pinctrl與gpio子系統下的字符設備驅動框架

點亮Linux驅動開發路上的第一個燈一文中將與外設有關的寄存器信息，定義到驅動代碼中，直接操作寄存器來控制外設。缺點是當芯片的寄存器發了變動，就要對底層的驅動進行重寫。

設備樹下的字符設備驅動框架一文中將與外設有關的寄存器信息，寫到了設備樹文件中，通過設備樹API函數獲取外設信息。當外設的信息有變化時，只需要修改設備樹文件即可，無需修改底層驅動，提高了驅動代碼的復用能力，但仍需要直接操作寄存器來控制外設。

本文介紹的pinctrl和gpio子系統實現了對寄存器的操作，我們只需要使用子系統提供的API函數即可，而無需再直接操作寄存器了。

1. pinctrl與gpio子系統介紹

1.1 pinctrl子系統

pinctrl子系統就是管理PIN引腳的一個系統，在設備樹里設置PIN的配置信息，pinctrl會根據提供的信息來配置PIN功能。其主要工作內容如下：

• 獲取設備樹中的PIN信息
• 設置獲取到的PIN的復用功能
• 設置獲取到的PIN的電氣特性

打開設備樹文件imx6ull-andyxi-emmc.dts，其中iomuxc節點就是I.MX6ULL的外設節點。代碼中的pinctrl_hog_1子節點就是和熱插拔有關的PIN集合

&iomuxc {
    pinctrl-names = "default";
    pinctrl-0 = <&pinctrl_hog_1>;
    imx6ul-evk {
        pinctrl_hog_1: hoggrp-1 {
            fsl,pins = <
                MX6UL_PAD_UART1_RTS_B__GPIO1_IO19        0x17059 
                MX6UL_PAD_GPIO1_IO05__USDHC1_VSELECT     0x17059 
                MX6UL_PAD_GPIO1_IO09__GPIO1_IO09         0x17059 
                MX6UL_PAD_GPIO1_IO00__ANATOP_OTG1_ID     0x13058
           >;
        };
        ......
    };
};

下面以UART1_RTS_B這個PIN為例，介紹如何添加PIN的配置信息：

MX6UL_PAD_UART1_RTS_B__GPIO1_IO19     0x17059

前半部分：設置UART1_RTS_B引腳的復用功能

//MX6UL_PAD_UART1_RTS_B__GPIO1_IO19宏定義在文件arch/arm/boot/dts/imx6ul-pinfunc.h中
#define MX6UL_PAD_UART1_RTS_B__UART1_DCE_RTS          0x0090 0x031C 0x0620 0x0 0x3
#define MX6UL_PAD_UART1_RTS_B__UART1_DTE_CTS          0x0090 0x031C 0x0000 0x0 0x0
#define MX6UL_PAD_UART1_RTS_B__ENET1_TX_ER            0x0090 0x031C 0x0000 0x1 0x0
#define MX6UL_PAD_UART1_RTS_B__USDHC1_CD_B            0x0090 0x031C 0x0668 0x2 0x1
#define MX6UL_PAD_UART1_RTS_B__CSI_DATA05             0x0090 0x031C 0x04CC 0x3 0x1
#define MX6UL_PAD_UART1_RTS_B__ENET2_1588_EVENT1_OUT  0x0090 0x031C 0x0000 0x4 0x0
#define MX6UL_PAD_UART1_RTS_B__GPIO1_IO19             0x0090 0x031C 0x0000 0x5 0x0
#define MX6UL_PAD_UART1_RTS_B__USDHC2_CD_B            0x0090 0x031C 0x0674 0x8 0x2

上面代碼中共有8個UART1_RTS_B引腳的宏定義，分別對應該引腳的8個復用IO。宏定義的值，被分為了5段，每段的值都有具體的含義：

• mux_reg：mux_reg寄存器偏移地址 (見下圖1)
• conf_reg：conf_reg寄存器偏移地址 (見下圖2)
• input_reg：input_reg寄存器偏移地址 (此處無效)
• mux_mode：mux_reg寄存器的值，用于設置復用功能 (見下圖3)
• input_val：input_reg寄存器值 (此處無效)

后半部分：此值就是conf_reg寄存器的值，用于設置UART1_RTS_B引腳的電氣特性

1.2 gpio子系統

gpio子系統就是管理gpio功能的一個系統，其作用是初始化gpio，并提供對外的API接口。使用gpio子系統后，就無需自己操作寄存器，通過調用相關API函數即可實現對gpio的控制。

仍以熱插拔節點為例，pinctrl子系統已經將UART1_RTS_B復用為GPIO1_IO19，并設置好了電氣屬性。驅動程序通過讀取其高低電平來判斷SD卡有沒有插入。

那驅動程序怎么知道CD引腳連接的是GPIO1_IO19呢 ？這就需要設備樹來告訴驅動了，在設備樹的SD卡節點下添加一個描述CD引腳的屬性：

&usdhc1 {
    pinctrl-names = "default", "state_100mhz", "state_200mhz";
    pinctrl-0 = <&pinctrl_usdhc1>;
    pinctrl-1 = <&pinctrl_usdhc1_100mhz>;
    pinctrl-2 = <&pinctrl_usdhc1_200mhz>;
    pinctrl-3 = <&pinctrl_hog_1>;
    cd-gpios = <&gpio1 19 GPIO_ACTIVE_LOW>;
    keep-power-in-suspend;
    enable-sdio-wakeup;
    vmmc-supply = <®_sd1_vmmc>;
    status = "okay";
};

上面代碼中pinctrl-3指定了CD引腳的pinctrl信息，cd-gpios屬性描述了CD引腳使用哪個IO，屬性值共有三個，具體含義如下：

• &gpio1 表示CD引腳所使用的IO屬于GPIO1組
• 19 表示GPIO1組的第19號IO
• GPIO_ACTIVE_LOW 表示低電平有效

設置好設備樹后就可使用gpio子系統提供的API函數來操作指定的GPIO，gpio子系統向開發人員屏蔽了具體的讀寫寄存器過程。下圖中有常用的API函數介，此外還有pinctrl和gpio子系統的使用模板：

**2. **pinctrl與gpio子系統字符設備驅動框架

下圖為pinctrl與gpio子系統下的字符設備驅動框架：

接下來根據上面的框架圖，以驅動LED (GPIO1_IO03) 為例，分步介紹具體的代碼編寫流程

2.1 修改設備樹文件

添加pinctrl節點：在iomuxc節點的imx6ul-evk子節點下創建pinctrl_led節點，復用GPIO1_IO03

pinctrl_led: ledgrp {
    fsl,pins = <
        MX6UL_PAD_GPIO1_IO03__GPIO1_IO03    0x10B0
    >;
};
//MX6UL_PAD_GPIO1_IO03__GPIO1_IO03 復用GPIO1_IO03
//0x10B0 設置pin的電氣特性

添加LED設備節點：在根節點下創建LED設備節點，指定對應的pinctrl節點，指定所使用的GPIO

gpioled {
    #address-cells = <1>;
    #size-cells = <1>;
    compatible = "alpha-gpioled";
    pinctrl-names = "default";
    pinctrl-0 = <&pinctrl_led>;
    led-gpio = <&gpio1 3 GPIO_ACTIVE_LOW>;
    status = "okay";
};

檢查PIN是否沖突：檢查pinctrl和設備節點中指定的引腳有沒有被別的外設占用

//檢查GPIO_IO03這個PIN有沒有被其他的pinctrl節點使用
pinctrl_tsc: tscgrp {
    fsl,pins = <
        MX6UL_PAD_GPIO1_IO01__GPIO1_IO01 0xb0
        MX6UL_PAD_GPIO1_IO02__GPIO1_IO02 0xb0
        //GPIO_IO03被pinctrl_tsc節點占用，因此需要屏蔽掉
        /* MX6UL_PAD_GPIO1_IO03__GPIO1_IO03 0xb0 */ 
        MX6UL_PAD_GPIO1_IO04__GPIO1_IO04 0xb0
    >;
};

//檢查"gpio1 3"有沒有被其他設備節點占用
&tsc {
    pinctrl-names = "default";
    pinctrl-0 = <&pinctrl_tsc>;
    //"gpio1 3"被tsc設備節點占用，因此需要屏蔽掉
    /* xnur-gpio = <&gpio1 3 GPIO_ACTIVE_LOW>; */
    measure-delay-time = <0xffff>;
    pre-charge-time = <0xfff>;
    status = "okay";
};

編譯設備樹：使用make dtbs命令編譯設備樹，并使用該設備樹啟動Linux系統

#在內核根目錄下
make dtbs                #編譯設備樹
#啟動Linux系統后
cd /proc/device-tree     #查看"gpioled"節點是否存在

2.2 編寫驅動程序

創建驅動程序文件gpioled.c，添加如下代碼

宏定義及設備結構體定義

struct gpioled_dev{
    dev_t devid;                //設備號
    struct cdev cdev;           //cdev字符設備
    struct class *class;        //類
    struct device *device;      //設備
    int major;                  //主設備號
    int minor;                  //次設備號
    struct device_node *nd;     //設備節點
    int led_gpio;               //所使用的gpio編號
};

struct gpioled_dev gpioled;     //定義led設備

編寫設備操作函數：write函數中，直接使用gpio子系統提供的API函數操作GPIO

static ssize_t led_write(struct file *filp, char __user *buf, size_t cnt, loff_t *offt){
    int retvalue;
    unsigned char databuf[1];
    unsigned char ledstat;
    struct gpioled_dev *dev = filp->private_data;
    retvalue = copy_from_user(databuf, buf, cnt); 
    if(retvalue < 0){
        printk("kernel write failed!\\r\\n");
        return -EFAULT;
    }

    ledstat = databuf[0];
    if(ledstat == LEDON){
        gpio_set_value(dev->led_gpio, 0);
    }else if(ledstat == LEDOFF){
        gpio_set_value(dev->led_gpio, 1);
    }
    return 0;
}

驅動入口函數中：獲取GPIO編號后初始化

/* 設置 LED 所使用的 GPIO */
/* 1、獲取設備節點：gpioled */
gpioled.nd = of_find_node_by_path("/gpioled");
if(gpioled.nd == NULL) {
    printk("gpioled node cant not found!\\r\\n");
    return -EINVAL;
} else {
    printk("gpioled node has been found!\\r\\n");
}
/* 2、 獲取設備樹中的 gpio 屬性，得到 LED 所使用的 LED 編號 */
gpioled.led_gpio = of_get_named_gpio(gpioled.nd, "led-gpio", 0);
if(gpioled.led_gpio < 0) {
    printk("can't get led-gpio");
    return -EINVAL;
}
printk("led-gpio num = %d\\r\\n", gpioled.led_gpio);
/* 3、設置 GPIO1_IO03 為輸出，并且輸出高電平，默認關閉 LED 燈 */
ret = gpio_direction_output(gpioled.led_gpio, 1);
if(ret < 0) {
    printk("can't set gpio!\\r\\n");
}

驅動入口函數中：注冊字符設備驅動，代碼與Linux點燈中一樣

驅動出口函數中：注銷設備驅動，刪除類和設備，代碼可參考Linux點燈一文

2.3 編寫測試程序

實現操作驅動文件對外設進行控制的功能。創建測試程序文件gpioledApp.c，代碼內容與Linux點燈一文中的測試程序代碼一致，此處不再贅述

2.4 編譯測試

編譯驅動程序：當前目錄下創建Makefile文件，并make編譯

KERNELDIR := /home/andyxi/linux/kernel/linux-imx-rel_imx_4.1.15_2.1.0_ga_andyxi
CURRENT_PATH := $(shell pwd)
obj-m := gpioled.o

build: kernel_modules

kernel_modules:
$(MAKE) -C $(KERNELDIR) M=$(CURRENT_PATH) modules
clean:
$(MAKE) -C $(KERNELDIR) M=$(CURRENT_PATH) clean

編譯測試程序：無需內核參與，直接編譯即可

arm-linux-gnueabihf-gcc gpioledApp.c -o gpioledApp

運行測試：啟動開發板后，加載驅動模塊，之后使用應用程序測試驅動是否正常工作

depmod                         #第一次加載驅動的時候需要運行此命令
modprobe gpioled.ko            #加載驅動
./gpioledApp /dev/gpioled 1    #打開LED燈
./gpioledApp /dev/gpioled 0    #關閉LED燈
rmmod gpioled.ko               #卸載驅動模塊