1 /** 2 ****************************************************************************** 3 * @file stm32f3xx_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) 2016 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 __STM32F3xx_HAL_DEF 22 #define __STM32F3xx_HAL_DEF 23 24 #ifdef __cplusplus 25 extern "C" { 26 #endif 27 28 /* Includes ------------------------------------------------------------------*/ 29 #include "stm32f3xx.h" 30 #include "Legacy/stm32_hal_legacy.h" 31 #include <stddef.h> 32 33 /* Exported types ------------------------------------------------------------*/ 34 35 /** 36 * @brief HAL Status structures definition 37 */ 38 typedef enum 39 { 40 HAL_OK = 0x00U, 41 HAL_ERROR = 0x01U, 42 HAL_BUSY = 0x02U, 43 HAL_TIMEOUT = 0x03 44 } HAL_StatusTypeDef; 45 46 /** 47 * @brief HAL Lock structures definition 48 */ 49 typedef enum 50 { 51 HAL_UNLOCKED = 0x00U, 52 HAL_LOCKED = 0x01 53 } HAL_LockTypeDef; 54 55 /* Exported macro ------------------------------------------------------------*/ 56 57 #if !defined(UNUSED) 58 #define UNUSED(X) (void)X /* To avoid gcc/g++ warnings */ 59 #endif /* UNUSED */ 60 61 #define HAL_MAX_DELAY 0xFFFFFFFFU 62 63 #define HAL_IS_BIT_SET(REG, BIT) (((REG) & (BIT)) == BIT) 64 #define HAL_IS_BIT_CLR(REG, BIT) (((REG) & (BIT)) == 0U) 65 66 #define __HAL_LINKDMA(__HANDLE__, __PPP_DMA_FIELD_, __DMA_HANDLE_) \ 67 do{ \ 68 (__HANDLE__)->__PPP_DMA_FIELD_ = &(__DMA_HANDLE_); \ 69 (__DMA_HANDLE_).Parent = (__HANDLE__); \ 70 } while(0U) 71 72 /** @brief Reset the Handle's State field. 73 * @param __HANDLE__ specifies the Peripheral Handle. 74 * @note This macro can be used for the following purpose: 75 * - When the Handle is declared as local variable; before passing it as parameter 76 * to HAL_PPP_Init() for the first time, it is mandatory to use this macro 77 * to set to 0 the Handle's "State" field. 78 * Otherwise, "State" field may have any random value and the first time the function 79 * HAL_PPP_Init() is called, the low level hardware initialization will be missed 80 * (i.e. HAL_PPP_MspInit() will not be executed). 81 * - When there is a need to reconfigure the low level hardware: instead of calling 82 * HAL_PPP_DeInit() then HAL_PPP_Init(), user can make a call to this macro then HAL_PPP_Init(). 83 * In this later function, when the Handle's "State" field is set to 0, it will execute the function 84 * HAL_PPP_MspInit() which will reconfigure the low level hardware. 85 * @retval None 86 */ 87 #define __HAL_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = 0U) 88 89 #if (USE_RTOS == 1U) 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 (0U) 103 104 #define __HAL_UNLOCK(__HANDLE__) \ 105 do{ \ 106 (__HANDLE__)->Lock = HAL_UNLOCKED; \ 107 }while (0U) 108 #endif /* USE_RTOS */ 109 110 #if defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050) /* ARM Compiler V6 */ 111 #ifndef __weak 112 #define __weak __attribute__((weak)) 113 #endif 114 #ifndef __packed 115 #define __packed __attribute__((packed)) 116 #endif 117 #elif defined ( __GNUC__ ) && !defined (__CC_ARM) /* GNU Compiler */ 118 #ifndef __weak 119 #define __weak __attribute__((weak)) 120 #endif /* __weak */ 121 #ifndef __packed 122 #define __packed __attribute__((__packed__)) 123 #endif /* __packed */ 124 #endif /* __GNUC__ */ 125 126 127 /* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used instead */ 128 #if defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050) /* ARM Compiler V6 */ 129 #ifndef __ALIGN_BEGIN 130 #define __ALIGN_BEGIN 131 #endif 132 #ifndef __ALIGN_END 133 #define __ALIGN_END __attribute__ ((aligned (4))) 134 #endif 135 #elif defined ( __GNUC__ ) && !defined (__CC_ARM) /* GNU Compiler */ 136 #ifndef __ALIGN_END 137 #define __ALIGN_END __attribute__ ((aligned (4))) 138 #endif /* __ALIGN_END */ 139 #ifndef __ALIGN_BEGIN 140 #define __ALIGN_BEGIN 141 #endif /* __ALIGN_BEGIN */ 142 #else 143 #ifndef __ALIGN_END 144 #define __ALIGN_END 145 #endif /* __ALIGN_END */ 146 #ifndef __ALIGN_BEGIN 147 #if defined (__CC_ARM) /* ARM Compiler V5*/ 148 #define __ALIGN_BEGIN __align(4) 149 #elif defined (__ICCARM__) /* IAR Compiler */ 150 #define __ALIGN_BEGIN 151 #endif /* __CC_ARM */ 152 #endif /* __ALIGN_BEGIN */ 153 #endif /* __GNUC__ */ 154 155 /** 156 * @brief __NOINLINE definition 157 */ 158 #if defined ( __CC_ARM ) || (defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050)) || defined ( __GNUC__ ) 159 /* ARM V4/V5 and V6 & GNU Compiler 160 ------------------------------- 161 */ 162 #define __NOINLINE __attribute__ ( (noinline) ) 163 164 #elif defined ( __ICCARM__ ) 165 /* ICCARM Compiler 166 --------------- 167 */ 168 #define __NOINLINE _Pragma("optimize = no_inline") 169 170 #endif 171 172 #ifdef __cplusplus 173 } 174 #endif 175 176 #endif /* ___STM32F3xx_HAL_DEF */ 177 178
