STM32F4xx_HAL_Driver  1.8.3
stm32f4xx_ll_cortex.h
Go to the documentation of this file.
1 
34 /* Define to prevent recursive inclusion -------------------------------------*/
35 #ifndef __STM32F4xx_LL_CORTEX_H
36 #define __STM32F4xx_LL_CORTEX_H
37 
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 /* Includes ------------------------------------------------------------------*/
43 #include "stm32f4xx.h"
44 
53 /* Private types -------------------------------------------------------------*/
54 /* Private variables ---------------------------------------------------------*/
55 
56 /* Private constants ---------------------------------------------------------*/
57 
58 /* Private macros ------------------------------------------------------------*/
59 
60 /* Exported types ------------------------------------------------------------*/
61 /* Exported constants --------------------------------------------------------*/
69 #define LL_SYSTICK_CLKSOURCE_HCLK_DIV8 0x00000000U
70 #define LL_SYSTICK_CLKSOURCE_HCLK SysTick_CTRL_CLKSOURCE_Msk
78 #define LL_HANDLER_FAULT_USG SCB_SHCSR_USGFAULTENA_Msk
79 #define LL_HANDLER_FAULT_BUS SCB_SHCSR_BUSFAULTENA_Msk
80 #define LL_HANDLER_FAULT_MEM SCB_SHCSR_MEMFAULTENA_Msk
85 #if __MPU_PRESENT
86 
90 #define LL_MPU_CTRL_HFNMI_PRIVDEF_NONE 0x00000000U
91 #define LL_MPU_CTRL_HARDFAULT_NMI MPU_CTRL_HFNMIENA_Msk
92 #define LL_MPU_CTRL_PRIVILEGED_DEFAULT MPU_CTRL_PRIVDEFENA_Msk
93 #define LL_MPU_CTRL_HFNMI_PRIVDEF (MPU_CTRL_HFNMIENA_Msk | MPU_CTRL_PRIVDEFENA_Msk)
101 #define LL_MPU_REGION_NUMBER0 0x00U
102 #define LL_MPU_REGION_NUMBER1 0x01U
103 #define LL_MPU_REGION_NUMBER2 0x02U
104 #define LL_MPU_REGION_NUMBER3 0x03U
105 #define LL_MPU_REGION_NUMBER4 0x04U
106 #define LL_MPU_REGION_NUMBER5 0x05U
107 #define LL_MPU_REGION_NUMBER6 0x06U
108 #define LL_MPU_REGION_NUMBER7 0x07U
116 #define LL_MPU_REGION_SIZE_32B (0x04U << MPU_RASR_SIZE_Pos)
117 #define LL_MPU_REGION_SIZE_64B (0x05U << MPU_RASR_SIZE_Pos)
118 #define LL_MPU_REGION_SIZE_128B (0x06U << MPU_RASR_SIZE_Pos)
119 #define LL_MPU_REGION_SIZE_256B (0x07U << MPU_RASR_SIZE_Pos)
120 #define LL_MPU_REGION_SIZE_512B (0x08U << MPU_RASR_SIZE_Pos)
121 #define LL_MPU_REGION_SIZE_1KB (0x09U << MPU_RASR_SIZE_Pos)
122 #define LL_MPU_REGION_SIZE_2KB (0x0AU << MPU_RASR_SIZE_Pos)
123 #define LL_MPU_REGION_SIZE_4KB (0x0BU << MPU_RASR_SIZE_Pos)
124 #define LL_MPU_REGION_SIZE_8KB (0x0CU << MPU_RASR_SIZE_Pos)
125 #define LL_MPU_REGION_SIZE_16KB (0x0DU << MPU_RASR_SIZE_Pos)
126 #define LL_MPU_REGION_SIZE_32KB (0x0EU << MPU_RASR_SIZE_Pos)
127 #define LL_MPU_REGION_SIZE_64KB (0x0FU << MPU_RASR_SIZE_Pos)
128 #define LL_MPU_REGION_SIZE_128KB (0x10U << MPU_RASR_SIZE_Pos)
129 #define LL_MPU_REGION_SIZE_256KB (0x11U << MPU_RASR_SIZE_Pos)
130 #define LL_MPU_REGION_SIZE_512KB (0x12U << MPU_RASR_SIZE_Pos)
131 #define LL_MPU_REGION_SIZE_1MB (0x13U << MPU_RASR_SIZE_Pos)
132 #define LL_MPU_REGION_SIZE_2MB (0x14U << MPU_RASR_SIZE_Pos)
133 #define LL_MPU_REGION_SIZE_4MB (0x15U << MPU_RASR_SIZE_Pos)
134 #define LL_MPU_REGION_SIZE_8MB (0x16U << MPU_RASR_SIZE_Pos)
135 #define LL_MPU_REGION_SIZE_16MB (0x17U << MPU_RASR_SIZE_Pos)
136 #define LL_MPU_REGION_SIZE_32MB (0x18U << MPU_RASR_SIZE_Pos)
137 #define LL_MPU_REGION_SIZE_64MB (0x19U << MPU_RASR_SIZE_Pos)
138 #define LL_MPU_REGION_SIZE_128MB (0x1AU << MPU_RASR_SIZE_Pos)
139 #define LL_MPU_REGION_SIZE_256MB (0x1BU << MPU_RASR_SIZE_Pos)
140 #define LL_MPU_REGION_SIZE_512MB (0x1CU << MPU_RASR_SIZE_Pos)
141 #define LL_MPU_REGION_SIZE_1GB (0x1DU << MPU_RASR_SIZE_Pos)
142 #define LL_MPU_REGION_SIZE_2GB (0x1EU << MPU_RASR_SIZE_Pos)
143 #define LL_MPU_REGION_SIZE_4GB (0x1FU << MPU_RASR_SIZE_Pos)
151 #define LL_MPU_REGION_NO_ACCESS (0x00U << MPU_RASR_AP_Pos)
152 #define LL_MPU_REGION_PRIV_RW (0x01U << MPU_RASR_AP_Pos)
153 #define LL_MPU_REGION_PRIV_RW_URO (0x02U << MPU_RASR_AP_Pos)
154 #define LL_MPU_REGION_FULL_ACCESS (0x03U << MPU_RASR_AP_Pos)
155 #define LL_MPU_REGION_PRIV_RO (0x05U << MPU_RASR_AP_Pos)
156 #define LL_MPU_REGION_PRIV_RO_URO (0x06U << MPU_RASR_AP_Pos)
164 #define LL_MPU_TEX_LEVEL0 (0x00U << MPU_RASR_TEX_Pos)
165 #define LL_MPU_TEX_LEVEL1 (0x01U << MPU_RASR_TEX_Pos)
166 #define LL_MPU_TEX_LEVEL2 (0x02U << MPU_RASR_TEX_Pos)
167 #define LL_MPU_TEX_LEVEL4 (0x04U << MPU_RASR_TEX_Pos)
175 #define LL_MPU_INSTRUCTION_ACCESS_ENABLE 0x00U
176 #define LL_MPU_INSTRUCTION_ACCESS_DISABLE MPU_RASR_XN_Msk
184 #define LL_MPU_ACCESS_SHAREABLE MPU_RASR_S_Msk
185 #define LL_MPU_ACCESS_NOT_SHAREABLE 0x00U
193 #define LL_MPU_ACCESS_CACHEABLE MPU_RASR_C_Msk
194 #define LL_MPU_ACCESS_NOT_CACHEABLE 0x00U
202 #define LL_MPU_ACCESS_BUFFERABLE MPU_RASR_B_Msk
203 #define LL_MPU_ACCESS_NOT_BUFFERABLE 0x00U
207 #endif /* __MPU_PRESENT */
212 /* Exported macro ------------------------------------------------------------*/
213 
214 /* Exported functions --------------------------------------------------------*/
229 __STATIC_INLINE uint32_t LL_SYSTICK_IsActiveCounterFlag(void)
230 {
231  return ((SysTick->CTRL & SysTick_CTRL_COUNTFLAG_Msk) == (SysTick_CTRL_COUNTFLAG_Msk));
232 }
233 
242 __STATIC_INLINE void LL_SYSTICK_SetClkSource(uint32_t Source)
243 {
244  if (Source == LL_SYSTICK_CLKSOURCE_HCLK)
245  {
246  SET_BIT(SysTick->CTRL, LL_SYSTICK_CLKSOURCE_HCLK);
247  }
248  else
249  {
250  CLEAR_BIT(SysTick->CTRL, LL_SYSTICK_CLKSOURCE_HCLK);
251  }
252 }
253 
261 __STATIC_INLINE uint32_t LL_SYSTICK_GetClkSource(void)
262 {
263  return READ_BIT(SysTick->CTRL, LL_SYSTICK_CLKSOURCE_HCLK);
264 }
265 
271 __STATIC_INLINE void LL_SYSTICK_EnableIT(void)
272 {
273  SET_BIT(SysTick->CTRL, SysTick_CTRL_TICKINT_Msk);
274 }
275 
281 __STATIC_INLINE void LL_SYSTICK_DisableIT(void)
282 {
283  CLEAR_BIT(SysTick->CTRL, SysTick_CTRL_TICKINT_Msk);
284 }
285 
291 __STATIC_INLINE uint32_t LL_SYSTICK_IsEnabledIT(void)
292 {
293  return (READ_BIT(SysTick->CTRL, SysTick_CTRL_TICKINT_Msk) == (SysTick_CTRL_TICKINT_Msk));
294 }
295 
309 __STATIC_INLINE void LL_LPM_EnableSleep(void)
310 {
311  /* Clear SLEEPDEEP bit of Cortex System Control Register */
312  CLEAR_BIT(SCB->SCR, ((uint32_t)SCB_SCR_SLEEPDEEP_Msk));
313 }
314 
320 __STATIC_INLINE void LL_LPM_EnableDeepSleep(void)
321 {
322  /* Set SLEEPDEEP bit of Cortex System Control Register */
323  SET_BIT(SCB->SCR, ((uint32_t)SCB_SCR_SLEEPDEEP_Msk));
324 }
325 
333 __STATIC_INLINE void LL_LPM_EnableSleepOnExit(void)
334 {
335  /* Set SLEEPONEXIT bit of Cortex System Control Register */
336  SET_BIT(SCB->SCR, ((uint32_t)SCB_SCR_SLEEPONEXIT_Msk));
337 }
338 
344 __STATIC_INLINE void LL_LPM_DisableSleepOnExit(void)
345 {
346  /* Clear SLEEPONEXIT bit of Cortex System Control Register */
347  CLEAR_BIT(SCB->SCR, ((uint32_t)SCB_SCR_SLEEPONEXIT_Msk));
348 }
349 
356 __STATIC_INLINE void LL_LPM_EnableEventOnPend(void)
357 {
358  /* Set SEVEONPEND bit of Cortex System Control Register */
359  SET_BIT(SCB->SCR, ((uint32_t)SCB_SCR_SEVONPEND_Msk));
360 }
361 
368 __STATIC_INLINE void LL_LPM_DisableEventOnPend(void)
369 {
370  /* Clear SEVEONPEND bit of Cortex System Control Register */
371  CLEAR_BIT(SCB->SCR, ((uint32_t)SCB_SCR_SEVONPEND_Msk));
372 }
373 
378 __STATIC_INLINE void LL_LPM_ClearEvent(void)
379 {
380  __SEV();
381  __WFE();
382 }
383 
401 __STATIC_INLINE void LL_HANDLER_EnableFault(uint32_t Fault)
402 {
403  /* Enable the system handler fault */
404  SET_BIT(SCB->SHCSR, Fault);
405 }
406 
416 __STATIC_INLINE void LL_HANDLER_DisableFault(uint32_t Fault)
417 {
418  /* Disable the system handler fault */
419  CLEAR_BIT(SCB->SHCSR, Fault);
420 }
421 
435 __STATIC_INLINE uint32_t LL_CPUID_GetImplementer(void)
436 {
437  return (uint32_t)(READ_BIT(SCB->CPUID, SCB_CPUID_IMPLEMENTER_Msk) >> SCB_CPUID_IMPLEMENTER_Pos);
438 }
439 
445 __STATIC_INLINE uint32_t LL_CPUID_GetVariant(void)
446 {
447  return (uint32_t)(READ_BIT(SCB->CPUID, SCB_CPUID_VARIANT_Msk) >> SCB_CPUID_VARIANT_Pos);
448 }
449 
455 __STATIC_INLINE uint32_t LL_CPUID_GetConstant(void)
456 {
457  return (uint32_t)(READ_BIT(SCB->CPUID, SCB_CPUID_ARCHITECTURE_Msk) >> SCB_CPUID_ARCHITECTURE_Pos);
458 }
459 
465 __STATIC_INLINE uint32_t LL_CPUID_GetParNo(void)
466 {
467  return (uint32_t)(READ_BIT(SCB->CPUID, SCB_CPUID_PARTNO_Msk) >> SCB_CPUID_PARTNO_Pos);
468 }
469 
475 __STATIC_INLINE uint32_t LL_CPUID_GetRevision(void)
476 {
477  return (uint32_t)(READ_BIT(SCB->CPUID, SCB_CPUID_REVISION_Msk) >> SCB_CPUID_REVISION_Pos);
478 }
479 
484 #if __MPU_PRESENT
499 __STATIC_INLINE void LL_MPU_Enable(uint32_t Options)
500 {
501  /* Enable the MPU*/
502  WRITE_REG(MPU->CTRL, (MPU_CTRL_ENABLE_Msk | Options));
503  /* Ensure MPU settings take effects */
504  __DSB();
505  /* Sequence instruction fetches using update settings */
506  __ISB();
507 }
508 
514 __STATIC_INLINE void LL_MPU_Disable(void)
515 {
516  /* Make sure outstanding transfers are done */
517  __DMB();
518  /* Disable MPU*/
519  WRITE_REG(MPU->CTRL, 0U);
520 }
521 
527 __STATIC_INLINE uint32_t LL_MPU_IsEnabled(void)
528 {
529  return (READ_BIT(MPU->CTRL, MPU_CTRL_ENABLE_Msk) == (MPU_CTRL_ENABLE_Msk));
530 }
531 
546 __STATIC_INLINE void LL_MPU_EnableRegion(uint32_t Region)
547 {
548  /* Set Region number */
549  WRITE_REG(MPU->RNR, Region);
550  /* Enable the MPU region */
551  SET_BIT(MPU->RASR, MPU_RASR_ENABLE_Msk);
552 }
553 
592 __STATIC_INLINE void LL_MPU_ConfigRegion(uint32_t Region, uint32_t SubRegionDisable, uint32_t Address, uint32_t Attributes)
593 {
594  /* Set Region number */
595  WRITE_REG(MPU->RNR, Region);
596  /* Set base address */
597  WRITE_REG(MPU->RBAR, (Address & 0xFFFFFFE0U));
598  /* Configure MPU */
599  WRITE_REG(MPU->RASR, (MPU_RASR_ENABLE_Msk | Attributes | (SubRegionDisable << MPU_RASR_SRD_Pos)));
600 }
601 
617 __STATIC_INLINE void LL_MPU_DisableRegion(uint32_t Region)
618 {
619  /* Set Region number */
620  WRITE_REG(MPU->RNR, Region);
621  /* Disable the MPU region */
622  CLEAR_BIT(MPU->RASR, MPU_RASR_ENABLE_Msk);
623 }
624 
629 #endif /* __MPU_PRESENT */
642 #ifdef __cplusplus
643 }
644 #endif
645 
646 #endif /* __STM32F4xx_LL_CORTEX_H */
647 
__STATIC_INLINE void LL_HANDLER_DisableFault(uint32_t Fault)
Disable a fault in System handler control register (SHCSR) @rmtoll SCB_SHCSR MEMFAULTENA LL_HANDLER_D...
__STATIC_INLINE void LL_HANDLER_EnableFault(uint32_t Fault)
Enable a fault in System handler control register (SHCSR) @rmtoll SCB_SHCSR MEMFAULTENA LL_HANDLER_En...
__STATIC_INLINE void LL_LPM_EnableDeepSleep(void)
Processor uses deep sleep as its low power mode @rmtoll SCB_SCR SLEEPDEEP LL_LPM_EnableDeepSleep.
__STATIC_INLINE void LL_LPM_ClearEvent(void)
Clear pending events.
__STATIC_INLINE void LL_LPM_DisableSleepOnExit(void)
Do not sleep when returning to Thread mode. @rmtoll SCB_SCR SLEEPONEXIT LL_LPM_DisableSleepOnExit.
__STATIC_INLINE void LL_LPM_EnableSleep(void)
Processor uses sleep as its low power mode @rmtoll SCB_SCR SLEEPDEEP LL_LPM_EnableSleep.
__STATIC_INLINE void LL_LPM_EnableSleepOnExit(void)
Configures sleep-on-exit when returning from Handler mode to Thread mode.
__STATIC_INLINE void LL_LPM_EnableEventOnPend(void)
Enabled events and all interrupts, including disabled interrupts, can wakeup the processor....
__STATIC_INLINE void LL_LPM_DisableEventOnPend(void)
Only enabled interrupts or events can wakeup the processor, disabled interrupts are excluded @rmtoll ...
__STATIC_INLINE uint32_t LL_CPUID_GetVariant(void)
Get Variant number (The r value in the rnpn product revision identifier) @rmtoll SCB_CPUID VARIANT LL...
__STATIC_INLINE uint32_t LL_CPUID_GetImplementer(void)
Get Implementer code @rmtoll SCB_CPUID IMPLEMENTER LL_CPUID_GetImplementer.
__STATIC_INLINE uint32_t LL_CPUID_GetRevision(void)
Get Revision number (The p value in the rnpn product revision identifier, indicates patch release) @r...
__STATIC_INLINE uint32_t LL_CPUID_GetConstant(void)
Get Constant number @rmtoll SCB_CPUID ARCHITECTURE LL_CPUID_GetConstant.
__STATIC_INLINE uint32_t LL_CPUID_GetParNo(void)
Get Part number @rmtoll SCB_CPUID PARTNO LL_CPUID_GetParNo.
__STATIC_INLINE void LL_MPU_Disable(void)
Disable MPU @rmtoll MPU_CTRL ENABLE LL_MPU_Disable.
__STATIC_INLINE void LL_MPU_EnableRegion(uint32_t Region)
Enable a MPU region @rmtoll MPU_RASR ENABLE LL_MPU_EnableRegion.
__STATIC_INLINE void LL_MPU_ConfigRegion(uint32_t Region, uint32_t SubRegionDisable, uint32_t Address, uint32_t Attributes)
Configure and enable a region @rmtoll MPU_RNR REGION LL_MPU_ConfigRegion MPU_RBAR REGION LL_MPU_Conf...
__STATIC_INLINE uint32_t LL_MPU_IsEnabled(void)
Check if MPU is enabled or not @rmtoll MPU_CTRL ENABLE LL_MPU_IsEnabled.
__STATIC_INLINE void LL_MPU_Enable(uint32_t Options)
Enable MPU with input options @rmtoll MPU_CTRL ENABLE LL_MPU_Enable.
__STATIC_INLINE void LL_MPU_DisableRegion(uint32_t Region)
Disable a region @rmtoll MPU_RNR REGION LL_MPU_DisableRegion MPU_RASR ENABLE LL_MPU_DisableRegion.
__STATIC_INLINE void LL_SYSTICK_DisableIT(void)
Disable SysTick exception request @rmtoll STK_CTRL TICKINT LL_SYSTICK_DisableIT.
__STATIC_INLINE uint32_t LL_SYSTICK_GetClkSource(void)
Get the SysTick clock source @rmtoll STK_CTRL CLKSOURCE LL_SYSTICK_GetClkSource.
__STATIC_INLINE void LL_SYSTICK_EnableIT(void)
Enable SysTick exception request @rmtoll STK_CTRL TICKINT LL_SYSTICK_EnableIT.
__STATIC_INLINE void LL_SYSTICK_SetClkSource(uint32_t Source)
Configures the SysTick clock source @rmtoll STK_CTRL CLKSOURCE LL_SYSTICK_SetClkSource.
__STATIC_INLINE uint32_t LL_SYSTICK_IsEnabledIT(void)
Checks if the SYSTICK interrupt is enabled or disabled. @rmtoll STK_CTRL TICKINT LL_SYSTICK_IsEnabled...
__STATIC_INLINE uint32_t LL_SYSTICK_IsActiveCounterFlag(void)
This function checks if the Systick counter flag is active or not.