/** | |
****************************************************************************** | |
* @file stm32f4xx_hal.c | |
* @author MCD Application Team | |
* @version V1.7.1 | |
* @date 14-April-2017 | |
* @brief HAL module driver. | |
* This is the common part of the HAL initialization | |
* | |
@verbatim | |
============================================================================== | |
##### How to use this driver ##### | |
============================================================================== | |
[..] | |
The common HAL driver contains a set of generic and common APIs that can be | |
used by the PPP peripheral drivers and the user to start using the HAL. | |
[..] | |
The HAL contains two APIs' categories: | |
(+) Common HAL APIs | |
(+) Services HAL APIs | |
@endverbatim | |
****************************************************************************** | |
* @attention | |
* | |
* <h2><center>© COPYRIGHT(c) 2017 STMicroelectronics</center></h2> | |
* | |
* Redistribution and use in source and binary forms, with or without modification, | |
* are permitted provided that the following conditions are met: | |
* 1. Redistributions of source code must retain the above copyright notice, | |
* this list of conditions and the following disclaimer. | |
* 2. Redistributions in binary form must reproduce the above copyright notice, | |
* this list of conditions and the following disclaimer in the documentation | |
* and/or other materials provided with the distribution. | |
* 3. Neither the name of STMicroelectronics nor the names of its contributors | |
* may be used to endorse or promote products derived from this software | |
* without specific prior written permission. | |
* | |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | |
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | |
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | |
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | |
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
* | |
****************************************************************************** | |
*/ | |
/* Includes ------------------------------------------------------------------*/ | |
#include "stm32f4xx_hal.h" | |
/** @addtogroup STM32F4xx_HAL_Driver | |
* @{ | |
*/ | |
/** @defgroup HAL HAL | |
* @brief HAL module driver. | |
* @{ | |
*/ | |
/* Private typedef -----------------------------------------------------------*/ | |
/* Private define ------------------------------------------------------------*/ | |
/** @addtogroup HAL_Private_Constants | |
* @{ | |
*/ | |
/** | |
* @brief STM32F4xx HAL Driver version number V1.7.1 | |
*/ | |
#define __STM32F4xx_HAL_VERSION_MAIN (0x01U) /*!< [31:24] main version */ | |
#define __STM32F4xx_HAL_VERSION_SUB1 (0x07U) /*!< [23:16] sub1 version */ | |
#define __STM32F4xx_HAL_VERSION_SUB2 (0x01U) /*!< [15:8] sub2 version */ | |
#define __STM32F4xx_HAL_VERSION_RC (0x00U) /*!< [7:0] release candidate */ | |
#define __STM32F4xx_HAL_VERSION ((__STM32F4xx_HAL_VERSION_MAIN << 24U)\ | |
|(__STM32F4xx_HAL_VERSION_SUB1 << 16U)\ | |
|(__STM32F4xx_HAL_VERSION_SUB2 << 8U )\ | |
|(__STM32F4xx_HAL_VERSION_RC)) | |
#define IDCODE_DEVID_MASK 0x00000FFFU | |
/* ------------ RCC registers bit address in the alias region ----------- */ | |
#define SYSCFG_OFFSET (SYSCFG_BASE - PERIPH_BASE) | |
/* --- MEMRMP Register ---*/ | |
/* Alias word address of UFB_MODE bit */ | |
#define MEMRMP_OFFSET SYSCFG_OFFSET | |
#define UFB_MODE_BIT_NUMBER POSITION_VAL(SYSCFG_MEMRMP_UFB_MODE) | |
#define UFB_MODE_BB (uint32_t)(PERIPH_BB_BASE + (MEMRMP_OFFSET * 32U) + (UFB_MODE_BIT_NUMBER * 4U)) | |
/* --- CMPCR Register ---*/ | |
/* Alias word address of CMP_PD bit */ | |
#define CMPCR_OFFSET (SYSCFG_OFFSET + 0x20U) | |
#define CMP_PD_BIT_NUMBER POSITION_VAL(SYSCFG_CMPCR_CMP_PD) | |
#define CMPCR_CMP_PD_BB (uint32_t)(PERIPH_BB_BASE + (CMPCR_OFFSET * 32U) + (CMP_PD_BIT_NUMBER * 4U)) | |
/* --- MCHDLYCR Register ---*/ | |
/* Alias word address of BSCKSEL bit */ | |
#define MCHDLYCR_OFFSET (SYSCFG_OFFSET + 0x30U) | |
#define BSCKSEL_BIT_NUMBER POSITION_VAL(SYSCFG_MCHDLYCR_BSCKSEL) | |
#define MCHDLYCR_BSCKSEL_BB (uint32_t)(PERIPH_BB_BASE + (MCHDLYCR_OFFSET * 32U) + (BSCKSEL_BIT_NUMBER * 4U)) | |
/** | |
* @} | |
*/ | |
/* Private macro -------------------------------------------------------------*/ | |
/* Private variables ---------------------------------------------------------*/ | |
/** @addtogroup HAL_Private_Variables | |
* @{ | |
*/ | |
__IO uint32_t uwTick; | |
/** | |
* @} | |
*/ | |
/* Private function prototypes -----------------------------------------------*/ | |
/* Private functions ---------------------------------------------------------*/ | |
/** @defgroup HAL_Exported_Functions HAL Exported Functions | |
* @{ | |
*/ | |
/** @defgroup HAL_Exported_Functions_Group1 Initialization and de-initialization Functions | |
* @brief Initialization and de-initialization functions | |
* | |
@verbatim | |
=============================================================================== | |
##### Initialization and de-initialization functions ##### | |
=============================================================================== | |
[..] This section provides functions allowing to: | |
(+) Initializes the Flash interface the NVIC allocation and initial clock | |
configuration. It initializes the systick also when timeout is needed | |
and the backup domain when enabled. | |
(+) de-Initializes common part of the HAL | |
(+) Configure The time base source to have 1ms time base with a dedicated | |
Tick interrupt priority. | |
(++) Systick timer is used by default as source of time base, but user | |
can eventually implement his proper time base source (a general purpose | |
timer for example or other time source), keeping in mind that Time base | |
duration should be kept 1ms since PPP_TIMEOUT_VALUEs are defined and | |
handled in milliseconds basis. | |
(++) Time base configuration function (HAL_InitTick ()) is called automatically | |
at the beginning of the program after reset by HAL_Init() or at any time | |
when clock is configured, by HAL_RCC_ClockConfig(). | |
(++) Source of time base is configured to generate interrupts at regular | |
time intervals. Care must be taken if HAL_Delay() is called from a | |
peripheral ISR process, the Tick interrupt line must have higher priority | |
(numerically lower) than the peripheral interrupt. Otherwise the caller | |
ISR process will be blocked. | |
(++) functions affecting time base configurations are declared as __weak | |
to make override possible in case of other implementations in user file. | |
@endverbatim | |
* @{ | |
*/ | |
/** | |
* @brief This function is used to initialize the HAL Library; it must be the first | |
* instruction to be executed in the main program (before to call any other | |
* HAL function), it performs the following: | |
* Configure the Flash prefetch, instruction and Data caches. | |
* Configures the SysTick to generate an interrupt each 1 millisecond, | |
* which is clocked by the HSI (at this stage, the clock is not yet | |
* configured and thus the system is running from the internal HSI at 16 MHz). | |
* Set NVIC Group Priority to 4. | |
* Calls the HAL_MspInit() callback function defined in user file | |
* "stm32f4xx_hal_msp.c" to do the global low level hardware initialization | |
* | |
* @note SysTick is used as time base for the HAL_Delay() function, the application | |
* need to ensure that the SysTick time base is always set to 1 millisecond | |
* to have correct HAL operation. | |
* @retval HAL status | |
*/ | |
HAL_StatusTypeDef HAL_Init(void) | |
{ | |
/* Configure Flash prefetch, Instruction cache, Data cache */ | |
#if (INSTRUCTION_CACHE_ENABLE != 0U) | |
__HAL_FLASH_INSTRUCTION_CACHE_ENABLE(); | |
#endif /* INSTRUCTION_CACHE_ENABLE */ | |
#if (DATA_CACHE_ENABLE != 0U) | |
__HAL_FLASH_DATA_CACHE_ENABLE(); | |
#endif /* DATA_CACHE_ENABLE */ | |
#if (PREFETCH_ENABLE != 0U) | |
__HAL_FLASH_PREFETCH_BUFFER_ENABLE(); | |
#endif /* PREFETCH_ENABLE */ | |
/* Set Interrupt Group Priority */ | |
HAL_NVIC_SetPriorityGrouping(NVIC_PRIORITYGROUP_4); | |
/* Use systick as time base source and configure 1ms tick (default clock after Reset is HSI) */ | |
HAL_InitTick(TICK_INT_PRIORITY); | |
/* Init the low level hardware */ | |
HAL_MspInit(); | |
/* Return function status */ | |
return HAL_OK; | |
} | |
/** | |
* @brief This function de-Initializes common part of the HAL and stops the systick. | |
* This function is optional. | |
* @retval HAL status | |
*/ | |
HAL_StatusTypeDef HAL_DeInit(void) | |
{ | |
/* Reset of all peripherals */ | |
__HAL_RCC_APB1_FORCE_RESET(); | |
__HAL_RCC_APB1_RELEASE_RESET(); | |
__HAL_RCC_APB2_FORCE_RESET(); | |
__HAL_RCC_APB2_RELEASE_RESET(); | |
__HAL_RCC_AHB1_FORCE_RESET(); | |
__HAL_RCC_AHB1_RELEASE_RESET(); | |
__HAL_RCC_AHB2_FORCE_RESET(); | |
__HAL_RCC_AHB2_RELEASE_RESET(); | |
__HAL_RCC_AHB3_FORCE_RESET(); | |
__HAL_RCC_AHB3_RELEASE_RESET(); | |
/* De-Init the low level hardware */ | |
HAL_MspDeInit(); | |
/* Return function status */ | |
return HAL_OK; | |
} | |
/** | |
* @brief Initializes the MSP. | |
* @retval None | |
*/ | |
__weak void HAL_MspInit(void) | |
{ | |
/* NOTE : This function Should not be modified, when the callback is needed, | |
the HAL_MspInit could be implemented in the user file | |
*/ | |
} | |
/** | |
* @brief DeInitializes the MSP. | |
* @retval None | |
*/ | |
__weak void HAL_MspDeInit(void) | |
{ | |
/* NOTE : This function Should not be modified, when the callback is needed, | |
the HAL_MspDeInit could be implemented in the user file | |
*/ | |
} | |
/** | |
* @brief This function configures the source of the time base. | |
* The time source is configured to have 1ms time base with a dedicated | |
* Tick interrupt priority. | |
* @note This function is called automatically at the beginning of program after | |
* reset by HAL_Init() or at any time when clock is reconfigured by HAL_RCC_ClockConfig(). | |
* @note In the default implementation, SysTick timer is the source of time base. | |
* It is used to generate interrupts at regular time intervals. | |
* Care must be taken if HAL_Delay() is called from a peripheral ISR process, | |
* The the SysTick interrupt must have higher priority (numerically lower) | |
* than the peripheral interrupt. Otherwise the caller ISR process will be blocked. | |
* The function is declared as __weak to be overwritten in case of other | |
* implementation in user file. | |
* @param TickPriority: Tick interrupt priority. | |
* @retval HAL status | |
*/ | |
__weak HAL_StatusTypeDef HAL_InitTick(uint32_t TickPriority) | |
{ | |
/*Configure the SysTick to have interrupt in 1ms time basis*/ | |
HAL_SYSTICK_Config(SystemCoreClock/1000U); | |
/*Configure the SysTick IRQ priority */ | |
HAL_NVIC_SetPriority(SysTick_IRQn, TickPriority, 0U); | |
/* Return function status */ | |
return HAL_OK; | |
} | |
/** | |
* @} | |
*/ | |
/** @defgroup HAL_Exported_Functions_Group2 HAL Control functions | |
* @brief HAL Control functions | |
* | |
@verbatim | |
=============================================================================== | |
##### HAL Control functions ##### | |
=============================================================================== | |
[..] This section provides functions allowing to: | |
(+) Provide a tick value in millisecond | |
(+) Provide a blocking delay in millisecond | |
(+) Suspend the time base source interrupt | |
(+) Resume the time base source interrupt | |
(+) Get the HAL API driver version | |
(+) Get the device identifier | |
(+) Get the device revision identifier | |
(+) Enable/Disable Debug module during SLEEP mode | |
(+) Enable/Disable Debug module during STOP mode | |
(+) Enable/Disable Debug module during STANDBY mode | |
@endverbatim | |
* @{ | |
*/ | |
/** | |
* @brief This function is called to increment a global variable "uwTick" | |
* used as application time base. | |
* @note In the default implementation, this variable is incremented each 1ms | |
* in Systick ISR. | |
* @note This function is declared as __weak to be overwritten in case of other | |
* implementations in user file. | |
* @retval None | |
*/ | |
__weak void HAL_IncTick(void) | |
{ | |
uwTick++; | |
} | |
/** | |
* @brief Provides a tick value in millisecond. | |
* @note This function is declared as __weak to be overwritten in case of other | |
* implementations in user file. | |
* @retval tick value | |
*/ | |
__weak uint32_t HAL_GetTick(void) | |
{ | |
return uwTick; | |
} | |
/** | |
* @brief This function provides minimum delay (in milliseconds) based | |
* on variable incremented. | |
* @note In the default implementation , SysTick timer is the source of time base. | |
* It is used to generate interrupts at regular time intervals where uwTick | |
* is incremented. | |
* @note This function is declared as __weak to be overwritten in case of other | |
* implementations in user file. | |
* @param Delay: specifies the delay time length, in milliseconds. | |
* @retval None | |
*/ | |
__weak void HAL_Delay(__IO uint32_t Delay) | |
{ | |
uint32_t tickstart = HAL_GetTick(); | |
uint32_t wait = Delay; | |
/* Add a period to guarantee minimum wait */ | |
if (wait < HAL_MAX_DELAY) | |
{ | |
wait++; | |
} | |
while((HAL_GetTick() - tickstart) < wait) | |
{ | |
} | |
} | |
/** | |
* @brief Suspend Tick increment. | |
* @note In the default implementation , SysTick timer is the source of time base. It is | |
* used to generate interrupts at regular time intervals. Once HAL_SuspendTick() | |
* is called, the SysTick interrupt will be disabled and so Tick increment | |
* is suspended. | |
* @note This function is declared as __weak to be overwritten in case of other | |
* implementations in user file. | |
* @retval None | |
*/ | |
__weak void HAL_SuspendTick(void) | |
{ | |
/* Disable SysTick Interrupt */ | |
SysTick->CTRL &= ~SysTick_CTRL_TICKINT_Msk; | |
} | |
/** | |
* @brief Resume Tick increment. | |
* @note In the default implementation , SysTick timer is the source of time base. It is | |
* used to generate interrupts at regular time intervals. Once HAL_ResumeTick() | |
* is called, the SysTick interrupt will be enabled and so Tick increment | |
* is resumed. | |
* @note This function is declared as __weak to be overwritten in case of other | |
* implementations in user file. | |
* @retval None | |
*/ | |
__weak void HAL_ResumeTick(void) | |
{ | |
/* Enable SysTick Interrupt */ | |
SysTick->CTRL |= SysTick_CTRL_TICKINT_Msk; | |
} | |
/** | |
* @brief Returns the HAL revision | |
* @retval version : 0xXYZR (8bits for each decimal, R for RC) | |
*/ | |
uint32_t HAL_GetHalVersion(void) | |
{ | |
return __STM32F4xx_HAL_VERSION; | |
} | |
/** | |
* @brief Returns the device revision identifier. | |
* @retval Device revision identifier | |
*/ | |
uint32_t HAL_GetREVID(void) | |
{ | |
return((DBGMCU->IDCODE) >> 16U); | |
} | |
/** | |
* @brief Returns the device identifier. | |
* @retval Device identifier | |
*/ | |
uint32_t HAL_GetDEVID(void) | |
{ | |
return((DBGMCU->IDCODE) & IDCODE_DEVID_MASK); | |
} | |
/** | |
* @brief Enable the Debug Module during SLEEP mode | |
* @retval None | |
*/ | |
void HAL_DBGMCU_EnableDBGSleepMode(void) | |
{ | |
SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_SLEEP); | |
} | |
/** | |
* @brief Disable the Debug Module during SLEEP mode | |
* @retval None | |
*/ | |
void HAL_DBGMCU_DisableDBGSleepMode(void) | |
{ | |
CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_SLEEP); | |
} | |
/** | |
* @brief Enable the Debug Module during STOP mode | |
* @retval None | |
*/ | |
void HAL_DBGMCU_EnableDBGStopMode(void) | |
{ | |
SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_STOP); | |
} | |
/** | |
* @brief Disable the Debug Module during STOP mode | |
* @retval None | |
*/ | |
void HAL_DBGMCU_DisableDBGStopMode(void) | |
{ | |
CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_STOP); | |
} | |
/** | |
* @brief Enable the Debug Module during STANDBY mode | |
* @retval None | |
*/ | |
void HAL_DBGMCU_EnableDBGStandbyMode(void) | |
{ | |
SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_STANDBY); | |
} | |
/** | |
* @brief Disable the Debug Module during STANDBY mode | |
* @retval None | |
*/ | |
void HAL_DBGMCU_DisableDBGStandbyMode(void) | |
{ | |
CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_STANDBY); | |
} | |
/** | |
* @brief Enables the I/O Compensation Cell. | |
* @note The I/O compensation cell can be used only when the device supply | |
* voltage ranges from 2.4 to 3.6 V. | |
* @retval None | |
*/ | |
void HAL_EnableCompensationCell(void) | |
{ | |
*(__IO uint32_t *)CMPCR_CMP_PD_BB = (uint32_t)ENABLE; | |
} | |
/** | |
* @brief Power-down the I/O Compensation Cell. | |
* @note The I/O compensation cell can be used only when the device supply | |
* voltage ranges from 2.4 to 3.6 V. | |
* @retval None | |
*/ | |
void HAL_DisableCompensationCell(void) | |
{ | |
*(__IO uint32_t *)CMPCR_CMP_PD_BB = (uint32_t)DISABLE; | |
} | |
/** | |
* @brief Return the unique device identifier (UID based on 96 bits) | |
* @param UID: pointer to 3 words array. | |
* @retval Device identifier | |
*/ | |
void HAL_GetUID(uint32_t *UID) | |
{ | |
UID[0] = (uint32_t)(READ_REG(*((uint32_t *)UID_BASE))); | |
UID[1] = (uint32_t)(READ_REG(*((uint32_t *)(UID_BASE + 4U)))); | |
UID[2] = (uint32_t)(READ_REG(*((uint32_t *)(UID_BASE + 8U)))); | |
} | |
#if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx) ||\ | |
defined(STM32F469xx) || defined(STM32F479xx) | |
/** | |
* @brief Enables the Internal FLASH Bank Swapping. | |
* | |
* @note This function can be used only for STM32F42xxx/43xxx devices. | |
* | |
* @note Flash Bank2 mapped at 0x08000000 (and aliased @0x00000000) | |
* and Flash Bank1 mapped at 0x08100000 (and aliased at 0x00100000) | |
* | |
* @retval None | |
*/ | |
void HAL_EnableMemorySwappingBank(void) | |
{ | |
*(__IO uint32_t *)UFB_MODE_BB = (uint32_t)ENABLE; | |
} | |
/** | |
* @brief Disables the Internal FLASH Bank Swapping. | |
* | |
* @note This function can be used only for STM32F42xxx/43xxx devices. | |
* | |
* @note The default state : Flash Bank1 mapped at 0x08000000 (and aliased @0x00000000) | |
* and Flash Bank2 mapped at 0x08100000 (and aliased at 0x00100000) | |
* | |
* @retval None | |
*/ | |
void HAL_DisableMemorySwappingBank(void) | |
{ | |
*(__IO uint32_t *)UFB_MODE_BB = (uint32_t)DISABLE; | |
} | |
#endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F469xx || STM32F479xx */ | |
/** | |
* @} | |
*/ | |
/** | |
* @} | |
*/ | |
/** | |
* @} | |
*/ | |
/** | |
* @} | |
*/ | |
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |