zephyr/snippets/cdc-acm-console/README.rst
Martí Bolívar cac263ec3f snippets: add cdc-acm-console
This snippet is based on samples/subsys/usb/console. Since it's a
snippet, it can be used in any application as long as its requirements
are met. This makes it more general purpose.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2023-03-26 16:12:41 +02:00

37 lines
898 B
ReStructuredText

.. _snippet-cdc-acm-console:
CDC-ACM Console Snippet (cdc-acm-console)
#########################################
.. code-block:: console
west build -S cdc-acm-console [...]
Overview
********
This snippet redirects serial console output to a CDC ACM UART. The USB device
which should be used is configured using :ref:`devicetree`.
Requirements
************
Hardware support for:
- :kconfig:option:`CONFIG_USB_DEVICE_STACK`
- :kconfig:option:`CONFIG_SERIAL`
- :kconfig:option:`CONFIG_CONSOLE`
- :kconfig:option:`CONFIG_UART_CONSOLE`
- :kconfig:option:`CONFIG_UART_LINE_CTRL`
A devicetree node with node label ``zephyr_udc0`` that points to an enabled USB
device node with driver support. This should look roughly like this in
:ref:`your devicetree <get-devicetree-outputs>`:
.. code-block:: DTS
zephyr_udc0: usbd@deadbeef {
compatible = "vnd,usb-device";
/* ... */
};