2 * Native support for the Aiptek HyperPen USB Tablets
3 * (4000U/5000U/6000U/8000U/12000U)
5 * Copyright (c) 2001 Chris Atenasio <chris@crud.net>
6 * Copyright (c) 2002-2004 Bryan W. Headley <bwheadley@earthlink.net>
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>
16 * Many thanks to Oliver Kuechemann for his support.
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
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.
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
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.
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.
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.
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
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>
85 #define DRIVER_VERSION "v1.5 (May-15-2004)"
86 #define DRIVER_AUTHOR "Bryan W. Headley/Chris Atenasio"
87 #define DRIVER_DESC "Aiptek HyperPen USB Tablet Driver (Linux 2.6.x)"
90 * Aiptek status packet:
92 * (returned as Report 1 - relative coordinates from mouse and stylus)
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
100 * (returned as Report 2 - absolute coordinates from the stylus)
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
112 * (returned as Report 3 - absolute coordinates from the mouse)
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
124 * (returned as Report 4 - macrokeys from the stylus)
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
134 * (returned as Report 5 - macrokeys from the mouse)
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
144 * IR: In Range = Proximity on
146 * BS = Barrel Switch (as in, macro keys)
147 * BS2 also referred to as Tablet Pick
151 * Use report_type CONTROL (3)
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
168 * To initialize the tablet:
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)
183 * (Step 9 can be omitted, but you'll then have no function keys.)
186 #define USB_VENDOR_ID_AIPTEK 0x08ca
187 #define USB_REQ_GET_REPORT 0x01
188 #define USB_REQ_SET_REPORT 0x09
192 #define AIPTEK_POINTER_ONLY_MOUSE_MODE 0
193 #define AIPTEK_POINTER_ONLY_STYLUS_MODE 1
194 #define AIPTEK_POINTER_EITHER_MODE 2
196 #define AIPTEK_POINTER_ALLOW_MOUSE_MODE(a) \
197 (a == AIPTEK_POINTER_ONLY_MOUSE_MODE || \
198 a == AIPTEK_POINTER_EITHER_MODE)
199 #define AIPTEK_POINTER_ALLOW_STYLUS_MODE(a) \
200 (a == AIPTEK_POINTER_ONLY_STYLUS_MODE || \
201 a == AIPTEK_POINTER_EITHER_MODE)
203 /* CoordinateMode code
205 #define AIPTEK_COORDINATE_RELATIVE_MODE 0
206 #define AIPTEK_COORDINATE_ABSOLUTE_MODE 1
208 /* XTilt and YTilt values
210 #define AIPTEK_TILT_MIN (-128)
211 #define AIPTEK_TILT_MAX 127
212 #define AIPTEK_TILT_DISABLE (-10101)
216 #define AIPTEK_WHEEL_MIN 0
217 #define AIPTEK_WHEEL_MAX 1024
218 #define AIPTEK_WHEEL_DISABLE (-10101)
220 /* ToolCode values, which BTW are 0x140 .. 0x14f
221 * We have things set up such that if TOOL_BUTTON_FIRED_BIT is
222 * not set, we'll send one instance of AIPTEK_TOOL_BUTTON_xxx.
224 * Whenever the user resets the value, TOOL_BUTTON_FIRED_BIT will
227 #define TOOL_BUTTON(x) ((x) & 0x14f)
228 #define TOOL_BUTTON_FIRED(x) ((x) & 0x200)
229 #define TOOL_BUTTON_FIRED_BIT 0x200
232 #define AIPTEK_TOOL_BUTTON_PEN_MODE BTN_TOOL_PEN
233 #define AIPTEK_TOOL_BUTTON_PEN_MODE BTN_TOOL_PEN
234 #define AIPTEK_TOOL_BUTTON_PENCIL_MODE BTN_TOOL_PENCIL
235 #define AIPTEK_TOOL_BUTTON_BRUSH_MODE BTN_TOOL_BRUSH
236 #define AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE BTN_TOOL_AIRBRUSH
237 #define AIPTEK_TOOL_BUTTON_ERASER_MODE BTN_TOOL_RUBBER
238 #define AIPTEK_TOOL_BUTTON_MOUSE_MODE BTN_TOOL_MOUSE
239 #define AIPTEK_TOOL_BUTTON_LENS_MODE BTN_TOOL_LENS
241 /* Diagnostic message codes
243 #define AIPTEK_DIAGNOSTIC_NA 0
244 #define AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE 1
245 #define AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE 2
246 #define AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED 3
248 /* Time to wait (in ms) to help mask hand jittering
249 * when pressing the stylus buttons.
251 #define AIPTEK_JITTER_DELAY_DEFAULT 50
253 /* Time to wait (in ms) in-between sending the tablet
254 * a command and beginning the process of reading the return
255 * sequence from the tablet.
257 #define AIPTEK_PROGRAMMABLE_DELAY_25 25
258 #define AIPTEK_PROGRAMMABLE_DELAY_50 50
259 #define AIPTEK_PROGRAMMABLE_DELAY_100 100
260 #define AIPTEK_PROGRAMMABLE_DELAY_200 200
261 #define AIPTEK_PROGRAMMABLE_DELAY_300 300
262 #define AIPTEK_PROGRAMMABLE_DELAY_400 400
263 #define AIPTEK_PROGRAMMABLE_DELAY_DEFAULT AIPTEK_PROGRAMMABLE_DELAY_400
265 /* Mouse button programming
267 #define AIPTEK_MOUSE_LEFT_BUTTON 0x04
268 #define AIPTEK_MOUSE_RIGHT_BUTTON 0x08
269 #define AIPTEK_MOUSE_MIDDLE_BUTTON 0x10
271 /* Stylus button programming
273 #define AIPTEK_STYLUS_LOWER_BUTTON 0x08
274 #define AIPTEK_STYLUS_UPPER_BUTTON 0x10
276 /* Length of incoming packet from the tablet
278 #define AIPTEK_PACKET_LENGTH 8
280 /* We report in EV_MISC both the proximity and
281 * whether the report came from the stylus, tablet mouse
282 * or "unknown" -- Unknown when the tablet is in relative
283 * mode, because we only get report 1's.
285 #define AIPTEK_REPORT_TOOL_UNKNOWN 0x10
286 #define AIPTEK_REPORT_TOOL_STYLUS 0x20
287 #define AIPTEK_REPORT_TOOL_MOUSE 0x40
289 static int programmableDelay = AIPTEK_PROGRAMMABLE_DELAY_DEFAULT;
290 static int jitterDelay = AIPTEK_JITTER_DELAY_DEFAULT;
292 struct aiptek_features {
293 int odmCode; /* Tablet manufacturer code */
294 int modelCode; /* Tablet model code (not unique) */
295 int firmwareCode; /* prom/eeprom version */
296 char usbPath[64 + 1]; /* device's physical usb path */
299 struct aiptek_settings {
300 int pointerMode; /* stylus-, mouse-only or either */
301 int coordinateMode; /* absolute/relative coords */
302 int toolMode; /* pen, pencil, brush, etc. tool */
303 int xTilt; /* synthetic xTilt amount */
304 int yTilt; /* synthetic yTilt amount */
305 int wheel; /* synthetic wheel amount */
306 int stylusButtonUpper; /* stylus upper btn delivers... */
307 int stylusButtonLower; /* stylus lower btn delivers... */
308 int mouseButtonLeft; /* mouse left btn delivers... */
309 int mouseButtonMiddle; /* mouse middle btn delivers... */
310 int mouseButtonRight; /* mouse right btn delivers... */
311 int programmableDelay; /* delay for tablet programming */
312 int jitterDelay; /* delay for hand jittering */
316 struct input_dev *inputdev; /* input device struct */
317 struct usb_device *usbdev; /* usb device struct */
318 struct urb *urb; /* urb for incoming reports */
319 dma_addr_t data_dma; /* our dma stuffage */
320 struct aiptek_features features; /* tablet's array of features */
321 struct aiptek_settings curSetting; /* tablet's current programmable */
322 struct aiptek_settings newSetting; /* ... and new param settings */
323 unsigned int ifnum; /* interface number for IO */
324 int diagnostic; /* tablet diagnostic codes */
325 unsigned long eventCount; /* event count */
326 int inDelay; /* jitter: in jitter delay? */
327 unsigned long endDelay; /* jitter: time when delay ends */
328 int previousJitterable; /* jitterable prev value */
329 unsigned char *data; /* incoming packet data */
332 static const int eventTypes[] = {
333 EV_KEY, EV_ABS, EV_REL, EV_MSC,
336 static const int absEvents[] = {
337 ABS_X, ABS_Y, ABS_PRESSURE, ABS_TILT_X, ABS_TILT_Y,
341 static const int relEvents[] = {
342 REL_X, REL_Y, REL_WHEEL,
345 static const int buttonEvents[] = {
346 BTN_LEFT, BTN_RIGHT, BTN_MIDDLE,
347 BTN_TOOL_PEN, BTN_TOOL_RUBBER, BTN_TOOL_PENCIL, BTN_TOOL_AIRBRUSH,
348 BTN_TOOL_BRUSH, BTN_TOOL_MOUSE, BTN_TOOL_LENS, BTN_TOUCH,
349 BTN_STYLUS, BTN_STYLUS2,
353 * Permit easy lookup of keyboard events to send, versus
354 * the bitmap which comes from the tablet. This hides the
355 * issue that the F_keys are not sequentially numbered.
357 static const int macroKeyEvents[] = {
358 KEY_ESC, KEY_F1, KEY_F2, KEY_F3, KEY_F4, KEY_F5,
359 KEY_F6, KEY_F7, KEY_F8, KEY_F9, KEY_F10, KEY_F11,
360 KEY_F12, KEY_F13, KEY_F14, KEY_F15, KEY_F16, KEY_F17,
361 KEY_F18, KEY_F19, KEY_F20, KEY_F21, KEY_F22, KEY_F23,
362 KEY_F24, KEY_STOP, KEY_AGAIN, KEY_PROPS, KEY_UNDO,
363 KEY_FRONT, KEY_COPY, KEY_OPEN, KEY_PASTE, 0
366 /***********************************************************************
367 * Map values to strings and back. Every map shoudl have the following
368 * as its last element: { NULL, AIPTEK_INVALID_VALUE }.
370 #define AIPTEK_INVALID_VALUE -1
377 static int map_str_to_val(const struct aiptek_map *map, const char *str, size_t count)
379 const struct aiptek_map *p;
381 for (p = map; p->string; p++)
382 if (!strncmp(str, p->string, count))
385 return AIPTEK_INVALID_VALUE;
388 static const char *map_val_to_str(const struct aiptek_map *map, int val)
390 const struct aiptek_map *p;
392 for (p = map; p->value != AIPTEK_INVALID_VALUE; p++)
399 /***********************************************************************
400 * aiptek_irq can receive one of six potential reports.
401 * The documentation for each is in the body of the function.
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.
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
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.
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.
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.)
433 static void aiptek_irq(struct urb *urb)
435 struct aiptek *aiptek = urb->context;
436 unsigned char *data = aiptek->data;
437 struct input_dev *inputdev = aiptek->inputdev;
439 int retval, macro, x, y, z, left, right, middle, p, dv, tip, bs, pck;
441 switch (urb->status) {
449 /* This urb is terminated, clean up */
450 dbg("%s - urb shutting down with status: %d",
451 __FUNCTION__, urb->status);
455 dbg("%s - nonzero urb status received: %d",
456 __FUNCTION__, urb->status);
460 /* See if we are in a delay loop -- throw out report if true.
462 if (aiptek->inDelay == 1 && time_after(aiptek->endDelay, jiffies)) {
467 aiptek->eventCount++;
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.
474 if (aiptek->curSetting.coordinateMode ==
475 AIPTEK_COORDINATE_ABSOLUTE_MODE) {
477 AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE;
479 x = (signed char) data[2];
480 y = (signed char) data[3];
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.)
489 jitterable = data[1] & 0x07;
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;
495 input_report_key(inputdev, BTN_LEFT, left);
496 input_report_key(inputdev, BTN_MIDDLE, middle);
497 input_report_key(inputdev, BTN_RIGHT, right);
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);
504 /* Wheel support is in the form of a single-event
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;
512 input_sync(inputdev);
515 /* Report 2 is delivered only by the stylus, and delivers
516 * absolute coordinates.
518 else if (data[0] == 2) {
519 if (aiptek->curSetting.coordinateMode == AIPTEK_COORDINATE_RELATIVE_MODE) {
520 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE;
521 } else if (!AIPTEK_POINTER_ALLOW_STYLUS_MODE
522 (aiptek->curSetting.pointerMode)) {
523 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED;
525 x = le16_to_cpu(get_unaligned((__le16 *) (data + 1)));
526 y = le16_to_cpu(get_unaligned((__le16 *) (data + 3)));
527 z = le16_to_cpu(get_unaligned((__le16 *) (data + 6)));
529 dv = (data[5] & 0x01) != 0 ? 1 : 0;
530 p = (data[5] & 0x02) != 0 ? 1 : 0;
531 tip = (data[5] & 0x04) != 0 ? 1 : 0;
533 /* Use jitterable to re-arrange button masks
535 jitterable = data[5] & 0x18;
537 bs = (data[5] & aiptek->curSetting.stylusButtonLower) != 0 ? 1 : 0;
538 pck = (data[5] & aiptek->curSetting.stylusButtonUpper) != 0 ? 1 : 0;
540 /* dv indicates 'data valid' (e.g., the tablet is in sync
541 * and has delivered a "correct" report) We will ignore
542 * all 'bad' reports...
545 /* If we've not already sent a tool_button_?? code, do
546 * so now. Then set FIRED_BIT so it won't be resent unless
547 * the user forces FIRED_BIT off.
549 if (TOOL_BUTTON_FIRED
550 (aiptek->curSetting.toolMode) == 0) {
551 input_report_key(inputdev,
552 TOOL_BUTTON(aiptek->curSetting.toolMode),
554 aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
558 input_report_abs(inputdev, ABS_X, x);
559 input_report_abs(inputdev, ABS_Y, y);
560 input_report_abs(inputdev, ABS_PRESSURE, z);
562 input_report_key(inputdev, BTN_TOUCH, tip);
563 input_report_key(inputdev, BTN_STYLUS, bs);
564 input_report_key(inputdev, BTN_STYLUS2, pck);
566 if (aiptek->curSetting.xTilt !=
567 AIPTEK_TILT_DISABLE) {
568 input_report_abs(inputdev,
570 aiptek->curSetting.xTilt);
572 if (aiptek->curSetting.yTilt != AIPTEK_TILT_DISABLE) {
573 input_report_abs(inputdev,
575 aiptek->curSetting.yTilt);
578 /* Wheel support is in the form of a single-event
581 if (aiptek->curSetting.wheel !=
582 AIPTEK_WHEEL_DISABLE) {
583 input_report_abs(inputdev,
585 aiptek->curSetting.wheel);
586 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
589 input_report_abs(inputdev, ABS_MISC, p | AIPTEK_REPORT_TOOL_STYLUS);
590 input_sync(inputdev);
594 /* Report 3's come from the mouse in absolute mode.
596 else if (data[0] == 3) {
597 if (aiptek->curSetting.coordinateMode == AIPTEK_COORDINATE_RELATIVE_MODE) {
598 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE;
599 } else if (!AIPTEK_POINTER_ALLOW_MOUSE_MODE
600 (aiptek->curSetting.pointerMode)) {
601 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED;
603 x = le16_to_cpu(get_unaligned((__le16 *) (data + 1)));
604 y = le16_to_cpu(get_unaligned((__le16 *) (data + 3)));
606 jitterable = data[5] & 0x1c;
608 dv = (data[5] & 0x01) != 0 ? 1 : 0;
609 p = (data[5] & 0x02) != 0 ? 1 : 0;
610 left = (data[5] & aiptek->curSetting.mouseButtonLeft) != 0 ? 1 : 0;
611 right = (data[5] & aiptek->curSetting.mouseButtonRight) != 0 ? 1 : 0;
612 middle = (data[5] & aiptek->curSetting.mouseButtonMiddle) != 0 ? 1 : 0;
615 /* If we've not already sent a tool_button_?? code, do
616 * so now. Then set FIRED_BIT so it won't be resent unless
617 * the user forces FIRED_BIT off.
619 if (TOOL_BUTTON_FIRED
620 (aiptek->curSetting.toolMode) == 0) {
621 input_report_key(inputdev,
622 TOOL_BUTTON(aiptek->curSetting.toolMode),
624 aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
628 input_report_abs(inputdev, ABS_X, x);
629 input_report_abs(inputdev, ABS_Y, y);
631 input_report_key(inputdev, BTN_LEFT, left);
632 input_report_key(inputdev, BTN_MIDDLE, middle);
633 input_report_key(inputdev, BTN_RIGHT, right);
635 /* Wheel support is in the form of a single-event
638 if (aiptek->curSetting.wheel != AIPTEK_WHEEL_DISABLE) {
639 input_report_abs(inputdev,
641 aiptek->curSetting.wheel);
642 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
645 input_report_abs(inputdev, ABS_MISC, p | AIPTEK_REPORT_TOOL_MOUSE);
646 input_sync(inputdev);
650 /* Report 4s come from the macro keys when pressed by stylus
652 else if (data[0] == 4) {
653 jitterable = data[1] & 0x18;
655 dv = (data[1] & 0x01) != 0 ? 1 : 0;
656 p = (data[1] & 0x02) != 0 ? 1 : 0;
657 tip = (data[1] & 0x04) != 0 ? 1 : 0;
658 bs = (data[1] & aiptek->curSetting.stylusButtonLower) != 0 ? 1 : 0;
659 pck = (data[1] & aiptek->curSetting.stylusButtonUpper) != 0 ? 1 : 0;
662 z = le16_to_cpu(get_unaligned((__le16 *) (data + 4)));
665 /* If we've not already sent a tool_button_?? code, do
666 * so now. Then set FIRED_BIT so it won't be resent unless
667 * the user forces FIRED_BIT off.
669 if (TOOL_BUTTON_FIRED(aiptek->curSetting.toolMode) == 0) {
670 input_report_key(inputdev,
671 TOOL_BUTTON(aiptek->curSetting.toolMode),
673 aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
677 input_report_key(inputdev, BTN_TOUCH, tip);
678 input_report_key(inputdev, BTN_STYLUS, bs);
679 input_report_key(inputdev, BTN_STYLUS2, pck);
680 input_report_abs(inputdev, ABS_PRESSURE, z);
683 /* For safety, we're sending key 'break' codes for the
684 * neighboring macro keys.
687 input_report_key(inputdev,
688 macroKeyEvents[macro - 1], 0);
691 input_report_key(inputdev,
692 macroKeyEvents[macro + 1], 0);
694 input_report_key(inputdev, macroKeyEvents[macro], p);
695 input_report_abs(inputdev, ABS_MISC,
696 p | AIPTEK_REPORT_TOOL_STYLUS);
697 input_sync(inputdev);
700 /* Report 5s come from the macro keys when pressed by mouse
702 else if (data[0] == 5) {
703 jitterable = data[1] & 0x1c;
705 dv = (data[1] & 0x01) != 0 ? 1 : 0;
706 p = (data[1] & 0x02) != 0 ? 1 : 0;
707 left = (data[1]& aiptek->curSetting.mouseButtonLeft) != 0 ? 1 : 0;
708 right = (data[1] & aiptek->curSetting.mouseButtonRight) != 0 ? 1 : 0;
709 middle = (data[1] & aiptek->curSetting.mouseButtonMiddle) != 0 ? 1 : 0;
713 /* If we've not already sent a tool_button_?? code, do
714 * so now. Then set FIRED_BIT so it won't be resent unless
715 * the user forces FIRED_BIT off.
717 if (TOOL_BUTTON_FIRED(aiptek->curSetting.toolMode) == 0) {
718 input_report_key(inputdev,
719 TOOL_BUTTON(aiptek->curSetting.toolMode),
721 aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
725 input_report_key(inputdev, BTN_LEFT, left);
726 input_report_key(inputdev, BTN_MIDDLE, middle);
727 input_report_key(inputdev, BTN_RIGHT, right);
730 /* For safety, we're sending key 'break' codes for the
731 * neighboring macro keys.
734 input_report_key(inputdev,
735 macroKeyEvents[macro - 1], 0);
738 input_report_key(inputdev,
739 macroKeyEvents[macro + 1], 0);
742 input_report_key(inputdev, macroKeyEvents[macro], 1);
743 input_report_rel(inputdev, ABS_MISC,
744 p | AIPTEK_REPORT_TOOL_MOUSE);
745 input_sync(inputdev);
748 /* We have no idea which tool can generate a report 6. Theoretically,
749 * neither need to, having been given reports 4 & 5 for such use.
750 * However, report 6 is the 'official-looking' report for macroKeys;
751 * reports 4 & 5 supposively are used to support unnamed, unknown
752 * hat switches (which just so happen to be the macroKeys.)
754 else if (data[0] == 6) {
755 macro = le16_to_cpu(get_unaligned((__le16 *) (data + 1)));
757 input_report_key(inputdev, macroKeyEvents[macro - 1],
761 input_report_key(inputdev, macroKeyEvents[macro + 1],
765 /* If we've not already sent a tool_button_?? code, do
766 * so now. Then set FIRED_BIT so it won't be resent unless
767 * the user forces FIRED_BIT off.
769 if (TOOL_BUTTON_FIRED(aiptek->curSetting.toolMode) == 0) {
770 input_report_key(inputdev,
771 TOOL_BUTTON(aiptek->curSetting.
773 aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
776 input_report_key(inputdev, macroKeyEvents[macro], 1);
777 input_report_abs(inputdev, ABS_MISC,
778 1 | AIPTEK_REPORT_TOOL_UNKNOWN);
779 input_sync(inputdev);
781 dbg("Unknown report %d", data[0]);
784 /* Jitter may occur when the user presses a button on the stlyus
785 * or the mouse. What we do to prevent that is wait 'x' milliseconds
786 * following a 'jitterable' event, which should give the hand some time
789 * We just introduced aiptek->previousJitterable to carry forth the
790 * notion that jitter occurs when the button state changes from on to off:
791 * a person drawing, holding a button down is not subject to jittering.
792 * With that in mind, changing from upper button depressed to lower button
793 * WILL transition through a jitter delay.
796 if (aiptek->previousJitterable != jitterable &&
797 aiptek->curSetting.jitterDelay != 0 && aiptek->inDelay != 1) {
798 aiptek->endDelay = jiffies +
799 ((aiptek->curSetting.jitterDelay * HZ) / 1000);
802 aiptek->previousJitterable = jitterable;
805 retval = usb_submit_urb(urb, GFP_ATOMIC);
807 err("%s - usb_submit_urb failed with result %d",
808 __FUNCTION__, retval);
812 /***********************************************************************
813 * These are the USB id's known so far. We do not identify them to
814 * specific Aiptek model numbers, because there has been overlaps,
815 * use, and reuse of id's in existing models. Certain models have
816 * been known to use more than one ID, indicative perhaps of
817 * manufacturing revisions. In any event, we consider these
818 * IDs to not be model-specific nor unique.
820 static const struct usb_device_id aiptek_ids[] = {
821 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x01)},
822 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x10)},
823 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x20)},
824 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x21)},
825 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x22)},
826 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x23)},
827 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x24)},
831 MODULE_DEVICE_TABLE(usb, aiptek_ids);
833 /***********************************************************************
834 * Open an instance of the tablet driver.
836 static int aiptek_open(struct input_dev *inputdev)
838 struct aiptek *aiptek = input_get_drvdata(inputdev);
840 aiptek->urb->dev = aiptek->usbdev;
841 if (usb_submit_urb(aiptek->urb, GFP_KERNEL) != 0)
847 /***********************************************************************
848 * Close an instance of the tablet driver.
850 static void aiptek_close(struct input_dev *inputdev)
852 struct aiptek *aiptek = input_get_drvdata(inputdev);
854 usb_kill_urb(aiptek->urb);
857 /***********************************************************************
858 * aiptek_set_report and aiptek_get_report() are borrowed from Linux 2.4.x,
859 * where they were known as usb_set_report and usb_get_report.
862 aiptek_set_report(struct aiptek *aiptek,
863 unsigned char report_type,
864 unsigned char report_id, void *buffer, int size)
866 return usb_control_msg(aiptek->usbdev,
867 usb_sndctrlpipe(aiptek->usbdev, 0),
869 USB_TYPE_CLASS | USB_RECIP_INTERFACE |
870 USB_DIR_OUT, (report_type << 8) + report_id,
871 aiptek->ifnum, buffer, size, 5000);
875 aiptek_get_report(struct aiptek *aiptek,
876 unsigned char report_type,
877 unsigned char report_id, void *buffer, int size)
879 return usb_control_msg(aiptek->usbdev,
880 usb_rcvctrlpipe(aiptek->usbdev, 0),
882 USB_TYPE_CLASS | USB_RECIP_INTERFACE |
883 USB_DIR_IN, (report_type << 8) + report_id,
884 aiptek->ifnum, buffer, size, 5000);
887 /***********************************************************************
888 * Send a command to the tablet.
891 aiptek_command(struct aiptek *aiptek, unsigned char command, unsigned char data)
893 const int sizeof_buf = 3 * sizeof(u8);
897 buf = kmalloc(sizeof_buf, GFP_KERNEL);
906 aiptek_set_report(aiptek, 3, 2, buf, sizeof_buf)) != sizeof_buf) {
907 dbg("aiptek_program: failed, tried to send: 0x%02x 0x%02x",
911 return ret < 0 ? ret : 0;
914 /***********************************************************************
915 * Retrieve information from the tablet. Querying info is defined as first
916 * sending the {command,data} sequence as a command, followed by a wait
917 * (aka, "programmaticDelay") and then a "read" request.
920 aiptek_query(struct aiptek *aiptek, unsigned char command, unsigned char data)
922 const int sizeof_buf = 3 * sizeof(u8);
926 buf = kmalloc(sizeof_buf, GFP_KERNEL);
934 if (aiptek_command(aiptek, command, data) != 0) {
938 msleep(aiptek->curSetting.programmableDelay);
941 aiptek_get_report(aiptek, 3, 2, buf, sizeof_buf)) != sizeof_buf) {
942 dbg("aiptek_query failed: returned 0x%02x 0x%02x 0x%02x",
943 buf[0], buf[1], buf[2]);
946 ret = le16_to_cpu(get_unaligned((__le16 *) (buf + 1)));
952 /***********************************************************************
953 * Program the tablet into either absolute or relative mode.
954 * We also get information about the tablet's size.
956 static int aiptek_program_tablet(struct aiptek *aiptek)
959 /* Execute Resolution500LPI */
960 if ((ret = aiptek_command(aiptek, 0x18, 0x04)) < 0)
963 /* Query getModelCode */
964 if ((ret = aiptek_query(aiptek, 0x02, 0x00)) < 0)
966 aiptek->features.modelCode = ret & 0xff;
968 /* Query getODMCode */
969 if ((ret = aiptek_query(aiptek, 0x03, 0x00)) < 0)
971 aiptek->features.odmCode = ret;
973 /* Query getFirmwareCode */
974 if ((ret = aiptek_query(aiptek, 0x04, 0x00)) < 0)
976 aiptek->features.firmwareCode = ret;
978 /* Query getXextension */
979 if ((ret = aiptek_query(aiptek, 0x01, 0x00)) < 0)
981 aiptek->inputdev->absmin[ABS_X] = 0;
982 aiptek->inputdev->absmax[ABS_X] = ret - 1;
984 /* Query getYextension */
985 if ((ret = aiptek_query(aiptek, 0x01, 0x01)) < 0)
987 aiptek->inputdev->absmin[ABS_Y] = 0;
988 aiptek->inputdev->absmax[ABS_Y] = ret - 1;
990 /* Query getPressureLevels */
991 if ((ret = aiptek_query(aiptek, 0x08, 0x00)) < 0)
993 aiptek->inputdev->absmin[ABS_PRESSURE] = 0;
994 aiptek->inputdev->absmax[ABS_PRESSURE] = ret - 1;
996 /* Depending on whether we are in absolute or relative mode, we will
997 * do a switchToTablet(absolute) or switchToMouse(relative) command.
999 if (aiptek->curSetting.coordinateMode ==
1000 AIPTEK_COORDINATE_ABSOLUTE_MODE) {
1001 /* Execute switchToTablet */
1002 if ((ret = aiptek_command(aiptek, 0x10, 0x01)) < 0) {
1006 /* Execute switchToMouse */
1007 if ((ret = aiptek_command(aiptek, 0x10, 0x00)) < 0) {
1012 /* Enable the macro keys */
1013 if ((ret = aiptek_command(aiptek, 0x11, 0x02)) < 0)
1016 /* Execute FilterOn */
1017 if ((ret = aiptek_command(aiptek, 0x17, 0x00)) < 0)
1021 /* Execute AutoGainOn */
1022 if ((ret = aiptek_command(aiptek, 0x12, 0xff)) < 0)
1025 /* Reset the eventCount, so we track events from last (re)programming
1027 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_NA;
1028 aiptek->eventCount = 0;
1033 /***********************************************************************
1034 * Sysfs functions. Sysfs prefers that individually-tunable parameters
1035 * exist in their separate pseudo-files. Summary data that is immutable
1036 * may exist in a singular file so long as you don't define a writeable
1040 /***********************************************************************
1041 * support the 'size' file -- display support
1043 static ssize_t show_tabletSize(struct device *dev, struct device_attribute *attr, char *buf)
1045 struct aiptek *aiptek = dev_get_drvdata(dev);
1047 return snprintf(buf, PAGE_SIZE, "%dx%d\n",
1048 aiptek->inputdev->absmax[ABS_X] + 1,
1049 aiptek->inputdev->absmax[ABS_Y] + 1);
1052 /* These structs define the sysfs files, param #1 is the name of the
1053 * file, param 2 is the file permissions, param 3 & 4 are to the
1054 * output generator and input parser routines. Absence of a routine is
1055 * permitted -- it only means can't either 'cat' the file, or send data
1058 static DEVICE_ATTR(size, S_IRUGO, show_tabletSize, NULL);
1060 /***********************************************************************
1061 * support routines for the 'pointer_mode' file. Note that this file
1062 * both displays current setting and allows reprogramming.
1064 static struct aiptek_map pointer_mode_map[] = {
1065 { "stylus", AIPTEK_POINTER_ONLY_STYLUS_MODE },
1066 { "mouse", AIPTEK_POINTER_ONLY_MOUSE_MODE },
1067 { "either", AIPTEK_POINTER_EITHER_MODE },
1068 { NULL, AIPTEK_INVALID_VALUE }
1071 static ssize_t show_tabletPointerMode(struct device *dev, struct device_attribute *attr, char *buf)
1073 struct aiptek *aiptek = dev_get_drvdata(dev);
1075 return snprintf(buf, PAGE_SIZE, "%s\n",
1076 map_val_to_str(pointer_mode_map,
1077 aiptek->curSetting.pointerMode));
1081 store_tabletPointerMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1083 struct aiptek *aiptek = dev_get_drvdata(dev);
1084 int new_mode = map_str_to_val(pointer_mode_map, buf, count);
1086 if (new_mode == AIPTEK_INVALID_VALUE)
1089 aiptek->newSetting.pointerMode = new_mode;
1093 static DEVICE_ATTR(pointer_mode,
1095 show_tabletPointerMode, store_tabletPointerMode);
1097 /***********************************************************************
1098 * support routines for the 'coordinate_mode' file. Note that this file
1099 * both displays current setting and allows reprogramming.
1102 static struct aiptek_map coordinate_mode_map[] = {
1103 { "absolute", AIPTEK_COORDINATE_ABSOLUTE_MODE },
1104 { "relative", AIPTEK_COORDINATE_RELATIVE_MODE },
1105 { NULL, AIPTEK_INVALID_VALUE }
1108 static ssize_t show_tabletCoordinateMode(struct device *dev, struct device_attribute *attr, char *buf)
1110 struct aiptek *aiptek = dev_get_drvdata(dev);
1112 return snprintf(buf, PAGE_SIZE, "%s\n",
1113 map_val_to_str(coordinate_mode_map,
1114 aiptek->curSetting.coordinateMode));
1118 store_tabletCoordinateMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1120 struct aiptek *aiptek = dev_get_drvdata(dev);
1121 int new_mode = map_str_to_val(coordinate_mode_map, buf, count);
1123 if (new_mode == AIPTEK_INVALID_VALUE)
1126 aiptek->newSetting.coordinateMode = new_mode;
1130 static DEVICE_ATTR(coordinate_mode,
1132 show_tabletCoordinateMode, store_tabletCoordinateMode);
1134 /***********************************************************************
1135 * support routines for the 'tool_mode' file. Note that this file
1136 * both displays current setting and allows reprogramming.
1139 static struct aiptek_map tool_mode_map[] = {
1140 { "mouse", AIPTEK_TOOL_BUTTON_MOUSE_MODE },
1141 { "eraser", AIPTEK_TOOL_BUTTON_ERASER_MODE },
1142 { "pencil", AIPTEK_TOOL_BUTTON_PENCIL_MODE },
1143 { "pen", AIPTEK_TOOL_BUTTON_PEN_MODE },
1144 { "brush", AIPTEK_TOOL_BUTTON_BRUSH_MODE },
1145 { "airbrush", AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE },
1146 { "lens", AIPTEK_TOOL_BUTTON_LENS_MODE },
1147 { NULL, AIPTEK_INVALID_VALUE }
1150 static ssize_t show_tabletToolMode(struct device *dev, struct device_attribute *attr, char *buf)
1152 struct aiptek *aiptek = dev_get_drvdata(dev);
1154 return snprintf(buf, PAGE_SIZE, "%s\n",
1155 map_val_to_str(tool_mode_map,
1156 aiptek->curSetting.toolMode));
1160 store_tabletToolMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1162 struct aiptek *aiptek = dev_get_drvdata(dev);
1163 int new_mode = map_str_to_val(tool_mode_map, buf, count);
1165 if (new_mode == AIPTEK_INVALID_VALUE)
1168 aiptek->newSetting.toolMode = new_mode;
1172 static DEVICE_ATTR(tool_mode,
1174 show_tabletToolMode, store_tabletToolMode);
1176 /***********************************************************************
1177 * support routines for the 'xtilt' file. Note that this file
1178 * both displays current setting and allows reprogramming.
1180 static ssize_t show_tabletXtilt(struct device *dev, struct device_attribute *attr, char *buf)
1182 struct aiptek *aiptek = dev_get_drvdata(dev);
1184 if (aiptek->curSetting.xTilt == AIPTEK_TILT_DISABLE) {
1185 return snprintf(buf, PAGE_SIZE, "disable\n");
1187 return snprintf(buf, PAGE_SIZE, "%d\n",
1188 aiptek->curSetting.xTilt);
1193 store_tabletXtilt(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1195 struct aiptek *aiptek = dev_get_drvdata(dev);
1198 if (strcmp(buf, "disable") == 0) {
1199 aiptek->newSetting.xTilt = AIPTEK_TILT_DISABLE;
1201 x = (int)simple_strtol(buf, NULL, 10);
1202 if (x >= AIPTEK_TILT_MIN && x <= AIPTEK_TILT_MAX) {
1203 aiptek->newSetting.xTilt = x;
1209 static DEVICE_ATTR(xtilt,
1210 S_IRUGO | S_IWUGO, show_tabletXtilt, store_tabletXtilt);
1212 /***********************************************************************
1213 * support routines for the 'ytilt' file. Note that this file
1214 * both displays current setting and allows reprogramming.
1216 static ssize_t show_tabletYtilt(struct device *dev, struct device_attribute *attr, char *buf)
1218 struct aiptek *aiptek = dev_get_drvdata(dev);
1220 if (aiptek->curSetting.yTilt == AIPTEK_TILT_DISABLE) {
1221 return snprintf(buf, PAGE_SIZE, "disable\n");
1223 return snprintf(buf, PAGE_SIZE, "%d\n",
1224 aiptek->curSetting.yTilt);
1229 store_tabletYtilt(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1231 struct aiptek *aiptek = dev_get_drvdata(dev);
1234 if (strcmp(buf, "disable") == 0) {
1235 aiptek->newSetting.yTilt = AIPTEK_TILT_DISABLE;
1237 y = (int)simple_strtol(buf, NULL, 10);
1238 if (y >= AIPTEK_TILT_MIN && y <= AIPTEK_TILT_MAX) {
1239 aiptek->newSetting.yTilt = y;
1245 static DEVICE_ATTR(ytilt,
1246 S_IRUGO | S_IWUGO, show_tabletYtilt, store_tabletYtilt);
1248 /***********************************************************************
1249 * support routines for the 'jitter' file. Note that this file
1250 * both displays current setting and allows reprogramming.
1252 static ssize_t show_tabletJitterDelay(struct device *dev, struct device_attribute *attr, char *buf)
1254 struct aiptek *aiptek = dev_get_drvdata(dev);
1256 return snprintf(buf, PAGE_SIZE, "%d\n", aiptek->curSetting.jitterDelay);
1260 store_tabletJitterDelay(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1262 struct aiptek *aiptek = dev_get_drvdata(dev);
1264 aiptek->newSetting.jitterDelay = (int)simple_strtol(buf, NULL, 10);
1268 static DEVICE_ATTR(jitter,
1270 show_tabletJitterDelay, store_tabletJitterDelay);
1272 /***********************************************************************
1273 * support routines for the 'delay' file. Note that this file
1274 * both displays current setting and allows reprogramming.
1276 static ssize_t show_tabletProgrammableDelay(struct device *dev, struct device_attribute *attr, char *buf)
1278 struct aiptek *aiptek = dev_get_drvdata(dev);
1280 return snprintf(buf, PAGE_SIZE, "%d\n",
1281 aiptek->curSetting.programmableDelay);
1285 store_tabletProgrammableDelay(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1287 struct aiptek *aiptek = dev_get_drvdata(dev);
1289 aiptek->newSetting.programmableDelay = (int)simple_strtol(buf, NULL, 10);
1293 static DEVICE_ATTR(delay,
1295 show_tabletProgrammableDelay, store_tabletProgrammableDelay);
1297 /***********************************************************************
1298 * support routines for the 'event_count' file. Note that this file
1299 * only displays current setting.
1301 static ssize_t show_tabletEventsReceived(struct device *dev, struct device_attribute *attr, char *buf)
1303 struct aiptek *aiptek = dev_get_drvdata(dev);
1305 return snprintf(buf, PAGE_SIZE, "%ld\n", aiptek->eventCount);
1308 static DEVICE_ATTR(event_count, S_IRUGO, show_tabletEventsReceived, NULL);
1310 /***********************************************************************
1311 * support routines for the 'diagnostic' file. Note that this file
1312 * only displays current setting.
1314 static ssize_t show_tabletDiagnosticMessage(struct device *dev, struct device_attribute *attr, char *buf)
1316 struct aiptek *aiptek = dev_get_drvdata(dev);
1319 switch (aiptek->diagnostic) {
1320 case AIPTEK_DIAGNOSTIC_NA:
1321 retMsg = "no errors\n";
1324 case AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE:
1325 retMsg = "Error: receiving relative reports\n";
1328 case AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE:
1329 retMsg = "Error: receiving absolute reports\n";
1332 case AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED:
1333 if (aiptek->curSetting.pointerMode ==
1334 AIPTEK_POINTER_ONLY_MOUSE_MODE) {
1335 retMsg = "Error: receiving stylus reports\n";
1337 retMsg = "Error: receiving mouse reports\n";
1344 return snprintf(buf, PAGE_SIZE, retMsg);
1347 static DEVICE_ATTR(diagnostic, S_IRUGO, show_tabletDiagnosticMessage, NULL);
1349 /***********************************************************************
1350 * support routines for the 'stylus_upper' file. Note that this file
1351 * both displays current setting and allows for setting changing.
1354 static struct aiptek_map stylus_button_map[] = {
1355 { "upper", AIPTEK_STYLUS_UPPER_BUTTON },
1356 { "lower", AIPTEK_STYLUS_LOWER_BUTTON },
1357 { NULL, AIPTEK_INVALID_VALUE }
1360 static ssize_t show_tabletStylusUpper(struct device *dev, struct device_attribute *attr, char *buf)
1362 struct aiptek *aiptek = dev_get_drvdata(dev);
1364 return snprintf(buf, PAGE_SIZE, "%s\n",
1365 map_val_to_str(stylus_button_map,
1366 aiptek->curSetting.stylusButtonUpper));
1370 store_tabletStylusUpper(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1372 struct aiptek *aiptek = dev_get_drvdata(dev);
1373 int new_button = map_str_to_val(stylus_button_map, buf, count);
1375 if (new_button == AIPTEK_INVALID_VALUE)
1378 aiptek->newSetting.stylusButtonUpper = new_button;
1382 static DEVICE_ATTR(stylus_upper,
1384 show_tabletStylusUpper, store_tabletStylusUpper);
1386 /***********************************************************************
1387 * support routines for the 'stylus_lower' file. Note that this file
1388 * both displays current setting and allows for setting changing.
1391 static ssize_t show_tabletStylusLower(struct device *dev, struct device_attribute *attr, char *buf)
1393 struct aiptek *aiptek = dev_get_drvdata(dev);
1395 return snprintf(buf, PAGE_SIZE, "%s\n",
1396 map_val_to_str(stylus_button_map,
1397 aiptek->curSetting.stylusButtonLower));
1401 store_tabletStylusLower(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1403 struct aiptek *aiptek = dev_get_drvdata(dev);
1404 int new_button = map_str_to_val(stylus_button_map, buf, count);
1406 if (new_button == AIPTEK_INVALID_VALUE)
1409 aiptek->newSetting.stylusButtonLower = new_button;
1413 static DEVICE_ATTR(stylus_lower,
1415 show_tabletStylusLower, store_tabletStylusLower);
1417 /***********************************************************************
1418 * support routines for the 'mouse_left' file. Note that this file
1419 * both displays current setting and allows for setting changing.
1422 static struct aiptek_map mouse_button_map[] = {
1423 { "left", AIPTEK_MOUSE_LEFT_BUTTON },
1424 { "middle", AIPTEK_MOUSE_MIDDLE_BUTTON },
1425 { "right", AIPTEK_MOUSE_RIGHT_BUTTON },
1426 { NULL, AIPTEK_INVALID_VALUE }
1429 static ssize_t show_tabletMouseLeft(struct device *dev, struct device_attribute *attr, char *buf)
1431 struct aiptek *aiptek = dev_get_drvdata(dev);
1433 return snprintf(buf, PAGE_SIZE, "%s\n",
1434 map_val_to_str(mouse_button_map,
1435 aiptek->curSetting.mouseButtonLeft));
1439 store_tabletMouseLeft(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1441 struct aiptek *aiptek = dev_get_drvdata(dev);
1442 int new_button = map_str_to_val(mouse_button_map, buf, count);
1444 if (new_button == AIPTEK_INVALID_VALUE)
1447 aiptek->newSetting.mouseButtonLeft = new_button;
1451 static DEVICE_ATTR(mouse_left,
1453 show_tabletMouseLeft, store_tabletMouseLeft);
1455 /***********************************************************************
1456 * support routines for the 'mouse_middle' file. Note that this file
1457 * both displays current setting and allows for setting changing.
1459 static ssize_t show_tabletMouseMiddle(struct device *dev, struct device_attribute *attr, char *buf)
1461 struct aiptek *aiptek = dev_get_drvdata(dev);
1463 return snprintf(buf, PAGE_SIZE, "%s\n",
1464 map_val_to_str(mouse_button_map,
1465 aiptek->curSetting.mouseButtonMiddle));
1469 store_tabletMouseMiddle(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1471 struct aiptek *aiptek = dev_get_drvdata(dev);
1472 int new_button = map_str_to_val(mouse_button_map, buf, count);
1474 if (new_button == AIPTEK_INVALID_VALUE)
1477 aiptek->newSetting.mouseButtonMiddle = new_button;
1481 static DEVICE_ATTR(mouse_middle,
1483 show_tabletMouseMiddle, store_tabletMouseMiddle);
1485 /***********************************************************************
1486 * support routines for the 'mouse_right' file. Note that this file
1487 * both displays current setting and allows for setting changing.
1489 static ssize_t show_tabletMouseRight(struct device *dev, struct device_attribute *attr, char *buf)
1491 struct aiptek *aiptek = dev_get_drvdata(dev);
1493 return snprintf(buf, PAGE_SIZE, "%s\n",
1494 map_val_to_str(mouse_button_map,
1495 aiptek->curSetting.mouseButtonRight));
1499 store_tabletMouseRight(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1501 struct aiptek *aiptek = dev_get_drvdata(dev);
1502 int new_button = map_str_to_val(mouse_button_map, buf, count);
1504 if (new_button == AIPTEK_INVALID_VALUE)
1507 aiptek->newSetting.mouseButtonRight = new_button;
1511 static DEVICE_ATTR(mouse_right,
1513 show_tabletMouseRight, store_tabletMouseRight);
1515 /***********************************************************************
1516 * support routines for the 'wheel' file. Note that this file
1517 * both displays current setting and allows for setting changing.
1519 static ssize_t show_tabletWheel(struct device *dev, struct device_attribute *attr, char *buf)
1521 struct aiptek *aiptek = dev_get_drvdata(dev);
1523 if (aiptek->curSetting.wheel == AIPTEK_WHEEL_DISABLE) {
1524 return snprintf(buf, PAGE_SIZE, "disable\n");
1526 return snprintf(buf, PAGE_SIZE, "%d\n",
1527 aiptek->curSetting.wheel);
1532 store_tabletWheel(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1534 struct aiptek *aiptek = dev_get_drvdata(dev);
1536 aiptek->newSetting.wheel = (int)simple_strtol(buf, NULL, 10);
1540 static DEVICE_ATTR(wheel,
1541 S_IRUGO | S_IWUGO, show_tabletWheel, store_tabletWheel);
1543 /***********************************************************************
1544 * support routines for the 'execute' file. Note that this file
1545 * both displays current setting and allows for setting changing.
1547 static ssize_t show_tabletExecute(struct device *dev, struct device_attribute *attr, char *buf)
1549 /* There is nothing useful to display, so a one-line manual
1552 return snprintf(buf, PAGE_SIZE,
1553 "Write anything to this file to program your tablet.\n");
1557 store_tabletExecute(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1559 struct aiptek *aiptek = dev_get_drvdata(dev);
1561 /* We do not care what you write to this file. Merely the action
1562 * of writing to this file triggers a tablet reprogramming.
1564 memcpy(&aiptek->curSetting, &aiptek->newSetting,
1565 sizeof(struct aiptek_settings));
1567 if (aiptek_program_tablet(aiptek) < 0)
1573 static DEVICE_ATTR(execute,
1574 S_IRUGO | S_IWUGO, show_tabletExecute, store_tabletExecute);
1576 /***********************************************************************
1577 * support routines for the 'odm_code' file. Note that this file
1578 * only displays current setting.
1580 static ssize_t show_tabletODMCode(struct device *dev, struct device_attribute *attr, char *buf)
1582 struct aiptek *aiptek = dev_get_drvdata(dev);
1584 return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->features.odmCode);
1587 static DEVICE_ATTR(odm_code, S_IRUGO, show_tabletODMCode, NULL);
1589 /***********************************************************************
1590 * support routines for the 'model_code' file. Note that this file
1591 * only displays current setting.
1593 static ssize_t show_tabletModelCode(struct device *dev, struct device_attribute *attr, char *buf)
1595 struct aiptek *aiptek = dev_get_drvdata(dev);
1597 return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->features.modelCode);
1600 static DEVICE_ATTR(model_code, S_IRUGO, show_tabletModelCode, NULL);
1602 /***********************************************************************
1603 * support routines for the 'firmware_code' file. Note that this file
1604 * only displays current setting.
1606 static ssize_t show_firmwareCode(struct device *dev, struct device_attribute *attr, char *buf)
1608 struct aiptek *aiptek = dev_get_drvdata(dev);
1610 return snprintf(buf, PAGE_SIZE, "%04x\n",
1611 aiptek->features.firmwareCode);
1614 static DEVICE_ATTR(firmware_code, S_IRUGO, show_firmwareCode, NULL);
1616 static struct attribute *aiptek_attributes[] = {
1617 &dev_attr_size.attr,
1618 &dev_attr_pointer_mode.attr,
1619 &dev_attr_coordinate_mode.attr,
1620 &dev_attr_tool_mode.attr,
1621 &dev_attr_xtilt.attr,
1622 &dev_attr_ytilt.attr,
1623 &dev_attr_jitter.attr,
1624 &dev_attr_delay.attr,
1625 &dev_attr_event_count.attr,
1626 &dev_attr_diagnostic.attr,
1627 &dev_attr_odm_code.attr,
1628 &dev_attr_model_code.attr,
1629 &dev_attr_firmware_code.attr,
1630 &dev_attr_stylus_lower.attr,
1631 &dev_attr_stylus_upper.attr,
1632 &dev_attr_mouse_left.attr,
1633 &dev_attr_mouse_middle.attr,
1634 &dev_attr_mouse_right.attr,
1635 &dev_attr_wheel.attr,
1636 &dev_attr_execute.attr,
1640 static struct attribute_group aiptek_attribute_group = {
1641 .attrs = aiptek_attributes,
1644 /***********************************************************************
1645 * This routine is called when a tablet has been identified. It basically
1646 * sets up the tablet and the driver's internal structures.
1649 aiptek_probe(struct usb_interface *intf, const struct usb_device_id *id)
1651 struct usb_device *usbdev = interface_to_usbdev(intf);
1652 struct usb_endpoint_descriptor *endpoint;
1653 struct aiptek *aiptek;
1654 struct input_dev *inputdev;
1657 AIPTEK_PROGRAMMABLE_DELAY_50,
1658 AIPTEK_PROGRAMMABLE_DELAY_400,
1659 AIPTEK_PROGRAMMABLE_DELAY_25,
1660 AIPTEK_PROGRAMMABLE_DELAY_100,
1661 AIPTEK_PROGRAMMABLE_DELAY_200,
1662 AIPTEK_PROGRAMMABLE_DELAY_300
1666 /* programmableDelay is where the command-line specified
1667 * delay is kept. We make it the first element of speeds[],
1668 * so therefore, your override speed is tried first, then the
1669 * remainder. Note that the default value of 400ms will be tried
1670 * if you do not specify any command line parameter.
1672 speeds[0] = programmableDelay;
1674 aiptek = kzalloc(sizeof(struct aiptek), GFP_KERNEL);
1675 inputdev = input_allocate_device();
1676 if (!aiptek || !inputdev) {
1677 warn("aiptek: cannot allocate memory or input device");
1681 aiptek->data = usb_buffer_alloc(usbdev, AIPTEK_PACKET_LENGTH,
1682 GFP_ATOMIC, &aiptek->data_dma);
1683 if (!aiptek->data) {
1684 warn("aiptek: cannot allocate usb buffer");
1688 aiptek->urb = usb_alloc_urb(0, GFP_KERNEL);
1690 warn("aiptek: cannot allocate urb");
1694 aiptek->inputdev = inputdev;
1695 aiptek->usbdev = usbdev;
1696 aiptek->ifnum = intf->altsetting[0].desc.bInterfaceNumber;
1697 aiptek->inDelay = 0;
1698 aiptek->endDelay = 0;
1699 aiptek->previousJitterable = 0;
1701 /* Set up the curSettings struct. Said struct contains the current
1702 * programmable parameters. The newSetting struct contains changes
1703 * the user makes to the settings via the sysfs interface. Those
1704 * changes are not "committed" to curSettings until the user
1705 * writes to the sysfs/.../execute file.
1707 aiptek->curSetting.pointerMode = AIPTEK_POINTER_EITHER_MODE;
1708 aiptek->curSetting.coordinateMode = AIPTEK_COORDINATE_ABSOLUTE_MODE;
1709 aiptek->curSetting.toolMode = AIPTEK_TOOL_BUTTON_PEN_MODE;
1710 aiptek->curSetting.xTilt = AIPTEK_TILT_DISABLE;
1711 aiptek->curSetting.yTilt = AIPTEK_TILT_DISABLE;
1712 aiptek->curSetting.mouseButtonLeft = AIPTEK_MOUSE_LEFT_BUTTON;
1713 aiptek->curSetting.mouseButtonMiddle = AIPTEK_MOUSE_MIDDLE_BUTTON;
1714 aiptek->curSetting.mouseButtonRight = AIPTEK_MOUSE_RIGHT_BUTTON;
1715 aiptek->curSetting.stylusButtonUpper = AIPTEK_STYLUS_UPPER_BUTTON;
1716 aiptek->curSetting.stylusButtonLower = AIPTEK_STYLUS_LOWER_BUTTON;
1717 aiptek->curSetting.jitterDelay = jitterDelay;
1718 aiptek->curSetting.programmableDelay = programmableDelay;
1720 /* Both structs should have equivalent settings
1722 aiptek->newSetting = aiptek->curSetting;
1724 /* Determine the usb devices' physical path.
1725 * Asketh not why we always pretend we're using "../input0",
1726 * but I suspect this will have to be refactored one
1727 * day if a single USB device can be a keyboard & a mouse
1728 * & a tablet, and the inputX number actually will tell
1731 usb_make_path(usbdev, aiptek->features.usbPath,
1732 sizeof(aiptek->features.usbPath));
1733 strlcat(aiptek->features.usbPath, "/input0",
1734 sizeof(aiptek->features.usbPath));
1736 /* Set up client data, pointers to open and close routines
1737 * for the input device.
1739 inputdev->name = "Aiptek";
1740 inputdev->phys = aiptek->features.usbPath;
1741 usb_to_input_id(usbdev, &inputdev->id);
1742 inputdev->dev.parent = &intf->dev;
1744 input_set_drvdata(inputdev, aiptek);
1746 inputdev->open = aiptek_open;
1747 inputdev->close = aiptek_close;
1749 /* Now program the capacities of the tablet, in terms of being
1752 for (i = 0; i < ARRAY_SIZE(eventTypes); ++i)
1753 __set_bit(eventTypes[i], inputdev->evbit);
1755 for (i = 0; i < ARRAY_SIZE(absEvents); ++i)
1756 __set_bit(absEvents[i], inputdev->absbit);
1758 for (i = 0; i < ARRAY_SIZE(relEvents); ++i)
1759 __set_bit(relEvents[i], inputdev->relbit);
1761 __set_bit(MSC_SERIAL, inputdev->mscbit);
1763 /* Set up key and button codes */
1764 for (i = 0; i < ARRAY_SIZE(buttonEvents); ++i)
1765 __set_bit(buttonEvents[i], inputdev->keybit);
1767 for (i = 0; i < ARRAY_SIZE(macroKeyEvents); ++i)
1768 __set_bit(macroKeyEvents[i], inputdev->keybit);
1771 * Program the input device coordinate capacities. We do not yet
1772 * know what maximum X, Y, and Z values are, so we're putting fake
1773 * values in. Later, we'll ask the tablet to put in the correct
1776 input_set_abs_params(inputdev, ABS_X, 0, 2999, 0, 0);
1777 input_set_abs_params(inputdev, ABS_Y, 0, 2249, 0, 0);
1778 input_set_abs_params(inputdev, ABS_PRESSURE, 0, 511, 0, 0);
1779 input_set_abs_params(inputdev, ABS_TILT_X, AIPTEK_TILT_MIN, AIPTEK_TILT_MAX, 0, 0);
1780 input_set_abs_params(inputdev, ABS_TILT_Y, AIPTEK_TILT_MIN, AIPTEK_TILT_MAX, 0, 0);
1781 input_set_abs_params(inputdev, ABS_WHEEL, AIPTEK_WHEEL_MIN, AIPTEK_WHEEL_MAX - 1, 0, 0);
1783 endpoint = &intf->altsetting[0].endpoint[0].desc;
1785 /* Go set up our URB, which is called when the tablet receives
1788 usb_fill_int_urb(aiptek->urb,
1790 usb_rcvintpipe(aiptek->usbdev,
1791 endpoint->bEndpointAddress),
1792 aiptek->data, 8, aiptek_irq, aiptek,
1793 endpoint->bInterval);
1795 aiptek->urb->transfer_dma = aiptek->data_dma;
1796 aiptek->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1798 /* Program the tablet. This sets the tablet up in the mode
1799 * specified in newSetting, and also queries the tablet's
1800 * physical capacities.
1802 * Sanity check: if a tablet doesn't like the slow programmatic
1803 * delay, we often get sizes of 0x0. Let's use that as an indicator
1804 * to try faster delays, up to 25 ms. If that logic fails, well, you'll
1805 * have to explain to us how your tablet thinks it's 0x0, and yet that's
1809 for (i = 0; i < ARRAY_SIZE(speeds); ++i) {
1810 aiptek->curSetting.programmableDelay = speeds[i];
1811 (void)aiptek_program_tablet(aiptek);
1812 if (aiptek->inputdev->absmax[ABS_X] > 0) {
1813 info("input: Aiptek using %d ms programming speed\n",
1814 aiptek->curSetting.programmableDelay);
1819 /* Murphy says that some day someone will have a tablet that fails the
1820 above test. That's you, Frederic Rodrigo */
1821 if (i == ARRAY_SIZE(speeds)) {
1822 info("input: Aiptek tried all speeds, no sane response");
1826 /* Associate this driver's struct with the usb interface.
1828 usb_set_intfdata(intf, aiptek);
1830 /* Set up the sysfs files
1832 err = sysfs_create_group(&intf->dev.kobj, &aiptek_attribute_group);
1834 warn("aiptek: cannot create sysfs group err: %d", err);
1838 /* Register the tablet as an Input Device
1840 err = input_register_device(aiptek->inputdev);
1842 warn("aiptek: input_register_device returned err: %d", err);
1847 fail4: sysfs_remove_group(&intf->dev.kobj, &aiptek_attribute_group);
1848 fail3: usb_free_urb(aiptek->urb);
1849 fail2: usb_buffer_free(usbdev, AIPTEK_PACKET_LENGTH, aiptek->data,
1851 fail1: usb_set_intfdata(intf, NULL);
1852 input_free_device(inputdev);
1857 /***********************************************************************
1858 * Deal with tablet disconnecting from the system.
1860 static void aiptek_disconnect(struct usb_interface *intf)
1862 struct aiptek *aiptek = usb_get_intfdata(intf);
1864 /* Disassociate driver's struct with usb interface
1866 usb_set_intfdata(intf, NULL);
1867 if (aiptek != NULL) {
1868 /* Free & unhook everything from the system.
1870 usb_kill_urb(aiptek->urb);
1871 input_unregister_device(aiptek->inputdev);
1872 sysfs_remove_group(&intf->dev.kobj, &aiptek_attribute_group);
1873 usb_free_urb(aiptek->urb);
1874 usb_buffer_free(interface_to_usbdev(intf),
1875 AIPTEK_PACKET_LENGTH,
1876 aiptek->data, aiptek->data_dma);
1881 static struct usb_driver aiptek_driver = {
1883 .probe = aiptek_probe,
1884 .disconnect = aiptek_disconnect,
1885 .id_table = aiptek_ids,
1888 static int __init aiptek_init(void)
1890 int result = usb_register(&aiptek_driver);
1892 info(DRIVER_VERSION ": " DRIVER_AUTHOR);
1898 static void __exit aiptek_exit(void)
1900 usb_deregister(&aiptek_driver);
1903 MODULE_AUTHOR(DRIVER_AUTHOR);
1904 MODULE_DESCRIPTION(DRIVER_DESC);
1905 MODULE_LICENSE("GPL");
1907 module_param(programmableDelay, int, 0);
1908 MODULE_PARM_DESC(programmableDelay, "delay used during tablet programming");
1909 module_param(jitterDelay, int, 0);
1910 MODULE_PARM_DESC(jitterDelay, "stylus/mouse settlement delay");
1912 module_init(aiptek_init);
1913 module_exit(aiptek_exit);