Jump to main content

##

# 1.1.9.4.19 DRV_USART_BUFFER_EVENT Enum

## C

    typedef enum
    {
        /* The buffer is pending to be serviced */
        DRV_USART_BUFFER_EVENT_PENDING = 0,

        /* All data from or to the buffer was transferred successfully. */
        DRV_USART_BUFFER_EVENT_COMPLETE = 1,

        /* Transfer Handle given is expired. It means transfer
        is completed but with or without error is not known. */
        DRV_USART_BUFFER_EVENT_HANDLE_EXPIRED = 2,

        /* There was an error while processing the buffer transfer request. */
        DRV_USART_BUFFER_EVENT_ERROR = -1,

        /* Transfer Handle given is invalid */
        DRV_USART_BUFFER_EVENT_HANDLE_INVALID = -2

    } DRV_USART_BUFFER_EVENT;

## Summary

Identifies the possible events that can result from a buffer add request.

## Description

This enumeration identifies the possible events that can result from a buffer add request caused by the client calling either the DRV_USART_ReadBufferAdd or DRV_USART_WriteBufferAdd functions.

## Remarks

One of these values is passed in the "event" parameter of the event handling callback function that the client registered with the driver by calling the DRV_USART_BufferEventHandlerSet function when a buffer transfer request is completed.