From 67919e42eb653f04e6ee86afc9f55186e8c08c4a Mon Sep 17 00:00:00 2001 From: Andrew Burge Date: Tue, 21 May 2024 14:19:13 +0100 Subject: [PATCH] Clarify uart_write_blocking() API vs UART still busy sending (#1274) --- src/rp2_common/hardware_uart/include/hardware/uart.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/rp2_common/hardware_uart/include/hardware/uart.h b/src/rp2_common/hardware_uart/include/hardware/uart.h index 12d6a1456..8cbbf21f9 100644 --- a/src/rp2_common/hardware_uart/include/hardware/uart.h +++ b/src/rp2_common/hardware_uart/include/hardware/uart.h @@ -310,7 +310,8 @@ static inline bool uart_is_readable(uart_inst_t *uart) { /*! \brief Write to the UART for transmission. * \ingroup hardware_uart * - * This function will block until all the data has been sent to the UART + * This function will block until all the data has been written to the UART. + * To check for UART Tx FIFO empty, please see: uart_tx_wait_blocking() * * \param uart UART instance. \ref uart0 or \ref uart1 * \param src The bytes to send