]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - drivers/input/tablet/aiptek.c
USB: input: aiptek.c: fix up dev_err() usage
[mirror_ubuntu-bionic-kernel.git] / drivers / input / tablet / aiptek.c
1 /*
2 * Native support for the Aiptek HyperPen USB Tablets
3 * (4000U/5000U/6000U/8000U/12000U)
4 *
5 * Copyright (c) 2001 Chris Atenasio <chris@crud.net>
6 * Copyright (c) 2002-2004 Bryan W. Headley <bwheadley@earthlink.net>
7 *
8 * based on wacom.c by
9 * Vojtech Pavlik <vojtech@suse.cz>
10 * Andreas Bach Aaen <abach@stofanet.dk>
11 * Clifford Wolf <clifford@clifford.at>
12 * Sam Mosel <sam.mosel@computer.org>
13 * James E. Blair <corvus@gnu.org>
14 * Daniel Egger <egger@suse.de>
15 *
16 * Many thanks to Oliver Kuechemann for his support.
17 *
18 * ChangeLog:
19 * v0.1 - Initial release
20 * v0.2 - Hack to get around fake event 28's. (Bryan W. Headley)
21 * v0.3 - Make URB dynamic (Bryan W. Headley, Jun-8-2002)
22 * Released to Linux 2.4.19 and 2.5.x
23 * v0.4 - Rewrote substantial portions of the code to deal with
24 * corrected control sequences, timing, dynamic configuration,
25 * support of 6000U - 12000U, procfs, and macro key support
26 * (Jan-1-2003 - Feb-5-2003, Bryan W. Headley)
27 * v1.0 - Added support for diagnostic messages, count of messages
28 * received from URB - Mar-8-2003, Bryan W. Headley
29 * v1.1 - added support for tablet resolution, changed DV and proximity
30 * some corrections - Jun-22-2003, martin schneebacher
31 * - Added support for the sysfs interface, deprecating the
32 * procfs interface for 2.5.x kernel. Also added support for
33 * Wheel command. Bryan W. Headley July-15-2003.
34 * v1.2 - Reworked jitter timer as a kernel thread.
35 * Bryan W. Headley November-28-2003/Jan-10-2004.
36 * v1.3 - Repaired issue of kernel thread going nuts on single-processor
37 * machines, introduced programmableDelay as a command line
38 * parameter. Feb 7 2004, Bryan W. Headley.
39 * v1.4 - Re-wire jitter so it does not require a thread. Courtesy of
40 * Rene van Paassen. Added reporting of physical pointer device
41 * (e.g., stylus, mouse in reports 2, 3, 4, 5. We don't know
42 * for reports 1, 6.)
43 * what physical device reports for reports 1, 6.) Also enabled
44 * MOUSE and LENS tool button modes. Renamed "rubber" to "eraser".
45 * Feb 20, 2004, Bryan W. Headley.
46 * v1.5 - Added previousJitterable, so we don't do jitter delay when the
47 * user is holding a button down for periods of time.
48 *
49 * NOTE:
50 * This kernel driver is augmented by the "Aiptek" XFree86 input
51 * driver for your X server, as well as the Gaiptek GUI Front-end
52 * "Tablet Manager".
53 * These three products are highly interactive with one another,
54 * so therefore it's easier to document them all as one subsystem.
55 * Please visit the project's "home page", located at,
56 * http://aiptektablet.sourceforge.net.
57 *
58 * This program is free software; you can redistribute it and/or modify
59 * it under the terms of the GNU General Public License as published by
60 * the Free Software Foundation; either version 2 of the License, or
61 * (at your option) any later version.
62 *
63 * This program is distributed in the hope that it will be useful,
64 * but WITHOUT ANY WARRANTY; without even the implied warranty of
65 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
66 * GNU General Public License for more details.
67 *
68 * You should have received a copy of the GNU General Public License
69 * along with this program; if not, write to the Free Software
70 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
71 */
72
73 #include <linux/jiffies.h>
74 #include <linux/kernel.h>
75 #include <linux/slab.h>
76 #include <linux/module.h>
77 #include <linux/init.h>
78 #include <linux/usb/input.h>
79 #include <asm/uaccess.h>
80 #include <asm/unaligned.h>
81
82 /*
83 * Version Information
84 */
85 #define DRIVER_VERSION "v2.3 (May 2, 2007)"
86 #define DRIVER_AUTHOR "Bryan W. Headley/Chris Atenasio/Cedric Brun/Rene van Paassen"
87 #define DRIVER_DESC "Aiptek HyperPen USB Tablet Driver (Linux 2.6.x)"
88
89 /*
90 * Aiptek status packet:
91 *
92 * (returned as Report 1 - relative coordinates from mouse and stylus)
93 *
94 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
95 * byte0 0 0 0 0 0 0 0 1
96 * byte1 0 0 0 0 0 BS2 BS Tip
97 * byte2 X7 X6 X5 X4 X3 X2 X1 X0
98 * byte3 Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
99 *
100 * (returned as Report 2 - absolute coordinates from the stylus)
101 *
102 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
103 * byte0 0 0 0 0 0 0 1 0
104 * byte1 X7 X6 X5 X4 X3 X2 X1 X0
105 * byte2 X15 X14 X13 X12 X11 X10 X9 X8
106 * byte3 Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
107 * byte4 Y15 Y14 Y13 Y12 Y11 Y10 Y9 Y8
108 * byte5 * * * BS2 BS1 Tip IR DV
109 * byte6 P7 P6 P5 P4 P3 P2 P1 P0
110 * byte7 P15 P14 P13 P12 P11 P10 P9 P8
111 *
112 * (returned as Report 3 - absolute coordinates from the mouse)
113 *
114 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
115 * byte0 0 0 0 0 0 0 1 1
116 * byte1 X7 X6 X5 X4 X3 X2 X1 X0
117 * byte2 X15 X14 X13 X12 X11 X10 X9 X8
118 * byte3 Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
119 * byte4 Y15 Y14 Y13 Y12 Y11 Y10 Y9 Y8
120 * byte5 * * * BS2 BS1 Tip IR DV
121 * byte6 P7 P6 P5 P4 P3 P2 P1 P0
122 * byte7 P15 P14 P13 P12 P11 P10 P9 P8
123 *
124 * (returned as Report 4 - macrokeys from the stylus)
125 *
126 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
127 * byte0 0 0 0 0 0 1 0 0
128 * byte1 0 0 0 BS2 BS Tip IR DV
129 * byte2 0 0 0 0 0 0 1 0
130 * byte3 0 0 0 K4 K3 K2 K1 K0
131 * byte4 P7 P6 P5 P4 P3 P2 P1 P0
132 * byte5 P15 P14 P13 P12 P11 P10 P9 P8
133 *
134 * (returned as Report 5 - macrokeys from the mouse)
135 *
136 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
137 * byte0 0 0 0 0 0 1 0 1
138 * byte1 0 0 0 BS2 BS Tip IR DV
139 * byte2 0 0 0 0 0 0 1 0
140 * byte3 0 0 0 K4 K3 K2 K1 K0
141 * byte4 P7 P6 P5 P4 P3 P2 P1 P0
142 * byte5 P15 P14 P13 P12 P11 P10 P9 P8
143 *
144 * IR: In Range = Proximity on
145 * DV = Data Valid
146 * BS = Barrel Switch (as in, macro keys)
147 * BS2 also referred to as Tablet Pick
148 *
149 * Command Summary:
150 *
151 * Use report_type CONTROL (3)
152 * Use report_id 2
153 *
154 * Command/Data Description Return Bytes Return Value
155 * 0x10/0x00 SwitchToMouse 0
156 * 0x10/0x01 SwitchToTablet 0
157 * 0x18/0x04 SetResolution 0
158 * 0x12/0xFF AutoGainOn 0
159 * 0x17/0x00 FilterOn 0
160 * 0x01/0x00 GetXExtension 2 MaxX
161 * 0x01/0x01 GetYExtension 2 MaxY
162 * 0x02/0x00 GetModelCode 2 ModelCode = LOBYTE
163 * 0x03/0x00 GetODMCode 2 ODMCode
164 * 0x08/0x00 GetPressureLevels 2 =512
165 * 0x04/0x00 GetFirmwareVersion 2 Firmware Version
166 * 0x11/0x02 EnableMacroKeys 0
167 *
168 * To initialize the tablet:
169 *
170 * (1) Send Resolution500LPI (Command)
171 * (2) Query for Model code (Option Report)
172 * (3) Query for ODM code (Option Report)
173 * (4) Query for firmware (Option Report)
174 * (5) Query for GetXExtension (Option Report)
175 * (6) Query for GetYExtension (Option Report)
176 * (7) Query for GetPressureLevels (Option Report)
177 * (8) SwitchToTablet for Absolute coordinates, or
178 * SwitchToMouse for Relative coordinates (Command)
179 * (9) EnableMacroKeys (Command)
180 * (10) FilterOn (Command)
181 * (11) AutoGainOn (Command)
182 *
183 * (Step 9 can be omitted, but you'll then have no function keys.)
184 */
185
186 #define USB_VENDOR_ID_AIPTEK 0x08ca
187 #define USB_VENDOR_ID_KYE 0x0458
188 #define USB_REQ_GET_REPORT 0x01
189 #define USB_REQ_SET_REPORT 0x09
190
191 /* PointerMode codes
192 */
193 #define AIPTEK_POINTER_ONLY_MOUSE_MODE 0
194 #define AIPTEK_POINTER_ONLY_STYLUS_MODE 1
195 #define AIPTEK_POINTER_EITHER_MODE 2
196
197 #define AIPTEK_POINTER_ALLOW_MOUSE_MODE(a) \
198 (a == AIPTEK_POINTER_ONLY_MOUSE_MODE || \
199 a == AIPTEK_POINTER_EITHER_MODE)
200 #define AIPTEK_POINTER_ALLOW_STYLUS_MODE(a) \
201 (a == AIPTEK_POINTER_ONLY_STYLUS_MODE || \
202 a == AIPTEK_POINTER_EITHER_MODE)
203
204 /* CoordinateMode code
205 */
206 #define AIPTEK_COORDINATE_RELATIVE_MODE 0
207 #define AIPTEK_COORDINATE_ABSOLUTE_MODE 1
208
209 /* XTilt and YTilt values
210 */
211 #define AIPTEK_TILT_MIN (-128)
212 #define AIPTEK_TILT_MAX 127
213 #define AIPTEK_TILT_DISABLE (-10101)
214
215 /* Wheel values
216 */
217 #define AIPTEK_WHEEL_MIN 0
218 #define AIPTEK_WHEEL_MAX 1024
219 #define AIPTEK_WHEEL_DISABLE (-10101)
220
221 /* ToolCode values, which BTW are 0x140 .. 0x14f
222 * We have things set up such that if the tool button has changed,
223 * the tools get reset.
224 */
225 /* toolMode codes
226 */
227 #define AIPTEK_TOOL_BUTTON_PEN_MODE BTN_TOOL_PEN
228 #define AIPTEK_TOOL_BUTTON_PENCIL_MODE BTN_TOOL_PENCIL
229 #define AIPTEK_TOOL_BUTTON_BRUSH_MODE BTN_TOOL_BRUSH
230 #define AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE BTN_TOOL_AIRBRUSH
231 #define AIPTEK_TOOL_BUTTON_ERASER_MODE BTN_TOOL_RUBBER
232 #define AIPTEK_TOOL_BUTTON_MOUSE_MODE BTN_TOOL_MOUSE
233 #define AIPTEK_TOOL_BUTTON_LENS_MODE BTN_TOOL_LENS
234
235 /* Diagnostic message codes
236 */
237 #define AIPTEK_DIAGNOSTIC_NA 0
238 #define AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE 1
239 #define AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE 2
240 #define AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED 3
241
242 /* Time to wait (in ms) to help mask hand jittering
243 * when pressing the stylus buttons.
244 */
245 #define AIPTEK_JITTER_DELAY_DEFAULT 50
246
247 /* Time to wait (in ms) in-between sending the tablet
248 * a command and beginning the process of reading the return
249 * sequence from the tablet.
250 */
251 #define AIPTEK_PROGRAMMABLE_DELAY_25 25
252 #define AIPTEK_PROGRAMMABLE_DELAY_50 50
253 #define AIPTEK_PROGRAMMABLE_DELAY_100 100
254 #define AIPTEK_PROGRAMMABLE_DELAY_200 200
255 #define AIPTEK_PROGRAMMABLE_DELAY_300 300
256 #define AIPTEK_PROGRAMMABLE_DELAY_400 400
257 #define AIPTEK_PROGRAMMABLE_DELAY_DEFAULT AIPTEK_PROGRAMMABLE_DELAY_400
258
259 /* Mouse button programming
260 */
261 #define AIPTEK_MOUSE_LEFT_BUTTON 0x04
262 #define AIPTEK_MOUSE_RIGHT_BUTTON 0x08
263 #define AIPTEK_MOUSE_MIDDLE_BUTTON 0x10
264
265 /* Stylus button programming
266 */
267 #define AIPTEK_STYLUS_LOWER_BUTTON 0x08
268 #define AIPTEK_STYLUS_UPPER_BUTTON 0x10
269
270 /* Length of incoming packet from the tablet
271 */
272 #define AIPTEK_PACKET_LENGTH 8
273
274 /* We report in EV_MISC both the proximity and
275 * whether the report came from the stylus, tablet mouse
276 * or "unknown" -- Unknown when the tablet is in relative
277 * mode, because we only get report 1's.
278 */
279 #define AIPTEK_REPORT_TOOL_UNKNOWN 0x10
280 #define AIPTEK_REPORT_TOOL_STYLUS 0x20
281 #define AIPTEK_REPORT_TOOL_MOUSE 0x40
282
283 static int programmableDelay = AIPTEK_PROGRAMMABLE_DELAY_DEFAULT;
284 static int jitterDelay = AIPTEK_JITTER_DELAY_DEFAULT;
285
286 struct aiptek_features {
287 int odmCode; /* Tablet manufacturer code */
288 int modelCode; /* Tablet model code (not unique) */
289 int firmwareCode; /* prom/eeprom version */
290 char usbPath[64 + 1]; /* device's physical usb path */
291 };
292
293 struct aiptek_settings {
294 int pointerMode; /* stylus-, mouse-only or either */
295 int coordinateMode; /* absolute/relative coords */
296 int toolMode; /* pen, pencil, brush, etc. tool */
297 int xTilt; /* synthetic xTilt amount */
298 int yTilt; /* synthetic yTilt amount */
299 int wheel; /* synthetic wheel amount */
300 int stylusButtonUpper; /* stylus upper btn delivers... */
301 int stylusButtonLower; /* stylus lower btn delivers... */
302 int mouseButtonLeft; /* mouse left btn delivers... */
303 int mouseButtonMiddle; /* mouse middle btn delivers... */
304 int mouseButtonRight; /* mouse right btn delivers... */
305 int programmableDelay; /* delay for tablet programming */
306 int jitterDelay; /* delay for hand jittering */
307 };
308
309 struct aiptek {
310 struct input_dev *inputdev; /* input device struct */
311 struct usb_device *usbdev; /* usb device struct */
312 struct urb *urb; /* urb for incoming reports */
313 dma_addr_t data_dma; /* our dma stuffage */
314 struct aiptek_features features; /* tablet's array of features */
315 struct aiptek_settings curSetting; /* tablet's current programmable */
316 struct aiptek_settings newSetting; /* ... and new param settings */
317 unsigned int ifnum; /* interface number for IO */
318 int diagnostic; /* tablet diagnostic codes */
319 unsigned long eventCount; /* event count */
320 int inDelay; /* jitter: in jitter delay? */
321 unsigned long endDelay; /* jitter: time when delay ends */
322 int previousJitterable; /* jitterable prev value */
323
324 int lastMacro; /* macro key to reset */
325 int previousToolMode; /* pen, pencil, brush, etc. tool */
326 unsigned char *data; /* incoming packet data */
327 };
328
329 static const int eventTypes[] = {
330 EV_KEY, EV_ABS, EV_REL, EV_MSC,
331 };
332
333 static const int absEvents[] = {
334 ABS_X, ABS_Y, ABS_PRESSURE, ABS_TILT_X, ABS_TILT_Y,
335 ABS_WHEEL, ABS_MISC,
336 };
337
338 static const int relEvents[] = {
339 REL_X, REL_Y, REL_WHEEL,
340 };
341
342 static const int buttonEvents[] = {
343 BTN_LEFT, BTN_RIGHT, BTN_MIDDLE,
344 BTN_TOOL_PEN, BTN_TOOL_RUBBER, BTN_TOOL_PENCIL, BTN_TOOL_AIRBRUSH,
345 BTN_TOOL_BRUSH, BTN_TOOL_MOUSE, BTN_TOOL_LENS, BTN_TOUCH,
346 BTN_STYLUS, BTN_STYLUS2,
347 };
348
349 /*
350 * Permit easy lookup of keyboard events to send, versus
351 * the bitmap which comes from the tablet. This hides the
352 * issue that the F_keys are not sequentially numbered.
353 */
354 static const int macroKeyEvents[] = {
355 KEY_ESC, KEY_F1, KEY_F2, KEY_F3, KEY_F4, KEY_F5,
356 KEY_F6, KEY_F7, KEY_F8, KEY_F9, KEY_F10, KEY_F11,
357 KEY_F12, KEY_F13, KEY_F14, KEY_F15, KEY_F16, KEY_F17,
358 KEY_F18, KEY_F19, KEY_F20, KEY_F21, KEY_F22, KEY_F23,
359 KEY_F24, KEY_STOP, KEY_AGAIN, KEY_PROPS, KEY_UNDO,
360 KEY_FRONT, KEY_COPY, KEY_OPEN, KEY_PASTE, 0
361 };
362
363 /***********************************************************************
364 * Map values to strings and back. Every map should have the following
365 * as its last element: { NULL, AIPTEK_INVALID_VALUE }.
366 */
367 #define AIPTEK_INVALID_VALUE -1
368
369 struct aiptek_map {
370 const char *string;
371 int value;
372 };
373
374 static int map_str_to_val(const struct aiptek_map *map, const char *str, size_t count)
375 {
376 const struct aiptek_map *p;
377
378 if (str[count - 1] == '\n')
379 count--;
380
381 for (p = map; p->string; p++)
382 if (!strncmp(str, p->string, count))
383 return p->value;
384
385 return AIPTEK_INVALID_VALUE;
386 }
387
388 static const char *map_val_to_str(const struct aiptek_map *map, int val)
389 {
390 const struct aiptek_map *p;
391
392 for (p = map; p->value != AIPTEK_INVALID_VALUE; p++)
393 if (val == p->value)
394 return p->string;
395
396 return "unknown";
397 }
398
399 /***********************************************************************
400 * aiptek_irq can receive one of six potential reports.
401 * The documentation for each is in the body of the function.
402 *
403 * The tablet reports on several attributes per invocation of
404 * aiptek_irq. Because the Linux Input Event system allows the
405 * transmission of ONE attribute per input_report_xxx() call,
406 * collation has to be done on the other end to reconstitute
407 * a complete tablet report. Further, the number of Input Event reports
408 * submitted varies, depending on what USB report type, and circumstance.
409 * To deal with this, EV_MSC is used to indicate an 'end-of-report'
410 * message. This has been an undocumented convention understood by the kernel
411 * tablet driver and clients such as gpm and XFree86's tablet drivers.
412 *
413 * Of the information received from the tablet, the one piece I
414 * cannot transmit is the proximity bit (without resorting to an EV_MSC
415 * convention above.) I therefore have taken over REL_MISC and ABS_MISC
416 * (for relative and absolute reports, respectively) for communicating
417 * Proximity. Why two events? I thought it interesting to know if the
418 * Proximity event occurred while the tablet was in absolute or relative
419 * mode.
420 * Update: REL_MISC proved not to be such a good idea. With REL_MISC you
421 * get an event transmitted each time. ABS_MISC works better, since it
422 * can be set and re-set. Thus, only using ABS_MISC from now on.
423 *
424 * Other tablets use the notion of a certain minimum stylus pressure
425 * to infer proximity. While that could have been done, that is yet
426 * another 'by convention' behavior, the documentation for which
427 * would be spread between two (or more) pieces of software.
428 *
429 * EV_MSC usage was terminated for this purpose in Linux 2.5.x, and
430 * replaced with the input_sync() method (which emits EV_SYN.)
431 */
432
433 static void aiptek_irq(struct urb *urb)
434 {
435 struct aiptek *aiptek = urb->context;
436 unsigned char *data = aiptek->data;
437 struct input_dev *inputdev = aiptek->inputdev;
438 int jitterable = 0;
439 int retval, macro, x, y, z, left, right, middle, p, dv, tip, bs, pck;
440
441 switch (urb->status) {
442 case 0:
443 /* Success */
444 break;
445
446 case -ECONNRESET:
447 case -ENOENT:
448 case -ESHUTDOWN:
449 /* This urb is terminated, clean up */
450 dbg("%s - urb shutting down with status: %d",
451 __func__, urb->status);
452 return;
453
454 default:
455 dbg("%s - nonzero urb status received: %d",
456 __func__, urb->status);
457 goto exit;
458 }
459
460 /* See if we are in a delay loop -- throw out report if true.
461 */
462 if (aiptek->inDelay == 1 && time_after(aiptek->endDelay, jiffies)) {
463 goto exit;
464 }
465
466 aiptek->inDelay = 0;
467 aiptek->eventCount++;
468
469 /* Report 1 delivers relative coordinates with either a stylus
470 * or the mouse. You do not know, however, which input
471 * tool generated the event.
472 */
473 if (data[0] == 1) {
474 if (aiptek->curSetting.coordinateMode ==
475 AIPTEK_COORDINATE_ABSOLUTE_MODE) {
476 aiptek->diagnostic =
477 AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE;
478 } else {
479 x = (signed char) data[2];
480 y = (signed char) data[3];
481
482 /* jitterable keeps track of whether any button has been pressed.
483 * We're also using it to remap the physical mouse button mask
484 * to pseudo-settings. (We don't specifically care about it's
485 * value after moving/transposing mouse button bitmasks, except
486 * that a non-zero value indicates that one or more
487 * mouse button was pressed.)
488 */
489 jitterable = data[1] & 0x07;
490
491 left = (data[1] & aiptek->curSetting.mouseButtonLeft >> 2) != 0 ? 1 : 0;
492 right = (data[1] & aiptek->curSetting.mouseButtonRight >> 2) != 0 ? 1 : 0;
493 middle = (data[1] & aiptek->curSetting.mouseButtonMiddle >> 2) != 0 ? 1 : 0;
494
495 input_report_key(inputdev, BTN_LEFT, left);
496 input_report_key(inputdev, BTN_MIDDLE, middle);
497 input_report_key(inputdev, BTN_RIGHT, right);
498
499 input_report_abs(inputdev, ABS_MISC,
500 1 | AIPTEK_REPORT_TOOL_UNKNOWN);
501 input_report_rel(inputdev, REL_X, x);
502 input_report_rel(inputdev, REL_Y, y);
503
504 /* Wheel support is in the form of a single-event
505 * firing.
506 */
507 if (aiptek->curSetting.wheel != AIPTEK_WHEEL_DISABLE) {
508 input_report_rel(inputdev, REL_WHEEL,
509 aiptek->curSetting.wheel);
510 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
511 }
512 if (aiptek->lastMacro != -1) {
513 input_report_key(inputdev,
514 macroKeyEvents[aiptek->lastMacro], 0);
515 aiptek->lastMacro = -1;
516 }
517 input_sync(inputdev);
518 }
519 }
520 /* Report 2 is delivered only by the stylus, and delivers
521 * absolute coordinates.
522 */
523 else if (data[0] == 2) {
524 if (aiptek->curSetting.coordinateMode == AIPTEK_COORDINATE_RELATIVE_MODE) {
525 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE;
526 } else if (!AIPTEK_POINTER_ALLOW_STYLUS_MODE
527 (aiptek->curSetting.pointerMode)) {
528 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED;
529 } else {
530 x = get_unaligned_le16(data + 1);
531 y = get_unaligned_le16(data + 3);
532 z = get_unaligned_le16(data + 6);
533
534 dv = (data[5] & 0x01) != 0 ? 1 : 0;
535 p = (data[5] & 0x02) != 0 ? 1 : 0;
536 tip = (data[5] & 0x04) != 0 ? 1 : 0;
537
538 /* Use jitterable to re-arrange button masks
539 */
540 jitterable = data[5] & 0x18;
541
542 bs = (data[5] & aiptek->curSetting.stylusButtonLower) != 0 ? 1 : 0;
543 pck = (data[5] & aiptek->curSetting.stylusButtonUpper) != 0 ? 1 : 0;
544
545 /* dv indicates 'data valid' (e.g., the tablet is in sync
546 * and has delivered a "correct" report) We will ignore
547 * all 'bad' reports...
548 */
549 if (dv != 0) {
550 /* If the selected tool changed, reset the old
551 * tool key, and set the new one.
552 */
553 if (aiptek->previousToolMode !=
554 aiptek->curSetting.toolMode) {
555 input_report_key(inputdev,
556 aiptek->previousToolMode, 0);
557 input_report_key(inputdev,
558 aiptek->curSetting.toolMode,
559 1);
560 aiptek->previousToolMode =
561 aiptek->curSetting.toolMode;
562 }
563
564 if (p != 0) {
565 input_report_abs(inputdev, ABS_X, x);
566 input_report_abs(inputdev, ABS_Y, y);
567 input_report_abs(inputdev, ABS_PRESSURE, z);
568
569 input_report_key(inputdev, BTN_TOUCH, tip);
570 input_report_key(inputdev, BTN_STYLUS, bs);
571 input_report_key(inputdev, BTN_STYLUS2, pck);
572
573 if (aiptek->curSetting.xTilt !=
574 AIPTEK_TILT_DISABLE) {
575 input_report_abs(inputdev,
576 ABS_TILT_X,
577 aiptek->curSetting.xTilt);
578 }
579 if (aiptek->curSetting.yTilt != AIPTEK_TILT_DISABLE) {
580 input_report_abs(inputdev,
581 ABS_TILT_Y,
582 aiptek->curSetting.yTilt);
583 }
584
585 /* Wheel support is in the form of a single-event
586 * firing.
587 */
588 if (aiptek->curSetting.wheel !=
589 AIPTEK_WHEEL_DISABLE) {
590 input_report_abs(inputdev,
591 ABS_WHEEL,
592 aiptek->curSetting.wheel);
593 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
594 }
595 }
596 input_report_abs(inputdev, ABS_MISC, p | AIPTEK_REPORT_TOOL_STYLUS);
597 if (aiptek->lastMacro != -1) {
598 input_report_key(inputdev,
599 macroKeyEvents[aiptek->lastMacro], 0);
600 aiptek->lastMacro = -1;
601 }
602 input_sync(inputdev);
603 }
604 }
605 }
606 /* Report 3's come from the mouse in absolute mode.
607 */
608 else if (data[0] == 3) {
609 if (aiptek->curSetting.coordinateMode == AIPTEK_COORDINATE_RELATIVE_MODE) {
610 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE;
611 } else if (!AIPTEK_POINTER_ALLOW_MOUSE_MODE
612 (aiptek->curSetting.pointerMode)) {
613 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED;
614 } else {
615 x = get_unaligned_le16(data + 1);
616 y = get_unaligned_le16(data + 3);
617
618 jitterable = data[5] & 0x1c;
619
620 dv = (data[5] & 0x01) != 0 ? 1 : 0;
621 p = (data[5] & 0x02) != 0 ? 1 : 0;
622 left = (data[5] & aiptek->curSetting.mouseButtonLeft) != 0 ? 1 : 0;
623 right = (data[5] & aiptek->curSetting.mouseButtonRight) != 0 ? 1 : 0;
624 middle = (data[5] & aiptek->curSetting.mouseButtonMiddle) != 0 ? 1 : 0;
625
626 if (dv != 0) {
627 /* If the selected tool changed, reset the old
628 * tool key, and set the new one.
629 */
630 if (aiptek->previousToolMode !=
631 aiptek->curSetting.toolMode) {
632 input_report_key(inputdev,
633 aiptek->previousToolMode, 0);
634 input_report_key(inputdev,
635 aiptek->curSetting.toolMode,
636 1);
637 aiptek->previousToolMode =
638 aiptek->curSetting.toolMode;
639 }
640
641 if (p != 0) {
642 input_report_abs(inputdev, ABS_X, x);
643 input_report_abs(inputdev, ABS_Y, y);
644
645 input_report_key(inputdev, BTN_LEFT, left);
646 input_report_key(inputdev, BTN_MIDDLE, middle);
647 input_report_key(inputdev, BTN_RIGHT, right);
648
649 /* Wheel support is in the form of a single-event
650 * firing.
651 */
652 if (aiptek->curSetting.wheel != AIPTEK_WHEEL_DISABLE) {
653 input_report_abs(inputdev,
654 ABS_WHEEL,
655 aiptek->curSetting.wheel);
656 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
657 }
658 }
659 input_report_abs(inputdev, ABS_MISC, p | AIPTEK_REPORT_TOOL_MOUSE);
660 if (aiptek->lastMacro != -1) {
661 input_report_key(inputdev,
662 macroKeyEvents[aiptek->lastMacro], 0);
663 aiptek->lastMacro = -1;
664 }
665 input_sync(inputdev);
666 }
667 }
668 }
669 /* Report 4s come from the macro keys when pressed by stylus
670 */
671 else if (data[0] == 4) {
672 jitterable = data[1] & 0x18;
673
674 dv = (data[1] & 0x01) != 0 ? 1 : 0;
675 p = (data[1] & 0x02) != 0 ? 1 : 0;
676 tip = (data[1] & 0x04) != 0 ? 1 : 0;
677 bs = (data[1] & aiptek->curSetting.stylusButtonLower) != 0 ? 1 : 0;
678 pck = (data[1] & aiptek->curSetting.stylusButtonUpper) != 0 ? 1 : 0;
679
680 macro = dv && p && tip && !(data[3] & 1) ? (data[3] >> 1) : -1;
681 z = get_unaligned_le16(data + 4);
682
683 if (dv) {
684 /* If the selected tool changed, reset the old
685 * tool key, and set the new one.
686 */
687 if (aiptek->previousToolMode !=
688 aiptek->curSetting.toolMode) {
689 input_report_key(inputdev,
690 aiptek->previousToolMode, 0);
691 input_report_key(inputdev,
692 aiptek->curSetting.toolMode,
693 1);
694 aiptek->previousToolMode =
695 aiptek->curSetting.toolMode;
696 }
697 }
698
699 if (aiptek->lastMacro != -1 && aiptek->lastMacro != macro) {
700 input_report_key(inputdev, macroKeyEvents[aiptek->lastMacro], 0);
701 aiptek->lastMacro = -1;
702 }
703
704 if (macro != -1 && macro != aiptek->lastMacro) {
705 input_report_key(inputdev, macroKeyEvents[macro], 1);
706 aiptek->lastMacro = macro;
707 }
708 input_report_abs(inputdev, ABS_MISC,
709 p | AIPTEK_REPORT_TOOL_STYLUS);
710 input_sync(inputdev);
711 }
712 /* Report 5s come from the macro keys when pressed by mouse
713 */
714 else if (data[0] == 5) {
715 jitterable = data[1] & 0x1c;
716
717 dv = (data[1] & 0x01) != 0 ? 1 : 0;
718 p = (data[1] & 0x02) != 0 ? 1 : 0;
719 left = (data[1]& aiptek->curSetting.mouseButtonLeft) != 0 ? 1 : 0;
720 right = (data[1] & aiptek->curSetting.mouseButtonRight) != 0 ? 1 : 0;
721 middle = (data[1] & aiptek->curSetting.mouseButtonMiddle) != 0 ? 1 : 0;
722 macro = dv && p && left && !(data[3] & 1) ? (data[3] >> 1) : 0;
723
724 if (dv) {
725 /* If the selected tool changed, reset the old
726 * tool key, and set the new one.
727 */
728 if (aiptek->previousToolMode !=
729 aiptek->curSetting.toolMode) {
730 input_report_key(inputdev,
731 aiptek->previousToolMode, 0);
732 input_report_key(inputdev,
733 aiptek->curSetting.toolMode, 1);
734 aiptek->previousToolMode = aiptek->curSetting.toolMode;
735 }
736 }
737
738 if (aiptek->lastMacro != -1 && aiptek->lastMacro != macro) {
739 input_report_key(inputdev, macroKeyEvents[aiptek->lastMacro], 0);
740 aiptek->lastMacro = -1;
741 }
742
743 if (macro != -1 && macro != aiptek->lastMacro) {
744 input_report_key(inputdev, macroKeyEvents[macro], 1);
745 aiptek->lastMacro = macro;
746 }
747
748 input_report_abs(inputdev, ABS_MISC,
749 p | AIPTEK_REPORT_TOOL_MOUSE);
750 input_sync(inputdev);
751 }
752 /* We have no idea which tool can generate a report 6. Theoretically,
753 * neither need to, having been given reports 4 & 5 for such use.
754 * However, report 6 is the 'official-looking' report for macroKeys;
755 * reports 4 & 5 supposively are used to support unnamed, unknown
756 * hat switches (which just so happen to be the macroKeys.)
757 */
758 else if (data[0] == 6) {
759 macro = get_unaligned_le16(data + 1);
760 if (macro > 0) {
761 input_report_key(inputdev, macroKeyEvents[macro - 1],
762 0);
763 }
764 if (macro < 25) {
765 input_report_key(inputdev, macroKeyEvents[macro + 1],
766 0);
767 }
768
769 /* If the selected tool changed, reset the old
770 tool key, and set the new one.
771 */
772 if (aiptek->previousToolMode !=
773 aiptek->curSetting.toolMode) {
774 input_report_key(inputdev,
775 aiptek->previousToolMode, 0);
776 input_report_key(inputdev,
777 aiptek->curSetting.toolMode,
778 1);
779 aiptek->previousToolMode =
780 aiptek->curSetting.toolMode;
781 }
782
783 input_report_key(inputdev, macroKeyEvents[macro], 1);
784 input_report_abs(inputdev, ABS_MISC,
785 1 | AIPTEK_REPORT_TOOL_UNKNOWN);
786 input_sync(inputdev);
787 } else {
788 dbg("Unknown report %d", data[0]);
789 }
790
791 /* Jitter may occur when the user presses a button on the stlyus
792 * or the mouse. What we do to prevent that is wait 'x' milliseconds
793 * following a 'jitterable' event, which should give the hand some time
794 * stabilize itself.
795 *
796 * We just introduced aiptek->previousJitterable to carry forth the
797 * notion that jitter occurs when the button state changes from on to off:
798 * a person drawing, holding a button down is not subject to jittering.
799 * With that in mind, changing from upper button depressed to lower button
800 * WILL transition through a jitter delay.
801 */
802
803 if (aiptek->previousJitterable != jitterable &&
804 aiptek->curSetting.jitterDelay != 0 && aiptek->inDelay != 1) {
805 aiptek->endDelay = jiffies +
806 ((aiptek->curSetting.jitterDelay * HZ) / 1000);
807 aiptek->inDelay = 1;
808 }
809 aiptek->previousJitterable = jitterable;
810
811 exit:
812 retval = usb_submit_urb(urb, GFP_ATOMIC);
813 if (retval != 0) {
814 dev_err(&inputdev->dev,
815 "%s - usb_submit_urb failed with result %d\n",
816 __func__, retval);
817 }
818 }
819
820 /***********************************************************************
821 * These are the USB id's known so far. We do not identify them to
822 * specific Aiptek model numbers, because there has been overlaps,
823 * use, and reuse of id's in existing models. Certain models have
824 * been known to use more than one ID, indicative perhaps of
825 * manufacturing revisions. In any event, we consider these
826 * IDs to not be model-specific nor unique.
827 */
828 static const struct usb_device_id aiptek_ids[] = {
829 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x01)},
830 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x10)},
831 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x20)},
832 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x21)},
833 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x22)},
834 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x23)},
835 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x24)},
836 {USB_DEVICE(USB_VENDOR_ID_KYE, 0x5003)},
837 {}
838 };
839
840 MODULE_DEVICE_TABLE(usb, aiptek_ids);
841
842 /***********************************************************************
843 * Open an instance of the tablet driver.
844 */
845 static int aiptek_open(struct input_dev *inputdev)
846 {
847 struct aiptek *aiptek = input_get_drvdata(inputdev);
848
849 aiptek->urb->dev = aiptek->usbdev;
850 if (usb_submit_urb(aiptek->urb, GFP_KERNEL) != 0)
851 return -EIO;
852
853 return 0;
854 }
855
856 /***********************************************************************
857 * Close an instance of the tablet driver.
858 */
859 static void aiptek_close(struct input_dev *inputdev)
860 {
861 struct aiptek *aiptek = input_get_drvdata(inputdev);
862
863 usb_kill_urb(aiptek->urb);
864 }
865
866 /***********************************************************************
867 * aiptek_set_report and aiptek_get_report() are borrowed from Linux 2.4.x,
868 * where they were known as usb_set_report and usb_get_report.
869 */
870 static int
871 aiptek_set_report(struct aiptek *aiptek,
872 unsigned char report_type,
873 unsigned char report_id, void *buffer, int size)
874 {
875 return usb_control_msg(aiptek->usbdev,
876 usb_sndctrlpipe(aiptek->usbdev, 0),
877 USB_REQ_SET_REPORT,
878 USB_TYPE_CLASS | USB_RECIP_INTERFACE |
879 USB_DIR_OUT, (report_type << 8) + report_id,
880 aiptek->ifnum, buffer, size, 5000);
881 }
882
883 static int
884 aiptek_get_report(struct aiptek *aiptek,
885 unsigned char report_type,
886 unsigned char report_id, void *buffer, int size)
887 {
888 return usb_control_msg(aiptek->usbdev,
889 usb_rcvctrlpipe(aiptek->usbdev, 0),
890 USB_REQ_GET_REPORT,
891 USB_TYPE_CLASS | USB_RECIP_INTERFACE |
892 USB_DIR_IN, (report_type << 8) + report_id,
893 aiptek->ifnum, buffer, size, 5000);
894 }
895
896 /***********************************************************************
897 * Send a command to the tablet.
898 */
899 static int
900 aiptek_command(struct aiptek *aiptek, unsigned char command, unsigned char data)
901 {
902 const int sizeof_buf = 3 * sizeof(u8);
903 int ret;
904 u8 *buf;
905
906 buf = kmalloc(sizeof_buf, GFP_KERNEL);
907 if (!buf)
908 return -ENOMEM;
909
910 buf[0] = 2;
911 buf[1] = command;
912 buf[2] = data;
913
914 if ((ret =
915 aiptek_set_report(aiptek, 3, 2, buf, sizeof_buf)) != sizeof_buf) {
916 dbg("aiptek_program: failed, tried to send: 0x%02x 0x%02x",
917 command, data);
918 }
919 kfree(buf);
920 return ret < 0 ? ret : 0;
921 }
922
923 /***********************************************************************
924 * Retrieve information from the tablet. Querying info is defined as first
925 * sending the {command,data} sequence as a command, followed by a wait
926 * (aka, "programmaticDelay") and then a "read" request.
927 */
928 static int
929 aiptek_query(struct aiptek *aiptek, unsigned char command, unsigned char data)
930 {
931 const int sizeof_buf = 3 * sizeof(u8);
932 int ret;
933 u8 *buf;
934
935 buf = kmalloc(sizeof_buf, GFP_KERNEL);
936 if (!buf)
937 return -ENOMEM;
938
939 buf[0] = 2;
940 buf[1] = command;
941 buf[2] = data;
942
943 if (aiptek_command(aiptek, command, data) != 0) {
944 kfree(buf);
945 return -EIO;
946 }
947 msleep(aiptek->curSetting.programmableDelay);
948
949 if ((ret =
950 aiptek_get_report(aiptek, 3, 2, buf, sizeof_buf)) != sizeof_buf) {
951 dbg("aiptek_query failed: returned 0x%02x 0x%02x 0x%02x",
952 buf[0], buf[1], buf[2]);
953 ret = -EIO;
954 } else {
955 ret = get_unaligned_le16(buf + 1);
956 }
957 kfree(buf);
958 return ret;
959 }
960
961 /***********************************************************************
962 * Program the tablet into either absolute or relative mode.
963 * We also get information about the tablet's size.
964 */
965 static int aiptek_program_tablet(struct aiptek *aiptek)
966 {
967 int ret;
968 /* Execute Resolution500LPI */
969 if ((ret = aiptek_command(aiptek, 0x18, 0x04)) < 0)
970 return ret;
971
972 /* Query getModelCode */
973 if ((ret = aiptek_query(aiptek, 0x02, 0x00)) < 0)
974 return ret;
975 aiptek->features.modelCode = ret & 0xff;
976
977 /* Query getODMCode */
978 if ((ret = aiptek_query(aiptek, 0x03, 0x00)) < 0)
979 return ret;
980 aiptek->features.odmCode = ret;
981
982 /* Query getFirmwareCode */
983 if ((ret = aiptek_query(aiptek, 0x04, 0x00)) < 0)
984 return ret;
985 aiptek->features.firmwareCode = ret;
986
987 /* Query getXextension */
988 if ((ret = aiptek_query(aiptek, 0x01, 0x00)) < 0)
989 return ret;
990 input_set_abs_params(aiptek->inputdev, ABS_X, 0, ret - 1, 0, 0);
991
992 /* Query getYextension */
993 if ((ret = aiptek_query(aiptek, 0x01, 0x01)) < 0)
994 return ret;
995 input_set_abs_params(aiptek->inputdev, ABS_Y, 0, ret - 1, 0, 0);
996
997 /* Query getPressureLevels */
998 if ((ret = aiptek_query(aiptek, 0x08, 0x00)) < 0)
999 return ret;
1000 input_set_abs_params(aiptek->inputdev, ABS_PRESSURE, 0, ret - 1, 0, 0);
1001
1002 /* Depending on whether we are in absolute or relative mode, we will
1003 * do a switchToTablet(absolute) or switchToMouse(relative) command.
1004 */
1005 if (aiptek->curSetting.coordinateMode ==
1006 AIPTEK_COORDINATE_ABSOLUTE_MODE) {
1007 /* Execute switchToTablet */
1008 if ((ret = aiptek_command(aiptek, 0x10, 0x01)) < 0) {
1009 return ret;
1010 }
1011 } else {
1012 /* Execute switchToMouse */
1013 if ((ret = aiptek_command(aiptek, 0x10, 0x00)) < 0) {
1014 return ret;
1015 }
1016 }
1017
1018 /* Enable the macro keys */
1019 if ((ret = aiptek_command(aiptek, 0x11, 0x02)) < 0)
1020 return ret;
1021 #if 0
1022 /* Execute FilterOn */
1023 if ((ret = aiptek_command(aiptek, 0x17, 0x00)) < 0)
1024 return ret;
1025 #endif
1026
1027 /* Execute AutoGainOn */
1028 if ((ret = aiptek_command(aiptek, 0x12, 0xff)) < 0)
1029 return ret;
1030
1031 /* Reset the eventCount, so we track events from last (re)programming
1032 */
1033 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_NA;
1034 aiptek->eventCount = 0;
1035
1036 return 0;
1037 }
1038
1039 /***********************************************************************
1040 * Sysfs functions. Sysfs prefers that individually-tunable parameters
1041 * exist in their separate pseudo-files. Summary data that is immutable
1042 * may exist in a singular file so long as you don't define a writeable
1043 * interface.
1044 */
1045
1046 /***********************************************************************
1047 * support the 'size' file -- display support
1048 */
1049 static ssize_t show_tabletSize(struct device *dev, struct device_attribute *attr, char *buf)
1050 {
1051 struct aiptek *aiptek = dev_get_drvdata(dev);
1052
1053 return snprintf(buf, PAGE_SIZE, "%dx%d\n",
1054 input_abs_get_max(aiptek->inputdev, ABS_X) + 1,
1055 input_abs_get_max(aiptek->inputdev, ABS_Y) + 1);
1056 }
1057
1058 /* These structs define the sysfs files, param #1 is the name of the
1059 * file, param 2 is the file permissions, param 3 & 4 are to the
1060 * output generator and input parser routines. Absence of a routine is
1061 * permitted -- it only means can't either 'cat' the file, or send data
1062 * to it.
1063 */
1064 static DEVICE_ATTR(size, S_IRUGO, show_tabletSize, NULL);
1065
1066 /***********************************************************************
1067 * support routines for the 'pointer_mode' file. Note that this file
1068 * both displays current setting and allows reprogramming.
1069 */
1070 static struct aiptek_map pointer_mode_map[] = {
1071 { "stylus", AIPTEK_POINTER_ONLY_STYLUS_MODE },
1072 { "mouse", AIPTEK_POINTER_ONLY_MOUSE_MODE },
1073 { "either", AIPTEK_POINTER_EITHER_MODE },
1074 { NULL, AIPTEK_INVALID_VALUE }
1075 };
1076
1077 static ssize_t show_tabletPointerMode(struct device *dev, struct device_attribute *attr, char *buf)
1078 {
1079 struct aiptek *aiptek = dev_get_drvdata(dev);
1080
1081 return snprintf(buf, PAGE_SIZE, "%s\n",
1082 map_val_to_str(pointer_mode_map,
1083 aiptek->curSetting.pointerMode));
1084 }
1085
1086 static ssize_t
1087 store_tabletPointerMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1088 {
1089 struct aiptek *aiptek = dev_get_drvdata(dev);
1090 int new_mode = map_str_to_val(pointer_mode_map, buf, count);
1091
1092 if (new_mode == AIPTEK_INVALID_VALUE)
1093 return -EINVAL;
1094
1095 aiptek->newSetting.pointerMode = new_mode;
1096 return count;
1097 }
1098
1099 static DEVICE_ATTR(pointer_mode,
1100 S_IRUGO | S_IWUSR,
1101 show_tabletPointerMode, store_tabletPointerMode);
1102
1103 /***********************************************************************
1104 * support routines for the 'coordinate_mode' file. Note that this file
1105 * both displays current setting and allows reprogramming.
1106 */
1107
1108 static struct aiptek_map coordinate_mode_map[] = {
1109 { "absolute", AIPTEK_COORDINATE_ABSOLUTE_MODE },
1110 { "relative", AIPTEK_COORDINATE_RELATIVE_MODE },
1111 { NULL, AIPTEK_INVALID_VALUE }
1112 };
1113
1114 static ssize_t show_tabletCoordinateMode(struct device *dev, struct device_attribute *attr, char *buf)
1115 {
1116 struct aiptek *aiptek = dev_get_drvdata(dev);
1117
1118 return snprintf(buf, PAGE_SIZE, "%s\n",
1119 map_val_to_str(coordinate_mode_map,
1120 aiptek->curSetting.coordinateMode));
1121 }
1122
1123 static ssize_t
1124 store_tabletCoordinateMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1125 {
1126 struct aiptek *aiptek = dev_get_drvdata(dev);
1127 int new_mode = map_str_to_val(coordinate_mode_map, buf, count);
1128
1129 if (new_mode == AIPTEK_INVALID_VALUE)
1130 return -EINVAL;
1131
1132 aiptek->newSetting.coordinateMode = new_mode;
1133 return count;
1134 }
1135
1136 static DEVICE_ATTR(coordinate_mode,
1137 S_IRUGO | S_IWUSR,
1138 show_tabletCoordinateMode, store_tabletCoordinateMode);
1139
1140 /***********************************************************************
1141 * support routines for the 'tool_mode' file. Note that this file
1142 * both displays current setting and allows reprogramming.
1143 */
1144
1145 static struct aiptek_map tool_mode_map[] = {
1146 { "mouse", AIPTEK_TOOL_BUTTON_MOUSE_MODE },
1147 { "eraser", AIPTEK_TOOL_BUTTON_ERASER_MODE },
1148 { "pencil", AIPTEK_TOOL_BUTTON_PENCIL_MODE },
1149 { "pen", AIPTEK_TOOL_BUTTON_PEN_MODE },
1150 { "brush", AIPTEK_TOOL_BUTTON_BRUSH_MODE },
1151 { "airbrush", AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE },
1152 { "lens", AIPTEK_TOOL_BUTTON_LENS_MODE },
1153 { NULL, AIPTEK_INVALID_VALUE }
1154 };
1155
1156 static ssize_t show_tabletToolMode(struct device *dev, struct device_attribute *attr, char *buf)
1157 {
1158 struct aiptek *aiptek = dev_get_drvdata(dev);
1159
1160 return snprintf(buf, PAGE_SIZE, "%s\n",
1161 map_val_to_str(tool_mode_map,
1162 aiptek->curSetting.toolMode));
1163 }
1164
1165 static ssize_t
1166 store_tabletToolMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1167 {
1168 struct aiptek *aiptek = dev_get_drvdata(dev);
1169 int new_mode = map_str_to_val(tool_mode_map, buf, count);
1170
1171 if (new_mode == AIPTEK_INVALID_VALUE)
1172 return -EINVAL;
1173
1174 aiptek->newSetting.toolMode = new_mode;
1175 return count;
1176 }
1177
1178 static DEVICE_ATTR(tool_mode,
1179 S_IRUGO | S_IWUSR,
1180 show_tabletToolMode, store_tabletToolMode);
1181
1182 /***********************************************************************
1183 * support routines for the 'xtilt' file. Note that this file
1184 * both displays current setting and allows reprogramming.
1185 */
1186 static ssize_t show_tabletXtilt(struct device *dev, struct device_attribute *attr, char *buf)
1187 {
1188 struct aiptek *aiptek = dev_get_drvdata(dev);
1189
1190 if (aiptek->curSetting.xTilt == AIPTEK_TILT_DISABLE) {
1191 return snprintf(buf, PAGE_SIZE, "disable\n");
1192 } else {
1193 return snprintf(buf, PAGE_SIZE, "%d\n",
1194 aiptek->curSetting.xTilt);
1195 }
1196 }
1197
1198 static ssize_t
1199 store_tabletXtilt(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1200 {
1201 struct aiptek *aiptek = dev_get_drvdata(dev);
1202 int x;
1203
1204 if (kstrtoint(buf, 10, &x)) {
1205 size_t len = buf[count - 1] == '\n' ? count - 1 : count;
1206
1207 if (strncmp(buf, "disable", len))
1208 return -EINVAL;
1209
1210 aiptek->newSetting.xTilt = AIPTEK_TILT_DISABLE;
1211 } else {
1212 if (x < AIPTEK_TILT_MIN || x > AIPTEK_TILT_MAX)
1213 return -EINVAL;
1214
1215 aiptek->newSetting.xTilt = x;
1216 }
1217
1218 return count;
1219 }
1220
1221 static DEVICE_ATTR(xtilt,
1222 S_IRUGO | S_IWUSR, show_tabletXtilt, store_tabletXtilt);
1223
1224 /***********************************************************************
1225 * support routines for the 'ytilt' file. Note that this file
1226 * both displays current setting and allows reprogramming.
1227 */
1228 static ssize_t show_tabletYtilt(struct device *dev, struct device_attribute *attr, char *buf)
1229 {
1230 struct aiptek *aiptek = dev_get_drvdata(dev);
1231
1232 if (aiptek->curSetting.yTilt == AIPTEK_TILT_DISABLE) {
1233 return snprintf(buf, PAGE_SIZE, "disable\n");
1234 } else {
1235 return snprintf(buf, PAGE_SIZE, "%d\n",
1236 aiptek->curSetting.yTilt);
1237 }
1238 }
1239
1240 static ssize_t
1241 store_tabletYtilt(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1242 {
1243 struct aiptek *aiptek = dev_get_drvdata(dev);
1244 int y;
1245
1246 if (kstrtoint(buf, 10, &y)) {
1247 size_t len = buf[count - 1] == '\n' ? count - 1 : count;
1248
1249 if (strncmp(buf, "disable", len))
1250 return -EINVAL;
1251
1252 aiptek->newSetting.yTilt = AIPTEK_TILT_DISABLE;
1253 } else {
1254 if (y < AIPTEK_TILT_MIN || y > AIPTEK_TILT_MAX)
1255 return -EINVAL;
1256
1257 aiptek->newSetting.yTilt = y;
1258 }
1259
1260 return count;
1261 }
1262
1263 static DEVICE_ATTR(ytilt,
1264 S_IRUGO | S_IWUSR, show_tabletYtilt, store_tabletYtilt);
1265
1266 /***********************************************************************
1267 * support routines for the 'jitter' file. Note that this file
1268 * both displays current setting and allows reprogramming.
1269 */
1270 static ssize_t show_tabletJitterDelay(struct device *dev, struct device_attribute *attr, char *buf)
1271 {
1272 struct aiptek *aiptek = dev_get_drvdata(dev);
1273
1274 return snprintf(buf, PAGE_SIZE, "%d\n", aiptek->curSetting.jitterDelay);
1275 }
1276
1277 static ssize_t
1278 store_tabletJitterDelay(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1279 {
1280 struct aiptek *aiptek = dev_get_drvdata(dev);
1281 int err, j;
1282
1283 err = kstrtoint(buf, 10, &j);
1284 if (err)
1285 return err;
1286
1287 aiptek->newSetting.jitterDelay = j;
1288 return count;
1289 }
1290
1291 static DEVICE_ATTR(jitter,
1292 S_IRUGO | S_IWUSR,
1293 show_tabletJitterDelay, store_tabletJitterDelay);
1294
1295 /***********************************************************************
1296 * support routines for the 'delay' file. Note that this file
1297 * both displays current setting and allows reprogramming.
1298 */
1299 static ssize_t show_tabletProgrammableDelay(struct device *dev, struct device_attribute *attr, char *buf)
1300 {
1301 struct aiptek *aiptek = dev_get_drvdata(dev);
1302
1303 return snprintf(buf, PAGE_SIZE, "%d\n",
1304 aiptek->curSetting.programmableDelay);
1305 }
1306
1307 static ssize_t
1308 store_tabletProgrammableDelay(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1309 {
1310 struct aiptek *aiptek = dev_get_drvdata(dev);
1311 int err, d;
1312
1313 err = kstrtoint(buf, 10, &d);
1314 if (err)
1315 return err;
1316
1317 aiptek->newSetting.programmableDelay = d;
1318 return count;
1319 }
1320
1321 static DEVICE_ATTR(delay,
1322 S_IRUGO | S_IWUSR,
1323 show_tabletProgrammableDelay, store_tabletProgrammableDelay);
1324
1325 /***********************************************************************
1326 * support routines for the 'event_count' file. Note that this file
1327 * only displays current setting.
1328 */
1329 static ssize_t show_tabletEventsReceived(struct device *dev, struct device_attribute *attr, char *buf)
1330 {
1331 struct aiptek *aiptek = dev_get_drvdata(dev);
1332
1333 return snprintf(buf, PAGE_SIZE, "%ld\n", aiptek->eventCount);
1334 }
1335
1336 static DEVICE_ATTR(event_count, S_IRUGO, show_tabletEventsReceived, NULL);
1337
1338 /***********************************************************************
1339 * support routines for the 'diagnostic' file. Note that this file
1340 * only displays current setting.
1341 */
1342 static ssize_t show_tabletDiagnosticMessage(struct device *dev, struct device_attribute *attr, char *buf)
1343 {
1344 struct aiptek *aiptek = dev_get_drvdata(dev);
1345 char *retMsg;
1346
1347 switch (aiptek->diagnostic) {
1348 case AIPTEK_DIAGNOSTIC_NA:
1349 retMsg = "no errors\n";
1350 break;
1351
1352 case AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE:
1353 retMsg = "Error: receiving relative reports\n";
1354 break;
1355
1356 case AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE:
1357 retMsg = "Error: receiving absolute reports\n";
1358 break;
1359
1360 case AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED:
1361 if (aiptek->curSetting.pointerMode ==
1362 AIPTEK_POINTER_ONLY_MOUSE_MODE) {
1363 retMsg = "Error: receiving stylus reports\n";
1364 } else {
1365 retMsg = "Error: receiving mouse reports\n";
1366 }
1367 break;
1368
1369 default:
1370 return 0;
1371 }
1372 return snprintf(buf, PAGE_SIZE, retMsg);
1373 }
1374
1375 static DEVICE_ATTR(diagnostic, S_IRUGO, show_tabletDiagnosticMessage, NULL);
1376
1377 /***********************************************************************
1378 * support routines for the 'stylus_upper' file. Note that this file
1379 * both displays current setting and allows for setting changing.
1380 */
1381
1382 static struct aiptek_map stylus_button_map[] = {
1383 { "upper", AIPTEK_STYLUS_UPPER_BUTTON },
1384 { "lower", AIPTEK_STYLUS_LOWER_BUTTON },
1385 { NULL, AIPTEK_INVALID_VALUE }
1386 };
1387
1388 static ssize_t show_tabletStylusUpper(struct device *dev, struct device_attribute *attr, char *buf)
1389 {
1390 struct aiptek *aiptek = dev_get_drvdata(dev);
1391
1392 return snprintf(buf, PAGE_SIZE, "%s\n",
1393 map_val_to_str(stylus_button_map,
1394 aiptek->curSetting.stylusButtonUpper));
1395 }
1396
1397 static ssize_t
1398 store_tabletStylusUpper(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1399 {
1400 struct aiptek *aiptek = dev_get_drvdata(dev);
1401 int new_button = map_str_to_val(stylus_button_map, buf, count);
1402
1403 if (new_button == AIPTEK_INVALID_VALUE)
1404 return -EINVAL;
1405
1406 aiptek->newSetting.stylusButtonUpper = new_button;
1407 return count;
1408 }
1409
1410 static DEVICE_ATTR(stylus_upper,
1411 S_IRUGO | S_IWUSR,
1412 show_tabletStylusUpper, store_tabletStylusUpper);
1413
1414 /***********************************************************************
1415 * support routines for the 'stylus_lower' file. Note that this file
1416 * both displays current setting and allows for setting changing.
1417 */
1418
1419 static ssize_t show_tabletStylusLower(struct device *dev, struct device_attribute *attr, char *buf)
1420 {
1421 struct aiptek *aiptek = dev_get_drvdata(dev);
1422
1423 return snprintf(buf, PAGE_SIZE, "%s\n",
1424 map_val_to_str(stylus_button_map,
1425 aiptek->curSetting.stylusButtonLower));
1426 }
1427
1428 static ssize_t
1429 store_tabletStylusLower(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1430 {
1431 struct aiptek *aiptek = dev_get_drvdata(dev);
1432 int new_button = map_str_to_val(stylus_button_map, buf, count);
1433
1434 if (new_button == AIPTEK_INVALID_VALUE)
1435 return -EINVAL;
1436
1437 aiptek->newSetting.stylusButtonLower = new_button;
1438 return count;
1439 }
1440
1441 static DEVICE_ATTR(stylus_lower,
1442 S_IRUGO | S_IWUSR,
1443 show_tabletStylusLower, store_tabletStylusLower);
1444
1445 /***********************************************************************
1446 * support routines for the 'mouse_left' file. Note that this file
1447 * both displays current setting and allows for setting changing.
1448 */
1449
1450 static struct aiptek_map mouse_button_map[] = {
1451 { "left", AIPTEK_MOUSE_LEFT_BUTTON },
1452 { "middle", AIPTEK_MOUSE_MIDDLE_BUTTON },
1453 { "right", AIPTEK_MOUSE_RIGHT_BUTTON },
1454 { NULL, AIPTEK_INVALID_VALUE }
1455 };
1456
1457 static ssize_t show_tabletMouseLeft(struct device *dev, struct device_attribute *attr, char *buf)
1458 {
1459 struct aiptek *aiptek = dev_get_drvdata(dev);
1460
1461 return snprintf(buf, PAGE_SIZE, "%s\n",
1462 map_val_to_str(mouse_button_map,
1463 aiptek->curSetting.mouseButtonLeft));
1464 }
1465
1466 static ssize_t
1467 store_tabletMouseLeft(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1468 {
1469 struct aiptek *aiptek = dev_get_drvdata(dev);
1470 int new_button = map_str_to_val(mouse_button_map, buf, count);
1471
1472 if (new_button == AIPTEK_INVALID_VALUE)
1473 return -EINVAL;
1474
1475 aiptek->newSetting.mouseButtonLeft = new_button;
1476 return count;
1477 }
1478
1479 static DEVICE_ATTR(mouse_left,
1480 S_IRUGO | S_IWUSR,
1481 show_tabletMouseLeft, store_tabletMouseLeft);
1482
1483 /***********************************************************************
1484 * support routines for the 'mouse_middle' file. Note that this file
1485 * both displays current setting and allows for setting changing.
1486 */
1487 static ssize_t show_tabletMouseMiddle(struct device *dev, struct device_attribute *attr, char *buf)
1488 {
1489 struct aiptek *aiptek = dev_get_drvdata(dev);
1490
1491 return snprintf(buf, PAGE_SIZE, "%s\n",
1492 map_val_to_str(mouse_button_map,
1493 aiptek->curSetting.mouseButtonMiddle));
1494 }
1495
1496 static ssize_t
1497 store_tabletMouseMiddle(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1498 {
1499 struct aiptek *aiptek = dev_get_drvdata(dev);
1500 int new_button = map_str_to_val(mouse_button_map, buf, count);
1501
1502 if (new_button == AIPTEK_INVALID_VALUE)
1503 return -EINVAL;
1504
1505 aiptek->newSetting.mouseButtonMiddle = new_button;
1506 return count;
1507 }
1508
1509 static DEVICE_ATTR(mouse_middle,
1510 S_IRUGO | S_IWUSR,
1511 show_tabletMouseMiddle, store_tabletMouseMiddle);
1512
1513 /***********************************************************************
1514 * support routines for the 'mouse_right' file. Note that this file
1515 * both displays current setting and allows for setting changing.
1516 */
1517 static ssize_t show_tabletMouseRight(struct device *dev, struct device_attribute *attr, char *buf)
1518 {
1519 struct aiptek *aiptek = dev_get_drvdata(dev);
1520
1521 return snprintf(buf, PAGE_SIZE, "%s\n",
1522 map_val_to_str(mouse_button_map,
1523 aiptek->curSetting.mouseButtonRight));
1524 }
1525
1526 static ssize_t
1527 store_tabletMouseRight(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1528 {
1529 struct aiptek *aiptek = dev_get_drvdata(dev);
1530 int new_button = map_str_to_val(mouse_button_map, buf, count);
1531
1532 if (new_button == AIPTEK_INVALID_VALUE)
1533 return -EINVAL;
1534
1535 aiptek->newSetting.mouseButtonRight = new_button;
1536 return count;
1537 }
1538
1539 static DEVICE_ATTR(mouse_right,
1540 S_IRUGO | S_IWUSR,
1541 show_tabletMouseRight, store_tabletMouseRight);
1542
1543 /***********************************************************************
1544 * support routines for the 'wheel' file. Note that this file
1545 * both displays current setting and allows for setting changing.
1546 */
1547 static ssize_t show_tabletWheel(struct device *dev, struct device_attribute *attr, char *buf)
1548 {
1549 struct aiptek *aiptek = dev_get_drvdata(dev);
1550
1551 if (aiptek->curSetting.wheel == AIPTEK_WHEEL_DISABLE) {
1552 return snprintf(buf, PAGE_SIZE, "disable\n");
1553 } else {
1554 return snprintf(buf, PAGE_SIZE, "%d\n",
1555 aiptek->curSetting.wheel);
1556 }
1557 }
1558
1559 static ssize_t
1560 store_tabletWheel(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1561 {
1562 struct aiptek *aiptek = dev_get_drvdata(dev);
1563 int err, w;
1564
1565 err = kstrtoint(buf, 10, &w);
1566 if (err)
1567 return err;
1568
1569 aiptek->newSetting.wheel = w;
1570 return count;
1571 }
1572
1573 static DEVICE_ATTR(wheel,
1574 S_IRUGO | S_IWUSR, show_tabletWheel, store_tabletWheel);
1575
1576 /***********************************************************************
1577 * support routines for the 'execute' file. Note that this file
1578 * both displays current setting and allows for setting changing.
1579 */
1580 static ssize_t show_tabletExecute(struct device *dev, struct device_attribute *attr, char *buf)
1581 {
1582 /* There is nothing useful to display, so a one-line manual
1583 * is in order...
1584 */
1585 return snprintf(buf, PAGE_SIZE,
1586 "Write anything to this file to program your tablet.\n");
1587 }
1588
1589 static ssize_t
1590 store_tabletExecute(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1591 {
1592 struct aiptek *aiptek = dev_get_drvdata(dev);
1593
1594 /* We do not care what you write to this file. Merely the action
1595 * of writing to this file triggers a tablet reprogramming.
1596 */
1597 memcpy(&aiptek->curSetting, &aiptek->newSetting,
1598 sizeof(struct aiptek_settings));
1599
1600 if (aiptek_program_tablet(aiptek) < 0)
1601 return -EIO;
1602
1603 return count;
1604 }
1605
1606 static DEVICE_ATTR(execute,
1607 S_IRUGO | S_IWUSR, show_tabletExecute, store_tabletExecute);
1608
1609 /***********************************************************************
1610 * support routines for the 'odm_code' file. Note that this file
1611 * only displays current setting.
1612 */
1613 static ssize_t show_tabletODMCode(struct device *dev, struct device_attribute *attr, char *buf)
1614 {
1615 struct aiptek *aiptek = dev_get_drvdata(dev);
1616
1617 return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->features.odmCode);
1618 }
1619
1620 static DEVICE_ATTR(odm_code, S_IRUGO, show_tabletODMCode, NULL);
1621
1622 /***********************************************************************
1623 * support routines for the 'model_code' file. Note that this file
1624 * only displays current setting.
1625 */
1626 static ssize_t show_tabletModelCode(struct device *dev, struct device_attribute *attr, char *buf)
1627 {
1628 struct aiptek *aiptek = dev_get_drvdata(dev);
1629
1630 return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->features.modelCode);
1631 }
1632
1633 static DEVICE_ATTR(model_code, S_IRUGO, show_tabletModelCode, NULL);
1634
1635 /***********************************************************************
1636 * support routines for the 'firmware_code' file. Note that this file
1637 * only displays current setting.
1638 */
1639 static ssize_t show_firmwareCode(struct device *dev, struct device_attribute *attr, char *buf)
1640 {
1641 struct aiptek *aiptek = dev_get_drvdata(dev);
1642
1643 return snprintf(buf, PAGE_SIZE, "%04x\n",
1644 aiptek->features.firmwareCode);
1645 }
1646
1647 static DEVICE_ATTR(firmware_code, S_IRUGO, show_firmwareCode, NULL);
1648
1649 static struct attribute *aiptek_attributes[] = {
1650 &dev_attr_size.attr,
1651 &dev_attr_pointer_mode.attr,
1652 &dev_attr_coordinate_mode.attr,
1653 &dev_attr_tool_mode.attr,
1654 &dev_attr_xtilt.attr,
1655 &dev_attr_ytilt.attr,
1656 &dev_attr_jitter.attr,
1657 &dev_attr_delay.attr,
1658 &dev_attr_event_count.attr,
1659 &dev_attr_diagnostic.attr,
1660 &dev_attr_odm_code.attr,
1661 &dev_attr_model_code.attr,
1662 &dev_attr_firmware_code.attr,
1663 &dev_attr_stylus_lower.attr,
1664 &dev_attr_stylus_upper.attr,
1665 &dev_attr_mouse_left.attr,
1666 &dev_attr_mouse_middle.attr,
1667 &dev_attr_mouse_right.attr,
1668 &dev_attr_wheel.attr,
1669 &dev_attr_execute.attr,
1670 NULL
1671 };
1672
1673 static struct attribute_group aiptek_attribute_group = {
1674 .attrs = aiptek_attributes,
1675 };
1676
1677 /***********************************************************************
1678 * This routine is called when a tablet has been identified. It basically
1679 * sets up the tablet and the driver's internal structures.
1680 */
1681 static int
1682 aiptek_probe(struct usb_interface *intf, const struct usb_device_id *id)
1683 {
1684 struct usb_device *usbdev = interface_to_usbdev(intf);
1685 struct usb_endpoint_descriptor *endpoint;
1686 struct aiptek *aiptek;
1687 struct input_dev *inputdev;
1688 int i;
1689 int speeds[] = { 0,
1690 AIPTEK_PROGRAMMABLE_DELAY_50,
1691 AIPTEK_PROGRAMMABLE_DELAY_400,
1692 AIPTEK_PROGRAMMABLE_DELAY_25,
1693 AIPTEK_PROGRAMMABLE_DELAY_100,
1694 AIPTEK_PROGRAMMABLE_DELAY_200,
1695 AIPTEK_PROGRAMMABLE_DELAY_300
1696 };
1697 int err = -ENOMEM;
1698
1699 /* programmableDelay is where the command-line specified
1700 * delay is kept. We make it the first element of speeds[],
1701 * so therefore, your override speed is tried first, then the
1702 * remainder. Note that the default value of 400ms will be tried
1703 * if you do not specify any command line parameter.
1704 */
1705 speeds[0] = programmableDelay;
1706
1707 aiptek = kzalloc(sizeof(struct aiptek), GFP_KERNEL);
1708 inputdev = input_allocate_device();
1709 if (!aiptek || !inputdev) {
1710 dev_warn(&intf->dev,
1711 "cannot allocate memory or input device\n");
1712 goto fail1;
1713 }
1714
1715 aiptek->data = usb_alloc_coherent(usbdev, AIPTEK_PACKET_LENGTH,
1716 GFP_ATOMIC, &aiptek->data_dma);
1717 if (!aiptek->data) {
1718 dev_warn(&intf->dev, "cannot allocate usb buffer\n");
1719 goto fail1;
1720 }
1721
1722 aiptek->urb = usb_alloc_urb(0, GFP_KERNEL);
1723 if (!aiptek->urb) {
1724 dev_warn(&intf->dev, "cannot allocate urb\n");
1725 goto fail2;
1726 }
1727
1728 aiptek->inputdev = inputdev;
1729 aiptek->usbdev = usbdev;
1730 aiptek->ifnum = intf->altsetting[0].desc.bInterfaceNumber;
1731 aiptek->inDelay = 0;
1732 aiptek->endDelay = 0;
1733 aiptek->previousJitterable = 0;
1734 aiptek->lastMacro = -1;
1735
1736 /* Set up the curSettings struct. Said struct contains the current
1737 * programmable parameters. The newSetting struct contains changes
1738 * the user makes to the settings via the sysfs interface. Those
1739 * changes are not "committed" to curSettings until the user
1740 * writes to the sysfs/.../execute file.
1741 */
1742 aiptek->curSetting.pointerMode = AIPTEK_POINTER_EITHER_MODE;
1743 aiptek->curSetting.coordinateMode = AIPTEK_COORDINATE_ABSOLUTE_MODE;
1744 aiptek->curSetting.toolMode = AIPTEK_TOOL_BUTTON_PEN_MODE;
1745 aiptek->curSetting.xTilt = AIPTEK_TILT_DISABLE;
1746 aiptek->curSetting.yTilt = AIPTEK_TILT_DISABLE;
1747 aiptek->curSetting.mouseButtonLeft = AIPTEK_MOUSE_LEFT_BUTTON;
1748 aiptek->curSetting.mouseButtonMiddle = AIPTEK_MOUSE_MIDDLE_BUTTON;
1749 aiptek->curSetting.mouseButtonRight = AIPTEK_MOUSE_RIGHT_BUTTON;
1750 aiptek->curSetting.stylusButtonUpper = AIPTEK_STYLUS_UPPER_BUTTON;
1751 aiptek->curSetting.stylusButtonLower = AIPTEK_STYLUS_LOWER_BUTTON;
1752 aiptek->curSetting.jitterDelay = jitterDelay;
1753 aiptek->curSetting.programmableDelay = programmableDelay;
1754
1755 /* Both structs should have equivalent settings
1756 */
1757 aiptek->newSetting = aiptek->curSetting;
1758
1759 /* Determine the usb devices' physical path.
1760 * Asketh not why we always pretend we're using "../input0",
1761 * but I suspect this will have to be refactored one
1762 * day if a single USB device can be a keyboard & a mouse
1763 * & a tablet, and the inputX number actually will tell
1764 * us something...
1765 */
1766 usb_make_path(usbdev, aiptek->features.usbPath,
1767 sizeof(aiptek->features.usbPath));
1768 strlcat(aiptek->features.usbPath, "/input0",
1769 sizeof(aiptek->features.usbPath));
1770
1771 /* Set up client data, pointers to open and close routines
1772 * for the input device.
1773 */
1774 inputdev->name = "Aiptek";
1775 inputdev->phys = aiptek->features.usbPath;
1776 usb_to_input_id(usbdev, &inputdev->id);
1777 inputdev->dev.parent = &intf->dev;
1778
1779 input_set_drvdata(inputdev, aiptek);
1780
1781 inputdev->open = aiptek_open;
1782 inputdev->close = aiptek_close;
1783
1784 /* Now program the capacities of the tablet, in terms of being
1785 * an input device.
1786 */
1787 for (i = 0; i < ARRAY_SIZE(eventTypes); ++i)
1788 __set_bit(eventTypes[i], inputdev->evbit);
1789
1790 for (i = 0; i < ARRAY_SIZE(absEvents); ++i)
1791 __set_bit(absEvents[i], inputdev->absbit);
1792
1793 for (i = 0; i < ARRAY_SIZE(relEvents); ++i)
1794 __set_bit(relEvents[i], inputdev->relbit);
1795
1796 __set_bit(MSC_SERIAL, inputdev->mscbit);
1797
1798 /* Set up key and button codes */
1799 for (i = 0; i < ARRAY_SIZE(buttonEvents); ++i)
1800 __set_bit(buttonEvents[i], inputdev->keybit);
1801
1802 for (i = 0; i < ARRAY_SIZE(macroKeyEvents); ++i)
1803 __set_bit(macroKeyEvents[i], inputdev->keybit);
1804
1805 /*
1806 * Program the input device coordinate capacities. We do not yet
1807 * know what maximum X, Y, and Z values are, so we're putting fake
1808 * values in. Later, we'll ask the tablet to put in the correct
1809 * values.
1810 */
1811 input_set_abs_params(inputdev, ABS_X, 0, 2999, 0, 0);
1812 input_set_abs_params(inputdev, ABS_Y, 0, 2249, 0, 0);
1813 input_set_abs_params(inputdev, ABS_PRESSURE, 0, 511, 0, 0);
1814 input_set_abs_params(inputdev, ABS_TILT_X, AIPTEK_TILT_MIN, AIPTEK_TILT_MAX, 0, 0);
1815 input_set_abs_params(inputdev, ABS_TILT_Y, AIPTEK_TILT_MIN, AIPTEK_TILT_MAX, 0, 0);
1816 input_set_abs_params(inputdev, ABS_WHEEL, AIPTEK_WHEEL_MIN, AIPTEK_WHEEL_MAX - 1, 0, 0);
1817
1818 endpoint = &intf->altsetting[0].endpoint[0].desc;
1819
1820 /* Go set up our URB, which is called when the tablet receives
1821 * input.
1822 */
1823 usb_fill_int_urb(aiptek->urb,
1824 aiptek->usbdev,
1825 usb_rcvintpipe(aiptek->usbdev,
1826 endpoint->bEndpointAddress),
1827 aiptek->data, 8, aiptek_irq, aiptek,
1828 endpoint->bInterval);
1829
1830 aiptek->urb->transfer_dma = aiptek->data_dma;
1831 aiptek->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1832
1833 /* Program the tablet. This sets the tablet up in the mode
1834 * specified in newSetting, and also queries the tablet's
1835 * physical capacities.
1836 *
1837 * Sanity check: if a tablet doesn't like the slow programmatic
1838 * delay, we often get sizes of 0x0. Let's use that as an indicator
1839 * to try faster delays, up to 25 ms. If that logic fails, well, you'll
1840 * have to explain to us how your tablet thinks it's 0x0, and yet that's
1841 * not an error :-)
1842 */
1843
1844 for (i = 0; i < ARRAY_SIZE(speeds); ++i) {
1845 aiptek->curSetting.programmableDelay = speeds[i];
1846 (void)aiptek_program_tablet(aiptek);
1847 if (input_abs_get_max(aiptek->inputdev, ABS_X) > 0) {
1848 dev_info(&intf->dev,
1849 "Aiptek using %d ms programming speed\n",
1850 aiptek->curSetting.programmableDelay);
1851 break;
1852 }
1853 }
1854
1855 /* Murphy says that some day someone will have a tablet that fails the
1856 above test. That's you, Frederic Rodrigo */
1857 if (i == ARRAY_SIZE(speeds)) {
1858 dev_info(&intf->dev,
1859 "Aiptek tried all speeds, no sane response\n");
1860 goto fail2;
1861 }
1862
1863 /* Associate this driver's struct with the usb interface.
1864 */
1865 usb_set_intfdata(intf, aiptek);
1866
1867 /* Set up the sysfs files
1868 */
1869 err = sysfs_create_group(&intf->dev.kobj, &aiptek_attribute_group);
1870 if (err) {
1871 dev_warn(&intf->dev, "cannot create sysfs group err: %d\n",
1872 err);
1873 goto fail3;
1874 }
1875
1876 /* Register the tablet as an Input Device
1877 */
1878 err = input_register_device(aiptek->inputdev);
1879 if (err) {
1880 dev_warn(&intf->dev,
1881 "input_register_device returned err: %d\n", err);
1882 goto fail4;
1883 }
1884 return 0;
1885
1886 fail4: sysfs_remove_group(&intf->dev.kobj, &aiptek_attribute_group);
1887 fail3: usb_free_urb(aiptek->urb);
1888 fail2: usb_free_coherent(usbdev, AIPTEK_PACKET_LENGTH, aiptek->data,
1889 aiptek->data_dma);
1890 fail1: usb_set_intfdata(intf, NULL);
1891 input_free_device(inputdev);
1892 kfree(aiptek);
1893 return err;
1894 }
1895
1896 /***********************************************************************
1897 * Deal with tablet disconnecting from the system.
1898 */
1899 static void aiptek_disconnect(struct usb_interface *intf)
1900 {
1901 struct aiptek *aiptek = usb_get_intfdata(intf);
1902
1903 /* Disassociate driver's struct with usb interface
1904 */
1905 usb_set_intfdata(intf, NULL);
1906 if (aiptek != NULL) {
1907 /* Free & unhook everything from the system.
1908 */
1909 usb_kill_urb(aiptek->urb);
1910 input_unregister_device(aiptek->inputdev);
1911 sysfs_remove_group(&intf->dev.kobj, &aiptek_attribute_group);
1912 usb_free_urb(aiptek->urb);
1913 usb_free_coherent(interface_to_usbdev(intf),
1914 AIPTEK_PACKET_LENGTH,
1915 aiptek->data, aiptek->data_dma);
1916 kfree(aiptek);
1917 }
1918 }
1919
1920 static struct usb_driver aiptek_driver = {
1921 .name = "aiptek",
1922 .probe = aiptek_probe,
1923 .disconnect = aiptek_disconnect,
1924 .id_table = aiptek_ids,
1925 };
1926
1927 module_usb_driver(aiptek_driver);
1928
1929 MODULE_AUTHOR(DRIVER_AUTHOR);
1930 MODULE_DESCRIPTION(DRIVER_DESC);
1931 MODULE_LICENSE("GPL");
1932
1933 module_param(programmableDelay, int, 0);
1934 MODULE_PARM_DESC(programmableDelay, "delay used during tablet programming");
1935 module_param(jitterDelay, int, 0);
1936 MODULE_PARM_DESC(jitterDelay, "stylus/mouse settlement delay");