标准linux4.4--驱动开发（二）GPIO驱动编写

简介
介绍GPIO
DTS配置
在驱动文件中关联DTS的配置
驱动说明
中断
复用
FAQs

简介

1、什么是linux内核模块
在linux中，驱动程序是以内核模块的形式存在的，驱动程序是放在module中的。每个驱动程序都是一个个独立的module，一般情况下，各个module是无关的。在设计linux驱动的时候，首先需要设计一个module。

2、加载的方式
（1）module编译好以后生成一个*.ko
module可以安装，可以卸载
#insmod led_drv.ko
#rmmod led_drv.ko
#lsmod ----->显示所有的使用#insmod安装的module
(2)驱动编译进内核
在源码级上，kernel/driver目录下添加自己的驱动，并在相应目录添加config、Makefile

3、设计linux的驱动程序，需要阅读linux源码
sourceinsight 软件阅读linux内核源码：

介绍GPIO

GPIO, 全称 General-Purpose Input/Output（通用输入输出），是一种软件运行期间能够动态配置和控制的通用引脚。 RK3399 有 5 组 GPIO bank：GPIO0~GPIO4，每组又以 A0~A7, B0~B7, C0~C7, D0~D7 作为编号区分（不是所有 bank 都有全部编号，例如 GPIO4 就只有 C0~C7, D0~D2)。所有的 GPIO 在上电后的初始状态都是输入模式，可以通过软件设为上拉或下拉，也可以设置为中断脚，驱动强度都是可编程的。每个 GPIO 口除了通用输入输出功能外，还可能有其它复用功能。
如
看GPIO1_A5,可以复用成3个功能，分别是GPIO1_A5、LCDC_D1、I2S。

以下举个简单的例子
都是描述将驱动编译进内核的方式，如何将一个开发板上的GPIO口使用起来，编写驱动，应用层去控制这个IO口。

DTS配置

例子一：
描述设备树

test-leds {compatible = "test-leds";poll-interval = <100>;pinctrl-names = "default";pinctrl-0 = <&led_gpio>;gpio = <&gpio0 RK_PC0 GPIO_ACTIVE_HIGH>;//以下这里是弄了个软件键盘按键的作用，此篇大家只需关注GPIO部分即可led-key {linux,code = <KEY_MEDIA>;label = "media";};};

因为上述使用了pinctl部分，所以再次需要声明led_gpio口的pintcl：

 myled {led_gpio: led-gpio{rockchip,pins = <0 RK_PC0 RK_FUNC_GPIO &pcfg_pull_up>;//RK_PC0 RK_FUNC_GPIO 此句话意思为定义该IO为GPIO模式。后期小伙伴需要将IO口复用成其他功能的再次声明即可};};

例子二：
设备树描述：

gpio_demo: gpio_demo {status = "okay";compatible = "firefly,rk3399-gpio";firefly-gpio = <&gpio0 12 GPIO_ACTIVE_HIGH>;          /* GPIO0_B4 */firefly-irq-gpio = <&gpio4 29 IRQ_TYPE_EDGE_RISING>;  /* GPIO4_D5 */};

在驱动文件中关联DTS的配置

用户驱动可参考 RK gpio驱动 :首先在驱动文件中定义 of_device_id 结构体数组：

static struct of_device_id firefly_match_table[] = {{ .compatible = "firefly,rk3399-gpio",},{},
};

然后将该结构体数组填充到要使用 gpio 的 platform_driver 中：

static struct platform_driver firefly_gpio_driver = {.driver = {.name = "firefly-gpio",.owner = THIS_MODULE,.of_match_table = firefly_match_table,},.probe = firefly_gpio_probe,
};

接着在 probe函数中对 DTS 所添加的资源进行解析：
简单逻辑是：获取道设备树描述的节点，获取gpio树，在获取节点中相应的属性，分别保存起来。
例句相关部分驱动：（具体可以下载看）

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;printk("Firefly GPIO Test Program Probe\n");gpio_info = devm_kzalloc(&pdev->dev,sizeof(struct firefly_gpio_info *), GFP_KERNEL);if (!gpio_info) {dev_err(&pdev->dev, "devm_kzalloc failed!\n");return -ENOMEM;}gpio = of_get_named_gpio_flags(firefly_gpio_node, "firefly-gpio", 0, &flag);if (!gpio_is_valid(gpio)) {dev_err(&pdev->dev, "firefly-gpio: %d is invalid\n", gpio);return -ENODEV;}if (gpio_request(gpio, "firefly-gpio")) {dev_err(&pdev->dev, "firefly-gpio: %d request failed!\n", gpio);gpio_free(gpio);return -ENODEV;}gpio_info->firefly_gpio = gpio;gpio_info->gpio_enable_value = (flag == OF_GPIO_ACTIVE_LOW) ? 0:1;gpio_direction_output(gpio_info->firefly_gpio, gpio_info->gpio_enable_value);printk("Firefly gpio putout\n");gpio = of_get_named_gpio_flags(firefly_gpio_node, "firefly-irq-gpio", 0, &flag);printk("firefly:the gpio:%d\n",gpio);if (!gpio_is_valid(gpio)) {dev_err(&pdev->dev, "firefly-irq-gpio: %d is invalid\n", gpio);return -ENODEV;}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);}}return 0;
}

驱动说明

of_get_named_gpio_flags 从设备树中读取 firefly-gpio 和 firefly-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);

中断

在 Firefly 的例子程序中还包含了一个中断引脚，GPIO 口的中断使用与 GPIO 的输入输出类似，首先在 DTS 文件中增加驱动的资源描述：

gpio {compatible = "firefly-gpio";firefly-irq-gpio = <&gpio4 29 IRQ_TYPE_EDGE_RISING>;  /* GPIO4_D5 */
};

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")) {printk("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);}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 结构，在注册共享中断时会用到。

复用

如何定义 GPIO 有哪些功能可以复用，在运行时又如何切换功能呢？以 I2C4 为例作简单的介绍。

查规格表可知，I2C4_SDA 与 I2C4_SCL 的功能定义如下：

Pad#                      func0           func1
I2C4_SDA/GPIO1_B3   gpio1b3     i2c4_sda
I2C4_SCL/GPIO1_B4   gpio1b4     i2c4_scl

在 kernel/arch/arm64/boot/dts/rockchip/rk3399.dtsi 里有：

i2c4: i2c@ff3d0000{compatible = "rockchip,rk3399-i2c";reg = <0x0 0xff3d0000 0x0 0x1000>;clocks = <&pmucru SCLK_I2C4_PMU>, <&pmucru PCLK_I2C4_PMU>;clock-names = "i2c", "pclk";interrupts = <GIC_SPI 56 IRQ_TYPE_LEVEL_HIGH 0>;pinctrl-names = "default", "gpio";pinctrl-0 = <&i2c4_xfer>;pinctrl-1 = <&i2c4_gpio>;   //此处源码未添加#address-cells = <1>;#size-cells = <0>;status = "disabled";
};

此处，跟复用控制相关的是 pinctrl- 开头的属性：

pinctrl-names 定义了状态名称列表： default (i2c 功能) 和 gpio 两种状态。

pinctrl-0 定义了状态 0 (即 default）时需要设置的 pinctrl: &i2c4_xfer

pinctrl-1 定义了状态 1 (即 gpio)时需要设置的 pinctrl: &i2c4_gpio

这些 pinctrl 在 kernel/arch/arm64/boot/dts/rockchip/rk3399.dtsi 中这样定义：

pinctrl: pinctrl {compatible = "rockchip,rk3399-pinctrl";rockchip,grf = <&grf>;rockchip,pmu = <&pmugrf>;#address-cells = <0x2>;#size-cells = <0x2>;ranges;i2c4{i2c4_xfer: i2c4-xfer{rockchip,pins = <1 12 RK_FUNC_1 &pcfg_pull_none>, <1 11 RK_FUNC_1 &pcfg_pull_none>;};i2c4_gpio: i2c4-gpio {rockchip,pins = <1 12 RK_FUNC_GPIO &pcfg_pull_none>, <1 11 RK_FUNC_GPIO &pcfg_pull_none>;};
};

RK_FUNC_1,RK_FUNC_GPIO 的定义在 kernel/include/dt-bindings/pinctrl/rk.h 中：

 #define RK_FUNC_GPIO    0#define RK_FUNC_1   1#define RK_FUNC_2   2#define RK_FUNC_3   3#define RK_FUNC_4   4#define RK_FUNC_5   5#define RK_FUNC_6   6#define RK_FUNC_7   7

另外，像 “1 11”，”1 12” 这样的值是有编码规则的，编码方式与上一小节 “输入输出” 描述的一样，”1 11” 代表 GPIO1_B3，”1 12” 代表 GPIO1_B4。

在复用时，如果选择了 default （即 i2c 功能),系统会应用 i2c4_xfer 这个 pinctrl，最终将 GPIO1_B3 和 GPIO1_B4 两个针脚切换成对应的 i2c 功能；而如果选择了 gpio ，系统会应用 i2c4_gpio 这个 pinctrl，将 GPIO1_B3 和 GPIO1_B4 两个针脚还原为 GPIO 功能。

我们看看 i2c 的驱动程序 kernel/drivers/i2c/busses/i2c-rockchip.c 是如何切换复用功能的：

static int rockchip_i2c_probe(struct platform_device *pdev)
{struct rockchip_i2c *i2c = NULL; struct resource *res;struct device_node *np = pdev->dev.of_node; int ret;//...i2c->sda_gpio = of_get_gpio(np, 0);if (!gpio_is_valid(i2c->sda_gpio)) {dev_err(&pdev->dev, "sda gpio is invalid\n");return -EINVAL;}ret = devm_gpio_request(&pdev->dev, i2c->sda_gpio, dev_name(&i2c->adap.dev));if (ret) {dev_err(&pdev->dev, "failed to request sda gpio\n");return ret;}i2c->scl_gpio = of_get_gpio(np, 1);if (!gpio_is_valid(i2c->scl_gpio)) {dev_err(&pdev->dev, "scl gpio is invalid\n");return -EINVAL;}ret = devm_gpio_request(&pdev->dev, i2c->scl_gpio, dev_name(&i2c->adap.dev));if (ret) {dev_err(&pdev->dev, "failed to request scl gpio\n");return ret;}i2c->gpio_state = pinctrl_lookup_state(i2c->dev->pins->p, "gpio");if (IS_ERR(i2c->gpio_state)) {dev_err(&pdev->dev, "no gpio pinctrl state\n");return PTR_ERR(i2c->gpio_state);}pinctrl_select_state(i2c->dev->pins->p, i2c->gpio_state);gpio_direction_input(i2c->sda_gpio);gpio_direction_input(i2c->scl_gpio);pinctrl_select_state(i2c->dev->pins->p, i2c->dev->pins->default_state);...
}

首先是调用 of_get_gpio 取出设备树中 i2c4 结点的 gpios 属于所定义的两个 gpio:

gpios = <&gpio1 GPIO_B3 GPIO_ACTIVE_LOW>, <&gpio1 GPIO_B4 GPIO_ACTIVE_LOW>;
然后是调用 devm_gpio_request 来申请 gpio，接着是调用 pinctrl_lookup_state 来查找 gpio 状态，而默认状态 default 已经由框架保存到 i2c->dev-pins->default_state 中了。

最后调用 pinctrl_select_state 来选择是 default 还是 gpio 功能。

下面是常用的复用 API 定义：

#include <linux/pinctrl/consumer.h>
struct device {//...#ifdef CONFIG_PINCTRLstruct dev_pin_info    *pins;#endif//...
};
struct dev_pin_info {struct pinctrl *p;struct pinctrl_state *default_state;
#ifdef CONFIG_PMstruct pinctrl_state *sleep_state;struct pinctrl_state *idle_state;
#endif
};
struct pinctrl_state * pinctrl_lookup_state(struct pinctrl *p, const char *name);
int pinctrl_select_state(struct pinctrl *p, struct pinctrl_state *s);

点击下载文章中驱动文件

FAQs

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

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

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

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 所做事情更多，浪费。