abawo/pico-sdk
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

issue 1219, minor improvements to doxygen comments (#1223)

Browse Source
This commit is contained in:
Brad S
2023-02-05 17:00:26 -08:00
committed by GitHub
parent 795d021ca6
commit a916761e7d
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -278,9 +278,8 @@ static inline void uart_tx_wait_blocking(uart_inst_t *uart) {
* \ingroup hardware_uart * \ingroup hardware_uart
* *
* \param uart UART instance. \ref uart0 or \ref uart1 * \param uart UART instance. \ref uart0 or \ref uart1
* \return 0 if no data available, otherwise the number of bytes, at least, that can be read * \return true if the RX FIFO is not empty, otherwise false.
* *
* \note HW limitations mean this function will return either 0 or 1.
*/ */
static inline bool uart_is_readable(uart_inst_t *uart) { static inline bool uart_is_readable(uart_inst_t *uart) {
// PL011 doesn't expose levels directly, so return values are only 0 or 1 // PL011 doesn't expose levels directly, so return values are only 0 or 1
@ -307,7 +306,7 @@ static inline void uart_write_blocking(uart_inst_t *uart, const uint8_t *src, si
/*! \brief Read from the UART /*! \brief Read from the UART
* \ingroup hardware_uart * \ingroup hardware_uart
* *
* This function will block until all the data has been received from the UART * This function blocks until len characters have been read from the UART
* *
* \param uart UART instance. \ref uart0 or \ref uart1 * \param uart UART instance. \ref uart0 or \ref uart1
* \param dst Buffer to accept received bytes * \param dst Buffer to accept received bytes
@ -378,10 +377,10 @@ static inline void uart_puts(uart_inst_t *uart, const char *s) {
#endif #endif
} }
/*! \brief Read a single character to UART /*! \brief Read a single character from the UART
* \ingroup hardware_uart * \ingroup hardware_uart
* *
* This function will block until the character has been read * This function will block until a character has been read
* *
* \param uart UART instance. \ref uart0 or \ref uart1 * \param uart UART instance. \ref uart0 or \ref uart1
* \return The character read. * \return The character read.