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)
5 (C) 2011 Hans de Goede <hdegoede@redhat.com>
7 NOTE: this version of pwc is an unofficial (modified) release of pwc & pcwx
8 driver and thus may have bugs that are not present in the original version.
9 Please send bug reports and support requests to <luc@saillard.org>.
10 The decompression routines have been implemented by reverse-engineering the
11 Nemosoft binary pwcx module. Caveat emptor.
13 This program is free software; you can redistribute it and/or modify
14 it under the terms of the GNU General Public License as published by
15 the Free Software Foundation; either version 2 of the License, or
16 (at your option) any later version.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 GNU General Public License for more details.
23 You should have received a copy of the GNU General Public License
24 along with this program; if not, write to the Free Software
25 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 This code forms the interface between the USB layers and the Philips
31 specific stuff. Some adanved stuff of the driver falls under an
32 NDA, signed between me and Philips B.V., Eindhoven, the Netherlands, and
33 is thus not distributed in source form. The binary pwcx.o module
34 contains the code that falls under the NDA.
36 In case you're wondering: 'pwc' stands for "Philips WebCam", but
37 I really didn't want to type 'philips_web_cam' every time (I'm lazy as
38 any Linux kernel hacker, but I don't like uncomprehensible abbreviations
41 Oh yes, convention: to disctinguish between all the various pointers to
42 device-structures, I use these names for the pointer variables:
43 udev: struct usb_device *
44 vdev: struct video_device (member of pwc_dev)
45 pdev: struct pwc_devive *
49 - Alvarado: adding whitebalance code
50 - Alistar Moire: QuickCam 3000 Pro device/product ID
51 - Tony Hoyle: Creative Labs Webcam 5 device/product ID
52 - Mark Burazin: solving hang in VIDIOCSYNC when camera gets unplugged
53 - Jk Fang: Sotec Afina Eye ID
54 - Xavier Roche: QuickCam Pro 4000 ID
55 - Jens Knudsen: QuickCam Zoom ID
56 - J. Debert: QuickCam for Notebooks ID
57 - Pham Thanh Nam: webcam snapshot button as an event input device
60 #include <linux/errno.h>
61 #include <linux/init.h>
63 #include <linux/module.h>
64 #include <linux/poll.h>
65 #include <linux/slab.h>
66 #ifdef CONFIG_USB_PWC_INPUT_EVDEV
67 #include <linux/usb/input.h>
69 #include <linux/vmalloc.h>
71 #include <linux/kernel.h> /* simple_strtol() */
74 #include "pwc-kiara.h"
75 #include "pwc-timon.h"
76 #include "pwc-dec23.h"
79 /* Function prototypes and driver templates */
81 /* hotplug device table support */
82 static const struct usb_device_id pwc_device_table [] = {
83 { USB_DEVICE(0x0471, 0x0302) }, /* Philips models */
84 { USB_DEVICE(0x0471, 0x0303) },
85 { USB_DEVICE(0x0471, 0x0304) },
86 { USB_DEVICE(0x0471, 0x0307) },
87 { USB_DEVICE(0x0471, 0x0308) },
88 { USB_DEVICE(0x0471, 0x030C) },
89 { USB_DEVICE(0x0471, 0x0310) },
90 { USB_DEVICE(0x0471, 0x0311) }, /* Philips ToUcam PRO II */
91 { USB_DEVICE(0x0471, 0x0312) },
92 { USB_DEVICE(0x0471, 0x0313) }, /* the 'new' 720K */
93 { USB_DEVICE(0x0471, 0x0329) }, /* Philips SPC 900NC PC Camera */
94 { USB_DEVICE(0x069A, 0x0001) }, /* Askey */
95 { USB_DEVICE(0x046D, 0x08B0) }, /* Logitech QuickCam Pro 3000 */
96 { USB_DEVICE(0x046D, 0x08B1) }, /* Logitech QuickCam Notebook Pro */
97 { USB_DEVICE(0x046D, 0x08B2) }, /* Logitech QuickCam Pro 4000 */
98 { USB_DEVICE(0x046D, 0x08B3) }, /* Logitech QuickCam Zoom (old model) */
99 { USB_DEVICE(0x046D, 0x08B4) }, /* Logitech QuickCam Zoom (new model) */
100 { USB_DEVICE(0x046D, 0x08B5) }, /* Logitech QuickCam Orbit/Sphere */
101 { USB_DEVICE(0x046D, 0x08B6) }, /* Cisco VT Camera */
102 { USB_DEVICE(0x046D, 0x08B7) }, /* Logitech ViewPort AV 100 */
103 { USB_DEVICE(0x046D, 0x08B8) }, /* Logitech (reserved) */
104 { USB_DEVICE(0x055D, 0x9000) }, /* Samsung MPC-C10 */
105 { USB_DEVICE(0x055D, 0x9001) }, /* Samsung MPC-C30 */
106 { USB_DEVICE(0x055D, 0x9002) }, /* Samsung SNC-35E (Ver3.0) */
107 { USB_DEVICE(0x041E, 0x400C) }, /* Creative Webcam 5 */
108 { USB_DEVICE(0x041E, 0x4011) }, /* Creative Webcam Pro Ex */
109 { USB_DEVICE(0x04CC, 0x8116) }, /* Afina Eye */
110 { USB_DEVICE(0x06BE, 0x8116) }, /* new Afina Eye */
111 { USB_DEVICE(0x0d81, 0x1910) }, /* Visionite */
112 { USB_DEVICE(0x0d81, 0x1900) },
115 MODULE_DEVICE_TABLE(usb, pwc_device_table);
117 static int usb_pwc_probe(struct usb_interface *intf, const struct usb_device_id *id);
118 static void usb_pwc_disconnect(struct usb_interface *intf);
119 static void pwc_isoc_cleanup(struct pwc_device *pdev);
121 static struct usb_driver pwc_driver = {
122 .name = "Philips webcam", /* name */
123 .id_table = pwc_device_table,
124 .probe = usb_pwc_probe, /* probe() */
125 .disconnect = usb_pwc_disconnect, /* disconnect() */
128 #define MAX_DEV_HINTS 20
129 #define MAX_ISOC_ERRORS 20
131 #ifdef CONFIG_USB_PWC_DEBUG
132 int pwc_trace = PWC_DEBUG_LEVEL;
134 static int power_save = -1;
135 static int leds[2] = { 100, 0 };
139 static const struct v4l2_file_operations pwc_fops = {
140 .owner = THIS_MODULE,
141 .open = v4l2_fh_open,
142 .release = vb2_fop_release,
143 .read = vb2_fop_read,
144 .poll = vb2_fop_poll,
145 .mmap = vb2_fop_mmap,
146 .unlocked_ioctl = video_ioctl2,
148 static struct video_device pwc_template = {
149 .name = "Philips Webcam", /* Filled in later */
150 .release = video_device_release_empty,
152 .ioctl_ops = &pwc_ioctl_ops,
155 /***************************************************************************/
156 /* Private functions */
158 static struct pwc_frame_buf *pwc_get_next_fill_buf(struct pwc_device *pdev)
160 unsigned long flags = 0;
161 struct pwc_frame_buf *buf = NULL;
163 spin_lock_irqsave(&pdev->queued_bufs_lock, flags);
164 if (list_empty(&pdev->queued_bufs))
167 buf = list_entry(pdev->queued_bufs.next, struct pwc_frame_buf, list);
168 list_del(&buf->list);
170 spin_unlock_irqrestore(&pdev->queued_bufs_lock, flags);
174 static void pwc_snapshot_button(struct pwc_device *pdev, int down)
177 PWC_TRACE("Snapshot button pressed.\n");
179 PWC_TRACE("Snapshot button released.\n");
182 #ifdef CONFIG_USB_PWC_INPUT_EVDEV
183 if (pdev->button_dev) {
184 input_report_key(pdev->button_dev, KEY_CAMERA, down);
185 input_sync(pdev->button_dev);
190 static void pwc_frame_complete(struct pwc_device *pdev)
192 struct pwc_frame_buf *fbuf = pdev->fill_buf;
194 /* The ToUCam Fun CMOS sensor causes the firmware to send 2 or 3 bogus
195 frames on the USB wire after an exposure change. This conditition is
196 however detected in the cam and a bit is set in the header.
198 if (pdev->type == 730) {
199 unsigned char *ptr = (unsigned char *)fbuf->data;
201 if (ptr[1] == 1 && ptr[0] & 0x10) {
202 PWC_TRACE("Hyundai CMOS sensor bug. Dropping frame.\n");
203 pdev->drop_frames += 2;
205 if ((ptr[0] ^ pdev->vmirror) & 0x01) {
206 pwc_snapshot_button(pdev, ptr[0] & 0x01);
208 if ((ptr[0] ^ pdev->vmirror) & 0x02) {
210 PWC_TRACE("Image is mirrored.\n");
212 PWC_TRACE("Image is normal.\n");
214 pdev->vmirror = ptr[0] & 0x03;
215 /* Sometimes the trailer of the 730 is still sent as a 4 byte packet
216 after a short frame; this condition is filtered out specifically. A 4 byte
217 frame doesn't make sense anyway.
218 So we get either this sequence:
219 drop_bit set -> 4 byte frame -> short frame -> good frame
221 drop_bit set -> short frame -> good frame
222 So we drop either 3 or 2 frames in all!
224 if (fbuf->filled == 4)
226 } else if (pdev->type == 740 || pdev->type == 720) {
227 unsigned char *ptr = (unsigned char *)fbuf->data;
228 if ((ptr[0] ^ pdev->vmirror) & 0x01) {
229 pwc_snapshot_button(pdev, ptr[0] & 0x01);
231 pdev->vmirror = ptr[0] & 0x03;
234 /* In case we were instructed to drop the frame, do so silently. */
235 if (pdev->drop_frames > 0) {
238 /* Check for underflow first */
239 if (fbuf->filled < pdev->frame_total_size) {
240 PWC_DEBUG_FLOW("Frame buffer underflow (%d bytes);"
241 " discarded.\n", fbuf->filled);
243 fbuf->vb.v4l2_buf.field = V4L2_FIELD_NONE;
244 fbuf->vb.v4l2_buf.sequence = pdev->vframe_count;
245 vb2_buffer_done(&fbuf->vb, VB2_BUF_STATE_DONE);
246 pdev->fill_buf = NULL;
250 pdev->vframe_count++;
253 /* This gets called for the Isochronous pipe (video). This is done in
254 * interrupt time, so it has to be fast, not crash, and not stall. Neat.
256 static void pwc_isoc_handler(struct urb *urb)
258 struct pwc_device *pdev = (struct pwc_device *)urb->context;
260 unsigned char *iso_buf = NULL;
262 if (urb->status == -ENOENT || urb->status == -ECONNRESET ||
263 urb->status == -ESHUTDOWN) {
264 PWC_DEBUG_OPEN("URB (%p) unlinked %ssynchronuously.\n", urb, urb->status == -ENOENT ? "" : "a");
268 if (pdev->fill_buf == NULL)
269 pdev->fill_buf = pwc_get_next_fill_buf(pdev);
271 if (urb->status != 0) {
275 switch(urb->status) {
276 case -ENOSR: errmsg = "Buffer error (overrun)"; break;
277 case -EPIPE: errmsg = "Stalled (device not responding)"; break;
278 case -EOVERFLOW: errmsg = "Babble (bad cable?)"; break;
279 case -EPROTO: errmsg = "Bit-stuff error (bad cable?)"; break;
280 case -EILSEQ: errmsg = "CRC/Timeout (could be anything)"; break;
281 case -ETIME: errmsg = "Device does not respond"; break;
283 PWC_ERROR("pwc_isoc_handler() called with status %d [%s].\n",
284 urb->status, errmsg);
285 /* Give up after a number of contiguous errors */
286 if (++pdev->visoc_errors > MAX_ISOC_ERRORS)
288 PWC_ERROR("Too many ISOC errors, bailing out.\n");
289 if (pdev->fill_buf) {
290 vb2_buffer_done(&pdev->fill_buf->vb,
291 VB2_BUF_STATE_ERROR);
292 pdev->fill_buf = NULL;
295 pdev->vsync = 0; /* Drop the current frame */
299 /* Reset ISOC error counter. We did get here, after all. */
300 pdev->visoc_errors = 0;
302 /* vsync: 0 = don't copy data
307 for (i = 0; i < urb->number_of_packets; i++) {
308 fst = urb->iso_frame_desc[i].status;
309 flen = urb->iso_frame_desc[i].actual_length;
310 iso_buf = urb->transfer_buffer + urb->iso_frame_desc[i].offset;
312 PWC_ERROR("Iso frame %d has error %d\n", i, fst);
315 if (flen > 0 && pdev->vsync) {
316 struct pwc_frame_buf *fbuf = pdev->fill_buf;
318 if (pdev->vsync == 1) {
320 &fbuf->vb.v4l2_buf.timestamp);
324 if (flen + fbuf->filled > pdev->frame_total_size) {
325 PWC_ERROR("Frame overflow (%d > %d)\n",
327 pdev->frame_total_size);
328 pdev->vsync = 0; /* Let's wait for an EOF */
330 memcpy(fbuf->data + fbuf->filled, iso_buf,
332 fbuf->filled += flen;
335 if (flen < pdev->vlast_packet_size) {
336 /* Shorter packet... end of frame */
337 if (pdev->vsync == 2)
338 pwc_frame_complete(pdev);
339 if (pdev->fill_buf == NULL)
340 pdev->fill_buf = pwc_get_next_fill_buf(pdev);
341 if (pdev->fill_buf) {
342 pdev->fill_buf->filled = 0;
346 pdev->vlast_packet_size = flen;
350 i = usb_submit_urb(urb, GFP_ATOMIC);
352 PWC_ERROR("Error (%d) re-submitting urb in pwc_isoc_handler.\n", i);
355 /* Both v4l2_lock and vb_queue_lock should be locked when calling this */
356 static int pwc_isoc_init(struct pwc_device *pdev)
358 struct usb_device *udev;
361 struct usb_interface *intf;
362 struct usb_host_interface *idesc = NULL;
363 int compression = 0; /* 0..3 = uncompressed..high */
366 pdev->vlast_packet_size = 0;
367 pdev->fill_buf = NULL;
368 pdev->vframe_count = 0;
369 pdev->visoc_errors = 0;
373 /* We first try with low compression and then retry with a higher
374 compression setting if there is not enough bandwidth. */
375 ret = pwc_set_video_mode(pdev, pdev->width, pdev->height, pdev->pixfmt,
376 pdev->vframes, &compression, 1);
378 /* Get the current alternate interface, adjust packet size */
379 intf = usb_ifnum_to_if(udev, 0);
381 idesc = usb_altnum_to_altsetting(intf, pdev->valternate);
385 /* Search video endpoint */
386 pdev->vmax_packet_size = -1;
387 for (i = 0; i < idesc->desc.bNumEndpoints; i++) {
388 if ((idesc->endpoint[i].desc.bEndpointAddress & 0xF) == pdev->vendpoint) {
389 pdev->vmax_packet_size = le16_to_cpu(idesc->endpoint[i].desc.wMaxPacketSize);
394 if (pdev->vmax_packet_size < 0 || pdev->vmax_packet_size > ISO_MAX_FRAME_SIZE) {
395 PWC_ERROR("Failed to find packet size for video endpoint in current alternate setting.\n");
396 return -ENFILE; /* Odd error, that should be noticeable */
399 /* Set alternate interface */
400 PWC_DEBUG_OPEN("Setting alternate interface %d\n", pdev->valternate);
401 ret = usb_set_interface(pdev->udev, 0, pdev->valternate);
402 if (ret == -ENOSPC && compression < 3) {
409 /* Allocate and init Isochronuous urbs */
410 for (i = 0; i < MAX_ISO_BUFS; i++) {
411 urb = usb_alloc_urb(ISO_FRAMES_PER_DESC, GFP_KERNEL);
413 PWC_ERROR("Failed to allocate urb %d\n", i);
414 pwc_isoc_cleanup(pdev);
418 PWC_DEBUG_MEMORY("Allocated URB at 0x%p\n", urb);
420 urb->interval = 1; // devik
422 urb->pipe = usb_rcvisocpipe(udev, pdev->vendpoint);
423 urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
424 urb->transfer_buffer = usb_alloc_coherent(udev,
428 if (urb->transfer_buffer == NULL) {
429 PWC_ERROR("Failed to allocate urb buffer %d\n", i);
430 pwc_isoc_cleanup(pdev);
433 urb->transfer_buffer_length = ISO_BUFFER_SIZE;
434 urb->complete = pwc_isoc_handler;
436 urb->start_frame = 0;
437 urb->number_of_packets = ISO_FRAMES_PER_DESC;
438 for (j = 0; j < ISO_FRAMES_PER_DESC; j++) {
439 urb->iso_frame_desc[j].offset = j * ISO_MAX_FRAME_SIZE;
440 urb->iso_frame_desc[j].length = pdev->vmax_packet_size;
445 for (i = 0; i < MAX_ISO_BUFS; i++) {
446 ret = usb_submit_urb(pdev->urbs[i], GFP_KERNEL);
447 if (ret == -ENOSPC && compression < 3) {
449 pwc_isoc_cleanup(pdev);
453 PWC_ERROR("isoc_init() submit_urb %d failed with error %d\n", i, ret);
454 pwc_isoc_cleanup(pdev);
457 PWC_DEBUG_MEMORY("URB 0x%p submitted.\n", pdev->urbs[i]);
461 PWC_DEBUG_OPEN("<< pwc_isoc_init()\n");
465 static void pwc_iso_stop(struct pwc_device *pdev)
469 /* Unlinking ISOC buffers one by one */
470 for (i = 0; i < MAX_ISO_BUFS; i++) {
472 PWC_DEBUG_MEMORY("Unlinking URB %p\n", pdev->urbs[i]);
473 usb_kill_urb(pdev->urbs[i]);
478 static void pwc_iso_free(struct pwc_device *pdev)
482 /* Freeing ISOC buffers one by one */
483 for (i = 0; i < MAX_ISO_BUFS; i++) {
485 PWC_DEBUG_MEMORY("Freeing URB\n");
486 if (pdev->urbs[i]->transfer_buffer) {
487 usb_free_coherent(pdev->udev,
488 pdev->urbs[i]->transfer_buffer_length,
489 pdev->urbs[i]->transfer_buffer,
490 pdev->urbs[i]->transfer_dma);
492 usb_free_urb(pdev->urbs[i]);
493 pdev->urbs[i] = NULL;
498 /* Both v4l2_lock and vb_queue_lock should be locked when calling this */
499 static void pwc_isoc_cleanup(struct pwc_device *pdev)
501 PWC_DEBUG_OPEN(">> pwc_isoc_cleanup()\n");
505 usb_set_interface(pdev->udev, 0, 0);
507 PWC_DEBUG_OPEN("<< pwc_isoc_cleanup()\n");
510 /* Must be called with vb_queue_lock hold */
511 static void pwc_cleanup_queued_bufs(struct pwc_device *pdev,
512 enum vb2_buffer_state state)
514 unsigned long flags = 0;
516 spin_lock_irqsave(&pdev->queued_bufs_lock, flags);
517 while (!list_empty(&pdev->queued_bufs)) {
518 struct pwc_frame_buf *buf;
520 buf = list_entry(pdev->queued_bufs.next, struct pwc_frame_buf,
522 list_del(&buf->list);
523 vb2_buffer_done(&buf->vb, state);
525 spin_unlock_irqrestore(&pdev->queued_bufs_lock, flags);
528 #ifdef CONFIG_USB_PWC_DEBUG
529 static const char *pwc_sensor_type_to_string(unsigned int sensor_type)
531 switch(sensor_type) {
533 return "Hyundai CMOS sensor";
535 return "Sony CCD sensor + TDA8787";
537 return "Sony CCD sensor + Exas 98L59";
539 return "Sony CCD sensor + ADI 9804";
541 return "Sharp CCD sensor + TDA8787";
543 return "Sharp CCD sensor + Exas 98L59";
545 return "Sharp CCD sensor + ADI 9804";
547 return "UPA 1021 sensor";
551 return "PAL MR sensor";
553 return "unknown type of sensor";
558 /***************************************************************************/
559 /* Video4Linux functions */
561 static void pwc_video_release(struct v4l2_device *v)
563 struct pwc_device *pdev = container_of(v, struct pwc_device, v4l2_dev);
565 v4l2_ctrl_handler_free(&pdev->ctrl_handler);
566 v4l2_device_unregister(&pdev->v4l2_dev);
567 kfree(pdev->ctrl_buf);
571 /***************************************************************************/
572 /* Videobuf2 operations */
574 static int queue_setup(struct vb2_queue *vq, const struct v4l2_format *fmt,
575 unsigned int *nbuffers, unsigned int *nplanes,
576 unsigned int sizes[], void *alloc_ctxs[])
578 struct pwc_device *pdev = vb2_get_drv_priv(vq);
581 if (*nbuffers < MIN_FRAMES)
582 *nbuffers = MIN_FRAMES;
583 else if (*nbuffers > MAX_FRAMES)
584 *nbuffers = MAX_FRAMES;
588 size = pwc_get_size(pdev, MAX_WIDTH, MAX_HEIGHT);
589 sizes[0] = PAGE_ALIGN(pwc_image_sizes[size][0] *
590 pwc_image_sizes[size][1] * 3 / 2);
595 static int buffer_init(struct vb2_buffer *vb)
597 struct pwc_frame_buf *buf = container_of(vb, struct pwc_frame_buf, vb);
599 /* need vmalloc since frame buffer > 128K */
600 buf->data = vzalloc(PWC_FRAME_SIZE);
601 if (buf->data == NULL)
607 static int buffer_prepare(struct vb2_buffer *vb)
609 struct pwc_device *pdev = vb2_get_drv_priv(vb->vb2_queue);
611 /* Don't allow queing new buffers after device disconnection */
618 static void buffer_finish(struct vb2_buffer *vb)
620 struct pwc_device *pdev = vb2_get_drv_priv(vb->vb2_queue);
621 struct pwc_frame_buf *buf = container_of(vb, struct pwc_frame_buf, vb);
623 if (vb->state == VB2_BUF_STATE_DONE) {
625 * Application has called dqbuf and is getting back a buffer
626 * we've filled, take the pwc data we've stored in buf->data
627 * and decompress it into a usable format, storing the result
630 pwc_decompress(pdev, buf);
634 static void buffer_cleanup(struct vb2_buffer *vb)
636 struct pwc_frame_buf *buf = container_of(vb, struct pwc_frame_buf, vb);
641 static void buffer_queue(struct vb2_buffer *vb)
643 struct pwc_device *pdev = vb2_get_drv_priv(vb->vb2_queue);
644 struct pwc_frame_buf *buf = container_of(vb, struct pwc_frame_buf, vb);
645 unsigned long flags = 0;
647 /* Check the device has not disconnected between prep and queuing */
649 vb2_buffer_done(&buf->vb, VB2_BUF_STATE_ERROR);
653 spin_lock_irqsave(&pdev->queued_bufs_lock, flags);
654 list_add_tail(&buf->list, &pdev->queued_bufs);
655 spin_unlock_irqrestore(&pdev->queued_bufs_lock, flags);
658 static int start_streaming(struct vb2_queue *vq, unsigned int count)
660 struct pwc_device *pdev = vb2_get_drv_priv(vq);
666 if (mutex_lock_interruptible(&pdev->v4l2_lock))
668 /* Turn on camera and set LEDS on */
669 pwc_camera_power(pdev, 1);
670 pwc_set_leds(pdev, leds[0], leds[1]);
672 r = pwc_isoc_init(pdev);
674 /* If we failed turn camera and LEDS back off */
675 pwc_set_leds(pdev, 0, 0);
676 pwc_camera_power(pdev, 0);
677 /* And cleanup any queued bufs!! */
678 pwc_cleanup_queued_bufs(pdev, VB2_BUF_STATE_QUEUED);
680 mutex_unlock(&pdev->v4l2_lock);
685 static void stop_streaming(struct vb2_queue *vq)
687 struct pwc_device *pdev = vb2_get_drv_priv(vq);
689 mutex_lock(&pdev->v4l2_lock);
691 pwc_set_leds(pdev, 0, 0);
692 pwc_camera_power(pdev, 0);
693 pwc_isoc_cleanup(pdev);
696 pwc_cleanup_queued_bufs(pdev, VB2_BUF_STATE_ERROR);
698 vb2_buffer_done(&pdev->fill_buf->vb, VB2_BUF_STATE_ERROR);
699 mutex_unlock(&pdev->v4l2_lock);
702 static struct vb2_ops pwc_vb_queue_ops = {
703 .queue_setup = queue_setup,
704 .buf_init = buffer_init,
705 .buf_prepare = buffer_prepare,
706 .buf_finish = buffer_finish,
707 .buf_cleanup = buffer_cleanup,
708 .buf_queue = buffer_queue,
709 .start_streaming = start_streaming,
710 .stop_streaming = stop_streaming,
711 .wait_prepare = vb2_ops_wait_prepare,
712 .wait_finish = vb2_ops_wait_finish,
715 /***************************************************************************/
718 /* This function gets called when a new device is plugged in or the usb core
722 static int usb_pwc_probe(struct usb_interface *intf, const struct usb_device_id *id)
724 struct usb_device *udev = interface_to_usbdev(intf);
725 struct pwc_device *pdev = NULL;
726 int vendor_id, product_id, type_id;
730 int my_power_save = power_save;
731 char serial_number[30], *name;
733 vendor_id = le16_to_cpu(udev->descriptor.idVendor);
734 product_id = le16_to_cpu(udev->descriptor.idProduct);
736 /* Check if we can handle this device */
737 PWC_DEBUG_PROBE("probe() called [%04X %04X], if %d\n",
738 vendor_id, product_id,
739 intf->altsetting->desc.bInterfaceNumber);
741 /* the interfaces are probed one by one. We are only interested in the
742 video interface (0) now.
743 Interface 1 is the Audio Control, and interface 2 Audio itself.
745 if (intf->altsetting->desc.bInterfaceNumber > 0)
748 if (vendor_id == 0x0471) {
749 switch (product_id) {
751 PWC_INFO("Philips PCA645VC USB webcam detected.\n");
752 name = "Philips 645 webcam";
756 PWC_INFO("Philips PCA646VC USB webcam detected.\n");
757 name = "Philips 646 webcam";
761 PWC_INFO("Askey VC010 type 2 USB webcam detected.\n");
762 name = "Askey VC010 webcam";
766 PWC_INFO("Philips PCVC675K (Vesta) USB webcam detected.\n");
767 name = "Philips 675 webcam";
771 PWC_INFO("Philips PCVC680K (Vesta Pro) USB webcam detected.\n");
772 name = "Philips 680 webcam";
776 PWC_INFO("Philips PCVC690K (Vesta Pro Scan) USB webcam detected.\n");
777 name = "Philips 690 webcam";
781 PWC_INFO("Philips PCVC730K (ToUCam Fun)/PCVC830 (ToUCam II) USB webcam detected.\n");
782 name = "Philips 730 webcam";
786 PWC_INFO("Philips PCVC740K (ToUCam Pro)/PCVC840 (ToUCam II) USB webcam detected.\n");
787 name = "Philips 740 webcam";
791 PWC_INFO("Philips PCVC750K (ToUCam Pro Scan) USB webcam detected.\n");
792 name = "Philips 750 webcam";
796 PWC_INFO("Philips PCVC720K/40 (ToUCam XS) USB webcam detected.\n");
797 name = "Philips 720K/40 webcam";
801 PWC_INFO("Philips SPC 900NC USB webcam detected.\n");
802 name = "Philips SPC 900NC webcam";
810 else if (vendor_id == 0x069A) {
813 PWC_INFO("Askey VC010 type 1 USB webcam detected.\n");
814 name = "Askey VC010 webcam";
822 else if (vendor_id == 0x046d) {
825 PWC_INFO("Logitech QuickCam Pro 3000 USB webcam detected.\n");
826 name = "Logitech QuickCam Pro 3000";
827 type_id = 740; /* CCD sensor */
830 PWC_INFO("Logitech QuickCam Notebook Pro USB webcam detected.\n");
831 name = "Logitech QuickCam Notebook Pro";
832 type_id = 740; /* CCD sensor */
835 PWC_INFO("Logitech QuickCam 4000 Pro USB webcam detected.\n");
836 name = "Logitech QuickCam Pro 4000";
837 type_id = 740; /* CCD sensor */
838 if (my_power_save == -1)
842 PWC_INFO("Logitech QuickCam Zoom USB webcam detected.\n");
843 name = "Logitech QuickCam Zoom";
844 type_id = 740; /* CCD sensor */
847 PWC_INFO("Logitech QuickCam Zoom (new model) USB webcam detected.\n");
848 name = "Logitech QuickCam Zoom";
849 type_id = 740; /* CCD sensor */
850 if (my_power_save == -1)
854 PWC_INFO("Logitech QuickCam Orbit/Sphere USB webcam detected.\n");
855 name = "Logitech QuickCam Orbit";
856 type_id = 740; /* CCD sensor */
857 if (my_power_save == -1)
859 features |= FEATURE_MOTOR_PANTILT;
862 PWC_INFO("Logitech/Cisco VT Camera webcam detected.\n");
863 name = "Cisco VT Camera";
864 type_id = 740; /* CCD sensor */
867 PWC_INFO("Logitech ViewPort AV 100 webcam detected.\n");
868 name = "Logitech ViewPort AV 100";
869 type_id = 740; /* CCD sensor */
871 case 0x08b8: /* Where this released? */
872 PWC_INFO("Logitech QuickCam detected (reserved ID).\n");
873 name = "Logitech QuickCam (res.)";
874 type_id = 730; /* Assuming CMOS */
881 else if (vendor_id == 0x055d) {
882 /* I don't know the difference between the C10 and the C30;
883 I suppose the difference is the sensor, but both cameras
884 work equally well with a type_id of 675
888 PWC_INFO("Samsung MPC-C10 USB webcam detected.\n");
889 name = "Samsung MPC-C10";
893 PWC_INFO("Samsung MPC-C30 USB webcam detected.\n");
894 name = "Samsung MPC-C30";
898 PWC_INFO("Samsung SNC-35E (v3.0) USB webcam detected.\n");
899 name = "Samsung MPC-C30";
907 else if (vendor_id == 0x041e) {
910 PWC_INFO("Creative Labs Webcam 5 detected.\n");
911 name = "Creative Labs Webcam 5";
913 if (my_power_save == -1)
917 PWC_INFO("Creative Labs Webcam Pro Ex detected.\n");
918 name = "Creative Labs Webcam Pro Ex";
926 else if (vendor_id == 0x04cc) {
929 PWC_INFO("Sotec Afina Eye USB webcam detected.\n");
930 name = "Sotec Afina Eye";
938 else if (vendor_id == 0x06be) {
941 /* This is essentially the same cam as the Sotec Afina Eye */
942 PWC_INFO("AME Co. Afina Eye USB webcam detected.\n");
943 name = "AME Co. Afina Eye";
952 else if (vendor_id == 0x0d81) {
955 PWC_INFO("Visionite VCS-UC300 USB webcam detected.\n");
956 name = "Visionite VCS-UC300";
957 type_id = 740; /* CCD sensor */
960 PWC_INFO("Visionite VCS-UM100 USB webcam detected.\n");
961 name = "Visionite VCS-UM100";
962 type_id = 730; /* CMOS sensor */
970 return -ENODEV; /* Not any of the know types; but the list keeps growing. */
972 if (my_power_save == -1)
975 memset(serial_number, 0, 30);
976 usb_string(udev, udev->descriptor.iSerialNumber, serial_number, 29);
977 PWC_DEBUG_PROBE("Device serial number is %s\n", serial_number);
979 if (udev->descriptor.bNumConfigurations > 1)
980 PWC_WARNING("Warning: more than 1 configuration available.\n");
982 /* Allocate structure, initialize pointers, mutexes, etc. and link it to the usb_device */
983 pdev = kzalloc(sizeof(struct pwc_device), GFP_KERNEL);
985 PWC_ERROR("Oops, could not allocate memory for pwc_device.\n");
988 pdev->type = type_id;
989 pdev->features = features;
990 pwc_construct(pdev); /* set min/max sizes correct */
992 mutex_init(&pdev->v4l2_lock);
993 mutex_init(&pdev->vb_queue_lock);
994 spin_lock_init(&pdev->queued_bufs_lock);
995 INIT_LIST_HEAD(&pdev->queued_bufs);
998 pdev->power_save = my_power_save;
1000 /* Init videobuf2 queue structure */
1001 pdev->vb_queue.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1002 pdev->vb_queue.io_modes = VB2_MMAP | VB2_USERPTR | VB2_READ;
1003 pdev->vb_queue.drv_priv = pdev;
1004 pdev->vb_queue.buf_struct_size = sizeof(struct pwc_frame_buf);
1005 pdev->vb_queue.ops = &pwc_vb_queue_ops;
1006 pdev->vb_queue.mem_ops = &vb2_vmalloc_memops;
1007 pdev->vb_queue.timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC;
1008 rc = vb2_queue_init(&pdev->vb_queue);
1010 PWC_ERROR("Oops, could not initialize vb2 queue.\n");
1014 /* Init video_device structure */
1015 pdev->vdev = pwc_template;
1016 strcpy(pdev->vdev.name, name);
1017 pdev->vdev.queue = &pdev->vb_queue;
1018 pdev->vdev.queue->lock = &pdev->vb_queue_lock;
1019 video_set_drvdata(&pdev->vdev, pdev);
1021 pdev->release = le16_to_cpu(udev->descriptor.bcdDevice);
1022 PWC_DEBUG_PROBE("Release: %04x\n", pdev->release);
1024 /* Allocate USB command buffers */
1025 pdev->ctrl_buf = kmalloc(sizeof(pdev->cmd_buf), GFP_KERNEL);
1026 if (!pdev->ctrl_buf) {
1027 PWC_ERROR("Oops, could not allocate memory for pwc_device.\n");
1032 #ifdef CONFIG_USB_PWC_DEBUG
1033 /* Query sensor type */
1034 if (pwc_get_cmos_sensor(pdev, &rc) >= 0) {
1035 PWC_DEBUG_OPEN("This %s camera is equipped with a %s (%d).\n",
1037 pwc_sensor_type_to_string(rc), rc);
1041 /* Set the leds off */
1042 pwc_set_leds(pdev, 0, 0);
1044 /* Setup initial videomode */
1045 rc = pwc_set_video_mode(pdev, MAX_WIDTH, MAX_HEIGHT,
1046 V4L2_PIX_FMT_YUV420, 30, &compression, 1);
1050 /* Register controls (and read default values from camera */
1051 rc = pwc_init_controls(pdev);
1053 PWC_ERROR("Failed to register v4l2 controls (%d).\n", rc);
1057 /* And powerdown the camera until streaming starts */
1058 pwc_camera_power(pdev, 0);
1060 /* Register the v4l2_device structure */
1061 pdev->v4l2_dev.release = pwc_video_release;
1062 rc = v4l2_device_register(&intf->dev, &pdev->v4l2_dev);
1064 PWC_ERROR("Failed to register v4l2-device (%d).\n", rc);
1065 goto err_free_controls;
1068 pdev->v4l2_dev.ctrl_handler = &pdev->ctrl_handler;
1069 pdev->vdev.v4l2_dev = &pdev->v4l2_dev;
1070 pdev->vdev.lock = &pdev->v4l2_lock;
1072 rc = video_register_device(&pdev->vdev, VFL_TYPE_GRABBER, -1);
1074 PWC_ERROR("Failed to register as video device (%d).\n", rc);
1075 goto err_unregister_v4l2_dev;
1077 PWC_INFO("Registered as %s.\n", video_device_node_name(&pdev->vdev));
1079 #ifdef CONFIG_USB_PWC_INPUT_EVDEV
1080 /* register webcam snapshot button input device */
1081 pdev->button_dev = input_allocate_device();
1082 if (!pdev->button_dev) {
1084 goto err_video_unreg;
1087 usb_make_path(udev, pdev->button_phys, sizeof(pdev->button_phys));
1088 strlcat(pdev->button_phys, "/input0", sizeof(pdev->button_phys));
1090 pdev->button_dev->name = "PWC snapshot button";
1091 pdev->button_dev->phys = pdev->button_phys;
1092 usb_to_input_id(pdev->udev, &pdev->button_dev->id);
1093 pdev->button_dev->dev.parent = &pdev->udev->dev;
1094 pdev->button_dev->evbit[0] = BIT_MASK(EV_KEY);
1095 pdev->button_dev->keybit[BIT_WORD(KEY_CAMERA)] = BIT_MASK(KEY_CAMERA);
1097 rc = input_register_device(pdev->button_dev);
1099 input_free_device(pdev->button_dev);
1100 pdev->button_dev = NULL;
1101 goto err_video_unreg;
1108 video_unregister_device(&pdev->vdev);
1109 err_unregister_v4l2_dev:
1110 v4l2_device_unregister(&pdev->v4l2_dev);
1112 v4l2_ctrl_handler_free(&pdev->ctrl_handler);
1114 kfree(pdev->ctrl_buf);
1119 /* The user yanked out the cable... */
1120 static void usb_pwc_disconnect(struct usb_interface *intf)
1122 struct v4l2_device *v = usb_get_intfdata(intf);
1123 struct pwc_device *pdev = container_of(v, struct pwc_device, v4l2_dev);
1125 mutex_lock(&pdev->vb_queue_lock);
1126 mutex_lock(&pdev->v4l2_lock);
1127 /* No need to keep the urbs around after disconnection */
1128 if (pdev->vb_queue.streaming)
1129 pwc_isoc_cleanup(pdev);
1132 v4l2_device_disconnect(&pdev->v4l2_dev);
1133 video_unregister_device(&pdev->vdev);
1134 mutex_unlock(&pdev->v4l2_lock);
1135 mutex_unlock(&pdev->vb_queue_lock);
1137 #ifdef CONFIG_USB_PWC_INPUT_EVDEV
1138 if (pdev->button_dev)
1139 input_unregister_device(pdev->button_dev);
1142 v4l2_device_put(&pdev->v4l2_dev);
1147 * Initialization code & module stuff
1150 static unsigned int leds_nargs;
1152 #ifdef CONFIG_USB_PWC_DEBUG
1153 module_param_named(trace, pwc_trace, int, 0644);
1155 module_param(power_save, int, 0644);
1156 module_param_array(leds, int, &leds_nargs, 0444);
1158 #ifdef CONFIG_USB_PWC_DEBUG
1159 MODULE_PARM_DESC(trace, "For debugging purposes");
1161 MODULE_PARM_DESC(power_save, "Turn power saving for new cameras on or off");
1162 MODULE_PARM_DESC(leds, "LED on,off time in milliseconds");
1164 MODULE_DESCRIPTION("Philips & OEM USB webcam driver");
1165 MODULE_AUTHOR("Luc Saillard <luc@saillard.org>");
1166 MODULE_LICENSE("GPL");
1167 MODULE_ALIAS("pwcx");
1168 MODULE_VERSION( PWC_VERSION );
1170 module_usb_driver(pwc_driver);