shao ziyang / mbed-src-kl05

mbed library sources

Dependents:   frdm_kl05z_gpio_test

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_NUCLEO_F411RE/stm32f4xx_hal.h@323:9e901b0a5aa1, 2014-09-13 (annotated)

Committer:
shaoziyang
Date:
Sat Sep 13 14:25:46 2014 +0000
Revision:
323:9e901b0a5aa1
Parent:
235:685d5f11838f 
test with CLOCK_SETUP = 0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 235:685d5f11838f 1 /**
mbed_official 235:685d5f11838f 2 ******************************************************************************
mbed_official 235:685d5f11838f 3 * @file stm32f4xx_hal.h
mbed_official 235:685d5f11838f 4 * @author MCD Application Team
mbed_official 235:685d5f11838f 5 * @version V1.1.0
mbed_official 235:685d5f11838f 6 * @date 19-June-2014
mbed_official 235:685d5f11838f 7 * @brief This file contains all the functions prototypes for the HAL
mbed_official 235:685d5f11838f 8 * module driver.
mbed_official 235:685d5f11838f 9 ******************************************************************************
mbed_official 235:685d5f11838f 10 * @attention
mbed_official 235:685d5f11838f 11 *
mbed_official 235:685d5f11838f 12 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
mbed_official 235:685d5f11838f 13 *
mbed_official 235:685d5f11838f 14 * Redistribution and use in source and binary forms, with or without modification,
mbed_official 235:685d5f11838f 15 * are permitted provided that the following conditions are met:
mbed_official 235:685d5f11838f 16 * 1. Redistributions of source code must retain the above copyright notice,
mbed_official 235:685d5f11838f 17 * this list of conditions and the following disclaimer.
mbed_official 235:685d5f11838f 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
mbed_official 235:685d5f11838f 19 * this list of conditions and the following disclaimer in the documentation
mbed_official 235:685d5f11838f 20 * and/or other materials provided with the distribution.
mbed_official 235:685d5f11838f 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
mbed_official 235:685d5f11838f 22 * may be used to endorse or promote products derived from this software
mbed_official 235:685d5f11838f 23 * without specific prior written permission.
mbed_official 235:685d5f11838f 24 *
mbed_official 235:685d5f11838f 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
mbed_official 235:685d5f11838f 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
mbed_official 235:685d5f11838f 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
mbed_official 235:685d5f11838f 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
mbed_official 235:685d5f11838f 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mbed_official 235:685d5f11838f 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
mbed_official 235:685d5f11838f 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
mbed_official 235:685d5f11838f 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
mbed_official 235:685d5f11838f 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
mbed_official 235:685d5f11838f 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mbed_official 235:685d5f11838f 35 *
mbed_official 235:685d5f11838f 36 ******************************************************************************
mbed_official 235:685d5f11838f 37 */
mbed_official 235:685d5f11838f 38
mbed_official 235:685d5f11838f 39 /* Define to prevent recursive inclusion -------------------------------------*/
mbed_official 235:685d5f11838f 40 #ifndef __STM32F4xx_HAL_H
mbed_official 235:685d5f11838f 41 #define __STM32F4xx_HAL_H
mbed_official 235:685d5f11838f 42
mbed_official 235:685d5f11838f 43 #ifdef __cplusplus
mbed_official 235:685d5f11838f 44 extern "C" {
mbed_official 235:685d5f11838f 45 #endif
mbed_official 235:685d5f11838f 46
mbed_official 235:685d5f11838f 47 /* Includes ------------------------------------------------------------------*/
mbed_official 235:685d5f11838f 48 #include "stm32f4xx_hal_conf.h"
mbed_official 235:685d5f11838f 49
mbed_official 235:685d5f11838f 50 /** @addtogroup STM32F4xx_HAL_Driver
mbed_official 235:685d5f11838f 51 * @{
mbed_official 235:685d5f11838f 52 */
mbed_official 235:685d5f11838f 53
mbed_official 235:685d5f11838f 54 /** @addtogroup HAL
mbed_official 235:685d5f11838f 55 * @{
mbed_official 235:685d5f11838f 56 */
mbed_official 235:685d5f11838f 57
mbed_official 235:685d5f11838f 58 /* Exported types ------------------------------------------------------------*/
mbed_official 235:685d5f11838f 59 /* Exported constants --------------------------------------------------------*/
mbed_official 235:685d5f11838f 60 /* Exported macro ------------------------------------------------------------*/
mbed_official 235:685d5f11838f 61
mbed_official 235:685d5f11838f 62 /** @brief Freeze/Unfreeze Peripherals in Debug mode
mbed_official 235:685d5f11838f 63 */
mbed_official 235:685d5f11838f 64 #define __HAL_FREEZE_TIM2_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM2_STOP))
mbed_official 235:685d5f11838f 65 #define __HAL_FREEZE_TIM3_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM3_STOP))
mbed_official 235:685d5f11838f 66 #define __HAL_FREEZE_TIM4_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM4_STOP))
mbed_official 235:685d5f11838f 67 #define __HAL_FREEZE_TIM5_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM5_STOP))
mbed_official 235:685d5f11838f 68 #define __HAL_FREEZE_TIM6_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM6_STOP))
mbed_official 235:685d5f11838f 69 #define __HAL_FREEZE_TIM7_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM7_STOP))
mbed_official 235:685d5f11838f 70 #define __HAL_FREEZE_TIM12_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM12_STOP))
mbed_official 235:685d5f11838f 71 #define __HAL_FREEZE_TIM13_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM13_STOP))
mbed_official 235:685d5f11838f 72 #define __HAL_FREEZE_TIM14_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_TIM14_STOP))
mbed_official 235:685d5f11838f 73 #define __HAL_FREEZE_RTC_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_RTC_STOP))
mbed_official 235:685d5f11838f 74 #define __HAL_FREEZE_WWDG_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_WWDG_STOP))
mbed_official 235:685d5f11838f 75 #define __HAL_FREEZE_IWDG_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_IWDG_STOP))
mbed_official 235:685d5f11838f 76 #define __HAL_FREEZE_I2C1_TIMEOUT_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C1_SMBUS_TIMEOUT))
mbed_official 235:685d5f11838f 77 #define __HAL_FREEZE_I2C2_TIMEOUT_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C2_SMBUS_TIMEOUT))
mbed_official 235:685d5f11838f 78 #define __HAL_FREEZE_I2C3_TIMEOUT_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_I2C3_SMBUS_TIMEOUT))
mbed_official 235:685d5f11838f 79 #define __HAL_FREEZE_CAN1_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_CAN1_STOP))
mbed_official 235:685d5f11838f 80 #define __HAL_FREEZE_CAN2_DBGMCU() (DBGMCU->APB1FZ |= (DBGMCU_APB1_FZ_DBG_CAN2_STOP))
mbed_official 235:685d5f11838f 81 #define __HAL_FREEZE_TIM1_DBGMCU() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM1_STOP))
mbed_official 235:685d5f11838f 82 #define __HAL_FREEZE_TIM8_DBGMCU() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM8_STOP))
mbed_official 235:685d5f11838f 83 #define __HAL_FREEZE_TIM9_DBGMCU() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM9_STOP))
mbed_official 235:685d5f11838f 84 #define __HAL_FREEZE_TIM10_DBGMCU() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM10_STOP))
mbed_official 235:685d5f11838f 85 #define __HAL_FREEZE_TIM11_DBGMCU() (DBGMCU->APB2FZ |= (DBGMCU_APB2_FZ_DBG_TIM11_STOP))
mbed_official 235:685d5f11838f 86
mbed_official 235:685d5f11838f 87 #define __HAL_UNFREEZE_TIM2_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM2_STOP))
mbed_official 235:685d5f11838f 88 #define __HAL_UNFREEZE_TIM3_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM3_STOP))
mbed_official 235:685d5f11838f 89 #define __HAL_UNFREEZE_TIM4_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM4_STOP))
mbed_official 235:685d5f11838f 90 #define __HAL_UNFREEZE_TIM5_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM5_STOP))
mbed_official 235:685d5f11838f 91 #define __HAL_UNFREEZE_TIM6_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM6_STOP))
mbed_official 235:685d5f11838f 92 #define __HAL_UNFREEZE_TIM7_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM7_STOP))
mbed_official 235:685d5f11838f 93 #define __HAL_UNFREEZE_TIM12_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM12_STOP))
mbed_official 235:685d5f11838f 94 #define __HAL_UNFREEZE_TIM13_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM13_STOP))
mbed_official 235:685d5f11838f 95 #define __HAL_UNFREEZE_TIM14_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM14_STOP))
mbed_official 235:685d5f11838f 96 #define __HAL_UNFREEZE_RTC_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_RTC_STOP))
mbed_official 235:685d5f11838f 97 #define __HAL_UNFREEZE_WWDG_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_WWDG_STOP))
mbed_official 235:685d5f11838f 98 #define __HAL_UNFREEZE_IWDG_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_IWDG_STOP))
mbed_official 235:685d5f11838f 99 #define __HAL_UNFREEZE_I2C1_TIMEOUT_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C1_SMBUS_TIMEOUT))
mbed_official 235:685d5f11838f 100 #define __HAL_UNFREEZE_I2C2_TIMEOUT_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C2_SMBUS_TIMEOUT))
mbed_official 235:685d5f11838f 101 #define __HAL_UNFREEZE_I2C3_TIMEOUT_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C3_SMBUS_TIMEOUT))
mbed_official 235:685d5f11838f 102 #define __HAL_UNFREEZE_CAN1_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_CAN1_STOP))
mbed_official 235:685d5f11838f 103 #define __HAL_UNFREEZE_CAN2_DBGMCU() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_CAN2_STOP))
mbed_official 235:685d5f11838f 104 #define __HAL_UNFREEZE_TIM1_DBGMCU() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM1_STOP))
mbed_official 235:685d5f11838f 105 #define __HAL_UNFREEZE_TIM8_DBGMCU() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM8_STOP))
mbed_official 235:685d5f11838f 106 #define __HAL_UNFREEZE_TIM9_DBGMCU() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM9_STOP))
mbed_official 235:685d5f11838f 107 #define __HAL_UNFREEZE_TIM10_DBGMCU() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM10_STOP))
mbed_official 235:685d5f11838f 108 #define __HAL_UNFREEZE_TIM11_DBGMCU() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM11_STOP))
mbed_official 235:685d5f11838f 109
mbed_official 235:685d5f11838f 110 /** @brief Main Flash memory mapped at 0x00000000
mbed_official 235:685d5f11838f 111 */
mbed_official 235:685d5f11838f 112 #define __HAL_REMAPMEMORY_FLASH() (SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE))
mbed_official 235:685d5f11838f 113
mbed_official 235:685d5f11838f 114 /** @brief System Flash memory mapped at 0x00000000
mbed_official 235:685d5f11838f 115 */
mbed_official 235:685d5f11838f 116 #define __HAL_REMAPMEMORY_SYSTEMFLASH() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
mbed_official 235:685d5f11838f 117 SYSCFG->MEMRMP |= SYSCFG_MEMRMP_MEM_MODE_0;\
mbed_official 235:685d5f11838f 118 }while(0);
mbed_official 235:685d5f11838f 119
mbed_official 235:685d5f11838f 120 /** @brief Embedded SRAM mapped at 0x00000000
mbed_official 235:685d5f11838f 121 */
mbed_official 235:685d5f11838f 122 #define __HAL_REMAPMEMORY_SRAM() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
mbed_official 235:685d5f11838f 123 SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_0 | SYSCFG_MEMRMP_MEM_MODE_1);\
mbed_official 235:685d5f11838f 124 }while(0);
mbed_official 235:685d5f11838f 125
mbed_official 235:685d5f11838f 126 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx)|| defined(STM32F417xx)
mbed_official 235:685d5f11838f 127 /** @brief FSMC Bank1 (NOR/PSRAM 1 and 2) mapped at 0x00000000
mbed_official 235:685d5f11838f 128 */
mbed_official 235:685d5f11838f 129 #define __HAL_REMAPMEMORY_FSMC() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
mbed_official 235:685d5f11838f 130 SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_1);\
mbed_official 235:685d5f11838f 131 }while(0);
mbed_official 235:685d5f11838f 132 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx */
mbed_official 235:685d5f11838f 133
mbed_official 235:685d5f11838f 134 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx)
mbed_official 235:685d5f11838f 135 /** @brief FMC Bank1 (NOR/PSRAM 1 and 2) mapped at 0x00000000
mbed_official 235:685d5f11838f 136 */
mbed_official 235:685d5f11838f 137 #define __HAL_REMAPMEMORY_FMC() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
mbed_official 235:685d5f11838f 138 SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_1);\
mbed_official 235:685d5f11838f 139 }while(0);
mbed_official 235:685d5f11838f 140
mbed_official 235:685d5f11838f 141 /** @brief FMC/SDRAM Bank 1 and 2 mapped at 0x00000000
mbed_official 235:685d5f11838f 142 */
mbed_official 235:685d5f11838f 143 #define __HAL_REMAPMEMORY_FMC_SDRAM() do {SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE);\
mbed_official 235:685d5f11838f 144 SYSCFG->MEMRMP |= (SYSCFG_MEMRMP_MEM_MODE_2);\
mbed_official 235:685d5f11838f 145 }while(0);
mbed_official 235:685d5f11838f 146 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
mbed_official 235:685d5f11838f 147
mbed_official 235:685d5f11838f 148 /* Exported functions --------------------------------------------------------*/
mbed_official 235:685d5f11838f 149
mbed_official 235:685d5f11838f 150 /* Initialization and de-initialization functions ******************************/
mbed_official 235:685d5f11838f 151 HAL_StatusTypeDef HAL_Init(void);
mbed_official 235:685d5f11838f 152 HAL_StatusTypeDef HAL_DeInit(void);
mbed_official 235:685d5f11838f 153 void HAL_MspInit(void);
mbed_official 235:685d5f11838f 154 void HAL_MspDeInit(void);
mbed_official 235:685d5f11838f 155 HAL_StatusTypeDef HAL_InitTick (uint32_t TickPriority);
mbed_official 235:685d5f11838f 156
mbed_official 235:685d5f11838f 157 /* Peripheral Control functions ************************************************/
mbed_official 235:685d5f11838f 158 void HAL_IncTick(void);
mbed_official 235:685d5f11838f 159 void HAL_Delay(__IO uint32_t Delay);
mbed_official 235:685d5f11838f 160 uint32_t HAL_GetTick(void);
mbed_official 235:685d5f11838f 161 void HAL_SuspendTick(void);
mbed_official 235:685d5f11838f 162 void HAL_ResumeTick(void);
mbed_official 235:685d5f11838f 163 uint32_t HAL_GetHalVersion(void);
mbed_official 235:685d5f11838f 164 uint32_t HAL_GetREVID(void);
mbed_official 235:685d5f11838f 165 uint32_t HAL_GetDEVID(void);
mbed_official 235:685d5f11838f 166 void HAL_EnableDBGSleepMode(void);
mbed_official 235:685d5f11838f 167 void HAL_DisableDBGSleepMode(void);
mbed_official 235:685d5f11838f 168 void HAL_EnableDBGStopMode(void);
mbed_official 235:685d5f11838f 169 void HAL_DisableDBGStopMode(void);
mbed_official 235:685d5f11838f 170 void HAL_EnableDBGStandbyMode(void);
mbed_official 235:685d5f11838f 171 void HAL_DisableDBGStandbyMode(void);
mbed_official 235:685d5f11838f 172 void HAL_EnableCompensationCell(void);
mbed_official 235:685d5f11838f 173 void HAL_DisableCompensationCell(void);
mbed_official 235:685d5f11838f 174 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx)
mbed_official 235:685d5f11838f 175 void HAL_EnableMemorySwappingBank(void);
mbed_official 235:685d5f11838f 176 void HAL_DisableMemorySwappingBank(void);
mbed_official 235:685d5f11838f 177 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
mbed_official 235:685d5f11838f 178
mbed_official 235:685d5f11838f 179
mbed_official 235:685d5f11838f 180 /**
mbed_official 235:685d5f11838f 181 * @}
mbed_official 235:685d5f11838f 182 */
mbed_official 235:685d5f11838f 183
mbed_official 235:685d5f11838f 184 /**
mbed_official 235:685d5f11838f 185 * @}
mbed_official 235:685d5f11838f 186 */
mbed_official 235:685d5f11838f 187
mbed_official 235:685d5f11838f 188 #ifdef __cplusplus
mbed_official 235:685d5f11838f 189 }
mbed_official 235:685d5f11838f 190 #endif
mbed_official 235:685d5f11838f 191
mbed_official 235:685d5f11838f 192 #endif /* __STM32F4xx_HAL_H */
mbed_official 235:685d5f11838f 193
mbed_official 235:685d5f11838f 194 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/