Mercurial > public > ostc4
comparison Common/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_def.h @ 128:c78bcbd5deda FlipDisplay
Added current STM32 standandard libraries in version independend folder structure
author | Ideenmodellierer |
---|---|
date | Sun, 17 Feb 2019 21:12:22 +0100 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
127:1369f8660eaa | 128:c78bcbd5deda |
---|---|
1 /** | |
2 ****************************************************************************** | |
3 * @file stm32f4xx_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</center></h2> | |
11 * | |
12 * Redistribution and use in source and binary forms, with or without modification, | |
13 * are permitted provided that the following conditions are met: | |
14 * 1. Redistributions of source code must retain the above copyright notice, | |
15 * this list of conditions and the following disclaimer. | |
16 * 2. Redistributions in binary form must reproduce the above copyright notice, | |
17 * this list of conditions and the following disclaimer in the documentation | |
18 * and/or other materials provided with the distribution. | |
19 * 3. Neither the name of STMicroelectronics nor the names of its contributors | |
20 * may be used to endorse or promote products derived from this software | |
21 * without specific prior written permission. | |
22 * | |
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | |
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
29 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | |
30 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | |
31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
33 * | |
34 ****************************************************************************** | |
35 */ | |
36 | |
37 /* Define to prevent recursive inclusion -------------------------------------*/ | |
38 #ifndef __STM32F4xx_HAL_DEF | |
39 #define __STM32F4xx_HAL_DEF | |
40 | |
41 #ifdef __cplusplus | |
42 extern "C" { | |
43 #endif | |
44 | |
45 /* Includes ------------------------------------------------------------------*/ | |
46 #include "stm32f4xx.h" | |
47 #include "Legacy/stm32_hal_legacy.h" | |
48 #include <stdio.h> | |
49 | |
50 /* Exported types ------------------------------------------------------------*/ | |
51 | |
52 /** | |
53 * @brief HAL Status structures definition | |
54 */ | |
55 typedef enum | |
56 { | |
57 HAL_OK = 0x00U, | |
58 HAL_ERROR = 0x01U, | |
59 HAL_BUSY = 0x02U, | |
60 HAL_TIMEOUT = 0x03U | |
61 } HAL_StatusTypeDef; | |
62 | |
63 /** | |
64 * @brief HAL Lock structures definition | |
65 */ | |
66 typedef enum | |
67 { | |
68 HAL_UNLOCKED = 0x00U, | |
69 HAL_LOCKED = 0x01U | |
70 } HAL_LockTypeDef; | |
71 | |
72 /* Exported macro ------------------------------------------------------------*/ | |
73 | |
74 #define UNUSED(X) (void)X /* To avoid gcc/g++ warnings */ | |
75 | |
76 #define HAL_MAX_DELAY 0xFFFFFFFFU | |
77 | |
78 #define HAL_IS_BIT_SET(REG, BIT) (((REG) & (BIT)) != RESET) | |
79 #define HAL_IS_BIT_CLR(REG, BIT) (((REG) & (BIT)) == RESET) | |
80 | |
81 #define __HAL_LINKDMA(__HANDLE__, __PPP_DMA_FIELD__, __DMA_HANDLE__) \ | |
82 do{ \ | |
83 (__HANDLE__)->__PPP_DMA_FIELD__ = &(__DMA_HANDLE__); \ | |
84 (__DMA_HANDLE__).Parent = (__HANDLE__); \ | |
85 } while(0U) | |
86 | |
87 /** @brief Reset the Handle's State field. | |
88 * @param __HANDLE__ specifies the Peripheral Handle. | |
89 * @note This macro can be used for the following purpose: | |
90 * - When the Handle is declared as local variable; before passing it as parameter | |
91 * to HAL_PPP_Init() for the first time, it is mandatory to use this macro | |
92 * to set to 0 the Handle's "State" field. | |
93 * Otherwise, "State" field may have any random value and the first time the function | |
94 * HAL_PPP_Init() is called, the low level hardware initialization will be missed | |
95 * (i.e. HAL_PPP_MspInit() will not be executed). | |
96 * - When there is a need to reconfigure the low level hardware: instead of calling | |
97 * HAL_PPP_DeInit() then HAL_PPP_Init(), user can make a call to this macro then HAL_PPP_Init(). | |
98 * In this later function, when the Handle's "State" field is set to 0, it will execute the function | |
99 * HAL_PPP_MspInit() which will reconfigure the low level hardware. | |
100 * @retval None | |
101 */ | |
102 #define __HAL_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = 0U) | |
103 | |
104 #if (USE_RTOS == 1U) | |
105 /* Reserved for future use */ | |
106 #error "USE_RTOS should be 0 in the current HAL release" | |
107 #else | |
108 #define __HAL_LOCK(__HANDLE__) \ | |
109 do{ \ | |
110 if((__HANDLE__)->Lock == HAL_LOCKED) \ | |
111 { \ | |
112 return HAL_BUSY; \ | |
113 } \ | |
114 else \ | |
115 { \ | |
116 (__HANDLE__)->Lock = HAL_LOCKED; \ | |
117 } \ | |
118 }while (0U) | |
119 | |
120 #define __HAL_UNLOCK(__HANDLE__) \ | |
121 do{ \ | |
122 (__HANDLE__)->Lock = HAL_UNLOCKED; \ | |
123 }while (0U) | |
124 #endif /* USE_RTOS */ | |
125 | |
126 #if defined ( __GNUC__ ) && !defined (__CC_ARM) /* GNU Compiler */ | |
127 #ifndef __weak | |
128 #define __weak __attribute__((weak)) | |
129 #endif /* __weak */ | |
130 #ifndef __packed | |
131 #define __packed __attribute__((__packed__)) | |
132 #endif /* __packed */ | |
133 #endif /* __GNUC__ */ | |
134 | |
135 | |
136 /* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used instead */ | |
137 #if defined ( __GNUC__ ) && !defined (__CC_ARM) /* GNU Compiler */ | |
138 #ifndef __ALIGN_END | |
139 #define __ALIGN_END __attribute__ ((aligned (4))) | |
140 #endif /* __ALIGN_END */ | |
141 #ifndef __ALIGN_BEGIN | |
142 #define __ALIGN_BEGIN | |
143 #endif /* __ALIGN_BEGIN */ | |
144 #else | |
145 #ifndef __ALIGN_END | |
146 #define __ALIGN_END | |
147 #endif /* __ALIGN_END */ | |
148 #ifndef __ALIGN_BEGIN | |
149 #if defined (__CC_ARM) /* ARM Compiler */ | |
150 #define __ALIGN_BEGIN __align(4) | |
151 #elif defined (__ICCARM__) /* IAR Compiler */ | |
152 #define __ALIGN_BEGIN | |
153 #endif /* __CC_ARM */ | |
154 #endif /* __ALIGN_BEGIN */ | |
155 #endif /* __GNUC__ */ | |
156 | |
157 | |
158 /** | |
159 * @brief __RAM_FUNC definition | |
160 */ | |
161 #if defined ( __CC_ARM ) | |
162 /* ARM Compiler | |
163 ------------ | |
164 RAM functions are defined using the toolchain options. | |
165 Functions that are executed in RAM should reside in a separate source module. | |
166 Using the 'Options for File' dialog you can simply change the 'Code / Const' | |
167 area of a module to a memory space in physical RAM. | |
168 Available memory areas are declared in the 'Target' tab of the 'Options for Target' | |
169 dialog. | |
170 */ | |
171 #define __RAM_FUNC | |
172 | |
173 #elif defined ( __ICCARM__ ) | |
174 /* ICCARM Compiler | |
175 --------------- | |
176 RAM functions are defined using a specific toolchain keyword "__ramfunc". | |
177 */ | |
178 #define __RAM_FUNC __ramfunc | |
179 | |
180 #elif defined ( __GNUC__ ) | |
181 /* GNU Compiler | |
182 ------------ | |
183 RAM functions are defined using a specific toolchain attribute | |
184 "__attribute__((section(".RamFunc")))". | |
185 */ | |
186 #define __RAM_FUNC __attribute__((section(".RamFunc"))) | |
187 | |
188 #endif | |
189 | |
190 /** | |
191 * @brief __NOINLINE definition | |
192 */ | |
193 #if defined ( __CC_ARM ) || defined ( __GNUC__ ) | |
194 /* ARM & GNUCompiler | |
195 ---------------- | |
196 */ | |
197 #define __NOINLINE __attribute__ ( (noinline) ) | |
198 | |
199 #elif defined ( __ICCARM__ ) | |
200 /* ICCARM Compiler | |
201 --------------- | |
202 */ | |
203 #define __NOINLINE _Pragma("optimize = no_inline") | |
204 | |
205 #endif | |
206 | |
207 #ifdef __cplusplus | |
208 } | |
209 #endif | |
210 | |
211 #endif /* ___STM32F4xx_HAL_DEF */ | |
212 | |
213 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |