User Guide - shadowregs

This user’s guide describes how to use shadowregs application.

Command line interface

shadowregs

NXP Shadow Registers control Tool.

Usage

shadowregs [OPTIONS] COMMAND [ARGS]...

Options

-v, --verbose

Print more detailed information

-vv, --debug

Display more debugging information.

--version

Show the version and exit.

--help

Show this message and exit.

-i, --interface <interface>

Probe interface selection, if not specified, all available debug probe interfaces are used. [‘pyocd’, ‘pemicro’, ‘mcu-link’, ‘lauterbach’, ‘jlink’]

-s, --serial-no <serial_no>

Serial number of debug probe to avoid select menu after startup.

-f, --family <family>

Select the chip family.

Options:

mimxrt533s | mimxrt555s | mimxrt595s | mimxrt685s | mimxrt735s | mimxrt758s | mimxrt798s | rw610 | rw612

-r, --revision <revision>

Chip revision; if not specified, most recent one will be used

-o, --debug-probe-option <debug_probe_option>

This option could be used multiply to setup non-standard option for debug probe.

The example of use: -o KEY=VALUE

[pyocd]:

[test_address]: Address for testing memory AP, default is tested address in RAM MCU memory range

[enable_recovery_reset]: Enable hardware reset during debug connection recovery. WARNING: This will restart the target chip and lose current state (default: False)

[pemicro]:

[test_address]: Address for testing memory AP, default is tested address in RAM MCU memory range

[enable_recovery_reset]: Enable hardware reset during debug connection recovery. WARNING: This will restart the target chip and lose current state (default: False)

[frequency]: Set the communication frequency in Hz, default is 100_000Hz

[mcu-link]:

[test_address]: Address for testing memory AP, default is tested address in RAM MCU memory range

[enable_recovery_reset]: Enable hardware reset during debug connection recovery. WARNING: This will restart the target chip and lose current state (default: False)

[lauterbach]:

[test_address]: Address for testing memory AP, default is tested address in RAM MCU memory range

[enable_recovery_reset]: Enable hardware reset during debug connection recovery. WARNING: This will restart the target chip and lose current state (default: False)

[ip]: [HOST][:PORT] of the Lauterbach T32. Default HOST: localhost, default PORT: 20_000. NOTE: Your config.t32 file shall contain the following settings: RCL=NETTCP PORT=20000

[startup]: Path to the startup.cmm script for Lauterbach T32 initialization (setting up target)

[timeout]: Trace32 connection timeout in seconds. Default is 1 second.

[jlink]:

[test_address]: Address for testing memory AP, default is tested address in RAM MCU memory range

[enable_recovery_reset]: Enable hardware reset during debug connection recovery. WARNING: This will restart the target chip and lose current state (default: False)

[frequency]: Set the communication frequency in KHz, default is 100KHz

fuses-script

The command generate BLHOST script to burn up fuses in device by configuration.

Usage

shadowregs fuses-script [OPTIONS]

Options

-c, --config <config>

Required Path to the YAML/JSON configuration file.

-oc, --override-config <key_path=value>

Allows override the individual configuration settings. The use is simple: ‘key_path=value’, like ‘family=mimxrt595s’ or in structural configuration with separating character ‘/’ like ‘containers/0/binary_container=my_container.bin’. It could be used multiple times.

-o, --output <output>

Required Path to a file, where to store the output.

get-families

Shows the full family info for commands in this group.

Usage

shadowregs get-families [OPTIONS]

get-template

Generate the template of Shadow registers YAML configuration file.

Usage

shadowregs get-template [OPTIONS]

Options

-o, --output <output>

Required Path to a file, where to store the output.

--force

Force overwriting of existing files.

getreg

The command prints the current value of one shadow register.

Usage

shadowregs getreg [OPTIONS]

Options

-r, --reg <reg>

Required The name of register to be read.

loadconfig

Load new state of shadow registers from YAML file into micro controller.

Usage

shadowregs loadconfig [OPTIONS]

Options

-c, --config <config>

Required Path to the YAML/JSON configuration file.

-oc, --override-config <key_path=value>

Allows override the individual configuration settings. The use is simple: ‘key_path=value’, like ‘family=mimxrt595s’ or in structural configuration with separating character ‘/’ like ‘containers/0/binary_container=my_container.bin’. It could be used multiple times.

--verify, --no-verify

Verify write operation (verify by default)

printregs

Print all Shadow registers including theirs current values.

In case of needed more information, there is also provided rich format of print.

Usage

shadowregs printregs [OPTIONS]

Options

-r, --rich

Enables rich format of printed output.

reset

The command resets connected device.

Usage

shadowregs reset [OPTIONS]

saveconfig

Save current state of shadow registers to YAML file.

Usage

shadowregs saveconfig [OPTIONS]

Options

-o, --output <output>

Required Path to a file, where to store the output.

-d, --save-diff

Save differences comparing to defaults

setreg

The command sets a value of one shadow register defined by parameter.

Usage

shadowregs setreg [OPTIONS]

Options

-r, --reg <reg>

Required The name of register to be set.

-v, --reg-val <reg_val>

Required The new value of register in hex format.

--verify, --no-verify

Verify write operation (verify by default)

--raw, --computed

If computed is set, the modification hooks will be used