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         return snprintf(buf, PAGE_SIZE, "%dx%d\n",
1010                         aiptek->inputdev->absmax[ABS_X] + 1,
1011                         aiptek->inputdev->absmax[ABS_Y] + 1);
1012 }
1013
1014 /* These structs define the sysfs files, param #1 is the name of the
1015  * file, param 2 is the file permissions, param 3 & 4 are to the
1016  * output generator and input parser routines. Absence of a routine is
1017  * permitted -- it only means can't either 'cat' the file, or send data
1018  * to it.
1019  */
1020 static DEVICE_ATTR(size, S_IRUGO, show_tabletSize, NULL);
1021
1022 /***********************************************************************
1023  * support routines for the 'pointer_mode' file. Note that this file
1024  * both displays current setting and allows reprogramming.
1025  */
1026 static ssize_t show_tabletPointerMode(struct device *dev, struct device_attribute *attr, char *buf)
1027 {
1028         struct aiptek *aiptek = dev_get_drvdata(dev);
1029         char *s;
1030
1031         switch (aiptek->curSetting.pointerMode) {
1032         case AIPTEK_POINTER_ONLY_STYLUS_MODE:
1033                 s = "stylus";
1034                 break;
1035
1036         case AIPTEK_POINTER_ONLY_MOUSE_MODE:
1037                 s = "mouse";
1038                 break;
1039
1040         case AIPTEK_POINTER_EITHER_MODE:
1041                 s = "either";
1042                 break;
1043
1044         default:
1045                 s = "unknown";
1046                 break;
1047         }
1048         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1049 }
1050
1051 static ssize_t
1052 store_tabletPointerMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1053 {
1054         struct aiptek *aiptek = dev_get_drvdata(dev);
1055
1056         if (strcmp(buf, "stylus") == 0) {
1057                 aiptek->newSetting.pointerMode =
1058                     AIPTEK_POINTER_ONLY_STYLUS_MODE;
1059         } else if (strcmp(buf, "mouse") == 0) {
1060                 aiptek->newSetting.pointerMode = AIPTEK_POINTER_ONLY_MOUSE_MODE;
1061         } else if (strcmp(buf, "either") == 0) {
1062                 aiptek->newSetting.pointerMode = AIPTEK_POINTER_EITHER_MODE;
1063         }
1064         return count;
1065 }
1066
1067 static DEVICE_ATTR(pointer_mode,
1068                    S_IRUGO | S_IWUGO,
1069                    show_tabletPointerMode, store_tabletPointerMode);
1070
1071 /***********************************************************************
1072  * support routines for the 'coordinate_mode' file. Note that this file
1073  * both displays current setting and allows reprogramming.
1074  */
1075 static ssize_t show_tabletCoordinateMode(struct device *dev, struct device_attribute *attr, char *buf)
1076 {
1077         struct aiptek *aiptek = dev_get_drvdata(dev);
1078         char *s;
1079
1080         switch (aiptek->curSetting.coordinateMode) {
1081         case AIPTEK_COORDINATE_ABSOLUTE_MODE:
1082                 s = "absolute";
1083                 break;
1084
1085         case AIPTEK_COORDINATE_RELATIVE_MODE:
1086                 s = "relative";
1087                 break;
1088
1089         default:
1090                 s = "unknown";
1091                 break;
1092         }
1093         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1094 }
1095
1096 static ssize_t
1097 store_tabletCoordinateMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1098 {
1099         struct aiptek *aiptek = dev_get_drvdata(dev);
1100
1101         if (strcmp(buf, "absolute") == 0) {
1102                 aiptek->newSetting.pointerMode =
1103                     AIPTEK_COORDINATE_ABSOLUTE_MODE;
1104         } else if (strcmp(buf, "relative") == 0) {
1105                 aiptek->newSetting.pointerMode =
1106                     AIPTEK_COORDINATE_RELATIVE_MODE;
1107         }
1108         return count;
1109 }
1110
1111 static DEVICE_ATTR(coordinate_mode,
1112                    S_IRUGO | S_IWUGO,
1113                    show_tabletCoordinateMode, store_tabletCoordinateMode);
1114
1115 /***********************************************************************
1116  * support routines for the 'tool_mode' file. Note that this file
1117  * both displays current setting and allows reprogramming.
1118  */
1119 static ssize_t show_tabletToolMode(struct device *dev, struct device_attribute *attr, char *buf)
1120 {
1121         struct aiptek *aiptek = dev_get_drvdata(dev);
1122         char *s;
1123
1124         switch (TOOL_BUTTON(aiptek->curSetting.toolMode)) {
1125         case AIPTEK_TOOL_BUTTON_MOUSE_MODE:
1126                 s = "mouse";
1127                 break;
1128
1129         case AIPTEK_TOOL_BUTTON_ERASER_MODE:
1130                 s = "eraser";
1131                 break;
1132
1133         case AIPTEK_TOOL_BUTTON_PENCIL_MODE:
1134                 s = "pencil";
1135                 break;
1136
1137         case AIPTEK_TOOL_BUTTON_PEN_MODE:
1138                 s = "pen";
1139                 break;
1140
1141         case AIPTEK_TOOL_BUTTON_BRUSH_MODE:
1142                 s = "brush";
1143                 break;
1144
1145         case AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE:
1146                 s = "airbrush";
1147                 break;
1148
1149         case AIPTEK_TOOL_BUTTON_LENS_MODE:
1150                 s = "lens";
1151                 break;
1152
1153         default:
1154                 s = "unknown";
1155                 break;
1156         }
1157         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1158 }
1159
1160 static ssize_t
1161 store_tabletToolMode(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1162 {
1163         struct aiptek *aiptek = dev_get_drvdata(dev);
1164
1165         if (strcmp(buf, "mouse") == 0) {
1166                 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_MOUSE_MODE;
1167         } else if (strcmp(buf, "eraser") == 0) {
1168                 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_ERASER_MODE;
1169         } else if (strcmp(buf, "pencil") == 0) {
1170                 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_PENCIL_MODE;
1171         } else if (strcmp(buf, "pen") == 0) {
1172                 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_PEN_MODE;
1173         } else if (strcmp(buf, "brush") == 0) {
1174                 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_BRUSH_MODE;
1175         } else if (strcmp(buf, "airbrush") == 0) {
1176                 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_AIRBRUSH_MODE;
1177         } else if (strcmp(buf, "lens") == 0) {
1178                 aiptek->newSetting.toolMode = AIPTEK_TOOL_BUTTON_LENS_MODE;
1179         }
1180
1181         return count;
1182 }
1183
1184 static DEVICE_ATTR(tool_mode,
1185                    S_IRUGO | S_IWUGO,
1186                    show_tabletToolMode, store_tabletToolMode);
1187
1188 /***********************************************************************
1189  * support routines for the 'xtilt' file. Note that this file
1190  * both displays current setting and allows reprogramming.
1191  */
1192 static ssize_t show_tabletXtilt(struct device *dev, struct device_attribute *attr, char *buf)
1193 {
1194         struct aiptek *aiptek = dev_get_drvdata(dev);
1195
1196         if (aiptek->curSetting.xTilt == AIPTEK_TILT_DISABLE) {
1197                 return snprintf(buf, PAGE_SIZE, "disable\n");
1198         } else {
1199                 return snprintf(buf, PAGE_SIZE, "%d\n",
1200                                 aiptek->curSetting.xTilt);
1201         }
1202 }
1203
1204 static ssize_t
1205 store_tabletXtilt(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1206 {
1207         struct aiptek *aiptek = dev_get_drvdata(dev);
1208         int x;
1209
1210         if (strcmp(buf, "disable") == 0) {
1211                 aiptek->newSetting.xTilt = AIPTEK_TILT_DISABLE;
1212         } else {
1213                 x = (int)simple_strtol(buf, NULL, 10);
1214                 if (x >= AIPTEK_TILT_MIN && x <= AIPTEK_TILT_MAX) {
1215                         aiptek->newSetting.xTilt = x;
1216                 }
1217         }
1218         return count;
1219 }
1220
1221 static DEVICE_ATTR(xtilt,
1222                    S_IRUGO | S_IWUGO, show_tabletXtilt, store_tabletXtilt);
1223
1224 /***********************************************************************
1225  * support routines for the 'ytilt' file. Note that this file
1226  * both displays current setting and allows reprogramming.
1227  */
1228 static ssize_t show_tabletYtilt(struct device *dev, struct device_attribute *attr, char *buf)
1229 {
1230         struct aiptek *aiptek = dev_get_drvdata(dev);
1231
1232         if (aiptek->curSetting.yTilt == AIPTEK_TILT_DISABLE) {
1233                 return snprintf(buf, PAGE_SIZE, "disable\n");
1234         } else {
1235                 return snprintf(buf, PAGE_SIZE, "%d\n",
1236                                 aiptek->curSetting.yTilt);
1237         }
1238 }
1239
1240 static ssize_t
1241 store_tabletYtilt(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1242 {
1243         struct aiptek *aiptek = dev_get_drvdata(dev);
1244         int y;
1245
1246         if (strcmp(buf, "disable") == 0) {
1247                 aiptek->newSetting.yTilt = AIPTEK_TILT_DISABLE;
1248         } else {
1249                 y = (int)simple_strtol(buf, NULL, 10);
1250                 if (y >= AIPTEK_TILT_MIN && y <= AIPTEK_TILT_MAX) {
1251                         aiptek->newSetting.yTilt = y;
1252                 }
1253         }
1254         return count;
1255 }
1256
1257 static DEVICE_ATTR(ytilt,
1258                    S_IRUGO | S_IWUGO, show_tabletYtilt, store_tabletYtilt);
1259
1260 /***********************************************************************
1261  * support routines for the 'jitter' file. Note that this file
1262  * both displays current setting and allows reprogramming.
1263  */
1264 static ssize_t show_tabletJitterDelay(struct device *dev, struct device_attribute *attr, char *buf)
1265 {
1266         struct aiptek *aiptek = dev_get_drvdata(dev);
1267
1268         return snprintf(buf, PAGE_SIZE, "%d\n", aiptek->curSetting.jitterDelay);
1269 }
1270
1271 static ssize_t
1272 store_tabletJitterDelay(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1273 {
1274         struct aiptek *aiptek = dev_get_drvdata(dev);
1275
1276         aiptek->newSetting.jitterDelay = (int)simple_strtol(buf, NULL, 10);
1277         return count;
1278 }
1279
1280 static DEVICE_ATTR(jitter,
1281                    S_IRUGO | S_IWUGO,
1282                    show_tabletJitterDelay, store_tabletJitterDelay);
1283
1284 /***********************************************************************
1285  * support routines for the 'delay' file. Note that this file
1286  * both displays current setting and allows reprogramming.
1287  */
1288 static ssize_t show_tabletProgrammableDelay(struct device *dev, struct device_attribute *attr, char *buf)
1289 {
1290         struct aiptek *aiptek = dev_get_drvdata(dev);
1291
1292         return snprintf(buf, PAGE_SIZE, "%d\n",
1293                         aiptek->curSetting.programmableDelay);
1294 }
1295
1296 static ssize_t
1297 store_tabletProgrammableDelay(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1298 {
1299         struct aiptek *aiptek = dev_get_drvdata(dev);
1300
1301         aiptek->newSetting.programmableDelay = (int)simple_strtol(buf, NULL, 10);
1302         return count;
1303 }
1304
1305 static DEVICE_ATTR(delay,
1306                    S_IRUGO | S_IWUGO,
1307                    show_tabletProgrammableDelay, store_tabletProgrammableDelay);
1308
1309 /***********************************************************************
1310  * support routines for the 'event_count' file. Note that this file
1311  * only displays current setting.
1312  */
1313 static ssize_t show_tabletEventsReceived(struct device *dev, struct device_attribute *attr, char *buf)
1314 {
1315         struct aiptek *aiptek = dev_get_drvdata(dev);
1316
1317         return snprintf(buf, PAGE_SIZE, "%ld\n", aiptek->eventCount);
1318 }
1319
1320 static DEVICE_ATTR(event_count, S_IRUGO, show_tabletEventsReceived, NULL);
1321
1322 /***********************************************************************
1323  * support routines for the 'diagnostic' file. Note that this file
1324  * only displays current setting.
1325  */
1326 static ssize_t show_tabletDiagnosticMessage(struct device *dev, struct device_attribute *attr, char *buf)
1327 {
1328         struct aiptek *aiptek = dev_get_drvdata(dev);
1329         char *retMsg;
1330
1331         switch (aiptek->diagnostic) {
1332         case AIPTEK_DIAGNOSTIC_NA:
1333                 retMsg = "no errors\n";
1334                 break;
1335
1336         case AIPTEK_DIAGNOSTIC_SENDING_RELATIVE_IN_ABSOLUTE:
1337                 retMsg = "Error: receiving relative reports\n";
1338                 break;
1339
1340         case AIPTEK_DIAGNOSTIC_SENDING_ABSOLUTE_IN_RELATIVE:
1341                 retMsg = "Error: receiving absolute reports\n";
1342                 break;
1343
1344         case AIPTEK_DIAGNOSTIC_TOOL_DISALLOWED:
1345                 if (aiptek->curSetting.pointerMode ==
1346                     AIPTEK_POINTER_ONLY_MOUSE_MODE) {
1347                         retMsg = "Error: receiving stylus reports\n";
1348                 } else {
1349                         retMsg = "Error: receiving mouse reports\n";
1350                 }
1351                 break;
1352
1353         default:
1354                 return 0;
1355         }
1356         return snprintf(buf, PAGE_SIZE, retMsg);
1357 }
1358
1359 static DEVICE_ATTR(diagnostic, S_IRUGO, show_tabletDiagnosticMessage, NULL);
1360
1361 /***********************************************************************
1362  * support routines for the 'stylus_upper' file. Note that this file
1363  * both displays current setting and allows for setting changing.
1364  */
1365 static ssize_t show_tabletStylusUpper(struct device *dev, struct device_attribute *attr, char *buf)
1366 {
1367         struct aiptek *aiptek = dev_get_drvdata(dev);
1368         char *s;
1369
1370         switch (aiptek->curSetting.stylusButtonUpper) {
1371         case AIPTEK_STYLUS_UPPER_BUTTON:
1372                 s = "upper";
1373                 break;
1374
1375         case AIPTEK_STYLUS_LOWER_BUTTON:
1376                 s = "lower";
1377                 break;
1378
1379         default:
1380                 s = "unknown";
1381                 break;
1382         }
1383         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1384 }
1385
1386 static ssize_t
1387 store_tabletStylusUpper(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1388 {
1389         struct aiptek *aiptek = dev_get_drvdata(dev);
1390
1391         if (strcmp(buf, "upper") == 0) {
1392                 aiptek->newSetting.stylusButtonUpper =
1393                     AIPTEK_STYLUS_UPPER_BUTTON;
1394         } else if (strcmp(buf, "lower") == 0) {
1395                 aiptek->newSetting.stylusButtonUpper =
1396                     AIPTEK_STYLUS_LOWER_BUTTON;
1397         }
1398         return count;
1399 }
1400
1401 static DEVICE_ATTR(stylus_upper,
1402                    S_IRUGO | S_IWUGO,
1403                    show_tabletStylusUpper, store_tabletStylusUpper);
1404
1405 /***********************************************************************
1406  * support routines for the 'stylus_lower' file. Note that this file
1407  * both displays current setting and allows for setting changing.
1408  */
1409 static ssize_t show_tabletStylusLower(struct device *dev, struct device_attribute *attr, char *buf)
1410 {
1411         struct aiptek *aiptek = dev_get_drvdata(dev);
1412         char *s;
1413
1414         switch (aiptek->curSetting.stylusButtonLower) {
1415         case AIPTEK_STYLUS_UPPER_BUTTON:
1416                 s = "upper";
1417                 break;
1418
1419         case AIPTEK_STYLUS_LOWER_BUTTON:
1420                 s = "lower";
1421                 break;
1422
1423         default:
1424                 s = "unknown";
1425                 break;
1426         }
1427         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1428 }
1429
1430 static ssize_t
1431 store_tabletStylusLower(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1432 {
1433         struct aiptek *aiptek = dev_get_drvdata(dev);
1434
1435         if (strcmp(buf, "upper") == 0) {
1436                 aiptek->newSetting.stylusButtonLower =
1437                     AIPTEK_STYLUS_UPPER_BUTTON;
1438         } else if (strcmp(buf, "lower") == 0) {
1439                 aiptek->newSetting.stylusButtonLower =
1440                     AIPTEK_STYLUS_LOWER_BUTTON;
1441         }
1442         return count;
1443 }
1444
1445 static DEVICE_ATTR(stylus_lower,
1446                    S_IRUGO | S_IWUGO,
1447                    show_tabletStylusLower, store_tabletStylusLower);
1448
1449 /***********************************************************************
1450  * support routines for the 'mouse_left' file. Note that this file
1451  * both displays current setting and allows for setting changing.
1452  */
1453 static ssize_t show_tabletMouseLeft(struct device *dev, struct device_attribute *attr, char *buf)
1454 {
1455         struct aiptek *aiptek = dev_get_drvdata(dev);
1456         char *s;
1457
1458         switch (aiptek->curSetting.mouseButtonLeft) {
1459         case AIPTEK_MOUSE_LEFT_BUTTON:
1460                 s = "left";
1461                 break;
1462
1463         case AIPTEK_MOUSE_MIDDLE_BUTTON:
1464                 s = "middle";
1465                 break;
1466
1467         case AIPTEK_MOUSE_RIGHT_BUTTON:
1468                 s = "right";
1469                 break;
1470
1471         default:
1472                 s = "unknown";
1473                 break;
1474         }
1475         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1476 }
1477
1478 static ssize_t
1479 store_tabletMouseLeft(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1480 {
1481         struct aiptek *aiptek = dev_get_drvdata(dev);
1482
1483         if (strcmp(buf, "left") == 0) {
1484                 aiptek->newSetting.mouseButtonLeft = AIPTEK_MOUSE_LEFT_BUTTON;
1485         } else if (strcmp(buf, "middle") == 0) {
1486                 aiptek->newSetting.mouseButtonLeft = AIPTEK_MOUSE_MIDDLE_BUTTON;
1487         } else if (strcmp(buf, "right") == 0) {
1488                 aiptek->newSetting.mouseButtonLeft = AIPTEK_MOUSE_RIGHT_BUTTON;
1489         }
1490         return count;
1491 }
1492
1493 static DEVICE_ATTR(mouse_left,
1494                    S_IRUGO | S_IWUGO,
1495                    show_tabletMouseLeft, store_tabletMouseLeft);
1496
1497 /***********************************************************************
1498  * support routines for the 'mouse_middle' file. Note that this file
1499  * both displays current setting and allows for setting changing.
1500  */
1501 static ssize_t show_tabletMouseMiddle(struct device *dev, struct device_attribute *attr, char *buf)
1502 {
1503         struct aiptek *aiptek = dev_get_drvdata(dev);
1504         char *s;
1505
1506         switch (aiptek->curSetting.mouseButtonMiddle) {
1507         case AIPTEK_MOUSE_LEFT_BUTTON:
1508                 s = "left";
1509                 break;
1510
1511         case AIPTEK_MOUSE_MIDDLE_BUTTON:
1512                 s = "middle";
1513                 break;
1514
1515         case AIPTEK_MOUSE_RIGHT_BUTTON:
1516                 s = "right";
1517                 break;
1518
1519         default:
1520                 s = "unknown";
1521                 break;
1522         }
1523         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1524 }
1525
1526 static ssize_t
1527 store_tabletMouseMiddle(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1528 {
1529         struct aiptek *aiptek = dev_get_drvdata(dev);
1530
1531         if (strcmp(buf, "left") == 0) {
1532                 aiptek->newSetting.mouseButtonMiddle = AIPTEK_MOUSE_LEFT_BUTTON;
1533         } else if (strcmp(buf, "middle") == 0) {
1534                 aiptek->newSetting.mouseButtonMiddle =
1535                     AIPTEK_MOUSE_MIDDLE_BUTTON;
1536         } else if (strcmp(buf, "right") == 0) {
1537                 aiptek->newSetting.mouseButtonMiddle =
1538                     AIPTEK_MOUSE_RIGHT_BUTTON;
1539         }
1540         return count;
1541 }
1542
1543 static DEVICE_ATTR(mouse_middle,
1544                    S_IRUGO | S_IWUGO,
1545                    show_tabletMouseMiddle, store_tabletMouseMiddle);
1546
1547 /***********************************************************************
1548  * support routines for the 'mouse_right' file. Note that this file
1549  * both displays current setting and allows for setting changing.
1550  */
1551 static ssize_t show_tabletMouseRight(struct device *dev, struct device_attribute *attr, char *buf)
1552 {
1553         struct aiptek *aiptek = dev_get_drvdata(dev);
1554         char *s;
1555
1556         switch (aiptek->curSetting.mouseButtonRight) {
1557         case AIPTEK_MOUSE_LEFT_BUTTON:
1558                 s = "left";
1559                 break;
1560
1561         case AIPTEK_MOUSE_MIDDLE_BUTTON:
1562                 s = "middle";
1563                 break;
1564
1565         case AIPTEK_MOUSE_RIGHT_BUTTON:
1566                 s = "right";
1567                 break;
1568
1569         default:
1570                 s = "unknown";
1571                 break;
1572         }
1573         return snprintf(buf, PAGE_SIZE, "%s\n", s);
1574 }
1575
1576 static ssize_t
1577 store_tabletMouseRight(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1578 {
1579         struct aiptek *aiptek = dev_get_drvdata(dev);
1580
1581         if (strcmp(buf, "left") == 0) {
1582                 aiptek->newSetting.mouseButtonRight = AIPTEK_MOUSE_LEFT_BUTTON;
1583         } else if (strcmp(buf, "middle") == 0) {
1584                 aiptek->newSetting.mouseButtonRight =
1585                     AIPTEK_MOUSE_MIDDLE_BUTTON;
1586         } else if (strcmp(buf, "right") == 0) {
1587                 aiptek->newSetting.mouseButtonRight = AIPTEK_MOUSE_RIGHT_BUTTON;
1588         }
1589         return count;
1590 }
1591
1592 static DEVICE_ATTR(mouse_right,
1593                    S_IRUGO | S_IWUGO,
1594                    show_tabletMouseRight, store_tabletMouseRight);
1595
1596 /***********************************************************************
1597  * support routines for the 'wheel' file. Note that this file
1598  * both displays current setting and allows for setting changing.
1599  */
1600 static ssize_t show_tabletWheel(struct device *dev, struct device_attribute *attr, char *buf)
1601 {
1602         struct aiptek *aiptek = dev_get_drvdata(dev);
1603
1604         if (aiptek->curSetting.wheel == AIPTEK_WHEEL_DISABLE) {
1605                 return snprintf(buf, PAGE_SIZE, "disable\n");
1606         } else {
1607                 return snprintf(buf, PAGE_SIZE, "%d\n",
1608                                 aiptek->curSetting.wheel);
1609         }
1610 }
1611
1612 static ssize_t
1613 store_tabletWheel(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1614 {
1615         struct aiptek *aiptek = dev_get_drvdata(dev);
1616
1617         aiptek->newSetting.wheel = (int)simple_strtol(buf, NULL, 10);
1618         return count;
1619 }
1620
1621 static DEVICE_ATTR(wheel,
1622                    S_IRUGO | S_IWUGO, show_tabletWheel, store_tabletWheel);
1623
1624 /***********************************************************************
1625  * support routines for the 'execute' file. Note that this file
1626  * both displays current setting and allows for setting changing.
1627  */
1628 static ssize_t show_tabletExecute(struct device *dev, struct device_attribute *attr, char *buf)
1629 {
1630         /* There is nothing useful to display, so a one-line manual
1631          * is in order...
1632          */
1633         return snprintf(buf, PAGE_SIZE,
1634                         "Write anything to this file to program your tablet.\n");
1635 }
1636
1637 static ssize_t
1638 store_tabletExecute(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
1639 {
1640         struct aiptek *aiptek = dev_get_drvdata(dev);
1641
1642         /* We do not care what you write to this file. Merely the action
1643          * of writing to this file triggers a tablet reprogramming.
1644          */
1645         memcpy(&aiptek->curSetting, &aiptek->newSetting,
1646                sizeof(struct aiptek_settings));
1647
1648         if (aiptek_program_tablet(aiptek) < 0)
1649                 return -EIO;
1650
1651         return count;
1652 }
1653
1654 static DEVICE_ATTR(execute,
1655                    S_IRUGO | S_IWUGO, show_tabletExecute, store_tabletExecute);
1656
1657 /***********************************************************************
1658  * support routines for the 'odm_code' file. Note that this file
1659  * only displays current setting.
1660  */
1661 static ssize_t show_tabletODMCode(struct device *dev, struct device_attribute *attr, char *buf)
1662 {
1663         struct aiptek *aiptek = dev_get_drvdata(dev);
1664
1665         return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->features.odmCode);
1666 }
1667
1668 static DEVICE_ATTR(odm_code, S_IRUGO, show_tabletODMCode, NULL);
1669
1670 /***********************************************************************
1671  * support routines for the 'model_code' file. Note that this file
1672  * only displays current setting.
1673  */
1674 static ssize_t show_tabletModelCode(struct device *dev, struct device_attribute *attr, char *buf)
1675 {
1676         struct aiptek *aiptek = dev_get_drvdata(dev);
1677
1678         return snprintf(buf, PAGE_SIZE, "0x%04x\n", aiptek->features.modelCode);
1679 }
1680
1681 static DEVICE_ATTR(model_code, S_IRUGO, show_tabletModelCode, NULL);
1682
1683 /***********************************************************************
1684  * support routines for the 'firmware_code' file. Note that this file
1685  * only displays current setting.
1686  */
1687 static ssize_t show_firmwareCode(struct device *dev, struct device_attribute *attr, char *buf)
1688 {
1689         struct aiptek *aiptek = dev_get_drvdata(dev);
1690
1691         return snprintf(buf, PAGE_SIZE, "%04x\n",
1692                         aiptek->features.firmwareCode);
1693 }
1694
1695 static DEVICE_ATTR(firmware_code, S_IRUGO, show_firmwareCode, NULL);
1696
1697 static struct attribute *aiptek_attributes[] = {
1698         &dev_attr_size.attr,
1699         &dev_attr_pointer_mode.attr,
1700         &dev_attr_coordinate_mode.attr,
1701         &dev_attr_tool_mode.attr,
1702         &dev_attr_xtilt.attr,
1703         &dev_attr_ytilt.attr,
1704         &dev_attr_jitter.attr,
1705         &dev_attr_delay.attr,
1706         &dev_attr_event_count.attr,
1707         &dev_attr_diagnostic.attr,
1708         &dev_attr_odm_code.attr,
1709         &dev_attr_model_code.attr,
1710         &dev_attr_firmware_code.attr,
1711         &dev_attr_stylus_lower.attr,
1712         &dev_attr_stylus_upper.attr,
1713         &dev_attr_mouse_left.attr,
1714         &dev_attr_mouse_middle.attr,
1715         &dev_attr_mouse_right.attr,
1716         &dev_attr_wheel.attr,
1717         &dev_attr_execute.attr,
1718         NULL
1719 };
1720
1721 static struct attribute_group aiptek_attribute_group = {
1722         .attrs  = aiptek_attributes,
1723 };
1724
1725 /***********************************************************************
1726  * This routine is called when a tablet has been identified. It basically
1727  * sets up the tablet and the driver's internal structures.
1728  */
1729 static int
1730 aiptek_probe(struct usb_interface *intf, const struct usb_device_id *id)
1731 {
1732         struct usb_device *usbdev = interface_to_usbdev(intf);
1733         struct usb_endpoint_descriptor *endpoint;
1734         struct aiptek *aiptek;
1735         struct input_dev *inputdev;
1736         int i;
1737         int speeds[] = { 0,
1738                 AIPTEK_PROGRAMMABLE_DELAY_50,
1739                 AIPTEK_PROGRAMMABLE_DELAY_400,
1740                 AIPTEK_PROGRAMMABLE_DELAY_25,
1741                 AIPTEK_PROGRAMMABLE_DELAY_100,
1742                 AIPTEK_PROGRAMMABLE_DELAY_200,
1743                 AIPTEK_PROGRAMMABLE_DELAY_300
1744         };
1745         int err = -ENOMEM;
1746
1747         /* programmableDelay is where the command-line specified
1748          * delay is kept. We make it the first element of speeds[],
1749          * so therefore, your override speed is tried first, then the
1750          * remainder. Note that the default value of 400ms will be tried
1751          * if you do not specify any command line parameter.
1752          */
1753         speeds[0] = programmableDelay;
1754
1755         aiptek = kzalloc(sizeof(struct aiptek), GFP_KERNEL);
1756         inputdev = input_allocate_device();
1757         if (!aiptek || !inputdev)
1758                 goto fail1;
1759
1760         aiptek->data = usb_buffer_alloc(usbdev, AIPTEK_PACKET_LENGTH,
1761                                         GFP_ATOMIC, &aiptek->data_dma);
1762         if (!aiptek->data)
1763                 goto fail1;
1764
1765         aiptek->urb = usb_alloc_urb(0, GFP_KERNEL);
1766         if (!aiptek->urb)
1767                 goto fail2;
1768
1769         aiptek->inputdev = inputdev;
1770         aiptek->usbdev = usbdev;
1771         aiptek->ifnum = intf->altsetting[0].desc.bInterfaceNumber;
1772         aiptek->inDelay = 0;
1773         aiptek->endDelay = 0;
1774         aiptek->previousJitterable = 0;
1775
1776         /* Set up the curSettings struct. Said struct contains the current
1777          * programmable parameters. The newSetting struct contains changes
1778          * the user makes to the settings via the sysfs interface. Those
1779          * changes are not "committed" to curSettings until the user
1780          * writes to the sysfs/.../execute file.
1781          */
1782         aiptek->curSetting.pointerMode = AIPTEK_POINTER_EITHER_MODE;
1783         aiptek->curSetting.coordinateMode = AIPTEK_COORDINATE_ABSOLUTE_MODE;
1784         aiptek->curSetting.toolMode = AIPTEK_TOOL_BUTTON_PEN_MODE;
1785         aiptek->curSetting.xTilt = AIPTEK_TILT_DISABLE;
1786         aiptek->curSetting.yTilt = AIPTEK_TILT_DISABLE;
1787         aiptek->curSetting.mouseButtonLeft = AIPTEK_MOUSE_LEFT_BUTTON;
1788         aiptek->curSetting.mouseButtonMiddle = AIPTEK_MOUSE_MIDDLE_BUTTON;
1789         aiptek->curSetting.mouseButtonRight = AIPTEK_MOUSE_RIGHT_BUTTON;
1790         aiptek->curSetting.stylusButtonUpper = AIPTEK_STYLUS_UPPER_BUTTON;
1791         aiptek->curSetting.stylusButtonLower = AIPTEK_STYLUS_LOWER_BUTTON;
1792         aiptek->curSetting.jitterDelay = jitterDelay;
1793         aiptek->curSetting.programmableDelay = programmableDelay;
1794
1795         /* Both structs should have equivalent settings
1796          */
1797         aiptek->newSetting = aiptek->curSetting;
1798
1799         /* Determine the usb devices' physical path.
1800          * Asketh not why we always pretend we're using "../input0",
1801          * but I suspect this will have to be refactored one
1802          * day if a single USB device can be a keyboard & a mouse
1803          * & a tablet, and the inputX number actually will tell
1804          * us something...
1805          */
1806         usb_make_path(usbdev, aiptek->features.usbPath,
1807                         sizeof(aiptek->features.usbPath));
1808         strlcat(aiptek->features.usbPath, "/input0",
1809                 sizeof(aiptek->features.usbPath));
1810
1811         /* Set up client data, pointers to open and close routines
1812          * for the input device.
1813          */
1814         inputdev->name = "Aiptek";
1815         inputdev->phys = aiptek->features.usbPath;
1816         usb_to_input_id(usbdev, &inputdev->id);
1817         inputdev->dev.parent = &intf->dev;
1818
1819         input_set_drvdata(inputdev, aiptek);
1820
1821         inputdev->open = aiptek_open;
1822         inputdev->close = aiptek_close;
1823
1824         /* Now program the capacities of the tablet, in terms of being
1825          * an input device.
1826          */
1827         inputdev->evbit[0] |= BIT(EV_KEY)
1828             | BIT(EV_ABS)
1829             | BIT(EV_REL)
1830             | BIT(EV_MSC);
1831
1832         inputdev->absbit[0] |= BIT(ABS_MISC);
1833
1834         inputdev->relbit[0] |=
1835             (BIT(REL_X) | BIT(REL_Y) | BIT(REL_WHEEL) | BIT(REL_MISC));
1836
1837         inputdev->keybit[LONG(BTN_LEFT)] |=
1838             (BIT(BTN_LEFT) | BIT(BTN_RIGHT) | BIT(BTN_MIDDLE));
1839
1840         inputdev->keybit[LONG(BTN_DIGI)] |=
1841             (BIT(BTN_TOOL_PEN) |
1842              BIT(BTN_TOOL_RUBBER) |
1843              BIT(BTN_TOOL_PENCIL) |
1844              BIT(BTN_TOOL_AIRBRUSH) |
1845              BIT(BTN_TOOL_BRUSH) |
1846              BIT(BTN_TOOL_MOUSE) |
1847              BIT(BTN_TOOL_LENS) |
1848              BIT(BTN_TOUCH) | BIT(BTN_STYLUS) | BIT(BTN_STYLUS2));
1849
1850         inputdev->mscbit[0] = BIT(MSC_SERIAL);
1851
1852         /* Programming the tablet macro keys needs to be done with a for loop
1853          * as the keycodes are discontiguous.
1854          */
1855         for (i = 0; i < ARRAY_SIZE(macroKeyEvents); ++i)
1856                 set_bit(macroKeyEvents[i], inputdev->keybit);
1857
1858         /*
1859          * Program the input device coordinate capacities. We do not yet
1860          * know what maximum X, Y, and Z values are, so we're putting fake
1861          * values in. Later, we'll ask the tablet to put in the correct
1862          * values.
1863          */
1864         input_set_abs_params(inputdev, ABS_X, 0, 2999, 0, 0);
1865         input_set_abs_params(inputdev, ABS_Y, 0, 2249, 0, 0);
1866         input_set_abs_params(inputdev, ABS_PRESSURE, 0, 511, 0, 0);
1867         input_set_abs_params(inputdev, ABS_TILT_X, AIPTEK_TILT_MIN, AIPTEK_TILT_MAX, 0, 0);
1868         input_set_abs_params(inputdev, ABS_TILT_Y, AIPTEK_TILT_MIN, AIPTEK_TILT_MAX, 0, 0);
1869         input_set_abs_params(inputdev, ABS_WHEEL, AIPTEK_WHEEL_MIN, AIPTEK_WHEEL_MAX - 1, 0, 0);
1870
1871         endpoint = &intf->altsetting[0].endpoint[0].desc;
1872
1873         /* Go set up our URB, which is called when the tablet receives
1874          * input.
1875          */
1876         usb_fill_int_urb(aiptek->urb,
1877                          aiptek->usbdev,
1878                          usb_rcvintpipe(aiptek->usbdev,
1879                                         endpoint->bEndpointAddress),
1880                          aiptek->data, 8, aiptek_irq, aiptek,
1881                          endpoint->bInterval);
1882
1883         aiptek->urb->transfer_dma = aiptek->data_dma;
1884         aiptek->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1885
1886         /* Program the tablet. This sets the tablet up in the mode
1887          * specified in newSetting, and also queries the tablet's
1888          * physical capacities.
1889          *
1890          * Sanity check: if a tablet doesn't like the slow programmatic
1891          * delay, we often get sizes of 0x0. Let's use that as an indicator
1892          * to try faster delays, up to 25 ms. If that logic fails, well, you'll
1893          * have to explain to us how your tablet thinks it's 0x0, and yet that's
1894          * not an error :-)
1895          */
1896
1897         for (i = 0; i < ARRAY_SIZE(speeds); ++i) {
1898                 aiptek->curSetting.programmableDelay = speeds[i];
1899                 (void)aiptek_program_tablet(aiptek);
1900                 if (aiptek->inputdev->absmax[ABS_X] > 0) {
1901                         info("input: Aiptek using %d ms programming speed\n",
1902                              aiptek->curSetting.programmableDelay);
1903                         break;
1904                 }
1905         }
1906
1907         /* Associate this driver's struct with the usb interface.
1908          */
1909         usb_set_intfdata(intf, aiptek);
1910
1911         /* Set up the sysfs files
1912          */
1913         err = sysfs_create_group(&intf->dev.kobj, &aiptek_attribute_group);
1914         if (err)
1915                 goto fail3;
1916
1917         /* Register the tablet as an Input Device
1918          */
1919         err = input_register_device(aiptek->inputdev);
1920         if (err)
1921                 goto fail4;
1922
1923         return 0;
1924
1925  fail4: sysfs_remove_group(&intf->dev.kobj, &aiptek_attribute_group);
1926  fail3: usb_free_urb(aiptek->urb);
1927  fail2: usb_buffer_free(usbdev, AIPTEK_PACKET_LENGTH, aiptek->data,
1928                         aiptek->data_dma);
1929  fail1: usb_set_intfdata(intf, NULL);
1930         input_free_device(inputdev);
1931         kfree(aiptek);
1932         return err;
1933 }
1934
1935 /***********************************************************************
1936  * Deal with tablet disconnecting from the system.
1937  */
1938 static void aiptek_disconnect(struct usb_interface *intf)
1939 {
1940         struct aiptek *aiptek = usb_get_intfdata(intf);
1941
1942         /* Disassociate driver's struct with usb interface
1943          */
1944         usb_set_intfdata(intf, NULL);
1945         if (aiptek != NULL) {
1946                 /* Free & unhook everything from the system.
1947                  */
1948                 usb_kill_urb(aiptek->urb);
1949                 input_unregister_device(aiptek->inputdev);
1950                 sysfs_remove_group(&intf->dev.kobj, &aiptek_attribute_group);
1951                 usb_free_urb(aiptek->urb);
1952                 usb_buffer_free(interface_to_usbdev(intf),
1953                                 AIPTEK_PACKET_LENGTH,
1954                                 aiptek->data, aiptek->data_dma);
1955                 kfree(aiptek);
1956         }
1957 }
1958
1959 static struct usb_driver aiptek_driver = {
1960         .name = "aiptek",
1961         .probe = aiptek_probe,
1962         .disconnect = aiptek_disconnect,
1963         .id_table = aiptek_ids,
1964 };
1965
1966 static int __init aiptek_init(void)
1967 {
1968         int result = usb_register(&aiptek_driver);
1969         if (result == 0) {
1970                 info(DRIVER_VERSION ": " DRIVER_AUTHOR);
1971                 info(DRIVER_DESC);
1972         }
1973         return result;
1974 }
1975
1976 static void __exit aiptek_exit(void)
1977 {
1978         usb_deregister(&aiptek_driver);
1979 }
1980
1981 MODULE_AUTHOR(DRIVER_AUTHOR);
1982 MODULE_DESCRIPTION(DRIVER_DESC);
1983 MODULE_LICENSE("GPL");
1984
1985 module_param(programmableDelay, int, 0);
1986 MODULE_PARM_DESC(programmableDelay, "delay used during tablet programming");
1987 module_param(jitterDelay, int, 0);
1988 MODULE_PARM_DESC(jitterDelay, "stylus/mouse settlement delay");
1989
1990 module_init(aiptek_init);
1991 module_exit(aiptek_exit);