/**
  ******************************************************************************
  * @file    ys32md211_gpio.h
  * @author  YSPRING Application Team
  * @version V1.0.1
  * @date    2025.02.15
  * @brief   This file contains all the functions prototypes for the GPIO 
  *          firmware library. 
  ******************************************************************************  */

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __YS32MD211_GPIO_H
#define __YS32MD211_GPIO_H

#ifdef __cplusplus
 extern "C" {
#endif

/* Includes ------------------------------------------------------------------*/
#include "ys32md211.h"

/** @addtogroup YS32MD211_StdPeriph_Driver
  * @{
  */

/** @addtogroup GPIO
  * @{
  */
/* Exported types ------------------------------------------------------------*/

#define IS_GPIO_ALL_PERIPH(PERIPH) (((PERIPH) == GPIOA) || \
                                    ((PERIPH) == GPIOB) || \
                                    ((PERIPH) == GPIOF))

#define IS_GPIO_LIST_PERIPH(PERIPH) (((PERIPH) == GPIOA) || \
                                     ((PERIPH) == GPIOB))

/** @defgroup Configuration_Mode_enumeration 
  * @{
  */
typedef enum
{
  GPIO_Mode_IN   = 0x00, /*!< GPIO Input Mode              */
  GPIO_Mode_OUT  = 0x01, /*!< GPIO Output Mode             */
  GPIO_Mode_AF   = 0x02, /*!< GPIO Alternate function Mode */
  GPIO_Mode_AN   = 0x03  /*!< GPIO Analog In/Out Mode      */
}GPIOMode_TypeDef;

#define IS_GPIO_MODE(MODE) (((MODE) == GPIO_Mode_IN)|| ((MODE) == GPIO_Mode_OUT) || \
                            ((MODE) == GPIO_Mode_AF)|| ((MODE) == GPIO_Mode_AN))
/**
  * @}
  */

/** @defgroup Output_type_enumeration
  * @{
  */
typedef enum
{
  GPIO_OType_PP = 0x00,
  GPIO_OType_OD = 0x01
}GPIOOType_TypeDef;

#define IS_GPIO_OTYPE(OTYPE) (((OTYPE) == GPIO_OType_PP) || ((OTYPE) == GPIO_OType_OD))

/**
  * @}
  */

/** @defgroup Output_Maximum_frequency_enumeration 
  * @{
  */
typedef enum
{
  GPIO_Speed_VeryLow  = 0x00, /*!< I/O output speed: VeryLow */
  GPIO_Speed_Low      = 0x01, /*!< I/O output speed: Low */
  GPIO_Speed_High     = 0x02, /*!< I/O output speed: High */
  GPIO_Speed_VeryHigh = 0x03  /*!< I/O output speed: Very High */  
}GPIOSpeed_TypeDef;

#define IS_GPIO_SPEED(SPEED) (((SPEED) == GPIO_Speed_VeryLow) || ((SPEED) == GPIO_Speed_Low)   || \
                              ((SPEED) == GPIO_Speed_High)    || ((SPEED) == GPIO_Speed_VeryHigh))

/**
  * @}
  */

/** @defgroup Configuration_Pull-Up_Pull-Down_enumeration 
  * @{
  */
typedef enum
{
  GPIO_PuPd_NOPULL = 0x00,
  GPIO_PuPd_UP     = 0x01,
  GPIO_PuPd_DOWN   = 0x02
}GPIOPuPd_TypeDef;

#define IS_GPIO_PUPD(PUPD) (((PUPD) == GPIO_PuPd_NOPULL) || ((PUPD) == GPIO_PuPd_UP) || \
                            ((PUPD) == GPIO_PuPd_DOWN))
/**
  * @}
  */

/** @defgroup Bit_SET_and_Bit_RESET_enumeration
  * @{
  */
typedef enum
{ 
  Bit_RESET = 0,
  Bit_SET
}BitAction;

#define IS_GPIO_BIT_ACTION(ACTION) (((ACTION) == Bit_RESET) || ((ACTION) == Bit_SET))
/**
  * @}
  */

/**
  * @brief  GPIO Init structure definition  
  */
typedef struct
{
  uint32_t GPIO_Pin;              /*!< Specifies the GPIO pins to be configured.
                                       This parameter can be any value of @ref GPIO_pins_define */
                                       
  GPIOMode_TypeDef GPIO_Mode;     /*!< Specifies the operating mode for the selected pins.
                                       This parameter can be a value of @ref GPIOMode_TypeDef   */

  GPIOSpeed_TypeDef GPIO_Speed;   /*!< Specifies the speed for the selected pins.
                                       This parameter can be a value of @ref GPIOSpeed_TypeDef  */

  GPIOOType_TypeDef GPIO_OType;   /*!< Specifies the operating output type for the selected pins.
                                       This parameter can be a value of @ref GPIOOType_TypeDef  */

  GPIOPuPd_TypeDef GPIO_PuPd;     /*!< Specifies the operating Pull-up/Pull down for the selected pins.
                                       This parameter can be a value of @ref GPIOPuPd_TypeDef   */
}GPIO_InitTypeDef;

/* Exported constants --------------------------------------------------------*/

/** @defgroup GPIO_Exported_Constants
  * @{
  */

/** @defgroup 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 IS_GPIO_PIN(PIN) ((PIN) != (uint16_t)0x00)

#define IS_GET_GPIO_PIN(PIN) (((PIN) == GPIO_Pin_0) || \
                              ((PIN) == GPIO_Pin_1) || \
                              ((PIN) == GPIO_Pin_2) || \
                              ((PIN) == GPIO_Pin_3) || \
                              ((PIN) == GPIO_Pin_4) || \
                              ((PIN) == GPIO_Pin_5) || \
                              ((PIN) == GPIO_Pin_6) || \
                              ((PIN) == GPIO_Pin_7) || \
                              ((PIN) == GPIO_Pin_8) || \
                              ((PIN) == GPIO_Pin_9) || \
                              ((PIN) == GPIO_Pin_10) || \
                              ((PIN) == GPIO_Pin_11) || \
                              ((PIN) == GPIO_Pin_12) || \
                              ((PIN) == GPIO_Pin_13) || \
                              ((PIN) == GPIO_Pin_14) || \
                              ((PIN) == GPIO_Pin_15))

/**
  * @}
  */

/** @defgroup GPIO_Pin_sources 
  * @{
  */
#define GPIO_PinSource0            ((uint8_t)0x00)
#define GPIO_PinSource1            ((uint8_t)0x01)
#define GPIO_PinSource2            ((uint8_t)0x02)
#define GPIO_PinSource3            ((uint8_t)0x03)
#define GPIO_PinSource4            ((uint8_t)0x04)
#define GPIO_PinSource5            ((uint8_t)0x05)
#define GPIO_PinSource6            ((uint8_t)0x06)
#define GPIO_PinSource7            ((uint8_t)0x07)
#define GPIO_PinSource8            ((uint8_t)0x08)
#define GPIO_PinSource9            ((uint8_t)0x09)
#define GPIO_PinSource10           ((uint8_t)0x0A)
#define GPIO_PinSource11           ((uint8_t)0x0B)
#define GPIO_PinSource12           ((uint8_t)0x0C)
#define GPIO_PinSource13           ((uint8_t)0x0D)
#define GPIO_PinSource14           ((uint8_t)0x0E)
#define GPIO_PinSource15           ((uint8_t)0x0F)

#define IS_GPIO_PIN_SOURCE(PINSOURCE) (((PINSOURCE) == GPIO_PinSource0) || \
                                       ((PINSOURCE) == GPIO_PinSource1) || \
                                       ((PINSOURCE) == GPIO_PinSource2) || \
                                       ((PINSOURCE) == GPIO_PinSource3) || \
                                       ((PINSOURCE) == GPIO_PinSource4) || \
                                       ((PINSOURCE) == GPIO_PinSource5) || \
                                       ((PINSOURCE) == GPIO_PinSource6) || \
                                       ((PINSOURCE) == GPIO_PinSource7) || \
                                       ((PINSOURCE) == GPIO_PinSource8) || \
                                       ((PINSOURCE) == GPIO_PinSource9) || \
                                       ((PINSOURCE) == GPIO_PinSource10) || \
                                       ((PINSOURCE) == GPIO_PinSource11) || \
                                       ((PINSOURCE) == GPIO_PinSource12) || \
                                       ((PINSOURCE) == GPIO_PinSource13) || \
                                       ((PINSOURCE) == GPIO_PinSource14) || \
                                       ((PINSOURCE) == GPIO_PinSource15))
/**
  * @}
  */

/** @defgroup GPIO_Alternate_function_selection_define 
  * @{
  */

/** 
  * @brief  AF 0 selection
  */
#define GPIO_AF_0            ((uint8_t)0x00) /* TIM1_CH1N, EVENTOUT, TIM16_BKIN, TIM1_ETR, SPI_NSS, SPI_SCK, SPI_MISO, SPI_MOSI, MCO, TIM17_BKIN, 
                                                SWDIO, SWCLK, TIM14_CH1, UART1_TX, UART1_RX, IR_OUT, I2C_SDA */
                                                
/** 
  * @brief  AF 1 selection
  */
#define GPIO_AF_1            ((uint8_t)0x01) /* UART2_TX, UART2_RX, UART1_RX, TIM3_CH1, TIM3_CH2, UART1_TX, TIM1_CH2N, TIM1_CH3N, IR_OUT, 
                                                TIM3_CH3, TIM3_CH4, EVENTOUT, I2C_SCL, I2C_SDA  */
                                             
/** 
  * @brief  AF 2 selection
  */
#define GPIO_AF_2            ((uint8_t)0x02) /* SPI_MISO, SPI_MOSI, TIM1_CH1, TIM1_BKIN, TIM1_CH1N, TIM1_CH2, TIM1_CH3, TIM1_CH4, TIM1_ETR, UART1_RX, 
                                                UART2_TX, UART2_RX, TIM1_CH2N, TIM1_CH3N, UART1_TX, EVENTOUT, TIM16_BKIN, TIM16_CH1N, TIM17_CH1N, TIM16_CH1, 
                                                TIM17_CH1, MCO */
                                                 
/** 
  * @brief  AF 3 selection
  */
#define GPIO_AF_3            ((uint8_t)0x03) /* SPI_SCK, SPI_MOSI, TIM3_CH3, MCO, COMP1_OUT, TIM1_CH2, EVENTOUT, TIM1_CH3N, SPI_MISO, TIM1_CH1, SPI_NSS, 
                                                TIM1_CH2N, UART2_TX, UART1_RX, COMP1_OUT, UART1_TX, SPI_SCK  */
                                                
/** 
  * @brief  AF 4 selection
  */
#define GPIO_AF_4            ((uint8_t)0x04) /* IR_OUT, TIM16_CH1, UART1_TX, UART2_RX, TIM14_CH1, TIM3_CH2, TIM1_CH1N, TIM14_CH1, TIM1_CH3, UART2_TX, TIM1_CH3, COMP1_OUT, 
                                                TIM1_ETR, TIM1_BKIN, TIM17_CH1, PVD_OUT, I2C_SCL, UART1_RX, TIM3_CH3 */
                                                 
/** 
  * @brief  AF 5 selection
  */
#define GPIO_AF_5            ((uint8_t)0x05) /* COMP1_OUT, MCO, I2C1_SDA, TIM16_CH1N, TIM1_BKIN, TIM17_CH1N, TIM16_CH1, TIM17_CH1, SPI_SCK, SPI_NSS, I2C_SCL, PVD_OUT, 
                                                TIM3_CH2, TIM3_CH3, UART2_TX, UART2_RX, TIM17_CH1*/
                                                 
/** 
  * @brief  AF 6 selection
  */
#define GPIO_AF_6            ((uint8_t)0x06) /* TIM1_CH3, TIM1_CH4, COMP2_OUT, I2C_SDA, EVENTOUT, SPI_MOSI, I2C_SCL, TIM17_BKIN, TIM1_CH2, TIM16_CH1, TIM3_CH1,
                                                TIM3_CH2, TIM3_CH3*/

/** 
  * @brief  AF 7 selection
  */
#define GPIO_AF_7            ((uint8_t)0x07) /* LED0, LED1, LED2, LED3, LED4, LED5, LED6, LED7, LED8, UART2_RX, TIM3_CH2, TIM3_CH1, COMP1_OUT, COMP2_OUT, TIM1_CH2, TIM1_CH1 
                                                TIM1_CH3, TIM1_CH4, I2C_SCL, I2C_SDA*/
                                                
/** 
  * @brief  AF 8 selection
  */
#define GPIO_AF_8            ((uint8_t)0x08) /* TIM3_CH1, I2C1_SCL, UART1_TX, TIM3_CH3, I2C_SDA, TIM1_CH1, TIM1_CH2, UART1_RX, I2C_SDA, TIM3_CH1, SPI_MOSI*/

/** 
  * @brief  AF 8 selection
  */
#define GPIO_AF_9            ((uint8_t)0x09) /* TIM1_CH2N, TIM17_CH1, UART2_TX, TIM3_CH4, TIM1_CH2N, TIM1_CH3N, TIM3_CH2, SPI_MISO */

/** 
  * @brief  AF 10 selection
  */
#define GPIO_AF_10           ((uint8_t)0x0A)   /* I2C_SCL, TIM1_CH1, COMP2_OUT, TIM3_CH3 */

/** 
  * @brief  AF 11 selection
  */
#define GPIO_AF_11           ((uint8_t)0x0B)   /* I2C1_SDA, TIM1_CH1N*/

/** 
  * @brief  AF 12 selection
  */
#define GPIO_AF_12           ((uint8_t)0x0C)   /* TIM1_CH2, COMP1_OUT*/

#define IS_GPIO_AF(AF)   (((AF) == GPIO_AF_0)  || ((AF) == GPIO_AF_1)  || \
                          ((AF) == GPIO_AF_2)  || ((AF) == GPIO_AF_3)  || \
                          ((AF) == GPIO_AF_4)  || ((AF) == GPIO_AF_5)  || \
                          ((AF) == GPIO_AF_6)  || ((AF) == GPIO_AF_7)  || \
                          ((AF) == GPIO_AF_8)  || ((AF) == GPIO_AF_9)  || \
                          ((AF) == GPIO_AF_10) || ((AF) == GPIO_AF_11) || \
                          ((AF) == GPIO_AF_12))

/**
  * @}
  */
 
/**
  * @}
  */

/* Exported macro ------------------------------------------------------------*/
/* Exported functions ------------------------------------------------------- */
/* Function used to set the GPIO configuration to the default reset state *****/
void GPIO_DeInit(GPIO_TypeDef* GPIOx);

/* Initialization and Configuration functions *********************************/
void GPIO_Init(GPIO_TypeDef* GPIOx, GPIO_InitTypeDef* GPIO_InitStruct);
void GPIO_StructInit(GPIO_InitTypeDef* GPIO_InitStruct);
void GPIO_PinLockConfig(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);

/* GPIO Read and Write functions **********************************************/
uint8_t GPIO_ReadInputDataBit(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
uint16_t GPIO_ReadInputData(GPIO_TypeDef* GPIOx);
uint8_t GPIO_ReadOutputDataBit(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
uint16_t GPIO_ReadOutputData(GPIO_TypeDef* GPIOx);
void GPIO_SetBits(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
void GPIO_ResetBits(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
void GPIO_TogglePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
void GPIO_WriteBit(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin, BitAction BitVal);
void GPIO_Write(GPIO_TypeDef* GPIOx, uint16_t PortVal);

/* GPIO Alternate functions configuration functions ***************************/
void GPIO_PinAFConfig(GPIO_TypeDef* GPIOx, uint16_t GPIO_PinSource, uint8_t GPIO_AF);

#ifdef __cplusplus
}
#endif

#endif /* __YS32MD211_GPIO_H */
/**
  * @}
  */

/**
  * @}
  */

