Reorganize into a usable debian dkms package

Signed-off-by: Henrik Rydberg <rydberg@euromail.se>

7 files changed, 1160 insertions, 0 deletions

diff --git a/usr/src/dkms_source_tree/Makefile b/usr/src/dkms_source_tree/Makefile
new file mode 100644
index 0000000..6a04556
--- /dev/null
+++ b/usr/src/dkms_source_tree/Makefile
@@ -0,0 +1,5 @@
+#
+# Makefile for input/mouse drivers
+#
+
+obj-m   := bcm5974.o
diff --git a/usr/src/dkms_source_tree/bcm5974.c b/usr/src/dkms_source_tree/bcm5974.c
new file mode 100644
index 0000000..e858f0b
--- /dev/null
+++ b/usr/src/dkms_source_tree/bcm5974.c
@@ -0,0 +1,778 @@
+/*
+ * Apple USB BCM5974 (Macbook Air and Penryn Macbook Pro) multitouch driver
+ *
+ * Copyright (C) 2008      Henrik Rydberg (rydberg@euromail.se)
+ *
+ * The USB initialization and package decoding was made by
+ * Scott Shawcroft as part of the touchd user-space driver project:
+ * Copyright (C) 2008      Scott Shawcroft (scott.shawcroft@gmail.com)
+ *
+ * The BCM5974 driver is based on the appletouch driver:
+ * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
+ * Copyright (C) 2005      Johannes Berg (johannes@sipsolutions.net)
+ * Copyright (C) 2005      Stelian Pop (stelian@popies.net)
+ * Copyright (C) 2005      Frank Arnold (frank@scirocco-5v-turbo.de)
+ * Copyright (C) 2005      Peter Osterlund (petero2@telia.com)
+ * Copyright (C) 2005      Michael Hanselmann (linux-kernel@hansmi.ch)
+ * Copyright (C) 2006      Nicolas Boichat (nicolas@boichat.ch)
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ *
+ */
+
+#include <linux/kernel.h>
+#include <linux/errno.h>
+#include <linux/init.h>
+#include <linux/slab.h>
+#include <linux/module.h>
+#include <linux/usb/input.h>
+#include <linux/hid.h>
+#include <linux/mutex.h>
+
+#define USB_VENDOR_ID_APPLE             0x05ac
+#define BTN_TOOL_PRESS                  0x148
+#define BTN_TOOL_QUADTAP                0x14f
+
+/* MacbookAir, aka wellspring */
+#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 USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI    0x0230
+#define USB_DEVICE_ID_APPLE_WELLSPRING2_ISO     0x0231
+#define USB_DEVICE_ID_APPLE_WELLSPRING2_JIS     0x0232
+/* Macbook5,1 (unibody), aka wellspring3 */
+#define USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI    0x0236
+#define USB_DEVICE_ID_APPLE_WELLSPRING3_ISO     0x0237
+#define USB_DEVICE_ID_APPLE_WELLSPRING3_JIS     0x0238
+
+#define BCM5974_DEVICE(prod) {                                  \
+        .match_flags = (USB_DEVICE_ID_MATCH_DEVICE |            \
+                        USB_DEVICE_ID_MATCH_INT_CLASS |         \
+                        USB_DEVICE_ID_MATCH_INT_PROTOCOL),      \
+        .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 bcm5974_table[] = {
+        /* MacbookAir1.1 */
+        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 */
+        BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI),
+        BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_ISO),
+        BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING2_JIS),
+        /* Macbook5,1 */
+        BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI),
+        BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING3_ISO),
+        BCM5974_DEVICE(USB_DEVICE_ID_APPLE_WELLSPRING3_JIS),
+        /* Terminating entry */
+        {}
+};
+MODULE_DEVICE_TABLE(usb, bcm5974_table);
+
+MODULE_AUTHOR("Henrik Rydberg");
+MODULE_DESCRIPTION("Apple USB BCM5974 multitouch driver");
+MODULE_LICENSE("GPL");
+
+#define dprintk(level, format, a...)\
+        { if (debug >= level) printk(KERN_DEBUG format, ##a); }
+
+static int debug = 1;
+module_param(debug, int, 0644);
+MODULE_PARM_DESC(debug, "Activate debugging output");
+
+/* button data structure */
+struct bt_data {
+        u8 unknown1;            /* constant */
+        u8 button;              /* left button */
+        u8 rel_x;               /* relative x coordinate */
+        u8 rel_y;               /* relative y coordinate */
+};
+
+/* trackpad header types */
+enum tp_type {
+        TYPE1,                  /* plain trackpad */
+        TYPE2                   /* button integrated in trackpad */
+};
+
+/* trackpad finger data offsets */
+#define FINGER_TYPE1            26
+#define FINGER_TYPE2            30
+
+/* trackpad button data offsets */
+#define BUTTON_TYPE2            15
+
+/* integrated button capability by configuration */
+#define HAS_INTEGRATED_BUTTON(c)        (c->tp_type == TYPE2)
+
+/* trackpad finger structure */
+struct tp_finger {
+        __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 */
+        __le16 rel_y;           /* relative y coodinate */
+        __le16 size_major;      /* finger size, major axis? */
+        __le16 size_minor;      /* finger size, minor axis? */
+        __le16 orientation;     /* 16384 when point, else 15 bit angle */
+        __le16 force_major;     /* trackpad force, major axis? */
+        __le16 force_minor;     /* trackpad force, minor axis? */
+        __le16 unused[3];       /* zeros */
+        __le16 multi;           /* one finger: varies, more fingers: constant */
+};
+
+/* trackpad finger data size, empirically at least ten fingers */
+#define SIZEOF_FINGER           sizeof(struct tp_finger)
+#define SIZEOF_ALL_FINGERS      (16 * SIZEOF_FINGER)
+
+/* device-specific parameters */
+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 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 */
+        enum tp_type tp_type;   /* type of trackpad interface */
+        int tp_offset;          /* offset to trackpad finger data */
+        int tp_datalen;         /* data length of the trackpad interface */
+        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 bcm5974 {
+        char phys[64];
+        struct usb_device *udev;        /* usb device */
+        struct usb_interface *intf;     /* our interface */
+        struct input_dev *input;        /* input dev */
+        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 */
+        struct urb *tp_urb;             /* trackpad usb request block */
+        u8 *tp_data;                    /* trackpad transferred data */
+        int fingers;                    /* number of fingers on trackpad */
+};
+
+/* logical dimensions */
+#define DIM_PRESSURE    256             /* maximum finger pressure */
+#define DIM_WIDTH       16              /* maximum finger width */
+#define DIM_X           1280            /* maximum trackpad x value */
+#define DIM_Y           800             /* maximum trackpad y value */
+
+/* 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 bcm5974_config bcm5974_config_table[] = {
+        {
+                USB_DEVICE_ID_APPLE_WELLSPRING_ANSI,
+                USB_DEVICE_ID_APPLE_WELLSPRING_ISO,
+                USB_DEVICE_ID_APPLE_WELLSPRING_JIS,
+                0x84, sizeof(struct bt_data),
+                0x81, TYPE1, FINGER_TYPE1, FINGER_TYPE1 + SIZEOF_ALL_FINGERS,
+                { 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 }
+        },
+        {
+                USB_DEVICE_ID_APPLE_WELLSPRING2_ANSI,
+                USB_DEVICE_ID_APPLE_WELLSPRING2_ISO,
+                USB_DEVICE_ID_APPLE_WELLSPRING2_JIS,
+                0x84, sizeof(struct bt_data),
+                0x81, TYPE1, FINGER_TYPE1, FINGER_TYPE1 + SIZEOF_ALL_FINGERS,
+                { 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 }
+        },
+        {
+                USB_DEVICE_ID_APPLE_WELLSPRING3_ANSI,
+                USB_DEVICE_ID_APPLE_WELLSPRING3_ISO,
+                USB_DEVICE_ID_APPLE_WELLSPRING3_JIS,
+                0x84, sizeof(struct bt_data),
+                0x81, TYPE2, FINGER_TYPE2, FINGER_TYPE2 + SIZEOF_ALL_FINGERS,
+                { DIM_PRESSURE, DIM_PRESSURE / SN_PRESSURE, 0, 300 },
+                { DIM_WIDTH, DIM_WIDTH / SN_WIDTH, 0, 2048 },
+                { DIM_X, DIM_X / SN_COORD, -4460, 5166 },
+                { DIM_Y, DIM_Y / SN_COORD, -75, 6700 }
+        },
+        {}
+};
+
+/* return the device-specific configuration by device */
+static const struct bcm5974_config *bcm5974_get_config(struct usb_device *udev)
+{
+        u16 id = le16_to_cpu(udev->descriptor.idProduct);
+        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 */
+static inline int raw2int(__le16 x)
+{
+        return (signed short)le16_to_cpu(x);
+}
+
+/* scale device data to logical dimensions (asserts devmin < devmax) */
+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 bcm5974_param *p, int x)
+{
+        int s = int2scale(p, x);
+
+        //return clamp_val(s, 0, p->dim - 1);
+        return s < 0 ? 0 : s >= p->dim ? p->dim - 1 : s;
+}
+
+/* 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_TOOL_QUADTAP, input_dev->keybit);
+        if (HAS_INTEGRATED_BUTTON(cfg))
+                __set_bit(BTN_TOOL_PRESS, 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;
+
+        dprintk(7,
+                "bcm5974: button data: %x %x %x %x\n",
+                dev->bt_data->unknown1, dev->bt_data->button,
+                dev->bt_data->rel_x, dev->bt_data->rel_y);
+
+        input_report_key(dev->input, BTN_LEFT, dev->bt_data->button);
+        input_sync(dev->input);
+
+        return 0;
+}
+
+/* report trackpad data as logical trackpad state */
+static int report_tp_state(struct bcm5974 *dev, int size)
+{
+        const struct bcm5974_config *c = &dev->cfg;
+        const struct tp_finger *f;
+        struct input_dev *input = dev->input;
+        int raw_p, raw_w, raw_x, raw_y, raw_n;
+        int ptest = 0, origin = 0, ibt = 0, nmin = 0, nmax = 0;
+        int abs_p = 0, abs_w = 0, abs_x = 0, abs_y = 0;
+
+        if (size < c->tp_offset || (size - c->tp_offset) % SIZEOF_FINGER != 0)
+                return -EIO;
+
+        f = (const struct tp_finger *)(dev->tp_data + c->tp_offset);
+        raw_n = (size - c->tp_offset) / SIZEOF_FINGER;
+
+        /* always track the first finger; when detached, start over */
+        if (raw_n) {
+                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: %d\n", raw_p, raw_w, raw_x, raw_y, raw_n);
+
+                ptest = int2bound(&c->p, raw_p);
+                origin = raw2int(f->origin);
+
+                /* set the integrated button if applicable */
+                if (c->tp_type == TYPE2)
+                        ibt = raw2int(dev->tp_data[BUTTON_TYPE2]);
+        }
+
+        /* 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);
+                while (raw_n--) {
+                        ptest = int2bound(&c->p, raw2int(f->force_major));
+                        if (ptest > PRESSURE_LOW)
+                                nmax++;
+                        if (ptest > PRESSURE_HIGH)
+                                nmin++;
+                        f++;
+                }
+        }
+
+        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 == 3);
+        input_report_key(input, BTN_TOOL_QUADTAP, dev->fingers > 3);
+
+        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 ibt: %d\n", abs_p, abs_w,
+                        abs_x, abs_y, nmin, nmax, dev->fingers, ibt);
+
+        }
+
+        if (HAS_INTEGRATED_BUTTON(c)) {
+                input_report_key(input, BTN_TOOL_PRESS, ibt);
+                input_report_key(input, BTN_LEFT, ibt);
+        }
+
+        input_sync(input);
+
+        return 0;
+}
+
+/* Wellspring initialization constants */
+#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 retval = 0, size;
+
+        if (!data) {
+                err("bcm5974: out of memory");
+                retval = -ENOMEM;
+                goto out;
+        }
+
+        /* read configuration */
+        size = usb_control_msg(dev->udev, usb_rcvctrlpipe(dev->udev, 0),
+                        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");
+                retval = -EIO;
+                goto out;
+        }
+
+        /* apply the mode switch */
+        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),
+                        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");
+                retval = -EIO;
+                goto out;
+        }
+
+        dprintk(2, "bcm5974: switched to %s mode.\n",
+                on ? "wellspring" : "normal");
+
+ out:
+        kfree(data);
+        return retval;
+}
+
+static void bcm5974_irq_button(struct urb *urb)
+{
+        struct bcm5974 *dev = urb->context;
+        int error;
+
+        switch (urb->status) {
+        case 0:
+                break;
+        case -EOVERFLOW:
+        case -ECONNRESET:
+        case -ENOENT:
+        case -ESHUTDOWN:
+                dbg("bcm5974: button urb shutting down: %d", urb->status);
+                return;
+        default:
+                dbg("bcm5974: button urb status: %d", urb->status);
+                goto exit;
+        }
+
+        if (report_bt_state(dev, dev->bt_urb->actual_length))
+                dprintk(1, "bcm5974: bad button package, length: %d\n",
+                        dev->bt_urb->actual_length);
+
+exit:
+        error = usb_submit_urb(dev->bt_urb, GFP_ATOMIC);
+        if (error)
+                err("bcm5974: button urb failed: %d", error);
+}
+
+static void bcm5974_irq_trackpad(struct urb *urb)
+{
+        struct bcm5974 *dev = urb->context;
+        int error;
+
+        switch (urb->status) {
+        case 0:
+                break;
+        case -EOVERFLOW:
+        case -ECONNRESET:
+        case -ENOENT:
+        case -ESHUTDOWN:
+                dbg("bcm5974: trackpad urb shutting down: %d", urb->status);
+                return;
+        default:
+                dbg("bcm5974: trackpad urb status: %d", urb->status);
+                goto exit;
+        }
+
+        /* control response ignored */
+        if (dev->tp_urb->actual_length == 2)
+                goto exit;
+
+        if (report_tp_state(dev, dev->tp_urb->actual_length))
+                dprintk(1, "bcm5974: bad trackpad package, length: %d\n",
+                        dev->tp_urb->actual_length);
+
+exit:
+        error = usb_submit_urb(dev->tp_urb, GFP_ATOMIC);
+        if (error)
+                err("bcm5974: trackpad urb failed: %d", error);
+}
+
+/*
+ * 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)
+{
+        if (bcm5974_wellspring_mode(dev, true)) {
+                dprintk(1, "bcm5974: mode switch failed\n");
+                goto error;
+        }
+
+        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_kill_bt:
+        usb_kill_urb(dev->bt_urb);
+error:
+        return -EIO;
+}
+
+static void bcm5974_pause_traffic(struct bcm5974 *dev)
+{
+        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;
+
+        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 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 bcm5974_config *cfg;
+        struct bcm5974 *dev;
+        struct input_dev *input_dev;
+        int error = -ENOMEM;
+
+        /* find the product index */
+        cfg = bcm5974_get_config(udev);
+
+        /* allocate memory for our device state and initialize it */
+        dev = kzalloc(sizeof(struct bcm5974), GFP_KERNEL);
+        input_dev = input_allocate_device();
+        if (!dev || !input_dev) {
+                err("bcm5974: out of memory");
+                goto err_free_devs;
+        }
+
+        dev->udev = udev;
+        dev->intf = iface;
+        dev->input = input_dev;
+        dev->cfg = *cfg;
+        mutex_init(&dev->pm_mutex);
+
+        /* setup urbs */
+        dev->bt_urb = usb_alloc_urb(0, GFP_KERNEL);
+        if (!dev->bt_urb)
+                goto err_free_devs;
+
+        dev->tp_urb = usb_alloc_urb(0, GFP_KERNEL);
+        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)
+                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)
+                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,
+                         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,
+                         bcm5974_irq_trackpad, dev, 1);
+
+        /* create bcm5974 device */
+        usb_make_path(udev, dev->phys, sizeof(dev->phys));
+        strlcat(dev->phys, "/input0", sizeof(dev->phys));
+
+        input_dev->name = "bcm5974";
+        input_dev->phys = dev->phys;
+        usb_to_input_id(dev->udev, &input_dev->id);
+        input_dev->dev.parent = &iface->dev;
+
+        input_set_drvdata(input_dev, dev);
+
+        input_dev->open = bcm5974_open;
+        input_dev->close = bcm5974_close;
+
+        setup_events_to_report(input_dev, cfg);
+
+        error = input_register_device(dev->input);
+        if (error)
+                goto err_free_buffer;
+
+        /* save our data pointer in this interface device */
+        usb_set_intfdata(iface, dev);
+
+        return 0;
+
+err_free_buffer:
+        usb_buffer_free(dev->udev, dev->cfg.tp_datalen,
+                dev->tp_data, dev->tp_urb->transfer_dma);
+err_free_bt_buffer:
+        usb_buffer_free(dev->udev, dev->cfg.bt_datalen,
+                dev->bt_data, dev->bt_urb->transfer_dma);
+err_free_urb:
+        usb_free_urb(dev->tp_urb);
+err_free_bt_urb:
+        usb_free_urb(dev->bt_urb);
+err_free_devs:
+        usb_set_intfdata(iface, NULL);
+        input_free_device(input_dev);
+        kfree(dev);
+        return error;
+}
+
+static void bcm5974_disconnect(struct usb_interface *iface)
+{
+        struct bcm5974 *dev = usb_get_intfdata(iface);
+
+        usb_set_intfdata(iface, NULL);
+
+        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,
+                        dev->bt_data, dev->bt_urb->transfer_dma);
+        usb_free_urb(dev->tp_urb);
+        usb_free_urb(dev->bt_urb);
+        kfree(dev);
+}
+
+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 bcm5974_init(void)
+{
+        return usb_register(&bcm5974_driver);
+}
+
+static void __exit bcm5974_exit(void)
+{
+        usb_deregister(&bcm5974_driver);
+}
+
+module_init(bcm5974_init);
+module_exit(bcm5974_exit);
+
diff --git a/usr/src/dkms_source_tree/dkms.conf b/usr/src/dkms_source_tree/dkms.conf
new file mode 100644
index 0000000..df7925c
--- /dev/null
+++ b/usr/src/dkms_source_tree/dkms.conf
@@ -0,0 +1,11 @@
+NAME=bcm5974
+VERSION=0.99
+PACKAGE_NAME="$NAME"
+PACKAGE_VERSION="$VERSION"
+MAKE[0]="make -C ${kernel_source_dir}
+  SUBDIRS=${dkms_tree}/${PACKAGE_NAME}/${PACKAGE_VERSION}/build modules"
+BUILT_MODULE_NAME[0]="bcm5974"
+DEST_MODULE_LOCATION[0]="/kernel/drivers/input/mouse"
+PRE_INSTALL="scripts/bcm5974-pre-install"
+POST_INSTALL="scripts/bcm5974-post-install"
+POST_REMOVE="scripts/bcm5974-post-remove"
diff --git a/usr/src/dkms_source_tree/scripts/bcm5974-diagnostics b/usr/src/dkms_source_tree/scripts/bcm5974-diagnostics
new file mode 100755
index 0000000..acd0bf4
--- /dev/null
+++ b/usr/src/dkms_source_tree/scripts/bcm5974-diagnostics
@@ -0,0 +1,232 @@
+#!/bin/bash
+#
+# bcm5943-diagnostics - troubleshooting the BCM5974 setup
+#
+# Copyright (C) 2008       Henrik Rydberg (rydberg@euromail.se)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+
+DRIVER=bcm5974
+
+echo -----------------------------------------------------------------------
+
+# What kernel version am I running?
+KERNEL=`uname -r`
+echo \* Kernel version: $KERNEL
+
+# What synaptics version is installed (debian)?
+if [ -x /usr/bin/dpkg-query ]; then
+    SYNAPTICS=`/usr/bin/dpkg-query -W -f='${Version}\n' xserver-xorg-input-synaptics`
+    echo \* Synaptics version: $SYNAPTICS
+else
+    echo \* Synaptics version: UNKNOWN - dpkg not found
+fi
+
+# What USB devices of interest can we find?
+if [ -x /usr/sbin/lsusb ]; then
+    LSUSB=`lsusb|grep 05ac:02`
+    echo \* USB device: $LSUSB
+else
+    echo \* USB device: UNKNOWN - lsusb not found
+fi
+
+# Do we have the module intalled?
+MODLIB=/lib/modules/$KERNEL/kernel/drivers/input/mouse/$DRIVER.ko
+MODLIB2=/lib/modules/$KERNEL/updates/dkms/$DRIVER.ko
+if [ -f $MODLIB ]; then
+    echo \* $MODLIB: exists
+elif [ -f $MODLIB2 ]; then
+    echo \* $MODLIB2: exists
+else
+    echo \* $DRIVER does NOT exist
+    echo dkms: install package
+    echo manual: copy the file $DRIVER.ko to $MODLIB
+    exit 1
+fi
+
+# Do we have the module configured?
+MODULES=/etc/modules
+if [ -f $MODULES ]; then
+    if (grep -q $DRIVER $MODULES); then
+        echo \* $MODULES: has $DRIVER config, please remove
+        exit 1
+    else
+        echo \* $MODULES: $DRIVER no longer explicitly listed, good
+    fi
+fi
+
+# Do we have old quirks?
+MODPROBE=/etc/modprobe.d/options
+if [ -f $MODPROBE ]; then
+    MODPROBEOPTS=`grep quirks= $MODPROBE|grep -v ^#|grep 0x05ac:0x02`
+    if [ "$MODPROBEOPTS" != "" ]; then
+        echo \* $MODPROBE: has obsolete quirks - please remove
+        exit 1
+    else
+        echo \* $MODPROBE: no obsolete quirks, good
+    fi
+else
+    echo \* $MODPROBE: file not found
+fi
+
+# Do we have the right quirks?
+DRIVMOD=/etc/modprobe.d/$DRIVER
+if [ -f $DRIVMOD ]; then
+    DRIVMODOPTS=`grep quirks= $DRIVMOD|grep -v ^#|grep 0x05ac:0x02`
+    if [ "$DRIVMODOPTS" != "" ]; then
+        echo \* $DRIVMOD: has quirks, good
+    else
+        echo \* $DRIVMOD: does NOT have quirks
+        echo Uncomment the right quirk line in $DRIVMOD
+        exit 1
+    fi
+else
+    echo \* $DRIVMOD: file not found
+    echo Copy the etc/modprobe.d/bcm5974 file to /etc/modprobe.d/
+    exit 1
+fi
+
+# Did the depmod bite?
+USBMAP=/lib/modules/$KERNEL/modules.usbmap
+if [ -f $USBMAP ]; then
+    typeset -i nusb=`grep $DRIVER $USBMAP|grep 0x05ac|grep 0x02|wc -l`
+    if [ $nusb -gt 0 ]; then
+        echo \* $USBMAP: maps to $DRIVER, good
+    else
+        echo \* $USBMAP: does NOT map to $DRIVER
+        echo Run depmod -a as root
+        exit 1
+    fi
+fi      
+
+# Was the $DRIVER module loaded?
+DMESG=`lsmod|grep $DRIVER`
+if [ "$DMESG" != "" ]; then
+    echo \* $DRIVER: module is loaded
+else
+    echo \* $DRIVER: module is NOT loaded
+    echo Add this line to /etc/modules:
+    echo "$DRIVER"
+    exit 1
+fi
+
+# Was the $DRIVER module registered?
+DEVPATH=/proc/bus/input/devices
+if [ -f $DEVPATH ]; then
+    DEVICES=`grep $DRIVER /proc/bus/input/devices`
+    if [ "$DEVICES" != "" ]; then
+        echo \* $DEVPATH: module is registered
+    else
+        echo \* $DEVPATH: module is NOT registered
+        echo "Please double-check the quirks settings in $DRIVMOD"
+        exit 1
+    fi
+else
+    echo \* $DEVPATH: does not exist, ignore
+fi
+
+# Do we have synaptics working properly?
+typeset -i SYNLINES=`synclient -l|wc -l`
+if [ $SYNLINES -gt 10 ]; then
+    echo \* synaptics: configuration readable
+else
+    echo \* synaptics: configuration NOT readable
+    exit 1
+fi
+
+# Do we have a working synaptics configuration?
+DIFF=/tmp/synclient-output.diff.$$
+TMP=/tmp/synclient-output.txt.$$
+synclient -l | grep -v Parameter | sort > $TMP
+diff -u - $TMP > $DIFF <<EOF
+    AccelFactor             = 0.1
+    BottomEdge              = 800
+    CircScrollDelta         = 0.1
+    CircScrollTrigger       = 0
+    CircularPad             = 0
+    CircularScrolling       = 0
+    ClickTime               = 100
+    CoastingSpeed           = 0
+    CornerCoasting          = 0
+    EdgeMotionMaxSpeed      = 80
+    EdgeMotionMaxZ          = 160
+    EdgeMotionMinSpeed      = 1
+    EdgeMotionMinZ          = 30
+    EdgeMotionUseAlways     = 0
+    EmulateMidButtonTime    = 75
+    EmulateTwoFingerMinZ    = 257
+    FastTaps                = 0
+    FingerHigh              = 80
+    FingerLow               = 16
+    FingerPress             = 256
+    GrabEventDevice         = 1
+    GuestMouseOff           = 0
+    HorizEdgeScroll         = 0
+    HorizScrollDelta        = 0
+    HorizTwoFingerScroll    = 1
+    LBCornerButton          = 0
+    LeftEdge                = 0
+    LeftRightScrolling      = 1
+    LeftRightScrollRepeat   = 1
+    LockedDrags             = 0
+    LockedDragTimeout       = 5000
+    LTCornerButton          = 0
+    MaxDoubleTapTime        = 200
+    MaxSpeed                = 1.2
+    MaxTapMove              = 100
+    MaxTapTime              = 223
+    MinSpeed                = 0.8
+    MultiFingerButton       = 2
+    PalmDetect              = 0
+    PalmMinWidth            = 10
+    PalmMinZ                = 200
+    PressureMotionMaxFactor = 1
+    PressureMotionMaxZ      = 160
+    PressureMotionMinFactor = 1
+    PressureMotionMinZ      = 10
+    RBCornerButton          = 0
+    RightEdge               = 1280
+    RTCornerButton          = 0
+    ScrollButtonRepeat      = 100
+    SingleTapTimeout        = 180
+    TapButton1              = 0
+    TapButton2              = 0
+    TapButton3              = 0
+    TopEdge                 = 0
+    TouchpadOff             = 0
+    TrackstickSpeed         = 40
+    UpDownScrolling         = 1
+    UpDownScrollRepeat      = 1
+    VertEdgeScroll          = 0
+    VertScrollDelta         = 40
+    VertTwoFingerScroll     = 1
+EOF
+rm -f $TMP
+
+echo =======================================================================
+echo The bcm5974 seems properly configured
+
+typeset -i NDIFF=`cat $DIFF|wc -l`
+if [ $NDIFF -gt 0 ]; then
+    echo
+    echo Your synaptics settings differ from the bcm5974 default:
+    echo -----------------------------------------------------------------------
+    tail -n +4 $DIFF
+    echo -----------------------------------------------------------------------
+    echo If in doubt, please check your /etc/X11/xorg.conf settings
+fi
+
+rm -f $DIFF
diff --git a/usr/src/dkms_source_tree/scripts/bcm5974-post-install b/usr/src/dkms_source_tree/scripts/bcm5974-post-install
new file mode 100755
index 0000000..de5094c
--- /dev/null
+++ b/usr/src/dkms_source_tree/scripts/bcm5974-post-install
@@ -0,0 +1,63 @@
+#!/bin/bash
+#
+# bcm5943-post-install - post-installing the BCM5974
+#
+# Copyright (C) 2008       Henrik Rydberg (rydberg@euromail.se)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+
+DRIVER=bcm5974
+ETCPATH=/etc/modprobe.d/$DRIVER
+
+echo -----------------------------------------------------------------------
+
+DIR=`dirname $0`
+LSUSB=/usr/sbin/lsusb
+
+PAT_HEAD="options usbhid quirks="
+
+DEV[0]="0223"
+DEV[1]="0224"
+DEV[2]="0225"
+DEV[3]="0230"
+DEV[4]="0231"
+DEV[5]="0232"
+DEV[6]="0236"
+DEV[7]="0237"
+DEV[8]="0238"
+
+if [ -x $LSUSB ]; then
+    typeset -i i=0
+    while [ $i -lt 9 ]; do
+        PAT=05ac:${DEV[$i]}
+        MATCH=${PAT_HEAD}0x05ac:0x${DEV[$i]}
+        if [ "`$LSUSB|grep $PAT`" != "" ]; then
+            SED="s/#$MATCH/$MATCH/"
+        fi
+        i=$i+1
+    done
+else
+    echo \* USB device: UNKNOWN - lsusb not found
+    exit 1
+fi
+
+if [ "$SED" != "" ]; then
+    cat $DIR/..$ETCPATH | sed "$SED" > $ETCPATH
+    exit 0
+else
+    echo No suitable device found
+    exit 1
+fi
diff --git a/usr/src/dkms_source_tree/scripts/bcm5974-post-remove b/usr/src/dkms_source_tree/scripts/bcm5974-post-remove
new file mode 100755
index 0000000..21977de
--- /dev/null
+++ b/usr/src/dkms_source_tree/scripts/bcm5974-post-remove
@@ -0,0 +1,29 @@
+#!/bin/bash
+#
+# bcm5943-post-remove - post-removing the BCM5974
+#
+# Copyright (C) 2008       Henrik Rydberg (rydberg@euromail.se)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+
+DRIVER=bcm5974
+ETCPATH=/etc/modprobe.d/$DRIVER
+
+echo -----------------------------------------------------------------------
+
+rm -f $ETCPATH
+
+exit 0
diff --git a/usr/src/dkms_source_tree/scripts/bcm5974-pre-install b/usr/src/dkms_source_tree/scripts/bcm5974-pre-install
new file mode 100755
index 0000000..1e2b864
--- /dev/null
+++ b/usr/src/dkms_source_tree/scripts/bcm5974-pre-install
@@ -0,0 +1,42 @@
+#!/bin/bash
+#
+# bcm5943-pre-install - check system before installing the bcm5974
+#
+# Copyright (C) 2008       Henrik Rydberg (rydberg@euromail.se)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.   See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+
+DRIVER=bcm5974
+LSUSB=/usr/sbin/lsusb
+
+PAT[0]="05ac:022"
+PAT[1]="05ac:023"
+
+if [ -x $LSUSB ]; then
+    if [ "`$LSUSB|grep ${PAT[0]}`" != "" ]; then
+        exit 0
+    elif [ "`$LSUSB|grep ${PAT[1]}`" != "" ]; then
+        exit 0
+    else
+        echo bcm5974: no suitable device found
+        exit -1
+    fi
+else
+    echo bcm5974: cannot determine device type
+    exit -1
+fi
+
+exit 0