2 * Syntek DV4000 (STK014) subdriver
4 * Copyright (C) 2008 Jean-Francois Moine (http://moinejf.free.fr)
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
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.
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
21 #define MODULE_NAME "stk014"
26 MODULE_AUTHOR("Jean-Francois Moine <http://moinejf.free.fr>");
27 MODULE_DESCRIPTION("Syntek DV4000 (STK014) USB Camera Driver");
28 MODULE_LICENSE("GPL");
30 /* specific webcam descriptor */
32 struct gspca_dev gspca_dev; /* !! must be the first item */
34 unsigned char brightness;
35 unsigned char contrast;
37 unsigned char lightfreq;
39 #define QUALITY_MIN 70
40 #define QUALITY_MAX 95
41 #define QUALITY_DEF 88
43 u8 jpeg_hdr[JPEG_HDR_SZ];
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);
56 static const struct ctrl sd_ctrls[] = {
59 .id = V4L2_CID_BRIGHTNESS,
60 .type = V4L2_CTRL_TYPE_INTEGER,
65 #define BRIGHTNESS_DEF 127
66 .default_value = BRIGHTNESS_DEF,
68 .set = sd_setbrightness,
69 .get = sd_getbrightness,
73 .id = V4L2_CID_CONTRAST,
74 .type = V4L2_CTRL_TYPE_INTEGER,
79 #define CONTRAST_DEF 127
80 .default_value = CONTRAST_DEF,
82 .set = sd_setcontrast,
83 .get = sd_getcontrast,
87 .id = V4L2_CID_SATURATION,
88 .type = V4L2_CTRL_TYPE_INTEGER,
94 .default_value = COLOR_DEF,
101 .id = V4L2_CID_POWER_LINE_FREQUENCY,
102 .type = V4L2_CTRL_TYPE_MENU,
103 .name = "Light frequency filter",
105 .maximum = 2, /* 0: 0, 1: 50Hz, 2:60Hz */
108 .default_value = FREQ_DEF,
115 static const struct v4l2_pix_format vga_mode[] = {
116 {320, 240, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
118 .sizeimage = 320 * 240 * 3 / 8 + 590,
119 .colorspace = V4L2_COLORSPACE_JPEG,
121 {640, 480, V4L2_PIX_FMT_JPEG, V4L2_FIELD_NONE,
123 .sizeimage = 640 * 480 * 3 / 8 + 590,
124 .colorspace = V4L2_COLORSPACE_JPEG,
128 /* -- read a register -- */
129 static u8 reg_r(struct gspca_dev *gspca_dev,
132 struct usb_device *dev = gspca_dev->dev;
135 if (gspca_dev->usb_err < 0)
137 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
139 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
142 gspca_dev->usb_buf, 1,
145 PDEBUG(D_ERR, "reg_r err %d", ret);
146 gspca_dev->usb_err = ret;
149 return gspca_dev->usb_buf[0];
152 /* -- write a register -- */
153 static void reg_w(struct gspca_dev *gspca_dev,
154 __u16 index, __u16 value)
156 struct usb_device *dev = gspca_dev->dev;
159 if (gspca_dev->usb_err < 0)
161 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
163 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
170 PDEBUG(D_ERR, "reg_w err %d", ret);
171 gspca_dev->usb_err = ret;
175 /* -- get a bulk value (4 bytes) -- */
176 static void rcv_val(struct gspca_dev *gspca_dev,
179 struct usb_device *dev = gspca_dev->dev;
182 reg_w(gspca_dev, 0x634, (ads >> 16) & 0xff);
183 reg_w(gspca_dev, 0x635, (ads >> 8) & 0xff);
184 reg_w(gspca_dev, 0x636, ads & 0xff);
185 reg_w(gspca_dev, 0x637, 0);
186 reg_w(gspca_dev, 0x638, 4); /* len & 0xff */
187 reg_w(gspca_dev, 0x639, 0); /* len >> 8 */
188 reg_w(gspca_dev, 0x63a, 0);
189 reg_w(gspca_dev, 0x63b, 0);
190 reg_w(gspca_dev, 0x630, 5);
191 if (gspca_dev->usb_err < 0)
193 ret = usb_bulk_msg(dev,
194 usb_rcvbulkpipe(dev, 0x05),
198 500); /* timeout in milliseconds */
200 PDEBUG(D_ERR, "rcv_val err %d", ret);
201 gspca_dev->usb_err = ret;
205 /* -- send a bulk value -- */
206 static void snd_val(struct gspca_dev *gspca_dev,
210 struct usb_device *dev = gspca_dev->dev;
214 if (ads == 0x003f08) {
215 reg_r(gspca_dev, 0x0704);
216 seq = reg_r(gspca_dev, 0x0705);
217 reg_r(gspca_dev, 0x0650);
218 reg_w(gspca_dev, 0x654, seq);
220 reg_w(gspca_dev, 0x654, (ads >> 16) & 0xff);
222 reg_w(gspca_dev, 0x655, (ads >> 8) & 0xff);
223 reg_w(gspca_dev, 0x656, ads & 0xff);
224 reg_w(gspca_dev, 0x657, 0);
225 reg_w(gspca_dev, 0x658, 0x04); /* size */
226 reg_w(gspca_dev, 0x659, 0);
227 reg_w(gspca_dev, 0x65a, 0);
228 reg_w(gspca_dev, 0x65b, 0);
229 reg_w(gspca_dev, 0x650, 5);
230 if (gspca_dev->usb_err < 0)
232 gspca_dev->usb_buf[0] = val >> 24;
233 gspca_dev->usb_buf[1] = val >> 16;
234 gspca_dev->usb_buf[2] = val >> 8;
235 gspca_dev->usb_buf[3] = val;
236 ret = usb_bulk_msg(dev,
237 usb_sndbulkpipe(dev, 6),
241 500); /* timeout in milliseconds */
243 PDEBUG(D_ERR, "snd_val err %d", ret);
244 gspca_dev->usb_err = ret;
246 if (ads == 0x003f08) {
249 reg_w(gspca_dev, 0x705, seq);
254 /* set a camera parameter */
255 static void set_par(struct gspca_dev *gspca_dev,
258 snd_val(gspca_dev, 0x003f08, parval);
261 static void setbrightness(struct gspca_dev *gspca_dev)
263 struct sd *sd = (struct sd *) gspca_dev;
266 parval = 0x06000000 /* whiteness */
267 + (sd->brightness << 16);
268 set_par(gspca_dev, parval);
271 static void setcontrast(struct gspca_dev *gspca_dev)
273 struct sd *sd = (struct sd *) gspca_dev;
276 parval = 0x07000000 /* contrast */
277 + (sd->contrast << 16);
278 set_par(gspca_dev, parval);
281 static void setcolors(struct gspca_dev *gspca_dev)
283 struct sd *sd = (struct sd *) gspca_dev;
286 parval = 0x08000000 /* saturation */
287 + (sd->colors << 16);
288 set_par(gspca_dev, parval);
291 static void setfreq(struct gspca_dev *gspca_dev)
293 struct sd *sd = (struct sd *) gspca_dev;
295 set_par(gspca_dev, sd->lightfreq == 1
296 ? 0x33640000 /* 50 Hz */
297 : 0x33780000); /* 60 Hz */
300 /* this function is called at probe time */
301 static int sd_config(struct gspca_dev *gspca_dev,
302 const struct usb_device_id *id)
304 struct sd *sd = (struct sd *) gspca_dev;
306 gspca_dev->cam.cam_mode = vga_mode;
307 gspca_dev->cam.nmodes = ARRAY_SIZE(vga_mode);
308 sd->brightness = BRIGHTNESS_DEF;
309 sd->contrast = CONTRAST_DEF;
310 sd->colors = COLOR_DEF;
311 sd->lightfreq = FREQ_DEF;
312 sd->quality = QUALITY_DEF;
316 /* this function is called at probe and resume time */
317 static int sd_init(struct gspca_dev *gspca_dev)
321 /* check if the device responds */
322 usb_set_interface(gspca_dev->dev, gspca_dev->iface, 1);
323 ret = reg_r(gspca_dev, 0x0740);
324 if (gspca_dev->usb_err >= 0) {
326 PDEBUG(D_ERR|D_STREAM, "init reg: 0x%02x", ret);
327 gspca_dev->usb_err = -EIO;
330 return gspca_dev->usb_err;
333 /* -- start the camera -- */
334 static int sd_start(struct gspca_dev *gspca_dev)
336 struct sd *sd = (struct sd *) gspca_dev;
339 /* create the JPEG header */
340 jpeg_define(sd->jpeg_hdr, gspca_dev->height, gspca_dev->width,
341 0x22); /* JPEG 411 */
342 jpeg_set_qual(sd->jpeg_hdr, sd->quality);
344 /* work on alternate 1 */
345 usb_set_interface(gspca_dev->dev, gspca_dev->iface, 1);
347 set_par(gspca_dev, 0x10000000);
348 set_par(gspca_dev, 0x00000000);
349 set_par(gspca_dev, 0x8002e001);
350 set_par(gspca_dev, 0x14000000);
351 if (gspca_dev->width > 320)
352 value = 0x8002e001; /* 640x480 */
354 value = 0x4001f000; /* 320x240 */
355 set_par(gspca_dev, value);
356 ret = usb_set_interface(gspca_dev->dev,
360 PDEBUG(D_ERR|D_STREAM, "set intf %d %d failed",
361 gspca_dev->iface, gspca_dev->alt);
362 gspca_dev->usb_err = ret;
365 reg_r(gspca_dev, 0x0630);
366 rcv_val(gspca_dev, 0x000020); /* << (value ff ff ff ff) */
367 reg_r(gspca_dev, 0x0650);
368 snd_val(gspca_dev, 0x000020, 0xffffffff);
369 reg_w(gspca_dev, 0x0620, 0);
370 reg_w(gspca_dev, 0x0630, 0);
371 reg_w(gspca_dev, 0x0640, 0);
372 reg_w(gspca_dev, 0x0650, 0);
373 reg_w(gspca_dev, 0x0660, 0);
374 setbrightness(gspca_dev); /* whiteness */
375 setcontrast(gspca_dev); /* contrast */
376 setcolors(gspca_dev); /* saturation */
377 set_par(gspca_dev, 0x09800000); /* Red ? */
378 set_par(gspca_dev, 0x0a800000); /* Green ? */
379 set_par(gspca_dev, 0x0b800000); /* Blue ? */
380 set_par(gspca_dev, 0x0d030000); /* Gamma ? */
381 setfreq(gspca_dev); /* light frequency */
383 /* start the video flow */
384 set_par(gspca_dev, 0x01000000);
385 set_par(gspca_dev, 0x01000000);
386 if (gspca_dev->usb_err >= 0)
387 PDEBUG(D_STREAM, "camera started alt: 0x%02x",
390 return gspca_dev->usb_err;
393 static void sd_stopN(struct gspca_dev *gspca_dev)
395 struct usb_device *dev = gspca_dev->dev;
397 set_par(gspca_dev, 0x02000000);
398 set_par(gspca_dev, 0x02000000);
399 usb_set_interface(dev, gspca_dev->iface, 1);
400 reg_r(gspca_dev, 0x0630);
401 rcv_val(gspca_dev, 0x000020); /* << (value ff ff ff ff) */
402 reg_r(gspca_dev, 0x0650);
403 snd_val(gspca_dev, 0x000020, 0xffffffff);
404 reg_w(gspca_dev, 0x0620, 0);
405 reg_w(gspca_dev, 0x0630, 0);
406 reg_w(gspca_dev, 0x0640, 0);
407 reg_w(gspca_dev, 0x0650, 0);
408 reg_w(gspca_dev, 0x0660, 0);
409 PDEBUG(D_STREAM, "camera stopped");
412 static void sd_pkt_scan(struct gspca_dev *gspca_dev,
413 u8 *data, /* isoc packet */
414 int len) /* iso packet length */
416 struct sd *sd = (struct sd *) gspca_dev;
417 static unsigned char ffd9[] = {0xff, 0xd9};
419 /* a frame starts with:
421 * - 0x08 0x00 - length (little endian ?!)
422 * - 4 bytes = size of whole frame (BE - including header)
425 * - .. JPEG image with escape sequences (ff 00)
426 * (without ending - ff d9)
428 if (data[0] == 0xff && data[1] == 0xfe) {
429 gspca_frame_add(gspca_dev, LAST_PACKET,
432 /* put the JPEG 411 header */
433 gspca_frame_add(gspca_dev, FIRST_PACKET,
434 sd->jpeg_hdr, JPEG_HDR_SZ);
436 /* beginning of the frame */
441 gspca_frame_add(gspca_dev, INTER_PACKET, data, len);
444 static int sd_setbrightness(struct gspca_dev *gspca_dev, __s32 val)
446 struct sd *sd = (struct sd *) gspca_dev;
448 sd->brightness = val;
449 if (gspca_dev->streaming)
450 setbrightness(gspca_dev);
451 return gspca_dev->usb_err;
454 static int sd_getbrightness(struct gspca_dev *gspca_dev, __s32 *val)
456 struct sd *sd = (struct sd *) gspca_dev;
458 *val = sd->brightness;
462 static int sd_setcontrast(struct gspca_dev *gspca_dev, __s32 val)
464 struct sd *sd = (struct sd *) gspca_dev;
467 if (gspca_dev->streaming)
468 setcontrast(gspca_dev);
469 return gspca_dev->usb_err;
472 static int sd_getcontrast(struct gspca_dev *gspca_dev, __s32 *val)
474 struct sd *sd = (struct sd *) gspca_dev;
480 static int sd_setcolors(struct gspca_dev *gspca_dev, __s32 val)
482 struct sd *sd = (struct sd *) gspca_dev;
485 if (gspca_dev->streaming)
486 setcolors(gspca_dev);
487 return gspca_dev->usb_err;
490 static int sd_getcolors(struct gspca_dev *gspca_dev, __s32 *val)
492 struct sd *sd = (struct sd *) gspca_dev;
498 static int sd_setfreq(struct gspca_dev *gspca_dev, __s32 val)
500 struct sd *sd = (struct sd *) gspca_dev;
503 if (gspca_dev->streaming)
505 return gspca_dev->usb_err;
508 static int sd_getfreq(struct gspca_dev *gspca_dev, __s32 *val)
510 struct sd *sd = (struct sd *) gspca_dev;
512 *val = sd->lightfreq;
516 static int sd_querymenu(struct gspca_dev *gspca_dev,
517 struct v4l2_querymenu *menu)
520 case V4L2_CID_POWER_LINE_FREQUENCY:
521 switch (menu->index) {
522 case 1: /* V4L2_CID_POWER_LINE_FREQUENCY_50HZ */
523 strcpy((char *) menu->name, "50 Hz");
525 case 2: /* V4L2_CID_POWER_LINE_FREQUENCY_60HZ */
526 strcpy((char *) menu->name, "60 Hz");
534 static int sd_set_jcomp(struct gspca_dev *gspca_dev,
535 struct v4l2_jpegcompression *jcomp)
537 struct sd *sd = (struct sd *) gspca_dev;
539 if (jcomp->quality < QUALITY_MIN)
540 sd->quality = QUALITY_MIN;
541 else if (jcomp->quality > QUALITY_MAX)
542 sd->quality = QUALITY_MAX;
544 sd->quality = jcomp->quality;
545 if (gspca_dev->streaming)
546 jpeg_set_qual(sd->jpeg_hdr, sd->quality);
547 return gspca_dev->usb_err;
550 static int sd_get_jcomp(struct gspca_dev *gspca_dev,
551 struct v4l2_jpegcompression *jcomp)
553 struct sd *sd = (struct sd *) gspca_dev;
555 memset(jcomp, 0, sizeof *jcomp);
556 jcomp->quality = sd->quality;
557 jcomp->jpeg_markers = V4L2_JPEG_MARKER_DHT
558 | V4L2_JPEG_MARKER_DQT;
562 /* sub-driver description */
563 static const struct sd_desc sd_desc = {
566 .nctrls = ARRAY_SIZE(sd_ctrls),
571 .pkt_scan = sd_pkt_scan,
572 .querymenu = sd_querymenu,
573 .get_jcomp = sd_get_jcomp,
574 .set_jcomp = sd_set_jcomp,
577 /* -- module initialisation -- */
578 static const __devinitdata struct usb_device_id device_table[] = {
579 {USB_DEVICE(0x05e1, 0x0893)},
582 MODULE_DEVICE_TABLE(usb, device_table);
584 /* -- device connect -- */
585 static int sd_probe(struct usb_interface *intf,
586 const struct usb_device_id *id)
588 return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
592 static struct usb_driver sd_driver = {
594 .id_table = device_table,
596 .disconnect = gspca_disconnect,
598 .suspend = gspca_suspend,
599 .resume = gspca_resume,
603 /* -- module insert / remove -- */
604 static int __init sd_mod_init(void)
607 ret = usb_register(&sd_driver);
613 static void __exit sd_mod_exit(void)
615 usb_deregister(&sd_driver);
616 info("deregistered");
619 module_init(sd_mod_init);
620 module_exit(sd_mod_exit);