Skip to content

Commit a7a8469

Browse files
Hubert Miśkartben
authored andcommitted
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 1050f53 commit a7a8469

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
@@ -380,10 +380,11 @@ __syscall int uart_poll_in_u16(const struct device *dev, uint16_t *p_u16);
380380
/**
381381
* @brief Write a character to the device for output.
382382
*
383-
* This routine checks if the transmitter is full. When the
383+
* This routine checks if the transmitter is full. When the
384384
* transmitter is not full, it writes a character to the data
385-
* register. It waits and blocks the calling thread, otherwise. This
386-
* function is a blocking call.
385+
* register. It waits and blocks the calling thread otherwise. This
386+
* function is a blocking call. It blocks the calling thread until the
387+
* character is sent.
387388
*
388389
* To send a character when hardware flow control is enabled, the handshake
389390
* signal CTS must be asserted.

0 commit comments

Comments
 (0)