怎么样才能让自己成功一个合格的Linux驱动开发人员，很多人喜欢一头扎进源码里抠各种细节，我自己实践出来的感受是：这样去学习Linux驱动很累，进步很慢。内核里设计的很多驱动框架其实是在不断的完善和抽象的，只有理解前人们设计框架时的思路和想法，才能融合他们的工作体系里。其实内核的开发人员们写了不少的文档和说明，只是我们往往懒于搜索，这些驱动框架的原创者的一两句总结可以很好地帮忙我们理解驱动。下面这篇笔记，会尽量少一点源码分析。

一、概述

pinctrl和gpio子系统在内核里的使用率非常高，和嵌入式产品的关联非常大。从这两个子系统开始学习驱动开发是个不错的入门选择。

gpio子系统提供了：

- 读引脚值，高或者低

- 输出高低电平；

- 部分gpio还负责接收IRQ，涉及irqchip子系统；

pinctrl子系统提供了：

- 引脚复用，大多数引脚都可以通过配置寄存器来选择复用成不同的功能，例如某个引脚即可用作为普通的gpio，也可以作为UART的TX；

- 引脚配置，一般包括上下拉、驱动能力等；

对于gpio子系统：

- 对于Linux-4.14，源码位于：drivers/gpio/*

- 文档位于：Documentation/gpio/*

- 所有的GPIO都会被编号，从0~N；

- 内核里使用GPIO子系统的代码被称为Consumer，Consumer是通过[devm_]gpio_request(gpio, label)来申请GPIO；

- 1个GPIO可以被设置为输入或者输出（gpiod_direction_output()）；

- 被设置出输入时，可以读到高或者电平（gpiod_direction_input()）；

- 被设置出输出时，可以输出高或者低电平（gpiod_set_value()）；

- GPIO可以被映射为Linux IRQ，暂时不关注这一块；

- GPIO可以在/sys/class/gpio中被导出，供应用层使用；

- struct gpio_chip用于表示一个gpio控制器，可通过gpiochip_add_data()将其注册给gpio子系统；

查看gpio子系统的文档：

$ tree Documentation/gpio/

如何为一款CPU的添加gpio驱动：

1. 针对具体CPU构造struct gpio_chip，部分成员如下：

2. 向gpio子系统注册CPU的struct gpio_chip（gpiochip_add_data()）；

对于pinctrl子系统：

- 硬件上的一个引脚通过软件的配置可作为不同的功能的行为叫做引脚复用（pin muxing），gpio（input/output功能）是引脚复用的子集；

- pinctrl子系统是在3.4内核中第一次被正式宣布的；

- 对于Linux-4.14，源码位于：drivers/pinctrl/*；

- 文档位于：Documentation/devicetree/bindings/pinctrl/*

- 会进行一些健全性检查，确保一个引脚不能同时用于两个功能；

- 驱动可以选择实现引脚复用接口（pin multiplexing interface）或引脚配置接口（pin configuration interface），或两者都实现；

- gpio子系统会引用pinctrl子系统；

- struct pinctrl_desc用于表示一个pin控制器，可通过[devm_]pinctrl_register()将其注册进pinctrl子系统；

- 单板在启动时注册一堆的能自动激活引脚复用配置的行为被称为“pinmux hogs”；

- 类似regulator的get/enable/disable/put操作，pinctrl子系统提供出来的api也有get/enable/disable/put操作；

如何为一款CPU的添加pinctrl驱动：

1. 针对具体CPU构造struct gpio_chip，部分成员如下：

2. 向pinctrl子系统注册CPU的struct pinctrl_desc（devm_pinctrl_register()）；

二、分析全志H3的gpio和pinctrl功能

我们以全志H3芯片+Linux-4.14内核为例分析一下。对于H3+Linux-4.14，已经没有独立的drivers/gpio/gpio-*.c驱动，因为gpio驱动和pinctrl驱动有着紧密的联系，所以在pinctrl驱动里会同时向gpio子系统注册struct gpio_chip，所以对于H3，我们只要分析pinctrl驱动就够了。

(一) H3平台的gpio功能

device端（不同的板子各自决定自己该怎么配置引脚）：

arch/arm/boot/dts/sun8i-h3.dtsi

driver端（提供配置引脚的能力）：

drivers/pinctrl/sunxi/pinctrl-sun8i-h3.c

sun8i_h3_pinctrl_probe

    sunxi_pinctrl_init(pdev, &sun8i_h3_pinctrl_data);

        sunxi_pinctrl_init_with_variant(_dev, _desc, 0)

sun8i_h3_pinctrl_data的定义如下：

...，中间省略

正好对应芯片手册描述的PA组~PG组的引脚；

struct sunxi_desc_pin包含了1个struct pinctrl_pin_desc ( 所有pinctrl驱动通用 ) 变量和1个指向struct sunxi_desc_function ( sunxi pinctrl驱动自定义的 ) 数组的指针：

* struct pinctrl_pin_desc用于描述一个引脚，对于PA0引脚，成员number=0，成员name="PA0"，类似一个map（key=0，value="PA0"）；

* struct sunxi_desc_function用于描述一个引脚功能，对于PA0引脚，共有4个function（gpio_in、gpio_out、uart2[看来只是功能分组，并没有指定具体是哪一个引脚功能]、jtag），第一个function的muxval=0x0（寄存器里的偏移值），name="gpio_in";

向gpio子系统注册平台gpio驱动：

1. 初始化struct gpio_chip（abstract a GPIO controller）：

* pctl的类型为struct sunxi_pinctrl *pctl，它是pinctrl-sunxi.c大管家结构体（wrapper for holding driver data together，跟pinctrl-samsung.c里的struct samsung_pinctrl_drv_data类似），本驱动涉及的所有需要在不同函数间共享的数据都会保存在此大管家结构体内。

* pctl->chip就是struct gpio_chip。

2. 注册struct gpio_chip：

gpiochip_add_data(pctl->chip, pctl);

将H3的struct gpio_chip注册给gpio子系统后，内核就有了控制引脚的能力（设置输入输出、读写高低电平），但是还无法感知 CPU 有多少引脚可用。

3. 感知所有引脚：

如何通过gpio子系统读写gpio

1. 在device tree里选择要使用的gpio引脚

以gpio-leds驱动为例：

<&pio 0 10 GPIO_ACTIVE_HIGH>;对应引脚PA0。

2. 在驱动源码里使用gpio子系统提供的统一接口来控制gpio

以gpio-leds驱动为例：

* gpio子系统API的前缀都是gpiod_，完整的API位于：include/linux/gpio/consumer.h;

(二) H3平台的pinctrl功能

向pinctrl子系统注册平台pintrcl驱动：

1. 保存所有引脚的硬件信息：

只需保存引脚索引号即可，后面要配置引脚功能时，会通过大管家结构体struct sunxi_pinctrl *pctl找到struct sunxi_pinctrl_desc，然后根据引脚索引号获取到引脚的硬件信息。

2. 初始化struct pinctrl_desc（pin controller descriptor）：

1) struct pinconf_ops sunxi_pconf_ops，负责提供获取和设置引脚驱动能力、上下拉（pin configuration）的能力；

2) struct pinctrl_ops sunxi_pctrl_ops，不是必须的，各种杂活都在这里处理（解析设备树等，类似ioctl()）；

3) struct pinmux_ops sunxi_pmx_ops，负责提供获取和配置引脚（pin muxing）的能力；

3. 注册struct pinctrl_desc：

devm_pinctrl_register(&pdev->dev, pctrl_desc, pctl);

如何通过pinctrl子系统配置引脚

1. 在device tree里添加引脚配置节点：

以csi 相关的引脚配置为例：

PE0~PE11都被要求作为csi功能，在pinctrl-sun8i-h3.c中有填写csi功能对应的硬件配置信息：

一个“pin configuration node”必须被具体的驱动引用才能发挥作用：

2. 在每一个特定功能的驱动被probe时，它引用的引脚功能会得到初始化：

以csi控制器为例：

drivers/media/platform/sunxi/sun6i-csi/sun6i_csi.c

    really_probe

        pinctrl_bind_pins(dev);

            devm_pinctrl_get(dev);    // 通过pinctrl子系统 获取引脚

                sunxi_pctrl_dt_node_to_map

            pinctrl_select_state(); // 设置引脚功能

    sun6i_csi_probe

* pinctr里子系统API的前缀都是pinctrl_，完整的API位于：include/linux/pinctrl/consumer.h;

总结

引脚的配置是很常用的功能，内核对引脚管理的抽象却很值得我们学习。一般来说，引脚配置这种基础驱动是应该包含在芯片厂商编写的BSP里，板级定制只要掌握如何和pinctrl子系统和gpio子系统交互即可，但是当遇到bug时，请仔细分析芯片厂商提供的驱动代码，软硬件上任何细微的改动都可能导致意想不到的的问题。