tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F1/stm32f1xx_hal_cortex.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f1xx_hal_cortex.h
   4   * @author  MCD Application Team
   5   * @version V1.0.0
   6   * @date    15-December-2014
   7   * @brief   Header file of CORTEX HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  12   *
  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.
  23   *
  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.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F1xx_HAL_CORTEX_H
  40 #define __STM32F1xx_HAL_CORTEX_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f1xx_hal_def.h"
  48
  49 /** @addtogroup STM32F1xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup CORTEX
  54   * @{
  55   */
  56 /* Exported types ------------------------------------------------------------*/
  57 /* Exported constants --------------------------------------------------------*/
  58
  59 /** @defgroup CORTEX_Exported_Constants CORTEX Exported Constants
  60   * @{
  61   */
  62
  63
  64 /** @defgroup CORTEX_Preemption_Priority_Group  CORTEX Preemption Priority Group
  65   * @{
  66   */
  67
  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 */
  78 /**
  79   * @}
  80   */
  81
  82 /** @defgroup CORTEX_SysTick_clock_source CORTEX SysTick clock source
  83   * @{
  84   */
  85 #define SYSTICK_CLKSOURCE_HCLK_DIV8    ((uint32_t)0x00000000)
  86 #define SYSTICK_CLKSOURCE_HCLK         ((uint32_t)0x00000004)
  87
  88 /**
  89   * @}
  90   */
  91
  92 /**
  93   * @}
  94   */
  95
  96 /* Exported Macros -----------------------------------------------------------*/
  97 /** @defgroup CORTEX_Exported_Macros CORTEX Exported Macros
  98   * @{
  99   */
 100
 101 /** @defgroup CORTEX_SysTick_clock_source_Macro_Exported CORTEX SysTick clock source
 102   * @{
 103   */
 104
 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.
 110   * @retval None
 111   */
 112 #define __HAL_CORTEX_SYSTICKCLK_CONFIG(__CLKSRC__)                             \
 113                             do {                                               \
 114                                  if ((__CLKSRC__) == SYSTICK_CLKSOURCE_HCLK)   \
 115                                   {                                            \
 116                                     SET_BIT(SysTick->CTRL, SYSTICK_CLKSOURCE_HCLK);   \
 117                                   }                                            \
 118                                  else                                          \
 119                                     CLEAR_BIT(SysTick->CTRL, SYSTICK_CLKSOURCE_HCLK);  \
 120                                 } while(0)
 121 /**
 122   * @}
 123   */
 124
 125 /**
 126   * @}
 127   */
 128
 129 /* Private macro -------------------------------------------------------------*/
 130 /** @defgroup CORTEX_Private_Macros CORTEX Private Macros
 131   * @{
 132   */
 133
 134 /** @defgroup CORTEX_Preemption_Priority_Group_Macro  CORTEX Preemption Priority Group
 135   * @{
 136   */
 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))
 142
 143 #define IS_NVIC_PREEMPTION_PRIORITY(PRIORITY)  ((PRIORITY) < 0x10)
 144
 145 #define IS_NVIC_SUB_PRIORITY(PRIORITY)  ((PRIORITY) < 0x10)
 146
 147 #define IS_NVIC_DEVICE_IRQ(IRQ)  ((IRQ) >= 0x00)
 148
 149 /**
 150   * @}
 151   */
 152
 153 /** @defgroup CORTEX_SysTick_clock_source_Macro_Private CORTEX SysTick clock source
 154   * @{
 155   */
 156 #define IS_SYSTICK_CLK_SOURCE(SOURCE) (((SOURCE) == SYSTICK_CLKSOURCE_HCLK) || \
 157                                        ((SOURCE) == SYSTICK_CLKSOURCE_HCLK_DIV8))
 158 /**
 159   * @}
 160   */
 161
 162 /**
 163   * @}
 164   */
 165
 166 /* Exported functions --------------------------------------------------------*/
 167
 168 /** @addtogroup CORTEX_Exported_Functions
 169   * @{
 170   */
 171
 172 /** @addtogroup CORTEX_Exported_Functions_Group1
 173   * @{
 174   */
 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);
 182 /**
 183   * @}
 184   */
 185
 186 /** @addtogroup CORTEX_Exported_Functions_Group2
 187   * @{
 188   */
 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);
 199 /**
 200   * @}
 201   */
 202
 203 /**
 204   * @}
 205   */
 206
 207 /**
 208   * @}
 209   */
 210
 211 /**
 212   * @}
 213   */
 214
 215 #ifdef __cplusplus
 216 }
 217 #endif
 218
 219 #endif /* __STM32F1xx_HAL_CORTEX_H */
 220
 221
 222 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/