ADM/GW/RTD/include/IntCtrl_Ip.h
2024-08-08 10:00:15 +09:00

291 lines
8.9 KiB
C

/*==================================================================================================
* Project : RTD AUTOSAR 4.4
* Platform : CORTEXM
* Peripheral :
* Dependencies : none
*
* 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 INTCTRL_IP_H_
#define INTCTRL_IP_H_
/**
* @file
*
* @defgroup IntCtrl_Ip Interrupt Controller IP
* @ingroup Platform
*
* @addtogroup IntCtrl_Ip
* @{
*/
/*==================================================================================================
* INCLUDE FILES
==================================================================================================*/
#include "IntCtrl_Ip_Cfg.h"
#include "Devassert.h"
/*==================================================================================================
* FUNCTION PROTOTYPES
==================================================================================================*/
#if defined(__cplusplus)
extern "C" {
#endif /* __cplusplus*/
#define PLATFORM_START_SEC_CODE
#include "Platform_MemMap.h"
/**
* @brief Initializes the configured interrupts at interrupt controller level.
*
* @details This function is non-reentrant and initializes the interrupts.
*
* @param[in] pIntCtrlCtrlConfig: pointer to configuration structure for interrupts.
* @return IntCtrl_Ip_StatusType: error code.
*
* @api
*
* */
IntCtrl_Ip_StatusType IntCtrl_Ip_Init(const IntCtrl_Ip_CtrlConfigType *pIntCtrlCtrlConfig);
#if (INT_CTRL_IP_MSCM_SYSTEM_INTERRUPT_ROUTER == STD_ON)
/**
* @brief Initializes the configured routing interrupts .
*
* @details This function is non-reentrant and initializes the routing interrupts.
*
* @param[in] routeConfig: pointer to configuration structure for interrupts.
* @return IntCtrl_Ip_StatusType: error code.
*
* @api
*
* */
IntCtrl_Ip_StatusType IntCtrl_Ip_ConfigIrqRouting(const IntCtrl_Ip_GlobalRouteConfigType *routeConfig);
#endif
/**
* @brief Installs a handler for an IRQ.
*
* @details This function is non-reentrant; it installs an new ISR for an interrupt line.
* @note This function works only when the interrupt vector table resides in RAM.
*
* @param[in] eIrqNumber: interrupt number.
* @param[in] pfNewHandler: function pointer for the new handler.
* @param[out] pfOldHandler: stores the address of the old interrupt handler.
* @return void.
*
* @api
*
* */
void IntCtrl_Ip_InstallHandler(IRQn_Type eIrqNumber,
const IntCtrl_Ip_IrqHandlerType pfNewHandler,
IntCtrl_Ip_IrqHandlerType* const pfOldHandler);
/**
* @brief Enables an interrupt request.
*
* @details This function is non-reentrant; it enables the interrupt request at
* interrupt controller level.
*
* @param[in] eIrqNumber: interrupt number to be enabled.
* @return void.
*
* @api
*
* */
void IntCtrl_Ip_EnableIrq(IRQn_Type eIrqNumber);
/**
* @brief Disables an interrupt request.
*
* @details This function is non-reentrant; it disables the interrupt request at
* interrupt controller level.
*
* @param[in] eIrqNumber: interrupt number to be disabled.
* @return void.
*
* @api
*
* */
void IntCtrl_Ip_DisableIrq(IRQn_Type eIrqNumber);
/**
* @brief Sets the priority for an interrupt request.
*
* @details This function is non-reentrant; it sets the priority for the
* interrupt request.
*
* @param[in] eIrqNumber: interrupt number for which the priority is set.
* @param[in] u8Priority: the priority to be set.
* @return void.
*
* @api
*
* */
void IntCtrl_Ip_SetPriority(IRQn_Type eIrqNumber, uint8 u8Priority);
/**
* @brief Gets the priority for an interrupt request.
*
* @details This function is non-reentrant; it retrieves the priority for the
* interrupt request.
*
* @param[in] eIrqNumber: interrupt number for which the priority is set.
* @return uint8: the priority of the interrupt.
*
* @api
*
* */
uint8 IntCtrl_Ip_GetPriority(IRQn_Type eIrqNumber);
/**
* @brief Clears the pending flag for an interrupt request.
*
* @details This function is reentrant; it clears the pending flag for the
* interrupt request.
*
* @param[in] eIrqNumber: interrupt number for which the pending flag is cleared.
* @return void.
*
* @api
*
* */
void IntCtrl_Ip_ClearPending(IRQn_Type eIrqNumber);
#if (INT_CTRL_IP_STANDALONE_APIS == STD_ON)
/**
* @brief Sets the pending flag for an interrupt request.
*
* @details This function is reentrant; it sets the pending flag for the
* interrupt request.
*
* @param[in] eIrqNumber: interrupt number for which the pending flag is set.
* @return void.
*
* @api
*
* */
void IntCtrl_Ip_SetPending(IRQn_Type eIrqNumber);
/**
* @brief Gets the pending flag for an interrupt request.
*
* @details This function is reentrant; it retrieves the pending flag for the
* interrupt request.
*
* @param[in] eIrqNumber: interrupt number for which the pending flag is returned.
* @return boolean: TRUE - pending flag set, FALSE - pending flag cleared.
*
* @api
*
* */
boolean IntCtrl_Ip_GetPending(IRQn_Type eIrqNumber);
/**
* @brief Gets the active flag for an interrupt request.
*
* @details This function is reentrant; it retrieves the active flag for the
* interrupt request.
*
* @param[in] eIrqNumber: interrupt number for which the active flag is returned.
* @return boolean: TRUE - active flag set, FALSE - active flag cleared.
*
* @api
*
* */
boolean IntCtrl_Ip_GetActive(IRQn_Type eIrqNumber);
#endif /* INT_CTRL_IP_STANDALONE_APIS*/
#if (INT_CTRL_IP_MSCM_SYSTEM_INTERRUPT_ROUTER == STD_ON)
/**
* @brief Sets the target cores for an interrupt request.
*
* @details This function is non-reentrant; it configures the target cores for the
* interrupt request.
*
* @param[in] eIrqNumber: interrupt number for which the target cores are set.
* @param[in] u8TargetCores: uint8 mask to defining the target cores.
* @note u8TargetCores parameter encodes the CPU targets as defined in each platform
* (see MSCM IRSPRCx register) - the function writes this value to the corresponding
* IRSPRCx register directly.
* @return void.
*
* @api
*
* */
void IntCtrl_Ip_SetTargetCores(IRQn_Type eIrqNumber, uint8 u8TargetCores);
#endif
#if (INT_CTRL_IP_MSI_AVAILABLE == STD_ON)
/**
* @brief Clear directed cpu Interrupt interrupt flag.
*
* @details This function is non-reentrant; it is provided for clearing directed cpu Interrupt interrupt flag.
*
* @param[in] eIrqNumber: interrupt number
* @return void.
*
* @api
*
* */
void IntCtrl_Ip_ClearDirectedCpuInterrupt(IRQn_Type eIrqNumber);
/**
* @brief Get directed cpu Interrupt interrupt flag.
*
* @details This function is non-reentrant; it is provided for getting directed cpu Interrupt interrupt flag.
*
* @param[in] eIrqNumber: interrupt number
* @return boolean: TRUE - flag set, FALSE - flag cleared.
*
* @api
*
* */
boolean IntCtrl_Ip_GetDirectedCpuInterrupt(IRQn_Type eIrqNumber);
/**
* @brief Generates an interrupt request to a CPU target.
*
* @details This function is non-reentrant; it is provided for generating a directed interrupt
* to a CPU defined by target parameter.
*
* @param[in] eIrqNumber: interrupt number to be triggered.
* @param[in] eCpuTarget: target core for the interrupt request.
* @return void.
*
* @api
*
* */
void IntCtrl_Ip_GenerateDirectedCpuInterrupt(IRQn_Type eIrqNumber, IntCtrl_Ip_IrqTargetType eCpuTarget);
#endif
#define PLATFORM_STOP_SEC_CODE
#include "Platform_MemMap.h"
#if defined(__cplusplus)
}
#endif /* __cplusplus*/
#endif /* INTCTRL_IP_H_ */
/** @} */