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     0
 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     0
 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                0x01
 268 #define AIPTEK_MOUSE_RIGHT_BUTTON               0x02
 269 #define AIPTEK_MOUSE_MIDDLE_BUTTON              0x04
 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 /*
 333  * Permit easy lookup of keyboard events to send, versus
 334  * the bitmap which comes from the tablet. This hides the
 335  * issue that the F_keys are not sequentially numbered.
 336  */
 337 static const int macroKeyEvents[] = {
 338         KEY_ESC, KEY_F1, KEY_F2, KEY_F3, KEY_F4, KEY_F5,
 339         KEY_F6, KEY_F7, KEY_F8, KEY_F9, KEY_F10, KEY_F11,
 340         KEY_F12, KEY_F13, KEY_F14, KEY_F15, KEY_F16, KEY_F17,
 341         KEY_F18, KEY_F19, KEY_F20, KEY_F21, KEY_F22, KEY_F23,
 342         KEY_F24, KEY_STOP, KEY_AGAIN, KEY_PROPS, KEY_UNDO,
 343         KEY_FRONT, KEY_COPY, KEY_OPEN, KEY_PASTE, 0
 344 };
 345
 346 /***********************************************************************
 347  * Relative reports deliver values in 2's complement format to
 348  * deal with negative offsets.
 349  */
 350 static int aiptek_convert_from_2s_complement(unsigned char c)
 351 {
 352         int ret;
 353         unsigned char b = c;
 354         int negate = 0;
 355
 356         if ((b & 0x80) != 0) {
 357                 b = ~b;
 358                 b--;
 359                 negate = 1;
 360         }
 361         ret = b;
 362         ret = (negate == 1) ? -ret : ret;
 363         return ret;
 364 }
 365
 366 /***********************************************************************
 367  * aiptek_irq can receive one of six potential reports.
 368  * The documentation for each is in the body of the function.
 369  *
 370  * The tablet reports on several attributes per invocation of
 371  * aiptek_irq. Because the Linux Input Event system allows the
 372  * transmission of ONE attribute per input_report_xxx() call,
 373  * collation has to be done on the other end to reconstitute
 374  * a complete tablet report. Further, the number of Input Event reports
 375  * submitted varies, depending on what USB report type, and circumstance.
 376  * To deal with this, EV_MSC is used to indicate an 'end-of-report'
 377  * message. This has been an undocumented convention understood by the kernel
 378  * tablet driver and clients such as gpm and XFree86's tablet drivers.
 379  *
 380  * Of the information received from the tablet, the one piece I
 381  * cannot transmit is the proximity bit (without resorting to an EV_MSC
 382  * convention above.) I therefore have taken over REL_MISC and ABS_MISC
 383  * (for relative and absolute reports, respectively) for communicating
 384  * Proximity. Why two events? I thought it interesting to know if the
 385  * Proximity event occurred while the tablet was in absolute or relative
 386  * mode.
 387  *
 388  * Other tablets use the notion of a certain minimum stylus pressure
 389  * to infer proximity. While that could have been done, that is yet
 390  * another 'by convention' behavior, the documentation for which
 391  * would be spread between two (or more) pieces of software.
 392  *
 393  * EV_MSC usage was terminated for this purpose in Linux 2.5.x, and
 394  * replaced with the input_sync() method (which emits EV_SYN.)
 395  */
 396
 397 static void aiptek_irq(struct urb *urb)
 398 {
 399         struct aiptek *aiptek = urb->context;
 400         unsigned char *data = aiptek->data;
 401         struct input_dev *inputdev = aiptek->inputdev;
 402         int jitterable = 0;
 403         int retval, macro, x, y, z, left, right, middle, p, dv, tip, bs, pck;
 404
 405         switch (urb->status) {
 406         case 0:
 407                 /* Success */
 408                 break;
 409
 410         case -ECONNRESET:
 411         case -ENOENT:
 412         case -ESHUTDOWN:
 413                 /* This urb is terminated, clean up */
 414                 dbg("%s - urb shutting down with status: %d",
 415                     __FUNCTION__, urb->status);
 416                 return;
 417
 418         default:
 419                 dbg("%s - nonzero urb status received: %d",
 420                     __FUNCTION__, urb->status);
 421                 goto exit;
 422         }
 423
 424         /* See if we are in a delay loop -- throw out report if true.
 425          */
 426         if (aiptek->inDelay == 1 && time_after(aiptek->endDelay, jiffies)) {
 427                 goto exit;
 428         }
 429
 430         aiptek->inDelay = 0;
 431         aiptek->eventCount++;
 432
 433         /* Report 1 delivers relative coordinates with either a stylus
 434          * or the mouse. You do not know, however, which input
 435          * tool generated the event.
 436          */
 437         if (data[0] == 1) {
 438                 if (aiptek->curSetting.coordinateMode ==
 439                     AIPTEK_COORDINATE_ABSOLUTE_MODE) {
 440                         aiptek->diagnostic =
 441                             AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE;
 442                 } else {
 443                         x = aiptek_convert_from_2s_complement(data[2]);
 444                         y = aiptek_convert_from_2s_complement(data[3]);
 445
 446                         /* jitterable keeps track of whether any button has been pressed.
 447                          * We're also using it to remap the physical mouse button mask
 448                          * to pseudo-settings. (We don't specifically care about it's
 449                          * value after moving/transposing mouse button bitmasks, except
 450                          * that a non-zero value indicates that one or more
 451                          * mouse button was pressed.)
 452                          */
 453                         jitterable = data[5] & 0x07;
 454
 455                         left = (data[5] & aiptek->curSetting.mouseButtonLeft) != 0 ? 1 : 0;
 456                         right = (data[5] & aiptek->curSetting.mouseButtonRight) != 0 ? 1 : 0;
 457                         middle = (data[5] & aiptek->curSetting.mouseButtonMiddle) != 0 ? 1 : 0;
 458
 459                         input_report_key(inputdev, BTN_LEFT, left);
 460                         input_report_key(inputdev, BTN_MIDDLE, middle);
 461                         input_report_key(inputdev, BTN_RIGHT, right);
 462                         input_report_rel(inputdev, REL_X, x);
 463                         input_report_rel(inputdev, REL_Y, y);
 464                         input_report_rel(inputdev, REL_MISC, 1 | AIPTEK_REPORT_TOOL_UNKNOWN);
 465
 466                         /* Wheel support is in the form of a single-event
 467                          * firing.
 468                          */
 469                         if (aiptek->curSetting.wheel != AIPTEK_WHEEL_DISABLE) {
 470                                 input_report_rel(inputdev, REL_WHEEL,
 471                                                  aiptek->curSetting.wheel);
 472                                 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
 473                         }
 474                         input_sync(inputdev);
 475                 }
 476         }
 477         /* Report 2 is delivered only by the stylus, and delivers
 478          * absolute coordinates.
 479          */
 480         else if (data[0] == 2) {
 481                 if (aiptek->curSetting.coordinateMode == AIPTEK_COORDINATE_RELATIVE_MODE) {
 482                         aiptek->diagnostic = AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE;
 483                 } else if (!AIPTEK_POINTER_ALLOW_STYLUS_MODE
 484                             (aiptek->curSetting.pointerMode)) {
 485                                 aiptek->diagnostic = AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED;
 486                 } else {
 487                         x = le16_to_cpu(get_unaligned((__le16 *) (data + 1)));
 488                         y = le16_to_cpu(get_unaligned((__le16 *) (data + 3)));
 489                         z = le16_to_cpu(get_unaligned((__le16 *) (data + 6)));
 490
 491                         p = (data[5] & 0x01) != 0 ? 1 : 0;
 492                         dv = (data[5] & 0x02) != 0 ? 1 : 0;
 493                         tip = (data[5] & 0x04) != 0 ? 1 : 0;
 494
 495                         /* Use jitterable to re-arrange button masks
 496                          */
 497                         jitterable = data[5] & 0x18;
 498
 499                         bs = (data[5] & aiptek->curSetting.stylusButtonLower) != 0 ? 1 : 0;
 500                         pck = (data[5] & aiptek->curSetting.stylusButtonUpper) != 0 ? 1 : 0;
 501
 502                         /* dv indicates 'data valid' (e.g., the tablet is in sync
 503                          * and has delivered a "correct" report) We will ignore
 504                          * all 'bad' reports...
 505                          */
 506                         if (dv != 0) {
 507                                 /* If we've not already sent a tool_button_?? code, do
 508                                  * so now. Then set FIRED_BIT so it won't be resent unless
 509                                  * the user forces FIRED_BIT off.
 510                                  */
 511                                 if (TOOL_BUTTON_FIRED
 512                                     (aiptek->curSetting.toolMode) == 0) {
 513                                         input_report_key(inputdev,
 514                                                          TOOL_BUTTON(aiptek->curSetting.toolMode),
 515                                                          1);
 516                                         aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
 517                                 }
 518
 519                                 if (p != 0) {
 520                                         input_report_abs(inputdev, ABS_X, x);
 521                                         input_report_abs(inputdev, ABS_Y, y);
 522                                         input_report_abs(inputdev, ABS_PRESSURE, z);
 523
 524                                         input_report_key(inputdev, BTN_TOUCH, tip);
 525                                         input_report_key(inputdev, BTN_STYLUS, bs);
 526                                         input_report_key(inputdev, BTN_STYLUS2, pck);
 527
 528                                         if (aiptek->curSetting.xTilt !=
 529                                             AIPTEK_TILT_DISABLE) {
 530                                                 input_report_abs(inputdev,
 531                                                                  ABS_TILT_X,
 532                                                                  aiptek->curSetting.xTilt);
 533                                         }
 534                                         if (aiptek->curSetting.yTilt != AIPTEK_TILT_DISABLE) {
 535                                                 input_report_abs(inputdev,
 536                                                                  ABS_TILT_Y,
 537                                                                  aiptek->curSetting.yTilt);
 538                                         }
 539
 540                                         /* Wheel support is in the form of a single-event
 541                                          * firing.
 542                                          */
 543                                         if (aiptek->curSetting.wheel !=
 544                                             AIPTEK_WHEEL_DISABLE) {
 545                                                 input_report_abs(inputdev,
 546                                                                  ABS_WHEEL,
 547                                                                  aiptek->curSetting.wheel);
 548                                                 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
 549                                         }
 550                                 }
 551                                 input_report_abs(inputdev, ABS_MISC, p | AIPTEK_REPORT_TOOL_STYLUS);
 552                                 input_sync(inputdev);
 553                         }
 554                 }
 555         }
 556         /* Report 3's come from the mouse in absolute mode.
 557          */
 558         else if (data[0] == 3) {
 559                 if (aiptek->curSetting.coordinateMode == AIPTEK_COORDINATE_RELATIVE_MODE) {
 560                         aiptek->diagnostic = AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE;
 561                 } else if (!AIPTEK_POINTER_ALLOW_MOUSE_MODE
 562                         (aiptek->curSetting.pointerMode)) {
 563                         aiptek->diagnostic = AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED;
 564                 } else {
 565                         x = le16_to_cpu(get_unaligned((__le16 *) (data + 1)));
 566                         y = le16_to_cpu(get_unaligned((__le16 *) (data + 3)));
 567
 568                         jitterable = data[5] & 0x1c;
 569
 570                         p = (data[5] & 0x01) != 0 ? 1 : 0;
 571                         dv = (data[5] & 0x02) != 0 ? 1 : 0;
 572                         left = (data[5] & aiptek->curSetting.mouseButtonLeft) != 0 ? 1 : 0;
 573                         right = (data[5] & aiptek->curSetting.mouseButtonRight) != 0 ? 1 : 0;
 574                         middle = (data[5] & aiptek->curSetting.mouseButtonMiddle) != 0 ? 1 : 0;
 575
 576                         if (dv != 0) {
 577                                 /* If we've not already sent a tool_button_?? code, do
 578                                  * so now. Then set FIRED_BIT so it won't be resent unless
 579                                  * the user forces FIRED_BIT off.
 580                                  */
 581                                 if (TOOL_BUTTON_FIRED
 582                                     (aiptek->curSetting.toolMode) == 0) {
 583                                         input_report_key(inputdev,
 584                                                          TOOL_BUTTON(aiptek->curSetting.toolMode),
 585                                                          1);
 586                                         aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
 587                                 }
 588
 589                                 if (p != 0) {
 590                                         input_report_abs(inputdev, ABS_X, x);
 591                                         input_report_abs(inputdev, ABS_Y, y);
 592
 593                                         input_report_key(inputdev, BTN_LEFT, left);
 594                                         input_report_key(inputdev, BTN_MIDDLE, middle);
 595                                         input_report_key(inputdev, BTN_RIGHT, right);
 596
 597                                         /* Wheel support is in the form of a single-event
 598                                          * firing.
 599                                          */
 600                                         if (aiptek->curSetting.wheel != AIPTEK_WHEEL_DISABLE) {
 601                                                 input_report_abs(inputdev,
 602                                                                  ABS_WHEEL,
 603                                                                  aiptek->curSetting.wheel);
 604                                                 aiptek->curSetting.wheel = AIPTEK_WHEEL_DISABLE;
 605                                         }
 606                                 }
 607                                 input_report_rel(inputdev, REL_MISC, p | AIPTEK_REPORT_TOOL_MOUSE);
 608                                 input_sync(inputdev);
 609                         }
 610                 }
 611         }
 612         /* Report 4s come from the macro keys when pressed by stylus
 613          */
 614         else if (data[0] == 4) {
 615                 jitterable = data[1] & 0x18;
 616
 617                 p = (data[1] & 0x01) != 0 ? 1 : 0;
 618                 dv = (data[1] & 0x02) != 0 ? 1 : 0;
 619                 tip = (data[1] & 0x04) != 0 ? 1 : 0;
 620                 bs = (data[1] & aiptek->curSetting.stylusButtonLower) != 0 ? 1 : 0;
 621                 pck = (data[1] & aiptek->curSetting.stylusButtonUpper) != 0 ? 1 : 0;
 622
 623                 macro = data[3];
 624                 z = le16_to_cpu(get_unaligned((__le16 *) (data + 4)));
 625
 626                 if (dv != 0) {
 627                         /* If we've not already sent a tool_button_?? code, do
 628                          * so now. Then set FIRED_BIT so it won't be resent unless
 629                          * the user forces FIRED_BIT off.
 630                          */
 631                         if (TOOL_BUTTON_FIRED(aiptek->curSetting.toolMode) == 0) {
 632                                 input_report_key(inputdev,
 633                                                  TOOL_BUTTON(aiptek->curSetting.toolMode),
 634                                                  1);
 635                                 aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
 636                         }
 637
 638                         if (p != 0) {
 639                                 input_report_key(inputdev, BTN_TOUCH, tip);
 640                                 input_report_key(inputdev, BTN_STYLUS, bs);
 641                                 input_report_key(inputdev, BTN_STYLUS2, pck);
 642                                 input_report_abs(inputdev, ABS_PRESSURE, z);
 643                         }
 644
 645                         /* For safety, we're sending key 'break' codes for the
 646                          * neighboring macro keys.
 647                          */
 648                         if (macro > 0) {
 649                                 input_report_key(inputdev,
 650                                                  macroKeyEvents[macro - 1], 0);
 651                         }
 652                         if (macro < 25) {
 653                                 input_report_key(inputdev,
 654                                                  macroKeyEvents[macro + 1], 0);
 655                         }
 656                         input_report_key(inputdev, macroKeyEvents[macro], p);
 657                         input_report_abs(inputdev, ABS_MISC,
 658                                          p | AIPTEK_REPORT_TOOL_STYLUS);
 659                         input_sync(inputdev);
 660                 }
 661         }
 662         /* Report 5s come from the macro keys when pressed by mouse
 663          */
 664         else if (data[0] == 5) {
 665                 jitterable = data[1] & 0x1c;
 666
 667                 p = (data[1] & 0x01) != 0 ? 1 : 0;
 668                 dv = (data[1] & 0x02) != 0 ? 1 : 0;
 669                 left = (data[1]& aiptek->curSetting.mouseButtonLeft) != 0 ? 1 : 0;
 670                 right = (data[1] & aiptek->curSetting.mouseButtonRight) != 0 ? 1 : 0;
 671                 middle = (data[1] & aiptek->curSetting.mouseButtonMiddle) != 0 ? 1 : 0;
 672                 macro = data[3];
 673
 674                 if (dv != 0) {
 675                         /* If we've not already sent a tool_button_?? code, do
 676                          * so now. Then set FIRED_BIT so it won't be resent unless
 677                          * the user forces FIRED_BIT off.
 678                          */
 679                         if (TOOL_BUTTON_FIRED(aiptek->curSetting.toolMode) == 0) {
 680                                 input_report_key(inputdev,
 681                                                  TOOL_BUTTON(aiptek->curSetting.toolMode),
 682                                                  1);
 683                                 aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
 684                         }
 685
 686                         if (p != 0) {
 687                                 input_report_key(inputdev, BTN_LEFT, left);
 688                                 input_report_key(inputdev, BTN_MIDDLE, middle);
 689                                 input_report_key(inputdev, BTN_RIGHT, right);
 690                         }
 691
 692                         /* For safety, we're sending key 'break' codes for the
 693                          * neighboring macro keys.
 694                          */
 695                         if (macro > 0) {
 696                                 input_report_key(inputdev,
 697                                                  macroKeyEvents[macro - 1], 0);
 698                         }
 699                         if (macro < 25) {
 700                                 input_report_key(inputdev,
 701                                                  macroKeyEvents[macro + 1], 0);
 702                         }
 703
 704                         input_report_key(inputdev, macroKeyEvents[macro], 1);
 705                         input_report_rel(inputdev, ABS_MISC,
 706                                          p | AIPTEK_REPORT_TOOL_MOUSE);
 707                         input_sync(inputdev);
 708                 }
 709         }
 710         /* We have no idea which tool can generate a report 6. Theoretically,
 711          * neither need to, having been given reports 4 & 5 for such use.
 712          * However, report 6 is the 'official-looking' report for macroKeys;
 713          * reports 4 & 5 supposively are used to support unnamed, unknown
 714          * hat switches (which just so happen to be the macroKeys.)
 715          */
 716         else if (data[0] == 6) {
 717                 macro = le16_to_cpu(get_unaligned((__le16 *) (data + 1)));
 718                 if (macro > 0) {
 719                         input_report_key(inputdev, macroKeyEvents[macro - 1],
 720                                          0);
 721                 }
 722                 if (macro < 25) {
 723                         input_report_key(inputdev, macroKeyEvents[macro + 1],
 724                                          0);
 725                 }
 726
 727                 /* If we've not already sent a tool_button_?? code, do
 728                  * so now. Then set FIRED_BIT so it won't be resent unless
 729                  * the user forces FIRED_BIT off.
 730                  */
 731                 if (TOOL_BUTTON_FIRED(aiptek->curSetting.toolMode) == 0) {
 732                         input_report_key(inputdev,
 733                                          TOOL_BUTTON(aiptek->curSetting.
 734                                                      toolMode), 1);
 735                         aiptek->curSetting.toolMode |= TOOL_BUTTON_FIRED_BIT;
 736                 }
 737
 738                 input_report_key(inputdev, macroKeyEvents[macro], 1);
 739                 input_report_abs(inputdev, ABS_MISC,
 740                                  1 | AIPTEK_REPORT_TOOL_UNKNOWN);
 741                 input_sync(inputdev);
 742         } else {
 743                 dbg("Unknown report %d", data[0]);
 744         }
 745
 746         /* Jitter may occur when the user presses a button on the stlyus
 747          * or the mouse. What we do to prevent that is wait 'x' milliseconds
 748          * following a 'jitterable' event, which should give the hand some time
 749          * stabilize itself.
 750          *
 751          * We just introduced aiptek->previousJitterable to carry forth the
 752          * notion that jitter occurs when the button state changes from on to off:
 753          * a person drawing, holding a button down is not subject to jittering.
 754          * With that in mind, changing from upper button depressed to lower button
 755          * WILL transition through a jitter delay.
 756          */
 757
 758         if (aiptek->previousJitterable != jitterable &&
 759             aiptek->curSetting.jitterDelay != 0 && aiptek->inDelay != 1) {
 760                 aiptek->endDelay = jiffies +
 761                     ((aiptek->curSetting.jitterDelay * HZ) / 1000);
 762                 aiptek->inDelay = 1;
 763         }
 764         aiptek->previousJitterable = jitterable;
 765
 766 exit:
 767         retval = usb_submit_urb(urb, GFP_ATOMIC);
 768         if (retval != 0) {
 769                 err("%s - usb_submit_urb failed with result %d",
 770                     __FUNCTION__, retval);
 771         }
 772 }
 773
 774 /***********************************************************************
 775  * These are the USB id's known so far. We do not identify them to
 776  * specific Aiptek model numbers, because there has been overlaps,
 777  * use, and reuse of id's in existing models. Certain models have
 778  * been known to use more than one ID, indicative perhaps of
 779  * manufacturing revisions. In any event, we consider these
 780  * IDs to not be model-specific nor unique.
 781  */
 782 static const struct usb_device_id aiptek_ids[] = {
 783         {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x01)},
 784         {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x10)},
 785         {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x20)},
 786         {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x21)},
 787         {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x22)},
 788         {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x23)},
 789         {USB_DEVICE(USB_VENDOR_ID_AIPTEK, 0x24)},
 790         {}
 791 };
 792
 793 MODULE_DEVICE_TABLE(usb, aiptek_ids);
 794
 795 /***********************************************************************
 796  * Open an instance of the tablet driver.
 797  */
 798 static int aiptek_open(struct input_dev *inputdev)
 799 {
 800         struct aiptek *aiptek = input_get_drvdata(inputdev);
 801
 802         aiptek->urb->dev = aiptek->usbdev;
 803         if (usb_submit_urb(aiptek->urb, GFP_KERNEL) != 0)
 804                 return -EIO;
 805
 806         return 0;
 807 }
 808
 809 /***********************************************************************
 810  * Close an instance of the tablet driver.
 811  */
 812 static void aiptek_close(struct input_dev *inputdev)
 813 {
 814         struct aiptek *aiptek = input_get_drvdata(inputdev);
 815
 816         usb_kill_urb(aiptek->urb);
 817 }
 818
 819 /***********************************************************************
 820  * aiptek_set_report and aiptek_get_report() are borrowed from Linux 2.4.x,
 821  * where they were known as usb_set_report and usb_get_report.
 822  */
 823 static int
 824 aiptek_set_report(struct aiptek *aiptek,
 825                   unsigned char report_type,
 826                   unsigned char report_id, void *buffer, int size)
 827 {
 828         return usb_control_msg(aiptek->usbdev,
 829                                usb_sndctrlpipe(aiptek->usbdev, 0),
 830                                USB_REQ_SET_REPORT,
 831                                USB_TYPE_CLASS | USB_RECIP_INTERFACE |
 832                                USB_DIR_OUT, (report_type << 8) + report_id,
 833                                aiptek->ifnum, buffer, size, 5000);
 834 }
 835
 836 static int
 837 aiptek_get_report(struct aiptek *aiptek,
 838                   unsigned char report_type,
 839                   unsigned char report_id, void *buffer, int size)
 840 {
 841         return usb_control_msg(aiptek->usbdev,
 842                                usb_rcvctrlpipe(aiptek->usbdev, 0),
 843                                USB_REQ_GET_REPORT,
 844                                USB_TYPE_CLASS | USB_RECIP_INTERFACE |
 845                                USB_DIR_IN, (report_type << 8) + report_id,
 846                                aiptek->ifnum, buffer, size, 5000);
 847 }
 848
 849 /***********************************************************************
 850  * Send a command to the tablet.
 851  */
 852 static int
 853 aiptek_command(struct aiptek *aiptek, unsigned char command, unsigned char data)
 854 {
 855         const int sizeof_buf = 3 * sizeof(u8);
 856         int ret;
 857         u8 *buf;
 858
 859         buf = kmalloc(sizeof_buf, GFP_KERNEL);
 860         if (!buf)
 861                 return -ENOMEM;
 862
 863         buf[0] = 2;
 864         buf[1] = command;
 865         buf[2] = data;
 866
 867         if ((ret =
 868              aiptek_set_report(aiptek, 3, 2, buf, sizeof_buf)) != sizeof_buf) {
 869                 dbg("aiptek_program: failed, tried to send: 0x%02x 0x%02x",
 870                     command, data);
 871         }
 872         kfree(buf);
 873         return ret < 0 ? ret : 0;
 874 }
 875
 876 /***********************************************************************
 877  * Retrieve information from the tablet. Querying info is defined as first
 878  * sending the {command,data} sequence as a command, followed by a wait
 879  * (aka, "programmaticDelay") and then a "read" request.
 880  */
 881 static int
 882 aiptek_query(struct aiptek *aiptek, unsigned char command, unsigned char data)
 883 {
 884         const int sizeof_buf = 3 * sizeof(u8);
 885         int ret;
 886         u8 *buf;
 887
 888         buf = kmalloc(sizeof_buf, GFP_KERNEL);
 889         if (!buf)
 890                 return -ENOMEM;
 891
 892         buf[0] = 2;
 893         buf[1] = command;
 894         buf[2] = data;
 895
 896         if (aiptek_command(aiptek, command, data) != 0) {
 897                 kfree(buf);
 898                 return -EIO;
 899         }
 900         msleep(aiptek->curSetting.programmableDelay);
 901
 902         if ((ret =
 903              aiptek_get_report(aiptek, 3, 2, buf, sizeof_buf)) != sizeof_buf) {
 904                 dbg("aiptek_query failed: returned 0x%02x 0x%02x 0x%02x",
 905                     buf[0], buf[1], buf[2]);
 906                 ret = -EIO;
 907         } else {
 908                 ret = le16_to_cpu(get_unaligned((__le16 *) (buf + 1)));
 909         }
 910         kfree(buf);
 911         return ret;
 912 }
 913
 914 /***********************************************************************
 915  * Program the tablet into either absolute or relative mode.
 916  * We also get information about the tablet's size.
 917  */
 918 static int aiptek_program_tablet(struct aiptek *aiptek)
 919 {
 920         int ret;
 921         /* Execute Resolution500LPI */
 922         if ((ret = aiptek_command(aiptek, 0x18, 0x04)) < 0)
 923                 return ret;
 924
 925         /* Query getModelCode */
 926         if ((ret = aiptek_query(aiptek, 0x02, 0x00)) < 0)
 927                 return ret;
 928         aiptek->features.modelCode = ret & 0xff;
 929
 930         /* Query getODMCode */
 931         if ((ret = aiptek_query(aiptek, 0x03, 0x00)) < 0)
 932                 return ret;
 933         aiptek->features.odmCode = ret;
 934
 935         /* Query getFirmwareCode */
 936         if ((ret = aiptek_query(aiptek, 0x04, 0x00)) < 0)
 937                 return ret;
 938         aiptek->features.firmwareCode = ret;
 939
 940         /* Query getXextension */
 941         if ((ret = aiptek_query(aiptek, 0x01, 0x00)) < 0)
 942                 return ret;
 943         aiptek->inputdev->absmin[ABS_X] = 0;
 944         aiptek->inputdev->absmax[ABS_X] = ret - 1;
 945
 946         /* Query getYextension */
 947         if ((ret = aiptek_query(aiptek, 0x01, 0x01)) < 0)
 948                 return ret;
 949         aiptek->inputdev->absmin[ABS_Y] = 0;
 950         aiptek->inputdev->absmax[ABS_Y] = ret - 1;
 951
 952         /* Query getPressureLevels */
 953         if ((ret = aiptek_query(aiptek, 0x08, 0x00)) < 0)
 954                 return ret;
 955         aiptek->inputdev->absmin[ABS_PRESSURE] = 0;
 956         aiptek->inputdev->absmax[ABS_PRESSURE] = ret - 1;
 957
 958         /* Depending on whether we are in absolute or relative mode, we will
 959          * do a switchToTablet(absolute) or switchToMouse(relative) command.
 960          */
 961         if (aiptek->curSetting.coordinateMode ==
 962             AIPTEK_COORDINATE_ABSOLUTE_MODE) {
 963                 /* Execute switchToTablet */
 964                 if ((ret = aiptek_command(aiptek, 0x10, 0x01)) < 0) {
 965                         return ret;
 966                 }
 967         } else {
 968                 /* Execute switchToMouse */
 969                 if ((ret = aiptek_command(aiptek, 0x10, 0x00)) < 0) {
 970                         return ret;
 971                 }
 972         }
 973
 974         /* Enable the macro keys */
 975         if ((ret = aiptek_command(aiptek, 0x11, 0x02)) < 0)
 976                 return ret;
 977 #if 0
 978         /* Execute FilterOn */
 979         if ((ret = aiptek_command(aiptek, 0x17, 0x00)) < 0)
 980                 return ret;
 981 #endif
 982
 983         /* Execute AutoGainOn */
 984         if ((ret = aiptek_command(aiptek, 0x12, 0xff)) < 0)
 985                 return ret;
 986
 987         /* Reset the eventCount, so we track events from last (re)programming
 988          */
 989         aiptek->diagnostic = AIPTEK_DIAGNOSTIC_NA;
 990         aiptek->eventCount = 0;
 991
 992         return 0;
 993 }
 994
 995 /***********************************************************************
 996  * Sysfs functions. Sysfs prefers that individually-tunable parameters
 997  * exist in their separate pseudo-files. Summary data that is immutable
 998  * may exist in a singular file so long as you don't define a writeable
 999  * interface.
1000  */
1001
1002 /***********************************************************************
1003  * support the 'size' file -- display support
1004  */
1005 static ssize_t show_tabletSize(struct device *dev, struct device_attribute *attr, char *buf)
1006 {
1007         struct aiptek *aiptek = dev_get_drvdata(dev);
1008
1009         if (aiptek == NULL)
1010                 return 0;
1011
1012         return snprintf(buf, PAGE_SIZE, "%dx%d\n",
1013                         aiptek->inputdev->absmax[ABS_X] + 1,
1014                         aiptek->inputdev->absmax[ABS_Y] + 1);
1015 }
1016
1017 /* These structs define the sysfs files, param #1 is the name of the
1018  * file, param 2 is the file permissions, param 3 & 4 are to the
1019  * output generator and input parser routines. Absence of a routine is
1020  * permitted -- it only means can't either 'cat' the file, or send data
1021  * to it.
1022  */
1023 static DEVICE_ATTR(size, S_IRUGO, show_tabletSize, NULL);
1024
1025 /***********************************************************************
1026  * support routines for the 'product_id' file
1027  */
1028 static ssize_t show_tabletProductId(struct device *dev, struct device_attribute *attr, char *buf)
1029 {
1030         struct aiptek *aiptek = dev_get_drvdata(dev);
1031
1032         if (aiptek == NULL)
1033                 return 0;
1034
1035         return snprintf(buf, PAGE_SIZE, "0x%04x\n",
1036                         aiptek->inputdev->id.product);
1037 }
1038
1039 static DEVICE_ATTR(product_id, S_IRUGO, show_tabletProductId, NULL);
1040
1041 /***********************************************************************
1042  * support routines for the 'vendor_id' file
1043  */
1044 static ssize_t show_tabletVendorId(struct device *dev, struct device_attribute *attr, char *buf)
1045 {
1046         struct aiptek *aiptek = dev_get_drvdata(dev);
1047
1048         if (aiptek == NULL)
1049                 return 0;
1050
1051         return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->inputdev->id.vendor);
1052 }
1053
1054 static DEVICE_ATTR(vendor_id, S_IRUGO, show_tabletVendorId, NULL);
1055
1056 /***********************************************************************
1057  * support routines for the 'vendor' file
1058  */
1059 static ssize_t show_tabletManufacturer(struct device *dev, struct device_attribute *attr, char *buf)
1060 {
1061         struct aiptek *aiptek = dev_get_drvdata(dev);
1062         int retval;
1063
1064         if (aiptek == NULL)
1065                 return 0;
1066
1067         retval = snprintf(buf, PAGE_SIZE, "%s\n", aiptek->usbdev->manufacturer);
1068         return retval;
1069 }
1070
1071 static DEVICE_ATTR(vendor, S_IRUGO, show_tabletManufacturer, NULL);
1072
1073 /***********************************************************************
1074  * support routines for the 'product' file
1075  */
1076 static ssize_t show_tabletProduct(struct device *dev, struct device_attribute *attr, char *buf)
1077 {
1078         struct aiptek *aiptek = dev_get_drvdata(dev);
1079         int retval;
1080
1081         if (aiptek == NULL)
1082                 return 0;
1083
1084         retval = snprintf(buf, PAGE_SIZE, "%s\n", aiptek->usbdev->product);
1085         return retval;
1086 }
1087
1088 static DEVICE_ATTR(product, S_IRUGO, show_tabletProduct, NULL);
1089
1090 /***********************************************************************
1091  * support routines for the 'pointer_mode' file. Note that this file
1092  * both displays current setting and allows reprogramming.
1093  */
1094 static ssize_t show_tabletPointerMode(struct device *dev, struct device_attribute *attr, char *buf)
1095 {
1096         struct aiptek *aiptek = dev_get_drvdata(dev);
1097         char *s;
1098
1099         if (aiptek == NULL)
1100                 return 0;
1101
1102         switch (aiptek->curSetting.pointerMode) {
1103         case AIPTEK_POINTER_ONLY_STYLUS_MODE:
1104                 s = "stylus";
1105                 break;
1106
1107         case AIPTEK_POINTER_ONLY_MOUSE_MODE:
1108                 s = "mouse";
1109                 break;
1110
1111         case AIPTEK_POINTER_EITHER_MODE:
1112                 s = "either";
1113                 break;
1114
1115         default:
1116                 s = "unknown";
1117                 break;
1118         }
1119         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1120 }
1121
1122 static ssize_t
1123 store_tabletPointerMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1124 {
1125         struct aiptek *aiptek = dev_get_drvdata(dev);
1126         if (aiptek == NULL)
1127                 return 0;
1128
1129         if (strcmp(buf, "stylus") == 0) {
1130                 aiptek->newSetting.pointerMode =
1131                     AIPTEK_POINTER_ONLY_STYLUS_MODE;
1132         } else if (strcmp(buf, "mouse") == 0) {
1133                 aiptek->newSetting.pointerMode = AIPTEK_POINTER_ONLY_MOUSE_MODE;
1134         } else if (strcmp(buf, "either") == 0) {
1135                 aiptek->newSetting.pointerMode = AIPTEK_POINTER_EITHER_MODE;
1136         }
1137         return count;
1138 }
1139
1140 static DEVICE_ATTR(pointer_mode,
1141                    S_IRUGO | S_IWUGO,
1142                    show_tabletPointerMode, store_tabletPointerMode);
1143
1144 /***********************************************************************
1145  * support routines for the 'coordinate_mode' file. Note that this file
1146  * both displays current setting and allows reprogramming.
1147  */
1148 static ssize_t show_tabletCoordinateMode(struct device *dev, struct device_attribute *attr, char *buf)
1149 {
1150         struct aiptek *aiptek = dev_get_drvdata(dev);
1151         char *s;
1152
1153         if (aiptek == NULL)
1154                 return 0;
1155
1156         switch (aiptek->curSetting.coordinateMode) {
1157         case AIPTEK_COORDINATE_ABSOLUTE_MODE:
1158                 s = "absolute";
1159                 break;
1160
1161         case AIPTEK_COORDINATE_RELATIVE_MODE:
1162                 s = "relative";
1163                 break;
1164
1165         default:
1166                 s = "unknown";
1167                 break;
1168         }
1169         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1170 }
1171
1172 static ssize_t
1173 store_tabletCoordinateMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1174 {
1175         struct aiptek *aiptek = dev_get_drvdata(dev);
1176         if (aiptek == NULL)
1177                 return 0;
1178
1179         if (strcmp(buf, "absolute") == 0) {
1180                 aiptek->newSetting.pointerMode =
1181                     AIPTEK_COORDINATE_ABSOLUTE_MODE;
1182         } else if (strcmp(buf, "relative") == 0) {
1183                 aiptek->newSetting.pointerMode =
1184                     AIPTEK_COORDINATE_RELATIVE_MODE;
1185         }
1186         return count;
1187 }
1188
1189 static DEVICE_ATTR(coordinate_mode,
1190                    S_IRUGO | S_IWUGO,
1191                    show_tabletCoordinateMode, store_tabletCoordinateMode);
1192
1193 /***********************************************************************
1194  * support routines for the 'tool_mode' file. Note that this file
1195  * both displays current setting and allows reprogramming.
1196  */
1197 static ssize_t show_tabletToolMode(struct device *dev, struct device_attribute *attr, char *buf)
1198 {
1199         struct aiptek *aiptek = dev_get_drvdata(dev);
1200         char *s;
1201
1202         if (aiptek == NULL)
1203                 return 0;
1204
1205         switch (TOOL_BUTTON(aiptek->curSetting.toolMode)) {
1206         case AIPTEK_TOOL_BUTTON_MOUSE_MODE:
1207                 s = "mouse";
1208                 break;
1209
1210         case AIPTEK_TOOL_BUTTON_ERASER_MODE:
1211                 s = "eraser";
1212                 break;
1213
1214         case AIPTEK_TOOL_BUTTON_PENCIL_MODE:
1215                 s = "pencil";
1216                 break;
1217
1218         case AIPTEK_TOOL_BUTTON_PEN_MODE:
1219                 s = "pen";
1220                 break;
1221
1222         case AIPTEK_TOOL_BUTTON_BRUSH_MODE:
1223                 s = "brush";
1224                 break;
1225
1226         case AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE:
1227                 s = "airbrush";
1228                 break;
1229
1230         case AIPTEK_TOOL_BUTTON_LENS_MODE:
1231                 s = "lens";
1232                 break;
1233
1234         default:
1235                 s = "unknown";
1236                 break;
1237         }
1238         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1239 }
1240
1241 static ssize_t
1242 store_tabletToolMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1243 {
1244         struct aiptek *aiptek = dev_get_drvdata(dev);
1245         if (aiptek == NULL)
1246                 return 0;
1247
1248         if (strcmp(buf, "mouse") == 0) {
1249                 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_MOUSE_MODE;
1250         } else if (strcmp(buf, "eraser") == 0) {
1251                 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_ERASER_MODE;
1252         } else if (strcmp(buf, "pencil") == 0) {
1253                 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_PENCIL_MODE;
1254         } else if (strcmp(buf, "pen") == 0) {
1255                 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_PEN_MODE;
1256         } else if (strcmp(buf, "brush") == 0) {
1257                 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_BRUSH_MODE;
1258         } else if (strcmp(buf, "airbrush") == 0) {
1259                 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE;
1260         } else if (strcmp(buf, "lens") == 0) {
1261                 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_LENS_MODE;
1262         }
1263
1264         return count;
1265 }
1266
1267 static DEVICE_ATTR(tool_mode,
1268                    S_IRUGO | S_IWUGO,
1269                    show_tabletToolMode, store_tabletToolMode);
1270
1271 /***********************************************************************
1272  * support routines for the 'xtilt' file. Note that this file
1273  * both displays current setting and allows reprogramming.
1274  */
1275 static ssize_t show_tabletXtilt(struct device *dev, struct device_attribute *attr, char *buf)
1276 {
1277         struct aiptek *aiptek = dev_get_drvdata(dev);
1278
1279         if (aiptek == NULL)
1280                 return 0;
1281
1282         if (aiptek->curSetting.xTilt == AIPTEK_TILT_DISABLE) {
1283                 return snprintf(buf, PAGE_SIZE, "disable\n");
1284         } else {
1285                 return snprintf(buf, PAGE_SIZE, "%d\n",
1286                                 aiptek->curSetting.xTilt);
1287         }
1288 }
1289
1290 static ssize_t
1291 store_tabletXtilt(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1292 {
1293         struct aiptek *aiptek = dev_get_drvdata(dev);
1294         int x;
1295
1296         if (aiptek == NULL)
1297                 return 0;
1298
1299         if (strcmp(buf, "disable") == 0) {
1300                 aiptek->newSetting.xTilt = AIPTEK_TILT_DISABLE;
1301         } else {
1302                 x = (int)simple_strtol(buf, NULL, 10);
1303                 if (x >= AIPTEK_TILT_MIN && x <= AIPTEK_TILT_MAX) {
1304                         aiptek->newSetting.xTilt = x;
1305                 }
1306         }
1307         return count;
1308 }
1309
1310 static DEVICE_ATTR(xtilt,
1311                    S_IRUGO | S_IWUGO, show_tabletXtilt, store_tabletXtilt);
1312
1313 /***********************************************************************
1314  * support routines for the 'ytilt' file. Note that this file
1315  * both displays current setting and allows reprogramming.
1316  */
1317 static ssize_t show_tabletYtilt(struct device *dev, struct device_attribute *attr, char *buf)
1318 {
1319         struct aiptek *aiptek = dev_get_drvdata(dev);
1320
1321         if (aiptek == NULL)
1322                 return 0;
1323
1324         if (aiptek->curSetting.yTilt == AIPTEK_TILT_DISABLE) {
1325                 return snprintf(buf, PAGE_SIZE, "disable\n");
1326         } else {
1327                 return snprintf(buf, PAGE_SIZE, "%d\n",
1328                                 aiptek->curSetting.yTilt);
1329         }
1330 }
1331
1332 static ssize_t
1333 store_tabletYtilt(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1334 {
1335         struct aiptek *aiptek = dev_get_drvdata(dev);
1336         int y;
1337
1338         if (aiptek == NULL)
1339                 return 0;
1340
1341         if (strcmp(buf, "disable") == 0) {
1342                 aiptek->newSetting.yTilt = AIPTEK_TILT_DISABLE;
1343         } else {
1344                 y = (int)simple_strtol(buf, NULL, 10);
1345                 if (y >= AIPTEK_TILT_MIN && y <= AIPTEK_TILT_MAX) {
1346                         aiptek->newSetting.yTilt = y;
1347                 }
1348         }
1349         return count;
1350 }
1351
1352 static DEVICE_ATTR(ytilt,
1353                    S_IRUGO | S_IWUGO, show_tabletYtilt, store_tabletYtilt);
1354
1355 /***********************************************************************
1356  * support routines for the 'jitter' file. Note that this file
1357  * both displays current setting and allows reprogramming.
1358  */
1359 static ssize_t show_tabletJitterDelay(struct device *dev, struct device_attribute *attr, char *buf)
1360 {
1361         struct aiptek *aiptek = dev_get_drvdata(dev);
1362
1363         if (aiptek == NULL)
1364                 return 0;
1365
1366         return snprintf(buf, PAGE_SIZE, "%d\n", aiptek->curSetting.jitterDelay);
1367 }
1368
1369 static ssize_t
1370 store_tabletJitterDelay(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1371 {
1372         struct aiptek *aiptek = dev_get_drvdata(dev);
1373
1374         if (aiptek == NULL)
1375                 return 0;
1376
1377         aiptek->newSetting.jitterDelay = (int)simple_strtol(buf, NULL, 10);
1378         return count;
1379 }
1380
1381 static DEVICE_ATTR(jitter,
1382                    S_IRUGO | S_IWUGO,
1383                    show_tabletJitterDelay, store_tabletJitterDelay);
1384
1385 /***********************************************************************
1386  * support routines for the 'delay' file. Note that this file
1387  * both displays current setting and allows reprogramming.
1388  */
1389 static ssize_t show_tabletProgrammableDelay(struct device *dev, struct device_attribute *attr, char *buf)
1390 {
1391         struct aiptek *aiptek = dev_get_drvdata(dev);
1392
1393         if (aiptek == NULL)
1394                 return 0;
1395
1396         return snprintf(buf, PAGE_SIZE, "%d\n",
1397                         aiptek->curSetting.programmableDelay);
1398 }
1399
1400 static ssize_t
1401 store_tabletProgrammableDelay(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1402 {
1403         struct aiptek *aiptek = dev_get_drvdata(dev);
1404
1405         if (aiptek == NULL)
1406                 return 0;
1407
1408         aiptek->newSetting.programmableDelay = (int)simple_strtol(buf, NULL, 10);
1409         return count;
1410 }
1411
1412 static DEVICE_ATTR(delay,
1413                    S_IRUGO | S_IWUGO,
1414                    show_tabletProgrammableDelay, store_tabletProgrammableDelay);
1415
1416 /***********************************************************************
1417  * support routines for the 'event_count' file. Note that this file
1418  * only displays current setting.
1419  */
1420 static ssize_t show_tabletEventsReceived(struct device *dev, struct device_attribute *attr, char *buf)
1421 {
1422         struct aiptek *aiptek = dev_get_drvdata(dev);
1423
1424         if (aiptek == NULL)
1425                 return 0;
1426
1427         return snprintf(buf, PAGE_SIZE, "%ld\n", aiptek->eventCount);
1428 }
1429
1430 static DEVICE_ATTR(event_count, S_IRUGO, show_tabletEventsReceived, NULL);
1431
1432 /***********************************************************************
1433  * support routines for the 'diagnostic' file. Note that this file
1434  * only displays current setting.
1435  */
1436 static ssize_t show_tabletDiagnosticMessage(struct device *dev, struct device_attribute *attr, char *buf)
1437 {
1438         struct aiptek *aiptek = dev_get_drvdata(dev);
1439         char *retMsg;
1440
1441         if (aiptek == NULL)
1442                 return 0;
1443
1444         switch (aiptek->diagnostic) {
1445         case AIPTEK_DIAGNOSTIC_NA:
1446                 retMsg = "no errors\n";
1447                 break;
1448
1449         case AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE:
1450                 retMsg = "Error: receiving relative reports\n";
1451                 break;
1452
1453         case AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE:
1454                 retMsg = "Error: receiving absolute reports\n";
1455                 break;
1456
1457         case AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED:
1458                 if (aiptek->curSetting.pointerMode ==
1459                     AIPTEK_POINTER_ONLY_MOUSE_MODE) {
1460                         retMsg = "Error: receiving stylus reports\n";
1461                 } else {
1462                         retMsg = "Error: receiving mouse reports\n";
1463                 }
1464                 break;
1465
1466         default:
1467                 return 0;
1468         }
1469         return snprintf(buf, PAGE_SIZE, retMsg);
1470 }
1471
1472 static DEVICE_ATTR(diagnostic, S_IRUGO, show_tabletDiagnosticMessage, NULL);
1473
1474 /***********************************************************************
1475  * support routines for the 'stylus_upper' file. Note that this file
1476  * both displays current setting and allows for setting changing.
1477  */
1478 static ssize_t show_tabletStylusUpper(struct device *dev, struct device_attribute *attr, char *buf)
1479 {
1480         struct aiptek *aiptek = dev_get_drvdata(dev);
1481         char *s;
1482
1483         if (aiptek == NULL)
1484                 return 0;
1485
1486         switch (aiptek->curSetting.stylusButtonUpper) {
1487         case AIPTEK_STYLUS_UPPER_BUTTON:
1488                 s = "upper";
1489                 break;
1490
1491         case AIPTEK_STYLUS_LOWER_BUTTON:
1492                 s = "lower";
1493                 break;
1494
1495         default:
1496                 s = "unknown";
1497                 break;
1498         }
1499         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1500 }
1501
1502 static ssize_t
1503 store_tabletStylusUpper(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1504 {
1505         struct aiptek *aiptek = dev_get_drvdata(dev);
1506
1507         if (aiptek == NULL)
1508                 return 0;
1509
1510         if (strcmp(buf, "upper") == 0) {
1511                 aiptek->newSetting.stylusButtonUpper =
1512                     AIPTEK_STYLUS_UPPER_BUTTON;
1513         } else if (strcmp(buf, "lower") == 0) {
1514                 aiptek->newSetting.stylusButtonUpper =
1515                     AIPTEK_STYLUS_LOWER_BUTTON;
1516         }
1517         return count;
1518 }
1519
1520 static DEVICE_ATTR(stylus_upper,
1521                    S_IRUGO | S_IWUGO,
1522                    show_tabletStylusUpper, store_tabletStylusUpper);
1523
1524 /***********************************************************************
1525  * support routines for the 'stylus_lower' file. Note that this file
1526  * both displays current setting and allows for setting changing.
1527  */
1528 static ssize_t show_tabletStylusLower(struct device *dev, struct device_attribute *attr, char *buf)
1529 {
1530         struct aiptek *aiptek = dev_get_drvdata(dev);
1531         char *s;
1532
1533         if (aiptek == NULL)
1534                 return 0;
1535
1536         switch (aiptek->curSetting.stylusButtonLower) {
1537         case AIPTEK_STYLUS_UPPER_BUTTON:
1538                 s = "upper";
1539                 break;
1540
1541         case AIPTEK_STYLUS_LOWER_BUTTON:
1542                 s = "lower";
1543                 break;
1544
1545         default:
1546                 s = "unknown";
1547                 break;
1548         }
1549         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1550 }
1551
1552 static ssize_t
1553 store_tabletStylusLower(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1554 {
1555         struct aiptek *aiptek = dev_get_drvdata(dev);
1556
1557         if (aiptek == NULL)
1558                 return 0;
1559
1560         if (strcmp(buf, "upper") == 0) {
1561                 aiptek->newSetting.stylusButtonLower =
1562                     AIPTEK_STYLUS_UPPER_BUTTON;
1563         } else if (strcmp(buf, "lower") == 0) {
1564                 aiptek->newSetting.stylusButtonLower =
1565                     AIPTEK_STYLUS_LOWER_BUTTON;
1566         }
1567         return count;
1568 }
1569
1570 static DEVICE_ATTR(stylus_lower,
1571                    S_IRUGO | S_IWUGO,
1572                    show_tabletStylusLower, store_tabletStylusLower);
1573
1574 /***********************************************************************
1575  * support routines for the 'mouse_left' file. Note that this file
1576  * both displays current setting and allows for setting changing.
1577  */
1578 static ssize_t show_tabletMouseLeft(struct device *dev, struct device_attribute *attr, char *buf)
1579 {
1580         struct aiptek *aiptek = dev_get_drvdata(dev);
1581         char *s;
1582
1583         if (aiptek == NULL)
1584                 return 0;
1585
1586         switch (aiptek->curSetting.mouseButtonLeft) {
1587         case AIPTEK_MOUSE_LEFT_BUTTON:
1588                 s = "left";
1589                 break;
1590
1591         case AIPTEK_MOUSE_MIDDLE_BUTTON:
1592                 s = "middle";
1593                 break;
1594
1595         case AIPTEK_MOUSE_RIGHT_BUTTON:
1596                 s = "right";
1597                 break;
1598
1599         default:
1600                 s = "unknown";
1601                 break;
1602         }
1603         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1604 }
1605
1606 static ssize_t
1607 store_tabletMouseLeft(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1608 {
1609         struct aiptek *aiptek = dev_get_drvdata(dev);
1610
1611         if (aiptek == NULL)
1612                 return 0;
1613
1614         if (strcmp(buf, "left") == 0) {
1615                 aiptek->newSetting.mouseButtonLeft = AIPTEK_MOUSE_LEFT_BUTTON;
1616         } else if (strcmp(buf, "middle") == 0) {
1617                 aiptek->newSetting.mouseButtonLeft = AIPTEK_MOUSE_MIDDLE_BUTTON;
1618         } else if (strcmp(buf, "right") == 0) {
1619                 aiptek->newSetting.mouseButtonLeft = AIPTEK_MOUSE_RIGHT_BUTTON;
1620         }
1621         return count;
1622 }
1623
1624 static DEVICE_ATTR(mouse_left,
1625                    S_IRUGO | S_IWUGO,
1626                    show_tabletMouseLeft, store_tabletMouseLeft);
1627
1628 /***********************************************************************
1629  * support routines for the 'mouse_middle' file. Note that this file
1630  * both displays current setting and allows for setting changing.
1631  */
1632 static ssize_t show_tabletMouseMiddle(struct device *dev, struct device_attribute *attr, char *buf)
1633 {
1634         struct aiptek *aiptek = dev_get_drvdata(dev);
1635         char *s;
1636
1637         if (aiptek == NULL)
1638                 return 0;
1639
1640         switch (aiptek->curSetting.mouseButtonMiddle) {
1641         case AIPTEK_MOUSE_LEFT_BUTTON:
1642                 s = "left";
1643                 break;
1644
1645         case AIPTEK_MOUSE_MIDDLE_BUTTON:
1646                 s = "middle";
1647                 break;
1648
1649         case AIPTEK_MOUSE_RIGHT_BUTTON:
1650                 s = "right";
1651                 break;
1652
1653         default:
1654                 s = "unknown";
1655                 break;
1656         }
1657         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1658 }
1659
1660 static ssize_t
1661 store_tabletMouseMiddle(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1662 {
1663         struct aiptek *aiptek = dev_get_drvdata(dev);
1664
1665         if (aiptek == NULL)
1666                 return 0;
1667
1668         if (strcmp(buf, "left") == 0) {
1669                 aiptek->newSetting.mouseButtonMiddle = AIPTEK_MOUSE_LEFT_BUTTON;
1670         } else if (strcmp(buf, "middle") == 0) {
1671                 aiptek->newSetting.mouseButtonMiddle =
1672                     AIPTEK_MOUSE_MIDDLE_BUTTON;
1673         } else if (strcmp(buf, "right") == 0) {
1674                 aiptek->newSetting.mouseButtonMiddle =
1675                     AIPTEK_MOUSE_RIGHT_BUTTON;
1676         }
1677         return count;
1678 }
1679
1680 static DEVICE_ATTR(mouse_middle,
1681                    S_IRUGO | S_IWUGO,
1682                    show_tabletMouseMiddle, store_tabletMouseMiddle);
1683
1684 /***********************************************************************
1685  * support routines for the 'mouse_right' file. Note that this file
1686  * both displays current setting and allows for setting changing.
1687  */
1688 static ssize_t show_tabletMouseRight(struct device *dev, struct device_attribute *attr, char *buf)
1689 {
1690         struct aiptek *aiptek = dev_get_drvdata(dev);
1691         char *s;
1692
1693         if (aiptek == NULL)
1694                 return 0;
1695
1696         switch (aiptek->curSetting.mouseButtonRight) {
1697         case AIPTEK_MOUSE_LEFT_BUTTON:
1698                 s = "left";
1699                 break;
1700
1701         case AIPTEK_MOUSE_MIDDLE_BUTTON:
1702                 s = "middle";
1703                 break;
1704
1705         case AIPTEK_MOUSE_RIGHT_BUTTON:
1706                 s = "right";
1707                 break;
1708
1709         default:
1710                 s = "unknown";
1711                 break;
1712         }
1713         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1714 }
1715
1716 static ssize_t
1717 store_tabletMouseRight(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1718 {
1719         struct aiptek *aiptek = dev_get_drvdata(dev);
1720
1721         if (aiptek == NULL)
1722                 return 0;
1723
1724         if (strcmp(buf, "left") == 0) {
1725                 aiptek->newSetting.mouseButtonRight = AIPTEK_MOUSE_LEFT_BUTTON;
1726         } else if (strcmp(buf, "middle") == 0) {
1727                 aiptek->newSetting.mouseButtonRight =
1728                     AIPTEK_MOUSE_MIDDLE_BUTTON;
1729         } else if (strcmp(buf, "right") == 0) {
1730                 aiptek->newSetting.mouseButtonRight = AIPTEK_MOUSE_RIGHT_BUTTON;
1731         }
1732         return count;
1733 }
1734
1735 static DEVICE_ATTR(mouse_right,
1736                    S_IRUGO | S_IWUGO,
1737                    show_tabletMouseRight, store_tabletMouseRight);
1738
1739 /***********************************************************************
1740  * support routines for the 'wheel' file. Note that this file
1741  * both displays current setting and allows for setting changing.
1742  */
1743 static ssize_t show_tabletWheel(struct device *dev, struct device_attribute *attr, char *buf)
1744 {
1745         struct aiptek *aiptek = dev_get_drvdata(dev);
1746
1747         if (aiptek == NULL)
1748                 return 0;
1749
1750         if (aiptek->curSetting.wheel == AIPTEK_WHEEL_DISABLE) {
1751                 return snprintf(buf, PAGE_SIZE, "disable\n");
1752         } else {
1753                 return snprintf(buf, PAGE_SIZE, "%d\n",
1754                                 aiptek->curSetting.wheel);
1755         }
1756 }
1757
1758 static ssize_t
1759 store_tabletWheel(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1760 {
1761         struct aiptek *aiptek = dev_get_drvdata(dev);
1762
1763         if (aiptek == NULL)
1764                 return 0;
1765
1766         aiptek->newSetting.wheel = (int)simple_strtol(buf, NULL, 10);
1767         return count;
1768 }
1769
1770 static DEVICE_ATTR(wheel,
1771                    S_IRUGO | S_IWUGO, show_tabletWheel, store_tabletWheel);
1772
1773 /***********************************************************************
1774  * support routines for the 'execute' file. Note that this file
1775  * both displays current setting and allows for setting changing.
1776  */
1777 static ssize_t show_tabletExecute(struct device *dev, struct device_attribute *attr, char *buf)
1778 {
1779         struct aiptek *aiptek = dev_get_drvdata(dev);
1780
1781         if (aiptek == NULL)
1782                 return 0;
1783
1784         /* There is nothing useful to display, so a one-line manual
1785          * is in order...
1786          */
1787         return snprintf(buf, PAGE_SIZE,
1788                         "Write anything to this file to program your tablet.\n");
1789 }
1790
1791 static ssize_t
1792 store_tabletExecute(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1793 {
1794         struct aiptek *aiptek = dev_get_drvdata(dev);
1795
1796         if (aiptek == NULL)
1797                 return 0;
1798
1799         /* We do not care what you write to this file. Merely the action
1800          * of writing to this file triggers a tablet reprogramming.
1801          */
1802         memcpy(&aiptek->curSetting, &aiptek->newSetting,
1803                sizeof(struct aiptek_settings));
1804
1805         if (aiptek_program_tablet(aiptek) < 0)
1806                 return -EIO;
1807
1808         return count;
1809 }
1810
1811 static DEVICE_ATTR(execute,
1812                    S_IRUGO | S_IWUGO, show_tabletExecute, store_tabletExecute);
1813
1814 /***********************************************************************
1815  * support routines for the 'odm_code' file. Note that this file
1816  * only displays current setting.
1817  */
1818 static ssize_t show_tabletODMCode(struct device *dev, struct device_attribute *attr, char *buf)
1819 {
1820         struct aiptek *aiptek = dev_get_drvdata(dev);
1821
1822         if (aiptek == NULL)
1823                 return 0;
1824
1825         return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->features.odmCode);
1826 }
1827
1828 static DEVICE_ATTR(odm_code, S_IRUGO, show_tabletODMCode, NULL);
1829
1830 /***********************************************************************
1831  * support routines for the 'model_code' file. Note that this file
1832  * only displays current setting.
1833  */
1834 static ssize_t show_tabletModelCode(struct device *dev, struct device_attribute *attr, char *buf)
1835 {
1836         struct aiptek *aiptek = dev_get_drvdata(dev);
1837
1838         if (aiptek == NULL)
1839                 return 0;
1840
1841         return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->features.modelCode);
1842 }
1843
1844 static DEVICE_ATTR(model_code, S_IRUGO, show_tabletModelCode, NULL);
1845
1846 /***********************************************************************
1847  * support routines for the 'firmware_code' file. Note that this file
1848  * only displays current setting.
1849  */
1850 static ssize_t show_firmwareCode(struct device *dev, struct device_attribute *attr, char *buf)
1851 {
1852         struct aiptek *aiptek = dev_get_drvdata(dev);
1853
1854         if (aiptek == NULL)
1855                 return 0;
1856
1857         return snprintf(buf, PAGE_SIZE, "%04x\n",
1858                         aiptek->features.firmwareCode);
1859 }
1860
1861 static DEVICE_ATTR(firmware_code, S_IRUGO, show_firmwareCode, NULL);
1862
1863 /***********************************************************************
1864  * This routine removes all existing sysfs files managed by this device
1865  * driver.
1866  */
1867 static void aiptek_delete_files(struct device *dev)
1868 {
1869         device_remove_file(dev, &dev_attr_size);
1870         device_remove_file(dev, &dev_attr_product_id);
1871         device_remove_file(dev, &dev_attr_vendor_id);
1872         device_remove_file(dev, &dev_attr_vendor);
1873         device_remove_file(dev, &dev_attr_product);
1874         device_remove_file(dev, &dev_attr_pointer_mode);
1875         device_remove_file(dev, &dev_attr_coordinate_mode);
1876         device_remove_file(dev, &dev_attr_tool_mode);
1877         device_remove_file(dev, &dev_attr_xtilt);
1878         device_remove_file(dev, &dev_attr_ytilt);
1879         device_remove_file(dev, &dev_attr_jitter);
1880         device_remove_file(dev, &dev_attr_delay);
1881         device_remove_file(dev, &dev_attr_event_count);
1882         device_remove_file(dev, &dev_attr_diagnostic);
1883         device_remove_file(dev, &dev_attr_odm_code);
1884         device_remove_file(dev, &dev_attr_model_code);
1885         device_remove_file(dev, &dev_attr_firmware_code);
1886         device_remove_file(dev, &dev_attr_stylus_lower);
1887         device_remove_file(dev, &dev_attr_stylus_upper);
1888         device_remove_file(dev, &dev_attr_mouse_left);
1889         device_remove_file(dev, &dev_attr_mouse_middle);
1890         device_remove_file(dev, &dev_attr_mouse_right);
1891         device_remove_file(dev, &dev_attr_wheel);
1892         device_remove_file(dev, &dev_attr_execute);
1893 }
1894
1895 /***********************************************************************
1896  * This routine creates the sysfs files managed by this device
1897  * driver.
1898  */
1899 static int aiptek_add_files(struct device *dev)
1900 {
1901         int ret;
1902
1903         if ((ret = device_create_file(dev, &dev_attr_size)) ||
1904             (ret = device_create_file(dev, &dev_attr_product_id)) ||
1905             (ret = device_create_file(dev, &dev_attr_vendor_id)) ||
1906             (ret = device_create_file(dev, &dev_attr_vendor)) ||
1907             (ret = device_create_file(dev, &dev_attr_product)) ||
1908             (ret = device_create_file(dev, &dev_attr_pointer_mode)) ||
1909             (ret = device_create_file(dev, &dev_attr_coordinate_mode)) ||
1910             (ret = device_create_file(dev, &dev_attr_tool_mode)) ||
1911             (ret = device_create_file(dev, &dev_attr_xtilt)) ||
1912             (ret = device_create_file(dev, &dev_attr_ytilt)) ||
1913             (ret = device_create_file(dev, &dev_attr_jitter)) ||
1914             (ret = device_create_file(dev, &dev_attr_delay)) ||
1915             (ret = device_create_file(dev, &dev_attr_event_count)) ||
1916             (ret = device_create_file(dev, &dev_attr_diagnostic)) ||
1917             (ret = device_create_file(dev, &dev_attr_odm_code)) ||
1918             (ret = device_create_file(dev, &dev_attr_model_code)) ||
1919             (ret = device_create_file(dev, &dev_attr_firmware_code)) ||
1920             (ret = device_create_file(dev, &dev_attr_stylus_lower)) ||
1921             (ret = device_create_file(dev, &dev_attr_stylus_upper)) ||
1922             (ret = device_create_file(dev, &dev_attr_mouse_left)) ||
1923             (ret = device_create_file(dev, &dev_attr_mouse_middle)) ||
1924             (ret = device_create_file(dev, &dev_attr_mouse_right)) ||
1925             (ret = device_create_file(dev, &dev_attr_wheel)) ||
1926             (ret = device_create_file(dev, &dev_attr_execute))) {
1927                 err("aiptek: killing own sysfs device files\n");
1928                 aiptek_delete_files(dev);
1929         }
1930         return ret;
1931 }
1932
1933 /***********************************************************************
1934  * This routine is called when a tablet has been identified. It basically
1935  * sets up the tablet and the driver's internal structures.
1936  */
1937 static int
1938 aiptek_probe(struct usb_interface *intf, const struct usb_device_id *id)
1939 {
1940         struct usb_device *usbdev = interface_to_usbdev(intf);
1941         struct usb_endpoint_descriptor *endpoint;
1942         struct aiptek *aiptek;
1943         struct input_dev *inputdev;
1944         int i;
1945         int speeds[] = { 0,
1946                 AIPTEK_PROGRAMMABLE_DELAY_50,
1947                 AIPTEK_PROGRAMMABLE_DELAY_400,
1948                 AIPTEK_PROGRAMMABLE_DELAY_25,
1949                 AIPTEK_PROGRAMMABLE_DELAY_100,
1950                 AIPTEK_PROGRAMMABLE_DELAY_200,
1951                 AIPTEK_PROGRAMMABLE_DELAY_300
1952         };
1953         int err = -ENOMEM;
1954
1955         /* programmableDelay is where the command-line specified
1956          * delay is kept. We make it the first element of speeds[],
1957          * so therefore, your override speed is tried first, then the
1958          * remainder. Note that the default value of 400ms will be tried
1959          * if you do not specify any command line parameter.
1960          */
1961         speeds[0] = programmableDelay;
1962
1963         aiptek = kzalloc(sizeof(struct aiptek), GFP_KERNEL);
1964         inputdev = input_allocate_device();
1965         if (!aiptek || !inputdev)
1966                 goto fail1;
1967
1968         aiptek->data = usb_buffer_alloc(usbdev, AIPTEK_PACKET_LENGTH,
1969                                         GFP_ATOMIC, &aiptek->data_dma);
1970         if (!aiptek->data)
1971                 goto fail1;
1972
1973         aiptek->urb = usb_alloc_urb(0, GFP_KERNEL);
1974         if (!aiptek->urb)
1975                 goto fail2;
1976
1977         aiptek->inputdev = inputdev;
1978         aiptek->usbdev = usbdev;
1979         aiptek->ifnum = intf->altsetting[0].desc.bInterfaceNumber;
1980         aiptek->inDelay = 0;
1981         aiptek->endDelay = 0;
1982         aiptek->previousJitterable = 0;
1983
1984         /* Set up the curSettings struct. Said struct contains the current
1985          * programmable parameters. The newSetting struct contains changes
1986          * the user makes to the settings via the sysfs interface. Those
1987          * changes are not "committed" to curSettings until the user
1988          * writes to the sysfs/.../execute file.
1989          */
1990         aiptek->curSetting.pointerMode = AIPTEK_POINTER_EITHER_MODE;
1991         aiptek->curSetting.coordinateMode = AIPTEK_COORDINATE_ABSOLUTE_MODE;
1992         aiptek->curSetting.toolMode = AIPTEK_TOOL_BUTTON_PEN_MODE;
1993         aiptek->curSetting.xTilt = AIPTEK_TILT_DISABLE;
1994         aiptek->curSetting.yTilt = AIPTEK_TILT_DISABLE;
1995         aiptek->curSetting.mouseButtonLeft = AIPTEK_MOUSE_LEFT_BUTTON;
1996         aiptek->curSetting.mouseButtonMiddle = AIPTEK_MOUSE_MIDDLE_BUTTON;
1997         aiptek->curSetting.mouseButtonRight = AIPTEK_MOUSE_RIGHT_BUTTON;
1998         aiptek->curSetting.stylusButtonUpper = AIPTEK_STYLUS_UPPER_BUTTON;
1999         aiptek->curSetting.stylusButtonLower = AIPTEK_STYLUS_LOWER_BUTTON;
2000         aiptek->curSetting.jitterDelay = jitterDelay;
2001         aiptek->curSetting.programmableDelay = programmableDelay;
2002
2003         /* Both structs should have equivalent settings
2004          */
2005         aiptek->newSetting = aiptek->curSetting;
2006
2007         /* Determine the usb devices' physical path.
2008          * Asketh not why we always pretend we're using "../input0",
2009          * but I suspect this will have to be refactored one
2010          * day if a single USB device can be a keyboard & a mouse
2011          * & a tablet, and the inputX number actually will tell
2012          * us something...
2013          */
2014         usb_make_path(usbdev, aiptek->features.usbPath,
2015                         sizeof(aiptek->features.usbPath));
2016         strlcat(aiptek->features.usbPath, "/input0",
2017                 sizeof(aiptek->features.usbPath));
2018
2019         /* Set up client data, pointers to open and close routines
2020          * for the input device.
2021          */
2022         inputdev->name = "Aiptek";
2023         inputdev->phys = aiptek->features.usbPath;
2024         usb_to_input_id(usbdev, &inputdev->id);
2025         inputdev->dev.parent = &intf->dev;
2026
2027         input_set_drvdata(inputdev, aiptek);
2028
2029         inputdev->open = aiptek_open;
2030         inputdev->close = aiptek_close;
2031
2032         /* Now program the capacities of the tablet, in terms of being
2033          * an input device.
2034          */
2035         inputdev->evbit[0] |= BIT(EV_KEY)
2036             | BIT(EV_ABS)
2037             | BIT(EV_REL)
2038             | BIT(EV_MSC);
2039
2040         inputdev->absbit[0] |= BIT(ABS_MISC);
2041
2042         inputdev->relbit[0] |=
2043             (BIT(REL_X) | BIT(REL_Y) | BIT(REL_WHEEL) | BIT(REL_MISC));
2044
2045         inputdev->keybit[LONG(BTN_LEFT)] |=
2046             (BIT(BTN_LEFT) | BIT(BTN_RIGHT) | BIT(BTN_MIDDLE));
2047
2048         inputdev->keybit[LONG(BTN_DIGI)] |=
2049             (BIT(BTN_TOOL_PEN) |
2050              BIT(BTN_TOOL_RUBBER) |
2051              BIT(BTN_TOOL_PENCIL) |
2052              BIT(BTN_TOOL_AIRBRUSH) |
2053              BIT(BTN_TOOL_BRUSH) |
2054              BIT(BTN_TOOL_MOUSE) |
2055              BIT(BTN_TOOL_LENS) |
2056              BIT(BTN_TOUCH) | BIT(BTN_STYLUS) | BIT(BTN_STYLUS2));
2057
2058         inputdev->mscbit[0] = BIT(MSC_SERIAL);
2059
2060         /* Programming the tablet macro keys needs to be done with a for loop
2061          * as the keycodes are discontiguous.
2062          */
2063         for (i = 0; i < ARRAY_SIZE(macroKeyEvents); ++i)
2064                 set_bit(macroKeyEvents[i], inputdev->keybit);
2065
2066         /*
2067          * Program the input device coordinate capacities. We do not yet
2068          * know what maximum X, Y, and Z values are, so we're putting fake
2069          * values in. Later, we'll ask the tablet to put in the correct
2070          * values.
2071          */
2072         input_set_abs_params(inputdev, ABS_X, 0, 2999, 0, 0);
2073         input_set_abs_params(inputdev, ABS_Y, 0, 2249, 0, 0);
2074         input_set_abs_params(inputdev, ABS_PRESSURE, 0, 511, 0, 0);
2075         input_set_abs_params(inputdev, ABS_TILT_X, AIPTEK_TILT_MIN, AIPTEK_TILT_MAX, 0, 0);
2076         input_set_abs_params(inputdev, ABS_TILT_Y, AIPTEK_TILT_MIN, AIPTEK_TILT_MAX, 0, 0);
2077         input_set_abs_params(inputdev, ABS_WHEEL, AIPTEK_WHEEL_MIN, AIPTEK_WHEEL_MAX - 1, 0, 0);
2078
2079         endpoint = &intf->altsetting[0].endpoint[0].desc;
2080
2081         /* Go set up our URB, which is called when the tablet receives
2082          * input.
2083          */
2084         usb_fill_int_urb(aiptek->urb,
2085                          aiptek->usbdev,
2086                          usb_rcvintpipe(aiptek->usbdev,
2087                                         endpoint->bEndpointAddress),
2088                          aiptek->data, 8, aiptek_irq, aiptek,
2089                          endpoint->bInterval);
2090
2091         aiptek->urb->transfer_dma = aiptek->data_dma;
2092         aiptek->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
2093
2094         /* Program the tablet. This sets the tablet up in the mode
2095          * specified in newSetting, and also queries the tablet's
2096          * physical capacities.
2097          *
2098          * Sanity check: if a tablet doesn't like the slow programmatic
2099          * delay, we often get sizes of 0x0. Let's use that as an indicator
2100          * to try faster delays, up to 25 ms. If that logic fails, well, you'll
2101          * have to explain to us how your tablet thinks it's 0x0, and yet that's
2102          * not an error :-)
2103          */
2104
2105         for (i = 0; i < ARRAY_SIZE(speeds); ++i) {
2106                 aiptek->curSetting.programmableDelay = speeds[i];
2107                 (void)aiptek_program_tablet(aiptek);
2108                 if (aiptek->inputdev->absmax[ABS_X] > 0) {
2109                         info("input: Aiptek using %d ms programming speed\n",
2110                              aiptek->curSetting.programmableDelay);
2111                         break;
2112                 }
2113         }
2114
2115         /* Register the tablet as an Input Device
2116          */
2117         err = input_register_device(aiptek->inputdev);
2118         if (err)
2119                 goto fail2;
2120
2121         /* Associate this driver's struct with the usb interface.
2122          */
2123         usb_set_intfdata(intf, aiptek);
2124
2125         /* Set up the sysfs files
2126          */
2127         aiptek_add_files(&intf->dev);
2128
2129         return 0;
2130
2131  fail2: usb_buffer_free(usbdev, AIPTEK_PACKET_LENGTH, aiptek->data,
2132                         aiptek->data_dma);
2133  fail1: input_free_device(inputdev);
2134         kfree(aiptek);
2135         return err;
2136 }
2137
2138 /***********************************************************************
2139  * Deal with tablet disconnecting from the system.
2140  */
2141 static void aiptek_disconnect(struct usb_interface *intf)
2142 {
2143         struct aiptek *aiptek = usb_get_intfdata(intf);
2144
2145         /* Disassociate driver's struct with usb interface
2146          */
2147         usb_set_intfdata(intf, NULL);
2148         if (aiptek != NULL) {
2149                 /* Free & unhook everything from the system.
2150                  */
2151                 usb_kill_urb(aiptek->urb);
2152                 input_unregister_device(aiptek->inputdev);
2153                 aiptek_delete_files(&intf->dev);
2154                 usb_free_urb(aiptek->urb);
2155                 usb_buffer_free(interface_to_usbdev(intf),
2156                                 AIPTEK_PACKET_LENGTH,
2157                                 aiptek->data, aiptek->data_dma);
2158                 kfree(aiptek);
2159         }
2160 }
2161
2162 static struct usb_driver aiptek_driver = {
2163         .name = "aiptek",
2164         .probe = aiptek_probe,
2165         .disconnect = aiptek_disconnect,
2166         .id_table = aiptek_ids,
2167 };
2168
2169 static int __init aiptek_init(void)
2170 {
2171         int result = usb_register(&aiptek_driver);
2172         if (result == 0) {
2173                 info(DRIVER_VERSION ": " DRIVER_AUTHOR);
2174                 info(DRIVER_DESC);
2175         }
2176         return result;
2177 }
2178
2179 static void __exit aiptek_exit(void)
2180 {
2181         usb_deregister(&aiptek_driver);
2182 }
2183
2184 MODULE_AUTHOR(DRIVER_AUTHOR);
2185 MODULE_DESCRIPTION(DRIVER_DESC);
2186 MODULE_LICENSE("GPL");
2187
2188 module_param(programmableDelay, int, 0);
2189 MODULE_PARM_DESC(programmableDelay, "delay used during tablet programming");
2190 module_param(jitterDelay, int, 0);
2191 MODULE_PARM_DESC(jitterDelay, "stylus/mouse settlement delay");
2192
2193 module_init(aiptek_init);
2194 module_exit(aiptek_exit);