Skip to content

Commit c544235

Browse files
author
Hubert Miś
committed
drivers: uart: clarification of poll_out blocking duration
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ś <[email protected]>
1 parent 1a5ae37 commit c544235

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

include/zephyr/drivers/uart.h

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -561,10 +561,11 @@ static inline int z_impl_uart_poll_in_u16(const struct device *dev,
561561
/**
562562
* @brief Write a character to the device for output.
563563
*
564-
* This routine checks if the transmitter is full. When the
564+
* This routine checks if the transmitter is full. When the
565565
* transmitter is not full, it writes a character to the data
566-
* register. It waits and blocks the calling thread, otherwise. This
567-
* function is a blocking call.
566+
* register. It waits and blocks the calling thread otherwise. This
567+
* function is a blocking call. It blocks the calling thread until the
568+
* character is sent.
568569
*
569570
* To send a character when hardware flow control is enabled, the handshake
570571
* signal CTS must be asserted.

0 commit comments

Comments
 (0)