# CMSIS USART Driver

CMSIS USART Driver Reference.

## Summary

Typedefs

- ARM_USART_STATUS : USART Status.
- ARM_USART_MODEM_CONTROL : USART Modem Control.
- ARM_USART_MODEM_STATUS : USART Modem Status.
- ARM_USART_SignalEvent_t : Pointer to ARM_USART_SignalEvent : Signal USART Event.
- ARM_USART_CAPABILITIES : USART Device Driver Capabilities.
- ARM_DRIVER_USART : Access structure of the USART Driver.

Data Structures

- _ARM_USART_STATUS : USART Status.
- _ARM_USART_MODEM_STATUS : USART Modem Status.
- _ARM_USART_CAPABILITIES : USART Device Driver Capabilities.
- _ARM_DRIVER_USART : Access structure of the USART Driver.

Enumerations

- _ARM_USART_MODEM_CONTROL : USART Modem Control.

Macros

- ARM_USART_API_VERSION : API version.
- ARM_USART_CONTROL_Pos : Position of the 0th bit of the USART control field in the ARM_USART structure.
- ARM_USART_CONTROL_Msk : Positioning of USART control field in the ARM_USART structure.
- ARM_USART_MODE_ASYNCHRONOUS : UART (Asynchronous); arg = Baudrate.
- ARM_USART_MODE_SYNCHRONOUS_MASTER : Synchronous Master (generates clock signal); arg = Baudrate.
- ARM_USART_MODE_SYNCHRONOUS_SLAVE : Synchronous Slave (external clock signal).
- ARM_USART_MODE_SINGLE_WIRE : UART Single-wire (half-duplex); arg = Baudrate.
- ARM_USART_MODE_IRDA : UART IrDA; arg = Baudrate.
- ARM_USART_MODE_SMART_CARD : UART Smart Card; arg = Baudrate.
- ARM_USART_DATA_BITS_Pos : Position of the 0th bit of the Data bits field in the ARM_USART structure.
- ARM_USART_DATA_BITS_Msk : Positioning of the Data bits field in the ARM_USART structure.
- ARM_USART_DATA_BITS_5 : 5 data bits.
- ARM_USART_DATA_BITS_6 : 6 data bits.
- ARM_USART_DATA_BITS_7 : 7 data bits.
- ARM_USART_DATA_BITS_8 : 8 data bits (default).
- ARM_USART_DATA_BITS_9 : 9 data bits.
- ARM_USART_PARITY_Pos : Position of the 0th bit of the Mode parameters Parity field in the ARM_USART structure.
- ARM_USART_PARITY_Msk : Positioning of the Mode parameters Parity field in the ARM_USART structure.
- ARM_USART_PARITY_NONE : No parity (default).
- ARM_USART_PARITY_EVEN : Even parity.
- ARM_USART_PARITY_ODD : Odd parity.
- ARM_USART_STOP_BITS_Pos : Position of the 0th bit of the Mode parameters Stop bits field in the ARM_USART structure.
- ARM_USART_STOP_BITS_Msk : Positioning of the Mode parameters Stop bits field in the ARM_USART structure.
- ARM_USART_STOP_BITS_1 : 1 stop bit (default).
- ARM_USART_STOP_BITS_2 : 2 stop bits.
- ARM_USART_STOP_BITS_1_5 : 1.5 stop bits.
- ARM_USART_STOP_BITS_0_5 : 0.5 stop bits.
- ARM_USART_FLOW_CONTROL_Pos : Position of the 0th bit of the Mode parameters Flow control field in the ARM_USART structure.
- ARM_USART_FLOW_CONTROL_Msk : Positioning of the Mode parameters Flow control field in the ARM_USART structure.
- ARM_USART_FLOW_CONTROL_NONE : No flow control (default).
- ARM_USART_FLOW_CONTROL_RTS : RTS flow control.
- ARM_USART_FLOW_CONTROL_CTS : CTS flow control.
- ARM_USART_FLOW_CONTROL_RTS_CTS : RTS/CTS flow control.
- ARM_USART_CPOL_Pos : Position of the 0th bit of the Mode parameters Clock polarity field in the ARM_USART structure.
- ARM_USART_CPOL_Msk : Positioning of the Mode parameters Clock polarity field in the ARM_USART structure.
- ARM_USART_CPOL0 : CPOL = 0 (default).
- ARM_USART_CPOL1 : CPOL = 1.
- ARM_USART_CPHA_Pos : Position of the 0th bit of the Mode parameters Clock phase field in the ARM_USART structure.
- ARM_USART_CPHA_Msk : Positioning of the Mode parameters Clock phase field in the ARM_USART structure.
- ARM_USART_CPHA0 : CPHA = 0 (default).
- ARM_USART_CPHA1 : CPHA = 1.
- ARM_USART_SET_DEFAULT_TX_VALUE : Set default transmit value (synchronous receive only); arg = value.
- ARM_USART_SET_IRDA_PULSE : Set IrDA Pulse in ns; arg: 0=3/16 of bit period.
- ARM_USART_SET_SMART_CARD_GUARD_TIME : Set smart card guard time; arg = number of bit periods.
- ARM_USART_SET_SMART_CARD_CLOCK : Set smart card clock in Hz; arg: 0=Clock not generated.
- ARM_USART_CONTROL_SMART_CARD_NACK : Smart card NACK generation; arg: 0=disabled, 1=enabled.
- ARM_USART_CONTROL_TX : Transmitter; arg: 0=disabled, 1=enabled.
- ARM_USART_CONTROL_RX : Receiver; arg: 0=disabled, 1=enabled.
- ARM_USART_CONTROL_BREAK : Continuous break transmission; arg: 0=disabled, 1=enabled.
- ARM_USART_ABORT_SEND : Abort ARM_USART_Send.
- ARM_USART_ABORT_RECEIVE : Abort ARM_USART_Receive.
- ARM_USART_ABORT_TRANSFER : Abort ARM_USART_Transfer.
- ARM_USART_ERROR_MODE : Specified mode not supported.
- ARM_USART_ERROR_BAUDRATE : Specified baudrate not supported.
- ARM_USART_ERROR_DATA_BITS : Specified number of data bits not supported.
- ARM_USART_ERROR_PARITY : Specified parity not supported.
- ARM_USART_ERROR_STOP_BITS : Specified number of stop bits not supported.
- ARM_USART_ERROR_FLOW_CONTROL : Specified flow control not supported.
- ARM_USART_ERROR_CPOL : Specified clock polarity not supported.
- ARM_USART_ERROR_CPHA : Specified clock phase not supported.
- ARM_USART_EVENT_SEND_COMPLETE : USART Event
- ARM_USART_EVENT_RECEIVE_COMPLETE : Receive completed.
- ARM_USART_EVENT_TRANSFER_COMPLETE : Transfer completed.
- ARM_USART_EVENT_TX_COMPLETE : Transmit completed (optional).
- ARM_USART_EVENT_TX_UNDERFLOW : Transmit data not available (synchronous slave).
- ARM_USART_EVENT_RX_OVERFLOW : Receive data overflow.
- ARM_USART_EVENT_RX_TIMEOUT : Receive character timeout (optional).
- ARM_USART_EVENT_RX_BREAK : Break detected on receive.
- ARM_USART_EVENT_RX_FRAMING_ERROR : Framing error detected on receive.
- ARM_USART_EVENT_RX_PARITY_ERROR : Parity error detected on receive.
- ARM_USART_EVENT_CTS : CTS state changed (optional).
- ARM_USART_EVENT_DSR : DSR state changed (optional).
- ARM_USART_EVENT_DCD : DCD state changed (optional).
- ARM_USART_EVENT_RI : RI state changed (optional).

Functions

- ARM_USART_GetVersion : Get driver version.
- ARM_USART_GetCapabilities : Get driver capabilities.
- ARM_USART_Initialize : Initialize USART Interface.
- ARM_USART_Uninitialize : De-initialize USART Interface.
- ARM_USART_PowerControl : Control USART Interface Power.
- ARM_USART_Send : Start sending data to USART transmitter.
- ARM_USART_Receive : Start receiving data from USART receiver.
- ARM_USART_Transfer : Start sending/receiving data to/from USART transmitter/receiver.
- ARM_USART_GetTxCount : Get transmitted data count.
- ARM_USART_GetRxCount : Get received data count.
- ARM_USART_Control : Control USART Interface.
- ARM_USART_GetStatus : Get USART status.
- ARM_USART_SetModemControl : Set USART Modem Control line state.
- ARM_USART_GetModemStatus : Get USART Modem Status lines state.
- ARM_USART_SignalEvent : Signal USART Events.