標準linux4.4--驅動開發(二)GPIO驅動編寫

簡介

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_PINCTRL
	struct dev_pin_info	*pins;
	#endif
	//...
};
struct dev_pin_info {
    	struct pinctrl *p;
    	struct pinctrl_state *default_state;
#ifdef CONFIG_PM
   	struct 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 所做事情更多,浪費。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章