Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_NUCLEO_F401RE/stm32f4xx_hal_gpio.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
90:cb3d968589d8
Child:
99:dbbf35b96557
dgdgr

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 77:869cf507173a 1 /**
emilmont 77:869cf507173a 2 ******************************************************************************
emilmont 77:869cf507173a 3 * @file stm32f4xx_hal_gpio.h
emilmont 77:869cf507173a 4 * @author MCD Application Team
Kojto 90:cb3d968589d8 5 * @version V1.1.0
Kojto 90:cb3d968589d8 6 * @date 19-June-2014
emilmont 77:869cf507173a 7 * @brief Header file of GPIO HAL module.
emilmont 77:869cf507173a 8 ******************************************************************************
emilmont 77:869cf507173a 9 * @attention
emilmont 77:869cf507173a 10 *
emilmont 77:869cf507173a 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
emilmont 77:869cf507173a 12 *
emilmont 77:869cf507173a 13 * Redistribution and use in source and binary forms, with or without modification,
emilmont 77:869cf507173a 14 * are permitted provided that the following conditions are met:
emilmont 77:869cf507173a 15 * 1. Redistributions of source code must retain the above copyright notice,
emilmont 77:869cf507173a 16 * this list of conditions and the following disclaimer.
emilmont 77:869cf507173a 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
emilmont 77:869cf507173a 18 * this list of conditions and the following disclaimer in the documentation
emilmont 77:869cf507173a 19 * and/or other materials provided with the distribution.
emilmont 77:869cf507173a 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
emilmont 77:869cf507173a 21 * may be used to endorse or promote products derived from this software
emilmont 77:869cf507173a 22 * without specific prior written permission.
emilmont 77:869cf507173a 23 *
emilmont 77:869cf507173a 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
emilmont 77:869cf507173a 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
emilmont 77:869cf507173a 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
emilmont 77:869cf507173a 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
emilmont 77:869cf507173a 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
emilmont 77:869cf507173a 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
emilmont 77:869cf507173a 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
emilmont 77:869cf507173a 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
emilmont 77:869cf507173a 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
emilmont 77:869cf507173a 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
emilmont 77:869cf507173a 34 *
emilmont 77:869cf507173a 35 ******************************************************************************
emilmont 77:869cf507173a 36 */
emilmont 77:869cf507173a 37
emilmont 77:869cf507173a 38 /* Define to prevent recursive inclusion -------------------------------------*/
emilmont 77:869cf507173a 39 #ifndef __STM32F4xx_HAL_GPIO_H
emilmont 77:869cf507173a 40 #define __STM32F4xx_HAL_GPIO_H
emilmont 77:869cf507173a 41
emilmont 77:869cf507173a 42 #ifdef __cplusplus
emilmont 77:869cf507173a 43 extern "C" {
emilmont 77:869cf507173a 44 #endif
emilmont 77:869cf507173a 45
emilmont 77:869cf507173a 46 /* Includes ------------------------------------------------------------------*/
emilmont 77:869cf507173a 47 #include "stm32f4xx_hal_def.h"
emilmont 77:869cf507173a 48
emilmont 77:869cf507173a 49 /** @addtogroup STM32F4xx_HAL_Driver
emilmont 77:869cf507173a 50 * @{
emilmont 77:869cf507173a 51 */
emilmont 77:869cf507173a 52
emilmont 77:869cf507173a 53 /** @addtogroup GPIO
emilmont 77:869cf507173a 54 * @{
emilmont 77:869cf507173a 55 */
emilmont 77:869cf507173a 56
emilmont 77:869cf507173a 57 /* Exported types ------------------------------------------------------------*/
emilmont 77:869cf507173a 58
emilmont 77:869cf507173a 59 /**
emilmont 77:869cf507173a 60 * @brief GPIO Init structure definition
emilmont 77:869cf507173a 61 */
emilmont 77:869cf507173a 62 typedef struct
emilmont 77:869cf507173a 63 {
emilmont 77:869cf507173a 64 uint32_t Pin; /*!< Specifies the GPIO pins to be configured.
emilmont 77:869cf507173a 65 This parameter can be any value of @ref GPIO_pins_define */
emilmont 77:869cf507173a 66
emilmont 77:869cf507173a 67 uint32_t Mode; /*!< Specifies the operating mode for the selected pins.
emilmont 77:869cf507173a 68 This parameter can be a value of @ref GPIO_mode_define */
emilmont 77:869cf507173a 69
emilmont 77:869cf507173a 70 uint32_t Pull; /*!< Specifies the Pull-up or Pull-Down activation for the selected pins.
emilmont 77:869cf507173a 71 This parameter can be a value of @ref GPIO_pull_define */
emilmont 77:869cf507173a 72
emilmont 77:869cf507173a 73 uint32_t Speed; /*!< Specifies the speed for the selected pins.
emilmont 77:869cf507173a 74 This parameter can be a value of @ref GPIO_speed_define */
emilmont 77:869cf507173a 75
bogdanm 85:024bf7f99721 76 uint32_t Alternate; /*!< Peripheral to be connected to the selected pins.
emilmont 77:869cf507173a 77 This parameter can be a value of @ref GPIO_Alternat_function_selection */
emilmont 77:869cf507173a 78 }GPIO_InitTypeDef;
emilmont 77:869cf507173a 79
emilmont 77:869cf507173a 80 /**
emilmont 77:869cf507173a 81 * @brief GPIO Bit SET and Bit RESET enumeration
emilmont 77:869cf507173a 82 */
emilmont 77:869cf507173a 83 typedef enum
emilmont 77:869cf507173a 84 {
emilmont 77:869cf507173a 85 GPIO_PIN_RESET = 0,
emilmont 77:869cf507173a 86 GPIO_PIN_SET
emilmont 77:869cf507173a 87 }GPIO_PinState;
emilmont 77:869cf507173a 88 #define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET))
emilmont 77:869cf507173a 89
emilmont 77:869cf507173a 90 /* Exported constants --------------------------------------------------------*/
emilmont 77:869cf507173a 91
emilmont 77:869cf507173a 92 /** @defgroup GPIO_Exported_Constants
emilmont 77:869cf507173a 93 * @{
emilmont 77:869cf507173a 94 */
emilmont 77:869cf507173a 95
emilmont 77:869cf507173a 96 /** @defgroup GPIO_pins_define
emilmont 77:869cf507173a 97 * @{
emilmont 77:869cf507173a 98 */
emilmont 77:869cf507173a 99 #define GPIO_PIN_0 ((uint16_t)0x0001) /* Pin 0 selected */
emilmont 77:869cf507173a 100 #define GPIO_PIN_1 ((uint16_t)0x0002) /* Pin 1 selected */
emilmont 77:869cf507173a 101 #define GPIO_PIN_2 ((uint16_t)0x0004) /* Pin 2 selected */
emilmont 77:869cf507173a 102 #define GPIO_PIN_3 ((uint16_t)0x0008) /* Pin 3 selected */
emilmont 77:869cf507173a 103 #define GPIO_PIN_4 ((uint16_t)0x0010) /* Pin 4 selected */
emilmont 77:869cf507173a 104 #define GPIO_PIN_5 ((uint16_t)0x0020) /* Pin 5 selected */
emilmont 77:869cf507173a 105 #define GPIO_PIN_6 ((uint16_t)0x0040) /* Pin 6 selected */
emilmont 77:869cf507173a 106 #define GPIO_PIN_7 ((uint16_t)0x0080) /* Pin 7 selected */
emilmont 77:869cf507173a 107 #define GPIO_PIN_8 ((uint16_t)0x0100) /* Pin 8 selected */
emilmont 77:869cf507173a 108 #define GPIO_PIN_9 ((uint16_t)0x0200) /* Pin 9 selected */
emilmont 77:869cf507173a 109 #define GPIO_PIN_10 ((uint16_t)0x0400) /* Pin 10 selected */
emilmont 77:869cf507173a 110 #define GPIO_PIN_11 ((uint16_t)0x0800) /* Pin 11 selected */
emilmont 77:869cf507173a 111 #define GPIO_PIN_12 ((uint16_t)0x1000) /* Pin 12 selected */
emilmont 77:869cf507173a 112 #define GPIO_PIN_13 ((uint16_t)0x2000) /* Pin 13 selected */
emilmont 77:869cf507173a 113 #define GPIO_PIN_14 ((uint16_t)0x4000) /* Pin 14 selected */
emilmont 77:869cf507173a 114 #define GPIO_PIN_15 ((uint16_t)0x8000) /* Pin 15 selected */
emilmont 77:869cf507173a 115 #define GPIO_PIN_All ((uint16_t)0xFFFF) /* All pins selected */
emilmont 77:869cf507173a 116
Kojto 90:cb3d968589d8 117 #define GPIO_PIN_MASK ((uint32_t)0x0000FFFF) /* PIN mask for assert test */
Kojto 90:cb3d968589d8 118 #define IS_GPIO_PIN(PIN) (((PIN) & GPIO_PIN_MASK ) != (uint32_t)0x00)
Kojto 90:cb3d968589d8 119
emilmont 77:869cf507173a 120 /**
emilmont 77:869cf507173a 121 * @}
emilmont 77:869cf507173a 122 */
emilmont 77:869cf507173a 123
emilmont 77:869cf507173a 124 /** @defgroup GPIO_mode_define
emilmont 77:869cf507173a 125 * @brief GPIO Configuration Mode
emilmont 77:869cf507173a 126 * Elements values convention: 0xX0yz00YZ
emilmont 77:869cf507173a 127 * - X : GPIO mode or EXTI Mode
emilmont 77:869cf507173a 128 * - y : External IT or Event trigger detection
emilmont 77:869cf507173a 129 * - z : IO configuration on External IT or Event
emilmont 77:869cf507173a 130 * - Y : Output type (Push Pull or Open Drain)
emilmont 77:869cf507173a 131 * - Z : IO Direction mode (Input, Output, Alternate or Analog)
emilmont 77:869cf507173a 132 * @{
emilmont 77:869cf507173a 133 */
emilmont 77:869cf507173a 134 #define GPIO_MODE_INPUT ((uint32_t)0x00000000) /*!< Input Floating Mode */
emilmont 77:869cf507173a 135 #define GPIO_MODE_OUTPUT_PP ((uint32_t)0x00000001) /*!< Output Push Pull Mode */
emilmont 77:869cf507173a 136 #define GPIO_MODE_OUTPUT_OD ((uint32_t)0x00000011) /*!< Output Open Drain Mode */
emilmont 77:869cf507173a 137 #define GPIO_MODE_AF_PP ((uint32_t)0x00000002) /*!< Alternate Function Push Pull Mode */
emilmont 77:869cf507173a 138 #define GPIO_MODE_AF_OD ((uint32_t)0x00000012) /*!< Alternate Function Open Drain Mode */
emilmont 77:869cf507173a 139
emilmont 77:869cf507173a 140 #define GPIO_MODE_ANALOG ((uint32_t)0x00000003) /*!< Analog Mode */
emilmont 77:869cf507173a 141
emilmont 77:869cf507173a 142 #define GPIO_MODE_IT_RISING ((uint32_t)0x10110000) /*!< External Interrupt Mode with Rising edge trigger detection */
emilmont 77:869cf507173a 143 #define GPIO_MODE_IT_FALLING ((uint32_t)0x10210000) /*!< External Interrupt Mode with Falling edge trigger detection */
emilmont 77:869cf507173a 144 #define GPIO_MODE_IT_RISING_FALLING ((uint32_t)0x10310000) /*!< External Interrupt Mode with Rising/Falling edge trigger detection */
emilmont 77:869cf507173a 145
emilmont 77:869cf507173a 146 #define GPIO_MODE_EVT_RISING ((uint32_t)0x10120000) /*!< External Event Mode with Rising edge trigger detection */
emilmont 77:869cf507173a 147 #define GPIO_MODE_EVT_FALLING ((uint32_t)0x10220000) /*!< External Event Mode with Falling edge trigger detection */
emilmont 77:869cf507173a 148 #define GPIO_MODE_EVT_RISING_FALLING ((uint32_t)0x10320000) /*!< External Event Mode with Rising/Falling edge trigger detection */
emilmont 77:869cf507173a 149
emilmont 77:869cf507173a 150 #define IS_GPIO_MODE(MODE) (((MODE) == GPIO_MODE_INPUT) ||\
emilmont 77:869cf507173a 151 ((MODE) == GPIO_MODE_OUTPUT_PP) ||\
emilmont 77:869cf507173a 152 ((MODE) == GPIO_MODE_OUTPUT_OD) ||\
emilmont 77:869cf507173a 153 ((MODE) == GPIO_MODE_AF_PP) ||\
emilmont 77:869cf507173a 154 ((MODE) == GPIO_MODE_AF_OD) ||\
emilmont 77:869cf507173a 155 ((MODE) == GPIO_MODE_IT_RISING) ||\
emilmont 77:869cf507173a 156 ((MODE) == GPIO_MODE_IT_FALLING) ||\
emilmont 77:869cf507173a 157 ((MODE) == GPIO_MODE_IT_RISING_FALLING) ||\
emilmont 77:869cf507173a 158 ((MODE) == GPIO_MODE_EVT_RISING) ||\
emilmont 77:869cf507173a 159 ((MODE) == GPIO_MODE_EVT_FALLING) ||\
emilmont 77:869cf507173a 160 ((MODE) == GPIO_MODE_EVT_RISING_FALLING) ||\
emilmont 77:869cf507173a 161 ((MODE) == GPIO_MODE_ANALOG))
emilmont 77:869cf507173a 162
emilmont 77:869cf507173a 163 /**
emilmont 77:869cf507173a 164 * @}
emilmont 77:869cf507173a 165 */
emilmont 77:869cf507173a 166 /** @defgroup GPIO_speed_define
emilmont 77:869cf507173a 167 * @brief GPIO Output Maximum frequency
emilmont 77:869cf507173a 168 * @{
emilmont 77:869cf507173a 169 */
emilmont 77:869cf507173a 170 #define GPIO_SPEED_LOW ((uint32_t)0x00000000) /*!< Low speed */
emilmont 77:869cf507173a 171 #define GPIO_SPEED_MEDIUM ((uint32_t)0x00000001) /*!< Medium speed */
emilmont 77:869cf507173a 172 #define GPIO_SPEED_FAST ((uint32_t)0x00000002) /*!< Fast speed */
emilmont 77:869cf507173a 173 #define GPIO_SPEED_HIGH ((uint32_t)0x00000003) /*!< High speed */
emilmont 77:869cf507173a 174
emilmont 77:869cf507173a 175 #define IS_GPIO_SPEED(SPEED) (((SPEED) == GPIO_SPEED_LOW) || ((SPEED) == GPIO_SPEED_MEDIUM) || \
emilmont 77:869cf507173a 176 ((SPEED) == GPIO_SPEED_FAST) || ((SPEED) == GPIO_SPEED_HIGH))
emilmont 77:869cf507173a 177 /**
emilmont 77:869cf507173a 178 * @}
emilmont 77:869cf507173a 179 */
emilmont 77:869cf507173a 180
emilmont 77:869cf507173a 181 /** @defgroup GPIO_pull_define
emilmont 77:869cf507173a 182 * @brief GPIO Pull-Up or Pull-Down Activation
emilmont 77:869cf507173a 183 * @{
emilmont 77:869cf507173a 184 */
emilmont 77:869cf507173a 185 #define GPIO_NOPULL ((uint32_t)0x00000000) /*!< No Pull-up or Pull-down activation */
emilmont 77:869cf507173a 186 #define GPIO_PULLUP ((uint32_t)0x00000001) /*!< Pull-up activation */
emilmont 77:869cf507173a 187 #define GPIO_PULLDOWN ((uint32_t)0x00000002) /*!< Pull-down activation */
emilmont 77:869cf507173a 188
emilmont 77:869cf507173a 189 #define IS_GPIO_PULL(PULL) (((PULL) == GPIO_NOPULL) || ((PULL) == GPIO_PULLUP) || \
emilmont 77:869cf507173a 190 ((PULL) == GPIO_PULLDOWN))
emilmont 77:869cf507173a 191 /**
emilmont 77:869cf507173a 192 * @}
emilmont 77:869cf507173a 193 */
emilmont 77:869cf507173a 194
emilmont 77:869cf507173a 195 /**
emilmont 77:869cf507173a 196 * @}
emilmont 77:869cf507173a 197 */
emilmont 77:869cf507173a 198
emilmont 77:869cf507173a 199 /* Exported macro ------------------------------------------------------------*/
emilmont 77:869cf507173a 200
emilmont 77:869cf507173a 201 /**
emilmont 77:869cf507173a 202 * @brief Checks whether the specified EXTI line flag is set or not.
emilmont 77:869cf507173a 203 * @param __EXTI_LINE__: specifies the EXTI line flag to check.
bogdanm 85:024bf7f99721 204 * This parameter can be GPIO_PIN_x where x can be(0..15)
emilmont 77:869cf507173a 205 * @retval The new state of __EXTI_LINE__ (SET or RESET).
emilmont 77:869cf507173a 206 */
emilmont 77:869cf507173a 207 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__))
emilmont 77:869cf507173a 208
emilmont 77:869cf507173a 209 /**
emilmont 77:869cf507173a 210 * @brief Clears the EXTI's line pending flags.
emilmont 77:869cf507173a 211 * @param __EXTI_LINE__: specifies the EXTI lines flags to clear.
bogdanm 85:024bf7f99721 212 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
emilmont 77:869cf507173a 213 * @retval None
emilmont 77:869cf507173a 214 */
emilmont 77:869cf507173a 215 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__))
emilmont 77:869cf507173a 216
emilmont 77:869cf507173a 217 /**
emilmont 77:869cf507173a 218 * @brief Checks whether the specified EXTI line is asserted or not.
emilmont 77:869cf507173a 219 * @param __EXTI_LINE__: specifies the EXTI line to check.
bogdanm 85:024bf7f99721 220 * This parameter can be GPIO_PIN_x where x can be(0..15)
emilmont 77:869cf507173a 221 * @retval The new state of __EXTI_LINE__ (SET or RESET).
emilmont 77:869cf507173a 222 */
emilmont 77:869cf507173a 223 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__))
emilmont 77:869cf507173a 224
emilmont 77:869cf507173a 225 /**
emilmont 77:869cf507173a 226 * @brief Clears the EXTI's line pending bits.
emilmont 77:869cf507173a 227 * @param __EXTI_LINE__: specifies the EXTI lines to clear.
bogdanm 85:024bf7f99721 228 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
emilmont 77:869cf507173a 229 * @retval None
emilmont 77:869cf507173a 230 */
emilmont 77:869cf507173a 231 #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__))
emilmont 77:869cf507173a 232
Kojto 90:cb3d968589d8 233 /**
Kojto 90:cb3d968589d8 234 * @brief Generates a Software interrupt on selected EXTI line.
Kojto 90:cb3d968589d8 235 * @param __EXTI_LINE__: specifies the EXTI line to check.
Kojto 90:cb3d968589d8 236 * This parameter can be GPIO_PIN_x where x can be(0..15)
Kojto 90:cb3d968589d8 237 * @retval None
Kojto 90:cb3d968589d8 238 */
Kojto 90:cb3d968589d8 239 #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER |= (__EXTI_LINE__))
Kojto 90:cb3d968589d8 240
emilmont 77:869cf507173a 241 /* Include GPIO HAL Extension module */
emilmont 77:869cf507173a 242 #include "stm32f4xx_hal_gpio_ex.h"
emilmont 77:869cf507173a 243
emilmont 77:869cf507173a 244 /* Exported functions --------------------------------------------------------*/
emilmont 77:869cf507173a 245 /* Initialization and de-initialization functions *******************************/
emilmont 77:869cf507173a 246 void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_Init);
emilmont 77:869cf507173a 247 void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin);
emilmont 77:869cf507173a 248
emilmont 77:869cf507173a 249 /* IO operation functions *******************************************************/
emilmont 77:869cf507173a 250 GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
bogdanm 85:024bf7f99721 251 void HAL_GPIO_WritePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState);
bogdanm 85:024bf7f99721 252 void HAL_GPIO_TogglePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
bogdanm 85:024bf7f99721 253 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
bogdanm 85:024bf7f99721 254 void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin);
bogdanm 85:024bf7f99721 255 void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin);
emilmont 77:869cf507173a 256
emilmont 77:869cf507173a 257 /**
emilmont 77:869cf507173a 258 * @}
emilmont 77:869cf507173a 259 */
emilmont 77:869cf507173a 260
emilmont 77:869cf507173a 261 /**
emilmont 77:869cf507173a 262 * @}
emilmont 77:869cf507173a 263 */
emilmont 77:869cf507173a 264
emilmont 77:869cf507173a 265 #ifdef __cplusplus
emilmont 77:869cf507173a 266 }
emilmont 77:869cf507173a 267 #endif
emilmont 77:869cf507173a 268
emilmont 77:869cf507173a 269 #endif /* __STM32F4xx_HAL_GPIO_H */
emilmont 77:869cf507173a 270
emilmont 77:869cf507173a 271 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/