drivers/video/efifb.c

   1 /*
   2  * Framebuffer driver for EFI/UEFI based system
   3  *
   4  * (c) 2006 Edgar Hucek <gimli@dark-green.com>
   5  * Original efi driver written by Gerd Knorr <kraxel@goldbach.in-berlin.de>
   6  *
   7  */
   8
   9 #include <linux/module.h>
  10 #include <linux/kernel.h>
  11 #include <linux/errno.h>
  12 #include <linux/fb.h>
  13 #include <linux/platform_device.h>
  14 #include <linux/screen_info.h>
  15 #include <linux/dmi.h>
  16 #include <linux/pci.h>
  17 #include <video/vga.h>
  18
  19 static struct fb_var_screeninfo efifb_defined __initdata = {
  20         .activate               = FB_ACTIVATE_NOW,
  21         .height                 = -1,
  22         .width                  = -1,
  23         .right_margin           = 32,
  24         .upper_margin           = 16,
  25         .lower_margin           = 4,
  26         .vsync_len              = 4,
  27         .vmode                  = FB_VMODE_NONINTERLACED,
  28 };
  29
  30 static struct fb_fix_screeninfo efifb_fix __initdata = {
  31         .id                     = "EFI VGA",
  32         .type                   = FB_TYPE_PACKED_PIXELS,
  33         .accel                  = FB_ACCEL_NONE,
  34         .visual                 = FB_VISUAL_TRUECOLOR,
  35 };
  36
  37 enum {
  38         M_I17,          /* 17-Inch iMac */
  39         M_I20,          /* 20-Inch iMac */
  40         M_I20_SR,       /* 20-Inch iMac (Santa Rosa) */
  41         M_I24,          /* 24-Inch iMac */
  42         M_MINI,         /* Mac Mini */
  43         M_MB,           /* MacBook */
  44         M_MB_2,         /* MacBook, 2nd rev. */
  45         M_MB_3,         /* MacBook, 3rd rev. */
  46         M_MB_SR,        /* MacBook, 2nd gen, (Santa Rosa) */
  47         M_MBA,          /* MacBook Air */
  48         M_MBP,          /* MacBook Pro */
  49         M_MBP_2,        /* MacBook Pro 2nd gen */
  50         M_MBP_SR,       /* MacBook Pro (Santa Rosa) */
  51         M_MBP_4,        /* MacBook Pro, 4th gen */
  52         M_UNKNOWN       /* placeholder */
  53 };
  54
  55 static struct efifb_dmi_info {
  56         char *optname;
  57         unsigned long base;
  58         int stride;
  59         int width;
  60         int height;
  61 } dmi_list[] = {
  62         [M_I17] = { "i17", 0x80010000, 1472 * 4, 1440, 900 },
  63         [M_I20] = { "i20", 0x80010000, 1728 * 4, 1680, 1050 }, /* guess */
  64         [M_I20_SR] = { "imac7", 0x40010000, 1728 * 4, 1680, 1050 },
  65         [M_I24] = { "i24", 0x80010000, 2048 * 4, 1920, 1200 }, /* guess */
  66         [M_MINI]= { "mini", 0x80000000, 2048 * 4, 1024, 768 },
  67         [M_MB] = { "macbook", 0x80000000, 2048 * 4, 1280, 800 },
  68         [M_MBA] = { "mba", 0x80000000, 2048 * 4, 1280, 800 },
  69         [M_MBP] = { "mbp", 0x80010000, 1472 * 4, 1440, 900 },
  70         [M_MBP_2] = { "mbp2", 0, 0, 0, 0 }, /* placeholder */
  71         [M_MBP_SR] = { "mbp3", 0x80030000, 2048 * 4, 1440, 900 },
  72         [M_MBP_4] = { "mbp4", 0xc0060000, 2048 * 4, 1920, 1200 },
  73         [M_UNKNOWN] = { NULL, 0, 0, 0, 0 }
  74 };
  75
  76 static int set_system(const struct dmi_system_id *id);
  77
  78 #define EFIFB_DMI_SYSTEM_ID(vendor, name, enumid)               \
  79         { set_system, name, {                                   \
  80                 DMI_MATCH(DMI_BIOS_VENDOR, vendor),             \
  81                 DMI_MATCH(DMI_PRODUCT_NAME, name) },            \
  82           &dmi_list[enumid] }
  83
  84 static struct dmi_system_id __initdata dmi_system_table[] = {
  85         EFIFB_DMI_SYSTEM_ID("Apple Computer, Inc.", "iMac4,1", M_I17),
  86         /* At least one of these two will be right; maybe both? */
  87         EFIFB_DMI_SYSTEM_ID("Apple Computer, Inc.", "iMac5,1", M_I20),
  88         EFIFB_DMI_SYSTEM_ID("Apple Inc.", "iMac5,1", M_I20),
  89         /* At least one of these two will be right; maybe both? */
  90         EFIFB_DMI_SYSTEM_ID("Apple Computer, Inc.", "iMac6,1", M_I24),
  91         EFIFB_DMI_SYSTEM_ID("Apple Inc.", "iMac6,1", M_I24),
  92         EFIFB_DMI_SYSTEM_ID("Apple Inc.", "iMac7,1", M_I20_SR),
  93         EFIFB_DMI_SYSTEM_ID("Apple Computer, Inc.", "Macmini1,1", M_MINI),
  94         EFIFB_DMI_SYSTEM_ID("Apple Computer, Inc.", "MacBook1,1", M_MB),
  95         /* At least one of these two will be right; maybe both? */
  96         EFIFB_DMI_SYSTEM_ID("Apple Computer, Inc.", "MacBook2,1", M_MB),
  97         EFIFB_DMI_SYSTEM_ID("Apple Inc.", "MacBook2,1", M_MB),
  98         /* At least one of these two will be right; maybe both? */
  99         EFIFB_DMI_SYSTEM_ID("Apple Computer, Inc.", "MacBook3,1", M_MB),
 100         EFIFB_DMI_SYSTEM_ID("Apple Inc.", "MacBook3,1", M_MB),
 101         EFIFB_DMI_SYSTEM_ID("Apple Inc.", "MacBook4,1", M_MB),
 102         EFIFB_DMI_SYSTEM_ID("Apple Inc.", "MacBookAir1,1", M_MBA),
 103         EFIFB_DMI_SYSTEM_ID("Apple Computer, Inc.", "MacBookPro1,1", M_MBP),
 104         EFIFB_DMI_SYSTEM_ID("Apple Computer, Inc.", "MacBookPro2,1", M_MBP_2),
 105         EFIFB_DMI_SYSTEM_ID("Apple Inc.", "MacBookPro2,1", M_MBP_2),
 106         EFIFB_DMI_SYSTEM_ID("Apple Computer, Inc.", "MacBookPro3,1", M_MBP_SR),
 107         EFIFB_DMI_SYSTEM_ID("Apple Inc.", "MacBookPro3,1", M_MBP_SR),
 108         EFIFB_DMI_SYSTEM_ID("Apple Inc.", "MacBookPro4,1", M_MBP_4),
 109         {},
 110 };
 111
 112 static int set_system(const struct dmi_system_id *id)
 113 {
 114         struct efifb_dmi_info *info = id->driver_data;
 115         if (info->base == 0)
 116                 return 0;
 117
 118         printk(KERN_INFO "efifb: dmi detected %s - framebuffer at %p "
 119                          "(%dx%d, stride %d)\n", id->ident,
 120                          (void *)info->base, info->width, info->height,
 121                          info->stride);
 122
 123         /* Trust the bootloader over the DMI tables */
 124         if (screen_info.lfb_base == 0) {
 125 #if defined(CONFIG_PCI)
 126                 struct pci_dev *dev = NULL;
 127                 int found_bar = 0;
 128 #endif
 129                 screen_info.lfb_base = info->base;
 130
 131 #if defined(CONFIG_PCI)
 132                 /* make sure that the address in the table is actually on a
 133                  * VGA device's PCI BAR */
 134
 135                 for_each_pci_dev(dev) {
 136                         int i;
 137                         if ((dev->class >> 8) != PCI_CLASS_DISPLAY_VGA)
 138                                 continue;
 139                         for (i = 0; i < DEVICE_COUNT_RESOURCE; i++) {
 140                                 resource_size_t start, end;
 141
 142                                 start = pci_resource_start(dev, i);
 143                                 if (start == 0)
 144                                         break;
 145                                 end = pci_resource_end(dev, i);
 146                                 if (screen_info.lfb_base >= start &&
 147                                                 screen_info.lfb_base < end) {
 148                                         found_bar = 1;
 149                                 }
 150                         }
 151                 }
 152                 if (!found_bar)
 153                         screen_info.lfb_base = 0;
 154 #endif
 155         }
 156         if (screen_info.lfb_base) {
 157                 if (screen_info.lfb_linelength == 0)
 158                         screen_info.lfb_linelength = info->stride;
 159                 if (screen_info.lfb_width == 0)
 160                         screen_info.lfb_width = info->width;
 161                 if (screen_info.lfb_height == 0)
 162                         screen_info.lfb_height = info->height;
 163                 if (screen_info.orig_video_isVGA == 0)
 164                         screen_info.orig_video_isVGA = VIDEO_TYPE_EFI;
 165         } else {
 166                 screen_info.lfb_linelength = 0;
 167                 screen_info.lfb_width = 0;
 168                 screen_info.lfb_height = 0;
 169                 screen_info.orig_video_isVGA = 0;
 170                 return 0;
 171         }
 172         return 1;
 173 }
 174
 175 static int efifb_setcolreg(unsigned regno, unsigned red, unsigned green,
 176                            unsigned blue, unsigned transp,
 177                            struct fb_info *info)
 178 {
 179         /*
 180          *  Set a single color register. The values supplied are
 181          *  already rounded down to the hardware's capabilities
 182          *  (according to the entries in the `var' structure). Return
 183          *  != 0 for invalid regno.
 184          */
 185
 186         if (regno >= info->cmap.len)
 187                 return 1;
 188
 189         if (regno < 16) {
 190                 red   >>= 8;
 191                 green >>= 8;
 192                 blue  >>= 8;
 193                 ((u32 *)(info->pseudo_palette))[regno] =
 194                         (red   << info->var.red.offset)   |
 195                         (green << info->var.green.offset) |
 196                         (blue  << info->var.blue.offset);
 197         }
 198         return 0;
 199 }
 200
 201 static void efifb_destroy(struct fb_info *info)
 202 {
 203         if (info->screen_base)
 204                 iounmap(info->screen_base);
 205         release_mem_region(info->aperture_base, info->aperture_size);
 206         framebuffer_release(info);
 207 }
 208
 209 static struct fb_ops efifb_ops = {
 210         .owner          = THIS_MODULE,
 211         .fb_destroy     = efifb_destroy,
 212         .fb_setcolreg   = efifb_setcolreg,
 213         .fb_fillrect    = cfb_fillrect,
 214         .fb_copyarea    = cfb_copyarea,
 215         .fb_imageblit   = cfb_imageblit,
 216 };
 217
 218 static int __init efifb_setup(char *options)
 219 {
 220         char *this_opt;
 221         int i;
 222
 223         if (!options || !*options)
 224                 return 0;
 225
 226         while ((this_opt = strsep(&options, ",")) != NULL) {
 227                 if (!*this_opt) continue;
 228
 229                 for (i = 0; i < M_UNKNOWN; i++) {
 230                         if (!strcmp(this_opt, dmi_list[i].optname) &&
 231                                         dmi_list[i].base != 0) {
 232                                 screen_info.lfb_base = dmi_list[i].base;
 233                                 screen_info.lfb_linelength = dmi_list[i].stride;
 234                                 screen_info.lfb_width = dmi_list[i].width;
 235                                 screen_info.lfb_height = dmi_list[i].height;
 236                         }
 237                 }
 238                 if (!strncmp(this_opt, "base:", 5))
 239                         screen_info.lfb_base = simple_strtoul(this_opt+5, NULL, 0);
 240                 else if (!strncmp(this_opt, "stride:", 7))
 241                         screen_info.lfb_linelength = simple_strtoul(this_opt+7, NULL, 0) * 4;
 242                 else if (!strncmp(this_opt, "height:", 7))
 243                         screen_info.lfb_height = simple_strtoul(this_opt+7, NULL, 0);
 244                 else if (!strncmp(this_opt, "width:", 6))
 245                         screen_info.lfb_width = simple_strtoul(this_opt+6, NULL, 0);
 246         }
 247         return 0;
 248 }
 249
 250 static int __init efifb_probe(struct platform_device *dev)
 251 {
 252         struct fb_info *info;
 253         int err;
 254         unsigned int size_vmode;
 255         unsigned int size_remap;
 256         unsigned int size_total;
 257         int request_succeeded = 0;
 258
 259         if (!screen_info.lfb_depth)
 260                 screen_info.lfb_depth = 32;
 261         if (!screen_info.pages)
 262                 screen_info.pages = 1;
 263         if (!screen_info.lfb_base) {
 264                 printk(KERN_DEBUG "efifb: invalid framebuffer address\n");
 265                 return -ENODEV;
 266         }
 267         printk(KERN_INFO "efifb: probing for efifb\n");
 268
 269         /* just assume they're all unset if any are */
 270         if (!screen_info.blue_size) {
 271                 screen_info.blue_size = 8;
 272                 screen_info.blue_pos = 0;
 273                 screen_info.green_size = 8;
 274                 screen_info.green_pos = 8;
 275                 screen_info.red_size = 8;
 276                 screen_info.red_pos = 16;
 277                 screen_info.rsvd_size = 8;
 278                 screen_info.rsvd_pos = 24;
 279         }
 280
 281         efifb_fix.smem_start = screen_info.lfb_base;
 282         efifb_defined.bits_per_pixel = screen_info.lfb_depth;
 283         efifb_defined.xres = screen_info.lfb_width;
 284         efifb_defined.yres = screen_info.lfb_height;
 285         efifb_fix.line_length = screen_info.lfb_linelength;
 286
 287         /*   size_vmode -- that is the amount of memory needed for the
 288          *                 used video mode, i.e. the minimum amount of
 289          *                 memory we need. */
 290         size_vmode = efifb_defined.yres * efifb_fix.line_length;
 291
 292         /*   size_total -- all video memory we have. Used for
 293          *                 entries, ressource allocation and bounds
 294          *                 checking. */
 295         size_total = screen_info.lfb_size;
 296         if (size_total < size_vmode)
 297                 size_total = size_vmode;
 298
 299         /*   size_remap -- the amount of video memory we are going to
 300          *                 use for efifb.  With modern cards it is no
 301          *                 option to simply use size_total as that
 302          *                 wastes plenty of kernel address space. */
 303         size_remap  = size_vmode * 2;
 304         if (size_remap > size_total)
 305                 size_remap = size_total;
 306         if (size_remap % PAGE_SIZE)
 307                 size_remap += PAGE_SIZE - (size_remap % PAGE_SIZE);
 308         efifb_fix.smem_len = size_remap;
 309
 310         if (request_mem_region(efifb_fix.smem_start, size_remap, "efifb")) {
 311                 request_succeeded = 1;
 312         } else {
 313                 /* We cannot make this fatal. Sometimes this comes from magic
 314                    spaces our resource handlers simply don't know about */
 315                 printk(KERN_WARNING
 316                        "efifb: cannot reserve video memory at 0x%lx\n",
 317                         efifb_fix.smem_start);
 318         }
 319
 320         info = framebuffer_alloc(sizeof(u32) * 16, &dev->dev);
 321         if (!info) {
 322                 printk(KERN_ERR "efifb: cannot allocate framebuffer\n");
 323                 err = -ENOMEM;
 324                 goto err_release_mem;
 325         }
 326         info->pseudo_palette = info->par;
 327         info->par = NULL;
 328
 329         info->aperture_base = efifb_fix.smem_start;
 330         info->aperture_size = size_remap;
 331
 332         info->screen_base = ioremap(efifb_fix.smem_start, efifb_fix.smem_len);
 333         if (!info->screen_base) {
 334                 printk(KERN_ERR "efifb: abort, cannot ioremap video memory "
 335                                 "0x%x @ 0x%lx\n",
 336                         efifb_fix.smem_len, efifb_fix.smem_start);
 337                 err = -EIO;
 338                 goto err_release_fb;
 339         }
 340
 341         printk(KERN_INFO "efifb: framebuffer at 0x%lx, mapped to 0x%p, "
 342                "using %dk, total %dk\n",
 343                efifb_fix.smem_start, info->screen_base,
 344                size_remap/1024, size_total/1024);
 345         printk(KERN_INFO "efifb: mode is %dx%dx%d, linelength=%d, pages=%d\n",
 346                efifb_defined.xres, efifb_defined.yres,
 347                efifb_defined.bits_per_pixel, efifb_fix.line_length,
 348                screen_info.pages);
 349
 350         efifb_defined.xres_virtual = efifb_defined.xres;
 351         efifb_defined.yres_virtual = efifb_fix.smem_len /
 352                                         efifb_fix.line_length;
 353         printk(KERN_INFO "efifb: scrolling: redraw\n");
 354         efifb_defined.yres_virtual = efifb_defined.yres;
 355
 356         /* some dummy values for timing to make fbset happy */
 357         efifb_defined.pixclock     = 10000000 / efifb_defined.xres *
 358                                         1000 / efifb_defined.yres;
 359         efifb_defined.left_margin  = (efifb_defined.xres / 8) & 0xf8;
 360         efifb_defined.hsync_len    = (efifb_defined.xres / 8) & 0xf8;
 361
 362         efifb_defined.red.offset    = screen_info.red_pos;
 363         efifb_defined.red.length    = screen_info.red_size;
 364         efifb_defined.green.offset  = screen_info.green_pos;
 365         efifb_defined.green.length  = screen_info.green_size;
 366         efifb_defined.blue.offset   = screen_info.blue_pos;
 367         efifb_defined.blue.length   = screen_info.blue_size;
 368         efifb_defined.transp.offset = screen_info.rsvd_pos;
 369         efifb_defined.transp.length = screen_info.rsvd_size;
 370
 371         printk(KERN_INFO "efifb: %s: "
 372                "size=%d:%d:%d:%d, shift=%d:%d:%d:%d\n",
 373                "Truecolor",
 374                screen_info.rsvd_size,
 375                screen_info.red_size,
 376                screen_info.green_size,
 377                screen_info.blue_size,
 378                screen_info.rsvd_pos,
 379                screen_info.red_pos,
 380                screen_info.green_pos,
 381                screen_info.blue_pos);
 382
 383         efifb_fix.ypanstep  = 0;
 384         efifb_fix.ywrapstep = 0;
 385
 386         info->fbops = &efifb_ops;
 387         info->var = efifb_defined;
 388         info->fix = efifb_fix;
 389         info->flags = FBINFO_FLAG_DEFAULT | FBINFO_MISC_FIRMWARE;
 390
 391         if ((err = fb_alloc_cmap(&info->cmap, 256, 0)) < 0) {
 392                 printk(KERN_ERR "efifb: cannot allocate colormap\n");
 393                 goto err_unmap;
 394         }
 395         if ((err = register_framebuffer(info)) < 0) {
 396                 printk(KERN_ERR "efifb: cannot register framebuffer\n");
 397                 goto err_fb_dealoc;
 398         }
 399         printk(KERN_INFO "fb%d: %s frame buffer device\n",
 400                 info->node, info->fix.id);
 401         return 0;
 402
 403 err_fb_dealoc:
 404         fb_dealloc_cmap(&info->cmap);
 405 err_unmap:
 406         iounmap(info->screen_base);
 407 err_release_fb:
 408         framebuffer_release(info);
 409 err_release_mem:
 410         if (request_succeeded)
 411                 release_mem_region(efifb_fix.smem_start, size_total);
 412         return err;
 413 }
 414
 415 static struct platform_driver efifb_driver = {
 416         .probe  = efifb_probe,
 417         .driver = {
 418                 .name   = "efifb",
 419         },
 420 };
 421
 422 static struct platform_device efifb_device = {
 423         .name   = "efifb",
 424 };
 425
 426 static int __init efifb_init(void)
 427 {
 428         int ret;
 429         char *option = NULL;
 430
 431         dmi_check_system(dmi_system_table);
 432
 433         if (screen_info.orig_video_isVGA != VIDEO_TYPE_EFI)
 434                 return -ENODEV;
 435
 436         if (fb_get_options("efifb", &option))
 437                 return -ENODEV;
 438         efifb_setup(option);
 439
 440         /* We don't get linelength from UGA Draw Protocol, only from
 441          * EFI Graphics Protocol.  So if it's not in DMI, and it's not
 442          * passed in from the user, we really can't use the framebuffer.
 443          */
 444         if (!screen_info.lfb_linelength)
 445                 return -ENODEV;
 446
 447         ret = platform_driver_register(&efifb_driver);
 448
 449         if (!ret) {
 450                 ret = platform_device_register(&efifb_device);
 451                 if (ret)
 452                         platform_driver_unregister(&efifb_driver);
 453         }
 454         return ret;
 455 }
 456 module_init(efifb_init);
 457
 458 MODULE_LICENSE("GPL");