blob: 0a619c558bfb40a8223c94301462d6387f7dc388 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Native support for the Aiptek HyperPen USB Tablets
3 * (4000U/5000U/6000U/8000U/12000U)
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -05004 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * Copyright (c) 2001 Chris Atenasio <chris@crud.net>
6 * Copyright (c) 2002-2004 Bryan W. Headley <bwheadley@earthlink.net>
7 *
8 * based on wacom.c by
9 * Vojtech Pavlik <vojtech@suse.cz>
10 * Andreas Bach Aaen <abach@stofanet.dk>
11 * Clifford Wolf <clifford@clifford.at>
12 * Sam Mosel <sam.mosel@computer.org>
13 * James E. Blair <corvus@gnu.org>
14 * Daniel Egger <egger@suse.de>
15 *
16 * Many thanks to Oliver Kuechemann for his support.
17 *
18 * ChangeLog:
19 * v0.1 - Initial release
20 * v0.2 - Hack to get around fake event 28's. (Bryan W. Headley)
21 * v0.3 - Make URB dynamic (Bryan W. Headley, Jun-8-2002)
22 * Released to Linux 2.4.19 and 2.5.x
23 * v0.4 - Rewrote substantial portions of the code to deal with
24 * corrected control sequences, timing, dynamic configuration,
25 * support of 6000U - 12000U, procfs, and macro key support
26 * (Jan-1-2003 - Feb-5-2003, Bryan W. Headley)
27 * v1.0 - Added support for diagnostic messages, count of messages
28 * received from URB - Mar-8-2003, Bryan W. Headley
29 * v1.1 - added support for tablet resolution, changed DV and proximity
30 * some corrections - Jun-22-2003, martin schneebacher
31 * - Added support for the sysfs interface, deprecating the
32 * procfs interface for 2.5.x kernel. Also added support for
33 * Wheel command. Bryan W. Headley July-15-2003.
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -050034 * v1.2 - Reworked jitter timer as a kernel thread.
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 * Bryan W. Headley November-28-2003/Jan-10-2004.
36 * v1.3 - Repaired issue of kernel thread going nuts on single-processor
37 * machines, introduced programmableDelay as a command line
38 * parameter. Feb 7 2004, Bryan W. Headley.
39 * v1.4 - Re-wire jitter so it does not require a thread. Courtesy of
40 * Rene van Paassen. Added reporting of physical pointer device
41 * (e.g., stylus, mouse in reports 2, 3, 4, 5. We don't know
42 * for reports 1, 6.)
43 * what physical device reports for reports 1, 6.) Also enabled
44 * MOUSE and LENS tool button modes. Renamed "rubber" to "eraser".
45 * Feb 20, 2004, Bryan W. Headley.
46 * v1.5 - Added previousJitterable, so we don't do jitter delay when the
47 * user is holding a button down for periods of time.
48 *
49 * NOTE:
50 * This kernel driver is augmented by the "Aiptek" XFree86 input
51 * driver for your X server, as well as the Gaiptek GUI Front-end
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -050052 * "Tablet Manager".
53 * These three products are highly interactive with one another,
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 * so therefore it's easier to document them all as one subsystem.
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -050055 * Please visit the project's "home page", located at,
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 * http://aiptektablet.sourceforge.net.
57 *
58 * This program is free software; you can redistribute it and/or modify
59 * it under the terms of the GNU General Public License as published by
60 * the Free Software Foundation; either version 2 of the License, or
61 * (at your option) any later version.
62 *
63 * This program is distributed in the hope that it will be useful,
64 * but WITHOUT ANY WARRANTY; without even the implied warranty of
65 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
66 * GNU General Public License for more details.
67 *
68 * You should have received a copy of the GNU General Public License
69 * along with this program; if not, write to the Free Software
70 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
71 */
72
73#include <linux/jiffies.h>
74#include <linux/kernel.h>
75#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070076#include <linux/module.h>
77#include <linux/init.h>
David Brownellae0dadc2006-06-13 10:04:34 -070078#include <linux/usb/input.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070079#include <asm/uaccess.h>
80#include <asm/unaligned.h>
81
82/*
83 * Version Information
84 */
Rene van Paassen50355222007-05-21 00:32:21 -040085#define DRIVER_VERSION "v2.3 (May 2, 2007)"
86#define DRIVER_AUTHOR "Bryan W. Headley/Chris Atenasio/Cedric Brun/Rene van Paassen"
Linus Torvalds1da177e2005-04-16 15:20:36 -070087#define DRIVER_DESC "Aiptek HyperPen USB Tablet Driver (Linux 2.6.x)"
88
89/*
90 * Aiptek status packet:
91 *
92 * (returned as Report 1 - relative coordinates from mouse and stylus)
93 *
94 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
95 * byte0 0 0 0 0 0 0 0 1
96 * byte1 0 0 0 0 0 BS2 BS Tip
97 * byte2 X7 X6 X5 X4 X3 X2 X1 X0
98 * byte3 Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
99 *
100 * (returned as Report 2 - absolute coordinates from the stylus)
101 *
102 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
103 * byte0 0 0 0 0 0 0 1 0
104 * byte1 X7 X6 X5 X4 X3 X2 X1 X0
105 * byte2 X15 X14 X13 X12 X11 X10 X9 X8
106 * byte3 Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
107 * byte4 Y15 Y14 Y13 Y12 Y11 Y10 Y9 Y8
108 * byte5 * * * BS2 BS1 Tip IR DV
109 * byte6 P7 P6 P5 P4 P3 P2 P1 P0
110 * byte7 P15 P14 P13 P12 P11 P10 P9 P8
111 *
112 * (returned as Report 3 - absolute coordinates from the mouse)
113 *
114 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
Rene van Paassen2fe57412007-05-21 00:18:24 -0400115 * byte0 0 0 0 0 0 0 1 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 * byte1 X7 X6 X5 X4 X3 X2 X1 X0
117 * byte2 X15 X14 X13 X12 X11 X10 X9 X8
118 * byte3 Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0
119 * byte4 Y15 Y14 Y13 Y12 Y11 Y10 Y9 Y8
120 * byte5 * * * BS2 BS1 Tip IR DV
121 * byte6 P7 P6 P5 P4 P3 P2 P1 P0
122 * byte7 P15 P14 P13 P12 P11 P10 P9 P8
123 *
124 * (returned as Report 4 - macrokeys from the stylus)
125 *
126 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
127 * byte0 0 0 0 0 0 1 0 0
128 * byte1 0 0 0 BS2 BS Tip IR DV
129 * byte2 0 0 0 0 0 0 1 0
130 * byte3 0 0 0 K4 K3 K2 K1 K0
131 * byte4 P7 P6 P5 P4 P3 P2 P1 P0
132 * byte5 P15 P14 P13 P12 P11 P10 P9 P8
133 *
134 * (returned as Report 5 - macrokeys from the mouse)
135 *
136 * bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0
Rene van Paassen2fe57412007-05-21 00:18:24 -0400137 * byte0 0 0 0 0 0 1 0 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 * byte1 0 0 0 BS2 BS Tip IR DV
139 * byte2 0 0 0 0 0 0 1 0
140 * byte3 0 0 0 K4 K3 K2 K1 K0
141 * byte4 P7 P6 P5 P4 P3 P2 P1 P0
142 * byte5 P15 P14 P13 P12 P11 P10 P9 P8
143 *
144 * IR: In Range = Proximity on
145 * DV = Data Valid
146 * BS = Barrel Switch (as in, macro keys)
147 * BS2 also referred to as Tablet Pick
148 *
149 * Command Summary:
150 *
151 * Use report_type CONTROL (3)
152 * Use report_id 2
153 *
154 * Command/Data Description Return Bytes Return Value
155 * 0x10/0x00 SwitchToMouse 0
156 * 0x10/0x01 SwitchToTablet 0
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500157 * 0x18/0x04 SetResolution 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 * 0x12/0xFF AutoGainOn 0
159 * 0x17/0x00 FilterOn 0
160 * 0x01/0x00 GetXExtension 2 MaxX
161 * 0x01/0x01 GetYExtension 2 MaxY
162 * 0x02/0x00 GetModelCode 2 ModelCode = LOBYTE
163 * 0x03/0x00 GetODMCode 2 ODMCode
164 * 0x08/0x00 GetPressureLevels 2 =512
165 * 0x04/0x00 GetFirmwareVersion 2 Firmware Version
166 * 0x11/0x02 EnableMacroKeys 0
167 *
168 * To initialize the tablet:
169 *
170 * (1) Send Resolution500LPI (Command)
171 * (2) Query for Model code (Option Report)
172 * (3) Query for ODM code (Option Report)
173 * (4) Query for firmware (Option Report)
174 * (5) Query for GetXExtension (Option Report)
175 * (6) Query for GetYExtension (Option Report)
176 * (7) Query for GetPressureLevels (Option Report)
177 * (8) SwitchToTablet for Absolute coordinates, or
178 * SwitchToMouse for Relative coordinates (Command)
179 * (9) EnableMacroKeys (Command)
180 * (10) FilterOn (Command)
181 * (11) AutoGainOn (Command)
182 *
183 * (Step 9 can be omitted, but you'll then have no function keys.)
184 */
185
186#define USB_VENDOR_ID_AIPTEK 0x08ca
Guryanov Dmitrya32bcc42008-03-10 03:08:58 -0700187#define USB_VENDOR_ID_KYE 0x0458
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188#define USB_REQ_GET_REPORT 0x01
189#define USB_REQ_SET_REPORT 0x09
190
191 /* PointerMode codes
192 */
193#define AIPTEK_POINTER_ONLY_MOUSE_MODE 0
194#define AIPTEK_POINTER_ONLY_STYLUS_MODE 1
195#define AIPTEK_POINTER_EITHER_MODE 2
196
197#define AIPTEK_POINTER_ALLOW_MOUSE_MODE(a) \
198 (a == AIPTEK_POINTER_ONLY_MOUSE_MODE || \
199 a == AIPTEK_POINTER_EITHER_MODE)
200#define AIPTEK_POINTER_ALLOW_STYLUS_MODE(a) \
201 (a == AIPTEK_POINTER_ONLY_STYLUS_MODE || \
202 a == AIPTEK_POINTER_EITHER_MODE)
203
204 /* CoordinateMode code
205 */
206#define AIPTEK_COORDINATE_RELATIVE_MODE 0
207#define AIPTEK_COORDINATE_ABSOLUTE_MODE 1
208
209 /* XTilt and YTilt values
210 */
211#define AIPTEK_TILT_MIN (-128)
212#define AIPTEK_TILT_MAX 127
213#define AIPTEK_TILT_DISABLE (-10101)
214
215 /* Wheel values
216 */
217#define AIPTEK_WHEEL_MIN 0
218#define AIPTEK_WHEEL_MAX 1024
219#define AIPTEK_WHEEL_DISABLE (-10101)
220
221 /* ToolCode values, which BTW are 0x140 .. 0x14f
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400222 * We have things set up such that if the tool button has changed,
223 * the tools get reset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 /* toolMode codes
226 */
227#define AIPTEK_TOOL_BUTTON_PEN_MODE BTN_TOOL_PEN
228#define AIPTEK_TOOL_BUTTON_PEN_MODE BTN_TOOL_PEN
229#define AIPTEK_TOOL_BUTTON_PENCIL_MODE BTN_TOOL_PENCIL
230#define AIPTEK_TOOL_BUTTON_BRUSH_MODE BTN_TOOL_BRUSH
231#define AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE BTN_TOOL_AIRBRUSH
232#define AIPTEK_TOOL_BUTTON_ERASER_MODE BTN_TOOL_RUBBER
233#define AIPTEK_TOOL_BUTTON_MOUSE_MODE BTN_TOOL_MOUSE
234#define AIPTEK_TOOL_BUTTON_LENS_MODE BTN_TOOL_LENS
235
236 /* Diagnostic message codes
237 */
238#define AIPTEK_DIAGNOSTIC_NA 0
239#define AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE 1
240#define AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE 2
241#define AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED 3
242
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500243 /* Time to wait (in ms) to help mask hand jittering
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 * when pressing the stylus buttons.
245 */
246#define AIPTEK_JITTER_DELAY_DEFAULT 50
247
248 /* Time to wait (in ms) in-between sending the tablet
249 * a command and beginning the process of reading the return
250 * sequence from the tablet.
251 */
252#define AIPTEK_PROGRAMMABLE_DELAY_25 25
253#define AIPTEK_PROGRAMMABLE_DELAY_50 50
254#define AIPTEK_PROGRAMMABLE_DELAY_100 100
255#define AIPTEK_PROGRAMMABLE_DELAY_200 200
256#define AIPTEK_PROGRAMMABLE_DELAY_300 300
257#define AIPTEK_PROGRAMMABLE_DELAY_400 400
258#define AIPTEK_PROGRAMMABLE_DELAY_DEFAULT AIPTEK_PROGRAMMABLE_DELAY_400
259
260 /* Mouse button programming
261 */
Rene van Paassence0982e2007-05-21 00:31:45 -0400262#define AIPTEK_MOUSE_LEFT_BUTTON 0x04
263#define AIPTEK_MOUSE_RIGHT_BUTTON 0x08
264#define AIPTEK_MOUSE_MIDDLE_BUTTON 0x10
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
266 /* Stylus button programming
267 */
268#define AIPTEK_STYLUS_LOWER_BUTTON 0x08
269#define AIPTEK_STYLUS_UPPER_BUTTON 0x10
270
271 /* Length of incoming packet from the tablet
272 */
273#define AIPTEK_PACKET_LENGTH 8
274
275 /* We report in EV_MISC both the proximity and
276 * whether the report came from the stylus, tablet mouse
277 * or "unknown" -- Unknown when the tablet is in relative
278 * mode, because we only get report 1's.
279 */
280#define AIPTEK_REPORT_TOOL_UNKNOWN 0x10
281#define AIPTEK_REPORT_TOOL_STYLUS 0x20
282#define AIPTEK_REPORT_TOOL_MOUSE 0x40
283
284static int programmableDelay = AIPTEK_PROGRAMMABLE_DELAY_DEFAULT;
285static int jitterDelay = AIPTEK_JITTER_DELAY_DEFAULT;
286
287struct aiptek_features {
288 int odmCode; /* Tablet manufacturer code */
289 int modelCode; /* Tablet model code (not unique) */
290 int firmwareCode; /* prom/eeprom version */
291 char usbPath[64 + 1]; /* device's physical usb path */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292};
293
294struct aiptek_settings {
295 int pointerMode; /* stylus-, mouse-only or either */
296 int coordinateMode; /* absolute/relative coords */
297 int toolMode; /* pen, pencil, brush, etc. tool */
298 int xTilt; /* synthetic xTilt amount */
299 int yTilt; /* synthetic yTilt amount */
300 int wheel; /* synthetic wheel amount */
301 int stylusButtonUpper; /* stylus upper btn delivers... */
302 int stylusButtonLower; /* stylus lower btn delivers... */
303 int mouseButtonLeft; /* mouse left btn delivers... */
304 int mouseButtonMiddle; /* mouse middle btn delivers... */
305 int mouseButtonRight; /* mouse right btn delivers... */
306 int programmableDelay; /* delay for tablet programming */
307 int jitterDelay; /* delay for hand jittering */
308};
309
310struct aiptek {
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500311 struct input_dev *inputdev; /* input device struct */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 struct usb_device *usbdev; /* usb device struct */
313 struct urb *urb; /* urb for incoming reports */
314 dma_addr_t data_dma; /* our dma stuffage */
315 struct aiptek_features features; /* tablet's array of features */
316 struct aiptek_settings curSetting; /* tablet's current programmable */
317 struct aiptek_settings newSetting; /* ... and new param settings */
318 unsigned int ifnum; /* interface number for IO */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 int diagnostic; /* tablet diagnostic codes */
320 unsigned long eventCount; /* event count */
321 int inDelay; /* jitter: in jitter delay? */
322 unsigned long endDelay; /* jitter: time when delay ends */
323 int previousJitterable; /* jitterable prev value */
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400324
325 int lastMacro; /* macro key to reset */
326 int previousToolMode; /* pen, pencil, brush, etc. tool */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 unsigned char *data; /* incoming packet data */
328};
329
Rene van Paassen1a54f492007-05-21 00:31:55 -0400330static const int eventTypes[] = {
331 EV_KEY, EV_ABS, EV_REL, EV_MSC,
332};
333
334static const int absEvents[] = {
335 ABS_X, ABS_Y, ABS_PRESSURE, ABS_TILT_X, ABS_TILT_Y,
336 ABS_WHEEL, ABS_MISC,
337};
338
339static const int relEvents[] = {
340 REL_X, REL_Y, REL_WHEEL,
341};
342
Dmitry Torokhov33936fa2007-05-21 00:18:15 -0400343static const int buttonEvents[] = {
344 BTN_LEFT, BTN_RIGHT, BTN_MIDDLE,
345 BTN_TOOL_PEN, BTN_TOOL_RUBBER, BTN_TOOL_PENCIL, BTN_TOOL_AIRBRUSH,
346 BTN_TOOL_BRUSH, BTN_TOOL_MOUSE, BTN_TOOL_LENS, BTN_TOUCH,
347 BTN_STYLUS, BTN_STYLUS2,
348};
349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350/*
351 * Permit easy lookup of keyboard events to send, versus
352 * the bitmap which comes from the tablet. This hides the
353 * issue that the F_keys are not sequentially numbered.
354 */
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100355static const int macroKeyEvents[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 KEY_ESC, KEY_F1, KEY_F2, KEY_F3, KEY_F4, KEY_F5,
357 KEY_F6, KEY_F7, KEY_F8, KEY_F9, KEY_F10, KEY_F11,
358 KEY_F12, KEY_F13, KEY_F14, KEY_F15, KEY_F16, KEY_F17,
359 KEY_F18, KEY_F19, KEY_F20, KEY_F21, KEY_F22, KEY_F23,
360 KEY_F24, KEY_STOP, KEY_AGAIN, KEY_PROPS, KEY_UNDO,
361 KEY_FRONT, KEY_COPY, KEY_OPEN, KEY_PASTE, 0
362};
363
364/***********************************************************************
Adam Buchbinderc9404c92009-12-18 15:40:42 -0500365 * Map values to strings and back. Every map should have the following
Dmitry Torokhovcd438a52007-05-21 00:17:57 -0400366 * as its last element: { NULL, AIPTEK_INVALID_VALUE }.
367 */
368#define AIPTEK_INVALID_VALUE -1
369
370struct aiptek_map {
371 const char *string;
372 int value;
373};
374
375static int map_str_to_val(const struct aiptek_map *map, const char *str, size_t count)
376{
377 const struct aiptek_map *p;
378
Rene van Paassen0112db32007-05-21 00:32:12 -0400379 if (str[count - 1] == '\n')
380 count--;
381
Dmitry Torokhovcd438a52007-05-21 00:17:57 -0400382 for (p = map; p->string; p++)
Rene van Paassen0112db32007-05-21 00:32:12 -0400383 if (!strncmp(str, p->string, count))
Dmitry Torokhovcd438a52007-05-21 00:17:57 -0400384 return p->value;
385
386 return AIPTEK_INVALID_VALUE;
387}
388
389static const char *map_val_to_str(const struct aiptek_map *map, int val)
390{
391 const struct aiptek_map *p;
392
393 for (p = map; p->value != AIPTEK_INVALID_VALUE; p++)
394 if (val == p->value)
395 return p->string;
396
397 return "unknown";
398}
399
400/***********************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 * aiptek_irq can receive one of six potential reports.
402 * The documentation for each is in the body of the function.
403 *
404 * The tablet reports on several attributes per invocation of
405 * aiptek_irq. Because the Linux Input Event system allows the
406 * transmission of ONE attribute per input_report_xxx() call,
407 * collation has to be done on the other end to reconstitute
408 * a complete tablet report. Further, the number of Input Event reports
409 * submitted varies, depending on what USB report type, and circumstance.
410 * To deal with this, EV_MSC is used to indicate an 'end-of-report'
411 * message. This has been an undocumented convention understood by the kernel
412 * tablet driver and clients such as gpm and XFree86's tablet drivers.
413 *
414 * Of the information received from the tablet, the one piece I
415 * cannot transmit is the proximity bit (without resorting to an EV_MSC
416 * convention above.) I therefore have taken over REL_MISC and ABS_MISC
417 * (for relative and absolute reports, respectively) for communicating
418 * Proximity. Why two events? I thought it interesting to know if the
Steven Cole093cf722005-05-03 19:07:24 -0600419 * Proximity event occurred while the tablet was in absolute or relative
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 * mode.
Rene van Paassenda9fda42007-05-21 00:32:03 -0400421 * Update: REL_MISC proved not to be such a good idea. With REL_MISC you
422 * get an event transmitted each time. ABS_MISC works better, since it
423 * can be set and re-set. Thus, only using ABS_MISC from now on.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 *
425 * Other tablets use the notion of a certain minimum stylus pressure
426 * to infer proximity. While that could have been done, that is yet
427 * another 'by convention' behavior, the documentation for which
428 * would be spread between two (or more) pieces of software.
429 *
430 * EV_MSC usage was terminated for this purpose in Linux 2.5.x, and
431 * replaced with the input_sync() method (which emits EV_SYN.)
432 */
433
David Howells7d12e782006-10-05 14:55:46 +0100434static void aiptek_irq(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435{
436 struct aiptek *aiptek = urb->context;
437 unsigned char *data = aiptek->data;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -0500438 struct input_dev *inputdev = aiptek->inputdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 int jitterable = 0;
440 int retval, macro, x, y, z, left, right, middle, p, dv, tip, bs, pck;
441
442 switch (urb->status) {
443 case 0:
444 /* Success */
445 break;
446
447 case -ECONNRESET:
448 case -ENOENT:
449 case -ESHUTDOWN:
450 /* This urb is terminated, clean up */
451 dbg("%s - urb shutting down with status: %d",
Harvey Harrisonea3e6c52008-05-05 11:36:18 -0400452 __func__, urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 return;
454
455 default:
456 dbg("%s - nonzero urb status received: %d",
Harvey Harrisonea3e6c52008-05-05 11:36:18 -0400457 __func__, urb->status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 goto exit;
459 }
460
461 /* See if we are in a delay loop -- throw out report if true.
462 */
463 if (aiptek->inDelay == 1 && time_after(aiptek->endDelay, jiffies)) {
464 goto exit;
465 }
466
467 aiptek->inDelay = 0;
468 aiptek->eventCount++;
469
470 /* Report 1 delivers relative coordinates with either a stylus
471 * or the mouse. You do not know, however, which input
472 * tool generated the event.
473 */
474 if (data[0] == 1) {
475 if (aiptek->curSetting.coordinateMode ==
476 AIPTEK_COORDINATE_ABSOLUTE_MODE) {
477 aiptek->diagnostic =
478 AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE;
479 } else {
Dmitry Torokhov37767b62007-05-21 00:18:08 -0400480 x = (signed char) data[2];
481 y = (signed char) data[3];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
483 /* jitterable keeps track of whether any button has been pressed.
484 * We're also using it to remap the physical mouse button mask
485 * to pseudo-settings. (We don't specifically care about it's
486 * value after moving/transposing mouse button bitmasks, except
487 * that a non-zero value indicates that one or more
488 * mouse button was pressed.)
489 */
Mark Vytlacil0038cae2007-05-21 00:31:50 -0400490 jitterable = data[1] & 0x07;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
Mark Vytlacil0038cae2007-05-21 00:31:50 -0400492 left = (data[1] & aiptek->curSetting.mouseButtonLeft >> 2) != 0 ? 1 : 0;
493 right = (data[1] & aiptek->curSetting.mouseButtonRight >> 2) != 0 ? 1 : 0;
494 middle = (data[1] & aiptek->curSetting.mouseButtonMiddle >> 2) != 0 ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
496 input_report_key(inputdev, BTN_LEFT, left);
497 input_report_key(inputdev, BTN_MIDDLE, middle);
498 input_report_key(inputdev, BTN_RIGHT, right);
Mark Vytlacil0038cae2007-05-21 00:31:50 -0400499
500 input_report_abs(inputdev, ABS_MISC,
501 1 | AIPTEK_REPORT_TOOL_UNKNOWN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 input_report_rel(inputdev, REL_X, x);
503 input_report_rel(inputdev, REL_Y, y);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
505 /* Wheel support is in the form of a single-event
506 * firing.
507 */
508 if (aiptek->curSetting.wheel != AIPTEK_WHEEL_DISABLE) {
509 input_report_rel(inputdev, REL_WHEEL,
510 aiptek->curSetting.wheel);
511 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
512 }
Rene van Paassen1e7b3fa2007-05-21 00:32:17 -0400513 if (aiptek->lastMacro != -1) {
514 input_report_key(inputdev,
515 macroKeyEvents[aiptek->lastMacro], 0);
516 aiptek->lastMacro = -1;
517 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 input_sync(inputdev);
519 }
520 }
521 /* Report 2 is delivered only by the stylus, and delivers
522 * absolute coordinates.
523 */
524 else if (data[0] == 2) {
525 if (aiptek->curSetting.coordinateMode == AIPTEK_COORDINATE_RELATIVE_MODE) {
526 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE;
527 } else if (!AIPTEK_POINTER_ALLOW_STYLUS_MODE
528 (aiptek->curSetting.pointerMode)) {
529 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED;
530 } else {
Harvey Harrison858ad082008-04-29 01:03:34 -0700531 x = get_unaligned_le16(data + 1);
532 y = get_unaligned_le16(data + 3);
533 z = get_unaligned_le16(data + 6);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
Rene van Paassenfe981f22007-05-21 00:31:24 -0400535 dv = (data[5] & 0x01) != 0 ? 1 : 0;
536 p = (data[5] & 0x02) != 0 ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 tip = (data[5] & 0x04) != 0 ? 1 : 0;
538
539 /* Use jitterable to re-arrange button masks
540 */
541 jitterable = data[5] & 0x18;
542
543 bs = (data[5] & aiptek->curSetting.stylusButtonLower) != 0 ? 1 : 0;
544 pck = (data[5] & aiptek->curSetting.stylusButtonUpper) != 0 ? 1 : 0;
545
546 /* dv indicates 'data valid' (e.g., the tablet is in sync
547 * and has delivered a "correct" report) We will ignore
548 * all 'bad' reports...
549 */
550 if (dv != 0) {
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400551 /* If the selected tool changed, reset the old
552 * tool key, and set the new one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 */
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400554 if (aiptek->previousToolMode !=
555 aiptek->curSetting.toolMode) {
556 input_report_key(inputdev,
557 aiptek->previousToolMode, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 input_report_key(inputdev,
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400559 aiptek->curSetting.toolMode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 1);
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400561 aiptek->previousToolMode =
562 aiptek->curSetting.toolMode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 }
564
565 if (p != 0) {
566 input_report_abs(inputdev, ABS_X, x);
567 input_report_abs(inputdev, ABS_Y, y);
568 input_report_abs(inputdev, ABS_PRESSURE, z);
569
570 input_report_key(inputdev, BTN_TOUCH, tip);
571 input_report_key(inputdev, BTN_STYLUS, bs);
572 input_report_key(inputdev, BTN_STYLUS2, pck);
573
574 if (aiptek->curSetting.xTilt !=
575 AIPTEK_TILT_DISABLE) {
576 input_report_abs(inputdev,
577 ABS_TILT_X,
578 aiptek->curSetting.xTilt);
579 }
580 if (aiptek->curSetting.yTilt != AIPTEK_TILT_DISABLE) {
581 input_report_abs(inputdev,
582 ABS_TILT_Y,
583 aiptek->curSetting.yTilt);
584 }
585
586 /* Wheel support is in the form of a single-event
587 * firing.
588 */
589 if (aiptek->curSetting.wheel !=
590 AIPTEK_WHEEL_DISABLE) {
591 input_report_abs(inputdev,
592 ABS_WHEEL,
593 aiptek->curSetting.wheel);
594 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
595 }
596 }
597 input_report_abs(inputdev, ABS_MISC, p | AIPTEK_REPORT_TOOL_STYLUS);
Rene van Paassen1e7b3fa2007-05-21 00:32:17 -0400598 if (aiptek->lastMacro != -1) {
599 input_report_key(inputdev,
600 macroKeyEvents[aiptek->lastMacro], 0);
601 aiptek->lastMacro = -1;
602 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 input_sync(inputdev);
604 }
605 }
606 }
607 /* Report 3's come from the mouse in absolute mode.
608 */
609 else if (data[0] == 3) {
610 if (aiptek->curSetting.coordinateMode == AIPTEK_COORDINATE_RELATIVE_MODE) {
611 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE;
612 } else if (!AIPTEK_POINTER_ALLOW_MOUSE_MODE
613 (aiptek->curSetting.pointerMode)) {
614 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED;
615 } else {
Harvey Harrison858ad082008-04-29 01:03:34 -0700616 x = get_unaligned_le16(data + 1);
617 y = get_unaligned_le16(data + 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
619 jitterable = data[5] & 0x1c;
620
Rene van Paassenfe981f22007-05-21 00:31:24 -0400621 dv = (data[5] & 0x01) != 0 ? 1 : 0;
622 p = (data[5] & 0x02) != 0 ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 left = (data[5] & aiptek->curSetting.mouseButtonLeft) != 0 ? 1 : 0;
624 right = (data[5] & aiptek->curSetting.mouseButtonRight) != 0 ? 1 : 0;
625 middle = (data[5] & aiptek->curSetting.mouseButtonMiddle) != 0 ? 1 : 0;
626
627 if (dv != 0) {
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400628 /* If the selected tool changed, reset the old
629 * tool key, and set the new one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 */
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400631 if (aiptek->previousToolMode !=
632 aiptek->curSetting.toolMode) {
633 input_report_key(inputdev,
634 aiptek->previousToolMode, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 input_report_key(inputdev,
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400636 aiptek->curSetting.toolMode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 1);
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400638 aiptek->previousToolMode =
639 aiptek->curSetting.toolMode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 }
641
642 if (p != 0) {
643 input_report_abs(inputdev, ABS_X, x);
644 input_report_abs(inputdev, ABS_Y, y);
645
646 input_report_key(inputdev, BTN_LEFT, left);
647 input_report_key(inputdev, BTN_MIDDLE, middle);
648 input_report_key(inputdev, BTN_RIGHT, right);
649
650 /* Wheel support is in the form of a single-event
651 * firing.
652 */
653 if (aiptek->curSetting.wheel != AIPTEK_WHEEL_DISABLE) {
654 input_report_abs(inputdev,
655 ABS_WHEEL,
656 aiptek->curSetting.wheel);
657 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
658 }
659 }
Rene van Paassenda9fda42007-05-21 00:32:03 -0400660 input_report_abs(inputdev, ABS_MISC, p | AIPTEK_REPORT_TOOL_MOUSE);
Rene van Paassen1e7b3fa2007-05-21 00:32:17 -0400661 if (aiptek->lastMacro != -1) {
662 input_report_key(inputdev,
663 macroKeyEvents[aiptek->lastMacro], 0);
664 aiptek->lastMacro = -1;
665 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 input_sync(inputdev);
667 }
668 }
669 }
670 /* Report 4s come from the macro keys when pressed by stylus
671 */
672 else if (data[0] == 4) {
673 jitterable = data[1] & 0x18;
674
Rene van Paassenfe981f22007-05-21 00:31:24 -0400675 dv = (data[1] & 0x01) != 0 ? 1 : 0;
676 p = (data[1] & 0x02) != 0 ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 tip = (data[1] & 0x04) != 0 ? 1 : 0;
678 bs = (data[1] & aiptek->curSetting.stylusButtonLower) != 0 ? 1 : 0;
679 pck = (data[1] & aiptek->curSetting.stylusButtonUpper) != 0 ? 1 : 0;
680
Rene van Paassen1e7b3fa2007-05-21 00:32:17 -0400681 macro = dv && p && tip && !(data[3] & 1) ? (data[3] >> 1) : -1;
Harvey Harrison858ad082008-04-29 01:03:34 -0700682 z = get_unaligned_le16(data + 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683
Rene van Paassen1e7b3fa2007-05-21 00:32:17 -0400684 if (dv) {
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400685 /* If the selected tool changed, reset the old
686 * tool key, and set the new one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 */
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400688 if (aiptek->previousToolMode !=
689 aiptek->curSetting.toolMode) {
690 input_report_key(inputdev,
691 aiptek->previousToolMode, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 input_report_key(inputdev,
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400693 aiptek->curSetting.toolMode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 1);
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400695 aiptek->previousToolMode =
696 aiptek->curSetting.toolMode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 }
Rene van Paassen1e7b3fa2007-05-21 00:32:17 -0400699
700 if (aiptek->lastMacro != -1 && aiptek->lastMacro != macro) {
701 input_report_key(inputdev, macroKeyEvents[aiptek->lastMacro], 0);
702 aiptek->lastMacro = -1;
703 }
704
705 if (macro != -1 && macro != aiptek->lastMacro) {
706 input_report_key(inputdev, macroKeyEvents[macro], 1);
707 aiptek->lastMacro = macro;
708 }
709 input_report_abs(inputdev, ABS_MISC,
710 p | AIPTEK_REPORT_TOOL_STYLUS);
711 input_sync(inputdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 }
713 /* Report 5s come from the macro keys when pressed by mouse
714 */
715 else if (data[0] == 5) {
716 jitterable = data[1] & 0x1c;
717
Rene van Paassenfe981f22007-05-21 00:31:24 -0400718 dv = (data[1] & 0x01) != 0 ? 1 : 0;
719 p = (data[1] & 0x02) != 0 ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 left = (data[1]& aiptek->curSetting.mouseButtonLeft) != 0 ? 1 : 0;
721 right = (data[1] & aiptek->curSetting.mouseButtonRight) != 0 ? 1 : 0;
722 middle = (data[1] & aiptek->curSetting.mouseButtonMiddle) != 0 ? 1 : 0;
Rene van Paassen1e7b3fa2007-05-21 00:32:17 -0400723 macro = dv && p && left && !(data[3] & 1) ? (data[3] >> 1) : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
Rene van Paassen1e7b3fa2007-05-21 00:32:17 -0400725 if (dv) {
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400726 /* If the selected tool changed, reset the old
727 * tool key, and set the new one.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 */
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400729 if (aiptek->previousToolMode !=
730 aiptek->curSetting.toolMode) {
Rene van Paassen1e7b3fa2007-05-21 00:32:17 -0400731 input_report_key(inputdev,
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400732 aiptek->previousToolMode, 0);
Rene van Paassen1e7b3fa2007-05-21 00:32:17 -0400733 input_report_key(inputdev,
734 aiptek->curSetting.toolMode, 1);
735 aiptek->previousToolMode = aiptek->curSetting.toolMode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 }
Rene van Paassen1e7b3fa2007-05-21 00:32:17 -0400738
739 if (aiptek->lastMacro != -1 && aiptek->lastMacro != macro) {
740 input_report_key(inputdev, macroKeyEvents[aiptek->lastMacro], 0);
741 aiptek->lastMacro = -1;
742 }
743
744 if (macro != -1 && macro != aiptek->lastMacro) {
745 input_report_key(inputdev, macroKeyEvents[macro], 1);
746 aiptek->lastMacro = macro;
747 }
748
749 input_report_abs(inputdev, ABS_MISC,
750 p | AIPTEK_REPORT_TOOL_MOUSE);
751 input_sync(inputdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 }
753 /* We have no idea which tool can generate a report 6. Theoretically,
754 * neither need to, having been given reports 4 & 5 for such use.
755 * However, report 6 is the 'official-looking' report for macroKeys;
756 * reports 4 & 5 supposively are used to support unnamed, unknown
757 * hat switches (which just so happen to be the macroKeys.)
758 */
759 else if (data[0] == 6) {
Harvey Harrison858ad082008-04-29 01:03:34 -0700760 macro = get_unaligned_le16(data + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 if (macro > 0) {
762 input_report_key(inputdev, macroKeyEvents[macro - 1],
763 0);
764 }
765 if (macro < 25) {
766 input_report_key(inputdev, macroKeyEvents[macro + 1],
767 0);
768 }
769
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400770 /* If the selected tool changed, reset the old
771 tool key, and set the new one.
772 */
773 if (aiptek->previousToolMode !=
774 aiptek->curSetting.toolMode) {
775 input_report_key(inputdev,
776 aiptek->previousToolMode, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 input_report_key(inputdev,
Rene van Paassenb3b6cf12007-05-21 00:32:07 -0400778 aiptek->curSetting.toolMode,
779 1);
780 aiptek->previousToolMode =
781 aiptek->curSetting.toolMode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 }
783
784 input_report_key(inputdev, macroKeyEvents[macro], 1);
785 input_report_abs(inputdev, ABS_MISC,
786 1 | AIPTEK_REPORT_TOOL_UNKNOWN);
787 input_sync(inputdev);
788 } else {
789 dbg("Unknown report %d", data[0]);
790 }
791
792 /* Jitter may occur when the user presses a button on the stlyus
793 * or the mouse. What we do to prevent that is wait 'x' milliseconds
794 * following a 'jitterable' event, which should give the hand some time
795 * stabilize itself.
796 *
797 * We just introduced aiptek->previousJitterable to carry forth the
798 * notion that jitter occurs when the button state changes from on to off:
799 * a person drawing, holding a button down is not subject to jittering.
800 * With that in mind, changing from upper button depressed to lower button
801 * WILL transition through a jitter delay.
802 */
803
804 if (aiptek->previousJitterable != jitterable &&
805 aiptek->curSetting.jitterDelay != 0 && aiptek->inDelay != 1) {
806 aiptek->endDelay = jiffies +
807 ((aiptek->curSetting.jitterDelay * HZ) / 1000);
808 aiptek->inDelay = 1;
809 }
810 aiptek->previousJitterable = jitterable;
811
812exit:
813 retval = usb_submit_urb(urb, GFP_ATOMIC);
814 if (retval != 0) {
815 err("%s - usb_submit_urb failed with result %d",
Harvey Harrisonea3e6c52008-05-05 11:36:18 -0400816 __func__, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 }
818}
819
820/***********************************************************************
821 * These are the USB id's known so far. We do not identify them to
822 * specific Aiptek model numbers, because there has been overlaps,
823 * use, and reuse of id's in existing models. Certain models have
824 * been known to use more than one ID, indicative perhaps of
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500825 * manufacturing revisions. In any event, we consider these
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 * IDs to not be model-specific nor unique.
827 */
828static const struct usb_device_id aiptek_ids[] = {
829 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x01)},
830 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x10)},
831 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x20)},
832 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x21)},
833 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x22)},
834 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x23)},
835 {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x24)},
Guryanov Dmitrya32bcc42008-03-10 03:08:58 -0700836 {USB_DEVICE(USB_VENDOR_ID_KYE, 0x5003)},
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 {}
838};
839
840MODULE_DEVICE_TABLE(usb, aiptek_ids);
841
842/***********************************************************************
843 * Open an instance of the tablet driver.
844 */
845static int aiptek_open(struct input_dev *inputdev)
846{
Dmitry Torokhov7791bda2007-04-12 01:34:39 -0400847 struct aiptek *aiptek = input_get_drvdata(inputdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 aiptek->urb->dev = aiptek->usbdev;
Dmitry Torokhov65cde542005-05-29 02:29:38 -0500850 if (usb_submit_urb(aiptek->urb, GFP_KERNEL) != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852
853 return 0;
854}
855
856/***********************************************************************
857 * Close an instance of the tablet driver.
858 */
859static void aiptek_close(struct input_dev *inputdev)
860{
Dmitry Torokhov7791bda2007-04-12 01:34:39 -0400861 struct aiptek *aiptek = input_get_drvdata(inputdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862
Dmitry Torokhov65cde542005-05-29 02:29:38 -0500863 usb_kill_urb(aiptek->urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864}
865
866/***********************************************************************
Dmitry Torokhov05f091ab2005-05-29 02:29:01 -0500867 * aiptek_set_report and aiptek_get_report() are borrowed from Linux 2.4.x,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 * where they were known as usb_set_report and usb_get_report.
869 */
870static int
871aiptek_set_report(struct aiptek *aiptek,
872 unsigned char report_type,
873 unsigned char report_id, void *buffer, int size)
874{
875 return usb_control_msg(aiptek->usbdev,
876 usb_sndctrlpipe(aiptek->usbdev, 0),
877 USB_REQ_SET_REPORT,
878 USB_TYPE_CLASS | USB_RECIP_INTERFACE |
879 USB_DIR_OUT, (report_type << 8) + report_id,
880 aiptek->ifnum, buffer, size, 5000);
881}
882
883static int
884aiptek_get_report(struct aiptek *aiptek,
885 unsigned char report_type,
886 unsigned char report_id, void *buffer, int size)
887{
888 return usb_control_msg(aiptek->usbdev,
889 usb_rcvctrlpipe(aiptek->usbdev, 0),
890 USB_REQ_GET_REPORT,
891 USB_TYPE_CLASS | USB_RECIP_INTERFACE |
892 USB_DIR_IN, (report_type << 8) + report_id,
893 aiptek->ifnum, buffer, size, 5000);
894}
895
896/***********************************************************************
897 * Send a command to the tablet.
898 */
899static int
900aiptek_command(struct aiptek *aiptek, unsigned char command, unsigned char data)
901{
902 const int sizeof_buf = 3 * sizeof(u8);
903 int ret;
904 u8 *buf;
905
906 buf = kmalloc(sizeof_buf, GFP_KERNEL);
907 if (!buf)
908 return -ENOMEM;
909
910 buf[0] = 2;
911 buf[1] = command;
912 buf[2] = data;
913
914 if ((ret =
915 aiptek_set_report(aiptek, 3, 2, buf, sizeof_buf)) != sizeof_buf) {
916 dbg("aiptek_program: failed, tried to send: 0x%02x 0x%02x",
917 command, data);
918 }
919 kfree(buf);
920 return ret < 0 ? ret : 0;
921}
922
923/***********************************************************************
924 * Retrieve information from the tablet. Querying info is defined as first
925 * sending the {command,data} sequence as a command, followed by a wait
926 * (aka, "programmaticDelay") and then a "read" request.
927 */
928static int
929aiptek_query(struct aiptek *aiptek, unsigned char command, unsigned char data)
930{
931 const int sizeof_buf = 3 * sizeof(u8);
932 int ret;
933 u8 *buf;
934
935 buf = kmalloc(sizeof_buf, GFP_KERNEL);
936 if (!buf)
937 return -ENOMEM;
938
939 buf[0] = 2;
940 buf[1] = command;
941 buf[2] = data;
942
943 if (aiptek_command(aiptek, command, data) != 0) {
944 kfree(buf);
945 return -EIO;
946 }
947 msleep(aiptek->curSetting.programmableDelay);
948
949 if ((ret =
950 aiptek_get_report(aiptek, 3, 2, buf, sizeof_buf)) != sizeof_buf) {
951 dbg("aiptek_query failed: returned 0x%02x 0x%02x 0x%02x",
952 buf[0], buf[1], buf[2]);
953 ret = -EIO;
954 } else {
Harvey Harrison858ad082008-04-29 01:03:34 -0700955 ret = get_unaligned_le16(buf + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 }
957 kfree(buf);
958 return ret;
959}
960
961/***********************************************************************
962 * Program the tablet into either absolute or relative mode.
963 * We also get information about the tablet's size.
964 */
965static int aiptek_program_tablet(struct aiptek *aiptek)
966{
967 int ret;
968 /* Execute Resolution500LPI */
969 if ((ret = aiptek_command(aiptek, 0x18, 0x04)) < 0)
970 return ret;
971
972 /* Query getModelCode */
973 if ((ret = aiptek_query(aiptek, 0x02, 0x00)) < 0)
974 return ret;
975 aiptek->features.modelCode = ret & 0xff;
976
977 /* Query getODMCode */
978 if ((ret = aiptek_query(aiptek, 0x03, 0x00)) < 0)
979 return ret;
980 aiptek->features.odmCode = ret;
981
982 /* Query getFirmwareCode */
983 if ((ret = aiptek_query(aiptek, 0x04, 0x00)) < 0)
984 return ret;
985 aiptek->features.firmwareCode = ret;
986
987 /* Query getXextension */
988 if ((ret = aiptek_query(aiptek, 0x01, 0x00)) < 0)
989 return ret;
Daniel Mack987a6c02010-08-02 20:15:17 -0700990 input_set_abs_params(aiptek->inputdev, ABS_X, 0, ret - 1, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
992 /* Query getYextension */
993 if ((ret = aiptek_query(aiptek, 0x01, 0x01)) < 0)
994 return ret;
Daniel Mack987a6c02010-08-02 20:15:17 -0700995 input_set_abs_params(aiptek->inputdev, ABS_Y, 0, ret - 1, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996
997 /* Query getPressureLevels */
998 if ((ret = aiptek_query(aiptek, 0x08, 0x00)) < 0)
999 return ret;
Daniel Mack987a6c02010-08-02 20:15:17 -07001000 input_set_abs_params(aiptek->inputdev, ABS_PRESSURE, 0, ret - 1, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001
1002 /* Depending on whether we are in absolute or relative mode, we will
1003 * do a switchToTablet(absolute) or switchToMouse(relative) command.
1004 */
1005 if (aiptek->curSetting.coordinateMode ==
1006 AIPTEK_COORDINATE_ABSOLUTE_MODE) {
1007 /* Execute switchToTablet */
1008 if ((ret = aiptek_command(aiptek, 0x10, 0x01)) < 0) {
1009 return ret;
1010 }
1011 } else {
1012 /* Execute switchToMouse */
1013 if ((ret = aiptek_command(aiptek, 0x10, 0x00)) < 0) {
1014 return ret;
1015 }
1016 }
1017
1018 /* Enable the macro keys */
1019 if ((ret = aiptek_command(aiptek, 0x11, 0x02)) < 0)
1020 return ret;
1021#if 0
1022 /* Execute FilterOn */
1023 if ((ret = aiptek_command(aiptek, 0x17, 0x00)) < 0)
1024 return ret;
1025#endif
1026
1027 /* Execute AutoGainOn */
1028 if ((ret = aiptek_command(aiptek, 0x12, 0xff)) < 0)
1029 return ret;
1030
1031 /* Reset the eventCount, so we track events from last (re)programming
1032 */
1033 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_NA;
1034 aiptek->eventCount = 0;
1035
1036 return 0;
1037}
1038
1039/***********************************************************************
1040 * Sysfs functions. Sysfs prefers that individually-tunable parameters
1041 * exist in their separate pseudo-files. Summary data that is immutable
1042 * may exist in a singular file so long as you don't define a writeable
1043 * interface.
1044 */
1045
1046/***********************************************************************
1047 * support the 'size' file -- display support
1048 */
Yani Ioannou060b8842005-05-17 06:44:04 -04001049static ssize_t show_tabletSize(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050{
1051 struct aiptek *aiptek = dev_get_drvdata(dev);
1052
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 return snprintf(buf, PAGE_SIZE, "%dx%d\n",
Daniel Mack987a6c02010-08-02 20:15:17 -07001054 input_abs_get_max(aiptek->inputdev, ABS_X) + 1,
1055 input_abs_get_max(aiptek->inputdev, ABS_Y) + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056}
1057
1058/* These structs define the sysfs files, param #1 is the name of the
1059 * file, param 2 is the file permissions, param 3 & 4 are to the
1060 * output generator and input parser routines. Absence of a routine is
1061 * permitted -- it only means can't either 'cat' the file, or send data
1062 * to it.
1063 */
1064static DEVICE_ATTR(size, S_IRUGO, show_tabletSize, NULL);
1065
1066/***********************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 * support routines for the 'pointer_mode' file. Note that this file
1068 * both displays current setting and allows reprogramming.
1069 */
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001070static struct aiptek_map pointer_mode_map[] = {
1071 { "stylus", AIPTEK_POINTER_ONLY_STYLUS_MODE },
1072 { "mouse", AIPTEK_POINTER_ONLY_MOUSE_MODE },
1073 { "either", AIPTEK_POINTER_EITHER_MODE },
1074 { NULL, AIPTEK_INVALID_VALUE }
1075};
1076
Yani Ioannou060b8842005-05-17 06:44:04 -04001077static ssize_t show_tabletPointerMode(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078{
1079 struct aiptek *aiptek = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001081 return snprintf(buf, PAGE_SIZE, "%s\n",
1082 map_val_to_str(pointer_mode_map,
1083 aiptek->curSetting.pointerMode));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084}
1085
1086static ssize_t
Yani Ioannou060b8842005-05-17 06:44:04 -04001087store_tabletPointerMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088{
1089 struct aiptek *aiptek = dev_get_drvdata(dev);
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001090 int new_mode = map_str_to_val(pointer_mode_map, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001092 if (new_mode == AIPTEK_INVALID_VALUE)
1093 return -EINVAL;
1094
1095 aiptek->newSetting.pointerMode = new_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 return count;
1097}
1098
1099static DEVICE_ATTR(pointer_mode,
Dmitry Torokhov6f07d312010-11-15 13:33:25 -08001100 S_IRUGO | S_IWUSR,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 show_tabletPointerMode, store_tabletPointerMode);
1102
1103/***********************************************************************
1104 * support routines for the 'coordinate_mode' file. Note that this file
1105 * both displays current setting and allows reprogramming.
1106 */
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001107
1108static struct aiptek_map coordinate_mode_map[] = {
1109 { "absolute", AIPTEK_COORDINATE_ABSOLUTE_MODE },
1110 { "relative", AIPTEK_COORDINATE_RELATIVE_MODE },
1111 { NULL, AIPTEK_INVALID_VALUE }
1112};
1113
Yani Ioannou060b8842005-05-17 06:44:04 -04001114static ssize_t show_tabletCoordinateMode(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115{
1116 struct aiptek *aiptek = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001118 return snprintf(buf, PAGE_SIZE, "%s\n",
1119 map_val_to_str(coordinate_mode_map,
1120 aiptek->curSetting.coordinateMode));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121}
1122
1123static ssize_t
Yani Ioannou060b8842005-05-17 06:44:04 -04001124store_tabletCoordinateMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125{
1126 struct aiptek *aiptek = dev_get_drvdata(dev);
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001127 int new_mode = map_str_to_val(coordinate_mode_map, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001129 if (new_mode == AIPTEK_INVALID_VALUE)
1130 return -EINVAL;
1131
1132 aiptek->newSetting.coordinateMode = new_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 return count;
1134}
1135
1136static DEVICE_ATTR(coordinate_mode,
Dmitry Torokhov6f07d312010-11-15 13:33:25 -08001137 S_IRUGO | S_IWUSR,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 show_tabletCoordinateMode, store_tabletCoordinateMode);
1139
1140/***********************************************************************
1141 * support routines for the 'tool_mode' file. Note that this file
1142 * both displays current setting and allows reprogramming.
1143 */
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001144
1145static struct aiptek_map tool_mode_map[] = {
1146 { "mouse", AIPTEK_TOOL_BUTTON_MOUSE_MODE },
1147 { "eraser", AIPTEK_TOOL_BUTTON_ERASER_MODE },
1148 { "pencil", AIPTEK_TOOL_BUTTON_PENCIL_MODE },
1149 { "pen", AIPTEK_TOOL_BUTTON_PEN_MODE },
1150 { "brush", AIPTEK_TOOL_BUTTON_BRUSH_MODE },
1151 { "airbrush", AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE },
1152 { "lens", AIPTEK_TOOL_BUTTON_LENS_MODE },
1153 { NULL, AIPTEK_INVALID_VALUE }
1154};
1155
Yani Ioannou060b8842005-05-17 06:44:04 -04001156static ssize_t show_tabletToolMode(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157{
1158 struct aiptek *aiptek = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001160 return snprintf(buf, PAGE_SIZE, "%s\n",
1161 map_val_to_str(tool_mode_map,
1162 aiptek->curSetting.toolMode));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163}
1164
1165static ssize_t
Yani Ioannou060b8842005-05-17 06:44:04 -04001166store_tabletToolMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167{
1168 struct aiptek *aiptek = dev_get_drvdata(dev);
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001169 int new_mode = map_str_to_val(tool_mode_map, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001171 if (new_mode == AIPTEK_INVALID_VALUE)
1172 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001174 aiptek->newSetting.toolMode = new_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175 return count;
1176}
1177
1178static DEVICE_ATTR(tool_mode,
Dmitry Torokhov6f07d312010-11-15 13:33:25 -08001179 S_IRUGO | S_IWUSR,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 show_tabletToolMode, store_tabletToolMode);
1181
1182/***********************************************************************
1183 * support routines for the 'xtilt' file. Note that this file
1184 * both displays current setting and allows reprogramming.
1185 */
Yani Ioannou060b8842005-05-17 06:44:04 -04001186static ssize_t show_tabletXtilt(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187{
1188 struct aiptek *aiptek = dev_get_drvdata(dev);
1189
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190 if (aiptek->curSetting.xTilt == AIPTEK_TILT_DISABLE) {
1191 return snprintf(buf, PAGE_SIZE, "disable\n");
1192 } else {
1193 return snprintf(buf, PAGE_SIZE, "%d\n",
1194 aiptek->curSetting.xTilt);
1195 }
1196}
1197
1198static ssize_t
Yani Ioannou060b8842005-05-17 06:44:04 -04001199store_tabletXtilt(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200{
1201 struct aiptek *aiptek = dev_get_drvdata(dev);
Joe Rouvier160f1fe2008-08-10 00:29:25 -04001202 long x;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203
Joe Rouvier160f1fe2008-08-10 00:29:25 -04001204 if (strict_strtol(buf, 10, &x)) {
1205 size_t len = buf[count - 1] == '\n' ? count - 1 : count;
1206
1207 if (strncmp(buf, "disable", len))
1208 return -EINVAL;
1209
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 aiptek->newSetting.xTilt = AIPTEK_TILT_DISABLE;
1211 } else {
Joe Rouvier160f1fe2008-08-10 00:29:25 -04001212 if (x < AIPTEK_TILT_MIN || x > AIPTEK_TILT_MAX)
1213 return -EINVAL;
1214
1215 aiptek->newSetting.xTilt = x;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 }
Joe Rouvier160f1fe2008-08-10 00:29:25 -04001217
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 return count;
1219}
1220
1221static DEVICE_ATTR(xtilt,
Dmitry Torokhov6f07d312010-11-15 13:33:25 -08001222 S_IRUGO | S_IWUSR, show_tabletXtilt, store_tabletXtilt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223
1224/***********************************************************************
1225 * support routines for the 'ytilt' file. Note that this file
1226 * both displays current setting and allows reprogramming.
1227 */
Yani Ioannou060b8842005-05-17 06:44:04 -04001228static ssize_t show_tabletYtilt(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229{
1230 struct aiptek *aiptek = dev_get_drvdata(dev);
1231
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 if (aiptek->curSetting.yTilt == AIPTEK_TILT_DISABLE) {
1233 return snprintf(buf, PAGE_SIZE, "disable\n");
1234 } else {
1235 return snprintf(buf, PAGE_SIZE, "%d\n",
1236 aiptek->curSetting.yTilt);
1237 }
1238}
1239
1240static ssize_t
Yani Ioannou060b8842005-05-17 06:44:04 -04001241store_tabletYtilt(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242{
1243 struct aiptek *aiptek = dev_get_drvdata(dev);
Joe Rouvier160f1fe2008-08-10 00:29:25 -04001244 long y;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245
Joe Rouvier160f1fe2008-08-10 00:29:25 -04001246 if (strict_strtol(buf, 10, &y)) {
1247 size_t len = buf[count - 1] == '\n' ? count - 1 : count;
1248
1249 if (strncmp(buf, "disable", len))
1250 return -EINVAL;
1251
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 aiptek->newSetting.yTilt = AIPTEK_TILT_DISABLE;
1253 } else {
Joe Rouvier160f1fe2008-08-10 00:29:25 -04001254 if (y < AIPTEK_TILT_MIN || y > AIPTEK_TILT_MAX)
1255 return -EINVAL;
1256
1257 aiptek->newSetting.yTilt = y;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 }
Joe Rouvier160f1fe2008-08-10 00:29:25 -04001259
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 return count;
1261}
1262
1263static DEVICE_ATTR(ytilt,
Dmitry Torokhov6f07d312010-11-15 13:33:25 -08001264 S_IRUGO | S_IWUSR, show_tabletYtilt, store_tabletYtilt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265
1266/***********************************************************************
1267 * support routines for the 'jitter' file. Note that this file
1268 * both displays current setting and allows reprogramming.
1269 */
Yani Ioannou060b8842005-05-17 06:44:04 -04001270static ssize_t show_tabletJitterDelay(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271{
1272 struct aiptek *aiptek = dev_get_drvdata(dev);
1273
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 return snprintf(buf, PAGE_SIZE, "%d\n", aiptek->curSetting.jitterDelay);
1275}
1276
1277static ssize_t
Yani Ioannou060b8842005-05-17 06:44:04 -04001278store_tabletJitterDelay(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279{
1280 struct aiptek *aiptek = dev_get_drvdata(dev);
Joe Rouvier160f1fe2008-08-10 00:29:25 -04001281 long j;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
Joe Rouvier160f1fe2008-08-10 00:29:25 -04001283 if (strict_strtol(buf, 10, &j))
1284 return -EINVAL;
1285
1286 aiptek->newSetting.jitterDelay = (int)j;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287 return count;
1288}
1289
1290static DEVICE_ATTR(jitter,
Dmitry Torokhov6f07d312010-11-15 13:33:25 -08001291 S_IRUGO | S_IWUSR,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 show_tabletJitterDelay, store_tabletJitterDelay);
1293
1294/***********************************************************************
1295 * support routines for the 'delay' file. Note that this file
1296 * both displays current setting and allows reprogramming.
1297 */
Yani Ioannou060b8842005-05-17 06:44:04 -04001298static ssize_t show_tabletProgrammableDelay(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299{
1300 struct aiptek *aiptek = dev_get_drvdata(dev);
1301
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 return snprintf(buf, PAGE_SIZE, "%d\n",
1303 aiptek->curSetting.programmableDelay);
1304}
1305
1306static ssize_t
Yani Ioannou060b8842005-05-17 06:44:04 -04001307store_tabletProgrammableDelay(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308{
1309 struct aiptek *aiptek = dev_get_drvdata(dev);
Joe Rouvier160f1fe2008-08-10 00:29:25 -04001310 long d;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311
Joe Rouvier160f1fe2008-08-10 00:29:25 -04001312 if (strict_strtol(buf, 10, &d))
1313 return -EINVAL;
1314
1315 aiptek->newSetting.programmableDelay = (int)d;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 return count;
1317}
1318
1319static DEVICE_ATTR(delay,
Dmitry Torokhov6f07d312010-11-15 13:33:25 -08001320 S_IRUGO | S_IWUSR,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 show_tabletProgrammableDelay, store_tabletProgrammableDelay);
1322
1323/***********************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 * support routines for the 'event_count' file. Note that this file
1325 * only displays current setting.
1326 */
Yani Ioannou060b8842005-05-17 06:44:04 -04001327static ssize_t show_tabletEventsReceived(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328{
1329 struct aiptek *aiptek = dev_get_drvdata(dev);
1330
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 return snprintf(buf, PAGE_SIZE, "%ld\n", aiptek->eventCount);
1332}
1333
1334static DEVICE_ATTR(event_count, S_IRUGO, show_tabletEventsReceived, NULL);
1335
1336/***********************************************************************
1337 * support routines for the 'diagnostic' file. Note that this file
1338 * only displays current setting.
1339 */
Yani Ioannou060b8842005-05-17 06:44:04 -04001340static ssize_t show_tabletDiagnosticMessage(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341{
1342 struct aiptek *aiptek = dev_get_drvdata(dev);
1343 char *retMsg;
1344
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 switch (aiptek->diagnostic) {
1346 case AIPTEK_DIAGNOSTIC_NA:
1347 retMsg = "no errors\n";
1348 break;
1349
1350 case AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE:
1351 retMsg = "Error: receiving relative reports\n";
1352 break;
1353
1354 case AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE:
1355 retMsg = "Error: receiving absolute reports\n";
1356 break;
1357
1358 case AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED:
1359 if (aiptek->curSetting.pointerMode ==
1360 AIPTEK_POINTER_ONLY_MOUSE_MODE) {
1361 retMsg = "Error: receiving stylus reports\n";
1362 } else {
1363 retMsg = "Error: receiving mouse reports\n";
1364 }
1365 break;
1366
1367 default:
1368 return 0;
1369 }
1370 return snprintf(buf, PAGE_SIZE, retMsg);
1371}
1372
1373static DEVICE_ATTR(diagnostic, S_IRUGO, show_tabletDiagnosticMessage, NULL);
1374
1375/***********************************************************************
1376 * support routines for the 'stylus_upper' file. Note that this file
1377 * both displays current setting and allows for setting changing.
1378 */
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001379
1380static struct aiptek_map stylus_button_map[] = {
1381 { "upper", AIPTEK_STYLUS_UPPER_BUTTON },
1382 { "lower", AIPTEK_STYLUS_LOWER_BUTTON },
1383 { NULL, AIPTEK_INVALID_VALUE }
1384};
1385
Yani Ioannou060b8842005-05-17 06:44:04 -04001386static ssize_t show_tabletStylusUpper(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387{
1388 struct aiptek *aiptek = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001390 return snprintf(buf, PAGE_SIZE, "%s\n",
1391 map_val_to_str(stylus_button_map,
1392 aiptek->curSetting.stylusButtonUpper));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393}
1394
1395static ssize_t
Yani Ioannou060b8842005-05-17 06:44:04 -04001396store_tabletStylusUpper(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397{
1398 struct aiptek *aiptek = dev_get_drvdata(dev);
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001399 int new_button = map_str_to_val(stylus_button_map, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001401 if (new_button == AIPTEK_INVALID_VALUE)
1402 return -EINVAL;
1403
1404 aiptek->newSetting.stylusButtonUpper = new_button;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 return count;
1406}
1407
1408static DEVICE_ATTR(stylus_upper,
Dmitry Torokhov6f07d312010-11-15 13:33:25 -08001409 S_IRUGO | S_IWUSR,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 show_tabletStylusUpper, store_tabletStylusUpper);
1411
1412/***********************************************************************
1413 * support routines for the 'stylus_lower' file. Note that this file
1414 * both displays current setting and allows for setting changing.
1415 */
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001416
Yani Ioannou060b8842005-05-17 06:44:04 -04001417static ssize_t show_tabletStylusLower(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418{
1419 struct aiptek *aiptek = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001421 return snprintf(buf, PAGE_SIZE, "%s\n",
1422 map_val_to_str(stylus_button_map,
1423 aiptek->curSetting.stylusButtonLower));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424}
1425
1426static ssize_t
Yani Ioannou060b8842005-05-17 06:44:04 -04001427store_tabletStylusLower(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428{
1429 struct aiptek *aiptek = dev_get_drvdata(dev);
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001430 int new_button = map_str_to_val(stylus_button_map, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001432 if (new_button == AIPTEK_INVALID_VALUE)
1433 return -EINVAL;
1434
1435 aiptek->newSetting.stylusButtonLower = new_button;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 return count;
1437}
1438
1439static DEVICE_ATTR(stylus_lower,
Dmitry Torokhov6f07d312010-11-15 13:33:25 -08001440 S_IRUGO | S_IWUSR,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441 show_tabletStylusLower, store_tabletStylusLower);
1442
1443/***********************************************************************
1444 * support routines for the 'mouse_left' file. Note that this file
1445 * both displays current setting and allows for setting changing.
1446 */
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001447
1448static struct aiptek_map mouse_button_map[] = {
1449 { "left", AIPTEK_MOUSE_LEFT_BUTTON },
1450 { "middle", AIPTEK_MOUSE_MIDDLE_BUTTON },
1451 { "right", AIPTEK_MOUSE_RIGHT_BUTTON },
1452 { NULL, AIPTEK_INVALID_VALUE }
1453};
1454
Yani Ioannou060b8842005-05-17 06:44:04 -04001455static ssize_t show_tabletMouseLeft(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456{
1457 struct aiptek *aiptek = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001459 return snprintf(buf, PAGE_SIZE, "%s\n",
1460 map_val_to_str(mouse_button_map,
1461 aiptek->curSetting.mouseButtonLeft));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462}
1463
1464static ssize_t
Yani Ioannou060b8842005-05-17 06:44:04 -04001465store_tabletMouseLeft(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466{
1467 struct aiptek *aiptek = dev_get_drvdata(dev);
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001468 int new_button = map_str_to_val(mouse_button_map, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001470 if (new_button == AIPTEK_INVALID_VALUE)
1471 return -EINVAL;
1472
1473 aiptek->newSetting.mouseButtonLeft = new_button;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474 return count;
1475}
1476
1477static DEVICE_ATTR(mouse_left,
Dmitry Torokhov6f07d312010-11-15 13:33:25 -08001478 S_IRUGO | S_IWUSR,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 show_tabletMouseLeft, store_tabletMouseLeft);
1480
1481/***********************************************************************
1482 * support routines for the 'mouse_middle' file. Note that this file
1483 * both displays current setting and allows for setting changing.
1484 */
Yani Ioannou060b8842005-05-17 06:44:04 -04001485static ssize_t show_tabletMouseMiddle(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486{
1487 struct aiptek *aiptek = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001489 return snprintf(buf, PAGE_SIZE, "%s\n",
1490 map_val_to_str(mouse_button_map,
1491 aiptek->curSetting.mouseButtonMiddle));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492}
1493
1494static ssize_t
Yani Ioannou060b8842005-05-17 06:44:04 -04001495store_tabletMouseMiddle(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496{
1497 struct aiptek *aiptek = dev_get_drvdata(dev);
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001498 int new_button = map_str_to_val(mouse_button_map, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001500 if (new_button == AIPTEK_INVALID_VALUE)
1501 return -EINVAL;
1502
1503 aiptek->newSetting.mouseButtonMiddle = new_button;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 return count;
1505}
1506
1507static DEVICE_ATTR(mouse_middle,
Dmitry Torokhov6f07d312010-11-15 13:33:25 -08001508 S_IRUGO | S_IWUSR,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 show_tabletMouseMiddle, store_tabletMouseMiddle);
1510
1511/***********************************************************************
1512 * support routines for the 'mouse_right' file. Note that this file
1513 * both displays current setting and allows for setting changing.
1514 */
Yani Ioannou060b8842005-05-17 06:44:04 -04001515static ssize_t show_tabletMouseRight(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516{
1517 struct aiptek *aiptek = dev_get_drvdata(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001519 return snprintf(buf, PAGE_SIZE, "%s\n",
1520 map_val_to_str(mouse_button_map,
1521 aiptek->curSetting.mouseButtonRight));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522}
1523
1524static ssize_t
Yani Ioannou060b8842005-05-17 06:44:04 -04001525store_tabletMouseRight(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526{
1527 struct aiptek *aiptek = dev_get_drvdata(dev);
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001528 int new_button = map_str_to_val(mouse_button_map, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
Dmitry Torokhovcd438a52007-05-21 00:17:57 -04001530 if (new_button == AIPTEK_INVALID_VALUE)
1531 return -EINVAL;
1532
1533 aiptek->newSetting.mouseButtonRight = new_button;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 return count;
1535}
1536
1537static DEVICE_ATTR(mouse_right,
Dmitry Torokhov6f07d312010-11-15 13:33:25 -08001538 S_IRUGO | S_IWUSR,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539 show_tabletMouseRight, store_tabletMouseRight);
1540
1541/***********************************************************************
1542 * support routines for the 'wheel' file. Note that this file
1543 * both displays current setting and allows for setting changing.
1544 */
Yani Ioannou060b8842005-05-17 06:44:04 -04001545static ssize_t show_tabletWheel(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546{
1547 struct aiptek *aiptek = dev_get_drvdata(dev);
1548
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 if (aiptek->curSetting.wheel == AIPTEK_WHEEL_DISABLE) {
1550 return snprintf(buf, PAGE_SIZE, "disable\n");
1551 } else {
1552 return snprintf(buf, PAGE_SIZE, "%d\n",
1553 aiptek->curSetting.wheel);
1554 }
1555}
1556
1557static ssize_t
Yani Ioannou060b8842005-05-17 06:44:04 -04001558store_tabletWheel(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559{
1560 struct aiptek *aiptek = dev_get_drvdata(dev);
Joe Rouvier160f1fe2008-08-10 00:29:25 -04001561 long w;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562
Joe Rouvier160f1fe2008-08-10 00:29:25 -04001563 if (strict_strtol(buf, 10, &w)) return -EINVAL;
1564
1565 aiptek->newSetting.wheel = (int)w;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 return count;
1567}
1568
1569static DEVICE_ATTR(wheel,
Dmitry Torokhov6f07d312010-11-15 13:33:25 -08001570 S_IRUGO | S_IWUSR, show_tabletWheel, store_tabletWheel);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
1572/***********************************************************************
1573 * support routines for the 'execute' file. Note that this file
1574 * both displays current setting and allows for setting changing.
1575 */
Yani Ioannou060b8842005-05-17 06:44:04 -04001576static ssize_t show_tabletExecute(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 /* There is nothing useful to display, so a one-line manual
1579 * is in order...
1580 */
1581 return snprintf(buf, PAGE_SIZE,
1582 "Write anything to this file to program your tablet.\n");
1583}
1584
1585static ssize_t
Yani Ioannou060b8842005-05-17 06:44:04 -04001586store_tabletExecute(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587{
1588 struct aiptek *aiptek = dev_get_drvdata(dev);
1589
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 /* We do not care what you write to this file. Merely the action
1591 * of writing to this file triggers a tablet reprogramming.
1592 */
1593 memcpy(&aiptek->curSetting, &aiptek->newSetting,
1594 sizeof(struct aiptek_settings));
1595
1596 if (aiptek_program_tablet(aiptek) < 0)
1597 return -EIO;
1598
1599 return count;
1600}
1601
1602static DEVICE_ATTR(execute,
Dmitry Torokhov6f07d312010-11-15 13:33:25 -08001603 S_IRUGO | S_IWUSR, show_tabletExecute, store_tabletExecute);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604
1605/***********************************************************************
1606 * support routines for the 'odm_code' file. Note that this file
1607 * only displays current setting.
1608 */
Yani Ioannou060b8842005-05-17 06:44:04 -04001609static ssize_t show_tabletODMCode(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610{
1611 struct aiptek *aiptek = dev_get_drvdata(dev);
1612
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->features.odmCode);
1614}
1615
1616static DEVICE_ATTR(odm_code, S_IRUGO, show_tabletODMCode, NULL);
1617
1618/***********************************************************************
1619 * support routines for the 'model_code' file. Note that this file
1620 * only displays current setting.
1621 */
Yani Ioannou060b8842005-05-17 06:44:04 -04001622static ssize_t show_tabletModelCode(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623{
1624 struct aiptek *aiptek = dev_get_drvdata(dev);
1625
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->features.modelCode);
1627}
1628
1629static DEVICE_ATTR(model_code, S_IRUGO, show_tabletModelCode, NULL);
1630
1631/***********************************************************************
1632 * support routines for the 'firmware_code' file. Note that this file
1633 * only displays current setting.
1634 */
Yani Ioannou060b8842005-05-17 06:44:04 -04001635static ssize_t show_firmwareCode(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636{
1637 struct aiptek *aiptek = dev_get_drvdata(dev);
1638
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 return snprintf(buf, PAGE_SIZE, "%04x\n",
1640 aiptek->features.firmwareCode);
1641}
1642
1643static DEVICE_ATTR(firmware_code, S_IRUGO, show_firmwareCode, NULL);
1644
Dmitry Torokhovb087e1f2007-05-21 00:17:37 -04001645static struct attribute *aiptek_attributes[] = {
1646 &dev_attr_size.attr,
1647 &dev_attr_pointer_mode.attr,
1648 &dev_attr_coordinate_mode.attr,
1649 &dev_attr_tool_mode.attr,
1650 &dev_attr_xtilt.attr,
1651 &dev_attr_ytilt.attr,
1652 &dev_attr_jitter.attr,
1653 &dev_attr_delay.attr,
1654 &dev_attr_event_count.attr,
1655 &dev_attr_diagnostic.attr,
1656 &dev_attr_odm_code.attr,
1657 &dev_attr_model_code.attr,
1658 &dev_attr_firmware_code.attr,
1659 &dev_attr_stylus_lower.attr,
1660 &dev_attr_stylus_upper.attr,
1661 &dev_attr_mouse_left.attr,
1662 &dev_attr_mouse_middle.attr,
1663 &dev_attr_mouse_right.attr,
1664 &dev_attr_wheel.attr,
1665 &dev_attr_execute.attr,
1666 NULL
1667};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668
Dmitry Torokhovb087e1f2007-05-21 00:17:37 -04001669static struct attribute_group aiptek_attribute_group = {
1670 .attrs = aiptek_attributes,
1671};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672
1673/***********************************************************************
1674 * This routine is called when a tablet has been identified. It basically
1675 * sets up the tablet and the driver's internal structures.
1676 */
1677static int
1678aiptek_probe(struct usb_interface *intf, const struct usb_device_id *id)
1679{
1680 struct usb_device *usbdev = interface_to_usbdev(intf);
1681 struct usb_endpoint_descriptor *endpoint;
1682 struct aiptek *aiptek;
1683 struct input_dev *inputdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684 int i;
1685 int speeds[] = { 0,
1686 AIPTEK_PROGRAMMABLE_DELAY_50,
1687 AIPTEK_PROGRAMMABLE_DELAY_400,
1688 AIPTEK_PROGRAMMABLE_DELAY_25,
1689 AIPTEK_PROGRAMMABLE_DELAY_100,
1690 AIPTEK_PROGRAMMABLE_DELAY_200,
1691 AIPTEK_PROGRAMMABLE_DELAY_300
1692 };
Dmitry Torokhov50141862007-04-12 01:33:39 -04001693 int err = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694
1695 /* programmableDelay is where the command-line specified
1696 * delay is kept. We make it the first element of speeds[],
1697 * so therefore, your override speed is tried first, then the
1698 * remainder. Note that the default value of 400ms will be tried
1699 * if you do not specify any command line parameter.
1700 */
1701 speeds[0] = programmableDelay;
1702
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001703 aiptek = kzalloc(sizeof(struct aiptek), GFP_KERNEL);
1704 inputdev = input_allocate_device();
Rene van Paassen6125a402007-05-21 00:31:59 -04001705 if (!aiptek || !inputdev) {
Greg Kroah-Hartman1817b162008-08-14 09:37:34 -07001706 dev_warn(&intf->dev,
1707 "cannot allocate memory or input device\n");
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001708 goto fail1;
Rene van Paassen6125a402007-05-21 00:31:59 -04001709 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
Daniel Mack997ea582010-04-12 13:17:25 +02001711 aiptek->data = usb_alloc_coherent(usbdev, AIPTEK_PACKET_LENGTH,
1712 GFP_ATOMIC, &aiptek->data_dma);
Rene van Paassen6125a402007-05-21 00:31:59 -04001713 if (!aiptek->data) {
Greg Kroah-Hartman1817b162008-08-14 09:37:34 -07001714 dev_warn(&intf->dev, "cannot allocate usb buffer\n");
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001715 goto fail1;
Rene van Paassen6125a402007-05-21 00:31:59 -04001716 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717
1718 aiptek->urb = usb_alloc_urb(0, GFP_KERNEL);
Rene van Paassen6125a402007-05-21 00:31:59 -04001719 if (!aiptek->urb) {
Greg Kroah-Hartman1817b162008-08-14 09:37:34 -07001720 dev_warn(&intf->dev, "cannot allocate urb\n");
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001721 goto fail2;
Rene van Paassen6125a402007-05-21 00:31:59 -04001722 }
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001723
1724 aiptek->inputdev = inputdev;
1725 aiptek->usbdev = usbdev;
1726 aiptek->ifnum = intf->altsetting[0].desc.bInterfaceNumber;
1727 aiptek->inDelay = 0;
1728 aiptek->endDelay = 0;
1729 aiptek->previousJitterable = 0;
Rene van Paassen1e7b3fa2007-05-21 00:32:17 -04001730 aiptek->lastMacro = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731
1732 /* Set up the curSettings struct. Said struct contains the current
1733 * programmable parameters. The newSetting struct contains changes
1734 * the user makes to the settings via the sysfs interface. Those
1735 * changes are not "committed" to curSettings until the user
1736 * writes to the sysfs/.../execute file.
1737 */
1738 aiptek->curSetting.pointerMode = AIPTEK_POINTER_EITHER_MODE;
1739 aiptek->curSetting.coordinateMode = AIPTEK_COORDINATE_ABSOLUTE_MODE;
1740 aiptek->curSetting.toolMode = AIPTEK_TOOL_BUTTON_PEN_MODE;
1741 aiptek->curSetting.xTilt = AIPTEK_TILT_DISABLE;
1742 aiptek->curSetting.yTilt = AIPTEK_TILT_DISABLE;
1743 aiptek->curSetting.mouseButtonLeft = AIPTEK_MOUSE_LEFT_BUTTON;
1744 aiptek->curSetting.mouseButtonMiddle = AIPTEK_MOUSE_MIDDLE_BUTTON;
1745 aiptek->curSetting.mouseButtonRight = AIPTEK_MOUSE_RIGHT_BUTTON;
1746 aiptek->curSetting.stylusButtonUpper = AIPTEK_STYLUS_UPPER_BUTTON;
1747 aiptek->curSetting.stylusButtonLower = AIPTEK_STYLUS_LOWER_BUTTON;
1748 aiptek->curSetting.jitterDelay = jitterDelay;
1749 aiptek->curSetting.programmableDelay = programmableDelay;
1750
1751 /* Both structs should have equivalent settings
1752 */
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001753 aiptek->newSetting = aiptek->curSetting;
1754
1755 /* Determine the usb devices' physical path.
1756 * Asketh not why we always pretend we're using "../input0",
1757 * but I suspect this will have to be refactored one
1758 * day if a single USB device can be a keyboard & a mouse
1759 * & a tablet, and the inputX number actually will tell
1760 * us something...
1761 */
1762 usb_make_path(usbdev, aiptek->features.usbPath,
1763 sizeof(aiptek->features.usbPath));
1764 strlcat(aiptek->features.usbPath, "/input0",
1765 sizeof(aiptek->features.usbPath));
1766
1767 /* Set up client data, pointers to open and close routines
1768 * for the input device.
1769 */
1770 inputdev->name = "Aiptek";
1771 inputdev->phys = aiptek->features.usbPath;
1772 usb_to_input_id(usbdev, &inputdev->id);
Dmitry Torokhovc0f82d52007-04-12 01:35:03 -04001773 inputdev->dev.parent = &intf->dev;
Dmitry Torokhov7791bda2007-04-12 01:34:39 -04001774
1775 input_set_drvdata(inputdev, aiptek);
1776
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001777 inputdev->open = aiptek_open;
1778 inputdev->close = aiptek_close;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779
1780 /* Now program the capacities of the tablet, in terms of being
1781 * an input device.
1782 */
Rene van Paassen1a54f492007-05-21 00:31:55 -04001783 for (i = 0; i < ARRAY_SIZE(eventTypes); ++i)
1784 __set_bit(eventTypes[i], inputdev->evbit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785
Rene van Paassen1a54f492007-05-21 00:31:55 -04001786 for (i = 0; i < ARRAY_SIZE(absEvents); ++i)
1787 __set_bit(absEvents[i], inputdev->absbit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788
Rene van Paassen1a54f492007-05-21 00:31:55 -04001789 for (i = 0; i < ARRAY_SIZE(relEvents); ++i)
1790 __set_bit(relEvents[i], inputdev->relbit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791
Rene van Paassen1a54f492007-05-21 00:31:55 -04001792 __set_bit(MSC_SERIAL, inputdev->mscbit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793
Dmitry Torokhov33936fa2007-05-21 00:18:15 -04001794 /* Set up key and button codes */
1795 for (i = 0; i < ARRAY_SIZE(buttonEvents); ++i)
1796 __set_bit(buttonEvents[i], inputdev->keybit);
1797
Tobias Klauser52950ed2005-12-11 16:20:08 +01001798 for (i = 0; i < ARRAY_SIZE(macroKeyEvents); ++i)
Dmitry Torokhov33936fa2007-05-21 00:18:15 -04001799 __set_bit(macroKeyEvents[i], inputdev->keybit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001801 /*
1802 * Program the input device coordinate capacities. We do not yet
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 * know what maximum X, Y, and Z values are, so we're putting fake
1804 * values in. Later, we'll ask the tablet to put in the correct
1805 * values.
1806 */
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001807 input_set_abs_params(inputdev, ABS_X, 0, 2999, 0, 0);
Riccardo Magliocchettif873e3e2005-12-28 20:44:48 -05001808 input_set_abs_params(inputdev, ABS_Y, 0, 2249, 0, 0);
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001809 input_set_abs_params(inputdev, ABS_PRESSURE, 0, 511, 0, 0);
1810 input_set_abs_params(inputdev, ABS_TILT_X, AIPTEK_TILT_MIN, AIPTEK_TILT_MAX, 0, 0);
1811 input_set_abs_params(inputdev, ABS_TILT_Y, AIPTEK_TILT_MIN, AIPTEK_TILT_MAX, 0, 0);
1812 input_set_abs_params(inputdev, ABS_WHEEL, AIPTEK_WHEEL_MIN, AIPTEK_WHEEL_MAX - 1, 0, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813
1814 endpoint = &intf->altsetting[0].endpoint[0].desc;
1815
1816 /* Go set up our URB, which is called when the tablet receives
1817 * input.
1818 */
1819 usb_fill_int_urb(aiptek->urb,
1820 aiptek->usbdev,
1821 usb_rcvintpipe(aiptek->usbdev,
1822 endpoint->bEndpointAddress),
1823 aiptek->data, 8, aiptek_irq, aiptek,
1824 endpoint->bInterval);
1825
1826 aiptek->urb->transfer_dma = aiptek->data_dma;
1827 aiptek->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1828
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 /* Program the tablet. This sets the tablet up in the mode
1830 * specified in newSetting, and also queries the tablet's
1831 * physical capacities.
1832 *
1833 * Sanity check: if a tablet doesn't like the slow programmatic
1834 * delay, we often get sizes of 0x0. Let's use that as an indicator
1835 * to try faster delays, up to 25 ms. If that logic fails, well, you'll
1836 * have to explain to us how your tablet thinks it's 0x0, and yet that's
1837 * not an error :-)
1838 */
1839
Tobias Klauser52950ed2005-12-11 16:20:08 +01001840 for (i = 0; i < ARRAY_SIZE(speeds); ++i) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 aiptek->curSetting.programmableDelay = speeds[i];
1842 (void)aiptek_program_tablet(aiptek);
Daniel Mack987a6c02010-08-02 20:15:17 -07001843 if (input_abs_get_max(aiptek->inputdev, ABS_X) > 0) {
Greg Kroah-Hartman899ef6e2008-08-18 13:21:04 -07001844 dev_info(&intf->dev,
1845 "Aiptek using %d ms programming speed\n",
1846 aiptek->curSetting.programmableDelay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 break;
1848 }
1849 }
1850
Rene van Paassen6125a402007-05-21 00:31:59 -04001851 /* Murphy says that some day someone will have a tablet that fails the
1852 above test. That's you, Frederic Rodrigo */
1853 if (i == ARRAY_SIZE(speeds)) {
Greg Kroah-Hartman899ef6e2008-08-18 13:21:04 -07001854 dev_info(&intf->dev,
1855 "Aiptek tried all speeds, no sane response\n");
Rene van Paassen6125a402007-05-21 00:31:59 -04001856 goto fail2;
1857 }
1858
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 /* Associate this driver's struct with the usb interface.
1860 */
1861 usb_set_intfdata(intf, aiptek);
1862
1863 /* Set up the sysfs files
1864 */
Dmitry Torokhovb087e1f2007-05-21 00:17:37 -04001865 err = sysfs_create_group(&intf->dev.kobj, &aiptek_attribute_group);
Rene van Paassen6125a402007-05-21 00:31:59 -04001866 if (err) {
Greg Kroah-Hartman1817b162008-08-14 09:37:34 -07001867 dev_warn(&intf->dev, "cannot create sysfs group err: %d\n",
1868 err);
Dmitry Torokhovb087e1f2007-05-21 00:17:37 -04001869 goto fail3;
Rene van Paassen6125a402007-05-21 00:31:59 -04001870 }
Dmitry Torokhovb087e1f2007-05-21 00:17:37 -04001871
1872 /* Register the tablet as an Input Device
1873 */
1874 err = input_register_device(aiptek->inputdev);
Rene van Paassen6125a402007-05-21 00:31:59 -04001875 if (err) {
Greg Kroah-Hartman1817b162008-08-14 09:37:34 -07001876 dev_warn(&intf->dev,
1877 "input_register_device returned err: %d\n", err);
Dmitry Torokhovb087e1f2007-05-21 00:17:37 -04001878 goto fail4;
Rene van Paassen6125a402007-05-21 00:31:59 -04001879 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880 return 0;
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001881
Dmitry Torokhovb087e1f2007-05-21 00:17:37 -04001882 fail4: sysfs_remove_group(&intf->dev.kobj, &aiptek_attribute_group);
1883 fail3: usb_free_urb(aiptek->urb);
Daniel Mack997ea582010-04-12 13:17:25 +02001884 fail2: usb_free_coherent(usbdev, AIPTEK_PACKET_LENGTH, aiptek->data,
1885 aiptek->data_dma);
Dmitry Torokhovb087e1f2007-05-21 00:17:37 -04001886 fail1: usb_set_intfdata(intf, NULL);
1887 input_free_device(inputdev);
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001888 kfree(aiptek);
Dmitry Torokhov50141862007-04-12 01:33:39 -04001889 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890}
1891
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892/***********************************************************************
1893 * Deal with tablet disconnecting from the system.
1894 */
1895static void aiptek_disconnect(struct usb_interface *intf)
1896{
1897 struct aiptek *aiptek = usb_get_intfdata(intf);
1898
1899 /* Disassociate driver's struct with usb interface
1900 */
1901 usb_set_intfdata(intf, NULL);
1902 if (aiptek != NULL) {
1903 /* Free & unhook everything from the system.
1904 */
1905 usb_kill_urb(aiptek->urb);
Dmitry Torokhovc5b7c7c2005-09-15 02:01:47 -05001906 input_unregister_device(aiptek->inputdev);
Dmitry Torokhovb087e1f2007-05-21 00:17:37 -04001907 sysfs_remove_group(&intf->dev.kobj, &aiptek_attribute_group);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 usb_free_urb(aiptek->urb);
Daniel Mack997ea582010-04-12 13:17:25 +02001909 usb_free_coherent(interface_to_usbdev(intf),
1910 AIPTEK_PACKET_LENGTH,
1911 aiptek->data, aiptek->data_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 kfree(aiptek);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913 }
1914}
1915
Dmitry Torokhov50141862007-04-12 01:33:39 -04001916static struct usb_driver aiptek_driver = {
1917 .name = "aiptek",
1918 .probe = aiptek_probe,
1919 .disconnect = aiptek_disconnect,
1920 .id_table = aiptek_ids,
1921};
1922
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923static int __init aiptek_init(void)
1924{
1925 int result = usb_register(&aiptek_driver);
1926 if (result == 0) {
Greg Kroah-Hartman899ef6e2008-08-18 13:21:04 -07001927 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1928 DRIVER_DESC "\n");
1929 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_AUTHOR "\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 }
1931 return result;
1932}
1933
1934static void __exit aiptek_exit(void)
1935{
1936 usb_deregister(&aiptek_driver);
1937}
1938
1939MODULE_AUTHOR(DRIVER_AUTHOR);
1940MODULE_DESCRIPTION(DRIVER_DESC);
1941MODULE_LICENSE("GPL");
1942
1943module_param(programmableDelay, int, 0);
1944MODULE_PARM_DESC(programmableDelay, "delay used during tablet programming");
1945module_param(jitterDelay, int, 0);
1946MODULE_PARM_DESC(jitterDelay, "stylus/mouse settlement delay");
1947
1948module_init(aiptek_init);
1949module_exit(aiptek_exit);