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
17 #include <linux/module.h>
18 #include <linux/kernel.h>
19 #include <linux/errno.h>
20 #include <linux/string.h>
21 #include <linux/interrupt.h>
22 #include <linux/slab.h>
25 #include <linux/delay.h>
26 #include <linux/init.h>
27 #include <linux/ioport.h>
28 #include <linux/cpufreq.h>
29 #include <linux/clk.h>
30 #include <linux/platform_device.h>
31 #include <linux/dma-mapping.h>
33 #include <linux/math64.h>
35 #include <mach/imxfb.h>
36 #include <mach/hardware.h>
39 * Complain if VAR is out of range.
43 #define DRIVER_NAME "imx-fb"
47 #define LCDC_SIZE 0x04
48 #define SIZE_XMAX(x) ((((x) >> 4) & 0x3f) << 20)
50 #ifdef CONFIG_ARCH_MX1
51 #define SIZE_YMAX(y) ((y) & 0x1ff)
53 #define SIZE_YMAX(y) ((y) & 0x3ff)
57 #define VPW_VPW(x) ((x) & 0x3ff)
59 #define LCDC_CPOS 0x0C
60 #define CPOS_CC1 (1<<31)
61 #define CPOS_CC0 (1<<30)
62 #define CPOS_OP (1<<28)
63 #define CPOS_CXP(x) (((x) & 3ff) << 16)
65 #ifdef CONFIG_ARCH_MX1
66 #define CPOS_CYP(y) ((y) & 0x1ff)
68 #define CPOS_CYP(y) ((y) & 0x3ff)
71 #define LCDC_LCWHB 0x10
72 #define LCWHB_BK_EN (1<<31)
73 #define LCWHB_CW(w) (((w) & 0x1f) << 24)
74 #define LCWHB_CH(h) (((h) & 0x1f) << 16)
75 #define LCWHB_BD(x) ((x) & 0xff)
77 #define LCDC_LCHCC 0x14
79 #ifdef CONFIG_ARCH_MX1
80 #define LCHCC_CUR_COL_R(r) (((r) & 0x1f) << 11)
81 #define LCHCC_CUR_COL_G(g) (((g) & 0x3f) << 5)
82 #define LCHCC_CUR_COL_B(b) ((b) & 0x1f)
84 #define LCHCC_CUR_COL_R(r) (((r) & 0x3f) << 12)
85 #define LCHCC_CUR_COL_G(g) (((g) & 0x3f) << 6)
86 #define LCHCC_CUR_COL_B(b) ((b) & 0x3f)
92 #define HCR_H_WIDTH(x) (((x) & 0x3f) << 26)
93 #define HCR_H_WAIT_1(x) (((x) & 0xff) << 8)
94 #define HCR_H_WAIT_2(x) ((x) & 0xff)
97 #define VCR_V_WIDTH(x) (((x) & 0x3f) << 26)
98 #define VCR_V_WAIT_1(x) (((x) & 0xff) << 8)
99 #define VCR_V_WAIT_2(x) ((x) & 0xff)
101 #define LCDC_POS 0x24
102 #define POS_POS(x) ((x) & 1f)
104 #define LCDC_LSCR1 0x28
105 /* bit fields in imxfb.h */
107 #define LCDC_PWMR 0x2C
108 /* bit fields in imxfb.h */
110 #define LCDC_DMACR 0x30
111 /* bit fields in imxfb.h */
113 #define LCDC_RMCR 0x34
115 #ifdef CONFIG_ARCH_MX1
116 #define RMCR_LCDC_EN (1<<1)
118 #define RMCR_LCDC_EN 0
121 #define RMCR_SELF_REF (1<<0)
123 #define LCDC_LCDICR 0x38
124 #define LCDICR_INT_SYN (1<<2)
125 #define LCDICR_INT_CON (1)
127 #define LCDC_LCDISR 0x40
128 #define LCDISR_UDR_ERR (1<<3)
129 #define LCDISR_ERR_RES (1<<2)
130 #define LCDISR_EOF (1<<1)
131 #define LCDISR_BOF (1<<0)
134 * These are the bitfields for each
135 * display depth that we support.
138 struct fb_bitfield red;
139 struct fb_bitfield green;
140 struct fb_bitfield blue;
141 struct fb_bitfield transp;
145 struct platform_device *pdev;
154 * These are the addresses we mapped
155 * the framebuffer memory region to.
162 dma_addr_t screen_dma;
172 u_int cmap_inverse:1,
176 void (*lcd_power)(int);
177 void (*backlight_power)(int);
180 #define IMX_NAME "IMX"
183 * Minimum X and Y resolutions
188 /* Actually this really is 18bit support, the lowest 2 bits of each colour
189 * are unused in hardware. We claim to have 24bit support to make software
190 * like X work, which does not support 18bit.
192 static struct imxfb_rgb def_rgb_18 = {
193 .red = {.offset = 16, .length = 8,},
194 .green = {.offset = 8, .length = 8,},
195 .blue = {.offset = 0, .length = 8,},
196 .transp = {.offset = 0, .length = 0,},
199 static struct imxfb_rgb def_rgb_16_tft = {
200 .red = {.offset = 11, .length = 5,},
201 .green = {.offset = 5, .length = 6,},
202 .blue = {.offset = 0, .length = 5,},
203 .transp = {.offset = 0, .length = 0,},
206 static struct imxfb_rgb def_rgb_16_stn = {
207 .red = {.offset = 8, .length = 4,},
208 .green = {.offset = 4, .length = 4,},
209 .blue = {.offset = 0, .length = 4,},
210 .transp = {.offset = 0, .length = 0,},
213 static struct imxfb_rgb def_rgb_8 = {
214 .red = {.offset = 0, .length = 8,},
215 .green = {.offset = 0, .length = 8,},
216 .blue = {.offset = 0, .length = 8,},
217 .transp = {.offset = 0, .length = 0,},
220 static int imxfb_activate_var(struct fb_var_screeninfo *var,
221 struct fb_info *info);
223 static inline u_int chan_to_field(u_int chan, struct fb_bitfield *bf)
226 chan >>= 16 - bf->length;
227 return chan << bf->offset;
230 static int imxfb_setpalettereg(u_int regno, u_int red, u_int green, u_int blue,
231 u_int trans, struct fb_info *info)
233 struct imxfb_info *fbi = info->par;
236 #define CNVT_TOHW(val,width) ((((val)<<(width))+0x7FFF-(val))>>16)
237 if (regno < fbi->palette_size) {
238 val = (CNVT_TOHW(red, 4) << 8) |
239 (CNVT_TOHW(green,4) << 4) |
242 writel(val, fbi->regs + 0x800 + (regno << 2));
248 static int imxfb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
249 u_int trans, struct fb_info *info)
251 struct imxfb_info *fbi = info->par;
256 * If inverse mode was selected, invert all the colours
257 * rather than the register number. The register number
258 * is what you poke into the framebuffer to produce the
259 * colour you requested.
261 if (fbi->cmap_inverse) {
263 green = 0xffff - green;
264 blue = 0xffff - blue;
268 * If greyscale is true, then we convert the RGB value
269 * to greyscale no mater what visual we are using.
271 if (info->var.grayscale)
272 red = green = blue = (19595 * red + 38470 * green +
275 switch (info->fix.visual) {
276 case FB_VISUAL_TRUECOLOR:
278 * 12 or 16-bit True Colour. We encode the RGB value
279 * according to the RGB bitfield information.
282 u32 *pal = info->pseudo_palette;
284 val = chan_to_field(red, &info->var.red);
285 val |= chan_to_field(green, &info->var.green);
286 val |= chan_to_field(blue, &info->var.blue);
293 case FB_VISUAL_STATIC_PSEUDOCOLOR:
294 case FB_VISUAL_PSEUDOCOLOR:
295 ret = imxfb_setpalettereg(regno, red, green, blue, trans, info);
304 * Round up in the following order: bits_per_pixel, xres,
305 * yres, xres_virtual, yres_virtual, xoffset, yoffset, grayscale,
306 * bitfields, horizontal timing, vertical timing.
308 static int imxfb_check_var(struct fb_var_screeninfo *var, struct fb_info *info)
310 struct imxfb_info *fbi = info->par;
311 struct imxfb_rgb *rgb;
313 if (var->xres < MIN_XRES)
314 var->xres = MIN_XRES;
315 if (var->yres < MIN_YRES)
316 var->yres = MIN_YRES;
317 if (var->xres > fbi->max_xres)
318 var->xres = fbi->max_xres;
319 if (var->yres > fbi->max_yres)
320 var->yres = fbi->max_yres;
321 var->xres_virtual = max(var->xres_virtual, var->xres);
322 var->yres_virtual = max(var->yres_virtual, var->yres);
324 pr_debug("var->bits_per_pixel=%d\n", var->bits_per_pixel);
325 switch (var->bits_per_pixel) {
331 if (fbi->pcr & PCR_TFT)
332 rgb = &def_rgb_16_tft;
334 rgb = &def_rgb_16_stn;
342 * Copy the RGB parameters for this display
343 * from the machine specific parameters.
346 var->green = rgb->green;
347 var->blue = rgb->blue;
348 var->transp = rgb->transp;
350 pr_debug("RGBT length = %d:%d:%d:%d\n",
351 var->red.length, var->green.length, var->blue.length,
354 pr_debug("RGBT offset = %d:%d:%d:%d\n",
355 var->red.offset, var->green.offset, var->blue.offset,
363 * Set the user defined part of the display for the specified console
365 static int imxfb_set_par(struct fb_info *info)
367 struct imxfb_info *fbi = info->par;
368 struct fb_var_screeninfo *var = &info->var;
370 if (var->bits_per_pixel == 16 || var->bits_per_pixel == 32)
371 info->fix.visual = FB_VISUAL_TRUECOLOR;
372 else if (!fbi->cmap_static)
373 info->fix.visual = FB_VISUAL_PSEUDOCOLOR;
376 * Some people have weird ideas about wanting static
377 * pseudocolor maps. I suspect their user space
378 * applications are broken.
380 info->fix.visual = FB_VISUAL_STATIC_PSEUDOCOLOR;
383 info->fix.line_length = var->xres_virtual * var->bits_per_pixel / 8;
384 fbi->palette_size = var->bits_per_pixel == 8 ? 256 : 16;
386 imxfb_activate_var(var, info);
391 static void imxfb_enable_controller(struct imxfb_info *fbi)
393 pr_debug("Enabling LCD controller\n");
395 writel(fbi->screen_dma, fbi->regs + LCDC_SSA);
397 /* physical screen start address */
398 writel(VPW_VPW(fbi->max_xres * fbi->max_bpp / 8 / 4),
399 fbi->regs + LCDC_VPW);
401 /* panning offset 0 (0 pixel offset) */
402 writel(0x00000000, fbi->regs + LCDC_POS);
404 /* disable hardware cursor */
405 writel(readl(fbi->regs + LCDC_CPOS) & ~(CPOS_CC0 | CPOS_CC1),
406 fbi->regs + LCDC_CPOS);
408 writel(RMCR_LCDC_EN, fbi->regs + LCDC_RMCR);
410 clk_enable(fbi->clk);
412 if (fbi->backlight_power)
413 fbi->backlight_power(1);
418 static void imxfb_disable_controller(struct imxfb_info *fbi)
420 pr_debug("Disabling LCD controller\n");
422 if (fbi->backlight_power)
423 fbi->backlight_power(0);
427 clk_disable(fbi->clk);
429 writel(0, fbi->regs + LCDC_RMCR);
432 static int imxfb_blank(int blank, struct fb_info *info)
434 struct imxfb_info *fbi = info->par;
436 pr_debug("imxfb_blank: blank=%d\n", blank);
439 case FB_BLANK_POWERDOWN:
440 case FB_BLANK_VSYNC_SUSPEND:
441 case FB_BLANK_HSYNC_SUSPEND:
442 case FB_BLANK_NORMAL:
443 imxfb_disable_controller(fbi);
446 case FB_BLANK_UNBLANK:
447 imxfb_enable_controller(fbi);
453 static struct fb_ops imxfb_ops = {
454 .owner = THIS_MODULE,
455 .fb_check_var = imxfb_check_var,
456 .fb_set_par = imxfb_set_par,
457 .fb_setcolreg = imxfb_setcolreg,
458 .fb_fillrect = cfb_fillrect,
459 .fb_copyarea = cfb_copyarea,
460 .fb_imageblit = cfb_imageblit,
461 .fb_blank = imxfb_blank,
465 * imxfb_activate_var():
466 * Configures LCD Controller based on entries in var parameter. Settings are
467 * only written to the controller if changes were made.
469 static int imxfb_activate_var(struct fb_var_screeninfo *var, struct fb_info *info)
471 struct imxfb_info *fbi = info->par;
472 unsigned int pcr, lcd_clk;
473 unsigned long long tmp;
475 pr_debug("var: xres=%d hslen=%d lm=%d rm=%d\n",
476 var->xres, var->hsync_len,
477 var->left_margin, var->right_margin);
478 pr_debug("var: yres=%d vslen=%d um=%d bm=%d\n",
479 var->yres, var->vsync_len,
480 var->upper_margin, var->lower_margin);
483 if (var->xres < 16 || var->xres > 1024)
484 printk(KERN_ERR "%s: invalid xres %d\n",
485 info->fix.id, var->xres);
486 if (var->hsync_len < 1 || var->hsync_len > 64)
487 printk(KERN_ERR "%s: invalid hsync_len %d\n",
488 info->fix.id, var->hsync_len);
489 if (var->left_margin > 255)
490 printk(KERN_ERR "%s: invalid left_margin %d\n",
491 info->fix.id, var->left_margin);
492 if (var->right_margin > 255)
493 printk(KERN_ERR "%s: invalid right_margin %d\n",
494 info->fix.id, var->right_margin);
495 if (var->yres < 1 || var->yres > 511)
496 printk(KERN_ERR "%s: invalid yres %d\n",
497 info->fix.id, var->yres);
498 if (var->vsync_len > 100)
499 printk(KERN_ERR "%s: invalid vsync_len %d\n",
500 info->fix.id, var->vsync_len);
501 if (var->upper_margin > 63)
502 printk(KERN_ERR "%s: invalid upper_margin %d\n",
503 info->fix.id, var->upper_margin);
504 if (var->lower_margin > 255)
505 printk(KERN_ERR "%s: invalid lower_margin %d\n",
506 info->fix.id, var->lower_margin);
509 writel(HCR_H_WIDTH(var->hsync_len - 1) |
510 HCR_H_WAIT_1(var->right_margin - 1) |
511 HCR_H_WAIT_2(var->left_margin - 3),
512 fbi->regs + LCDC_HCR);
514 writel(VCR_V_WIDTH(var->vsync_len) |
515 VCR_V_WAIT_1(var->lower_margin) |
516 VCR_V_WAIT_2(var->upper_margin),
517 fbi->regs + LCDC_VCR);
519 writel(SIZE_XMAX(var->xres) | SIZE_YMAX(var->yres),
520 fbi->regs + LCDC_SIZE);
522 lcd_clk = clk_get_rate(fbi->clk);
523 tmp = var->pixclock * (unsigned long long)lcd_clk;
524 do_div(tmp, 1000000);
525 if (do_div(tmp, 1000000) > 500000)
527 pcr = (unsigned int)tmp;
530 printk(KERN_WARNING "Must limit pixel clock to %uHz\n",
534 switch (var->bits_per_pixel) {
550 /* add sync polarities */
551 pcr |= fbi->pcr & ~(0x3f | (7 << 25));
553 writel(pcr, fbi->regs + LCDC_PCR);
554 writel(fbi->pwmr, fbi->regs + LCDC_PWMR);
555 writel(fbi->lscr1, fbi->regs + LCDC_LSCR1);
556 writel(fbi->dmacr, fbi->regs + LCDC_DMACR);
563 * Power management hooks. Note that we won't be called from IRQ context,
564 * unlike the blank functions above, so we may sleep.
566 static int imxfb_suspend(struct platform_device *dev, pm_message_t state)
568 struct imxfb_info *fbi = platform_get_drvdata(dev);
570 pr_debug("%s\n", __func__);
572 imxfb_disable_controller(fbi);
576 static int imxfb_resume(struct platform_device *dev)
578 struct imxfb_info *fbi = platform_get_drvdata(dev);
580 pr_debug("%s\n", __func__);
582 imxfb_enable_controller(fbi);
586 #define imxfb_suspend NULL
587 #define imxfb_resume NULL
590 static int __init imxfb_init_fbinfo(struct platform_device *pdev)
592 struct imx_fb_platform_data *pdata = pdev->dev.platform_data;
593 struct fb_info *info = dev_get_drvdata(&pdev->dev);
594 struct imxfb_info *fbi = info->par;
596 pr_debug("%s\n",__func__);
598 info->pseudo_palette = kmalloc(sizeof(u32) * 16, GFP_KERNEL);
599 if (!info->pseudo_palette)
602 memset(fbi, 0, sizeof(struct imxfb_info));
604 strlcpy(info->fix.id, IMX_NAME, sizeof(info->fix.id));
606 info->fix.type = FB_TYPE_PACKED_PIXELS;
607 info->fix.type_aux = 0;
608 info->fix.xpanstep = 0;
609 info->fix.ypanstep = 0;
610 info->fix.ywrapstep = 0;
611 info->fix.accel = FB_ACCEL_NONE;
613 info->var.nonstd = 0;
614 info->var.activate = FB_ACTIVATE_NOW;
615 info->var.height = -1;
616 info->var.width = -1;
617 info->var.accel_flags = 0;
618 info->var.vmode = FB_VMODE_NONINTERLACED;
620 info->fbops = &imxfb_ops;
621 info->flags = FBINFO_FLAG_DEFAULT |
624 fbi->max_xres = pdata->xres;
625 info->var.xres = pdata->xres;
626 info->var.xres_virtual = pdata->xres;
627 fbi->max_yres = pdata->yres;
628 info->var.yres = pdata->yres;
629 info->var.yres_virtual = pdata->yres;
630 fbi->max_bpp = pdata->bpp;
631 info->var.bits_per_pixel = pdata->bpp;
632 info->var.nonstd = pdata->nonstd;
633 info->var.pixclock = pdata->pixclock;
634 info->var.hsync_len = pdata->hsync_len;
635 info->var.left_margin = pdata->left_margin;
636 info->var.right_margin = pdata->right_margin;
637 info->var.vsync_len = pdata->vsync_len;
638 info->var.upper_margin = pdata->upper_margin;
639 info->var.lower_margin = pdata->lower_margin;
640 info->var.sync = pdata->sync;
641 info->var.grayscale = pdata->cmap_greyscale;
642 fbi->cmap_inverse = pdata->cmap_inverse;
643 fbi->cmap_static = pdata->cmap_static;
644 fbi->pcr = pdata->pcr;
645 fbi->lscr1 = pdata->lscr1;
646 fbi->dmacr = pdata->dmacr;
647 fbi->pwmr = pdata->pwmr;
648 fbi->lcd_power = pdata->lcd_power;
649 fbi->backlight_power = pdata->backlight_power;
650 info->fix.smem_len = fbi->max_xres * fbi->max_yres *
656 static int __init imxfb_probe(struct platform_device *pdev)
658 struct imxfb_info *fbi;
659 struct fb_info *info;
660 struct imx_fb_platform_data *pdata;
661 struct resource *res;
664 printk("i.MX Framebuffer driver\n");
666 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
670 pdata = pdev->dev.platform_data;
672 dev_err(&pdev->dev,"No platform_data available\n");
676 info = framebuffer_alloc(sizeof(struct imxfb_info), &pdev->dev);
682 platform_set_drvdata(pdev, info);
684 ret = imxfb_init_fbinfo(pdev);
688 res = request_mem_region(res->start, resource_size(res),
695 fbi->clk = clk_get(&pdev->dev, NULL);
696 if (IS_ERR(fbi->clk)) {
697 ret = PTR_ERR(fbi->clk);;
698 dev_err(&pdev->dev, "unable to get clock: %d\n", ret);
699 goto failed_getclock;
702 fbi->regs = ioremap(res->start, resource_size(res));
703 if (fbi->regs == NULL) {
704 printk(KERN_ERR"Cannot map frame buffer registers\n");
708 if (!pdata->fixed_screen_cpu) {
709 fbi->map_size = PAGE_ALIGN(info->fix.smem_len);
710 fbi->map_cpu = dma_alloc_writecombine(&pdev->dev,
711 fbi->map_size, &fbi->map_dma, GFP_KERNEL);
714 dev_err(&pdev->dev, "Failed to allocate video RAM: %d\n", ret);
719 info->screen_base = fbi->map_cpu;
720 fbi->screen_cpu = fbi->map_cpu;
721 fbi->screen_dma = fbi->map_dma;
722 info->fix.smem_start = fbi->screen_dma;
724 /* Fixed framebuffer mapping enables location of the screen in eSRAM */
725 fbi->map_cpu = pdata->fixed_screen_cpu;
726 fbi->map_dma = pdata->fixed_screen_dma;
727 info->screen_base = fbi->map_cpu;
728 fbi->screen_cpu = fbi->map_cpu;
729 fbi->screen_dma = fbi->map_dma;
730 info->fix.smem_start = fbi->screen_dma;
734 ret = pdata->init(fbi->pdev);
736 goto failed_platform_init;
740 * This makes sure that our colour bitfield
741 * descriptors are correctly initialised.
743 imxfb_check_var(&info->var, info);
745 ret = fb_alloc_cmap(&info->cmap, 1 << info->var.bits_per_pixel, 0);
750 ret = register_framebuffer(info);
752 dev_err(&pdev->dev, "failed to register framebuffer\n");
753 goto failed_register;
756 imxfb_enable_controller(fbi);
761 fb_dealloc_cmap(&info->cmap);
764 pdata->exit(fbi->pdev);
765 failed_platform_init:
766 if (!pdata->fixed_screen_cpu)
767 dma_free_writecombine(&pdev->dev,fbi->map_size,fbi->map_cpu,
774 release_mem_region(res->start, res->end - res->start);
776 kfree(info->pseudo_palette);
778 platform_set_drvdata(pdev, NULL);
779 framebuffer_release(info);
783 static int __devexit imxfb_remove(struct platform_device *pdev)
785 struct imx_fb_platform_data *pdata;
786 struct fb_info *info = platform_get_drvdata(pdev);
787 struct imxfb_info *fbi = info->par;
788 struct resource *res;
790 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
792 imxfb_disable_controller(fbi);
794 unregister_framebuffer(info);
796 pdata = pdev->dev.platform_data;
798 pdata->exit(fbi->pdev);
800 fb_dealloc_cmap(&info->cmap);
801 kfree(info->pseudo_palette);
802 framebuffer_release(info);
805 release_mem_region(res->start, res->end - res->start + 1);
806 clk_disable(fbi->clk);
809 platform_set_drvdata(pdev, NULL);
814 void imxfb_shutdown(struct platform_device * dev)
816 struct fb_info *info = platform_get_drvdata(dev);
817 struct imxfb_info *fbi = info->par;
818 imxfb_disable_controller(fbi);
821 static struct platform_driver imxfb_driver = {
822 .suspend = imxfb_suspend,
823 .resume = imxfb_resume,
824 .remove = __devexit_p(imxfb_remove),
825 .shutdown = imxfb_shutdown,
831 int __init imxfb_init(void)
833 return platform_driver_probe(&imxfb_driver, imxfb_probe);
836 static void __exit imxfb_cleanup(void)
838 platform_driver_unregister(&imxfb_driver);
841 module_init(imxfb_init);
842 module_exit(imxfb_cleanup);
844 MODULE_DESCRIPTION("Motorola i.MX framebuffer driver");
845 MODULE_AUTHOR("Sascha Hauer, Pengutronix");
846 MODULE_LICENSE("GPL");