CMSIS-Driver: USART Events

| CMSIS-Driver Version 2.8.0 Peripheral Interface for Middleware and Application Code

- Main Page
- Usage and Description
- Reference

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros
USART Events
USART Interface

The USART driver generates call back events that are notified via the function ARM_USART_SignalEvent. More...

## Macros

#define | ARM_USART_EVENT_SEND_COMPLETE (1UL << 0)
| Send completed; however USART may still transmit data. More...
#define | ARM_USART_EVENT_RECEIVE_COMPLETE (1UL << 1)
| Receive completed. More...
#define | ARM_USART_EVENT_TRANSFER_COMPLETE (1UL << 2)
| Transfer completed. More...
#define | ARM_USART_EVENT_TX_COMPLETE (1UL << 3)
| Transmit completed (optional) More...
#define | ARM_USART_EVENT_TX_UNDERFLOW (1UL << 4)
| Transmit data not available (Synchronous Slave) More...
#define | ARM_USART_EVENT_RX_OVERFLOW (1UL << 5)
| Receive data overflow. More...
#define | ARM_USART_EVENT_RX_TIMEOUT (1UL << 6)
| Receive character timeout (optional) More...
#define | ARM_USART_EVENT_RX_BREAK (1UL << 7)
| Break detected on receive. More...
#define | ARM_USART_EVENT_RX_FRAMING_ERROR (1UL << 8)
| Framing error detected on receive. More...
#define | ARM_USART_EVENT_RX_PARITY_ERROR (1UL << 9)
| Parity error detected on receive. More...
#define | ARM_USART_EVENT_CTS (1UL << 10)
| CTS state changed (optional) More...
#define | ARM_USART_EVENT_DSR (1UL << 11)
| DSR state changed (optional) More...
#define | ARM_USART_EVENT_DCD (1UL << 12)
| DCD state changed (optional) More...
#define | ARM_USART_EVENT_RI (1UL << 13)
| RI state changed (optional) More...

## Description

The USART driver generates call back events that are notified via the function ARM_USART_SignalEvent.

This section provides the event values for the ARM_USART_SignalEvent callback function.

The following call back notification events are generated:

## Macro Definition Documentation

#define ARM_USART_EVENT_SEND_COMPLETE (1UL << 0)

Send completed; however USART may still transmit data.

#define ARM_USART_EVENT_RECEIVE_COMPLETE (1UL << 1)

Receive completed.

#define ARM_USART_EVENT_TRANSFER_COMPLETE (1UL << 2)

Transfer completed.

#define ARM_USART_EVENT_TX_COMPLETE (1UL << 3)

Transmit completed (optional)

#define ARM_USART_EVENT_TX_UNDERFLOW (1UL << 4)

Transmit data not available (Synchronous Slave)

#define ARM_USART_EVENT_RX_OVERFLOW (1UL << 5)

Receive data overflow.

#define ARM_USART_EVENT_RX_TIMEOUT (1UL << 6)

Receive character timeout (optional)

#define ARM_USART_EVENT_RX_BREAK (1UL << 7)

Break detected on receive.

#define ARM_USART_EVENT_RX_FRAMING_ERROR (1UL << 8)

Framing error detected on receive.

#define ARM_USART_EVENT_RX_PARITY_ERROR (1UL << 9)

Parity error detected on receive.

#define ARM_USART_EVENT_CTS (1UL << 10)

CTS state changed (optional)

#define ARM_USART_EVENT_DSR (1UL << 11)

DSR state changed (optional)

#define ARM_USART_EVENT_DCD (1UL << 12)

DCD state changed (optional)

#define ARM_USART_EVENT_RI (1UL << 13)

RI state changed (optional)