mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-12 19:52:39 +00:00
7a3462de7a
The various runners (flash/debug scripts) use environment variables to
take arguments. This is legacy behavior which is not desirable.
Use command line arguments instead.
Note: this leaves more general environment variables with publicly
documented behavior in place for now, for compatibility, e.g.:
ZEPHYR_FLASH_OVER_DFU, OPENSDA_FW, ESP_IDF_PATH, PYOCD_DAPARG
For example, when using dfu-util to flash arduino_101, instead of
setting DFUUTIL_PID, DFUUTIL_ALT, and DFUUTIL_IMG environment
variables, have the script invocation look like this:
python3 .../zephyr_flash_debug.py dfu-util flash \
[common arguments omitted] \
--pid=8087:0aba --alt=x86_app \
--img=.../build/zephyr/zephyr.bin
Make similar changes for other runners (openocd, etc.) and
targets (debug, debugserver).
To implement this in the scripts:
- have the individual scripts/support/runner/some-runner.py files
register their own command line arguments
- teach them to construct instances from arguments, not the
environment
- have zephyr_flash_debug.py request runners to register command
line argument parsers, and handle arguments
In the build system:
- add a new board_runner_args() extension function that board.cmake
files can use to add to the zephyr_flash_debug.py command line
- adjust cmake/flash/CMakeLists.txt to invoke with arguments
- add new helper include files for each runner (like
boards/common/dfu-util.board.cmake, etc.), which add default
options as needed and then add on overrides from
board_runner_args() calls
- update board.cmake files to use the new includes and extension
This implied some tweaking when using openocd to make the CMake string
escaping and unescaping work properly.
Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
112 lines
4.0 KiB
Python
112 lines
4.0 KiB
Python
# Copyright (c) 2017 Linaro Limited.
|
|
# Copyright (c) 2017 Open Source Foundries Limited.
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
'''ARC architecture-specific runners.'''
|
|
|
|
from os import path
|
|
|
|
from .core import ZephyrBinaryRunner
|
|
|
|
DEFAULT_ARC_TCL_PORT = 6333
|
|
DEFAULT_ARC_TELNET_PORT = 4444
|
|
DEFAULT_ARC_GDB_PORT = 3333
|
|
|
|
|
|
class EmStarterKitBinaryRunner(ZephyrBinaryRunner):
|
|
'''Runner front-end for the EM Starterkit board, using openocd.'''
|
|
|
|
# This unusual 'flash' implementation matches the original shell script.
|
|
#
|
|
# It works by starting a GDB server in a separate session, connecting a
|
|
# client to it to load the program, and running 'continue' within the
|
|
# client to execute the application.
|
|
#
|
|
# TODO: exit immediately when flashing is done, leaving Zephyr running.
|
|
|
|
def __init__(self, board_dir, elf, gdb,
|
|
openocd='openocd', search=None,
|
|
tui=False, tcl_port=DEFAULT_ARC_TCL_PORT,
|
|
telnet_port=DEFAULT_ARC_TELNET_PORT,
|
|
gdb_port=DEFAULT_ARC_GDB_PORT, debug=False):
|
|
super(EmStarterKitBinaryRunner, self).__init__(debug=debug)
|
|
self.board_dir = board_dir
|
|
self.elf = elf
|
|
self.gdb_cmd = [gdb] + (['-tui'] if tui else [])
|
|
search_args = []
|
|
if search is not None:
|
|
search_args = ['-s', search]
|
|
self.openocd_cmd = [openocd] + search_args
|
|
self.tcl_port = tcl_port
|
|
self.telnet_port = telnet_port
|
|
self.gdb_port = gdb_port
|
|
|
|
@classmethod
|
|
def name(cls):
|
|
return 'em-starterkit'
|
|
|
|
@classmethod
|
|
def do_add_parser(cls, parser):
|
|
parser.add_argument('--tui', default=False, action='store_true',
|
|
help='if given, GDB uses -tui')
|
|
parser.add_argument('--tcl-port', default=DEFAULT_ARC_TCL_PORT,
|
|
help='openocd TCL port, defaults to 6333')
|
|
parser.add_argument('--telnet-port', default=DEFAULT_ARC_TELNET_PORT,
|
|
help='openocd telnet port, defaults to 4444')
|
|
parser.add_argument('--gdb-port', default=DEFAULT_ARC_GDB_PORT,
|
|
help='openocd gdb port, defaults to 3333')
|
|
|
|
@classmethod
|
|
def create_from_args(cls, args):
|
|
if args.gdb is None:
|
|
raise ValueError('--gdb not provided at command line')
|
|
|
|
return EmStarterKitBinaryRunner(
|
|
args.board_dir, args.kernel_elf, args.gdb,
|
|
openocd=args.openocd, search=args.openocd_search,
|
|
tui=args.tui, tcl_port=args.tcl_port, telnet_port=args.telnet_port,
|
|
gdb_port=args.gdb_port, debug=args.verbose)
|
|
|
|
def do_run(self, command, **kwargs):
|
|
kwargs['openocd-cfg'] = path.join(self.board_dir, 'support',
|
|
'openocd.cfg')
|
|
|
|
if command in {'flash', 'debug'}:
|
|
self.flash_debug(command, **kwargs)
|
|
else:
|
|
self.debugserver(**kwargs)
|
|
|
|
def flash_debug(self, command, **kwargs):
|
|
config = kwargs['openocd-cfg']
|
|
|
|
server_cmd = (self.openocd_cmd +
|
|
['-f', config] +
|
|
['-c', 'tcl_port {}'.format(self.tcl_port),
|
|
'-c', 'telnet_port {}'.format(self.telnet_port),
|
|
'-c', 'gdb_port {}'.format(self.gdb_port),
|
|
'-c', 'init',
|
|
'-c', 'targets',
|
|
'-c', 'halt'])
|
|
|
|
continue_arg = []
|
|
if command == 'flash':
|
|
continue_arg = ['-ex', 'c']
|
|
|
|
gdb_cmd = (self.gdb_cmd +
|
|
['-ex', 'target remote :{}'.format(self.gdb_port),
|
|
'-ex', 'load'] +
|
|
continue_arg +
|
|
[self.elf])
|
|
|
|
self.run_server_and_client(server_cmd, gdb_cmd)
|
|
|
|
def debugserver(self, **kwargs):
|
|
config = kwargs['openocd-cfg']
|
|
cmd = (self.openocd_cmd +
|
|
['-f', config,
|
|
'-c', 'init',
|
|
'-c', 'targets',
|
|
'-c', 'reset halt'])
|
|
self.check_call(cmd)
|