GPIO使用参考¶

REVISION HISTORY

Revision No.	Description	Date
1.0	Initial release	04/18/2023
1.1	增加第八章DEBUG&FAQ	04/08/2025

1. 概述¶

General Purpose Input Output （通用输入/输出）简称为GPIO。GPIO 采用标准的LINUX框架，能够使用统一的接口来操作gpio。

图1-1 GPIO框架图

GPIO的框架如上图，中间层是 gpiolib，用于管理系统中的 GPIO。gpiolib 汇总了 GPIO 的通用操作，根据 GPIO 的特性，gpiolib 对上（其他 Drivers）提供的一套统一通用的操作 GPIO 的软件接口。对下，Gpiolib 提供了针对不同芯片操作的一套 framework，针对不同芯片，只需要实现drv_gpio_io.c，然后使用 Gpiolib 提供的注册函数，将其挂接到 Gpiolib 上。

2. 关键字说明¶

2.1. GPIO Index¶

原理图上GPIO的Pad name可以在表1-1中查找到对应的GPIO Index，GPIO Index作为软件操作GPIO相关函数的输入参数使用。

例如：希望操作的GPIO为 PAD_KEY1，根据表1-1中的内容找到对应的GPIO Index为12。

表1-1：GPIO Index与PAD对应表

Pad Name	GPIO Index	Pad Name	GPIO Index	Pad Name	GPIO Index
PAD_HSYNC	0	PAD_VSYNC	1	PAD_HDMITX_HPD	2
PAD_HDMITX_SDA	3	PAD_HDMITX_SCL	4	PAD_GPIO17	5
PAD_GPIO18	6	PAD_GPIO19	7	PAD_GPIO20	8
PAD_GPIO21	9	PAD_GPIO22	10	PAD_I2C1_SCL	11
PAD_I2C1_SDA	12	PAD_PWM2	13	PAD_GPIO23	14
PAD_GPIO24	15	PAD_OUTP_TX0_CH0	16	PAD_OUTN_TX0_CH0	17
PAD_OUTP_TX0_CH1	18	PAD_OUTN_TX0_CH1	19	PAD_OUTP_TX0_CH2	20
PAD_OUTN_TX0_CH2	21	PAD_OUTP_TX0_CH3	22	PAD_OUTN_TX0_CH3	23
PAD_OUTP_TX0_CH4	24	PAD_OUTN_TX0_CH4	25	PAD_I2S0_MCLK	26
PAD_I2S0_TX_BCK	27	PAD_I2S0_TX_WCK	28	PAD_I2S0_TX_SDO	29
PAD_I2C2_SCL	30	PAD_I2C2_SDA	31	PAD_GPIO8	32
PAD_GPIO9	33	PAD_GPIO10	34	PAD_GPIO11	35
PAD_SPI_CK	36	PAD_SPI_DI	37	PAD_SPI_HLD	38
PAD_SPI_DO	39	PAD_SPI_WPZ	40	PAD_SPI_CZ	41
PAD_GPIO12	42	PAD_GPIO13	43	PAD_GPIO14	44
PAD_GPIO15	45	PAD_I2C4_SCL	46	PAD_I2C4_SDA	47
PAD_GPIO16	48	PAD_EMMC_RSTN	49	PAD_EMMC_CLK	50
PAD_EMMC_CMD	51	PAD_EMMC_DS	52	PAD_EMMC_D3	53
PAD_EMMC_D4	54	PAD_EMMC_D0	55	PAD_EMMC_D5	56
PAD_EMMC_D1	57	PAD_EMMC_D6	58	PAD_EMMC_D2	59
PAD_EMMC_D7	60	PAD_SD0_GPIO0	61	PAD_SD0_VCTRL	62
PAD_SD0_CDZ	63	PAD_SD0_D1	64	PAD_SD0_D0	65
PAD_SD0_CLK	66	PAD_SD0_CMD	67	PAD_SD0_D3	68
PAD_SD0_D2	69	PAD_I2C3_SCL	70	PAD_I2C3_SDA	71
PAD_PWM0	72	PAD_PWM1	73	PAD_FUART_RTS	74
PAD_FUART_CTS	75	PAD_FUART_TX	76	PAD_FUART_RX	77
PAD_IRIN	78	PAD_RGMII1_RSTN	79	PAD_RGMII1_RXCLK	80
PAD_RGMII1_RXCTL	81	PAD_RGMII1_RXD0	82	PAD_RGMII1_RXD1	83
PAD_RGMII1_RXD2	84	PAD_RGMII1_RXD3	85	PAD_RGMII1_TXCLK	86
PAD_RGMII1_TXCTL	87	PAD_RGMII1_TXD0	88	PAD_RGMII1_TXD1	89
PAD_RGMII1_TXD2	90	PAD_RGMII1_TXD3	91	PAD_RGMII1_MDIO	92
PAD_RGMII1_MDC	93	PAD_RGMII1_MCLK	94	PAD_RGMII0_MCLK	95
PAD_RGMII0_RSTN	96	PAD_RGMII0_RXCLK	97	PAD_RGMII0_RXCTL	98
PAD_RGMII0_RXD0	99	PAD_RGMII0_RXD1	100	PAD_RGMII0_RXD2	101
PAD_RGMII0_RXD3	102	PAD_RGMII0_TXCLK	103	PAD_RGMII0_TXCTL	104
PAD_RGMII0_TXD0	105	PAD_RGMII0_TXD1	106	PAD_RGMII0_TXD2	107
PAD_RGMII0_TXD3	108	PAD_RGMII0_MDIO	109	PAD_RGMII0_MDC	110
PAD_UART1_RX	111	PAD_UART1_TX	112	PAD_UART2_RX	113
PAD_UART2_TX	114	PAD_UART_RX	115	PAD_UART_TX	116
PAD_PM_GPIO0	117	PAD_PM_GPIO2	118	PAD_PM_GPIO3	119
PAD_PM_GPIO4	120	PAD_PM_GPIO5	121	PAD_PM_GPIO1	122
PAD_PM_GPIO6	123	PAD_PM_GPIO7	124	PAD_SATA_GPIO0	125
PAD_SATA_GPIO1	126	PAD_SAR_GPIO4	127	PAD_SAR_GPIO3	128
PAD_SAR_GPIO2	129	PAD_SAR_GPIO1	130	PAD_SAR_GPIO0	131

3. 功能描述¶

支持对gpio管脚的上下拉状态进行配置
支持对gpio管脚的驱动能力进行配置

4. 硬件连接¶

将对应gpio引脚连接至硬件即可。

5. Uboot用法介绍¶

5.1. Uboot config配置说明¶

[*] Sgs drivers  --->

    [*]   Sgs GPIO
    [*]   Sgs padmux

5.2. 相关代码路径¶

drivers/sgs/gpio/drv_gpio.c
drivers/sgs/gpio/drv_gpio.h
drivers/sgs/gpio/chip_name/hal_gpio.c
drivers/sgs/gpio/chip_name/hal_gpio.h
drivers/sgs/gpio/chip_name/hal_pinmux.c
drivers/sgs/gpio/chip_name/hal_pinmux.h
drivers/sgs/include/chip_name/gpio.h
drivers/sgs/include/chip_name/padmux.h

5.3. Dts参数配置说明¶

gpio: gpio {
    compatible = "sgs,gpio";
    status = "okay";
};

属性	描述	备注
compatible	用于匹配驱动进行驱动注册	禁止修改
status	驱动开关	根据需要配置，okay/disabled

5.4. Uboot cmd参数说明¶

<input|set|clear|toggle> <pin> → input/set/clear/toggle the specified pin

gpio status [-a] [<bank> | <pin>] → show [all / claimed] GPIOs

cmd	参数	说明
input	pin	设置引脚号为pin的引脚为gpio input mode
set	pin	设置引脚号为pin的引脚为gpio output high mode
clear	pin	设置引脚号为pin的引脚为gpio output low mode
toggle	pin	将引脚号为pin的引脚电平翻转
status	pin	查看引脚号为pin的引脚的状态

5.5. Uboot cmd使用实例¶

gpio input <gpio#> → gpio input 69 // gpio69 set as input

gpio set <gpio#> → gpio set 10 // gpio10 set as output high

gpio clear <gpio#> → gpio clear 49 // gpio49 set as output low

gpio toggle <gpio#> → gpio toggle 49 // gpio49 level toggle

gpio status <gpio#> → gpio status 20 // gpio20 status

5.6. 引脚初始状态设置¶

5.6.1. Uboot Config¶

编译Uboot时：make menuconfig

[*] Sgs drivers  --->

    [*]   Sgs PAD_INIT

5.6.2. 功能使用说明¶

PAD的初始状态包括输入/输出状态、电平状态、内部上拉状态、引脚驱动能力等级。因此在设置PAD初始状态的时候，主要是对以上四种状态进行配置。在xxx-padmux.dtsi中具体的配置格式如下：

/*
    * Format:
    * <Pad_Index   Direction       Level_State        Pull_State          Driving_Level>
    */
1. <PAD_OUTP_RX0_CH0 GPIO_DIR_IN    GPIO_LEVEL_NA     PAD_PULL_UP         PAD_DRV_1>,
2. <PAD_PM_I2C_SDA   GPIO_DIR_OUT   GPIO_LEVEL_HIGH   PAD_PULL_DOWN       PAD_DRV_1>,
3. <PAD_GPIOC_00     GPIO_DIR_NA    GPIO_LEVEL_NA     PAD_HIZ             PAD_DRV_3>,
4. <GPIO_NR     GPIO_DIR_NA     GPIO_LEVEL_NA      PAD_PULL_DEFAULT    PAD_DRV_DEFAULT>;

如上所示：

Pad_Index：表示PAD序号，可参考表1-1：GPIO NUM与PAD对应表。
Direction：表示Pad的输入/输出模式，可以选择配置为：GPIO_DIR_IN、GPIO_DIR_OUT、GPIO_DIR_NA。

GPIO_DIR_IN表示设置为输入，GPIO_DIR_OUT表示设置为输出。如果只需要设置PAD的内部上拉状态和驱动能力等级，而不需要将PAD设置为GPIO mode的话，可以在Direction位置传入GPIO_DIR_NA。Pad设置为输入/输出模式的时候需要将这只Pad设置为GPIO mode，所以需要在配置padmux的位置加入GPIO mode的设定
```
1.    <PAD_OUTP_RX0_CH0      PINMUX_FOR_GPIO_MODE      MDRV_PUSE_GPIO_OUTP_RX0_CH0>,
2.    <PAD_PM_I2C_SDA        PINMUX_FOR_GPIO_MODE      MDRV_PUSE_GPIO_PM_I2C_SDA>,
3.    <PAD_GPIOC_00          PINMUX_FOR_GPIO_MODE      MDRV_PUSE_GPIO_GPIOC_00>,
```
Level_State：表示电平高低状态，可以选择配置为：GPIO_LEVEL_HIGH、GPIO_LEVEL_LOW、GPIO_LEVEL_NA。

GPIO_LEVEL_HIGH表示高电平，GPIO_LEVEL_LOW表示低电平，GPIO_LEVEL_NA则表示无需配置初始电平，使用默认电平即可。
Pull_State：表示内部上下拉状态，可以选择配置为：PAD_PULL_UP、PAD_PULL_DOWN、PAD_HIZ、PAD_PULL_DEFAULT。

PAD_PULL_UP表示内部上拉，PAD_PULL_DOWN表示内部下拉，PAD_HIZ表示悬空，在不需要设置内部上拉状态的时候，可以选择PAD_PULL_DEFAULT，表示设置为默认状态

Driving_Level：表示驱动能力等级，可以选择配置为PAD_DRV_0、PAD_DRV_1、PAD_DRV_2......当不需要设置驱动能力等级的时候，也可以选择PAD_DRV_DEFAULT，即使用当前驱动能力等级，不做配置

Name	Config
Direction	GPIO_DIR_IN、GPIO_DIR_OUT、GPIO_DIR_NA
Level_State	GPIO_LEVEL_HIGH、GPIO_LEVEL_LOW、GPIO_LEVEL_NA
Pull_State	PAD_PULL_UP、PAD_PULL_DOWN、PAD_HIZ、PAD_PULL_DEFAULT
Driving_Level	PAD_DRV_0、PAD_DRV_1、PAD_DRV_2、……PAD_DRV_DEFAULT

6. Kernel用法介绍¶

6.1. Kernel config配置说明¶

Device Drivers  --->

    [*] GPIO Support  --->
        [*]   /sys/class/gpio/... (sysfs interface)

    [*] SGS SoC platform drivers  --->
        [*]   GPIO driver
        [*]   PADMUX driver

6.2. 相关代码路径¶

drivers/sgs_common/gpio/drv/drv_gpio.c
drivers/sgs_common/gpio/drv/drv_gpio.h
drivers/sgs_common/gpio/hal/chip_name/src/hal_gpio.c
drivers/sgs_common/gpio/hal/chip_name/inc/hal_gpio.h
drivers/sgs_common/gpio/hal/chip_name/src/hal_pinmux.c
drivers/sgs_common/gpio/hal/chip_name/inc/hal_pinmux.h
drivers/sgs_common/gpio/hal//chip_name/pub/gpio.h
drivers/sgs_common/gpio/hal/chip_name/pub/padmux.h
drivers/sgs/gpio/os/gpio_os.h
drivers/sgs/gpio/ut/gpio_irq_test.c

6.3. Dts参数配置说明¶

gpio: gpio {
    compatible = "sgs,gpio";
    #gpio-cells = <2>;
    status = "okay";
};

属性	描述	备注
compatible	用于匹配驱动进行驱动注册	禁止修改
#gpio-cells	声明设备节点gpio cells的个数	配置为2表示第一个cell为gpio号，第二个cell表示gpio有效电平
status	驱动开关	根据需要配置，ok/disabled

6.4. 模块使用介绍¶

6.4.1. export/unexport文件接口¶

Userspace可以通过sysfs接口操作GPIO

/sys/class/gpio对应的源码位于driver/gpio/gpiolib-sysfs.c

/sys/class/gpio目录下的包含export/unexport、gpioN、gpio_chipN三种文件：

文件名	读写权限	值	描述
export	wo	GPIO Index	在用户空间申请某个GPIO的控制权
unexport	wo	GPIO Index	在用户空间移除某个GPIO的控制权
gpioN	ro		包含具体GPIO的direction、value等信息
gpio_chipN	ro		指代GPIO控制器

/sys/class/gpio/export 文件属性为只允许写不允许读，用户程序通过写入GPIO的编号来向内核申请将某个GPIO的控制权导出到用户空间（sysfs），前提是没有内核代码申请这个GPIO端口，如用户申请编号为12的GPIO的命令：
```
# echo 12 > export
```
上述操作会为GPIO Index为12的GPIO创建一个节点gpio12，此时/sys/class/gpio目录下边生成一个gpio12的目录，如下图所示：
/sys/class/gpio/unexport 文件属性也为只允许写不允许读，和export的效果相反，用户通过写入GPIO的编号来移除用户空间（sysfs）的接口。如移除gpio12文件夹的操作命令：
```
# echo 12 > unexport
```
上述操作将会移除gpio12这个节点，如下图所示：

6.4.2. /sys/class/gpio/gpioN¶

/sys/class/gpio/gpioN 指代某个具体的gpio端口，里边有如下属性文件：

文件名	读写权限	值	描述
direction	rw	in	输入模式，value不可写
		out	输出模式，value可写
		high	输出状态，默认高电平状态，value可写
		low	输出状态，默认低电平状态，value可写
value	rw	1	高电平状态
value	rw	0	低电平状态
edge	rw	none	disable gpio中断
		rising	使能gpio中断，并设置为上升沿触发
		falling	使能gpio中断，并设置为下降沿触发
		both	使能gpio中断，并设置为双边沿触发

direction 表示gpio端口的方向，读取结果是in或out，读取命令为：

# cat direction

value 表示gpio引脚的电平，0表示低电平，1表示高电平；读取命令为：

# cat value

可以对direction进行写操作，命令为：

# echo in > direction

# echo out > direction

如果direction被配置为输出（out），电平默认为低，同时value是可写的，操作命令为：

# echo 1 > value

# echo 0 > value

direction写入low或high时不仅可以设置为输出还可以设置指定的输出电平。操作命令为：

# echo high > direction

# echo low > direction

当然如果内核不支持或者内核代码不愿意，将不会存在这个属性，比如内核调用了gpio_export(N,0)就表示内核不愿意修改gpio端口方向属性。

edge 表示是否使能gpio中断，并设置触发模式，支持上升沿触发、下降沿触发、双边沿触发：

# cat edge

可以对edge进行写操作，命令为：

# echo none > edge
# echo rising > edge
# echo falling > edge
# echo both > edge

如果需要使能某只脚的中断，需要先将该脚设置为输入状态，并设置触发模式，则可以调用poll(2)函数监听该中断，中断触发后poll(2)函数就会返回。

6.4.3. /sys/class/sgs/msys¶

LINUX GPIO框架暂时未支持GPIO上下拉和驱动能力调节相关配置，在LINUX的GPIO标准框架外，我们又增加了另外的文件接口用于操作GPIO的上下拉和调节驱动能力。如需支持此功能，首先需要打开 CONFIG_MSYS_GPIO 配置，该配置位于menuconfig中：Device Drivers -> SGS SoC platform drivers -> msys api ->support GPIO pull and driving modify

/sys/class/sgs/msys对应的源代码位于driver/sgs/msys/ms_msys.c

设置上拉/下拉之前需要先将GPIO设置为输入状态，输出状态上拉/下拉是没法测量的：

引脚设置为输入状态后，进入sys/class/sgs/msys文件夹：

gpio_pull 可以写入up和down

文件名读写权限值描述

gpio_pull rw up 上拉模式

down 下拉模式

查看GPIO当前的pull 状态是pull up / pull down / pull off：
```
1. # echo 50 >  gpio_pull
2. # cat gpio_pull
```
如果输入非法的GPIO Index 和GPIO Name，则会报错：

设置上拉和设置下拉的命令为：
```
1. # echo 50 up > gpio_pull
2. # echo 50 down > gpio_pull
```
设置后查看gpio_pull的状态，如下图，50表示GPIO Index，PAD_OUTN_RX0_CH3表示GPIO Name。
```
1. # cat gpio_pull
```
如果输入非法的GPIO Index 和GPIO Name，则会报错：

检查具体BIT是否被正确写入，可以根据GPIO_Mapping_Table，查找对应的PAD（如下图GPIO INDEX：50）。当pull up的时候PE bit位为1，PS bit位为0；pull down的时候PE bit位为1，PS bit位为0。具体操作命令为：
```
1. # riu_r 0x103e 0x34
```
查看riu_r返回值的BIT6、BIT11
gpio_drive 可以写入驱动的等级

文件名读写权限值描述

gpio_drive rw 0~8 设置GPIO的驱动等级

当前平台中GPIO的驱动能力等级可查阅GPIO_Mapping_Table。

查看GPIO的初始驱动能力等级的命令位：(也可以直接使用GPIO43的名称PAD_OUTP_RX0_CH0)
```
1. # echo 43 > gpio_drive
2. # cat gpio_drive
```
如果输入非法的GPIO Index 和GPIO Name，则会报错：

设置驱动能力之前将GPIO设置为高电平输出状态方便测量，设置命令为：
```
1. # echo 43 1 > gpio_drive
```
43为GPIO Index，1为驱动能力等级，对应4mA

设置驱动能力之后查看gpio_driver的状态，如下图，设置GPIO Index为43的引脚的驱动能力为4mA成功。
```
1. # cat gpio_drive
```
检查具体BIT是否被正确写入，可以根据GPIO_Mapping_Table，查找对应的PAD(如下图GPIO INDEX：50)。当设置驱动等级为1时，[103E56]#7 ~ #8为01。具体操作命令为：
```
1. # riu_r 0x103e 0x2B
```
查看riu_r返回值的BIT7、BIT8

6.4.4. 复用功能使用说明¶

当需要使用GPIO的复用功能时候，首先需要获取所要操作的PIN脚的Name、所要复用的Tmux Mode，将他们配置在xxx-padmux.dtsi中：

<PAD_EMMC_RST            PINMUX_FOR_EMMC8B_BOOT_MODE_1    MDRV_PUSE_EMMC_RST>,
<PAD_EMMC_CLK            PINMUX_FOR_EMMC8B_BOOT_MODE_1    MDRV_PUSE_EMMC_CLK>,
<PAD_EMMC_CMD            PINMUX_FOR_EMMC8B_BOOT_MODE_1    MDRV_PUSE_EMMC_CMD>,
<PAD_EMMC_D0             PINMUX_FOR_EMMC8B_BOOT_MODE_1    MDRV_PUSE_EMMC_D0>,
<PAD_EMMC_D1             PINMUX_FOR_EMMC8B_BOOT_MODE_1    MDRV_PUSE_EMMC_D1>,
<PAD_EMMC_D2             PINMUX_FOR_EMMC8B_BOOT_MODE_1    MDRV_PUSE_EMMC_D2>,
<PAD_EMMC_D3             PINMUX_FOR_EMMC8B_BOOT_MODE_1    MDRV_PUSE_EMMC_D3>,
<PAD_EMMC_D4             PINMUX_FOR_EMMC8B_BOOT_MODE_1    MDRV_PUSE_EMMC_D4>,
<PAD_EMMC_D5             PINMUX_FOR_EMMC8B_BOOT_MODE_1    MDRV_PUSE_EMMC_D5>,
<PAD_EMMC_D6             PINMUX_FOR_EMMC8B_BOOT_MODE_1    MDRV_PUSE_EMMC_D6>,
<PAD_EMMC_D7             PINMUX_FOR_EMMC8B_BOOT_MODE_1    MDRV_PUSE_EMMC_D7>,
<PAD_EMMC_DS             PINMUX_FOR_EMMC8B_BOOT_MODE_1    MDRV_PUSE_EMMC_DS>,

如上所示，第一列和第二列分别表示Pad Name和Tmux Mode，MDRV_PUSE_XXX可以理解为当前这一组的配置的Name。

配置的时候需要注意的事项：

一个Pad只能配置一种Mode，不可以一个Pad同时配置多个Mode。
一个Puse只能对应一组配置，否则会造成冲突。
配置的Pad和Mode必须是匹配的。
不允许在驱动中直接进行复用操作，要求复用的配置都集中到xxx_padmux.dtsi。（需要动态调整复用配置的除外，目的是为了方便管理和减少配置冲突）

6.4.5. 引脚初始状态设置¶

编译Kernel时：make menuconfig

Device Drivers-->
    [*] SGS SoC platform drivers-->
        [*] PAD_INIT driver

详见本文章节：功能使用说明

6.5. Sample Code¶

6.5.1 用户空间中断¶

用户空间代码使能gpio中断请参考sgs_gpio_poll.c。

1.    #include <stdio.h>
2.    #include <stdlib.h>
3.    #include <unistd.h>
4.    #include <fcntl.h>
5.    #include <sys/poll.h>
6.
7.    int main(int argc, char *argv[])
8.    {
9.        char buff[1024];
10.        int gpio_id;
12.        struct pollfd fds[1];
13.        int gpio_fd = open("/sys/class/gpio/gpio135/value", O_RDONLY);
14.        if (gpio_fd == -1)
15.            {printf("gpio open\n");}
16.        else
17.            {printf("/sys/class/gpio/gpio135/value\n");}
18.        fds[0].fd = gpio_fd;
19.        fds[0].events = POLLPRI;
20.        int ret = read(gpio_fd, buff, 10);
21.        if (ret == -1)
22.            printf("read fail\n");
23.        else
24.            printf("read\n");
25.        while (1)
26.        {
27.            printf("revents is %d\n", fds[0].revents);
28.            ret = poll(fds, 1, -1);
29.            if (ret == -1)
30.                printf("poll\n");
31.
32.            if (fds[0].revents & POLLPRI)
33.            {
34.                ret = lseek(gpio_fd, 0, SEEK_SET);
35.                if (ret == -1)
36.                    printf("lseek\n");
37.                ret = read(gpio_fd, buff, 10);
38.                if (ret == -1)
39.                    printf("read\n");
40.                printf("get interrupt\n");
41.            }
42.        }
43.    }

6.6 API使用参考¶

#include <drv_gpio.h>

int main()
{
    u8 index = 0;
    gpio_request(index,"test");
    gpio_direction_input(index);

    //do your operation
    gpio_set_value(index,1);

    //.....

    gpio_free(index);
}

7. API参考¶

该功能模块提供以下接口：

API名称	功能
gpio_request	申请gpio端口
gpio_free	释放gpio端口
gpio_direction_input	标记gpio为输入
gpio_direction_output	标记gpio为输出
gpio_get_value	获取输入引脚的电平
gpio_set_value	设定输出引脚的电平
drv_gpio_pad_set	设置引脚为gpio_mode
drv_gpio_pad_clr	清楚引脚的gpio_mode
drv_gpio_pad_val_set	设置引脚的tmux模式
drv_gpio_pad_val_get	获取某只pad当前配置的PadMode
drv_gpio_vol_val_set	获取输入引脚的电平，该接口仅在Muffin支持
drv_gpio_pad_in_out	判断引脚的输入输出状态
drv_gpio_pull_up	开启指定的gpio上拉功能
drv_gpio_pull_down	开启指定的gpio下拉功能
drv_gpio_pull_off	关闭指定的gpio上下拉功能，并切换至悬空状态
drv_gpio_pull_status	获取指定的gpio上下拉状态
drv_gpio_drv_set	设置指定的gpio驱动能力
drv_gpio_drv_get	获取指定的gpio的驱动能力等级
drv_gpio_to_irq	获取知道你过的gpio的中断号
drv_gpio_name_to_num	通过gpio name获取gpio index
drv_gpio_padmode_to_padindex	查询能够使用某一个特定的padmode的所有gpio脚
drv_padmux_getpad	以puse检索dtsi中配置的pad
drv_padmux_getmode	以puse检索dtsi中配置的tmux mode
drv_padmux_getpuse	获取puse的宏定义

7.1. gpio_request¶

目的

创建端口为GPIO。

语法

int gpio_request(unsigned gpio, const char *label)

参数

参数名称描述

gpio GPIO Index

label 具体名称
返回值

返回值描述

0 成功

other 失败

7.2. gpio_free¶

目的

释放GPIO端口。
语法
```
void gpio_free(unsigned gpio)
```
参数

参数名称描述

gpio GPIO Index
返回值

返回值描述

void 无

7.3. gpio_direction_input¶

目的

标记gpio为输入。

语法

int gpio_direction_input(unsigned gpio);

参数

参数名称描述

gpio GPIO Index
返回值

返回值描述

0 成功

other 失败

7.4. gpio_direction_output¶

目的

标记gpio为输出。

语法

int gpio_direction_output(unsigned gpio, int value);

参数

参数名称描述

gpio GPIO Index

value 输出值
返回值

返回值描述

0 成功

other 失败

7.5. gpio_get_value¶

目的

获取输入引脚的电平。
语法
```
int gpio_get_value(unsigned gpio);
```
参数

参数名称描述

gpio GPIO Index
返回值

返回值描述

int 电平值

7.6. gpio_set_value¶

目的

设定输出引脚的电平。

语法

void gpio_set_value(unsigned gpio, int value);

参数

参数名称描述

gpio GPIO Index

value 输出值
返回值

返回值描述

0 成功

other 失败

7.7. drv_gpio_pad_set¶

目的

设置引脚为GPIO MODE。
语法
```
void drv_gpio_pad_set(u8 gpio_index);
```
参数

参数名称描述

gpio_index GPIO Index
返回值

返回值描述

void 无

7.8. drv_gpio_pad_clr¶

目的

清除引脚的GPIO MODE。
语法
```
void drv_gpio_pad_clr(u8 gpio_index);
```
参数

参数名称描述

gpio_index GPIO Index
返回值

返回值描述

void 无

7.9. drv_gpio_pad_val_set¶

目的

设置引脚的TMUX模式。

语法

u8 drv_gpio_pad_val_set(u8 gpio_index, u32 pad_mode);

参数

参数名称描述

gpio_index GPIO Index

pad_mode TMUX MODE
返回值

返回值描述

1 输出参数错误

0 成功

7.10. drv_gpio_pad_val_get¶

目的

该API用于获取某只Pad当前配置的PadMode，前提是这只Pad配置PadMode的时候是通过Padmux接口进行配置，直接操作寄存器进行配置的方式则不会使该API生效。

语法

u8 drv_gpio_pad_val_get(u8 gpio_index, u32 *pad_mode);

参数

参数名称描述

gpio_index Group Index

pad_mode 获取到的TMUX MODE
返回值

返回值描述

1 输出参数错误

0 成功

7.11. drv_gpio_vol_val_set¶

目的

获取输入引脚的电平，注意本接口仅在Muffin支持。

语法

void drv_gpio_vol_val_set(u8 group, u32 mode);

参数

参数名称描述

group Group num (11 Groups in total)

mode Mode = 0：引脚电压为3.3V； Mode = 1：引脚电压为1.8V
返回值

返回值描述

void 无

7.12. drv_gpio_pad_in_out¶

目的

判断引脚的状态是输入还是输出。

语法

u8 drv_gpio_pad_in_out(u8 gpio_index, u8 *pad_in_out);

参数

参数名称描述

gpio_index GPIO Index

pad_in_out 0表示引脚状态为输出，1表示引脚状态为输入
返回值

返回值描述

1 输入参数错误

0 成功

7.13. drv_gpio_pull_up¶

目的

开启指定的GPIO上拉功能。
语法
```
u8 drv_gpio_pull_up(u8 gpio_index);
```
参数

参数名称描述

gpio_index GPIO Index
返回值

返回值描述

0 设置成功

other 该引脚不支持上拉设置或者输入参数错误

7.14. drv_gpio_pull_down¶

目的

开启指定的GPIO下拉功能。
语法
```
u8 drv_gpio_pull_down(u8 gpio_index);
```
参数

参数名称描述

gpio_index GPIO Index
返回值

返回值描述

0 设置成功

other 该引脚不支持下拉设置或者输入参数错误

7.15. drv_gpio_pull_off¶

目的

关闭指定的GPIO上/下拉功能，并切换至悬空状态。
语法
```
u8 drv_gpio_pull_off(u8 gpio_index);
```
参数

参数名称描述

gpio_index GPIO Index
返回值

返回值描述

0 设置成功

other 该引脚不支持上拉设置或者输入参数错误

7.16. drv_gpio_pull_status¶

目的

获取指定的GPIO上/下拉状态。

语法

u8 drv_gpio_pull_status(u8 gpio_index, u8 *pull_status);

参数

参数名称描述

gpio_index GPIO Index

pull_status 获取到的上/下拉状态
返回值

返回值描述

0 获取成功

1 该引脚不支持上拉设置或者输入参数错误

7.17. drv_gpio_drv_set¶

目的

设置指定的GPIO的驱动能力。

语法

u8 drv_gpio_drv_set(u8 gpio_index, u8 level);

参数

参数名称描述

gpio_index GPIO Index

level 驱动能力等级
返回值

返回值描述

0 设置成功

other 该引脚不支持驱动能力设置或者输入参数错误

7.18. drv_gpio_drv_get¶

目的

获取指定的GPIO的驱动能力等级。

语法

u8 drv_gpio_drv_get(u8 gpio_index, u8 *level);

参数

参数名称描述

gpio_index GPIO Index

level 获取到的GPIO的驱动能力等级
返回值

返回值描述

0 获取成功

1 该引脚不支持驱动能力设置或者输入参数错误

7.19. drv_gpio_to_irq¶

目的

获取指定的GPIO的中断号。
语法
```
int drv_gpio_to_irq(u8 gpio_index);
```
参数

参数名称描述

gpio_index GPIO Index
返回值

返回值描述

virq Virq为返回的中断号

负数或0 失败

7.20. drv_gpio_name_to_num¶

目的

通过GPIO Name获取GPIO Index。

语法

u8 drv_gpio_name_to_num(u8 *p_name, u8 *gpio_index);

参数

参数名称描述

p_name GPIO Name

gpio_index 获取到的GPIO Index
返回值

返回值描述

1 输入参数错误

0 成功

7.21. drv_gpio_padmode_to_padindex¶

目的

查询能够使用某一个特定PadMode的所有GPIO脚。

语法

u32 * drv_gpio_padmode_to_padindex(u32 mode);

参数

参数名称描述

mode 所要查询的PadMode
返回值

返回值描述

数组首地址存放GPIO Index的数组

7.22. drv_padmux_getpad¶

目的

以Puse为检索条件遍历，获取xxx-padmux.dtsi中配置到的Pad。
语法
```
int drv_padmux_getpad(int puse);
```
参数

参数名称描述

puse puse的宏定义
返回值

返回值描述

PadId 成功获取到padmux.dtsi中的Pad的宏定义

PAD_UNKNOWN 输入的Puse有误或者padmux.dtsi中没有对应的PadId

7.23. drv_padmux_getmode¶

目的

以Puse为检索条件遍历，获取xxx-padmux.dtsi中配置到的Tmux Mode。
语法
```
int drv_padmux_getmode(int puse);
```
参数

参数名称描述

puse Puse的宏定义
返回值

返回值描述

PadId 成功获取到padmux.dtsi中的Mode的宏定义

PAD_UNKNOWN 输入的Puse有误或者padmux.dtsi中没有对应的PadId

7.24. drv_padmux_getpuse¶

目的

因为PUSE的宏定义遵循一套规则：
1. 不同IP之间的偏移为0x10000
2. 同一个IP中不同Channel之间的偏移为0x100
3. 同一个IP同一个Channel中不同Puse之间的偏移为0x1
因此可以根据这三个参数获取Puse的宏定义。

语法

int drv_padmux_getpuse(int ip_index, int channel_index, int pad_index);

参数

参数名称	描述
ip_index	Puse所在的IP，可在mdrv_puse.h中查阅
channel_index	Puse所在的Channel，可在mdrv_puse.h中查阅
pad_index	Puse在channel中的Index，可在mdrv_puse.h中查阅

返回值

返回值描述

Puse 成功获取到padmux.dtsi中的PadId

8. FAQ¶

当操作gpio出现异常时，可参考如下几点进行调试。

常见问题	排查方向
export无法拉高拉低	电压表实际量测，直接写寄存器
padmode异常	使用iocheck工具检查padmode设置是否正确

8.1. 直接写寄存器¶

操作对应gpio pin的寄存器拉高拉低，使用电压表量测有无变化，定位是cat value有误还是 set value有误。

8.2. 使用iocheck工具检查¶

在目录kernel/drivers/sgs_common/gpio/ut/io_check目录下，直接make即可生成prog_io_check工具，打包到customer分区即可开机使用。

支持的选项如下:

选项	功能
-s	设置padmux mode
-g	获取padmux mode
-i	指定引脚号
-m	指定模式
-v	校验padmux mode冲突情况

例：查询某gpio pin，其索引为index

查询当前复用情况：./prog_io_check -i index

设置为对应mode：./prog_io_check -i index -m mode_index -s

参数名称	描述
group	Group num (11 Groups in total)
mode	Mode = 0：引脚电压为3.3V； Mode = 1：引脚电压为1.8V

参数名称	描述
gpio_index	GPIO Index
pad_in_out	0表示引脚状态为输出，1表示引脚状态为输入

返回值	描述
0	设置成功
other	该引脚不支持上拉设置或者输入参数错误

返回值	描述
0	设置成功
other	该引脚不支持下拉设置或者输入参数错误

返回值	描述
0	获取成功
1	该引脚不支持上拉设置或者输入参数错误

返回值	描述
0	设置成功
other	该引脚不支持驱动能力设置或者输入参数错误

参数名称	描述
gpio_index	GPIO Index
level	获取到的GPIO的驱动能力等级

返回值	描述
PadId	成功获取到padmux.dtsi中的Pad的宏定义
PAD_UNKNOWN	输入的Puse有误或者padmux.dtsi中没有对应的PadId

返回值	描述
PadId	成功获取到padmux.dtsi中的Mode的宏定义
PAD_UNKNOWN	输入的Puse有误或者padmux.dtsi中没有对应的PadId

文件名	读写权限	值	描述
gpio_pull	rw	up	上拉模式
gpio_pull	rw	down	下拉模式

返回值	描述
1	输出参数错误
0	成功

返回值	描述
1	输出参数错误
0	成功

返回值	描述
1	输入参数错误
0	成功