Clarify uart_write_blocking() API vs UART still busy sending (#1274) (#1709)

andygpz11 · web-flow · commit b3bf690d0a4c · 2024-07-25T11:12:21.000-05:00
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -312,6 +312,9 @@ static inline bool uart_is_readable(uart_inst_t *uart) {`
`312`	`312`	`* \ingroup hardware_uart`
`313`	`313`	`*`
`314`	`314`	`* This function will block until all the data has been sent to the UART transmit buffer`
	`315`	`+ * hardware. Note: Serial data transmission will continue until the Tx FIFO and`
	`316`	`+ * the transmit shift register (not programmer-accessible) are empty.`
	`317`	`+ * To ensure the UART FIFO has been emptied, you can use \ref uart_tx_wait_blocking()`
`315`	`318`	`*`
`316`	`319`	`* \param uart UART instance. \ref uart0 or \ref uart1`
`317`	`320`	`* \param src The bytes to send`