au1100fb.c

  1/*
  2 * BRIEF MODULE DESCRIPTION
  3 *	Au1100 LCD Driver.
  4 *
  5 * Rewritten for 2.6 by Embedded Alley Solutions
  6 * 	<source@embeddedalley.com>, based on submissions by
  7 *  	Karl Lessard <klessard@sunrisetelecom.com>
  8 *  	<c.pellegrin@exadron.com>
  9 *
 10 * PM support added by Rodolfo Giometti <giometti@linux.it>
 11 * Cursor enable/disable by Rodolfo Giometti <giometti@linux.it>
 12 *
 13 * Copyright 2002 MontaVista Software
 14 * Author: MontaVista Software, Inc.
 15 *		ppopov@mvista.com or source@mvista.com
 16 *
 17 * Copyright 2002 Alchemy Semiconductor
 18 * Author: Alchemy Semiconductor
 19 *
 20 * Based on:
 21 * linux/drivers/video/skeletonfb.c -- Skeleton for a frame buffer device
 22 *  Created 28 Dec 1997 by Geert Uytterhoeven
 23 *
 24 *  This program is free software; you can redistribute	 it and/or modify it
 25 *  under  the terms of	 the GNU General  Public License as published by the
 26 *  Free Software Foundation;  either version 2 of the	License, or (at your
 27 *  option) any later version.
 28 *
 29 *  THIS  SOFTWARE  IS PROVIDED	  ``AS	IS'' AND   ANY	EXPRESS OR IMPLIED
 30 *  WARRANTIES,	  INCLUDING, BUT NOT  LIMITED  TO, THE IMPLIED WARRANTIES OF
 31 *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
 32 *  NO	EVENT  SHALL   THE AUTHOR  BE	 LIABLE FOR ANY	  DIRECT, INDIRECT,
 33 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 34 *  NOT LIMITED	  TO, PROCUREMENT OF  SUBSTITUTE GOODS	OR SERVICES; LOSS OF
 35 *  USE, DATA,	OR PROFITS; OR	BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 36 *  ANY THEORY OF LIABILITY, WHETHER IN	 CONTRACT, STRICT LIABILITY, OR TORT
 37 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 38 *  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 39 *
 40 *  You should have received a copy of the  GNU General Public License along
 41 *  with this program; if not, write  to the Free Software Foundation, Inc.,
 42 *  675 Mass Ave, Cambridge, MA 02139, USA.
 43 */
 44#include <linux/clk.h>
 45#include <linux/module.h>
 46#include <linux/kernel.h>
 47#include <linux/errno.h>
 48#include <linux/string.h>
 49#include <linux/mm.h>
 50#include <linux/fb.h>
 51#include <linux/init.h>
 52#include <linux/interrupt.h>
 53#include <linux/ctype.h>
 54#include <linux/dma-mapping.h>
 55#include <linux/platform_device.h>
 56#include <linux/slab.h>
 57
 58#include <asm/mach-au1x00/au1000.h>
 59
 60#define DEBUG 0
 61
 62#include "au1100fb.h"
 63
 64#define DRIVER_NAME "au1100fb"
 65#define DRIVER_DESC "LCD controller driver for AU1100 processors"
 66
 67#define to_au1100fb_device(_info) \
 68	  (_info ? container_of(_info, struct au1100fb_device, info) : NULL);
 69
 70/* Bitfields format supported by the controller. Note that the order of formats
 71 * SHOULD be the same as in the LCD_CONTROL_SBPPF field, so we can retrieve the
 72 * right pixel format by doing rgb_bitfields[LCD_CONTROL_SBPPF_XXX >> LCD_CONTROL_SBPPF]
 73 */
 74struct fb_bitfield rgb_bitfields[][4] =
 75{
 76  	/*     Red, 	   Green, 	 Blue, 	     Transp   */
 77	{ { 10, 6, 0 }, { 5, 5, 0 }, { 0, 5, 0 }, { 0, 0, 0 } },
 78	{ { 11, 5, 0 }, { 5, 6, 0 }, { 0, 5, 0 }, { 0, 0, 0 } },
 79	{ { 11, 5, 0 }, { 6, 5, 0 }, { 0, 6, 0 }, { 0, 0, 0 } },
 80	{ { 10, 5, 0 }, { 5, 5, 0 }, { 0, 5, 0 }, { 15, 1, 0 } },
 81	{ { 11, 5, 0 }, { 6, 5, 0 }, { 1, 5, 0 }, { 0, 1, 0 } },
 82
 83	/* The last is used to describe 12bpp format */
 84	{ { 8, 4, 0 },  { 4, 4, 0 }, { 0, 4, 0 }, { 0, 0, 0 } },
 85};
 86
 87static struct fb_fix_screeninfo au1100fb_fix = {
 88	.id		= "AU1100 FB",
 89	.xpanstep 	= 1,
 90	.ypanstep 	= 1,
 91	.type		= FB_TYPE_PACKED_PIXELS,
 92	.accel		= FB_ACCEL_NONE,
 93};
 94
 95static struct fb_var_screeninfo au1100fb_var = {
 96	.activate	= FB_ACTIVATE_NOW,
 97	.height		= -1,
 98	.width		= -1,
 99	.vmode		= FB_VMODE_NONINTERLACED,
100};
101
102/* fb_blank
103 * Blank the screen. Depending on the mode, the screen will be
104 * activated with the backlight color, or desactivated
105 */
106static int au1100fb_fb_blank(int blank_mode, struct fb_info *fbi)
107{
108	struct au1100fb_device *fbdev = to_au1100fb_device(fbi);
109
110	print_dbg("fb_blank %d %p", blank_mode, fbi);
111
112	switch (blank_mode) {
113
114	case VESA_NO_BLANKING:
115		/* Turn on panel */
116		fbdev->regs->lcd_control |= LCD_CONTROL_GO;
117		wmb(); /* drain writebuffer */
118		break;
119
120	case VESA_VSYNC_SUSPEND:
121	case VESA_HSYNC_SUSPEND:
122	case VESA_POWERDOWN:
123		/* Turn off panel */
124		fbdev->regs->lcd_control &= ~LCD_CONTROL_GO;
125		wmb(); /* drain writebuffer */
126		break;
127	default:
128		break;
129
130	}
131	return 0;
132}
133
134/*
135 * Set hardware with var settings. This will enable the controller with a specific
136 * mode, normally validated with the fb_check_var method
137	 */
138int au1100fb_setmode(struct au1100fb_device *fbdev)
139{
140	struct fb_info *info;
141	u32 words;
142	int index;
143
144	if (!fbdev)
145		return -EINVAL;
146
147	info = &fbdev->info;
148
149	/* Update var-dependent FB info */
150	if (panel_is_active(fbdev->panel) || panel_is_color(fbdev->panel)) {
151		if (info->var.bits_per_pixel <= 8) {
152			/* palettized */
153			info->var.red.offset    = 0;
154			info->var.red.length    = info->var.bits_per_pixel;
155			info->var.red.msb_right = 0;
156
157			info->var.green.offset  = 0;
158			info->var.green.length  = info->var.bits_per_pixel;
159			info->var.green.msb_right = 0;
160
161			info->var.blue.offset   = 0;
162			info->var.blue.length   = info->var.bits_per_pixel;
163			info->var.blue.msb_right = 0;
164
165			info->var.transp.offset = 0;
166			info->var.transp.length = 0;
167			info->var.transp.msb_right = 0;
168
169			info->fix.visual = FB_VISUAL_PSEUDOCOLOR;
170			info->fix.line_length = info->var.xres_virtual /
171							(8/info->var.bits_per_pixel);
172		} else {
173			/* non-palettized */
174			index = (fbdev->panel->control_base & LCD_CONTROL_SBPPF_MASK) >> LCD_CONTROL_SBPPF_BIT;
175			info->var.red = rgb_bitfields[index][0];
176			info->var.green = rgb_bitfields[index][1];
177			info->var.blue = rgb_bitfields[index][2];
178			info->var.transp = rgb_bitfields[index][3];
179
180			info->fix.visual = FB_VISUAL_TRUECOLOR;
181			info->fix.line_length = info->var.xres_virtual << 1; /* depth=16 */
182		}
183	} else {
184		/* mono */
185		info->fix.visual = FB_VISUAL_MONO10;
186		info->fix.line_length = info->var.xres_virtual / 8;
187	}
188
189	info->screen_size = info->fix.line_length * info->var.yres_virtual;
190	info->var.rotate = ((fbdev->panel->control_base&LCD_CONTROL_SM_MASK) \
191				>> LCD_CONTROL_SM_BIT) * 90;
192
193	/* Determine BPP mode and format */
194	fbdev->regs->lcd_control = fbdev->panel->control_base;
195	fbdev->regs->lcd_horztiming = fbdev->panel->horztiming;
196	fbdev->regs->lcd_verttiming = fbdev->panel->verttiming;
197	fbdev->regs->lcd_clkcontrol = fbdev->panel->clkcontrol_base;
198	fbdev->regs->lcd_intenable = 0;
199	fbdev->regs->lcd_intstatus = 0;
200	fbdev->regs->lcd_dmaaddr0 = LCD_DMA_SA_N(fbdev->fb_phys);
201
202	if (panel_is_dual(fbdev->panel)) {
203		/* Second panel display seconf half of screen if possible,
204		 * otherwise display the same as the first panel */
205		if (info->var.yres_virtual >= (info->var.yres << 1)) {
206			fbdev->regs->lcd_dmaaddr1 = LCD_DMA_SA_N(fbdev->fb_phys +
207							  (info->fix.line_length *
208						          (info->var.yres_virtual >> 1)));
209		} else {
210			fbdev->regs->lcd_dmaaddr1 = LCD_DMA_SA_N(fbdev->fb_phys);
211		}
212	}
213
214	words = info->fix.line_length / sizeof(u32);
215	if (!info->var.rotate || (info->var.rotate == 180)) {
216		words *= info->var.yres_virtual;
217		if (info->var.rotate /* 180 */) {
218			words -= (words % 8); /* should be divisable by 8 */
219		}
220	}
221	fbdev->regs->lcd_words = LCD_WRD_WRDS_N(words);
222
223	fbdev->regs->lcd_pwmdiv = 0;
224	fbdev->regs->lcd_pwmhi = 0;
225
226	/* Resume controller */
227	fbdev->regs->lcd_control |= LCD_CONTROL_GO;
228	mdelay(10);
229	au1100fb_fb_blank(VESA_NO_BLANKING, info);
230
231	return 0;
232}
233
234/* fb_setcolreg
235 * Set color in LCD palette.
236 */
237int au1100fb_fb_setcolreg(unsigned regno, unsigned red, unsigned green, unsigned blue, unsigned transp, struct fb_info *fbi)
238{
239	struct au1100fb_device *fbdev;
240	u32 *palette;
241	u32 value;
242
243	fbdev = to_au1100fb_device(fbi);
244	palette = fbdev->regs->lcd_palettebase;
245
246	if (regno > (AU1100_LCD_NBR_PALETTE_ENTRIES - 1))
247		return -EINVAL;
248
249	if (fbi->var.grayscale) {
250		/* Convert color to grayscale */
251		red = green = blue =
252			(19595 * red + 38470 * green + 7471 * blue) >> 16;
253	}
254
255	if (fbi->fix.visual == FB_VISUAL_TRUECOLOR) {
256		/* Place color in the pseudopalette */
257		if (regno > 16)
258			return -EINVAL;
259
260		palette = (u32*)fbi->pseudo_palette;
261
262		red   >>= (16 - fbi->var.red.length);
263		green >>= (16 - fbi->var.green.length);
264		blue  >>= (16 - fbi->var.blue.length);
265
266		value = (red   << fbi->var.red.offset) 	|
267			(green << fbi->var.green.offset)|
268			(blue  << fbi->var.blue.offset);
269		value &= 0xFFFF;
270
271	} else if (panel_is_active(fbdev->panel)) {
272		/* COLOR TFT PALLETTIZED (use RGB 565) */
273		value = (red & 0xF800)|((green >> 5) & 0x07E0)|((blue >> 11) & 0x001F);
274		value &= 0xFFFF;
275
276	} else if (panel_is_color(fbdev->panel)) {
277		/* COLOR STN MODE */
278		value = (((panel_swap_rgb(fbdev->panel) ? blue : red) >> 12) & 0x000F) |
279			((green >> 8) & 0x00F0) |
280			(((panel_swap_rgb(fbdev->panel) ? red : blue) >> 4) & 0x0F00);
281		value &= 0xFFF;
282	} else {
283		/* MONOCHROME MODE */
284		value = (green >> 12) & 0x000F;
285		value &= 0xF;
286	}
287
288	palette[regno] = value;
289
290	return 0;
291}
292
293/* fb_pan_display
294 * Pan display in x and/or y as specified
295 */
296int au1100fb_fb_pan_display(struct fb_var_screeninfo *var, struct fb_info *fbi)
297{
298	struct au1100fb_device *fbdev;
299	int dy;
300
301	fbdev = to_au1100fb_device(fbi);
302
303	print_dbg("fb_pan_display %p %p", var, fbi);
304
305	if (!var || !fbdev) {
306		return -EINVAL;
307	}
308
309	if (var->xoffset - fbi->var.xoffset) {
310		/* No support for X panning for now! */
311		return -EINVAL;
312	}
313
314	print_dbg("fb_pan_display 2 %p %p", var, fbi);
315	dy = var->yoffset - fbi->var.yoffset;
316	if (dy) {
317
318		u32 dmaaddr;
319
320		print_dbg("Panning screen of %d lines", dy);
321
322		dmaaddr = fbdev->regs->lcd_dmaaddr0;
323		dmaaddr += (fbi->fix.line_length * dy);
324
325		/* TODO: Wait for current frame to finished */
326		fbdev->regs->lcd_dmaaddr0 = LCD_DMA_SA_N(dmaaddr);
327
328		if (panel_is_dual(fbdev->panel)) {
329			dmaaddr = fbdev->regs->lcd_dmaaddr1;
330			dmaaddr += (fbi->fix.line_length * dy);
331			fbdev->regs->lcd_dmaaddr0 = LCD_DMA_SA_N(dmaaddr);
332	}
333	}
334	print_dbg("fb_pan_display 3 %p %p", var, fbi);
335
336	return 0;
337}
338
339/* fb_mmap
340 * Map video memory in user space. We don't use the generic fb_mmap method mainly
341 * to allow the use of the TLB streaming flag (CCA=6)
342 */
343int au1100fb_fb_mmap(struct fb_info *fbi, struct vm_area_struct *vma)
344{
345	struct au1100fb_device *fbdev = to_au1100fb_device(fbi);
346
347	vma->vm_page_prot = pgprot_decrypted(vma->vm_page_prot);
348
349	pgprot_val(vma->vm_page_prot) |= (6 << 9); //CCA=6
350
351	return dma_mmap_coherent(fbdev->dev, vma, fbdev->fb_mem, fbdev->fb_phys,
352			fbdev->fb_len);
353}
354
355static const struct fb_ops au1100fb_ops = {
356	.owner			= THIS_MODULE,
357	__FB_DEFAULT_IOMEM_OPS_RDWR,
358	.fb_setcolreg		= au1100fb_fb_setcolreg,
359	.fb_blank		= au1100fb_fb_blank,
360	.fb_pan_display		= au1100fb_fb_pan_display,
361	__FB_DEFAULT_IOMEM_OPS_DRAW,
362	.fb_mmap		= au1100fb_fb_mmap,
363};
364
365
366/*-------------------------------------------------------------------------*/
367
368static int au1100fb_setup(struct au1100fb_device *fbdev)
369{
370	char *this_opt, *options;
371	int num_panels = ARRAY_SIZE(known_lcd_panels);
372
373	if (num_panels <= 0) {
374		print_err("No LCD panels supported by driver!");
375		return -ENODEV;
376	}
377
378	if (fb_get_options(DRIVER_NAME, &options))
379		return -ENODEV;
380	if (!options)
381		return -ENODEV;
382
383	while ((this_opt = strsep(&options, ",")) != NULL) {
384		/* Panel option */
385		if (!strncmp(this_opt, "panel:", 6)) {
386			int i;
387			this_opt += 6;
388			for (i = 0; i < num_panels; i++) {
389				if (!strncmp(this_opt, known_lcd_panels[i].name,
390					     strlen(this_opt))) {
391					fbdev->panel = &known_lcd_panels[i];
392					fbdev->panel_idx = i;
393					break;
394				}
395			}
396			if (i >= num_panels) {
397				print_warn("Panel '%s' not supported!", this_opt);
398				return -ENODEV;
399			}
400		}
401		/* Unsupported option */
402		else
403			print_warn("Unsupported option \"%s\"", this_opt);
404	}
405
406	print_info("Panel=%s", fbdev->panel->name);
407
408	return 0;
409}
410
411static int au1100fb_drv_probe(struct platform_device *dev)
412{
413	struct au1100fb_device *fbdev;
414	struct resource *regs_res;
415	struct clk *c;
416
417	/* Allocate new device private */
418	fbdev = devm_kzalloc(&dev->dev, sizeof(*fbdev), GFP_KERNEL);
419	if (!fbdev)
420		return -ENOMEM;
421
422	if (au1100fb_setup(fbdev))
423		goto failed;
424
425	platform_set_drvdata(dev, (void *)fbdev);
426	fbdev->dev = &dev->dev;
427
428	/* Allocate region for our registers and map them */
429	regs_res = platform_get_resource(dev, IORESOURCE_MEM, 0);
430	if (!regs_res) {
431		print_err("fail to retrieve registers resource");
432		return -EFAULT;
433	}
434
435	au1100fb_fix.mmio_start = regs_res->start;
436	au1100fb_fix.mmio_len = resource_size(regs_res);
437
438	if (!devm_request_mem_region(&dev->dev,
439				     au1100fb_fix.mmio_start,
440				     au1100fb_fix.mmio_len,
441				     DRIVER_NAME)) {
442		print_err("fail to lock memory region at 0x%08lx",
443				au1100fb_fix.mmio_start);
444		return -EBUSY;
445	}
446
447	fbdev->regs = (struct au1100fb_regs*)KSEG1ADDR(au1100fb_fix.mmio_start);
448
449	print_dbg("Register memory map at %p", fbdev->regs);
450	print_dbg("phys=0x%08x, size=%d", fbdev->regs_phys, fbdev->regs_len);
451
452	c = clk_get(NULL, "lcd_intclk");
453	if (!IS_ERR(c)) {
454		fbdev->lcdclk = c;
455		clk_set_rate(c, 48000000);
456		clk_prepare_enable(c);
457	}
458
459	/* Allocate the framebuffer to the maximum screen size * nbr of video buffers */
460	fbdev->fb_len = fbdev->panel->xres * fbdev->panel->yres *
461		  	(fbdev->panel->bpp >> 3) * AU1100FB_NBR_VIDEO_BUFFERS;
462
463	fbdev->fb_mem = dmam_alloc_coherent(&dev->dev,
464					    PAGE_ALIGN(fbdev->fb_len),
465					    &fbdev->fb_phys, GFP_KERNEL);
466	if (!fbdev->fb_mem) {
467		print_err("fail to allocate framebuffer (size: %dK))",
468			  fbdev->fb_len / 1024);
469		return -ENOMEM;
470	}
471
472	au1100fb_fix.smem_start = fbdev->fb_phys;
473	au1100fb_fix.smem_len = fbdev->fb_len;
474
475	print_dbg("Framebuffer memory map at %p", fbdev->fb_mem);
476	print_dbg("phys=0x%08x, size=%dK", fbdev->fb_phys, fbdev->fb_len / 1024);
477
478	/* load the panel info into the var struct */
479	au1100fb_var.bits_per_pixel = fbdev->panel->bpp;
480	au1100fb_var.xres = fbdev->panel->xres;
481	au1100fb_var.xres_virtual = au1100fb_var.xres;
482	au1100fb_var.yres = fbdev->panel->yres;
483	au1100fb_var.yres_virtual = au1100fb_var.yres;
484
485	fbdev->info.screen_base = fbdev->fb_mem;
486	fbdev->info.fbops = &au1100fb_ops;
487	fbdev->info.fix = au1100fb_fix;
488
489	fbdev->info.pseudo_palette =
490		devm_kcalloc(&dev->dev, 16, sizeof(u32), GFP_KERNEL);
491	if (!fbdev->info.pseudo_palette)
492		return -ENOMEM;
493
494	if (fb_alloc_cmap(&fbdev->info.cmap, AU1100_LCD_NBR_PALETTE_ENTRIES, 0) < 0) {
495		print_err("Fail to allocate colormap (%d entries)",
496			   AU1100_LCD_NBR_PALETTE_ENTRIES);
497		return -EFAULT;
498	}
499
500	fbdev->info.var = au1100fb_var;
501
502	/* Set h/w registers */
503	au1100fb_setmode(fbdev);
504
505	/* Register new framebuffer */
506	if (register_framebuffer(&fbdev->info) < 0) {
507		print_err("cannot register new framebuffer");
508		goto failed;
509	}
510
511	return 0;
512
513failed:
514	if (fbdev->lcdclk) {
515		clk_disable_unprepare(fbdev->lcdclk);
516		clk_put(fbdev->lcdclk);
517	}
518	if (fbdev->info.cmap.len != 0) {
519		fb_dealloc_cmap(&fbdev->info.cmap);
520	}
521
522	return -ENODEV;
523}
524
525void au1100fb_drv_remove(struct platform_device *dev)
526{
527	struct au1100fb_device *fbdev = NULL;
528
529	fbdev = platform_get_drvdata(dev);
530
531#if !defined(CONFIG_FRAMEBUFFER_CONSOLE) && defined(CONFIG_LOGO)
532	au1100fb_fb_blank(VESA_POWERDOWN, &fbdev->info);
533#endif
534	fbdev->regs->lcd_control &= ~LCD_CONTROL_GO;
535
536	/* Clean up all probe data */
537	unregister_framebuffer(&fbdev->info);
538
539	fb_dealloc_cmap(&fbdev->info.cmap);
540
541	if (fbdev->lcdclk) {
542		clk_disable_unprepare(fbdev->lcdclk);
543		clk_put(fbdev->lcdclk);
544	}
545}
546
547#ifdef CONFIG_PM
548static struct au1100fb_regs fbregs;
549
550int au1100fb_drv_suspend(struct platform_device *dev, pm_message_t state)
551{
552	struct au1100fb_device *fbdev = platform_get_drvdata(dev);
553
554	if (!fbdev)
555		return 0;
556
557	/* Blank the LCD */
558	au1100fb_fb_blank(VESA_POWERDOWN, &fbdev->info);
559
560	clk_disable(fbdev->lcdclk);
561
562	memcpy(&fbregs, fbdev->regs, sizeof(struct au1100fb_regs));
563
564	return 0;
565}
566
567int au1100fb_drv_resume(struct platform_device *dev)
568{
569	struct au1100fb_device *fbdev = platform_get_drvdata(dev);
570
571	if (!fbdev)
572		return 0;
573
574	memcpy(fbdev->regs, &fbregs, sizeof(struct au1100fb_regs));
575
576	clk_enable(fbdev->lcdclk);
577
578	/* Unblank the LCD */
579	au1100fb_fb_blank(VESA_NO_BLANKING, &fbdev->info);
580
581	return 0;
582}
583#else
584#define au1100fb_drv_suspend NULL
585#define au1100fb_drv_resume NULL
586#endif
587
588static struct platform_driver au1100fb_driver = {
589	.driver = {
590		.name		= "au1100-lcd",
591	},
592	.probe		= au1100fb_drv_probe,
593	.remove		= au1100fb_drv_remove,
594	.suspend	= au1100fb_drv_suspend,
595	.resume		= au1100fb_drv_resume,
596};
597module_platform_driver(au1100fb_driver);
598
599MODULE_DESCRIPTION(DRIVER_DESC);
600MODULE_LICENSE("GPL");