michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: porting: add note about CDC ACM UART configuration

Browse source 
Clarify how to configure serial output for the console for the two most
common cases. Follow up on commit 0cae816b27
("boards: add common configuration for CDC ACM UART")

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
This commit is contained in:
Johann Fischer 2024-12-17 12:05:15 +01:00 • committed by Benjamin Cabé
commit 59a7b972a2
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
doc/hardware/porting/board_porting.rst
View file

@ -649,6 +649,15 @@ while porting.
- If available, configure and enable a serial output for the console
using the ``zephyr,console`` chosen node in the devicetree.
Development boards with a built-in debug adapter or USB-to-UART adapter should
by default configure and use the UART controller connected to that adapter.
For boards like :ref:`nRF52840 Dongle <nrf52840dongle_nrf52840>`, that do not
have a debug adapter, but a USB device controller, there is a common
:zephyr_file:`Kconfig file <boards/common/usb/Kconfig.cdc_acm_serial.defconfig>`
that must be included in the board's Kconfig.defconfig file and
:zephyr_file:`devicetree file <boards/common/usb/cdc_acm_serial.dtsi>`
that must be included if the board's devicetree, if the board want to use the
CDC ACM UART as the default backend for logging and shell.
- If your board supports networking, configure a default interface.