6. Linux内核的gpiolib

一、Linux内核的gpiolib

1.1 gpiolib学习重点

• gpiolib的建立过程
• gpiolib的使用方法：申请、使用、释放
• gpiolib的架构：涉及那些目录的那些文件

1.2 gpiolib源码分析1-------gpiolib的建立过程

找到目标函数在arch/arm/mach-s5pv210/gpiolib.c ----> s5pv210_gpiolib_init

smdkc110_map_io();
	s5pv210_gpiolib_init();		这个函数就是gpiolib初始化的函数		

1.2.1 struct s3c_gpio_chip

• struct s3c_gpio_chip 是一个GPIO端口的抽象, 结构体的一个变量就可以完全描述一个IO端口。
• 端口和IO口是两个概念。

S5PV210有很多个IO口（160个左右），这些IO口首先被分成N个端口（port group），然后每个端口中又包含了M个IO口。
比如GPA0是一个端口，里面包含了8个IO口，一般记作：GPA0_0（或GPA0.0）、GPA0_1。
内核中为每个GPIO分配了一个编号，编号是一个数字（譬如一共有160个IO时编号就可以从1到160连续分布），编号可以让程序很方便的去识别每一个GPIO。

在终端中显示如下：
gpiochip112(112 对应base, 即当前端口GPA1的基地址)。端口分GPA0,GPA1,GPB

1.2.2 s5pv210_gpio_4bit

(1) s5pv210_gpio_4bit是一个结构体数组，数组中包含了很多个struct s3c_gpio_chip类型的变量。

1.2.2.1 S5PV210_GPA0宏

• S5PV210_GPA0宏的返回值就是GPA0端口的某一个IO口的编号值，传参就是这个IO口在GPA0端口中的局部编号。
• samsung_gpiolib_add_4bit_chips() 函数才是具体进行 gpiolib 注册的。这个函数接收的参数是当前文件中定义好的结构体数组 s5pv210_gpio_4bit（其实2个参数分别是数组名和数组元素个数）。这个数组中就包含了当前系统中所有IO端口的信息（这些信息包含：端口的名字、端口中所有GPIO的编号、端口操作寄存器组的虚拟地址基地址、端口中IO口的数量、端口上下拉等模式的配置函数、端口中的IO口换算其对应的中断号的函数）。

1.2.2.2 分析 S5PV210_GPIO_A1_START = S5PV210_GPIO_NEXT(S5PV210_GPIO_A0) 的值

1. 由宏定义：

//  kernel/arch/arm/mach-s5pv210/include/mach
#define S5PV210_GPIO_NEXT(__gpio) \
((__gpio##_START) + (__gpio##_NR) + CONFIG_S3C_GPIO_SPACE + 1)

2. 和其参数可得到这个宏定义其实为：

#define S5PV210_GPIO_NEXT(__gpio) \
((S5PV210_GPIO_A0_START) + (S5PV210_GPI
O_A0_NR) + CONFIG_S3C_GPIO_SPACE + 1)

3. 而 S5PV210_GPIO_A0_NR 的定义为：
   
4. 表示 A0 端口到底有多少个。
   CONFIG_S3C_GPIO_SPACE 前面有 CONFIG， 表明内核里面应该没有， 这是.config 文件中的

root@wwj:~/driver/kernel# vi .config

CONFIG_S3C_GPIO_SPACE=0

5. 所以：

#define S5PV210_GPIO_NEXT(__gpio) \
((__gpio##_START) + (__gpio##_NR) + CONFIG_S3C_GPIO_SPACE + 1)
= 0 + 8 + 0 + 1 = 9   (9+4+0+1=14)

6. 最后 +1 是为了在每个端口之间用一个空号隔开。
7. 在开发板中看到 gpiochip0 下来就是 gpiochip9->gpiochip14， 依次类推， 如下图：
   

1.2.3 samsung_gpiolib_add_4bit_chips(s5pv210_gpio_4bit, nr_chips)

• 路径:arch/arm/plat-samsung/gpiolib.c
• samsung_gpiolib_add_4bit_chips() 函数才是具体进行gpiolib注册的。这个函数接收的参数是当前文件中定义好的结构体数组。这个注册就是将封装的一个GPIO端口的所有信息的chip结构体变量挂接到内核gpiolib模块定义的一个gpio_desc数组中的某一个格子中（和前面两个不一样，这个不是三星工程师写的，这个是内核开发者写的； 驱动就是内核开发者写一部分，厂商驱动开发工程师写一部分）。
• 函数名中为什么有个4bit：三星的CPU中2440的CON寄存器是2bit对应一个IO口，而6410和210以及之后的系列中CON寄存器是4bit对应1个IO口。所以gpiolib在操作2440和210的CON寄存器时是不同的。
  函数调用关系：
  

1.2.3.1 samsung_gpiolib_add_4bit();

经过分析，发现内部其实并没有做gpiolib的注册工作，而是还在做填充，填充的是每一个GPIO被设置成输入模式/输出模式的操作方法。

1.2.3.2 s3c_gpiolib_add

• 首先检测并完善chip的direction_input/direction_ouput/set/get这4个方法
• 调用gpiochip_add方法进行真正的注册操作。其实这个注册就是将封装的一个GPIO端口的所有信息的chip结构体变量挂接到内核gpiolib模块定义的一个gpio_desc数组中的某一个格子中。
  

1.3 gpiolib源码分析2 ----- 内核开发者写的gpiolib框架部分

1.3.1 从驱动框架角度再来分析一下gpiolib

• 之前的分析已经搞清楚了gpiolib的建立过程。但是这只是整个gpiolib建立的一部分，是厂商驱动工程师负责的那一部分；还有另一部分是内核开发者提供的驱动框架，就是后面要去分析的第2部分。
• drivers/gpio/gpiolib.c 这个文件中所有的函数构成了第2部分，也就是内核开发者写的gpiolib框架部分。这个文件中提供的函数主要有以下部分：

函数接口	函数的作用
gpiochip_add()	是框架开出来的接口，给厂商驱动工程师用，用于向内核注册我们的gpiolib
gpio_request()	是框架开出来的接口，给使用gpiolib来编写自己的驱动的驱动工程师用的，驱动中要想使用某一个gpio，就必须先调用gpio_request接口来向内核的gpiolib部分申请，得到允许后才可以去使用这个gpio
gpio_free()	对应gpio_request，用来释放申请后用完了的gpio
gpio_request_one()/gpio_request_array()	这两个是gpio_request的变种
gpiochip_is_requested()	接口用来判断某一个gpio是否已经被申请了
gpio_direction_input()/gpio_direction_output()	接口用来设置GPIO为输入/输出模式，注意该函数内部实际并没有对硬件进行操作，只是通过chip结构体变量的函数指针调用了将来SoC厂商的驱动工程师写的真正的操作硬件实现gpio设置成输出模式的那个函数

以上的接口属于一类，这些都是给写其他驱动并且用到了gpiolib的人使用的。剩下的还有另外一类函数，这类函数是gpiolib内部自己的一些功能实现的代码。

2. gpiolib的attribute部分

• CONFIG_GPIO_SYSFS
• GPIO的attribute演示
  
  gpiolib_sysfs_init //调用 class_create 创建类
  gpiochip_export //调用 device_create 创建设备
  sysfs_create_group //在 devices 目录下创建好多个 attribute

1.4 使用gpiolib完成led驱动

1. 流程分析

• 第1步：使用gpio_request申请要使用的一个GPIO
• 第2步：gpio_direction_input/gpio_direction_output 设置输入/输出模式
• 第3步：设置输出值gpio_set_value 获取IO口值gpio_get_value

2. 代码实践

#include <linux/module.h>		// module_init  module_exit
#include <linux/init.h>			// __init   __exit
#include <linux/fs.h>
#include <linux/leds.h>
#include <mach/regs-gpio.h>
#include <mach/gpio-bank.h>
#include <linux/io.h>
#include <linux/ioport.h>
#include <mach/gpio.h>


#define GPIO_LED1	S5PV210_GPJ0(3)
#define GPIO_LED2	S5PV210_GPJ0(4)
#define GPIO_LED3	S5PV210_GPJ0(5)

#define X210_LED_OFF	    1			// X210中LED是正极接电源，负极节GPIO
#define X210_LED_ON		0			// 所以1是灭，0是亮


static struct led_classdev mydev1;			// 定义结构体变量
static struct led_classdev mydev2;			// 定义结构体变量
static struct led_classdev mydev3;			// 定义结构体变量

// 这个函数就是要去完成具体的硬件读写任务的
static void s5pv210_led1_set(struct led_classdev *led_cdev,
			    enum led_brightness value)
{
	printk(KERN_INFO "s5pv210_led1_set\n");
		
	// 在这里根据用户设置的值来操作硬件
	// 用户设置的值就是value
	if (value == LED_OFF)
	{
		gpio_set_value(GPIO_LED1, X210_LED_OFF);
	}
	else
	{
		gpio_set_value(GPIO_LED1, X210_LED_ON);
	}
}

static void s5pv210_led2_set(struct led_classdev *led_cdev,
			    enum led_brightness value)
{
	printk(KERN_INFO "s5pv2102_led_set\n");
	
	if (value == LED_OFF)
	{
		gpio_set_value(GPIO_LED2, X210_LED_OFF);
	}
	else
	{
		gpio_set_value(GPIO_LED2, X210_LED_ON);
	}
}

static void s5pv210_led3_set(struct led_classdev *led_cdev,
			    enum led_brightness value)
{
	printk(KERN_INFO "s5pv210_led3_set\n");
	if (value == LED_OFF)
	{
		gpio_set_value(GPIO_LED3, X210_LED_OFF);
	}
	else
	{
		gpio_set_value(GPIO_LED3, X210_LED_ON);
	}
}

static int __init s5pv210_led_init(void)
{
	// 用户insmod安装驱动模块时会调用该函数
	// 该函数的主要任务就是去使用led驱动框架提供的设备注册函数来注册一个设备
	int ret = -1;
	
	// 在这里去申请驱动用到的各种资源，当前驱动中就是GPIO资源
	if (gpio_request(GPIO_LED1, "led1_gpj0.3")) 
	{
		printk(KERN_ERR "gpio_request failed\n");
	} 
	else 
	{
		// 设置为输出模式，并且默认输出1让LED灯灭
		gpio_direction_output(GPIO_LED1, 1);
	}

	// led1
	mydev1.name = "led1";
	mydev1.brightness = 0;	
	mydev1.brightness_set = s5pv210_led1_set;
	
	ret = led_classdev_register(NULL, &mydev1);
	if (ret < 0) {
		printk(KERN_ERR "led_classdev_register failed\n");
		return ret;
	}
	
	// led2
	mydev2.name = "led2";
	mydev2.brightness = 0;	
	mydev2.brightness_set = s5pv210_led2_set;
	
	ret = led_classdev_register(NULL, &mydev2);
	if (ret < 0) {
		printk(KERN_ERR "led_classdev_register failed\n");
		return ret;
	}
	
	// led3
	mydev3.name = "led3";
	mydev3.brightness = 0;	
	mydev3.brightness_set = s5pv210_led3_set;
	
	ret = led_classdev_register(NULL, &mydev3);
	if (ret < 0) {
		printk(KERN_ERR "led_classdev_register failed\n");
		return ret;
	}
	
	return 0;
}

static void __exit s5pv210_led_exit(void)
{
	led_classdev_unregister(&mydev1);
	led_classdev_unregister(&mydev2);
	led_classdev_unregister(&mydev3);
	
	gpio_free(GPIO_LED1);
}

module_init(s5pv210_led_init);
module_exit(s5pv210_led_exit);

// MODULE_xxx这种宏作用是用来添加模块描述信息
MODULE_LICENSE("GPL");							// 描述模块的许可证
MODULE_AUTHOR("aston <1264671872@qq.com>");		// 描述模块的作者
MODULE_DESCRIPTION("s5pv210 led driver");		// 描述模块的介绍信息
MODULE_ALIAS("s5pv210_led");					// 描述模块的别名信息

linux中查看gpio使用情况的方法

内核中提供了虚拟文件系统debugfs，里面有一个gpio文件，提供了gpio的使用信息。
使用方法：mount -t debugfs debugfs /tmp，然后cat /tmp/gpio即可得到gpio的所有信息，使用完后umount /tmp卸载掉debugfs

1.5 将驱动添加到内核中

1.5.1 驱动的存在形式

• “野生”，优势是方便调试开发，所以在开发阶段都是这种
• ”家养“，优势可以在内核配置时make menuconfig决定内核怎么编译，方便集成

1.5.2 驱动开发的一般步骤

• 以模块的形式在外部编写、调试
• 将调试好的驱动代码集成到kernel中

1.5.3 实践验证

• 关键点：Kconfig、Makefile、make menuconfig
• 操作步骤：
  第1步：将写好的驱动源文件放入内核源码中正确的目录下
  第2步：在Makefile中添加相应的依赖
  
  第3步：在Kconfig中添加相应的配置项
  第4步：make menuconfig
• 重新启动验证