[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	4 /* power on default: 4 */

/* An exposure value of 4 also works (3 does not) but then we need to lower
   the compression balance setting when in 352x288 mode, otherwise the usb
   bandwidth is not enough and packets get dropped resulting in corrupt
   frames. The problem with this is that when the compression balance gets
   lowered below 0x80, the pac207 starts using a different compression
   algorithm for some lines, these lines get prefixed with a 0x2dd2 prefix
   and currently we do not know how to decompress these lines, so for now
   we use a minimum exposure value of 5 */
#define PAC207_EXPOSURE_MIN		5
#define PAC207_EXPOSURE_MAX		26
#define PAC207_EXPOSURE_DEFAULT		5 /* power on default: 3 ?? */
#define PAC207_EXPOSURE_KNEE		11 /* 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		20

#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 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 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, 0xf0},
	{0x00, 0x64, 0x64, 0x64, 0x04, 0x10, 0xf0, 0x30},
	{0x00, 0x00, 0x00, 0x70, 0xa0, 0xf8, 0x00, 0x00},
	{0x00, 0x00, 0x32, 0x00, 0x96, 0x00, 0xa2, 0x02},
	{0x32, 0x00, 0x96, 0x00, 0xA2, 0x02, 0xaf, 0x00},
};

			/* 48 reg_72 Rate Control end BalSize_4a =0x36 */
static const __u8 PacReg72[] = { 0x00, 0x00, 0x36, 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->epaddr = 0x05;
	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 */
	pac207_write_reg(gspca_dev, 0x11, 0x30); /* Analog Bias */

	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, 0x0040, pac207_sensor_init[3], 8);
	pac207_write_regs(gspca_dev, 0x0042, pac207_sensor_init[4], 8);
	pac207_write_regs(gspca_dev, 0x0048, PacReg72, 4);

	/* Compression Balance */
	if (gspca_dev->width == 176)
		pac207_write_reg(gspca_dev, 0x4a, 0xff);
	else
		pac207_write_reg(gspca_dev, 0x4a, 0x88);
	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 + sd->brightness / 2, 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,
			struct gspca_frame *frame,
			__u8 *data,
			int len)
{
	struct sd *sd = (struct sd *) gspca_dev;
	unsigned char *sof;

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