]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - drivers/input/tablet/gtco.c
UBUNTU: Ubuntu-5.4.0-117.132
[mirror_ubuntu-focal-kernel.git] / drivers / input / tablet / gtco.c
CommitLineData
a19ceb56
JR
1/* -*- linux-c -*-
2
3GTCO digitizer USB driver
4
a19ceb56
JR
5TO CHECK: Is pressure done right on report 5?
6
7Copyright (C) 2006 GTCO CalComp
8
9This program is free software; you can redistribute it and/or
10modify it under the terms of the GNU General Public License
11as published by the Free Software Foundation; version 2
12of the License.
13
14This program is distributed in the hope that it will be useful,
15but WITHOUT ANY WARRANTY; without even the implied warranty of
16MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17GNU General Public License for more details.
18
19You should have received a copy of the GNU General Public License
20along with this program; if not, write to the Free Software
21Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22
23Permission to use, copy, modify, distribute, and sell this software and its
24documentation for any purpose is hereby granted without fee, provided that
25the above copyright notice appear in all copies and that both that
26copyright notice and this permission notice appear in supporting
27documentation, and that the name of GTCO-CalComp not be used in advertising
28or publicity pertaining to distribution of the software without specific,
29written prior permission. GTCO-CalComp makes no representations about the
30suitability of this software for any purpose. It is provided "as is"
31without express or implied warranty.
32
33GTCO-CALCOMP DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
34INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
35EVENT SHALL GTCO-CALCOMP BE LIABLE FOR ANY SPECIAL, INDIRECT OR
36CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
37DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
38TORTIOUS ACTIONS, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
39PERFORMANCE OF THIS SOFTWARE.
40
41GTCO CalComp, Inc.
427125 Riverwood Drive
43Columbia, MD 21046
44
45Jeremy Roberson jroberson@gtcocalcomp.com
46Scott Hill shill@gtcocalcomp.com
47*/
48
49
50
51/*#define DEBUG*/
52
53#include <linux/kernel.h>
54#include <linux/module.h>
55#include <linux/errno.h>
a19ceb56
JR
56#include <linux/slab.h>
57#include <linux/input.h>
58#include <linux/usb.h>
7c0f6ba6 59#include <linux/uaccess.h>
a19ceb56
JR
60#include <asm/unaligned.h>
61#include <asm/byteorder.h>
8d212820 62#include <linux/bitops.h>
a19ceb56 63
a19ceb56
JR
64#include <linux/usb/input.h>
65
66/* Version with a Major number of 2 is for kernel inclusion only. */
67#define GTCO_VERSION "2.00.0006"
68
69
70/* MACROS */
71
72#define VENDOR_ID_GTCO 0x078C
73#define PID_400 0x400
74#define PID_401 0x401
75#define PID_1000 0x1000
76#define PID_1001 0x1001
77#define PID_1002 0x1002
78
79/* Max size of a single report */
80#define REPORT_MAX_SIZE 10
2a017fd8 81#define MAX_COLLECTION_LEVELS 10
a19ceb56
JR
82
83
84/* Bitmask whether pen is in range */
85#define MASK_INRANGE 0x20
86#define MASK_BUTTON 0x01F
87
88#define PATHLENGTH 64
89
90/* DATA STRUCTURES */
91
92/* Device table */
9cb3ce52 93static const struct usb_device_id gtco_usbid_table[] = {
a19ceb56
JR
94 { USB_DEVICE(VENDOR_ID_GTCO, PID_400) },
95 { USB_DEVICE(VENDOR_ID_GTCO, PID_401) },
96 { USB_DEVICE(VENDOR_ID_GTCO, PID_1000) },
97 { USB_DEVICE(VENDOR_ID_GTCO, PID_1001) },
98 { USB_DEVICE(VENDOR_ID_GTCO, PID_1002) },
99 { }
100};
101MODULE_DEVICE_TABLE (usb, gtco_usbid_table);
102
103
104/* Structure to hold all of our device specific stuff */
105struct gtco {
106
107 struct input_dev *inputdevice; /* input device struct pointer */
27c2597d 108 struct usb_interface *intf; /* the usb interface for this device */
a19ceb56
JR
109 struct urb *urbinfo; /* urb for incoming reports */
110 dma_addr_t buf_dma; /* dma addr of the data buffer*/
111 unsigned char * buffer; /* databuffer for reports */
112
113 char usbpath[PATHLENGTH];
114 int openCount;
115
116 /* Information pulled from Report Descriptor */
117 u32 usage;
118 u32 min_X;
119 u32 max_X;
120 u32 min_Y;
121 u32 max_Y;
122 s8 mintilt_X;
123 s8 maxtilt_X;
124 s8 mintilt_Y;
125 s8 maxtilt_Y;
126 u32 maxpressure;
127 u32 minpressure;
128};
129
130
131
132/* Code for parsing the HID REPORT DESCRIPTOR */
133
134/* From HID1.11 spec */
135struct hid_descriptor
136{
137 struct usb_descriptor_header header;
138 __le16 bcdHID;
139 u8 bCountryCode;
140 u8 bNumDescriptors;
141 u8 bDescriptorType;
142 __le16 wDescriptorLength;
143} __attribute__ ((packed));
144
145
146#define HID_DESCRIPTOR_SIZE 9
147#define HID_DEVICE_TYPE 33
148#define REPORT_DEVICE_TYPE 34
149
150
151#define PREF_TAG(x) ((x)>>4)
152#define PREF_TYPE(x) ((x>>2)&0x03)
153#define PREF_SIZE(x) ((x)&0x03)
154
155#define TYPE_MAIN 0
156#define TYPE_GLOBAL 1
157#define TYPE_LOCAL 2
158#define TYPE_RESERVED 3
159
160#define TAG_MAIN_INPUT 0x8
161#define TAG_MAIN_OUTPUT 0x9
162#define TAG_MAIN_FEATURE 0xB
163#define TAG_MAIN_COL_START 0xA
164#define TAG_MAIN_COL_END 0xC
165
166#define TAG_GLOB_USAGE 0
167#define TAG_GLOB_LOG_MIN 1
168#define TAG_GLOB_LOG_MAX 2
169#define TAG_GLOB_PHYS_MIN 3
170#define TAG_GLOB_PHYS_MAX 4
171#define TAG_GLOB_UNIT_EXP 5
172#define TAG_GLOB_UNIT 6
173#define TAG_GLOB_REPORT_SZ 7
174#define TAG_GLOB_REPORT_ID 8
175#define TAG_GLOB_REPORT_CNT 9
176#define TAG_GLOB_PUSH 10
177#define TAG_GLOB_POP 11
178
179#define TAG_GLOB_MAX 12
180
181#define DIGITIZER_USAGE_TIP_PRESSURE 0x30
182#define DIGITIZER_USAGE_TILT_X 0x3D
183#define DIGITIZER_USAGE_TILT_Y 0x3E
184
185
186/*
a19ceb56
JR
187 * This is an abbreviated parser for the HID Report Descriptor. We
188 * know what devices we are talking to, so this is by no means meant
189 * to be generic. We can make some safe assumptions:
190 *
191 * - We know there are no LONG tags, all short
192 * - We know that we have no MAIN Feature and MAIN Output items
193 * - We know what the IRQ reports are supposed to look like.
194 *
195 * The main purpose of this is to use the HID report desc to figure
196 * out the mins and maxs of the fields in the IRQ reports. The IRQ
197 * reports for 400/401 change slightly if the max X is bigger than 64K.
198 *
199 */
200static void parse_hid_report_descriptor(struct gtco *device, char * report,
201 int length)
202{
27c2597d 203 struct device *ddev = &device->intf->dev;
1b726a02 204 int x, i = 0;
a19ceb56
JR
205
206 /* Tag primitive vars */
207 __u8 prefix;
208 __u8 size;
209 __u8 tag;
210 __u8 type;
211 __u8 data = 0;
212 __u16 data16 = 0;
213 __u32 data32 = 0;
214
a19ceb56
JR
215 /* For parsing logic */
216 int inputnum = 0;
217 __u32 usage = 0;
218
219 /* Global Values, indexed by TAG */
220 __u32 globalval[TAG_GLOB_MAX];
221 __u32 oldval[TAG_GLOB_MAX];
222
223 /* Debug stuff */
bc95f366 224 char maintype = 'x';
a19ceb56 225 char globtype[12];
1b726a02 226 int indent = 0;
2a017fd8 227 char indentstr[MAX_COLLECTION_LEVELS + 1] = { 0 };
a19ceb56 228
c6f880a7 229 dev_dbg(ddev, "======>>>>>>PARSE<<<<<<======\n");
a19ceb56
JR
230
231 /* Walk this report and pull out the info we need */
1b726a02 232 while (i < length) {
a5082947 233 prefix = report[i++];
a19ceb56
JR
234
235 /* Determine data size and save the data in the proper variable */
a5082947
DT
236 size = (1U << PREF_SIZE(prefix)) >> 1;
237 if (i + size > length) {
238 dev_err(ddev,
239 "Not enough data (need %d, have %d)\n",
240 i + size, length);
241 break;
242 }
243
1b726a02 244 switch (size) {
a19ceb56
JR
245 case 1:
246 data = report[i];
247 break;
248 case 2:
858ad08c 249 data16 = get_unaligned_le16(&report[i]);
a19ceb56 250 break;
a5082947 251 case 4:
858ad08c 252 data32 = get_unaligned_le32(&report[i]);
1b726a02 253 break;
a19ceb56
JR
254 }
255
256 /* Skip size of data */
1b726a02 257 i += size;
a19ceb56
JR
258
259 /* What we do depends on the tag type */
260 tag = PREF_TAG(prefix);
261 type = PREF_TYPE(prefix);
1b726a02 262 switch (type) {
a19ceb56 263 case TYPE_MAIN:
1b726a02
DT
264 strcpy(globtype, "");
265 switch (tag) {
a19ceb56
JR
266
267 case TAG_MAIN_INPUT:
268 /*
269 * The INPUT MAIN tag signifies this is
270 * information from a report. We need to
271 * figure out what it is and store the
272 * min/max values
273 */
274
1b726a02
DT
275 maintype = 'I';
276 if (data == 2)
277 strcpy(globtype, "Variable");
278 else if (data == 3)
279 strcpy(globtype, "Var|Const");
a19ceb56 280
c6f880a7
GKH
281 dev_dbg(ddev, "::::: Saving Report: %d input #%d Max: 0x%X(%d) Min:0x%X(%d) of %d bits\n",
282 globalval[TAG_GLOB_REPORT_ID], inputnum,
283 globalval[TAG_GLOB_LOG_MAX], globalval[TAG_GLOB_LOG_MAX],
284 globalval[TAG_GLOB_LOG_MIN], globalval[TAG_GLOB_LOG_MIN],
285 globalval[TAG_GLOB_REPORT_SZ] * globalval[TAG_GLOB_REPORT_CNT]);
a19ceb56
JR
286
287
288 /*
289 We can assume that the first two input items
290 are always the X and Y coordinates. After
291 that, we look for everything else by
292 local usage value
293 */
1b726a02 294 switch (inputnum) {
a19ceb56 295 case 0: /* X coord */
c6f880a7 296 dev_dbg(ddev, "GER: X Usage: 0x%x\n", usage);
1b726a02 297 if (device->max_X == 0) {
a19ceb56
JR
298 device->max_X = globalval[TAG_GLOB_LOG_MAX];
299 device->min_X = globalval[TAG_GLOB_LOG_MIN];
300 }
a19ceb56 301 break;
1b726a02 302
a19ceb56 303 case 1: /* Y coord */
c6f880a7 304 dev_dbg(ddev, "GER: Y Usage: 0x%x\n", usage);
1b726a02 305 if (device->max_Y == 0) {
a19ceb56
JR
306 device->max_Y = globalval[TAG_GLOB_LOG_MAX];
307 device->min_Y = globalval[TAG_GLOB_LOG_MIN];
308 }
309 break;
1b726a02 310
a19ceb56
JR
311 default:
312 /* Tilt X */
1b726a02
DT
313 if (usage == DIGITIZER_USAGE_TILT_X) {
314 if (device->maxtilt_X == 0) {
a19ceb56
JR
315 device->maxtilt_X = globalval[TAG_GLOB_LOG_MAX];
316 device->mintilt_X = globalval[TAG_GLOB_LOG_MIN];
317 }
318 }
319
320 /* Tilt Y */
1b726a02
DT
321 if (usage == DIGITIZER_USAGE_TILT_Y) {
322 if (device->maxtilt_Y == 0) {
a19ceb56
JR
323 device->maxtilt_Y = globalval[TAG_GLOB_LOG_MAX];
324 device->mintilt_Y = globalval[TAG_GLOB_LOG_MIN];
325 }
326 }
327
a19ceb56 328 /* Pressure */
1b726a02
DT
329 if (usage == DIGITIZER_USAGE_TIP_PRESSURE) {
330 if (device->maxpressure == 0) {
a19ceb56
JR
331 device->maxpressure = globalval[TAG_GLOB_LOG_MAX];
332 device->minpressure = globalval[TAG_GLOB_LOG_MIN];
333 }
334 }
335
336 break;
337 }
338
339 inputnum++;
a19ceb56 340 break;
1b726a02 341
a19ceb56 342 case TAG_MAIN_OUTPUT:
1b726a02 343 maintype = 'O';
a19ceb56 344 break;
1b726a02 345
a19ceb56 346 case TAG_MAIN_FEATURE:
1b726a02 347 maintype = 'F';
a19ceb56 348 break;
1b726a02 349
a19ceb56 350 case TAG_MAIN_COL_START:
1b726a02 351 maintype = 'S';
a19ceb56 352
2a017fd8
GH
353 if (indent == MAX_COLLECTION_LEVELS) {
354 dev_err(ddev, "Collection level %d would exceed limit of %d\n",
355 indent + 1,
356 MAX_COLLECTION_LEVELS);
357 break;
358 }
359
1b726a02 360 if (data == 0) {
c6f880a7 361 dev_dbg(ddev, "======>>>>>> Physical\n");
1b726a02
DT
362 strcpy(globtype, "Physical");
363 } else
c6f880a7 364 dev_dbg(ddev, "======>>>>>>\n");
a19ceb56
JR
365
366 /* Indent the debug output */
367 indent++;
1b726a02
DT
368 for (x = 0; x < indent; x++)
369 indentstr[x] = '-';
370 indentstr[x] = 0;
a19ceb56
JR
371
372 /* Save global tags */
1b726a02 373 for (x = 0; x < TAG_GLOB_MAX; x++)
a19ceb56 374 oldval[x] = globalval[x];
a19ceb56
JR
375
376 break;
1b726a02 377
a19ceb56 378 case TAG_MAIN_COL_END:
1b726a02 379 maintype = 'E';
2a017fd8
GH
380
381 if (indent == 0) {
382 dev_err(ddev, "Collection level already at zero\n");
383 break;
384 }
385
386 dev_dbg(ddev, "<<<<<<======\n");
387
a19ceb56 388 indent--;
1b726a02
DT
389 for (x = 0; x < indent; x++)
390 indentstr[x] = '-';
391 indentstr[x] = 0;
a19ceb56
JR
392
393 /* Copy global tags back */
1b726a02 394 for (x = 0; x < TAG_GLOB_MAX; x++)
a19ceb56 395 globalval[x] = oldval[x];
a19ceb56
JR
396
397 break;
398 }
399
1b726a02 400 switch (size) {
a19ceb56 401 case 1:
c6f880a7
GKH
402 dev_dbg(ddev, "%sMAINTAG:(%d) %c SIZE: %d Data: %s 0x%x\n",
403 indentstr, tag, maintype, size, globtype, data);
a19ceb56 404 break;
1b726a02 405
a19ceb56 406 case 2:
c6f880a7
GKH
407 dev_dbg(ddev, "%sMAINTAG:(%d) %c SIZE: %d Data: %s 0x%x\n",
408 indentstr, tag, maintype, size, globtype, data16);
a19ceb56 409 break;
1b726a02 410
a19ceb56 411 case 4:
c6f880a7
GKH
412 dev_dbg(ddev, "%sMAINTAG:(%d) %c SIZE: %d Data: %s 0x%x\n",
413 indentstr, tag, maintype, size, globtype, data32);
a19ceb56
JR
414 break;
415 }
416 break;
1b726a02 417
a19ceb56 418 case TYPE_GLOBAL:
1b726a02 419 switch (tag) {
a19ceb56
JR
420 case TAG_GLOB_USAGE:
421 /*
422 * First time we hit the global usage tag,
423 * it should tell us the type of device
424 */
1b726a02 425 if (device->usage == 0)
a19ceb56 426 device->usage = data;
1b726a02
DT
427
428 strcpy(globtype, "USAGE");
a19ceb56 429 break;
1b726a02
DT
430
431 case TAG_GLOB_LOG_MIN:
432 strcpy(globtype, "LOG_MIN");
a19ceb56 433 break;
1b726a02
DT
434
435 case TAG_GLOB_LOG_MAX:
436 strcpy(globtype, "LOG_MAX");
a19ceb56 437 break;
1b726a02
DT
438
439 case TAG_GLOB_PHYS_MIN:
440 strcpy(globtype, "PHYS_MIN");
a19ceb56 441 break;
1b726a02
DT
442
443 case TAG_GLOB_PHYS_MAX:
444 strcpy(globtype, "PHYS_MAX");
a19ceb56 445 break;
1b726a02
DT
446
447 case TAG_GLOB_UNIT_EXP:
448 strcpy(globtype, "EXP");
a19ceb56 449 break;
1b726a02
DT
450
451 case TAG_GLOB_UNIT:
452 strcpy(globtype, "UNIT");
a19ceb56 453 break;
1b726a02
DT
454
455 case TAG_GLOB_REPORT_SZ:
456 strcpy(globtype, "REPORT_SZ");
a19ceb56 457 break;
1b726a02
DT
458
459 case TAG_GLOB_REPORT_ID:
460 strcpy(globtype, "REPORT_ID");
a19ceb56 461 /* New report, restart numbering */
1b726a02 462 inputnum = 0;
a19ceb56 463 break;
1b726a02 464
a19ceb56 465 case TAG_GLOB_REPORT_CNT:
1b726a02 466 strcpy(globtype, "REPORT_CNT");
a19ceb56 467 break;
1b726a02
DT
468
469 case TAG_GLOB_PUSH:
470 strcpy(globtype, "PUSH");
a19ceb56 471 break;
1b726a02 472
a19ceb56 473 case TAG_GLOB_POP:
1b726a02 474 strcpy(globtype, "POP");
a19ceb56
JR
475 break;
476 }
477
a19ceb56
JR
478 /* Check to make sure we have a good tag number
479 so we don't overflow array */
1b726a02
DT
480 if (tag < TAG_GLOB_MAX) {
481 switch (size) {
a19ceb56 482 case 1:
c6f880a7
GKH
483 dev_dbg(ddev, "%sGLOBALTAG:%s(%d) SIZE: %d Data: 0x%x\n",
484 indentstr, globtype, tag, size, data);
1b726a02 485 globalval[tag] = data;
a19ceb56 486 break;
1b726a02 487
a19ceb56 488 case 2:
c6f880a7
GKH
489 dev_dbg(ddev, "%sGLOBALTAG:%s(%d) SIZE: %d Data: 0x%x\n",
490 indentstr, globtype, tag, size, data16);
1b726a02 491 globalval[tag] = data16;
a19ceb56 492 break;
1b726a02 493
a19ceb56 494 case 4:
c6f880a7
GKH
495 dev_dbg(ddev, "%sGLOBALTAG:%s(%d) SIZE: %d Data: 0x%x\n",
496 indentstr, globtype, tag, size, data32);
1b726a02 497 globalval[tag] = data32;
a19ceb56
JR
498 break;
499 }
1b726a02 500 } else {
c6f880a7
GKH
501 dev_dbg(ddev, "%sGLOBALTAG: ILLEGAL TAG:%d SIZE: %d\n",
502 indentstr, tag, size);
a19ceb56 503 }
a19ceb56
JR
504 break;
505
506 case TYPE_LOCAL:
1b726a02 507 switch (tag) {
a19ceb56 508 case TAG_GLOB_USAGE:
1b726a02 509 strcpy(globtype, "USAGE");
a19ceb56
JR
510 /* Always 1 byte */
511 usage = data;
512 break;
1b726a02
DT
513
514 case TAG_GLOB_LOG_MIN:
515 strcpy(globtype, "MIN");
a19ceb56 516 break;
1b726a02
DT
517
518 case TAG_GLOB_LOG_MAX:
519 strcpy(globtype, "MAX");
a19ceb56 520 break;
1b726a02 521
a19ceb56 522 default:
1b726a02
DT
523 strcpy(globtype, "UNKNOWN");
524 break;
a19ceb56
JR
525 }
526
1b726a02 527 switch (size) {
a19ceb56 528 case 1:
c6f880a7
GKH
529 dev_dbg(ddev, "%sLOCALTAG:(%d) %s SIZE: %d Data: 0x%x\n",
530 indentstr, tag, globtype, size, data);
a19ceb56 531 break;
1b726a02 532
a19ceb56 533 case 2:
c6f880a7
GKH
534 dev_dbg(ddev, "%sLOCALTAG:(%d) %s SIZE: %d Data: 0x%x\n",
535 indentstr, tag, globtype, size, data16);
a19ceb56 536 break;
1b726a02 537
a19ceb56 538 case 4:
c6f880a7
GKH
539 dev_dbg(ddev, "%sLOCALTAG:(%d) %s SIZE: %d Data: 0x%x\n",
540 indentstr, tag, globtype, size, data32);
a19ceb56
JR
541 break;
542 }
543
544 break;
545 }
a19ceb56 546 }
a19ceb56
JR
547}
548
a19ceb56
JR
549/* INPUT DRIVER Routines */
550
a19ceb56 551/*
1b726a02
DT
552 * Called when opening the input device. This will submit the URB to
553 * the usb system so we start getting reports
a19ceb56
JR
554 */
555static int gtco_input_open(struct input_dev *inputdev)
556{
7791bdae 557 struct gtco *device = input_get_drvdata(inputdev);
a19ceb56 558
ed752e5d 559 device->urbinfo->dev = interface_to_usbdev(device->intf);
1b726a02 560 if (usb_submit_urb(device->urbinfo, GFP_KERNEL))
a19ceb56 561 return -EIO;
1b726a02 562
a19ceb56
JR
563 return 0;
564}
565
1b726a02
DT
566/*
567 * Called when closing the input device. This will unlink the URB
568 */
a19ceb56
JR
569static void gtco_input_close(struct input_dev *inputdev)
570{
7791bdae 571 struct gtco *device = input_get_drvdata(inputdev);
a19ceb56
JR
572
573 usb_kill_urb(device->urbinfo);
a19ceb56
JR
574}
575
576
577/*
578 * Setup input device capabilities. Tell the input system what this
579 * device is capable of generating.
580 *
581 * This information is based on what is read from the HID report and
582 * placed in the struct gtco structure
583 *
584 */
7791bdae 585static void gtco_setup_caps(struct input_dev *inputdev)
a19ceb56 586{
7791bdae 587 struct gtco *device = input_get_drvdata(inputdev);
a19ceb56 588
a19ceb56 589 /* Which events */
7b19ada2
JS
590 inputdev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS) |
591 BIT_MASK(EV_MSC);
a19ceb56 592
a19ceb56 593 /* Misc event menu block */
7b19ada2
JS
594 inputdev->mscbit[0] = BIT_MASK(MSC_SCAN) | BIT_MASK(MSC_SERIAL) |
595 BIT_MASK(MSC_RAW);
a19ceb56 596
a19ceb56
JR
597 /* Absolute values based on HID report info */
598 input_set_abs_params(inputdev, ABS_X, device->min_X, device->max_X,
599 0, 0);
600 input_set_abs_params(inputdev, ABS_Y, device->min_Y, device->max_Y,
601 0, 0);
602
603 /* Proximity */
604 input_set_abs_params(inputdev, ABS_DISTANCE, 0, 1, 0, 0);
605
606 /* Tilt & pressure */
607 input_set_abs_params(inputdev, ABS_TILT_X, device->mintilt_X,
608 device->maxtilt_X, 0, 0);
609 input_set_abs_params(inputdev, ABS_TILT_Y, device->mintilt_Y,
610 device->maxtilt_Y, 0, 0);
611 input_set_abs_params(inputdev, ABS_PRESSURE, device->minpressure,
612 device->maxpressure, 0, 0);
613
a19ceb56 614 /* Transducer */
1b726a02 615 input_set_abs_params(inputdev, ABS_MISC, 0, 0xFF, 0, 0);
a19ceb56
JR
616}
617
a19ceb56
JR
618/* USB Routines */
619
a19ceb56
JR
620/*
621 * URB callback routine. Called when we get IRQ reports from the
622 * digitizer.
623 *
624 * This bridges the USB and input device worlds. It generates events
625 * on the input device based on the USB reports.
626 */
627static void gtco_urb_callback(struct urb *urbinfo)
628{
1b726a02 629 struct gtco *device = urbinfo->context;
a19ceb56
JR
630 struct input_dev *inputdev;
631 int rc;
632 u32 val = 0;
a19ceb56
JR
633 char le_buffer[2];
634
635 inputdev = device->inputdevice;
636
a19ceb56 637 /* Was callback OK? */
1b726a02
DT
638 if (urbinfo->status == -ECONNRESET ||
639 urbinfo->status == -ENOENT ||
640 urbinfo->status == -ESHUTDOWN) {
a19ceb56
JR
641
642 /* Shutdown is occurring. Return and don't queue up any more */
643 return;
644 }
645
1b726a02
DT
646 if (urbinfo->status != 0) {
647 /*
648 * Some unknown error. Hopefully temporary. Just go and
649 * requeue an URB
650 */
a19ceb56
JR
651 goto resubmit;
652 }
653
654 /*
655 * Good URB, now process
656 */
657
658 /* PID dependent when we interpret the report */
1b726a02
DT
659 if (inputdev->id.product == PID_1000 ||
660 inputdev->id.product == PID_1001 ||
661 inputdev->id.product == PID_1002) {
a19ceb56
JR
662
663 /*
664 * Switch on the report ID
665 * Conveniently, the reports have more information, the higher
666 * the report number. We can just fall through the case
667 * statements if we start with the highest number report
668 */
1b726a02 669 switch (device->buffer[0]) {
a19ceb56
JR
670 case 5:
671 /* Pressure is 9 bits */
1b726a02 672 val = ((u16)(device->buffer[8]) << 1);
a19ceb56
JR
673 val |= (u16)(device->buffer[7] >> 7);
674 input_report_abs(inputdev, ABS_PRESSURE,
675 device->buffer[8]);
676
677 /* Mask out the Y tilt value used for pressure */
678 device->buffer[7] = (u8)((device->buffer[7]) & 0x7F);
679
a19ceb56
JR
680 /* Fall thru */
681 case 4:
682 /* Tilt */
8d212820
MK
683 input_report_abs(inputdev, ABS_TILT_X,
684 sign_extend32(device->buffer[6], 6));
a19ceb56 685
8d212820
MK
686 input_report_abs(inputdev, ABS_TILT_Y,
687 sign_extend32(device->buffer[7], 6));
a19ceb56
JR
688
689 /* Fall thru */
a19ceb56
JR
690 case 2:
691 case 3:
692 /* Convert buttons, only 5 bits possible */
1b726a02 693 val = (device->buffer[5]) & MASK_BUTTON;
a19ceb56
JR
694
695 /* We don't apply any meaning to the bitmask,
696 just report */
697 input_event(inputdev, EV_MSC, MSC_SERIAL, val);
698
699 /* Fall thru */
700 case 1:
a19ceb56 701 /* All reports have X and Y coords in the same place */
858ad08c 702 val = get_unaligned_le16(&device->buffer[1]);
a19ceb56
JR
703 input_report_abs(inputdev, ABS_X, val);
704
858ad08c 705 val = get_unaligned_le16(&device->buffer[3]);
a19ceb56
JR
706 input_report_abs(inputdev, ABS_Y, val);
707
a19ceb56 708 /* Ditto for proximity bit */
1b726a02 709 val = device->buffer[5] & MASK_INRANGE ? 1 : 0;
a19ceb56
JR
710 input_report_abs(inputdev, ABS_DISTANCE, val);
711
a19ceb56
JR
712 /* Report 1 is an exception to how we handle buttons */
713 /* Buttons are an index, not a bitmask */
1b726a02 714 if (device->buffer[0] == 1) {
a19ceb56 715
1b726a02
DT
716 /*
717 * Convert buttons, 5 bit index
718 * Report value of index set as one,
719 * the rest as 0
720 */
721 val = device->buffer[5] & MASK_BUTTON;
27c2597d 722 dev_dbg(&device->intf->dev,
c6f880a7
GKH
723 "======>>>>>>REPORT 1: val 0x%X(%d)\n",
724 val, val);
a19ceb56
JR
725
726 /*
727 * We don't apply any meaning to the button
728 * index, just report it
729 */
730 input_event(inputdev, EV_MSC, MSC_SERIAL, val);
a19ceb56 731 }
a19ceb56 732 break;
1b726a02 733
a19ceb56
JR
734 case 7:
735 /* Menu blocks */
736 input_event(inputdev, EV_MSC, MSC_SCAN,
737 device->buffer[1]);
a19ceb56 738 break;
a19ceb56 739 }
a19ceb56 740 }
1b726a02 741
a19ceb56 742 /* Other pid class */
1b726a02
DT
743 if (inputdev->id.product == PID_400 ||
744 inputdev->id.product == PID_401) {
a19ceb56
JR
745
746 /* Report 2 */
1b726a02 747 if (device->buffer[0] == 2) {
a19ceb56 748 /* Menu blocks */
1b726a02 749 input_event(inputdev, EV_MSC, MSC_SCAN, device->buffer[1]);
a19ceb56
JR
750 }
751
752 /* Report 1 */
1b726a02 753 if (device->buffer[0] == 1) {
a19ceb56
JR
754 char buttonbyte;
755
a19ceb56 756 /* IF X max > 64K, we still a bit from the y report */
1b726a02 757 if (device->max_X > 0x10000) {
a19ceb56 758
1b726a02
DT
759 val = (u16)(((u16)(device->buffer[2] << 8)) | (u8)device->buffer[1]);
760 val |= (u32)(((u8)device->buffer[3] & 0x1) << 16);
a19ceb56
JR
761
762 input_report_abs(inputdev, ABS_X, val);
763
1b726a02
DT
764 le_buffer[0] = (u8)((u8)(device->buffer[3]) >> 1);
765 le_buffer[0] |= (u8)((device->buffer[3] & 0x1) << 7);
a19ceb56 766
1b726a02
DT
767 le_buffer[1] = (u8)(device->buffer[4] >> 1);
768 le_buffer[1] |= (u8)((device->buffer[5] & 0x1) << 7);
a19ceb56 769
858ad08c 770 val = get_unaligned_le16(le_buffer);
a19ceb56
JR
771 input_report_abs(inputdev, ABS_Y, val);
772
a19ceb56
JR
773 /*
774 * Shift the button byte right by one to
775 * make it look like the standard report
776 */
1b726a02
DT
777 buttonbyte = device->buffer[5] >> 1;
778 } else {
a19ceb56 779
858ad08c 780 val = get_unaligned_le16(&device->buffer[1]);
a19ceb56
JR
781 input_report_abs(inputdev, ABS_X, val);
782
858ad08c 783 val = get_unaligned_le16(&device->buffer[3]);
a19ceb56
JR
784 input_report_abs(inputdev, ABS_Y, val);
785
786 buttonbyte = device->buffer[5];
a19ceb56
JR
787 }
788
a19ceb56 789 /* BUTTONS and PROXIMITY */
1b726a02 790 val = buttonbyte & MASK_INRANGE ? 1 : 0;
a19ceb56
JR
791 input_report_abs(inputdev, ABS_DISTANCE, val);
792
793 /* Convert buttons, only 4 bits possible */
1b726a02 794 val = buttonbyte & 0x0F;
a19ceb56 795#ifdef USE_BUTTONS
1b726a02
DT
796 for (i = 0; i < 5; i++)
797 input_report_key(inputdev, BTN_DIGI + i, val & (1 << i));
a19ceb56
JR
798#else
799 /* We don't apply any meaning to the bitmask, just report */
800 input_event(inputdev, EV_MSC, MSC_SERIAL, val);
801#endif
1b726a02 802
a19ceb56
JR
803 /* TRANSDUCER */
804 input_report_abs(inputdev, ABS_MISC, device->buffer[6]);
a19ceb56
JR
805 }
806 }
807
808 /* Everybody gets report ID's */
809 input_event(inputdev, EV_MSC, MSC_RAW, device->buffer[0]);
810
811 /* Sync it up */
812 input_sync(inputdev);
813
814 resubmit:
815 rc = usb_submit_urb(urbinfo, GFP_ATOMIC);
1b726a02 816 if (rc != 0)
27c2597d 817 dev_err(&device->intf->dev,
3bd9597a 818 "usb_submit_urb failed rc=0x%x\n", rc);
a19ceb56
JR
819}
820
821/*
822 * The probe routine. This is called when the kernel find the matching USB
823 * vendor/product. We do the following:
824 *
825 * - Allocate mem for a local structure to manage the device
826 * - Request a HID Report Descriptor from the device and parse it to
827 * find out the device parameters
828 * - Create an input device and assign it attributes
829 * - Allocate an URB so the device can talk to us when the input
830 * queue is open
831 */
832static int gtco_probe(struct usb_interface *usbinterface,
833 const struct usb_device_id *id)
834{
835
1b726a02
DT
836 struct gtco *gtco;
837 struct input_dev *input_dev;
a19ceb56 838 struct hid_descriptor *hid_desc;
501a5250 839 char *report;
1b726a02
DT
840 int result = 0, retry;
841 int error;
a19ceb56 842 struct usb_endpoint_descriptor *endpoint;
ed752e5d 843 struct usb_device *udev = interface_to_usbdev(usbinterface);
a19ceb56
JR
844
845 /* Allocate memory for device structure */
1b726a02
DT
846 gtco = kzalloc(sizeof(struct gtco), GFP_KERNEL);
847 input_dev = input_allocate_device();
848 if (!gtco || !input_dev) {
3bd9597a 849 dev_err(&usbinterface->dev, "No more memory\n");
1b726a02
DT
850 error = -ENOMEM;
851 goto err_free_devs;
a19ceb56
JR
852 }
853
1b726a02
DT
854 /* Set pointer to the input device */
855 gtco->inputdevice = input_dev;
a19ceb56
JR
856
857 /* Save interface information */
27c2597d 858 gtco->intf = usbinterface;
a19ceb56
JR
859
860 /* Allocate some data for incoming reports */
ed752e5d 861 gtco->buffer = usb_alloc_coherent(udev, REPORT_MAX_SIZE,
997ea58e 862 GFP_KERNEL, &gtco->buf_dma);
1b726a02 863 if (!gtco->buffer) {
3bd9597a 864 dev_err(&usbinterface->dev, "No more memory for us buffers\n");
1b726a02
DT
865 error = -ENOMEM;
866 goto err_free_devs;
a19ceb56
JR
867 }
868
869 /* Allocate URB for reports */
1b726a02
DT
870 gtco->urbinfo = usb_alloc_urb(0, GFP_KERNEL);
871 if (!gtco->urbinfo) {
3bd9597a 872 dev_err(&usbinterface->dev, "Failed to allocate URB\n");
f4bc95d7 873 error = -ENOMEM;
1b726a02 874 goto err_free_buf;
a19ceb56
JR
875 }
876
162f98de 877 /* Sanity check that a device has an endpoint */
545ad53c 878 if (usbinterface->cur_altsetting->desc.bNumEndpoints < 1) {
162f98de
VD
879 dev_err(&usbinterface->dev,
880 "Invalid number of endpoints\n");
881 error = -EINVAL;
882 goto err_free_urb;
883 }
884
545ad53c 885 endpoint = &usbinterface->cur_altsetting->endpoint[0].desc;
a19ceb56
JR
886
887 /* Some debug */
c6f880a7
GKH
888 dev_dbg(&usbinterface->dev, "gtco # interfaces: %d\n", usbinterface->num_altsetting);
889 dev_dbg(&usbinterface->dev, "num endpoints: %d\n", usbinterface->cur_altsetting->desc.bNumEndpoints);
890 dev_dbg(&usbinterface->dev, "interface class: %d\n", usbinterface->cur_altsetting->desc.bInterfaceClass);
891 dev_dbg(&usbinterface->dev, "endpoint: attribute:0x%x type:0x%x\n", endpoint->bmAttributes, endpoint->bDescriptorType);
e941da31 892 if (usb_endpoint_xfer_int(endpoint))
c6f880a7 893 dev_dbg(&usbinterface->dev, "endpoint: we have interrupt endpoint\n");
a19ceb56 894
c6f880a7 895 dev_dbg(&usbinterface->dev, "endpoint extra len:%d\n", usbinterface->altsetting[0].extralen);
a19ceb56
JR
896
897 /*
898 * Find the HID descriptor so we can find out the size of the
899 * HID report descriptor
900 */
901 if (usb_get_extra_descriptor(usbinterface->cur_altsetting,
162f98de 902 HID_DEVICE_TYPE, &hid_desc) != 0) {
3bd9597a
GKH
903 dev_err(&usbinterface->dev,
904 "Can't retrieve exta USB descriptor to get hid report descriptor length\n");
1b726a02
DT
905 error = -EIO;
906 goto err_free_urb;
a19ceb56
JR
907 }
908
c6f880a7
GKH
909 dev_dbg(&usbinterface->dev,
910 "Extra descriptor success: type:%d len:%d\n",
911 hid_desc->bDescriptorType, hid_desc->wDescriptorLength);
a19ceb56 912
6b8588f7 913 report = kzalloc(le16_to_cpu(hid_desc->wDescriptorLength), GFP_KERNEL);
1b726a02 914 if (!report) {
3bd9597a 915 dev_err(&usbinterface->dev, "No more memory for report\n");
1b726a02
DT
916 error = -ENOMEM;
917 goto err_free_urb;
a19ceb56
JR
918 }
919
920 /* Couple of tries to get reply */
1b726a02 921 for (retry = 0; retry < 3; retry++) {
ed752e5d
ON
922 result = usb_control_msg(udev,
923 usb_rcvctrlpipe(udev, 0),
a19ceb56
JR
924 USB_REQ_GET_DESCRIPTOR,
925 USB_RECIP_INTERFACE | USB_DIR_IN,
1b726a02 926 REPORT_DEVICE_TYPE << 8,
a19ceb56
JR
927 0, /* interface */
928 report,
6b8588f7 929 le16_to_cpu(hid_desc->wDescriptorLength),
a19ceb56
JR
930 5000); /* 5 secs */
931
c6f880a7 932 dev_dbg(&usbinterface->dev, "usb_control_msg result: %d\n", result);
501a5250
DT
933 if (result == le16_to_cpu(hid_desc->wDescriptorLength)) {
934 parse_hid_report_descriptor(gtco, report, result);
a19ceb56 935 break;
501a5250 936 }
a19ceb56
JR
937 }
938
501a5250
DT
939 kfree(report);
940
a19ceb56 941 /* If we didn't get the report, fail */
6b8588f7 942 if (result != le16_to_cpu(hid_desc->wDescriptorLength)) {
3bd9597a
GKH
943 dev_err(&usbinterface->dev,
944 "Failed to get HID Report Descriptor of size: %d\n",
945 hid_desc->wDescriptorLength);
1b726a02
DT
946 error = -EIO;
947 goto err_free_urb;
a19ceb56
JR
948 }
949
a19ceb56 950 /* Create a device file node */
ed752e5d 951 usb_make_path(udev, gtco->usbpath, sizeof(gtco->usbpath));
1b726a02 952 strlcat(gtco->usbpath, "/input0", sizeof(gtco->usbpath));
a19ceb56
JR
953
954 /* Set Input device functions */
1b726a02
DT
955 input_dev->open = gtco_input_open;
956 input_dev->close = gtco_input_close;
a19ceb56
JR
957
958 /* Set input device information */
1b726a02
DT
959 input_dev->name = "GTCO_CalComp";
960 input_dev->phys = gtco->usbpath;
7791bdae
DT
961
962 input_set_drvdata(input_dev, gtco);
a19ceb56
JR
963
964 /* Now set up all the input device capabilities */
1b726a02 965 gtco_setup_caps(input_dev);
a19ceb56
JR
966
967 /* Set input device required ID information */
ed752e5d 968 usb_to_input_id(udev, &input_dev->id);
c0f82d57 969 input_dev->dev.parent = &usbinterface->dev;
a19ceb56
JR
970
971 /* Setup the URB, it will be posted later on open of input device */
545ad53c 972 endpoint = &usbinterface->cur_altsetting->endpoint[0].desc;
a19ceb56 973
1b726a02 974 usb_fill_int_urb(gtco->urbinfo,
ed752e5d
ON
975 udev,
976 usb_rcvintpipe(udev,
a19ceb56 977 endpoint->bEndpointAddress),
1b726a02 978 gtco->buffer,
a19ceb56
JR
979 REPORT_MAX_SIZE,
980 gtco_urb_callback,
1b726a02 981 gtco,
a19ceb56
JR
982 endpoint->bInterval);
983
1b726a02
DT
984 gtco->urbinfo->transfer_dma = gtco->buf_dma;
985 gtco->urbinfo->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
a19ceb56 986
1b726a02
DT
987 /* Save gtco pointer in USB interface gtco */
988 usb_set_intfdata(usbinterface, gtco);
a19ceb56
JR
989
990 /* All done, now register the input device */
1b726a02
DT
991 error = input_register_device(input_dev);
992 if (error)
993 goto err_free_urb;
a19ceb56 994
a19ceb56
JR
995 return 0;
996
1b726a02
DT
997 err_free_urb:
998 usb_free_urb(gtco->urbinfo);
999 err_free_buf:
ed752e5d 1000 usb_free_coherent(udev, REPORT_MAX_SIZE,
997ea58e 1001 gtco->buffer, gtco->buf_dma);
1b726a02 1002 err_free_devs:
1b726a02
DT
1003 input_free_device(input_dev);
1004 kfree(gtco);
1005 return error;
a19ceb56
JR
1006}
1007
1008/*
1009 * This function is a standard USB function called when the USB device
1010 * is disconnected. We will get rid of the URV, de-register the input
1011 * device, and free up allocated memory
1012 */
1013static void gtco_disconnect(struct usb_interface *interface)
1014{
a19ceb56 1015 /* Grab private device ptr */
1b726a02 1016 struct gtco *gtco = usb_get_intfdata(interface);
ed752e5d 1017 struct usb_device *udev = interface_to_usbdev(interface);
a19ceb56
JR
1018
1019 /* Now reverse all the registration stuff */
1b726a02
DT
1020 if (gtco) {
1021 input_unregister_device(gtco->inputdevice);
1022 usb_kill_urb(gtco->urbinfo);
1023 usb_free_urb(gtco->urbinfo);
ed752e5d 1024 usb_free_coherent(udev, REPORT_MAX_SIZE,
997ea58e 1025 gtco->buffer, gtco->buf_dma);
1b726a02 1026 kfree(gtco);
a19ceb56
JR
1027 }
1028
899ef6e7 1029 dev_info(&interface->dev, "gtco driver disconnected\n");
a19ceb56
JR
1030}
1031
a19ceb56
JR
1032/* STANDARD MODULE LOAD ROUTINES */
1033
1034static struct usb_driver gtco_driverinfo_table = {
1b726a02
DT
1035 .name = "gtco",
1036 .id_table = gtco_usbid_table,
1037 .probe = gtco_probe,
1038 .disconnect = gtco_disconnect,
a19ceb56 1039};
1b726a02 1040
08642e7c 1041module_usb_driver(gtco_driverinfo_table);
a19ceb56 1042
32a676fe 1043MODULE_DESCRIPTION("GTCO digitizer USB driver");
a19ceb56 1044MODULE_LICENSE("GPL");