CMSIS SPI Driver Function Documentation

ARM_SPI_GetVersion

ARM_DRIVER_VERSION ARM_SPI_GetVersion()

Location: Driver_SPI.c:42

Get driver version.

Returns:

ARM_DRIVER_VERSION

ARM_SPI_GetCapabilities

ARM_SPI_CAPABILITIES ARM_SPI_GetCapabilities()

Location: Driver_SPI.c:47

Get driver capabilities.

Returns:

ARM_SPI_CAPABILITIES

ARM_SPI_Initialize

int32_t ARM_SPI_Initialize(ARM_SPI_SignalEvent_t cb_event)

Location: Driver_SPI.c:52

Initialize SPI Interface.

Returns:

execution_status

Parameters

Direction	Name	Description
in	cb_event	Pointer to ARM_SPI_SignalEvent

ARM_SPI_Uninitialize

int32_t ARM_SPI_Uninitialize()

Location: Driver_SPI.c:56

De-initialize SPI Interface.

Returns:

execution_status

ARM_SPI_PowerControl

int32_t ARM_SPI_PowerControl(ARM_POWER_STATE state)

Location: Driver_SPI.c:60

Control SPI Interface Power.

Returns:

execution_status

Parameters

Direction	Name	Description
in	state	Power state

ARM_SPI_Send

int32_t ARM_SPI_Send(const void * data, uint32_t num)

Location: Driver_SPI.c:76

Start sending data to SPI transmitter.

Returns:

execution_status

Parameters

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

ARM_SPI_Receive

int32_t ARM_SPI_Receive(void * data, uint32_t num)

Location: Driver_SPI.c:80

Start receiving data from SPI receiver.

Returns:

execution_status

Parameters

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

ARM_SPI_Transfer

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

Location: Driver_SPI.c:84

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

Returns:

execution_status

Parameters

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

ARM_SPI_GetDataCount

uint32_t ARM_SPI_GetDataCount()

Location: Driver_SPI.c:88

Get transferred data count.

Returns:

number of data items transferred

ARM_SPI_Control

int32_t ARM_SPI_Control(uint32_t control, uint32_t arg)

Location: Driver_SPI.c:92

Control SPI Interface.

Returns:

common execution_status and driver specific spi_execution_status

Parameters

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

ARM_SPI_GetStatus

ARM_SPI_STATUS ARM_SPI_GetStatus()

Location: Driver_SPI.c:125

Get SPI status.

Returns:

SPI status ARM_SPI_STATUS

ARM_SPI_SignalEvent

void ARM_SPI_SignalEvent(uint32_t event)

Location: Driver_SPI.c:129

Signal SPI Events.

Returns:

none

Parameters

Direction	Name	Description
in	event	SPI_events notification mask