misc.h

00001 /**
00002   ******************************************************************************
00003   * @file    misc.h
00004   * @author  MCD Application Team
00005   * @version V3.5.0
00006   * @date    11-March-2011
00007   * @brief   This file contains all the functions prototypes for the miscellaneous
00008   *          firmware library functions (add-on to CMSIS functions).
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
00013   * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
00014   * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
00015   * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
00016   * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
00017   * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
00018   *
00019   * <h2><center>&copy; COPYRIGHT 2011 STMicroelectronics</center></h2>
00020   ******************************************************************************
00021   */
00022 
00023 /* Define to prevent recursive inclusion -------------------------------------*/
00024 #ifndef __MISC_H
00025 #define __MISC_H
00026 
00027 #ifdef __cplusplus
00028  extern "C" {
00029 #endif
00030 
00031 /* Includes ------------------------------------------------------------------*/
00032 #include "stm32f10x.h"
00033 
00034 /** @addtogroup STM32F10x_StdPeriph_Driver
00035   * @{
00036   */
00037 
00038 /** @addtogroup MISC
00039   * @{
00040   */
00041 
00042 /** @defgroup MISC_Exported_Types
00043   * @{
00044   */
00045 
00046 /** 
00047   * @brief  NVIC Init Structure definition  
00048   */
00049 
00050 typedef struct
00051 {
00052   uint8_t NVIC_IRQChannel;                    /*!< Specifies the IRQ channel to be enabled or disabled.
00053                                                    This parameter can be a value of @ref IRQn_Type 
00054                                                    (For the complete STM32 Devices IRQ Channels list, please
00055                                                     refer to stm32f10x.h file) */
00056 
00057   uint8_t NVIC_IRQChannelPreemptionPriority;  /*!< Specifies the pre-emption priority for the IRQ channel
00058                                                    specified in NVIC_IRQChannel. This parameter can be a value
00059                                                    between 0 and 15 as described in the table @ref NVIC_Priority_Table */
00060 
00061   uint8_t NVIC_IRQChannelSubPriority;         /*!< Specifies the subpriority level for the IRQ channel specified
00062                                                    in NVIC_IRQChannel. This parameter can be a value
00063                                                    between 0 and 15 as described in the table @ref NVIC_Priority_Table */
00064 
00065   FunctionalState NVIC_IRQChannelCmd;         /*!< Specifies whether the IRQ channel defined in NVIC_IRQChannel
00066                                                    will be enabled or disabled. 
00067                                                    This parameter can be set either to ENABLE or DISABLE */   
00068 } NVIC_InitTypeDef;
00069  
00070 /**
00071   * @}
00072   */
00073 
00074 /** @defgroup NVIC_Priority_Table 
00075   * @{
00076   */
00077 
00078 /**
00079 @code  
00080  The table below gives the allowed values of the pre-emption priority and subpriority according
00081  to the Priority Grouping configuration performed by NVIC_PriorityGroupConfig function
00082   ============================================================================================================================
00083     NVIC_PriorityGroup   | NVIC_IRQChannelPreemptionPriority | NVIC_IRQChannelSubPriority  | Description
00084   ============================================================================================================================
00085    NVIC_PriorityGroup_0  |                0                  |            0-15             |   0 bits for pre-emption priority
00086                          |                                   |                             |   4 bits for subpriority
00087   ----------------------------------------------------------------------------------------------------------------------------
00088    NVIC_PriorityGroup_1  |                0-1                |            0-7              |   1 bits for pre-emption priority
00089                          |                                   |                             |   3 bits for subpriority
00090   ----------------------------------------------------------------------------------------------------------------------------    
00091    NVIC_PriorityGroup_2  |                0-3                |            0-3              |   2 bits for pre-emption priority
00092                          |                                   |                             |   2 bits for subpriority
00093   ----------------------------------------------------------------------------------------------------------------------------    
00094    NVIC_PriorityGroup_3  |                0-7                |            0-1              |   3 bits for pre-emption priority
00095                          |                                   |                             |   1 bits for subpriority
00096   ----------------------------------------------------------------------------------------------------------------------------    
00097    NVIC_PriorityGroup_4  |                0-15               |            0                |   4 bits for pre-emption priority
00098                          |                                   |                             |   0 bits for subpriority                       
00099   ============================================================================================================================
00100 @endcode
00101 */
00102 
00103 /**
00104   * @}
00105   */
00106 
00107 /** @defgroup MISC_Exported_Constants
00108   * @{
00109   */
00110 
00111 /** @defgroup Vector_Table_Base 
00112   * @{
00113   */
00114 
00115 #define NVIC_VectTab_RAM             ((uint32_t)0x20000000)
00116 #define NVIC_VectTab_FLASH           ((uint32_t)0x08000000)
00117 #define IS_NVIC_VECTTAB(VECTTAB) (((VECTTAB) == NVIC_VectTab_RAM) || \
00118                                   ((VECTTAB) == NVIC_VectTab_FLASH))
00119 /**
00120   * @}
00121   */
00122 
00123 /** @defgroup System_Low_Power 
00124   * @{
00125   */
00126 
00127 #define NVIC_LP_SEVONPEND            ((uint8_t)0x10)
00128 #define NVIC_LP_SLEEPDEEP            ((uint8_t)0x04)
00129 #define NVIC_LP_SLEEPONEXIT          ((uint8_t)0x02)
00130 #define IS_NVIC_LP(LP) (((LP) == NVIC_LP_SEVONPEND) || \
00131                         ((LP) == NVIC_LP_SLEEPDEEP) || \
00132                         ((LP) == NVIC_LP_SLEEPONEXIT))
00133 /**
00134   * @}
00135   */
00136 
00137 /** @defgroup Preemption_Priority_Group 
00138   * @{
00139   */
00140 
00141 #define NVIC_PriorityGroup_0         ((uint32_t)0x700) /*!< 0 bits for pre-emption priority
00142                                                             4 bits for subpriority */
00143 #define NVIC_PriorityGroup_1         ((uint32_t)0x600) /*!< 1 bits for pre-emption priority
00144                                                             3 bits for subpriority */
00145 #define NVIC_PriorityGroup_2         ((uint32_t)0x500) /*!< 2 bits for pre-emption priority
00146                                                             2 bits for subpriority */
00147 #define NVIC_PriorityGroup_3         ((uint32_t)0x400) /*!< 3 bits for pre-emption priority
00148                                                             1 bits for subpriority */
00149 #define NVIC_PriorityGroup_4         ((uint32_t)0x300) /*!< 4 bits for pre-emption priority
00150                                                             0 bits for subpriority */
00151 
00152 #define IS_NVIC_PRIORITY_GROUP(GROUP) (((GROUP) == NVIC_PriorityGroup_0) || \
00153                                        ((GROUP) == NVIC_PriorityGroup_1) || \
00154                                        ((GROUP) == NVIC_PriorityGroup_2) || \
00155                                        ((GROUP) == NVIC_PriorityGroup_3) || \
00156                                        ((GROUP) == NVIC_PriorityGroup_4))
00157 
00158 #define IS_NVIC_PREEMPTION_PRIORITY(PRIORITY)  ((PRIORITY) < 0x10)
00159 
00160 #define IS_NVIC_SUB_PRIORITY(PRIORITY)  ((PRIORITY) < 0x10)
00161 
00162 #define IS_NVIC_OFFSET(OFFSET)  ((OFFSET) < 0x000FFFFF)
00163 
00164 /**
00165   * @}
00166   */
00167 
00168 /** @defgroup SysTick_clock_source 
00169   * @{
00170   */
00171 
00172 #define SysTick_CLKSource_HCLK_Div8    ((uint32_t)0xFFFFFFFB)
00173 #define SysTick_CLKSource_HCLK         ((uint32_t)0x00000004)
00174 #define IS_SYSTICK_CLK_SOURCE(SOURCE) (((SOURCE) == SysTick_CLKSource_HCLK) || \
00175                                        ((SOURCE) == SysTick_CLKSource_HCLK_Div8))
00176 /**
00177   * @}
00178   */
00179 
00180 /**
00181   * @}
00182   */
00183 
00184 /** @defgroup MISC_Exported_Macros
00185   * @{
00186   */
00187 
00188 /**
00189   * @}
00190   */
00191 
00192 /** @defgroup MISC_Exported_Functions
00193   * @{
00194   */
00195 
00196 void NVIC_PriorityGroupConfig(uint32_t NVIC_PriorityGroup);
00197 void NVIC_Init(NVIC_InitTypeDef* NVIC_InitStruct);
00198 void NVIC_SetVectorTable(uint32_t NVIC_VectTab, uint32_t Offset);
00199 void NVIC_SystemLPConfig(uint8_t LowPowerMode, FunctionalState NewState);
00200 void SysTick_CLKSourceConfig(uint32_t SysTick_CLKSource);
00201 
00202 #ifdef __cplusplus
00203 }
00204 #endif
00205 
00206 #endif /* __MISC_H */
00207 
00208 /**
00209   * @}
00210   */
00211 
00212 /**
00213   * @}
00214   */
00215 
00216 /**
00217   * @}
00218   */
00219 
00220 /******************* (C) COPYRIGHT 2011 STMicroelectronics *****END OF FILE****/