source: asp3_wo_tecs/trunk/arch/arm_m_gcc/stm32f4xx_stm32cube/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_def.h@ 303

Last change on this file since 303 was 303, checked in by ertl-honda, 7 years ago

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