err.no Git - linux-2.6/blob - drivers/input/tablet/aiptek.c

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