From 3612ecdf9f17d48e4c8815a08bd24e0b530c78cd Mon Sep 17 00:00:00 2001 From: ReFil <31960031+ReFil@users.noreply.github.com> Date: Mon, 27 Nov 2023 08:53:58 +0000 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Cem Aksoylar --- docs/docs/development/usb-logging.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/docs/development/usb-logging.md b/docs/docs/development/usb-logging.md index 23324537..aafad572 100644 --- a/docs/docs/development/usb-logging.md +++ b/docs/docs/development/usb-logging.md @@ -86,29 +86,29 @@ From there, you should see the various log messages from ZMK and Zephyr, dependi ## Adding USB logging to a board -Standard boards such as the nice!nano and Seeeduinoo XIAO family have logging already added, however if you are developing your own standalone board you may wish to add the ability to use USB logging in the future. +Standard boards such as the nice!nano and Seeeduino XIAO family have the necessary configuration for logging already added, however if you are developing your own standalone board you may wish to add the ability to use USB logging in the future. -To add USB logging to a board you need to define the USB CDC ACM device that the serial output gets piped to as well as adding the console in the `chosen` node inside `.dts` +To add USB logging to a board you need to define the USB CDC ACM device that the serial output gets piped to, as well as adding the console in the `chosen` node inside `.dts`. Inside the USB device (`&usbd`), add the CDC ACM node: ```dts &usbd { - status = "okay"; - cdc_acm_uart: cdc_acm_uart { - compatible = "zephyr,cdc-acm-uart"; - }; + status = "okay"; + cdc_acm_uart: cdc_acm_uart { + compatible = "zephyr,cdc-acm-uart"; + }; }; ``` -Then you can add the `zephyr,console` binding in the `chosen` node +Then you can add the `zephyr,console` binding in the `chosen` node: ```dts / { - chosen { + chosen { + ... + zephyr,console = &cdc_acm_uart; + }; ... - zephyr,console = &cdc_acm_uart; - }; - ... }; ```