2 ******************************************************************************
\r
3 * @file stm32f7xx_hal_gpio_ex.h
\r
4 * @author MCD Application Team
\r
6 * @date 24-March-2015
\r
7 * @brief Header file of GPIO HAL Extension module.
\r
8 ******************************************************************************
\r
11 * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
\r
13 * Redistribution and use in source and binary forms, with or without modification,
\r
14 * are permitted provided that the following conditions are met:
\r
15 * 1. Redistributions of source code must retain the above copyright notice,
\r
16 * this list of conditions and the following disclaimer.
\r
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
\r
18 * this list of conditions and the following disclaimer in the documentation
\r
19 * and/or other materials provided with the distribution.
\r
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
\r
21 * may be used to endorse or promote products derived from this software
\r
22 * without specific prior written permission.
\r
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
\r
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
\r
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
\r
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
\r
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
\r
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
\r
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
\r
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
\r
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
\r
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\r
35 ******************************************************************************
\r
38 /* Define to prevent recursive inclusion -------------------------------------*/
\r
39 #ifndef __STM32F7xx_HAL_GPIO_EX_H
\r
40 #define __STM32F7xx_HAL_GPIO_EX_H
\r
46 /* Includes ------------------------------------------------------------------*/
\r
47 #include "stm32f7xx_hal_def.h"
\r
49 /** @addtogroup STM32F7xx_HAL_Driver
\r
53 /** @defgroup GPIOEx GPIOEx
\r
57 /* Exported types ------------------------------------------------------------*/
\r
59 /* Exported constants --------------------------------------------------------*/
\r
60 /** @defgroup GPIOEx_Exported_Constants GPIO Exported Constants
\r
64 /** @defgroup GPIO_Alternate_function_selection GPIO Alternate Function Selection
\r
69 * @brief AF 0 selection
\r
71 #define GPIO_AF0_RTC_50Hz ((uint8_t)0x00) /* RTC_50Hz Alternate Function mapping */
\r
72 #define GPIO_AF0_MCO ((uint8_t)0x00) /* MCO (MCO1 and MCO2) Alternate Function mapping */
\r
73 #define GPIO_AF0_SWJ ((uint8_t)0x00) /* SWJ (SWD and JTAG) Alternate Function mapping */
\r
74 #define GPIO_AF0_TRACE ((uint8_t)0x00) /* TRACE Alternate Function mapping */
\r
77 * @brief AF 1 selection
\r
79 #define GPIO_AF1_TIM1 ((uint8_t)0x01) /* TIM1 Alternate Function mapping */
\r
80 #define GPIO_AF1_TIM2 ((uint8_t)0x01) /* TIM2 Alternate Function mapping */
\r
83 * @brief AF 2 selection
\r
85 #define GPIO_AF2_TIM3 ((uint8_t)0x02) /* TIM3 Alternate Function mapping */
\r
86 #define GPIO_AF2_TIM4 ((uint8_t)0x02) /* TIM4 Alternate Function mapping */
\r
87 #define GPIO_AF2_TIM5 ((uint8_t)0x02) /* TIM5 Alternate Function mapping */
\r
90 * @brief AF 3 selection
\r
92 #define GPIO_AF3_TIM8 ((uint8_t)0x03) /* TIM8 Alternate Function mapping */
\r
93 #define GPIO_AF3_TIM9 ((uint8_t)0x03) /* TIM9 Alternate Function mapping */
\r
94 #define GPIO_AF3_TIM10 ((uint8_t)0x03) /* TIM10 Alternate Function mapping */
\r
95 #define GPIO_AF3_TIM11 ((uint8_t)0x03) /* TIM11 Alternate Function mapping */
\r
96 #define GPIO_AF3_LPTIM1 ((uint8_t)0x03) /* LPTIM1 Alternate Function mapping */
\r
97 #define GPIO_AF3_CEC ((uint8_t)0x03) /* CEC Alternate Function mapping */
\r
101 * @brief AF 4 selection
\r
103 #define GPIO_AF4_I2C1 ((uint8_t)0x04) /* I2C1 Alternate Function mapping */
\r
104 #define GPIO_AF4_I2C2 ((uint8_t)0x04) /* I2C2 Alternate Function mapping */
\r
105 #define GPIO_AF4_I2C3 ((uint8_t)0x04) /* I2C3 Alternate Function mapping */
\r
106 #define GPIO_AF4_I2C4 ((uint8_t)0x04) /* I2C4 Alternate Function mapping */
\r
107 #define GPIO_AF4_CEC ((uint8_t)0x04) /* CEC Alternate Function mapping */
\r
110 * @brief AF 5 selection
\r
112 #define GPIO_AF5_SPI1 ((uint8_t)0x05) /* SPI1 Alternate Function mapping */
\r
113 #define GPIO_AF5_SPI2 ((uint8_t)0x05) /* SPI2/I2S2 Alternate Function mapping */
\r
114 #define GPIO_AF5_SPI3 ((uint8_t)0x05) /* SPI3/I2S3 Alternate Function mapping */
\r
115 #define GPIO_AF5_SPI4 ((uint8_t)0x05) /* SPI4 Alternate Function mapping */
\r
116 #define GPIO_AF5_SPI5 ((uint8_t)0x05) /* SPI5 Alternate Function mapping */
\r
117 #define GPIO_AF5_SPI6 ((uint8_t)0x05) /* SPI6 Alternate Function mapping */
\r
120 * @brief AF 6 selection
\r
122 #define GPIO_AF6_SPI3 ((uint8_t)0x06) /* SPI3/I2S3 Alternate Function mapping */
\r
123 #define GPIO_AF6_SAI1 ((uint8_t)0x06) /* SAI1 Alternate Function mapping */
\r
126 * @brief AF 7 selection
\r
128 #define GPIO_AF7_USART1 ((uint8_t)0x07) /* USART1 Alternate Function mapping */
\r
129 #define GPIO_AF7_USART2 ((uint8_t)0x07) /* USART2 Alternate Function mapping */
\r
130 #define GPIO_AF7_USART3 ((uint8_t)0x07) /* USART3 Alternate Function mapping */
\r
131 #define GPIO_AF7_UART5 ((uint8_t)0x07) /* UART5 Alternate Function mapping */
\r
132 #define GPIO_AF7_SPDIFRX ((uint8_t)0x07) /* SPDIF-RX Alternate Function mapping */
\r
133 #define GPIO_AF7_SPI2 ((uint8_t)0x07) /* SPI2 Alternate Function mapping */
\r
134 #define GPIO_AF7_SPI3 ((uint8_t)0x07) /* SPI3 Alternate Function mapping */
\r
137 * @brief AF 8 selection
\r
139 #define GPIO_AF8_UART4 ((uint8_t)0x08) /* UART4 Alternate Function mapping */
\r
140 #define GPIO_AF8_UART5 ((uint8_t)0x08) /* UART5 Alternate Function mapping */
\r
141 #define GPIO_AF8_USART6 ((uint8_t)0x08) /* USART6 Alternate Function mapping */
\r
142 #define GPIO_AF8_UART7 ((uint8_t)0x08) /* UART7 Alternate Function mapping */
\r
143 #define GPIO_AF8_UART8 ((uint8_t)0x08) /* UART8 Alternate Function mapping */
\r
144 #define GPIO_AF8_SPDIFRX ((uint8_t)0x08) /* SPIDIF-RX Alternate Function mapping */
\r
145 #define GPIO_AF8_SAI2 ((uint8_t)0x08) /* SAI2 Alternate Function mapping */
\r
149 * @brief AF 9 selection
\r
151 #define GPIO_AF9_CAN1 ((uint8_t)0x09) /* CAN1 Alternate Function mapping */
\r
152 #define GPIO_AF9_CAN2 ((uint8_t)0x09) /* CAN2 Alternate Function mapping */
\r
153 #define GPIO_AF9_TIM12 ((uint8_t)0x09) /* TIM12 Alternate Function mapping */
\r
154 #define GPIO_AF9_TIM13 ((uint8_t)0x09) /* TIM13 Alternate Function mapping */
\r
155 #define GPIO_AF9_TIM14 ((uint8_t)0x09) /* TIM14 Alternate Function mapping */
\r
156 #define GPIO_AF9_LTDC ((uint8_t)0x09) /* LCD-TFT Alternate Function mapping */
\r
157 #define GPIO_AF9_QUADSPI ((uint8_t)0x09) /* QUADSPI Alternate Function mapping */
\r
160 * @brief AF 10 selection
\r
162 #define GPIO_AF10_OTG_FS ((uint8_t)0xA) /* OTG_FS Alternate Function mapping */
\r
163 #define GPIO_AF10_OTG_HS ((uint8_t)0xA) /* OTG_HS Alternate Function mapping */
\r
164 #define GPIO_AF10_QUADSPI ((uint8_t)0xA) /* QUADSPI Alternate Function mapping */
\r
165 #define GPIO_AF10_SAI2 ((uint8_t)0xA) /* SAI2 Alternate Function mapping */
\r
168 * @brief AF 11 selection
\r
170 #define GPIO_AF11_ETH ((uint8_t)0x0B) /* ETHERNET Alternate Function mapping */
\r
173 * @brief AF 12 selection
\r
175 #define GPIO_AF12_FMC ((uint8_t)0xC) /* FMC Alternate Function mapping */
\r
176 #define GPIO_AF12_OTG_HS_FS ((uint8_t)0xC) /* OTG HS configured in FS, Alternate Function mapping */
\r
177 #define GPIO_AF12_SDMMC ((uint8_t)0xC) /* SDMMC Alternate Function mapping */
\r
180 * @brief AF 13 selection
\r
182 #define GPIO_AF13_DCMI ((uint8_t)0x0D) /* DCMI Alternate Function mapping */
\r
185 * @brief AF 14 selection
\r
187 #define GPIO_AF14_LTDC ((uint8_t)0x0E) /* LCD-TFT Alternate Function mapping */
\r
190 * @brief AF 15 selection
\r
192 #define GPIO_AF15_EVENTOUT ((uint8_t)0x0F) /* EVENTOUT Alternate Function mapping */
\r
203 /* Exported macro ------------------------------------------------------------*/
\r
204 /** @defgroup GPIOEx_Exported_Macros GPIO Exported Macros
\r
211 /* Exported functions --------------------------------------------------------*/
\r
212 /** @defgroup GPIOEx_Exported_Functions GPIO Exported Functions
\r
218 /* Private types -------------------------------------------------------------*/
\r
219 /* Private variables ---------------------------------------------------------*/
\r
220 /* Private constants ---------------------------------------------------------*/
\r
221 /** @defgroup GPIOEx_Private_Constants GPIO Private Constants
\r
226 * @brief GPIO pin available on the platform
\r
228 /* Defines the available pins per GPIOs */
\r
229 #define GPIOA_PIN_AVAILABLE GPIO_PIN_All
\r
230 #define GPIOB_PIN_AVAILABLE GPIO_PIN_All
\r
231 #define GPIOC_PIN_AVAILABLE GPIO_PIN_All
\r
232 #define GPIOD_PIN_AVAILABLE GPIO_PIN_All
\r
233 #define GPIOE_PIN_AVAILABLE GPIO_PIN_All
\r
234 #define GPIOF_PIN_AVAILABLE GPIO_PIN_All
\r
235 #define GPIOG_PIN_AVAILABLE GPIO_PIN_All
\r
236 #define GPIOI_PIN_AVAILABLE GPIO_PIN_All
\r
237 #define GPIOJ_PIN_AVAILABLE GPIO_PIN_All
\r
238 #define GPIOH_PIN_AVAILABLE GPIO_PIN_All
\r
239 #define GPIOK_PIN_AVAILABLE (GPIO_PIN_0 | GPIO_PIN_1 | GPIO_PIN_3 | GPIO_PIN_4 | \
\r
240 GPIO_PIN_5 | GPIO_PIN_6 | GPIO_PIN_7)
\r
246 /* Private macros ------------------------------------------------------------*/
\r
247 /** @defgroup GPIOEx_Private_Macros GPIO Private Macros
\r
250 /** @defgroup GPIOEx_Get_Port_Index GPIO Get Port Index
\r
253 #define GPIO_GET_INDEX(__GPIOx__) (uint8_t)(((__GPIOx__) == (GPIOA))? 0U :\
\r
254 ((__GPIOx__) == (GPIOB))? 1U :\
\r
255 ((__GPIOx__) == (GPIOC))? 2U :\
\r
256 ((__GPIOx__) == (GPIOD))? 3U :\
\r
257 ((__GPIOx__) == (GPIOE))? 4U :\
\r
258 ((__GPIOx__) == (GPIOF))? 5U :\
\r
259 ((__GPIOx__) == (GPIOG))? 6U :\
\r
260 ((__GPIOx__) == (GPIOH))? 7U :\
\r
261 ((__GPIOx__) == (GPIOI))? 8U :\
\r
262 ((__GPIOx__) == (GPIOJ))? 9U : 10U)
\r
267 #define IS_GPIO_PIN_AVAILABLE(__INSTANCE__,__PIN__) \
\r
268 ((((__INSTANCE__) == GPIOA) && (((__PIN__) & (GPIOA_PIN_AVAILABLE)) != 0) && (((__PIN__) | (GPIOA_PIN_AVAILABLE)) == (GPIOA_PIN_AVAILABLE))) || \
\r
269 (((__INSTANCE__) == GPIOB) && (((__PIN__) & (GPIOB_PIN_AVAILABLE)) != 0) && (((__PIN__) | (GPIOB_PIN_AVAILABLE)) == (GPIOB_PIN_AVAILABLE))) || \
\r
270 (((__INSTANCE__) == GPIOC) && (((__PIN__) & (GPIOC_PIN_AVAILABLE)) != 0) && (((__PIN__) | (GPIOC_PIN_AVAILABLE)) == (GPIOC_PIN_AVAILABLE))) || \
\r
271 (((__INSTANCE__) == GPIOD) && (((__PIN__) & (GPIOD_PIN_AVAILABLE)) != 0) && (((__PIN__) | (GPIOD_PIN_AVAILABLE)) == (GPIOD_PIN_AVAILABLE))) || \
\r
272 (((__INSTANCE__) == GPIOE) && (((__PIN__) & (GPIOE_PIN_AVAILABLE)) != 0) && (((__PIN__) | (GPIOE_PIN_AVAILABLE)) == (GPIOE_PIN_AVAILABLE))) || \
\r
273 (((__INSTANCE__) == GPIOF) && (((__PIN__) & (GPIOF_PIN_AVAILABLE)) != 0) && (((__PIN__) | (GPIOF_PIN_AVAILABLE)) == (GPIOF_PIN_AVAILABLE))) || \
\r
274 (((__INSTANCE__) == GPIOG) && (((__PIN__) & (GPIOG_PIN_AVAILABLE)) != 0) && (((__PIN__) | (GPIOG_PIN_AVAILABLE)) == (GPIOG_PIN_AVAILABLE))) || \
\r
275 (((__INSTANCE__) == GPIOI) && (((__PIN__) & (GPIOI_PIN_AVAILABLE)) != 0) && (((__PIN__) | (GPIOI_PIN_AVAILABLE)) == (GPIOI_PIN_AVAILABLE))) || \
\r
276 (((__INSTANCE__) == GPIOJ) && (((__PIN__) & (GPIOJ_PIN_AVAILABLE)) != 0) && (((__PIN__) | (GPIOJ_PIN_AVAILABLE)) == (GPIOJ_PIN_AVAILABLE))) || \
\r
277 (((__INSTANCE__) == GPIOK) && (((__PIN__) & (GPIOK_PIN_AVAILABLE)) != 0) && (((__PIN__) | (GPIOK_PIN_AVAILABLE)) == (GPIOK_PIN_AVAILABLE))) || \
\r
278 (((__INSTANCE__) == GPIOH) && (((__PIN__) & (GPIOH_PIN_AVAILABLE)) != 0) && (((__PIN__) | (GPIOH_PIN_AVAILABLE)) == (GPIOH_PIN_AVAILABLE))))
\r
279 /** @defgroup GPIOEx_IS_Alternat_function_selection GPIO Check Alternate Function
\r
282 #define IS_GPIO_AF(AF) (((AF) == GPIO_AF0_RTC_50Hz) || ((AF) == GPIO_AF1_TIM1) || \
\r
283 ((AF) == GPIO_AF0_SWJ) || ((AF) == GPIO_AF0_TRACE) || \
\r
284 ((AF) == GPIO_AF0_MCO) || ((AF) == GPIO_AF1_TIM2) || \
\r
285 ((AF) == GPIO_AF2_TIM3) || ((AF) == GPIO_AF2_TIM4) || \
\r
286 ((AF) == GPIO_AF2_TIM5) || ((AF) == GPIO_AF3_TIM8) || \
\r
287 ((AF) == GPIO_AF3_TIM9) || ((AF) == GPIO_AF3_TIM10) || \
\r
288 ((AF) == GPIO_AF3_TIM11) || ((AF) == GPIO_AF3_LPTIM1) || \
\r
289 ((AF) == GPIO_AF3_CEC) || ((AF) == GPIO_AF4_CEC) || \
\r
290 ((AF) == GPIO_AF4_I2C1) || ((AF) == GPIO_AF4_I2C2) || \
\r
291 ((AF) == GPIO_AF4_I2C3) || ((AF) == GPIO_AF4_I2C4) || \
\r
292 ((AF) == GPIO_AF5_SPI1) || ((AF) == GPIO_AF5_SPI2) || \
\r
293 ((AF) == GPIO_AF5_SPI3) || ((AF) == GPIO_AF5_SPI4) || \
\r
294 ((AF) == GPIO_AF5_SPI5) || ((AF) == GPIO_AF5_SPI6) || \
\r
295 ((AF) == GPIO_AF6_SPI3) || ((AF) == GPIO_AF6_SAI1) || \
\r
296 ((AF) == GPIO_AF7_SPI3) || ((AF) == GPIO_AF7_SPI2) || \
\r
297 ((AF) == GPIO_AF7_USART1) || ((AF) == GPIO_AF7_USART2) || \
\r
298 ((AF) == GPIO_AF7_USART3) || ((AF) == GPIO_AF7_UART5) || \
\r
299 ((AF) == GPIO_AF7_SPDIFRX) || ((AF) == GPIO_AF8_SPDIFRX) || \
\r
300 ((AF) == GPIO_AF8_SAI2) || ((AF) == GPIO_AF8_USART6) || \
\r
301 ((AF) == GPIO_AF8_UART4) || ((AF) == GPIO_AF8_UART5) || \
\r
302 ((AF) == GPIO_AF8_UART7) || ((AF) == GPIO_AF8_UART8) || \
\r
303 ((AF) == GPIO_AF9_CAN1) || ((AF) == GPIO_AF9_CAN2) || \
\r
304 ((AF) == GPIO_AF9_TIM12) || ((AF) == GPIO_AF9_TIM12) || \
\r
305 ((AF) == GPIO_AF9_TIM14) || ((AF) == GPIO_AF9_QUADSPI) || \
\r
306 ((AF) == GPIO_AF9_LTDC) || ((AF) == GPIO_AF10_OTG_FS) || \
\r
307 ((AF) == GPIO_AF10_OTG_HS) || ((AF) == GPIO_AF10_SAI2) || \
\r
308 ((AF) == GPIO_AF10_QUADSPI) || ((AF) == GPIO_AF11_ETH) || \
\r
309 ((AF) == GPIO_AF12_OTG_HS_FS) || ((AF) == GPIO_AF12_SDMMC) || \
\r
310 ((AF) == GPIO_AF12_FMC) || ((AF) == GPIO_AF15_EVENTOUT) || \
\r
311 ((AF) == GPIO_AF13_DCMI) || ((AF) == GPIO_AF14_LTDC))
\r
320 /* Private functions ---------------------------------------------------------*/
\r
321 /** @defgroup GPIOEx_Private_Functions GPIO Private Functions
\r
341 #endif /* __STM32F7xx_HAL_GPIO_EX_H */
\r
343 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
\r