1 /** 2 ****************************************************************************** 3 * @file stm32u5xx_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 * Copyright (c) 2021 STMicroelectronics. 11 * All rights reserved. 12 * 13 * This software is licensed under terms that can be found in the LICENSE file 14 * in the root directory of this software component. 15 * If no LICENSE file comes with this software, it is provided AS-IS. 16 * 17 ****************************************************************************** 18 */ 19 20 /* Define to prevent recursive inclusion -------------------------------------*/ 21 #ifndef __STM32U5xx_HAL_DEF 22 #define __STM32U5xx_HAL_DEF 23 24 #ifdef __cplusplus 25 extern "C" { 26 #endif 27 28 /* Includes ------------------------------------------------------------------*/ 29 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U) 30 #include <arm_cmse.h> 31 #endif /* __ARM_FEATURE_CMSE */ 32 33 #include "stm32u5xx.h" 34 #include "Legacy/stm32_hal_legacy.h" /* Aliases file for old names compatibility */ 35 #include <stddef.h> 36 #include <math.h> 37 38 /* Exported types ------------------------------------------------------------*/ 39 40 /** 41 * @brief HAL Status structures definition 42 */ 43 typedef enum 44 { 45 HAL_OK = 0x00, 46 HAL_ERROR = 0x01, 47 HAL_BUSY = 0x02, 48 HAL_TIMEOUT = 0x03 49 } HAL_StatusTypeDef; 50 51 /** 52 * @brief HAL Lock structures definition 53 */ 54 typedef enum 55 { 56 HAL_UNLOCKED = 0x00, 57 HAL_LOCKED = 0x01 58 } HAL_LockTypeDef; 59 60 /* Exported macros -----------------------------------------------------------*/ 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 #if !defined(UNUSED) 74 #define UNUSED(X) (void)X /* To avoid gcc/g++ warnings */ 75 #endif /* UNUSED */ 76 77 /** @brief Reset the Handle's State field. 78 * @param __HANDLE__: specifies the Peripheral Handle. 79 * @note This macro can be used for the following purpose: 80 * - When the Handle is declared as local variable; before passing it as parameter 81 * to HAL_PPP_Init() for the first time, it is mandatory to use this macro 82 * to set to 0 the Handle's "State" field. 83 * Otherwise, "State" field may have any random value and the first time the function 84 * HAL_PPP_Init() is called, the low level hardware initialization will be missed 85 * (i.e. HAL_PPP_MspInit() will not be executed). 86 * - When there is a need to reconfigure the low level hardware: instead of calling 87 * HAL_PPP_DeInit() then HAL_PPP_Init(), user can make a call to this macro then HAL_PPP_Init(). 88 * In this later function, when the Handle's "State" field is set to 0, it will execute the function 89 * HAL_PPP_MspInit() which will reconfigure the low level hardware. 90 * @retval None 91 */ 92 #define __HAL_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = 0) 93 94 #if (USE_RTOS == 1) 95 /* Reserved for future use */ 96 #error " USE_RTOS should be 0 in the current HAL release " 97 #else 98 #define __HAL_LOCK(__HANDLE__) \ 99 do{ \ 100 if((__HANDLE__)->Lock == HAL_LOCKED) \ 101 { \ 102 return HAL_BUSY; \ 103 } \ 104 else \ 105 { \ 106 (__HANDLE__)->Lock = HAL_LOCKED; \ 107 } \ 108 }while (0) 109 110 #define __HAL_UNLOCK(__HANDLE__) \ 111 do{ \ 112 (__HANDLE__)->Lock = HAL_UNLOCKED; \ 113 }while (0) 114 #endif /* USE_RTOS */ 115 116 #if defined ( __GNUC__ ) 117 #ifndef __weak 118 #define __weak __attribute__((weak)) 119 #endif /* __weak */ 120 #ifndef __packed 121 #define __packed __attribute__((__packed__)) 122 #endif /* __packed */ 123 #endif /* __GNUC__ */ 124 125 #if defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050) 126 #ifndef __weak 127 #define __weak __attribute__((weak)) 128 #endif /* __weak */ 129 #ifndef __packed 130 #define __packed __attribute__((packed)) 131 #endif /* __packed */ 132 #endif /* __ARMCC_VERSION */ 133 134 /* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used 135 instead */ 136 #if defined (__GNUC__) /* 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 #elif defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050) 144 #ifndef __ALIGN_END 145 #define __ALIGN_END __ALIGNED(4) 146 #endif /* __ALIGN_END */ 147 #ifndef __ALIGN_BEGIN 148 #define __ALIGN_BEGIN 149 #endif /* __ALIGN_BEGIN */ 150 #else 151 #ifndef __ALIGN_END 152 #define __ALIGN_END 153 #endif /* __ALIGN_END */ 154 #ifndef __ALIGN_BEGIN 155 #if defined (__CC_ARM) /* ARM Compiler */ 156 #define __ALIGN_BEGIN __align(4) 157 #elif defined (__ICCARM__) /* IAR Compiler */ 158 #define __ALIGN_BEGIN 159 #endif /* __CC_ARM */ 160 #endif /* __ALIGN_BEGIN */ 161 #endif /* __GNUC__ */ 162 163 /* Macro to get variable aligned on 32-bytes,needed for cache maintenance purpose */ 164 #if defined (__GNUC__) /* GNU Compiler */ 165 #define ALIGN_32BYTES(buf) buf __attribute__ ((aligned (32))) 166 #elif defined (__ICCARM__) /* IAR Compiler */ 167 #define ALIGN_32BYTES(buf) _Pragma("data_alignment=32") buf 168 #elif defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050) 169 #define ALIGN_32BYTES(buf) __ALIGNED(32) buf 170 #elif defined (__CC_ARM) /* ARM Compiler */ 171 #define ALIGN_32BYTES(buf) __align(32) buf 172 #endif /* __GNUC__ */ 173 174 /** 175 * @brief __RAM_FUNC definition 176 */ 177 #if defined ( __CC_ARM ) || ((__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050)) 178 179 /* ARM Compiler 180 ------------ 181 RAM functions are defined using the toolchain options. 182 Functions that are executed in RAM should reside in a separate source module. 183 Using the 'Options for File' dialog you can simply change the 'Code / Const' 184 area of a module to a memory space in physical RAM. 185 Available memory areas are declared in the 'Target' tab of the 'Options for Target' 186 dialog. 187 */ 188 #define __RAM_FUNC HAL_StatusTypeDef 189 190 #elif defined ( __ICCARM__ ) 191 /* ICCARM Compiler 192 --------------- 193 RAM functions are defined using a specific toolchain keyword "__ramfunc". 194 */ 195 #define __RAM_FUNC __ramfunc HAL_StatusTypeDef 196 197 #elif defined ( __GNUC__ ) 198 /* GNU Compiler 199 ------------ 200 RAM functions are defined using a specific toolchain attribute 201 "__attribute__((section(".RamFunc")))". 202 */ 203 #define __RAM_FUNC HAL_StatusTypeDef __attribute__((section(".RamFunc"))) 204 205 #endif /* __RAM_FUNC */ 206 207 /** 208 * @brief __NOINLINE definition 209 */ 210 #if defined ( __CC_ARM ) || ((__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050)) || defined ( __GNUC__ ) 211 /* ARM & GNUCompiler 212 ---------------- 213 */ 214 #define __NOINLINE __attribute__ ( (noinline) ) 215 216 #elif defined ( __ICCARM__ ) 217 /* ICCARM Compiler 218 --------------- 219 */ 220 #define __NOINLINE _Pragma("optimize = no_inline") 221 222 #endif /* __NOINLINE */ 223 224 225 #ifdef __cplusplus 226 } 227 #endif 228 229 #endif /* ___STM32U5xx_HAL_DEF */ 230
