/*!
* @file     Irme_Sms.h
*
* @version  1.0.0
*
* @brief    The header of IRME moudle internal API
*
* @attention
*
* Project Name      : AUTOSAR MCAL
*
* Platform          : Arm
*
* Autosar Standard  : Classic Platform 4.4.0
*
* Compiled Version  : G32A10xx_MCAL_1_0_0_01-Otc-25
*
* Copyright (C) 2026 Geehy Semiconductor
*
* You may not use this file except in compliance with the
* GEEHY COPYRIGHT NOTICE (Geehy Semiconductor Software License Agreement).
*
* The program is only for reference, which is distributed in the hope
* that it will be usefull and instructional for customers to develop
* their software. Unless required by applicable law or agreed to in
* writing, the program is distributed on an "AS IS" BASIS, WITHOUT
* ANY WARRANTY OR CONDITIONS OF ANY KIND, either express or implied.
* See the Geehy Semiconductor Software License Agreement for the governing permissions
* and limitations under the License.
*/

#ifndef IRME_SMS_H
#define IRME_SMS_H

#ifdef __cplusplus
extern "C"{
#endif

#include "Irme_SmsTypes.h"

/** @addtogroup G32A10xx_StdPeriphDriver
  @{
*/

/** @defgroup IRME_Driver
  * @brief IRME driver modules
  @{
*/

/** @defgroup IRME_Macros
  @{
*/
/***********************************************************************************************************************
                                    VENDOR ID & AUTOSAR VERSION INFO
***********************************************************************************************************************/
/** Vendor ID (vendorId) of the dedicated implementation of this module according to the AUTOSAR vendor list. */
#define IRME_SMS_H_VENDOR_ID                              0x00C1U
/** Module ID of this module, as defined in the BSW Module List. */
#define IRME_SMS_H_MODULE_ID                              0x0000U
/** Major version number of AUTOSAR release on which the appropriate implementation is based on. */
#define IRME_SMS_H_AR_RELEASE_MAJOR_VERSION               0x04U
/** Minor version number of AUTOSAR release on which the appropriate implementation is based on. */
#define IRME_SMS_H_AR_RELEASE_MINOR_VERSION               0x04U
/** Revision version number of AUTOSAR release on which the appropriate implementation is based on. */
#define IRME_SMS_H_AR_RELEASE_REVISION_VERSION            0x00U
/** Major version number of the vendor specific implementation of the module. The numbering is vendor specific. */ 
#define IRME_SMS_H_SW_MAJOR_VERSION                       0x01U
/** Minor version number of the vendor specific implementation of the module. The numbering is vendor specific. */
#define IRME_SMS_H_SW_MINOR_VERSION                       0x00U
/** Patch level version number of the vendor specific implementation of the module. The numbering is vendor specific. */
#define IRME_SMS_H_SW_PATCH_VERSION                       0x00U

/**@} end of group IRME_Macros */

/***********************************************************************************************************
                                  VERSION INFOMATION VERIFICATION
*************************************************************************************************************/
/* Make sure the vendor ids are the same between Irme_Sms.h and Irme_SmsTypes.h" */
#if (IRME_SMS_H_VENDOR_ID != IRME_SMS_TYPES_H_VENDOR_ID)
    #error "Vendor ids mismatch between Irme_Sms.h and Irme_SmsTypes.h"
#endif
/* Make sure the AUTOSAR major version number is the same between Irme_Sms.h and Irme_SmsTypes.h" */
#if (IRME_SMS_H_AR_RELEASE_MAJOR_VERSION != IRME_SMS_TYPES_H_AR_RELEASE_MAJOR_VERSION)
    #error "AUTOSAR Major Version Number mismatch between Irme_Sms.h and Irme_SmsTypes.h"
#endif
/* Make sure the AUTOSAR minor version number is the same between Irme_Sms.h and Irme_SmsTypes.h" */
#if (IRME_SMS_H_AR_RELEASE_MINOR_VERSION != IRME_SMS_TYPES_H_AR_RELEASE_MINOR_VERSION)
    #error "AUTOSAR Minor Version Number mismatch between Irme_Sms.h and Irme_SmsTypes.h"
#endif
/* Make sure the AUTOSAR revision version number is the same between Irme_Sms.h and Irme_SmsTypes.h" */
#if (IRME_SMS_H_AR_RELEASE_REVISION_VERSION != IRME_SMS_TYPES_H_AR_RELEASE_REVISION_VERSION)
    #error "AUTOSAR Revision Version Number mismatch between Irme_Sms.h and Irme_SmsTypes.h"
#endif
/* Make sure the software major version number is the same between Irme_Sms.h and Irme_SmsTypes.h" */
#if (IRME_SMS_H_SW_MAJOR_VERSION != IRME_SMS_TYPES_H_SW_MAJOR_VERSION)
    #error "Software Major Version Number mismatch between Irme_Sms.h and Irme_SmsTypes.h"
#endif
/* Make sure the software minor version number is the same between Irme_Sms.h and Irme_SmsTypes.h" */
#if (IRME_SMS_H_SW_MINOR_VERSION != IRME_SMS_TYPES_H_SW_MINOR_VERSION)
    #error "Software Minor Version Number mismatch between Irme_Sms.h and Irme_SmsTypes.h"
#endif
/* Make sure the software patch version number is the same between Irme_Sms.h and Irme_SmsTypes.h" */
#if (IRME_SMS_H_SW_PATCH_VERSION != IRME_SMS_TYPES_H_SW_PATCH_VERSION)
    #error "Software Patch Version Number mismatch between Irme_Sms.h and Irme_SmsTypes.h"
#endif

/***********************************************************************************************************
                                            MACRO DEFINITION
************************************************************************************************************/
/** @defgroup IRME_Macros
  @{
*/

#define IRME_SMS_NO_ERR             (0UL)

/**@} end of group IRME_Macros */

/**********************************************************************************************************************
                                             GLOBAL VARIABLE
***********************************************************************************************************************/
#define IRME_START_SEC_VAR_INIT_UNSPECIFIED
#include "Irme_MemMap.h"

/** @defgroup IRME_Variable
  @{
*/

/** The configuration data of the Irme module */
extern P2CONST(Irme_SmsConfigType, AUTOMATIC, IRME_APPL_CONST) g_smsConfigPtr;

/**@} end of group IRME_Variable */

#define  IRME_STOP_SEC_VAR_INIT_UNSPECIFIED
#include "Irme_MemMap.h"

#define  IRME_START_SEC_CONST_UNSPECIFIED
#include "Irme_MemMap.h"

/** @defgroup IRME_Variable
  @{
*/

/** The bit position array of the faults(CORTEX_M4 only) */
extern CONST(uint32,IRME_CONST) g_irmeSmsStatBitPosition[IRME_FAULTS_TOTAL_COUNT];

/**@} end of group IRME_Variable */

#define  IRME_STOP_SEC_CONST_UNSPECIFIED
#include "Irme_MemMap.h"
/**********************************************************************************************************************
                                        FUNCTION DECLARATION
***********************************************************************************************************************/
#define IRME_START_SEC_CODE
#include "Irme_MemMap.h"

/** @defgroup IRME_Fuctions
  @{
*/

FUNC(boolean, IRME_CODE) Irme_Sms_CheckValidFault(VAR(Irme_InjectBitErrType, AUTOMATIC) InjectBitErr);

FUNC(Std_ReturnType, IRME_CODE) Irme_Sms_Init(P2CONST(Irme_SmsConfigType, AUTOMATIC, IRME_APPL_CONST) SmsConfigPtr);

FUNC(Std_ReturnType, IRME_CODE) Irme_Sms_ClearFault(void);

FUNC(void, IRME_CODE) Irme_Sms_InjectFault(VAR(Irme_InjectBitErrType, AUTOMATIC) InjectBitErrType);

FUNC(Std_ReturnType, IRME_CODE) Irme_Sms_GetErrors(VAR(uint32,AUTOMATIC) FaultPool[]);

FUNC(uint32, IRME_CODE) Irme_Sms_GetErrorAddr(void);

/**@} end of group IRME_Fuctions */

#define IRME_STOP_SEC_CODE
#include "Irme_MemMap.h"

#ifdef __cplusplus
}
#endif

#endif

/**@} end of group IRME_Driver */
/**@} end of group G32A10xx_StdPeriphDriver */
