4 * Xilinx TFT LCD frame buffer driver
6 * Author: MontaVista Software, Inc.
9 * 2002-2007 (c) MontaVista Software, Inc. This file is licensed under the
10 * terms of the GNU General Public License version 2. This program is licensed
11 * "as is" without any warranty of any kind, whether express or implied.
15 * This driver was based on au1100fb.c by MontaVista rewritten for 2.6
16 * by Embedded Alley Solutions <source@embeddedalley.com>, which in turn
17 * was based on skeletonfb.c, Skeleton for a frame buffer device by
21 #include <linux/module.h>
22 #include <linux/kernel.h>
23 #include <linux/version.h>
24 #include <linux/errno.h>
25 #include <linux/string.h>
28 #include <linux/init.h>
29 #include <linux/dma-mapping.h>
30 #include <linux/platform_device.h>
33 #include <syslib/virtex_devices.h>
35 #define DRIVER_NAME "xilinxfb"
36 #define DRIVER_DESCRIPTION "Xilinx TFT LCD frame buffer driver"
39 * Xilinx calls it "PLB TFT LCD Controller" though it can also be used for
40 * the VGA port on the Xilinx ML40x board. This is a hardware display controller
41 * for a 640x480 resolution TFT or VGA screen.
43 * The interface to the framebuffer is nice and simple. There are two
44 * control registers. The first tells the LCD interface where in memory
45 * the frame buffer is (only the 11 most significant bits are used, so
46 * don't start thinking about scrolling). The second allows the LCD to
47 * be turned on or off as well as rotated 180 degrees.
52 #define REG_CTRL_ENABLE 0x0001
53 #define REG_CTRL_ROTATE 0x0002
56 * The hardware only handles a single mode: 640x480 24 bit true
57 * color. Each pixel gets a word (32 bits) of memory. Within each word,
58 * the 8 most significant bits are ignored, the next 8 bits are the red
59 * level, the next 8 bits are the green level and the 8 least
60 * significant bits are the blue level. Each row of the LCD uses 1024
61 * words, but only the first 640 pixels are displayed with the other 384
62 * words being ignored. There are 480 rows.
64 #define BYTES_PER_PIXEL 4
65 #define BITS_PER_PIXEL (BYTES_PER_PIXEL * 8)
68 #define XRES_VIRTUAL 1024
69 #define YRES_VIRTUAL YRES
70 #define LINE_LENGTH (XRES_VIRTUAL * BYTES_PER_PIXEL)
71 #define FB_SIZE (YRES_VIRTUAL * LINE_LENGTH)
77 #define PALETTE_ENTRIES_NO 16 /* passed to fb_alloc_cmap() */
80 * Here are the default fb_fix_screeninfo and fb_var_screeninfo structures
82 static struct fb_fix_screeninfo xilinx_fb_fix = {
84 .type = FB_TYPE_PACKED_PIXELS,
85 .visual = FB_VISUAL_TRUECOLOR,
87 .line_length = LINE_LENGTH,
88 .accel = FB_ACCEL_NONE
91 static struct fb_var_screeninfo xilinx_fb_var = {
94 .xres_virtual = XRES_VIRTUAL,
95 .yres_virtual = YRES_VIRTUAL,
97 .bits_per_pixel = BITS_PER_PIXEL,
99 .red = { RED_SHIFT, 8, 0 },
100 .green = { GREEN_SHIFT, 8, 0 },
101 .blue = { BLUE_SHIFT, 8, 0 },
102 .transp = { 0, 0, 0 },
104 .activate = FB_ACTIVATE_NOW
107 struct xilinxfb_drvdata {
109 struct fb_info info; /* FB driver info record */
111 u32 regs_phys; /* phys. address of the control registers */
112 u32 __iomem *regs; /* virt. address of the control registers */
114 unsigned char __iomem *fb_virt; /* virt. address of the frame buffer */
115 dma_addr_t fb_phys; /* phys. address of the frame buffer */
117 u32 reg_ctrl_default;
119 u32 pseudo_palette[PALETTE_ENTRIES_NO];
120 /* Fake palette of 16 colors */
123 #define to_xilinxfb_drvdata(_info) \
124 container_of(_info, struct xilinxfb_drvdata, info)
127 * The LCD controller has DCR interface to its registers, but all
128 * the boards and configurations the driver has been tested with
129 * use opb2dcr bridge. So the registers are seen as memory mapped.
130 * This macro is to make it simple to add the direct DCR access
133 #define xilinx_fb_out_be32(driverdata, offset, val) \
134 out_be32(driverdata->regs + offset, val)
137 xilinx_fb_setcolreg(unsigned regno, unsigned red, unsigned green, unsigned blue,
138 unsigned transp, struct fb_info *fbi)
140 u32 *palette = fbi->pseudo_palette;
142 if (regno >= PALETTE_ENTRIES_NO)
145 if (fbi->var.grayscale) {
146 /* Convert color to grayscale.
147 * grayscale = 0.30*R + 0.59*G + 0.11*B */
149 (red * 77 + green * 151 + blue * 28 + 127) >> 8;
152 /* fbi->fix.visual is always FB_VISUAL_TRUECOLOR */
154 /* We only handle 8 bits of each color. */
158 palette[regno] = (red << RED_SHIFT) | (green << GREEN_SHIFT) |
159 (blue << BLUE_SHIFT);
165 xilinx_fb_blank(int blank_mode, struct fb_info *fbi)
167 struct xilinxfb_drvdata *drvdata = to_xilinxfb_drvdata(fbi);
169 switch (blank_mode) {
170 case FB_BLANK_UNBLANK:
172 xilinx_fb_out_be32(drvdata, REG_CTRL, drvdata->reg_ctrl_default);
175 case FB_BLANK_NORMAL:
176 case FB_BLANK_VSYNC_SUSPEND:
177 case FB_BLANK_HSYNC_SUSPEND:
178 case FB_BLANK_POWERDOWN:
180 xilinx_fb_out_be32(drvdata, REG_CTRL, 0);
185 return 0; /* success */
188 static struct fb_ops xilinxfb_ops =
190 .owner = THIS_MODULE,
191 .fb_setcolreg = xilinx_fb_setcolreg,
192 .fb_blank = xilinx_fb_blank,
193 .fb_fillrect = cfb_fillrect,
194 .fb_copyarea = cfb_copyarea,
195 .fb_imageblit = cfb_imageblit,
198 /* === The device driver === */
201 xilinxfb_drv_probe(struct device *dev)
203 struct platform_device *pdev;
204 struct xilinxfb_platform_data *pdata;
205 struct xilinxfb_drvdata *drvdata;
206 struct resource *regs_res;
212 pdev = to_platform_device(dev);
213 pdata = pdev->dev.platform_data;
215 drvdata = kzalloc(sizeof(*drvdata), GFP_KERNEL);
217 printk(KERN_ERR "Couldn't allocate device private record\n");
220 dev_set_drvdata(dev, drvdata);
222 /* Map the control registers in */
223 regs_res = platform_get_resource(pdev, IORESOURCE_IO, 0);
224 if (!regs_res || (regs_res->end - regs_res->start + 1 < 8)) {
225 printk(KERN_ERR "Couldn't get registers resource\n");
230 if (!request_mem_region(regs_res->start, 8, DRIVER_NAME)) {
232 "Couldn't lock memory region at 0x%08X\n",
237 drvdata->regs = (u32 __iomem*) ioremap(regs_res->start, 8);
238 drvdata->regs_phys = regs_res->start;
240 /* Allocate the framebuffer memory */
241 drvdata->fb_virt = dma_alloc_coherent(dev, PAGE_ALIGN(FB_SIZE),
242 &drvdata->fb_phys, GFP_KERNEL);
243 if (!drvdata->fb_virt) {
244 printk(KERN_ERR "Could not allocate frame buffer memory\n");
249 /* Clear (turn to black) the framebuffer */
250 memset_io((void *) drvdata->fb_virt, 0, FB_SIZE);
252 /* Tell the hardware where the frame buffer is */
253 xilinx_fb_out_be32(drvdata, REG_FB_ADDR, drvdata->fb_phys);
255 /* Turn on the display */
256 drvdata->reg_ctrl_default = REG_CTRL_ENABLE;
257 if (pdata && pdata->rotate_screen)
258 drvdata->reg_ctrl_default |= REG_CTRL_ROTATE;
259 xilinx_fb_out_be32(drvdata, REG_CTRL, drvdata->reg_ctrl_default);
261 /* Fill struct fb_info */
262 drvdata->info.device = dev;
263 drvdata->info.screen_base = drvdata->fb_virt;
264 drvdata->info.fbops = &xilinxfb_ops;
265 drvdata->info.fix = xilinx_fb_fix;
266 drvdata->info.fix.smem_start = drvdata->fb_phys;
267 drvdata->info.pseudo_palette = drvdata->pseudo_palette;
269 if (fb_alloc_cmap(&drvdata->info.cmap, PALETTE_ENTRIES_NO, 0) < 0) {
270 printk(KERN_ERR "Fail to allocate colormap (%d entries)\n",
276 drvdata->info.flags = FBINFO_DEFAULT;
278 xilinx_fb_var.height = pdata->screen_height_mm;
279 xilinx_fb_var.width = pdata->screen_width_mm;
281 drvdata->info.var = xilinx_fb_var;
283 /* Register new frame buffer */
284 if (register_framebuffer(&drvdata->info) < 0) {
285 printk(KERN_ERR "Could not register frame buffer\n");
290 return 0; /* success */
293 fb_dealloc_cmap(&drvdata->info.cmap);
296 dma_free_coherent(dev, PAGE_ALIGN(FB_SIZE), drvdata->fb_virt,
299 /* Turn off the display */
300 xilinx_fb_out_be32(drvdata, REG_CTRL, 0);
301 iounmap(drvdata->regs);
304 release_mem_region(regs_res->start, 8);
308 dev_set_drvdata(dev, NULL);
314 xilinxfb_drv_remove(struct device *dev)
316 struct xilinxfb_drvdata *drvdata;
321 drvdata = (struct xilinxfb_drvdata *) dev_get_drvdata(dev);
323 #if !defined(CONFIG_FRAMEBUFFER_CONSOLE) && defined(CONFIG_LOGO)
324 xilinx_fb_blank(VESA_POWERDOWN, &drvdata->info);
327 unregister_framebuffer(&drvdata->info);
329 fb_dealloc_cmap(&drvdata->info.cmap);
331 dma_free_coherent(dev, PAGE_ALIGN(FB_SIZE), drvdata->fb_virt,
334 /* Turn off the display */
335 xilinx_fb_out_be32(drvdata, REG_CTRL, 0);
336 iounmap(drvdata->regs);
338 release_mem_region(drvdata->regs_phys, 8);
341 dev_set_drvdata(dev, NULL);
347 static struct device_driver xilinxfb_driver = {
349 .bus = &platform_bus_type,
351 .probe = xilinxfb_drv_probe,
352 .remove = xilinxfb_drv_remove
359 * No kernel boot options used,
360 * so we just need to register the driver
362 return driver_register(&xilinxfb_driver);
366 xilinxfb_cleanup(void)
368 driver_unregister(&xilinxfb_driver);
371 module_init(xilinxfb_init);
372 module_exit(xilinxfb_cleanup);
374 MODULE_AUTHOR("MontaVista Software, Inc. <source@mvista.com>");
375 MODULE_DESCRIPTION(DRIVER_DESCRIPTION);
376 MODULE_LICENSE("GPL");