User Guide - nxpdebugmbox#
This user’s guide describes how to use nxpdebugmbox application.
Note
If you encounter this warning: STLink, CMSIS-DAPv2 and PicoProbe probes are not supported because no libusb library was found. It means that libusb cannot be found on your system. Libusb in PyOCD is distributed as python package libusb-package which does not have wheel distribution for Python 3.12 pyocd/libusb-package#16 (October 2024). As a workaround you might copy the libusb-1.0.dll to the root of libusb-package folder in your virtual environment e.g.: venv/Lib/site-packages/libusb_package/libusb-1.0.dll or copy it to Windows/System32/. You can get the dll here: https://libusb.info/
Command line interface#
nxpdebugmbox#
Tool for working with Debug Mailbox.
Usage
nxpdebugmbox [OPTIONS] COMMAND [ARGS]...
Options
- -i, --interface <interface>#
Probe interface selection, if not specified, all available debug probe interfaces are used. [‘pyocd’, ‘pemicro’, ‘mcu-link’, ‘lauterbach’, ‘jlink’]
- -s, --serial-no <serial_no>#
Debug probe hardware ID/serial number to select the probe in system.
- -t, --timing <timing>#
Duration of additional delay after reset sequence, defaults to 0 seconds
- -n, --no-reset#
Omit reset of debug mailbox during initialization, default behavior is reset debug mailbox during initialization.
- -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
[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)
[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
[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)
[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
- --operation-timeout <operation_timeout>#
Special option to change the standard operation timeout used for communication with debug mailbox. Default value is 1000ms.
- -v, --verbose#
Print more detailed information
- -vv, --debug#
Display more debugging information.
- --version#
Show the version and exit.
- --help#
Show this message and exit.
cmd#
Group of commands for working with raw Debug MailBox commands.
Usage
nxpdebugmbox cmd [OPTIONS] COMMAND [ARGS]...
Options
- -f, --family <family>#
[required] Select the chip family.
- Options:
k32w148 | kw45b41z5 | kw45b41z8 | kw45z41052 | kw45z41053 | kw45z41082 | kw45z41083 | kw47b42z83 | kw47b42z96 | kw47b42z97 | kw47b42zb2 | kw47b42zb3 | kw47b42zb6 | kw47b42zb7 | kw47z42082 | kw47z42092 | kw47z420b2 | kw47z420b3 | lpc55s04 | lpc55s06 | lpc55s14 | lpc55s16 | lpc55s26 | lpc55s28 | lpc55s36 | lpc55s66 | lpc55s69 | mcxa132 | mcxa133 | mcxa142 | mcxa143 | mcxa144 | mcxa145 | mcxa146 | mcxa152 | mcxa153 | mcxa154 | mcxa155 | mcxa156 | mcxa173 | mcxa174 | mcxa175 | mcxa176 | mcxa185 | mcxa186 | mcxa255 | mcxa256 | mcxa265 | mcxa266 | mcxa343 | mcxa344 | mcxa345 | mcxa346 | mcxa355 | mcxa356 | mcxa365 | mcxa366 | mcxl253 | mcxl254 | mcxl255 | mcxn235 | mcxn236 | mcxn247 | mcxn526 | mcxn527 | mcxn536 | mcxn537 | mcxn546 | mcxn547 | mcxn556s | mcxn557s | mcxn946 | mcxn947 | mcxw235 | mcxw236 | mcxw716a | mcxw716c | mcxw727a | mcxw727c | mcxw727d | mimx8ulp | mimx9131 | mimx9352 | mimx943 | mimx95294 | mimx9596 | mimxrt1181 | mimxrt1182 | mimxrt1186 | mimxrt1187 | mimxrt1189 | mimxrt533s | mimxrt555s | mimxrt595s | mimxrt685s | mimxrt735s | mimxrt758s | mimxrt798s | nhs52s04 | rw610 | rw612
erase#
Erase Flash.
Usage
nxpdebugmbox cmd erase [OPTIONS]
erase-one-sector#
Erase one flash sector.
Usage
nxpdebugmbox cmd erase-one-sector [OPTIONS]
Options
- -a, --address <address>#
Required Starting address
exit#
Exit DebugMailBox.
Usage
nxpdebugmbox cmd exit [OPTIONS]
famode#
Set Fault Analysis Mode.
Usage
nxpdebugmbox cmd famode [OPTIONS]
Options
- -m, --message <message>#
Path to message file.
get-crp#
Get CRP level. This command should be called after ‘start’ command and with no-reset ‘-n’ option.
Usage
nxpdebugmbox cmd get-crp [OPTIONS]
get-dac#
Perform the Start of Debug Authentication and get the DAC.
The -p option must be defined in main application.
Usage
nxpdebugmbox cmd get-dac [OPTIONS]
Options
- -o, --output <output>#
Required Path to a file, where to store the output.
- -l, --rot-hash-length <rot_hash_length>#
- The length of Root of Trust hash in Debug authentication challenge packet.There is simple key do decide:- Most device depends on used RoT keys type:– RSA (all types): 32– ECC 256: 32– ECC 384: 48– ECC 521: 66- The exceptions:– The KW45xx devices has always 32 bytes– Devices based on EdgeLock Enclave security element has 32 bytes
- Options:
32 | 48 | 66
- -x, --nxp-keys#
Use the ROM NXP keys to authenticate.
get-families#
Shows the full family info for commands in this group.
Usage
nxpdebugmbox cmd get-families [OPTIONS]
ispmode#
Enter ISP Mode.
Usage
nxpdebugmbox cmd ispmode [OPTIONS]
Options
- -m, --mode <mode>#
ISP download mode based on the ISP mode value in boot configuration register in CMPA/fuses.
nxp-exec-prov-fw#
Execute NXP Provisioning Firmware.
Usage
nxpdebugmbox cmd nxp-exec-prov-fw [OPTIONS]
nxp-ssf-insert-cert#
Command to create self-signed certificate as part of Self sign flow (SSF).
Usage
nxpdebugmbox cmd nxp-ssf-insert-cert [OPTIONS]
Options
- -s, --seed <seed>#
Required The tester seed value.. Accepts a 256-bit hexadecimal value that can be provided directly on the command line, or as a path to a binary/text file containing the hex value. (Expected size: 32 bytes)
- -e, --output-ecdsa-puk <output_ecdsa_puk>#
Path to save the ECDSA PUK (0x60 bytes).
- -y, --output-hybrid-puk <output_hybrid_puk>#
Path to save the Hybrid PUK (0xA80 bytes).
- -rd, --response-delay <response_delay>#
Delay before reading response in seconds
- Default:
1.0
nxp-ssf-insert-duk#
Create NXP PUF AC code store area as part of Self sign flow (SSF).
Usage
nxpdebugmbox cmd nxp-ssf-insert-duk [OPTIONS]
Options
- -s, --seed <seed>#
Required The tester seed value.. Accepts a 256-bit hexadecimal value that can be provided directly on the command line, or as a path to a binary/text file containing the hex value. (Expected size: 32 bytes)
send-dar#
Send the Debug Authentication response to device.
Usage
nxpdebugmbox cmd send-dar [OPTIONS]
Options
- -b, --binary <binary>#
Required Path to binary with DAR packet.
- -x, --nxp-keys#
Use the ROM NXP keys to authenticate.
set-bricked-mode#
Set Bricked mode.
Usage
nxpdebugmbox cmd set-bricked-mode [OPTIONS]
start#
Start DebugMailBox.
Usage
nxpdebugmbox cmd start [OPTIONS]
start-debug-session#
Start debug session.
Usage
nxpdebugmbox cmd start-debug-session [OPTIONS]
token-auth#
Debug Authentication using token.
Usage
nxpdebugmbox cmd token-auth [OPTIONS]
Options
- -f, --file <file>#
Required Path to token file (string hex format).
- -n, --no-exit#
When used, exit debug mailbox command is not executed after debug authentication.
write-to-flash#
Write data to flash.
Usage
nxpdebugmbox cmd write-to-flash [OPTIONS]
Options
- -a, --address <address>#
Required Starting address
- -f, --file <file>#
Required Path to file.
dat#
Group of commands for working with Debug Authentication Procedure.
Usage
nxpdebugmbox dat [OPTIONS] COMMAND [ARGS]...
auth#
Perform the Debug Authentication.
Usage
nxpdebugmbox dat auth [OPTIONS]
Options
- -c, --config <config>#
Required Path to Debug Authentication 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.
- -n, --no-exit#
When used, exit debug mailbox command is not executed after debug authentication.
dc#
Group of commands for Debug Credential binaries.
Usage
nxpdebugmbox dat dc [OPTIONS] COMMAND [ARGS]...
export#
Generate debug certificate (DC).
Usage
nxpdebugmbox dat dc export [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.
- -e, --rot-config <rot_config>#
Specify Root Of Trust from MBI or Cert block configuration file
- -o, --output <output>#
Required Path to a file, where to store the output.
- --force#
Force overwriting of existing files.
get-families#
Shows the full family info for commands in this group.
Usage
nxpdebugmbox dat dc get-families [OPTIONS]
Options
- -c, --cmd-name <cmd_name>#
Choose the command name to get full information about NXP families support.
- Options:
get-template
get-template#
Generate the template of Debug Credentials YML configuration file.
Usage
nxpdebugmbox dat dc get-template [OPTIONS]
Options
- -f, --family <family>#
[required] Select the chip family.
- Options:
k32w148 | kw45b41z5 | kw45b41z8 | kw45z41052 | kw45z41053 | kw45z41082 | kw45z41083 | kw47b42z83 | kw47b42z96 | kw47b42z97 | kw47b42zb2 | kw47b42zb3 | kw47b42zb6 | kw47b42zb7 | kw47z42082 | kw47z42092 | kw47z420b2 | kw47z420b3 | lpc55s04 | lpc55s06 | lpc55s14 | lpc55s16 | lpc55s26 | lpc55s28 | lpc55s36 | lpc55s66 | lpc55s69 | mcxa132 | mcxa133 | mcxa142 | mcxa143 | mcxa144 | mcxa145 | mcxa146 | mcxa152 | mcxa153 | mcxa154 | mcxa155 | mcxa156 | mcxa173 | mcxa174 | mcxa175 | mcxa176 | mcxa185 | mcxa186 | mcxa255 | mcxa256 | mcxa265 | mcxa266 | mcxa343 | mcxa344 | mcxa345 | mcxa346 | mcxa355 | mcxa356 | mcxa365 | mcxa366 | mcxl253 | mcxl254 | mcxl255 | mcxn235 | mcxn236 | mcxn247 | mcxn526 | mcxn527 | mcxn536 | mcxn537 | mcxn546 | mcxn547 | mcxn556s | mcxn557s | mcxn946 | mcxn947 | mcxw235 | mcxw236 | mcxw716a | mcxw716c | mcxw727a | mcxw727c | mcxw727d | mimx8ulp | mimx9131 | mimx9352 | mimx943 | mimx95294 | mimx9596 | mimxrt1181 | mimxrt1182 | mimxrt1186 | mimxrt1187 | mimxrt1189 | mimxrt533s | mimxrt555s | mimxrt595s | mimxrt685s | mimxrt735s | mimxrt758s | mimxrt798s | nhs52s04 | rw610 | rw612
- -r, --revision <revision>#
Chip revision; if not specified, most recent one will be used
- -o, --output <output>#
Required Path to a file, where to store the output.
- --force#
Force overwriting of existing files.
get-families#
Shows the full family info for commands in this group.
Usage
nxpdebugmbox dat get-families [OPTIONS]
Options
- -c, --cmd-name <cmd_name>#
Choose the command name to get full information about NXP families support.
- Options:
get-template
get-template#
Create template of Debug authentication configurations in YAML format.
Usage
nxpdebugmbox dat get-template [OPTIONS]
Options
- -f, --family <family>#
[required] Select the chip family.
- Options:
k32w148 | kw45b41z5 | kw45b41z8 | kw45z41052 | kw45z41053 | kw45z41082 | kw45z41083 | kw47b42z83 | kw47b42z96 | kw47b42z97 | kw47b42zb2 | kw47b42zb3 | kw47b42zb6 | kw47b42zb7 | kw47z42082 | kw47z42092 | kw47z420b2 | kw47z420b3 | lpc55s04 | lpc55s06 | lpc55s14 | lpc55s16 | lpc55s26 | lpc55s28 | lpc55s36 | lpc55s66 | lpc55s69 | mcxa132 | mcxa133 | mcxa142 | mcxa143 | mcxa144 | mcxa145 | mcxa146 | mcxa152 | mcxa153 | mcxa154 | mcxa155 | mcxa156 | mcxa173 | mcxa174 | mcxa175 | mcxa176 | mcxa185 | mcxa186 | mcxa255 | mcxa256 | mcxa265 | mcxa266 | mcxa343 | mcxa344 | mcxa345 | mcxa346 | mcxa355 | mcxa356 | mcxa365 | mcxa366 | mcxl253 | mcxl254 | mcxl255 | mcxn235 | mcxn236 | mcxn247 | mcxn526 | mcxn527 | mcxn536 | mcxn537 | mcxn546 | mcxn547 | mcxn556s | mcxn557s | mcxn946 | mcxn947 | mcxw235 | mcxw236 | mcxw716a | mcxw716c | mcxw727a | mcxw727c | mcxw727d | mimx8ulp | mimx9131 | mimx9352 | mimx943 | mimx95294 | mimx9596 | mimxrt1181 | mimxrt1182 | mimxrt1186 | mimxrt1187 | mimxrt1189 | mimxrt533s | mimxrt555s | mimxrt595s | mimxrt685s | mimxrt735s | mimxrt758s | mimxrt798s | nhs52s04 | rw610 | rw612
- -r, --revision <revision>#
Chip revision; if not specified, most recent one will be used
- -o, --output <output>#
Required Path to a file, where to store the output.
- --force#
Force overwriting of existing files.
famode-image#
Group of sub-commands related to Fault Analysis Mode Image (related to some families).
Usage
nxpdebugmbox famode-image [OPTIONS] COMMAND [ARGS]...
export#
Generate Fault Analysis mode image from YAML/JSON configuration.
The configuration template files could be generated by subcommand ‘get-templates’.
Usage
nxpdebugmbox famode-image export [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.
get-families#
Shows the full family info for commands in this group.
Usage
nxpdebugmbox famode-image get-families [OPTIONS]
Options
- -c, --cmd-name <cmd_name>#
Choose the command name to get full information about NXP families support.
- Options:
parse | get-templates
get-templates#
Create template of Fault Analysis mode image configurations in YAML format.
Usage
nxpdebugmbox famode-image get-templates [OPTIONS]
Options
- -f, --family <family>#
[required] Select the chip family.
- Options:
k32w148 | kw45b41z5 | kw45b41z8 | kw45z41052 | kw45z41053 | kw45z41082 | kw45z41083 | kw47b42z83 | kw47b42z96 | kw47b42z97 | kw47b42zb2 | kw47b42zb3 | kw47b42zb6 | kw47b42zb7 | kw47z42082 | kw47z42092 | kw47z420b2 | kw47z420b3 | mcxw716a | mcxw716c | mcxw727a | mcxw727c | mcxw727d
- -r, --revision <revision>#
Chip revision; if not specified, most recent one will be used
- -o, --output <output>#
Required Path to a directory, where to store generated/parsed files.
- --force#
Force overwriting of existing files.
parse#
Parse MBI Image into YAML configuration and binary images.
Usage
nxpdebugmbox famode-image parse [OPTIONS]
Options
- -f, --family <family>#
[required] Select the chip family.
- Options:
k32w148 | kw45b41z5 | kw45b41z8 | kw45z41052 | kw45z41053 | kw45z41082 | kw45z41083 | kw47b42z83 | kw47b42z96 | kw47b42z97 | kw47b42zb2 | kw47b42zb3 | kw47b42zb6 | kw47b42zb7 | kw47z42082 | kw47z42092 | kw47z420b2 | kw47z420b3 | mcxw716a | mcxw716c | mcxw727a | mcxw727c | mcxw727d
- -r, --revision <revision>#
Chip revision; if not specified, most recent one will be used
- -b, --binary <binary>#
Required Path to binary FA Mode image to parse.
- -o, --output <output>#
Required Path to a directory, where to store generated/parsed files.
get-families#
Shows the full family info for commands in this group.
Usage
nxpdebugmbox get-families [OPTIONS]
Options
- -c, --cmd-name <cmd_name>#
Choose the command name to get full information about NXP families support.
- Options:
cmd
mem-tool#
Group of commands for working with target memory over debug probe.
Usage
nxpdebugmbox mem-tool [OPTIONS] COMMAND [ARGS]...
get-families#
Shows the full family info for commands in this group.
Usage
nxpdebugmbox mem-tool get-families [OPTIONS]
Options
- -c, --cmd-name <cmd_name>#
Choose the command name to get full information about NXP families support.
- Options:
read-memory | write-memory | test-connection
read-memory#
Reads the memory and writes it to the file or stdout.
Usage
nxpdebugmbox mem-tool read-memory [OPTIONS]
Options
- -f, --family <family>#
[required] Select the chip family.
- Options:
k32w148 | kw45b41z5 | kw45b41z8 | kw45z41052 | kw45z41053 | kw45z41082 | kw45z41083 | kw47b42z83 | kw47b42z96 | kw47b42z97 | kw47b42zb2 | kw47b42zb3 | kw47b42zb6 | kw47b42zb7 | kw47z42082 | kw47z42092 | kw47z420b2 | kw47z420b3 | lpc5502 | lpc5504 | lpc5506 | lpc5512 | lpc5514 | lpc5516 | lpc5526 | lpc5528 | lpc5534 | lpc5536 | lpc55s04 | lpc55s06 | lpc55s14 | lpc55s16 | lpc55s26 | lpc55s28 | lpc55s36 | lpc55s66 | lpc55s69 | lpc804 | lpc810 | lpc812 | lpc845 | lpc865 | mc56f81646 | mc56f81648 | mc56f81666 | mc56f81668 | mc56f81746 | mc56f81748 | mc56f81766 | mc56f81768 | mc56f81866 | mc56f81868 | mcxa132 | mcxa133 | mcxa142 | mcxa143 | mcxa144 | mcxa145 | mcxa146 | mcxa152 | mcxa153 | mcxa154 | mcxa155 | mcxa156 | mcxa173 | mcxa174 | mcxa175 | mcxa176 | mcxa185 | mcxa186 | mcxa255 | mcxa256 | mcxa265 | mcxa266 | mcxa343 | mcxa344 | mcxa345 | mcxa346 | mcxa355 | mcxa356 | mcxa365 | mcxa366 | mcxc041 | mcxc141 | mcxc142 | mcxc143 | mcxc144 | mcxc242 | mcxc243 | mcxc244 | mcxc443 | mcxc444 | mcxe245 | mcxe246 | mcxe247 | mcxe315 | mcxe316 | mcxe317 | mcxe31b | mcxl253 | mcxl254 | mcxl255 | mcxn235 | mcxn236 | mcxn247 | mcxn526 | mcxn527 | mcxn536 | mcxn537 | mcxn546 | mcxn547 | mcxn556s | mcxn557s | mcxn946 | mcxn947 | mcxw235 | mcxw236 | mcxw716a | mcxw716c | mcxw727a | mcxw727c | mcxw727d | mimx28 | mimx8dxl | mimx8m | mimx8mm | mimx8mn | mimx8mp | mimx8qm | mimx8qxp | mimx8ulp | mimx8x | mimx9131 | mimx9352 | mimx943 | mimx95294 | mimx9596 | mimxrt1010 | mimxrt1015 | mimxrt1020 | mimxrt1024 | mimxrt1040 | mimxrt1043 | mimxrt1046 | mimxrt1050 | mimxrt1060 | mimxrt1064 | mimxrt1165 | mimxrt1166 | mimxrt1171 | mimxrt1172 | mimxrt1173 | mimxrt1175 | mimxrt1176 | mimxrt1181 | mimxrt1182 | mimxrt1186 | mimxrt1187 | mimxrt1189 | mimxrt533s | mimxrt555s | mimxrt595s | mimxrt685s | mimxrt735s | mimxrt758s | mimxrt798s | mwct2012 | mwct2012a | mwct2014s | mwct2015s | mwct2016s | mwct20d2 | mwct20d2a | mwct2d16s | mwct2d17s | nhs52s04 | rw610 | rw612
- -r, --revision <revision>#
Chip revision; if not specified, most recent one will be used
- -a, --address <address>#
Required Starting address
- -c, --count <count>#
Required Number of bytes to read
- -o, --output <output>#
Path to a file, where to store the output.
- -h, --use-hexdump#
Use hexdump format
test-connection#
Method just try if the device debug port is opened or not.
Usage
nxpdebugmbox mem-tool test-connection [OPTIONS]
Options
- -f, --family <family>#
[required] Select the chip family.
- Options:
k32w148 | kw45b41z5 | kw45b41z8 | kw45z41052 | kw45z41053 | kw45z41082 | kw45z41083 | kw47b42z83 | kw47b42z96 | kw47b42z97 | kw47b42zb2 | kw47b42zb3 | kw47b42zb6 | kw47b42zb7 | kw47z42082 | kw47z42092 | kw47z420b2 | kw47z420b3 | lpc5502 | lpc5504 | lpc5506 | lpc5512 | lpc5514 | lpc5516 | lpc5526 | lpc5528 | lpc5534 | lpc5536 | lpc55s04 | lpc55s06 | lpc55s14 | lpc55s16 | lpc55s26 | lpc55s28 | lpc55s36 | lpc55s66 | lpc55s69 | lpc804 | lpc810 | lpc812 | lpc845 | lpc865 | mc56f81646 | mc56f81648 | mc56f81666 | mc56f81668 | mc56f81746 | mc56f81748 | mc56f81766 | mc56f81768 | mc56f81866 | mc56f81868 | mcxa132 | mcxa133 | mcxa142 | mcxa143 | mcxa144 | mcxa145 | mcxa146 | mcxa152 | mcxa153 | mcxa154 | mcxa155 | mcxa156 | mcxa173 | mcxa174 | mcxa175 | mcxa176 | mcxa185 | mcxa186 | mcxa255 | mcxa256 | mcxa265 | mcxa266 | mcxa343 | mcxa344 | mcxa345 | mcxa346 | mcxa355 | mcxa356 | mcxa365 | mcxa366 | mcxc041 | mcxc141 | mcxc142 | mcxc143 | mcxc144 | mcxc242 | mcxc243 | mcxc244 | mcxc443 | mcxc444 | mcxe245 | mcxe246 | mcxe247 | mcxe315 | mcxe316 | mcxe317 | mcxe31b | mcxl253 | mcxl254 | mcxl255 | mcxn235 | mcxn236 | mcxn247 | mcxn526 | mcxn527 | mcxn536 | mcxn537 | mcxn546 | mcxn547 | mcxn556s | mcxn557s | mcxn946 | mcxn947 | mcxw235 | mcxw236 | mcxw716a | mcxw716c | mcxw727a | mcxw727c | mcxw727d | mimx28 | mimx8dxl | mimx8m | mimx8mm | mimx8mn | mimx8mp | mimx8qm | mimx8qxp | mimx8ulp | mimx8x | mimx9131 | mimx9352 | mimx943 | mimx95294 | mimx9596 | mimxrt1010 | mimxrt1015 | mimxrt1020 | mimxrt1024 | mimxrt1040 | mimxrt1043 | mimxrt1046 | mimxrt1050 | mimxrt1060 | mimxrt1064 | mimxrt1165 | mimxrt1166 | mimxrt1171 | mimxrt1172 | mimxrt1173 | mimxrt1175 | mimxrt1176 | mimxrt1181 | mimxrt1182 | mimxrt1186 | mimxrt1187 | mimxrt1189 | mimxrt533s | mimxrt555s | mimxrt595s | mimxrt685s | mimxrt735s | mimxrt758s | mimxrt798s | mwct2012 | mwct2012a | mwct2014s | mwct2015s | mwct2016s | mwct20d2 | mwct20d2a | mwct2d16s | mwct2d17s | nhs52s04 | rw610 | rw612
- -r, --revision <revision>#
Chip revision; if not specified, most recent one will be used
- -d, --destination <destination>#
Test connection destination:
cpu_mem: Test that is able to communicate with target memory
debug_port: Test that is able to communicate with chip debug port (basic chip connection)
- Options:
cpu_mem | debug_port
write-memory#
Writes memory from a file or a hex-data.
Usage
nxpdebugmbox mem-tool write-memory [OPTIONS]
Options
- -f, --family <family>#
[required] Select the chip family.
- Options:
k32w148 | kw45b41z5 | kw45b41z8 | kw45z41052 | kw45z41053 | kw45z41082 | kw45z41083 | kw47b42z83 | kw47b42z96 | kw47b42z97 | kw47b42zb2 | kw47b42zb3 | kw47b42zb6 | kw47b42zb7 | kw47z42082 | kw47z42092 | kw47z420b2 | kw47z420b3 | lpc5502 | lpc5504 | lpc5506 | lpc5512 | lpc5514 | lpc5516 | lpc5526 | lpc5528 | lpc5534 | lpc5536 | lpc55s04 | lpc55s06 | lpc55s14 | lpc55s16 | lpc55s26 | lpc55s28 | lpc55s36 | lpc55s66 | lpc55s69 | lpc804 | lpc810 | lpc812 | lpc845 | lpc865 | mc56f81646 | mc56f81648 | mc56f81666 | mc56f81668 | mc56f81746 | mc56f81748 | mc56f81766 | mc56f81768 | mc56f81866 | mc56f81868 | mcxa132 | mcxa133 | mcxa142 | mcxa143 | mcxa144 | mcxa145 | mcxa146 | mcxa152 | mcxa153 | mcxa154 | mcxa155 | mcxa156 | mcxa173 | mcxa174 | mcxa175 | mcxa176 | mcxa185 | mcxa186 | mcxa255 | mcxa256 | mcxa265 | mcxa266 | mcxa343 | mcxa344 | mcxa345 | mcxa346 | mcxa355 | mcxa356 | mcxa365 | mcxa366 | mcxc041 | mcxc141 | mcxc142 | mcxc143 | mcxc144 | mcxc242 | mcxc243 | mcxc244 | mcxc443 | mcxc444 | mcxe245 | mcxe246 | mcxe247 | mcxe315 | mcxe316 | mcxe317 | mcxe31b | mcxl253 | mcxl254 | mcxl255 | mcxn235 | mcxn236 | mcxn247 | mcxn526 | mcxn527 | mcxn536 | mcxn537 | mcxn546 | mcxn547 | mcxn556s | mcxn557s | mcxn946 | mcxn947 | mcxw235 | mcxw236 | mcxw716a | mcxw716c | mcxw727a | mcxw727c | mcxw727d | mimx28 | mimx8dxl | mimx8m | mimx8mm | mimx8mn | mimx8mp | mimx8qm | mimx8qxp | mimx8ulp | mimx8x | mimx9131 | mimx9352 | mimx943 | mimx95294 | mimx9596 | mimxrt1010 | mimxrt1015 | mimxrt1020 | mimxrt1024 | mimxrt1040 | mimxrt1043 | mimxrt1046 | mimxrt1050 | mimxrt1060 | mimxrt1064 | mimxrt1165 | mimxrt1166 | mimxrt1171 | mimxrt1172 | mimxrt1173 | mimxrt1175 | mimxrt1176 | mimxrt1181 | mimxrt1182 | mimxrt1186 | mimxrt1187 | mimxrt1189 | mimxrt533s | mimxrt555s | mimxrt595s | mimxrt685s | mimxrt735s | mimxrt758s | mimxrt798s | mwct2012 | mwct2012a | mwct2014s | mwct2015s | mwct2016s | mwct20d2 | mwct20d2a | mwct2d16s | mwct2d17s | nhs52s04 | rw610 | rw612
- -r, --revision <revision>#
Chip revision; if not specified, most recent one will be used
- -a, --address <address>#
Required Starting address
- --file <file>#
Path to file to write
- -h, --hex-string <hex_string>#
String of hex values. e.g. ‘1234’, ‘12 34’
- -c, --count <count>#
Number of bytes to write
tool#
Group of commands for working with various tools over debug probe.
Usage
nxpdebugmbox tool [OPTIONS] COMMAND [ARGS]...
get-families#
Shows the full family info for commands in this group.
Usage
nxpdebugmbox tool get-families [OPTIONS]
Options
- -c, --cmd-name <cmd_name>#
Choose the command name to get full information about NXP families support.
- Options:
reset | get-uuid | halt | resume
get-uuid#
Get the UUID from target if possible.
Some devices need to call ‘start’ command prior the get-uuid! Also there could be issue with repeating of this command without hard reset of device ‘reset -h’.
Usage
nxpdebugmbox tool get-uuid [OPTIONS]
Options
- -f, --family <family>#
[required] Select the chip family.
- Options:
k32w148 | kw45b41z5 | kw45b41z8 | kw45z41052 | kw45z41053 | kw45z41082 | kw45z41083 | kw47b42z83 | kw47b42z96 | kw47b42z97 | kw47b42zb2 | kw47b42zb3 | kw47b42zb6 | kw47b42zb7 | kw47z42082 | kw47z42092 | kw47z420b2 | kw47z420b3 | lpc55s04 | lpc55s06 | lpc55s14 | lpc55s16 | lpc55s26 | lpc55s28 | lpc55s36 | lpc55s66 | lpc55s69 | mcxa132 | mcxa133 | mcxa142 | mcxa143 | mcxa144 | mcxa145 | mcxa146 | mcxa152 | mcxa153 | mcxa154 | mcxa155 | mcxa156 | mcxa173 | mcxa174 | mcxa175 | mcxa176 | mcxa185 | mcxa186 | mcxa255 | mcxa256 | mcxa265 | mcxa266 | mcxa343 | mcxa344 | mcxa345 | mcxa346 | mcxa355 | mcxa356 | mcxa365 | mcxa366 | mcxl253 | mcxl254 | mcxl255 | mcxn235 | mcxn236 | mcxn247 | mcxn526 | mcxn527 | mcxn536 | mcxn537 | mcxn546 | mcxn547 | mcxn556s | mcxn557s | mcxn946 | mcxn947 | mcxw235 | mcxw236 | mcxw716a | mcxw716c | mcxw727a | mcxw727c | mcxw727d | mimx8ulp | mimx9131 | mimx9352 | mimx943 | mimx95294 | mimx9596 | mimxrt1181 | mimxrt1182 | mimxrt1186 | mimxrt1187 | mimxrt1189 | mimxrt533s | mimxrt555s | mimxrt595s | mimxrt685s | mimxrt735s | mimxrt758s | mimxrt798s | nhs52s04 | rw610 | rw612
halt#
Halt CPU execution.
Usage
nxpdebugmbox tool halt [OPTIONS]
Options
- -f, --family <family>#
[required] Select the chip family.
- Options:
k32w148 | kw45b41z5 | kw45b41z8 | kw45z41052 | kw45z41053 | kw45z41082 | kw45z41083 | kw47b42z83 | kw47b42z96 | kw47b42z97 | kw47b42zb2 | kw47b42zb3 | kw47b42zb6 | kw47b42zb7 | kw47z42082 | kw47z42092 | kw47z420b2 | kw47z420b3 | lpc5502 | lpc5504 | lpc5506 | lpc5512 | lpc5514 | lpc5516 | lpc5526 | lpc5528 | lpc5534 | lpc5536 | lpc55s04 | lpc55s06 | lpc55s14 | lpc55s16 | lpc55s26 | lpc55s28 | lpc55s36 | lpc55s66 | lpc55s69 | lpc804 | lpc810 | lpc812 | lpc845 | lpc865 | mc56f81646 | mc56f81648 | mc56f81666 | mc56f81668 | mc56f81746 | mc56f81748 | mc56f81766 | mc56f81768 | mc56f81866 | mc56f81868 | mcxa132 | mcxa133 | mcxa142 | mcxa143 | mcxa144 | mcxa145 | mcxa146 | mcxa152 | mcxa153 | mcxa154 | mcxa155 | mcxa156 | mcxa173 | mcxa174 | mcxa175 | mcxa176 | mcxa185 | mcxa186 | mcxa255 | mcxa256 | mcxa265 | mcxa266 | mcxa343 | mcxa344 | mcxa345 | mcxa346 | mcxa355 | mcxa356 | mcxa365 | mcxa366 | mcxc041 | mcxc141 | mcxc142 | mcxc143 | mcxc144 | mcxc242 | mcxc243 | mcxc244 | mcxc443 | mcxc444 | mcxe245 | mcxe246 | mcxe247 | mcxe315 | mcxe316 | mcxe317 | mcxe31b | mcxl253 | mcxl254 | mcxl255 | mcxn235 | mcxn236 | mcxn247 | mcxn526 | mcxn527 | mcxn536 | mcxn537 | mcxn546 | mcxn547 | mcxn556s | mcxn557s | mcxn946 | mcxn947 | mcxw235 | mcxw236 | mcxw716a | mcxw716c | mcxw727a | mcxw727c | mcxw727d | mimx28 | mimx8dxl | mimx8m | mimx8mm | mimx8mn | mimx8mp | mimx8qm | mimx8qxp | mimx8ulp | mimx8x | mimx9131 | mimx9352 | mimx943 | mimx95294 | mimx9596 | mimxrt1010 | mimxrt1015 | mimxrt1020 | mimxrt1024 | mimxrt1040 | mimxrt1043 | mimxrt1046 | mimxrt1050 | mimxrt1060 | mimxrt1064 | mimxrt1165 | mimxrt1166 | mimxrt1171 | mimxrt1172 | mimxrt1173 | mimxrt1175 | mimxrt1176 | mimxrt1181 | mimxrt1182 | mimxrt1186 | mimxrt1187 | mimxrt1189 | mimxrt533s | mimxrt555s | mimxrt595s | mimxrt685s | mimxrt735s | mimxrt758s | mimxrt798s | mwct2012 | mwct2012a | mwct2014s | mwct2015s | mwct2016s | mwct20d2 | mwct20d2a | mwct2d16s | mwct2d17s | nhs52s04 | rw610 | rw612
reset#
Reset MCU by DebugMailBox.
The reset command implemented in NXPDEBUGMBOX has two modes (option -h):
Reset by RESET REQUEST of debug mailbox that causes the reset of MCU by SYSRESET_REQ. The chip is reset, but the ROM code returns back the chip into debug mailbox handler (without -h/–hard-reset option).
Reset by external reset signal. This reset is done by asserting external reset signal over debug probe. After this reset type the chip behavior is same as after standard reset button on the board. (with -h/–hard-reset option)
Usage
nxpdebugmbox tool reset [OPTIONS]
Options
- -f, --family <family>#
[required] Select the chip family.
- Options:
k32w148 | kw45b41z5 | kw45b41z8 | kw45z41052 | kw45z41053 | kw45z41082 | kw45z41083 | kw47b42z83 | kw47b42z96 | kw47b42z97 | kw47b42zb2 | kw47b42zb3 | kw47b42zb6 | kw47b42zb7 | kw47z42082 | kw47z42092 | kw47z420b2 | kw47z420b3 | lpc5502 | lpc5504 | lpc5506 | lpc5512 | lpc5514 | lpc5516 | lpc5526 | lpc5528 | lpc5534 | lpc5536 | lpc55s04 | lpc55s06 | lpc55s14 | lpc55s16 | lpc55s26 | lpc55s28 | lpc55s36 | lpc55s66 | lpc55s69 | lpc804 | lpc810 | lpc812 | lpc845 | lpc865 | mc56f81646 | mc56f81648 | mc56f81666 | mc56f81668 | mc56f81746 | mc56f81748 | mc56f81766 | mc56f81768 | mc56f81866 | mc56f81868 | mcxa132 | mcxa133 | mcxa142 | mcxa143 | mcxa144 | mcxa145 | mcxa146 | mcxa152 | mcxa153 | mcxa154 | mcxa155 | mcxa156 | mcxa173 | mcxa174 | mcxa175 | mcxa176 | mcxa185 | mcxa186 | mcxa255 | mcxa256 | mcxa265 | mcxa266 | mcxa343 | mcxa344 | mcxa345 | mcxa346 | mcxa355 | mcxa356 | mcxa365 | mcxa366 | mcxc041 | mcxc141 | mcxc142 | mcxc143 | mcxc144 | mcxc242 | mcxc243 | mcxc244 | mcxc443 | mcxc444 | mcxe245 | mcxe246 | mcxe247 | mcxe315 | mcxe316 | mcxe317 | mcxe31b | mcxl253 | mcxl254 | mcxl255 | mcxn235 | mcxn236 | mcxn247 | mcxn526 | mcxn527 | mcxn536 | mcxn537 | mcxn546 | mcxn547 | mcxn556s | mcxn557s | mcxn946 | mcxn947 | mcxw235 | mcxw236 | mcxw716a | mcxw716c | mcxw727a | mcxw727c | mcxw727d | mimx28 | mimx8dxl | mimx8m | mimx8mm | mimx8mn | mimx8mp | mimx8qm | mimx8qxp | mimx8ulp | mimx8x | mimx9131 | mimx9352 | mimx943 | mimx95294 | mimx9596 | mimxrt1010 | mimxrt1015 | mimxrt1020 | mimxrt1024 | mimxrt1040 | mimxrt1043 | mimxrt1046 | mimxrt1050 | mimxrt1060 | mimxrt1064 | mimxrt1165 | mimxrt1166 | mimxrt1171 | mimxrt1172 | mimxrt1173 | mimxrt1175 | mimxrt1176 | mimxrt1181 | mimxrt1182 | mimxrt1186 | mimxrt1187 | mimxrt1189 | mimxrt533s | mimxrt555s | mimxrt595s | mimxrt685s | mimxrt735s | mimxrt758s | mimxrt798s | mwct2012 | mwct2012a | mwct2014s | mwct2015s | mwct2016s | mwct20d2 | mwct20d2a | mwct2d16s | mwct2d17s | nhs52s04 | rw610 | rw612
- -r, --revision <revision>#
Chip revision; if not specified, most recent one will be used
- -h, --hard-reset#
When used, the hardware reset is used instead of debug mailbox reset.
resume#
Resume CPU execution.
Usage
nxpdebugmbox tool resume [OPTIONS]
Options
- -f, --family <family>#
[required] Select the chip family.
- Options:
k32w148 | kw45b41z5 | kw45b41z8 | kw45z41052 | kw45z41053 | kw45z41082 | kw45z41083 | kw47b42z83 | kw47b42z96 | kw47b42z97 | kw47b42zb2 | kw47b42zb3 | kw47b42zb6 | kw47b42zb7 | kw47z42082 | kw47z42092 | kw47z420b2 | kw47z420b3 | lpc5502 | lpc5504 | lpc5506 | lpc5512 | lpc5514 | lpc5516 | lpc5526 | lpc5528 | lpc5534 | lpc5536 | lpc55s04 | lpc55s06 | lpc55s14 | lpc55s16 | lpc55s26 | lpc55s28 | lpc55s36 | lpc55s66 | lpc55s69 | lpc804 | lpc810 | lpc812 | lpc845 | lpc865 | mc56f81646 | mc56f81648 | mc56f81666 | mc56f81668 | mc56f81746 | mc56f81748 | mc56f81766 | mc56f81768 | mc56f81866 | mc56f81868 | mcxa132 | mcxa133 | mcxa142 | mcxa143 | mcxa144 | mcxa145 | mcxa146 | mcxa152 | mcxa153 | mcxa154 | mcxa155 | mcxa156 | mcxa173 | mcxa174 | mcxa175 | mcxa176 | mcxa185 | mcxa186 | mcxa255 | mcxa256 | mcxa265 | mcxa266 | mcxa343 | mcxa344 | mcxa345 | mcxa346 | mcxa355 | mcxa356 | mcxa365 | mcxa366 | mcxc041 | mcxc141 | mcxc142 | mcxc143 | mcxc144 | mcxc242 | mcxc243 | mcxc244 | mcxc443 | mcxc444 | mcxe245 | mcxe246 | mcxe247 | mcxe315 | mcxe316 | mcxe317 | mcxe31b | mcxl253 | mcxl254 | mcxl255 | mcxn235 | mcxn236 | mcxn247 | mcxn526 | mcxn527 | mcxn536 | mcxn537 | mcxn546 | mcxn547 | mcxn556s | mcxn557s | mcxn946 | mcxn947 | mcxw235 | mcxw236 | mcxw716a | mcxw716c | mcxw727a | mcxw727c | mcxw727d | mimx28 | mimx8dxl | mimx8m | mimx8mm | mimx8mn | mimx8mp | mimx8qm | mimx8qxp | mimx8ulp | mimx8x | mimx9131 | mimx9352 | mimx943 | mimx95294 | mimx9596 | mimxrt1010 | mimxrt1015 | mimxrt1020 | mimxrt1024 | mimxrt1040 | mimxrt1043 | mimxrt1046 | mimxrt1050 | mimxrt1060 | mimxrt1064 | mimxrt1165 | mimxrt1166 | mimxrt1171 | mimxrt1172 | mimxrt1173 | mimxrt1175 | mimxrt1176 | mimxrt1181 | mimxrt1182 | mimxrt1186 | mimxrt1187 | mimxrt1189 | mimxrt533s | mimxrt555s | mimxrt595s | mimxrt685s | mimxrt735s | mimxrt758s | mimxrt798s | mwct2012 | mwct2012a | mwct2014s | mwct2015s | mwct2016s | mwct20d2 | mwct20d2a | mwct2d16s | mwct2d17s | nhs52s04 | rw610 | rw612