5. GPIO 使用

5.1. 简介

GPIO，全称 General-Purpose Input/Output（通用输入输出），是一种软件运行期间能够动态配置和控制的通用引脚。 所有的 GPIO 在上电后的初始状态都是输入模式，可以通过软件设为上拉或下拉，也可以设置为中断脚，驱动强度都是可编程的，其核心是填充 GPIO bank 的方法和参数，并调用 gpiochip_add 注册到内核中。

5.1.1. Rockchip 矩阵 IO 功能列表

ROC-RK3506J-CC 支持一个 Rockchip Matrix IO（RM_IO），旨在让众多功能信号共享到有限的引脚接口。在同一矩阵内，任何函数信号可以通过软件配置映射到任何引脚接口。RM_IO 支持 98 个功能信号映射到 32 个引脚接口（GPIO0_A0~GPIO0_C7, GPIO1_B1~GPIO1_B3, GPIO1_C2~GPIO1_C3、GPIO1_D1~GPIO1_D3） 。

具体 RM_IO 功能列表详见芯片 Datasheet 文档：/path/to/sdk/docs/en/Socs/Datasheet/Rockchip RK3506B Datasheet V1.0-20240816.pdf

ROC-RK3506J-CC 开发板为了方便用户开发使用，引出了GPIO口供用户调试和开发，可以用到的 GPIO0_C2。

_images/usage_gpio_interface.png

5.2. GPIO引脚计算

ROC-RK3506J-CC 有 4 组 GPIO bank：GPIO0~GPIO3，每组又以 A0~A7, B0~B7, C0~C7, D0~D7 作为编号区分，常用以下公式计算引脚：

GPIO pin脚计算公式：pin = bank * 32 + number

GPIO 小组编号计算公式：number = group * 8 + X

下面演示 GPIO0_C2 pin脚计算方法：

bank = 0;      //GPIO0_C2 => 0, bank ∈ [0,4]

group = 2;      //GPIO0_C2 => 2, group ∈ {(A=0), (B=1), (C=2), (D=3)}

X = 2;       //GPIO0_C2 => 2, X ∈ [0,7]

number = group * 8 + X = 2 * 8 + 2 = 18

pin = bank*32 + number= 0 * 32 + 18 = 18;

GPIO0_C2 对应的设备树属性描述为:<&gpio0 18 GPIO_ACTIVE_HIGH>,由kernel/include/dt-bindings/pinctrl/rockchip.h的宏定义可知，也可以将GPIO0_C2 描述为<&gpio0 RK_PC2 GPIO_ACTIVE_HIGH>。

#define RK_PA0		0
#define RK_PA1		1
#define RK_PA2		2
#define RK_PA3		3
#define RK_PA4		4
#define RK_PA5		5
#define RK_PA6		6
#define RK_PA7		7
#define RK_PB0		8
#define RK_PB1		9
#define RK_PB2		10
#define RK_PB3		11
...

当 GPIO0_C2 脚没有被其它外设复用时，我们可以通过 export 导出该引脚去使用

root@rk3506-buildroot:/# ls /sys/class/gpio/
export  gpiochip0  gpiochip128  gpiochip32  gpiochip503  gpiochip511  gpiochip64  gpiochip96  unexport
root@rk3506-buildroot:/# echo 18 > /sys/class/gpio/export
root@rk3506-buildroot:/# ls /sys/class/gpio/
export  gpio18  gpiochip0  gpiochip128  gpiochip32  gpiochip503  gpiochip511  gpiochip64  gpiochip96  unexport
root@rk3506-buildroot:/# ls /sys/class/gpio/gpio18
active_low  device  direction  edge  power  subsystem  uevent  value

5.3. 输入输出

5.3.1. 应用层设置

在上述 export 导出引脚后，可以直接设置 gpio 为输入模式或者输出模式

  • 查看当前 gpio 的模式

root@rk3506-buildroot:/# cat /sys/class/gpio/gpio18/direction
in

  • 设置为输入模式

root@rk3506-buildroot:/# echo in > /sys/class/gpio/gpio18/direction

  • 在输入模式下，直接查看 value 文件的值即可知道输入的电平

root@rk3506-buildroot:/# cat /sys/class/gpio/gpio18/value
0

  • 设置为输出模式

root@rk3506-buildroot:/# echo out > /sys/class/gpio/gpio18/direction

  • 设置输出高电平

root@rk3506-buildroot:/# echo 1 > /sys/class/gpio/gpio18/value

  • 设置输出低电平

root@rk3506-buildroot:/# echo 0 > /sys/class/gpio/gpio18/value

5.3.2. 驱动层设置

of_get_named_gpio_flags 从设备树中读取 gpio 和 irq-gpio 的 GPIO 配置编号和标志，gpio_is_valid 判断该 GPIO 编号是否有效，gpio_request 则申请占用该 GPIO。如果初始化过程出错，需要调用 gpio_free 来释放之前申请过且成功的 GPIO 。在驱动中调用 gpio_direction_output 就可以设置输出高还是低电平，这里默认输出从 DTS 获取得到的有效电平 GPIO_ACTIVE_HIGH，即为高电平，如果驱动正常工作，可以用万用表测得对应的引脚应该为高电平。实际中如果要读出 GPIO，需要先设置成输入模式，然后再读取值：

int val;
gpio_direction_input(your_gpio);
val = gpio_get_value(your_gpio);

下面是常用的 GPIO API 定义：

#include <linux/gpio.h>
#include <linux/of_gpio.h>

enum of_gpio_flags {
	OF_GPIO_ACTIVE_LOW = 0x1,
};
int of_get_named_gpio_flags(struct device_node *np, const char *propname,
int index, enum of_gpio_flags *flags);
int gpio_is_valid(int gpio);
int gpio_request(unsigned gpio, const char *label);
void gpio_free(unsigned gpio);
int gpio_direction_input(int gpio);
int gpio_direction_output(int gpio, int v);

5.4. 中断

IRQ_TYPE_EDGE_RISING 表示中断由上升沿触发，当该引脚接收到上升沿信号时可以触发中断函数。 这里还可以配置成如下：

IRQ_TYPE_NONE         //默认值，无定义中断触发类型
IRQ_TYPE_EDGE_RISING  //上升沿触发
IRQ_TYPE_EDGE_FALLING //下降沿触发
IRQ_TYPE_EDGE_BOTH    //上升沿和下降沿都触发
IRQ_TYPE_LEVEL_HIGH   //高电平触发
IRQ_TYPE_LEVEL_LOW    //低电平触发

然后在 probe 函数中对 DTS 所添加的资源进行解析，再做中断的注册申请，例如代码如下：

static int firefly_gpio_probe(struct platform_device *pdev)
{
	int ret;
	int gpio;
	enum of_gpio_flags flag;
	struct firefly_gpio_info *gpio_info;
	struct device_node *firefly_gpio_node = pdev->dev.of_node;
	...

	gpio_info->firefly_irq_gpio = gpio;
	gpio_info->firefly_irq_mode = flag;
	gpio_info->firefly_irq = gpio_to_irq(gpio_info->firefly_irq_gpio);
	if (gpio_info->firefly_irq)
	{
		if (gpio_request(gpio, "firefly-irq-gpio"))
		{
			dev_err(&pdev->dev, "firefly-irq-gpio: %d request failed!\n", gpio);
			gpio_free(gpio);
			return IRQ_NONE;
		}

		ret = request_irq(gpio_info->firefly_irq, firefly_gpio_irq,
							flag, "firefly-gpio", gpio_info);
		if (ret != 0)
		{
			free_irq(gpio_info->firefly_irq, gpio_info);
			dev_err(&pdev->dev, "Failed to request IRQ: %d\n", ret);
		}
	}
	printk("Firefly irq gpio finish \n");
	return 0;
}

static irqreturn_t firefly_gpio_irq(int irq, void *dev_id) //中断函数
{
	printk("Enter firefly gpio irq test program!\n");
	return IRQ_HANDLED;
}

调用 gpio_to_irq 把 GPIO 的 PIN 值转换为相应的 IRQ 值，调用 gpio_request 申请占用该 IO 口，调用 request_irq 申请中断，如果失败要调用 free_irq 释放，该函数中 gpio_info-firefly_irq 是要申请的硬件中断号，firefly_gpio_irq 是中断函数，gpio_info->firefly_irq_mode 是中断处理的属性，firefly-gpio 是设备驱动程序名称，gpio_info 是该设备的 device 结构，在注册共享中断时会用到。

5.5. 复用

该案例仅供参考，最终以实际硬件接口为准
GPIO 口除了通用输入输出、中断功能外，还可能有其它复用功能，以GPIO0_C2为例，就有如下几个功能：

func0 func1 func2
RM_IO18 SPI0_MISO REF_CLK1_OUT

查看 /sys/kernel/debug/pinctrl/pinctrl-rockchip-pinctrl/pinmux-pins，查看各个引脚的作用，如果发现 GPIO0_C2 被复用为 SPI0_MISO ，则需要在dts中关闭它。

5.6. 调试方法

5.6.1. IO指令

GPIO 调试有一个很好用的工具，那就是 IO 指令，ROC-RK3506J-CC 的 Linux 系统默认已经内置了 IO 指令，使用 IO 指令可以实时读取或写入每个 IO 口的状态，这里简单介绍 IO 指令的使用。首先查看 IO 指令的帮助：

root@rk3506-buildroot:/# io --help
Unknown option: ?
Raw memory i/o utility - $Revision: 1.5 $

io -v -1|2|4 -r|w [-l <len>] [-f <file>] <addr> [<value>]

    -v         Verbose, asks for confirmation
    -1|2|4     Sets memory access size in bytes (default byte)
    -l <len>   Length in bytes of area to access (defaults to
               one access, or whole file length)
    -r|w       Read from or Write to memory (default read)
    -f <file>  File to write on memory read, or
               to read on memory write
    <addr>     The memory address to access
    <val>      The value to write (implies -w)

Examples:
    io 0x1000                  Reads one byte from 0x1000
    io 0x1000 0x12             Writes 0x12 to location 0x1000
    io -2 -l 8 0x1000          Reads 8 words from 0x1000
    io -r -f dmp -l 100 200    Reads 100 bytes from addr 200 to file
    io -w -f img 0x10000       Writes the whole of file to memory

Note access size (-1|2|4) does not apply to file based accesses.

从帮助上可以看出，如果要读或者写一个寄存器，可以用：

io -4 -r 0x1000 //读从0x1000起的4位寄存器的值
io -4 -w 0x1000 //写从0x1000起的4位寄存器的值

5.6.2. GPIO 调试接口

Debugfs 文件系统目的是为开发人员提供更多内核数据，方便调试。 这里 GPIO 的调试也可以用 Debugfs 文件系统，获得更多的内核信息。GPIO 在 Debugfs 文件系统中的接口为 /sys/kernel/debug/gpio，可以这样读取该接口的信息：

root@rk3506-buildroot:/# cat /sys/kernel/debug/gpio
gpiochip0: GPIOs 0-31, parent: platform/ff940000.gpio, gpio0:
 gpio-1   (                    |wd-en               ) in  lo
 gpio-18  (                    |sysfs               ) out lo
 gpio-24  (                    |hp-det              ) in  lo IRQ

gpiochip1: GPIOs 32-63, parent: platform/ff870000.gpio, gpio1:

gpiochip2: GPIOs 64-95, parent: platform/ff1c0000.gpio, gpio2:

gpiochip3: GPIOs 96-127, parent: platform/ff1d0000.gpio, gpio3:

gpiochip4: GPIOs 128-159, parent: platform/ff1e0000.gpio, gpio4:

gpiochip5: GPIOs 272-287, parent: i2c/0-0021, 0-0021, can sleep:
 gpio-272 (                    |enable              ) out hi
 gpio-273 (                    |enable              ) out hi
 gpio-274 (                    |reset               ) out hi ACTIVE LOW
 gpio-276 (                    |:user               ) out hi
 gpio-277 (                    |vcc5v0-otg0-otg1-reg) out hi
 gpio-281 (                    |vcc-wifi-pwren-regul) out lo ACTIVE LOW
 gpio-282 (                    |spk-con             ) out lo
 gpio-284 (                    |vcc-hub-reset-regula) out hi
 gpio-285 (                    |vcc-host1-pwr-en-reg) out hi
 gpio-286 (                    |:power              ) out hi
 gpio-287 (                    |hp-con              ) out lo
 ...

从读取到的信息中可以知道，内核把 GPIO 当前的状态都列出来了，以 GPIO0 组为例，gpio-18(GPIO0_C2) 输出低电平 (out lo)。

5.6.3. 查看 pinmux-pins

使用命令

root@rk3506-buildroot:/# cat /sys/kernel/debug/pinctrl/pinctrl-rockchip-pinctrl/pinmux-pins

得到结果

Pinmux settings per pin
Format: pin (name): mux_owner gpio_owner hog?
pin 0 (gpio0-0): (MUX UNCLAIMED) (GPIO UNCLAIMED)
pin 1 (gpio0-1): (MUX UNCLAIMED) gpio0:1
pin 2 (gpio0-2): (MUX UNCLAIMED) (GPIO UNCLAIMED)
pin 3 (gpio0-3): ff932000.pwm (GPIO UNCLAIMED) function rm_io3 group rm-io3-pwm0-ch2
pin 4 (gpio0-4): ff040000.i2c (GPIO UNCLAIMED) function rm_io4 group rm-io4-i2c0-scl
pin 5 (gpio0-5): ff040000.i2c (GPIO UNCLAIMED) function rm_io5 group rm-io5-i2c0-sda
pin 6 (gpio0-6): (MUX UNCLAIMED) (GPIO UNCLAIMED)
pin 7 (gpio0-7): 0-0051 (GPIO UNCLAIMED) function hym8563 group hym8563-int
pin 8 (gpio0-8): 0-0011 (GPIO UNCLAIMED) function rm_io8 group rm-io8-sai1-mclk
pin 9 (gpio0-9): ff310000.sai (GPIO UNCLAIMED) function rm_io9 group rm-io9-sai1-sclk
pin 10 (gpio0-10): ff310000.sai (GPIO UNCLAIMED) function rm_io10 group rm-io10-sai1-lrck
pin 11 (gpio0-11): ff310000.sai (GPIO UNCLAIMED) function rm_io11 group rm-io11-sai1-sdi
pin 12 (gpio0-12): ff310000.sai (GPIO UNCLAIMED) function rm_io12 group rm-io12-sai1-sdo0
...

解析： pin 0这一列表示引脚编号，gpio0-0这一列表示gpio组编号，后面MUX UNCLAIMED这一列表示数据选择器的拥有者，GPIO UNCLAIMED这一列表示gpio的拥有者。

其中 MUX UNCLAIMED 表示该引脚还没有被节点使用pinctrl去进行控制。GPIO UNCLAIMED表示还没有注册的gpio使用该引脚

5.7. FAQs

5.7.1. Q1: 如何将 PIN 的 MUX 值切换为一般的 GPIO？

A1: 当使用 GPIO request 时候，会将该 PIN 的 MUX 值强制切换为 GPIO，所以使用该 PIN 脚为 GPIO 功能的时候确保该 PIN 脚没有被其他模块所使用。

5.7.2. Q2: 为什么我用 IO 指令读出来的值都是 0x00000000？

A2: 如果用 IO 命令读某个 GPIO 的寄存器，读出来的值异常,如 0x00000000 或 0xffffffff 等，请确认该 GPIO 的 CLK 是不是被关了，GPIO 的 CLK 是由 CRU 控制，可以通过读取 datasheet 下面 CRU_CLKGATE_CON* 寄存器来查到 CLK 是否开启，如果没有开启可以用 io 命令设置对应的寄存器，从而打开对应的 CLK，打开 CLK 之后应该就可以读到正确的寄存器值了。

5.7.3. Q3: 测量到 PIN 脚的电压不对应该怎么查？

A3: 测量该 PIN 脚的电压不对时，如果排除了外部因素，可以确认下该 PIN 所在的 IO 电压源是否正确，以及 IO-Domain 配置是否正确。

5.7.4. Q4: gpio_set_value() 与 gpio_direction_output() 有什么区别？

A4: 如果使用该 GPIO 时，不会动态的切换输入输出，建议在开始时就设置好 GPIO 输出方向，后面拉高拉低时使用 gpio_set_value() 接口，而不建议使用 gpio_direction_output(), 因为 gpio_direction_output 接口里面有 mutex 锁，对中断上下文调用会有错误异常，且相比 gpio_set_value，gpio_direction_output 所做事情更多，浪费。