xref: /openbmc/linux/drivers/video/fbdev/valkyriefb.c (revision d3741027)
1 /*
2  *  valkyriefb.c -- frame buffer device for the PowerMac 'valkyrie' display
3  *
4  *  Created 8 August 1998 by
5  *  Martin Costabel <costabel@wanadoo.fr> and Kevin Schoedel
6  *
7  *  Vmode-switching changes and vmode 15/17 modifications created 29 August
8  *  1998 by Barry K. Nathan <barryn@pobox.com>.
9  *
10  *  Ported to m68k Macintosh by David Huggins-Daines <dhd@debian.org>
11  *
12  *  Derived directly from:
13  *
14  *   controlfb.c -- frame buffer device for the PowerMac 'control' display
15  *   Copyright (C) 1998 Dan Jacobowitz <dan@debian.org>
16  *
17  *   pmc-valkyrie.c -- Console support for PowerMac "valkyrie" display adaptor.
18  *   Copyright (C) 1997 Paul Mackerras.
19  *
20  *  and indirectly:
21  *
22  *  Frame buffer structure from:
23  *    drivers/video/chipsfb.c -- frame buffer device for
24  *    Chips & Technologies 65550 chip.
25  *
26  *    Copyright (C) 1998 Paul Mackerras
27  *
28  *    This file is derived from the Powermac "chips" driver:
29  *    Copyright (C) 1997 Fabio Riccardi.
30  *    And from the frame buffer device for Open Firmware-initialized devices:
31  *    Copyright (C) 1997 Geert Uytterhoeven.
32  *
33  *  Hardware information from:
34  *    control.c: Console support for PowerMac "control" display adaptor.
35  *    Copyright (C) 1996 Paul Mackerras
36  *
37  *  This file is subject to the terms and conditions of the GNU General Public
38  *  License. See the file COPYING in the main directory of this archive for
39  *  more details.
40  */
41 
42 #include <linux/module.h>
43 #include <linux/kernel.h>
44 #include <linux/errno.h>
45 #include <linux/string.h>
46 #include <linux/mm.h>
47 #include <linux/slab.h>
48 #include <linux/vmalloc.h>
49 #include <linux/delay.h>
50 #include <linux/interrupt.h>
51 #include <linux/fb.h>
52 #include <linux/selection.h>
53 #include <linux/init.h>
54 #include <linux/nvram.h>
55 #include <linux/adb.h>
56 #include <linux/cuda.h>
57 #include <linux/of_address.h>
58 #ifdef CONFIG_MAC
59 #include <asm/macintosh.h>
60 #endif
61 
62 #include "macmodes.h"
63 #include "valkyriefb.h"
64 
65 static int default_vmode = VMODE_NVRAM;
66 static int default_cmode = CMODE_NVRAM;
67 
68 struct fb_par_valkyrie {
69 	int	vmode, cmode;
70 	int	xres, yres;
71 	int	vxres, vyres;
72 	struct valkyrie_regvals *init;
73 };
74 
75 struct fb_info_valkyrie {
76 	struct fb_info		info;
77 	struct fb_par_valkyrie	par;
78 	struct cmap_regs	__iomem *cmap_regs;
79 	unsigned long		cmap_regs_phys;
80 
81 	struct valkyrie_regs	__iomem *valkyrie_regs;
82 	unsigned long		valkyrie_regs_phys;
83 
84 	__u8			__iomem *frame_buffer;
85 	unsigned long		frame_buffer_phys;
86 
87 	int			sense;
88 	unsigned long		total_vram;
89 
90 	u32			pseudo_palette[16];
91 };
92 
93 /*
94  * Exported functions
95  */
96 int valkyriefb_init(void);
97 int valkyriefb_setup(char*);
98 
99 static int valkyriefb_check_var(struct fb_var_screeninfo *var,
100 				struct fb_info *info);
101 static int valkyriefb_set_par(struct fb_info *info);
102 static int valkyriefb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
103 			     u_int transp, struct fb_info *info);
104 static int valkyriefb_blank(int blank_mode, struct fb_info *info);
105 
106 static int read_valkyrie_sense(struct fb_info_valkyrie *p);
107 static void set_valkyrie_clock(unsigned char *params);
108 static int valkyrie_var_to_par(struct fb_var_screeninfo *var,
109 	struct fb_par_valkyrie *par, const struct fb_info *fb_info);
110 
111 static int valkyrie_init_info(struct fb_info *info, struct fb_info_valkyrie *p);
112 static void valkyrie_par_to_fix(struct fb_par_valkyrie *par, struct fb_fix_screeninfo *fix);
113 static void valkyrie_init_fix(struct fb_fix_screeninfo *fix, struct fb_info_valkyrie *p);
114 
115 static const struct fb_ops valkyriefb_ops = {
116 	.owner =	THIS_MODULE,
117 	.fb_check_var =	valkyriefb_check_var,
118 	.fb_set_par =	valkyriefb_set_par,
119 	.fb_setcolreg =	valkyriefb_setcolreg,
120 	.fb_blank =	valkyriefb_blank,
121 	.fb_fillrect	= cfb_fillrect,
122 	.fb_copyarea	= cfb_copyarea,
123 	.fb_imageblit	= cfb_imageblit,
124 };
125 
126 /* Sets the video mode according to info->var */
127 static int valkyriefb_set_par(struct fb_info *info)
128 {
129 	struct fb_info_valkyrie *p =
130 		container_of(info, struct fb_info_valkyrie, info);
131 	volatile struct valkyrie_regs __iomem *valkyrie_regs = p->valkyrie_regs;
132 	struct fb_par_valkyrie *par = info->par;
133 	struct valkyrie_regvals	*init;
134 	int err;
135 
136 	if ((err = valkyrie_var_to_par(&info->var, par, info)))
137 		return err;
138 
139 	valkyrie_par_to_fix(par, &info->fix);
140 
141 	/* Reset the valkyrie */
142 	out_8(&valkyrie_regs->status.r, 0);
143 	udelay(100);
144 
145 	/* Initialize display timing registers */
146 	init = par->init;
147 	out_8(&valkyrie_regs->mode.r, init->mode | 0x80);
148 	out_8(&valkyrie_regs->depth.r, par->cmode + 3);
149 	set_valkyrie_clock(init->clock_params);
150 	udelay(100);
151 
152 	/* Turn on display */
153 	out_8(&valkyrie_regs->mode.r, init->mode);
154 
155 	return 0;
156 }
157 
158 static inline int valkyrie_par_to_var(struct fb_par_valkyrie *par,
159 				      struct fb_var_screeninfo *var)
160 {
161 	return mac_vmode_to_var(par->vmode, par->cmode, var);
162 }
163 
164 static int
165 valkyriefb_check_var(struct fb_var_screeninfo *var, struct fb_info *info)
166 {
167 	int err;
168 	struct fb_par_valkyrie par;
169 
170 	if ((err = valkyrie_var_to_par(var, &par, info)))
171 		return err;
172 	valkyrie_par_to_var(&par, var);
173 	return 0;
174 }
175 
176 /*
177  *  Blank the screen if blank_mode != 0, else unblank. If blank_mode == NULL
178  *  then the caller blanks by setting the CLUT (Color Look Up Table) to all
179  *  black. Return 0 if blanking succeeded, != 0 if un-/blanking failed due
180  *  to e.g. a video mode which doesn't support it. Implements VESA suspend
181  *  and powerdown modes on hardware that supports disabling hsync/vsync:
182  *    blank_mode == 2: suspend vsync
183  *    blank_mode == 3: suspend hsync
184  *    blank_mode == 4: powerdown
185  */
186 static int valkyriefb_blank(int blank_mode, struct fb_info *info)
187 {
188 	struct fb_info_valkyrie *p =
189 		container_of(info, struct fb_info_valkyrie, info);
190 	struct fb_par_valkyrie *par = info->par;
191 	struct valkyrie_regvals	*init = par->init;
192 
193 	if (init == NULL)
194 		return 1;
195 
196 	switch (blank_mode) {
197 	case FB_BLANK_UNBLANK:			/* unblank */
198 		out_8(&p->valkyrie_regs->mode.r, init->mode);
199 		break;
200 	case FB_BLANK_NORMAL:
201 		return 1;	/* get caller to set CLUT to all black */
202 	case FB_BLANK_VSYNC_SUSPEND:
203 	case FB_BLANK_HSYNC_SUSPEND:
204 		/*
205 		 * [kps] Value extracted from MacOS. I don't know
206 		 * whether this bit disables hsync or vsync, or
207 		 * whether the hardware can do the other as well.
208 		 */
209 		out_8(&p->valkyrie_regs->mode.r, init->mode | 0x40);
210 		break;
211 	case FB_BLANK_POWERDOWN:
212 		out_8(&p->valkyrie_regs->mode.r, 0x66);
213 		break;
214 	}
215 	return 0;
216 }
217 
218 static int valkyriefb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
219 			     u_int transp, struct fb_info *info)
220 {
221 	struct fb_info_valkyrie *p =
222 		container_of(info, struct fb_info_valkyrie, info);
223 	volatile struct cmap_regs __iomem *cmap_regs = p->cmap_regs;
224 	struct fb_par_valkyrie *par = info->par;
225 
226 	if (regno > 255)
227 		return 1;
228 	red >>= 8;
229 	green >>= 8;
230 	blue >>= 8;
231 
232 	/* tell clut which address to fill */
233 	out_8(&p->cmap_regs->addr, regno);
234 	udelay(1);
235 	/* send one color channel at a time */
236 	out_8(&cmap_regs->lut, red);
237 	out_8(&cmap_regs->lut, green);
238 	out_8(&cmap_regs->lut, blue);
239 
240 	if (regno < 16 && par->cmode == CMODE_16)
241 		((u32 *)info->pseudo_palette)[regno] =
242 			(regno << 10) | (regno << 5) | regno;
243 
244 	return 0;
245 }
246 
247 static inline int valkyrie_vram_reqd(int video_mode, int color_mode)
248 {
249 	int pitch;
250 	struct valkyrie_regvals *init = valkyrie_reg_init[video_mode-1];
251 
252 	if ((pitch = init->pitch[color_mode]) == 0)
253 		pitch = 2 * init->pitch[0];
254 	return init->vres * pitch;
255 }
256 
257 static void set_valkyrie_clock(unsigned char *params)
258 {
259 #ifdef CONFIG_ADB_CUDA
260 	struct adb_request req;
261 	int i;
262 
263 	for (i = 0; i < 3; ++i) {
264 		cuda_request(&req, NULL, 5, CUDA_PACKET, CUDA_GET_SET_IIC,
265 			     0x50, i + 1, params[i]);
266 		while (!req.complete)
267 			cuda_poll();
268 	}
269 #endif
270 }
271 
272 static void __init valkyrie_choose_mode(struct fb_info_valkyrie *p)
273 {
274 	p->sense = read_valkyrie_sense(p);
275 	printk(KERN_INFO "Monitor sense value = 0x%x\n", p->sense);
276 
277 	/* Try to pick a video mode out of NVRAM if we have one. */
278 #ifdef CONFIG_PPC_PMAC
279 	if (IS_REACHABLE(CONFIG_NVRAM) && default_vmode == VMODE_NVRAM)
280 		default_vmode = nvram_read_byte(NV_VMODE);
281 #endif
282 	if (default_vmode <= 0 || default_vmode > VMODE_MAX ||
283 	    !valkyrie_reg_init[default_vmode - 1]) {
284 		default_vmode = mac_map_monitor_sense(p->sense);
285 		if (!valkyrie_reg_init[default_vmode - 1])
286 			default_vmode = VMODE_640_480_67;
287 	}
288 
289 #ifdef CONFIG_PPC_PMAC
290 	if (IS_REACHABLE(CONFIG_NVRAM) && default_cmode == CMODE_NVRAM)
291 		default_cmode = nvram_read_byte(NV_CMODE);
292 #endif
293 	/*
294 	 * Reduce the pixel size if we don't have enough VRAM or bandwidth.
295 	 */
296 	if (default_cmode < CMODE_8 || default_cmode > CMODE_16
297 	    || valkyrie_reg_init[default_vmode-1]->pitch[default_cmode] == 0
298 	    || valkyrie_vram_reqd(default_vmode, default_cmode) > p->total_vram)
299 		default_cmode = CMODE_8;
300 
301 	printk(KERN_INFO "using video mode %d and color mode %d.\n",
302 	       default_vmode, default_cmode);
303 }
304 
305 int __init valkyriefb_init(void)
306 {
307 	struct fb_info_valkyrie	*p;
308 	unsigned long frame_buffer_phys, cmap_regs_phys;
309 	int err;
310 	char *option = NULL;
311 
312 	if (fb_get_options("valkyriefb", &option))
313 		return -ENODEV;
314 	valkyriefb_setup(option);
315 
316 #ifdef CONFIG_MAC
317 	if (!MACH_IS_MAC)
318 		return -ENODEV;
319 	if (!(mac_bi_data.id == MAC_MODEL_Q630
320 	      /* I'm not sure about this one */
321 	    || mac_bi_data.id == MAC_MODEL_P588))
322 		return -ENODEV;
323 
324 	/* Hardcoded addresses... welcome to 68k Macintosh country :-) */
325 	frame_buffer_phys = 0xf9000000;
326 	cmap_regs_phys = 0x50f24000;
327 #else /* ppc (!CONFIG_MAC) */
328 	{
329 		struct device_node *dp;
330 		struct resource r;
331 
332 		dp = of_find_node_by_name(NULL, "valkyrie");
333 		if (!dp)
334 			return 0;
335 
336 		if (of_address_to_resource(dp, 0, &r)) {
337 			printk(KERN_ERR "can't find address for valkyrie\n");
338 			return 0;
339 		}
340 
341 		frame_buffer_phys = r.start;
342 		cmap_regs_phys = r.start + 0x304000;
343 	}
344 #endif /* ppc (!CONFIG_MAC) */
345 
346 	p = kzalloc(sizeof(*p), GFP_ATOMIC);
347 	if (!p)
348 		return -ENOMEM;
349 
350 	/* Map in frame buffer and registers */
351 	if (!request_mem_region(frame_buffer_phys, 0x100000, "valkyriefb")) {
352 		kfree(p);
353 		return 0;
354 	}
355 	p->total_vram = 0x100000;
356 	p->frame_buffer_phys = frame_buffer_phys;
357 #ifdef CONFIG_MAC
358 	p->frame_buffer = ioremap(frame_buffer_phys, p->total_vram);
359 #else
360 	p->frame_buffer = ioremap_wt(frame_buffer_phys, p->total_vram);
361 #endif
362 	p->cmap_regs_phys = cmap_regs_phys;
363 	p->cmap_regs = ioremap(p->cmap_regs_phys, 0x1000);
364 	p->valkyrie_regs_phys = cmap_regs_phys+0x6000;
365 	p->valkyrie_regs = ioremap(p->valkyrie_regs_phys, 0x1000);
366 	err = -ENOMEM;
367 	if (p->frame_buffer == NULL || p->cmap_regs == NULL
368 	    || p->valkyrie_regs == NULL) {
369 		printk(KERN_ERR "valkyriefb: couldn't map resources\n");
370 		goto out_free;
371 	}
372 
373 	valkyrie_choose_mode(p);
374 	mac_vmode_to_var(default_vmode, default_cmode, &p->info.var);
375 	err = valkyrie_init_info(&p->info, p);
376 	if (err < 0)
377 		goto out_free;
378 	valkyrie_init_fix(&p->info.fix, p);
379 	if (valkyriefb_set_par(&p->info))
380 		/* "can't happen" */
381 		printk(KERN_ERR "valkyriefb: can't set default video mode\n");
382 
383 	if ((err = register_framebuffer(&p->info)) != 0)
384 		goto out_cmap_free;
385 
386 	fb_info(&p->info, "valkyrie frame buffer device\n");
387 	return 0;
388 
389  out_cmap_free:
390 	fb_dealloc_cmap(&p->info.cmap);
391  out_free:
392 	if (p->frame_buffer)
393 		iounmap(p->frame_buffer);
394 	if (p->cmap_regs)
395 		iounmap(p->cmap_regs);
396 	if (p->valkyrie_regs)
397 		iounmap(p->valkyrie_regs);
398 	kfree(p);
399 	return err;
400 }
401 
402 /*
403  * Get the monitor sense value.
404  */
405 static int read_valkyrie_sense(struct fb_info_valkyrie *p)
406 {
407 	int sense, in;
408 
409 	out_8(&p->valkyrie_regs->msense.r, 0);   /* release all lines */
410 	__delay(20000);
411 	sense = ((in = in_8(&p->valkyrie_regs->msense.r)) & 0x70) << 4;
412 	/* drive each sense line low in turn and collect the other 2 */
413 	out_8(&p->valkyrie_regs->msense.r, 4);   /* drive A low */
414 	__delay(20000);
415 	sense |= ((in = in_8(&p->valkyrie_regs->msense.r)) & 0x30);
416 	out_8(&p->valkyrie_regs->msense.r, 2);   /* drive B low */
417 	__delay(20000);
418 	sense |= ((in = in_8(&p->valkyrie_regs->msense.r)) & 0x40) >> 3;
419 	sense |= (in & 0x10) >> 2;
420 	out_8(&p->valkyrie_regs->msense.r, 1);   /* drive C low */
421 	__delay(20000);
422 	sense |= ((in = in_8(&p->valkyrie_regs->msense.r)) & 0x60) >> 5;
423 
424 	out_8(&p->valkyrie_regs->msense.r, 7);
425 
426 	return sense;
427 }
428 
429 /*
430  * This routine takes a user-supplied var,
431  * and picks the best vmode/cmode from it.
432  */
433 
434 /* [bkn] I did a major overhaul of this function.
435  *
436  * Much of the old code was "swiped by jonh from atyfb.c". Because
437  * macmodes has mac_var_to_vmode, I felt that it would be better to
438  * rework this function to use that, instead of reinventing the wheel to
439  * add support for vmode 17. This was reinforced by the fact that
440  * the previously swiped atyfb.c code is no longer there.
441  *
442  * So, I swiped and adapted platinum_var_to_par (from platinumfb.c), replacing
443  * most, but not all, of the old code in the process. One side benefit of
444  * swiping the platinumfb code is that we now have more comprehensible error
445  * messages when a vmode/cmode switch fails. (Most of the error messages are
446  * platinumfb.c, but I added two of my own, and I also changed some commas
447  * into colons to make the messages more consistent with other Linux error
448  * messages.) In addition, I think the new code *might* fix some vmode-
449  * switching oddities, but I'm not sure.
450  *
451  * There may be some more opportunities for cleanup in here, but this is a
452  * good start...
453  */
454 
455 static int valkyrie_var_to_par(struct fb_var_screeninfo *var,
456 	struct fb_par_valkyrie *par, const struct fb_info *fb_info)
457 {
458 	int vmode, cmode;
459 	struct valkyrie_regvals *init;
460 	struct fb_info_valkyrie *p =
461 		container_of(fb_info, struct fb_info_valkyrie, info);
462 
463 	if (mac_var_to_vmode(var, &vmode, &cmode) != 0) {
464 		printk(KERN_ERR "valkyriefb: can't do %dx%dx%d.\n",
465 		       var->xres, var->yres, var->bits_per_pixel);
466 		return -EINVAL;
467 	}
468 
469 	/* Check if we know about the wanted video mode */
470 	if (vmode < 1 || vmode > VMODE_MAX || !valkyrie_reg_init[vmode-1]) {
471 		printk(KERN_ERR "valkyriefb: vmode %d not valid.\n", vmode);
472 		return -EINVAL;
473 	}
474 
475 	if (cmode != CMODE_8 && cmode != CMODE_16) {
476 		printk(KERN_ERR "valkyriefb: cmode %d not valid.\n", cmode);
477 		return -EINVAL;
478 	}
479 
480 	if (var->xres_virtual > var->xres || var->yres_virtual > var->yres
481 	    || var->xoffset != 0 || var->yoffset != 0) {
482 		return -EINVAL;
483 	}
484 
485 	init = valkyrie_reg_init[vmode-1];
486 	if (init->pitch[cmode] == 0) {
487 		printk(KERN_ERR "valkyriefb: vmode %d does not support "
488 		       "cmode %d.\n", vmode, cmode);
489 		return -EINVAL;
490 	}
491 
492 	if (valkyrie_vram_reqd(vmode, cmode) > p->total_vram) {
493 		printk(KERN_ERR "valkyriefb: not enough ram for vmode %d, "
494 		       "cmode %d.\n", vmode, cmode);
495 		return -EINVAL;
496 	}
497 
498 	par->vmode = vmode;
499 	par->cmode = cmode;
500 	par->init = init;
501 	par->xres = var->xres;
502 	par->yres = var->yres;
503 	par->vxres = par->xres;
504 	par->vyres = par->yres;
505 
506 	return 0;
507 }
508 
509 static void valkyrie_init_fix(struct fb_fix_screeninfo *fix, struct fb_info_valkyrie *p)
510 {
511 	memset(fix, 0, sizeof(*fix));
512 	strcpy(fix->id, "valkyrie");
513 	fix->mmio_start = p->valkyrie_regs_phys;
514 	fix->mmio_len = sizeof(struct valkyrie_regs);
515 	fix->type = FB_TYPE_PACKED_PIXELS;
516 	fix->smem_start = p->frame_buffer_phys + 0x1000;
517 	fix->smem_len = p->total_vram;
518 
519 	fix->type_aux = 0;
520 	fix->ywrapstep = 0;
521 	fix->ypanstep = 0;
522 	fix->xpanstep = 0;
523 
524 }
525 
526 /* Fix must already be inited above */
527 static void valkyrie_par_to_fix(struct fb_par_valkyrie *par,
528 	struct fb_fix_screeninfo *fix)
529 {
530 	fix->smem_len = valkyrie_vram_reqd(par->vmode, par->cmode);
531 	fix->visual = (par->cmode == CMODE_8) ?
532 		FB_VISUAL_PSEUDOCOLOR : FB_VISUAL_DIRECTCOLOR;
533 	fix->line_length = par->vxres << par->cmode;
534 		/* ywrapstep, xpanstep, ypanstep */
535 }
536 
537 static int __init valkyrie_init_info(struct fb_info *info,
538 		struct fb_info_valkyrie *p)
539 {
540 	info->fbops = &valkyriefb_ops;
541 	info->screen_base = p->frame_buffer + 0x1000;
542 	info->flags = FBINFO_DEFAULT;
543 	info->pseudo_palette = p->pseudo_palette;
544 	info->par = &p->par;
545 	return fb_alloc_cmap(&info->cmap, 256, 0);
546 }
547 
548 
549 /*
550  * Parse user specified options (`video=valkyriefb:')
551  */
552 int __init valkyriefb_setup(char *options)
553 {
554 	char *this_opt;
555 
556 	if (!options || !*options)
557 		return 0;
558 
559 	while ((this_opt = strsep(&options, ",")) != NULL) {
560 		if (!strncmp(this_opt, "vmode:", 6)) {
561 	    		int vmode = simple_strtoul(this_opt+6, NULL, 0);
562 			if (vmode > 0 && vmode <= VMODE_MAX)
563 				default_vmode = vmode;
564 		}
565 		else if (!strncmp(this_opt, "cmode:", 6)) {
566 			int depth = simple_strtoul(this_opt+6, NULL, 0);
567 			switch (depth) {
568 			case 8:
569 				default_cmode = CMODE_8;
570 				break;
571 			case 15:
572 			case 16:
573 				default_cmode = CMODE_16;
574 				break;
575 			}
576 		}
577 	}
578 	return 0;
579 }
580 
581 module_init(valkyriefb_init);
582 MODULE_LICENSE("GPL");
583