308 lines
12 KiB
C
308 lines
12 KiB
C
/**
|
|
******************************************************************************
|
|
* @file stm32f1xx_hal_gpio.h
|
|
* @author MCD Application Team
|
|
* @brief Header file of GPIO HAL module.
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* <h2><center>© Copyright (c) 2016 STMicroelectronics.
|
|
* All rights reserved.</center></h2>
|
|
*
|
|
* This software component is licensed by ST under BSD 3-Clause license,
|
|
* the "License"; You may not use this file except in compliance with the
|
|
* License. You may obtain a copy of the License at:
|
|
* opensource.org/licenses/BSD-3-Clause
|
|
*
|
|
******************************************************************************
|
|
*/
|
|
|
|
/* Define to prevent recursive inclusion -------------------------------------*/
|
|
#ifndef STM32F1xx_HAL_GPIO_H
|
|
#define STM32F1xx_HAL_GPIO_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Includes ------------------------------------------------------------------*/
|
|
#include "stm32f1xx_hal_def.h"
|
|
|
|
/** @addtogroup STM32F1xx_HAL_Driver
|
|
* @{
|
|
*/
|
|
|
|
/** @addtogroup GPIO
|
|
* @{
|
|
*/
|
|
|
|
/* Exported types ------------------------------------------------------------*/
|
|
/** @defgroup GPIO_Exported_Types GPIO Exported Types
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief GPIO Init structure definition
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint32_t Pin; /*!< Specifies the GPIO pins to be configured.
|
|
This parameter can be any value of @ref GPIO_pins_define */
|
|
|
|
uint32_t Mode; /*!< Specifies the operating mode for the selected pins.
|
|
This parameter can be a value of @ref GPIO_mode_define */
|
|
|
|
uint32_t Pull; /*!< Specifies the Pull-up or Pull-Down activation for the selected pins.
|
|
This parameter can be a value of @ref GPIO_pull_define */
|
|
|
|
uint32_t Speed; /*!< Specifies the speed for the selected pins.
|
|
This parameter can be a value of @ref GPIO_speed_define */
|
|
} GPIO_InitTypeDef;
|
|
|
|
/**
|
|
* @brief GPIO Bit SET and Bit RESET enumeration
|
|
*/
|
|
typedef enum
|
|
{
|
|
GPIO_PIN_RESET = 0u,
|
|
GPIO_PIN_SET
|
|
} GPIO_PinState;
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Exported constants --------------------------------------------------------*/
|
|
|
|
/** @defgroup GPIO_Exported_Constants GPIO Exported Constants
|
|
* @{
|
|
*/
|
|
|
|
/** @defgroup GPIO_pins_define GPIO pins define
|
|
* @{
|
|
*/
|
|
#define GPIO_PIN_0 ((uint16_t)0x0001) /* Pin 0 selected */
|
|
#define GPIO_PIN_1 ((uint16_t)0x0002) /* Pin 1 selected */
|
|
#define GPIO_PIN_2 ((uint16_t)0x0004) /* Pin 2 selected */
|
|
#define GPIO_PIN_3 ((uint16_t)0x0008) /* Pin 3 selected */
|
|
#define GPIO_PIN_4 ((uint16_t)0x0010) /* Pin 4 selected */
|
|
#define GPIO_PIN_5 ((uint16_t)0x0020) /* Pin 5 selected */
|
|
#define GPIO_PIN_6 ((uint16_t)0x0040) /* Pin 6 selected */
|
|
#define GPIO_PIN_7 ((uint16_t)0x0080) /* Pin 7 selected */
|
|
#define GPIO_PIN_8 ((uint16_t)0x0100) /* Pin 8 selected */
|
|
#define GPIO_PIN_9 ((uint16_t)0x0200) /* Pin 9 selected */
|
|
#define GPIO_PIN_10 ((uint16_t)0x0400) /* Pin 10 selected */
|
|
#define GPIO_PIN_11 ((uint16_t)0x0800) /* Pin 11 selected */
|
|
#define GPIO_PIN_12 ((uint16_t)0x1000) /* Pin 12 selected */
|
|
#define GPIO_PIN_13 ((uint16_t)0x2000) /* Pin 13 selected */
|
|
#define GPIO_PIN_14 ((uint16_t)0x4000) /* Pin 14 selected */
|
|
#define GPIO_PIN_15 ((uint16_t)0x8000) /* Pin 15 selected */
|
|
#define GPIO_PIN_All ((uint16_t)0xFFFF) /* All pins selected */
|
|
|
|
#define GPIO_PIN_MASK 0x0000FFFFu /* PIN mask for assert test */
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/** @defgroup GPIO_mode_define GPIO mode define
|
|
* @brief GPIO Configuration Mode
|
|
* Elements values convention: 0xX0yz00YZ
|
|
* - X : GPIO mode or EXTI Mode
|
|
* - y : External IT or Event trigger detection
|
|
* - z : IO configuration on External IT or Event
|
|
* - Y : Output type (Push Pull or Open Drain)
|
|
* - Z : IO Direction mode (Input, Output, Alternate or Analog)
|
|
* @{
|
|
*/
|
|
#define GPIO_MODE_INPUT 0x00000000u /*!< Input Floating Mode */
|
|
#define GPIO_MODE_OUTPUT_PP 0x00000001u /*!< Output Push Pull Mode */
|
|
#define GPIO_MODE_OUTPUT_OD 0x00000011u /*!< Output Open Drain Mode */
|
|
#define GPIO_MODE_AF_PP 0x00000002u /*!< Alternate Function Push Pull Mode */
|
|
#define GPIO_MODE_AF_OD 0x00000012u /*!< Alternate Function Open Drain Mode */
|
|
#define GPIO_MODE_AF_INPUT GPIO_MODE_INPUT /*!< Alternate Function Input Mode */
|
|
|
|
#define GPIO_MODE_ANALOG 0x00000003u /*!< Analog Mode */
|
|
|
|
#define GPIO_MODE_IT_RISING 0x10110000u /*!< External Interrupt Mode with Rising edge trigger detection */
|
|
#define GPIO_MODE_IT_FALLING 0x10210000u /*!< External Interrupt Mode with Falling edge trigger detection */
|
|
#define GPIO_MODE_IT_RISING_FALLING 0x10310000u /*!< External Interrupt Mode with Rising/Falling edge trigger detection */
|
|
|
|
#define GPIO_MODE_EVT_RISING 0x10120000u /*!< External Event Mode with Rising edge trigger detection */
|
|
#define GPIO_MODE_EVT_FALLING 0x10220000u /*!< External Event Mode with Falling edge trigger detection */
|
|
#define GPIO_MODE_EVT_RISING_FALLING 0x10320000u /*!< External Event Mode with Rising/Falling edge trigger detection */
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/** @defgroup GPIO_speed_define GPIO speed define
|
|
* @brief GPIO Output Maximum frequency
|
|
* @{
|
|
*/
|
|
#define GPIO_SPEED_FREQ_LOW (GPIO_CRL_MODE0_1) /*!< Low speed */
|
|
#define GPIO_SPEED_FREQ_MEDIUM (GPIO_CRL_MODE0_0) /*!< Medium speed */
|
|
#define GPIO_SPEED_FREQ_HIGH (GPIO_CRL_MODE0) /*!< High speed */
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/** @defgroup GPIO_pull_define GPIO pull define
|
|
* @brief GPIO Pull-Up or Pull-Down Activation
|
|
* @{
|
|
*/
|
|
#define GPIO_NOPULL 0x00000000u /*!< No Pull-up or Pull-down activation */
|
|
#define GPIO_PULLUP 0x00000001u /*!< Pull-up activation */
|
|
#define GPIO_PULLDOWN 0x00000002u /*!< Pull-down activation */
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Exported macro ------------------------------------------------------------*/
|
|
/** @defgroup GPIO_Exported_Macros GPIO Exported Macros
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Checks whether the specified EXTI line flag is set or not.
|
|
* @param __EXTI_LINE__: specifies the EXTI line flag to check.
|
|
* This parameter can be GPIO_PIN_x where x can be(0..15)
|
|
* @retval The new state of __EXTI_LINE__ (SET or RESET).
|
|
*/
|
|
#define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__))
|
|
|
|
/**
|
|
* @brief Clears the EXTI's line pending flags.
|
|
* @param __EXTI_LINE__: specifies the EXTI lines flags to clear.
|
|
* This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
|
|
* @retval None
|
|
*/
|
|
#define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__))
|
|
|
|
/**
|
|
* @brief Checks whether the specified EXTI line is asserted or not.
|
|
* @param __EXTI_LINE__: specifies the EXTI line to check.
|
|
* This parameter can be GPIO_PIN_x where x can be(0..15)
|
|
* @retval The new state of __EXTI_LINE__ (SET or RESET).
|
|
*/
|
|
#define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__))
|
|
|
|
/**
|
|
* @brief Clears the EXTI's line pending bits.
|
|
* @param __EXTI_LINE__: specifies the EXTI lines to clear.
|
|
* This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
|
|
* @retval None
|
|
*/
|
|
#define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__))
|
|
|
|
/**
|
|
* @brief Generates a Software interrupt on selected EXTI line.
|
|
* @param __EXTI_LINE__: specifies the EXTI line to check.
|
|
* This parameter can be GPIO_PIN_x where x can be(0..15)
|
|
* @retval None
|
|
*/
|
|
#define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER |= (__EXTI_LINE__))
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Include GPIO HAL Extension module */
|
|
#include "stm32f1xx_hal_gpio_ex.h"
|
|
|
|
/* Exported functions --------------------------------------------------------*/
|
|
/** @addtogroup GPIO_Exported_Functions
|
|
* @{
|
|
*/
|
|
|
|
/** @addtogroup GPIO_Exported_Functions_Group1
|
|
* @{
|
|
*/
|
|
/* Initialization and de-initialization functions *****************************/
|
|
void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_Init);
|
|
void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin);
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/** @addtogroup GPIO_Exported_Functions_Group2
|
|
* @{
|
|
*/
|
|
/* IO operation functions *****************************************************/
|
|
GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);
|
|
void HAL_GPIO_WritePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState);
|
|
void HAL_GPIO_TogglePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);
|
|
HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);
|
|
void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin);
|
|
void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
/* Private types -------------------------------------------------------------*/
|
|
/* Private variables ---------------------------------------------------------*/
|
|
/* Private constants ---------------------------------------------------------*/
|
|
/** @defgroup GPIO_Private_Constants GPIO Private Constants
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Private macros ------------------------------------------------------------*/
|
|
/** @defgroup GPIO_Private_Macros GPIO Private Macros
|
|
* @{
|
|
*/
|
|
#define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET))
|
|
#define IS_GPIO_PIN(PIN) (((((uint32_t)PIN) & GPIO_PIN_MASK ) != 0x00u) && ((((uint32_t)PIN) & ~GPIO_PIN_MASK) == 0x00u))
|
|
#define IS_GPIO_MODE(MODE) (((MODE) == GPIO_MODE_INPUT) ||\
|
|
((MODE) == GPIO_MODE_OUTPUT_PP) ||\
|
|
((MODE) == GPIO_MODE_OUTPUT_OD) ||\
|
|
((MODE) == GPIO_MODE_AF_PP) ||\
|
|
((MODE) == GPIO_MODE_AF_OD) ||\
|
|
((MODE) == GPIO_MODE_IT_RISING) ||\
|
|
((MODE) == GPIO_MODE_IT_FALLING) ||\
|
|
((MODE) == GPIO_MODE_IT_RISING_FALLING) ||\
|
|
((MODE) == GPIO_MODE_EVT_RISING) ||\
|
|
((MODE) == GPIO_MODE_EVT_FALLING) ||\
|
|
((MODE) == GPIO_MODE_EVT_RISING_FALLING) ||\
|
|
((MODE) == GPIO_MODE_ANALOG))
|
|
#define IS_GPIO_SPEED(SPEED) (((SPEED) == GPIO_SPEED_FREQ_LOW) || \
|
|
((SPEED) == GPIO_SPEED_FREQ_MEDIUM) || ((SPEED) == GPIO_SPEED_FREQ_HIGH))
|
|
#define IS_GPIO_PULL(PULL) (((PULL) == GPIO_NOPULL) || ((PULL) == GPIO_PULLUP) || \
|
|
((PULL) == GPIO_PULLDOWN))
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/* Private functions ---------------------------------------------------------*/
|
|
/** @defgroup GPIO_Private_Functions GPIO Private Functions
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* STM32F1xx_HAL_GPIO_H */
|
|
|
|
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|