pwc-if.c 61.1 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 70 71 72 73
#include <linux/vmalloc.h>
#include <asm/io.h>

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

/* Function prototypes and driver templates */

/* hotplug device table support */
81
static const struct usb_device_id pwc_device_table [] = {
L
Linus Torvalds 已提交
82 83 84 85 86 87 88
	{ 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) },
89
	{ USB_DEVICE(0x0471, 0x0311) }, /* Philips ToUcam PRO II */
L
Linus Torvalds 已提交
90 91
	{ USB_DEVICE(0x0471, 0x0312) },
	{ USB_DEVICE(0x0471, 0x0313) }, /* the 'new' 720K */
92
	{ USB_DEVICE(0x0471, 0x0329) }, /* Philips SPC 900NC PC Camera */
L
Linus Torvalds 已提交
93 94 95 96 97 98 99
	{ 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 */
100 101
	{ USB_DEVICE(0x046D, 0x08B6) }, /* Cisco VT Camera */
	{ USB_DEVICE(0x046D, 0x08B7) }, /* Logitech ViewPort AV 100 */
L
Linus Torvalds 已提交
102
	{ USB_DEVICE(0x046D, 0x08B8) }, /* Logitech (reserved) */
103 104 105
	{ 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 已提交
106 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
	{ 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 */
132
	int pwc_mbufs = 2;	/* Default number of mmap() buffers */
133
#ifdef CONFIG_USB_PWC_DEBUG
134
	int pwc_trace = PWC_DEBUG_LEVEL;
135
#endif
136 137
static int power_save;
static int led_on = 100, led_off; /* defaults to LED that is on while in use */
138
static int pwc_preferred_compression = 1; /* 0..3 = uncompressed..high */
L
Linus Torvalds 已提交
139 140 141 142 143 144 145 146 147
static struct {
	int type;
	char serial_number[30];
	int device_node;
	struct pwc_device *pdev;
} device_hint[MAX_DEV_HINTS];

/***/

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

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

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

/* 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 290 291
	/* create frame buffers, and make circular ring */
	for (i = 0; i < default_fbufs; i++) {
		if (pdev->fbuf[i].data == NULL) {
			kbuf = vmalloc(PWC_FRAME_SIZE); /* need vmalloc since frame buffer > 128K */
			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
			pdev->fbuf[i].data = kbuf;
297
			memset(kbuf, 0, PWC_FRAME_SIZE);
L
Linus Torvalds 已提交
298 299
		}
	}
300

L
Linus Torvalds 已提交
301
	/* Allocate decompressor table space */
302 303 304 305 306 307 308 309 310
	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;
	}
311

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

	kbuf = NULL;
330

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

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

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

	if (pdev == NULL)
		return;
	/* Release Iso-pipe buffers */
	for (i = 0; i < MAX_ISO_BUFS; i++)
		if (pdev->sbuf[i].data != NULL) {
346
			PWC_DEBUG_MEMORY("Freeing ISO buffer at %p.\n", pdev->sbuf[i].data);
L
Linus Torvalds 已提交
347 348 349 350 351 352 353 354
			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) {
355
				PWC_DEBUG_MEMORY("Freeing frame buffer %d at %p.\n", i, pdev->fbuf[i].data);
L
Linus Torvalds 已提交
356 357 358 359 360 361 362 363 364 365
				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) {
366
		PWC_DEBUG_MEMORY("Freeing decompression buffer at %p.\n", pdev->decompress_data);
L
Linus Torvalds 已提交
367 368 369 370 371 372
		kfree(pdev->decompress_data);
		pdev->decompress_data = NULL;
	}

	/* Release image buffers */
	if (pdev->image_data != NULL) {
373 374
		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 已提交
375 376
	}
	pdev->image_data = NULL;
377

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

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

   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
387
   interesting. Suffices to say the data from this buffer is quickly
L
Linus Torvalds 已提交
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 416
   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.
417 418
     * 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 已提交
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
       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.
 */
438
static int pwc_next_fill_frame(struct pwc_device *pdev)
L
Linus Torvalds 已提交
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 464
{
	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) {
465
			PWC_ERROR("Neither empty or full frames available!\n");
L
Linus Torvalds 已提交
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
			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;

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

L
Linus Torvalds 已提交
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
	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);
510

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


/**
  \brief Do all the handling for getting one frame: get pointer, decompress, advance pointers.
 */
518
int pwc_handle_frame(struct pwc_device *pdev)
L
Linus Torvalds 已提交
519 520 521 522 523 524 525 526 527
{
	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 */
528 529 530 531 532 533 534 535
		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 已提交
536 537
	}
	else {
538 539 540 541 542 543
		pdev->read_frame = pdev->full_frames;
		pdev->full_frames = pdev->full_frames->next;
		pdev->read_frame->next = NULL;
	}

	if (pdev->read_frame != NULL) {
544
		/* Decompression is a lengthy process, so it's outside of the lock.
545 546 547 548 549 550 551 552 553 554 555
		   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 已提交
556 557
		}
		else {
558 559
			pdev->empty_frames_tail->next = pdev->read_frame;
			pdev->empty_frames_tail = pdev->read_frame;
L
Linus Torvalds 已提交
560
		}
561
		pdev->read_frame = NULL;
L
Linus Torvalds 已提交
562 563 564 565 566 567 568 569
	}
	spin_unlock_irqrestore(&pdev->ptrlock, flags);
	return ret;
}

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

576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
/**
 * 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);
}

593 594 595 596 597 598 599 600 601 602 603
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) {
604
		input_report_key(pdev->button_dev, KEY_CAMERA, down);
605 606 607 608 609
		input_sync(pdev->button_dev);
	}
#endif
}

610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
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) {
627
			pwc_snapshot_button(pdev, ptr[0] & 0x01);
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
		}
		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) {
651
			pwc_snapshot_button(pdev, ptr[0] & 0x01);
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 683
		}
		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 已提交
684 685 686 687

/* 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.
 */
688
static void pwc_isoc_handler(struct urb *urb)
L
Linus Torvalds 已提交
689 690 691 692 693 694 695 696 697 698
{
	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) {
699
		PWC_ERROR("isoc_handler() called with NULL device?!\n");
L
Linus Torvalds 已提交
700 701
		return;
	}
702

L
Linus Torvalds 已提交
703
	if (urb->status == -ENOENT || urb->status == -ECONNRESET) {
704
		PWC_DEBUG_OPEN("URB (%p) unlinked %ssynchronuously.\n", urb, urb->status == -ENOENT ? "" : "a");
L
Linus Torvalds 已提交
705 706 707 708 709 710 711 712 713 714 715 716
		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;
717
			case -ETIME:		errmsg = "Device does not respond"; break;
L
Linus Torvalds 已提交
718
		}
719
		PWC_DEBUG_FLOW("pwc_isoc_handler() called with status %d [%s].\n", urb->status, errmsg);
720
		/* Give up after a number of contiguous errors on the USB bus.
L
Linus Torvalds 已提交
721 722 723 724
		   Appearantly something is wrong so we simulate an unplug event.
		 */
		if (++pdev->visoc_errors > MAX_ISOC_ERRORS)
		{
725
			PWC_INFO("Too many ISOC errors, bailing out.\n");
L
Linus Torvalds 已提交
726 727 728 729 730 731 732 733 734
			pdev->error_status = EIO;
			awake = 1;
			wake_up_interruptible(&pdev->frameq);
		}
		goto handler_end; // ugly, but practical
	}

	fbuf = pdev->fill_frame;
	if (fbuf == NULL) {
735
		PWC_ERROR("pwc_isoc_handler without valid fill frame.\n");
L
Linus Torvalds 已提交
736 737 738 739 740 741 742 743 744 745 746
		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
747 748
		  1 = sync-hunt
		  2 = synched
L
Linus Torvalds 已提交
749 750 751 752 753 754 755 756 757 758 759 760 761
	 */
	/* 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) {
762
						PWC_DEBUG_FLOW("Frame buffer overflow (flen = %d, frame_total_size = %d).\n", flen, pdev->frame_total_size);
L
Linus Torvalds 已提交
763 764 765 766 767 768 769 770 771 772 773 774
						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) {
775
				/* Shorter packet... We probably have the end of an image-frame;
L
Linus Torvalds 已提交
776 777
				   wake up read() process and let select()/poll() do something.
				   Decompression is done in user time over there.
778
				   */
L
Linus Torvalds 已提交
779
				if (pdev->vsync == 2) {
780 781 782
					if (pwc_rcv_short_packet(pdev, fbuf)) {
						awake = 1;
						fbuf = pdev->fill_frame;
L
Linus Torvalds 已提交
783 784 785 786 787
					}
				}
				fbuf->filled = 0;
				fillptr = fbuf->data;
				pdev->vsync = 1;
788 789
			}

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

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

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


813
int pwc_isoc_init(struct pwc_device *pdev)
L
Linus Torvalds 已提交
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
{
	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);
835

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

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

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

	/* Set alternate interface */
	ret = 0;
855
	PWC_DEBUG_OPEN("Setting alternate interface %d\n", pdev->valternate);
L
Linus Torvalds 已提交
856 857 858 859 860 861 862
	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) {
863
			PWC_ERROR("Failed to allocate urb %d\n", i);
L
Linus Torvalds 已提交
864 865 866 867
			ret = -ENOMEM;
			break;
		}
		pdev->sbuf[i].urb = urb;
868
		PWC_DEBUG_MEMORY("Allocated URB at 0x%p\n", urb);
L
Linus Torvalds 已提交
869 870 871
	}
	if (ret) {
		/* De-allocate in reverse order */
M
Mariusz Kozlowski 已提交
872
		while (i--) {
M
Mariusz Kozlowski 已提交
873
			usb_free_urb(pdev->sbuf[i].urb);
L
Linus Torvalds 已提交
874 875 876 877 878
			pdev->sbuf[i].urb = NULL;
		}
		return ret;
	}

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

		urb->interval = 1; // devik
		urb->dev = udev;
885
		urb->pipe = usb_rcvisocpipe(udev, pdev->vendpoint);
L
Linus Torvalds 已提交
886
		urb->transfer_flags = URB_ISO_ASAP;
887 888 889 890
		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 已提交
891 892 893 894 895 896 897 898 899 900 901 902
		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);
		if (ret)
903
			PWC_ERROR("isoc_init() submit_urb %d failed with error %d\n", i, ret);
L
Linus Torvalds 已提交
904
		else
905
			PWC_DEBUG_MEMORY("URB 0x%p submitted.\n", pdev->sbuf[i].urb);
L
Linus Torvalds 已提交
906 907 908 909
	}

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

914
static void pwc_iso_stop(struct pwc_device *pdev)
L
Linus Torvalds 已提交
915 916 917 918 919 920 921 922
{
	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 已提交
923
		if (urb) {
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938
			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 已提交
939
		if (urb) {
940
			PWC_DEBUG_MEMORY("Freeing URB\n");
L
Linus Torvalds 已提交
941 942 943 944
			usb_free_urb(urb);
			pdev->sbuf[i].urb = NULL;
		}
	}
945 946 947 948 949 950 951 952 953 954 955 956
}

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 已提交
957 958

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

	pdev->iso_init = 0;
967
	PWC_DEBUG_OPEN("<< pwc_isoc_cleanup()\n");
L
Linus Torvalds 已提交
968 969 970 971 972 973 974 975 976 977 978 979
}

int pwc_try_video_mode(struct pwc_device *pdev, int width, int height, int new_fps, int new_compression, int new_snapshot)
{
	int ret, start;

	/* Stop isoc stuff */
	pwc_isoc_cleanup(pdev);
	/* Reset parameters */
	pwc_reset_buffers(pdev);
	/* Try to set video mode... */
	start = ret = pwc_set_video_mode(pdev, width, height, new_fps, new_compression, new_snapshot);
980
	if (ret) {
981
		PWC_DEBUG_FLOW("pwc_set_video_mode attempt 1 failed.\n");
L
Linus Torvalds 已提交
982 983 984
		/* That failed... restore old mode (we know that worked) */
		start = pwc_set_video_mode(pdev, pdev->view.x, pdev->view.y, pdev->vframes, pdev->vcompression, pdev->vsnapshot);
		if (start) {
985
			PWC_DEBUG_FLOW("pwc_set_video_mode attempt 2 failed.\n");
L
Linus Torvalds 已提交
986 987 988 989 990 991
		}
	}
	if (start == 0)
	{
		if (pwc_isoc_init(pdev) < 0)
		{
992
			PWC_WARNING("Failed to restart ISOC transfers in pwc_try_video_mode.\n");
L
Linus Torvalds 已提交
993 994 995 996 997 998 999
			ret = -EAGAIN; /* let's try again, who knows if it works a second time */
		}
	}
	pdev->drop_frames++; /* try to avoid garbage during switch */
	return ret; /* Return original error code */
}

1000 1001 1002
/*********
 * sysfs
 *********/
1003
static struct pwc_device *cd_to_pwc(struct device *cd)
1004 1005 1006 1007 1008
{
	struct video_device *vdev = to_video_device(cd);
	return video_get_drvdata(vdev);
}

1009 1010
static ssize_t show_pan_tilt(struct device *class_dev,
			     struct device_attribute *attr, char *buf)
1011 1012 1013 1014 1015
{
	struct pwc_device *pdev = cd_to_pwc(class_dev);
	return sprintf(buf, "%d %d\n", pdev->pan_angle, pdev->tilt_angle);
}

1016 1017 1018
static ssize_t store_pan_tilt(struct device *class_dev,
			      struct device_attribute *attr,
			      const char *buf, size_t count)
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
{
	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);
}
1034 1035
static DEVICE_ATTR(pan_tilt, S_IRUGO | S_IWUSR, show_pan_tilt,
		   store_pan_tilt);
1036

1037 1038
static ssize_t show_snapshot_button_status(struct device *class_dev,
					   struct device_attribute *attr, char *buf)
1039 1040 1041 1042 1043 1044 1045
{
	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);
}

1046 1047
static DEVICE_ATTR(button, S_IRUGO | S_IWUSR, show_snapshot_button_status,
		   NULL);
1048

1049
static int pwc_create_sysfs_files(struct video_device *vdev)
1050 1051
{
	struct pwc_device *pdev = video_get_drvdata(vdev);
1052 1053
	int rc;

1054
	rc = device_create_file(&vdev->dev, &dev_attr_button);
1055 1056 1057
	if (rc)
		goto err;
	if (pdev->features & FEATURE_MOTOR_PANTILT) {
1058
		rc = device_create_file(&vdev->dev, &dev_attr_pan_tilt);
1059 1060 1061 1062 1063 1064
		if (rc) goto err_button;
	}

	return 0;

err_button:
1065
	device_remove_file(&vdev->dev, &dev_attr_button);
1066
err:
1067
	PWC_ERROR("Could not create sysfs files.\n");
1068
	return rc;
1069 1070 1071 1072 1073 1074
}

static void pwc_remove_sysfs_files(struct video_device *vdev)
{
	struct pwc_device *pdev = video_get_drvdata(vdev);
	if (pdev->features & FEATURE_MOTOR_PANTILT)
1075 1076
		device_remove_file(&vdev->dev, &dev_attr_pan_tilt);
	device_remove_file(&vdev->dev, &dev_attr_button);
1077 1078
}

1079
#ifdef CONFIG_USB_PWC_DEBUG
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
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:
1104
			return "unknown type of sensor";
1105 1106 1107
	}
}
#endif
L
Linus Torvalds 已提交
1108 1109 1110 1111

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

1112
static int pwc_video_open(struct file *file)
L
Linus Torvalds 已提交
1113
{
1114
	int i, ret;
L
Linus Torvalds 已提交
1115 1116 1117
	struct video_device *vdev = video_devdata(file);
	struct pwc_device *pdev;

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

1120
	pdev = video_get_drvdata(vdev);
1121
	BUG_ON(!pdev);
1122 1123
	if (pdev->vopen) {
		PWC_DEBUG_OPEN("I'm busy, someone is using the device.\n");
L
Linus Torvalds 已提交
1124
		return -EBUSY;
1125
	}
1126

1127
	mutex_lock(&pdev->modlock);
1128
	pwc_construct(pdev); /* set min/max sizes correct */
L
Linus Torvalds 已提交
1129
	if (!pdev->usb_init) {
1130
		PWC_DEBUG_OPEN("Doing first time initialization.\n");
L
Linus Torvalds 已提交
1131
		pdev->usb_init = 1;
1132

1133 1134 1135
		/* Query sensor type */
		ret = pwc_get_cmos_sensor(pdev, &i);
		if (ret >= 0)
L
Linus Torvalds 已提交
1136
		{
1137 1138 1139
			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 已提交
1140 1141 1142 1143 1144 1145 1146
		}
	}

	/* Turn on camera */
	if (power_save) {
		i = pwc_camera_power(pdev, 1);
		if (i < 0)
1147
			PWC_DEBUG_OPEN("Failed to restore power to the camera! (%d)\n", i);
L
Linus Torvalds 已提交
1148 1149 1150
	}
	/* Set LED on/off time */
	if (pwc_set_leds(pdev, led_on, led_off) < 0)
1151
		PWC_DEBUG_OPEN("Failed to set LED on/off time.\n");
1152

L
Linus Torvalds 已提交
1153 1154 1155 1156

	/* So far, so good. Allocate memory. */
	i = pwc_allocate_buffers(pdev);
	if (i < 0) {
1157 1158
		PWC_DEBUG_OPEN("Failed to allocate buffers memory.\n");
		pwc_free_buffers(pdev);
1159
		mutex_unlock(&pdev->modlock);
L
Linus Torvalds 已提交
1160 1161
		return i;
	}
1162

L
Linus Torvalds 已提交
1163 1164
	/* Reset buffers & parameters */
	pwc_reset_buffers(pdev);
1165
	for (i = 0; i < pwc_mbufs; i++)
L
Linus Torvalds 已提交
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
		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;

	/* Start iso pipe for video; first try the last used video size
	   (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)	{
1183 1184 1185 1186
		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 已提交
1187
		else
1188 1189 1190 1191 1192 1193 1194 1195
			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 已提交
1196 1197
	}
	if (i) {
1198 1199
		PWC_DEBUG_OPEN("Second attempt at set_video_mode failed.\n");
		pwc_free_buffers(pdev);
1200
		mutex_unlock(&pdev->modlock);
L
Linus Torvalds 已提交
1201 1202
		return i;
	}
1203

L
Linus Torvalds 已提交
1204 1205
	i = pwc_isoc_init(pdev);
	if (i) {
1206 1207 1208
		PWC_DEBUG_OPEN("Failed to init ISOC stuff = %d.\n", i);
		pwc_isoc_cleanup(pdev);
		pwc_free_buffers(pdev);
1209
		mutex_unlock(&pdev->modlock);
L
Linus Torvalds 已提交
1210 1211 1212
		return i;
	}

1213 1214 1215 1216
	/* Initialize the webcam to sane value */
	pwc_set_brightness(pdev, 0x7fff);
	pwc_set_agc(pdev, 1, 0);

L
Linus Torvalds 已提交
1217 1218
	pdev->vopen++;
	file->private_data = vdev;
1219
	mutex_unlock(&pdev->modlock);
1220
	PWC_DEBUG_OPEN("<< video_open() returns 0.\n");
L
Linus Torvalds 已提交
1221 1222 1223
	return 0;
}

1224 1225 1226 1227 1228

static void pwc_cleanup(struct pwc_device *pdev)
{
	pwc_remove_sysfs_files(pdev->vdev);
	video_unregister_device(pdev->vdev);
1229 1230 1231 1232 1233 1234 1235 1236 1237

#ifdef CONFIG_USB_PWC_INPUT_EVDEV
	if (pdev->button_dev) {
		input_unregister_device(pdev->button_dev);
		input_free_device(pdev->button_dev);
		kfree(pdev->button_dev->phys);
		pdev->button_dev = NULL;
	}
#endif
1238 1239
}

L
Linus Torvalds 已提交
1240
/* Note that all cleanup is done in the reverse order as in _open */
1241
static int pwc_video_close(struct file *file)
L
Linus Torvalds 已提交
1242 1243 1244
{
	struct video_device *vdev = file->private_data;
	struct pwc_device *pdev;
1245
	int i, hint;
L
Linus Torvalds 已提交
1246

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

1249
	lock_kernel();
1250
	pdev = video_get_drvdata(vdev);
L
Linus Torvalds 已提交
1251
	if (pdev->vopen == 0)
1252
		PWC_DEBUG_MODULE("video_close() called on closed device?\n");
L
Linus Torvalds 已提交
1253 1254 1255 1256 1257 1258

	/* 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)
1259
		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 已提交
1260

1261 1262 1263 1264
	if (DEVICE_USE_CODEC1(pdev->type))
	    pwc_dec1_exit();
	else
	    pwc_dec23_exit();
L
Linus Torvalds 已提交
1265 1266 1267 1268 1269

	pwc_isoc_cleanup(pdev);
	pwc_free_buffers(pdev);

	/* Turn off LEDS and power down camera, but only when not unplugged */
1270
	if (!pdev->unplugged) {
L
Linus Torvalds 已提交
1271 1272
		/* Turn LEDs off */
		if (pwc_set_leds(pdev, 0, 0) < 0)
1273
			PWC_DEBUG_MODULE("Failed to set LED on/off time.\n");
L
Linus Torvalds 已提交
1274 1275 1276
		if (power_save) {
			i = pwc_camera_power(pdev, 0);
			if (i < 0)
1277
				PWC_ERROR("Failed to power down camera (%d)\n", i);
L
Linus Torvalds 已提交
1278
		}
1279
		pdev->vopen--;
1280
		PWC_DEBUG_OPEN("<< video_close() vopen=%d\n", pdev->vopen);
1281 1282 1283 1284 1285 1286 1287 1288
	} else {
		pwc_cleanup(pdev);
		/* Free memory (don't set pdev to 0 just yet) */
		kfree(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 已提交
1289
	}
1290 1291
	unlock_kernel();

L
Linus Torvalds 已提交
1292 1293 1294 1295 1296 1297
	return 0;
}

/*
 *	FIXME: what about two parallel reads ????
 *      ANSWER: Not supported. You can't open the device more than once,
1298 1299 1300 1301 1302 1303 1304
		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 已提交
1305 1306
 */

1307
static ssize_t pwc_video_read(struct file *file, char __user *buf,
L
Linus Torvalds 已提交
1308 1309 1310 1311 1312 1313
			  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);
1314
	int bytes_to_read, rv = 0;
1315
	void *image_buffer_addr;
L
Linus Torvalds 已提交
1316

1317 1318
	PWC_DEBUG_READ("pwc_video_read(vdev=0x%p, buf=%p, count=%zd) called.\n",
			vdev, buf, count);
L
Linus Torvalds 已提交
1319 1320
	if (vdev == NULL)
		return -EFAULT;
1321
	pdev = video_get_drvdata(vdev);
L
Linus Torvalds 已提交
1322 1323
	if (pdev == NULL)
		return -EFAULT;
1324 1325 1326 1327 1328 1329

	mutex_lock(&pdev->modlock);
	if (pdev->error_status) {
		rv = -pdev->error_status; /* Something happened, report what. */
		goto err_out;
	}
L
Linus Torvalds 已提交
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339

	/* 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);
1340 1341
				rv = -pdev->error_status ;
				goto err_out;
L
Linus Torvalds 已提交
1342
			}
1343 1344 1345
			if (noblock) {
				remove_wait_queue(&pdev->frameq, &wait);
				set_current_state(TASK_RUNNING);
1346 1347
				rv = -EWOULDBLOCK;
				goto err_out;
1348 1349 1350 1351
			}
			if (signal_pending(current)) {
				remove_wait_queue(&pdev->frameq, &wait);
				set_current_state(TASK_RUNNING);
1352 1353
				rv = -ERESTARTSYS;
				goto err_out;
1354 1355 1356
			}
			schedule();
			set_current_state(TASK_INTERRUPTIBLE);
L
Linus Torvalds 已提交
1357 1358 1359
		}
		remove_wait_queue(&pdev->frameq, &wait);
		set_current_state(TASK_RUNNING);
1360

L
Linus Torvalds 已提交
1361
		/* Decompress and release frame */
1362 1363 1364 1365
		if (pwc_handle_frame(pdev)) {
			rv = -EFAULT;
			goto err_out;
		}
L
Linus Torvalds 已提交
1366 1367
	}

1368
	PWC_DEBUG_READ("Copying data to user space.\n");
L
Linus Torvalds 已提交
1369
	if (pdev->vpalette == VIDEO_PALETTE_RAW)
1370
		bytes_to_read = pdev->frame_size + sizeof(struct pwc_raw_frame);
L
Linus Torvalds 已提交
1371
	else
1372
		bytes_to_read = pdev->view.size;
L
Linus Torvalds 已提交
1373 1374 1375 1376

	/* 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;
1377 1378 1379
	image_buffer_addr = pdev->image_data;
	image_buffer_addr += pdev->images[pdev->fill_image].offset;
	image_buffer_addr += pdev->image_read_pos;
1380 1381 1382 1383
	if (copy_to_user(buf, image_buffer_addr, count)) {
		rv = -EFAULT;
		goto err_out;
	}
L
Linus Torvalds 已提交
1384 1385 1386 1387 1388
	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);
	}
1389
	mutex_unlock(&pdev->modlock);
L
Linus Torvalds 已提交
1390
	return count;
1391 1392 1393
err_out:
	mutex_unlock(&pdev->modlock);
	return rv;
L
Linus Torvalds 已提交
1394 1395 1396 1397 1398 1399 1400 1401 1402
}

static unsigned int pwc_video_poll(struct file *file, poll_table *wait)
{
	struct video_device *vdev = file->private_data;
	struct pwc_device *pdev;

	if (vdev == NULL)
		return -EFAULT;
1403
	pdev = video_get_drvdata(vdev);
L
Linus Torvalds 已提交
1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415
	if (pdev == NULL)
		return -EFAULT;

	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;
}

1416
static long pwc_video_ioctl(struct file *file,
L
Linus Torvalds 已提交
1417 1418
			   unsigned int cmd, unsigned long arg)
{
1419 1420
	struct video_device *vdev = file->private_data;
	struct pwc_device *pdev;
1421
	long r = -ENODEV;
1422 1423 1424

	if (!vdev)
		goto out;
1425
	pdev = video_get_drvdata(vdev);
1426 1427 1428

	mutex_lock(&pdev->modlock);
	if (!pdev->unplugged)
1429
		r = video_usercopy(file, cmd, arg, pwc_video_do_ioctl);
1430 1431 1432
	mutex_unlock(&pdev->modlock);
out:
	return r;
L
Linus Torvalds 已提交
1433 1434 1435 1436 1437 1438
}

static int pwc_video_mmap(struct file *file, struct vm_area_struct *vma)
{
	struct video_device *vdev = file->private_data;
	struct pwc_device *pdev;
1439 1440 1441 1442
	unsigned long start;
	unsigned long size;
	unsigned long page, pos = 0;
	int index;
1443

1444
	PWC_DEBUG_MEMORY(">> %s\n", __func__);
1445
	pdev = video_get_drvdata(vdev);
1446 1447
	size = vma->vm_end - vma->vm_start;
	start = vma->vm_start;
1448

1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
	/* 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 已提交
1473

1474
	pos += (unsigned long)pdev->image_data;
L
Linus Torvalds 已提交
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500
	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;
1501
	int i, hint, rc;
L
Linus Torvalds 已提交
1502 1503 1504
	int features = 0;
	int video_nr = -1; /* default: use next available device */
	char serial_number[30], *name;
1505 1506 1507
#ifdef CONFIG_USB_PWC_INPUT_EVDEV
	char *phys = NULL;
#endif
L
Linus Torvalds 已提交
1508

1509 1510 1511
	vendor_id = le16_to_cpu(udev->descriptor.idVendor);
	product_id = le16_to_cpu(udev->descriptor.idProduct);

L
Linus Torvalds 已提交
1512
	/* Check if we can handle this device */
1513 1514
	PWC_DEBUG_PROBE("probe() called [%04X %04X], if %d\n",
		vendor_id, product_id,
L
Linus Torvalds 已提交
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526
		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:
1527
			PWC_INFO("Philips PCA645VC USB webcam detected.\n");
L
Linus Torvalds 已提交
1528 1529 1530 1531
			name = "Philips 645 webcam";
			type_id = 645;
			break;
		case 0x0303:
1532
			PWC_INFO("Philips PCA646VC USB webcam detected.\n");
L
Linus Torvalds 已提交
1533 1534 1535 1536
			name = "Philips 646 webcam";
			type_id = 646;
			break;
		case 0x0304:
1537
			PWC_INFO("Askey VC010 type 2 USB webcam detected.\n");
L
Linus Torvalds 已提交
1538 1539 1540 1541
			name = "Askey VC010 webcam";
			type_id = 646;
			break;
		case 0x0307:
1542
			PWC_INFO("Philips PCVC675K (Vesta) USB webcam detected.\n");
L
Linus Torvalds 已提交
1543 1544 1545 1546
			name = "Philips 675 webcam";
			type_id = 675;
			break;
		case 0x0308:
1547
			PWC_INFO("Philips PCVC680K (Vesta Pro) USB webcam detected.\n");
L
Linus Torvalds 已提交
1548 1549 1550 1551
			name = "Philips 680 webcam";
			type_id = 680;
			break;
		case 0x030C:
1552
			PWC_INFO("Philips PCVC690K (Vesta Pro Scan) USB webcam detected.\n");
L
Linus Torvalds 已提交
1553 1554 1555 1556
			name = "Philips 690 webcam";
			type_id = 690;
			break;
		case 0x0310:
1557
			PWC_INFO("Philips PCVC730K (ToUCam Fun)/PCVC830 (ToUCam II) USB webcam detected.\n");
L
Linus Torvalds 已提交
1558 1559 1560 1561
			name = "Philips 730 webcam";
			type_id = 730;
			break;
		case 0x0311:
1562
			PWC_INFO("Philips PCVC740K (ToUCam Pro)/PCVC840 (ToUCam II) USB webcam detected.\n");
L
Linus Torvalds 已提交
1563 1564 1565 1566
			name = "Philips 740 webcam";
			type_id = 740;
			break;
		case 0x0312:
1567
			PWC_INFO("Philips PCVC750K (ToUCam Pro Scan) USB webcam detected.\n");
L
Linus Torvalds 已提交
1568 1569 1570 1571
			name = "Philips 750 webcam";
			type_id = 750;
			break;
		case 0x0313:
1572
			PWC_INFO("Philips PCVC720K/40 (ToUCam XS) USB webcam detected.\n");
L
Linus Torvalds 已提交
1573 1574 1575
			name = "Philips 720K/40 webcam";
			type_id = 720;
			break;
1576 1577 1578
		case 0x0329:
			PWC_INFO("Philips SPC 900NC USB webcam detected.\n");
			name = "Philips SPC 900NC webcam";
1579
			type_id = 740;
1580
			break;
L
Linus Torvalds 已提交
1581 1582 1583 1584 1585 1586 1587 1588
		default:
			return -ENODEV;
			break;
		}
	}
	else if (vendor_id == 0x069A) {
		switch(product_id) {
		case 0x0001:
1589
			PWC_INFO("Askey VC010 type 1 USB webcam detected.\n");
L
Linus Torvalds 已提交
1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600
			name = "Askey VC010 webcam";
			type_id = 645;
			break;
		default:
			return -ENODEV;
			break;
		}
	}
	else if (vendor_id == 0x046d) {
		switch(product_id) {
		case 0x08b0:
1601
			PWC_INFO("Logitech QuickCam Pro 3000 USB webcam detected.\n");
L
Linus Torvalds 已提交
1602 1603 1604 1605
			name = "Logitech QuickCam Pro 3000";
			type_id = 740; /* CCD sensor */
			break;
		case 0x08b1:
1606
			PWC_INFO("Logitech QuickCam Notebook Pro USB webcam detected.\n");
L
Linus Torvalds 已提交
1607 1608 1609 1610
			name = "Logitech QuickCam Notebook Pro";
			type_id = 740; /* CCD sensor */
			break;
		case 0x08b2:
1611
			PWC_INFO("Logitech QuickCam 4000 Pro USB webcam detected.\n");
L
Linus Torvalds 已提交
1612 1613 1614 1615
			name = "Logitech QuickCam Pro 4000";
			type_id = 740; /* CCD sensor */
			break;
		case 0x08b3:
1616
			PWC_INFO("Logitech QuickCam Zoom USB webcam detected.\n");
L
Linus Torvalds 已提交
1617 1618 1619 1620
			name = "Logitech QuickCam Zoom";
			type_id = 740; /* CCD sensor */
			break;
		case 0x08B4:
1621
			PWC_INFO("Logitech QuickCam Zoom (new model) USB webcam detected.\n");
L
Linus Torvalds 已提交
1622 1623
			name = "Logitech QuickCam Zoom";
			type_id = 740; /* CCD sensor */
1624
			power_save = 1;
L
Linus Torvalds 已提交
1625 1626
			break;
		case 0x08b5:
1627
			PWC_INFO("Logitech QuickCam Orbit/Sphere USB webcam detected.\n");
L
Linus Torvalds 已提交
1628 1629 1630 1631 1632
			name = "Logitech QuickCam Orbit";
			type_id = 740; /* CCD sensor */
			features |= FEATURE_MOTOR_PANTILT;
			break;
		case 0x08b6:
1633 1634 1635 1636
			PWC_INFO("Logitech/Cisco VT Camera webcam detected.\n");
			name = "Cisco VT Camera";
			type_id = 740; /* CCD sensor */
			break;
L
Linus Torvalds 已提交
1637
		case 0x08b7:
1638 1639 1640 1641 1642
			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? */
1643
			PWC_INFO("Logitech QuickCam detected (reserved ID).\n");
L
Linus Torvalds 已提交
1644 1645 1646
			name = "Logitech QuickCam (res.)";
			type_id = 730; /* Assuming CMOS */
			break;
1647
		default:
L
Linus Torvalds 已提交
1648
			return -ENODEV;
1649 1650 1651
			break;
		}
	}
L
Linus Torvalds 已提交
1652 1653 1654 1655 1656 1657 1658
	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:
1659
			PWC_INFO("Samsung MPC-C10 USB webcam detected.\n");
L
Linus Torvalds 已提交
1660 1661 1662 1663
			name = "Samsung MPC-C10";
			type_id = 675;
			break;
		case 0x9001:
1664
			PWC_INFO("Samsung MPC-C30 USB webcam detected.\n");
L
Linus Torvalds 已提交
1665 1666 1667
			name = "Samsung MPC-C30";
			type_id = 675;
			break;
1668 1669 1670 1671 1672
		case 0x9002:
			PWC_INFO("Samsung SNC-35E (v3.0) USB webcam detected.\n");
			name = "Samsung MPC-C30";
			type_id = 740;
			break;
L
Linus Torvalds 已提交
1673 1674 1675 1676 1677 1678 1679 1680
		default:
			return -ENODEV;
			break;
		}
	}
	else if (vendor_id == 0x041e) {
		switch(product_id) {
		case 0x400c:
1681
			PWC_INFO("Creative Labs Webcam 5 detected.\n");
L
Linus Torvalds 已提交
1682 1683 1684 1685
			name = "Creative Labs Webcam 5";
			type_id = 730;
			break;
		case 0x4011:
1686
			PWC_INFO("Creative Labs Webcam Pro Ex detected.\n");
L
Linus Torvalds 已提交
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697
			name = "Creative Labs Webcam Pro Ex";
			type_id = 740;
			break;
		default:
			return -ENODEV;
			break;
		}
	}
	else if (vendor_id == 0x04cc) {
		switch(product_id) {
		case 0x8116:
1698
			PWC_INFO("Sotec Afina Eye USB webcam detected.\n");
L
Linus Torvalds 已提交
1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710
			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 */
1711
			PWC_INFO("AME Co. Afina Eye USB webcam detected.\n");
L
Linus Torvalds 已提交
1712 1713 1714 1715 1716 1717 1718
			name = "AME Co. Afina Eye";
			type_id = 750;
			break;
		default:
			return -ENODEV;
			break;
		}
1719

L
Linus Torvalds 已提交
1720 1721 1722 1723
	}
	else if (vendor_id == 0x0d81) {
		switch(product_id) {
		case 0x1900:
1724
			PWC_INFO("Visionite VCS-UC300 USB webcam detected.\n");
L
Linus Torvalds 已提交
1725 1726 1727 1728
			name = "Visionite VCS-UC300";
			type_id = 740; /* CCD sensor */
			break;
		case 0x1910:
1729
			PWC_INFO("Visionite VCS-UM100 USB webcam detected.\n");
L
Linus Torvalds 已提交
1730 1731 1732 1733 1734 1735 1736 1737
			name = "Visionite VCS-UM100";
			type_id = 730; /* CMOS sensor */
			break;
		default:
			return -ENODEV;
			break;
		}
	}
1738
	else
L
Linus Torvalds 已提交
1739 1740 1741 1742
		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);
1743
	PWC_DEBUG_PROBE("Device serial number is %s\n", serial_number);
L
Linus Torvalds 已提交
1744 1745

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

	/* Allocate structure, initialize pointers, mutexes, etc. and link it to the usb_device */
1749
	pdev = kzalloc(sizeof(struct pwc_device), GFP_KERNEL);
L
Linus Torvalds 已提交
1750
	if (pdev == NULL) {
1751
		PWC_ERROR("Oops, could not allocate memory for pwc_device.\n");
L
Linus Torvalds 已提交
1752 1753 1754 1755 1756 1757 1758 1759 1760 1761
		return -ENOMEM;
	}
	pdev->type = type_id;
	pdev->vsize = default_size;
	pdev->vframes = default_fps;
	strcpy(pdev->serial, serial_number);
	pdev->features = features;
	if (vendor_id == 0x046D && product_id == 0x08B5)
	{
		/* Logitech QuickCam Orbit
1762 1763 1764
		   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 已提交
1765 1766 1767 1768 1769 1770
		pdev->angle_range.pan_min  = -7000;
		pdev->angle_range.pan_max  =  7000;
		pdev->angle_range.tilt_min = -3000;
		pdev->angle_range.tilt_max =  2500;
	}

1771
	mutex_init(&pdev->modlock);
L
Linus Torvalds 已提交
1772 1773 1774 1775 1776 1777 1778 1779
	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 已提交
1780
	if (!pdev->vdev) {
1781
		PWC_ERROR("Err, cannot allocate video_device struture. Failing probe.");
L
Linus Torvalds 已提交
1782 1783 1784 1785
		kfree(pdev);
		return -ENOMEM;
	}
	memcpy(pdev->vdev, &pwc_template, sizeof(pwc_template));
1786
	pdev->vdev->parent = &intf->dev;
L
Linus Torvalds 已提交
1787 1788 1789 1790
	strcpy(pdev->vdev->name, name);
	video_set_drvdata(pdev->vdev, pdev);

	pdev->release = le16_to_cpu(udev->descriptor.bcdDevice);
1791
	PWC_DEBUG_PROBE("Release: %04x\n", pdev->release);
L
Linus Torvalds 已提交
1792 1793 1794 1795 1796 1797 1798

	/* 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)) {
1799 1800 1801 1802
				/* 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 已提交
1803 1804 1805 1806 1807 1808 1809
			}
		}
	}

	pdev->vdev->release = video_device_release;
	i = video_register_device(pdev->vdev, VFL_TYPE_GRABBER, video_nr);
	if (i < 0) {
1810
		PWC_ERROR("Failed to register as video device (%d).\n", i);
1811 1812
		rc = i;
		goto err;
L
Linus Torvalds 已提交
1813 1814
	}
	else {
1815
		PWC_INFO("Registered as /dev/video%d.\n", pdev->vdev->num);
L
Linus Torvalds 已提交
1816 1817 1818
	}

	/* occupy slot */
1819
	if (hint < MAX_DEV_HINTS)
L
Linus Torvalds 已提交
1820 1821
		device_hint[hint].pdev = pdev;

1822
	PWC_DEBUG_PROBE("probe() function returning struct at 0x%p.\n", pdev);
L
Linus Torvalds 已提交
1823
	usb_set_intfdata (intf, pdev);
1824 1825 1826
	rc = pwc_create_sysfs_files(pdev->vdev);
	if (rc)
		goto err_unreg;
1827 1828 1829 1830 1831

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

1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849
#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.");
		return -ENOMEM;
	}

	pdev->button_dev->name = "PWC snapshot button";
	phys = kasprintf(GFP_KERNEL,"usb-%s-%s", pdev->udev->bus->bus_name, pdev->udev->devpath);
	if (!phys) {
		input_free_device(pdev->button_dev);
		return -ENOMEM;
	}
	pdev->button_dev->phys = phys;
	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);
1850
	pdev->button_dev->keybit[BIT_WORD(KEY_CAMERA)] = BIT_MASK(KEY_CAMERA);
1851 1852 1853 1854 1855 1856 1857 1858 1859 1860

	rc = input_register_device(pdev->button_dev);
	if (rc) {
		input_free_device(pdev->button_dev);
		kfree(pdev->button_dev->phys);
		pdev->button_dev = NULL;
		return rc;
	}
#endif

L
Linus Torvalds 已提交
1861
	return 0;
1862 1863 1864 1865 1866 1867 1868 1869 1870

err_unreg:
	if (hint < MAX_DEV_HINTS)
		device_hint[hint].pdev = NULL;
	video_unregister_device(pdev->vdev);
err:
	video_device_release(pdev->vdev); /* Drip... drip... drip... */
	kfree(pdev); /* Oops, no memory leaks please */
	return rc;
L
Linus Torvalds 已提交
1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882
}

/* The user janked out the cable... */
static void usb_pwc_disconnect(struct usb_interface *intf)
{
	struct pwc_device *pdev;
	int hint;

	lock_kernel();
	pdev = usb_get_intfdata (intf);
	usb_set_intfdata (intf, NULL);
	if (pdev == NULL) {
1883
		PWC_ERROR("pwc_disconnect() Called without private pointer.\n");
L
Linus Torvalds 已提交
1884 1885 1886
		goto disconnect_out;
	}
	if (pdev->udev == NULL) {
1887
		PWC_ERROR("pwc_disconnect() already called for %p\n", pdev);
L
Linus Torvalds 已提交
1888 1889 1890
		goto disconnect_out;
	}
	if (pdev->udev != interface_to_usbdev(intf)) {
1891
		PWC_ERROR("pwc_disconnect() Woops: pointer mismatch udev/pdev.\n");
L
Linus Torvalds 已提交
1892 1893
		goto disconnect_out;
	}
1894

L
Linus Torvalds 已提交
1895 1896
	/* We got unplugged; this is signalled by an EPIPE error code */
	if (pdev->vopen) {
1897
		PWC_INFO("Disconnected while webcam is in use!\n");
L
Linus Torvalds 已提交
1898 1899 1900 1901 1902 1903
		pdev->error_status = EPIPE;
	}

	/* Alert waiting processes */
	wake_up_interruptible(&pdev->frameq);
	/* Wait until device is closed */
1904
	if(pdev->vopen) {
1905
		mutex_lock(&pdev->modlock);
1906
		pdev->unplugged = 1;
1907 1908
		mutex_unlock(&pdev->modlock);
		pwc_iso_stop(pdev);
1909 1910 1911 1912 1913 1914
	} else {
		/* Device is closed, so we can safely unregister it */
		PWC_DEBUG_PROBE("Unregistering video device in disconnect().\n");
		pwc_cleanup(pdev);
		/* Free memory (don't set pdev to 0 just yet) */
		kfree(pdev);
L
Linus Torvalds 已提交
1915 1916

disconnect_out:
1917 1918 1919 1920 1921
		/* 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 已提交
1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939

	unlock_kernel();
}

/* *grunt* We have to do atoi ourselves :-( */
static int pwc_atoi(const char *s)
{
	int k = 0;

	k = 0;
	while (*s != '\0' && *s >= '0' && *s <= '9') {
		k = 10 * k + (*s - '0');
		s++;
	}
	return k;
}


1940 1941
/*
 * Initialization code & module stuff
L
Linus Torvalds 已提交
1942 1943
 */

1944 1945 1946 1947
static char *size;
static int fps;
static int fbufs;
static int mbufs;
L
Linus Torvalds 已提交
1948 1949
static int compression = -1;
static int leds[2] = { -1, -1 };
1950
static unsigned int leds_nargs;
1951
static char *dev_hint[MAX_DEV_HINTS];
1952
static unsigned int dev_hint_nargs;
1953 1954 1955 1956 1957

module_param(size, charp, 0444);
module_param(fps, int, 0444);
module_param(fbufs, int, 0444);
module_param(mbufs, int, 0444);
1958
#ifdef CONFIG_USB_PWC_DEBUG
1959 1960 1961 1962 1963 1964
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 已提交
1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978

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");
MODULE_PARM_DESC(trace, "For debugging purposes");
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");
1979 1980
MODULE_ALIAS("pwcx");
MODULE_VERSION( PWC_VERSION );
L
Linus Torvalds 已提交
1981 1982 1983 1984 1985 1986

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

1987 1988 1989 1990
	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 已提交
1991 1992 1993

	if (fps) {
		if (fps < 4 || fps > 30) {
1994
			PWC_ERROR("Framerate out of bounds (4-30).\n");
L
Linus Torvalds 已提交
1995 1996 1997
			return -EINVAL;
		}
		default_fps = fps;
1998
		PWC_DEBUG_MODULE("Default framerate set to %d.\n", default_fps);
L
Linus Torvalds 已提交
1999 2000
	}

2001
	if (size) {
L
Linus Torvalds 已提交
2002 2003 2004 2005 2006 2007 2008 2009
		/* 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) {
2010
			PWC_ERROR("Size not recognized; try size=[sqcif | qsif | qcif | sif | cif | vga].\n");
L
Linus Torvalds 已提交
2011 2012
			return -EINVAL;
		}
2013
		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 已提交
2014 2015 2016
	}
	if (mbufs) {
		if (mbufs < 1 || mbufs > MAX_IMAGES) {
2017
			PWC_ERROR("Illegal number of mmap() buffers; use a number between 1 and %d.\n", MAX_IMAGES);
L
Linus Torvalds 已提交
2018 2019
			return -EINVAL;
		}
2020 2021
		pwc_mbufs = mbufs;
		PWC_DEBUG_MODULE("Number of image buffers set to %d.\n", pwc_mbufs);
L
Linus Torvalds 已提交
2022 2023 2024
	}
	if (fbufs) {
		if (fbufs < 2 || fbufs > MAX_FRAMES) {
2025
			PWC_ERROR("Illegal number of frame buffers; use a number between 2 and %d.\n", MAX_FRAMES);
L
Linus Torvalds 已提交
2026 2027 2028
			return -EINVAL;
		}
		default_fbufs = fbufs;
2029
		PWC_DEBUG_MODULE("Number of frame buffers set to %d.\n", default_fbufs);
L
Linus Torvalds 已提交
2030
	}
2031
#ifdef CONFIG_USB_PWC_DEBUG
2032 2033
	if (pwc_trace >= 0) {
		PWC_DEBUG_MODULE("Trace options: 0x%04x\n", pwc_trace);
L
Linus Torvalds 已提交
2034
	}
2035
#endif
L
Linus Torvalds 已提交
2036 2037
	if (compression >= 0) {
		if (compression > 3) {
2038
			PWC_ERROR("Invalid compression setting; use a number between 0 (uncompressed) and 3 (high).\n");
L
Linus Torvalds 已提交
2039 2040 2041
			return -EINVAL;
		}
		pwc_preferred_compression = compression;
2042
		PWC_DEBUG_MODULE("Preferred compression set to %d.\n", pwc_preferred_compression);
L
Linus Torvalds 已提交
2043 2044
	}
	if (power_save)
2045
		PWC_DEBUG_MODULE("Enabling power save on open/close.\n");
L
Linus Torvalds 已提交
2046 2047 2048 2049 2050
	if (leds[0] >= 0)
		led_on = leds[0];
	if (leds[1] >= 0)
		led_off = leds[1];

2051
	/* Big device node whoopla. Basically, it allows you to assign a
L
Linus Torvalds 已提交
2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075
	   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) {
2076
				PWC_ERROR("Malformed camera hint: the colon must be after the dot.\n");
L
Linus Torvalds 已提交
2077 2078 2079 2080 2081 2082
				return -EINVAL;
			}

			if (*colon == '\0') {
				/* No colon */
				if (*dot != '\0') {
2083
					PWC_ERROR("Malformed camera hint: no colon + device node given.\n");
L
Linus Torvalds 已提交
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097
					return -EINVAL;
				}
				else {
					/* No type or serial number specified, just a number. */
					device_hint[i].device_node = pwc_atoi(s);
				}
			}
			else {
				/* There's a colon, so we have at least a type and a device node */
				device_hint[i].type = pwc_atoi(s);
				device_hint[i].device_node = pwc_atoi(colon + 1);
				if (*dot != '\0') {
					/* There's a serial number as well */
					int k;
2098

L
Linus Torvalds 已提交
2099 2100 2101 2102 2103 2104 2105 2106 2107
					dot++;
					k = 0;
					while (*dot != ':' && k < 29) {
						device_hint[i].serial_number[k++] = *dot;
						dot++;
					}
					device_hint[i].serial_number[k] = '\0';
				}
			}
2108 2109 2110 2111
			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 已提交
2112 2113 2114 2115 2116
		}
		else
			device_hint[i].type = 0; /* not filled */
	} /* ..for MAX_DEV_HINTS */

2117
	PWC_DEBUG_PROBE("Registering driver at address 0x%p.\n", &pwc_driver);
L
Linus Torvalds 已提交
2118 2119 2120 2121 2122
	return usb_register(&pwc_driver);
}

static void __exit usb_pwc_exit(void)
{
2123
	PWC_DEBUG_MODULE("Deregistering driver.\n");
L
Linus Torvalds 已提交
2124
	usb_deregister(&pwc_driver);
2125
	PWC_INFO("Philips webcam module removed.\n");
L
Linus Torvalds 已提交
2126 2127 2128 2129 2130
}

module_init(usb_pwc_init);
module_exit(usb_pwc_exit);

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