SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/media/video/gspca/m5602/m5602_core.c

   1 /*
   2  * USB Driver for ALi m5602 based webcams
   3  *
   4  * Copyright (C) 2008 Erik Andren
   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 int dump_bridge;
  28 int dump_sensor;
  29 unsigned int m5602_debug;
  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 /* sub-driver description, the ctrl and nctrl is filled at probe time */
  39 static struct sd_desc sd_desc = {
  40         .name           = MODULE_NAME,
  41         .config         = m5602_configure,
  42         .init           = m5602_init,
  43         .start          = m5602_start_transfer,
  44         .stopN          = m5602_stop_transfer,
  45         .pkt_scan       = m5602_urb_complete
  46 };
  47
  48 /* Reads a byte from the m5602 */
  49 int m5602_read_bridge(struct sd *sd, u8 address, u8 *i2c_data)
  50 {
  51         int err;
  52         struct usb_device *udev = sd->gspca_dev.dev;
  53         __u8 *buf = sd->gspca_dev.usb_buf;
  54
  55         err = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
  56                               0x04, 0xc0, 0x14,
  57                               0x8100 + address, buf,
  58                               1, M5602_URB_MSG_TIMEOUT);
  59         *i2c_data = buf[0];
  60
  61         PDEBUG(DBG_TRACE, "Reading bridge register 0x%x containing 0x%x",
  62                address, *i2c_data);
  63
  64         /* usb_control_msg(...) returns the number of bytes sent upon success,
  65         mask that and return zero upon success instead*/
  66         return (err < 0) ? err : 0;
  67 }
  68
  69 /* Writes a byte to to the m5602 */
  70 int m5602_write_bridge(struct sd *sd, u8 address, u8 i2c_data)
  71 {
  72         int err;
  73         struct usb_device *udev = sd->gspca_dev.dev;
  74         __u8 *buf = sd->gspca_dev.usb_buf;
  75
  76         PDEBUG(DBG_TRACE, "Writing bridge register 0x%x with 0x%x",
  77                address, i2c_data);
  78
  79         memcpy(buf, bridge_urb_skeleton,
  80                sizeof(bridge_urb_skeleton));
  81         buf[1] = address;
  82         buf[3] = i2c_data;
  83
  84         err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  85                                 0x04, 0x40, 0x19,
  86                                 0x0000, buf,
  87                                 4, M5602_URB_MSG_TIMEOUT);
  88
  89         /* usb_control_msg(...) returns the number of bytes sent upon success,
  90            mask that and return zero upon success instead */
  91         return (err < 0) ? err : 0;
  92 }
  93
  94 /* Dump all the registers of the m5602 bridge,
  95    unfortunately this breaks the camera until it's power cycled */
  96 static void m5602_dump_bridge(struct sd *sd)
  97 {
  98         int i;
  99         for (i = 0; i < 0x80; i++) {
 100                 unsigned char val = 0;
 101                 m5602_read_bridge(sd, i, &val);
 102                 info("ALi m5602 address 0x%x contains 0x%x", i, val);
 103         }
 104         info("Warning: The camera probably won't work until it's power cycled");
 105 }
 106
 107 int m5602_probe_sensor(struct sd *sd)
 108 {
 109         /* Try the po1030 */
 110         sd->sensor = &po1030;
 111         if (!sd->sensor->probe(sd)) {
 112                 sd_desc.ctrls = po1030.ctrls;
 113                 sd_desc.nctrls = po1030.nctrls;
 114                 return 0;
 115         }
 116
 117         /* Try the mt9m111 sensor */
 118         sd->sensor = &mt9m111;
 119         if (!sd->sensor->probe(sd)) {
 120                 sd_desc.ctrls = mt9m111.ctrls;
 121                 sd_desc.nctrls = mt9m111.nctrls;
 122                 return 0;
 123         }
 124
 125         /* Try the s5k4aa */
 126         sd->sensor = &s5k4aa;
 127         if (!sd->sensor->probe(sd)) {
 128                 sd_desc.ctrls = s5k4aa.ctrls;
 129                 sd_desc.nctrls = s5k4aa.nctrls;
 130                 return 0;
 131         }
 132
 133         /* Try the ov9650 */
 134         sd->sensor = &ov9650;
 135         if (!sd->sensor->probe(sd)) {
 136                 sd_desc.ctrls = ov9650.ctrls;
 137                 sd_desc.nctrls = ov9650.nctrls;
 138                 return 0;
 139         }
 140
 141         /* Try the s5k83a */
 142         sd->sensor = &s5k83a;
 143         if (!sd->sensor->probe(sd)) {
 144                 sd_desc.ctrls = s5k83a.ctrls;
 145                 sd_desc.nctrls = s5k83a.nctrls;
 146                 return 0;
 147         }
 148
 149
 150         /* More sensor probe function goes here */
 151         info("Failed to find a sensor");
 152         sd->sensor = NULL;
 153         return -ENODEV;
 154 }
 155
 156 int m5602_init(struct gspca_dev *gspca_dev)
 157 {
 158         struct sd *sd = (struct sd *) gspca_dev;
 159         int err;
 160
 161         PDEBUG(DBG_TRACE, "Initializing ALi m5602 webcam");
 162         /* Run the init sequence */
 163         err = sd->sensor->init(sd);
 164
 165         return err;
 166 }
 167
 168 void m5602_start_transfer(struct gspca_dev *gspca_dev)
 169 {
 170         struct sd *sd = (struct sd *) gspca_dev;
 171         __u8 *buf = sd->gspca_dev.usb_buf;
 172
 173         /* Send start command to the camera */
 174         const u8 buffer[4] = {0x13, 0xf9, 0x0f, 0x01};
 175         memcpy(buf, buffer, sizeof(buffer));
 176         usb_control_msg(gspca_dev->dev, usb_sndctrlpipe(gspca_dev->dev, 0),
 177                         0x04, 0x40, 0x19, 0x0000, buf,
 178                         4, M5602_URB_MSG_TIMEOUT);
 179
 180         PDEBUG(DBG_V4L2, "Transfer started");
 181 }
 182
 183 void m5602_urb_complete(struct gspca_dev *gspca_dev, struct gspca_frame *frame,
 184                         __u8 *data, int len)
 185 {
 186         struct sd *sd = (struct sd *) gspca_dev;
 187
 188         if (len < 6) {
 189                 PDEBUG(DBG_DATA, "Packet is less than 6 bytes");
 190                 return;
 191         }
 192
 193         /* Frame delimiter: ff xx xx xx ff ff */
 194         if (data[0] == 0xff && data[4] == 0xff && data[5] == 0xff &&
 195             data[2] != sd->frame_id) {
 196                 PDEBUG(DBG_DATA, "Frame delimiter detected");
 197                 sd->frame_id = data[2];
 198
 199                 /* Remove the extra fluff appended on each header */
 200                 data += 6;
 201                 len -= 6;
 202
 203                 /* Complete the last frame (if any) */
 204                 frame = gspca_frame_add(gspca_dev, LAST_PACKET,
 205                                         frame, data, 0);
 206                 sd->frame_count++;
 207
 208                 /* Create a new frame */
 209                 gspca_frame_add(gspca_dev, FIRST_PACKET, frame, data, len);
 210
 211                 PDEBUG(DBG_V4L2, "Starting new frame %d",
 212                        sd->frame_count);
 213
 214         } else {
 215                 int cur_frame_len = frame->data_end - frame->data;
 216
 217                 /* Remove urb header */
 218                 data += 4;
 219                 len -= 4;
 220
 221                 if (cur_frame_len + len <= frame->v4l2_buf.length) {
 222                         PDEBUG(DBG_DATA, "Continuing frame %d copying %d bytes",
 223                                sd->frame_count, len);
 224
 225                         gspca_frame_add(gspca_dev, INTER_PACKET, frame,
 226                                         data, len);
 227                 } else if (frame->v4l2_buf.length - cur_frame_len > 0) {
 228                         /* Add the remaining data up to frame size */
 229                         gspca_frame_add(gspca_dev, INTER_PACKET, frame, data,
 230                                         frame->v4l2_buf.length - cur_frame_len);
 231                 }
 232         }
 233 }
 234
 235 void m5602_stop_transfer(struct gspca_dev *gspca_dev)
 236 {
 237         /* Is there are a command to stop a data transfer? */
 238 }
 239
 240 /* this function is called at probe time */
 241 int m5602_configure(struct gspca_dev *gspca_dev,
 242                            const struct usb_device_id *id)
 243 {
 244         struct sd *sd = (struct sd *) gspca_dev;
 245         struct cam *cam;
 246         int err;
 247
 248         PDEBUG(DBG_GSPCA, "m5602_configure start");
 249         cam = &gspca_dev->cam;
 250         cam->epaddr = M5602_ISOC_ENDPOINT_ADDR;
 251
 252         if (dump_bridge)
 253                 m5602_dump_bridge(sd);
 254
 255         /* Probe sensor */
 256         err = m5602_probe_sensor(sd);
 257         if (err)
 258                 goto fail;
 259
 260         PDEBUG(DBG_GSPCA, "m5602_configure end");
 261         return 0;
 262
 263 fail:
 264         PDEBUG(DBG_GSPCA, "m5602_configure failed");
 265         cam->cam_mode = NULL;
 266         cam->nmodes = 0;
 267
 268         return err;
 269 }
 270
 271 static int m5602_probe(struct usb_interface *intf,
 272                        const struct usb_device_id *id)
 273 {
 274         return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
 275                                THIS_MODULE);
 276 }
 277
 278 static struct usb_driver sd_driver = {
 279         .name = MODULE_NAME,
 280         .id_table = m5602_table,
 281         .probe = m5602_probe,
 282 #ifdef CONFIG_PM
 283         .suspend = gspca_suspend,
 284         .resume = gspca_resume,
 285 #endif
 286         .disconnect = gspca_disconnect
 287 };
 288
 289 /* -- module insert / remove -- */
 290 static int __init mod_m5602_init(void)
 291 {
 292         if (usb_register(&sd_driver) < 0)
 293                 return -1;
 294         PDEBUG(D_PROBE, "m5602 module registered");
 295         return 0;
 296 }
 297 static void __exit mod_m5602_exit(void)
 298 {
 299         usb_deregister(&sd_driver);
 300         PDEBUG(D_PROBE, "m5602 module deregistered");
 301 }
 302
 303 module_init(mod_m5602_init);
 304 module_exit(mod_m5602_exit);
 305
 306 MODULE_AUTHOR(DRIVER_AUTHOR);
 307 MODULE_DESCRIPTION(DRIVER_DESC);
 308 MODULE_LICENSE("GPL");
 309 module_param_named(debug, m5602_debug, int, S_IRUGO | S_IWUSR);
 310 MODULE_PARM_DESC(debug, "toggles debug on/off");
 311
 312 module_param(force_sensor, int, S_IRUGO | S_IWUSR);
 313 MODULE_PARM_DESC(force_sensor,
 314                 "force detection of sensor, "
 315                 "1 = OV9650, 2 = S5K83A, 3 = S5K4AA, 4 = MT9M111, 5 = PO1030");
 316
 317 module_param(dump_bridge, bool, S_IRUGO | S_IWUSR);
 318 MODULE_PARM_DESC(dump_bridge, "Dumps all usb bridge registers at startup");
 319
 320 module_param(dump_sensor, bool, S_IRUGO | S_IWUSR);
 321 MODULE_PARM_DESC(dump_sensor, "Dumps all usb sensor registers "
 322                 "at startup providing a sensor is found");