1 /**
2   ******************************************************************************
3   * @file    stm32h7rsxx_hal_gpio.h
4   * @author  MCD Application Team
5   * @brief   Header file of GPIO HAL module.
6   ******************************************************************************
7   * @attention
8   *
9   * Copyright (c) 2022 STMicroelectronics.
10   * All rights reserved.
11   *
12   * This software is licensed under terms that can be found in the LICENSE file
13   * in the root directory of this software component.
14   * If no LICENSE file comes with this software, it is provided AS-IS.
15   *
16   ******************************************************************************
17   */
18 
19 /* Define to prevent recursive inclusion -------------------------------------*/
20 #ifndef STM32H7RSxx_HAL_GPIO_H
21 #define STM32H7RSxx_HAL_GPIO_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /* Includes ------------------------------------------------------------------*/
28 #include "stm32h7rsxx_hal_def.h"
29 
30 /** @addtogroup STM32H7RSxx_HAL_Driver
31   * @{
32   */
33 
34 /** @defgroup GPIO GPIO
35   * @brief GPIO HAL module driver
36   * @{
37   */
38 
39 /* Exported types ------------------------------------------------------------*/
40 
41 /** @defgroup GPIO_Exported_Types GPIO Exported Types
42   * @{
43   */
44 /**
45   * @brief   GPIO Init structure definition
46   */
47 typedef struct
48 {
49   uint32_t Pin;        /*!< Specifies the GPIO pins to be configured.
50                             This parameter can be any value of @ref GPIO_pins */
51 
52   uint32_t Mode;       /*!< Specifies the operating mode for the selected pins.
53                             This parameter can be a value of @ref GPIO_mode */
54 
55   uint32_t Pull;       /*!< Specifies the Pull-up or Pull-Down activation for the selected pins.
56                             This parameter can be a value of @ref GPIO_pull */
57 
58   uint32_t Speed;      /*!< Specifies the speed for the selected pins.
59                             This parameter can be a value of @ref GPIO_speed */
60 
61   uint32_t Alternate;  /*!< Peripheral to be connected to the selected pins
62                             This parameter can be a value of @ref GPIOEx_Alternate_function_selection */
63 } GPIO_InitTypeDef;
64 
65 /**
66   * @brief  GPIO Bit SET and Bit RESET enumeration
67   */
68 typedef enum
69 {
70   GPIO_PIN_RESET = 0U,
71   GPIO_PIN_SET
72 } GPIO_PinState;
73 /**
74   * @}
75   */
76 
77 /* Exported constants --------------------------------------------------------*/
78 /** @defgroup GPIO_Exported_Constants GPIO Exported Constants
79   * @{
80   */
81 /** @defgroup GPIO_pins GPIO pins
82   * @{
83   */
84 #define GPIO_PIN_0                      ((uint16_t)0x0001)  /* Pin 0 selected    */
85 #define GPIO_PIN_1                      ((uint16_t)0x0002)  /* Pin 1 selected    */
86 #define GPIO_PIN_2                      ((uint16_t)0x0004)  /* Pin 2 selected    */
87 #define GPIO_PIN_3                      ((uint16_t)0x0008)  /* Pin 3 selected    */
88 #define GPIO_PIN_4                      ((uint16_t)0x0010)  /* Pin 4 selected    */
89 #define GPIO_PIN_5                      ((uint16_t)0x0020)  /* Pin 5 selected    */
90 #define GPIO_PIN_6                      ((uint16_t)0x0040)  /* Pin 6 selected    */
91 #define GPIO_PIN_7                      ((uint16_t)0x0080)  /* Pin 7 selected    */
92 #define GPIO_PIN_8                      ((uint16_t)0x0100)  /* Pin 8 selected    */
93 #define GPIO_PIN_9                      ((uint16_t)0x0200)  /* Pin 9 selected    */
94 #define GPIO_PIN_10                     ((uint16_t)0x0400)  /* Pin 10 selected   */
95 #define GPIO_PIN_11                     ((uint16_t)0x0800)  /* Pin 11 selected   */
96 #define GPIO_PIN_12                     ((uint16_t)0x1000)  /* Pin 12 selected   */
97 #define GPIO_PIN_13                     ((uint16_t)0x2000)  /* Pin 13 selected   */
98 #define GPIO_PIN_14                     ((uint16_t)0x4000)  /* Pin 14 selected   */
99 #define GPIO_PIN_15                     ((uint16_t)0x8000)  /* Pin 15 selected   */
100 #define GPIO_PIN_ALL                    ((uint16_t)0xFFFF)  /* All pins selected */
101 
102 #define GPIO_PIN_MASK                   (0x0000FFFFu) /* PIN mask for assert test */
103 /**
104   * @}
105   */
106 
107 /** @defgroup GPIO_mode GPIO mode
108   * @brief GPIO Configuration Mode
109   *        Elements values convention: 0x00WX00YZ
110   *           - W  : EXTI trigger detection on 3 bits
111   *           - X  : EXTI mode (IT or Event) on 2 bits
112   *           - Y  : Output type (Push Pull or Open Drain) on 1 bit
113   *           - Z  : GPIO mode (Input, Output, Alternate or Analog) on 2 bits
114   * @{
115   */
116 #define GPIO_MODE_INPUT                 MODE_INPUT                                                  /*!< Input Floating Mode                                                */
117 #define GPIO_MODE_OUTPUT_PP             (MODE_OUTPUT | OUTPUT_PP)                                   /*!< Output Push Pull Mode                                              */
118 #define GPIO_MODE_OUTPUT_OD             (MODE_OUTPUT | OUTPUT_OD)                                   /*!< Output Open Drain Mode                                             */
119 #define GPIO_MODE_AF_PP                 (MODE_AF | OUTPUT_PP)                                       /*!< Alternate Function Push Pull Mode                                  */
120 #define GPIO_MODE_AF_OD                 (MODE_AF | OUTPUT_OD)                                       /*!< Alternate Function Open Drain Mode                                 */
121 #define GPIO_MODE_ANALOG                MODE_ANALOG                                                 /*!< Analog Mode                                                        */
122 #define GPIO_MODE_IT_RISING             (MODE_INPUT | EXTI_IT | TRIGGER_RISING)                     /*!< External Interrupt Mode with Rising edge trigger detection         */
123 #define GPIO_MODE_IT_FALLING            (MODE_INPUT | EXTI_IT | TRIGGER_FALLING)                    /*!< External Interrupt Mode with Falling edge trigger detection        */
124 #define GPIO_MODE_IT_RISING_FALLING     (MODE_INPUT | EXTI_IT | TRIGGER_RISING | TRIGGER_FALLING)   /*!< External Interrupt Mode with Rising/Falling edge trigger detection */
125 #define GPIO_MODE_EVT_RISING            (MODE_INPUT | EXTI_EVT | TRIGGER_RISING)                    /*!< External Event Mode with Rising edge trigger detection             */
126 #define GPIO_MODE_EVT_FALLING           (MODE_INPUT | EXTI_EVT | TRIGGER_FALLING)                   /*!< External Event Mode with Falling edge trigger detection            */
127 #define GPIO_MODE_EVT_RISING_FALLING    (MODE_INPUT | EXTI_EVT | TRIGGER_RISING | TRIGGER_FALLING)  /*!< External Event Mode with Rising/Falling edge trigger detection     */
128 /**
129   * @}
130   */
131 
132 /** @defgroup GPIO_speed GPIO speed
133   * @brief GPIO Output Maximum frequency
134   * @{
135   */
136 #define GPIO_SPEED_FREQ_LOW             0x00000000u  /*!< Low speed       */
137 #define GPIO_SPEED_FREQ_MEDIUM          0x00000001u  /*!< Medium speed    */
138 #define GPIO_SPEED_FREQ_HIGH            0x00000002u  /*!< High speed      */
139 #define GPIO_SPEED_FREQ_VERY_HIGH       0x00000003u  /*!< Very high speed */
140 /**
141   * @}
142   */
143 
144 /** @defgroup GPIO_pull GPIO pull
145   * @brief GPIO Pull-Up or Pull-Down Activation
146   * @{
147   */
148 #define GPIO_NOPULL                     0x00000000u   /*!< No Pull-up or Pull-down activation  */
149 #define GPIO_PULLUP                     0x00000001u   /*!< Pull-up activation                  */
150 #define GPIO_PULLDOWN                   0x00000002u   /*!< Pull-down activation                */
151 /**
152   * @}
153   */
154 
155 /**
156   * @}
157   */
158 
159 /* Exported macro ------------------------------------------------------------*/
160 /** @defgroup GPIO_Exported_Macros GPIO Exported Macros
161   * @{
162   */
163 
164 /**
165   * @brief  Check whether the specified EXTI line flag is set or not.
166   * @param  __EXTI_LINE__ specifies the EXTI line flag to check.
167   *         This parameter can be GPIO_PIN_x where x can be(0..15)
168   * @retval The new state of __EXTI_LINE__ (SET or RESET).
169   */
170 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__)       (EXTI->PR1 & (__EXTI_LINE__))
171 
172 /**
173   * @brief  Clear the EXTI's line pending flags.
174   * @param  __EXTI_LINE__ specifies the EXTI lines flags to clear.
175   *         This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
176   * @retval None
177   */
178 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__)     (EXTI->PR1 = (__EXTI_LINE__))
179 
180 /**
181   * @brief  Check whether the specified EXTI line is asserted or not.
182   * @param  __EXTI_LINE__ specifies the EXTI line to check.
183   *         This parameter can be GPIO_PIN_x where x can be(0..15)
184   * @retval The new state of __EXTI_LINE__ (SET or RESET).
185   */
186 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__)         (EXTI->PR1 & (__EXTI_LINE__))
187 
188 /**
189   * @brief  Clear the EXTI's line pending bits.
190   * @param  __EXTI_LINE__ specifies the EXTI lines to clear.
191   *         This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
192   * @retval None
193   */
194 #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__)       (EXTI->PR1 = (__EXTI_LINE__))
195 
196 /**
197   * @brief  Generate a Software interrupt on selected EXTI line(s).
198   * @param  __EXTI_LINE__ specifies the EXTI line to be set.
199   *          This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
200   * @retval None
201   */
202 #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__)  (EXTI->SWIER1 = (__EXTI_LINE__))
203 /**
204   * @}
205   */
206 
207 /* Private macros ------------------------------------------------------------*/
208 /** @defgroup GPIO_Private_Constants GPIO Private Constants
209   * @{
210   */
211 #define GPIO_MODE_Pos                           0u
212 #define GPIO_MODE                               (0x3uL << GPIO_MODE_Pos)
213 #define MODE_INPUT                              (0x0uL << GPIO_MODE_Pos)
214 #define MODE_OUTPUT                             (0x1uL << GPIO_MODE_Pos)
215 #define MODE_AF                                 (0x2uL << GPIO_MODE_Pos)
216 #define MODE_ANALOG                             (0x3uL << GPIO_MODE_Pos)
217 #define OUTPUT_TYPE_Pos                         4u
218 #define OUTPUT_TYPE                             (0x1uL << OUTPUT_TYPE_Pos)
219 #define OUTPUT_PP                               (0x0uL << OUTPUT_TYPE_Pos)
220 #define OUTPUT_OD                               (0x1uL << OUTPUT_TYPE_Pos)
221 #define EXTI_MODE_Pos                           16u
222 #define EXTI_MODE                               (0x3uL << EXTI_MODE_Pos)
223 #define EXTI_IT                                 (0x1uL << EXTI_MODE_Pos)
224 #define EXTI_EVT                                (0x2uL << EXTI_MODE_Pos)
225 #define TRIGGER_MODE_Pos                         20u
226 #define TRIGGER_MODE                            (0x7uL << TRIGGER_MODE_Pos)
227 #define TRIGGER_RISING                          (0x1uL << TRIGGER_MODE_Pos)
228 #define TRIGGER_FALLING                         (0x2uL << TRIGGER_MODE_Pos)
229 /**
230   * @}
231   */
232 
233 /** @defgroup GPIO_Private_Macros GPIO Private Macros
234   * @{
235   */
236 #define IS_GPIO_PIN_ACTION(ACTION)  (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET))
237 
238 #define IS_GPIO_PIN(__PIN__)        ((((uint32_t)(__PIN__) & GPIO_PIN_MASK) != 0x00u) &&\
239                                      (((uint32_t)(__PIN__) & ~GPIO_PIN_MASK) == 0x00u))
240 
241 #define IS_GPIO_COMMON_PIN(__RESETMASK__, __SETMASK__)  \
242   (((uint32_t)(__RESETMASK__) & (uint32_t)(__SETMASK__)) == 0x00u)
243 
244 #define IS_GPIO_MODE(__MODE__)      (((__MODE__) == GPIO_MODE_INPUT)              ||\
245                                      ((__MODE__) == GPIO_MODE_OUTPUT_PP)          ||\
246                                      ((__MODE__) == GPIO_MODE_OUTPUT_OD)          ||\
247                                      ((__MODE__) == GPIO_MODE_AF_PP)              ||\
248                                      ((__MODE__) == GPIO_MODE_AF_OD)              ||\
249                                      ((__MODE__) == GPIO_MODE_IT_RISING)          ||\
250                                      ((__MODE__) == GPIO_MODE_IT_FALLING)         ||\
251                                      ((__MODE__) == GPIO_MODE_IT_RISING_FALLING)  ||\
252                                      ((__MODE__) == GPIO_MODE_EVT_RISING)         ||\
253                                      ((__MODE__) == GPIO_MODE_EVT_FALLING)        ||\
254                                      ((__MODE__) == GPIO_MODE_EVT_RISING_FALLING) ||\
255                                      ((__MODE__) == GPIO_MODE_ANALOG))
256 
257 #define IS_GPIO_SPEED(__SPEED__)    (((__SPEED__) == GPIO_SPEED_FREQ_LOW)       ||\
258                                      ((__SPEED__) == GPIO_SPEED_FREQ_MEDIUM)    ||\
259                                      ((__SPEED__) == GPIO_SPEED_FREQ_HIGH)      ||\
260                                      ((__SPEED__) == GPIO_SPEED_FREQ_VERY_HIGH))
261 
262 #define IS_GPIO_PULL(__PULL__)      (((__PULL__) == GPIO_NOPULL)   ||\
263                                      ((__PULL__) == GPIO_PULLUP)   || \
264                                      ((__PULL__) == GPIO_PULLDOWN))
265 /**
266   * @}
267   */
268 
269 /* Include GPIO HAL Extended module */
270 #include "stm32h7rsxx_hal_gpio_ex.h"
271 
272 /* Exported functions --------------------------------------------------------*/
273 /** @defgroup GPIO_Exported_Functions GPIO Exported Functions
274   * @brief    GPIO Exported Functions
275   * @{
276   */
277 
278 /** @defgroup GPIO_Exported_Functions_Group1 Initialization/de-initialization functions
279   * @brief    Initialization and Configuration functions
280   * @{
281   */
282 
283 /* Initialization and de-initialization functions *****************************/
284 void              HAL_GPIO_Init(GPIO_TypeDef  *GPIOx, const GPIO_InitTypeDef *GPIO_Init);
285 void              HAL_GPIO_DeInit(GPIO_TypeDef  *GPIOx, uint32_t GPIO_Pin);
286 
287 /**
288   * @}
289   */
290 
291 /** @defgroup GPIO_Exported_Functions_Group2 IO operation functions
292   * @brief    IO operation functions
293   * @{
294   */
295 
296 /* IO operation functions *****************************************************/
297 GPIO_PinState     HAL_GPIO_ReadPin(const GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);
298 void              HAL_GPIO_WritePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState);
299 void              HAL_GPIO_WriteMultipleStatePin(GPIO_TypeDef *GPIOx, uint16_t PinReset, uint16_t PinSet);
300 void              HAL_GPIO_TogglePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);
301 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);
302 void              HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin);
303 void              HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin);
304 
305 /**
306   * @}
307   */
308 
309 /**
310   * @}
311   */
312 
313 /**
314   * @}
315   */
316 
317 /**
318   * @}
319   */
320 
321 #ifdef __cplusplus
322 }
323 #endif
324 
325 #endif /* STM32H7RSxx_HAL_GPIO_H */
326