Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 30 | mjames | 1 | /** |
| 2 | ****************************************************************************** |
||
| 3 | * @file stm32l1xx_hal.c |
||
| 4 | * @author MCD Application Team |
||
| 5 | * @version V1.2.0 |
||
| 6 | * @date 01-July-2016 |
||
| 7 | * @brief HAL module driver. |
||
| 8 | * This is the common part of the HAL initialization |
||
| 9 | * |
||
| 10 | @verbatim |
||
| 11 | ============================================================================== |
||
| 12 | ##### How to use this driver ##### |
||
| 13 | ============================================================================== |
||
| 14 | [..] |
||
| 15 | The common HAL driver contains a set of generic and common APIs that can be |
||
| 16 | used by the PPP peripheral drivers and the user to start using the HAL. |
||
| 17 | [..] |
||
| 18 | The HAL contains two APIs' categories: |
||
| 19 | (+) Common HAL APIs |
||
| 20 | (+) Services HAL APIs |
||
| 21 | |||
| 22 | @endverbatim |
||
| 23 | ****************************************************************************** |
||
| 24 | * @attention |
||
| 25 | * |
||
| 26 | * <h2><center>© COPYRIGHT(c) 2016 STMicroelectronics</center></h2> |
||
| 27 | * |
||
| 28 | * Redistribution and use in source and binary forms, with or without modification, |
||
| 29 | * are permitted provided that the following conditions are met: |
||
| 30 | * 1. Redistributions of source code must retain the above copyright notice, |
||
| 31 | * this list of conditions and the following disclaimer. |
||
| 32 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
||
| 33 | * this list of conditions and the following disclaimer in the documentation |
||
| 34 | * and/or other materials provided with the distribution. |
||
| 35 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
||
| 36 | * may be used to endorse or promote products derived from this software |
||
| 37 | * without specific prior written permission. |
||
| 38 | * |
||
| 39 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
||
| 40 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
||
| 41 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
||
| 42 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
||
| 43 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
||
| 44 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
||
| 45 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
||
| 46 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
||
| 47 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||
| 48 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||
| 49 | * |
||
| 50 | ****************************************************************************** |
||
| 51 | */ |
||
| 52 | |||
| 53 | /* Includes ------------------------------------------------------------------*/ |
||
| 54 | #include "stm32l1xx_hal.h" |
||
| 55 | |||
| 56 | /** @addtogroup STM32L1xx_HAL_Driver |
||
| 57 | * @{ |
||
| 58 | */ |
||
| 59 | |||
| 60 | /** @defgroup HAL HAL |
||
| 61 | * @brief HAL module driver. |
||
| 62 | * @{ |
||
| 63 | */ |
||
| 64 | |||
| 65 | #ifdef HAL_MODULE_ENABLED |
||
| 66 | |||
| 67 | /* Private typedef -----------------------------------------------------------*/ |
||
| 68 | /* Private define ------------------------------------------------------------*/ |
||
| 69 | |||
| 70 | /** @defgroup HAL_Private_Defines HAL Private Defines |
||
| 71 | * @{ |
||
| 72 | */ |
||
| 73 | |||
| 74 | /** |
||
| 75 | * @brief STM32L1xx HAL Driver version number |
||
| 76 | */ |
||
| 77 | #define __STM32L1xx_HAL_VERSION_MAIN (0x01) /*!< [31:24] main version */ |
||
| 78 | #define __STM32L1xx_HAL_VERSION_SUB1 (0x02) /*!< [23:16] sub1 version */ |
||
| 79 | #define __STM32L1xx_HAL_VERSION_SUB2 (0x00) /*!< [15:8] sub2 version */ |
||
| 80 | #define __STM32L1xx_HAL_VERSION_RC (0x00) /*!< [7:0] release candidate */ |
||
| 81 | #define __STM32L1xx_HAL_VERSION ((__STM32L1xx_HAL_VERSION_MAIN << 24)\ |
||
| 82 | |(__STM32L1xx_HAL_VERSION_SUB1 << 16)\ |
||
| 83 | |(__STM32L1xx_HAL_VERSION_SUB2 << 8 )\ |
||
| 84 | |(__STM32L1xx_HAL_VERSION_RC)) |
||
| 85 | |||
| 86 | #define IDCODE_DEVID_MASK ((uint32_t)0x00000FFF) |
||
| 87 | |||
| 88 | /** |
||
| 89 | * @} |
||
| 90 | */ |
||
| 91 | |||
| 92 | /* Private macro -------------------------------------------------------------*/ |
||
| 93 | /* Private variables ---------------------------------------------------------*/ |
||
| 94 | |||
| 95 | /** @defgroup HAL_Private_Variables HAL Private Variables |
||
| 96 | * @{ |
||
| 97 | */ |
||
| 98 | |||
| 99 | __IO uint32_t uwTick; |
||
| 100 | |||
| 101 | /** |
||
| 102 | * @} |
||
| 103 | */ |
||
| 104 | |||
| 105 | /* Private function prototypes -----------------------------------------------*/ |
||
| 106 | /* Private functions ---------------------------------------------------------*/ |
||
| 107 | |||
| 108 | /** @defgroup HAL_Exported_Functions HAL Exported Functions |
||
| 109 | * @{ |
||
| 110 | */ |
||
| 111 | |||
| 112 | /** @defgroup HAL_Exported_Functions_Group1 Initialization and de-initialization Functions |
||
| 113 | * @brief Initialization and de-initialization functions |
||
| 114 | * |
||
| 115 | @verbatim |
||
| 116 | =============================================================================== |
||
| 117 | ##### Initialization and de-initialization functions ##### |
||
| 118 | =============================================================================== |
||
| 119 | [..] This section provides functions allowing to: |
||
| 120 | (+) Initializes the Flash interface, the NVIC allocation and initial clock |
||
| 121 | configuration. It initializes the source of time base also when timeout |
||
| 122 | is needed and the backup domain when enabled. |
||
| 123 | (+) de-Initializes common part of the HAL. |
||
| 124 | (+) Configure The time base source to have 1ms time base with a dedicated |
||
| 125 | Tick interrupt priority. |
||
| 126 | (++) Systick timer is used by default as source of time base, but user |
||
| 127 | can eventually implement his proper time base source (a general purpose |
||
| 128 | timer for example or other time source), keeping in mind that Time base |
||
| 129 | duration should be kept 1ms since PPP_TIMEOUT_VALUEs are defined and |
||
| 130 | handled in milliseconds basis. |
||
| 131 | (++) Time base configuration function (HAL_InitTick ()) is called automatically |
||
| 132 | at the beginning of the program after reset by HAL_Init() or at any time |
||
| 133 | when clock is configured, by HAL_RCC_ClockConfig(). |
||
| 134 | (++) Source of time base is configured to generate interrupts at regular |
||
| 135 | time intervals. Care must be taken if HAL_Delay() is called from a |
||
| 136 | peripheral ISR process, the Tick interrupt line must have higher priority |
||
| 137 | (numerically lower) than the peripheral interrupt. Otherwise the caller |
||
| 138 | ISR process will be blocked. |
||
| 139 | (++) functions affecting time base configurations are declared as __Weak |
||
| 140 | to make override possible in case of other implementations in user file. |
||
| 141 | |||
| 142 | @endverbatim |
||
| 143 | * @{ |
||
| 144 | */ |
||
| 145 | |||
| 146 | /** |
||
| 147 | * @brief This function configures the Flash prefetch, |
||
| 148 | * Configures time base source, NVIC and Low level hardware |
||
| 149 | * @note This function is called at the beginning of program after reset and before |
||
| 150 | * the clock configuration |
||
| 151 | * @note The time base configuration is based on MSI clock when exiting from Reset. |
||
| 152 | * Once done, time base tick start incrementing. |
||
| 153 | * In the default implementation,Systick is used as source of time base. |
||
| 154 | * the tick variable is incremented each 1ms in its ISR. |
||
| 155 | * @retval HAL status |
||
| 156 | */ |
||
| 157 | HAL_StatusTypeDef HAL_Init(void) |
||
| 158 | { |
||
| 159 | /* Configure Flash prefetch */ |
||
| 160 | #if (PREFETCH_ENABLE != 0) |
||
| 161 | __HAL_FLASH_PREFETCH_BUFFER_ENABLE(); |
||
| 162 | #endif /* PREFETCH_ENABLE */ |
||
| 163 | |||
| 164 | /* Set Interrupt Group Priority */ |
||
| 165 | HAL_NVIC_SetPriorityGrouping(NVIC_PRIORITYGROUP_4); |
||
| 166 | |||
| 167 | /* Use systick as time base source and configure 1ms tick (default clock after Reset is MSI) */ |
||
| 168 | HAL_InitTick(TICK_INT_PRIORITY); |
||
| 169 | |||
| 170 | /* Init the low level hardware */ |
||
| 171 | HAL_MspInit(); |
||
| 172 | |||
| 173 | /* Return function status */ |
||
| 174 | return HAL_OK; |
||
| 175 | } |
||
| 176 | |||
| 177 | /** |
||
| 178 | * @brief This function de-Initializes common part of the HAL and stops the source |
||
| 179 | * of time base. |
||
| 180 | * @note This function is optional. |
||
| 181 | * @retval HAL status |
||
| 182 | */ |
||
| 183 | HAL_StatusTypeDef HAL_DeInit(void) |
||
| 184 | { |
||
| 185 | /* Reset of all peripherals */ |
||
| 186 | __HAL_RCC_APB1_FORCE_RESET(); |
||
| 187 | __HAL_RCC_APB1_RELEASE_RESET(); |
||
| 188 | |||
| 189 | __HAL_RCC_APB2_FORCE_RESET(); |
||
| 190 | __HAL_RCC_APB2_RELEASE_RESET(); |
||
| 191 | |||
| 192 | __HAL_RCC_AHB_FORCE_RESET(); |
||
| 193 | __HAL_RCC_AHB_RELEASE_RESET(); |
||
| 194 | |||
| 195 | /* De-Init the low level hardware */ |
||
| 196 | HAL_MspDeInit(); |
||
| 197 | |||
| 198 | /* Return function status */ |
||
| 199 | return HAL_OK; |
||
| 200 | } |
||
| 201 | |||
| 202 | /** |
||
| 203 | * @brief Initializes the MSP. |
||
| 204 | * @retval None |
||
| 205 | */ |
||
| 206 | __weak void HAL_MspInit(void) |
||
| 207 | { |
||
| 208 | /* NOTE : This function Should not be modified, when the callback is needed, |
||
| 209 | the HAL_MspInit could be implemented in the user file |
||
| 210 | */ |
||
| 211 | } |
||
| 212 | |||
| 213 | /** |
||
| 214 | * @brief DeInitializes the MSP. |
||
| 215 | * @retval None |
||
| 216 | */ |
||
| 217 | __weak void HAL_MspDeInit(void) |
||
| 218 | { |
||
| 219 | /* NOTE : This function Should not be modified, when the callback is needed, |
||
| 220 | the HAL_MspDeInit could be implemented in the user file |
||
| 221 | */ |
||
| 222 | } |
||
| 223 | |||
| 224 | /** |
||
| 225 | * @brief This function configures the source of the time base. |
||
| 226 | * The time source is configured to have 1ms time base with a dedicated |
||
| 227 | * Tick interrupt priority. |
||
| 228 | * @note This function is called automatically at the beginning of program after |
||
| 229 | * reset by HAL_Init() or at any time when clock is reconfigured by HAL_RCC_ClockConfig(). |
||
| 230 | * @note In the default implementation, SysTick timer is the source of time base. |
||
| 231 | * It is used to generate interrupts at regular time intervals. |
||
| 232 | * Care must be taken if HAL_Delay() is called from a peripheral ISR process, |
||
| 233 | * The the SysTick interrupt must have higher priority (numerically lower) |
||
| 234 | * than the peripheral interrupt. Otherwise the caller ISR process will be blocked. |
||
| 235 | * The function is declared as __Weak to be overwritten in case of other |
||
| 236 | * implementation in user file. |
||
| 237 | * @param TickPriority: Tick interrupt priority. |
||
| 238 | * @retval HAL status |
||
| 239 | */ |
||
| 240 | __weak HAL_StatusTypeDef HAL_InitTick(uint32_t TickPriority) |
||
| 241 | { |
||
| 242 | /*Configure the SysTick to have interrupt in 1ms time basis*/ |
||
| 243 | HAL_SYSTICK_Config(SystemCoreClock /1000); |
||
| 244 | |||
| 245 | /*Configure the SysTick IRQ priority */ |
||
| 246 | HAL_NVIC_SetPriority(SysTick_IRQn, TickPriority ,0); |
||
| 247 | |||
| 248 | /* Return function status */ |
||
| 249 | return HAL_OK; |
||
| 250 | } |
||
| 251 | |||
| 252 | /** |
||
| 253 | * @} |
||
| 254 | */ |
||
| 255 | |||
| 256 | /** @defgroup HAL_Exported_Functions_Group2 HAL Control functions |
||
| 257 | * @brief HAL Control functions |
||
| 258 | * |
||
| 259 | @verbatim |
||
| 260 | =============================================================================== |
||
| 261 | ##### HAL Control functions ##### |
||
| 262 | =============================================================================== |
||
| 263 | [..] This section provides functions allowing to: |
||
| 264 | (+) Provide a tick value in millisecond |
||
| 265 | (+) Provide a blocking delay in millisecond |
||
| 266 | (+) Suspend the time base source interrupt |
||
| 267 | (+) Resume the time base source interrupt |
||
| 268 | (+) Get the HAL API driver version |
||
| 269 | (+) Get the device identifier |
||
| 270 | (+) Get the device revision identifier |
||
| 271 | (+) Enable/Disable Debug module during Sleep mode |
||
| 272 | (+) Enable/Disable Debug module during STOP mode |
||
| 273 | (+) Enable/Disable Debug module during STANDBY mode |
||
| 274 | |||
| 275 | @endverbatim |
||
| 276 | * @{ |
||
| 277 | */ |
||
| 278 | |||
| 279 | /** |
||
| 280 | * @brief This function is called to increment a global variable "uwTick" |
||
| 281 | * used as application time base. |
||
| 282 | * @note In the default implementation, this variable is incremented each 1ms |
||
| 283 | * in Systick ISR. |
||
| 284 | * @note This function is declared as __weak to be overwritten in case of other |
||
| 285 | * implementations in user file. |
||
| 286 | * @retval None |
||
| 287 | */ |
||
| 288 | __weak void HAL_IncTick(void) |
||
| 289 | { |
||
| 290 | uwTick++; |
||
| 291 | } |
||
| 292 | |||
| 293 | /** |
||
| 294 | * @brief Provides a tick value in millisecond. |
||
| 295 | * @note This function is declared as __weak to be overwritten in case of other |
||
| 296 | * implementations in user file. |
||
| 297 | * @retval tick value |
||
| 298 | */ |
||
| 299 | __weak uint32_t HAL_GetTick(void) |
||
| 300 | { |
||
| 301 | return uwTick; |
||
| 302 | } |
||
| 303 | |||
| 304 | /** |
||
| 305 | * @brief This function provides accurate delay (in milliseconds) based |
||
| 306 | * on variable incremented. |
||
| 307 | * @note In the default implementation , SysTick timer is the source of time base. |
||
| 308 | * It is used to generate interrupts at regular time intervals where uwTick |
||
| 309 | * is incremented. |
||
| 310 | * @note ThiS function is declared as __weak to be overwritten in case of other |
||
| 311 | * implementations in user file. |
||
| 312 | * @param Delay: specifies the delay time length, in milliseconds. |
||
| 313 | * @retval None |
||
| 314 | */ |
||
| 315 | __weak void HAL_Delay(__IO uint32_t Delay) |
||
| 316 | { |
||
| 317 | uint32_t tickstart = 0; |
||
| 318 | tickstart = HAL_GetTick(); |
||
| 319 | while((HAL_GetTick() - tickstart) < Delay) |
||
| 320 | { |
||
| 321 | } |
||
| 322 | } |
||
| 323 | |||
| 324 | /** |
||
| 325 | * @brief Suspend Tick increment. |
||
| 326 | * @note In the default implementation , SysTick timer is the source of time base. It is |
||
| 327 | * used to generate interrupts at regular time intervals. Once HAL_SuspendTick() |
||
| 328 | * is called, the the SysTick interrupt will be disabled and so Tick increment |
||
| 329 | * is suspended. |
||
| 330 | * @note This function is declared as __weak to be overwritten in case of other |
||
| 331 | * implementations in user file. |
||
| 332 | * @retval None |
||
| 333 | */ |
||
| 334 | __weak void HAL_SuspendTick(void) |
||
| 335 | { |
||
| 336 | /* Disable SysTick Interrupt */ |
||
| 337 | CLEAR_BIT(SysTick->CTRL,SysTick_CTRL_TICKINT_Msk); |
||
| 338 | } |
||
| 339 | |||
| 340 | /** |
||
| 341 | * @brief Resume Tick increment. |
||
| 342 | * @note In the default implementation , SysTick timer is the source of time base. It is |
||
| 343 | * used to generate interrupts at regular time intervals. Once HAL_ResumeTick() |
||
| 344 | * is called, the the SysTick interrupt will be enabled and so Tick increment |
||
| 345 | * is resumed. |
||
| 346 | * @note This function is declared as __weak to be overwritten in case of other |
||
| 347 | * implementations in user file. |
||
| 348 | * @retval None |
||
| 349 | */ |
||
| 350 | __weak void HAL_ResumeTick(void) |
||
| 351 | { |
||
| 352 | /* Enable SysTick Interrupt */ |
||
| 353 | SET_BIT(SysTick->CTRL,SysTick_CTRL_TICKINT_Msk); |
||
| 354 | } |
||
| 355 | |||
| 356 | /** |
||
| 357 | * @brief Returns the HAL revision |
||
| 358 | * @retval version: 0xXYZR (8bits for each decimal, R for RC) |
||
| 359 | */ |
||
| 360 | uint32_t HAL_GetHalVersion(void) |
||
| 361 | { |
||
| 362 | return __STM32L1xx_HAL_VERSION; |
||
| 363 | } |
||
| 364 | |||
| 365 | /** |
||
| 366 | * @brief Returns the device revision identifier. |
||
| 367 | * @retval Device revision identifier |
||
| 368 | */ |
||
| 369 | uint32_t HAL_GetREVID(void) |
||
| 370 | { |
||
| 371 | return((DBGMCU->IDCODE) >> 16); |
||
| 372 | } |
||
| 373 | |||
| 374 | /** |
||
| 375 | * @brief Returns the device identifier. |
||
| 376 | * @retval Device identifier |
||
| 377 | */ |
||
| 378 | uint32_t HAL_GetDEVID(void) |
||
| 379 | { |
||
| 380 | return((DBGMCU->IDCODE) & IDCODE_DEVID_MASK); |
||
| 381 | } |
||
| 382 | |||
| 383 | /** |
||
| 384 | * @brief Enable the Debug Module during SLEEP mode |
||
| 385 | * @retval None |
||
| 386 | */ |
||
| 387 | void HAL_DBGMCU_EnableDBGSleepMode(void) |
||
| 388 | { |
||
| 389 | SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_SLEEP); |
||
| 390 | } |
||
| 391 | |||
| 392 | /** |
||
| 393 | * @brief Disable the Debug Module during SLEEP mode |
||
| 394 | * @retval None |
||
| 395 | */ |
||
| 396 | void HAL_DBGMCU_DisableDBGSleepMode(void) |
||
| 397 | { |
||
| 398 | CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_SLEEP); |
||
| 399 | } |
||
| 400 | |||
| 401 | /** |
||
| 402 | * @brief Enable the Debug Module during STOP mode |
||
| 403 | * @retval None |
||
| 404 | */ |
||
| 405 | void HAL_DBGMCU_EnableDBGStopMode(void) |
||
| 406 | { |
||
| 407 | SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_STOP); |
||
| 408 | } |
||
| 409 | |||
| 410 | /** |
||
| 411 | * @brief Disable the Debug Module during STOP mode |
||
| 412 | * @retval None |
||
| 413 | */ |
||
| 414 | void HAL_DBGMCU_DisableDBGStopMode(void) |
||
| 415 | { |
||
| 416 | CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_STOP); |
||
| 417 | } |
||
| 418 | |||
| 419 | /** |
||
| 420 | * @brief Enable the Debug Module during STANDBY mode |
||
| 421 | * @retval None |
||
| 422 | */ |
||
| 423 | void HAL_DBGMCU_EnableDBGStandbyMode(void) |
||
| 424 | { |
||
| 425 | SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_STANDBY); |
||
| 426 | } |
||
| 427 | |||
| 428 | /** |
||
| 429 | * @brief Disable the Debug Module during STANDBY mode |
||
| 430 | * @retval None |
||
| 431 | */ |
||
| 432 | void HAL_DBGMCU_DisableDBGStandbyMode(void) |
||
| 433 | { |
||
| 434 | CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_STANDBY); |
||
| 435 | } |
||
| 436 | |||
| 437 | /** |
||
| 438 | * @} |
||
| 439 | */ |
||
| 440 | |||
| 441 | /** |
||
| 442 | * @} |
||
| 443 | */ |
||
| 444 | |||
| 445 | #endif /* HAL_MODULE_ENABLED */ |
||
| 446 | /** |
||
| 447 | * @} |
||
| 448 | */ |
||
| 449 | |||
| 450 | /** |
||
| 451 | * @} |
||
| 452 | */ |
||
| 453 | |||
| 454 | /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ |