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. [‘pemicro’, ‘lauterbach’, ‘jlink’, ‘pyocd’, ‘mcu-link’]

-s, --serial-no <serial_no>

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

-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

[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

[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

[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)

[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)

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-config

Save current state of shadow registers to YAML file.

Usage

shadowregs get-config [OPTIONS]

Options

-o, --output <output>

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

-do, --diff-only

Save differences compared to default values.

-ia, --ignore-access-rights

Force reading shadow registers even when access rights are set to WO (Write-Only) or Reserved.

-f, --family <family>

Select the chip family.

Options:

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

get-families

Shows the full family info for commands in this group.

Usage

shadowregs get-families [OPTIONS]

Options

-c, --cmd-name <cmd_name>

Choose the command name to get full information about NXP families support.

Options:

saveconfig | get-config | get-template | printregs | getreg | print | setreg | write-single | reset

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.

-f, --family <family>

Select the chip family.

Options:

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

print

Print the current state of shadow registers from device.

Usage

shadowregs print [OPTIONS]

Options

-n, --name <name>

Shadow register name/uid/otp_index to be printed.

--rich

Enables rich format of printed output.

-ia, --ignore-access-rights

Force reading shadow register even when access rights are set to WO (Write-Only).

-f, --family <family>

Select the chip family.

Options:

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

reset

The command resets connected device.

Usage

shadowregs reset [OPTIONS]

Options

-f, --family <family>

Select the chip family.

Options:

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

write

Write shadow registers from configuration into device.

Usage

shadowregs write [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)

write-single

Write single shadow register into device.

Usage

shadowregs write-single [OPTIONS]

Options

-n, --name <name>

Required Shadow register name/uid/otp_index to be written.

-v, --value <value>

Required The new value of shadow 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

-f, --family <family>

Select the chip family.

Options:

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