source: trunk/firmware/Drivers/STM32G0xx_HAL_Driver/Inc/stm32g0xx_hal_def.h

Last change on this file was 6, checked in by f.jahn, 8 months ago
File size: 7.7 KB
Line 
1/**
2 ******************************************************************************
3 * @file stm32g0xx_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) 2018 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 STM32G0xx_HAL_DEF
22#define STM32G0xx_HAL_DEF
23
24#ifdef __cplusplus
25extern "C" {
26#endif
27
28/* Includes ------------------------------------------------------------------*/
29#include "stm32g0xx.h"
30#include "Legacy/stm32_hal_legacy.h" /* Aliases file for old names compatibility */
31#include <stddef.h>
32
33/* Exported types ------------------------------------------------------------*/
34
35/**
36 * @brief HAL Status structures definition
37 */
38typedef enum
39{
40 HAL_OK = 0x00U,
41 HAL_ERROR = 0x01U,
42 HAL_BUSY = 0x02U,
43 HAL_TIMEOUT = 0x03U
44} HAL_StatusTypeDef;
45
46/**
47 * @brief HAL Lock structures definition
48 */
49typedef enum
50{
51 HAL_UNLOCKED = 0x00U,
52 HAL_LOCKED = 0x01U
53} HAL_LockTypeDef;
54
55/* Exported macros -----------------------------------------------------------*/
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 Handles 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 Handles "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 Handles "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/* Reserved for future use */
91#error " USE_RTOS should be 0 in the current HAL release "
92#else
93#define __HAL_LOCK(__HANDLE__) \
94 do{ \
95 if((__HANDLE__)->Lock == HAL_LOCKED) \
96 { \
97 return HAL_BUSY; \
98 } \
99 else \
100 { \
101 (__HANDLE__)->Lock = HAL_LOCKED; \
102 } \
103 }while (0U)
104
105#define __HAL_UNLOCK(__HANDLE__) \
106 do{ \
107 (__HANDLE__)->Lock = HAL_UNLOCKED; \
108 }while (0U)
109#endif /* USE_RTOS */
110
111#if defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050)
112 #ifndef __weak
113 #define __weak __attribute__((weak))
114 #endif /* __weak */
115 #ifndef __packed
116 #define __packed __attribute__((packed))
117 #endif /* __packed */
118#elif defined ( __GNUC__ ) && !defined (__CC_ARM) /* GNU Compiler */
119#ifndef __weak
120#define __weak __attribute__((weak))
121#endif /* __weak */
122#ifndef __packed
123#define __packed __attribute__((__packed__))
124#endif /* __packed */
125#endif /* __GNUC__ */
126
127
128/* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used instead */
129/* GNU Compiler */
130#if defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050) /* ARM Compiler V6 */
131 #ifndef __ALIGN_BEGIN
132 #define __ALIGN_BEGIN
133 #endif /* __ALIGN_BEGIN */
134 #ifndef __ALIGN_END
135 #define __ALIGN_END __attribute__ ((aligned (4)))
136 #endif /* __ALIGN_END */
137#elif defined (__GNUC__) && !defined (__CC_ARM) /* GNU Compiler */
138#ifndef __ALIGN_END
139#define __ALIGN_END __attribute__ ((aligned (4U)))
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/* ARM Compiler */
150#if defined (__CC_ARM) /* ARM Compiler V5 */
151#define __ALIGN_BEGIN __align(4U)
152/* IAR Compiler */
153#elif defined (__ICCARM__)
154#define __ALIGN_BEGIN
155#endif /* __CC_ARM */
156#endif /* __ALIGN_BEGIN */
157#endif /* __GNUC__ */
158
159/**
160 * @brief __RAM_FUNC definition
161 */
162#if defined ( __CC_ARM ) || (defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050))
163/* ARM Compiler V4/V5 and V6
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
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
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 __attribute__((section(".RamFunc")))
188
189#endif /* __CC_ARM || __ARMCC_VERSION */
190
191/**
192 * @brief __NOINLINE definition
193 */
194#if defined ( __CC_ARM ) || (defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050)) || defined ( __GNUC__ )
195/* ARM V4/V5 and V6 & GNU Compiler
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 /* __CC_ARM || __ARMCC_VERSION */
207
208
209#ifdef __cplusplus
210}
211#endif
212
213#endif /* STM32G0xx_HAL_DEF */
214
215
Note: See TracBrowser for help on using the repository browser.