1 /** 2 ****************************************************************************** 3 * @file stm32l4xx_hal_def.h 4 * @author MCD Application Team 5 * @brief This file contains HAL common defines, enumeration, macros and 6 * structures definitions. 7 ****************************************************************************** 8 * @attention 9 * 10 * <h2><center>© Copyright (c) 2017 STMicroelectronics. 11 * All rights reserved.</center></h2> 12 * 13 * This software component is licensed by ST under BSD 3-Clause license, 14 * the "License"; You may not use this file except in compliance with the 15 * License. You may obtain a copy of the License at: 16 * opensource.org/licenses/BSD-3-Clause 17 * 18 ****************************************************************************** 19 */ 20 21 /* Define to prevent recursive inclusion -------------------------------------*/ 22 #ifndef STM32L4xx_HAL_DEF_H 23 #define STM32L4xx_HAL_DEF_H 24 25 #ifdef __cplusplus 26 extern "C" { 27 #endif 28 29 /* Includes ------------------------------------------------------------------*/ 30 #include "stm32l4xx.h" 31 #include "Legacy/stm32_hal_legacy.h" /* Aliases file for old names compatibility */ 32 #include <stddef.h> 33 34 /* Exported types ------------------------------------------------------------*/ 35 36 /** 37 * @brief HAL Status structures definition 38 */ 39 typedef enum 40 { 41 HAL_OK = 0x00, 42 HAL_ERROR = 0x01, 43 HAL_BUSY = 0x02, 44 HAL_TIMEOUT = 0x03 45 } HAL_StatusTypeDef; 46 47 /** 48 * @brief HAL Lock structures definition 49 */ 50 typedef enum 51 { 52 HAL_UNLOCKED = 0x00, 53 HAL_LOCKED = 0x01 54 } HAL_LockTypeDef; 55 56 /* Exported macros -----------------------------------------------------------*/ 57 58 #define UNUSED(X) (void)X /* To avoid gcc/g++ warnings */ 59 60 #define HAL_MAX_DELAY 0xFFFFFFFFU 61 62 #define HAL_IS_BIT_SET(REG, BIT) (((REG) & (BIT)) == (BIT)) 63 #define HAL_IS_BIT_CLR(REG, BIT) (((REG) & (BIT)) == 0U) 64 65 #define __HAL_LINKDMA(__HANDLE__, __PPP_DMA_FIELD__, __DMA_HANDLE__) \ 66 do{ \ 67 (__HANDLE__)->__PPP_DMA_FIELD__ = &(__DMA_HANDLE__); \ 68 (__DMA_HANDLE__).Parent = (__HANDLE__); \ 69 } while(0) 70 71 /** @brief Reset the Handle's State field. 72 * @param __HANDLE__: specifies the Peripheral Handle. 73 * @note This macro can be used for the following purpose: 74 * - When the Handle is declared as local variable; before passing it as parameter 75 * to HAL_PPP_Init() for the first time, it is mandatory to use this macro 76 * to set to 0 the Handle's "State" field. 77 * Otherwise, "State" field may have any random value and the first time the function 78 * HAL_PPP_Init() is called, the low level hardware initialization will be missed 79 * (i.e. HAL_PPP_MspInit() will not be executed). 80 * - When there is a need to reconfigure the low level hardware: instead of calling 81 * HAL_PPP_DeInit() then HAL_PPP_Init(), user can make a call to this macro then HAL_PPP_Init(). 82 * In this later function, when the Handle's "State" field is set to 0, it will execute the function 83 * HAL_PPP_MspInit() which will reconfigure the low level hardware. 84 * @retval None 85 */ 86 #define __HAL_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = 0) 87 88 #if (USE_RTOS == 1) 89 /* Reserved for future use */ 90 #error " USE_RTOS should be 0 in the current HAL release " 91 #else 92 #define __HAL_LOCK(__HANDLE__) \ 93 do{ \ 94 if((__HANDLE__)->Lock == HAL_LOCKED) \ 95 { \ 96 return HAL_BUSY; \ 97 } \ 98 else \ 99 { \ 100 (__HANDLE__)->Lock = HAL_LOCKED; \ 101 } \ 102 }while (0) 103 104 #define __HAL_UNLOCK(__HANDLE__) \ 105 do{ \ 106 (__HANDLE__)->Lock = HAL_UNLOCKED; \ 107 }while (0) 108 #endif /* USE_RTOS */ 109 110 111 #if defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050) /* ARM Compiler V6 */ 112 #ifndef __weak 113 #define __weak __attribute__((weak)) 114 #endif 115 #ifndef __packed 116 #define __packed __attribute__((packed)) 117 #endif 118 #elif defined ( __GNUC__ ) && !defined (__CC_ARM) /* GNU Compiler */ 119 #ifndef __weak 120 #define __weak __attribute__((weak)) 121 #endif /* __weak */ 122 #ifndef __packed 123 #define __packed __attribute__((__packed__)) 124 #endif /* __packed */ 125 #endif /* __GNUC__ */ 126 127 128 /* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used instead */ 129 #if defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050) /* ARM Compiler V6 */ 130 #ifndef __ALIGN_BEGIN 131 #define __ALIGN_BEGIN 132 #endif 133 #ifndef __ALIGN_END 134 #define __ALIGN_END __attribute__ ((aligned (4))) 135 #endif 136 #elif defined ( __GNUC__ ) && !defined (__CC_ARM) /* GNU Compiler */ 137 #ifndef __ALIGN_END 138 #define __ALIGN_END __attribute__ ((aligned (4))) 139 #endif /* __ALIGN_END */ 140 #ifndef __ALIGN_BEGIN 141 #define __ALIGN_BEGIN 142 #endif /* __ALIGN_BEGIN */ 143 #else 144 #ifndef __ALIGN_END 145 #define __ALIGN_END 146 #endif /* __ALIGN_END */ 147 #ifndef __ALIGN_BEGIN 148 #if defined (__CC_ARM) /* ARM Compiler V5 */ 149 #define __ALIGN_BEGIN __align(4) 150 #elif defined (__ICCARM__) /* IAR Compiler */ 151 #define __ALIGN_BEGIN 152 #endif /* __CC_ARM */ 153 #endif /* __ALIGN_BEGIN */ 154 #endif /* __GNUC__ */ 155 156 /** 157 * @brief __RAM_FUNC definition 158 */ 159 #if defined ( __CC_ARM ) || (defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050)) 160 /* ARM Compiler V4/V5 and V6 161 -------------------------- 162 RAM functions are defined using the toolchain options. 163 Functions that are executed in RAM should reside in a separate source module. 164 Using the 'Options for File' dialog you can simply change the 'Code / Const' 165 area of a module to a memory space in physical RAM. 166 Available memory areas are declared in the 'Target' tab of the 'Options for Target' 167 dialog. 168 */ 169 #define __RAM_FUNC 170 171 #elif defined ( __ICCARM__ ) 172 /* ICCARM Compiler 173 --------------- 174 RAM functions are defined using a specific toolchain keyword "__ramfunc". 175 */ 176 #define __RAM_FUNC __ramfunc 177 178 #elif defined ( __GNUC__ ) 179 /* GNU Compiler 180 ------------ 181 RAM functions are defined using a specific toolchain attribute 182 "__attribute__((section(".RamFunc")))". 183 */ 184 #define __RAM_FUNC __attribute__((section(".RamFunc"))) 185 186 #endif 187 188 /** 189 * @brief __NOINLINE definition 190 */ 191 #if defined ( __CC_ARM ) || (defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050)) || defined ( __GNUC__ ) 192 /* ARM V4/V5 and V6 & GNU Compiler 193 ------------------------------- 194 */ 195 #define __NOINLINE __attribute__ ( (noinline) ) 196 197 #elif defined ( __ICCARM__ ) 198 /* ICCARM Compiler 199 --------------- 200 */ 201 #define __NOINLINE _Pragma("optimize = no_inline") 202 203 #endif 204 205 206 #ifdef __cplusplus 207 } 208 #endif 209 210 #endif /* STM32L4xx_HAL_DEF_H */ 211 212 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 213