User Guide - pfr
This user’s guide describes how to use pfr application.
pfr
Utility for generating and parsing Protected Flash Region data (CMPA, CFPA).
pfr [OPTIONS] COMMAND [ARGS]...
Options
- -v, --version
Show the version and exit.
pfr - Sub-commands
pfr consist of a set of sub-commands followed by options and arguments. The options and the sub-command are separated with a ‘–’.
pfr [options] -- [sub-command]
The “help” guide of pfr lists all of the options and sub-commands supported by the pfr utility.
pfr --help
pfr devices
List supported devices.
pfr devices [OPTIONS]
pfr generate
This is depreciated command for generate-binary.
pfr generate [OPTIONS]
Options
- -c, --user-config <user_config_file>
Required YAML/JSON file with user configuration
- -o, --output <output>
Required Save the output into a file instead of console
- -a, --add-seal
Add seal mark digest at the end.
- -i, --calc-inverse
Calculate the INVERSE values CAUTION!!! It locks the settings
- -e, --elf2sb-config <elf2sb_config>
Specify Root Of Trust from configuration file used by elf2sb tool
- -f, --secret-file <secret_file>
Secret file (certificate, public key, private key); can be defined multiple times
- -p, --password <password>
Password when using Encrypted private keys as –secret-file
pfr generate-binary
Generate binary data.
pfr generate-binary [OPTIONS]
Options
- -e, --elf2sb-config <elf2sb_config>
Specify Root Of Trust from configuration file used by elf2sb tool
- -f, --secret-file <secret_file>
Secret file (certificate, public key, private key); can be defined multiple times
- -c, --user-config <user_config_file>
Required YAML/JSON file with user configuration
- -o, --output <output>
Required Save the output into a file instead of console
- -a, --add-seal
Add seal mark digest at the end.
- -i, --calc-inverse
Calculate the INVERSE values CAUTION!!! It locks the settings
- -p, --password <password>
Password when using Encrypted private keys as –secret-file
pfr get-cfg-template
Generate user configuration template file.
pfr get-cfg-template [OPTIONS]
Options
- -d, --device <device>
Required Device to use
- Options
lpc55s6x | lpc551x | lpc55s1x | lpc550x | lpc55s0x | lpc55s2x | lpc552x | lpc55s3x | lpc553x
- -r, --revision <revision>
Chip revision; if not specified, most recent one will be used
- -t, --type <area>
Required Select PFR partition
- Options
cmpa | cfpa
- -o, --output <output>
Save the output into a file instead of console
- -f, --full
Show full config, including computed values
pfr info
Generate HTML page with brief description of CMPA/CFPA configuration fields.
pfr info [OPTIONS]
Options
- -d, --device <device>
Required Device to use
- Options
lpc55s6x | lpc551x | lpc55s1x | lpc550x | lpc55s0x | lpc55s2x | lpc552x | lpc55s3x | lpc553x
- -r, --revision <revision>
Chip revision; if not specified, most recent one will be used
- -t, --type <area>
Required Select PFR partition
- Options
cmpa | cfpa
- -o, --output <output>
Required Save the output into a file instead of console
- -p, --open
Open the generated description file
pfr parse
This is depreciated command for parse-binary.
pfr parse [OPTIONS]
Options
- -d, --device <device>
Required Device to use
- Options
lpc55s6x | lpc551x | lpc55s1x | lpc550x | lpc55s0x | lpc55s2x | lpc552x | lpc55s3x | lpc553x
- -r, --revision <revision>
Chip revision; if not specified, most recent one will be used
- -t, --type <area>
Required Select PFR partition
- Options
cmpa | cfpa
- -o, --output <output>
Save the output into a file instead of console
- -b, --binary <binary>
Required Binary to parse
- -f, --show-diff
Show differences comparing to defaults
- -c, --show-calc
Show also calculated fields when displaying difference to defaults (–show-diff)
pfr parse-binary
Parse binary and extract configuration.
pfr parse-binary [OPTIONS]
Options
- -d, --device <device>
Required Device to use
- Options
lpc55s6x | lpc551x | lpc55s1x | lpc550x | lpc55s0x | lpc55s2x | lpc552x | lpc55s3x | lpc553x
- -r, --revision <revision>
Chip revision; if not specified, most recent one will be used
- -t, --type <area>
Required Select PFR partition
- Options
cmpa | cfpa
- -o, --output <output>
Save the output into a file instead of console
- -b, --binary <binary>
Required Binary to parse
- -f, --show-diff
Show differences comparing to defaults
- -c, --show-calc
Show also calculated fields when displaying difference to defaults (–show-diff)
pfr user-config
This is depreciated command for get-cfg-template.
pfr user-config [OPTIONS]
Options
- -d, --device <device>
Required Device to use
- Options
lpc55s6x | lpc551x | lpc55s1x | lpc550x | lpc55s0x | lpc55s2x | lpc552x | lpc55s3x | lpc553x
- -r, --revision <revision>
Chip revision; if not specified, most recent one will be used
- -t, --type <area>
Required Select PFR partition
- Options
cmpa | cfpa
- -o, --output <output>
Save the output into a file instead of console
- -f, --full
Show full config, including computed values