regulator: fix header file missing kernel-doc
[linux-2.6] / 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
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 -ENODEV;
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                 screen_info.lfb_base = info->base;
126         if (screen_info.lfb_linelength == 0)
127                 screen_info.lfb_linelength = info->stride;
128         if (screen_info.lfb_width == 0)
129                 screen_info.lfb_width = info->width;
130         if (screen_info.lfb_height == 0)
131                 screen_info.lfb_height = info->height;
132         if (screen_info.orig_video_isVGA == 0)
133                 screen_info.orig_video_isVGA = VIDEO_TYPE_EFI;
134
135         return 0;
136 }
137
138 static int efifb_setcolreg(unsigned regno, unsigned red, unsigned green,
139                            unsigned blue, unsigned transp,
140                            struct fb_info *info)
141 {
142         /*
143          *  Set a single color register. The values supplied are
144          *  already rounded down to the hardware's capabilities
145          *  (according to the entries in the `var' structure). Return
146          *  != 0 for invalid regno.
147          */
148
149         if (regno >= info->cmap.len)
150                 return 1;
151
152         if (regno < 16) {
153                 red   >>= 8;
154                 green >>= 8;
155                 blue  >>= 8;
156                 ((u32 *)(info->pseudo_palette))[regno] =
157                         (red   << info->var.red.offset)   |
158                         (green << info->var.green.offset) |
159                         (blue  << info->var.blue.offset);
160         }
161         return 0;
162 }
163
164 static struct fb_ops efifb_ops = {
165         .owner          = THIS_MODULE,
166         .fb_setcolreg   = efifb_setcolreg,
167         .fb_fillrect    = cfb_fillrect,
168         .fb_copyarea    = cfb_copyarea,
169         .fb_imageblit   = cfb_imageblit,
170 };
171
172 static int __init efifb_setup(char *options)
173 {
174         char *this_opt;
175         int i;
176
177         if (!options || !*options)
178                 return 0;
179
180         while ((this_opt = strsep(&options, ",")) != NULL) {
181                 if (!*this_opt) continue;
182
183                 for (i = 0; i < M_UNKNOWN; i++) {
184                         if (!strcmp(this_opt, dmi_list[i].optname) &&
185                                         dmi_list[i].base != 0) {
186                                 screen_info.lfb_base = dmi_list[i].base;
187                                 screen_info.lfb_linelength = dmi_list[i].stride;
188                                 screen_info.lfb_width = dmi_list[i].width;
189                                 screen_info.lfb_height = dmi_list[i].height;
190                         }
191                 }
192                 if (!strncmp(this_opt, "base:", 5))
193                         screen_info.lfb_base = simple_strtoul(this_opt+5, NULL, 0);
194                 else if (!strncmp(this_opt, "stride:", 7))
195                         screen_info.lfb_linelength = simple_strtoul(this_opt+7, NULL, 0) * 4;
196                 else if (!strncmp(this_opt, "height:", 7))
197                         screen_info.lfb_height = simple_strtoul(this_opt+7, NULL, 0);
198                 else if (!strncmp(this_opt, "width:", 6))
199                         screen_info.lfb_width = simple_strtoul(this_opt+6, NULL, 0);
200         }
201         return 0;
202 }
203
204 static int __init efifb_probe(struct platform_device *dev)
205 {
206         struct fb_info *info;
207         int err;
208         unsigned int size_vmode;
209         unsigned int size_remap;
210         unsigned int size_total;
211         int request_succeeded = 0;
212
213         if (!screen_info.lfb_depth)
214                 screen_info.lfb_depth = 32;
215         if (!screen_info.pages)
216                 screen_info.pages = 1;
217         if (!screen_info.lfb_base) {
218                 printk(KERN_DEBUG "efifb: invalid framebuffer address\n");
219                 return -ENODEV;
220         }
221         printk(KERN_INFO "efifb: probing for efifb\n");
222
223         /* just assume they're all unset if any are */
224         if (!screen_info.blue_size) {
225                 screen_info.blue_size = 8;
226                 screen_info.blue_pos = 0;
227                 screen_info.green_size = 8;
228                 screen_info.green_pos = 8;
229                 screen_info.red_size = 8;
230                 screen_info.red_pos = 16;
231                 screen_info.rsvd_size = 8;
232                 screen_info.rsvd_pos = 24;
233         }
234
235         efifb_fix.smem_start = screen_info.lfb_base;
236         efifb_defined.bits_per_pixel = screen_info.lfb_depth;
237         efifb_defined.xres = screen_info.lfb_width;
238         efifb_defined.yres = screen_info.lfb_height;
239         efifb_fix.line_length = screen_info.lfb_linelength;
240
241         /*   size_vmode -- that is the amount of memory needed for the
242          *                 used video mode, i.e. the minimum amount of
243          *                 memory we need. */
244         size_vmode = efifb_defined.yres * efifb_fix.line_length;
245
246         /*   size_total -- all video memory we have. Used for
247          *                 entries, ressource allocation and bounds
248          *                 checking. */
249         size_total = screen_info.lfb_size;
250         if (size_total < size_vmode)
251                 size_total = size_vmode;
252
253         /*   size_remap -- the amount of video memory we are going to
254          *                 use for efifb.  With modern cards it is no
255          *                 option to simply use size_total as that
256          *                 wastes plenty of kernel address space. */
257         size_remap  = size_vmode * 2;
258         if (size_remap > size_total)
259                 size_remap = size_total;
260         if (size_remap % PAGE_SIZE)
261                 size_remap += PAGE_SIZE - (size_remap % PAGE_SIZE);
262         efifb_fix.smem_len = size_remap;
263
264         if (request_mem_region(efifb_fix.smem_start, size_remap, "efifb")) {
265                 request_succeeded = 1;
266         } else {
267                 /* We cannot make this fatal. Sometimes this comes from magic
268                    spaces our resource handlers simply don't know about */
269                 printk(KERN_WARNING
270                        "efifb: cannot reserve video memory at 0x%lx\n",
271                         efifb_fix.smem_start);
272         }
273
274         info = framebuffer_alloc(sizeof(u32) * 16, &dev->dev);
275         if (!info) {
276                 printk(KERN_ERR "efifb: cannot allocate framebuffer\n");
277                 err = -ENOMEM;
278                 goto err_release_mem;
279         }
280         info->pseudo_palette = info->par;
281         info->par = NULL;
282
283         info->screen_base = ioremap(efifb_fix.smem_start, efifb_fix.smem_len);
284         if (!info->screen_base) {
285                 printk(KERN_ERR "efifb: abort, cannot ioremap video memory "
286                                 "0x%x @ 0x%lx\n",
287                         efifb_fix.smem_len, efifb_fix.smem_start);
288                 err = -EIO;
289                 goto err_release_fb;
290         }
291
292         printk(KERN_INFO "efifb: framebuffer at 0x%lx, mapped to 0x%p, "
293                "using %dk, total %dk\n",
294                efifb_fix.smem_start, info->screen_base,
295                size_remap/1024, size_total/1024);
296         printk(KERN_INFO "efifb: mode is %dx%dx%d, linelength=%d, pages=%d\n",
297                efifb_defined.xres, efifb_defined.yres,
298                efifb_defined.bits_per_pixel, efifb_fix.line_length,
299                screen_info.pages);
300
301         efifb_defined.xres_virtual = efifb_defined.xres;
302         efifb_defined.yres_virtual = efifb_fix.smem_len /
303                                         efifb_fix.line_length;
304         printk(KERN_INFO "efifb: scrolling: redraw\n");
305         efifb_defined.yres_virtual = efifb_defined.yres;
306
307         /* some dummy values for timing to make fbset happy */
308         efifb_defined.pixclock     = 10000000 / efifb_defined.xres *
309                                         1000 / efifb_defined.yres;
310         efifb_defined.left_margin  = (efifb_defined.xres / 8) & 0xf8;
311         efifb_defined.hsync_len    = (efifb_defined.xres / 8) & 0xf8;
312
313         efifb_defined.red.offset    = screen_info.red_pos;
314         efifb_defined.red.length    = screen_info.red_size;
315         efifb_defined.green.offset  = screen_info.green_pos;
316         efifb_defined.green.length  = screen_info.green_size;
317         efifb_defined.blue.offset   = screen_info.blue_pos;
318         efifb_defined.blue.length   = screen_info.blue_size;
319         efifb_defined.transp.offset = screen_info.rsvd_pos;
320         efifb_defined.transp.length = screen_info.rsvd_size;
321
322         printk(KERN_INFO "efifb: %s: "
323                "size=%d:%d:%d:%d, shift=%d:%d:%d:%d\n",
324                "Truecolor",
325                screen_info.rsvd_size,
326                screen_info.red_size,
327                screen_info.green_size,
328                screen_info.blue_size,
329                screen_info.rsvd_pos,
330                screen_info.red_pos,
331                screen_info.green_pos,
332                screen_info.blue_pos);
333
334         efifb_fix.ypanstep  = 0;
335         efifb_fix.ywrapstep = 0;
336
337         info->fbops = &efifb_ops;
338         info->var = efifb_defined;
339         info->fix = efifb_fix;
340         info->flags = FBINFO_FLAG_DEFAULT;
341
342         if ((err = fb_alloc_cmap(&info->cmap, 256, 0)) < 0) {
343                 printk(KERN_ERR "efifb: cannot allocate colormap\n");
344                 goto err_unmap;
345         }
346         if ((err = register_framebuffer(info)) < 0) {
347                 printk(KERN_ERR "efifb: cannot register framebuffer\n");
348                 goto err_fb_dealoc;
349         }
350         printk(KERN_INFO "fb%d: %s frame buffer device\n",
351                 info->node, info->fix.id);
352         return 0;
353
354 err_fb_dealoc:
355         fb_dealloc_cmap(&info->cmap);
356 err_unmap:
357         iounmap(info->screen_base);
358 err_release_fb:
359         framebuffer_release(info);
360 err_release_mem:
361         if (request_succeeded)
362                 release_mem_region(efifb_fix.smem_start, size_total);
363         return err;
364 }
365
366 static struct platform_driver efifb_driver = {
367         .probe  = efifb_probe,
368         .driver = {
369                 .name   = "efifb",
370         },
371 };
372
373 static struct platform_device efifb_device = {
374         .name   = "efifb",
375 };
376
377 static int __init efifb_init(void)
378 {
379         int ret;
380         char *option = NULL;
381
382         dmi_check_system(dmi_system_table);
383
384         if (screen_info.orig_video_isVGA != VIDEO_TYPE_EFI)
385                 return -ENODEV;
386
387         if (fb_get_options("efifb", &option))
388                 return -ENODEV;
389         efifb_setup(option);
390
391         /* We don't get linelength from UGA Draw Protocol, only from
392          * EFI Graphics Protocol.  So if it's not in DMI, and it's not
393          * passed in from the user, we really can't use the framebuffer.
394          */
395         if (!screen_info.lfb_linelength)
396                 return -ENODEV;
397
398         ret = platform_driver_register(&efifb_driver);
399
400         if (!ret) {
401                 ret = platform_device_register(&efifb_device);
402                 if (ret)
403                         platform_driver_unregister(&efifb_driver);
404         }
405         return ret;
406 }
407 module_init(efifb_init);
408
409 MODULE_LICENSE("GPL");