Jump to main content

##

# 2.130.36 UART_EVENT Enum

## C

    /* Ring buffer mode */

    typedef enum
    {
        /* Threshold number of bytes are available in the receive ring buffer */
        UART_EVENT_READ_THRESHOLD_REACHED,

        /* Receive ring buffer is full. Application must read the data out to avoid missing data on the next RX interrupt. */
        UART_EVENT_READ_BUFFER_FULL,

        /* USART error. Application must call the UARTx_ErrorGet API to get the type of error and clear the error. */
        UART_EVENT_READ_ERROR,

        /* Threshold number of free space is available in the transmit ring buffer */
        UART_EVENT_WRITE_THRESHOLD_REACHED,
    }UART_EVENT;

## Summary

Defines the enums associated with the UART events in the ring buffer mode

## Description

Defines the enums associated with the UART events in the ring buffer mode. An event of this type is passed in the read and write callbacks to let application identify the UART event type.

## Remarks

None.