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