SPI Handler Driver (Spi)

Service for SPI initialization.

Service for SPI de - initialization.

Service for writing one or more data to an IB SPI Handler/ Driver Channel specified by parameter.

Service to transmit data on the SPI bus.

Service for reading synchronously one or more data from an IB SPI Handler/ Driver Channel specified by parameter.

Service to setup the buffers and the length of data for the EB SPI Handle r/ Driver Channel specified.

Service returns the SPI Handler/ Driver software module status.

This service returns the last transmission result of the specified Job.

This service returns the last transmission result of the specified Sequence.

This service returns the version information of this module.

Service to transmit data on the SPI bus

This service returns the status of the specified SPI Hardware microcontroller peripheral.

Service cancels the specified on - going sequence transmission.

Service to set the asynchronous mechanism mode for SPI busses handled asynchronously.

-

Callback routine provided by the user for each Job to notify the caller that a job has been finished.

Callback routine provided by the user for each Sequence to notify the caller that a sequence has been finished.

This type of the external data structure shall contain the initialization data for the SPI Handler/ Driver.

This type defines a range of specific status for SPI Handler/ Driver.

This type defines a range of specific Jobs status for SPI Handler/ Driver.

This type defines a range of specific Sequences status for SPI Handler/ Driver.

Type of application data buffer elements.

Type for defining the number of data elements of the type Spi_ Data Buffer Type to send and / or receive by Channel

Specifies the identification (ID) for a Channel.

Specifies the identification (ID) for a Job.

Specifies the identification (ID) for a sequence of jobs.

Specifies the identification (ID) for a SPI Hardware microcontroller peripheral (unit).

Specifies the asynchronous mechanism mode for SPI busses handled asynchronously.

SPI Handler/driver shall be able to detect the error SPI_E_PARAM_CHANNEL when API ser vice called with wrong param e- ter.

[SWS_Spi_00016] ⌈The function Spi_ReadIB shall read synchronously one or more data from an IB SPI Handler/Driver Channel specified by the respective parameter.⌋(SRS_Spi_12099, SRS_Spi_12152)

[SWS_Spi_00018] ⌈The function Spi_WriteIB shall write one or more data to an IB SPI Handler/Driver Channel specified by the respective parame- ter.⌋(SRS_Spi_12101, SRS_Spi_12153)

[SWS_Spi_00020] ⌈The function Spi_AsyncTransmit shall take over the given parameter, initiate a transmission, set the SPI Handler/Driver status to SPI_BUSY, set the sequence result to SPI_SEQ_PENDING and return. ⌋(SRS_Spi_12099, SRS_Spi_12101, SRS_Spi_12103)

[SWS_Spi_00021] ⌈The function Spi_DeInit shall de-initialize SPI Han- dler/Driver.⌋(SRS_BSW_00336, SRS_SPAL_12163, SRS_SPAL_12064)

[SWS_Spi_00022] ⌈After the module de-initialization using the function Spi_DeInit, the SPI Handler/Driver shall set its state to SPI_UNINIT.⌋(SRS_BSW_00336, SRS_SPAL_12163) The SPI Handler/Driver shall have been initialized before the function Spi_DeInit is called, otherwise see [SWS_Spi_00046].

[SWS_Spi_00023] ⌈If the given parameter “DataBufferPtr” is null, the function Spi_WriteIB shall assume that the data to be transmitted is not relevant and the default transmit value of the given channel shall be used instead.⌋()

[SWS_Spi_00024] ⌈The function Spi_WriteIB shall take over the given parame- ters, and save the pointed data to the internal buffer defined with the function Spi_Init.⌋()

[SWS_Spi_00027] ⌈The SPI Handler/Driver’s environment shall call the function Spi_ReadIB after a Transmit method call to have relevant data within IB Channel.⌋()

[SWS_Spi_00030] ⌈When the function Spi_SetupEB is called with the parameter DesDataBufferPtr being a Null pointer, the SPI Handler/Driver shall ignore the received data after a Transmit method is requested.(See also [SWS_Spi_00036])⌋()

The API parameter Channel shall have a value within the d e- fined channels in the initialization data structure, and the cor rect type of channel (IB or EB) has to be used with services. Related error value: SPI_E_PARAM_CHANNEL . Otherwise, the service is not done and the return value shall be E_NOT_OK .

The API parameters Sequence and Job shall have values within the specified range of values. Related errors values: SPI_E_PARAM_SEQ or SPI_E_PARAM_JOB.

[SWS_Spi_00035] ⌈When the function Spi_AsyncTransmit is used with EB and the source data pointer has been provided as NULL using the Spi_SetupEB method, the default transmit data configured for each channel shall be transmitted. (See also

[SWS_Spi_00036] ⌈When the function Spi_AsyncTransmit is used with EB and the destination data pointer has been provided as NULL using the Spi_SetupEB method, the SPI Handler/Driver shall ignore receiving data (See also

[SWS_Spi_00037] ⌈The SPI Handler/Driver’s environment shall call the Spi_SetupEB function once for each Channel with EB declared before the SPI Handler/Driver’s environment calls a Transmit method on them.⌋()

If development error detection for the SPI mod ule is enabled and the SPI Handler/Driver’s env i ronment calls any API function before initialization, an error should be reported to the DET with the error value SPI_E_UNINIT according to the configur a tion.

[SWS_Spi_00055] ⌈When the function Spi_AsyncTransmit is used for a Se- quence with linked Jobs, the function shall transmit from the first Job up to the last Job in the sequence.⌋(SRS_Spi_12181)

[SWS_Spi_00057] ⌈ At the end of a sequence transmission initiated by the function Spi_AsyncTransmit and if configured, the SPI Handler/Driver shall invoke the se- quence notification call-back function after the last Job end notification if this one is also configured.⌋(SRS_SPAL_00157, SRS_Spi_12108)

[SWS_Spi_00058] ⌈The function Spi_SetupEB shall set up the buffers and the length of data for the specific EB SPI Handler/Driver Channel.⌋(SRS_Spi_12103)

The API parameter Length of data shall have a value within the specified buffer maximum value. Related error va lue: SPI_E_PARAM_LENGTH.

[SWS_Spi_00067] ⌈The function Spi_SetupEB shall update the buffer pointers and length attributes of the specified Channel with the provided val- ues.⌋(SRS_Spi_12103) As these attributes are persistent, they will be used for all succeeding calls to a Transmit method (for the specified Channel).

[SWS_Spi_00081] ⌈When the function Spi_AsyncTransmit is called and the re- quested Sequence is already in state SPI_SEQ_PENDING, the SPI Handler/Driver shall not take in account this new request and this function shall return with value E_NOT_OK, in this case.⌋()

[SWS_Spi_00086] ⌈When the function Spi_AsyncTransmit is called and the re- quested Sequence shares Jobs with another sequence that is in the state SPI_SEQ_PENDING, the SPI Handler/Driver shall not take into account this new re- quest and this function shall return the value E_NOT_OK. In this case and according to [SWS_BSW_00042] and [SWS_BSW_00045], the SPI Handler/Driver shall report the SPI_E_SEQ_PENDING error.⌋()

[SWS_Spi_00114]). In this case, the SPI Han- dler/Driver shall report the SPI_E_SEQ_IN_PROCESS error according to

[SWS_Spi_00133] ⌈The function Spi_AsyncTransmit is pre-compile time se- lectable by the configuration parameter SpiLevelDelivered. This function is only relevant for LEVEL 1 and LEVEL 2.⌋()

[SWS_Spi_00134] ⌈When the function Spi_SyncTransmit is called, shall take over the given parameter and set the SPI Handler/Driver status to SPI_BUSY can be ob- tained calling the API service SPI_GetStatus.⌋(SRS_Spi_12152, SRS_Spi_12153, SRS_Spi_12154)

[SWS_Spi_00135] ⌈When the function Spi_SyncTransmit is called while a se- quence is on transmission and SPI_SUPPORT_CONCURRENT_SYNC_TRANSMIT is disabled or another sequence is on transmission on same bus, the SPI Han- dler/Driver shall not take into account this new transmission request and the function shall return the value E_NOT_OK (see [SWS_Spi_00114]). In this case, the SPI Han- dler/Driver shall report the SPI_E_SEQ_IN_PROCESS error according to

[SWS_Spi_00136] ⌈The function Spi_SyncTransmit is pre-compile time se- lectable by the configuration parameter SpiLevelDelivered. This function is only relevant for LEVEL 0 and LEVEL 2.⌋() Parameters of the function Spi_SyncTransmit shall be checked as it is explained in section API parameter checking

[SWS_Spi_00137] ⌈The function Spi_WriteIB shall be pre-compile time configu- rable by the parameter SpiChannelBuffersAllowed. This function is only rele- vant for Channels with IB.⌋() Parameters of the function Spi_WriteIB shall be checked as it is explained in sec- tion API parameter checking. The SPI Handler/Driver shall have been initialized before the function Spi_WriteIB is called, otherwise see [SWS_Spi_00046].

[SWS_Spi_00138] ⌈The function Spi_ReadIB is pre-compile time configurable by the parameter SpiChannelBuffersAllowed. This function is only relevant for Channels with IB.⌋() Parameters of the function Spi_ReadIB shall be checked as it is explained in sec- tion API parameter checking. The SPI Handler/Driver shall have been initialized before the function Spi_ReadIB is called otherwise see [SWS_Spi_00046].

[SWS_Spi_00139] ⌈The function Spi_SetupEB is pre-compile time configurable by the parameter SpiChannelBuffersAllowed. This function is only relevant for Channels with EB.⌋() Parameters of the function Spi_SetupEB shall be checked as it is explained in sec- tion API parameter checking. The SPI Handler/Driver shall have been initialized before the function Spi_SetupEB is called otherwise see [SWS_Spi_00046].

The API parameter HWUnit shall have a value within the spe c i- fied range of valu es. Related error value: SPI_E_PARAM_UNIT.

[SWS_Spi_00154] ⌈The function Spi_SetAsyncMode is pre-compile time se- lectable by the configuration parameter SpiLevelDelivered. This function is only relevant for LEVEL 1 and 2.⌋()

Both the polling mechanism and inte r rupt mechanism modes for SPI busses shall be selectable during execution time (see [ SWS_Spi_00188 ]).

[SWS_Spi_00157] ⌈When the function Spi_AsyncTransmit is called, the SPI Han- dler/Driver shall handle the Job results. Result shall be SPI_JOB_PENDING when the transmission of Jobs is started.⌋()

[SWS_Spi_00171] ⌈If the function Spi_SetAsyncMode is called while the SPI Han- dler/Driver status is SPI_BUSY and an asynchronous transmission is in progress, the SPI Handler/Driver shall not change the AsyncModeType and keep the mode type as it is. The function shall return the value E_NOT_OK.⌋()

[SWS_Spi_00172] ⌈If Spi_SetAsyncMode is called while a synchronous transmis- sion is in progress, the SPI Handler/Driver shall set the AsyncModeType according to parameter 'Mode', even if the SPI Handler/Driver status is SPI_BUSY. The function shall return the value E_OK.⌋()

[SWS_Spi_00173] ⌈The SPI Handler/Driver’s environment shall call the function Spi_AsyncTransmit after a function call of Spi_SetupEB for EB Channels or a function call of Spi_WriteIB for IB Channels but before the function call Spi_ReadIB.⌋() Parameters of the function Spi_AsyncTransmit shall be checked as explained in section API parameter checking The SPI Handler/Driver shall have been initialized before the function Spi_AsyncTransmit is called otherwise see [SWS_Spi_00046].

[SWS_Spi_00194] ⌈When the function Spi_AsyncTransmit is called, shall take over the given parameter and set the Job status to SPI_JOB_QUEUED, which can be ob- tained by calling the API service Spi_GetJobResult.⌋()

SPI Handler/driver shall be able to detect the error SPI_E_HARDWARE_ERROR when an hardware error occur during asy n chronous or synchronous transmit. Please see also SWS_Spi_00267 and SWS_Spi_ 00384 .

If development error detection for the SPI module is enabled, the calling of the ro u- tine SPI_Init() while the SPI driver is a l ready initialized will cause a development error SPI_E_ALREADY_INITIALIZED and the desired functiona l ity shall be left without any action.

If not applicable, the SPI Handler/Driver module’s environment shall pass a NULL pointer to the fun c tion Spi_Init.

SPI Handler/driver shall be able to detect the error SPI_E_PARAM_JOB when API service called with wrong parameter.

SPI Handler/driver sha ll be able to detect the error SPI_E_PARAM_SEQ when API service called with wrong parameter.

SPI Handler/driver shall be able to detect th e error SPI_E_PARAM_LENGTH when API service called with wrong parameter.

SPI Handler/driver shall be able to detect the error SPI_E_PARAM_UNIT when API service called with wrong parameter.

SPI Handler/driver shall be able to det ect the error SPI_E_UNINIT when API service used without module initialization.

SPI Handler/driver shall be able to detect the error SPI_E_ SEQ_PENDING when services called in a wrong sequence.

SPI Handler/driver shall be able to detect the error SPI_E_SEQ_IN_PROCESS when synchronous tran s mission service called at wrong time.

SPI Handler/dri ver shall be able to detect the error SPI_E_ALREADY_INITIALIZED when API SPI_Init service called while the SPI dri v- er has already been initialized time.

[SWS_Spi_00252] ⌈In case of the SPI Handler/Driver state is not SPI_BUSY, the deInitialization function shall put all already initialized microcontroller SPI peripherals into the same state such as Power On Reset.⌋()

[SWS_Spi_00253] ⌈The function call Spi_DeInit shall be rejected if the status of SPI Handler/Driver is SPI_BUSY.⌋()

If the Sequence and Job related service is not done and, d e- pending on services, either the return value shall be E_NOT_OK or a failed result (SPI_JOB_FAILED or SPI_SEQ_FAILED).

The SPI Handler/Driver shall not pr o cess the invoked function but, depending on the invo ked function, shall either return the value E_NOT_OK or a failed result (SPI_JOB_FAILED or SPI_SEQ_FAILED).

If the API parameter Length related service is not done and the return value shall be E_NOT_OK.

[SWS_Spi_00266] ⌈When the function Spi_AsyncTransmit is called and the re- quested Sequence is already in state SPI_SEQ_PENDING the SPI Handler/Driver shall report the SPI_E_SEQ_PENDING error according to [SWS_BSW_00042] and

[SWS_Spi_00285] ⌈When the function Spi_SyncTransmit is called, shall take over the given parameter and set the Sequence status to SPI_SEQ_PENDING can be obtained calling the API service Spi_GetSequenceResult.⌋()

[SWS_Spi_00286] ⌈When the function Spi_SyncTransmit is called, shall take over the given parameter and set the Job status to SPI_JOB_PENDING can be obtained calling the API service Spi_GetJobResult.⌋()

If HWUnit related service is not done and the return value shall be SPI_UNINIT.

[SWS_Spi_00292] ⌈When the function Spi_AsyncTransmit is called, the SPI Han- dler/Driver shall handle the Job results. Result shall be SPI_JOB_OK when the transmission of Jobs is success.⌋()

[SWS_Spi_00293] ⌈When the function Spi_AsyncTransmit is called, the SPI Han- dler/Driver shall handle the Job results. Result shall be SPI_JOB_FAILED when the transmission of Jobs is failed.⌋()

[SWS_Spi_00300] ⌈The operation Std_ReturnType Spi_DeInit( ) is Non Re- entrant.⌋()

[SWS_Spi_00301] ⌈When the API Spi_DeInit has been accepted the return value of this function shall be E_OK.⌋()

[SWS_Spi_00302] ⌈When the API Spi_DeInit has not been accepted the return val- ue of this function shall be E_NOT_OK.⌋()

[SWS_Spi_00303] ⌈The function Spi_DeInit provides the service for SPI de- initialization.⌋()

[SWS_Spi_00304] ⌈The operation Spi_WriteIB is Re-entrant.⌋()

[SWS_Spi_00305] ⌈When the API Spi_WriteIB command has been accepted the function returns the value E_OK.⌋()

[SWS_Spi_00306] ⌈When the API Spi_WriteIB command has not been accepted the function returns the value E_NOT_OK.⌋()

[SWS_Spi_00307] ⌈The function Spi_WriteIB provides the service for writing one or more data to an IB SPI Handler/Driver Channel by the respective parameter.⌋()

[SWS_Spi_00308] ⌈The operation Std_ReturnType Spi_AsyncTransmit( Spi_SequenceType Sequence ) is Re-entrant.⌋()

[SWS_Spi_00309] ⌈When the API Spi_AsyncTransmit command has been accept- ed the function shall return the value E_OK.⌋()

[SWS_Spi_00310] ⌈When the API Spi_AsyncTransmit command has not been ac- cepted the function shall return the value E_NOT_OK.⌋()

[SWS_Spi_00311] ⌈The function Spi_AsyncTransmit provides service to transmit data on the SPI bus.⌋()

[SWS_Spi_00312] ⌈The operation Spi_ReadIB is Re-entrant.⌋()

[SWS_Spi_00313] ⌈The function Spi_ReadIB return values E_OK: read command has been accepted.⌋()

[SWS_Spi_00314] ⌈The function Spi_ReadIB return values E_NOT_OK: read com- mand has not been accepted.⌋()

[SWS_Spi_00315] ⌈The function Spi_ReadIB provides the service for reading syn- chronously one or more data from an IB SPI Handler/Driver Channel specified by parameter.⌋()

[SWS_Spi_00316] ⌈The operation Spi_SetupEB is Re-entrant.⌋()

[SWS_Spi_00317] ⌈Return values of the function Spi_SetupEB are E_OK: Setup command has been accepted and E_NOT_OK: Setup command has not been ac- cepted.⌋()

[SWS_Spi_00318] ⌈The function Spi_SetupEB provides the service to setup the buffers and the length of data for the EB SPI Handler/Driver Channel specified.⌋()

[SWS_Spi_00327] ⌈The operation Spi_SyncTransmit is Re-entrant.⌋()

[SWS_Spi_00328] ⌈The function Spi_SyncTransmit returns E_OK if the transmis- sion request has been successful.⌋()

[SWS_Spi_00329] ⌈The function Spi_SyncTransmit returns E_NOT_OK if the transmission request failed.⌋()

[SWS_Spi_00330] ⌈The function Spi_SyncTransmit provides the service to transmit data on the SPI bus.⌋()

[SWS_Spi_00335] ⌈The operation Spi_SetAsyncMode is Non Re-entrant.⌋()

[SWS_Spi_00336] ⌈Return value of the function Spi_SetAsyncMode is E_OK: Set- ting command has been done.⌋()

[SWS_Spi_00337] ⌈Return value of the function Spi_SetAsyncMode is E_NOT_OK: setting command has not been accepted.⌋()

[SWS_Spi_00338] ⌈The function Spi_SetAsyncMode service to set the asynchro- nous mechanism mode for SPI buses handled asynchronously.⌋()

Dem _ Set - Event Status Dem.h Called by SW - Cs or BSW modules to report monitor status information to the Dem. BSW modules calling Dem_ Set Event Status can safely ignore the return value. This API will be available only if ({Dem/ Dem Config Set/ Dem Event Parameter/ Dem Event Reporting Type} == STANDARD_ REPORTING) Det _ - Report Error Det.h Service to report development errors.

When a hardware error is detected, the SPI Handler /Driver shall stop the current s equence, report an error to the DEM as configured and set the state of the Job to SPI_JOB_FAILED and the state of the Sequence to SPI_SEQ_FAILED.

When any error bit inside the SPI transmit status register is set, the SPI transmit status register information shall b e reported to DEM as Dem_SetEventStatus (SPI_E_HARDWARE _ERROR, DEM_EVENT_STATUS_FAILED)

When no error bit inside the SPI transmit status register is set , t he SPI transmit status register information shall be reported to DEM as Dem_SetE ventStatus (SPI_E_HARDWARE_ERROR, DEM_EVENT_STATUS_PASSED)

Det _ Report - Runtime Error Det.h Service to report runtime errors. If a callout has been configured then this callout shall be called.

The SPI module shall reject configurations w ith partition ma p- pings which are not supported by the implementation.

Type of error Related error code Error value API service called with wrong channel SPI_ E_ PARAM_ CHANNEL 0x0A API service called with wrong job SPI_ E_ PARAM_ JOB 0x0B API service called with wrong sequence SPI_ E_ PARAM_ SEQ 0x0C API service called with wrong lenghth for EB SPI_ E_ PARAM_ LENGTH 0x0D API service called with wrong hardware unit SPI_ E_ PARAM_ UNIT 0x0E APIs called with an unexpected value for the pointer SPI_ E_ PARAM_ POINTER 0x10 API service used without module initialization SPI_ E_ UNINIT 0x1A API SPI_ Init service called while the SPI driver has been already initialized SPI_ E_ ALREADY_ INITIALIZED 0x4A

Type of error Related error code Erro r value API Spi_ Async Transmit service called in a wrong order SPI_ E_ SEQ_ PENDING 0x2A API Spi_ Sync Transmit service called at wrong time SPI_ E_ SEQ_ IN_ PROCESS 0x3A

The ECUC partitions referenced by Spi - K ernelEcucPartitionRef shall be a subset of the ECUC partitions referenced by SpiEcucPartitionRef.

The ECUC partitions referenced by Sp i- DeviceEcucPartitionRef shall be a subset of the ECUC partitions referenced by SpiEcucPartitionRef.

If SpiEcucPartitionRef references one or more ECUC partitions, SpiKernelEcucPartitionRef shall have a multiplicity of one and reference one of these ECUC partitions as well.

If SpiEcucPartitionRef references one or more ECUC partitions, SpiDeviceEcucPartitionRef shall have a multiplicity of greater than zero and reference one or several of these ECUC partitions as well.