Linux-libre 2.6.32.42-gnu1
[librecmc/linux-libre.git] / drivers / input / keyboard / hil_kbd.c
1 /*
2  * Generic linux-input device driver for keyboard devices
3  *
4  * Copyright (c) 2001 Brian S. Julin
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions, and the following disclaimer,
12  *    without modification.
13  * 2. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
15  *
16  * Alternatively, this software may be distributed under the terms of the
17  * GNU General Public License ("GPL").
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  *
29  * References:
30  * HP-HIL Technical Reference Manual.  Hewlett Packard Product No. 45918A
31  *
32  */
33
34 #include <linux/hil.h>
35 #include <linux/input.h>
36 #include <linux/serio.h>
37 #include <linux/kernel.h>
38 #include <linux/module.h>
39 #include <linux/init.h>
40 #include <linux/completion.h>
41 #include <linux/slab.h>
42 #include <linux/pci_ids.h>
43
44 #define PREFIX "HIL: "
45
46 MODULE_AUTHOR("Brian S. Julin <bri@calyx.com>");
47 MODULE_DESCRIPTION("HIL keyboard/mouse driver");
48 MODULE_LICENSE("Dual BSD/GPL");
49 MODULE_ALIAS("serio:ty03pr25id00ex*"); /* HIL keyboard */
50 MODULE_ALIAS("serio:ty03pr25id0Fex*"); /* HIL mouse */
51
52 #define HIL_PACKET_MAX_LENGTH 16
53
54 #define HIL_KBD_SET1_UPBIT 0x01
55 #define HIL_KBD_SET1_SHIFT 1
56 static unsigned int hil_kbd_set1[HIL_KEYCODES_SET1_TBLSIZE] __read_mostly =
57         { HIL_KEYCODES_SET1 };
58
59 #define HIL_KBD_SET2_UPBIT 0x01
60 #define HIL_KBD_SET2_SHIFT 1
61 /* Set2 is user defined */
62
63 #define HIL_KBD_SET3_UPBIT 0x80
64 #define HIL_KBD_SET3_SHIFT 0
65 static unsigned int hil_kbd_set3[HIL_KEYCODES_SET3_TBLSIZE] __read_mostly =
66         { HIL_KEYCODES_SET3 };
67
68 static const char hil_language[][16] = { HIL_LOCALE_MAP };
69
70 struct hil_dev {
71         struct input_dev *dev;
72         struct serio *serio;
73
74         /* Input buffer and index for packets from HIL bus. */
75         hil_packet data[HIL_PACKET_MAX_LENGTH];
76         int idx4; /* four counts per packet */
77
78         /* Raw device info records from HIL bus, see hil.h for fields. */
79         char    idd[HIL_PACKET_MAX_LENGTH];     /* DID byte and IDD record */
80         char    rsc[HIL_PACKET_MAX_LENGTH];     /* RSC record */
81         char    exd[HIL_PACKET_MAX_LENGTH];     /* EXD record */
82         char    rnm[HIL_PACKET_MAX_LENGTH + 1]; /* RNM record + NULL term. */
83
84         struct completion cmd_done;
85
86         bool is_pointer;
87         /* Extra device details needed for pointing devices. */
88         unsigned int nbtn, naxes;
89         unsigned int btnmap[7];
90 };
91
92 static bool hil_dev_is_command_response(hil_packet p)
93 {
94         if ((p & ~HIL_CMDCT_POL) == (HIL_ERR_INT | HIL_PKT_CMD | HIL_CMD_POL))
95                 return false;
96
97         if ((p & ~HIL_CMDCT_RPL) == (HIL_ERR_INT | HIL_PKT_CMD | HIL_CMD_RPL))
98                 return false;
99
100         return true;
101 }
102
103 static void hil_dev_handle_command_response(struct hil_dev *dev)
104 {
105         hil_packet p;
106         char *buf;
107         int i, idx;
108
109         idx = dev->idx4 / 4;
110         p = dev->data[idx - 1];
111
112         switch (p & HIL_PKT_DATA_MASK) {
113         case HIL_CMD_IDD:
114                 buf = dev->idd;
115                 break;
116
117         case HIL_CMD_RSC:
118                 buf = dev->rsc;
119                 break;
120
121         case HIL_CMD_EXD:
122                 buf = dev->exd;
123                 break;
124
125         case HIL_CMD_RNM:
126                 dev->rnm[HIL_PACKET_MAX_LENGTH] = 0;
127                 buf = dev->rnm;
128                 break;
129
130         default:
131                 /* These occur when device isn't present */
132                 if (p != (HIL_ERR_INT | HIL_PKT_CMD)) {
133                         /* Anything else we'd like to know about. */
134                         printk(KERN_WARNING PREFIX "Device sent unknown record %x\n", p);
135                 }
136                 goto out;
137         }
138
139         for (i = 0; i < idx; i++)
140                 buf[i] = dev->data[i] & HIL_PKT_DATA_MASK;
141         for (; i < HIL_PACKET_MAX_LENGTH; i++)
142                 buf[i] = 0;
143  out:
144         complete(&dev->cmd_done);
145 }
146
147 static void hil_dev_handle_kbd_events(struct hil_dev *kbd)
148 {
149         struct input_dev *dev = kbd->dev;
150         int idx = kbd->idx4 / 4;
151         int i;
152
153         switch (kbd->data[0] & HIL_POL_CHARTYPE_MASK) {
154         case HIL_POL_CHARTYPE_NONE:
155                 return;
156
157         case HIL_POL_CHARTYPE_ASCII:
158                 for (i = 1; i < idx - 1; i++)
159                         input_report_key(dev, kbd->data[i] & 0x7f, 1);
160                 break;
161
162         case HIL_POL_CHARTYPE_RSVD1:
163         case HIL_POL_CHARTYPE_RSVD2:
164         case HIL_POL_CHARTYPE_BINARY:
165                 for (i = 1; i < idx - 1; i++)
166                         input_report_key(dev, kbd->data[i], 1);
167                 break;
168
169         case HIL_POL_CHARTYPE_SET1:
170                 for (i = 1; i < idx - 1; i++) {
171                         unsigned int key = kbd->data[i];
172                         int up = key & HIL_KBD_SET1_UPBIT;
173
174                         key &= (~HIL_KBD_SET1_UPBIT & 0xff);
175                         key = hil_kbd_set1[key >> HIL_KBD_SET1_SHIFT];
176                         input_report_key(dev, key, !up);
177                 }
178                 break;
179
180         case HIL_POL_CHARTYPE_SET2:
181                 for (i = 1; i < idx - 1; i++) {
182                         unsigned int key = kbd->data[i];
183                         int up = key & HIL_KBD_SET2_UPBIT;
184
185                         key &= (~HIL_KBD_SET1_UPBIT & 0xff);
186                         key = key >> HIL_KBD_SET2_SHIFT;
187                         input_report_key(dev, key, !up);
188                 }
189                 break;
190
191         case HIL_POL_CHARTYPE_SET3:
192                 for (i = 1; i < idx - 1; i++) {
193                         unsigned int key = kbd->data[i];
194                         int up = key & HIL_KBD_SET3_UPBIT;
195
196                         key &= (~HIL_KBD_SET1_UPBIT & 0xff);
197                         key = hil_kbd_set3[key >> HIL_KBD_SET3_SHIFT];
198                         input_report_key(dev, key, !up);
199                 }
200                 break;
201         }
202
203         input_sync(dev);
204 }
205
206 static void hil_dev_handle_ptr_events(struct hil_dev *ptr)
207 {
208         struct input_dev *dev = ptr->dev;
209         int idx = ptr->idx4 / 4;
210         hil_packet p = ptr->data[idx - 1];
211         int i, cnt, laxis;
212         bool absdev, ax16;
213
214         if ((p & HIL_CMDCT_POL) != idx - 1) {
215                 printk(KERN_WARNING PREFIX
216                         "Malformed poll packet %x (idx = %i)\n", p, idx);
217                 return;
218         }
219
220         i = (p & HIL_POL_AXIS_ALT) ? 3 : 0;
221         laxis = (p & HIL_POL_NUM_AXES_MASK) + i;
222
223         ax16 = ptr->idd[1] & HIL_IDD_HEADER_16BIT; /* 8 or 16bit resolution */
224         absdev = ptr->idd[1] & HIL_IDD_HEADER_ABS;
225
226         for (cnt = 1; i < laxis; i++) {
227                 unsigned int lo, hi, val;
228
229                 lo = ptr->data[cnt++] & HIL_PKT_DATA_MASK;
230                 hi = ax16 ? (ptr->data[cnt++] & HIL_PKT_DATA_MASK) : 0;
231
232                 if (absdev) {
233                         val = lo + (hi << 8);
234 #ifdef TABLET_AUTOADJUST
235                         if (val < dev->absmin[ABS_X + i])
236                                 dev->absmin[ABS_X + i] = val;
237                         if (val > dev->absmax[ABS_X + i])
238                                 dev->absmax[ABS_X + i] = val;
239 #endif
240                         if (i%3) val = dev->absmax[ABS_X + i] - val;
241                         input_report_abs(dev, ABS_X + i, val);
242                 } else {
243                         val = (int) (((int8_t)lo) | ((int8_t)hi << 8));
244                         if (i % 3)
245                                 val *= -1;
246                         input_report_rel(dev, REL_X + i, val);
247                 }
248         }
249
250         while (cnt < idx - 1) {
251                 unsigned int btn = ptr->data[cnt++];
252                 int up = btn & 1;
253
254                 btn &= 0xfe;
255                 if (btn == 0x8e)
256                         continue; /* TODO: proximity == touch? */
257                 if (btn > 0x8c || btn < 0x80)
258                         continue;
259                 btn = (btn - 0x80) >> 1;
260                 btn = ptr->btnmap[btn];
261                 input_report_key(dev, btn, !up);
262         }
263
264         input_sync(dev);
265 }
266
267 static void hil_dev_process_err(struct hil_dev *dev)
268 {
269         printk(KERN_WARNING PREFIX "errored HIL packet\n");
270         dev->idx4 = 0;
271         complete(&dev->cmd_done); /* just in case somebody is waiting */
272 }
273
274 static irqreturn_t hil_dev_interrupt(struct serio *serio,
275                                 unsigned char data, unsigned int flags)
276 {
277         struct hil_dev *dev;
278         hil_packet packet;
279         int idx;
280
281         dev = serio_get_drvdata(serio);
282         BUG_ON(dev == NULL);
283
284         if (dev->idx4 >= HIL_PACKET_MAX_LENGTH * sizeof(hil_packet)) {
285                 hil_dev_process_err(dev);
286                 goto out;
287         }
288
289         idx = dev->idx4 / 4;
290         if (!(dev->idx4 % 4))
291                 dev->data[idx] = 0;
292         packet = dev->data[idx];
293         packet |= ((hil_packet)data) << ((3 - (dev->idx4 % 4)) * 8);
294         dev->data[idx] = packet;
295
296         /* Records of N 4-byte hil_packets must terminate with a command. */
297         if ((++dev->idx4 % 4) == 0) {
298                 if ((packet & 0xffff0000) != HIL_ERR_INT) {
299                         hil_dev_process_err(dev);
300                 } else if (packet & HIL_PKT_CMD) {
301                         if (hil_dev_is_command_response(packet))
302                                 hil_dev_handle_command_response(dev);
303                         else if (dev->is_pointer)
304                                 hil_dev_handle_ptr_events(dev);
305                         else
306                                 hil_dev_handle_kbd_events(dev);
307                         dev->idx4 = 0;
308                 }
309         }
310  out:
311         return IRQ_HANDLED;
312 }
313
314 static void hil_dev_disconnect(struct serio *serio)
315 {
316         struct hil_dev *dev = serio_get_drvdata(serio);
317
318         BUG_ON(dev == NULL);
319
320         serio_close(serio);
321         input_unregister_device(dev->dev);
322         serio_set_drvdata(serio, NULL);
323         kfree(dev);
324 }
325
326 static void hil_dev_keyboard_setup(struct hil_dev *kbd)
327 {
328         struct input_dev *input_dev = kbd->dev;
329         uint8_t did = kbd->idd[0];
330         int i;
331
332         input_dev->evbit[0]     = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
333         input_dev->ledbit[0]    = BIT_MASK(LED_NUML) | BIT_MASK(LED_CAPSL) |
334                                   BIT_MASK(LED_SCROLLL);
335
336         for (i = 0; i < 128; i++) {
337                 __set_bit(hil_kbd_set1[i], input_dev->keybit);
338                 __set_bit(hil_kbd_set3[i], input_dev->keybit);
339         }
340         __clear_bit(KEY_RESERVED, input_dev->keybit);
341
342         input_dev->keycodemax   = HIL_KEYCODES_SET1_TBLSIZE;
343         input_dev->keycodesize  = sizeof(hil_kbd_set1[0]);
344         input_dev->keycode      = hil_kbd_set1;
345
346         input_dev->name = strlen(kbd->rnm) ? kbd->rnm : "HIL keyboard";
347         input_dev->phys = "hpkbd/input0";
348
349         printk(KERN_INFO PREFIX "HIL keyboard found (did = 0x%02x, lang = %s)\n",
350                 did, hil_language[did & HIL_IDD_DID_TYPE_KB_LANG_MASK]);
351 }
352
353 static void hil_dev_pointer_setup(struct hil_dev *ptr)
354 {
355         struct input_dev *input_dev = ptr->dev;
356         uint8_t did = ptr->idd[0];
357         uint8_t *idd = ptr->idd + 1;
358         unsigned int naxsets = HIL_IDD_NUM_AXSETS(*idd);
359         unsigned int i, btntype;
360         const char *txt;
361
362         ptr->naxes = HIL_IDD_NUM_AXES_PER_SET(*idd);
363
364         switch (did & HIL_IDD_DID_TYPE_MASK) {
365         case HIL_IDD_DID_TYPE_REL:
366                 input_dev->evbit[0] = BIT_MASK(EV_REL);
367
368                 for (i = 0; i < ptr->naxes; i++)
369                         __set_bit(REL_X + i, input_dev->relbit);
370
371                 for (i = 3; naxsets > 1 && i < ptr->naxes + 3; i++)
372                         __set_bit(REL_X + i, input_dev->relbit);
373
374                 txt = "relative";
375                 break;
376
377         case HIL_IDD_DID_TYPE_ABS:
378                 input_dev->evbit[0] = BIT_MASK(EV_ABS);
379
380                 for (i = 0; i < ptr->naxes; i++)
381                         input_set_abs_params(input_dev, ABS_X + i,
382                                         0, HIL_IDD_AXIS_MAX(idd, i), 0, 0);
383
384                 for (i = 3; naxsets > 1 && i < ptr->naxes + 3; i++)
385                         input_set_abs_params(input_dev, ABS_X + i,
386                                         0, HIL_IDD_AXIS_MAX(idd, i - 3), 0, 0);
387
388 #ifdef TABLET_AUTOADJUST
389                 for (i = 0; i < ABS_MAX; i++) {
390                         int diff = input_dev->absmax[ABS_X + i] / 10;
391                         input_dev->absmin[ABS_X + i] += diff;
392                         input_dev->absmax[ABS_X + i] -= diff;
393                 }
394 #endif
395
396                 txt = "absolute";
397                 break;
398
399         default:
400                 BUG();
401         }
402
403         ptr->nbtn = HIL_IDD_NUM_BUTTONS(idd);
404         if (ptr->nbtn)
405                 input_dev->evbit[0] |= BIT_MASK(EV_KEY);
406
407         btntype = BTN_MISC;
408         if ((did & HIL_IDD_DID_ABS_TABLET_MASK) == HIL_IDD_DID_ABS_TABLET)
409 #ifdef TABLET_SIMULATES_MOUSE
410                 btntype = BTN_TOUCH;
411 #else
412                 btntype = BTN_DIGI;
413 #endif
414         if ((did & HIL_IDD_DID_ABS_TSCREEN_MASK) == HIL_IDD_DID_ABS_TSCREEN)
415                 btntype = BTN_TOUCH;
416
417         if ((did & HIL_IDD_DID_REL_MOUSE_MASK) == HIL_IDD_DID_REL_MOUSE)
418                 btntype = BTN_MOUSE;
419
420         for (i = 0; i < ptr->nbtn; i++) {
421                 __set_bit(btntype | i, input_dev->keybit);
422                 ptr->btnmap[i] = btntype | i;
423         }
424
425         if (btntype == BTN_MOUSE) {
426                 /* Swap buttons 2 and 3 */
427                 ptr->btnmap[1] = BTN_MIDDLE;
428                 ptr->btnmap[2] = BTN_RIGHT;
429         }
430
431         input_dev->name = strlen(ptr->rnm) ? ptr->rnm : "HIL pointer device";
432
433         printk(KERN_INFO PREFIX
434                 "HIL pointer device found (did: 0x%02x, axis: %s)\n",
435                 did, txt);
436         printk(KERN_INFO PREFIX
437                 "HIL pointer has %i buttons and %i sets of %i axes\n",
438                 ptr->nbtn, naxsets, ptr->naxes);
439 }
440
441 static int hil_dev_connect(struct serio *serio, struct serio_driver *drv)
442 {
443         struct hil_dev *dev;
444         struct input_dev *input_dev;
445         uint8_t did, *idd;
446         int error;
447
448         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
449         input_dev = input_allocate_device();
450         if (!dev || !input_dev) {
451                 error = -ENOMEM;
452                 goto bail0;
453         }
454
455         dev->serio = serio;
456         dev->dev = input_dev;
457
458         error = serio_open(serio, drv);
459         if (error)
460                 goto bail0;
461
462         serio_set_drvdata(serio, dev);
463
464         /* Get device info.  MLC driver supplies devid/status/etc. */
465         init_completion(&dev->cmd_done);
466         serio_write(serio, 0);
467         serio_write(serio, 0);
468         serio_write(serio, HIL_PKT_CMD >> 8);
469         serio_write(serio, HIL_CMD_IDD);
470         error = wait_for_completion_killable(&dev->cmd_done);
471         if (error)
472                 goto bail1;
473
474         init_completion(&dev->cmd_done);
475         serio_write(serio, 0);
476         serio_write(serio, 0);
477         serio_write(serio, HIL_PKT_CMD >> 8);
478         serio_write(serio, HIL_CMD_RSC);
479         error = wait_for_completion_killable(&dev->cmd_done);
480         if (error)
481                 goto bail1;
482
483         init_completion(&dev->cmd_done);
484         serio_write(serio, 0);
485         serio_write(serio, 0);
486         serio_write(serio, HIL_PKT_CMD >> 8);
487         serio_write(serio, HIL_CMD_RNM);
488         error = wait_for_completion_killable(&dev->cmd_done);
489         if (error)
490                 goto bail1;
491
492         init_completion(&dev->cmd_done);
493         serio_write(serio, 0);
494         serio_write(serio, 0);
495         serio_write(serio, HIL_PKT_CMD >> 8);
496         serio_write(serio, HIL_CMD_EXD);
497         error = wait_for_completion_killable(&dev->cmd_done);
498         if (error)
499                 goto bail1;
500
501         did = dev->idd[0];
502         idd = dev->idd + 1;
503
504         switch (did & HIL_IDD_DID_TYPE_MASK) {
505         case HIL_IDD_DID_TYPE_KB_INTEGRAL:
506         case HIL_IDD_DID_TYPE_KB_ITF:
507         case HIL_IDD_DID_TYPE_KB_RSVD:
508         case HIL_IDD_DID_TYPE_CHAR:
509                 if (HIL_IDD_NUM_BUTTONS(idd) ||
510                     HIL_IDD_NUM_AXES_PER_SET(*idd)) {
511                         printk(KERN_INFO PREFIX
512                                 "combo devices are not supported.\n");
513                         goto bail1;
514                 }
515
516                 dev->is_pointer = false;
517                 hil_dev_keyboard_setup(dev);
518                 break;
519
520         case HIL_IDD_DID_TYPE_REL:
521         case HIL_IDD_DID_TYPE_ABS:
522                 dev->is_pointer = true;
523                 hil_dev_pointer_setup(dev);
524                 break;
525
526         default:
527                 goto bail1;
528         }
529
530         input_dev->id.bustype   = BUS_HIL;
531         input_dev->id.vendor    = PCI_VENDOR_ID_HP;
532         input_dev->id.product   = 0x0001; /* TODO: get from kbd->rsc */
533         input_dev->id.version   = 0x0100; /* TODO: get from kbd->rsc */
534         input_dev->dev.parent   = &serio->dev;
535
536         if (!dev->is_pointer) {
537                 serio_write(serio, 0);
538                 serio_write(serio, 0);
539                 serio_write(serio, HIL_PKT_CMD >> 8);
540                 /* Enable Keyswitch Autorepeat 1 */
541                 serio_write(serio, HIL_CMD_EK1);
542                 /* No need to wait for completion */
543         }
544
545         error = input_register_device(input_dev);
546         if (error)
547                 goto bail1;
548
549         return 0;
550
551  bail1:
552         serio_close(serio);
553         serio_set_drvdata(serio, NULL);
554  bail0:
555         input_free_device(input_dev);
556         kfree(dev);
557         return error;
558 }
559
560 static struct serio_device_id hil_dev_ids[] = {
561         {
562                 .type = SERIO_HIL_MLC,
563                 .proto = SERIO_HIL,
564                 .id = SERIO_ANY,
565                 .extra = SERIO_ANY,
566         },
567         { 0 }
568 };
569
570 static struct serio_driver hil_serio_drv = {
571         .driver         = {
572                 .name   = "hil_dev",
573         },
574         .description    = "HP HIL keyboard/mouse/tablet driver",
575         .id_table       = hil_dev_ids,
576         .connect        = hil_dev_connect,
577         .disconnect     = hil_dev_disconnect,
578         .interrupt      = hil_dev_interrupt
579 };
580
581 static int __init hil_dev_init(void)
582 {
583         return serio_register_driver(&hil_serio_drv);
584 }
585
586 static void __exit hil_dev_exit(void)
587 {
588         serio_unregister_driver(&hil_serio_drv);
589 }
590
591 module_init(hil_dev_init);
592 module_exit(hil_dev_exit);