嵌入式linux驱动-platform 设备驱动

Linux 系统提出了驱动的分离与分层这样的软件思路—platform 设备驱动（平台设备驱动）。

Linux 驱动的分离与分层

驱动的分离

随着linux驱动的板子越来越多，驱动设备越来越多，所以代码的重用性非常重要。

举个例子，使用一个MPU6050：

• 板子的厂家一般会提供I2C主机驱动
• MPU6050一般会提供设备驱动
• 需要借助linux内核中platform驱动将主机驱动和设备驱动“连线”。
  

大体规则

• 当我们向系统注册一个驱动的时候，总线就会在右侧的设备中查找，看看有没有与之匹配的设备，如果有的话就将两者联系起来。
• 当向系统中注册一个设备的时候，总线就会当向系统中注册一个设备的时候，总线就会在左侧的驱动中查找看有没有与之匹配的设备，有的话也联系起来。

说白了就是总线(bus)、驱动(driver)和设备(device)模型。

驱动的分层

类似于网络的 7 层模型，不同的层负责不同的内容。

驱动分层也是如此，也是为了在不同的层处理不同的内容，可以极大的简化我们的驱动编写。

例如：input 子系统负责管理所有跟输入有关的驱动，包括键盘、鼠标、触摸等，最底层的就是设备原始驱动，负责获取输入设备的原始值，获取到的输入事件上报给 input 核心层。

platform 平台驱动模型简介

Linux 提出了：platform 虚拟总线、platform_driver驱动 和 platform_device设备。

之前说的设备树compatible属性就是类似的用于驱动和设备之间的匹配。

platform 总线

总线：bus_type结构体，定义在文件include/linux/device.h。

struct bus_type {
	const char *name; /* 总线名字 */
	...
	int (*match)(struct device *dev, struct device_driver *drv);
	...
};

platform 总线： bus_type 的一个具体实例，定义在文件 drivers/base/platform.c。

struct bus_type platform_bus_type = {
	.name = "platform",
	.dev_groups = platform_dev_groups,
	.match = platform_match,
	.uevent = platform_uevent,
	.pm = &platform_dev_pm_ops,
};

其中platform_match函数负责匹配驱动和设备，有4种方法：

• OF 类型的匹配，of_driver_match_device(dev, drv)。
• ACPI 匹配方式，acpi_driver_match_device(dev, drv)。
• id_table 匹配，platform_driver匹配platform_device中的id_table。
• 直接比较驱动和设备的 name 字段。（常用）

platform 驱动

platform驱动：由platform_driver 结构体表示，定义在文件include/linux/platform_device.h

struct platform_driver {
	int (*probe)(struct platform_device *);
	int (*remove)(struct platform_device *);
	void (*shutdown)(struct platform_device *);
	int (*suspend)(struct platform_device *, pm_message_t state);
	int (*resume)(struct platform_device *);
	struct device_driver driver;
	const struct platform_device_id *id_table;
	bool prevent_deferred_probe;
};
//同样的，里边儿有各种函数指针。

注意：

• probe 函数，当驱动与设备匹配成功以后 probe 函数就会执行，非常重要的函数！！
• driver 成员是 device_driver 结构体（基类）变量。

//device_driver 结构体定义在 include/linux/device.h
struct device_driver {
	const char *name;
	...
	const struct of_device_id *of_match_table;
	...
};

//of_device_id 结构体定义在文件 include/linux/mod_devicetable.h
struct of_device_id {
	char name[32];
	char type[32];
	char compatible[128];
	const void *data;
};

• id_table 表，第三种匹配方法。

• 注册函数

int platform_driver_register (struct platform_driver *driver)

driver：要注册的 platform 驱动。
返回值： 负数，失败； 0，成功。

• 注销函数

void platform_driver_unregister(struct platform_driver *drv)

drv：要卸载的 platform 驱动。
返回值： 无。

platform 驱动框架

platform 驱动还是传统的字符设备驱动、块设备驱动或网络设备驱动，只是套上了一张“platform” 的皮，目的是为了使用总线、驱动和设备这个驱动模型来实现驱动的分离与分层。

以下驱动还是在之前驱动程序的基础上，中间加塞了platform驱动。

/* 设备结构体 */
struct xxx_dev{
	struct cdev cdev;
	...
	/* 设备结构体其他具体内容 */
};
struct xxx_dev xxxdev; /* 定义个设备结构体变量 */

static int xxx_open(struct inode *inode, struct file *filp)
{
	/* 函数具体内容 */
	...
	return 0;
}
static ssize_t xxx_write(struct file *filp, const char __user *buf, size_t cnt, loff_t *offt)
{
	/* 函数具体内容 */
	...
	return 0;
}
/*
* 字符设备驱动操作集
*/
static struct file_operations xxx_fops = {
	.owner = THIS_MODULE,
	.open = xxx_open,
	.write = xxx_write,
};

/*
* platform 驱动的 probe 函数
* 驱动与设备匹配成功以后此函数就会执行
*/
static int xxx_probe(struct platform_device *dev)
{
	......
	cdev_init(&xxxdev.cdev, &xxx_fops); /* 注册字符设备驱动 */
	/* 函数具体内容 */
	...
	return 0;
}
static int xxx_remove(struct platform_device *dev)
{
	......
	cdev_del(&xxxdev.cdev);/* 删除 cdev */
	/* 函数具体内容 */
	...
	return 0;
}
/* 匹配列表 */
static const struct of_device_id xxx_of_match[] = {
	{ .compatible = "xxx-gpio" },
	{ /* Sentinel */ }//of_device_id 表最后一个匹配项必须是空的
};
/*
* platform 平台驱动结构体
*/
static struct platform_driver xxx_driver = {
	.driver = {
		.name = "xxx",
		.of_match_table = xxx_of_match,
	},
	.probe = xxx_probe,
	.remove = xxx_remove,
};
/* 驱动模块加载 */
static int __init xxxdriver_init(void)
{
	return platform_driver_register(&xxx_driver);
}
/* 驱动模块卸载 */
static void __exit xxxdriver_exit(void)
{
	platform_driver_unregister(&xxx_driver);
}
module_init(xxxdriver_init);
module_exit(xxxdriver_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("zuozhongkai");

platform 设备

两种方法：

• 方法一：直接设备树描述（常用）
• 方法二：编写platform 设备（这是实在不支持设备树的情况）

platform_device文件编写

platform 设备：由platform_device结构体表示，定义在文件
include/linux/platform_device.h 。

struct platform_device {
	const char *name;	//设备名字
	...
	u32 num_resources;	//资源数量
	struct resource *resource;	//资源，也就是设备信息，如外设寄存器
	...
};

注意：

• resource结构体：

struct resource {
	resource_size_t start;
	resource_size_t end;
	const char *name;
	unsigned long flags;
	struct resource *parent, *sibling, *child;
};
start 和 end 分别表示资源的起始和终止信息，对于内存类的资源，就表示内存起始和终止地址， 
name 表示资源名字， 
flags 表示资源类型
	#define IORESOURCE_BITS 0x000000ff /* Bus-specific bits */
	#define IORESOURCE_TYPE_BITS 0x00001f00 /* Resource type */
	#define IORESOURCE_IO 0x00000100 /* PCI/ISA I/O ports */
	#define IORESOURCE_MEM 0x00000200
	#define IORESOURCE_REG 0x00000300 /* Register offsets */
	#define IORESOURCE_IRQ 0x00000400
	#define IORESOURCE_DMA 0x00000800
	#define IORESOURCE_BUS 0x00001000
	......
	/* PCI control bits. Shares IORESOURCE_BITS with above PCI ROM. */
	#define IORESOURCE_PCI_FIXED (1<<4) /* Do not move resource */

• 注册函数

int platform_device_register(struct platform_device *pdev)

pdev：要注册的 platform 设备。
返回值： 负数，失败； 0，成功。

• 注销函数

void platform_device_unregister(struct platform_device *pdev)

pdev：要注销的 platform 设备。
返回值： 无。

• platform 设备信息框架

/* 寄存器地址定义*/
#define PERIPH1_REGISTER_BASE (0X20000000) /* 外设 1 寄存器首地址 */
#define PERIPH2_REGISTER_BASE (0X020E0068) /* 外设 2 寄存器首地址 */
#define REGISTER_LENGTH 4
/* 资源 */
static struct resource xxx_resources[] = {
	[0] = {
		.start = PERIPH1_REGISTER_BASE,
		.end = (PERIPH1_REGISTER_BASE + REGISTER_LENGTH - 1),
		.flags = IORESOURCE_MEM,
	},
	[1] = {
		.start = PERIPH2_REGISTER_BASE,
		.end = (PERIPH2_REGISTER_BASE + REGISTER_LENGTH - 1),
		.flags = IORESOURCE_MEM,
	},
};

/* platform 设备结构体 */
static struct platform_device xxxdevice = {
	.name = "xxx-gpio",
	.id = -1,
	.num_resources = ARRAY_SIZE(xxx_resources),
	.resource = xxx_resources,
};

/* 设备模块加载 */
static int __init xxxdevice_init(void)
{
	return platform_device_register(&xxxdevice);
}
/* 设备模块注销 */
static void __exit xxx_resourcesdevice_exit(void)
{
	platform_device_unregister(&xxxdevice);
}
module_init(xxxdevice_init);
module_exit(xxxdevice_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("zuozhongkai");

直接设备树描述设备信息（常用）

设备树：platform 总线通过设备树中设备节点的 compatible 属性值来匹配驱动！

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

注意：

• 编写 platform驱动的时候 of_match_table 属性表中要有“atkalpha-gpioled”。
• 驱动和设备的compatible匹配成功执行probe函数。
• 注销驱动模块执行remove函数。

程序编写

设备树文件—platform 设备

在设备树中添加gpioled子节点。

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

驱动文件—platform 驱动

正所谓，熟能生巧，到目前为止，驱动程序都是这几步，很套路的。

#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/ide.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/errno.h>
#include <linux/gpio.h>
#include <linux/cdev.h>
#include <linux/device.h>
#include <linux/of_gpio.h>
#include <linux/semaphore.h>
#include <linux/timer.h>
#include <linux/irq.h>
#include <linux/wait.h>
#include <linux/poll.h>
#include <linux/fs.h>
#include <linux/fcntl.h>
#include <linux/platform_device.h>
#include <asm/mach/map.h>
#include <asm/uaccess.h>
#include <asm/io.h>
/***************************************************************
Copyright © ALIENTEK Co., Ltd. 1998-2029. All rights reserved.
文件名		: leddriver.c
作者	  	: 左忠凯
版本	   	: V1.0
描述	   	: 设备树下的platform驱动
其他	   	: 无
论坛 	   	: www.openedv.com
日志	   	: 初版V1.0 2019/8/13 左忠凯创建
***************************************************************/

#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设备 */

/*
 * @description		: LED打开/关闭
 * @param - sta 	: LEDON(0) 打开LED，LEDOFF(1) 关闭LED
 * @return 			: 无
 */
void led0_switch(u8 sta)
{
	if (sta == LEDON )
		gpio_set_value(leddev.led0, 0);
	else if (sta == LEDOFF)
		gpio_set_value(leddev.led0, 1);	
}

/*
 * @description		: 打开设备
 * @param - inode 	: 传递给驱动的inode
 * @param - filp 	: 设备文件，file结构体有个叫做private_data的成员变量
 * 					  一般在open的时候将private_data指向设备结构体。
 * @return 			: 0 成功;其他 失败
 */
static int led_open(struct inode *inode, struct file *filp)
{
	filp->private_data = &leddev; /* 设置私有数据  */
	return 0;
}

/*
 * @description		: 向设备写数据 
 * @param - filp 	: 设备文件，表示打开的文件描述符
 * @param - buf 	: 要写给设备写入的数据
 * @param - cnt 	: 要写入的数据长度
 * @param - offt 	: 相对于文件首地址的偏移
 * @return 			: 写入的字节数，如果为负值，表示写入失败
 */
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,
};

/*
 * @description		: flatform驱动的probe函数，当驱动与
 * 					  设备匹配以后此函数就会执行
 * @param - dev 	: platform设备
 * @return 			: 0，成功;其他负值,失败
 */
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); /* led0 IO设置为输出，默认高电平	*/
	return 0;
}

/*
 * @description		: platform驱动的remove函数，移除platform驱动的时候此函数会执行
 * @param - dev 	: platform设备
 * @return 			: 0，成功;其他负值,失败
 */
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;
}

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

/* platform驱动结构体 */
static struct platform_driver led_driver = {
	.driver		= {
		.name	= "imx6ul-led",			/* 驱动名字，用于和设备匹配 */
		.of_match_table	= led_of_match, /* 设备树匹配表 		 */
	},
	.probe		= led_probe,
	.remove		= led_remove,
};
		
/*
 * @description	: 驱动模块加载函数
 * @param 		: 无
 * @return 		: 无
 */
static int __init leddriver_init(void)
{
	return platform_driver_register(&led_driver);
}

/*
 * @description	: 驱动模块卸载函数
 * @param 		: 无
 * @return 		: 无
 */
static void __exit leddriver_exit(void)
{
	platform_driver_unregister(&led_driver);
}

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

运行测试

1、编译驱动和应用

2、加载驱动

depmod //第一次加载驱动的时候需要运行此命令
modprobe leddriver.ko //加载驱动模块

3、/sys/bus/platform/drivers/目录下查看驱动是否存在。

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

4、/sys/bus/platform/devices/目录下查看设备文件是否存在。

设备树中的gpioled子节点。

gpioled {
	......	
};

5、驱动和设备匹配成功