Subversion Repositories DashDisplay

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 mjames 1
/**
2
  ******************************************************************************
3
  * @file    stm32f1xx_hal.c
4
  * @author  MCD Application Team
5
  * @version V1.0.1
6
  * @date    31-July-2015
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>&copy; COPYRIGHT(c) 2015 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 "stm32f1xx_hal.h"
55
 
56
/** @addtogroup STM32F1xx_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_Constants HAL Private Constants
71
  * @{
72
  */
73
 
74
/**
75
 * @brief STM32F1xx HAL Driver version number V1.0.1
76
   */
77
#define __STM32F1xx_HAL_VERSION_MAIN   (0x01) /*!< [31:24] main version */
78
#define __STM32F1xx_HAL_VERSION_SUB1   (0x00) /*!< [23:16] sub1 version */
79
#define __STM32F1xx_HAL_VERSION_SUB2   (0x01) /*!< [15:8]  sub2 version */
80
#define __STM32F1xx_HAL_VERSION_RC     (0x00) /*!< [7:0]  release candidate */
81
#define __STM32F1xx_HAL_VERSION         ((__STM32F1xx_HAL_VERSION_MAIN << 24)\
82
                                        |(__STM32F1xx_HAL_VERSION_SUB1 << 16)\
83
                                        |(__STM32F1xx_HAL_VERSION_SUB2 << 8 )\
84
                                        |(__STM32F1xx_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
static __IO uint32_t uwTick;
100
 
101
/**
102
  * @}
103
  */
104
 
105
/* Private function prototypes -----------------------------------------------*/
106
/* Exported 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
#if defined(STM32F101x6) || defined(STM32F101xB) || defined(STM32F101xE) || defined(STM32F101xG) || \
162
    defined(STM32F102x6) || defined(STM32F102xB) || \
163
    defined(STM32F103x6) || defined(STM32F103xB) || defined(STM32F103xE) || defined(STM32F103xG) || \
164
    defined(STM32F105xC) || defined(STM32F107xC)
165
 
166
  /* Prefetch buffer is not available on value line devices */
167
  __HAL_FLASH_PREFETCH_BUFFER_ENABLE();
168
#endif
169
#endif /* PREFETCH_ENABLE */
170
 
171
  /* Set Interrupt Group Priority */
172
  HAL_NVIC_SetPriorityGrouping(NVIC_PRIORITYGROUP_4);
173
 
174
  /* Use systick as time base source and configure 1ms tick (default clock after Reset is MSI) */
175
  HAL_InitTick(TICK_INT_PRIORITY);
176
 
177
  /* Init the low level hardware */
178
  HAL_MspInit();
179
 
180
  /* Return function status */
181
  return HAL_OK;
182
}
183
 
184
/**
185
  * @brief This function de-Initializes common part of the HAL and stops the source
186
  *        of time base.
187
  * @note This function is optional.
188
  * @retval HAL status
189
  */
190
HAL_StatusTypeDef HAL_DeInit(void)
191
{
192
  /* Reset of all peripherals */
193
  __HAL_RCC_APB1_FORCE_RESET();
194
  __HAL_RCC_APB1_RELEASE_RESET();
195
 
196
  __HAL_RCC_APB2_FORCE_RESET();
197
  __HAL_RCC_APB2_RELEASE_RESET();
198
 
199
#if defined(STM32F105xC) || defined(STM32F107xC)
200
  __HAL_RCC_AHB_FORCE_RESET();
201
  __HAL_RCC_AHB_RELEASE_RESET();
202
#endif
203
 
204
  /* De-Init the low level hardware */
205
  HAL_MspDeInit();
206
 
207
  /* Return function status */
208
  return HAL_OK;
209
}
210
 
211
/**
212
  * @brief  Initializes the MSP.
213
  * @retval None
214
  */
215
__weak void HAL_MspInit(void)
216
{
217
  /* NOTE : This function Should not be modified, when the callback is needed,
218
            the HAL_MspInit could be implemented in the user file
219
   */
220
}
221
 
222
/**
223
  * @brief  DeInitializes the MSP.
224
  * @retval None
225
  */
226
__weak void HAL_MspDeInit(void)
227
{
228
  /* NOTE : This function Should not be modified, when the callback is needed,
229
            the HAL_MspDeInit could be implemented in the user file
230
   */
231
}
232
 
233
/**
234
  * @brief This function configures the source of the time base.
235
  *        The time source is configured  to have 1ms time base with a dedicated
236
  *        Tick interrupt priority.
237
  * @note This function is called  automatically at the beginning of program after
238
  *       reset by HAL_Init() or at any time when clock is reconfigured  by HAL_RCC_ClockConfig().
239
  * @note In the default implementation, SysTick timer is the source of time base.
240
  *       It is used to generate interrupts at regular time intervals.
241
  *       Care must be taken if HAL_Delay() is called from a peripheral ISR process,
242
  *       The the SysTick interrupt must have higher priority (numerically lower)
243
  *       than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
244
  *       The function is declared as __Weak  to be overwritten  in case of other
245
  *       implementation  in user file.
246
  * @param TickPriority: Tick interrupt priority.
247
  * @retval HAL status
248
  */
249
__weak HAL_StatusTypeDef HAL_InitTick(uint32_t TickPriority)
250
{
251
  /*Configure the SysTick to have interrupt in 1ms time basis*/
252
  HAL_SYSTICK_Config(HAL_RCC_GetHCLKFreq()/1000);
253
 
254
  /*Configure the SysTick IRQ priority */
255
  HAL_NVIC_SetPriority(SysTick_IRQn, TickPriority ,0);
256
 
257
   /* Return function status */
258
  return HAL_OK;
259
}
260
 
261
/**
262
  * @}
263
  */
264
 
265
/** @defgroup HAL_Exported_Functions_Group2 HAL Control functions
266
 *  @brief    HAL Control functions
267
 *
268
@verbatim
269
 ===============================================================================
270
                      ##### HAL Control functions #####
271
 ===============================================================================
272
    [..]  This section provides functions allowing to:
273
      (+) Provide a tick value in millisecond
274
      (+) Provide a blocking delay in millisecond
275
      (+) Suspend the time base source interrupt
276
      (+) Resume the time base source interrupt
277
      (+) Get the HAL API driver version
278
      (+) Get the device identifier
279
      (+) Get the device revision identifier
280
      (+) Enable/Disable Debug module during Sleep mode
281
      (+) Enable/Disable Debug module during STOP mode
282
      (+) Enable/Disable Debug module during STANDBY mode
283
 
284
@endverbatim
285
  * @{
286
  */
287
 
288
/**
289
  * @brief This function is called to increment  a global variable "uwTick"
290
  *        used as application time base.
291
  * @note In the default implementation, this variable is incremented each 1ms
292
  *       in Systick ISR.
293
  * @note This function is declared as __weak to be overwritten in case of other
294
  *      implementations in user file.
295
  * @retval None
296
  */
297
__weak void HAL_IncTick(void)
298
{
299
  uwTick++;
300
}
301
 
302
/**
303
  * @brief Provides a tick value in millisecond.
304
  * @note   This function is declared as __weak  to be overwritten  in case of other
305
  *       implementations in user file.
306
  * @retval tick value
307
  */
308
__weak uint32_t HAL_GetTick(void)
309
{
310
  return uwTick;
311
}
312
 
313
/**
314
  * @brief This function provides accurate delay (in milliseconds) based
315
  *        on variable incremented.
316
  * @note In the default implementation , SysTick timer is the source of time base.
317
  *       It is used to generate interrupts at regular time intervals where uwTick
318
  *       is incremented.
319
  * @note ThiS function is declared as __weak to be overwritten in case of other
320
  *       implementations in user file.
321
  * @param Delay: specifies the delay time length, in milliseconds.
322
  * @retval None
323
  */
324
__weak void HAL_Delay(__IO uint32_t Delay)
325
{
326
  uint32_t tickstart = 0;
327
  tickstart = HAL_GetTick();
328
  while((HAL_GetTick() - tickstart) < Delay)
329
  {
330
  }
331
}
332
 
333
/**
334
  * @brief Suspend Tick increment.
335
  * @note In the default implementation , SysTick timer is the source of time base. It is
336
  *       used to generate interrupts at regular time intervals. Once HAL_SuspendTick()
337
  *       is called, the the SysTick interrupt will be disabled and so Tick increment
338
  *       is suspended.
339
  * @note This function is declared as __weak to be overwritten in case of other
340
  *       implementations in user file.
341
  * @retval None
342
  */
343
__weak void HAL_SuspendTick(void)
344
{
345
  /* Disable SysTick Interrupt */
346
  CLEAR_BIT(SysTick->CTRL,SysTick_CTRL_TICKINT_Msk);
347
}
348
 
349
/**
350
  * @brief Resume Tick increment.
351
  * @note In the default implementation , SysTick timer is the source of time base. It is
352
  *       used to generate interrupts at regular time intervals. Once HAL_ResumeTick()
353
  *       is called, the the SysTick interrupt will be enabled and so Tick increment
354
  *       is resumed.
355
  * @note This function is declared as __weak  to be overwritten  in case of other
356
  *       implementations in user file.
357
  * @retval None
358
  */
359
__weak void HAL_ResumeTick(void)
360
{
361
  /* Enable SysTick Interrupt */
362
  SET_BIT(SysTick->CTRL,SysTick_CTRL_TICKINT_Msk);
363
}
364
 
365
/**
366
  * @brief  This method returns the HAL revision
367
  * @retval version: 0xXYZR (8bits for each decimal, R for RC)
368
  */
369
uint32_t HAL_GetHalVersion(void)
370
{
371
 return __STM32F1xx_HAL_VERSION;
372
}
373
 
374
/**
375
  * @brief Returns the device revision identifier.
376
  * Note: On devices STM32F10xx8 and STM32F10xxB,
377
  *                  STM32F101xC/D/E and STM32F103xC/D/E,
378
  *                  STM32F101xF/G and STM32F103xF/G
379
  *                  STM32F10xx4 and STM32F10xx6
380
  *       Debug registers DBGMCU_IDCODE and DBGMCU_CR are accessible only in
381
  *       debug mode (not accessible by the user software in normal mode).
382
  *       Refer to errata sheet of these devices for more details.
383
  * @retval Device revision identifier
384
  */
385
uint32_t HAL_GetREVID(void)
386
{
387
  return((DBGMCU->IDCODE) >> POSITION_VAL(DBGMCU_IDCODE_REV_ID));
388
}
389
 
390
/**
391
  * @brief  Returns the device identifier.
392
  * Note: On devices STM32F10xx8 and STM32F10xxB,
393
  *                  STM32F101xC/D/E and STM32F103xC/D/E,
394
  *                  STM32F101xF/G and STM32F103xF/G
395
  *                  STM32F10xx4 and STM32F10xx6
396
  *       Debug registers DBGMCU_IDCODE and DBGMCU_CR are accessible only in
397
  *       debug mode (not accessible by the user software in normal mode).
398
  *       Refer to errata sheet of these devices for more details.
399
  * @retval Device identifier
400
  */
401
uint32_t HAL_GetDEVID(void)
402
{
403
   return((DBGMCU->IDCODE) & IDCODE_DEVID_MASK);
404
}
405
 
406
/**
407
  * @brief  Enable the Debug Module during SLEEP mode
408
  * @retval None
409
  */
410
void HAL_DBGMCU_EnableDBGSleepMode(void)
411
{
412
  SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_SLEEP);
413
}
414
 
415
/**
416
  * @brief  Disable the Debug Module during SLEEP mode
417
  * Note: On devices STM32F10xx8 and STM32F10xxB,
418
  *                  STM32F101xC/D/E and STM32F103xC/D/E,
419
  *                  STM32F101xF/G and STM32F103xF/G
420
  *                  STM32F10xx4 and STM32F10xx6
421
  *       Debug registers DBGMCU_IDCODE and DBGMCU_CR are accessible only in
422
  *       debug mode (not accessible by the user software in normal mode).
423
  *       Refer to errata sheet of these devices for more details.
424
  * @retval None
425
  */
426
void HAL_DBGMCU_DisableDBGSleepMode(void)
427
{
428
  CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_SLEEP);
429
}
430
 
431
/**
432
  * @brief  Enable the Debug Module during STOP mode
433
  * Note: On devices STM32F10xx8 and STM32F10xxB,
434
  *                  STM32F101xC/D/E and STM32F103xC/D/E,
435
  *                  STM32F101xF/G and STM32F103xF/G
436
  *                  STM32F10xx4 and STM32F10xx6
437
  *       Debug registers DBGMCU_IDCODE and DBGMCU_CR are accessible only in
438
  *       debug mode (not accessible by the user software in normal mode).
439
  *       Refer to errata sheet of these devices for more details.
440
  * Note: On all STM32F1 devices:
441
  *       If the system tick timer interrupt is enabled during the Stop mode
442
  *       debug (DBG_STOP bit set in the DBGMCU_CR register ), it will wakeup
443
  *       the system from Stop mode.
444
  *       Workaround: To debug the Stop mode, disable the system tick timer
445
  *       interrupt.
446
  *       Refer to errata sheet of these devices for more details.
447
  * Note: On all STM32F1 devices:
448
  *       If the system tick timer interrupt is enabled during the Stop mode  
449
  *       debug (DBG_STOP bit set in the DBGMCU_CR register ), it will wakeup
450
  *       the system from Stop mode.
451
  *       Workaround: To debug the Stop mode, disable the system tick timer
452
  *       interrupt.
453
  *       Refer to errata sheet of these devices for more details.
454
  * @retval None
455
  */
456
void HAL_DBGMCU_EnableDBGStopMode(void)
457
{
458
  SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_STOP);
459
}
460
 
461
/**
462
  * @brief  Disable the Debug Module during STOP mode
463
  * Note: On devices STM32F10xx8 and STM32F10xxB,
464
  *                  STM32F101xC/D/E and STM32F103xC/D/E,
465
  *                  STM32F101xF/G and STM32F103xF/G
466
  *                  STM32F10xx4 and STM32F10xx6
467
  *       Debug registers DBGMCU_IDCODE and DBGMCU_CR are accessible only in
468
  *       debug mode (not accessible by the user software in normal mode).
469
  *       Refer to errata sheet of these devices for more details.
470
  * @retval None
471
  */
472
void HAL_DBGMCU_DisableDBGStopMode(void)
473
{
474
  CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_STOP);
475
}
476
 
477
/**
478
  * @brief  Enable the Debug Module during STANDBY mode
479
  * Note: On devices STM32F10xx8 and STM32F10xxB,
480
  *                  STM32F101xC/D/E and STM32F103xC/D/E,
481
  *                  STM32F101xF/G and STM32F103xF/G
482
  *                  STM32F10xx4 and STM32F10xx6
483
  *       Debug registers DBGMCU_IDCODE and DBGMCU_CR are accessible only in
484
  *       debug mode (not accessible by the user software in normal mode).
485
  *       Refer to errata sheet of these devices for more details.
486
  * @retval None
487
  */
488
void HAL_DBGMCU_EnableDBGStandbyMode(void)
489
{
490
  SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_STANDBY);
491
}
492
 
493
/**
494
  * @brief  Disable the Debug Module during STANDBY mode
495
  * Note: On devices STM32F10xx8 and STM32F10xxB,
496
  *                  STM32F101xC/D/E and STM32F103xC/D/E,
497
  *                  STM32F101xF/G and STM32F103xF/G
498
  *                  STM32F10xx4 and STM32F10xx6
499
  *       Debug registers DBGMCU_IDCODE and DBGMCU_CR are accessible only in
500
  *       debug mode (not accessible by the user software in normal mode).
501
  *       Refer to errata sheet of these devices for more details.
502
  * @retval None
503
  */
504
void HAL_DBGMCU_DisableDBGStandbyMode(void)
505
{
506
  CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_STANDBY);
507
}
508
 
509
/**
510
  * @}
511
  */
512
 
513
/**
514
  * @}
515
  */
516
 
517
#endif /* HAL_MODULE_ENABLED */
518
/**
519
  * @}
520
  */
521
 
522
/**
523
  * @}
524
  */
525
 
526
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/