|
| 1 | +/** |
| 2 | + ****************************************************************************** |
| 3 | + * @file stm32f4xx_hal.h |
| 4 | + * @author MCD Application Team |
| 5 | + * @version V1.0.0RC2 |
| 6 | + * @date 04-February-2014 |
| 7 | + * @brief This file contains all the functions prototypes for the HAL |
| 8 | + * module driver. |
| 9 | + ****************************************************************************** |
| 10 | + * @attention |
| 11 | + * |
| 12 | + * <h2><center>© COPYRIGHT(c) 2014 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 __STM32F4xx_HAL_H |
| 41 | +#define __STM32F4xx_HAL_H |
| 42 | + |
| 43 | +#ifdef __cplusplus |
| 44 | + extern "C" { |
| 45 | +#endif |
| 46 | + |
| 47 | +/* Includes ------------------------------------------------------------------*/ |
| 48 | +#include "stm32f4xx_hal_conf.h" |
| 49 | + |
| 50 | +/** @addtogroup STM32F4xx_HAL_Driver |
| 51 | + * @{ |
| 52 | + */ |
| 53 | + |
| 54 | +/** @addtogroup HAL |
| 55 | + * @{ |
| 56 | + */ |
| 57 | + |
| 58 | +/* Exported types ------------------------------------------------------------*/ |
| 59 | +/* Exported constants --------------------------------------------------------*/ |
| 60 | +/* Exported macro ------------------------------------------------------------*/ |
| 61 | + |
| 62 | +/** @brief Freeze/Unfreeze Peripherals in Debug mode |
| 63 | + */ |
| 64 | +#define __HAL_FREEZE_TIM2_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM2_STOP)) |
| 65 | +#define __HAL_FREEZE_TIM3_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM3_STOP)) |
| 66 | +#define __HAL_FREEZE_TIM4_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM4_STOP)) |
| 67 | +#define __HAL_FREEZE_TIM5_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM5_STOP)) |
| 68 | +#define __HAL_FREEZE_TIM6_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM6_STOP)) |
| 69 | +#define __HAL_FREEZE_TIM7_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM7_STOP)) |
| 70 | +#define __HAL_FREEZE_TIM12_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM12_STOP)) |
| 71 | +#define __HAL_FREEZE_TIM13_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM13_STOP)) |
| 72 | +#define __HAL_FREEZE_TIM14_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM14_STOP)) |
| 73 | +#define __HAL_FREEZE_RTC_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_RTC_STOP)) |
| 74 | +#define __HAL_FREEZE_WWDG_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_WWDG_STOP)) |
| 75 | +#define __HAL_FREEZE_IWDG_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_IWDG_STOP)) |
| 76 | +#define __HAL_FREEZE_I2C1_TIMEOUT_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C1_SMBUS_TIMEOUT)) |
| 77 | +#define __HAL_FREEZE_I2C2_TIMEOUT_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C2_SMBUS_TIMEOUT)) |
| 78 | +#define __HAL_FREEZE_I2C3_TIMEOUT_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C3_SMBUS_TIMEOUT)) |
| 79 | +#define __HAL_FREEZE_CAN1_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_CAN1_STOP)) |
| 80 | +#define __HAL_FREEZE_CAN2_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_CAN2_STOP)) |
| 81 | +#define __HAL_FREEZE_TIM1_DBGMCU() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM1_STOP)) |
| 82 | +#define __HAL_FREEZE_TIM8_DBGMCU() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM8_STOP)) |
| 83 | +#define __HAL_FREEZE_TIM9_DBGMCU() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM9_STOP)) |
| 84 | +#define __HAL_FREEZE_TIM10_DBGMCU() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM10_STOP)) |
| 85 | +#define __HAL_FREEZE_TIM11_DBGMCU() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM11_STOP)) |
| 86 | + |
| 87 | +#define __HAL_UNFREEZE_TIM2_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM2_STOP)) |
| 88 | +#define __HAL_UNFREEZE_TIM3_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM3_STOP)) |
| 89 | +#define __HAL_UNFREEZE_TIM4_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM4_STOP)) |
| 90 | +#define __HAL_UNFREEZE_TIM5_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM5_STOP)) |
| 91 | +#define __HAL_UNFREEZE_TIM6_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM6_STOP)) |
| 92 | +#define __HAL_UNFREEZE_TIM7_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM7_STOP)) |
| 93 | +#define __HAL_UNFREEZE_TIM12_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM12_STOP)) |
| 94 | +#define __HAL_UNFREEZE_TIM13_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM13_STOP)) |
| 95 | +#define __HAL_UNFREEZE_TIM14_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM14_STOP)) |
| 96 | +#define __HAL_UNFREEZE_RTC_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_RTC_STOP)) |
| 97 | +#define __HAL_UNFREEZE_WWDG_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_WWDG_STOP)) |
| 98 | +#define __HAL_UNFREEZE_IWDG_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_IWDG_STOP)) |
| 99 | +#define __HAL_UNFREEZE_I2C1_TIMEOUT_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C1_SMBUS_TIMEOUT)) |
| 100 | +#define __HAL_UNFREEZE_I2C2_TIMEOUT_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C2_SMBUS_TIMEOUT)) |
| 101 | +#define __HAL_UNFREEZE_I2C3_TIMEOUT_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C3_SMBUS_TIMEOUT)) |
| 102 | +#define __HAL_UNFREEZE_CAN1_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_CAN1_STOP)) |
| 103 | +#define __HAL_UNFREEZE_CAN2_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_CAN2_STOP)) |
| 104 | +#define __HAL_UNFREEZE_TIM1_DBGMCU() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM1_STOP)) |
| 105 | +#define __HAL_UNFREEZE_TIM8_DBGMCU() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM8_STOP)) |
| 106 | +#define __HAL_UNFREEZE_TIM9_DBGMCU() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM9_STOP)) |
| 107 | +#define __HAL_UNFREEZE_TIM10_DBGMCU() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM10_STOP)) |
| 108 | +#define __HAL_UNFREEZE_TIM11_DBGMCU() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM11_STOP)) |
| 109 | + |
| 110 | +/** @brief Main Flash memory mapped at 0x00000000 |
| 111 | + */ |
| 112 | +#define __HAL_REMAPMEMORY_FLASH (SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE)) |
| 113 | + |
| 114 | +/** @brief System Flash memory mapped at 0x00000000 |
| 115 | + */ |
| 116 | +#define __HAL_REMAPMEMORY_SYSTEMFLASH do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\ |
| 117 | + SYSCFG->MEMRMP |= SYSCFG_MEMRMP_MEM_MODE_0;\ |
| 118 | + }while(0); |
| 119 | + |
| 120 | +/** @brief Embedded SRAM mapped at 0x00000000 |
| 121 | + */ |
| 122 | +#define __HAL_REMAPMEMORY_SRAM do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\ |
| 123 | + SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_0 | SYSCFG_MEMRMP_MEM_MODE_1);\ |
| 124 | + }while(0); |
| 125 | + |
| 126 | +#if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx)|| defined(STM32F417xx) |
| 127 | +/** @brief FSMC Bank1 (NOR/PSRAM 1 and 2) mapped at 0x00000000 |
| 128 | + */ |
| 129 | +#define __HAL_REMAPMEMORY_FSMC do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\ |
| 130 | + SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_1);\ |
| 131 | + }while(0); |
| 132 | +#endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx */ |
| 133 | + |
| 134 | +#if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx) |
| 135 | +/** @brief FMC Bank1 (NOR/PSRAM 1 and 2) mapped at 0x00000000 |
| 136 | + */ |
| 137 | +#define __HAL_REMAPMEMORY_FMC do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\ |
| 138 | + SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_1);\ |
| 139 | + }while(0); |
| 140 | + |
| 141 | +/** @brief FMC/SDRAM Bank 1 and 2 mapped at 0x00000000 |
| 142 | + */ |
| 143 | +#define __HAL_REMAPMEMORY_FMC_SDRAM do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\ |
| 144 | + SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_2);\ |
| 145 | + }while(0); |
| 146 | +#endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */ |
| 147 | + |
| 148 | +/* Exported functions --------------------------------------------------------*/ |
| 149 | + |
| 150 | +/* Initialization and de-initialization functions ******************************/ |
| 151 | +HAL_StatusTypeDef HAL_Init(void); |
| 152 | +HAL_StatusTypeDef HAL_DeInit(void); |
| 153 | +__weak void HAL_MspInit(void); |
| 154 | +__weak void HAL_MspDeInit(void); |
| 155 | + |
| 156 | +/* Peripheral Control functions ************************************************/ |
| 157 | +void HAL_IncTick(void); |
| 158 | +void HAL_Delay(__IO uint32_t Delay); |
| 159 | +uint32_t HAL_GetTick(void); |
| 160 | +uint32_t HAL_GetHalVersion(void); |
| 161 | +uint32_t HAL_GetREVID(void); |
| 162 | +uint32_t HAL_GetDEVID(void); |
| 163 | +void HAL_EnableDBGSleepMode(void); |
| 164 | +void HAL_DisableDBGSleepMode(void); |
| 165 | +void HAL_EnableDBGStopMode(void); |
| 166 | +void HAL_DisableDBGStopMode(void); |
| 167 | +void HAL_EnableDBGStandbyMode(void); |
| 168 | +void HAL_DisableDBGStandbyMode(void); |
| 169 | +void HAL_EnableCompensationCell(void); |
| 170 | +void HAL_DisableCompensationCell(void); |
| 171 | +#if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx) |
| 172 | +void HAL_EnableMemorySwappingBank(void); |
| 173 | +void HAL_DisableMemorySwappingBank(void); |
| 174 | +#endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */ |
| 175 | + |
| 176 | + |
| 177 | +/** |
| 178 | + * @} |
| 179 | + */ |
| 180 | + |
| 181 | +/** |
| 182 | + * @} |
| 183 | + */ |
| 184 | + |
| 185 | +#ifdef __cplusplus |
| 186 | +} |
| 187 | +#endif |
| 188 | + |
| 189 | +#endif /* __STM32F4xx_HAL_H */ |
| 190 | + |
| 191 | +/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |
0 commit comments