zephyr/scripts/west_commands/runners/ezflashcli.py
Carles Cufi 2d38c095a6 west: runners: Add support for a common --reset argument
Some of the runners in the tree have been adding their own,
class-specific versions of a switch to instruct the runner to reset or
not the device after flashing.

In order to better support multi-image builds that require more than one
flash operation, introduce a new --reset,--no-reset command-line
parameter that is part of the RunnerCaps so taht this functionality can
be accessed in a standardized manner.

Implementations for the new parameter are provided for the runner
classes that were already configurable in this regard.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-09-28 11:08:25 -07:00

80 lines
2.8 KiB
Python

# Copyright (c) 2022 Renesas Electronics Corporation
#
# SPDX-License-Identifier: Apache-2.0
'''Runner for flashing with ezFlashCLI.'''
from runners.core import ZephyrBinaryRunner, RunnerCaps
DEFAULT_EZFLASHCLI = "ezFlashCLI"
class EzFlashCliBinaryRunner(ZephyrBinaryRunner):
'''Runner front-end for ezFlashCLI'''
def __init__(self, cfg, tool, sn, erase=False, reset=True):
super().__init__(cfg)
self.bin_ = cfg.bin_file
self.tool = tool
self.sn_arg = ['-j', f'{sn}'] if sn is not None else []
self.erase = bool(erase)
self.reset = bool(reset)
@classmethod
def name(cls):
return 'ezflashcli'
@classmethod
def capabilities(cls):
return RunnerCaps(commands={'flash'}, erase=True, reset=True)
@classmethod
def do_add_parser(cls, parser):
parser.add_argument('--tool', default=DEFAULT_EZFLASHCLI,
help='ezFlashCLI path, default is '
f'{DEFAULT_EZFLASHCLI}')
parser.add_argument('--sn', default=None, required=False,
help='J-Link probe serial number')
parser.set_defaults(reset=True)
@classmethod
def do_create(cls, cfg, args):
return EzFlashCliBinaryRunner(cfg, tool=args.tool, sn=args.sn,
erase=args.erase)
def needs_product_header(self):
# Applications linked to code partition are meant to be run by MCUboot
# and do not require product header. Other applications and MCUboot itself
# are run by internal bootloader and thus require valid product header.
is_mcuboot = self.build_conf.getboolean('CONFIG_MCUBOOT')
uses_code_partition = self.build_conf.getboolean('CONFIG_USE_DT_CODE_PARTITION')
return is_mcuboot or not uses_code_partition
def program_bin(self):
if self.erase:
self.logger.info("Erasing flash...")
self.check_call([self.tool] + self.sn_arg + ["erase_flash"])
self.logger.info(f"Flashing {self.bin_}...")
if self.needs_product_header():
# Write product header and application image at fixed offset as required
# by internal bootloader.
self.check_call([self.tool] + self.sn_arg + ["image_flash", self.bin_])
else:
load_offset = self.build_conf['CONFIG_FLASH_LOAD_OFFSET']
self.check_call([self.tool] + self.sn_arg + ["write_flash", f'0x{load_offset:x}', self.bin_])
def reset_device(self):
self.logger.info("Resetting...")
self.check_call([self.tool] + self.sn_arg + ["go"])
def do_run(self, command, **kwargs):
self.require(self.tool)
self.ensure_output('bin')
self.program_bin()
if self.reset:
self.reset_device()