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>
42 lines
1.1 KiB
Python
42 lines
1.1 KiB
Python
# Copyright (c) 2017 Linaro Limited.
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
'''Runner for debugging with xt-gdb.'''
|
|
|
|
from os import path
|
|
|
|
from .core import ZephyrBinaryRunner, RunnerCaps
|
|
|
|
|
|
class XtensaBinaryRunner(ZephyrBinaryRunner):
|
|
'''Runner front-end for xt-gdb.'''
|
|
|
|
def __init__(self, gdb, elf_name, debug=False):
|
|
super(XtensaBinaryRunner, self).__init__(debug=debug)
|
|
self.gdb_cmd = [gdb]
|
|
self.elf_name = elf_name
|
|
|
|
@classmethod
|
|
def name(cls):
|
|
return 'xtensa'
|
|
|
|
@classmethod
|
|
def capabilities(cls):
|
|
return RunnerCaps(commands={'debug'})
|
|
|
|
@classmethod
|
|
def do_add_parser(cls, parser):
|
|
parser.add_argument('--xcc-tools', required=True,
|
|
help='path to XTensa tools')
|
|
|
|
@classmethod
|
|
def create_from_args(command, args):
|
|
xt_gdb = path.join(args.xcc_tools, 'bin', 'xt-gdb')
|
|
return XtensaBinaryRunner(xt_gdb, args.kernel_elf, args.verbose)
|
|
|
|
def do_run(self, command, **kwargs):
|
|
gdb_cmd = (self.gdb_cmd + [self.elf_name])
|
|
|
|
self.check_call(gdb_cmd)
|