Introduction

The SPI Driver MCAL provides low level access to SPI peripheral present on Device.
The SPI Driver implements a standardized interface specified in the AUTOSAR_SWS_SPIHandlerDriver document.

Limitations of the driver:

A job could belong to several sequences but can't be active at the same time i.e. a job queued in a sequence cannot be queued via another sequence. This is a design limitation to reduce driver complexity.
A channel could belong to several sequences or jobs but can't be active at the same time i.e. a channel in a job in a sequence cannot be part of another active job or sequeuence. This is a design limitation to reduce driver complexity.
Non-Interruptible sequences applies only within a HW unit. If a sequence is started, another high priority job belonging to another sequence cannot interrupt the job belonging to the same hardware unit. But the job can be scheduled ahead of another pending job of the started sequence if it belongs to another HW queue. This is illustrated in below example

Example of non-interruptible sequence across HW units: SEQ1 - JOB1 (HW1, P0) SEQ2 - JOB2 (HW2, P0), JOB3 (HW1, P0) SEQ3 - JOB4 (HW2, P3)

Consider the above sequence of calls happening back to back at time T1. The job schedule for this case will be
```
  Time T1 - JOB1 and JOB2     (Since different HW)

  Time T2 - JOB4              (could interrupts SEQ2 JOB3 if JOB1
                               takes more time that JOB2)

  Time T3 - JOB3
```

See also: SPI Configuration; Defines Interrupt Handler for all SPI instances; Defines variables that could be used to driver

Sub Modules
	Defines Interrupt Handler for all SPI instances

	Defines variables that could be used to driver

	SPI Configuration

Typedefs
typedef uint8	Spi_DataBufferType
	Type of application data buffer elements. More...

typedef uint16	Spi_NumberOfDataType
	Type for defining the number of data elements of the type Spi_DataBufferType to send and / or receive by Channel. More...

typedef uint8	Spi_ChannelType
	Specifies the identification (ID) for a Channel. More...

typedef uint16	Spi_JobType
	Specifies the identification (ID) for a Job. More...

typedef uint8	Spi_SequenceType
	Specifies the identification (ID) for a sequence of jobs. More...

typedef uint8	Spi_HWUnitType
	Specifies the identification (ID) for a SPI Hardware micro controller peripheral (unit) More...

Macros
#define	SPI_HW_UNIT_CNT (11U)
	Total HW units - used for array allocation. This should be +1 of the max unit number. More...

#define	SPI_MCSPI_FCLK (48000000U)
	MCSPI functional clock input in Hz. This clock is used to generate the serial clock output after the divider. More...

SPI Driver Module SW Version Info
Defines for SPI Driver version used for compatibility checks
#define	SPI_SW_MAJOR_VERSION (1U)
	Driver Implementation Major Version. More...

#define	SPI_SW_MINOR_VERSION (3U)
	Driver Implementation Minor Version. More...

#define	SPI_SW_PATCH_VERSION (2U)
	Driver Implementation Patch Version. More...

SPI Driver Module AUTOSAR Version Info
Defines for SPI Driver AUTOSAR version used for compatibility checks
#define	SPI_AR_RELEASE_MAJOR_VERSION (4U)
	AUTOSAR Major version specification implemented by SPI Driver. More...

#define	SPI_AR_RELEASE_MINOR_VERSION (3U)
	AUTOSAR Minor version specification implemented by SPI Driver. More...

#define	SPI_AR_RELEASE_REVISION_VERSION (1U)
	AUTOSAR Patch version specification implemented by SPI Driver. More...

SPI Driver ID Info
#define	SPI_VENDOR_ID ((uint16) 44U)
	Texas Instruments Vendor ID. More...

#define	SPI_MODULE_ID ((uint16) 83U)
	SPI Driver Module ID. More...

#define	SPI_INSTANCE_ID ((uint8) 0U)
	SPI Driver Instance ID. More...

SPI HW unit Info
#define	SPI_UNIT_MCU_MCSPI0 ((Spi_HWUnitType) CSIB0)
	MCU MCSPI0 instance. More...

#define	SPI_UNIT_MCU_MCSPI1 ((Spi_HWUnitType) CSIB1)
	MCU MCSPI1 instance. More...

#define	SPI_UNIT_MCU_MCSPI2 ((Spi_HWUnitType) CSIB2)
	MCU MCSPI2 instance. More...

#define	SPI_UNIT_MCSPI0 ((Spi_HWUnitType) CSIB3)
	MCSPI0 instance. More...

#define	SPI_UNIT_MCSPI1 ((Spi_HWUnitType) CSIB4)
	MCSPI1 instance. More...

#define	SPI_UNIT_MCSPI2 ((Spi_HWUnitType) CSIB5)
	MCSPI2 instance. More...

#define	SPI_UNIT_MCSPI3 ((Spi_HWUnitType) CSIB6)
	MCSPI3 instance. More...

#define	SPI_UNIT_MCSPI4 ((Spi_HWUnitType) CSIB7)
	MCSPI4 instance. More...

#define	SPI_UNIT_MCSPI5 ((Spi_HWUnitType) CSIB8)
	MCSPI5 instance. More...

#define	SPI_UNIT_MCSPI6 ((Spi_HWUnitType) CSIB9)
	MCSPI6 instance. More...

#define	SPI_UNIT_MCSPI7 ((Spi_HWUnitType) CSIB10)
	MCSPI7 instance. More...

SPI Buffer Definition
#define	SPI_IB (0U)
	Buffer definitions IB - internal buffers. More...

#define	SPI_EB (1U)
	Buffer definitions EB - external buffers. Only this is supported. More...

#define	SPI_IB_EB (2U)
	Buffer definitions IB/EB - internal/external buffers. More...

SPI Error Codes
Error codes returned by SPI functions
#define	SPI_E_PARAM_CHANNEL ((uint8) 0x0AU)
	API service called with wrong parameter. More...

#define	SPI_E_PARAM_JOB ((uint8) 0x0BU)
	API service called with wrong parameter. More...

#define	SPI_E_PARAM_SEQ ((uint8) 0x0CU)
	API service called with wrong parameter. More...

#define	SPI_E_PARAM_LENGTH ((uint8) 0x0DU)
	API service called with wrong parameter. More...

#define	SPI_E_PARAM_UNIT ((uint8) 0x0EU)
	API service called with wrong parameter. More...

#define	SPI_E_PARAM_POINTER ((uint8) 0x10U)
	APIs called with a Null Pointer. More...

#define	SPI_E_UNINIT ((uint8) 0x1AU)
	API service used without module initiali-zation. More...

#define	SPI_E_SEQ_PENDING ((uint8) 0x2AU)
	Services called in a wrong sequence. More...

#define	SPI_E_SEQ_IN_PROCESS ((uint8) 0x3AU)
	Synchronous transmission service called at wrong time. More...

#define	SPI_E_ALREADY_INITIALIZED ((uint8) 0x4AU)
	API Spi_Init service called while the SPI driver has already been initialized. More...

#define	SPI_E_SEQUENCE_NOT_OK ((uint8) 0x5AU)
	Sequence did not complete successfully. More...

SPI Service Ids
The Service Id is one of the argument to Det_ReportError function and is used to identify the source of the error
#define	SPI_SID_INIT ((uint8) 0x00U)
	Spi_Init() API Service ID. More...

#define	SPI_SID_DEINIT ((uint8) 0x01U)
	Spi_DeInit() API Service ID. More...

#define	SPI_SID_WRITE_IB ((uint8) 0x02U)
	Spi_WriteIB() API Service ID. More...

#define	SPI_SID_ASYNC_TRANSMIT ((uint8) 0x03U)
	Spi_AsyncTransmit() API Service ID. More...

#define	SPI_SID_READ_IB ((uint8) 0x04U)
	Spi_ReadIB() API Service ID. More...

#define	SPI_SID_SETUP_EB ((uint8) 0x05U)
	Spi_SetupEB() API Service ID. More...

#define	SPI_SID_GET_STATUS ((uint8) 0x06U)
	Spi_GetStatus() API Service ID. More...

#define	SPI_SID_GET_JOB_RESULT ((uint8) 0x07U)
	Spi_GetJobResult() API Service ID. More...

#define	SPI_SID_GET_SEQ_RESULT ((uint8) 0x08U)
	Spi_GetSequenceResult() API Service ID. More...

#define	SPI_SID_GET_VERSION_INFO ((uint8) 0x09U)
	Spi_GetVersionInfo() API Service ID. More...

#define	SPI_SID_SYNC_TRANSMIT ((uint8) 0x0AU)
	Spi_SyncTransmit() API Service ID. More...

#define	SPI_SID_GET_HW_UNIT_STATUS ((uint8) 0x0BU)
	Spi_GetHWUnitStatus() API Service ID. More...

#define	SPI_SID_CANCEL ((uint8) 0x0CU)
	Spi_Cancel() API Service ID. More...

#define	SPI_SID_SET_ASYNC_MODE ((uint8) 0x0DU)
	Spi_SetAsyncMode() API Service ID. More...

#define	SPI_SID_MAINFUNCTION_HANDLING ((uint8) 0x10U)
	Spi_MainFunction_Handling() API Service ID. More...

SPI Config Ids
The Config Ids used for different SPI Configuration builds
#define	SPI_CFG_ID_0 (0x01U)
	Config 0 (All configurations ON), Scaleability level 2) More...

#define	SPI_CFG_ID_1 (0x02U)
	Config 1 (All configurations OFF). SPI_CFG_ID_1 is used only for compile check. More...

#define	SPI_CFG_ID_2 (0x04U)
	Config 2 (All configurations ON except DET OFF) More...

#define	SPI_CFG_ID_3 (0x08U)
	Config 3 (Configurator auto generated file) More...

#define	SPI_CFG_ID_4 (0x10U)
	Config 4 (Config is used only by Unit Test, Scaleability level 0) More...

#define	SPI_CFG_ID_5 (0x20U)
	Config 5 (Config is used only by Unit Test, Scaleability level 1) More...

Macro Definition Documentation

◆ SPI_SW_MAJOR_VERSION

#define SPI_SW_MAJOR_VERSION (1U)

Driver Implementation Major Version.

◆ SPI_SW_MINOR_VERSION

#define SPI_SW_MINOR_VERSION (3U)

Driver Implementation Minor Version.

◆ SPI_SW_PATCH_VERSION

#define SPI_SW_PATCH_VERSION (2U)

Driver Implementation Patch Version.

◆ SPI_AR_RELEASE_MAJOR_VERSION

#define SPI_AR_RELEASE_MAJOR_VERSION (4U)

AUTOSAR Major version specification implemented by SPI Driver.

◆ SPI_AR_RELEASE_MINOR_VERSION

#define SPI_AR_RELEASE_MINOR_VERSION (3U)

AUTOSAR Minor version specification implemented by SPI Driver.

◆ SPI_AR_RELEASE_REVISION_VERSION

#define SPI_AR_RELEASE_REVISION_VERSION (1U)

AUTOSAR Patch version specification implemented by SPI Driver.

◆ SPI_VENDOR_ID

#define SPI_VENDOR_ID ((uint16) 44U)

Texas Instruments Vendor ID.

◆ SPI_MODULE_ID

#define SPI_MODULE_ID ((uint16) 83U)

SPI Driver Module ID.

◆ SPI_INSTANCE_ID

#define SPI_INSTANCE_ID ((uint8) 0U)

SPI Driver Instance ID.

◆ SPI_UNIT_MCU_MCSPI0

#define SPI_UNIT_MCU_MCSPI0 ((Spi_HWUnitType) CSIB0)

MCU MCSPI0 instance.

◆ SPI_UNIT_MCU_MCSPI1

#define SPI_UNIT_MCU_MCSPI1 ((Spi_HWUnitType) CSIB1)

MCU MCSPI1 instance.

◆ SPI_UNIT_MCU_MCSPI2

#define SPI_UNIT_MCU_MCSPI2 ((Spi_HWUnitType) CSIB2)

MCU MCSPI2 instance.

◆ SPI_UNIT_MCSPI0

#define SPI_UNIT_MCSPI0 ((Spi_HWUnitType) CSIB3)

MCSPI0 instance.

◆ SPI_UNIT_MCSPI1

#define SPI_UNIT_MCSPI1 ((Spi_HWUnitType) CSIB4)

MCSPI1 instance.

◆ SPI_UNIT_MCSPI2

#define SPI_UNIT_MCSPI2 ((Spi_HWUnitType) CSIB5)

MCSPI2 instance.

◆ SPI_UNIT_MCSPI3

#define SPI_UNIT_MCSPI3 ((Spi_HWUnitType) CSIB6)

MCSPI3 instance.

◆ SPI_UNIT_MCSPI4

#define SPI_UNIT_MCSPI4 ((Spi_HWUnitType) CSIB7)

MCSPI4 instance.

◆ SPI_UNIT_MCSPI5

#define SPI_UNIT_MCSPI5 ((Spi_HWUnitType) CSIB8)

MCSPI5 instance.

◆ SPI_UNIT_MCSPI6

#define SPI_UNIT_MCSPI6 ((Spi_HWUnitType) CSIB9)

MCSPI6 instance.

◆ SPI_UNIT_MCSPI7

#define SPI_UNIT_MCSPI7 ((Spi_HWUnitType) CSIB10)

MCSPI7 instance.

◆ SPI_HW_UNIT_CNT

#define SPI_HW_UNIT_CNT (11U)

Total HW units - used for array allocation. This should be +1 of the max unit number.

◆ SPI_IB

#define SPI_IB (0U)

Buffer definitions IB - internal buffers.

◆ SPI_EB

#define SPI_EB (1U)

Buffer definitions EB - external buffers. Only this is supported.

◆ SPI_IB_EB

#define SPI_IB_EB (2U)

Buffer definitions IB/EB - internal/external buffers.