4G/RTD/include/Trgmux_Ip.h

/*==================================================================================================
*   Project              : RTD AUTOSAR 4.4
*   Platform             : CORTEXM
*   Peripheral           : DMA,CACHE,TRGMUX,FLEXIO
*   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.
==================================================================================================*/

/* Prevention from multiple including the same header */
#ifndef TRGMUX_IP_H_
#define TRGMUX_IP_H_

/**
*   @file    Trgmux_Ip.h
*
*   @version 1.0.0
*
*   @brief   AUTOSAR Mcl - Trgmux Ip driver header file.
*   @details
*
*   @addtogroup TRGMUX_IP_DRIVER TRGMUX IP Driver
*   @{
*/

/*==================================================================================================
*                                        INCLUDE FILES
* 1) system and project includes
* 2) needed interfaces from external units
* 3) internal and external interfaces from this unit
==================================================================================================*/
#include "Trgmux_Ip_Cfg.h"

#if (TRGMUX_IP_IS_AVAILABLE == STD_ON)
/*==================================================================================================
*                                 SOURCE FILE VERSION INFORMATION
==================================================================================================*/
#define TRGMUX_IP_VENDOR_ID_H                    43
#define TRGMUX_IP_MODULE_ID_H                    255
#define TRGMUX_IP_AR_RELEASE_MAJOR_VERSION_H     4
#define TRGMUX_IP_AR_RELEASE_MINOR_VERSION_H     4
#define TRGMUX_IP_AR_RELEASE_REVISION_VERSION_H  0
#define TRGMUX_IP_SW_MAJOR_VERSION_H             1
#define TRGMUX_IP_SW_MINOR_VERSION_H             0
#define TRGMUX_IP_SW_PATCH_VERSION_H             0

/**
* @page misra_violations MISRA-C:2012 violations
*/

/*==================================================================================================
                                      FILE VERSION CHECKS
==================================================================================================*/

/* Check if header file and Trgmux_Ip_Cfg.h file are of the same vendor */
#if (TRGMUX_IP_VENDOR_ID_H != TRGMUX_IP_CFG_VENDOR_ID_H)
    #error "Trgmux_Ip.h and Trgmux_Ip_Cfg.h have different vendor ids"
#endif

/* Check if header file and Trgmux_Ip_Cfg.h file are of the same Autosar version */
#if ((TRGMUX_IP_AR_RELEASE_MAJOR_VERSION_H != TRGMUX_IP_CFG_AR_RELEASE_MAJOR_VERSION_H) || \
     (TRGMUX_IP_AR_RELEASE_MINOR_VERSION_H != TRGMUX_IP_CFG_AR_RELEASE_MINOR_VERSION_H) || \
     (TRGMUX_IP_AR_RELEASE_REVISION_VERSION_H != TRGMUX_IP_CFG_AR_RELEASE_REVISION_VERSION_H) \
    )
    #error "AutoSar Version Numbers of Trgmux_Ip.h and Trgmux_Ip_Cfg.h are different"
#endif

/* Check if header file and Trgmux_Ip_Cfg.h file are of the same Software version */
#if ((TRGMUX_IP_SW_MAJOR_VERSION_H != TRGMUX_IP_CFG_SW_MAJOR_VERSION_H) || \
     (TRGMUX_IP_SW_MINOR_VERSION_H != TRGMUX_IP_CFG_SW_MINOR_VERSION_H) || \
     (TRGMUX_IP_SW_PATCH_VERSION_H != TRGMUX_IP_CFG_SW_PATCH_VERSION_H) \
    )
    #error "Software Version Numbers of Trgmux_Ip.h and Trgmux_Ip_Cfg.h are different"
#endif

/*==================================================================================================
*                                        GLOBAL FUNCTION
==================================================================================================*/
#define MCL_START_SEC_CODE
/* @violates @ref Mcl_Dma_h_REF_1 MISRA 2012 Required Directive 4.10, Precautions shall be taken in order to prevent the contents of a header file being included more than once. */
#include "Mcl_MemMap.h"

/**
 * @brief This function initializes the Trgmux Ip Driver.
 * @details This service is a non reentrant function that shall initialize the Trgmux Ip driver.
 *
 * @param[in]  pxTrgmuxInit      Pointer to the initialization structure.
 *
 * @return     TRGMUX_IP_STATUS_LOCKED  The trigger is locked.
 *             TRGMUX_IP_STATUS_SUCCESS      The initialization was successful.
 *
 * @implements Trgmux_Ip_Init_Activity
 * */
Trgmux_Ip_StatusType Trgmux_Ip_Init(const Trgmux_Ip_InitType * const pxTrgmuxInit);

/**
 * @brief This function sets the Trgmux Ip Input.
 * @details This service is a reentrant function that shall set the Trgmux Ip Input.
 *
 * @param[in]  LogicTrigger      The logic trigger id.
 * @param[in]  Input             The input value.
 *
 * @return     TRGMUX_IP_STATUS_LOCKED  The trigger is locked.
 *             TRGMUX_IP_STATUS_SUCCESS      The initialization was successful.
 *
 * @implements Trgmux_Ip_SetInput_Activity
 * */
Trgmux_Ip_StatusType Trgmux_Ip_SetInput(const uint32 LogicTrigger, const uint32 Input);

/**
 * @brief This function locks the Trgmux Ip Trigger.
 * @details This service is a reentrant function that shall lock the Trgmux Ip Trigger.
 *
 * @param[in]  LogicTrigger      The logic trigger id.
 *
 * @return     TRGMUX_IP_STATUS_LOCKED  The trigger is locked.
 *             TRGMUX_IP_STATUS_SUCCESS      The initialization was successful.
 *
 * @implements Trgmux_Ip_SetLock_Activity
 * */
Trgmux_Ip_StatusType Trgmux_Ip_SetLock(const uint32 LogicTrigger);

#define MCL_STOP_SEC_CODE
/* @violates @ref Mcl_Dma_h_REF_1 MISRA 2012 Required Directive 4.10, Precautions shall be taken in order to prevent the contents of a header file being included more than once. */
#include "Mcl_MemMap.h"

#endif /* TRGMUX_IP_IS_AVAILABLE */

/** @} */

#endif  /* #ifndef TRGMUX_IP_H_ */

/*==================================================================================================
 *                                        END OF FILE
==================================================================================================*/