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( )中我们加入了
s3c24xx_fb_set_platdata (&smdk2410_lcd_platdata);
这条语句，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;
}
三、解剖s3c2410fb_driver变量
s3c2410fb_driver变量有什么作用呢？在前面的2.2节提到了它的定义，从它的原型可以看出s3c2410fb_driver是个platform_driver类型的变量，前面的几个小节提到了从platform_driver的名字可以看出它应该是platform_device的驱动类型。为了方便阅读，这里再贴一次s3c2410fb_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_device的驱动函数有s3c2410fb_probe，s3c2410fb_remove，s3c2410fb_suspend和s3c2410fb_suspend。.resource成员前面的章节有说明，.driver成员的值相信不用再说明了吧，再明白不过了。前面的章节，s3c2410fb_probe被比较详细的介绍，这节中的主要任务就是解释其他的几个函数。在解释他们之前，s3c2410fb_probe里面在该函数结尾的时候调用了几个函数没有说到，所以在这里补上。
3.1 s3c2410fb_probe余党
在s3c2410fb_probe中最好调用了s3c2410fb_init_registers和s3c2410fb_check_var函数，这里应该将他们交代清楚。很显然，s3c2410fb_init_registers是初始化相关寄存器。那么后者呢？这里先把s3c2410fb_init_registers搞定再说。s3c2410fb_init_registers的定义与实现如下，先根据它的指向流程，一步一步解释：
static int s3c2410fb_init_registers(struct s3c2410fb_info *fbi)
{
unsigned long flags;
/* Initialise LCD with values from haret */
local_irq_save(flags); /* 关闭中断，在关闭中断前，中断的当前状态被保存在flags中，对于关闭中断的函数，linux内核有很多种，可以查阅相关的资料。*/
/* modify the gpio(s) with interrupts set (bjd) */
/*下面的modify_gpio函数是修改处理器GPIO的工作模式，它的实现很简单，将第二个参数的值与第三个参数的反码按位与操作后，在写到第一个参数。这里的第一个参数实际就是硬件的GPIO控制器。*/
modify_gpio(S3C2410_GPCUP, mach_info->gpcup, mach_info->gpcup_mask);
modify_gpio(S3C2410_GPCCON, mach_info->gpccon, mach_info->gpccon_mask);
modify_gpio(S3C2410_GPDUP, mach_info->gpdup, mach_info->gpdup_mask);
modify_gpio(S3C2410_GPDCON, mach_info->gpdcon, mach_info->gpdcon_mask);
local_irq_restore(flags); //使能中断，并恢复以前的状态
/*下面的几个writel函数开始初始化LCD控制寄存器，它的值就是我们在smdk2410_lcd_platdata(arch/arm/mach-s3c2410/mach-smdk2410.c)中regs域的值。*/
writel(fbi->regs.lcdcon1, S3C2410_LCDCON1);
writel(fbi->regs.lcdcon2, S3C2410_LCDCON2);
writel(fbi->regs.lcdcon3, S3C2410_LCDCON3);
writel(fbi->regs.lcdcon4, S3C2410_LCDCON4);
writel(fbi->regs.lcdcon5, S3C2410_LCDCON5);
s3c2410fb_set_lcdaddr(fbi); /*该函数的主要作用是让处理器的LCD控制器的三个地址寄存器指向正确的位置，这个位置就是LCD的缓冲区，详细的情况可以参见s3c2410的用户手册。*/
……
/* Enable video by setting the ENVID bit to 1 这里打开video，在s3c2410fb_probe中被关闭了，这里打开*/
fbi->regs.lcdcon1 |= S3C2410_LCDCON1_ENVID;
writel(fbi->regs.lcdcon1, S3C2410_LCDCON1);
return 0;
}
OK，s3c2410fb_init_registers就简单介绍到这里。下面看看s3c2410fb_check_var函数要干些什么事，要说到这个函数，还得提到fb_var_screeninfo结构类型，与它对应的是fb_fix_screeninfo结构类型。这两个类型分别代表了显示屏的属性信息，这些信息可以分为可变属性信息（如：颜色深度，分辨率等）和不可变的信息（如帧缓冲的其实地址）。既然fb_var_screeninfo表示了可变的属下信息，那么这些可变信息就应该有一定范围，否则显示就会出问题，所以s3c2410fb_check_var函数的功能就是要在LCD的帧缓冲驱动开始运行之前将这些值初始到合法的范围内。知道了s3c2410fb_check_var要做什么，再去阅读s3c2410fb_check_var函数的代码就没什么问题了。
3.2 s3c2410fb_remove
从这里开始将解释s3c2410fb_driver中的其他几个函数。那么就从s3c2410fb_remove开刀吧！顾名思义该函数就该知道，它要将这个platform设备从系统中移除，可以推测它应该释放掉所有的资源，包括内存空间，中断线等等。还是按照惯例，在它的实现代码中一步步的解释。
static int s3c2410fb_remove(struct platform_device *pdev)
{
struct fb_info *fbinfo = platform_get_drvdata(pdev); /*该函数从platform_device中，到fb_info信息*/
struct s3c2410fb_info *info = fbinfo->par; //得到私有数据
int irq;
s3c2410fb_stop_lcd(info); //该函数停止LCD控制器，实现可以在s3c2410fb.c中找到
msleep(1); //休息以下，等待LCD停止
s3c2410fb_unmap_video_memory(info); //该函数释放缓冲区
if (info->clk) { //停止时钟
clk_disable(info->clk);
clk_put(info->clk);
info->clk = NULL;
}
irq = platform_get_irq(pdev, 0); //得到中断线，以便释放
free_irq(irq,info); //释放该中断
release_mem_region((unsigned long)S3C24XX_VA_LCD, S3C24XX_SZ_LCD); /* 释放内存空间 */
unregister_framebuffer(fbinfo); //向内核注销该帧缓冲
return 0;
}
3.3 s3c2410fb_suspend与s3c2410fb_resume
在实际的设备，常常可以看到LCD在不需要的时候进入休眠状态，当需要使用的时候又开始工作，比如手机，在不需要的时候LCD就熄灭，当需要使用的时候LCD又被点亮。从实际中可以看出这对函数非常重要。虽然他们很重要，但不一定很复杂，下面看看它们是怎么样实现的。
static int s3c2410fb_suspend(struct platform_device *dev, pm_message_t state)
{
struct fb_info *fbinfo = platform_get_drvdata(dev); //这两条语句好面熟^_^
struct s3c2410fb_info *info = fbinfo->par;
s3c2410fb_stop_lcd(info); //停止LCD
/* sleep before disabling the clock, we need to ensure
* the LCD DMA engine is not going to get back on the bus
* before the clock goes off again (bjd) */
msleep(1); //等待一下，因为LCD停止需要一点时间
clk_disable(info->clk); //关闭LCD的时钟
return 0;
}
^_^，下面的代码就不用解释了吧！
static int s3c2410fb_resume(struct platform_device *dev)
{
struct fb_info *fbinfo = platform_get_drvdata(dev);
struct s3c2410fb_info *info = fbinfo->par;
clk_enable(info->clk);
msleep(1);
s3c2410fb_init_registers(info);
return 0;
}
OK，到现在为止，对于platform device的相关驱动就over了。不过精彩的还在后头哦！
四、s3c2410fb_ops变量详解
在上面的文字中，较为详细的解释了platform device相关的代码，通过上面的代码的执行，一个platform设备（framebuffer被当作了platform设备）就加载到内核中去了。就像一个PCI的网卡被加入到内核一样，不同的是PCI的网卡占用的是PCI总线，内核会直接支持它。而对于platform设备需要用上面软件的方法加载到内核，同PCI网卡一样，设备需要驱动程序，刚才只是将platform设备注册到内核中，现在它还需要驱动程序，本节中就来看看这些驱动。
4.1 static struct fb_ops s3c2410fb_ops
对于s3c2410的framebuffer驱动支持的操作主要有s3c2410fb_ops变量中定义，该变量类型为struct fb_ops，该类型的定义在include/linux/fb.h文件中。它的相关解释可以在http://www.91linux.com/html/article/kernel/20071204/8805.html页面中找到，当然在fb.h中也有很详细的说明。下面看看对于s3c2410的驱动为该framebuffer提供了哪些操作。
static struct fb_ops s3c2410fb_ops = {
.owner = THIS_MODULE,
.fb_check_var = s3c2410fb_check_var,
.fb_set_par = s3c2410fb_set_par,
.fb_blank = s3c2410fb_blank,
.fb_setcolreg = s3c2410fb_setcolreg,
.fb_fillrect = cfb_fillrect,
.fb_copyarea = cfb_copyarea,
.fb_imageblit = cfb_imageblit,
};
上面的代码描述了支持的相关操作，下面主要会解释s3c2410****的函数，从.fb_fillrect开始的三个函数将不会被提及，当然也可以去看看它们的行为是什么。这里还有一个问题要说明一下，就是s3c2410fb_ops是在什么时候被注册的，这个问题的答案可以在s3c2410fb_probe函数中找到，请查看s3c2410fb_probe分析的那一小节。
4.2.1 s3c2410fb_check_var
在上面的小节中提到对于一个LCD屏来说内核提供了两组数据结构来描述它，一组是可变属性（fb_var_screeninfo描述），另一组是不变属性（fb_fix_screeninfo描述）。对于可变属性，应该防止在操作的过程中出现超出法定范围的情况，因此内核应该可以调用相关函数来检测、并将这些属性固定在法定的范围内，完成这个操作的函数就是s3c2410_check_var。
下面简单说明一下该函数要做的事情，在这里最好看着fb_var_screeninfo和fb_info的定义。
static int s3c2410fb_check_var(struct fb_var_screeninfo *var, struct fb_info *info)
{
struct s3c2410fb_info *fbi = info->par; //得到驱动的私有数据信息，注意info-par的值
……
/* 下面检查fb_var_screeninfo的xres和yres的值是否超出法定范围，如果查出将其设定为正确的值。*/
if (var->yres > fbi->mach_info->yres.max)
var->yres = fbi->mach_info->yres.max;
else if (var->yres < fbi->mach_info->yres.min)
var->yres = fbi->mach_info->yres.min;
if (var->xres > fbi->mach_info->xres.max)
var->yres = fbi->mach_info->xres.max;
else if (var->xres < fbi->mach_info->xres.min)
var->xres = fbi->mach_info->xres.min;
……
/* 羡慕开始检查bpp（表示用多少位表示一个像素），如果不合法，将其设置正确*/
if (var->bits_per_pixel > fbi->mach_info->bpp.max)
var->bits_per_pixel = fbi->mach_info->bpp.max;
else if (var->bits_per_pixel < fbi->mach_info->bpp.min)
var->bits_per_pixel = fbi->mach_info->bpp.min;
/* 下面的代码根据bpp设置正确的颜色信息，代码略 */
……
}
return 0;
}
4.2.2 s3c2410fb_set_par
该函数的主要工作是重新设置驱动的私有数据信息，主要改变的属性有bpp和行的长度（以字节为单位）。这些属性值其实是存放在fb_fix_screeninfo结构中的，前面说过这些值在运行基本是不会改变的，这些不可改变的值又可分为绝对不能改变和允许改变的两种类型，前一种的例子就是帧缓冲区的起始地址，后一种的例子就是在s3c2410fb_set_par函数中提到的属性。假如应用程序需要修改硬件的显示状态之类的操作，这个函数就显得十分重要。
static int s3c2410fb_set_par(struct fb_info *info)
{
struct s3c2410fb_info *fbi = info->par; //得到私有数据信息
struct fb_var_screeninfo *var = &info->var; //可变的数据属性
switch (var->bits_per_pixel) //根据bpp设置不变属性信息的颜色模式
{
case 16:
fbi->fb->fix.visual = FB_VISUAL_TRUECOLOR; //真彩色
break;
case 1:
fbi->fb->fix.visual = FB_VISUAL_MONO01; // 单色
break;
default:
fbi->fb->fix.visual = FB_VISUAL_PSEUDOCOLOR; //伪彩色
break;
}
fbi->fb->fix.line_length = (var->width*var->bits_per_pixel)/8; //修改行长度信息（以字节为单位），计算方法是一行中的(像素总数 * 表达每个像素的位数)/8。
……
s3c2410fb_activate_var(fbi, var); //该函数实际是设置硬件寄存器，解释略。
return 0;
}
4.2.3 s3c2410fb_blank和s3c2410fb_setcolreg
对于s3c2410fb_blank函数实现的功能非常简单，而且也有较详细的说明，因此对它的说明就省略了。s3c2410fb_setcolreg函数的功能是设置颜色寄存器。它需要6个参数，分别代表寄存器编号，红色，绿色，蓝色，透明和fb_info结构。
static int s3c2410fb_setcolreg(unsigned regno,
unsigned red, unsigned green, unsigned blue,
unsigned transp, struct fb_info *info)
{
struct s3c2410fb_info *fbi = info->par; //得到私有数据信息
unsigned int val;
……
switch (fbi->fb->fix.visual) {
case FB_VISUAL_TRUECOLOR: //真彩色，使用了调色板
/* true-colour, use pseuo-palette */
if (regno < 16) {
u32 *pal = fbi->fb->pseudo_palette;
val = chan_to_field(red, &fbi->fb->var.red); //根据颜色值生成需要的数据
val |= chan_to_field(green, &fbi->fb->var.green);
val |= chan_to_field(blue, &fbi->fb->var.blue);
pal[regno] = val;
}
break;
case FB_VISUAL_PSEUDOCOLOR: //伪彩色
if (regno < 256) {
/* 当前假设为 RGB 5-6-5 模式 */
val = ((red >> 0) & 0xf800);
val |= ((green >> 5) & 0x07e0);
val |= ((blue >> 11) & 0x001f);
writel(val, S3C2410_TFTPAL(regno)); //将此值直接写入寄存器
schedule_palette_update(fbi, regno, val); //相关寄存器
}
break;
default:
return 1; /* unknown type */
}
return 0;
}
到目前为止，整个驱动的主要部分已经解释完毕了。最后还是得提一下中断处理函数s3c2410fb_irq，这个函数实现也比较短，它的主要调用了s3c2410fb_write_palette函数将它的功能是将调色板中的数据显示到LCD上。两个函数的实现也不难，这里就不再赘述。
OK！good bye everyone！see you next time。
