2 ******************************************************************************
3 * @file stm32f1xx_hal_cortex.h
4 * @author MCD Application Team
6 * @date 15-December-2014
7 * @brief Header file of CORTEX HAL module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
13 * Redistribution and use in source and binary forms, with or without modification,
14 * are permitted provided that the following conditions are met:
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 ******************************************************************************
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F1xx_HAL_CORTEX_H
40 #define __STM32F1xx_HAL_CORTEX_H
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32f1xx_hal_def.h"
49 /** @addtogroup STM32F1xx_HAL_Driver
53 /** @addtogroup CORTEX
56 /* Exported types ------------------------------------------------------------*/
57 /* Exported constants --------------------------------------------------------*/
59 /** @defgroup CORTEX_Exported_Constants CORTEX Exported Constants
64 /** @defgroup CORTEX_Preemption_Priority_Group CORTEX Preemption Priority Group
68 #define NVIC_PRIORITYGROUP_0 ((uint32_t)0x00000007) /*!< 0 bits for pre-emption priority
69 4 bits for subpriority */
70 #define NVIC_PRIORITYGROUP_1 ((uint32_t)0x00000006) /*!< 1 bits for pre-emption priority
71 3 bits for subpriority */
72 #define NVIC_PRIORITYGROUP_2 ((uint32_t)0x00000005) /*!< 2 bits for pre-emption priority
73 2 bits for subpriority */
74 #define NVIC_PRIORITYGROUP_3 ((uint32_t)0x00000004) /*!< 3 bits for pre-emption priority
75 1 bits for subpriority */
76 #define NVIC_PRIORITYGROUP_4 ((uint32_t)0x00000003) /*!< 4 bits for pre-emption priority
77 0 bits for subpriority */
82 /** @defgroup CORTEX_SysTick_clock_source CORTEX SysTick clock source
85 #define SYSTICK_CLKSOURCE_HCLK_DIV8 ((uint32_t)0x00000000)
86 #define SYSTICK_CLKSOURCE_HCLK ((uint32_t)0x00000004)
96 /* Exported Macros -----------------------------------------------------------*/
97 /** @defgroup CORTEX_Exported_Macros CORTEX Exported Macros
101 /** @defgroup CORTEX_SysTick_clock_source_Macro_Exported CORTEX SysTick clock source
105 /** @brief Configures the SysTick clock source.
106 * @param __CLKSRC__: specifies the SysTick clock source.
107 * This parameter can be one of the following values:
108 * @arg SYSTICK_CLKSOURCE_HCLK_DIV8: AHB clock divided by 8 selected as SysTick clock source.
109 * @arg SYSTICK_CLKSOURCE_HCLK: AHB clock selected as SysTick clock source.
112 #define __HAL_CORTEX_SYSTICKCLK_CONFIG(__CLKSRC__) \
114 if ((__CLKSRC__) == SYSTICK_CLKSOURCE_HCLK) \
116 SET_BIT(SysTick->CTRL, SYSTICK_CLKSOURCE_HCLK); \
119 CLEAR_BIT(SysTick->CTRL, SYSTICK_CLKSOURCE_HCLK); \
129 /* Private macro -------------------------------------------------------------*/
130 /** @defgroup CORTEX_Private_Macros CORTEX Private Macros
134 /** @defgroup CORTEX_Preemption_Priority_Group_Macro CORTEX Preemption Priority Group
137 #define IS_NVIC_PRIORITY_GROUP(GROUP) (((GROUP) == NVIC_PRIORITYGROUP_0) || \
138 ((GROUP) == NVIC_PRIORITYGROUP_1) || \
139 ((GROUP) == NVIC_PRIORITYGROUP_2) || \
140 ((GROUP) == NVIC_PRIORITYGROUP_3) || \
141 ((GROUP) == NVIC_PRIORITYGROUP_4))
143 #define IS_NVIC_PREEMPTION_PRIORITY(PRIORITY) ((PRIORITY) < 0x10)
145 #define IS_NVIC_SUB_PRIORITY(PRIORITY) ((PRIORITY) < 0x10)
147 #define IS_NVIC_DEVICE_IRQ(IRQ) ((IRQ) >= 0x00)
153 /** @defgroup CORTEX_SysTick_clock_source_Macro_Private CORTEX SysTick clock source
156 #define IS_SYSTICK_CLK_SOURCE(SOURCE) (((SOURCE) == SYSTICK_CLKSOURCE_HCLK) || \
157 ((SOURCE) == SYSTICK_CLKSOURCE_HCLK_DIV8))
166 /* Exported functions --------------------------------------------------------*/
168 /** @addtogroup CORTEX_Exported_Functions
172 /** @addtogroup CORTEX_Exported_Functions_Group1
175 /* Initialization and de-initialization functions *****************************/
176 void HAL_NVIC_SetPriorityGrouping(uint32_t PriorityGroup);
177 void HAL_NVIC_SetPriority(IRQn_Type IRQn, uint32_t PreemptPriority, uint32_t SubPriority);
178 void HAL_NVIC_EnableIRQ(IRQn_Type IRQn);
179 void HAL_NVIC_DisableIRQ(IRQn_Type IRQn);
180 void HAL_NVIC_SystemReset(void);
181 uint32_t HAL_SYSTICK_Config(uint32_t TicksNumb);
186 /** @addtogroup CORTEX_Exported_Functions_Group2
189 /* Peripheral Control functions ***********************************************/
190 uint32_t HAL_NVIC_GetPriorityGrouping(void);
191 void HAL_NVIC_GetPriority(IRQn_Type IRQn, uint32_t PriorityGroup, uint32_t* pPreemptPriority, uint32_t* pSubPriority);
192 uint32_t HAL_NVIC_GetPendingIRQ(IRQn_Type IRQn);
193 void HAL_NVIC_SetPendingIRQ(IRQn_Type IRQn);
194 void HAL_NVIC_ClearPendingIRQ(IRQn_Type IRQn);
195 uint32_t HAL_NVIC_GetActive(IRQn_Type IRQn);
196 void HAL_SYSTICK_CLKSourceConfig(uint32_t CLKSource);
197 void HAL_SYSTICK_IRQHandler(void);
198 void HAL_SYSTICK_Callback(void);
219 #endif /* __STM32F1xx_HAL_CORTEX_H */
222 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/