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