blob: c77bcc6ab463c2ce1cfd17abdb813d490c4376bd [file] [log] [blame]
Jaya Kumaraad09e52007-05-08 00:37:43 -07001/*
Jaya Kumar0e27aa32008-04-28 02:15:40 -07002 * linux/drivers/video/hecubafb.c -- FB driver for Hecuba/Apollo controller
Jaya Kumaraad09e52007-05-08 00:37:43 -07003 *
4 * Copyright (C) 2006, Jaya Kumar
5 * This work was sponsored by CIS(M) Sdn Bhd
6 *
7 * This file is subject to the terms and conditions of the GNU General Public
8 * License. See the file COPYING in the main directory of this archive for
9 * more details.
10 *
11 * Layout is based on skeletonfb.c by James Simmons and Geert Uytterhoeven.
12 * This work was possible because of apollo display code from E-Ink's website
13 * http://support.eink.com/community
14 * All information used to write this code is from public material made
15 * available by E-Ink on its support site. Some commands such as 0xA4
16 * were found by looping through cmd=0x00 thru 0xFF and supplying random
17 * values. There are other commands that the display is capable of,
18 * beyond the 5 used here but they are more complex.
19 *
Jaya Kumar0e27aa32008-04-28 02:15:40 -070020 * This driver is written to be used with the Hecuba display architecture.
21 * The actual display chip is called Apollo and the interface electronics
22 * it needs is called Hecuba.
Jaya Kumaraad09e52007-05-08 00:37:43 -070023 *
Jaya Kumar0e27aa32008-04-28 02:15:40 -070024 * It is intended to be architecture independent. A board specific driver
25 * must be used to perform all the physical IO interactions. An example
26 * is provided as n411.c
Jaya Kumaraad09e52007-05-08 00:37:43 -070027 *
28 */
29
30#include <linux/module.h>
31#include <linux/kernel.h>
32#include <linux/errno.h>
33#include <linux/string.h>
34#include <linux/mm.h>
Jaya Kumaraad09e52007-05-08 00:37:43 -070035#include <linux/vmalloc.h>
36#include <linux/delay.h>
37#include <linux/interrupt.h>
38#include <linux/fb.h>
39#include <linux/init.h>
40#include <linux/platform_device.h>
41#include <linux/list.h>
Krzysztof Helt84902b72007-10-16 01:29:04 -070042#include <linux/uaccess.h>
Jaya Kumaraad09e52007-05-08 00:37:43 -070043
Jaya Kumar0e27aa32008-04-28 02:15:40 -070044#include <video/hecubafb.h>
Jaya Kumaraad09e52007-05-08 00:37:43 -070045
46/* Display specific information */
47#define DPY_W 600
48#define DPY_H 800
49
Jaya Kumaraad09e52007-05-08 00:37:43 -070050static struct fb_fix_screeninfo hecubafb_fix __devinitdata = {
51 .id = "hecubafb",
52 .type = FB_TYPE_PACKED_PIXELS,
53 .visual = FB_VISUAL_MONO01,
54 .xpanstep = 0,
55 .ypanstep = 0,
56 .ywrapstep = 0,
Jaya Kumar0e27aa32008-04-28 02:15:40 -070057 .line_length = DPY_W,
Jaya Kumaraad09e52007-05-08 00:37:43 -070058 .accel = FB_ACCEL_NONE,
59};
60
61static struct fb_var_screeninfo hecubafb_var __devinitdata = {
62 .xres = DPY_W,
63 .yres = DPY_H,
64 .xres_virtual = DPY_W,
65 .yres_virtual = DPY_H,
66 .bits_per_pixel = 1,
67 .nonstd = 1,
68};
69
Jaya Kumar0e27aa32008-04-28 02:15:40 -070070/* main hecubafb functions */
Jaya Kumaraad09e52007-05-08 00:37:43 -070071
Adrian Bunk9a268a62007-05-08 00:37:45 -070072static void apollo_send_data(struct hecubafb_par *par, unsigned char data)
Jaya Kumaraad09e52007-05-08 00:37:43 -070073{
74 /* set data */
Jaya Kumar0e27aa32008-04-28 02:15:40 -070075 par->board->set_data(par, data);
Jaya Kumaraad09e52007-05-08 00:37:43 -070076
77 /* set DS low */
Jaya Kumar0e27aa32008-04-28 02:15:40 -070078 par->board->set_ctl(par, HCB_DS_BIT, 0);
Jaya Kumaraad09e52007-05-08 00:37:43 -070079
Jaya Kumar0e27aa32008-04-28 02:15:40 -070080 /* wait for ack */
81 par->board->wait_for_ack(par, 0);
Jaya Kumaraad09e52007-05-08 00:37:43 -070082
83 /* set DS hi */
Jaya Kumar0e27aa32008-04-28 02:15:40 -070084 par->board->set_ctl(par, HCB_DS_BIT, 1);
Jaya Kumaraad09e52007-05-08 00:37:43 -070085
Jaya Kumar0e27aa32008-04-28 02:15:40 -070086 /* wait for ack to clear */
87 par->board->wait_for_ack(par, 1);
Jaya Kumaraad09e52007-05-08 00:37:43 -070088}
89
Adrian Bunk9a268a62007-05-08 00:37:45 -070090static void apollo_send_command(struct hecubafb_par *par, unsigned char data)
Jaya Kumaraad09e52007-05-08 00:37:43 -070091{
92 /* command so set CD to high */
Jaya Kumar0e27aa32008-04-28 02:15:40 -070093 par->board->set_ctl(par, HCB_CD_BIT, 1);
Jaya Kumaraad09e52007-05-08 00:37:43 -070094
95 /* actually strobe with command */
96 apollo_send_data(par, data);
97
98 /* clear CD back to low */
Jaya Kumar0e27aa32008-04-28 02:15:40 -070099 par->board->set_ctl(par, HCB_CD_BIT, 0);
Jaya Kumaraad09e52007-05-08 00:37:43 -0700100}
101
Jaya Kumaraad09e52007-05-08 00:37:43 -0700102static void hecubafb_dpy_update(struct hecubafb_par *par)
103{
104 int i;
Antonino A. Daplas28cdf762007-05-08 00:38:50 -0700105 unsigned char *buf = (unsigned char __force *)par->info->screen_base;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700106
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700107 apollo_send_command(par, APOLLO_START_NEW_IMG);
Jaya Kumaraad09e52007-05-08 00:37:43 -0700108
109 for (i=0; i < (DPY_W*DPY_H/8); i++) {
110 apollo_send_data(par, *(buf++));
111 }
112
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700113 apollo_send_command(par, APOLLO_STOP_IMG_DATA);
114 apollo_send_command(par, APOLLO_DISPLAY_IMG);
Jaya Kumaraad09e52007-05-08 00:37:43 -0700115}
116
117/* this is called back from the deferred io workqueue */
118static void hecubafb_dpy_deferred_io(struct fb_info *info,
119 struct list_head *pagelist)
120{
121 hecubafb_dpy_update(info->par);
122}
123
124static void hecubafb_fillrect(struct fb_info *info,
125 const struct fb_fillrect *rect)
126{
127 struct hecubafb_par *par = info->par;
128
Antonino A. Daplasd6774932007-05-08 00:39:00 -0700129 sys_fillrect(info, rect);
Jaya Kumaraad09e52007-05-08 00:37:43 -0700130
131 hecubafb_dpy_update(par);
132}
133
134static void hecubafb_copyarea(struct fb_info *info,
135 const struct fb_copyarea *area)
136{
137 struct hecubafb_par *par = info->par;
138
Antonino A. Daplasd6774932007-05-08 00:39:00 -0700139 sys_copyarea(info, area);
Jaya Kumaraad09e52007-05-08 00:37:43 -0700140
141 hecubafb_dpy_update(par);
142}
143
144static void hecubafb_imageblit(struct fb_info *info,
145 const struct fb_image *image)
146{
147 struct hecubafb_par *par = info->par;
148
Antonino A. Daplasd6774932007-05-08 00:39:00 -0700149 sys_imageblit(info, image);
Jaya Kumaraad09e52007-05-08 00:37:43 -0700150
151 hecubafb_dpy_update(par);
152}
153
154/*
155 * this is the slow path from userspace. they can seek and write to
156 * the fb. it's inefficient to do anything less than a full screen draw
157 */
Antonino A. Daplas3f9b0882007-05-08 00:39:02 -0700158static ssize_t hecubafb_write(struct fb_info *info, const char __user *buf,
Jaya Kumaraad09e52007-05-08 00:37:43 -0700159 size_t count, loff_t *ppos)
160{
Jaya Kumar963654a2008-04-28 02:15:37 -0700161 struct hecubafb_par *par = info->par;
162 unsigned long p = *ppos;
163 void *dst;
164 int err = 0;
165 unsigned long total_size;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700166
Jaya Kumar963654a2008-04-28 02:15:37 -0700167 if (info->state != FBINFO_STATE_RUNNING)
168 return -EPERM;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700169
Jaya Kumar963654a2008-04-28 02:15:37 -0700170 total_size = info->fix.smem_len;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700171
Jaya Kumar963654a2008-04-28 02:15:37 -0700172 if (p > total_size)
173 return -EFBIG;
174
175 if (count > total_size) {
176 err = -EFBIG;
177 count = total_size;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700178 }
179
Jaya Kumar963654a2008-04-28 02:15:37 -0700180 if (count + p > total_size) {
181 if (!err)
182 err = -ENOSPC;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700183
Jaya Kumar963654a2008-04-28 02:15:37 -0700184 count = total_size - p;
185 }
186
187 dst = (void __force *) (info->screen_base + p);
188
189 if (copy_from_user(dst, buf, count))
Jaya Kumaraad09e52007-05-08 00:37:43 -0700190 err = -EFAULT;
Jaya Kumar963654a2008-04-28 02:15:37 -0700191
192 if (!err)
193 *ppos += count;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700194
195 hecubafb_dpy_update(par);
196
Jaya Kumar963654a2008-04-28 02:15:37 -0700197 return (err) ? err : count;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700198}
199
200static struct fb_ops hecubafb_ops = {
201 .owner = THIS_MODULE,
Antonino A. Daplas28d45642007-05-08 00:39:06 -0700202 .fb_read = fb_sys_read,
Jaya Kumaraad09e52007-05-08 00:37:43 -0700203 .fb_write = hecubafb_write,
204 .fb_fillrect = hecubafb_fillrect,
205 .fb_copyarea = hecubafb_copyarea,
206 .fb_imageblit = hecubafb_imageblit,
207};
208
209static struct fb_deferred_io hecubafb_defio = {
210 .delay = HZ,
211 .deferred_io = hecubafb_dpy_deferred_io,
212};
213
214static int __devinit hecubafb_probe(struct platform_device *dev)
215{
216 struct fb_info *info;
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700217 struct hecuba_board *board;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700218 int retval = -ENOMEM;
219 int videomemorysize;
220 unsigned char *videomemory;
221 struct hecubafb_par *par;
222
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700223 /* pick up board specific routines */
224 board = dev->dev.platform_data;
225 if (!board)
226 return -EINVAL;
227
228 /* try to count device specific driver, if can't, platform recalls */
229 if (!try_module_get(board->owner))
230 return -ENODEV;
231
Jaya Kumaraad09e52007-05-08 00:37:43 -0700232 videomemorysize = (DPY_W*DPY_H)/8;
233
234 if (!(videomemory = vmalloc(videomemorysize)))
235 return retval;
236
237 memset(videomemory, 0, videomemorysize);
238
239 info = framebuffer_alloc(sizeof(struct hecubafb_par), &dev->dev);
240 if (!info)
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700241 goto err_fballoc;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700242
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700243 info->screen_base = (char __force __iomem *)videomemory;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700244 info->fbops = &hecubafb_ops;
245
246 info->var = hecubafb_var;
247 info->fix = hecubafb_fix;
248 info->fix.smem_len = videomemorysize;
249 par = info->par;
250 par->info = info;
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700251 par->board = board;
252 par->send_command = apollo_send_command;
253 par->send_data = apollo_send_data;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700254
Konrad Rzeszutek Wilka9b5ff92009-12-03 10:31:58 -0500255 info->flags = FBINFO_FLAG_DEFAULT | FBINFO_VIRTFB;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700256
257 info->fbdefio = &hecubafb_defio;
258 fb_deferred_io_init(info);
259
260 retval = register_framebuffer(info);
261 if (retval < 0)
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700262 goto err_fbreg;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700263 platform_set_drvdata(dev, info);
264
265 printk(KERN_INFO
266 "fb%d: Hecuba frame buffer device, using %dK of video memory\n",
267 info->node, videomemorysize >> 10);
268
269 /* this inits the dpy */
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700270 retval = par->board->init(par);
271 if (retval < 0)
272 goto err_fbreg;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700273
274 return 0;
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700275err_fbreg:
Jaya Kumaraad09e52007-05-08 00:37:43 -0700276 framebuffer_release(info);
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700277err_fballoc:
Jaya Kumaraad09e52007-05-08 00:37:43 -0700278 vfree(videomemory);
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700279 module_put(board->owner);
Jaya Kumaraad09e52007-05-08 00:37:43 -0700280 return retval;
281}
282
283static int __devexit hecubafb_remove(struct platform_device *dev)
284{
285 struct fb_info *info = platform_get_drvdata(dev);
286
287 if (info) {
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700288 struct hecubafb_par *par = info->par;
Jaya Kumaraad09e52007-05-08 00:37:43 -0700289 fb_deferred_io_cleanup(info);
290 unregister_framebuffer(info);
Antonino A. Daplas28cdf762007-05-08 00:38:50 -0700291 vfree((void __force *)info->screen_base);
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700292 if (par->board->remove)
293 par->board->remove(par);
294 module_put(par->board->owner);
Jaya Kumaraad09e52007-05-08 00:37:43 -0700295 framebuffer_release(info);
296 }
297 return 0;
298}
299
300static struct platform_driver hecubafb_driver = {
301 .probe = hecubafb_probe,
302 .remove = hecubafb_remove,
303 .driver = {
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700304 .owner = THIS_MODULE,
Jaya Kumaraad09e52007-05-08 00:37:43 -0700305 .name = "hecubafb",
306 },
307};
308
Jaya Kumaraad09e52007-05-08 00:37:43 -0700309static int __init hecubafb_init(void)
310{
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700311 return platform_driver_register(&hecubafb_driver);
Jaya Kumaraad09e52007-05-08 00:37:43 -0700312}
313
314static void __exit hecubafb_exit(void)
315{
Jaya Kumaraad09e52007-05-08 00:37:43 -0700316 platform_driver_unregister(&hecubafb_driver);
317}
318
Jaya Kumaraad09e52007-05-08 00:37:43 -0700319module_init(hecubafb_init);
320module_exit(hecubafb_exit);
321
Jaya Kumar0e27aa32008-04-28 02:15:40 -0700322MODULE_DESCRIPTION("fbdev driver for Hecuba/Apollo controller");
Jaya Kumaraad09e52007-05-08 00:37:43 -0700323MODULE_AUTHOR("Jaya Kumar");
324MODULE_LICENSE("GPL");