1ba0acb5eSDmitry Torokhov /* 2ba0acb5eSDmitry Torokhov * A driver for the Griffin Technology, Inc. "PowerMate" USB controller dial. 3ba0acb5eSDmitry Torokhov * 4ba0acb5eSDmitry Torokhov * v1.1, (c)2002 William R Sowerbutts <will@sowerbutts.com> 5ba0acb5eSDmitry Torokhov * 6ba0acb5eSDmitry Torokhov * This device is a anodised aluminium knob which connects over USB. It can measure 7ba0acb5eSDmitry Torokhov * clockwise and anticlockwise rotation. The dial also acts as a pushbutton with 8ba0acb5eSDmitry Torokhov * a spring for automatic release. The base contains a pair of LEDs which illuminate 9ba0acb5eSDmitry Torokhov * the translucent base. It rotates without limit and reports its relative rotation 10ba0acb5eSDmitry Torokhov * back to the host when polled by the USB controller. 11ba0acb5eSDmitry Torokhov * 12ba0acb5eSDmitry Torokhov * Testing with the knob I have has shown that it measures approximately 94 "clicks" 13ba0acb5eSDmitry Torokhov * for one full rotation. Testing with my High Speed Rotation Actuator (ok, it was 14ba0acb5eSDmitry Torokhov * a variable speed cordless electric drill) has shown that the device can measure 15ba0acb5eSDmitry Torokhov * speeds of up to 7 clicks either clockwise or anticlockwise between pollings from 16ba0acb5eSDmitry Torokhov * the host. If it counts more than 7 clicks before it is polled, it will wrap back 17ba0acb5eSDmitry Torokhov * to zero and start counting again. This was at quite high speed, however, almost 18ba0acb5eSDmitry Torokhov * certainly faster than the human hand could turn it. Griffin say that it loses a 19ba0acb5eSDmitry Torokhov * pulse or two on a direction change; the granularity is so fine that I never 20ba0acb5eSDmitry Torokhov * noticed this in practice. 21ba0acb5eSDmitry Torokhov * 22ba0acb5eSDmitry Torokhov * The device's microcontroller can be programmed to set the LED to either a constant 23ba0acb5eSDmitry Torokhov * intensity, or to a rhythmic pulsing. Several patterns and speeds are available. 24ba0acb5eSDmitry Torokhov * 25ba0acb5eSDmitry Torokhov * Griffin were very happy to provide documentation and free hardware for development. 26ba0acb5eSDmitry Torokhov * 27ba0acb5eSDmitry Torokhov * Some userspace tools are available on the web: http://sowerbutts.com/powermate/ 28ba0acb5eSDmitry Torokhov * 29ba0acb5eSDmitry Torokhov */ 30ba0acb5eSDmitry Torokhov 31ba0acb5eSDmitry Torokhov #include <linux/kernel.h> 32ba0acb5eSDmitry Torokhov #include <linux/slab.h> 33ba0acb5eSDmitry Torokhov #include <linux/module.h> 34ba0acb5eSDmitry Torokhov #include <linux/init.h> 35ba0acb5eSDmitry Torokhov #include <linux/spinlock.h> 36ba0acb5eSDmitry Torokhov #include <linux/usb/input.h> 37ba0acb5eSDmitry Torokhov 38ba0acb5eSDmitry Torokhov #define POWERMATE_VENDOR 0x077d /* Griffin Technology, Inc. */ 39ba0acb5eSDmitry Torokhov #define POWERMATE_PRODUCT_NEW 0x0410 /* Griffin PowerMate */ 40ba0acb5eSDmitry Torokhov #define POWERMATE_PRODUCT_OLD 0x04AA /* Griffin soundKnob */ 41ba0acb5eSDmitry Torokhov 42ba0acb5eSDmitry Torokhov #define CONTOUR_VENDOR 0x05f3 /* Contour Design, Inc. */ 43ba0acb5eSDmitry Torokhov #define CONTOUR_JOG 0x0240 /* Jog and Shuttle */ 44ba0acb5eSDmitry Torokhov 45ba0acb5eSDmitry Torokhov /* these are the command codes we send to the device */ 46ba0acb5eSDmitry Torokhov #define SET_STATIC_BRIGHTNESS 0x01 47ba0acb5eSDmitry Torokhov #define SET_PULSE_ASLEEP 0x02 48ba0acb5eSDmitry Torokhov #define SET_PULSE_AWAKE 0x03 49ba0acb5eSDmitry Torokhov #define SET_PULSE_MODE 0x04 50ba0acb5eSDmitry Torokhov 51ba0acb5eSDmitry Torokhov /* these refer to bits in the powermate_device's requires_update field. */ 52ba0acb5eSDmitry Torokhov #define UPDATE_STATIC_BRIGHTNESS (1<<0) 53ba0acb5eSDmitry Torokhov #define UPDATE_PULSE_ASLEEP (1<<1) 54ba0acb5eSDmitry Torokhov #define UPDATE_PULSE_AWAKE (1<<2) 55ba0acb5eSDmitry Torokhov #define UPDATE_PULSE_MODE (1<<3) 56ba0acb5eSDmitry Torokhov 57ba0acb5eSDmitry Torokhov /* at least two versions of the hardware exist, with differing payload 58ba0acb5eSDmitry Torokhov sizes. the first three bytes always contain the "interesting" data in 59ba0acb5eSDmitry Torokhov the relevant format. */ 60ba0acb5eSDmitry Torokhov #define POWERMATE_PAYLOAD_SIZE_MAX 6 61ba0acb5eSDmitry Torokhov #define POWERMATE_PAYLOAD_SIZE_MIN 3 62ba0acb5eSDmitry Torokhov struct powermate_device { 63ba0acb5eSDmitry Torokhov signed char *data; 64ba0acb5eSDmitry Torokhov dma_addr_t data_dma; 65ba0acb5eSDmitry Torokhov struct urb *irq, *config; 66ba0acb5eSDmitry Torokhov struct usb_ctrlrequest *configcr; 67ba0acb5eSDmitry Torokhov dma_addr_t configcr_dma; 68ba0acb5eSDmitry Torokhov struct usb_device *udev; 69ba0acb5eSDmitry Torokhov struct input_dev *input; 70ba0acb5eSDmitry Torokhov spinlock_t lock; 71ba0acb5eSDmitry Torokhov int static_brightness; 72ba0acb5eSDmitry Torokhov int pulse_speed; 73ba0acb5eSDmitry Torokhov int pulse_table; 74ba0acb5eSDmitry Torokhov int pulse_asleep; 75ba0acb5eSDmitry Torokhov int pulse_awake; 76ba0acb5eSDmitry Torokhov int requires_update; // physical settings which are out of sync 77ba0acb5eSDmitry Torokhov char phys[64]; 78ba0acb5eSDmitry Torokhov }; 79ba0acb5eSDmitry Torokhov 80ba0acb5eSDmitry Torokhov static char pm_name_powermate[] = "Griffin PowerMate"; 81ba0acb5eSDmitry Torokhov static char pm_name_soundknob[] = "Griffin SoundKnob"; 82ba0acb5eSDmitry Torokhov 83ba0acb5eSDmitry Torokhov static void powermate_config_complete(struct urb *urb); 84ba0acb5eSDmitry Torokhov 85ba0acb5eSDmitry Torokhov /* Callback for data arriving from the PowerMate over the USB interrupt pipe */ 86ba0acb5eSDmitry Torokhov static void powermate_irq(struct urb *urb) 87ba0acb5eSDmitry Torokhov { 88ba0acb5eSDmitry Torokhov struct powermate_device *pm = urb->context; 89ba0acb5eSDmitry Torokhov int retval; 90ba0acb5eSDmitry Torokhov 91ba0acb5eSDmitry Torokhov switch (urb->status) { 92ba0acb5eSDmitry Torokhov case 0: 93ba0acb5eSDmitry Torokhov /* success */ 94ba0acb5eSDmitry Torokhov break; 95ba0acb5eSDmitry Torokhov case -ECONNRESET: 96ba0acb5eSDmitry Torokhov case -ENOENT: 97ba0acb5eSDmitry Torokhov case -ESHUTDOWN: 98ba0acb5eSDmitry Torokhov /* this urb is terminated, clean up */ 99ba0acb5eSDmitry Torokhov dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status); 100ba0acb5eSDmitry Torokhov return; 101ba0acb5eSDmitry Torokhov default: 102ba0acb5eSDmitry Torokhov dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status); 103ba0acb5eSDmitry Torokhov goto exit; 104ba0acb5eSDmitry Torokhov } 105ba0acb5eSDmitry Torokhov 106ba0acb5eSDmitry Torokhov /* handle updates to device state */ 107ba0acb5eSDmitry Torokhov input_report_key(pm->input, BTN_0, pm->data[0] & 0x01); 108ba0acb5eSDmitry Torokhov input_report_rel(pm->input, REL_DIAL, pm->data[1]); 109ba0acb5eSDmitry Torokhov input_sync(pm->input); 110ba0acb5eSDmitry Torokhov 111ba0acb5eSDmitry Torokhov exit: 112ba0acb5eSDmitry Torokhov retval = usb_submit_urb (urb, GFP_ATOMIC); 113ba0acb5eSDmitry Torokhov if (retval) 114ba0acb5eSDmitry Torokhov err ("%s - usb_submit_urb failed with result %d", 115ba0acb5eSDmitry Torokhov __FUNCTION__, retval); 116ba0acb5eSDmitry Torokhov } 117ba0acb5eSDmitry Torokhov 118ba0acb5eSDmitry Torokhov /* Decide if we need to issue a control message and do so. Must be called with pm->lock taken */ 119ba0acb5eSDmitry Torokhov static void powermate_sync_state(struct powermate_device *pm) 120ba0acb5eSDmitry Torokhov { 121ba0acb5eSDmitry Torokhov if (pm->requires_update == 0) 122ba0acb5eSDmitry Torokhov return; /* no updates are required */ 123ba0acb5eSDmitry Torokhov if (pm->config->status == -EINPROGRESS) 124ba0acb5eSDmitry Torokhov return; /* an update is already in progress; it'll issue this update when it completes */ 125ba0acb5eSDmitry Torokhov 126ba0acb5eSDmitry Torokhov if (pm->requires_update & UPDATE_PULSE_ASLEEP){ 127ba0acb5eSDmitry Torokhov pm->configcr->wValue = cpu_to_le16( SET_PULSE_ASLEEP ); 128ba0acb5eSDmitry Torokhov pm->configcr->wIndex = cpu_to_le16( pm->pulse_asleep ? 1 : 0 ); 129ba0acb5eSDmitry Torokhov pm->requires_update &= ~UPDATE_PULSE_ASLEEP; 130ba0acb5eSDmitry Torokhov }else if (pm->requires_update & UPDATE_PULSE_AWAKE){ 131ba0acb5eSDmitry Torokhov pm->configcr->wValue = cpu_to_le16( SET_PULSE_AWAKE ); 132ba0acb5eSDmitry Torokhov pm->configcr->wIndex = cpu_to_le16( pm->pulse_awake ? 1 : 0 ); 133ba0acb5eSDmitry Torokhov pm->requires_update &= ~UPDATE_PULSE_AWAKE; 134ba0acb5eSDmitry Torokhov }else if (pm->requires_update & UPDATE_PULSE_MODE){ 135ba0acb5eSDmitry Torokhov int op, arg; 136ba0acb5eSDmitry Torokhov /* the powermate takes an operation and an argument for its pulse algorithm. 137ba0acb5eSDmitry Torokhov the operation can be: 138ba0acb5eSDmitry Torokhov 0: divide the speed 139ba0acb5eSDmitry Torokhov 1: pulse at normal speed 140ba0acb5eSDmitry Torokhov 2: multiply the speed 141ba0acb5eSDmitry Torokhov the argument only has an effect for operations 0 and 2, and ranges between 142ba0acb5eSDmitry Torokhov 1 (least effect) to 255 (maximum effect). 143ba0acb5eSDmitry Torokhov 144ba0acb5eSDmitry Torokhov thus, several states are equivalent and are coalesced into one state. 145ba0acb5eSDmitry Torokhov 146ba0acb5eSDmitry Torokhov we map this onto a range from 0 to 510, with: 147ba0acb5eSDmitry Torokhov 0 -- 254 -- use divide (0 = slowest) 148ba0acb5eSDmitry Torokhov 255 -- use normal speed 149ba0acb5eSDmitry Torokhov 256 -- 510 -- use multiple (510 = fastest). 150ba0acb5eSDmitry Torokhov 151ba0acb5eSDmitry Torokhov Only values of 'arg' quite close to 255 are particularly useful/spectacular. 152ba0acb5eSDmitry Torokhov */ 153ba0acb5eSDmitry Torokhov if (pm->pulse_speed < 255) { 154ba0acb5eSDmitry Torokhov op = 0; // divide 155ba0acb5eSDmitry Torokhov arg = 255 - pm->pulse_speed; 156ba0acb5eSDmitry Torokhov } else if (pm->pulse_speed > 255) { 157ba0acb5eSDmitry Torokhov op = 2; // multiply 158ba0acb5eSDmitry Torokhov arg = pm->pulse_speed - 255; 159ba0acb5eSDmitry Torokhov } else { 160ba0acb5eSDmitry Torokhov op = 1; // normal speed 161ba0acb5eSDmitry Torokhov arg = 0; // can be any value 162ba0acb5eSDmitry Torokhov } 163ba0acb5eSDmitry Torokhov pm->configcr->wValue = cpu_to_le16( (pm->pulse_table << 8) | SET_PULSE_MODE ); 164ba0acb5eSDmitry Torokhov pm->configcr->wIndex = cpu_to_le16( (arg << 8) | op ); 165ba0acb5eSDmitry Torokhov pm->requires_update &= ~UPDATE_PULSE_MODE; 166ba0acb5eSDmitry Torokhov } else if (pm->requires_update & UPDATE_STATIC_BRIGHTNESS) { 167ba0acb5eSDmitry Torokhov pm->configcr->wValue = cpu_to_le16( SET_STATIC_BRIGHTNESS ); 168ba0acb5eSDmitry Torokhov pm->configcr->wIndex = cpu_to_le16( pm->static_brightness ); 169ba0acb5eSDmitry Torokhov pm->requires_update &= ~UPDATE_STATIC_BRIGHTNESS; 170ba0acb5eSDmitry Torokhov } else { 171ba0acb5eSDmitry Torokhov printk(KERN_ERR "powermate: unknown update required"); 172ba0acb5eSDmitry Torokhov pm->requires_update = 0; /* fudge the bug */ 173ba0acb5eSDmitry Torokhov return; 174ba0acb5eSDmitry Torokhov } 175ba0acb5eSDmitry Torokhov 176ba0acb5eSDmitry Torokhov /* printk("powermate: %04x %04x\n", pm->configcr->wValue, pm->configcr->wIndex); */ 177ba0acb5eSDmitry Torokhov 178ba0acb5eSDmitry Torokhov pm->configcr->bRequestType = 0x41; /* vendor request */ 179ba0acb5eSDmitry Torokhov pm->configcr->bRequest = 0x01; 180ba0acb5eSDmitry Torokhov pm->configcr->wLength = 0; 181ba0acb5eSDmitry Torokhov 182ba0acb5eSDmitry Torokhov usb_fill_control_urb(pm->config, pm->udev, usb_sndctrlpipe(pm->udev, 0), 183ba0acb5eSDmitry Torokhov (void *) pm->configcr, NULL, 0, 184ba0acb5eSDmitry Torokhov powermate_config_complete, pm); 185ba0acb5eSDmitry Torokhov pm->config->setup_dma = pm->configcr_dma; 186ba0acb5eSDmitry Torokhov pm->config->transfer_flags |= URB_NO_SETUP_DMA_MAP; 187ba0acb5eSDmitry Torokhov 188ba0acb5eSDmitry Torokhov if (usb_submit_urb(pm->config, GFP_ATOMIC)) 189ba0acb5eSDmitry Torokhov printk(KERN_ERR "powermate: usb_submit_urb(config) failed"); 190ba0acb5eSDmitry Torokhov } 191ba0acb5eSDmitry Torokhov 192ba0acb5eSDmitry Torokhov /* Called when our asynchronous control message completes. We may need to issue another immediately */ 193ba0acb5eSDmitry Torokhov static void powermate_config_complete(struct urb *urb) 194ba0acb5eSDmitry Torokhov { 195ba0acb5eSDmitry Torokhov struct powermate_device *pm = urb->context; 196ba0acb5eSDmitry Torokhov unsigned long flags; 197ba0acb5eSDmitry Torokhov 198ba0acb5eSDmitry Torokhov if (urb->status) 199ba0acb5eSDmitry Torokhov printk(KERN_ERR "powermate: config urb returned %d\n", urb->status); 200ba0acb5eSDmitry Torokhov 201ba0acb5eSDmitry Torokhov spin_lock_irqsave(&pm->lock, flags); 202ba0acb5eSDmitry Torokhov powermate_sync_state(pm); 203ba0acb5eSDmitry Torokhov spin_unlock_irqrestore(&pm->lock, flags); 204ba0acb5eSDmitry Torokhov } 205ba0acb5eSDmitry Torokhov 206ba0acb5eSDmitry Torokhov /* Set the LED up as described and begin the sync with the hardware if required */ 207ba0acb5eSDmitry Torokhov static void powermate_pulse_led(struct powermate_device *pm, int static_brightness, int pulse_speed, 208ba0acb5eSDmitry Torokhov int pulse_table, int pulse_asleep, int pulse_awake) 209ba0acb5eSDmitry Torokhov { 210ba0acb5eSDmitry Torokhov unsigned long flags; 211ba0acb5eSDmitry Torokhov 212ba0acb5eSDmitry Torokhov if (pulse_speed < 0) 213ba0acb5eSDmitry Torokhov pulse_speed = 0; 214ba0acb5eSDmitry Torokhov if (pulse_table < 0) 215ba0acb5eSDmitry Torokhov pulse_table = 0; 216ba0acb5eSDmitry Torokhov if (pulse_speed > 510) 217ba0acb5eSDmitry Torokhov pulse_speed = 510; 218ba0acb5eSDmitry Torokhov if (pulse_table > 2) 219ba0acb5eSDmitry Torokhov pulse_table = 2; 220ba0acb5eSDmitry Torokhov 221ba0acb5eSDmitry Torokhov pulse_asleep = !!pulse_asleep; 222ba0acb5eSDmitry Torokhov pulse_awake = !!pulse_awake; 223ba0acb5eSDmitry Torokhov 224ba0acb5eSDmitry Torokhov 225ba0acb5eSDmitry Torokhov spin_lock_irqsave(&pm->lock, flags); 226ba0acb5eSDmitry Torokhov 227ba0acb5eSDmitry Torokhov /* mark state updates which are required */ 228ba0acb5eSDmitry Torokhov if (static_brightness != pm->static_brightness) { 229ba0acb5eSDmitry Torokhov pm->static_brightness = static_brightness; 230ba0acb5eSDmitry Torokhov pm->requires_update |= UPDATE_STATIC_BRIGHTNESS; 231ba0acb5eSDmitry Torokhov } 232ba0acb5eSDmitry Torokhov if (pulse_asleep != pm->pulse_asleep) { 233ba0acb5eSDmitry Torokhov pm->pulse_asleep = pulse_asleep; 234ba0acb5eSDmitry Torokhov pm->requires_update |= (UPDATE_PULSE_ASLEEP | UPDATE_STATIC_BRIGHTNESS); 235ba0acb5eSDmitry Torokhov } 236ba0acb5eSDmitry Torokhov if (pulse_awake != pm->pulse_awake) { 237ba0acb5eSDmitry Torokhov pm->pulse_awake = pulse_awake; 238ba0acb5eSDmitry Torokhov pm->requires_update |= (UPDATE_PULSE_AWAKE | UPDATE_STATIC_BRIGHTNESS); 239ba0acb5eSDmitry Torokhov } 240ba0acb5eSDmitry Torokhov if (pulse_speed != pm->pulse_speed || pulse_table != pm->pulse_table) { 241ba0acb5eSDmitry Torokhov pm->pulse_speed = pulse_speed; 242ba0acb5eSDmitry Torokhov pm->pulse_table = pulse_table; 243ba0acb5eSDmitry Torokhov pm->requires_update |= UPDATE_PULSE_MODE; 244ba0acb5eSDmitry Torokhov } 245ba0acb5eSDmitry Torokhov 246ba0acb5eSDmitry Torokhov powermate_sync_state(pm); 247ba0acb5eSDmitry Torokhov 248ba0acb5eSDmitry Torokhov spin_unlock_irqrestore(&pm->lock, flags); 249ba0acb5eSDmitry Torokhov } 250ba0acb5eSDmitry Torokhov 251ba0acb5eSDmitry Torokhov /* Callback from the Input layer when an event arrives from userspace to configure the LED */ 252ba0acb5eSDmitry Torokhov static int powermate_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int _value) 253ba0acb5eSDmitry Torokhov { 254ba0acb5eSDmitry Torokhov unsigned int command = (unsigned int)_value; 255ba0acb5eSDmitry Torokhov struct powermate_device *pm = input_get_drvdata(dev); 256ba0acb5eSDmitry Torokhov 257ba0acb5eSDmitry Torokhov if (type == EV_MSC && code == MSC_PULSELED){ 258ba0acb5eSDmitry Torokhov /* 259ba0acb5eSDmitry Torokhov bits 0- 7: 8 bits: LED brightness 260ba0acb5eSDmitry Torokhov bits 8-16: 9 bits: pulsing speed modifier (0 ... 510); 0-254 = slower, 255 = standard, 256-510 = faster. 261ba0acb5eSDmitry Torokhov bits 17-18: 2 bits: pulse table (0, 1, 2 valid) 262ba0acb5eSDmitry Torokhov bit 19: 1 bit : pulse whilst asleep? 263ba0acb5eSDmitry Torokhov bit 20: 1 bit : pulse constantly? 264ba0acb5eSDmitry Torokhov */ 265ba0acb5eSDmitry Torokhov int static_brightness = command & 0xFF; // bits 0-7 266ba0acb5eSDmitry Torokhov int pulse_speed = (command >> 8) & 0x1FF; // bits 8-16 267ba0acb5eSDmitry Torokhov int pulse_table = (command >> 17) & 0x3; // bits 17-18 268ba0acb5eSDmitry Torokhov int pulse_asleep = (command >> 19) & 0x1; // bit 19 269ba0acb5eSDmitry Torokhov int pulse_awake = (command >> 20) & 0x1; // bit 20 270ba0acb5eSDmitry Torokhov 271ba0acb5eSDmitry Torokhov powermate_pulse_led(pm, static_brightness, pulse_speed, pulse_table, pulse_asleep, pulse_awake); 272ba0acb5eSDmitry Torokhov } 273ba0acb5eSDmitry Torokhov 274ba0acb5eSDmitry Torokhov return 0; 275ba0acb5eSDmitry Torokhov } 276ba0acb5eSDmitry Torokhov 277ba0acb5eSDmitry Torokhov static int powermate_alloc_buffers(struct usb_device *udev, struct powermate_device *pm) 278ba0acb5eSDmitry Torokhov { 279ba0acb5eSDmitry Torokhov pm->data = usb_buffer_alloc(udev, POWERMATE_PAYLOAD_SIZE_MAX, 280ba0acb5eSDmitry Torokhov GFP_ATOMIC, &pm->data_dma); 281ba0acb5eSDmitry Torokhov if (!pm->data) 282ba0acb5eSDmitry Torokhov return -1; 283ba0acb5eSDmitry Torokhov 284ba0acb5eSDmitry Torokhov pm->configcr = usb_buffer_alloc(udev, sizeof(*(pm->configcr)), 285ba0acb5eSDmitry Torokhov GFP_ATOMIC, &pm->configcr_dma); 286ba0acb5eSDmitry Torokhov if (!pm->configcr) 287ba0acb5eSDmitry Torokhov return -1; 288ba0acb5eSDmitry Torokhov 289ba0acb5eSDmitry Torokhov return 0; 290ba0acb5eSDmitry Torokhov } 291ba0acb5eSDmitry Torokhov 292ba0acb5eSDmitry Torokhov static void powermate_free_buffers(struct usb_device *udev, struct powermate_device *pm) 293ba0acb5eSDmitry Torokhov { 294ba0acb5eSDmitry Torokhov usb_buffer_free(udev, POWERMATE_PAYLOAD_SIZE_MAX, 295ba0acb5eSDmitry Torokhov pm->data, pm->data_dma); 296ba0acb5eSDmitry Torokhov usb_buffer_free(udev, sizeof(*(pm->configcr)), 297ba0acb5eSDmitry Torokhov pm->configcr, pm->configcr_dma); 298ba0acb5eSDmitry Torokhov } 299ba0acb5eSDmitry Torokhov 300ba0acb5eSDmitry Torokhov /* Called whenever a USB device matching one in our supported devices table is connected */ 301ba0acb5eSDmitry Torokhov static int powermate_probe(struct usb_interface *intf, const struct usb_device_id *id) 302ba0acb5eSDmitry Torokhov { 303ba0acb5eSDmitry Torokhov struct usb_device *udev = interface_to_usbdev (intf); 304ba0acb5eSDmitry Torokhov struct usb_host_interface *interface; 305ba0acb5eSDmitry Torokhov struct usb_endpoint_descriptor *endpoint; 306ba0acb5eSDmitry Torokhov struct powermate_device *pm; 307ba0acb5eSDmitry Torokhov struct input_dev *input_dev; 308ba0acb5eSDmitry Torokhov int pipe, maxp; 309ba0acb5eSDmitry Torokhov int error = -ENOMEM; 310ba0acb5eSDmitry Torokhov 311ba0acb5eSDmitry Torokhov interface = intf->cur_altsetting; 312ba0acb5eSDmitry Torokhov endpoint = &interface->endpoint[0].desc; 313ba0acb5eSDmitry Torokhov if (!usb_endpoint_is_int_in(endpoint)) 314ba0acb5eSDmitry Torokhov return -EIO; 315ba0acb5eSDmitry Torokhov 316ba0acb5eSDmitry Torokhov usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 317ba0acb5eSDmitry Torokhov 0x0a, USB_TYPE_CLASS | USB_RECIP_INTERFACE, 318ba0acb5eSDmitry Torokhov 0, interface->desc.bInterfaceNumber, NULL, 0, 319ba0acb5eSDmitry Torokhov USB_CTRL_SET_TIMEOUT); 320ba0acb5eSDmitry Torokhov 321ba0acb5eSDmitry Torokhov pm = kzalloc(sizeof(struct powermate_device), GFP_KERNEL); 322ba0acb5eSDmitry Torokhov input_dev = input_allocate_device(); 323ba0acb5eSDmitry Torokhov if (!pm || !input_dev) 324ba0acb5eSDmitry Torokhov goto fail1; 325ba0acb5eSDmitry Torokhov 326ba0acb5eSDmitry Torokhov if (powermate_alloc_buffers(udev, pm)) 327ba0acb5eSDmitry Torokhov goto fail2; 328ba0acb5eSDmitry Torokhov 329ba0acb5eSDmitry Torokhov pm->irq = usb_alloc_urb(0, GFP_KERNEL); 330ba0acb5eSDmitry Torokhov if (!pm->irq) 331ba0acb5eSDmitry Torokhov goto fail2; 332ba0acb5eSDmitry Torokhov 333ba0acb5eSDmitry Torokhov pm->config = usb_alloc_urb(0, GFP_KERNEL); 334ba0acb5eSDmitry Torokhov if (!pm->config) 335ba0acb5eSDmitry Torokhov goto fail3; 336ba0acb5eSDmitry Torokhov 337ba0acb5eSDmitry Torokhov pm->udev = udev; 338ba0acb5eSDmitry Torokhov pm->input = input_dev; 339ba0acb5eSDmitry Torokhov 340ba0acb5eSDmitry Torokhov usb_make_path(udev, pm->phys, sizeof(pm->phys)); 341ba0acb5eSDmitry Torokhov strlcpy(pm->phys, "/input0", sizeof(pm->phys)); 342ba0acb5eSDmitry Torokhov 343ba0acb5eSDmitry Torokhov spin_lock_init(&pm->lock); 344ba0acb5eSDmitry Torokhov 345ba0acb5eSDmitry Torokhov switch (le16_to_cpu(udev->descriptor.idProduct)) { 346ba0acb5eSDmitry Torokhov case POWERMATE_PRODUCT_NEW: 347ba0acb5eSDmitry Torokhov input_dev->name = pm_name_powermate; 348ba0acb5eSDmitry Torokhov break; 349ba0acb5eSDmitry Torokhov case POWERMATE_PRODUCT_OLD: 350ba0acb5eSDmitry Torokhov input_dev->name = pm_name_soundknob; 351ba0acb5eSDmitry Torokhov break; 352ba0acb5eSDmitry Torokhov default: 353ba0acb5eSDmitry Torokhov input_dev->name = pm_name_soundknob; 354ba0acb5eSDmitry Torokhov printk(KERN_WARNING "powermate: unknown product id %04x\n", 355ba0acb5eSDmitry Torokhov le16_to_cpu(udev->descriptor.idProduct)); 356ba0acb5eSDmitry Torokhov } 357ba0acb5eSDmitry Torokhov 358ba0acb5eSDmitry Torokhov input_dev->phys = pm->phys; 359ba0acb5eSDmitry Torokhov usb_to_input_id(udev, &input_dev->id); 360ba0acb5eSDmitry Torokhov input_dev->dev.parent = &intf->dev; 361ba0acb5eSDmitry Torokhov 362ba0acb5eSDmitry Torokhov input_set_drvdata(input_dev, pm); 363ba0acb5eSDmitry Torokhov 364ba0acb5eSDmitry Torokhov input_dev->event = powermate_input_event; 365ba0acb5eSDmitry Torokhov 366ba0acb5eSDmitry Torokhov input_dev->evbit[0] = BIT(EV_KEY) | BIT(EV_REL) | BIT(EV_MSC); 367ba0acb5eSDmitry Torokhov input_dev->keybit[LONG(BTN_0)] = BIT(BTN_0); 368ba0acb5eSDmitry Torokhov input_dev->relbit[LONG(REL_DIAL)] = BIT(REL_DIAL); 369ba0acb5eSDmitry Torokhov input_dev->mscbit[LONG(MSC_PULSELED)] = BIT(MSC_PULSELED); 370ba0acb5eSDmitry Torokhov 371ba0acb5eSDmitry Torokhov /* get a handle to the interrupt data pipe */ 372ba0acb5eSDmitry Torokhov pipe = usb_rcvintpipe(udev, endpoint->bEndpointAddress); 373ba0acb5eSDmitry Torokhov maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe)); 374ba0acb5eSDmitry Torokhov 375ba0acb5eSDmitry Torokhov if (maxp < POWERMATE_PAYLOAD_SIZE_MIN || maxp > POWERMATE_PAYLOAD_SIZE_MAX) { 376ba0acb5eSDmitry Torokhov printk(KERN_WARNING "powermate: Expected payload of %d--%d bytes, found %d bytes!\n", 377ba0acb5eSDmitry Torokhov POWERMATE_PAYLOAD_SIZE_MIN, POWERMATE_PAYLOAD_SIZE_MAX, maxp); 378ba0acb5eSDmitry Torokhov maxp = POWERMATE_PAYLOAD_SIZE_MAX; 379ba0acb5eSDmitry Torokhov } 380ba0acb5eSDmitry Torokhov 381ba0acb5eSDmitry Torokhov usb_fill_int_urb(pm->irq, udev, pipe, pm->data, 382ba0acb5eSDmitry Torokhov maxp, powermate_irq, 383ba0acb5eSDmitry Torokhov pm, endpoint->bInterval); 384ba0acb5eSDmitry Torokhov pm->irq->transfer_dma = pm->data_dma; 385ba0acb5eSDmitry Torokhov pm->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 386ba0acb5eSDmitry Torokhov 387ba0acb5eSDmitry Torokhov /* register our interrupt URB with the USB system */ 388ba0acb5eSDmitry Torokhov if (usb_submit_urb(pm->irq, GFP_KERNEL)) { 389ba0acb5eSDmitry Torokhov error = -EIO; 390ba0acb5eSDmitry Torokhov goto fail4; 391ba0acb5eSDmitry Torokhov } 392ba0acb5eSDmitry Torokhov 393ba0acb5eSDmitry Torokhov error = input_register_device(pm->input); 394ba0acb5eSDmitry Torokhov if (error) 395ba0acb5eSDmitry Torokhov goto fail5; 396ba0acb5eSDmitry Torokhov 397ba0acb5eSDmitry Torokhov 398ba0acb5eSDmitry Torokhov /* force an update of everything */ 399ba0acb5eSDmitry Torokhov pm->requires_update = UPDATE_PULSE_ASLEEP | UPDATE_PULSE_AWAKE | UPDATE_PULSE_MODE | UPDATE_STATIC_BRIGHTNESS; 400ba0acb5eSDmitry Torokhov powermate_pulse_led(pm, 0x80, 255, 0, 1, 0); // set default pulse parameters 401ba0acb5eSDmitry Torokhov 402ba0acb5eSDmitry Torokhov usb_set_intfdata(intf, pm); 403ba0acb5eSDmitry Torokhov return 0; 404ba0acb5eSDmitry Torokhov 405ba0acb5eSDmitry Torokhov fail5: usb_kill_urb(pm->irq); 406ba0acb5eSDmitry Torokhov fail4: usb_free_urb(pm->config); 407ba0acb5eSDmitry Torokhov fail3: usb_free_urb(pm->irq); 408ba0acb5eSDmitry Torokhov fail2: powermate_free_buffers(udev, pm); 409ba0acb5eSDmitry Torokhov fail1: input_free_device(input_dev); 410ba0acb5eSDmitry Torokhov kfree(pm); 411ba0acb5eSDmitry Torokhov return error; 412ba0acb5eSDmitry Torokhov } 413ba0acb5eSDmitry Torokhov 414ba0acb5eSDmitry Torokhov /* Called when a USB device we've accepted ownership of is removed */ 415ba0acb5eSDmitry Torokhov static void powermate_disconnect(struct usb_interface *intf) 416ba0acb5eSDmitry Torokhov { 417ba0acb5eSDmitry Torokhov struct powermate_device *pm = usb_get_intfdata (intf); 418ba0acb5eSDmitry Torokhov 419ba0acb5eSDmitry Torokhov usb_set_intfdata(intf, NULL); 420ba0acb5eSDmitry Torokhov if (pm) { 421ba0acb5eSDmitry Torokhov pm->requires_update = 0; 422ba0acb5eSDmitry Torokhov usb_kill_urb(pm->irq); 423ba0acb5eSDmitry Torokhov input_unregister_device(pm->input); 424ba0acb5eSDmitry Torokhov usb_free_urb(pm->irq); 425ba0acb5eSDmitry Torokhov usb_free_urb(pm->config); 426ba0acb5eSDmitry Torokhov powermate_free_buffers(interface_to_usbdev(intf), pm); 427ba0acb5eSDmitry Torokhov 428ba0acb5eSDmitry Torokhov kfree(pm); 429ba0acb5eSDmitry Torokhov } 430ba0acb5eSDmitry Torokhov } 431ba0acb5eSDmitry Torokhov 432ba0acb5eSDmitry Torokhov static struct usb_device_id powermate_devices [] = { 433ba0acb5eSDmitry Torokhov { USB_DEVICE(POWERMATE_VENDOR, POWERMATE_PRODUCT_NEW) }, 434ba0acb5eSDmitry Torokhov { USB_DEVICE(POWERMATE_VENDOR, POWERMATE_PRODUCT_OLD) }, 435ba0acb5eSDmitry Torokhov { USB_DEVICE(CONTOUR_VENDOR, CONTOUR_JOG) }, 436ba0acb5eSDmitry Torokhov { } /* Terminating entry */ 437ba0acb5eSDmitry Torokhov }; 438ba0acb5eSDmitry Torokhov 439ba0acb5eSDmitry Torokhov MODULE_DEVICE_TABLE (usb, powermate_devices); 440ba0acb5eSDmitry Torokhov 441ba0acb5eSDmitry Torokhov static struct usb_driver powermate_driver = { 442ba0acb5eSDmitry Torokhov .name = "powermate", 443ba0acb5eSDmitry Torokhov .probe = powermate_probe, 444ba0acb5eSDmitry Torokhov .disconnect = powermate_disconnect, 445ba0acb5eSDmitry Torokhov .id_table = powermate_devices, 446ba0acb5eSDmitry Torokhov }; 447ba0acb5eSDmitry Torokhov 448ba0acb5eSDmitry Torokhov static int __init powermate_init(void) 449ba0acb5eSDmitry Torokhov { 450ba0acb5eSDmitry Torokhov return usb_register(&powermate_driver); 451ba0acb5eSDmitry Torokhov } 452ba0acb5eSDmitry Torokhov 453ba0acb5eSDmitry Torokhov static void __exit powermate_cleanup(void) 454ba0acb5eSDmitry Torokhov { 455ba0acb5eSDmitry Torokhov usb_deregister(&powermate_driver); 456ba0acb5eSDmitry Torokhov } 457ba0acb5eSDmitry Torokhov 458ba0acb5eSDmitry Torokhov module_init(powermate_init); 459ba0acb5eSDmitry Torokhov module_exit(powermate_cleanup); 460ba0acb5eSDmitry Torokhov 461ba0acb5eSDmitry Torokhov MODULE_AUTHOR( "William R Sowerbutts" ); 462ba0acb5eSDmitry Torokhov MODULE_DESCRIPTION( "Griffin Technology, Inc PowerMate driver" ); 463ba0acb5eSDmitry Torokhov MODULE_LICENSE("GPL"); 464