设备树下的 platform 驱动开发框架

1. 设备树下的platform驱动开发

platform驱动框架分为总线、设备和驱动，其中总线是由Linux内核提供，在编写驱动时只要关注于设备和驱动的具体实现即可。Linux下的platform驱动开发模板一文中介绍了没有设备树的情况，需要分别编写并注册platform设备和platform驱动。而在使用设备树的时候，设备的描述被放到了设备树中，因此只需要实现platform_driver即可

本文将介绍如何在设备树下编写platform驱动，编写框架如下图示：

2. 程序编写

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 用于设置pin的复用功能
//0x10B0 用于设置pin的电气特性

• 添加LED设备节点：在根节点下创建LED设备节点，设置PIN对应的pinctrl节点，指定所使用的的GPIO

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

• 检查PIN是否冲突：检查pinctrl中设置以及设备节点中指定的引脚有没有被别的外设使用

2.2 驱动程序编写

platform驱动框架如下图示，按照下面步骤编写程序

新建 dtsleddriver.c 驱动文件，并输入如下内容

• 宏定义以及设备结构体定义

#define LEDDEV_CNT 1 				/* 设备号长度 */
#define LEDDEV_NAME "dtsplatled" 	/* 设备名字 */
#define LEDOFF 0
#define LEDON 1

/* leddev 设备结构体 */
struct leddev_dev{
	dev_t devid; 				//设备号
	struct cdev cdev; 			//cdev 
	struct class *class; 		//类 
	struct device *device; 		//设备 
	int major; 					//主设备号 
	struct device_node *node; 	//LED 设备节点 
	int led0; 					//LED 灯 GPIO 标号 
};
struct leddev_dev leddev; 		//led设备

• 编写设备操作函数集

/* LED 打开或关闭 */
void led0_switch(u8 sta) {
	if (sta == LEDON )
		gpio_set_value(leddev.led0, 0);
	else if (sta == LEDOFF)
		gpio_set_value(leddev.led0, 1);
}
/* 打开设备 */
static int led_open(struct inode *inode, struct file *filp) {
	filp->private_data = &leddev; 		//设置私有数据 
	return 0;
}
/* 向设备写数据 */
static ssize_t led_write(struct file *filp, const char __user *buf, size_t cnt, loff_t *offt) {
	int retvalue;
	unsigned char databuf[2];
	unsigned char ledstat;

	retvalue = copy_from_user(databuf, buf, cnt);
	if(retvalue < 0) {
		printk("kernel write failed!\r\n");
		return -EFAULT;
	}

	ledstat = databuf[0];
	if (ledstat == LEDON) {
		led0_switch(LEDON);
	} else if (ledstat == LEDOFF) {
		led0_switch(LEDOFF);
	}
	return 0;
}
/* 设备操作函数 */
static struct file_operations led_fops = {
	.owner = THIS_MODULE,
	.open = led_open,
	.write = led_write,
};

• probe函数中，完成IO初始化，注册字符设备

/* platform 驱动的 probe 函数 */
static int led_probe(struct platform_device *dev) {
	printk("led driver and device was matched!\r\n");
	/* 1、设置设备号 */
	if (leddev.major) {
		leddev.devid = MKDEV(leddev.major, 0);
		register_chrdev_region(leddev.devid, LEDDEV_CNT,LEDDEV_NAME);
	} else {
		alloc_chrdev_region(&leddev.devid, 0, LEDDEV_CNT,LEDDEV_NAME);
		leddev.major = MAJOR(leddev.devid);
	}
	/* 2、注册设备 */
	cdev_init(&leddev.cdev, &led_fops);
	cdev_add(&leddev.cdev, leddev.devid, LEDDEV_CNT);
	/* 3、创建类 */
	leddev.class = class_create(THIS_MODULE, LEDDEV_NAME);
	if (IS_ERR(leddev.class)) {
		return PTR_ERR(leddev.class);
	}
	/* 4、创建设备 */
	leddev.device = device_create(leddev.class, NULL, leddev.devid,NULL, LEDDEV_NAME);
	if (IS_ERR(leddev.device)) {
		return PTR_ERR(leddev.device);
	}
	/* 5、初始化 IO */
	leddev.node = of_find_node_by_path("/gpioled");
	if (leddev.node == NULL){
		printk("gpioled node nost find!\r\n");
		return -EINVAL;
	}

	leddev.led0 = of_get_named_gpio(leddev.node, "led-gpio", 0);
	if (leddev.led0 < 0) {
		printk("can't get led-gpio\r\n");
		return -EINVAL;
	}

	gpio_request(leddev.led0, "led0");
	gpio_direction_output(leddev.led0, 1); 	//设置为输出，默认高电平
	return 0;
}

• remove函数中，删除字符设备

/* platform 驱动的 remove 函数 */
static int led_remove(struct platform_device *dev) {
	gpio_set_value(leddev.led0, 1); 	//卸载驱动的时候关闭 LED
	cdev_del(&leddev.cdev); 			//删除 cdev 
	unregister_chrdev_region(leddev.devid, LEDDEV_CNT);
	device_destroy(leddev.class, leddev.devid);
	class_destroy(leddev.class);
	return 0;
}

• 编写设备匹配列表：注意compatible属性值要与设备节点属性值一致

/* 匹配列表 */
static const struct of_device_id led_of_match[] = {
	{ .compatible = "gpioled" },
	{ /* Sentinel */ }
};

• 填充platform驱动结构体

/* platform 驱动结构体 */
static struct platform_driver led_driver = {
	.driver = {
		.name = "imx6ul-led", 			//驱动名字，用于和设备匹配
		.of_match_table = led_of_match, //设备树匹配表
	},
	.probe = led_probe,
	.remove = led_remove,
};

• 驱动入口和出口函数中，注册和卸载platform驱动

/* 驱动模块加载函数 */
static int __init leddriver_init(void) {
	return platform_driver_register(&led_driver);
}
/* 驱动模块卸载函数 */
static void __exit leddriver_exit(void) {
	platform_driver_unregister(&led_driver);
}

module_init(leddriver_init);
module_exit(leddriver_exit);
MODULE_LICENSE("GPL");

2.3 测试程序编写

新建测试文件 platformledAPP.c，并编写程序

int main(int argc, char *argv[]) {
	int fd, retvalue;
	char *filename;
	unsigned char databuf[2];

	if(argc != 3){
		printf("Error Usage!\r\n");
		return -1;
	}

	filename = argv[1];
	/* 打开 led 驱动 */
	fd = open(filename, O_RDWR);
	if(fd < 0){
		printf("file %s open failed!\r\n", argv[1]);
		return -1;
	}

	databuf[0] = atoi(argv[2]); /* 要执行的操作：打开或关闭 */
	retvalue = write(fd, databuf, sizeof(databuf));
	if(retvalue < 0){
		printf("LED Control Failed!\r\n");
		close(fd);
		return -1;
	}

	retvalue = close(fd); /* 关闭文件 */
	if(retvalue < 0){
		printf("file %s close failed!\r\n", argv[1]);
		return -1;
	}
	return 0;
}

3. 编译测试

• 编译驱动程序：当前目录下创建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 := dtsleddriver.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 platformledApp.c -o platformledApp

• 将驱动文件和测试文件拷贝至rootfs/lib/modules/4.1.15后加载驱动，加载成功后，总线就会进行匹配

depmod  #第一次加载驱动时，需使用“depmod”命令
modprobe dtsleddriver.ko

• 根文件系统中 /sys/bus/platform/ 目录下保存着当前platform总线下的设备和驱动，子目录devices为platform设备，子目录drivers为platform驱动，设备模块和驱动模块加载成功后，会在相应目录下找到对应的设备和驱动

• 使用以下命令打开或者关闭LED灯

./platformledAPP  /dev/dtsplatled 1 
./platformledAPP  /dev/dtsplatled 0