Linux-2.6.20的LCD驱动分析（二）[转]

二、s3c2410fb_probe函数分析
2.1 驱动的入口点
摆在面前的第一个问题相信应该是，这个函数是从那里开始运行的。这里就应该从long long ago 开始了，打开drivers/video/s3c2410fb.c文件，然后找到s3c2410fb_init函数，先不管它里面是怎么回事，再把目光下移就会看到这样一串字符串module_init(s3c2410fb_init)，郁闷，这和S3C2410fb_probe有啥关系嘛？这个问题问的好！不要着急慢慢往下面走。先摸摸module_init是何方神圣再说，于是乎我就登陆了http://lxr.linux.no/linux+v2.6.20/网站，在上面一搜，原来module_init老家在include/linux/init.h，原来它居然还有两重身份，其原型如下：
#ifndef MODULE
……
#define module_init(x) __initcall(x); ①
……
#else
……
#define module_init(initfn) / ②
static inline initcall_t __inittest(void) /
{ return initfn; } /
int init_module(void) __attribute__((alias(#c)));
……
#endif

从上面可以看出，module_init到底用哪个，就取决于MODULE了，那么MODULE的作用是什么呢？我们知道Linux可以将设备当作模块动态加进内核，也可以直接编译进内核，说到这里大概有点明白MODULE的作用了，不错！它就是要控制一个驱动加入内核的方式。定义了MODULE就表示将设备当作模块动态加入。所以上面的①表示将设备加进内核。在②中的__attribute__((alias(#initfn)))很有意思，这代表什么呢？主要alias就是属性的意思，它的英文意思是别名，可以在http://publib.boulder.ibm.com/infocenter/lnxpcomp/v8v101/index.jsp?topic=/com.ibm.xlcpp8l.doc/language/ref/fn_attrib_alias.htm找到它的详细说明，这里简单的说int init_module(void) __attribute__((alias(#initfn)));的意思为init_module是initfn的别名，或者init_module是initfn的一个连接，再简单一点说这个时候module_init宏基因突变成了init_module()了。对于第一种情况，__initcall(fn) 又被宏定义成了device_initcall(fn)，也就是说module_init(x)等于device_initcall(fn)。对于device_initcall(fn)又是一个宏定义，它被定义成了__define_initcall("6",fn,6)，至于这个宏表示什么意思，在这里就不啰嗦重复了，在Linux-2.6.20的cs8900驱动分析(一)这篇文章中有对它的揭秘。
上面啰嗦了这么多，最终是要说明只要用module_init申明了一个函数，该函数就会被Linux内核在适当的时机运行，这些时机包括在linux启动的do_initcalls()时调用（设备被编译进内核），或者在动态插入时调用。
回到上面的module_init(s3c2410fb_init)处，也就是说内核与buffer驱动发生关系的第一次地点是在s3c2410fb_init函数，该函数就只有一条语句
[align=center]platform_driver_register (&s3c2410fb_driver)；[/align]
？？？？？？……

2.2 platform是何许人也
platform可以理解成一种设备类型，就像字符设备、块设备和网络设备一样，而LCD就属于这种设备。对于platform设备Linux为应用添加了相关的接口，在这里只是简单的说说这些接口的用法，而不去深入探讨这些接口的实现（我现在还没有那个能力呢！）。说到这里，马上就有个问题涌上心头了，那就是Linux提供了那些接口呢？如果我们需要添加这些设备应该怎么样做呢？
platform中的相关数据结构是应用的关键，为了向内核添加一个platform设备，程序员应该填写两个数据结构platform_device 和platform_driver，这两个数据结构的定义都可以在include/linux/platform_device.h文件中找到。看看LCD驱动是怎么做的，第一步是填写platform_device，在arch/arm/mach-s3c2410/devs.c可以找到填写platform_device的代码，如下：
static u64 s3c_device_lcd_dmamask = 0xffffffffUL;
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_device数据结构中有详细的说明，这里不赘述。上面的代码中的ARRAY_SIZE宏还是比较有意思的，其实是个c的编程技巧，这个技巧很有用哦！可以在include/linux/kernel.h中找到它的定义：
[align=center]#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))[/align]
该宏可以方便的求出一个数组中有多少数据成员，这在很多情况下是很有用的，比如对于 int a[]={1,5,65,23,12,20,3}数组，可以使用该宏求出a[]有7个元素。
另外，platform_device的另外一项重要成员是resource，在上面的代码中此域被赋予了s3c_lcd_resource，s3c_lcd_resource也可以在arch/arm/mach-s3c2410/devs.c找到。
static struct resource s3c_lcd_resource[] = {
[0] = {
.start = S3C24XX_PA_LCD,
.end = S3C24XX_PA_LCD + S3C24XX_SZ_LCD - 1,
.flags = IORESOURCE_MEM,
},
[1] = {
.start = IRQ_LCD,
.end = IRQ_LCD,
.flags = IORESOURCE_IRQ,
}
};
struct resource结构实际上描述了该设备占用的硬件资源（如地址空间，中断号等s），s3c_lcd_resource描述了内存空间和中断分配情况。
最后在smdk2410_devices指针数组中添加上s3c_device_lcd的大名，Linux在初始化platform的时候就知道系统中有个s3c_device_lcd设备了。注意了这里只是向Linux描述了设备需要的资源情况，不代表内核会给这些资源的。如果设备要得到这些设备还需要在自己的初始化函数中去申请。

static struct platform_device *smdk2410_devices[] __initdata = {
&s3c_device_usb,
&s3c_device_lcd,
&s3c_device_wdt,
&s3c_device_i2c,
&s3c_device_iis,
&s3c_device_ts,
};
说到这里，应该说向Linux添加一个platform设备应该很容易。

2.2 回到s3c2410fb_init
终于把platform的相关知识啰嗦了一番，下面回到s3c2410fb_init函数所调用platform_driver_register(&s3c2410fb_driver)。简单地说platform_driver_register要将向内核注册一个platform设备的驱动，这里是要注册LCD设备。上面说过platform有两个重要的数据结构platform_device和platform_driver，现在是应该提到后者的时候了。platform_driver也在include/linux/platform_device.h中，它的各个成员应该再明白不过来吧！在LCD驱动程序（drivers/video/s3c2410fb.c）中定义了填充了platform_driver这个结构，如下：
static struct platform_driver s3c2410fb_driver = {
.probe = s3c2410fb_probe,
.remove = s3c2410fb_remove,
.suspend = s3c2410fb_suspend,
.resume = s3c2410fb_resume,
.driver = {
.name = "s3c2410-lcd",
.owner = THIS_MODULE,
},
};
可以看到该platform设备的驱动函数有s3c2410fb_probe、s3c2410fb_remove等等。通过platform_driver_register函数注册该设备的过程中，它会回调.probe函数，说到这里也就明白s3c2410fb_probe是在platform_driver_registe中回调的。到目前为止，经过二万五千里长征终于到达s3c2410fb_probe（LCD的驱动程序）了。

2.3 s3c2410fb_probe揭秘
对于该函数，我想最好的办法就是跟着程序一步一步的解释。OK，let’s go to ……
static int __init s3c2410fb_probe(struct platform_device *pdev)
{
struct s3c2410 fb_info *info; //s3c2410fb_info结构在driver/video/s3c2410fb.h中定义，
//可以说该结构记录了s3c2410fb驱动的所有信息。
struct fb_info *fbinfo; /* fb_info为内核提供的buffer驱动的接口数据结构, 每个帧缓冲驱动都对应一个这样的结构。s3c2410fb_probe的最终目的填充该结构，并向内核注册。*/
struct s3c2410fb_hw *mregs; // s3c2410fb_hw为描述LCD的硬件控制寄存器的结构体，
//在include/asm-arm/arch-s3c2410/fb.h可以找到它的原型。
……

mach_info = pdev->dev.platform_data; /*这一步看来要多费些口舌了。mach_info是一个s3c2410fb_mach_info类型的指针，注意区分s3c2410fb_mach_info和s3c2410fb_info结构,简单地说前者只是用于描述LCD初始化时所用的值，而后者是描述整个LCD驱动的结构体。s3c2410fb_mach_info在include/asm-arm/arch-s3c2410/fb.h中定义，从他的位置可以看出它和平台相关，也即它不是内核认知的数据结构，这只是驱动程序设计者设计的结构。这里的主要疑问是什么呢？从下面的if语句可以看出如果mach_info等于NULL的话，整个驱动程序就退出了，这就引出了问题――pdev->dev.platform_data是在什么时候被初始化的呢？看来要回答这个问题，历史应该回到孙悟空大闹天宫的时候了。按住倒带键不放一直到本篇文章的第一部分，看看那个时候做了些什么。放在这里来解释第一部分的内容希望没有为时已晚。其实在内核启动init进程之前就会执行smdk2410_map_io( )函数（内核的启动分析就免了吧@_@），而在smdk2410_map_io( )中我们加入了
[align=center]s3c24xx_fb_set_platdata (&smdk2410_lcd_platdata);[/align]
这条语句，s3c24xx_fb_set_platdata()的实现为：
void __init s3c24xx_fb_set_platdata(struct s3c2410fb_mach_info *pd)
{
s3c_device_lcd.dev.platform_data = pd;
}
根据这些代码，可以清楚的看到s3c_device_lcd.dev.platform_data指向了smdk2410_lcd_platdata，而这个smdk2410_lcd_platdata就是一个s3c2410fb_mach_info的变量，它里面就存放了LCD驱动初始化需要的初始数据。当s3c2410fb_probe被回调时，所传给它的参数实际就是s3c_device_lcd的首地址，说到这里一切应该都明了了吧！好了，又撤了一通，现在假设这步成功，继续往下面走。*/
if (mach_info == NULL) {
dev_err(&pdev->dev,"no platform data for lcd, cannot attach/n");
return -EINVAL;
}

mregs = &mach_info->regs; //mregs指向硬件各控制寄存器的初始值，可参见第一部
//分的smdk2410_lcd_platdata变量。

irq = platform_get_irq(pdev, 0); /*该函数获得中断号，该函数的实现是通过比较struct resource的flags域，得到irq中断号，在上2.1的时候提到s3c_lcd_resource[]，platform_get_irq函数检测到flags＝＝IORESOURCE_IRQ时就返回中断号IRQ_LCD。详细的内容请读它的源代码吧！*/
if (irq < 0) { //没有找到可用的中断号，返回-ENOENT
dev_err(&pdev->dev, "no irq for device/n");
return -ENOENT;
}

fbinfo = framebuffer_alloc(sizeof(struct s3c2410fb_info), &pdev->dev); /* framebuffer_alloc可以在include/linux/fb.h文件中找到其原型：struct fb_info *framebuffer_alloc(size_t size, struct device *dev); 它的功能是向内核申请一段大小为sizeof(struct fb_info) + size的空间，其中size的大小代表设备的私有数据空间，并用fb_info的par域指向该私有空间。*/
if (!fbinfo) {
return -ENOMEM;
}

//以下开始做正经事了，填充fbinfo了。
info = fbinfo->par; //你中有我，我中有你！
info->fb = fbinfo;
platform_set_drvdata(pdev, fbinfo); /*该函数的实现非常简单，实际的操作为：pdev->dev.driver_data ＝ fbinfo，device结构的driver_data域指向驱动程序的私有数据空间。*/

dprintk("devinit/n");

strcpy(fbinfo->fix.id, driver_name);

memcpy(&info->regs, &mach_info->regs, sizeof(info->regs));

/* Stop the video and unset ENVID if set */
info->regs.lcdcon1 &= ~S3C2410_LCDCON1_ENVID;
lcdcon1 = readl(S3C2410_LCDCON1);
writel(lcdcon1 & ~S3C2410_LCDCON1_ENVID, S3C2410_LCDCON1);//停止硬件

/*以下的对fbinfo的填写就免了吧！对于fb_info结构的各个成员，在include/linux/fb文件中都有详细的说明，如果不知道说明的意思，就应该找些基本的知识读读了。在众多的初始化中，fbinfo->fbops = &s3c2410fb_ops;是值得一提的，变量s3c2410fb_ops 就在s3c2410fb.c中定义，它记录了该帧缓冲区驱动所支持的操作 */

……

for (i = 0; i < 256; i++) //初始化调色板缓冲区
info->palette_buffer[i] = PALETTE_BUFF_CLEAR;

if (!request_mem_region((unsigned long)S3C24XX_VA_LCD, SZ_1M, "s3c2410-lcd")) {
/* 向内核申请内存空间，如果request_mem_region返回0表示申请失败，此时程序跳到dealloc_fb处开始执行，该处会调用framebuffer_release释放刚才由framebuffer_alloc申请的fb_info空间 */
ret = -EBUSY;
goto dealloc_fb;
}
……
ret = request_irq(irq, s3c2410fb_irq, IRQF_DISABLED, pdev->name, info);/* 向内核注册中断，如果注册失败，程序跳转到release_mem处运行，此处释放fb_info和刚才由request_mem_region申请的内存空间 */
if (ret) {
dev_err(&pdev->dev, "cannot get irq %d - err %d/n", irq, ret);
ret = -EBUSY;
goto release_mem;
}

info->clk = clk_get(NULL, "lcd"); //该函数得到时钟源，并与硬件紧密相连，对于我的
//板子，可以在arch/arm/mach-s3c2410/clock.c看到它的原型和实现。
if (!info->clk || IS_ERR(info->clk)) {
printk(KERN_ERR "failed to get lcd clock source/n");
ret = -ENOENT;
goto release_irq; //该处释放上面申请的fb_info，内存，和irq资源
}

clk_enable(info->clk); //打开时钟
dprintk("got and enabled clock/n");

msleep(1); //运行得太久有点累了，去打个盹再说

/* Initialize video memory */
ret = s3c2410fb_map_video_memory(info);/*此函数就在s3c2410fb.c文件中被定义，它的作用是申请帧缓冲器内存空间*/
if (ret) {
printk( KERN_ERR "Failed to allocate video RAM: %d/n", ret);
ret = -ENOMEM;
goto release_clock; //释放所有已得到的资源
}
dprintk("got video memory/n");

ret = s3c2410fb_init_registers(info); //此函数也在s3c2410fb.c文件中定义，后面会分析

ret = s3c2410fb_check_var(&fbinfo->var, fbinfo); //此函数也在s3c2410fb.c文件中定义

ret = register_framebuffer(fbinfo); //神圣的时刻终于到来，向内核正式注册。
if (ret < 0) {
printk(KERN_ERR "Failed to register framebuffer device: %d/n", ret);
goto free_video_memory; //不让注册真郁闷，那就释放所有的资源，出家算了！
}

/* create device files */
device_create_file(&pdev->dev, &dev_attr_debug); //为该设备创建一个在sysfs中的属性

printk(KERN_INFO "fb%d: %s frame buffer device/n",
fbinfo->node, fbinfo->fix.id);

return 0; //大功告成！

free_video_memory:
s3c2410fb_unmap_video_memory(info);
release_clock:
clk_disable(info->clk);
clk_put(info->clk);
release_irq:
free_irq(irq,info);
release_mem:
release_mem_region((unsigned long)S3C24XX_VA_LCD, S3C24XX_SZ_LCD);
dealloc_fb:
framebuffer_release(fbinfo);
return ret;
}