CMSIS USART Driver Function Documentation

ARM_USART_GetVersion

ARM_DRIVER_VERSION ARM_USART_GetVersion()

Location: Driver_USART.c:59

Get driver version.

Returns:

ARM_DRIVER_VERSION

ARM_USART_GetCapabilities

ARM_USART_CAPABILITIES ARM_USART_GetCapabilities()

Location: Driver_USART.c:64

Get driver capabilities.

Returns:

ARM_USART_CAPABILITIES

ARM_USART_Initialize

int32_t ARM_USART_Initialize(ARM_USART_SignalEvent_t cb_event)

Location: Driver_USART.c:69

Initialize USART Interface.

Returns:

execution_status

Parameters

Direction	Name	Description
in	cb_event	Pointer to ARM_USART_SignalEvent

ARM_USART_Uninitialize

int32_t ARM_USART_Uninitialize()

Location: Driver_USART.c:73

De-initialize USART Interface.

Returns:

execution_status

ARM_USART_PowerControl

int32_t ARM_USART_PowerControl(ARM_POWER_STATE state)

Location: Driver_USART.c:77

Control USART Interface Power.

Returns:

execution_status

Parameters

Direction	Name	Description
in	state	Power state

ARM_USART_Send

int32_t ARM_USART_Send(const void * data, uint32_t num)

Location: Driver_USART.c:93

Start sending data to USART transmitter.

Returns:

execution_status

Parameters

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

ARM_USART_Receive

int32_t ARM_USART_Receive(void * data, uint32_t num)

Location: Driver_USART.c:97

Start receiving data from USART receiver.

Returns:

execution_status

Parameters

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

ARM_USART_Transfer

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

Location: Driver_USART.c:101

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

Returns:

execution_status

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

ARM_USART_GetTxCount

uint32_t ARM_USART_GetTxCount()

Location: Driver_USART.c:105

Get transmitted data count.

Returns:

number of data items transmitted

ARM_USART_GetRxCount

uint32_t ARM_USART_GetRxCount()

Location: Driver_USART.c:109

Get received data count.

Returns:

number of data items received

ARM_USART_Control

int32_t ARM_USART_Control(uint32_t control, uint32_t arg)

Location: Driver_USART.c:113

Control USART Interface.

Returns:

common execution_status and driver specific usart_execution_status

Parameters

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

ARM_USART_GetStatus

ARM_USART_STATUS ARM_USART_GetStatus()

Location: Driver_USART.c:117

Get USART status.

Returns:

USART status ARM_USART_STATUS

ARM_USART_SetModemControl

int32_t ARM_USART_SetModemControl(ARM_USART_MODEM_CONTROL control)

Location: Driver_USART.c:121

Set USART Modem Control line state.

Returns:

execution_status

Parameters

Direction	Name	Description
in	control	ARM_USART_MODEM_CONTROL

ARM_USART_GetModemStatus

ARM_USART_MODEM_STATUS ARM_USART_GetModemStatus()

Location: Driver_USART.c:125

Get USART Modem Status lines state.

Returns:

modem status ARM_USART_MODEM_STATUS

ARM_USART_SignalEvent

void ARM_USART_SignalEvent(uint32_t event)

Location: Driver_USART.c:129

Signal USART Events.

Returns:

none

Parameters

Direction	Name	Description
in	event	USART_events notification mask