Allow overriding debug adapter speed using "debug_speed" option

Author: valeros

builder/main.py

@@ -146,7 +146,7 @@ def _jlink_cmd_script(env, source):
         UPLOADER="JLink.exe" if system() == "Windows" else "JLinkExe",
         UPLOADERFLAGS=[
             "-device", board.get("debug", {}).get("jlink_device"),
-            "-speed", "4000",
+            "-speed", env.GetProjectOption("debug_speed", "4000"),
             "-if", ("jtag" if upload_protocol == "jlink-jtag" else "swd"),
             "-autoconnect", "1",
             "-NoGui", "1"
@@ -193,6 +193,10 @@ def _jlink_cmd_script(env, source):
             "-d%d" % (2 if int(ARGUMENTS.get("PIOVERBOSE", 0)) else 1)
         ]
         openocd_args.extend(debug_server.get("arguments", []))
+        if env.GetProjectOption("debug_speed"):
+            openocd_args.extend(
+                ["-c", "adapter speed %s" % env.GetProjectOption("debug_speed")]
+            )
         openocd_args.extend([
             "-c", "program {$SOURCE} %s verify reset; shutdown;" %
             board.get("upload.offset_address", "")

platform.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import copy
 import json
 import os
 
@@ -31,7 +32,7 @@ def configure_default_packages(self, variables, targets):
                                                 variables.get("board")).get(
                                                     "upload.protocol", ""))
             if upload_protocol == "cmsis-dap":
-                self.packages['tool-pyocd']['type'] = "uploader"
+                self.packages["tool-pyocd"]["type"] = "uploader"
 
             if "mbed" in variables.get("pioframework", []):
                 deprecated_boards_file = os.path.join(
@@ -48,7 +49,7 @@ def configure_default_packages(self, variables, targets):
                     "tool-cmake", "tool-dtc", "tool-ninja"):
                     self.packages[p]["optional"] = False
             if "windows" not in get_systype():
-                self.packages['tool-gperf']['optional'] = False
+                self.packages["tool-gperf"]["optional"] = False
 
         # configure J-LINK tool
         jlink_conds = [
@@ -84,15 +85,15 @@ def _add_default_debug_tools(self, board):
         upload_protocols = board.manifest.get("upload", {}).get(
             "protocols", [])
         if "tools" not in debug:
-            debug['tools'] = {}
+            debug["tools"] = {}
 
         # J-Link / BlackMagic Probe
         for link in ("blackmagic", "cmsis-dap", "jlink"):
-            if link not in upload_protocols or link in debug['tools']:
+            if link not in upload_protocols or link in debug["tools"]:
                 continue
 
             if link == "blackmagic":
-                debug['tools']['blackmagic'] = {
+                debug["tools"]["blackmagic"] = {
                     "hwids": [["0x1d50", "0x6018"]],
                     "require_debug_port": True
                 }
@@ -101,7 +102,7 @@ def _add_default_debug_tools(self, board):
                 if debug.get("pyocd_target"):
                     pyocd_target = debug.get("pyocd_target")
                     assert pyocd_target
-                    debug['tools'][link] = {
+                    debug["tools"][link] = {
                         "onboard": True,
                         "server": {
                             "package": "tool-pyocd",
@@ -117,7 +118,7 @@ def _add_default_debug_tools(self, board):
                 else:
                     openocd_target = debug.get("openocd_target")
                     assert openocd_target
-                    debug['tools'][link] = {
+                    debug["tools"][link] = {
                         "load_cmd": "preload",
                         "onboard": True,
                         "server": {
@@ -134,7 +135,7 @@ def _add_default_debug_tools(self, board):
             elif link == "jlink":
                 assert debug.get("jlink_device"), (
                     "Missed J-Link Device ID for %s" % board.id)
-                debug['tools'][link] = {
+                debug["tools"][link] = {
                     "server": {
                         "package": "tool-jlink",
                         "arguments": [
@@ -151,5 +152,28 @@ def _add_default_debug_tools(self, board):
                     "onboard": link in debug.get("onboard_tools", [])
                 }
 
-        board.manifest['debug'] = debug
+        board.manifest["debug"] = debug
         return board
+
+    def configure_debug_options(self, initial_debug_options, ide_data):
+        debug_options = copy.deepcopy(initial_debug_options)
+        server_executable = debug_options["server"]["executable"].lower()
+        adapter_speed = initial_debug_options.get("speed")
+        if adapter_speed:
+            if "openocd" in server_executable:
+                debug_options["server"]["arguments"].extend(
+                    ["-c", "adapter speed %s" % adapter_speed]
+                )
+            elif "jlink" in server_executable:
+                debug_options["server"]["arguments"].extend(
+                    ["-speed", adapter_speed]
+                )
+            elif "pyocd" in debug_options["server"]["package"]:
+                assert (
+                    adapter_speed.isdigit()
+                ), "pyOCD requires the debug frequency value in Hz, e.g. 4000"
+                debug_options["server"]["arguments"].extend(
+                    ["--frequency", "%d" % int(adapter_speed)]
+                )
+
+        return debug_options