1 /* drivers/video/s1d13xxxfb.c
3 * (c) 2004 Simtec Electronics
4 * (c) 2005 Thibaut VARENE <varenet@parisc-linux.org>
6 * Driver for Epson S1D13xxx series framebuffer chips
9 * linux/drivers/video/skeletonfb.c
10 * linux/drivers/video/epson1355fb.c
11 * linux/drivers/video/epson/s1d13xxxfb.c (2.4 driver by Epson)
13 * Note, currently only tested on S1D13806 with 16bit CRT.
14 * As such, this driver might still contain some hardcoded bits relating to
16 * Making it work on other S1D13XXX chips should merely be a matter of adding
17 * a few switch()s, some missing glue here and there maybe, and split header
20 * TODO: - handle dual screen display (CRT and LCD at the same time).
21 * - check_var(), mode change, etc.
23 * - Accelerated interfaces.
24 * - Probably not SMP safe :)
26 * This file is subject to the terms and conditions of the GNU General Public
27 * License. See the file COPYING in the main directory of this archive for
31 #include <linux/config.h>
32 #include <linux/module.h>
33 #include <linux/device.h>
34 #include <linux/delay.h>
36 #include <linux/types.h>
37 #include <linux/errno.h>
39 #include <linux/mman.h>
44 #include <video/s1d13xxxfb.h>
46 #define PFX "s1d13xxxfb: "
49 #define dbg(fmt, args...) do { printk(KERN_INFO fmt, ## args); } while(0)
51 #define dbg(fmt, args...) do { } while (0)
55 * Here we define the default struct fb_fix_screeninfo
57 static struct fb_fix_screeninfo __devinitdata s1d13xxxfb_fix = {
59 .type = FB_TYPE_PACKED_PIXELS,
60 .visual = FB_VISUAL_PSEUDOCOLOR,
64 .accel = FB_ACCEL_NONE,
68 s1d13xxxfb_readreg(struct s1d13xxxfb_par *par, u16 regno)
70 #if defined(CONFIG_PLAT_M32700UT) || defined(CONFIG_PLAT_OPSPUT) || defined(CONFIG_PLAT_MAPPI3)
71 regno=((regno & 1) ? (regno & ~1L) : (regno + 1));
73 return readb(par->regs + regno);
77 s1d13xxxfb_writereg(struct s1d13xxxfb_par *par, u16 regno, u8 value)
79 #if defined(CONFIG_PLAT_M32700UT) || defined(CONFIG_PLAT_OPSPUT) || defined(CONFIG_PLAT_MAPPI3)
80 regno=((regno & 1) ? (regno & ~1L) : (regno + 1));
82 writeb(value, par->regs + regno);
86 s1d13xxxfb_runinit(struct s1d13xxxfb_par *par,
87 const struct s1d13xxxfb_regval *initregs,
88 const unsigned int size)
92 for (i = 0; i < size; i++) {
93 if ((initregs[i].addr == S1DREG_DELAYOFF) ||
94 (initregs[i].addr == S1DREG_DELAYON))
95 mdelay((int)initregs[i].value);
97 s1d13xxxfb_writereg(par, initregs[i].addr, initregs[i].value);
101 /* make sure the hardware can cope with us */
106 lcd_enable(struct s1d13xxxfb_par *par, int enable)
108 u8 mode = s1d13xxxfb_readreg(par, S1DREG_COM_DISP_MODE);
115 s1d13xxxfb_writereg(par, S1DREG_COM_DISP_MODE, mode);
119 crt_enable(struct s1d13xxxfb_par *par, int enable)
121 u8 mode = s1d13xxxfb_readreg(par, S1DREG_COM_DISP_MODE);
128 s1d13xxxfb_writereg(par, S1DREG_COM_DISP_MODE, mode);
131 /* framebuffer control routines */
134 s1d13xxxfb_setup_pseudocolour(struct fb_info *info)
136 info->fix.visual = FB_VISUAL_PSEUDOCOLOR;
138 info->var.red.length = 4;
139 info->var.green.length = 4;
140 info->var.blue.length = 4;
144 s1d13xxxfb_setup_truecolour(struct fb_info *info)
146 info->fix.visual = FB_VISUAL_TRUECOLOR;
147 info->var.bits_per_pixel = 16;
149 info->var.red.length = 5;
150 info->var.red.offset = 11;
152 info->var.green.length = 6;
153 info->var.green.offset = 5;
155 info->var.blue.length = 5;
156 info->var.blue.offset = 0;
160 * s1d13xxxfb_set_par - Alters the hardware state.
161 * @info: frame buffer structure
163 * Using the fb_var_screeninfo in fb_info we set the depth of the
164 * framebuffer. This function alters the par AND the
165 * fb_fix_screeninfo stored in fb_info. It doesn't not alter var in
166 * fb_info since we are using that data. This means we depend on the
167 * data in var inside fb_info to be supported by the hardware.
168 * xxxfb_check_var is always called before xxxfb_set_par to ensure this.
170 * XXX TODO: write proper s1d13xxxfb_check_var(), without which that
171 * function is quite useless.
174 s1d13xxxfb_set_par(struct fb_info *info)
176 struct s1d13xxxfb_par *s1dfb = info->par;
179 dbg("s1d13xxxfb_set_par: bpp=%d\n", info->var.bits_per_pixel);
181 if ((s1dfb->display & 0x01)) /* LCD */
182 val = s1d13xxxfb_readreg(s1dfb, S1DREG_LCD_DISP_MODE); /* read colour control */
184 val = s1d13xxxfb_readreg(s1dfb, S1DREG_CRT_DISP_MODE); /* read colour control */
188 switch (info->var.bits_per_pixel) {
190 dbg("pseudo colour 4\n");
191 s1d13xxxfb_setup_pseudocolour(info);
195 dbg("pseudo colour 8\n");
196 s1d13xxxfb_setup_pseudocolour(info);
200 dbg("true colour\n");
201 s1d13xxxfb_setup_truecolour(info);
206 dbg("bpp not supported!\n");
210 dbg("writing %02x to display mode register\n", val);
212 if ((s1dfb->display & 0x01)) /* LCD */
213 s1d13xxxfb_writereg(s1dfb, S1DREG_LCD_DISP_MODE, val);
215 s1d13xxxfb_writereg(s1dfb, S1DREG_CRT_DISP_MODE, val);
217 info->fix.line_length = info->var.xres * info->var.bits_per_pixel;
218 info->fix.line_length /= 8;
220 dbg("setting line_length to %d\n", info->fix.line_length);
228 * s1d13xxxfb_setcolreg - sets a color register.
229 * @regno: Which register in the CLUT we are programming
230 * @red: The red value which can be up to 16 bits wide
231 * @green: The green value which can be up to 16 bits wide
232 * @blue: The blue value which can be up to 16 bits wide.
233 * @transp: If supported the alpha value which can be up to 16 bits wide.
234 * @info: frame buffer info structure
236 * Returns negative errno on error, or zero on success.
239 s1d13xxxfb_setcolreg(u_int regno, u_int red, u_int green, u_int blue,
240 u_int transp, struct fb_info *info)
242 struct s1d13xxxfb_par *s1dfb = info->par;
243 unsigned int pseudo_val;
245 if (regno >= S1D_PALETTE_SIZE)
248 dbg("s1d13xxxfb_setcolreg: %d: rgb=%d,%d,%d, tr=%d\n",
249 regno, red, green, blue, transp);
251 if (info->var.grayscale)
252 red = green = blue = (19595*red + 38470*green + 7471*blue) >> 16;
254 switch (info->fix.visual) {
255 case FB_VISUAL_TRUECOLOR:
259 /* deal with creating pseudo-palette entries */
261 pseudo_val = (red >> 11) << info->var.red.offset;
262 pseudo_val |= (green >> 10) << info->var.green.offset;
263 pseudo_val |= (blue >> 11) << info->var.blue.offset;
265 dbg("s1d13xxxfb_setcolreg: pseudo %d, val %08x\n",
268 #if defined(CONFIG_PLAT_MAPPI)
269 ((u32 *)info->pseudo_palette)[regno] = cpu_to_le16(pseudo_val);
271 ((u32 *)info->pseudo_palette)[regno] = pseudo_val;
275 case FB_VISUAL_PSEUDOCOLOR:
276 s1d13xxxfb_writereg(s1dfb, S1DREG_LKUP_ADDR, regno);
277 s1d13xxxfb_writereg(s1dfb, S1DREG_LKUP_DATA, red);
278 s1d13xxxfb_writereg(s1dfb, S1DREG_LKUP_DATA, green);
279 s1d13xxxfb_writereg(s1dfb, S1DREG_LKUP_DATA, blue);
286 dbg("s1d13xxxfb_setcolreg: done\n");
292 * s1d13xxxfb_blank - blanks the display.
293 * @blank_mode: the blank mode we want.
294 * @info: frame buffer structure that represents a single frame buffer
296 * Blank the screen if blank_mode != 0, else unblank. Return 0 if
297 * blanking succeeded, != 0 if un-/blanking failed due to e.g. a
298 * video mode which doesn't support it. Implements VESA suspend
299 * and powerdown modes on hardware that supports disabling hsync/vsync:
300 * blank_mode == 2: suspend vsync
301 * blank_mode == 3: suspend hsync
302 * blank_mode == 4: powerdown
304 * Returns negative errno on error, or zero on success.
307 s1d13xxxfb_blank(int blank_mode, struct fb_info *info)
309 struct s1d13xxxfb_par *par = info->par;
311 dbg("s1d13xxxfb_blank: blank=%d, info=%p\n", blank_mode, info);
313 switch (blank_mode) {
314 case FB_BLANK_UNBLANK:
315 case FB_BLANK_NORMAL:
316 if ((par->display & 0x01) != 0)
318 if ((par->display & 0x02) != 0)
321 case FB_BLANK_VSYNC_SUSPEND:
322 case FB_BLANK_HSYNC_SUSPEND:
324 case FB_BLANK_POWERDOWN:
332 /* let fbcon do a soft blank for us */
333 return ((blank_mode == FB_BLANK_NORMAL) ? 1 : 0);
337 * s1d13xxxfb_pan_display - Pans the display.
338 * @var: frame buffer variable screen structure
339 * @info: frame buffer structure that represents a single frame buffer
341 * Pan (or wrap, depending on the `vmode' field) the display using the
342 * `yoffset' field of the `var' structure (`xoffset' not yet supported).
343 * If the values don't fit, return -EINVAL.
345 * Returns negative errno on error, or zero on success.
348 s1d13xxxfb_pan_display(struct fb_var_screeninfo *var, struct fb_info *info)
350 struct s1d13xxxfb_par *par = info->par;
353 if (var->xoffset != 0) /* not yet ... */
356 if (var->yoffset + info->var.yres > info->var.yres_virtual)
359 start = (info->fix.line_length >> 1) * var->yoffset;
361 if ((par->display & 0x01)) {
363 s1d13xxxfb_writereg(par, S1DREG_LCD_DISP_START0, (start & 0xff));
364 s1d13xxxfb_writereg(par, S1DREG_LCD_DISP_START1, ((start >> 8) & 0xff));
365 s1d13xxxfb_writereg(par, S1DREG_LCD_DISP_START2, ((start >> 16) & 0x0f));
368 s1d13xxxfb_writereg(par, S1DREG_CRT_DISP_START0, (start & 0xff));
369 s1d13xxxfb_writereg(par, S1DREG_CRT_DISP_START1, ((start >> 8) & 0xff));
370 s1d13xxxfb_writereg(par, S1DREG_CRT_DISP_START2, ((start >> 16) & 0x0f));
377 /* framebuffer information structures */
379 static struct fb_ops s1d13xxxfb_fbops = {
380 .owner = THIS_MODULE,
381 .fb_set_par = s1d13xxxfb_set_par,
382 .fb_setcolreg = s1d13xxxfb_setcolreg,
383 .fb_blank = s1d13xxxfb_blank,
385 .fb_pan_display = s1d13xxxfb_pan_display,
387 /* to be replaced by any acceleration we can */
388 .fb_fillrect = cfb_fillrect,
389 .fb_copyarea = cfb_copyarea,
390 .fb_imageblit = cfb_imageblit,
391 .fb_cursor = soft_cursor
394 static int s1d13xxxfb_width_tab[2][4] __devinitdata = {
400 * s1d13xxxfb_fetch_hw_state - Configure the framebuffer according to
402 * @info: frame buffer structure
404 * We setup the framebuffer structures according to the current
405 * hardware setup. On some machines, the BIOS will have filled
406 * the chip registers with such info, on others, these values will
407 * have been written in some init procedure. In any case, the
408 * software values needs to match the hardware ones. This is what
409 * this function ensures.
411 * Note: some of the hardcoded values here might need some love to
412 * work on various chips, and might need to no longer be hardcoded.
414 static void __devinit
415 s1d13xxxfb_fetch_hw_state(struct fb_info *info)
417 struct fb_var_screeninfo *var = &info->var;
418 struct fb_fix_screeninfo *fix = &info->fix;
419 struct s1d13xxxfb_par *par = info->par;
423 u32 xres_virtual, yres_virtual;
425 int is_color, is_dual, is_tft;
426 int lcd_enabled, crt_enabled;
428 fix->type = FB_TYPE_PACKED_PIXELS;
431 par->display = s1d13xxxfb_readreg(par, S1DREG_COM_DISP_MODE);
432 crt_enabled = (par->display & 0x02) != 0;
433 lcd_enabled = (par->display & 0x01) != 0;
435 if (lcd_enabled && crt_enabled)
436 printk(KERN_WARNING PFX "Warning: LCD and CRT detected, using LCD\n");
439 display = s1d13xxxfb_readreg(par, S1DREG_LCD_DISP_MODE);
441 display = s1d13xxxfb_readreg(par, S1DREG_CRT_DISP_MODE);
443 bpp = display & 0x07;
448 var->bits_per_pixel = 8;
449 var->red.offset = var->green.offset = var->blue.offset = 0;
450 var->red.length = var->green.length = var->blue.length = 8;
453 s1d13xxxfb_setup_truecolour(info);
456 dbg("bpp: %i\n", bpp);
458 fb_alloc_cmap(&info->cmap, 256, 0);
461 panel = s1d13xxxfb_readreg(par, S1DREG_PANEL_TYPE);
462 is_color = (panel & 0x04) != 0;
463 is_dual = (panel & 0x02) != 0;
464 is_tft = (panel & 0x01) != 0;
465 lcd_bpp = s1d13xxxfb_width_tab[is_tft][(panel >> 4) & 3];
468 xres = (s1d13xxxfb_readreg(par, S1DREG_LCD_DISP_HWIDTH) + 1) * 8;
469 yres = (s1d13xxxfb_readreg(par, S1DREG_LCD_DISP_VHEIGHT0) +
470 ((s1d13xxxfb_readreg(par, S1DREG_LCD_DISP_VHEIGHT1) & 0x03) << 8) + 1);
472 offset = (s1d13xxxfb_readreg(par, S1DREG_LCD_MEM_OFF0) +
473 ((s1d13xxxfb_readreg(par, S1DREG_LCD_MEM_OFF1) & 0x7) << 8));
475 xres = (s1d13xxxfb_readreg(par, S1DREG_CRT_DISP_HWIDTH) + 1) * 8;
476 yres = (s1d13xxxfb_readreg(par, S1DREG_CRT_DISP_VHEIGHT0) +
477 ((s1d13xxxfb_readreg(par, S1DREG_CRT_DISP_VHEIGHT1) & 0x03) << 8) + 1);
479 offset = (s1d13xxxfb_readreg(par, S1DREG_CRT_MEM_OFF0) +
480 ((s1d13xxxfb_readreg(par, S1DREG_CRT_MEM_OFF1) & 0x7) << 8));
482 xres_virtual = offset * 16 / var->bits_per_pixel;
483 yres_virtual = fix->smem_len / (offset * 2);
487 var->xres_virtual = xres_virtual;
488 var->yres_virtual = yres_virtual;
489 var->xoffset = var->yoffset = 0;
491 fix->line_length = offset * 2;
493 var->grayscale = !is_color;
495 var->activate = FB_ACTIVATE_NOW;
497 dbg(PFX "bpp=%d, lcd_bpp=%d, "
498 "crt_enabled=%d, lcd_enabled=%d\n",
499 var->bits_per_pixel, lcd_bpp, crt_enabled, lcd_enabled);
500 dbg(PFX "xres=%d, yres=%d, vxres=%d, vyres=%d "
501 "is_color=%d, is_dual=%d, is_tft=%d\n",
502 xres, yres, xres_virtual, yres_virtual, is_color, is_dual, is_tft);
507 s1d13xxxfb_remove(struct device *dev)
509 struct fb_info *info = dev_get_drvdata(dev);
510 struct platform_device *pdev = to_platform_device(dev);
511 struct s1d13xxxfb_par *par = NULL;
515 if (par && par->regs) {
516 /* disable output & enable powersave */
517 s1d13xxxfb_writereg(par, S1DREG_COM_DISP_MODE, 0x00);
518 s1d13xxxfb_writereg(par, S1DREG_PS_CNF, 0x11);
522 fb_dealloc_cmap(&info->cmap);
524 if (info->screen_base)
525 iounmap(info->screen_base);
527 framebuffer_release(info);
530 release_mem_region(pdev->resource[0].start,
531 pdev->resource[0].end - pdev->resource[0].start +1);
532 release_mem_region(pdev->resource[1].start,
533 pdev->resource[1].end - pdev->resource[1].start +1);
538 s1d13xxxfb_probe(struct device *dev)
540 struct platform_device *pdev = to_platform_device(dev);
541 struct s1d13xxxfb_par *default_par;
542 struct fb_info *info;
543 struct s1d13xxxfb_pdata *pdata = NULL;
547 dbg("probe called: device is %p\n", dev);
549 printk(KERN_INFO "Epson S1D13XXX FB Driver\n");
551 /* enable platform-dependent hardware glue, if any */
552 if (dev->platform_data)
553 pdata = dev->platform_data;
555 if (pdata && pdata->platform_init_video)
556 pdata->platform_init_video();
559 if (pdev->num_resources != 2) {
560 dev_err(&pdev->dev, "invalid num_resources: %i\n",
561 pdev->num_resources);
566 /* resource[0] is VRAM, resource[1] is registers */
567 if (pdev->resource[0].flags != IORESOURCE_MEM
568 || pdev->resource[1].flags != IORESOURCE_MEM) {
569 dev_err(&pdev->dev, "invalid resource type\n");
574 if (!request_mem_region(pdev->resource[0].start,
575 pdev->resource[0].end - pdev->resource[0].start +1, "s1d13xxxfb mem")) {
576 dev_dbg(dev, "request_mem_region failed\n");
581 if (!request_mem_region(pdev->resource[1].start,
582 pdev->resource[1].end - pdev->resource[1].start +1, "s1d13xxxfb regs")) {
583 dev_dbg(dev, "request_mem_region failed\n");
588 info = framebuffer_alloc(sizeof(struct s1d13xxxfb_par) + sizeof(u32) * 256, &pdev->dev);
594 default_par = info->par;
595 default_par->regs = ioremap_nocache(pdev->resource[1].start,
596 pdev->resource[1].end - pdev->resource[1].start +1);
597 if (!default_par->regs) {
598 printk(KERN_ERR PFX "unable to map registers\n");
602 info->pseudo_palette = default_par->pseudo_palette;
604 info->screen_base = ioremap_nocache(pdev->resource[0].start,
605 pdev->resource[0].end - pdev->resource[0].start +1);
607 if (!info->screen_base) {
608 printk(KERN_ERR PFX "unable to map framebuffer\n");
613 revision = s1d13xxxfb_readreg(default_par, S1DREG_REV_CODE);
614 if ((revision >> 2) != S1D_CHIP_REV) {
615 printk(KERN_INFO PFX "chip not found: %i\n", (revision >> 2));
620 info->fix = s1d13xxxfb_fix;
621 info->fix.mmio_start = pdev->resource[1].start;
622 info->fix.mmio_len = pdev->resource[1].end - pdev->resource[1].start +1;
623 info->fix.smem_start = pdev->resource[0].start;
624 info->fix.smem_len = pdev->resource[0].end - pdev->resource[0].start +1;
626 printk(KERN_INFO PFX "regs mapped at 0x%p, fb %d KiB mapped at 0x%p\n",
627 default_par->regs, info->fix.smem_len / 1024, info->screen_base);
629 info->par = default_par;
630 info->fbops = &s1d13xxxfb_fbops;
631 info->flags = FBINFO_DEFAULT | FBINFO_HWACCEL_YPAN;
633 /* perform "manual" chip initialization, if needed */
634 if (pdata && pdata->initregs)
635 s1d13xxxfb_runinit(info->par, pdata->initregs, pdata->initregssize);
637 s1d13xxxfb_fetch_hw_state(info);
639 if (register_framebuffer(info) < 0) {
644 dev_set_drvdata(&pdev->dev, info);
646 printk(KERN_INFO "fb%d: %s frame buffer device\n",
647 info->node, info->fix.id);
652 s1d13xxxfb_remove(dev);
658 static int s1d13xxxfb_suspend(struct device *dev, pm_message_t state, u32 level)
660 struct fb_info *info = dev_get_drvdata(dev);
661 struct s1d13xxxfb_par *s1dfb = info->par;
662 struct s1d13xxxfb_pdata *pdata = NULL;
664 /* disable display */
665 lcd_enable(s1dfb, 0);
666 crt_enable(s1dfb, 0);
668 if (dev->platform_data)
669 pdata = dev->platform_data;
672 if (!s1dfb->disp_save)
673 s1dfb->disp_save = kmalloc(info->fix.smem_len, GFP_KERNEL);
675 if (!s1dfb->disp_save) {
676 printk(KERN_ERR PFX "no memory to save screen");
680 memcpy_fromio(s1dfb->disp_save, info->screen_base, info->fix.smem_len);
682 s1dfb->disp_save = NULL;
685 if (!s1dfb->regs_save)
686 s1dfb->regs_save = kmalloc(info->fix.mmio_len, GFP_KERNEL);
688 if (!s1dfb->regs_save) {
689 printk(KERN_ERR PFX "no memory to save registers");
693 /* backup all registers */
694 memcpy_fromio(s1dfb->regs_save, s1dfb->regs, info->fix.mmio_len);
696 /* now activate power save mode */
697 s1d13xxxfb_writereg(s1dfb, S1DREG_PS_CNF, 0x11);
699 if (pdata && pdata->platform_suspend_video)
700 return pdata->platform_suspend_video();
705 static int s1d13xxxfb_resume(struct device *dev, u32 level)
707 struct fb_info *info = dev_get_drvdata(dev);
708 struct s1d13xxxfb_par *s1dfb = info->par;
709 struct s1d13xxxfb_pdata *pdata = NULL;
711 if (level != RESUME_ENABLE)
714 /* awaken the chip */
715 s1d13xxxfb_writereg(s1dfb, S1DREG_PS_CNF, 0x10);
717 /* do not let go until SDRAM "wakes up" */
718 while ((s1d13xxxfb_readreg(s1dfb, S1DREG_PS_STATUS) & 0x01))
721 if (dev->platform_data)
722 pdata = dev->platform_data;
724 if (s1dfb->regs_save) {
725 /* will write RO regs, *should* get away with it :) */
726 memcpy_toio(s1dfb->regs, s1dfb->regs_save, info->fix.mmio_len);
727 kfree(s1dfb->regs_save);
730 if (s1dfb->disp_save) {
731 memcpy_toio(info->screen_base, s1dfb->disp_save,
733 kfree(s1dfb->disp_save); /* XXX kmalloc()'d when? */
736 if ((s1dfb->display & 0x01) != 0)
737 lcd_enable(s1dfb, 1);
738 if ((s1dfb->display & 0x02) != 0)
739 crt_enable(s1dfb, 1);
741 if (pdata && pdata->platform_resume_video)
742 return pdata->platform_resume_video();
746 #endif /* CONFIG_PM */
748 static struct device_driver s1d13xxxfb_driver = {
749 .name = S1D_DEVICENAME,
750 .bus = &platform_bus_type,
751 .probe = s1d13xxxfb_probe,
752 .remove = s1d13xxxfb_remove,
754 .suspend = s1d13xxxfb_suspend,
755 .resume = s1d13xxxfb_resume
761 s1d13xxxfb_init(void)
763 if (fb_get_options("s1d13xxxfb", NULL))
766 return driver_register(&s1d13xxxfb_driver);
771 s1d13xxxfb_exit(void)
773 driver_unregister(&s1d13xxxfb_driver);
776 module_init(s1d13xxxfb_init);
777 module_exit(s1d13xxxfb_exit);
780 MODULE_LICENSE("GPL");
781 MODULE_DESCRIPTION("Framebuffer driver for S1D13xxx devices");
782 MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>, Thibaut VARENE <varenet@parisc-linux.org>");