2 * SuperH Mobile LCDC Framebuffer
4 * Copyright (c) 2008 Magnus Damm
6 * This file is subject to the terms and conditions of the GNU General Public
7 * License. See the file "COPYING" in the main directory of this archive
11 #include <linux/kernel.h>
12 #include <linux/init.h>
13 #include <linux/delay.h>
16 #include <linux/clk.h>
17 #include <linux/platform_device.h>
18 #include <linux/dma-mapping.h>
19 #include <asm/sh_mobile_lcdc.h>
23 struct sh_mobile_lcdc_priv;
24 struct sh_mobile_lcdc_chan {
25 struct sh_mobile_lcdc_priv *lcdc;
26 unsigned long *reg_offs;
27 unsigned long ldmt1r_value;
28 unsigned long enabled; /* ME and SE in LDCNT2R */
29 struct sh_mobile_lcdc_chan_cfg cfg;
30 u32 pseudo_palette[PALETTE_NR];
32 dma_addr_t dma_handle;
35 struct sh_mobile_lcdc_priv {
39 struct sh_mobile_lcdc_chan ch[2];
42 /* shared registers */
44 #define _LDDCKSTPR 0x414
47 #define _LDCNT1R 0x470
48 #define _LDCNT2R 0x474
50 #define _LDDWD0R 0x800
55 /* per-channel registers */
56 enum { LDDCKPAT1R, LDDCKPAT2R, LDMT1R, LDMT2R, LDMT3R, LDDFR, LDSM1R,
57 LDSA1R, LDMLSR, LDHCNR, LDHSYNR, LDVLNR, LDVSYNR, LDPMR };
59 static unsigned long lcdc_offs_mainlcd[] = {
76 static unsigned long lcdc_offs_sublcd[] = {
93 #define START_LCDC 0x00000001
94 #define LCDC_RESET 0x00000100
95 #define DISPLAY_BEU 0x00000008
96 #define LCDC_ENABLE 0x00000001
98 static void lcdc_write_chan(struct sh_mobile_lcdc_chan *chan,
99 int reg_nr, unsigned long data)
101 iowrite32(data, chan->lcdc->base + chan->reg_offs[reg_nr]);
104 static unsigned long lcdc_read_chan(struct sh_mobile_lcdc_chan *chan,
107 return ioread32(chan->lcdc->base + chan->reg_offs[reg_nr]);
110 static void lcdc_write(struct sh_mobile_lcdc_priv *priv,
111 unsigned long reg_offs, unsigned long data)
113 iowrite32(data, priv->base + reg_offs);
116 static unsigned long lcdc_read(struct sh_mobile_lcdc_priv *priv,
117 unsigned long reg_offs)
119 return ioread32(priv->base + reg_offs);
122 static void lcdc_wait_bit(struct sh_mobile_lcdc_priv *priv,
123 unsigned long reg_offs,
124 unsigned long mask, unsigned long until)
126 while ((lcdc_read(priv, reg_offs) & mask) != until)
130 static int lcdc_chan_is_sublcd(struct sh_mobile_lcdc_chan *chan)
132 return chan->cfg.chan == LCDC_CHAN_SUBLCD;
135 static void lcdc_sys_write_index(void *handle, unsigned long data)
137 struct sh_mobile_lcdc_chan *ch = handle;
139 lcdc_write(ch->lcdc, _LDDWD0R, data | 0x10000000);
140 lcdc_wait_bit(ch->lcdc, _LDSR, 2, 0);
141 lcdc_write(ch->lcdc, _LDDWAR, 1 | (lcdc_chan_is_sublcd(ch) ? 2 : 0));
144 static void lcdc_sys_write_data(void *handle, unsigned long data)
146 struct sh_mobile_lcdc_chan *ch = handle;
148 lcdc_write(ch->lcdc, _LDDWD0R, data | 0x11000000);
149 lcdc_wait_bit(ch->lcdc, _LDSR, 2, 0);
150 lcdc_write(ch->lcdc, _LDDWAR, 1 | (lcdc_chan_is_sublcd(ch) ? 2 : 0));
153 static unsigned long lcdc_sys_read_data(void *handle)
155 struct sh_mobile_lcdc_chan *ch = handle;
157 lcdc_write(ch->lcdc, _LDDRDR, 0x01000000);
158 lcdc_wait_bit(ch->lcdc, _LDSR, 2, 0);
159 lcdc_write(ch->lcdc, _LDDRAR, 1 | (lcdc_chan_is_sublcd(ch) ? 2 : 0));
162 return lcdc_read(ch->lcdc, _LDDRDR) & 0xffff;
165 struct sh_mobile_lcdc_sys_bus_ops sh_mobile_lcdc_sys_bus_ops = {
166 lcdc_sys_write_index,
171 static void sh_mobile_lcdc_start_stop(struct sh_mobile_lcdc_priv *priv,
174 unsigned long tmp = lcdc_read(priv, _LDCNT2R);
177 /* start or stop the lcdc */
179 lcdc_write(priv, _LDCNT2R, tmp | START_LCDC);
181 lcdc_write(priv, _LDCNT2R, tmp & ~START_LCDC);
183 /* wait until power is applied/stopped on all channels */
184 for (k = 0; k < ARRAY_SIZE(priv->ch); k++)
185 if (lcdc_read(priv, _LDCNT2R) & priv->ch[k].enabled)
187 tmp = lcdc_read_chan(&priv->ch[k], LDPMR) & 3;
188 if (start && tmp == 3)
190 if (!start && tmp == 0)
196 lcdc_write(priv, _LDDCKSTPR, 1); /* stop dotclock */
199 static int sh_mobile_lcdc_start(struct sh_mobile_lcdc_priv *priv)
201 struct sh_mobile_lcdc_chan *ch;
202 struct fb_videomode *lcd_cfg;
203 struct sh_mobile_lcdc_board_cfg *board_cfg;
209 lcdc_write(priv, _LDCNT2R, lcdc_read(priv, _LDCNT2R) | LCDC_RESET);
210 lcdc_wait_bit(priv, _LDCNT2R, LCDC_RESET, 0);
212 /* enable LCDC channels */
213 tmp = lcdc_read(priv, _LDCNT2R);
214 tmp |= priv->ch[0].enabled;
215 tmp |= priv->ch[1].enabled;
216 lcdc_write(priv, _LDCNT2R, tmp);
218 /* read data from external memory, avoid using the BEU for now */
219 lcdc_write(priv, _LDCNT2R, lcdc_read(priv, _LDCNT2R) & ~DISPLAY_BEU);
221 /* stop the lcdc first */
222 sh_mobile_lcdc_start_stop(priv, 0);
224 /* configure clocks */
226 for (k = 0; k < ARRAY_SIZE(priv->ch); k++) {
229 if (!priv->ch[k].enabled)
232 m = ch->cfg.clock_divider;
238 tmp |= m << (lcdc_chan_is_sublcd(ch) ? 8 : 0);
240 lcdc_write_chan(ch, LDDCKPAT1R, 0x00000000);
241 lcdc_write_chan(ch, LDDCKPAT2R, (1 << (m/2)) - 1);
244 lcdc_write(priv, _LDDCKR, tmp);
246 /* start dotclock again */
247 lcdc_write(priv, _LDDCKSTPR, 0);
248 lcdc_wait_bit(priv, _LDDCKSTPR, ~0, 0);
250 /* interrupts are disabled */
251 lcdc_write(priv, _LDINTR, 0);
253 for (k = 0; k < ARRAY_SIZE(priv->ch); k++) {
255 lcd_cfg = &ch->cfg.lcd_cfg;
260 tmp = ch->ldmt1r_value;
261 tmp |= (lcd_cfg->sync & FB_SYNC_VERT_HIGH_ACT) ? 0 : 1 << 28;
262 tmp |= (lcd_cfg->sync & FB_SYNC_HOR_HIGH_ACT) ? 0 : 1 << 27;
263 lcdc_write_chan(ch, LDMT1R, tmp);
266 lcdc_write_chan(ch, LDMT2R, ch->cfg.sys_bus_cfg.ldmt2r);
267 lcdc_write_chan(ch, LDMT3R, ch->cfg.sys_bus_cfg.ldmt3r);
269 /* horizontal configuration */
270 tmp = lcd_cfg->xres + lcd_cfg->hsync_len;
271 tmp += lcd_cfg->left_margin;
272 tmp += lcd_cfg->right_margin;
274 tmp |= (lcd_cfg->xres / 8) << 16; /* HDCN */
275 lcdc_write_chan(ch, LDHCNR, tmp);
278 tmp += lcd_cfg->right_margin;
279 tmp /= 8; /* HSYNP */
280 tmp |= (lcd_cfg->hsync_len / 8) << 16; /* HSYNW */
281 lcdc_write_chan(ch, LDHSYNR, tmp);
284 lcdc_write_chan(ch, LDPMR, 0);
286 /* vertical configuration */
287 tmp = lcd_cfg->yres + lcd_cfg->vsync_len;
288 tmp += lcd_cfg->upper_margin;
289 tmp += lcd_cfg->lower_margin; /* VTLN */
290 tmp |= lcd_cfg->yres << 16; /* VDLN */
291 lcdc_write_chan(ch, LDVLNR, tmp);
294 tmp += lcd_cfg->lower_margin; /* VSYNP */
295 tmp |= lcd_cfg->vsync_len << 16; /* VSYNW */
296 lcdc_write_chan(ch, LDVSYNR, tmp);
298 board_cfg = &ch->cfg.board_cfg;
299 if (board_cfg->setup_sys)
300 ret = board_cfg->setup_sys(board_cfg->board_data, ch,
301 &sh_mobile_lcdc_sys_bus_ops);
306 /* --- display_lcdc_data() --- */
307 lcdc_write(priv, _LDINTR, 0x00000f00);
309 /* word and long word swap */
310 lcdc_write(priv, _LDDDSR, lcdc_read(priv, _LDDDSR) | 6);
312 for (k = 0; k < ARRAY_SIZE(priv->ch); k++) {
315 if (!priv->ch[k].enabled)
318 /* set bpp format in PKF[4:0] */
319 tmp = lcdc_read_chan(ch, LDDFR);
320 tmp &= ~(0x0001001f);
321 tmp |= (priv->ch[k].info.var.bits_per_pixel == 16) ? 3 : 0;
322 lcdc_write_chan(ch, LDDFR, tmp);
324 /* point out our frame buffer */
325 lcdc_write_chan(ch, LDSA1R, ch->info.fix.smem_start);
328 lcdc_write_chan(ch, LDMLSR, ch->info.fix.line_length);
330 /* continuous read mode */
331 lcdc_write_chan(ch, LDSM1R, 0);
335 lcdc_write(priv, _LDCNT1R, LCDC_ENABLE);
338 sh_mobile_lcdc_start_stop(priv, 1);
340 /* tell the board code to enable the panel */
341 for (k = 0; k < ARRAY_SIZE(priv->ch); k++) {
343 board_cfg = &ch->cfg.board_cfg;
344 if (board_cfg->display_on)
345 board_cfg->display_on(board_cfg->board_data);
351 static void sh_mobile_lcdc_stop(struct sh_mobile_lcdc_priv *priv)
353 struct sh_mobile_lcdc_chan *ch;
354 struct sh_mobile_lcdc_board_cfg *board_cfg;
357 /* tell the board code to disable the panel */
358 for (k = 0; k < ARRAY_SIZE(priv->ch); k++) {
360 board_cfg = &ch->cfg.board_cfg;
361 if (board_cfg->display_off)
362 board_cfg->display_off(board_cfg->board_data);
366 sh_mobile_lcdc_start_stop(priv, 0);
369 static int sh_mobile_lcdc_check_interface(struct sh_mobile_lcdc_chan *ch)
373 switch (ch->cfg.interface_type) {
374 case RGB8: ifm = 0; miftyp = 0; break;
375 case RGB9: ifm = 0; miftyp = 4; break;
376 case RGB12A: ifm = 0; miftyp = 5; break;
377 case RGB12B: ifm = 0; miftyp = 6; break;
378 case RGB16: ifm = 0; miftyp = 7; break;
379 case RGB18: ifm = 0; miftyp = 10; break;
380 case RGB24: ifm = 0; miftyp = 11; break;
381 case SYS8A: ifm = 1; miftyp = 0; break;
382 case SYS8B: ifm = 1; miftyp = 1; break;
383 case SYS8C: ifm = 1; miftyp = 2; break;
384 case SYS8D: ifm = 1; miftyp = 3; break;
385 case SYS9: ifm = 1; miftyp = 4; break;
386 case SYS12: ifm = 1; miftyp = 5; break;
387 case SYS16A: ifm = 1; miftyp = 7; break;
388 case SYS16B: ifm = 1; miftyp = 8; break;
389 case SYS16C: ifm = 1; miftyp = 9; break;
390 case SYS18: ifm = 1; miftyp = 10; break;
391 case SYS24: ifm = 1; miftyp = 11; break;
395 /* SUBLCD only supports SYS interface */
396 if (lcdc_chan_is_sublcd(ch)) {
403 ch->ldmt1r_value = (ifm << 12) | miftyp;
409 static int sh_mobile_lcdc_setup_clocks(struct device *dev, int clock_source,
410 struct sh_mobile_lcdc_priv *priv)
415 switch (clock_source) {
416 case LCDC_CLK_BUS: str = "bus_clk"; icksel = 0; break;
417 case LCDC_CLK_PERIPHERAL: str = "peripheral_clk"; icksel = 1; break;
418 case LCDC_CLK_EXTERNAL: str = NULL; icksel = 2; break;
423 priv->lddckr = icksel << 16;
426 priv->clk = clk_get(dev, str);
427 if (IS_ERR(priv->clk)) {
428 dev_err(dev, "cannot get clock %s\n", str);
429 return PTR_ERR(priv->clk);
432 clk_enable(priv->clk);
438 static int sh_mobile_lcdc_setcolreg(u_int regno,
439 u_int red, u_int green, u_int blue,
440 u_int transp, struct fb_info *info)
442 u32 *palette = info->pseudo_palette;
444 if (regno >= PALETTE_NR)
447 /* only FB_VISUAL_TRUECOLOR supported */
449 red >>= 16 - info->var.red.length;
450 green >>= 16 - info->var.green.length;
451 blue >>= 16 - info->var.blue.length;
452 transp >>= 16 - info->var.transp.length;
454 palette[regno] = (red << info->var.red.offset) |
455 (green << info->var.green.offset) |
456 (blue << info->var.blue.offset) |
457 (transp << info->var.transp.offset);
462 static struct fb_fix_screeninfo sh_mobile_lcdc_fix = {
463 .id = "SH Mobile LCDC",
464 .type = FB_TYPE_PACKED_PIXELS,
465 .visual = FB_VISUAL_TRUECOLOR,
466 .accel = FB_ACCEL_NONE,
469 static struct fb_ops sh_mobile_lcdc_ops = {
470 .fb_setcolreg = sh_mobile_lcdc_setcolreg,
471 .fb_fillrect = cfb_fillrect,
472 .fb_copyarea = cfb_copyarea,
473 .fb_imageblit = cfb_imageblit,
476 static int sh_mobile_lcdc_set_bpp(struct fb_var_screeninfo *var, int bpp)
479 case 16: /* PKF[4:0] = 00011 - RGB 565 */
480 var->red.offset = 11;
482 var->green.offset = 5;
483 var->green.length = 6;
484 var->blue.offset = 0;
485 var->blue.length = 5;
486 var->transp.offset = 0;
487 var->transp.length = 0;
490 case 32: /* PKF[4:0] = 00000 - RGB 888
491 * sh7722 pdf says 00RRGGBB but reality is GGBB00RR
492 * this may be because LDDDSR has word swap enabled..
496 var->green.offset = 24;
497 var->green.length = 8;
498 var->blue.offset = 16;
499 var->blue.length = 8;
500 var->transp.offset = 0;
501 var->transp.length = 0;
506 var->bits_per_pixel = bpp;
507 var->red.msb_right = 0;
508 var->green.msb_right = 0;
509 var->blue.msb_right = 0;
510 var->transp.msb_right = 0;
514 static int sh_mobile_lcdc_remove(struct platform_device *pdev);
516 static int __init sh_mobile_lcdc_probe(struct platform_device *pdev)
518 struct fb_info *info;
519 struct sh_mobile_lcdc_priv *priv;
520 struct sh_mobile_lcdc_info *pdata;
521 struct sh_mobile_lcdc_chan_cfg *cfg;
522 struct resource *res;
527 if (!pdev->dev.platform_data) {
528 dev_err(&pdev->dev, "no platform data defined\n");
533 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
535 dev_err(&pdev->dev, "cannot find IO resource\n");
540 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
542 dev_err(&pdev->dev, "cannot allocate device data\n");
547 platform_set_drvdata(pdev, priv);
548 pdata = pdev->dev.platform_data;
551 for (i = 0; i < ARRAY_SIZE(pdata->ch); i++) {
552 priv->ch[j].lcdc = priv;
553 memcpy(&priv->ch[j].cfg, &pdata->ch[i], sizeof(pdata->ch[i]));
555 error = sh_mobile_lcdc_check_interface(&priv->ch[i]);
557 dev_err(&pdev->dev, "unsupported interface type\n");
561 switch (pdata->ch[i].chan) {
562 case LCDC_CHAN_MAINLCD:
563 priv->ch[j].enabled = 1 << 1;
564 priv->ch[j].reg_offs = lcdc_offs_mainlcd;
567 case LCDC_CHAN_SUBLCD:
568 priv->ch[j].enabled = 1 << 2;
569 priv->ch[j].reg_offs = lcdc_offs_sublcd;
576 dev_err(&pdev->dev, "no channels defined\n");
581 error = sh_mobile_lcdc_setup_clocks(&pdev->dev,
582 pdata->clock_source, priv);
584 dev_err(&pdev->dev, "unable to setup clocks\n");
588 priv->lddckr = pdata->lddckr;
589 priv->base = ioremap_nocache(res->start, (res->end - res->start) + 1);
591 for (i = 0; i < j; i++) {
592 info = &priv->ch[i].info;
593 cfg = &priv->ch[i].cfg;
595 info->fbops = &sh_mobile_lcdc_ops;
596 info->var.xres = info->var.xres_virtual = cfg->lcd_cfg.xres;
597 info->var.yres = info->var.yres_virtual = cfg->lcd_cfg.yres;
598 info->var.width = cfg->lcd_size_cfg.width;
599 info->var.height = cfg->lcd_size_cfg.height;
600 info->var.activate = FB_ACTIVATE_NOW;
601 error = sh_mobile_lcdc_set_bpp(&info->var, cfg->bpp);
605 info->fix = sh_mobile_lcdc_fix;
606 info->fix.line_length = cfg->lcd_cfg.xres * (cfg->bpp / 8);
607 info->fix.smem_len = info->fix.line_length * cfg->lcd_cfg.yres;
609 buf = dma_alloc_coherent(&pdev->dev, info->fix.smem_len,
610 &priv->ch[i].dma_handle, GFP_KERNEL);
612 dev_err(&pdev->dev, "unable to allocate buffer\n");
617 info->pseudo_palette = &priv->ch[i].pseudo_palette;
618 info->flags = FBINFO_FLAG_DEFAULT;
620 error = fb_alloc_cmap(&info->cmap, PALETTE_NR, 0);
622 dev_err(&pdev->dev, "unable to allocate cmap\n");
623 dma_free_coherent(&pdev->dev, info->fix.smem_len,
624 buf, priv->ch[i].dma_handle);
628 memset(buf, 0, info->fix.smem_len);
629 info->fix.smem_start = priv->ch[i].dma_handle;
630 info->screen_base = buf;
631 info->device = &pdev->dev;
637 error = sh_mobile_lcdc_start(priv);
639 dev_err(&pdev->dev, "unable to start hardware\n");
643 for (i = 0; i < j; i++) {
644 error = register_framebuffer(&priv->ch[i].info);
649 for (i = 0; i < j; i++) {
650 info = &priv->ch[i].info;
652 "registered %s/%s as %dx%d %dbpp.\n",
654 (priv->ch[i].cfg.chan == LCDC_CHAN_MAINLCD) ?
655 "mainlcd" : "sublcd",
656 (int) priv->ch[i].cfg.lcd_cfg.xres,
657 (int) priv->ch[i].cfg.lcd_cfg.yres,
658 priv->ch[i].cfg.bpp);
663 sh_mobile_lcdc_remove(pdev);
668 static int sh_mobile_lcdc_remove(struct platform_device *pdev)
670 struct sh_mobile_lcdc_priv *priv = platform_get_drvdata(pdev);
671 struct fb_info *info;
674 for (i = 0; i < ARRAY_SIZE(priv->ch); i++)
675 if (priv->ch[i].info.dev)
676 unregister_framebuffer(&priv->ch[i].info);
678 sh_mobile_lcdc_stop(priv);
680 for (i = 0; i < ARRAY_SIZE(priv->ch); i++) {
681 info = &priv->ch[i].info;
686 dma_free_coherent(&pdev->dev, info->fix.smem_len,
687 info->screen_base, priv->ch[i].dma_handle);
688 fb_dealloc_cmap(&info->cmap);
692 clk_disable(priv->clk);
703 static struct platform_driver sh_mobile_lcdc_driver = {
705 .name = "sh_mobile_lcdc_fb",
706 .owner = THIS_MODULE,
708 .probe = sh_mobile_lcdc_probe,
709 .remove = sh_mobile_lcdc_remove,
712 static int __init sh_mobile_lcdc_init(void)
714 return platform_driver_register(&sh_mobile_lcdc_driver);
717 static void __exit sh_mobile_lcdc_exit(void)
719 platform_driver_unregister(&sh_mobile_lcdc_driver);
722 module_init(sh_mobile_lcdc_init);
723 module_exit(sh_mobile_lcdc_exit);
725 MODULE_DESCRIPTION("SuperH Mobile LCDC Framebuffer driver");
726 MODULE_AUTHOR("Magnus Damm <damm@opensource.se>");
727 MODULE_LICENSE("GPL v2");