From f5769830a1ca8aefe8d585bdeeb7628d69fc4eec Mon Sep 17 00:00:00 2001 From: Johann Fischer Date: Fri, 5 Jul 2024 13:49:25 +0200 Subject: [PATCH] doc: usb: add note about CDC ACM virtual UART polling API behavior Add note about CDC ACM virtual UART polling API behavior. Signed-off-by: Johann Fischer --- doc/connectivity/usb/device_next/usb_device.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/connectivity/usb/device_next/usb_device.rst b/doc/connectivity/usb/device_next/usb_device.rst index eac40fbd025e783..f545ede16825444 100644 --- a/doc/connectivity/usb/device_next/usb_device.rst +++ b/doc/connectivity/usb/device_next/usb_device.rst @@ -280,3 +280,10 @@ connected to the host. If there is space in the TX FIFO, and the TX interrupt is enabled, :c:func:`uart_irq_tx_ready()` will succeed. If there is data in the RX FIFO, and the RX interrupt is enabled, :c:func:`uart_irq_rx_ready()` will succeed. Function :c:func:`uart_irq_tx_complete()` is not implemented yet. + +UART Polling API +---------------- + +The CDC ACM poll out implementation follows :ref:`uart_polling_api` and +blocks when the TX FIFO is full only if the hw-flow-control property is enabled +and called from a non-ISR context.