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_address.h>
34 #include <linux/of_device.h>
35 #include <linux/of_platform.h>
38 #include "platinumfb.h"
40 static int default_vmode = VMODE_NVRAM;
41 static int default_cmode = CMODE_NVRAM;
43 struct fb_info_platinum {
52 __u8 red, green, blue;
54 u32 pseudo_palette[16];
56 volatile struct cmap_regs __iomem *cmap_regs;
57 unsigned long cmap_regs_phys;
59 volatile struct platinum_regs __iomem *platinum_regs;
60 unsigned long platinum_regs_phys;
62 __u8 __iomem *frame_buffer;
63 volatile __u8 __iomem *base_frame_buffer;
64 unsigned long frame_buffer_phys;
66 unsigned long total_vram;
70 struct resource rsrc_fb, rsrc_reg;
74 * Frame buffer device API
77 static int platinumfb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
78 u_int transp, struct fb_info *info);
79 static int platinumfb_blank(int blank_mode, struct fb_info *info);
80 static int platinumfb_set_par (struct fb_info *info);
81 static int platinumfb_check_var (struct fb_var_screeninfo *var, struct fb_info *info);
87 static inline int platinum_vram_reqd(int video_mode, int color_mode);
88 static int read_platinum_sense(struct fb_info_platinum *pinfo);
89 static void set_platinum_clock(struct fb_info_platinum *pinfo);
90 static void platinum_set_hardware(struct fb_info_platinum *pinfo);
91 static int platinum_var_to_par(struct fb_var_screeninfo *var,
92 struct fb_info_platinum *pinfo,
96 * Interface used by the world
99 static const struct fb_ops platinumfb_ops = {
100 .owner = THIS_MODULE,
101 FB_DEFAULT_IOMEM_OPS,
102 .fb_check_var = platinumfb_check_var,
103 .fb_set_par = platinumfb_set_par,
104 .fb_setcolreg = platinumfb_setcolreg,
105 .fb_blank = platinumfb_blank,
109 * Checks a var structure
111 static int platinumfb_check_var (struct fb_var_screeninfo *var, struct fb_info *info)
113 return platinum_var_to_par(var, info->par, 1);
117 * Applies current var to display
119 static int platinumfb_set_par (struct fb_info *info)
121 struct fb_info_platinum *pinfo = info->par;
122 struct platinum_regvals *init;
123 int err, offset = 0x20;
125 if((err = platinum_var_to_par(&info->var, pinfo, 0))) {
126 printk (KERN_ERR "platinumfb_set_par: error calling"
127 " platinum_var_to_par: %d.\n", err);
131 platinum_set_hardware(pinfo);
133 init = platinum_reg_init[pinfo->vmode-1];
135 if ((pinfo->vmode == VMODE_832_624_75) && (pinfo->cmode > CMODE_8))
138 info->screen_base = pinfo->frame_buffer + init->fb_offset + offset;
139 mutex_lock(&info->mm_lock);
140 info->fix.smem_start = (pinfo->frame_buffer_phys) + init->fb_offset + offset;
141 mutex_unlock(&info->mm_lock);
142 info->fix.visual = (pinfo->cmode == CMODE_8) ?
143 FB_VISUAL_PSEUDOCOLOR : FB_VISUAL_DIRECTCOLOR;
144 info->fix.line_length = vmode_attrs[pinfo->vmode-1].hres * (1<<pinfo->cmode)
146 printk("line_length: %x\n", info->fix.line_length);
150 static int platinumfb_blank(int blank, struct fb_info *fb)
153 * Blank the screen if blank_mode != 0, else unblank. If blank == NULL
154 * then the caller blanks by setting the CLUT (Color Look Up Table) to all
155 * black. Return 0 if blanking succeeded, != 0 if un-/blanking failed due
156 * to e.g. a video mode which doesn't support it. Implements VESA suspend
157 * and powerdown modes on hardware that supports disabling hsync/vsync:
158 * blank_mode == 2: suspend vsync
159 * blank_mode == 3: suspend hsync
160 * blank_mode == 4: powerdown
162 /* [danj] I think there's something fishy about those constants... */
164 struct fb_info_platinum *info = (struct fb_info_platinum *) fb;
167 ctrl = le32_to_cpup(&info->platinum_regs->ctrl.r) | 0x33;
170 if (blank & VESA_VSYNC_SUSPEND)
172 if (blank & VESA_HSYNC_SUSPEND)
174 out_le32(&info->platinum_regs->ctrl.r, ctrl);
176 /* TODO: Figure out how the heck to powerdown this thing! */
180 static int platinumfb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
181 u_int transp, struct fb_info *info)
183 struct fb_info_platinum *pinfo = info->par;
184 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
193 pinfo->palette[regno].red = red;
194 pinfo->palette[regno].green = green;
195 pinfo->palette[regno].blue = blue;
197 out_8(&cmap_regs->addr, regno); /* tell clut what addr to fill */
198 out_8(&cmap_regs->lut, red); /* send one color channel at */
199 out_8(&cmap_regs->lut, green); /* a time... */
200 out_8(&cmap_regs->lut, blue);
204 u32 *pal = info->pseudo_palette;
205 switch (pinfo->cmode) {
207 pal[regno] = (regno << 10) | (regno << 5) | regno;
210 i = (regno << 8) | regno;
211 pal[regno] = (i << 16) | i;
219 static inline int platinum_vram_reqd(int video_mode, int color_mode)
221 int baseval = vmode_attrs[video_mode-1].hres * (1<<color_mode);
223 if ((video_mode == VMODE_832_624_75) && (color_mode > CMODE_8))
228 return vmode_attrs[video_mode-1].vres * baseval + 0x1000;
231 #define STORE_D2(a, d) { \
232 out_8(&cmap_regs->addr, (a+32)); \
233 out_8(&cmap_regs->d2, (d)); \
236 static void set_platinum_clock(struct fb_info_platinum *pinfo)
238 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
239 struct platinum_regvals *init;
241 init = platinum_reg_init[pinfo->vmode-1];
244 out_8(&cmap_regs->addr,3+32);
246 if (in_8(&cmap_regs->d2) == 2) {
247 STORE_D2(7, init->clock_params[pinfo->clktype][0]);
248 STORE_D2(8, init->clock_params[pinfo->clktype][1]);
251 STORE_D2(4, init->clock_params[pinfo->clktype][0]);
252 STORE_D2(5, init->clock_params[pinfo->clktype][1]);
261 /* Now how about actually saying, Make it so! */
262 /* Some things in here probably don't need to be done each time. */
263 static void platinum_set_hardware(struct fb_info_platinum *pinfo)
265 volatile struct platinum_regs __iomem *platinum_regs = pinfo->platinum_regs;
266 volatile struct cmap_regs __iomem *cmap_regs = pinfo->cmap_regs;
267 struct platinum_regvals *init;
271 vmode = pinfo->vmode;
272 cmode = pinfo->cmode;
274 init = platinum_reg_init[vmode - 1];
276 /* Initialize display timing registers */
277 out_be32(&platinum_regs->reg[24].r, 7); /* turn display off */
279 for (i = 0; i < 26; ++i)
280 out_be32(&platinum_regs->reg[i+32].r, init->regs[i]);
282 out_be32(&platinum_regs->reg[26+32].r, (pinfo->total_vram == 0x100000 ?
283 init->offset[cmode] + 4 - cmode :
284 init->offset[cmode]));
285 out_be32(&platinum_regs->reg[16].r, (unsigned) pinfo->frame_buffer_phys+init->fb_offset+0x10);
286 out_be32(&platinum_regs->reg[18].r, init->pitch[cmode]);
287 out_be32(&platinum_regs->reg[19].r, (pinfo->total_vram == 0x100000 ?
288 init->mode[cmode+1] :
290 out_be32(&platinum_regs->reg[20].r, (pinfo->total_vram == 0x100000 ? 0x11 : 0x1011));
291 out_be32(&platinum_regs->reg[21].r, 0x100);
292 out_be32(&platinum_regs->reg[22].r, 1);
293 out_be32(&platinum_regs->reg[23].r, 1);
294 out_be32(&platinum_regs->reg[26].r, 0xc00);
295 out_be32(&platinum_regs->reg[27].r, 0x235);
296 /* out_be32(&platinum_regs->reg[27].r, 0x2aa); */
298 STORE_D2(0, (pinfo->total_vram == 0x100000 ?
299 init->dacula_ctrl[cmode] & 0xf :
300 init->dacula_ctrl[cmode]));
304 set_platinum_clock(pinfo);
306 out_be32(&platinum_regs->reg[24].r, 0); /* turn display on */
310 * Set misc info vars for this driver
312 static void platinum_init_info(struct fb_info *info,
313 struct fb_info_platinum *pinfo)
316 info->fbops = &platinumfb_ops;
317 info->pseudo_palette = pinfo->pseudo_palette;
318 info->screen_base = pinfo->frame_buffer + 0x20;
320 fb_alloc_cmap(&info->cmap, 256, 0);
322 /* Fill fix common fields */
323 strcpy(info->fix.id, "platinum");
324 info->fix.mmio_start = pinfo->platinum_regs_phys;
325 info->fix.mmio_len = 0x1000;
326 info->fix.type = FB_TYPE_PACKED_PIXELS;
327 info->fix.smem_start = pinfo->frame_buffer_phys + 0x20; /* will be updated later */
328 info->fix.smem_len = pinfo->total_vram - 0x20;
329 info->fix.ywrapstep = 0;
330 info->fix.xpanstep = 0;
331 info->fix.ypanstep = 0;
332 info->fix.type_aux = 0;
333 info->fix.accel = FB_ACCEL_NONE;
337 static int platinum_init_fb(struct fb_info *info)
339 struct fb_info_platinum *pinfo = info->par;
340 struct fb_var_screeninfo var;
343 sense = read_platinum_sense(pinfo);
344 printk(KERN_INFO "platinumfb: Monitor sense value = 0x%x, ", sense);
346 if (IS_REACHABLE(CONFIG_NVRAM) && default_vmode == VMODE_NVRAM)
347 default_vmode = nvram_read_byte(NV_VMODE);
348 if (default_vmode <= 0 || default_vmode > VMODE_MAX ||
349 !platinum_reg_init[default_vmode - 1]) {
350 default_vmode = mac_map_monitor_sense(sense);
351 if (!platinum_reg_init[default_vmode - 1])
352 default_vmode = VMODE_640_480_60;
355 if (IS_REACHABLE(CONFIG_NVRAM) && default_cmode == CMODE_NVRAM)
356 default_cmode = nvram_read_byte(NV_CMODE);
357 if (default_cmode < CMODE_8 || default_cmode > CMODE_32)
358 default_cmode = CMODE_8;
360 * Reduce the pixel size if we don't have enough VRAM.
362 while(default_cmode > CMODE_8 &&
363 platinum_vram_reqd(default_vmode, default_cmode) > pinfo->total_vram)
366 printk("platinumfb: Using video mode %d and color mode %d.\n", default_vmode, default_cmode);
368 /* Setup default var */
369 if (mac_vmode_to_var(default_vmode, default_cmode, &var) < 0) {
370 /* This shouldn't happen! */
371 printk("mac_vmode_to_var(%d, %d,) failed\n", default_vmode, default_cmode);
373 default_vmode = VMODE_640_480_60;
374 default_cmode = CMODE_8;
375 if (mac_vmode_to_var(default_vmode, default_cmode, &var) < 0) {
376 printk(KERN_ERR "platinumfb: mac_vmode_to_var() failed\n");
381 /* Initialize info structure */
382 platinum_init_info(info, pinfo);
384 /* Apply default var */
386 var.activate = FB_ACTIVATE_NOW;
387 rc = fb_set_var(info, &var);
388 if (rc && (default_vmode != VMODE_640_480_60 || default_cmode != CMODE_8))
391 /* Register with fbdev layer */
392 rc = register_framebuffer(info);
396 fb_info(info, "Apple Platinum frame buffer device\n");
402 * Get the monitor sense value.
403 * Note that this can be called before calibrate_delay,
404 * so we can't use udelay.
406 static int read_platinum_sense(struct fb_info_platinum *info)
408 volatile struct platinum_regs __iomem *platinum_regs = info->platinum_regs;
411 out_be32(&platinum_regs->reg[23].r, 7); /* turn off drivers */
413 sense = (~in_be32(&platinum_regs->reg[23].r) & 7) << 8;
415 /* drive each sense line low in turn and collect the other 2 */
416 out_be32(&platinum_regs->reg[23].r, 3); /* drive A low */
418 sense |= (~in_be32(&platinum_regs->reg[23].r) & 3) << 4;
419 out_be32(&platinum_regs->reg[23].r, 5); /* drive B low */
421 sense |= (~in_be32(&platinum_regs->reg[23].r) & 4) << 1;
422 sense |= (~in_be32(&platinum_regs->reg[23].r) & 1) << 2;
423 out_be32(&platinum_regs->reg[23].r, 6); /* drive C low */
425 sense |= (~in_be32(&platinum_regs->reg[23].r) & 6) >> 1;
427 out_be32(&platinum_regs->reg[23].r, 7); /* turn off drivers */
433 * This routine takes a user-supplied var, and picks the best vmode/cmode from it.
434 * It also updates the var structure to the actual mode data obtained
436 static int platinum_var_to_par(struct fb_var_screeninfo *var,
437 struct fb_info_platinum *pinfo,
442 if (mac_var_to_vmode(var, &vmode, &cmode) != 0) {
443 printk(KERN_ERR "platinum_var_to_par: mac_var_to_vmode unsuccessful.\n");
444 printk(KERN_ERR "platinum_var_to_par: var->xres = %d\n", var->xres);
445 printk(KERN_ERR "platinum_var_to_par: var->yres = %d\n", var->yres);
446 printk(KERN_ERR "platinum_var_to_par: var->xres_virtual = %d\n", var->xres_virtual);
447 printk(KERN_ERR "platinum_var_to_par: var->yres_virtual = %d\n", var->yres_virtual);
448 printk(KERN_ERR "platinum_var_to_par: var->bits_per_pixel = %d\n", var->bits_per_pixel);
449 printk(KERN_ERR "platinum_var_to_par: var->pixclock = %d\n", var->pixclock);
450 printk(KERN_ERR "platinum_var_to_par: var->vmode = %d\n", var->vmode);
454 if (!platinum_reg_init[vmode-1]) {
455 printk(KERN_ERR "platinum_var_to_par, vmode %d not valid.\n", vmode);
459 if (platinum_vram_reqd(vmode, cmode) > pinfo->total_vram) {
460 printk(KERN_ERR "platinum_var_to_par, not enough ram for vmode %d, cmode %d.\n", vmode, cmode);
464 if (mac_vmode_to_var(vmode, cmode, var))
470 pinfo->vmode = vmode;
471 pinfo->cmode = cmode;
472 pinfo->xres = vmode_attrs[vmode-1].hres;
473 pinfo->yres = vmode_attrs[vmode-1].vres;
476 pinfo->vxres = pinfo->xres;
477 pinfo->vyres = pinfo->yres;
484 * Parse user specified options (`video=platinumfb:')
486 static int __init platinumfb_setup(char *options)
490 if (!options || !*options)
493 while ((this_opt = strsep(&options, ",")) != NULL) {
494 if (!strncmp(this_opt, "vmode:", 6)) {
495 int vmode = simple_strtoul(this_opt+6, NULL, 0);
496 if (vmode > 0 && vmode <= VMODE_MAX)
497 default_vmode = vmode;
498 } else if (!strncmp(this_opt, "cmode:", 6)) {
499 int depth = simple_strtoul(this_opt+6, NULL, 0);
503 default_cmode = CMODE_8;
507 default_cmode = CMODE_16;
511 default_cmode = CMODE_32;
520 #define invalidate_cache(addr) \
521 asm volatile("eieio; dcbf 0,%1" \
522 : "=m" (*(addr)) : "r" (addr) : "memory");
524 #define invalidate_cache(addr)
527 static int platinumfb_probe(struct platform_device* odev)
529 struct device_node *dp = odev->dev.of_node;
530 struct fb_info *info;
531 struct fb_info_platinum *pinfo;
532 volatile __u8 *fbuffer;
533 int bank0, bank1, bank2, bank3, rc;
535 dev_info(&odev->dev, "Found Apple Platinum video hardware\n");
537 info = framebuffer_alloc(sizeof(*pinfo), &odev->dev);
543 if (of_address_to_resource(dp, 0, &pinfo->rsrc_reg) ||
544 of_address_to_resource(dp, 1, &pinfo->rsrc_fb)) {
545 dev_err(&odev->dev, "Can't get resources\n");
546 framebuffer_release(info);
549 dev_dbg(&odev->dev, " registers : 0x%llx...0x%llx\n",
550 (unsigned long long)pinfo->rsrc_reg.start,
551 (unsigned long long)pinfo->rsrc_reg.end);
552 dev_dbg(&odev->dev, " framebuffer: 0x%llx...0x%llx\n",
553 (unsigned long long)pinfo->rsrc_fb.start,
554 (unsigned long long)pinfo->rsrc_fb.end);
556 /* Do not try to request register space, they overlap with the
557 * northbridge and that can fail. Only request framebuffer
559 if (!request_mem_region(pinfo->rsrc_fb.start,
560 resource_size(&pinfo->rsrc_fb),
561 "platinumfb framebuffer")) {
562 printk(KERN_ERR "platinumfb: Can't request framebuffer !\n");
563 framebuffer_release(info);
567 /* frame buffer - map only 4MB */
568 pinfo->frame_buffer_phys = pinfo->rsrc_fb.start;
569 pinfo->frame_buffer = ioremap_wt(pinfo->rsrc_fb.start, 0x400000);
570 pinfo->base_frame_buffer = pinfo->frame_buffer;
573 pinfo->platinum_regs_phys = pinfo->rsrc_reg.start;
574 pinfo->platinum_regs = ioremap(pinfo->rsrc_reg.start, 0x1000);
576 pinfo->cmap_regs_phys = 0xf301b000; /* XXX not in prom? */
577 request_mem_region(pinfo->cmap_regs_phys, 0x1000, "platinumfb cmap");
578 pinfo->cmap_regs = ioremap(pinfo->cmap_regs_phys, 0x1000);
580 /* Grok total video ram */
581 out_be32(&pinfo->platinum_regs->reg[16].r, (unsigned)pinfo->frame_buffer_phys);
582 out_be32(&pinfo->platinum_regs->reg[20].r, 0x1011); /* select max vram */
583 out_be32(&pinfo->platinum_regs->reg[24].r, 0); /* switch in vram */
585 fbuffer = pinfo->base_frame_buffer;
586 fbuffer[0x100000] = 0x34;
587 fbuffer[0x100008] = 0x0;
588 invalidate_cache(&fbuffer[0x100000]);
589 fbuffer[0x200000] = 0x56;
590 fbuffer[0x200008] = 0x0;
591 invalidate_cache(&fbuffer[0x200000]);
592 fbuffer[0x300000] = 0x78;
593 fbuffer[0x300008] = 0x0;
594 invalidate_cache(&fbuffer[0x300000]);
595 bank0 = 1; /* builtin 1MB vram, always there */
596 bank1 = fbuffer[0x100000] == 0x34;
597 bank2 = fbuffer[0x200000] == 0x56;
598 bank3 = fbuffer[0x300000] == 0x78;
599 pinfo->total_vram = (bank0 + bank1 + bank2 + bank3) * 0x100000;
600 printk(KERN_INFO "platinumfb: Total VRAM = %dMB (%d%d%d%d)\n",
601 (unsigned int) (pinfo->total_vram / 1024 / 1024),
602 bank3, bank2, bank1, bank0);
605 * Try to determine whether we have an old or a new DACula.
607 out_8(&pinfo->cmap_regs->addr, 0x40);
608 pinfo->dactype = in_8(&pinfo->cmap_regs->d2);
609 switch (pinfo->dactype) {
612 printk(KERN_INFO "platinumfb: DACula type 0x3c\n");
616 printk(KERN_INFO "platinumfb: DACula type 0x84\n");
620 printk(KERN_INFO "platinumfb: Unknown DACula type: %x\n", pinfo->dactype);
623 dev_set_drvdata(&odev->dev, info);
625 rc = platinum_init_fb(info);
627 iounmap(pinfo->frame_buffer);
628 iounmap(pinfo->platinum_regs);
629 iounmap(pinfo->cmap_regs);
630 framebuffer_release(info);
636 static void platinumfb_remove(struct platform_device* odev)
638 struct fb_info *info = dev_get_drvdata(&odev->dev);
639 struct fb_info_platinum *pinfo = info->par;
641 unregister_framebuffer (info);
643 /* Unmap frame buffer and registers */
644 iounmap(pinfo->frame_buffer);
645 iounmap(pinfo->platinum_regs);
646 iounmap(pinfo->cmap_regs);
648 release_mem_region(pinfo->rsrc_fb.start,
649 resource_size(&pinfo->rsrc_fb));
651 release_mem_region(pinfo->cmap_regs_phys, 0x1000);
653 framebuffer_release(info);
656 static struct of_device_id platinumfb_match[] =
664 static struct platform_driver platinum_driver =
667 .name = "platinumfb",
668 .of_match_table = platinumfb_match,
670 .probe = platinumfb_probe,
671 .remove_new = platinumfb_remove,
674 static int __init platinumfb_init(void)
679 if (fb_get_options("platinumfb", &option))
681 platinumfb_setup(option);
683 platform_driver_register(&platinum_driver);
688 static void __exit platinumfb_exit(void)
690 platform_driver_unregister(&platinum_driver);
693 MODULE_LICENSE("GPL");
694 MODULE_DESCRIPTION("framebuffer driver for Apple Platinum video");
695 module_init(platinumfb_init);
698 module_exit(platinumfb_exit);