1 /* Linux driver for Philips webcam
2 USB and Video4Linux interface part.
3 (C) 1999-2004 Nemosoft Unv.
4 (C) 2004-2006 Luc Saillard (luc@saillard.org)
6 NOTE: this version of pwc is an unofficial (modified) release of pwc & pcwx
7 driver and thus may have bugs that are not present in the original version.
8 Please send bug reports and support requests to <luc@saillard.org>.
9 The decompression routines have been implemented by reverse-engineering the
10 Nemosoft binary pwcx module. Caveat emptor.
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 2 of the License, or
15 (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 This code forms the interface between the USB layers and the Philips
30 specific stuff. Some adanved stuff of the driver falls under an
31 NDA, signed between me and Philips B.V., Eindhoven, the Netherlands, and
32 is thus not distributed in source form. The binary pwcx.o module
33 contains the code that falls under the NDA.
35 In case you're wondering: 'pwc' stands for "Philips WebCam", but
36 I really didn't want to type 'philips_web_cam' every time (I'm lazy as
37 any Linux kernel hacker, but I don't like uncomprehensible abbreviations
40 Oh yes, convention: to disctinguish between all the various pointers to
41 device-structures, I use these names for the pointer variables:
42 udev: struct usb_device *
43 vdev: struct video_device *
44 pdev: struct pwc_devive *
48 - Alvarado: adding whitebalance code
49 - Alistar Moire: QuickCam 3000 Pro device/product ID
50 - Tony Hoyle: Creative Labs Webcam 5 device/product ID
51 - Mark Burazin: solving hang in VIDIOCSYNC when camera gets unplugged
52 - Jk Fang: Sotec Afina Eye ID
53 - Xavier Roche: QuickCam Pro 4000 ID
54 - Jens Knudsen: QuickCam Zoom ID
55 - J. Debert: QuickCam for Notebooks ID
58 #include <linux/errno.h>
59 #include <linux/init.h>
61 #include <linux/module.h>
62 #include <linux/poll.h>
63 #include <linux/slab.h>
64 #include <linux/vmalloc.h>
65 #include <linux/version.h>
69 #include "pwc-kiara.h"
70 #include "pwc-timon.h"
71 #include "pwc-dec23.h"
73 #include "pwc-uncompress.h"
75 /* Function prototypes and driver templates */
77 /* hotplug device table support */
78 static const struct usb_device_id pwc_device_table [] = {
79 { USB_DEVICE(0x0471, 0x0302) }, /* Philips models */
80 { USB_DEVICE(0x0471, 0x0303) },
81 { USB_DEVICE(0x0471, 0x0304) },
82 { USB_DEVICE(0x0471, 0x0307) },
83 { USB_DEVICE(0x0471, 0x0308) },
84 { USB_DEVICE(0x0471, 0x030C) },
85 { USB_DEVICE(0x0471, 0x0310) },
86 { USB_DEVICE(0x0471, 0x0311) }, /* Philips ToUcam PRO II */
87 { USB_DEVICE(0x0471, 0x0312) },
88 { USB_DEVICE(0x0471, 0x0313) }, /* the 'new' 720K */
89 { USB_DEVICE(0x0471, 0x0329) }, /* Philips SPC 900NC PC Camera */
90 { USB_DEVICE(0x069A, 0x0001) }, /* Askey */
91 { USB_DEVICE(0x046D, 0x08B0) }, /* Logitech QuickCam Pro 3000 */
92 { USB_DEVICE(0x046D, 0x08B1) }, /* Logitech QuickCam Notebook Pro */
93 { USB_DEVICE(0x046D, 0x08B2) }, /* Logitech QuickCam Pro 4000 */
94 { USB_DEVICE(0x046D, 0x08B3) }, /* Logitech QuickCam Zoom (old model) */
95 { USB_DEVICE(0x046D, 0x08B4) }, /* Logitech QuickCam Zoom (new model) */
96 { USB_DEVICE(0x046D, 0x08B5) }, /* Logitech QuickCam Orbit/Sphere */
97 { USB_DEVICE(0x046D, 0x08B6) }, /* Cisco VT Camera */
98 { USB_DEVICE(0x046D, 0x08B7) }, /* Logitech ViewPort AV 100 */
99 { USB_DEVICE(0x046D, 0x08B8) }, /* Logitech (reserved) */
100 { USB_DEVICE(0x055D, 0x9000) }, /* Samsung MPC-C10 */
101 { USB_DEVICE(0x055D, 0x9001) }, /* Samsung MPC-C30 */
102 { USB_DEVICE(0x055D, 0x9002) }, /* Samsung SNC-35E (Ver3.0) */
103 { USB_DEVICE(0x041E, 0x400C) }, /* Creative Webcam 5 */
104 { USB_DEVICE(0x041E, 0x4011) }, /* Creative Webcam Pro Ex */
105 { USB_DEVICE(0x04CC, 0x8116) }, /* Afina Eye */
106 { USB_DEVICE(0x06BE, 0x8116) }, /* new Afina Eye */
107 { USB_DEVICE(0x0d81, 0x1910) }, /* Visionite */
108 { USB_DEVICE(0x0d81, 0x1900) },
111 MODULE_DEVICE_TABLE(usb, pwc_device_table);
113 static int usb_pwc_probe(struct usb_interface *intf, const struct usb_device_id *id);
114 static void usb_pwc_disconnect(struct usb_interface *intf);
116 static struct usb_driver pwc_driver = {
117 .name = "Philips webcam", /* name */
118 .id_table = pwc_device_table,
119 .probe = usb_pwc_probe, /* probe() */
120 .disconnect = usb_pwc_disconnect, /* disconnect() */
123 #define MAX_DEV_HINTS 20
124 #define MAX_ISOC_ERRORS 20
126 static int default_size = PSZ_QCIF;
127 static int default_fps = 10;
128 static int default_fbufs = 3; /* Default number of frame buffers */
129 int pwc_mbufs = 2; /* Default number of mmap() buffers */
130 #ifdef CONFIG_USB_PWC_DEBUG
131 int pwc_trace = PWC_DEBUG_LEVEL;
133 static int power_save;
134 static int led_on = 100, led_off; /* defaults to LED that is on while in use */
135 static int pwc_preferred_compression = 1; /* 0..3 = uncompressed..high */
138 char serial_number[30];
140 struct pwc_device *pdev;
141 } device_hint[MAX_DEV_HINTS];
145 static int pwc_video_open(struct inode *inode, struct file *file);
146 static int pwc_video_close(struct inode *inode, struct file *file);
147 static ssize_t pwc_video_read(struct file *file, char __user *buf,
148 size_t count, loff_t *ppos);
149 static unsigned int pwc_video_poll(struct file *file, poll_table *wait);
150 static int pwc_video_ioctl(struct inode *inode, struct file *file,
151 unsigned int ioctlnr, unsigned long arg);
152 static int pwc_video_mmap(struct file *file, struct vm_area_struct *vma);
154 static const struct file_operations pwc_fops = {
155 .owner = THIS_MODULE,
156 .open = pwc_video_open,
157 .release = pwc_video_close,
158 .read = pwc_video_read,
159 .poll = pwc_video_poll,
160 .mmap = pwc_video_mmap,
161 .ioctl = pwc_video_ioctl,
163 .compat_ioctl = v4l_compat_ioctl32,
167 static struct video_device pwc_template = {
168 .name = "Philips Webcam", /* Filled in later */
169 .release = video_device_release,
174 /***************************************************************************/
176 /* Okay, this is some magic that I worked out and the reasoning behind it...
178 The biggest problem with any USB device is of course: "what to do
179 when the user unplugs the device while it is in use by an application?"
180 We have several options:
181 1) Curse them with the 7 plagues when they do (requires divine intervention)
182 2) Tell them not to (won't work: they'll do it anyway)
183 3) Oops the kernel (this will have a negative effect on a user's uptime)
184 4) Do something sensible.
186 Of course, we go for option 4.
188 It happens that this device will be linked to two times, once from
189 usb_device and once from the video_device in their respective 'private'
190 pointers. This is done when the device is probed() and all initialization
191 succeeded. The pwc_device struct links back to both structures.
193 When a device is unplugged while in use it will be removed from the
194 list of known USB devices; I also de-register it as a V4L device, but
195 unfortunately I can't free the memory since the struct is still in use
196 by the file descriptor. This free-ing is then deferend until the first
197 opportunity. Crude, but it works.
199 A small 'advantage' is that if a user unplugs the cam and plugs it back
200 in, it should get assigned the same video device minor, but unfortunately
201 it's non-trivial to re-link the cam back to the video device... (that
202 would surely be magic! :))
205 /***************************************************************************/
206 /* Private functions */
208 /* Here we want the physical address of the memory.
209 * This is used when initializing the contents of the area.
214 static void *pwc_rvmalloc(unsigned long size)
219 mem=vmalloc_32(size);
223 memset(mem, 0, size); /* Clear the ram out, no junk to the user */
224 adr=(unsigned long) mem;
227 SetPageReserved(vmalloc_to_page((void *)adr));
234 static void pwc_rvfree(void * mem, unsigned long size)
241 adr=(unsigned long) mem;
242 while ((long) size > 0)
244 ClearPageReserved(vmalloc_to_page((void *)adr));
254 static int pwc_allocate_buffers(struct pwc_device *pdev)
259 PWC_DEBUG_MEMORY(">> pwc_allocate_buffers(pdev = 0x%p)\n", pdev);
264 /* Allocate Isochronuous pipe buffers */
265 for (i = 0; i < MAX_ISO_BUFS; i++) {
266 if (pdev->sbuf[i].data == NULL) {
267 kbuf = kzalloc(ISO_BUFFER_SIZE, GFP_KERNEL);
269 PWC_ERROR("Failed to allocate iso buffer %d.\n", i);
272 PWC_DEBUG_MEMORY("Allocated iso buffer at %p.\n", kbuf);
273 pdev->sbuf[i].data = kbuf;
277 /* Allocate frame buffer structure */
278 if (pdev->fbuf == NULL) {
279 kbuf = kzalloc(default_fbufs * sizeof(struct pwc_frame_buf), GFP_KERNEL);
281 PWC_ERROR("Failed to allocate frame buffer structure.\n");
284 PWC_DEBUG_MEMORY("Allocated frame buffer structure at %p.\n", kbuf);
288 /* create frame buffers, and make circular ring */
289 for (i = 0; i < default_fbufs; i++) {
290 if (pdev->fbuf[i].data == NULL) {
291 kbuf = vmalloc(PWC_FRAME_SIZE); /* need vmalloc since frame buffer > 128K */
293 PWC_ERROR("Failed to allocate frame buffer %d.\n", i);
296 PWC_DEBUG_MEMORY("Allocated frame buffer %d at %p.\n", i, kbuf);
297 pdev->fbuf[i].data = kbuf;
298 memset(kbuf, 0, PWC_FRAME_SIZE);
302 /* Allocate decompressor table space */
303 if (DEVICE_USE_CODEC1(pdev->type))
304 err = pwc_dec1_alloc(pdev);
306 err = pwc_dec23_alloc(pdev);
309 PWC_ERROR("Failed to allocate decompress table.\n");
313 /* Allocate image buffer; double buffer for mmap() */
314 kbuf = pwc_rvmalloc(pwc_mbufs * pdev->len_per_image);
316 PWC_ERROR("Failed to allocate image buffer(s). needed (%d)\n",
317 pwc_mbufs * pdev->len_per_image);
320 PWC_DEBUG_MEMORY("Allocated image buffer at %p.\n", kbuf);
321 pdev->image_data = kbuf;
322 for (i = 0; i < pwc_mbufs; i++) {
323 pdev->images[i].offset = i * pdev->len_per_image;
324 pdev->images[i].vma_use_count = 0;
326 for (; i < MAX_IMAGES; i++) {
327 pdev->images[i].offset = 0;
332 PWC_DEBUG_MEMORY("<< pwc_allocate_buffers()\n");
336 static void pwc_free_buffers(struct pwc_device *pdev)
340 PWC_DEBUG_MEMORY("Entering free_buffers(%p).\n", pdev);
344 /* Release Iso-pipe buffers */
345 for (i = 0; i < MAX_ISO_BUFS; i++)
346 if (pdev->sbuf[i].data != NULL) {
347 PWC_DEBUG_MEMORY("Freeing ISO buffer at %p.\n", pdev->sbuf[i].data);
348 kfree(pdev->sbuf[i].data);
349 pdev->sbuf[i].data = NULL;
352 /* The same for frame buffers */
353 if (pdev->fbuf != NULL) {
354 for (i = 0; i < default_fbufs; i++) {
355 if (pdev->fbuf[i].data != NULL) {
356 PWC_DEBUG_MEMORY("Freeing frame buffer %d at %p.\n", i, pdev->fbuf[i].data);
357 vfree(pdev->fbuf[i].data);
358 pdev->fbuf[i].data = NULL;
365 /* Intermediate decompression buffer & tables */
366 if (pdev->decompress_data != NULL) {
367 PWC_DEBUG_MEMORY("Freeing decompression buffer at %p.\n", pdev->decompress_data);
368 kfree(pdev->decompress_data);
369 pdev->decompress_data = NULL;
372 /* Release image buffers */
373 if (pdev->image_data != NULL) {
374 PWC_DEBUG_MEMORY("Freeing image buffer at %p.\n", pdev->image_data);
375 pwc_rvfree(pdev->image_data, pwc_mbufs * pdev->len_per_image);
377 pdev->image_data = NULL;
379 PWC_DEBUG_MEMORY("Leaving free_buffers().\n");
382 /* The frame & image buffer mess.
384 Yes, this is a mess. Well, it used to be simple, but alas... In this
385 module, 3 buffers schemes are used to get the data from the USB bus to
386 the user program. The first scheme involves the ISO buffers (called thus
387 since they transport ISO data from the USB controller), and not really
388 interesting. Suffices to say the data from this buffer is quickly
389 gathered in an interrupt handler (pwc_isoc_handler) and placed into the
392 The frame buffer is the second scheme, and is the central element here.
393 It collects the data from a single frame from the camera (hence, the
394 name). Frames are delimited by the USB camera with a short USB packet,
395 so that's easy to detect. The frame buffers form a list that is filled
396 by the camera+USB controller and drained by the user process through
397 either read() or mmap().
399 The image buffer is the third scheme, in which frames are decompressed
400 and converted into planar format. For mmap() there is more than
401 one image buffer available.
403 The frame buffers provide the image buffering. In case the user process
404 is a bit slow, this introduces lag and some undesired side-effects.
405 The problem arises when the frame buffer is full. I used to drop the last
406 frame, which makes the data in the queue stale very quickly. But dropping
407 the frame at the head of the queue proved to be a litte bit more difficult.
408 I tried a circular linked scheme, but this introduced more problems than
411 Because filling and draining are completely asynchronous processes, this
412 requires some fiddling with pointers and mutexes.
414 Eventually, I came up with a system with 2 lists: an 'empty' frame list
415 and a 'full' frame list:
416 * Initially, all frame buffers but one are on the 'empty' list; the one
417 remaining buffer is our initial fill frame.
418 * If a frame is needed for filling, we try to take it from the 'empty'
419 list, unless that list is empty, in which case we take the buffer at
420 the head of the 'full' list.
421 * When our fill buffer has been filled, it is appended to the 'full'
423 * If a frame is needed by read() or mmap(), it is taken from the head of
424 the 'full' list, handled, and then appended to the 'empty' list. If no
425 buffer is present on the 'full' list, we wait.
426 The advantage is that the buffer that is currently being decompressed/
427 converted, is on neither list, and thus not in our way (any other scheme
428 I tried had the problem of old data lingering in the queue).
430 Whatever strategy you choose, it always remains a tradeoff: with more
431 frame buffers the chances of a missed frame are reduced. On the other
432 hand, on slower machines it introduces lag because the queue will
437 \brief Find next frame buffer to fill. Take from empty or full list, whichever comes first.
439 static int pwc_next_fill_frame(struct pwc_device *pdev)
445 spin_lock_irqsave(&pdev->ptrlock, flags);
446 if (pdev->fill_frame != NULL) {
447 /* append to 'full' list */
448 if (pdev->full_frames == NULL) {
449 pdev->full_frames = pdev->fill_frame;
450 pdev->full_frames_tail = pdev->full_frames;
453 pdev->full_frames_tail->next = pdev->fill_frame;
454 pdev->full_frames_tail = pdev->fill_frame;
457 if (pdev->empty_frames != NULL) {
458 /* We have empty frames available. That's easy */
459 pdev->fill_frame = pdev->empty_frames;
460 pdev->empty_frames = pdev->empty_frames->next;
463 /* Hmm. Take it from the full list */
465 if (pdev->full_frames == NULL) {
466 PWC_ERROR("Neither empty or full frames available!\n");
467 spin_unlock_irqrestore(&pdev->ptrlock, flags);
470 pdev->fill_frame = pdev->full_frames;
471 pdev->full_frames = pdev->full_frames->next;
474 pdev->fill_frame->next = NULL;
475 spin_unlock_irqrestore(&pdev->ptrlock, flags);
481 \brief Reset all buffers, pointers and lists, except for the image_used[] buffer.
483 If the image_used[] buffer is cleared too, mmap()/VIDIOCSYNC will run into trouble.
485 static void pwc_reset_buffers(struct pwc_device *pdev)
490 PWC_DEBUG_MEMORY(">> %s __enter__\n", __func__);
492 spin_lock_irqsave(&pdev->ptrlock, flags);
493 pdev->full_frames = NULL;
494 pdev->full_frames_tail = NULL;
495 for (i = 0; i < default_fbufs; i++) {
496 pdev->fbuf[i].filled = 0;
498 pdev->fbuf[i].next = &pdev->fbuf[i - 1];
500 pdev->fbuf->next = NULL;
502 pdev->empty_frames = &pdev->fbuf[default_fbufs - 1];
503 pdev->empty_frames_tail = pdev->fbuf;
504 pdev->read_frame = NULL;
505 pdev->fill_frame = pdev->empty_frames;
506 pdev->empty_frames = pdev->empty_frames->next;
508 pdev->image_read_pos = 0;
509 pdev->fill_image = 0;
510 spin_unlock_irqrestore(&pdev->ptrlock, flags);
512 PWC_DEBUG_MEMORY("<< %s __leaving__\n", __func__);
517 \brief Do all the handling for getting one frame: get pointer, decompress, advance pointers.
519 int pwc_handle_frame(struct pwc_device *pdev)
524 spin_lock_irqsave(&pdev->ptrlock, flags);
525 /* First grab our read_frame; this is removed from all lists, so
526 we can release the lock after this without problems */
527 if (pdev->read_frame != NULL) {
528 /* This can't theoretically happen */
529 PWC_ERROR("Huh? Read frame still in use?\n");
530 spin_unlock_irqrestore(&pdev->ptrlock, flags);
535 if (pdev->full_frames == NULL) {
536 PWC_ERROR("Woops. No frames ready.\n");
539 pdev->read_frame = pdev->full_frames;
540 pdev->full_frames = pdev->full_frames->next;
541 pdev->read_frame->next = NULL;
544 if (pdev->read_frame != NULL) {
545 /* Decompression is a lengthy process, so it's outside of the lock.
546 This gives the isoc_handler the opportunity to fill more frames
549 spin_unlock_irqrestore(&pdev->ptrlock, flags);
550 ret = pwc_decompress(pdev);
551 spin_lock_irqsave(&pdev->ptrlock, flags);
553 /* We're done with read_buffer, tack it to the end of the empty buffer list */
554 if (pdev->empty_frames == NULL) {
555 pdev->empty_frames = pdev->read_frame;
556 pdev->empty_frames_tail = pdev->empty_frames;
559 pdev->empty_frames_tail->next = pdev->read_frame;
560 pdev->empty_frames_tail = pdev->read_frame;
562 pdev->read_frame = NULL;
564 spin_unlock_irqrestore(&pdev->ptrlock, flags);
569 \brief Advance pointers of image buffer (after each user request)
571 void pwc_next_image(struct pwc_device *pdev)
573 pdev->image_used[pdev->fill_image] = 0;
574 pdev->fill_image = (pdev->fill_image + 1) % pwc_mbufs;
578 * Print debug information when a frame is discarded because all of our buffer
581 static void pwc_frame_dumped(struct pwc_device *pdev)
583 pdev->vframes_dumped++;
584 if (pdev->vframe_count < FRAME_LOWMARK)
587 if (pdev->vframes_dumped < 20)
588 PWC_DEBUG_FLOW("Dumping frame %d\n", pdev->vframe_count);
589 else if (pdev->vframes_dumped == 20)
590 PWC_DEBUG_FLOW("Dumping frame %d (last message)\n",
594 static int pwc_rcv_short_packet(struct pwc_device *pdev, const struct pwc_frame_buf *fbuf)
598 /* The ToUCam Fun CMOS sensor causes the firmware to send 2 or 3 bogus
599 frames on the USB wire after an exposure change. This conditition is
600 however detected in the cam and a bit is set in the header.
602 if (pdev->type == 730) {
603 unsigned char *ptr = (unsigned char *)fbuf->data;
605 if (ptr[1] == 1 && ptr[0] & 0x10) {
606 PWC_TRACE("Hyundai CMOS sensor bug. Dropping frame.\n");
607 pdev->drop_frames += 2;
608 pdev->vframes_error++;
610 if ((ptr[0] ^ pdev->vmirror) & 0x01) {
612 pdev->snapshot_button_status = 1;
613 PWC_TRACE("Snapshot button pressed.\n");
616 PWC_TRACE("Snapshot button released.\n");
619 if ((ptr[0] ^ pdev->vmirror) & 0x02) {
621 PWC_TRACE("Image is mirrored.\n");
623 PWC_TRACE("Image is normal.\n");
625 pdev->vmirror = ptr[0] & 0x03;
626 /* Sometimes the trailer of the 730 is still sent as a 4 byte packet
627 after a short frame; this condition is filtered out specifically. A 4 byte
628 frame doesn't make sense anyway.
629 So we get either this sequence:
630 drop_bit set -> 4 byte frame -> short frame -> good frame
632 drop_bit set -> short frame -> good frame
633 So we drop either 3 or 2 frames in all!
635 if (fbuf->filled == 4)
638 else if (pdev->type == 740 || pdev->type == 720) {
639 unsigned char *ptr = (unsigned char *)fbuf->data;
640 if ((ptr[0] ^ pdev->vmirror) & 0x01) {
642 pdev->snapshot_button_status = 1;
643 PWC_TRACE("Snapshot button pressed.\n");
646 PWC_TRACE("Snapshot button released.\n");
648 pdev->vmirror = ptr[0] & 0x03;
651 /* In case we were instructed to drop the frame, do so silently.
652 The buffer pointers are not updated either (but the counters are reset below).
654 if (pdev->drop_frames > 0)
657 /* Check for underflow first */
658 if (fbuf->filled < pdev->frame_total_size) {
659 PWC_DEBUG_FLOW("Frame buffer underflow (%d bytes);"
660 " discarded.\n", fbuf->filled);
661 pdev->vframes_error++;
664 /* Send only once per EOF */
665 awake = 1; /* delay wake_ups */
667 /* Find our next frame to fill. This will always succeed, since we
668 * nick a frame from either empty or full list, but if we had to
669 * take it from the full list, it means a frame got dropped.
671 if (pwc_next_fill_frame(pdev))
672 pwc_frame_dumped(pdev);
676 pdev->vframe_count++;
680 /* This gets called for the Isochronous pipe (video). This is done in
681 * interrupt time, so it has to be fast, not crash, and not stall. Neat.
683 static void pwc_isoc_handler(struct urb *urb)
685 struct pwc_device *pdev;
688 struct pwc_frame_buf *fbuf;
689 unsigned char *fillptr = NULL, *iso_buf = NULL;
692 pdev = (struct pwc_device *)urb->context;
694 PWC_ERROR("isoc_handler() called with NULL device?!\n");
698 if (urb->status == -ENOENT || urb->status == -ECONNRESET) {
699 PWC_DEBUG_OPEN("URB (%p) unlinked %ssynchronuously.\n", urb, urb->status == -ENOENT ? "" : "a");
702 if (urb->status != -EINPROGRESS && urb->status != 0) {
706 switch(urb->status) {
707 case -ENOSR: errmsg = "Buffer error (overrun)"; break;
708 case -EPIPE: errmsg = "Stalled (device not responding)"; break;
709 case -EOVERFLOW: errmsg = "Babble (bad cable?)"; break;
710 case -EPROTO: errmsg = "Bit-stuff error (bad cable?)"; break;
711 case -EILSEQ: errmsg = "CRC/Timeout (could be anything)"; break;
712 case -ETIME: errmsg = "Device does not respond"; break;
714 PWC_DEBUG_FLOW("pwc_isoc_handler() called with status %d [%s].\n", urb->status, errmsg);
715 /* Give up after a number of contiguous errors on the USB bus.
716 Appearantly something is wrong so we simulate an unplug event.
718 if (++pdev->visoc_errors > MAX_ISOC_ERRORS)
720 PWC_INFO("Too many ISOC errors, bailing out.\n");
721 pdev->error_status = EIO;
723 wake_up_interruptible(&pdev->frameq);
725 goto handler_end; // ugly, but practical
728 fbuf = pdev->fill_frame;
730 PWC_ERROR("pwc_isoc_handler without valid fill frame.\n");
735 fillptr = fbuf->data + fbuf->filled;
738 /* Reset ISOC error counter. We did get here, after all. */
739 pdev->visoc_errors = 0;
741 /* vsync: 0 = don't copy data
746 for (i = 0; i < urb->number_of_packets; i++) {
747 fst = urb->iso_frame_desc[i].status;
748 flen = urb->iso_frame_desc[i].actual_length;
749 iso_buf = urb->transfer_buffer + urb->iso_frame_desc[i].offset;
751 if (flen > 0) { /* if valid data... */
752 if (pdev->vsync > 0) { /* ...and we are not sync-hunting... */
755 /* ...copy data to frame buffer, if possible */
756 if (flen + fbuf->filled > pdev->frame_total_size) {
757 PWC_DEBUG_FLOW("Frame buffer overflow (flen = %d, frame_total_size = %d).\n", flen, pdev->frame_total_size);
758 pdev->vsync = 0; /* Hmm, let's wait for an EOF (end-of-frame) */
759 pdev->vframes_error++;
762 memmove(fillptr, iso_buf, flen);
766 fbuf->filled += flen;
769 if (flen < pdev->vlast_packet_size) {
770 /* Shorter packet... We probably have the end of an image-frame;
771 wake up read() process and let select()/poll() do something.
772 Decompression is done in user time over there.
774 if (pdev->vsync == 2) {
775 if (pwc_rcv_short_packet(pdev, fbuf)) {
777 fbuf = pdev->fill_frame;
781 fillptr = fbuf->data;
785 pdev->vlast_packet_size = flen;
786 } /* ..status == 0 */
788 /* This is normally not interesting to the user, unless
789 * you are really debugging something, default = 0 */
790 static int iso_error;
793 PWC_DEBUG_FLOW("Iso frame %d of USB has error %d\n", i, fst);
799 wake_up_interruptible(&pdev->frameq);
801 urb->dev = pdev->udev;
802 i = usb_submit_urb(urb, GFP_ATOMIC);
804 PWC_ERROR("Error (%d) re-submitting urb in pwc_isoc_handler.\n", i);
808 int pwc_isoc_init(struct pwc_device *pdev)
810 struct usb_device *udev;
814 struct usb_interface *intf;
815 struct usb_host_interface *idesc = NULL;
824 /* Get the current alternate interface, adjust packet size */
825 if (!udev->actconfig)
827 intf = usb_ifnum_to_if(udev, 0);
829 idesc = usb_altnum_to_altsetting(intf, pdev->valternate);
834 /* Search video endpoint */
835 pdev->vmax_packet_size = -1;
836 for (i = 0; i < idesc->desc.bNumEndpoints; i++) {
837 if ((idesc->endpoint[i].desc.bEndpointAddress & 0xF) == pdev->vendpoint) {
838 pdev->vmax_packet_size = le16_to_cpu(idesc->endpoint[i].desc.wMaxPacketSize);
843 if (pdev->vmax_packet_size < 0 || pdev->vmax_packet_size > ISO_MAX_FRAME_SIZE) {
844 PWC_ERROR("Failed to find packet size for video endpoint in current alternate setting.\n");
845 return -ENFILE; /* Odd error, that should be noticeable */
848 /* Set alternate interface */
850 PWC_DEBUG_OPEN("Setting alternate interface %d\n", pdev->valternate);
851 ret = usb_set_interface(pdev->udev, 0, pdev->valternate);
855 for (i = 0; i < MAX_ISO_BUFS; i++) {
856 urb = usb_alloc_urb(ISO_FRAMES_PER_DESC, GFP_KERNEL);
858 PWC_ERROR("Failed to allocate urb %d\n", i);
862 pdev->sbuf[i].urb = urb;
863 PWC_DEBUG_MEMORY("Allocated URB at 0x%p\n", urb);
866 /* De-allocate in reverse order */
868 usb_free_urb(pdev->sbuf[i].urb);
869 pdev->sbuf[i].urb = NULL;
874 /* init URB structure */
875 for (i = 0; i < MAX_ISO_BUFS; i++) {
876 urb = pdev->sbuf[i].urb;
878 urb->interval = 1; // devik
880 urb->pipe = usb_rcvisocpipe(udev, pdev->vendpoint);
881 urb->transfer_flags = URB_ISO_ASAP;
882 urb->transfer_buffer = pdev->sbuf[i].data;
883 urb->transfer_buffer_length = ISO_BUFFER_SIZE;
884 urb->complete = pwc_isoc_handler;
886 urb->start_frame = 0;
887 urb->number_of_packets = ISO_FRAMES_PER_DESC;
888 for (j = 0; j < ISO_FRAMES_PER_DESC; j++) {
889 urb->iso_frame_desc[j].offset = j * ISO_MAX_FRAME_SIZE;
890 urb->iso_frame_desc[j].length = pdev->vmax_packet_size;
895 for (i = 0; i < MAX_ISO_BUFS; i++) {
896 ret = usb_submit_urb(pdev->sbuf[i].urb, GFP_KERNEL);
898 PWC_ERROR("isoc_init() submit_urb %d failed with error %d\n", i, ret);
900 PWC_DEBUG_MEMORY("URB 0x%p submitted.\n", pdev->sbuf[i].urb);
905 PWC_DEBUG_OPEN("<< pwc_isoc_init()\n");
909 static void pwc_iso_stop(struct pwc_device *pdev)
913 /* Unlinking ISOC buffers one by one */
914 for (i = 0; i < MAX_ISO_BUFS; i++) {
917 urb = pdev->sbuf[i].urb;
919 PWC_DEBUG_MEMORY("Unlinking URB %p\n", urb);
925 static void pwc_iso_free(struct pwc_device *pdev)
929 /* Freeing ISOC buffers one by one */
930 for (i = 0; i < MAX_ISO_BUFS; i++) {
933 urb = pdev->sbuf[i].urb;
935 PWC_DEBUG_MEMORY("Freeing URB\n");
937 pdev->sbuf[i].urb = NULL;
942 void pwc_isoc_cleanup(struct pwc_device *pdev)
944 PWC_DEBUG_OPEN(">> pwc_isoc_cleanup()\n");
947 if (pdev->iso_init == 0)
953 /* Stop camera, but only if we are sure the camera is still there (unplug
954 is signalled by EPIPE)
956 if (pdev->error_status && pdev->error_status != EPIPE) {
957 PWC_DEBUG_OPEN("Setting alternate interface 0.\n");
958 usb_set_interface(pdev->udev, 0, 0);
962 PWC_DEBUG_OPEN("<< pwc_isoc_cleanup()\n");
965 int pwc_try_video_mode(struct pwc_device *pdev, int width, int height, int new_fps, int new_compression, int new_snapshot)
969 /* Stop isoc stuff */
970 pwc_isoc_cleanup(pdev);
971 /* Reset parameters */
972 pwc_reset_buffers(pdev);
973 /* Try to set video mode... */
974 start = ret = pwc_set_video_mode(pdev, width, height, new_fps, new_compression, new_snapshot);
976 PWC_DEBUG_FLOW("pwc_set_video_mode attempt 1 failed.\n");
977 /* That failed... restore old mode (we know that worked) */
978 start = pwc_set_video_mode(pdev, pdev->view.x, pdev->view.y, pdev->vframes, pdev->vcompression, pdev->vsnapshot);
980 PWC_DEBUG_FLOW("pwc_set_video_mode attempt 2 failed.\n");
985 if (pwc_isoc_init(pdev) < 0)
987 PWC_WARNING("Failed to restart ISOC transfers in pwc_try_video_mode.\n");
988 ret = -EAGAIN; /* let's try again, who knows if it works a second time */
991 pdev->drop_frames++; /* try to avoid garbage during switch */
992 return ret; /* Return original error code */
998 static struct pwc_device *cd_to_pwc(struct device *cd)
1000 struct video_device *vdev = to_video_device(cd);
1001 return video_get_drvdata(vdev);
1004 static ssize_t show_pan_tilt(struct device *class_dev,
1005 struct device_attribute *attr, char *buf)
1007 struct pwc_device *pdev = cd_to_pwc(class_dev);
1008 return sprintf(buf, "%d %d\n", pdev->pan_angle, pdev->tilt_angle);
1011 static ssize_t store_pan_tilt(struct device *class_dev,
1012 struct device_attribute *attr,
1013 const char *buf, size_t count)
1015 struct pwc_device *pdev = cd_to_pwc(class_dev);
1019 if (strncmp(buf, "reset", 5) == 0)
1020 ret = pwc_mpt_reset(pdev, 0x3);
1022 else if (sscanf(buf, "%d %d", &pan, &tilt) > 0)
1023 ret = pwc_mpt_set_angle(pdev, pan, tilt);
1029 static DEVICE_ATTR(pan_tilt, S_IRUGO | S_IWUSR, show_pan_tilt,
1032 static ssize_t show_snapshot_button_status(struct device *class_dev,
1033 struct device_attribute *attr, char *buf)
1035 struct pwc_device *pdev = cd_to_pwc(class_dev);
1036 int status = pdev->snapshot_button_status;
1037 pdev->snapshot_button_status = 0;
1038 return sprintf(buf, "%d\n", status);
1041 static DEVICE_ATTR(button, S_IRUGO | S_IWUSR, show_snapshot_button_status,
1044 static int pwc_create_sysfs_files(struct video_device *vdev)
1046 struct pwc_device *pdev = video_get_drvdata(vdev);
1049 rc = device_create_file(&vdev->dev, &dev_attr_button);
1052 if (pdev->features & FEATURE_MOTOR_PANTILT) {
1053 rc = device_create_file(&vdev->dev, &dev_attr_pan_tilt);
1054 if (rc) goto err_button;
1060 device_remove_file(&vdev->dev, &dev_attr_button);
1062 PWC_ERROR("Could not create sysfs files.\n");
1066 static void pwc_remove_sysfs_files(struct video_device *vdev)
1068 struct pwc_device *pdev = video_get_drvdata(vdev);
1069 if (pdev->features & FEATURE_MOTOR_PANTILT)
1070 device_remove_file(&vdev->dev, &dev_attr_pan_tilt);
1071 device_remove_file(&vdev->dev, &dev_attr_button);
1074 #ifdef CONFIG_USB_PWC_DEBUG
1075 static const char *pwc_sensor_type_to_string(unsigned int sensor_type)
1077 switch(sensor_type) {
1079 return "Hyundai CMOS sensor";
1081 return "Sony CCD sensor + TDA8787";
1083 return "Sony CCD sensor + Exas 98L59";
1085 return "Sony CCD sensor + ADI 9804";
1087 return "Sharp CCD sensor + TDA8787";
1089 return "Sharp CCD sensor + Exas 98L59";
1091 return "Sharp CCD sensor + ADI 9804";
1093 return "UPA 1021 sensor";
1095 return "VGA sensor";
1097 return "PAL MR sensor";
1099 return "unknown type of sensor";
1104 /***************************************************************************/
1105 /* Video4Linux functions */
1107 static int pwc_video_open(struct inode *inode, struct file *file)
1110 struct video_device *vdev = video_devdata(file);
1111 struct pwc_device *pdev;
1113 PWC_DEBUG_OPEN(">> video_open called(vdev = 0x%p).\n", vdev);
1115 pdev = video_get_drvdata(vdev);
1118 PWC_DEBUG_OPEN("I'm busy, someone is using the device.\n");
1122 mutex_lock(&pdev->modlock);
1123 if (!pdev->usb_init) {
1124 PWC_DEBUG_OPEN("Doing first time initialization.\n");
1127 /* Query sensor type */
1128 ret = pwc_get_cmos_sensor(pdev, &i);
1131 PWC_DEBUG_OPEN("This %s camera is equipped with a %s (%d).\n",
1133 pwc_sensor_type_to_string(i), i);
1137 /* Turn on camera */
1139 i = pwc_camera_power(pdev, 1);
1141 PWC_DEBUG_OPEN("Failed to restore power to the camera! (%d)\n", i);
1143 /* Set LED on/off time */
1144 if (pwc_set_leds(pdev, led_on, led_off) < 0)
1145 PWC_DEBUG_OPEN("Failed to set LED on/off time.\n");
1147 pwc_construct(pdev); /* set min/max sizes correct */
1149 /* So far, so good. Allocate memory. */
1150 i = pwc_allocate_buffers(pdev);
1152 PWC_DEBUG_OPEN("Failed to allocate buffers memory.\n");
1153 pwc_free_buffers(pdev);
1154 mutex_unlock(&pdev->modlock);
1158 /* Reset buffers & parameters */
1159 pwc_reset_buffers(pdev);
1160 for (i = 0; i < pwc_mbufs; i++)
1161 pdev->image_used[i] = 0;
1162 pdev->vframe_count = 0;
1163 pdev->vframes_dumped = 0;
1164 pdev->vframes_error = 0;
1165 pdev->visoc_errors = 0;
1166 pdev->error_status = 0;
1167 pwc_construct(pdev); /* set min/max sizes correct */
1169 /* Set some defaults */
1170 pdev->vsnapshot = 0;
1172 /* Start iso pipe for video; first try the last used video size
1173 (or the default one); if that fails try QCIF/10 or QSIF/10;
1174 it that fails too, give up.
1176 i = pwc_set_video_mode(pdev, pwc_image_sizes[pdev->vsize].x, pwc_image_sizes[pdev->vsize].y, pdev->vframes, pdev->vcompression, 0);
1178 unsigned int default_resolution;
1179 PWC_DEBUG_OPEN("First attempt at set_video_mode failed.\n");
1180 if (pdev->type>= 730)
1181 default_resolution = PSZ_QSIF;
1183 default_resolution = PSZ_QCIF;
1185 i = pwc_set_video_mode(pdev,
1186 pwc_image_sizes[default_resolution].x,
1187 pwc_image_sizes[default_resolution].y,
1193 PWC_DEBUG_OPEN("Second attempt at set_video_mode failed.\n");
1194 pwc_free_buffers(pdev);
1195 mutex_unlock(&pdev->modlock);
1199 i = pwc_isoc_init(pdev);
1201 PWC_DEBUG_OPEN("Failed to init ISOC stuff = %d.\n", i);
1202 pwc_isoc_cleanup(pdev);
1203 pwc_free_buffers(pdev);
1204 mutex_unlock(&pdev->modlock);
1208 /* Initialize the webcam to sane value */
1209 pwc_set_brightness(pdev, 0x7fff);
1210 pwc_set_agc(pdev, 1, 0);
1213 file->private_data = vdev;
1214 mutex_unlock(&pdev->modlock);
1215 PWC_DEBUG_OPEN("<< video_open() returns 0.\n");
1220 static void pwc_cleanup(struct pwc_device *pdev)
1222 pwc_remove_sysfs_files(pdev->vdev);
1223 video_unregister_device(pdev->vdev);
1226 /* Note that all cleanup is done in the reverse order as in _open */
1227 static int pwc_video_close(struct inode *inode, struct file *file)
1229 struct video_device *vdev = file->private_data;
1230 struct pwc_device *pdev;
1233 PWC_DEBUG_OPEN(">> video_close called(vdev = 0x%p).\n", vdev);
1236 pdev = video_get_drvdata(vdev);
1237 if (pdev->vopen == 0)
1238 PWC_DEBUG_MODULE("video_close() called on closed device?\n");
1240 /* Dump statistics, but only if a reasonable amount of frames were
1241 processed (to prevent endless log-entries in case of snap-shot
1244 if (pdev->vframe_count > 20)
1245 PWC_DEBUG_MODULE("Closing video device: %d frames received, dumped %d frames, %d frames with errors.\n", pdev->vframe_count, pdev->vframes_dumped, pdev->vframes_error);
1247 if (DEVICE_USE_CODEC1(pdev->type))
1252 pwc_isoc_cleanup(pdev);
1253 pwc_free_buffers(pdev);
1255 /* Turn off LEDS and power down camera, but only when not unplugged */
1256 if (!pdev->unplugged) {
1258 if (pwc_set_leds(pdev, 0, 0) < 0)
1259 PWC_DEBUG_MODULE("Failed to set LED on/off time.\n");
1261 i = pwc_camera_power(pdev, 0);
1263 PWC_ERROR("Failed to power down camera (%d)\n", i);
1266 PWC_DEBUG_OPEN("<< video_close() vopen=%d\n", pdev->vopen);
1269 /* Free memory (don't set pdev to 0 just yet) */
1271 /* search device_hint[] table if we occupy a slot, by any chance */
1272 for (hint = 0; hint < MAX_DEV_HINTS; hint++)
1273 if (device_hint[hint].pdev == pdev)
1274 device_hint[hint].pdev = NULL;
1282 * FIXME: what about two parallel reads ????
1283 * ANSWER: Not supported. You can't open the device more than once,
1284 despite what the V4L1 interface says. First, I don't see
1285 the need, second there's no mechanism of alerting the
1286 2nd/3rd/... process of events like changing image size.
1287 And I don't see the point of blocking that for the
1288 2nd/3rd/... process.
1289 In multi-threaded environments reading parallel from any
1290 device is tricky anyhow.
1293 static ssize_t pwc_video_read(struct file *file, char __user *buf,
1294 size_t count, loff_t *ppos)
1296 struct video_device *vdev = file->private_data;
1297 struct pwc_device *pdev;
1298 int noblock = file->f_flags & O_NONBLOCK;
1299 DECLARE_WAITQUEUE(wait, current);
1300 int bytes_to_read, rv = 0;
1301 void *image_buffer_addr;
1303 PWC_DEBUG_READ("pwc_video_read(vdev=0x%p, buf=%p, count=%zd) called.\n",
1307 pdev = video_get_drvdata(vdev);
1311 mutex_lock(&pdev->modlock);
1312 if (pdev->error_status) {
1313 rv = -pdev->error_status; /* Something happened, report what. */
1317 /* In case we're doing partial reads, we don't have to wait for a frame */
1318 if (pdev->image_read_pos == 0) {
1319 /* Do wait queueing according to the (doc)book */
1320 add_wait_queue(&pdev->frameq, &wait);
1321 while (pdev->full_frames == NULL) {
1322 /* Check for unplugged/etc. here */
1323 if (pdev->error_status) {
1324 remove_wait_queue(&pdev->frameq, &wait);
1325 set_current_state(TASK_RUNNING);
1326 rv = -pdev->error_status ;
1330 remove_wait_queue(&pdev->frameq, &wait);
1331 set_current_state(TASK_RUNNING);
1335 if (signal_pending(current)) {
1336 remove_wait_queue(&pdev->frameq, &wait);
1337 set_current_state(TASK_RUNNING);
1342 set_current_state(TASK_INTERRUPTIBLE);
1344 remove_wait_queue(&pdev->frameq, &wait);
1345 set_current_state(TASK_RUNNING);
1347 /* Decompress and release frame */
1348 if (pwc_handle_frame(pdev)) {
1354 PWC_DEBUG_READ("Copying data to user space.\n");
1355 if (pdev->vpalette == VIDEO_PALETTE_RAW)
1356 bytes_to_read = pdev->frame_size + sizeof(struct pwc_raw_frame);
1358 bytes_to_read = pdev->view.size;
1360 /* copy bytes to user space; we allow for partial reads */
1361 if (count + pdev->image_read_pos > bytes_to_read)
1362 count = bytes_to_read - pdev->image_read_pos;
1363 image_buffer_addr = pdev->image_data;
1364 image_buffer_addr += pdev->images[pdev->fill_image].offset;
1365 image_buffer_addr += pdev->image_read_pos;
1366 if (copy_to_user(buf, image_buffer_addr, count)) {
1370 pdev->image_read_pos += count;
1371 if (pdev->image_read_pos >= bytes_to_read) { /* All data has been read */
1372 pdev->image_read_pos = 0;
1373 pwc_next_image(pdev);
1375 mutex_unlock(&pdev->modlock);
1378 mutex_unlock(&pdev->modlock);
1382 static unsigned int pwc_video_poll(struct file *file, poll_table *wait)
1384 struct video_device *vdev = file->private_data;
1385 struct pwc_device *pdev;
1389 pdev = video_get_drvdata(vdev);
1393 poll_wait(file, &pdev->frameq, wait);
1394 if (pdev->error_status)
1396 if (pdev->full_frames != NULL) /* we have frames waiting */
1397 return (POLLIN | POLLRDNORM);
1402 static int pwc_video_ioctl(struct inode *inode, struct file *file,
1403 unsigned int cmd, unsigned long arg)
1405 struct video_device *vdev = file->private_data;
1406 struct pwc_device *pdev;
1411 pdev = video_get_drvdata(vdev);
1413 mutex_lock(&pdev->modlock);
1414 if (!pdev->unplugged)
1415 r = video_usercopy(inode, file, cmd, arg, pwc_video_do_ioctl);
1416 mutex_unlock(&pdev->modlock);
1421 static int pwc_video_mmap(struct file *file, struct vm_area_struct *vma)
1423 struct video_device *vdev = file->private_data;
1424 struct pwc_device *pdev;
1425 unsigned long start;
1427 unsigned long page, pos = 0;
1430 PWC_DEBUG_MEMORY(">> %s\n", __func__);
1431 pdev = video_get_drvdata(vdev);
1432 size = vma->vm_end - vma->vm_start;
1433 start = vma->vm_start;
1435 /* Find the idx buffer for this mapping */
1436 for (index = 0; index < pwc_mbufs; index++) {
1437 pos = pdev->images[index].offset;
1438 if ((pos>>PAGE_SHIFT) == vma->vm_pgoff)
1441 if (index == MAX_IMAGES)
1445 * Special case for v4l1. In v4l1, we map only one big buffer,
1446 * but in v4l2 each buffer is mapped
1448 unsigned long total_size;
1449 total_size = pwc_mbufs * pdev->len_per_image;
1450 if (size != pdev->len_per_image && size != total_size) {
1451 PWC_ERROR("Wrong size (%lu) needed to be len_per_image=%d or total_size=%lu\n",
1452 size, pdev->len_per_image, total_size);
1455 } else if (size > pdev->len_per_image)
1458 vma->vm_flags |= VM_IO; /* from 2.6.9-acX */
1460 pos += (unsigned long)pdev->image_data;
1462 page = vmalloc_to_pfn((void *)pos);
1463 if (remap_pfn_range(vma, start, page, PAGE_SIZE, PAGE_SHARED))
1467 if (size > PAGE_SIZE)
1475 /***************************************************************************/
1478 /* This function gets called when a new device is plugged in or the usb core
1482 static int usb_pwc_probe(struct usb_interface *intf, const struct usb_device_id *id)
1484 struct usb_device *udev = interface_to_usbdev(intf);
1485 struct pwc_device *pdev = NULL;
1486 int vendor_id, product_id, type_id;
1489 int video_nr = -1; /* default: use next available device */
1490 char serial_number[30], *name;
1492 vendor_id = le16_to_cpu(udev->descriptor.idVendor);
1493 product_id = le16_to_cpu(udev->descriptor.idProduct);
1495 /* Check if we can handle this device */
1496 PWC_DEBUG_PROBE("probe() called [%04X %04X], if %d\n",
1497 vendor_id, product_id,
1498 intf->altsetting->desc.bInterfaceNumber);
1500 /* the interfaces are probed one by one. We are only interested in the
1501 video interface (0) now.
1502 Interface 1 is the Audio Control, and interface 2 Audio itself.
1504 if (intf->altsetting->desc.bInterfaceNumber > 0)
1507 if (vendor_id == 0x0471) {
1508 switch (product_id) {
1510 PWC_INFO("Philips PCA645VC USB webcam detected.\n");
1511 name = "Philips 645 webcam";
1515 PWC_INFO("Philips PCA646VC USB webcam detected.\n");
1516 name = "Philips 646 webcam";
1520 PWC_INFO("Askey VC010 type 2 USB webcam detected.\n");
1521 name = "Askey VC010 webcam";
1525 PWC_INFO("Philips PCVC675K (Vesta) USB webcam detected.\n");
1526 name = "Philips 675 webcam";
1530 PWC_INFO("Philips PCVC680K (Vesta Pro) USB webcam detected.\n");
1531 name = "Philips 680 webcam";
1535 PWC_INFO("Philips PCVC690K (Vesta Pro Scan) USB webcam detected.\n");
1536 name = "Philips 690 webcam";
1540 PWC_INFO("Philips PCVC730K (ToUCam Fun)/PCVC830 (ToUCam II) USB webcam detected.\n");
1541 name = "Philips 730 webcam";
1545 PWC_INFO("Philips PCVC740K (ToUCam Pro)/PCVC840 (ToUCam II) USB webcam detected.\n");
1546 name = "Philips 740 webcam";
1550 PWC_INFO("Philips PCVC750K (ToUCam Pro Scan) USB webcam detected.\n");
1551 name = "Philips 750 webcam";
1555 PWC_INFO("Philips PCVC720K/40 (ToUCam XS) USB webcam detected.\n");
1556 name = "Philips 720K/40 webcam";
1560 PWC_INFO("Philips SPC 900NC USB webcam detected.\n");
1561 name = "Philips SPC 900NC webcam";
1569 else if (vendor_id == 0x069A) {
1570 switch(product_id) {
1572 PWC_INFO("Askey VC010 type 1 USB webcam detected.\n");
1573 name = "Askey VC010 webcam";
1581 else if (vendor_id == 0x046d) {
1582 switch(product_id) {
1584 PWC_INFO("Logitech QuickCam Pro 3000 USB webcam detected.\n");
1585 name = "Logitech QuickCam Pro 3000";
1586 type_id = 740; /* CCD sensor */
1589 PWC_INFO("Logitech QuickCam Notebook Pro USB webcam detected.\n");
1590 name = "Logitech QuickCam Notebook Pro";
1591 type_id = 740; /* CCD sensor */
1594 PWC_INFO("Logitech QuickCam 4000 Pro USB webcam detected.\n");
1595 name = "Logitech QuickCam Pro 4000";
1596 type_id = 740; /* CCD sensor */
1599 PWC_INFO("Logitech QuickCam Zoom USB webcam detected.\n");
1600 name = "Logitech QuickCam Zoom";
1601 type_id = 740; /* CCD sensor */
1604 PWC_INFO("Logitech QuickCam Zoom (new model) USB webcam detected.\n");
1605 name = "Logitech QuickCam Zoom";
1606 type_id = 740; /* CCD sensor */
1610 PWC_INFO("Logitech QuickCam Orbit/Sphere USB webcam detected.\n");
1611 name = "Logitech QuickCam Orbit";
1612 type_id = 740; /* CCD sensor */
1613 features |= FEATURE_MOTOR_PANTILT;
1616 PWC_INFO("Logitech/Cisco VT Camera webcam detected.\n");
1617 name = "Cisco VT Camera";
1618 type_id = 740; /* CCD sensor */
1621 PWC_INFO("Logitech ViewPort AV 100 webcam detected.\n");
1622 name = "Logitech ViewPort AV 100";
1623 type_id = 740; /* CCD sensor */
1625 case 0x08b8: /* Where this released? */
1626 PWC_INFO("Logitech QuickCam detected (reserved ID).\n");
1627 name = "Logitech QuickCam (res.)";
1628 type_id = 730; /* Assuming CMOS */
1635 else if (vendor_id == 0x055d) {
1636 /* I don't know the difference between the C10 and the C30;
1637 I suppose the difference is the sensor, but both cameras
1638 work equally well with a type_id of 675
1640 switch(product_id) {
1642 PWC_INFO("Samsung MPC-C10 USB webcam detected.\n");
1643 name = "Samsung MPC-C10";
1647 PWC_INFO("Samsung MPC-C30 USB webcam detected.\n");
1648 name = "Samsung MPC-C30";
1652 PWC_INFO("Samsung SNC-35E (v3.0) USB webcam detected.\n");
1653 name = "Samsung MPC-C30";
1661 else if (vendor_id == 0x041e) {
1662 switch(product_id) {
1664 PWC_INFO("Creative Labs Webcam 5 detected.\n");
1665 name = "Creative Labs Webcam 5";
1669 PWC_INFO("Creative Labs Webcam Pro Ex detected.\n");
1670 name = "Creative Labs Webcam Pro Ex";
1678 else if (vendor_id == 0x04cc) {
1679 switch(product_id) {
1681 PWC_INFO("Sotec Afina Eye USB webcam detected.\n");
1682 name = "Sotec Afina Eye";
1690 else if (vendor_id == 0x06be) {
1691 switch(product_id) {
1693 /* This is essentially the same cam as the Sotec Afina Eye */
1694 PWC_INFO("AME Co. Afina Eye USB webcam detected.\n");
1695 name = "AME Co. Afina Eye";
1704 else if (vendor_id == 0x0d81) {
1705 switch(product_id) {
1707 PWC_INFO("Visionite VCS-UC300 USB webcam detected.\n");
1708 name = "Visionite VCS-UC300";
1709 type_id = 740; /* CCD sensor */
1712 PWC_INFO("Visionite VCS-UM100 USB webcam detected.\n");
1713 name = "Visionite VCS-UM100";
1714 type_id = 730; /* CMOS sensor */
1722 return -ENODEV; /* Not any of the know types; but the list keeps growing. */
1724 memset(serial_number, 0, 30);
1725 usb_string(udev, udev->descriptor.iSerialNumber, serial_number, 29);
1726 PWC_DEBUG_PROBE("Device serial number is %s\n", serial_number);
1728 if (udev->descriptor.bNumConfigurations > 1)
1729 PWC_WARNING("Warning: more than 1 configuration available.\n");
1731 /* Allocate structure, initialize pointers, mutexes, etc. and link it to the usb_device */
1732 pdev = kzalloc(sizeof(struct pwc_device), GFP_KERNEL);
1734 PWC_ERROR("Oops, could not allocate memory for pwc_device.\n");
1737 pdev->type = type_id;
1738 pdev->vsize = default_size;
1739 pdev->vframes = default_fps;
1740 strcpy(pdev->serial, serial_number);
1741 pdev->features = features;
1742 if (vendor_id == 0x046D && product_id == 0x08B5)
1744 /* Logitech QuickCam Orbit
1745 The ranges have been determined experimentally; they may differ from cam to cam.
1746 Also, the exact ranges left-right and up-down are different for my cam
1748 pdev->angle_range.pan_min = -7000;
1749 pdev->angle_range.pan_max = 7000;
1750 pdev->angle_range.tilt_min = -3000;
1751 pdev->angle_range.tilt_max = 2500;
1754 mutex_init(&pdev->modlock);
1755 spin_lock_init(&pdev->ptrlock);
1758 init_waitqueue_head(&pdev->frameq);
1759 pdev->vcompression = pwc_preferred_compression;
1761 /* Allocate video_device structure */
1762 pdev->vdev = video_device_alloc();
1764 PWC_ERROR("Err, cannot allocate video_device struture. Failing probe.");
1768 memcpy(pdev->vdev, &pwc_template, sizeof(pwc_template));
1769 pdev->vdev->parent = &(udev->dev);
1770 strcpy(pdev->vdev->name, name);
1771 video_set_drvdata(pdev->vdev, pdev);
1773 pdev->release = le16_to_cpu(udev->descriptor.bcdDevice);
1774 PWC_DEBUG_PROBE("Release: %04x\n", pdev->release);
1776 /* Now search device_hint[] table for a match, so we can hint a node number. */
1777 for (hint = 0; hint < MAX_DEV_HINTS; hint++) {
1778 if (((device_hint[hint].type == -1) || (device_hint[hint].type == pdev->type)) &&
1779 (device_hint[hint].pdev == NULL)) {
1780 /* so far, so good... try serial number */
1781 if ((device_hint[hint].serial_number[0] == '*') || !strcmp(device_hint[hint].serial_number, serial_number)) {
1783 video_nr = device_hint[hint].device_node;
1784 PWC_DEBUG_PROBE("Found hint, will try to register as /dev/video%d\n", video_nr);
1790 pdev->vdev->release = video_device_release;
1791 i = video_register_device(pdev->vdev, VFL_TYPE_GRABBER, video_nr);
1793 PWC_ERROR("Failed to register as video device (%d).\n", i);
1798 PWC_INFO("Registered as /dev/video%d.\n", pdev->vdev->num);
1802 if (hint < MAX_DEV_HINTS)
1803 device_hint[hint].pdev = pdev;
1805 PWC_DEBUG_PROBE("probe() function returning struct at 0x%p.\n", pdev);
1806 usb_set_intfdata (intf, pdev);
1807 rc = pwc_create_sysfs_files(pdev->vdev);
1811 /* Set the leds off */
1812 pwc_set_leds(pdev, 0, 0);
1813 pwc_camera_power(pdev, 0);
1818 if (hint < MAX_DEV_HINTS)
1819 device_hint[hint].pdev = NULL;
1820 video_unregister_device(pdev->vdev);
1822 video_device_release(pdev->vdev); /* Drip... drip... drip... */
1823 kfree(pdev); /* Oops, no memory leaks please */
1827 /* The user janked out the cable... */
1828 static void usb_pwc_disconnect(struct usb_interface *intf)
1830 struct pwc_device *pdev;
1834 pdev = usb_get_intfdata (intf);
1835 usb_set_intfdata (intf, NULL);
1837 PWC_ERROR("pwc_disconnect() Called without private pointer.\n");
1838 goto disconnect_out;
1840 if (pdev->udev == NULL) {
1841 PWC_ERROR("pwc_disconnect() already called for %p\n", pdev);
1842 goto disconnect_out;
1844 if (pdev->udev != interface_to_usbdev(intf)) {
1845 PWC_ERROR("pwc_disconnect() Woops: pointer mismatch udev/pdev.\n");
1846 goto disconnect_out;
1849 /* We got unplugged; this is signalled by an EPIPE error code */
1851 PWC_INFO("Disconnected while webcam is in use!\n");
1852 pdev->error_status = EPIPE;
1855 /* Alert waiting processes */
1856 wake_up_interruptible(&pdev->frameq);
1857 /* Wait until device is closed */
1859 mutex_lock(&pdev->modlock);
1860 pdev->unplugged = 1;
1861 mutex_unlock(&pdev->modlock);
1864 /* Device is closed, so we can safely unregister it */
1865 PWC_DEBUG_PROBE("Unregistering video device in disconnect().\n");
1867 /* Free memory (don't set pdev to 0 just yet) */
1871 /* search device_hint[] table if we occupy a slot, by any chance */
1872 for (hint = 0; hint < MAX_DEV_HINTS; hint++)
1873 if (device_hint[hint].pdev == pdev)
1874 device_hint[hint].pdev = NULL;
1880 /* *grunt* We have to do atoi ourselves :-( */
1881 static int pwc_atoi(const char *s)
1886 while (*s != '\0' && *s >= '0' && *s <= '9') {
1887 k = 10 * k + (*s - '0');
1895 * Initialization code & module stuff
1902 static int compression = -1;
1903 static int leds[2] = { -1, -1 };
1904 static unsigned int leds_nargs;
1905 static char *dev_hint[MAX_DEV_HINTS];
1906 static unsigned int dev_hint_nargs;
1908 module_param(size, charp, 0444);
1909 module_param(fps, int, 0444);
1910 module_param(fbufs, int, 0444);
1911 module_param(mbufs, int, 0444);
1912 #ifdef CONFIG_USB_PWC_DEBUG
1913 module_param_named(trace, pwc_trace, int, 0644);
1915 module_param(power_save, int, 0444);
1916 module_param(compression, int, 0444);
1917 module_param_array(leds, int, &leds_nargs, 0444);
1918 module_param_array(dev_hint, charp, &dev_hint_nargs, 0444);
1920 MODULE_PARM_DESC(size, "Initial image size. One of sqcif, qsif, qcif, sif, cif, vga");
1921 MODULE_PARM_DESC(fps, "Initial frames per second. Varies with model, useful range 5-30");
1922 MODULE_PARM_DESC(fbufs, "Number of internal frame buffers to reserve");
1923 MODULE_PARM_DESC(mbufs, "Number of external (mmap()ed) image buffers");
1924 MODULE_PARM_DESC(trace, "For debugging purposes");
1925 MODULE_PARM_DESC(power_save, "Turn power save feature in camera on or off");
1926 MODULE_PARM_DESC(compression, "Preferred compression quality. Range 0 (uncompressed) to 3 (high compression)");
1927 MODULE_PARM_DESC(leds, "LED on,off time in milliseconds");
1928 MODULE_PARM_DESC(dev_hint, "Device node hints");
1930 MODULE_DESCRIPTION("Philips & OEM USB webcam driver");
1931 MODULE_AUTHOR("Luc Saillard <luc@saillard.org>");
1932 MODULE_LICENSE("GPL");
1933 MODULE_ALIAS("pwcx");
1934 MODULE_VERSION( PWC_VERSION );
1936 static int __init usb_pwc_init(void)
1939 char *sizenames[PSZ_MAX] = { "sqcif", "qsif", "qcif", "sif", "cif", "vga" };
1941 PWC_INFO("Philips webcam module version " PWC_VERSION " loaded.\n");
1942 PWC_INFO("Supports Philips PCA645/646, PCVC675/680/690, PCVC720[40]/730/740/750 & PCVC830/840.\n");
1943 PWC_INFO("Also supports the Askey VC010, various Logitech Quickcams, Samsung MPC-C10 and MPC-C30,\n");
1944 PWC_INFO("the Creative WebCam 5 & Pro Ex, SOTEC Afina Eye and Visionite VCS-UC300 and VCS-UM100.\n");
1947 if (fps < 4 || fps > 30) {
1948 PWC_ERROR("Framerate out of bounds (4-30).\n");
1952 PWC_DEBUG_MODULE("Default framerate set to %d.\n", default_fps);
1956 /* string; try matching with array */
1957 for (sz = 0; sz < PSZ_MAX; sz++) {
1958 if (!strcmp(sizenames[sz], size)) { /* Found! */
1963 if (sz == PSZ_MAX) {
1964 PWC_ERROR("Size not recognized; try size=[sqcif | qsif | qcif | sif | cif | vga].\n");
1967 PWC_DEBUG_MODULE("Default image size set to %s [%dx%d].\n", sizenames[default_size], pwc_image_sizes[default_size].x, pwc_image_sizes[default_size].y);
1970 if (mbufs < 1 || mbufs > MAX_IMAGES) {
1971 PWC_ERROR("Illegal number of mmap() buffers; use a number between 1 and %d.\n", MAX_IMAGES);
1975 PWC_DEBUG_MODULE("Number of image buffers set to %d.\n", pwc_mbufs);
1978 if (fbufs < 2 || fbufs > MAX_FRAMES) {
1979 PWC_ERROR("Illegal number of frame buffers; use a number between 2 and %d.\n", MAX_FRAMES);
1982 default_fbufs = fbufs;
1983 PWC_DEBUG_MODULE("Number of frame buffers set to %d.\n", default_fbufs);
1985 #ifdef CONFIG_USB_PWC_DEBUG
1986 if (pwc_trace >= 0) {
1987 PWC_DEBUG_MODULE("Trace options: 0x%04x\n", pwc_trace);
1990 if (compression >= 0) {
1991 if (compression > 3) {
1992 PWC_ERROR("Invalid compression setting; use a number between 0 (uncompressed) and 3 (high).\n");
1995 pwc_preferred_compression = compression;
1996 PWC_DEBUG_MODULE("Preferred compression set to %d.\n", pwc_preferred_compression);
1999 PWC_DEBUG_MODULE("Enabling power save on open/close.\n");
2005 /* Big device node whoopla. Basically, it allows you to assign a
2006 device node (/dev/videoX) to a camera, based on its type
2007 & serial number. The format is [type[.serialnumber]:]node.
2009 Any camera that isn't matched by these rules gets the next
2010 available free device node.
2012 for (i = 0; i < MAX_DEV_HINTS; i++) {
2013 char *s, *colon, *dot;
2015 /* This loop also initializes the array */
2016 device_hint[i].pdev = NULL;
2018 if (s != NULL && *s != '\0') {
2019 device_hint[i].type = -1; /* wildcard */
2020 strcpy(device_hint[i].serial_number, "*");
2022 /* parse string: chop at ':' & '/' */
2024 while (*colon != '\0' && *colon != ':')
2026 while (*dot != '\0' && *dot != '.')
2028 /* Few sanity checks */
2029 if (*dot != '\0' && dot > colon) {
2030 PWC_ERROR("Malformed camera hint: the colon must be after the dot.\n");
2034 if (*colon == '\0') {
2037 PWC_ERROR("Malformed camera hint: no colon + device node given.\n");
2041 /* No type or serial number specified, just a number. */
2042 device_hint[i].device_node = pwc_atoi(s);
2046 /* There's a colon, so we have at least a type and a device node */
2047 device_hint[i].type = pwc_atoi(s);
2048 device_hint[i].device_node = pwc_atoi(colon + 1);
2050 /* There's a serial number as well */
2055 while (*dot != ':' && k < 29) {
2056 device_hint[i].serial_number[k++] = *dot;
2059 device_hint[i].serial_number[k] = '\0';
2062 PWC_TRACE("device_hint[%d]:\n", i);
2063 PWC_TRACE(" type : %d\n", device_hint[i].type);
2064 PWC_TRACE(" serial# : %s\n", device_hint[i].serial_number);
2065 PWC_TRACE(" node : %d\n", device_hint[i].device_node);
2068 device_hint[i].type = 0; /* not filled */
2069 } /* ..for MAX_DEV_HINTS */
2071 PWC_DEBUG_PROBE("Registering driver at address 0x%p.\n", &pwc_driver);
2072 return usb_register(&pwc_driver);
2075 static void __exit usb_pwc_exit(void)
2077 PWC_DEBUG_MODULE("Deregistering driver.\n");
2078 usb_deregister(&pwc_driver);
2079 PWC_INFO("Philips webcam module removed.\n");
2082 module_init(usb_pwc_init);
2083 module_exit(usb_pwc_exit);
2085 /* vim: set cino= formatoptions=croql cindent shiftwidth=8 tabstop=8: */