2 * platinumfb.c -- frame buffer device for the PowerMac 'platinum' display
4 * Copyright (C) 1998 Franz Sirl
6 * Frame buffer structure from:
7 * drivers/video/controlfb.c -- frame buffer device for
8 * Apple 'control' display chip.
9 * Copyright (C) 1998 Dan Jacobowitz
11 * Hardware information from:
12 * platinum.c: Console support for PowerMac "platinum" display adaptor.
13 * Copyright (C) 1996 Paul Mackerras and Mark Abene
15 * This file is subject to the terms and conditions of the GNU General Public
16 * License. See the file COPYING in the main directory of this archive for
20 #include <linux/config.h>
21 #include <linux/module.h>
22 #include <linux/kernel.h>
23 #include <linux/errno.h>
24 #include <linux/string.h>
26 #include <linux/tty.h>
27 #include <linux/slab.h>
28 #include <linux/vmalloc.h>
29 #include <linux/delay.h>
30 #include <linux/interrupt.h>
32 #include <linux/init.h>
33 #include <linux/pci.h>
34 #include <linux/nvram.h>
37 #include <asm/pgtable.h>
38 #include <asm/of_device.h>
41 #include "platinumfb.h"
43 static int default_vmode = VMODE_NVRAM;
44 static int default_cmode = CMODE_NVRAM;
46 struct fb_info_platinum {
55 __u8 red, green, blue;
57 u32 pseudo_palette[17];
59 volatile struct cmap_regs __iomem *cmap_regs;
60 unsigned long cmap_regs_phys;
62 volatile struct platinum_regs __iomem *platinum_regs;
63 unsigned long platinum_regs_phys;
65 __u8 __iomem *frame_buffer;
66 volatile __u8 __iomem *base_frame_buffer;
67 unsigned long frame_buffer_phys;
69 unsigned long total_vram;
75 * Frame buffer device API
78 static int platinumfb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
79 u_int transp, struct fb_info *info);
80 static int platinumfb_blank(int blank_mode, struct fb_info *info);
81 static int platinumfb_set_par (struct fb_info *info);
82 static int platinumfb_check_var (struct fb_var_screeninfo *var, struct fb_info *info);
88 static inline int platinum_vram_reqd(int video_mode, int color_mode);
89 static int read_platinum_sense(struct fb_info_platinum *pinfo);
90 static void set_platinum_clock(struct fb_info_platinum *pinfo);
91 static void platinum_set_hardware(struct fb_info_platinum *pinfo);
92 static int platinum_var_to_par(struct fb_var_screeninfo *var,
93 struct fb_info_platinum *pinfo,
97 * Interface used by the world
100 int platinumfb_init(void);
101 int platinumfb_setup(char*);
103 static struct fb_ops platinumfb_ops = {
104 .owner = THIS_MODULE,
105 .fb_check_var = platinumfb_check_var,
106 .fb_set_par = platinumfb_set_par,
107 .fb_setcolreg = platinumfb_setcolreg,
108 .fb_blank = platinumfb_blank,
109 .fb_fillrect = cfb_fillrect,
110 .fb_copyarea = cfb_copyarea,
111 .fb_imageblit = cfb_imageblit,
115 * Checks a var structure
117 static int platinumfb_check_var (struct fb_var_screeninfo *var, struct fb_info *info)
119 return platinum_var_to_par(var, info->par, 1);
123 * Applies current var to display
125 static int platinumfb_set_par (struct fb_info *info)
127 struct fb_info_platinum *pinfo = info->par;
128 struct platinum_regvals *init;
129 int err, offset = 0x20;
131 if((err = platinum_var_to_par(&info->var, pinfo, 0))) {
132 printk (KERN_ERR "platinumfb_set_par: error calling"
133 " platinum_var_to_par: %d.\n", err);
137 platinum_set_hardware(pinfo);
139 init = platinum_reg_init[pinfo->vmode-1];
141 if (pinfo->vmode == 13 && pinfo->cmode > 0)
143 info->screen_base = pinfo->frame_buffer + init->fb_offset + offset;
144 info->fix.smem_start = (pinfo->frame_buffer_phys) + init->fb_offset + offset;
145 info->fix.visual = (pinfo->cmode == CMODE_8) ?
146 FB_VISUAL_PSEUDOCOLOR : FB_VISUAL_DIRECTCOLOR;
147 info->fix.line_length = vmode_attrs[pinfo->vmode-1].hres * (1<<pinfo->cmode) + offset;
148 printk("line_length: %x\n", info->fix.line_length);
152 static int platinumfb_blank(int blank, struct fb_info *fb)
155 * Blank the screen if blank_mode != 0, else unblank. If blank == NULL
156 * then the caller blanks by setting the CLUT (Color Look Up Table) to all
157 * black. Return 0 if blanking succeeded, != 0 if un-/blanking failed due
158 * to e.g. a video mode which doesn't support it. Implements VESA suspend
159 * and powerdown modes on hardware that supports disabling hsync/vsync:
160 * blank_mode == 2: suspend vsync
161 * blank_mode == 3: suspend hsync
162 * blank_mode == 4: powerdown
164 /* [danj] I think there's something fishy about those constants... */
166 struct fb_info_platinum *info = (struct fb_info_platinum *) fb;
169 ctrl = ld_le32(&info->platinum_regs->ctrl.r) | 0x33;
172 if (blank & VESA_VSYNC_SUSPEND)
174 if (blank & VESA_HSYNC_SUSPEND)
176 out_le32(&info->platinum_regs->ctrl.r, ctrl);
178 /* TODO: Figure out how the heck to powerdown this thing! */
182 static int platinumfb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
183 u_int transp, struct fb_info *info)
185 struct fb_info_platinum *pinfo = info->par;
186 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
195 pinfo->palette[regno].red = red;
196 pinfo->palette[regno].green = green;
197 pinfo->palette[regno].blue = blue;
199 out_8(&cmap_regs->addr, regno); /* tell clut what addr to fill */
200 out_8(&cmap_regs->lut, red); /* send one color channel at */
201 out_8(&cmap_regs->lut, green); /* a time... */
202 out_8(&cmap_regs->lut, blue);
206 u32 *pal = info->pseudo_palette;
207 switch (pinfo->cmode) {
209 pal[regno] = (regno << 10) | (regno << 5) | regno;
212 i = (regno << 8) | regno;
213 pal[regno] = (i << 16) | i;
221 static inline int platinum_vram_reqd(int video_mode, int color_mode)
223 return vmode_attrs[video_mode-1].vres *
224 (vmode_attrs[video_mode-1].hres * (1<<color_mode) + 0x20) +0x1000;
227 #define STORE_D2(a, d) { \
228 out_8(&cmap_regs->addr, (a+32)); \
229 out_8(&cmap_regs->d2, (d)); \
232 static void set_platinum_clock(struct fb_info_platinum *pinfo)
234 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
235 struct platinum_regvals *init;
237 init = platinum_reg_init[pinfo->vmode-1];
240 out_8(&cmap_regs->addr,3+32);
242 if (in_8(&cmap_regs->d2) == 2) {
243 STORE_D2(7, init->clock_params[pinfo->clktype][0]);
244 STORE_D2(8, init->clock_params[pinfo->clktype][1]);
247 STORE_D2(4, init->clock_params[pinfo->clktype][0]);
248 STORE_D2(5, init->clock_params[pinfo->clktype][1]);
257 /* Now how about actually saying, Make it so! */
258 /* Some things in here probably don't need to be done each time. */
259 static void platinum_set_hardware(struct fb_info_platinum *pinfo)
261 volatile struct platinum_regs __iomem *platinum_regs = pinfo->platinum_regs;
262 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
263 struct platinum_regvals *init;
267 vmode = pinfo->vmode;
268 cmode = pinfo->cmode;
270 init = platinum_reg_init[vmode - 1];
272 /* Initialize display timing registers */
273 out_be32(&platinum_regs->reg[24].r, 7); /* turn display off */
275 for (i = 0; i < 26; ++i)
276 out_be32(&platinum_regs->reg[i+32].r, init->regs[i]);
278 out_be32(&platinum_regs->reg[26+32].r, (pinfo->total_vram == 0x100000 ?
279 init->offset[cmode] + 4 - cmode :
280 init->offset[cmode]));
281 out_be32(&platinum_regs->reg[16].r, (unsigned) pinfo->frame_buffer_phys+init->fb_offset+0x10);
282 out_be32(&platinum_regs->reg[18].r, init->pitch[cmode]);
283 out_be32(&platinum_regs->reg[19].r, (pinfo->total_vram == 0x100000 ?
284 init->mode[cmode+1] :
286 out_be32(&platinum_regs->reg[20].r, (pinfo->total_vram == 0x100000 ? 0x11 : 0x1011));
287 out_be32(&platinum_regs->reg[21].r, 0x100);
288 out_be32(&platinum_regs->reg[22].r, 1);
289 out_be32(&platinum_regs->reg[23].r, 1);
290 out_be32(&platinum_regs->reg[26].r, 0xc00);
291 out_be32(&platinum_regs->reg[27].r, 0x235);
292 /* out_be32(&platinum_regs->reg[27].r, 0x2aa); */
294 STORE_D2(0, (pinfo->total_vram == 0x100000 ?
295 init->dacula_ctrl[cmode] & 0xf :
296 init->dacula_ctrl[cmode]));
300 set_platinum_clock(pinfo);
302 out_be32(&platinum_regs->reg[24].r, 0); /* turn display on */
306 * Set misc info vars for this driver
308 static void __devinit platinum_init_info(struct fb_info *info, struct fb_info_platinum *pinfo)
311 info->fbops = &platinumfb_ops;
312 info->pseudo_palette = pinfo->pseudo_palette;
313 info->flags = FBINFO_DEFAULT;
314 info->screen_base = pinfo->frame_buffer + 0x20;
316 fb_alloc_cmap(&info->cmap, 256, 0);
318 /* Fill fix common fields */
319 strcpy(info->fix.id, "platinum");
320 info->fix.mmio_start = pinfo->platinum_regs_phys;
321 info->fix.mmio_len = 0x1000;
322 info->fix.type = FB_TYPE_PACKED_PIXELS;
323 info->fix.smem_start = pinfo->frame_buffer_phys + 0x20; /* will be updated later */
324 info->fix.smem_len = pinfo->total_vram - 0x20;
325 info->fix.ywrapstep = 0;
326 info->fix.xpanstep = 0;
327 info->fix.ypanstep = 0;
328 info->fix.type_aux = 0;
329 info->fix.accel = FB_ACCEL_NONE;
333 static int __devinit platinum_init_fb(struct fb_info *info)
335 struct fb_info_platinum *pinfo = info->par;
336 struct fb_var_screeninfo var;
339 sense = read_platinum_sense(pinfo);
340 printk(KERN_INFO "platinumfb: Monitor sense value = 0x%x, ", sense);
342 if (default_vmode == VMODE_NVRAM) {
343 default_vmode = nvram_read_byte(NV_VMODE);
344 if (default_vmode <= 0 || default_vmode > VMODE_MAX ||
345 !platinum_reg_init[default_vmode-1])
346 default_vmode = VMODE_CHOOSE;
348 if (default_vmode == VMODE_CHOOSE) {
349 default_vmode = mac_map_monitor_sense(sense);
351 if (default_vmode <= 0 || default_vmode > VMODE_MAX)
352 default_vmode = VMODE_640_480_60;
353 if (default_cmode == CMODE_NVRAM)
354 default_cmode = nvram_read_byte(NV_CMODE);
355 if (default_cmode < CMODE_8 || default_cmode > CMODE_32)
356 default_cmode = CMODE_8;
358 * Reduce the pixel size if we don't have enough VRAM.
360 while(default_cmode > CMODE_8 &&
361 platinum_vram_reqd(default_vmode, default_cmode) > pinfo->total_vram)
364 printk("platinumfb: Using video mode %d and color mode %d.\n", default_vmode, default_cmode);
366 /* Setup default var */
367 if (mac_vmode_to_var(default_vmode, default_cmode, &var) < 0) {
368 /* This shouldn't happen! */
369 printk("mac_vmode_to_var(%d, %d,) failed\n", default_vmode, default_cmode);
371 default_vmode = VMODE_640_480_60;
372 default_cmode = CMODE_8;
373 if (mac_vmode_to_var(default_vmode, default_cmode, &var) < 0) {
374 printk(KERN_ERR "platinumfb: mac_vmode_to_var() failed\n");
379 /* Initialize info structure */
380 platinum_init_info(info, pinfo);
382 /* Apply default var */
384 var.activate = FB_ACTIVATE_NOW;
385 rc = fb_set_var(info, &var);
386 if (rc && (default_vmode != VMODE_640_480_60 || default_cmode != CMODE_8))
389 /* Register with fbdev layer */
390 rc = register_framebuffer(info);
394 printk(KERN_INFO "fb%d: Apple Platinum frame buffer device\n", info->node);
400 * Get the monitor sense value.
401 * Note that this can be called before calibrate_delay,
402 * so we can't use udelay.
404 static int read_platinum_sense(struct fb_info_platinum *info)
406 volatile struct platinum_regs __iomem *platinum_regs = info->platinum_regs;
409 out_be32(&platinum_regs->reg[23].r, 7); /* turn off drivers */
411 sense = (~in_be32(&platinum_regs->reg[23].r) & 7) << 8;
413 /* drive each sense line low in turn and collect the other 2 */
414 out_be32(&platinum_regs->reg[23].r, 3); /* drive A low */
416 sense |= (~in_be32(&platinum_regs->reg[23].r) & 3) << 4;
417 out_be32(&platinum_regs->reg[23].r, 5); /* drive B low */
419 sense |= (~in_be32(&platinum_regs->reg[23].r) & 4) << 1;
420 sense |= (~in_be32(&platinum_regs->reg[23].r) & 1) << 2;
421 out_be32(&platinum_regs->reg[23].r, 6); /* drive C low */
423 sense |= (~in_be32(&platinum_regs->reg[23].r) & 6) >> 1;
425 out_be32(&platinum_regs->reg[23].r, 7); /* turn off drivers */
431 * This routine takes a user-supplied var, and picks the best vmode/cmode from it.
432 * It also updates the var structure to the actual mode data obtained
434 static int platinum_var_to_par(struct fb_var_screeninfo *var,
435 struct fb_info_platinum *pinfo,
440 if (mac_var_to_vmode(var, &vmode, &cmode) != 0) {
441 printk(KERN_ERR "platinum_var_to_par: mac_var_to_vmode unsuccessful.\n");
442 printk(KERN_ERR "platinum_var_to_par: var->xres = %d\n", var->xres);
443 printk(KERN_ERR "platinum_var_to_par: var->yres = %d\n", var->yres);
444 printk(KERN_ERR "platinum_var_to_par: var->xres_virtual = %d\n", var->xres_virtual);
445 printk(KERN_ERR "platinum_var_to_par: var->yres_virtual = %d\n", var->yres_virtual);
446 printk(KERN_ERR "platinum_var_to_par: var->bits_per_pixel = %d\n", var->bits_per_pixel);
447 printk(KERN_ERR "platinum_var_to_par: var->pixclock = %d\n", var->pixclock);
448 printk(KERN_ERR "platinum_var_to_par: var->vmode = %d\n", var->vmode);
452 if (!platinum_reg_init[vmode-1]) {
453 printk(KERN_ERR "platinum_var_to_par, vmode %d not valid.\n", vmode);
457 if (platinum_vram_reqd(vmode, cmode) > pinfo->total_vram) {
458 printk(KERN_ERR "platinum_var_to_par, not enough ram for vmode %d, cmode %d.\n", vmode, cmode);
462 if (mac_vmode_to_var(vmode, cmode, var))
468 pinfo->vmode = vmode;
469 pinfo->cmode = cmode;
470 pinfo->xres = vmode_attrs[vmode-1].hres;
471 pinfo->yres = vmode_attrs[vmode-1].vres;
474 pinfo->vxres = pinfo->xres;
475 pinfo->vyres = pinfo->yres;
482 * Parse user speficied options (`video=platinumfb:')
484 int __init platinumfb_setup(char *options)
488 if (!options || !*options)
491 while ((this_opt = strsep(&options, ",")) != NULL) {
492 if (!strncmp(this_opt, "vmode:", 6)) {
493 int vmode = simple_strtoul(this_opt+6, NULL, 0);
494 if (vmode > 0 && vmode <= VMODE_MAX)
495 default_vmode = vmode;
496 } else if (!strncmp(this_opt, "cmode:", 6)) {
497 int depth = simple_strtoul(this_opt+6, NULL, 0);
501 default_cmode = CMODE_8;
505 default_cmode = CMODE_16;
509 default_cmode = CMODE_32;
518 #define invalidate_cache(addr) \
519 asm volatile("eieio; dcbf 0,%1" \
520 : "=m" (*(addr)) : "r" (addr) : "memory");
522 #define invalidate_cache(addr)
525 static int __devinit platinumfb_probe(struct of_device* odev, const struct of_device_id *match)
527 struct device_node *dp = odev->node;
528 struct fb_info *info;
529 struct fb_info_platinum *pinfo;
530 unsigned long addr, size;
531 volatile __u8 *fbuffer;
532 int i, bank0, bank1, bank2, bank3, rc;
534 if (dp->n_addrs != 2) {
535 printk(KERN_ERR "expecting 2 address for platinum (got %d)", dp->n_addrs);
538 printk(KERN_INFO "platinumfb: Found Apple Platinum video hardware\n");
540 info = framebuffer_alloc(sizeof(*pinfo), &odev->dev);
545 /* Map in frame buffer and registers */
546 for (i = 0; i < dp->n_addrs; ++i) {
547 addr = dp->addrs[i].address;
548 size = dp->addrs[i].size;
549 /* Let's assume we can request either all or nothing */
550 if (!request_mem_region(addr, size, "platinumfb")) {
551 framebuffer_release(info);
554 if (size >= 0x400000) {
555 /* frame buffer - map only 4MB */
556 pinfo->frame_buffer_phys = addr;
557 pinfo->frame_buffer = __ioremap(addr, 0x400000, _PAGE_WRITETHRU);
558 pinfo->base_frame_buffer = pinfo->frame_buffer;
561 pinfo->platinum_regs_phys = addr;
562 pinfo->platinum_regs = ioremap(addr, size);
566 pinfo->cmap_regs_phys = 0xf301b000; /* XXX not in prom? */
567 request_mem_region(pinfo->cmap_regs_phys, 0x1000, "platinumfb cmap");
568 pinfo->cmap_regs = ioremap(pinfo->cmap_regs_phys, 0x1000);
570 /* Grok total video ram */
571 out_be32(&pinfo->platinum_regs->reg[16].r, (unsigned)pinfo->frame_buffer_phys);
572 out_be32(&pinfo->platinum_regs->reg[20].r, 0x1011); /* select max vram */
573 out_be32(&pinfo->platinum_regs->reg[24].r, 0); /* switch in vram */
575 fbuffer = pinfo->base_frame_buffer;
576 fbuffer[0x100000] = 0x34;
577 fbuffer[0x100008] = 0x0;
578 invalidate_cache(&fbuffer[0x100000]);
579 fbuffer[0x200000] = 0x56;
580 fbuffer[0x200008] = 0x0;
581 invalidate_cache(&fbuffer[0x200000]);
582 fbuffer[0x300000] = 0x78;
583 fbuffer[0x300008] = 0x0;
584 invalidate_cache(&fbuffer[0x300000]);
585 bank0 = 1; /* builtin 1MB vram, always there */
586 bank1 = fbuffer[0x100000] == 0x34;
587 bank2 = fbuffer[0x200000] == 0x56;
588 bank3 = fbuffer[0x300000] == 0x78;
589 pinfo->total_vram = (bank0 + bank1 + bank2 + bank3) * 0x100000;
590 printk(KERN_INFO "platinumfb: Total VRAM = %dMB (%d%d%d%d)\n", (int) (pinfo->total_vram / 1024 / 1024),
591 bank3, bank2, bank1, bank0);
594 * Try to determine whether we have an old or a new DACula.
596 out_8(&pinfo->cmap_regs->addr, 0x40);
597 pinfo->dactype = in_8(&pinfo->cmap_regs->d2);
598 switch (pinfo->dactype) {
601 printk(KERN_INFO "platinumfb: DACula type 0x3c\n");
605 printk(KERN_INFO "platinumfb: DACula type 0x84\n");
609 printk(KERN_INFO "platinumfb: Unknown DACula type: %x\n", pinfo->dactype);
612 dev_set_drvdata(&odev->dev, info);
614 rc = platinum_init_fb(info);
616 dev_set_drvdata(&odev->dev, NULL);
617 framebuffer_release(info);
623 static int __devexit platinumfb_remove(struct of_device* odev)
625 struct fb_info *info = dev_get_drvdata(&odev->dev);
626 struct fb_info_platinum *pinfo = info->par;
627 struct device_node *dp = odev->node;
628 unsigned long addr, size;
631 unregister_framebuffer (info);
633 /* Unmap frame buffer and registers */
634 for (i = 0; i < dp->n_addrs; ++i) {
635 addr = dp->addrs[i].address;
636 size = dp->addrs[i].size;
637 release_mem_region(addr, size);
639 iounmap(pinfo->frame_buffer);
640 iounmap(pinfo->platinum_regs);
641 release_mem_region(pinfo->cmap_regs_phys, 0x1000);
642 iounmap(pinfo->cmap_regs);
644 framebuffer_release(info);
649 static struct of_device_id platinumfb_match[] =
657 static struct of_platform_driver platinum_driver =
659 .name = "platinumfb",
660 .match_table = platinumfb_match,
661 .probe = platinumfb_probe,
662 .remove = platinumfb_remove,
665 int __init platinumfb_init(void)
670 if (fb_get_options("platinumfb", &option))
672 platinumfb_setup(option);
674 of_register_driver(&platinum_driver);
679 void __exit platinumfb_exit(void)
681 of_unregister_driver(&platinum_driver);
684 MODULE_LICENSE("GPL");
685 MODULE_DESCRIPTION("framebuffer driver for Apple Platinum video");
686 module_init(platinumfb_init);
689 module_exit(platinumfb_exit);