2 * Generic linux-input device driver for axis-bearing devices
4 * Copyright (c) 2001 Brian S. Julin
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
16 * Alternatively, this software may be distributed under the terms of the
17 * GNU General Public License ("GPL").
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
30 * HP-HIL Technical Reference Manual. Hewlett Packard Product No. 45918A
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/slab.h>
41 #include <linux/pci_ids.h>
43 #define PREFIX "HIL PTR: "
44 #define HIL_GENERIC_NAME "HIL pointer device"
46 MODULE_AUTHOR("Brian S. Julin <bri@calyx.com>");
47 MODULE_DESCRIPTION(HIL_GENERIC_NAME
" driver");
48 MODULE_LICENSE("Dual BSD/GPL");
51 #define TABLET_SIMULATES_MOUSE /* allow tablet to be used as mouse */
52 #undef TABLET_AUTOADJUST /* auto-adjust valid tablet ranges */
55 #define HIL_PTR_MAX_LENGTH 16
58 struct input_dev
*dev
;
61 /* Input buffer and index for packets from HIL bus. */
62 hil_packet data
[HIL_PTR_MAX_LENGTH
];
63 int idx4
; /* four counts per packet */
65 /* Raw device info records from HIL bus, see hil.h for fields. */
66 char idd
[HIL_PTR_MAX_LENGTH
]; /* DID byte and IDD record */
67 char rsc
[HIL_PTR_MAX_LENGTH
]; /* RSC record */
68 char exd
[HIL_PTR_MAX_LENGTH
]; /* EXD record */
69 char rnm
[HIL_PTR_MAX_LENGTH
+ 1]; /* RNM record + NULL term. */
71 /* Extra device details not contained in struct input_dev. */
72 unsigned int nbtn
, naxes
;
73 unsigned int btnmap
[7];
75 /* Something to sleep around with. */
79 /* Process a complete packet after transfer from the HIL */
80 static void hil_ptr_process_record(struct hil_ptr
*ptr
)
82 struct input_dev
*dev
= ptr
->dev
;
83 hil_packet
*data
= ptr
->data
;
85 int idx
, i
, cnt
, laxis
;
91 if ((p
& ~HIL_CMDCT_POL
) ==
92 (HIL_ERR_INT
| HIL_PKT_CMD
| HIL_CMD_POL
))
94 if ((p
& ~HIL_CMDCT_RPL
) ==
95 (HIL_ERR_INT
| HIL_PKT_CMD
| HIL_CMD_RPL
))
98 /* Not a poll response. See if we are loading config records. */
99 switch (p
& HIL_PKT_DATA_MASK
) {
101 for (i
= 0; i
< idx
; i
++)
102 ptr
->idd
[i
] = ptr
->data
[i
] & HIL_PKT_DATA_MASK
;
103 for (; i
< HIL_PTR_MAX_LENGTH
; i
++)
108 for (i
= 0; i
< idx
; i
++)
109 ptr
->rsc
[i
] = ptr
->data
[i
] & HIL_PKT_DATA_MASK
;
110 for (; i
< HIL_PTR_MAX_LENGTH
; i
++)
115 for (i
= 0; i
< idx
; i
++)
116 ptr
->exd
[i
] = ptr
->data
[i
] & HIL_PKT_DATA_MASK
;
117 for (; i
< HIL_PTR_MAX_LENGTH
; i
++)
122 for (i
= 0; i
< idx
; i
++)
123 ptr
->rnm
[i
] = ptr
->data
[i
] & HIL_PKT_DATA_MASK
;
124 for (; i
< HIL_PTR_MAX_LENGTH
+ 1; i
++)
129 /* These occur when device isn't present */
130 if (p
== (HIL_ERR_INT
| HIL_PKT_CMD
))
132 /* Anything else we'd like to know about. */
133 printk(KERN_WARNING PREFIX
"Device sent unknown record %x\n", p
);
139 if ((p
& HIL_CMDCT_POL
) != idx
- 1) {
140 printk(KERN_WARNING PREFIX
141 "Malformed poll packet %x (idx = %i)\n", p
, idx
);
145 i
= (ptr
->data
[0] & HIL_POL_AXIS_ALT
) ? 3 : 0;
146 laxis
= ptr
->data
[0] & HIL_POL_NUM_AXES_MASK
;
149 ax16
= ptr
->idd
[1] & HIL_IDD_HEADER_16BIT
; /* 8 or 16bit resolution */
150 absdev
= ptr
->idd
[1] & HIL_IDD_HEADER_ABS
;
152 for (cnt
= 1; i
< laxis
; i
++) {
153 unsigned int lo
,hi
,val
;
154 lo
= ptr
->data
[cnt
++] & HIL_PKT_DATA_MASK
;
155 hi
= ax16
? (ptr
->data
[cnt
++] & HIL_PKT_DATA_MASK
) : 0;
158 #ifdef TABLET_AUTOADJUST
159 if (val
< dev
->absmin
[ABS_X
+ i
])
160 dev
->absmin
[ABS_X
+ i
] = val
;
161 if (val
> dev
->absmax
[ABS_X
+ i
])
162 dev
->absmax
[ABS_X
+ i
] = val
;
164 if (i
%3) val
= dev
->absmax
[ABS_X
+ i
] - val
;
165 input_report_abs(dev
, ABS_X
+ i
, val
);
167 val
= (int) (((int8_t)lo
) | ((int8_t)hi
<<8));
170 input_report_rel(dev
, REL_X
+ i
, val
);
174 while (cnt
< idx
- 1) {
177 btn
= ptr
->data
[cnt
++];
181 continue; /* TODO: proximity == touch? */
183 if ((btn
> 0x8c) || (btn
< 0x80))
185 btn
= (btn
- 0x80) >> 1;
186 btn
= ptr
->btnmap
[btn
];
187 input_report_key(dev
, btn
, !up
);
195 static void hil_ptr_process_err(struct hil_ptr
*ptr
)
197 printk(KERN_WARNING PREFIX
"errored HIL packet\n");
202 static irqreturn_t
hil_ptr_interrupt(struct serio
*serio
,
203 unsigned char data
, unsigned int flags
)
209 ptr
= serio_get_drvdata(serio
);
212 if (ptr
->idx4
>= (HIL_PTR_MAX_LENGTH
* sizeof(hil_packet
))) {
213 hil_ptr_process_err(ptr
);
217 if (!(ptr
->idx4
% 4))
219 packet
= ptr
->data
[idx
];
220 packet
|= ((hil_packet
)data
) << ((3 - (ptr
->idx4
% 4)) * 8);
221 ptr
->data
[idx
] = packet
;
223 /* Records of N 4-byte hil_packets must terminate with a command. */
224 if ((++(ptr
->idx4
)) % 4)
226 if ((packet
& 0xffff0000) != HIL_ERR_INT
) {
227 hil_ptr_process_err(ptr
);
230 if (packet
& HIL_PKT_CMD
)
231 hil_ptr_process_record(ptr
);
236 static void hil_ptr_disconnect(struct serio
*serio
)
240 ptr
= serio_get_drvdata(serio
);
244 input_unregister_device(ptr
->dev
);
248 static int hil_ptr_connect(struct serio
*serio
, struct serio_driver
*driver
)
252 unsigned int i
, naxsets
, btntype
;
255 if (!(ptr
= kzalloc(sizeof(struct hil_ptr
), GFP_KERNEL
)))
258 ptr
->dev
= input_allocate_device();
262 if (serio_open(serio
, driver
))
265 serio_set_drvdata(serio
, ptr
);
268 init_MUTEX_LOCKED(&ptr
->sem
);
270 /* Get device info. MLC driver supplies devid/status/etc. */
271 serio
->write(serio
, 0);
272 serio
->write(serio
, 0);
273 serio
->write(serio
, HIL_PKT_CMD
>> 8);
274 serio
->write(serio
, HIL_CMD_IDD
);
277 serio
->write(serio
, 0);
278 serio
->write(serio
, 0);
279 serio
->write(serio
, HIL_PKT_CMD
>> 8);
280 serio
->write(serio
, HIL_CMD_RSC
);
283 serio
->write(serio
, 0);
284 serio
->write(serio
, 0);
285 serio
->write(serio
, HIL_PKT_CMD
>> 8);
286 serio
->write(serio
, HIL_CMD_RNM
);
289 serio
->write(serio
, 0);
290 serio
->write(serio
, 0);
291 serio
->write(serio
, HIL_PKT_CMD
>> 8);
292 serio
->write(serio
, HIL_CMD_EXD
);
300 if ((did
& HIL_IDD_DID_TYPE_MASK
) == HIL_IDD_DID_TYPE_REL
) {
301 ptr
->dev
->evbit
[0] = BIT_MASK(EV_REL
);
305 if ((did
& HIL_IDD_DID_TYPE_MASK
) == HIL_IDD_DID_TYPE_ABS
) {
306 ptr
->dev
->evbit
[0] = BIT_MASK(EV_ABS
);
309 if (!ptr
->dev
->evbit
[0])
312 ptr
->nbtn
= HIL_IDD_NUM_BUTTONS(idd
);
314 ptr
->dev
->evbit
[0] |= BIT_MASK(EV_KEY
);
316 naxsets
= HIL_IDD_NUM_AXSETS(*idd
);
317 ptr
->naxes
= HIL_IDD_NUM_AXES_PER_SET(*idd
);
319 printk(KERN_INFO PREFIX
"HIL pointer device found (did: 0x%02x, axis: %s)\n",
321 printk(KERN_INFO PREFIX
"HIL pointer has %i buttons and %i sets of %i axes\n",
322 ptr
->nbtn
, naxsets
, ptr
->naxes
);
325 if ((did
& HIL_IDD_DID_ABS_TABLET_MASK
) == HIL_IDD_DID_ABS_TABLET
)
326 #ifdef TABLET_SIMULATES_MOUSE
331 if ((did
& HIL_IDD_DID_ABS_TSCREEN_MASK
) == HIL_IDD_DID_ABS_TSCREEN
)
334 if ((did
& HIL_IDD_DID_REL_MOUSE_MASK
) == HIL_IDD_DID_REL_MOUSE
)
337 for (i
= 0; i
< ptr
->nbtn
; i
++) {
338 set_bit(btntype
| i
, ptr
->dev
->keybit
);
339 ptr
->btnmap
[i
] = btntype
| i
;
342 if (btntype
== BTN_MOUSE
) {
343 /* Swap buttons 2 and 3 */
344 ptr
->btnmap
[1] = BTN_MIDDLE
;
345 ptr
->btnmap
[2] = BTN_RIGHT
;
348 if ((did
& HIL_IDD_DID_TYPE_MASK
) == HIL_IDD_DID_TYPE_REL
) {
349 for (i
= 0; i
< ptr
->naxes
; i
++)
350 set_bit(REL_X
+ i
, ptr
->dev
->relbit
);
351 for (i
= 3; (i
< ptr
->naxes
+ 3) && (naxsets
> 1); i
++)
352 set_bit(REL_X
+ i
, ptr
->dev
->relbit
);
354 for (i
= 0; i
< ptr
->naxes
; i
++) {
355 set_bit(ABS_X
+ i
, ptr
->dev
->absbit
);
356 ptr
->dev
->absmin
[ABS_X
+ i
] = 0;
357 ptr
->dev
->absmax
[ABS_X
+ i
] =
358 HIL_IDD_AXIS_MAX((ptr
->idd
+ 1), i
);
360 for (i
= 3; (i
< ptr
->naxes
+ 3) && (naxsets
> 1); i
++) {
361 set_bit(ABS_X
+ i
, ptr
->dev
->absbit
);
362 ptr
->dev
->absmin
[ABS_X
+ i
] = 0;
363 ptr
->dev
->absmax
[ABS_X
+ i
] =
364 HIL_IDD_AXIS_MAX((ptr
->idd
+ 1), (i
- 3));
366 #ifdef TABLET_AUTOADJUST
367 for (i
= 0; i
< ABS_MAX
; i
++) {
368 int diff
= ptr
->dev
->absmax
[ABS_X
+ i
] / 10;
369 ptr
->dev
->absmin
[ABS_X
+ i
] += diff
;
370 ptr
->dev
->absmax
[ABS_X
+ i
] -= diff
;
375 ptr
->dev
->name
= strlen(ptr
->rnm
) ? ptr
->rnm
: HIL_GENERIC_NAME
;
377 ptr
->dev
->id
.bustype
= BUS_HIL
;
378 ptr
->dev
->id
.vendor
= PCI_VENDOR_ID_HP
;
379 ptr
->dev
->id
.product
= 0x0001; /* TODO: get from ptr->rsc */
380 ptr
->dev
->id
.version
= 0x0100; /* TODO: get from ptr->rsc */
381 ptr
->dev
->dev
.parent
= &serio
->dev
;
383 input_register_device(ptr
->dev
);
384 printk(KERN_INFO
"input: %s (%s), ID: %d\n",
386 (btntype
== BTN_MOUSE
) ? "HIL mouse":"HIL tablet or touchpad",
393 input_free_device(ptr
->dev
);
396 serio_set_drvdata(serio
, NULL
);
400 static struct serio_device_id hil_ptr_ids
[] = {
402 .type
= SERIO_HIL_MLC
,
410 static struct serio_driver hil_ptr_serio_driver
= {
414 .description
= "HP HIL mouse/tablet driver",
415 .id_table
= hil_ptr_ids
,
416 .connect
= hil_ptr_connect
,
417 .disconnect
= hil_ptr_disconnect
,
418 .interrupt
= hil_ptr_interrupt
421 static int __init
hil_ptr_init(void)
423 return serio_register_driver(&hil_ptr_serio_driver
);
426 static void __exit
hil_ptr_exit(void)
428 serio_unregister_driver(&hil_ptr_serio_driver
);
431 module_init(hil_ptr_init
);
432 module_exit(hil_ptr_exit
);