User Guide - shadowregs
This user’s guide describes how to use shadowregs application.
Command line interface
shadowregs
NXP Shadow Registers control Tool.
shadowregs [OPTIONS] COMMAND [ARGS]...
Options
- -i, --interface <interface>
The interface allow specify to use only one debug probe interface like: ‘PyOCD’, ‘jlink’ or ‘pemicro’
- -v, --verbose
Print more detailed information
- -vv, --debug
Display more debugging information.
- --version
Show the version and exit.
- --help
Show this message and exit.
- -s, --serial-no <serial_no>
Serial number of debug probe to avoid select menu after startup.
- -dev, --device <device>
The target device family.
- Options
imxrt595 | imxrt685
- -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
fuses-script
The command generate BLHOST script to burn up fuses in device by configuration.
The OUTPUT argument specify file name of generate BLHOST burn fuses script.
shadowregs fuses-script [OPTIONS] OUTPUT
Options
- -c, --config <config>
Required The name of shadow register configuration file used to generate burn fuses BLHOST script.
Arguments
- OUTPUT
Required argument
get-template
Generate the template of Shadow registers YML configuration file.
shadowregs get-template [OPTIONS] PATH
Options
- -r, --raw
In loaded configuration will accepted also the computed fields and anti-pole registers.
Arguments
- PATH
Required argument
getreg
The command prints the current value of one shadow register.
shadowregs getreg [OPTIONS]
Options
- -r, --reg <reg>
The name of register to be read.
info
The command generate HTML of Shadow registers.
shadowregs info [OPTIONS]
Options
- -o, --output <output>
Required Save the output into a file instead of console
- -p, --open
Open the generated description file
loadconfig
Load new state of shadow registers from YML file into microcontroller.
shadowregs loadconfig [OPTIONS]
Options
- -f, --filename <filename>
The name of file used to load a new configuration. Default name is ‘sr_config’. The extension is always ‘.yml’.
- -r, --raw
In loaded configuration will accepted also the computed fields and anti-pole registers.
printregs
Print all Shadow registers including theirs current values.
In case of needed more information, there is also provided rich format of print.
shadowregs printregs [OPTIONS]
Options
- -r, --rich
Enables rich format of printed output.
reset
The command resets connected device.
shadowregs reset [OPTIONS]
saveconfig
Save current state of shadow registers to YML file.
shadowregs saveconfig [OPTIONS]
Options
- -f, --filename <filename>
The name of file used to save the current configuration. Default name is ‘sr_config’. The extension is always ‘.yml’.
- -r, --raw
The stored configuration will include also the computed fields and anti-pole registers.
- -d, --save-diff
Save differences comparing to defaults
setreg
The command sets a value of one shadow register defined by parameter.
shadowregs setreg [OPTIONS]
Options
- -r, --reg <reg>
The name of register to be set.
- -v, --reg_val <reg_val>
The new value of register in hex format.