feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Merge branch 'docs/update_uart_events_description' into 'master'

Browse Source 
docs: update descriptions for UART events

See merge request espressif/esp-idf!34049
This commit is contained in:
Song Ruo Jing
2024-11-04 16:30:20 +08:00
parent 5504a596e2 10e6101061
commit 3357fe8b95
1 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
components/esp_driver_uart/include/driver/uart.h
View File

@@ -67,18 +67,20 @@ typedef struct {
* @brief UART event types used in the ring buffer
*/
typedef enum {
UART_DATA, /*!< UART data event*/
UART_BREAK, /*!< UART break event*/
UART_BUFFER_FULL, /*!< UART RX buffer full event*/
UART_FIFO_OVF, /*!< UART FIFO overflow event*/
UART_FRAME_ERR, /*!< UART RX frame error event*/
UART_PARITY_ERR, /*!< UART RX parity event*/
UART_DATA_BREAK, /*!< UART TX data and break event*/
UART_PATTERN_DET, /*!< UART pattern detected */
UART_DATA, /*!< Triggered when the receiver either takes longer than rx_timeout_thresh
to receive a byte, or when more data is received than what rxfifo_full_thresh
specifies*/
UART_BREAK, /*!< Triggered when the receiver detects a NULL character*/
UART_BUFFER_FULL, /*!< Triggered when RX ring buffer is full*/
UART_FIFO_OVF, /*!< Triggered when the received data exceeds the capacity of the RX FIFO*/
UART_FRAME_ERR, /*!< Triggered when the receiver detects a data frame error*/
UART_PARITY_ERR, /*!< Triggered when a parity error is detected in the received data*/
UART_DATA_BREAK, /*!< Internal event triggered to signal a break afte data transmission*/
UART_PATTERN_DET, /*!< Triggered when a specified pattern is detected in the incoming data*/
#if SOC_UART_SUPPORT_WAKEUP_INT
UART_WAKEUP, /*!< UART wakeup event */
UART_WAKEUP, /*!< Triggered when a wakeup signal is detected*/
#endif
UART_EVENT_MAX, /*!< UART event max index*/
UART_EVENT_MAX, /*!< Maximum index for UART events*/
} uart_event_type_t;
/**