platform設備驅動全透析
1.1 platform總線、設備與驅動
在Linux 2.6的設備驅動模型中，關心總線、設備和驅動這3個實體，總線將設備和驅動綁定。在系統每註冊一個設備的時候，會尋找與之匹配的驅動；相反的，在系統每註冊一個驅動的時候，會尋找與之匹配的設備，而匹配由總線完成。
一個現實的Linux設備和驅動通常都需要掛接在一種總線上，對於本身依附於PCI、USB、I2 C、SPI等的設備而言，這自然不是問題，但是在嵌入式系統裏面，SoC系統中集成的獨立的外設控制器、掛接在SoC內存空間的外設等確不依附於此類總 線。基於這一背景，Linux發明了一種虛擬的總線，稱爲platform總線，相應的設備稱爲platform_device，而驅動成爲 platform_driver。
注意，所謂的platform_device並不是與字符設備、塊設備和網絡設備並列的概念，而是Linux系統提供的一種附加手段，例如，在S3C6410處理器中，把內部集成的I2 C、RTC、SPI、LCD、看門狗等控制器都歸納爲platform_device，而它們本身就是字符設備。platform_device結構體的定義如代碼清單1所示。
代碼清單1 platform_device結構體
1 struct platform_device {
2 const char * name;/* 設備名 */
3 u32 id;
4 struct device dev;
5 u32 num_resources;/* 設備所使用各類資源數量 */
6 struct resource * resource;/* 資源 */
7 };
platform_driver這個結構體中包含probe()、remove()、shutdown()、suspend()、resume()函數，通常也需要由驅動實現，如代碼清單2。
代碼清單2 platform_driver結構體
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 (*suspend_late)(struct platform_device *, pm_message_t state);
int (*resume_early)(struct platform_device *);
int (*resume)(struct platform_device *);
struct pm_ext_ops *pm;
struct device_driver driver;
};
系統中爲platform總線定義了一個bus_type的實例platform_bus_type，其定義如代碼清單15.3。
代碼清單15.3 platform總線的bus_type 實例platform_bus_type
struct bus_type platform_bus_type = {
.name = "platform",
.dev_attrs = platform_dev_attrs,
.match = platform_match,
.uevent = platform_uevent,
.pm = PLATFORM_PM_OPS_PTR,
};
EXPORT_SYMBOL_GPL(platform_bus_type);
這裏要重點關注其match()成員函數，正是此成員表明了platform_device和platform_driver之間如何匹配，如代碼清單4所示。
代碼清單4 platform_bus_type的match()成員函數
static int platform_match(struct device *dev, struct device_driver *drv)
{
struct platform_device *pdev;
pdev = container_of(dev, struct platform_device, dev);
return (strncmp(pdev->name, drv->name, BUS_ID_SIZE) == 0);
}
從代碼清單4的第6行可以看出，匹配platform_device和platform_driver主要看二者的name字段是否相同。
對platform_device的定義通常在BSP的板文件中實現，在板文件中，將platform_device歸納爲一個數組，最終通過 platform_add_devices()函數統一註冊。platform_add_devices()函數可以將平臺設備添加到系統中，這個函數的 原型爲：
int platform_add_devices(struct platform_device **devs, int num);
該函數的第一個參數爲平臺設備數組的指針，第二個參數爲平臺設備的數量，它內部調用了platform_device_register()函數用於註冊單個的平臺設備。
1.2 將globalfifo作爲platform設備
現在我們將前面章節的globalfifo驅動掛接到platform總線上，要完成2個工作:
1. 將globalfifo移植爲platform驅動。
2. 在板文件中添加globalfifo這個platform設備。
爲完成將globalfifo移植到platform驅動的工作，需要在原始的globalfifo字符設備驅動中套一層 platform_driver的外殼，如代碼清單5。注意進行這一工作後，並沒有改變globalfifo是字符設備的本質，只是將其掛接到了 platform總線。
代碼清單5 爲globalfifo添加platform_driver
static int __devinit globalfifo_probe(struct platform_device *pdev)
{
int ret;
dev_t devno = MKDEV(globalfifo_major, 0);
/* 申請設備號*/
if (globalfifo_major)
ret = register_chrdev_region(devno, 1, "globalfifo");
else { /* 動態申請設備號 */
ret = alloc_chrdev_region(&devno, 0, 1, "globalfifo");
globalfifo_major = MAJOR(devno);
}
if (ret < 0)
return ret;
/* 動態申請設備結構體的內存*/
globalfifo_devp = kmalloc(sizeof(struct globalfifo_dev), GFP_KERNEL);
if (!globalfifo_devp) { /*申請失敗*/
ret = - ENOMEM;
goto fail_malloc;
}
memset(globalfifo_devp, 0, sizeof(struct globalfifo_dev));
globalfifo_setup_cdev(globalfifo_devp, 0);
init_MUTEX(&globalfifo_devp->sem); /*初始化信號量*/
init_waitqueue_head(&globalfifo_devp->r_wait); /*初始化讀等待隊列頭*/
init_waitqueue_head(&globalfifo_devp->w_wait); /*初始化寫等待隊列頭*/
return 0;
fail_malloc: unregister_chrdev_region(devno, 1);
return ret;
}
static int __devexit globalfifo_remove(struct platform_device *pdev)
{
cdev_del(&globalfifo_devp->cdev); /*註銷cdev*/
kfree(globalfifo_devp); /*釋放設備結構體內存*/
unregister_chrdev_region(MKDEV(globalfifo_major, 0), 1); /*釋放設備號*/
return 0;
}
static struct platform_driver globalfifo_device_driver = {
.probe = globalfifo_probe,
.remove = __devexit_p(globalfifo_remove),
.driver = {
.name = "globalfifo",
.owner = THIS_MODULE,
}
};
static int __init globalfifo_init(void)
{
return platform_driver_register(&globalfifo_device_driver);
}
static void __exit globalfifo_exit(void)
{
platform_driver_unregister(&globalfifo_device_driver);
}
module_init(globalfifo_init);
module_exit(globalfifo_exit);
在代碼清單5中，模塊加載和卸載函數僅僅通過platform_driver_register()、 platform_driver_unregister()函數進行platform_driver的註冊與註銷，而原先註冊和註銷字符設備的工作已經被 移交到platform_driver的probe()和remove()成員函數中。
代碼清單5未列出的部分與原始的globalfifo驅動相同，都是實現作爲字符設備驅動核心的file_operations的成員函數。
爲了完成在板文件中添加globalfifo這個platform設備的工作，需要在板文件（對於LDD6410而言，爲arch/arm/mach-s3c6410/ mach-ldd6410.c）中添加相應的代碼，如代碼清單6。
代碼清單6 globalfifo對應的platform_device
1 static struct platform_device globalfifo_device = {
2 .name = "globalfifo",
3 .id = -1,
4 };
對於LDD6410開發板而言，爲了完成上述globalfifo_device這一platform_device的註冊，只需要將其地址放入 arch/arm/mach-s3c6410/ mach-ldd6410.c中定義的ldd6410_devices數組，如：
static struct platform_device *ldd6410_devices[] __initdata = {
+ & globalfifo_device,
#ifdef CONFIG_FB_S3C_V2
&s3c_device_fb,
#endif
&s3c_device_hsmmc0,
...
}
在加載LDD6410驅動後，在sysfs中會發現如下結點：
/sys/bus/platform/devices/globalfifo/
/sys/devices/platform/globalfifo/
留意一下代碼清單5的第48行和代碼清單6的第2行，platform_device和platform_driver的name一致，這是二者得以匹配的前提。
1.3 platform設備資源和數據
留意一下代碼清單1中platform_device結構體定義的第5~6行，描述了platform_device的資源，資源本身由resource結構體描述，其定義如代碼清單7。
代碼清單7 resouce結構體定義
1 struct resource {
2 resource_size_t start;
3 resource_size_t end;
4 const char *name;
5 unsigned long flags;
6 struct resource *parent, *sibling, *child;
7 };
我們通常關心start、end和flags這3個字段，分別標明資源的開始值、結束值和類型，flags可以爲IORESOURCE_IO、 IORESOURCE_MEM、IORESOURCE_IRQ、IORESOURCE_DMA等。start、end的含義會隨着flags而變更，如當 flags爲IORESOURCE_MEM時，start、end分別表示該platform_device佔據的內存的開始地址和結束地址；當 flags爲IORESOURCE_IRQ時，start、end分別表示該platform_device使用的中斷號的開始值和結束值，如果只使用了
1箇中斷號，開始和結束值相同。對於同種類型的資源而言，可以有多份，譬如說某設備佔據了2個內存區域，則可以定義2個IORESOURCE_MEM資 源。
對resource的定義也通常在BSP的板文件中進行，而在具體的設備驅動中透過platform_get_resource()這樣的API來獲取，此API的原型爲：
struct resource *platform_get_resource(struct platform_device *, unsigned int, unsigned int);
譬如在LDD6410開發板的板文件中爲DM9000網卡定義瞭如下resouce：
static struct resource ldd6410_dm9000_resource[] = {
[0] = {
.start = 0x18000000,
.end = 0x18000000 + 3,
.flags = IORESOURCE_MEM
},
[1] = {
.start = 0x18000000 + 0x4,
.end = 0x18000000 + 0x7,
.flags = IORESOURCE_MEM
},
[2] = {
.start = IRQ_EINT(7),
.end = IRQ_EINT(7),
.flags = IORESOURCE_IRQ | IORESOURCE_IRQ_HIGHLEVEL,
}
};
在DM9000網卡的驅動中則是通過如下辦法拿到這3份資源：
db->addr_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
db->data_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
db->irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
對於IRQ而言，platform_get_resource()還有一個進行了封裝的變體platform_get_irq()，其原型爲：
int platform_get_irq(struct platform_device *dev, unsigned int num);
它實際上調用了“platform_get_resource(dev, IORESOURCE_IRQ, num);”。
設備除了可以在BSP中定義資源以外，還可以附加一些數據信息，因爲對設備的硬件描述除了中斷、內存、DMA通道以外，可能還會有一些配置信息，而 這些配置信息也依賴於板，不適宜直接放置在設備驅動本身，因此，platform也提供了platform_data的支持。platform_data 的形式是自定義的，如對於DM9000網卡而言，platform_data爲一個dm9000_plat_data結構體，我們就可以將MAC地址、總 線寬度、有無EEPROM信息放入platform_data：
static struct dm9000_plat_data ldd6410_dm9000_platdata = {
.flags = DM9000_PLATF_16BITONLY | DM9000_PLATF_NO_EEPROM,
.dev_addr = { 0x0, 0x16, 0xd4, 0x9f, 0xed, 0xa4 },
};
static struct platform_device ldd6410_dm9000 = {
.name = "dm9000",
.id = 0,
.num_resources = ARRAY_SIZE(ldd6410_dm9000_resource),
.resource = ldd6410_dm9000_resource,
.dev = {
.platform_data = &ldd6410_dm9000_platdata,
}
};
而在DM9000網卡的驅動中，通過如下方式就拿到了platform_data：
struct dm9000_plat_data *pdata = pdev->dev.platform_data;
其中，pdev爲platform_device的指針。
由以上分析可知，設備驅動中引入platform的概念至少有如下2大好處：
1. 使得設備被掛接在一個總線上，因此，符合Linux 2.6的設備模型。其結果是，配套的sysfs結點、設備電源管理都成爲可能。
2. 隔離BSP和驅動。在BSP中定義platform設備和設備使用的資源、設備的具體配置信息，而在驅動中，只需要通過通用API去獲取資源和數據，做到了板相關代碼和驅動代碼的分離，使得驅動具有更好的可擴展性和跨平臺性。
