HAL
Select one of the symbols to view example projects that use it.
 
Outline
#include "stm32f4xx_hal.h"
Private define
#define PWR_OVERDRIVE_TIMEOUT_VALUE
#define PWR_UDERDRIVE_TIMEOUT_VALUE
#define PWR_BKPREG_TIMEOUT_VALUE
#define PWR_VOSRDY_TIMEOUT_VALUE
HAL_PWREx_EnableBkUpReg()
HAL_PWREx_DisableBkUpReg()
HAL_PWREx_EnableFlashPowerDown()
HAL_PWREx_DisableFlashPowerDown()
HAL_PWREx_GetVoltageRange()
HAL_PWREx_ControlVoltageScaling(uint32_t)
HAL_PWREx_EnableOverDrive()
HAL_PWREx_DisableOverDrive()
HAL_PWREx_EnterUnderDriveSTOPMode(uint32_t, uint8_t)
Files
loading...
SourceVuSTM32 Libraries and SamplesHALSrc/stm32f4xx_hal_pwr_ex.c
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/** ****************************************************************************** * @file stm32f4xx_hal_pwr_ex.c * @author MCD Application Team * @brief Extended PWR HAL module driver. * This file provides firmware functions to manage the following * functionalities of PWR extension peripheral: * + Peripheral Extended features functions * ****************************************************************************** * @attention * * Copyright (c) 2017 STMicroelectronics. * All rights reserved. * * This software is licensed under terms that can be found in the LICENSE file in * the root directory of this software component. * If no LICENSE file comes with this software, it is provided AS-IS. ****************************************************************************** *//* ... */ /* Includes ------------------------------------------------------------------*/ #include "stm32f4xx_hal.h" /** @addtogroup STM32F4xx_HAL_Driver * @{ *//* ... */ /** @defgroup PWREx PWREx * @brief PWR HAL module driver * @{ *//* ... */ #ifdef HAL_PWR_MODULE_ENABLED /* Private typedef -----------------------------------------------------------*/ /* Private define ------------------------------------------------------------*/ /** @addtogroup PWREx_Private_Constants * @{ *//* ... */ #define PWR_OVERDRIVE_TIMEOUT_VALUE 1000U #define PWR_UDERDRIVE_TIMEOUT_VALUE 1000U #define PWR_BKPREG_TIMEOUT_VALUE 1000U #define PWR_VOSRDY_TIMEOUT_VALUE 1000U /** * @} *//* ... */ Private define /* Private macro -------------------------------------------------------------*/ /* Private variables ---------------------------------------------------------*/ /* Private function prototypes -----------------------------------------------*/ /* Private functions ---------------------------------------------------------*/ /** @defgroup PWREx_Exported_Functions PWREx Exported Functions * @{ *//* ... */ /** @defgroup PWREx_Exported_Functions_Group1 Peripheral Extended features functions * @brief Peripheral Extended features functions * @verbatim =============================================================================== ##### Peripheral extended features functions ##### =============================================================================== *** Main and Backup Regulators configuration *** ================================================ [..] (+) The backup domain includes 4 Kbytes of backup SRAM accessible only from the CPU, and address in 32-bit, 16-bit or 8-bit mode. Its content is retained even in Standby or VBAT mode when the low power backup regulator is enabled. It can be considered as an internal EEPROM when VBAT is always present. You can use the HAL_PWREx_EnableBkUpReg() function to enable the low power backup regulator. (+) When the backup domain is supplied by VDD (analog switch connected to VDD) the backup SRAM is powered from VDD which replaces the VBAT power supply to save battery life. (+) The backup SRAM is not mass erased by a tamper event. It is read protected to prevent confidential data, such as cryptographic private key, from being accessed. The backup SRAM can be erased only through the Flash interface when a protection level change from level 1 to level 0 is requested. -@- Refer to the description of Read protection (RDP) in the Flash programming manual. (+) The main internal regulator can be configured to have a tradeoff between performance and power consumption when the device does not operate at the maximum frequency. This is done through __HAL_PWR_MAINREGULATORMODE_CONFIG() macro which configure VOS bit in PWR_CR register Refer to the product datasheets for more details. *** FLASH Power Down configuration **** ======================================= [..] (+) By setting the FPDS bit in the PWR_CR register by using the HAL_PWREx_EnableFlashPowerDown() function, the Flash memory also enters power down mode when the device enters Stop mode. When the Flash memory is in power down mode, an additional startup delay is incurred when waking up from Stop mode. (+) For STM32F42xxx/43xxx/446xx/469xx/479xx Devices, the scale can be modified only when the PLL is OFF and the HSI or HSE clock source is selected as system clock. The new value programmed is active only when the PLL is ON. When the PLL is OFF, the voltage scale 3 is automatically selected. Refer to the datasheets for more details. *** Over-Drive and Under-Drive configuration **** ================================================= [..] (+) For STM32F42xxx/43xxx/446xx/469xx/479xx Devices, in Run mode: the main regulator has 2 operating modes available: (++) Normal mode: The CPU and core logic operate at maximum frequency at a given voltage scaling (scale 1, scale 2 or scale 3) (++) Over-drive mode: This mode allows the CPU and the core logic to operate at a higher frequency than the normal mode for a given voltage scaling (scale 1, scale 2 or scale 3). This mode is enabled through HAL_PWREx_EnableOverDrive() function and disabled by HAL_PWREx_DisableOverDrive() function, to enter or exit from Over-drive mode please follow the sequence described in Reference manual. (+) For STM32F42xxx/43xxx/446xx/469xx/479xx Devices, in Stop mode: the main regulator or low power regulator supplies a low power voltage to the 1.2V domain, thus preserving the content of registers and internal SRAM. 2 operating modes are available: (++) Normal mode: the 1.2V domain is preserved in nominal leakage mode. This mode is only available when the main regulator or the low power regulator is used in Scale 3 or low voltage mode. (++) Under-drive mode: the 1.2V domain is preserved in reduced leakage mode. This mode is only available when the main regulator or the low power regulator is in low voltage mode. @endverbatim * @{ *//* ... */ /** * @brief Enables the Backup Regulator. * @retval HAL status *//* ... */ HAL_StatusTypeDef HAL_PWREx_EnableBkUpReg(void) { uint32_t tickstart = 0U; *(__IO uint32_t *) CSR_BRE_BB = (uint32_t)ENABLE; /* Get tick */ tickstart = HAL_GetTick(); /* Wait till Backup regulator ready flag is set */ while(__HAL_PWR_GET_FLAG(PWR_FLAG_BRR) == RESET) { if((HAL_GetTick() - tickstart ) > PWR_BKPREG_TIMEOUT_VALUE) { return HAL_TIMEOUT; }if ((HAL_GetTick() - tickstart ) > PWR_BKPREG_TIMEOUT_VALUE) { ... } }while (__HAL_PWR_GET_FLAG(PWR_FLAG_BRR) == RESET) { ... } return HAL_OK; }{ ... } /** * @brief Disables the Backup Regulator. * @retval HAL status *//* ... */ HAL_StatusTypeDef HAL_PWREx_DisableBkUpReg(void) { uint32_t tickstart = 0U; *(__IO uint32_t *) CSR_BRE_BB = (uint32_t)DISABLE; /* Get tick */ tickstart = HAL_GetTick(); /* Wait till Backup regulator ready flag is set */ while(__HAL_PWR_GET_FLAG(PWR_FLAG_BRR) != RESET) { if((HAL_GetTick() - tickstart ) > PWR_BKPREG_TIMEOUT_VALUE) { return HAL_TIMEOUT; }if ((HAL_GetTick() - tickstart ) > PWR_BKPREG_TIMEOUT_VALUE) { ... } }while (__HAL_PWR_GET_FLAG(PWR_FLAG_BRR) != RESET) { ... } return HAL_OK; }{ ... } /** * @brief Enables the Flash Power Down in Stop mode. * @retval None *//* ... */ void HAL_PWREx_EnableFlashPowerDown(void) { *(__IO uint32_t *) CR_FPDS_BB = (uint32_t)ENABLE; }{ ... } /** * @brief Disables the Flash Power Down in Stop mode. * @retval None *//* ... */ void HAL_PWREx_DisableFlashPowerDown(void) { *(__IO uint32_t *) CR_FPDS_BB = (uint32_t)DISABLE; }{ ... } /** * @brief Return Voltage Scaling Range. * @retval The configured scale for the regulator voltage(VOS bit field). * The returned value can be one of the following: * - @arg PWR_REGULATOR_VOLTAGE_SCALE1: Regulator voltage output Scale 1 mode * - @arg PWR_REGULATOR_VOLTAGE_SCALE2: Regulator voltage output Scale 2 mode * - @arg PWR_REGULATOR_VOLTAGE_SCALE3: Regulator voltage output Scale 3 mode *//* ... */ uint32_t HAL_PWREx_GetVoltageRange(void) { return (PWR->CR & PWR_CR_VOS); }{ ... } #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) /** * @brief Configures the main internal regulator output voltage. * @param VoltageScaling specifies the regulator output voltage to achieve * a tradeoff between performance and power consumption. * This parameter can be one of the following values: * @arg PWR_REGULATOR_VOLTAGE_SCALE1: Regulator voltage output range 1 mode, * the maximum value of fHCLK = 168 MHz. * @arg PWR_REGULATOR_VOLTAGE_SCALE2: Regulator voltage output range 2 mode, * the maximum value of fHCLK = 144 MHz. * @note When moving from Range 1 to Range 2, the system frequency must be decreased to * a value below 144 MHz before calling HAL_PWREx_ConfigVoltageScaling() API. * When moving from Range 2 to Range 1, the system frequency can be increased to * a value up to 168 MHz after calling HAL_PWREx_ConfigVoltageScaling() API. * @retval HAL Status *//* ... */ HAL_StatusTypeDef HAL_PWREx_ControlVoltageScaling(uint32_t VoltageScaling) { uint32_t tickstart = 0U; assert_param(IS_PWR_VOLTAGE_SCALING_RANGE(VoltageScaling)); /* Enable PWR RCC Clock Peripheral */ __HAL_RCC_PWR_CLK_ENABLE(); /* Set Range */ __HAL_PWR_VOLTAGESCALING_CONFIG(VoltageScaling); /* Get Start Tick*/ tickstart = HAL_GetTick(); while((__HAL_PWR_GET_FLAG(PWR_FLAG_VOSRDY) == RESET)) { if((HAL_GetTick() - tickstart ) > PWR_VOSRDY_TIMEOUT_VALUE) { return HAL_TIMEOUT; }if ((HAL_GetTick() - tickstart ) > PWR_VOSRDY_TIMEOUT_VALUE) { ... } }while ((__HAL_PWR_GET_FLAG(PWR_FLAG_VOSRDY) == RESET)) { ... } return HAL_OK; }HAL_PWREx_ControlVoltageScaling (uint32_t VoltageScaling) { ... } /* ... */ #elif defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \ defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F410Tx) || defined(STM32F410Cx) || \ defined(STM32F410Rx) || defined(STM32F411xE) || defined(STM32F446xx) || defined(STM32F469xx) || \ defined(STM32F479xx) || defined(STM32F412Zx) || defined(STM32F412Vx) || defined(STM32F412Rx) || \ defined(STM32F412Cx) || defined(STM32F413xx) || defined(STM32F423xx) /** * @brief Configures the main internal regulator output voltage. * @param VoltageScaling specifies the regulator output voltage to achieve * a tradeoff between performance and power consumption. * This parameter can be one of the following values: * @arg PWR_REGULATOR_VOLTAGE_SCALE1: Regulator voltage output range 1 mode, * the maximum value of fHCLK is 168 MHz. It can be extended to * 180 MHz by activating the over-drive mode. * @arg PWR_REGULATOR_VOLTAGE_SCALE2: Regulator voltage output range 2 mode, * the maximum value of fHCLK is 144 MHz. It can be extended to, * 168 MHz by activating the over-drive mode. * @arg PWR_REGULATOR_VOLTAGE_SCALE3: Regulator voltage output range 3 mode, * the maximum value of fHCLK is 120 MHz. * @note To update the system clock frequency(SYSCLK): * - Set the HSI or HSE as system clock frequency using the HAL_RCC_ClockConfig(). * - Call the HAL_RCC_OscConfig() to configure the PLL. * - Call HAL_PWREx_ConfigVoltageScaling() API to adjust the voltage scale. * - Set the new system clock frequency using the HAL_RCC_ClockConfig(). * @note The scale can be modified only when the HSI or HSE clock source is selected * as system clock source, otherwise the API returns HAL_ERROR. * @note When the PLL is OFF, the voltage scale 3 is automatically selected and the VOS bits * value in the PWR_CR1 register are not taken in account. * @note This API forces the PLL state ON to allow the possibility to configure the voltage scale 1 or 2. * @note The new voltage scale is active only when the PLL is ON. * @retval HAL Status *//* ... */ HAL_StatusTypeDef HAL_PWREx_ControlVoltageScaling(uint32_t VoltageScaling) { uint32_t tickstart = 0U; assert_param(IS_PWR_VOLTAGE_SCALING_RANGE(VoltageScaling)); /* Enable PWR RCC Clock Peripheral */ __HAL_RCC_PWR_CLK_ENABLE(); /* Check if the PLL is used as system clock or not */ if(__HAL_RCC_GET_SYSCLK_SOURCE() != RCC_CFGR_SWS_PLL) { /* Disable the main PLL */ __HAL_RCC_PLL_DISABLE(); /* Get Start Tick */ tickstart = HAL_GetTick(); /* Wait till PLL is disabled */ while(__HAL_RCC_GET_FLAG(RCC_FLAG_PLLRDY) != RESET) { if((HAL_GetTick() - tickstart ) > PLL_TIMEOUT_VALUE) { return HAL_TIMEOUT; }if ((HAL_GetTick() - tickstart ) > PLL_TIMEOUT_VALUE) { ... } }while (__HAL_RCC_GET_FLAG(RCC_FLAG_PLLRDY) != RESET) { ... } /* Set Range */ __HAL_PWR_VOLTAGESCALING_CONFIG(VoltageScaling); /* Enable the main PLL */ __HAL_RCC_PLL_ENABLE(); /* Get Start Tick */ tickstart = HAL_GetTick(); /* Wait till PLL is ready */ while(__HAL_RCC_GET_FLAG(RCC_FLAG_PLLRDY) == RESET) { if((HAL_GetTick() - tickstart ) > PLL_TIMEOUT_VALUE) { return HAL_TIMEOUT; }if ((HAL_GetTick() - tickstart ) > PLL_TIMEOUT_VALUE) { ... } }while (__HAL_RCC_GET_FLAG(RCC_FLAG_PLLRDY) == RESET) { ... } /* Get Start Tick */ tickstart = HAL_GetTick(); while((__HAL_PWR_GET_FLAG(PWR_FLAG_VOSRDY) == RESET)) { if((HAL_GetTick() - tickstart ) > PWR_VOSRDY_TIMEOUT_VALUE) { return HAL_TIMEOUT; }if ((HAL_GetTick() - tickstart ) > PWR_VOSRDY_TIMEOUT_VALUE) { ... } }while ((__HAL_PWR_GET_FLAG(PWR_FLAG_VOSRDY) == RESET)) { ... } }if (__HAL_RCC_GET_SYSCLK_SOURCE() != RCC_CFGR_SWS_PLL) { ... } else { return HAL_ERROR; }else { ... } return HAL_OK; }{ ... } #endif/* ... */ /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx */ #if defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F410Tx) || defined(STM32F410Cx) || defined(STM32F410Rx) ||\ defined(STM32F411xE) || defined(STM32F412Zx) || defined(STM32F412Vx) || defined(STM32F412Rx) || defined(STM32F412Cx) ||\ defined(STM32F413xx) || defined(STM32F423xx) /** * @brief Enables Main Regulator low voltage mode. * @note This mode is only available for STM32F401xx/STM32F410xx/STM32F411xx/STM32F412Zx/STM32F412Rx/STM32F412Vx/STM32F412Cx/ * STM32F413xx/STM32F423xx devices. * @retval None *//* ... */ void HAL_PWREx_EnableMainRegulatorLowVoltage(void) { *(__IO uint32_t *) CR_MRLVDS_BB = (uint32_t)ENABLE; }HAL_PWREx_EnableMainRegulatorLowVoltage (void) { ... } /** * @brief Disables Main Regulator low voltage mode. * @note This mode is only available for STM32F401xx/STM32F410xx/STM32F411xx/STM32F412Zx/STM32F412Rx/STM32F412Vx/STM32F412Cx/ * STM32F413xx/STM32F423xxdevices. * @retval None *//* ... */ void HAL_PWREx_DisableMainRegulatorLowVoltage(void) { *(__IO uint32_t *) CR_MRLVDS_BB = (uint32_t)DISABLE; }HAL_PWREx_DisableMainRegulatorLowVoltage (void) { ... } /** * @brief Enables Low Power Regulator low voltage mode. * @note This mode is only available for STM32F401xx/STM32F410xx/STM32F411xx/STM32F412Zx/STM32F412Rx/STM32F412Vx/STM32F412Cx/ * STM32F413xx/STM32F423xx devices. * @retval None *//* ... */ void HAL_PWREx_EnableLowRegulatorLowVoltage(void) { *(__IO uint32_t *) CR_LPLVDS_BB = (uint32_t)ENABLE; }HAL_PWREx_EnableLowRegulatorLowVoltage (void) { ... } /** * @brief Disables Low Power Regulator low voltage mode. * @note This mode is only available for STM32F401xx/STM32F410xx/STM32F411xx/STM32F412Zx/STM32F412Rx/STM32F412Vx/STM32F412Cx/ * STM32F413xx/STM32F423xx devices. * @retval None *//* ... */ void HAL_PWREx_DisableLowRegulatorLowVoltage(void) { *(__IO uint32_t *) CR_LPLVDS_BB = (uint32_t)DISABLE; }HAL_PWREx_DisableLowRegulatorLowVoltage (void) { ... } /* ... */ #endif /* STM32F401xC || STM32F401xE || STM32F410xx || STM32F411xE || STM32F412Zx || STM32F412Rx || STM32F412Vx || STM32F412Cx || STM32F413xx || STM32F423xx *//* ... */ #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\ defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx) /** * @brief Activates the Over-Drive mode. * @note This function can be used only for STM32F42xx/STM32F43xx/STM32F446xx/STM32F469xx/STM32F479xx devices. * This mode allows the CPU and the core logic to operate at a higher frequency * than the normal mode for a given voltage scaling (scale 1, scale 2 or scale 3). * @note It is recommended to enter or exit Over-drive mode when the application is not running * critical tasks and when the system clock source is either HSI or HSE. * During the Over-drive switch activation, no peripheral clocks should be enabled. * The peripheral clocks must be enabled once the Over-drive mode is activated. * @retval HAL status *//* ... */ HAL_StatusTypeDef HAL_PWREx_EnableOverDrive(void) { uint32_t tickstart = 0U; __HAL_RCC_PWR_CLK_ENABLE(); /* Enable the Over-drive to extend the clock frequency to 180 Mhz */ __HAL_PWR_OVERDRIVE_ENABLE(); /* Get tick */ tickstart = HAL_GetTick(); while(!__HAL_PWR_GET_FLAG(PWR_FLAG_ODRDY)) { if((HAL_GetTick() - tickstart) > PWR_OVERDRIVE_TIMEOUT_VALUE) { return HAL_TIMEOUT; }if ((HAL_GetTick() - tickstart) > PWR_OVERDRIVE_TIMEOUT_VALUE) { ... } }while (!__HAL_PWR_GET_FLAG(PWR_FLAG_ODRDY)) { ... } /* Enable the Over-drive switch */ __HAL_PWR_OVERDRIVESWITCHING_ENABLE(); /* Get tick */ tickstart = HAL_GetTick(); while(!__HAL_PWR_GET_FLAG(PWR_FLAG_ODSWRDY)) { if((HAL_GetTick() - tickstart ) > PWR_OVERDRIVE_TIMEOUT_VALUE) { return HAL_TIMEOUT; }if ((HAL_GetTick() - tickstart ) > PWR_OVERDRIVE_TIMEOUT_VALUE) { ... } }while (!__HAL_PWR_GET_FLAG(PWR_FLAG_ODSWRDY)) { ... } return HAL_OK; }{ ... } /** * @brief Deactivates the Over-Drive mode. * @note This function can be used only for STM32F42xx/STM32F43xx/STM32F446xx/STM32F469xx/STM32F479xx devices. * This mode allows the CPU and the core logic to operate at a higher frequency * than the normal mode for a given voltage scaling (scale 1, scale 2 or scale 3). * @note It is recommended to enter or exit Over-drive mode when the application is not running * critical tasks and when the system clock source is either HSI or HSE. * During the Over-drive switch activation, no peripheral clocks should be enabled. * The peripheral clocks must be enabled once the Over-drive mode is activated. * @retval HAL status *//* ... */ HAL_StatusTypeDef HAL_PWREx_DisableOverDrive(void) { uint32_t tickstart = 0U; __HAL_RCC_PWR_CLK_ENABLE(); /* Disable the Over-drive switch */ __HAL_PWR_OVERDRIVESWITCHING_DISABLE(); /* Get tick */ tickstart = HAL_GetTick(); while(__HAL_PWR_GET_FLAG(PWR_FLAG_ODSWRDY)) { if((HAL_GetTick() - tickstart) > PWR_OVERDRIVE_TIMEOUT_VALUE) { return HAL_TIMEOUT; }if ((HAL_GetTick() - tickstart) > PWR_OVERDRIVE_TIMEOUT_VALUE) { ... } }while (__HAL_PWR_GET_FLAG(PWR_FLAG_ODSWRDY)) { ... } /* Disable the Over-drive */ __HAL_PWR_OVERDRIVE_DISABLE(); /* Get tick */ tickstart = HAL_GetTick(); while(__HAL_PWR_GET_FLAG(PWR_FLAG_ODRDY)) { if((HAL_GetTick() - tickstart) > PWR_OVERDRIVE_TIMEOUT_VALUE) { return HAL_TIMEOUT; }if ((HAL_GetTick() - tickstart) > PWR_OVERDRIVE_TIMEOUT_VALUE) { ... } }while (__HAL_PWR_GET_FLAG(PWR_FLAG_ODRDY)) { ... } return HAL_OK; }{ ... } /** * @brief Enters in Under-Drive STOP mode. * * @note This mode is only available for STM32F42xxx/STM32F43xxx/STM32F446xx/STM32F469xx/STM32F479xx devices. * * @note This mode can be selected only when the Under-Drive is already active * * @note This mode is enabled only with STOP low power mode. * In this mode, the 1.2V domain is preserved in reduced leakage mode. This * mode is only available when the main regulator or the low power regulator * is in low voltage mode * * @note If the Under-drive mode was enabled, it is automatically disabled after * exiting Stop mode. * When the voltage regulator operates in Under-drive mode, an additional * startup delay is induced when waking up from Stop mode. * * @note In Stop mode, all I/O pins keep the same state as in Run mode. * * @note When exiting Stop mode by issuing an interrupt or a wake-up event, * the HSI RC oscillator is selected as system clock. * * @note When the voltage regulator operates in low power mode, an additional * startup delay is incurred when waking up from Stop mode. * By keeping the internal regulator ON during Stop mode, the consumption * is higher although the startup time is reduced. * * @param Regulator specifies the regulator state in STOP mode. * This parameter can be one of the following values: * @arg PWR_MAINREGULATOR_UNDERDRIVE_ON: Main Regulator in under-drive mode * and Flash memory in power-down when the device is in Stop under-drive mode * @arg PWR_LOWPOWERREGULATOR_UNDERDRIVE_ON: Low Power Regulator in under-drive mode * and Flash memory in power-down when the device is in Stop under-drive mode * @param STOPEntry specifies if STOP mode in entered with WFI or WFE instruction. * This parameter can be one of the following values: * @arg PWR_SLEEPENTRY_WFI: enter STOP mode with WFI instruction * @arg PWR_SLEEPENTRY_WFE: enter STOP mode with WFE instruction * @retval None *//* ... */ HAL_StatusTypeDef HAL_PWREx_EnterUnderDriveSTOPMode(uint32_t Regulator, uint8_t STOPEntry) { uint32_t tmpreg1 = 0U; /* Check the parameters */ assert_param(IS_PWR_REGULATOR_UNDERDRIVE(Regulator)); assert_param(IS_PWR_STOP_ENTRY(STOPEntry)); /* Enable Power ctrl clock */ __HAL_RCC_PWR_CLK_ENABLE(); /* Enable the Under-drive Mode ---------------------------------------------*/ /* Clear Under-drive flag */ __HAL_PWR_CLEAR_ODRUDR_FLAG(); /* Enable the Under-drive */ __HAL_PWR_UNDERDRIVE_ENABLE(); Enable the Under-drive Mode /* Select the regulator state in STOP mode ---------------------------------*/ tmpreg1 = PWR->CR; /* Clear PDDS, LPDS, MRLUDS and LPLUDS bits */ tmpreg1 &= (uint32_t)~(PWR_CR_PDDS | PWR_CR_LPDS | PWR_CR_LPUDS | PWR_CR_MRUDS); /* Set LPDS, MRLUDS and LPLUDS bits according to PWR_Regulator value */ tmpreg1 |= Regulator; /* Store the new value */ PWR->CR = tmpreg1; /* Set SLEEPDEEP bit of Cortex System Control Register */ SCB->SCR |= SCB_SCR_SLEEPDEEP_Msk; Select the regulator state in STOP mode /* Select STOP mode entry --------------------------------------------------*/ if(STOPEntry == PWR_SLEEPENTRY_WFI) { /* Request Wait For Interrupt */ __WFI(); }if (STOPEntry == PWR_SLEEPENTRY_WFI) { ... } else { /* Request Wait For Event */ __WFE(); }else { ... } /* Reset SLEEPDEEP bit of Cortex System Control Register */ SCB->SCR &= (uint32_t)~((uint32_t)SCB_SCR_SLEEPDEEP_Msk); return HAL_OK; }{ ... } /* ... */#endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx */ /** * @} *//* ... */ /** * @} *//* ... */ /* ... */ #endif /* HAL_PWR_MODULE_ENABLED */ /** * @} *//* ... */ /** * @} *//* ... */
Details