mirror/pico-sdk
1
0
Fork 0
mirror of https://github.com/raspberrypi/pico-sdk.git synced 2025-02-05 18:40:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
andygpz11 2024-07-25 17:12:21 +01:00 committed by GitHub
parent 9f85f25640
commit b3bf690d0a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/rp2_common/hardware_uart/include/hardware/uart.h
View File

@ -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