User Guide - nxpmemcfg#
This user guide describes how to use nxpmemcfg application. nxpmemcfg is a tool for managing external memory configuration option words used by BLHOST. As part of the nxpmemcfg is database of known option words for various memory flash chips.
Command line interface#
nxpmemcfg#
Collection of utilities for memory configuration operations.
nxpmemcfg [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.
blhost-script#
Export the configuration option words to blhost script.
nxpmemcfg blhost-script [OPTIONS]
Options
- -f, --family <family>#
Select the chip family.
- Options:
lpc550x | lpc551x | lpc552x | lpc55s0x | lpc55s1x | lpc55s2x | lpc55s3x | lpc55s6x | rt101x | rt102x | rt104x | rt105x | rt106x | rt116x | rt117x | rt118x | rt5xx | rt6xx | rw61x
- -m, --memory-chip <memory_chip>#
Select supported memory chip name. Use family-info command to get the known names.
- -i, --interface <interface>#
Select supported memory chip interface. Use family-info command to get the known interfaces.
- -c, --config <config>#
Option word configuration YAML file, in case that known chip has not been used
- -ix, --instance <instance>#
Instance of peripheral if applicable
- --fcb <fcb>#
Optional filename of FCB block generated by HW and read back to PC. Be aware that script will contain also erase of 4KB on base address.
- -o, --output <output>#
Name of BLHOST script. If not specified, the script will be printed to command line
- --force#
Force overwriting of existing files.
export#
Export the configuration option words from configuration.
nxpmemcfg export [OPTIONS]
Options
- -c, --config <config>#
Required Option word configuration YAML file
family-info#
List known memory configurations for the family.
nxpmemcfg family-info [OPTIONS]
Options
- -f, --family <family>#
Select the chip family.
- Options:
lpc550x | lpc551x | lpc552x | lpc55s0x | lpc55s1x | lpc55s2x | lpc55s3x | lpc55s6x | rt101x | rt102x | rt104x | rt105x | rt106x | rt116x | rt117x | rt118x | rt5xx | rt6xx | rw61x
- -p, --peripheral <peripheral>#
Restrict results just for this one peripheral, if used.
- Options:
flexspi_nor | flexspi_nand | semc_nor | semc_nand | spi_nor | mmc | sd
get-templates#
Create template of Memory option words in YAML format.
nxpmemcfg get-templates [OPTIONS]
Options
- -f, --family <family>#
Required Select the chip family.
- Options:
lpc550x | lpc551x | lpc552x | lpc55s0x | lpc55s1x | lpc55s2x | lpc55s3x | lpc55s6x | rt101x | rt102x | rt104x | rt105x | rt106x | rt116x | rt117x | rt118x | rt5xx | rt6xx | rw61x
- -o, --output <output>#
Required Path to a directory, where to store generated/parsed files.
- --force#
Force overwriting of existing files.
parse#
Parse the existing memory configuration option words.
nxpmemcfg parse [OPTIONS]
Options
- -f, --family <family>#
Required Select the chip family.
- Options:
lpc550x | lpc551x | lpc552x | lpc55s0x | lpc55s1x | lpc55s2x | lpc55s3x | lpc55s6x | rt101x | rt102x | rt104x | rt105x | rt106x | rt116x | rt117x | rt118x | rt5xx | rt6xx | rw61x
- -m, --memory-chip <memory_chip>#
Select supported memory chip name. Use family-info command to get the known names.
- -i, --interface <interface>#
Select supported memory chip interface. Use family-info command to get the known interfaces.
- -p, --peripheral <peripheral>#
Choose the peripheral of the input option words
- Options:
flexspi_nor | flexspi_nand | semc_nor | semc_nand | spi_nor | mmc | sd
- -w, --option-word <option_word>#
Define one or more memory configuration option words to be parsed.
- -o, --output <output>#
Required Path to a file, where to store the output.
- --force#
Force overwriting of existing files.