Linux下的platform总线驱动（一）
原创作者：南京邮电大学 通信与信息系统专业 研二 魏清
一．Platform设备驱动概念
主要讲解平台设备驱动的模型和基本概念，同时因为驱动加载的方式有动态加载和静态加载两种方式，这里我们分别对动态加载和静态加载两种情况下，如何使用平台设备和驱动加以叙述。最后使用mini2440开发板，运用Platform和device_attribute机制，编写按键驱动代码和测试代码。
我们知道linux内核中常见的的总线有I2C总线，PCI总线，串口总线，SPI总线，PCI总线，CAN总线，单总线等，所以有些设备和驱动就可以挂在这些总线上，然后通过总线上的match进行设备和驱动的匹配。但是有的设备并不属于这些常见总线，所以我们引入了一种虚拟总线，也就是platform总线的概念，对应的设备叫做platform设备，对应的驱动叫做platform驱动。当然引入platform的概念，可以做的与板子相关的代码和驱动的代码分离，使得驱动有更好的可扩展性和跨平台性。
1.Platform总线
struct bus_type platform_bus_type = {
.name = "platform", //名
.dev_attrs = platform_dev_attrs, //属性
.match = platform_match, //设备和驱动的匹配函数
.uevent = platform_uevent, //卸载处理
.pm = &platform_dev_pm_ops, //电源管理
};
我们看看设备和驱动的匹配函数match
static int platform_match(struct device *dev, struct device_driver *drv)
{
struct platform_device *pdev = to_platform_device(dev); //获得平台设备
struct platform_driver *pdrv = to_platform_driver(drv); //获得平台驱动
if (pdrv->id_table) //如果平台驱动有支持项，进入platform_match_id
return platform_match_id(pdrv->id_table, pdev) != NULL;
return (strcmp(pdev->name, drv->name) == 0); //没有支持项，则老实匹配名字
}
通过上面这个match函数我们知道，如果驱动中定义了驱动支持项，那么在总线执行match函数中，就会将驱动支持项中每一个名字和设备名字匹配，看看是否匹配成功。如果驱动没有设置支持项，就会把驱动的名字和设备的名字匹配，如果一样，则匹配成功。
2.Platform设备
struct platform_device {
const char * name; //名
int id;
struct device dev; //内嵌设备
u32 num_resources; //资源个数
struct resource * resource; //资源结构体
struct platform_device_id *id_entry;
struct pdev_archdata archdata;
};
我们重点来看看platform_device中资源结构体的定义
struct resource {
resource_size_t start; //起始地址
resource_size_t end; //结束地址
const char *name; //名
unsigned long flags; //标号
struct resource *parent, *sibling, *child;
};
对于这个资源结构体中的flags标号可以有IORESOURCE_IO、IORESOURCE_MEM、IORESOURCE_IRQ、IORESOURCE_DMA四种选择，重点是申请内存（IORESOURCE_MEM）和申请中断号（IORESOURCE_IRQ）用的比较多。
2.1Platform设备的静态加载
所谓的静态加载，就是把platform设备编译进内核，对于platform_device的定义常常在BSP中实现，我们这里拿Mini2440举例，看看对于的BSP文件mach-smdk2440.c
struct platform_device s3c_device_lcd = {
.name = "s3c2410-lcd",
.id = -1,
.num_resources = ARRAY_SIZE(s3c_lcd_resource),
.resource = s3c_lcd_resource,
.dev = {
.dma_mask = &s3c_device_lcd_dmamask,
.coherent_dma_mask = 0xffffffffUL
}
};
这是基于Mini2440的LCD平台设备在BSP文件中的定义，那么我们怎么把它加入内核呢？
static struct platform_device *smdk2440_devices[] __initdata = {
&s3c_device_usb,
&s3c_device_lcd, //添加LCD平台设备
&s3c_device_wdt,
&s3c_device_i2c0,
&s3c_device_iis,
};
嗯，原来我们建立了一个platform_device数组，然后把LCD的platform_device添加到这个数组中，那么这个platform_device数组怎么注册到内核的呢？
static void __init smdk2440_machine_init(void)
{
s3c24xx_fb_set_platdata(&smdk2440_fb_info);
s3c_i2c0_set_platdata(NULL);
platform_add_devices(smdk2440_devices, ARRAY_SIZE(smdk2440_devices));//加到内核
smdk_machine_init();
}
看到了吧，在smdk2440_machine_init中，我们调用了platform_add_devices函数来把platform_device注册到内核，再继续跟踪下platform_add_devices
int platform_add_devices(struct platform_device **devs, int num)
{
int i, ret = 0;
for (i = 0; i < num; i++) {
ret = platform_device_register(devs[i]);
if (ret) {
while (--i >= 0)
platform_device_unregister(devs[i]); //注册设备
break;
}
}
return ret;
}
好了，到此为止，我们已经看到了如果添加platform_device，以及这个platform_device又是如何被注册到内核的全过程。
除了BSP中定义的资源外，有的设备可能还会有一些配置信息，而这些配置信息依赖于板子，不适合放到驱动中，为此，我们的platform提供了平台数据platform_data的支持。在内核中添加平台数据有两种方式，仍然以LCD为例
static struct s3c2410fb_mach_info smdk2440_fb_info __initdata = { //平台数据
.displays = &smdk2440_lcd_cfg,
.num_displays = 1,
.default_display = 0,
.lpcsel = ((0xCE6) & ~7) | 1<<4,
};
上面的smdk2440_fb_info就是LCD的平台数据，我们怎么把这个LCD的平台数据告诉LCD的platform_device呢？
static void __init smdk2440_machine_init(void)
{
s3c24xx_fb_set_platdata(&smdk2440_fb_info); //添加平台数据
s3c_i2c0_set_platdata(NULL);
platform_add_devices(smdk2440_devices, ARRAY_SIZE(smdk2440_devices));
smdk_machine_init();
}
看到没？上面的s3c24xx_fb_set_platdata函数就完成了平台数据的添加，继续跟踪这个s3c24xx_fb_set_platdata函数
void __init s3c24xx_fb_set_platdata(struct s3c2410fb_mach_info *pd)
{
struct s3c2410fb_mach_info *npd;
npd = kmalloc(sizeof(*npd), GFP_KERNEL);
if (npd) {
memcpy(npd, pd, sizeof(*npd));
s3c_device_lcd.dev.platform_data = npd; //平台数据添加的实现
} else {
printk(KERN_ERR "no memory for LCD platform data\n");
}
}
好了，我们可以看到其实把这个平台数据保存在了平台设备中内嵌的设备结构体的platform_data中。刚才说了添加平台数据有两种方式，根据上面的原理，其实我们可以直接把平台数据保存在了平台设备中内嵌的设备结构体的platform_data中，具体代码如下
struct platform_device s3c_device_lcd = {
.name = "s3c2410-lcd",
.id = -1,
.num_resources = ARRAY_SIZE(s3c_lcd_resource),
.resource = s3c_lcd_resource,
.dev = {
.dma_mask = &s3c_device_lcd_dmamask,
.coherent_dma_mask = 0xffffffffUL
.platform_data=&smdk2440_fb_info //添加平台数据
}
};
到此为止，我们已经明白了platform_device的静态添加全过程。
2.2 Platform设备的动态加载
由于静态添加platform_device需要最后编译内核，这个不利于修改，所以在开发阶段，我们可以采用platform设备的动态加载方法。具体操作是：先分配platform_device，然后向platform_device中添加资源结构体，最后把platform_device注册到内核，对应三个函数如下
struct platform_device my_device = platform_device_alloc("s3c2410-buttons", -1);
platform_device_add_resources(my_device, s3c_buttons_resource, 3);
ret = platform_device_add(my_device);
当然，上面三个函数还是封装在模块加载函数中，也就是把平台设备的加载写成一个模块的形式。
3. Platform驱动
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; //内嵌设备驱动
struct platform_device_id *id_table; //驱动支持项
};
根据上面的platform_driver结构体的定义，我们需要思考下platform驱动名字在哪里呢？实际上在内嵌的设备驱动中定义的。
3.1 Platform驱动的静态加载
写一个驱动，测试驱动阶段我们一般采用动态加载的方式，当驱动已经成型，我们就会采用静态加载的方式，把驱动编译入内核。把驱动静态编译入内核的方式主要是根据Makefile和Kconfig两张地图，在Makefile中添加驱动文件名，在Kconfig中添加对应的驱动菜单选项，当我面make zImage时就会自动编译我们的驱动文件。
3.2 Platform驱动的动态加载
拿一个基于平台设备的按键驱动例子看看
static struct platform_driver my_driver = {
.probe = my_probe, //探测函数
.remove = my_remove,
.driver = {
.owner = THIS_MODULE,
.name = "s3c2410-buttons",
},
};
上面是按键驱动中定义了的一个platform_driver，然后我们只需要在驱动模块加载函数中执行platform_driver_register(&my_driver)就可以把platform驱动加入内核了。在我们进行insmod加载时就会调用这个模块加载函数，从而注册platform驱动。
二．平台设备的资源
1.平台数据和私有数据的区别
前面在讲平台设备的静态加载的时候，我们提到平台数据的概念，在内核驱动代码中还会出现私有数据这一名词。那么平台数据和私有数据有什么区别呢？首先平台数据是由于引入平台设备而产生的，平台数据主要保存的是一些依赖的板子的配置信息，平台数据的定义是定义在平台设备所在的BSP中的，我们在平台驱动中可以进行读取到在BSP中定义的平台数据。而私有数据是作为一个驱动中保存设备信息的一个结构体，它定义在平台驱动中，而不是BSP中，我们在平台驱动中可以把一个设备结构体设置为这个平台驱动的私有数据，也可以根据这个平台设备，读取这个平台设备的私有数据。
好了，下面我们先看看怎么在平台驱动中读取在BSP中定义的平台数据，仍然以LCD为例，只需要在设备驱动需要获取平台数据的地方执行如下代码
struct s3c2410fb_mach_info *pdata=pdev->dev.platform_data;
接下来，我们研究下私有数据。私有数据的定义各种各样，总之是一个结构体。那么怎么将一个设备结构体设置为平台设备的私有数据呢？
struct buttons *key；
platform_set_drvdata(pdev, key)；
同样怎么根据这个平台设备，读取这个平台设备的私有数据呢？
Struct buttons *keyt=platform_get_drvdata(pdev)；
最后补充两个点：第一，根据经验发现平台数据是为私有数据服务的，也就是平台数据可能成为私有数据的一部分。第二，对于由设备获得平台设备的情况，我们可以通过*pdev=to_platform_device(dev)代码获得。
2. Platform设备资源的读取
我们在BSP中定义了平台设备的资源，那么怎么获取这些资源呢？首先我们要明白，设备和驱动的第一次匹配是发生在总线上的match函数中，这次匹配成功后所做的操作只是把设备和驱动相连。当我们执行平台驱动中的probe时，会发生第二次设备和驱动的匹配，也就是所谓的探测。所以，我们对在BSP中定义的平台设备的资源会在平台驱动的probe函数中读取到，下面我们就看看如何读取这些资源了。
对于资源中的存储空间的资源读取，首先读取资源，然后申请空间，最后完成由虚拟地址到物理地址的映射。具体函数如下
struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
struct resource *buttons_mem = request_mem_region(res->start,
res->end-res->start+1, pdev->name);
void __iomem *buttons_base = ioremap(res->start, res->end - res->start + 1);
对于中断资源的读取，只要一步如下操作即可。
struct resource *buttons_irq1 = platform_get_resource(pdev, IORESOURCE_IRQ, 0);