drivers/media/video/gspca/stv06xx/stv06xx.c

   1 /*
   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
   6  *
   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.
  11  *
  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.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  *
  21  * P/N 861037:      Sensor HDCS1000        ASIC STV0600
  22  * P/N 861050-0010: Sensor HDCS1000        ASIC STV0600
  23  * P/N 861050-0020: Sensor Photobit PB100  ASIC STV0600-1 - QuickCam Express
  24  * P/N 861055:      Sensor ST VV6410       ASIC STV0610   - LEGO cam
  25  * P/N 861075-0040: Sensor HDCS1000        ASIC
  26  * P/N 961179-0700: Sensor ST VV6410       ASIC STV0602   - Dexxa WebCam USB
  27  * P/N 861040-0000: Sensor ST VV6410       ASIC STV0610   - QuickCam Web
  28  */
  29
  30 #include "stv06xx_sensor.h"
  31
  32 MODULE_AUTHOR("Erik Andrén");
  33 MODULE_DESCRIPTION("STV06XX USB Camera Driver");
  34 MODULE_LICENSE("GPL");
  35
  36 static int dump_bridge;
  37 static int dump_sensor;
  38
  39 int stv06xx_write_bridge(struct sd *sd, u16 address, u16 i2c_data)
  40 {
  41         int err;
  42         struct usb_device *udev = sd->gspca_dev.dev;
  43         __u8 *buf = sd->gspca_dev.usb_buf;
  44         u8 len = (i2c_data > 0xff) ? 2 : 1;
  45
  46         buf[0] = i2c_data & 0xff;
  47         buf[1] = (i2c_data >> 8) & 0xff;
  48
  49         err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  50                               0x04, 0x40, address, 0, buf, len,
  51                               STV06XX_URB_MSG_TIMEOUT);
  52
  53         PDEBUG(D_CONF, "Written 0x%x to address 0x%x, status: %d",
  54                i2c_data, address, err);
  55
  56         return (err < 0) ? err : 0;
  57 }
  58
  59 int stv06xx_read_bridge(struct sd *sd, u16 address, u8 *i2c_data)
  60 {
  61         int err;
  62         struct usb_device *udev = sd->gspca_dev.dev;
  63         __u8 *buf = sd->gspca_dev.usb_buf;
  64
  65         err = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
  66                               0x04, 0xc0, address, 0, buf, 1,
  67                               STV06XX_URB_MSG_TIMEOUT);
  68
  69         *i2c_data = buf[0];
  70
  71         PDEBUG(D_CONF, "Reading 0x%x from address 0x%x, status %d",
  72                *i2c_data, address, err);
  73
  74         return (err < 0) ? err : 0;
  75 }
  76
  77 /* Wraps the normal write sensor bytes / words functions for writing a
  78    single value */
  79 int stv06xx_write_sensor(struct sd *sd, u8 address, u16 value)
  80 {
  81         if (sd->sensor->i2c_len == 2) {
  82                 u16 data[2] = { address, value };
  83                 return stv06xx_write_sensor_words(sd, data, 1);
  84         } else {
  85                 u8 data[2] = { address, value };
  86                 return stv06xx_write_sensor_bytes(sd, data, 1);
  87         }
  88 }
  89
  90 static int stv06xx_write_sensor_finish(struct sd *sd)
  91 {
  92         int err = 0;
  93
  94         if (sd->bridge == BRIDGE_STV610) {
  95                 struct usb_device *udev = sd->gspca_dev.dev;
  96                 __u8 *buf = sd->gspca_dev.usb_buf;
  97
  98                 buf[0] = 0;
  99                 err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
 100                                       0x04, 0x40, 0x1704, 0, buf, 1,
 101                                       STV06XX_URB_MSG_TIMEOUT);
 102         }
 103
 104         return (err < 0) ? err : 0;
 105 }
 106
 107 int stv06xx_write_sensor_bytes(struct sd *sd, const u8 *data, u8 len)
 108 {
 109         int err, i, j;
 110         struct usb_device *udev = sd->gspca_dev.dev;
 111         __u8 *buf = sd->gspca_dev.usb_buf;
 112
 113         PDEBUG(D_CONF, "I2C: Command buffer contains %d entries", len);
 114         for (i = 0; i < len;) {
 115                 /* Build the command buffer */
 116                 memset(buf, 0, I2C_BUFFER_LENGTH);
 117                 for (j = 0; j < I2C_MAX_BYTES && i < len; j++, i++) {
 118                         buf[j] = data[2*i];
 119                         buf[0x10 + j] = data[2*i+1];
 120                         PDEBUG(D_CONF, "I2C: Writing 0x%02x to reg 0x%02x",
 121                         data[2*i+1], data[2*i]);
 122                 }
 123                 buf[0x20] = sd->sensor->i2c_addr;
 124                 buf[0x21] = j - 1; /* Number of commands to send - 1 */
 125                 buf[0x22] = I2C_WRITE_CMD;
 126                 err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
 127                                       0x04, 0x40, 0x0400, 0, buf,
 128                                       I2C_BUFFER_LENGTH,
 129                                       STV06XX_URB_MSG_TIMEOUT);
 130                 if (err < 0)
 131                         return err;
 132         }
 133         return stv06xx_write_sensor_finish(sd);
 134 }
 135
 136 int stv06xx_write_sensor_words(struct sd *sd, const u16 *data, u8 len)
 137 {
 138         int err, i, j;
 139         struct usb_device *udev = sd->gspca_dev.dev;
 140         __u8 *buf = sd->gspca_dev.usb_buf;
 141
 142         PDEBUG(D_CONF, "I2C: Command buffer contains %d entries", len);
 143
 144         for (i = 0; i < len;) {
 145                 /* Build the command buffer */
 146                 memset(buf, 0, I2C_BUFFER_LENGTH);
 147                 for (j = 0; j < I2C_MAX_WORDS && i < len; j++, i++) {
 148                         buf[j] = data[2*i];
 149                         buf[0x10 + j * 2] = data[2*i+1];
 150                         buf[0x10 + j * 2 + 1] = data[2*i+1] >> 8;
 151                         PDEBUG(D_CONF, "I2C: Writing 0x%04x to reg 0x%02x",
 152                                 data[2*i+1], data[2*i]);
 153                 }
 154                 buf[0x20] = sd->sensor->i2c_addr;
 155                 buf[0x21] = j - 1; /* Number of commands to send - 1 */
 156                 buf[0x22] = I2C_WRITE_CMD;
 157                 err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
 158                                 0x04, 0x40, 0x0400, 0, buf,
 159                                 I2C_BUFFER_LENGTH,
 160                                 STV06XX_URB_MSG_TIMEOUT);
 161                 if (err < 0)
 162                         return err;
 163         }
 164         return stv06xx_write_sensor_finish(sd);
 165 }
 166
 167 int stv06xx_read_sensor(struct sd *sd, const u8 address, u16 *value)
 168 {
 169         int err;
 170         struct usb_device *udev = sd->gspca_dev.dev;
 171         __u8 *buf = sd->gspca_dev.usb_buf;
 172
 173         err = stv06xx_write_bridge(sd, STV_I2C_FLUSH, sd->sensor->i2c_flush);
 174         if (err < 0)
 175                 return err;
 176
 177         /* Clear mem */
 178         memset(buf, 0, I2C_BUFFER_LENGTH);
 179
 180         buf[0] = address;
 181         buf[0x20] = sd->sensor->i2c_addr;
 182         buf[0x21] = 0;
 183
 184         /* Read I2C register */
 185         buf[0x22] = I2C_READ_CMD;
 186
 187         err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
 188                               0x04, 0x40, 0x1400, 0, buf, I2C_BUFFER_LENGTH,
 189                               STV06XX_URB_MSG_TIMEOUT);
 190         if (err < 0) {
 191                 PDEBUG(D_ERR, "I2C: Read error writing address: %d", err);
 192                 return err;
 193         }
 194
 195         err = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
 196                               0x04, 0xc0, 0x1410, 0, buf, sd->sensor->i2c_len,
 197                               STV06XX_URB_MSG_TIMEOUT);
 198         if (sd->sensor->i2c_len == 2)
 199                 *value = buf[0] | (buf[1] << 8);
 200         else
 201                 *value = buf[0];
 202
 203         PDEBUG(D_CONF, "I2C: Read 0x%x from address 0x%x, status: %d",
 204                *value, address, err);
 205
 206         return (err < 0) ? err : 0;
 207 }
 208
 209 /* Dumps all bridge registers */
 210 static void stv06xx_dump_bridge(struct sd *sd)
 211 {
 212         int i;
 213         u8 data, buf;
 214
 215         info("Dumping all stv06xx bridge registers");
 216         for (i = 0x1400; i < 0x160f; i++) {
 217                 stv06xx_read_bridge(sd, i, &data);
 218
 219                 info("Read 0x%x from address 0x%x", data, i);
 220         }
 221
 222         for (i = 0x1400; i < 0x160f; i++) {
 223                 stv06xx_read_bridge(sd, i, &data);
 224                 buf = data;
 225
 226                 stv06xx_write_bridge(sd, i, 0xff);
 227                 stv06xx_read_bridge(sd, i, &data);
 228                 if (data == 0xff)
 229                         info("Register 0x%x is read/write", i);
 230                 else if (data != buf)
 231                         info("Register 0x%x is read/write,"
 232                              "but only partially", i);
 233                 else
 234                         info("Register 0x%x is read-only", i);
 235
 236                 stv06xx_write_bridge(sd, i, buf);
 237         }
 238 }
 239
 240 /* this function is called at probe and resume time */
 241 static int stv06xx_init(struct gspca_dev *gspca_dev)
 242 {
 243         struct sd *sd = (struct sd *) gspca_dev;
 244         int err;
 245
 246         PDEBUG(D_PROBE, "Initializing camera");
 247
 248         /* Let the usb init settle for a bit
 249            before performing the initialization */
 250         msleep(250);
 251
 252         err = sd->sensor->init(sd);
 253
 254         if (dump_sensor && sd->sensor->dump)
 255                 sd->sensor->dump(sd);
 256
 257         return (err < 0) ? err : 0;
 258 }
 259
 260 /* Start the camera */
 261 static int stv06xx_start(struct gspca_dev *gspca_dev)
 262 {
 263         struct sd *sd = (struct sd *) gspca_dev;
 264         int err;
 265
 266         /* Prepare the sensor for start */
 267         err = sd->sensor->start(sd);
 268         if (err < 0)
 269                 goto out;
 270
 271         /* Start isochronous streaming */
 272         err = stv06xx_write_bridge(sd, STV_ISO_ENABLE, 1);
 273
 274 out:
 275         if (err < 0)
 276                 PDEBUG(D_STREAM, "Starting stream failed");
 277         else
 278                 PDEBUG(D_STREAM, "Started streaming");
 279
 280         return (err < 0) ? err : 0;
 281 }
 282
 283 static void stv06xx_stopN(struct gspca_dev *gspca_dev)
 284 {
 285         int err;
 286         struct sd *sd = (struct sd *) gspca_dev;
 287
 288         /* stop ISO-streaming */
 289         err = stv06xx_write_bridge(sd, STV_ISO_ENABLE, 0);
 290         if (err < 0)
 291                 goto out;
 292
 293         err = sd->sensor->stop(sd);
 294
 295 out:
 296         if (err < 0)
 297                 PDEBUG(D_STREAM, "Failed to stop stream");
 298         else
 299                 PDEBUG(D_STREAM, "Stopped streaming");
 300 }
 301
 302 /*
 303  * Analyse an USB packet of the data stream and store it appropriately.
 304  * Each packet contains an integral number of chunks. Each chunk has
 305  * 2-bytes identification, followed by 2-bytes that describe the chunk
 306  * length. Known/guessed chunk identifications are:
 307  * 8001/8005/C001/C005 - Begin new frame
 308  * 8002/8006/C002/C006 - End frame
 309  * 0200/4200           - Contains actual image data, bayer or compressed
 310  * 0005                - 11 bytes of unknown data
 311  * 0100                - 2 bytes of unknown data
 312  * The 0005 and 0100 chunks seem to appear only in compressed stream.
 313  */
 314 static void stv06xx_pkt_scan(struct gspca_dev *gspca_dev,
 315                         u8 *data,                       /* isoc packet */
 316                         int len)                        /* iso packet length */
 317 {
 318         struct sd *sd = (struct sd *) gspca_dev;
 319
 320         PDEBUG(D_PACK, "Packet of length %d arrived", len);
 321
 322         /* A packet may contain several frames
 323            loop until the whole packet is reached */
 324         while (len) {
 325                 int id, chunk_len;
 326
 327                 if (len < 4) {
 328                         PDEBUG(D_PACK, "Packet is smaller than 4 bytes");
 329                         return;
 330                 }
 331
 332                 /* Capture the id */
 333                 id = (data[0] << 8) | data[1];
 334
 335                 /* Capture the chunk length */
 336                 chunk_len = (data[2] << 8) | data[3];
 337                 PDEBUG(D_PACK, "Chunk id: %x, length: %d", id, chunk_len);
 338
 339                 data += 4;
 340                 len -= 4;
 341
 342                 if (len < chunk_len) {
 343                         PDEBUG(D_ERR, "URB packet length is smaller"
 344                                 " than the specified chunk length");
 345                         gspca_dev->last_packet_type = DISCARD_PACKET;
 346                         return;
 347                 }
 348
 349                 /* First byte seem to be 02=data 2nd byte is unknown??? */
 350                 if (sd->bridge == BRIDGE_ST6422 && (id & 0xFF00) == 0x0200)
 351                         goto frame_data;
 352
 353                 switch (id) {
 354                 case 0x0200:
 355                 case 0x4200:
 356 frame_data:
 357                         PDEBUG(D_PACK, "Frame data packet detected");
 358
 359                         if (sd->to_skip) {
 360                                 int skip = (sd->to_skip < chunk_len) ?
 361                                             sd->to_skip : chunk_len;
 362                                 data += skip;
 363                                 len -= skip;
 364                                 chunk_len -= skip;
 365                                 sd->to_skip -= skip;
 366                         }
 367
 368                         gspca_frame_add(gspca_dev, INTER_PACKET,
 369                                         data, chunk_len);
 370                         break;
 371
 372                 case 0x8001:
 373                 case 0x8005:
 374                 case 0xc001:
 375                 case 0xc005:
 376                         PDEBUG(D_PACK, "Starting new frame");
 377
 378                         /* Create a new frame, chunk length should be zero */
 379                         gspca_frame_add(gspca_dev, FIRST_PACKET,
 380                                         NULL, 0);
 381
 382                         if (sd->bridge == BRIDGE_ST6422)
 383                                 sd->to_skip = gspca_dev->width * 4;
 384
 385                         if (chunk_len)
 386                                 PDEBUG(D_ERR, "Chunk length is "
 387                                               "non-zero on a SOF");
 388                         break;
 389
 390                 case 0x8002:
 391                 case 0x8006:
 392                 case 0xc002:
 393                         PDEBUG(D_PACK, "End of frame detected");
 394
 395                         /* Complete the last frame (if any) */
 396                         gspca_frame_add(gspca_dev, LAST_PACKET,
 397                                         NULL, 0);
 398
 399                         if (chunk_len)
 400                                 PDEBUG(D_ERR, "Chunk length is "
 401                                               "non-zero on a EOF");
 402                         break;
 403
 404                 case 0x0005:
 405                         PDEBUG(D_PACK, "Chunk 0x005 detected");
 406                         /* Unknown chunk with 11 bytes of data,
 407                            occurs just before end of each frame
 408                            in compressed mode */
 409                         break;
 410
 411                 case 0x0100:
 412                         PDEBUG(D_PACK, "Chunk 0x0100 detected");
 413                         /* Unknown chunk with 2 bytes of data,
 414                            occurs 2-3 times per USB interrupt */
 415                         break;
 416                 case 0x42ff:
 417                         PDEBUG(D_PACK, "Chunk 0x42ff detected");
 418                         /* Special chunk seen sometimes on the ST6422 */
 419                         break;
 420                 default:
 421                         PDEBUG(D_PACK, "Unknown chunk 0x%04x detected", id);
 422                         /* Unknown chunk */
 423                 }
 424                 data    += chunk_len;
 425                 len     -= chunk_len;
 426         }
 427 }
 428
 429 static int stv06xx_config(struct gspca_dev *gspca_dev,
 430                           const struct usb_device_id *id);
 431
 432 /* sub-driver description */
 433 static const struct sd_desc sd_desc = {
 434         .name = MODULE_NAME,
 435         .config = stv06xx_config,
 436         .init = stv06xx_init,
 437         .start = stv06xx_start,
 438         .stopN = stv06xx_stopN,
 439         .pkt_scan = stv06xx_pkt_scan
 440 };
 441
 442 /* This function is called at probe time */
 443 static int stv06xx_config(struct gspca_dev *gspca_dev,
 444                           const struct usb_device_id *id)
 445 {
 446         struct sd *sd = (struct sd *) gspca_dev;
 447         struct cam *cam;
 448
 449         PDEBUG(D_PROBE, "Configuring camera");
 450
 451         cam = &gspca_dev->cam;
 452         sd->desc = sd_desc;
 453         sd->bridge = id->driver_info;
 454         gspca_dev->sd_desc = &sd->desc;
 455
 456         if (dump_bridge)
 457                 stv06xx_dump_bridge(sd);
 458
 459         sd->sensor = &stv06xx_sensor_st6422;
 460         if (!sd->sensor->probe(sd))
 461                 return 0;
 462
 463         sd->sensor = &stv06xx_sensor_vv6410;
 464         if (!sd->sensor->probe(sd))
 465                 return 0;
 466
 467         sd->sensor = &stv06xx_sensor_hdcs1x00;
 468         if (!sd->sensor->probe(sd))
 469                 return 0;
 470
 471         sd->sensor = &stv06xx_sensor_hdcs1020;
 472         if (!sd->sensor->probe(sd))
 473                 return 0;
 474
 475         sd->sensor = &stv06xx_sensor_pb0100;
 476         if (!sd->sensor->probe(sd))
 477                 return 0;
 478
 479         sd->sensor = NULL;
 480         return -ENODEV;
 481 }
 482
 483
 484
 485 /* -- module initialisation -- */
 486 static const __devinitdata struct usb_device_id device_table[] = {
 487         /* QuickCam Express */
 488         {USB_DEVICE(0x046d, 0x0840), .driver_info = BRIDGE_STV600 },
 489         /* LEGO cam / QuickCam Web */
 490         {USB_DEVICE(0x046d, 0x0850), .driver_info = BRIDGE_STV610 },
 491         /* Dexxa WebCam USB */
 492         {USB_DEVICE(0x046d, 0x0870), .driver_info = BRIDGE_STV602 },
 493         /* QuickCam Messenger */
 494         {USB_DEVICE(0x046D, 0x08F0), .driver_info = BRIDGE_ST6422 },
 495         /* QuickCam Communicate */
 496         {USB_DEVICE(0x046D, 0x08F5), .driver_info = BRIDGE_ST6422 },
 497         /* QuickCam Messenger (new) */
 498         {USB_DEVICE(0x046D, 0x08F6), .driver_info = BRIDGE_ST6422 },
 499         /* QuickCam Messenger (new) */
 500         {USB_DEVICE(0x046D, 0x08DA), .driver_info = BRIDGE_ST6422 },
 501         {}
 502 };
 503 MODULE_DEVICE_TABLE(usb, device_table);
 504
 505 /* -- device connect -- */
 506 static int sd_probe(struct usb_interface *intf,
 507                         const struct usb_device_id *id)
 508 {
 509         PDEBUG(D_PROBE, "Probing for a stv06xx device");
 510         return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
 511                                THIS_MODULE);
 512 }
 513
 514 static void sd_disconnect(struct usb_interface *intf)
 515 {
 516         struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
 517         struct sd *sd = (struct sd *) gspca_dev;
 518         PDEBUG(D_PROBE, "Disconnecting the stv06xx device");
 519
 520         if (sd->sensor->disconnect)
 521                 sd->sensor->disconnect(sd);
 522         gspca_disconnect(intf);
 523 }
 524
 525 static struct usb_driver sd_driver = {
 526         .name = MODULE_NAME,
 527         .id_table = device_table,
 528         .probe = sd_probe,
 529         .disconnect = sd_disconnect,
 530 #ifdef CONFIG_PM
 531         .suspend = gspca_suspend,
 532         .resume = gspca_resume,
 533 #endif
 534 };
 535
 536 /* -- module insert / remove -- */
 537 static int __init sd_mod_init(void)
 538 {
 539         int ret;
 540         ret = usb_register(&sd_driver);
 541         if (ret < 0)
 542                 return ret;
 543         PDEBUG(D_PROBE, "registered");
 544         return 0;
 545 }
 546 static void __exit sd_mod_exit(void)
 547 {
 548         usb_deregister(&sd_driver);
 549         PDEBUG(D_PROBE, "deregistered");
 550 }
 551
 552 module_init(sd_mod_init);
 553 module_exit(sd_mod_exit);
 554
 555 module_param(dump_bridge, bool, S_IRUGO | S_IWUSR);
 556 MODULE_PARM_DESC(dump_bridge, "Dumps all usb bridge registers at startup");
 557
 558 module_param(dump_sensor, bool, S_IRUGO | S_IWUSR);
 559 MODULE_PARM_DESC(dump_sensor, "Dumps all sensor registers at startup");