1 /** 2 ****************************************************************************** 3 * @file stm32l1xx_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 __STM32L1xx_HAL_DEF 23 #define __STM32L1xx_HAL_DEF 24 25 #ifdef __cplusplus 26 extern "C" { 27 #endif 28 29 /* Includes ------------------------------------------------------------------*/ 30 #include "stm32l1xx.h" 31 #include "Legacy/stm32_hal_legacy.h" 32 #include <stddef.h> 33 34 /* Exported types ------------------------------------------------------------*/ 35 36 /** 37 * @brief HAL Status structures definition 38 */ 39 typedef enum 40 { 41 HAL_OK = 0x00U, 42 HAL_ERROR = 0x01U, 43 HAL_BUSY = 0x02U, 44 HAL_TIMEOUT = 0x03U 45 } HAL_StatusTypeDef; 46 47 /** 48 * @brief HAL Lock structures definition 49 */ 50 typedef enum 51 { 52 HAL_UNLOCKED = 0x00U, 53 HAL_LOCKED = 0x01U 54 } HAL_LockTypeDef; 55 56 /* Exported macro ------------------------------------------------------------*/ 57 58 #ifndef UNUSED 59 #define UNUSED(X) (void)X /* To avoid gcc/g++ warnings */ 60 #endif 61 62 #define HAL_MAX_DELAY 0xFFFFFFFFU 63 64 #define HAL_IS_BIT_SET(REG, BIT) (((REG) & (BIT)) == (BIT)) 65 #define HAL_IS_BIT_CLR(REG, BIT) (((REG) & (BIT)) == 0U) 66 67 #define __HAL_LINKDMA(__HANDLE__, __PPP_DMA_FIELD_, __DMA_HANDLE_) \ 68 do{ \ 69 (__HANDLE__)->__PPP_DMA_FIELD_ = &(__DMA_HANDLE_); \ 70 (__DMA_HANDLE_).Parent = (__HANDLE__); \ 71 } while(0) 72 73 /** @brief Reset the Handle's State field. 74 * @param __HANDLE__: specifies the Peripheral Handle. 75 * @note This macro can be used for the following purpose: 76 * - When the Handle is declared as local variable; before passing it as parameter 77 * to HAL_PPP_Init() for the first time, it is mandatory to use this macro 78 * to set to 0 the Handle's "State" field. 79 * Otherwise, "State" field may have any random value and the first time the function 80 * HAL_PPP_Init() is called, the low level hardware initialization will be missed 81 * (i.e. HAL_PPP_MspInit() will not be executed). 82 * - When there is a need to reconfigure the low level hardware: instead of calling 83 * HAL_PPP_DeInit() then HAL_PPP_Init(), user can make a call to this macro then HAL_PPP_Init(). 84 * In this later function, when the Handle's "State" field is set to 0, it will execute the function 85 * HAL_PPP_MspInit() which will reconfigure the low level hardware. 86 * @retval None 87 */ 88 #define __HAL_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = 0U) 89 90 #if (USE_RTOS == 1) 91 92 /* Reserved for future use */ 93 #error "USE_RTOS should be 0 in the current HAL release" 94 95 #else 96 #define __HAL_LOCK(__HANDLE__) \ 97 do{ \ 98 if((__HANDLE__)->Lock == HAL_LOCKED) \ 99 { \ 100 return HAL_BUSY; \ 101 } \ 102 else \ 103 { \ 104 (__HANDLE__)->Lock = HAL_LOCKED; \ 105 } \ 106 }while (0) 107 108 #define __HAL_UNLOCK(__HANDLE__) \ 109 do{ \ 110 (__HANDLE__)->Lock = HAL_UNLOCKED; \ 111 }while (0) 112 #endif /* USE_RTOS */ 113 114 #if defined ( __GNUC__ ) && !defined (__CC_ARM) /* GNU Compiler */ 115 #ifndef __weak 116 #define __weak __attribute__((weak)) 117 #endif /* __weak */ 118 #ifndef __packed 119 #define __packed __attribute__((__packed__)) 120 #endif /* __packed */ 121 #endif /* __GNUC__ */ 122 123 124 /* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used instead */ 125 #if defined (__GNUC__) && !defined (__CC_ARM) /* GNU Compiler */ 126 #ifndef __ALIGN_END 127 #define __ALIGN_END __attribute__ ((aligned (4))) 128 #endif /* __ALIGN_END */ 129 #ifndef __ALIGN_BEGIN 130 #define __ALIGN_BEGIN 131 #endif /* __ALIGN_BEGIN */ 132 #else 133 #ifndef __ALIGN_END 134 #define __ALIGN_END 135 #endif /* __ALIGN_END */ 136 #ifndef __ALIGN_BEGIN 137 #if defined (__CC_ARM) /* ARM Compiler */ 138 #define __ALIGN_BEGIN __align(4) 139 #elif defined (__ICCARM__) /* IAR Compiler */ 140 #define __ALIGN_BEGIN 141 #endif /* __CC_ARM */ 142 #endif /* __ALIGN_BEGIN */ 143 #endif /* __GNUC__ */ 144 145 /** 146 * @brief __RAM_FUNC definition 147 */ 148 #if defined ( __CC_ARM ) 149 /* ARM Compiler 150 ------------ 151 RAM functions are defined using the toolchain options. 152 Functions that are executed in RAM should reside in a separate source module. 153 Using the 'Options for File' dialog you can simply change the 'Code / Const' 154 area of a module to a memory space in physical RAM. 155 Available memory areas are declared in the 'Target' tab of the 'Options for Target' 156 dialog. 157 */ 158 #define __RAM_FUNC 159 160 #elif defined ( __ICCARM__ ) 161 /* ICCARM Compiler 162 --------------- 163 RAM functions are defined using a specific toolchain keyword "__ramfunc". 164 */ 165 #define __RAM_FUNC __ramfunc 166 167 #elif defined ( __GNUC__ ) 168 /* GNU Compiler 169 ------------ 170 RAM functions are defined using a specific toolchain attribute 171 "__attribute__((section(".RamFunc")))". 172 */ 173 #define __RAM_FUNC __attribute__((section(".RamFunc"))) 174 175 #endif 176 177 /** 178 * @brief __NOINLINE definition 179 */ 180 #if defined ( __CC_ARM ) || defined ( __GNUC__ ) 181 /* ARM & GNUCompiler 182 ---------------- 183 */ 184 #define __NOINLINE __attribute__ ( (noinline) ) 185 186 #elif defined ( __ICCARM__ ) 187 /* ICCARM Compiler 188 --------------- 189 */ 190 #define __NOINLINE _Pragma("optimize = no_inline") 191 192 #endif 193 194 #ifdef __cplusplus 195 } 196 #endif 197 198 #endif /* ___STM32L1xx_HAL_DEF */ 199 200 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 201
