drivers/media/video/gspca/stk014.c

   1 /*
   2  * Syntek DV4000 (STK014) subdriver
   3  *
   4  * Copyright (C) 2008 Jean-Francois Moine (http://moinejf.free.fr)
   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 #define MODULE_NAME "stk014"
  22
  23 #include "gspca.h"
  24 #include "jpeg.h"
  25
  26 #define DRIVER_VERSION_NUMBER   KERNEL_VERSION(2, 1, 7)
  27 static const char version[] = "2.1.7";
  28
  29 MODULE_AUTHOR("Jean-Francois Moine <http://moinejf.free.fr>");
  30 MODULE_DESCRIPTION("Syntek DV4000 (STK014) USB Camera Driver");
  31 MODULE_LICENSE("GPL");
  32
  33 /* specific webcam descriptor */
  34 struct sd {
  35         struct gspca_dev gspca_dev;     /* !! must be the first item */
  36
  37         unsigned char brightness;
  38         unsigned char contrast;
  39         unsigned char colors;
  40         unsigned char lightfreq;
  41 };
  42
  43 /* global parameters */
  44 static int sd_quant = 7;                /* <= 4 KO - 7: good (enough!) */
  45
  46 /* V4L2 controls supported by the driver */
  47 static int sd_setbrightness(struct gspca_dev *gspca_dev, __s32 val);
  48 static int sd_getbrightness(struct gspca_dev *gspca_dev, __s32 *val);
  49 static int sd_setcontrast(struct gspca_dev *gspca_dev, __s32 val);
  50 static int sd_getcontrast(struct gspca_dev *gspca_dev, __s32 *val);
  51 static int sd_setcolors(struct gspca_dev *gspca_dev, __s32 val);
  52 static int sd_getcolors(struct gspca_dev *gspca_dev, __s32 *val);
  53 static int sd_setfreq(struct gspca_dev *gspca_dev, __s32 val);
  54 static int sd_getfreq(struct gspca_dev *gspca_dev, __s32 *val);
  55
  56 static struct ctrl sd_ctrls[] = {
  57         {
  58             {
  59                 .id      = V4L2_CID_BRIGHTNESS,
  60                 .type    = V4L2_CTRL_TYPE_INTEGER,
  61                 .name    = "Brightness",
  62                 .minimum = 0,
  63                 .maximum = 255,
  64                 .step    = 1,
  65 #define BRIGHTNESS_DEF 127
  66                 .default_value = BRIGHTNESS_DEF,
  67             },
  68             .set = sd_setbrightness,
  69             .get = sd_getbrightness,
  70         },
  71         {
  72             {
  73                 .id      = V4L2_CID_CONTRAST,
  74                 .type    = V4L2_CTRL_TYPE_INTEGER,
  75                 .name    = "Contrast",
  76                 .minimum = 0,
  77                 .maximum = 255,
  78                 .step    = 1,
  79 #define CONTRAST_DEF 127
  80                 .default_value = CONTRAST_DEF,
  81             },
  82             .set = sd_setcontrast,
  83             .get = sd_getcontrast,
  84         },
  85         {
  86             {
  87                 .id      = V4L2_CID_SATURATION,
  88                 .type    = V4L2_CTRL_TYPE_INTEGER,
  89                 .name    = "Color",
  90                 .minimum = 0,
  91                 .maximum = 255,
  92                 .step    = 1,
  93 #define COLOR_DEF 127
  94                 .default_value = COLOR_DEF,
  95             },
  96             .set = sd_setcolors,
  97             .get = sd_getcolors,
  98         },
  99         {
 100             {
 101                 .id      = V4L2_CID_POWER_LINE_FREQUENCY,
 102                 .type    = V4L2_CTRL_TYPE_MENU,
 103                 .name    = "Light frequency filter",
 104                 .minimum = 1,
 105                 .maximum = 2,   /* 0: 0, 1: 50Hz, 2:60Hz */
 106                 .step    = 1,
 107 #define FREQ_DEF 1
 108                 .default_value = FREQ_DEF,
 109             },
 110             .set = sd_setfreq,
 111             .get = sd_getfreq,
 112         },
 113 };
 114
 115 static struct v4l2_pix_format vga_mode[] = {
 116         {320, 240, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
 117                 .bytesperline = 320,
 118                 .sizeimage = 320 * 240 * 3 / 8 + 590,
 119                 .colorspace = V4L2_COLORSPACE_JPEG,
 120                 .priv = 1},
 121         {640, 480, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
 122                 .bytesperline = 640,
 123                 .sizeimage = 640 * 480 * 3 / 8 + 590,
 124                 .colorspace = V4L2_COLORSPACE_JPEG,
 125                 .priv = 0},
 126 };
 127
 128 /* -- read a register -- */
 129 static int reg_r(struct gspca_dev *gspca_dev,
 130                         __u16 index)
 131 {
 132         struct usb_device *dev = gspca_dev->dev;
 133         int ret;
 134
 135         ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 136                         0x00,
 137                         USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
 138                         0x00,
 139                         index,
 140                         gspca_dev->usb_buf, 1,
 141                         500);
 142         if (ret < 0) {
 143                 PDEBUG(D_ERR, "reg_r err %d", ret);
 144                 return ret;
 145         }
 146         return gspca_dev->usb_buf[0];
 147 }
 148
 149 /* -- write a register -- */
 150 static int reg_w(struct gspca_dev *gspca_dev,
 151                         __u16 index, __u16 value)
 152 {
 153         struct usb_device *dev = gspca_dev->dev;
 154         int ret;
 155
 156         ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 157                         0x01,
 158                         USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
 159                         value,
 160                         index,
 161                         NULL,
 162                         0,
 163                         500);
 164         if (ret < 0)
 165                 PDEBUG(D_ERR, "reg_w err %d", ret);
 166         return ret;
 167 }
 168
 169 /* -- get a bulk value (4 bytes) -- */
 170 static int rcv_val(struct gspca_dev *gspca_dev,
 171                         int ads)
 172 {
 173         struct usb_device *dev = gspca_dev->dev;
 174         int alen, ret;
 175
 176         reg_w(gspca_dev, 0x634, (ads >> 16) & 0xff);
 177         reg_w(gspca_dev, 0x635, (ads >> 8) & 0xff);
 178         reg_w(gspca_dev, 0x636, ads & 0xff);
 179         reg_w(gspca_dev, 0x637, 0);
 180         reg_w(gspca_dev, 0x638, 4);     /* len & 0xff */
 181         reg_w(gspca_dev, 0x639, 0);     /* len >> 8 */
 182         reg_w(gspca_dev, 0x63a, 0);
 183         reg_w(gspca_dev, 0x63b, 0);
 184         reg_w(gspca_dev, 0x630, 5);
 185         ret = usb_bulk_msg(dev,
 186                         usb_rcvbulkpipe(dev, 5),
 187                         gspca_dev->usb_buf,
 188                         4,              /* length */
 189                         &alen,
 190                         500);           /* timeout in milliseconds */
 191         return ret;
 192 }
 193
 194 /* -- send a bulk value -- */
 195 static int snd_val(struct gspca_dev *gspca_dev,
 196                         int ads,
 197                         unsigned int val)
 198 {
 199         struct usb_device *dev = gspca_dev->dev;
 200         int alen, ret;
 201         __u8 seq = 0;
 202
 203         if (ads == 0x003f08) {
 204                 ret = reg_r(gspca_dev, 0x0704);
 205                 if (ret < 0)
 206                         goto ko;
 207                 ret = reg_r(gspca_dev, 0x0705);
 208                 if (ret < 0)
 209                         goto ko;
 210                 seq = ret;              /* keep the sequence number */
 211                 ret = reg_r(gspca_dev, 0x0650);
 212                 if (ret < 0)
 213                         goto ko;
 214                 reg_w(gspca_dev, 0x654, seq);
 215         } else {
 216                 reg_w(gspca_dev, 0x654, (ads >> 16) & 0xff);
 217         }
 218         reg_w(gspca_dev, 0x655, (ads >> 8) & 0xff);
 219         reg_w(gspca_dev, 0x656, ads & 0xff);
 220         reg_w(gspca_dev, 0x657, 0);
 221         reg_w(gspca_dev, 0x658, 0x04);  /* size */
 222         reg_w(gspca_dev, 0x659, 0);
 223         reg_w(gspca_dev, 0x65a, 0);
 224         reg_w(gspca_dev, 0x65b, 0);
 225         reg_w(gspca_dev, 0x650, 5);
 226         gspca_dev->usb_buf[0] = val >> 24;
 227         gspca_dev->usb_buf[1] = val >> 16;
 228         gspca_dev->usb_buf[2] = val >> 8;
 229         gspca_dev->usb_buf[3] = val;
 230         ret = usb_bulk_msg(dev,
 231                         usb_sndbulkpipe(dev, 6),
 232                         gspca_dev->usb_buf,
 233                         4,
 234                         &alen,
 235                         500);   /* timeout in milliseconds */
 236         if (ret < 0)
 237                 goto ko;
 238         if (ads == 0x003f08) {
 239                 seq += 4;
 240                 seq &= 0x3f;
 241                 reg_w(gspca_dev, 0x705, seq);
 242         }
 243         return ret;
 244 ko:
 245         PDEBUG(D_ERR, "snd_val err %d", ret);
 246         return ret;
 247 }
 248
 249 /* set a camera parameter */
 250 static int set_par(struct gspca_dev *gspca_dev,
 251                    int parval)
 252 {
 253         return snd_val(gspca_dev, 0x003f08, parval);
 254 }
 255
 256 static void setbrightness(struct gspca_dev *gspca_dev)
 257 {
 258         struct sd *sd = (struct sd *) gspca_dev;
 259         int parval;
 260
 261         parval = 0x06000000             /* whiteness */
 262                 + (sd->brightness << 16);
 263         set_par(gspca_dev, parval);
 264 }
 265
 266 static void setcontrast(struct gspca_dev *gspca_dev)
 267 {
 268         struct sd *sd = (struct sd *) gspca_dev;
 269         int parval;
 270
 271         parval = 0x07000000             /* contrast */
 272                 + (sd->contrast << 16);
 273         set_par(gspca_dev, parval);
 274 }
 275
 276 static void setcolors(struct gspca_dev *gspca_dev)
 277 {
 278         struct sd *sd = (struct sd *) gspca_dev;
 279         int parval;
 280
 281         parval = 0x08000000             /* saturation */
 282                 + (sd->colors << 16);
 283         set_par(gspca_dev, parval);
 284 }
 285
 286 static void setfreq(struct gspca_dev *gspca_dev)
 287 {
 288         struct sd *sd = (struct sd *) gspca_dev;
 289
 290         set_par(gspca_dev, sd->lightfreq == 1
 291                         ? 0x33640000            /* 50 Hz */
 292                         : 0x33780000);          /* 60 Hz */
 293 }
 294
 295 /* this function is called at probe time */
 296 static int sd_config(struct gspca_dev *gspca_dev,
 297                         const struct usb_device_id *id)
 298 {
 299         struct sd *sd = (struct sd *) gspca_dev;
 300         struct cam *cam = &gspca_dev->cam;
 301
 302         cam->dev_name = (char *) id->driver_info;
 303         cam->epaddr = 0x02;
 304         gspca_dev->cam.cam_mode = vga_mode;
 305         gspca_dev->cam.nmodes = ARRAY_SIZE(vga_mode);
 306         sd->brightness = BRIGHTNESS_DEF;
 307         sd->contrast = CONTRAST_DEF;
 308         sd->colors = COLOR_DEF;
 309         sd->lightfreq = FREQ_DEF;
 310         return 0;
 311 }
 312
 313 /* this function is called at open time */
 314 static int sd_open(struct gspca_dev *gspca_dev)
 315 {
 316         int ret;
 317
 318         /* check if the device responds */
 319         usb_set_interface(gspca_dev->dev, gspca_dev->iface, 1);
 320         ret = reg_r(gspca_dev, 0x0740);
 321         if (ret < 0)
 322                 return ret;
 323         if (ret != 0xff) {
 324                 PDEBUG(D_ERR|D_STREAM, "init reg: 0x%02x", ret);
 325                 return -1;
 326         }
 327         return 0;
 328 }
 329
 330 /* -- start the camera -- */
 331 static void sd_start(struct gspca_dev *gspca_dev)
 332 {
 333         int ret, value;
 334
 335         /* work on alternate 1 */
 336         usb_set_interface(gspca_dev->dev, gspca_dev->iface, 1);
 337
 338         set_par(gspca_dev, 0x10000000);
 339         set_par(gspca_dev, 0x00000000);
 340         set_par(gspca_dev, 0x8002e001);
 341         set_par(gspca_dev, 0x14000000);
 342         if (gspca_dev->width > 320)
 343                 value = 0x8002e001;             /* 640x480 */
 344         else
 345                 value = 0x4001f000;             /* 320x240 */
 346         set_par(gspca_dev, value);
 347         ret = usb_set_interface(gspca_dev->dev,
 348                                         gspca_dev->iface,
 349                                         gspca_dev->alt);
 350         if (ret < 0) {
 351                 PDEBUG(D_ERR|D_STREAM, "set intf %d %d failed",
 352                         gspca_dev->iface, gspca_dev->alt);
 353                 goto out;
 354         }
 355         ret = reg_r(gspca_dev, 0x0630);
 356         if (ret < 0)
 357                 goto out;
 358         rcv_val(gspca_dev, 0x000020);   /* << (value ff ff ff ff) */
 359         ret = reg_r(gspca_dev, 0x0650);
 360         if (ret < 0)
 361                 goto out;
 362         snd_val(gspca_dev, 0x000020, 0xffffffff);
 363         reg_w(gspca_dev, 0x0620, 0);
 364         reg_w(gspca_dev, 0x0630, 0);
 365         reg_w(gspca_dev, 0x0640, 0);
 366         reg_w(gspca_dev, 0x0650, 0);
 367         reg_w(gspca_dev, 0x0660, 0);
 368         setbrightness(gspca_dev);               /* whiteness */
 369         setcontrast(gspca_dev);                 /* contrast */
 370         setcolors(gspca_dev);                   /* saturation */
 371         set_par(gspca_dev, 0x09800000);         /* Red ? */
 372         set_par(gspca_dev, 0x0a800000);         /* Green ? */
 373         set_par(gspca_dev, 0x0b800000);         /* Blue ? */
 374         set_par(gspca_dev, 0x0d030000);         /* Gamma ? */
 375         setfreq(gspca_dev);                     /* light frequency */
 376
 377         /* start the video flow */
 378         set_par(gspca_dev, 0x01000000);
 379         set_par(gspca_dev, 0x01000000);
 380         PDEBUG(D_STREAM, "camera started alt: 0x%02x", gspca_dev->alt);
 381         return;
 382 out:
 383         PDEBUG(D_ERR|D_STREAM, "camera start err %d", ret);
 384 }
 385
 386 static void sd_stopN(struct gspca_dev *gspca_dev)
 387 {
 388         struct usb_device *dev = gspca_dev->dev;
 389
 390         set_par(gspca_dev, 0x02000000);
 391         set_par(gspca_dev, 0x02000000);
 392         usb_set_interface(dev, gspca_dev->iface, 1);
 393         reg_r(gspca_dev, 0x0630);
 394         rcv_val(gspca_dev, 0x000020);   /* << (value ff ff ff ff) */
 395         reg_r(gspca_dev, 0x0650);
 396         snd_val(gspca_dev, 0x000020, 0xffffffff);
 397         reg_w(gspca_dev, 0x0620, 0);
 398         reg_w(gspca_dev, 0x0630, 0);
 399         reg_w(gspca_dev, 0x0640, 0);
 400         reg_w(gspca_dev, 0x0650, 0);
 401         reg_w(gspca_dev, 0x0660, 0);
 402         PDEBUG(D_STREAM, "camera stopped");
 403 }
 404
 405 static void sd_stop0(struct gspca_dev *gspca_dev)
 406 {
 407 }
 408
 409 static void sd_close(struct gspca_dev *gspca_dev)
 410 {
 411 }
 412
 413 static void sd_pkt_scan(struct gspca_dev *gspca_dev,
 414                         struct gspca_frame *frame,      /* target */
 415                         __u8 *data,                     /* isoc packet */
 416                         int len)                        /* iso packet length */
 417 {
 418         static unsigned char ffd9[] = {0xff, 0xd9};
 419
 420         /* a frame starts with:
 421          *      - 0xff 0xfe
 422          *      - 0x08 0x00     - length (little endian ?!)
 423          *      - 4 bytes = size of whole frame (BE - including header)
 424          *      - 0x00 0x0c
 425          *      - 0xff 0xd8
 426          *      - ..    JPEG image with escape sequences (ff 00)
 427          *              (without ending - ff d9)
 428          */
 429         if (data[0] == 0xff && data[1] == 0xfe) {
 430                 frame = gspca_frame_add(gspca_dev, LAST_PACKET, frame,
 431                                         ffd9, 2);
 432
 433                 /* put the JPEG 411 header */
 434                 jpeg_put_header(gspca_dev, frame, sd_quant, 0x22);
 435
 436                 /* beginning of the frame */
 437 #define STKHDRSZ 12
 438                 gspca_frame_add(gspca_dev, INTER_PACKET, frame,
 439                                 data + STKHDRSZ, len - STKHDRSZ);
 440 #undef STKHDRSZ
 441                 return;
 442         }
 443         gspca_frame_add(gspca_dev, INTER_PACKET, frame, data, len);
 444 }
 445
 446 static int sd_setbrightness(struct gspca_dev *gspca_dev, __s32 val)
 447 {
 448         struct sd *sd = (struct sd *) gspca_dev;
 449
 450         sd->brightness = val;
 451         if (gspca_dev->streaming)
 452                 setbrightness(gspca_dev);
 453         return 0;
 454 }
 455
 456 static int sd_getbrightness(struct gspca_dev *gspca_dev, __s32 *val)
 457 {
 458         struct sd *sd = (struct sd *) gspca_dev;
 459
 460         *val = sd->brightness;
 461         return 0;
 462 }
 463
 464 static int sd_setcontrast(struct gspca_dev *gspca_dev, __s32 val)
 465 {
 466         struct sd *sd = (struct sd *) gspca_dev;
 467
 468         sd->contrast = val;
 469         if (gspca_dev->streaming)
 470                 setcontrast(gspca_dev);
 471         return 0;
 472 }
 473
 474 static int sd_getcontrast(struct gspca_dev *gspca_dev, __s32 *val)
 475 {
 476         struct sd *sd = (struct sd *) gspca_dev;
 477
 478         *val = sd->contrast;
 479         return 0;
 480 }
 481
 482 static int sd_setcolors(struct gspca_dev *gspca_dev, __s32 val)
 483 {
 484         struct sd *sd = (struct sd *) gspca_dev;
 485
 486         sd->colors = val;
 487         if (gspca_dev->streaming)
 488                 setcolors(gspca_dev);
 489         return 0;
 490 }
 491
 492 static int sd_getcolors(struct gspca_dev *gspca_dev, __s32 *val)
 493 {
 494         struct sd *sd = (struct sd *) gspca_dev;
 495
 496         *val = sd->colors;
 497         return 0;
 498 }
 499
 500 static int sd_setfreq(struct gspca_dev *gspca_dev, __s32 val)
 501 {
 502         struct sd *sd = (struct sd *) gspca_dev;
 503
 504         sd->lightfreq = val;
 505         if (gspca_dev->streaming)
 506                 setfreq(gspca_dev);
 507         return 0;
 508 }
 509
 510 static int sd_getfreq(struct gspca_dev *gspca_dev, __s32 *val)
 511 {
 512         struct sd *sd = (struct sd *) gspca_dev;
 513
 514         *val = sd->lightfreq;
 515         return 0;
 516 }
 517
 518 static int sd_querymenu(struct gspca_dev *gspca_dev,
 519                         struct v4l2_querymenu *menu)
 520 {
 521         switch (menu->id) {
 522         case V4L2_CID_POWER_LINE_FREQUENCY:
 523                 switch (menu->index) {
 524                 case 1:         /* V4L2_CID_POWER_LINE_FREQUENCY_50HZ */
 525                         strcpy((char *) menu->name, "50 Hz");
 526                         return 0;
 527                 case 2:         /* V4L2_CID_POWER_LINE_FREQUENCY_60HZ */
 528                         strcpy((char *) menu->name, "60 Hz");
 529                         return 0;
 530                 }
 531                 break;
 532         }
 533         return -EINVAL;
 534 }
 535
 536 /* sub-driver description */
 537 static const struct sd_desc sd_desc = {
 538         .name = MODULE_NAME,
 539         .ctrls = sd_ctrls,
 540         .nctrls = ARRAY_SIZE(sd_ctrls),
 541         .config = sd_config,
 542         .open = sd_open,
 543         .start = sd_start,
 544         .stopN = sd_stopN,
 545         .stop0 = sd_stop0,
 546         .close = sd_close,
 547         .pkt_scan = sd_pkt_scan,
 548         .querymenu = sd_querymenu,
 549 };
 550
 551 /* -- module initialisation -- */
 552 #define DVNM(name) .driver_info = (kernel_ulong_t) name
 553 static const __devinitdata struct usb_device_id device_table[] = {
 554         {USB_DEVICE(0x05e1, 0x0893), DVNM("Syntek DV4000")},
 555         {}
 556 };
 557 MODULE_DEVICE_TABLE(usb, device_table);
 558
 559 /* -- device connect -- */
 560 static int sd_probe(struct usb_interface *intf,
 561                         const struct usb_device_id *id)
 562 {
 563         return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
 564                                 THIS_MODULE);
 565 }
 566
 567 static struct usb_driver sd_driver = {
 568         .name = MODULE_NAME,
 569         .id_table = device_table,
 570         .probe = sd_probe,
 571         .disconnect = gspca_disconnect,
 572 };
 573
 574 /* -- module insert / remove -- */
 575 static int __init sd_mod_init(void)
 576 {
 577         if (usb_register(&sd_driver) < 0)
 578                 return -1;
 579         info("v%s registered", version);
 580         return 0;
 581 }
 582 static void __exit sd_mod_exit(void)
 583 {
 584         usb_deregister(&sd_driver);
 585         info("deregistered");
 586 }
 587
 588 module_init(sd_mod_init);
 589 module_exit(sd_mod_exit);
 590
 591 module_param_named(quant, sd_quant, int, 0644);
 592 MODULE_PARM_DESC(quant, "Quantization index (0..8)");