lib/main/STM32F7/Drivers/STM32F7xx_HAL_Driver/Inc/stm32f7xx_hal_exti.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f7xx_hal_exti.h
   4   * @author  MCD Application Team
   5   * @brief   Header file of EXTI HAL module.
   6   ******************************************************************************
   7   * @attention
   8   *
   9   * <h2><center>&copy; Copyright (c) 2018 STMicroelectronics.
  10   * All rights reserved.</center></h2>
  11   *
  12   * This software component is licensed by ST under BSD 3-Clause license,
  13   * the "License"; You may not use this file except in compliance with the
  14   * License. You may obtain a copy of the License at:
  15   *                        opensource.org/licenses/BSD-3-Clause
  16   *
  17   ******************************************************************************
  18   */
  19
  20 /* Define to prevent recursive inclusion -------------------------------------*/
  21 #ifndef __STM32F7xx_HAL_EXTI_H
  22 #define __STM32F7xx_HAL_EXTI_H
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /* Includes ------------------------------------------------------------------*/
  29 #include "stm32f7xx_hal_def.h"
  30
  31 /** @addtogroup STM32F7xx_HAL_Driver
  32   * @{
  33   */
  34
  35 /** @defgroup EXTI EXTI
  36   * @brief EXTI HAL module driver
  37   * @{
  38   */
  39
  40 /* Exported types ------------------------------------------------------------*/
  41 /** @defgroup EXTI_Exported_Types EXTI Exported Types
  42   * @{
  43   */
  44 typedef enum
  45 {
  46   HAL_EXTI_COMMON_CB_ID          = 0x00U,
  47   HAL_EXTI_RISING_CB_ID          = 0x01U,
  48   HAL_EXTI_FALLING_CB_ID         = 0x02U,
  49 } EXTI_CallbackIDTypeDef;
  50
  51 /**
  52   * @brief  EXTI Handle structure definition
  53   */
  54 typedef struct
  55 {
  56   uint32_t Line;                    /*!<  Exti line number */
  57   void (* PendingCallback)(void);   /*!<  Exti pending callback */
  58 } EXTI_HandleTypeDef;
  59
  60 /**
  61   * @brief  EXTI Configuration structure definition
  62   */
  63 typedef struct
  64 {
  65   uint32_t Line;      /*!< The Exti line to be configured. This parameter
  66                            can be a value of @ref EXTI_Line */
  67   uint32_t Mode;      /*!< The Exit Mode to be configured for a core.
  68                            This parameter can be a combination of @ref EXTI_Mode */
  69   uint32_t Trigger;   /*!< The Exti Trigger to be configured. This parameter
  70                            can be a value of @ref EXTI_Trigger */
  71 } EXTI_ConfigTypeDef;
  72
  73 /**
  74   * @}
  75   */
  76
  77 /* Exported constants --------------------------------------------------------*/
  78 /** @defgroup EXTI_Exported_Constants EXTI Exported Constants
  79   * @{
  80   */
  81
  82 /** @defgroup EXTI_Line  EXTI Line
  83   * @{
  84   */
  85 #define EXTI_LINE_0                          EXTI_IMR_IM0     /*!< External interrupt line 0 */
  86 #define EXTI_LINE_1                          EXTI_IMR_IM1     /*!< External interrupt line 1 */
  87 #define EXTI_LINE_2                          EXTI_IMR_IM2     /*!< External interrupt line 2 */
  88 #define EXTI_LINE_3                          EXTI_IMR_IM3     /*!< External interrupt line 3 */
  89 #define EXTI_LINE_4                          EXTI_IMR_IM4     /*!< External interrupt line 4 */
  90 #define EXTI_LINE_5                          EXTI_IMR_IM5     /*!< External interrupt line 5 */
  91 #define EXTI_LINE_6                          EXTI_IMR_IM6     /*!< External interrupt line 6 */
  92 #define EXTI_LINE_7                          EXTI_IMR_IM7     /*!< External interrupt line 7 */
  93 #define EXTI_LINE_8                          EXTI_IMR_IM8     /*!< External interrupt line 8 */
  94 #define EXTI_LINE_9                          EXTI_IMR_IM9     /*!< External interrupt line 9 */
  95 #define EXTI_LINE_10                         EXTI_IMR_IM10    /*!< External interrupt line 10 */
  96 #define EXTI_LINE_11                         EXTI_IMR_IM11    /*!< External interrupt line 11 */
  97 #define EXTI_LINE_12                         EXTI_IMR_IM12    /*!< External interrupt line 12 */
  98 #define EXTI_LINE_13                         EXTI_IMR_IM13    /*!< External interrupt line 13 */
  99 #define EXTI_LINE_14                         EXTI_IMR_IM14    /*!< External interrupt line 14 */
 100 #define EXTI_LINE_15                         EXTI_IMR_IM15    /*!< External interrupt line 15 */
 101 #if defined(EXTI_IMR_IM16)
 102 #define EXTI_LINE_16                         EXTI_IMR_IM16    /*!< External interrupt line 16 Connected to the PVD Output */
 103 #endif /* EXTI_IMR_IM16 */
 104 #if defined(EXTI_IMR_IM17)
 105 #define EXTI_LINE_17                         EXTI_IMR_IM17    /*!< External interrupt line 17 Connected to the RTC Alarm event */
 106 #endif /* EXTI_IMR_IM17 */
 107 #if defined(EXTI_IMR_IM18)
 108 #define EXTI_LINE_18                         EXTI_IMR_IM18    /*!< External interrupt line 18 Connected to the USB OTG FS Wakeup from suspend event */
 109 #endif /* EXTI_IMR_IM18 */
 110 #if defined(EXTI_IMR_IM19)
 111 #define EXTI_LINE_19                         EXTI_IMR_IM19    /*!< External interrupt line 19 Connected to the Ethernet Wakeup event */
 112 #endif /* EXTI_IMR_IM19 */
 113 #if defined(EXTI_IMR_IM20)
 114 #define EXTI_LINE_20                         EXTI_IMR_IM20    /*!< External interrupt line 20 Connected to the USB OTG HS (configured in FS) Wakeup event  */
 115 #endif /* EXTI_IMR_IM20 */
 116 #if defined(EXTI_IMR_IM21)
 117 #define EXTI_LINE_21                         EXTI_IMR_IM21    /*!< External interrupt line 21 Connected to the RTC Tamper and Time Stamp events */
 118 #endif /* EXTI_IMR_IM21 */
 119 #if defined(EXTI_IMR_IM22)
 120 #define EXTI_LINE_22                         EXTI_IMR_IM22    /*!< External interrupt line 22 Connected to the RTC Wakeup event */
 121 #endif /* EXTI_IMR_IM22 */
 122 #if defined(EXTI_IMR_IM23)
 123 #define EXTI_LINE_23                         EXTI_IMR_IM23    /*!< External interrupt line 23 Connected to the LPTIM Wakeup event */
 124 #endif /* EXTI_IMR_IM23 */
 125 #if defined(EXTI_IMR_IM24)
 126 #define EXTI_LINE_24                         EXTI_IMR_IM24    /*!< External interrupt line 24 Connected to the MDIO Slave global Interrupt Wakeup event */
 127 #endif /* EXTI_IMR_IM24 */
 128 /**
 129   * @}
 130   */
 131
 132 /** @defgroup EXTI_Mode  EXTI Mode
 133   * @{
 134   */
 135 #define EXTI_MODE_NONE                      0x00000000u
 136 #define EXTI_MODE_INTERRUPT                 0x00000001u
 137 #define EXTI_MODE_EVENT                     0x00000002u
 138 /**
 139   * @}
 140   */
 141
 142 /** @defgroup EXTI_Trigger  EXTI Trigger
 143   * @{
 144   */
 145 #define EXTI_TRIGGER_NONE                   0x00000000u
 146 #define EXTI_TRIGGER_RISING                 0x00000001u
 147 #define EXTI_TRIGGER_FALLING                0x00000002u
 148 #define EXTI_TRIGGER_RISING_FALLING         (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING)
 149 /**
 150   * @}
 151   */
 152
 153 /**
 154   * @}
 155   */
 156
 157 /* Exported macro ------------------------------------------------------------*/
 158 /** @defgroup EXTI_Exported_Macros EXTI Exported Macros
 159   * @{
 160   */
 161
 162 /**
 163   * @}
 164   */
 165
 166 /* Private constants --------------------------------------------------------*/
 167 /** @defgroup EXTI_Private_Constants EXTI Private Constants
 168   * @{
 169   */
 170 /**
 171   * @brief  EXTI Mask for interrupt & event mode
 172   */
 173 #define EXTI_MODE_MASK                      (EXTI_MODE_EVENT | EXTI_MODE_INTERRUPT)
 174
 175 /**
 176   * @brief  EXTI Mask for trigger possibilities
 177   */
 178 #define EXTI_TRIGGER_MASK                   (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING | EXTI_TRIGGER_RISING_FALLING)
 179
 180 /**
 181   * @brief  EXTI Line number
 182   */
 183 #define EXTI_LINE_NB                        25u
 184
 185 /**
 186   * @}
 187   */
 188
 189 /* Private macros ------------------------------------------------------------*/
 190 /** @defgroup EXTI_Private_Macros EXTI Private Macros
 191   * @{
 192   */
 193 #define IS_EXTI_LINE(__LINE__)          ((((__LINE__) & ~EXTI_IMR_IM) == 0x00U) && (__LINE__))
 194
 195 #define IS_EXTI_MODE(__LINE__)          ((((__LINE__) & ~EXTI_MODE_MASK) == 0x00U))
 196
 197 #define IS_EXTI_TRIGGER(__LINE__)       (((__LINE__)  & ~EXTI_TRIGGER_MASK) == 0x00U)
 198
 199 #define IS_EXTI_PENDING_EDGE(__LINE__)  (((__LINE__) == EXTI_TRIGGER_FALLING) || \
 200                                          ((__LINE__) == EXTI_TRIGGER_RISING)  || \
 201                                          ((__LINE__) == EXTI_TRIGGER_RISING_FALLING))
 202
 203 #define IS_EXTI_GPIO_PIN(__PIN__)       ((__PIN__) < 16U)
 204 /**
 205   * @}
 206   */
 207
 208 /* Exported functions --------------------------------------------------------*/
 209 /** @defgroup EXTI_Exported_Functions EXTI Exported Functions
 210   * @brief    EXTI Exported Functions
 211   * @{
 212   */
 213
 214 /** @defgroup EXTI_Exported_Functions_Group1 Configuration functions
 215   * @brief    Configuration functions
 216   * @{
 217   */
 218 /* Configuration functions ****************************************************/
 219 HAL_StatusTypeDef HAL_EXTI_SetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig);
 220 HAL_StatusTypeDef HAL_EXTI_GetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig);
 221 HAL_StatusTypeDef HAL_EXTI_ClearConfigLine(EXTI_HandleTypeDef *hexti);
 222 HAL_StatusTypeDef HAL_EXTI_RegisterCallback(EXTI_HandleTypeDef *hexti, EXTI_CallbackIDTypeDef CallbackID, void (*pPendingCbfn)(void));
 223 HAL_StatusTypeDef HAL_EXTI_GetHandle(EXTI_HandleTypeDef *hexti, uint32_t ExtiLine);
 224 /**
 225   * @}
 226   */
 227
 228 /** @defgroup EXTI_Exported_Functions_Group2 IO operation functions
 229   * @brief    IO operation functions
 230   * @{
 231   */
 232 /* IO operation functions *****************************************************/
 233 void HAL_EXTI_IRQHandler(EXTI_HandleTypeDef *hexti);
 234 uint32_t HAL_EXTI_GetPending(EXTI_HandleTypeDef *hexti, uint32_t Edge);
 235 void HAL_EXTI_ClearPending(EXTI_HandleTypeDef *hexti, uint32_t Edge);
 236 void HAL_EXTI_GenerateSWI(EXTI_HandleTypeDef *hexti);
 237
 238 /**
 239   * @}
 240   */
 241
 242 /**
 243   * @}
 244   */
 245
 246 /**
 247   * @}
 248   */
 249
 250 /**
 251   * @}
 252   */
 253
 254 #ifdef __cplusplus
 255 }
 256 #endif
 257
 258 #endif /* __STM32F7xx_HAL_EXTI_H */
 259
 260 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/