## CMSIS USART Driver Function Documentation

### ARM_USART_GetVersion

ARM_DRIVER_VERSION ARM_USART_GetVersion()

Get driver version.

Location: Driver_USART.c:59

Return

ARM_DRIVER_VERSION

### ARM_USART_GetCapabilities

ARM_USART_CAPABILITIES ARM_USART_GetCapabilities()

Get driver capabilities.

Location: Driver_USART.c:64

Return

ARM_USART_CAPABILITIES

### ARM_USART_Initialize

int32_t ARM_USART_Initialize(ARM_USART_SignalEvent_t cb_event)

Initialize USART Interface.

Location: Driver_USART.c:69

Parameters

Direction | Name | Description
--- | --- | ---
in | cb_event | Pointer to ARM_USART_SignalEvent

Return

execution_status

### ARM_USART_Uninitialize

int32_t ARM_USART_Uninitialize()

De-initialize USART Interface.

Location: Driver_USART.c:73

Return

execution_status

### ARM_USART_PowerControl

int32_t ARM_USART_PowerControl(ARM_POWER_STATE state)

Control USART Interface Power.

Location: Driver_USART.c:77

Parameters

Direction | Name | Description
--- | --- | ---
in | state | Power state

Return

execution_status

### ARM_USART_Send

int32_t ARM_USART_Send(const void * data, uint32_t num)

Start sending data to USART transmitter.

Location: Driver_USART.c:93

Parameters

Direction | Name | Description
--- | --- | ---
in | data | Pointer to buffer with data to send to USART transmitter
in | num | Number of data items to send

Return

execution_status

### ARM_USART_Receive

int32_t ARM_USART_Receive(void * data, uint32_t num)

Start receiving data from USART receiver.

Location: Driver_USART.c:97

Parameters

Direction | Name | Description
--- | --- | ---
out | data | Pointer to buffer for data to receive from USART receiver
in | num | Number of data items to receive

Return

execution_status

### ARM_USART_Transfer

int32_t ARM_USART_Transfer(const void * data_out, void * data_in, uint32_t num)

Start sending/receiving data to/from USART transmitter/receiver.

Location: Driver_USART.c:101

Parameters

Direction | Name | Description
--- | --- | ---
in | data_out | Pointer to buffer with data to send to USART transmitter
out | data_in | Pointer to buffer for data to receive from USART receiver
in | num | Number of data items to transfer

Return

execution_status

### ARM_USART_GetTxCount

uint32_t ARM_USART_GetTxCount()

Get transmitted data count.

Location: Driver_USART.c:105

Return

number of data items transmitted

### ARM_USART_GetRxCount

uint32_t ARM_USART_GetRxCount()

Get received data count.

Location: Driver_USART.c:109

Return

number of data items received

### ARM_USART_Control

int32_t ARM_USART_Control(uint32_t control, uint32_t arg)

Control USART Interface.

Location: Driver_USART.c:113

Parameters

Direction | Name | Description
--- | --- | ---
in | control | Operation
in | arg | Argument of operation (optional)

Return

common execution_status and driver specific usart_execution_status

### ARM_USART_GetStatus

ARM_USART_STATUS ARM_USART_GetStatus()

Get USART status.

Location: Driver_USART.c:117

Return

USART status ARM_USART_STATUS

### ARM_USART_SetModemControl

int32_t ARM_USART_SetModemControl(ARM_USART_MODEM_CONTROL control)

Set USART Modem Control line state.

Location: Driver_USART.c:121

Parameters

Direction | Name | Description
--- | --- | ---
in | control | ARM_USART_MODEM_CONTROL

Return

execution_status

### ARM_USART_GetModemStatus

ARM_USART_MODEM_STATUS ARM_USART_GetModemStatus()

Get USART Modem Status lines state.

Location: Driver_USART.c:125

Return

modem status ARM_USART_MODEM_STATUS

### ARM_USART_SignalEvent

void ARM_USART_SignalEvent(uint32_t event)

Signal USART Events.

Location: Driver_USART.c:129

Parameters

Direction | Name | Description
--- | --- | ---
in | event | USART_events notification mask

Return

none