xref: /openbmc/linux/drivers/video/fbdev/pvr2fb.c (revision e3d786a3)
1 /*
2  * drivers/video/pvr2fb.c
3  *
4  * Frame buffer and fbcon support for the NEC PowerVR2 found within the Sega
5  * Dreamcast.
6  *
7  * Copyright (c) 2001 M. R. Brown <mrbrown@0xd6.org>
8  * Copyright (c) 2001 - 2008  Paul Mundt <lethal@linux-sh.org>
9  *
10  * This driver is mostly based on the excellent amifb and vfb sources.  It uses
11  * an odd scheme for converting hardware values to/from framebuffer values,
12  * here are some hacked-up formulas:
13  *
14  *  The Dreamcast has screen offsets from each side of its four borders and
15  *  the start offsets of the display window.  I used these values to calculate
16  *  'pseudo' values (think of them as placeholders) for the fb video mode, so
17  *  that when it came time to convert these values back into their hardware
18  *  values, I could just add mode- specific offsets to get the correct mode
19  *  settings:
20  *
21  *      left_margin = diwstart_h - borderstart_h;
22  *      right_margin = borderstop_h - (diwstart_h + xres);
23  *      upper_margin = diwstart_v - borderstart_v;
24  *      lower_margin = borderstop_v - (diwstart_h + yres);
25  *
26  *      hsync_len = borderstart_h + (hsync_total - borderstop_h);
27  *      vsync_len = borderstart_v + (vsync_total - borderstop_v);
28  *
29  *  Then, when it's time to convert back to hardware settings, the only
30  *  constants are the borderstart_* offsets, all other values are derived from
31  *  the fb video mode:
32  *
33  *      // PAL
34  *      borderstart_h = 116;
35  *      borderstart_v = 44;
36  *      ...
37  *      borderstop_h = borderstart_h + hsync_total - hsync_len;
38  *      ...
39  *      diwstart_v = borderstart_v - upper_margin;
40  *
41  *  However, in the current implementation, the borderstart values haven't had
42  *  the benefit of being fully researched, so some modes may be broken.
43  */
44 
45 #undef DEBUG
46 
47 #include <linux/module.h>
48 #include <linux/kernel.h>
49 #include <linux/errno.h>
50 #include <linux/string.h>
51 #include <linux/mm.h>
52 #include <linux/slab.h>
53 #include <linux/delay.h>
54 #include <linux/interrupt.h>
55 #include <linux/fb.h>
56 #include <linux/init.h>
57 #include <linux/pci.h>
58 
59 #ifdef CONFIG_SH_DREAMCAST
60 #include <asm/machvec.h>
61 #include <mach-dreamcast/mach/sysasic.h>
62 #endif
63 
64 #ifdef CONFIG_PVR2_DMA
65 #include <linux/pagemap.h>
66 #include <mach/dma.h>
67 #include <asm/dma.h>
68 #endif
69 
70 #ifdef CONFIG_SH_STORE_QUEUES
71 #include <linux/uaccess.h>
72 #include <cpu/sq.h>
73 #endif
74 
75 #ifndef PCI_DEVICE_ID_NEC_NEON250
76 #  define PCI_DEVICE_ID_NEC_NEON250	0x0067
77 #endif
78 
79 /* 2D video registers */
80 #define DISP_BASE	par->mmio_base
81 #define DISP_BRDRCOLR (DISP_BASE + 0x40)
82 #define DISP_DIWMODE (DISP_BASE + 0x44)
83 #define DISP_DIWADDRL (DISP_BASE + 0x50)
84 #define DISP_DIWADDRS (DISP_BASE + 0x54)
85 #define DISP_DIWSIZE (DISP_BASE + 0x5c)
86 #define DISP_SYNCCONF (DISP_BASE + 0xd0)
87 #define DISP_BRDRHORZ (DISP_BASE + 0xd4)
88 #define DISP_SYNCSIZE (DISP_BASE + 0xd8)
89 #define DISP_BRDRVERT (DISP_BASE + 0xdc)
90 #define DISP_DIWCONF (DISP_BASE + 0xe8)
91 #define DISP_DIWHSTRT (DISP_BASE + 0xec)
92 #define DISP_DIWVSTRT (DISP_BASE + 0xf0)
93 #define DISP_PIXDEPTH (DISP_BASE + 0x108)
94 
95 /* Pixel clocks, one for TV output, doubled for VGA output */
96 #define TV_CLK 74239
97 #define VGA_CLK 37119
98 
99 /* This is for 60Hz - the VTOTAL is doubled for interlaced modes */
100 #define PAL_HTOTAL 863
101 #define PAL_VTOTAL 312
102 #define NTSC_HTOTAL 857
103 #define NTSC_VTOTAL 262
104 
105 /* Supported cable types */
106 enum { CT_VGA, CT_NONE, CT_RGB, CT_COMPOSITE };
107 
108 /* Supported video output types */
109 enum { VO_PAL, VO_NTSC, VO_VGA };
110 
111 /* Supported palette types */
112 enum { PAL_ARGB1555, PAL_RGB565, PAL_ARGB4444, PAL_ARGB8888 };
113 
114 struct pvr2_params { unsigned int val; char *name; };
115 static struct pvr2_params cables[] = {
116 	{ CT_VGA, "VGA" }, { CT_RGB, "RGB" }, { CT_COMPOSITE, "COMPOSITE" },
117 };
118 
119 static struct pvr2_params outputs[] = {
120 	{ VO_PAL, "PAL" }, { VO_NTSC, "NTSC" }, { VO_VGA, "VGA" },
121 };
122 
123 /*
124  * This describes the current video mode
125  */
126 
127 static struct pvr2fb_par {
128 	unsigned int hsync_total;	/* Clocks/line */
129 	unsigned int vsync_total;	/* Lines/field */
130 	unsigned int borderstart_h;
131 	unsigned int borderstop_h;
132 	unsigned int borderstart_v;
133 	unsigned int borderstop_v;
134 	unsigned int diwstart_h;	/* Horizontal offset of the display field */
135 	unsigned int diwstart_v;	/* Vertical offset of the display field, for
136 				   interlaced modes, this is the long field */
137 	unsigned long disp_start;	/* Address of image within VRAM */
138 	unsigned char is_interlaced;	/* Is the display interlaced? */
139 	unsigned char is_doublescan;	/* Are scanlines output twice? (doublescan) */
140 	unsigned char is_lowres;	/* Is horizontal pixel-doubling enabled? */
141 
142 	unsigned long mmio_base;	/* MMIO base */
143 	u32 palette[16];
144 } *currentpar;
145 
146 static struct fb_info *fb_info;
147 
148 static struct fb_fix_screeninfo pvr2_fix = {
149 	.id =		"NEC PowerVR2",
150 	.type =		FB_TYPE_PACKED_PIXELS,
151 	.visual =	FB_VISUAL_TRUECOLOR,
152 	.ypanstep =	1,
153 	.ywrapstep =	1,
154 	.accel =	FB_ACCEL_NONE,
155 };
156 
157 static const struct fb_var_screeninfo pvr2_var = {
158 	.xres =		640,
159 	.yres =		480,
160 	.xres_virtual =	640,
161 	.yres_virtual = 480,
162 	.bits_per_pixel	=16,
163 	.red =		{ 11, 5, 0 },
164 	.green =	{  5, 6, 0 },
165 	.blue =		{  0, 5, 0 },
166 	.activate =	FB_ACTIVATE_NOW,
167 	.height =	-1,
168 	.width =	-1,
169 	.vmode =	FB_VMODE_NONINTERLACED,
170 };
171 
172 static int cable_type = CT_VGA;
173 static int video_output = VO_VGA;
174 
175 static int nopan = 0;
176 static int nowrap = 1;
177 
178 /*
179  * We do all updating, blanking, etc. during the vertical retrace period
180  */
181 static unsigned int do_vmode_full = 0;	/* Change the video mode */
182 static unsigned int do_vmode_pan = 0;	/* Update the video mode */
183 static short do_blank = 0;		/* (Un)Blank the screen */
184 
185 static unsigned int is_blanked = 0;		/* Is the screen blanked? */
186 
187 #ifdef CONFIG_SH_STORE_QUEUES
188 static unsigned long pvr2fb_map;
189 #endif
190 
191 #ifdef CONFIG_PVR2_DMA
192 static unsigned int shdma = PVR2_CASCADE_CHAN;
193 static unsigned int pvr2dma = ONCHIP_NR_DMA_CHANNELS;
194 #endif
195 
196 static int pvr2fb_setcolreg(unsigned int regno, unsigned int red, unsigned int green, unsigned int blue,
197                             unsigned int transp, struct fb_info *info);
198 static int pvr2fb_blank(int blank, struct fb_info *info);
199 static unsigned long get_line_length(int xres_virtual, int bpp);
200 static void set_color_bitfields(struct fb_var_screeninfo *var);
201 static int pvr2fb_check_var(struct fb_var_screeninfo *var, struct fb_info *info);
202 static int pvr2fb_set_par(struct fb_info *info);
203 static void pvr2_update_display(struct fb_info *info);
204 static void pvr2_init_display(struct fb_info *info);
205 static void pvr2_do_blank(void);
206 static irqreturn_t pvr2fb_interrupt(int irq, void *dev_id);
207 static int pvr2_init_cable(void);
208 static int pvr2_get_param(const struct pvr2_params *p, const char *s,
209                             int val, int size);
210 #ifdef CONFIG_PVR2_DMA
211 static ssize_t pvr2fb_write(struct fb_info *info, const char *buf,
212 			    size_t count, loff_t *ppos);
213 #endif
214 
215 static struct fb_ops pvr2fb_ops = {
216 	.owner		= THIS_MODULE,
217 	.fb_setcolreg	= pvr2fb_setcolreg,
218 	.fb_blank	= pvr2fb_blank,
219 	.fb_check_var	= pvr2fb_check_var,
220 	.fb_set_par	= pvr2fb_set_par,
221 #ifdef CONFIG_PVR2_DMA
222 	.fb_write	= pvr2fb_write,
223 #endif
224 	.fb_fillrect	= cfb_fillrect,
225 	.fb_copyarea	= cfb_copyarea,
226 	.fb_imageblit	= cfb_imageblit,
227 };
228 
229 static struct fb_videomode pvr2_modedb[] = {
230     /*
231      * Broadcast video modes (PAL and NTSC).  I'm unfamiliar with
232      * PAL-M and PAL-N, but from what I've read both modes parallel PAL and
233      * NTSC, so it shouldn't be a problem (I hope).
234      */
235 
236     {
237 	/* 640x480 @ 60Hz interlaced (NTSC) */
238 	"ntsc_640x480i", 60, 640, 480, TV_CLK, 38, 33, 0, 18, 146, 26,
239 	FB_SYNC_BROADCAST, FB_VMODE_INTERLACED | FB_VMODE_YWRAP
240     }, {
241 	/* 640x240 @ 60Hz (NTSC) */
242 	/* XXX: Broken! Don't use... */
243 	"ntsc_640x240", 60, 640, 240, TV_CLK, 38, 33, 0, 0, 146, 22,
244 	FB_SYNC_BROADCAST, FB_VMODE_YWRAP
245     }, {
246 	/* 640x480 @ 60hz (VGA) */
247 	"vga_640x480", 60, 640, 480, VGA_CLK, 38, 33, 0, 18, 146, 26,
248 	0, FB_VMODE_YWRAP
249     },
250 };
251 
252 #define NUM_TOTAL_MODES  ARRAY_SIZE(pvr2_modedb)
253 
254 #define DEFMODE_NTSC	0
255 #define DEFMODE_PAL	0
256 #define DEFMODE_VGA	2
257 
258 static int defmode = DEFMODE_NTSC;
259 static char *mode_option = NULL;
260 
261 static inline void pvr2fb_set_pal_type(unsigned int type)
262 {
263 	struct pvr2fb_par *par = (struct pvr2fb_par *)fb_info->par;
264 
265 	fb_writel(type, par->mmio_base + 0x108);
266 }
267 
268 static inline void pvr2fb_set_pal_entry(struct pvr2fb_par *par,
269 					unsigned int regno,
270 					unsigned int val)
271 {
272 	fb_writel(val, par->mmio_base + 0x1000 + (4 * regno));
273 }
274 
275 static int pvr2fb_blank(int blank, struct fb_info *info)
276 {
277 	do_blank = blank ? blank : -1;
278 	return 0;
279 }
280 
281 static inline unsigned long get_line_length(int xres_virtual, int bpp)
282 {
283 	return (unsigned long)((((xres_virtual*bpp)+31)&~31) >> 3);
284 }
285 
286 static void set_color_bitfields(struct fb_var_screeninfo *var)
287 {
288 	switch (var->bits_per_pixel) {
289 	    case 16:        /* RGB 565 */
290 		pvr2fb_set_pal_type(PAL_RGB565);
291 		var->red.offset = 11;    var->red.length = 5;
292 		var->green.offset = 5;   var->green.length = 6;
293 		var->blue.offset = 0;    var->blue.length = 5;
294 		var->transp.offset = 0;  var->transp.length = 0;
295 		break;
296 	    case 24:        /* RGB 888 */
297 		var->red.offset = 16;    var->red.length = 8;
298 		var->green.offset = 8;   var->green.length = 8;
299 		var->blue.offset = 0;    var->blue.length = 8;
300 		var->transp.offset = 0;  var->transp.length = 0;
301 		break;
302 	    case 32:        /* ARGB 8888 */
303 		pvr2fb_set_pal_type(PAL_ARGB8888);
304 		var->red.offset = 16;    var->red.length = 8;
305 		var->green.offset = 8;   var->green.length = 8;
306 		var->blue.offset = 0;    var->blue.length = 8;
307 		var->transp.offset = 24; var->transp.length = 8;
308 		break;
309 	}
310 }
311 
312 static int pvr2fb_setcolreg(unsigned int regno, unsigned int red,
313 			    unsigned int green, unsigned int blue,
314                             unsigned int transp, struct fb_info *info)
315 {
316 	struct pvr2fb_par *par = (struct pvr2fb_par *)info->par;
317 	unsigned int tmp;
318 
319 	if (regno > info->cmap.len)
320 		return 1;
321 
322 	/*
323 	 * We only support the hardware palette for 16 and 32bpp. It's also
324 	 * expected that the palette format has been set by the time we get
325 	 * here, so we don't waste time setting it again.
326 	 */
327 	switch (info->var.bits_per_pixel) {
328 	    case 16: /* RGB 565 */
329 		tmp =  (red   & 0xf800)       |
330 		      ((green & 0xfc00) >> 5) |
331 		      ((blue  & 0xf800) >> 11);
332 
333 		pvr2fb_set_pal_entry(par, regno, tmp);
334 		break;
335 	    case 24: /* RGB 888 */
336 		red >>= 8; green >>= 8; blue >>= 8;
337 		tmp = (red << 16) | (green << 8) | blue;
338 		break;
339 	    case 32: /* ARGB 8888 */
340 		red >>= 8; green >>= 8; blue >>= 8;
341 		tmp = (transp << 24) | (red << 16) | (green << 8) | blue;
342 
343 		pvr2fb_set_pal_entry(par, regno, tmp);
344 		break;
345 	    default:
346 		pr_debug("Invalid bit depth %d?!?\n", info->var.bits_per_pixel);
347 		return 1;
348 	}
349 
350 	if (regno < 16)
351 		((u32*)(info->pseudo_palette))[regno] = tmp;
352 
353 	return 0;
354 }
355 
356 static int pvr2fb_set_par(struct fb_info *info)
357 {
358 	struct pvr2fb_par *par = (struct pvr2fb_par *)info->par;
359 	struct fb_var_screeninfo *var = &info->var;
360 	unsigned long line_length;
361 	unsigned int vtotal;
362 
363 	/*
364 	 * XXX: It's possible that a user could use a VGA box, change the cable
365 	 * type in hardware (i.e. switch from VGA<->composite), then change
366 	 * modes (i.e. switching to another VT).  If that happens we should
367 	 * automagically change the output format to cope, but currently I
368 	 * don't have a VGA box to make sure this works properly.
369 	 */
370 	cable_type = pvr2_init_cable();
371 	if (cable_type == CT_VGA && video_output != VO_VGA)
372 		video_output = VO_VGA;
373 
374 	var->vmode &= FB_VMODE_MASK;
375 	if (var->vmode & FB_VMODE_INTERLACED && video_output != VO_VGA)
376 		par->is_interlaced = 1;
377 	/*
378 	 * XXX: Need to be more creative with this (i.e. allow doublecan for
379 	 * PAL/NTSC output).
380 	 */
381 	if (var->vmode & FB_VMODE_DOUBLE && video_output == VO_VGA)
382 		par->is_doublescan = 1;
383 
384 	par->hsync_total = var->left_margin + var->xres + var->right_margin +
385 	                   var->hsync_len;
386 	par->vsync_total = var->upper_margin + var->yres + var->lower_margin +
387 	                   var->vsync_len;
388 
389 	if (var->sync & FB_SYNC_BROADCAST) {
390 		vtotal = par->vsync_total;
391 		if (par->is_interlaced)
392 			vtotal /= 2;
393 		if (vtotal > (PAL_VTOTAL + NTSC_VTOTAL)/2) {
394 			/* XXX: Check for start values here... */
395 			/* XXX: Check hardware for PAL-compatibility */
396 			par->borderstart_h = 116;
397 			par->borderstart_v = 44;
398 		} else {
399 			/* NTSC video output */
400 			par->borderstart_h = 126;
401 			par->borderstart_v = 18;
402 		}
403 	} else {
404 		/* VGA mode */
405 		/* XXX: What else needs to be checked? */
406 		/*
407 		 * XXX: We have a little freedom in VGA modes, what ranges
408 		 * should be here (i.e. hsync/vsync totals, etc.)?
409 		 */
410 		par->borderstart_h = 126;
411 		par->borderstart_v = 40;
412 	}
413 
414 	/* Calculate the remainding offsets */
415 	par->diwstart_h = par->borderstart_h + var->left_margin;
416 	par->diwstart_v = par->borderstart_v + var->upper_margin;
417 	par->borderstop_h = par->diwstart_h + var->xres +
418 			    var->right_margin;
419 	par->borderstop_v = par->diwstart_v + var->yres +
420 			    var->lower_margin;
421 
422 	if (!par->is_interlaced)
423 		par->borderstop_v /= 2;
424 	if (info->var.xres < 640)
425 		par->is_lowres = 1;
426 
427 	line_length = get_line_length(var->xres_virtual, var->bits_per_pixel);
428 	par->disp_start = info->fix.smem_start + (line_length * var->yoffset) * line_length;
429 	info->fix.line_length = line_length;
430 	return 0;
431 }
432 
433 static int pvr2fb_check_var(struct fb_var_screeninfo *var, struct fb_info *info)
434 {
435 	struct pvr2fb_par *par = (struct pvr2fb_par *)info->par;
436 	unsigned int vtotal, hsync_total;
437 	unsigned long line_length;
438 
439 	if (var->pixclock != TV_CLK && var->pixclock != VGA_CLK) {
440 		pr_debug("Invalid pixclock value %d\n", var->pixclock);
441 		return -EINVAL;
442 	}
443 
444 	if (var->xres < 320)
445 		var->xres = 320;
446 	if (var->yres < 240)
447 		var->yres = 240;
448 	if (var->xres_virtual < var->xres)
449 		var->xres_virtual = var->xres;
450 	if (var->yres_virtual < var->yres)
451 		var->yres_virtual = var->yres;
452 
453 	if (var->bits_per_pixel <= 16)
454 		var->bits_per_pixel = 16;
455 	else if (var->bits_per_pixel <= 24)
456 		var->bits_per_pixel = 24;
457 	else if (var->bits_per_pixel <= 32)
458 		var->bits_per_pixel = 32;
459 
460 	set_color_bitfields(var);
461 
462 	if (var->vmode & FB_VMODE_YWRAP) {
463 		if (var->xoffset || var->yoffset < 0 ||
464 		    var->yoffset >= var->yres_virtual) {
465 			var->xoffset = var->yoffset = 0;
466 		} else {
467 			if (var->xoffset > var->xres_virtual - var->xres ||
468 			    var->yoffset > var->yres_virtual - var->yres ||
469 			    var->xoffset < 0 || var->yoffset < 0)
470 				var->xoffset = var->yoffset = 0;
471 		}
472 	} else {
473 		var->xoffset = var->yoffset = 0;
474 	}
475 
476 	/*
477 	 * XXX: Need to be more creative with this (i.e. allow doublecan for
478 	 * PAL/NTSC output).
479 	 */
480 	if (var->yres < 480 && video_output == VO_VGA)
481 		var->vmode |= FB_VMODE_DOUBLE;
482 
483 	if (video_output != VO_VGA) {
484 		var->sync |= FB_SYNC_BROADCAST;
485 		var->vmode |= FB_VMODE_INTERLACED;
486 	} else {
487 		var->sync &= ~FB_SYNC_BROADCAST;
488 		var->vmode &= ~FB_VMODE_INTERLACED;
489 		var->vmode |= FB_VMODE_NONINTERLACED;
490 	}
491 
492 	if ((var->activate & FB_ACTIVATE_MASK) != FB_ACTIVATE_TEST) {
493 		var->right_margin = par->borderstop_h -
494 				   (par->diwstart_h + var->xres);
495 		var->left_margin  = par->diwstart_h - par->borderstart_h;
496 		var->hsync_len    = par->borderstart_h +
497 		                   (par->hsync_total - par->borderstop_h);
498 
499 		var->upper_margin = par->diwstart_v - par->borderstart_v;
500 		var->lower_margin = par->borderstop_v -
501 				   (par->diwstart_v + var->yres);
502 		var->vsync_len    = par->borderstop_v +
503 				   (par->vsync_total - par->borderstop_v);
504 	}
505 
506 	hsync_total = var->left_margin + var->xres + var->right_margin +
507 		      var->hsync_len;
508 	vtotal = var->upper_margin + var->yres + var->lower_margin +
509 		 var->vsync_len;
510 
511 	if (var->sync & FB_SYNC_BROADCAST) {
512 		if (var->vmode & FB_VMODE_INTERLACED)
513 			vtotal /= 2;
514 		if (vtotal > (PAL_VTOTAL + NTSC_VTOTAL)/2) {
515 			/* PAL video output */
516 			/* XXX: Should be using a range here ... ? */
517 			if (hsync_total != PAL_HTOTAL) {
518 				pr_debug("invalid hsync total for PAL\n");
519 				return -EINVAL;
520 			}
521 		} else {
522 			/* NTSC video output */
523 			if (hsync_total != NTSC_HTOTAL) {
524 				pr_debug("invalid hsync total for NTSC\n");
525 				return -EINVAL;
526 			}
527 		}
528 	}
529 
530 	/* Check memory sizes */
531 	line_length = get_line_length(var->xres_virtual, var->bits_per_pixel);
532 	if (line_length * var->yres_virtual > info->fix.smem_len)
533 		return -ENOMEM;
534 
535 	return 0;
536 }
537 
538 static void pvr2_update_display(struct fb_info *info)
539 {
540 	struct pvr2fb_par *par = (struct pvr2fb_par *) info->par;
541 	struct fb_var_screeninfo *var = &info->var;
542 
543 	/* Update the start address of the display image */
544 	fb_writel(par->disp_start, DISP_DIWADDRL);
545 	fb_writel(par->disp_start +
546 		  get_line_length(var->xoffset+var->xres, var->bits_per_pixel),
547 	          DISP_DIWADDRS);
548 }
549 
550 /*
551  * Initialize the video mode.  Currently, the 16bpp and 24bpp modes aren't
552  * very stable.  It's probably due to the fact that a lot of the 2D video
553  * registers are still undocumented.
554  */
555 
556 static void pvr2_init_display(struct fb_info *info)
557 {
558 	struct pvr2fb_par *par = (struct pvr2fb_par *) info->par;
559 	struct fb_var_screeninfo *var = &info->var;
560 	unsigned int diw_height, diw_width, diw_modulo = 1;
561 	unsigned int bytesperpixel = var->bits_per_pixel >> 3;
562 
563 	/* hsync and vsync totals */
564 	fb_writel((par->vsync_total << 16) | par->hsync_total, DISP_SYNCSIZE);
565 
566 	/* column height, modulo, row width */
567 	/* since we're "panning" within vram, we need to offset things based
568 	 * on the offset from the virtual x start to our real gfx. */
569 	if (video_output != VO_VGA && par->is_interlaced)
570 		diw_modulo += info->fix.line_length / 4;
571 	diw_height = (par->is_interlaced ? var->yres / 2 : var->yres);
572 	diw_width = get_line_length(var->xres, var->bits_per_pixel) / 4;
573 	fb_writel((diw_modulo << 20) | (--diw_height << 10) | --diw_width,
574 	          DISP_DIWSIZE);
575 
576 	/* display address, long and short fields */
577 	fb_writel(par->disp_start, DISP_DIWADDRL);
578 	fb_writel(par->disp_start +
579 	          get_line_length(var->xoffset+var->xres, var->bits_per_pixel),
580 	          DISP_DIWADDRS);
581 
582 	/* border horizontal, border vertical, border color */
583 	fb_writel((par->borderstart_h << 16) | par->borderstop_h, DISP_BRDRHORZ);
584 	fb_writel((par->borderstart_v << 16) | par->borderstop_v, DISP_BRDRVERT);
585 	fb_writel(0, DISP_BRDRCOLR);
586 
587 	/* display window start position */
588 	fb_writel(par->diwstart_h, DISP_DIWHSTRT);
589 	fb_writel((par->diwstart_v << 16) | par->diwstart_v, DISP_DIWVSTRT);
590 
591 	/* misc. settings */
592 	fb_writel((0x16 << 16) | par->is_lowres, DISP_DIWCONF);
593 
594 	/* clock doubler (for VGA), scan doubler, display enable */
595 	fb_writel(((video_output == VO_VGA) << 23) |
596 	          (par->is_doublescan << 1) | 1, DISP_DIWMODE);
597 
598 	/* bits per pixel */
599 	fb_writel(fb_readl(DISP_DIWMODE) | (--bytesperpixel << 2), DISP_DIWMODE);
600 	fb_writel(bytesperpixel << 2, DISP_PIXDEPTH);
601 
602 	/* video enable, color sync, interlace,
603 	 * hsync and vsync polarity (currently unused) */
604 	fb_writel(0x100 | ((par->is_interlaced /*|4*/) << 4), DISP_SYNCCONF);
605 }
606 
607 /* Simulate blanking by making the border cover the entire screen */
608 
609 #define BLANK_BIT (1<<3)
610 
611 static void pvr2_do_blank(void)
612 {
613 	struct pvr2fb_par *par = currentpar;
614 	unsigned long diwconf;
615 
616 	diwconf = fb_readl(DISP_DIWCONF);
617 	if (do_blank > 0)
618 		fb_writel(diwconf | BLANK_BIT, DISP_DIWCONF);
619 	else
620 		fb_writel(diwconf & ~BLANK_BIT, DISP_DIWCONF);
621 
622 	is_blanked = do_blank > 0 ? do_blank : 0;
623 }
624 
625 static irqreturn_t pvr2fb_interrupt(int irq, void *dev_id)
626 {
627 	struct fb_info *info = dev_id;
628 
629 	if (do_vmode_pan || do_vmode_full)
630 		pvr2_update_display(info);
631 	if (do_vmode_full)
632 		pvr2_init_display(info);
633 	if (do_vmode_pan)
634 		do_vmode_pan = 0;
635 	if (do_vmode_full)
636 		do_vmode_full = 0;
637 	if (do_blank) {
638 		pvr2_do_blank();
639 		do_blank = 0;
640 	}
641 	return IRQ_HANDLED;
642 }
643 
644 /*
645  * Determine the cable type and initialize the cable output format.  Don't do
646  * anything if the cable type has been overidden (via "cable:XX").
647  */
648 
649 #define PCTRA 0xff80002c
650 #define PDTRA 0xff800030
651 #define VOUTC 0xa0702c00
652 
653 static int pvr2_init_cable(void)
654 {
655 	if (cable_type < 0) {
656 		fb_writel((fb_readl(PCTRA) & 0xfff0ffff) | 0x000a0000,
657 	                  PCTRA);
658 		cable_type = (fb_readw(PDTRA) >> 8) & 3;
659 	}
660 
661 	/* Now select the output format (either composite or other) */
662 	/* XXX: Save the previous val first, as this reg is also AICA
663 	  related */
664 	if (cable_type == CT_COMPOSITE)
665 		fb_writel(3 << 8, VOUTC);
666 	else if (cable_type == CT_RGB)
667 		fb_writel(1 << 9, VOUTC);
668 	else
669 		fb_writel(0, VOUTC);
670 
671 	return cable_type;
672 }
673 
674 #ifdef CONFIG_PVR2_DMA
675 static ssize_t pvr2fb_write(struct fb_info *info, const char *buf,
676 			    size_t count, loff_t *ppos)
677 {
678 	unsigned long dst, start, end, len;
679 	unsigned int nr_pages;
680 	struct page **pages;
681 	int ret, i;
682 
683 	nr_pages = (count + PAGE_SIZE - 1) >> PAGE_SHIFT;
684 
685 	pages = kmalloc_array(nr_pages, sizeof(struct page *), GFP_KERNEL);
686 	if (!pages)
687 		return -ENOMEM;
688 
689 	ret = get_user_pages_fast((unsigned long)buf, nr_pages, true, pages);
690 	if (ret < nr_pages) {
691 		nr_pages = ret;
692 		ret = -EINVAL;
693 		goto out_unmap;
694 	}
695 
696 	dma_configure_channel(shdma, 0x12c1);
697 
698 	dst   = (unsigned long)fb_info->screen_base + *ppos;
699 	start = (unsigned long)page_address(pages[0]);
700 	end   = (unsigned long)page_address(pages[nr_pages]);
701 	len   = nr_pages << PAGE_SHIFT;
702 
703 	/* Half-assed contig check */
704 	if (start + len == end) {
705 		/* As we do this in one shot, it's either all or nothing.. */
706 		if ((*ppos + len) > fb_info->fix.smem_len) {
707 			ret = -ENOSPC;
708 			goto out_unmap;
709 		}
710 
711 		dma_write(shdma, start, 0, len);
712 		dma_write(pvr2dma, 0, dst, len);
713 		dma_wait_for_completion(pvr2dma);
714 
715 		goto out;
716 	}
717 
718 	/* Not contiguous, writeout per-page instead.. */
719 	for (i = 0; i < nr_pages; i++, dst += PAGE_SIZE) {
720 		if ((*ppos + (i << PAGE_SHIFT)) > fb_info->fix.smem_len) {
721 			ret = -ENOSPC;
722 			goto out_unmap;
723 		}
724 
725 		dma_write_page(shdma, (unsigned long)page_address(pages[i]), 0);
726 		dma_write_page(pvr2dma, 0, dst);
727 		dma_wait_for_completion(pvr2dma);
728 	}
729 
730 out:
731 	*ppos += count;
732 	ret = count;
733 
734 out_unmap:
735 	for (i = 0; i < nr_pages; i++)
736 		put_page(pages[i]);
737 
738 	kfree(pages);
739 
740 	return ret;
741 }
742 #endif /* CONFIG_PVR2_DMA */
743 
744 /**
745  * pvr2fb_common_init
746  *
747  * Common init code for the PVR2 chips.
748  *
749  * This mostly takes care of the common aspects of the fb setup and
750  * registration. It's expected that the board-specific init code has
751  * already setup pvr2_fix with something meaningful at this point.
752  *
753  * Device info reporting is also done here, as well as picking a sane
754  * default from the modedb. For board-specific modelines, simply define
755  * a per-board modedb.
756  *
757  * Also worth noting is that the cable and video output types are likely
758  * always going to be VGA for the PCI-based PVR2 boards, but we leave this
759  * in for flexibility anyways. Who knows, maybe someone has tv-out on a
760  * PCI-based version of these things ;-)
761  */
762 static int pvr2fb_common_init(void)
763 {
764 	struct pvr2fb_par *par = currentpar;
765 	unsigned long modememused, rev;
766 
767 	fb_info->screen_base = ioremap_nocache(pvr2_fix.smem_start,
768 					       pvr2_fix.smem_len);
769 
770 	if (!fb_info->screen_base) {
771 		printk(KERN_ERR "pvr2fb: Failed to remap smem space\n");
772 		goto out_err;
773 	}
774 
775 	par->mmio_base = (unsigned long)ioremap_nocache(pvr2_fix.mmio_start,
776 							pvr2_fix.mmio_len);
777 	if (!par->mmio_base) {
778 		printk(KERN_ERR "pvr2fb: Failed to remap mmio space\n");
779 		goto out_err;
780 	}
781 
782 	fb_memset(fb_info->screen_base, 0, pvr2_fix.smem_len);
783 
784 	pvr2_fix.ypanstep	= nopan  ? 0 : 1;
785 	pvr2_fix.ywrapstep	= nowrap ? 0 : 1;
786 
787 	fb_info->fbops		= &pvr2fb_ops;
788 	fb_info->fix		= pvr2_fix;
789 	fb_info->par		= currentpar;
790 	fb_info->pseudo_palette	= currentpar->palette;
791 	fb_info->flags		= FBINFO_DEFAULT | FBINFO_HWACCEL_YPAN;
792 
793 	if (video_output == VO_VGA)
794 		defmode = DEFMODE_VGA;
795 
796 	if (!mode_option)
797 		mode_option = "640x480@60";
798 
799 	if (!fb_find_mode(&fb_info->var, fb_info, mode_option, pvr2_modedb,
800 	                  NUM_TOTAL_MODES, &pvr2_modedb[defmode], 16))
801 		fb_info->var = pvr2_var;
802 
803 	fb_alloc_cmap(&fb_info->cmap, 256, 0);
804 
805 	if (register_framebuffer(fb_info) < 0)
806 		goto out_err;
807 	/*Must write PIXDEPTH to register before anything is displayed - so force init */
808 	pvr2_init_display(fb_info);
809 
810 	modememused = get_line_length(fb_info->var.xres_virtual,
811 				      fb_info->var.bits_per_pixel);
812 	modememused *= fb_info->var.yres_virtual;
813 
814 	rev = fb_readl(par->mmio_base + 0x04);
815 
816 	fb_info(fb_info, "%s (rev %ld.%ld) frame buffer device, using %ldk/%ldk of video memory\n",
817 		fb_info->fix.id, (rev >> 4) & 0x0f, rev & 0x0f,
818 		modememused >> 10,
819 		(unsigned long)(fb_info->fix.smem_len >> 10));
820 	fb_info(fb_info, "Mode %dx%d-%d pitch = %ld cable: %s video output: %s\n",
821 		fb_info->var.xres, fb_info->var.yres,
822 		fb_info->var.bits_per_pixel,
823 		get_line_length(fb_info->var.xres, fb_info->var.bits_per_pixel),
824 		(char *)pvr2_get_param(cables, NULL, cable_type, 3),
825 		(char *)pvr2_get_param(outputs, NULL, video_output, 3));
826 
827 #ifdef CONFIG_SH_STORE_QUEUES
828 	fb_notice(fb_info, "registering with SQ API\n");
829 
830 	pvr2fb_map = sq_remap(fb_info->fix.smem_start, fb_info->fix.smem_len,
831 			      fb_info->fix.id, PAGE_SHARED);
832 
833 	fb_notice(fb_info, "Mapped video memory to SQ addr 0x%lx\n",
834 		  pvr2fb_map);
835 #endif
836 
837 	return 0;
838 
839 out_err:
840 	if (fb_info->screen_base)
841 		iounmap(fb_info->screen_base);
842 	if (par->mmio_base)
843 		iounmap((void *)par->mmio_base);
844 
845 	return -ENXIO;
846 }
847 
848 #ifdef CONFIG_SH_DREAMCAST
849 static int __init pvr2fb_dc_init(void)
850 {
851 	if (!mach_is_dreamcast())
852 		return -ENXIO;
853 
854 	/* Make a guess at the monitor based on the attached cable */
855 	if (pvr2_init_cable() == CT_VGA) {
856 		fb_info->monspecs.hfmin = 30000;
857 		fb_info->monspecs.hfmax = 70000;
858 		fb_info->monspecs.vfmin = 60;
859 		fb_info->monspecs.vfmax = 60;
860 	} else {
861 		/* Not VGA, using a TV (taken from acornfb) */
862 		fb_info->monspecs.hfmin = 15469;
863 		fb_info->monspecs.hfmax = 15781;
864 		fb_info->monspecs.vfmin = 49;
865 		fb_info->monspecs.vfmax = 51;
866 	}
867 
868 	/*
869 	 * XXX: This needs to pull default video output via BIOS or other means
870 	 */
871 	if (video_output < 0) {
872 		if (cable_type == CT_VGA) {
873 			video_output = VO_VGA;
874 		} else {
875 			video_output = VO_NTSC;
876 		}
877 	}
878 
879 	/*
880 	 * Nothing exciting about the DC PVR2 .. only a measly 8MiB.
881 	 */
882 	pvr2_fix.smem_start	= 0xa5000000;	/* RAM starts here */
883 	pvr2_fix.smem_len	= 8 << 20;
884 
885 	pvr2_fix.mmio_start	= 0xa05f8000;	/* registers start here */
886 	pvr2_fix.mmio_len	= 0x2000;
887 
888 	if (request_irq(HW_EVENT_VSYNC, pvr2fb_interrupt, IRQF_SHARED,
889 	                "pvr2 VBL handler", fb_info)) {
890 		return -EBUSY;
891 	}
892 
893 #ifdef CONFIG_PVR2_DMA
894 	if (request_dma(pvr2dma, "pvr2") != 0) {
895 		free_irq(HW_EVENT_VSYNC, fb_info);
896 		return -EBUSY;
897 	}
898 #endif
899 
900 	return pvr2fb_common_init();
901 }
902 
903 static void __exit pvr2fb_dc_exit(void)
904 {
905 	if (fb_info->screen_base) {
906 		iounmap(fb_info->screen_base);
907 		fb_info->screen_base = NULL;
908 	}
909 	if (currentpar->mmio_base) {
910 		iounmap((void *)currentpar->mmio_base);
911 		currentpar->mmio_base = 0;
912 	}
913 
914 	free_irq(HW_EVENT_VSYNC, fb_info);
915 #ifdef CONFIG_PVR2_DMA
916 	free_dma(pvr2dma);
917 #endif
918 }
919 #endif /* CONFIG_SH_DREAMCAST */
920 
921 #ifdef CONFIG_PCI
922 static int pvr2fb_pci_probe(struct pci_dev *pdev,
923 			    const struct pci_device_id *ent)
924 {
925 	int ret;
926 
927 	ret = pci_enable_device(pdev);
928 	if (ret) {
929 		printk(KERN_ERR "pvr2fb: PCI enable failed\n");
930 		return ret;
931 	}
932 
933 	ret = pci_request_regions(pdev, "pvr2fb");
934 	if (ret) {
935 		printk(KERN_ERR "pvr2fb: PCI request regions failed\n");
936 		return ret;
937 	}
938 
939 	/*
940 	 * Slightly more exciting than the DC PVR2 .. 16MiB!
941 	 */
942 	pvr2_fix.smem_start	= pci_resource_start(pdev, 0);
943 	pvr2_fix.smem_len	= pci_resource_len(pdev, 0);
944 
945 	pvr2_fix.mmio_start	= pci_resource_start(pdev, 1);
946 	pvr2_fix.mmio_len	= pci_resource_len(pdev, 1);
947 
948 	fb_info->device		= &pdev->dev;
949 
950 	return pvr2fb_common_init();
951 }
952 
953 static void pvr2fb_pci_remove(struct pci_dev *pdev)
954 {
955 	if (fb_info->screen_base) {
956 		iounmap(fb_info->screen_base);
957 		fb_info->screen_base = NULL;
958 	}
959 	if (currentpar->mmio_base) {
960 		iounmap((void *)currentpar->mmio_base);
961 		currentpar->mmio_base = 0;
962 	}
963 
964 	pci_release_regions(pdev);
965 }
966 
967 static const struct pci_device_id pvr2fb_pci_tbl[] = {
968 	{ PCI_VENDOR_ID_NEC, PCI_DEVICE_ID_NEC_NEON250,
969 	  PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 },
970 	{ 0, },
971 };
972 
973 MODULE_DEVICE_TABLE(pci, pvr2fb_pci_tbl);
974 
975 static struct pci_driver pvr2fb_pci_driver = {
976 	.name		= "pvr2fb",
977 	.id_table	= pvr2fb_pci_tbl,
978 	.probe		= pvr2fb_pci_probe,
979 	.remove		= pvr2fb_pci_remove,
980 };
981 
982 static int __init pvr2fb_pci_init(void)
983 {
984 	return pci_register_driver(&pvr2fb_pci_driver);
985 }
986 
987 static void __exit pvr2fb_pci_exit(void)
988 {
989 	pci_unregister_driver(&pvr2fb_pci_driver);
990 }
991 #endif /* CONFIG_PCI */
992 
993 static int pvr2_get_param(const struct pvr2_params *p, const char *s, int val,
994 			  int size)
995 {
996 	int i;
997 
998 	for (i = 0 ; i < size ; i++ ) {
999 		if (s != NULL) {
1000 			if (!strncasecmp(p[i].name, s, strlen(s)))
1001 				return p[i].val;
1002 		} else {
1003 			if (p[i].val == val)
1004 				return (int)p[i].name;
1005 		}
1006 	}
1007 	return -1;
1008 }
1009 
1010 /*
1011  * Parse command arguments.  Supported arguments are:
1012  *    inverse                             Use inverse color maps
1013  *    cable:composite|rgb|vga             Override the video cable type
1014  *    output:NTSC|PAL|VGA                 Override the video output format
1015  *
1016  *    <xres>x<yres>[-<bpp>][@<refresh>]   or,
1017  *    <name>[-<bpp>][@<refresh>]          Startup using this video mode
1018  */
1019 
1020 #ifndef MODULE
1021 static int __init pvr2fb_setup(char *options)
1022 {
1023 	char *this_opt;
1024 	char cable_arg[80];
1025 	char output_arg[80];
1026 
1027 	if (!options || !*options)
1028 		return 0;
1029 
1030 	while ((this_opt = strsep(&options, ","))) {
1031 		if (!*this_opt)
1032 			continue;
1033 		if (!strcmp(this_opt, "inverse")) {
1034 			fb_invert_cmaps();
1035 		} else if (!strncmp(this_opt, "cable:", 6)) {
1036 			strcpy(cable_arg, this_opt + 6);
1037 		} else if (!strncmp(this_opt, "output:", 7)) {
1038 			strcpy(output_arg, this_opt + 7);
1039 		} else if (!strncmp(this_opt, "nopan", 5)) {
1040 			nopan = 1;
1041 		} else if (!strncmp(this_opt, "nowrap", 6)) {
1042 			nowrap = 1;
1043 		} else {
1044 			mode_option = this_opt;
1045 		}
1046 	}
1047 
1048 	if (*cable_arg)
1049 		cable_type = pvr2_get_param(cables, cable_arg, 0, 3);
1050 	if (*output_arg)
1051 		video_output = pvr2_get_param(outputs, output_arg, 0, 3);
1052 
1053 	return 0;
1054 }
1055 #endif
1056 
1057 static struct pvr2_board {
1058 	int (*init)(void);
1059 	void (*exit)(void);
1060 	char name[16];
1061 } board_driver[] __refdata = {
1062 #ifdef CONFIG_SH_DREAMCAST
1063 	{ pvr2fb_dc_init, pvr2fb_dc_exit, "Sega DC PVR2" },
1064 #endif
1065 #ifdef CONFIG_PCI
1066 	{ pvr2fb_pci_init, pvr2fb_pci_exit, "PCI PVR2" },
1067 #endif
1068 	{ 0, },
1069 };
1070 
1071 static int __init pvr2fb_init(void)
1072 {
1073 	int i, ret = -ENODEV;
1074 	int size;
1075 
1076 #ifndef MODULE
1077 	char *option = NULL;
1078 
1079 	if (fb_get_options("pvr2fb", &option))
1080 		return -ENODEV;
1081 	pvr2fb_setup(option);
1082 #endif
1083 	size = sizeof(struct fb_info) + sizeof(struct pvr2fb_par) + 16 * sizeof(u32);
1084 
1085 	fb_info = framebuffer_alloc(sizeof(struct pvr2fb_par), NULL);
1086 
1087 	if (!fb_info) {
1088 		printk(KERN_ERR "Failed to allocate memory for fb_info\n");
1089 		return -ENOMEM;
1090 	}
1091 
1092 
1093 	currentpar = fb_info->par;
1094 
1095 	for (i = 0; i < ARRAY_SIZE(board_driver); i++) {
1096 		struct pvr2_board *pvr_board = board_driver + i;
1097 
1098 		if (!pvr_board->init)
1099 			continue;
1100 
1101 		ret = pvr_board->init();
1102 
1103 		if (ret != 0) {
1104 			printk(KERN_ERR "pvr2fb: Failed init of %s device\n",
1105 				pvr_board->name);
1106 			framebuffer_release(fb_info);
1107 			break;
1108 		}
1109 	}
1110 
1111 	return ret;
1112 }
1113 
1114 static void __exit pvr2fb_exit(void)
1115 {
1116 	int i;
1117 
1118 	for (i = 0; i < ARRAY_SIZE(board_driver); i++) {
1119 		struct pvr2_board *pvr_board = board_driver + i;
1120 
1121 		if (pvr_board->exit)
1122 			pvr_board->exit();
1123 	}
1124 
1125 #ifdef CONFIG_SH_STORE_QUEUES
1126 	sq_unmap(pvr2fb_map);
1127 #endif
1128 
1129 	unregister_framebuffer(fb_info);
1130 	framebuffer_release(fb_info);
1131 }
1132 
1133 module_init(pvr2fb_init);
1134 module_exit(pvr2fb_exit);
1135 
1136 MODULE_AUTHOR("Paul Mundt <lethal@linux-sh.org>, M. R. Brown <mrbrown@0xd6.org>");
1137 MODULE_DESCRIPTION("Framebuffer driver for NEC PowerVR 2 based graphics boards");
1138 MODULE_LICENSE("GPL");
1139