gspca.c 59.9 KB
Newer Older
1 2 3
/*
 * Main USB camera driver
 *
4
 * Copyright (C) 2008-2010 Jean-François Moine <http://moinejf.free.fr>
5
 *
6 7 8
 * Camera button input handling by Márton Németh
 * Copyright (C) 2009-2010 Márton Németh <nm127@freemail.hu>
 *
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#define MODULE_NAME "gspca"

#include <linux/init.h>
27
#include <linux/version.h>
28 29 30 31 32 33 34
#include <linux/fs.h>
#include <linux/vmalloc.h>
#include <linux/sched.h>
#include <linux/slab.h>
#include <linux/mm.h>
#include <linux/string.h>
#include <linux/pagemap.h>
35
#include <linux/io.h>
36
#include <asm/page.h>
37
#include <linux/uaccess.h>
38
#include <linux/ktime.h>
39
#include <media/v4l2-ioctl.h>
40 41 42

#include "gspca.h"

43
#if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
44 45
#include <linux/input.h>
#include <linux/usb/input.h>
46
#endif
47

48
/* global values */
49 50 51 52
#define DEF_NURBS 3		/* default number of URBs */
#if DEF_NURBS > MAX_NURBS
#error "DEF_NURBS too big"
#endif
53

54
MODULE_AUTHOR("Jean-François Moine <http://moinejf.free.fr>");
55 56 57
MODULE_DESCRIPTION("GSPCA USB Camera Driver");
MODULE_LICENSE("GPL");

58
#define DRIVER_VERSION_NUMBER	KERNEL_VERSION(2, 10, 0)
59

60
#ifdef GSPCA_DEBUG
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
int gspca_debug = D_ERR | D_PROBE;
EXPORT_SYMBOL(gspca_debug);

static void PDEBUG_MODE(char *txt, __u32 pixfmt, int w, int h)
{
	if ((pixfmt >> 24) >= '0' && (pixfmt >> 24) <= 'z') {
		PDEBUG(D_CONF|D_STREAM, "%s %c%c%c%c %dx%d",
			txt,
			pixfmt & 0xff,
			(pixfmt >> 8) & 0xff,
			(pixfmt >> 16) & 0xff,
			pixfmt >> 24,
			w, h);
	} else {
		PDEBUG(D_CONF|D_STREAM, "%s 0x%08x %dx%d",
			txt,
			pixfmt,
			w, h);
	}
}
#else
#define PDEBUG_MODE(txt, pixfmt, w, h)
#endif

85
/* specific memory types - !! should be different from V4L2_MEMORY_xxx */
86 87 88 89 90
#define GSPCA_MEMORY_NO 0	/* V4L2_MEMORY_xxx starts from 1 */
#define GSPCA_MEMORY_READ 7

#define BUF_ALL_FLAGS (V4L2_BUF_FLAG_QUEUED | V4L2_BUF_FLAG_DONE)

91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
/*
 * VMA operations.
 */
static void gspca_vm_open(struct vm_area_struct *vma)
{
	struct gspca_frame *frame = vma->vm_private_data;

	frame->vma_use_count++;
	frame->v4l2_buf.flags |= V4L2_BUF_FLAG_MAPPED;
}

static void gspca_vm_close(struct vm_area_struct *vma)
{
	struct gspca_frame *frame = vma->vm_private_data;

	if (--frame->vma_use_count <= 0)
		frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_MAPPED;
}

110
static const struct vm_operations_struct gspca_vm_ops = {
111 112 113 114
	.open		= gspca_vm_open,
	.close		= gspca_vm_close,
};

115 116 117
/*
 * Input and interrupt endpoint handling functions
 */
118
#if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
static void int_irq(struct urb *urb)
{
	struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
	int ret;

	ret = urb->status;
	switch (ret) {
	case 0:
		if (gspca_dev->sd_desc->int_pkt_scan(gspca_dev,
		    urb->transfer_buffer, urb->actual_length) < 0) {
			PDEBUG(D_ERR, "Unknown packet received");
		}
		break;

	case -ENOENT:
	case -ECONNRESET:
	case -ENODEV:
	case -ESHUTDOWN:
		/* Stop is requested either by software or hardware is gone,
		 * keep the ret value non-zero and don't resubmit later.
		 */
		break;

	default:
		PDEBUG(D_ERR, "URB error %i, resubmitting", urb->status);
		urb->status = 0;
		ret = 0;
	}

	if (ret == 0) {
		ret = usb_submit_urb(urb, GFP_ATOMIC);
		if (ret < 0)
151
			err("Resubmit URB failed with error %i", ret);
152 153 154 155 156 157 158 159 160
	}
}

static int gspca_input_connect(struct gspca_dev *dev)
{
	struct input_dev *input_dev;
	int err = 0;

	dev->input_dev = NULL;
161
	if (dev->sd_desc->int_pkt_scan || dev->sd_desc->other_input)  {
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
		input_dev = input_allocate_device();
		if (!input_dev)
			return -ENOMEM;

		usb_make_path(dev->dev, dev->phys, sizeof(dev->phys));
		strlcat(dev->phys, "/input0", sizeof(dev->phys));

		input_dev->name = dev->sd_desc->name;
		input_dev->phys = dev->phys;

		usb_to_input_id(dev->dev, &input_dev->id);

		input_dev->evbit[0] = BIT_MASK(EV_KEY);
		input_dev->keybit[BIT_WORD(KEY_CAMERA)] = BIT_MASK(KEY_CAMERA);
		input_dev->dev.parent = &dev->dev->dev;

		err = input_register_device(input_dev);
		if (err) {
180 181
			err("Input device registration failed with error %i",
				err);
182 183 184 185 186
			input_dev->dev.parent = NULL;
			input_free_device(input_dev);
		} else {
			dev->input_dev = input_dev;
		}
187
	}
188 189 190 191 192 193 194 195 196 197 198 199 200 201

	return err;
}

static int alloc_and_submit_int_urb(struct gspca_dev *gspca_dev,
			  struct usb_endpoint_descriptor *ep)
{
	unsigned int buffer_len;
	int interval;
	struct urb *urb;
	struct usb_device *dev;
	void *buffer = NULL;
	int ret = -EINVAL;

202
	buffer_len = le16_to_cpu(ep->wMaxPacketSize);
203
	interval = ep->bInterval;
204
	PDEBUG(D_CONF, "found int in endpoint: 0x%x, "
205 206 207 208 209 210 211 212 213 214 215
		"buffer_len=%u, interval=%u",
		ep->bEndpointAddress, buffer_len, interval);

	dev = gspca_dev->dev;

	urb = usb_alloc_urb(0, GFP_KERNEL);
	if (!urb) {
		ret = -ENOMEM;
		goto error;
	}

216
	buffer = usb_alloc_coherent(dev, buffer_len,
217 218 219 220 221 222 223 224 225
				GFP_KERNEL, &urb->transfer_dma);
	if (!buffer) {
		ret = -ENOMEM;
		goto error_buffer;
	}
	usb_fill_int_urb(urb, dev,
		usb_rcvintpipe(dev, ep->bEndpointAddress),
		buffer, buffer_len,
		int_irq, (void *)gspca_dev, interval);
226
	urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
227 228
	ret = usb_submit_urb(urb, GFP_KERNEL);
	if (ret < 0) {
229
		PDEBUG(D_ERR, "submit int URB failed with error %i", ret);
230 231
		goto error_submit;
	}
232
	gspca_dev->int_urb = urb;
233 234 235
	return ret;

error_submit:
236 237 238 239
	usb_free_coherent(dev,
			  urb->transfer_buffer_length,
			  urb->transfer_buffer,
			  urb->transfer_dma);
240 241 242 243 244 245
error_buffer:
	usb_free_urb(urb);
error:
	return ret;
}

246
static void gspca_input_create_urb(struct gspca_dev *gspca_dev)
247 248 249 250 251 252 253 254 255 256 257 258 259 260
{
	struct usb_interface *intf;
	struct usb_host_interface *intf_desc;
	struct usb_endpoint_descriptor *ep;
	int i;

	if (gspca_dev->sd_desc->int_pkt_scan)  {
		intf = usb_ifnum_to_if(gspca_dev->dev, gspca_dev->iface);
		intf_desc = intf->cur_altsetting;
		for (i = 0; i < intf_desc->desc.bNumEndpoints; i++) {
			ep = &intf_desc->endpoint[i].desc;
			if (usb_endpoint_dir_in(ep) &&
			    usb_endpoint_xfer_int(ep)) {

261
				alloc_and_submit_int_urb(gspca_dev, ep);
262 263 264 265 266 267 268 269 270 271 272 273 274 275
				break;
			}
		}
	}
}

static void gspca_input_destroy_urb(struct gspca_dev *gspca_dev)
{
	struct urb *urb;

	urb = gspca_dev->int_urb;
	if (urb) {
		gspca_dev->int_urb = NULL;
		usb_kill_urb(urb);
276 277 278 279
		usb_free_coherent(gspca_dev->dev,
				  urb->transfer_buffer_length,
				  urb->transfer_buffer,
				  urb->transfer_dma);
280 281 282
		usb_free_urb(urb);
	}
}
283 284 285 286 287 288 289 290 291 292 293 294 295
#else
static inline void gspca_input_destroy_urb(struct gspca_dev *gspca_dev)
{
}

static inline void gspca_input_create_urb(struct gspca_dev *gspca_dev)
{
}

static inline int gspca_input_connect(struct gspca_dev *dev)
{
	return 0;
}
296 297
#endif

298
/*
299
 * fill a video frame from an URB and resubmit
300
 */
301 302
static void fill_frame(struct gspca_dev *gspca_dev,
			struct urb *urb)
303
{
304
	u8 *data;		/* address of data in the iso message */
305
	int i, len, st;
306 307
	cam_pkt_op pkt_scan;

308
	if (urb->status != 0) {
309 310
		if (urb->status == -ESHUTDOWN)
			return;		/* disconnection */
311
#ifdef CONFIG_PM
312 313
		if (gspca_dev->frozen)
			return;
314
#endif
315
		PDEBUG(D_ERR|D_PACK, "urb status: %d", urb->status);
316
		urb->status = 0;
317
		goto resubmit;
318
	}
319 320 321 322 323
	pkt_scan = gspca_dev->sd_desc->pkt_scan;
	for (i = 0; i < urb->number_of_packets; i++) {

		/* check the packet status and length */
		len = urb->iso_frame_desc[i].actual_length;
324 325 326
		if (len == 0) {
			if (gspca_dev->empty_packet == 0)
				gspca_dev->empty_packet = 1;
327
			continue;
328
		}
329 330
		st = urb->iso_frame_desc[i].status;
		if (st) {
331
			err("ISOC data error: [%d] len=%d, status=%d",
332 333 334 335 336 337 338 339
				i, len, st);
			gspca_dev->last_packet_type = DISCARD_PACKET;
			continue;
		}

		/* let the packet be analyzed by the subdriver */
		PDEBUG(D_PACK, "packet [%d] o:%d l:%d",
			i, urb->iso_frame_desc[i].offset, len);
340
		data = (u8 *) urb->transfer_buffer
341
					+ urb->iso_frame_desc[i].offset;
342
		pkt_scan(gspca_dev, data, len);
343 344
	}

345
resubmit:
346 347 348
	/* resubmit the URB */
	st = usb_submit_urb(urb, GFP_ATOMIC);
	if (st < 0)
349
		err("usb_submit_urb() ret %d", st);
350 351
}

352 353 354
/*
 * ISOC message interrupt from the USB device
 *
355
 * Analyse each packet and call the subdriver for copy to the frame buffer.
356
 */
357
static void isoc_irq(struct urb *urb)
358 359 360
{
	struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;

361
	PDEBUG(D_PACK, "isoc irq");
362 363 364 365 366
	if (!gspca_dev->streaming)
		return;
	fill_frame(gspca_dev, urb);
}

367 368 369
/*
 * bulk message interrupt from the USB device
 */
370
static void bulk_irq(struct urb *urb)
371 372
{
	struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
373
	int st;
374 375 376 377

	PDEBUG(D_PACK, "bulk irq");
	if (!gspca_dev->streaming)
		return;
378 379 380
	switch (urb->status) {
	case 0:
		break;
381 382
	case -ESHUTDOWN:
		return;		/* disconnection */
383
	default:
384
#ifdef CONFIG_PM
385 386
		if (gspca_dev->frozen)
			return;
387
#endif
388
		PDEBUG(D_ERR|D_PACK, "urb status: %d", urb->status);
389
		urb->status = 0;
390
		goto resubmit;
391 392
	}

393 394 395 396
	PDEBUG(D_PACK, "packet l:%d", urb->actual_length);
	gspca_dev->sd_desc->pkt_scan(gspca_dev,
				urb->transfer_buffer,
				urb->actual_length);
397

398
resubmit:
399 400 401 402
	/* resubmit the URB */
	if (gspca_dev->cam.bulk_nurbs != 0) {
		st = usb_submit_urb(urb, GFP_ATOMIC);
		if (st < 0)
403
			err("usb_submit_urb() ret %d", st);
404
	}
405 406
}

407 408 409
/*
 * add data to the current frame
 *
410 411
 * This function is called by the subdrivers at interrupt level.
 *
412 413 414 415 416 417 418
 * To build a frame, these ones must add
 *	- one FIRST_PACKET
 *	- 0 or many INTER_PACKETs
 *	- one LAST_PACKET
 * DISCARD_PACKET invalidates the whole frame.
 * On LAST_PACKET, a new frame is returned.
 */
419 420 421 422
void gspca_frame_add(struct gspca_dev *gspca_dev,
			enum gspca_packet_type packet_type,
			const u8 *data,
			int len)
423
{
424
	struct gspca_frame *frame;
425 426
	int i, j;

427
	PDEBUG(D_PACK, "add t:%d l:%d",	packet_type, len);
428

429
	if (packet_type == FIRST_PACKET) {
430 431 432 433 434
		i = atomic_read(&gspca_dev->fr_i);

		/* if there are no queued buffer, discard the whole frame */
		if (i == atomic_read(&gspca_dev->fr_q)) {
			gspca_dev->last_packet_type = DISCARD_PACKET;
435
			gspca_dev->sequence++;
436 437
			return;
		}
438 439
		j = gspca_dev->fr_queue[i];
		frame = &gspca_dev->frame[j];
440
		frame->v4l2_buf.timestamp = ktime_to_timeval(ktime_get());
441
		frame->v4l2_buf.sequence = gspca_dev->sequence++;
442
		gspca_dev->image = frame->data;
443
		gspca_dev->image_len = 0;
444 445 446 447 448 449 450 451 452
	} else {
		switch (gspca_dev->last_packet_type) {
		case DISCARD_PACKET:
			if (packet_type == LAST_PACKET)
				gspca_dev->last_packet_type = packet_type;
			return;
		case LAST_PACKET:
			return;
		}
453
	}
454

455
	/* append the packet to the frame buffer */
456
	if (len > 0) {
457 458 459 460
		if (gspca_dev->image_len + len > gspca_dev->frsz) {
			PDEBUG(D_ERR|D_PACK, "frame overflow %d > %d",
				gspca_dev->image_len + len,
				gspca_dev->frsz);
461 462
			packet_type = DISCARD_PACKET;
		} else {
463 464 465 466 467 468
/* !! image is NULL only when last pkt is LAST or DISCARD
			if (gspca_dev->image == NULL) {
				err("gspca_frame_add() image == NULL");
				return;
			}
 */
469 470 471
			memcpy(gspca_dev->image + gspca_dev->image_len,
				data, len);
			gspca_dev->image_len += len;
472 473 474 475
		}
	}
	gspca_dev->last_packet_type = packet_type;

476 477 478
	/* if last packet, invalidate packet concatenation until
	 * next first packet, wake up the application and advance
	 * in the queue */
479
	if (packet_type == LAST_PACKET) {
480
		i = atomic_read(&gspca_dev->fr_i);
481 482 483
		j = gspca_dev->fr_queue[i];
		frame = &gspca_dev->frame[j];
		frame->v4l2_buf.bytesused = gspca_dev->image_len;
484 485 486
		frame->v4l2_buf.flags = (frame->v4l2_buf.flags
					 | V4L2_BUF_FLAG_DONE)
					& ~V4L2_BUF_FLAG_QUEUED;
487 488
		i = (i + 1) % GSPCA_MAX_FRAMES;
		atomic_set(&gspca_dev->fr_i, i);
489
		wake_up_interruptible(&gspca_dev->wq);	/* event = new frame */
490 491 492 493
		PDEBUG(D_FRAM, "frame complete len:%d",
			frame->v4l2_buf.bytesused);
		gspca_dev->image = NULL;
		gspca_dev->image_len = 0;
494 495 496 497 498 499 500 501 502
	}
}
EXPORT_SYMBOL(gspca_frame_add);

static int gspca_is_compressed(__u32 format)
{
	switch (format) {
	case V4L2_PIX_FMT_MJPEG:
	case V4L2_PIX_FMT_JPEG:
503
	case V4L2_PIX_FMT_SPCA561:
504
	case V4L2_PIX_FMT_PAC207:
505
	case V4L2_PIX_FMT_MR97310A:
506 507 508 509 510 511
		return 1;
	}
	return 0;
}

static int frame_alloc(struct gspca_dev *gspca_dev,
512
			unsigned int count)
513
{
514 515 516
	struct gspca_frame *frame;
	unsigned int frsz;
	int i;
517

518 519
	i = gspca_dev->curr_mode;
	frsz = gspca_dev->cam.cam_mode[i].sizeimage;
520 521 522
	PDEBUG(D_STREAM, "frame alloc frsz: %d", frsz);
	frsz = PAGE_ALIGN(frsz);
	gspca_dev->frsz = frsz;
523 524
	if (count >= GSPCA_MAX_FRAMES)
		count = GSPCA_MAX_FRAMES - 1;
525
	gspca_dev->frbuf = vmalloc_32(frsz * count);
526 527 528
	if (!gspca_dev->frbuf) {
		err("frame alloc failed");
		return -ENOMEM;
529 530 531
	}
	gspca_dev->nframes = count;
	for (i = 0; i < count; i++) {
532 533 534 535 536 537 538 539
		frame = &gspca_dev->frame[i];
		frame->v4l2_buf.index = i;
		frame->v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
		frame->v4l2_buf.flags = 0;
		frame->v4l2_buf.field = V4L2_FIELD_NONE;
		frame->v4l2_buf.length = frsz;
		frame->v4l2_buf.memory = gspca_dev->memory;
		frame->v4l2_buf.sequence = 0;
540
		frame->data = gspca_dev->frbuf + i * frsz;
541
		frame->v4l2_buf.m.offset = i * frsz;
542
	}
543 544 545
	atomic_set(&gspca_dev->fr_q, 0);
	atomic_set(&gspca_dev->fr_i, 0);
	gspca_dev->fr_o = 0;
546
	return 0;
547 548 549 550 551 552 553
}

static void frame_free(struct gspca_dev *gspca_dev)
{
	int i;

	PDEBUG(D_STREAM, "frame free");
554
	if (gspca_dev->frbuf != NULL) {
555
		vfree(gspca_dev->frbuf);
556 557 558 559 560 561 562
		gspca_dev->frbuf = NULL;
		for (i = 0; i < gspca_dev->nframes; i++)
			gspca_dev->frame[i].data = NULL;
	}
	gspca_dev->nframes = 0;
}

563
static void destroy_urbs(struct gspca_dev *gspca_dev)
564 565 566 567 568
{
	struct urb *urb;
	unsigned int i;

	PDEBUG(D_STREAM, "kill transfer");
569
	for (i = 0; i < MAX_NURBS; i++) {
570
		urb = gspca_dev->urb[i];
571
		if (urb == NULL)
572
			break;
573

574
		gspca_dev->urb[i] = NULL;
575
		usb_kill_urb(urb);
576
		if (urb->transfer_buffer != NULL)
577 578 579 580
			usb_free_coherent(gspca_dev->dev,
					  urb->transfer_buffer_length,
					  urb->transfer_buffer,
					  urb->transfer_dma);
581 582 583 584
		usb_free_urb(urb);
	}
}

585 586 587 588 589 590 591 592
static int gspca_set_alt0(struct gspca_dev *gspca_dev)
{
	int ret;

	if (gspca_dev->alt == 0)
		return 0;
	ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, 0);
	if (ret < 0)
593
		err("set alt 0 err %d", ret);
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
	return ret;
}

/* Note: both the queue and the usb locks should be held when calling this */
static void gspca_stream_off(struct gspca_dev *gspca_dev)
{
	gspca_dev->streaming = 0;
	if (gspca_dev->present) {
		if (gspca_dev->sd_desc->stopN)
			gspca_dev->sd_desc->stopN(gspca_dev);
		destroy_urbs(gspca_dev);
		gspca_input_destroy_urb(gspca_dev);
		gspca_set_alt0(gspca_dev);
		gspca_input_create_urb(gspca_dev);
	}

	/* always call stop0 to free the subdriver's resources */
	if (gspca_dev->sd_desc->stop0)
		gspca_dev->sd_desc->stop0(gspca_dev);
	PDEBUG(D_STREAM, "stream off OK");
}

616
/*
617
 * look for an input transfer endpoint in an alternate setting
618
 */
619
static struct usb_host_endpoint *alt_xfer(struct usb_host_interface *alt,
620
					  int xfer)
621 622 623 624 625 626
{
	struct usb_host_endpoint *ep;
	int i, attr;

	for (i = 0; i < alt->desc.bNumEndpoints; i++) {
		ep = &alt->endpoint[i];
627
		attr = ep->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
628 629
		if (attr == xfer
		    && ep->desc.wMaxPacketSize != 0)
630
			return ep;
631 632 633 634 635
	}
	return NULL;
}

/*
636
 * look for an input (isoc or bulk) endpoint
637 638 639 640 641 642
 *
 * The endpoint is defined by the subdriver.
 * Use only the first isoc (some Zoran - 0x0572:0x0001 - have two such ep).
 * This routine may be called many times when the bandwidth is too small
 * (the bandwidth is checked on urb submit).
 */
643
static struct usb_host_endpoint *get_ep(struct gspca_dev *gspca_dev)
644 645 646
{
	struct usb_interface *intf;
	struct usb_host_endpoint *ep;
647
	int xfer, i, ret;
648 649

	intf = usb_ifnum_to_if(gspca_dev->dev, gspca_dev->iface);
650
	ep = NULL;
651 652
	xfer = gspca_dev->cam.bulk ? USB_ENDPOINT_XFER_BULK
				   : USB_ENDPOINT_XFER_ISOC;
653
	i = gspca_dev->alt;			/* previous alt setting */
654
	if (gspca_dev->cam.reverse_alts) {
655
		if (gspca_dev->audio && i < gspca_dev->nbalt - 2)
656
			i++;
657 658 659 660 661 662
		while (++i < gspca_dev->nbalt) {
			ep = alt_xfer(&intf->altsetting[i], xfer);
			if (ep)
				break;
		}
	} else {
663
		if (gspca_dev->audio && i > 1)
664
			i--;
665 666 667 668 669
		while (--i >= 0) {
			ep = alt_xfer(&intf->altsetting[i], xfer);
			if (ep)
				break;
		}
670
	}
671
	if (ep == NULL) {
672 673
		err("no transfer endpoint found");
		return NULL;
674
	}
675
	PDEBUG(D_STREAM, "use alt %d ep 0x%02x",
676
			i, ep->desc.bEndpointAddress);
677
	gspca_dev->alt = i;		/* memorize the current alt setting */
678
	if (gspca_dev->nbalt > 1) {
679 680
		ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, i);
		if (ret < 0) {
681
			err("set alt %d err %d", i, ret);
682
			ep = NULL;
683
		}
684 685 686 687 688
	}
	return ep;
}

/*
689
 * create the URBs for image transfer
690 691 692 693 694
 */
static int create_urbs(struct gspca_dev *gspca_dev,
			struct usb_host_endpoint *ep)
{
	struct urb *urb;
695
	int n, nurbs, i, psize, npkt, bsize;
696 697 698

	/* calculate the packet size and the number of packets */
	psize = le16_to_cpu(ep->desc.wMaxPacketSize);
699

700
	if (!gspca_dev->cam.bulk) {		/* isoc */
701 702

		/* See paragraph 5.9 / table 5-11 of the usb 2.0 spec. */
703 704 705 706
		if (gspca_dev->pkt_size == 0)
			psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
		else
			psize = gspca_dev->pkt_size;
707 708 709
		npkt = gspca_dev->cam.npkt;
		if (npkt == 0)
			npkt = 32;		/* default value */
710 711 712 713
		bsize = psize * npkt;
		PDEBUG(D_STREAM,
			"isoc %d pkts size %d = bsize:%d",
			npkt, psize, bsize);
714
		nurbs = DEF_NURBS;
715
	} else {				/* bulk */
716
		npkt = 0;
717
		bsize = gspca_dev->cam.bulk_size;
718 719
		if (bsize == 0)
			bsize = psize;
720
		PDEBUG(D_STREAM, "bulk bsize:%d", bsize);
721 722 723 724
		if (gspca_dev->cam.bulk_nurbs != 0)
			nurbs = gspca_dev->cam.bulk_nurbs;
		else
			nurbs = 1;
725 726
	}

727
	for (n = 0; n < nurbs; n++) {
728 729 730 731 732
		urb = usb_alloc_urb(npkt, GFP_KERNEL);
		if (!urb) {
			err("usb_alloc_urb failed");
			return -ENOMEM;
		}
733
		gspca_dev->urb[n] = urb;
734
		urb->transfer_buffer = usb_alloc_coherent(gspca_dev->dev,
735 736 737 738
						bsize,
						GFP_KERNEL,
						&urb->transfer_dma);

739
		if (urb->transfer_buffer == NULL) {
740
			err("usb_alloc_coherent failed");
741 742 743 744 745
			return -ENOMEM;
		}
		urb->dev = gspca_dev->dev;
		urb->context = gspca_dev;
		urb->transfer_buffer_length = bsize;
746 747 748
		if (npkt != 0) {		/* ISOC */
			urb->pipe = usb_rcvisocpipe(gspca_dev->dev,
						    ep->desc.bEndpointAddress);
749 750
			urb->transfer_flags = URB_ISO_ASAP
					| URB_NO_TRANSFER_DMA_MAP;
751 752 753 754 755 756 757 758 759 760
			urb->interval = ep->desc.bInterval;
			urb->complete = isoc_irq;
			urb->number_of_packets = npkt;
			for (i = 0; i < npkt; i++) {
				urb->iso_frame_desc[i].length = psize;
				urb->iso_frame_desc[i].offset = psize * i;
			}
		} else {		/* bulk */
			urb->pipe = usb_rcvbulkpipe(gspca_dev->dev,
						ep->desc.bEndpointAddress),
761
			urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
762
			urb->complete = bulk_irq;
763 764 765 766 767 768 769 770 771 772 773
		}
	}
	return 0;
}

/*
 * start the USB transfer
 */
static int gspca_init_transfer(struct gspca_dev *gspca_dev)
{
	struct usb_host_endpoint *ep;
774
	struct urb *urb;
775 776
	int n, ret;

777 778
	if (mutex_lock_interruptible(&gspca_dev->usb_lock))
		return -ERESTARTSYS;
779

780 781
	if (!gspca_dev->present) {
		ret = -ENODEV;
782
		goto unlock;
783 784
	}

785 786 787 788 789 790
	/* reset the streaming variables */
	gspca_dev->image = NULL;
	gspca_dev->image_len = 0;
	gspca_dev->last_packet_type = DISCARD_PACKET;
	gspca_dev->sequence = 0;

791 792
	gspca_dev->usb_err = 0;

793 794
	/* set the higher alternate setting and
	 * loop until urb submit succeeds */
795 796 797 798 799
	if (gspca_dev->cam.reverse_alts)
		gspca_dev->alt = 0;
	else
		gspca_dev->alt = gspca_dev->nbalt;

800 801 802
	if (gspca_dev->sd_desc->isoc_init) {
		ret = gspca_dev->sd_desc->isoc_init(gspca_dev);
		if (ret < 0)
803
			goto unlock;
804
	}
805 806

	gspca_input_destroy_urb(gspca_dev);
807 808 809 810 811
	ep = get_ep(gspca_dev);
	if (ep == NULL) {
		ret = -EIO;
		goto out;
	}
812
	for (;;) {
813 814 815 816 817 818 819 820
		if (!gspca_dev->cam.no_urb_create) {
			PDEBUG(D_STREAM, "init transfer alt %d",
				gspca_dev->alt);
			ret = create_urbs(gspca_dev, ep);
			if (ret < 0) {
				destroy_urbs(gspca_dev);
				goto out;
			}
821
		}
822

823
		/* clear the bulk endpoint */
824
		if (gspca_dev->cam.bulk)
825
			usb_clear_halt(gspca_dev->dev,
826
					gspca_dev->urb[0]->pipe);
827

828
		/* start the cam */
829 830 831 832 833
		ret = gspca_dev->sd_desc->start(gspca_dev);
		if (ret < 0) {
			destroy_urbs(gspca_dev);
			goto out;
		}
834 835
		gspca_dev->streaming = 1;

836
		/* some bulk transfers are started by the subdriver */
837
		if (gspca_dev->cam.bulk && gspca_dev->cam.bulk_nurbs == 0)
838 839
			break;

840
		/* submit the URBs */
841 842 843 844 845
		for (n = 0; n < MAX_NURBS; n++) {
			urb = gspca_dev->urb[n];
			if (urb == NULL)
				break;
			ret = usb_submit_urb(urb, GFP_KERNEL);
846 847
			if (ret < 0)
				break;
848 849 850
		}
		if (ret >= 0)
			break;
851
		gspca_stream_off(gspca_dev);
852
		if (ret != -ENOSPC) {
853
			err("usb_submit_urb alt %d err %d",
854
				gspca_dev->alt, ret);
855
			goto out;
856
		}
857 858 859

		/* the bandwidth is not wide enough
		 * negociate or try a lower alternate setting */
860 861
		PDEBUG(D_ERR|D_STREAM,
			"bandwidth not wide enough - trying again");
862 863 864 865 866 867 868 869 870 871 872 873
		msleep(20);	/* wait for kill complete */
		if (gspca_dev->sd_desc->isoc_nego) {
			ret = gspca_dev->sd_desc->isoc_nego(gspca_dev);
			if (ret < 0)
				goto out;
		} else {
			ep = get_ep(gspca_dev);
			if (ep == NULL) {
				ret = -EIO;
				goto out;
			}
		}
874 875
	}
out:
876 877
	gspca_input_create_urb(gspca_dev);
unlock:
878 879 880 881
	mutex_unlock(&gspca_dev->usb_lock);
	return ret;
}

882
static void gspca_set_default_mode(struct gspca_dev *gspca_dev)
883
{
884
	struct gspca_ctrl *ctrl;
885 886 887 888 889 890
	int i;

	i = gspca_dev->cam.nmodes - 1;	/* take the highest mode */
	gspca_dev->curr_mode = i;
	gspca_dev->width = gspca_dev->cam.cam_mode[i].width;
	gspca_dev->height = gspca_dev->cam.cam_mode[i].height;
891
	gspca_dev->pixfmt = gspca_dev->cam.cam_mode[i].pixelformat;
892 893 894 895 896 897 898 899 900 901

	/* set the current control values to their default values
	 * which may have changed in sd_init() */
	ctrl = gspca_dev->cam.ctrls;
	if (ctrl != NULL) {
		for (i = 0;
		     i < gspca_dev->sd_desc->nctrls;
		     i++, ctrl++)
			ctrl->val = ctrl->def;
	}
902 903 904 905 906 907 908
}

static int wxh_to_mode(struct gspca_dev *gspca_dev,
			int width, int height)
{
	int i;

909 910 911
	for (i = gspca_dev->cam.nmodes; --i > 0; ) {
		if (width >= gspca_dev->cam.cam_mode[i].width
		    && height >= gspca_dev->cam.cam_mode[i].height)
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928
			break;
	}
	return i;
}

/*
 * search a mode with the right pixel format
 */
static int gspca_get_mode(struct gspca_dev *gspca_dev,
			int mode,
			int pixfmt)
{
	int modeU, modeD;

	modeU = modeD = mode;
	while ((modeU < gspca_dev->cam.nmodes) || modeD >= 0) {
		if (--modeD >= 0) {
929 930
			if (gspca_dev->cam.cam_mode[modeD].pixelformat
								== pixfmt)
931 932 933
				return modeD;
		}
		if (++modeU < gspca_dev->cam.nmodes) {
934 935
			if (gspca_dev->cam.cam_mode[modeU].pixelformat
								== pixfmt)
936 937 938 939 940 941
				return modeU;
		}
	}
	return -EINVAL;
}

942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
#ifdef CONFIG_VIDEO_ADV_DEBUG
static int vidioc_g_register(struct file *file, void *priv,
			struct v4l2_dbg_register *reg)
{
	int ret;
	struct gspca_dev *gspca_dev = priv;

	if (!gspca_dev->sd_desc->get_chip_ident)
		return -EINVAL;

	if (!gspca_dev->sd_desc->get_register)
		return -EINVAL;

	if (mutex_lock_interruptible(&gspca_dev->usb_lock))
		return -ERESTARTSYS;
957
	gspca_dev->usb_err = 0;
958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
	if (gspca_dev->present)
		ret = gspca_dev->sd_desc->get_register(gspca_dev, reg);
	else
		ret = -ENODEV;
	mutex_unlock(&gspca_dev->usb_lock);

	return ret;
}

static int vidioc_s_register(struct file *file, void *priv,
			struct v4l2_dbg_register *reg)
{
	int ret;
	struct gspca_dev *gspca_dev = priv;

	if (!gspca_dev->sd_desc->get_chip_ident)
		return -EINVAL;

	if (!gspca_dev->sd_desc->set_register)
		return -EINVAL;

	if (mutex_lock_interruptible(&gspca_dev->usb_lock))
		return -ERESTARTSYS;
981
	gspca_dev->usb_err = 0;
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
	if (gspca_dev->present)
		ret = gspca_dev->sd_desc->set_register(gspca_dev, reg);
	else
		ret = -ENODEV;
	mutex_unlock(&gspca_dev->usb_lock);

	return ret;
}
#endif

static int vidioc_g_chip_ident(struct file *file, void *priv,
			struct v4l2_dbg_chip_ident *chip)
{
	int ret;
	struct gspca_dev *gspca_dev = priv;

	if (!gspca_dev->sd_desc->get_chip_ident)
		return -EINVAL;

	if (mutex_lock_interruptible(&gspca_dev->usb_lock))
		return -ERESTARTSYS;
1003
	gspca_dev->usb_err = 0;
1004 1005 1006 1007 1008 1009 1010 1011 1012
	if (gspca_dev->present)
		ret = gspca_dev->sd_desc->get_chip_ident(gspca_dev, chip);
	else
		ret = -ENODEV;
	mutex_unlock(&gspca_dev->usb_lock);

	return ret;
}

1013
static int vidioc_enum_fmt_vid_cap(struct file *file, void  *priv,
1014 1015 1016
				struct v4l2_fmtdesc *fmtdesc)
{
	struct gspca_dev *gspca_dev = priv;
1017
	int i, j, index;
1018 1019 1020 1021 1022 1023
	__u32 fmt_tb[8];

	/* give an index to each format */
	index = 0;
	j = 0;
	for (i = gspca_dev->cam.nmodes; --i >= 0; ) {
1024
		fmt_tb[index] = gspca_dev->cam.cam_mode[i].pixelformat;
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
		j = 0;
		for (;;) {
			if (fmt_tb[j] == fmt_tb[index])
				break;
			j++;
		}
		if (j == index) {
			if (fmtdesc->index == index)
				break;		/* new format */
			index++;
1035
			if (index >= ARRAY_SIZE(fmt_tb))
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
				return -EINVAL;
		}
	}
	if (i < 0)
		return -EINVAL;		/* no more format */

	fmtdesc->pixelformat = fmt_tb[index];
	if (gspca_is_compressed(fmt_tb[index]))
		fmtdesc->flags = V4L2_FMT_FLAG_COMPRESSED;
	fmtdesc->description[0] = fmtdesc->pixelformat & 0xff;
	fmtdesc->description[1] = (fmtdesc->pixelformat >> 8) & 0xff;
	fmtdesc->description[2] = (fmtdesc->pixelformat >> 16) & 0xff;
	fmtdesc->description[3] = fmtdesc->pixelformat >> 24;
	fmtdesc->description[4] = '\0';
	return 0;
}

1053
static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
1054 1055 1056
			    struct v4l2_format *fmt)
{
	struct gspca_dev *gspca_dev = priv;
1057
	int mode;
1058

1059 1060 1061
	mode = gspca_dev->curr_mode;
	memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
		sizeof fmt->fmt.pix);
1062 1063 1064
	return 0;
}

1065
static int try_fmt_vid_cap(struct gspca_dev *gspca_dev,
1066 1067
			struct v4l2_format *fmt)
{
1068
	int w, h, mode, mode2;
1069

1070 1071
	w = fmt->fmt.pix.width;
	h = fmt->fmt.pix.height;
1072

1073
#ifdef GSPCA_DEBUG
1074 1075 1076 1077 1078 1079 1080
	if (gspca_debug & D_CONF)
		PDEBUG_MODE("try fmt cap", fmt->fmt.pix.pixelformat, w, h);
#endif
	/* search the closest mode for width and height */
	mode = wxh_to_mode(gspca_dev, w, h);

	/* OK if right palette */
1081 1082
	if (gspca_dev->cam.cam_mode[mode].pixelformat
						!= fmt->fmt.pix.pixelformat) {
1083 1084 1085 1086

		/* else, search the closest mode with the same pixel format */
		mode2 = gspca_get_mode(gspca_dev, mode,
					fmt->fmt.pix.pixelformat);
1087
		if (mode2 >= 0)
1088
			mode = mode2;
1089 1090
/*		else
			;		 * no chance, return this mode */
1091
	}
1092 1093
	memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
		sizeof fmt->fmt.pix);
1094 1095 1096
	return mode;			/* used when s_fmt */
}

1097
static int vidioc_try_fmt_vid_cap(struct file *file,
1098 1099 1100
			      void *priv,
			      struct v4l2_format *fmt)
{
1101
	struct gspca_dev *gspca_dev = priv;
1102 1103
	int ret;

1104
	ret = try_fmt_vid_cap(gspca_dev, fmt);
1105 1106 1107 1108 1109
	if (ret < 0)
		return ret;
	return 0;
}

1110
static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
1111 1112 1113
			    struct v4l2_format *fmt)
{
	struct gspca_dev *gspca_dev = priv;
1114
	int ret;
1115

1116 1117
	if (mutex_lock_interruptible(&gspca_dev->queue_lock))
		return -ERESTARTSYS;
1118

1119
	ret = try_fmt_vid_cap(gspca_dev, fmt);
1120 1121 1122
	if (ret < 0)
		goto out;

1123 1124 1125 1126 1127 1128
	if (gspca_dev->nframes != 0
	    && fmt->fmt.pix.sizeimage > gspca_dev->frsz) {
		ret = -EINVAL;
		goto out;
	}

1129 1130
	if (ret == gspca_dev->curr_mode) {
		ret = 0;
1131
		goto out;			/* same mode */
1132
	}
1133 1134 1135 1136

	if (gspca_dev->streaming) {
		ret = -EBUSY;
		goto out;
1137
	}
1138 1139
	gspca_dev->width = fmt->fmt.pix.width;
	gspca_dev->height = fmt->fmt.pix.height;
1140 1141
	gspca_dev->pixfmt = fmt->fmt.pix.pixelformat;
	gspca_dev->curr_mode = ret;
1142 1143

	ret = 0;
1144 1145 1146 1147 1148
out:
	mutex_unlock(&gspca_dev->queue_lock);
	return ret;
}

1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
static int vidioc_enum_framesizes(struct file *file, void *priv,
				  struct v4l2_frmsizeenum *fsize)
{
	struct gspca_dev *gspca_dev = priv;
	int i;
	__u32 index = 0;

	for (i = 0; i < gspca_dev->cam.nmodes; i++) {
		if (fsize->pixel_format !=
				gspca_dev->cam.cam_mode[i].pixelformat)
			continue;

		if (fsize->index == index) {
			fsize->type = V4L2_FRMSIZE_TYPE_DISCRETE;
			fsize->discrete.width =
				gspca_dev->cam.cam_mode[i].width;
			fsize->discrete.height =
				gspca_dev->cam.cam_mode[i].height;
			return 0;
		}
		index++;
	}

	return -EINVAL;
}

1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
static int vidioc_enum_frameintervals(struct file *filp, void *priv,
				      struct v4l2_frmivalenum *fival)
{
	struct gspca_dev *gspca_dev = priv;
	int mode = wxh_to_mode(gspca_dev, fival->width, fival->height);
	__u32 i;

	if (gspca_dev->cam.mode_framerates == NULL ||
			gspca_dev->cam.mode_framerates[mode].nrates == 0)
		return -EINVAL;

	if (fival->pixel_format !=
			gspca_dev->cam.cam_mode[mode].pixelformat)
		return -EINVAL;

	for (i = 0; i < gspca_dev->cam.mode_framerates[mode].nrates; i++) {
		if (fival->index == i) {
			fival->type = V4L2_FRMSIZE_TYPE_DISCRETE;
			fival->discrete.numerator = 1;
			fival->discrete.denominator =
				gspca_dev->cam.mode_framerates[mode].rates[i];
			return 0;
		}
	}

	return -EINVAL;
}

1203
static void gspca_release(struct video_device *vfd)
1204
{
1205
	struct gspca_dev *gspca_dev = container_of(vfd, struct gspca_dev, vdev);
1206

1207 1208
	PDEBUG(D_PROBE, "%s released",
		video_device_node_name(&gspca_dev->vdev));
1209 1210 1211 1212 1213

	kfree(gspca_dev->usb_buf);
	kfree(gspca_dev);
}

1214
static int dev_open(struct file *file)
1215 1216 1217 1218
{
	struct gspca_dev *gspca_dev;
	int ret;

1219
	PDEBUG(D_STREAM, "[%s] open", current->comm);
1220
	gspca_dev = (struct gspca_dev *) video_devdata(file);
1221 1222
	if (mutex_lock_interruptible(&gspca_dev->queue_lock))
		return -ERESTARTSYS;
1223 1224 1225 1226 1227
	if (!gspca_dev->present) {
		ret = -ENODEV;
		goto out;
	}

1228
	if (gspca_dev->users > 4) {	/* (arbitrary value) */
1229 1230 1231
		ret = -EBUSY;
		goto out;
	}
1232 1233 1234 1235 1236 1237 1238

	/* protect the subdriver against rmmod */
	if (!try_module_get(gspca_dev->module)) {
		ret = -ENODEV;
		goto out;
	}

1239
	gspca_dev->users++;
1240

1241
	file->private_data = gspca_dev;
1242
#ifdef GSPCA_DEBUG
1243
	/* activate the v4l2 debug */
1244
	if (gspca_debug & D_V4L2)
1245
		gspca_dev->vdev.debug |= V4L2_DEBUG_IOCTL
1246
					| V4L2_DEBUG_IOCTL_ARG;
1247
	else
1248
		gspca_dev->vdev.debug &= ~(V4L2_DEBUG_IOCTL
1249
					| V4L2_DEBUG_IOCTL_ARG);
1250
#endif
1251
	ret = 0;
1252 1253 1254 1255 1256
out:
	mutex_unlock(&gspca_dev->queue_lock);
	if (ret != 0)
		PDEBUG(D_ERR|D_STREAM, "open failed err %d", ret);
	else
1257
		PDEBUG(D_STREAM, "open done");
1258 1259 1260
	return ret;
}

1261
static int dev_close(struct file *file)
1262 1263 1264
{
	struct gspca_dev *gspca_dev = file->private_data;

1265
	PDEBUG(D_STREAM, "[%s] close", current->comm);
1266 1267 1268 1269
	if (mutex_lock_interruptible(&gspca_dev->queue_lock))
		return -ERESTARTSYS;
	gspca_dev->users--;

1270
	/* if the file did the capture, free the streaming resources */
1271
	if (gspca_dev->capt_file == file) {
1272 1273
		if (gspca_dev->streaming) {
			mutex_lock(&gspca_dev->usb_lock);
1274
			gspca_dev->usb_err = 0;
1275 1276 1277
			gspca_stream_off(gspca_dev);
			mutex_unlock(&gspca_dev->usb_lock);
		}
1278
		frame_free(gspca_dev);
1279
		gspca_dev->capt_file = NULL;
1280
		gspca_dev->memory = GSPCA_MEMORY_NO;
1281
	}
1282
	file->private_data = NULL;
1283
	module_put(gspca_dev->module);
1284
	mutex_unlock(&gspca_dev->queue_lock);
1285

1286
	PDEBUG(D_STREAM, "close done");
1287

1288 1289 1290 1291 1292 1293 1294
	return 0;
}

static int vidioc_querycap(struct file *file, void  *priv,
			   struct v4l2_capability *cap)
{
	struct gspca_dev *gspca_dev = priv;
1295
	int ret;
1296

1297 1298 1299 1300 1301 1302 1303
	/* protect the access to the usb device */
	if (mutex_lock_interruptible(&gspca_dev->usb_lock))
		return -ERESTARTSYS;
	if (!gspca_dev->present) {
		ret = -ENODEV;
		goto out;
	}
1304
	strncpy(cap->driver, gspca_dev->sd_desc->name, sizeof cap->driver);
1305 1306 1307 1308 1309 1310 1311 1312 1313
	if (gspca_dev->dev->product != NULL) {
		strncpy(cap->card, gspca_dev->dev->product,
			sizeof cap->card);
	} else {
		snprintf(cap->card, sizeof cap->card,
			"USB Camera (%04x:%04x)",
			le16_to_cpu(gspca_dev->dev->descriptor.idVendor),
			le16_to_cpu(gspca_dev->dev->descriptor.idProduct));
	}
1314
	usb_make_path(gspca_dev->dev, cap->bus_info, sizeof(cap->bus_info));
1315 1316 1317 1318
	cap->version = DRIVER_VERSION_NUMBER;
	cap->capabilities = V4L2_CAP_VIDEO_CAPTURE
			  | V4L2_CAP_STREAMING
			  | V4L2_CAP_READWRITE;
1319 1320 1321 1322
	ret = 0;
out:
	mutex_unlock(&gspca_dev->usb_lock);
	return ret;
1323 1324
}

1325
static int get_ctrl(struct gspca_dev *gspca_dev,
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
				   int id)
{
	const struct ctrl *ctrls;
	int i;

	for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
	     i < gspca_dev->sd_desc->nctrls;
	     i++, ctrls++) {
		if (gspca_dev->ctrl_dis & (1 << i))
			continue;
		if (id == ctrls->qctrl.id)
1337
			return i;
1338
	}
1339
	return -1;
1340 1341
}

1342 1343 1344 1345
static int vidioc_queryctrl(struct file *file, void *priv,
			   struct v4l2_queryctrl *q_ctrl)
{
	struct gspca_dev *gspca_dev = priv;
1346
	const struct ctrl *ctrls;
1347 1348
	struct gspca_ctrl *gspca_ctrl;
	int i, idx;
1349 1350 1351 1352 1353 1354
	u32 id;

	id = q_ctrl->id;
	if (id & V4L2_CTRL_FLAG_NEXT_CTRL) {
		id &= V4L2_CTRL_ID_MASK;
		id++;
1355
		idx = -1;
1356
		for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
1357
			if (gspca_dev->ctrl_dis & (1 << i))
1358
				continue;
1359
			if (gspca_dev->sd_desc->ctrls[i].qctrl.id < id)
1360
				continue;
1361 1362
			if (idx >= 0
			 && gspca_dev->sd_desc->ctrls[i].qctrl.id
1363
				    > gspca_dev->sd_desc->ctrls[idx].qctrl.id)
1364
				continue;
1365
			idx = i;
1366
		}
1367
	} else {
1368
		idx = get_ctrl(gspca_dev, id);
1369
	}
1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380
	if (idx < 0)
		return -EINVAL;
	ctrls = &gspca_dev->sd_desc->ctrls[idx];
	memcpy(q_ctrl, &ctrls->qctrl, sizeof *q_ctrl);
	if (gspca_dev->cam.ctrls != NULL) {
		gspca_ctrl = &gspca_dev->cam.ctrls[idx];
		q_ctrl->default_value = gspca_ctrl->def;
		q_ctrl->minimum = gspca_ctrl->min;
		q_ctrl->maximum = gspca_ctrl->max;
	}
	if (gspca_dev->ctrl_inac & (1 << idx))
1381
		q_ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
1382
	return 0;
1383 1384 1385 1386 1387 1388
}

static int vidioc_s_ctrl(struct file *file, void *priv,
			 struct v4l2_control *ctrl)
{
	struct gspca_dev *gspca_dev = priv;
1389
	const struct ctrl *ctrls;
1390 1391
	struct gspca_ctrl *gspca_ctrl;
	int idx, ret;
1392

1393 1394
	idx = get_ctrl(gspca_dev, ctrl->id);
	if (idx < 0)
1395
		return -EINVAL;
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409
	if (gspca_dev->ctrl_inac & (1 << idx))
		return -EINVAL;
	ctrls = &gspca_dev->sd_desc->ctrls[idx];
	if (gspca_dev->cam.ctrls != NULL) {
		gspca_ctrl = &gspca_dev->cam.ctrls[idx];
		if (ctrl->value < gspca_ctrl->min
		    || ctrl->value > gspca_ctrl->max)
			return -ERANGE;
	} else {
		gspca_ctrl = NULL;
		if (ctrl->value < ctrls->qctrl.minimum
		    || ctrl->value > ctrls->qctrl.maximum)
			return -ERANGE;
	}
1410 1411 1412
	PDEBUG(D_CONF, "set ctrl [%08x] = %d", ctrl->id, ctrl->value);
	if (mutex_lock_interruptible(&gspca_dev->usb_lock))
		return -ERESTARTSYS;
1413 1414 1415 1416
	if (!gspca_dev->present) {
		ret = -ENODEV;
		goto out;
	}
1417
	gspca_dev->usb_err = 0;
1418
	if (ctrls->set != NULL) {
1419
		ret = ctrls->set(gspca_dev, ctrl->value);
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
		goto out;
	}
	if (gspca_ctrl != NULL) {
		gspca_ctrl->val = ctrl->value;
		if (ctrls->set_control != NULL
		 && gspca_dev->streaming)
			ctrls->set_control(gspca_dev);
	}
	ret = gspca_dev->usb_err;
out:
1430 1431
	mutex_unlock(&gspca_dev->usb_lock);
	return ret;
1432 1433 1434 1435 1436 1437
}

static int vidioc_g_ctrl(struct file *file, void *priv,
			 struct v4l2_control *ctrl)
{
	struct gspca_dev *gspca_dev = priv;
1438
	const struct ctrl *ctrls;
1439
	int idx, ret;
1440

1441 1442
	idx = get_ctrl(gspca_dev, ctrl->id);
	if (idx < 0)
1443
		return -EINVAL;
1444
	ctrls = &gspca_dev->sd_desc->ctrls[idx];
1445 1446 1447

	if (mutex_lock_interruptible(&gspca_dev->usb_lock))
		return -ERESTARTSYS;
1448 1449 1450 1451
	if (!gspca_dev->present) {
		ret = -ENODEV;
		goto out;
	}
1452
	gspca_dev->usb_err = 0;
1453
	if (ctrls->get != NULL) {
1454
		ret = ctrls->get(gspca_dev, &ctrl->value);
1455 1456 1457 1458 1459 1460
		goto out;
	}
	if (gspca_dev->cam.ctrls != NULL)
		ctrl->value = gspca_dev->cam.ctrls[idx].val;
	ret = 0;
out:
1461 1462
	mutex_unlock(&gspca_dev->usb_lock);
	return ret;
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
}

static int vidioc_querymenu(struct file *file, void *priv,
			    struct v4l2_querymenu *qmenu)
{
	struct gspca_dev *gspca_dev = priv;

	if (!gspca_dev->sd_desc->querymenu)
		return -EINVAL;
	return gspca_dev->sd_desc->querymenu(gspca_dev, qmenu);
}

static int vidioc_enum_input(struct file *file, void *priv,
				struct v4l2_input *input)
{
	struct gspca_dev *gspca_dev = priv;

	if (input->index != 0)
		return -EINVAL;
	input->type = V4L2_INPUT_TYPE_CAMERA;
1483
	input->status = gspca_dev->cam.input_flags;
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
	strncpy(input->name, gspca_dev->sd_desc->name,
		sizeof input->name);
	return 0;
}

static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
{
	*i = 0;
	return 0;
}

static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
{
	if (i > 0)
		return -EINVAL;
	return (0);
}

static int vidioc_reqbufs(struct file *file, void *priv,
			  struct v4l2_requestbuffers *rb)
{
	struct gspca_dev *gspca_dev = priv;
1506
	int i, ret = 0, streaming;
1507

1508 1509
	i = rb->memory;			/* (avoid compilation warning) */
	switch (i) {
1510
	case GSPCA_MEMORY_READ:			/* (internal call) */
1511 1512
	case V4L2_MEMORY_MMAP:
	case V4L2_MEMORY_USERPTR:
1513
		break;
1514
	default:
1515
		return -EINVAL;
1516
	}
1517 1518
	if (mutex_lock_interruptible(&gspca_dev->queue_lock))
		return -ERESTARTSYS;
1519

1520 1521
	if (gspca_dev->memory != GSPCA_MEMORY_NO
	    && gspca_dev->memory != rb->memory) {
1522 1523 1524
		ret = -EBUSY;
		goto out;
	}
1525

1526 1527 1528 1529 1530 1531 1532 1533 1534 1535
	/* only one file may do the capture */
	if (gspca_dev->capt_file != NULL
	    && gspca_dev->capt_file != file) {
		ret = -EBUSY;
		goto out;
	}

	/* if allocated, the buffers must not be mapped */
	for (i = 0; i < gspca_dev->nframes; i++) {
		if (gspca_dev->frame[i].vma_use_count) {
1536 1537 1538
			ret = -EBUSY;
			goto out;
		}
1539 1540 1541
	}

	/* stop streaming */
1542 1543
	streaming = gspca_dev->streaming;
	if (streaming) {
1544
		mutex_lock(&gspca_dev->usb_lock);
1545
		gspca_dev->usb_err = 0;
1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
		gspca_stream_off(gspca_dev);
		mutex_unlock(&gspca_dev->usb_lock);
	}

	/* free the previous allocated buffers, if any */
	if (gspca_dev->nframes != 0) {
		frame_free(gspca_dev);
		gspca_dev->capt_file = NULL;
	}
	if (rb->count == 0)			/* unrequest */
		goto out;
	gspca_dev->memory = rb->memory;
	ret = frame_alloc(gspca_dev, rb->count);
	if (ret == 0) {
		rb->count = gspca_dev->nframes;
		gspca_dev->capt_file = file;
1562 1563
		if (streaming)
			ret = gspca_init_transfer(gspca_dev);
1564 1565
	}
out:
1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
	mutex_unlock(&gspca_dev->queue_lock);
	PDEBUG(D_STREAM, "reqbufs st:%d c:%d", ret, rb->count);
	return ret;
}

static int vidioc_querybuf(struct file *file, void *priv,
			   struct v4l2_buffer *v4l2_buf)
{
	struct gspca_dev *gspca_dev = priv;
	struct gspca_frame *frame;

1577
	if (v4l2_buf->index < 0
1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593
	    || v4l2_buf->index >= gspca_dev->nframes)
		return -EINVAL;

	frame = &gspca_dev->frame[v4l2_buf->index];
	memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
	return 0;
}

static int vidioc_streamon(struct file *file, void *priv,
			   enum v4l2_buf_type buf_type)
{
	struct gspca_dev *gspca_dev = priv;
	int ret;

	if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
		return -EINVAL;
1594 1595
	if (mutex_lock_interruptible(&gspca_dev->queue_lock))
		return -ERESTARTSYS;
1596

1597 1598 1599 1600 1601 1602
	/* check the capture file */
	if (gspca_dev->capt_file != file) {
		ret = -EBUSY;
		goto out;
	}

1603 1604
	if (gspca_dev->nframes == 0
	    || !(gspca_dev->frame[0].v4l2_buf.flags & V4L2_BUF_FLAG_QUEUED)) {
1605 1606 1607 1608 1609 1610 1611 1612
		ret = -EINVAL;
		goto out;
	}
	if (!gspca_dev->streaming) {
		ret = gspca_init_transfer(gspca_dev);
		if (ret < 0)
			goto out;
	}
1613
#ifdef GSPCA_DEBUG
1614 1615 1616 1617 1618 1619 1620
	if (gspca_debug & D_STREAM) {
		PDEBUG_MODE("stream on OK",
			gspca_dev->pixfmt,
			gspca_dev->width,
			gspca_dev->height);
	}
#endif
1621
	ret = 0;
1622 1623 1624 1625 1626 1627 1628 1629 1630
out:
	mutex_unlock(&gspca_dev->queue_lock);
	return ret;
}

static int vidioc_streamoff(struct file *file, void *priv,
				enum v4l2_buf_type buf_type)
{
	struct gspca_dev *gspca_dev = priv;
1631
	int ret;
1632 1633 1634

	if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
		return -EINVAL;
1635 1636 1637 1638
	if (!gspca_dev->streaming)
		return 0;
	if (mutex_lock_interruptible(&gspca_dev->queue_lock))
		return -ERESTARTSYS;
1639

1640 1641 1642 1643 1644 1645
	/* check the capture file */
	if (gspca_dev->capt_file != file) {
		ret = -EBUSY;
		goto out;
	}

1646
	/* stop streaming */
1647 1648 1649
	if (mutex_lock_interruptible(&gspca_dev->usb_lock)) {
		ret = -ERESTARTSYS;
		goto out;
1650
	}
1651
	gspca_dev->usb_err = 0;
1652 1653
	gspca_stream_off(gspca_dev);
	mutex_unlock(&gspca_dev->usb_lock);
1654

1655 1656 1657 1658
	/* empty the transfer queues */
	atomic_set(&gspca_dev->fr_q, 0);
	atomic_set(&gspca_dev->fr_i, 0);
	gspca_dev->fr_o = 0;
1659
	ret = 0;
1660 1661 1662
out:
	mutex_unlock(&gspca_dev->queue_lock);
	return ret;
1663 1664 1665 1666 1667 1668 1669 1670 1671 1672
}

static int vidioc_g_jpegcomp(struct file *file, void *priv,
			struct v4l2_jpegcompression *jpegcomp)
{
	struct gspca_dev *gspca_dev = priv;
	int ret;

	if (!gspca_dev->sd_desc->get_jcomp)
		return -EINVAL;
1673 1674
	if (mutex_lock_interruptible(&gspca_dev->usb_lock))
		return -ERESTARTSYS;
1675
	gspca_dev->usb_err = 0;
1676 1677 1678 1679
	if (gspca_dev->present)
		ret = gspca_dev->sd_desc->get_jcomp(gspca_dev, jpegcomp);
	else
		ret = -ENODEV;
1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
	mutex_unlock(&gspca_dev->usb_lock);
	return ret;
}

static int vidioc_s_jpegcomp(struct file *file, void *priv,
			struct v4l2_jpegcompression *jpegcomp)
{
	struct gspca_dev *gspca_dev = priv;
	int ret;

	if (!gspca_dev->sd_desc->set_jcomp)
		return -EINVAL;
1692 1693
	if (mutex_lock_interruptible(&gspca_dev->usb_lock))
		return -ERESTARTSYS;
1694
	gspca_dev->usb_err = 0;
1695 1696 1697 1698
	if (gspca_dev->present)
		ret = gspca_dev->sd_desc->set_jcomp(gspca_dev, jpegcomp);
	else
		ret = -ENODEV;
1699 1700 1701 1702 1703 1704 1705 1706 1707 1708
	mutex_unlock(&gspca_dev->usb_lock);
	return ret;
}

static int vidioc_g_parm(struct file *filp, void *priv,
			struct v4l2_streamparm *parm)
{
	struct gspca_dev *gspca_dev = priv;

	parm->parm.capture.readbuffers = gspca_dev->nbufread;
1709 1710 1711 1712 1713 1714

	if (gspca_dev->sd_desc->get_streamparm) {
		int ret;

		if (mutex_lock_interruptible(&gspca_dev->usb_lock))
			return -ERESTARTSYS;
1715
		gspca_dev->usb_err = 0;
1716 1717 1718 1719 1720
		if (gspca_dev->present)
			ret = gspca_dev->sd_desc->get_streamparm(gspca_dev,
								 parm);
		else
			ret = -ENODEV;
1721 1722 1723 1724
		mutex_unlock(&gspca_dev->usb_lock);
		return ret;
	}

1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
	return 0;
}

static int vidioc_s_parm(struct file *filp, void *priv,
			struct v4l2_streamparm *parm)
{
	struct gspca_dev *gspca_dev = priv;
	int n;

	n = parm->parm.capture.readbuffers;
1735
	if (n == 0 || n >= GSPCA_MAX_FRAMES)
1736 1737 1738
		parm->parm.capture.readbuffers = gspca_dev->nbufread;
	else
		gspca_dev->nbufread = n;
1739 1740 1741 1742 1743 1744

	if (gspca_dev->sd_desc->set_streamparm) {
		int ret;

		if (mutex_lock_interruptible(&gspca_dev->usb_lock))
			return -ERESTARTSYS;
1745
		gspca_dev->usb_err = 0;
1746 1747 1748 1749 1750
		if (gspca_dev->present)
			ret = gspca_dev->sd_desc->set_streamparm(gspca_dev,
								 parm);
		else
			ret = -ENODEV;
1751 1752 1753 1754
		mutex_unlock(&gspca_dev->usb_lock);
		return ret;
	}

1755 1756 1757 1758 1759 1760
	return 0;
}

static int dev_mmap(struct file *file, struct vm_area_struct *vma)
{
	struct gspca_dev *gspca_dev = file->private_data;
1761
	struct gspca_frame *frame;
1762 1763 1764 1765 1766 1767 1768 1769
	struct page *page;
	unsigned long addr, start, size;
	int i, ret;

	start = vma->vm_start;
	size = vma->vm_end - vma->vm_start;
	PDEBUG(D_STREAM, "mmap start:%08x size:%d", (int) start, (int) size);

1770 1771
	if (mutex_lock_interruptible(&gspca_dev->queue_lock))
		return -ERESTARTSYS;
1772 1773
	if (!gspca_dev->present) {
		ret = -ENODEV;
1774 1775 1776 1777 1778
		goto out;
	}
	if (gspca_dev->capt_file != file) {
		ret = -EINVAL;
		goto out;
1779 1780
	}

1781
	frame = NULL;
1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
	for (i = 0; i < gspca_dev->nframes; ++i) {
		if (gspca_dev->frame[i].v4l2_buf.memory != V4L2_MEMORY_MMAP) {
			PDEBUG(D_STREAM, "mmap bad memory type");
			break;
		}
		if ((gspca_dev->frame[i].v4l2_buf.m.offset >> PAGE_SHIFT)
						== vma->vm_pgoff) {
			frame = &gspca_dev->frame[i];
			break;
		}
	}
1793
	if (frame == NULL) {
1794 1795
		PDEBUG(D_STREAM, "mmap no frame buffer found");
		ret = -EINVAL;
1796
		goto out;
1797
	}
1798
	if (size != frame->v4l2_buf.length) {
1799 1800
		PDEBUG(D_STREAM, "mmap bad size");
		ret = -EINVAL;
1801
		goto out;
1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814
	}

	/*
	 * - VM_IO marks the area as being a mmaped region for I/O to a
	 *   device. It also prevents the region from being core dumped.
	 */
	vma->vm_flags |= VM_IO;

	addr = (unsigned long) frame->data;
	while (size > 0) {
		page = vmalloc_to_page((void *) addr);
		ret = vm_insert_page(vma, start, page);
		if (ret < 0)
1815
			goto out;
1816 1817 1818 1819 1820
		start += PAGE_SIZE;
		addr += PAGE_SIZE;
		size -= PAGE_SIZE;
	}

1821
	vma->vm_ops = &gspca_vm_ops;
1822 1823
	vma->vm_private_data = frame;
	gspca_vm_open(vma);
1824
	ret = 0;
1825
out:
1826 1827 1828 1829 1830 1831 1832 1833 1834
	mutex_unlock(&gspca_dev->queue_lock);
	return ret;
}

/*
 * wait for a video frame
 *
 * If a frame is ready, its index is returned.
 */
1835
static int frame_wait(struct gspca_dev *gspca_dev,
1836 1837
			int nonblock_ing)
{
1838
	int i, ret;
1839

1840
	/* check if a frame is ready */
1841
	i = gspca_dev->fr_o;
1842
	if (i == atomic_read(&gspca_dev->fr_i)) {
1843 1844 1845 1846
		if (nonblock_ing)
			return -EAGAIN;

		/* wait till a frame is ready */
1847
		ret = wait_event_interruptible_timeout(gspca_dev->wq,
1848
			i != atomic_read(&gspca_dev->fr_i) ||
1849 1850 1851 1852 1853
			!gspca_dev->streaming || !gspca_dev->present,
			msecs_to_jiffies(3000));
		if (ret < 0)
			return ret;
		if (ret == 0 || !gspca_dev->streaming || !gspca_dev->present)
1854
			return -EIO;
1855
	}
1856

1857
	gspca_dev->fr_o = (i + 1) % GSPCA_MAX_FRAMES;
1858

1859 1860
	if (gspca_dev->sd_desc->dq_callback) {
		mutex_lock(&gspca_dev->usb_lock);
1861
		gspca_dev->usb_err = 0;
1862 1863
		if (gspca_dev->present)
			gspca_dev->sd_desc->dq_callback(gspca_dev);
1864 1865
		mutex_unlock(&gspca_dev->usb_lock);
	}
1866
	return gspca_dev->fr_queue[i];
1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881
}

/*
 * dequeue a video buffer
 *
 * If nonblock_ing is false, block until a buffer is available.
 */
static int vidioc_dqbuf(struct file *file, void *priv,
			struct v4l2_buffer *v4l2_buf)
{
	struct gspca_dev *gspca_dev = priv;
	struct gspca_frame *frame;
	int i, ret;

	PDEBUG(D_FRAM, "dqbuf");
1882
	if (v4l2_buf->memory != gspca_dev->memory)
1883
		return -EINVAL;
1884

1885 1886 1887
	if (!gspca_dev->present)
		return -ENODEV;

1888 1889 1890
	/* if not streaming, be sure the application will not loop forever */
	if (!(file->f_flags & O_NONBLOCK)
	    && !gspca_dev->streaming && gspca_dev->users == 1)
1891 1892
		return -EINVAL;

1893 1894 1895 1896 1897
	/* only the capturing file may dequeue */
	if (gspca_dev->capt_file != file)
		return -EINVAL;

	/* only one dequeue / read at a time */
1898 1899 1900
	if (mutex_lock_interruptible(&gspca_dev->read_lock))
		return -ERESTARTSYS;

1901
	ret = frame_wait(gspca_dev, file->f_flags & O_NONBLOCK);
1902
	if (ret < 0)
1903
		goto out;
1904 1905
	i = ret;				/* frame index */
	frame = &gspca_dev->frame[i];
1906
	if (gspca_dev->memory == V4L2_MEMORY_USERPTR) {
1907
		if (copy_to_user((__u8 __user *) frame->v4l2_buf.m.userptr,
1908 1909 1910 1911 1912 1913 1914 1915
				 frame->data,
				 frame->v4l2_buf.bytesused)) {
			PDEBUG(D_ERR|D_STREAM,
				"dqbuf cp to user failed");
			ret = -EFAULT;
			goto out;
		}
	}
1916 1917 1918 1919
	frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_DONE;
	memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
	PDEBUG(D_FRAM, "dqbuf %d", i);
	ret = 0;
1920
out:
1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939
	mutex_unlock(&gspca_dev->read_lock);
	return ret;
}

/*
 * queue a video buffer
 *
 * Attempting to queue a buffer that has already been
 * queued will return -EINVAL.
 */
static int vidioc_qbuf(struct file *file, void *priv,
			struct v4l2_buffer *v4l2_buf)
{
	struct gspca_dev *gspca_dev = priv;
	struct gspca_frame *frame;
	int i, index, ret;

	PDEBUG(D_FRAM, "qbuf %d", v4l2_buf->index);

1940 1941 1942
	if (mutex_lock_interruptible(&gspca_dev->queue_lock))
		return -ERESTARTSYS;

1943 1944
	index = v4l2_buf->index;
	if ((unsigned) index >= gspca_dev->nframes) {
1945
		PDEBUG(D_FRAM,
1946
			"qbuf idx %d >= %d", index, gspca_dev->nframes);
1947 1948
		ret = -EINVAL;
		goto out;
1949
	}
1950
	if (v4l2_buf->memory != gspca_dev->memory) {
1951
		PDEBUG(D_FRAM, "qbuf bad memory type");
1952 1953
		ret = -EINVAL;
		goto out;
1954
	}
1955

1956
	frame = &gspca_dev->frame[index];
1957 1958
	if (frame->v4l2_buf.flags & BUF_ALL_FLAGS) {
		PDEBUG(D_FRAM, "qbuf bad state");
1959 1960 1961 1962 1963 1964
		ret = -EINVAL;
		goto out;
	}

	frame->v4l2_buf.flags |= V4L2_BUF_FLAG_QUEUED;

1965
	if (frame->v4l2_buf.memory == V4L2_MEMORY_USERPTR) {
1966 1967 1968 1969 1970
		frame->v4l2_buf.m.userptr = v4l2_buf->m.userptr;
		frame->v4l2_buf.length = v4l2_buf->length;
	}

	/* put the buffer in the 'queued' queue */
1971
	i = atomic_read(&gspca_dev->fr_q);
1972
	gspca_dev->fr_queue[i] = index;
1973
	atomic_set(&gspca_dev->fr_q, (i + 1) % GSPCA_MAX_FRAMES);
1974 1975 1976 1977 1978 1979 1980 1981 1982

	v4l2_buf->flags |= V4L2_BUF_FLAG_QUEUED;
	v4l2_buf->flags &= ~V4L2_BUF_FLAG_DONE;
	ret = 0;
out:
	mutex_unlock(&gspca_dev->queue_lock);
	return ret;
}

1983 1984 1985 1986 1987
/*
 * allocate the resources for read()
 */
static int read_alloc(struct gspca_dev *gspca_dev,
			struct file *file)
1988 1989
{
	struct v4l2_buffer v4l2_buf;
1990
	int i, ret;
1991

1992
	PDEBUG(D_STREAM, "read alloc");
1993 1994 1995 1996 1997 1998
	if (gspca_dev->nframes == 0) {
		struct v4l2_requestbuffers rb;

		memset(&rb, 0, sizeof rb);
		rb.count = gspca_dev->nbufread;
		rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1999
		rb.memory = GSPCA_MEMORY_READ;
2000 2001
		ret = vidioc_reqbufs(file, gspca_dev, &rb);
		if (ret != 0) {
2002
			PDEBUG(D_STREAM, "read reqbuf err %d", ret);
2003 2004 2005 2006
			return ret;
		}
		memset(&v4l2_buf, 0, sizeof v4l2_buf);
		v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
2007
		v4l2_buf.memory = GSPCA_MEMORY_READ;
2008 2009 2010 2011 2012 2013 2014 2015
		for (i = 0; i < gspca_dev->nbufread; i++) {
			v4l2_buf.index = i;
			ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
			if (ret != 0) {
				PDEBUG(D_STREAM, "read qbuf err: %d", ret);
				return ret;
			}
		}
2016 2017
		gspca_dev->memory = GSPCA_MEMORY_READ;
	}
2018

2019 2020 2021 2022 2023 2024 2025 2026 2027 2028
	/* start streaming */
	ret = vidioc_streamon(file, gspca_dev, V4L2_BUF_TYPE_VIDEO_CAPTURE);
	if (ret != 0)
		PDEBUG(D_STREAM, "read streamon err %d", ret);
	return ret;
}

static unsigned int dev_poll(struct file *file, poll_table *wait)
{
	struct gspca_dev *gspca_dev = file->private_data;
2029
	int ret;
2030 2031 2032 2033 2034

	PDEBUG(D_FRAM, "poll");

	poll_wait(file, &gspca_dev->wq, wait);

2035 2036 2037 2038
	/* if reqbufs is not done, the user would use read() */
	if (gspca_dev->nframes == 0) {
		if (gspca_dev->memory != GSPCA_MEMORY_NO)
			return POLLERR;		/* not the 1st time */
2039
		ret = read_alloc(gspca_dev, file);
2040 2041
		if (ret != 0)
			return POLLERR;
2042 2043
	}

2044 2045 2046
	if (mutex_lock_interruptible(&gspca_dev->queue_lock) != 0)
		return POLLERR;

2047 2048 2049
	/* check if an image has been received */
	if (gspca_dev->fr_o != atomic_read(&gspca_dev->fr_i))
		ret = POLLIN | POLLRDNORM;	/* yes */
2050 2051 2052
	else
		ret = 0;
	mutex_unlock(&gspca_dev->queue_lock);
2053 2054
	if (!gspca_dev->present)
		return POLLHUP;
2055 2056 2057 2058 2059 2060 2061 2062 2063 2064
	return ret;
}

static ssize_t dev_read(struct file *file, char __user *data,
		    size_t count, loff_t *ppos)
{
	struct gspca_dev *gspca_dev = file->private_data;
	struct gspca_frame *frame;
	struct v4l2_buffer v4l2_buf;
	struct timeval timestamp;
2065
	int n, ret, ret2;
2066

2067
	PDEBUG(D_FRAM, "read (%zd)", count);
2068 2069 2070 2071 2072 2073 2074 2075 2076
	if (!gspca_dev->present)
		return -ENODEV;
	switch (gspca_dev->memory) {
	case GSPCA_MEMORY_NO:			/* first time */
		ret = read_alloc(gspca_dev, file);
		if (ret != 0)
			return ret;
		break;
	case GSPCA_MEMORY_READ:
2077 2078 2079
		if (gspca_dev->capt_file == file)
			break;
		/* fall thru */
2080 2081 2082 2083
	default:
		return -EINVAL;
	}

2084
	/* get a frame */
2085
	timestamp = ktime_to_timeval(ktime_get());
2086
	timestamp.tv_sec--;
2087 2088
	n = 2;
	for (;;) {
2089 2090
		memset(&v4l2_buf, 0, sizeof v4l2_buf);
		v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
2091
		v4l2_buf.memory = GSPCA_MEMORY_READ;
2092 2093 2094 2095 2096 2097 2098
		ret = vidioc_dqbuf(file, gspca_dev, &v4l2_buf);
		if (ret != 0) {
			PDEBUG(D_STREAM, "read dqbuf err %d", ret);
			return ret;
		}

		/* if the process slept for more than 1 second,
2099
		 * get a newer frame */
2100
		frame = &gspca_dev->frame[v4l2_buf.index];
2101 2102
		if (--n < 0)
			break;			/* avoid infinite loop */
2103 2104 2105 2106 2107 2108 2109 2110 2111 2112
		if (frame->v4l2_buf.timestamp.tv_sec >= timestamp.tv_sec)
			break;
		ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
		if (ret != 0) {
			PDEBUG(D_STREAM, "read qbuf err %d", ret);
			return ret;
		}
	}

	/* copy the frame */
2113 2114
	if (count > frame->v4l2_buf.bytesused)
		count = frame->v4l2_buf.bytesused;
2115 2116 2117
	ret = copy_to_user(data, frame->data, count);
	if (ret != 0) {
		PDEBUG(D_ERR|D_STREAM,
2118
			"read cp to user lack %d / %zd", ret, count);
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130
		ret = -EFAULT;
		goto out;
	}
	ret = count;
out:
	/* in each case, requeue the buffer */
	ret2 = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
	if (ret2 != 0)
		return ret2;
	return ret;
}

2131
static struct v4l2_file_operations dev_fops = {
2132 2133 2134 2135 2136
	.owner = THIS_MODULE,
	.open = dev_open,
	.release = dev_close,
	.read = dev_read,
	.mmap = dev_mmap,
2137
	.unlocked_ioctl = video_ioctl2,
2138 2139 2140
	.poll	= dev_poll,
};

2141
static const struct v4l2_ioctl_ops dev_ioctl_ops = {
2142 2143 2144
	.vidioc_querycap	= vidioc_querycap,
	.vidioc_dqbuf		= vidioc_dqbuf,
	.vidioc_qbuf		= vidioc_qbuf,
2145 2146 2147 2148
	.vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
	.vidioc_try_fmt_vid_cap	= vidioc_try_fmt_vid_cap,
	.vidioc_g_fmt_vid_cap	= vidioc_g_fmt_vid_cap,
	.vidioc_s_fmt_vid_cap	= vidioc_s_fmt_vid_cap,
2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163
	.vidioc_streamon	= vidioc_streamon,
	.vidioc_queryctrl	= vidioc_queryctrl,
	.vidioc_g_ctrl		= vidioc_g_ctrl,
	.vidioc_s_ctrl		= vidioc_s_ctrl,
	.vidioc_querymenu	= vidioc_querymenu,
	.vidioc_enum_input	= vidioc_enum_input,
	.vidioc_g_input		= vidioc_g_input,
	.vidioc_s_input		= vidioc_s_input,
	.vidioc_reqbufs		= vidioc_reqbufs,
	.vidioc_querybuf	= vidioc_querybuf,
	.vidioc_streamoff	= vidioc_streamoff,
	.vidioc_g_jpegcomp	= vidioc_g_jpegcomp,
	.vidioc_s_jpegcomp	= vidioc_s_jpegcomp,
	.vidioc_g_parm		= vidioc_g_parm,
	.vidioc_s_parm		= vidioc_s_parm,
2164
	.vidioc_enum_framesizes = vidioc_enum_framesizes,
2165
	.vidioc_enum_frameintervals = vidioc_enum_frameintervals,
2166 2167 2168 2169 2170
#ifdef CONFIG_VIDEO_ADV_DEBUG
	.vidioc_g_register	= vidioc_g_register,
	.vidioc_s_register	= vidioc_s_register,
#endif
	.vidioc_g_chip_ident	= vidioc_g_chip_ident,
2171 2172
};

2173 2174 2175 2176
static struct video_device gspca_template = {
	.name = "gspca main driver",
	.fops = &dev_fops,
	.ioctl_ops = &dev_ioctl_ops,
2177
	.release = gspca_release,
2178 2179
};

2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195
/* initialize the controls */
static void ctrls_init(struct gspca_dev *gspca_dev)
{
	struct gspca_ctrl *ctrl;
	int i;

	for (i = 0, ctrl = gspca_dev->cam.ctrls;
	     i < gspca_dev->sd_desc->nctrls;
	     i++, ctrl++) {
		ctrl->def = gspca_dev->sd_desc->ctrls[i].qctrl.default_value;
		ctrl->val = ctrl->def;
		ctrl->min = gspca_dev->sd_desc->ctrls[i].qctrl.minimum;
		ctrl->max = gspca_dev->sd_desc->ctrls[i].qctrl.maximum;
	}
}

2196 2197 2198 2199 2200 2201
/*
 * probe and create a new gspca device
 *
 * This function must be called by the sub-driver when it is
 * called for probing a new device.
 */
2202
int gspca_dev_probe2(struct usb_interface *intf,
2203 2204
		const struct usb_device_id *id,
		const struct sd_desc *sd_desc,
2205 2206
		int dev_size,
		struct module *module)
2207 2208 2209 2210 2211
{
	struct gspca_dev *gspca_dev;
	struct usb_device *dev = interface_to_usbdev(intf);
	int ret;

2212
	PDEBUG(D_PROBE, "probing %04x:%04x", id->idVendor, id->idProduct);
2213 2214 2215 2216 2217

	/* create the device */
	if (dev_size < sizeof *gspca_dev)
		dev_size = sizeof *gspca_dev;
	gspca_dev = kzalloc(dev_size, GFP_KERNEL);
2218
	if (!gspca_dev) {
2219
		err("couldn't kzalloc gspca struct");
2220
		return -ENOMEM;
2221
	}
2222 2223 2224
	gspca_dev->usb_buf = kmalloc(USB_BUF_SZ, GFP_KERNEL);
	if (!gspca_dev->usb_buf) {
		err("out of memory");
2225
		ret = -ENOMEM;
2226 2227
		goto out;
	}
2228
	gspca_dev->dev = dev;
2229
	gspca_dev->iface = intf->cur_altsetting->desc.bInterfaceNumber;
2230
	gspca_dev->nbalt = intf->num_altsetting;
2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248

	/* check if any audio device */
	if (dev->config->desc.bNumInterfaces != 1) {
		int i;
		struct usb_interface *intf2;

		for (i = 0; i < dev->config->desc.bNumInterfaces; i++) {
			intf2 = dev->config->interface[i];
			if (intf2 != NULL
			 && intf2->altsetting != NULL
			 && intf2->altsetting->desc.bInterfaceClass ==
					 USB_CLASS_AUDIO) {
				gspca_dev->audio = 1;
				break;
			}
		}
	}

2249 2250
	gspca_dev->sd_desc = sd_desc;
	gspca_dev->nbufread = 2;
2251
	gspca_dev->empty_packet = -1;	/* don't check the empty packets */
2252

2253
	/* configure the subdriver and initialize the USB device */
2254
	ret = sd_desc->config(gspca_dev, id);
2255 2256
	if (ret < 0)
		goto out;
2257 2258
	if (gspca_dev->cam.ctrls != NULL)
		ctrls_init(gspca_dev);
2259
	ret = sd_desc->init(gspca_dev);
2260 2261 2262 2263
	if (ret < 0)
		goto out;
	gspca_set_default_mode(gspca_dev);

2264 2265 2266 2267
	ret = gspca_input_connect(gspca_dev);
	if (ret)
		goto out;

2268 2269 2270 2271 2272 2273
	mutex_init(&gspca_dev->usb_lock);
	mutex_init(&gspca_dev->read_lock);
	mutex_init(&gspca_dev->queue_lock);
	init_waitqueue_head(&gspca_dev->wq);

	/* init video stuff */
2274
	memcpy(&gspca_dev->vdev, &gspca_template, sizeof gspca_template);
2275
	gspca_dev->vdev.parent = &intf->dev;
2276
	gspca_dev->module = module;
2277
	gspca_dev->present = 1;
2278
	ret = video_register_device(&gspca_dev->vdev,
2279
				  VFL_TYPE_GRABBER,
2280
				  -1);
2281 2282 2283 2284 2285 2286
	if (ret < 0) {
		err("video_register_device err %d", ret);
		goto out;
	}

	usb_set_intfdata(intf, gspca_dev);
2287
	PDEBUG(D_PROBE, "%s created", video_device_node_name(&gspca_dev->vdev));
2288

2289
	gspca_input_create_urb(gspca_dev);
2290

2291 2292
	return 0;
out:
2293
#if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
2294 2295
	if (gspca_dev->input_dev)
		input_unregister_device(gspca_dev->input_dev);
2296
#endif
2297 2298
	kfree(gspca_dev->usb_buf);
	kfree(gspca_dev);
2299 2300
	return ret;
}
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313
EXPORT_SYMBOL(gspca_dev_probe2);

/* same function as the previous one, but check the interface */
int gspca_dev_probe(struct usb_interface *intf,
		const struct usb_device_id *id,
		const struct sd_desc *sd_desc,
		int dev_size,
		struct module *module)
{
	struct usb_device *dev = interface_to_usbdev(intf);

	/* we don't handle multi-config cameras */
	if (dev->descriptor.bNumConfigurations != 1) {
2314
		err("%04x:%04x too many config",
2315 2316 2317 2318 2319 2320
				id->idVendor, id->idProduct);
		return -ENODEV;
	}

	/* the USB video interface must be the first one */
	if (dev->config->desc.bNumInterfaces != 1
2321
	 && intf->cur_altsetting->desc.bInterfaceNumber != 0)
2322 2323 2324 2325
		return -ENODEV;

	return gspca_dev_probe2(intf, id, sd_desc, dev_size, module);
}
2326 2327 2328 2329 2330 2331 2332 2333 2334 2335
EXPORT_SYMBOL(gspca_dev_probe);

/*
 * USB disconnection
 *
 * This function must be called by the sub-driver
 * when the device disconnects, after the specific resources are freed.
 */
void gspca_disconnect(struct usb_interface *intf)
{
2336
	struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2337
#if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
2338
	struct input_dev *input_dev;
2339
#endif
2340

2341 2342
	PDEBUG(D_PROBE, "%s disconnect",
		video_device_node_name(&gspca_dev->vdev));
2343
	mutex_lock(&gspca_dev->usb_lock);
2344 2345
	gspca_dev->present = 0;

2346 2347 2348 2349 2350
	if (gspca_dev->streaming) {
		destroy_urbs(gspca_dev);
		wake_up_interruptible(&gspca_dev->wq);
	}

2351
#if defined(CONFIG_INPUT) || defined(CONFIG_INPUT_MODULE)
2352 2353 2354 2355 2356 2357
	gspca_input_destroy_urb(gspca_dev);
	input_dev = gspca_dev->input_dev;
	if (input_dev) {
		gspca_dev->input_dev = NULL;
		input_unregister_device(input_dev);
	}
2358
#endif
2359

2360
	/* the device is freed at exit of this function */
2361
	gspca_dev->dev = NULL;
2362 2363
	mutex_unlock(&gspca_dev->usb_lock);

2364 2365
	usb_set_intfdata(intf, NULL);

2366 2367 2368
	/* release the device */
	/* (this will call gspca_release() immediatly or on last close) */
	video_unregister_device(&gspca_dev->vdev);
2369

2370
/*	PDEBUG(D_PROBE, "disconnect complete"); */
2371 2372 2373
}
EXPORT_SYMBOL(gspca_disconnect);

2374 2375 2376 2377 2378 2379 2380 2381
#ifdef CONFIG_PM
int gspca_suspend(struct usb_interface *intf, pm_message_t message)
{
	struct gspca_dev *gspca_dev = usb_get_intfdata(intf);

	if (!gspca_dev->streaming)
		return 0;
	gspca_dev->frozen = 1;		/* avoid urb error messages */
2382 2383
	if (gspca_dev->sd_desc->stopN)
		gspca_dev->sd_desc->stopN(gspca_dev);
2384
	destroy_urbs(gspca_dev);
2385
	gspca_input_destroy_urb(gspca_dev);
2386
	gspca_set_alt0(gspca_dev);
2387 2388
	if (gspca_dev->sd_desc->stop0)
		gspca_dev->sd_desc->stop0(gspca_dev);
2389 2390 2391 2392 2393 2394 2395 2396 2397
	return 0;
}
EXPORT_SYMBOL(gspca_suspend);

int gspca_resume(struct usb_interface *intf)
{
	struct gspca_dev *gspca_dev = usb_get_intfdata(intf);

	gspca_dev->frozen = 0;
2398
	gspca_dev->sd_desc->init(gspca_dev);
2399
	gspca_input_create_urb(gspca_dev);
2400 2401
	if (gspca_dev->streaming)
		return gspca_init_transfer(gspca_dev);
2402
	return 0;
2403 2404 2405
}
EXPORT_SYMBOL(gspca_resume);
#endif
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422
/* -- cam driver utility functions -- */

/* auto gain and exposure algorithm based on the knee algorithm described here:
   http://ytse.tricolour.net/docs/LowLightOptimization.html

   Returns 0 if no changes were made, 1 if the gain and or exposure settings
   where changed. */
int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
	int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee)
{
	int i, steps, gain, orig_gain, exposure, orig_exposure, autogain;
	const struct ctrl *gain_ctrl = NULL;
	const struct ctrl *exposure_ctrl = NULL;
	const struct ctrl *autogain_ctrl = NULL;
	int retval = 0;

	for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
2423 2424
		if (gspca_dev->ctrl_dis & (1 << i))
			continue;
2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449
		if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_GAIN)
			gain_ctrl = &gspca_dev->sd_desc->ctrls[i];
		if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_EXPOSURE)
			exposure_ctrl = &gspca_dev->sd_desc->ctrls[i];
		if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_AUTOGAIN)
			autogain_ctrl = &gspca_dev->sd_desc->ctrls[i];
	}
	if (!gain_ctrl || !exposure_ctrl || !autogain_ctrl) {
		PDEBUG(D_ERR, "Error: gspca_auto_gain_n_exposure called "
			"on cam without (auto)gain/exposure");
		return 0;
	}

	if (gain_ctrl->get(gspca_dev, &gain) ||
			exposure_ctrl->get(gspca_dev, &exposure) ||
			autogain_ctrl->get(gspca_dev, &autogain) || !autogain)
		return 0;

	orig_gain = gain;
	orig_exposure = exposure;

	/* If we are of a multiple of deadzone, do multiple steps to reach the
	   desired lumination fast (with the risc of a slight overshoot) */
	steps = abs(desired_avg_lum - avg_lum) / deadzone;

2450
	PDEBUG(D_FRAM, "autogain: lum: %d, desired: %d, steps: %d",
2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495
		avg_lum, desired_avg_lum, steps);

	for (i = 0; i < steps; i++) {
		if (avg_lum > desired_avg_lum) {
			if (gain > gain_knee)
				gain--;
			else if (exposure > exposure_knee)
				exposure--;
			else if (gain > gain_ctrl->qctrl.default_value)
				gain--;
			else if (exposure > exposure_ctrl->qctrl.minimum)
				exposure--;
			else if (gain > gain_ctrl->qctrl.minimum)
				gain--;
			else
				break;
		} else {
			if (gain < gain_ctrl->qctrl.default_value)
				gain++;
			else if (exposure < exposure_knee)
				exposure++;
			else if (gain < gain_knee)
				gain++;
			else if (exposure < exposure_ctrl->qctrl.maximum)
				exposure++;
			else if (gain < gain_ctrl->qctrl.maximum)
				gain++;
			else
				break;
		}
	}

	if (gain != orig_gain) {
		gain_ctrl->set(gspca_dev, gain);
		retval = 1;
	}
	if (exposure != orig_exposure) {
		exposure_ctrl->set(gspca_dev, exposure);
		retval = 1;
	}

	return retval;
}
EXPORT_SYMBOL(gspca_auto_gain_n_exposure);

2496 2497 2498
/* -- module insert / remove -- */
static int __init gspca_init(void)
{
2499
	info("v%d.%d.%d registered",
2500 2501 2502
		(DRIVER_VERSION_NUMBER >> 16) & 0xff,
		(DRIVER_VERSION_NUMBER >> 8) & 0xff,
		DRIVER_VERSION_NUMBER & 0xff);
2503 2504 2505 2506 2507 2508 2509 2510 2511
	return 0;
}
static void __exit gspca_exit(void)
{
}

module_init(gspca_init);
module_exit(gspca_exit);

2512
#ifdef GSPCA_DEBUG
2513 2514 2515
module_param_named(debug, gspca_debug, int, 0644);
MODULE_PARM_DESC(debug,
		"Debug (bit) 0x01:error 0x02:probe 0x04:config"
2516 2517
		" 0x08:stream 0x10:frame 0x20:packet 0x40:USBin 0x80:USBout"
		" 0x0100: v4l2");
2518
#endif