4 * Copyright (C) 2008, 2009 Adam Baker and Theodore Kilgore
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
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.
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
22 * History and Acknowledgments
24 * The original Linux driver for SQ905 based cameras was written by
25 * Marcell Lengyel and furter developed by many other contributers
26 * and is available from http://sourceforge.net/projects/sqcam/
28 * This driver takes advantage of the reverse engineering work done for
29 * that driver and for libgphoto2 but shares no code with them.
31 * This driver has used as a base the finepix driver and other gspca
32 * based drivers and may still contain code fragments taken from those
36 #define MODULE_NAME "sq905"
38 #include <linux/workqueue.h>
39 #include <linux/slab.h>
42 MODULE_AUTHOR("Adam Baker <linux@baker-net.org.uk>, "
43 "Theodore Kilgore <kilgota@auburn.edu>");
44 MODULE_DESCRIPTION("GSPCA/SQ905 USB Camera Driver");
45 MODULE_LICENSE("GPL");
47 /* Default timeouts, in ms */
48 #define SQ905_CMD_TIMEOUT 500
49 #define SQ905_DATA_TIMEOUT 1000
51 /* Maximum transfer size to use. */
52 #define SQ905_MAX_TRANSFER 0x8000
53 #define FRAME_HEADER_LEN 64
55 /* The known modes, or registers. These go in the "value" slot. */
57 /* 00 is "none" obviously */
59 #define SQ905_BULK_READ 0x03 /* precedes any bulk read */
60 #define SQ905_COMMAND 0x06 /* precedes the command codes below */
61 #define SQ905_PING 0x07 /* when reading an "idling" command */
62 #define SQ905_READ_DONE 0xc0 /* ack bulk read completed */
64 /* Any non-zero value in the bottom 2 bits of the 2nd byte of
65 * the ID appears to indicate the camera can do 640*480. If the
66 * LSB of that byte is set the image is just upside down, otherwise
67 * it is rotated 180 degrees. */
68 #define SQ905_HIRES_MASK 0x00000300
69 #define SQ905_ORIENTATION_MASK 0x00000100
71 /* Some command codes. These go in the "index" slot. */
73 #define SQ905_ID 0xf0 /* asks for model string */
74 #define SQ905_CONFIG 0x20 /* gets photo alloc. table, not used here */
75 #define SQ905_DATA 0x30 /* accesses photo data, not used here */
76 #define SQ905_CLEAR 0xa0 /* clear everything */
77 #define SQ905_CAPTURE_LOW 0x60 /* Starts capture at 160x120 */
78 #define SQ905_CAPTURE_MED 0x61 /* Starts capture at 320x240 */
79 #define SQ905_CAPTURE_HIGH 0x62 /* Starts capture at 640x480 (some cams only) */
80 /* note that the capture command also controls the output dimensions */
82 /* Structure to hold all of our device specific stuff */
84 struct gspca_dev gspca_dev; /* !! must be the first item */
89 struct work_struct work_struct;
90 struct workqueue_struct *work_thread;
93 static struct v4l2_pix_format sq905_mode[] = {
94 { 160, 120, V4L2_PIX_FMT_SBGGR8, V4L2_FIELD_NONE,
96 .sizeimage = 160 * 120,
97 .colorspace = V4L2_COLORSPACE_SRGB,
99 { 320, 240, V4L2_PIX_FMT_SBGGR8, V4L2_FIELD_NONE,
101 .sizeimage = 320 * 240,
102 .colorspace = V4L2_COLORSPACE_SRGB,
104 { 640, 480, V4L2_PIX_FMT_SBGGR8, V4L2_FIELD_NONE,
106 .sizeimage = 640 * 480,
107 .colorspace = V4L2_COLORSPACE_SRGB,
112 * Send a command to the camera.
114 static int sq905_command(struct gspca_dev *gspca_dev, u16 index)
118 gspca_dev->usb_buf[0] = '\0';
119 ret = usb_control_msg(gspca_dev->dev,
120 usb_sndctrlpipe(gspca_dev->dev, 0),
121 USB_REQ_SYNCH_FRAME, /* request */
122 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
123 SQ905_COMMAND, index, gspca_dev->usb_buf, 1,
126 err("%s: usb_control_msg failed (%d)",
131 ret = usb_control_msg(gspca_dev->dev,
132 usb_sndctrlpipe(gspca_dev->dev, 0),
133 USB_REQ_SYNCH_FRAME, /* request */
134 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
135 SQ905_PING, 0, gspca_dev->usb_buf, 1,
138 err("%s: usb_control_msg failed 2 (%d)",
147 * Acknowledge the end of a frame - see warning on sq905_command.
149 static int sq905_ack_frame(struct gspca_dev *gspca_dev)
153 gspca_dev->usb_buf[0] = '\0';
154 ret = usb_control_msg(gspca_dev->dev,
155 usb_sndctrlpipe(gspca_dev->dev, 0),
156 USB_REQ_SYNCH_FRAME, /* request */
157 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
158 SQ905_READ_DONE, 0, gspca_dev->usb_buf, 1,
161 err("%s: usb_control_msg failed (%d)", __func__, ret);
169 * request and read a block of data - see warning on sq905_command.
172 sq905_read_data(struct gspca_dev *gspca_dev, u8 *data, int size, int need_lock)
177 gspca_dev->usb_buf[0] = '\0';
179 mutex_lock(&gspca_dev->usb_lock);
180 ret = usb_control_msg(gspca_dev->dev,
181 usb_sndctrlpipe(gspca_dev->dev, 0),
182 USB_REQ_SYNCH_FRAME, /* request */
183 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
184 SQ905_BULK_READ, size, gspca_dev->usb_buf,
185 1, SQ905_CMD_TIMEOUT);
187 mutex_unlock(&gspca_dev->usb_lock);
189 err("%s: usb_control_msg failed (%d)", __func__, ret);
192 ret = usb_bulk_msg(gspca_dev->dev,
193 usb_rcvbulkpipe(gspca_dev->dev, 0x81),
194 data, size, &act_len, SQ905_DATA_TIMEOUT);
196 /* successful, it returns 0, otherwise negative */
197 if (ret < 0 || act_len != size) {
198 err("bulk read fail (%d) len %d/%d",
205 /* This function is called as a workqueue function and runs whenever the camera
206 * is streaming data. Because it is a workqueue function it is allowed to sleep
207 * so we can use synchronous USB calls. To avoid possible collisions with other
208 * threads attempting to use the camera's USB interface we take the gspca
209 * usb_lock when performing USB operations. In practice the only thing we need
210 * to protect against is the usb_set_interface call that gspca makes during
211 * stream_off as the camera doesn't provide any controls that the user could try
214 static void sq905_dostream(struct work_struct *work)
216 struct sd *dev = container_of(work, struct sd, work_struct);
217 struct gspca_dev *gspca_dev = &dev->gspca_dev;
218 int bytes_left; /* bytes remaining in current frame. */
219 int data_len; /* size to use for the next read. */
220 int header_read; /* true if we have already read the frame header. */
227 buffer = kmalloc(SQ905_MAX_TRANSFER, GFP_KERNEL | GFP_DMA);
229 err("Couldn't allocate USB buffer");
233 frame_sz = gspca_dev->cam.cam_mode[gspca_dev->curr_mode].sizeimage
236 while (gspca_dev->present && gspca_dev->streaming) {
237 /* request some data and then read it until we have
238 * a complete frame. */
239 bytes_left = frame_sz;
242 /* Note we do not check for gspca_dev->streaming here, as
243 we must finish reading an entire frame, otherwise the
244 next time we stream we start reading in the middle of a
246 while (bytes_left > 0 && gspca_dev->present) {
247 data_len = bytes_left > SQ905_MAX_TRANSFER ?
248 SQ905_MAX_TRANSFER : bytes_left;
249 ret = sq905_read_data(gspca_dev, buffer, data_len, 1);
253 "Got %d bytes out of %d for frame",
254 data_len, bytes_left);
255 bytes_left -= data_len;
258 packet_type = FIRST_PACKET;
259 /* The first 64 bytes of each frame are
260 * a header full of FF 00 bytes */
261 data += FRAME_HEADER_LEN;
262 data_len -= FRAME_HEADER_LEN;
264 } else if (bytes_left == 0) {
265 packet_type = LAST_PACKET;
267 packet_type = INTER_PACKET;
269 gspca_frame_add(gspca_dev, packet_type,
271 /* If entire frame fits in one packet we still
272 need to add a LAST_PACKET */
273 if (packet_type == FIRST_PACKET &&
275 gspca_frame_add(gspca_dev, LAST_PACKET,
278 if (gspca_dev->present) {
279 /* acknowledge the frame */
280 mutex_lock(&gspca_dev->usb_lock);
281 ret = sq905_ack_frame(gspca_dev);
282 mutex_unlock(&gspca_dev->usb_lock);
288 if (gspca_dev->present) {
289 mutex_lock(&gspca_dev->usb_lock);
290 sq905_command(gspca_dev, SQ905_CLEAR);
291 mutex_unlock(&gspca_dev->usb_lock);
296 /* This function is called at probe time just before sd_init */
297 static int sd_config(struct gspca_dev *gspca_dev,
298 const struct usb_device_id *id)
300 struct cam *cam = &gspca_dev->cam;
301 struct sd *dev = (struct sd *) gspca_dev;
303 /* We don't use the buffer gspca allocates so make it small. */
307 INIT_WORK(&dev->work_struct, sq905_dostream);
312 /* called on streamoff with alt==0 and on disconnect */
313 /* the usb_lock is held at entry - restore on exit */
314 static void sd_stop0(struct gspca_dev *gspca_dev)
316 struct sd *dev = (struct sd *) gspca_dev;
318 /* wait for the work queue to terminate */
319 mutex_unlock(&gspca_dev->usb_lock);
320 /* This waits for sq905_dostream to finish */
321 destroy_workqueue(dev->work_thread);
322 dev->work_thread = NULL;
323 mutex_lock(&gspca_dev->usb_lock);
326 /* this function is called at probe and resume time */
327 static int sd_init(struct gspca_dev *gspca_dev)
332 /* connect to the camera and read
333 * the model ID and process that and put it away.
335 ret = sq905_command(gspca_dev, SQ905_CLEAR);
338 ret = sq905_command(gspca_dev, SQ905_ID);
341 ret = sq905_read_data(gspca_dev, gspca_dev->usb_buf, 4, 0);
344 /* usb_buf is allocated with kmalloc so is aligned.
345 * Camera model number is the right way round if we assume this
346 * reverse engineered ID is supposed to be big endian. */
347 ident = be32_to_cpup((__be32 *)gspca_dev->usb_buf);
348 ret = sq905_command(gspca_dev, SQ905_CLEAR);
351 PDEBUG(D_CONF, "SQ905 camera ID %08x detected", ident);
352 gspca_dev->cam.cam_mode = sq905_mode;
353 gspca_dev->cam.nmodes = ARRAY_SIZE(sq905_mode);
354 if (!(ident & SQ905_HIRES_MASK))
355 gspca_dev->cam.nmodes--;
357 if (ident & SQ905_ORIENTATION_MASK)
358 gspca_dev->cam.input_flags = V4L2_IN_ST_VFLIP;
360 gspca_dev->cam.input_flags = V4L2_IN_ST_VFLIP |
365 /* Set up for getting frames. */
366 static int sd_start(struct gspca_dev *gspca_dev)
368 struct sd *dev = (struct sd *) gspca_dev;
371 /* "Open the shutter" and set size, to start capture */
372 switch (gspca_dev->curr_mode) {
375 PDEBUG(D_STREAM, "Start streaming at high resolution");
376 ret = sq905_command(&dev->gspca_dev, SQ905_CAPTURE_HIGH);
379 PDEBUG(D_STREAM, "Start streaming at medium resolution");
380 ret = sq905_command(&dev->gspca_dev, SQ905_CAPTURE_MED);
383 PDEBUG(D_STREAM, "Start streaming at low resolution");
384 ret = sq905_command(&dev->gspca_dev, SQ905_CAPTURE_LOW);
388 PDEBUG(D_ERR, "Start streaming command failed");
391 /* Start the workqueue function to do the streaming */
392 dev->work_thread = create_singlethread_workqueue(MODULE_NAME);
393 queue_work(dev->work_thread, &dev->work_struct);
398 /* Table of supported USB devices */
399 static const struct usb_device_id device_table[] = {
400 {USB_DEVICE(0x2770, 0x9120)},
404 MODULE_DEVICE_TABLE(usb, device_table);
406 /* sub-driver description */
407 static const struct sd_desc sd_desc = {
415 /* -- device connect -- */
416 static int sd_probe(struct usb_interface *intf,
417 const struct usb_device_id *id)
419 return gspca_dev_probe(intf, id,
425 static struct usb_driver sd_driver = {
427 .id_table = device_table,
429 .disconnect = gspca_disconnect,
431 .suspend = gspca_suspend,
432 .resume = gspca_resume,
436 /* -- module insert / remove -- */
437 static int __init sd_mod_init(void)
439 return usb_register(&sd_driver);
442 static void __exit sd_mod_exit(void)
444 usb_deregister(&sd_driver);
447 module_init(sd_mod_init);
448 module_exit(sd_mod_exit);