1 /**
2   ******************************************************************************
3   * @file    stm32f7xx_hal_def.h
4   * @author  MCD Application Team
5   * @version V1.0.1
6   * @date    25-June-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 __STM32F7xx_HAL_DEF
41 #define __STM32F7xx_HAL_DEF
42 
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46 
47 /* Includes ------------------------------------------------------------------*/
48 #include "stm32f7xx.h"
49 #include "Legacy/stm32_hal_legacy.h"
50 #include <stdio.h>
51 /* Exported types ------------------------------------------------------------*/
52 
53 /**
54   * @brief  HAL Status structures definition
55   */
56 typedef enum {
57     HAL_OK       = 0x00,
58     HAL_ERROR    = 0x01,
59     HAL_BUSY     = 0x02,
60     HAL_TIMEOUT  = 0x03
61 } HAL_StatusTypeDef;
62 
63 /**
64   * @brief  HAL Lock structures definition
65   */
66 typedef enum {
67     HAL_UNLOCKED = 0x00,
68     HAL_LOCKED   = 0x01
69 } HAL_LockTypeDef;
70 
71 /* Exported macro ------------------------------------------------------------*/
72 #define HAL_MAX_DELAY      0xFFFFFFFF
73 
74 #define HAL_IS_BIT_SET(REG, BIT)         (((REG) & (BIT)) != RESET)
75 #define HAL_IS_BIT_CLR(REG, BIT)         (((REG) & (BIT)) == RESET)
76 
77 #define __HAL_LINKDMA(__HANDLE__, __PPP_DMA_FIELD__, __DMA_HANDLE__)               \
78                         do{                                                      \
79                               (__HANDLE__)->__PPP_DMA_FIELD__ = &(__DMA_HANDLE__); \
80                               (__DMA_HANDLE__).Parent = (__HANDLE__);             \
81                           } while(0)
82 
83 #define UNUSED(x) ((void)(x))
84 
85 /** @brief Reset the Handle's State field.
86   * @param __HANDLE__: specifies the Peripheral Handle.
87   * @note  This macro can be used for the following purpose:
88   *          - When the Handle is declared as local variable; before passing it as parameter
89   *            to HAL_PPP_Init() for the first time, it is mandatory to use this macro
90   *            to set to 0 the Handle's "State" field.
91   *            Otherwise, "State" field may have any random value and the first time the function
92   *            HAL_PPP_Init() is called, the low level hardware initialization will be missed
93   *            (i.e. HAL_PPP_MspInit() will not be executed).
94   *          - When there is a need to reconfigure the low level hardware: instead of calling
95   *            HAL_PPP_DeInit() then HAL_PPP_Init(), user can make a call to this macro then HAL_PPP_Init().
96   *            In this later function, when the Handle's "State" field is set to 0, it will execute the function
97   *            HAL_PPP_MspInit() which will reconfigure the low level hardware.
98   * @retval None
99   */
100 #define __HAL_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = 0)
101 
102 #if (USE_RTOS == 1)
103 /* Reserved for future use */
104 #errorUSE_RTOS should be 0 in the current HAL release105 #else
106 #define __HAL_LOCK(__HANDLE__)                                           \
107                                 do{                                        \
108                                     if((__HANDLE__)->Lock == HAL_LOCKED)   \
109                                     {                                      \
110                                        return HAL_BUSY;                    \
111                                     }                                      \
112                                     else                                   \
113                                     {                                      \
114                                        (__HANDLE__)->Lock = HAL_LOCKED;    \
115                                     }                                      \
116                                   }while (0)
117 
118 #define __HAL_UNLOCK(__HANDLE__)                                          \
119                                   do{                                       \
120                                       (__HANDLE__)->Lock = HAL_UNLOCKED;    \
121                                     }while (0)
122 #endif /* USE_RTOS */
123 
124 #if  defined ( __GNUC__ )
125 #ifndef __weak
126 #define __weak   __attribute__((weak))
127 #endif /* __weak */
128 #ifndef __packed
129 #define __packed __attribute__((__packed__))
130 #endif /* __packed */
131 #endif /* __GNUC__ */
132 
133 
134 /* Macro to get variable aligned on 4-bytes, for __ICCARM__ the directive "#pragma data_alignment=4" must be used instead */
135 #if defined   (__GNUC__)        /* GNU Compiler */
136 #ifndef __ALIGN_END
137 #define __ALIGN_END    __attribute__ ((aligned (4)))
138 #endif /* __ALIGN_END */
139 #ifndef __ALIGN_BEGIN
140 #define __ALIGN_BEGIN
141 #endif /* __ALIGN_BEGIN */
142 #else
143 #ifndef __ALIGN_END
144 #define __ALIGN_END
145 #endif /* __ALIGN_END */
146 #ifndef __ALIGN_BEGIN
147 #if defined   (__CC_ARM)      /* ARM Compiler */
148 #define __ALIGN_BEGIN    __align(4)
149 #elif defined (__ICCARM__)    /* IAR Compiler */
150 #define __ALIGN_BEGIN
151 #endif /* __CC_ARM */
152 #endif /* __ALIGN_BEGIN */
153 #endif /* __GNUC__ */
154 
155 
156 /**
157   * @brief  __RAM_FUNC definition
158   */
159 #if defined ( __CC_ARM   )
160 /* ARM Compiler
161    ------------
162    RAM functions are defined using the toolchain options.
163    Functions that are executed in RAM should reside in a separate source module.
164    Using the 'Options for File' dialog you can simply change the 'Code / Const'
165    area of a module to a memory space in physical RAM.
166    Available memory areas are declared in the 'Target' tab of the 'Options for Target'
167    dialog.
168 */
169 #define __RAM_FUNC HAL_StatusTypeDef
170 
171 #elif defined ( __ICCARM__ )
172 /* ICCARM Compiler
173    ---------------
174    RAM functions are defined using a specific toolchain keyword "__ramfunc".
175 */
176 #define __RAM_FUNC __ramfunc HAL_StatusTypeDef
177 
178 #elif defined   (  __GNUC__  )
179 /* GNU Compiler
180    ------------
181   RAM functions are defined using a specific toolchain attribute
182    "__attribute__((section(".RamFunc")))".
183 */
184 #define __RAM_FUNC HAL_StatusTypeDef  __attribute__((section(".RamFunc")))
185 
186 #endif
187 
188 /**
189   * @brief  __NOINLINE definition
190   */
191 #if defined ( __CC_ARM   ) || defined   (  __GNUC__  )
192 /* ARM & GNUCompiler
193    ----------------
194 */
195 #define __NOINLINE __attribute__ ( (noinline) )
196 
197 #elif defined ( __ICCARM__ )
198 /* ICCARM Compiler
199    ---------------
200 */
201 #define __NOINLINE _Pragma("optimize = no_inline")
202 
203 #endif
204 
205 #ifdef __cplusplus
206 }
207 #endif
208 
209 #endif /* ___STM32F7xx_HAL_DEF */
210 
211 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
212