Added STM32F4xx StdPeriph Driver sources
[fw/stlink] / example / stm32f4 / STM32F4xx_StdPeriph_Driver / inc / stm32f4xx_exti.h
1 /**
2   ******************************************************************************
3   * @file    stm32f4xx_exti.h
4   * @author  MCD Application Team
5   * @version V1.0.0RC1
6   * @date    25-August-2011
7   * @brief   This file contains all the functions prototypes for the EXTI firmware
8   *          library.
9   ******************************************************************************
10   * @attention
11   *
12   * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
13   * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
14   * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
15   * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
16   * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
17   * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
18   *
19   * <h2><center>&copy; COPYRIGHT 2011 STMicroelectronics</center></h2>
20   ******************************************************************************
21   */
22
23 /* Define to prevent recursive inclusion -------------------------------------*/
24 #ifndef __STM32F4xx_EXTI_H
25 #define __STM32F4xx_EXTI_H
26
27 #ifdef __cplusplus
28  extern "C" {
29 #endif
30
31 /* Includes ------------------------------------------------------------------*/
32 #include "stm32f4xx.h"
33
34 /** @addtogroup STM32F4xx_StdPeriph_Driver
35   * @{
36   */
37
38 /** @addtogroup EXTI
39   * @{
40   */
41
42 /* Exported types ------------------------------------------------------------*/
43
44 /** 
45   * @brief  EXTI mode enumeration  
46   */
47
48 typedef enum
49 {
50   EXTI_Mode_Interrupt = 0x00,
51   EXTI_Mode_Event = 0x04
52 }EXTIMode_TypeDef;
53
54 #define IS_EXTI_MODE(MODE) (((MODE) == EXTI_Mode_Interrupt) || ((MODE) == EXTI_Mode_Event))
55
56 /** 
57   * @brief  EXTI Trigger enumeration  
58   */
59
60 typedef enum
61 {
62   EXTI_Trigger_Rising = 0x08,
63   EXTI_Trigger_Falling = 0x0C,  
64   EXTI_Trigger_Rising_Falling = 0x10
65 }EXTITrigger_TypeDef;
66
67 #define IS_EXTI_TRIGGER(TRIGGER) (((TRIGGER) == EXTI_Trigger_Rising) || \
68                                   ((TRIGGER) == EXTI_Trigger_Falling) || \
69                                   ((TRIGGER) == EXTI_Trigger_Rising_Falling))
70 /** 
71   * @brief  EXTI Init Structure definition  
72   */
73
74 typedef struct
75 {
76   uint32_t EXTI_Line;               /*!< Specifies the EXTI lines to be enabled or disabled.
77                                          This parameter can be any combination value of @ref EXTI_Lines */
78    
79   EXTIMode_TypeDef EXTI_Mode;       /*!< Specifies the mode for the EXTI lines.
80                                          This parameter can be a value of @ref EXTIMode_TypeDef */
81
82   EXTITrigger_TypeDef EXTI_Trigger; /*!< Specifies the trigger signal active edge for the EXTI lines.
83                                          This parameter can be a value of @ref EXTITrigger_TypeDef */
84
85   FunctionalState EXTI_LineCmd;     /*!< Specifies the new state of the selected EXTI lines.
86                                          This parameter can be set either to ENABLE or DISABLE */ 
87 }EXTI_InitTypeDef;
88
89 /* Exported constants --------------------------------------------------------*/
90
91 /** @defgroup EXTI_Exported_Constants
92   * @{
93   */
94
95 /** @defgroup EXTI_Lines 
96   * @{
97   */
98
99 #define EXTI_Line0       ((uint32_t)0x00001)     /*!< External interrupt line 0 */
100 #define EXTI_Line1       ((uint32_t)0x00002)     /*!< External interrupt line 1 */
101 #define EXTI_Line2       ((uint32_t)0x00004)     /*!< External interrupt line 2 */
102 #define EXTI_Line3       ((uint32_t)0x00008)     /*!< External interrupt line 3 */
103 #define EXTI_Line4       ((uint32_t)0x00010)     /*!< External interrupt line 4 */
104 #define EXTI_Line5       ((uint32_t)0x00020)     /*!< External interrupt line 5 */
105 #define EXTI_Line6       ((uint32_t)0x00040)     /*!< External interrupt line 6 */
106 #define EXTI_Line7       ((uint32_t)0x00080)     /*!< External interrupt line 7 */
107 #define EXTI_Line8       ((uint32_t)0x00100)     /*!< External interrupt line 8 */
108 #define EXTI_Line9       ((uint32_t)0x00200)     /*!< External interrupt line 9 */
109 #define EXTI_Line10      ((uint32_t)0x00400)     /*!< External interrupt line 10 */
110 #define EXTI_Line11      ((uint32_t)0x00800)     /*!< External interrupt line 11 */
111 #define EXTI_Line12      ((uint32_t)0x01000)     /*!< External interrupt line 12 */
112 #define EXTI_Line13      ((uint32_t)0x02000)     /*!< External interrupt line 13 */
113 #define EXTI_Line14      ((uint32_t)0x04000)     /*!< External interrupt line 14 */
114 #define EXTI_Line15      ((uint32_t)0x08000)     /*!< External interrupt line 15 */
115 #define EXTI_Line16      ((uint32_t)0x10000)     /*!< External interrupt line 16 Connected to the PVD Output */
116 #define EXTI_Line17      ((uint32_t)0x20000)     /*!< External interrupt line 17 Connected to the RTC Alarm event */
117 #define EXTI_Line18      ((uint32_t)0x40000)     /*!< External interrupt line 18 Connected to the USB OTG FS Wakeup from suspend event */                                    
118 #define EXTI_Line19      ((uint32_t)0x80000)     /*!< External interrupt line 19 Connected to the Ethernet Wakeup event */
119 #define EXTI_Line20      ((uint32_t)0x00100000)  /*!< External interrupt line 20 Connected to the USB OTG HS (configured in FS) Wakeup event  */
120 #define EXTI_Line21      ((uint32_t)0x00200000)  /*!< External interrupt line 21 Connected to the RTC Tamper and Time Stamp events */                                               
121 #define EXTI_Line22      ((uint32_t)0x00400000)  /*!< External interrupt line 22 Connected to the RTC Wakeup event */                                               
122                                           
123 #define IS_EXTI_LINE(LINE) ((((LINE) & (uint32_t)0xFF800000) == 0x00) && ((LINE) != (uint16_t)0x00))
124
125 #define IS_GET_EXTI_LINE(LINE) (((LINE) == EXTI_Line0) || ((LINE) == EXTI_Line1) || \
126                                 ((LINE) == EXTI_Line2) || ((LINE) == EXTI_Line3) || \
127                                 ((LINE) == EXTI_Line4) || ((LINE) == EXTI_Line5) || \
128                                 ((LINE) == EXTI_Line6) || ((LINE) == EXTI_Line7) || \
129                                 ((LINE) == EXTI_Line8) || ((LINE) == EXTI_Line9) || \
130                                 ((LINE) == EXTI_Line10) || ((LINE) == EXTI_Line11) || \
131                                 ((LINE) == EXTI_Line12) || ((LINE) == EXTI_Line13) || \
132                                 ((LINE) == EXTI_Line14) || ((LINE) == EXTI_Line15) || \
133                                 ((LINE) == EXTI_Line16) || ((LINE) == EXTI_Line17) || \
134                                 ((LINE) == EXTI_Line18) || ((LINE) == EXTI_Line19) || \
135                                 ((LINE) == EXTI_Line20) || ((LINE) == EXTI_Line21) ||\
136                                 ((LINE) == EXTI_Line22))
137                     
138 /**
139   * @}
140   */
141
142 /**
143   * @}
144   */
145
146 /* Exported macro ------------------------------------------------------------*/
147 /* Exported functions --------------------------------------------------------*/
148
149 /*  Function used to set the EXTI configuration to the default reset state *****/
150 void EXTI_DeInit(void);
151
152 /* Initialization and Configuration functions *********************************/
153 void EXTI_Init(EXTI_InitTypeDef* EXTI_InitStruct);
154 void EXTI_StructInit(EXTI_InitTypeDef* EXTI_InitStruct);
155 void EXTI_GenerateSWInterrupt(uint32_t EXTI_Line);
156
157 /* Interrupts and flags management functions **********************************/
158 FlagStatus EXTI_GetFlagStatus(uint32_t EXTI_Line);
159 void EXTI_ClearFlag(uint32_t EXTI_Line);
160 ITStatus EXTI_GetITStatus(uint32_t EXTI_Line);
161 void EXTI_ClearITPendingBit(uint32_t EXTI_Line);
162
163 #ifdef __cplusplus
164 }
165 #endif
166
167 #endif /* __STM32F4xx_EXTI_H */
168
169 /**
170   * @}
171   */
172
173 /**
174   * @}
175   */
176
177 /******************* (C) COPYRIGHT 2011 STMicroelectronics *****END OF FILE****/