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 <linux/usb.h>
70 #include <linux/mutex.h>
74 static int video_nr = -1;
75 static int swapRGB = 0; /* default for auto sleect */
76 static int swapRGB_on = 0; /* default to allow auto select; -1=swap never, +1= swap always */
78 static unsigned int debug = 0;
80 #define PDEBUG(level, fmt, args...) \
83 info("[%s:%d] " fmt, __FUNCTION__, __LINE__ , ## args); \
90 #define DRIVER_VERSION "v0.25"
91 #define DRIVER_AUTHOR "Kevin Sisson <kjsisson@bellsouth.net>"
92 #define DRIVER_DESC "STV0680 USB Camera Driver"
94 MODULE_AUTHOR (DRIVER_AUTHOR);
95 MODULE_DESCRIPTION (DRIVER_DESC);
96 MODULE_LICENSE ("GPL");
97 module_param(debug, int, S_IRUGO | S_IWUSR);
98 MODULE_PARM_DESC (debug, "Debug enabled or not");
99 module_param(swapRGB_on, int, 0);
100 MODULE_PARM_DESC (swapRGB_on, "Red/blue swap: 1=always, 0=auto, -1=never");
101 module_param(video_nr, int, 0);
103 /********************************************************************
107 * This is a shameless copy from the USB-cpia driver (linux kernel
108 * version 2.3.29 or so, I have no idea what this code actually does ;).
109 * Actually it seems to be a copy of a shameless copy of the bttv-driver.
110 * Or that is a copy of a shameless copy of ... (To the powers: is there
111 * no generic kernel-function to do this sort of stuff?)
113 * Yes, it was a shameless copy from the bttv-driver. IIRC, Alan says
114 * there will be one, but apparentely not yet -jerdfelt
116 * So I copied it again for the ov511 driver -claudio
118 * Same for the se401 driver -Jeroen
120 * And the STV0680 driver - Kevin
121 ********************************************************************/
122 static void *rvmalloc (unsigned long size)
127 size = PAGE_ALIGN(size);
128 mem = vmalloc_32 (size);
132 memset (mem, 0, size); /* Clear the ram out, no junk to the user */
133 adr = (unsigned long) mem;
135 SetPageReserved(vmalloc_to_page((void *)adr));
142 static void rvfree (void *mem, unsigned long size)
149 adr = (unsigned long) mem;
150 while ((long) size > 0) {
151 ClearPageReserved(vmalloc_to_page((void *)adr));
159 /*********************************************************************
160 * pencam read/write functions
161 ********************************************************************/
163 static int stv_sndctrl (int set, struct usb_stv *stv680, unsigned short req, unsigned short value, unsigned char *buffer, int size)
169 ret = usb_control_msg (stv680->udev,
170 usb_rcvctrlpipe (stv680->udev, 0),
172 (USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_ENDPOINT),
173 value, 0, buffer, size, PENCAM_TIMEOUT);
177 ret = usb_control_msg (stv680->udev,
178 usb_sndctrlpipe (stv680->udev, 0),
180 (USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_ENDPOINT),
181 value, 0, buffer, size, PENCAM_TIMEOUT);
185 ret = usb_control_msg (stv680->udev,
186 usb_rcvctrlpipe (stv680->udev, 0),
188 (USB_DIR_IN | USB_RECIP_DEVICE),
189 value, 0, buffer, size, PENCAM_TIMEOUT);
193 ret = usb_control_msg (stv680->udev,
194 usb_sndctrlpipe (stv680->udev, 0),
196 (USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE),
197 value, 0, buffer, size, PENCAM_TIMEOUT);
201 if ((ret < 0) && (req != 0x0a)) {
202 PDEBUG (1, "STV(e): usb_control_msg error %i, request = 0x%x, error = %i", set, req, ret);
207 static int stv_set_config (struct usb_stv *dev, int configuration, int interface, int alternate)
210 if (configuration != dev->udev->actconfig->desc.bConfigurationValue
211 || usb_reset_configuration (dev->udev) < 0) {
212 PDEBUG (1, "STV(e): FAILED to reset configuration %i", configuration);
215 if (usb_set_interface (dev->udev, interface, alternate) < 0) {
216 PDEBUG (1, "STV(e): FAILED to set alternate interface %i", alternate);
222 static int stv_stop_video (struct usb_stv *dev)
227 buf = kmalloc (40, GFP_KERNEL);
229 PDEBUG (0, "STV(e): Out of (small buf) memory");
233 /* this is a high priority command; it stops all lower order commands */
234 if ((i = stv_sndctrl (1, dev, 0x04, 0x0000, buf, 0x0)) < 0) {
235 i = stv_sndctrl (0, dev, 0x80, 0, buf, 0x02); /* Get Last Error; 2 = busy */
236 PDEBUG (1, "STV(i): last error: %i, command = 0x%x", buf[0], buf[1]);
238 PDEBUG (1, "STV(i): Camera reset to idle mode.");
241 if ((i = stv_set_config (dev, 1, 0, 0)) < 0)
242 PDEBUG (1, "STV(e): Reset config during exit failed");
244 /* get current mode */
246 if ((i = stv_sndctrl (0, dev, 0x87, 0, buf, 0x08)) != 0x08) /* get mode */
247 PDEBUG (0, "STV(e): Stop_video: problem setting original mode");
248 if (dev->origMode != buf[0]) {
250 buf[0] = (unsigned char) dev->origMode;
251 if ((i = stv_sndctrl (3, dev, 0x07, 0x0100, buf, 0x08)) != 0x08) {
252 PDEBUG (0, "STV(e): Stop_video: Set_Camera_Mode failed");
256 i = stv_sndctrl (0, dev, 0x87, 0, buf, 0x08);
257 if ((i != 0x08) || (buf[0] != dev->origMode)) {
258 PDEBUG (0, "STV(e): camera NOT set to original resolution.");
261 PDEBUG (0, "STV(i): Camera set to original resolution");
268 static int stv_set_video_mode (struct usb_stv *dev)
270 int i, stop_video = 1;
273 buf = kmalloc (40, GFP_KERNEL);
275 PDEBUG (0, "STV(e): Out of (small buf) memory");
279 if ((i = stv_set_config (dev, 1, 0, 0)) < 0) {
284 i = stv_sndctrl (2, dev, 0x06, 0x0100, buf, 0x12);
285 if (!(i > 0) && (buf[8] == 0x53) && (buf[9] == 0x05)) {
286 PDEBUG (1, "STV(e): Could not get descriptor 0100.");
290 /* set alternate interface 1 */
291 if ((i = stv_set_config (dev, 1, 0, 1)) < 0)
294 if ((i = stv_sndctrl (0, dev, 0x85, 0, buf, 0x10)) != 0x10)
296 PDEBUG (1, "STV(i): Setting video mode.");
297 /* Switch to Video mode: 0x0100 = VGA (640x480), 0x0000 = CIF (352x288) 0x0300 = QVGA (320x240) */
298 if ((i = stv_sndctrl (1, dev, 0x09, dev->VideoMode, buf, 0x0)) < 0) {
307 stv_stop_video (dev);
315 static int stv_init (struct usb_stv *stv680)
318 unsigned char *buffer;
319 unsigned long int bufsize;
321 buffer = kzalloc (40, GFP_KERNEL);
322 if (buffer == NULL) {
323 PDEBUG (0, "STV(e): Out of (small buf) memory");
328 /* set config 1, interface 0, alternate 0 */
329 if ((i = stv_set_config (stv680, 1, 0, 0)) < 0) {
331 PDEBUG (0, "STV(e): set config 1,0,0 failed");
334 /* ping camera to be sure STV0680 is present */
335 if ((i = stv_sndctrl (0, stv680, 0x88, 0x5678, buffer, 0x02)) != 0x02)
337 if ((buffer[0] != 0x56) || (buffer[1] != 0x78)) {
338 PDEBUG (1, "STV(e): camera ping failed!!");
342 /* get camera descriptor */
343 if ((i = stv_sndctrl (2, stv680, 0x06, 0x0200, buffer, 0x09)) != 0x09)
345 i = stv_sndctrl (2, stv680, 0x06, 0x0200, buffer, 0x22);
346 if (!(i >= 0) && (buffer[7] == 0xa0) && (buffer[8] == 0x23)) {
347 PDEBUG (1, "STV(e): Could not get descriptor 0200.");
350 if ((i = stv_sndctrl (0, stv680, 0x8a, 0, buffer, 0x02)) != 0x02)
352 if ((i = stv_sndctrl (0, stv680, 0x8b, 0, buffer, 0x24)) != 0x24)
354 if ((i = stv_sndctrl (0, stv680, 0x85, 0, buffer, 0x10)) != 0x10)
357 stv680->SupportedModes = buffer[7];
358 i = stv680->SupportedModes;
368 if (stv680->SupportedModes == 0) {
369 PDEBUG (0, "STV(e): There are NO supported STV680 modes!!");
374 PDEBUG (0, "STV(i): CIF is supported");
376 PDEBUG (0, "STV(i): QVGA is supported");
378 /* FW rev, ASIC rev, sensor ID */
379 PDEBUG (1, "STV(i): Firmware rev is %i.%i", buffer[0], buffer[1]);
380 PDEBUG (1, "STV(i): ASIC rev is %i.%i", buffer[2], buffer[3]);
381 PDEBUG (1, "STV(i): Sensor ID is %i", (buffer[4]*16) + (buffer[5]>>4));
383 /* set alternate interface 1 */
384 if ((i = stv_set_config (stv680, 1, 0, 1)) < 0)
387 if ((i = stv_sndctrl (0, stv680, 0x85, 0, buffer, 0x10)) != 0x10)
389 if ((i = stv_sndctrl (0, stv680, 0x8d, 0, buffer, 0x08)) != 0x08)
392 PDEBUG (0, "STV(i): Camera has %i pictures.", i);
394 /* get current mode */
395 if ((i = stv_sndctrl (0, stv680, 0x87, 0, buffer, 0x08)) != 0x08)
397 stv680->origMode = buffer[0]; /* 01 = VGA, 03 = QVGA, 00 = CIF */
399 /* This will attemp CIF mode, if supported. If not, set to QVGA */
400 memset (buffer, 0, 8);
403 else if (stv680->QVGA)
405 if ((i = stv_sndctrl (3, stv680, 0x07, 0x0100, buffer, 0x08)) != 0x08) {
406 PDEBUG (0, "STV(i): Set_Camera_Mode failed");
411 stv_sndctrl (0, stv680, 0x87, 0, buffer, 0x08);
412 if (((stv680->CIF == 1) && (buffer[0] != 0x00)) || ((stv680->QVGA == 1) && (buffer[0] != 0x03))) {
413 PDEBUG (0, "STV(e): Error setting camera video mode!");
417 if (buffer[0] == 0) {
418 stv680->VideoMode = 0x0000;
419 PDEBUG (0, "STV(i): Video Mode set to CIF");
421 if (buffer[0] == 0x03) {
422 stv680->VideoMode = 0x0300;
423 PDEBUG (0, "STV(i): Video Mode set to QVGA");
426 if ((i = stv_sndctrl (0, stv680, 0x8f, 0, buffer, 0x10)) != 0x10)
428 bufsize = (buffer[0] << 24) | (buffer[1] << 16) | (buffer[2] << 8) | (buffer[3]);
429 stv680->cwidth = (buffer[4] << 8) | (buffer[5]); /* ->camera = 322, 356, 644 */
430 stv680->cheight = (buffer[6] << 8) | (buffer[7]); /* ->camera = 242, 292, 484 */
431 stv680->origGain = buffer[12];
436 i = stv_sndctrl (0, stv680, 0x80, 0, buffer, 0x02); /* Get Last Error */
437 PDEBUG (1, "STV(i): last error: %i, command = 0x%x", buffer[0], buffer[1]);
444 /* video = 320x240, 352x288 */
445 if (stv680->CIF == 1) {
446 stv680->maxwidth = 352;
447 stv680->maxheight = 288;
448 stv680->vwidth = 352;
449 stv680->vheight = 288;
451 if (stv680->QVGA == 1) {
452 stv680->maxwidth = 320;
453 stv680->maxheight = 240;
454 stv680->vwidth = 320;
455 stv680->vheight = 240;
458 stv680->rawbufsize = bufsize; /* must be ./. by 8 */
459 stv680->maxframesize = bufsize * 3; /* RGB size */
460 PDEBUG (2, "STV(i): cwidth = %i, cheight = %i", stv680->cwidth, stv680->cheight);
461 PDEBUG (1, "STV(i): width = %i, height = %i, rawbufsize = %li", stv680->vwidth, stv680->vheight, stv680->rawbufsize);
463 /* some default values */
464 stv680->bulk_in_endpointAddr = 0x82;
467 stv680->framecount = 0;
468 stv680->readcount = 0;
469 stv680->streaming = 0;
470 /* bright, white, colour, hue, contrast are set by software, not in stv0680 */
471 stv680->brightness = 32767;
472 stv680->chgbright = 0;
473 stv680->whiteness = 0; /* only for greyscale */
474 stv680->colour = 32767;
475 stv680->contrast = 32767;
477 stv680->palette = STV_VIDEO_PALETTE;
478 stv680->depth = 24; /* rgb24 bits */
479 if ((swapRGB_on == 0) && (swapRGB == 0))
480 PDEBUG (1, "STV(i): swapRGB is (auto) OFF");
481 else if ((swapRGB_on == 0) && (swapRGB == 1))
482 PDEBUG (1, "STV(i): swapRGB is (auto) ON");
483 else if (swapRGB_on == 1)
484 PDEBUG (1, "STV(i): swapRGB is (forced) ON");
485 else if (swapRGB_on == -1)
486 PDEBUG (1, "STV(i): swapRGB is (forced) OFF");
488 if (stv_set_video_mode (stv680) < 0) {
489 PDEBUG (0, "STV(e): Could not set video mode in stv_init");
496 /***************** last of pencam routines *******************/
498 /****************************************************************************
500 ***************************************************************************/
501 #define stv680_file(name, variable, field) \
502 static ssize_t show_##name(struct class_device *class_dev, char *buf) \
504 struct video_device *vdev = to_video_device(class_dev); \
505 struct usb_stv *stv = video_get_drvdata(vdev); \
506 return sprintf(buf, field, stv->variable); \
508 static CLASS_DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
510 stv680_file(model, camera_name, "%s\n");
511 stv680_file(in_use, user, "%d\n");
512 stv680_file(streaming, streaming, "%d\n");
513 stv680_file(palette, palette, "%i\n");
514 stv680_file(frames_total, readcount, "%d\n");
515 stv680_file(frames_read, framecount, "%d\n");
516 stv680_file(packets_dropped, dropped, "%d\n");
517 stv680_file(decoding_errors, error, "%d\n");
519 static int stv680_create_sysfs_files(struct video_device *vdev)
523 rc = video_device_create_file(vdev, &class_device_attr_model);
525 rc = video_device_create_file(vdev, &class_device_attr_in_use);
526 if (rc) goto err_model;
527 rc = video_device_create_file(vdev, &class_device_attr_streaming);
528 if (rc) goto err_inuse;
529 rc = video_device_create_file(vdev, &class_device_attr_palette);
530 if (rc) goto err_stream;
531 rc = video_device_create_file(vdev, &class_device_attr_frames_total);
532 if (rc) goto err_pal;
533 rc = video_device_create_file(vdev, &class_device_attr_frames_read);
534 if (rc) goto err_framtot;
535 rc = video_device_create_file(vdev, &class_device_attr_packets_dropped);
536 if (rc) goto err_framread;
537 rc = video_device_create_file(vdev, &class_device_attr_decoding_errors);
538 if (rc) goto err_dropped;
543 video_device_remove_file(vdev, &class_device_attr_packets_dropped);
545 video_device_remove_file(vdev, &class_device_attr_frames_read);
547 video_device_remove_file(vdev, &class_device_attr_frames_total);
549 video_device_remove_file(vdev, &class_device_attr_palette);
551 video_device_remove_file(vdev, &class_device_attr_streaming);
553 video_device_remove_file(vdev, &class_device_attr_in_use);
555 video_device_remove_file(vdev, &class_device_attr_model);
560 static void stv680_remove_sysfs_files(struct video_device *vdev)
562 video_device_remove_file(vdev, &class_device_attr_model);
563 video_device_remove_file(vdev, &class_device_attr_in_use);
564 video_device_remove_file(vdev, &class_device_attr_streaming);
565 video_device_remove_file(vdev, &class_device_attr_palette);
566 video_device_remove_file(vdev, &class_device_attr_frames_total);
567 video_device_remove_file(vdev, &class_device_attr_frames_read);
568 video_device_remove_file(vdev, &class_device_attr_packets_dropped);
569 video_device_remove_file(vdev, &class_device_attr_decoding_errors);
572 /********************************************************************
574 *******************************************************************/
576 static int stv680_get_pict (struct usb_stv *stv680, struct video_picture *p)
578 /* This sets values for v4l interface. max/min = 65535/0 */
580 p->brightness = stv680->brightness;
581 p->whiteness = stv680->whiteness; /* greyscale */
582 p->colour = stv680->colour;
583 p->contrast = stv680->contrast;
584 p->hue = stv680->hue;
585 p->palette = stv680->palette;
586 p->depth = stv680->depth;
590 static int stv680_set_pict (struct usb_stv *stv680, struct video_picture *p)
592 /* See above stv680_get_pict */
594 if (p->palette != STV_VIDEO_PALETTE) {
595 PDEBUG (2, "STV(e): Palette set error in _set_pic");
599 if (stv680->brightness != p->brightness) {
600 stv680->chgbright = 1;
601 stv680->brightness = p->brightness;
604 stv680->whiteness = p->whiteness; /* greyscale */
605 stv680->colour = p->colour;
606 stv680->contrast = p->contrast;
607 stv680->hue = p->hue;
608 stv680->palette = p->palette;
609 stv680->depth = p->depth;
614 static void stv680_video_irq (struct urb *urb)
616 struct usb_stv *stv680 = urb->context;
617 int length = urb->actual_length;
619 if (length < stv680->rawbufsize)
620 PDEBUG (2, "STV(i): Lost data in transfer: exp %li, got %i", stv680->rawbufsize, length);
623 if (!stv680->streaming)
627 PDEBUG (0, "STV(e): device vapourished in video_irq");
631 /* 0 sized packets happen if we are to fast, but sometimes the camera
632 keeps sending them forever...
634 if (length && !urb->status) {
635 stv680->nullpackets = 0;
636 switch (stv680->scratch[stv680->scratch_next].state) {
643 memcpy (stv680->scratch[stv680->scratch_next].data,
644 (unsigned char *) urb->transfer_buffer, length);
645 stv680->scratch[stv680->scratch_next].state = BUFFER_READY;
646 stv680->scratch[stv680->scratch_next].length = length;
647 if (waitqueue_active (&stv680->wq)) {
648 wake_up_interruptible (&stv680->wq);
650 stv680->scratch_overflow = 0;
651 stv680->scratch_next++;
652 if (stv680->scratch_next >= STV680_NUMSCRATCH)
653 stv680->scratch_next = 0;
657 stv680->nullpackets++;
658 if (stv680->nullpackets > STV680_MAX_NULLPACKETS) {
659 if (waitqueue_active (&stv680->wq)) {
660 wake_up_interruptible (&stv680->wq);
665 /* Resubmit urb for new data */
667 urb->dev = stv680->udev;
668 if (usb_submit_urb (urb, GFP_ATOMIC))
669 PDEBUG (0, "STV(e): urb burned down in video irq");
673 static int stv680_start_stream (struct usb_stv *stv680)
678 stv680->streaming = 1;
680 /* Do some memory allocation */
681 for (i = 0; i < STV680_NUMFRAMES; i++) {
682 stv680->frame[i].data = stv680->fbuf + i * stv680->maxframesize;
683 stv680->frame[i].curpix = 0;
685 /* packet size = 4096 */
686 for (i = 0; i < STV680_NUMSBUF; i++) {
687 stv680->sbuf[i].data = kmalloc (stv680->rawbufsize, GFP_KERNEL);
688 if (stv680->sbuf[i].data == NULL) {
689 PDEBUG (0, "STV(e): Could not kmalloc raw data buffer %i", i);
694 stv680->scratch_next = 0;
695 stv680->scratch_use = 0;
696 stv680->scratch_overflow = 0;
697 for (i = 0; i < STV680_NUMSCRATCH; i++) {
698 stv680->scratch[i].data = kmalloc (stv680->rawbufsize, GFP_KERNEL);
699 if (stv680->scratch[i].data == NULL) {
700 PDEBUG (0, "STV(e): Could not kmalloc raw scratch buffer %i", i);
703 stv680->scratch[i].state = BUFFER_UNUSED;
706 for (i = 0; i < STV680_NUMSBUF; i++) {
707 urb = usb_alloc_urb (0, GFP_KERNEL);
711 /* sbuf is urb->transfer_buffer, later gets memcpyed to scratch */
712 usb_fill_bulk_urb (urb, stv680->udev,
713 usb_rcvbulkpipe (stv680->udev, stv680->bulk_in_endpointAddr),
714 stv680->sbuf[i].data, stv680->rawbufsize,
715 stv680_video_irq, stv680);
716 stv680->urb[i] = urb;
717 err = usb_submit_urb (stv680->urb[i], GFP_KERNEL);
719 PDEBUG (0, "STV(e): urb burned down in start stream");
720 } /* i STV680_NUMSBUF */
722 stv680->framecount = 0;
726 static int stv680_stop_stream (struct usb_stv *stv680)
730 if (!stv680->streaming || !stv680->udev)
733 stv680->streaming = 0;
735 for (i = 0; i < STV680_NUMSBUF; i++)
736 if (stv680->urb[i]) {
737 usb_kill_urb (stv680->urb[i]);
738 usb_free_urb (stv680->urb[i]);
739 stv680->urb[i] = NULL;
740 kfree(stv680->sbuf[i].data);
742 for (i = 0; i < STV680_NUMSCRATCH; i++) {
743 kfree(stv680->scratch[i].data);
744 stv680->scratch[i].data = NULL;
750 static int stv680_set_size (struct usb_stv *stv680, int width, int height)
752 int wasstreaming = stv680->streaming;
754 /* Check to see if we need to change */
755 if ((stv680->vwidth == width) && (stv680->vheight == height))
758 PDEBUG (1, "STV(i): size request for %i x %i", width, height);
759 /* Check for a valid mode */
760 if ((!width || !height) || ((width & 1) || (height & 1))) {
761 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);
765 if ((width < (stv680->maxwidth / 2)) || (height < (stv680->maxheight / 2))) {
766 width = stv680->maxwidth / 2;
767 height = stv680->maxheight / 2;
768 } else if ((width >= 158) && (width <= 166) && (stv680->QVGA == 1)) {
771 } else if ((width >= 172) && (width <= 180) && (stv680->CIF == 1)) {
774 } else if ((width >= 318) && (width <= 350) && (stv680->QVGA == 1)) {
777 } else if ((width >= 350) && (width <= 358) && (stv680->CIF == 1)) {
781 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);
785 /* Stop a current stream and start it again at the new size */
787 stv680_stop_stream (stv680);
788 stv680->vwidth = width;
789 stv680->vheight = height;
790 PDEBUG (1, "STV(i): size set to %i x %i", stv680->vwidth, stv680->vheight);
792 stv680_start_stream (stv680);
797 /**********************************************************************
799 **********************************************************************/
801 /******* routines from the pencam program; hey, they work! ********/
804 * STV0680 Vision Camera Chipset Driver
805 * Copyright (C) 2000 Adam Harrison <adam@antispin.org>
811 #define AD(x, y, w) (((y)*(w)+(x))*3)
813 static void bayer_unshuffle (struct usb_stv *stv680, struct stv680_scratch *buffer)
816 int w = stv680->cwidth;
817 int vw = stv680->cwidth, vh = stv680->cheight;
819 int colour = 0, bayer = 0;
820 unsigned char *raw = buffer->data;
821 struct stv680_frame *frame = &stv680->frame[stv680->curframe];
822 unsigned char *output = frame->data;
823 unsigned char *temp = frame->data;
824 int offset = buffer->offset;
826 if (frame->curpix == 0) {
827 if (frame->grabstate == FRAME_READY) {
828 frame->grabstate = FRAME_GRABBING;
831 if (offset != frame->curpix) { /* Regard frame as lost :( */
837 if ((stv680->vwidth == 320) || (stv680->vwidth == 160)) {
841 if ((stv680->vwidth == 352) || (stv680->vwidth == 176)) {
846 memset (output, 0, 3 * vw * vh); /* clear output matrix. */
848 for (y = 0; y < vh; y++) {
849 for (x = 0; x < vw; x++) {
851 p = *(raw + y * w + (x >> 1));
853 p = *(raw + y * w + (x >> 1) + (w >> 1));
874 i = (y * vw + x) * 3;
875 *(output + i + colour) = (unsigned char) p;
880 /****** gamma correction plus hardcoded white balance */
881 /* Thanks to Alexander Schwartx <alexander.schwartx@gmx.net> for this code.
882 Correction values red[], green[], blue[], are generated by
883 (pow(i/256.0, GAMMA)*255.0)*white balanceRGB where GAMMA=0.55, 1<i<255.
884 White balance (RGB)= 1.0, 1.17, 1.48. Values are calculated as double float and
885 converted to unsigned char. Values are in stv680.h */
887 for (y = 0; y < vh; y++) {
888 for (x = 0; x < vw; x++) {
889 i = (y * vw + x) * 3;
890 *(output + i) = red[*(output + i)];
891 *(output + i + 1) = green[*(output + i + 1)];
892 *(output + i + 2) = blue[*(output + i + 2)];
896 /****** bayer demosaic ******/
897 for (y = 1; y < (vh - 1); y++) {
898 for (x = 1; x < (vw - 1); x++) { /* work out pixel type */
907 case 0: /* green. blue lr, red tb */
908 *(output + AD (x, y, vw) + BLUE) = ((int) *(output + AD (x - 1, y, vw) + BLUE) + (int) *(output + AD (x + 1, y, vw) + BLUE)) >> 1;
909 *(output + AD (x, y, vw) + RED) = ((int) *(output + AD (x, y - 1, vw) + RED) + (int) *(output + AD (x, y + 1, vw) + RED)) >> 1;
912 case 1: /* blue. green lrtb, red diagonals */
913 *(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;
914 *(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;
917 case 2: /* red. green lrtb, blue diagonals */
918 *(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;
919 *(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;
922 case 3: /* green. red lr, blue tb */
923 *(output + AD (x, y, vw) + RED) = ((int) *(output + AD (x - 1, y, vw) + RED) + (int) *(output + AD (x + 1, y, vw) + RED)) >> 1;
924 *(output + AD (x, y, vw) + BLUE) = ((int) *(output + AD (x, y - 1, vw) + BLUE) + (int) *(output + AD (x, y + 1, vw) + BLUE)) >> 1;
928 } /* for y - end demosaic */
930 /* fix top and bottom row, left and right side */
932 memcpy (output, (output + i), i);
933 memcpy ((output + (vh * i)), (output + ((vh - 1) * i)), i);
934 for (y = 0; y < vh; y++) {
936 memcpy ((output + i), (output + i + 3), 3);
937 memcpy ((output + i + (vw * 3)), (output + i + (vw - 1) * 3), 3);
940 /* process all raw data, then trim to size if necessary */
941 if ((stv680->vwidth == 160) || (stv680->vwidth == 176)) {
943 for (y = 0; y < vh; y++) {
945 for (x = 0; x < vw; x++) {
946 p = (y * vw + x) * 3;
948 *(output + i) = *(output + p);
949 *(output + i + 1) = *(output + p + 1);
950 *(output + i + 2) = *(output + p + 2);
957 /* reset to proper width */
958 if ((stv680->vwidth == 160)) {
962 if ((stv680->vwidth == 176)) {
967 /* output is RGB; some programs want BGR */
968 /* swapRGB_on=0 -> program decides; swapRGB_on=1, always swap */
969 /* swapRGB_on=-1, never swap */
970 if (((swapRGB == 1) && (swapRGB_on != -1)) || (swapRGB_on == 1)) {
971 for (y = 0; y < vh; y++) {
972 for (x = 0; x < vw; x++) {
973 i = (y * vw + x) * 3;
974 *(temp) = *(output + i);
975 *(output + i) = *(output + i + 2);
976 *(output + i + 2) = *(temp);
981 if (stv680->chgbright == 1) {
982 if (stv680->brightness >= 32767) {
983 p = (stv680->brightness - 32767) / 256;
984 for (x = 0; x < (vw * vh * 3); x++) {
985 if ((*(output + x) + (unsigned char) p) > 255)
988 *(output + x) += (unsigned char) p;
991 p = (32767 - stv680->brightness) / 256;
992 for (x = 0; x < (vw * vh * 3); x++) {
993 if ((unsigned char) p > *(output + x))
996 *(output + x) -= (unsigned char) p;
1002 frame->curlinepix = 0;
1003 frame->grabstate = FRAME_DONE;
1004 stv680->framecount++;
1005 stv680->readcount++;
1006 if (stv680->frame[(stv680->curframe + 1) & (STV680_NUMFRAMES - 1)].grabstate == FRAME_READY) {
1007 stv680->curframe = (stv680->curframe + 1) & (STV680_NUMFRAMES - 1);
1010 } /* bayer_unshuffle */
1012 /******* end routines from the pencam program *********/
1014 static int stv680_newframe (struct usb_stv *stv680, int framenr)
1018 while (stv680->streaming && (stv680->frame[framenr].grabstate == FRAME_READY || stv680->frame[framenr].grabstate == FRAME_GRABBING)) {
1019 if (!stv680->frame[framenr].curpix) {
1022 wait_event_interruptible (stv680->wq, (stv680->scratch[stv680->scratch_use].state == BUFFER_READY));
1024 if (stv680->nullpackets > STV680_MAX_NULLPACKETS) {
1025 stv680->nullpackets = 0;
1026 PDEBUG (2, "STV(i): too many null length packets, restarting capture");
1027 stv680_stop_stream (stv680);
1028 stv680_start_stream (stv680);
1030 if (stv680->scratch[stv680->scratch_use].state != BUFFER_READY) {
1031 stv680->frame[framenr].grabstate = FRAME_ERROR;
1032 PDEBUG (2, "STV(e): FRAME_ERROR in _newframe");
1035 stv680->scratch[stv680->scratch_use].state = BUFFER_BUSY;
1037 bayer_unshuffle (stv680, &stv680->scratch[stv680->scratch_use]);
1039 stv680->scratch[stv680->scratch_use].state = BUFFER_UNUSED;
1040 stv680->scratch_use++;
1041 if (stv680->scratch_use >= STV680_NUMSCRATCH)
1042 stv680->scratch_use = 0;
1043 if (errors > STV680_MAX_ERRORS) {
1045 PDEBUG (2, "STV(i): too many errors, restarting capture");
1046 stv680_stop_stream (stv680);
1047 stv680_start_stream (stv680);
1054 /*********************************************************************
1056 *********************************************************************/
1058 static int stv_open (struct inode *inode, struct file *file)
1060 struct video_device *dev = video_devdata(file);
1061 struct usb_stv *stv680 = video_get_drvdata(dev);
1064 /* we are called with the BKL held */
1066 err = stv_init (stv680); /* main initialization routine for camera */
1069 stv680->fbuf = rvmalloc (stv680->maxframesize * STV680_NUMFRAMES);
1070 if (!stv680->fbuf) {
1071 PDEBUG (0, "STV(e): Could not rvmalloc frame bufer");
1074 file->private_data = dev;
1082 static int stv_close (struct inode *inode, struct file *file)
1084 struct video_device *dev = file->private_data;
1085 struct usb_stv *stv680 = video_get_drvdata(dev);
1088 for (i = 0; i < STV680_NUMFRAMES; i++)
1089 stv680->frame[i].grabstate = FRAME_UNUSED;
1090 if (stv680->streaming)
1091 stv680_stop_stream (stv680);
1093 if ((i = stv_stop_video (stv680)) < 0)
1094 PDEBUG (1, "STV(e): stop_video failed in stv_close");
1096 rvfree (stv680->fbuf, stv680->maxframesize * STV680_NUMFRAMES);
1099 if (stv680->removed) {
1102 PDEBUG (0, "STV(i): device unregistered");
1104 file->private_data = NULL;
1108 static int stv680_do_ioctl (struct inode *inode, struct file *file,
1109 unsigned int cmd, void *arg)
1111 struct video_device *vdev = file->private_data;
1112 struct usb_stv *stv680 = video_get_drvdata(vdev);
1119 struct video_capability *b = arg;
1121 strcpy (b->name, stv680->camera_name);
1122 b->type = VID_TYPE_CAPTURE;
1125 b->maxwidth = stv680->maxwidth;
1126 b->maxheight = stv680->maxheight;
1127 b->minwidth = stv680->maxwidth / 2;
1128 b->minheight = stv680->maxheight / 2;
1132 struct video_channel *v = arg;
1134 if (v->channel != 0)
1138 v->type = VIDEO_TYPE_CAMERA;
1139 strcpy (v->name, "STV Camera");
1143 struct video_channel *v = arg;
1144 if (v->channel != 0)
1149 struct video_picture *p = arg;
1151 stv680_get_pict (stv680, p);
1155 struct video_picture *p = arg;
1157 if (stv680_set_pict (stv680, p))
1162 struct video_window *vw = arg;
1168 if (vw->width != stv680->vwidth) {
1169 if (stv680_set_size (stv680, vw->width, vw->height)) {
1170 PDEBUG (2, "STV(e): failed (from user) set size in VIDIOCSWIN");
1177 struct video_window *vw = arg;
1179 vw->x = 0; /* FIXME */
1184 vw->width = stv680->vwidth;
1185 vw->height = stv680->vheight;
1189 struct video_mbuf *vm = arg;
1192 memset (vm, 0, sizeof (*vm));
1193 vm->size = STV680_NUMFRAMES * stv680->maxframesize;
1194 vm->frames = STV680_NUMFRAMES;
1195 for (i = 0; i < STV680_NUMFRAMES; i++)
1196 vm->offsets[i] = stv680->maxframesize * i;
1199 case VIDIOCMCAPTURE:{
1200 struct video_mmap *vm = arg;
1202 if (vm->format != STV_VIDEO_PALETTE) {
1203 PDEBUG (2, "STV(i): VIDIOCMCAPTURE vm.format (%i) != VIDEO_PALETTE (%i)",
1204 vm->format, STV_VIDEO_PALETTE);
1205 if ((vm->format == 3) && (swapRGB_on == 0)) {
1206 PDEBUG (2, "STV(i): VIDIOCMCAPTURE swapRGB is (auto) ON");
1207 /* this may fix those apps (e.g., xawtv) that want BGR */
1212 if (vm->frame >= STV680_NUMFRAMES) {
1213 PDEBUG (2, "STV(e): VIDIOCMCAPTURE vm.frame > NUMFRAMES");
1216 if ((stv680->frame[vm->frame].grabstate == FRAME_ERROR)
1217 || (stv680->frame[vm->frame].grabstate == FRAME_GRABBING)) {
1218 PDEBUG (2, "STV(e): VIDIOCMCAPTURE grabstate (%i) error",
1219 stv680->frame[vm->frame].grabstate);
1222 /* Is this according to the v4l spec??? */
1223 if (stv680->vwidth != vm->width) {
1224 if (stv680_set_size (stv680, vm->width, vm->height)) {
1225 PDEBUG (2, "STV(e): VIDIOCMCAPTURE set_size failed");
1229 stv680->frame[vm->frame].grabstate = FRAME_READY;
1231 if (!stv680->streaming)
1232 stv680_start_stream (stv680);
1240 if (*frame < 0 || *frame >= STV680_NUMFRAMES) {
1241 PDEBUG (2, "STV(e): Bad frame # in VIDIOCSYNC");
1244 ret = stv680_newframe (stv680, *frame);
1245 stv680->frame[*frame].grabstate = FRAME_UNUSED;
1249 struct video_buffer *vb = arg;
1251 memset (vb, 0, sizeof (*vb));
1258 PDEBUG (2, "STV(e): VIDIOCCAPTURE failed");
1270 return -ENOIOCTLCMD;
1276 static int stv680_ioctl(struct inode *inode, struct file *file,
1277 unsigned int cmd, unsigned long arg)
1279 return video_usercopy(inode, file, cmd, arg, stv680_do_ioctl);
1282 static int stv680_mmap (struct file *file, struct vm_area_struct *vma)
1284 struct video_device *dev = file->private_data;
1285 struct usb_stv *stv680 = video_get_drvdata(dev);
1286 unsigned long start = vma->vm_start;
1287 unsigned long size = vma->vm_end-vma->vm_start;
1288 unsigned long page, pos;
1290 mutex_lock(&stv680->lock);
1292 if (stv680->udev == NULL) {
1293 mutex_unlock(&stv680->lock);
1296 if (size > (((STV680_NUMFRAMES * stv680->maxframesize) + PAGE_SIZE - 1)
1297 & ~(PAGE_SIZE - 1))) {
1298 mutex_unlock(&stv680->lock);
1301 pos = (unsigned long) stv680->fbuf;
1303 page = vmalloc_to_pfn((void *)pos);
1304 if (remap_pfn_range(vma, start, page, PAGE_SIZE, PAGE_SHARED)) {
1305 mutex_unlock(&stv680->lock);
1310 if (size > PAGE_SIZE)
1315 mutex_unlock(&stv680->lock);
1320 static ssize_t stv680_read (struct file *file, char __user *buf,
1321 size_t count, loff_t *ppos)
1323 struct video_device *dev = file->private_data;
1324 unsigned long int realcount = count;
1326 struct usb_stv *stv680 = video_get_drvdata(dev);
1327 unsigned long int i;
1329 if (STV680_NUMFRAMES != 2) {
1330 PDEBUG (0, "STV(e): STV680_NUMFRAMES needs to be 2!");
1333 if (stv680->udev == NULL)
1335 if (realcount > (stv680->vwidth * stv680->vheight * 3))
1336 realcount = stv680->vwidth * stv680->vheight * 3;
1338 /* Shouldn't happen: */
1339 if (stv680->frame[0].grabstate == FRAME_GRABBING) {
1340 PDEBUG (2, "STV(e): FRAME_GRABBING in stv680_read");
1343 stv680->frame[0].grabstate = FRAME_READY;
1344 stv680->frame[1].grabstate = FRAME_UNUSED;
1345 stv680->curframe = 0;
1347 if (!stv680->streaming)
1348 stv680_start_stream (stv680);
1350 if (!stv680->streaming) {
1351 ret = stv680_newframe (stv680, 0); /* ret should = 0 */
1354 ret = stv680_newframe (stv680, 0);
1357 if ((i = copy_to_user (buf, stv680->frame[0].data, realcount)) != 0) {
1358 PDEBUG (2, "STV(e): copy_to_user frame 0 failed, ret count = %li", i);
1364 stv680->frame[0].grabstate = FRAME_UNUSED;
1368 static struct file_operations stv680_fops = {
1369 .owner = THIS_MODULE,
1371 .release = stv_close,
1372 .read = stv680_read,
1373 .mmap = stv680_mmap,
1374 .ioctl = stv680_ioctl,
1375 .compat_ioctl = v4l_compat_ioctl32,
1376 .llseek = no_llseek,
1378 static struct video_device stv680_template = {
1379 .owner = THIS_MODULE,
1380 .name = "STV0680 USB camera",
1381 .type = VID_TYPE_CAPTURE,
1382 .hardware = VID_HARDWARE_SE401,
1383 .fops = &stv680_fops,
1384 .release = video_device_release,
1388 static int stv680_probe (struct usb_interface *intf, const struct usb_device_id *id)
1390 struct usb_device *dev = interface_to_usbdev(intf);
1391 struct usb_host_interface *interface;
1392 struct usb_stv *stv680 = NULL;
1393 char *camera_name = NULL;
1396 /* We don't handle multi-config cameras */
1397 if (dev->descriptor.bNumConfigurations != 1) {
1398 PDEBUG (0, "STV(e): Number of Configurations != 1");
1402 interface = &intf->altsetting[0];
1403 /* Is it a STV680? */
1404 if ((le16_to_cpu(dev->descriptor.idVendor) == USB_PENCAM_VENDOR_ID) &&
1405 (le16_to_cpu(dev->descriptor.idProduct) == USB_PENCAM_PRODUCT_ID)) {
1406 camera_name = "STV0680";
1407 PDEBUG (0, "STV(i): STV0680 camera found.");
1408 } else if ((le16_to_cpu(dev->descriptor.idVendor) == USB_CREATIVEGOMINI_VENDOR_ID) &&
1409 (le16_to_cpu(dev->descriptor.idProduct) == USB_CREATIVEGOMINI_PRODUCT_ID)) {
1410 camera_name = "Creative WebCam Go Mini";
1411 PDEBUG (0, "STV(i): Creative WebCam Go Mini found.");
1413 PDEBUG (0, "STV(e): Vendor/Product ID do not match STV0680 or Creative WebCam Go Mini values.");
1414 PDEBUG (0, "STV(e): Check that the STV0680 or Creative WebCam Go Mini camera is connected to the computer.");
1419 if ((stv680 = kzalloc (sizeof (*stv680), GFP_KERNEL)) == NULL) {
1420 PDEBUG (0, "STV(e): couldn't kmalloc stv680 struct.");
1426 stv680->camera_name = camera_name;
1428 stv680->vdev = video_device_alloc();
1429 if (!stv680->vdev) {
1433 memcpy(stv680->vdev, &stv680_template, sizeof(stv680_template));
1434 stv680->vdev->dev = &intf->dev;
1435 video_set_drvdata(stv680->vdev, stv680);
1437 memcpy (stv680->vdev->name, stv680->camera_name, strlen (stv680->camera_name));
1438 init_waitqueue_head (&stv680->wq);
1439 mutex_init (&stv680->lock);
1442 if (video_register_device (stv680->vdev, VFL_TYPE_GRABBER, video_nr) == -1) {
1443 PDEBUG (0, "STV(e): video_register_device failed");
1447 PDEBUG (0, "STV(i): registered new video device: video%d", stv680->vdev->minor);
1449 usb_set_intfdata (intf, stv680);
1450 retval = stv680_create_sysfs_files(stv680->vdev);
1456 video_unregister_device(stv680->vdev);
1458 video_device_release(stv680->vdev);
1464 static inline void usb_stv680_remove_disconnected (struct usb_stv *stv680)
1468 stv680->udev = NULL;
1469 stv680->frame[0].grabstate = FRAME_ERROR;
1470 stv680->frame[1].grabstate = FRAME_ERROR;
1471 stv680->streaming = 0;
1473 wake_up_interruptible (&stv680->wq);
1475 for (i = 0; i < STV680_NUMSBUF; i++)
1476 if (stv680->urb[i]) {
1477 usb_kill_urb (stv680->urb[i]);
1478 usb_free_urb (stv680->urb[i]);
1479 stv680->urb[i] = NULL;
1480 kfree(stv680->sbuf[i].data);
1482 for (i = 0; i < STV680_NUMSCRATCH; i++)
1483 kfree(stv680->scratch[i].data);
1484 PDEBUG (0, "STV(i): %s disconnected", stv680->camera_name);
1486 /* Free the memory */
1490 static void stv680_disconnect (struct usb_interface *intf)
1492 struct usb_stv *stv680 = usb_get_intfdata (intf);
1494 usb_set_intfdata (intf, NULL);
1497 /* We don't want people trying to open up the device */
1499 stv680_remove_sysfs_files(stv680->vdev);
1500 video_unregister_device(stv680->vdev);
1501 stv680->vdev = NULL;
1503 if (!stv680->user) {
1504 usb_stv680_remove_disconnected (stv680);
1506 stv680->removed = 1;
1511 static struct usb_driver stv680_driver = {
1513 .probe = stv680_probe,
1514 .disconnect = stv680_disconnect,
1515 .id_table = device_table
1518 /********************************************************************
1520 ********************************************************************/
1522 static int __init usb_stv680_init (void)
1524 if (usb_register (&stv680_driver) < 0) {
1525 PDEBUG (0, "STV(e): Could not setup STV0680 driver");
1528 PDEBUG (0, "STV(i): usb camera driver version %s registering", DRIVER_VERSION);
1530 info(DRIVER_DESC " " DRIVER_VERSION);
1534 static void __exit usb_stv680_exit (void)
1536 usb_deregister (&stv680_driver);
1537 PDEBUG (0, "STV(i): driver deregistered");
1540 module_init (usb_stv680_init);
1541 module_exit (usb_stv680_exit);