2 ******************************************************************************
3 * @file stm32f1xx_hal_def.h
4 * @author MCD Application Team
6 * @date 15-December-2014
7 * @brief This file contains HAL common defines, enumeration, macros and
8 * structures definitions.
9 ******************************************************************************
12 * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
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.
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.
36 ******************************************************************************
39 /* Define to prevent recursive inclusion -------------------------------------*/
40 #ifndef __STM32F1xx_HAL_DEF
41 #define __STM32F1xx_HAL_DEF
47 /* Includes ------------------------------------------------------------------*/
48 #include "stm32f1xx.h"
49 #include "stm32_hal_legacy.h"
51 /* Exported types ------------------------------------------------------------*/
54 * @brief HAL Status structures definition
65 * @brief HAL Lock structures definition
73 /* Exported macro ------------------------------------------------------------*/
78 #define HAL_MAX_DELAY 0xFFFFFFFF
80 #define HAL_IS_BIT_SET(REG, BIT) (((REG) & (BIT)) != RESET)
81 #define HAL_IS_BIT_CLR(REG, BIT) (((REG) & (BIT)) == RESET)
83 #define __HAL_LINKDMA(__HANDLE__, __PPP_DMA_FIELD_, __DMA_HANDLE_) \
85 (__HANDLE__)->__PPP_DMA_FIELD_ = &(__DMA_HANDLE_); \
86 (__DMA_HANDLE_).Parent = (__HANDLE__); \
89 #define UNUSED(x) ((void)(x))
91 /** @brief Reset the Handle's State field.
92 * @param __HANDLE__: specifies the Peripheral Handle.
93 * @note This macro can be used for the following purpose:
94 * - When the Handle is declared as local variable; before passing it as parameter
95 * to HAL_PPP_Init() for the first time, it is mandatory to use this macro
96 * to set to 0 the Handle's "State" field.
97 * Otherwise, "State" field may have any random value and the first time the function
98 * HAL_PPP_Init() is called, the low level hardware initialization will be missed
99 * (i.e. HAL_PPP_MspInit() will not be executed).
100 * - When there is a need to reconfigure the low level hardware: instead of calling
101 * HAL_PPP_DeInit() then HAL_PPP_Init(), user can make a call to this macro then HAL_PPP_Init().
102 * In this later function, when the Handle's "State" field is set to 0, it will execute the function
103 * HAL_PPP_MspInit() which will reconfigure the low level hardware.
106 #define __HAL_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = 0)
109 #error " USE_RTOS should be 0 in the current HAL release "
111 #define __HAL_LOCK(__HANDLE__) \
113 if((__HANDLE__)->Lock == HAL_LOCKED) \
119 (__HANDLE__)->Lock = HAL_LOCKED; \
123 #define __HAL_UNLOCK(__HANDLE__) \
125 (__HANDLE__)->Lock = HAL_UNLOCKED; \
127 #endif /* USE_RTOS */
129 #if defined ( __GNUC__ )
131 #define __weak __attribute__((weak))
134 #define __packed __attribute__((__packed__))
135 #endif /* __packed */
136 #endif /* __GNUC__ */
139 /* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used instead */
140 #if defined (__GNUC__) /* GNU Compiler */
142 #define __ALIGN_END __attribute__ ((aligned (4)))
143 #endif /* __ALIGN_END */
144 #ifndef __ALIGN_BEGIN
145 #define __ALIGN_BEGIN
146 #endif /* __ALIGN_BEGIN */
150 #endif /* __ALIGN_END */
151 #ifndef __ALIGN_BEGIN
152 #if defined (__CC_ARM) /* ARM Compiler */
153 #define __ALIGN_BEGIN __align(4)
154 #elif defined (__ICCARM__) /* IAR Compiler */
155 #define __ALIGN_BEGIN
156 #endif /* __CC_ARM */
157 #endif /* __ALIGN_BEGIN */
158 #endif /* __GNUC__ */
161 * @brief __RAM_FUNC definition
163 #if defined ( __CC_ARM )
166 RAM functions are defined using the toolchain options.
167 Functions that are executed in RAM should reside in a separate source module.
168 Using the 'Options for File' dialog you can simply change the 'Code / Const'
169 area of a module to a memory space in physical RAM.
170 Available memory areas are declared in the 'Target' tab of the 'Options for Target'
173 #define __RAM_FUNC HAL_StatusTypeDef
175 #elif defined ( __ICCARM__ )
178 RAM functions are defined using a specific toolchain keyword "__ramfunc".
180 #define __RAM_FUNC __ramfunc HAL_StatusTypeDef
182 #elif defined ( __GNUC__ )
185 RAM functions are defined using a specific toolchain attribute
186 "__attribute__((section(".RamFunc")))".
188 #define __RAM_FUNC HAL_StatusTypeDef __attribute__((section(".RamFunc")))
193 * @brief __NOINLINE definition
195 #if defined ( __CC_ARM ) || defined ( __GNUC__ )
199 #define __NOINLINE __attribute__ ( (noinline) )
201 #elif defined ( __ICCARM__ )
205 #define __NOINLINE _Pragma("optimize = no_inline")
214 #endif /* ___STM32F1xx_HAL_DEF */
216 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/