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,
112 .fb_cursor = soft_cursor,
116 * Checks a var structure
118 static int platinumfb_check_var (struct fb_var_screeninfo *var, struct fb_info *info)
120 return platinum_var_to_par(var, info->par, 1);
124 * Applies current var to display
126 static int platinumfb_set_par (struct fb_info *info)
128 struct fb_info_platinum *pinfo = info->par;
129 struct platinum_regvals *init;
130 int err, offset = 0x20;
132 if((err = platinum_var_to_par(&info->var, pinfo, 0))) {
133 printk (KERN_ERR "platinumfb_set_par: error calling"
134 " platinum_var_to_par: %d.\n", err);
138 platinum_set_hardware(pinfo);
140 init = platinum_reg_init[pinfo->vmode-1];
142 if (pinfo->vmode == 13 && pinfo->cmode > 0)
144 info->screen_base = pinfo->frame_buffer + init->fb_offset + offset;
145 info->fix.smem_start = (pinfo->frame_buffer_phys) + init->fb_offset + offset;
146 info->fix.visual = (pinfo->cmode == CMODE_8) ?
147 FB_VISUAL_PSEUDOCOLOR : FB_VISUAL_DIRECTCOLOR;
148 info->fix.line_length = vmode_attrs[pinfo->vmode-1].hres * (1<<pinfo->cmode) + offset;
149 printk("line_length: %x\n", info->fix.line_length);
153 static int platinumfb_blank(int blank, struct fb_info *fb)
156 * Blank the screen if blank_mode != 0, else unblank. If blank == NULL
157 * then the caller blanks by setting the CLUT (Color Look Up Table) to all
158 * black. Return 0 if blanking succeeded, != 0 if un-/blanking failed due
159 * to e.g. a video mode which doesn't support it. Implements VESA suspend
160 * and powerdown modes on hardware that supports disabling hsync/vsync:
161 * blank_mode == 2: suspend vsync
162 * blank_mode == 3: suspend hsync
163 * blank_mode == 4: powerdown
165 /* [danj] I think there's something fishy about those constants... */
167 struct fb_info_platinum *info = (struct fb_info_platinum *) fb;
170 ctrl = ld_le32(&info->platinum_regs->ctrl.r) | 0x33;
173 if (blank & VESA_VSYNC_SUSPEND)
175 if (blank & VESA_HSYNC_SUSPEND)
177 out_le32(&info->platinum_regs->ctrl.r, ctrl);
179 /* TODO: Figure out how the heck to powerdown this thing! */
183 static int platinumfb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
184 u_int transp, struct fb_info *info)
186 struct fb_info_platinum *pinfo = info->par;
187 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
196 pinfo->palette[regno].red = red;
197 pinfo->palette[regno].green = green;
198 pinfo->palette[regno].blue = blue;
200 out_8(&cmap_regs->addr, regno); /* tell clut what addr to fill */
201 out_8(&cmap_regs->lut, red); /* send one color channel at */
202 out_8(&cmap_regs->lut, green); /* a time... */
203 out_8(&cmap_regs->lut, blue);
207 u32 *pal = info->pseudo_palette;
208 switch (pinfo->cmode) {
210 pal[regno] = (regno << 10) | (regno << 5) | regno;
213 i = (regno << 8) | regno;
214 pal[regno] = (i << 16) | i;
222 static inline int platinum_vram_reqd(int video_mode, int color_mode)
224 return vmode_attrs[video_mode-1].vres *
225 (vmode_attrs[video_mode-1].hres * (1<<color_mode) + 0x20) +0x1000;
228 #define STORE_D2(a, d) { \
229 out_8(&cmap_regs->addr, (a+32)); \
230 out_8(&cmap_regs->d2, (d)); \
233 static void set_platinum_clock(struct fb_info_platinum *pinfo)
235 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
236 struct platinum_regvals *init;
238 init = platinum_reg_init[pinfo->vmode-1];
241 out_8(&cmap_regs->addr,3+32);
243 if (in_8(&cmap_regs->d2) == 2) {
244 STORE_D2(7, init->clock_params[pinfo->clktype][0]);
245 STORE_D2(8, init->clock_params[pinfo->clktype][1]);
248 STORE_D2(4, init->clock_params[pinfo->clktype][0]);
249 STORE_D2(5, init->clock_params[pinfo->clktype][1]);
258 /* Now how about actually saying, Make it so! */
259 /* Some things in here probably don't need to be done each time. */
260 static void platinum_set_hardware(struct fb_info_platinum *pinfo)
262 volatile struct platinum_regs __iomem *platinum_regs = pinfo->platinum_regs;
263 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
264 struct platinum_regvals *init;
268 vmode = pinfo->vmode;
269 cmode = pinfo->cmode;
271 init = platinum_reg_init[vmode - 1];
273 /* Initialize display timing registers */
274 out_be32(&platinum_regs->reg[24].r, 7); /* turn display off */
276 for (i = 0; i < 26; ++i)
277 out_be32(&platinum_regs->reg[i+32].r, init->regs[i]);
279 out_be32(&platinum_regs->reg[26+32].r, (pinfo->total_vram == 0x100000 ?
280 init->offset[cmode] + 4 - cmode :
281 init->offset[cmode]));
282 out_be32(&platinum_regs->reg[16].r, (unsigned) pinfo->frame_buffer_phys+init->fb_offset+0x10);
283 out_be32(&platinum_regs->reg[18].r, init->pitch[cmode]);
284 out_be32(&platinum_regs->reg[19].r, (pinfo->total_vram == 0x100000 ?
285 init->mode[cmode+1] :
287 out_be32(&platinum_regs->reg[20].r, (pinfo->total_vram == 0x100000 ? 0x11 : 0x1011));
288 out_be32(&platinum_regs->reg[21].r, 0x100);
289 out_be32(&platinum_regs->reg[22].r, 1);
290 out_be32(&platinum_regs->reg[23].r, 1);
291 out_be32(&platinum_regs->reg[26].r, 0xc00);
292 out_be32(&platinum_regs->reg[27].r, 0x235);
293 /* out_be32(&platinum_regs->reg[27].r, 0x2aa); */
295 STORE_D2(0, (pinfo->total_vram == 0x100000 ?
296 init->dacula_ctrl[cmode] & 0xf :
297 init->dacula_ctrl[cmode]));
301 set_platinum_clock(pinfo);
303 out_be32(&platinum_regs->reg[24].r, 0); /* turn display on */
307 * Set misc info vars for this driver
309 static void __devinit platinum_init_info(struct fb_info *info, struct fb_info_platinum *pinfo)
312 info->fbops = &platinumfb_ops;
313 info->pseudo_palette = pinfo->pseudo_palette;
314 info->flags = FBINFO_DEFAULT;
315 info->screen_base = pinfo->frame_buffer + 0x20;
317 fb_alloc_cmap(&info->cmap, 256, 0);
319 /* Fill fix common fields */
320 strcpy(info->fix.id, "platinum");
321 info->fix.mmio_start = pinfo->platinum_regs_phys;
322 info->fix.mmio_len = 0x1000;
323 info->fix.type = FB_TYPE_PACKED_PIXELS;
324 info->fix.smem_start = pinfo->frame_buffer_phys + 0x20; /* will be updated later */
325 info->fix.smem_len = pinfo->total_vram - 0x20;
326 info->fix.ywrapstep = 0;
327 info->fix.xpanstep = 0;
328 info->fix.ypanstep = 0;
329 info->fix.type_aux = 0;
330 info->fix.accel = FB_ACCEL_NONE;
334 static int __devinit platinum_init_fb(struct fb_info *info)
336 struct fb_info_platinum *pinfo = info->par;
337 struct fb_var_screeninfo var;
340 sense = read_platinum_sense(pinfo);
341 printk(KERN_INFO "platinumfb: Monitor sense value = 0x%x, ", sense);
343 if (default_vmode == VMODE_NVRAM) {
344 default_vmode = nvram_read_byte(NV_VMODE);
345 if (default_vmode <= 0 || default_vmode > VMODE_MAX ||
346 !platinum_reg_init[default_vmode-1])
347 default_vmode = VMODE_CHOOSE;
349 if (default_vmode == VMODE_CHOOSE) {
350 default_vmode = mac_map_monitor_sense(sense);
352 if (default_vmode <= 0 || default_vmode > VMODE_MAX)
353 default_vmode = VMODE_640_480_60;
354 if (default_cmode == CMODE_NVRAM)
355 default_cmode = nvram_read_byte(NV_CMODE);
356 if (default_cmode < CMODE_8 || default_cmode > CMODE_32)
357 default_cmode = CMODE_8;
359 * Reduce the pixel size if we don't have enough VRAM.
361 while(default_cmode > CMODE_8 &&
362 platinum_vram_reqd(default_vmode, default_cmode) > pinfo->total_vram)
365 printk("platinumfb: Using video mode %d and color mode %d.\n", default_vmode, default_cmode);
367 /* Setup default var */
368 if (mac_vmode_to_var(default_vmode, default_cmode, &var) < 0) {
369 /* This shouldn't happen! */
370 printk("mac_vmode_to_var(%d, %d,) failed\n", default_vmode, default_cmode);
372 default_vmode = VMODE_640_480_60;
373 default_cmode = CMODE_8;
374 if (mac_vmode_to_var(default_vmode, default_cmode, &var) < 0) {
375 printk(KERN_ERR "platinumfb: mac_vmode_to_var() failed\n");
380 /* Initialize info structure */
381 platinum_init_info(info, pinfo);
383 /* Apply default var */
385 var.activate = FB_ACTIVATE_NOW;
386 rc = fb_set_var(info, &var);
387 if (rc && (default_vmode != VMODE_640_480_60 || default_cmode != CMODE_8))
390 /* Register with fbdev layer */
391 rc = register_framebuffer(info);
395 printk(KERN_INFO "fb%d: Apple Platinum frame buffer device\n", info->node);
401 * Get the monitor sense value.
402 * Note that this can be called before calibrate_delay,
403 * so we can't use udelay.
405 static int read_platinum_sense(struct fb_info_platinum *info)
407 volatile struct platinum_regs __iomem *platinum_regs = info->platinum_regs;
410 out_be32(&platinum_regs->reg[23].r, 7); /* turn off drivers */
412 sense = (~in_be32(&platinum_regs->reg[23].r) & 7) << 8;
414 /* drive each sense line low in turn and collect the other 2 */
415 out_be32(&platinum_regs->reg[23].r, 3); /* drive A low */
417 sense |= (~in_be32(&platinum_regs->reg[23].r) & 3) << 4;
418 out_be32(&platinum_regs->reg[23].r, 5); /* drive B low */
420 sense |= (~in_be32(&platinum_regs->reg[23].r) & 4) << 1;
421 sense |= (~in_be32(&platinum_regs->reg[23].r) & 1) << 2;
422 out_be32(&platinum_regs->reg[23].r, 6); /* drive C low */
424 sense |= (~in_be32(&platinum_regs->reg[23].r) & 6) >> 1;
426 out_be32(&platinum_regs->reg[23].r, 7); /* turn off drivers */
432 * This routine takes a user-supplied var, and picks the best vmode/cmode from it.
433 * It also updates the var structure to the actual mode data obtained
435 static int platinum_var_to_par(struct fb_var_screeninfo *var,
436 struct fb_info_platinum *pinfo,
441 if (mac_var_to_vmode(var, &vmode, &cmode) != 0) {
442 printk(KERN_ERR "platinum_var_to_par: mac_var_to_vmode unsuccessful.\n");
443 printk(KERN_ERR "platinum_var_to_par: var->xres = %d\n", var->xres);
444 printk(KERN_ERR "platinum_var_to_par: var->yres = %d\n", var->yres);
445 printk(KERN_ERR "platinum_var_to_par: var->xres_virtual = %d\n", var->xres_virtual);
446 printk(KERN_ERR "platinum_var_to_par: var->yres_virtual = %d\n", var->yres_virtual);
447 printk(KERN_ERR "platinum_var_to_par: var->bits_per_pixel = %d\n", var->bits_per_pixel);
448 printk(KERN_ERR "platinum_var_to_par: var->pixclock = %d\n", var->pixclock);
449 printk(KERN_ERR "platinum_var_to_par: var->vmode = %d\n", var->vmode);
453 if (!platinum_reg_init[vmode-1]) {
454 printk(KERN_ERR "platinum_var_to_par, vmode %d not valid.\n", vmode);
458 if (platinum_vram_reqd(vmode, cmode) > pinfo->total_vram) {
459 printk(KERN_ERR "platinum_var_to_par, not enough ram for vmode %d, cmode %d.\n", vmode, cmode);
463 if (mac_vmode_to_var(vmode, cmode, var))
469 pinfo->vmode = vmode;
470 pinfo->cmode = cmode;
471 pinfo->xres = vmode_attrs[vmode-1].hres;
472 pinfo->yres = vmode_attrs[vmode-1].vres;
475 pinfo->vxres = pinfo->xres;
476 pinfo->vyres = pinfo->yres;
483 * Parse user speficied options (`video=platinumfb:')
485 int __init platinumfb_setup(char *options)
489 if (!options || !*options)
492 while ((this_opt = strsep(&options, ",")) != NULL) {
493 if (!strncmp(this_opt, "vmode:", 6)) {
494 int vmode = simple_strtoul(this_opt+6, NULL, 0);
495 if (vmode > 0 && vmode <= VMODE_MAX)
496 default_vmode = vmode;
497 } else if (!strncmp(this_opt, "cmode:", 6)) {
498 int depth = simple_strtoul(this_opt+6, NULL, 0);
502 default_cmode = CMODE_8;
506 default_cmode = CMODE_16;
510 default_cmode = CMODE_32;
519 #define invalidate_cache(addr) \
520 asm volatile("eieio; dcbf 0,%1" \
521 : "=m" (*(addr)) : "r" (addr) : "memory");
523 #define invalidate_cache(addr)
526 static int __devinit platinumfb_probe(struct of_device* odev, const struct of_match *match)
528 struct device_node *dp = odev->node;
529 struct fb_info *info;
530 struct fb_info_platinum *pinfo;
531 unsigned long addr, size;
532 volatile __u8 *fbuffer;
533 int i, bank0, bank1, bank2, bank3, rc;
535 if (dp->n_addrs != 2) {
536 printk(KERN_ERR "expecting 2 address for platinum (got %d)", dp->n_addrs);
539 printk(KERN_INFO "platinumfb: Found Apple Platinum video hardware\n");
541 info = framebuffer_alloc(sizeof(*pinfo), &odev->dev);
546 /* Map in frame buffer and registers */
547 for (i = 0; i < dp->n_addrs; ++i) {
548 addr = dp->addrs[i].address;
549 size = dp->addrs[i].size;
550 /* Let's assume we can request either all or nothing */
551 if (!request_mem_region(addr, size, "platinumfb")) {
552 framebuffer_release(info);
555 if (size >= 0x400000) {
556 /* frame buffer - map only 4MB */
557 pinfo->frame_buffer_phys = addr;
558 pinfo->frame_buffer = __ioremap(addr, 0x400000, _PAGE_WRITETHRU);
559 pinfo->base_frame_buffer = pinfo->frame_buffer;
562 pinfo->platinum_regs_phys = addr;
563 pinfo->platinum_regs = ioremap(addr, size);
567 pinfo->cmap_regs_phys = 0xf301b000; /* XXX not in prom? */
568 request_mem_region(pinfo->cmap_regs_phys, 0x1000, "platinumfb cmap");
569 pinfo->cmap_regs = ioremap(pinfo->cmap_regs_phys, 0x1000);
571 /* Grok total video ram */
572 out_be32(&pinfo->platinum_regs->reg[16].r, (unsigned)pinfo->frame_buffer_phys);
573 out_be32(&pinfo->platinum_regs->reg[20].r, 0x1011); /* select max vram */
574 out_be32(&pinfo->platinum_regs->reg[24].r, 0); /* switch in vram */
576 fbuffer = pinfo->base_frame_buffer;
577 fbuffer[0x100000] = 0x34;
578 fbuffer[0x100008] = 0x0;
579 invalidate_cache(&fbuffer[0x100000]);
580 fbuffer[0x200000] = 0x56;
581 fbuffer[0x200008] = 0x0;
582 invalidate_cache(&fbuffer[0x200000]);
583 fbuffer[0x300000] = 0x78;
584 fbuffer[0x300008] = 0x0;
585 invalidate_cache(&fbuffer[0x300000]);
586 bank0 = 1; /* builtin 1MB vram, always there */
587 bank1 = fbuffer[0x100000] == 0x34;
588 bank2 = fbuffer[0x200000] == 0x56;
589 bank3 = fbuffer[0x300000] == 0x78;
590 pinfo->total_vram = (bank0 + bank1 + bank2 + bank3) * 0x100000;
591 printk(KERN_INFO "platinumfb: Total VRAM = %dMB (%d%d%d%d)\n", (int) (pinfo->total_vram / 1024 / 1024),
592 bank3, bank2, bank1, bank0);
595 * Try to determine whether we have an old or a new DACula.
597 out_8(&pinfo->cmap_regs->addr, 0x40);
598 pinfo->dactype = in_8(&pinfo->cmap_regs->d2);
599 switch (pinfo->dactype) {
602 printk(KERN_INFO "platinumfb: DACula type 0x3c\n");
606 printk(KERN_INFO "platinumfb: DACula type 0x84\n");
610 printk(KERN_INFO "platinumfb: Unknown DACula type: %x\n", pinfo->dactype);
613 dev_set_drvdata(&odev->dev, info);
615 rc = platinum_init_fb(info);
617 dev_set_drvdata(&odev->dev, NULL);
618 framebuffer_release(info);
624 static int __devexit platinumfb_remove(struct of_device* odev)
626 struct fb_info *info = dev_get_drvdata(&odev->dev);
627 struct fb_info_platinum *pinfo = info->par;
628 struct device_node *dp = odev->node;
629 unsigned long addr, size;
632 unregister_framebuffer (info);
634 /* Unmap frame buffer and registers */
635 for (i = 0; i < dp->n_addrs; ++i) {
636 addr = dp->addrs[i].address;
637 size = dp->addrs[i].size;
638 release_mem_region(addr, size);
640 iounmap(pinfo->frame_buffer);
641 iounmap(pinfo->platinum_regs);
642 release_mem_region(pinfo->cmap_regs_phys, 0x1000);
643 iounmap(pinfo->cmap_regs);
645 framebuffer_release(info);
650 static struct of_match platinumfb_match[] =
654 .type = OF_ANY_MATCH,
655 .compatible = OF_ANY_MATCH,
660 static struct of_platform_driver platinum_driver =
662 .name = "platinumfb",
663 .match_table = platinumfb_match,
664 .probe = platinumfb_probe,
665 .remove = platinumfb_remove,
668 int __init platinumfb_init(void)
673 if (fb_get_options("platinumfb", &option))
675 platinumfb_setup(option);
677 of_register_driver(&platinum_driver);
682 void __exit platinumfb_exit(void)
684 of_unregister_driver(&platinum_driver);
687 MODULE_LICENSE("GPL");
688 MODULE_DESCRIPTION("framebuffer driver for Apple Platinum video");
689 module_init(platinumfb_init);
692 module_exit(platinumfb_exit);