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