[mirror_ubuntu-artful-kernel.git] / drivers / media / video / gspca / pac207.c

/*
 * Pixart PAC207BCA library
 *
 * Copyright (C) 2008 Hans de Goede <hdgoede@redhat.com>
 * Copyright (C) 2005 Thomas Kaiser thomas@kaiser-linux.li
 * Copyleft (C) 2005 Michel Xhaard mxhaard@magic.fr
 *
 * V4L2 by Jean-Francois Moine <http://moinejf.free.fr>
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#define MODULE_NAME "pac207"

#include "gspca.h"

MODULE_AUTHOR("Hans de Goede <hdgoede@redhat.com>");
MODULE_DESCRIPTION("Pixart PAC207");
MODULE_LICENSE("GPL");

#define PAC207_CTRL_TIMEOUT		100  /* ms */

#define PAC207_BRIGHTNESS_MIN		0
#define PAC207_BRIGHTNESS_MAX		255
#define PAC207_BRIGHTNESS_DEFAULT	46

#define PAC207_EXPOSURE_MIN		3
#define PAC207_EXPOSURE_MAX		26
#define PAC207_EXPOSURE_DEFAULT		5 /* power on default: 3 */
#define PAC207_EXPOSURE_KNEE		8 /* 4 = 30 fps, 11 = 8, 15 = 6 */

#define PAC207_GAIN_MIN			0
#define PAC207_GAIN_MAX			31
#define PAC207_GAIN_DEFAULT         	9 /* power on default: 9 */
#define PAC207_GAIN_KNEE		31

#define PAC207_AUTOGAIN_DEADZONE	30

/* specific webcam descriptor */
struct sd {
	struct gspca_dev gspca_dev;		/* !! must be the first item */

	u8 mode;

	u8 brightness;
	u8 exposure;
	u8 autogain;
	u8 gain;

	u8 sof_read;
	u8 header_read;
	u8 autogain_ignore_frames;

	atomic_t avg_lum;
};

/* V4L2 controls supported by the driver */
static int sd_setbrightness(struct gspca_dev *gspca_dev, __s32 val);
static int sd_getbrightness(struct gspca_dev *gspca_dev, __s32 *val);
static int sd_setexposure(struct gspca_dev *gspca_dev, __s32 val);
static int sd_getexposure(struct gspca_dev *gspca_dev, __s32 *val);
static int sd_setautogain(struct gspca_dev *gspca_dev, __s32 val);
static int sd_getautogain(struct gspca_dev *gspca_dev, __s32 *val);
static int sd_setgain(struct gspca_dev *gspca_dev, __s32 val);
static int sd_getgain(struct gspca_dev *gspca_dev, __s32 *val);

static const struct ctrl sd_ctrls[] = {
#define SD_BRIGHTNESS 0
	{
	    {
		.id      = V4L2_CID_BRIGHTNESS,
		.type    = V4L2_CTRL_TYPE_INTEGER,
		.name    = "Brightness",
		.minimum = PAC207_BRIGHTNESS_MIN,
		.maximum = PAC207_BRIGHTNESS_MAX,
		.step = 1,
		.default_value = PAC207_BRIGHTNESS_DEFAULT,
		.flags = 0,
	    },
	    .set = sd_setbrightness,
	    .get = sd_getbrightness,
	},
#define SD_EXPOSURE 1
	{
	    {
		.id = V4L2_CID_EXPOSURE,
		.type = V4L2_CTRL_TYPE_INTEGER,
		.name = "exposure",
		.minimum = PAC207_EXPOSURE_MIN,
		.maximum = PAC207_EXPOSURE_MAX,
		.step = 1,
		.default_value = PAC207_EXPOSURE_DEFAULT,
		.flags = 0,
	    },
	    .set = sd_setexposure,
	    .get = sd_getexposure,
	},
#define SD_AUTOGAIN 2
	{
	    {
		.id	  = V4L2_CID_AUTOGAIN,
		.type	= V4L2_CTRL_TYPE_BOOLEAN,
		.name	= "Auto Gain",
		.minimum = 0,
		.maximum = 1,
		.step	= 1,
#define AUTOGAIN_DEF 1
		.default_value = AUTOGAIN_DEF,
		.flags = 0,
	    },
	    .set = sd_setautogain,
	    .get = sd_getautogain,
	},
#define SD_GAIN 3
	{
	    {
		.id = V4L2_CID_GAIN,
		.type = V4L2_CTRL_TYPE_INTEGER,
		.name = "gain",
		.minimum = PAC207_GAIN_MIN,
		.maximum = PAC207_GAIN_MAX,
		.step = 1,
		.default_value = PAC207_GAIN_DEFAULT,
		.flags = 0,
	    },
	    .set = sd_setgain,
	    .get = sd_getgain,
	},
};

static const struct v4l2_pix_format sif_mode[] = {
	{176, 144, V4L2_PIX_FMT_PAC207, V4L2_FIELD_NONE,
		.bytesperline = 176,
		.sizeimage = (176 + 2) * 144,
			/* uncompressed, add 2 bytes / line for line header */
		.colorspace = V4L2_COLORSPACE_SRGB,
		.priv = 1},
	{352, 288, V4L2_PIX_FMT_PAC207, V4L2_FIELD_NONE,
		.bytesperline = 352,
			/* compressed, but only when needed (not compressed
			   when the framerate is low) */
		.sizeimage = (352 + 2) * 288,
		.colorspace = V4L2_COLORSPACE_SRGB,
		.priv = 0},
};

static const __u8 pac207_sensor_init[][8] = {
	{0x10, 0x12, 0x0d, 0x12, 0x0c, 0x01, 0x29, 0x84},
	{0x49, 0x64, 0x64, 0x64, 0x04, 0x10, 0xf0, 0x30},
	{0x00, 0x00, 0x00, 0x70, 0xa0, 0xf8, 0x00, 0x00},
	{0x32, 0x00, 0x96, 0x00, 0xA2, 0x02, 0xaf, 0x00},
};

static int pac207_write_regs(struct gspca_dev *gspca_dev, u16 index,
	const u8 *buffer, u16 length)
{
	struct usb_device *udev = gspca_dev->dev;
	int err;

	memcpy(gspca_dev->usb_buf, buffer, length);

	err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x01,
			USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_INTERFACE,
			0x00, index,
			gspca_dev->usb_buf, length, PAC207_CTRL_TIMEOUT);
	if (err < 0)
		PDEBUG(D_ERR,
			"Failed to write registers to index 0x%04X, error %d)",
			index, err);

	return err;
}


static int pac207_write_reg(struct gspca_dev *gspca_dev, u16 index, u16 value)
{
	struct usb_device *udev = gspca_dev->dev;
	int err;

	err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x00,
			USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_INTERFACE,
			value, index, NULL, 0, PAC207_CTRL_TIMEOUT);
	if (err)
		PDEBUG(D_ERR, "Failed to write a register (index 0x%04X,"
			" value 0x%02X, error %d)", index, value, err);

	return err;
}

static int pac207_read_reg(struct gspca_dev *gspca_dev, u16 index)
{
	struct usb_device *udev = gspca_dev->dev;
	int res;

	res = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0), 0x00,
			USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_INTERFACE,
			0x00, index,
			gspca_dev->usb_buf, 1, PAC207_CTRL_TIMEOUT);
	if (res < 0) {
		PDEBUG(D_ERR,
			"Failed to read a register (index 0x%04X, error %d)",
			index, res);
		return res;
	}

	return gspca_dev->usb_buf[0];
}

/* this function is called at probe time */
static int sd_config(struct gspca_dev *gspca_dev,
			const struct usb_device_id *id)
{
	struct sd *sd = (struct sd *) gspca_dev;
	struct cam *cam;
	u8 idreg[2];

	idreg[0] = pac207_read_reg(gspca_dev, 0x0000);
	idreg[1] = pac207_read_reg(gspca_dev, 0x0001);
	idreg[0] = ((idreg[0] & 0x0F) << 4) | ((idreg[1] & 0xf0) >> 4);
	idreg[1] = idreg[1] & 0x0f;
	PDEBUG(D_PROBE, "Pixart Sensor ID 0x%02X Chips ID 0x%02X",
		idreg[0], idreg[1]);

	if (idreg[0] != 0x27) {
		PDEBUG(D_PROBE, "Error invalid sensor ID!");
		return -ENODEV;
	}

	PDEBUG(D_PROBE,
		"Pixart PAC207BCA Image Processor and Control Chip detected"
		" (vid/pid 0x%04X:0x%04X)", id->idVendor, id->idProduct);

	cam = &gspca_dev->cam;
	cam->cam_mode = sif_mode;
	cam->nmodes = ARRAY_SIZE(sif_mode);
	sd->brightness = PAC207_BRIGHTNESS_DEFAULT;
	sd->exposure = PAC207_EXPOSURE_DEFAULT;
	sd->gain = PAC207_GAIN_DEFAULT;
	sd->autogain = AUTOGAIN_DEF;

	return 0;
}

/* this function is called at probe and resume time */
static int sd_init(struct gspca_dev *gspca_dev)
{
	pac207_write_reg(gspca_dev, 0x41, 0x00);
				/* Bit_0=Image Format,
				 * Bit_1=LED,
				 * Bit_2=Compression test mode enable */
	pac207_write_reg(gspca_dev, 0x0f, 0x00); /* Power Control */

	return 0;
}

/* -- start the camera -- */
static int sd_start(struct gspca_dev *gspca_dev)
{
	struct sd *sd = (struct sd *) gspca_dev;
	__u8 mode;

	pac207_write_reg(gspca_dev, 0x0f, 0x10); /* Power control (Bit 6-0) */
	pac207_write_regs(gspca_dev, 0x0002, pac207_sensor_init[0], 8);
	pac207_write_regs(gspca_dev, 0x000a, pac207_sensor_init[1], 8);
	pac207_write_regs(gspca_dev, 0x0012, pac207_sensor_init[2], 8);
	pac207_write_regs(gspca_dev, 0x0042, pac207_sensor_init[3], 8);

	/* Compression Balance */
	if (gspca_dev->width == 176)
		pac207_write_reg(gspca_dev, 0x4a, 0xff);
	else
		pac207_write_reg(gspca_dev, 0x4a, 0x30);
	pac207_write_reg(gspca_dev, 0x4b, 0x00); /* Sram test value */
	pac207_write_reg(gspca_dev, 0x08, sd->brightness);

	/* PGA global gain (Bit 4-0) */
	pac207_write_reg(gspca_dev, 0x0e, sd->gain);
	pac207_write_reg(gspca_dev, 0x02, sd->exposure); /* PXCK = 12MHz /n */

	mode = 0x02; /* Image Format (Bit 0), LED (1), Compr. test mode (2) */
	if (gspca_dev->width == 176) {	/* 176x144 */
		mode |= 0x01;
		PDEBUG(D_STREAM, "pac207_start mode 176x144");
	} else {				/* 352x288 */
		PDEBUG(D_STREAM, "pac207_start mode 352x288");
	}
	pac207_write_reg(gspca_dev, 0x41, mode);

	pac207_write_reg(gspca_dev, 0x13, 0x01); /* Bit 0, auto clear */
	pac207_write_reg(gspca_dev, 0x1c, 0x01); /* not documented */
	msleep(10);
	pac207_write_reg(gspca_dev, 0x40, 0x01); /* Start ISO pipe */

	sd->sof_read = 0;
	sd->autogain_ignore_frames = 0;
	atomic_set(&sd->avg_lum, -1);
	return 0;
}

static void sd_stopN(struct gspca_dev *gspca_dev)
{
	pac207_write_reg(gspca_dev, 0x40, 0x00); /* Stop ISO pipe */
	pac207_write_reg(gspca_dev, 0x41, 0x00); /* Turn of LED */
	pac207_write_reg(gspca_dev, 0x0f, 0x00); /* Power Control */
}

/* Include pac common sof detection functions */
#include "pac_common.h"

static void pac207_do_auto_gain(struct gspca_dev *gspca_dev)
{
	struct sd *sd = (struct sd *) gspca_dev;
	int avg_lum = atomic_read(&sd->avg_lum);

	if (avg_lum == -1)
		return;

	if (sd->autogain_ignore_frames > 0)
		sd->autogain_ignore_frames--;
	else if (gspca_auto_gain_n_exposure(gspca_dev, avg_lum,
			100, PAC207_AUTOGAIN_DEADZONE,
			PAC207_GAIN_KNEE, PAC207_EXPOSURE_KNEE))
		sd->autogain_ignore_frames = PAC_AUTOGAIN_IGNORE_FRAMES;
}

static void sd_pkt_scan(struct gspca_dev *gspca_dev,
			u8 *data,
			int len)
{
	struct sd *sd = (struct sd *) gspca_dev;
	unsigned char *sof;

	sof = pac_find_sof(&sd->sof_read, data, len);
	if (sof) {
		int n;

		/* finish decoding current frame */
		n = sof - data;
		if (n > sizeof pac_sof_marker)
			n -= sizeof pac_sof_marker;
		else
			n = 0;
		gspca_frame_add(gspca_dev, LAST_PACKET,
				data, n);
		sd->header_read = 0;
		gspca_frame_add(gspca_dev, FIRST_PACKET, NULL, 0);
		len -= sof - data;
		data = sof;
	}
	if (sd->header_read < 11) {
		int needed;

		/* get average lumination from frame header (byte 5) */
		if (sd->header_read < 5) {
			needed = 5 - sd->header_read;
			if (len >= needed)
				atomic_set(&sd->avg_lum, data[needed - 1]);
		}
		/* skip the rest of the header */
		needed = 11 - sd->header_read;
		if (len <= needed) {
			sd->header_read += len;
			return;
		}
		data += needed;
		len -= needed;
		sd->header_read = 11;
	}

	gspca_frame_add(gspca_dev, INTER_PACKET, data, len);
}

static void setbrightness(struct gspca_dev *gspca_dev)
{
	struct sd *sd = (struct sd *) gspca_dev;

	pac207_write_reg(gspca_dev, 0x08, sd->brightness);
	pac207_write_reg(gspca_dev, 0x13, 0x01);	/* Bit 0, auto clear */
	pac207_write_reg(gspca_dev, 0x1c, 0x01);	/* not documented */
}

static void setexposure(struct gspca_dev *gspca_dev)
{
	struct sd *sd = (struct sd *) gspca_dev;

	pac207_write_reg(gspca_dev, 0x02, sd->exposure);
	pac207_write_reg(gspca_dev, 0x13, 0x01);	/* Bit 0, auto clear */
	pac207_write_reg(gspca_dev, 0x1c, 0x01);	/* not documented */
}

static void setgain(struct gspca_dev *gspca_dev)
{
	struct sd *sd = (struct sd *) gspca_dev;

	pac207_write_reg(gspca_dev, 0x0e, sd->gain);
	pac207_write_reg(gspca_dev, 0x13, 0x01);	/* Bit 0, auto clear */
	pac207_write_reg(gspca_dev, 0x1c, 0x01);	/* not documented */
}

static int sd_setbrightness(struct gspca_dev *gspca_dev, __s32 val)
{
	struct sd *sd = (struct sd *) gspca_dev;

	sd->brightness = val;
	if (gspca_dev->streaming)
		setbrightness(gspca_dev);
	return 0;
}

static int sd_getbrightness(struct gspca_dev *gspca_dev, __s32 *val)
{
	struct sd *sd = (struct sd *) gspca_dev;

	*val = sd->brightness;
	return 0;
}

static int sd_setexposure(struct gspca_dev *gspca_dev, __s32 val)
{
	struct sd *sd = (struct sd *) gspca_dev;

	sd->exposure = val;
	if (gspca_dev->streaming)
		setexposure(gspca_dev);
	return 0;
}

static int sd_getexposure(struct gspca_dev *gspca_dev, __s32 *val)
{
	struct sd *sd = (struct sd *) gspca_dev;

	*val = sd->exposure;
	return 0;
}

static int sd_setgain(struct gspca_dev *gspca_dev, __s32 val)
{
	struct sd *sd = (struct sd *) gspca_dev;

	sd->gain = val;
	if (gspca_dev->streaming)
		setgain(gspca_dev);
	return 0;
}

static int sd_getgain(struct gspca_dev *gspca_dev, __s32 *val)
{
	struct sd *sd = (struct sd *) gspca_dev;

	*val = sd->gain;
	return 0;
}

static int sd_setautogain(struct gspca_dev *gspca_dev, __s32 val)
{
	struct sd *sd = (struct sd *) gspca_dev;

	sd->autogain = val;
	/* when switching to autogain set defaults to make sure
	   we are on a valid point of the autogain gain /
	   exposure knee graph, and give this change time to
	   take effect before doing autogain. */
	if (sd->autogain) {
		sd->exposure = PAC207_EXPOSURE_DEFAULT;
		sd->gain = PAC207_GAIN_DEFAULT;
		if (gspca_dev->streaming) {
			sd->autogain_ignore_frames =
				PAC_AUTOGAIN_IGNORE_FRAMES;
			setexposure(gspca_dev);
			setgain(gspca_dev);
		}
	}

	return 0;
}

static int sd_getautogain(struct gspca_dev *gspca_dev, __s32 *val)
{
	struct sd *sd = (struct sd *) gspca_dev;

	*val = sd->autogain;
	return 0;
}

/* sub-driver description */
static const struct sd_desc sd_desc = {
	.name = MODULE_NAME,
	.ctrls = sd_ctrls,
	.nctrls = ARRAY_SIZE(sd_ctrls),
	.config = sd_config,
	.init = sd_init,
	.start = sd_start,
	.stopN = sd_stopN,
	.dq_callback = pac207_do_auto_gain,
	.pkt_scan = sd_pkt_scan,
};

/* -- module initialisation -- */
static const __devinitdata struct usb_device_id device_table[] = {
	{USB_DEVICE(0x041e, 0x4028)},
	{USB_DEVICE(0x093a, 0x2460)},
	{USB_DEVICE(0x093a, 0x2461)},
	{USB_DEVICE(0x093a, 0x2463)},
	{USB_DEVICE(0x093a, 0x2464)},
	{USB_DEVICE(0x093a, 0x2468)},
	{USB_DEVICE(0x093a, 0x2470)},
	{USB_DEVICE(0x093a, 0x2471)},
	{USB_DEVICE(0x093a, 0x2472)},
	{USB_DEVICE(0x093a, 0x2474)},
	{USB_DEVICE(0x093a, 0x2476)},
	{USB_DEVICE(0x145f, 0x013a)},
	{USB_DEVICE(0x2001, 0xf115)},
	{}
};
MODULE_DEVICE_TABLE(usb, device_table);

/* -- device connect -- */
static int sd_probe(struct usb_interface *intf,
			const struct usb_device_id *id)
{
	return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
				THIS_MODULE);
}

static struct usb_driver sd_driver = {
	.name = MODULE_NAME,
	.id_table = device_table,
	.probe = sd_probe,
	.disconnect = gspca_disconnect,
#ifdef CONFIG_PM
	.suspend = gspca_suspend,
	.resume = gspca_resume,
#endif
};

/* -- module insert / remove -- */
static int __init sd_mod_init(void)
{
	int ret;
	ret = usb_register(&sd_driver);
	if (ret < 0)
		return ret;
	PDEBUG(D_PROBE, "registered");
	return 0;
}
static void __exit sd_mod_exit(void)
{
	usb_deregister(&sd_driver);
	PDEBUG(D_PROBE, "deregistered");
}

module_init(sd_mod_init);
module_exit(sd_mod_exit);
Commit	Line	Data
e2997a72 HG	1	/*
	2	* Pixart PAC207BCA library
	3	*
dc1fe157	4	* Copyright (C) 2008 Hans de Goede <hdgoede@redhat.com>
e2997a72 HG	5	* Copyright (C) 2005 Thomas Kaiser thomas@kaiser-linux.li
	6	* Copyleft (C) 2005 Michel Xhaard mxhaard@magic.fr
	7	*
	8	* V4L2 by Jean-Francois Moine <http://moinejf.free.fr>
	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
	12	* the Free Software Foundation; either version 2 of the License, or
	13	* (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software
	22	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	23	*
	24	*/
	25
	26	#define MODULE_NAME "pac207"
	27
	28	#include "gspca.h"
	29
dc1fe157	30	MODULE_AUTHOR("Hans de Goede <hdgoede@redhat.com>");
e2997a72 HG	31	MODULE_DESCRIPTION("Pixart PAC207");
	32	MODULE_LICENSE("GPL");
	33
	34	#define PAC207_CTRL_TIMEOUT 100 /* ms */
	35
	36	#define PAC207_BRIGHTNESS_MIN 0
	37	#define PAC207_BRIGHTNESS_MAX 255
0e4a9099 HG	38	#define PAC207_BRIGHTNESS_DEFAULT 46
	39
	40	#define PAC207_EXPOSURE_MIN 3
e2997a72	41	#define PAC207_EXPOSURE_MAX 26
0e4a9099 HG	42	#define PAC207_EXPOSURE_DEFAULT 5 /* power on default: 3 */
0e4a9099 HG	43	#define PAC207_EXPOSURE_KNEE 8 /* 4 = 30 fps, 11 = 8, 15 = 6 */
e2997a72 HG	44
	45	#define PAC207_GAIN_MIN 0
	46	#define PAC207_GAIN_MAX 31
	47	#define PAC207_GAIN_DEFAULT 9 /* power on default: 9 */
0e4a9099	48	#define PAC207_GAIN_KNEE 31
e2997a72 HG	49
e2997a72 HG	50	#define PAC207_AUTOGAIN_DEADZONE 30
e2997a72	51
e2997a72 HG	52	/* specific webcam descriptor */
	53	struct sd {
	54	struct gspca_dev gspca_dev; /* !! must be the first item */
	55
e2997a72 HG	56	u8 mode;
	57
	58	u8 brightness;
	59	u8 exposure;
	60	u8 autogain;
	61	u8 gain;
	62
	63	u8 sof_read;
ab8f12cf	64	u8 header_read;
e2997a72 HG	65	u8 autogain_ignore_frames;
	66
	67	atomic_t avg_lum;
	68	};
	69
	70	/* V4L2 controls supported by the driver */
	71	static int sd_setbrightness(struct gspca_dev *gspca_dev, __s32 val);
	72	static int sd_getbrightness(struct gspca_dev gspca_dev, __s32 val);
	73	static int sd_setexposure(struct gspca_dev *gspca_dev, __s32 val);
	74	static int sd_getexposure(struct gspca_dev gspca_dev, __s32 val);
	75	static int sd_setautogain(struct gspca_dev *gspca_dev, __s32 val);
	76	static int sd_getautogain(struct gspca_dev gspca_dev, __s32 val);
	77	static int sd_setgain(struct gspca_dev *gspca_dev, __s32 val);
	78	static int sd_getgain(struct gspca_dev gspca_dev, __s32 val);
	79
7e64dc4c	80	static const struct ctrl sd_ctrls[] = {
e2997a72 HG	81	#define SD_BRIGHTNESS 0
	82	{
	83	{
	84	.id = V4L2_CID_BRIGHTNESS,
	85	.type = V4L2_CTRL_TYPE_INTEGER,
	86	.name = "Brightness",
	87	.minimum = PAC207_BRIGHTNESS_MIN,
	88	.maximum = PAC207_BRIGHTNESS_MAX,
	89	.step = 1,
	90	.default_value = PAC207_BRIGHTNESS_DEFAULT,
	91	.flags = 0,
	92	},
	93	.set = sd_setbrightness,
	94	.get = sd_getbrightness,
	95	},
	96	#define SD_EXPOSURE 1
	97	{
	98	{
	99	.id = V4L2_CID_EXPOSURE,
	100	.type = V4L2_CTRL_TYPE_INTEGER,
	101	.name = "exposure",
	102	.minimum = PAC207_EXPOSURE_MIN,
	103	.maximum = PAC207_EXPOSURE_MAX,
	104	.step = 1,
	105	.default_value = PAC207_EXPOSURE_DEFAULT,
	106	.flags = 0,
	107	},
	108	.set = sd_setexposure,
	109	.get = sd_getexposure,
	110	},
	111	#define SD_AUTOGAIN 2
	112	{
	113	{
	114	.id = V4L2_CID_AUTOGAIN,
	115	.type = V4L2_CTRL_TYPE_BOOLEAN,
	116	.name = "Auto Gain",
	117	.minimum = 0,
	118	.maximum = 1,
	119	.step = 1,
66e4124f JFM	120	#define AUTOGAIN_DEF 1
66e4124f JFM	121	.default_value = AUTOGAIN_DEF,
e2997a72 HG	122	.flags = 0,
	123	},
	124	.set = sd_setautogain,
	125	.get = sd_getautogain,
	126	},
	127	#define SD_GAIN 3
	128	{
	129	{
	130	.id = V4L2_CID_GAIN,
	131	.type = V4L2_CTRL_TYPE_INTEGER,
	132	.name = "gain",
	133	.minimum = PAC207_GAIN_MIN,
	134	.maximum = PAC207_GAIN_MAX,
	135	.step = 1,
	136	.default_value = PAC207_GAIN_DEFAULT,
	137	.flags = 0,
	138	},
	139	.set = sd_setgain,
	140	.get = sd_getgain,
	141	},
	142	};
	143
cc611b8a	144	static const struct v4l2_pix_format sif_mode[] = {
c2446b3e JFM	145	{176, 144, V4L2_PIX_FMT_PAC207, V4L2_FIELD_NONE,
	146	.bytesperline = 176,
	147	.sizeimage = (176 + 2) * 144,
	148	/* uncompressed, add 2 bytes / line for line header */
	149	.colorspace = V4L2_COLORSPACE_SRGB,
	150	.priv = 1},
	151	{352, 288, V4L2_PIX_FMT_PAC207, V4L2_FIELD_NONE,
	152	.bytesperline = 352,
80544d3c HG	153	/* compressed, but only when needed (not compressed
	154	when the framerate is low) */
	155	.sizeimage = (352 + 2) * 288,
c2446b3e JFM	156	.colorspace = V4L2_COLORSPACE_SRGB,
c2446b3e JFM	157	.priv = 0},
e2997a72 HG	158	};
	159
	160	static const __u8 pac207_sensor_init[][8] = {
0e4a9099 HG	161	{0x10, 0x12, 0x0d, 0x12, 0x0c, 0x01, 0x29, 0x84},
0e4a9099 HG	162	{0x49, 0x64, 0x64, 0x64, 0x04, 0x10, 0xf0, 0x30},
e2997a72	163	{0x00, 0x00, 0x00, 0x70, 0xa0, 0xf8, 0x00, 0x00},
e2997a72 HG	164	{0x32, 0x00, 0x96, 0x00, 0xA2, 0x02, 0xaf, 0x00},
	165	};
	166
739570bb	167	static int pac207_write_regs(struct gspca_dev *gspca_dev, u16 index,
e2997a72 HG	168	const u8 *buffer, u16 length)
	169	{
	170	struct usb_device *udev = gspca_dev->dev;
	171	int err;
e2997a72	172
739570bb	173	memcpy(gspca_dev->usb_buf, buffer, length);
e2997a72 HG	174
	175	err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x01,
	176	USB_DIR_OUT \| USB_TYPE_VENDOR \| USB_RECIP_INTERFACE,
739570bb JFM	177	0x00, index,
739570bb JFM	178	gspca_dev->usb_buf, length, PAC207_CTRL_TIMEOUT);
e2997a72 HG	179	if (err < 0)
	180	PDEBUG(D_ERR,
	181	"Failed to write registers to index 0x%04X, error %d)",
	182	index, err);
	183
	184	return err;
	185	}
	186
	187
903e10aa	188	static int pac207_write_reg(struct gspca_dev *gspca_dev, u16 index, u16 value)
e2997a72 HG	189	{
	190	struct usb_device *udev = gspca_dev->dev;
	191	int err;
	192
	193	err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0), 0x00,
	194	USB_DIR_OUT \| USB_TYPE_VENDOR \| USB_RECIP_INTERFACE,
	195	value, index, NULL, 0, PAC207_CTRL_TIMEOUT);
	196	if (err)
	197	PDEBUG(D_ERR, "Failed to write a register (index 0x%04X,"
	198	" value 0x%02X, error %d)", index, value, err);
	199
	200	return err;
	201	}
	202
903e10aa	203	static int pac207_read_reg(struct gspca_dev *gspca_dev, u16 index)
e2997a72 HG	204	{
e2997a72 HG	205	struct usb_device *udev = gspca_dev->dev;
e2997a72 HG	206	int res;
	207
	208	res = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0), 0x00,
	209	USB_DIR_IN \| USB_TYPE_VENDOR \| USB_RECIP_INTERFACE,
739570bb JFM	210	0x00, index,
739570bb JFM	211	gspca_dev->usb_buf, 1, PAC207_CTRL_TIMEOUT);
e2997a72 HG	212	if (res < 0) {
	213	PDEBUG(D_ERR,
	214	"Failed to read a register (index 0x%04X, error %d)",
	215	index, res);
	216	return res;
	217	}
	218
739570bb	219	return gspca_dev->usb_buf[0];
e2997a72 HG	220	}
e2997a72 HG	221
e2997a72 HG	222	/* this function is called at probe time */
	223	static int sd_config(struct gspca_dev *gspca_dev,
	224	const struct usb_device_id *id)
	225	{
4aa0d037	226	struct sd sd = (struct sd ) gspca_dev;
e2997a72 HG	227	struct cam *cam;
	228	u8 idreg[2];
	229
	230	idreg[0] = pac207_read_reg(gspca_dev, 0x0000);
	231	idreg[1] = pac207_read_reg(gspca_dev, 0x0001);
	232	idreg[0] = ((idreg[0] & 0x0F) << 4) \| ((idreg[1] & 0xf0) >> 4);
	233	idreg[1] = idreg[1] & 0x0f;
	234	PDEBUG(D_PROBE, "Pixart Sensor ID 0x%02X Chips ID 0x%02X",
	235	idreg[0], idreg[1]);
	236
	237	if (idreg[0] != 0x27) {
	238	PDEBUG(D_PROBE, "Error invalid sensor ID!");
	239	return -ENODEV;
	240	}
	241
e2997a72 HG	242	PDEBUG(D_PROBE,
	243	"Pixart PAC207BCA Image Processor and Control Chip detected"
	244	" (vid/pid 0x%04X:0x%04X)", id->idVendor, id->idProduct);
	245
	246	cam = &gspca_dev->cam;
e2997a72 HG	247	cam->cam_mode = sif_mode;
e2997a72 HG	248	cam->nmodes = ARRAY_SIZE(sif_mode);
4aa0d037 JFM	249	sd->brightness = PAC207_BRIGHTNESS_DEFAULT;
	250	sd->exposure = PAC207_EXPOSURE_DEFAULT;
	251	sd->gain = PAC207_GAIN_DEFAULT;
66e4124f	252	sd->autogain = AUTOGAIN_DEF;
e2997a72 HG	253
	254	return 0;
	255	}
	256
012d6b02 JFM	257	/* this function is called at probe and resume time */
012d6b02 JFM	258	static int sd_init(struct gspca_dev *gspca_dev)
e2997a72	259	{
66e4124f JFM	260	pac207_write_reg(gspca_dev, 0x41, 0x00);
	261	/* Bit_0=Image Format,
	262	* Bit_1=LED,
	263	* Bit_2=Compression test mode enable */
	264	pac207_write_reg(gspca_dev, 0x0f, 0x00); /* Power Control */
e2997a72	265
e2997a72 HG	266	return 0;
	267	}
	268
	269	/* -- start the camera -- */
72ab97ce	270	static int sd_start(struct gspca_dev *gspca_dev)
e2997a72 HG	271	{
	272	struct sd sd = (struct sd ) gspca_dev;
	273	__u8 mode;
	274
	275	pac207_write_reg(gspca_dev, 0x0f, 0x10); /* Power control (Bit 6-0) */
	276	pac207_write_regs(gspca_dev, 0x0002, pac207_sensor_init[0], 8);
	277	pac207_write_regs(gspca_dev, 0x000a, pac207_sensor_init[1], 8);
	278	pac207_write_regs(gspca_dev, 0x0012, pac207_sensor_init[2], 8);
c529e556	279	pac207_write_regs(gspca_dev, 0x0042, pac207_sensor_init[3], 8);
e2997a72 HG	280
	281	/* Compression Balance */
	282	if (gspca_dev->width == 176)
	283	pac207_write_reg(gspca_dev, 0x4a, 0xff);
	284	else
0e4a9099	285	pac207_write_reg(gspca_dev, 0x4a, 0x30);
e2997a72 HG	286	pac207_write_reg(gspca_dev, 0x4b, 0x00); /* Sram test value */
	287	pac207_write_reg(gspca_dev, 0x08, sd->brightness);
	288
	289	/* PGA global gain (Bit 4-0) */
	290	pac207_write_reg(gspca_dev, 0x0e, sd->gain);
	291	pac207_write_reg(gspca_dev, 0x02, sd->exposure); /* PXCK = 12MHz /n */
	292
	293	mode = 0x02; /* Image Format (Bit 0), LED (1), Compr. test mode (2) */
d43fa32f	294	if (gspca_dev->width == 176) { /* 176x144 */
e2997a72 HG	295	mode \|= 0x01;
e2997a72 HG	296	PDEBUG(D_STREAM, "pac207_start mode 176x144");
d43fa32f	297	} else { /* 352x288 */
e2997a72	298	PDEBUG(D_STREAM, "pac207_start mode 352x288");
d43fa32f	299	}
e2997a72 HG	300	pac207_write_reg(gspca_dev, 0x41, mode);
	301
	302	pac207_write_reg(gspca_dev, 0x13, 0x01); /* Bit 0, auto clear */
	303	pac207_write_reg(gspca_dev, 0x1c, 0x01); /* not documented */
6a7eba24	304	msleep(10);
e2997a72 HG	305	pac207_write_reg(gspca_dev, 0x40, 0x01); /* Start ISO pipe */
	306
	307	sd->sof_read = 0;
	308	sd->autogain_ignore_frames = 0;
	309	atomic_set(&sd->avg_lum, -1);
72ab97ce	310	return 0;
e2997a72 HG	311	}
	312
	313	static void sd_stopN(struct gspca_dev *gspca_dev)
	314	{
	315	pac207_write_reg(gspca_dev, 0x40, 0x00); /* Stop ISO pipe */
	316	pac207_write_reg(gspca_dev, 0x41, 0x00); /* Turn of LED */
	317	pac207_write_reg(gspca_dev, 0x0f, 0x00); /* Power Control */
	318	}
	319
8a5b2e90 HG	320	/* Include pac common sof detection functions */
	321	#include "pac_common.h"
	322
e2997a72 HG	323	static void pac207_do_auto_gain(struct gspca_dev *gspca_dev)
	324	{
	325	struct sd sd = (struct sd ) gspca_dev;
e2997a72 HG	326	int avg_lum = atomic_read(&sd->avg_lum);
e2997a72 HG	327
dcef3237	328	if (avg_lum == -1)
e2997a72 HG	329	return;
e2997a72 HG	330
dcef3237	331	if (sd->autogain_ignore_frames > 0)
e2997a72	332	sd->autogain_ignore_frames--;
dcef3237	333	else if (gspca_auto_gain_n_exposure(gspca_dev, avg_lum,
0e4a9099	334	100, PAC207_AUTOGAIN_DEADZONE,
dcef3237	335	PAC207_GAIN_KNEE, PAC207_EXPOSURE_KNEE))
8a5b2e90	336	sd->autogain_ignore_frames = PAC_AUTOGAIN_IGNORE_FRAMES;
e2997a72 HG	337	}
e2997a72 HG	338
e2997a72	339	static void sd_pkt_scan(struct gspca_dev *gspca_dev,
76dd272b	340	u8 *data,
e2997a72 HG	341	int len)
e2997a72 HG	342	{
ab8f12cf	343	struct sd sd = (struct sd ) gspca_dev;
e2997a72	344	unsigned char *sof;
e2997a72	345
a6b69e40	346	sof = pac_find_sof(&sd->sof_read, data, len);
e2997a72	347	if (sof) {
ab8f12cf HG	348	int n;
ab8f12cf HG	349
e2997a72	350	/* finish decoding current frame */
ab8f12cf	351	n = sof - data;
327c4abf HG	352	if (n > sizeof pac_sof_marker)
327c4abf HG	353	n -= sizeof pac_sof_marker;
ab8f12cf HG	354	else
ab8f12cf HG	355	n = 0;
76dd272b JFM	356	gspca_frame_add(gspca_dev, LAST_PACKET,
76dd272b JFM	357	data, n);
ab8f12cf	358	sd->header_read = 0;
76dd272b	359	gspca_frame_add(gspca_dev, FIRST_PACKET, NULL, 0);
e2997a72 HG	360	len -= sof - data;
	361	data = sof;
	362	}
ab8f12cf HG	363	if (sd->header_read < 11) {
ab8f12cf HG	364	int needed;
e2997a72	365
ab8f12cf HG	366	/* get average lumination from frame header (byte 5) */
	367	if (sd->header_read < 5) {
	368	needed = 5 - sd->header_read;
	369	if (len >= needed)
	370	atomic_set(&sd->avg_lum, data[needed - 1]);
	371	}
	372	/* skip the rest of the header */
	373	needed = 11 - sd->header_read;
	374	if (len <= needed) {
	375	sd->header_read += len;
	376	return;
	377	}
	378	data += needed;
	379	len -= needed;
	380	sd->header_read = 11;
	381	}
e2997a72	382
76dd272b	383	gspca_frame_add(gspca_dev, INTER_PACKET, data, len);
e2997a72 HG	384	}
	385
	386	static void setbrightness(struct gspca_dev *gspca_dev)
	387	{
	388	struct sd sd = (struct sd ) gspca_dev;
	389
	390	pac207_write_reg(gspca_dev, 0x08, sd->brightness);
	391	pac207_write_reg(gspca_dev, 0x13, 0x01); /* Bit 0, auto clear */
	392	pac207_write_reg(gspca_dev, 0x1c, 0x01); /* not documented */
	393	}
	394
	395	static void setexposure(struct gspca_dev *gspca_dev)
	396	{
	397	struct sd sd = (struct sd ) gspca_dev;
	398
	399	pac207_write_reg(gspca_dev, 0x02, sd->exposure);
	400	pac207_write_reg(gspca_dev, 0x13, 0x01); /* Bit 0, auto clear */
	401	pac207_write_reg(gspca_dev, 0x1c, 0x01); /* not documented */
	402	}
	403
	404	static void setgain(struct gspca_dev *gspca_dev)
	405	{
	406	struct sd sd = (struct sd ) gspca_dev;
	407
	408	pac207_write_reg(gspca_dev, 0x0e, sd->gain);
	409	pac207_write_reg(gspca_dev, 0x13, 0x01); /* Bit 0, auto clear */
	410	pac207_write_reg(gspca_dev, 0x1c, 0x01); /* not documented */
	411	}
	412
	413	static int sd_setbrightness(struct gspca_dev *gspca_dev, __s32 val)
	414	{
	415	struct sd sd = (struct sd ) gspca_dev;
	416
	417	sd->brightness = val;
	418	if (gspca_dev->streaming)
	419	setbrightness(gspca_dev);
	420	return 0;
	421	}
	422
	423	static int sd_getbrightness(struct gspca_dev gspca_dev, __s32 val)
	424	{
	425	struct sd sd = (struct sd ) gspca_dev;
	426
	427	*val = sd->brightness;
	428	return 0;
	429	}
	430
	431	static int sd_setexposure(struct gspca_dev *gspca_dev, __s32 val)
	432	{
	433	struct sd sd = (struct sd ) gspca_dev;
	434
e2997a72 HG	435	sd->exposure = val;
	436	if (gspca_dev->streaming)
	437	setexposure(gspca_dev);
	438	return 0;
	439	}
	440
	441	static int sd_getexposure(struct gspca_dev gspca_dev, __s32 val)
	442	{
	443	struct sd sd = (struct sd ) gspca_dev;
	444
	445	*val = sd->exposure;
	446	return 0;
	447	}
	448
	449	static int sd_setgain(struct gspca_dev *gspca_dev, __s32 val)
	450	{
	451	struct sd sd = (struct sd ) gspca_dev;
	452
e2997a72 HG	453	sd->gain = val;
	454	if (gspca_dev->streaming)
	455	setgain(gspca_dev);
	456	return 0;
	457	}
	458
	459	static int sd_getgain(struct gspca_dev gspca_dev, __s32 val)
	460	{
	461	struct sd sd = (struct sd ) gspca_dev;
	462
	463	*val = sd->gain;
	464	return 0;
	465	}
	466
	467	static int sd_setautogain(struct gspca_dev *gspca_dev, __s32 val)
	468	{
	469	struct sd sd = (struct sd ) gspca_dev;
	470
	471	sd->autogain = val;
	472	/* when switching to autogain set defaults to make sure
	473	we are on a valid point of the autogain gain /
	474	exposure knee graph, and give this change time to
	475	take effect before doing autogain. */
	476	if (sd->autogain) {
	477	sd->exposure = PAC207_EXPOSURE_DEFAULT;
	478	sd->gain = PAC207_GAIN_DEFAULT;
	479	if (gspca_dev->streaming) {
	480	sd->autogain_ignore_frames =
8a5b2e90	481	PAC_AUTOGAIN_IGNORE_FRAMES;
e2997a72 HG	482	setexposure(gspca_dev);
	483	setgain(gspca_dev);
	484	}
	485	}
	486
	487	return 0;
	488	}
	489
	490	static int sd_getautogain(struct gspca_dev gspca_dev, __s32 val)
	491	{
	492	struct sd sd = (struct sd ) gspca_dev;
	493
	494	*val = sd->autogain;
	495	return 0;
	496	}
	497
	498	/* sub-driver description */
a5ae2062	499	static const struct sd_desc sd_desc = {
e2997a72 HG	500	.name = MODULE_NAME,
	501	.ctrls = sd_ctrls,
	502	.nctrls = ARRAY_SIZE(sd_ctrls),
	503	.config = sd_config,
012d6b02	504	.init = sd_init,
e2997a72 HG	505	.start = sd_start,
e2997a72 HG	506	.stopN = sd_stopN,
e2997a72 HG	507	.dq_callback = pac207_do_auto_gain,
	508	.pkt_scan = sd_pkt_scan,
	509	};
	510
	511	/* -- module initialisation -- */
a5ae2062	512	static const __devinitdata struct usb_device_id device_table[] = {
9d64fdb1 JFM	513	{USB_DEVICE(0x041e, 0x4028)},
9d64fdb1 JFM	514	{USB_DEVICE(0x093a, 0x2460)},
87945895	515	{USB_DEVICE(0x093a, 0x2461)},
9d64fdb1 JFM	516	{USB_DEVICE(0x093a, 0x2463)},
	517	{USB_DEVICE(0x093a, 0x2464)},
	518	{USB_DEVICE(0x093a, 0x2468)},
	519	{USB_DEVICE(0x093a, 0x2470)},
	520	{USB_DEVICE(0x093a, 0x2471)},
	521	{USB_DEVICE(0x093a, 0x2472)},
db91235e	522	{USB_DEVICE(0x093a, 0x2474)},
d654dca7	523	{USB_DEVICE(0x093a, 0x2476)},
91711874	524	{USB_DEVICE(0x145f, 0x013a)},
9d64fdb1	525	{USB_DEVICE(0x2001, 0xf115)},
e2997a72 HG	526	{}
	527	};
	528	MODULE_DEVICE_TABLE(usb, device_table);
	529
	530	/* -- device connect -- */
	531	static int sd_probe(struct usb_interface *intf,
	532	const struct usb_device_id *id)
	533	{
d43fa32f JFM	534	return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
d43fa32f JFM	535	THIS_MODULE);
e2997a72 HG	536	}
	537
	538	static struct usb_driver sd_driver = {
	539	.name = MODULE_NAME,
	540	.id_table = device_table,
	541	.probe = sd_probe,
	542	.disconnect = gspca_disconnect,
6a709749 JFM	543	#ifdef CONFIG_PM
	544	.suspend = gspca_suspend,
	545	.resume = gspca_resume,
	546	#endif
e2997a72 HG	547	};
	548
	549	/* -- module insert / remove -- */
	550	static int __init sd_mod_init(void)
	551	{
f69e9529 AK	552	int ret;
	553	ret = usb_register(&sd_driver);
	554	if (ret < 0)
e6b14849	555	return ret;
903e10aa	556	PDEBUG(D_PROBE, "registered");
e2997a72 HG	557	return 0;
	558	}
	559	static void __exit sd_mod_exit(void)
	560	{
	561	usb_deregister(&sd_driver);
	562	PDEBUG(D_PROBE, "deregistered");
	563	}
	564
	565	module_init(sd_mod_init);
	566	module_exit(sd_mod_exit);