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
22 #include <linux/module.h>
23 #include <linux/kernel.h>
24 #include <linux/errno.h>
25 #include <linux/string.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/nvram.h>
36 #include <asm/pgtable.h>
37 #include <asm/of_device.h>
38 #include <asm/of_platform.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[16];
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;
73 struct resource rsrc_fb, rsrc_reg;
77 * Frame buffer device API
80 static int platinumfb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
81 u_int transp, struct fb_info *info);
82 static int platinumfb_blank(int blank_mode, struct fb_info *info);
83 static int platinumfb_set_par (struct fb_info *info);
84 static int platinumfb_check_var (struct fb_var_screeninfo *var, struct fb_info *info);
90 static inline int platinum_vram_reqd(int video_mode, int color_mode);
91 static int read_platinum_sense(struct fb_info_platinum *pinfo);
92 static void set_platinum_clock(struct fb_info_platinum *pinfo);
93 static void platinum_set_hardware(struct fb_info_platinum *pinfo);
94 static int platinum_var_to_par(struct fb_var_screeninfo *var,
95 struct fb_info_platinum *pinfo,
99 * Interface used by the world
102 static struct fb_ops platinumfb_ops = {
103 .owner = THIS_MODULE,
104 .fb_check_var = platinumfb_check_var,
105 .fb_set_par = platinumfb_set_par,
106 .fb_setcolreg = platinumfb_setcolreg,
107 .fb_blank = platinumfb_blank,
108 .fb_fillrect = cfb_fillrect,
109 .fb_copyarea = cfb_copyarea,
110 .fb_imageblit = cfb_imageblit,
114 * Checks a var structure
116 static int platinumfb_check_var (struct fb_var_screeninfo *var, struct fb_info *info)
118 return platinum_var_to_par(var, info->par, 1);
122 * Applies current var to display
124 static int platinumfb_set_par (struct fb_info *info)
126 struct fb_info_platinum *pinfo = info->par;
127 struct platinum_regvals *init;
128 int err, offset = 0x20;
130 if((err = platinum_var_to_par(&info->var, pinfo, 0))) {
131 printk (KERN_ERR "platinumfb_set_par: error calling"
132 " platinum_var_to_par: %d.\n", err);
136 platinum_set_hardware(pinfo);
138 init = platinum_reg_init[pinfo->vmode-1];
140 if ((pinfo->vmode == VMODE_832_624_75) && (pinfo->cmode > CMODE_8))
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)
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) +
226 ((video_mode == VMODE_832_624_75) &&
227 (color_mode > CMODE_8)) ? 0x10 : 0x20) + 0x1000;
230 #define STORE_D2(a, d) { \
231 out_8(&cmap_regs->addr, (a+32)); \
232 out_8(&cmap_regs->d2, (d)); \
235 static void set_platinum_clock(struct fb_info_platinum *pinfo)
237 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
238 struct platinum_regvals *init;
240 init = platinum_reg_init[pinfo->vmode-1];
243 out_8(&cmap_regs->addr,3+32);
245 if (in_8(&cmap_regs->d2) == 2) {
246 STORE_D2(7, init->clock_params[pinfo->clktype][0]);
247 STORE_D2(8, init->clock_params[pinfo->clktype][1]);
250 STORE_D2(4, init->clock_params[pinfo->clktype][0]);
251 STORE_D2(5, init->clock_params[pinfo->clktype][1]);
260 /* Now how about actually saying, Make it so! */
261 /* Some things in here probably don't need to be done each time. */
262 static void platinum_set_hardware(struct fb_info_platinum *pinfo)
264 volatile struct platinum_regs __iomem *platinum_regs = pinfo->platinum_regs;
265 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
266 struct platinum_regvals *init;
270 vmode = pinfo->vmode;
271 cmode = pinfo->cmode;
273 init = platinum_reg_init[vmode - 1];
275 /* Initialize display timing registers */
276 out_be32(&platinum_regs->reg[24].r, 7); /* turn display off */
278 for (i = 0; i < 26; ++i)
279 out_be32(&platinum_regs->reg[i+32].r, init->regs[i]);
281 out_be32(&platinum_regs->reg[26+32].r, (pinfo->total_vram == 0x100000 ?
282 init->offset[cmode] + 4 - cmode :
283 init->offset[cmode]));
284 out_be32(&platinum_regs->reg[16].r, (unsigned) pinfo->frame_buffer_phys+init->fb_offset+0x10);
285 out_be32(&platinum_regs->reg[18].r, init->pitch[cmode]);
286 out_be32(&platinum_regs->reg[19].r, (pinfo->total_vram == 0x100000 ?
287 init->mode[cmode+1] :
289 out_be32(&platinum_regs->reg[20].r, (pinfo->total_vram == 0x100000 ? 0x11 : 0x1011));
290 out_be32(&platinum_regs->reg[21].r, 0x100);
291 out_be32(&platinum_regs->reg[22].r, 1);
292 out_be32(&platinum_regs->reg[23].r, 1);
293 out_be32(&platinum_regs->reg[26].r, 0xc00);
294 out_be32(&platinum_regs->reg[27].r, 0x235);
295 /* out_be32(&platinum_regs->reg[27].r, 0x2aa); */
297 STORE_D2(0, (pinfo->total_vram == 0x100000 ?
298 init->dacula_ctrl[cmode] & 0xf :
299 init->dacula_ctrl[cmode]));
303 set_platinum_clock(pinfo);
305 out_be32(&platinum_regs->reg[24].r, 0); /* turn display on */
309 * Set misc info vars for this driver
311 static void __devinit platinum_init_info(struct fb_info *info, struct fb_info_platinum *pinfo)
314 info->fbops = &platinumfb_ops;
315 info->pseudo_palette = pinfo->pseudo_palette;
316 info->flags = FBINFO_DEFAULT;
317 info->screen_base = pinfo->frame_buffer + 0x20;
319 fb_alloc_cmap(&info->cmap, 256, 0);
321 /* Fill fix common fields */
322 strcpy(info->fix.id, "platinum");
323 info->fix.mmio_start = pinfo->platinum_regs_phys;
324 info->fix.mmio_len = 0x1000;
325 info->fix.type = FB_TYPE_PACKED_PIXELS;
326 info->fix.smem_start = pinfo->frame_buffer_phys + 0x20; /* will be updated later */
327 info->fix.smem_len = pinfo->total_vram - 0x20;
328 info->fix.ywrapstep = 0;
329 info->fix.xpanstep = 0;
330 info->fix.ypanstep = 0;
331 info->fix.type_aux = 0;
332 info->fix.accel = FB_ACCEL_NONE;
336 static int __devinit platinum_init_fb(struct fb_info *info)
338 struct fb_info_platinum *pinfo = info->par;
339 struct fb_var_screeninfo var;
342 sense = read_platinum_sense(pinfo);
343 printk(KERN_INFO "platinumfb: Monitor sense value = 0x%x, ", sense);
344 if (default_vmode == VMODE_NVRAM) {
346 default_vmode = nvram_read_byte(NV_VMODE);
347 if (default_vmode <= 0 || default_vmode > VMODE_MAX ||
348 !platinum_reg_init[default_vmode-1])
350 default_vmode = VMODE_CHOOSE;
352 if (default_vmode == VMODE_CHOOSE) {
353 default_vmode = mac_map_monitor_sense(sense);
355 if (default_vmode <= 0 || default_vmode > VMODE_MAX)
356 default_vmode = VMODE_640_480_60;
358 if (default_cmode == CMODE_NVRAM)
359 default_cmode = nvram_read_byte(NV_CMODE);
361 if (default_cmode < CMODE_8 || default_cmode > CMODE_32)
362 default_cmode = CMODE_8;
364 * Reduce the pixel size if we don't have enough VRAM.
366 while(default_cmode > CMODE_8 &&
367 platinum_vram_reqd(default_vmode, default_cmode) > pinfo->total_vram)
370 printk("platinumfb: Using video mode %d and color mode %d.\n", default_vmode, default_cmode);
372 /* Setup default var */
373 if (mac_vmode_to_var(default_vmode, default_cmode, &var) < 0) {
374 /* This shouldn't happen! */
375 printk("mac_vmode_to_var(%d, %d,) failed\n", default_vmode, default_cmode);
377 default_vmode = VMODE_640_480_60;
378 default_cmode = CMODE_8;
379 if (mac_vmode_to_var(default_vmode, default_cmode, &var) < 0) {
380 printk(KERN_ERR "platinumfb: mac_vmode_to_var() failed\n");
385 /* Initialize info structure */
386 platinum_init_info(info, pinfo);
388 /* Apply default var */
390 var.activate = FB_ACTIVATE_NOW;
391 rc = fb_set_var(info, &var);
392 if (rc && (default_vmode != VMODE_640_480_60 || default_cmode != CMODE_8))
395 /* Register with fbdev layer */
396 rc = register_framebuffer(info);
400 printk(KERN_INFO "fb%d: Apple Platinum frame buffer device\n", info->node);
406 * Get the monitor sense value.
407 * Note that this can be called before calibrate_delay,
408 * so we can't use udelay.
410 static int read_platinum_sense(struct fb_info_platinum *info)
412 volatile struct platinum_regs __iomem *platinum_regs = info->platinum_regs;
415 out_be32(&platinum_regs->reg[23].r, 7); /* turn off drivers */
417 sense = (~in_be32(&platinum_regs->reg[23].r) & 7) << 8;
419 /* drive each sense line low in turn and collect the other 2 */
420 out_be32(&platinum_regs->reg[23].r, 3); /* drive A low */
422 sense |= (~in_be32(&platinum_regs->reg[23].r) & 3) << 4;
423 out_be32(&platinum_regs->reg[23].r, 5); /* drive B low */
425 sense |= (~in_be32(&platinum_regs->reg[23].r) & 4) << 1;
426 sense |= (~in_be32(&platinum_regs->reg[23].r) & 1) << 2;
427 out_be32(&platinum_regs->reg[23].r, 6); /* drive C low */
429 sense |= (~in_be32(&platinum_regs->reg[23].r) & 6) >> 1;
431 out_be32(&platinum_regs->reg[23].r, 7); /* turn off drivers */
437 * This routine takes a user-supplied var, and picks the best vmode/cmode from it.
438 * It also updates the var structure to the actual mode data obtained
440 static int platinum_var_to_par(struct fb_var_screeninfo *var,
441 struct fb_info_platinum *pinfo,
446 if (mac_var_to_vmode(var, &vmode, &cmode) != 0) {
447 printk(KERN_ERR "platinum_var_to_par: mac_var_to_vmode unsuccessful.\n");
448 printk(KERN_ERR "platinum_var_to_par: var->xres = %d\n", var->xres);
449 printk(KERN_ERR "platinum_var_to_par: var->yres = %d\n", var->yres);
450 printk(KERN_ERR "platinum_var_to_par: var->xres_virtual = %d\n", var->xres_virtual);
451 printk(KERN_ERR "platinum_var_to_par: var->yres_virtual = %d\n", var->yres_virtual);
452 printk(KERN_ERR "platinum_var_to_par: var->bits_per_pixel = %d\n", var->bits_per_pixel);
453 printk(KERN_ERR "platinum_var_to_par: var->pixclock = %d\n", var->pixclock);
454 printk(KERN_ERR "platinum_var_to_par: var->vmode = %d\n", var->vmode);
458 if (!platinum_reg_init[vmode-1]) {
459 printk(KERN_ERR "platinum_var_to_par, vmode %d not valid.\n", vmode);
463 if (platinum_vram_reqd(vmode, cmode) > pinfo->total_vram) {
464 printk(KERN_ERR "platinum_var_to_par, not enough ram for vmode %d, cmode %d.\n", vmode, cmode);
468 if (mac_vmode_to_var(vmode, cmode, var))
474 pinfo->vmode = vmode;
475 pinfo->cmode = cmode;
476 pinfo->xres = vmode_attrs[vmode-1].hres;
477 pinfo->yres = vmode_attrs[vmode-1].vres;
480 pinfo->vxres = pinfo->xres;
481 pinfo->vyres = pinfo->yres;
488 * Parse user speficied options (`video=platinumfb:')
490 static int __init platinumfb_setup(char *options)
494 if (!options || !*options)
497 while ((this_opt = strsep(&options, ",")) != NULL) {
498 if (!strncmp(this_opt, "vmode:", 6)) {
499 int vmode = simple_strtoul(this_opt+6, NULL, 0);
500 if (vmode > 0 && vmode <= VMODE_MAX)
501 default_vmode = vmode;
502 } else if (!strncmp(this_opt, "cmode:", 6)) {
503 int depth = simple_strtoul(this_opt+6, NULL, 0);
507 default_cmode = CMODE_8;
511 default_cmode = CMODE_16;
515 default_cmode = CMODE_32;
524 #define invalidate_cache(addr) \
525 asm volatile("eieio; dcbf 0,%1" \
526 : "=m" (*(addr)) : "r" (addr) : "memory");
528 #define invalidate_cache(addr)
531 static int __devinit platinumfb_probe(struct of_device* odev,
532 const struct of_device_id *match)
534 struct device_node *dp = odev->node;
535 struct fb_info *info;
536 struct fb_info_platinum *pinfo;
537 volatile __u8 *fbuffer;
538 int bank0, bank1, bank2, bank3, rc;
540 dev_info(&odev->dev, "Found Apple Platinum video hardware\n");
542 info = framebuffer_alloc(sizeof(*pinfo), &odev->dev);
544 dev_err(&odev->dev, "Failed to allocate fbdev !\n");
549 if (of_address_to_resource(dp, 0, &pinfo->rsrc_reg) ||
550 of_address_to_resource(dp, 1, &pinfo->rsrc_fb)) {
551 dev_err(&odev->dev, "Can't get resources\n");
552 framebuffer_release(info);
555 dev_dbg(&odev->dev, " registers : 0x%llx...0x%llx\n",
556 (unsigned long long)pinfo->rsrc_reg.start,
557 (unsigned long long)pinfo->rsrc_reg.end);
558 dev_dbg(&odev->dev, " framebuffer: 0x%llx...0x%llx\n",
559 (unsigned long long)pinfo->rsrc_fb.start,
560 (unsigned long long)pinfo->rsrc_fb.end);
562 /* Do not try to request register space, they overlap with the
563 * northbridge and that can fail. Only request framebuffer
565 if (!request_mem_region(pinfo->rsrc_fb.start,
566 pinfo->rsrc_fb.end - pinfo->rsrc_fb.start + 1,
567 "platinumfb framebuffer")) {
568 printk(KERN_ERR "platinumfb: Can't request framebuffer !\n");
569 framebuffer_release(info);
573 /* frame buffer - map only 4MB */
574 pinfo->frame_buffer_phys = pinfo->rsrc_fb.start;
575 pinfo->frame_buffer = __ioremap(pinfo->rsrc_fb.start, 0x400000,
577 pinfo->base_frame_buffer = pinfo->frame_buffer;
580 pinfo->platinum_regs_phys = pinfo->rsrc_reg.start;
581 pinfo->platinum_regs = ioremap(pinfo->rsrc_reg.start, 0x1000);
583 pinfo->cmap_regs_phys = 0xf301b000; /* XXX not in prom? */
584 request_mem_region(pinfo->cmap_regs_phys, 0x1000, "platinumfb cmap");
585 pinfo->cmap_regs = ioremap(pinfo->cmap_regs_phys, 0x1000);
587 /* Grok total video ram */
588 out_be32(&pinfo->platinum_regs->reg[16].r, (unsigned)pinfo->frame_buffer_phys);
589 out_be32(&pinfo->platinum_regs->reg[20].r, 0x1011); /* select max vram */
590 out_be32(&pinfo->platinum_regs->reg[24].r, 0); /* switch in vram */
592 fbuffer = pinfo->base_frame_buffer;
593 fbuffer[0x100000] = 0x34;
594 fbuffer[0x100008] = 0x0;
595 invalidate_cache(&fbuffer[0x100000]);
596 fbuffer[0x200000] = 0x56;
597 fbuffer[0x200008] = 0x0;
598 invalidate_cache(&fbuffer[0x200000]);
599 fbuffer[0x300000] = 0x78;
600 fbuffer[0x300008] = 0x0;
601 invalidate_cache(&fbuffer[0x300000]);
602 bank0 = 1; /* builtin 1MB vram, always there */
603 bank1 = fbuffer[0x100000] == 0x34;
604 bank2 = fbuffer[0x200000] == 0x56;
605 bank3 = fbuffer[0x300000] == 0x78;
606 pinfo->total_vram = (bank0 + bank1 + bank2 + bank3) * 0x100000;
607 printk(KERN_INFO "platinumfb: Total VRAM = %dMB (%d%d%d%d)\n",
608 (unsigned int) (pinfo->total_vram / 1024 / 1024),
609 bank3, bank2, bank1, bank0);
612 * Try to determine whether we have an old or a new DACula.
614 out_8(&pinfo->cmap_regs->addr, 0x40);
615 pinfo->dactype = in_8(&pinfo->cmap_regs->d2);
616 switch (pinfo->dactype) {
619 printk(KERN_INFO "platinumfb: DACula type 0x3c\n");
623 printk(KERN_INFO "platinumfb: DACula type 0x84\n");
627 printk(KERN_INFO "platinumfb: Unknown DACula type: %x\n", pinfo->dactype);
630 dev_set_drvdata(&odev->dev, info);
632 rc = platinum_init_fb(info);
634 iounmap(pinfo->frame_buffer);
635 iounmap(pinfo->platinum_regs);
636 iounmap(pinfo->cmap_regs);
637 dev_set_drvdata(&odev->dev, NULL);
638 framebuffer_release(info);
644 static int __devexit platinumfb_remove(struct of_device* odev)
646 struct fb_info *info = dev_get_drvdata(&odev->dev);
647 struct fb_info_platinum *pinfo = info->par;
649 unregister_framebuffer (info);
651 /* Unmap frame buffer and registers */
652 iounmap(pinfo->frame_buffer);
653 iounmap(pinfo->platinum_regs);
654 iounmap(pinfo->cmap_regs);
656 release_mem_region(pinfo->rsrc_fb.start,
658 pinfo->rsrc_fb.start + 1);
660 release_mem_region(pinfo->cmap_regs_phys, 0x1000);
662 framebuffer_release(info);
667 static struct of_device_id platinumfb_match[] =
675 static struct of_platform_driver platinum_driver =
677 .name = "platinumfb",
678 .match_table = platinumfb_match,
679 .probe = platinumfb_probe,
680 .remove = platinumfb_remove,
683 static int __init platinumfb_init(void)
688 if (fb_get_options("platinumfb", &option))
690 platinumfb_setup(option);
692 of_register_platform_driver(&platinum_driver);
697 static void __exit platinumfb_exit(void)
699 of_unregister_platform_driver(&platinum_driver);
702 MODULE_LICENSE("GPL");
703 MODULE_DESCRIPTION("framebuffer driver for Apple Platinum video");
704 module_init(platinumfb_init);
707 module_exit(platinumfb_exit);