Merge branch 'master' into detour

1 files changed, 352 insertions, 315 deletions

diff --git a/bcm5974.c b/bcm5974.c
index a7f070f..bf6c59f 100644
--- a/bcm5974.c
+++ b/bcm5974.c
@@ -39,42 +39,43 @@
 #include <linux/module.h>
 #include <linux/usb/input.h>
 #include <linux/hid.h>
+#include <linux/mutex.h>
 
-#define APPLE_VENDOR_ID         0x05AC
+#define USB_VENDOR_ID_APPLE             0x05ac
 
 /* MacbookAir, aka wellspring */
-#define ATP_WELLSPRING_ANSI     0x0223
-#define ATP_WELLSPRING_ISO      0x0224
-#define ATP_WELLSPRING_JIS      0x0225
+#define USB_DEVICE_ID_APPLE_WELLSPRING_ANSI     0x0223
+#define USB_DEVICE_ID_APPLE_WELLSPRING_ISO      0x0224
+#define USB_DEVICE_ID_APPLE_WELLSPRING_JIS      0x0225
 /* MacbookProPenryn, aka wellspring2 */
-#define ATP_WELLSPRING2_ANSI    0x0230
-#define ATP_WELLSPRING2_ISO     0x0231
-#define ATP_WELLSPRING2_JIS     0x0232
+#define USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI    0x0230
+#define USB_DEVICE_ID_APPLE_WELLSPRING2_ISO     0x0231
+#define USB_DEVICE_ID_APPLE_WELLSPRING2_JIS     0x0232
 
-#define ATP_DEVICE(prod) {                                      \
+#define BCM5974_DEVICE(prod) {                                  \
         .match_flags = (USB_DEVICE_ID_MATCH_DEVICE |            \
                         USB_DEVICE_ID_MATCH_INT_CLASS |         \
                         USB_DEVICE_ID_MATCH_INT_PROTOCOL),      \
-        .idVendor = APPLE_VENDOR_ID,                            \
+        .idVendor = USB_VENDOR_ID_APPLE,                        \
         .idProduct = (prod),                                    \
         .bInterfaceClass = USB_INTERFACE_CLASS_HID,             \
         .bInterfaceProtocol = USB_INTERFACE_PROTOCOL_MOUSE      \
 }
 
 /* table of devices that work with this driver */
-static const struct usb_device_id atp_table [] = {
+static const struct usb_device_id bcm5974_table[] = {
         /* MacbookAir1.1 */
-        ATP_DEVICE(ATP_WELLSPRING_ANSI),
-        ATP_DEVICE(ATP_WELLSPRING_ISO),
-        ATP_DEVICE(ATP_WELLSPRING_JIS),
+        BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING_ANSI),
+        BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING_ISO),
+        BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING_JIS),
         /* MacbookProPenryn */
-        ATP_DEVICE(ATP_WELLSPRING2_ANSI),
-        ATP_DEVICE(ATP_WELLSPRING2_ISO),
-        ATP_DEVICE(ATP_WELLSPRING2_JIS),
+        BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI),
+        BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_ISO),
+        BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_JIS),
         /* Terminating entry */
         {}
 };
-MODULE_DEVICE_TABLE(usb, atp_table);
+MODULE_DEVICE_TABLE(usb, bcm5974_table);
 
 MODULE_AUTHOR("Henrik Rydberg");
 MODULE_DESCRIPTION("Apple USB BCM5974 multitouch driver");
@@ -104,7 +105,7 @@ struct tp_header {
 
 /* trackpad finger structure */
 struct tp_finger {
-        __le16 origin;          /* left/right origin? */
+        __le16 origin;          /* zero when switching track finger */
         __le16 abs_x;           /* absolute x coodinate */
         __le16 abs_y;           /* absolute y coodinate */
         __le16 rel_x;           /* relative x coodinate */
@@ -125,50 +126,40 @@ struct tp_data {
 };
 
 /* device-specific parameters */
-struct atp_params {
+struct bcm5974_param {
         int dim;                /* logical dimension */
+        int fuzz;               /* logical noise value */
         int devmin;             /* device minimum reading */
         int devmax;             /* device maximum reading */
 };
 
 /* device-specific configuration */
-struct atp_config {
+struct bcm5974_config {
         int ansi, iso, jis;     /* the product id of this device */
         int bt_ep;              /* the endpoint of the button interface */
         int bt_datalen;         /* data length of the button interface */
         int tp_ep;              /* the endpoint of the trackpad interface */
         int tp_datalen;         /* data length of the trackpad interface */
-        struct atp_params p;    /* finger pressure limits */
-        struct atp_params w;    /* finger width limits */
-        struct atp_params x;    /* horizontal limits */
-        struct atp_params y;    /* vertical limits */
-};
-
-/* logical trackpad state */
-struct tp_state {
-        int pressure;           /* finger pressure value */
-        int width;              /* finger width value */
-        int abs_x;              /* absolute x coordinate */
-        int abs_y;              /* absolute y coordinate */
-        int fingers;            /* number of fingers on trackpad */
+        struct bcm5974_param p; /* finger pressure limits */
+        struct bcm5974_param w; /* finger width limits */
+        struct bcm5974_param x; /* horizontal limits */
+        struct bcm5974_param y; /* vertical limits */
 };
 
 /* logical device structure */
-struct atp {
+struct bcm5974 {
         char phys[64];
         struct usb_device *udev;        /* usb device */
+        struct usb_interface *intf;     /* our interface */
         struct input_dev *input;        /* input dev */
-        struct atp_config cfg;          /* device configuration */
-        int open;                       /* >0: open, else closed */
-        int suspended;                  /* >0: suspended, else open */
+        struct bcm5974_config cfg;      /* device configuration */
+        struct mutex pm_mutex;          /* serialize access to open/suspend */
+        int opened;                     /* 1: opened, 0: closed */
         struct urb *bt_urb;             /* button usb request block */
         struct bt_data *bt_data;        /* button transferred data */
-        unsigned bt_prev_state;         /* logical button previous state */
-        unsigned bt_state;              /* logical button state */
         struct urb *tp_urb;             /* trackpad usb request block */
         struct tp_data *tp_data;        /* trackpad transferred data */
-        struct tp_state tp_state;       /* logical trackpad state */
-        unsigned tp_valid;              /* trackpad sensors valid */
+        int fingers;                    /* number of fingers on trackpad */
 };
 
 /* logical dimensions */
@@ -176,45 +167,54 @@ struct atp {
 #define DIM_WIDTH       16              /* maximum finger width */
 #define DIM_X           1280            /* maximum trackpad x value */
 #define DIM_Y           800             /* maximum trackpad y value */
-#define SNRATIO         50              /* signal to noise ratio */
+
+/* logical signal quality */
+#define SN_PRESSURE     45              /* pressure signal-to-noise ratio */
+#define SN_WIDTH        100             /* width signal-to-noise ratio */
+#define SN_COORD        250             /* coordinate signal-to-noise ratio */
+
+/* pressure thresholds */
+#define PRESSURE_LOW    (2 * DIM_PRESSURE / SN_PRESSURE)
+#define PRESSURE_HIGH   (3 * PRESSURE_LOW)
 
 /* device constants */
-static const struct atp_config atp_config_table[] = {
+static const struct bcm5974_config bcm5974_config_table[] = {
         {
-                ATP_WELLSPRING_ANSI,
-                ATP_WELLSPRING_ISO,
-                ATP_WELLSPRING_JIS,
+                USB_DEVICE_ID_APPLE_WELLSPRING_ANSI,
+                USB_DEVICE_ID_APPLE_WELLSPRING_ISO,
+                USB_DEVICE_ID_APPLE_WELLSPRING_JIS,
                 0x84, sizeof(struct bt_data),
                 0x81, sizeof(struct tp_data),
-                { DIM_PRESSURE, 0, 256 },
-                { DIM_WIDTH, 0, 2048 },
-                { DIM_X, -4824, 5342 },
-                { DIM_Y, -172, 5820 }
+                { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 256 },
+                { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
+                { DIM_X, DIM_X / SN_COORD, -4824, 5342 },
+                { DIM_Y, DIM_Y / SN_COORD, -172, 5820 }
         },
         {
-                ATP_WELLSPRING2_ANSI,
-                ATP_WELLSPRING2_ISO,
-                ATP_WELLSPRING2_JIS,
+                USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI,
+                USB_DEVICE_ID_APPLE_WELLSPRING2_ISO,
+                USB_DEVICE_ID_APPLE_WELLSPRING2_JIS,
                 0x84, sizeof(struct bt_data),
                 0x81, sizeof(struct tp_data),
-                { DIM_PRESSURE, 0, 256 },
-                { DIM_WIDTH, 0, 2048 },
-                { DIM_X, -4824, 5342 },
-                { DIM_Y, -172, 5820 }
+                { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 256 },
+                { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
+                { DIM_X, DIM_X / SN_COORD, -4824, 4824 },
+                { DIM_Y, DIM_Y / SN_COORD, -172, 4290 }
         },
         {}
 };
 
 /* return the device-specific configuration by device */
-static const struct atp_config *atp_product_config(struct usb_device *udev)
+static const struct bcm5974_config *bcm5974_get_config(struct usb_device *udev)
 {
         u16 id = le16_to_cpu(udev->descriptor.idProduct);
-        const struct atp_config *config;
-        for (config = atp_config_table; config->ansi; ++config)
-                if (config->ansi == id || config->iso == id ||
-                                config->jis == id)
-                        return config;
-        return atp_config_table;
+        const struct bcm5974_config *cfg;
+
+        for (cfg = bcm5974_config_table; cfg->ansi; ++cfg)
+                if (cfg->ansi == id || cfg->iso == id || cfg->jis == id)
+                        return cfg;
+
+        return bcm5974_config_table;
 }
 
 /* convert 16-bit little endian to signed integer */
@@ -224,142 +224,189 @@ static inline int raw2int(__le16 x)
 }
 
 /* scale device data to logical dimensions (asserts devmin < devmax) */
-static inline int int2scale(const struct atp_params *p, int x)
+static inline int int2scale(const struct bcm5974_param *p, int x)
 {
         return x * p->dim / (p->devmax - p->devmin);
 }
 
 /* all logical value ranges are [0,dim). */
-static inline int int2bound(const struct atp_params *p, int x)
+static inline int int2bound(const struct bcm5974_param *p, int x)
 {
         int s = int2scale(p, x);
-        return s < 0 ? 0 : s >= p->dim ? p->dim - 1 : s;
+
+        //return clamp_val(s, 0, p->dim - 1);
+        return s < 0 ? 0 : s >= p->dim ? p->dim - 1 : s;
 }
 
-/* convert button data to logical button state */
-static int compute_bt_state(struct atp *dev, int size)
+/* setup which logical events to report */
+static void setup_events_to_report(struct input_dev *input_dev,
+                                   const struct bcm5974_config *cfg)
+{
+        __set_bit(EV_ABS, input_dev->evbit);
+
+        input_set_abs_params(input_dev, ABS_PRESSURE,
+                                0, cfg->p.dim, cfg->p.fuzz, 0);
+        input_set_abs_params(input_dev, ABS_TOOL_WIDTH,
+                                0, cfg->w.dim, cfg->w.fuzz, 0);
+        input_set_abs_params(input_dev, ABS_X,
+                                0, cfg->x.dim, cfg->x.fuzz, 0);
+        input_set_abs_params(input_dev, ABS_Y,
+                                0, cfg->y.dim, cfg->y.fuzz, 0);
+
+        __set_bit(EV_KEY, input_dev->evbit);
+        __set_bit(BTN_TOUCH, input_dev->keybit);
+        __set_bit(BTN_TOOL_FINGER, input_dev->keybit);
+        __set_bit(BTN_TOOL_DOUBLETAP, input_dev->keybit);
+        __set_bit(BTN_TOOL_TRIPLETAP, input_dev->keybit);
+        __set_bit(BTN_LEFT, input_dev->keybit);
+}
+
+/* report button data as logical button state */
+static int report_bt_state(struct bcm5974 *dev, int size)
 {
         if (size != sizeof(struct bt_data))
                 return -EIO;
 
-        dev->bt_prev_state = dev->bt_state;
-        dev->bt_state = dev->bt_data->button;
+        input_report_key(dev->input, BTN_LEFT, dev->bt_data->button);
+        input_sync(dev->input);
 
         return 0;
 }
 
-/* convert trackpad data to logical trackpad state */
-static int compute_tp_state(struct atp *dev, int size)
+/* report trackpad data as logical trackpad state */
+static int report_tp_state(struct bcm5974 *dev, int size)
 {
-        const struct atp_config *c = &dev->cfg;
+        const struct bcm5974_config *c = &dev->cfg;
         const struct tp_finger *f = dev->tp_data->finger;
+        struct input_dev *input = dev->input;
         const int fingers = (size - 26) / 28;
-        struct tp_state *s = &dev->tp_state;
+        int raw_p, raw_w, raw_x, raw_y;
+        int ptest = 0, origin = 0, nmin = 0, nmax = 0;
+        int abs_p = 0, abs_w = 0, abs_x = 0, abs_y = 0;
 
         if (size < 26 || (size - 26) % 28 != 0)
                 return -EIO;
 
-        if (!fingers) {
-                s->pressure = 0;
-                s->fingers = 0;
-                return 0;
+        /* always track the first finger; when detached, start over */
+        if (fingers) {
+                raw_p = raw2int(f->force_major);
+                raw_w = raw2int(f->size_major);
+                raw_x = raw2int(f->abs_x);
+                raw_y = raw2int(f->abs_y);
+
+                dprintk(9,
+                        "bcm5974: raw: p: %+05d w: %+05d x: %+05d y: %+05d\n",
+                        raw_p, raw_w, raw_x, raw_y);
+
+                ptest = int2bound(&c->p, raw_p);
+                origin = raw2int(f->origin);
+        }
+
+        /* while tracking finger still valid, count all fingers */
+        if (ptest > PRESSURE_LOW && origin) {
+                abs_p = ptest;
+                abs_w = int2bound(&c->w, raw_w);
+                abs_x = int2bound(&c->x, raw_x - c->x.devmin);
+                abs_y = int2bound(&c->y, c->y.devmax - raw_y);
+                for (; f != dev->tp_data->finger + fingers; f++) {
+                        ptest = int2bound(&c->p, raw2int(f->force_major));
+                        if (ptest > PRESSURE_LOW)
+                                nmax++;
+                        if (ptest > PRESSURE_HIGH)
+                                nmin++;
+                }
         }
 
-        dprintk(9, "bcm5974: p: %+05d w: %+05d x: %+05d y: %+05d f: %d\n",
-                raw2int(f->force_major), raw2int(f->size_major),
-                raw2int(f->abs_x), raw2int(f->abs_y), fingers);
+        if (dev->fingers < nmin)
+                dev->fingers = nmin;
+        if (dev->fingers > nmax)
+                dev->fingers = nmax;
+
+        input_report_key(input, BTN_TOUCH, dev->fingers > 0);
+        input_report_key(input, BTN_TOOL_FINGER, dev->fingers == 1);
+        input_report_key(input, BTN_TOOL_DOUBLETAP, dev->fingers == 2);
+        input_report_key(input, BTN_TOOL_TRIPLETAP, dev->fingers > 2);
+
+        input_report_abs(input, ABS_PRESSURE, abs_p);
+        input_report_abs(input, ABS_TOOL_WIDTH, abs_w);
+
+        if (abs_p) {
+                input_report_abs(input, ABS_X, abs_x);
+                input_report_abs(input, ABS_Y, abs_y);
+
+                dprintk(8,
+                        "bcm5974: abs: p: %+05d w: %+05d x: %+05d y: %+05d "
+                        "nmin: %d nmax: %d n: %d\n",
+                        abs_p, abs_w, abs_x, abs_y, nmin, nmax, dev->fingers);
 
-        s->pressure = int2bound(&c->p, raw2int(f->force_major));
-        s->width = int2bound(&c->w, raw2int(f->size_major));
-        s->abs_x = int2bound(&c->x, raw2int(f->abs_x) - c->x.devmin);
-        s->abs_y = int2bound(&c->y, c->y.devmax - raw2int(f->abs_y));
-        s->fingers = s->pressure > 0 ? fingers : 0;
+        }
+
+        input_sync(input);
 
         return 0;
 }
 
 /* Wellspring initialization constants */
-#define ATP_WELLSPRING_MODE_READ_REQUEST_ID     1
-#define ATP_WELLSPRING_MODE_WRITE_REQUEST_ID    9
-#define ATP_WELLSPRING_MODE_REQUEST_VALUE       0x300
-#define ATP_WELLSPRING_MODE_REQUEST_INDEX       0
-#define ATP_WELLSPRING_MODE_VENDOR_VALUE_1      0x01
-#define ATP_WELLSPRING_MODE_VENDOR_VALUE_2      0x05
-
-static int atp_wellspring_init(struct atp *dev)
+#define BCM5974_WELLSPRING_MODE_READ_REQUEST_ID         1
+#define BCM5974_WELLSPRING_MODE_WRITE_REQUEST_ID        9
+#define BCM5974_WELLSPRING_MODE_REQUEST_VALUE           0x300
+#define BCM5974_WELLSPRING_MODE_REQUEST_INDEX           0
+#define BCM5974_WELLSPRING_MODE_VENDOR_VALUE            0x01
+#define BCM5974_WELLSPRING_MODE_NORMAL_VALUE            0x08
+
+static int bcm5974_wellspring_mode(struct bcm5974 *dev, bool on)
 {
         char *data = kmalloc(8, GFP_KERNEL);
-        int error = 0, size;
+        int retval = 0, size;
 
         if (!data) {
                 err("bcm5974: out of memory");
-                error = -ENOMEM;
-                goto error;
-        }
-
-        /* reset button endpoint */
-        if (usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
-                        USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
-                        0, dev->cfg.bt_ep, NULL, 0, 5000)) {
-                err("bcm5974: could not reset button endpoint");
-                error = -EIO;
-                goto error;
-        }
-
-        /* reset trackpad endpoint */
-        if (usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
-                        USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
-                        0, dev->cfg.tp_ep, NULL, 0, 5000)) {
-                err("bcm5974: could not reset trackpad endpoint");
-                error = -EIO;
-                goto error;
+                retval = -ENOMEM;
+                goto out;
         }
 
         /* read configuration */
         size = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
-                ATP_WELLSPRING_MODE_READ_REQUEST_ID,
-                USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
-                ATP_WELLSPRING_MODE_REQUEST_VALUE,
-                ATP_WELLSPRING_MODE_REQUEST_INDEX, data, 8, 5000);
+                        BCM5974_WELLSPRING_MODE_READ_REQUEST_ID,
+                        USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
+                        BCM5974_WELLSPRING_MODE_REQUEST_VALUE,
+                        BCM5974_WELLSPRING_MODE_REQUEST_INDEX, data, 8, 5000);
 
         if (size != 8) {
                 err("bcm5974: could not read from device");
-                error = -EIO;
-                goto error;
+                retval = -EIO;
+                goto out;
         }
 
         /* apply the mode switch */
-        data[0] = ATP_WELLSPRING_MODE_VENDOR_VALUE_1;
-        data[1] = ATP_WELLSPRING_MODE_VENDOR_VALUE_2;
+        data[0] = on ?
+                BCM5974_WELLSPRING_MODE_VENDOR_VALUE :
+                BCM5974_WELLSPRING_MODE_NORMAL_VALUE;
 
         /* write configuration */
         size = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, 0),
-                ATP_WELLSPRING_MODE_WRITE_REQUEST_ID,
-                USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
-                ATP_WELLSPRING_MODE_REQUEST_VALUE,
-                ATP_WELLSPRING_MODE_REQUEST_INDEX, data, 8, 5000);
+                        BCM5974_WELLSPRING_MODE_WRITE_REQUEST_ID,
+                        USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
+                        BCM5974_WELLSPRING_MODE_REQUEST_VALUE,
+                        BCM5974_WELLSPRING_MODE_REQUEST_INDEX, data, 8, 5000);
 
         if (size != 8) {
                 err("bcm5974: could not write to device");
-                error = -EIO;
-                goto error;
+                retval = -EIO;
+                goto out;
         }
 
-        dev->tp_valid = 0;
-
-        printk(KERN_INFO "bcm5974: Wellspring mode initialized.\n");
+        dprintk(2, "bcm5974: switched to %s mode.\n",
+                on ? "wellspring" : "normal");
 
+ out:
         kfree(data);
-        return 0;
-
-error:
-        kfree(data);
-        return error;
+        return retval;
 }
 
-static void irq_button(struct urb *urb)
+static void bcm5974_irq_button(struct urb *urb)
 {
-        struct atp *dev = urb->context;
+        struct bcm5974 *dev = urb->context;
         int error;
 
         switch (urb->status) {
@@ -376,17 +423,9 @@ static void irq_button(struct urb *urb)
                 goto exit;
         }
 
-        if (compute_bt_state(dev, dev->bt_urb->actual_length)) {
-                dprintk(1, "bcm5974: bad button package, length: %d)\n",
+        if (report_bt_state(dev, dev->bt_urb->actual_length))
+                dprintk(1, "bcm5974: bad button package, length: %d\n",
                         dev->bt_urb->actual_length);
-                goto exit;
-        }
-
-        /* only report button state changes */
-        if (dev->bt_state != dev->bt_prev_state) {
-                input_report_key(dev->input, BTN_LEFT, dev->bt_data->button);
-                input_sync(dev->input);
-        }
 
 exit:
         error = usb_submit_urb(dev->bt_urb, GFP_ATOMIC);
@@ -394,10 +433,9 @@ exit:
                 err("bcm5974: button urb failed: %d", error);
 }
 
-static void irq_trackpad(struct urb *urb)
+static void bcm5974_irq_trackpad(struct urb *urb)
 {
-        struct atp *dev = urb->context;
-        struct tp_state *state = &dev->tp_state;
+        struct bcm5974 *dev = urb->context;
         int error;
 
         switch (urb->status) {
@@ -414,26 +452,13 @@ static void irq_trackpad(struct urb *urb)
                 goto exit;
         }
 
-        /* first sample data ignored */
-        if (!dev->tp_valid) {
-                dev->tp_valid = 1;
+        /* control response ignored */
+        if (dev->tp_urb->actual_length == 2)
                 goto exit;
-        }
 
-        if (compute_tp_state(dev, dev->tp_urb->actual_length)) {
-                dprintk(1, "bcm5974: bad trackpad package, length: %d)\n",
+        if (report_tp_state(dev, dev->tp_urb->actual_length))
+                dprintk(1, "bcm5974: bad trackpad package, length: %d\n",
                         dev->tp_urb->actual_length);
-                goto exit;
-        }
-
-        input_report_abs(dev->input, ABS_PRESSURE, state->pressure);
-        input_report_abs(dev->input, ABS_TOOL_WIDTH, state->width);
-        input_report_abs(dev->input, ABS_X, state->abs_x);
-        input_report_abs(dev->input, ABS_Y, state->abs_y);
-        input_report_key(dev->input, BTN_TOOL_FINGER, state->fingers == 1);
-        input_report_key(dev->input, BTN_TOOL_DOUBLETAP, state->fingers == 2);
-        input_report_key(dev->input, BTN_TOOL_TRIPLETAP, state->fingers > 2);
-        input_sync(dev->input);
 
 exit:
         error = usb_submit_urb(dev->tp_urb, GFP_ATOMIC);
@@ -441,107 +466,184 @@ exit:
                 err("bcm5974: trackpad urb failed: %d", error);
 }
 
-static int atp_open(struct input_dev *input)
+/*
+ * The Wellspring trackpad, like many recent Apple trackpads, share
+ * the usb device with the keyboard. Since keyboards are usually
+ * handled by the HID system, the device ends up being handled by two
+ * modules. Setting up the device therefore becomes slightly
+ * complicated. To enable multitouch features, a mode switch is
+ * required, which is usually applied via the control interface of the
+ * device.  It can be argued where this switch should take place. In
+ * some drivers, like appletouch, the switch is made during
+ * probe. However, the hid module may also alter the state of the
+ * device, resulting in trackpad malfunction under certain
+ * circumstances. To get around this problem, there is at least one
+ * example that utilizes the USB_QUIRK_RESET_RESUME quirk in order to
+ * recieve a reset_resume request rather than the normal resume.
+ * Since the implementation of reset_resume is equal to mode switch
+ * plus start_traffic, it seems easier to always do the switch when
+ * starting traffic on the device.
+ */
+static int bcm5974_start_traffic(struct bcm5974 *dev)
 {
-        struct atp *dev = input_get_drvdata(input);
-
-        if (!dev->open) {
-                if (usb_submit_urb(dev->bt_urb, GFP_ATOMIC))
-                        goto error;
-                if (usb_submit_urb(dev->tp_urb, GFP_ATOMIC))
-                        goto err_free_bt_urb;
+        if (bcm5974_wellspring_mode(dev, true)) {
+                dprintk(1, "bcm5974: mode switch failed\n");
+                goto error;
         }
 
-        dev->open = 1;
-        dev->suspended = 0;
+        if (usb_submit_urb(dev->bt_urb, GFP_KERNEL))
+                goto error;
+
+        if (usb_submit_urb(dev->tp_urb, GFP_KERNEL))
+                goto err_kill_bt;
+
         return 0;
 
-err_free_bt_urb:
-        usb_free_urb(dev->bt_urb);
+err_kill_bt:
+        usb_kill_urb(dev->bt_urb);
 error:
         return -EIO;
 }
 
-static void atp_close(struct input_dev *input)
+static void bcm5974_pause_traffic(struct bcm5974 *dev)
 {
-        struct atp *dev = input_get_drvdata(input);
-
         usb_kill_urb(dev->tp_urb);
         usb_kill_urb(dev->bt_urb);
+        bcm5974_wellspring_mode(dev, false);
+}
+
+/*
+ * The code below implements open/close and manual suspend/resume.
+ * All functions may be called in random order.
+ *
+ * Opening a suspended device fails with EACCES - permission denied.
+ *
+ * Failing a resume leaves the device resumed but closed.
+ */
+static int bcm5974_open(struct input_dev *input)
+{
+        struct bcm5974 *dev = input_get_drvdata(input);
+        int error;
+
+        error = usb_autopm_get_interface(dev->intf);
+        if (error)
+                return error;
 
-        dev->open = 0;
-        dev->suspended = 0;
+        mutex_lock(&dev->pm_mutex);
+
+        error = bcm5974_start_traffic(dev);
+        if (!error)
+                dev->opened = 1;
+
+        mutex_unlock(&dev->pm_mutex);
+
+        if (error)
+                usb_autopm_put_interface(dev->intf);
+
+        return error;
+}
+
+static void bcm5974_close(struct input_dev *input)
+{
+        struct bcm5974 *dev = input_get_drvdata(input);
+
+        mutex_lock(&dev->pm_mutex);
+
+        bcm5974_pause_traffic(dev);
+        dev->opened = 0;
+
+        mutex_unlock(&dev->pm_mutex);
+
+        usb_autopm_put_interface(dev->intf);
 }
 
-static int atp_probe(struct usb_interface *iface,
-                     const struct usb_device_id *id)
+static int bcm5974_suspend(struct usb_interface *iface, pm_message_t message)
+{
+        struct bcm5974 *dev = usb_get_intfdata(iface);
+
+        mutex_lock(&dev->pm_mutex);
+
+        if (dev->opened)
+                bcm5974_pause_traffic(dev);
+
+        mutex_unlock(&dev->pm_mutex);
+
+        return 0;
+}
+
+static int bcm5974_resume(struct usb_interface *iface)
+{
+        struct bcm5974 *dev = usb_get_intfdata(iface);
+        int error = 0;
+
+        mutex_lock(&dev->pm_mutex);
+
+        if (dev->opened)
+                error = bcm5974_start_traffic(dev);
+
+        mutex_unlock(&dev->pm_mutex);
+
+        return error;
+}
+
+static int bcm5974_probe(struct usb_interface *iface,
+                         const struct usb_device_id *id)
 {
         struct usb_device *udev = interface_to_usbdev(iface);
-        const struct atp_config *cfg;
-        struct atp *dev;
+        const struct bcm5974_config *cfg;
+        struct bcm5974 *dev;
         struct input_dev *input_dev;
-        int error = 0;
+        int error = -ENOMEM;
 
         /* find the product index */
-        cfg = atp_product_config(udev);
+        cfg = bcm5974_get_config(udev);
 
         /* allocate memory for our device state and initialize it */
-        dev = kzalloc(sizeof(struct atp), GFP_KERNEL);
+        dev = kzalloc(sizeof(struct bcm5974), GFP_KERNEL);
         input_dev = input_allocate_device();
         if (!dev || !input_dev) {
                 err("bcm5974: out of memory");
-                error = -ENOMEM;
                 goto err_free_devs;
         }
 
         dev->udev = udev;
+        dev->intf = iface;
         dev->input = input_dev;
         dev->cfg = *cfg;
+        mutex_init(&dev->pm_mutex);
 
-        /* switch to raw sensor mode */
-        if (atp_wellspring_init(dev)) {
-                error = -EIO;
-                goto err_free_devs;
-        }
-
+        /* setup urbs */
         dev->bt_urb = usb_alloc_urb(0, GFP_KERNEL);
-        if (!dev->bt_urb) {
-                error = -ENOMEM;
+        if (!dev->bt_urb)
                 goto err_free_devs;
-        }
 
         dev->tp_urb = usb_alloc_urb(0, GFP_KERNEL);
-        if (!dev->tp_urb) {
-                error = -ENOMEM;
+        if (!dev->tp_urb)
                 goto err_free_bt_urb;
-        }
 
         dev->bt_data = usb_buffer_alloc(dev->udev,
-                dev->cfg.bt_datalen, GFP_KERNEL,
-                &dev->bt_urb->transfer_dma);
-        if (!dev->bt_data) {
-                error = -ENOMEM;
+                                        dev->cfg.bt_datalen, GFP_KERNEL,
+                                        &dev->bt_urb->transfer_dma);
+        if (!dev->bt_data)
                 goto err_free_urb;
-        }
 
         dev->tp_data = usb_buffer_alloc(dev->udev,
-                dev->cfg.tp_datalen, GFP_KERNEL,
-                &dev->tp_urb->transfer_dma);
-        if (!dev->tp_data) {
-                error = -ENOMEM;
+                                        dev->cfg.tp_datalen, GFP_KERNEL,
+                                        &dev->tp_urb->transfer_dma);
+        if (!dev->tp_data)
                 goto err_free_bt_buffer;
-        }
 
         usb_fill_int_urb(dev->bt_urb, udev,
-                usb_rcvintpipe(udev, cfg->bt_ep),
-                dev->bt_data, dev->cfg.bt_datalen,
-                irq_button, dev, 1);
+                         usb_rcvintpipe(udev, cfg->bt_ep),
+                         dev->bt_data, dev->cfg.bt_datalen,
+                         bcm5974_irq_button, dev, 1);
 
         usb_fill_int_urb(dev->tp_urb, udev,
-                usb_rcvintpipe(udev, cfg->tp_ep),
-                dev->tp_data, dev->cfg.tp_datalen,
-                irq_trackpad, dev, 1);
+                         usb_rcvintpipe(udev, cfg->tp_ep),
+                         dev->tp_data, dev->cfg.tp_datalen,
+                         bcm5974_irq_trackpad, dev, 1);
 
+        /* create bcm5974 device */
         usb_make_path(udev, dev->phys, sizeof(dev->phys));
         strlcat(dev->phys, "/input0", sizeof(dev->phys));
 
@@ -552,24 +654,10 @@ static int atp_probe(struct usb_interface *iface,
 
         input_set_drvdata(input_dev, dev);
 
-        input_dev->open = atp_open;
-        input_dev->close = atp_close;
-
-        set_bit(EV_ABS, input_dev->evbit);
-        input_set_abs_params(input_dev, ABS_PRESSURE,
-                0, cfg->p.dim, cfg->p.dim / SNRATIO, 0);
-        input_set_abs_params(input_dev, ABS_TOOL_WIDTH,
-                0, cfg->w.dim, cfg->w.dim / SNRATIO, 0);
-        input_set_abs_params(input_dev, ABS_X,
-                0, cfg->x.dim, cfg->x.dim / SNRATIO, 0);
-        input_set_abs_params(input_dev, ABS_Y,
-                0, cfg->y.dim, cfg->y.dim / SNRATIO, 0);
+        input_dev->open = bcm5974_open;
+        input_dev->close = bcm5974_close;
 
-        set_bit(EV_KEY, input_dev->evbit);
-        set_bit(BTN_TOOL_FINGER, input_dev->keybit);
-        set_bit(BTN_TOOL_DOUBLETAP, input_dev->keybit);
-        set_bit(BTN_TOOL_TRIPLETAP, input_dev->keybit);
-        set_bit(BTN_LEFT, input_dev->keybit);
+        setup_events_to_report(input_dev, cfg);
 
         error = input_register_device(dev->input);
         if (error)
@@ -592,99 +680,48 @@ err_free_bt_urb:
         usb_free_urb(dev->bt_urb);
 err_free_devs:
         usb_set_intfdata(iface, NULL);
-        kfree(dev);
         input_free_device(input_dev);
+        kfree(dev);
         return error;
 }
 
-static void atp_disconnect(struct usb_interface *iface)
+static void bcm5974_disconnect(struct usb_interface *iface)
 {
-        struct atp *dev = usb_get_intfdata(iface);
+        struct bcm5974 *dev = usb_get_intfdata(iface);
 
         usb_set_intfdata(iface, NULL);
 
-        if (dev) {
-                input_unregister_device(dev->input);
-                usb_buffer_free(dev->udev, dev->cfg.tp_datalen,
+        input_unregister_device(dev->input);
+        usb_buffer_free(dev->udev, dev->cfg.tp_datalen,
                         dev->tp_data, dev->tp_urb->transfer_dma);
-                usb_buffer_free(dev->udev, dev->cfg.bt_datalen,
+        usb_buffer_free(dev->udev, dev->cfg.bt_datalen,
                         dev->bt_data, dev->bt_urb->transfer_dma);
-                usb_free_urb(dev->tp_urb);
-                usb_free_urb(dev->bt_urb);
-                kfree(dev);
-        }
-
-        printk(KERN_INFO "bcm5974: disconnected\n");
-}
-
-static int atp_suspend(struct usb_interface *iface, pm_message_t message)
-{
-        struct atp *dev = usb_get_intfdata(iface);
-
-        if (dev) {
-                if (!dev->suspended)
-                        atp_close(dev->input);
-                dev->suspended++;
-        }
-
-        return 0;
-}
-
-static int atp_resume(struct usb_interface *iface)
-{
-        struct atp *dev = usb_get_intfdata(iface);
-        int error = 0;
-
-        if (dev && dev->suspended) {
-                if (!--dev->suspended)
-                        error = atp_open(dev->input);
-        }
-
-        return error;
-}
-
-static int atp_reset_resume(struct usb_interface *iface)
-{
-        struct atp *dev = usb_get_intfdata(iface);
-
-        if (dev && atp_wellspring_init(dev))
-                printk(KERN_INFO "bcm5974: warning: reset failed\n");
-
-        return atp_resume(iface);
-}
-
-static int atp_pre_reset(struct usb_interface *iface)
-{
-        return atp_suspend(iface, PMSG_ON);
-}
-
-static int atp_post_reset(struct usb_interface *iface)
-{
-        return atp_reset_resume(iface);
+        usb_free_urb(dev->tp_urb);
+        usb_free_urb(dev->bt_urb);
+        kfree(dev);
 }
 
-static struct usb_driver atp_driver = {
-        .name = "bcm5974",
-        .probe = atp_probe,
-        .disconnect = atp_disconnect,
-        .suspend = atp_suspend,
-        .resume = atp_resume,
-        .reset_resume = atp_reset_resume,
-        .pre_reset = atp_pre_reset,
-        .post_reset = atp_post_reset,
-        .id_table = atp_table,
+static struct usb_driver bcm5974_driver = {
+        .name                   = "bcm5974",
+        .probe                  = bcm5974_probe,
+        .disconnect             = bcm5974_disconnect,
+        .suspend                = bcm5974_suspend,
+        .resume                 = bcm5974_resume,
+        .reset_resume           = bcm5974_resume,
+        .id_table               = bcm5974_table,
+        .supports_autosuspend   = 1,
 };
 
-static int __init atp_init(void)
+static int __init bcm5974_init(void)
 {
-        return usb_register(&atp_driver);
+        return usb_register(&bcm5974_driver);
 }
 
-static void __exit atp_exit(void)
+static void __exit bcm5974_exit(void)
 {
-        usb_deregister(&atp_driver);
+        usb_deregister(&bcm5974_driver);
 }
 
-module_init(atp_init);
-module_exit(atp_exit);
+module_init(bcm5974_init);
+module_exit(bcm5974_exit);