release/src-rt-6.x.4708/linux/linux-2.6.36/drivers/media/video/gspca/m5602/m5602_core.c

   1  /*
   2  * USB Driver for ALi m5602 based webcams
   3  *
   4  * Copyright (C) 2008 Erik Andrén
   5  * Copyright (C) 2007 Ilyes Gouta. Based on the m5603x Linux Driver Project.
   6  * Copyright (C) 2005 m5603x Linux Driver Project <m5602@x3ng.com.br>
   7  *
   8  * Portions of code to USB interface and ALi driver software,
   9  * Copyright (c) 2006 Willem Duinker
  10  * v4l2 interface modeled after the V4L2 driver
  11  * for SN9C10x PC Camera Controllers
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License as
  15  * published by the Free Software Foundation, version 2.
  16  *
  17  */
  18
  19 #include "m5602_ov9650.h"
  20 #include "m5602_ov7660.h"
  21 #include "m5602_mt9m111.h"
  22 #include "m5602_po1030.h"
  23 #include "m5602_s5k83a.h"
  24 #include "m5602_s5k4aa.h"
  25
  26 /* Kernel module parameters */
  27 int force_sensor;
  28 static int dump_bridge;
  29 int dump_sensor;
  30
  31 static const __devinitdata struct usb_device_id m5602_table[] = {
  32         {USB_DEVICE(0x0402, 0x5602)},
  33         {}
  34 };
  35
  36 MODULE_DEVICE_TABLE(usb, m5602_table);
  37
  38 /* Reads a byte from the m5602 */
  39 int m5602_read_bridge(struct sd *sd, const u8 address, u8 *i2c_data)
  40 {
  41         int err;
  42         struct usb_device *udev = sd->gspca_dev.dev;
  43         __u8 *buf = sd->gspca_dev.usb_buf;
  44
  45         err = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
  46                               0x04, 0xc0, 0x14,
  47                               0x8100 + address, buf,
  48                               1, M5602_URB_MSG_TIMEOUT);
  49         *i2c_data = buf[0];
  50
  51         PDEBUG(D_CONF, "Reading bridge register 0x%x containing 0x%x",
  52                address, *i2c_data);
  53
  54         /* usb_control_msg(...) returns the number of bytes sent upon success,
  55         mask that and return zero instead*/
  56         return (err < 0) ? err : 0;
  57 }
  58
  59 /* Writes a byte to the m5602 */
  60 int m5602_write_bridge(struct sd *sd, const u8 address, const u8 i2c_data)
  61 {
  62         int err;
  63         struct usb_device *udev = sd->gspca_dev.dev;
  64         __u8 *buf = sd->gspca_dev.usb_buf;
  65
  66         PDEBUG(D_CONF, "Writing bridge register 0x%x with 0x%x",
  67                address, i2c_data);
  68
  69         memcpy(buf, bridge_urb_skeleton,
  70                sizeof(bridge_urb_skeleton));
  71         buf[1] = address;
  72         buf[3] = i2c_data;
  73
  74         err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  75                                 0x04, 0x40, 0x19,
  76                                 0x0000, buf,
  77                                 4, M5602_URB_MSG_TIMEOUT);
  78
  79         /* usb_control_msg(...) returns the number of bytes sent upon success,
  80            mask that and return zero instead */
  81         return (err < 0) ? err : 0;
  82 }
  83
  84 static int m5602_wait_for_i2c(struct sd *sd)
  85 {
  86         int err;
  87         u8 data;
  88
  89         do {
  90                 err = m5602_read_bridge(sd, M5602_XB_I2C_STATUS, &data);
  91         } while ((data & I2C_BUSY) && !err);
  92         return err;
  93 }
  94
  95 int m5602_read_sensor(struct sd *sd, const u8 address,
  96                        u8 *i2c_data, const u8 len)
  97 {
  98         int err, i;
  99
 100         if (!len || len > sd->sensor->i2c_regW)
 101                 return -EINVAL;
 102
 103         err = m5602_wait_for_i2c(sd);
 104         if (err < 0)
 105                 return err;
 106
 107         err = m5602_write_bridge(sd, M5602_XB_I2C_DEV_ADDR,
 108                                  sd->sensor->i2c_slave_id);
 109         if (err < 0)
 110                 return err;
 111
 112         err = m5602_write_bridge(sd, M5602_XB_I2C_REG_ADDR, address);
 113         if (err < 0)
 114                 return err;
 115
 116         /* Sensors with registers that are of only
 117            one byte width are differently read */
 118
 119         if (sd->sensor->i2c_regW == 1) {
 120                 err = m5602_write_bridge(sd, M5602_XB_I2C_CTRL, 1);
 121                 if (err < 0)
 122                         return err;
 123
 124                 err = m5602_write_bridge(sd, M5602_XB_I2C_CTRL, 0x08);
 125         } else {
 126                 err = m5602_write_bridge(sd, M5602_XB_I2C_CTRL, 0x18 + len);
 127         }
 128
 129         for (i = 0; (i < len) && !err; i++) {
 130                 err = m5602_wait_for_i2c(sd);
 131                 if (err < 0)
 132                         return err;
 133
 134                 err = m5602_read_bridge(sd, M5602_XB_I2C_DATA, &(i2c_data[i]));
 135
 136                 PDEBUG(D_CONF, "Reading sensor register "
 137                                "0x%x containing 0x%x ", address, *i2c_data);
 138         }
 139         return err;
 140 }
 141
 142 int m5602_write_sensor(struct sd *sd, const u8 address,
 143                         u8 *i2c_data, const u8 len)
 144 {
 145         int err, i;
 146         u8 *p;
 147         struct usb_device *udev = sd->gspca_dev.dev;
 148         __u8 *buf = sd->gspca_dev.usb_buf;
 149
 150         /* No sensor with a data width larger than 16 bits has yet been seen */
 151         if (len > sd->sensor->i2c_regW || !len)
 152                 return -EINVAL;
 153
 154         memcpy(buf, sensor_urb_skeleton,
 155                sizeof(sensor_urb_skeleton));
 156
 157         buf[11] = sd->sensor->i2c_slave_id;
 158         buf[15] = address;
 159
 160         /* Special case larger sensor writes */
 161         p = buf + 16;
 162
 163         /* Copy a four byte write sequence for each byte to be written to */
 164         for (i = 0; i < len; i++) {
 165                 memcpy(p, sensor_urb_skeleton + 16, 4);
 166                 p[3] = i2c_data[i];
 167                 p += 4;
 168                 PDEBUG(D_CONF, "Writing sensor register 0x%x with 0x%x",
 169                        address, i2c_data[i]);
 170         }
 171
 172         /* Copy the tailer */
 173         memcpy(p, sensor_urb_skeleton + 20, 4);
 174
 175         /* Set the total length */
 176         p[3] = 0x10 + len;
 177
 178         err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
 179                               0x04, 0x40, 0x19,
 180                               0x0000, buf,
 181                               20 + len * 4, M5602_URB_MSG_TIMEOUT);
 182
 183         return (err < 0) ? err : 0;
 184 }
 185
 186 /* Dump all the registers of the m5602 bridge,
 187    unfortunately this breaks the camera until it's power cycled */
 188 static void m5602_dump_bridge(struct sd *sd)
 189 {
 190         int i;
 191         for (i = 0; i < 0x80; i++) {
 192                 unsigned char val = 0;
 193                 m5602_read_bridge(sd, i, &val);
 194                 info("ALi m5602 address 0x%x contains 0x%x", i, val);
 195         }
 196         info("Warning: The ALi m5602 webcam probably won't work "
 197                 "until it's power cycled");
 198 }
 199
 200 static int m5602_probe_sensor(struct sd *sd)
 201 {
 202         /* Try the po1030 */
 203         sd->sensor = &po1030;
 204         if (!sd->sensor->probe(sd))
 205                 return 0;
 206
 207         /* Try the mt9m111 sensor */
 208         sd->sensor = &mt9m111;
 209         if (!sd->sensor->probe(sd))
 210                 return 0;
 211
 212         /* Try the s5k4aa */
 213         sd->sensor = &s5k4aa;
 214         if (!sd->sensor->probe(sd))
 215                 return 0;
 216
 217         /* Try the ov9650 */
 218         sd->sensor = &ov9650;
 219         if (!sd->sensor->probe(sd))
 220                 return 0;
 221
 222         /* Try the ov7660 */
 223         sd->sensor = &ov7660;
 224         if (!sd->sensor->probe(sd))
 225                 return 0;
 226
 227         /* Try the s5k83a */
 228         sd->sensor = &s5k83a;
 229         if (!sd->sensor->probe(sd))
 230                 return 0;
 231
 232         /* More sensor probe function goes here */
 233         info("Failed to find a sensor");
 234         sd->sensor = NULL;
 235         return -ENODEV;
 236 }
 237
 238 static int m5602_configure(struct gspca_dev *gspca_dev,
 239                            const struct usb_device_id *id);
 240
 241 static int m5602_init(struct gspca_dev *gspca_dev)
 242 {
 243         struct sd *sd = (struct sd *) gspca_dev;
 244         int err;
 245
 246         PDEBUG(D_CONF, "Initializing ALi m5602 webcam");
 247         /* Run the init sequence */
 248         err = sd->sensor->init(sd);
 249
 250         return err;
 251 }
 252
 253 static int m5602_start_transfer(struct gspca_dev *gspca_dev)
 254 {
 255         struct sd *sd = (struct sd *) gspca_dev;
 256         __u8 *buf = sd->gspca_dev.usb_buf;
 257         int err;
 258
 259         /* Send start command to the camera */
 260         const u8 buffer[4] = {0x13, 0xf9, 0x0f, 0x01};
 261
 262         if (sd->sensor->start)
 263                 sd->sensor->start(sd);
 264
 265         memcpy(buf, buffer, sizeof(buffer));
 266         err = usb_control_msg(gspca_dev->dev,
 267                               usb_sndctrlpipe(gspca_dev->dev, 0),
 268                               0x04, 0x40, 0x19, 0x0000, buf,
 269                               sizeof(buffer), M5602_URB_MSG_TIMEOUT);
 270
 271         PDEBUG(D_STREAM, "Transfer started");
 272         return (err < 0) ? err : 0;
 273 }
 274
 275 static void m5602_urb_complete(struct gspca_dev *gspca_dev,
 276                                 u8 *data, int len)
 277 {
 278         struct sd *sd = (struct sd *) gspca_dev;
 279
 280         if (len < 6) {
 281                 PDEBUG(D_PACK, "Packet is less than 6 bytes");
 282                 return;
 283         }
 284
 285         /* Frame delimiter: ff xx xx xx ff ff */
 286         if (data[0] == 0xff && data[4] == 0xff && data[5] == 0xff &&
 287             data[2] != sd->frame_id) {
 288                 PDEBUG(D_FRAM, "Frame delimiter detected");
 289                 sd->frame_id = data[2];
 290
 291                 /* Remove the extra fluff appended on each header */
 292                 data += 6;
 293                 len -= 6;
 294
 295                 /* Complete the last frame (if any) */
 296                 gspca_frame_add(gspca_dev, LAST_PACKET,
 297                                 NULL, 0);
 298                 sd->frame_count++;
 299
 300                 /* Create a new frame */
 301                 gspca_frame_add(gspca_dev, FIRST_PACKET, data, len);
 302
 303                 PDEBUG(D_FRAM, "Starting new frame %d",
 304                        sd->frame_count);
 305
 306         } else {
 307                 int cur_frame_len;
 308
 309                 cur_frame_len = gspca_dev->image_len;
 310                 /* Remove urb header */
 311                 data += 4;
 312                 len -= 4;
 313
 314                 if (cur_frame_len + len <= gspca_dev->frsz) {
 315                         PDEBUG(D_FRAM, "Continuing frame %d copying %d bytes",
 316                                sd->frame_count, len);
 317
 318                         gspca_frame_add(gspca_dev, INTER_PACKET,
 319                                         data, len);
 320                 } else {
 321                         /* Add the remaining data up to frame size */
 322                         gspca_frame_add(gspca_dev, INTER_PACKET, data,
 323                                     gspca_dev->frsz - cur_frame_len);
 324                 }
 325         }
 326 }
 327
 328 static void m5602_stop_transfer(struct gspca_dev *gspca_dev)
 329 {
 330         struct sd *sd = (struct sd *) gspca_dev;
 331
 332         /* Run the sensor specific end transfer sequence */
 333         if (sd->sensor->stop)
 334                 sd->sensor->stop(sd);
 335 }
 336
 337 /* sub-driver description, the ctrl and nctrl is filled at probe time */
 338 static struct sd_desc sd_desc = {
 339         .name           = MODULE_NAME,
 340         .config         = m5602_configure,
 341         .init           = m5602_init,
 342         .start          = m5602_start_transfer,
 343         .stopN          = m5602_stop_transfer,
 344         .pkt_scan       = m5602_urb_complete
 345 };
 346
 347 /* this function is called at probe time */
 348 static int m5602_configure(struct gspca_dev *gspca_dev,
 349                            const struct usb_device_id *id)
 350 {
 351         struct sd *sd = (struct sd *) gspca_dev;
 352         struct cam *cam;
 353         int err;
 354
 355         cam = &gspca_dev->cam;
 356         sd->desc = &sd_desc;
 357
 358         if (dump_bridge)
 359                 m5602_dump_bridge(sd);
 360
 361         /* Probe sensor */
 362         err = m5602_probe_sensor(sd);
 363         if (err)
 364                 goto fail;
 365
 366         return 0;
 367
 368 fail:
 369         PDEBUG(D_ERR, "ALi m5602 webcam failed");
 370         cam->cam_mode = NULL;
 371         cam->nmodes = 0;
 372
 373         return err;
 374 }
 375
 376 static int m5602_probe(struct usb_interface *intf,
 377                        const struct usb_device_id *id)
 378 {
 379         return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
 380                                THIS_MODULE);
 381 }
 382
 383 static void m5602_disconnect(struct usb_interface *intf)
 384 {
 385         struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
 386         struct sd *sd = (struct sd *) gspca_dev;
 387
 388         if (sd->sensor->disconnect)
 389                 sd->sensor->disconnect(sd);
 390
 391         gspca_disconnect(intf);
 392 }
 393
 394 static struct usb_driver sd_driver = {
 395         .name = MODULE_NAME,
 396         .id_table = m5602_table,
 397         .probe = m5602_probe,
 398 #ifdef CONFIG_PM
 399         .suspend = gspca_suspend,
 400         .resume = gspca_resume,
 401 #endif
 402         .disconnect = m5602_disconnect
 403 };
 404
 405 /* -- module insert / remove -- */
 406 static int __init mod_m5602_init(void)
 407 {
 408         int ret;
 409         ret = usb_register(&sd_driver);
 410         if (ret < 0)
 411                 return ret;
 412         PDEBUG(D_PROBE, "registered");
 413         return 0;
 414 }
 415
 416 static void __exit mod_m5602_exit(void)
 417 {
 418         usb_deregister(&sd_driver);
 419         PDEBUG(D_PROBE, "deregistered");
 420 }
 421
 422 module_init(mod_m5602_init);
 423 module_exit(mod_m5602_exit);
 424
 425 MODULE_AUTHOR(DRIVER_AUTHOR);
 426 MODULE_DESCRIPTION(DRIVER_DESC);
 427 MODULE_LICENSE("GPL");
 428 module_param(force_sensor, int, S_IRUGO | S_IWUSR);
 429 MODULE_PARM_DESC(force_sensor,
 430                 "forces detection of a sensor, "
 431                 "1 = OV9650, 2 = S5K83A, 3 = S5K4AA, "
 432                 "4 = MT9M111, 5 = PO1030, 6 = OV7660");
 433
 434 module_param(dump_bridge, bool, S_IRUGO | S_IWUSR);
 435 MODULE_PARM_DESC(dump_bridge, "Dumps all usb bridge registers at startup");
 436
 437 module_param(dump_sensor, bool, S_IRUGO | S_IWUSR);
 438 MODULE_PARM_DESC(dump_sensor, "Dumps all usb sensor registers "
 439                 "at startup providing a sensor is found");