diff options
Diffstat (limited to 'os/hal/src/hal_uart.c')
| -rw-r--r-- | os/hal/src/hal_uart.c | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/os/hal/src/hal_uart.c b/os/hal/src/hal_uart.c index 72d6221dd..8df77adb5 100644 --- a/os/hal/src/hal_uart.c +++ b/os/hal/src/hal_uart.c @@ -352,6 +352,8 @@ size_t uartStopReceiveI(UARTDriver *uartp) { * sent to the UART or on timeout.
* @note The buffers are organized as uint8_t arrays for data sizes below
* or equal to 8 bits else it is organized as uint16_t arrays.
+ * @note This function implements a software timeout, it does not use
+ * any underlying HW timeout mechanism.
*
* @param[in] uartp pointer to the @p UARTDriver object
* @param[in,out] np number of data frames to transmit, on exit the number
@@ -395,6 +397,8 @@ msg_t uartSendTimeout(UARTDriver *uartp, size_t *np, * physically transmitted or on timeout.
* @note The buffers are organized as uint8_t arrays for data sizes below
* or equal to 8 bits else it is organized as uint16_t arrays.
+ * @note This function implements a software timeout, it does not use
+ * any underlying HW timeout mechanism.
*
* @param[in] uartp pointer to the @p UARTDriver object
* @param[in,out] np number of data frames to transmit, on exit the number
@@ -438,6 +442,8 @@ msg_t uartSendFullTimeout(UARTDriver *uartp, size_t *np, * received or on error/timeout.
* @note The buffers are organized as uint8_t arrays for data sizes below
* or equal to 8 bits else it is organized as uint16_t arrays.
+ * @note This function implements a software timeout, it does not use
+ * any underlying HW timeout mechanism.
*
* @param[in] uartp pointer to the @p UARTDriver object
* @param[in,out] np number of data frames to receive, on exit the number
|