drivers/video/fbdev/vfb.c

   1 /*
   2  *  linux/drivers/video/vfb.c -- Virtual frame buffer device
   3  *
   4  *      Copyright (C) 2002 James Simmons
   5  *
   6  *      Copyright (C) 1997 Geert Uytterhoeven
   7  *
   8  *  This file is subject to the terms and conditions of the GNU General Public
   9  *  License. See the file COPYING in the main directory of this archive for
  10  *  more details.
  11  */
  12
  13 #include <linux/module.h>
  14 #include <linux/kernel.h>
  15 #include <linux/errno.h>
  16 #include <linux/string.h>
  17 #include <linux/mm.h>
  18 #include <linux/vmalloc.h>
  19 #include <linux/delay.h>
  20 #include <linux/interrupt.h>
  21 #include <linux/platform_device.h>
  22
  23 #include <linux/fb.h>
  24 #include <linux/init.h>
  25
  26     /*
  27      *  RAM we reserve for the frame buffer. This defines the maximum screen
  28      *  size
  29      *
  30      *  The default can be overridden if the driver is compiled as a module
  31      */
  32
  33 #define VIDEOMEMSIZE    (1*1024*1024)   /* 1 MB */
  34
  35 static void *videomemory;
  36 static u_long videomemorysize = VIDEOMEMSIZE;
  37 module_param(videomemorysize, ulong, 0);
  38
  39 /**********************************************************************
  40  *
  41  * Memory management
  42  *
  43  **********************************************************************/
  44 static void *rvmalloc(unsigned long size)
  45 {
  46         void *mem;
  47         unsigned long adr;
  48
  49         size = PAGE_ALIGN(size);
  50         mem = vmalloc_32(size);
  51         if (!mem)
  52                 return NULL;
  53
  54         /*
  55          * VFB must clear memory to prevent kernel info
  56          * leakage into userspace
  57          * VGA-based drivers MUST NOT clear memory if
  58          * they want to be able to take over vgacon
  59          */
  60
  61         memset(mem, 0, size);
  62         adr = (unsigned long) mem;
  63         while (size > 0) {
  64                 SetPageReserved(vmalloc_to_page((void *)adr));
  65                 adr += PAGE_SIZE;
  66                 size -= PAGE_SIZE;
  67         }
  68
  69         return mem;
  70 }
  71
  72 static void rvfree(void *mem, unsigned long size)
  73 {
  74         unsigned long adr;
  75
  76         if (!mem)
  77                 return;
  78
  79         adr = (unsigned long) mem;
  80         while ((long) size > 0) {
  81                 ClearPageReserved(vmalloc_to_page((void *)adr));
  82                 adr += PAGE_SIZE;
  83                 size -= PAGE_SIZE;
  84         }
  85         vfree(mem);
  86 }
  87
  88 static struct fb_var_screeninfo vfb_default = {
  89         .xres =         640,
  90         .yres =         480,
  91         .xres_virtual = 640,
  92         .yres_virtual = 480,
  93         .bits_per_pixel = 8,
  94         .red =          { 0, 8, 0 },
  95         .green =        { 0, 8, 0 },
  96         .blue =         { 0, 8, 0 },
  97         .activate =     FB_ACTIVATE_TEST,
  98         .height =       -1,
  99         .width =        -1,
 100         .pixclock =     20000,
 101         .left_margin =  64,
 102         .right_margin = 64,
 103         .upper_margin = 32,
 104         .lower_margin = 32,
 105         .hsync_len =    64,
 106         .vsync_len =    2,
 107         .vmode =        FB_VMODE_NONINTERLACED,
 108 };
 109
 110 static struct fb_fix_screeninfo vfb_fix = {
 111         .id =           "Virtual FB",
 112         .type =         FB_TYPE_PACKED_PIXELS,
 113         .visual =       FB_VISUAL_PSEUDOCOLOR,
 114         .xpanstep =     1,
 115         .ypanstep =     1,
 116         .ywrapstep =    1,
 117         .accel =        FB_ACCEL_NONE,
 118 };
 119
 120 static bool vfb_enable __initdata = 0;  /* disabled by default */
 121 module_param(vfb_enable, bool, 0);
 122
 123 static int vfb_check_var(struct fb_var_screeninfo *var,
 124                          struct fb_info *info);
 125 static int vfb_set_par(struct fb_info *info);
 126 static int vfb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
 127                          u_int transp, struct fb_info *info);
 128 static int vfb_pan_display(struct fb_var_screeninfo *var,
 129                            struct fb_info *info);
 130 static int vfb_mmap(struct fb_info *info,
 131                     struct vm_area_struct *vma);
 132
 133 static struct fb_ops vfb_ops = {
 134         .fb_read        = fb_sys_read,
 135         .fb_write       = fb_sys_write,
 136         .fb_check_var   = vfb_check_var,
 137         .fb_set_par     = vfb_set_par,
 138         .fb_setcolreg   = vfb_setcolreg,
 139         .fb_pan_display = vfb_pan_display,
 140         .fb_fillrect    = sys_fillrect,
 141         .fb_copyarea    = sys_copyarea,
 142         .fb_imageblit   = sys_imageblit,
 143         .fb_mmap        = vfb_mmap,
 144 };
 145
 146     /*
 147      *  Internal routines
 148      */
 149
 150 static u_long get_line_length(int xres_virtual, int bpp)
 151 {
 152         u_long length;
 153
 154         length = xres_virtual * bpp;
 155         length = (length + 31) & ~31;
 156         length >>= 3;
 157         return (length);
 158 }
 159
 160     /*
 161      *  Setting the video mode has been split into two parts.
 162      *  First part, xxxfb_check_var, must not write anything
 163      *  to hardware, it should only verify and adjust var.
 164      *  This means it doesn't alter par but it does use hardware
 165      *  data from it to check this var.
 166      */
 167
 168 static int vfb_check_var(struct fb_var_screeninfo *var,
 169                          struct fb_info *info)
 170 {
 171         u_long line_length;
 172
 173         /*
 174          *  FB_VMODE_CONUPDATE and FB_VMODE_SMOOTH_XPAN are equal!
 175          *  as FB_VMODE_SMOOTH_XPAN is only used internally
 176          */
 177
 178         if (var->vmode & FB_VMODE_CONUPDATE) {
 179                 var->vmode |= FB_VMODE_YWRAP;
 180                 var->xoffset = info->var.xoffset;
 181                 var->yoffset = info->var.yoffset;
 182         }
 183
 184         /*
 185          *  Some very basic checks
 186          */
 187         if (!var->xres)
 188                 var->xres = 1;
 189         if (!var->yres)
 190                 var->yres = 1;
 191         if (var->xres > var->xres_virtual)
 192                 var->xres_virtual = var->xres;
 193         if (var->yres > var->yres_virtual)
 194                 var->yres_virtual = var->yres;
 195         if (var->bits_per_pixel <= 1)
 196                 var->bits_per_pixel = 1;
 197         else if (var->bits_per_pixel <= 8)
 198                 var->bits_per_pixel = 8;
 199         else if (var->bits_per_pixel <= 16)
 200                 var->bits_per_pixel = 16;
 201         else if (var->bits_per_pixel <= 24)
 202                 var->bits_per_pixel = 24;
 203         else if (var->bits_per_pixel <= 32)
 204                 var->bits_per_pixel = 32;
 205         else
 206                 return -EINVAL;
 207
 208         if (var->xres_virtual < var->xoffset + var->xres)
 209                 var->xres_virtual = var->xoffset + var->xres;
 210         if (var->yres_virtual < var->yoffset + var->yres)
 211                 var->yres_virtual = var->yoffset + var->yres;
 212
 213         /*
 214          *  Memory limit
 215          */
 216         line_length =
 217             get_line_length(var->xres_virtual, var->bits_per_pixel);
 218         if (line_length * var->yres_virtual > videomemorysize)
 219                 return -ENOMEM;
 220
 221         /*
 222          * Now that we checked it we alter var. The reason being is that the video
 223          * mode passed in might not work but slight changes to it might make it
 224          * work. This way we let the user know what is acceptable.
 225          */
 226         switch (var->bits_per_pixel) {
 227         case 1:
 228         case 8:
 229                 var->red.offset = 0;
 230                 var->red.length = 8;
 231                 var->green.offset = 0;
 232                 var->green.length = 8;
 233                 var->blue.offset = 0;
 234                 var->blue.length = 8;
 235                 var->transp.offset = 0;
 236                 var->transp.length = 0;
 237                 break;
 238         case 16:                /* RGBA 5551 */
 239                 if (var->transp.length) {
 240                         var->red.offset = 0;
 241                         var->red.length = 5;
 242                         var->green.offset = 5;
 243                         var->green.length = 5;
 244                         var->blue.offset = 10;
 245                         var->blue.length = 5;
 246                         var->transp.offset = 15;
 247                         var->transp.length = 1;
 248                 } else {        /* RGB 565 */
 249                         var->red.offset = 0;
 250                         var->red.length = 5;
 251                         var->green.offset = 5;
 252                         var->green.length = 6;
 253                         var->blue.offset = 11;
 254                         var->blue.length = 5;
 255                         var->transp.offset = 0;
 256                         var->transp.length = 0;
 257                 }
 258                 break;
 259         case 24:                /* RGB 888 */
 260                 var->red.offset = 0;
 261                 var->red.length = 8;
 262                 var->green.offset = 8;
 263                 var->green.length = 8;
 264                 var->blue.offset = 16;
 265                 var->blue.length = 8;
 266                 var->transp.offset = 0;
 267                 var->transp.length = 0;
 268                 break;
 269         case 32:                /* RGBA 8888 */
 270                 var->red.offset = 0;
 271                 var->red.length = 8;
 272                 var->green.offset = 8;
 273                 var->green.length = 8;
 274                 var->blue.offset = 16;
 275                 var->blue.length = 8;
 276                 var->transp.offset = 24;
 277                 var->transp.length = 8;
 278                 break;
 279         }
 280         var->red.msb_right = 0;
 281         var->green.msb_right = 0;
 282         var->blue.msb_right = 0;
 283         var->transp.msb_right = 0;
 284
 285         return 0;
 286 }
 287
 288 /* This routine actually sets the video mode. It's in here where we
 289  * the hardware state info->par and fix which can be affected by the
 290  * change in par. For this driver it doesn't do much.
 291  */
 292 static int vfb_set_par(struct fb_info *info)
 293 {
 294         switch (info->var.bits_per_pixel) {
 295         case 1:
 296                 info->fix.visual = FB_VISUAL_MONO01;
 297                 break;
 298         case 8:
 299                 info->fix.visual = FB_VISUAL_PSEUDOCOLOR;
 300                 break;
 301         case 16:
 302         case 24:
 303         case 32:
 304                 info->fix.visual = FB_VISUAL_TRUECOLOR;
 305                 break;
 306         }
 307
 308         info->fix.line_length = get_line_length(info->var.xres_virtual,
 309                                                 info->var.bits_per_pixel);
 310
 311         return 0;
 312 }
 313
 314     /*
 315      *  Set a single color register. The values supplied are already
 316      *  rounded down to the hardware's capabilities (according to the
 317      *  entries in the var structure). Return != 0 for invalid regno.
 318      */
 319
 320 static int vfb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
 321                          u_int transp, struct fb_info *info)
 322 {
 323         if (regno >= 256)       /* no. of hw registers */
 324                 return 1;
 325         /*
 326          * Program hardware... do anything you want with transp
 327          */
 328
 329         /* grayscale works only partially under directcolor */
 330         if (info->var.grayscale) {
 331                 /* grayscale = 0.30*R + 0.59*G + 0.11*B */
 332                 red = green = blue =
 333                     (red * 77 + green * 151 + blue * 28) >> 8;
 334         }
 335
 336         /* Directcolor:
 337          *   var->{color}.offset contains start of bitfield
 338          *   var->{color}.length contains length of bitfield
 339          *   {hardwarespecific} contains width of RAMDAC
 340          *   cmap[X] is programmed to (X << red.offset) | (X << green.offset) | (X << blue.offset)
 341          *   RAMDAC[X] is programmed to (red, green, blue)
 342          *
 343          * Pseudocolor:
 344          *    var->{color}.offset is 0 unless the palette index takes less than
 345          *                        bits_per_pixel bits and is stored in the upper
 346          *                        bits of the pixel value
 347          *    var->{color}.length is set so that 1 << length is the number of available
 348          *                        palette entries
 349          *    cmap is not used
 350          *    RAMDAC[X] is programmed to (red, green, blue)
 351          *
 352          * Truecolor:
 353          *    does not use DAC. Usually 3 are present.
 354          *    var->{color}.offset contains start of bitfield
 355          *    var->{color}.length contains length of bitfield
 356          *    cmap is programmed to (red << red.offset) | (green << green.offset) |
 357          *                      (blue << blue.offset) | (transp << transp.offset)
 358          *    RAMDAC does not exist
 359          */
 360 #define CNVT_TOHW(val,width) ((((val)<<(width))+0x7FFF-(val))>>16)
 361         switch (info->fix.visual) {
 362         case FB_VISUAL_TRUECOLOR:
 363         case FB_VISUAL_PSEUDOCOLOR:
 364                 red = CNVT_TOHW(red, info->var.red.length);
 365                 green = CNVT_TOHW(green, info->var.green.length);
 366                 blue = CNVT_TOHW(blue, info->var.blue.length);
 367                 transp = CNVT_TOHW(transp, info->var.transp.length);
 368                 break;
 369         case FB_VISUAL_DIRECTCOLOR:
 370                 red = CNVT_TOHW(red, 8);        /* expect 8 bit DAC */
 371                 green = CNVT_TOHW(green, 8);
 372                 blue = CNVT_TOHW(blue, 8);
 373                 /* hey, there is bug in transp handling... */
 374                 transp = CNVT_TOHW(transp, 8);
 375                 break;
 376         }
 377 #undef CNVT_TOHW
 378         /* Truecolor has hardware independent palette */
 379         if (info->fix.visual == FB_VISUAL_TRUECOLOR) {
 380                 u32 v;
 381
 382                 if (regno >= 16)
 383                         return 1;
 384
 385                 v = (red << info->var.red.offset) |
 386                     (green << info->var.green.offset) |
 387                     (blue << info->var.blue.offset) |
 388                     (transp << info->var.transp.offset);
 389                 switch (info->var.bits_per_pixel) {
 390                 case 8:
 391                         break;
 392                 case 16:
 393                         ((u32 *) (info->pseudo_palette))[regno] = v;
 394                         break;
 395                 case 24:
 396                 case 32:
 397                         ((u32 *) (info->pseudo_palette))[regno] = v;
 398                         break;
 399                 }
 400                 return 0;
 401         }
 402         return 0;
 403 }
 404
 405     /*
 406      *  Pan or Wrap the Display
 407      *
 408      *  This call looks only at xoffset, yoffset and the FB_VMODE_YWRAP flag
 409      */
 410
 411 static int vfb_pan_display(struct fb_var_screeninfo *var,
 412                            struct fb_info *info)
 413 {
 414         if (var->vmode & FB_VMODE_YWRAP) {
 415                 if (var->yoffset >= info->var.yres_virtual ||
 416                     var->xoffset)
 417                         return -EINVAL;
 418         } else {
 419                 if (var->xoffset + info->var.xres > info->var.xres_virtual ||
 420                     var->yoffset + info->var.yres > info->var.yres_virtual)
 421                         return -EINVAL;
 422         }
 423         info->var.xoffset = var->xoffset;
 424         info->var.yoffset = var->yoffset;
 425         if (var->vmode & FB_VMODE_YWRAP)
 426                 info->var.vmode |= FB_VMODE_YWRAP;
 427         else
 428                 info->var.vmode &= ~FB_VMODE_YWRAP;
 429         return 0;
 430 }
 431
 432     /*
 433      *  Most drivers don't need their own mmap function
 434      */
 435
 436 static int vfb_mmap(struct fb_info *info,
 437                     struct vm_area_struct *vma)
 438 {
 439         unsigned long start = vma->vm_start;
 440         unsigned long size = vma->vm_end - vma->vm_start;
 441         unsigned long offset = vma->vm_pgoff << PAGE_SHIFT;
 442         unsigned long page, pos;
 443
 444         if (vma->vm_pgoff > (~0UL >> PAGE_SHIFT))
 445                 return -EINVAL;
 446         if (size > info->fix.smem_len)
 447                 return -EINVAL;
 448         if (offset > info->fix.smem_len - size)
 449                 return -EINVAL;
 450
 451         pos = (unsigned long)info->fix.smem_start + offset;
 452
 453         while (size > 0) {
 454                 page = vmalloc_to_pfn((void *)pos);
 455                 if (remap_pfn_range(vma, start, page, PAGE_SIZE, PAGE_SHARED)) {
 456                         return -EAGAIN;
 457                 }
 458                 start += PAGE_SIZE;
 459                 pos += PAGE_SIZE;
 460                 if (size > PAGE_SIZE)
 461                         size -= PAGE_SIZE;
 462                 else
 463                         size = 0;
 464         }
 465
 466         return 0;
 467
 468 }
 469
 470 #ifndef MODULE
 471 /*
 472  * The virtual framebuffer driver is only enabled if explicitly
 473  * requested by passing 'video=vfb:' (or any actual options).
 474  */
 475 static int __init vfb_setup(char *options)
 476 {
 477         char *this_opt;
 478
 479         vfb_enable = 0;
 480
 481         if (!options)
 482                 return 1;
 483
 484         vfb_enable = 1;
 485
 486         if (!*options)
 487                 return 1;
 488
 489         while ((this_opt = strsep(&options, ",")) != NULL) {
 490                 if (!*this_opt)
 491                         continue;
 492                 /* Test disable for backwards compatibility */
 493                 if (!strcmp(this_opt, "disable"))
 494                         vfb_enable = 0;
 495         }
 496         return 1;
 497 }
 498 #endif  /*  MODULE  */
 499
 500     /*
 501      *  Initialisation
 502      */
 503
 504 static int vfb_probe(struct platform_device *dev)
 505 {
 506         struct fb_info *info;
 507         int retval = -ENOMEM;
 508
 509         /*
 510          * For real video cards we use ioremap.
 511          */
 512         if (!(videomemory = rvmalloc(videomemorysize)))
 513                 return retval;
 514
 515         info = framebuffer_alloc(sizeof(u32) * 256, &dev->dev);
 516         if (!info)
 517                 goto err;
 518
 519         info->screen_base = (char __iomem *)videomemory;
 520         info->fbops = &vfb_ops;
 521
 522         retval = fb_find_mode(&info->var, info, NULL,
 523                               NULL, 0, NULL, 8);
 524
 525         if (!retval || (retval == 4))
 526                 info->var = vfb_default;
 527         vfb_fix.smem_start = (unsigned long) videomemory;
 528         vfb_fix.smem_len = videomemorysize;
 529         info->fix = vfb_fix;
 530         info->pseudo_palette = info->par;
 531         info->par = NULL;
 532         info->flags = FBINFO_FLAG_DEFAULT;
 533
 534         retval = fb_alloc_cmap(&info->cmap, 256, 0);
 535         if (retval < 0)
 536                 goto err1;
 537
 538         retval = register_framebuffer(info);
 539         if (retval < 0)
 540                 goto err2;
 541         platform_set_drvdata(dev, info);
 542
 543         vfb_set_par(info);
 544
 545         fb_info(info, "Virtual frame buffer device, using %ldK of video memory\n",
 546                 videomemorysize >> 10);
 547         return 0;
 548 err2:
 549         fb_dealloc_cmap(&info->cmap);
 550 err1:
 551         framebuffer_release(info);
 552 err:
 553         rvfree(videomemory, videomemorysize);
 554         return retval;
 555 }
 556
 557 static int vfb_remove(struct platform_device *dev)
 558 {
 559         struct fb_info *info = platform_get_drvdata(dev);
 560
 561         if (info) {
 562                 unregister_framebuffer(info);
 563                 rvfree(videomemory, videomemorysize);
 564                 fb_dealloc_cmap(&info->cmap);
 565                 framebuffer_release(info);
 566         }
 567         return 0;
 568 }
 569
 570 static struct platform_driver vfb_driver = {
 571         .probe  = vfb_probe,
 572         .remove = vfb_remove,
 573         .driver = {
 574                 .name   = "vfb",
 575         },
 576 };
 577
 578 static struct platform_device *vfb_device;
 579
 580 static int __init vfb_init(void)
 581 {
 582         int ret = 0;
 583
 584 #ifndef MODULE
 585         char *option = NULL;
 586
 587         if (fb_get_options("vfb", &option))
 588                 return -ENODEV;
 589         vfb_setup(option);
 590 #endif
 591
 592         if (!vfb_enable)
 593                 return -ENXIO;
 594
 595         ret = platform_driver_register(&vfb_driver);
 596
 597         if (!ret) {
 598                 vfb_device = platform_device_alloc("vfb", 0);
 599
 600                 if (vfb_device)
 601                         ret = platform_device_add(vfb_device);
 602                 else
 603                         ret = -ENOMEM;
 604
 605                 if (ret) {
 606                         platform_device_put(vfb_device);
 607                         platform_driver_unregister(&vfb_driver);
 608                 }
 609         }
 610
 611         return ret;
 612 }
 613
 614 module_init(vfb_init);
 615
 616 #ifdef MODULE
 617 static void __exit vfb_exit(void)
 618 {
 619         platform_device_unregister(vfb_device);
 620         platform_driver_unregister(&vfb_driver);
 621 }
 622
 623 module_exit(vfb_exit);
 624
 625 MODULE_LICENSE("GPL");
 626 #endif                          /* MODULE */