2 * STV0680 USB Camera Driver, by Kevin Sisson (kjsisson@bellsouth.net)
4 * Thanks to STMicroelectronics for information on the usb commands, and
5 * to Steve Miller at STM for his help and encouragement while I was
8 * This driver is based heavily on the
9 * Endpoints (formerly known as AOX) se401 USB Camera Driver
10 * Copyright (c) 2000 Jeroen B. Vreeken (pe1rxq@amsat.org)
12 * Still somewhat based on the Linux ov511 driver.
14 * This program is free software; you can redistribute it and/or modify it
15 * under the terms of the GNU General Public License as published by the
16 * Free Software Foundation; either version 2 of the License, or (at your
17 * option) any later version.
19 * This program is distributed in the hope that it will be useful, but
20 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
21 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software Foundation,
26 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
29 * ver 0.1 October, 2001. Initial attempt.
31 * ver 0.2 November, 2001. Fixed asbility to resize, added brightness
32 * function, made more stable (?)
34 * ver 0.21 Nov, 2001. Added gamma correction and white balance,
35 * due to Alexander Schwartz. Still trying to
36 * improve stablility. Moved stuff into stv680.h
38 * ver 0.22 Nov, 2001. Added sharpen function (by Michael Sweet,
39 * mike@easysw.com) from GIMP, also used in pencam.
40 * Simple, fast, good integer math routine.
42 * ver 0.23 Dec, 2001 (gkh)
43 * Took out sharpen function, ran code through
44 * Lindent, and did other minor tweaks to get
45 * things to work properly with 2.5.1
47 * ver 0.24 Jan, 2002 (kjs)
48 * Fixed the problem with webcam crashing after
49 * two pictures. Changed the way pic is halved to
50 * improve quality. Got rid of green line around
51 * frame. Fix brightness reset when changing size
52 * bug. Adjusted gamma filters slightly.
54 * ver 0.25 Jan, 2002 (kjs)
55 * Fixed a bug in which the driver sometimes attempted
56 * to set to a non-supported size. This allowed
57 * gnomemeeting to work.
58 * Fixed proc entry removal bug.
61 #include <linux/module.h>
62 #include <linux/init.h>
63 #include <linux/vmalloc.h>
64 #include <linux/slab.h>
65 #include <linux/pagemap.h>
66 #include <linux/errno.h>
67 #include <linux/videodev.h>
68 #include <media/v4l2-common.h>
69 #include <media/v4l2-ioctl.h>
70 #include <linux/usb.h>
71 #include <linux/mutex.h>
75 static int video_nr = -1;
77 static int swapRGB; /* 0 = default for auto select */
79 /* 0 = default to allow auto select; -1 = swap never, +1 = swap always */
80 static int swapRGB_on;
82 static unsigned int debug;
84 #define PDEBUG(level, fmt, args...) \
87 printk(KERN_INFO KBUILD_MODNAME " [%s:%d] \n" fmt, \
88 __func__, __LINE__ , ## args); \
95 #define DRIVER_VERSION "v0.25"
96 #define DRIVER_AUTHOR "Kevin Sisson <kjsisson@bellsouth.net>"
97 #define DRIVER_DESC "STV0680 USB Camera Driver"
99 MODULE_AUTHOR (DRIVER_AUTHOR);
100 MODULE_DESCRIPTION (DRIVER_DESC);
101 MODULE_LICENSE ("GPL");
102 module_param(debug, int, S_IRUGO | S_IWUSR);
103 MODULE_PARM_DESC (debug, "Debug enabled or not");
104 module_param(swapRGB_on, int, 0);
105 MODULE_PARM_DESC (swapRGB_on, "Red/blue swap: 1=always, 0=auto, -1=never");
106 module_param(video_nr, int, 0);
108 /********************************************************************
112 * This is a shameless copy from the USB-cpia driver (linux kernel
113 * version 2.3.29 or so, I have no idea what this code actually does ;).
114 * Actually it seems to be a copy of a shameless copy of the bttv-driver.
115 * Or that is a copy of a shameless copy of ... (To the powers: is there
116 * no generic kernel-function to do this sort of stuff?)
118 * Yes, it was a shameless copy from the bttv-driver. IIRC, Alan says
119 * there will be one, but apparentely not yet -jerdfelt
121 * So I copied it again for the ov511 driver -claudio
123 * Same for the se401 driver -Jeroen
125 * And the STV0680 driver - Kevin
126 ********************************************************************/
127 static void *rvmalloc (unsigned long size)
132 size = PAGE_ALIGN(size);
133 mem = vmalloc_32 (size);
137 memset (mem, 0, size); /* Clear the ram out, no junk to the user */
138 adr = (unsigned long) mem;
140 SetPageReserved(vmalloc_to_page((void *)adr));
147 static void rvfree (void *mem, unsigned long size)
154 adr = (unsigned long) mem;
155 while ((long) size > 0) {
156 ClearPageReserved(vmalloc_to_page((void *)adr));
164 /*********************************************************************
165 * pencam read/write functions
166 ********************************************************************/
168 static int stv_sndctrl (int set, struct usb_stv *stv680, unsigned short req, unsigned short value, unsigned char *buffer, int size)
174 ret = usb_control_msg (stv680->udev,
175 usb_rcvctrlpipe (stv680->udev, 0),
177 (USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_ENDPOINT),
178 value, 0, buffer, size, PENCAM_TIMEOUT);
182 ret = usb_control_msg (stv680->udev,
183 usb_sndctrlpipe (stv680->udev, 0),
185 (USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_ENDPOINT),
186 value, 0, buffer, size, PENCAM_TIMEOUT);
190 ret = usb_control_msg (stv680->udev,
191 usb_rcvctrlpipe (stv680->udev, 0),
193 (USB_DIR_IN | USB_RECIP_DEVICE),
194 value, 0, buffer, size, PENCAM_TIMEOUT);
198 ret = usb_control_msg (stv680->udev,
199 usb_sndctrlpipe (stv680->udev, 0),
201 (USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE),
202 value, 0, buffer, size, PENCAM_TIMEOUT);
206 if ((ret < 0) && (req != 0x0a)) {
207 PDEBUG (1, "STV(e): usb_control_msg error %i, request = 0x%x, error = %i", set, req, ret);
212 static int stv_set_config (struct usb_stv *dev, int configuration, int interface, int alternate)
215 if (configuration != dev->udev->actconfig->desc.bConfigurationValue
216 || usb_reset_configuration (dev->udev) < 0) {
217 PDEBUG (1, "STV(e): FAILED to reset configuration %i", configuration);
220 if (usb_set_interface (dev->udev, interface, alternate) < 0) {
221 PDEBUG (1, "STV(e): FAILED to set alternate interface %i", alternate);
227 static int stv_stop_video (struct usb_stv *dev)
232 buf = kmalloc (40, GFP_KERNEL);
234 PDEBUG (0, "STV(e): Out of (small buf) memory");
238 /* this is a high priority command; it stops all lower order commands */
239 if ((i = stv_sndctrl (1, dev, 0x04, 0x0000, buf, 0x0)) < 0) {
240 i = stv_sndctrl (0, dev, 0x80, 0, buf, 0x02); /* Get Last Error; 2 = busy */
241 PDEBUG (1, "STV(i): last error: %i, command = 0x%x", buf[0], buf[1]);
243 PDEBUG (1, "STV(i): Camera reset to idle mode.");
246 if ((i = stv_set_config (dev, 1, 0, 0)) < 0)
247 PDEBUG (1, "STV(e): Reset config during exit failed");
249 /* get current mode */
251 if ((i = stv_sndctrl (0, dev, 0x87, 0, buf, 0x08)) != 0x08) /* get mode */
252 PDEBUG (0, "STV(e): Stop_video: problem setting original mode");
253 if (dev->origMode != buf[0]) {
255 buf[0] = (unsigned char) dev->origMode;
256 if ((i = stv_sndctrl (3, dev, 0x07, 0x0100, buf, 0x08)) != 0x08) {
257 PDEBUG (0, "STV(e): Stop_video: Set_Camera_Mode failed");
261 i = stv_sndctrl (0, dev, 0x87, 0, buf, 0x08);
262 if ((i != 0x08) || (buf[0] != dev->origMode)) {
263 PDEBUG (0, "STV(e): camera NOT set to original resolution.");
266 PDEBUG (0, "STV(i): Camera set to original resolution");
273 static int stv_set_video_mode (struct usb_stv *dev)
275 int i, stop_video = 1;
278 buf = kmalloc (40, GFP_KERNEL);
280 PDEBUG (0, "STV(e): Out of (small buf) memory");
284 if ((i = stv_set_config (dev, 1, 0, 0)) < 0) {
289 i = stv_sndctrl (2, dev, 0x06, 0x0100, buf, 0x12);
290 if (!(i > 0) && (buf[8] == 0x53) && (buf[9] == 0x05)) {
291 PDEBUG (1, "STV(e): Could not get descriptor 0100.");
295 /* set alternate interface 1 */
296 if ((i = stv_set_config (dev, 1, 0, 1)) < 0)
299 if ((i = stv_sndctrl (0, dev, 0x85, 0, buf, 0x10)) != 0x10)
301 PDEBUG (1, "STV(i): Setting video mode.");
302 /* Switch to Video mode: 0x0100 = VGA (640x480), 0x0000 = CIF (352x288) 0x0300 = QVGA (320x240) */
303 if ((i = stv_sndctrl (1, dev, 0x09, dev->VideoMode, buf, 0x0)) < 0) {
312 stv_stop_video (dev);
320 static int stv_init (struct usb_stv *stv680)
323 unsigned char *buffer;
324 unsigned long int bufsize;
326 buffer = kzalloc (40, GFP_KERNEL);
327 if (buffer == NULL) {
328 PDEBUG (0, "STV(e): Out of (small buf) memory");
333 /* set config 1, interface 0, alternate 0 */
334 if ((i = stv_set_config (stv680, 1, 0, 0)) < 0) {
336 PDEBUG (0, "STV(e): set config 1,0,0 failed");
339 /* ping camera to be sure STV0680 is present */
340 if ((i = stv_sndctrl (0, stv680, 0x88, 0x5678, buffer, 0x02)) != 0x02)
342 if ((buffer[0] != 0x56) || (buffer[1] != 0x78)) {
343 PDEBUG (1, "STV(e): camera ping failed!!");
347 /* get camera descriptor */
348 if ((i = stv_sndctrl (2, stv680, 0x06, 0x0200, buffer, 0x09)) != 0x09)
350 i = stv_sndctrl (2, stv680, 0x06, 0x0200, buffer, 0x22);
351 if (!(i >= 0) && (buffer[7] == 0xa0) && (buffer[8] == 0x23)) {
352 PDEBUG (1, "STV(e): Could not get descriptor 0200.");
355 if ((i = stv_sndctrl (0, stv680, 0x8a, 0, buffer, 0x02)) != 0x02)
357 if ((i = stv_sndctrl (0, stv680, 0x8b, 0, buffer, 0x24)) != 0x24)
359 if ((i = stv_sndctrl (0, stv680, 0x85, 0, buffer, 0x10)) != 0x10)
362 stv680->SupportedModes = buffer[7];
363 i = stv680->SupportedModes;
373 if (stv680->SupportedModes == 0) {
374 PDEBUG (0, "STV(e): There are NO supported STV680 modes!!");
379 PDEBUG (0, "STV(i): CIF is supported");
381 PDEBUG (0, "STV(i): QVGA is supported");
383 /* FW rev, ASIC rev, sensor ID */
384 PDEBUG (1, "STV(i): Firmware rev is %i.%i", buffer[0], buffer[1]);
385 PDEBUG (1, "STV(i): ASIC rev is %i.%i", buffer[2], buffer[3]);
386 PDEBUG (1, "STV(i): Sensor ID is %i", (buffer[4]*16) + (buffer[5]>>4));
388 /* set alternate interface 1 */
389 if ((i = stv_set_config (stv680, 1, 0, 1)) < 0)
392 if ((i = stv_sndctrl (0, stv680, 0x85, 0, buffer, 0x10)) != 0x10)
394 if ((i = stv_sndctrl (0, stv680, 0x8d, 0, buffer, 0x08)) != 0x08)
397 PDEBUG (0, "STV(i): Camera has %i pictures.", i);
399 /* get current mode */
400 if ((i = stv_sndctrl (0, stv680, 0x87, 0, buffer, 0x08)) != 0x08)
402 stv680->origMode = buffer[0]; /* 01 = VGA, 03 = QVGA, 00 = CIF */
404 /* This will attemp CIF mode, if supported. If not, set to QVGA */
405 memset (buffer, 0, 8);
408 else if (stv680->QVGA)
410 if ((i = stv_sndctrl (3, stv680, 0x07, 0x0100, buffer, 0x08)) != 0x08) {
411 PDEBUG (0, "STV(i): Set_Camera_Mode failed");
416 stv_sndctrl (0, stv680, 0x87, 0, buffer, 0x08);
417 if (((stv680->CIF == 1) && (buffer[0] != 0x00)) || ((stv680->QVGA == 1) && (buffer[0] != 0x03))) {
418 PDEBUG (0, "STV(e): Error setting camera video mode!");
422 if (buffer[0] == 0) {
423 stv680->VideoMode = 0x0000;
424 PDEBUG (0, "STV(i): Video Mode set to CIF");
426 if (buffer[0] == 0x03) {
427 stv680->VideoMode = 0x0300;
428 PDEBUG (0, "STV(i): Video Mode set to QVGA");
431 if ((i = stv_sndctrl (0, stv680, 0x8f, 0, buffer, 0x10)) != 0x10)
433 bufsize = (buffer[0] << 24) | (buffer[1] << 16) | (buffer[2] << 8) | (buffer[3]);
434 stv680->cwidth = (buffer[4] << 8) | (buffer[5]); /* ->camera = 322, 356, 644 */
435 stv680->cheight = (buffer[6] << 8) | (buffer[7]); /* ->camera = 242, 292, 484 */
436 stv680->origGain = buffer[12];
441 i = stv_sndctrl (0, stv680, 0x80, 0, buffer, 0x02); /* Get Last Error */
442 PDEBUG (1, "STV(i): last error: %i, command = 0x%x", buffer[0], buffer[1]);
449 /* video = 320x240, 352x288 */
450 if (stv680->CIF == 1) {
451 stv680->maxwidth = 352;
452 stv680->maxheight = 288;
453 stv680->vwidth = 352;
454 stv680->vheight = 288;
456 if (stv680->QVGA == 1) {
457 stv680->maxwidth = 320;
458 stv680->maxheight = 240;
459 stv680->vwidth = 320;
460 stv680->vheight = 240;
463 stv680->rawbufsize = bufsize; /* must be ./. by 8 */
464 stv680->maxframesize = bufsize * 3; /* RGB size */
465 PDEBUG (2, "STV(i): cwidth = %i, cheight = %i", stv680->cwidth, stv680->cheight);
466 PDEBUG (1, "STV(i): width = %i, height = %i, rawbufsize = %li", stv680->vwidth, stv680->vheight, stv680->rawbufsize);
468 /* some default values */
469 stv680->bulk_in_endpointAddr = 0x82;
472 stv680->framecount = 0;
473 stv680->readcount = 0;
474 stv680->streaming = 0;
475 /* bright, white, colour, hue, contrast are set by software, not in stv0680 */
476 stv680->brightness = 32767;
477 stv680->chgbright = 0;
478 stv680->whiteness = 0; /* only for greyscale */
479 stv680->colour = 32767;
480 stv680->contrast = 32767;
482 stv680->palette = STV_VIDEO_PALETTE;
483 stv680->depth = 24; /* rgb24 bits */
484 if ((swapRGB_on == 0) && (swapRGB == 0))
485 PDEBUG (1, "STV(i): swapRGB is (auto) OFF");
486 else if ((swapRGB_on == 0) && (swapRGB == 1))
487 PDEBUG (1, "STV(i): swapRGB is (auto) ON");
488 else if (swapRGB_on == 1)
489 PDEBUG (1, "STV(i): swapRGB is (forced) ON");
490 else if (swapRGB_on == -1)
491 PDEBUG (1, "STV(i): swapRGB is (forced) OFF");
493 if (stv_set_video_mode (stv680) < 0) {
494 PDEBUG (0, "STV(e): Could not set video mode in stv_init");
501 /***************** last of pencam routines *******************/
503 /****************************************************************************
505 ***************************************************************************/
506 #define stv680_file(name, variable, field) \
507 static ssize_t show_##name(struct device *class_dev, \
508 struct device_attribute *attr, char *buf) \
510 struct video_device *vdev = to_video_device(class_dev); \
511 struct usb_stv *stv = video_get_drvdata(vdev); \
512 return sprintf(buf, field, stv->variable); \
514 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
516 stv680_file(model, camera_name, "%s\n");
517 stv680_file(in_use, user, "%d\n");
518 stv680_file(streaming, streaming, "%d\n");
519 stv680_file(palette, palette, "%i\n");
520 stv680_file(frames_total, readcount, "%d\n");
521 stv680_file(frames_read, framecount, "%d\n");
522 stv680_file(packets_dropped, dropped, "%d\n");
523 stv680_file(decoding_errors, error, "%d\n");
525 static int stv680_create_sysfs_files(struct video_device *vdev)
529 rc = device_create_file(&vdev->dev, &dev_attr_model);
531 rc = device_create_file(&vdev->dev, &dev_attr_in_use);
532 if (rc) goto err_model;
533 rc = device_create_file(&vdev->dev, &dev_attr_streaming);
534 if (rc) goto err_inuse;
535 rc = device_create_file(&vdev->dev, &dev_attr_palette);
536 if (rc) goto err_stream;
537 rc = device_create_file(&vdev->dev, &dev_attr_frames_total);
538 if (rc) goto err_pal;
539 rc = device_create_file(&vdev->dev, &dev_attr_frames_read);
540 if (rc) goto err_framtot;
541 rc = device_create_file(&vdev->dev, &dev_attr_packets_dropped);
542 if (rc) goto err_framread;
543 rc = device_create_file(&vdev->dev, &dev_attr_decoding_errors);
544 if (rc) goto err_dropped;
549 device_remove_file(&vdev->dev, &dev_attr_packets_dropped);
551 device_remove_file(&vdev->dev, &dev_attr_frames_read);
553 device_remove_file(&vdev->dev, &dev_attr_frames_total);
555 device_remove_file(&vdev->dev, &dev_attr_palette);
557 device_remove_file(&vdev->dev, &dev_attr_streaming);
559 device_remove_file(&vdev->dev, &dev_attr_in_use);
561 device_remove_file(&vdev->dev, &dev_attr_model);
563 PDEBUG(0, "STV(e): Could not create sysfs files");
567 static void stv680_remove_sysfs_files(struct video_device *vdev)
569 device_remove_file(&vdev->dev, &dev_attr_model);
570 device_remove_file(&vdev->dev, &dev_attr_in_use);
571 device_remove_file(&vdev->dev, &dev_attr_streaming);
572 device_remove_file(&vdev->dev, &dev_attr_palette);
573 device_remove_file(&vdev->dev, &dev_attr_frames_total);
574 device_remove_file(&vdev->dev, &dev_attr_frames_read);
575 device_remove_file(&vdev->dev, &dev_attr_packets_dropped);
576 device_remove_file(&vdev->dev, &dev_attr_decoding_errors);
579 /********************************************************************
581 *******************************************************************/
583 static int stv680_get_pict (struct usb_stv *stv680, struct video_picture *p)
585 /* This sets values for v4l interface. max/min = 65535/0 */
587 p->brightness = stv680->brightness;
588 p->whiteness = stv680->whiteness; /* greyscale */
589 p->colour = stv680->colour;
590 p->contrast = stv680->contrast;
591 p->hue = stv680->hue;
592 p->palette = stv680->palette;
593 p->depth = stv680->depth;
597 static int stv680_set_pict (struct usb_stv *stv680, struct video_picture *p)
599 /* See above stv680_get_pict */
601 if (p->palette != STV_VIDEO_PALETTE) {
602 PDEBUG (2, "STV(e): Palette set error in _set_pic");
606 if (stv680->brightness != p->brightness) {
607 stv680->chgbright = 1;
608 stv680->brightness = p->brightness;
611 stv680->whiteness = p->whiteness; /* greyscale */
612 stv680->colour = p->colour;
613 stv680->contrast = p->contrast;
614 stv680->hue = p->hue;
615 stv680->palette = p->palette;
616 stv680->depth = p->depth;
621 static void stv680_video_irq (struct urb *urb)
623 struct usb_stv *stv680 = urb->context;
624 int length = urb->actual_length;
626 if (length < stv680->rawbufsize)
627 PDEBUG (2, "STV(i): Lost data in transfer: exp %li, got %i", stv680->rawbufsize, length);
630 if (!stv680->streaming)
634 PDEBUG (0, "STV(e): device vapourished in video_irq");
638 /* 0 sized packets happen if we are to fast, but sometimes the camera
639 keeps sending them forever...
641 if (length && !urb->status) {
642 stv680->nullpackets = 0;
643 switch (stv680->scratch[stv680->scratch_next].state) {
650 memcpy (stv680->scratch[stv680->scratch_next].data,
651 (unsigned char *) urb->transfer_buffer, length);
652 stv680->scratch[stv680->scratch_next].state = BUFFER_READY;
653 stv680->scratch[stv680->scratch_next].length = length;
654 if (waitqueue_active (&stv680->wq)) {
655 wake_up_interruptible (&stv680->wq);
657 stv680->scratch_overflow = 0;
658 stv680->scratch_next++;
659 if (stv680->scratch_next >= STV680_NUMSCRATCH)
660 stv680->scratch_next = 0;
664 stv680->nullpackets++;
665 if (stv680->nullpackets > STV680_MAX_NULLPACKETS) {
666 if (waitqueue_active (&stv680->wq)) {
667 wake_up_interruptible (&stv680->wq);
672 /* Resubmit urb for new data */
674 urb->dev = stv680->udev;
675 if (usb_submit_urb (urb, GFP_ATOMIC))
676 PDEBUG (0, "STV(e): urb burned down in video irq");
680 static int stv680_start_stream (struct usb_stv *stv680)
685 stv680->streaming = 1;
687 /* Do some memory allocation */
688 for (i = 0; i < STV680_NUMFRAMES; i++) {
689 stv680->frame[i].data = stv680->fbuf + i * stv680->maxframesize;
690 stv680->frame[i].curpix = 0;
692 /* packet size = 4096 */
693 for (i = 0; i < STV680_NUMSBUF; i++) {
694 stv680->sbuf[i].data = kmalloc (stv680->rawbufsize, GFP_KERNEL);
695 if (stv680->sbuf[i].data == NULL) {
696 PDEBUG (0, "STV(e): Could not kmalloc raw data buffer %i", i);
701 stv680->scratch_next = 0;
702 stv680->scratch_use = 0;
703 stv680->scratch_overflow = 0;
704 for (i = 0; i < STV680_NUMSCRATCH; i++) {
705 stv680->scratch[i].data = kmalloc (stv680->rawbufsize, GFP_KERNEL);
706 if (stv680->scratch[i].data == NULL) {
707 PDEBUG (0, "STV(e): Could not kmalloc raw scratch buffer %i", i);
710 stv680->scratch[i].state = BUFFER_UNUSED;
713 for (i = 0; i < STV680_NUMSBUF; i++) {
714 urb = usb_alloc_urb (0, GFP_KERNEL);
718 /* sbuf is urb->transfer_buffer, later gets memcpyed to scratch */
719 usb_fill_bulk_urb (urb, stv680->udev,
720 usb_rcvbulkpipe (stv680->udev, stv680->bulk_in_endpointAddr),
721 stv680->sbuf[i].data, stv680->rawbufsize,
722 stv680_video_irq, stv680);
723 stv680->urb[i] = urb;
724 err = usb_submit_urb (stv680->urb[i], GFP_KERNEL);
726 PDEBUG (0, "STV(e): urb burned down with err "
727 "%d in start stream %d", err, i);
730 } /* i STV680_NUMSBUF */
732 stv680->framecount = 0;
736 for (i = 0; i < STV680_NUMSCRATCH; i++) {
737 kfree(stv680->scratch[i].data);
738 stv680->scratch[i].data = NULL;
740 for (i = 0; i < STV680_NUMSBUF; i++) {
741 usb_kill_urb(stv680->urb[i]);
742 usb_free_urb(stv680->urb[i]);
743 stv680->urb[i] = NULL;
744 kfree(stv680->sbuf[i].data);
745 stv680->sbuf[i].data = NULL;
751 static int stv680_stop_stream (struct usb_stv *stv680)
755 if (!stv680->streaming || !stv680->udev)
758 stv680->streaming = 0;
760 for (i = 0; i < STV680_NUMSBUF; i++)
761 if (stv680->urb[i]) {
762 usb_kill_urb (stv680->urb[i]);
763 usb_free_urb (stv680->urb[i]);
764 stv680->urb[i] = NULL;
765 kfree(stv680->sbuf[i].data);
767 for (i = 0; i < STV680_NUMSCRATCH; i++) {
768 kfree(stv680->scratch[i].data);
769 stv680->scratch[i].data = NULL;
775 static int stv680_set_size (struct usb_stv *stv680, int width, int height)
777 int wasstreaming = stv680->streaming;
779 /* Check to see if we need to change */
780 if ((stv680->vwidth == width) && (stv680->vheight == height))
783 PDEBUG (1, "STV(i): size request for %i x %i", width, height);
784 /* Check for a valid mode */
785 if ((!width || !height) || ((width & 1) || (height & 1))) {
786 PDEBUG (1, "STV(e): set_size error: request: v.width = %i, v.height = %i actual: stv.width = %i, stv.height = %i", width, height, stv680->vwidth, stv680->vheight);
790 if ((width < (stv680->maxwidth / 2)) || (height < (stv680->maxheight / 2))) {
791 width = stv680->maxwidth / 2;
792 height = stv680->maxheight / 2;
793 } else if ((width >= 158) && (width <= 166) && (stv680->QVGA == 1)) {
796 } else if ((width >= 172) && (width <= 180) && (stv680->CIF == 1)) {
799 } else if ((width >= 318) && (width <= 350) && (stv680->QVGA == 1)) {
802 } else if ((width >= 350) && (width <= 358) && (stv680->CIF == 1)) {
806 PDEBUG (1, "STV(e): request for non-supported size: request: v.width = %i, v.height = %i actual: stv.width = %i, stv.height = %i", width, height, stv680->vwidth, stv680->vheight);
810 /* Stop a current stream and start it again at the new size */
812 stv680_stop_stream (stv680);
813 stv680->vwidth = width;
814 stv680->vheight = height;
815 PDEBUG (1, "STV(i): size set to %i x %i", stv680->vwidth, stv680->vheight);
817 stv680_start_stream (stv680);
822 /**********************************************************************
824 **********************************************************************/
826 /******* routines from the pencam program; hey, they work! ********/
829 * STV0680 Vision Camera Chipset Driver
830 * Copyright (C) 2000 Adam Harrison <adam@antispin.org>
836 #define AD(x, y, w) (((y)*(w)+(x))*3)
838 static void bayer_unshuffle (struct usb_stv *stv680, struct stv680_scratch *buffer)
841 int w = stv680->cwidth;
842 int vw = stv680->cwidth, vh = stv680->cheight;
844 int colour = 0, bayer = 0;
845 unsigned char *raw = buffer->data;
846 struct stv680_frame *frame = &stv680->frame[stv680->curframe];
847 unsigned char *output = frame->data;
848 unsigned char *temp = frame->data;
849 int offset = buffer->offset;
851 if (frame->curpix == 0) {
852 if (frame->grabstate == FRAME_READY) {
853 frame->grabstate = FRAME_GRABBING;
856 if (offset != frame->curpix) { /* Regard frame as lost :( */
862 if ((stv680->vwidth == 320) || (stv680->vwidth == 160)) {
866 if ((stv680->vwidth == 352) || (stv680->vwidth == 176)) {
871 memset (output, 0, 3 * vw * vh); /* clear output matrix. */
873 for (y = 0; y < vh; y++) {
874 for (x = 0; x < vw; x++) {
876 p = *(raw + y * w + (x >> 1));
878 p = *(raw + y * w + (x >> 1) + (w >> 1));
899 i = (y * vw + x) * 3;
900 *(output + i + colour) = (unsigned char) p;
905 /****** gamma correction plus hardcoded white balance */
906 /* Thanks to Alexander Schwartx <alexander.schwartx@gmx.net> for this code.
907 Correction values red[], green[], blue[], are generated by
908 (pow(i/256.0, GAMMA)*255.0)*white balanceRGB where GAMMA=0.55, 1<i<255.
909 White balance (RGB)= 1.0, 1.17, 1.48. Values are calculated as double float and
910 converted to unsigned char. Values are in stv680.h */
912 for (y = 0; y < vh; y++) {
913 for (x = 0; x < vw; x++) {
914 i = (y * vw + x) * 3;
915 *(output + i) = red[*(output + i)];
916 *(output + i + 1) = green[*(output + i + 1)];
917 *(output + i + 2) = blue[*(output + i + 2)];
921 /****** bayer demosaic ******/
922 for (y = 1; y < (vh - 1); y++) {
923 for (x = 1; x < (vw - 1); x++) { /* work out pixel type */
932 case 0: /* green. blue lr, red tb */
933 *(output + AD (x, y, vw) + BLUE) = ((int) *(output + AD (x - 1, y, vw) + BLUE) + (int) *(output + AD (x + 1, y, vw) + BLUE)) >> 1;
934 *(output + AD (x, y, vw) + RED) = ((int) *(output + AD (x, y - 1, vw) + RED) + (int) *(output + AD (x, y + 1, vw) + RED)) >> 1;
937 case 1: /* blue. green lrtb, red diagonals */
938 *(output + AD (x, y, vw) + GREEN) = ((int) *(output + AD (x - 1, y, vw) + GREEN) + (int) *(output + AD (x + 1, y, vw) + GREEN) + (int) *(output + AD (x, y - 1, vw) + GREEN) + (int) *(output + AD (x, y + 1, vw) + GREEN)) >> 2;
939 *(output + AD (x, y, vw) + RED) = ((int) *(output + AD (x - 1, y - 1, vw) + RED) + (int) *(output + AD (x - 1, y + 1, vw) + RED) + (int) *(output + AD (x + 1, y - 1, vw) + RED) + (int) *(output + AD (x + 1, y + 1, vw) + RED)) >> 2;
942 case 2: /* red. green lrtb, blue diagonals */
943 *(output + AD (x, y, vw) + GREEN) = ((int) *(output + AD (x - 1, y, vw) + GREEN) + (int) *(output + AD (x + 1, y, vw) + GREEN) + (int) *(output + AD (x, y - 1, vw) + GREEN) + (int) *(output + AD (x, y + 1, vw) + GREEN)) >> 2;
944 *(output + AD (x, y, vw) + BLUE) = ((int) *(output + AD (x - 1, y - 1, vw) + BLUE) + (int) *(output + AD (x + 1, y - 1, vw) + BLUE) + (int) *(output + AD (x - 1, y + 1, vw) + BLUE) + (int) *(output + AD (x + 1, y + 1, vw) + BLUE)) >> 2;
947 case 3: /* green. red lr, blue tb */
948 *(output + AD (x, y, vw) + RED) = ((int) *(output + AD (x - 1, y, vw) + RED) + (int) *(output + AD (x + 1, y, vw) + RED)) >> 1;
949 *(output + AD (x, y, vw) + BLUE) = ((int) *(output + AD (x, y - 1, vw) + BLUE) + (int) *(output + AD (x, y + 1, vw) + BLUE)) >> 1;
953 } /* for y - end demosaic */
955 /* fix top and bottom row, left and right side */
957 memcpy (output, (output + i), i);
958 memcpy ((output + (vh * i)), (output + ((vh - 1) * i)), i);
959 for (y = 0; y < vh; y++) {
961 memcpy ((output + i), (output + i + 3), 3);
962 memcpy ((output + i + (vw * 3)), (output + i + (vw - 1) * 3), 3);
965 /* process all raw data, then trim to size if necessary */
966 if ((stv680->vwidth == 160) || (stv680->vwidth == 176)) {
968 for (y = 0; y < vh; y++) {
970 for (x = 0; x < vw; x++) {
971 p = (y * vw + x) * 3;
973 *(output + i) = *(output + p);
974 *(output + i + 1) = *(output + p + 1);
975 *(output + i + 2) = *(output + p + 2);
982 /* reset to proper width */
983 if ((stv680->vwidth == 160)) {
987 if ((stv680->vwidth == 176)) {
992 /* output is RGB; some programs want BGR */
993 /* swapRGB_on=0 -> program decides; swapRGB_on=1, always swap */
994 /* swapRGB_on=-1, never swap */
995 if (((swapRGB == 1) && (swapRGB_on != -1)) || (swapRGB_on == 1)) {
996 for (y = 0; y < vh; y++) {
997 for (x = 0; x < vw; x++) {
998 i = (y * vw + x) * 3;
999 *(temp) = *(output + i);
1000 *(output + i) = *(output + i + 2);
1001 *(output + i + 2) = *(temp);
1006 if (stv680->chgbright == 1) {
1007 if (stv680->brightness >= 32767) {
1008 p = (stv680->brightness - 32767) / 256;
1009 for (x = 0; x < (vw * vh * 3); x++) {
1010 if ((*(output + x) + (unsigned char) p) > 255)
1011 *(output + x) = 255;
1013 *(output + x) += (unsigned char) p;
1016 p = (32767 - stv680->brightness) / 256;
1017 for (x = 0; x < (vw * vh * 3); x++) {
1018 if ((unsigned char) p > *(output + x))
1021 *(output + x) -= (unsigned char) p;
1027 frame->curlinepix = 0;
1028 frame->grabstate = FRAME_DONE;
1029 stv680->framecount++;
1030 stv680->readcount++;
1031 if (stv680->frame[(stv680->curframe + 1) & (STV680_NUMFRAMES - 1)].grabstate == FRAME_READY) {
1032 stv680->curframe = (stv680->curframe + 1) & (STV680_NUMFRAMES - 1);
1035 } /* bayer_unshuffle */
1037 /******* end routines from the pencam program *********/
1039 static int stv680_newframe (struct usb_stv *stv680, int framenr)
1043 while (stv680->streaming && (stv680->frame[framenr].grabstate == FRAME_READY || stv680->frame[framenr].grabstate == FRAME_GRABBING)) {
1044 if (!stv680->frame[framenr].curpix) {
1047 wait_event_interruptible (stv680->wq, (stv680->scratch[stv680->scratch_use].state == BUFFER_READY));
1049 if (stv680->nullpackets > STV680_MAX_NULLPACKETS) {
1050 stv680->nullpackets = 0;
1051 PDEBUG (2, "STV(i): too many null length packets, restarting capture");
1052 stv680_stop_stream (stv680);
1053 stv680_start_stream (stv680);
1055 if (stv680->scratch[stv680->scratch_use].state != BUFFER_READY) {
1056 stv680->frame[framenr].grabstate = FRAME_ERROR;
1057 PDEBUG (2, "STV(e): FRAME_ERROR in _newframe");
1060 stv680->scratch[stv680->scratch_use].state = BUFFER_BUSY;
1062 bayer_unshuffle (stv680, &stv680->scratch[stv680->scratch_use]);
1064 stv680->scratch[stv680->scratch_use].state = BUFFER_UNUSED;
1065 stv680->scratch_use++;
1066 if (stv680->scratch_use >= STV680_NUMSCRATCH)
1067 stv680->scratch_use = 0;
1068 if (errors > STV680_MAX_ERRORS) {
1070 PDEBUG (2, "STV(i): too many errors, restarting capture");
1071 stv680_stop_stream (stv680);
1072 stv680_start_stream (stv680);
1079 /*********************************************************************
1081 *********************************************************************/
1083 static int stv_open(struct file *file)
1085 struct video_device *dev = video_devdata(file);
1086 struct usb_stv *stv680 = video_get_drvdata(dev);
1089 /* we are called with the BKL held */
1092 err = stv_init (stv680); /* main initialization routine for camera */
1095 stv680->fbuf = rvmalloc (stv680->maxframesize * STV680_NUMFRAMES);
1096 if (!stv680->fbuf) {
1097 PDEBUG (0, "STV(e): Could not rvmalloc frame bufer");
1100 file->private_data = dev;
1109 static int stv_close(struct file *file)
1111 struct video_device *dev = file->private_data;
1112 struct usb_stv *stv680 = video_get_drvdata(dev);
1115 for (i = 0; i < STV680_NUMFRAMES; i++)
1116 stv680->frame[i].grabstate = FRAME_UNUSED;
1117 if (stv680->streaming)
1118 stv680_stop_stream (stv680);
1120 if ((i = stv_stop_video (stv680)) < 0)
1121 PDEBUG (1, "STV(e): stop_video failed in stv_close");
1123 rvfree (stv680->fbuf, stv680->maxframesize * STV680_NUMFRAMES);
1126 if (stv680->removed) {
1129 PDEBUG (0, "STV(i): device unregistered");
1131 file->private_data = NULL;
1135 static long stv680_do_ioctl(struct file *file, unsigned int cmd, void *arg)
1137 struct video_device *vdev = file->private_data;
1138 struct usb_stv *stv680 = video_get_drvdata(vdev);
1145 struct video_capability *b = arg;
1147 strcpy (b->name, stv680->camera_name);
1148 b->type = VID_TYPE_CAPTURE;
1151 b->maxwidth = stv680->maxwidth;
1152 b->maxheight = stv680->maxheight;
1153 b->minwidth = stv680->maxwidth / 2;
1154 b->minheight = stv680->maxheight / 2;
1158 struct video_channel *v = arg;
1160 if (v->channel != 0)
1164 v->type = VIDEO_TYPE_CAMERA;
1165 strcpy (v->name, "STV Camera");
1169 struct video_channel *v = arg;
1170 if (v->channel != 0)
1175 struct video_picture *p = arg;
1177 stv680_get_pict (stv680, p);
1181 struct video_picture *p = arg;
1183 if (stv680_set_pict (stv680, p))
1188 struct video_window *vw = arg;
1194 if (vw->width != stv680->vwidth) {
1195 if (stv680_set_size (stv680, vw->width, vw->height)) {
1196 PDEBUG (2, "STV(e): failed (from user) set size in VIDIOCSWIN");
1203 struct video_window *vw = arg;
1205 vw->x = 0; /* FIXME */
1210 vw->width = stv680->vwidth;
1211 vw->height = stv680->vheight;
1215 struct video_mbuf *vm = arg;
1218 memset (vm, 0, sizeof (*vm));
1219 vm->size = STV680_NUMFRAMES * stv680->maxframesize;
1220 vm->frames = STV680_NUMFRAMES;
1221 for (i = 0; i < STV680_NUMFRAMES; i++)
1222 vm->offsets[i] = stv680->maxframesize * i;
1225 case VIDIOCMCAPTURE:{
1226 struct video_mmap *vm = arg;
1228 if (vm->format != STV_VIDEO_PALETTE) {
1229 PDEBUG (2, "STV(i): VIDIOCMCAPTURE vm.format (%i) != VIDEO_PALETTE (%i)",
1230 vm->format, STV_VIDEO_PALETTE);
1231 if ((vm->format == 3) && (swapRGB_on == 0)) {
1232 PDEBUG (2, "STV(i): VIDIOCMCAPTURE swapRGB is (auto) ON");
1233 /* this may fix those apps (e.g., xawtv) that want BGR */
1238 if (vm->frame >= STV680_NUMFRAMES) {
1239 PDEBUG (2, "STV(e): VIDIOCMCAPTURE vm.frame > NUMFRAMES");
1242 if ((stv680->frame[vm->frame].grabstate == FRAME_ERROR)
1243 || (stv680->frame[vm->frame].grabstate == FRAME_GRABBING)) {
1244 PDEBUG (2, "STV(e): VIDIOCMCAPTURE grabstate (%i) error",
1245 stv680->frame[vm->frame].grabstate);
1248 /* Is this according to the v4l spec??? */
1249 if (stv680->vwidth != vm->width) {
1250 if (stv680_set_size (stv680, vm->width, vm->height)) {
1251 PDEBUG (2, "STV(e): VIDIOCMCAPTURE set_size failed");
1255 stv680->frame[vm->frame].grabstate = FRAME_READY;
1257 if (!stv680->streaming)
1258 stv680_start_stream (stv680);
1266 if (*frame < 0 || *frame >= STV680_NUMFRAMES) {
1267 PDEBUG (2, "STV(e): Bad frame # in VIDIOCSYNC");
1270 ret = stv680_newframe (stv680, *frame);
1271 stv680->frame[*frame].grabstate = FRAME_UNUSED;
1275 struct video_buffer *vb = arg;
1277 memset (vb, 0, sizeof (*vb));
1284 PDEBUG (2, "STV(e): VIDIOCCAPTURE failed");
1296 return -ENOIOCTLCMD;
1302 static long stv680_ioctl(struct file *file,
1303 unsigned int cmd, unsigned long arg)
1305 return video_usercopy(file, cmd, arg, stv680_do_ioctl);
1308 static int stv680_mmap (struct file *file, struct vm_area_struct *vma)
1310 struct video_device *dev = file->private_data;
1311 struct usb_stv *stv680 = video_get_drvdata(dev);
1312 unsigned long start = vma->vm_start;
1313 unsigned long size = vma->vm_end-vma->vm_start;
1314 unsigned long page, pos;
1316 mutex_lock(&stv680->lock);
1318 if (stv680->udev == NULL) {
1319 mutex_unlock(&stv680->lock);
1322 if (size > (((STV680_NUMFRAMES * stv680->maxframesize) + PAGE_SIZE - 1)
1323 & ~(PAGE_SIZE - 1))) {
1324 mutex_unlock(&stv680->lock);
1327 pos = (unsigned long) stv680->fbuf;
1329 page = vmalloc_to_pfn((void *)pos);
1330 if (remap_pfn_range(vma, start, page, PAGE_SIZE, PAGE_SHARED)) {
1331 mutex_unlock(&stv680->lock);
1336 if (size > PAGE_SIZE)
1341 mutex_unlock(&stv680->lock);
1346 static ssize_t stv680_read (struct file *file, char __user *buf,
1347 size_t count, loff_t *ppos)
1349 struct video_device *dev = file->private_data;
1350 unsigned long int realcount = count;
1352 struct usb_stv *stv680 = video_get_drvdata(dev);
1353 unsigned long int i;
1355 if (STV680_NUMFRAMES != 2) {
1356 PDEBUG (0, "STV(e): STV680_NUMFRAMES needs to be 2!");
1359 if (stv680->udev == NULL)
1361 if (realcount > (stv680->vwidth * stv680->vheight * 3))
1362 realcount = stv680->vwidth * stv680->vheight * 3;
1364 /* Shouldn't happen: */
1365 if (stv680->frame[0].grabstate == FRAME_GRABBING) {
1366 PDEBUG (2, "STV(e): FRAME_GRABBING in stv680_read");
1369 stv680->frame[0].grabstate = FRAME_READY;
1370 stv680->frame[1].grabstate = FRAME_UNUSED;
1371 stv680->curframe = 0;
1373 if (!stv680->streaming)
1374 stv680_start_stream (stv680);
1376 if (!stv680->streaming) {
1377 ret = stv680_newframe (stv680, 0); /* ret should = 0 */
1380 ret = stv680_newframe (stv680, 0);
1383 if ((i = copy_to_user (buf, stv680->frame[0].data, realcount)) != 0) {
1384 PDEBUG (2, "STV(e): copy_to_user frame 0 failed, ret count = %li", i);
1390 stv680->frame[0].grabstate = FRAME_UNUSED;
1394 static const struct v4l2_file_operations stv680_fops = {
1395 .owner = THIS_MODULE,
1397 .release = stv_close,
1398 .read = stv680_read,
1399 .mmap = stv680_mmap,
1400 .ioctl = stv680_ioctl,
1402 static struct video_device stv680_template = {
1403 .name = "STV0680 USB camera",
1404 .fops = &stv680_fops,
1405 .release = video_device_release,
1409 static int stv680_probe (struct usb_interface *intf, const struct usb_device_id *id)
1411 struct usb_device *dev = interface_to_usbdev(intf);
1412 struct usb_host_interface *interface;
1413 struct usb_stv *stv680 = NULL;
1414 char *camera_name = NULL;
1417 /* We don't handle multi-config cameras */
1418 if (dev->descriptor.bNumConfigurations != 1) {
1419 PDEBUG (0, "STV(e): Number of Configurations != 1");
1423 interface = &intf->altsetting[0];
1424 /* Is it a STV680? */
1425 if ((le16_to_cpu(dev->descriptor.idVendor) == USB_PENCAM_VENDOR_ID) &&
1426 (le16_to_cpu(dev->descriptor.idProduct) == USB_PENCAM_PRODUCT_ID)) {
1427 camera_name = "STV0680";
1428 PDEBUG (0, "STV(i): STV0680 camera found.");
1429 } else if ((le16_to_cpu(dev->descriptor.idVendor) == USB_CREATIVEGOMINI_VENDOR_ID) &&
1430 (le16_to_cpu(dev->descriptor.idProduct) == USB_CREATIVEGOMINI_PRODUCT_ID)) {
1431 camera_name = "Creative WebCam Go Mini";
1432 PDEBUG (0, "STV(i): Creative WebCam Go Mini found.");
1434 PDEBUG (0, "STV(e): Vendor/Product ID do not match STV0680 or Creative WebCam Go Mini values.");
1435 PDEBUG (0, "STV(e): Check that the STV0680 or Creative WebCam Go Mini camera is connected to the computer.");
1440 if ((stv680 = kzalloc (sizeof (*stv680), GFP_KERNEL)) == NULL) {
1441 PDEBUG (0, "STV(e): couldn't kmalloc stv680 struct.");
1447 stv680->camera_name = camera_name;
1449 stv680->vdev = video_device_alloc();
1450 if (!stv680->vdev) {
1454 memcpy(stv680->vdev, &stv680_template, sizeof(stv680_template));
1455 stv680->vdev->parent = &intf->dev;
1456 video_set_drvdata(stv680->vdev, stv680);
1458 memcpy (stv680->vdev->name, stv680->camera_name, strlen (stv680->camera_name));
1459 init_waitqueue_head (&stv680->wq);
1460 mutex_init (&stv680->lock);
1463 if (video_register_device(stv680->vdev, VFL_TYPE_GRABBER, video_nr) < 0) {
1464 PDEBUG (0, "STV(e): video_register_device failed");
1468 PDEBUG(0, "STV(i): registered new video device: video%d",
1471 usb_set_intfdata (intf, stv680);
1472 retval = stv680_create_sysfs_files(stv680->vdev);
1478 video_unregister_device(stv680->vdev);
1480 video_device_release(stv680->vdev);
1486 static inline void usb_stv680_remove_disconnected (struct usb_stv *stv680)
1490 stv680->udev = NULL;
1491 stv680->frame[0].grabstate = FRAME_ERROR;
1492 stv680->frame[1].grabstate = FRAME_ERROR;
1493 stv680->streaming = 0;
1495 wake_up_interruptible (&stv680->wq);
1497 for (i = 0; i < STV680_NUMSBUF; i++)
1498 if (stv680->urb[i]) {
1499 usb_kill_urb (stv680->urb[i]);
1500 usb_free_urb (stv680->urb[i]);
1501 stv680->urb[i] = NULL;
1502 kfree(stv680->sbuf[i].data);
1504 for (i = 0; i < STV680_NUMSCRATCH; i++)
1505 kfree(stv680->scratch[i].data);
1506 PDEBUG (0, "STV(i): %s disconnected", stv680->camera_name);
1508 /* Free the memory */
1512 static void stv680_disconnect (struct usb_interface *intf)
1514 struct usb_stv *stv680 = usb_get_intfdata (intf);
1516 usb_set_intfdata (intf, NULL);
1519 /* We don't want people trying to open up the device */
1521 stv680_remove_sysfs_files(stv680->vdev);
1522 video_unregister_device(stv680->vdev);
1523 stv680->vdev = NULL;
1525 if (!stv680->user) {
1526 usb_stv680_remove_disconnected (stv680);
1528 stv680->removed = 1;
1533 static struct usb_driver stv680_driver = {
1535 .probe = stv680_probe,
1536 .disconnect = stv680_disconnect,
1537 .id_table = device_table
1540 /********************************************************************
1542 ********************************************************************/
1544 static int __init usb_stv680_init (void)
1546 if (usb_register (&stv680_driver) < 0) {
1547 PDEBUG (0, "STV(e): Could not setup STV0680 driver");
1550 PDEBUG (0, "STV(i): usb camera driver version %s registering", DRIVER_VERSION);
1552 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1557 static void __exit usb_stv680_exit (void)
1559 usb_deregister (&stv680_driver);
1560 PDEBUG (0, "STV(i): driver deregistered");
1563 module_init (usb_stv680_init);
1564 module_exit (usb_stv680_exit);