1 /* 2 * Copyright 2023 NXP 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef EMIOS_ICU_IP_DEFINES_H 8 #define EMIOS_ICU_IP_DEFINES_H 9 10 /** 11 * @file 12 * @implements Emios_Icu_Ip_Defines.h_Artifact 13 * @addtogroup emios_icu_ip EMIOS IPL 14 * @{ 15 */ 16 17 #ifdef __cplusplus 18 extern "C"{ 19 #endif 20 21 /*================================================================================================== 22 * INCLUDE FILES 23 * 1) system and project includes 24 * 2) needed interfaces from external units 25 * 3) internal and external interfaces from this unit 26 *================================================================================================*/ 27 #include "Std_Types.h" 28 #include "S32K344_EMIOS.h" 29 30 #include <zephyr/devicetree.h> 31 32 #define _PWM_NXP_S32_CAPTURE_USED(node_id) \ 33 COND_CODE_1(DT_ENUM_HAS_VALUE(node_id, pwm_mode, SAIC), (+ 1), (+ 0)) 34 35 #define PWM_NXP_S32_CAPTURE_USED(node_id) \ 36 DT_FOREACH_CHILD_STATUS_OKAY(node_id, _PWM_NXP_S32_CAPTURE_USED) 37 38 /*================================================================================================== 39 * SOURCE FILE VERSION INFORMATION 40 *================================================================================================*/ 41 #define EMIOS_ICU_IP_DEFINES_VENDOR_ID 43 42 #define EMIOS_ICU_IP_DEFINES_AR_RELEASE_MAJOR_VERSION 4 43 #define EMIOS_ICU_IP_DEFINES_AR_RELEASE_MINOR_VERSION 7 44 #define EMIOS_ICU_IP_DEFINES_AR_RELEASE_REVISION_VERSION 0 45 #define EMIOS_ICU_IP_DEFINES_SW_MAJOR_VERSION 3 46 #define EMIOS_ICU_IP_DEFINES_SW_MINOR_VERSION 0 47 #define EMIOS_ICU_IP_DEFINES_SW_PATCH_VERSION 0 48 49 /*================================================================================================== 50 * FILE VERSION CHECKS 51 ==================================================================================================*/ 52 /* Check if header file and Std_Types.h file are of the same Autosar version */ 53 #ifndef DISABLE_MCAL_INTERMODULE_ASR_CHECK 54 #if ((EMIOS_ICU_IP_DEFINES_AR_RELEASE_MAJOR_VERSION != STD_AR_RELEASE_MAJOR_VERSION) || \ 55 (EMIOS_ICU_IP_DEFINES_AR_RELEASE_MINOR_VERSION != STD_AR_RELEASE_MINOR_VERSION)) 56 #error "AutoSar Version Numbers of Emios_Icu_Ip_Defines.h and Std_Types.h are different" 57 #endif 58 #endif 59 60 /*================================================================================================== 61 * CONSTANTS 62 ==================================================================================================*/ 63 64 /*================================================================================================== 65 * DEFINES AND MACROS 66 ==================================================================================================*/ 67 #define EMIOS_ICU_IP_USED (0 || (DT_FOREACH_STATUS_OKAY(nxp_s32_emios_pwm, PWM_NXP_S32_CAPTURE_USED))) 68 69 #if (STD_ON == EMIOS_ICU_IP_USED) 70 71 #define EMIOS_ICU_IP_CHANNEL_24_USED (STD_OFF) 72 /** @brief The number of EMIOS instances available on platform */ 73 #define EMIOS_ICU_IP_INSTANCE_COUNT (3U) 74 75 /** @brief The number of channels available on each EMIOS instance */ 76 #define EMIOS_ICU_IP_NUM_OF_CHANNELS (24U) 77 78 /** @brief The number of eMios channels are used in configuration */ 79 #define EMIOS_ICU_IP_NUM_OF_CHANNELS_USED 0 DT_FOREACH_STATUS_OKAY(nxp_s32_emios_pwm, PWM_NXP_S32_CAPTURE_USED) 80 81 #define EMIOS_ICU_IP_CHANNEL_NOT_USED ((uint8)0xFF) 82 83 #define EMIOS_ICU_IP_MASTERBUS_CHANNEL_USED ((uint8)0xFE) 84 85 /** @brief Switches the Development Error Detection and Notification on or off. */ 86 #define EMIOS_ICU_IP_DEV_ERROR_DETECT (STD_OFF) 87 #define EMIOS_ICU_IP_VALIDATE_GLOBAL_CALL (EMIOS_ICU_IP_DEV_ERROR_DETECT) 88 89 90 /** @brief Adds or removes all services related to the timestamp functionality. */ 91 #define EMIOS_ICU_IP_TIMESTAMP_API (STD_ON) 92 /** @brief Adds or removes all services related to the edge detect functionality. */ 93 #define EMIOS_ICU_IP_EDGE_DETECT_API (STD_OFF) 94 /** @brief Adds or removes all services related to the signal mesurement functionality. */ 95 #define EMIOS_ICU_IP_SIGNAL_MEASUREMENT_API (STD_OFF) 96 /** @brief Adds or removes all services related to the input level. */ 97 #define EMIOS_ICU_IP_GET_INPUT_LEVEL_API (STD_ON) 98 /** @brief Adds or removes all services related to the deinitialization functionality. */ 99 #define EMIOS_ICU_IP_DEINIT_API (STD_OFF) 100 /** @brief Adds or removes all services related to edge count functionality. */ 101 #define EMIOS_ICU_IP_EDGE_COUNT_API (STD_OFF) 102 103 #define EMIOS_ICU_IP_CAPTURERGISTER_API (STD_OFF) 104 105 /** @brief Adds or Removes the code related to overflow notification */ 106 #define EMIOS_ICU_IP_OVERFLOW_NOTIFICATION_API (STD_OFF) 107 108 /** @brief define SAIC mode if any channels not supporting IPWM or IPM mode is configured. */ 109 #define EMIOS_ICU_IP_SIGNAL_MEASUREMENT_USES_SAIC_MODE (STD_OFF) 110 111 /** @brief Adds or removes the service set Max Counter for eMios. */ 112 #define EMIOS_ICU_IP_SET_MAX_COUNTER (STD_OFF) 113 114 /** @brief Adds or removes the service set Initial Counter for eMios. */ 115 #define EMIOS_ICU_IP_SET_INITIAL_COUNTER (STD_OFF) 116 117 /** @brief Adds or removes all services related to mode set functionality. */ 118 #define EMIOS_ICU_IP_SET_MODE_API (STD_OFF) 119 120 /** @brief Adds or removes all services related to input state functionality. */ 121 #define EMIOS_ICU_IP_GET_INPUT_STATE_API (STD_OFF) 122 123 /** @brief Adds or removes all services related to dual clock edge functionality. */ 124 #define EMIOS_ICU_IP_DUAL_CLOCK_MODE_API (STD_OFF) 125 126 /** @brief Adds or removes the support measurement with DMA. */ 127 #define EMIOS_ICU_IP_SIGNALMEASUREMENT_USES_DMA (STD_OFF) 128 #define EMIOS_ICU_IP_TIMESTAMP_USES_DMA (STD_OFF) 129 130 /** @brief Adds or removes the support measurement with DMA in IPL */ 131 #define EMIOS_ICU_IP_SIGNALMEASUREMENT_USES_DMA_IPL (STD_OFF) 132 #define EMIOS_ICU_IP_DMA_MAJORLOOP_COUNT (2U) 133 #define EMIOS_ICU_IP_TIMESTAMP_USES_DMA_IPL (STD_OFF) 134 135 #define EMIOS_ICU_IP_GET_PULSE_WIDTH_API (STD_OFF) 136 /** @brief Support for User mode. 137 * If this parameter has been configured to STD_ON, the EMIOS driver code 138 * can be executed from both supervisor and user mode. */ 139 #define EMIOS_ICU_IP_ENABLE_USER_MODE_SUPPORT (STD_OFF) 140 141 /* Verification for user mode support. */ 142 #ifndef MCAL_ENABLE_USER_MODE_SUPPORT 143 #if (defined (EMIOS_ICU_IP_ENABLE_USER_MODE_SUPPORT) && (STD_ON == EMIOS_ICU_IP_ENABLE_USER_MODE_SUPPORT)) 144 #error MCAL_ENABLE_USER_MODE_SUPPORT is not enabled. For running Icu in user mode the MCAL_ENABLE_USER_MODE_SUPPORT needs to be defined 145 #endif 146 #endif 147 148 #define EMIOS_ICU_USES_MCL_DRIVER (STD_ON) 149 150 #if ((EMIOS_ICU_IP_EDGE_COUNT_API == STD_ON) || (EMIOS_ICU_IP_SIGNAL_MEASUREMENT_API == STD_ON) || (EMIOS_ICU_IP_TIMESTAMP_API == STD_ON)) 151 #define EMIOS_ICU_IP_COUNTER_MASK ((uint32)65535) 152 #endif 153 #define EMIOS_ICU_IP_INITIAL_INDEX_OF_CHANNELS \ 154 { \ 155 {0U, 1U, 2U, 3U, 4U, 5U, 6U, 7U, 8U, 9U, 10U, 11U, 12U, 13U, 14U, 15U, 16U, 17U, 18U, 19U, 20U, 21U, 22U, 255U}, \ 156 {23U, 24U, 25U, 26U, 27U, 28U, 29U, 30U, 31U, 32U, 33U, 34U, 35U, 36U, 37U, 38U, 39U, 40U, 41U, 42U, 43U, 44U, 45U, 255U}, \ 157 {46U, 47U, 48U, 49U, 50U, 51U, 52U, 53U, 54U, 55U, 56U, 57U, 58U, 59U, 60U, 61U, 62U, 63U, 64U, 65U, 66U, 67U, 68U, 255U} \ 158 } \ 159 160 161 /*================================================================================================== 162 * ENUMS 163 ==================================================================================================*/ 164 165 /*================================================================================================== 166 * STRUCTURES AND OTHER TYPEDEFS 167 ==================================================================================================*/ 168 /** 169 * @brief Implementation specific. This type shall be chosen in order to have the most efficient 170 * implementation on a specific microcontroller platform. 171 * Range: 0 to width of the timer register. 172 * Description: Width of the buffer for timestamp ticks and measured elapsed timeticks 173 */ 174 typedef uint32 eMios_Icu_ValueType; 175 /*================================================================================================== 176 * GLOBAL VARIABLE DECLARATIONS 177 ==================================================================================================*/ 178 179 /*================================================================================================== 180 * FUNCTION PROTOTYPES 181 ==================================================================================================*/ 182 183 #endif /* EMIOS_ICU_IP_USED */ 184 185 #ifdef __cplusplus 186 } 187 #endif 188 189 /** @} */ 190 191 #endif /* EMIOS_ICU_IP_DEFINES_H */ 192 193
