2 * File: drivers/video/bf54x-lq043.c
4 * Author: Michael Hennerich <hennerich@blackfin.uclinux.org>
7 * Description: ADSP-BF54x Framebufer driver
11 * Copyright 2007-2008 Analog Devices Inc.
13 * Bugs: Enter bugs at http://blackfin.uclinux.org/
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program; if not, see the file COPYING, or write
27 * to the Free Software Foundation, Inc.,
28 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
31 #include <linux/module.h>
32 #include <linux/kernel.h>
33 #include <linux/errno.h>
34 #include <linux/string.h>
36 #include <linux/tty.h>
37 #include <linux/slab.h>
38 #include <linux/delay.h>
40 #include <linux/ioport.h>
41 #include <linux/init.h>
42 #include <linux/types.h>
43 #include <linux/interrupt.h>
44 #include <linux/sched.h>
45 #include <linux/timer.h>
46 #include <linux/device.h>
47 #include <linux/backlight.h>
48 #include <linux/lcd.h>
49 #include <linux/spinlock.h>
50 #include <linux/dma-mapping.h>
51 #include <linux/platform_device.h>
53 #include <asm/blackfin.h>
56 #include <asm/dma-mapping.h>
59 #include <asm/portmux.h>
61 #include <mach/bf54x-lq043.h>
65 #define DRIVER_NAME "bf54x-lq043"
66 static char driver_name[] = DRIVER_NAME;
68 #define BFIN_LCD_NBR_PALETTE_ENTRIES 256
70 #define EPPI0_18 {P_PPI0_CLK, P_PPI0_FS1, P_PPI0_FS2, P_PPI0_D0, P_PPI0_D1, P_PPI0_D2, P_PPI0_D3, \
71 P_PPI0_D4, P_PPI0_D5, P_PPI0_D6, P_PPI0_D7, P_PPI0_D8, P_PPI0_D9, P_PPI0_D10, \
72 P_PPI0_D11, P_PPI0_D12, P_PPI0_D13, P_PPI0_D14, P_PPI0_D15, P_PPI0_D16, P_PPI0_D17, 0}
74 #define EPPI0_24 {P_PPI0_D18, P_PPI0_D19, P_PPI0_D20, P_PPI0_D21, P_PPI0_D22, P_PPI0_D23, 0}
76 struct bfin_bf54xfb_info {
80 struct bfin_bf54xfb_mach_info *mach_info;
82 unsigned char *fb_buffer; /* RGB Buffer */
84 dma_addr_t dma_handle;
88 spinlock_t lock; /* lock */
92 module_param(nocursor, int, 0644);
93 MODULE_PARM_DESC(nocursor, "cursor enable/disable");
95 static int outp_rgb666;
96 module_param(outp_rgb666, int, 0);
97 MODULE_PARM_DESC(outp_rgb666, "Output 18-bit RGB666");
99 #define LCD_X_RES 480 /*Horizontal Resolution */
100 #define LCD_Y_RES 272 /* Vertical Resolution */
102 #define LCD_BPP 24 /* Bit Per Pixel */
103 #define DMA_BUS_SIZE 32
105 /* -- Horizontal synchronizing --
107 * Timing characteristics taken from the SHARP LQ043T1DG01 datasheet
108 * (LCY-W-06602A Page 9 of 22)
110 * Clock Frequency 1/Tc Min 7.83 Typ 9.00 Max 9.26 MHz
112 * Period TH - 525 - Clock
113 * Pulse width THp - 41 - Clock
114 * Horizontal period THd - 480 - Clock
115 * Back porch THb - 2 - Clock
116 * Front porch THf - 2 - Clock
118 * -- Vertical synchronizing --
119 * Period TV - 286 - Line
120 * Pulse width TVp - 10 - Line
121 * Vertical period TVd - 272 - Line
122 * Back porch TVb - 2 - Line
123 * Front porch TVf - 2 - Line
126 #define LCD_CLK (8*1000*1000) /* 8MHz */
128 /* # active data to transfer after Horizontal Delay clock */
129 #define EPPI_HCOUNT LCD_X_RES
131 /* # active lines to transfer after Vertical Delay clock */
132 #define EPPI_VCOUNT LCD_Y_RES
134 /* Samples per Line = 480 (active data) + 45 (padding) */
135 #define EPPI_LINE 525
137 /* Lines per Frame = 272 (active data) + 14 (padding) */
138 #define EPPI_FRAME 286
140 /* FS1 (Hsync) Width (Typical)*/
141 #define EPPI_FS1W_HBL 41
143 /* FS1 (Hsync) Period (Typical) */
144 #define EPPI_FS1P_AVPL EPPI_LINE
146 /* Horizontal Delay clock after assertion of Hsync (Typical) */
147 #define EPPI_HDELAY 43
149 /* FS2 (Vsync) Width = FS1 (Hsync) Period * 10 */
150 #define EPPI_FS2W_LVB (EPPI_LINE * 10)
152 /* FS2 (Vsync) Period = FS1 (Hsync) Period * Lines per Frame */
153 #define EPPI_FS2P_LAVF (EPPI_LINE * EPPI_FRAME)
155 /* Vertical Delay after assertion of Vsync (2 Lines) */
156 #define EPPI_VDELAY 12
158 #define EPPI_CLIP 0xFF00FF00
160 /* EPPI Control register configuration value for RGB out
162 * GP 2 frame sync mode,
163 * Internal Clock generation disabled, Internal FS generation enabled,
164 * Receives samples on EPPI_CLK raising edge, Transmits samples on EPPI_CLK falling edge,
165 * FS1 & FS2 are active high,
166 * DLEN = 6 (24 bits for RGB888 out) or 5 (18 bits for RGB666 out)
167 * DMA Unpacking disabled when RGB Formating is enabled, otherwise DMA unpacking enabled
169 * One (DMA) Channel Mode,
170 * RGB Formatting Enabled for RGB666 output, disabled for RGB888 output
171 * Regular watermark - when FIFO is 100% full,
172 * Urgent watermark - when FIFO is 75% full
175 #define EPPI_CONTROL (0x20136E2E | SWAPEN)
177 static inline u16 get_eppi_clkdiv(u32 target_ppi_clk)
179 u32 sclk = get_sclk();
181 /* EPPI_CLK = (SCLK) / (2 * (EPPI_CLKDIV[15:0] + 1)) */
183 return (((sclk / target_ppi_clk) / 2) - 1);
186 static void config_ppi(struct bfin_bf54xfb_info *fbi)
189 u16 eppi_clkdiv = get_eppi_clkdiv(LCD_CLK);
191 bfin_write_EPPI0_FS1W_HBL(EPPI_FS1W_HBL);
192 bfin_write_EPPI0_FS1P_AVPL(EPPI_FS1P_AVPL);
193 bfin_write_EPPI0_FS2W_LVB(EPPI_FS2W_LVB);
194 bfin_write_EPPI0_FS2P_LAVF(EPPI_FS2P_LAVF);
195 bfin_write_EPPI0_CLIP(EPPI_CLIP);
197 bfin_write_EPPI0_FRAME(EPPI_FRAME);
198 bfin_write_EPPI0_LINE(EPPI_LINE);
200 bfin_write_EPPI0_HCOUNT(EPPI_HCOUNT);
201 bfin_write_EPPI0_HDELAY(EPPI_HDELAY);
202 bfin_write_EPPI0_VCOUNT(EPPI_VCOUNT);
203 bfin_write_EPPI0_VDELAY(EPPI_VDELAY);
205 bfin_write_EPPI0_CLKDIV(eppi_clkdiv);
208 * DLEN = 6 (24 bits for RGB888 out) or 5 (18 bits for RGB666 out)
209 * RGB Formatting Enabled for RGB666 output, disabled for RGB888 output
212 bfin_write_EPPI0_CONTROL((EPPI_CONTROL & ~DLENGTH) | DLEN_18 |
215 bfin_write_EPPI0_CONTROL(((EPPI_CONTROL & ~DLENGTH) | DLEN_24) &
221 static int config_dma(struct bfin_bf54xfb_info *fbi)
224 set_dma_config(CH_EPPI0,
225 set_bfin_dma_config(DIR_READ, DMA_FLOW_AUTO,
226 INTR_DISABLE, DIMENSION_2D,
228 DMA_NOSYNC_KEEP_DMA_BUF));
229 set_dma_x_count(CH_EPPI0, (LCD_X_RES * LCD_BPP) / DMA_BUS_SIZE);
230 set_dma_x_modify(CH_EPPI0, DMA_BUS_SIZE / 8);
231 set_dma_y_count(CH_EPPI0, LCD_Y_RES);
232 set_dma_y_modify(CH_EPPI0, DMA_BUS_SIZE / 8);
233 set_dma_start_addr(CH_EPPI0, (unsigned long)fbi->fb_buffer);
238 static int request_ports(struct bfin_bf54xfb_info *fbi)
241 u16 eppi_req_18[] = EPPI0_18;
242 u16 disp = fbi->mach_info->disp;
244 if (gpio_request(disp, DRIVER_NAME)) {
245 printk(KERN_ERR "Requesting GPIO %d faild\n", disp);
249 if (peripheral_request_list(eppi_req_18, DRIVER_NAME)) {
250 printk(KERN_ERR "Requesting Peripherals faild\n");
257 u16 eppi_req_24[] = EPPI0_24;
259 if (peripheral_request_list(eppi_req_24, DRIVER_NAME)) {
260 printk(KERN_ERR "Requesting Peripherals faild\n");
261 peripheral_free_list(eppi_req_18);
267 gpio_direction_output(disp, 1);
272 static void free_ports(struct bfin_bf54xfb_info *fbi)
275 u16 eppi_req_18[] = EPPI0_18;
277 gpio_free(fbi->mach_info->disp);
279 peripheral_free_list(eppi_req_18);
282 u16 eppi_req_24[] = EPPI0_24;
283 peripheral_free_list(eppi_req_24);
287 static int bfin_bf54x_fb_open(struct fb_info *info, int user)
289 struct bfin_bf54xfb_info *fbi = info->par;
291 spin_lock(&fbi->lock);
292 fbi->lq043_open_cnt++;
294 if (fbi->lq043_open_cnt <= 1) {
296 bfin_write_EPPI0_CONTROL(0);
303 enable_dma(CH_EPPI0);
304 bfin_write_EPPI0_CONTROL(bfin_read_EPPI0_CONTROL() | EPPI_EN);
307 spin_unlock(&fbi->lock);
312 static int bfin_bf54x_fb_release(struct fb_info *info, int user)
314 struct bfin_bf54xfb_info *fbi = info->par;
316 spin_lock(&fbi->lock);
318 fbi->lq043_open_cnt--;
321 if (fbi->lq043_open_cnt <= 0) {
323 bfin_write_EPPI0_CONTROL(0);
325 disable_dma(CH_EPPI0);
328 spin_unlock(&fbi->lock);
333 static int bfin_bf54x_fb_check_var(struct fb_var_screeninfo *var,
334 struct fb_info *info)
337 switch (var->bits_per_pixel) {
338 case 24:/* TRUECOLOUR, 16m */
339 var->red.offset = 16;
340 var->green.offset = 8;
341 var->blue.offset = 0;
342 var->red.length = var->green.length = var->blue.length = 8;
343 var->transp.offset = 0;
344 var->transp.length = 0;
345 var->transp.msb_right = 0;
346 var->red.msb_right = 0;
347 var->green.msb_right = 0;
348 var->blue.msb_right = 0;
351 pr_debug("%s: depth not supported: %u BPP\n", __func__,
352 var->bits_per_pixel);
356 if (info->var.xres != var->xres || info->var.yres != var->yres ||
357 info->var.xres_virtual != var->xres_virtual ||
358 info->var.yres_virtual != var->yres_virtual) {
359 pr_debug("%s: Resolution not supported: X%u x Y%u \n",
360 __func__, var->xres, var->yres);
368 if ((info->fix.line_length * var->yres_virtual) > info->fix.smem_len) {
369 pr_debug("%s: Memory Limit requested yres_virtual = %u\n",
370 __func__, var->yres_virtual);
377 static int bfin_bf54x_fb_mmap(struct fb_info *info, struct vm_area_struct *vma)
380 struct bfin_bf54xfb_info *fbi = info->par;
385 spin_lock(&fbi->lock);
387 spin_unlock(&fbi->lock);
389 vma->vm_start = (unsigned long)(fbi->fb_buffer);
391 vma->vm_end = vma->vm_start + info->fix.smem_len;
392 /* For those who don't understand how mmap works, go read
393 * Documentation/nommu-mmap.txt.
394 * For those that do, you will know that the VM_MAYSHARE flag
395 * must be set in the vma->vm_flags structure on noMMU
396 * Other flags can be set, and are documented in
399 vma->vm_flags |= VM_MAYSHARE | VM_SHARED;
404 int bfin_bf54x_fb_cursor(struct fb_info *info, struct fb_cursor *cursor)
409 return -EINVAL; /* just to force soft_cursor() call */
412 static int bfin_bf54x_fb_setcolreg(u_int regno, u_int red, u_int green,
413 u_int blue, u_int transp,
414 struct fb_info *info)
416 if (regno >= BFIN_LCD_NBR_PALETTE_ENTRIES)
419 if (info->var.grayscale) {
420 /* grayscale = 0.30*R + 0.59*G + 0.11*B */
421 red = green = blue = (red * 77 + green * 151 + blue * 28) >> 8;
424 if (info->fix.visual == FB_VISUAL_TRUECOLOR) {
427 /* Place color in the pseudopalette */
431 red >>= (16 - info->var.red.length);
432 green >>= (16 - info->var.green.length);
433 blue >>= (16 - info->var.blue.length);
435 value = (red << info->var.red.offset) |
436 (green << info->var.green.offset) |
437 (blue << info->var.blue.offset);
440 ((u32 *) (info->pseudo_palette))[regno] = value;
447 static struct fb_ops bfin_bf54x_fb_ops = {
448 .owner = THIS_MODULE,
449 .fb_open = bfin_bf54x_fb_open,
450 .fb_release = bfin_bf54x_fb_release,
451 .fb_check_var = bfin_bf54x_fb_check_var,
452 .fb_fillrect = cfb_fillrect,
453 .fb_copyarea = cfb_copyarea,
454 .fb_imageblit = cfb_imageblit,
455 .fb_mmap = bfin_bf54x_fb_mmap,
456 .fb_cursor = bfin_bf54x_fb_cursor,
457 .fb_setcolreg = bfin_bf54x_fb_setcolreg,
460 #ifndef NO_BL_SUPPORT
461 static int bl_get_brightness(struct backlight_device *bd)
466 static struct backlight_ops bfin_lq043fb_bl_ops = {
467 .get_brightness = bl_get_brightness,
470 static struct backlight_device *bl_dev;
472 static int bfin_lcd_get_power(struct lcd_device *dev)
477 static int bfin_lcd_set_power(struct lcd_device *dev, int power)
482 static int bfin_lcd_get_contrast(struct lcd_device *dev)
487 static int bfin_lcd_set_contrast(struct lcd_device *dev, int contrast)
493 static int bfin_lcd_check_fb(struct lcd_device *dev, struct fb_info *fi)
495 if (!fi || (fi == &bfin_bf54x_fb))
500 static struct lcd_ops bfin_lcd_ops = {
501 .get_power = bfin_lcd_get_power,
502 .set_power = bfin_lcd_set_power,
503 .get_contrast = bfin_lcd_get_contrast,
504 .set_contrast = bfin_lcd_set_contrast,
505 .check_fb = bfin_lcd_check_fb,
508 static struct lcd_device *lcd_dev;
511 static irqreturn_t bfin_bf54x_irq_error(int irq, void *dev_id)
513 /*struct bfin_bf54xfb_info *info = dev_id;*/
515 u16 status = bfin_read_EPPI0_STATUS();
517 bfin_write_EPPI0_STATUS(0xFFFF);
520 bfin_write_EPPI0_CONTROL(bfin_read_EPPI0_CONTROL() & ~EPPI_EN);
521 disable_dma(CH_EPPI0);
524 enable_dma(CH_EPPI0);
525 bfin_write_EPPI0_CONTROL(bfin_read_EPPI0_CONTROL() | EPPI_EN);
526 bfin_write_EPPI0_STATUS(0xFFFF);
532 static int __devinit bfin_bf54x_probe(struct platform_device *pdev)
534 struct bfin_bf54xfb_info *info;
535 struct fb_info *fbinfo;
538 printk(KERN_INFO DRIVER_NAME ": FrameBuffer initializing...\n");
540 if (request_dma(CH_EPPI0, "CH_EPPI0") < 0) {
541 printk(KERN_ERR DRIVER_NAME
542 ": couldn't request CH_EPPI0 DMA\n");
548 framebuffer_alloc(sizeof(struct bfin_bf54xfb_info), &pdev->dev);
556 info->dev = &pdev->dev;
558 platform_set_drvdata(pdev, fbinfo);
560 strcpy(fbinfo->fix.id, driver_name);
562 info->mach_info = pdev->dev.platform_data;
564 if (info->mach_info == NULL) {
566 "no platform data for lcd, cannot attach\n");
571 fbinfo->fix.type = FB_TYPE_PACKED_PIXELS;
572 fbinfo->fix.type_aux = 0;
573 fbinfo->fix.xpanstep = 0;
574 fbinfo->fix.ypanstep = 0;
575 fbinfo->fix.ywrapstep = 0;
576 fbinfo->fix.accel = FB_ACCEL_NONE;
577 fbinfo->fix.visual = FB_VISUAL_TRUECOLOR;
579 fbinfo->var.nonstd = 0;
580 fbinfo->var.activate = FB_ACTIVATE_NOW;
581 fbinfo->var.height = info->mach_info->height;
582 fbinfo->var.width = info->mach_info->width;
583 fbinfo->var.accel_flags = 0;
584 fbinfo->var.vmode = FB_VMODE_NONINTERLACED;
586 fbinfo->fbops = &bfin_bf54x_fb_ops;
587 fbinfo->flags = FBINFO_FLAG_DEFAULT;
589 fbinfo->var.xres = info->mach_info->xres.defval;
590 fbinfo->var.xres_virtual = info->mach_info->xres.defval;
591 fbinfo->var.yres = info->mach_info->yres.defval;
592 fbinfo->var.yres_virtual = info->mach_info->yres.defval;
593 fbinfo->var.bits_per_pixel = info->mach_info->bpp.defval;
595 fbinfo->var.upper_margin = 0;
596 fbinfo->var.lower_margin = 0;
597 fbinfo->var.vsync_len = 0;
599 fbinfo->var.left_margin = 0;
600 fbinfo->var.right_margin = 0;
601 fbinfo->var.hsync_len = 0;
603 fbinfo->var.red.offset = 16;
604 fbinfo->var.green.offset = 8;
605 fbinfo->var.blue.offset = 0;
606 fbinfo->var.transp.offset = 0;
607 fbinfo->var.red.length = 8;
608 fbinfo->var.green.length = 8;
609 fbinfo->var.blue.length = 8;
610 fbinfo->var.transp.length = 0;
611 fbinfo->fix.smem_len = info->mach_info->xres.max *
612 info->mach_info->yres.max * info->mach_info->bpp.max / 8;
614 fbinfo->fix.line_length = fbinfo->var.xres_virtual *
615 fbinfo->var.bits_per_pixel / 8;
618 dma_alloc_coherent(NULL, fbinfo->fix.smem_len, &info->dma_handle,
621 if (NULL == info->fb_buffer) {
622 printk(KERN_ERR DRIVER_NAME
623 ": couldn't allocate dma buffer.\n");
628 fbinfo->screen_base = (void *)info->fb_buffer;
629 fbinfo->fix.smem_start = (int)info->fb_buffer;
631 fbinfo->fbops = &bfin_bf54x_fb_ops;
633 fbinfo->pseudo_palette = kzalloc(sizeof(u32) * 16, GFP_KERNEL);
634 if (!fbinfo->pseudo_palette) {
635 printk(KERN_ERR DRIVER_NAME
636 "Fail to allocate pseudo_palette\n");
642 if (fb_alloc_cmap(&fbinfo->cmap, BFIN_LCD_NBR_PALETTE_ENTRIES, 0)
644 printk(KERN_ERR DRIVER_NAME
645 "Fail to allocate colormap (%d entries)\n",
646 BFIN_LCD_NBR_PALETTE_ENTRIES);
651 if (request_ports(info)) {
652 printk(KERN_ERR DRIVER_NAME ": couldn't request gpio port.\n");
657 info->irq = platform_get_irq(pdev, 0);
663 if (request_irq(info->irq, bfin_bf54x_irq_error, IRQF_DISABLED,
664 "PPI ERROR", info) < 0) {
665 printk(KERN_ERR DRIVER_NAME
666 ": unable to request PPI ERROR IRQ\n");
671 if (register_framebuffer(fbinfo) < 0) {
672 printk(KERN_ERR DRIVER_NAME
673 ": unable to register framebuffer.\n");
677 #ifndef NO_BL_SUPPORT
679 backlight_device_register("bf54x-bl", NULL, NULL,
680 &bfin_lq043fb_bl_ops);
681 bl_dev->props.max_brightness = 255;
683 lcd_dev = lcd_device_register(DRIVER_NAME, &pdev->dev, NULL, &bfin_lcd_ops);
684 lcd_dev->props.max_contrast = 255, printk(KERN_INFO "Done.\n");
690 free_irq(info->irq, info);
694 fb_dealloc_cmap(&fbinfo->cmap);
696 kfree(fbinfo->pseudo_palette);
698 dma_free_coherent(NULL, fbinfo->fix.smem_len, info->fb_buffer,
701 framebuffer_release(fbinfo);
705 platform_set_drvdata(pdev, NULL);
710 static int __devexit bfin_bf54x_remove(struct platform_device *pdev)
713 struct fb_info *fbinfo = platform_get_drvdata(pdev);
714 struct bfin_bf54xfb_info *info = fbinfo->par;
717 free_irq(info->irq, info);
719 if (info->fb_buffer != NULL)
720 dma_free_coherent(NULL, fbinfo->fix.smem_len, info->fb_buffer,
723 kfree(fbinfo->pseudo_palette);
724 fb_dealloc_cmap(&fbinfo->cmap);
726 #ifndef NO_BL_SUPPORT
727 lcd_device_unregister(lcd_dev);
728 backlight_device_unregister(bl_dev);
731 unregister_framebuffer(fbinfo);
735 printk(KERN_INFO DRIVER_NAME ": Unregister LCD driver.\n");
741 static int bfin_bf54x_suspend(struct platform_device *pdev, pm_message_t state)
743 struct fb_info *fbinfo = platform_get_drvdata(pdev);
745 bfin_write_EPPI0_CONTROL(bfin_read_EPPI0_CONTROL() & ~EPPI_EN);
746 disable_dma(CH_EPPI0);
747 bfin_write_EPPI0_STATUS(0xFFFF);
752 static int bfin_bf54x_resume(struct platform_device *pdev)
754 struct fb_info *fbinfo = platform_get_drvdata(pdev);
755 struct bfin_bf54xfb_info *info = fbinfo->par;
757 if (info->lq043_open_cnt) {
759 bfin_write_EPPI0_CONTROL(0);
766 enable_dma(CH_EPPI0);
767 bfin_write_EPPI0_CONTROL(bfin_read_EPPI0_CONTROL() | EPPI_EN);
773 #define bfin_bf54x_suspend NULL
774 #define bfin_bf54x_resume NULL
777 static struct platform_driver bfin_bf54x_driver = {
778 .probe = bfin_bf54x_probe,
779 .remove = __devexit_p(bfin_bf54x_remove),
780 .suspend = bfin_bf54x_suspend,
781 .resume = bfin_bf54x_resume,
784 .owner = THIS_MODULE,
788 static int __init bfin_bf54x_driver_init(void)
790 return platform_driver_register(&bfin_bf54x_driver);
793 static void __exit bfin_bf54x_driver_cleanup(void)
795 platform_driver_unregister(&bfin_bf54x_driver);
798 MODULE_DESCRIPTION("Blackfin BF54x TFT LCD Driver");
799 MODULE_LICENSE("GPL");
801 module_init(bfin_bf54x_driver_init);
802 module_exit(bfin_bf54x_driver_cleanup);