Re: gspca kernel module, support for usb bridge devices with bulk endpoints like sq930

--MP_/Rmd8zHJgfRoZv0xtnE=N0yx
Content-Type: text/plain; charset=ISO-8859-1
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Fri, 07 Nov 2008 18:57:36 +0100
Gerard Klaver <[email protected]> wrote:

> Hello,

Hello Gerard,

> For some time now i am the maintainer for the sq930 kernel module
> (written by Sam Revitch).
>=20
> See http://gkall.hobby.nl/sq930x.html for more information about the
> sq930 kernel module.
	[snip]
> I expect a integration into the gspca kernel module would prevent in
> future these sort of problems because there is more support and
> knowledge within the gspca maintainers group to adapt this sort of
> changes.

Did you start the conversion of your driver to gspca?

Last week, Adam Baker and Theodore Kilgore (see Cc:) proposed a gspca
subdriver for the sq905 (see attachment). It needs some cleanup, but it
should work.

I was wondering if you could merge your code with this one.

Best regards.

--=20
Ken ar c'henta=F1 |	      ** Breizh ha Linux atav! **
Jef		|		http://moinejf.free.fr/

--MP_/Rmd8zHJgfRoZv0xtnE=N0yx
Content-Type: text/x-csrc; name=sq905.c
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename=sq905.c

/*
 * SQ905 subdriver
 *
 * Copyright (C) 2008 Adam Baker and Theodore Kilgore
 *
 * 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
 */

/*
 * History and Acknowledgments
 *
 * The original Linux driver for SQ905 based cameras was written by
 * Marcell Lengyel and furter developed by many other contributers
 * and is available from http://sourceforge.net/projects/sqcam/
 *
 * This driver takes advantage of the reverse engineering work done for
 * that driver and for libgphoto2 but shares no code with them.
 *
 * This driver has used as a base the finepix driver and other gspca
 * based drivers and may still contain code fragments taken from those
 * drivers.
 */

#define MODULE_NAME "sq905"

#include "gspca.h"

MODULE_AUTHOR("Adam Baker <[email protected]>, "
		"Theodore Kilgore <[email protected]>");
MODULE_DESCRIPTION("GSPCA/SQ905 USB Camera Driver");
MODULE_LICENSE("GPL");

/* Default timeout, in ms */
#define SQ905_TIMEOUT (HZ / 10)

/* Maximum transfer size to use. The windows driver reads by chunks of
 * 0x8000 bytes, so do the same. Note: reading more seems to work
 * too. */
#define SQ905_MAX_TRANSFER 0x8000
#define FRAME_HEADER_LEN 64

/* The known modes, or registers. These go in the "value" slot. */

/* 00 is "none" obviously */

#define SQ905_BULK_READ	0x03	/* precedes any bulk read */
#define SQ905_COMMAND	0x06	/* precedes the command codes below */
#define SQ905_PING	0x07	/* when reading an "idling" command */
#define SQ905_READ_DONE 0xc0    /* ack bulk read completed */

/* Some command codes. These go in the "index" slot. */

#define SQ905_ID      0xf0	/* asks for model string */
#define SQ905_CONFIG  0x20	/* gets photo alloc. table, not used here */
#define SQ905_DATA    0x30	/* accesses photo data, not used here */
#define SQ905_CLEAR   0xa0	/* clear everything */
#define SQ905_CAPTURE_LOW 0x60	/* Starts capture at 160x120 */
#define SQ905_CAPTURE_MED 0x61	/* Starts capture at 320x240 */
/* note that the capture command also controls the output dimensions */
/* 0x60 -> 160x120, 0x61 -> 320x240 0x62 -> 640x480 depends on camera */
/* 0x62 is not correct, at least for some cams. Should be 0x63 ? */



/* Structure to hold all of our device specific stuff */
struct sd {
	struct gspca_dev gspca_dev;	/* !! must be the first item */

	enum {
		SQ905_MODEL_DEFAULT,
		SQ905_MODEL_POCK_CAM,
		SQ905_MODEL_MAGPIX
	} cam_model;

	/*
	 * Driver stuff
	 */
	__u8 *buffer;
	struct delayed_work wqe;
	struct completion can_close;
	int streaming;
};

/* These cameras only support 320x200. Actually not true but good for a start*/
static struct v4l2_pix_format sq905_mode[1] = {
	{ 320, 240, V4L2_PIX_FMT_SBGGR8, V4L2_FIELD_NONE,
		.bytesperline = 320,
		.sizeimage = 320 * 240,
		.colorspace = V4L2_COLORSPACE_SRGB,
		.priv = 0}
};

static int sq905_command(struct usb_device *dev, __u16 index)
{
	__u8 status;
	int ret;
	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
			      USB_REQ_SYNCH_FRAME,                /* request */
			      USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
			      SQ905_COMMAND, index, "\x0", 1, 500);
	if (ret != 1) {
		PDEBUG(D_ERR, "sq905_command: usb_control_msg failed (%d)",
			ret);
		return -EIO;
	}

	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
			      USB_REQ_SYNCH_FRAME,                /* request */
			      USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
			      SQ905_PING, 0, &status, 1, 500);
	if (ret != 1) {
		PDEBUG(D_ERR, "sq905_command: usb_control_msg failed 2 (%d)",
			ret);
		return -EIO;
	}

	return 0;
}

static int sq905_ack_frame(struct usb_device *dev)
{
	int ret;
	ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
			      USB_REQ_SYNCH_FRAME,                /* request */
			      USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
			      SQ905_READ_DONE, 0, "\x0", 1, 500);
	if (ret != 1) {
		PDEBUG(D_ERR, "sq905_ack_frame: usb_ctrl_msg failed (%d)", ret);
		return -EIO;
	}

	return 0;
}

static int
sq905_read_data(struct gspca_dev *gspca_dev, __u8 *data, int size)
{
	int ret;
	int act_len;

	if (!data) {
		PDEBUG(D_ERR, "sq905_read_data: data pointer was NULL\n");
		return -EINVAL;
	}

	ret = usb_control_msg(gspca_dev->dev,
			      usb_sndctrlpipe(gspca_dev->dev, 0),
			      USB_REQ_SYNCH_FRAME,                /* request */
			      USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
			      SQ905_BULK_READ, size, "\x0", 1, 500);
	if (ret != 1) {
		PDEBUG(D_ERR, "sq905_read_data: usb_ctrl_msg failed (%d)", ret);
		return -EIO;
	}
	ret = usb_bulk_msg(gspca_dev->dev,
			   usb_rcvbulkpipe(gspca_dev->dev, 0x81),
			   data, size, &act_len, 500);
	/* successful, it returns 0, otherwise  negative */
	if ((ret != 0) || (act_len != size)) {
		PDEBUG(D_ERR, "sq905_read_data: bulk read fail (%d) len %d/%d",
			ret, act_len, size);
		return -EIO;
	}
	return 0;
}

/* This function is called as a workqueue function and runs whenever the camera
 * is streaming data. Because it is a workqueue function it is allowed to sleep
 * so we can use synchronous USB calls. There appears to be no reason to
 * terminate before we stop streaming.
 */
static void sq905_dostream(struct work_struct *work)
{
	struct sd *dev = container_of(work, struct sd, wqe.work);
	struct gspca_frame *frame;
	int bytes_left; /* bytes remaining in current frame. */
	int data_len;   /* size to use for the next read. */
	int header_read; /* true if we have already read the frame header. */
	int discarding; /* true if we failed to get space for frame. */
	int packet_type;
	__u8 *data;

	while ((dev->gspca_dev.present) && (dev->streaming)) {
		/* request some data and then read it until we have
		 * a complete frame. */
		bytes_left = sq905_mode[0].sizeimage + FRAME_HEADER_LEN;
		header_read = 0;
		discarding = 0;

		while (bytes_left > 0) {
			data_len = bytes_left > SQ905_MAX_TRANSFER  ?
				SQ905_MAX_TRANSFER : bytes_left;
			if (sq905_read_data(&dev->gspca_dev, dev->buffer,
					 data_len) == 0) {
				PDEBUG(D_STREAM,
					"Got %d bytes out of %d for frame",
					data_len, bytes_left);
				bytes_left -= data_len;
				data = dev->buffer;
				if (!header_read) {
					packet_type = FIRST_PACKET;
					/* The first 64 bytes of each frame are
					 * a header of unknown format */
					data += FRAME_HEADER_LEN;
					data_len -= FRAME_HEADER_LEN;
					header_read = 1;
				} else if (bytes_left == 0) {
					packet_type = LAST_PACKET;
				} else {
					packet_type = INTER_PACKET;
				}
				frame = gspca_get_i_frame(&dev->gspca_dev);
				if (frame &&  !discarding)
					gspca_frame_add(&dev->gspca_dev,
						packet_type, frame,
						data, data_len);
				else
					discarding = 1;
			} else {
				/* shut down if we got a USB error. */
				dev->streaming = 0;
			}
		}
		/* acknowledge the frame */
		sq905_ack_frame(dev->gspca_dev.dev);
	}
	complete(&dev->can_close);
}

/* this function is called at probe time */
static int sd_config(struct gspca_dev *gspca_dev,
		const struct usb_device_id *id)
{
	struct cam *cam = &gspca_dev->cam;

	cam->cam_mode = sq905_mode;
	cam->nmodes = 1;
	cam->bulk_size = SQ905_MAX_TRANSFER; /* Mention here, use everywhere! */
	/* Gives the number of altsettings. There is only one. */
	gspca_dev->nbalt = 1;	/* use bulk transfer */
	return 0;
}

/* Stop streaming and free the resources allocated by sd_start. */
static void sd_stopN(struct gspca_dev *gspca_dev)
{
	struct sd *dev = (struct sd *) gspca_dev;

	dev->streaming = 0;

	/* wait for the work queue to terminate */
	wait_for_completion(&dev->can_close);
}

/* called on streamoff with alt 0 and disconnect */
static void sd_stop0(struct gspca_dev *gspca_dev)
{
	struct sd *dev = (struct sd *) gspca_dev;
	sq905_command(gspca_dev->dev, SQ905_CLEAR);
	kfree(dev->buffer);
}

/* this function is called at probe and resume time */
static int sd_init(struct gspca_dev *gspca_dev)
{
	struct sd *dev = (struct sd *) gspca_dev;
	INIT_DELAYED_WORK(&dev->wqe, sq905_dostream);

	/* connect to the camera and read
	 * the model ID and process that and put it away.
	 */
	sq905_command(gspca_dev->dev, SQ905_CLEAR);
	sq905_command(gspca_dev->dev, SQ905_ID);
	sq905_read_data(gspca_dev, gspca_dev->usb_buf, 4);
	sq905_command(gspca_dev->dev, SQ905_CLEAR);
	if (!memcmp(gspca_dev->usb_buf, "\x09\x05\x01\x19", 4)) {
		dev->cam_model = SQ905_MODEL_POCK_CAM;
		PDEBUG(D_CONF, "Model is SQ905_MODEL_POCK_CAM");
	} else if (!memcmp(gspca_dev->usb_buf, "\x09\x05\x01\x32", 4)) {
		dev->cam_model = SQ905_MODEL_MAGPIX;
		PDEBUG(D_CONF, "Model is SQ905_MODEL_MAGPIX");
	} else {
		dev->cam_model = SQ905_MODEL_DEFAULT;
		PDEBUG(D_CONF, "Model is SQ905_MODEL_DEFAULT");
	}
	return 0;
}

/* Set up for getting frames. */
static int sd_start(struct gspca_dev *gspca_dev)
{
	struct sd *dev = (struct sd *) gspca_dev;

	/* Various initializations. */
	dev->buffer = kmalloc(SQ905_MAX_TRANSFER, GFP_KERNEL | GFP_DMA);
	if (!dev->buffer) {
		PDEBUG(D_ERR, "Couldn't allocate USB buffer\n");
		return -ENOMEM;
	}
	init_completion(&dev->can_close);
	dev->streaming = 1;

	/* "Open the shutter" and set size, to start capture */
	if (sq905_command(gspca_dev->dev, SQ905_CAPTURE_MED)) {
		PDEBUG(D_ERR, "Start streaming command failed\n");
		dev->streaming = 0;
		return -EIO;
	}
	/* Start the workqueue function to do the streaming */
	schedule_delayed_work(&dev->wqe, 1);

	return 0;
}

/* Table of supported USB devices */
static const __devinitdata struct usb_device_id device_table[] = {
	{USB_DEVICE(0x2770, 0x9120)},
	{}
};

MODULE_DEVICE_TABLE(usb, device_table);

/* sub-driver description */
static const struct sd_desc sd_desc = {
	.name = MODULE_NAME,
	.config = sd_config,
	.init = sd_init,
	.start = sd_start,
	.stopN = sd_stopN,
	.stop0 = sd_stop0,
};

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

--MP_/Rmd8zHJgfRoZv0xtnE=N0yx
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

------------------------------------------------------------------------------
Check out the new SourceForge.net Marketplace.
It is the best place to buy or sell services for
just about anything Open Source.
http://p.sf.net/sfu/Xq1LFB
--MP_/Rmd8zHJgfRoZv0xtnE=N0yx
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
Spca50x-devs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/spca50x-devs

--MP_/Rmd8zHJgfRoZv0xtnE=N0yx--