[mirror_ubuntu-bionic-kernel.git] / drivers / media / video / gspca / stk014.c

/*
 * Syntek DV4000 (STK014) subdriver
 *
 * Copyright (C) 2008 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
 * 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 "stk014"

#include "gspca.h"
#include "jpeg.h"

MODULE_AUTHOR("Jean-Francois Moine <http://moinejf.free.fr>");
MODULE_DESCRIPTION("Syntek DV4000 (STK014) USB Camera Driver");
MODULE_LICENSE("GPL");

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

	unsigned char brightness;
	unsigned char contrast;
	unsigned char colors;
	unsigned char lightfreq;
};

/* global parameters */
static int sd_quant = 7;		/* <= 4 KO - 7: good (enough!) */

/* 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_setcontrast(struct gspca_dev *gspca_dev, __s32 val);
static int sd_getcontrast(struct gspca_dev *gspca_dev, __s32 *val);
static int sd_setcolors(struct gspca_dev *gspca_dev, __s32 val);
static int sd_getcolors(struct gspca_dev *gspca_dev, __s32 *val);
static int sd_setfreq(struct gspca_dev *gspca_dev, __s32 val);
static int sd_getfreq(struct gspca_dev *gspca_dev, __s32 *val);

static struct ctrl sd_ctrls[] = {
	{
	    {
		.id      = V4L2_CID_BRIGHTNESS,
		.type    = V4L2_CTRL_TYPE_INTEGER,
		.name    = "Brightness",
		.minimum = 0,
		.maximum = 255,
		.step    = 1,
#define BRIGHTNESS_DEF 127
		.default_value = BRIGHTNESS_DEF,
	    },
	    .set = sd_setbrightness,
	    .get = sd_getbrightness,
	},
	{
	    {
		.id      = V4L2_CID_CONTRAST,
		.type    = V4L2_CTRL_TYPE_INTEGER,
		.name    = "Contrast",
		.minimum = 0,
		.maximum = 255,
		.step    = 1,
#define CONTRAST_DEF 127
		.default_value = CONTRAST_DEF,
	    },
	    .set = sd_setcontrast,
	    .get = sd_getcontrast,
	},
	{
	    {
		.id      = V4L2_CID_SATURATION,
		.type    = V4L2_CTRL_TYPE_INTEGER,
		.name    = "Color",
		.minimum = 0,
		.maximum = 255,
		.step    = 1,
#define COLOR_DEF 127
		.default_value = COLOR_DEF,
	    },
	    .set = sd_setcolors,
	    .get = sd_getcolors,
	},
	{
	    {
		.id	 = V4L2_CID_POWER_LINE_FREQUENCY,
		.type    = V4L2_CTRL_TYPE_MENU,
		.name    = "Light frequency filter",
		.minimum = 1,
		.maximum = 2,	/* 0: 0, 1: 50Hz, 2:60Hz */
		.step    = 1,
#define FREQ_DEF 1
		.default_value = FREQ_DEF,
	    },
	    .set = sd_setfreq,
	    .get = sd_getfreq,
	},
};

static const struct v4l2_pix_format vga_mode[] = {
	{320, 240, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
		.bytesperline = 320,
		.sizeimage = 320 * 240 * 3 / 8 + 590,
		.colorspace = V4L2_COLORSPACE_JPEG,
		.priv = 1},
	{640, 480, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
		.bytesperline = 640,
		.sizeimage = 640 * 480 * 3 / 8 + 590,
		.colorspace = V4L2_COLORSPACE_JPEG,
		.priv = 0},
};

/* -- read a register -- */
static int reg_r(struct gspca_dev *gspca_dev,
			__u16 index)
{
	struct usb_device *dev = gspca_dev->dev;
	int ret;

	ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
			0x00,
			USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
			0x00,
			index,
			gspca_dev->usb_buf, 1,
			500);
	if (ret < 0) {
		PDEBUG(D_ERR, "reg_r err %d", ret);
		return ret;
	}
	return gspca_dev->usb_buf[0];
}

/* -- write a register -- */
static int reg_w(struct gspca_dev *gspca_dev,
			__u16 index, __u16 value)
{
	struct usb_device *dev = gspca_dev->dev;
	int ret;

	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
			0x01,
			USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
			value,
			index,
			NULL,
			0,
			500);
	if (ret < 0)
		PDEBUG(D_ERR, "reg_w err %d", ret);
	return ret;
}

/* -- get a bulk value (4 bytes) -- */
static int rcv_val(struct gspca_dev *gspca_dev,
			int ads)
{
	struct usb_device *dev = gspca_dev->dev;
	int alen, ret;

	reg_w(gspca_dev, 0x634, (ads >> 16) & 0xff);
	reg_w(gspca_dev, 0x635, (ads >> 8) & 0xff);
	reg_w(gspca_dev, 0x636, ads & 0xff);
	reg_w(gspca_dev, 0x637, 0);
	reg_w(gspca_dev, 0x638, 4);	/* len & 0xff */
	reg_w(gspca_dev, 0x639, 0);	/* len >> 8 */
	reg_w(gspca_dev, 0x63a, 0);
	reg_w(gspca_dev, 0x63b, 0);
	reg_w(gspca_dev, 0x630, 5);
	ret = usb_bulk_msg(dev,
			usb_rcvbulkpipe(dev, 0x05),
			gspca_dev->usb_buf,
			4,		/* length */
			&alen,
			500);		/* timeout in milliseconds */
	return ret;
}

/* -- send a bulk value -- */
static int snd_val(struct gspca_dev *gspca_dev,
			int ads,
			unsigned int val)
{
	struct usb_device *dev = gspca_dev->dev;
	int alen, ret;
	__u8 seq = 0;

	if (ads == 0x003f08) {
		ret = reg_r(gspca_dev, 0x0704);
		if (ret < 0)
			goto ko;
		ret = reg_r(gspca_dev, 0x0705);
		if (ret < 0)
			goto ko;
		seq = ret;		/* keep the sequence number */
		ret = reg_r(gspca_dev, 0x0650);
		if (ret < 0)
			goto ko;
		reg_w(gspca_dev, 0x654, seq);
	} else {
		reg_w(gspca_dev, 0x654, (ads >> 16) & 0xff);
	}
	reg_w(gspca_dev, 0x655, (ads >> 8) & 0xff);
	reg_w(gspca_dev, 0x656, ads & 0xff);
	reg_w(gspca_dev, 0x657, 0);
	reg_w(gspca_dev, 0x658, 0x04);	/* size */
	reg_w(gspca_dev, 0x659, 0);
	reg_w(gspca_dev, 0x65a, 0);
	reg_w(gspca_dev, 0x65b, 0);
	reg_w(gspca_dev, 0x650, 5);
	gspca_dev->usb_buf[0] = val >> 24;
	gspca_dev->usb_buf[1] = val >> 16;
	gspca_dev->usb_buf[2] = val >> 8;
	gspca_dev->usb_buf[3] = val;
	ret = usb_bulk_msg(dev,
			usb_sndbulkpipe(dev, 6),
			gspca_dev->usb_buf,
			4,
			&alen,
			500);	/* timeout in milliseconds */
	if (ret < 0)
		goto ko;
	if (ads == 0x003f08) {
		seq += 4;
		seq &= 0x3f;
		reg_w(gspca_dev, 0x705, seq);
	}
	return ret;
ko:
	PDEBUG(D_ERR, "snd_val err %d", ret);
	return ret;
}

/* set a camera parameter */
static int set_par(struct gspca_dev *gspca_dev,
		   int parval)
{
	return snd_val(gspca_dev, 0x003f08, parval);
}

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

	parval = 0x06000000		/* whiteness */
		+ (sd->brightness << 16);
	set_par(gspca_dev, parval);
}

static void setcontrast(struct gspca_dev *gspca_dev)
{
	struct sd *sd = (struct sd *) gspca_dev;
	int parval;

	parval = 0x07000000		/* contrast */
		+ (sd->contrast << 16);
	set_par(gspca_dev, parval);
}

static void setcolors(struct gspca_dev *gspca_dev)
{
	struct sd *sd = (struct sd *) gspca_dev;
	int parval;

	parval = 0x08000000		/* saturation */
		+ (sd->colors << 16);
	set_par(gspca_dev, parval);
}

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

	set_par(gspca_dev, sd->lightfreq == 1
			? 0x33640000		/* 50 Hz */
			: 0x33780000);		/* 60 Hz */
}

/* 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;

	gspca_dev->cam.cam_mode = vga_mode;
	gspca_dev->cam.nmodes = ARRAY_SIZE(vga_mode);
	sd->brightness = BRIGHTNESS_DEF;
	sd->contrast = CONTRAST_DEF;
	sd->colors = COLOR_DEF;
	sd->lightfreq = FREQ_DEF;
	return 0;
}

/* this function is called at probe and resume time */
static int sd_init(struct gspca_dev *gspca_dev)
{
	int ret;

	/* check if the device responds */
	usb_set_interface(gspca_dev->dev, gspca_dev->iface, 1);
	ret = reg_r(gspca_dev, 0x0740);
	if (ret < 0)
		return ret;
	if (ret != 0xff) {
		PDEBUG(D_ERR|D_STREAM, "init reg: 0x%02x", ret);
		return -1;
	}
	return 0;
}

/* -- start the camera -- */
static int sd_start(struct gspca_dev *gspca_dev)
{
	int ret, value;

	/* work on alternate 1 */
	usb_set_interface(gspca_dev->dev, gspca_dev->iface, 1);

	set_par(gspca_dev, 0x10000000);
	set_par(gspca_dev, 0x00000000);
	set_par(gspca_dev, 0x8002e001);
	set_par(gspca_dev, 0x14000000);
	if (gspca_dev->width > 320)
		value = 0x8002e001;		/* 640x480 */
	else
		value = 0x4001f000;		/* 320x240 */
	set_par(gspca_dev, value);
	ret = usb_set_interface(gspca_dev->dev,
					gspca_dev->iface,
					gspca_dev->alt);
	if (ret < 0) {
		PDEBUG(D_ERR|D_STREAM, "set intf %d %d failed",
			gspca_dev->iface, gspca_dev->alt);
		goto out;
	}
	ret = reg_r(gspca_dev, 0x0630);
	if (ret < 0)
		goto out;
	rcv_val(gspca_dev, 0x000020);	/* << (value ff ff ff ff) */
	ret = reg_r(gspca_dev, 0x0650);
	if (ret < 0)
		goto out;
	snd_val(gspca_dev, 0x000020, 0xffffffff);
	reg_w(gspca_dev, 0x0620, 0);
	reg_w(gspca_dev, 0x0630, 0);
	reg_w(gspca_dev, 0x0640, 0);
	reg_w(gspca_dev, 0x0650, 0);
	reg_w(gspca_dev, 0x0660, 0);
	setbrightness(gspca_dev);		/* whiteness */
	setcontrast(gspca_dev);			/* contrast */
	setcolors(gspca_dev);			/* saturation */
	set_par(gspca_dev, 0x09800000);		/* Red ? */
	set_par(gspca_dev, 0x0a800000);		/* Green ? */
	set_par(gspca_dev, 0x0b800000);		/* Blue ? */
	set_par(gspca_dev, 0x0d030000);		/* Gamma ? */
	setfreq(gspca_dev);			/* light frequency */

	/* start the video flow */
	set_par(gspca_dev, 0x01000000);
	set_par(gspca_dev, 0x01000000);
	PDEBUG(D_STREAM, "camera started alt: 0x%02x", gspca_dev->alt);
	return 0;
out:
	PDEBUG(D_ERR|D_STREAM, "camera start err %d", ret);
	return ret;
}

static void sd_stopN(struct gspca_dev *gspca_dev)
{
	struct usb_device *dev = gspca_dev->dev;

	set_par(gspca_dev, 0x02000000);
	set_par(gspca_dev, 0x02000000);
	usb_set_interface(dev, gspca_dev->iface, 1);
	reg_r(gspca_dev, 0x0630);
	rcv_val(gspca_dev, 0x000020);	/* << (value ff ff ff ff) */
	reg_r(gspca_dev, 0x0650);
	snd_val(gspca_dev, 0x000020, 0xffffffff);
	reg_w(gspca_dev, 0x0620, 0);
	reg_w(gspca_dev, 0x0630, 0);
	reg_w(gspca_dev, 0x0640, 0);
	reg_w(gspca_dev, 0x0650, 0);
	reg_w(gspca_dev, 0x0660, 0);
	PDEBUG(D_STREAM, "camera stopped");
}

static void sd_pkt_scan(struct gspca_dev *gspca_dev,
			struct gspca_frame *frame,	/* target */
			__u8 *data,			/* isoc packet */
			int len)			/* iso packet length */
{
	static unsigned char ffd9[] = {0xff, 0xd9};

	/* a frame starts with:
	 *	- 0xff 0xfe
	 *	- 0x08 0x00	- length (little endian ?!)
	 *	- 4 bytes = size of whole frame (BE - including header)
	 *	- 0x00 0x0c
	 *	- 0xff 0xd8
	 *	- ..	JPEG image with escape sequences (ff 00)
	 *		(without ending - ff d9)
	 */
	if (data[0] == 0xff && data[1] == 0xfe) {
		frame = gspca_frame_add(gspca_dev, LAST_PACKET, frame,
					ffd9, 2);

		/* put the JPEG 411 header */
		jpeg_put_header(gspca_dev, frame, sd_quant, 0x22);

		/* beginning of the frame */
#define STKHDRSZ 12
		data += STKHDRSZ;
		len -= STKHDRSZ;
	}
	gspca_frame_add(gspca_dev, INTER_PACKET, frame, data, len);
}

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_setcontrast(struct gspca_dev *gspca_dev, __s32 val)
{
	struct sd *sd = (struct sd *) gspca_dev;

	sd->contrast = val;
	if (gspca_dev->streaming)
		setcontrast(gspca_dev);
	return 0;
}

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

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

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

	sd->colors = val;
	if (gspca_dev->streaming)
		setcolors(gspca_dev);
	return 0;
}

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

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

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

	sd->lightfreq = val;
	if (gspca_dev->streaming)
		setfreq(gspca_dev);
	return 0;
}

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

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

static int sd_querymenu(struct gspca_dev *gspca_dev,
			struct v4l2_querymenu *menu)
{
	switch (menu->id) {
	case V4L2_CID_POWER_LINE_FREQUENCY:
		switch (menu->index) {
		case 1:		/* V4L2_CID_POWER_LINE_FREQUENCY_50HZ */
			strcpy((char *) menu->name, "50 Hz");
			return 0;
		case 2:		/* V4L2_CID_POWER_LINE_FREQUENCY_60HZ */
			strcpy((char *) menu->name, "60 Hz");
			return 0;
		}
		break;
	}
	return -EINVAL;
}

/* 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,
	.pkt_scan = sd_pkt_scan,
	.querymenu = sd_querymenu,
};

/* -- module initialisation -- */
static const __devinitdata struct usb_device_id device_table[] = {
	{USB_DEVICE(0x05e1, 0x0893)},
	{}
};
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 -1;
	info("registered");
	return 0;
}
static void __exit sd_mod_exit(void)
{
	usb_deregister(&sd_driver);
	info("deregistered");
}

module_init(sd_mod_init);
module_exit(sd_mod_exit);

module_param_named(quant, sd_quant, int, 0644);
MODULE_PARM_DESC(quant, "Quantization index (0..8)");
Commit	Line	Data
63eb9546 JFM	1	/*
	2	* Syntek DV4000 (STK014) subdriver
	3	*
d43fa32f	4	* Copyright (C) 2008 Jean-Francois Moine (http://moinejf.free.fr)
63eb9546 JFM	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
63eb9546 JFM	19	*/
	20
	21	#define MODULE_NAME "stk014"
	22
	23	#include "gspca.h"
	24	#include "jpeg.h"
	25
63eb9546 JFM	26	MODULE_AUTHOR("Jean-Francois Moine <http://moinejf.free.fr>");
	27	MODULE_DESCRIPTION("Syntek DV4000 (STK014) USB Camera Driver");
	28	MODULE_LICENSE("GPL");
	29
	30	/* specific webcam descriptor */
	31	struct sd {
	32	struct gspca_dev gspca_dev; /* !! must be the first item */
	33
	34	unsigned char brightness;
	35	unsigned char contrast;
	36	unsigned char colors;
6a7eba24	37	unsigned char lightfreq;
63eb9546 JFM	38	};
	39
	40	/* global parameters */
63eb9546 JFM	41	static int sd_quant = 7; /* <= 4 KO - 7: good (enough!) */
	42
	43	/* V4L2 controls supported by the driver */
	44	static int sd_setbrightness(struct gspca_dev *gspca_dev, __s32 val);
	45	static int sd_getbrightness(struct gspca_dev gspca_dev, __s32 val);
	46	static int sd_setcontrast(struct gspca_dev *gspca_dev, __s32 val);
	47	static int sd_getcontrast(struct gspca_dev gspca_dev, __s32 val);
	48	static int sd_setcolors(struct gspca_dev *gspca_dev, __s32 val);
	49	static int sd_getcolors(struct gspca_dev gspca_dev, __s32 val);
6a7eba24 JFM	50	static int sd_setfreq(struct gspca_dev *gspca_dev, __s32 val);
6a7eba24 JFM	51	static int sd_getfreq(struct gspca_dev gspca_dev, __s32 val);
63eb9546 JFM	52
63eb9546 JFM	53	static struct ctrl sd_ctrls[] = {
63eb9546 JFM	54	{
	55	{
	56	.id = V4L2_CID_BRIGHTNESS,
	57	.type = V4L2_CTRL_TYPE_INTEGER,
	58	.name = "Brightness",
	59	.minimum = 0,
	60	.maximum = 255,
	61	.step = 1,
a5ae2062 JFM	62	#define BRIGHTNESS_DEF 127
a5ae2062 JFM	63	.default_value = BRIGHTNESS_DEF,
63eb9546 JFM	64	},
	65	.set = sd_setbrightness,
	66	.get = sd_getbrightness,
	67	},
63eb9546 JFM	68	{
	69	{
	70	.id = V4L2_CID_CONTRAST,
	71	.type = V4L2_CTRL_TYPE_INTEGER,
	72	.name = "Contrast",
	73	.minimum = 0,
	74	.maximum = 255,
	75	.step = 1,
a5ae2062 JFM	76	#define CONTRAST_DEF 127
a5ae2062 JFM	77	.default_value = CONTRAST_DEF,
63eb9546 JFM	78	},
	79	.set = sd_setcontrast,
	80	.get = sd_getcontrast,
	81	},
63eb9546 JFM	82	{
	83	{
	84	.id = V4L2_CID_SATURATION,
	85	.type = V4L2_CTRL_TYPE_INTEGER,
a5ae2062	86	.name = "Color",
63eb9546 JFM	87	.minimum = 0,
	88	.maximum = 255,
	89	.step = 1,
a5ae2062 JFM	90	#define COLOR_DEF 127
a5ae2062 JFM	91	.default_value = COLOR_DEF,
63eb9546 JFM	92	},
	93	.set = sd_setcolors,
	94	.get = sd_getcolors,
	95	},
6a7eba24 JFM	96	{
	97	{
	98	.id = V4L2_CID_POWER_LINE_FREQUENCY,
	99	.type = V4L2_CTRL_TYPE_MENU,
	100	.name = "Light frequency filter",
	101	.minimum = 1,
	102	.maximum = 2, /* 0: 0, 1: 50Hz, 2:60Hz */
	103	.step = 1,
a5ae2062 JFM	104	#define FREQ_DEF 1
a5ae2062 JFM	105	.default_value = FREQ_DEF,
6a7eba24 JFM	106	},
	107	.set = sd_setfreq,
	108	.get = sd_getfreq,
	109	},
63eb9546 JFM	110	};
63eb9546 JFM	111
cc611b8a	112	static const struct v4l2_pix_format vga_mode[] = {
c2446b3e JFM	113	{320, 240, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
	114	.bytesperline = 320,
	115	.sizeimage = 320 * 240 * 3 / 8 + 590,
	116	.colorspace = V4L2_COLORSPACE_JPEG,
	117	.priv = 1},
	118	{640, 480, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
	119	.bytesperline = 640,
	120	.sizeimage = 640 * 480 * 3 / 8 + 590,
	121	.colorspace = V4L2_COLORSPACE_JPEG,
	122	.priv = 0},
63eb9546 JFM	123	};
	124
	125	/* -- read a register -- */
6a7eba24	126	static int reg_r(struct gspca_dev *gspca_dev,
739570bb	127	__u16 index)
63eb9546	128	{
63eb9546	129	struct usb_device *dev = gspca_dev->dev;
6a7eba24	130	int ret;
63eb9546 JFM	131
	132	ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
	133	0x00,
	134	USB_DIR_IN \| USB_TYPE_VENDOR \| USB_RECIP_DEVICE,
	135	0x00,
	136	index,
739570bb	137	gspca_dev->usb_buf, 1,
63eb9546	138	500);
739570bb	139	if (ret < 0) {
6a7eba24	140	PDEBUG(D_ERR, "reg_r err %d", ret);
739570bb JFM	141	return ret;
	142	}
	143	return gspca_dev->usb_buf[0];
63eb9546 JFM	144	}
	145
	146	/* -- write a register -- */
6a7eba24	147	static int reg_w(struct gspca_dev *gspca_dev,
63eb9546 JFM	148	__u16 index, __u16 value)
	149	{
	150	struct usb_device *dev = gspca_dev->dev;
	151	int ret;
	152
	153	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
	154	0x01,
	155	USB_DIR_OUT \| USB_TYPE_VENDOR \| USB_RECIP_DEVICE,
	156	value,
	157	index,
	158	NULL,
	159	0,
	160	500);
	161	if (ret < 0)
6a7eba24	162	PDEBUG(D_ERR, "reg_w err %d", ret);
63eb9546 JFM	163	return ret;
	164	}
	165
739570bb	166	/* -- get a bulk value (4 bytes) -- */
63eb9546	167	static int rcv_val(struct gspca_dev *gspca_dev,
739570bb	168	int ads)
63eb9546 JFM	169	{
	170	struct usb_device *dev = gspca_dev->dev;
	171	int alen, ret;
63eb9546	172
6a7eba24 JFM	173	reg_w(gspca_dev, 0x634, (ads >> 16) & 0xff);
	174	reg_w(gspca_dev, 0x635, (ads >> 8) & 0xff);
	175	reg_w(gspca_dev, 0x636, ads & 0xff);
	176	reg_w(gspca_dev, 0x637, 0);
739570bb JFM	177	reg_w(gspca_dev, 0x638, 4); /* len & 0xff */
739570bb JFM	178	reg_w(gspca_dev, 0x639, 0); /* len >> 8 */
6a7eba24 JFM	179	reg_w(gspca_dev, 0x63a, 0);
	180	reg_w(gspca_dev, 0x63b, 0);
	181	reg_w(gspca_dev, 0x630, 5);
63eb9546	182	ret = usb_bulk_msg(dev,
50e06dee	183	usb_rcvbulkpipe(dev, 0x05),
739570bb JFM	184	gspca_dev->usb_buf,
739570bb JFM	185	4, /* length */
63eb9546	186	&alen,
739570bb	187	500); /* timeout in milliseconds */
63eb9546 JFM	188	return ret;
	189	}
	190
739570bb	191	/* -- send a bulk value -- */
63eb9546 JFM	192	static int snd_val(struct gspca_dev *gspca_dev,
	193	int ads,
	194	unsigned int val)
	195	{
	196	struct usb_device *dev = gspca_dev->dev;
	197	int alen, ret;
739570bb	198	__u8 seq = 0;
63eb9546 JFM	199
63eb9546 JFM	200	if (ads == 0x003f08) {
739570bb	201	ret = reg_r(gspca_dev, 0x0704);
63eb9546 JFM	202	if (ret < 0)
63eb9546 JFM	203	goto ko;
739570bb	204	ret = reg_r(gspca_dev, 0x0705);
63eb9546 JFM	205	if (ret < 0)
63eb9546 JFM	206	goto ko;
739570bb JFM	207	seq = ret; /* keep the sequence number */
739570bb JFM	208	ret = reg_r(gspca_dev, 0x0650);
63eb9546 JFM	209	if (ret < 0)
63eb9546 JFM	210	goto ko;
6a7eba24	211	reg_w(gspca_dev, 0x654, seq);
739570bb	212	} else {
6a7eba24	213	reg_w(gspca_dev, 0x654, (ads >> 16) & 0xff);
739570bb	214	}
6a7eba24 JFM	215	reg_w(gspca_dev, 0x655, (ads >> 8) & 0xff);
	216	reg_w(gspca_dev, 0x656, ads & 0xff);
	217	reg_w(gspca_dev, 0x657, 0);
	218	reg_w(gspca_dev, 0x658, 0x04); /* size */
	219	reg_w(gspca_dev, 0x659, 0);
	220	reg_w(gspca_dev, 0x65a, 0);
	221	reg_w(gspca_dev, 0x65b, 0);
	222	reg_w(gspca_dev, 0x650, 5);
739570bb JFM	223	gspca_dev->usb_buf[0] = val >> 24;
	224	gspca_dev->usb_buf[1] = val >> 16;
	225	gspca_dev->usb_buf[2] = val >> 8;
	226	gspca_dev->usb_buf[3] = val;
63eb9546 JFM	227	ret = usb_bulk_msg(dev,
63eb9546 JFM	228	usb_sndbulkpipe(dev, 6),
739570bb	229	gspca_dev->usb_buf,
63eb9546 JFM	230	4,
	231	&alen,
	232	500); /* timeout in milliseconds */
	233	if (ret < 0)
	234	goto ko;
	235	if (ads == 0x003f08) {
	236	seq += 4;
	237	seq &= 0x3f;
6a7eba24	238	reg_w(gspca_dev, 0x705, seq);
63eb9546 JFM	239	}
	240	return ret;
	241	ko:
	242	PDEBUG(D_ERR, "snd_val err %d", ret);
	243	return ret;
	244	}
	245
	246	/* set a camera parameter */
	247	static int set_par(struct gspca_dev *gspca_dev,
	248	int parval)
	249	{
	250	return snd_val(gspca_dev, 0x003f08, parval);
	251	}
	252
	253	static void setbrightness(struct gspca_dev *gspca_dev)
	254	{
	255	struct sd sd = (struct sd ) gspca_dev;
	256	int parval;
	257
63eb9546 JFM	258	parval = 0x06000000 /* whiteness */
	259	+ (sd->brightness << 16);
	260	set_par(gspca_dev, parval);
	261	}
	262
	263	static void setcontrast(struct gspca_dev *gspca_dev)
	264	{
	265	struct sd sd = (struct sd ) gspca_dev;
	266	int parval;
	267
63eb9546 JFM	268	parval = 0x07000000 /* contrast */
	269	+ (sd->contrast << 16);
	270	set_par(gspca_dev, parval);
	271	}
	272
	273	static void setcolors(struct gspca_dev *gspca_dev)
	274	{
	275	struct sd sd = (struct sd ) gspca_dev;
	276	int parval;
	277
63eb9546 JFM	278	parval = 0x08000000 /* saturation */
	279	+ (sd->colors << 16);
	280	set_par(gspca_dev, parval);
	281	}
	282
6a7eba24 JFM	283	static void setfreq(struct gspca_dev *gspca_dev)
	284	{
	285	struct sd sd = (struct sd ) gspca_dev;
	286
	287	set_par(gspca_dev, sd->lightfreq == 1
	288	? 0x33640000 /* 50 Hz */
	289	: 0x33780000); /* 60 Hz */
	290	}
	291
63eb9546 JFM	292	/* this function is called at probe time */
	293	static int sd_config(struct gspca_dev *gspca_dev,
	294	const struct usb_device_id *id)
	295	{
	296	struct sd sd = (struct sd ) gspca_dev;
63eb9546	297
63eb9546	298	gspca_dev->cam.cam_mode = vga_mode;
739570bb	299	gspca_dev->cam.nmodes = ARRAY_SIZE(vga_mode);
a5ae2062 JFM	300	sd->brightness = BRIGHTNESS_DEF;
	301	sd->contrast = CONTRAST_DEF;
	302	sd->colors = COLOR_DEF;
	303	sd->lightfreq = FREQ_DEF;
63eb9546 JFM	304	return 0;
	305	}
	306
012d6b02 JFM	307	/* this function is called at probe and resume time */
012d6b02 JFM	308	static int sd_init(struct gspca_dev *gspca_dev)
63eb9546	309	{
63eb9546 JFM	310	int ret;
	311
	312	/* check if the device responds */
	313	usb_set_interface(gspca_dev->dev, gspca_dev->iface, 1);
739570bb	314	ret = reg_r(gspca_dev, 0x0740);
63eb9546 JFM	315	if (ret < 0)
63eb9546 JFM	316	return ret;
739570bb JFM	317	if (ret != 0xff) {
739570bb JFM	318	PDEBUG(D_ERR\|D_STREAM, "init reg: 0x%02x", ret);
63eb9546 JFM	319	return -1;
	320	}
	321	return 0;
	322	}
	323
	324	/* -- start the camera -- */
72ab97ce	325	static int sd_start(struct gspca_dev *gspca_dev)
63eb9546	326	{
63eb9546 JFM	327	int ret, value;
	328
	329	/* work on alternate 1 */
	330	usb_set_interface(gspca_dev->dev, gspca_dev->iface, 1);
	331
	332	set_par(gspca_dev, 0x10000000);
	333	set_par(gspca_dev, 0x00000000);
	334	set_par(gspca_dev, 0x8002e001);
	335	set_par(gspca_dev, 0x14000000);
	336	if (gspca_dev->width > 320)
	337	value = 0x8002e001; /* 640x480 */
	338	else
	339	value = 0x4001f000; /* 320x240 */
	340	set_par(gspca_dev, value);
	341	ret = usb_set_interface(gspca_dev->dev,
	342	gspca_dev->iface,
	343	gspca_dev->alt);
6a7eba24 JFM	344	if (ret < 0) {
	345	PDEBUG(D_ERR\|D_STREAM, "set intf %d %d failed",
	346	gspca_dev->iface, gspca_dev->alt);
63eb9546	347	goto out;
6a7eba24	348	}
739570bb	349	ret = reg_r(gspca_dev, 0x0630);
63eb9546 JFM	350	if (ret < 0)
63eb9546 JFM	351	goto out;
739570bb JFM	352	rcv_val(gspca_dev, 0x000020); /* << (value ff ff ff ff) */
739570bb JFM	353	ret = reg_r(gspca_dev, 0x0650);
63eb9546 JFM	354	if (ret < 0)
	355	goto out;
	356	snd_val(gspca_dev, 0x000020, 0xffffffff);
6a7eba24 JFM	357	reg_w(gspca_dev, 0x0620, 0);
	358	reg_w(gspca_dev, 0x0630, 0);
	359	reg_w(gspca_dev, 0x0640, 0);
	360	reg_w(gspca_dev, 0x0650, 0);
	361	reg_w(gspca_dev, 0x0660, 0);
63eb9546 JFM	362	setbrightness(gspca_dev); /* whiteness */
	363	setcontrast(gspca_dev); /* contrast */
	364	setcolors(gspca_dev); /* saturation */
	365	set_par(gspca_dev, 0x09800000); /* Red ? */
	366	set_par(gspca_dev, 0x0a800000); /* Green ? */
	367	set_par(gspca_dev, 0x0b800000); /* Blue ? */
	368	set_par(gspca_dev, 0x0d030000); /* Gamma ? */
6a7eba24	369	setfreq(gspca_dev); /* light frequency */
63eb9546 JFM	370
	371	/* start the video flow */
	372	set_par(gspca_dev, 0x01000000);
	373	set_par(gspca_dev, 0x01000000);
	374	PDEBUG(D_STREAM, "camera started alt: 0x%02x", gspca_dev->alt);
72ab97ce	375	return 0;
63eb9546 JFM	376	out:
63eb9546 JFM	377	PDEBUG(D_ERR\|D_STREAM, "camera start err %d", ret);
72ab97ce	378	return ret;
63eb9546 JFM	379	}
	380
	381	static void sd_stopN(struct gspca_dev *gspca_dev)
	382	{
	383	struct usb_device *dev = gspca_dev->dev;
63eb9546 JFM	384
	385	set_par(gspca_dev, 0x02000000);
	386	set_par(gspca_dev, 0x02000000);
	387	usb_set_interface(dev, gspca_dev->iface, 1);
739570bb JFM	388	reg_r(gspca_dev, 0x0630);
	389	rcv_val(gspca_dev, 0x000020); /* << (value ff ff ff ff) */
	390	reg_r(gspca_dev, 0x0650);
63eb9546	391	snd_val(gspca_dev, 0x000020, 0xffffffff);
6a7eba24 JFM	392	reg_w(gspca_dev, 0x0620, 0);
	393	reg_w(gspca_dev, 0x0630, 0);
	394	reg_w(gspca_dev, 0x0640, 0);
	395	reg_w(gspca_dev, 0x0650, 0);
	396	reg_w(gspca_dev, 0x0660, 0);
63eb9546 JFM	397	PDEBUG(D_STREAM, "camera stopped");
	398	}
	399
63eb9546 JFM	400	static void sd_pkt_scan(struct gspca_dev *gspca_dev,
63eb9546 JFM	401	struct gspca_frame frame, / target */
a5ae2062	402	__u8 data, / isoc packet */
63eb9546 JFM	403	int len) /* iso packet length */
63eb9546 JFM	404	{
4aa0d037	405	static unsigned char ffd9[] = {0xff, 0xd9};
63eb9546 JFM	406
	407	/* a frame starts with:
	408	* - 0xff 0xfe
d43fa32f JFM	409	* - 0x08 0x00 - length (little endian ?!)
d43fa32f JFM	410	* - 4 bytes = size of whole frame (BE - including header)
63eb9546 JFM	411	* - 0x00 0x0c
	412	* - 0xff 0xd8
	413	* - .. JPEG image with escape sequences (ff 00)
d43fa32f	414	* (without ending - ff d9)
63eb9546 JFM	415	*/
63eb9546 JFM	416	if (data[0] == 0xff && data[1] == 0xfe) {
d43fa32f JFM	417	frame = gspca_frame_add(gspca_dev, LAST_PACKET, frame,
d43fa32f JFM	418	ffd9, 2);
63eb9546	419
d43fa32f	420	/* put the JPEG 411 header */
63eb9546 JFM	421	jpeg_put_header(gspca_dev, frame, sd_quant, 0x22);
	422
	423	/* beginning of the frame */
	424	#define STKHDRSZ 12
8843765e JFM	425	data += STKHDRSZ;
8843765e JFM	426	len -= STKHDRSZ;
63eb9546	427	}
63eb9546	428	gspca_frame_add(gspca_dev, INTER_PACKET, frame, data, len);
63eb9546 JFM	429	}
	430
	431	static int sd_setbrightness(struct gspca_dev *gspca_dev, __s32 val)
	432	{
	433	struct sd sd = (struct sd ) gspca_dev;
	434
	435	sd->brightness = val;
	436	if (gspca_dev->streaming)
	437	setbrightness(gspca_dev);
	438	return 0;
	439	}
	440
	441	static int sd_getbrightness(struct gspca_dev gspca_dev, __s32 val)
	442	{
	443	struct sd sd = (struct sd ) gspca_dev;
	444
	445	*val = sd->brightness;
	446	return 0;
	447	}
	448
	449	static int sd_setcontrast(struct gspca_dev *gspca_dev, __s32 val)
	450	{
	451	struct sd sd = (struct sd ) gspca_dev;
	452
	453	sd->contrast = val;
	454	if (gspca_dev->streaming)
	455	setcontrast(gspca_dev);
	456	return 0;
	457	}
	458
	459	static int sd_getcontrast(struct gspca_dev gspca_dev, __s32 val)
	460	{
	461	struct sd sd = (struct sd ) gspca_dev;
	462
	463	*val = sd->contrast;
	464	return 0;
	465	}
	466
	467	static int sd_setcolors(struct gspca_dev *gspca_dev, __s32 val)
	468	{
	469	struct sd sd = (struct sd ) gspca_dev;
	470
	471	sd->colors = val;
	472	if (gspca_dev->streaming)
	473	setcolors(gspca_dev);
	474	return 0;
	475	}
	476
	477	static int sd_getcolors(struct gspca_dev gspca_dev, __s32 val)
	478	{
	479	struct sd sd = (struct sd ) gspca_dev;
	480
	481	*val = sd->colors;
	482	return 0;
	483	}
	484
6a7eba24 JFM	485	static int sd_setfreq(struct gspca_dev *gspca_dev, __s32 val)
	486	{
	487	struct sd sd = (struct sd ) gspca_dev;
	488
	489	sd->lightfreq = val;
	490	if (gspca_dev->streaming)
	491	setfreq(gspca_dev);
	492	return 0;
	493	}
	494
	495	static int sd_getfreq(struct gspca_dev gspca_dev, __s32 val)
	496	{
	497	struct sd sd = (struct sd ) gspca_dev;
	498
	499	*val = sd->lightfreq;
	500	return 0;
	501	}
	502
	503	static int sd_querymenu(struct gspca_dev *gspca_dev,
	504	struct v4l2_querymenu *menu)
	505	{
	506	switch (menu->id) {
	507	case V4L2_CID_POWER_LINE_FREQUENCY:
	508	switch (menu->index) {
	509	case 1: /* V4L2_CID_POWER_LINE_FREQUENCY_50HZ */
a5ae2062	510	strcpy((char *) menu->name, "50 Hz");
6a7eba24 JFM	511	return 0;
6a7eba24 JFM	512	case 2: /* V4L2_CID_POWER_LINE_FREQUENCY_60HZ */
a5ae2062	513	strcpy((char *) menu->name, "60 Hz");
6a7eba24 JFM	514	return 0;
	515	}
	516	break;
	517	}
	518	return -EINVAL;
	519	}
	520
63eb9546	521	/* sub-driver description */
739570bb	522	static const struct sd_desc sd_desc = {
63eb9546 JFM	523	.name = MODULE_NAME,
63eb9546 JFM	524	.ctrls = sd_ctrls,
739570bb	525	.nctrls = ARRAY_SIZE(sd_ctrls),
63eb9546	526	.config = sd_config,
012d6b02	527	.init = sd_init,
63eb9546 JFM	528	.start = sd_start,
63eb9546 JFM	529	.stopN = sd_stopN,
63eb9546	530	.pkt_scan = sd_pkt_scan,
6a7eba24	531	.querymenu = sd_querymenu,
63eb9546 JFM	532	};
	533
	534	/* -- module initialisation -- */
739570bb	535	static const __devinitdata struct usb_device_id device_table[] = {
9d64fdb1	536	{USB_DEVICE(0x05e1, 0x0893)},
63eb9546 JFM	537	{}
	538	};
	539	MODULE_DEVICE_TABLE(usb, device_table);
	540
	541	/* -- device connect -- */
	542	static int sd_probe(struct usb_interface *intf,
	543	const struct usb_device_id *id)
	544	{
d43fa32f JFM	545	return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
d43fa32f JFM	546	THIS_MODULE);
63eb9546 JFM	547	}
	548
	549	static struct usb_driver sd_driver = {
	550	.name = MODULE_NAME,
	551	.id_table = device_table,
	552	.probe = sd_probe,
	553	.disconnect = gspca_disconnect,
6a709749 JFM	554	#ifdef CONFIG_PM
	555	.suspend = gspca_suspend,
	556	.resume = gspca_resume,
	557	#endif
63eb9546 JFM	558	};
	559
	560	/* -- module insert / remove -- */
	561	static int __init sd_mod_init(void)
	562	{
f69e9529 AK	563	int ret;
	564	ret = usb_register(&sd_driver);
	565	if (ret < 0)
63eb9546	566	return -1;
10b0e96e	567	info("registered");
63eb9546 JFM	568	return 0;
	569	}
	570	static void __exit sd_mod_exit(void)
	571	{
	572	usb_deregister(&sd_driver);
	573	info("deregistered");
	574	}
	575
	576	module_init(sd_mod_init);
	577	module_exit(sd_mod_exit);
	578
63eb9546 JFM	579	module_param_named(quant, sd_quant, int, 0644);
63eb9546 JFM	580	MODULE_PARM_DESC(quant, "Quantization index (0..8)");