5317f76dec
Continue better integration of the runner subpackage into west by moving the common runner configuration options into the command core. This allows commands like "west flash -h" to display help for common overrides like --kernel-hex. Adjustments needed to make this happen are: - Change the build system to separate common configuration values from runner-specific options and arguments - Prepare the runner core by defining a new RunnerConfig class that represents the common configuration, and accepting that from a new create() method, which replaces create_from_args(). - Convert all concrete runner classes to use the new style of argument parsing and initialization. - Group the command options appropriately for help output readability There's still a bit of tool-specific stuff in the common configuration (gdb and openocd configuration in particular); a more generic way to deal with that will be necessary to better support things like non-GDB debuggers, but that's out of scope of this patch. All the runner-specific options are still in the runner packge, which currently prevents them from being included in "west flash -h" etc. Fixing that is also out of scope of this patch. This has the ancillary benefit of getting rid of the legacy 'debug' argument to ZephyrBinaryRunner, which is no longer appropriate since verbose debug logging is handled by log.py in west. Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
137 lines
4.9 KiB
Python
137 lines
4.9 KiB
Python
# Copyright (c) 2018 Intel Corporation.
|
|
# Copyright 2018 Open Source Foundries Limited.
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
'''Runner for debugging and flashing intel_s1000 devices'''
|
|
from os import path
|
|
import time
|
|
import subprocess
|
|
|
|
from .. import log
|
|
from .core import ZephyrBinaryRunner
|
|
|
|
DEFAULT_XT_GDB_PORT = 20000
|
|
|
|
|
|
class IntelS1000BinaryRunner(ZephyrBinaryRunner):
|
|
'''Runner front-end for Intel_s1000.'''
|
|
|
|
def __init__(self, cfg, xt_ocd_dir,
|
|
ocd_topology, ocd_jtag_instr, gdb_flash_file,
|
|
gdb_port=DEFAULT_XT_GDB_PORT):
|
|
super(IntelS1000BinaryRunner, self).__init__(cfg)
|
|
self.board_dir = cfg.board_dir
|
|
self.elf_name = cfg.kernel_elf
|
|
self.gdb_cmd = cfg.gdb
|
|
self.xt_ocd_dir = xt_ocd_dir
|
|
self.ocd_topology = ocd_topology
|
|
self.ocd_jtag_instr = ocd_jtag_instr
|
|
self.gdb_flash_file = gdb_flash_file
|
|
self.gdb_port = gdb_port
|
|
|
|
@classmethod
|
|
def name(cls):
|
|
return 'intel_s1000'
|
|
|
|
@classmethod
|
|
def do_add_parser(cls, parser):
|
|
# Optional
|
|
parser.add_argument(
|
|
'--xt-ocd-dir', default='/opt/Tensilica/xocd-12.0.4/xt-ocd',
|
|
help='ocd-dir, defaults to /opt/Tensilica/xocd-12.0.4/xt-ocd')
|
|
parser.add_argument(
|
|
'--ocd-topology', default='topology_dsp0_flyswatter2.xml',
|
|
help='ocd-topology, defaults to topology_dsp0_flyswatter2.xml')
|
|
parser.add_argument(
|
|
'--ocd-jtag-instr', default='dsp0_gdb.txt',
|
|
help='ocd-jtag-instr, defaults to dsp0_gdb.txt')
|
|
parser.add_argument(
|
|
'--gdb-flash-file', default='load_elf.txt',
|
|
help='gdb-flash-file, defaults to load_elf.txt')
|
|
parser.add_argument(
|
|
'--gdb-port', default=DEFAULT_XT_GDB_PORT,
|
|
help='xt-gdb port, defaults to 20000')
|
|
|
|
@classmethod
|
|
def create(cls, cfg, args):
|
|
return IntelS1000BinaryRunner(
|
|
cfg, args.xt_ocd_dir,
|
|
args.ocd_topology, args.ocd_jtag_instr, args.gdb_flash_file,
|
|
gdb_port=args.gdb_port)
|
|
|
|
def do_run(self, command, **kwargs):
|
|
kwargs['ocd-topology'] = path.join(self.board_dir, 'support',
|
|
self.ocd_topology)
|
|
kwargs['ocd-jtag-instr'] = path.join(self.board_dir, 'support',
|
|
self.ocd_jtag_instr)
|
|
kwargs['gdb-flash-file'] = path.join(self.board_dir, 'support',
|
|
self.gdb_flash_file)
|
|
|
|
if command == 'flash':
|
|
self.flash(**kwargs)
|
|
elif command == 'debugserver':
|
|
self.debugserver(**kwargs)
|
|
else:
|
|
self.debugserver(**kwargs)
|
|
self.do_debug()
|
|
|
|
def flash(self, **kwargs):
|
|
topology_file = kwargs['ocd-topology']
|
|
jtag_instr_file = kwargs['ocd-jtag-instr']
|
|
gdb_flash_file = kwargs['gdb-flash-file']
|
|
|
|
self.print_gdbserver_message(self.gdb_port)
|
|
server_cmd = [self.xt_ocd_dir,
|
|
'-c', topology_file,
|
|
'-I', jtag_instr_file]
|
|
|
|
# Start the server
|
|
# Note that XTOCD always fails the first time. It has to be
|
|
# relaunched the second time to work.
|
|
self.call(server_cmd)
|
|
server_proc = self.popen_ignore_int(server_cmd)
|
|
time.sleep(3)
|
|
|
|
# Start the client, and wait for it to finish flashing the file.
|
|
gdb_cmd = [self.gdb_cmd, '-x', gdb_flash_file]
|
|
client_proc = self.popen_ignore_int(gdb_cmd)
|
|
client_proc.wait()
|
|
|
|
# At this point, the ELF image is loaded and the program is in
|
|
# execution. Now we can quit the server (xt-ocd); it is not
|
|
# needed anymore. The loaded program (ELF) will continue to
|
|
# run.
|
|
server_proc.terminate()
|
|
|
|
def do_debug(self):
|
|
if self.elf_name is None:
|
|
raise ValueError('Cannot debug; elf is missing')
|
|
if self.gdb_cmd is None:
|
|
raise ValueError('Cannot debug; no gdb specified')
|
|
|
|
gdb_cmd = [self.gdb_cmd,
|
|
'-ex', 'target remote :{}'.format(self.gdb_port),
|
|
self.elf_name]
|
|
gdb_proc = self.popen_ignore_int(gdb_cmd)
|
|
retcode = gdb_proc.wait()
|
|
if retcode:
|
|
raise subprocess.CalledProcessError((retcode, gdb_cmd))
|
|
|
|
def print_gdbserver_message(self, gdb_port):
|
|
log.inf('Intel S1000 GDB server running on port {}'.format(gdb_port))
|
|
|
|
def debugserver(self, **kwargs):
|
|
topology_file = kwargs['ocd-topology']
|
|
jtag_instr_file = kwargs['ocd-jtag-instr']
|
|
|
|
self.print_gdbserver_message(self.gdb_port)
|
|
server_cmd = [self.xt_ocd_dir,
|
|
'-c', topology_file,
|
|
'-I', jtag_instr_file]
|
|
|
|
# Note that XTOCD always fails the first time. It has to be
|
|
# relaunched the second time to work.
|
|
self.call(server_cmd)
|
|
self.check_call(server_cmd)
|