2 * Freescale i.MX Frame Buffer device driver
4 * Copyright (C) 2004 Sascha Hauer, Pengutronix
5 * Based on acornfb.c Copyright (C) Russell King.
7 * This file is subject to the terms and conditions of the GNU General Public
8 * License. See the file COPYING in the main directory of this archive for
11 * Please direct your questions and comments on this driver to the following
14 * linux-arm-kernel@lists.arm.linux.org.uk
18 #include <linux/module.h>
19 #include <linux/kernel.h>
20 #include <linux/errno.h>
21 #include <linux/string.h>
22 #include <linux/interrupt.h>
23 #include <linux/slab.h>
26 #include <linux/delay.h>
27 #include <linux/init.h>
28 #include <linux/ioport.h>
29 #include <linux/cpufreq.h>
30 #include <linux/platform_device.h>
31 #include <linux/dma-mapping.h>
34 #include <mach/imxfb.h>
37 * Complain if VAR is out of range.
41 #define DRIVER_NAME "imx-fb"
45 #define LCDC_SIZE 0x04
46 #define SIZE_XMAX(x) ((((x) >> 4) & 0x3f) << 20)
47 #define SIZE_YMAX(y) ((y) & 0x1ff)
50 #define VPW_VPW(x) ((x) & 0x3ff)
52 #define LCDC_CPOS 0x0C
53 #define CPOS_CC1 (1<<31)
54 #define CPOS_CC0 (1<<30)
55 #define CPOS_OP (1<<28)
56 #define CPOS_CXP(x) (((x) & 3ff) << 16)
57 #define CPOS_CYP(y) ((y) & 0x1ff)
59 #define LCDC_LCWHB 0x10
60 #define LCWHB_BK_EN (1<<31)
61 #define LCWHB_CW(w) (((w) & 0x1f) << 24)
62 #define LCWHB_CH(h) (((h) & 0x1f) << 16)
63 #define LCWHB_BD(x) ((x) & 0xff)
65 #define LCDC_LCHCC 0x14
66 #define LCHCC_CUR_COL_R(r) (((r) & 0x1f) << 11)
67 #define LCHCC_CUR_COL_G(g) (((g) & 0x3f) << 5)
68 #define LCHCC_CUR_COL_B(b) ((b) & 0x1f)
73 #define HCR_H_WIDTH(x) (((x) & 0x3f) << 26)
74 #define HCR_H_WAIT_1(x) (((x) & 0xff) << 8)
75 #define HCR_H_WAIT_2(x) ((x) & 0xff)
78 #define VCR_V_WIDTH(x) (((x) & 0x3f) << 26)
79 #define VCR_V_WAIT_1(x) (((x) & 0xff) << 8)
80 #define VCR_V_WAIT_2(x) ((x) & 0xff)
83 #define POS_POS(x) ((x) & 1f)
85 #define LCDC_LSCR1 0x28
86 /* bit fields in imxfb.h */
88 #define LCDC_PWMR 0x2C
89 /* bit fields in imxfb.h */
91 #define LCDC_DMACR 0x30
92 /* bit fields in imxfb.h */
94 #define LCDC_RMCR 0x34
95 #define RMCR_LCDC_EN (1<<1)
96 #define RMCR_SELF_REF (1<<0)
98 #define LCDC_LCDICR 0x38
99 #define LCDICR_INT_SYN (1<<2)
100 #define LCDICR_INT_CON (1)
102 #define LCDC_LCDISR 0x40
103 #define LCDISR_UDR_ERR (1<<3)
104 #define LCDISR_ERR_RES (1<<2)
105 #define LCDISR_EOF (1<<1)
106 #define LCDISR_BOF (1<<0)
109 * These are the bitfields for each
110 * display depth that we support.
113 struct fb_bitfield red
;
114 struct fb_bitfield green
;
115 struct fb_bitfield blue
;
116 struct fb_bitfield transp
;
120 struct platform_device
*pdev
;
128 * These are the addresses we mapped
129 * the framebuffer memory region to.
136 dma_addr_t screen_dma
;
146 u_int cmap_inverse
:1,
150 void (*lcd_power
)(int);
151 void (*backlight_power
)(int);
154 #define IMX_NAME "IMX"
157 * Minimum X and Y resolutions
162 static struct imxfb_rgb def_rgb_16_tft
= {
163 .red
= {.offset
= 11, .length
= 5,},
164 .green
= {.offset
= 5, .length
= 6,},
165 .blue
= {.offset
= 0, .length
= 5,},
166 .transp
= {.offset
= 0, .length
= 0,},
169 static struct imxfb_rgb def_rgb_16_stn
= {
170 .red
= {.offset
= 8, .length
= 4,},
171 .green
= {.offset
= 4, .length
= 4,},
172 .blue
= {.offset
= 0, .length
= 4,},
173 .transp
= {.offset
= 0, .length
= 0,},
176 static struct imxfb_rgb def_rgb_8
= {
177 .red
= {.offset
= 0, .length
= 8,},
178 .green
= {.offset
= 0, .length
= 8,},
179 .blue
= {.offset
= 0, .length
= 8,},
180 .transp
= {.offset
= 0, .length
= 0,},
183 static int imxfb_activate_var(struct fb_var_screeninfo
*var
,
184 struct fb_info
*info
);
186 static inline u_int
chan_to_field(u_int chan
, struct fb_bitfield
*bf
)
189 chan
>>= 16 - bf
->length
;
190 return chan
<< bf
->offset
;
193 static int imxfb_setpalettereg(u_int regno
, u_int red
, u_int green
, u_int blue
,
194 u_int trans
, struct fb_info
*info
)
196 struct imxfb_info
*fbi
= info
->par
;
199 #define CNVT_TOHW(val,width) ((((val)<<(width))+0x7FFF-(val))>>16)
200 if (regno
< fbi
->palette_size
) {
201 val
= (CNVT_TOHW(red
, 4) << 8) |
202 (CNVT_TOHW(green
,4) << 4) |
205 writel(val
, fbi
->regs
+ 0x800 + (regno
<< 2));
211 static int imxfb_setcolreg(u_int regno
, u_int red
, u_int green
, u_int blue
,
212 u_int trans
, struct fb_info
*info
)
214 struct imxfb_info
*fbi
= info
->par
;
219 * If inverse mode was selected, invert all the colours
220 * rather than the register number. The register number
221 * is what you poke into the framebuffer to produce the
222 * colour you requested.
224 if (fbi
->cmap_inverse
) {
226 green
= 0xffff - green
;
227 blue
= 0xffff - blue
;
231 * If greyscale is true, then we convert the RGB value
232 * to greyscale no mater what visual we are using.
234 if (info
->var
.grayscale
)
235 red
= green
= blue
= (19595 * red
+ 38470 * green
+
238 switch (info
->fix
.visual
) {
239 case FB_VISUAL_TRUECOLOR
:
241 * 12 or 16-bit True Colour. We encode the RGB value
242 * according to the RGB bitfield information.
245 u32
*pal
= info
->pseudo_palette
;
247 val
= chan_to_field(red
, &info
->var
.red
);
248 val
|= chan_to_field(green
, &info
->var
.green
);
249 val
|= chan_to_field(blue
, &info
->var
.blue
);
256 case FB_VISUAL_STATIC_PSEUDOCOLOR
:
257 case FB_VISUAL_PSEUDOCOLOR
:
258 ret
= imxfb_setpalettereg(regno
, red
, green
, blue
, trans
, info
);
267 * Round up in the following order: bits_per_pixel, xres,
268 * yres, xres_virtual, yres_virtual, xoffset, yoffset, grayscale,
269 * bitfields, horizontal timing, vertical timing.
271 static int imxfb_check_var(struct fb_var_screeninfo
*var
, struct fb_info
*info
)
273 struct imxfb_info
*fbi
= info
->par
;
274 struct imxfb_rgb
*rgb
;
276 if (var
->xres
< MIN_XRES
)
277 var
->xres
= MIN_XRES
;
278 if (var
->yres
< MIN_YRES
)
279 var
->yres
= MIN_YRES
;
280 if (var
->xres
> fbi
->max_xres
)
281 var
->xres
= fbi
->max_xres
;
282 if (var
->yres
> fbi
->max_yres
)
283 var
->yres
= fbi
->max_yres
;
284 var
->xres_virtual
= max(var
->xres_virtual
, var
->xres
);
285 var
->yres_virtual
= max(var
->yres_virtual
, var
->yres
);
287 pr_debug("var->bits_per_pixel=%d\n", var
->bits_per_pixel
);
288 switch (var
->bits_per_pixel
) {
291 if (readl(fbi
->regs
+ LCDC_PCR
) & PCR_TFT
)
292 rgb
= &def_rgb_16_tft
;
294 rgb
= &def_rgb_16_stn
;
302 * Copy the RGB parameters for this display
303 * from the machine specific parameters.
306 var
->green
= rgb
->green
;
307 var
->blue
= rgb
->blue
;
308 var
->transp
= rgb
->transp
;
310 pr_debug("RGBT length = %d:%d:%d:%d\n",
311 var
->red
.length
, var
->green
.length
, var
->blue
.length
,
314 pr_debug("RGBT offset = %d:%d:%d:%d\n",
315 var
->red
.offset
, var
->green
.offset
, var
->blue
.offset
,
323 * Set the user defined part of the display for the specified console
325 static int imxfb_set_par(struct fb_info
*info
)
327 struct imxfb_info
*fbi
= info
->par
;
328 struct fb_var_screeninfo
*var
= &info
->var
;
330 pr_debug("set_par\n");
332 if (var
->bits_per_pixel
== 16)
333 info
->fix
.visual
= FB_VISUAL_TRUECOLOR
;
334 else if (!fbi
->cmap_static
)
335 info
->fix
.visual
= FB_VISUAL_PSEUDOCOLOR
;
338 * Some people have weird ideas about wanting static
339 * pseudocolor maps. I suspect their user space
340 * applications are broken.
342 info
->fix
.visual
= FB_VISUAL_STATIC_PSEUDOCOLOR
;
345 info
->fix
.line_length
= var
->xres_virtual
* var
->bits_per_pixel
/ 8;
346 fbi
->palette_size
= var
->bits_per_pixel
== 8 ? 256 : 16;
348 imxfb_activate_var(var
, info
);
353 static void imxfb_enable_controller(struct imxfb_info
*fbi
)
355 pr_debug("Enabling LCD controller\n");
357 /* initialize LCDC */
358 writel(readl(fbi
->regs
+ LCDC_RMCR
) & ~RMCR_LCDC_EN
,
359 fbi
->regs
+ LCDC_RMCR
); /* just to be safe... */
361 writel(fbi
->screen_dma
, fbi
->regs
+ LCDC_SSA
);
363 /* physical screen start address */
364 writel(VPW_VPW(fbi
->max_xres
* fbi
->max_bpp
/ 8 / 4),
365 fbi
->regs
+ LCDC_VPW
);
367 /* panning offset 0 (0 pixel offset) */
368 writel(0x00000000, fbi
->regs
+ LCDC_POS
);
370 /* disable hardware cursor */
371 writel(readl(fbi
->regs
+ LCDC_CPOS
) & ~(CPOS_CC0
| CPOS_CC1
),
372 fbi
->regs
+ LCDC_CPOS
);
374 writel(RMCR_LCDC_EN
, fbi
->regs
+ LCDC_RMCR
);
376 if (fbi
->backlight_power
)
377 fbi
->backlight_power(1);
382 static void imxfb_disable_controller(struct imxfb_info
*fbi
)
384 pr_debug("Disabling LCD controller\n");
386 if (fbi
->backlight_power
)
387 fbi
->backlight_power(0);
391 writel(0, fbi
->regs
+ LCDC_RMCR
);
394 static int imxfb_blank(int blank
, struct fb_info
*info
)
396 struct imxfb_info
*fbi
= info
->par
;
398 pr_debug("imxfb_blank: blank=%d\n", blank
);
401 case FB_BLANK_POWERDOWN
:
402 case FB_BLANK_VSYNC_SUSPEND
:
403 case FB_BLANK_HSYNC_SUSPEND
:
404 case FB_BLANK_NORMAL
:
405 imxfb_disable_controller(fbi
);
408 case FB_BLANK_UNBLANK
:
409 imxfb_enable_controller(fbi
);
415 static struct fb_ops imxfb_ops
= {
416 .owner
= THIS_MODULE
,
417 .fb_check_var
= imxfb_check_var
,
418 .fb_set_par
= imxfb_set_par
,
419 .fb_setcolreg
= imxfb_setcolreg
,
420 .fb_fillrect
= cfb_fillrect
,
421 .fb_copyarea
= cfb_copyarea
,
422 .fb_imageblit
= cfb_imageblit
,
423 .fb_blank
= imxfb_blank
,
427 * imxfb_activate_var():
428 * Configures LCD Controller based on entries in var parameter. Settings are
429 * only written to the controller if changes were made.
431 static int imxfb_activate_var(struct fb_var_screeninfo
*var
, struct fb_info
*info
)
433 struct imxfb_info
*fbi
= info
->par
;
434 pr_debug("var: xres=%d hslen=%d lm=%d rm=%d\n",
435 var
->xres
, var
->hsync_len
,
436 var
->left_margin
, var
->right_margin
);
437 pr_debug("var: yres=%d vslen=%d um=%d bm=%d\n",
438 var
->yres
, var
->vsync_len
,
439 var
->upper_margin
, var
->lower_margin
);
442 if (var
->xres
< 16 || var
->xres
> 1024)
443 printk(KERN_ERR
"%s: invalid xres %d\n",
444 info
->fix
.id
, var
->xres
);
445 if (var
->hsync_len
< 1 || var
->hsync_len
> 64)
446 printk(KERN_ERR
"%s: invalid hsync_len %d\n",
447 info
->fix
.id
, var
->hsync_len
);
448 if (var
->left_margin
> 255)
449 printk(KERN_ERR
"%s: invalid left_margin %d\n",
450 info
->fix
.id
, var
->left_margin
);
451 if (var
->right_margin
> 255)
452 printk(KERN_ERR
"%s: invalid right_margin %d\n",
453 info
->fix
.id
, var
->right_margin
);
454 if (var
->yres
< 1 || var
->yres
> 511)
455 printk(KERN_ERR
"%s: invalid yres %d\n",
456 info
->fix
.id
, var
->yres
);
457 if (var
->vsync_len
> 100)
458 printk(KERN_ERR
"%s: invalid vsync_len %d\n",
459 info
->fix
.id
, var
->vsync_len
);
460 if (var
->upper_margin
> 63)
461 printk(KERN_ERR
"%s: invalid upper_margin %d\n",
462 info
->fix
.id
, var
->upper_margin
);
463 if (var
->lower_margin
> 255)
464 printk(KERN_ERR
"%s: invalid lower_margin %d\n",
465 info
->fix
.id
, var
->lower_margin
);
468 writel(HCR_H_WIDTH(var
->hsync_len
) |
469 HCR_H_WAIT_1(var
->right_margin
) |
470 HCR_H_WAIT_2(var
->left_margin
),
471 fbi
->regs
+ LCDC_HCR
);
473 writel(VCR_V_WIDTH(var
->vsync_len
) |
474 VCR_V_WAIT_1(var
->lower_margin
) |
475 VCR_V_WAIT_2(var
->upper_margin
),
476 fbi
->regs
+ LCDC_VCR
);
478 writel(SIZE_XMAX(var
->xres
) | SIZE_YMAX(var
->yres
),
479 fbi
->regs
+ LCDC_SIZE
);
480 writel(fbi
->pcr
, fbi
->regs
+ LCDC_PCR
);
481 writel(fbi
->pwmr
, fbi
->regs
+ LCDC_PWMR
);
482 writel(fbi
->lscr1
, fbi
->regs
+ LCDC_LSCR1
);
483 writel(fbi
->dmacr
, fbi
->regs
+ LCDC_DMACR
);
490 * Power management hooks. Note that we won't be called from IRQ context,
491 * unlike the blank functions above, so we may sleep.
493 static int imxfb_suspend(struct platform_device
*dev
, pm_message_t state
)
495 struct imxfb_info
*fbi
= platform_get_drvdata(dev
);
497 pr_debug("%s\n", __func__
);
499 imxfb_disable_controller(fbi
);
503 static int imxfb_resume(struct platform_device
*dev
)
505 struct imxfb_info
*fbi
= platform_get_drvdata(dev
);
507 pr_debug("%s\n", __func__
);
509 imxfb_enable_controller(fbi
);
513 #define imxfb_suspend NULL
514 #define imxfb_resume NULL
517 static int __init
imxfb_init_fbinfo(struct platform_device
*pdev
)
519 struct imx_fb_platform_data
*pdata
= pdev
->dev
.platform_data
;
520 struct fb_info
*info
= dev_get_drvdata(&pdev
->dev
);
521 struct imxfb_info
*fbi
= info
->par
;
523 pr_debug("%s\n",__func__
);
525 info
->pseudo_palette
= kmalloc(sizeof(u32
) * 16, GFP_KERNEL
);
526 if (!info
->pseudo_palette
)
529 memset(fbi
, 0, sizeof(struct imxfb_info
));
531 strlcpy(info
->fix
.id
, IMX_NAME
, sizeof(info
->fix
.id
));
533 info
->fix
.type
= FB_TYPE_PACKED_PIXELS
;
534 info
->fix
.type_aux
= 0;
535 info
->fix
.xpanstep
= 0;
536 info
->fix
.ypanstep
= 0;
537 info
->fix
.ywrapstep
= 0;
538 info
->fix
.accel
= FB_ACCEL_NONE
;
540 info
->var
.nonstd
= 0;
541 info
->var
.activate
= FB_ACTIVATE_NOW
;
542 info
->var
.height
= -1;
543 info
->var
.width
= -1;
544 info
->var
.accel_flags
= 0;
545 info
->var
.vmode
= FB_VMODE_NONINTERLACED
;
547 info
->fbops
= &imxfb_ops
;
548 info
->flags
= FBINFO_FLAG_DEFAULT
|
551 fbi
->max_xres
= pdata
->xres
;
552 info
->var
.xres
= pdata
->xres
;
553 info
->var
.xres_virtual
= pdata
->xres
;
554 fbi
->max_yres
= pdata
->yres
;
555 info
->var
.yres
= pdata
->yres
;
556 info
->var
.yres_virtual
= pdata
->yres
;
557 fbi
->max_bpp
= pdata
->bpp
;
558 info
->var
.bits_per_pixel
= pdata
->bpp
;
559 info
->var
.nonstd
= pdata
->nonstd
;
560 info
->var
.pixclock
= pdata
->pixclock
;
561 info
->var
.hsync_len
= pdata
->hsync_len
;
562 info
->var
.left_margin
= pdata
->left_margin
;
563 info
->var
.right_margin
= pdata
->right_margin
;
564 info
->var
.vsync_len
= pdata
->vsync_len
;
565 info
->var
.upper_margin
= pdata
->upper_margin
;
566 info
->var
.lower_margin
= pdata
->lower_margin
;
567 info
->var
.sync
= pdata
->sync
;
568 info
->var
.grayscale
= pdata
->cmap_greyscale
;
569 fbi
->cmap_inverse
= pdata
->cmap_inverse
;
570 fbi
->cmap_static
= pdata
->cmap_static
;
571 fbi
->pcr
= pdata
->pcr
;
572 fbi
->lscr1
= pdata
->lscr1
;
573 fbi
->dmacr
= pdata
->dmacr
;
574 fbi
->pwmr
= pdata
->pwmr
;
575 fbi
->lcd_power
= pdata
->lcd_power
;
576 fbi
->backlight_power
= pdata
->backlight_power
;
577 info
->fix
.smem_len
= fbi
->max_xres
* fbi
->max_yres
*
583 static int __init
imxfb_probe(struct platform_device
*pdev
)
585 struct imxfb_info
*fbi
;
586 struct fb_info
*info
;
587 struct imx_fb_platform_data
*pdata
;
588 struct resource
*res
;
591 printk("i.MX Framebuffer driver\n");
593 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
597 pdata
= pdev
->dev
.platform_data
;
599 dev_err(&pdev
->dev
,"No platform_data available\n");
603 info
= framebuffer_alloc(sizeof(struct imxfb_info
), &pdev
->dev
);
609 platform_set_drvdata(pdev
, info
);
611 ret
= imxfb_init_fbinfo(pdev
);
615 res
= request_mem_region(res
->start
, resource_size(res
),
622 fbi
->regs
= ioremap(res
->start
, resource_size(res
));
623 if (fbi
->regs
== NULL
) {
624 printk(KERN_ERR
"Cannot map frame buffer registers\n");
628 if (!pdata
->fixed_screen_cpu
) {
629 fbi
->map_size
= PAGE_ALIGN(info
->fix
.smem_len
);
630 fbi
->map_cpu
= dma_alloc_writecombine(&pdev
->dev
,
631 fbi
->map_size
, &fbi
->map_dma
, GFP_KERNEL
);
634 dev_err(&pdev
->dev
, "Failed to allocate video RAM: %d\n", ret
);
639 info
->screen_base
= fbi
->map_cpu
;
640 fbi
->screen_cpu
= fbi
->map_cpu
;
641 fbi
->screen_dma
= fbi
->map_dma
;
642 info
->fix
.smem_start
= fbi
->screen_dma
;
644 /* Fixed framebuffer mapping enables location of the screen in eSRAM */
645 fbi
->map_cpu
= pdata
->fixed_screen_cpu
;
646 fbi
->map_dma
= pdata
->fixed_screen_dma
;
647 info
->screen_base
= fbi
->map_cpu
;
648 fbi
->screen_cpu
= fbi
->map_cpu
;
649 fbi
->screen_dma
= fbi
->map_dma
;
650 info
->fix
.smem_start
= fbi
->screen_dma
;
654 * This makes sure that our colour bitfield
655 * descriptors are correctly initialised.
657 imxfb_check_var(&info
->var
, info
);
659 ret
= fb_alloc_cmap(&info
->cmap
, 1 << info
->var
.bits_per_pixel
, 0);
664 ret
= register_framebuffer(info
);
666 dev_err(&pdev
->dev
, "failed to register framebuffer\n");
667 goto failed_register
;
670 imxfb_enable_controller(fbi
);
675 fb_dealloc_cmap(&info
->cmap
);
677 if (!pdata
->fixed_screen_cpu
)
678 dma_free_writecombine(&pdev
->dev
,fbi
->map_size
,fbi
->map_cpu
,
683 release_mem_region(res
->start
, res
->end
- res
->start
);
685 kfree(info
->pseudo_palette
);
687 platform_set_drvdata(pdev
, NULL
);
688 framebuffer_release(info
);
692 static int __devexit
imxfb_remove(struct platform_device
*pdev
)
694 struct fb_info
*info
= platform_get_drvdata(pdev
);
695 struct imxfb_info
*fbi
= info
->par
;
696 struct resource
*res
;
698 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
700 imxfb_disable_controller(fbi
);
702 unregister_framebuffer(info
);
704 fb_dealloc_cmap(&info
->cmap
);
705 kfree(info
->pseudo_palette
);
706 framebuffer_release(info
);
709 release_mem_region(res
->start
, res
->end
- res
->start
+ 1);
710 platform_set_drvdata(pdev
, NULL
);
715 void imxfb_shutdown(struct platform_device
* dev
)
717 struct fb_info
*info
= platform_get_drvdata(dev
);
718 struct imxfb_info
*fbi
= info
->par
;
719 imxfb_disable_controller(fbi
);
722 static struct platform_driver imxfb_driver
= {
723 .suspend
= imxfb_suspend
,
724 .resume
= imxfb_resume
,
725 .remove
= __devexit_p(imxfb_remove
),
726 .shutdown
= imxfb_shutdown
,
732 int __init
imxfb_init(void)
734 return platform_driver_probe(&imxfb_driver
, imxfb_probe
);
737 static void __exit
imxfb_cleanup(void)
739 platform_driver_unregister(&imxfb_driver
);
742 module_init(imxfb_init
);
743 module_exit(imxfb_cleanup
);
745 MODULE_DESCRIPTION("Motorola i.MX framebuffer driver");
746 MODULE_AUTHOR("Sascha Hauer, Pengutronix");
747 MODULE_LICENSE("GPL");