2 * Copyright (C) 2009-2010, Lars-Peter Clausen <lars@metafoo.de>
3 * JZ4740 SoC LCD framebuffer driver
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version.
10 * You should have received a copy of the GNU General Public License along
11 * with this program; if not, write to the Free Software Foundation, Inc.,
12 * 675 Mass Ave, Cambridge, MA 02139, USA.
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/mutex.h>
19 #include <linux/platform_device.h>
20 #include <linux/pinctrl/consumer.h>
22 #include <linux/clk.h>
23 #include <linux/delay.h>
25 #include <linux/console.h>
28 #include <linux/dma-mapping.h>
30 #include <asm/mach-jz4740/jz4740_fb.h>
32 #define JZ_REG_LCD_CFG 0x00
33 #define JZ_REG_LCD_VSYNC 0x04
34 #define JZ_REG_LCD_HSYNC 0x08
35 #define JZ_REG_LCD_VAT 0x0C
36 #define JZ_REG_LCD_DAH 0x10
37 #define JZ_REG_LCD_DAV 0x14
38 #define JZ_REG_LCD_PS 0x18
39 #define JZ_REG_LCD_CLS 0x1C
40 #define JZ_REG_LCD_SPL 0x20
41 #define JZ_REG_LCD_REV 0x24
42 #define JZ_REG_LCD_CTRL 0x30
43 #define JZ_REG_LCD_STATE 0x34
44 #define JZ_REG_LCD_IID 0x38
45 #define JZ_REG_LCD_DA0 0x40
46 #define JZ_REG_LCD_SA0 0x44
47 #define JZ_REG_LCD_FID0 0x48
48 #define JZ_REG_LCD_CMD0 0x4C
49 #define JZ_REG_LCD_DA1 0x50
50 #define JZ_REG_LCD_SA1 0x54
51 #define JZ_REG_LCD_FID1 0x58
52 #define JZ_REG_LCD_CMD1 0x5C
54 #define JZ_LCD_CFG_SLCD BIT(31)
55 #define JZ_LCD_CFG_PS_DISABLE BIT(23)
56 #define JZ_LCD_CFG_CLS_DISABLE BIT(22)
57 #define JZ_LCD_CFG_SPL_DISABLE BIT(21)
58 #define JZ_LCD_CFG_REV_DISABLE BIT(20)
59 #define JZ_LCD_CFG_HSYNCM BIT(19)
60 #define JZ_LCD_CFG_PCLKM BIT(18)
61 #define JZ_LCD_CFG_INV BIT(17)
62 #define JZ_LCD_CFG_SYNC_DIR BIT(16)
63 #define JZ_LCD_CFG_PS_POLARITY BIT(15)
64 #define JZ_LCD_CFG_CLS_POLARITY BIT(14)
65 #define JZ_LCD_CFG_SPL_POLARITY BIT(13)
66 #define JZ_LCD_CFG_REV_POLARITY BIT(12)
67 #define JZ_LCD_CFG_HSYNC_ACTIVE_LOW BIT(11)
68 #define JZ_LCD_CFG_PCLK_FALLING_EDGE BIT(10)
69 #define JZ_LCD_CFG_DE_ACTIVE_LOW BIT(9)
70 #define JZ_LCD_CFG_VSYNC_ACTIVE_LOW BIT(8)
71 #define JZ_LCD_CFG_18_BIT BIT(7)
72 #define JZ_LCD_CFG_PDW (BIT(5) | BIT(4))
73 #define JZ_LCD_CFG_MODE_MASK 0xf
75 #define JZ_LCD_CTRL_BURST_4 (0x0 << 28)
76 #define JZ_LCD_CTRL_BURST_8 (0x1 << 28)
77 #define JZ_LCD_CTRL_BURST_16 (0x2 << 28)
78 #define JZ_LCD_CTRL_RGB555 BIT(27)
79 #define JZ_LCD_CTRL_OFUP BIT(26)
80 #define JZ_LCD_CTRL_FRC_GRAYSCALE_16 (0x0 << 24)
81 #define JZ_LCD_CTRL_FRC_GRAYSCALE_4 (0x1 << 24)
82 #define JZ_LCD_CTRL_FRC_GRAYSCALE_2 (0x2 << 24)
83 #define JZ_LCD_CTRL_PDD_MASK (0xff << 16)
84 #define JZ_LCD_CTRL_EOF_IRQ BIT(13)
85 #define JZ_LCD_CTRL_SOF_IRQ BIT(12)
86 #define JZ_LCD_CTRL_OFU_IRQ BIT(11)
87 #define JZ_LCD_CTRL_IFU0_IRQ BIT(10)
88 #define JZ_LCD_CTRL_IFU1_IRQ BIT(9)
89 #define JZ_LCD_CTRL_DD_IRQ BIT(8)
90 #define JZ_LCD_CTRL_QDD_IRQ BIT(7)
91 #define JZ_LCD_CTRL_REVERSE_ENDIAN BIT(6)
92 #define JZ_LCD_CTRL_LSB_FISRT BIT(5)
93 #define JZ_LCD_CTRL_DISABLE BIT(4)
94 #define JZ_LCD_CTRL_ENABLE BIT(3)
95 #define JZ_LCD_CTRL_BPP_1 0x0
96 #define JZ_LCD_CTRL_BPP_2 0x1
97 #define JZ_LCD_CTRL_BPP_4 0x2
98 #define JZ_LCD_CTRL_BPP_8 0x3
99 #define JZ_LCD_CTRL_BPP_15_16 0x4
100 #define JZ_LCD_CTRL_BPP_18_24 0x5
102 #define JZ_LCD_CMD_SOF_IRQ BIT(31)
103 #define JZ_LCD_CMD_EOF_IRQ BIT(30)
104 #define JZ_LCD_CMD_ENABLE_PAL BIT(28)
106 #define JZ_LCD_SYNC_MASK 0x3ff
108 #define JZ_LCD_STATE_DISABLED BIT(0)
110 struct jzfb_framedesc {
119 struct platform_device *pdev;
121 struct resource *mem;
122 struct jz4740_fb_platform_data *pdata;
126 dma_addr_t vidmem_phys;
127 struct jzfb_framedesc *framedesc;
128 dma_addr_t framedesc_phys;
133 unsigned is_enabled:1;
136 uint32_t pseudo_palette[16];
139 static const struct fb_fix_screeninfo jzfb_fix = {
141 .type = FB_TYPE_PACKED_PIXELS,
142 .visual = FB_VISUAL_TRUECOLOR,
146 .accel = FB_ACCEL_NONE,
149 /* Based on CNVT_TOHW macro from skeletonfb.c */
150 static inline uint32_t jzfb_convert_color_to_hw(unsigned val,
151 struct fb_bitfield *bf)
153 return (((val << bf->length) + 0x7FFF - val) >> 16) << bf->offset;
156 static int jzfb_setcolreg(unsigned regno, unsigned red, unsigned green,
157 unsigned blue, unsigned transp, struct fb_info *fb)
164 color = jzfb_convert_color_to_hw(red, &fb->var.red);
165 color |= jzfb_convert_color_to_hw(green, &fb->var.green);
166 color |= jzfb_convert_color_to_hw(blue, &fb->var.blue);
167 color |= jzfb_convert_color_to_hw(transp, &fb->var.transp);
169 ((uint32_t *)(fb->pseudo_palette))[regno] = color;
174 static int jzfb_get_controller_bpp(struct jzfb *jzfb)
176 switch (jzfb->pdata->bpp) {
183 return jzfb->pdata->bpp;
187 static struct fb_videomode *jzfb_get_mode(struct jzfb *jzfb,
188 struct fb_var_screeninfo *var)
191 struct fb_videomode *mode = jzfb->pdata->modes;
193 for (i = 0; i < jzfb->pdata->num_modes; ++i, ++mode) {
194 if (mode->xres == var->xres && mode->yres == var->yres)
201 static int jzfb_check_var(struct fb_var_screeninfo *var, struct fb_info *fb)
203 struct jzfb *jzfb = fb->par;
204 struct fb_videomode *mode;
206 if (var->bits_per_pixel != jzfb_get_controller_bpp(jzfb) &&
207 var->bits_per_pixel != jzfb->pdata->bpp)
210 mode = jzfb_get_mode(jzfb, var);
214 fb_videomode_to_var(var, mode);
216 switch (jzfb->pdata->bpp) {
220 var->red.offset = 10;
222 var->green.offset = 6;
223 var->green.length = 5;
224 var->blue.offset = 0;
225 var->blue.length = 5;
228 var->red.offset = 11;
230 var->green.offset = 5;
231 var->green.length = 6;
232 var->blue.offset = 0;
233 var->blue.length = 5;
236 var->red.offset = 16;
238 var->green.offset = 8;
239 var->green.length = 6;
240 var->blue.offset = 0;
241 var->blue.length = 6;
242 var->bits_per_pixel = 32;
246 var->transp.offset = 24;
247 var->transp.length = 8;
248 var->red.offset = 16;
250 var->green.offset = 8;
251 var->green.length = 8;
252 var->blue.offset = 0;
253 var->blue.length = 8;
254 var->bits_per_pixel = 32;
263 static int jzfb_set_par(struct fb_info *info)
265 struct jzfb *jzfb = info->par;
266 struct jz4740_fb_platform_data *pdata = jzfb->pdata;
267 struct fb_var_screeninfo *var = &info->var;
268 struct fb_videomode *mode;
276 mode = jzfb_get_mode(jzfb, var);
280 if (mode == info->mode)
285 hds = mode->hsync_len + mode->left_margin;
286 hde = hds + mode->xres;
287 ht = hde + mode->right_margin;
289 vds = mode->vsync_len + mode->upper_margin;
290 vde = vds + mode->yres;
291 vt = vde + mode->lower_margin;
293 ctrl = JZ_LCD_CTRL_OFUP | JZ_LCD_CTRL_BURST_16;
295 switch (pdata->bpp) {
297 ctrl |= JZ_LCD_CTRL_BPP_1;
300 ctrl |= JZ_LCD_CTRL_BPP_2;
303 ctrl |= JZ_LCD_CTRL_BPP_4;
306 ctrl |= JZ_LCD_CTRL_BPP_8;
309 ctrl |= JZ_LCD_CTRL_RGB555; /* Falltrough */
311 ctrl |= JZ_LCD_CTRL_BPP_15_16;
316 ctrl |= JZ_LCD_CTRL_BPP_18_24;
322 cfg = pdata->lcd_type & 0xf;
324 if (!(mode->sync & FB_SYNC_HOR_HIGH_ACT))
325 cfg |= JZ_LCD_CFG_HSYNC_ACTIVE_LOW;
327 if (!(mode->sync & FB_SYNC_VERT_HIGH_ACT))
328 cfg |= JZ_LCD_CFG_VSYNC_ACTIVE_LOW;
330 if (pdata->pixclk_falling_edge)
331 cfg |= JZ_LCD_CFG_PCLK_FALLING_EDGE;
333 if (pdata->date_enable_active_low)
334 cfg |= JZ_LCD_CFG_DE_ACTIVE_LOW;
336 if (pdata->lcd_type == JZ_LCD_TYPE_GENERIC_18_BIT)
337 cfg |= JZ_LCD_CFG_18_BIT;
339 if (mode->pixclock) {
340 rate = PICOS2KHZ(mode->pixclock) * 1000;
341 mode->refresh = rate / vt / ht;
343 if (pdata->lcd_type == JZ_LCD_TYPE_8BIT_SERIAL)
344 rate = mode->refresh * (vt + 2 * mode->xres) * ht;
346 rate = mode->refresh * vt * ht;
348 mode->pixclock = KHZ2PICOS(rate / 1000);
351 mutex_lock(&jzfb->lock);
352 if (!jzfb->is_enabled)
353 clk_enable(jzfb->ldclk);
355 ctrl |= JZ_LCD_CTRL_ENABLE;
357 switch (pdata->lcd_type) {
358 case JZ_LCD_TYPE_SPECIAL_TFT_1:
359 case JZ_LCD_TYPE_SPECIAL_TFT_2:
360 case JZ_LCD_TYPE_SPECIAL_TFT_3:
361 writel(pdata->special_tft_config.spl, jzfb->base + JZ_REG_LCD_SPL);
362 writel(pdata->special_tft_config.cls, jzfb->base + JZ_REG_LCD_CLS);
363 writel(pdata->special_tft_config.ps, jzfb->base + JZ_REG_LCD_PS);
364 writel(pdata->special_tft_config.ps, jzfb->base + JZ_REG_LCD_REV);
367 cfg |= JZ_LCD_CFG_PS_DISABLE;
368 cfg |= JZ_LCD_CFG_CLS_DISABLE;
369 cfg |= JZ_LCD_CFG_SPL_DISABLE;
370 cfg |= JZ_LCD_CFG_REV_DISABLE;
374 writel(mode->hsync_len, jzfb->base + JZ_REG_LCD_HSYNC);
375 writel(mode->vsync_len, jzfb->base + JZ_REG_LCD_VSYNC);
377 writel((ht << 16) | vt, jzfb->base + JZ_REG_LCD_VAT);
379 writel((hds << 16) | hde, jzfb->base + JZ_REG_LCD_DAH);
380 writel((vds << 16) | vde, jzfb->base + JZ_REG_LCD_DAV);
382 writel(cfg, jzfb->base + JZ_REG_LCD_CFG);
384 writel(ctrl, jzfb->base + JZ_REG_LCD_CTRL);
386 if (!jzfb->is_enabled)
387 clk_disable_unprepare(jzfb->ldclk);
389 mutex_unlock(&jzfb->lock);
391 clk_set_rate(jzfb->lpclk, rate);
392 clk_set_rate(jzfb->ldclk, rate * 3);
397 static void jzfb_enable(struct jzfb *jzfb)
401 clk_prepare_enable(jzfb->ldclk);
403 pinctrl_pm_select_default_state(&jzfb->pdev->dev);
405 writel(0, jzfb->base + JZ_REG_LCD_STATE);
407 writel(jzfb->framedesc->next, jzfb->base + JZ_REG_LCD_DA0);
409 ctrl = readl(jzfb->base + JZ_REG_LCD_CTRL);
410 ctrl |= JZ_LCD_CTRL_ENABLE;
411 ctrl &= ~JZ_LCD_CTRL_DISABLE;
412 writel(ctrl, jzfb->base + JZ_REG_LCD_CTRL);
415 static void jzfb_disable(struct jzfb *jzfb)
419 ctrl = readl(jzfb->base + JZ_REG_LCD_CTRL);
420 ctrl |= JZ_LCD_CTRL_DISABLE;
421 writel(ctrl, jzfb->base + JZ_REG_LCD_CTRL);
423 ctrl = readl(jzfb->base + JZ_REG_LCD_STATE);
424 } while (!(ctrl & JZ_LCD_STATE_DISABLED));
426 pinctrl_pm_select_sleep_state(&jzfb->pdev->dev);
428 clk_disable_unprepare(jzfb->ldclk);
431 static int jzfb_blank(int blank_mode, struct fb_info *info)
433 struct jzfb *jzfb = info->par;
435 switch (blank_mode) {
436 case FB_BLANK_UNBLANK:
437 mutex_lock(&jzfb->lock);
438 if (jzfb->is_enabled) {
439 mutex_unlock(&jzfb->lock);
444 jzfb->is_enabled = 1;
446 mutex_unlock(&jzfb->lock);
449 mutex_lock(&jzfb->lock);
450 if (!jzfb->is_enabled) {
451 mutex_unlock(&jzfb->lock);
456 jzfb->is_enabled = 0;
458 mutex_unlock(&jzfb->lock);
465 static int jzfb_alloc_devmem(struct jzfb *jzfb)
467 int max_videosize = 0;
468 struct fb_videomode *mode = jzfb->pdata->modes;
472 for (i = 0; i < jzfb->pdata->num_modes; ++mode, ++i) {
473 if (max_videosize < mode->xres * mode->yres)
474 max_videosize = mode->xres * mode->yres;
477 max_videosize *= jzfb_get_controller_bpp(jzfb) >> 3;
479 jzfb->framedesc = dma_alloc_coherent(&jzfb->pdev->dev,
480 sizeof(*jzfb->framedesc),
481 &jzfb->framedesc_phys, GFP_KERNEL);
483 if (!jzfb->framedesc)
486 jzfb->vidmem_size = PAGE_ALIGN(max_videosize);
487 jzfb->vidmem = dma_alloc_coherent(&jzfb->pdev->dev,
489 &jzfb->vidmem_phys, GFP_KERNEL);
492 goto err_free_framedesc;
494 for (page = jzfb->vidmem;
495 page < jzfb->vidmem + PAGE_ALIGN(jzfb->vidmem_size);
497 SetPageReserved(virt_to_page(page));
500 jzfb->framedesc->next = jzfb->framedesc_phys;
501 jzfb->framedesc->addr = jzfb->vidmem_phys;
502 jzfb->framedesc->id = 0xdeafbead;
503 jzfb->framedesc->cmd = 0;
504 jzfb->framedesc->cmd |= max_videosize / 4;
509 dma_free_coherent(&jzfb->pdev->dev, sizeof(*jzfb->framedesc),
510 jzfb->framedesc, jzfb->framedesc_phys);
514 static void jzfb_free_devmem(struct jzfb *jzfb)
516 dma_free_coherent(&jzfb->pdev->dev, jzfb->vidmem_size,
517 jzfb->vidmem, jzfb->vidmem_phys);
518 dma_free_coherent(&jzfb->pdev->dev, sizeof(*jzfb->framedesc),
519 jzfb->framedesc, jzfb->framedesc_phys);
522 static struct fb_ops jzfb_ops = {
523 .owner = THIS_MODULE,
524 .fb_check_var = jzfb_check_var,
525 .fb_set_par = jzfb_set_par,
526 .fb_blank = jzfb_blank,
527 .fb_fillrect = sys_fillrect,
528 .fb_copyarea = sys_copyarea,
529 .fb_imageblit = sys_imageblit,
530 .fb_setcolreg = jzfb_setcolreg,
533 static int jzfb_probe(struct platform_device *pdev)
538 struct jz4740_fb_platform_data *pdata = pdev->dev.platform_data;
539 struct resource *mem;
542 dev_err(&pdev->dev, "Missing platform data\n");
546 fb = framebuffer_alloc(sizeof(struct jzfb), &pdev->dev);
548 dev_err(&pdev->dev, "Failed to allocate framebuffer device\n");
552 fb->fbops = &jzfb_ops;
553 fb->flags = FBINFO_DEFAULT;
559 jzfb->ldclk = devm_clk_get(&pdev->dev, "lcd");
560 if (IS_ERR(jzfb->ldclk)) {
561 ret = PTR_ERR(jzfb->ldclk);
562 dev_err(&pdev->dev, "Failed to get lcd clock: %d\n", ret);
563 goto err_framebuffer_release;
566 jzfb->lpclk = devm_clk_get(&pdev->dev, "lcd_pclk");
567 if (IS_ERR(jzfb->lpclk)) {
568 ret = PTR_ERR(jzfb->lpclk);
569 dev_err(&pdev->dev, "Failed to get lcd pixel clock: %d\n", ret);
570 goto err_framebuffer_release;
573 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
574 jzfb->base = devm_ioremap_resource(&pdev->dev, mem);
575 if (IS_ERR(jzfb->base)) {
576 ret = PTR_ERR(jzfb->base);
577 goto err_framebuffer_release;
580 platform_set_drvdata(pdev, jzfb);
582 mutex_init(&jzfb->lock);
584 fb_videomode_to_modelist(pdata->modes, pdata->num_modes,
586 fb_videomode_to_var(&fb->var, pdata->modes);
587 fb->var.bits_per_pixel = pdata->bpp;
588 jzfb_check_var(&fb->var, fb);
590 ret = jzfb_alloc_devmem(jzfb);
592 dev_err(&pdev->dev, "Failed to allocate video memory\n");
593 goto err_framebuffer_release;
597 fb->fix.line_length = fb->var.bits_per_pixel * fb->var.xres / 8;
598 fb->fix.mmio_start = mem->start;
599 fb->fix.mmio_len = resource_size(mem);
600 fb->fix.smem_start = jzfb->vidmem_phys;
601 fb->fix.smem_len = fb->fix.line_length * fb->var.yres;
602 fb->screen_base = jzfb->vidmem;
603 fb->pseudo_palette = jzfb->pseudo_palette;
605 fb_alloc_cmap(&fb->cmap, 256, 0);
607 clk_prepare_enable(jzfb->ldclk);
608 jzfb->is_enabled = 1;
610 writel(jzfb->framedesc->next, jzfb->base + JZ_REG_LCD_DA0);
615 ret = register_framebuffer(fb);
617 dev_err(&pdev->dev, "Failed to register framebuffer: %d\n", ret);
618 goto err_free_devmem;
626 fb_dealloc_cmap(&fb->cmap);
627 jzfb_free_devmem(jzfb);
628 err_framebuffer_release:
629 framebuffer_release(fb);
633 static int jzfb_remove(struct platform_device *pdev)
635 struct jzfb *jzfb = platform_get_drvdata(pdev);
637 jzfb_blank(FB_BLANK_POWERDOWN, jzfb->fb);
639 fb_dealloc_cmap(&jzfb->fb->cmap);
640 jzfb_free_devmem(jzfb);
642 framebuffer_release(jzfb->fb);
649 static int jzfb_suspend(struct device *dev)
651 struct jzfb *jzfb = dev_get_drvdata(dev);
654 fb_set_suspend(jzfb->fb, 1);
657 mutex_lock(&jzfb->lock);
658 if (jzfb->is_enabled)
660 mutex_unlock(&jzfb->lock);
665 static int jzfb_resume(struct device *dev)
667 struct jzfb *jzfb = dev_get_drvdata(dev);
668 clk_prepare_enable(jzfb->ldclk);
670 mutex_lock(&jzfb->lock);
671 if (jzfb->is_enabled)
673 mutex_unlock(&jzfb->lock);
676 fb_set_suspend(jzfb->fb, 0);
682 static const struct dev_pm_ops jzfb_pm_ops = {
683 .suspend = jzfb_suspend,
684 .resume = jzfb_resume,
685 .poweroff = jzfb_suspend,
686 .restore = jzfb_resume,
689 #define JZFB_PM_OPS (&jzfb_pm_ops)
692 #define JZFB_PM_OPS NULL
695 static struct platform_driver jzfb_driver = {
697 .remove = jzfb_remove,
703 module_platform_driver(jzfb_driver);
705 MODULE_LICENSE("GPL");
706 MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
707 MODULE_DESCRIPTION("JZ4740 SoC LCD framebuffer driver");
708 MODULE_ALIAS("platform:jz4740-fb");