blob: 0ff5718bf9b92d7c37eae208b0adf33b905c689b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* Linux driver for Philips webcam
2 USB and Video4Linux interface part.
3 (C) 1999-2004 Nemosoft Unv.
Luc Saillard2b455db2006-04-24 10:29:46 -03004 (C) 2004-2006 Luc Saillard (luc@saillard.org)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005
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.
11
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.
16
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.
21
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
25
26*/
27
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -030028/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 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
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -030032 is thus not distributed in source form. The binary pwcx.o module
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 contains the code that falls under the NDA.
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -030034
35 In case you're wondering: 'pwc' stands for "Philips WebCam", but
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 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
38 without explanation).
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -030039
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 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 *
45*/
46
47/* Contributors:
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
56*/
57
58#include <linux/errno.h>
59#include <linux/init.h>
60#include <linux/mm.h>
61#include <linux/module.h>
62#include <linux/poll.h>
63#include <linux/slab.h>
64#include <linux/vmalloc.h>
Luc Saillard2b455db2006-04-24 10:29:46 -030065#include <linux/version.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#include <asm/io.h>
67
68#include "pwc.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#include "pwc-kiara.h"
70#include "pwc-timon.h"
Luc Saillard2b455db2006-04-24 10:29:46 -030071#include "pwc-dec23.h"
72#include "pwc-dec1.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070073#include "pwc-uncompress.h"
74
75/* Function prototypes and driver templates */
76
77/* hotplug device table support */
Luc Saillard2b455db2006-04-24 10:29:46 -030078static const struct usb_device_id pwc_device_table [] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 { 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) },
Luc Saillard2b455db2006-04-24 10:29:46 -030086 { USB_DEVICE(0x0471, 0x0311) }, /* Philips ToUcam PRO II */
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 { USB_DEVICE(0x0471, 0x0312) },
88 { USB_DEVICE(0x0471, 0x0313) }, /* the 'new' 720K */
Luc Saillard2b455db2006-04-24 10:29:46 -030089 { USB_DEVICE(0x0471, 0x0329) }, /* Philips SPC 900NC PC Camera */
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 { 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 */
Mauro Carvalho Chehab6b1ce3c2007-03-21 16:35:28 -030097 { USB_DEVICE(0x046D, 0x08B6) }, /* Cisco VT Camera */
98 { USB_DEVICE(0x046D, 0x08B7) }, /* Logitech ViewPort AV 100 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 { USB_DEVICE(0x046D, 0x08B8) }, /* Logitech (reserved) */
Luc Saillard2b455db2006-04-24 10:29:46 -0300100 { 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) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 { 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) },
109 { }
110};
111MODULE_DEVICE_TABLE(usb, pwc_device_table);
112
113static int usb_pwc_probe(struct usb_interface *intf, const struct usb_device_id *id);
114static void usb_pwc_disconnect(struct usb_interface *intf);
115
116static struct usb_driver pwc_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 .name = "Philips webcam", /* name */
118 .id_table = pwc_device_table,
119 .probe = usb_pwc_probe, /* probe() */
120 .disconnect = usb_pwc_disconnect, /* disconnect() */
121};
122
123#define MAX_DEV_HINTS 20
124#define MAX_ISOC_ERRORS 20
125
126static int default_size = PSZ_QCIF;
127static int default_fps = 10;
128static int default_fbufs = 3; /* Default number of frame buffers */
Michael Krufkyb930e1d2007-08-27 18:16:54 -0300129 int pwc_mbufs = 2; /* Default number of mmap() buffers */
Trent Piepho05ad3902007-01-30 23:26:01 -0300130#ifdef CONFIG_USB_PWC_DEBUG
Michael Krufkyb930e1d2007-08-27 18:16:54 -0300131 int pwc_trace = PWC_DEBUG_LEVEL;
Luc Saillard2b455db2006-04-24 10:29:46 -0300132#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133static int power_save = 0;
134static int led_on = 100, led_off = 0; /* defaults to LED that is on while in use */
Adrian Bunkb20c3cf2006-06-23 06:49:34 -0300135static int pwc_preferred_compression = 1; /* 0..3 = uncompressed..high */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136static struct {
137 int type;
138 char serial_number[30];
139 int device_node;
140 struct pwc_device *pdev;
141} device_hint[MAX_DEV_HINTS];
142
143/***/
144
145static int pwc_video_open(struct inode *inode, struct file *file);
146static int pwc_video_close(struct inode *inode, struct file *file);
Luc Saillard2b455db2006-04-24 10:29:46 -0300147static ssize_t pwc_video_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 size_t count, loff_t *ppos);
149static unsigned int pwc_video_poll(struct file *file, poll_table *wait);
150static int pwc_video_ioctl(struct inode *inode, struct file *file,
151 unsigned int ioctlnr, unsigned long arg);
152static int pwc_video_mmap(struct file *file, struct vm_area_struct *vma);
153
Arjan van de Venfa027c22007-02-12 00:55:33 -0800154static const struct file_operations pwc_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 .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,
Luc Van Oostenryck3cdc0f22006-08-08 09:10:10 -0300162 .compat_ioctl = v4l_compat_ioctl32,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 .llseek = no_llseek,
164};
165static struct video_device pwc_template = {
166 .owner = THIS_MODULE,
167 .name = "Philips Webcam", /* Filled in later */
168 .type = VID_TYPE_CAPTURE,
169 .hardware = VID_HARDWARE_PWC,
170 .release = video_device_release,
171 .fops = &pwc_fops,
172 .minor = -1,
173};
174
175/***************************************************************************/
176
177/* Okay, this is some magic that I worked out and the reasoning behind it...
178
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300179 The biggest problem with any USB device is of course: "what to do
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 when the user unplugs the device while it is in use by an application?"
181 We have several options:
182 1) Curse them with the 7 plagues when they do (requires divine intervention)
183 2) Tell them not to (won't work: they'll do it anyway)
184 3) Oops the kernel (this will have a negative effect on a user's uptime)
185 4) Do something sensible.
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300186
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 Of course, we go for option 4.
188
189 It happens that this device will be linked to two times, once from
190 usb_device and once from the video_device in their respective 'private'
191 pointers. This is done when the device is probed() and all initialization
192 succeeded. The pwc_device struct links back to both structures.
193
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300194 When a device is unplugged while in use it will be removed from the
195 list of known USB devices; I also de-register it as a V4L device, but
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 unfortunately I can't free the memory since the struct is still in use
197 by the file descriptor. This free-ing is then deferend until the first
198 opportunity. Crude, but it works.
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 A small 'advantage' is that if a user unplugs the cam and plugs it back
201 in, it should get assigned the same video device minor, but unfortunately
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300202 it's non-trivial to re-link the cam back to the video device... (that
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 would surely be magic! :))
204*/
205
206/***************************************************************************/
207/* Private functions */
208
209/* Here we want the physical address of the memory.
210 * This is used when initializing the contents of the area.
211 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Luc Saillard2b455db2006-04-24 10:29:46 -0300214
215static void *pwc_rvmalloc(unsigned long size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216{
217 void * mem;
218 unsigned long adr;
219
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300220 mem=vmalloc_32(size);
Luc Saillard2b455db2006-04-24 10:29:46 -0300221 if (!mem)
222 return NULL;
223
224 memset(mem, 0, size); /* Clear the ram out, no junk to the user */
225 adr=(unsigned long) mem;
226 while (size > 0)
227 {
228 SetPageReserved(vmalloc_to_page((void *)adr));
229 adr += PAGE_SIZE;
230 size -= PAGE_SIZE;
231 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 return mem;
233}
234
Luc Saillard2b455db2006-04-24 10:29:46 -0300235static void pwc_rvfree(void * mem, unsigned long size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236{
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300237 unsigned long adr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
Luc Saillard2b455db2006-04-24 10:29:46 -0300239 if (!mem)
240 return;
241
242 adr=(unsigned long) mem;
243 while ((long) size > 0)
244 {
245 ClearPageReserved(vmalloc_to_page((void *)adr));
246 adr += PAGE_SIZE;
247 size -= PAGE_SIZE;
248 }
249 vfree(mem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250}
251
252
253
254
255static int pwc_allocate_buffers(struct pwc_device *pdev)
256{
Luc Saillard2b455db2006-04-24 10:29:46 -0300257 int i, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 void *kbuf;
259
Luc Saillard2b455db2006-04-24 10:29:46 -0300260 PWC_DEBUG_MEMORY(">> pwc_allocate_buffers(pdev = 0x%p)\n", pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
262 if (pdev == NULL)
263 return -ENXIO;
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300264
Luc Saillard2b455db2006-04-24 10:29:46 -0300265 /* Allocate Isochronuous pipe buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 for (i = 0; i < MAX_ISO_BUFS; i++) {
267 if (pdev->sbuf[i].data == NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300268 kbuf = kzalloc(ISO_BUFFER_SIZE, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 if (kbuf == NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300270 PWC_ERROR("Failed to allocate iso buffer %d.\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 return -ENOMEM;
272 }
Luc Saillard2b455db2006-04-24 10:29:46 -0300273 PWC_DEBUG_MEMORY("Allocated iso buffer at %p.\n", kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 pdev->sbuf[i].data = kbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 }
276 }
277
278 /* Allocate frame buffer structure */
279 if (pdev->fbuf == NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300280 kbuf = kzalloc(default_fbufs * sizeof(struct pwc_frame_buf), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 if (kbuf == NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300282 PWC_ERROR("Failed to allocate frame buffer structure.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 return -ENOMEM;
284 }
Luc Saillard2b455db2006-04-24 10:29:46 -0300285 PWC_DEBUG_MEMORY("Allocated frame buffer structure at %p.\n", kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 pdev->fbuf = kbuf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 }
Luc Saillard2b455db2006-04-24 10:29:46 -0300288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 /* create frame buffers, and make circular ring */
290 for (i = 0; i < default_fbufs; i++) {
291 if (pdev->fbuf[i].data == NULL) {
292 kbuf = vmalloc(PWC_FRAME_SIZE); /* need vmalloc since frame buffer > 128K */
293 if (kbuf == NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300294 PWC_ERROR("Failed to allocate frame buffer %d.\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 return -ENOMEM;
296 }
Luc Saillard2b455db2006-04-24 10:29:46 -0300297 PWC_DEBUG_MEMORY("Allocated frame buffer %d at %p.\n", i, kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 pdev->fbuf[i].data = kbuf;
Luc Saillard2b455db2006-04-24 10:29:46 -0300299 memset(kbuf, 0, PWC_FRAME_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 }
301 }
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 /* Allocate decompressor table space */
Luc Saillard2b455db2006-04-24 10:29:46 -0300304 if (DEVICE_USE_CODEC1(pdev->type))
305 err = pwc_dec1_alloc(pdev);
306 else
307 err = pwc_dec23_alloc(pdev);
308
309 if (err) {
310 PWC_ERROR("Failed to allocate decompress table.\n");
311 return err;
312 }
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300313
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 /* Allocate image buffer; double buffer for mmap() */
Luc Saillard2b455db2006-04-24 10:29:46 -0300315 kbuf = pwc_rvmalloc(pwc_mbufs * pdev->len_per_image);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 if (kbuf == NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300317 PWC_ERROR("Failed to allocate image buffer(s). needed (%d)\n",
318 pwc_mbufs * pdev->len_per_image);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 return -ENOMEM;
320 }
Luc Saillard2b455db2006-04-24 10:29:46 -0300321 PWC_DEBUG_MEMORY("Allocated image buffer at %p.\n", kbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 pdev->image_data = kbuf;
Luc Saillard2b455db2006-04-24 10:29:46 -0300323 for (i = 0; i < pwc_mbufs; i++) {
324 pdev->images[i].offset = i * pdev->len_per_image;
325 pdev->images[i].vma_use_count = 0;
326 }
327 for (; i < MAX_IMAGES; i++) {
328 pdev->images[i].offset = 0;
329 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
331 kbuf = NULL;
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300332
Luc Saillard2b455db2006-04-24 10:29:46 -0300333 PWC_DEBUG_MEMORY("<< pwc_allocate_buffers()\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 return 0;
335}
336
337static void pwc_free_buffers(struct pwc_device *pdev)
338{
339 int i;
340
Luc Saillard2b455db2006-04-24 10:29:46 -0300341 PWC_DEBUG_MEMORY("Entering free_buffers(%p).\n", pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
343 if (pdev == NULL)
344 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 /* Release Iso-pipe buffers */
346 for (i = 0; i < MAX_ISO_BUFS; i++)
347 if (pdev->sbuf[i].data != NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300348 PWC_DEBUG_MEMORY("Freeing ISO buffer at %p.\n", pdev->sbuf[i].data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 kfree(pdev->sbuf[i].data);
350 pdev->sbuf[i].data = NULL;
351 }
352
353 /* The same for frame buffers */
354 if (pdev->fbuf != NULL) {
355 for (i = 0; i < default_fbufs; i++) {
356 if (pdev->fbuf[i].data != NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300357 PWC_DEBUG_MEMORY("Freeing frame buffer %d at %p.\n", i, pdev->fbuf[i].data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 vfree(pdev->fbuf[i].data);
359 pdev->fbuf[i].data = NULL;
360 }
361 }
362 kfree(pdev->fbuf);
363 pdev->fbuf = NULL;
364 }
365
366 /* Intermediate decompression buffer & tables */
367 if (pdev->decompress_data != NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300368 PWC_DEBUG_MEMORY("Freeing decompression buffer at %p.\n", pdev->decompress_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 kfree(pdev->decompress_data);
370 pdev->decompress_data = NULL;
371 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
373 /* Release image buffers */
374 if (pdev->image_data != NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300375 PWC_DEBUG_MEMORY("Freeing image buffer at %p.\n", pdev->image_data);
376 pwc_rvfree(pdev->image_data, pwc_mbufs * pdev->len_per_image);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 }
378 pdev->image_data = NULL;
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300379
Luc Saillard2b455db2006-04-24 10:29:46 -0300380 PWC_DEBUG_MEMORY("Leaving free_buffers().\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381}
382
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300383/* The frame & image buffer mess.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
385 Yes, this is a mess. Well, it used to be simple, but alas... In this
386 module, 3 buffers schemes are used to get the data from the USB bus to
387 the user program. The first scheme involves the ISO buffers (called thus
388 since they transport ISO data from the USB controller), and not really
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300389 interesting. Suffices to say the data from this buffer is quickly
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 gathered in an interrupt handler (pwc_isoc_handler) and placed into the
391 frame buffer.
392
393 The frame buffer is the second scheme, and is the central element here.
394 It collects the data from a single frame from the camera (hence, the
395 name). Frames are delimited by the USB camera with a short USB packet,
396 so that's easy to detect. The frame buffers form a list that is filled
397 by the camera+USB controller and drained by the user process through
398 either read() or mmap().
399
400 The image buffer is the third scheme, in which frames are decompressed
401 and converted into planar format. For mmap() there is more than
402 one image buffer available.
403
404 The frame buffers provide the image buffering. In case the user process
405 is a bit slow, this introduces lag and some undesired side-effects.
406 The problem arises when the frame buffer is full. I used to drop the last
407 frame, which makes the data in the queue stale very quickly. But dropping
408 the frame at the head of the queue proved to be a litte bit more difficult.
409 I tried a circular linked scheme, but this introduced more problems than
410 it solved.
411
412 Because filling and draining are completely asynchronous processes, this
413 requires some fiddling with pointers and mutexes.
414
415 Eventually, I came up with a system with 2 lists: an 'empty' frame list
416 and a 'full' frame list:
417 * Initially, all frame buffers but one are on the 'empty' list; the one
418 remaining buffer is our initial fill frame.
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300419 * If a frame is needed for filling, we try to take it from the 'empty'
420 list, unless that list is empty, in which case we take the buffer at
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 the head of the 'full' list.
422 * When our fill buffer has been filled, it is appended to the 'full'
423 list.
424 * If a frame is needed by read() or mmap(), it is taken from the head of
425 the 'full' list, handled, and then appended to the 'empty' list. If no
426 buffer is present on the 'full' list, we wait.
427 The advantage is that the buffer that is currently being decompressed/
428 converted, is on neither list, and thus not in our way (any other scheme
429 I tried had the problem of old data lingering in the queue).
430
431 Whatever strategy you choose, it always remains a tradeoff: with more
432 frame buffers the chances of a missed frame are reduced. On the other
433 hand, on slower machines it introduces lag because the queue will
434 always be full.
435 */
436
437/**
438 \brief Find next frame buffer to fill. Take from empty or full list, whichever comes first.
439 */
Luc Saillard2b455db2006-04-24 10:29:46 -0300440static int pwc_next_fill_frame(struct pwc_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441{
442 int ret;
443 unsigned long flags;
444
445 ret = 0;
446 spin_lock_irqsave(&pdev->ptrlock, flags);
447 if (pdev->fill_frame != NULL) {
448 /* append to 'full' list */
449 if (pdev->full_frames == NULL) {
450 pdev->full_frames = pdev->fill_frame;
451 pdev->full_frames_tail = pdev->full_frames;
452 }
453 else {
454 pdev->full_frames_tail->next = pdev->fill_frame;
455 pdev->full_frames_tail = pdev->fill_frame;
456 }
457 }
458 if (pdev->empty_frames != NULL) {
459 /* We have empty frames available. That's easy */
460 pdev->fill_frame = pdev->empty_frames;
461 pdev->empty_frames = pdev->empty_frames->next;
462 }
463 else {
464 /* Hmm. Take it from the full list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 /* sanity check */
466 if (pdev->full_frames == NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300467 PWC_ERROR("Neither empty or full frames available!\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 spin_unlock_irqrestore(&pdev->ptrlock, flags);
469 return -EINVAL;
470 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 pdev->fill_frame = pdev->full_frames;
472 pdev->full_frames = pdev->full_frames->next;
473 ret = 1;
474 }
475 pdev->fill_frame->next = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 spin_unlock_irqrestore(&pdev->ptrlock, flags);
477 return ret;
478}
479
480
481/**
482 \brief Reset all buffers, pointers and lists, except for the image_used[] buffer.
483
484 If the image_used[] buffer is cleared too, mmap()/VIDIOCSYNC will run into trouble.
485 */
486static void pwc_reset_buffers(struct pwc_device *pdev)
487{
488 int i;
489 unsigned long flags;
490
Luc Saillard2b455db2006-04-24 10:29:46 -0300491 PWC_DEBUG_MEMORY(">> %s __enter__\n", __FUNCTION__);
492
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 spin_lock_irqsave(&pdev->ptrlock, flags);
494 pdev->full_frames = NULL;
495 pdev->full_frames_tail = NULL;
496 for (i = 0; i < default_fbufs; i++) {
497 pdev->fbuf[i].filled = 0;
498 if (i > 0)
499 pdev->fbuf[i].next = &pdev->fbuf[i - 1];
500 else
501 pdev->fbuf->next = NULL;
502 }
503 pdev->empty_frames = &pdev->fbuf[default_fbufs - 1];
504 pdev->empty_frames_tail = pdev->fbuf;
505 pdev->read_frame = NULL;
506 pdev->fill_frame = pdev->empty_frames;
507 pdev->empty_frames = pdev->empty_frames->next;
508
509 pdev->image_read_pos = 0;
510 pdev->fill_image = 0;
511 spin_unlock_irqrestore(&pdev->ptrlock, flags);
Luc Saillard2b455db2006-04-24 10:29:46 -0300512
513 PWC_DEBUG_MEMORY("<< %s __leaving__\n", __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514}
515
516
517/**
518 \brief Do all the handling for getting one frame: get pointer, decompress, advance pointers.
519 */
Luc Saillard2b455db2006-04-24 10:29:46 -0300520int pwc_handle_frame(struct pwc_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521{
522 int ret = 0;
523 unsigned long flags;
524
525 spin_lock_irqsave(&pdev->ptrlock, flags);
526 /* First grab our read_frame; this is removed from all lists, so
527 we can release the lock after this without problems */
528 if (pdev->read_frame != NULL) {
529 /* This can't theoretically happen */
Luc Saillard2b455db2006-04-24 10:29:46 -0300530 PWC_ERROR("Huh? Read frame still in use?\n");
531 spin_unlock_irqrestore(&pdev->ptrlock, flags);
532 return ret;
533 }
534
535
536 if (pdev->full_frames == NULL) {
537 PWC_ERROR("Woops. No frames ready.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 }
539 else {
Luc Saillard2b455db2006-04-24 10:29:46 -0300540 pdev->read_frame = pdev->full_frames;
541 pdev->full_frames = pdev->full_frames->next;
542 pdev->read_frame->next = NULL;
543 }
544
545 if (pdev->read_frame != NULL) {
546 /* Decompression is a lenghty process, so it's outside of the lock.
547 This gives the isoc_handler the opportunity to fill more frames
548 in the mean time.
549 */
550 spin_unlock_irqrestore(&pdev->ptrlock, flags);
551 ret = pwc_decompress(pdev);
552 spin_lock_irqsave(&pdev->ptrlock, flags);
553
554 /* We're done with read_buffer, tack it to the end of the empty buffer list */
555 if (pdev->empty_frames == NULL) {
556 pdev->empty_frames = pdev->read_frame;
557 pdev->empty_frames_tail = pdev->empty_frames;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 }
559 else {
Luc Saillard2b455db2006-04-24 10:29:46 -0300560 pdev->empty_frames_tail->next = pdev->read_frame;
561 pdev->empty_frames_tail = pdev->read_frame;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 }
Luc Saillard2b455db2006-04-24 10:29:46 -0300563 pdev->read_frame = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 }
565 spin_unlock_irqrestore(&pdev->ptrlock, flags);
566 return ret;
567}
568
569/**
570 \brief Advance pointers of image buffer (after each user request)
571*/
Luc Saillard2b455db2006-04-24 10:29:46 -0300572void pwc_next_image(struct pwc_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573{
574 pdev->image_used[pdev->fill_image] = 0;
Luc Saillard2b455db2006-04-24 10:29:46 -0300575 pdev->fill_image = (pdev->fill_image + 1) % pwc_mbufs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576}
577
Luc Saillard2b455db2006-04-24 10:29:46 -0300578/**
579 * Print debug information when a frame is discarded because all of our buffer
580 * is full
581 */
582static void pwc_frame_dumped(struct pwc_device *pdev)
583{
584 pdev->vframes_dumped++;
585 if (pdev->vframe_count < FRAME_LOWMARK)
586 return;
587
588 if (pdev->vframes_dumped < 20)
589 PWC_DEBUG_FLOW("Dumping frame %d\n", pdev->vframe_count);
590 else if (pdev->vframes_dumped == 20)
591 PWC_DEBUG_FLOW("Dumping frame %d (last message)\n",
592 pdev->vframe_count);
593}
594
595static int pwc_rcv_short_packet(struct pwc_device *pdev, const struct pwc_frame_buf *fbuf)
596{
597 int awake = 0;
598
599 /* The ToUCam Fun CMOS sensor causes the firmware to send 2 or 3 bogus
600 frames on the USB wire after an exposure change. This conditition is
601 however detected in the cam and a bit is set in the header.
602 */
603 if (pdev->type == 730) {
604 unsigned char *ptr = (unsigned char *)fbuf->data;
605
606 if (ptr[1] == 1 && ptr[0] & 0x10) {
607 PWC_TRACE("Hyundai CMOS sensor bug. Dropping frame.\n");
608 pdev->drop_frames += 2;
609 pdev->vframes_error++;
610 }
611 if ((ptr[0] ^ pdev->vmirror) & 0x01) {
612 if (ptr[0] & 0x01) {
613 pdev->snapshot_button_status = 1;
614 PWC_TRACE("Snapshot button pressed.\n");
615 }
616 else {
617 PWC_TRACE("Snapshot button released.\n");
618 }
619 }
620 if ((ptr[0] ^ pdev->vmirror) & 0x02) {
621 if (ptr[0] & 0x02)
622 PWC_TRACE("Image is mirrored.\n");
623 else
624 PWC_TRACE("Image is normal.\n");
625 }
626 pdev->vmirror = ptr[0] & 0x03;
627 /* Sometimes the trailer of the 730 is still sent as a 4 byte packet
628 after a short frame; this condition is filtered out specifically. A 4 byte
629 frame doesn't make sense anyway.
630 So we get either this sequence:
631 drop_bit set -> 4 byte frame -> short frame -> good frame
632 Or this one:
633 drop_bit set -> short frame -> good frame
634 So we drop either 3 or 2 frames in all!
635 */
636 if (fbuf->filled == 4)
637 pdev->drop_frames++;
638 }
639 else if (pdev->type == 740 || pdev->type == 720) {
640 unsigned char *ptr = (unsigned char *)fbuf->data;
641 if ((ptr[0] ^ pdev->vmirror) & 0x01) {
642 if (ptr[0] & 0x01) {
643 pdev->snapshot_button_status = 1;
644 PWC_TRACE("Snapshot button pressed.\n");
645 }
646 else
647 PWC_TRACE("Snapshot button released.\n");
648 }
649 pdev->vmirror = ptr[0] & 0x03;
650 }
651
652 /* In case we were instructed to drop the frame, do so silently.
653 The buffer pointers are not updated either (but the counters are reset below).
654 */
655 if (pdev->drop_frames > 0)
656 pdev->drop_frames--;
657 else {
658 /* Check for underflow first */
659 if (fbuf->filled < pdev->frame_total_size) {
660 PWC_DEBUG_FLOW("Frame buffer underflow (%d bytes);"
661 " discarded.\n", fbuf->filled);
662 pdev->vframes_error++;
663 }
664 else {
665 /* Send only once per EOF */
666 awake = 1; /* delay wake_ups */
667
668 /* Find our next frame to fill. This will always succeed, since we
669 * nick a frame from either empty or full list, but if we had to
670 * take it from the full list, it means a frame got dropped.
671 */
672 if (pwc_next_fill_frame(pdev))
673 pwc_frame_dumped(pdev);
674
675 }
676 } /* !drop_frames */
677 pdev->vframe_count++;
678 return awake;
679}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
681/* This gets called for the Isochronous pipe (video). This is done in
682 * interrupt time, so it has to be fast, not crash, and not stall. Neat.
683 */
David Howells7d12e782006-10-05 14:55:46 +0100684static void pwc_isoc_handler(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685{
686 struct pwc_device *pdev;
687 int i, fst, flen;
688 int awake;
689 struct pwc_frame_buf *fbuf;
690 unsigned char *fillptr = NULL, *iso_buf = NULL;
691
692 awake = 0;
693 pdev = (struct pwc_device *)urb->context;
694 if (pdev == NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300695 PWC_ERROR("isoc_handler() called with NULL device?!\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 return;
697 }
Luc Saillard2b455db2006-04-24 10:29:46 -0300698
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 if (urb->status == -ENOENT || urb->status == -ECONNRESET) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300700 PWC_DEBUG_OPEN("URB (%p) unlinked %ssynchronuously.\n", urb, urb->status == -ENOENT ? "" : "a");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 return;
702 }
703 if (urb->status != -EINPROGRESS && urb->status != 0) {
704 const char *errmsg;
705
706 errmsg = "Unknown";
707 switch(urb->status) {
708 case -ENOSR: errmsg = "Buffer error (overrun)"; break;
709 case -EPIPE: errmsg = "Stalled (device not responding)"; break;
710 case -EOVERFLOW: errmsg = "Babble (bad cable?)"; break;
711 case -EPROTO: errmsg = "Bit-stuff error (bad cable?)"; break;
712 case -EILSEQ: errmsg = "CRC/Timeout (could be anything)"; break;
Pete Zaitcev38e2bfc2006-09-18 22:49:02 -0700713 case -ETIME: errmsg = "Device does not respond"; break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 }
Luc Saillard2b455db2006-04-24 10:29:46 -0300715 PWC_DEBUG_FLOW("pwc_isoc_handler() called with status %d [%s].\n", urb->status, errmsg);
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300716 /* Give up after a number of contiguous errors on the USB bus.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 Appearantly something is wrong so we simulate an unplug event.
718 */
719 if (++pdev->visoc_errors > MAX_ISOC_ERRORS)
720 {
Luc Saillard2b455db2006-04-24 10:29:46 -0300721 PWC_INFO("Too many ISOC errors, bailing out.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 pdev->error_status = EIO;
723 awake = 1;
724 wake_up_interruptible(&pdev->frameq);
725 }
726 goto handler_end; // ugly, but practical
727 }
728
729 fbuf = pdev->fill_frame;
730 if (fbuf == NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300731 PWC_ERROR("pwc_isoc_handler without valid fill frame.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 awake = 1;
733 goto handler_end;
734 }
735 else {
736 fillptr = fbuf->data + fbuf->filled;
737 }
738
739 /* Reset ISOC error counter. We did get here, after all. */
740 pdev->visoc_errors = 0;
741
742 /* vsync: 0 = don't copy data
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300743 1 = sync-hunt
744 2 = synched
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 */
746 /* Compact data */
747 for (i = 0; i < urb->number_of_packets; i++) {
748 fst = urb->iso_frame_desc[i].status;
749 flen = urb->iso_frame_desc[i].actual_length;
750 iso_buf = urb->transfer_buffer + urb->iso_frame_desc[i].offset;
751 if (fst == 0) {
752 if (flen > 0) { /* if valid data... */
753 if (pdev->vsync > 0) { /* ...and we are not sync-hunting... */
754 pdev->vsync = 2;
755
756 /* ...copy data to frame buffer, if possible */
757 if (flen + fbuf->filled > pdev->frame_total_size) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300758 PWC_DEBUG_FLOW("Frame buffer overflow (flen = %d, frame_total_size = %d).\n", flen, pdev->frame_total_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 pdev->vsync = 0; /* Hmm, let's wait for an EOF (end-of-frame) */
760 pdev->vframes_error++;
761 }
762 else {
763 memmove(fillptr, iso_buf, flen);
764 fillptr += flen;
765 }
766 }
767 fbuf->filled += flen;
768 } /* ..flen > 0 */
769
770 if (flen < pdev->vlast_packet_size) {
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300771 /* Shorter packet... We probably have the end of an image-frame;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 wake up read() process and let select()/poll() do something.
773 Decompression is done in user time over there.
Luc Saillard2b455db2006-04-24 10:29:46 -0300774 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 if (pdev->vsync == 2) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300776 if (pwc_rcv_short_packet(pdev, fbuf)) {
777 awake = 1;
778 fbuf = pdev->fill_frame;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 }
781 fbuf->filled = 0;
782 fillptr = fbuf->data;
783 pdev->vsync = 1;
Luc Saillard2b455db2006-04-24 10:29:46 -0300784 }
785
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 pdev->vlast_packet_size = flen;
787 } /* ..status == 0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 else {
Luc Saillard2b455db2006-04-24 10:29:46 -0300789 /* This is normally not interesting to the user, unless
790 * you are really debugging something */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 static int iso_error = 0;
792 iso_error++;
793 if (iso_error < 20)
Luc Saillard2b455db2006-04-24 10:29:46 -0300794 PWC_DEBUG_FLOW("Iso frame %d of USB has error %d\n", i, fst);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 }
797
798handler_end:
799 if (awake)
800 wake_up_interruptible(&pdev->frameq);
801
802 urb->dev = pdev->udev;
803 i = usb_submit_urb(urb, GFP_ATOMIC);
804 if (i != 0)
Luc Saillard2b455db2006-04-24 10:29:46 -0300805 PWC_ERROR("Error (%d) re-submitting urb in pwc_isoc_handler.\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806}
807
808
Luc Saillard2b455db2006-04-24 10:29:46 -0300809int pwc_isoc_init(struct pwc_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810{
811 struct usb_device *udev;
812 struct urb *urb;
813 int i, j, ret;
814
815 struct usb_interface *intf;
816 struct usb_host_interface *idesc = NULL;
817
818 if (pdev == NULL)
819 return -EFAULT;
820 if (pdev->iso_init)
821 return 0;
822 pdev->vsync = 0;
823 udev = pdev->udev;
824
825 /* Get the current alternate interface, adjust packet size */
826 if (!udev->actconfig)
827 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 intf = usb_ifnum_to_if(udev, 0);
829 if (intf)
830 idesc = usb_altnum_to_altsetting(intf, pdev->valternate);
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300831
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 if (!idesc)
833 return -EFAULT;
834
835 /* Search video endpoint */
836 pdev->vmax_packet_size = -1;
Luc Saillard2b455db2006-04-24 10:29:46 -0300837 for (i = 0; i < idesc->desc.bNumEndpoints; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 if ((idesc->endpoint[i].desc.bEndpointAddress & 0xF) == pdev->vendpoint) {
839 pdev->vmax_packet_size = le16_to_cpu(idesc->endpoint[i].desc.wMaxPacketSize);
840 break;
841 }
Luc Saillard2b455db2006-04-24 10:29:46 -0300842 }
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300843
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 if (pdev->vmax_packet_size < 0 || pdev->vmax_packet_size > ISO_MAX_FRAME_SIZE) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300845 PWC_ERROR("Failed to find packet size for video endpoint in current alternate setting.\n");
Steven Cole093cf722005-05-03 19:07:24 -0600846 return -ENFILE; /* Odd error, that should be noticeable */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 }
848
849 /* Set alternate interface */
850 ret = 0;
Luc Saillard2b455db2006-04-24 10:29:46 -0300851 PWC_DEBUG_OPEN("Setting alternate interface %d\n", pdev->valternate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 ret = usb_set_interface(pdev->udev, 0, pdev->valternate);
853 if (ret < 0)
854 return ret;
855
856 for (i = 0; i < MAX_ISO_BUFS; i++) {
857 urb = usb_alloc_urb(ISO_FRAMES_PER_DESC, GFP_KERNEL);
858 if (urb == NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300859 PWC_ERROR("Failed to allocate urb %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 ret = -ENOMEM;
861 break;
862 }
863 pdev->sbuf[i].urb = urb;
Luc Saillard2b455db2006-04-24 10:29:46 -0300864 PWC_DEBUG_MEMORY("Allocated URB at 0x%p\n", urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 }
866 if (ret) {
867 /* De-allocate in reverse order */
Mariusz Kozlowski444f4f92006-11-16 16:38:57 +0100868 while (i--) {
Mariusz Kozlowski90b26252006-11-08 15:34:55 +0100869 usb_free_urb(pdev->sbuf[i].urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 pdev->sbuf[i].urb = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 }
872 return ret;
873 }
874
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300875 /* init URB structure */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 for (i = 0; i < MAX_ISO_BUFS; i++) {
877 urb = pdev->sbuf[i].urb;
878
879 urb->interval = 1; // devik
880 urb->dev = udev;
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300881 urb->pipe = usb_rcvisocpipe(udev, pdev->vendpoint);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 urb->transfer_flags = URB_ISO_ASAP;
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300883 urb->transfer_buffer = pdev->sbuf[i].data;
884 urb->transfer_buffer_length = ISO_BUFFER_SIZE;
885 urb->complete = pwc_isoc_handler;
886 urb->context = pdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 urb->start_frame = 0;
888 urb->number_of_packets = ISO_FRAMES_PER_DESC;
889 for (j = 0; j < ISO_FRAMES_PER_DESC; j++) {
890 urb->iso_frame_desc[j].offset = j * ISO_MAX_FRAME_SIZE;
891 urb->iso_frame_desc[j].length = pdev->vmax_packet_size;
892 }
893 }
894
895 /* link */
896 for (i = 0; i < MAX_ISO_BUFS; i++) {
897 ret = usb_submit_urb(pdev->sbuf[i].urb, GFP_KERNEL);
898 if (ret)
Luc Saillard2b455db2006-04-24 10:29:46 -0300899 PWC_ERROR("isoc_init() submit_urb %d failed with error %d\n", i, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 else
Luc Saillard2b455db2006-04-24 10:29:46 -0300901 PWC_DEBUG_MEMORY("URB 0x%p submitted.\n", pdev->sbuf[i].urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 }
903
904 /* All is done... */
905 pdev->iso_init = 1;
Luc Saillard2b455db2006-04-24 10:29:46 -0300906 PWC_DEBUG_OPEN("<< pwc_isoc_init()\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 return 0;
908}
909
Oliver Neukum0b67f5c2007-09-26 10:19:01 -0300910static void pwc_iso_stop(struct pwc_device *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911{
912 int i;
913
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 /* Unlinking ISOC buffers one by one */
915 for (i = 0; i < MAX_ISO_BUFS; i++) {
916 struct urb *urb;
917
918 urb = pdev->sbuf[i].urb;
919 if (urb != 0) {
Oliver Neukum0b67f5c2007-09-26 10:19:01 -0300920 PWC_DEBUG_MEMORY("Unlinking URB %p\n", urb);
921 usb_kill_urb(urb);
922 }
923 }
924}
925
926static void pwc_iso_free(struct pwc_device *pdev)
927{
928 int i;
929
930 /* Freeing ISOC buffers one by one */
931 for (i = 0; i < MAX_ISO_BUFS; i++) {
932 struct urb *urb;
933
934 urb = pdev->sbuf[i].urb;
935 if (urb != 0) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300936 PWC_DEBUG_MEMORY("Freeing URB\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 usb_free_urb(urb);
938 pdev->sbuf[i].urb = NULL;
939 }
940 }
Oliver Neukum0b67f5c2007-09-26 10:19:01 -0300941}
942
943void pwc_isoc_cleanup(struct pwc_device *pdev)
944{
945 PWC_DEBUG_OPEN(">> pwc_isoc_cleanup()\n");
946 if (pdev == NULL)
947 return;
948 if (pdev->iso_init == 0)
949 return;
950
951 pwc_iso_stop(pdev);
952 pwc_iso_free(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953
954 /* Stop camera, but only if we are sure the camera is still there (unplug
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300955 is signalled by EPIPE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 */
957 if (pdev->error_status && pdev->error_status != EPIPE) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300958 PWC_DEBUG_OPEN("Setting alternate interface 0.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 usb_set_interface(pdev->udev, 0, 0);
960 }
961
962 pdev->iso_init = 0;
Luc Saillard2b455db2006-04-24 10:29:46 -0300963 PWC_DEBUG_OPEN("<< pwc_isoc_cleanup()\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964}
965
966int pwc_try_video_mode(struct pwc_device *pdev, int width, int height, int new_fps, int new_compression, int new_snapshot)
967{
968 int ret, start;
969
970 /* Stop isoc stuff */
971 pwc_isoc_cleanup(pdev);
972 /* Reset parameters */
973 pwc_reset_buffers(pdev);
974 /* Try to set video mode... */
975 start = ret = pwc_set_video_mode(pdev, width, height, new_fps, new_compression, new_snapshot);
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -0300976 if (ret) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300977 PWC_DEBUG_FLOW("pwc_set_video_mode attempt 1 failed.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 /* That failed... restore old mode (we know that worked) */
979 start = pwc_set_video_mode(pdev, pdev->view.x, pdev->view.y, pdev->vframes, pdev->vcompression, pdev->vsnapshot);
980 if (start) {
Luc Saillard2b455db2006-04-24 10:29:46 -0300981 PWC_DEBUG_FLOW("pwc_set_video_mode attempt 2 failed.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 }
983 }
984 if (start == 0)
985 {
986 if (pwc_isoc_init(pdev) < 0)
987 {
Luc Saillard2b455db2006-04-24 10:29:46 -0300988 PWC_WARNING("Failed to restart ISOC transfers in pwc_try_video_mode.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 ret = -EAGAIN; /* let's try again, who knows if it works a second time */
990 }
991 }
992 pdev->drop_frames++; /* try to avoid garbage during switch */
993 return ret; /* Return original error code */
994}
995
Luc Saillard2b455db2006-04-24 10:29:46 -0300996/*********
997 * sysfs
998 *********/
999static struct pwc_device *cd_to_pwc(struct class_device *cd)
1000{
1001 struct video_device *vdev = to_video_device(cd);
1002 return video_get_drvdata(vdev);
1003}
1004
1005static ssize_t show_pan_tilt(struct class_device *class_dev, char *buf)
1006{
1007 struct pwc_device *pdev = cd_to_pwc(class_dev);
1008 return sprintf(buf, "%d %d\n", pdev->pan_angle, pdev->tilt_angle);
1009}
1010
1011static ssize_t store_pan_tilt(struct class_device *class_dev, const char *buf,
1012 size_t count)
1013{
1014 struct pwc_device *pdev = cd_to_pwc(class_dev);
1015 int pan, tilt;
1016 int ret = -EINVAL;
1017
1018 if (strncmp(buf, "reset", 5) == 0)
1019 ret = pwc_mpt_reset(pdev, 0x3);
1020
1021 else if (sscanf(buf, "%d %d", &pan, &tilt) > 0)
1022 ret = pwc_mpt_set_angle(pdev, pan, tilt);
1023
1024 if (ret < 0)
1025 return ret;
1026 return strlen(buf);
1027}
1028static CLASS_DEVICE_ATTR(pan_tilt, S_IRUGO | S_IWUSR, show_pan_tilt,
1029 store_pan_tilt);
1030
1031static ssize_t show_snapshot_button_status(struct class_device *class_dev, char *buf)
1032{
1033 struct pwc_device *pdev = cd_to_pwc(class_dev);
1034 int status = pdev->snapshot_button_status;
1035 pdev->snapshot_button_status = 0;
1036 return sprintf(buf, "%d\n", status);
1037}
1038
1039static CLASS_DEVICE_ATTR(button, S_IRUGO | S_IWUSR, show_snapshot_button_status,
1040 NULL);
1041
Jeff Garzikc12e3be2006-10-13 07:17:32 -03001042static int pwc_create_sysfs_files(struct video_device *vdev)
Luc Saillard2b455db2006-04-24 10:29:46 -03001043{
1044 struct pwc_device *pdev = video_get_drvdata(vdev);
Jeff Garzikc12e3be2006-10-13 07:17:32 -03001045 int rc;
1046
1047 rc = video_device_create_file(vdev, &class_device_attr_button);
1048 if (rc)
1049 goto err;
1050 if (pdev->features & FEATURE_MOTOR_PANTILT) {
1051 rc = video_device_create_file(vdev,&class_device_attr_pan_tilt);
1052 if (rc) goto err_button;
1053 }
1054
1055 return 0;
1056
1057err_button:
1058 video_device_remove_file(vdev, &class_device_attr_button);
1059err:
1060 return rc;
Luc Saillard2b455db2006-04-24 10:29:46 -03001061}
1062
1063static void pwc_remove_sysfs_files(struct video_device *vdev)
1064{
1065 struct pwc_device *pdev = video_get_drvdata(vdev);
1066 if (pdev->features & FEATURE_MOTOR_PANTILT)
1067 video_device_remove_file(vdev, &class_device_attr_pan_tilt);
1068 video_device_remove_file(vdev, &class_device_attr_button);
1069}
1070
Trent Piepho05ad3902007-01-30 23:26:01 -03001071#ifdef CONFIG_USB_PWC_DEBUG
Luc Saillard2b455db2006-04-24 10:29:46 -03001072static const char *pwc_sensor_type_to_string(unsigned int sensor_type)
1073{
1074 switch(sensor_type) {
1075 case 0x00:
1076 return "Hyundai CMOS sensor";
1077 case 0x20:
1078 return "Sony CCD sensor + TDA8787";
1079 case 0x2E:
1080 return "Sony CCD sensor + Exas 98L59";
1081 case 0x2F:
1082 return "Sony CCD sensor + ADI 9804";
1083 case 0x30:
1084 return "Sharp CCD sensor + TDA8787";
1085 case 0x3E:
1086 return "Sharp CCD sensor + Exas 98L59";
1087 case 0x3F:
1088 return "Sharp CCD sensor + ADI 9804";
1089 case 0x40:
1090 return "UPA 1021 sensor";
1091 case 0x100:
1092 return "VGA sensor";
1093 case 0x101:
1094 return "PAL MR sensor";
1095 default:
Trent Piepho657de3c2006-06-20 00:30:57 -03001096 return "unknown type of sensor";
Luc Saillard2b455db2006-04-24 10:29:46 -03001097 }
1098}
1099#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100
1101/***************************************************************************/
1102/* Video4Linux functions */
1103
1104static int pwc_video_open(struct inode *inode, struct file *file)
1105{
Luc Saillard2b455db2006-04-24 10:29:46 -03001106 int i, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 struct video_device *vdev = video_devdata(file);
1108 struct pwc_device *pdev;
1109
Luc Saillard2b455db2006-04-24 10:29:46 -03001110 PWC_DEBUG_OPEN(">> video_open called(vdev = 0x%p).\n", vdev);
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001111
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 pdev = (struct pwc_device *)vdev->priv;
Eric Sesterhenn5d9a2762006-11-30 05:26:46 +01001113 BUG_ON(!pdev);
Luc Saillard2b455db2006-04-24 10:29:46 -03001114 if (pdev->vopen) {
1115 PWC_DEBUG_OPEN("I'm busy, someone is using the device.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 return -EBUSY;
Luc Saillard2b455db2006-04-24 10:29:46 -03001117 }
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001118
Matthias Kaehlckeb9378fd2007-07-02 10:04:52 -03001119 mutex_lock(&pdev->modlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 if (!pdev->usb_init) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001121 PWC_DEBUG_OPEN("Doing first time initialization.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 pdev->usb_init = 1;
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001123
Luc Saillard2b455db2006-04-24 10:29:46 -03001124 /* Query sensor type */
1125 ret = pwc_get_cmos_sensor(pdev, &i);
1126 if (ret >= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 {
Luc Saillard2b455db2006-04-24 10:29:46 -03001128 PWC_DEBUG_OPEN("This %s camera is equipped with a %s (%d).\n",
1129 pdev->vdev->name,
1130 pwc_sensor_type_to_string(i), i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 }
1132 }
1133
1134 /* Turn on camera */
1135 if (power_save) {
1136 i = pwc_camera_power(pdev, 1);
1137 if (i < 0)
Luc Saillard2b455db2006-04-24 10:29:46 -03001138 PWC_DEBUG_OPEN("Failed to restore power to the camera! (%d)\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 }
1140 /* Set LED on/off time */
1141 if (pwc_set_leds(pdev, led_on, led_off) < 0)
Luc Saillard2b455db2006-04-24 10:29:46 -03001142 PWC_DEBUG_OPEN("Failed to set LED on/off time.\n");
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001143
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 pwc_construct(pdev); /* set min/max sizes correct */
1145
1146 /* So far, so good. Allocate memory. */
1147 i = pwc_allocate_buffers(pdev);
1148 if (i < 0) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001149 PWC_DEBUG_OPEN("Failed to allocate buffers memory.\n");
1150 pwc_free_buffers(pdev);
Matthias Kaehlckeb9378fd2007-07-02 10:04:52 -03001151 mutex_unlock(&pdev->modlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 return i;
1153 }
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001154
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 /* Reset buffers & parameters */
1156 pwc_reset_buffers(pdev);
Luc Saillard2b455db2006-04-24 10:29:46 -03001157 for (i = 0; i < pwc_mbufs; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 pdev->image_used[i] = 0;
1159 pdev->vframe_count = 0;
1160 pdev->vframes_dumped = 0;
1161 pdev->vframes_error = 0;
1162 pdev->visoc_errors = 0;
1163 pdev->error_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 pwc_construct(pdev); /* set min/max sizes correct */
1165
1166 /* Set some defaults */
1167 pdev->vsnapshot = 0;
1168
1169 /* Start iso pipe for video; first try the last used video size
1170 (or the default one); if that fails try QCIF/10 or QSIF/10;
1171 it that fails too, give up.
1172 */
1173 i = pwc_set_video_mode(pdev, pwc_image_sizes[pdev->vsize].x, pwc_image_sizes[pdev->vsize].y, pdev->vframes, pdev->vcompression, 0);
1174 if (i) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001175 unsigned int default_resolution;
1176 PWC_DEBUG_OPEN("First attempt at set_video_mode failed.\n");
1177 if (pdev->type>= 730)
1178 default_resolution = PSZ_QSIF;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 else
Luc Saillard2b455db2006-04-24 10:29:46 -03001180 default_resolution = PSZ_QCIF;
1181
1182 i = pwc_set_video_mode(pdev,
1183 pwc_image_sizes[default_resolution].x,
1184 pwc_image_sizes[default_resolution].y,
1185 10,
1186 pdev->vcompression,
1187 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 }
1189 if (i) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001190 PWC_DEBUG_OPEN("Second attempt at set_video_mode failed.\n");
1191 pwc_free_buffers(pdev);
Matthias Kaehlckeb9378fd2007-07-02 10:04:52 -03001192 mutex_unlock(&pdev->modlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 return i;
1194 }
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001195
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 i = pwc_isoc_init(pdev);
1197 if (i) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001198 PWC_DEBUG_OPEN("Failed to init ISOC stuff = %d.\n", i);
1199 pwc_isoc_cleanup(pdev);
1200 pwc_free_buffers(pdev);
Matthias Kaehlckeb9378fd2007-07-02 10:04:52 -03001201 mutex_unlock(&pdev->modlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 return i;
1203 }
1204
Luc Saillard2b455db2006-04-24 10:29:46 -03001205 /* Initialize the webcam to sane value */
1206 pwc_set_brightness(pdev, 0x7fff);
1207 pwc_set_agc(pdev, 1, 0);
1208
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 pdev->vopen++;
1210 file->private_data = vdev;
Matthias Kaehlckeb9378fd2007-07-02 10:04:52 -03001211 mutex_unlock(&pdev->modlock);
Luc Saillard2b455db2006-04-24 10:29:46 -03001212 PWC_DEBUG_OPEN("<< video_open() returns 0.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 return 0;
1214}
1215
Oliver Neukum85237f22007-08-21 07:10:42 +02001216
1217static void pwc_cleanup(struct pwc_device *pdev)
1218{
1219 pwc_remove_sysfs_files(pdev->vdev);
1220 video_unregister_device(pdev->vdev);
1221}
1222
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223/* Note that all cleanup is done in the reverse order as in _open */
1224static int pwc_video_close(struct inode *inode, struct file *file)
1225{
1226 struct video_device *vdev = file->private_data;
1227 struct pwc_device *pdev;
Oliver Neukum85237f22007-08-21 07:10:42 +02001228 int i, hint;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229
Luc Saillard2b455db2006-04-24 10:29:46 -03001230 PWC_DEBUG_OPEN(">> video_close called(vdev = 0x%p).\n", vdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231
Oliver Neukum0b67f5c2007-09-26 10:19:01 -03001232 lock_kernel();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 pdev = (struct pwc_device *)vdev->priv;
1234 if (pdev->vopen == 0)
Luc Saillard2b455db2006-04-24 10:29:46 -03001235 PWC_DEBUG_MODULE("video_close() called on closed device?\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236
1237 /* Dump statistics, but only if a reasonable amount of frames were
1238 processed (to prevent endless log-entries in case of snap-shot
1239 programs)
1240 */
1241 if (pdev->vframe_count > 20)
Luc Saillard2b455db2006-04-24 10:29:46 -03001242 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243
Luc Saillard2b455db2006-04-24 10:29:46 -03001244 if (DEVICE_USE_CODEC1(pdev->type))
1245 pwc_dec1_exit();
1246 else
1247 pwc_dec23_exit();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248
1249 pwc_isoc_cleanup(pdev);
1250 pwc_free_buffers(pdev);
1251
1252 /* Turn off LEDS and power down camera, but only when not unplugged */
Oliver Neukum85237f22007-08-21 07:10:42 +02001253 if (!pdev->unplugged) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 /* Turn LEDs off */
1255 if (pwc_set_leds(pdev, 0, 0) < 0)
Luc Saillard2b455db2006-04-24 10:29:46 -03001256 PWC_DEBUG_MODULE("Failed to set LED on/off time.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 if (power_save) {
1258 i = pwc_camera_power(pdev, 0);
1259 if (i < 0)
Luc Saillard2b455db2006-04-24 10:29:46 -03001260 PWC_ERROR("Failed to power down camera (%d)\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 }
Oliver Neukum85237f22007-08-21 07:10:42 +02001262 pdev->vopen--;
Jean Delvare7b9fbc32007-09-03 11:51:51 -03001263 PWC_DEBUG_OPEN("<< video_close() vopen=%d\n", pdev->vopen);
Oliver Neukum85237f22007-08-21 07:10:42 +02001264 } else {
1265 pwc_cleanup(pdev);
1266 /* Free memory (don't set pdev to 0 just yet) */
1267 kfree(pdev);
1268 /* search device_hint[] table if we occupy a slot, by any chance */
1269 for (hint = 0; hint < MAX_DEV_HINTS; hint++)
1270 if (device_hint[hint].pdev == pdev)
1271 device_hint[hint].pdev = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 }
Oliver Neukum85237f22007-08-21 07:10:42 +02001273 unlock_kernel();
1274
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 return 0;
1276}
1277
1278/*
1279 * FIXME: what about two parallel reads ????
1280 * ANSWER: Not supported. You can't open the device more than once,
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001281 despite what the V4L1 interface says. First, I don't see
1282 the need, second there's no mechanism of alerting the
1283 2nd/3rd/... process of events like changing image size.
1284 And I don't see the point of blocking that for the
1285 2nd/3rd/... process.
1286 In multi-threaded environments reading parallel from any
1287 device is tricky anyhow.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 */
1289
Luc Saillard2b455db2006-04-24 10:29:46 -03001290static ssize_t pwc_video_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 size_t count, loff_t *ppos)
1292{
1293 struct video_device *vdev = file->private_data;
1294 struct pwc_device *pdev;
1295 int noblock = file->f_flags & O_NONBLOCK;
1296 DECLARE_WAITQUEUE(wait, current);
Oliver Neukum0b67f5c2007-09-26 10:19:01 -03001297 int bytes_to_read, rv = 0;
Luc Saillard2b455db2006-04-24 10:29:46 -03001298 void *image_buffer_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299
Luc Saillard2b455db2006-04-24 10:29:46 -03001300 PWC_DEBUG_READ("pwc_video_read(vdev=0x%p, buf=%p, count=%zd) called.\n",
1301 vdev, buf, count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 if (vdev == NULL)
1303 return -EFAULT;
1304 pdev = vdev->priv;
1305 if (pdev == NULL)
1306 return -EFAULT;
Oliver Neukum0b67f5c2007-09-26 10:19:01 -03001307
1308 mutex_lock(&pdev->modlock);
1309 if (pdev->error_status) {
1310 rv = -pdev->error_status; /* Something happened, report what. */
1311 goto err_out;
1312 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313
1314 /* In case we're doing partial reads, we don't have to wait for a frame */
1315 if (pdev->image_read_pos == 0) {
1316 /* Do wait queueing according to the (doc)book */
1317 add_wait_queue(&pdev->frameq, &wait);
1318 while (pdev->full_frames == NULL) {
1319 /* Check for unplugged/etc. here */
1320 if (pdev->error_status) {
1321 remove_wait_queue(&pdev->frameq, &wait);
1322 set_current_state(TASK_RUNNING);
Oliver Neukum0b67f5c2007-09-26 10:19:01 -03001323 rv = -pdev->error_status ;
1324 goto err_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 }
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001326 if (noblock) {
1327 remove_wait_queue(&pdev->frameq, &wait);
1328 set_current_state(TASK_RUNNING);
Oliver Neukum0b67f5c2007-09-26 10:19:01 -03001329 rv = -EWOULDBLOCK;
1330 goto err_out;
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001331 }
1332 if (signal_pending(current)) {
1333 remove_wait_queue(&pdev->frameq, &wait);
1334 set_current_state(TASK_RUNNING);
Oliver Neukum0b67f5c2007-09-26 10:19:01 -03001335 rv = -ERESTARTSYS;
1336 goto err_out;
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001337 }
1338 schedule();
1339 set_current_state(TASK_INTERRUPTIBLE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 }
1341 remove_wait_queue(&pdev->frameq, &wait);
1342 set_current_state(TASK_RUNNING);
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001343
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 /* Decompress and release frame */
Oliver Neukum0b67f5c2007-09-26 10:19:01 -03001345 if (pwc_handle_frame(pdev)) {
1346 rv = -EFAULT;
1347 goto err_out;
1348 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 }
1350
Luc Saillard2b455db2006-04-24 10:29:46 -03001351 PWC_DEBUG_READ("Copying data to user space.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 if (pdev->vpalette == VIDEO_PALETTE_RAW)
Luc Saillard2b455db2006-04-24 10:29:46 -03001353 bytes_to_read = pdev->frame_size + sizeof(struct pwc_raw_frame);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 else
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001355 bytes_to_read = pdev->view.size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356
1357 /* copy bytes to user space; we allow for partial reads */
1358 if (count + pdev->image_read_pos > bytes_to_read)
1359 count = bytes_to_read - pdev->image_read_pos;
Luc Saillard2b455db2006-04-24 10:29:46 -03001360 image_buffer_addr = pdev->image_data;
1361 image_buffer_addr += pdev->images[pdev->fill_image].offset;
1362 image_buffer_addr += pdev->image_read_pos;
Oliver Neukum0b67f5c2007-09-26 10:19:01 -03001363 if (copy_to_user(buf, image_buffer_addr, count)) {
1364 rv = -EFAULT;
1365 goto err_out;
1366 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 pdev->image_read_pos += count;
1368 if (pdev->image_read_pos >= bytes_to_read) { /* All data has been read */
1369 pdev->image_read_pos = 0;
1370 pwc_next_image(pdev);
1371 }
Oliver Neukum0b67f5c2007-09-26 10:19:01 -03001372 mutex_unlock(&pdev->modlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 return count;
Oliver Neukum0b67f5c2007-09-26 10:19:01 -03001374err_out:
1375 mutex_unlock(&pdev->modlock);
1376 return rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377}
1378
1379static unsigned int pwc_video_poll(struct file *file, poll_table *wait)
1380{
1381 struct video_device *vdev = file->private_data;
1382 struct pwc_device *pdev;
1383
1384 if (vdev == NULL)
1385 return -EFAULT;
1386 pdev = vdev->priv;
1387 if (pdev == NULL)
1388 return -EFAULT;
1389
1390 poll_wait(file, &pdev->frameq, wait);
1391 if (pdev->error_status)
1392 return POLLERR;
1393 if (pdev->full_frames != NULL) /* we have frames waiting */
1394 return (POLLIN | POLLRDNORM);
1395
1396 return 0;
1397}
1398
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399static int pwc_video_ioctl(struct inode *inode, struct file *file,
1400 unsigned int cmd, unsigned long arg)
1401{
Oliver Neukum0b67f5c2007-09-26 10:19:01 -03001402 struct video_device *vdev = file->private_data;
1403 struct pwc_device *pdev;
1404 int r = -ENODEV;
1405
1406 if (!vdev)
1407 goto out;
1408 pdev = vdev->priv;
1409
1410 mutex_lock(&pdev->modlock);
1411 if (!pdev->unplugged)
1412 r = video_usercopy(inode, file, cmd, arg, pwc_video_do_ioctl);
1413 mutex_unlock(&pdev->modlock);
1414out:
1415 return r;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416}
1417
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418static int pwc_video_mmap(struct file *file, struct vm_area_struct *vma)
1419{
1420 struct video_device *vdev = file->private_data;
1421 struct pwc_device *pdev;
Luc Saillard2b455db2006-04-24 10:29:46 -03001422 unsigned long start;
1423 unsigned long size;
1424 unsigned long page, pos = 0;
1425 int index;
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001426
Luc Saillard2b455db2006-04-24 10:29:46 -03001427 PWC_DEBUG_MEMORY(">> %s\n", __FUNCTION__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428 pdev = vdev->priv;
Luc Saillard2b455db2006-04-24 10:29:46 -03001429 size = vma->vm_end - vma->vm_start;
1430 start = vma->vm_start;
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001431
Luc Saillard2b455db2006-04-24 10:29:46 -03001432 /* Find the idx buffer for this mapping */
1433 for (index = 0; index < pwc_mbufs; index++) {
1434 pos = pdev->images[index].offset;
1435 if ((pos>>PAGE_SHIFT) == vma->vm_pgoff)
1436 break;
1437 }
1438 if (index == MAX_IMAGES)
1439 return -EINVAL;
1440 if (index == 0) {
1441 /*
1442 * Special case for v4l1. In v4l1, we map only one big buffer,
1443 * but in v4l2 each buffer is mapped
1444 */
1445 unsigned long total_size;
1446 total_size = pwc_mbufs * pdev->len_per_image;
1447 if (size != pdev->len_per_image && size != total_size) {
1448 PWC_ERROR("Wrong size (%lu) needed to be len_per_image=%d or total_size=%lu\n",
1449 size, pdev->len_per_image, total_size);
1450 return -EINVAL;
1451 }
1452 } else if (size > pdev->len_per_image)
1453 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454
Luc Saillard2b455db2006-04-24 10:29:46 -03001455 vma->vm_flags |= VM_IO; /* from 2.6.9-acX */
1456
1457 pos += (unsigned long)pdev->image_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 while (size > 0) {
1459 page = vmalloc_to_pfn((void *)pos);
1460 if (remap_pfn_range(vma, start, page, PAGE_SIZE, PAGE_SHARED))
1461 return -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 start += PAGE_SIZE;
1463 pos += PAGE_SIZE;
1464 if (size > PAGE_SIZE)
1465 size -= PAGE_SIZE;
1466 else
1467 size = 0;
1468 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 return 0;
1470}
1471
1472/***************************************************************************/
1473/* USB functions */
1474
1475/* This function gets called when a new device is plugged in or the usb core
1476 * is loaded.
1477 */
1478
1479static int usb_pwc_probe(struct usb_interface *intf, const struct usb_device_id *id)
1480{
1481 struct usb_device *udev = interface_to_usbdev(intf);
1482 struct pwc_device *pdev = NULL;
1483 int vendor_id, product_id, type_id;
Jeff Garzikc12e3be2006-10-13 07:17:32 -03001484 int i, hint, rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 int features = 0;
1486 int video_nr = -1; /* default: use next available device */
1487 char serial_number[30], *name;
1488
Luc Saillard2b455db2006-04-24 10:29:46 -03001489 vendor_id = le16_to_cpu(udev->descriptor.idVendor);
1490 product_id = le16_to_cpu(udev->descriptor.idProduct);
1491
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 /* Check if we can handle this device */
Luc Saillard2b455db2006-04-24 10:29:46 -03001493 PWC_DEBUG_PROBE("probe() called [%04X %04X], if %d\n",
1494 vendor_id, product_id,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 intf->altsetting->desc.bInterfaceNumber);
1496
1497 /* the interfaces are probed one by one. We are only interested in the
1498 video interface (0) now.
1499 Interface 1 is the Audio Control, and interface 2 Audio itself.
1500 */
1501 if (intf->altsetting->desc.bInterfaceNumber > 0)
1502 return -ENODEV;
1503
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 if (vendor_id == 0x0471) {
1505 switch (product_id) {
1506 case 0x0302:
Luc Saillard2b455db2006-04-24 10:29:46 -03001507 PWC_INFO("Philips PCA645VC USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 name = "Philips 645 webcam";
1509 type_id = 645;
1510 break;
1511 case 0x0303:
Luc Saillard2b455db2006-04-24 10:29:46 -03001512 PWC_INFO("Philips PCA646VC USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 name = "Philips 646 webcam";
1514 type_id = 646;
1515 break;
1516 case 0x0304:
Luc Saillard2b455db2006-04-24 10:29:46 -03001517 PWC_INFO("Askey VC010 type 2 USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 name = "Askey VC010 webcam";
1519 type_id = 646;
1520 break;
1521 case 0x0307:
Luc Saillard2b455db2006-04-24 10:29:46 -03001522 PWC_INFO("Philips PCVC675K (Vesta) USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 name = "Philips 675 webcam";
1524 type_id = 675;
1525 break;
1526 case 0x0308:
Luc Saillard2b455db2006-04-24 10:29:46 -03001527 PWC_INFO("Philips PCVC680K (Vesta Pro) USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 name = "Philips 680 webcam";
1529 type_id = 680;
1530 break;
1531 case 0x030C:
Luc Saillard2b455db2006-04-24 10:29:46 -03001532 PWC_INFO("Philips PCVC690K (Vesta Pro Scan) USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 name = "Philips 690 webcam";
1534 type_id = 690;
1535 break;
1536 case 0x0310:
Luc Saillard2b455db2006-04-24 10:29:46 -03001537 PWC_INFO("Philips PCVC730K (ToUCam Fun)/PCVC830 (ToUCam II) USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538 name = "Philips 730 webcam";
1539 type_id = 730;
1540 break;
1541 case 0x0311:
Luc Saillard2b455db2006-04-24 10:29:46 -03001542 PWC_INFO("Philips PCVC740K (ToUCam Pro)/PCVC840 (ToUCam II) USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 name = "Philips 740 webcam";
1544 type_id = 740;
1545 break;
1546 case 0x0312:
Luc Saillard2b455db2006-04-24 10:29:46 -03001547 PWC_INFO("Philips PCVC750K (ToUCam Pro Scan) USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 name = "Philips 750 webcam";
1549 type_id = 750;
1550 break;
1551 case 0x0313:
Luc Saillard2b455db2006-04-24 10:29:46 -03001552 PWC_INFO("Philips PCVC720K/40 (ToUCam XS) USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 name = "Philips 720K/40 webcam";
1554 type_id = 720;
1555 break;
Luc Saillard2b455db2006-04-24 10:29:46 -03001556 case 0x0329:
1557 PWC_INFO("Philips SPC 900NC USB webcam detected.\n");
1558 name = "Philips SPC 900NC webcam";
Luc Saillard9ee6d782007-04-22 23:54:36 -03001559 type_id = 740;
Luc Saillard2b455db2006-04-24 10:29:46 -03001560 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 default:
1562 return -ENODEV;
1563 break;
1564 }
1565 }
1566 else if (vendor_id == 0x069A) {
1567 switch(product_id) {
1568 case 0x0001:
Luc Saillard2b455db2006-04-24 10:29:46 -03001569 PWC_INFO("Askey VC010 type 1 USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 name = "Askey VC010 webcam";
1571 type_id = 645;
1572 break;
1573 default:
1574 return -ENODEV;
1575 break;
1576 }
1577 }
1578 else if (vendor_id == 0x046d) {
1579 switch(product_id) {
1580 case 0x08b0:
Luc Saillard2b455db2006-04-24 10:29:46 -03001581 PWC_INFO("Logitech QuickCam Pro 3000 USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 name = "Logitech QuickCam Pro 3000";
1583 type_id = 740; /* CCD sensor */
1584 break;
1585 case 0x08b1:
Luc Saillard2b455db2006-04-24 10:29:46 -03001586 PWC_INFO("Logitech QuickCam Notebook Pro USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 name = "Logitech QuickCam Notebook Pro";
1588 type_id = 740; /* CCD sensor */
1589 break;
1590 case 0x08b2:
Luc Saillard2b455db2006-04-24 10:29:46 -03001591 PWC_INFO("Logitech QuickCam 4000 Pro USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 name = "Logitech QuickCam Pro 4000";
1593 type_id = 740; /* CCD sensor */
1594 break;
1595 case 0x08b3:
Luc Saillard2b455db2006-04-24 10:29:46 -03001596 PWC_INFO("Logitech QuickCam Zoom USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 name = "Logitech QuickCam Zoom";
1598 type_id = 740; /* CCD sensor */
1599 break;
1600 case 0x08B4:
Luc Saillard2b455db2006-04-24 10:29:46 -03001601 PWC_INFO("Logitech QuickCam Zoom (new model) USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 name = "Logitech QuickCam Zoom";
1603 type_id = 740; /* CCD sensor */
Luc Saillard2b455db2006-04-24 10:29:46 -03001604 power_save = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 break;
1606 case 0x08b5:
Luc Saillard2b455db2006-04-24 10:29:46 -03001607 PWC_INFO("Logitech QuickCam Orbit/Sphere USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 name = "Logitech QuickCam Orbit";
1609 type_id = 740; /* CCD sensor */
1610 features |= FEATURE_MOTOR_PANTILT;
1611 break;
1612 case 0x08b6:
Jean Tourrilhesa63e1572007-03-21 16:29:16 -03001613 PWC_INFO("Logitech/Cisco VT Camera webcam detected.\n");
1614 name = "Cisco VT Camera";
1615 type_id = 740; /* CCD sensor */
1616 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 case 0x08b7:
Mauro Carvalho Chehab6b1ce3c2007-03-21 16:35:28 -03001618 PWC_INFO("Logitech ViewPort AV 100 webcam detected.\n");
1619 name = "Logitech ViewPort AV 100";
1620 type_id = 740; /* CCD sensor */
1621 break;
1622 case 0x08b8: /* Where this released? */
Luc Saillard2b455db2006-04-24 10:29:46 -03001623 PWC_INFO("Logitech QuickCam detected (reserved ID).\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 name = "Logitech QuickCam (res.)";
1625 type_id = 730; /* Assuming CMOS */
1626 break;
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001627 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 return -ENODEV;
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001629 break;
1630 }
1631 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632 else if (vendor_id == 0x055d) {
1633 /* I don't know the difference between the C10 and the C30;
1634 I suppose the difference is the sensor, but both cameras
1635 work equally well with a type_id of 675
1636 */
1637 switch(product_id) {
1638 case 0x9000:
Luc Saillard2b455db2006-04-24 10:29:46 -03001639 PWC_INFO("Samsung MPC-C10 USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 name = "Samsung MPC-C10";
1641 type_id = 675;
1642 break;
1643 case 0x9001:
Luc Saillard2b455db2006-04-24 10:29:46 -03001644 PWC_INFO("Samsung MPC-C30 USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 name = "Samsung MPC-C30";
1646 type_id = 675;
1647 break;
Luc Saillard2b455db2006-04-24 10:29:46 -03001648 case 0x9002:
1649 PWC_INFO("Samsung SNC-35E (v3.0) USB webcam detected.\n");
1650 name = "Samsung MPC-C30";
1651 type_id = 740;
1652 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 default:
1654 return -ENODEV;
1655 break;
1656 }
1657 }
1658 else if (vendor_id == 0x041e) {
1659 switch(product_id) {
1660 case 0x400c:
Luc Saillard2b455db2006-04-24 10:29:46 -03001661 PWC_INFO("Creative Labs Webcam 5 detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 name = "Creative Labs Webcam 5";
1663 type_id = 730;
1664 break;
1665 case 0x4011:
Luc Saillard2b455db2006-04-24 10:29:46 -03001666 PWC_INFO("Creative Labs Webcam Pro Ex detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 name = "Creative Labs Webcam Pro Ex";
1668 type_id = 740;
1669 break;
1670 default:
1671 return -ENODEV;
1672 break;
1673 }
1674 }
1675 else if (vendor_id == 0x04cc) {
1676 switch(product_id) {
1677 case 0x8116:
Luc Saillard2b455db2006-04-24 10:29:46 -03001678 PWC_INFO("Sotec Afina Eye USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679 name = "Sotec Afina Eye";
1680 type_id = 730;
1681 break;
1682 default:
1683 return -ENODEV;
1684 break;
1685 }
1686 }
1687 else if (vendor_id == 0x06be) {
1688 switch(product_id) {
1689 case 0x8116:
1690 /* This is essentially the same cam as the Sotec Afina Eye */
Luc Saillard2b455db2006-04-24 10:29:46 -03001691 PWC_INFO("AME Co. Afina Eye USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 name = "AME Co. Afina Eye";
1693 type_id = 750;
1694 break;
1695 default:
1696 return -ENODEV;
1697 break;
1698 }
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001699
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 }
1701 else if (vendor_id == 0x0d81) {
1702 switch(product_id) {
1703 case 0x1900:
Luc Saillard2b455db2006-04-24 10:29:46 -03001704 PWC_INFO("Visionite VCS-UC300 USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 name = "Visionite VCS-UC300";
1706 type_id = 740; /* CCD sensor */
1707 break;
1708 case 0x1910:
Luc Saillard2b455db2006-04-24 10:29:46 -03001709 PWC_INFO("Visionite VCS-UM100 USB webcam detected.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710 name = "Visionite VCS-UM100";
1711 type_id = 730; /* CMOS sensor */
1712 break;
1713 default:
1714 return -ENODEV;
1715 break;
1716 }
1717 }
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001718 else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 return -ENODEV; /* Not any of the know types; but the list keeps growing. */
1720
1721 memset(serial_number, 0, 30);
1722 usb_string(udev, udev->descriptor.iSerialNumber, serial_number, 29);
Luc Saillard2b455db2006-04-24 10:29:46 -03001723 PWC_DEBUG_PROBE("Device serial number is %s\n", serial_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724
1725 if (udev->descriptor.bNumConfigurations > 1)
Luc Saillard2b455db2006-04-24 10:29:46 -03001726 PWC_WARNING("Warning: more than 1 configuration available.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727
1728 /* Allocate structure, initialize pointers, mutexes, etc. and link it to the usb_device */
Eric Sesterhenn80b6ca42006-02-27 21:29:43 +01001729 pdev = kzalloc(sizeof(struct pwc_device), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 if (pdev == NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001731 PWC_ERROR("Oops, could not allocate memory for pwc_device.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732 return -ENOMEM;
1733 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 pdev->type = type_id;
1735 pdev->vsize = default_size;
1736 pdev->vframes = default_fps;
1737 strcpy(pdev->serial, serial_number);
1738 pdev->features = features;
1739 if (vendor_id == 0x046D && product_id == 0x08B5)
1740 {
1741 /* Logitech QuickCam Orbit
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001742 The ranges have been determined experimentally; they may differ from cam to cam.
1743 Also, the exact ranges left-right and up-down are different for my cam
1744 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 pdev->angle_range.pan_min = -7000;
1746 pdev->angle_range.pan_max = 7000;
1747 pdev->angle_range.tilt_min = -3000;
1748 pdev->angle_range.tilt_max = 2500;
1749 }
1750
Matthias Kaehlckeb9378fd2007-07-02 10:04:52 -03001751 mutex_init(&pdev->modlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 spin_lock_init(&pdev->ptrlock);
1753
1754 pdev->udev = udev;
1755 init_waitqueue_head(&pdev->frameq);
1756 pdev->vcompression = pwc_preferred_compression;
1757
1758 /* Allocate video_device structure */
1759 pdev->vdev = video_device_alloc();
1760 if (pdev->vdev == 0)
1761 {
Luc Saillard2b455db2006-04-24 10:29:46 -03001762 PWC_ERROR("Err, cannot allocate video_device struture. Failing probe.");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 kfree(pdev);
1764 return -ENOMEM;
1765 }
1766 memcpy(pdev->vdev, &pwc_template, sizeof(pwc_template));
Luc Saillard2b455db2006-04-24 10:29:46 -03001767 pdev->vdev->dev = &(udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 strcpy(pdev->vdev->name, name);
1769 pdev->vdev->owner = THIS_MODULE;
1770 video_set_drvdata(pdev->vdev, pdev);
1771
1772 pdev->release = le16_to_cpu(udev->descriptor.bcdDevice);
Luc Saillard2b455db2006-04-24 10:29:46 -03001773 PWC_DEBUG_PROBE("Release: %04x\n", pdev->release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774
1775 /* Now search device_hint[] table for a match, so we can hint a node number. */
1776 for (hint = 0; hint < MAX_DEV_HINTS; hint++) {
1777 if (((device_hint[hint].type == -1) || (device_hint[hint].type == pdev->type)) &&
1778 (device_hint[hint].pdev == NULL)) {
1779 /* so far, so good... try serial number */
1780 if ((device_hint[hint].serial_number[0] == '*') || !strcmp(device_hint[hint].serial_number, serial_number)) {
Trent Piepho657de3c2006-06-20 00:30:57 -03001781 /* match! */
1782 video_nr = device_hint[hint].device_node;
1783 PWC_DEBUG_PROBE("Found hint, will try to register as /dev/video%d\n", video_nr);
1784 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 }
1786 }
1787 }
1788
1789 pdev->vdev->release = video_device_release;
1790 i = video_register_device(pdev->vdev, VFL_TYPE_GRABBER, video_nr);
1791 if (i < 0) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001792 PWC_ERROR("Failed to register as video device (%d).\n", i);
Jeff Garzikc12e3be2006-10-13 07:17:32 -03001793 rc = i;
1794 goto err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 }
1796 else {
Luc Saillard2b455db2006-04-24 10:29:46 -03001797 PWC_INFO("Registered as /dev/video%d.\n", pdev->vdev->minor & 0x3F);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 }
1799
1800 /* occupy slot */
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001801 if (hint < MAX_DEV_HINTS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 device_hint[hint].pdev = pdev;
1803
Luc Saillard2b455db2006-04-24 10:29:46 -03001804 PWC_DEBUG_PROBE("probe() function returning struct at 0x%p.\n", pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 usb_set_intfdata (intf, pdev);
Jeff Garzikc12e3be2006-10-13 07:17:32 -03001806 rc = pwc_create_sysfs_files(pdev->vdev);
1807 if (rc)
1808 goto err_unreg;
Luc Saillard2b455db2006-04-24 10:29:46 -03001809
1810 /* Set the leds off */
1811 pwc_set_leds(pdev, 0, 0);
1812 pwc_camera_power(pdev, 0);
1813
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 return 0;
Jeff Garzikc12e3be2006-10-13 07:17:32 -03001815
1816err_unreg:
1817 if (hint < MAX_DEV_HINTS)
1818 device_hint[hint].pdev = NULL;
1819 video_unregister_device(pdev->vdev);
1820err:
1821 video_device_release(pdev->vdev); /* Drip... drip... drip... */
1822 kfree(pdev); /* Oops, no memory leaks please */
1823 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824}
1825
1826/* The user janked out the cable... */
1827static void usb_pwc_disconnect(struct usb_interface *intf)
1828{
1829 struct pwc_device *pdev;
1830 int hint;
1831
1832 lock_kernel();
1833 pdev = usb_get_intfdata (intf);
1834 usb_set_intfdata (intf, NULL);
1835 if (pdev == NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001836 PWC_ERROR("pwc_disconnect() Called without private pointer.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 goto disconnect_out;
1838 }
1839 if (pdev->udev == NULL) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001840 PWC_ERROR("pwc_disconnect() already called for %p\n", pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 goto disconnect_out;
1842 }
1843 if (pdev->udev != interface_to_usbdev(intf)) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001844 PWC_ERROR("pwc_disconnect() Woops: pointer mismatch udev/pdev.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 goto disconnect_out;
1846 }
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001847
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848 /* We got unplugged; this is signalled by an EPIPE error code */
1849 if (pdev->vopen) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001850 PWC_INFO("Disconnected while webcam is in use!\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 pdev->error_status = EPIPE;
1852 }
1853
1854 /* Alert waiting processes */
1855 wake_up_interruptible(&pdev->frameq);
1856 /* Wait until device is closed */
Oliver Neukum85237f22007-08-21 07:10:42 +02001857 if(pdev->vopen) {
Oliver Neukum0b67f5c2007-09-26 10:19:01 -03001858 mutex_lock(&pdev->modlock);
Oliver Neukum85237f22007-08-21 07:10:42 +02001859 pdev->unplugged = 1;
Oliver Neukum0b67f5c2007-09-26 10:19:01 -03001860 mutex_unlock(&pdev->modlock);
1861 pwc_iso_stop(pdev);
Oliver Neukum85237f22007-08-21 07:10:42 +02001862 } else {
1863 /* Device is closed, so we can safely unregister it */
1864 PWC_DEBUG_PROBE("Unregistering video device in disconnect().\n");
1865 pwc_cleanup(pdev);
1866 /* Free memory (don't set pdev to 0 just yet) */
1867 kfree(pdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868
1869disconnect_out:
Oliver Neukum85237f22007-08-21 07:10:42 +02001870 /* search device_hint[] table if we occupy a slot, by any chance */
1871 for (hint = 0; hint < MAX_DEV_HINTS; hint++)
1872 if (device_hint[hint].pdev == pdev)
1873 device_hint[hint].pdev = NULL;
1874 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875
1876 unlock_kernel();
1877}
1878
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879/* *grunt* We have to do atoi ourselves :-( */
1880static int pwc_atoi(const char *s)
1881{
1882 int k = 0;
1883
1884 k = 0;
1885 while (*s != '\0' && *s >= '0' && *s <= '9') {
1886 k = 10 * k + (*s - '0');
1887 s++;
1888 }
1889 return k;
1890}
1891
1892
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03001893/*
1894 * Initialization code & module stuff
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895 */
1896
Luc Saillard2b455db2006-04-24 10:29:46 -03001897static char *size;
1898static int fps;
1899static int fbufs;
1900static int mbufs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901static int compression = -1;
1902static int leds[2] = { -1, -1 };
Luc Saillard2b455db2006-04-24 10:29:46 -03001903static int leds_nargs;
1904static char *dev_hint[MAX_DEV_HINTS];
1905static int dev_hint_nargs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906
Luc Saillard2b455db2006-04-24 10:29:46 -03001907module_param(size, charp, 0444);
1908module_param(fps, int, 0444);
1909module_param(fbufs, int, 0444);
1910module_param(mbufs, int, 0444);
Trent Piepho05ad3902007-01-30 23:26:01 -03001911#ifdef CONFIG_USB_PWC_DEBUG
Luc Saillard2b455db2006-04-24 10:29:46 -03001912module_param_named(trace, pwc_trace, int, 0644);
1913#endif
1914module_param(power_save, int, 0444);
1915module_param(compression, int, 0444);
1916module_param_array(leds, int, &leds_nargs, 0444);
1917module_param_array(dev_hint, charp, &dev_hint_nargs, 0444);
1918
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919MODULE_PARM_DESC(size, "Initial image size. One of sqcif, qsif, qcif, sif, cif, vga");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920MODULE_PARM_DESC(fps, "Initial frames per second. Varies with model, useful range 5-30");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921MODULE_PARM_DESC(fbufs, "Number of internal frame buffers to reserve");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922MODULE_PARM_DESC(mbufs, "Number of external (mmap()ed) image buffers");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923MODULE_PARM_DESC(trace, "For debugging purposes");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924MODULE_PARM_DESC(power_save, "Turn power save feature in camera on or off");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925MODULE_PARM_DESC(compression, "Preferred compression quality. Range 0 (uncompressed) to 3 (high compression)");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926MODULE_PARM_DESC(leds, "LED on,off time in milliseconds");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927MODULE_PARM_DESC(dev_hint, "Device node hints");
1928
1929MODULE_DESCRIPTION("Philips & OEM USB webcam driver");
1930MODULE_AUTHOR("Luc Saillard <luc@saillard.org>");
1931MODULE_LICENSE("GPL");
Luc Saillard2b455db2006-04-24 10:29:46 -03001932MODULE_ALIAS("pwcx");
1933MODULE_VERSION( PWC_VERSION );
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934
1935static int __init usb_pwc_init(void)
1936{
1937 int i, sz;
1938 char *sizenames[PSZ_MAX] = { "sqcif", "qsif", "qcif", "sif", "cif", "vga" };
1939
Luc Saillard2b455db2006-04-24 10:29:46 -03001940 PWC_INFO("Philips webcam module version " PWC_VERSION " loaded.\n");
1941 PWC_INFO("Supports Philips PCA645/646, PCVC675/680/690, PCVC720[40]/730/740/750 & PCVC830/840.\n");
1942 PWC_INFO("Also supports the Askey VC010, various Logitech Quickcams, Samsung MPC-C10 and MPC-C30,\n");
1943 PWC_INFO("the Creative WebCam 5 & Pro Ex, SOTEC Afina Eye and Visionite VCS-UC300 and VCS-UM100.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944
1945 if (fps) {
1946 if (fps < 4 || fps > 30) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001947 PWC_ERROR("Framerate out of bounds (4-30).\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 return -EINVAL;
1949 }
1950 default_fps = fps;
Luc Saillard2b455db2006-04-24 10:29:46 -03001951 PWC_DEBUG_MODULE("Default framerate set to %d.\n", default_fps);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 }
1953
Luc Saillard2b455db2006-04-24 10:29:46 -03001954 if (size) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 /* string; try matching with array */
1956 for (sz = 0; sz < PSZ_MAX; sz++) {
1957 if (!strcmp(sizenames[sz], size)) { /* Found! */
1958 default_size = sz;
1959 break;
1960 }
1961 }
1962 if (sz == PSZ_MAX) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001963 PWC_ERROR("Size not recognized; try size=[sqcif | qsif | qcif | sif | cif | vga].\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 return -EINVAL;
1965 }
Luc Saillard2b455db2006-04-24 10:29:46 -03001966 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 }
1968 if (mbufs) {
1969 if (mbufs < 1 || mbufs > MAX_IMAGES) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001970 PWC_ERROR("Illegal number of mmap() buffers; use a number between 1 and %d.\n", MAX_IMAGES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 return -EINVAL;
1972 }
Luc Saillard2b455db2006-04-24 10:29:46 -03001973 pwc_mbufs = mbufs;
1974 PWC_DEBUG_MODULE("Number of image buffers set to %d.\n", pwc_mbufs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 }
1976 if (fbufs) {
1977 if (fbufs < 2 || fbufs > MAX_FRAMES) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001978 PWC_ERROR("Illegal number of frame buffers; use a number between 2 and %d.\n", MAX_FRAMES);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979 return -EINVAL;
1980 }
1981 default_fbufs = fbufs;
Luc Saillard2b455db2006-04-24 10:29:46 -03001982 PWC_DEBUG_MODULE("Number of frame buffers set to %d.\n", default_fbufs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983 }
Trent Piepho05ad3902007-01-30 23:26:01 -03001984#ifdef CONFIG_USB_PWC_DEBUG
Luc Saillard2b455db2006-04-24 10:29:46 -03001985 if (pwc_trace >= 0) {
1986 PWC_DEBUG_MODULE("Trace options: 0x%04x\n", pwc_trace);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987 }
Luc Saillard2b455db2006-04-24 10:29:46 -03001988#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 if (compression >= 0) {
1990 if (compression > 3) {
Luc Saillard2b455db2006-04-24 10:29:46 -03001991 PWC_ERROR("Invalid compression setting; use a number between 0 (uncompressed) and 3 (high).\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 return -EINVAL;
1993 }
1994 pwc_preferred_compression = compression;
Luc Saillard2b455db2006-04-24 10:29:46 -03001995 PWC_DEBUG_MODULE("Preferred compression set to %d.\n", pwc_preferred_compression);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996 }
1997 if (power_save)
Luc Saillard2b455db2006-04-24 10:29:46 -03001998 PWC_DEBUG_MODULE("Enabling power save on open/close.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999 if (leds[0] >= 0)
2000 led_on = leds[0];
2001 if (leds[1] >= 0)
2002 led_off = leds[1];
2003
Steven Cole093cf722005-05-03 19:07:24 -06002004 /* Big device node whoopla. Basically, it allows you to assign a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 device node (/dev/videoX) to a camera, based on its type
2006 & serial number. The format is [type[.serialnumber]:]node.
2007
2008 Any camera that isn't matched by these rules gets the next
2009 available free device node.
2010 */
2011 for (i = 0; i < MAX_DEV_HINTS; i++) {
2012 char *s, *colon, *dot;
2013
2014 /* This loop also initializes the array */
2015 device_hint[i].pdev = NULL;
2016 s = dev_hint[i];
2017 if (s != NULL && *s != '\0') {
2018 device_hint[i].type = -1; /* wildcard */
2019 strcpy(device_hint[i].serial_number, "*");
2020
2021 /* parse string: chop at ':' & '/' */
2022 colon = dot = s;
2023 while (*colon != '\0' && *colon != ':')
2024 colon++;
2025 while (*dot != '\0' && *dot != '.')
2026 dot++;
2027 /* Few sanity checks */
2028 if (*dot != '\0' && dot > colon) {
Luc Saillard2b455db2006-04-24 10:29:46 -03002029 PWC_ERROR("Malformed camera hint: the colon must be after the dot.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 return -EINVAL;
2031 }
2032
2033 if (*colon == '\0') {
2034 /* No colon */
2035 if (*dot != '\0') {
Luc Saillard2b455db2006-04-24 10:29:46 -03002036 PWC_ERROR("Malformed camera hint: no colon + device node given.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 return -EINVAL;
2038 }
2039 else {
2040 /* No type or serial number specified, just a number. */
2041 device_hint[i].device_node = pwc_atoi(s);
2042 }
2043 }
2044 else {
2045 /* There's a colon, so we have at least a type and a device node */
2046 device_hint[i].type = pwc_atoi(s);
2047 device_hint[i].device_node = pwc_atoi(colon + 1);
2048 if (*dot != '\0') {
2049 /* There's a serial number as well */
2050 int k;
Mauro Carvalho Chehabd56410e2006-03-25 09:19:53 -03002051
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052 dot++;
2053 k = 0;
2054 while (*dot != ':' && k < 29) {
2055 device_hint[i].serial_number[k++] = *dot;
2056 dot++;
2057 }
2058 device_hint[i].serial_number[k] = '\0';
2059 }
2060 }
Luc Saillard2b455db2006-04-24 10:29:46 -03002061 PWC_TRACE("device_hint[%d]:\n", i);
2062 PWC_TRACE(" type : %d\n", device_hint[i].type);
2063 PWC_TRACE(" serial# : %s\n", device_hint[i].serial_number);
2064 PWC_TRACE(" node : %d\n", device_hint[i].device_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065 }
2066 else
2067 device_hint[i].type = 0; /* not filled */
2068 } /* ..for MAX_DEV_HINTS */
2069
Luc Saillard2b455db2006-04-24 10:29:46 -03002070 PWC_DEBUG_PROBE("Registering driver at address 0x%p.\n", &pwc_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 return usb_register(&pwc_driver);
2072}
2073
2074static void __exit usb_pwc_exit(void)
2075{
Luc Saillard2b455db2006-04-24 10:29:46 -03002076 PWC_DEBUG_MODULE("Deregistering driver.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 usb_deregister(&pwc_driver);
Luc Saillard2b455db2006-04-24 10:29:46 -03002078 PWC_INFO("Philips webcam module removed.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079}
2080
2081module_init(usb_pwc_init);
2082module_exit(usb_pwc_exit);
2083
Luc Saillard2b455db2006-04-24 10:29:46 -03002084/* vim: set cino= formatoptions=croql cindent shiftwidth=8 tabstop=8: */