From b3bf690d0a4cd37d58022afb46c67fe813b1143a Mon Sep 17 00:00:00 2001
From: andygpz11 <111971637+andygpz11@users.noreply.github.com>
Date: Thu, 25 Jul 2024 17:12:21 +0100
Subject: [PATCH] Clarify uart_write_blocking() API vs UART still busy sending
(#1274) (#1709)
---
src/rp2_common/hardware_uart/include/hardware/uart.h | 3 +++
1 file changed, 3 insertions(+)
diff --git a/src/rp2_common/hardware_uart/include/hardware/uart.h b/src/rp2_common/hardware_uart/include/hardware/uart.h
index 5e4e3ea..a574150 100644
--- a/src/rp2_common/hardware_uart/include/hardware/uart.h
+++ b/src/rp2_common/hardware_uart/include/hardware/uart.h
@@ -312,6 +312,9 @@ static inline bool uart_is_readable(uart_inst_t *uart) {
* \ingroup hardware_uart
*
* This function will block until all the data has been sent to the UART transmit buffer
+ * hardware. Note: Serial data transmission will continue until the Tx FIFO and
+ * the transmit shift register (not programmer-accessible) are empty.
+ * To ensure the UART FIFO has been emptied, you can use \ref uart_tx_wait_blocking()
*
* \param uart UART instance. \ref uart0 or \ref uart1
* \param src The bytes to send
--
GitLab