4G/RTD/include/Power_Ip_SMC.h

/*==================================================================================================
*   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           : 1.0.0
*   Build Version        : S32K1_RTD_1_0_0_HF01_D2109_ASR_REL_4_4_REV_0000_20210907
*
*   (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.
==================================================================================================*/
/**
*   @file       Power_Ip_SMC.h
*   @version    1.0.0
*
*   @brief   POWER IP driver header file.
*   @details POWER IP driver header file.
*
*   @addtogroup POWER_DRIVER Power Ip Driver
*   @{
*/

#ifndef POWER_IP_SMC_H
#define POWER_IP_SMC_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 "Power_Ip_SMC_Types.h"
#include "Power_Ip_Cfg.h"
#include "StandardTypes.h"
#include "OsIf.h"
#include "Mcal.h"


/*==================================================================================================
                               SOURCE FILE VERSION INFORMATION
==================================================================================================*/
#define POWER_IP_SMC_VENDOR_ID                       43
#define POWER_IP_SMC_AR_RELEASE_MAJOR_VERSION        4
#define POWER_IP_SMC_AR_RELEASE_MINOR_VERSION        4
#define POWER_IP_SMC_AR_RELEASE_REVISION_VERSION     0
#define POWER_IP_SMC_SW_MAJOR_VERSION                1
#define POWER_IP_SMC_SW_MINOR_VERSION                0
#define POWER_IP_SMC_SW_PATCH_VERSION                0

/*==================================================================================================
                                      FILE VERSION CHECKS
==================================================================================================*/
#ifndef DISABLE_MCAL_INTERMODULE_ASR_CHECK
  /* Check if Power_Ip_SMC.h file and StandardTypes.h file are of the same Autosar version */
  #if ((POWER_IP_SMC_AR_RELEASE_MAJOR_VERSION    != STD_AR_RELEASE_MAJOR_VERSION) || \
       (POWER_IP_SMC_AR_RELEASE_MINOR_VERSION    != STD_AR_RELEASE_MINOR_VERSION))
      #error "AutoSar Version Numbers of Power_Ip_SMC.h and StandardTypes.h are different"
  #endif
  
  /* Check if Power_Ip_SMC.h file and OsIf.h file are of the same Autosar version */
  #if ((POWER_IP_SMC_AR_RELEASE_MAJOR_VERSION    != OSIF_AR_RELEASE_MAJOR_VERSION) || \
       (POWER_IP_SMC_AR_RELEASE_MINOR_VERSION    != OSIF_AR_RELEASE_MINOR_VERSION))
      #error "AutoSar Version Numbers of Power_Ip_SMC.h and OsIf.h are different"
  #endif
  
  /* Check if Power_Ip_SMC.h file and Mcal.h file are of the same Autosar version */
  #if ((POWER_IP_SMC_AR_RELEASE_MAJOR_VERSION    != MCAL_AR_RELEASE_MAJOR_VERSION) || \
       (POWER_IP_SMC_AR_RELEASE_MINOR_VERSION    != MCAL_AR_RELEASE_MINOR_VERSION))
      #error "AutoSar Version Numbers of Power_Ip_SMC.h and Mcal.h are different"
  #endif
#endif /* DISABLE_MCAL_INTERMODULE_ASR_CHECK */

/* Check if Power_Ip_SMC.h file and Power_Ip_SMC_Types.h file are of the same vendor */
#if (POWER_IP_SMC_VENDOR_ID != POWER_IP_SMC_TYPES_VENDOR_ID)
    #error "Power_Ip_SMC.h and Power_Ip_SMC_Types.h have different vendor ids"
#endif

/* Check if Power_Ip_SMC.h file and Power_Ip_SMC_Types.h file are of the same Autosar version */
#if ((POWER_IP_SMC_AR_RELEASE_MAJOR_VERSION != POWER_IP_SMC_TYPES_AR_RELEASE_MAJOR_VERSION) || \
     (POWER_IP_SMC_AR_RELEASE_MINOR_VERSION != POWER_IP_SMC_TYPES_AR_RELEASE_MINOR_VERSION) || \
     (POWER_IP_SMC_AR_RELEASE_REVISION_VERSION != POWER_IP_SMC_TYPES_AR_RELEASE_REVISION_VERSION) \
    )
    #error "AutoSar Version Numbers of Power_Ip_SMC.h and Power_Ip_SMC_Types.h are different"
#endif

/* Check if Power_Ip_SMC.h file and Power_Ip_SMC_Types.h file are of the same Software version */
#if ((POWER_IP_SMC_SW_MAJOR_VERSION != POWER_IP_SMC_TYPES_SW_MAJOR_VERSION) || \
     (POWER_IP_SMC_SW_MINOR_VERSION != POWER_IP_SMC_TYPES_SW_MINOR_VERSION) || \
     (POWER_IP_SMC_SW_PATCH_VERSION != POWER_IP_SMC_TYPES_SW_PATCH_VERSION) \
    )
    #error "Software Version Numbers of Power_Ip_SMC.h and Power_Ip_SMC_Types.h are different"
#endif

/* Check if Power_Ip_SMC.h file and Power_Ip_Cfg.h file are of the same vendor */
#if (POWER_IP_SMC_VENDOR_ID != POWER_IP_CFG_VENDOR_ID)
    #error "Power_Ip_SMC.h and Power_Ip_Cfg.h have different vendor ids"
#endif

/* Check if Power_Ip_SMC.h file and Power_Ip_Cfg.h file are of the same Autosar version */
#if ((POWER_IP_SMC_AR_RELEASE_MAJOR_VERSION != POWER_IP_CFG_AR_RELEASE_MAJOR_VERSION) || \
     (POWER_IP_SMC_AR_RELEASE_MINOR_VERSION != POWER_IP_CFG_AR_RELEASE_MINOR_VERSION) || \
     (POWER_IP_SMC_AR_RELEASE_REVISION_VERSION != POWER_IP_CFG_AR_RELEASE_REVISION_VERSION) \
    )
    #error "AutoSar Version Numbers of Power_Ip_SMC.h and Power_Ip_Cfg.h are different"
#endif

/* Check if Power_Ip_SMC.h file and Power_Ip_Cfg.h file are of the same Software version */
#if ((POWER_IP_SMC_SW_MAJOR_VERSION != POWER_IP_CFG_SW_MAJOR_VERSION) || \
     (POWER_IP_SMC_SW_MINOR_VERSION != POWER_IP_CFG_SW_MINOR_VERSION) || \
     (POWER_IP_SMC_SW_PATCH_VERSION != POWER_IP_CFG_SW_PATCH_VERSION) \
    )
    #error "Software Version Numbers of Power_Ip_SMC.h and Power_Ip_Cfg.h are different"
#endif
/*==================================================================================================
*                                          CONSTANTS
==================================================================================================*/


/*==================================================================================================
                                       DEFINES AND MACROS
==================================================================================================*/

/*==================================================================================================
*                                             ENUMS
==================================================================================================*/


/*==================================================================================================
*                                STRUCTURES AND OTHER TYPEDEFS
==================================================================================================*/


/*==================================================================================================
*                                GLOBAL VARIABLE DECLARATIONS
==================================================================================================*/


/*==================================================================================================
*                                    FUNCTION PROTOTYPES
==================================================================================================*/
#define MCU_START_SEC_CODE

#include "Mcu_MemMap.h"

#if (defined(POWER_IP_DISABLE_SMC_INIT) && (STD_OFF == POWER_IP_DISABLE_SMC_INIT))
#ifdef POWER_IP_ENABLE_USER_MODE_SUPPORT
  #if (STD_ON == POWER_IP_ENABLE_USER_MODE_SUPPORT)

#define  Call_Power_Ip_SMC_AllowedModesConfig(SMC_pConfigPtr) \
    OsIf_Trusted_Call1param(Power_Ip_SMC_AllowedModesConfig,(SMC_pConfigPtr))
  #else

#define  Call_Power_Ip_SMC_AllowedModesConfig(SMC_pConfigPtr) \
    Power_Ip_SMC_AllowedModesConfig(SMC_pConfigPtr)
  #endif
#endif
#endif


#ifdef POWER_IP_ENABLE_USER_MODE_SUPPORT
  #if (STD_ON == POWER_IP_ENABLE_USER_MODE_SUPPORT)

#define  Call_Power_Ip_SMC_ModeConfig(pModeConfigPtr) \
    OsIf_Trusted_Call_Return1param(Power_Ip_SMC_ModeConfig,(pModeConfigPtr))
  #else

#define  Call_Power_Ip_SMC_ModeConfig(pModeConfigPtr) \
    Power_Ip_SMC_ModeConfig(pModeConfigPtr)
  #endif
#endif

#if (defined(POWER_IP_DISABLE_SMC_INIT) && (STD_OFF == POWER_IP_DISABLE_SMC_INIT))
void Power_Ip_SMC_AllowedModesConfig(const Power_Ip_SMC_ConfigType * pConfigPtr);
#endif
Power_Ip_SMC_ModeStatusType Power_Ip_SMC_ModeCheckEntry(Power_Ip_PowerModeType ePowerMode);
uint32 Power_Ip_SMC_ModeConfig(const Power_Ip_ModeConfigType * pModeConfigPtr);

#ifdef POWER_IP_POWERMODE_STATE_API
#if (STD_ON == POWER_IP_POWERMODE_STATE_API)
Power_Ip_PowerModeStateType Power_Ip_SMC_GetPowerModeState(void);
#endif
#endif

#define MCU_STOP_SEC_CODE

#include "Mcu_MemMap.h"


#ifdef __cplusplus
}
#endif

#endif /* POWER_IP_SMC_H */

/** @} */