Skip to content

Commit a842685

Browse files
rluboscarlescufi
authored andcommitted
doc: samples: Clarify on how to enable USB support in certain samples
It's now also needed to set the DTC_OVERLAY_FILE variable in order to enable USB support in certain samples. Signed-off-by: Robert Lubos <[email protected]>
1 parent adda654 commit a842685

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

doc/nrf/ug_thread_tools.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ To program the nRF device with the RCP application, complete the following steps
8787

8888
.. code-block:: console
8989
90-
west build -p always -b nrf52840dongle_nrf52840 nrf/samples/openthread/coprocessor/ -- -DOVERLAY_CONFIG="overlay-rcp.conf ../cli/overlay-thread_1_2.conf overlay-usb.conf"
90+
west build -p always -b nrf52840dongle_nrf52840 nrf/samples/openthread/coprocessor/ -- -DOVERLAY_CONFIG="overlay-rcp.conf ../cli/overlay-thread_1_2.conf overlay-usb.conf" -DDTC_OVERLAY_FILE="usb.overlay"
9191
9292
.. tab:: nRF52840 Development Kit (UART transport)
9393

samples/bluetooth/peripheral_uart/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Activating sample extensions
135135
To activate the optional extensions supported by this sample, modify :makevar:`OVERLAY_CONFIG` in the following manner:
136136

137137
* For the minimal build variant, set :file:`prj_minimal.conf`.
138-
* For the USB CDC ACM extension, set :file:`prj_cdc.conf`.
138+
* For the USB CDC ACM extension, set :file:`prj_cdc.conf`. Additionally, you need to set :makevar:`DTC_OVERLAY_FILE` to :file:`usb.overlay`.
139139

140140
See :ref:`cmake_options` for instructions on how to add this option.
141141
For more information about using configuration overlay files, see :ref:`zephyr:important-build-vars` in the Zephyr documentation.

samples/openthread/cli/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ To activate the optional extensions supported by this sample, modify :makevar:`O
120120
* For the experimental Thread 1.2 variant, set :file:`overlay-thread_1_2.conf`.
121121
* For the minimal single protocol variant, set :file:`overlay-minimal_singleprotocol.conf`.
122122
* For the minimal multiprotocol variant, set :file:`overlay-minimal_multiprotocol.conf`.
123-
* For USB transport support, set :file:`overlay-usb.conf`.
123+
* For USB transport support, set :file:`overlay-usb.conf`. Additionally, you need to set :makevar:`DTC_OVERLAY_FILE` to :file:`usb.overlay`.
124124

125125
See :ref:`cmake_options` for instructions on how to add this option.
126126
For more information about using configuration overlay files, see :ref:`zephyr:important-build-vars` in the Zephyr documentation.

samples/openthread/coprocessor/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ The following configuration files are available:
126126
* :file:`overlay-minimal_rcp.conf` - Enables a minimal configuration that reduces the code size and RAM usage.
127127
This file enables the RCP architecture with basic functionality and optimizes stacks and buffer sizes.
128128
For more information, see :ref:`app_memory`.
129-
* :file:`overlay-usb.conf` - Enables emulating a serial port over USB for Spinel communication with the host.
129+
* :file:`overlay-usb.conf` - Enables emulating a serial port over USB for Spinel communication with the host. Additionally, you need to set :makevar:`DTC_OVERLAY_FILE` to :file:`usb.overlay`.
130130

131131
Building and running
132132
********************

0 commit comments

Comments
 (0)