Espressif ESP32-S2 - Page 478

Chapter 2. API Reference
• ESP_OK Success, result will be put in (*flow_ctrl)
Parameters
• uart_num: UART port number, the max port number is (UART_NUM_MAX -1).
• flow_ctrl: Option for different flow control mode.
esp_err_t uart_clear_intr_status(uart_port_t uart_num, uint32_t clr_mask)
Clear UART interrupt status.
Return
• ESP_OK Success
• ESP_FAIL Parameter error
Parameters
• uart_num: UART port number, the max port number is (UART_NUM_MAX -1).
• clr_mask: Bit mask of the interrupt status to be cleared.
esp_err_t uart_enable_intr_mask(uart_port_t uart_num, uint32_t enable_mask)
Set UART interrupt enable.
Return
• ESP_OK Success
• ESP_FAIL Parameter error
Parameters
• uart_num: UART port number, the max port number is (UART_NUM_MAX -1).
• enable_mask: Bit mask of the enable bits.
esp_err_t uart_disable_intr_mask(uart_port_t uart_num, uint32_t disable_mask)
Clear UART interrupt enable bits.
Return
• ESP_OK Success
• ESP_FAIL Parameter error
Parameters
• uart_num: UART port number, the max port number is (UART_NUM_MAX -1).
• disable_mask: Bit mask of the disable bits.
esp_err_t uart_enable_rx_intr(uart_port_t uart_num)
Enable UART RX interrupt (RX_FULL & RX_TIMEOUT INTERRUPT)
Return
• ESP_OK Success
• ESP_FAIL Parameter error
Parameters
• uart_num: UART port number, the max port number is (UART_NUM_MAX -1).
esp_err_t uart_disable_rx_intr(uart_port_t uart_num)
Disable UART RX interrupt (RX_FULL & RX_TIMEOUT INTERRUPT)
Return
• ESP_OK Success
• ESP_FAIL Parameter error
Parameters
• uart_num: UART port number, the max port number is (UART_NUM_MAX -1).
esp_err_t uart_disable_tx_intr(uart_port_t uart_num)
Disable UART TX interrupt (TXFIFO_EMPTY INTERRUPT)
Return
• ESP_OK Success
• ESP_FAIL Parameter error
Parameters
• uart_num: UART port number
esp_err_t uart_enable_tx_intr(uart_port_t uart_num, int enable, int thresh)
Enable UART TX interrupt (TXFIFO_EMPTY INTERRUPT)
Espressif Systems 467
Submit Document Feedback
Release v4.4