2 * Copyright (c) 2001 Jean-Fredric Clere, Nikolas Zimmermann, Georg Acher
3 * Mark Cave-Ayland, Carlo E Prelz, Dick Streefland
4 * Copyright (c) 2002, 2003 Tuukka Toivonen
5 * Copyright (c) 2008 Erik Andrén
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * P/N 861037: Sensor HDCS1000 ASIC STV0600
18 * P/N 861050-0010: Sensor HDCS1000 ASIC STV0600
19 * P/N 861050-0020: Sensor Photobit PB100 ASIC STV0600-1 - QuickCam Express
20 * P/N 861055: Sensor ST VV6410 ASIC STV0610 - LEGO cam
21 * P/N 861075-0040: Sensor HDCS1000 ASIC
22 * P/N 961179-0700: Sensor ST VV6410 ASIC STV0602 - Dexxa WebCam USB
23 * P/N 861040-0000: Sensor ST VV6410 ASIC STV0610 - QuickCam Web
26 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
28 #include <linux/input.h>
29 #include "stv06xx_sensor.h"
31 MODULE_AUTHOR("Erik Andrén");
32 MODULE_DESCRIPTION("STV06XX USB Camera Driver");
33 MODULE_LICENSE("GPL");
35 static bool dump_bridge;
36 static bool dump_sensor;
38 int stv06xx_write_bridge(struct sd *sd, u16 address, u16 i2c_data)
41 struct gspca_dev *gspca_dev = (struct gspca_dev *)sd;
42 struct usb_device *udev = sd->gspca_dev.dev;
43 __u8 *buf = sd->gspca_dev.usb_buf;
45 u8 len = (i2c_data > 0xff) ? 2 : 1;
47 buf[0] = i2c_data & 0xff;
48 buf[1] = (i2c_data >> 8) & 0xff;
50 err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
51 0x04, 0x40, address, 0, buf, len,
52 STV06XX_URB_MSG_TIMEOUT);
54 gspca_dbg(gspca_dev, D_CONF, "Written 0x%x to address 0x%x, status: %d\n",
55 i2c_data, address, err);
57 return (err < 0) ? err : 0;
60 int stv06xx_read_bridge(struct sd *sd, u16 address, u8 *i2c_data)
63 struct gspca_dev *gspca_dev = (struct gspca_dev *)sd;
64 struct usb_device *udev = sd->gspca_dev.dev;
65 __u8 *buf = sd->gspca_dev.usb_buf;
67 err = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
68 0x04, 0xc0, address, 0, buf, 1,
69 STV06XX_URB_MSG_TIMEOUT);
73 gspca_dbg(gspca_dev, D_CONF, "Reading 0x%x from address 0x%x, status %d\n",
74 *i2c_data, address, err);
76 return (err < 0) ? err : 0;
79 /* Wraps the normal write sensor bytes / words functions for writing a
81 int stv06xx_write_sensor(struct sd *sd, u8 address, u16 value)
83 if (sd->sensor->i2c_len == 2) {
84 u16 data[2] = { address, value };
85 return stv06xx_write_sensor_words(sd, data, 1);
87 u8 data[2] = { address, value };
88 return stv06xx_write_sensor_bytes(sd, data, 1);
92 static int stv06xx_write_sensor_finish(struct sd *sd)
96 if (sd->bridge == BRIDGE_STV610) {
97 struct usb_device *udev = sd->gspca_dev.dev;
98 __u8 *buf = sd->gspca_dev.usb_buf;
101 err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
102 0x04, 0x40, 0x1704, 0, buf, 1,
103 STV06XX_URB_MSG_TIMEOUT);
106 return (err < 0) ? err : 0;
109 int stv06xx_write_sensor_bytes(struct sd *sd, const u8 *data, u8 len)
112 struct gspca_dev *gspca_dev = (struct gspca_dev *)sd;
113 struct usb_device *udev = sd->gspca_dev.dev;
114 __u8 *buf = sd->gspca_dev.usb_buf;
116 gspca_dbg(gspca_dev, D_CONF, "I2C: Command buffer contains %d entries\n",
118 for (i = 0; i < len;) {
119 /* Build the command buffer */
120 memset(buf, 0, I2C_BUFFER_LENGTH);
121 for (j = 0; j < I2C_MAX_BYTES && i < len; j++, i++) {
123 buf[0x10 + j] = data[2*i+1];
124 gspca_dbg(gspca_dev, D_CONF, "I2C: Writing 0x%02x to reg 0x%02x\n",
125 data[2*i+1], data[2*i]);
127 buf[0x20] = sd->sensor->i2c_addr;
128 buf[0x21] = j - 1; /* Number of commands to send - 1 */
129 buf[0x22] = I2C_WRITE_CMD;
130 err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
131 0x04, 0x40, 0x0400, 0, buf,
133 STV06XX_URB_MSG_TIMEOUT);
137 return stv06xx_write_sensor_finish(sd);
140 int stv06xx_write_sensor_words(struct sd *sd, const u16 *data, u8 len)
143 struct gspca_dev *gspca_dev = (struct gspca_dev *)sd;
144 struct usb_device *udev = sd->gspca_dev.dev;
145 __u8 *buf = sd->gspca_dev.usb_buf;
147 gspca_dbg(gspca_dev, D_CONF, "I2C: Command buffer contains %d entries\n",
150 for (i = 0; i < len;) {
151 /* Build the command buffer */
152 memset(buf, 0, I2C_BUFFER_LENGTH);
153 for (j = 0; j < I2C_MAX_WORDS && i < len; j++, i++) {
155 buf[0x10 + j * 2] = data[2*i+1];
156 buf[0x10 + j * 2 + 1] = data[2*i+1] >> 8;
157 gspca_dbg(gspca_dev, D_CONF, "I2C: Writing 0x%04x to reg 0x%02x\n",
158 data[2*i+1], data[2*i]);
160 buf[0x20] = sd->sensor->i2c_addr;
161 buf[0x21] = j - 1; /* Number of commands to send - 1 */
162 buf[0x22] = I2C_WRITE_CMD;
163 err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
164 0x04, 0x40, 0x0400, 0, buf,
166 STV06XX_URB_MSG_TIMEOUT);
170 return stv06xx_write_sensor_finish(sd);
173 int stv06xx_read_sensor(struct sd *sd, const u8 address, u16 *value)
176 struct gspca_dev *gspca_dev = (struct gspca_dev *)sd;
177 struct usb_device *udev = sd->gspca_dev.dev;
178 __u8 *buf = sd->gspca_dev.usb_buf;
180 err = stv06xx_write_bridge(sd, STV_I2C_FLUSH, sd->sensor->i2c_flush);
185 memset(buf, 0, I2C_BUFFER_LENGTH);
188 buf[0x20] = sd->sensor->i2c_addr;
191 /* Read I2C register */
192 buf[0x22] = I2C_READ_CMD;
194 err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
195 0x04, 0x40, 0x1400, 0, buf, I2C_BUFFER_LENGTH,
196 STV06XX_URB_MSG_TIMEOUT);
198 pr_err("I2C: Read error writing address: %d\n", err);
202 err = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
203 0x04, 0xc0, 0x1410, 0, buf, sd->sensor->i2c_len,
204 STV06XX_URB_MSG_TIMEOUT);
205 if (sd->sensor->i2c_len == 2)
206 *value = buf[0] | (buf[1] << 8);
210 gspca_dbg(gspca_dev, D_CONF, "I2C: Read 0x%x from address 0x%x, status: %d\n",
211 *value, address, err);
213 return (err < 0) ? err : 0;
216 /* Dumps all bridge registers */
217 static void stv06xx_dump_bridge(struct sd *sd)
222 pr_info("Dumping all stv06xx bridge registers\n");
223 for (i = 0x1400; i < 0x160f; i++) {
224 stv06xx_read_bridge(sd, i, &data);
226 pr_info("Read 0x%x from address 0x%x\n", data, i);
229 pr_info("Testing stv06xx bridge registers for writability\n");
230 for (i = 0x1400; i < 0x160f; i++) {
231 stv06xx_read_bridge(sd, i, &data);
234 stv06xx_write_bridge(sd, i, 0xff);
235 stv06xx_read_bridge(sd, i, &data);
237 pr_info("Register 0x%x is read/write\n", i);
238 else if (data != buf)
239 pr_info("Register 0x%x is read/write, but only partially\n",
242 pr_info("Register 0x%x is read-only\n", i);
244 stv06xx_write_bridge(sd, i, buf);
248 /* this function is called at probe and resume time */
249 static int stv06xx_init(struct gspca_dev *gspca_dev)
251 struct sd *sd = (struct sd *) gspca_dev;
254 gspca_dbg(gspca_dev, D_PROBE, "Initializing camera\n");
256 /* Let the usb init settle for a bit
257 before performing the initialization */
260 err = sd->sensor->init(sd);
262 if (dump_sensor && sd->sensor->dump)
263 sd->sensor->dump(sd);
265 return (err < 0) ? err : 0;
268 /* this function is called at probe time */
269 static int stv06xx_init_controls(struct gspca_dev *gspca_dev)
271 struct sd *sd = (struct sd *) gspca_dev;
273 gspca_dbg(gspca_dev, D_PROBE, "Initializing controls\n");
275 gspca_dev->vdev.ctrl_handler = &gspca_dev->ctrl_handler;
276 return sd->sensor->init_controls(sd);
279 /* Start the camera */
280 static int stv06xx_start(struct gspca_dev *gspca_dev)
282 struct sd *sd = (struct sd *) gspca_dev;
283 struct usb_host_interface *alt;
284 struct usb_interface *intf;
285 int err, packet_size;
287 intf = usb_ifnum_to_if(sd->gspca_dev.dev, sd->gspca_dev.iface);
288 alt = usb_altnum_to_altsetting(intf, sd->gspca_dev.alt);
290 gspca_err(gspca_dev, "Couldn't get altsetting\n");
294 packet_size = le16_to_cpu(alt->endpoint[0].desc.wMaxPacketSize);
295 err = stv06xx_write_bridge(sd, STV_ISO_SIZE_L, packet_size);
299 /* Prepare the sensor for start */
300 err = sd->sensor->start(sd);
304 /* Start isochronous streaming */
305 err = stv06xx_write_bridge(sd, STV_ISO_ENABLE, 1);
309 gspca_dbg(gspca_dev, D_STREAM, "Starting stream failed\n");
311 gspca_dbg(gspca_dev, D_STREAM, "Started streaming\n");
313 return (err < 0) ? err : 0;
316 static int stv06xx_isoc_init(struct gspca_dev *gspca_dev)
318 struct usb_host_interface *alt;
319 struct sd *sd = (struct sd *) gspca_dev;
321 /* Start isoc bandwidth "negotiation" at max isoc bandwidth */
322 alt = &gspca_dev->dev->actconfig->intf_cache[0]->altsetting[1];
323 alt->endpoint[0].desc.wMaxPacketSize =
324 cpu_to_le16(sd->sensor->max_packet_size[gspca_dev->curr_mode]);
329 static int stv06xx_isoc_nego(struct gspca_dev *gspca_dev)
331 int ret, packet_size, min_packet_size;
332 struct usb_host_interface *alt;
333 struct sd *sd = (struct sd *) gspca_dev;
335 alt = &gspca_dev->dev->actconfig->intf_cache[0]->altsetting[1];
336 packet_size = le16_to_cpu(alt->endpoint[0].desc.wMaxPacketSize);
337 min_packet_size = sd->sensor->min_packet_size[gspca_dev->curr_mode];
338 if (packet_size <= min_packet_size)
342 if (packet_size < min_packet_size)
343 packet_size = min_packet_size;
344 alt->endpoint[0].desc.wMaxPacketSize = cpu_to_le16(packet_size);
346 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, 1);
348 gspca_err(gspca_dev, "set alt 1 err %d\n", ret);
353 static void stv06xx_stopN(struct gspca_dev *gspca_dev)
356 struct sd *sd = (struct sd *) gspca_dev;
358 /* stop ISO-streaming */
359 err = stv06xx_write_bridge(sd, STV_ISO_ENABLE, 0);
363 err = sd->sensor->stop(sd);
367 gspca_dbg(gspca_dev, D_STREAM, "Failed to stop stream\n");
369 gspca_dbg(gspca_dev, D_STREAM, "Stopped streaming\n");
373 * Analyse an USB packet of the data stream and store it appropriately.
374 * Each packet contains an integral number of chunks. Each chunk has
375 * 2-bytes identification, followed by 2-bytes that describe the chunk
376 * length. Known/guessed chunk identifications are:
377 * 8001/8005/C001/C005 - Begin new frame
378 * 8002/8006/C002/C006 - End frame
379 * 0200/4200 - Contains actual image data, bayer or compressed
380 * 0005 - 11 bytes of unknown data
381 * 0100 - 2 bytes of unknown data
382 * The 0005 and 0100 chunks seem to appear only in compressed stream.
384 static void stv06xx_pkt_scan(struct gspca_dev *gspca_dev,
385 u8 *data, /* isoc packet */
386 int len) /* iso packet length */
388 struct sd *sd = (struct sd *) gspca_dev;
390 gspca_dbg(gspca_dev, D_PACK, "Packet of length %d arrived\n", len);
392 /* A packet may contain several frames
393 loop until the whole packet is reached */
398 gspca_dbg(gspca_dev, D_PACK, "Packet is smaller than 4 bytes\n");
403 id = (data[0] << 8) | data[1];
405 /* Capture the chunk length */
406 chunk_len = (data[2] << 8) | data[3];
407 gspca_dbg(gspca_dev, D_PACK, "Chunk id: %x, length: %d\n",
413 if (len < chunk_len) {
414 gspca_err(gspca_dev, "URB packet length is smaller than the specified chunk length\n");
415 gspca_dev->last_packet_type = DISCARD_PACKET;
419 /* First byte seem to be 02=data 2nd byte is unknown??? */
420 if (sd->bridge == BRIDGE_ST6422 && (id & 0xff00) == 0x0200)
427 gspca_dbg(gspca_dev, D_PACK, "Frame data packet detected\n");
430 int skip = (sd->to_skip < chunk_len) ?
431 sd->to_skip : chunk_len;
438 gspca_frame_add(gspca_dev, INTER_PACKET,
446 gspca_dbg(gspca_dev, D_PACK, "Starting new frame\n");
448 /* Create a new frame, chunk length should be zero */
449 gspca_frame_add(gspca_dev, FIRST_PACKET,
452 if (sd->bridge == BRIDGE_ST6422)
453 sd->to_skip = gspca_dev->pixfmt.width * 4;
456 gspca_err(gspca_dev, "Chunk length is non-zero on a SOF\n");
462 gspca_dbg(gspca_dev, D_PACK, "End of frame detected\n");
464 /* Complete the last frame (if any) */
465 gspca_frame_add(gspca_dev, LAST_PACKET,
469 gspca_err(gspca_dev, "Chunk length is non-zero on a EOF\n");
473 gspca_dbg(gspca_dev, D_PACK, "Chunk 0x005 detected\n");
474 /* Unknown chunk with 11 bytes of data,
475 occurs just before end of each frame
476 in compressed mode */
480 gspca_dbg(gspca_dev, D_PACK, "Chunk 0x0100 detected\n");
481 /* Unknown chunk with 2 bytes of data,
482 occurs 2-3 times per USB interrupt */
485 gspca_dbg(gspca_dev, D_PACK, "Chunk 0x42ff detected\n");
486 /* Special chunk seen sometimes on the ST6422 */
489 gspca_dbg(gspca_dev, D_PACK, "Unknown chunk 0x%04x detected\n",
498 #if IS_ENABLED(CONFIG_INPUT)
499 static int sd_int_pkt_scan(struct gspca_dev *gspca_dev,
500 u8 *data, /* interrupt packet data */
501 int len) /* interrupt packet length */
505 if (len == 1 && (data[0] == 0x80 || data[0] == 0x10)) {
506 input_report_key(gspca_dev->input_dev, KEY_CAMERA, 1);
507 input_sync(gspca_dev->input_dev);
511 if (len == 1 && (data[0] == 0x88 || data[0] == 0x11)) {
512 input_report_key(gspca_dev->input_dev, KEY_CAMERA, 0);
513 input_sync(gspca_dev->input_dev);
521 static int stv06xx_config(struct gspca_dev *gspca_dev,
522 const struct usb_device_id *id);
524 /* sub-driver description */
525 static const struct sd_desc sd_desc = {
527 .config = stv06xx_config,
528 .init = stv06xx_init,
529 .init_controls = stv06xx_init_controls,
530 .start = stv06xx_start,
531 .stopN = stv06xx_stopN,
532 .pkt_scan = stv06xx_pkt_scan,
533 .isoc_init = stv06xx_isoc_init,
534 .isoc_nego = stv06xx_isoc_nego,
535 #if IS_ENABLED(CONFIG_INPUT)
536 .int_pkt_scan = sd_int_pkt_scan,
540 /* This function is called at probe time */
541 static int stv06xx_config(struct gspca_dev *gspca_dev,
542 const struct usb_device_id *id)
544 struct sd *sd = (struct sd *) gspca_dev;
546 gspca_dbg(gspca_dev, D_PROBE, "Configuring camera\n");
548 sd->bridge = id->driver_info;
549 gspca_dev->sd_desc = &sd_desc;
552 stv06xx_dump_bridge(sd);
554 sd->sensor = &stv06xx_sensor_st6422;
555 if (!sd->sensor->probe(sd))
558 sd->sensor = &stv06xx_sensor_vv6410;
559 if (!sd->sensor->probe(sd))
562 sd->sensor = &stv06xx_sensor_hdcs1x00;
563 if (!sd->sensor->probe(sd))
566 sd->sensor = &stv06xx_sensor_hdcs1020;
567 if (!sd->sensor->probe(sd))
570 sd->sensor = &stv06xx_sensor_pb0100;
571 if (!sd->sensor->probe(sd))
580 /* -- module initialisation -- */
581 static const struct usb_device_id device_table[] = {
582 {USB_DEVICE(0x046d, 0x0840), .driver_info = BRIDGE_STV600 }, /* QuickCam Express */
583 {USB_DEVICE(0x046d, 0x0850), .driver_info = BRIDGE_STV610 }, /* LEGO cam / QuickCam Web */
584 {USB_DEVICE(0x046d, 0x0870), .driver_info = BRIDGE_STV602 }, /* Dexxa WebCam USB */
585 {USB_DEVICE(0x046D, 0x08F0), .driver_info = BRIDGE_ST6422 }, /* QuickCam Messenger */
586 {USB_DEVICE(0x046D, 0x08F5), .driver_info = BRIDGE_ST6422 }, /* QuickCam Communicate */
587 {USB_DEVICE(0x046D, 0x08F6), .driver_info = BRIDGE_ST6422 }, /* QuickCam Messenger (new) */
590 MODULE_DEVICE_TABLE(usb, device_table);
592 /* -- device connect -- */
593 static int sd_probe(struct usb_interface *intf,
594 const struct usb_device_id *id)
596 return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
600 static void sd_disconnect(struct usb_interface *intf)
602 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
603 struct sd *sd = (struct sd *) gspca_dev;
604 void *priv = sd->sensor_priv;
605 gspca_dbg(gspca_dev, D_PROBE, "Disconnecting the stv06xx device\n");
608 gspca_disconnect(intf);
612 static struct usb_driver sd_driver = {
614 .id_table = device_table,
616 .disconnect = sd_disconnect,
618 .suspend = gspca_suspend,
619 .resume = gspca_resume,
620 .reset_resume = gspca_resume,
624 module_usb_driver(sd_driver);
626 module_param(dump_bridge, bool, S_IRUGO | S_IWUSR);
627 MODULE_PARM_DESC(dump_bridge, "Dumps all usb bridge registers at startup");
629 module_param(dump_sensor, bool, S_IRUGO | S_IWUSR);
630 MODULE_PARM_DESC(dump_sensor, "Dumps all sensor registers at startup");