drivers/media/video/gspca/sq905c.c

   1 /*
   2  * SQ905C subdriver
   3  *
   4  * Copyright (C) 2009 Theodore Kilgore
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19  */
  20
  21 /*
  22  *
  23  * This driver uses work done in
  24  * libgphoto2/camlibs/digigr8, Copyright (C) Theodore Kilgore.
  25  *
  26  * This driver has also used as a base the sq905c driver
  27  * and may contain code fragments from it.
  28  */
  29
  30 #define MODULE_NAME "sq905c"
  31
  32 #include <linux/workqueue.h>
  33 #include "gspca.h"
  34
  35 MODULE_AUTHOR("Theodore Kilgore <kilgota@auburn.edu>");
  36 MODULE_DESCRIPTION("GSPCA/SQ905C USB Camera Driver");
  37 MODULE_LICENSE("GPL");
  38
  39 /* Default timeouts, in ms */
  40 #define SQ905C_CMD_TIMEOUT 500
  41 #define SQ905C_DATA_TIMEOUT 1000
  42
  43 /* Maximum transfer size to use. */
  44 #define SQ905C_MAX_TRANSFER 0x8000
  45
  46 #define FRAME_HEADER_LEN 0x50
  47
  48 /* Commands. These go in the "value" slot. */
  49 #define SQ905C_CLEAR   0xa0             /* clear everything */
  50 #define SQ905C_GET_ID  0x14f4           /* Read version number */
  51 #define SQ905C_CAPTURE_LOW 0xa040       /* Starts capture at 160x120 */
  52 #define SQ905C_CAPTURE_MED 0x1440       /* Starts capture at 320x240 */
  53 #define SQ905C_CAPTURE_HI 0x2840        /* Starts capture at 320x240 */
  54
  55 /* For capture, this must go in the "index" slot. */
  56 #define SQ905C_CAPTURE_INDEX 0x110f
  57
  58 /* Structure to hold all of our device specific stuff */
  59 struct sd {
  60         struct gspca_dev gspca_dev;     /* !! must be the first item */
  61         const struct v4l2_pix_format *cap_mode;
  62         /* Driver stuff */
  63         struct work_struct work_struct;
  64         struct workqueue_struct *work_thread;
  65 };
  66
  67 /*
  68  * Most of these cameras will do 640x480 and 320x240. 160x120 works
  69  * in theory but gives very poor output. Therefore, not supported.
  70  * The 0x2770:0x9050 cameras have max resolution of 320x240.
  71  */
  72 static struct v4l2_pix_format sq905c_mode[] = {
  73         { 320, 240, V4L2_PIX_FMT_SQ905C, V4L2_FIELD_NONE,
  74                 .bytesperline = 320,
  75                 .sizeimage = 320 * 240,
  76                 .colorspace = V4L2_COLORSPACE_SRGB,
  77                 .priv = 0},
  78         { 640, 480, V4L2_PIX_FMT_SQ905C, V4L2_FIELD_NONE,
  79                 .bytesperline = 640,
  80                 .sizeimage = 640 * 480,
  81                 .colorspace = V4L2_COLORSPACE_SRGB,
  82                 .priv = 0}
  83 };
  84
  85 /* Send a command to the camera. */
  86 static int sq905c_command(struct gspca_dev *gspca_dev, u16 command, u16 index)
  87 {
  88         int ret;
  89
  90         ret = usb_control_msg(gspca_dev->dev,
  91                               usb_sndctrlpipe(gspca_dev->dev, 0),
  92                               USB_REQ_SYNCH_FRAME,                /* request */
  93                               USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
  94                               command, index, NULL, 0,
  95                               SQ905C_CMD_TIMEOUT);
  96         if (ret < 0) {
  97                 PDEBUG(D_ERR, "%s: usb_control_msg failed (%d)",
  98                         __func__, ret);
  99                 return ret;
 100         }
 101
 102         return 0;
 103 }
 104
 105 static int sq905c_read(struct gspca_dev *gspca_dev, u16 command, u16 index,
 106                        int size)
 107 {
 108         int ret;
 109
 110         ret = usb_control_msg(gspca_dev->dev,
 111                               usb_rcvctrlpipe(gspca_dev->dev, 0),
 112                               USB_REQ_SYNCH_FRAME,              /* request */
 113                               USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
 114                               command, index, gspca_dev->usb_buf, size,
 115                               SQ905C_CMD_TIMEOUT);
 116         if (ret < 0) {
 117                 PDEBUG(D_ERR, "%s: usb_control_msg failed (%d)",
 118                        __func__, ret);
 119                 return ret;
 120         }
 121
 122         return 0;
 123 }
 124
 125 /* This function is called as a workqueue function and runs whenever the camera
 126  * is streaming data. Because it is a workqueue function it is allowed to sleep
 127  * so we can use synchronous USB calls. To avoid possible collisions with other
 128  * threads attempting to use the camera's USB interface the gspca usb_lock is
 129  * used when performing the one USB control operation inside the workqueue,
 130  * which tells the camera to close the stream. In practice the only thing
 131  * which needs to be protected against is the usb_set_interface call that
 132  * gspca makes during stream_off. Otherwise the camera doesn't provide any
 133  * controls that the user could try to change.
 134  */
 135 static void sq905c_dostream(struct work_struct *work)
 136 {
 137         struct sd *dev = container_of(work, struct sd, work_struct);
 138         struct gspca_dev *gspca_dev = &dev->gspca_dev;
 139         int bytes_left; /* bytes remaining in current frame. */
 140         int data_len;   /* size to use for the next read. */
 141         int act_len;
 142         int packet_type;
 143         int ret;
 144         u8 *buffer;
 145
 146         buffer = kmalloc(SQ905C_MAX_TRANSFER, GFP_KERNEL | GFP_DMA);
 147         if (!buffer) {
 148                 PDEBUG(D_ERR, "Couldn't allocate USB buffer");
 149                 goto quit_stream;
 150         }
 151
 152         while (gspca_dev->present && gspca_dev->streaming) {
 153                 /* Request the header, which tells the size to download */
 154                 ret = usb_bulk_msg(gspca_dev->dev,
 155                                 usb_rcvbulkpipe(gspca_dev->dev, 0x81),
 156                                 buffer, FRAME_HEADER_LEN, &act_len,
 157                                 SQ905C_DATA_TIMEOUT);
 158                 PDEBUG(D_STREAM,
 159                         "Got %d bytes out of %d for header",
 160                         act_len, FRAME_HEADER_LEN);
 161                 if (ret < 0 || act_len < FRAME_HEADER_LEN)
 162                         goto quit_stream;
 163                 /* size is read from 4 bytes starting 0x40, little endian */
 164                 bytes_left = buffer[0x40]|(buffer[0x41]<<8)|(buffer[0x42]<<16)
 165                                         |(buffer[0x43]<<24);
 166                 PDEBUG(D_STREAM, "bytes_left = 0x%x", bytes_left);
 167                 /* We keep the header. It has other information, too. */
 168                 packet_type = FIRST_PACKET;
 169                 gspca_frame_add(gspca_dev, packet_type,
 170                                 buffer, FRAME_HEADER_LEN);
 171                 while (bytes_left > 0 && gspca_dev->present) {
 172                         data_len = bytes_left > SQ905C_MAX_TRANSFER ?
 173                                 SQ905C_MAX_TRANSFER : bytes_left;
 174                         ret = usb_bulk_msg(gspca_dev->dev,
 175                                 usb_rcvbulkpipe(gspca_dev->dev, 0x81),
 176                                 buffer, data_len, &act_len,
 177                                 SQ905C_DATA_TIMEOUT);
 178                         if (ret < 0 || act_len < data_len)
 179                                 goto quit_stream;
 180                         PDEBUG(D_STREAM,
 181                                 "Got %d bytes out of %d for frame",
 182                                 data_len, bytes_left);
 183                         bytes_left -= data_len;
 184                         if (bytes_left == 0)
 185                                 packet_type = LAST_PACKET;
 186                         else
 187                                 packet_type = INTER_PACKET;
 188                         gspca_frame_add(gspca_dev, packet_type,
 189                                         buffer, data_len);
 190                 }
 191         }
 192 quit_stream:
 193         if (gspca_dev->present) {
 194                 mutex_lock(&gspca_dev->usb_lock);
 195                 sq905c_command(gspca_dev, SQ905C_CLEAR, 0);
 196                 mutex_unlock(&gspca_dev->usb_lock);
 197         }
 198         kfree(buffer);
 199 }
 200
 201 /* This function is called at probe time just before sd_init */
 202 static int sd_config(struct gspca_dev *gspca_dev,
 203                 const struct usb_device_id *id)
 204 {
 205         struct cam *cam = &gspca_dev->cam;
 206         struct sd *dev = (struct sd *) gspca_dev;
 207         int ret;
 208
 209         PDEBUG(D_PROBE,
 210                 "SQ9050 camera detected"
 211                 " (vid/pid 0x%04X:0x%04X)", id->idVendor, id->idProduct);
 212
 213         ret = sq905c_command(gspca_dev, SQ905C_GET_ID, 0);
 214         if (ret < 0) {
 215                 PDEBUG(D_ERR, "Get version command failed");
 216                 return ret;
 217         }
 218
 219         ret = sq905c_read(gspca_dev, 0xf5, 0, 20);
 220         if (ret < 0) {
 221                 PDEBUG(D_ERR, "Reading version command failed");
 222                 return ret;
 223         }
 224         /* Note we leave out the usb id and the manufacturing date */
 225         PDEBUG(D_PROBE,
 226                "SQ9050 ID string: %02x - %02x %02x %02x %02x %02x %02x",
 227                 gspca_dev->usb_buf[3],
 228                 gspca_dev->usb_buf[14], gspca_dev->usb_buf[15],
 229                 gspca_dev->usb_buf[16], gspca_dev->usb_buf[17],
 230                 gspca_dev->usb_buf[18], gspca_dev->usb_buf[19]);
 231
 232         cam->cam_mode = sq905c_mode;
 233         cam->nmodes = 2;
 234         if (gspca_dev->usb_buf[15] == 0)
 235                 cam->nmodes = 1;
 236         /* We don't use the buffer gspca allocates so make it small. */
 237         cam->bulk_size = 32;
 238         cam->bulk = 1;
 239         INIT_WORK(&dev->work_struct, sq905c_dostream);
 240         return 0;
 241 }
 242
 243 /* called on streamoff with alt==0 and on disconnect */
 244 /* the usb_lock is held at entry - restore on exit */
 245 static void sd_stop0(struct gspca_dev *gspca_dev)
 246 {
 247         struct sd *dev = (struct sd *) gspca_dev;
 248
 249         /* wait for the work queue to terminate */
 250         mutex_unlock(&gspca_dev->usb_lock);
 251         /* This waits for sq905c_dostream to finish */
 252         destroy_workqueue(dev->work_thread);
 253         dev->work_thread = NULL;
 254         mutex_lock(&gspca_dev->usb_lock);
 255 }
 256
 257 /* this function is called at probe and resume time */
 258 static int sd_init(struct gspca_dev *gspca_dev)
 259 {
 260         int ret;
 261
 262         /* connect to the camera and reset it. */
 263         ret = sq905c_command(gspca_dev, SQ905C_CLEAR, 0);
 264         return ret;
 265 }
 266
 267 /* Set up for getting frames. */
 268 static int sd_start(struct gspca_dev *gspca_dev)
 269 {
 270         struct sd *dev = (struct sd *) gspca_dev;
 271         int ret;
 272
 273         dev->cap_mode = gspca_dev->cam.cam_mode;
 274         /* "Open the shutter" and set size, to start capture */
 275         switch (gspca_dev->width) {
 276         case 640:
 277                 PDEBUG(D_STREAM, "Start streaming at high resolution");
 278                 dev->cap_mode++;
 279                 ret = sq905c_command(gspca_dev, SQ905C_CAPTURE_HI,
 280                                                 SQ905C_CAPTURE_INDEX);
 281                 break;
 282         default: /* 320 */
 283         PDEBUG(D_STREAM, "Start streaming at medium resolution");
 284                 ret = sq905c_command(gspca_dev, SQ905C_CAPTURE_MED,
 285                                                 SQ905C_CAPTURE_INDEX);
 286         }
 287
 288         if (ret < 0) {
 289                 PDEBUG(D_ERR, "Start streaming command failed");
 290                 return ret;
 291         }
 292         /* Start the workqueue function to do the streaming */
 293         dev->work_thread = create_singlethread_workqueue(MODULE_NAME);
 294         queue_work(dev->work_thread, &dev->work_struct);
 295
 296         return 0;
 297 }
 298
 299 /* Table of supported USB devices */
 300 static const __devinitdata struct usb_device_id device_table[] = {
 301         {USB_DEVICE(0x2770, 0x905c)},
 302         {USB_DEVICE(0x2770, 0x9050)},
 303         {USB_DEVICE(0x2770, 0x9052)},
 304         {USB_DEVICE(0x2770, 0x913d)},
 305         {}
 306 };
 307
 308 MODULE_DEVICE_TABLE(usb, device_table);
 309
 310 /* sub-driver description */
 311 static const struct sd_desc sd_desc = {
 312         .name   = MODULE_NAME,
 313         .config = sd_config,
 314         .init   = sd_init,
 315         .start  = sd_start,
 316         .stop0  = sd_stop0,
 317 };
 318
 319 /* -- device connect -- */
 320 static int sd_probe(struct usb_interface *intf,
 321                 const struct usb_device_id *id)
 322 {
 323         return gspca_dev_probe(intf, id,
 324                         &sd_desc,
 325                         sizeof(struct sd),
 326                         THIS_MODULE);
 327 }
 328
 329 static struct usb_driver sd_driver = {
 330         .name       = MODULE_NAME,
 331         .id_table   = device_table,
 332         .probe      = sd_probe,
 333         .disconnect = gspca_disconnect,
 334 #ifdef CONFIG_PM
 335         .suspend = gspca_suspend,
 336         .resume  = gspca_resume,
 337 #endif
 338 };
 339
 340 /* -- module insert / remove -- */
 341 static int __init sd_mod_init(void)
 342 {
 343         int ret;
 344
 345         ret = usb_register(&sd_driver);
 346         if (ret < 0)
 347                 return ret;
 348         PDEBUG(D_PROBE, "registered");
 349         return 0;
 350 }
 351
 352 static void __exit sd_mod_exit(void)
 353 {
 354         usb_deregister(&sd_driver);
 355         PDEBUG(D_PROBE, "deregistered");
 356 }
 357
 358 module_init(sd_mod_init);
 359 module_exit(sd_mod_exit);