From 1ddb813bcf7ca85a36ace349ecc9142ca5194c20 Mon Sep 17 00:00:00 2001
From: ReFil <31960031+ReFil@users.noreply.github.com>
Date: Sun, 26 Nov 2023 18:23:32 +0000
Subject: [PATCH] docs: Document adding USB logging to a standalone board

Currently this is only documented in the zephyr 3.0 upgrade blog. This explicitly documents it as well as when it doesn't need to be applied (i.e. when a mcu board is already in use)
---
 docs/docs/development/usb-logging.md | 29 ++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/docs/docs/development/usb-logging.md b/docs/docs/development/usb-logging.md
index e50e7824..23324537 100644
--- a/docs/docs/development/usb-logging.md
+++ b/docs/docs/development/usb-logging.md
@@ -83,3 +83,32 @@ You should see tio printing `Disconnected` or `Connected` when you disconnect or
 </Tabs>
 
 From there, you should see the various log messages from ZMK and Zephyr, depending on which systems you have set to what log levels.
+
+## 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.
+
+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 `<board>.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";
+  };
+};
+```
+
+Then you can add the `zephyr,console` binding in the `chosen` node
+
+```dts
+/ {
+  chosen {
+    ...
+    zephyr,console = &cdc_acm_uart;
+  };
+  ...
+};
+```