Mercurial > pub > halpp

comparison l476rg/Drivers/STM32L4xx_HAL_Driver/Inc/stm32l4xx_hal_def.h @ 0:32a3b1785697

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
a rough draft of Hardware Abstraction Layer for C++ STM32L476RG drivers
author cin
date Thu, 12 Jan 2017 02:45:43 +0300
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:32a3b1785697
1 /**
2 ******************************************************************************
3 * @file stm32l4xx_hal_def.h
4 * @author MCD Application Team
5 * @version V1.6.0
6 * @date 28-October-2016
7 * @brief This file contains HAL common defines, enumeration, macros and
8 * structures definitions.
9 ******************************************************************************
10 * @attention
11 *
12 * <h2><center>&copy; COPYRIGHT(c) 2016 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 __STM32L4xx_HAL_DEF
41 #define __STM32L4xx_HAL_DEF
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 /* Includes ------------------------------------------------------------------*/
48 #include "stm32l4xx.h"
49 #include "Legacy/stm32_hal_legacy.h" /* Aliases file for old names compatibility */
50 #include <stdio.h>
51
52 /* Exported types ------------------------------------------------------------*/
53
54 /**
55 * @brief HAL Status structures definition
56 */
57 typedef 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 */
68 typedef enum
69 {
70 HAL_UNLOCKED = 0x00,
71 HAL_LOCKED = 0x01
72 } HAL_LockTypeDef;
73
74 /* Exported macros -----------------------------------------------------------*/
75
76 #define HAL_MAX_DELAY 0xFFFFFFFFU
77
78 #define HAL_IS_BIT_SET(REG, BIT) (((REG) & (BIT)) == (BIT))
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(0)
86
87 #define UNUSED(x) ((void)(x))
88
89 /** @brief Reset the Handle's State field.
90 * @param __HANDLE__: specifies the Peripheral Handle.
91 * @note This macro can be used for the following purpose:
92 * - When the Handle is declared as local variable; before passing it as parameter
93 * to HAL_PPP_Init() for the first time, it is mandatory to use this macro
94 * to set to 0 the Handle's "State" field.
95 * Otherwise, "State" field may have any random value and the first time the function
96 * HAL_PPP_Init() is called, the low level hardware initialization will be missed
97 * (i.e. HAL_PPP_MspInit() will not be executed).
98 * - When there is a need to reconfigure the low level hardware: instead of calling
99 * HAL_PPP_DeInit() then HAL_PPP_Init(), user can make a call to this macro then HAL_PPP_Init().
100 * In this later function, when the Handle's "State" field is set to 0, it will execute the function
101 * HAL_PPP_MspInit() which will reconfigure the low level hardware.
102 * @retval None
103 */
104 #define __HAL_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = 0)
105
106 #if (USE_RTOS == 1)
107 /* Reserved for future use */
108 #error " USE_RTOS should be 0 in the current HAL release "
109 #else
110 #define __HAL_LOCK(__HANDLE__) \
111 do{ \
112 if((__HANDLE__)->Lock == HAL_LOCKED) \
113 { \
114 return HAL_BUSY; \
115 } \
116 else \
117 { \
118 (__HANDLE__)->Lock = HAL_LOCKED; \
119 } \
120 }while (0)
121
122 #define __HAL_UNLOCK(__HANDLE__) \
123 do{ \
124 (__HANDLE__)->Lock = HAL_UNLOCKED; \
125 }while (0)
126 #endif /* USE_RTOS */
127
128 #if defined ( __GNUC__ )
129 #ifndef __weak
130 #define __weak __attribute__((weak))
131 #endif /* __weak */
132 #ifndef __packed
133 #define __packed __attribute__((__packed__))
134 #endif /* __packed */
135 #endif /* __GNUC__ */
136
137
138 /* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used instead */
139 #if defined (__GNUC__) /* GNU Compiler */
140 #ifndef __ALIGN_END
141 #define __ALIGN_END __attribute__ ((aligned (4)))
142 #endif /* __ALIGN_END */
143 #ifndef __ALIGN_BEGIN
144 #define __ALIGN_BEGIN
145 #endif /* __ALIGN_BEGIN */
146 #else
147 #ifndef __ALIGN_END
148 #define __ALIGN_END
149 #endif /* __ALIGN_END */
150 #ifndef __ALIGN_BEGIN
151 #if defined (__CC_ARM) /* ARM Compiler */
152 #define __ALIGN_BEGIN __align(4)
153 #elif defined (__ICCARM__) /* IAR Compiler */
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 )
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
209 #ifdef __cplusplus
210 }
211 #endif
212
213 #endif /* ___STM32L4xx_HAL_DEF */
214
215 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/