2 * linux/drivers/video/epson1355fb.c -- Epson S1D13505 frame buffer for 2.5.
4 * Epson Research S1D13505 Embedded RAMDAC LCD/CRT Controller
5 * (previously known as SED1355)
7 * Cf. http://www.erd.epson.com/vdc/html/S1D13505.html
10 * Copyright (C) Hewlett-Packard Company. All rights reserved.
12 * Written by Christopher Hoover <ch@hpl.hp.com>
16 * linux/drivers/video/skeletonfb.c
17 * Modified to new api Jan 2001 by James Simmons (jsimmons@infradead.org)
18 * Created 28 Dec 1997 by Geert Uytterhoeven
20 * linux/drivers/video/epson1355fb.c (2.4 driver)
21 * Copyright (C) 2000 Philipp Rumpf <prumpf@tux.org>
23 * This file is subject to the terms and conditions of the GNU General Public
24 * License. See the file COPYING in the main directory of this archive for
31 * This driver is complicated by the fact that this is a 16-bit chip
32 * and, on at least one platform (ceiva), we can only do 16-bit reads
33 * and writes to the framebuffer. We hide this from user space
34 * except in the case of mmap().
40 * - Test 8-bit pseudocolor mode
41 * - Allow setting bpp, virtual resolution
42 * - Implement horizontal panning
43 * - (maybe) Implement hardware cursor
46 #include <linux/module.h>
47 #include <linux/kernel.h>
48 #include <linux/errno.h>
49 #include <linux/string.h>
51 #include <linux/slab.h>
52 #include <linux/delay.h>
54 #include <linux/init.h>
55 #include <linux/ioport.h>
56 #include <linux/platform_device.h>
58 #include <asm/types.h>
60 #include <linux/uaccess.h>
62 #include <video/epson1355.h>
64 struct epson1355_par {
65 unsigned long reg_addr;
66 u32 pseudo_palette[16];
69 /* ------------------------------------------------------------------------- */
71 #if defined(CONFIG_ARM)
73 # ifdef CONFIG_ARCH_CEIVA
74 # include <mach/hardware.h>
75 # define EPSON1355FB_BASE_PHYS (CEIVA_PHYS_SED1355)
78 static inline u8 epson1355_read_reg(struct epson1355_par *par, int index)
80 return __raw_readb(par->reg_addr + index);
83 static inline void epson1355_write_reg(struct epson1355_par *par, u8 data, int index)
85 __raw_writeb(data, par->reg_addr + index);
89 # error "no architecture-specific epson1355_{read,write}_reg"
92 #ifndef EPSON1355FB_BASE_PHYS
93 # error "EPSON1355FB_BASE_PHYS is not defined"
96 #define EPSON1355FB_REGS_OFS (0)
97 #define EPSON1355FB_REGS_PHYS (EPSON1355FB_BASE_PHYS + EPSON1355FB_REGS_OFS)
98 #define EPSON1355FB_REGS_LEN (64)
100 #define EPSON1355FB_FB_OFS (0x00200000)
101 #define EPSON1355FB_FB_PHYS (EPSON1355FB_BASE_PHYS + EPSON1355FB_FB_OFS)
102 #define EPSON1355FB_FB_LEN (2 * 1024 * 1024)
104 /* ------------------------------------------------------------------------- */
106 static inline u16 epson1355_read_reg16(struct epson1355_par *par, int index)
108 u8 lo = epson1355_read_reg(par, index);
109 u8 hi = epson1355_read_reg(par, index + 1);
111 return (hi << 8) | lo;
114 static inline void epson1355_write_reg16(struct epson1355_par *par, u16 data, int index)
117 u8 hi = (data >> 8) & 0xff;
119 epson1355_write_reg(par, lo, index);
120 epson1355_write_reg(par, hi, index + 1);
123 static inline u32 epson1355_read_reg20(struct epson1355_par *par, int index)
125 u8 b0 = epson1355_read_reg(par, index);
126 u8 b1 = epson1355_read_reg(par, index + 1);
127 u8 b2 = epson1355_read_reg(par, index + 2);
129 return (b2 & 0x0f) << 16 | (b1 << 8) | b0;
132 static inline void epson1355_write_reg20(struct epson1355_par *par, u32 data, int index)
135 u8 b1 = (data >> 8) & 0xff;
136 u8 b2 = (data >> 16) & 0x0f;
138 epson1355_write_reg(par, b0, index);
139 epson1355_write_reg(par, b1, index + 1);
140 epson1355_write_reg(par, b2, index + 2);
143 /* ------------------------------------------------------------------------- */
145 static void set_lut(struct epson1355_par *par, u8 index, u8 r, u8 g, u8 b)
147 epson1355_write_reg(par, index, REG_LUT_ADDR);
148 epson1355_write_reg(par, r, REG_LUT_DATA);
149 epson1355_write_reg(par, g, REG_LUT_DATA);
150 epson1355_write_reg(par, b, REG_LUT_DATA);
155 * epson1355fb_setcolreg - sets a color register.
156 * @regno: Which register in the CLUT we are programming
157 * @red: The red value which can be up to 16 bits wide
158 * @green: The green value which can be up to 16 bits wide
159 * @blue: The blue value which can be up to 16 bits wide.
160 * @transp: If supported the alpha value which can be up to 16 bits wide.
161 * @info: frame buffer info structure
163 * Returns negative errno on error, or zero on success.
165 static int epson1355fb_setcolreg(unsigned regno, unsigned r, unsigned g,
166 unsigned b, unsigned transp,
167 struct fb_info *info)
169 struct epson1355_par *par = info->par;
171 if (info->var.grayscale)
172 r = g = b = (19595 * r + 38470 * g + 7471 * b) >> 16;
174 switch (info->fix.visual) {
175 case FB_VISUAL_TRUECOLOR:
179 ((u32 *) info->pseudo_palette)[regno] =
180 (r & 0xf800) | (g & 0xfc00) >> 5 | (b & 0xf800) >> 11;
183 case FB_VISUAL_PSEUDOCOLOR:
187 set_lut(par, regno, r >> 8, g >> 8, b >> 8);
196 /* ------------------------------------------------------------------------- */
199 * epson1355fb_pan_display - Pans the display.
200 * @var: frame buffer variable screen structure
201 * @info: frame buffer structure that represents a single frame buffer
203 * Pan (or wrap, depending on the `vmode' field) the display using the
204 * `xoffset' and `yoffset' fields of the `var' structure.
205 * If the values don't fit, return -EINVAL.
207 * Returns negative errno on error, or zero on success.
209 static int epson1355fb_pan_display(struct fb_var_screeninfo *var,
210 struct fb_info *info)
212 struct epson1355_par *par = info->par;
215 if (var->xoffset != 0) /* not yet ... */
218 if (var->yoffset + info->var.yres > info->var.yres_virtual)
221 start = (info->fix.line_length >> 1) * var->yoffset;
223 epson1355_write_reg20(par, start, REG_SCRN1_DISP_START_ADDR0);
228 /* ------------------------------------------------------------------------- */
230 static void lcd_enable(struct epson1355_par *par, int enable)
232 u8 mode = epson1355_read_reg(par, REG_DISPLAY_MODE);
239 epson1355_write_reg(par, mode, REG_DISPLAY_MODE);
242 #if defined(CONFIG_ARCH_CEIVA)
243 static void backlight_enable(int enable)
245 /* ### this should be protected by a spinlock ... */
246 u8 pddr = clps_readb(PDDR);
251 clps_writeb(pddr, PDDR);
254 static void backlight_enable(int enable)
261 * epson1355fb_blank - blanks the display.
262 * @blank_mode: the blank mode we want.
263 * @info: frame buffer structure that represents a single frame buffer
265 * Blank the screen if blank_mode != 0, else unblank. Return 0 if
266 * blanking succeeded, != 0 if un-/blanking failed due to e.g. a
267 * video mode which doesn't support it. Implements VESA suspend
268 * and powerdown modes on hardware that supports disabling hsync/vsync:
269 * blank_mode == 2: suspend vsync
270 * blank_mode == 3: suspend hsync
271 * blank_mode == 4: powerdown
273 * Returns negative errno on error, or zero on success.
276 static int epson1355fb_blank(int blank_mode, struct fb_info *info)
278 struct epson1355_par *par = info->par;
280 switch (blank_mode) {
281 case FB_BLANK_UNBLANK:
282 case FB_BLANK_NORMAL:
286 case FB_BLANK_VSYNC_SUSPEND:
287 case FB_BLANK_HSYNC_SUSPEND:
290 case FB_BLANK_POWERDOWN:
298 /* let fbcon do a soft blank for us */
299 return (blank_mode == FB_BLANK_NORMAL) ? 1 : 0;
302 /* ------------------------------------------------------------------------- */
305 * We can't use the cfb generic routines, as we have to limit
306 * ourselves to 16-bit or 8-bit loads and stores to this 16-bit
310 static inline void epson1355fb_fb_writel(unsigned long v, unsigned long *a)
320 static inline unsigned long epson1355fb_fb_readl(const unsigned long *a)
322 const u16 *p = (u16 *) a;
324 u16 h = fb_readw(p + 1);
326 return (h << 16) | l;
329 #define FB_READL epson1355fb_fb_readl
330 #define FB_WRITEL epson1355fb_fb_writel
332 /* ------------------------------------------------------------------------- */
334 static inline unsigned long copy_from_user16(void *to, const void *from,
337 u16 *dst = (u16 *) to;
338 u16 *src = (u16 *) from;
340 if (!access_ok(VERIFY_READ, from, n))
345 if (__get_user(v, src))
357 if (__get_user(v, ((u8 *) src)))
365 static inline unsigned long copy_to_user16(void *to, const void *from,
368 u16 *dst = (u16 *) to;
369 u16 *src = (u16 *) from;
371 if (!access_ok(VERIFY_WRITE, to, n))
375 u16 v = fb_readw(src);
377 if (__put_user(v, dst))
385 u8 v = fb_readb(src);
387 if (__put_user(v, ((u8 *) dst)))
395 epson1355fb_read(struct fb_info *info, char *buf, size_t count, loff_t * ppos)
397 unsigned long p = *ppos;
399 if (p >= info->fix.smem_len)
401 if (count >= info->fix.smem_len)
402 count = info->fix.smem_len;
403 if (count + p > info->fix.smem_len)
404 count = info->fix.smem_len - p;
409 base_addr = info->screen_base;
410 count -= copy_to_user16(buf, base_addr + p, count);
419 epson1355fb_write(struct fb_info *info, const char *buf,
420 size_t count, loff_t * ppos)
422 unsigned long p = *ppos;
425 /* from fbmem.c except for our own copy_*_user */
426 if (p > info->fix.smem_len)
428 if (count >= info->fix.smem_len)
429 count = info->fix.smem_len;
431 if (count + p > info->fix.smem_len) {
432 count = info->fix.smem_len - p;
439 base_addr = info->screen_base;
440 count -= copy_from_user16(base_addr + p, buf, count);
449 /* ------------------------------------------------------------------------- */
451 static struct fb_ops epson1355fb_fbops = {
452 .owner = THIS_MODULE,
453 .fb_setcolreg = epson1355fb_setcolreg,
454 .fb_pan_display = epson1355fb_pan_display,
455 .fb_blank = epson1355fb_blank,
456 .fb_fillrect = cfb_fillrect,
457 .fb_copyarea = cfb_copyarea,
458 .fb_imageblit = cfb_imageblit,
459 .fb_read = epson1355fb_read,
460 .fb_write = epson1355fb_write,
463 /* ------------------------------------------------------------------------- */
465 static __init unsigned int get_fb_size(struct fb_info *info)
467 unsigned int size = 2 * 1024 * 1024;
468 char *p = info->screen_base;
470 /* the 512k framebuffer is aliased at start + 0x80000 * n */
472 fb_writeb(0, p + 0x80000);
481 static int epson1355_width_tab[2][4] __initdata =
482 { {4, 8, 16, -1}, {9, 12, 16, -1} };
483 static int epson1355_bpp_tab[8] __initdata = { 1, 2, 4, 8, 15, 16 };
485 static void __init fetch_hw_state(struct fb_info *info, struct epson1355_par *par)
487 struct fb_var_screeninfo *var = &info->var;
488 struct fb_fix_screeninfo *fix = &info->fix;
492 u32 xres_virtual, yres_virtual;
494 int is_color, is_dual, is_tft;
495 int lcd_enabled, crt_enabled;
497 fix->type = FB_TYPE_PACKED_PIXELS;
499 display = epson1355_read_reg(par, REG_DISPLAY_MODE);
500 bpp = epson1355_bpp_tab[(display >> 2) & 7];
504 fix->visual = FB_VISUAL_PSEUDOCOLOR;
505 var->bits_per_pixel = 8;
506 var->red.offset = var->green.offset = var->blue.offset = 0;
507 var->red.length = var->green.length = var->blue.length = 8;
511 fix->visual = FB_VISUAL_TRUECOLOR;
512 var->bits_per_pixel = 16;
513 var->red.offset = 11;
515 var->green.offset = 5;
516 var->green.length = 6;
517 var->blue.offset = 0;
518 var->blue.length = 5;
523 fb_alloc_cmap(&(info->cmap), 256, 0);
525 panel = epson1355_read_reg(par, REG_PANEL_TYPE);
526 is_color = (panel & 0x04) != 0;
527 is_dual = (panel & 0x02) != 0;
528 is_tft = (panel & 0x01) != 0;
529 crt_enabled = (display & 0x02) != 0;
530 lcd_enabled = (display & 0x01) != 0;
531 lcd_bpp = epson1355_width_tab[is_tft][(panel >> 4) & 3];
533 xres = (epson1355_read_reg(par, REG_HORZ_DISP_WIDTH) + 1) * 8;
534 yres = (epson1355_read_reg16(par, REG_VERT_DISP_HEIGHT0) + 1) *
535 ((is_dual && !crt_enabled) ? 2 : 1);
536 offset = epson1355_read_reg16(par, REG_MEM_ADDR_OFFSET0) & 0x7ff;
537 xres_virtual = offset * 16 / bpp;
538 yres_virtual = fix->smem_len / (offset * 2);
542 var->xres_virtual = xres_virtual;
543 var->yres_virtual = yres_virtual;
544 var->xoffset = var->yoffset = 0;
546 fix->line_length = offset * 2;
548 fix->xpanstep = 0; /* no pan yet */
551 fix->accel = FB_ACCEL_NONE;
553 var->grayscale = !is_color;
557 "epson1355fb: xres=%d, yres=%d, "
558 "is_color=%d, is_dual=%d, is_tft=%d\n",
559 xres, yres, is_color, is_dual, is_tft);
561 "epson1355fb: bpp=%d, lcd_bpp=%d, "
562 "crt_enabled=%d, lcd_enabled=%d\n",
563 bpp, lcd_bpp, crt_enabled, lcd_enabled);
568 static void clearfb16(struct fb_info *info)
570 u16 *dst = (u16 *) info->screen_base;
571 unsigned long n = info->fix.smem_len;
582 static int epson1355fb_remove(struct platform_device *dev)
584 struct fb_info *info = platform_get_drvdata(dev);
585 struct epson1355_par *par = info->par;
590 if (par && par->reg_addr)
591 iounmap((void *) par->reg_addr);
595 fb_dealloc_cmap(&info->cmap);
596 if (info->screen_base)
597 iounmap(info->screen_base);
598 framebuffer_release(info);
600 release_mem_region(EPSON1355FB_FB_PHYS, EPSON1355FB_FB_LEN);
601 release_mem_region(EPSON1355FB_REGS_PHYS, EPSON1355FB_REGS_LEN);
605 int __init epson1355fb_probe(struct platform_device *dev)
607 struct epson1355_par *default_par;
608 struct fb_info *info;
612 if (!request_mem_region(EPSON1355FB_REGS_PHYS, EPSON1355FB_REGS_LEN, "S1D13505 registers")) {
613 printk(KERN_ERR "epson1355fb: unable to reserve "
614 "registers at 0x%0x\n", EPSON1355FB_REGS_PHYS);
619 if (!request_mem_region(EPSON1355FB_FB_PHYS, EPSON1355FB_FB_LEN,
620 "S1D13505 framebuffer")) {
621 printk(KERN_ERR "epson1355fb: unable to reserve "
622 "framebuffer at 0x%0x\n", EPSON1355FB_FB_PHYS);
627 info = framebuffer_alloc(sizeof(struct epson1355_par), &dev->dev);
633 default_par = info->par;
634 default_par->reg_addr = (unsigned long) ioremap(EPSON1355FB_REGS_PHYS, EPSON1355FB_REGS_LEN);
635 if (!default_par->reg_addr) {
636 printk(KERN_ERR "epson1355fb: unable to map registers\n");
640 info->pseudo_palette = default_par->pseudo_palette;
642 info->screen_base = ioremap(EPSON1355FB_FB_PHYS, EPSON1355FB_FB_LEN);
643 if (!info->screen_base) {
644 printk(KERN_ERR "epson1355fb: unable to map framebuffer\n");
649 revision = epson1355_read_reg(default_par, REG_REVISION_CODE);
650 if ((revision >> 2) != 3) {
651 printk(KERN_INFO "epson1355fb: epson1355 not found\n");
656 info->fix.mmio_start = EPSON1355FB_REGS_PHYS;
657 info->fix.mmio_len = EPSON1355FB_REGS_LEN;
658 info->fix.smem_start = EPSON1355FB_FB_PHYS;
659 info->fix.smem_len = get_fb_size(info);
661 printk(KERN_INFO "epson1355fb: regs mapped at 0x%lx, fb %d KiB mapped at 0x%p\n",
662 default_par->reg_addr, info->fix.smem_len / 1024, info->screen_base);
664 strcpy(info->fix.id, "S1D13505");
665 info->par = default_par;
666 info->fbops = &epson1355fb_fbops;
667 info->flags = FBINFO_DEFAULT | FBINFO_HWACCEL_YPAN;
669 /* we expect the boot loader to have initialized the chip
670 with appropriate parameters from which we can determinte
671 the flavor of lcd panel attached */
672 fetch_hw_state(info, default_par);
674 /* turn this puppy on ... */
677 lcd_enable(default_par, 1);
679 if (register_framebuffer(info) < 0) {
686 platform_set_drvdata(dev, info);
688 printk(KERN_INFO "fb%d: %s frame buffer device\n",
689 info->node, info->fix.id);
694 epson1355fb_remove(dev);
698 static struct platform_driver epson1355fb_driver = {
699 .probe = epson1355fb_probe,
700 .remove = epson1355fb_remove,
702 .name = "epson1355fb",
706 static struct platform_device *epson1355fb_device;
708 int __init epson1355fb_init(void)
712 if (fb_get_options("epson1355fb", NULL))
715 ret = platform_driver_register(&epson1355fb_driver);
718 epson1355fb_device = platform_device_alloc("epson1355fb", 0);
720 if (epson1355fb_device)
721 ret = platform_device_add(epson1355fb_device);
726 platform_device_put(epson1355fb_device);
727 platform_driver_unregister(&epson1355fb_driver);
734 module_init(epson1355fb_init);
737 static void __exit epson1355fb_exit(void)
739 platform_device_unregister(epson1355fb_device);
740 platform_driver_unregister(&epson1355fb_driver);
743 /* ------------------------------------------------------------------------- */
745 module_exit(epson1355fb_exit);
748 MODULE_AUTHOR("Christopher Hoover <ch@hpl.hp.com>");
749 MODULE_DESCRIPTION("Framebuffer driver for Epson S1D13505");
750 MODULE_LICENSE("GPL");