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/module.h>
21 #include <linux/kernel.h>
22 #include <linux/errno.h>
23 #include <linux/string.h>
25 #include <linux/slab.h>
26 #include <linux/vmalloc.h>
27 #include <linux/delay.h>
28 #include <linux/interrupt.h>
30 #include <linux/init.h>
31 #include <linux/pci.h>
32 #include <linux/nvram.h>
35 #include <asm/pgtable.h>
36 #include <asm/of_device.h>
37 #include <asm/of_platform.h>
40 #include "platinumfb.h"
42 static int default_vmode = VMODE_NVRAM;
43 static int default_cmode = CMODE_NVRAM;
45 struct fb_info_platinum {
54 __u8 red, green, blue;
56 u32 pseudo_palette[17];
58 volatile struct cmap_regs __iomem *cmap_regs;
59 unsigned long cmap_regs_phys;
61 volatile struct platinum_regs __iomem *platinum_regs;
62 unsigned long platinum_regs_phys;
64 __u8 __iomem *frame_buffer;
65 volatile __u8 __iomem *base_frame_buffer;
66 unsigned long frame_buffer_phys;
68 unsigned long total_vram;
72 struct resource rsrc_fb, rsrc_reg;
76 * Frame buffer device API
79 static int platinumfb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
80 u_int transp, struct fb_info *info);
81 static int platinumfb_blank(int blank_mode, struct fb_info *info);
82 static int platinumfb_set_par (struct fb_info *info);
83 static int platinumfb_check_var (struct fb_var_screeninfo *var, struct fb_info *info);
89 static inline int platinum_vram_reqd(int video_mode, int color_mode);
90 static int read_platinum_sense(struct fb_info_platinum *pinfo);
91 static void set_platinum_clock(struct fb_info_platinum *pinfo);
92 static void platinum_set_hardware(struct fb_info_platinum *pinfo);
93 static int platinum_var_to_par(struct fb_var_screeninfo *var,
94 struct fb_info_platinum *pinfo,
98 * Interface used by the world
101 static struct fb_ops platinumfb_ops = {
102 .owner = THIS_MODULE,
103 .fb_check_var = platinumfb_check_var,
104 .fb_set_par = platinumfb_set_par,
105 .fb_setcolreg = platinumfb_setcolreg,
106 .fb_blank = platinumfb_blank,
107 .fb_fillrect = cfb_fillrect,
108 .fb_copyarea = cfb_copyarea,
109 .fb_imageblit = cfb_imageblit,
113 * Checks a var structure
115 static int platinumfb_check_var (struct fb_var_screeninfo *var, struct fb_info *info)
117 return platinum_var_to_par(var, info->par, 1);
121 * Applies current var to display
123 static int platinumfb_set_par (struct fb_info *info)
125 struct fb_info_platinum *pinfo = info->par;
126 struct platinum_regvals *init;
127 int err, offset = 0x20;
129 if((err = platinum_var_to_par(&info->var, pinfo, 0))) {
130 printk (KERN_ERR "platinumfb_set_par: error calling"
131 " platinum_var_to_par: %d.\n", err);
135 platinum_set_hardware(pinfo);
137 init = platinum_reg_init[pinfo->vmode-1];
139 if ((pinfo->vmode == VMODE_832_624_75) && (pinfo->cmode > CMODE_8))
142 info->screen_base = pinfo->frame_buffer + init->fb_offset + offset;
143 info->fix.smem_start = (pinfo->frame_buffer_phys) + init->fb_offset + offset;
144 info->fix.visual = (pinfo->cmode == CMODE_8) ?
145 FB_VISUAL_PSEUDOCOLOR : FB_VISUAL_DIRECTCOLOR;
146 info->fix.line_length = vmode_attrs[pinfo->vmode-1].hres * (1<<pinfo->cmode)
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) +
225 ((video_mode == VMODE_832_624_75) &&
226 (color_mode > CMODE_8)) ? 0x10 : 0x20) + 0x1000;
229 #define STORE_D2(a, d) { \
230 out_8(&cmap_regs->addr, (a+32)); \
231 out_8(&cmap_regs->d2, (d)); \
234 static void set_platinum_clock(struct fb_info_platinum *pinfo)
236 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
237 struct platinum_regvals *init;
239 init = platinum_reg_init[pinfo->vmode-1];
242 out_8(&cmap_regs->addr,3+32);
244 if (in_8(&cmap_regs->d2) == 2) {
245 STORE_D2(7, init->clock_params[pinfo->clktype][0]);
246 STORE_D2(8, init->clock_params[pinfo->clktype][1]);
249 STORE_D2(4, init->clock_params[pinfo->clktype][0]);
250 STORE_D2(5, init->clock_params[pinfo->clktype][1]);
259 /* Now how about actually saying, Make it so! */
260 /* Some things in here probably don't need to be done each time. */
261 static void platinum_set_hardware(struct fb_info_platinum *pinfo)
263 volatile struct platinum_regs __iomem *platinum_regs = pinfo->platinum_regs;
264 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
265 struct platinum_regvals *init;
269 vmode = pinfo->vmode;
270 cmode = pinfo->cmode;
272 init = platinum_reg_init[vmode - 1];
274 /* Initialize display timing registers */
275 out_be32(&platinum_regs->reg[24].r, 7); /* turn display off */
277 for (i = 0; i < 26; ++i)
278 out_be32(&platinum_regs->reg[i+32].r, init->regs[i]);
280 out_be32(&platinum_regs->reg[26+32].r, (pinfo->total_vram == 0x100000 ?
281 init->offset[cmode] + 4 - cmode :
282 init->offset[cmode]));
283 out_be32(&platinum_regs->reg[16].r, (unsigned) pinfo->frame_buffer_phys+init->fb_offset+0x10);
284 out_be32(&platinum_regs->reg[18].r, init->pitch[cmode]);
285 out_be32(&platinum_regs->reg[19].r, (pinfo->total_vram == 0x100000 ?
286 init->mode[cmode+1] :
288 out_be32(&platinum_regs->reg[20].r, (pinfo->total_vram == 0x100000 ? 0x11 : 0x1011));
289 out_be32(&platinum_regs->reg[21].r, 0x100);
290 out_be32(&platinum_regs->reg[22].r, 1);
291 out_be32(&platinum_regs->reg[23].r, 1);
292 out_be32(&platinum_regs->reg[26].r, 0xc00);
293 out_be32(&platinum_regs->reg[27].r, 0x235);
294 /* out_be32(&platinum_regs->reg[27].r, 0x2aa); */
296 STORE_D2(0, (pinfo->total_vram == 0x100000 ?
297 init->dacula_ctrl[cmode] & 0xf :
298 init->dacula_ctrl[cmode]));
302 set_platinum_clock(pinfo);
304 out_be32(&platinum_regs->reg[24].r, 0); /* turn display on */
308 * Set misc info vars for this driver
310 static void __devinit platinum_init_info(struct fb_info *info, struct fb_info_platinum *pinfo)
313 info->fbops = &platinumfb_ops;
314 info->pseudo_palette = pinfo->pseudo_palette;
315 info->flags = FBINFO_DEFAULT;
316 info->screen_base = pinfo->frame_buffer + 0x20;
318 fb_alloc_cmap(&info->cmap, 256, 0);
320 /* Fill fix common fields */
321 strcpy(info->fix.id, "platinum");
322 info->fix.mmio_start = pinfo->platinum_regs_phys;
323 info->fix.mmio_len = 0x1000;
324 info->fix.type = FB_TYPE_PACKED_PIXELS;
325 info->fix.smem_start = pinfo->frame_buffer_phys + 0x20; /* will be updated later */
326 info->fix.smem_len = pinfo->total_vram - 0x20;
327 info->fix.ywrapstep = 0;
328 info->fix.xpanstep = 0;
329 info->fix.ypanstep = 0;
330 info->fix.type_aux = 0;
331 info->fix.accel = FB_ACCEL_NONE;
335 static int __devinit platinum_init_fb(struct fb_info *info)
337 struct fb_info_platinum *pinfo = info->par;
338 struct fb_var_screeninfo var;
341 sense = read_platinum_sense(pinfo);
342 printk(KERN_INFO "platinumfb: Monitor sense value = 0x%x, ", sense);
343 if (default_vmode == VMODE_NVRAM) {
345 default_vmode = nvram_read_byte(NV_VMODE);
346 if (default_vmode <= 0 || default_vmode > VMODE_MAX ||
347 !platinum_reg_init[default_vmode-1])
349 default_vmode = VMODE_CHOOSE;
351 if (default_vmode == VMODE_CHOOSE) {
352 default_vmode = mac_map_monitor_sense(sense);
354 if (default_vmode <= 0 || default_vmode > VMODE_MAX)
355 default_vmode = VMODE_640_480_60;
357 if (default_cmode == CMODE_NVRAM)
358 default_cmode = nvram_read_byte(NV_CMODE);
360 if (default_cmode < CMODE_8 || default_cmode > CMODE_32)
361 default_cmode = CMODE_8;
363 * Reduce the pixel size if we don't have enough VRAM.
365 while(default_cmode > CMODE_8 &&
366 platinum_vram_reqd(default_vmode, default_cmode) > pinfo->total_vram)
369 printk("platinumfb: Using video mode %d and color mode %d.\n", default_vmode, default_cmode);
371 /* Setup default var */
372 if (mac_vmode_to_var(default_vmode, default_cmode, &var) < 0) {
373 /* This shouldn't happen! */
374 printk("mac_vmode_to_var(%d, %d,) failed\n", default_vmode, default_cmode);
376 default_vmode = VMODE_640_480_60;
377 default_cmode = CMODE_8;
378 if (mac_vmode_to_var(default_vmode, default_cmode, &var) < 0) {
379 printk(KERN_ERR "platinumfb: mac_vmode_to_var() failed\n");
384 /* Initialize info structure */
385 platinum_init_info(info, pinfo);
387 /* Apply default var */
389 var.activate = FB_ACTIVATE_NOW;
390 rc = fb_set_var(info, &var);
391 if (rc && (default_vmode != VMODE_640_480_60 || default_cmode != CMODE_8))
394 /* Register with fbdev layer */
395 rc = register_framebuffer(info);
399 printk(KERN_INFO "fb%d: Apple Platinum frame buffer device\n", info->node);
405 * Get the monitor sense value.
406 * Note that this can be called before calibrate_delay,
407 * so we can't use udelay.
409 static int read_platinum_sense(struct fb_info_platinum *info)
411 volatile struct platinum_regs __iomem *platinum_regs = info->platinum_regs;
414 out_be32(&platinum_regs->reg[23].r, 7); /* turn off drivers */
416 sense = (~in_be32(&platinum_regs->reg[23].r) & 7) << 8;
418 /* drive each sense line low in turn and collect the other 2 */
419 out_be32(&platinum_regs->reg[23].r, 3); /* drive A low */
421 sense |= (~in_be32(&platinum_regs->reg[23].r) & 3) << 4;
422 out_be32(&platinum_regs->reg[23].r, 5); /* drive B low */
424 sense |= (~in_be32(&platinum_regs->reg[23].r) & 4) << 1;
425 sense |= (~in_be32(&platinum_regs->reg[23].r) & 1) << 2;
426 out_be32(&platinum_regs->reg[23].r, 6); /* drive C low */
428 sense |= (~in_be32(&platinum_regs->reg[23].r) & 6) >> 1;
430 out_be32(&platinum_regs->reg[23].r, 7); /* turn off drivers */
436 * This routine takes a user-supplied var, and picks the best vmode/cmode from it.
437 * It also updates the var structure to the actual mode data obtained
439 static int platinum_var_to_par(struct fb_var_screeninfo *var,
440 struct fb_info_platinum *pinfo,
445 if (mac_var_to_vmode(var, &vmode, &cmode) != 0) {
446 printk(KERN_ERR "platinum_var_to_par: mac_var_to_vmode unsuccessful.\n");
447 printk(KERN_ERR "platinum_var_to_par: var->xres = %d\n", var->xres);
448 printk(KERN_ERR "platinum_var_to_par: var->yres = %d\n", var->yres);
449 printk(KERN_ERR "platinum_var_to_par: var->xres_virtual = %d\n", var->xres_virtual);
450 printk(KERN_ERR "platinum_var_to_par: var->yres_virtual = %d\n", var->yres_virtual);
451 printk(KERN_ERR "platinum_var_to_par: var->bits_per_pixel = %d\n", var->bits_per_pixel);
452 printk(KERN_ERR "platinum_var_to_par: var->pixclock = %d\n", var->pixclock);
453 printk(KERN_ERR "platinum_var_to_par: var->vmode = %d\n", var->vmode);
457 if (!platinum_reg_init[vmode-1]) {
458 printk(KERN_ERR "platinum_var_to_par, vmode %d not valid.\n", vmode);
462 if (platinum_vram_reqd(vmode, cmode) > pinfo->total_vram) {
463 printk(KERN_ERR "platinum_var_to_par, not enough ram for vmode %d, cmode %d.\n", vmode, cmode);
467 if (mac_vmode_to_var(vmode, cmode, var))
473 pinfo->vmode = vmode;
474 pinfo->cmode = cmode;
475 pinfo->xres = vmode_attrs[vmode-1].hres;
476 pinfo->yres = vmode_attrs[vmode-1].vres;
479 pinfo->vxres = pinfo->xres;
480 pinfo->vyres = pinfo->yres;
487 * Parse user speficied options (`video=platinumfb:')
489 static int __init platinumfb_setup(char *options)
493 if (!options || !*options)
496 while ((this_opt = strsep(&options, ",")) != NULL) {
497 if (!strncmp(this_opt, "vmode:", 6)) {
498 int vmode = simple_strtoul(this_opt+6, NULL, 0);
499 if (vmode > 0 && vmode <= VMODE_MAX)
500 default_vmode = vmode;
501 } else if (!strncmp(this_opt, "cmode:", 6)) {
502 int depth = simple_strtoul(this_opt+6, NULL, 0);
506 default_cmode = CMODE_8;
510 default_cmode = CMODE_16;
514 default_cmode = CMODE_32;
523 #define invalidate_cache(addr) \
524 asm volatile("eieio; dcbf 0,%1" \
525 : "=m" (*(addr)) : "r" (addr) : "memory");
527 #define invalidate_cache(addr)
530 static int __devinit platinumfb_probe(struct of_device* odev,
531 const struct of_device_id *match)
533 struct device_node *dp = odev->node;
534 struct fb_info *info;
535 struct fb_info_platinum *pinfo;
536 volatile __u8 *fbuffer;
537 int bank0, bank1, bank2, bank3, rc;
539 printk(KERN_INFO "platinumfb: Found Apple Platinum video hardware\n");
541 info = framebuffer_alloc(sizeof(*pinfo), &odev->dev);
546 if (of_address_to_resource(dp, 0, &pinfo->rsrc_reg) ||
547 of_address_to_resource(dp, 1, &pinfo->rsrc_fb)) {
548 printk(KERN_ERR "platinumfb: Can't get resources\n");
549 framebuffer_release(info);
552 if (!request_mem_region(pinfo->rsrc_reg.start,
553 pinfo->rsrc_reg.start -
554 pinfo->rsrc_reg.end + 1,
555 "platinumfb registers")) {
556 framebuffer_release(info);
559 if (!request_mem_region(pinfo->rsrc_fb.start,
561 - pinfo->rsrc_fb.end + 1,
562 "platinumfb framebuffer")) {
563 release_mem_region(pinfo->rsrc_reg.start,
564 pinfo->rsrc_reg.end -
565 pinfo->rsrc_reg.start + 1);
566 framebuffer_release(info);
570 /* frame buffer - map only 4MB */
571 pinfo->frame_buffer_phys = pinfo->rsrc_fb.start;
572 pinfo->frame_buffer = __ioremap(pinfo->rsrc_fb.start, 0x400000,
574 pinfo->base_frame_buffer = pinfo->frame_buffer;
577 pinfo->platinum_regs_phys = pinfo->rsrc_reg.start;
578 pinfo->platinum_regs = ioremap(pinfo->rsrc_reg.start, 0x1000);
580 pinfo->cmap_regs_phys = 0xf301b000; /* XXX not in prom? */
581 request_mem_region(pinfo->cmap_regs_phys, 0x1000, "platinumfb cmap");
582 pinfo->cmap_regs = ioremap(pinfo->cmap_regs_phys, 0x1000);
584 /* Grok total video ram */
585 out_be32(&pinfo->platinum_regs->reg[16].r, (unsigned)pinfo->frame_buffer_phys);
586 out_be32(&pinfo->platinum_regs->reg[20].r, 0x1011); /* select max vram */
587 out_be32(&pinfo->platinum_regs->reg[24].r, 0); /* switch in vram */
589 fbuffer = pinfo->base_frame_buffer;
590 fbuffer[0x100000] = 0x34;
591 fbuffer[0x100008] = 0x0;
592 invalidate_cache(&fbuffer[0x100000]);
593 fbuffer[0x200000] = 0x56;
594 fbuffer[0x200008] = 0x0;
595 invalidate_cache(&fbuffer[0x200000]);
596 fbuffer[0x300000] = 0x78;
597 fbuffer[0x300008] = 0x0;
598 invalidate_cache(&fbuffer[0x300000]);
599 bank0 = 1; /* builtin 1MB vram, always there */
600 bank1 = fbuffer[0x100000] == 0x34;
601 bank2 = fbuffer[0x200000] == 0x56;
602 bank3 = fbuffer[0x300000] == 0x78;
603 pinfo->total_vram = (bank0 + bank1 + bank2 + bank3) * 0x100000;
604 printk(KERN_INFO "platinumfb: Total VRAM = %dMB (%d%d%d%d)\n", (int) (pinfo->total_vram / 1024 / 1024),
605 bank3, bank2, bank1, bank0);
608 * Try to determine whether we have an old or a new DACula.
610 out_8(&pinfo->cmap_regs->addr, 0x40);
611 pinfo->dactype = in_8(&pinfo->cmap_regs->d2);
612 switch (pinfo->dactype) {
615 printk(KERN_INFO "platinumfb: DACula type 0x3c\n");
619 printk(KERN_INFO "platinumfb: DACula type 0x84\n");
623 printk(KERN_INFO "platinumfb: Unknown DACula type: %x\n", pinfo->dactype);
626 dev_set_drvdata(&odev->dev, info);
628 rc = platinum_init_fb(info);
630 iounmap(pinfo->frame_buffer);
631 iounmap(pinfo->platinum_regs);
632 iounmap(pinfo->cmap_regs);
633 dev_set_drvdata(&odev->dev, NULL);
634 framebuffer_release(info);
640 static int __devexit platinumfb_remove(struct of_device* odev)
642 struct fb_info *info = dev_get_drvdata(&odev->dev);
643 struct fb_info_platinum *pinfo = info->par;
645 unregister_framebuffer (info);
647 /* Unmap frame buffer and registers */
648 release_mem_region(pinfo->rsrc_fb.start,
650 pinfo->rsrc_fb.start + 1);
651 release_mem_region(pinfo->rsrc_reg.start,
652 pinfo->rsrc_reg.end -
653 pinfo->rsrc_reg.start + 1);
654 iounmap(pinfo->frame_buffer);
655 iounmap(pinfo->platinum_regs);
656 release_mem_region(pinfo->cmap_regs_phys, 0x1000);
657 iounmap(pinfo->cmap_regs);
659 framebuffer_release(info);
664 static struct of_device_id platinumfb_match[] =
672 static struct of_platform_driver platinum_driver =
674 .name = "platinumfb",
675 .match_table = platinumfb_match,
676 .probe = platinumfb_probe,
677 .remove = platinumfb_remove,
680 static int __init platinumfb_init(void)
685 if (fb_get_options("platinumfb", &option))
687 platinumfb_setup(option);
689 of_register_platform_driver(&platinum_driver);
694 static void __exit platinumfb_exit(void)
696 of_unregister_platform_driver(&platinum_driver);
699 MODULE_LICENSE("GPL");
700 MODULE_DESCRIPTION("framebuffer driver for Apple Platinum video");
701 module_init(platinumfb_init);
704 module_exit(platinumfb_exit);