drivers: uart: clarification of poll_out blocking duration (a7a8469b) · Commits · Wenxi XU / zephyr

The API docs state that the uart_poll_out is a blocking call, but it does not specify how long a call to this function should block the calling thread. This is described in the UART driver documentation. This patch clarifies the API docs and alignes it with the driver documentation. Signed-off-by:

Hubert Miś <hubert.mis@nordicsemi.no>

include/zephyr/drivers/uart.h

+3 −2

Changes for include/zephyr/drivers/uart.h: 3 added lines, 2 removed lines.
Original line number	Diff line number	Diff line
		@@ -382,8 +382,9 @@ __syscall int uart_poll_in_u16(const struct device dev, uint16_t p_u16);
		*
		* This routine checks if the transmitter is full. When the
		* transmitter is not full, it writes a character to the data
		* register. It waits and blocks the calling thread, otherwise. This
		* function is a blocking call.
		* register. It waits and blocks the calling thread otherwise. This
		* function is a blocking call. It blocks the calling thread until the
		* character is sent.
		*
		* To send a character when hardware flow control is enabled, the handshake
		* signal CTS must be asserted.

Admin message