install newer OpenOCD via tl_install from github

Author: Jason2866

platform.py

@@ -13,13 +13,15 @@
 # limitations under the License.
 
 import os
-import urllib
+import subprocess
 import sys
-import json
-import re
-import requests
+import shutil
+from os.path import join
 
 from platformio.public import PlatformBase, to_unix_path
+from platformio.proc import get_pythonexe_path
+from platformio.project.config import ProjectConfig
+from platformio.package.manager.tool import ToolPackageManager
 
 
 IS_WINDOWS = sys.platform.startswith("win")
@@ -29,6 +31,36 @@
 if IS_WINDOWS:
     os.environ["PLATFORMIO_SYSTEM_TYPE"] = "windows_amd64"
 
+python_exe = get_pythonexe_path()
+pm = ToolPackageManager()
+
+def install_tool(TOOL):
+    TOOLS_PATH_DEFAULT = os.path.join(os.path.expanduser("~"), ".platformio")
+    IDF_TOOLS = os.path.join(ProjectConfig.get_instance().get("platformio", "packages_dir"), "tl-install", "tools", "idf_tools.py")
+    TOOLS_JSON_PATH = os.path.join(ProjectConfig.get_instance().get("platformio", "packages_dir"), TOOL, "tools.json")
+    TOOLS_PACK_PATH = os.path.join(ProjectConfig.get_instance().get("platformio", "packages_dir"), TOOL, "package.json")
+    IDF_TOOLS_CMD = (
+        python_exe,
+        IDF_TOOLS,
+        "--quiet",
+        "--non-interactive",
+        "--tools-json",
+        TOOLS_JSON_PATH,
+        "install"
+    )
+
+    tl_flag = bool(os.path.exists(IDF_TOOLS))
+    json_flag = bool(os.path.exists(TOOLS_JSON_PATH))
+    if tl_flag and json_flag:
+        rc = subprocess.call(IDF_TOOLS_CMD)
+        if rc != 0:
+            sys.stderr.write("Error: Couldn't execute 'idf_tools.py install'\n")
+        else:
+            tl_path = "file://" + join(TOOLS_PATH_DEFAULT, "tools", TOOL)
+            shutil.copyfile(TOOLS_PACK_PATH, join(TOOLS_PATH_DEFAULT, "tools", TOOL, "package.json"))
+            pm.install(tl_path)
+    return
+
 
 class Espressif32Platform(PlatformBase):
     def configure_default_packages(self, variables, targets):
@@ -43,7 +75,12 @@ def configure_default_packages(self, variables, targets):
         core_variant_build = (''.join(variables.get("build_flags", []))).replace("-D", " ")
         frameworks = variables.get("pioframework", [])
 
-        if "arduino" in frameworks:
+        # Installer only needed for setup, deactivate
+        self.packages["tl-install"]["optional"] = True
+        # Installed not from pio registry, deactivate until needed
+        self.packages["tool-openocd-esp32"]["optional"] = True
+
+        if "arduino" in frameworks and variables.get("custom_sdkconfig") is None and len(str(board_sdkconfig)) < 3:
             self.packages["framework-arduinoespressif32"]["optional"] = False
             self.packages["framework-arduinoespressif32-libs"]["optional"] = False
             # use matching espressif Arduino libs
@@ -93,21 +130,20 @@ def configure_default_packages(self, variables, targets):
         # Starting from v12, Espressif's toolchains are shipped without
         # bundled GDB. Instead, it's distributed as separate packages for Xtensa
         # and RISC-V targets.
-        for gdb_package in ("tool-xtensa-esp-elf-gdb", "tool-riscv32-esp-elf-gdb"):
-            self.packages[gdb_package]["optional"] = False
-            # if IS_WINDOWS:
-                # Note: On Windows GDB v12 is not able to
-                # launch a GDB server in pipe mode while v11 works fine
-                # self.packages[gdb_package]["version"] = "~11.2.0"
+        if (variables.get("build_type") or "debug" in "".join(targets)) or variables.get("upload_protocol"):
+            for gdb_package in ("tool-xtensa-esp-elf-gdb", "tool-riscv32-esp-elf-gdb"):
+                self.packages[gdb_package]["optional"] = False
+            install_tool("tool-openocd-esp32")
+            self.packages["tool-openocd-esp32"]["optional"] = False
 
         # Common packages for IDF and mixed Arduino+IDF projects
         if "espidf" in frameworks:
             self.packages["toolchain-esp32ulp"]["optional"] = False
             for p in self.packages:
                 if p in (
-                    "tool-scons",
                     "tool-cmake",
                     "tool-ninja",
+                    "tool-scons",
                     "tool-esp-rom-elfs",
                  ):
                     self.packages[p]["optional"] = False
@@ -119,8 +155,8 @@ def configure_default_packages(self, variables, targets):
         else:
             self.packages.pop("toolchain-xtensa-esp-elf", None)
 
-        if mcu in ("esp32s2", "esp32s3", "esp32c2", "esp32c3", "esp32c6", "esp32h2", "esp32p4"):
-            if mcu in ("esp32c2", "esp32c3", "esp32c6", "esp32h2", "esp32p4"):
+        if mcu in ("esp32s2", "esp32s3", "esp32c2", "esp32c3", "esp32c5", "esp32c6", "esp32h2", "esp32p4"):
+            if mcu in ("esp32c2", "esp32c3", "esp32c5", "esp32c6", "esp32h2", "esp32p4"):
                 self.packages.pop("toolchain-esp32ulp", None)
             # RISC-V based toolchain for ESP32C3, ESP32C6 ESP32S2, ESP32S3 ULP
             self.packages["toolchain-riscv32-esp"]["optional"] = False