tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F3/stm32f3xx_hal_cortex.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f3xx_hal_cortex.h
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    12-Sept-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 __STM32F3xx_HAL_CORTEX_H
  40 #define __STM32F3xx_HAL_CORTEX_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f3xx_hal_def.h"
  48
  49 /** @addtogroup STM32F3xx_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 /** @defgroup CORTEX_Preemption_Priority_Group CORTEX Preemption Priority Group
  64   * @{
  65   */
  66
  67 #define NVIC_PRIORITYGROUP_0         ((uint32_t)0x00000007) /*!< 0 bits for pre-emption priority
  68                                                                  4 bits for subpriority */
  69 #define NVIC_PRIORITYGROUP_1         ((uint32_t)0x00000006) /*!< 1 bits for pre-emption priority
  70                                                                  3 bits for subpriority */
  71 #define NVIC_PRIORITYGROUP_2         ((uint32_t)0x00000005) /*!< 2 bits for pre-emption priority
  72                                                                  2 bits for subpriority */
  73 #define NVIC_PRIORITYGROUP_3         ((uint32_t)0x00000004) /*!< 3 bits for pre-emption priority
  74                                                                  1 bits for subpriority */
  75 #define NVIC_PRIORITYGROUP_4         ((uint32_t)0x00000003) /*!< 4 bits for pre-emption priority
  76                                                                  0 bits for subpriority */
  77
  78 #define IS_NVIC_PRIORITY_GROUP(GROUP) (((GROUP) == NVIC_PRIORITYGROUP_0) || \
  79                                        ((GROUP) == NVIC_PRIORITYGROUP_1) || \
  80                                        ((GROUP) == NVIC_PRIORITYGROUP_2) || \
  81                                        ((GROUP) == NVIC_PRIORITYGROUP_3) || \
  82                                        ((GROUP) == NVIC_PRIORITYGROUP_4))
  83
  84 #define IS_NVIC_PREEMPTION_PRIORITY(PRIORITY)  ((PRIORITY) < 0x10)
  85
  86 #define IS_NVIC_SUB_PRIORITY(PRIORITY)  ((PRIORITY) < 0x10)
  87
  88 /**
  89   * @}
  90   */
  91
  92 /** @defgroup CORTEX_SysTick_clock_source CORTEX _SysTick clock source
  93   * @{
  94   */
  95 #define SYSTICK_CLKSOURCE_HCLK_DIV8    ((uint32_t)0x00000000)
  96 #define SYSTICK_CLKSOURCE_HCLK         ((uint32_t)0x00000004)
  97 #define IS_SYSTICK_CLK_SOURCE(SOURCE) (((SOURCE) == SYSTICK_CLKSOURCE_HCLK) || \
  98                                        ((SOURCE) == SYSTICK_CLKSOURCE_HCLK_DIV8))
  99 /**
 100   * @}
 101   */
 102
 103 /**
 104   * @}
 105   */
 106
 107
 108 /* Exported Macros -----------------------------------------------------------*/
 109 /** @defgroup CORTEX_Exported_Macros CORTEX Exported Macros
 110   * @{
 111   */
 112
 113 /** @brief Configures the SysTick clock source.
 114   * @param __CLKSRC__: specifies the SysTick clock source.
 115   *   This parameter can be one of the following values:
 116   *     @arg SYSTICK_CLKSOURCE_HCLK_DIV8: AHB clock divided by 8 selected as SysTick clock source.
 117   *     @arg SYSTICK_CLKSOURCE_HCLK: AHB clock selected as SysTick clock source.
 118   * @retval None
 119   */
 120 #define __HAL_CORTEX_SYSTICKCLK_CONFIG(__CLKSRC__)                             \
 121                             do {                                               \
 122                                  if ((__CLKSRC__) == SYSTICK_CLKSOURCE_HCLK)   \
 123                                   {                                            \
 124                                     SysTick->CTRL |= SYSTICK_CLKSOURCE_HCLK;   \
 125                                   }                                            \
 126                                  else                                          \
 127                                     SysTick->CTRL &= ~SYSTICK_CLKSOURCE_HCLK;  \
 128                                 } while(0)
 129 /**
 130   * @}
 131   */
 132
 133 /* Exported functions --------------------------------------------------------*/
 134 /** @addtogroup CORTEX_Exported_Functions CORTEX Exported Functions
 135   * @{
 136   */
 137
 138 /** @addtogroup CORTEX_Exported_Functions_Group1 Initialization and de-initialization functions
 139  *  @brief    Initialization and Configuration functions
 140  * @{
 141  */
 142 /* Initialization and de-initialization functions *****************************/
 143 void HAL_NVIC_SetPriorityGrouping(uint32_t PriorityGroup);
 144 void HAL_NVIC_SetPriority(IRQn_Type IRQn, uint32_t PreemptPriority, uint32_t SubPriority);
 145 void HAL_NVIC_EnableIRQ(IRQn_Type IRQn);
 146 void HAL_NVIC_DisableIRQ(IRQn_Type IRQn);
 147 void HAL_NVIC_SystemReset(void);
 148 uint32_t HAL_SYSTICK_Config(uint32_t TicksNumb);
 149 /**
 150   * @}
 151   */
 152
 153 /** @addtogroup CORTEX_Exported_Functions_Group2 Peripheral Control functions
 154  *  @brief   Cortex control functions
 155  * @{
 156  */
 157 /* Peripheral Control functions ***********************************************/
 158 uint32_t HAL_NVIC_GetPriorityGrouping(void);
 159 void HAL_NVIC_GetPriority(IRQn_Type IRQn, uint32_t PriorityGroup, uint32_t* pPreemptPriority, uint32_t* pSubPriority);
 160 uint32_t HAL_NVIC_GetPendingIRQ(IRQn_Type IRQn);
 161 void HAL_NVIC_SetPendingIRQ(IRQn_Type IRQn);
 162 void HAL_NVIC_ClearPendingIRQ(IRQn_Type IRQn);
 163 uint32_t HAL_NVIC_GetActive(IRQn_Type IRQn);
 164 void HAL_SYSTICK_CLKSourceConfig(uint32_t CLKSource);
 165 void HAL_SYSTICK_IRQHandler(void);
 166 void HAL_SYSTICK_Callback(void);
 167 /**
 168   * @}
 169   */
 170
 171 /**
 172   * @}
 173   */
 174
 175 /**
 176   * @}
 177   */
 178
 179 /**
 180   * @}
 181   */
 182
 183 #ifdef __cplusplus
 184 }
 185 #endif
 186
 187 #endif /* __STM32F3xx_HAL_CORTEX_H */
 188
 189
 190 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/