From f3a39105b96931edd6245ffcfcddc9f1c0d1f607 Mon Sep 17 00:00:00 2001
From: ARg <aromanov@comped.it>
Date: Wed, 25 Sep 2024 12:10:08 +0200
Subject: [PATCH] Tools: Migration of ESP32 targets from idf 4.4 to 5.3
 consisting of: - Updated installation scripts of esp-idf toolchain; - Adding
 ESP_PLATFORM define to ESP32 targets, it is required to compile FreeRTOS with
 idf 5.3;

---
 Tools/ardupilotwaf/boards.py   |  6 ++++-
 Tools/scripts/esp32_get_idf.sh | 44 ++++++++++++++++++++--------------
 2 files changed, 31 insertions(+), 19 deletions(-)

diff --git a/Tools/ardupilotwaf/boards.py b/Tools/ardupilotwaf/boards.py
index a7930ea0a3..5ba14dd183 100644
--- a/Tools/ardupilotwaf/boards.py
+++ b/Tools/ardupilotwaf/boards.py
@@ -57,6 +57,7 @@ class Board:
         def srcpath(path):
             return cfg.srcnode.make_node(path).abspath()
         env.SRCROOT = srcpath('')
+
         self.configure_env(cfg, env)
 
         # Setup scripting:
@@ -1002,7 +1003,7 @@ class esp32(Board):
         )
 
         tt = self.name[5:] #leave off 'esp32' so we just get 'buzz','diy','icarus, etc
-        
+
         # this makes sure we get the correct subtype
         env.DEFINES.update(
             CONFIG_HAL_BOARD_SUBTYPE = 'HAL_BOARD_SUBTYPE_ESP32_%s' %  tt.upper() ,
@@ -1018,6 +1019,9 @@ class esp32(Board):
         else:
             env.DEFINES.update(AP_SIM_ENABLED = 0)
 
+        # FreeRTOS component from esp-idf expects this define
+        env.DEFINES.update(ESP_PLATFORM = 1)
+
         env.AP_LIBRARIES += [
             'AP_HAL_ESP32',
         ]
diff --git a/Tools/scripts/esp32_get_idf.sh b/Tools/scripts/esp32_get_idf.sh
index f7e8318b47..a7ec191701 100755
--- a/Tools/scripts/esp32_get_idf.sh
+++ b/Tools/scripts/esp32_get_idf.sh
@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 # if you have modules/esp_idf setup as a submodule, then leave it as a submodule and switch branches
+
+COMMIT="cc3203dc4f087ab41b434afff1ed7520c6d90993"
+
 if [ ! -d modules ]; then
 echo "this script needs to be run from the root of your repo, sorry, giving up."
 exit 1
@@ -13,6 +16,7 @@ if [ ! -d esp_idf ]; then
 else
     echo 'found modules/esp_idf folder' ; 
 fi
+
 echo "looking for submodule or repo..."
 if [ `git submodule | grep esp_idf | wc | cut -c1-7` == '1'  ]; then 
     echo "found real submodule, syncing"
@@ -23,40 +27,44 @@ else
     if  [ ! `ls  esp_idf/install.sh 2>/dev/null` ]; then
         echo "found empty IDF, cloning"
         # add esp_idf as almost submodule, depths  uses less space
-        #git clone -b v4.4 --single-branch --depth 10 https://github.com/espressif/esp-idf.git esp_idf
-        git clone -b 'release/v4.4'  https://github.com/espressif/esp-idf.git esp_idf
-        git checkout 6d853f
-        # check if we've got v4.4 checked out, only this version of esp_idf is tested and works?
-        
+        git clone -b 'release/v5.3'  https://github.com/espressif/esp-idf.git esp_idf
+        git checkout $COMMIT
     fi
 fi
 
-
-
 echo "inspecting possible IDF... "
 cd esp_idf
 echo `git rev-parse HEAD`
-# these are a selection of possible specific commit/s that represent v4.4 branch of the esp_idf 
-if [ `git rev-parse HEAD` == '6d853f0525b003afaeaed4fb59a265c8522c2da9' ]; then 
-    echo "IDF version 'release/4.4' found OK, great."; 
+# these are a selection of possible specific commit/s that represent v5.3 branch of the esp_idf 
+if [ `git rev-parse HEAD` == '$COMMIT' ]; then 
+    echo "IDF version 'release/5.3' found OK, great."; 
 else
-    echo "looks like an idf, but not v4.4 branch, or wrong commit , trying to switch branch and reflect upstream";
+    echo "looks like an idf, but not v5.3 branch, or wrong commit , trying to switch branch and reflect upstream";
     ../../Tools/gittools/submodule-sync.sh >/dev/null
-    git fetch ; git checkout -f release/v4.4 
-    git checkout 6d853f
+    git fetch ; git checkout -f release/v5.3 
+    git checkout $COMMIT
 
     # retry same as above
     echo `git rev-parse HEAD`
-    if [ `git rev-parse HEAD` == '6d853f0525b003afaeaed4fb59a265c8522c2da9' ]; then 
-        echo "IDF version 'release/4.4' found OK, great."; 
-        git checkout 6d853f
+    if [ `git rev-parse HEAD` == '$COMMIT' ]; then 
+        echo "IDF version 'release/5.3' found OK, great."; 
+        git checkout $COMMIT
     fi
 fi
 cd ../..
 
-cd modules/esp_idf 
+cd modules/esp_idf
 git submodule update --init --recursive
+
+echo
+echo "installing missing python modules"
+python -m pip install empy==3.3.4
+python -m pip install pexpect
+python -m pip install future
+
 cd ../..
-echo "after changing IDF versions [ such as between 4.2 and 4.4 ] you should re-run these in your console:"
+
+echo
+echo "after changing IDF versions [ such as between 4.4 and 5.3 ] you should re-run these in your console:"
 echo "./modules/esp_idf/install.sh"
 echo "source ./modules/esp_idf/export.sh"