本文目錄：

一、gpio與pinctrl
二、內核里如何引用gpio
三、gpio子系統框架
四、應用層如何訪問gpio

一、gpio 與 pinctrl

本文主要關注 gpio 子系統，但是老吳認為必要先說明一下 pinctrl 子系統和 gpio 子系統的之間關系。

pinctrl 的作用：

• 引腳復用，例如某個引腳即可用作為普通的gpio，也可以作為UART的TX;
• 引腳配置，一般包括上下拉、驅動能力等；

gpio 的作用：

• 作為輸入功能時，支持讀引腳值;
• 作為輸出功能時，支持輸出高低電平；
• 部分 gpio 還負責接收中斷；

gpio 的使用依賴于 pinctrl：

本文的關注點是 gpio driver --> gpio subsystem core -> gpio consumer 這一路徑，讀者如果想更深入地了解 pinctrl 子系統.

gpio 子系統內核文檔：

Documentation/driver-api/gpio：

注：本文基于 Linux-4.19。

二、內核里如何引用 gpio

2 個步驟：

1) 設備樹里添加 gpio mappings

示例：

foo_device {
    compatible = "packt,gpio-descriptor-sample";
    led-gpios = <&gpio2 15 GPIO_ACTIVE_HIGH>, // red 
                <&gpio2 16 GPIO_ACTIVE_HIGH>, // green 

    btn1-gpios = <&gpio2 1 GPIO_ACTIVE_LOW>;
    btn2-gpios = <&gpio2 1 GPIO_ACTIVE_LOW>;
};

要點：

• 屬性-gpios里的由使用者自行決定的， 例如上述例子中的為 led，在 gpio consumer driver 里可以通過 "led" 這個字符串，配合偏移值來獲取這一組 gpio 里的任一 gpio。

• 至于如何標志是硬件上的哪一個引腳，是由平臺相關的 gpio controller driver 的設備樹節點里的#gpio-cells的值來決定，上述例子中需要 2個參數才能確定硬件引腳，所以#gpio-cells = 2。

2) 在 gpio consumer driver 中引用

目前 gpio subsystem 提供了 2 套接口:

• legacy API：integer-based GPIO interface，形式為 gpio_xxx()，例如void gpio_set_value(unsigned gpio, int value)，不推薦使用該 API;

• 推薦 API: descriptor-based GPIO interface，形式為 gpiod_xxx()，例如void gpiod_set_value(struct gpio_desc *desc, int value)，新添加的驅動代碼一律采用這套 API。

示例：

staticstructgpio_desc*red,*green,*btn1,*btn2;staticintirq;

staticirqreturn_tbtn1_pushed_irq_handler(intirq,void*dev_id)
{
intstate;

/*readthebuttonvalueandchangetheledstate*/
state=gpiod_get_value(btn2);
gpiod_set_value(red,state);
gpiod_set_value(green,state);

pr_info("btn1interrupt:Interrupt!btn2stateis%d)
",state);
returnIRQ_HANDLED;
}

staticconststructof_device_idgpiod_dt_ids[]={
{.compatible="gpio-descriptor-sample",},
};


staticintmy_pdrv_probe(structplatform_device*pdev)
{
intretval;
structdevice*dev=&pdev->dev;

//獲得gpiodescriptor的同時也將其設置為output，并且輸出低電平
red=gpiod_get_index(dev,"led",0,GPIOD_OUT_LOW);
green=gpiod_get_index(dev,"led",1,GPIOD_OUT_LOW);

btn1=gpiod_get(dev,"btn1",GPIOD_IN);
btn2=gpiod_get(dev,"btn2",GPIOD_IN);

//獲得中斷號
irq=gpiod_to_irq(btn1);

//申請中斷
retval=request_threaded_irq(irq,NULL,
btn1_pushed_irq_handler,
IRQF_TRIGGER_LOW|IRQF_ONESHOT,
"gpio-descriptor-sample",NULL);
pr_info("Hello!deviceprobed!
");
return0;
}

staticintmy_pdrv_remove(structplatform_device*pdev)
{
free_irq(irq,NULL);

//釋放gpio
gpiod_put(red);
gpiod_put(green);
gpiod_put(btn1);
gpiod_put(btn2);
pr_info("goodbyereader!
");
return0;
}

staticstructplatform_drivermypdrv={
.probe=my_pdrv_probe,
.remove=my_pdrv_remove,
.driver={
.name="gpio_descriptor_sample",
.of_match_table=of_match_ptr(gpiod_dt_ids),
.owner=THIS_MODULE,
},
};
module_platform_driver(mypdrv);

gpiod_xxx() API

在 gpio 子系統中，用 struct gpio_desc 來描述一個 gpio 引腳，gpiod_xxx() 都是圍繞著 strcut gpio_desc 進行操作的。

完整的接口定義位于 linux/gpio/consumer.h，大約共有 70個 API。

常用 API：

• 獲得/釋放 一個或者一組 gpio：

  • [devm]_gpiod_get*()
  • [devm]_gpiod_put*()

• 設置/查詢 輸入或者輸出

  • gpiod_direction_input()
  • gpiod_direction_output()
  • gpiod_get_direction()

• 讀寫一個 gpio

  • gpiod_get_value()
  • gpiod_set_value()
  • gpiod_get_value_cansleep()
  • gpiod_set_value_cansleep()

• 讀寫一組 gpio

  • gpiod_get_array_value()
  • gpiod_set_array_value()

• 獲得 gpio 對應的中斷號

  • gpiod_to_irq()

相關要點：

• 以 _cansleep 為后綴的函數是可能會睡眠的 API，不可以在 hard (non-threaded) IRQ handlers 中使用;

• gpiod_get_value() 返回的是硬件上的電平值;

• gpiod_set_value() 設置的值是邏輯值而非電平值，1 表示使能，0 表示不使能，由設備樹里的 gpio mappings 里的 GPIO_ACTIVE_XXX 來決定哪個電平值是有效的，總結如下：

三、gpio 子系統框架

1. 整體框架

正常情況下，驅動工程師不需要了解 gpio chip driver 和 gpiolib：

• 驅動工程師負責編寫 gpio consumer drvier;

• 芯片廠商的 bsp 工程師負責編寫 gpio chip driver;

• 開源社區里的大牛負責 gpiolib 的核心實現;

但是當功能和預期的不一樣時，為了調試定位出問題，這時就有必要弄清楚 gpio chip driver 和 gpiolib 的工作流程。

2. gpiolib

作用：

• 向下為 gpio chip driver 提供注冊 struct gpio_chip 的接口：gpiochip_xxx();

• 向上為 gpio consumer 提供引用 gpio 的接口：gpiod_xxx();

• 實現字符設備的功能;

• 注冊 sysfs;

源碼：

$cdlinux-4_19/drivers/gpio$lsgpiolib*-1X
gpiolib-acpi.c//ACPIhelpersforGPIOAPI
gpiolib.c//GPIOsubsystemcore
gpiolib-devprop.c//DevicepropertyhelpersforGPIOchips.
gpiolib-legacy.c
gpiolib-of.c//OFhelpersfortheGPIOAPI
gpiolib-sysfs.c//sysfshelpers
gpiolib.h

int gpiochip_add(struct gpio_chip *chip)

這是 bsp 工程師比較關心的 api。

在 gpio 子系統中，SoC 上的每一個 gpio bank 都會被認為是一個 gpio controller，每一個 gpio controller 都由一個 struct gpio_chip 來描述，bsp 工程師的核心工作就是填充該結構體。

struct gpio_chip 比較龐大，但是我們只需要關注跟硬件聯系比較緊密的成員就好：

• .set()，輸出電平
• .get()，獲得電平
• .get_direction()，獲得方向
• .direction_input()，設置為輸入
• .direction_output()，設置為輸出
• .to_irq()，獲得中斷號

3. gpio chip driver

最簡單的 demo：

#defineGPIO_NUM16staticstructgpio_chipchip;staticintfake_get_value(structgpio_chip*gc,unsignedoffset)
{
return0;
}

staticvoidfake_set_value(structgpio_chip*gc,unsignedoffset,intval)
{
}

staticintfake_direction_output(structgpio_chip*gc,unsignedoffset,intval)
{
return0;
}

staticintfake_direction_input(structgpio_chip*gc,unsignedoffset)
{
return0;
}

staticconststructof_device_idfake_gpiochip_ids[]={
{.compatible="fake-gpio-chip",},
};

staticintmy_pdrv_probe(structplatform_device*pdev)
{
chip.label=pdev->name;
chip.base=-1;
chip.dev=&pdev->dev;
chip.owner=THIS_MODULE;
chip.ngpio=GPIO_NUM;
chip.can_sleep=1;
chip.get=fake_get_value;
chip.set=fake_set_value;
chip.direction_output=fake_direction_output;
chip.direction_input=fake_direction_input;

returngpiochip_add(&chip);
}

staticintmy_pdrv_remove(structplatform_device*pdev)
{
gpiochip_remove(&chip);
return0;
}

staticstructplatform_drivermypdrv={
.probe=my_pdrv_probe,
.remove=my_pdrv_remove,
.driver={
.name="fake-gpio-chip",
.of_match_table=of_match_ptr(fake_gpiochip_ids),
.owner=THIS_MODULE,
},
};
module_platform_driver(mypdrv);

RK3399 實例分析

1) 設備樹

gpio0: gpio0@ff720000 {
    compatible = "rockchip,gpio-bank";
    reg = <0x0 0xff720000 0x0 0x100>;
    clocks = <&pmucru PCLK_GPIO0_PMU>;
    interrupts = ;

    gpio-controller;
    #gpio-cells = <0x2>;

    interrupt-controller;
    #interrupt-cells = <0x2>;
};
...
gpio4: gpio4@ff790000 {
    ...
}

一共定義了 5 個 gpio-controller 節點，對應芯片上的 5 個 gpio bank。

里面用于表明寄存器地址 和 clock 等屬性會在 gpio chip driver 中被使用。

2) chip driver

這里只關心程序主干，不關心芯片廠商為了適應多款芯片而封裝的代碼。

gpio_chip 的注冊過程：

drivers/pinctrl/pinctrl-rockchip.c

rockchip_pinctrl_probe(){
//rockchip用于管理gpio/pinctrl大管家結構體
structrockchip_pinctrl*info=devm_kzalloc()

//rk3399gpiobank相關的硬件描述信息
structrockchip_pin_ctrl*ctrl=&rk3399_pin_ctrl;

info->ctrl=ctrl;

rockchip_gpiolib_register(pdev,info);{
structgpio_chip*gc;

for(i=0;inr_banks;++i,++bank){
//初始化gpio_chip
gc=&rockchip_gpiolib_chip;
gc->base=bank->pin_base;
gc->ngpio=bank->nr_pins;

//注冊gpio_chip
gpiochip_add_data(gc,bank);
}
}
}

struct gpio_chip 的定義：

staticconststructgpio_chiprockchip_gpiolib_chip={
.request=gpiochip_generic_request,
.free=gpiochip_generic_free,
.set=rockchip_gpio_set,
.get=rockchip_gpio_get,
.get_direction=rockchip_gpio_get_direction,
.direction_input=rockchip_gpio_direction_input,
.direction_output=rockchip_gpio_direction_output,
.set_config=rockchip_gpio_set_config,
.to_irq=rockchip_gpio_to_irq,
.owner=THIS_MODULE,
};

這些函數都是在操作 rk3399 gpio 相關的寄存器，實現一個 gpio chip driver 本質上就是實現上面一系列的硬件操作函數。

四、應用層如何訪問 gpio

1. /dev/gpiochipX

直接操作字符設備是比較低效率的，內核里提供了一些 demo：

$cdlinux-4_19/tools/gpio
$ls
Makefile
gpio-event-mon.c
gpio-hammer.c
gpio-utils.c
lsgpio.c
gpio-utils.h
$makeARCH=arm64CROSS_COMPILE=aarch64-linux-

具體的代碼請各位自行閱讀吧。

2. libgpiod

libgpiod 是一個用 C 語言編寫的用于訪問 gpio chardev 的庫，同時里面包含了一些訪問 gpio 的命令行工具，推薦優先采用這個庫來訪問 gpio。

編譯：

$gitclonehttps://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git-bv1.6.x
$./autogen.sh--enable-tools=yes
$make&&makeinstall
$ldconfig

附帶的幾個命令行工具：

• gpiodetect – list all gpiochips present on the system, their names, labels and number of GPIO lines

• gpioinfo – list all lines of specified gpiochips, their names, consumers, direction, active state and additional flags

• gpioget – read values of specified GPIO lines

• gpioset – set values of specified GPIO lines, potentially keep the lines exported and wait until timeout, user input or signal

• gpiofind – find the gpiochip name and line offset given the line name

• gpiomon – wait for events on GPIO lines, specify which events to watch, how many events to process before exiting or if the events should be reported to the console

$gpiodetect
gpiochip0[gpio0](32lines)
gpiochip1[gpio1](32lines)
gpiochip2[gpio2](32lines)
gpiochip3[gpio3](32lines)
gpiochip4[gpio4](32lines)

$gpioinfogpio0
gpiochip0-32lines:
line0:unnamedunusedinputactive-high
line1:unnamed"vcc_sd"outputactive-high[used]
line2:unnamedunusedinputactive-high
line3:unnamedunusedinputactive-high
line4:unnamed"bt_default_wake_host"inputactive-high[used]
line5:unnamed"GPIOKeyPower"inputactive-low[used]
...
line13:unnamed"status_led"outputactive-high[used]
...
line30:unnamedunusedinputactive-high
line31:unnamedunusedinputactive-high

3. sysfs

過時的接口，不推薦使用，用法如下：

$echo25>/sys/class/gpio/export
$echoout>/sys/class/gpio/gpio25/direction
$echo1>/sys/class/gpio/gpio25/valuesh