added 2.6.29.6 aldebaran kernel
[nao-ulib.git] / kernel / 2.6.29.6-aldebaran-rt / drivers / input / touchscreen / h3600_ts_input.c
blob4d3139e2099d02b6f7bed9432b723fc4b84490e2
1 /*
2 * Copyright (c) 2001 "Crazy" James Simmons jsimmons@transvirtual.com
4 * Sponsored by Transvirtual Technology.
6 * Derived from the code in h3600_ts.[ch] by Charles Flynn
7 */
9 /*
10 * Driver for the h3600 Touch Screen and other Atmel controlled devices.
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 * Should you need to contact me, the author, you can do so by
29 * e-mail - mail your message to <jsimmons@transvirtual.com>.
32 #include <linux/errno.h>
33 #include <linux/kernel.h>
34 #include <linux/module.h>
35 #include <linux/slab.h>
36 #include <linux/input.h>
37 #include <linux/serio.h>
38 #include <linux/init.h>
39 #include <linux/delay.h>
41 /* SA1100 serial defines */
42 #include <mach/hardware.h>
43 #include <mach/irqs.h>
45 #define DRIVER_DESC "H3600 touchscreen driver"
47 MODULE_AUTHOR("James Simmons <jsimmons@transvirtual.com>");
48 MODULE_DESCRIPTION(DRIVER_DESC);
49 MODULE_LICENSE("GPL");
52 * Definitions & global arrays.
55 /* The start and end of frame characters SOF and EOF */
56 #define CHAR_SOF 0x02
57 #define CHAR_EOF 0x03
58 #define FRAME_OVERHEAD 3 /* CHAR_SOF,CHAR_EOF,LENGTH = 3 */
61 Atmel events and response IDs contained in frame.
62 Programmer has no control over these numbers.
63 TODO there are holes - specifically 1,7,0x0a
65 #define VERSION_ID 0 /* Get Version (request/respose) */
66 #define KEYBD_ID 2 /* Keyboard (event) */
67 #define TOUCHS_ID 3 /* Touch Screen (event)*/
68 #define EEPROM_READ_ID 4 /* (request/response) */
69 #define EEPROM_WRITE_ID 5 /* (request/response) */
70 #define THERMAL_ID 6 /* (request/response) */
71 #define NOTIFY_LED_ID 8 /* (request/response) */
72 #define BATTERY_ID 9 /* (request/response) */
73 #define SPI_READ_ID 0x0b /* ( request/response) */
74 #define SPI_WRITE_ID 0x0c /* ( request/response) */
75 #define FLITE_ID 0x0d /* backlight ( request/response) */
76 #define STX_ID 0xa1 /* extension pack status (req/resp) */
78 #define MAX_ID 14
80 #define H3600_MAX_LENGTH 16
81 #define H3600_KEY 0xf
83 #define H3600_SCANCODE_RECORD 1 /* 1 -> record button */
84 #define H3600_SCANCODE_CALENDAR 2 /* 2 -> calendar */
85 #define H3600_SCANCODE_CONTACTS 3 /* 3 -> contact */
86 #define H3600_SCANCODE_Q 4 /* 4 -> Q button */
87 #define H3600_SCANCODE_START 5 /* 5 -> start menu */
88 #define H3600_SCANCODE_UP 6 /* 6 -> up */
89 #define H3600_SCANCODE_RIGHT 7 /* 7 -> right */
90 #define H3600_SCANCODE_LEFT 8 /* 8 -> left */
91 #define H3600_SCANCODE_DOWN 9 /* 9 -> down */
94 * Per-touchscreen data.
96 struct h3600_dev {
97 struct input_dev *dev;
98 struct serio *serio;
99 unsigned char event; /* event ID from packet */
100 unsigned char chksum;
101 unsigned char len;
102 unsigned char idx;
103 unsigned char buf[H3600_MAX_LENGTH];
104 char phys[32];
107 static irqreturn_t action_button_handler(int irq, void *dev_id)
109 int down = (GPLR & GPIO_BITSY_ACTION_BUTTON) ? 0 : 1;
110 struct input_dev *dev = dev_id;
112 input_report_key(dev, KEY_ENTER, down);
113 input_sync(dev);
115 return IRQ_HANDLED;
118 static irqreturn_t npower_button_handler(int irq, void *dev_id)
120 int down = (GPLR & GPIO_BITSY_NPOWER_BUTTON) ? 0 : 1;
121 struct input_dev *dev = dev_id;
124 * This interrupt is only called when we release the key. So we have
125 * to fake a key press.
127 input_report_key(dev, KEY_SUSPEND, 1);
128 input_report_key(dev, KEY_SUSPEND, down);
129 input_sync(dev);
131 return IRQ_HANDLED;
134 #ifdef CONFIG_PM
136 static int flite_brightness = 25;
138 enum flite_pwr {
139 FLITE_PWR_OFF = 0,
140 FLITE_PWR_ON = 1
144 * h3600_flite_power: enables or disables power to frontlight, using last bright */
145 unsigned int h3600_flite_power(struct input_dev *dev, enum flite_pwr pwr)
147 unsigned char brightness = (pwr == FLITE_PWR_OFF) ? 0 : flite_brightness;
148 struct h3600_dev *ts = input_get_drvdata(dev);
150 /* Must be in this order */
151 ts->serio->write(ts->serio, 1);
152 ts->serio->write(ts->serio, pwr);
153 ts->serio->write(ts->serio, brightness);
154 return 0;
157 #endif
160 * This function translates the native event packets to linux input event
161 * packets. Some packets coming from serial are not touchscreen related. In
162 * this case we send them off to be processed elsewhere.
164 static void h3600ts_process_packet(struct h3600_dev *ts)
166 struct input_dev *dev = ts->dev;
167 static int touched = 0;
168 int key, down = 0;
170 switch (ts->event) {
172 Buttons - returned as a single byte
173 7 6 5 4 3 2 1 0
174 S x x x N N N N
176 S switch state ( 0=pressed 1=released)
177 x Unused.
178 NNNN switch number 0-15
180 Note: This is true for non interrupt generated key events.
182 case KEYBD_ID:
183 down = (ts->buf[0] & 0x80) ? 0 : 1;
185 switch (ts->buf[0] & 0x7f) {
186 case H3600_SCANCODE_RECORD:
187 key = KEY_RECORD;
188 break;
189 case H3600_SCANCODE_CALENDAR:
190 key = KEY_PROG1;
191 break;
192 case H3600_SCANCODE_CONTACTS:
193 key = KEY_PROG2;
194 break;
195 case H3600_SCANCODE_Q:
196 key = KEY_Q;
197 break;
198 case H3600_SCANCODE_START:
199 key = KEY_PROG3;
200 break;
201 case H3600_SCANCODE_UP:
202 key = KEY_UP;
203 break;
204 case H3600_SCANCODE_RIGHT:
205 key = KEY_RIGHT;
206 break;
207 case H3600_SCANCODE_LEFT:
208 key = KEY_LEFT;
209 break;
210 case H3600_SCANCODE_DOWN:
211 key = KEY_DOWN;
212 break;
213 default:
214 key = 0;
216 if (key)
217 input_report_key(dev, key, down);
218 break;
220 * Native touchscreen event data is formatted as shown below:-
222 * +-------+-------+-------+-------+
223 * | Xmsb | Xlsb | Ymsb | Ylsb |
224 * +-------+-------+-------+-------+
225 * byte 0 1 2 3
227 case TOUCHS_ID:
228 if (!touched) {
229 input_report_key(dev, BTN_TOUCH, 1);
230 touched = 1;
233 if (ts->len) {
234 unsigned short x, y;
236 x = ts->buf[0]; x <<= 8; x += ts->buf[1];
237 y = ts->buf[2]; y <<= 8; y += ts->buf[3];
239 input_report_abs(dev, ABS_X, x);
240 input_report_abs(dev, ABS_Y, y);
241 } else {
242 input_report_key(dev, BTN_TOUCH, 0);
243 touched = 0;
245 break;
246 default:
247 /* Send a non input event elsewhere */
248 break;
251 input_sync(dev);
255 * h3600ts_event() handles events from the input module.
257 static int h3600ts_event(struct input_dev *dev, unsigned int type,
258 unsigned int code, int value)
260 #if 0
261 struct h3600_dev *ts = input_get_drvdata(dev);
263 switch (type) {
264 case EV_LED: {
265 // ts->serio->write(ts->serio, SOME_CMD);
266 return 0;
269 return -1;
270 #endif
271 return 0;
275 Frame format
276 byte 1 2 3 len + 4
277 +-------+---------------+---------------+--=------------+
278 |SOF |id |len | len bytes | Chksum |
279 +-------+---------------+---------------+--=------------+
280 bit 0 7 8 11 12 15 16
282 +-------+---------------+-------+
283 |SOF |id |0 |Chksum | - Note Chksum does not include SOF
284 +-------+---------------+-------+
285 bit 0 7 8 11 12 15 16
289 static int state;
291 /* decode States */
292 #define STATE_SOF 0 /* start of FRAME */
293 #define STATE_ID 1 /* state where we decode the ID & len */
294 #define STATE_DATA 2 /* state where we decode data */
295 #define STATE_EOF 3 /* state where we decode checksum or EOF */
297 static irqreturn_t h3600ts_interrupt(struct serio *serio, unsigned char data,
298 unsigned int flags)
300 struct h3600_dev *ts = serio_get_drvdata(serio);
303 * We have a new frame coming in.
305 switch (state) {
306 case STATE_SOF:
307 if (data == CHAR_SOF)
308 state = STATE_ID;
309 break;
310 case STATE_ID:
311 ts->event = (data & 0xf0) >> 4;
312 ts->len = (data & 0xf);
313 ts->idx = 0;
314 if (ts->event >= MAX_ID) {
315 state = STATE_SOF;
316 break;
318 ts->chksum = data;
319 state = (ts->len > 0) ? STATE_DATA : STATE_EOF;
320 break;
321 case STATE_DATA:
322 ts->chksum += data;
323 ts->buf[ts->idx]= data;
324 if (++ts->idx == ts->len)
325 state = STATE_EOF;
326 break;
327 case STATE_EOF:
328 state = STATE_SOF;
329 if (data == CHAR_EOF || data == ts->chksum)
330 h3600ts_process_packet(ts);
331 break;
332 default:
333 printk("Error3\n");
334 break;
337 return IRQ_HANDLED;
341 * h3600ts_connect() is the routine that is called when someone adds a
342 * new serio device that supports H3600 protocol and registers it as
343 * an input device.
345 static int h3600ts_connect(struct serio *serio, struct serio_driver *drv)
347 struct h3600_dev *ts;
348 struct input_dev *input_dev;
349 int err;
351 ts = kzalloc(sizeof(struct h3600_dev), GFP_KERNEL);
352 input_dev = input_allocate_device();
353 if (!ts || !input_dev) {
354 err = -ENOMEM;
355 goto fail1;
358 ts->serio = serio;
359 ts->dev = input_dev;
360 snprintf(ts->phys, sizeof(ts->phys), "%s/input0", serio->phys);
362 input_dev->name = "H3600 TouchScreen";
363 input_dev->phys = ts->phys;
364 input_dev->id.bustype = BUS_RS232;
365 input_dev->id.vendor = SERIO_H3600;
366 input_dev->id.product = 0x0666; /* FIXME !!! We can ask the hardware */
367 input_dev->id.version = 0x0100;
368 input_dev->dev.parent = &serio->dev;
370 input_set_drvdata(input_dev, ts);
372 input_dev->event = h3600ts_event;
374 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS) |
375 BIT_MASK(EV_LED) | BIT_MASK(EV_PWR);
376 input_dev->ledbit[0] = BIT_MASK(LED_SLEEP);
377 input_set_abs_params(input_dev, ABS_X, 60, 985, 0, 0);
378 input_set_abs_params(input_dev, ABS_Y, 35, 1024, 0, 0);
380 set_bit(KEY_RECORD, input_dev->keybit);
381 set_bit(KEY_Q, input_dev->keybit);
382 set_bit(KEY_PROG1, input_dev->keybit);
383 set_bit(KEY_PROG2, input_dev->keybit);
384 set_bit(KEY_PROG3, input_dev->keybit);
385 set_bit(KEY_UP, input_dev->keybit);
386 set_bit(KEY_RIGHT, input_dev->keybit);
387 set_bit(KEY_LEFT, input_dev->keybit);
388 set_bit(KEY_DOWN, input_dev->keybit);
389 set_bit(KEY_ENTER, input_dev->keybit);
390 set_bit(KEY_SUSPEND, input_dev->keybit);
391 set_bit(BTN_TOUCH, input_dev->keybit);
393 /* Device specific stuff */
394 set_GPIO_IRQ_edge(GPIO_BITSY_ACTION_BUTTON, GPIO_BOTH_EDGES);
395 set_GPIO_IRQ_edge(GPIO_BITSY_NPOWER_BUTTON, GPIO_RISING_EDGE);
397 if (request_irq(IRQ_GPIO_BITSY_ACTION_BUTTON, action_button_handler,
398 IRQF_SHARED | IRQF_DISABLED, "h3600_action", &ts->dev)) {
399 printk(KERN_ERR "h3600ts.c: Could not allocate Action Button IRQ!\n");
400 err = -EBUSY;
401 goto fail2;
404 if (request_irq(IRQ_GPIO_BITSY_NPOWER_BUTTON, npower_button_handler,
405 IRQF_SHARED | IRQF_DISABLED, "h3600_suspend", &ts->dev)) {
406 printk(KERN_ERR "h3600ts.c: Could not allocate Power Button IRQ!\n");
407 err = -EBUSY;
408 goto fail3;
411 serio_set_drvdata(serio, ts);
413 err = serio_open(serio, drv);
414 if (err)
415 return err;
417 //h3600_flite_control(1, 25); /* default brightness */
418 input_register_device(ts->dev);
420 return 0;
422 fail3: free_irq(IRQ_GPIO_BITSY_NPOWER_BUTTON, ts->dev);
423 fail2: free_irq(IRQ_GPIO_BITSY_ACTION_BUTTON, ts->dev);
424 fail1: serio_set_drvdata(serio, NULL);
425 input_free_device(input_dev);
426 kfree(ts);
427 return err;
431 * h3600ts_disconnect() is the opposite of h3600ts_connect()
434 static void h3600ts_disconnect(struct serio *serio)
436 struct h3600_dev *ts = serio_get_drvdata(serio);
438 free_irq(IRQ_GPIO_BITSY_ACTION_BUTTON, &ts->dev);
439 free_irq(IRQ_GPIO_BITSY_NPOWER_BUTTON, &ts->dev);
440 input_get_device(ts->dev);
441 input_unregister_device(ts->dev);
442 serio_close(serio);
443 serio_set_drvdata(serio, NULL);
444 input_put_device(ts->dev);
445 kfree(ts);
449 * The serio driver structure.
452 static struct serio_device_id h3600ts_serio_ids[] = {
454 .type = SERIO_RS232,
455 .proto = SERIO_H3600,
456 .id = SERIO_ANY,
457 .extra = SERIO_ANY,
459 { 0 }
462 MODULE_DEVICE_TABLE(serio, h3600ts_serio_ids);
464 static struct serio_driver h3600ts_drv = {
465 .driver = {
466 .name = "h3600ts",
468 .description = DRIVER_DESC,
469 .id_table = h3600ts_serio_ids,
470 .interrupt = h3600ts_interrupt,
471 .connect = h3600ts_connect,
472 .disconnect = h3600ts_disconnect,
476 * The functions for inserting/removing us as a module.
479 static int __init h3600ts_init(void)
481 return serio_register_driver(&h3600ts_drv);
484 static void __exit h3600ts_exit(void)
486 serio_unregister_driver(&h3600ts_drv);
489 module_init(h3600ts_init);
490 module_exit(h3600ts_exit);