1 /**
2   ******************************************************************************
3   * @file    stm32f7xx_hal.h
4   * @author  MCD Application Team
5   * @brief   This file contains all the functions prototypes for the HAL
6   *          module driver.
7   ******************************************************************************
8   * @attention
9   *
10   * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
11   * All rights reserved.</center></h2>
12   *
13   * This software component is licensed by ST under BSD 3-Clause license,
14   * the "License"; You may not use this file except in compliance with the
15   * License. You may obtain a copy of the License at:
16   *                        opensource.org/licenses/BSD-3-Clause
17   *
18   ******************************************************************************
19   */
20 
21 /* Define to prevent recursive inclusion -------------------------------------*/
22 #ifndef __STM32F7xx_HAL_H
23 #define __STM32F7xx_HAL_H
24 
25 #ifdef __cplusplus
26  extern "C" {
27 #endif
28 
29 /* Includes ------------------------------------------------------------------*/
30 #include "stm32f7xx_hal_conf.h"
31 
32 /** @addtogroup STM32F7xx_HAL_Driver
33   * @{
34   */
35 
36 /** @addtogroup HAL
37   * @{
38   */
39 
40 /* Exported types ------------------------------------------------------------*/
41 /* Exported constants --------------------------------------------------------*/
42 
43 /** @defgroup HAL_Exported_Constants HAL Exported Constants
44   * @{
45   */
46 
47 /** @defgroup HAL_TICK_FREQ Tick Frequency
48   * @{
49   */
50 typedef enum
51 {
52   HAL_TICK_FREQ_10HZ         = 100U,
53   HAL_TICK_FREQ_100HZ        = 10U,
54   HAL_TICK_FREQ_1KHZ         = 1U,
55   HAL_TICK_FREQ_DEFAULT      = HAL_TICK_FREQ_1KHZ
56 } HAL_TickFreqTypeDef;
57 /**
58   * @}
59   */
60 
61 /** @defgroup SYSCFG_BootMode Boot Mode
62   * @{
63   */
64 #define SYSCFG_MEM_BOOT_ADD0          ((uint32_t)0x00000000U)
65 #define SYSCFG_MEM_BOOT_ADD1          SYSCFG_MEMRMP_MEM_BOOT
66 /**
67   * @}
68   */
69 
70 /**
71   * @}
72   */
73 
74 /* Exported macro ------------------------------------------------------------*/
75 /** @defgroup HAL_Exported_Macros HAL Exported Macros
76   * @{
77   */
78 
79 /** @brief  Freeze/Unfreeze Peripherals in Debug mode
80   */
81 #define __HAL_DBGMCU_FREEZE_TIM2()           (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM2_STOP))
82 #define __HAL_DBGMCU_FREEZE_TIM3()           (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM3_STOP))
83 #define __HAL_DBGMCU_FREEZE_TIM4()           (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM4_STOP))
84 #define __HAL_DBGMCU_FREEZE_TIM5()           (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM5_STOP))
85 #define __HAL_DBGMCU_FREEZE_TIM6()           (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM6_STOP))
86 #define __HAL_DBGMCU_FREEZE_TIM7()           (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM7_STOP))
87 #define __HAL_DBGMCU_FREEZE_TIM12()          (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM12_STOP))
88 #define __HAL_DBGMCU_FREEZE_TIM13()          (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM13_STOP))
89 #define __HAL_DBGMCU_FREEZE_TIM14()          (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM14_STOP))
90 #define __HAL_DBGMCU_FREEZE_LPTIM1()         (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_LPTIM1_STOP))
91 #define __HAL_DBGMCU_FREEZE_RTC()            (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_RTC_STOP))
92 #define __HAL_DBGMCU_FREEZE_WWDG()           (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_WWDG_STOP))
93 #define __HAL_DBGMCU_FREEZE_IWDG()           (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_IWDG_STOP))
94 #define __HAL_DBGMCU_FREEZE_I2C1_TIMEOUT()   (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C1_SMBUS_TIMEOUT))
95 #define __HAL_DBGMCU_FREEZE_I2C2_TIMEOUT()   (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C2_SMBUS_TIMEOUT))
96 #define __HAL_DBGMCU_FREEZE_I2C3_TIMEOUT()   (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C3_SMBUS_TIMEOUT))
97 #define __HAL_DBGMCU_FREEZE_I2C4_TIMEOUT()   (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C4_SMBUS_TIMEOUT))
98 #define __HAL_DBGMCU_FREEZE_CAN1()           (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_CAN1_STOP))
99 #define __HAL_DBGMCU_FREEZE_CAN2()           (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_CAN2_STOP))
100 #define __HAL_DBGMCU_FREEZE_TIM1()           (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM1_STOP))
101 #define __HAL_DBGMCU_FREEZE_TIM8()           (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM8_STOP))
102 #define __HAL_DBGMCU_FREEZE_TIM9()           (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM9_STOP))
103 #define __HAL_DBGMCU_FREEZE_TIM10()          (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM10_STOP))
104 #define __HAL_DBGMCU_FREEZE_TIM11()          (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM11_STOP))
105 
106 #define __HAL_DBGMCU_UNFREEZE_TIM2()           (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM2_STOP))
107 #define __HAL_DBGMCU_UNFREEZE_TIM3()           (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM3_STOP))
108 #define __HAL_DBGMCU_UNFREEZE_TIM4()           (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM4_STOP))
109 #define __HAL_DBGMCU_UNFREEZE_TIM5()           (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM5_STOP))
110 #define __HAL_DBGMCU_UNFREEZE_TIM6()           (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM6_STOP))
111 #define __HAL_DBGMCU_UNFREEZE_TIM7()           (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM7_STOP))
112 #define __HAL_DBGMCU_UNFREEZE_TIM12()          (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM12_STOP))
113 #define __HAL_DBGMCU_UNFREEZE_TIM13()          (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM13_STOP))
114 #define __HAL_DBGMCU_UNFREEZE_TIM14()          (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM14_STOP))
115 #define __HAL_DBGMCU_UNFREEZE_LPTIM1()         (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_LPTIM1_STOP))
116 #define __HAL_DBGMCU_UNFREEZE_RTC()            (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_RTC_STOP))
117 #define __HAL_DBGMCU_UNFREEZE_WWDG()           (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_WWDG_STOP))
118 #define __HAL_DBGMCU_UNFREEZE_IWDG()           (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_IWDG_STOP))
119 #define __HAL_DBGMCU_UNFREEZE_I2C1_TIMEOUT()   (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C1_SMBUS_TIMEOUT))
120 #define __HAL_DBGMCU_UNFREEZE_I2C2_TIMEOUT()   (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C2_SMBUS_TIMEOUT))
121 #define __HAL_DBGMCU_UNFREEZE_I2C3_TIMEOUT()   (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C3_SMBUS_TIMEOUT))
122 #define __HAL_DBGMCU_UNFREEZE_I2C4_TIMEOUT()   (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C4_SMBUS_TIMEOUT))
123 #define __HAL_DBGMCU_UNFREEZE_CAN1()           (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_CAN1_STOP))
124 #define __HAL_DBGMCU_UNFREEZE_CAN2()           (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_CAN2_STOP))
125 #define __HAL_DBGMCU_UNFREEZE_TIM1()           (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM1_STOP))
126 #define __HAL_DBGMCU_UNFREEZE_TIM8()           (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM8_STOP))
127 #define __HAL_DBGMCU_UNFREEZE_TIM9()           (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM9_STOP))
128 #define __HAL_DBGMCU_UNFREEZE_TIM10()          (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM10_STOP))
129 #define __HAL_DBGMCU_UNFREEZE_TIM11()          (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM11_STOP))
130 
131 
132 /** @brief  FMC (NOR/RAM) mapped at 0x60000000 and SDRAM mapped at 0xC0000000
133   */
134 #define __HAL_SYSCFG_REMAPMEMORY_FMC()          (SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_SWP_FMC))
135 
136 
137 /** @brief  FMC/SDRAM  mapped at 0x60000000 (NOR/RAM) mapped at 0xC0000000
138   */
139 #define __HAL_SYSCFG_REMAPMEMORY_FMC_SDRAM() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_SWP_FMC);\
140                                           SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_SWP_FMC_0);\
141                                          }while(0);
142 /**
143   * @brief  Return the memory boot mapping as configured by user.
144   * @retval The boot mode as configured by user. The returned value can be one
145   *         of the following values:
146   *           @arg @ref SYSCFG_MEM_BOOT_ADD0
147   *           @arg @ref SYSCFG_MEM_BOOT_ADD1
148   */
149 #define __HAL_SYSCFG_GET_BOOT_MODE()           READ_BIT(SYSCFG->MEMRMP, SYSCFG_MEMRMP_MEM_BOOT)
150 
151 #if defined (STM32F765xx) || defined (STM32F767xx) || defined (STM32F769xx) || defined (STM32F777xx) || defined (STM32F779xx)
152 /** @brief  SYSCFG Break Cortex-M7 Lockup lock.
153   *         Enable and lock the connection of Cortex-M7 LOCKUP (Hardfault) output to TIM1/8 Break input.
154   * @note   The selected configuration is locked and can be unlocked only by system reset.
155   */
156 #define __HAL_SYSCFG_BREAK_LOCKUP_LOCK()     SET_BIT(SYSCFG->CBR, SYSCFG_CBR_CLL)
157 
158 /** @brief  SYSCFG Break PVD lock.
159   *         Enable and lock the PVD connection to Timer1/8 Break input, as well as the PVDE and PLS[2:0] in the PWR_CR1 register.
160   * @note   The selected configuration is locked and can be unlocked only by system reset.
161   */
162 #define __HAL_SYSCFG_BREAK_PVD_LOCK()        SET_BIT(SYSCFG->CBR, SYSCFG_CBR_PVDL)
163 #endif /* STM32F765xx || STM32F767xx || STM32F769xx || STM32F777xx || STM32F779xx */
164 
165 /**
166   * @}
167   */
168 
169 /** @defgroup HAL_Private_Macros HAL Private Macros
170   * @{
171   */
172 #define IS_TICKFREQ(FREQ) (((FREQ) == HAL_TICK_FREQ_10HZ)  || \
173                            ((FREQ) == HAL_TICK_FREQ_100HZ) || \
174                            ((FREQ) == HAL_TICK_FREQ_1KHZ))
175 /**
176   * @}
177   */
178 /* Exported functions --------------------------------------------------------*/
179 /** @addtogroup HAL_Exported_Functions
180   * @{
181   */
182 /** @addtogroup HAL_Exported_Functions_Group1
183   * @{
184   */
185 /* Initialization and Configuration functions  ******************************/
186 HAL_StatusTypeDef HAL_Init(void);
187 HAL_StatusTypeDef HAL_DeInit(void);
188 void HAL_MspInit(void);
189 void HAL_MspDeInit(void);
190 HAL_StatusTypeDef HAL_InitTick(uint32_t TickPriority);
191 /**
192   * @}
193   */
194 
195  /* Exported variables ---------------------------------------------------------*/
196 /** @addtogroup HAL_Exported_Variables
197   * @{
198   */
199 extern __IO uint32_t uwTick;
200 extern uint32_t uwTickPrio;
201 extern HAL_TickFreqTypeDef uwTickFreq;
202 /**
203   * @}
204   */
205 
206 /** @addtogroup HAL_Exported_Functions_Group2
207   * @{
208   */
209 /* Peripheral Control functions  ************************************************/
210 void HAL_IncTick(void);
211 void HAL_Delay(uint32_t Delay);
212 uint32_t HAL_GetTick(void);
213 uint32_t HAL_GetTickPrio(void);
214 HAL_StatusTypeDef HAL_SetTickFreq(HAL_TickFreqTypeDef Freq);
215 HAL_TickFreqTypeDef HAL_GetTickFreq(void);
216 void HAL_SuspendTick(void);
217 void HAL_ResumeTick(void);
218 uint32_t HAL_GetHalVersion(void);
219 uint32_t HAL_GetREVID(void);
220 uint32_t HAL_GetDEVID(void);
221 uint32_t HAL_GetUIDw0(void);
222 uint32_t HAL_GetUIDw1(void);
223 uint32_t HAL_GetUIDw2(void);
224 void HAL_DBGMCU_EnableDBGSleepMode(void);
225 void HAL_DBGMCU_DisableDBGSleepMode(void);
226 void HAL_DBGMCU_EnableDBGStopMode(void);
227 void HAL_DBGMCU_DisableDBGStopMode(void);
228 void HAL_DBGMCU_EnableDBGStandbyMode(void);
229 void HAL_DBGMCU_DisableDBGStandbyMode(void);
230 void HAL_EnableCompensationCell(void);
231 void HAL_DisableCompensationCell(void);
232 void HAL_EnableFMCMemorySwapping(void);
233 void HAL_DisableFMCMemorySwapping(void);
234 #if defined (STM32F765xx) || defined (STM32F767xx) || defined (STM32F769xx) || defined (STM32F777xx) || defined (STM32F779xx)
235 void HAL_EnableMemorySwappingBank(void);
236 void HAL_DisableMemorySwappingBank(void);
237 #endif /* STM32F765xx || STM32F767xx || STM32F769xx || STM32F777xx || STM32F779xx */
238 /**
239   * @}
240   */
241 
242 /**
243   * @}
244   */
245 /* Private types -------------------------------------------------------------*/
246 /* Private variables ---------------------------------------------------------*/
247 /** @defgroup HAL_Private_Variables HAL Private Variables
248   * @{
249   */
250 /**
251   * @}
252   */
253 /* Private constants ---------------------------------------------------------*/
254 /** @defgroup HAL_Private_Constants HAL Private Constants
255   * @{
256   */
257 /**
258   * @}
259   */
260 /* Private macros ------------------------------------------------------------*/
261 /* Private functions ---------------------------------------------------------*/
262 /**
263   * @}
264   */
265 
266 /**
267   * @}
268   */
269 
270 #ifdef __cplusplus
271 }
272 #endif
273 
274 #endif /* __STM32F7xx_HAL_H */
275 
276 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
277