[linux-2.6-block.git] / drivers / usb / misc / isight_firmware.c

/*
 * Driver for loading USB isight firmware
 *
 * Copyright (C) 2008 Matthew Garrett <mjg@redhat.com>
 *
 * 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, version 2.
 *
 * The USB isight cameras in recent Apples are roughly compatible with the USB
 * video class specification, and can be driven by uvcvideo. However, they
 * need firmware to be loaded beforehand. After firmware loading, the device
 * detaches from the USB bus and reattaches with a new device ID. It can then
 * be claimed by the uvc driver.
 *
 * The firmware is non-free and must be extracted by the user. Tools to do this
 * are available at http://bersace03.free.fr/ift/
 *
 * The isight firmware loading was reverse engineered by Johannes Berg
 * <johannes@sipsolutions.de>, and this driver is based on code by Ronald
 * Bultje <rbultje@ronald.bitfreak.net>
 */

#include <linux/usb.h>
#include <linux/firmware.h>
#include <linux/errno.h>
#include <linux/module.h>

static const struct usb_device_id id_table[] = {
	{USB_DEVICE(0x05ac, 0x8300)},
	{},
};

MODULE_DEVICE_TABLE(usb, id_table);

static int isight_firmware_load(struct usb_interface *intf,
				const struct usb_device_id *id)
{
	struct usb_device *dev = interface_to_usbdev(intf);
	int llen, len, req, ret = 0;
	const struct firmware *firmware;
	unsigned char *buf = kmalloc(50, GFP_KERNEL);
	unsigned char data[4];
	const u8 *ptr;

	if (!buf)
		return -ENOMEM;

	if (request_firmware(&firmware, "isight.fw", &dev->dev) != 0) {
		printk(KERN_ERR "Unable to load isight firmware\n");
		ret = -ENODEV;
		goto out;
	}

	ptr = firmware->data;

	if (usb_control_msg
	    (dev, usb_sndctrlpipe(dev, 0), 0xa0, 0x40, 0xe600, 0, "\1", 1,
	     300) != 1) {
		printk(KERN_ERR
		       "Failed to initialise isight firmware loader\n");
		ret = -ENODEV;
		goto out;
	}

	while (ptr+4 <= firmware->data+firmware->size) {
		memcpy(data, ptr, 4);
		len = (data[0] << 8 | data[1]);
		req = (data[2] << 8 | data[3]);
		ptr += 4;

		if (len == 0x8001)
			break;	/* success */
		else if (len == 0)
			continue;

		for (; len > 0; req += 50) {
			llen = min(len, 50);
			len -= llen;
			if (ptr+llen > firmware->data+firmware->size) {
				printk(KERN_ERR
				       "Malformed isight firmware");
				ret = -ENODEV;
				goto out;
			}
			memcpy(buf, ptr, llen);

			ptr += llen;

			if (usb_control_msg
			    (dev, usb_sndctrlpipe(dev, 0), 0xa0, 0x40, req, 0,
			     buf, llen, 300) != llen) {
				printk(KERN_ERR
				       "Failed to load isight firmware\n");
				ret = -ENODEV;
				goto out;
			}

		}
	}

	if (usb_control_msg
	    (dev, usb_sndctrlpipe(dev, 0), 0xa0, 0x40, 0xe600, 0, "\0", 1,
	     300) != 1) {
		printk(KERN_ERR "isight firmware loading completion failed\n");
		ret = -ENODEV;
	}

out:
	kfree(buf);
	release_firmware(firmware);
	return ret;
}

MODULE_FIRMWARE("isight.fw");

static void isight_firmware_disconnect(struct usb_interface *intf)
{
}

static struct usb_driver isight_firmware_driver = {
	.name = "isight_firmware",
	.probe = isight_firmware_load,
	.disconnect = isight_firmware_disconnect,
	.id_table = id_table,
};

static int __init isight_firmware_init(void)
{
	return usb_register(&isight_firmware_driver);
}

static void __exit isight_firmware_exit(void)
{
	usb_deregister(&isight_firmware_driver);
}

module_init(isight_firmware_init);
module_exit(isight_firmware_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Matthew Garrett <mjg@redhat.com>");
Commit	Line	Data
62d104d0 MG	1	/*
	2	* Driver for loading USB isight firmware
	3	*
	4	* Copyright (C) 2008 Matthew Garrett <mjg@redhat.com>
	5	*
	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms of the GNU General Public License as published by the Free
	8	* Software Foundation, version 2.
	9	*
	10	* The USB isight cameras in recent Apples are roughly compatible with the USB
	11	* video class specification, and can be driven by uvcvideo. However, they
	12	* need firmware to be loaded beforehand. After firmware loading, the device
	13	* detaches from the USB bus and reattaches with a new device ID. It can then
	14	* be claimed by the uvc driver.
	15	*
	16	* The firmware is non-free and must be extracted by the user. Tools to do this
	17	* are available at http://bersace03.free.fr/ift/
	18	*
	19	* The isight firmware loading was reverse engineered by Johannes Berg
	20	* <johannes@sipsolutions.de>, and this driver is based on code by Ronald
	21	* Bultje <rbultje@ronald.bitfreak.net>
	22	*/
	23
	24	#include <linux/usb.h>
	25	#include <linux/firmware.h>
	26	#include <linux/errno.h>
	27	#include <linux/module.h>
	28
33b9e162	29	static const struct usb_device_id id_table[] = {
62d104d0 MG	30	{USB_DEVICE(0x05ac, 0x8300)},
	31	{},
	32	};
	33
	34	MODULE_DEVICE_TABLE(usb, id_table);
	35
	36	static int isight_firmware_load(struct usb_interface *intf,
	37	const struct usb_device_id *id)
	38	{
	39	struct usb_device *dev = interface_to_usbdev(intf);
	40	int llen, len, req, ret = 0;
	41	const struct firmware *firmware;
62b58848	42	unsigned char *buf = kmalloc(50, GFP_KERNEL);
62d104d0	43	unsigned char data[4];
ed5a2825	44	const u8 *ptr;
62b58848 MG	45
	46	if (!buf)
	47	return -ENOMEM;
62d104d0 MG	48
	49	if (request_firmware(&firmware, "isight.fw", &dev->dev) != 0) {
	50	printk(KERN_ERR "Unable to load isight firmware\n");
ff1a4a7b PW	51	ret = -ENODEV;
ff1a4a7b PW	52	goto out;
62d104d0 MG	53	}
	54
	55	ptr = firmware->data;
	56
	57	if (usb_control_msg
	58	(dev, usb_sndctrlpipe(dev, 0), 0xa0, 0x40, 0xe600, 0, "\1", 1,
	59	300) != 1) {
	60	printk(KERN_ERR
	61	"Failed to initialise isight firmware loader\n");
	62	ret = -ENODEV;
	63	goto out;
	64	}
	65
62b58848	66	while (ptr+4 <= firmware->data+firmware->size) {
62d104d0 MG	67	memcpy(data, ptr, 4);
	68	len = (data[0] << 8 \| data[1]);
	69	req = (data[2] << 8 \| data[3]);
	70	ptr += 4;
	71
	72	if (len == 0x8001)
	73	break; /* success */
	74	else if (len == 0)
	75	continue;
	76
	77	for (; len > 0; req += 50) {
62b58848	78	llen = min(len, 50);
62d104d0	79	len -= llen;
62b58848 MG	80	if (ptr+llen > firmware->data+firmware->size) {
	81	printk(KERN_ERR
	82	"Malformed isight firmware");
	83	ret = -ENODEV;
	84	goto out;
	85	}
62d104d0 MG	86	memcpy(buf, ptr, llen);
	87
	88	ptr += llen;
	89
	90	if (usb_control_msg
	91	(dev, usb_sndctrlpipe(dev, 0), 0xa0, 0x40, req, 0,
	92	buf, llen, 300) != llen) {
	93	printk(KERN_ERR
	94	"Failed to load isight firmware\n");
62d104d0 MG	95	ret = -ENODEV;
	96	goto out;
	97	}
	98
62d104d0 MG	99	}
62d104d0 MG	100	}
62b58848	101
62d104d0 MG	102	if (usb_control_msg
	103	(dev, usb_sndctrlpipe(dev, 0), 0xa0, 0x40, 0xe600, 0, "\0", 1,
	104	300) != 1) {
	105	printk(KERN_ERR "isight firmware loading completion failed\n");
	106	ret = -ENODEV;
	107	}
62b58848	108
62d104d0	109	out:
62b58848	110	kfree(buf);
62d104d0 MG	111	release_firmware(firmware);
	112	return ret;
	113	}
	114
4e0961d5 BH	115	MODULE_FIRMWARE("isight.fw");
4e0961d5 BH	116
62d104d0 MG	117	static void isight_firmware_disconnect(struct usb_interface *intf)
	118	{
	119	}
	120
	121	static struct usb_driver isight_firmware_driver = {
	122	.name = "isight_firmware",
	123	.probe = isight_firmware_load,
	124	.disconnect = isight_firmware_disconnect,
	125	.id_table = id_table,
	126	};
	127
	128	static int __init isight_firmware_init(void)
	129	{
	130	return usb_register(&isight_firmware_driver);
	131	}
	132
	133	static void __exit isight_firmware_exit(void)
	134	{
	135	usb_deregister(&isight_firmware_driver);
	136	}
	137
	138	module_init(isight_firmware_init);
	139	module_exit(isight_firmware_exit);
	140
	141	MODULE_LICENSE("GPL");
	142	MODULE_AUTHOR("Matthew Garrett <mjg@redhat.com>");