Dio_Cfg.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380
  1. /*==================================================================================================
  2. * Project : RTD AUTOSAR 4.4
  3. * Platform : CORTEXM
  4. * Peripheral : GPIO
  5. * Dependencies : none
  6. *
  7. * Autosar Version : 4.4.0
  8. * Autosar Revision : ASR_REL_4_4_REV_0000
  9. * Autosar Conf.Variant :
  10. * SW Version : 1.0.0
  11. * Build Version : S32K1_RTD_1_0_0_HF01_D2109_ASR_REL_4_4_REV_0000_20210907
  12. *
  13. * (c) Copyright 2020-2021 NXP Semiconductors
  14. * All Rights Reserved.
  15. *
  16. * NXP Confidential. This software is owned or controlled by NXP and may only be
  17. * used strictly in accordance with the applicable license terms. By expressly
  18. * accepting such terms or by downloading, installing, activating and/or otherwise
  19. * using the software, you are agreeing that you have read, and that you agree to
  20. * comply with and are bound by, such license terms. If you do not agree to be
  21. * bound by the applicable license terms, then you may not retain, install,
  22. * activate or otherwise use the software.
  23. ==================================================================================================*/
  24. #ifndef DIO_CFG_H
  25. #define DIO_CFG_H
  26. /**
  27. * @file Dio_Cfg.h
  28. * @implements Dio_Cfg.h_Artifact
  29. *
  30. * @defgroup DIO_CFG Dio Cfg
  31. * @{
  32. */
  33. #ifdef __cplusplus
  34. extern "C" {
  35. #endif
  36. /*=================================================================================================
  37. * INCLUDE FILES
  38. * 1) system and project includes
  39. * 2) needed interfaces from external units
  40. * 3) internal and external interfaces from this unit
  41. =================================================================================================*/
  42. #include "StandardTypes.h"
  43. /*=================================================================================================
  44. * SOURCE FILE VERSION INFORMATION
  45. =================================================================================================*/
  46. #define DIO_VENDOR_ID_CFG_H 43
  47. #define DIO_AR_RELEASE_MAJOR_VERSION_CFG_H 4
  48. #define DIO_AR_RELEASE_MINOR_VERSION_CFG_H 4
  49. #define DIO_AR_RELEASE_REVISION_VERSION_CFG_H 0
  50. #define DIO_SW_MAJOR_VERSION_CFG_H 1
  51. #define DIO_SW_MINOR_VERSION_CFG_H 0
  52. #define DIO_SW_PATCH_VERSION_CFG_H 0
  53. /*=================================================================================================
  54. * FILE VERSION CHECKS
  55. =================================================================================================*/
  56. #ifndef DISABLE_MCAL_INTERMODULE_ASR_CHECK
  57. /* StandardTypes.h version check start */
  58. #if ((DIO_AR_RELEASE_MAJOR_VERSION_CFG_H != STD_AR_RELEASE_MAJOR_VERSION) || \
  59. (DIO_AR_RELEASE_MINOR_VERSION_CFG_H != STD_AR_RELEASE_MINOR_VERSION) \
  60. )
  61. #error "AUTOSAR Version Numbers of Dio_Cfg.h and StandardTypes.h are different"
  62. #endif
  63. /* StandardTypes.h version check end */
  64. #endif
  65. /*=================================================================================================
  66. * CONSTANTS
  67. =================================================================================================*/
  68. /**
  69. * @brief Enable or Disable Development Error Detection.
  70. *
  71. * @implements DIO_DEV_ERROR_DETECT_define
  72. */
  73. #define DIO_DEV_ERROR_DETECT (STD_OFF)
  74. /**
  75. * @brief Function @p Dio_GetVersionInfo() enable switch.
  76. *
  77. * @implements DIO_VERSION_INFO_API_define
  78. */
  79. #define DIO_VERSION_INFO_API (STD_OFF)
  80. /**
  81. * @brief Function @p Dio_FlipChannel() enable switch.
  82. */
  83. #define DIO_FLIP_CHANNEL_API (STD_ON)
  84. /**
  85. * @brief Function @p Dio_MaskedWritePort() enable switch.
  86. */
  87. #define DIO_MASKEDWRITEPORT_API (STD_OFF)
  88. /**
  89. * @brief Reversed port functionality enable switch.
  90. *
  91. * @implements DIO_REVERSEPORTBITS_define
  92. */
  93. #define DIO_REVERSEPORTBITS (STD_OFF)
  94. /**
  95. * @brief Undefined pins masking enable switch.
  96. */
  97. #define DIO_READZERO_UNDEFINEDPORTS (STD_OFF)
  98. /**
  99. * @brief The number of partition on the platform.
  100. *
  101. * @note Used for channel, port and channel group validation.
  102. */
  103. /**
  104. * @brief Enable/Disable multiocre function from the driver
  105. */
  106. #define DIO_MULTICORE_ENABLED (STD_OFF)
  107. /**
  108. * @brief Number of implemented ports.
  109. *
  110. * @note Used for channel, port and channel group validation.
  111. */
  112. #define DIO_NUM_PORTS_U16 ((uint16)0x5)
  113. /**
  114. * @brief The number of partition on the port
  115. *
  116. * @note Used for port validation.
  117. */
  118. #define DIO_PORT_PARTITION_U16 ((uint16)5U)
  119. /**
  120. * @brief Number of channels available on the implemented ports.
  121. *
  122. * @note Used for channel validation.
  123. */
  124. #if (STD_ON == DIO_DEV_ERROR_DETECT)
  125. #define DIO_NUM_CHANNELS_U16 ((uint16)139U)
  126. #endif
  127. /**
  128. * @brief The number of partition on the channel.
  129. *
  130. * @note Used for channel validation.
  131. */
  132. #define DIO_CHANNEL_PARTITION_U16 ((uint16)140U)
  133. /**
  134. * @brief Mask representing no available channels on a port.
  135. *
  136. * @note Used for channel validation.
  137. */
  138. #if (STD_ON == DIO_DEV_ERROR_DETECT)
  139. #define DIO_NO_AVAILABLE_CHANNELS_U16 ((Dio_PortLevelType)0x0U)
  140. #endif
  141. /**
  142. * @brief Mask representing the maximum valid offset for a channel group.
  143. *
  144. * @note Used for channel group validation.
  145. */
  146. #if (STD_ON == DIO_DEV_ERROR_DETECT)
  147. #define DIO_MAX_VALID_OFFSET_U8 ((uint8)0x1FU)
  148. #endif
  149. /**
  150. * @brief Enables or disables the access to a hardware register from user mode
  151. * USER_MODE_SOFT_LOCKING: All reads to hw registers will be done via REG_PROT, user mode access
  152. * SUPERVISOR_MODE_SOFT_LOCKING: Locks the access to the registers only for supervisor mode
  153. *
  154. * @note Currently, no register protection mechanism is used for Dio driver.
  155. */
  156. #define DIO_USER_MODE_SOFT_LOCKING (STD_OFF)
  157. /**
  158. * @brief Dio driver Pre-Compile configuration switch.
  159. */
  160. #define DIO_PRECOMPILE_SUPPORT
  161. /**
  162. * @brief Support for User mode.
  163. * If this parameter has been configured to 'STD_ON', the Dio driver code can be executed from both supervisor and user mode.
  164. *
  165. */
  166. #define DIO_ENABLE_USER_MODE_SUPPORT (STD_OFF)
  167. #ifndef MCAL_ENABLE_USER_MODE_SUPPORT
  168. #ifdef DIO_ENABLE_USER_MODE_SUPPORT
  169. #if (STD_ON == DIO_ENABLE_USER_MODE_SUPPORT)
  170. #error MCAL_ENABLE_USER_MODE_SUPPORT is not enabled. For running Dio in user mode the MCAL_ENABLE_USER_MODE_SUPPORT needs to be defined
  171. #endif /* (STD_ON == DIO_ENABLE_USER_MODE_SUPPORT) */
  172. #endif /* ifdef DIO_ENABLE_USER_MODE_SUPPORT*/
  173. #endif /* ifndef MCAL_ENABLE_USER_MODE_SUPPORT */
  174. /*=================================================================================================
  175. * DEFINES AND MACROS
  176. =================================================================================================*/
  177. /**
  178. * @brief Symbolic name for the configuration Dio_ConfigPC.
  179. *
  180. */
  181. #define Dio_ConfigPC (Dio_Config)
  182. /* ========== DioConfig ========== */
  183. /* ---------- DioPort_D ---------- */
  184. /**
  185. * @brief Symbolic name for the port DioPort_D.
  186. *
  187. */
  188. #define DioConf_DioPort_DioPort_D ((uint8)0x03U)
  189. /**
  190. * @brief Symbolic name for the channel PTD16_GPIO_OUT_MCU_WIFI_POW_EN.
  191. *
  192. */
  193. #define DioConf_DioChannel_PTD16_GPIO_OUT_MCU_WIFI_POW_EN ((uint16)0x0070U)
  194. /**
  195. * @brief Symbolic name for the channel PTD15_GPIO_OUT_MCU_WIFI_RESET.
  196. *
  197. */
  198. #define DioConf_DioChannel_PTD15_GPIO_OUT_MCU_WIFI_RESET ((uint16)0x006fU)
  199. /* ---------- DioPort_E ---------- */
  200. /**
  201. * @brief Symbolic name for the port DioPort_E.
  202. *
  203. */
  204. #define DioConf_DioPort_DioPort_E ((uint8)0x04U)
  205. /**
  206. * @brief Symbolic name for the channel PTE9_GPIO_OUT_MCU_BT_POW_EN.
  207. *
  208. */
  209. #define DioConf_DioChannel_PTE9_GPIO_OUT_MCU_BT_POW_EN ((uint16)0x0089U)
  210. /**
  211. * @brief Symbolic name for the channel PTE8_GPIO_OUT_MCU_BT_RESET.
  212. *
  213. */
  214. #define DioConf_DioChannel_PTE8_GPIO_OUT_MCU_BT_RESET ((uint16)0x0088U)
  215. /**
  216. * @brief Symbolic name for the channel PTE7_GPIO_OUT_MCU_BT_MOD.
  217. *
  218. */
  219. #define DioConf_DioChannel_PTE7_GPIO_OUT_MCU_BT_MOD ((uint16)0x0087U)
  220. /*=================================================================================================
  221. * ENUMS
  222. =================================================================================================*/
  223. /*=================================================================================================
  224. * STRUCTURES AND OTHER TYPEDEFS
  225. =================================================================================================*/
  226. /**
  227. * @brief Type of a DIO port representation.
  228. *
  229. * @implements Dio_PortType_typedef
  230. */
  231. typedef uint8 Dio_PortType;
  232. /**
  233. * @brief Type of a DIO channel representation.
  234. *
  235. * @implements Dio_ChannelType_typedef
  236. */
  237. typedef uint16 Dio_ChannelType;
  238. /**
  239. * @brief Type of a DIO port levels representation.
  240. *
  241. * @implements Dio_PortLevelType_typedef
  242. */
  243. typedef uint32 Dio_PortLevelType;
  244. /**
  245. * @brief Type of a DIO channel levels representation.
  246. *
  247. * @implements Dio_LevelType_typedef
  248. */
  249. typedef uint8 Dio_LevelType;
  250. /**
  251. * @brief Type of a DIO channel group representation.
  252. *
  253. * @implements Dio_ChannelGroupType_struct
  254. */
  255. typedef struct
  256. {
  257. Dio_PortType port; /**< @brief Port identifier. */
  258. uint8 u8offset; /**< @brief Bit offset within the port. */
  259. Dio_PortLevelType mask; /**< @brief Group mask. */
  260. } Dio_ChannelGroupType;
  261. /**
  262. * @brief Type of a DIO configuration structure.
  263. *
  264. * @note In this implementation there is no need for a configuration
  265. * structure there is only a dummy field, it is recommended
  266. * to initialize this field to zero.
  267. *
  268. * @implements Dio_ConfigType_struct
  269. */
  270. typedef struct
  271. {
  272. uint8 u8NumChannelGroups; /**< @brief Number of channel groups in configuration */
  273. const Dio_ChannelGroupType * pChannelGroupList; /**< @brief
  274. Pointer to list of channel groups in configuration */
  275. const uint32 * pau32Dio_ChannelToPartitionMap; /**< @brief Pointer to channel to partition mapping */
  276. const uint32 * pau32Dio_PortToPartitionMap; /**< @brief Pointer to port to partition mapping */
  277. } Dio_ConfigType;
  278. /*=================================================================================================
  279. * GLOBAL VARIABLE DECLARATIONS
  280. =================================================================================================*/
  281. #define DIO_START_SEC_CONST_32
  282. #include "Dio_MemMap.h"
  283. /**
  284. * @brief Array containing list of mapping channel for partition
  285. */
  286. extern const uint32 au32Dio_ChannelToPartitionMap[DIO_CHANNEL_PARTITION_U16];
  287. /**
  288. * @brief Array containing list of mapping port for partition
  289. */
  290. extern const uint32 au32Dio_PortToPartitionMap[DIO_PORT_PARTITION_U16];
  291. /**
  292. * @brief Array of bitmaps of output pins available per port
  293. */
  294. extern const Dio_PortLevelType Dio_aAvailablePinsForWrite[DIO_NUM_PORTS_U16];
  295. /**
  296. * @brief Array of bitmaps of input pins available per port
  297. */
  298. extern const Dio_PortLevelType Dio_aAvailablePinsForRead[DIO_NUM_PORTS_U16];
  299. #define DIO_STOP_SEC_CONST_32
  300. #include "Dio_MemMap.h"
  301. /*=================================================================================================
  302. * FUNCTION PROTOTYPES
  303. =================================================================================================*/
  304. #ifdef __cplusplus
  305. }
  306. #endif
  307. #endif /* DIO_CFG_H */
  308. /** @} */