Skip to content

Commit

Permalink
include: drivers: uart: fix incorrect event name in brief
Browse files Browse the repository at this point in the history
The use of UART_RX_DONE was incorrect/invalid (the event does not exist).
This corrects the reference to UART_RX_RDY.

Fixes #31207

Signed-off-by: Jennifer Williams <[email protected]>
  • Loading branch information
jenmwms authored Feb 3, 2021
1 parent 2d65d72 commit 04d3d4e
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions include/drivers/uart.h
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,9 @@ enum uart_line_ctrl {
*
* - Provide second buffer using uart_rx_buf_rsp, when first buffer is
* filled, receiving will automatically start to second buffer.
* - Ignore the event, this way when current buffer is filled UART_RX_DONE
* event will be generated and receiving will be stopped.
* - Ignore the event, this way when current buffer is filled
* @ref uart_event_type::UART_RX_RDY event will be generated and
* receiving will be stopped.
*
* 3. If some data was received and timeout occurred
* @ref uart_event_type::UART_RX_RDY event will be generated. It can happen
Expand Down

0 comments on commit 04d3d4e

Please sign in to comment.