mirror of
https://github.com/Dev-KATECH/ADM.git
synced 2026-05-17 01:43:59 +09:00
391 lines
20 KiB
C
391 lines
20 KiB
C
/**
|
|
* @file Lpspi_Ip.h
|
|
*
|
|
*
|
|
* @brief LPSPI IP driver header file.
|
|
* @details LPSPI IP driver header file.
|
|
|
|
* @addtogroup LPSPI_DRIVER Lpspi Driver
|
|
* @{
|
|
*/
|
|
/*==================================================================================================
|
|
* Project : RTD AUTOSAR 4.4
|
|
* Platform : CORTEXM
|
|
* Peripheral : LPSPI
|
|
* Dependencies :
|
|
*
|
|
* Autosar Version : 4.4.0
|
|
* Autosar Revision : ASR_REL_4_4_REV_0000
|
|
* Autosar Conf.Variant :
|
|
* SW Version : 0.9.0
|
|
* Build Version : S32K3_RTD_0_9_0__ASR_REL_4_4_REV_0000_20210326
|
|
*
|
|
* (c) Copyright 2020 - 2021 NXP Semiconductors
|
|
* All Rights Reserved.
|
|
*
|
|
* NXP Confidential. This software is owned or controlled by NXP and may only be
|
|
* used strictly in accordance with the applicable license terms. By expressly
|
|
* accepting such terms or by downloading, installing, activating and/or otherwise
|
|
* using the software, you are agreeing that you have read, and that you agree to
|
|
* comply with and are bound by, such license terms. If you do not agree to be
|
|
* bound by the applicable license terms, then you may not retain, install,
|
|
* activate or otherwise use the software.
|
|
==================================================================================================*/
|
|
|
|
#ifndef LPSPI_IP_H
|
|
#define LPSPI_IP_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"{
|
|
#endif
|
|
|
|
|
|
|
|
/*==================================================================================================
|
|
* INCLUDE FILES
|
|
* 1) system and project includes
|
|
* 2) needed interfaces from external units
|
|
* 3) internal and external interfaces from this unit
|
|
==================================================================================================*/
|
|
#include "Lpspi_Ip_Types.h"
|
|
#ifdef LPSPI_IP_ENABLE_USER_MODE_SUPPORT
|
|
#include "Mcal.h"
|
|
#endif
|
|
/*==================================================================================================
|
|
* SOURCE FILE VERSION INFORMATION
|
|
==================================================================================================*/
|
|
#define LPSPI_IP_VENDOR_ID 43
|
|
#define LPSPI_IP_AR_RELEASE_MAJOR_VERSION 4
|
|
#define LPSPI_IP_AR_RELEASE_MINOR_VERSION 4
|
|
#define LPSPI_IP_AR_RELEASE_REVISION_VERSION 0
|
|
#define LPSPI_IP_SW_MAJOR_VERSION 0
|
|
#define LPSPI_IP_SW_MINOR_VERSION 9
|
|
#define LPSPI_IP_SW_PATCH_VERSION 0
|
|
/*==================================================================================================
|
|
* FILE VERSION CHECKS
|
|
==================================================================================================*/
|
|
/* Check if Lpspi_Ip.h and Lpspi_Ip_Types.h are of the same vendor */
|
|
#if (LPSPI_IP_VENDOR_ID != LPSPI_IP_TYPES_VENDOR_ID)
|
|
#error "Lpspi_Ip.h and Lpspi_Ip_Types.h have different vendor ids"
|
|
#endif
|
|
/* Check if Lpspi_Ip.h file and Lpspi_Ip_Types.h file are of the same Autosar version */
|
|
#if ((LPSPI_IP_AR_RELEASE_MAJOR_VERSION != LPSPI_IP_TYPES_AR_RELEASE_MAJOR_VERSION) || \
|
|
(LPSPI_IP_AR_RELEASE_MINOR_VERSION != LPSPI_IP_TYPES_AR_RELEASE_MINOR_VERSION) || \
|
|
(LPSPI_IP_AR_RELEASE_REVISION_VERSION != LPSPI_IP_TYPES_AR_RELEASE_REVISION_VERSION))
|
|
#error "AutoSar Version Numbers of Lpspi_Ip.h and Lpspi_Ip_Types.h are different"
|
|
#endif
|
|
#if ((LPSPI_IP_SW_MAJOR_VERSION != LPSPI_IP_TYPES_SW_MAJOR_VERSION) || \
|
|
(LPSPI_IP_SW_MINOR_VERSION != LPSPI_IP_TYPES_SW_MINOR_VERSION) || \
|
|
(LPSPI_IP_SW_PATCH_VERSION != LPSPI_IP_TYPES_SW_PATCH_VERSION))
|
|
#error "Software Version Numbers of Lpspi_Ip.h and Lpspi_Ip_Types.h are different"
|
|
#endif
|
|
|
|
#ifndef DISABLE_MCAL_INTERMODULE_ASR_CHECK
|
|
/* Check if current file and Mcal header file are of the same Autosar version */
|
|
#if ((LPSPI_IP_AR_RELEASE_MAJOR_VERSION != MCAL_AR_RELEASE_MAJOR_VERSION) || \
|
|
(LPSPI_IP_AR_RELEASE_MINOR_VERSION != MCAL_AR_RELEASE_MINOR_VERSION))
|
|
#error "AutoSar Version Numbers of Lpspi_Ip.h and Mcal.h are different"
|
|
#endif
|
|
#endif
|
|
/*==================================================================================================
|
|
* CONSTANTS
|
|
==================================================================================================*/
|
|
/*==================================================================================================
|
|
* DEFINES AND MACROS
|
|
==================================================================================================*/
|
|
/*==================================================================================================
|
|
* ENUMS
|
|
==================================================================================================*/
|
|
/*==================================================================================================
|
|
* STRUCTURES AND OTHER TYPEDEFS
|
|
==================================================================================================*/
|
|
/*==================================================================================================
|
|
* GLOBAL VARIABLE DECLARATIONS
|
|
==================================================================================================*/
|
|
#define SPI_START_SEC_CONFIG_DATA_UNSPECIFIED
|
|
#include "Spi_MemMap.h"
|
|
/**
|
|
* @brief Export Post-Build configurations.
|
|
*/
|
|
LPSPI_IP_CONFIG_EXT
|
|
|
|
#define SPI_STOP_SEC_CONFIG_DATA_UNSPECIFIED
|
|
#include "Spi_MemMap.h"
|
|
/*==================================================================================================
|
|
* FUNCTION PROTOTYPES
|
|
==================================================================================================*/
|
|
#define SPI_START_SEC_CODE
|
|
#include "Spi_MemMap.h"
|
|
|
|
/**
|
|
* @brief LPSPI peripheral initialization.
|
|
* @details The function initialize the SPI Unit specified in the configuration.
|
|
*
|
|
* @param[in] pPhyUnitConfigPtr - pointer to the specified SPI Unit configuration.
|
|
*
|
|
* @return LPSPI_IP_STATUS_SUCCESS: Initialization command has been accepted.
|
|
* LPSPI_IP_STATUS_FAIL: Initialization command has not been accepted.
|
|
* @implements Lpspi_Ip_Init_Activity
|
|
*/
|
|
Lpspi_Ip_StatusType Lpspi_Ip_Init(const Lpspi_Ip_ConfigType *pPhyUnitConfigPtr);
|
|
|
|
/**
|
|
* @brief LPSPI peripheral deinitialization.
|
|
* @details The function de-initialize the SPI peripheral instance specified.
|
|
* All registers of SPI peripheral will be reset.
|
|
*
|
|
* @param[in] u8Instance - SPI peripheral instance number.
|
|
*
|
|
* @return LPSPI_IP_STATUS_SUCCESS: De-initialization command has been accepted.
|
|
* LPSPI_IP_STATUS_FAIL: De-initialization command has not been accepted.
|
|
* @implements Lpspi_Ip_DeInit_Activity
|
|
*/
|
|
Lpspi_Ip_StatusType Lpspi_Ip_DeInit(uint8 u8Instance);
|
|
|
|
/**
|
|
* @brief LPSPI synchronous transmission.
|
|
* @details This function initializes a synchronous transfer using the bus parameters provided
|
|
* by external device.
|
|
*
|
|
* @param[in] pExternalDevice - pointer to the external device where data is transmitted.
|
|
* @param[in] pu8TxBuffer - pointer to transmit buffer.
|
|
* @param[in-out] pu8RxBuffer - pointer to receive buffer.
|
|
* @param[in] u16Length - number of bytes to be sent.
|
|
* @param[in] u32TimeOut - duration for sending one frame.
|
|
*
|
|
* @return LPSPI_IP_STATUS_SUCCESS: Transmission command has been accepted.
|
|
* LPSPI_IP_FIFO_ERROR: Overflow or underflow error occurred.
|
|
* LPSPI_IP_STATUS_FAIL: Transmission command has not been accepted.
|
|
* LPSPI_IP_TIMEOUT: Timeout error occurred.
|
|
*
|
|
* @implements Lpspi_Ip_SyncTransmit_Activity
|
|
*/
|
|
Lpspi_Ip_StatusType Lpspi_Ip_SyncTransmit(
|
|
const Lpspi_Ip_ExternalDeviceType *pExternalDevice,
|
|
uint8 *pu8TxBuffer,
|
|
uint8 *pu8RxBuffer,
|
|
uint16 u16Length,
|
|
uint32 u32TimeOut
|
|
);
|
|
|
|
/**
|
|
* @brief LPSPI asynchronous transmission.
|
|
* @details This function initializes an asynchronous transfer using the bus parameters provided
|
|
* by external device.
|
|
*
|
|
* @param[in] pExternalDevice - pointer to the external device where data is transmitted
|
|
* @param[in] pu8TxBuffer - pointer to transmit buffer.
|
|
* @param[in-out] pu8RxBuffer - pointer to receive buffer.
|
|
* @param[in] u16Length - number of bytes to be sent.
|
|
* @param[in] EndCallback - callback function is called at the end of transfer.
|
|
*
|
|
* @return LPSPI_IP_STATUS_SUCCESS: Transmission command has been accepted.
|
|
* LPSPI_IP_STATUS_FAIL: Transmission command has not been accepted.
|
|
* @implements Lpspi_Ip_AsyncTransmit_Activity
|
|
*/
|
|
Lpspi_Ip_StatusType Lpspi_Ip_AsyncTransmit(
|
|
const Lpspi_Ip_ExternalDeviceType *pExternalDevice,
|
|
uint8 *pu8TxBuffer,
|
|
uint8 *pu8RxBuffer,
|
|
uint16 u16Length,
|
|
Lpspi_Ip_CallbackType EndCallback
|
|
);
|
|
|
|
#if (LPSPI_IP_DMA_USED == STD_ON)
|
|
#if (LPSPI_IP_ENABLE_DMAFASTTRANSFER_SUPPORT == STD_ON)
|
|
/**
|
|
* @brief LPSPI asynchronous transmission fast.
|
|
* @details This function initializes an asynchronous transmission for multiple transfers session
|
|
* and CPU used only for processing at the end of sequence transfer.
|
|
* The list of transfers session is composed of an array of fast transfers settings.
|
|
* The settings array is defined by the user needs: it contains entries parameters to be configured
|
|
* for each transfer session as defined in Lpspi_Ip_FastTransferType.
|
|
*
|
|
* How to use this interface:
|
|
* 1. Use the "Lpspi_Ip_FastTransferType" to create a list(array) of transfer session.
|
|
* Each field in Lpspi_Ip_FastTransferType for each transfer session must be configured.
|
|
* Note: This feature requires:
|
|
* a. The parameters SpiBaudrate, SpiHwUnit, SpiTimeClk2Cs, SpiTimeCs2Clk, SpiTimeCs2Cs, SpiDataWidth, SpiTransferStart in all External Devices used(pointed by pcExternalDevice) must be the same in each transfer session.
|
|
* b. In each transfer section, the number of data buffer(u16Length) is NOT higher than 32767 if SpiDataWidth < 9.
|
|
* c. Only Master mode is supported(SpiPhyUnit/SpiPhyUnitMode = SPI_MASTER).
|
|
* d. Make sure that SpiPhyUnit/SpiMaxDmaFastTransfer value must NOT lower than total of transfer sessions.
|
|
* e. Make sure that number of ScatterGathers configuration in SpiPhyUnit/SpiPhyTxDmaChannel must NOT lower than
|
|
* total of transfer sessions plus number of time request CS de-assert(bKeepCs = FALSE) at the end of transfer session in the list configured.
|
|
* f. Make sure that number of ScatterGathers configuration in each SpiPhyUnit/SpiPhyRxDmaChannel must NOT lower than total of transfer sessions.
|
|
* 2. Call the "Lpspi_Ip_AsyncTransmitFast()" interface.
|
|
*
|
|
* Example:
|
|
* The user shall create the desired configuration list for his specific application.
|
|
* For example use case:
|
|
* - Requiring 2 transfers session, keep CS assert at the end of first transfer session.
|
|
* - Transfer session 1:
|
|
* + Use SpiExternalDevice_0 with SpiCsIdentifier = PCS0, SpiCsContinous = TRUE.
|
|
* + Send 5 bytes. Tx buffer is "uint8 u8TxBuffer1[5u]={0,1,2,3,4};". Rx buffer is "uint8 u8RxBuffer1[5u];".
|
|
* + Keep CS assert at the end of this transfer session.
|
|
* - Transfer session 2:
|
|
* + Use SpiExternalDevice_0 with SpiCsIdentifier = PCS0, SpiCsContinous = TRUE.
|
|
* + Send 10 bytes with default transmit data value is 5. Tx buffer is NULL_PTR. Rx buffer is "uint8 u8RxBuffer2[10u];".
|
|
* + This is last transfer session, so CS will not kipped by default at the end of last transfer session.
|
|
* - Configuration example on configuration tool:
|
|
* + SpiGeneral/SpiEnableDmaFastTransferSupport = true.
|
|
* + SpiPhyUnit/SpiMaxDmaFastTransfer = 2(2 transfers session).
|
|
* + Number of ScatterGathers configuration for SpiPhyTxDmaChannel is 3(2 transfers session + 1 time CS de-assert at the end of last transfer session).
|
|
* + Number of ScatterGathers configuration for SpiPhyRxDmaChannel is 2(2 transfers session).
|
|
* - Call "UserCallbackFunc" when Fast transfer completed.
|
|
* - Coding example:
|
|
* void UserCallbackFunc(uint8 u8Instance, Lpspi_Ip_EventType event);
|
|
* Lpspi_Ip_FastTransferType aUserFastTransferCfgList[2u] =
|
|
* {
|
|
* {
|
|
* Lpspi_Ip_DeviceAttributes_SpiExternalDevice_0_BOARD_InitPeripherals, ->Point to External Device 0 configuration generated by configuration tool
|
|
* u8TxBuffer1, -> Store pointer for Tx buffer
|
|
* u8RxBuffer1, -> Store pointer for Rx buffer
|
|
* 0u, -> Default transmit data, don't care due to Tx buffer is not NULL_PTR
|
|
* 5u, -> Number of bytes to be sent
|
|
* (boolean)TRUE -> Keep CS signal at the end of this transfer session
|
|
* },
|
|
* {
|
|
* Lpspi_Ip_DeviceAttributes_SpiExternalDevice_0_BOARD_InitPeripherals, -> Point to external device configuration
|
|
* NULL_PTR, -> Store pointer for Tx buffer
|
|
* u8RxBuffer2, -> Store pointer for Rx buffer
|
|
* 5u, -> Default transmit data, don't care due to Tx buffer is not NULL_PTR
|
|
* 10u, -> Number of bytes to be sent
|
|
* (boolean)FALSE -> Not keep CS signal at the end of this transfer session, don't care this parameter for last transfer
|
|
* }
|
|
* };
|
|
* Lpspi_Ip_AsyncTransmitFast(aUserFastTransferCfgList, 2u, &UserCallbackFunc);
|
|
*
|
|
* @param[in-out] pFastTransferCfg - pointer to the list of transfers section configuration.
|
|
* @param[in] u16NumberOfTransfer - number of transfers session in the list is pointed by pFastTransferCfg.
|
|
* @param[in] EndCallback - callback function is called at the end of sequence transfer.
|
|
*
|
|
* @return LPSPI_IP_STATUS_SUCCESS: Transmission command has been accepted.
|
|
* LPSPI_IP_STATUS_FAIL: Transmission command has not been accepted.
|
|
* @implements Lpspi_Ip_AsyncTransmitFast_Activity
|
|
*/
|
|
Lpspi_Ip_StatusType Lpspi_Ip_AsyncTransmitFast(
|
|
const Lpspi_Ip_FastTransferType *pFastTransferCfg,
|
|
uint8 u8NumberOfTransfer,
|
|
Lpspi_Ip_CallbackType EndCallback
|
|
);
|
|
#endif
|
|
#endif
|
|
|
|
/**
|
|
* @brief Get status of HW unit.
|
|
* @details This function returns the status of the specified SPI Hardware microcontroller peripheral.
|
|
*
|
|
* @param[in] u8Instance - SPI peripheral instance number.
|
|
*
|
|
* @return Lpspi_Ip_HwStatusType
|
|
* @implements Lpspi_Ip_GetStatus_Activity
|
|
*/
|
|
Lpspi_Ip_HwStatusType Lpspi_Ip_GetStatus(uint8 u8Instance);
|
|
|
|
/**
|
|
* @brief Process transfer in POLLING mode.
|
|
* @details This function shall polls the SPI interrupts linked to SPI peripheral instance allocated to
|
|
* the transmission of data to enable the evolution of transmission state machine.
|
|
*
|
|
* @param[in] u8Instance - SPI peripheral instance number.
|
|
*
|
|
* @return void
|
|
* @implements Lpspi_Ip_ManageBuffers_Activity
|
|
*/
|
|
void Lpspi_Ip_ManageBuffers(uint8 u8Instance);
|
|
|
|
/**
|
|
* @brief LPSPI change frame size.
|
|
* @details This function updates frame size of specific external device configuration for next transfers.
|
|
*
|
|
* @param[in] pExternalDevice - pointer to the external device configuration.
|
|
* @param[in] u8FrameSize - Frame size.
|
|
*
|
|
* @return LPSPI_IP_STATUS_SUCCESS: Setting command has been accepted.
|
|
* LPSPI_IP_STATUS_FAIL: Setting command has not been accepted.
|
|
* @implements Lpspi_Ip_UpdateFrameSize_Activity
|
|
*/
|
|
Lpspi_Ip_StatusType Lpspi_Ip_UpdateFrameSize(const Lpspi_Ip_ExternalDeviceType *pExternalDevice, uint8 u8FrameSize);
|
|
|
|
/**
|
|
* @brief LPSPI change bit order.
|
|
* @details This function updates bits order LSB or MSB of specific external device configuration for next transfer.
|
|
*
|
|
* @param[in] pExternalDevice - pointer to the external device configuration.
|
|
* @param[in] bLsb - Data is transferred LSB first or not.
|
|
*
|
|
* @return LPSPI_IP_STATUS_SUCCESS: Setting command has been accepted.
|
|
* LPSPI_IP_STATUS_FAIL: Setting command has not been accepted.
|
|
* @implements Lpspi_Ip_UpdateLsb_Activity
|
|
*/
|
|
Lpspi_Ip_StatusType Lpspi_Ip_UpdateLsb(const Lpspi_Ip_ExternalDeviceType *pExternalDevice, boolean bLsb);
|
|
|
|
/**
|
|
* @brief LPSPI change default transmit data.
|
|
* @details This function updates default transmit data of specific external device configuration for next transfer.
|
|
*
|
|
* @param[in] pExternalDevice - pointer to the external device configuration.
|
|
* @param[in] u32DefaultData - New default transmit data.
|
|
*
|
|
* @return LPSPI_IP_STATUS_SUCCESS: Setting command has been accepted.
|
|
* LPSPI_IP_STATUS_FAIL: Setting command has not been accepted.
|
|
* @implements Lpspi_Ip_UpdateDefaultTransmitData_Activity
|
|
*/
|
|
Lpspi_Ip_StatusType Lpspi_Ip_UpdateDefaultTransmitData(const Lpspi_Ip_ExternalDeviceType *pExternalDevice, uint32 u32DefaultData);
|
|
|
|
/**
|
|
* @brief LPSPI change transfer mode.
|
|
* @details This function updates the asynchronous mechanism mode for the specified SPI Hardware microcontroller peripheral.
|
|
*
|
|
* @param[in] u8Instance - SPI peripheral instance number.
|
|
* @param[in] Mode - new mode (interrupt or polling).
|
|
*
|
|
* @return LPSPI_IP_STATUS_SUCCESS: Setting command has been accepted.
|
|
* LPSPI_IP_STATUS_FAIL: Setting command has not been accepted.
|
|
* @implements Lpspi_Ip_UpdateTransferMode_Activity
|
|
*/
|
|
Lpspi_Ip_StatusType Lpspi_Ip_UpdateTransferMode(uint8 u8Instance, Lpspi_Ip_ModeType Mode);
|
|
|
|
/**
|
|
* @brief LPSPI cancel current asynchronous transmission.
|
|
* @details This function cancels an asynchronous transmission in progress for the specified SPI Hardware microcontroller peripheral.
|
|
*
|
|
* @param[in] u8Instance - SPI peripheral instance number.
|
|
*
|
|
* @return void
|
|
* @implements Lpspi_Ip_Cancel_Activity
|
|
*/
|
|
void Lpspi_Ip_Cancel(uint8 u8Instance);
|
|
|
|
#if (LPSPI_IP_DUAL_CLOCK_MODE == STD_ON)
|
|
/**
|
|
* @brief Change clock mode.
|
|
* @details This function will change clock mode to operate with other clock reference.
|
|
*
|
|
* @param[in] u8Instance - SPI peripheral instance number.
|
|
* @param[in] ClockMode Clock mode.
|
|
*
|
|
* @return LPSPI_IP_STATUS_SUCCESS: Setting command has been accepted.
|
|
* LPSPI_IP_STATUS_FAIL: Setting command has not been accepted.
|
|
*/
|
|
Lpspi_Ip_StatusType Lpspi_Ip_SetClockMode(uint8 u8Instance, Lpspi_Ip_DualClockModeType ClockMode);
|
|
#endif
|
|
|
|
void Lpspi_Ip_IrqHandler(uint8 u8Instance);
|
|
#if (LPSPI_IP_DMA_USED == STD_ON)
|
|
void Lpspi_Ip_IrqTxDmaHandler(uint8 u8Instance);
|
|
void Lpspi_Ip_IrqRxDmaHandler(uint8 u8Instance);
|
|
#endif
|
|
|
|
#define SPI_STOP_SEC_CODE
|
|
#include "Spi_MemMap.h"
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* LPSPI_IP_H */
|
|
|
|
/** @} */
|
|
|