SPI_MASTER: Enumerations

SPI_MASTER

SPI_MASTER
Enumerations
enum  SPI_MASTER_STATUS {
  SPI_MASTER_STATUS_SUCCESS = 0U, SPI_MASTER_STATUS_FAILURE, SPI_MASTER_STATUS_BUSY, SPI_MASTER_STATUS_BUFFER_INVALID,
  SPI_MASTER_STATUS_MODE_MISMATCH
}
 Return status of the SPI_MASTER APP. More...
 
enum  SPI_MASTER_SR_ID {
  SPI_MASTER_SR_ID_0 = 0U, SPI_MASTER_SR_ID_1, SPI_MASTER_SR_ID_2, SPI_MASTER_SR_ID_3,
  SPI_MASTER_SR_ID_4, SPI_MASTER_SR_ID_5
}
 Service ID for Transmit, Receive and Parity events. More...
 
enum  SPI_MASTER_SS_SIGNAL {
  SPI_MASTER_SS_SIGNAL_0 = 0U, SPI_MASTER_SS_SIGNAL_1, SPI_MASTER_SS_SIGNAL_2, SPI_MASTER_SS_SIGNAL_3,
  SPI_MASTER_SS_SIGNAL_4, SPI_MASTER_SS_SIGNAL_5, SPI_MASTER_SS_SIGNAL_6, SPI_MASTER_SS_SIGNAL_7
}
 Slave select signals. More...
 
enum  SPI_MASTER_INPUT {
  SPI_MASTER_INPUT_A = 0U, SPI_MASTER_INPUT_B, SPI_MASTER_INPUT_C, SPI_MASTER_INPUT_D,
  SPI_MASTER_INPUT_E, SPI_MASTER_INPUT_F, SPI_MASTER_INPUT_G, SPI_MASTER_INPUT_INVALID
}
 Enum type which defines Receive input list. More...
 
enum  SPI_MASTER_TRANSFER_MODE { SPI_MASTER_TRANSFER_MODE_INTERRUPT, SPI_MASTER_TRANSFER_MODE_DMA, SPI_MASTER_TRANSFER_MODE_DIRECT }
 Enum used to identify the transfer type used for either transmit or receive function. More...
 
typedef enum SPI_MASTER_STATUS SPI_MASTER_STATUS_t
 Return status of the SPI_MASTER APP.
 
typedef enum SPI_MASTER_SR_ID SPI_MASTER_SR_ID_t
 Service ID for Transmit, Receive and Parity events.
 
typedef enum SPI_MASTER_SS_SIGNAL SPI_MASTER_SS_SIGNAL_t
 Slave select signals.
 
typedef enum SPI_MASTER_INPUT SPI_MASTER_INPUT_t
 Enum type which defines Receive input list.
 
typedef enum
SPI_MASTER_TRANSFER_MODE 
SPI_MASTER_TRANSFER_MODE_t
 Enum used to identify the transfer type used for either transmit or receive function.
 

Detailed Description

Enumeration Type Documentation

Enum type which defines Receive input list.

Enumerator
SPI_MASTER_INPUT_A 

Input-A

SPI_MASTER_INPUT_B 

Input-B

SPI_MASTER_INPUT_C 

Input-C

SPI_MASTER_INPUT_D 

Input-D

SPI_MASTER_INPUT_E 

Input-E

SPI_MASTER_INPUT_F 

Input-F

SPI_MASTER_INPUT_G 

Input-G

SPI_MASTER_INPUT_INVALID 

This is to check during mode switch

Definition at line 169 of file SPI_MASTER.h.

Service ID for Transmit, Receive and Parity events.

Enumerator
SPI_MASTER_SR_ID_0 

SR-0

SPI_MASTER_SR_ID_1 

SR-1

SPI_MASTER_SR_ID_2 

SR-2

SPI_MASTER_SR_ID_3 

SR-3

SPI_MASTER_SR_ID_4 

SR-4

SPI_MASTER_SR_ID_5 

SR-5

Definition at line 141 of file SPI_MASTER.h.

Slave select signals.

Enumerator
SPI_MASTER_SS_SIGNAL_0 

Slave select 0

SPI_MASTER_SS_SIGNAL_1 

Slave select 1

SPI_MASTER_SS_SIGNAL_2 

Slave select 2

SPI_MASTER_SS_SIGNAL_3 

Slave select 3

SPI_MASTER_SS_SIGNAL_4 

Slave select 4

SPI_MASTER_SS_SIGNAL_5 

Slave select 5

SPI_MASTER_SS_SIGNAL_6 

Slave select 6

SPI_MASTER_SS_SIGNAL_7 

Slave select 7

Definition at line 154 of file SPI_MASTER.h.

Return status of the SPI_MASTER APP.

Enumerator
SPI_MASTER_STATUS_SUCCESS 

Status success

SPI_MASTER_STATUS_FAILURE 

Status failure

SPI_MASTER_STATUS_BUSY 

Busy state

SPI_MASTER_STATUS_BUFFER_INVALID 

If input buffer and length is invalid

SPI_MASTER_STATUS_MODE_MISMATCH 

API invoked by a handle configured with different mode. e.g, If SPI_MASTER_StartTransmitDMA is invoked for an instance which has transmit mode configured as "Interrupt", will return this status.

Definition at line 126 of file SPI_MASTER.h.

Enum used to identify the transfer type used for either transmit or receive function.

Enumerator
SPI_MASTER_TRANSFER_MODE_INTERRUPT 

Implement data transmit or receive using interrupts

SPI_MASTER_TRANSFER_MODE_DMA 

Implement data transmit or receive using DMA

SPI_MASTER_TRANSFER_MODE_DIRECT 

This configuration exposes signals for external APP connection

Definition at line 184 of file SPI_MASTER.h.