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 60
40 #define QUALITY_MAX 95
41 #define QUALITY_DEF 80
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 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 int reg_r(struct gspca_dev *gspca_dev,
132 struct usb_device *dev = gspca_dev->dev;
135 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
137 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
140 gspca_dev->usb_buf, 1,
143 PDEBUG(D_ERR, "reg_r err %d", ret);
146 return gspca_dev->usb_buf[0];
149 /* -- write a register -- */
150 static int reg_w(struct gspca_dev *gspca_dev,
151 __u16 index, __u16 value)
153 struct usb_device *dev = gspca_dev->dev;
156 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
158 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
165 PDEBUG(D_ERR, "reg_w err %d", ret);
169 /* -- get a bulk value (4 bytes) -- */
170 static int rcv_val(struct gspca_dev *gspca_dev,
173 struct usb_device *dev = gspca_dev->dev;
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, 0x05),
190 500); /* timeout in milliseconds */
194 /* -- send a bulk value -- */
195 static int snd_val(struct gspca_dev *gspca_dev,
199 struct usb_device *dev = gspca_dev->dev;
203 if (ads == 0x003f08) {
204 ret = reg_r(gspca_dev, 0x0704);
207 ret = reg_r(gspca_dev, 0x0705);
210 seq = ret; /* keep the sequence number */
211 ret = reg_r(gspca_dev, 0x0650);
214 reg_w(gspca_dev, 0x654, seq);
216 reg_w(gspca_dev, 0x654, (ads >> 16) & 0xff);
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),
235 500); /* timeout in milliseconds */
238 if (ads == 0x003f08) {
241 reg_w(gspca_dev, 0x705, seq);
245 PDEBUG(D_ERR, "snd_val err %d", ret);
249 /* set a camera parameter */
250 static int set_par(struct gspca_dev *gspca_dev,
253 return snd_val(gspca_dev, 0x003f08, parval);
256 static void setbrightness(struct gspca_dev *gspca_dev)
258 struct sd *sd = (struct sd *) gspca_dev;
261 parval = 0x06000000 /* whiteness */
262 + (sd->brightness << 16);
263 set_par(gspca_dev, parval);
266 static void setcontrast(struct gspca_dev *gspca_dev)
268 struct sd *sd = (struct sd *) gspca_dev;
271 parval = 0x07000000 /* contrast */
272 + (sd->contrast << 16);
273 set_par(gspca_dev, parval);
276 static void setcolors(struct gspca_dev *gspca_dev)
278 struct sd *sd = (struct sd *) gspca_dev;
281 parval = 0x08000000 /* saturation */
282 + (sd->colors << 16);
283 set_par(gspca_dev, parval);
286 static void setfreq(struct gspca_dev *gspca_dev)
288 struct sd *sd = (struct sd *) gspca_dev;
290 set_par(gspca_dev, sd->lightfreq == 1
291 ? 0x33640000 /* 50 Hz */
292 : 0x33780000); /* 60 Hz */
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)
299 struct sd *sd = (struct sd *) gspca_dev;
301 gspca_dev->cam.cam_mode = vga_mode;
302 gspca_dev->cam.nmodes = ARRAY_SIZE(vga_mode);
303 sd->brightness = BRIGHTNESS_DEF;
304 sd->contrast = CONTRAST_DEF;
305 sd->colors = COLOR_DEF;
306 sd->lightfreq = FREQ_DEF;
307 sd->quality = QUALITY_DEF;
311 /* this function is called at probe and resume time */
312 static int sd_init(struct gspca_dev *gspca_dev)
316 /* check if the device responds */
317 usb_set_interface(gspca_dev->dev, gspca_dev->iface, 1);
318 ret = reg_r(gspca_dev, 0x0740);
322 PDEBUG(D_ERR|D_STREAM, "init reg: 0x%02x", ret);
328 /* -- start the camera -- */
329 static int sd_start(struct gspca_dev *gspca_dev)
331 struct sd *sd = (struct sd *) gspca_dev;
334 /* create the JPEG header */
335 sd->jpeg_hdr = kmalloc(JPEG_HDR_SZ, GFP_KERNEL);
338 jpeg_define(sd->jpeg_hdr, gspca_dev->height, gspca_dev->width,
339 0x22); /* JPEG 411 */
340 jpeg_set_qual(sd->jpeg_hdr, sd->quality);
342 /* work on alternate 1 */
343 usb_set_interface(gspca_dev->dev, gspca_dev->iface, 1);
345 set_par(gspca_dev, 0x10000000);
346 set_par(gspca_dev, 0x00000000);
347 set_par(gspca_dev, 0x8002e001);
348 set_par(gspca_dev, 0x14000000);
349 if (gspca_dev->width > 320)
350 value = 0x8002e001; /* 640x480 */
352 value = 0x4001f000; /* 320x240 */
353 set_par(gspca_dev, value);
354 ret = usb_set_interface(gspca_dev->dev,
358 PDEBUG(D_ERR|D_STREAM, "set intf %d %d failed",
359 gspca_dev->iface, gspca_dev->alt);
362 ret = reg_r(gspca_dev, 0x0630);
365 rcv_val(gspca_dev, 0x000020); /* << (value ff ff ff ff) */
366 ret = reg_r(gspca_dev, 0x0650);
369 snd_val(gspca_dev, 0x000020, 0xffffffff);
370 reg_w(gspca_dev, 0x0620, 0);
371 reg_w(gspca_dev, 0x0630, 0);
372 reg_w(gspca_dev, 0x0640, 0);
373 reg_w(gspca_dev, 0x0650, 0);
374 reg_w(gspca_dev, 0x0660, 0);
375 setbrightness(gspca_dev); /* whiteness */
376 setcontrast(gspca_dev); /* contrast */
377 setcolors(gspca_dev); /* saturation */
378 set_par(gspca_dev, 0x09800000); /* Red ? */
379 set_par(gspca_dev, 0x0a800000); /* Green ? */
380 set_par(gspca_dev, 0x0b800000); /* Blue ? */
381 set_par(gspca_dev, 0x0d030000); /* Gamma ? */
382 setfreq(gspca_dev); /* light frequency */
384 /* start the video flow */
385 set_par(gspca_dev, 0x01000000);
386 set_par(gspca_dev, 0x01000000);
387 PDEBUG(D_STREAM, "camera started alt: 0x%02x", gspca_dev->alt);
390 PDEBUG(D_ERR|D_STREAM, "camera start err %d", ret);
394 static void sd_stopN(struct gspca_dev *gspca_dev)
396 struct usb_device *dev = gspca_dev->dev;
398 set_par(gspca_dev, 0x02000000);
399 set_par(gspca_dev, 0x02000000);
400 usb_set_interface(dev, gspca_dev->iface, 1);
401 reg_r(gspca_dev, 0x0630);
402 rcv_val(gspca_dev, 0x000020); /* << (value ff ff ff ff) */
403 reg_r(gspca_dev, 0x0650);
404 snd_val(gspca_dev, 0x000020, 0xffffffff);
405 reg_w(gspca_dev, 0x0620, 0);
406 reg_w(gspca_dev, 0x0630, 0);
407 reg_w(gspca_dev, 0x0640, 0);
408 reg_w(gspca_dev, 0x0650, 0);
409 reg_w(gspca_dev, 0x0660, 0);
410 PDEBUG(D_STREAM, "camera stopped");
413 static void sd_stop0(struct gspca_dev *gspca_dev)
415 struct sd *sd = (struct sd *) gspca_dev;
420 static void sd_pkt_scan(struct gspca_dev *gspca_dev,
421 struct gspca_frame *frame, /* target */
422 __u8 *data, /* isoc packet */
423 int len) /* iso packet length */
425 struct sd *sd = (struct sd *) gspca_dev;
426 static unsigned char ffd9[] = {0xff, 0xd9};
428 /* a frame starts with:
430 * - 0x08 0x00 - length (little endian ?!)
431 * - 4 bytes = size of whole frame (BE - including header)
434 * - .. JPEG image with escape sequences (ff 00)
435 * (without ending - ff d9)
437 if (data[0] == 0xff && data[1] == 0xfe) {
438 frame = gspca_frame_add(gspca_dev, LAST_PACKET, frame,
441 /* put the JPEG 411 header */
442 gspca_frame_add(gspca_dev, FIRST_PACKET, frame,
443 sd->jpeg_hdr, JPEG_HDR_SZ);
445 /* beginning of the frame */
450 gspca_frame_add(gspca_dev, INTER_PACKET, frame, data, len);
453 static int sd_setbrightness(struct gspca_dev *gspca_dev, __s32 val)
455 struct sd *sd = (struct sd *) gspca_dev;
457 sd->brightness = val;
458 if (gspca_dev->streaming)
459 setbrightness(gspca_dev);
463 static int sd_getbrightness(struct gspca_dev *gspca_dev, __s32 *val)
465 struct sd *sd = (struct sd *) gspca_dev;
467 *val = sd->brightness;
471 static int sd_setcontrast(struct gspca_dev *gspca_dev, __s32 val)
473 struct sd *sd = (struct sd *) gspca_dev;
476 if (gspca_dev->streaming)
477 setcontrast(gspca_dev);
481 static int sd_getcontrast(struct gspca_dev *gspca_dev, __s32 *val)
483 struct sd *sd = (struct sd *) gspca_dev;
489 static int sd_setcolors(struct gspca_dev *gspca_dev, __s32 val)
491 struct sd *sd = (struct sd *) gspca_dev;
494 if (gspca_dev->streaming)
495 setcolors(gspca_dev);
499 static int sd_getcolors(struct gspca_dev *gspca_dev, __s32 *val)
501 struct sd *sd = (struct sd *) gspca_dev;
507 static int sd_setfreq(struct gspca_dev *gspca_dev, __s32 val)
509 struct sd *sd = (struct sd *) gspca_dev;
512 if (gspca_dev->streaming)
517 static int sd_getfreq(struct gspca_dev *gspca_dev, __s32 *val)
519 struct sd *sd = (struct sd *) gspca_dev;
521 *val = sd->lightfreq;
525 static int sd_querymenu(struct gspca_dev *gspca_dev,
526 struct v4l2_querymenu *menu)
529 case V4L2_CID_POWER_LINE_FREQUENCY:
530 switch (menu->index) {
531 case 1: /* V4L2_CID_POWER_LINE_FREQUENCY_50HZ */
532 strcpy((char *) menu->name, "50 Hz");
534 case 2: /* V4L2_CID_POWER_LINE_FREQUENCY_60HZ */
535 strcpy((char *) menu->name, "60 Hz");
543 static int sd_set_jcomp(struct gspca_dev *gspca_dev,
544 struct v4l2_jpegcompression *jcomp)
546 struct sd *sd = (struct sd *) gspca_dev;
548 if (jcomp->quality < QUALITY_MIN)
549 sd->quality = QUALITY_MIN;
550 else if (jcomp->quality > QUALITY_MAX)
551 sd->quality = QUALITY_MAX;
553 sd->quality = jcomp->quality;
554 if (gspca_dev->streaming)
555 jpeg_set_qual(sd->jpeg_hdr, sd->quality);
559 static int sd_get_jcomp(struct gspca_dev *gspca_dev,
560 struct v4l2_jpegcompression *jcomp)
562 struct sd *sd = (struct sd *) gspca_dev;
564 memset(jcomp, 0, sizeof *jcomp);
565 jcomp->quality = sd->quality;
566 jcomp->jpeg_markers = V4L2_JPEG_MARKER_DHT
567 | V4L2_JPEG_MARKER_DQT;
571 /* sub-driver description */
572 static const struct sd_desc sd_desc = {
575 .nctrls = ARRAY_SIZE(sd_ctrls),
581 .pkt_scan = sd_pkt_scan,
582 .querymenu = sd_querymenu,
583 .get_jcomp = sd_get_jcomp,
584 .set_jcomp = sd_set_jcomp,
587 /* -- module initialisation -- */
588 static const __devinitdata struct usb_device_id device_table[] = {
589 {USB_DEVICE(0x05e1, 0x0893)},
592 MODULE_DEVICE_TABLE(usb, device_table);
594 /* -- device connect -- */
595 static int sd_probe(struct usb_interface *intf,
596 const struct usb_device_id *id)
598 return gspca_dev_probe(intf, id, &sd_desc, sizeof(struct sd),
602 static struct usb_driver sd_driver = {
604 .id_table = device_table,
606 .disconnect = gspca_disconnect,
608 .suspend = gspca_suspend,
609 .resume = gspca_resume,
613 /* -- module insert / remove -- */
614 static int __init sd_mod_init(void)
617 ret = usb_register(&sd_driver);
623 static void __exit sd_mod_exit(void)
625 usb_deregister(&sd_driver);
626 info("deregistered");
629 module_init(sd_mod_init);
630 module_exit(sd_mod_exit);