[mirror_ubuntu-zesty-kernel.git] / drivers / input / misc / powermate.c

/*
 * A driver for the Griffin Technology, Inc. "PowerMate" USB controller dial.
 *
 * v1.1, (c)2002 William R Sowerbutts <will@sowerbutts.com>
 *
 * This device is a anodised aluminium knob which connects over USB. It can measure
 * clockwise and anticlockwise rotation. The dial also acts as a pushbutton with
 * a spring for automatic release. The base contains a pair of LEDs which illuminate
 * the translucent base. It rotates without limit and reports its relative rotation
 * back to the host when polled by the USB controller.
 *
 * Testing with the knob I have has shown that it measures approximately 94 "clicks"
 * for one full rotation. Testing with my High Speed Rotation Actuator (ok, it was
 * a variable speed cordless electric drill) has shown that the device can measure
 * speeds of up to 7 clicks either clockwise or anticlockwise between pollings from
 * the host. If it counts more than 7 clicks before it is polled, it will wrap back
 * to zero and start counting again. This was at quite high speed, however, almost
 * certainly faster than the human hand could turn it. Griffin say that it loses a
 * pulse or two on a direction change; the granularity is so fine that I never
 * noticed this in practice.
 *
 * The device's microcontroller can be programmed to set the LED to either a constant
 * intensity, or to a rhythmic pulsing. Several patterns and speeds are available.
 *
 * Griffin were very happy to provide documentation and free hardware for development.
 *
 * Some userspace tools are available on the web: http://sowerbutts.com/powermate/
 *
 */

#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/spinlock.h>
#include <linux/usb/input.h>

#define POWERMATE_VENDOR	0x077d	/* Griffin Technology, Inc. */
#define POWERMATE_PRODUCT_NEW	0x0410	/* Griffin PowerMate */
#define POWERMATE_PRODUCT_OLD	0x04AA	/* Griffin soundKnob */

#define CONTOUR_VENDOR		0x05f3	/* Contour Design, Inc. */
#define CONTOUR_JOG		0x0240	/* Jog and Shuttle */

/* these are the command codes we send to the device */
#define SET_STATIC_BRIGHTNESS  0x01
#define SET_PULSE_ASLEEP       0x02
#define SET_PULSE_AWAKE        0x03
#define SET_PULSE_MODE         0x04

/* these refer to bits in the powermate_device's requires_update field. */
#define UPDATE_STATIC_BRIGHTNESS (1<<0)
#define UPDATE_PULSE_ASLEEP      (1<<1)
#define UPDATE_PULSE_AWAKE       (1<<2)
#define UPDATE_PULSE_MODE        (1<<3)

/* at least two versions of the hardware exist, with differing payload
   sizes. the first three bytes always contain the "interesting" data in
   the relevant format. */
#define POWERMATE_PAYLOAD_SIZE_MAX 6
#define POWERMATE_PAYLOAD_SIZE_MIN 3
struct powermate_device {
	signed char *data;
	dma_addr_t data_dma;
	struct urb *irq, *config;
	struct usb_ctrlrequest *configcr;
	struct usb_device *udev;
	struct usb_interface *intf;
	struct input_dev *input;
	spinlock_t lock;
	int static_brightness;
	int pulse_speed;
	int pulse_table;
	int pulse_asleep;
	int pulse_awake;
	int requires_update; // physical settings which are out of sync
	char phys[64];
};

static char pm_name_powermate[] = "Griffin PowerMate";
static char pm_name_soundknob[] = "Griffin SoundKnob";

static void powermate_config_complete(struct urb *urb);

/* Callback for data arriving from the PowerMate over the USB interrupt pipe */
static void powermate_irq(struct urb *urb)
{
	struct powermate_device *pm = urb->context;
	struct device *dev = &pm->intf->dev;
	int retval;

	switch (urb->status) {
	case 0:
		/* success */
		break;
	case -ECONNRESET:
	case -ENOENT:
	case -ESHUTDOWN:
		/* this urb is terminated, clean up */
		dev_dbg(dev, "%s - urb shutting down with status: %d\n",
			__func__, urb->status);
		return;
	default:
		dev_dbg(dev, "%s - nonzero urb status received: %d\n",
			__func__, urb->status);
		goto exit;
	}

	/* handle updates to device state */
	input_report_key(pm->input, BTN_0, pm->data[0] & 0x01);
	input_report_rel(pm->input, REL_DIAL, pm->data[1]);
	input_sync(pm->input);

exit:
	retval = usb_submit_urb (urb, GFP_ATOMIC);
	if (retval)
		dev_err(dev, "%s - usb_submit_urb failed with result: %d\n",
			__func__, retval);
}

/* Decide if we need to issue a control message and do so. Must be called with pm->lock taken */
static void powermate_sync_state(struct powermate_device *pm)
{
	if (pm->requires_update == 0)
		return; /* no updates are required */
	if (pm->config->status == -EINPROGRESS)
		return; /* an update is already in progress; it'll issue this update when it completes */

	if (pm->requires_update & UPDATE_PULSE_ASLEEP){
		pm->configcr->wValue = cpu_to_le16( SET_PULSE_ASLEEP );
		pm->configcr->wIndex = cpu_to_le16( pm->pulse_asleep ? 1 : 0 );
		pm->requires_update &= ~UPDATE_PULSE_ASLEEP;
	}else if (pm->requires_update & UPDATE_PULSE_AWAKE){
		pm->configcr->wValue = cpu_to_le16( SET_PULSE_AWAKE );
		pm->configcr->wIndex = cpu_to_le16( pm->pulse_awake ? 1 : 0 );
		pm->requires_update &= ~UPDATE_PULSE_AWAKE;
	}else if (pm->requires_update & UPDATE_PULSE_MODE){
		int op, arg;
		/* the powermate takes an operation and an argument for its pulse algorithm.
		   the operation can be:
		   0: divide the speed
		   1: pulse at normal speed
		   2: multiply the speed
		   the argument only has an effect for operations 0 and 2, and ranges between
		   1 (least effect) to 255 (maximum effect).

		   thus, several states are equivalent and are coalesced into one state.

		   we map this onto a range from 0 to 510, with:
		   0 -- 254    -- use divide (0 = slowest)
		   255         -- use normal speed
		   256 -- 510  -- use multiple (510 = fastest).

		   Only values of 'arg' quite close to 255 are particularly useful/spectacular.
		*/
		if (pm->pulse_speed < 255) {
			op = 0;                   // divide
			arg = 255 - pm->pulse_speed;
		} else if (pm->pulse_speed > 255) {
			op = 2;                   // multiply
			arg = pm->pulse_speed - 255;
		} else {
			op = 1;                   // normal speed
			arg = 0;                  // can be any value
		}
		pm->configcr->wValue = cpu_to_le16( (pm->pulse_table << 8) | SET_PULSE_MODE );
		pm->configcr->wIndex = cpu_to_le16( (arg << 8) | op );
		pm->requires_update &= ~UPDATE_PULSE_MODE;
	} else if (pm->requires_update & UPDATE_STATIC_BRIGHTNESS) {
		pm->configcr->wValue = cpu_to_le16( SET_STATIC_BRIGHTNESS );
		pm->configcr->wIndex = cpu_to_le16( pm->static_brightness );
		pm->requires_update &= ~UPDATE_STATIC_BRIGHTNESS;
	} else {
		printk(KERN_ERR "powermate: unknown update required");
		pm->requires_update = 0; /* fudge the bug */
		return;
	}

/*	printk("powermate: %04x %04x\n", pm->configcr->wValue, pm->configcr->wIndex); */

	pm->configcr->bRequestType = 0x41; /* vendor request */
	pm->configcr->bRequest = 0x01;
	pm->configcr->wLength = 0;

	usb_fill_control_urb(pm->config, pm->udev, usb_sndctrlpipe(pm->udev, 0),
			     (void *) pm->configcr, NULL, 0,
			     powermate_config_complete, pm);

	if (usb_submit_urb(pm->config, GFP_ATOMIC))
		printk(KERN_ERR "powermate: usb_submit_urb(config) failed");
}

/* Called when our asynchronous control message completes. We may need to issue another immediately */
static void powermate_config_complete(struct urb *urb)
{
	struct powermate_device *pm = urb->context;
	unsigned long flags;

	if (urb->status)
		printk(KERN_ERR "powermate: config urb returned %d\n", urb->status);

	spin_lock_irqsave(&pm->lock, flags);
	powermate_sync_state(pm);
	spin_unlock_irqrestore(&pm->lock, flags);
}

/* Set the LED up as described and begin the sync with the hardware if required */
static void powermate_pulse_led(struct powermate_device *pm, int static_brightness, int pulse_speed,
				int pulse_table, int pulse_asleep, int pulse_awake)
{
	unsigned long flags;

	if (pulse_speed < 0)
		pulse_speed = 0;
	if (pulse_table < 0)
		pulse_table = 0;
	if (pulse_speed > 510)
		pulse_speed = 510;
	if (pulse_table > 2)
		pulse_table = 2;

	pulse_asleep = !!pulse_asleep;
	pulse_awake = !!pulse_awake;


	spin_lock_irqsave(&pm->lock, flags);

	/* mark state updates which are required */
	if (static_brightness != pm->static_brightness) {
		pm->static_brightness = static_brightness;
		pm->requires_update |= UPDATE_STATIC_BRIGHTNESS;
	}
	if (pulse_asleep != pm->pulse_asleep) {
		pm->pulse_asleep = pulse_asleep;
		pm->requires_update |= (UPDATE_PULSE_ASLEEP | UPDATE_STATIC_BRIGHTNESS);
	}
	if (pulse_awake != pm->pulse_awake) {
		pm->pulse_awake = pulse_awake;
		pm->requires_update |= (UPDATE_PULSE_AWAKE | UPDATE_STATIC_BRIGHTNESS);
	}
	if (pulse_speed != pm->pulse_speed || pulse_table != pm->pulse_table) {
		pm->pulse_speed = pulse_speed;
		pm->pulse_table = pulse_table;
		pm->requires_update |= UPDATE_PULSE_MODE;
	}

	powermate_sync_state(pm);

	spin_unlock_irqrestore(&pm->lock, flags);
}

/* Callback from the Input layer when an event arrives from userspace to configure the LED */
static int powermate_input_event(struct input_dev *dev, unsigned int type, unsigned int code, int _value)
{
	unsigned int command = (unsigned int)_value;
	struct powermate_device *pm = input_get_drvdata(dev);

	if (type == EV_MSC && code == MSC_PULSELED){
		/*
		    bits  0- 7: 8 bits: LED brightness
		    bits  8-16: 9 bits: pulsing speed modifier (0 ... 510); 0-254 = slower, 255 = standard, 256-510 = faster.
		    bits 17-18: 2 bits: pulse table (0, 1, 2 valid)
		    bit     19: 1 bit : pulse whilst asleep?
		    bit     20: 1 bit : pulse constantly?
		*/
		int static_brightness = command & 0xFF;   // bits 0-7
		int pulse_speed = (command >> 8) & 0x1FF; // bits 8-16
		int pulse_table = (command >> 17) & 0x3;  // bits 17-18
		int pulse_asleep = (command >> 19) & 0x1; // bit 19
		int pulse_awake  = (command >> 20) & 0x1; // bit 20

		powermate_pulse_led(pm, static_brightness, pulse_speed, pulse_table, pulse_asleep, pulse_awake);
	}

	return 0;
}

static int powermate_alloc_buffers(struct usb_device *udev, struct powermate_device *pm)
{
	pm->data = usb_alloc_coherent(udev, POWERMATE_PAYLOAD_SIZE_MAX,
				      GFP_ATOMIC, &pm->data_dma);
	if (!pm->data)
		return -1;

	pm->configcr = kmalloc(sizeof(*(pm->configcr)), GFP_KERNEL);
	if (!pm->configcr)
		return -ENOMEM;

	return 0;
}

static void powermate_free_buffers(struct usb_device *udev, struct powermate_device *pm)
{
	usb_free_coherent(udev, POWERMATE_PAYLOAD_SIZE_MAX,
			  pm->data, pm->data_dma);
	kfree(pm->configcr);
}

/* Called whenever a USB device matching one in our supported devices table is connected */
static int powermate_probe(struct usb_interface *intf, const struct usb_device_id *id)
{
	struct usb_device *udev = interface_to_usbdev (intf);
	struct usb_host_interface *interface;
	struct usb_endpoint_descriptor *endpoint;
	struct powermate_device *pm;
	struct input_dev *input_dev;
	int pipe, maxp;
	int error = -ENOMEM;

	interface = intf->cur_altsetting;
	if (interface->desc.bNumEndpoints < 1)
		return -EINVAL;

	endpoint = &interface->endpoint[0].desc;
	if (!usb_endpoint_is_int_in(endpoint))
		return -EIO;

	usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
		0x0a, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
		0, interface->desc.bInterfaceNumber, NULL, 0,
		USB_CTRL_SET_TIMEOUT);

	pm = kzalloc(sizeof(struct powermate_device), GFP_KERNEL);
	input_dev = input_allocate_device();
	if (!pm || !input_dev)
		goto fail1;

	if (powermate_alloc_buffers(udev, pm))
		goto fail2;

	pm->irq = usb_alloc_urb(0, GFP_KERNEL);
	if (!pm->irq)
		goto fail2;

	pm->config = usb_alloc_urb(0, GFP_KERNEL);
	if (!pm->config)
		goto fail3;

	pm->udev = udev;
	pm->intf = intf;
	pm->input = input_dev;

	usb_make_path(udev, pm->phys, sizeof(pm->phys));
	strlcat(pm->phys, "/input0", sizeof(pm->phys));

	spin_lock_init(&pm->lock);

	switch (le16_to_cpu(udev->descriptor.idProduct)) {
	case POWERMATE_PRODUCT_NEW:
		input_dev->name = pm_name_powermate;
		break;
	case POWERMATE_PRODUCT_OLD:
		input_dev->name = pm_name_soundknob;
		break;
	default:
		input_dev->name = pm_name_soundknob;
		printk(KERN_WARNING "powermate: unknown product id %04x\n",
		       le16_to_cpu(udev->descriptor.idProduct));
	}

	input_dev->phys = pm->phys;
	usb_to_input_id(udev, &input_dev->id);
	input_dev->dev.parent = &intf->dev;

	input_set_drvdata(input_dev, pm);

	input_dev->event = powermate_input_event;

	input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL) |
		BIT_MASK(EV_MSC);
	input_dev->keybit[BIT_WORD(BTN_0)] = BIT_MASK(BTN_0);
	input_dev->relbit[BIT_WORD(REL_DIAL)] = BIT_MASK(REL_DIAL);
	input_dev->mscbit[BIT_WORD(MSC_PULSELED)] = BIT_MASK(MSC_PULSELED);

	/* get a handle to the interrupt data pipe */
	pipe = usb_rcvintpipe(udev, endpoint->bEndpointAddress);
	maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));

	if (maxp < POWERMATE_PAYLOAD_SIZE_MIN || maxp > POWERMATE_PAYLOAD_SIZE_MAX) {
		printk(KERN_WARNING "powermate: Expected payload of %d--%d bytes, found %d bytes!\n",
			POWERMATE_PAYLOAD_SIZE_MIN, POWERMATE_PAYLOAD_SIZE_MAX, maxp);
		maxp = POWERMATE_PAYLOAD_SIZE_MAX;
	}

	usb_fill_int_urb(pm->irq, udev, pipe, pm->data,
			 maxp, powermate_irq,
			 pm, endpoint->bInterval);
	pm->irq->transfer_dma = pm->data_dma;
	pm->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

	/* register our interrupt URB with the USB system */
	if (usb_submit_urb(pm->irq, GFP_KERNEL)) {
		error = -EIO;
		goto fail4;
	}

	error = input_register_device(pm->input);
	if (error)
		goto fail5;


	/* force an update of everything */
	pm->requires_update = UPDATE_PULSE_ASLEEP | UPDATE_PULSE_AWAKE | UPDATE_PULSE_MODE | UPDATE_STATIC_BRIGHTNESS;
	powermate_pulse_led(pm, 0x80, 255, 0, 1, 0); // set default pulse parameters

	usb_set_intfdata(intf, pm);
	return 0;

 fail5:	usb_kill_urb(pm->irq);
 fail4:	usb_free_urb(pm->config);
 fail3:	usb_free_urb(pm->irq);
 fail2:	powermate_free_buffers(udev, pm);
 fail1:	input_free_device(input_dev);
	kfree(pm);
	return error;
}

/* Called when a USB device we've accepted ownership of is removed */
static void powermate_disconnect(struct usb_interface *intf)
{
	struct powermate_device *pm = usb_get_intfdata (intf);

	usb_set_intfdata(intf, NULL);
	if (pm) {
		pm->requires_update = 0;
		usb_kill_urb(pm->irq);
		input_unregister_device(pm->input);
		usb_free_urb(pm->irq);
		usb_free_urb(pm->config);
		powermate_free_buffers(interface_to_usbdev(intf), pm);

		kfree(pm);
	}
}

static struct usb_device_id powermate_devices [] = {
	{ USB_DEVICE(POWERMATE_VENDOR, POWERMATE_PRODUCT_NEW) },
	{ USB_DEVICE(POWERMATE_VENDOR, POWERMATE_PRODUCT_OLD) },
	{ USB_DEVICE(CONTOUR_VENDOR, CONTOUR_JOG) },
	{ } /* Terminating entry */
};

MODULE_DEVICE_TABLE (usb, powermate_devices);

static struct usb_driver powermate_driver = {
        .name =         "powermate",
        .probe =        powermate_probe,
        .disconnect =   powermate_disconnect,
        .id_table =     powermate_devices,
};

module_usb_driver(powermate_driver);

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