[XFRM]: skb_cow_data() does not set proper owner for new skbs.
[linux-2.6/verdex.git] / drivers / usb / input / aiptek.c
blob94ce2a9ad50f5e9b71b5abdf49f862b3745a0a24
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>
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>
16 * Many thanks to Oliver Kuechemann for his support.
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.
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.
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/input.h>
77 #include <linux/module.h>
78 #include <linux/init.h>
79 #include <linux/usb.h>
80 #include <linux/sched.h>
81 #include <asm/uaccess.h>
82 #include <asm/unaligned.h>
85 * Version Information
87 #define DRIVER_VERSION "v1.5 (May-15-2004)"
88 #define DRIVER_AUTHOR "Bryan W. Headley/Chris Atenasio"
89 #define DRIVER_DESC "Aiptek HyperPen USB Tablet Driver (Linux 2.6.x)"
92 * Aiptek status packet:
94 * (returned as Report 1 - relative coordinates from mouse and stylus)
96 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
97 * byte0 0 0 0 0 0 0 0 1
98 * byte1 0 0 0 0 0 BS2 BS Tip
99 * byte2 X7 X6 X5 X4 X3 X2 X1 X0
100 * byte3 Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
102 * (returned as Report 2 - absolute coordinates from the stylus)
104 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
105 * byte0 0 0 0 0 0 0 1 0
106 * byte1 X7 X6 X5 X4 X3 X2 X1 X0
107 * byte2 X15 X14 X13 X12 X11 X10 X9 X8
108 * byte3 Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
109 * byte4 Y15 Y14 Y13 Y12 Y11 Y10 Y9 Y8
110 * byte5 * * * BS2 BS1 Tip IR DV
111 * byte6 P7 P6 P5 P4 P3 P2 P1 P0
112 * byte7 P15 P14 P13 P12 P11 P10 P9 P8
114 * (returned as Report 3 - absolute coordinates from the mouse)
116 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
117 * byte0 0 0 0 0 0 0 1 0
118 * byte1 X7 X6 X5 X4 X3 X2 X1 X0
119 * byte2 X15 X14 X13 X12 X11 X10 X9 X8
120 * byte3 Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
121 * byte4 Y15 Y14 Y13 Y12 Y11 Y10 Y9 Y8
122 * byte5 * * * BS2 BS1 Tip IR DV
123 * byte6 P7 P6 P5 P4 P3 P2 P1 P0
124 * byte7 P15 P14 P13 P12 P11 P10 P9 P8
126 * (returned as Report 4 - macrokeys from the stylus)
128 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
129 * byte0 0 0 0 0 0 1 0 0
130 * byte1 0 0 0 BS2 BS Tip IR DV
131 * byte2 0 0 0 0 0 0 1 0
132 * byte3 0 0 0 K4 K3 K2 K1 K0
133 * byte4 P7 P6 P5 P4 P3 P2 P1 P0
134 * byte5 P15 P14 P13 P12 P11 P10 P9 P8
136 * (returned as Report 5 - macrokeys from the mouse)
138 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
139 * byte0 0 0 0 0 0 1 0 0
140 * byte1 0 0 0 BS2 BS Tip IR DV
141 * byte2 0 0 0 0 0 0 1 0
142 * byte3 0 0 0 K4 K3 K2 K1 K0
143 * byte4 P7 P6 P5 P4 P3 P2 P1 P0
144 * byte5 P15 P14 P13 P12 P11 P10 P9 P8
146 * IR: In Range = Proximity on
147 * DV = Data Valid
148 * BS = Barrel Switch (as in, macro keys)
149 * BS2 also referred to as Tablet Pick
151 * Command Summary:
153 * Use report_type CONTROL (3)
154 * Use report_id 2
156 * Command/Data Description Return Bytes Return Value
157 * 0x10/0x00 SwitchToMouse 0
158 * 0x10/0x01 SwitchToTablet 0
159 * 0x18/0x04 SetResolution 0
160 * 0x12/0xFF AutoGainOn 0
161 * 0x17/0x00 FilterOn 0
162 * 0x01/0x00 GetXExtension 2 MaxX
163 * 0x01/0x01 GetYExtension 2 MaxY
164 * 0x02/0x00 GetModelCode 2 ModelCode = LOBYTE
165 * 0x03/0x00 GetODMCode 2 ODMCode
166 * 0x08/0x00 GetPressureLevels 2 =512
167 * 0x04/0x00 GetFirmwareVersion 2 Firmware Version
168 * 0x11/0x02 EnableMacroKeys 0
170 * To initialize the tablet:
172 * (1) Send Resolution500LPI (Command)
173 * (2) Query for Model code (Option Report)
174 * (3) Query for ODM code (Option Report)
175 * (4) Query for firmware (Option Report)
176 * (5) Query for GetXExtension (Option Report)
177 * (6) Query for GetYExtension (Option Report)
178 * (7) Query for GetPressureLevels (Option Report)
179 * (8) SwitchToTablet for Absolute coordinates, or
180 * SwitchToMouse for Relative coordinates (Command)
181 * (9) EnableMacroKeys (Command)
182 * (10) FilterOn (Command)
183 * (11) AutoGainOn (Command)
185 * (Step 9 can be omitted, but you'll then have no function keys.)
188 #define USB_VENDOR_ID_AIPTEK 0x08ca
189 #define USB_REQ_GET_REPORT 0x01
190 #define USB_REQ_SET_REPORT 0x09
192 /* PointerMode codes
194 #define AIPTEK_POINTER_ONLY_MOUSE_MODE 0
195 #define AIPTEK_POINTER_ONLY_STYLUS_MODE 1
196 #define AIPTEK_POINTER_EITHER_MODE 2
198 #define AIPTEK_POINTER_ALLOW_MOUSE_MODE(a) \
199 (a == AIPTEK_POINTER_ONLY_MOUSE_MODE || \
200 a == AIPTEK_POINTER_EITHER_MODE)
201 #define AIPTEK_POINTER_ALLOW_STYLUS_MODE(a) \
202 (a == AIPTEK_POINTER_ONLY_STYLUS_MODE || \
203 a == AIPTEK_POINTER_EITHER_MODE)
205 /* CoordinateMode code
207 #define AIPTEK_COORDINATE_RELATIVE_MODE 0
208 #define AIPTEK_COORDINATE_ABSOLUTE_MODE 1
210 /* XTilt and YTilt values
212 #define AIPTEK_TILT_MIN (-128)
213 #define AIPTEK_TILT_MAX 127
214 #define AIPTEK_TILT_DISABLE (-10101)
216 /* Wheel values
218 #define AIPTEK_WHEEL_MIN 0
219 #define AIPTEK_WHEEL_MAX 1024
220 #define AIPTEK_WHEEL_DISABLE (-10101)
222 /* ToolCode values, which BTW are 0x140 .. 0x14f
223 * We have things set up such that if TOOL_BUTTON_FIRED_BIT is
224 * not set, we'll send one instance of AIPTEK_TOOL_BUTTON_xxx.
226 * Whenever the user resets the value, TOOL_BUTTON_FIRED_BIT will
227 * get reset.
229 #define TOOL_BUTTON(x) ((x) & 0x14f)
230 #define TOOL_BUTTON_FIRED(x) ((x) & 0x200)
231 #define TOOL_BUTTON_FIRED_BIT 0x200
232 /* toolMode codes
234 #define AIPTEK_TOOL_BUTTON_PEN_MODE BTN_TOOL_PEN
235 #define AIPTEK_TOOL_BUTTON_PEN_MODE BTN_TOOL_PEN
236 #define AIPTEK_TOOL_BUTTON_PENCIL_MODE BTN_TOOL_PENCIL
237 #define AIPTEK_TOOL_BUTTON_BRUSH_MODE BTN_TOOL_BRUSH
238 #define AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE BTN_TOOL_AIRBRUSH
239 #define AIPTEK_TOOL_BUTTON_ERASER_MODE BTN_TOOL_RUBBER
240 #define AIPTEK_TOOL_BUTTON_MOUSE_MODE BTN_TOOL_MOUSE
241 #define AIPTEK_TOOL_BUTTON_LENS_MODE BTN_TOOL_LENS
243 /* Diagnostic message codes
245 #define AIPTEK_DIAGNOSTIC_NA 0
246 #define AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE 1
247 #define AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE 2
248 #define AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED 3
250 /* Time to wait (in ms) to help mask hand jittering
251 * when pressing the stylus buttons.
253 #define AIPTEK_JITTER_DELAY_DEFAULT 50
255 /* Time to wait (in ms) in-between sending the tablet
256 * a command and beginning the process of reading the return
257 * sequence from the tablet.
259 #define AIPTEK_PROGRAMMABLE_DELAY_25 25
260 #define AIPTEK_PROGRAMMABLE_DELAY_50 50
261 #define AIPTEK_PROGRAMMABLE_DELAY_100 100
262 #define AIPTEK_PROGRAMMABLE_DELAY_200 200
263 #define AIPTEK_PROGRAMMABLE_DELAY_300 300
264 #define AIPTEK_PROGRAMMABLE_DELAY_400 400
265 #define AIPTEK_PROGRAMMABLE_DELAY_DEFAULT AIPTEK_PROGRAMMABLE_DELAY_400
267 /* Mouse button programming
269 #define AIPTEK_MOUSE_LEFT_BUTTON 0x01
270 #define AIPTEK_MOUSE_RIGHT_BUTTON 0x02
271 #define AIPTEK_MOUSE_MIDDLE_BUTTON 0x04
273 /* Stylus button programming
275 #define AIPTEK_STYLUS_LOWER_BUTTON 0x08
276 #define AIPTEK_STYLUS_UPPER_BUTTON 0x10
278 /* Length of incoming packet from the tablet
280 #define AIPTEK_PACKET_LENGTH 8
282 /* We report in EV_MISC both the proximity and
283 * whether the report came from the stylus, tablet mouse
284 * or "unknown" -- Unknown when the tablet is in relative
285 * mode, because we only get report 1's.
287 #define AIPTEK_REPORT_TOOL_UNKNOWN 0x10
288 #define AIPTEK_REPORT_TOOL_STYLUS 0x20
289 #define AIPTEK_REPORT_TOOL_MOUSE 0x40
291 static int programmableDelay = AIPTEK_PROGRAMMABLE_DELAY_DEFAULT;
292 static int jitterDelay = AIPTEK_JITTER_DELAY_DEFAULT;
294 struct aiptek_features {
295 int odmCode; /* Tablet manufacturer code */
296 int modelCode; /* Tablet model code (not unique) */
297 int firmwareCode; /* prom/eeprom version */
298 char usbPath[64 + 1]; /* device's physical usb path */
299 char inputPath[64 + 1]; /* input device path */
302 struct aiptek_settings {
303 int pointerMode; /* stylus-, mouse-only or either */
304 int coordinateMode; /* absolute/relative coords */
305 int toolMode; /* pen, pencil, brush, etc. tool */
306 int xTilt; /* synthetic xTilt amount */
307 int yTilt; /* synthetic yTilt amount */
308 int wheel; /* synthetic wheel amount */
309 int stylusButtonUpper; /* stylus upper btn delivers... */
310 int stylusButtonLower; /* stylus lower btn delivers... */
311 int mouseButtonLeft; /* mouse left btn delivers... */
312 int mouseButtonMiddle; /* mouse middle btn delivers... */
313 int mouseButtonRight; /* mouse right btn delivers... */
314 int programmableDelay; /* delay for tablet programming */
315 int jitterDelay; /* delay for hand jittering */
318 struct aiptek {
319 struct input_dev inputdev; /* input device struct */
320 struct usb_device *usbdev; /* usb device struct */
321 struct urb *urb; /* urb for incoming reports */
322 dma_addr_t data_dma; /* our dma stuffage */
323 struct aiptek_features features; /* tablet's array of features */
324 struct aiptek_settings curSetting; /* tablet's current programmable */
325 struct aiptek_settings newSetting; /* ... and new param settings */
326 unsigned int ifnum; /* interface number for IO */
327 int openCount; /* module use counter */
328 int diagnostic; /* tablet diagnostic codes */
329 unsigned long eventCount; /* event count */
330 int inDelay; /* jitter: in jitter delay? */
331 unsigned long endDelay; /* jitter: time when delay ends */
332 int previousJitterable; /* jitterable prev value */
333 unsigned char *data; /* incoming packet data */
337 * Permit easy lookup of keyboard events to send, versus
338 * the bitmap which comes from the tablet. This hides the
339 * issue that the F_keys are not sequentially numbered.
341 static int macroKeyEvents[] = {
342 KEY_ESC, KEY_F1, KEY_F2, KEY_F3, KEY_F4, KEY_F5,
343 KEY_F6, KEY_F7, KEY_F8, KEY_F9, KEY_F10, KEY_F11,
344 KEY_F12, KEY_F13, KEY_F14, KEY_F15, KEY_F16, KEY_F17,
345 KEY_F18, KEY_F19, KEY_F20, KEY_F21, KEY_F22, KEY_F23,
346 KEY_F24, KEY_STOP, KEY_AGAIN, KEY_PROPS, KEY_UNDO,
347 KEY_FRONT, KEY_COPY, KEY_OPEN, KEY_PASTE, 0
350 /***********************************************************************
351 * Relative reports deliver values in 2's complement format to
352 * deal with negative offsets.
354 static int aiptek_convert_from_2s_complement(unsigned char c)
356 int ret;
357 unsigned char b = c;
358 int negate = 0;
360 if ((b & 0x80) != 0) {
361 b = ~b;
362 b--;
363 negate = 1;
365 ret = b;
366 ret = (negate == 1) ? -ret : ret;
367 return ret;
370 /***********************************************************************
371 * aiptek_irq can receive one of six potential reports.
372 * The documentation for each is in the body of the function.
374 * The tablet reports on several attributes per invocation of
375 * aiptek_irq. Because the Linux Input Event system allows the
376 * transmission of ONE attribute per input_report_xxx() call,
377 * collation has to be done on the other end to reconstitute
378 * a complete tablet report. Further, the number of Input Event reports
379 * submitted varies, depending on what USB report type, and circumstance.
380 * To deal with this, EV_MSC is used to indicate an 'end-of-report'
381 * message. This has been an undocumented convention understood by the kernel
382 * tablet driver and clients such as gpm and XFree86's tablet drivers.
384 * Of the information received from the tablet, the one piece I
385 * cannot transmit is the proximity bit (without resorting to an EV_MSC
386 * convention above.) I therefore have taken over REL_MISC and ABS_MISC
387 * (for relative and absolute reports, respectively) for communicating
388 * Proximity. Why two events? I thought it interesting to know if the
389 * Proximity event occurred while the tablet was in absolute or relative
390 * mode.
392 * Other tablets use the notion of a certain minimum stylus pressure
393 * to infer proximity. While that could have been done, that is yet
394 * another 'by convention' behavior, the documentation for which
395 * would be spread between two (or more) pieces of software.
397 * EV_MSC usage was terminated for this purpose in Linux 2.5.x, and
398 * replaced with the input_sync() method (which emits EV_SYN.)
401 static void aiptek_irq(struct urb *urb, struct pt_regs *regs)
403 struct aiptek *aiptek = urb->context;
404 unsigned char *data = aiptek->data;
405 struct input_dev *inputdev = &aiptek->inputdev;
406 int jitterable = 0;
407 int retval, macro, x, y, z, left, right, middle, p, dv, tip, bs, pck;
409 switch (urb->status) {
410 case 0:
411 /* Success */
412 break;
414 case -ECONNRESET:
415 case -ENOENT:
416 case -ESHUTDOWN:
417 /* This urb is terminated, clean up */
418 dbg("%s - urb shutting down with status: %d",
419 __FUNCTION__, urb->status);
420 return;
422 default:
423 dbg("%s - nonzero urb status received: %d",
424 __FUNCTION__, urb->status);
425 goto exit;
428 /* See if we are in a delay loop -- throw out report if true.
430 if (aiptek->inDelay == 1 && time_after(aiptek->endDelay, jiffies)) {
431 goto exit;
434 aiptek->inDelay = 0;
435 aiptek->eventCount++;
437 /* Report 1 delivers relative coordinates with either a stylus
438 * or the mouse. You do not know, however, which input
439 * tool generated the event.
441 if (data[0] == 1) {
442 if (aiptek->curSetting.coordinateMode ==
443 AIPTEK_COORDINATE_ABSOLUTE_MODE) {
444 aiptek->diagnostic =
445 AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE;
446 } else {
447 input_regs(inputdev, regs);
449 x = aiptek_convert_from_2s_complement(data[2]);
450 y = aiptek_convert_from_2s_complement(data[3]);
452 /* jitterable keeps track of whether any button has been pressed.
453 * We're also using it to remap the physical mouse button mask
454 * to pseudo-settings. (We don't specifically care about it's
455 * value after moving/transposing mouse button bitmasks, except
456 * that a non-zero value indicates that one or more
457 * mouse button was pressed.)
459 jitterable = data[5] & 0x07;
461 left = (data[5] & aiptek->curSetting.mouseButtonLeft) != 0 ? 1 : 0;
462 right = (data[5] & aiptek->curSetting.mouseButtonRight) != 0 ? 1 : 0;
463 middle = (data[5] & aiptek->curSetting.mouseButtonMiddle) != 0 ? 1 : 0;
465 input_report_key(inputdev, BTN_LEFT, left);
466 input_report_key(inputdev, BTN_MIDDLE, middle);
467 input_report_key(inputdev, BTN_RIGHT, right);
468 input_report_rel(inputdev, REL_X, x);
469 input_report_rel(inputdev, REL_Y, y);
470 input_report_rel(inputdev, REL_MISC, 1 | AIPTEK_REPORT_TOOL_UNKNOWN);
472 /* Wheel support is in the form of a single-event
473 * firing.
475 if (aiptek->curSetting.wheel != AIPTEK_WHEEL_DISABLE) {
476 input_report_rel(inputdev, REL_WHEEL,
477 aiptek->curSetting.wheel);
478 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
480 input_sync(inputdev);
483 /* Report 2 is delivered only by the stylus, and delivers
484 * absolute coordinates.
486 else if (data[0] == 2) {
487 if (aiptek->curSetting.coordinateMode == AIPTEK_COORDINATE_RELATIVE_MODE) {
488 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE;
489 } else if (!AIPTEK_POINTER_ALLOW_STYLUS_MODE
490 (aiptek->curSetting.pointerMode)) {
491 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED;
492 } else {
493 input_regs(inputdev, regs);
495 x = le16_to_cpu(get_unaligned((__le16 *) (data + 1)));
496 y = le16_to_cpu(get_unaligned((__le16 *) (data + 3)));
497 z = le16_to_cpu(get_unaligned((__le16 *) (data + 6)));
499 p = (data[5] & 0x01) != 0 ? 1 : 0;
500 dv = (data[5] & 0x02) != 0 ? 1 : 0;
501 tip = (data[5] & 0x04) != 0 ? 1 : 0;
503 /* Use jitterable to re-arrange button masks
505 jitterable = data[5] & 0x18;
507 bs = (data[5] & aiptek->curSetting.stylusButtonLower) != 0 ? 1 : 0;
508 pck = (data[5] & aiptek->curSetting.stylusButtonUpper) != 0 ? 1 : 0;
510 /* dv indicates 'data valid' (e.g., the tablet is in sync
511 * and has delivered a "correct" report) We will ignore
512 * all 'bad' reports...
514 if (dv != 0) {
515 /* If we've not already sent a tool_button_?? code, do
516 * so now. Then set FIRED_BIT so it won't be resent unless
517 * the user forces FIRED_BIT off.
519 if (TOOL_BUTTON_FIRED
520 (aiptek->curSetting.toolMode) == 0) {
521 input_report_key(inputdev,
522 TOOL_BUTTON(aiptek->curSetting.toolMode),
524 aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
527 if (p != 0) {
528 input_report_abs(inputdev, ABS_X, x);
529 input_report_abs(inputdev, ABS_Y, y);
530 input_report_abs(inputdev, ABS_PRESSURE, z);
532 input_report_key(inputdev, BTN_TOUCH, tip);
533 input_report_key(inputdev, BTN_STYLUS, bs);
534 input_report_key(inputdev, BTN_STYLUS2, pck);
536 if (aiptek->curSetting.xTilt !=
537 AIPTEK_TILT_DISABLE) {
538 input_report_abs(inputdev,
539 ABS_TILT_X,
540 aiptek->curSetting.xTilt);
542 if (aiptek->curSetting.yTilt != AIPTEK_TILT_DISABLE) {
543 input_report_abs(inputdev,
544 ABS_TILT_Y,
545 aiptek->curSetting.yTilt);
548 /* Wheel support is in the form of a single-event
549 * firing.
551 if (aiptek->curSetting.wheel !=
552 AIPTEK_WHEEL_DISABLE) {
553 input_report_abs(inputdev,
554 ABS_WHEEL,
555 aiptek->curSetting.wheel);
556 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
559 input_report_abs(inputdev, ABS_MISC, p | AIPTEK_REPORT_TOOL_STYLUS);
560 input_sync(inputdev);
564 /* Report 3's come from the mouse in absolute mode.
566 else if (data[0] == 3) {
567 if (aiptek->curSetting.coordinateMode == AIPTEK_COORDINATE_RELATIVE_MODE) {
568 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE;
569 } else if (!AIPTEK_POINTER_ALLOW_MOUSE_MODE
570 (aiptek->curSetting.pointerMode)) {
571 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED;
572 } else {
573 input_regs(inputdev, regs);
574 x = le16_to_cpu(get_unaligned((__le16 *) (data + 1)));
575 y = le16_to_cpu(get_unaligned((__le16 *) (data + 3)));
577 jitterable = data[5] & 0x1c;
579 p = (data[5] & 0x01) != 0 ? 1 : 0;
580 dv = (data[5] & 0x02) != 0 ? 1 : 0;
581 left = (data[5] & aiptek->curSetting.mouseButtonLeft) != 0 ? 1 : 0;
582 right = (data[5] & aiptek->curSetting.mouseButtonRight) != 0 ? 1 : 0;
583 middle = (data[5] & aiptek->curSetting.mouseButtonMiddle) != 0 ? 1 : 0;
585 if (dv != 0) {
586 /* If we've not already sent a tool_button_?? code, do
587 * so now. Then set FIRED_BIT so it won't be resent unless
588 * the user forces FIRED_BIT off.
590 if (TOOL_BUTTON_FIRED
591 (aiptek->curSetting.toolMode) == 0) {
592 input_report_key(inputdev,
593 TOOL_BUTTON(aiptek->curSetting.toolMode),
595 aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
598 if (p != 0) {
599 input_report_abs(inputdev, ABS_X, x);
600 input_report_abs(inputdev, ABS_Y, y);
602 input_report_key(inputdev, BTN_LEFT, left);
603 input_report_key(inputdev, BTN_MIDDLE, middle);
604 input_report_key(inputdev, BTN_RIGHT, right);
606 /* Wheel support is in the form of a single-event
607 * firing.
609 if (aiptek->curSetting.wheel != AIPTEK_WHEEL_DISABLE) {
610 input_report_abs(inputdev,
611 ABS_WHEEL,
612 aiptek->curSetting.wheel);
613 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
616 input_report_rel(inputdev, REL_MISC, p | AIPTEK_REPORT_TOOL_MOUSE);
617 input_sync(inputdev);
621 /* Report 4s come from the macro keys when pressed by stylus
623 else if (data[0] == 4) {
624 jitterable = data[1] & 0x18;
626 p = (data[1] & 0x01) != 0 ? 1 : 0;
627 dv = (data[1] & 0x02) != 0 ? 1 : 0;
628 tip = (data[1] & 0x04) != 0 ? 1 : 0;
629 bs = (data[1] & aiptek->curSetting.stylusButtonLower) != 0 ? 1 : 0;
630 pck = (data[1] & aiptek->curSetting.stylusButtonUpper) != 0 ? 1 : 0;
632 macro = data[3];
633 z = le16_to_cpu(get_unaligned((__le16 *) (data + 4)));
635 if (dv != 0) {
636 input_regs(inputdev, regs);
638 /* If we've not already sent a tool_button_?? code, do
639 * so now. Then set FIRED_BIT so it won't be resent unless
640 * the user forces FIRED_BIT off.
642 if (TOOL_BUTTON_FIRED(aiptek->curSetting.toolMode) == 0) {
643 input_report_key(inputdev,
644 TOOL_BUTTON(aiptek->curSetting.toolMode),
646 aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
649 if (p != 0) {
650 input_report_key(inputdev, BTN_TOUCH, tip);
651 input_report_key(inputdev, BTN_STYLUS, bs);
652 input_report_key(inputdev, BTN_STYLUS2, pck);
653 input_report_abs(inputdev, ABS_PRESSURE, z);
656 /* For safety, we're sending key 'break' codes for the
657 * neighboring macro keys.
659 if (macro > 0) {
660 input_report_key(inputdev,
661 macroKeyEvents[macro - 1], 0);
663 if (macro < 25) {
664 input_report_key(inputdev,
665 macroKeyEvents[macro + 1], 0);
667 input_report_key(inputdev, macroKeyEvents[macro], p);
668 input_report_abs(inputdev, ABS_MISC,
669 p | AIPTEK_REPORT_TOOL_STYLUS);
670 input_sync(inputdev);
673 /* Report 5s come from the macro keys when pressed by mouse
675 else if (data[0] == 5) {
676 jitterable = data[1] & 0x1c;
678 p = (data[1] & 0x01) != 0 ? 1 : 0;
679 dv = (data[1] & 0x02) != 0 ? 1 : 0;
680 left = (data[1]& aiptek->curSetting.mouseButtonLeft) != 0 ? 1 : 0;
681 right = (data[1] & aiptek->curSetting.mouseButtonRight) != 0 ? 1 : 0;
682 middle = (data[1] & aiptek->curSetting.mouseButtonMiddle) != 0 ? 1 : 0;
683 macro = data[3];
685 if (dv != 0) {
686 input_regs(inputdev, regs);
688 /* If we've not already sent a tool_button_?? code, do
689 * so now. Then set FIRED_BIT so it won't be resent unless
690 * the user forces FIRED_BIT off.
692 if (TOOL_BUTTON_FIRED(aiptek->curSetting.toolMode) == 0) {
693 input_report_key(inputdev,
694 TOOL_BUTTON(aiptek->curSetting.toolMode),
696 aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
699 if (p != 0) {
700 input_report_key(inputdev, BTN_LEFT, left);
701 input_report_key(inputdev, BTN_MIDDLE, middle);
702 input_report_key(inputdev, BTN_RIGHT, right);
705 /* For safety, we're sending key 'break' codes for the
706 * neighboring macro keys.
708 if (macro > 0) {
709 input_report_key(inputdev,
710 macroKeyEvents[macro - 1], 0);
712 if (macro < 25) {
713 input_report_key(inputdev,
714 macroKeyEvents[macro + 1], 0);
717 input_report_key(inputdev, macroKeyEvents[macro], 1);
718 input_report_rel(inputdev, ABS_MISC,
719 p | AIPTEK_REPORT_TOOL_MOUSE);
720 input_sync(inputdev);
723 /* We have no idea which tool can generate a report 6. Theoretically,
724 * neither need to, having been given reports 4 & 5 for such use.
725 * However, report 6 is the 'official-looking' report for macroKeys;
726 * reports 4 & 5 supposively are used to support unnamed, unknown
727 * hat switches (which just so happen to be the macroKeys.)
729 else if (data[0] == 6) {
730 macro = le16_to_cpu(get_unaligned((__le16 *) (data + 1)));
731 input_regs(inputdev, regs);
733 if (macro > 0) {
734 input_report_key(inputdev, macroKeyEvents[macro - 1],
737 if (macro < 25) {
738 input_report_key(inputdev, macroKeyEvents[macro + 1],
742 /* If we've not already sent a tool_button_?? code, do
743 * so now. Then set FIRED_BIT so it won't be resent unless
744 * the user forces FIRED_BIT off.
746 if (TOOL_BUTTON_FIRED(aiptek->curSetting.toolMode) == 0) {
747 input_report_key(inputdev,
748 TOOL_BUTTON(aiptek->curSetting.
749 toolMode), 1);
750 aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
753 input_report_key(inputdev, macroKeyEvents[macro], 1);
754 input_report_abs(inputdev, ABS_MISC,
755 1 | AIPTEK_REPORT_TOOL_UNKNOWN);
756 input_sync(inputdev);
757 } else {
758 dbg("Unknown report %d", data[0]);
761 /* Jitter may occur when the user presses a button on the stlyus
762 * or the mouse. What we do to prevent that is wait 'x' milliseconds
763 * following a 'jitterable' event, which should give the hand some time
764 * stabilize itself.
766 * We just introduced aiptek->previousJitterable to carry forth the
767 * notion that jitter occurs when the button state changes from on to off:
768 * a person drawing, holding a button down is not subject to jittering.
769 * With that in mind, changing from upper button depressed to lower button
770 * WILL transition through a jitter delay.
773 if (aiptek->previousJitterable != jitterable &&
774 aiptek->curSetting.jitterDelay != 0 && aiptek->inDelay != 1) {
775 aiptek->endDelay = jiffies +
776 ((aiptek->curSetting.jitterDelay * HZ) / 1000);
777 aiptek->inDelay = 1;
779 aiptek->previousJitterable = jitterable;
781 exit:
782 retval = usb_submit_urb(urb, GFP_ATOMIC);
783 if (retval != 0) {
784 err("%s - usb_submit_urb failed with result %d",
785 __FUNCTION__, retval);
789 /***********************************************************************
790 * These are the USB id's known so far. We do not identify them to
791 * specific Aiptek model numbers, because there has been overlaps,
792 * use, and reuse of id's in existing models. Certain models have
793 * been known to use more than one ID, indicative perhaps of
794 * manufacturing revisions. In any event, we consider these
795 * IDs to not be model-specific nor unique.
797 static const struct usb_device_id aiptek_ids[] = {
798 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x01)},
799 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x10)},
800 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x20)},
801 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x21)},
802 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x22)},
803 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x23)},
804 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x24)},
808 MODULE_DEVICE_TABLE(usb, aiptek_ids);
810 /***********************************************************************
811 * Open an instance of the tablet driver.
813 static int aiptek_open(struct input_dev *inputdev)
815 struct aiptek *aiptek = inputdev->private;
817 if (aiptek->openCount++ > 0) {
818 return 0;
821 aiptek->urb->dev = aiptek->usbdev;
822 if (usb_submit_urb(aiptek->urb, GFP_KERNEL) != 0) {
823 aiptek->openCount--;
824 return -EIO;
827 return 0;
830 /***********************************************************************
831 * Close an instance of the tablet driver.
833 static void aiptek_close(struct input_dev *inputdev)
835 struct aiptek *aiptek = inputdev->private;
837 if (--aiptek->openCount == 0) {
838 usb_kill_urb(aiptek->urb);
842 /***********************************************************************
843 * aiptek_set_report and aiptek_get_report() are borrowed from Linux 2.4.x,
844 * where they were known as usb_set_report and usb_get_report.
846 static int
847 aiptek_set_report(struct aiptek *aiptek,
848 unsigned char report_type,
849 unsigned char report_id, void *buffer, int size)
851 return usb_control_msg(aiptek->usbdev,
852 usb_sndctrlpipe(aiptek->usbdev, 0),
853 USB_REQ_SET_REPORT,
854 USB_TYPE_CLASS | USB_RECIP_INTERFACE |
855 USB_DIR_OUT, (report_type << 8) + report_id,
856 aiptek->ifnum, buffer, size, 5000);
859 static int
860 aiptek_get_report(struct aiptek *aiptek,
861 unsigned char report_type,
862 unsigned char report_id, void *buffer, int size)
864 return usb_control_msg(aiptek->usbdev,
865 usb_rcvctrlpipe(aiptek->usbdev, 0),
866 USB_REQ_GET_REPORT,
867 USB_TYPE_CLASS | USB_RECIP_INTERFACE |
868 USB_DIR_IN, (report_type << 8) + report_id,
869 aiptek->ifnum, buffer, size, 5000);
872 /***********************************************************************
873 * Send a command to the tablet.
875 static int
876 aiptek_command(struct aiptek *aiptek, unsigned char command, unsigned char data)
878 const int sizeof_buf = 3 * sizeof(u8);
879 int ret;
880 u8 *buf;
882 buf = kmalloc(sizeof_buf, GFP_KERNEL);
883 if (!buf)
884 return -ENOMEM;
886 buf[0] = 2;
887 buf[1] = command;
888 buf[2] = data;
890 if ((ret =
891 aiptek_set_report(aiptek, 3, 2, buf, sizeof_buf)) != sizeof_buf) {
892 dbg("aiptek_program: failed, tried to send: 0x%02x 0x%02x",
893 command, data);
895 kfree(buf);
896 return ret < 0 ? ret : 0;
899 /***********************************************************************
900 * Retrieve information from the tablet. Querying info is defined as first
901 * sending the {command,data} sequence as a command, followed by a wait
902 * (aka, "programmaticDelay") and then a "read" request.
904 static int
905 aiptek_query(struct aiptek *aiptek, unsigned char command, unsigned char data)
907 const int sizeof_buf = 3 * sizeof(u8);
908 int ret;
909 u8 *buf;
911 buf = kmalloc(sizeof_buf, GFP_KERNEL);
912 if (!buf)
913 return -ENOMEM;
915 buf[0] = 2;
916 buf[1] = command;
917 buf[2] = data;
919 if (aiptek_command(aiptek, command, data) != 0) {
920 kfree(buf);
921 return -EIO;
923 msleep(aiptek->curSetting.programmableDelay);
925 if ((ret =
926 aiptek_get_report(aiptek, 3, 2, buf, sizeof_buf)) != sizeof_buf) {
927 dbg("aiptek_query failed: returned 0x%02x 0x%02x 0x%02x",
928 buf[0], buf[1], buf[2]);
929 ret = -EIO;
930 } else {
931 ret = le16_to_cpu(get_unaligned((__le16 *) (buf + 1)));
933 kfree(buf);
934 return ret;
937 /***********************************************************************
938 * Program the tablet into either absolute or relative mode.
939 * We also get information about the tablet's size.
941 static int aiptek_program_tablet(struct aiptek *aiptek)
943 int ret;
944 /* Execute Resolution500LPI */
945 if ((ret = aiptek_command(aiptek, 0x18, 0x04)) < 0)
946 return ret;
948 /* Query getModelCode */
949 if ((ret = aiptek_query(aiptek, 0x02, 0x00)) < 0)
950 return ret;
951 aiptek->features.modelCode = ret & 0xff;
953 /* Query getODMCode */
954 if ((ret = aiptek_query(aiptek, 0x03, 0x00)) < 0)
955 return ret;
956 aiptek->features.odmCode = ret;
958 /* Query getFirmwareCode */
959 if ((ret = aiptek_query(aiptek, 0x04, 0x00)) < 0)
960 return ret;
961 aiptek->features.firmwareCode = ret;
963 /* Query getXextension */
964 if ((ret = aiptek_query(aiptek, 0x01, 0x00)) < 0)
965 return ret;
966 aiptek->inputdev.absmin[ABS_X] = 0;
967 aiptek->inputdev.absmax[ABS_X] = ret - 1;
969 /* Query getYextension */
970 if ((ret = aiptek_query(aiptek, 0x01, 0x01)) < 0)
971 return ret;
972 aiptek->inputdev.absmin[ABS_Y] = 0;
973 aiptek->inputdev.absmax[ABS_Y] = ret - 1;
975 /* Query getPressureLevels */
976 if ((ret = aiptek_query(aiptek, 0x08, 0x00)) < 0)
977 return ret;
978 aiptek->inputdev.absmin[ABS_PRESSURE] = 0;
979 aiptek->inputdev.absmax[ABS_PRESSURE] = ret - 1;
981 /* Depending on whether we are in absolute or relative mode, we will
982 * do a switchToTablet(absolute) or switchToMouse(relative) command.
984 if (aiptek->curSetting.coordinateMode ==
985 AIPTEK_COORDINATE_ABSOLUTE_MODE) {
986 /* Execute switchToTablet */
987 if ((ret = aiptek_command(aiptek, 0x10, 0x01)) < 0) {
988 return ret;
990 } else {
991 /* Execute switchToMouse */
992 if ((ret = aiptek_command(aiptek, 0x10, 0x00)) < 0) {
993 return ret;
997 /* Enable the macro keys */
998 if ((ret = aiptek_command(aiptek, 0x11, 0x02)) < 0)
999 return ret;
1000 #if 0
1001 /* Execute FilterOn */
1002 if ((ret = aiptek_command(aiptek, 0x17, 0x00)) < 0)
1003 return ret;
1004 #endif
1006 /* Execute AutoGainOn */
1007 if ((ret = aiptek_command(aiptek, 0x12, 0xff)) < 0)
1008 return ret;
1010 /* Reset the eventCount, so we track events from last (re)programming
1012 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_NA;
1013 aiptek->eventCount = 0;
1015 return 0;
1018 /***********************************************************************
1019 * Sysfs functions. Sysfs prefers that individually-tunable parameters
1020 * exist in their separate pseudo-files. Summary data that is immutable
1021 * may exist in a singular file so long as you don't define a writeable
1022 * interface.
1025 /***********************************************************************
1026 * support the 'size' file -- display support
1028 static ssize_t show_tabletSize(struct device *dev, char *buf)
1030 struct aiptek *aiptek = dev_get_drvdata(dev);
1032 if (aiptek == NULL)
1033 return 0;
1035 return snprintf(buf, PAGE_SIZE, "%dx%d\n",
1036 aiptek->inputdev.absmax[ABS_X] + 1,
1037 aiptek->inputdev.absmax[ABS_Y] + 1);
1040 /* These structs define the sysfs files, param #1 is the name of the
1041 * file, param 2 is the file permissions, param 3 & 4 are to the
1042 * output generator and input parser routines. Absence of a routine is
1043 * permitted -- it only means can't either 'cat' the file, or send data
1044 * to it.
1046 static DEVICE_ATTR(size, S_IRUGO, show_tabletSize, NULL);
1048 /***********************************************************************
1049 * support routines for the 'product_id' file
1051 static ssize_t show_tabletProductId(struct device *dev, char *buf)
1053 struct aiptek *aiptek = dev_get_drvdata(dev);
1055 if (aiptek == NULL)
1056 return 0;
1058 return snprintf(buf, PAGE_SIZE, "0x%04x\n",
1059 aiptek->inputdev.id.product);
1062 static DEVICE_ATTR(product_id, S_IRUGO, show_tabletProductId, NULL);
1064 /***********************************************************************
1065 * support routines for the 'vendor_id' file
1067 static ssize_t show_tabletVendorId(struct device *dev, char *buf)
1069 struct aiptek *aiptek = dev_get_drvdata(dev);
1071 if (aiptek == NULL)
1072 return 0;
1074 return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->inputdev.id.vendor);
1077 static DEVICE_ATTR(vendor_id, S_IRUGO, show_tabletVendorId, NULL);
1079 /***********************************************************************
1080 * support routines for the 'vendor' file
1082 static ssize_t show_tabletManufacturer(struct device *dev, char *buf)
1084 struct aiptek *aiptek = dev_get_drvdata(dev);
1085 int retval;
1087 if (aiptek == NULL)
1088 return 0;
1090 retval = snprintf(buf, PAGE_SIZE, "%s\n", aiptek->usbdev->manufacturer);
1091 return retval;
1094 static DEVICE_ATTR(vendor, S_IRUGO, show_tabletManufacturer, NULL);
1096 /***********************************************************************
1097 * support routines for the 'product' file
1099 static ssize_t show_tabletProduct(struct device *dev, char *buf)
1101 struct aiptek *aiptek = dev_get_drvdata(dev);
1102 int retval;
1104 if (aiptek == NULL)
1105 return 0;
1107 retval = snprintf(buf, PAGE_SIZE, "%s\n", aiptek->usbdev->product);
1108 return retval;
1111 static DEVICE_ATTR(product, S_IRUGO, show_tabletProduct, NULL);
1113 /***********************************************************************
1114 * support routines for the 'pointer_mode' file. Note that this file
1115 * both displays current setting and allows reprogramming.
1117 static ssize_t show_tabletPointerMode(struct device *dev, char *buf)
1119 struct aiptek *aiptek = dev_get_drvdata(dev);
1120 char *s;
1122 if (aiptek == NULL)
1123 return 0;
1125 switch (aiptek->curSetting.pointerMode) {
1126 case AIPTEK_POINTER_ONLY_STYLUS_MODE:
1127 s = "stylus";
1128 break;
1130 case AIPTEK_POINTER_ONLY_MOUSE_MODE:
1131 s = "mouse";
1132 break;
1134 case AIPTEK_POINTER_EITHER_MODE:
1135 s = "either";
1136 break;
1138 default:
1139 s = "unknown";
1140 break;
1142 return snprintf(buf, PAGE_SIZE, "%s\n", s);
1145 static ssize_t
1146 store_tabletPointerMode(struct device *dev, const char *buf, size_t count)
1148 struct aiptek *aiptek = dev_get_drvdata(dev);
1149 if (aiptek == NULL)
1150 return 0;
1152 if (strcmp(buf, "stylus") == 0) {
1153 aiptek->newSetting.pointerMode =
1154 AIPTEK_POINTER_ONLY_STYLUS_MODE;
1155 } else if (strcmp(buf, "mouse") == 0) {
1156 aiptek->newSetting.pointerMode = AIPTEK_POINTER_ONLY_MOUSE_MODE;
1157 } else if (strcmp(buf, "either") == 0) {
1158 aiptek->newSetting.pointerMode = AIPTEK_POINTER_EITHER_MODE;
1160 return count;
1163 static DEVICE_ATTR(pointer_mode,
1164 S_IRUGO | S_IWUGO,
1165 show_tabletPointerMode, store_tabletPointerMode);
1167 /***********************************************************************
1168 * support routines for the 'coordinate_mode' file. Note that this file
1169 * both displays current setting and allows reprogramming.
1171 static ssize_t show_tabletCoordinateMode(struct device *dev, char *buf)
1173 struct aiptek *aiptek = dev_get_drvdata(dev);
1174 char *s;
1176 if (aiptek == NULL)
1177 return 0;
1179 switch (aiptek->curSetting.coordinateMode) {
1180 case AIPTEK_COORDINATE_ABSOLUTE_MODE:
1181 s = "absolute";
1182 break;
1184 case AIPTEK_COORDINATE_RELATIVE_MODE:
1185 s = "relative";
1186 break;
1188 default:
1189 s = "unknown";
1190 break;
1192 return snprintf(buf, PAGE_SIZE, "%s\n", s);
1195 static ssize_t
1196 store_tabletCoordinateMode(struct device *dev, const char *buf, size_t count)
1198 struct aiptek *aiptek = dev_get_drvdata(dev);
1199 if (aiptek == NULL)
1200 return 0;
1202 if (strcmp(buf, "absolute") == 0) {
1203 aiptek->newSetting.pointerMode =
1204 AIPTEK_COORDINATE_ABSOLUTE_MODE;
1205 } else if (strcmp(buf, "relative") == 0) {
1206 aiptek->newSetting.pointerMode =
1207 AIPTEK_COORDINATE_RELATIVE_MODE;
1209 return count;
1212 static DEVICE_ATTR(coordinate_mode,
1213 S_IRUGO | S_IWUGO,
1214 show_tabletCoordinateMode, store_tabletCoordinateMode);
1216 /***********************************************************************
1217 * support routines for the 'tool_mode' file. Note that this file
1218 * both displays current setting and allows reprogramming.
1220 static ssize_t show_tabletToolMode(struct device *dev, char *buf)
1222 struct aiptek *aiptek = dev_get_drvdata(dev);
1223 char *s;
1225 if (aiptek == NULL)
1226 return 0;
1228 switch (TOOL_BUTTON(aiptek->curSetting.toolMode)) {
1229 case AIPTEK_TOOL_BUTTON_MOUSE_MODE:
1230 s = "mouse";
1231 break;
1233 case AIPTEK_TOOL_BUTTON_ERASER_MODE:
1234 s = "eraser";
1235 break;
1237 case AIPTEK_TOOL_BUTTON_PENCIL_MODE:
1238 s = "pencil";
1239 break;
1241 case AIPTEK_TOOL_BUTTON_PEN_MODE:
1242 s = "pen";
1243 break;
1245 case AIPTEK_TOOL_BUTTON_BRUSH_MODE:
1246 s = "brush";
1247 break;
1249 case AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE:
1250 s = "airbrush";
1251 break;
1253 case AIPTEK_TOOL_BUTTON_LENS_MODE:
1254 s = "lens";
1255 break;
1257 default:
1258 s = "unknown";
1259 break;
1261 return snprintf(buf, PAGE_SIZE, "%s\n", s);
1264 static ssize_t
1265 store_tabletToolMode(struct device *dev, const char *buf, size_t count)
1267 struct aiptek *aiptek = dev_get_drvdata(dev);
1268 if (aiptek == NULL)
1269 return 0;
1271 if (strcmp(buf, "mouse") == 0) {
1272 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_MOUSE_MODE;
1273 } else if (strcmp(buf, "eraser") == 0) {
1274 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_ERASER_MODE;
1275 } else if (strcmp(buf, "pencil") == 0) {
1276 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_PENCIL_MODE;
1277 } else if (strcmp(buf, "pen") == 0) {
1278 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_PEN_MODE;
1279 } else if (strcmp(buf, "brush") == 0) {
1280 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_BRUSH_MODE;
1281 } else if (strcmp(buf, "airbrush") == 0) {
1282 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE;
1283 } else if (strcmp(buf, "lens") == 0) {
1284 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_LENS_MODE;
1287 return count;
1290 static DEVICE_ATTR(tool_mode,
1291 S_IRUGO | S_IWUGO,
1292 show_tabletToolMode, store_tabletToolMode);
1294 /***********************************************************************
1295 * support routines for the 'xtilt' file. Note that this file
1296 * both displays current setting and allows reprogramming.
1298 static ssize_t show_tabletXtilt(struct device *dev, char *buf)
1300 struct aiptek *aiptek = dev_get_drvdata(dev);
1302 if (aiptek == NULL)
1303 return 0;
1305 if (aiptek->curSetting.xTilt == AIPTEK_TILT_DISABLE) {
1306 return snprintf(buf, PAGE_SIZE, "disable\n");
1307 } else {
1308 return snprintf(buf, PAGE_SIZE, "%d\n",
1309 aiptek->curSetting.xTilt);
1313 static ssize_t
1314 store_tabletXtilt(struct device *dev, const char *buf, size_t count)
1316 struct aiptek *aiptek = dev_get_drvdata(dev);
1317 int x;
1319 if (aiptek == NULL)
1320 return 0;
1322 if (strcmp(buf, "disable") == 0) {
1323 aiptek->newSetting.xTilt = AIPTEK_TILT_DISABLE;
1324 } else {
1325 x = (int)simple_strtol(buf, NULL, 10);
1326 if (x >= AIPTEK_TILT_MIN && x <= AIPTEK_TILT_MAX) {
1327 aiptek->newSetting.xTilt = x;
1330 return count;
1333 static DEVICE_ATTR(xtilt,
1334 S_IRUGO | S_IWUGO, show_tabletXtilt, store_tabletXtilt);
1336 /***********************************************************************
1337 * support routines for the 'ytilt' file. Note that this file
1338 * both displays current setting and allows reprogramming.
1340 static ssize_t show_tabletYtilt(struct device *dev, char *buf)
1342 struct aiptek *aiptek = dev_get_drvdata(dev);
1344 if (aiptek == NULL)
1345 return 0;
1347 if (aiptek->curSetting.yTilt == AIPTEK_TILT_DISABLE) {
1348 return snprintf(buf, PAGE_SIZE, "disable\n");
1349 } else {
1350 return snprintf(buf, PAGE_SIZE, "%d\n",
1351 aiptek->curSetting.yTilt);
1355 static ssize_t
1356 store_tabletYtilt(struct device *dev, const char *buf, size_t count)
1358 struct aiptek *aiptek = dev_get_drvdata(dev);
1359 int y;
1361 if (aiptek == NULL)
1362 return 0;
1364 if (strcmp(buf, "disable") == 0) {
1365 aiptek->newSetting.yTilt = AIPTEK_TILT_DISABLE;
1366 } else {
1367 y = (int)simple_strtol(buf, NULL, 10);
1368 if (y >= AIPTEK_TILT_MIN && y <= AIPTEK_TILT_MAX) {
1369 aiptek->newSetting.yTilt = y;
1372 return count;
1375 static DEVICE_ATTR(ytilt,
1376 S_IRUGO | S_IWUGO, show_tabletYtilt, store_tabletYtilt);
1378 /***********************************************************************
1379 * support routines for the 'jitter' file. Note that this file
1380 * both displays current setting and allows reprogramming.
1382 static ssize_t show_tabletJitterDelay(struct device *dev, char *buf)
1384 struct aiptek *aiptek = dev_get_drvdata(dev);
1386 if (aiptek == NULL)
1387 return 0;
1389 return snprintf(buf, PAGE_SIZE, "%d\n", aiptek->curSetting.jitterDelay);
1392 static ssize_t
1393 store_tabletJitterDelay(struct device *dev, const char *buf, size_t count)
1395 struct aiptek *aiptek = dev_get_drvdata(dev);
1397 if (aiptek == NULL)
1398 return 0;
1400 aiptek->newSetting.jitterDelay = (int)simple_strtol(buf, NULL, 10);
1401 return count;
1404 static DEVICE_ATTR(jitter,
1405 S_IRUGO | S_IWUGO,
1406 show_tabletJitterDelay, store_tabletJitterDelay);
1408 /***********************************************************************
1409 * support routines for the 'delay' file. Note that this file
1410 * both displays current setting and allows reprogramming.
1412 static ssize_t show_tabletProgrammableDelay(struct device *dev, char *buf)
1414 struct aiptek *aiptek = dev_get_drvdata(dev);
1416 if (aiptek == NULL)
1417 return 0;
1419 return snprintf(buf, PAGE_SIZE, "%d\n",
1420 aiptek->curSetting.programmableDelay);
1423 static ssize_t
1424 store_tabletProgrammableDelay(struct device *dev, const char *buf, size_t count)
1426 struct aiptek *aiptek = dev_get_drvdata(dev);
1428 if (aiptek == NULL)
1429 return 0;
1431 aiptek->newSetting.programmableDelay = (int)simple_strtol(buf, NULL, 10);
1432 return count;
1435 static DEVICE_ATTR(delay,
1436 S_IRUGO | S_IWUGO,
1437 show_tabletProgrammableDelay, store_tabletProgrammableDelay);
1439 /***********************************************************************
1440 * support routines for the 'input_path' file. Note that this file
1441 * only displays current setting.
1443 static ssize_t show_tabletInputDevice(struct device *dev, char *buf)
1445 struct aiptek *aiptek = dev_get_drvdata(dev);
1447 if (aiptek == NULL)
1448 return 0;
1450 return snprintf(buf, PAGE_SIZE, "/dev/input/%s\n",
1451 aiptek->features.inputPath);
1454 static DEVICE_ATTR(input_path, S_IRUGO, show_tabletInputDevice, NULL);
1456 /***********************************************************************
1457 * support routines for the 'event_count' file. Note that this file
1458 * only displays current setting.
1460 static ssize_t show_tabletEventsReceived(struct device *dev, char *buf)
1462 struct aiptek *aiptek = dev_get_drvdata(dev);
1464 if (aiptek == NULL)
1465 return 0;
1467 return snprintf(buf, PAGE_SIZE, "%ld\n", aiptek->eventCount);
1470 static DEVICE_ATTR(event_count, S_IRUGO, show_tabletEventsReceived, NULL);
1472 /***********************************************************************
1473 * support routines for the 'diagnostic' file. Note that this file
1474 * only displays current setting.
1476 static ssize_t show_tabletDiagnosticMessage(struct device *dev, char *buf)
1478 struct aiptek *aiptek = dev_get_drvdata(dev);
1479 char *retMsg;
1481 if (aiptek == NULL)
1482 return 0;
1484 switch (aiptek->diagnostic) {
1485 case AIPTEK_DIAGNOSTIC_NA:
1486 retMsg = "no errors\n";
1487 break;
1489 case AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE:
1490 retMsg = "Error: receiving relative reports\n";
1491 break;
1493 case AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE:
1494 retMsg = "Error: receiving absolute reports\n";
1495 break;
1497 case AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED:
1498 if (aiptek->curSetting.pointerMode ==
1499 AIPTEK_POINTER_ONLY_MOUSE_MODE) {
1500 retMsg = "Error: receiving stylus reports\n";
1501 } else {
1502 retMsg = "Error: receiving mouse reports\n";
1504 break;
1506 default:
1507 return 0;
1509 return snprintf(buf, PAGE_SIZE, retMsg);
1512 static DEVICE_ATTR(diagnostic, S_IRUGO, show_tabletDiagnosticMessage, NULL);
1514 /***********************************************************************
1515 * support routines for the 'stylus_upper' file. Note that this file
1516 * both displays current setting and allows for setting changing.
1518 static ssize_t show_tabletStylusUpper(struct device *dev, char *buf)
1520 struct aiptek *aiptek = dev_get_drvdata(dev);
1521 char *s;
1523 if (aiptek == NULL)
1524 return 0;
1526 switch (aiptek->curSetting.stylusButtonUpper) {
1527 case AIPTEK_STYLUS_UPPER_BUTTON:
1528 s = "upper";
1529 break;
1531 case AIPTEK_STYLUS_LOWER_BUTTON:
1532 s = "lower";
1533 break;
1535 default:
1536 s = "unknown";
1537 break;
1539 return snprintf(buf, PAGE_SIZE, "%s\n", s);
1542 static ssize_t
1543 store_tabletStylusUpper(struct device *dev, const char *buf, size_t count)
1545 struct aiptek *aiptek = dev_get_drvdata(dev);
1547 if (aiptek == NULL)
1548 return 0;
1550 if (strcmp(buf, "upper") == 0) {
1551 aiptek->newSetting.stylusButtonUpper =
1552 AIPTEK_STYLUS_UPPER_BUTTON;
1553 } else if (strcmp(buf, "lower") == 0) {
1554 aiptek->newSetting.stylusButtonUpper =
1555 AIPTEK_STYLUS_LOWER_BUTTON;
1557 return count;
1560 static DEVICE_ATTR(stylus_upper,
1561 S_IRUGO | S_IWUGO,
1562 show_tabletStylusUpper, store_tabletStylusUpper);
1564 /***********************************************************************
1565 * support routines for the 'stylus_lower' file. Note that this file
1566 * both displays current setting and allows for setting changing.
1568 static ssize_t show_tabletStylusLower(struct device *dev, char *buf)
1570 struct aiptek *aiptek = dev_get_drvdata(dev);
1571 char *s;
1573 if (aiptek == NULL)
1574 return 0;
1576 switch (aiptek->curSetting.stylusButtonLower) {
1577 case AIPTEK_STYLUS_UPPER_BUTTON:
1578 s = "upper";
1579 break;
1581 case AIPTEK_STYLUS_LOWER_BUTTON:
1582 s = "lower";
1583 break;
1585 default:
1586 s = "unknown";
1587 break;
1589 return snprintf(buf, PAGE_SIZE, "%s\n", s);
1592 static ssize_t
1593 store_tabletStylusLower(struct device *dev, const char *buf, size_t count)
1595 struct aiptek *aiptek = dev_get_drvdata(dev);
1597 if (aiptek == NULL)
1598 return 0;
1600 if (strcmp(buf, "upper") == 0) {
1601 aiptek->newSetting.stylusButtonLower =
1602 AIPTEK_STYLUS_UPPER_BUTTON;
1603 } else if (strcmp(buf, "lower") == 0) {
1604 aiptek->newSetting.stylusButtonLower =
1605 AIPTEK_STYLUS_LOWER_BUTTON;
1607 return count;
1610 static DEVICE_ATTR(stylus_lower,
1611 S_IRUGO | S_IWUGO,
1612 show_tabletStylusLower, store_tabletStylusLower);
1614 /***********************************************************************
1615 * support routines for the 'mouse_left' file. Note that this file
1616 * both displays current setting and allows for setting changing.
1618 static ssize_t show_tabletMouseLeft(struct device *dev, char *buf)
1620 struct aiptek *aiptek = dev_get_drvdata(dev);
1621 char *s;
1623 if (aiptek == NULL)
1624 return 0;
1626 switch (aiptek->curSetting.mouseButtonLeft) {
1627 case AIPTEK_MOUSE_LEFT_BUTTON:
1628 s = "left";
1629 break;
1631 case AIPTEK_MOUSE_MIDDLE_BUTTON:
1632 s = "middle";
1633 break;
1635 case AIPTEK_MOUSE_RIGHT_BUTTON:
1636 s = "right";
1637 break;
1639 default:
1640 s = "unknown";
1641 break;
1643 return snprintf(buf, PAGE_SIZE, "%s\n", s);
1646 static ssize_t
1647 store_tabletMouseLeft(struct device *dev, const char *buf, size_t count)
1649 struct aiptek *aiptek = dev_get_drvdata(dev);
1651 if (aiptek == NULL)
1652 return 0;
1654 if (strcmp(buf, "left") == 0) {
1655 aiptek->newSetting.mouseButtonLeft = AIPTEK_MOUSE_LEFT_BUTTON;
1656 } else if (strcmp(buf, "middle") == 0) {
1657 aiptek->newSetting.mouseButtonLeft = AIPTEK_MOUSE_MIDDLE_BUTTON;
1658 } else if (strcmp(buf, "right") == 0) {
1659 aiptek->newSetting.mouseButtonLeft = AIPTEK_MOUSE_RIGHT_BUTTON;
1661 return count;
1664 static DEVICE_ATTR(mouse_left,
1665 S_IRUGO | S_IWUGO,
1666 show_tabletMouseLeft, store_tabletMouseLeft);
1668 /***********************************************************************
1669 * support routines for the 'mouse_middle' file. Note that this file
1670 * both displays current setting and allows for setting changing.
1672 static ssize_t show_tabletMouseMiddle(struct device *dev, char *buf)
1674 struct aiptek *aiptek = dev_get_drvdata(dev);
1675 char *s;
1677 if (aiptek == NULL)
1678 return 0;
1680 switch (aiptek->curSetting.mouseButtonMiddle) {
1681 case AIPTEK_MOUSE_LEFT_BUTTON:
1682 s = "left";
1683 break;
1685 case AIPTEK_MOUSE_MIDDLE_BUTTON:
1686 s = "middle";
1687 break;
1689 case AIPTEK_MOUSE_RIGHT_BUTTON:
1690 s = "right";
1691 break;
1693 default:
1694 s = "unknown";
1695 break;
1697 return snprintf(buf, PAGE_SIZE, "%s\n", s);
1700 static ssize_t
1701 store_tabletMouseMiddle(struct device *dev, const char *buf, size_t count)
1703 struct aiptek *aiptek = dev_get_drvdata(dev);
1705 if (aiptek == NULL)
1706 return 0;
1708 if (strcmp(buf, "left") == 0) {
1709 aiptek->newSetting.mouseButtonMiddle = AIPTEK_MOUSE_LEFT_BUTTON;
1710 } else if (strcmp(buf, "middle") == 0) {
1711 aiptek->newSetting.mouseButtonMiddle =
1712 AIPTEK_MOUSE_MIDDLE_BUTTON;
1713 } else if (strcmp(buf, "right") == 0) {
1714 aiptek->newSetting.mouseButtonMiddle =
1715 AIPTEK_MOUSE_RIGHT_BUTTON;
1717 return count;
1720 static DEVICE_ATTR(mouse_middle,
1721 S_IRUGO | S_IWUGO,
1722 show_tabletMouseMiddle, store_tabletMouseMiddle);
1724 /***********************************************************************
1725 * support routines for the 'mouse_right' file. Note that this file
1726 * both displays current setting and allows for setting changing.
1728 static ssize_t show_tabletMouseRight(struct device *dev, char *buf)
1730 struct aiptek *aiptek = dev_get_drvdata(dev);
1731 char *s;
1733 if (aiptek == NULL)
1734 return 0;
1736 switch (aiptek->curSetting.mouseButtonRight) {
1737 case AIPTEK_MOUSE_LEFT_BUTTON:
1738 s = "left";
1739 break;
1741 case AIPTEK_MOUSE_MIDDLE_BUTTON:
1742 s = "middle";
1743 break;
1745 case AIPTEK_MOUSE_RIGHT_BUTTON:
1746 s = "right";
1747 break;
1749 default:
1750 s = "unknown";
1751 break;
1753 return snprintf(buf, PAGE_SIZE, "%s\n", s);
1756 static ssize_t
1757 store_tabletMouseRight(struct device *dev, const char *buf, size_t count)
1759 struct aiptek *aiptek = dev_get_drvdata(dev);
1761 if (aiptek == NULL)
1762 return 0;
1764 if (strcmp(buf, "left") == 0) {
1765 aiptek->newSetting.mouseButtonRight = AIPTEK_MOUSE_LEFT_BUTTON;
1766 } else if (strcmp(buf, "middle") == 0) {
1767 aiptek->newSetting.mouseButtonRight =
1768 AIPTEK_MOUSE_MIDDLE_BUTTON;
1769 } else if (strcmp(buf, "right") == 0) {
1770 aiptek->newSetting.mouseButtonRight = AIPTEK_MOUSE_RIGHT_BUTTON;
1772 return count;
1775 static DEVICE_ATTR(mouse_right,
1776 S_IRUGO | S_IWUGO,
1777 show_tabletMouseRight, store_tabletMouseRight);
1779 /***********************************************************************
1780 * support routines for the 'wheel' file. Note that this file
1781 * both displays current setting and allows for setting changing.
1783 static ssize_t show_tabletWheel(struct device *dev, char *buf)
1785 struct aiptek *aiptek = dev_get_drvdata(dev);
1787 if (aiptek == NULL)
1788 return 0;
1790 if (aiptek->curSetting.wheel == AIPTEK_WHEEL_DISABLE) {
1791 return snprintf(buf, PAGE_SIZE, "disable\n");
1792 } else {
1793 return snprintf(buf, PAGE_SIZE, "%d\n",
1794 aiptek->curSetting.wheel);
1798 static ssize_t
1799 store_tabletWheel(struct device *dev, const char *buf, size_t count)
1801 struct aiptek *aiptek = dev_get_drvdata(dev);
1803 if (aiptek == NULL)
1804 return 0;
1806 aiptek->newSetting.wheel = (int)simple_strtol(buf, NULL, 10);
1807 return count;
1810 static DEVICE_ATTR(wheel,
1811 S_IRUGO | S_IWUGO, show_tabletWheel, store_tabletWheel);
1813 /***********************************************************************
1814 * support routines for the 'execute' file. Note that this file
1815 * both displays current setting and allows for setting changing.
1817 static ssize_t show_tabletExecute(struct device *dev, char *buf)
1819 struct aiptek *aiptek = dev_get_drvdata(dev);
1821 if (aiptek == NULL)
1822 return 0;
1824 /* There is nothing useful to display, so a one-line manual
1825 * is in order...
1827 return snprintf(buf, PAGE_SIZE,
1828 "Write anything to this file to program your tablet.\n");
1831 static ssize_t
1832 store_tabletExecute(struct device *dev, const char *buf, size_t count)
1834 struct aiptek *aiptek = dev_get_drvdata(dev);
1836 if (aiptek == NULL)
1837 return 0;
1839 /* We do not care what you write to this file. Merely the action
1840 * of writing to this file triggers a tablet reprogramming.
1842 memcpy(&aiptek->curSetting, &aiptek->newSetting,
1843 sizeof(struct aiptek_settings));
1845 if (aiptek_program_tablet(aiptek) < 0)
1846 return -EIO;
1848 return count;
1851 static DEVICE_ATTR(execute,
1852 S_IRUGO | S_IWUGO, show_tabletExecute, store_tabletExecute);
1854 /***********************************************************************
1855 * support routines for the 'odm_code' file. Note that this file
1856 * only displays current setting.
1858 static ssize_t show_tabletODMCode(struct device *dev, char *buf)
1860 struct aiptek *aiptek = dev_get_drvdata(dev);
1862 if (aiptek == NULL)
1863 return 0;
1865 return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->features.odmCode);
1868 static DEVICE_ATTR(odm_code, S_IRUGO, show_tabletODMCode, NULL);
1870 /***********************************************************************
1871 * support routines for the 'model_code' file. Note that this file
1872 * only displays current setting.
1874 static ssize_t show_tabletModelCode(struct device *dev, char *buf)
1876 struct aiptek *aiptek = dev_get_drvdata(dev);
1878 if (aiptek == NULL)
1879 return 0;
1881 return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->features.modelCode);
1884 static DEVICE_ATTR(model_code, S_IRUGO, show_tabletModelCode, NULL);
1886 /***********************************************************************
1887 * support routines for the 'firmware_code' file. Note that this file
1888 * only displays current setting.
1890 static ssize_t show_firmwareCode(struct device *dev, char *buf)
1892 struct aiptek *aiptek = dev_get_drvdata(dev);
1894 if (aiptek == NULL)
1895 return 0;
1897 return snprintf(buf, PAGE_SIZE, "%04x\n",
1898 aiptek->features.firmwareCode);
1901 static DEVICE_ATTR(firmware_code, S_IRUGO, show_firmwareCode, NULL);
1903 /***********************************************************************
1904 * This routine removes all existing sysfs files managed by this device
1905 * driver.
1907 static void aiptek_delete_files(struct device *dev)
1909 device_remove_file(dev, &dev_attr_size);
1910 device_remove_file(dev, &dev_attr_product_id);
1911 device_remove_file(dev, &dev_attr_vendor_id);
1912 device_remove_file(dev, &dev_attr_vendor);
1913 device_remove_file(dev, &dev_attr_product);
1914 device_remove_file(dev, &dev_attr_pointer_mode);
1915 device_remove_file(dev, &dev_attr_coordinate_mode);
1916 device_remove_file(dev, &dev_attr_tool_mode);
1917 device_remove_file(dev, &dev_attr_xtilt);
1918 device_remove_file(dev, &dev_attr_ytilt);
1919 device_remove_file(dev, &dev_attr_jitter);
1920 device_remove_file(dev, &dev_attr_delay);
1921 device_remove_file(dev, &dev_attr_input_path);
1922 device_remove_file(dev, &dev_attr_event_count);
1923 device_remove_file(dev, &dev_attr_diagnostic);
1924 device_remove_file(dev, &dev_attr_odm_code);
1925 device_remove_file(dev, &dev_attr_model_code);
1926 device_remove_file(dev, &dev_attr_firmware_code);
1927 device_remove_file(dev, &dev_attr_stylus_lower);
1928 device_remove_file(dev, &dev_attr_stylus_upper);
1929 device_remove_file(dev, &dev_attr_mouse_left);
1930 device_remove_file(dev, &dev_attr_mouse_middle);
1931 device_remove_file(dev, &dev_attr_mouse_right);
1932 device_remove_file(dev, &dev_attr_wheel);
1933 device_remove_file(dev, &dev_attr_execute);
1936 /***********************************************************************
1937 * This routine creates the sysfs files managed by this device
1938 * driver.
1940 static int aiptek_add_files(struct device *dev)
1942 int ret;
1944 if ((ret = device_create_file(dev, &dev_attr_size)) ||
1945 (ret = device_create_file(dev, &dev_attr_product_id)) ||
1946 (ret = device_create_file(dev, &dev_attr_vendor_id)) ||
1947 (ret = device_create_file(dev, &dev_attr_vendor)) ||
1948 (ret = device_create_file(dev, &dev_attr_product)) ||
1949 (ret = device_create_file(dev, &dev_attr_pointer_mode)) ||
1950 (ret = device_create_file(dev, &dev_attr_coordinate_mode)) ||
1951 (ret = device_create_file(dev, &dev_attr_tool_mode)) ||
1952 (ret = device_create_file(dev, &dev_attr_xtilt)) ||
1953 (ret = device_create_file(dev, &dev_attr_ytilt)) ||
1954 (ret = device_create_file(dev, &dev_attr_jitter)) ||
1955 (ret = device_create_file(dev, &dev_attr_delay)) ||
1956 (ret = device_create_file(dev, &dev_attr_input_path)) ||
1957 (ret = device_create_file(dev, &dev_attr_event_count)) ||
1958 (ret = device_create_file(dev, &dev_attr_diagnostic)) ||
1959 (ret = device_create_file(dev, &dev_attr_odm_code)) ||
1960 (ret = device_create_file(dev, &dev_attr_model_code)) ||
1961 (ret = device_create_file(dev, &dev_attr_firmware_code)) ||
1962 (ret = device_create_file(dev, &dev_attr_stylus_lower)) ||
1963 (ret = device_create_file(dev, &dev_attr_stylus_upper)) ||
1964 (ret = device_create_file(dev, &dev_attr_mouse_left)) ||
1965 (ret = device_create_file(dev, &dev_attr_mouse_middle)) ||
1966 (ret = device_create_file(dev, &dev_attr_mouse_right)) ||
1967 (ret = device_create_file(dev, &dev_attr_wheel)) ||
1968 (ret = device_create_file(dev, &dev_attr_execute))) {
1969 err("aiptek: killing own sysfs device files\n");
1970 aiptek_delete_files(dev);
1972 return ret;
1975 /***********************************************************************
1976 * This routine is called when a tablet has been identified. It basically
1977 * sets up the tablet and the driver's internal structures.
1979 static int
1980 aiptek_probe(struct usb_interface *intf, const struct usb_device_id *id)
1982 struct usb_device *usbdev = interface_to_usbdev(intf);
1983 struct usb_endpoint_descriptor *endpoint;
1984 struct aiptek *aiptek;
1985 struct input_dev *inputdev;
1986 struct input_handle *inputhandle;
1987 struct list_head *node, *next;
1988 char path[64 + 1];
1989 int i;
1990 int speeds[] = { 0,
1991 AIPTEK_PROGRAMMABLE_DELAY_50,
1992 AIPTEK_PROGRAMMABLE_DELAY_400,
1993 AIPTEK_PROGRAMMABLE_DELAY_25,
1994 AIPTEK_PROGRAMMABLE_DELAY_100,
1995 AIPTEK_PROGRAMMABLE_DELAY_200,
1996 AIPTEK_PROGRAMMABLE_DELAY_300
1999 /* programmableDelay is where the command-line specified
2000 * delay is kept. We make it the first element of speeds[],
2001 * so therefore, your override speed is tried first, then the
2002 * remainder. Note that the default value of 400ms will be tried
2003 * if you do not specify any command line parameter.
2005 speeds[0] = programmableDelay;
2007 if ((aiptek = kmalloc(sizeof(struct aiptek), GFP_KERNEL)) == NULL)
2008 return -ENOMEM;
2009 memset(aiptek, 0, sizeof(struct aiptek));
2011 aiptek->data = usb_buffer_alloc(usbdev, AIPTEK_PACKET_LENGTH,
2012 SLAB_ATOMIC, &aiptek->data_dma);
2013 if (aiptek->data == NULL) {
2014 kfree(aiptek);
2015 return -ENOMEM;
2018 aiptek->urb = usb_alloc_urb(0, GFP_KERNEL);
2019 if (aiptek->urb == NULL) {
2020 usb_buffer_free(usbdev, AIPTEK_PACKET_LENGTH, aiptek->data,
2021 aiptek->data_dma);
2022 kfree(aiptek);
2023 return -ENOMEM;
2026 /* Set up the curSettings struct. Said struct contains the current
2027 * programmable parameters. The newSetting struct contains changes
2028 * the user makes to the settings via the sysfs interface. Those
2029 * changes are not "committed" to curSettings until the user
2030 * writes to the sysfs/.../execute file.
2032 aiptek->curSetting.pointerMode = AIPTEK_POINTER_EITHER_MODE;
2033 aiptek->curSetting.coordinateMode = AIPTEK_COORDINATE_ABSOLUTE_MODE;
2034 aiptek->curSetting.toolMode = AIPTEK_TOOL_BUTTON_PEN_MODE;
2035 aiptek->curSetting.xTilt = AIPTEK_TILT_DISABLE;
2036 aiptek->curSetting.yTilt = AIPTEK_TILT_DISABLE;
2037 aiptek->curSetting.mouseButtonLeft = AIPTEK_MOUSE_LEFT_BUTTON;
2038 aiptek->curSetting.mouseButtonMiddle = AIPTEK_MOUSE_MIDDLE_BUTTON;
2039 aiptek->curSetting.mouseButtonRight = AIPTEK_MOUSE_RIGHT_BUTTON;
2040 aiptek->curSetting.stylusButtonUpper = AIPTEK_STYLUS_UPPER_BUTTON;
2041 aiptek->curSetting.stylusButtonLower = AIPTEK_STYLUS_LOWER_BUTTON;
2042 aiptek->curSetting.jitterDelay = jitterDelay;
2043 aiptek->curSetting.programmableDelay = programmableDelay;
2045 /* Both structs should have equivalent settings
2047 memcpy(&aiptek->newSetting, &aiptek->curSetting,
2048 sizeof(struct aiptek_settings));
2050 /* Now program the capacities of the tablet, in terms of being
2051 * an input device.
2053 aiptek->inputdev.evbit[0] |= BIT(EV_KEY)
2054 | BIT(EV_ABS)
2055 | BIT(EV_REL)
2056 | BIT(EV_MSC);
2058 aiptek->inputdev.absbit[0] |=
2059 (BIT(ABS_X) |
2060 BIT(ABS_Y) |
2061 BIT(ABS_PRESSURE) |
2062 BIT(ABS_TILT_X) |
2063 BIT(ABS_TILT_Y) | BIT(ABS_WHEEL) | BIT(ABS_MISC));
2065 aiptek->inputdev.relbit[0] |=
2066 (BIT(REL_X) | BIT(REL_Y) | BIT(REL_WHEEL) | BIT(REL_MISC));
2068 aiptek->inputdev.keybit[LONG(BTN_LEFT)] |=
2069 (BIT(BTN_LEFT) | BIT(BTN_RIGHT) | BIT(BTN_MIDDLE));
2071 aiptek->inputdev.keybit[LONG(BTN_DIGI)] |=
2072 (BIT(BTN_TOOL_PEN) |
2073 BIT(BTN_TOOL_RUBBER) |
2074 BIT(BTN_TOOL_PENCIL) |
2075 BIT(BTN_TOOL_AIRBRUSH) |
2076 BIT(BTN_TOOL_BRUSH) |
2077 BIT(BTN_TOOL_MOUSE) |
2078 BIT(BTN_TOOL_LENS) |
2079 BIT(BTN_TOUCH) | BIT(BTN_STYLUS) | BIT(BTN_STYLUS2));
2081 aiptek->inputdev.mscbit[0] = BIT(MSC_SERIAL);
2083 /* Programming the tablet macro keys needs to be done with a for loop
2084 * as the keycodes are discontiguous.
2086 for (i = 0; i < sizeof(macroKeyEvents) / sizeof(macroKeyEvents[0]); ++i)
2087 set_bit(macroKeyEvents[i], aiptek->inputdev.keybit);
2089 /* Set up client data, pointers to open and close routines
2090 * for the input device.
2092 aiptek->inputdev.private = aiptek;
2093 aiptek->inputdev.open = aiptek_open;
2094 aiptek->inputdev.close = aiptek_close;
2096 /* Determine the usb devices' physical path.
2097 * Asketh not why we always pretend we're using "../input0",
2098 * but I suspect this will have to be refactored one
2099 * day if a single USB device can be a keyboard & a mouse
2100 * & a tablet, and the inputX number actually will tell
2101 * us something...
2103 if (usb_make_path(usbdev, path, 64) > 0)
2104 sprintf(aiptek->features.usbPath, "%s/input0", path);
2106 /* Program the input device coordinate capacities. We do not yet
2107 * know what maximum X, Y, and Z values are, so we're putting fake
2108 * values in. Later, we'll ask the tablet to put in the correct
2109 * values.
2111 aiptek->inputdev.absmin[ABS_X] = 0;
2112 aiptek->inputdev.absmax[ABS_X] = 2999;
2113 aiptek->inputdev.absmin[ABS_Y] = 0;
2114 aiptek->inputdev.absmax[ABS_Y] = 2249;
2115 aiptek->inputdev.absmin[ABS_PRESSURE] = 0;
2116 aiptek->inputdev.absmax[ABS_PRESSURE] = 511;
2117 aiptek->inputdev.absmin[ABS_TILT_X] = AIPTEK_TILT_MIN;
2118 aiptek->inputdev.absmax[ABS_TILT_X] = AIPTEK_TILT_MAX;
2119 aiptek->inputdev.absmin[ABS_TILT_Y] = AIPTEK_TILT_MIN;
2120 aiptek->inputdev.absmax[ABS_TILT_Y] = AIPTEK_TILT_MAX;
2121 aiptek->inputdev.absmin[ABS_WHEEL] = AIPTEK_WHEEL_MIN;
2122 aiptek->inputdev.absmax[ABS_WHEEL] = AIPTEK_WHEEL_MAX - 1;
2123 aiptek->inputdev.absfuzz[ABS_X] = 0;
2124 aiptek->inputdev.absfuzz[ABS_Y] = 0;
2125 aiptek->inputdev.absfuzz[ABS_PRESSURE] = 0;
2126 aiptek->inputdev.absfuzz[ABS_TILT_X] = 0;
2127 aiptek->inputdev.absfuzz[ABS_TILT_Y] = 0;
2128 aiptek->inputdev.absfuzz[ABS_WHEEL] = 0;
2129 aiptek->inputdev.absflat[ABS_X] = 0;
2130 aiptek->inputdev.absflat[ABS_Y] = 0;
2131 aiptek->inputdev.absflat[ABS_PRESSURE] = 0;
2132 aiptek->inputdev.absflat[ABS_TILT_X] = 0;
2133 aiptek->inputdev.absflat[ABS_TILT_Y] = 0;
2134 aiptek->inputdev.absflat[ABS_WHEEL] = 0;
2135 aiptek->inputdev.name = "Aiptek";
2136 aiptek->inputdev.phys = aiptek->features.usbPath;
2137 aiptek->inputdev.id.bustype = BUS_USB;
2138 aiptek->inputdev.id.vendor = le16_to_cpu(usbdev->descriptor.idVendor);
2139 aiptek->inputdev.id.product = le16_to_cpu(usbdev->descriptor.idProduct);
2140 aiptek->inputdev.id.version = le16_to_cpu(usbdev->descriptor.bcdDevice);
2141 aiptek->inputdev.dev = &intf->dev;
2143 aiptek->usbdev = usbdev;
2144 aiptek->ifnum = intf->altsetting[0].desc.bInterfaceNumber;
2145 aiptek->inDelay = 0;
2146 aiptek->endDelay = 0;
2147 aiptek->previousJitterable = 0;
2149 endpoint = &intf->altsetting[0].endpoint[0].desc;
2151 /* Go set up our URB, which is called when the tablet receives
2152 * input.
2154 usb_fill_int_urb(aiptek->urb,
2155 aiptek->usbdev,
2156 usb_rcvintpipe(aiptek->usbdev,
2157 endpoint->bEndpointAddress),
2158 aiptek->data, 8, aiptek_irq, aiptek,
2159 endpoint->bInterval);
2161 aiptek->urb->transfer_dma = aiptek->data_dma;
2162 aiptek->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
2164 /* Register the tablet as an Input Device
2166 input_register_device(&aiptek->inputdev);
2168 /* We now will look for the evdev device which is mapped to
2169 * the tablet. The partial name is kept in the link list of
2170 * input_handles associated with this input device.
2171 * What identifies an evdev input_handler is that it begins
2172 * with 'event', continues with a digit, and that in turn
2173 * is mapped to /{devfs}/input/eventN.
2175 inputdev = &aiptek->inputdev;
2176 list_for_each_safe(node, next, &inputdev->h_list) {
2177 inputhandle = to_handle(node);
2178 if (strncmp(inputhandle->name, "event", 5) == 0) {
2179 strcpy(aiptek->features.inputPath, inputhandle->name);
2180 break;
2184 info("input: Aiptek on %s (%s)\n", path, aiptek->features.inputPath);
2186 /* Program the tablet. This sets the tablet up in the mode
2187 * specified in newSetting, and also queries the tablet's
2188 * physical capacities.
2190 * Sanity check: if a tablet doesn't like the slow programmatic
2191 * delay, we often get sizes of 0x0. Let's use that as an indicator
2192 * to try faster delays, up to 25 ms. If that logic fails, well, you'll
2193 * have to explain to us how your tablet thinks it's 0x0, and yet that's
2194 * not an error :-)
2197 for (i = 0; i < sizeof(speeds) / sizeof(speeds[0]); ++i) {
2198 aiptek->curSetting.programmableDelay = speeds[i];
2199 (void)aiptek_program_tablet(aiptek);
2200 if (aiptek->inputdev.absmax[ABS_X] > 0) {
2201 info("input: Aiptek using %d ms programming speed\n",
2202 aiptek->curSetting.programmableDelay);
2203 break;
2207 /* Associate this driver's struct with the usb interface.
2209 usb_set_intfdata(intf, aiptek);
2211 /* Set up the sysfs files
2213 aiptek_add_files(&intf->dev);
2215 /* Make sure the evdev module is loaded. Assuming evdev IS a module :-)
2217 if (request_module("evdev") != 0)
2218 info("aiptek: error loading 'evdev' module");
2220 return 0;
2223 /* Forward declaration */
2224 static void aiptek_disconnect(struct usb_interface *intf);
2226 static struct usb_driver aiptek_driver = {
2227 .owner = THIS_MODULE,
2228 .name = "aiptek",
2229 .probe = aiptek_probe,
2230 .disconnect = aiptek_disconnect,
2231 .id_table = aiptek_ids,
2234 /***********************************************************************
2235 * Deal with tablet disconnecting from the system.
2237 static void aiptek_disconnect(struct usb_interface *intf)
2239 struct aiptek *aiptek = usb_get_intfdata(intf);
2241 /* Disassociate driver's struct with usb interface
2243 usb_set_intfdata(intf, NULL);
2244 if (aiptek != NULL) {
2245 /* Free & unhook everything from the system.
2247 usb_kill_urb(aiptek->urb);
2248 input_unregister_device(&aiptek->inputdev);
2249 aiptek_delete_files(&intf->dev);
2250 usb_free_urb(aiptek->urb);
2251 usb_buffer_free(interface_to_usbdev(intf),
2252 AIPTEK_PACKET_LENGTH,
2253 aiptek->data, aiptek->data_dma);
2254 kfree(aiptek);
2255 aiptek = NULL;
2259 static int __init aiptek_init(void)
2261 int result = usb_register(&aiptek_driver);
2262 if (result == 0) {
2263 info(DRIVER_VERSION ": " DRIVER_AUTHOR);
2264 info(DRIVER_DESC);
2266 return result;
2269 static void __exit aiptek_exit(void)
2271 usb_deregister(&aiptek_driver);
2274 MODULE_AUTHOR(DRIVER_AUTHOR);
2275 MODULE_DESCRIPTION(DRIVER_DESC);
2276 MODULE_LICENSE("GPL");
2278 module_param(programmableDelay, int, 0);
2279 MODULE_PARM_DESC(programmableDelay, "delay used during tablet programming");
2280 module_param(jitterDelay, int, 0);
2281 MODULE_PARM_DESC(jitterDelay, "stylus/mouse settlement delay");
2283 module_init(aiptek_init);
2284 module_exit(aiptek_exit);