V4L/DVB (9707): gspca: Remove the event counter and simplify the frame wait.
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / media / video / gspca / gspca.c
blobe77cc19be4ec129d9ad3ad34c62ad10be56b4e9f
1 /*
2 * Main USB camera driver
4 * V4L2 by Jean-Francois Moine <http://moinejf.free.fr>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #define MODULE_NAME "gspca"
23 #include <linux/init.h>
24 #include <linux/version.h>
25 #include <linux/fs.h>
26 #include <linux/vmalloc.h>
27 #include <linux/sched.h>
28 #include <linux/slab.h>
29 #include <linux/mm.h>
30 #include <linux/string.h>
31 #include <linux/pagemap.h>
32 #include <linux/io.h>
33 #include <asm/page.h>
34 #include <linux/uaccess.h>
35 #include <linux/jiffies.h>
36 #include <media/v4l2-ioctl.h>
38 #include "gspca.h"
40 /* global values */
41 #define DEF_NURBS 2 /* default number of URBs */
43 MODULE_AUTHOR("Jean-Francois Moine <http://moinejf.free.fr>");
44 MODULE_DESCRIPTION("GSPCA USB Camera Driver");
45 MODULE_LICENSE("GPL");
47 #define DRIVER_VERSION_NUMBER KERNEL_VERSION(2, 4, 0)
49 static int video_nr = -1;
51 #ifdef GSPCA_DEBUG
52 int gspca_debug = D_ERR | D_PROBE;
53 EXPORT_SYMBOL(gspca_debug);
55 static void PDEBUG_MODE(char *txt, __u32 pixfmt, int w, int h)
57 if ((pixfmt >> 24) >= '0' && (pixfmt >> 24) <= 'z') {
58 PDEBUG(D_CONF|D_STREAM, "%s %c%c%c%c %dx%d",
59 txt,
60 pixfmt & 0xff,
61 (pixfmt >> 8) & 0xff,
62 (pixfmt >> 16) & 0xff,
63 pixfmt >> 24,
64 w, h);
65 } else {
66 PDEBUG(D_CONF|D_STREAM, "%s 0x%08x %dx%d",
67 txt,
68 pixfmt,
69 w, h);
72 #else
73 #define PDEBUG_MODE(txt, pixfmt, w, h)
74 #endif
76 /* specific memory types - !! should different from V4L2_MEMORY_xxx */
77 #define GSPCA_MEMORY_NO 0 /* V4L2_MEMORY_xxx starts from 1 */
78 #define GSPCA_MEMORY_READ 7
80 #define BUF_ALL_FLAGS (V4L2_BUF_FLAG_QUEUED | V4L2_BUF_FLAG_DONE)
83 * VMA operations.
85 static void gspca_vm_open(struct vm_area_struct *vma)
87 struct gspca_frame *frame = vma->vm_private_data;
89 frame->vma_use_count++;
90 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_MAPPED;
93 static void gspca_vm_close(struct vm_area_struct *vma)
95 struct gspca_frame *frame = vma->vm_private_data;
97 if (--frame->vma_use_count <= 0)
98 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_MAPPED;
101 static struct vm_operations_struct gspca_vm_ops = {
102 .open = gspca_vm_open,
103 .close = gspca_vm_close,
106 /* get the current input frame buffer */
107 struct gspca_frame *gspca_get_i_frame(struct gspca_dev *gspca_dev)
109 struct gspca_frame *frame;
110 int i;
112 i = gspca_dev->fr_i;
113 i = gspca_dev->fr_queue[i];
114 frame = &gspca_dev->frame[i];
115 if ((frame->v4l2_buf.flags & BUF_ALL_FLAGS)
116 != V4L2_BUF_FLAG_QUEUED)
117 return NULL;
118 return frame;
120 EXPORT_SYMBOL(gspca_get_i_frame);
123 * fill a video frame from an URB and resubmit
125 static void fill_frame(struct gspca_dev *gspca_dev,
126 struct urb *urb)
128 struct gspca_frame *frame;
129 __u8 *data; /* address of data in the iso message */
130 int i, len, st;
131 cam_pkt_op pkt_scan;
133 if (urb->status != 0) {
134 #ifdef CONFIG_PM
135 if (!gspca_dev->frozen)
136 #endif
137 PDEBUG(D_ERR|D_PACK, "urb status: %d", urb->status);
138 return; /* disconnection ? */
140 pkt_scan = gspca_dev->sd_desc->pkt_scan;
141 for (i = 0; i < urb->number_of_packets; i++) {
143 /* check the availability of the frame buffer */
144 frame = gspca_get_i_frame(gspca_dev);
145 if (!frame) {
146 gspca_dev->last_packet_type = DISCARD_PACKET;
147 break;
150 /* check the packet status and length */
151 len = urb->iso_frame_desc[i].actual_length;
152 if (len == 0) {
153 if (gspca_dev->empty_packet == 0)
154 gspca_dev->empty_packet = 1;
155 continue;
157 st = urb->iso_frame_desc[i].status;
158 if (st) {
159 PDEBUG(D_ERR,
160 "ISOC data error: [%d] len=%d, status=%d",
161 i, len, st);
162 gspca_dev->last_packet_type = DISCARD_PACKET;
163 continue;
166 /* let the packet be analyzed by the subdriver */
167 PDEBUG(D_PACK, "packet [%d] o:%d l:%d",
168 i, urb->iso_frame_desc[i].offset, len);
169 data = (__u8 *) urb->transfer_buffer
170 + urb->iso_frame_desc[i].offset;
171 pkt_scan(gspca_dev, frame, data, len);
174 /* resubmit the URB */
175 st = usb_submit_urb(urb, GFP_ATOMIC);
176 if (st < 0)
177 PDEBUG(D_ERR|D_PACK, "usb_submit_urb() ret %d", st);
181 * ISOC message interrupt from the USB device
183 * Analyse each packet and call the subdriver for copy to the frame buffer.
185 static void isoc_irq(struct urb *urb
188 struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
190 PDEBUG(D_PACK, "isoc irq");
191 if (!gspca_dev->streaming)
192 return;
193 fill_frame(gspca_dev, urb);
197 * bulk message interrupt from the USB device
199 static void bulk_irq(struct urb *urb
202 struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
203 struct gspca_frame *frame;
204 int st;
206 PDEBUG(D_PACK, "bulk irq");
207 if (!gspca_dev->streaming)
208 return;
209 switch (urb->status) {
210 case 0:
211 break;
212 case -ECONNRESET:
213 urb->status = 0;
214 break;
215 default:
216 #ifdef CONFIG_PM
217 if (!gspca_dev->frozen)
218 #endif
219 PDEBUG(D_ERR|D_PACK, "urb status: %d", urb->status);
220 return; /* disconnection ? */
223 /* check the availability of the frame buffer */
224 frame = gspca_get_i_frame(gspca_dev);
225 if (!frame) {
226 gspca_dev->last_packet_type = DISCARD_PACKET;
227 } else {
228 PDEBUG(D_PACK, "packet l:%d", urb->actual_length);
229 gspca_dev->sd_desc->pkt_scan(gspca_dev,
230 frame,
231 urb->transfer_buffer,
232 urb->actual_length);
235 /* resubmit the URB */
236 if (gspca_dev->cam.bulk_nurbs != 0) {
237 st = usb_submit_urb(urb, GFP_ATOMIC);
238 if (st < 0)
239 PDEBUG(D_ERR|D_PACK, "usb_submit_urb() ret %d", st);
244 * add data to the current frame
246 * This function is called by the subdrivers at interrupt level.
248 * To build a frame, these ones must add
249 * - one FIRST_PACKET
250 * - 0 or many INTER_PACKETs
251 * - one LAST_PACKET
252 * DISCARD_PACKET invalidates the whole frame.
253 * On LAST_PACKET, a new frame is returned.
255 struct gspca_frame *gspca_frame_add(struct gspca_dev *gspca_dev,
256 enum gspca_packet_type packet_type,
257 struct gspca_frame *frame,
258 const __u8 *data,
259 int len)
261 int i, j;
263 PDEBUG(D_PACK, "add t:%d l:%d", packet_type, len);
265 /* when start of a new frame, if the current frame buffer
266 * is not queued, discard the whole frame */
267 if (packet_type == FIRST_PACKET) {
268 if ((frame->v4l2_buf.flags & BUF_ALL_FLAGS)
269 != V4L2_BUF_FLAG_QUEUED) {
270 gspca_dev->last_packet_type = DISCARD_PACKET;
271 return frame;
273 frame->data_end = frame->data;
274 jiffies_to_timeval(get_jiffies_64(),
275 &frame->v4l2_buf.timestamp);
276 frame->v4l2_buf.sequence = ++gspca_dev->sequence;
277 } else if (gspca_dev->last_packet_type == DISCARD_PACKET) {
278 if (packet_type == LAST_PACKET)
279 gspca_dev->last_packet_type = packet_type;
280 return frame;
283 /* append the packet to the frame buffer */
284 if (len > 0) {
285 if (frame->data_end - frame->data + len
286 > frame->v4l2_buf.length) {
287 PDEBUG(D_ERR|D_PACK, "frame overflow %zd > %d",
288 frame->data_end - frame->data + len,
289 frame->v4l2_buf.length);
290 packet_type = DISCARD_PACKET;
291 } else {
292 memcpy(frame->data_end, data, len);
293 frame->data_end += len;
296 gspca_dev->last_packet_type = packet_type;
298 /* if last packet, wake up the application and advance in the queue */
299 if (packet_type == LAST_PACKET) {
300 frame->v4l2_buf.bytesused = frame->data_end - frame->data;
301 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_QUEUED;
302 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_DONE;
303 wake_up_interruptible(&gspca_dev->wq); /* event = new frame */
304 i = (gspca_dev->fr_i + 1) % gspca_dev->nframes;
305 gspca_dev->fr_i = i;
306 PDEBUG(D_FRAM, "frame complete len:%d q:%d i:%d o:%d",
307 frame->v4l2_buf.bytesused,
308 gspca_dev->fr_q,
310 gspca_dev->fr_o);
311 j = gspca_dev->fr_queue[i];
312 frame = &gspca_dev->frame[j];
314 return frame;
316 EXPORT_SYMBOL(gspca_frame_add);
318 static int gspca_is_compressed(__u32 format)
320 switch (format) {
321 case V4L2_PIX_FMT_MJPEG:
322 case V4L2_PIX_FMT_JPEG:
323 case V4L2_PIX_FMT_SPCA561:
324 case V4L2_PIX_FMT_PAC207:
325 return 1;
327 return 0;
330 static void *rvmalloc(unsigned long size)
332 void *mem;
333 unsigned long adr;
335 mem = vmalloc_32(size);
336 if (mem != NULL) {
337 adr = (unsigned long) mem;
338 while ((long) size > 0) {
339 SetPageReserved(vmalloc_to_page((void *) adr));
340 adr += PAGE_SIZE;
341 size -= PAGE_SIZE;
344 return mem;
347 static void rvfree(void *mem, long size)
349 unsigned long adr;
351 adr = (unsigned long) mem;
352 while (size > 0) {
353 ClearPageReserved(vmalloc_to_page((void *) adr));
354 adr += PAGE_SIZE;
355 size -= PAGE_SIZE;
357 vfree(mem);
360 static int frame_alloc(struct gspca_dev *gspca_dev,
361 unsigned int count)
363 struct gspca_frame *frame;
364 unsigned int frsz;
365 int i;
367 i = gspca_dev->curr_mode;
368 frsz = gspca_dev->cam.cam_mode[i].sizeimage;
369 PDEBUG(D_STREAM, "frame alloc frsz: %d", frsz);
370 frsz = PAGE_ALIGN(frsz);
371 gspca_dev->frsz = frsz;
372 if (count > GSPCA_MAX_FRAMES)
373 count = GSPCA_MAX_FRAMES;
374 gspca_dev->frbuf = rvmalloc(frsz * count);
375 if (!gspca_dev->frbuf) {
376 err("frame alloc failed");
377 return -ENOMEM;
379 gspca_dev->nframes = count;
380 for (i = 0; i < count; i++) {
381 frame = &gspca_dev->frame[i];
382 frame->v4l2_buf.index = i;
383 frame->v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
384 frame->v4l2_buf.flags = 0;
385 frame->v4l2_buf.field = V4L2_FIELD_NONE;
386 frame->v4l2_buf.length = frsz;
387 frame->v4l2_buf.memory = gspca_dev->memory;
388 frame->v4l2_buf.sequence = 0;
389 frame->data = frame->data_end =
390 gspca_dev->frbuf + i * frsz;
391 frame->v4l2_buf.m.offset = i * frsz;
393 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
394 gspca_dev->last_packet_type = DISCARD_PACKET;
395 gspca_dev->sequence = 0;
396 return 0;
399 static void frame_free(struct gspca_dev *gspca_dev)
401 int i;
403 PDEBUG(D_STREAM, "frame free");
404 if (gspca_dev->frbuf != NULL) {
405 rvfree(gspca_dev->frbuf,
406 gspca_dev->nframes * gspca_dev->frsz);
407 gspca_dev->frbuf = NULL;
408 for (i = 0; i < gspca_dev->nframes; i++)
409 gspca_dev->frame[i].data = NULL;
411 gspca_dev->nframes = 0;
414 static void destroy_urbs(struct gspca_dev *gspca_dev)
416 struct urb *urb;
417 unsigned int i;
419 PDEBUG(D_STREAM, "kill transfer");
420 for (i = 0; i < MAX_NURBS; i++) {
421 urb = gspca_dev->urb[i];
422 if (urb == NULL)
423 break;
425 gspca_dev->urb[i] = NULL;
426 usb_kill_urb(urb);
427 if (urb->transfer_buffer != NULL)
428 usb_buffer_free(gspca_dev->dev,
429 urb->transfer_buffer_length,
430 urb->transfer_buffer,
431 urb->transfer_dma);
432 usb_free_urb(urb);
437 * look for an input transfer endpoint in an alternate setting
439 static struct usb_host_endpoint *alt_xfer(struct usb_host_interface *alt,
440 __u8 epaddr,
441 __u8 xfer)
443 struct usb_host_endpoint *ep;
444 int i, attr;
446 epaddr |= USB_DIR_IN;
447 for (i = 0; i < alt->desc.bNumEndpoints; i++) {
448 ep = &alt->endpoint[i];
449 if (ep->desc.bEndpointAddress == epaddr) {
450 attr = ep->desc.bmAttributes
451 & USB_ENDPOINT_XFERTYPE_MASK;
452 if (attr == xfer)
453 return ep;
454 break;
457 return NULL;
461 * look for an input (isoc or bulk) endpoint
463 * The endpoint is defined by the subdriver.
464 * Use only the first isoc (some Zoran - 0x0572:0x0001 - have two such ep).
465 * This routine may be called many times when the bandwidth is too small
466 * (the bandwidth is checked on urb submit).
468 static struct usb_host_endpoint *get_ep(struct gspca_dev *gspca_dev)
470 struct usb_interface *intf;
471 struct usb_host_endpoint *ep;
472 int i, ret;
474 intf = usb_ifnum_to_if(gspca_dev->dev, gspca_dev->iface);
475 ep = NULL;
476 i = gspca_dev->alt; /* previous alt setting */
478 /* try isoc */
479 while (--i > 0) { /* alt 0 is unusable */
480 ep = alt_xfer(&intf->altsetting[i],
481 gspca_dev->cam.epaddr,
482 USB_ENDPOINT_XFER_ISOC);
483 if (ep)
484 break;
487 /* if no isoc, try bulk */
488 if (ep == NULL) {
489 ep = alt_xfer(&intf->altsetting[0],
490 gspca_dev->cam.epaddr,
491 USB_ENDPOINT_XFER_BULK);
492 if (ep == NULL) {
493 err("no transfer endpoint found");
494 return NULL;
497 PDEBUG(D_STREAM, "use alt %d ep 0x%02x",
498 i, ep->desc.bEndpointAddress);
499 if (i > 0) {
500 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, i);
501 if (ret < 0) {
502 err("set interface err %d", ret);
503 return NULL;
506 gspca_dev->alt = i; /* memorize the current alt setting */
507 return ep;
511 * create the URBs for image transfer
513 static int create_urbs(struct gspca_dev *gspca_dev,
514 struct usb_host_endpoint *ep)
516 struct urb *urb;
517 int n, nurbs, i, psize, npkt, bsize;
519 /* calculate the packet size and the number of packets */
520 psize = le16_to_cpu(ep->desc.wMaxPacketSize);
522 if (gspca_dev->alt != 0) { /* isoc */
524 /* See paragraph 5.9 / table 5-11 of the usb 2.0 spec. */
525 psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
526 npkt = ISO_MAX_SIZE / psize;
527 if (npkt > ISO_MAX_PKT)
528 npkt = ISO_MAX_PKT;
529 bsize = psize * npkt;
530 PDEBUG(D_STREAM,
531 "isoc %d pkts size %d = bsize:%d",
532 npkt, psize, bsize);
533 nurbs = DEF_NURBS;
534 } else { /* bulk */
535 npkt = 0;
536 bsize = gspca_dev->cam.bulk_size;
537 if (bsize == 0)
538 bsize = psize;
539 PDEBUG(D_STREAM, "bulk bsize:%d", bsize);
540 if (gspca_dev->cam.bulk_nurbs != 0)
541 nurbs = gspca_dev->cam.bulk_nurbs;
542 else
543 nurbs = 1;
546 gspca_dev->nurbs = nurbs;
547 for (n = 0; n < nurbs; n++) {
548 urb = usb_alloc_urb(npkt, GFP_KERNEL);
549 if (!urb) {
550 err("usb_alloc_urb failed");
551 destroy_urbs(gspca_dev);
552 return -ENOMEM;
554 urb->transfer_buffer = usb_buffer_alloc(gspca_dev->dev,
555 bsize,
556 GFP_KERNEL,
557 &urb->transfer_dma);
559 if (urb->transfer_buffer == NULL) {
560 usb_free_urb(urb);
561 err("usb_buffer_urb failed");
562 destroy_urbs(gspca_dev);
563 return -ENOMEM;
565 gspca_dev->urb[n] = urb;
566 urb->dev = gspca_dev->dev;
567 urb->context = gspca_dev;
568 urb->transfer_buffer_length = bsize;
569 if (npkt != 0) { /* ISOC */
570 urb->pipe = usb_rcvisocpipe(gspca_dev->dev,
571 ep->desc.bEndpointAddress);
572 urb->transfer_flags = URB_ISO_ASAP
573 | URB_NO_TRANSFER_DMA_MAP;
574 urb->interval = ep->desc.bInterval;
575 urb->complete = isoc_irq;
576 urb->number_of_packets = npkt;
577 for (i = 0; i < npkt; i++) {
578 urb->iso_frame_desc[i].length = psize;
579 urb->iso_frame_desc[i].offset = psize * i;
581 } else { /* bulk */
582 urb->pipe = usb_rcvbulkpipe(gspca_dev->dev,
583 ep->desc.bEndpointAddress),
584 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
585 urb->complete = bulk_irq;
588 return 0;
592 * start the USB transfer
594 static int gspca_init_transfer(struct gspca_dev *gspca_dev)
596 struct usb_host_endpoint *ep;
597 int n, ret;
599 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
600 return -ERESTARTSYS;
602 /* set the higher alternate setting and
603 * loop until urb submit succeeds */
604 gspca_dev->alt = gspca_dev->nbalt;
605 for (;;) {
606 PDEBUG(D_STREAM, "init transfer alt %d", gspca_dev->alt);
607 ep = get_ep(gspca_dev);
608 if (ep == NULL) {
609 ret = -EIO;
610 goto out;
612 ret = create_urbs(gspca_dev, ep);
613 if (ret < 0)
614 goto out;
616 /* clear the bulk endpoint */
617 if (gspca_dev->alt == 0) /* if bulk transfer */
618 usb_clear_halt(gspca_dev->dev,
619 usb_rcvintpipe(gspca_dev->dev,
620 gspca_dev->cam.epaddr));
622 /* start the cam */
623 ret = gspca_dev->sd_desc->start(gspca_dev);
624 if (ret < 0) {
625 destroy_urbs(gspca_dev);
626 goto out;
628 gspca_dev->streaming = 1;
630 /* some bulk transfers are started by the subdriver */
631 if (gspca_dev->alt == 0 && gspca_dev->cam.bulk_nurbs == 0)
632 break;
634 /* submit the URBs */
635 for (n = 0; n < gspca_dev->nurbs; n++) {
636 ret = usb_submit_urb(gspca_dev->urb[n], GFP_KERNEL);
637 if (ret < 0) {
638 PDEBUG(D_ERR|D_STREAM,
639 "usb_submit_urb [%d] err %d", n, ret);
640 gspca_dev->streaming = 0;
641 destroy_urbs(gspca_dev);
642 if (ret == -ENOSPC)
643 break; /* try the previous alt */
644 goto out;
647 if (ret >= 0)
648 break;
650 out:
651 mutex_unlock(&gspca_dev->usb_lock);
652 return ret;
655 static int gspca_set_alt0(struct gspca_dev *gspca_dev)
657 int ret;
659 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, 0);
660 if (ret < 0)
661 PDEBUG(D_ERR|D_STREAM, "set interface 0 err %d", ret);
662 return ret;
665 /* Note: both the queue and the usb locks should be held when calling this */
666 static void gspca_stream_off(struct gspca_dev *gspca_dev)
668 gspca_dev->streaming = 0;
669 if (gspca_dev->present
670 && gspca_dev->sd_desc->stopN)
671 gspca_dev->sd_desc->stopN(gspca_dev);
672 destroy_urbs(gspca_dev);
673 gspca_set_alt0(gspca_dev);
674 if (gspca_dev->sd_desc->stop0)
675 gspca_dev->sd_desc->stop0(gspca_dev);
676 PDEBUG(D_STREAM, "stream off OK");
679 static void gspca_set_default_mode(struct gspca_dev *gspca_dev)
681 int i;
683 i = gspca_dev->cam.nmodes - 1; /* take the highest mode */
684 gspca_dev->curr_mode = i;
685 gspca_dev->width = gspca_dev->cam.cam_mode[i].width;
686 gspca_dev->height = gspca_dev->cam.cam_mode[i].height;
687 gspca_dev->pixfmt = gspca_dev->cam.cam_mode[i].pixelformat;
690 static int wxh_to_mode(struct gspca_dev *gspca_dev,
691 int width, int height)
693 int i;
695 for (i = gspca_dev->cam.nmodes; --i > 0; ) {
696 if (width >= gspca_dev->cam.cam_mode[i].width
697 && height >= gspca_dev->cam.cam_mode[i].height)
698 break;
700 return i;
704 * search a mode with the right pixel format
706 static int gspca_get_mode(struct gspca_dev *gspca_dev,
707 int mode,
708 int pixfmt)
710 int modeU, modeD;
712 modeU = modeD = mode;
713 while ((modeU < gspca_dev->cam.nmodes) || modeD >= 0) {
714 if (--modeD >= 0) {
715 if (gspca_dev->cam.cam_mode[modeD].pixelformat
716 == pixfmt)
717 return modeD;
719 if (++modeU < gspca_dev->cam.nmodes) {
720 if (gspca_dev->cam.cam_mode[modeU].pixelformat
721 == pixfmt)
722 return modeU;
725 return -EINVAL;
728 static int vidioc_enum_fmt_vid_cap(struct file *file, void *priv,
729 struct v4l2_fmtdesc *fmtdesc)
731 struct gspca_dev *gspca_dev = priv;
732 int i, j, index;
733 __u32 fmt_tb[8];
735 /* give an index to each format */
736 index = 0;
737 j = 0;
738 for (i = gspca_dev->cam.nmodes; --i >= 0; ) {
739 fmt_tb[index] = gspca_dev->cam.cam_mode[i].pixelformat;
740 j = 0;
741 for (;;) {
742 if (fmt_tb[j] == fmt_tb[index])
743 break;
744 j++;
746 if (j == index) {
747 if (fmtdesc->index == index)
748 break; /* new format */
749 index++;
750 if (index >= ARRAY_SIZE(fmt_tb))
751 return -EINVAL;
754 if (i < 0)
755 return -EINVAL; /* no more format */
757 fmtdesc->pixelformat = fmt_tb[index];
758 if (gspca_is_compressed(fmt_tb[index]))
759 fmtdesc->flags = V4L2_FMT_FLAG_COMPRESSED;
760 fmtdesc->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
761 fmtdesc->description[0] = fmtdesc->pixelformat & 0xff;
762 fmtdesc->description[1] = (fmtdesc->pixelformat >> 8) & 0xff;
763 fmtdesc->description[2] = (fmtdesc->pixelformat >> 16) & 0xff;
764 fmtdesc->description[3] = fmtdesc->pixelformat >> 24;
765 fmtdesc->description[4] = '\0';
766 return 0;
769 static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
770 struct v4l2_format *fmt)
772 struct gspca_dev *gspca_dev = priv;
773 int mode;
775 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
776 return -EINVAL;
777 mode = gspca_dev->curr_mode;
778 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
779 sizeof fmt->fmt.pix);
780 return 0;
783 static int try_fmt_vid_cap(struct gspca_dev *gspca_dev,
784 struct v4l2_format *fmt)
786 int w, h, mode, mode2;
788 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
789 return -EINVAL;
790 w = fmt->fmt.pix.width;
791 h = fmt->fmt.pix.height;
793 #ifdef GSPCA_DEBUG
794 if (gspca_debug & D_CONF)
795 PDEBUG_MODE("try fmt cap", fmt->fmt.pix.pixelformat, w, h);
796 #endif
797 /* search the closest mode for width and height */
798 mode = wxh_to_mode(gspca_dev, w, h);
800 /* OK if right palette */
801 if (gspca_dev->cam.cam_mode[mode].pixelformat
802 != fmt->fmt.pix.pixelformat) {
804 /* else, search the closest mode with the same pixel format */
805 mode2 = gspca_get_mode(gspca_dev, mode,
806 fmt->fmt.pix.pixelformat);
807 if (mode2 >= 0)
808 mode = mode2;
809 /* else
810 ; * no chance, return this mode */
812 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
813 sizeof fmt->fmt.pix);
814 return mode; /* used when s_fmt */
817 static int vidioc_try_fmt_vid_cap(struct file *file,
818 void *priv,
819 struct v4l2_format *fmt)
821 struct gspca_dev *gspca_dev = priv;
822 int ret;
824 ret = try_fmt_vid_cap(gspca_dev, fmt);
825 if (ret < 0)
826 return ret;
827 return 0;
830 static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
831 struct v4l2_format *fmt)
833 struct gspca_dev *gspca_dev = priv;
834 int ret;
836 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
837 return -ERESTARTSYS;
839 ret = try_fmt_vid_cap(gspca_dev, fmt);
840 if (ret < 0)
841 goto out;
843 if (gspca_dev->nframes != 0
844 && fmt->fmt.pix.sizeimage > gspca_dev->frsz) {
845 ret = -EINVAL;
846 goto out;
849 if (ret == gspca_dev->curr_mode) {
850 ret = 0;
851 goto out; /* same mode */
854 if (gspca_dev->streaming) {
855 ret = -EBUSY;
856 goto out;
858 gspca_dev->width = fmt->fmt.pix.width;
859 gspca_dev->height = fmt->fmt.pix.height;
860 gspca_dev->pixfmt = fmt->fmt.pix.pixelformat;
861 gspca_dev->curr_mode = ret;
863 ret = 0;
864 out:
865 mutex_unlock(&gspca_dev->queue_lock);
866 return ret;
869 static void gspca_release(struct video_device *vfd)
871 struct gspca_dev *gspca_dev = container_of(vfd, struct gspca_dev, vdev);
873 PDEBUG(D_STREAM, "device released");
875 kfree(gspca_dev->usb_buf);
876 kfree(gspca_dev);
879 static int dev_open(struct inode *inode, struct file *file)
881 struct gspca_dev *gspca_dev;
882 int ret;
884 PDEBUG(D_STREAM, "%s open", current->comm);
885 gspca_dev = (struct gspca_dev *) video_devdata(file);
886 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
887 return -ERESTARTSYS;
888 if (!gspca_dev->present) {
889 ret = -ENODEV;
890 goto out;
893 if (gspca_dev->users > 4) { /* (arbitrary value) */
894 ret = -EBUSY;
895 goto out;
898 /* protect the subdriver against rmmod */
899 if (!try_module_get(gspca_dev->module)) {
900 ret = -ENODEV;
901 goto out;
904 gspca_dev->users++;
906 file->private_data = gspca_dev;
907 #ifdef GSPCA_DEBUG
908 /* activate the v4l2 debug */
909 if (gspca_debug & D_V4L2)
910 gspca_dev->vdev.debug |= V4L2_DEBUG_IOCTL
911 | V4L2_DEBUG_IOCTL_ARG;
912 else
913 gspca_dev->vdev.debug &= ~(V4L2_DEBUG_IOCTL
914 | V4L2_DEBUG_IOCTL_ARG);
915 #endif
916 ret = 0;
917 out:
918 mutex_unlock(&gspca_dev->queue_lock);
919 if (ret != 0)
920 PDEBUG(D_ERR|D_STREAM, "open failed err %d", ret);
921 else
922 PDEBUG(D_STREAM, "open done");
923 return ret;
926 static int dev_close(struct inode *inode, struct file *file)
928 struct gspca_dev *gspca_dev = file->private_data;
930 PDEBUG(D_STREAM, "%s close", current->comm);
931 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
932 return -ERESTARTSYS;
933 gspca_dev->users--;
935 /* if the file did the capture, free the streaming resources */
936 if (gspca_dev->capt_file == file) {
937 if (gspca_dev->streaming) {
938 mutex_lock(&gspca_dev->usb_lock);
939 gspca_stream_off(gspca_dev);
940 mutex_unlock(&gspca_dev->usb_lock);
942 frame_free(gspca_dev);
943 gspca_dev->capt_file = NULL;
944 gspca_dev->memory = GSPCA_MEMORY_NO;
946 file->private_data = NULL;
947 module_put(gspca_dev->module);
948 mutex_unlock(&gspca_dev->queue_lock);
950 PDEBUG(D_STREAM, "close done");
952 return 0;
955 static int vidioc_querycap(struct file *file, void *priv,
956 struct v4l2_capability *cap)
958 struct gspca_dev *gspca_dev = priv;
960 memset(cap, 0, sizeof *cap);
961 strncpy(cap->driver, gspca_dev->sd_desc->name, sizeof cap->driver);
962 if (gspca_dev->dev->product != NULL) {
963 strncpy(cap->card, gspca_dev->dev->product,
964 sizeof cap->card);
965 } else {
966 snprintf(cap->card, sizeof cap->card,
967 "USB Camera (%04x:%04x)",
968 le16_to_cpu(gspca_dev->dev->descriptor.idVendor),
969 le16_to_cpu(gspca_dev->dev->descriptor.idProduct));
971 strncpy(cap->bus_info, gspca_dev->dev->bus->bus_name,
972 sizeof cap->bus_info);
973 cap->version = DRIVER_VERSION_NUMBER;
974 cap->capabilities = V4L2_CAP_VIDEO_CAPTURE
975 | V4L2_CAP_STREAMING
976 | V4L2_CAP_READWRITE;
977 return 0;
980 static int vidioc_queryctrl(struct file *file, void *priv,
981 struct v4l2_queryctrl *q_ctrl)
983 struct gspca_dev *gspca_dev = priv;
984 int i, ix;
985 u32 id;
987 ix = -1;
988 id = q_ctrl->id;
989 if (id & V4L2_CTRL_FLAG_NEXT_CTRL) {
990 id &= V4L2_CTRL_ID_MASK;
991 id++;
992 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
993 if (gspca_dev->sd_desc->ctrls[i].qctrl.id < id)
994 continue;
995 if (ix < 0) {
996 ix = i;
997 continue;
999 if (gspca_dev->sd_desc->ctrls[i].qctrl.id
1000 > gspca_dev->sd_desc->ctrls[ix].qctrl.id)
1001 continue;
1002 ix = i;
1005 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
1006 if (id == gspca_dev->sd_desc->ctrls[i].qctrl.id) {
1007 ix = i;
1008 break;
1011 if (ix < 0)
1012 return -EINVAL;
1013 memcpy(q_ctrl, &gspca_dev->sd_desc->ctrls[ix].qctrl,
1014 sizeof *q_ctrl);
1015 if (gspca_dev->ctrl_dis & (1 << ix))
1016 q_ctrl->flags |= V4L2_CTRL_FLAG_DISABLED;
1017 return 0;
1020 static int vidioc_s_ctrl(struct file *file, void *priv,
1021 struct v4l2_control *ctrl)
1023 struct gspca_dev *gspca_dev = priv;
1024 const struct ctrl *ctrls;
1025 int i, ret;
1027 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
1028 i < gspca_dev->sd_desc->nctrls;
1029 i++, ctrls++) {
1030 if (ctrl->id != ctrls->qctrl.id)
1031 continue;
1032 if (gspca_dev->ctrl_dis & (1 << i))
1033 return -EINVAL;
1034 if (ctrl->value < ctrls->qctrl.minimum
1035 || ctrl->value > ctrls->qctrl.maximum)
1036 return -ERANGE;
1037 PDEBUG(D_CONF, "set ctrl [%08x] = %d", ctrl->id, ctrl->value);
1038 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1039 return -ERESTARTSYS;
1040 ret = ctrls->set(gspca_dev, ctrl->value);
1041 mutex_unlock(&gspca_dev->usb_lock);
1042 return ret;
1044 return -EINVAL;
1047 static int vidioc_g_ctrl(struct file *file, void *priv,
1048 struct v4l2_control *ctrl)
1050 struct gspca_dev *gspca_dev = priv;
1052 const struct ctrl *ctrls;
1053 int i, ret;
1055 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
1056 i < gspca_dev->sd_desc->nctrls;
1057 i++, ctrls++) {
1058 if (ctrl->id != ctrls->qctrl.id)
1059 continue;
1060 if (gspca_dev->ctrl_dis & (1 << i))
1061 return -EINVAL;
1062 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1063 return -ERESTARTSYS;
1064 ret = ctrls->get(gspca_dev, &ctrl->value);
1065 mutex_unlock(&gspca_dev->usb_lock);
1066 return ret;
1068 return -EINVAL;
1071 static int vidioc_querymenu(struct file *file, void *priv,
1072 struct v4l2_querymenu *qmenu)
1074 struct gspca_dev *gspca_dev = priv;
1076 if (!gspca_dev->sd_desc->querymenu)
1077 return -EINVAL;
1078 return gspca_dev->sd_desc->querymenu(gspca_dev, qmenu);
1081 static int vidioc_enum_input(struct file *file, void *priv,
1082 struct v4l2_input *input)
1084 struct gspca_dev *gspca_dev = priv;
1086 if (input->index != 0)
1087 return -EINVAL;
1088 memset(input, 0, sizeof *input);
1089 input->type = V4L2_INPUT_TYPE_CAMERA;
1090 strncpy(input->name, gspca_dev->sd_desc->name,
1091 sizeof input->name);
1092 return 0;
1095 static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
1097 *i = 0;
1098 return 0;
1101 static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
1103 if (i > 0)
1104 return -EINVAL;
1105 return (0);
1108 static int vidioc_reqbufs(struct file *file, void *priv,
1109 struct v4l2_requestbuffers *rb)
1111 struct gspca_dev *gspca_dev = priv;
1112 int i, ret = 0;
1114 if (rb->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1115 return -EINVAL;
1116 switch (rb->memory) {
1117 case GSPCA_MEMORY_READ: /* (internal call) */
1118 case V4L2_MEMORY_MMAP:
1119 case V4L2_MEMORY_USERPTR:
1120 break;
1121 default:
1122 return -EINVAL;
1124 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1125 return -ERESTARTSYS;
1127 if (gspca_dev->memory != GSPCA_MEMORY_NO
1128 && gspca_dev->memory != rb->memory) {
1129 ret = -EBUSY;
1130 goto out;
1133 /* only one file may do the capture */
1134 if (gspca_dev->capt_file != NULL
1135 && gspca_dev->capt_file != file) {
1136 ret = -EBUSY;
1137 goto out;
1140 /* if allocated, the buffers must not be mapped */
1141 for (i = 0; i < gspca_dev->nframes; i++) {
1142 if (gspca_dev->frame[i].vma_use_count) {
1143 ret = -EBUSY;
1144 goto out;
1148 /* stop streaming */
1149 if (gspca_dev->streaming) {
1150 mutex_lock(&gspca_dev->usb_lock);
1151 gspca_stream_off(gspca_dev);
1152 mutex_unlock(&gspca_dev->usb_lock);
1155 /* free the previous allocated buffers, if any */
1156 if (gspca_dev->nframes != 0) {
1157 frame_free(gspca_dev);
1158 gspca_dev->capt_file = NULL;
1160 if (rb->count == 0) /* unrequest */
1161 goto out;
1162 gspca_dev->memory = rb->memory;
1163 ret = frame_alloc(gspca_dev, rb->count);
1164 if (ret == 0) {
1165 rb->count = gspca_dev->nframes;
1166 gspca_dev->capt_file = file;
1168 out:
1169 mutex_unlock(&gspca_dev->queue_lock);
1170 PDEBUG(D_STREAM, "reqbufs st:%d c:%d", ret, rb->count);
1171 return ret;
1174 static int vidioc_querybuf(struct file *file, void *priv,
1175 struct v4l2_buffer *v4l2_buf)
1177 struct gspca_dev *gspca_dev = priv;
1178 struct gspca_frame *frame;
1180 if (v4l2_buf->type != V4L2_BUF_TYPE_VIDEO_CAPTURE
1181 || v4l2_buf->index < 0
1182 || v4l2_buf->index >= gspca_dev->nframes)
1183 return -EINVAL;
1185 frame = &gspca_dev->frame[v4l2_buf->index];
1186 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1187 return 0;
1190 static int vidioc_streamon(struct file *file, void *priv,
1191 enum v4l2_buf_type buf_type)
1193 struct gspca_dev *gspca_dev = priv;
1194 int ret;
1196 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1197 return -EINVAL;
1198 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1199 return -ERESTARTSYS;
1200 if (!gspca_dev->present) {
1201 ret = -ENODEV;
1202 goto out;
1204 if (gspca_dev->nframes == 0) {
1205 ret = -EINVAL;
1206 goto out;
1208 if (!gspca_dev->streaming) {
1209 ret = gspca_init_transfer(gspca_dev);
1210 if (ret < 0)
1211 goto out;
1213 #ifdef GSPCA_DEBUG
1214 if (gspca_debug & D_STREAM) {
1215 PDEBUG_MODE("stream on OK",
1216 gspca_dev->pixfmt,
1217 gspca_dev->width,
1218 gspca_dev->height);
1220 #endif
1221 ret = 0;
1222 out:
1223 mutex_unlock(&gspca_dev->queue_lock);
1224 return ret;
1227 static int vidioc_streamoff(struct file *file, void *priv,
1228 enum v4l2_buf_type buf_type)
1230 struct gspca_dev *gspca_dev = priv;
1231 int i, ret;
1233 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1234 return -EINVAL;
1235 if (!gspca_dev->streaming)
1236 return 0;
1237 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1238 return -ERESTARTSYS;
1240 /* stop streaming */
1241 if (mutex_lock_interruptible(&gspca_dev->usb_lock)) {
1242 ret = -ERESTARTSYS;
1243 goto out;
1245 gspca_stream_off(gspca_dev);
1246 mutex_unlock(&gspca_dev->usb_lock);
1248 /* empty the application queues */
1249 for (i = 0; i < gspca_dev->nframes; i++)
1250 gspca_dev->frame[i].v4l2_buf.flags &= ~BUF_ALL_FLAGS;
1251 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
1252 gspca_dev->last_packet_type = DISCARD_PACKET;
1253 gspca_dev->sequence = 0;
1254 ret = 0;
1255 out:
1256 mutex_unlock(&gspca_dev->queue_lock);
1257 return ret;
1260 static int vidioc_g_jpegcomp(struct file *file, void *priv,
1261 struct v4l2_jpegcompression *jpegcomp)
1263 struct gspca_dev *gspca_dev = priv;
1264 int ret;
1266 if (!gspca_dev->sd_desc->get_jcomp)
1267 return -EINVAL;
1268 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1269 return -ERESTARTSYS;
1270 ret = gspca_dev->sd_desc->get_jcomp(gspca_dev, jpegcomp);
1271 mutex_unlock(&gspca_dev->usb_lock);
1272 return ret;
1275 static int vidioc_s_jpegcomp(struct file *file, void *priv,
1276 struct v4l2_jpegcompression *jpegcomp)
1278 struct gspca_dev *gspca_dev = priv;
1279 int ret;
1281 if (!gspca_dev->sd_desc->set_jcomp)
1282 return -EINVAL;
1283 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1284 return -ERESTARTSYS;
1285 ret = gspca_dev->sd_desc->set_jcomp(gspca_dev, jpegcomp);
1286 mutex_unlock(&gspca_dev->usb_lock);
1287 return ret;
1290 static int vidioc_g_parm(struct file *filp, void *priv,
1291 struct v4l2_streamparm *parm)
1293 struct gspca_dev *gspca_dev = priv;
1295 memset(parm, 0, sizeof *parm);
1296 parm->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1297 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1298 return 0;
1301 static int vidioc_s_parm(struct file *filp, void *priv,
1302 struct v4l2_streamparm *parm)
1304 struct gspca_dev *gspca_dev = priv;
1305 int n;
1307 n = parm->parm.capture.readbuffers;
1308 if (n == 0 || n > GSPCA_MAX_FRAMES)
1309 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1310 else
1311 gspca_dev->nbufread = n;
1312 return 0;
1315 static int vidioc_s_std(struct file *filp, void *priv,
1316 v4l2_std_id *parm)
1318 return 0;
1321 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1322 static int vidiocgmbuf(struct file *file, void *priv,
1323 struct video_mbuf *mbuf)
1325 struct gspca_dev *gspca_dev = file->private_data;
1326 int i;
1328 PDEBUG(D_STREAM, "cgmbuf");
1329 if (gspca_dev->nframes == 0) {
1330 int ret;
1333 struct v4l2_format fmt;
1335 memset(&fmt, 0, sizeof fmt);
1336 fmt.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1337 i = gspca_dev->cam.nmodes - 1; /* highest mode */
1338 fmt.fmt.pix.width = gspca_dev->cam.cam_mode[i].width;
1339 fmt.fmt.pix.height = gspca_dev->cam.cam_mode[i].height;
1340 fmt.fmt.pix.pixelformat = V4L2_PIX_FMT_BGR24;
1341 ret = vidioc_s_fmt_vid_cap(file, priv, &fmt);
1342 if (ret != 0)
1343 return ret;
1346 struct v4l2_requestbuffers rb;
1348 memset(&rb, 0, sizeof rb);
1349 rb.count = 4;
1350 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1351 rb.memory = V4L2_MEMORY_MMAP;
1352 ret = vidioc_reqbufs(file, priv, &rb);
1353 if (ret != 0)
1354 return ret;
1357 mbuf->frames = gspca_dev->nframes;
1358 mbuf->size = gspca_dev->frsz * gspca_dev->nframes;
1359 for (i = 0; i < mbuf->frames; i++)
1360 mbuf->offsets[i] = gspca_dev->frame[i].v4l2_buf.m.offset;
1361 return 0;
1363 #endif
1365 static int dev_mmap(struct file *file, struct vm_area_struct *vma)
1367 struct gspca_dev *gspca_dev = file->private_data;
1368 struct gspca_frame *frame;
1369 struct page *page;
1370 unsigned long addr, start, size;
1371 int i, ret;
1373 start = vma->vm_start;
1374 size = vma->vm_end - vma->vm_start;
1375 PDEBUG(D_STREAM, "mmap start:%08x size:%d", (int) start, (int) size);
1377 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1378 return -ERESTARTSYS;
1379 if (!gspca_dev->present) {
1380 ret = -ENODEV;
1381 goto out;
1383 if (gspca_dev->capt_file != file) {
1384 ret = -EINVAL;
1385 goto out;
1388 frame = NULL;
1389 for (i = 0; i < gspca_dev->nframes; ++i) {
1390 if (gspca_dev->frame[i].v4l2_buf.memory != V4L2_MEMORY_MMAP) {
1391 PDEBUG(D_STREAM, "mmap bad memory type");
1392 break;
1394 if ((gspca_dev->frame[i].v4l2_buf.m.offset >> PAGE_SHIFT)
1395 == vma->vm_pgoff) {
1396 frame = &gspca_dev->frame[i];
1397 break;
1400 if (frame == NULL) {
1401 PDEBUG(D_STREAM, "mmap no frame buffer found");
1402 ret = -EINVAL;
1403 goto out;
1405 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1406 /* v4l1 maps all the buffers */
1407 if (i != 0
1408 || size != frame->v4l2_buf.length * gspca_dev->nframes)
1409 #endif
1410 if (size != frame->v4l2_buf.length) {
1411 PDEBUG(D_STREAM, "mmap bad size");
1412 ret = -EINVAL;
1413 goto out;
1417 * - VM_IO marks the area as being a mmaped region for I/O to a
1418 * device. It also prevents the region from being core dumped.
1420 vma->vm_flags |= VM_IO;
1422 addr = (unsigned long) frame->data;
1423 while (size > 0) {
1424 page = vmalloc_to_page((void *) addr);
1425 ret = vm_insert_page(vma, start, page);
1426 if (ret < 0)
1427 goto out;
1428 start += PAGE_SIZE;
1429 addr += PAGE_SIZE;
1430 size -= PAGE_SIZE;
1433 vma->vm_ops = &gspca_vm_ops;
1434 vma->vm_private_data = frame;
1435 gspca_vm_open(vma);
1436 ret = 0;
1437 out:
1438 mutex_unlock(&gspca_dev->queue_lock);
1439 return ret;
1443 * wait for a video frame
1445 * If a frame is ready, its index is returned.
1447 static int frame_wait(struct gspca_dev *gspca_dev,
1448 int nonblock_ing)
1450 struct gspca_frame *frame;
1451 int i, j, ret;
1453 /* check if a frame is ready */
1454 i = gspca_dev->fr_o;
1455 j = gspca_dev->fr_queue[i];
1456 frame = &gspca_dev->frame[j];
1458 if (!(frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE)) {
1459 if (nonblock_ing)
1460 return -EAGAIN;
1462 /* wait till a frame is ready */
1463 ret = wait_event_interruptible_timeout(gspca_dev->wq,
1464 (frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE) ||
1465 !gspca_dev->streaming || !gspca_dev->present,
1466 msecs_to_jiffies(3000));
1467 if (ret < 0)
1468 return ret;
1469 if (ret == 0 || !gspca_dev->streaming || !gspca_dev->present)
1470 return -EIO;
1473 gspca_dev->fr_o = (i + 1) % gspca_dev->nframes;
1474 PDEBUG(D_FRAM, "frame wait q:%d i:%d o:%d",
1475 gspca_dev->fr_q,
1476 gspca_dev->fr_i,
1477 gspca_dev->fr_o);
1479 if (gspca_dev->sd_desc->dq_callback) {
1480 mutex_lock(&gspca_dev->usb_lock);
1481 gspca_dev->sd_desc->dq_callback(gspca_dev);
1482 mutex_unlock(&gspca_dev->usb_lock);
1484 return j;
1488 * dequeue a video buffer
1490 * If nonblock_ing is false, block until a buffer is available.
1492 static int vidioc_dqbuf(struct file *file, void *priv,
1493 struct v4l2_buffer *v4l2_buf)
1495 struct gspca_dev *gspca_dev = priv;
1496 struct gspca_frame *frame;
1497 int i, ret;
1499 PDEBUG(D_FRAM, "dqbuf");
1500 if (v4l2_buf->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1501 return -EINVAL;
1502 if (v4l2_buf->memory != gspca_dev->memory)
1503 return -EINVAL;
1505 /* if not streaming, be sure the application will not loop forever */
1506 if (!(file->f_flags & O_NONBLOCK)
1507 && !gspca_dev->streaming && gspca_dev->users == 1)
1508 return -EINVAL;
1510 /* only the capturing file may dequeue */
1511 if (gspca_dev->capt_file != file)
1512 return -EINVAL;
1514 /* only one dequeue / read at a time */
1515 if (mutex_lock_interruptible(&gspca_dev->read_lock))
1516 return -ERESTARTSYS;
1518 ret = frame_wait(gspca_dev, file->f_flags & O_NONBLOCK);
1519 if (ret < 0)
1520 goto out;
1521 i = ret; /* frame index */
1522 frame = &gspca_dev->frame[i];
1523 if (gspca_dev->memory == V4L2_MEMORY_USERPTR) {
1524 if (copy_to_user((__u8 __user *) frame->v4l2_buf.m.userptr,
1525 frame->data,
1526 frame->v4l2_buf.bytesused)) {
1527 PDEBUG(D_ERR|D_STREAM,
1528 "dqbuf cp to user failed");
1529 ret = -EFAULT;
1530 goto out;
1533 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_DONE;
1534 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1535 PDEBUG(D_FRAM, "dqbuf %d", i);
1536 ret = 0;
1537 out:
1538 mutex_unlock(&gspca_dev->read_lock);
1539 return ret;
1543 * queue a video buffer
1545 * Attempting to queue a buffer that has already been
1546 * queued will return -EINVAL.
1548 static int vidioc_qbuf(struct file *file, void *priv,
1549 struct v4l2_buffer *v4l2_buf)
1551 struct gspca_dev *gspca_dev = priv;
1552 struct gspca_frame *frame;
1553 int i, index, ret;
1555 PDEBUG(D_FRAM, "qbuf %d", v4l2_buf->index);
1556 if (v4l2_buf->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1557 return -EINVAL;
1559 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1560 return -ERESTARTSYS;
1562 index = v4l2_buf->index;
1563 if ((unsigned) index >= gspca_dev->nframes) {
1564 PDEBUG(D_FRAM,
1565 "qbuf idx %d >= %d", index, gspca_dev->nframes);
1566 ret = -EINVAL;
1567 goto out;
1569 if (v4l2_buf->memory != gspca_dev->memory) {
1570 PDEBUG(D_FRAM, "qbuf bad memory type");
1571 ret = -EINVAL;
1572 goto out;
1575 frame = &gspca_dev->frame[index];
1576 if (frame->v4l2_buf.flags & BUF_ALL_FLAGS) {
1577 PDEBUG(D_FRAM, "qbuf bad state");
1578 ret = -EINVAL;
1579 goto out;
1582 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_QUEUED;
1584 if (frame->v4l2_buf.memory == V4L2_MEMORY_USERPTR) {
1585 frame->v4l2_buf.m.userptr = v4l2_buf->m.userptr;
1586 frame->v4l2_buf.length = v4l2_buf->length;
1589 /* put the buffer in the 'queued' queue */
1590 i = gspca_dev->fr_q;
1591 gspca_dev->fr_queue[i] = index;
1592 gspca_dev->fr_q = (i + 1) % gspca_dev->nframes;
1593 PDEBUG(D_FRAM, "qbuf q:%d i:%d o:%d",
1594 gspca_dev->fr_q,
1595 gspca_dev->fr_i,
1596 gspca_dev->fr_o);
1598 v4l2_buf->flags |= V4L2_BUF_FLAG_QUEUED;
1599 v4l2_buf->flags &= ~V4L2_BUF_FLAG_DONE;
1600 ret = 0;
1601 out:
1602 mutex_unlock(&gspca_dev->queue_lock);
1603 return ret;
1607 * allocate the resources for read()
1609 static int read_alloc(struct gspca_dev *gspca_dev,
1610 struct file *file)
1612 struct v4l2_buffer v4l2_buf;
1613 int i, ret;
1615 PDEBUG(D_STREAM, "read alloc");
1616 if (gspca_dev->nframes == 0) {
1617 struct v4l2_requestbuffers rb;
1619 memset(&rb, 0, sizeof rb);
1620 rb.count = gspca_dev->nbufread;
1621 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1622 rb.memory = GSPCA_MEMORY_READ;
1623 ret = vidioc_reqbufs(file, gspca_dev, &rb);
1624 if (ret != 0) {
1625 PDEBUG(D_STREAM, "read reqbuf err %d", ret);
1626 return ret;
1628 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1629 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1630 v4l2_buf.memory = GSPCA_MEMORY_READ;
1631 for (i = 0; i < gspca_dev->nbufread; i++) {
1632 v4l2_buf.index = i;
1633 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1634 if (ret != 0) {
1635 PDEBUG(D_STREAM, "read qbuf err: %d", ret);
1636 return ret;
1639 gspca_dev->memory = GSPCA_MEMORY_READ;
1642 /* start streaming */
1643 ret = vidioc_streamon(file, gspca_dev, V4L2_BUF_TYPE_VIDEO_CAPTURE);
1644 if (ret != 0)
1645 PDEBUG(D_STREAM, "read streamon err %d", ret);
1646 return ret;
1649 static unsigned int dev_poll(struct file *file, poll_table *wait)
1651 struct gspca_dev *gspca_dev = file->private_data;
1652 int i, ret;
1654 PDEBUG(D_FRAM, "poll");
1656 poll_wait(file, &gspca_dev->wq, wait);
1657 if (!gspca_dev->present)
1658 return POLLERR;
1660 /* if reqbufs is not done, the user would use read() */
1661 if (gspca_dev->nframes == 0) {
1662 if (gspca_dev->memory != GSPCA_MEMORY_NO)
1663 return POLLERR; /* not the 1st time */
1664 ret = read_alloc(gspca_dev, file);
1665 if (ret != 0)
1666 return POLLERR;
1669 if (mutex_lock_interruptible(&gspca_dev->queue_lock) != 0)
1670 return POLLERR;
1671 if (!gspca_dev->present) {
1672 ret = POLLERR;
1673 goto out;
1676 /* check the next incoming buffer */
1677 i = gspca_dev->fr_o;
1678 i = gspca_dev->fr_queue[i];
1679 if (gspca_dev->frame[i].v4l2_buf.flags & V4L2_BUF_FLAG_DONE)
1680 ret = POLLIN | POLLRDNORM; /* something to read */
1681 else
1682 ret = 0;
1683 out:
1684 mutex_unlock(&gspca_dev->queue_lock);
1685 return ret;
1688 static ssize_t dev_read(struct file *file, char __user *data,
1689 size_t count, loff_t *ppos)
1691 struct gspca_dev *gspca_dev = file->private_data;
1692 struct gspca_frame *frame;
1693 struct v4l2_buffer v4l2_buf;
1694 struct timeval timestamp;
1695 int n, ret, ret2;
1697 PDEBUG(D_FRAM, "read (%zd)", count);
1698 if (!gspca_dev->present)
1699 return -ENODEV;
1700 switch (gspca_dev->memory) {
1701 case GSPCA_MEMORY_NO: /* first time */
1702 ret = read_alloc(gspca_dev, file);
1703 if (ret != 0)
1704 return ret;
1705 break;
1706 case GSPCA_MEMORY_READ:
1707 if (gspca_dev->capt_file == file)
1708 break;
1709 /* fall thru */
1710 default:
1711 return -EINVAL;
1714 /* get a frame */
1715 jiffies_to_timeval(get_jiffies_64(), &timestamp);
1716 timestamp.tv_sec--;
1717 n = 2;
1718 for (;;) {
1719 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1720 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1721 v4l2_buf.memory = GSPCA_MEMORY_READ;
1722 ret = vidioc_dqbuf(file, gspca_dev, &v4l2_buf);
1723 if (ret != 0) {
1724 PDEBUG(D_STREAM, "read dqbuf err %d", ret);
1725 return ret;
1728 /* if the process slept for more than 1 second,
1729 * get a newer frame */
1730 frame = &gspca_dev->frame[v4l2_buf.index];
1731 if (--n < 0)
1732 break; /* avoid infinite loop */
1733 if (frame->v4l2_buf.timestamp.tv_sec >= timestamp.tv_sec)
1734 break;
1735 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1736 if (ret != 0) {
1737 PDEBUG(D_STREAM, "read qbuf err %d", ret);
1738 return ret;
1742 /* copy the frame */
1743 if (count > frame->v4l2_buf.bytesused)
1744 count = frame->v4l2_buf.bytesused;
1745 ret = copy_to_user(data, frame->data, count);
1746 if (ret != 0) {
1747 PDEBUG(D_ERR|D_STREAM,
1748 "read cp to user lack %d / %zd", ret, count);
1749 ret = -EFAULT;
1750 goto out;
1752 ret = count;
1753 out:
1754 /* in each case, requeue the buffer */
1755 ret2 = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1756 if (ret2 != 0)
1757 return ret2;
1758 return ret;
1761 static struct file_operations dev_fops = {
1762 .owner = THIS_MODULE,
1763 .open = dev_open,
1764 .release = dev_close,
1765 .read = dev_read,
1766 .mmap = dev_mmap,
1767 .ioctl = video_ioctl2,
1768 #ifdef CONFIG_COMPAT
1769 .compat_ioctl = v4l_compat_ioctl32,
1770 #endif
1771 .llseek = no_llseek,
1772 .poll = dev_poll,
1775 static const struct v4l2_ioctl_ops dev_ioctl_ops = {
1776 .vidioc_querycap = vidioc_querycap,
1777 .vidioc_dqbuf = vidioc_dqbuf,
1778 .vidioc_qbuf = vidioc_qbuf,
1779 .vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
1780 .vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
1781 .vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
1782 .vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
1783 .vidioc_streamon = vidioc_streamon,
1784 .vidioc_queryctrl = vidioc_queryctrl,
1785 .vidioc_g_ctrl = vidioc_g_ctrl,
1786 .vidioc_s_ctrl = vidioc_s_ctrl,
1787 .vidioc_querymenu = vidioc_querymenu,
1788 .vidioc_enum_input = vidioc_enum_input,
1789 .vidioc_g_input = vidioc_g_input,
1790 .vidioc_s_input = vidioc_s_input,
1791 .vidioc_reqbufs = vidioc_reqbufs,
1792 .vidioc_querybuf = vidioc_querybuf,
1793 .vidioc_streamoff = vidioc_streamoff,
1794 .vidioc_g_jpegcomp = vidioc_g_jpegcomp,
1795 .vidioc_s_jpegcomp = vidioc_s_jpegcomp,
1796 .vidioc_g_parm = vidioc_g_parm,
1797 .vidioc_s_parm = vidioc_s_parm,
1798 .vidioc_s_std = vidioc_s_std,
1799 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1800 .vidiocgmbuf = vidiocgmbuf,
1801 #endif
1804 static struct video_device gspca_template = {
1805 .name = "gspca main driver",
1806 .fops = &dev_fops,
1807 .ioctl_ops = &dev_ioctl_ops,
1808 .release = gspca_release,
1809 .minor = -1,
1813 * probe and create a new gspca device
1815 * This function must be called by the sub-driver when it is
1816 * called for probing a new device.
1818 int gspca_dev_probe(struct usb_interface *intf,
1819 const struct usb_device_id *id,
1820 const struct sd_desc *sd_desc,
1821 int dev_size,
1822 struct module *module)
1824 struct usb_interface_descriptor *interface;
1825 struct gspca_dev *gspca_dev;
1826 struct usb_device *dev = interface_to_usbdev(intf);
1827 int ret;
1829 PDEBUG(D_PROBE, "probing %04x:%04x", id->idVendor, id->idProduct);
1831 /* we don't handle multi-config cameras */
1832 if (dev->descriptor.bNumConfigurations != 1)
1833 return -ENODEV;
1834 interface = &intf->cur_altsetting->desc;
1835 if (interface->bInterfaceNumber > 0)
1836 return -ENODEV;
1838 /* create the device */
1839 if (dev_size < sizeof *gspca_dev)
1840 dev_size = sizeof *gspca_dev;
1841 gspca_dev = kzalloc(dev_size, GFP_KERNEL);
1842 if (!gspca_dev) {
1843 err("couldn't kzalloc gspca struct");
1844 return -ENOMEM;
1846 gspca_dev->usb_buf = kmalloc(USB_BUF_SZ, GFP_KERNEL);
1847 if (!gspca_dev->usb_buf) {
1848 err("out of memory");
1849 ret = -ENOMEM;
1850 goto out;
1852 gspca_dev->dev = dev;
1853 gspca_dev->iface = interface->bInterfaceNumber;
1854 gspca_dev->nbalt = intf->num_altsetting;
1855 gspca_dev->sd_desc = sd_desc;
1856 gspca_dev->nbufread = 2;
1857 gspca_dev->empty_packet = -1; /* don't check the empty packets */
1859 /* configure the subdriver and initialize the USB device */
1860 ret = gspca_dev->sd_desc->config(gspca_dev, id);
1861 if (ret < 0)
1862 goto out;
1863 ret = gspca_dev->sd_desc->init(gspca_dev);
1864 if (ret < 0)
1865 goto out;
1866 ret = gspca_set_alt0(gspca_dev);
1867 if (ret < 0)
1868 goto out;
1869 gspca_set_default_mode(gspca_dev);
1871 mutex_init(&gspca_dev->usb_lock);
1872 mutex_init(&gspca_dev->read_lock);
1873 mutex_init(&gspca_dev->queue_lock);
1874 init_waitqueue_head(&gspca_dev->wq);
1876 /* init video stuff */
1877 gspca_dev->vdev = video_device_alloc();
1878 memcpy(gspca_dev->vdev, &gspca_template, sizeof gspca_template);
1879 gspca_dev->vdev->parent = &dev->dev;
1880 gspca_dev->module = module;
1881 gspca_dev->present = 1;
1882 ret = video_register_device(&gspca_dev->vdev,
1883 VFL_TYPE_GRABBER,
1884 video_nr);
1885 if (ret < 0) {
1886 err("video_register_device err %d", ret);
1887 goto out;
1890 usb_set_intfdata(intf, gspca_dev);
1891 PDEBUG(D_PROBE, "probe ok");
1892 return 0;
1893 out:
1894 kfree(gspca_dev->usb_buf);
1895 kfree(gspca_dev);
1896 return ret;
1898 EXPORT_SYMBOL(gspca_dev_probe);
1901 * USB disconnection
1903 * This function must be called by the sub-driver
1904 * when the device disconnects, after the specific resources are freed.
1906 void gspca_disconnect(struct usb_interface *intf)
1908 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
1910 gspca_dev->present = 0;
1911 gspca_dev->streaming = 0;
1913 usb_set_intfdata(intf, NULL);
1915 /* release the device */
1916 /* (this will call gspca_release() immediatly or on last close) */
1917 video_unregister_device(&gspca_dev->vdev);
1919 PDEBUG(D_PROBE, "disconnect complete");
1921 EXPORT_SYMBOL(gspca_disconnect);
1923 #ifdef CONFIG_PM
1924 int gspca_suspend(struct usb_interface *intf, pm_message_t message)
1926 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
1928 if (!gspca_dev->streaming)
1929 return 0;
1930 gspca_dev->frozen = 1; /* avoid urb error messages */
1931 if (gspca_dev->sd_desc->stopN)
1932 gspca_dev->sd_desc->stopN(gspca_dev);
1933 destroy_urbs(gspca_dev);
1934 gspca_set_alt0(gspca_dev);
1935 if (gspca_dev->sd_desc->stop0)
1936 gspca_dev->sd_desc->stop0(gspca_dev);
1937 return 0;
1939 EXPORT_SYMBOL(gspca_suspend);
1941 int gspca_resume(struct usb_interface *intf)
1943 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
1945 gspca_dev->frozen = 0;
1946 gspca_dev->sd_desc->init(gspca_dev);
1947 if (gspca_dev->streaming)
1948 return gspca_init_transfer(gspca_dev);
1949 return 0;
1951 EXPORT_SYMBOL(gspca_resume);
1952 #endif
1953 /* -- cam driver utility functions -- */
1955 /* auto gain and exposure algorithm based on the knee algorithm described here:
1956 http://ytse.tricolour.net/docs/LowLightOptimization.html
1958 Returns 0 if no changes were made, 1 if the gain and or exposure settings
1959 where changed. */
1960 int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
1961 int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee)
1963 int i, steps, gain, orig_gain, exposure, orig_exposure, autogain;
1964 const struct ctrl *gain_ctrl = NULL;
1965 const struct ctrl *exposure_ctrl = NULL;
1966 const struct ctrl *autogain_ctrl = NULL;
1967 int retval = 0;
1969 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
1970 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_GAIN)
1971 gain_ctrl = &gspca_dev->sd_desc->ctrls[i];
1972 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_EXPOSURE)
1973 exposure_ctrl = &gspca_dev->sd_desc->ctrls[i];
1974 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_AUTOGAIN)
1975 autogain_ctrl = &gspca_dev->sd_desc->ctrls[i];
1977 if (!gain_ctrl || !exposure_ctrl || !autogain_ctrl) {
1978 PDEBUG(D_ERR, "Error: gspca_auto_gain_n_exposure called "
1979 "on cam without (auto)gain/exposure");
1980 return 0;
1983 if (gain_ctrl->get(gspca_dev, &gain) ||
1984 exposure_ctrl->get(gspca_dev, &exposure) ||
1985 autogain_ctrl->get(gspca_dev, &autogain) || !autogain)
1986 return 0;
1988 orig_gain = gain;
1989 orig_exposure = exposure;
1991 /* If we are of a multiple of deadzone, do multiple steps to reach the
1992 desired lumination fast (with the risc of a slight overshoot) */
1993 steps = abs(desired_avg_lum - avg_lum) / deadzone;
1995 PDEBUG(D_FRAM, "autogain: lum: %d, desired: %d, steps: %d",
1996 avg_lum, desired_avg_lum, steps);
1998 for (i = 0; i < steps; i++) {
1999 if (avg_lum > desired_avg_lum) {
2000 if (gain > gain_knee)
2001 gain--;
2002 else if (exposure > exposure_knee)
2003 exposure--;
2004 else if (gain > gain_ctrl->qctrl.default_value)
2005 gain--;
2006 else if (exposure > exposure_ctrl->qctrl.minimum)
2007 exposure--;
2008 else if (gain > gain_ctrl->qctrl.minimum)
2009 gain--;
2010 else
2011 break;
2012 } else {
2013 if (gain < gain_ctrl->qctrl.default_value)
2014 gain++;
2015 else if (exposure < exposure_knee)
2016 exposure++;
2017 else if (gain < gain_knee)
2018 gain++;
2019 else if (exposure < exposure_ctrl->qctrl.maximum)
2020 exposure++;
2021 else if (gain < gain_ctrl->qctrl.maximum)
2022 gain++;
2023 else
2024 break;
2028 if (gain != orig_gain) {
2029 gain_ctrl->set(gspca_dev, gain);
2030 retval = 1;
2032 if (exposure != orig_exposure) {
2033 exposure_ctrl->set(gspca_dev, exposure);
2034 retval = 1;
2037 return retval;
2039 EXPORT_SYMBOL(gspca_auto_gain_n_exposure);
2041 /* -- module insert / remove -- */
2042 static int __init gspca_init(void)
2044 info("main v%d.%d.%d registered",
2045 (DRIVER_VERSION_NUMBER >> 16) & 0xff,
2046 (DRIVER_VERSION_NUMBER >> 8) & 0xff,
2047 DRIVER_VERSION_NUMBER & 0xff);
2048 return 0;
2050 static void __exit gspca_exit(void)
2052 info("main deregistered");
2055 module_init(gspca_init);
2056 module_exit(gspca_exit);
2058 #ifdef GSPCA_DEBUG
2059 module_param_named(debug, gspca_debug, int, 0644);
2060 MODULE_PARM_DESC(debug,
2061 "Debug (bit) 0x01:error 0x02:probe 0x04:config"
2062 " 0x08:stream 0x10:frame 0x20:packet 0x40:USBin 0x80:USBout"
2063 " 0x0100: v4l2");
2064 #endif