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/vmalloc.h>
28 #include <linux/delay.h>
29 #include <linux/interrupt.h>
31 #include <linux/init.h>
32 #include <linux/nvram.h>
33 #include <linux/of_device.h>
34 #include <linux/of_platform.h>
37 #include <asm/pgtable.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[16];
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 mutex_lock(&info->mm_lock);
144 info->fix.smem_start = (pinfo->frame_buffer_phys) + init->fb_offset + offset;
145 mutex_unlock(&info->mm_lock);
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)
150 printk("line_length: %x\n", info->fix.line_length);
154 static int platinumfb_blank(int blank, struct fb_info *fb)
157 * Blank the screen if blank_mode != 0, else unblank. If blank == NULL
158 * then the caller blanks by setting the CLUT (Color Look Up Table) to all
159 * black. Return 0 if blanking succeeded, != 0 if un-/blanking failed due
160 * to e.g. a video mode which doesn't support it. Implements VESA suspend
161 * and powerdown modes on hardware that supports disabling hsync/vsync:
162 * blank_mode == 2: suspend vsync
163 * blank_mode == 3: suspend hsync
164 * blank_mode == 4: powerdown
166 /* [danj] I think there's something fishy about those constants... */
168 struct fb_info_platinum *info = (struct fb_info_platinum *) fb;
171 ctrl = ld_le32(&info->platinum_regs->ctrl.r) | 0x33;
174 if (blank & VESA_VSYNC_SUSPEND)
176 if (blank & VESA_HSYNC_SUSPEND)
178 out_le32(&info->platinum_regs->ctrl.r, ctrl);
180 /* TODO: Figure out how the heck to powerdown this thing! */
184 static int platinumfb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
185 u_int transp, struct fb_info *info)
187 struct fb_info_platinum *pinfo = info->par;
188 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
197 pinfo->palette[regno].red = red;
198 pinfo->palette[regno].green = green;
199 pinfo->palette[regno].blue = blue;
201 out_8(&cmap_regs->addr, regno); /* tell clut what addr to fill */
202 out_8(&cmap_regs->lut, red); /* send one color channel at */
203 out_8(&cmap_regs->lut, green); /* a time... */
204 out_8(&cmap_regs->lut, blue);
208 u32 *pal = info->pseudo_palette;
209 switch (pinfo->cmode) {
211 pal[regno] = (regno << 10) | (regno << 5) | regno;
214 i = (regno << 8) | regno;
215 pal[regno] = (i << 16) | i;
223 static inline int platinum_vram_reqd(int video_mode, int color_mode)
225 int baseval = vmode_attrs[video_mode-1].hres * (1<<color_mode);
227 if ((video_mode == VMODE_832_624_75) && (color_mode > CMODE_8))
232 return vmode_attrs[video_mode-1].vres * baseval + 0x1000;
235 #define STORE_D2(a, d) { \
236 out_8(&cmap_regs->addr, (a+32)); \
237 out_8(&cmap_regs->d2, (d)); \
240 static void set_platinum_clock(struct fb_info_platinum *pinfo)
242 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
243 struct platinum_regvals *init;
245 init = platinum_reg_init[pinfo->vmode-1];
248 out_8(&cmap_regs->addr,3+32);
250 if (in_8(&cmap_regs->d2) == 2) {
251 STORE_D2(7, init->clock_params[pinfo->clktype][0]);
252 STORE_D2(8, init->clock_params[pinfo->clktype][1]);
255 STORE_D2(4, init->clock_params[pinfo->clktype][0]);
256 STORE_D2(5, init->clock_params[pinfo->clktype][1]);
265 /* Now how about actually saying, Make it so! */
266 /* Some things in here probably don't need to be done each time. */
267 static void platinum_set_hardware(struct fb_info_platinum *pinfo)
269 volatile struct platinum_regs __iomem *platinum_regs = pinfo->platinum_regs;
270 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
271 struct platinum_regvals *init;
275 vmode = pinfo->vmode;
276 cmode = pinfo->cmode;
278 init = platinum_reg_init[vmode - 1];
280 /* Initialize display timing registers */
281 out_be32(&platinum_regs->reg[24].r, 7); /* turn display off */
283 for (i = 0; i < 26; ++i)
284 out_be32(&platinum_regs->reg[i+32].r, init->regs[i]);
286 out_be32(&platinum_regs->reg[26+32].r, (pinfo->total_vram == 0x100000 ?
287 init->offset[cmode] + 4 - cmode :
288 init->offset[cmode]));
289 out_be32(&platinum_regs->reg[16].r, (unsigned) pinfo->frame_buffer_phys+init->fb_offset+0x10);
290 out_be32(&platinum_regs->reg[18].r, init->pitch[cmode]);
291 out_be32(&platinum_regs->reg[19].r, (pinfo->total_vram == 0x100000 ?
292 init->mode[cmode+1] :
294 out_be32(&platinum_regs->reg[20].r, (pinfo->total_vram == 0x100000 ? 0x11 : 0x1011));
295 out_be32(&platinum_regs->reg[21].r, 0x100);
296 out_be32(&platinum_regs->reg[22].r, 1);
297 out_be32(&platinum_regs->reg[23].r, 1);
298 out_be32(&platinum_regs->reg[26].r, 0xc00);
299 out_be32(&platinum_regs->reg[27].r, 0x235);
300 /* out_be32(&platinum_regs->reg[27].r, 0x2aa); */
302 STORE_D2(0, (pinfo->total_vram == 0x100000 ?
303 init->dacula_ctrl[cmode] & 0xf :
304 init->dacula_ctrl[cmode]));
308 set_platinum_clock(pinfo);
310 out_be32(&platinum_regs->reg[24].r, 0); /* turn display on */
314 * Set misc info vars for this driver
316 static void platinum_init_info(struct fb_info *info,
317 struct fb_info_platinum *pinfo)
320 info->fbops = &platinumfb_ops;
321 info->pseudo_palette = pinfo->pseudo_palette;
322 info->flags = FBINFO_DEFAULT;
323 info->screen_base = pinfo->frame_buffer + 0x20;
325 fb_alloc_cmap(&info->cmap, 256, 0);
327 /* Fill fix common fields */
328 strcpy(info->fix.id, "platinum");
329 info->fix.mmio_start = pinfo->platinum_regs_phys;
330 info->fix.mmio_len = 0x1000;
331 info->fix.type = FB_TYPE_PACKED_PIXELS;
332 info->fix.smem_start = pinfo->frame_buffer_phys + 0x20; /* will be updated later */
333 info->fix.smem_len = pinfo->total_vram - 0x20;
334 info->fix.ywrapstep = 0;
335 info->fix.xpanstep = 0;
336 info->fix.ypanstep = 0;
337 info->fix.type_aux = 0;
338 info->fix.accel = FB_ACCEL_NONE;
342 static int platinum_init_fb(struct fb_info *info)
344 struct fb_info_platinum *pinfo = info->par;
345 struct fb_var_screeninfo var;
348 sense = read_platinum_sense(pinfo);
349 printk(KERN_INFO "platinumfb: Monitor sense value = 0x%x, ", sense);
350 if (default_vmode == VMODE_NVRAM) {
352 default_vmode = nvram_read_byte(NV_VMODE);
353 if (default_vmode <= 0 || default_vmode > VMODE_MAX ||
354 !platinum_reg_init[default_vmode-1])
356 default_vmode = VMODE_CHOOSE;
358 if (default_vmode == VMODE_CHOOSE) {
359 default_vmode = mac_map_monitor_sense(sense);
361 if (default_vmode <= 0 || default_vmode > VMODE_MAX)
362 default_vmode = VMODE_640_480_60;
364 if (default_cmode == CMODE_NVRAM)
365 default_cmode = nvram_read_byte(NV_CMODE);
367 if (default_cmode < CMODE_8 || default_cmode > CMODE_32)
368 default_cmode = CMODE_8;
370 * Reduce the pixel size if we don't have enough VRAM.
372 while(default_cmode > CMODE_8 &&
373 platinum_vram_reqd(default_vmode, default_cmode) > pinfo->total_vram)
376 printk("platinumfb: Using video mode %d and color mode %d.\n", default_vmode, default_cmode);
378 /* Setup default var */
379 if (mac_vmode_to_var(default_vmode, default_cmode, &var) < 0) {
380 /* This shouldn't happen! */
381 printk("mac_vmode_to_var(%d, %d,) failed\n", default_vmode, default_cmode);
383 default_vmode = VMODE_640_480_60;
384 default_cmode = CMODE_8;
385 if (mac_vmode_to_var(default_vmode, default_cmode, &var) < 0) {
386 printk(KERN_ERR "platinumfb: mac_vmode_to_var() failed\n");
391 /* Initialize info structure */
392 platinum_init_info(info, pinfo);
394 /* Apply default var */
396 var.activate = FB_ACTIVATE_NOW;
397 rc = fb_set_var(info, &var);
398 if (rc && (default_vmode != VMODE_640_480_60 || default_cmode != CMODE_8))
401 /* Register with fbdev layer */
402 rc = register_framebuffer(info);
406 printk(KERN_INFO "fb%d: Apple Platinum frame buffer device\n", info->node);
412 * Get the monitor sense value.
413 * Note that this can be called before calibrate_delay,
414 * so we can't use udelay.
416 static int read_platinum_sense(struct fb_info_platinum *info)
418 volatile struct platinum_regs __iomem *platinum_regs = info->platinum_regs;
421 out_be32(&platinum_regs->reg[23].r, 7); /* turn off drivers */
423 sense = (~in_be32(&platinum_regs->reg[23].r) & 7) << 8;
425 /* drive each sense line low in turn and collect the other 2 */
426 out_be32(&platinum_regs->reg[23].r, 3); /* drive A low */
428 sense |= (~in_be32(&platinum_regs->reg[23].r) & 3) << 4;
429 out_be32(&platinum_regs->reg[23].r, 5); /* drive B low */
431 sense |= (~in_be32(&platinum_regs->reg[23].r) & 4) << 1;
432 sense |= (~in_be32(&platinum_regs->reg[23].r) & 1) << 2;
433 out_be32(&platinum_regs->reg[23].r, 6); /* drive C low */
435 sense |= (~in_be32(&platinum_regs->reg[23].r) & 6) >> 1;
437 out_be32(&platinum_regs->reg[23].r, 7); /* turn off drivers */
443 * This routine takes a user-supplied var, and picks the best vmode/cmode from it.
444 * It also updates the var structure to the actual mode data obtained
446 static int platinum_var_to_par(struct fb_var_screeninfo *var,
447 struct fb_info_platinum *pinfo,
452 if (mac_var_to_vmode(var, &vmode, &cmode) != 0) {
453 printk(KERN_ERR "platinum_var_to_par: mac_var_to_vmode unsuccessful.\n");
454 printk(KERN_ERR "platinum_var_to_par: var->xres = %d\n", var->xres);
455 printk(KERN_ERR "platinum_var_to_par: var->yres = %d\n", var->yres);
456 printk(KERN_ERR "platinum_var_to_par: var->xres_virtual = %d\n", var->xres_virtual);
457 printk(KERN_ERR "platinum_var_to_par: var->yres_virtual = %d\n", var->yres_virtual);
458 printk(KERN_ERR "platinum_var_to_par: var->bits_per_pixel = %d\n", var->bits_per_pixel);
459 printk(KERN_ERR "platinum_var_to_par: var->pixclock = %d\n", var->pixclock);
460 printk(KERN_ERR "platinum_var_to_par: var->vmode = %d\n", var->vmode);
464 if (!platinum_reg_init[vmode-1]) {
465 printk(KERN_ERR "platinum_var_to_par, vmode %d not valid.\n", vmode);
469 if (platinum_vram_reqd(vmode, cmode) > pinfo->total_vram) {
470 printk(KERN_ERR "platinum_var_to_par, not enough ram for vmode %d, cmode %d.\n", vmode, cmode);
474 if (mac_vmode_to_var(vmode, cmode, var))
480 pinfo->vmode = vmode;
481 pinfo->cmode = cmode;
482 pinfo->xres = vmode_attrs[vmode-1].hres;
483 pinfo->yres = vmode_attrs[vmode-1].vres;
486 pinfo->vxres = pinfo->xres;
487 pinfo->vyres = pinfo->yres;
494 * Parse user specified options (`video=platinumfb:')
496 static int __init platinumfb_setup(char *options)
500 if (!options || !*options)
503 while ((this_opt = strsep(&options, ",")) != NULL) {
504 if (!strncmp(this_opt, "vmode:", 6)) {
505 int vmode = simple_strtoul(this_opt+6, NULL, 0);
506 if (vmode > 0 && vmode <= VMODE_MAX)
507 default_vmode = vmode;
508 } else if (!strncmp(this_opt, "cmode:", 6)) {
509 int depth = simple_strtoul(this_opt+6, NULL, 0);
513 default_cmode = CMODE_8;
517 default_cmode = CMODE_16;
521 default_cmode = CMODE_32;
530 #define invalidate_cache(addr) \
531 asm volatile("eieio; dcbf 0,%1" \
532 : "=m" (*(addr)) : "r" (addr) : "memory");
534 #define invalidate_cache(addr)
537 static int platinumfb_probe(struct platform_device* odev)
539 struct device_node *dp = odev->dev.of_node;
540 struct fb_info *info;
541 struct fb_info_platinum *pinfo;
542 volatile __u8 *fbuffer;
543 int bank0, bank1, bank2, bank3, rc;
545 dev_info(&odev->dev, "Found Apple Platinum video hardware\n");
547 info = framebuffer_alloc(sizeof(*pinfo), &odev->dev);
549 dev_err(&odev->dev, "Failed to allocate fbdev !\n");
554 if (of_address_to_resource(dp, 0, &pinfo->rsrc_reg) ||
555 of_address_to_resource(dp, 1, &pinfo->rsrc_fb)) {
556 dev_err(&odev->dev, "Can't get resources\n");
557 framebuffer_release(info);
560 dev_dbg(&odev->dev, " registers : 0x%llx...0x%llx\n",
561 (unsigned long long)pinfo->rsrc_reg.start,
562 (unsigned long long)pinfo->rsrc_reg.end);
563 dev_dbg(&odev->dev, " framebuffer: 0x%llx...0x%llx\n",
564 (unsigned long long)pinfo->rsrc_fb.start,
565 (unsigned long long)pinfo->rsrc_fb.end);
567 /* Do not try to request register space, they overlap with the
568 * northbridge and that can fail. Only request framebuffer
570 if (!request_mem_region(pinfo->rsrc_fb.start,
571 resource_size(&pinfo->rsrc_fb),
572 "platinumfb framebuffer")) {
573 printk(KERN_ERR "platinumfb: Can't request framebuffer !\n");
574 framebuffer_release(info);
578 /* frame buffer - map only 4MB */
579 pinfo->frame_buffer_phys = pinfo->rsrc_fb.start;
580 pinfo->frame_buffer = __ioremap(pinfo->rsrc_fb.start, 0x400000,
582 pinfo->base_frame_buffer = pinfo->frame_buffer;
585 pinfo->platinum_regs_phys = pinfo->rsrc_reg.start;
586 pinfo->platinum_regs = ioremap(pinfo->rsrc_reg.start, 0x1000);
588 pinfo->cmap_regs_phys = 0xf301b000; /* XXX not in prom? */
589 request_mem_region(pinfo->cmap_regs_phys, 0x1000, "platinumfb cmap");
590 pinfo->cmap_regs = ioremap(pinfo->cmap_regs_phys, 0x1000);
592 /* Grok total video ram */
593 out_be32(&pinfo->platinum_regs->reg[16].r, (unsigned)pinfo->frame_buffer_phys);
594 out_be32(&pinfo->platinum_regs->reg[20].r, 0x1011); /* select max vram */
595 out_be32(&pinfo->platinum_regs->reg[24].r, 0); /* switch in vram */
597 fbuffer = pinfo->base_frame_buffer;
598 fbuffer[0x100000] = 0x34;
599 fbuffer[0x100008] = 0x0;
600 invalidate_cache(&fbuffer[0x100000]);
601 fbuffer[0x200000] = 0x56;
602 fbuffer[0x200008] = 0x0;
603 invalidate_cache(&fbuffer[0x200000]);
604 fbuffer[0x300000] = 0x78;
605 fbuffer[0x300008] = 0x0;
606 invalidate_cache(&fbuffer[0x300000]);
607 bank0 = 1; /* builtin 1MB vram, always there */
608 bank1 = fbuffer[0x100000] == 0x34;
609 bank2 = fbuffer[0x200000] == 0x56;
610 bank3 = fbuffer[0x300000] == 0x78;
611 pinfo->total_vram = (bank0 + bank1 + bank2 + bank3) * 0x100000;
612 printk(KERN_INFO "platinumfb: Total VRAM = %dMB (%d%d%d%d)\n",
613 (unsigned int) (pinfo->total_vram / 1024 / 1024),
614 bank3, bank2, bank1, bank0);
617 * Try to determine whether we have an old or a new DACula.
619 out_8(&pinfo->cmap_regs->addr, 0x40);
620 pinfo->dactype = in_8(&pinfo->cmap_regs->d2);
621 switch (pinfo->dactype) {
624 printk(KERN_INFO "platinumfb: DACula type 0x3c\n");
628 printk(KERN_INFO "platinumfb: DACula type 0x84\n");
632 printk(KERN_INFO "platinumfb: Unknown DACula type: %x\n", pinfo->dactype);
635 dev_set_drvdata(&odev->dev, info);
637 rc = platinum_init_fb(info);
639 iounmap(pinfo->frame_buffer);
640 iounmap(pinfo->platinum_regs);
641 iounmap(pinfo->cmap_regs);
642 dev_set_drvdata(&odev->dev, NULL);
643 framebuffer_release(info);
649 static int platinumfb_remove(struct platform_device* odev)
651 struct fb_info *info = dev_get_drvdata(&odev->dev);
652 struct fb_info_platinum *pinfo = info->par;
654 unregister_framebuffer (info);
656 /* Unmap frame buffer and registers */
657 iounmap(pinfo->frame_buffer);
658 iounmap(pinfo->platinum_regs);
659 iounmap(pinfo->cmap_regs);
661 release_mem_region(pinfo->rsrc_fb.start,
662 resource_size(&pinfo->rsrc_fb));
664 release_mem_region(pinfo->cmap_regs_phys, 0x1000);
666 framebuffer_release(info);
671 static struct of_device_id platinumfb_match[] =
679 static struct platform_driver platinum_driver =
682 .name = "platinumfb",
683 .owner = THIS_MODULE,
684 .of_match_table = platinumfb_match,
686 .probe = platinumfb_probe,
687 .remove = platinumfb_remove,
690 static int __init platinumfb_init(void)
695 if (fb_get_options("platinumfb", &option))
697 platinumfb_setup(option);
699 platform_driver_register(&platinum_driver);
704 static void __exit platinumfb_exit(void)
706 platform_driver_unregister(&platinum_driver);
709 MODULE_LICENSE("GPL");
710 MODULE_DESCRIPTION("framebuffer driver for Apple Platinum video");
711 module_init(platinumfb_init);
714 module_exit(platinumfb_exit);