pwc-if.c 59.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3
/* Linux driver for Philips webcam
   USB and Video4Linux interface part.
   (C) 1999-2004 Nemosoft Unv.
4
   (C) 2004-2006 Luc Saillard (luc@saillard.org)
L
Linus Torvalds 已提交
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

   NOTE: this version of pwc is an unofficial (modified) release of pwc & pcwx
   driver and thus may have bugs that are not present in the original version.
   Please send bug reports and support requests to <luc@saillard.org>.
   The decompression routines have been implemented by reverse-engineering the
   Nemosoft binary pwcx module. Caveat emptor.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*/

28
/*
L
Linus Torvalds 已提交
29 30 31
   This code forms the interface between the USB layers and the Philips
   specific stuff. Some adanved stuff of the driver falls under an
   NDA, signed between me and Philips B.V., Eindhoven, the Netherlands, and
32
   is thus not distributed in source form. The binary pwcx.o module
L
Linus Torvalds 已提交
33
   contains the code that falls under the NDA.
34 35

   In case you're wondering: 'pwc' stands for "Philips WebCam", but
L
Linus Torvalds 已提交
36 37 38
   I really didn't want to type 'philips_web_cam' every time (I'm lazy as
   any Linux kernel hacker, but I don't like uncomprehensible abbreviations
   without explanation).
39

L
Linus Torvalds 已提交
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
   Oh yes, convention: to disctinguish between all the various pointers to
   device-structures, I use these names for the pointer variables:
   udev: struct usb_device *
   vdev: struct video_device *
   pdev: struct pwc_devive *
*/

/* Contributors:
   - Alvarado: adding whitebalance code
   - Alistar Moire: QuickCam 3000 Pro device/product ID
   - Tony Hoyle: Creative Labs Webcam 5 device/product ID
   - Mark Burazin: solving hang in VIDIOCSYNC when camera gets unplugged
   - Jk Fang: Sotec Afina Eye ID
   - Xavier Roche: QuickCam Pro 4000 ID
   - Jens Knudsen: QuickCam Zoom ID
   - J. Debert: QuickCam for Notebooks ID
56
   - Pham Thanh Nam: webcam snapshot button as an event input device
L
Linus Torvalds 已提交
57 58 59 60 61 62 63 64
*/

#include <linux/errno.h>
#include <linux/init.h>
#include <linux/mm.h>
#include <linux/module.h>
#include <linux/poll.h>
#include <linux/slab.h>
65 66 67
#ifdef CONFIG_USB_PWC_INPUT_EVDEV
#include <linux/usb/input.h>
#endif
L
Linus Torvalds 已提交
68 69
#include <linux/vmalloc.h>
#include <asm/io.h>
70
#include <linux/kernel.h>		/* simple_strtol() */
L
Linus Torvalds 已提交
71 72 73 74

#include "pwc.h"
#include "pwc-kiara.h"
#include "pwc-timon.h"
75 76
#include "pwc-dec23.h"
#include "pwc-dec1.h"
L
Linus Torvalds 已提交
77 78 79 80 81
#include "pwc-uncompress.h"

/* Function prototypes and driver templates */

/* hotplug device table support */
82
static const struct usb_device_id pwc_device_table [] = {
L
Linus Torvalds 已提交
83 84 85 86 87 88 89
	{ USB_DEVICE(0x0471, 0x0302) }, /* Philips models */
	{ USB_DEVICE(0x0471, 0x0303) },
	{ USB_DEVICE(0x0471, 0x0304) },
	{ USB_DEVICE(0x0471, 0x0307) },
	{ USB_DEVICE(0x0471, 0x0308) },
	{ USB_DEVICE(0x0471, 0x030C) },
	{ USB_DEVICE(0x0471, 0x0310) },
90
	{ USB_DEVICE(0x0471, 0x0311) }, /* Philips ToUcam PRO II */
L
Linus Torvalds 已提交
91 92
	{ USB_DEVICE(0x0471, 0x0312) },
	{ USB_DEVICE(0x0471, 0x0313) }, /* the 'new' 720K */
93
	{ USB_DEVICE(0x0471, 0x0329) }, /* Philips SPC 900NC PC Camera */
L
Linus Torvalds 已提交
94 95 96 97 98 99 100
	{ USB_DEVICE(0x069A, 0x0001) }, /* Askey */
	{ USB_DEVICE(0x046D, 0x08B0) }, /* Logitech QuickCam Pro 3000 */
	{ USB_DEVICE(0x046D, 0x08B1) }, /* Logitech QuickCam Notebook Pro */
	{ USB_DEVICE(0x046D, 0x08B2) }, /* Logitech QuickCam Pro 4000 */
	{ USB_DEVICE(0x046D, 0x08B3) }, /* Logitech QuickCam Zoom (old model) */
	{ USB_DEVICE(0x046D, 0x08B4) }, /* Logitech QuickCam Zoom (new model) */
	{ USB_DEVICE(0x046D, 0x08B5) }, /* Logitech QuickCam Orbit/Sphere */
101 102
	{ USB_DEVICE(0x046D, 0x08B6) }, /* Cisco VT Camera */
	{ USB_DEVICE(0x046D, 0x08B7) }, /* Logitech ViewPort AV 100 */
L
Linus Torvalds 已提交
103
	{ USB_DEVICE(0x046D, 0x08B8) }, /* Logitech (reserved) */
104 105 106
	{ USB_DEVICE(0x055D, 0x9000) }, /* Samsung MPC-C10 */
	{ USB_DEVICE(0x055D, 0x9001) }, /* Samsung MPC-C30 */
	{ USB_DEVICE(0x055D, 0x9002) },	/* Samsung SNC-35E (Ver3.0) */
L
Linus Torvalds 已提交
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
	{ USB_DEVICE(0x041E, 0x400C) }, /* Creative Webcam 5 */
	{ USB_DEVICE(0x041E, 0x4011) }, /* Creative Webcam Pro Ex */
	{ USB_DEVICE(0x04CC, 0x8116) }, /* Afina Eye */
	{ USB_DEVICE(0x06BE, 0x8116) }, /* new Afina Eye */
	{ USB_DEVICE(0x0d81, 0x1910) }, /* Visionite */
	{ USB_DEVICE(0x0d81, 0x1900) },
	{ }
};
MODULE_DEVICE_TABLE(usb, pwc_device_table);

static int usb_pwc_probe(struct usb_interface *intf, const struct usb_device_id *id);
static void usb_pwc_disconnect(struct usb_interface *intf);

static struct usb_driver pwc_driver = {
	.name =			"Philips webcam",	/* name */
	.id_table =		pwc_device_table,
	.probe =		usb_pwc_probe,		/* probe() */
	.disconnect =		usb_pwc_disconnect,	/* disconnect() */
};

#define MAX_DEV_HINTS	20
#define MAX_ISOC_ERRORS	20

static int default_size = PSZ_QCIF;
static int default_fps = 10;
static int default_fbufs = 3;   /* Default number of frame buffers */
133
	int pwc_mbufs = 2;	/* Default number of mmap() buffers */
134
#ifdef CONFIG_USB_PWC_DEBUG
135
	int pwc_trace = PWC_DEBUG_LEVEL;
136
#endif
137 138
static int power_save;
static int led_on = 100, led_off; /* defaults to LED that is on while in use */
139
static int pwc_preferred_compression = 1; /* 0..3 = uncompressed..high */
L
Linus Torvalds 已提交
140 141 142 143 144 145 146 147 148
static struct {
	int type;
	char serial_number[30];
	int device_node;
	struct pwc_device *pdev;
} device_hint[MAX_DEV_HINTS];

/***/

149 150
static int pwc_video_open(struct file *file);
static int pwc_video_close(struct file *file);
151
static ssize_t pwc_video_read(struct file *file, char __user *buf,
L
Linus Torvalds 已提交
152 153
			  size_t count, loff_t *ppos);
static unsigned int pwc_video_poll(struct file *file, poll_table *wait);
154
static long  pwc_video_ioctl(struct file *file,
L
Linus Torvalds 已提交
155 156 157
			    unsigned int ioctlnr, unsigned long arg);
static int  pwc_video_mmap(struct file *file, struct vm_area_struct *vma);

158
static const struct v4l2_file_operations pwc_fops = {
L
Linus Torvalds 已提交
159 160 161 162 163 164
	.owner =	THIS_MODULE,
	.open =		pwc_video_open,
	.release =     	pwc_video_close,
	.read =		pwc_video_read,
	.poll =		pwc_video_poll,
	.mmap =		pwc_video_mmap,
H
Hans Verkuil 已提交
165
	.unlocked_ioctl = pwc_video_ioctl,
L
Linus Torvalds 已提交
166 167 168 169 170 171 172 173 174 175 176
};
static struct video_device pwc_template = {
	.name =		"Philips Webcam",	/* Filled in later */
	.release =	video_device_release,
	.fops =         &pwc_fops,
};

/***************************************************************************/

/* Okay, this is some magic that I worked out and the reasoning behind it...

177
   The biggest problem with any USB device is of course: "what to do
L
Linus Torvalds 已提交
178 179 180 181 182 183
   when the user unplugs the device while it is in use by an application?"
   We have several options:
   1) Curse them with the 7 plagues when they do (requires divine intervention)
   2) Tell them not to (won't work: they'll do it anyway)
   3) Oops the kernel (this will have a negative effect on a user's uptime)
   4) Do something sensible.
184

L
Linus Torvalds 已提交
185 186 187 188 189 190 191
   Of course, we go for option 4.

   It happens that this device will be linked to two times, once from
   usb_device and once from the video_device in their respective 'private'
   pointers. This is done when the device is probed() and all initialization
   succeeded. The pwc_device struct links back to both structures.

192 193
   When a device is unplugged while in use it will be removed from the
   list of known USB devices; I also de-register it as a V4L device, but
L
Linus Torvalds 已提交
194 195 196
   unfortunately I can't free the memory since the struct is still in use
   by the file descriptor. This free-ing is then deferend until the first
   opportunity. Crude, but it works.
197

L
Linus Torvalds 已提交
198 199
   A small 'advantage' is that if a user unplugs the cam and plugs it back
   in, it should get assigned the same video device minor, but unfortunately
200
   it's non-trivial to re-link the cam back to the video device... (that
L
Linus Torvalds 已提交
201 202 203 204 205 206 207 208 209 210 211
   would surely be magic! :))
*/

/***************************************************************************/
/* Private functions */

/* Here we want the physical address of the memory.
 * This is used when initializing the contents of the area.
 */


212 213

static void *pwc_rvmalloc(unsigned long size)
L
Linus Torvalds 已提交
214 215 216 217
{
	void * mem;
	unsigned long adr;

218
	mem=vmalloc_32(size);
219 220 221 222 223 224 225 226 227 228 229
	if (!mem)
		return NULL;

	memset(mem, 0, size); /* Clear the ram out, no junk to the user */
	adr=(unsigned long) mem;
	while (size > 0)
	 {
	   SetPageReserved(vmalloc_to_page((void *)adr));
	   adr  += PAGE_SIZE;
	   size -= PAGE_SIZE;
	 }
L
Linus Torvalds 已提交
230 231 232
	return mem;
}

233
static void pwc_rvfree(void * mem, unsigned long size)
L
Linus Torvalds 已提交
234
{
235
	unsigned long adr;
L
Linus Torvalds 已提交
236

237 238 239 240 241 242 243 244 245 246 247
	if (!mem)
		return;

	adr=(unsigned long) mem;
	while ((long) size > 0)
	 {
	   ClearPageReserved(vmalloc_to_page((void *)adr));
	   adr  += PAGE_SIZE;
	   size -= PAGE_SIZE;
	 }
	vfree(mem);
L
Linus Torvalds 已提交
248 249 250 251 252 253 254
}




static int pwc_allocate_buffers(struct pwc_device *pdev)
{
255
	int i, err;
L
Linus Torvalds 已提交
256 257
	void *kbuf;

258
	PWC_DEBUG_MEMORY(">> pwc_allocate_buffers(pdev = 0x%p)\n", pdev);
L
Linus Torvalds 已提交
259 260 261

	if (pdev == NULL)
		return -ENXIO;
262

263
	/* Allocate Isochronuous pipe buffers */
L
Linus Torvalds 已提交
264 265
	for (i = 0; i < MAX_ISO_BUFS; i++) {
		if (pdev->sbuf[i].data == NULL) {
266
			kbuf = kzalloc(ISO_BUFFER_SIZE, GFP_KERNEL);
L
Linus Torvalds 已提交
267
			if (kbuf == NULL) {
268
				PWC_ERROR("Failed to allocate iso buffer %d.\n", i);
L
Linus Torvalds 已提交
269 270
				return -ENOMEM;
			}
271
			PWC_DEBUG_MEMORY("Allocated iso buffer at %p.\n", kbuf);
L
Linus Torvalds 已提交
272 273 274 275 276 277
			pdev->sbuf[i].data = kbuf;
		}
	}

	/* Allocate frame buffer structure */
	if (pdev->fbuf == NULL) {
278
		kbuf = kzalloc(default_fbufs * sizeof(struct pwc_frame_buf), GFP_KERNEL);
L
Linus Torvalds 已提交
279
		if (kbuf == NULL) {
280
			PWC_ERROR("Failed to allocate frame buffer structure.\n");
L
Linus Torvalds 已提交
281 282
			return -ENOMEM;
		}
283
		PWC_DEBUG_MEMORY("Allocated frame buffer structure at %p.\n", kbuf);
L
Linus Torvalds 已提交
284 285
		pdev->fbuf = kbuf;
	}
286

L
Linus Torvalds 已提交
287 288 289
	/* create frame buffers, and make circular ring */
	for (i = 0; i < default_fbufs; i++) {
		if (pdev->fbuf[i].data == NULL) {
J
Joe Perches 已提交
290
			kbuf = vzalloc(PWC_FRAME_SIZE); /* need vmalloc since frame buffer > 128K */
L
Linus Torvalds 已提交
291
			if (kbuf == NULL) {
292
				PWC_ERROR("Failed to allocate frame buffer %d.\n", i);
L
Linus Torvalds 已提交
293 294
				return -ENOMEM;
			}
295
			PWC_DEBUG_MEMORY("Allocated frame buffer %d at %p.\n", i, kbuf);
L
Linus Torvalds 已提交
296 297 298
			pdev->fbuf[i].data = kbuf;
		}
	}
299

L
Linus Torvalds 已提交
300
	/* Allocate decompressor table space */
301 302 303 304 305 306 307 308 309
	if (DEVICE_USE_CODEC1(pdev->type))
		err = pwc_dec1_alloc(pdev);
	else
		err = pwc_dec23_alloc(pdev);

	if (err) {
		PWC_ERROR("Failed to allocate decompress table.\n");
		return err;
	}
310

L
Linus Torvalds 已提交
311
	/* Allocate image buffer; double buffer for mmap() */
312
	kbuf = pwc_rvmalloc(pwc_mbufs * pdev->len_per_image);
L
Linus Torvalds 已提交
313
	if (kbuf == NULL) {
314 315
		PWC_ERROR("Failed to allocate image buffer(s). needed (%d)\n",
				pwc_mbufs * pdev->len_per_image);
L
Linus Torvalds 已提交
316 317
		return -ENOMEM;
	}
318
	PWC_DEBUG_MEMORY("Allocated image buffer at %p.\n", kbuf);
L
Linus Torvalds 已提交
319
	pdev->image_data = kbuf;
320 321 322 323 324 325 326
	for (i = 0; i < pwc_mbufs; i++) {
		pdev->images[i].offset = i * pdev->len_per_image;
		pdev->images[i].vma_use_count = 0;
	}
	for (; i < MAX_IMAGES; i++) {
		pdev->images[i].offset = 0;
	}
L
Linus Torvalds 已提交
327 328

	kbuf = NULL;
329

330
	PWC_DEBUG_MEMORY("<< pwc_allocate_buffers()\n");
L
Linus Torvalds 已提交
331 332 333 334 335 336 337
	return 0;
}

static void pwc_free_buffers(struct pwc_device *pdev)
{
	int i;

338
	PWC_DEBUG_MEMORY("Entering free_buffers(%p).\n", pdev);
L
Linus Torvalds 已提交
339 340 341 342 343 344

	if (pdev == NULL)
		return;
	/* Release Iso-pipe buffers */
	for (i = 0; i < MAX_ISO_BUFS; i++)
		if (pdev->sbuf[i].data != NULL) {
345
			PWC_DEBUG_MEMORY("Freeing ISO buffer at %p.\n", pdev->sbuf[i].data);
L
Linus Torvalds 已提交
346 347 348 349 350 351 352 353
			kfree(pdev->sbuf[i].data);
			pdev->sbuf[i].data = NULL;
		}

	/* The same for frame buffers */
	if (pdev->fbuf != NULL) {
		for (i = 0; i < default_fbufs; i++) {
			if (pdev->fbuf[i].data != NULL) {
354
				PWC_DEBUG_MEMORY("Freeing frame buffer %d at %p.\n", i, pdev->fbuf[i].data);
L
Linus Torvalds 已提交
355 356 357 358 359 360 361 362 363 364
				vfree(pdev->fbuf[i].data);
				pdev->fbuf[i].data = NULL;
			}
		}
		kfree(pdev->fbuf);
		pdev->fbuf = NULL;
	}

	/* Intermediate decompression buffer & tables */
	if (pdev->decompress_data != NULL) {
365
		PWC_DEBUG_MEMORY("Freeing decompression buffer at %p.\n", pdev->decompress_data);
L
Linus Torvalds 已提交
366 367 368 369 370 371
		kfree(pdev->decompress_data);
		pdev->decompress_data = NULL;
	}

	/* Release image buffers */
	if (pdev->image_data != NULL) {
372 373
		PWC_DEBUG_MEMORY("Freeing image buffer at %p.\n", pdev->image_data);
		pwc_rvfree(pdev->image_data, pwc_mbufs * pdev->len_per_image);
L
Linus Torvalds 已提交
374 375
	}
	pdev->image_data = NULL;
376

377
	PWC_DEBUG_MEMORY("Leaving free_buffers().\n");
L
Linus Torvalds 已提交
378 379
}

380
/* The frame & image buffer mess.
L
Linus Torvalds 已提交
381 382 383 384 385

   Yes, this is a mess. Well, it used to be simple, but alas...  In this
   module, 3 buffers schemes are used to get the data from the USB bus to
   the user program. The first scheme involves the ISO buffers (called thus
   since they transport ISO data from the USB controller), and not really
386
   interesting. Suffices to say the data from this buffer is quickly
L
Linus Torvalds 已提交
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
   gathered in an interrupt handler (pwc_isoc_handler) and placed into the
   frame buffer.

   The frame buffer is the second scheme, and is the central element here.
   It collects the data from a single frame from the camera (hence, the
   name). Frames are delimited by the USB camera with a short USB packet,
   so that's easy to detect. The frame buffers form a list that is filled
   by the camera+USB controller and drained by the user process through
   either read() or mmap().

   The image buffer is the third scheme, in which frames are decompressed
   and converted into planar format. For mmap() there is more than
   one image buffer available.

   The frame buffers provide the image buffering. In case the user process
   is a bit slow, this introduces lag and some undesired side-effects.
   The problem arises when the frame buffer is full. I used to drop the last
   frame, which makes the data in the queue stale very quickly. But dropping
   the frame at the head of the queue proved to be a litte bit more difficult.
   I tried a circular linked scheme, but this introduced more problems than
   it solved.

   Because filling and draining are completely asynchronous processes, this
   requires some fiddling with pointers and mutexes.

   Eventually, I came up with a system with 2 lists: an 'empty' frame list
   and a 'full' frame list:
     * Initially, all frame buffers but one are on the 'empty' list; the one
       remaining buffer is our initial fill frame.
416 417
     * If a frame is needed for filling, we try to take it from the 'empty'
       list, unless that list is empty, in which case we take the buffer at
L
Linus Torvalds 已提交
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
       the head of the 'full' list.
     * When our fill buffer has been filled, it is appended to the 'full'
       list.
     * If a frame is needed by read() or mmap(), it is taken from the head of
       the 'full' list, handled, and then appended to the 'empty' list. If no
       buffer is present on the 'full' list, we wait.
   The advantage is that the buffer that is currently being decompressed/
   converted, is on neither list, and thus not in our way (any other scheme
   I tried had the problem of old data lingering in the queue).

   Whatever strategy you choose, it always remains a tradeoff: with more
   frame buffers the chances of a missed frame are reduced. On the other
   hand, on slower machines it introduces lag because the queue will
   always be full.
 */

/**
  \brief Find next frame buffer to fill. Take from empty or full list, whichever comes first.
 */
437
static int pwc_next_fill_frame(struct pwc_device *pdev)
L
Linus Torvalds 已提交
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
{
	int ret;
	unsigned long flags;

	ret = 0;
	spin_lock_irqsave(&pdev->ptrlock, flags);
	if (pdev->fill_frame != NULL) {
		/* append to 'full' list */
		if (pdev->full_frames == NULL) {
			pdev->full_frames = pdev->fill_frame;
			pdev->full_frames_tail = pdev->full_frames;
		}
		else {
			pdev->full_frames_tail->next = pdev->fill_frame;
			pdev->full_frames_tail = pdev->fill_frame;
		}
	}
	if (pdev->empty_frames != NULL) {
		/* We have empty frames available. That's easy */
		pdev->fill_frame = pdev->empty_frames;
		pdev->empty_frames = pdev->empty_frames->next;
	}
	else {
		/* Hmm. Take it from the full list */
		/* sanity check */
		if (pdev->full_frames == NULL) {
464
			PWC_ERROR("Neither empty or full frames available!\n");
L
Linus Torvalds 已提交
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
			spin_unlock_irqrestore(&pdev->ptrlock, flags);
			return -EINVAL;
		}
		pdev->fill_frame = pdev->full_frames;
		pdev->full_frames = pdev->full_frames->next;
		ret = 1;
	}
	pdev->fill_frame->next = NULL;
	spin_unlock_irqrestore(&pdev->ptrlock, flags);
	return ret;
}


/**
  \brief Reset all buffers, pointers and lists, except for the image_used[] buffer.

  If the image_used[] buffer is cleared too, mmap()/VIDIOCSYNC will run into trouble.
 */
static void pwc_reset_buffers(struct pwc_device *pdev)
{
	int i;
	unsigned long flags;

488
	PWC_DEBUG_MEMORY(">> %s __enter__\n", __func__);
489

L
Linus Torvalds 已提交
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
	spin_lock_irqsave(&pdev->ptrlock, flags);
	pdev->full_frames = NULL;
	pdev->full_frames_tail = NULL;
	for (i = 0; i < default_fbufs; i++) {
		pdev->fbuf[i].filled = 0;
		if (i > 0)
			pdev->fbuf[i].next = &pdev->fbuf[i - 1];
		else
			pdev->fbuf->next = NULL;
	}
	pdev->empty_frames = &pdev->fbuf[default_fbufs - 1];
	pdev->empty_frames_tail = pdev->fbuf;
	pdev->read_frame = NULL;
	pdev->fill_frame = pdev->empty_frames;
	pdev->empty_frames = pdev->empty_frames->next;

	pdev->image_read_pos = 0;
	pdev->fill_image = 0;
	spin_unlock_irqrestore(&pdev->ptrlock, flags);
509

510
	PWC_DEBUG_MEMORY("<< %s __leaving__\n", __func__);
L
Linus Torvalds 已提交
511 512 513 514 515 516
}


/**
  \brief Do all the handling for getting one frame: get pointer, decompress, advance pointers.
 */
517
int pwc_handle_frame(struct pwc_device *pdev)
L
Linus Torvalds 已提交
518 519 520 521 522 523 524 525 526
{
	int ret = 0;
	unsigned long flags;

	spin_lock_irqsave(&pdev->ptrlock, flags);
	/* First grab our read_frame; this is removed from all lists, so
	   we can release the lock after this without problems */
	if (pdev->read_frame != NULL) {
		/* This can't theoretically happen */
527 528 529 530 531 532 533 534
		PWC_ERROR("Huh? Read frame still in use?\n");
		spin_unlock_irqrestore(&pdev->ptrlock, flags);
		return ret;
	}


	if (pdev->full_frames == NULL) {
		PWC_ERROR("Woops. No frames ready.\n");
L
Linus Torvalds 已提交
535 536
	}
	else {
537 538 539 540 541 542
		pdev->read_frame = pdev->full_frames;
		pdev->full_frames = pdev->full_frames->next;
		pdev->read_frame->next = NULL;
	}

	if (pdev->read_frame != NULL) {
543
		/* Decompression is a lengthy process, so it's outside of the lock.
544 545 546 547 548 549 550 551 552 553 554
		   This gives the isoc_handler the opportunity to fill more frames
		   in the mean time.
		*/
		spin_unlock_irqrestore(&pdev->ptrlock, flags);
		ret = pwc_decompress(pdev);
		spin_lock_irqsave(&pdev->ptrlock, flags);

		/* We're done with read_buffer, tack it to the end of the empty buffer list */
		if (pdev->empty_frames == NULL) {
			pdev->empty_frames = pdev->read_frame;
			pdev->empty_frames_tail = pdev->empty_frames;
L
Linus Torvalds 已提交
555 556
		}
		else {
557 558
			pdev->empty_frames_tail->next = pdev->read_frame;
			pdev->empty_frames_tail = pdev->read_frame;
L
Linus Torvalds 已提交
559
		}
560
		pdev->read_frame = NULL;
L
Linus Torvalds 已提交
561 562 563 564 565 566 567 568
	}
	spin_unlock_irqrestore(&pdev->ptrlock, flags);
	return ret;
}

/**
  \brief Advance pointers of image buffer (after each user request)
*/
569
void pwc_next_image(struct pwc_device *pdev)
L
Linus Torvalds 已提交
570 571
{
	pdev->image_used[pdev->fill_image] = 0;
572
	pdev->fill_image = (pdev->fill_image + 1) % pwc_mbufs;
L
Linus Torvalds 已提交
573 574
}

575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
/**
 * Print debug information when a frame is discarded because all of our buffer
 * is full
 */
static void pwc_frame_dumped(struct pwc_device *pdev)
{
	pdev->vframes_dumped++;
	if (pdev->vframe_count < FRAME_LOWMARK)
		return;

	if (pdev->vframes_dumped < 20)
		PWC_DEBUG_FLOW("Dumping frame %d\n", pdev->vframe_count);
	else if (pdev->vframes_dumped == 20)
		PWC_DEBUG_FLOW("Dumping frame %d (last message)\n",
				pdev->vframe_count);
}

592 593 594 595 596 597 598 599 600 601 602
static void pwc_snapshot_button(struct pwc_device *pdev, int down)
{
	if (down) {
		PWC_TRACE("Snapshot button pressed.\n");
		pdev->snapshot_button_status = 1;
	} else {
		PWC_TRACE("Snapshot button released.\n");
	}

#ifdef CONFIG_USB_PWC_INPUT_EVDEV
	if (pdev->button_dev) {
603
		input_report_key(pdev->button_dev, KEY_CAMERA, down);
604 605 606 607 608
		input_sync(pdev->button_dev);
	}
#endif
}

609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
static int pwc_rcv_short_packet(struct pwc_device *pdev, const struct pwc_frame_buf *fbuf)
{
	int awake = 0;

	/* The ToUCam Fun CMOS sensor causes the firmware to send 2 or 3 bogus
	   frames on the USB wire after an exposure change. This conditition is
	   however detected  in the cam and a bit is set in the header.
	   */
	if (pdev->type == 730) {
		unsigned char *ptr = (unsigned char *)fbuf->data;

		if (ptr[1] == 1 && ptr[0] & 0x10) {
			PWC_TRACE("Hyundai CMOS sensor bug. Dropping frame.\n");
			pdev->drop_frames += 2;
			pdev->vframes_error++;
		}
		if ((ptr[0] ^ pdev->vmirror) & 0x01) {
626
			pwc_snapshot_button(pdev, ptr[0] & 0x01);
627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
		}
		if ((ptr[0] ^ pdev->vmirror) & 0x02) {
			if (ptr[0] & 0x02)
				PWC_TRACE("Image is mirrored.\n");
			else
				PWC_TRACE("Image is normal.\n");
		}
		pdev->vmirror = ptr[0] & 0x03;
		/* Sometimes the trailer of the 730 is still sent as a 4 byte packet
		   after a short frame; this condition is filtered out specifically. A 4 byte
		   frame doesn't make sense anyway.
		   So we get either this sequence:
		   drop_bit set -> 4 byte frame -> short frame -> good frame
		   Or this one:
		   drop_bit set -> short frame -> good frame
		   So we drop either 3 or 2 frames in all!
		   */
		if (fbuf->filled == 4)
			pdev->drop_frames++;
	}
	else if (pdev->type == 740 || pdev->type == 720) {
		unsigned char *ptr = (unsigned char *)fbuf->data;
		if ((ptr[0] ^ pdev->vmirror) & 0x01) {
650
			pwc_snapshot_button(pdev, ptr[0] & 0x01);
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
		}
		pdev->vmirror = ptr[0] & 0x03;
	}

	/* In case we were instructed to drop the frame, do so silently.
	   The buffer pointers are not updated either (but the counters are reset below).
	   */
	if (pdev->drop_frames > 0)
		pdev->drop_frames--;
	else {
		/* Check for underflow first */
		if (fbuf->filled < pdev->frame_total_size) {
			PWC_DEBUG_FLOW("Frame buffer underflow (%d bytes);"
				       " discarded.\n", fbuf->filled);
			pdev->vframes_error++;
		}
		else {
			/* Send only once per EOF */
			awake = 1; /* delay wake_ups */

			/* Find our next frame to fill. This will always succeed, since we
			 * nick a frame from either empty or full list, but if we had to
			 * take it from the full list, it means a frame got dropped.
			 */
			if (pwc_next_fill_frame(pdev))
				pwc_frame_dumped(pdev);

		}
	} /* !drop_frames */
	pdev->vframe_count++;
	return awake;
}
L
Linus Torvalds 已提交
683 684 685 686

/* This gets called for the Isochronous pipe (video). This is done in
 * interrupt time, so it has to be fast, not crash, and not stall. Neat.
 */
687
static void pwc_isoc_handler(struct urb *urb)
L
Linus Torvalds 已提交
688 689 690 691 692 693 694 695 696 697
{
	struct pwc_device *pdev;
	int i, fst, flen;
	int awake;
	struct pwc_frame_buf *fbuf;
	unsigned char *fillptr = NULL, *iso_buf = NULL;

	awake = 0;
	pdev = (struct pwc_device *)urb->context;
	if (pdev == NULL) {
698
		PWC_ERROR("isoc_handler() called with NULL device?!\n");
L
Linus Torvalds 已提交
699 700
		return;
	}
701

L
Linus Torvalds 已提交
702
	if (urb->status == -ENOENT || urb->status == -ECONNRESET) {
703
		PWC_DEBUG_OPEN("URB (%p) unlinked %ssynchronuously.\n", urb, urb->status == -ENOENT ? "" : "a");
L
Linus Torvalds 已提交
704 705 706 707 708 709 710 711 712 713 714 715
		return;
	}
	if (urb->status != -EINPROGRESS && urb->status != 0) {
		const char *errmsg;

		errmsg = "Unknown";
		switch(urb->status) {
			case -ENOSR:		errmsg = "Buffer error (overrun)"; break;
			case -EPIPE:		errmsg = "Stalled (device not responding)"; break;
			case -EOVERFLOW:	errmsg = "Babble (bad cable?)"; break;
			case -EPROTO:		errmsg = "Bit-stuff error (bad cable?)"; break;
			case -EILSEQ:		errmsg = "CRC/Timeout (could be anything)"; break;
716
			case -ETIME:		errmsg = "Device does not respond"; break;
L
Linus Torvalds 已提交
717
		}
718
		PWC_DEBUG_FLOW("pwc_isoc_handler() called with status %d [%s].\n", urb->status, errmsg);
719
		/* Give up after a number of contiguous errors on the USB bus.
L
Linus Torvalds 已提交
720 721 722 723
		   Appearantly something is wrong so we simulate an unplug event.
		 */
		if (++pdev->visoc_errors > MAX_ISOC_ERRORS)
		{
724
			PWC_INFO("Too many ISOC errors, bailing out.\n");
L
Linus Torvalds 已提交
725 726 727 728 729 730 731 732 733
			pdev->error_status = EIO;
			awake = 1;
			wake_up_interruptible(&pdev->frameq);
		}
		goto handler_end; // ugly, but practical
	}

	fbuf = pdev->fill_frame;
	if (fbuf == NULL) {
734
		PWC_ERROR("pwc_isoc_handler without valid fill frame.\n");
L
Linus Torvalds 已提交
735 736 737 738 739 740 741 742 743 744 745
		awake = 1;
		goto handler_end;
	}
	else {
		fillptr = fbuf->data + fbuf->filled;
	}

	/* Reset ISOC error counter. We did get here, after all. */
	pdev->visoc_errors = 0;

	/* vsync: 0 = don't copy data
746 747
		  1 = sync-hunt
		  2 = synched
L
Linus Torvalds 已提交
748 749 750 751 752 753 754 755 756 757 758 759 760
	 */
	/* Compact data */
	for (i = 0; i < urb->number_of_packets; i++) {
		fst  = urb->iso_frame_desc[i].status;
		flen = urb->iso_frame_desc[i].actual_length;
		iso_buf = urb->transfer_buffer + urb->iso_frame_desc[i].offset;
		if (fst == 0) {
			if (flen > 0) { /* if valid data... */
				if (pdev->vsync > 0) { /* ...and we are not sync-hunting... */
					pdev->vsync = 2;

					/* ...copy data to frame buffer, if possible */
					if (flen + fbuf->filled > pdev->frame_total_size) {
761
						PWC_DEBUG_FLOW("Frame buffer overflow (flen = %d, frame_total_size = %d).\n", flen, pdev->frame_total_size);
L
Linus Torvalds 已提交
762 763 764 765 766 767 768 769 770 771 772 773
						pdev->vsync = 0; /* Hmm, let's wait for an EOF (end-of-frame) */
						pdev->vframes_error++;
					}
					else {
						memmove(fillptr, iso_buf, flen);
						fillptr += flen;
					}
				}
				fbuf->filled += flen;
			} /* ..flen > 0 */

			if (flen < pdev->vlast_packet_size) {
774
				/* Shorter packet... We probably have the end of an image-frame;
L
Linus Torvalds 已提交
775 776
				   wake up read() process and let select()/poll() do something.
				   Decompression is done in user time over there.
777
				   */
L
Linus Torvalds 已提交
778
				if (pdev->vsync == 2) {
779 780 781
					if (pwc_rcv_short_packet(pdev, fbuf)) {
						awake = 1;
						fbuf = pdev->fill_frame;
L
Linus Torvalds 已提交
782 783 784 785 786
					}
				}
				fbuf->filled = 0;
				fillptr = fbuf->data;
				pdev->vsync = 1;
787 788
			}

L
Linus Torvalds 已提交
789 790 791
			pdev->vlast_packet_size = flen;
		} /* ..status == 0 */
		else {
792
			/* This is normally not interesting to the user, unless
793 794
			 * you are really debugging something, default = 0 */
			static int iso_error;
L
Linus Torvalds 已提交
795 796
			iso_error++;
			if (iso_error < 20)
797
				PWC_DEBUG_FLOW("Iso frame %d of USB has error %d\n", i, fst);
L
Linus Torvalds 已提交
798 799 800 801 802 803 804 805 806 807
		}
	}

handler_end:
	if (awake)
		wake_up_interruptible(&pdev->frameq);

	urb->dev = pdev->udev;
	i = usb_submit_urb(urb, GFP_ATOMIC);
	if (i != 0)
808
		PWC_ERROR("Error (%d) re-submitting urb in pwc_isoc_handler.\n", i);
L
Linus Torvalds 已提交
809 810 811
}


812
int pwc_isoc_init(struct pwc_device *pdev)
L
Linus Torvalds 已提交
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
{
	struct usb_device *udev;
	struct urb *urb;
	int i, j, ret;

	struct usb_interface *intf;
	struct usb_host_interface *idesc = NULL;

	if (pdev == NULL)
		return -EFAULT;
	if (pdev->iso_init)
		return 0;
	pdev->vsync = 0;
	udev = pdev->udev;

	/* Get the current alternate interface, adjust packet size */
	if (!udev->actconfig)
		return -EFAULT;
	intf = usb_ifnum_to_if(udev, 0);
	if (intf)
		idesc = usb_altnum_to_altsetting(intf, pdev->valternate);
834

L
Linus Torvalds 已提交
835 836 837 838 839
	if (!idesc)
		return -EFAULT;

	/* Search video endpoint */
	pdev->vmax_packet_size = -1;
840
	for (i = 0; i < idesc->desc.bNumEndpoints; i++) {
L
Linus Torvalds 已提交
841 842 843 844
		if ((idesc->endpoint[i].desc.bEndpointAddress & 0xF) == pdev->vendpoint) {
			pdev->vmax_packet_size = le16_to_cpu(idesc->endpoint[i].desc.wMaxPacketSize);
			break;
		}
845
	}
846

L
Linus Torvalds 已提交
847
	if (pdev->vmax_packet_size < 0 || pdev->vmax_packet_size > ISO_MAX_FRAME_SIZE) {
848
		PWC_ERROR("Failed to find packet size for video endpoint in current alternate setting.\n");
849
		return -ENFILE; /* Odd error, that should be noticeable */
L
Linus Torvalds 已提交
850 851 852 853
	}

	/* Set alternate interface */
	ret = 0;
854
	PWC_DEBUG_OPEN("Setting alternate interface %d\n", pdev->valternate);
L
Linus Torvalds 已提交
855 856 857 858 859 860 861
	ret = usb_set_interface(pdev->udev, 0, pdev->valternate);
	if (ret < 0)
		return ret;

	for (i = 0; i < MAX_ISO_BUFS; i++) {
		urb = usb_alloc_urb(ISO_FRAMES_PER_DESC, GFP_KERNEL);
		if (urb == NULL) {
862
			PWC_ERROR("Failed to allocate urb %d\n", i);
L
Linus Torvalds 已提交
863 864 865 866
			ret = -ENOMEM;
			break;
		}
		pdev->sbuf[i].urb = urb;
867
		PWC_DEBUG_MEMORY("Allocated URB at 0x%p\n", urb);
L
Linus Torvalds 已提交
868 869 870
	}
	if (ret) {
		/* De-allocate in reverse order */
M
Mariusz Kozlowski 已提交
871
		while (i--) {
M
Mariusz Kozlowski 已提交
872
			usb_free_urb(pdev->sbuf[i].urb);
L
Linus Torvalds 已提交
873 874 875 876 877
			pdev->sbuf[i].urb = NULL;
		}
		return ret;
	}

878
	/* init URB structure */
L
Linus Torvalds 已提交
879 880 881 882 883
	for (i = 0; i < MAX_ISO_BUFS; i++) {
		urb = pdev->sbuf[i].urb;

		urb->interval = 1; // devik
		urb->dev = udev;
884
		urb->pipe = usb_rcvisocpipe(udev, pdev->vendpoint);
L
Linus Torvalds 已提交
885
		urb->transfer_flags = URB_ISO_ASAP;
886 887 888 889
		urb->transfer_buffer = pdev->sbuf[i].data;
		urb->transfer_buffer_length = ISO_BUFFER_SIZE;
		urb->complete = pwc_isoc_handler;
		urb->context = pdev;
L
Linus Torvalds 已提交
890 891 892 893 894 895 896 897 898 899 900
		urb->start_frame = 0;
		urb->number_of_packets = ISO_FRAMES_PER_DESC;
		for (j = 0; j < ISO_FRAMES_PER_DESC; j++) {
			urb->iso_frame_desc[j].offset = j * ISO_MAX_FRAME_SIZE;
			urb->iso_frame_desc[j].length = pdev->vmax_packet_size;
		}
	}

	/* link */
	for (i = 0; i < MAX_ISO_BUFS; i++) {
		ret = usb_submit_urb(pdev->sbuf[i].urb, GFP_KERNEL);
901
		if (ret) {
902
			PWC_ERROR("isoc_init() submit_urb %d failed with error %d\n", i, ret);
903 904 905 906 907
			pdev->iso_init = 1;
			pwc_isoc_cleanup(pdev);
			return ret;
		}
		PWC_DEBUG_MEMORY("URB 0x%p submitted.\n", pdev->sbuf[i].urb);
L
Linus Torvalds 已提交
908 909 910 911
	}

	/* All is done... */
	pdev->iso_init = 1;
912
	PWC_DEBUG_OPEN("<< pwc_isoc_init()\n");
L
Linus Torvalds 已提交
913 914 915
	return 0;
}

916
static void pwc_iso_stop(struct pwc_device *pdev)
L
Linus Torvalds 已提交
917 918 919 920 921 922 923 924
{
	int i;

	/* Unlinking ISOC buffers one by one */
	for (i = 0; i < MAX_ISO_BUFS; i++) {
		struct urb *urb;

		urb = pdev->sbuf[i].urb;
A
Al Viro 已提交
925
		if (urb) {
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
			PWC_DEBUG_MEMORY("Unlinking URB %p\n", urb);
			usb_kill_urb(urb);
		}
	}
}

static void pwc_iso_free(struct pwc_device *pdev)
{
	int i;

	/* Freeing ISOC buffers one by one */
	for (i = 0; i < MAX_ISO_BUFS; i++) {
		struct urb *urb;

		urb = pdev->sbuf[i].urb;
A
Al Viro 已提交
941
		if (urb) {
942
			PWC_DEBUG_MEMORY("Freeing URB\n");
L
Linus Torvalds 已提交
943 944 945 946
			usb_free_urb(urb);
			pdev->sbuf[i].urb = NULL;
		}
	}
947 948 949 950 951 952 953 954 955 956 957 958
}

void pwc_isoc_cleanup(struct pwc_device *pdev)
{
	PWC_DEBUG_OPEN(">> pwc_isoc_cleanup()\n");
	if (pdev == NULL)
		return;
	if (pdev->iso_init == 0)
		return;

	pwc_iso_stop(pdev);
	pwc_iso_free(pdev);
L
Linus Torvalds 已提交
959 960

	/* Stop camera, but only if we are sure the camera is still there (unplug
961
	   is signalled by EPIPE)
L
Linus Torvalds 已提交
962
	 */
963
	if (pdev->error_status != EPIPE) {
964
		PWC_DEBUG_OPEN("Setting alternate interface 0.\n");
L
Linus Torvalds 已提交
965 966 967 968
		usb_set_interface(pdev->udev, 0, 0);
	}

	pdev->iso_init = 0;
969
	PWC_DEBUG_OPEN("<< pwc_isoc_cleanup()\n");
L
Linus Torvalds 已提交
970 971
}

972 973 974
/*********
 * sysfs
 *********/
975
static struct pwc_device *cd_to_pwc(struct device *cd)
976 977 978 979 980
{
	struct video_device *vdev = to_video_device(cd);
	return video_get_drvdata(vdev);
}

981 982
static ssize_t show_pan_tilt(struct device *class_dev,
			     struct device_attribute *attr, char *buf)
983 984 985 986 987
{
	struct pwc_device *pdev = cd_to_pwc(class_dev);
	return sprintf(buf, "%d %d\n", pdev->pan_angle, pdev->tilt_angle);
}

988 989 990
static ssize_t store_pan_tilt(struct device *class_dev,
			      struct device_attribute *attr,
			      const char *buf, size_t count)
991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
{
	struct pwc_device *pdev = cd_to_pwc(class_dev);
	int pan, tilt;
	int ret = -EINVAL;

	if (strncmp(buf, "reset", 5) == 0)
		ret = pwc_mpt_reset(pdev, 0x3);

	else if (sscanf(buf, "%d %d", &pan, &tilt) > 0)
		ret = pwc_mpt_set_angle(pdev, pan, tilt);

	if (ret < 0)
		return ret;
	return strlen(buf);
}
1006 1007
static DEVICE_ATTR(pan_tilt, S_IRUGO | S_IWUSR, show_pan_tilt,
		   store_pan_tilt);
1008

1009 1010
static ssize_t show_snapshot_button_status(struct device *class_dev,
					   struct device_attribute *attr, char *buf)
1011 1012 1013 1014 1015 1016 1017
{
	struct pwc_device *pdev = cd_to_pwc(class_dev);
	int status = pdev->snapshot_button_status;
	pdev->snapshot_button_status = 0;
	return sprintf(buf, "%d\n", status);
}

1018 1019
static DEVICE_ATTR(button, S_IRUGO | S_IWUSR, show_snapshot_button_status,
		   NULL);
1020

1021
static int pwc_create_sysfs_files(struct video_device *vdev)
1022 1023
{
	struct pwc_device *pdev = video_get_drvdata(vdev);
1024 1025
	int rc;

1026
	rc = device_create_file(&vdev->dev, &dev_attr_button);
1027 1028 1029
	if (rc)
		goto err;
	if (pdev->features & FEATURE_MOTOR_PANTILT) {
1030
		rc = device_create_file(&vdev->dev, &dev_attr_pan_tilt);
1031 1032
		if (rc)
			goto err_button;
1033 1034 1035 1036 1037
	}

	return 0;

err_button:
1038
	device_remove_file(&vdev->dev, &dev_attr_button);
1039
err:
1040
	PWC_ERROR("Could not create sysfs files.\n");
1041
	return rc;
1042 1043 1044 1045 1046
}

static void pwc_remove_sysfs_files(struct video_device *vdev)
{
	struct pwc_device *pdev = video_get_drvdata(vdev);
1047

1048
	if (pdev->features & FEATURE_MOTOR_PANTILT)
1049 1050
		device_remove_file(&vdev->dev, &dev_attr_pan_tilt);
	device_remove_file(&vdev->dev, &dev_attr_button);
1051 1052
}

1053
#ifdef CONFIG_USB_PWC_DEBUG
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
static const char *pwc_sensor_type_to_string(unsigned int sensor_type)
{
	switch(sensor_type) {
		case 0x00:
			return "Hyundai CMOS sensor";
		case 0x20:
			return "Sony CCD sensor + TDA8787";
		case 0x2E:
			return "Sony CCD sensor + Exas 98L59";
		case 0x2F:
			return "Sony CCD sensor + ADI 9804";
		case 0x30:
			return "Sharp CCD sensor + TDA8787";
		case 0x3E:
			return "Sharp CCD sensor + Exas 98L59";
		case 0x3F:
			return "Sharp CCD sensor + ADI 9804";
		case 0x40:
			return "UPA 1021 sensor";
		case 0x100:
			return "VGA sensor";
		case 0x101:
			return "PAL MR sensor";
		default:
1078
			return "unknown type of sensor";
1079 1080 1081
	}
}
#endif
L
Linus Torvalds 已提交
1082 1083 1084 1085

/***************************************************************************/
/* Video4Linux functions */

1086
static int pwc_video_open(struct file *file)
L
Linus Torvalds 已提交
1087
{
1088
	int i, ret;
L
Linus Torvalds 已提交
1089 1090 1091
	struct video_device *vdev = video_devdata(file);
	struct pwc_device *pdev;

1092
	PWC_DEBUG_OPEN(">> video_open called(vdev = 0x%p).\n", vdev);
1093

1094
	pdev = video_get_drvdata(vdev);
1095
	BUG_ON(!pdev);
1096 1097
	if (pdev->vopen) {
		PWC_DEBUG_OPEN("I'm busy, someone is using the device.\n");
L
Linus Torvalds 已提交
1098
		return -EBUSY;
1099
	}
1100

1101
	pwc_construct(pdev); /* set min/max sizes correct */
L
Linus Torvalds 已提交
1102
	if (!pdev->usb_init) {
1103
		PWC_DEBUG_OPEN("Doing first time initialization.\n");
L
Linus Torvalds 已提交
1104
		pdev->usb_init = 1;
1105

1106 1107 1108
		/* Query sensor type */
		ret = pwc_get_cmos_sensor(pdev, &i);
		if (ret >= 0)
L
Linus Torvalds 已提交
1109
		{
1110 1111 1112
			PWC_DEBUG_OPEN("This %s camera is equipped with a %s (%d).\n",
					pdev->vdev->name,
					pwc_sensor_type_to_string(i), i);
L
Linus Torvalds 已提交
1113 1114 1115 1116 1117 1118 1119
		}
	}

	/* Turn on camera */
	if (power_save) {
		i = pwc_camera_power(pdev, 1);
		if (i < 0)
1120
			PWC_DEBUG_OPEN("Failed to restore power to the camera! (%d)\n", i);
L
Linus Torvalds 已提交
1121 1122 1123
	}
	/* Set LED on/off time */
	if (pwc_set_leds(pdev, led_on, led_off) < 0)
1124
		PWC_DEBUG_OPEN("Failed to set LED on/off time.\n");
1125

L
Linus Torvalds 已提交
1126 1127 1128 1129

	/* So far, so good. Allocate memory. */
	i = pwc_allocate_buffers(pdev);
	if (i < 0) {
1130 1131
		PWC_DEBUG_OPEN("Failed to allocate buffers memory.\n");
		pwc_free_buffers(pdev);
L
Linus Torvalds 已提交
1132 1133
		return i;
	}
1134

L
Linus Torvalds 已提交
1135 1136
	/* Reset buffers & parameters */
	pwc_reset_buffers(pdev);
1137
	for (i = 0; i < pwc_mbufs; i++)
L
Linus Torvalds 已提交
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
		pdev->image_used[i] = 0;
	pdev->vframe_count = 0;
	pdev->vframes_dumped = 0;
	pdev->vframes_error = 0;
	pdev->visoc_errors = 0;
	pdev->error_status = 0;
	pwc_construct(pdev); /* set min/max sizes correct */

	/* Set some defaults */
	pdev->vsnapshot = 0;

1149
	/* Set video size, first try the last used video size
L
Linus Torvalds 已提交
1150 1151 1152 1153 1154
	   (or the default one); if that fails try QCIF/10 or QSIF/10;
	   it that fails too, give up.
	 */
	i = pwc_set_video_mode(pdev, pwc_image_sizes[pdev->vsize].x, pwc_image_sizes[pdev->vsize].y, pdev->vframes, pdev->vcompression, 0);
	if (i)	{
1155 1156 1157 1158
		unsigned int default_resolution;
		PWC_DEBUG_OPEN("First attempt at set_video_mode failed.\n");
		if (pdev->type>= 730)
			default_resolution = PSZ_QSIF;
L
Linus Torvalds 已提交
1159
		else
1160 1161 1162 1163 1164 1165 1166 1167
			default_resolution = PSZ_QCIF;

		i = pwc_set_video_mode(pdev,
				       pwc_image_sizes[default_resolution].x,
				       pwc_image_sizes[default_resolution].y,
				       10,
				       pdev->vcompression,
				       0);
L
Linus Torvalds 已提交
1168 1169
	}
	if (i) {
1170 1171
		PWC_DEBUG_OPEN("Second attempt at set_video_mode failed.\n");
		pwc_free_buffers(pdev);
L
Linus Torvalds 已提交
1172 1173
		return i;
	}
1174

1175 1176 1177 1178
	/* Initialize the webcam to sane value */
	pwc_set_brightness(pdev, 0x7fff);
	pwc_set_agc(pdev, 1, 0);

L
Linus Torvalds 已提交
1179 1180
	pdev->vopen++;
	file->private_data = vdev;
1181
	PWC_DEBUG_OPEN("<< video_open() returns 0.\n");
L
Linus Torvalds 已提交
1182 1183 1184
	return 0;
}

1185 1186 1187 1188 1189

static void pwc_cleanup(struct pwc_device *pdev)
{
	pwc_remove_sysfs_files(pdev->vdev);
	video_unregister_device(pdev->vdev);
1190 1191

#ifdef CONFIG_USB_PWC_INPUT_EVDEV
1192
	if (pdev->button_dev)
1193 1194
		input_unregister_device(pdev->button_dev);
#endif
1195 1196

	kfree(pdev);
1197 1198
}

L
Linus Torvalds 已提交
1199
/* Note that all cleanup is done in the reverse order as in _open */
1200
static int pwc_video_close(struct file *file)
L
Linus Torvalds 已提交
1201 1202 1203
{
	struct video_device *vdev = file->private_data;
	struct pwc_device *pdev;
1204
	int i, hint;
L
Linus Torvalds 已提交
1205

1206
	PWC_DEBUG_OPEN(">> video_close called(vdev = 0x%p).\n", vdev);
L
Linus Torvalds 已提交
1207

1208
	pdev = video_get_drvdata(vdev);
L
Linus Torvalds 已提交
1209
	if (pdev->vopen == 0)
1210
		PWC_DEBUG_MODULE("video_close() called on closed device?\n");
L
Linus Torvalds 已提交
1211 1212 1213 1214 1215 1216

	/* Dump statistics, but only if a reasonable amount of frames were
	   processed (to prevent endless log-entries in case of snap-shot
	   programs)
	 */
	if (pdev->vframe_count > 20)
1217
		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);
L
Linus Torvalds 已提交
1218

1219 1220 1221 1222
	if (DEVICE_USE_CODEC1(pdev->type))
	    pwc_dec1_exit();
	else
	    pwc_dec23_exit();
L
Linus Torvalds 已提交
1223 1224 1225 1226 1227

	pwc_isoc_cleanup(pdev);
	pwc_free_buffers(pdev);

	/* Turn off LEDS and power down camera, but only when not unplugged */
1228
	if (!pdev->unplugged) {
L
Linus Torvalds 已提交
1229 1230
		/* Turn LEDs off */
		if (pwc_set_leds(pdev, 0, 0) < 0)
1231
			PWC_DEBUG_MODULE("Failed to set LED on/off time.\n");
L
Linus Torvalds 已提交
1232 1233 1234
		if (power_save) {
			i = pwc_camera_power(pdev, 0);
			if (i < 0)
1235
				PWC_ERROR("Failed to power down camera (%d)\n", i);
L
Linus Torvalds 已提交
1236
		}
1237
		pdev->vopen--;
1238
		PWC_DEBUG_OPEN("<< video_close() vopen=%d\n", pdev->vopen);
1239 1240 1241 1242 1243 1244
	} else {
		pwc_cleanup(pdev);
		/* search device_hint[] table if we occupy a slot, by any chance */
		for (hint = 0; hint < MAX_DEV_HINTS; hint++)
			if (device_hint[hint].pdev == pdev)
				device_hint[hint].pdev = NULL;
L
Linus Torvalds 已提交
1245
	}
1246

L
Linus Torvalds 已提交
1247 1248 1249 1250 1251 1252
	return 0;
}

/*
 *	FIXME: what about two parallel reads ????
 *      ANSWER: Not supported. You can't open the device more than once,
1253 1254 1255 1256 1257 1258 1259
		despite what the V4L1 interface says. First, I don't see
		the need, second there's no mechanism of alerting the
		2nd/3rd/... process of events like changing image size.
		And I don't see the point of blocking that for the
		2nd/3rd/... process.
		In multi-threaded environments reading parallel from any
		device is tricky anyhow.
L
Linus Torvalds 已提交
1260 1261
 */

1262
static ssize_t pwc_video_read(struct file *file, char __user *buf,
L
Linus Torvalds 已提交
1263 1264 1265 1266 1267 1268
			  size_t count, loff_t *ppos)
{
	struct video_device *vdev = file->private_data;
	struct pwc_device *pdev;
	int noblock = file->f_flags & O_NONBLOCK;
	DECLARE_WAITQUEUE(wait, current);
1269
	int bytes_to_read, rv = 0;
1270
	void *image_buffer_addr;
L
Linus Torvalds 已提交
1271

1272 1273
	PWC_DEBUG_READ("pwc_video_read(vdev=0x%p, buf=%p, count=%zd) called.\n",
			vdev, buf, count);
L
Linus Torvalds 已提交
1274 1275
	if (vdev == NULL)
		return -EFAULT;
1276
	pdev = video_get_drvdata(vdev);
L
Linus Torvalds 已提交
1277 1278
	if (pdev == NULL)
		return -EFAULT;
1279 1280 1281 1282 1283

	if (pdev->error_status) {
		rv = -pdev->error_status; /* Something happened, report what. */
		goto err_out;
	}
L
Linus Torvalds 已提交
1284

1285 1286 1287 1288 1289
	/* Start the stream (if not already started) */
	rv = pwc_isoc_init(pdev);
	if (rv)
		goto err_out;

L
Linus Torvalds 已提交
1290 1291 1292 1293 1294 1295 1296 1297 1298
	/* In case we're doing partial reads, we don't have to wait for a frame */
	if (pdev->image_read_pos == 0) {
		/* Do wait queueing according to the (doc)book */
		add_wait_queue(&pdev->frameq, &wait);
		while (pdev->full_frames == NULL) {
			/* Check for unplugged/etc. here */
			if (pdev->error_status) {
				remove_wait_queue(&pdev->frameq, &wait);
				set_current_state(TASK_RUNNING);
1299 1300
				rv = -pdev->error_status ;
				goto err_out;
L
Linus Torvalds 已提交
1301
			}
1302 1303 1304
			if (noblock) {
				remove_wait_queue(&pdev->frameq, &wait);
				set_current_state(TASK_RUNNING);
1305 1306
				rv = -EWOULDBLOCK;
				goto err_out;
1307 1308 1309 1310
			}
			if (signal_pending(current)) {
				remove_wait_queue(&pdev->frameq, &wait);
				set_current_state(TASK_RUNNING);
1311 1312
				rv = -ERESTARTSYS;
				goto err_out;
1313
			}
1314
			mutex_unlock(&pdev->modlock);
1315 1316
			schedule();
			set_current_state(TASK_INTERRUPTIBLE);
1317
			mutex_lock(&pdev->modlock);
L
Linus Torvalds 已提交
1318 1319 1320
		}
		remove_wait_queue(&pdev->frameq, &wait);
		set_current_state(TASK_RUNNING);
1321

L
Linus Torvalds 已提交
1322
		/* Decompress and release frame */
1323 1324 1325 1326
		if (pwc_handle_frame(pdev)) {
			rv = -EFAULT;
			goto err_out;
		}
L
Linus Torvalds 已提交
1327 1328
	}

1329
	PWC_DEBUG_READ("Copying data to user space.\n");
1330
	if (pdev->pixfmt != V4L2_PIX_FMT_YUV420)
1331
		bytes_to_read = pdev->frame_size + sizeof(struct pwc_raw_frame);
L
Linus Torvalds 已提交
1332
	else
1333
		bytes_to_read = pdev->view.size;
L
Linus Torvalds 已提交
1334 1335 1336 1337

	/* copy bytes to user space; we allow for partial reads */
	if (count + pdev->image_read_pos > bytes_to_read)
		count = bytes_to_read - pdev->image_read_pos;
1338 1339 1340
	image_buffer_addr = pdev->image_data;
	image_buffer_addr += pdev->images[pdev->fill_image].offset;
	image_buffer_addr += pdev->image_read_pos;
1341 1342 1343 1344
	if (copy_to_user(buf, image_buffer_addr, count)) {
		rv = -EFAULT;
		goto err_out;
	}
L
Linus Torvalds 已提交
1345 1346 1347 1348 1349 1350
	pdev->image_read_pos += count;
	if (pdev->image_read_pos >= bytes_to_read) { /* All data has been read */
		pdev->image_read_pos = 0;
		pwc_next_image(pdev);
	}
	return count;
1351 1352
err_out:
	return rv;
L
Linus Torvalds 已提交
1353 1354 1355 1356 1357 1358
}

static unsigned int pwc_video_poll(struct file *file, poll_table *wait)
{
	struct video_device *vdev = file->private_data;
	struct pwc_device *pdev;
1359
	int ret;
L
Linus Torvalds 已提交
1360 1361 1362

	if (vdev == NULL)
		return -EFAULT;
1363
	pdev = video_get_drvdata(vdev);
L
Linus Torvalds 已提交
1364 1365 1366
	if (pdev == NULL)
		return -EFAULT;

1367 1368 1369 1370 1371
	/* Start the stream (if not already started) */
	ret = pwc_isoc_init(pdev);
	if (ret)
		return ret;

L
Linus Torvalds 已提交
1372 1373 1374 1375 1376 1377 1378 1379 1380
	poll_wait(file, &pdev->frameq, wait);
	if (pdev->error_status)
		return POLLERR;
	if (pdev->full_frames != NULL) /* we have frames waiting */
		return (POLLIN | POLLRDNORM);

	return 0;
}

1381
static long pwc_video_ioctl(struct file *file,
L
Linus Torvalds 已提交
1382 1383
			   unsigned int cmd, unsigned long arg)
{
1384 1385
	struct video_device *vdev = file->private_data;
	struct pwc_device *pdev;
1386
	long r = -ENODEV;
1387 1388 1389

	if (!vdev)
		goto out;
1390
	pdev = video_get_drvdata(vdev);
1391 1392

	if (!pdev->unplugged)
1393
		r = video_usercopy(file, cmd, arg, pwc_video_do_ioctl);
1394 1395
out:
	return r;
L
Linus Torvalds 已提交
1396 1397 1398 1399 1400 1401
}

static int pwc_video_mmap(struct file *file, struct vm_area_struct *vma)
{
	struct video_device *vdev = file->private_data;
	struct pwc_device *pdev;
1402 1403 1404 1405
	unsigned long start;
	unsigned long size;
	unsigned long page, pos = 0;
	int index;
1406

1407
	PWC_DEBUG_MEMORY(">> %s\n", __func__);
1408
	pdev = video_get_drvdata(vdev);
1409 1410
	size = vma->vm_end - vma->vm_start;
	start = vma->vm_start;
1411

1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
	/* Find the idx buffer for this mapping */
	for (index = 0; index < pwc_mbufs; index++) {
		pos = pdev->images[index].offset;
		if ((pos>>PAGE_SHIFT) == vma->vm_pgoff)
			break;
	}
	if (index == MAX_IMAGES)
		return -EINVAL;
	if (index == 0) {
		/*
		 * Special case for v4l1. In v4l1, we map only one big buffer,
		 * but in v4l2 each buffer is mapped
		 */
		unsigned long total_size;
		total_size = pwc_mbufs * pdev->len_per_image;
		if (size != pdev->len_per_image && size != total_size) {
			PWC_ERROR("Wrong size (%lu) needed to be len_per_image=%d or total_size=%lu\n",
				   size, pdev->len_per_image, total_size);
			return -EINVAL;
		}
	} else if (size > pdev->len_per_image)
		return -EINVAL;

	vma->vm_flags |= VM_IO;	/* from 2.6.9-acX */
L
Linus Torvalds 已提交
1436

1437
	pos += (unsigned long)pdev->image_data;
L
Linus Torvalds 已提交
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
	while (size > 0) {
		page = vmalloc_to_pfn((void *)pos);
		if (remap_pfn_range(vma, start, page, PAGE_SIZE, PAGE_SHARED))
			return -EAGAIN;
		start += PAGE_SIZE;
		pos += PAGE_SIZE;
		if (size > PAGE_SIZE)
			size -= PAGE_SIZE;
		else
			size = 0;
	}
	return 0;
}

/***************************************************************************/
/* USB functions */

/* This function gets called when a new device is plugged in or the usb core
 * is loaded.
 */

static int usb_pwc_probe(struct usb_interface *intf, const struct usb_device_id *id)
{
	struct usb_device *udev = interface_to_usbdev(intf);
	struct pwc_device *pdev = NULL;
	int vendor_id, product_id, type_id;
1464
	int hint, rc;
L
Linus Torvalds 已提交
1465 1466 1467 1468
	int features = 0;
	int video_nr = -1; /* default: use next available device */
	char serial_number[30], *name;

1469 1470 1471
	vendor_id = le16_to_cpu(udev->descriptor.idVendor);
	product_id = le16_to_cpu(udev->descriptor.idProduct);

L
Linus Torvalds 已提交
1472
	/* Check if we can handle this device */
1473 1474
	PWC_DEBUG_PROBE("probe() called [%04X %04X], if %d\n",
		vendor_id, product_id,
L
Linus Torvalds 已提交
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486
		intf->altsetting->desc.bInterfaceNumber);

	/* the interfaces are probed one by one. We are only interested in the
	   video interface (0) now.
	   Interface 1 is the Audio Control, and interface 2 Audio itself.
	 */
	if (intf->altsetting->desc.bInterfaceNumber > 0)
		return -ENODEV;

	if (vendor_id == 0x0471) {
		switch (product_id) {
		case 0x0302:
1487
			PWC_INFO("Philips PCA645VC USB webcam detected.\n");
L
Linus Torvalds 已提交
1488 1489 1490 1491
			name = "Philips 645 webcam";
			type_id = 645;
			break;
		case 0x0303:
1492
			PWC_INFO("Philips PCA646VC USB webcam detected.\n");
L
Linus Torvalds 已提交
1493 1494 1495 1496
			name = "Philips 646 webcam";
			type_id = 646;
			break;
		case 0x0304:
1497
			PWC_INFO("Askey VC010 type 2 USB webcam detected.\n");
L
Linus Torvalds 已提交
1498 1499 1500 1501
			name = "Askey VC010 webcam";
			type_id = 646;
			break;
		case 0x0307:
1502
			PWC_INFO("Philips PCVC675K (Vesta) USB webcam detected.\n");
L
Linus Torvalds 已提交
1503 1504 1505 1506
			name = "Philips 675 webcam";
			type_id = 675;
			break;
		case 0x0308:
1507
			PWC_INFO("Philips PCVC680K (Vesta Pro) USB webcam detected.\n");
L
Linus Torvalds 已提交
1508 1509 1510 1511
			name = "Philips 680 webcam";
			type_id = 680;
			break;
		case 0x030C:
1512
			PWC_INFO("Philips PCVC690K (Vesta Pro Scan) USB webcam detected.\n");
L
Linus Torvalds 已提交
1513 1514 1515 1516
			name = "Philips 690 webcam";
			type_id = 690;
			break;
		case 0x0310:
1517
			PWC_INFO("Philips PCVC730K (ToUCam Fun)/PCVC830 (ToUCam II) USB webcam detected.\n");
L
Linus Torvalds 已提交
1518 1519 1520 1521
			name = "Philips 730 webcam";
			type_id = 730;
			break;
		case 0x0311:
1522
			PWC_INFO("Philips PCVC740K (ToUCam Pro)/PCVC840 (ToUCam II) USB webcam detected.\n");
L
Linus Torvalds 已提交
1523 1524 1525 1526
			name = "Philips 740 webcam";
			type_id = 740;
			break;
		case 0x0312:
1527
			PWC_INFO("Philips PCVC750K (ToUCam Pro Scan) USB webcam detected.\n");
L
Linus Torvalds 已提交
1528 1529 1530 1531
			name = "Philips 750 webcam";
			type_id = 750;
			break;
		case 0x0313:
1532
			PWC_INFO("Philips PCVC720K/40 (ToUCam XS) USB webcam detected.\n");
L
Linus Torvalds 已提交
1533 1534 1535
			name = "Philips 720K/40 webcam";
			type_id = 720;
			break;
1536 1537 1538
		case 0x0329:
			PWC_INFO("Philips SPC 900NC USB webcam detected.\n");
			name = "Philips SPC 900NC webcam";
1539
			type_id = 740;
1540
			break;
L
Linus Torvalds 已提交
1541 1542 1543 1544 1545 1546 1547 1548
		default:
			return -ENODEV;
			break;
		}
	}
	else if (vendor_id == 0x069A) {
		switch(product_id) {
		case 0x0001:
1549
			PWC_INFO("Askey VC010 type 1 USB webcam detected.\n");
L
Linus Torvalds 已提交
1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
			name = "Askey VC010 webcam";
			type_id = 645;
			break;
		default:
			return -ENODEV;
			break;
		}
	}
	else if (vendor_id == 0x046d) {
		switch(product_id) {
		case 0x08b0:
1561
			PWC_INFO("Logitech QuickCam Pro 3000 USB webcam detected.\n");
L
Linus Torvalds 已提交
1562 1563 1564 1565
			name = "Logitech QuickCam Pro 3000";
			type_id = 740; /* CCD sensor */
			break;
		case 0x08b1:
1566
			PWC_INFO("Logitech QuickCam Notebook Pro USB webcam detected.\n");
L
Linus Torvalds 已提交
1567 1568 1569 1570
			name = "Logitech QuickCam Notebook Pro";
			type_id = 740; /* CCD sensor */
			break;
		case 0x08b2:
1571
			PWC_INFO("Logitech QuickCam 4000 Pro USB webcam detected.\n");
L
Linus Torvalds 已提交
1572 1573 1574 1575
			name = "Logitech QuickCam Pro 4000";
			type_id = 740; /* CCD sensor */
			break;
		case 0x08b3:
1576
			PWC_INFO("Logitech QuickCam Zoom USB webcam detected.\n");
L
Linus Torvalds 已提交
1577 1578 1579 1580
			name = "Logitech QuickCam Zoom";
			type_id = 740; /* CCD sensor */
			break;
		case 0x08B4:
1581
			PWC_INFO("Logitech QuickCam Zoom (new model) USB webcam detected.\n");
L
Linus Torvalds 已提交
1582 1583
			name = "Logitech QuickCam Zoom";
			type_id = 740; /* CCD sensor */
1584
			power_save = 1;
L
Linus Torvalds 已提交
1585 1586
			break;
		case 0x08b5:
1587
			PWC_INFO("Logitech QuickCam Orbit/Sphere USB webcam detected.\n");
L
Linus Torvalds 已提交
1588 1589 1590 1591 1592
			name = "Logitech QuickCam Orbit";
			type_id = 740; /* CCD sensor */
			features |= FEATURE_MOTOR_PANTILT;
			break;
		case 0x08b6:
1593 1594 1595 1596
			PWC_INFO("Logitech/Cisco VT Camera webcam detected.\n");
			name = "Cisco VT Camera";
			type_id = 740; /* CCD sensor */
			break;
L
Linus Torvalds 已提交
1597
		case 0x08b7:
1598 1599 1600 1601 1602
			PWC_INFO("Logitech ViewPort AV 100 webcam detected.\n");
			name = "Logitech ViewPort AV 100";
			type_id = 740; /* CCD sensor */
			break;
		case 0x08b8: /* Where this released? */
1603
			PWC_INFO("Logitech QuickCam detected (reserved ID).\n");
L
Linus Torvalds 已提交
1604 1605 1606
			name = "Logitech QuickCam (res.)";
			type_id = 730; /* Assuming CMOS */
			break;
1607
		default:
L
Linus Torvalds 已提交
1608
			return -ENODEV;
1609 1610 1611
			break;
		}
	}
L
Linus Torvalds 已提交
1612 1613 1614 1615 1616 1617 1618
	else if (vendor_id == 0x055d) {
		/* I don't know the difference between the C10 and the C30;
		   I suppose the difference is the sensor, but both cameras
		   work equally well with a type_id of 675
		 */
		switch(product_id) {
		case 0x9000:
1619
			PWC_INFO("Samsung MPC-C10 USB webcam detected.\n");
L
Linus Torvalds 已提交
1620 1621 1622 1623
			name = "Samsung MPC-C10";
			type_id = 675;
			break;
		case 0x9001:
1624
			PWC_INFO("Samsung MPC-C30 USB webcam detected.\n");
L
Linus Torvalds 已提交
1625 1626 1627
			name = "Samsung MPC-C30";
			type_id = 675;
			break;
1628 1629 1630 1631 1632
		case 0x9002:
			PWC_INFO("Samsung SNC-35E (v3.0) USB webcam detected.\n");
			name = "Samsung MPC-C30";
			type_id = 740;
			break;
L
Linus Torvalds 已提交
1633 1634 1635 1636 1637 1638 1639 1640
		default:
			return -ENODEV;
			break;
		}
	}
	else if (vendor_id == 0x041e) {
		switch(product_id) {
		case 0x400c:
1641
			PWC_INFO("Creative Labs Webcam 5 detected.\n");
L
Linus Torvalds 已提交
1642 1643 1644 1645
			name = "Creative Labs Webcam 5";
			type_id = 730;
			break;
		case 0x4011:
1646
			PWC_INFO("Creative Labs Webcam Pro Ex detected.\n");
L
Linus Torvalds 已提交
1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657
			name = "Creative Labs Webcam Pro Ex";
			type_id = 740;
			break;
		default:
			return -ENODEV;
			break;
		}
	}
	else if (vendor_id == 0x04cc) {
		switch(product_id) {
		case 0x8116:
1658
			PWC_INFO("Sotec Afina Eye USB webcam detected.\n");
L
Linus Torvalds 已提交
1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670
			name = "Sotec Afina Eye";
			type_id = 730;
			break;
		default:
			return -ENODEV;
			break;
		}
	}
	else if (vendor_id == 0x06be) {
		switch(product_id) {
		case 0x8116:
			/* This is essentially the same cam as the Sotec Afina Eye */
1671
			PWC_INFO("AME Co. Afina Eye USB webcam detected.\n");
L
Linus Torvalds 已提交
1672 1673 1674 1675 1676 1677 1678
			name = "AME Co. Afina Eye";
			type_id = 750;
			break;
		default:
			return -ENODEV;
			break;
		}
1679

L
Linus Torvalds 已提交
1680 1681 1682 1683
	}
	else if (vendor_id == 0x0d81) {
		switch(product_id) {
		case 0x1900:
1684
			PWC_INFO("Visionite VCS-UC300 USB webcam detected.\n");
L
Linus Torvalds 已提交
1685 1686 1687 1688
			name = "Visionite VCS-UC300";
			type_id = 740; /* CCD sensor */
			break;
		case 0x1910:
1689
			PWC_INFO("Visionite VCS-UM100 USB webcam detected.\n");
L
Linus Torvalds 已提交
1690 1691 1692 1693 1694 1695 1696 1697
			name = "Visionite VCS-UM100";
			type_id = 730; /* CMOS sensor */
			break;
		default:
			return -ENODEV;
			break;
		}
	}
1698
	else
L
Linus Torvalds 已提交
1699 1700 1701 1702
		return -ENODEV; /* Not any of the know types; but the list keeps growing. */

	memset(serial_number, 0, 30);
	usb_string(udev, udev->descriptor.iSerialNumber, serial_number, 29);
1703
	PWC_DEBUG_PROBE("Device serial number is %s\n", serial_number);
L
Linus Torvalds 已提交
1704 1705

	if (udev->descriptor.bNumConfigurations > 1)
1706
		PWC_WARNING("Warning: more than 1 configuration available.\n");
L
Linus Torvalds 已提交
1707 1708

	/* Allocate structure, initialize pointers, mutexes, etc. and link it to the usb_device */
1709
	pdev = kzalloc(sizeof(struct pwc_device), GFP_KERNEL);
L
Linus Torvalds 已提交
1710
	if (pdev == NULL) {
1711
		PWC_ERROR("Oops, could not allocate memory for pwc_device.\n");
L
Linus Torvalds 已提交
1712 1713 1714 1715 1716 1717 1718
		return -ENOMEM;
	}
	pdev->type = type_id;
	pdev->vsize = default_size;
	pdev->vframes = default_fps;
	strcpy(pdev->serial, serial_number);
	pdev->features = features;
1719
	if (vendor_id == 0x046D && product_id == 0x08B5) {
L
Linus Torvalds 已提交
1720
		/* Logitech QuickCam Orbit
1721 1722 1723
		   The ranges have been determined experimentally; they may differ from cam to cam.
		   Also, the exact ranges left-right and up-down are different for my cam
		  */
L
Linus Torvalds 已提交
1724 1725 1726 1727 1728 1729
		pdev->angle_range.pan_min  = -7000;
		pdev->angle_range.pan_max  =  7000;
		pdev->angle_range.tilt_min = -3000;
		pdev->angle_range.tilt_max =  2500;
	}

1730
	mutex_init(&pdev->modlock);
L
Linus Torvalds 已提交
1731 1732 1733 1734 1735 1736 1737 1738
	spin_lock_init(&pdev->ptrlock);

	pdev->udev = udev;
	init_waitqueue_head(&pdev->frameq);
	pdev->vcompression = pwc_preferred_compression;

	/* Allocate video_device structure */
	pdev->vdev = video_device_alloc();
A
Al Viro 已提交
1739
	if (!pdev->vdev) {
1740
		PWC_ERROR("Err, cannot allocate video_device struture. Failing probe.");
1741 1742
		rc = -ENOMEM;
		goto err_free_mem;
L
Linus Torvalds 已提交
1743 1744
	}
	memcpy(pdev->vdev, &pwc_template, sizeof(pwc_template));
1745
	pdev->vdev->parent = &intf->dev;
1746
	pdev->vdev->lock = &pdev->modlock;
L
Linus Torvalds 已提交
1747 1748 1749 1750
	strcpy(pdev->vdev->name, name);
	video_set_drvdata(pdev->vdev, pdev);

	pdev->release = le16_to_cpu(udev->descriptor.bcdDevice);
1751
	PWC_DEBUG_PROBE("Release: %04x\n", pdev->release);
L
Linus Torvalds 已提交
1752 1753 1754 1755 1756 1757 1758

	/* Now search device_hint[] table for a match, so we can hint a node number. */
	for (hint = 0; hint < MAX_DEV_HINTS; hint++) {
		if (((device_hint[hint].type == -1) || (device_hint[hint].type == pdev->type)) &&
		     (device_hint[hint].pdev == NULL)) {
			/* so far, so good... try serial number */
			if ((device_hint[hint].serial_number[0] == '*') || !strcmp(device_hint[hint].serial_number, serial_number)) {
1759 1760 1761 1762
				/* match! */
				video_nr = device_hint[hint].device_node;
				PWC_DEBUG_PROBE("Found hint, will try to register as /dev/video%d\n", video_nr);
				break;
L
Linus Torvalds 已提交
1763 1764 1765 1766 1767
			}
		}
	}

	pdev->vdev->release = video_device_release;
1768

L
Linus Torvalds 已提交
1769
	/* occupy slot */
1770
	if (hint < MAX_DEV_HINTS)
L
Linus Torvalds 已提交
1771 1772
		device_hint[hint].pdev = pdev;

1773
	PWC_DEBUG_PROBE("probe() function returning struct at 0x%p.\n", pdev);
1774
	usb_set_intfdata(intf, pdev);
1775 1776 1777 1778 1779

	/* Set the leds off */
	pwc_set_leds(pdev, 0, 0);
	pwc_camera_power(pdev, 0);

1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790
	rc = video_register_device(pdev->vdev, VFL_TYPE_GRABBER, video_nr);
	if (rc < 0) {
		PWC_ERROR("Failed to register as video device (%d).\n", rc);
		goto err_video_release;
	}
	rc = pwc_create_sysfs_files(pdev->vdev);
	if (rc)
		goto err_video_unreg;

	PWC_INFO("Registered as %s.\n", video_device_node_name(pdev->vdev));

1791 1792 1793 1794 1795
#ifdef CONFIG_USB_PWC_INPUT_EVDEV
	/* register webcam snapshot button input device */
	pdev->button_dev = input_allocate_device();
	if (!pdev->button_dev) {
		PWC_ERROR("Err, insufficient memory for webcam snapshot button device.");
1796 1797 1798
		rc = -ENOMEM;
		pwc_remove_sysfs_files(pdev->vdev);
		goto err_video_unreg;
1799 1800
	}

1801 1802 1803
	usb_make_path(udev, pdev->button_phys, sizeof(pdev->button_phys));
	strlcat(pdev->button_phys, "/input0", sizeof(pdev->button_phys));

1804
	pdev->button_dev->name = "PWC snapshot button";
1805
	pdev->button_dev->phys = pdev->button_phys;
1806 1807 1808
	usb_to_input_id(pdev->udev, &pdev->button_dev->id);
	pdev->button_dev->dev.parent = &pdev->udev->dev;
	pdev->button_dev->evbit[0] = BIT_MASK(EV_KEY);
1809
	pdev->button_dev->keybit[BIT_WORD(KEY_CAMERA)] = BIT_MASK(KEY_CAMERA);
1810 1811 1812 1813 1814

	rc = input_register_device(pdev->button_dev);
	if (rc) {
		input_free_device(pdev->button_dev);
		pdev->button_dev = NULL;
1815 1816
		pwc_remove_sysfs_files(pdev->vdev);
		goto err_video_unreg;
1817 1818 1819
	}
#endif

L
Linus Torvalds 已提交
1820
	return 0;
1821

1822
err_video_unreg:
1823 1824 1825
	if (hint < MAX_DEV_HINTS)
		device_hint[hint].pdev = NULL;
	video_unregister_device(pdev->vdev);
1826 1827 1828 1829 1830
	pdev->vdev = NULL;	/* So we don't try to release it below */
err_video_release:
	video_device_release(pdev->vdev);
err_free_mem:
	kfree(pdev);
1831
	return rc;
L
Linus Torvalds 已提交
1832 1833
}

1834
/* The user yanked out the cable... */
L
Linus Torvalds 已提交
1835 1836 1837 1838 1839 1840
static void usb_pwc_disconnect(struct usb_interface *intf)
{
	struct pwc_device *pdev;
	int hint;

	pdev = usb_get_intfdata (intf);
H
Hans Verkuil 已提交
1841
	mutex_lock(&pdev->modlock);
L
Linus Torvalds 已提交
1842 1843
	usb_set_intfdata (intf, NULL);
	if (pdev == NULL) {
1844
		PWC_ERROR("pwc_disconnect() Called without private pointer.\n");
L
Linus Torvalds 已提交
1845 1846 1847
		goto disconnect_out;
	}
	if (pdev->udev == NULL) {
1848
		PWC_ERROR("pwc_disconnect() already called for %p\n", pdev);
L
Linus Torvalds 已提交
1849 1850 1851
		goto disconnect_out;
	}
	if (pdev->udev != interface_to_usbdev(intf)) {
1852
		PWC_ERROR("pwc_disconnect() Woops: pointer mismatch udev/pdev.\n");
L
Linus Torvalds 已提交
1853 1854
		goto disconnect_out;
	}
1855

L
Linus Torvalds 已提交
1856 1857
	/* We got unplugged; this is signalled by an EPIPE error code */
	if (pdev->vopen) {
1858
		PWC_INFO("Disconnected while webcam is in use!\n");
L
Linus Torvalds 已提交
1859 1860 1861 1862 1863 1864
		pdev->error_status = EPIPE;
	}

	/* Alert waiting processes */
	wake_up_interruptible(&pdev->frameq);
	/* Wait until device is closed */
1865
	if (pdev->vopen) {
1866
		pdev->unplugged = 1;
1867
		pwc_iso_stop(pdev);
1868 1869 1870 1871
	} else {
		/* Device is closed, so we can safely unregister it */
		PWC_DEBUG_PROBE("Unregistering video device in disconnect().\n");
		pwc_cleanup(pdev);
L
Linus Torvalds 已提交
1872 1873

disconnect_out:
1874 1875 1876 1877 1878
		/* search device_hint[] table if we occupy a slot, by any chance */
		for (hint = 0; hint < MAX_DEV_HINTS; hint++)
			if (device_hint[hint].pdev == pdev)
				device_hint[hint].pdev = NULL;
	}
L
Linus Torvalds 已提交
1879

H
Hans Verkuil 已提交
1880
	mutex_unlock(&pdev->modlock);
L
Linus Torvalds 已提交
1881 1882 1883
}


1884 1885
/*
 * Initialization code & module stuff
L
Linus Torvalds 已提交
1886 1887
 */

1888 1889 1890 1891
static char *size;
static int fps;
static int fbufs;
static int mbufs;
L
Linus Torvalds 已提交
1892 1893
static int compression = -1;
static int leds[2] = { -1, -1 };
1894
static unsigned int leds_nargs;
1895
static char *dev_hint[MAX_DEV_HINTS];
1896
static unsigned int dev_hint_nargs;
1897 1898 1899 1900 1901

module_param(size, charp, 0444);
module_param(fps, int, 0444);
module_param(fbufs, int, 0444);
module_param(mbufs, int, 0444);
1902
#ifdef CONFIG_USB_PWC_DEBUG
1903 1904 1905 1906 1907 1908
module_param_named(trace, pwc_trace, int, 0644);
#endif
module_param(power_save, int, 0444);
module_param(compression, int, 0444);
module_param_array(leds, int, &leds_nargs, 0444);
module_param_array(dev_hint, charp, &dev_hint_nargs, 0444);
L
Linus Torvalds 已提交
1909 1910 1911 1912 1913

MODULE_PARM_DESC(size, "Initial image size. One of sqcif, qsif, qcif, sif, cif, vga");
MODULE_PARM_DESC(fps, "Initial frames per second. Varies with model, useful range 5-30");
MODULE_PARM_DESC(fbufs, "Number of internal frame buffers to reserve");
MODULE_PARM_DESC(mbufs, "Number of external (mmap()ed) image buffers");
1914
#ifdef CONFIG_USB_PWC_DEBUG
L
Linus Torvalds 已提交
1915
MODULE_PARM_DESC(trace, "For debugging purposes");
1916
#endif
L
Linus Torvalds 已提交
1917 1918 1919 1920 1921 1922 1923 1924
MODULE_PARM_DESC(power_save, "Turn power save feature in camera on or off");
MODULE_PARM_DESC(compression, "Preferred compression quality. Range 0 (uncompressed) to 3 (high compression)");
MODULE_PARM_DESC(leds, "LED on,off time in milliseconds");
MODULE_PARM_DESC(dev_hint, "Device node hints");

MODULE_DESCRIPTION("Philips & OEM USB webcam driver");
MODULE_AUTHOR("Luc Saillard <luc@saillard.org>");
MODULE_LICENSE("GPL");
1925 1926
MODULE_ALIAS("pwcx");
MODULE_VERSION( PWC_VERSION );
L
Linus Torvalds 已提交
1927 1928 1929 1930 1931 1932

static int __init usb_pwc_init(void)
{
	int i, sz;
	char *sizenames[PSZ_MAX] = { "sqcif", "qsif", "qcif", "sif", "cif", "vga" };

1933 1934 1935 1936
	PWC_INFO("Philips webcam module version " PWC_VERSION " loaded.\n");
	PWC_INFO("Supports Philips PCA645/646, PCVC675/680/690, PCVC720[40]/730/740/750 & PCVC830/840.\n");
	PWC_INFO("Also supports the Askey VC010, various Logitech Quickcams, Samsung MPC-C10 and MPC-C30,\n");
	PWC_INFO("the Creative WebCam 5 & Pro Ex, SOTEC Afina Eye and Visionite VCS-UC300 and VCS-UM100.\n");
L
Linus Torvalds 已提交
1937 1938 1939

	if (fps) {
		if (fps < 4 || fps > 30) {
1940
			PWC_ERROR("Framerate out of bounds (4-30).\n");
L
Linus Torvalds 已提交
1941 1942 1943
			return -EINVAL;
		}
		default_fps = fps;
1944
		PWC_DEBUG_MODULE("Default framerate set to %d.\n", default_fps);
L
Linus Torvalds 已提交
1945 1946
	}

1947
	if (size) {
L
Linus Torvalds 已提交
1948 1949 1950 1951 1952 1953 1954 1955
		/* string; try matching with array */
		for (sz = 0; sz < PSZ_MAX; sz++) {
			if (!strcmp(sizenames[sz], size)) { /* Found! */
				default_size = sz;
				break;
			}
		}
		if (sz == PSZ_MAX) {
1956
			PWC_ERROR("Size not recognized; try size=[sqcif | qsif | qcif | sif | cif | vga].\n");
L
Linus Torvalds 已提交
1957 1958
			return -EINVAL;
		}
1959
		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);
L
Linus Torvalds 已提交
1960 1961 1962
	}
	if (mbufs) {
		if (mbufs < 1 || mbufs > MAX_IMAGES) {
1963
			PWC_ERROR("Illegal number of mmap() buffers; use a number between 1 and %d.\n", MAX_IMAGES);
L
Linus Torvalds 已提交
1964 1965
			return -EINVAL;
		}
1966 1967
		pwc_mbufs = mbufs;
		PWC_DEBUG_MODULE("Number of image buffers set to %d.\n", pwc_mbufs);
L
Linus Torvalds 已提交
1968 1969 1970
	}
	if (fbufs) {
		if (fbufs < 2 || fbufs > MAX_FRAMES) {
1971
			PWC_ERROR("Illegal number of frame buffers; use a number between 2 and %d.\n", MAX_FRAMES);
L
Linus Torvalds 已提交
1972 1973 1974
			return -EINVAL;
		}
		default_fbufs = fbufs;
1975
		PWC_DEBUG_MODULE("Number of frame buffers set to %d.\n", default_fbufs);
L
Linus Torvalds 已提交
1976
	}
1977
#ifdef CONFIG_USB_PWC_DEBUG
1978 1979
	if (pwc_trace >= 0) {
		PWC_DEBUG_MODULE("Trace options: 0x%04x\n", pwc_trace);
L
Linus Torvalds 已提交
1980
	}
1981
#endif
L
Linus Torvalds 已提交
1982 1983
	if (compression >= 0) {
		if (compression > 3) {
1984
			PWC_ERROR("Invalid compression setting; use a number between 0 (uncompressed) and 3 (high).\n");
L
Linus Torvalds 已提交
1985 1986 1987
			return -EINVAL;
		}
		pwc_preferred_compression = compression;
1988
		PWC_DEBUG_MODULE("Preferred compression set to %d.\n", pwc_preferred_compression);
L
Linus Torvalds 已提交
1989 1990
	}
	if (power_save)
1991
		PWC_DEBUG_MODULE("Enabling power save on open/close.\n");
L
Linus Torvalds 已提交
1992 1993 1994 1995 1996
	if (leds[0] >= 0)
		led_on = leds[0];
	if (leds[1] >= 0)
		led_off = leds[1];

1997
	/* Big device node whoopla. Basically, it allows you to assign a
L
Linus Torvalds 已提交
1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021
	   device node (/dev/videoX) to a camera, based on its type
	   & serial number. The format is [type[.serialnumber]:]node.

	   Any camera that isn't matched by these rules gets the next
	   available free device node.
	 */
	for (i = 0; i < MAX_DEV_HINTS; i++) {
		char *s, *colon, *dot;

		/* This loop also initializes the array */
		device_hint[i].pdev = NULL;
		s = dev_hint[i];
		if (s != NULL && *s != '\0') {
			device_hint[i].type = -1; /* wildcard */
			strcpy(device_hint[i].serial_number, "*");

			/* parse string: chop at ':' & '/' */
			colon = dot = s;
			while (*colon != '\0' && *colon != ':')
				colon++;
			while (*dot != '\0' && *dot != '.')
				dot++;
			/* Few sanity checks */
			if (*dot != '\0' && dot > colon) {
2022
				PWC_ERROR("Malformed camera hint: the colon must be after the dot.\n");
L
Linus Torvalds 已提交
2023 2024 2025 2026 2027 2028
				return -EINVAL;
			}

			if (*colon == '\0') {
				/* No colon */
				if (*dot != '\0') {
2029
					PWC_ERROR("Malformed camera hint: no colon + device node given.\n");
L
Linus Torvalds 已提交
2030 2031 2032 2033
					return -EINVAL;
				}
				else {
					/* No type or serial number specified, just a number. */
2034 2035
					device_hint[i].device_node =
						simple_strtol(s, NULL, 10);
L
Linus Torvalds 已提交
2036 2037 2038 2039
				}
			}
			else {
				/* There's a colon, so we have at least a type and a device node */
2040 2041 2042 2043
				device_hint[i].type =
					simple_strtol(s, NULL, 10);
				device_hint[i].device_node =
					simple_strtol(colon + 1, NULL, 10);
L
Linus Torvalds 已提交
2044 2045 2046
				if (*dot != '\0') {
					/* There's a serial number as well */
					int k;
2047

L
Linus Torvalds 已提交
2048 2049 2050 2051 2052 2053 2054 2055 2056
					dot++;
					k = 0;
					while (*dot != ':' && k < 29) {
						device_hint[i].serial_number[k++] = *dot;
						dot++;
					}
					device_hint[i].serial_number[k] = '\0';
				}
			}
2057 2058 2059 2060
			PWC_TRACE("device_hint[%d]:\n", i);
			PWC_TRACE("  type    : %d\n", device_hint[i].type);
			PWC_TRACE("  serial# : %s\n", device_hint[i].serial_number);
			PWC_TRACE("  node    : %d\n", device_hint[i].device_node);
L
Linus Torvalds 已提交
2061 2062 2063 2064 2065
		}
		else
			device_hint[i].type = 0; /* not filled */
	} /* ..for MAX_DEV_HINTS */

2066
	PWC_DEBUG_PROBE("Registering driver at address 0x%p.\n", &pwc_driver);
L
Linus Torvalds 已提交
2067 2068 2069 2070 2071
	return usb_register(&pwc_driver);
}

static void __exit usb_pwc_exit(void)
{
2072
	PWC_DEBUG_MODULE("Deregistering driver.\n");
L
Linus Torvalds 已提交
2073
	usb_deregister(&pwc_driver);
2074
	PWC_INFO("Philips webcam module removed.\n");
L
Linus Torvalds 已提交
2075 2076 2077 2078 2079
}

module_init(usb_pwc_init);
module_exit(usb_pwc_exit);

2080
/* vim: set cino= formatoptions=croql cindent shiftwidth=8 tabstop=8: */