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 TOOL_BUTTON_FIRED_BIT is
 222          * not set, we'll send one instance of AIPTEK_TOOL_BUTTON_xxx.
 223          *
 224          * Whenever the user resets the value, TOOL_BUTTON_FIRED_BIT will
 225          * get reset.
 226          */
 227 #define TOOL_BUTTON(x)                                  ((x) & 0x14f)
 228 #define TOOL_BUTTON_FIRED(x)                            ((x) & 0x200)
 229 #define TOOL_BUTTON_FIRED_BIT                           0x200
 230         /* toolMode codes
 231          */
 232 #define AIPTEK_TOOL_BUTTON_PEN_MODE                     BTN_TOOL_PEN
 233 #define AIPTEK_TOOL_BUTTON_PEN_MODE                     BTN_TOOL_PEN
 234 #define AIPTEK_TOOL_BUTTON_PENCIL_MODE                  BTN_TOOL_PENCIL
 235 #define AIPTEK_TOOL_BUTTON_BRUSH_MODE                   BTN_TOOL_BRUSH
 236 #define AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE                BTN_TOOL_AIRBRUSH
 237 #define AIPTEK_TOOL_BUTTON_ERASER_MODE                  BTN_TOOL_RUBBER
 238 #define AIPTEK_TOOL_BUTTON_MOUSE_MODE                   BTN_TOOL_MOUSE
 239 #define AIPTEK_TOOL_BUTTON_LENS_MODE                    BTN_TOOL_LENS
 240
 241         /* Diagnostic message codes
 242          */
 243 #define AIPTEK_DIAGNOSTIC_NA                            0
 244 #define AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE  1
 245 #define AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE  2
 246 #define AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED               3
 247
 248         /* Time to wait (in ms) to help mask hand jittering
 249          * when pressing the stylus buttons.
 250          */
 251 #define AIPTEK_JITTER_DELAY_DEFAULT                     50
 252
 253         /* Time to wait (in ms) in-between sending the tablet
 254          * a command and beginning the process of reading the return
 255          * sequence from the tablet.
 256          */
 257 #define AIPTEK_PROGRAMMABLE_DELAY_25            25
 258 #define AIPTEK_PROGRAMMABLE_DELAY_50            50
 259 #define AIPTEK_PROGRAMMABLE_DELAY_100           100
 260 #define AIPTEK_PROGRAMMABLE_DELAY_200           200
 261 #define AIPTEK_PROGRAMMABLE_DELAY_300           300
 262 #define AIPTEK_PROGRAMMABLE_DELAY_400           400
 263 #define AIPTEK_PROGRAMMABLE_DELAY_DEFAULT       AIPTEK_PROGRAMMABLE_DELAY_400
 264
 265         /* Mouse button programming
 266          */
 267 #define AIPTEK_MOUSE_LEFT_BUTTON                0x04
 268 #define AIPTEK_MOUSE_RIGHT_BUTTON               0x08
 269 #define AIPTEK_MOUSE_MIDDLE_BUTTON              0x10
 270
 271         /* Stylus button programming
 272          */
 273 #define AIPTEK_STYLUS_LOWER_BUTTON              0x08
 274 #define AIPTEK_STYLUS_UPPER_BUTTON              0x10
 275
 276         /* Length of incoming packet from the tablet
 277          */
 278 #define AIPTEK_PACKET_LENGTH                    8
 279
 280         /* We report in EV_MISC both the proximity and
 281          * whether the report came from the stylus, tablet mouse
 282          * or "unknown" -- Unknown when the tablet is in relative
 283          * mode, because we only get report 1's.
 284          */
 285 #define AIPTEK_REPORT_TOOL_UNKNOWN              0x10
 286 #define AIPTEK_REPORT_TOOL_STYLUS               0x20
 287 #define AIPTEK_REPORT_TOOL_MOUSE                0x40
 288
 289 static int programmableDelay = AIPTEK_PROGRAMMABLE_DELAY_DEFAULT;
 290 static int jitterDelay = AIPTEK_JITTER_DELAY_DEFAULT;
 291
 292 struct aiptek_features {
 293         int odmCode;            /* Tablet manufacturer code       */
 294         int modelCode;          /* Tablet model code (not unique) */
 295         int firmwareCode;       /* prom/eeprom version            */
 296         char usbPath[64 + 1];   /* device's physical usb path     */
 297 };
 298
 299 struct aiptek_settings {
 300         int pointerMode;        /* stylus-, mouse-only or either */
 301         int coordinateMode;     /* absolute/relative coords      */
 302         int toolMode;           /* pen, pencil, brush, etc. tool */
 303         int xTilt;              /* synthetic xTilt amount        */
 304         int yTilt;              /* synthetic yTilt amount        */
 305         int wheel;              /* synthetic wheel amount        */
 306         int stylusButtonUpper;  /* stylus upper btn delivers...  */
 307         int stylusButtonLower;  /* stylus lower btn delivers...  */
 308         int mouseButtonLeft;    /* mouse left btn delivers...    */
 309         int mouseButtonMiddle;  /* mouse middle btn delivers...  */
 310         int mouseButtonRight;   /* mouse right btn delivers...   */
 311         int programmableDelay;  /* delay for tablet programming  */
 312         int jitterDelay;        /* delay for hand jittering      */
 313 };
 314
 315 struct aiptek {
 316         struct input_dev *inputdev;             /* input device struct           */
 317         struct usb_device *usbdev;              /* usb device struct             */
 318         struct urb *urb;                        /* urb for incoming reports      */
 319         dma_addr_t data_dma;                    /* our dma stuffage              */
 320         struct aiptek_features features;        /* tablet's array of features    */
 321         struct aiptek_settings curSetting;      /* tablet's current programmable */
 322         struct aiptek_settings newSetting;      /* ... and new param settings    */
 323         unsigned int ifnum;                     /* interface number for IO       */
 324         int diagnostic;                         /* tablet diagnostic codes       */
 325         unsigned long eventCount;               /* event count                   */
 326         int inDelay;                            /* jitter: in jitter delay?      */
 327         unsigned long endDelay;                 /* jitter: time when delay ends  */
 328         int previousJitterable;                 /* jitterable prev value     */
 329         unsigned char *data;                    /* incoming packet data          */
 330 };
 331
 332 static const int eventTypes[] = {
 333         EV_KEY, EV_ABS, EV_REL, EV_MSC,
 334 };
 335
 336 static const int absEvents[] = {
 337         ABS_X, ABS_Y, ABS_PRESSURE, ABS_TILT_X, ABS_TILT_Y,
 338         ABS_WHEEL, ABS_MISC,
 339 };
 340
 341 static const int relEvents[] = {
 342         REL_X, REL_Y, REL_WHEEL,
 343 };
 344
 345 static const int buttonEvents[] = {
 346         BTN_LEFT, BTN_RIGHT, BTN_MIDDLE,
 347         BTN_TOOL_PEN, BTN_TOOL_RUBBER, BTN_TOOL_PENCIL, BTN_TOOL_AIRBRUSH,
 348         BTN_TOOL_BRUSH, BTN_TOOL_MOUSE, BTN_TOOL_LENS, BTN_TOUCH,
 349         BTN_STYLUS, BTN_STYLUS2,
 350 };
 351
 352 /*
 353  * Permit easy lookup of keyboard events to send, versus
 354  * the bitmap which comes from the tablet. This hides the
 355  * issue that the F_keys are not sequentially numbered.
 356  */
 357 static const int macroKeyEvents[] = {
 358         KEY_ESC, KEY_F1, KEY_F2, KEY_F3, KEY_F4, KEY_F5,
 359         KEY_F6, KEY_F7, KEY_F8, KEY_F9, KEY_F10, KEY_F11,
 360         KEY_F12, KEY_F13, KEY_F14, KEY_F15, KEY_F16, KEY_F17,
 361         KEY_F18, KEY_F19, KEY_F20, KEY_F21, KEY_F22, KEY_F23,
 362         KEY_F24, KEY_STOP, KEY_AGAIN, KEY_PROPS, KEY_UNDO,
 363         KEY_FRONT, KEY_COPY, KEY_OPEN, KEY_PASTE, 0
 364 };
 365
 366 /***********************************************************************
 367  * Map values to strings and back. Every map shoudl have the following
 368  * as its last element: { NULL, AIPTEK_INVALID_VALUE }.
 369  */
 370 #define AIPTEK_INVALID_VALUE    -1
 371
 372 struct aiptek_map {
 373         const char *string;
 374         int value;
 375 };
 376
 377 static int map_str_to_val(const struct aiptek_map *map, const char *str, size_t count)
 378 {
 379         const struct aiptek_map *p;
 380
 381         for (p = map; p->string; p++)
 382                 if (!strncmp(str, p->string, count))
 383                         return p->value;
 384
 385         return AIPTEK_INVALID_VALUE;
 386 }
 387
 388 static const char *map_val_to_str(const struct aiptek_map *map, int val)
 389 {
 390         const struct aiptek_map *p;
 391
 392         for (p = map; p->value != AIPTEK_INVALID_VALUE; p++)
 393                 if (val == p->value)
 394                         return p->string;
 395
 396         return "unknown";
 397 }
 398
 399 /***********************************************************************
 400  * aiptek_irq can receive one of six potential reports.
 401  * The documentation for each is in the body of the function.
 402  *
 403  * The tablet reports on several attributes per invocation of
 404  * aiptek_irq. Because the Linux Input Event system allows the
 405  * transmission of ONE attribute per input_report_xxx() call,
 406  * collation has to be done on the other end to reconstitute
 407  * a complete tablet report. Further, the number of Input Event reports
 408  * submitted varies, depending on what USB report type, and circumstance.
 409  * To deal with this, EV_MSC is used to indicate an 'end-of-report'
 410  * message. This has been an undocumented convention understood by the kernel
 411  * tablet driver and clients such as gpm and XFree86's tablet drivers.
 412  *
 413  * Of the information received from the tablet, the one piece I
 414  * cannot transmit is the proximity bit (without resorting to an EV_MSC
 415  * convention above.) I therefore have taken over REL_MISC and ABS_MISC
 416  * (for relative and absolute reports, respectively) for communicating
 417  * Proximity. Why two events? I thought it interesting to know if the
 418  * Proximity event occurred while the tablet was in absolute or relative
 419  * mode.
 420  *
 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 we've not already sent a tool_button_?? code, do
 543                                  * so now. Then set FIRED_BIT so it won't be resent unless
 544                                  * the user forces FIRED_BIT off.
 545                                  */
 546                                 if (TOOL_BUTTON_FIRED
 547                                     (aiptek->curSetting.toolMode) == 0) {
 548                                         input_report_key(inputdev,
 549                                                          TOOL_BUTTON(aiptek->curSetting.toolMode),
 550                                                          1);
 551                                         aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
 552                                 }
 553
 554                                 if (p != 0) {
 555                                         input_report_abs(inputdev, ABS_X, x);
 556                                         input_report_abs(inputdev, ABS_Y, y);
 557                                         input_report_abs(inputdev, ABS_PRESSURE, z);
 558
 559                                         input_report_key(inputdev, BTN_TOUCH, tip);
 560                                         input_report_key(inputdev, BTN_STYLUS, bs);
 561                                         input_report_key(inputdev, BTN_STYLUS2, pck);
 562
 563                                         if (aiptek->curSetting.xTilt !=
 564                                             AIPTEK_TILT_DISABLE) {
 565                                                 input_report_abs(inputdev,
 566                                                                  ABS_TILT_X,
 567                                                                  aiptek->curSetting.xTilt);
 568                                         }
 569                                         if (aiptek->curSetting.yTilt != AIPTEK_TILT_DISABLE) {
 570                                                 input_report_abs(inputdev,
 571                                                                  ABS_TILT_Y,
 572                                                                  aiptek->curSetting.yTilt);
 573                                         }
 574
 575                                         /* Wheel support is in the form of a single-event
 576                                          * firing.
 577                                          */
 578                                         if (aiptek->curSetting.wheel !=
 579                                             AIPTEK_WHEEL_DISABLE) {
 580                                                 input_report_abs(inputdev,
 581                                                                  ABS_WHEEL,
 582                                                                  aiptek->curSetting.wheel);
 583                                                 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
 584                                         }
 585                                 }
 586                                 input_report_abs(inputdev, ABS_MISC, p | AIPTEK_REPORT_TOOL_STYLUS);
 587                                 input_sync(inputdev);
 588                         }
 589                 }
 590         }
 591         /* Report 3's come from the mouse in absolute mode.
 592          */
 593         else if (data[0] == 3) {
 594                 if (aiptek->curSetting.coordinateMode == AIPTEK_COORDINATE_RELATIVE_MODE) {
 595                         aiptek->diagnostic = AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE;
 596                 } else if (!AIPTEK_POINTER_ALLOW_MOUSE_MODE
 597                         (aiptek->curSetting.pointerMode)) {
 598                         aiptek->diagnostic = AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED;
 599                 } else {
 600                         x = le16_to_cpu(get_unaligned((__le16 *) (data + 1)));
 601                         y = le16_to_cpu(get_unaligned((__le16 *) (data + 3)));
 602
 603                         jitterable = data[5] & 0x1c;
 604
 605                         dv = (data[5] & 0x01) != 0 ? 1 : 0;
 606                         p = (data[5] & 0x02) != 0 ? 1 : 0;
 607                         left = (data[5] & aiptek->curSetting.mouseButtonLeft) != 0 ? 1 : 0;
 608                         right = (data[5] & aiptek->curSetting.mouseButtonRight) != 0 ? 1 : 0;
 609                         middle = (data[5] & aiptek->curSetting.mouseButtonMiddle) != 0 ? 1 : 0;
 610
 611                         if (dv != 0) {
 612                                 /* If we've not already sent a tool_button_?? code, do
 613                                  * so now. Then set FIRED_BIT so it won't be resent unless
 614                                  * the user forces FIRED_BIT off.
 615                                  */
 616                                 if (TOOL_BUTTON_FIRED
 617                                     (aiptek->curSetting.toolMode) == 0) {
 618                                         input_report_key(inputdev,
 619                                                          TOOL_BUTTON(aiptek->curSetting.toolMode),
 620                                                          1);
 621                                         aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
 622                                 }
 623
 624                                 if (p != 0) {
 625                                         input_report_abs(inputdev, ABS_X, x);
 626                                         input_report_abs(inputdev, ABS_Y, y);
 627
 628                                         input_report_key(inputdev, BTN_LEFT, left);
 629                                         input_report_key(inputdev, BTN_MIDDLE, middle);
 630                                         input_report_key(inputdev, BTN_RIGHT, right);
 631
 632                                         /* Wheel support is in the form of a single-event
 633                                          * firing.
 634                                          */
 635                                         if (aiptek->curSetting.wheel != AIPTEK_WHEEL_DISABLE) {
 636                                                 input_report_abs(inputdev,
 637                                                                  ABS_WHEEL,
 638                                                                  aiptek->curSetting.wheel);
 639                                                 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
 640                                         }
 641                                 }
 642                                 input_report_rel(inputdev, REL_MISC, p | AIPTEK_REPORT_TOOL_MOUSE);
 643                                 input_sync(inputdev);
 644                         }
 645                 }
 646         }
 647         /* Report 4s come from the macro keys when pressed by stylus
 648          */
 649         else if (data[0] == 4) {
 650                 jitterable = data[1] & 0x18;
 651
 652                 dv = (data[1] & 0x01) != 0 ? 1 : 0;
 653                 p = (data[1] & 0x02) != 0 ? 1 : 0;
 654                 tip = (data[1] & 0x04) != 0 ? 1 : 0;
 655                 bs = (data[1] & aiptek->curSetting.stylusButtonLower) != 0 ? 1 : 0;
 656                 pck = (data[1] & aiptek->curSetting.stylusButtonUpper) != 0 ? 1 : 0;
 657
 658                 macro = data[3];
 659                 z = le16_to_cpu(get_unaligned((__le16 *) (data + 4)));
 660
 661                 if (dv != 0) {
 662                         /* If we've not already sent a tool_button_?? code, do
 663                          * so now. Then set FIRED_BIT so it won't be resent unless
 664                          * the user forces FIRED_BIT off.
 665                          */
 666                         if (TOOL_BUTTON_FIRED(aiptek->curSetting.toolMode) == 0) {
 667                                 input_report_key(inputdev,
 668                                                  TOOL_BUTTON(aiptek->curSetting.toolMode),
 669                                                  1);
 670                                 aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
 671                         }
 672
 673                         if (p != 0) {
 674                                 input_report_key(inputdev, BTN_TOUCH, tip);
 675                                 input_report_key(inputdev, BTN_STYLUS, bs);
 676                                 input_report_key(inputdev, BTN_STYLUS2, pck);
 677                                 input_report_abs(inputdev, ABS_PRESSURE, z);
 678                         }
 679
 680                         /* For safety, we're sending key 'break' codes for the
 681                          * neighboring macro keys.
 682                          */
 683                         if (macro > 0) {
 684                                 input_report_key(inputdev,
 685                                                  macroKeyEvents[macro - 1], 0);
 686                         }
 687                         if (macro < 25) {
 688                                 input_report_key(inputdev,
 689                                                  macroKeyEvents[macro + 1], 0);
 690                         }
 691                         input_report_key(inputdev, macroKeyEvents[macro], p);
 692                         input_report_abs(inputdev, ABS_MISC,
 693                                          p | AIPTEK_REPORT_TOOL_STYLUS);
 694                         input_sync(inputdev);
 695                 }
 696         }
 697         /* Report 5s come from the macro keys when pressed by mouse
 698          */
 699         else if (data[0] == 5) {
 700                 jitterable = data[1] & 0x1c;
 701
 702                 dv = (data[1] & 0x01) != 0 ? 1 : 0;
 703                 p = (data[1] & 0x02) != 0 ? 1 : 0;
 704                 left = (data[1]& aiptek->curSetting.mouseButtonLeft) != 0 ? 1 : 0;
 705                 right = (data[1] & aiptek->curSetting.mouseButtonRight) != 0 ? 1 : 0;
 706                 middle = (data[1] & aiptek->curSetting.mouseButtonMiddle) != 0 ? 1 : 0;
 707                 macro = data[3];
 708
 709                 if (dv != 0) {
 710                         /* If we've not already sent a tool_button_?? code, do
 711                          * so now. Then set FIRED_BIT so it won't be resent unless
 712                          * the user forces FIRED_BIT off.
 713                          */
 714                         if (TOOL_BUTTON_FIRED(aiptek->curSetting.toolMode) == 0) {
 715                                 input_report_key(inputdev,
 716                                                  TOOL_BUTTON(aiptek->curSetting.toolMode),
 717                                                  1);
 718                                 aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
 719                         }
 720
 721                         if (p != 0) {
 722                                 input_report_key(inputdev, BTN_LEFT, left);
 723                                 input_report_key(inputdev, BTN_MIDDLE, middle);
 724                                 input_report_key(inputdev, BTN_RIGHT, right);
 725                         }
 726
 727                         /* For safety, we're sending key 'break' codes for the
 728                          * neighboring macro keys.
 729                          */
 730                         if (macro > 0) {
 731                                 input_report_key(inputdev,
 732                                                  macroKeyEvents[macro - 1], 0);
 733                         }
 734                         if (macro < 25) {
 735                                 input_report_key(inputdev,
 736                                                  macroKeyEvents[macro + 1], 0);
 737                         }
 738
 739                         input_report_key(inputdev, macroKeyEvents[macro], 1);
 740                         input_report_rel(inputdev, ABS_MISC,
 741                                          p | AIPTEK_REPORT_TOOL_MOUSE);
 742                         input_sync(inputdev);
 743                 }
 744         }
 745         /* We have no idea which tool can generate a report 6. Theoretically,
 746          * neither need to, having been given reports 4 & 5 for such use.
 747          * However, report 6 is the 'official-looking' report for macroKeys;
 748          * reports 4 & 5 supposively are used to support unnamed, unknown
 749          * hat switches (which just so happen to be the macroKeys.)
 750          */
 751         else if (data[0] == 6) {
 752                 macro = le16_to_cpu(get_unaligned((__le16 *) (data + 1)));
 753                 if (macro > 0) {
 754                         input_report_key(inputdev, macroKeyEvents[macro - 1],
 755                                          0);
 756                 }
 757                 if (macro < 25) {
 758                         input_report_key(inputdev, macroKeyEvents[macro + 1],
 759                                          0);
 760                 }
 761
 762                 /* If we've not already sent a tool_button_?? code, do
 763                  * so now. Then set FIRED_BIT so it won't be resent unless
 764                  * the user forces FIRED_BIT off.
 765                  */
 766                 if (TOOL_BUTTON_FIRED(aiptek->curSetting.toolMode) == 0) {
 767                         input_report_key(inputdev,
 768                                          TOOL_BUTTON(aiptek->curSetting.
 769                                                      toolMode), 1);
 770                         aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
 771                 }
 772
 773                 input_report_key(inputdev, macroKeyEvents[macro], 1);
 774                 input_report_abs(inputdev, ABS_MISC,
 775                                  1 | AIPTEK_REPORT_TOOL_UNKNOWN);
 776                 input_sync(inputdev);
 777         } else {
 778                 dbg("Unknown report %d", data[0]);
 779         }
 780
 781         /* Jitter may occur when the user presses a button on the stlyus
 782          * or the mouse. What we do to prevent that is wait 'x' milliseconds
 783          * following a 'jitterable' event, which should give the hand some time
 784          * stabilize itself.
 785          *
 786          * We just introduced aiptek->previousJitterable to carry forth the
 787          * notion that jitter occurs when the button state changes from on to off:
 788          * a person drawing, holding a button down is not subject to jittering.
 789          * With that in mind, changing from upper button depressed to lower button
 790          * WILL transition through a jitter delay.
 791          */
 792
 793         if (aiptek->previousJitterable != jitterable &&
 794             aiptek->curSetting.jitterDelay != 0 && aiptek->inDelay != 1) {
 795                 aiptek->endDelay = jiffies +
 796                     ((aiptek->curSetting.jitterDelay * HZ) / 1000);
 797                 aiptek->inDelay = 1;
 798         }
 799         aiptek->previousJitterable = jitterable;
 800
 801 exit:
 802         retval = usb_submit_urb(urb, GFP_ATOMIC);
 803         if (retval != 0) {
 804                 err("%s - usb_submit_urb failed with result %d",
 805                     __FUNCTION__, retval);
 806         }
 807 }
 808
 809 /***********************************************************************
 810  * These are the USB id's known so far. We do not identify them to
 811  * specific Aiptek model numbers, because there has been overlaps,
 812  * use, and reuse of id's in existing models. Certain models have
 813  * been known to use more than one ID, indicative perhaps of
 814  * manufacturing revisions. In any event, we consider these
 815  * IDs to not be model-specific nor unique.
 816  */
 817 static const struct usb_device_id aiptek_ids[] = {
 818         {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x01)},
 819         {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x10)},
 820         {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x20)},
 821         {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x21)},
 822         {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x22)},
 823         {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x23)},
 824         {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x24)},
 825         {}
 826 };
 827
 828 MODULE_DEVICE_TABLE(usb, aiptek_ids);
 829
 830 /***********************************************************************
 831  * Open an instance of the tablet driver.
 832  */
 833 static int aiptek_open(struct input_dev *inputdev)
 834 {
 835         struct aiptek *aiptek = input_get_drvdata(inputdev);
 836
 837         aiptek->urb->dev = aiptek->usbdev;
 838         if (usb_submit_urb(aiptek->urb, GFP_KERNEL) != 0)
 839                 return -EIO;
 840
 841         return 0;
 842 }
 843
 844 /***********************************************************************
 845  * Close an instance of the tablet driver.
 846  */
 847 static void aiptek_close(struct input_dev *inputdev)
 848 {
 849         struct aiptek *aiptek = input_get_drvdata(inputdev);
 850
 851         usb_kill_urb(aiptek->urb);
 852 }
 853
 854 /***********************************************************************
 855  * aiptek_set_report and aiptek_get_report() are borrowed from Linux 2.4.x,
 856  * where they were known as usb_set_report and usb_get_report.
 857  */
 858 static int
 859 aiptek_set_report(struct aiptek *aiptek,
 860                   unsigned char report_type,
 861                   unsigned char report_id, void *buffer, int size)
 862 {
 863         return usb_control_msg(aiptek->usbdev,
 864                                usb_sndctrlpipe(aiptek->usbdev, 0),
 865                                USB_REQ_SET_REPORT,
 866                                USB_TYPE_CLASS | USB_RECIP_INTERFACE |
 867                                USB_DIR_OUT, (report_type << 8) + report_id,
 868                                aiptek->ifnum, buffer, size, 5000);
 869 }
 870
 871 static int
 872 aiptek_get_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_rcvctrlpipe(aiptek->usbdev, 0),
 878                                USB_REQ_GET_REPORT,
 879                                USB_TYPE_CLASS | USB_RECIP_INTERFACE |
 880                                USB_DIR_IN, (report_type << 8) + report_id,
 881                                aiptek->ifnum, buffer, size, 5000);
 882 }
 883
 884 /***********************************************************************
 885  * Send a command to the tablet.
 886  */
 887 static int
 888 aiptek_command(struct aiptek *aiptek, unsigned char command, unsigned char data)
 889 {
 890         const int sizeof_buf = 3 * sizeof(u8);
 891         int ret;
 892         u8 *buf;
 893
 894         buf = kmalloc(sizeof_buf, GFP_KERNEL);
 895         if (!buf)
 896                 return -ENOMEM;
 897
 898         buf[0] = 2;
 899         buf[1] = command;
 900         buf[2] = data;
 901
 902         if ((ret =
 903              aiptek_set_report(aiptek, 3, 2, buf, sizeof_buf)) != sizeof_buf) {
 904                 dbg("aiptek_program: failed, tried to send: 0x%02x 0x%02x",
 905                     command, data);
 906         }
 907         kfree(buf);
 908         return ret < 0 ? ret : 0;
 909 }
 910
 911 /***********************************************************************
 912  * Retrieve information from the tablet. Querying info is defined as first
 913  * sending the {command,data} sequence as a command, followed by a wait
 914  * (aka, "programmaticDelay") and then a "read" request.
 915  */
 916 static int
 917 aiptek_query(struct aiptek *aiptek, unsigned char command, unsigned char data)
 918 {
 919         const int sizeof_buf = 3 * sizeof(u8);
 920         int ret;
 921         u8 *buf;
 922
 923         buf = kmalloc(sizeof_buf, GFP_KERNEL);
 924         if (!buf)
 925                 return -ENOMEM;
 926
 927         buf[0] = 2;
 928         buf[1] = command;
 929         buf[2] = data;
 930
 931         if (aiptek_command(aiptek, command, data) != 0) {
 932                 kfree(buf);
 933                 return -EIO;
 934         }
 935         msleep(aiptek->curSetting.programmableDelay);
 936
 937         if ((ret =
 938              aiptek_get_report(aiptek, 3, 2, buf, sizeof_buf)) != sizeof_buf) {
 939                 dbg("aiptek_query failed: returned 0x%02x 0x%02x 0x%02x",
 940                     buf[0], buf[1], buf[2]);
 941                 ret = -EIO;
 942         } else {
 943                 ret = le16_to_cpu(get_unaligned((__le16 *) (buf + 1)));
 944         }
 945         kfree(buf);
 946         return ret;
 947 }
 948
 949 /***********************************************************************
 950  * Program the tablet into either absolute or relative mode.
 951  * We also get information about the tablet's size.
 952  */
 953 static int aiptek_program_tablet(struct aiptek *aiptek)
 954 {
 955         int ret;
 956         /* Execute Resolution500LPI */
 957         if ((ret = aiptek_command(aiptek, 0x18, 0x04)) < 0)
 958                 return ret;
 959
 960         /* Query getModelCode */
 961         if ((ret = aiptek_query(aiptek, 0x02, 0x00)) < 0)
 962                 return ret;
 963         aiptek->features.modelCode = ret & 0xff;
 964
 965         /* Query getODMCode */
 966         if ((ret = aiptek_query(aiptek, 0x03, 0x00)) < 0)
 967                 return ret;
 968         aiptek->features.odmCode = ret;
 969
 970         /* Query getFirmwareCode */
 971         if ((ret = aiptek_query(aiptek, 0x04, 0x00)) < 0)
 972                 return ret;
 973         aiptek->features.firmwareCode = ret;
 974
 975         /* Query getXextension */
 976         if ((ret = aiptek_query(aiptek, 0x01, 0x00)) < 0)
 977                 return ret;
 978         aiptek->inputdev->absmin[ABS_X] = 0;
 979         aiptek->inputdev->absmax[ABS_X] = ret - 1;
 980
 981         /* Query getYextension */
 982         if ((ret = aiptek_query(aiptek, 0x01, 0x01)) < 0)
 983                 return ret;
 984         aiptek->inputdev->absmin[ABS_Y] = 0;
 985         aiptek->inputdev->absmax[ABS_Y] = ret - 1;
 986
 987         /* Query getPressureLevels */
 988         if ((ret = aiptek_query(aiptek, 0x08, 0x00)) < 0)
 989                 return ret;
 990         aiptek->inputdev->absmin[ABS_PRESSURE] = 0;
 991         aiptek->inputdev->absmax[ABS_PRESSURE] = ret - 1;
 992
 993         /* Depending on whether we are in absolute or relative mode, we will
 994          * do a switchToTablet(absolute) or switchToMouse(relative) command.
 995          */
 996         if (aiptek->curSetting.coordinateMode ==
 997             AIPTEK_COORDINATE_ABSOLUTE_MODE) {
 998                 /* Execute switchToTablet */
 999                 if ((ret = aiptek_command(aiptek, 0x10, 0x01)) < 0) {
1000                         return ret;
1001                 }
1002         } else {
1003                 /* Execute switchToMouse */
1004                 if ((ret = aiptek_command(aiptek, 0x10, 0x00)) < 0) {
1005                         return ret;
1006                 }
1007         }
1008
1009         /* Enable the macro keys */
1010         if ((ret = aiptek_command(aiptek, 0x11, 0x02)) < 0)
1011                 return ret;
1012 #if 0
1013         /* Execute FilterOn */
1014         if ((ret = aiptek_command(aiptek, 0x17, 0x00)) < 0)
1015                 return ret;
1016 #endif
1017
1018         /* Execute AutoGainOn */
1019         if ((ret = aiptek_command(aiptek, 0x12, 0xff)) < 0)
1020                 return ret;
1021
1022         /* Reset the eventCount, so we track events from last (re)programming
1023          */
1024         aiptek->diagnostic = AIPTEK_DIAGNOSTIC_NA;
1025         aiptek->eventCount = 0;
1026
1027         return 0;
1028 }
1029
1030 /***********************************************************************
1031  * Sysfs functions. Sysfs prefers that individually-tunable parameters
1032  * exist in their separate pseudo-files. Summary data that is immutable
1033  * may exist in a singular file so long as you don't define a writeable
1034  * interface.
1035  */
1036
1037 /***********************************************************************
1038  * support the 'size' file -- display support
1039  */
1040 static ssize_t show_tabletSize(struct device *dev, struct device_attribute *attr, char *buf)
1041 {
1042         struct aiptek *aiptek = dev_get_drvdata(dev);
1043
1044         return snprintf(buf, PAGE_SIZE, "%dx%d\n",
1045                         aiptek->inputdev->absmax[ABS_X] + 1,
1046                         aiptek->inputdev->absmax[ABS_Y] + 1);
1047 }
1048
1049 /* These structs define the sysfs files, param #1 is the name of the
1050  * file, param 2 is the file permissions, param 3 & 4 are to the
1051  * output generator and input parser routines. Absence of a routine is
1052  * permitted -- it only means can't either 'cat' the file, or send data
1053  * to it.
1054  */
1055 static DEVICE_ATTR(size, S_IRUGO, show_tabletSize, NULL);
1056
1057 /***********************************************************************
1058  * support routines for the 'pointer_mode' file. Note that this file
1059  * both displays current setting and allows reprogramming.
1060  */
1061 static struct aiptek_map pointer_mode_map[] = {
1062         { "stylus",     AIPTEK_POINTER_ONLY_STYLUS_MODE },
1063         { "mouse",      AIPTEK_POINTER_ONLY_MOUSE_MODE },
1064         { "either",     AIPTEK_POINTER_EITHER_MODE },
1065         { NULL,         AIPTEK_INVALID_VALUE }
1066 };
1067
1068 static ssize_t show_tabletPointerMode(struct device *dev, struct device_attribute *attr, char *buf)
1069 {
1070         struct aiptek *aiptek = dev_get_drvdata(dev);
1071
1072         return snprintf(buf, PAGE_SIZE, "%s\n",
1073                         map_val_to_str(pointer_mode_map,
1074                                         aiptek->curSetting.pointerMode));
1075 }
1076
1077 static ssize_t
1078 store_tabletPointerMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1079 {
1080         struct aiptek *aiptek = dev_get_drvdata(dev);
1081         int new_mode = map_str_to_val(pointer_mode_map, buf, count);
1082
1083         if (new_mode == AIPTEK_INVALID_VALUE)
1084                 return -EINVAL;
1085
1086         aiptek->newSetting.pointerMode = new_mode;
1087         return count;
1088 }
1089
1090 static DEVICE_ATTR(pointer_mode,
1091                    S_IRUGO | S_IWUGO,
1092                    show_tabletPointerMode, store_tabletPointerMode);
1093
1094 /***********************************************************************
1095  * support routines for the 'coordinate_mode' file. Note that this file
1096  * both displays current setting and allows reprogramming.
1097  */
1098
1099 static struct aiptek_map coordinate_mode_map[] = {
1100         { "absolute",   AIPTEK_COORDINATE_ABSOLUTE_MODE },
1101         { "relative",   AIPTEK_COORDINATE_RELATIVE_MODE },
1102         { NULL,         AIPTEK_INVALID_VALUE }
1103 };
1104
1105 static ssize_t show_tabletCoordinateMode(struct device *dev, struct device_attribute *attr, char *buf)
1106 {
1107         struct aiptek *aiptek = dev_get_drvdata(dev);
1108
1109         return snprintf(buf, PAGE_SIZE, "%s\n",
1110                         map_val_to_str(coordinate_mode_map,
1111                                         aiptek->curSetting.coordinateMode));
1112 }
1113
1114 static ssize_t
1115 store_tabletCoordinateMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1116 {
1117         struct aiptek *aiptek = dev_get_drvdata(dev);
1118         int new_mode = map_str_to_val(coordinate_mode_map, buf, count);
1119
1120         if (new_mode == AIPTEK_INVALID_VALUE)
1121                 return -EINVAL;
1122
1123         aiptek->newSetting.coordinateMode = new_mode;
1124         return count;
1125 }
1126
1127 static DEVICE_ATTR(coordinate_mode,
1128                    S_IRUGO | S_IWUGO,
1129                    show_tabletCoordinateMode, store_tabletCoordinateMode);
1130
1131 /***********************************************************************
1132  * support routines for the 'tool_mode' file. Note that this file
1133  * both displays current setting and allows reprogramming.
1134  */
1135
1136 static struct aiptek_map tool_mode_map[] = {
1137         { "mouse",      AIPTEK_TOOL_BUTTON_MOUSE_MODE },
1138         { "eraser",     AIPTEK_TOOL_BUTTON_ERASER_MODE },
1139         { "pencil",     AIPTEK_TOOL_BUTTON_PENCIL_MODE },
1140         { "pen",        AIPTEK_TOOL_BUTTON_PEN_MODE },
1141         { "brush",      AIPTEK_TOOL_BUTTON_BRUSH_MODE },
1142         { "airbrush",   AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE },
1143         { "lens",       AIPTEK_TOOL_BUTTON_LENS_MODE },
1144         { NULL,         AIPTEK_INVALID_VALUE }
1145 };
1146
1147 static ssize_t show_tabletToolMode(struct device *dev, struct device_attribute *attr, char *buf)
1148 {
1149         struct aiptek *aiptek = dev_get_drvdata(dev);
1150
1151         return snprintf(buf, PAGE_SIZE, "%s\n",
1152                         map_val_to_str(tool_mode_map,
1153                                         aiptek->curSetting.toolMode));
1154 }
1155
1156 static ssize_t
1157 store_tabletToolMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1158 {
1159         struct aiptek *aiptek = dev_get_drvdata(dev);
1160         int new_mode = map_str_to_val(tool_mode_map, buf, count);
1161
1162         if (new_mode == AIPTEK_INVALID_VALUE)
1163                 return -EINVAL;
1164
1165         aiptek->newSetting.toolMode = new_mode;
1166         return count;
1167 }
1168
1169 static DEVICE_ATTR(tool_mode,
1170                    S_IRUGO | S_IWUGO,
1171                    show_tabletToolMode, store_tabletToolMode);
1172
1173 /***********************************************************************
1174  * support routines for the 'xtilt' file. Note that this file
1175  * both displays current setting and allows reprogramming.
1176  */
1177 static ssize_t show_tabletXtilt(struct device *dev, struct device_attribute *attr, char *buf)
1178 {
1179         struct aiptek *aiptek = dev_get_drvdata(dev);
1180
1181         if (aiptek->curSetting.xTilt == AIPTEK_TILT_DISABLE) {
1182                 return snprintf(buf, PAGE_SIZE, "disable\n");
1183         } else {
1184                 return snprintf(buf, PAGE_SIZE, "%d\n",
1185                                 aiptek->curSetting.xTilt);
1186         }
1187 }
1188
1189 static ssize_t
1190 store_tabletXtilt(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1191 {
1192         struct aiptek *aiptek = dev_get_drvdata(dev);
1193         int x;
1194
1195         if (strcmp(buf, "disable") == 0) {
1196                 aiptek->newSetting.xTilt = AIPTEK_TILT_DISABLE;
1197         } else {
1198                 x = (int)simple_strtol(buf, NULL, 10);
1199                 if (x >= AIPTEK_TILT_MIN && x <= AIPTEK_TILT_MAX) {
1200                         aiptek->newSetting.xTilt = x;
1201                 }
1202         }
1203         return count;
1204 }
1205
1206 static DEVICE_ATTR(xtilt,
1207                    S_IRUGO | S_IWUGO, show_tabletXtilt, store_tabletXtilt);
1208
1209 /***********************************************************************
1210  * support routines for the 'ytilt' file. Note that this file
1211  * both displays current setting and allows reprogramming.
1212  */
1213 static ssize_t show_tabletYtilt(struct device *dev, struct device_attribute *attr, char *buf)
1214 {
1215         struct aiptek *aiptek = dev_get_drvdata(dev);
1216
1217         if (aiptek->curSetting.yTilt == AIPTEK_TILT_DISABLE) {
1218                 return snprintf(buf, PAGE_SIZE, "disable\n");
1219         } else {
1220                 return snprintf(buf, PAGE_SIZE, "%d\n",
1221                                 aiptek->curSetting.yTilt);
1222         }
1223 }
1224
1225 static ssize_t
1226 store_tabletYtilt(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1227 {
1228         struct aiptek *aiptek = dev_get_drvdata(dev);
1229         int y;
1230
1231         if (strcmp(buf, "disable") == 0) {
1232                 aiptek->newSetting.yTilt = AIPTEK_TILT_DISABLE;
1233         } else {
1234                 y = (int)simple_strtol(buf, NULL, 10);
1235                 if (y >= AIPTEK_TILT_MIN && y <= AIPTEK_TILT_MAX) {
1236                         aiptek->newSetting.yTilt = y;
1237                 }
1238         }
1239         return count;
1240 }
1241
1242 static DEVICE_ATTR(ytilt,
1243                    S_IRUGO | S_IWUGO, show_tabletYtilt, store_tabletYtilt);
1244
1245 /***********************************************************************
1246  * support routines for the 'jitter' file. Note that this file
1247  * both displays current setting and allows reprogramming.
1248  */
1249 static ssize_t show_tabletJitterDelay(struct device *dev, struct device_attribute *attr, char *buf)
1250 {
1251         struct aiptek *aiptek = dev_get_drvdata(dev);
1252
1253         return snprintf(buf, PAGE_SIZE, "%d\n", aiptek->curSetting.jitterDelay);
1254 }
1255
1256 static ssize_t
1257 store_tabletJitterDelay(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1258 {
1259         struct aiptek *aiptek = dev_get_drvdata(dev);
1260
1261         aiptek->newSetting.jitterDelay = (int)simple_strtol(buf, NULL, 10);
1262         return count;
1263 }
1264
1265 static DEVICE_ATTR(jitter,
1266                    S_IRUGO | S_IWUGO,
1267                    show_tabletJitterDelay, store_tabletJitterDelay);
1268
1269 /***********************************************************************
1270  * support routines for the 'delay' file. Note that this file
1271  * both displays current setting and allows reprogramming.
1272  */
1273 static ssize_t show_tabletProgrammableDelay(struct device *dev, struct device_attribute *attr, char *buf)
1274 {
1275         struct aiptek *aiptek = dev_get_drvdata(dev);
1276
1277         return snprintf(buf, PAGE_SIZE, "%d\n",
1278                         aiptek->curSetting.programmableDelay);
1279 }
1280
1281 static ssize_t
1282 store_tabletProgrammableDelay(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1283 {
1284         struct aiptek *aiptek = dev_get_drvdata(dev);
1285
1286         aiptek->newSetting.programmableDelay = (int)simple_strtol(buf, NULL, 10);
1287         return count;
1288 }
1289
1290 static DEVICE_ATTR(delay,
1291                    S_IRUGO | S_IWUGO,
1292                    show_tabletProgrammableDelay, store_tabletProgrammableDelay);
1293
1294 /***********************************************************************
1295  * support routines for the 'event_count' file. Note that this file
1296  * only displays current setting.
1297  */
1298 static ssize_t show_tabletEventsReceived(struct device *dev, struct device_attribute *attr, char *buf)
1299 {
1300         struct aiptek *aiptek = dev_get_drvdata(dev);
1301
1302         return snprintf(buf, PAGE_SIZE, "%ld\n", aiptek->eventCount);
1303 }
1304
1305 static DEVICE_ATTR(event_count, S_IRUGO, show_tabletEventsReceived, NULL);
1306
1307 /***********************************************************************
1308  * support routines for the 'diagnostic' file. Note that this file
1309  * only displays current setting.
1310  */
1311 static ssize_t show_tabletDiagnosticMessage(struct device *dev, struct device_attribute *attr, char *buf)
1312 {
1313         struct aiptek *aiptek = dev_get_drvdata(dev);
1314         char *retMsg;
1315
1316         switch (aiptek->diagnostic) {
1317         case AIPTEK_DIAGNOSTIC_NA:
1318                 retMsg = "no errors\n";
1319                 break;
1320
1321         case AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE:
1322                 retMsg = "Error: receiving relative reports\n";
1323                 break;
1324
1325         case AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE:
1326                 retMsg = "Error: receiving absolute reports\n";
1327                 break;
1328
1329         case AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED:
1330                 if (aiptek->curSetting.pointerMode ==
1331                     AIPTEK_POINTER_ONLY_MOUSE_MODE) {
1332                         retMsg = "Error: receiving stylus reports\n";
1333                 } else {
1334                         retMsg = "Error: receiving mouse reports\n";
1335                 }
1336                 break;
1337
1338         default:
1339                 return 0;
1340         }
1341         return snprintf(buf, PAGE_SIZE, retMsg);
1342 }
1343
1344 static DEVICE_ATTR(diagnostic, S_IRUGO, show_tabletDiagnosticMessage, NULL);
1345
1346 /***********************************************************************
1347  * support routines for the 'stylus_upper' file. Note that this file
1348  * both displays current setting and allows for setting changing.
1349  */
1350
1351 static struct aiptek_map stylus_button_map[] = {
1352         { "upper",      AIPTEK_STYLUS_UPPER_BUTTON },
1353         { "lower",      AIPTEK_STYLUS_LOWER_BUTTON },
1354         { NULL,         AIPTEK_INVALID_VALUE }
1355 };
1356
1357 static ssize_t show_tabletStylusUpper(struct device *dev, struct device_attribute *attr, char *buf)
1358 {
1359         struct aiptek *aiptek = dev_get_drvdata(dev);
1360
1361         return snprintf(buf, PAGE_SIZE, "%s\n",
1362                         map_val_to_str(stylus_button_map,
1363                                         aiptek->curSetting.stylusButtonUpper));
1364 }
1365
1366 static ssize_t
1367 store_tabletStylusUpper(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1368 {
1369         struct aiptek *aiptek = dev_get_drvdata(dev);
1370         int new_button = map_str_to_val(stylus_button_map, buf, count);
1371
1372         if (new_button == AIPTEK_INVALID_VALUE)
1373                 return -EINVAL;
1374
1375         aiptek->newSetting.stylusButtonUpper = new_button;
1376         return count;
1377 }
1378
1379 static DEVICE_ATTR(stylus_upper,
1380                    S_IRUGO | S_IWUGO,
1381                    show_tabletStylusUpper, store_tabletStylusUpper);
1382
1383 /***********************************************************************
1384  * support routines for the 'stylus_lower' file. Note that this file
1385  * both displays current setting and allows for setting changing.
1386  */
1387
1388 static ssize_t show_tabletStylusLower(struct device *dev, struct device_attribute *attr, char *buf)
1389 {
1390         struct aiptek *aiptek = dev_get_drvdata(dev);
1391
1392         return snprintf(buf, PAGE_SIZE, "%s\n",
1393                         map_val_to_str(stylus_button_map,
1394                                         aiptek->curSetting.stylusButtonLower));
1395 }
1396
1397 static ssize_t
1398 store_tabletStylusLower(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1399 {
1400         struct aiptek *aiptek = dev_get_drvdata(dev);
1401         int new_button = map_str_to_val(stylus_button_map, buf, count);
1402
1403         if (new_button == AIPTEK_INVALID_VALUE)
1404                 return -EINVAL;
1405
1406         aiptek->newSetting.stylusButtonLower = new_button;
1407         return count;
1408 }
1409
1410 static DEVICE_ATTR(stylus_lower,
1411                    S_IRUGO | S_IWUGO,
1412                    show_tabletStylusLower, store_tabletStylusLower);
1413
1414 /***********************************************************************
1415  * support routines for the 'mouse_left' file. Note that this file
1416  * both displays current setting and allows for setting changing.
1417  */
1418
1419 static struct aiptek_map mouse_button_map[] = {
1420         { "left",       AIPTEK_MOUSE_LEFT_BUTTON },
1421         { "middle",     AIPTEK_MOUSE_MIDDLE_BUTTON },
1422         { "right",      AIPTEK_MOUSE_RIGHT_BUTTON },
1423         { NULL,         AIPTEK_INVALID_VALUE }
1424 };
1425
1426 static ssize_t show_tabletMouseLeft(struct device *dev, struct device_attribute *attr, char *buf)
1427 {
1428         struct aiptek *aiptek = dev_get_drvdata(dev);
1429
1430         return snprintf(buf, PAGE_SIZE, "%s\n",
1431                         map_val_to_str(mouse_button_map,
1432                                         aiptek->curSetting.mouseButtonLeft));
1433 }
1434
1435 static ssize_t
1436 store_tabletMouseLeft(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1437 {
1438         struct aiptek *aiptek = dev_get_drvdata(dev);
1439         int new_button = map_str_to_val(mouse_button_map, buf, count);
1440
1441         if (new_button == AIPTEK_INVALID_VALUE)
1442                 return -EINVAL;
1443
1444         aiptek->newSetting.mouseButtonLeft = new_button;
1445         return count;
1446 }
1447
1448 static DEVICE_ATTR(mouse_left,
1449                    S_IRUGO | S_IWUGO,
1450                    show_tabletMouseLeft, store_tabletMouseLeft);
1451
1452 /***********************************************************************
1453  * support routines for the 'mouse_middle' file. Note that this file
1454  * both displays current setting and allows for setting changing.
1455  */
1456 static ssize_t show_tabletMouseMiddle(struct device *dev, struct device_attribute *attr, char *buf)
1457 {
1458         struct aiptek *aiptek = dev_get_drvdata(dev);
1459
1460         return snprintf(buf, PAGE_SIZE, "%s\n",
1461                         map_val_to_str(mouse_button_map,
1462                                         aiptek->curSetting.mouseButtonMiddle));
1463 }
1464
1465 static ssize_t
1466 store_tabletMouseMiddle(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1467 {
1468         struct aiptek *aiptek = dev_get_drvdata(dev);
1469         int new_button = map_str_to_val(mouse_button_map, buf, count);
1470
1471         if (new_button == AIPTEK_INVALID_VALUE)
1472                 return -EINVAL;
1473
1474         aiptek->newSetting.mouseButtonMiddle = new_button;
1475         return count;
1476 }
1477
1478 static DEVICE_ATTR(mouse_middle,
1479                    S_IRUGO | S_IWUGO,
1480                    show_tabletMouseMiddle, store_tabletMouseMiddle);
1481
1482 /***********************************************************************
1483  * support routines for the 'mouse_right' file. Note that this file
1484  * both displays current setting and allows for setting changing.
1485  */
1486 static ssize_t show_tabletMouseRight(struct device *dev, struct device_attribute *attr, char *buf)
1487 {
1488         struct aiptek *aiptek = dev_get_drvdata(dev);
1489
1490         return snprintf(buf, PAGE_SIZE, "%s\n",
1491                         map_val_to_str(mouse_button_map,
1492                                         aiptek->curSetting.mouseButtonRight));
1493 }
1494
1495 static ssize_t
1496 store_tabletMouseRight(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1497 {
1498         struct aiptek *aiptek = dev_get_drvdata(dev);
1499         int new_button = map_str_to_val(mouse_button_map, buf, count);
1500
1501         if (new_button == AIPTEK_INVALID_VALUE)
1502                 return -EINVAL;
1503
1504         aiptek->newSetting.mouseButtonRight = new_button;
1505         return count;
1506 }
1507
1508 static DEVICE_ATTR(mouse_right,
1509                    S_IRUGO | S_IWUGO,
1510                    show_tabletMouseRight, store_tabletMouseRight);
1511
1512 /***********************************************************************
1513  * support routines for the 'wheel' file. Note that this file
1514  * both displays current setting and allows for setting changing.
1515  */
1516 static ssize_t show_tabletWheel(struct device *dev, struct device_attribute *attr, char *buf)
1517 {
1518         struct aiptek *aiptek = dev_get_drvdata(dev);
1519
1520         if (aiptek->curSetting.wheel == AIPTEK_WHEEL_DISABLE) {
1521                 return snprintf(buf, PAGE_SIZE, "disable\n");
1522         } else {
1523                 return snprintf(buf, PAGE_SIZE, "%d\n",
1524                                 aiptek->curSetting.wheel);
1525         }
1526 }
1527
1528 static ssize_t
1529 store_tabletWheel(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1530 {
1531         struct aiptek *aiptek = dev_get_drvdata(dev);
1532
1533         aiptek->newSetting.wheel = (int)simple_strtol(buf, NULL, 10);
1534         return count;
1535 }
1536
1537 static DEVICE_ATTR(wheel,
1538                    S_IRUGO | S_IWUGO, show_tabletWheel, store_tabletWheel);
1539
1540 /***********************************************************************
1541  * support routines for the 'execute' file. Note that this file
1542  * both displays current setting and allows for setting changing.
1543  */
1544 static ssize_t show_tabletExecute(struct device *dev, struct device_attribute *attr, char *buf)
1545 {
1546         /* There is nothing useful to display, so a one-line manual
1547          * is in order...
1548          */
1549         return snprintf(buf, PAGE_SIZE,
1550                         "Write anything to this file to program your tablet.\n");
1551 }
1552
1553 static ssize_t
1554 store_tabletExecute(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1555 {
1556         struct aiptek *aiptek = dev_get_drvdata(dev);
1557
1558         /* We do not care what you write to this file. Merely the action
1559          * of writing to this file triggers a tablet reprogramming.
1560          */
1561         memcpy(&aiptek->curSetting, &aiptek->newSetting,
1562                sizeof(struct aiptek_settings));
1563
1564         if (aiptek_program_tablet(aiptek) < 0)
1565                 return -EIO;
1566
1567         return count;
1568 }
1569
1570 static DEVICE_ATTR(execute,
1571                    S_IRUGO | S_IWUGO, show_tabletExecute, store_tabletExecute);
1572
1573 /***********************************************************************
1574  * support routines for the 'odm_code' file. Note that this file
1575  * only displays current setting.
1576  */
1577 static ssize_t show_tabletODMCode(struct device *dev, struct device_attribute *attr, char *buf)
1578 {
1579         struct aiptek *aiptek = dev_get_drvdata(dev);
1580
1581         return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->features.odmCode);
1582 }
1583
1584 static DEVICE_ATTR(odm_code, S_IRUGO, show_tabletODMCode, NULL);
1585
1586 /***********************************************************************
1587  * support routines for the 'model_code' file. Note that this file
1588  * only displays current setting.
1589  */
1590 static ssize_t show_tabletModelCode(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.modelCode);
1595 }
1596
1597 static DEVICE_ATTR(model_code, S_IRUGO, show_tabletModelCode, NULL);
1598
1599 /***********************************************************************
1600  * support routines for the 'firmware_code' file. Note that this file
1601  * only displays current setting.
1602  */
1603 static ssize_t show_firmwareCode(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, "%04x\n",
1608                         aiptek->features.firmwareCode);
1609 }
1610
1611 static DEVICE_ATTR(firmware_code, S_IRUGO, show_firmwareCode, NULL);
1612
1613 static struct attribute *aiptek_attributes[] = {
1614         &dev_attr_size.attr,
1615         &dev_attr_pointer_mode.attr,
1616         &dev_attr_coordinate_mode.attr,
1617         &dev_attr_tool_mode.attr,
1618         &dev_attr_xtilt.attr,
1619         &dev_attr_ytilt.attr,
1620         &dev_attr_jitter.attr,
1621         &dev_attr_delay.attr,
1622         &dev_attr_event_count.attr,
1623         &dev_attr_diagnostic.attr,
1624         &dev_attr_odm_code.attr,
1625         &dev_attr_model_code.attr,
1626         &dev_attr_firmware_code.attr,
1627         &dev_attr_stylus_lower.attr,
1628         &dev_attr_stylus_upper.attr,
1629         &dev_attr_mouse_left.attr,
1630         &dev_attr_mouse_middle.attr,
1631         &dev_attr_mouse_right.attr,
1632         &dev_attr_wheel.attr,
1633         &dev_attr_execute.attr,
1634         NULL
1635 };
1636
1637 static struct attribute_group aiptek_attribute_group = {
1638         .attrs  = aiptek_attributes,
1639 };
1640
1641 /***********************************************************************
1642  * This routine is called when a tablet has been identified. It basically
1643  * sets up the tablet and the driver's internal structures.
1644  */
1645 static int
1646 aiptek_probe(struct usb_interface *intf, const struct usb_device_id *id)
1647 {
1648         struct usb_device *usbdev = interface_to_usbdev(intf);
1649         struct usb_endpoint_descriptor *endpoint;
1650         struct aiptek *aiptek;
1651         struct input_dev *inputdev;
1652         int i;
1653         int speeds[] = { 0,
1654                 AIPTEK_PROGRAMMABLE_DELAY_50,
1655                 AIPTEK_PROGRAMMABLE_DELAY_400,
1656                 AIPTEK_PROGRAMMABLE_DELAY_25,
1657                 AIPTEK_PROGRAMMABLE_DELAY_100,
1658                 AIPTEK_PROGRAMMABLE_DELAY_200,
1659                 AIPTEK_PROGRAMMABLE_DELAY_300
1660         };
1661         int err = -ENOMEM;
1662
1663         /* programmableDelay is where the command-line specified
1664          * delay is kept. We make it the first element of speeds[],
1665          * so therefore, your override speed is tried first, then the
1666          * remainder. Note that the default value of 400ms will be tried
1667          * if you do not specify any command line parameter.
1668          */
1669         speeds[0] = programmableDelay;
1670
1671         aiptek = kzalloc(sizeof(struct aiptek), GFP_KERNEL);
1672         inputdev = input_allocate_device();
1673         if (!aiptek || !inputdev) {
1674                 warn("aiptek: cannot allocate memory or input device");
1675                 goto fail1;
1676         }
1677
1678         aiptek->data = usb_buffer_alloc(usbdev, AIPTEK_PACKET_LENGTH,
1679                                         GFP_ATOMIC, &aiptek->data_dma);
1680         if (!aiptek->data) {
1681                 warn("aiptek: cannot allocate usb buffer");
1682                 goto fail1;
1683         }
1684
1685         aiptek->urb = usb_alloc_urb(0, GFP_KERNEL);
1686         if (!aiptek->urb) {
1687                 warn("aiptek: cannot allocate urb");
1688                 goto fail2;
1689         }
1690
1691         aiptek->inputdev = inputdev;
1692         aiptek->usbdev = usbdev;
1693         aiptek->ifnum = intf->altsetting[0].desc.bInterfaceNumber;
1694         aiptek->inDelay = 0;
1695         aiptek->endDelay = 0;
1696         aiptek->previousJitterable = 0;
1697
1698         /* Set up the curSettings struct. Said struct contains the current
1699          * programmable parameters. The newSetting struct contains changes
1700          * the user makes to the settings via the sysfs interface. Those
1701          * changes are not "committed" to curSettings until the user
1702          * writes to the sysfs/.../execute file.
1703          */
1704         aiptek->curSetting.pointerMode = AIPTEK_POINTER_EITHER_MODE;
1705         aiptek->curSetting.coordinateMode = AIPTEK_COORDINATE_ABSOLUTE_MODE;
1706         aiptek->curSetting.toolMode = AIPTEK_TOOL_BUTTON_PEN_MODE;
1707         aiptek->curSetting.xTilt = AIPTEK_TILT_DISABLE;
1708         aiptek->curSetting.yTilt = AIPTEK_TILT_DISABLE;
1709         aiptek->curSetting.mouseButtonLeft = AIPTEK_MOUSE_LEFT_BUTTON;
1710         aiptek->curSetting.mouseButtonMiddle = AIPTEK_MOUSE_MIDDLE_BUTTON;
1711         aiptek->curSetting.mouseButtonRight = AIPTEK_MOUSE_RIGHT_BUTTON;
1712         aiptek->curSetting.stylusButtonUpper = AIPTEK_STYLUS_UPPER_BUTTON;
1713         aiptek->curSetting.stylusButtonLower = AIPTEK_STYLUS_LOWER_BUTTON;
1714         aiptek->curSetting.jitterDelay = jitterDelay;
1715         aiptek->curSetting.programmableDelay = programmableDelay;
1716
1717         /* Both structs should have equivalent settings
1718          */
1719         aiptek->newSetting = aiptek->curSetting;
1720
1721         /* Determine the usb devices' physical path.
1722          * Asketh not why we always pretend we're using "../input0",
1723          * but I suspect this will have to be refactored one
1724          * day if a single USB device can be a keyboard & a mouse
1725          * & a tablet, and the inputX number actually will tell
1726          * us something...
1727          */
1728         usb_make_path(usbdev, aiptek->features.usbPath,
1729                         sizeof(aiptek->features.usbPath));
1730         strlcat(aiptek->features.usbPath, "/input0",
1731                 sizeof(aiptek->features.usbPath));
1732
1733         /* Set up client data, pointers to open and close routines
1734          * for the input device.
1735          */
1736         inputdev->name = "Aiptek";
1737         inputdev->phys = aiptek->features.usbPath;
1738         usb_to_input_id(usbdev, &inputdev->id);
1739         inputdev->dev.parent = &intf->dev;
1740
1741         input_set_drvdata(inputdev, aiptek);
1742
1743         inputdev->open = aiptek_open;
1744         inputdev->close = aiptek_close;
1745
1746         /* Now program the capacities of the tablet, in terms of being
1747          * an input device.
1748          */
1749         for (i = 0; i < ARRAY_SIZE(eventTypes); ++i)
1750                 __set_bit(eventTypes[i], inputdev->evbit);
1751
1752         for (i = 0; i < ARRAY_SIZE(absEvents); ++i)
1753                 __set_bit(absEvents[i], inputdev->absbit);
1754
1755         for (i = 0; i < ARRAY_SIZE(relEvents); ++i)
1756                 __set_bit(relEvents[i], inputdev->relbit);
1757
1758         __set_bit(MSC_SERIAL, inputdev->mscbit);
1759
1760         /* Set up key and button codes */
1761         for (i = 0; i < ARRAY_SIZE(buttonEvents); ++i)
1762                 __set_bit(buttonEvents[i], inputdev->keybit);
1763
1764         for (i = 0; i < ARRAY_SIZE(macroKeyEvents); ++i)
1765                 __set_bit(macroKeyEvents[i], inputdev->keybit);
1766
1767         /*
1768          * Program the input device coordinate capacities. We do not yet
1769          * know what maximum X, Y, and Z values are, so we're putting fake
1770          * values in. Later, we'll ask the tablet to put in the correct
1771          * values.
1772          */
1773         input_set_abs_params(inputdev, ABS_X, 0, 2999, 0, 0);
1774         input_set_abs_params(inputdev, ABS_Y, 0, 2249, 0, 0);
1775         input_set_abs_params(inputdev, ABS_PRESSURE, 0, 511, 0, 0);
1776         input_set_abs_params(inputdev, ABS_TILT_X, AIPTEK_TILT_MIN, AIPTEK_TILT_MAX, 0, 0);
1777         input_set_abs_params(inputdev, ABS_TILT_Y, AIPTEK_TILT_MIN, AIPTEK_TILT_MAX, 0, 0);
1778         input_set_abs_params(inputdev, ABS_WHEEL, AIPTEK_WHEEL_MIN, AIPTEK_WHEEL_MAX - 1, 0, 0);
1779
1780         endpoint = &intf->altsetting[0].endpoint[0].desc;
1781
1782         /* Go set up our URB, which is called when the tablet receives
1783          * input.
1784          */
1785         usb_fill_int_urb(aiptek->urb,
1786                          aiptek->usbdev,
1787                          usb_rcvintpipe(aiptek->usbdev,
1788                                         endpoint->bEndpointAddress),
1789                          aiptek->data, 8, aiptek_irq, aiptek,
1790                          endpoint->bInterval);
1791
1792         aiptek->urb->transfer_dma = aiptek->data_dma;
1793         aiptek->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1794
1795         /* Program the tablet. This sets the tablet up in the mode
1796          * specified in newSetting, and also queries the tablet's
1797          * physical capacities.
1798          *
1799          * Sanity check: if a tablet doesn't like the slow programmatic
1800          * delay, we often get sizes of 0x0. Let's use that as an indicator
1801          * to try faster delays, up to 25 ms. If that logic fails, well, you'll
1802          * have to explain to us how your tablet thinks it's 0x0, and yet that's
1803          * not an error :-)
1804          */
1805
1806         for (i = 0; i < ARRAY_SIZE(speeds); ++i) {
1807                 aiptek->curSetting.programmableDelay = speeds[i];
1808                 (void)aiptek_program_tablet(aiptek);
1809                 if (aiptek->inputdev->absmax[ABS_X] > 0) {
1810                         info("input: Aiptek using %d ms programming speed\n",
1811                              aiptek->curSetting.programmableDelay);
1812                         break;
1813                 }
1814         }
1815
1816         /* Murphy says that some day someone will have a tablet that fails the
1817            above test. That's you, Frederic Rodrigo */
1818         if (i == ARRAY_SIZE(speeds)) {
1819                 info("input: Aiptek tried all speeds, no sane response");
1820                 goto fail2;
1821         }
1822
1823         /* Associate this driver's struct with the usb interface.
1824          */
1825         usb_set_intfdata(intf, aiptek);
1826
1827         /* Set up the sysfs files
1828          */
1829         err = sysfs_create_group(&intf->dev.kobj, &aiptek_attribute_group);
1830         if (err) {
1831                 warn("aiptek: cannot create sysfs group err: %d", err);
1832                 goto fail3;
1833         }
1834
1835         /* Register the tablet as an Input Device
1836          */
1837         err = input_register_device(aiptek->inputdev);
1838         if (err) {
1839                 warn("aiptek: input_register_device returned err: %d", err);
1840                 goto fail4;
1841         }
1842         return 0;
1843
1844  fail4: sysfs_remove_group(&intf->dev.kobj, &aiptek_attribute_group);
1845  fail3: usb_free_urb(aiptek->urb);
1846  fail2: usb_buffer_free(usbdev, AIPTEK_PACKET_LENGTH, aiptek->data,
1847                         aiptek->data_dma);
1848  fail1: usb_set_intfdata(intf, NULL);
1849         input_free_device(inputdev);
1850         kfree(aiptek);
1851         return err;
1852 }
1853
1854 /***********************************************************************
1855  * Deal with tablet disconnecting from the system.
1856  */
1857 static void aiptek_disconnect(struct usb_interface *intf)
1858 {
1859         struct aiptek *aiptek = usb_get_intfdata(intf);
1860
1861         /* Disassociate driver's struct with usb interface
1862          */
1863         usb_set_intfdata(intf, NULL);
1864         if (aiptek != NULL) {
1865                 /* Free & unhook everything from the system.
1866                  */
1867                 usb_kill_urb(aiptek->urb);
1868                 input_unregister_device(aiptek->inputdev);
1869                 sysfs_remove_group(&intf->dev.kobj, &aiptek_attribute_group);
1870                 usb_free_urb(aiptek->urb);
1871                 usb_buffer_free(interface_to_usbdev(intf),
1872                                 AIPTEK_PACKET_LENGTH,
1873                                 aiptek->data, aiptek->data_dma);
1874                 kfree(aiptek);
1875         }
1876 }
1877
1878 static struct usb_driver aiptek_driver = {
1879         .name = "aiptek",
1880         .probe = aiptek_probe,
1881         .disconnect = aiptek_disconnect,
1882         .id_table = aiptek_ids,
1883 };
1884
1885 static int __init aiptek_init(void)
1886 {
1887         int result = usb_register(&aiptek_driver);
1888         if (result == 0) {
1889                 info(DRIVER_VERSION ": " DRIVER_AUTHOR);
1890                 info(DRIVER_DESC);
1891         }
1892         return result;
1893 }
1894
1895 static void __exit aiptek_exit(void)
1896 {
1897         usb_deregister(&aiptek_driver);
1898 }
1899
1900 MODULE_AUTHOR(DRIVER_AUTHOR);
1901 MODULE_DESCRIPTION(DRIVER_DESC);
1902 MODULE_LICENSE("GPL");
1903
1904 module_param(programmableDelay, int, 0);
1905 MODULE_PARM_DESC(programmableDelay, "delay used during tablet programming");
1906 module_param(jitterDelay, int, 0);
1907 MODULE_PARM_DESC(jitterDelay, "stylus/mouse settlement delay");
1908
1909 module_init(aiptek_init);
1910 module_exit(aiptek_exit);