1 /********************************** (C) COPYRIGHT  *******************************
2  * File Name          : ch32v10x_gpio.h
3  * Author             : WCH
4  * Version            : V1.0.0
5  * Date               : 2020/04/30
6  * Description        : This file contains all the functions prototypes for the
7  *                      GPIO firmware library.
8  * Copyright (c) 2021 Nanjing Qinheng Microelectronics Co., Ltd.
9  * SPDX-License-Identifier: Apache-2.0
10  *******************************************************************************/
11 #ifndef __CH32V10x_GPIO_H
12 #define __CH32V10x_GPIO_H
13 
14 #ifdef __cplusplus
15 extern "C" {
16 #endif
17 
18 #include "ch32v10x.h"
19 
20 /* Output Maximum frequency selection */
21 typedef enum
22 {
23     GPIO_Speed_10MHz = 1,
24     GPIO_Speed_2MHz,
25     GPIO_Speed_50MHz
26 } GPIOSpeed_TypeDef;
27 
28 /* Configuration Mode enumeration */
29 typedef enum
30 {
31     GPIO_Mode_AIN = 0x0,
32     GPIO_Mode_IN_FLOATING = 0x04,
33     GPIO_Mode_IPD = 0x28,
34     GPIO_Mode_IPU = 0x48,
35     GPIO_Mode_Out_OD = 0x14,
36     GPIO_Mode_Out_PP = 0x10,
37     GPIO_Mode_AF_OD = 0x1C,
38     GPIO_Mode_AF_PP = 0x18
39 } GPIOMode_TypeDef;
40 
41 /* GPIO Init structure definition */
42 typedef struct
43 {
44     uint16_t GPIO_Pin; /* Specifies the GPIO pins to be configured.
45                           This parameter can be any value of @ref GPIO_pins_define */
46 
47     GPIOSpeed_TypeDef GPIO_Speed; /* Specifies the speed for the selected pins.
48                                      This parameter can be a value of @ref GPIOSpeed_TypeDef */
49 
50     GPIOMode_TypeDef GPIO_Mode; /* Specifies the operating mode for the selected pins.
51                                    This parameter can be a value of @ref GPIOMode_TypeDef */
52 } GPIO_InitTypeDef;
53 
54 /* Bit_SET and Bit_RESET enumeration */
55 typedef enum
56 {
57     Bit_RESET = 0,
58     Bit_SET
59 } BitAction;
60 
61 /* GPIO_pins_define */
62 #define GPIO_Pin_0                     ((uint16_t)0x0001) /* Pin 0 selected */
63 #define GPIO_Pin_1                     ((uint16_t)0x0002) /* Pin 1 selected */
64 #define GPIO_Pin_2                     ((uint16_t)0x0004) /* Pin 2 selected */
65 #define GPIO_Pin_3                     ((uint16_t)0x0008) /* Pin 3 selected */
66 #define GPIO_Pin_4                     ((uint16_t)0x0010) /* Pin 4 selected */
67 #define GPIO_Pin_5                     ((uint16_t)0x0020) /* Pin 5 selected */
68 #define GPIO_Pin_6                     ((uint16_t)0x0040) /* Pin 6 selected */
69 #define GPIO_Pin_7                     ((uint16_t)0x0080) /* Pin 7 selected */
70 #define GPIO_Pin_8                     ((uint16_t)0x0100) /* Pin 8 selected */
71 #define GPIO_Pin_9                     ((uint16_t)0x0200) /* Pin 9 selected */
72 #define GPIO_Pin_10                    ((uint16_t)0x0400) /* Pin 10 selected */
73 #define GPIO_Pin_11                    ((uint16_t)0x0800) /* Pin 11 selected */
74 #define GPIO_Pin_12                    ((uint16_t)0x1000) /* Pin 12 selected */
75 #define GPIO_Pin_13                    ((uint16_t)0x2000) /* Pin 13 selected */
76 #define GPIO_Pin_14                    ((uint16_t)0x4000) /* Pin 14 selected */
77 #define GPIO_Pin_15                    ((uint16_t)0x8000) /* Pin 15 selected */
78 #define GPIO_Pin_All                   ((uint16_t)0xFFFF) /* All pins selected */
79 
80 /* GPIO_Remap_define */
81 #define GPIO_Remap_SPI1                ((uint32_t)0x00000001) /* SPI1 Alternate Function mapping */
82 #define GPIO_Remap_I2C1                ((uint32_t)0x00000002) /* I2C1 Alternate Function mapping */
83 #define GPIO_Remap_USART1              ((uint32_t)0x00000004) /* USART1 Alternate Function mapping */
84 #define GPIO_Remap_USART2              ((uint32_t)0x00000008) /* USART2 Alternate Function mapping */
85 #define GPIO_PartialRemap_USART3       ((uint32_t)0x00140010) /* USART3 Partial Alternate Function mapping */
86 #define GPIO_FullRemap_USART3          ((uint32_t)0x00140030) /* USART3 Full Alternate Function mapping */
87 #define GPIO_PartialRemap_TIM1         ((uint32_t)0x00160040) /* TIM1 Partial Alternate Function mapping */
88 #define GPIO_FullRemap_TIM1            ((uint32_t)0x001600C0) /* TIM1 Full Alternate Function mapping */
89 #define GPIO_PartialRemap1_TIM2        ((uint32_t)0x00180100) /* TIM2 Partial1 Alternate Function mapping */
90 #define GPIO_PartialRemap2_TIM2        ((uint32_t)0x00180200) /* TIM2 Partial2 Alternate Function mapping */
91 #define GPIO_FullRemap_TIM2            ((uint32_t)0x00180300) /* TIM2 Full Alternate Function mapping */
92 #define GPIO_PartialRemap_TIM3         ((uint32_t)0x001A0800) /* TIM3 Partial Alternate Function mapping */
93 #define GPIO_FullRemap_TIM3            ((uint32_t)0x001A0C00) /* TIM3 Full Alternate Function mapping */
94 #define GPIO_Remap_TIM4                ((uint32_t)0x00001000) /* TIM4 Alternate Function mapping */
95 #define GPIO_Remap1_CAN1               ((uint32_t)0x001D4000) /* CAN1 Alternate Function mapping */
96 #define GPIO_Remap2_CAN1               ((uint32_t)0x001D6000) /* CAN1 Alternate Function mapping */
97 #define GPIO_Remap_PD01                ((uint32_t)0x00008000) /* PD01 Alternate Function mapping */
98 #define GPIO_Remap_ADC1_ETRGINJ        ((uint32_t)0x00200002) /* ADC1 External Trigger Injected Conversion remapping */
99 #define GPIO_Remap_ADC1_ETRGREG        ((uint32_t)0x00200004) /* ADC1 External Trigger Regular Conversion remapping */
100 #define GPIO_Remap_SWJ_NoJTRST         ((uint32_t)0x00300100) /* Full SWJ Enabled (JTAG-DP + SW-DP) but without JTRST */
101 #define GPIO_Remap_SWJ_JTAGDisable     ((uint32_t)0x00300200) /* JTAG-DP Disabled and SW-DP Enabled */
102 #define GPIO_Remap_SWJ_Disable         ((uint32_t)0x00300400) /* Full SWJ Disabled (JTAG-DP + SW-DP) */
103 #define GPIO_Remap_TIM2ITR1_PTP_SOF    ((uint32_t)0x00202000) /* Ethernet PTP output or USB OTG SOF (Start of Frame) connected \
104                                                                  to TIM2 Internal Trigger 1 for calibration                    \
105                                                                  (only for Connectivity line devices) */
106 #define GPIO_Remap_TIM1_DMA            ((uint32_t)0x80000010) /* TIM1 DMA requests mapping (only for Value line devices) */
107 #define GPIO_Remap_TIM67_DAC_DMA       ((uint32_t)0x80000800) /* TIM6/TIM7 and DAC DMA requests remapping (only for High density Value line devices) */
108 #define GPIO_Remap_MISC                ((uint32_t)0x80002000) /* Miscellaneous Remap (DMA2 Channel5 Position and DAC Trigger remapping, \
109                                                                    only for High density Value line devices) */
110 
111 /* GPIO_Port_Sources */
112 #define GPIO_PortSourceGPIOA           ((uint8_t)0x00)
113 #define GPIO_PortSourceGPIOB           ((uint8_t)0x01)
114 #define GPIO_PortSourceGPIOC           ((uint8_t)0x02)
115 #define GPIO_PortSourceGPIOD           ((uint8_t)0x03)
116 #define GPIO_PortSourceGPIOE           ((uint8_t)0x04)
117 #define GPIO_PortSourceGPIOF           ((uint8_t)0x05)
118 #define GPIO_PortSourceGPIOG           ((uint8_t)0x06)
119 
120 /* GPIO_Pin_sources */
121 #define GPIO_PinSource0                ((uint8_t)0x00)
122 #define GPIO_PinSource1                ((uint8_t)0x01)
123 #define GPIO_PinSource2                ((uint8_t)0x02)
124 #define GPIO_PinSource3                ((uint8_t)0x03)
125 #define GPIO_PinSource4                ((uint8_t)0x04)
126 #define GPIO_PinSource5                ((uint8_t)0x05)
127 #define GPIO_PinSource6                ((uint8_t)0x06)
128 #define GPIO_PinSource7                ((uint8_t)0x07)
129 #define GPIO_PinSource8                ((uint8_t)0x08)
130 #define GPIO_PinSource9                ((uint8_t)0x09)
131 #define GPIO_PinSource10               ((uint8_t)0x0A)
132 #define GPIO_PinSource11               ((uint8_t)0x0B)
133 #define GPIO_PinSource12               ((uint8_t)0x0C)
134 #define GPIO_PinSource13               ((uint8_t)0x0D)
135 #define GPIO_PinSource14               ((uint8_t)0x0E)
136 #define GPIO_PinSource15               ((uint8_t)0x0F)
137 
138 void     GPIO_DeInit(GPIO_TypeDef *GPIOx);
139 void     GPIO_AFIODeInit(void);
140 void     GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_InitStruct);
141 void     GPIO_StructInit(GPIO_InitTypeDef *GPIO_InitStruct);
142 uint8_t  GPIO_ReadInputDataBit(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);
143 uint16_t GPIO_ReadInputData(GPIO_TypeDef *GPIOx);
144 uint8_t  GPIO_ReadOutputDataBit(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);
145 uint16_t GPIO_ReadOutputData(GPIO_TypeDef *GPIOx);
146 void     GPIO_SetBits(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);
147 void     GPIO_ResetBits(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);
148 void     GPIO_WriteBit(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, BitAction BitVal);
149 void     GPIO_Write(GPIO_TypeDef *GPIOx, uint16_t PortVal);
150 void     GPIO_PinLockConfig(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);
151 void     GPIO_EventOutputConfig(uint8_t GPIO_PortSource, uint8_t GPIO_PinSource);
152 void     GPIO_EventOutputCmd(FunctionalState NewState);
153 void     GPIO_PinRemapConfig(uint32_t GPIO_Remap, FunctionalState NewState);
154 void     GPIO_EXTILineConfig(uint8_t GPIO_PortSource, uint8_t GPIO_PinSource);
155 
156 #ifdef __cplusplus
157 }
158 #endif
159 
160 #endif /* __CH32V10x_GPIO_H */
161