Snippets for an nRF91 Series device
nRF91 Series’ Snippets are tailored for tracing on the nRF91 Series devices but can work with other boards as well. On nRF91 Series devices, you can enable the following functionalities using snippets:
Functionality |
Snippet name |
Compatible board targets |
|---|---|---|
|
|
|
|
||
|
||
|
||
|
nRF91 modem traces with flash backend using snippets
The nrf91-modem-trace-ext-flash snippet enables modem tracing, the flash backend, and external flash and configures them to store modem traces to a dedicated partition on the external flash for supported boards.
To change the partition size, the project needs to configure the CONFIG_NRF_MODEM_LIB_TRACE_BACKEND_FLASH_PARTITION_SIZE Kconfig option.
To enable modem traces with the flash backend, add the nrf91-modem-trace-ext-flash snippet to the build configuration.
You can do this in one of the following ways:
To add the modem traces with the flash backend snippet when building an application with west, use the following command pattern, where board_target corresponds to your board target and <image_name> to your application image name:
west build --board board_target -- -D<image_name>_SNIPPET="nrf91-modem-trace-ext-flash"
To add the modem traces with the flash backend snippet when building an application with CMake, add the following command to the CMake arguments:
-D<image_name>_SNIPPET="nrf91-modem-trace-ext-flash" [...]
To build with the nRF Connect for VS Code extension, specify -D<image_name>_SNIPPET="nrf91-modem-trace-ext-flash" [...] in the Extra CMake arguments field.
See Providing CMake options for more details.
nRF91 modem traces with RAM backend using snippets
The nrf91-modem-trace-ram snippet enables modem tracing and configures it to store modem traces to a dedicated partition on the RAM.
To change the partition size, the project needs to configure the CONFIG_NRF_MODEM_LIB_TRACE_BACKEND_RAM_LENGTH Kconfig option.
To enable modem traces with the RAM backend, add the nrf91-modem-trace-ram snippet to the build configuration.
You can do this in one of the following ways:
To add modem traces with the RAM backend when building an application with west, use the following command pattern, where board_target corresponds to your board target and <image_name> to your application image name:
west build --board board_target -- -D<image_name>_SNIPPET="nrf91-modem-trace-ram"
To add the modem traces with the RAM backend snippet when building an application with CMake, add the following command to the CMake arguments:
-D<image_name>_SNIPPET="nrf91-modem-trace-ram" [...]
To build with the nRF Connect for VS Code extension, specify -D<image_name>_SNIPPET="nrf91-modem-trace-ram" [...] in the Extra CMake arguments field.
See Providing CMake options for more details.
nRF91 modem tracing with UART backend using snippets
The nrf91-modem-trace-uart snippet enables the CONFIG_NRF_MODEM_LIB_TRACE Kconfig option and chooses the Zephyr UART driver for the backend, with the necessary Kconfig options.
The snippet also enables the UART1 peripheral with a baud rate of 1 Mbd and hardware flow control enabled.
If this configuration does not match your requirements, you can add a snippet or Kconfig and devicetree overlays to your application with the desired setup.
Note
If you are using the nRF9160 DK, remember to set the board controller switch to the **nRF91** position before programming.
To enable modem tracing with the UART trace backend on a nRF91 Series device, add the nrf91-modem-trace-uart snippet to the build configuration.
You can do this in one of the following ways:
To add the modem trace UART snippet when building an application with west, use the following command pattern, where board_target corresponds to your board target and <image_name> to your application image name:
west build --board board_target -- -D<image_name>_SNIPPET="nrf91-modem-trace-uart"
Note
With sysbuild, using the west build -S option applies the snippet to all images.
Therefore, use the CMake argument instead, specifying the application image.
To add the modem trace UART snippet when building an application with CMake, add the following command to the CMake arguments:
-D<image_name>_SNIPPET="nrf91-modem-trace-uart" [...]
To build with the nRF Connect for VS Code extension, specify -D<image_name>_SNIPPET="nrf91-modem-trace-uart" [...] in the Extra CMake arguments field.
See Providing CMake options for more details.
nRF91 modem traces with RTT backend using snippets
The nrf91-modem-trace-rtt snippet enables the CONFIG_NRF_MODEM_LIB_TRACE Kconfig option and chooses the RTT trace backend with the necessary Kconfig options.
To enable modem tracing with the RTT backend, add the nrf91-modem-trace-rtt snippet to the build configuration.
You can do this in one of the following ways:
To add modem traces with the RTT backend when building an application with west, use the following command pattern, where board_target corresponds to your board target and <image_name> to your application image name:
west build --board board_target -- -D<image_name>_SNIPPET="nrf91-modem-trace-rtt"
To add the modem traces with the RTT backend snippet when building an application with CMake, add the following command to the CMake arguments:
-D<image_name>_SNIPPET="nrf91-modem-trace-rtt" [...]
To build with the nRF Connect for VS Code extension, specify -D<image_name>_SNIPPET="nrf91-modem-trace-rtt" [...] in the Extra CMake arguments field.
See Providing CMake options for more details.