mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-03 07:34:17 +00:00
eb95bed552
Refactor the code to support the new runners.yaml file created by the
build system.
Compared to fishing around in the CMake cache, this makes it trivial
to put all the command line arguments to a runner-based command on
equal footing, regardless of if they're defined in the runners package
proper or defined in run_common.py.
This allows board.cmake files to do things like this:
board_set_runner_args(foo
--bin-file=${PROJECT_BINARY_DIR}/my-signed.bin)
While at it, make some other cleanups:
- Stop using the obsolete and deprecated west.cmake module while we're
here in favor of the zcmake.py module which was added to Zephyr a long
time ago. Yikes. I had forgotten this was still here.
- Stop using west.util's wrap function in favor of raw use of
textwrap. The west function splits on hyphens, which is breaking
runner names like "em-starterkit".
- Clean up the --context output a bit
Fixes: #22563
Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
80 lines
2.6 KiB
Python
80 lines
2.6 KiB
Python
# Copyright (c) 2018 Open Source Foundries Limited.
|
|
# Copyright 2019 Foundries.io
|
|
# Copyright (c) 2020 Nordic Semiconductor ASA
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
'''west "debug", "debugserver", and "attach" commands.'''
|
|
|
|
from textwrap import dedent
|
|
|
|
from west.commands import WestCommand
|
|
|
|
from run_common import desc_common, add_parser_common, do_run_common
|
|
|
|
|
|
class Debug(WestCommand):
|
|
|
|
def __init__(self):
|
|
super(Debug, self).__init__(
|
|
'debug',
|
|
# Keep this in sync with the string in west-commands.yml.
|
|
'flash and interactively debug a Zephyr application',
|
|
dedent('''
|
|
Connect to the board, flash the program, and start a
|
|
debugging session. Use "west attach" instead to attach
|
|
a debugger without reflashing.\n\n''') +
|
|
desc_common('debug'),
|
|
accepts_unknown_args=True)
|
|
self.runner_key = 'debug-runner' # in runners.yaml
|
|
|
|
def do_add_parser(self, parser_adder):
|
|
return add_parser_common(self, parser_adder)
|
|
|
|
def do_run(self, my_args, runner_args):
|
|
do_run_common(self, my_args, runner_args)
|
|
|
|
|
|
class DebugServer(WestCommand):
|
|
|
|
def __init__(self):
|
|
super(DebugServer, self).__init__(
|
|
'debugserver',
|
|
# Keep this in sync with the string in west-commands.yml.
|
|
'connect to board and launch a debug server',
|
|
dedent('''
|
|
Connect to the board and launch a debug server which accepts
|
|
incoming connections for debugging the connected board.
|
|
|
|
The debug server binds to a known port, and allows client software
|
|
started elsewhere to connect to it and debug the running
|
|
Zephyr image.\n\n''') +
|
|
desc_common('debugserver'),
|
|
accepts_unknown_args=True)
|
|
self.runner_key = 'debug-runner' # in runners.yaml
|
|
|
|
def do_add_parser(self, parser_adder):
|
|
return add_parser_common(self, parser_adder)
|
|
|
|
def do_run(self, my_args, runner_args):
|
|
do_run_common(self, my_args, runner_args)
|
|
|
|
|
|
class Attach(WestCommand):
|
|
|
|
def __init__(self):
|
|
super(Attach, self).__init__(
|
|
'attach',
|
|
# Keep this in sync with the string in west-commands.yml.
|
|
'interactively debug a board',
|
|
"Like \"west debug\", but doesn't reflash the program.\n\n" +
|
|
desc_common('attach'),
|
|
accepts_unknown_args=True)
|
|
self.runner_key = 'debug-runner' # in runners.yaml
|
|
|
|
def do_add_parser(self, parser_adder):
|
|
return add_parser_common(self, parser_adder)
|
|
|
|
def do_run(self, my_args, runner_args):
|
|
do_run_common(self, my_args, runner_args)
|