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
- -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.
- Options
pyocd | jlink | pemicro
- -s, --serial-no <serial_no>
Serial number of debug probe to avoid select menu after startup.
- -f, --family <family>
Select the chip family.
- Options
rt5xx | rt6xx | rw61x
- -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
[jlink]:
[frequency]: Set the communication frequency in KHz, default is 100KHz
[pemicro]:
[frequency]: Set the communication frequency in Hz, default is 100_000Hz
fuses-script
The command generate BLHOST script to burn up fuses in device by configuration.
shadowregs fuses-script [OPTIONS]
Options
- -c, --config <config>
Required Path to the YAML/JSON configuration file.
- -o, --output <output>
Required Path to a file, where to store the output.
get-template
Generate the template of Shadow registers YAML configuration file.
shadowregs get-template [OPTIONS]
Options
- -r, --raw
In loaded configuration will accepted also the computed fields and anti-pole registers.
- -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.
shadowregs getreg [OPTIONS]
Options
- -r, --reg <reg>
Required The name of register to be read.
info
The command generate HTML of Shadow registers.
shadowregs info [OPTIONS]
Options
- -o, --output <output>
Required File name of generated output HTML description file
- -p, --open
Open the generated description file
loadconfig
Load new state of shadow registers from YAML file into micro controller.
shadowregs loadconfig [OPTIONS]
Options
- -c, --config <config>
Required Path to the YAML/JSON configuration file.
- -r, --raw
In loaded configuration will accepted also the computed fields and anti-pole registers.
- --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.
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 YAML file.
shadowregs saveconfig [OPTIONS]
Options
- -o, --output <output>
Required Path to a file, where to store the output.
- -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>
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