1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Geode GX framebuffer driver.
4  *
5  *   Copyright (C) 2006 Arcom Control Systems Ltd.
6  *
7  * This driver assumes that the BIOS has created a virtual PCI device header
8  * for the video device. The PCI header is assumed to contain the following
9  * BARs:
10  *
11  *    BAR0 - framebuffer memory
12  *    BAR1 - graphics processor registers
13  *    BAR2 - display controller registers
14  *    BAR3 - video processor and flat panel control registers.
15  *
16  * 16 MiB of framebuffer memory is assumed to be available.
17  */
18 #include <linux/module.h>
19 #include <linux/kernel.h>
20 #include <linux/errno.h>
21 #include <linux/string.h>
22 #include <linux/mm.h>
23 #include <linux/delay.h>
24 #include <linux/fb.h>
25 #include <linux/console.h>
26 #include <linux/suspend.h>
27 #include <linux/init.h>
28 #include <linux/pci.h>
29 #include <linux/cs5535.h>
30 
31 #include <asm/olpc.h>
32 
33 #include "gxfb.h"
34 
35 static char *mode_option;
36 static int vram;
37 static int vt_switch;
38 
39 /* Modes relevant to the GX (taken from modedb.c) */
40 static struct fb_videomode gx_modedb[] = {
41 	/* 640x480-60 VESA */
42 	{ NULL, 60, 640, 480, 39682,  48, 16, 33, 10, 96, 2,
43 	  0, FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
44 	/* 640x480-75 VESA */
45 	{ NULL, 75, 640, 480, 31746, 120, 16, 16, 01, 64, 3,
46 	  0, FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
47 	/* 640x480-85 VESA */
48 	{ NULL, 85, 640, 480, 27777, 80, 56, 25, 01, 56, 3,
49 	  0, FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
50 	/* 800x600-60 VESA */
51 	{ NULL, 60, 800, 600, 25000, 88, 40, 23, 01, 128, 4,
52 	  FB_SYNC_HOR_HIGH_ACT | FB_SYNC_VERT_HIGH_ACT,
53 	  FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
54 	/* 800x600-75 VESA */
55 	{ NULL, 75, 800, 600, 20202, 160, 16, 21, 01, 80, 3,
56 	  FB_SYNC_HOR_HIGH_ACT | FB_SYNC_VERT_HIGH_ACT,
57 	  FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
58 	/* 800x600-85 VESA */
59 	{ NULL, 85, 800, 600, 17761, 152, 32, 27, 01, 64, 3,
60 	  FB_SYNC_HOR_HIGH_ACT | FB_SYNC_VERT_HIGH_ACT,
61 	  FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
62 	/* 1024x768-60 VESA */
63 	{ NULL, 60, 1024, 768, 15384, 160, 24, 29, 3, 136, 6,
64 	  0, FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
65 	/* 1024x768-75 VESA */
66 	{ NULL, 75, 1024, 768, 12690, 176, 16, 28, 1, 96, 3,
67 	  FB_SYNC_HOR_HIGH_ACT | FB_SYNC_VERT_HIGH_ACT,
68 	  FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
69 	/* 1024x768-85 VESA */
70 	{ NULL, 85, 1024, 768, 10582, 208, 48, 36, 1, 96, 3,
71 	  FB_SYNC_HOR_HIGH_ACT | FB_SYNC_VERT_HIGH_ACT,
72 	  FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
73 	/* 1280x960-60 VESA */
74 	{ NULL, 60, 1280, 960, 9259, 312, 96, 36, 1, 112, 3,
75 	  FB_SYNC_HOR_HIGH_ACT | FB_SYNC_VERT_HIGH_ACT,
76 	  FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
77 	/* 1280x960-85 VESA */
78 	{ NULL, 85, 1280, 960, 6734, 224, 64, 47, 1, 160, 3,
79 	  FB_SYNC_HOR_HIGH_ACT | FB_SYNC_VERT_HIGH_ACT,
80 	  FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
81 	/* 1280x1024-60 VESA */
82 	{ NULL, 60, 1280, 1024, 9259, 248, 48, 38, 1, 112, 3,
83 	  FB_SYNC_HOR_HIGH_ACT | FB_SYNC_VERT_HIGH_ACT,
84 	  FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
85 	/* 1280x1024-75 VESA */
86 	{ NULL, 75, 1280, 1024, 7407, 248, 16, 38, 1, 144, 3,
87 	  FB_SYNC_HOR_HIGH_ACT | FB_SYNC_VERT_HIGH_ACT,
88 	  FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
89 	/* 1280x1024-85 VESA */
90 	{ NULL, 85, 1280, 1024, 6349, 224, 64, 44, 1, 160, 3,
91 	  FB_SYNC_HOR_HIGH_ACT | FB_SYNC_VERT_HIGH_ACT,
92 	  FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
93 	/* 1600x1200-60 VESA */
94 	{ NULL, 60, 1600, 1200, 6172, 304, 64, 46, 1, 192, 3,
95 	  FB_SYNC_HOR_HIGH_ACT | FB_SYNC_VERT_HIGH_ACT,
96 	  FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
97 	/* 1600x1200-75 VESA */
98 	{ NULL, 75, 1600, 1200, 4938, 304, 64, 46, 1, 192, 3,
99 	  FB_SYNC_HOR_HIGH_ACT | FB_SYNC_VERT_HIGH_ACT,
100 	  FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
101 	/* 1600x1200-85 VESA */
102 	{ NULL, 85, 1600, 1200, 4357, 304, 64, 46, 1, 192, 3,
103 	  FB_SYNC_HOR_HIGH_ACT | FB_SYNC_VERT_HIGH_ACT,
104 	  FB_VMODE_NONINTERLACED, FB_MODE_IS_VESA },
105 };
106 
107 static struct fb_videomode gx_dcon_modedb[] = {
108 	/* The only mode the DCON has is 1200x900 */
109 	{ NULL, 50, 1200, 900, 17460, 24, 8, 4, 5, 8, 3,
110 	  FB_SYNC_HOR_HIGH_ACT | FB_SYNC_VERT_HIGH_ACT,
111 	  FB_VMODE_NONINTERLACED, 0 }
112 };
113 
114 static void get_modedb(struct fb_videomode **modedb, unsigned int *size)
115 {
116 	if (olpc_has_dcon()) {
117 		*modedb = (struct fb_videomode *) gx_dcon_modedb;
118 		*size = ARRAY_SIZE(gx_dcon_modedb);
119 	} else {
120 		*modedb = (struct fb_videomode *) gx_modedb;
121 		*size = ARRAY_SIZE(gx_modedb);
122 	}
123 }
124 
125 static int gxfb_check_var(struct fb_var_screeninfo *var, struct fb_info *info)
126 {
127 	if (var->xres > 1600 || var->yres > 1200)
128 		return -EINVAL;
129 	if ((var->xres > 1280 || var->yres > 1024) && var->bits_per_pixel > 16)
130 		return -EINVAL;
131 
132 	if (var->bits_per_pixel == 32) {
133 		var->red.offset   = 16; var->red.length   = 8;
134 		var->green.offset =  8; var->green.length = 8;
135 		var->blue.offset  =  0; var->blue.length  = 8;
136 	} else if (var->bits_per_pixel == 16) {
137 		var->red.offset   = 11; var->red.length   = 5;
138 		var->green.offset =  5; var->green.length = 6;
139 		var->blue.offset  =  0; var->blue.length  = 5;
140 	} else if (var->bits_per_pixel == 8) {
141 		var->red.offset   = 0; var->red.length   = 8;
142 		var->green.offset = 0; var->green.length = 8;
143 		var->blue.offset  = 0; var->blue.length  = 8;
144 	} else
145 		return -EINVAL;
146 	var->transp.offset = 0; var->transp.length = 0;
147 
148 	/* Enough video memory? */
149 	if (gx_line_delta(var->xres, var->bits_per_pixel) * var->yres > info->fix.smem_len)
150 		return -EINVAL;
151 
152 	/* FIXME: Check timing parameters here? */
153 
154 	return 0;
155 }
156 
157 static int gxfb_set_par(struct fb_info *info)
158 {
159 	if (info->var.bits_per_pixel > 8)
160 		info->fix.visual = FB_VISUAL_TRUECOLOR;
161 	else
162 		info->fix.visual = FB_VISUAL_PSEUDOCOLOR;
163 
164 	info->fix.line_length = gx_line_delta(info->var.xres, info->var.bits_per_pixel);
165 
166 	gx_set_mode(info);
167 
168 	return 0;
169 }
170 
171 static inline u_int chan_to_field(u_int chan, struct fb_bitfield *bf)
172 {
173 	chan &= 0xffff;
174 	chan >>= 16 - bf->length;
175 	return chan << bf->offset;
176 }
177 
178 static int gxfb_setcolreg(unsigned regno, unsigned red, unsigned green,
179 			   unsigned blue, unsigned transp,
180 			   struct fb_info *info)
181 {
182 	if (info->var.grayscale) {
183 		/* grayscale = 0.30*R + 0.59*G + 0.11*B */
184 		red = green = blue = (red * 77 + green * 151 + blue * 28) >> 8;
185 	}
186 
187 	/* Truecolor has hardware independent palette */
188 	if (info->fix.visual == FB_VISUAL_TRUECOLOR) {
189 		u32 *pal = info->pseudo_palette;
190 		u32 v;
191 
192 		if (regno >= 16)
193 			return -EINVAL;
194 
195 		v  = chan_to_field(red, &info->var.red);
196 		v |= chan_to_field(green, &info->var.green);
197 		v |= chan_to_field(blue, &info->var.blue);
198 
199 		pal[regno] = v;
200 	} else {
201 		if (regno >= 256)
202 			return -EINVAL;
203 
204 		gx_set_hw_palette_reg(info, regno, red, green, blue);
205 	}
206 
207 	return 0;
208 }
209 
210 static int gxfb_blank(int blank_mode, struct fb_info *info)
211 {
212 	return gx_blank_display(info, blank_mode);
213 }
214 
215 static int gxfb_map_video_memory(struct fb_info *info, struct pci_dev *dev)
216 {
217 	struct gxfb_par *par = info->par;
218 	int ret;
219 
220 	ret = pci_enable_device(dev);
221 	if (ret < 0)
222 		return ret;
223 
224 	ret = pci_request_region(dev, 3, "gxfb (video processor)");
225 	if (ret < 0)
226 		return ret;
227 	par->vid_regs = pci_ioremap_bar(dev, 3);
228 	if (!par->vid_regs)
229 		return -ENOMEM;
230 
231 	ret = pci_request_region(dev, 2, "gxfb (display controller)");
232 	if (ret < 0)
233 		return ret;
234 	par->dc_regs = pci_ioremap_bar(dev, 2);
235 	if (!par->dc_regs)
236 		return -ENOMEM;
237 
238 	ret = pci_request_region(dev, 1, "gxfb (graphics processor)");
239 	if (ret < 0)
240 		return ret;
241 	par->gp_regs = pci_ioremap_bar(dev, 1);
242 
243 	if (!par->gp_regs)
244 		return -ENOMEM;
245 
246 	ret = pci_request_region(dev, 0, "gxfb (framebuffer)");
247 	if (ret < 0)
248 		return ret;
249 
250 	info->fix.smem_start = pci_resource_start(dev, 0);
251 	info->fix.smem_len = vram ? vram : gx_frame_buffer_size();
252 	info->screen_base = ioremap_wc(info->fix.smem_start,
253 				       info->fix.smem_len);
254 	if (!info->screen_base)
255 		return -ENOMEM;
256 
257 	/* Set the 16MiB aligned base address of the graphics memory region
258 	 * in the display controller */
259 
260 	write_dc(par, DC_GLIU0_MEM_OFFSET, info->fix.smem_start & 0xFF000000);
261 
262 	dev_info(&dev->dev, "%d KiB of video memory at 0x%lx\n",
263 		 info->fix.smem_len / 1024, info->fix.smem_start);
264 
265 	return 0;
266 }
267 
268 static const struct fb_ops gxfb_ops = {
269 	.owner		= THIS_MODULE,
270 	.fb_check_var	= gxfb_check_var,
271 	.fb_set_par	= gxfb_set_par,
272 	.fb_setcolreg	= gxfb_setcolreg,
273 	.fb_blank       = gxfb_blank,
274 	/* No HW acceleration for now. */
275 	.fb_fillrect	= cfb_fillrect,
276 	.fb_copyarea	= cfb_copyarea,
277 	.fb_imageblit	= cfb_imageblit,
278 };
279 
280 static struct fb_info *gxfb_init_fbinfo(struct device *dev)
281 {
282 	struct gxfb_par *par;
283 	struct fb_info *info;
284 
285 	/* Alloc enough space for the pseudo palette. */
286 	info = framebuffer_alloc(sizeof(struct gxfb_par) + sizeof(u32) * 16,
287 			dev);
288 	if (!info)
289 		return NULL;
290 
291 	par = info->par;
292 
293 	strcpy(info->fix.id, "Geode GX");
294 
295 	info->fix.type		= FB_TYPE_PACKED_PIXELS;
296 	info->fix.type_aux	= 0;
297 	info->fix.xpanstep	= 0;
298 	info->fix.ypanstep	= 0;
299 	info->fix.ywrapstep	= 0;
300 	info->fix.accel		= FB_ACCEL_NONE;
301 
302 	info->var.nonstd	= 0;
303 	info->var.activate	= FB_ACTIVATE_NOW;
304 	info->var.height	= -1;
305 	info->var.width	= -1;
306 	info->var.accel_flags = 0;
307 	info->var.vmode	= FB_VMODE_NONINTERLACED;
308 
309 	info->fbops		= &gxfb_ops;
310 	info->flags		= FBINFO_DEFAULT;
311 	info->node		= -1;
312 
313 	info->pseudo_palette	= (void *)par + sizeof(struct gxfb_par);
314 
315 	info->var.grayscale	= 0;
316 
317 	if (fb_alloc_cmap(&info->cmap, 256, 0) < 0) {
318 		framebuffer_release(info);
319 		return NULL;
320 	}
321 
322 	return info;
323 }
324 
325 static int __maybe_unused gxfb_suspend(struct device *dev)
326 {
327 	struct fb_info *info = dev_get_drvdata(dev);
328 
329 	console_lock();
330 	gx_powerdown(info);
331 	fb_set_suspend(info, 1);
332 	console_unlock();
333 
334 	/* there's no point in setting PCI states; we emulate PCI, so
335 	 * we don't end up getting power savings anyways */
336 
337 	return 0;
338 }
339 
340 static int __maybe_unused gxfb_resume(struct device *dev)
341 {
342 	struct fb_info *info = dev_get_drvdata(dev);
343 	int ret;
344 
345 	console_lock();
346 	ret = gx_powerup(info);
347 	if (ret) {
348 		printk(KERN_ERR "gxfb:  power up failed!\n");
349 		return ret;
350 	}
351 
352 	fb_set_suspend(info, 0);
353 	console_unlock();
354 	return 0;
355 }
356 
357 static int gxfb_probe(struct pci_dev *pdev, const struct pci_device_id *id)
358 {
359 	struct gxfb_par *par;
360 	struct fb_info *info;
361 	int ret;
362 	unsigned long val;
363 
364 	struct fb_videomode *modedb_ptr;
365 	unsigned int modedb_size;
366 
367 	info = gxfb_init_fbinfo(&pdev->dev);
368 	if (!info)
369 		return -ENOMEM;
370 	par = info->par;
371 
372 	if ((ret = gxfb_map_video_memory(info, pdev)) < 0) {
373 		dev_err(&pdev->dev, "failed to map frame buffer or controller registers\n");
374 		goto err;
375 	}
376 
377 	/* Figure out if this is a TFT or CRT part */
378 
379 	rdmsrl(MSR_GX_GLD_MSR_CONFIG, val);
380 
381 	if ((val & MSR_GX_GLD_MSR_CONFIG_FP) == MSR_GX_GLD_MSR_CONFIG_FP)
382 		par->enable_crt = 0;
383 	else
384 		par->enable_crt = 1;
385 
386 	get_modedb(&modedb_ptr, &modedb_size);
387 	ret = fb_find_mode(&info->var, info, mode_option,
388 			   modedb_ptr, modedb_size, NULL, 16);
389 	if (ret == 0 || ret == 4) {
390 		dev_err(&pdev->dev, "could not find valid video mode\n");
391 		ret = -EINVAL;
392 		goto err;
393 	}
394 
395 
396 	/* Clear the frame buffer of garbage. */
397         memset_io(info->screen_base, 0, info->fix.smem_len);
398 
399 	gxfb_check_var(&info->var, info);
400 	gxfb_set_par(info);
401 
402 	pm_set_vt_switch(vt_switch);
403 
404 	if (register_framebuffer(info) < 0) {
405 		ret = -EINVAL;
406 		goto err;
407 	}
408 	pci_set_drvdata(pdev, info);
409 	fb_info(info, "%s frame buffer device\n", info->fix.id);
410 	return 0;
411 
412   err:
413 	if (info->screen_base) {
414 		iounmap(info->screen_base);
415 		pci_release_region(pdev, 0);
416 	}
417 	if (par->vid_regs) {
418 		iounmap(par->vid_regs);
419 		pci_release_region(pdev, 3);
420 	}
421 	if (par->dc_regs) {
422 		iounmap(par->dc_regs);
423 		pci_release_region(pdev, 2);
424 	}
425 	if (par->gp_regs) {
426 		iounmap(par->gp_regs);
427 		pci_release_region(pdev, 1);
428 	}
429 
430 	fb_dealloc_cmap(&info->cmap);
431 	framebuffer_release(info);
432 	return ret;
433 }
434 
435 static void gxfb_remove(struct pci_dev *pdev)
436 {
437 	struct fb_info *info = pci_get_drvdata(pdev);
438 	struct gxfb_par *par = info->par;
439 
440 	unregister_framebuffer(info);
441 
442 	iounmap((void __iomem *)info->screen_base);
443 	pci_release_region(pdev, 0);
444 
445 	iounmap(par->vid_regs);
446 	pci_release_region(pdev, 3);
447 
448 	iounmap(par->dc_regs);
449 	pci_release_region(pdev, 2);
450 
451 	iounmap(par->gp_regs);
452 	pci_release_region(pdev, 1);
453 
454 	fb_dealloc_cmap(&info->cmap);
455 
456 	framebuffer_release(info);
457 }
458 
459 static const struct pci_device_id gxfb_id_table[] = {
460 	{ PCI_DEVICE(PCI_VENDOR_ID_NS, PCI_DEVICE_ID_NS_GX_VIDEO) },
461 	{ 0, }
462 };
463 
464 MODULE_DEVICE_TABLE(pci, gxfb_id_table);
465 
466 static const struct dev_pm_ops gxfb_pm_ops = {
467 #ifdef CONFIG_PM_SLEEP
468 	.suspend	= gxfb_suspend,
469 	.resume		= gxfb_resume,
470 	.freeze		= NULL,
471 	.thaw		= gxfb_resume,
472 	.poweroff	= NULL,
473 	.restore	= gxfb_resume,
474 #endif
475 };
476 
477 static struct pci_driver gxfb_driver = {
478 	.name		= "gxfb",
479 	.id_table	= gxfb_id_table,
480 	.probe		= gxfb_probe,
481 	.remove		= gxfb_remove,
482 	.driver.pm	= &gxfb_pm_ops,
483 };
484 
485 #ifndef MODULE
486 static int __init gxfb_setup(char *options)
487 {
488 
489 	char *opt;
490 
491 	if (!options || !*options)
492 		return 0;
493 
494 	while ((opt = strsep(&options, ",")) != NULL) {
495 		if (!*opt)
496 			continue;
497 
498 		mode_option = opt;
499 	}
500 
501 	return 0;
502 }
503 #endif
504 
505 static int __init gxfb_init(void)
506 {
507 #ifndef MODULE
508 	char *option = NULL;
509 
510 	if (fb_get_options("gxfb", &option))
511 		return -ENODEV;
512 
513 	gxfb_setup(option);
514 #endif
515 	return pci_register_driver(&gxfb_driver);
516 }
517 
518 static void __exit gxfb_cleanup(void)
519 {
520 	pci_unregister_driver(&gxfb_driver);
521 }
522 
523 module_init(gxfb_init);
524 module_exit(gxfb_cleanup);
525 
526 module_param(mode_option, charp, 0);
527 MODULE_PARM_DESC(mode_option, "video mode (<x>x<y>[-<bpp>][@<refr>])");
528 
529 module_param(vram, int, 0);
530 MODULE_PARM_DESC(vram, "video memory size");
531 
532 module_param(vt_switch, int, 0);
533 MODULE_PARM_DESC(vt_switch, "enable VT switch during suspend/resume");
534 
535 MODULE_DESCRIPTION("Framebuffer driver for the AMD Geode GX");
536 MODULE_LICENSE("GPL");
537