[scons] Add command to run only OpenOcd

Co-authored-by: Niklas Hauser <niklas.hauser@rwth-aachen.de>
modm-io · Oct 28, 2021 · 151d2e1 · 151d2e1
1 parent 5dcdf1d
commit 151d2e1
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 3 deletions.
diff --git a/tools/build_script_generator/scons/module.md b/tools/build_script_generator/scons/module.md
@@ -283,6 +283,18 @@ scons program-remote profile={debug|release} [host={ip or hostname}] [firmware={
 
 Writes the executable onto your target connected to a remote OpenOCD process
 running on your own computer (host=`localhost`) or somewhere else.
+(\* *only ARM Cortex-M targets*)
+
+
+#### scons openocd
+
+```
+scons openocd
+```
+
+Starts an OpenOCD process to attach a remote debugger to (e.g. with
+`scons program-remote` or `scons debug-remote`).
+(\* *only ARM Cortex-M targets*)
 
 
 #### scons run
@@ -342,7 +354,7 @@ Launches GDB for post-mortem debugging with the firmware identified by the
 See the `modm:platform:fault` module for details how to receive the coredump data.
 
 
-#### scons program-remote
+#### scons debug-remote
 
 ```
 scons debug-remote profile={debug|release} ui={tui|web} [host={ip or hostname}] [firmware={hash or file}]

diff --git a/tools/build_script_generator/scons/resources/build_target.py.in b/tools/build_script_generator/scons/resources/build_target.py.in
@@ -64,6 +64,9 @@ def build_target(env, sources):
 	env.Alias("reset-bmp", env.ResetBMP())
 	env.Alias("reset-remote", env.ResetGdbRemote())
 
+	# Start only OpenOCD to attach a external (remote) debugger
+	env.Alias("openocd", env.OpenOcd())
+
 	# Default to OpenOCD
 	env.Alias("program", "program-openocd")
 	env.Alias("reset", "reset-openocd")

diff --git a/tools/build_script_generator/scons/site_tools/comstr.py b/tools/build_script_generator/scons/site_tools/comstr.py
@@ -99,6 +99,9 @@ def generate(env, **kw):
         env["ARTIFACT_COMSTR"] =         "%s╭───Artifact─── %s$SOURCE\n" \
                                          "%s╰────Cache────> %s$ARTIFACT_FILEPATH%s" % install
 
+        env["RUN_OPENOCD_COMSTR"] =      "%s╭────────────── %s\n" \
+                                         "%s╰───OpenOCD───> %s$CONFIG_DEVICE_NAME%s" % install
+
         env["DEBUG_OPENOCD_COMSTR"] =    "%s╭─────GDB─────> %s$SOURCE\n" \
                                          "%s╰───OpenOCD───> %s$CONFIG_DEVICE_NAME%s" % install
 

diff --git a/tools/build_script_generator/scons/site_tools/openocd.py b/tools/build_script_generator/scons/site_tools/openocd.py
@@ -62,11 +62,23 @@ def call_reset_openocd(target, source, env):
 	action = Action(call_reset_openocd, cmdstr="$RESET_OPENOCD_COMSTR")
 	return env.AlwaysBuild(env.Alias(alias, '', action))
 
+# -----------------------------------------------------------------------------
+def run_openocd(env, alias="run_openocd"):
+	def call_run_openocd(target, source, env):
+		config = env.Listify(env.get("MODM_OPENOCD_CONFIGFILES", []))
+		searchdir = env.Listify(env.get("MODM_OPENOCD_SEARCHDIRS", []))
+		openocd.call(config=map(env.subst, config),
+                    search=map(env.subst, searchdir), verbose=True)
+
+	action = Action(call_run_openocd, cmdstr="$RUN_OPENOCD_COMSTR")
+	return env.AlwaysBuild(env.Alias(alias, '', action))
+
 # -----------------------------------------------------------------------------
 def generate(env, **kw):
 	env.AddMethod(program_openocd, "ProgramOpenOcd")
 	env.AddMethod(debug_openocd, "DebugOpenOcd")
 	env.AddMethod(reset_openocd, "ResetOpenOcd")
+	env.AddMethod(run_openocd, "OpenOcd")
 
 def exists(env):
 	return env.Detect("openocd")
diff --git a/tools/modm_tools/openocd.py b/tools/modm_tools/openocd.py
@@ -66,7 +66,7 @@ def stop(self):
 
 
 # -----------------------------------------------------------------------------
-def call(commands=None, config=None, search=None, blocking=True, silent=False):
+def call(commands=None, config=None, search=None, blocking=True, silent=False, verbose=False):
     commands = utils.listify(commands)
     config = utils.listify(config)
     search = utils.listify(search)
@@ -83,7 +83,8 @@ def call(commands=None, config=None, search=None, blocking=True, silent=False):
         " ".join(map('-f "{}"'.format, config)),
         " ".join(map('-c "{}"'.format, commands))
     )
-    # print(command_openocd)
+    if verbose:
+        print(command_openocd)
 
     kwargs = {"cwd": os.getcwd(), "shell": True}
     if blocking: