README.rst
1.. _snippet-cdc-acm-console:
2
3CDC-ACM Console Snippet (cdc-acm-console)
4#########################################
5
6.. code-block:: console
7
8 west build -S cdc-acm-console [...]
9
10Overview
11********
12
13This snippet redirects serial console output to a CDC ACM UART. The USB device
14which should be used is configured using :ref:`devicetree`.
15
16Requirements
17************
18
19Hardware support for:
20
21- :kconfig:option:`CONFIG_USB_DEVICE_STACK`
22- :kconfig:option:`CONFIG_SERIAL`
23- :kconfig:option:`CONFIG_CONSOLE`
24- :kconfig:option:`CONFIG_UART_CONSOLE`
25- :kconfig:option:`CONFIG_UART_LINE_CTRL`
26
27A devicetree node with node label ``zephyr_udc0`` that points to an enabled USB
28device node with driver support. This should look roughly like this in
29:ref:`your devicetree <get-devicetree-outputs>`:
30
31.. code-block:: DTS
32
33 zephyr_udc0: usbd@deadbeef {
34 compatible = "vnd,usb-device";
35 /* ... */
36 };
37
