2 * Main USB camera driver
4 * Copyright (C) 2008-2009 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
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>
26 #include <linux/vmalloc.h>
27 #include <linux/sched.h>
28 #include <linux/slab.h>
30 #include <linux/string.h>
31 #include <linux/pagemap.h>
34 #include <linux/uaccess.h>
35 #include <linux/jiffies.h>
36 #include <media/v4l2-ioctl.h>
41 #define DEF_NURBS 3 /* default number of URBs */
42 #if DEF_NURBS > MAX_NURBS
43 #error "DEF_NURBS too big"
46 MODULE_AUTHOR("Jean-Francois Moine <http://moinejf.free.fr>");
47 MODULE_DESCRIPTION("GSPCA USB Camera Driver");
48 MODULE_LICENSE("GPL");
50 #define DRIVER_VERSION_NUMBER KERNEL_VERSION(2, 8, 0)
53 int gspca_debug = D_ERR | D_PROBE;
54 EXPORT_SYMBOL(gspca_debug);
56 static void PDEBUG_MODE(char *txt, __u32 pixfmt, int w, int h)
58 if ((pixfmt >> 24) >= '0' && (pixfmt >> 24) <= 'z') {
59 PDEBUG(D_CONF|D_STREAM, "%s %c%c%c%c %dx%d",
63 (pixfmt >> 16) & 0xff,
67 PDEBUG(D_CONF|D_STREAM, "%s 0x%08x %dx%d",
74 #define PDEBUG_MODE(txt, pixfmt, w, h)
77 /* specific memory types - !! should be different from V4L2_MEMORY_xxx */
78 #define GSPCA_MEMORY_NO 0 /* V4L2_MEMORY_xxx starts from 1 */
79 #define GSPCA_MEMORY_READ 7
81 #define BUF_ALL_FLAGS (V4L2_BUF_FLAG_QUEUED | V4L2_BUF_FLAG_DONE)
86 static void gspca_vm_open(struct vm_area_struct *vma)
88 struct gspca_frame *frame = vma->vm_private_data;
90 frame->vma_use_count++;
91 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_MAPPED;
94 static void gspca_vm_close(struct vm_area_struct *vma)
96 struct gspca_frame *frame = vma->vm_private_data;
98 if (--frame->vma_use_count <= 0)
99 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_MAPPED;
102 static const struct vm_operations_struct gspca_vm_ops = {
103 .open = gspca_vm_open,
104 .close = gspca_vm_close,
107 /* get the current input frame buffer */
108 struct gspca_frame *gspca_get_i_frame(struct gspca_dev *gspca_dev)
110 struct gspca_frame *frame;
114 i = gspca_dev->fr_queue[i];
115 frame = &gspca_dev->frame[i];
116 if ((frame->v4l2_buf.flags & BUF_ALL_FLAGS)
117 != V4L2_BUF_FLAG_QUEUED)
121 EXPORT_SYMBOL(gspca_get_i_frame);
124 * fill a video frame from an URB and resubmit
126 static void fill_frame(struct gspca_dev *gspca_dev,
129 u8 *data; /* address of data in the iso message */
133 if (urb->status != 0) {
134 if (urb->status == -ESHUTDOWN)
135 return; /* disconnection */
137 if (gspca_dev->frozen)
140 PDEBUG(D_ERR|D_PACK, "urb status: %d", urb->status);
144 pkt_scan = gspca_dev->sd_desc->pkt_scan;
145 for (i = 0; i < urb->number_of_packets; i++) {
147 /* check the packet status and length */
148 len = urb->iso_frame_desc[i].actual_length;
150 if (gspca_dev->empty_packet == 0)
151 gspca_dev->empty_packet = 1;
154 st = urb->iso_frame_desc[i].status;
157 "ISOC data error: [%d] len=%d, status=%d",
159 gspca_dev->last_packet_type = DISCARD_PACKET;
163 /* let the packet be analyzed by the subdriver */
164 PDEBUG(D_PACK, "packet [%d] o:%d l:%d",
165 i, urb->iso_frame_desc[i].offset, len);
166 data = (u8 *) urb->transfer_buffer
167 + urb->iso_frame_desc[i].offset;
168 pkt_scan(gspca_dev, data, len);
172 /* resubmit the URB */
173 st = usb_submit_urb(urb, GFP_ATOMIC);
175 PDEBUG(D_ERR|D_PACK, "usb_submit_urb() ret %d", st);
179 * ISOC message interrupt from the USB device
181 * Analyse each packet and call the subdriver for copy to the frame buffer.
183 static void isoc_irq(struct urb *urb)
185 struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
187 PDEBUG(D_PACK, "isoc irq");
188 if (!gspca_dev->streaming)
190 fill_frame(gspca_dev, urb);
194 * bulk message interrupt from the USB device
196 static void bulk_irq(struct urb *urb)
198 struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
201 PDEBUG(D_PACK, "bulk irq");
202 if (!gspca_dev->streaming)
204 switch (urb->status) {
208 return; /* disconnection */
211 if (gspca_dev->frozen)
214 PDEBUG(D_ERR|D_PACK, "urb status: %d", urb->status);
219 PDEBUG(D_PACK, "packet l:%d", urb->actual_length);
220 gspca_dev->sd_desc->pkt_scan(gspca_dev,
221 urb->transfer_buffer,
225 /* resubmit the URB */
226 if (gspca_dev->cam.bulk_nurbs != 0) {
227 st = usb_submit_urb(urb, GFP_ATOMIC);
229 PDEBUG(D_ERR|D_PACK, "usb_submit_urb() ret %d", st);
234 * add data to the current frame
236 * This function is called by the subdrivers at interrupt level.
238 * To build a frame, these ones must add
240 * - 0 or many INTER_PACKETs
242 * DISCARD_PACKET invalidates the whole frame.
243 * On LAST_PACKET, a new frame is returned.
245 void gspca_frame_add(struct gspca_dev *gspca_dev,
246 enum gspca_packet_type packet_type,
250 struct gspca_frame *frame;
253 PDEBUG(D_PACK, "add t:%d l:%d", packet_type, len);
255 /* check the availability of the frame buffer */
256 frame = gspca_dev->cur_frame;
257 if ((frame->v4l2_buf.flags & BUF_ALL_FLAGS)
258 != V4L2_BUF_FLAG_QUEUED) {
259 gspca_dev->last_packet_type = DISCARD_PACKET;
263 /* when start of a new frame, if the current frame buffer
264 * is not queued, discard the whole frame */
265 if (packet_type == FIRST_PACKET) {
266 frame->data_end = frame->data;
267 jiffies_to_timeval(get_jiffies_64(),
268 &frame->v4l2_buf.timestamp);
269 frame->v4l2_buf.sequence = ++gspca_dev->sequence;
270 } else if (gspca_dev->last_packet_type == DISCARD_PACKET) {
271 if (packet_type == LAST_PACKET)
272 gspca_dev->last_packet_type = packet_type;
276 /* append the packet to the frame buffer */
278 if (frame->data_end - frame->data + len
279 > frame->v4l2_buf.length) {
280 PDEBUG(D_ERR|D_PACK, "frame overflow %zd > %d",
281 frame->data_end - frame->data + len,
282 frame->v4l2_buf.length);
283 packet_type = DISCARD_PACKET;
285 memcpy(frame->data_end, data, len);
286 frame->data_end += len;
289 gspca_dev->last_packet_type = packet_type;
291 /* if last packet, wake up the application and advance in the queue */
292 if (packet_type == LAST_PACKET) {
293 frame->v4l2_buf.bytesused = frame->data_end - frame->data;
294 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_QUEUED;
295 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_DONE;
296 wake_up_interruptible(&gspca_dev->wq); /* event = new frame */
297 i = (gspca_dev->fr_i + 1) % gspca_dev->nframes;
299 PDEBUG(D_FRAM, "frame complete len:%d q:%d i:%d o:%d",
300 frame->v4l2_buf.bytesused,
304 j = gspca_dev->fr_queue[i];
305 gspca_dev->cur_frame = &gspca_dev->frame[j];
308 EXPORT_SYMBOL(gspca_frame_add);
310 static int gspca_is_compressed(__u32 format)
313 case V4L2_PIX_FMT_MJPEG:
314 case V4L2_PIX_FMT_JPEG:
315 case V4L2_PIX_FMT_SPCA561:
316 case V4L2_PIX_FMT_PAC207:
317 case V4L2_PIX_FMT_MR97310A:
323 static void *rvmalloc(long size)
328 mem = vmalloc_32(size);
330 adr = (unsigned long) mem;
332 SetPageReserved(vmalloc_to_page((void *) adr));
340 static void rvfree(void *mem, long size)
344 adr = (unsigned long) mem;
346 ClearPageReserved(vmalloc_to_page((void *) adr));
353 static int frame_alloc(struct gspca_dev *gspca_dev,
356 struct gspca_frame *frame;
360 i = gspca_dev->curr_mode;
361 frsz = gspca_dev->cam.cam_mode[i].sizeimage;
362 PDEBUG(D_STREAM, "frame alloc frsz: %d", frsz);
363 frsz = PAGE_ALIGN(frsz);
364 gspca_dev->frsz = frsz;
365 if (count > GSPCA_MAX_FRAMES)
366 count = GSPCA_MAX_FRAMES;
367 gspca_dev->frbuf = rvmalloc(frsz * count);
368 if (!gspca_dev->frbuf) {
369 err("frame alloc failed");
372 gspca_dev->nframes = count;
373 for (i = 0; i < count; i++) {
374 frame = &gspca_dev->frame[i];
375 frame->v4l2_buf.index = i;
376 frame->v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
377 frame->v4l2_buf.flags = 0;
378 frame->v4l2_buf.field = V4L2_FIELD_NONE;
379 frame->v4l2_buf.length = frsz;
380 frame->v4l2_buf.memory = gspca_dev->memory;
381 frame->v4l2_buf.sequence = 0;
382 frame->data = frame->data_end =
383 gspca_dev->frbuf + i * frsz;
384 frame->v4l2_buf.m.offset = i * frsz;
386 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
387 gspca_dev->cur_frame = &gspca_dev->frame[0];
388 gspca_dev->last_packet_type = DISCARD_PACKET;
389 gspca_dev->sequence = 0;
393 static void frame_free(struct gspca_dev *gspca_dev)
397 PDEBUG(D_STREAM, "frame free");
398 if (gspca_dev->frbuf != NULL) {
399 rvfree(gspca_dev->frbuf,
400 gspca_dev->nframes * gspca_dev->frsz);
401 gspca_dev->frbuf = NULL;
402 for (i = 0; i < gspca_dev->nframes; i++)
403 gspca_dev->frame[i].data = NULL;
405 gspca_dev->nframes = 0;
408 static void destroy_urbs(struct gspca_dev *gspca_dev)
413 PDEBUG(D_STREAM, "kill transfer");
414 for (i = 0; i < MAX_NURBS; i++) {
415 urb = gspca_dev->urb[i];
419 gspca_dev->urb[i] = NULL;
421 if (urb->transfer_buffer != NULL)
422 usb_buffer_free(gspca_dev->dev,
423 urb->transfer_buffer_length,
424 urb->transfer_buffer,
431 * look for an input transfer endpoint in an alternate setting
433 static struct usb_host_endpoint *alt_xfer(struct usb_host_interface *alt,
436 struct usb_host_endpoint *ep;
439 for (i = 0; i < alt->desc.bNumEndpoints; i++) {
440 ep = &alt->endpoint[i];
441 attr = ep->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
443 && ep->desc.wMaxPacketSize != 0)
450 * look for an input (isoc or bulk) endpoint
452 * The endpoint is defined by the subdriver.
453 * Use only the first isoc (some Zoran - 0x0572:0x0001 - have two such ep).
454 * This routine may be called many times when the bandwidth is too small
455 * (the bandwidth is checked on urb submit).
457 static struct usb_host_endpoint *get_ep(struct gspca_dev *gspca_dev)
459 struct usb_interface *intf;
460 struct usb_host_endpoint *ep;
463 intf = usb_ifnum_to_if(gspca_dev->dev, gspca_dev->iface);
465 xfer = gspca_dev->cam.bulk ? USB_ENDPOINT_XFER_BULK
466 : USB_ENDPOINT_XFER_ISOC;
467 i = gspca_dev->alt; /* previous alt setting */
468 if (gspca_dev->cam.reverse_alts) {
469 while (++i < gspca_dev->nbalt) {
470 ep = alt_xfer(&intf->altsetting[i], xfer);
476 ep = alt_xfer(&intf->altsetting[i], xfer);
482 err("no transfer endpoint found");
485 PDEBUG(D_STREAM, "use alt %d ep 0x%02x",
486 i, ep->desc.bEndpointAddress);
487 gspca_dev->alt = i; /* memorize the current alt setting */
488 if (gspca_dev->nbalt > 1) {
489 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, i);
491 err("set alt %d err %d", i, ret);
499 * create the URBs for image transfer
501 static int create_urbs(struct gspca_dev *gspca_dev,
502 struct usb_host_endpoint *ep)
505 int n, nurbs, i, psize, npkt, bsize;
507 /* calculate the packet size and the number of packets */
508 psize = le16_to_cpu(ep->desc.wMaxPacketSize);
510 if (!gspca_dev->cam.bulk) { /* isoc */
512 /* See paragraph 5.9 / table 5-11 of the usb 2.0 spec. */
513 if (gspca_dev->pkt_size == 0)
514 psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
516 psize = gspca_dev->pkt_size;
517 npkt = gspca_dev->cam.npkt;
519 npkt = 32; /* default value */
520 bsize = psize * npkt;
522 "isoc %d pkts size %d = bsize:%d",
527 bsize = gspca_dev->cam.bulk_size;
530 PDEBUG(D_STREAM, "bulk bsize:%d", bsize);
531 if (gspca_dev->cam.bulk_nurbs != 0)
532 nurbs = gspca_dev->cam.bulk_nurbs;
537 gspca_dev->nurbs = nurbs;
538 for (n = 0; n < nurbs; n++) {
539 urb = usb_alloc_urb(npkt, GFP_KERNEL);
541 err("usb_alloc_urb failed");
542 destroy_urbs(gspca_dev);
545 urb->transfer_buffer = usb_buffer_alloc(gspca_dev->dev,
550 if (urb->transfer_buffer == NULL) {
552 err("usb_buffer_urb failed");
553 destroy_urbs(gspca_dev);
556 gspca_dev->urb[n] = urb;
557 urb->dev = gspca_dev->dev;
558 urb->context = gspca_dev;
559 urb->transfer_buffer_length = bsize;
560 if (npkt != 0) { /* ISOC */
561 urb->pipe = usb_rcvisocpipe(gspca_dev->dev,
562 ep->desc.bEndpointAddress);
563 urb->transfer_flags = URB_ISO_ASAP
564 | URB_NO_TRANSFER_DMA_MAP;
565 urb->interval = ep->desc.bInterval;
566 urb->complete = isoc_irq;
567 urb->number_of_packets = npkt;
568 for (i = 0; i < npkt; i++) {
569 urb->iso_frame_desc[i].length = psize;
570 urb->iso_frame_desc[i].offset = psize * i;
573 urb->pipe = usb_rcvbulkpipe(gspca_dev->dev,
574 ep->desc.bEndpointAddress),
575 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
576 urb->complete = bulk_irq;
583 * start the USB transfer
585 static int gspca_init_transfer(struct gspca_dev *gspca_dev)
587 struct usb_host_endpoint *ep;
590 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
593 if (!gspca_dev->present) {
598 /* set the higher alternate setting and
599 * loop until urb submit succeeds */
600 if (gspca_dev->cam.reverse_alts)
603 gspca_dev->alt = gspca_dev->nbalt;
605 if (gspca_dev->sd_desc->isoc_init) {
606 ret = gspca_dev->sd_desc->isoc_init(gspca_dev);
610 ep = get_ep(gspca_dev);
616 PDEBUG(D_STREAM, "init transfer alt %d", gspca_dev->alt);
617 ret = create_urbs(gspca_dev, ep);
621 /* clear the bulk endpoint */
622 if (gspca_dev->cam.bulk)
623 usb_clear_halt(gspca_dev->dev,
624 gspca_dev->urb[0]->pipe);
627 ret = gspca_dev->sd_desc->start(gspca_dev);
629 destroy_urbs(gspca_dev);
632 gspca_dev->streaming = 1;
634 /* some bulk transfers are started by the subdriver */
635 if (gspca_dev->cam.bulk && gspca_dev->cam.bulk_nurbs == 0)
638 /* submit the URBs */
639 for (n = 0; n < gspca_dev->nurbs; n++) {
640 ret = usb_submit_urb(gspca_dev->urb[n], GFP_KERNEL);
646 gspca_dev->streaming = 0;
647 destroy_urbs(gspca_dev);
648 if (ret != -ENOSPC) {
649 PDEBUG(D_ERR|D_STREAM,
650 "usb_submit_urb alt %d err %d",
651 gspca_dev->alt, ret);
655 /* the bandwidth is not wide enough
656 * negociate or try a lower alternate setting */
657 PDEBUG(D_ERR|D_STREAM,
658 "bandwidth not wide enough - trying again");
659 msleep(20); /* wait for kill complete */
660 if (gspca_dev->sd_desc->isoc_nego) {
661 ret = gspca_dev->sd_desc->isoc_nego(gspca_dev);
665 ep = get_ep(gspca_dev);
673 mutex_unlock(&gspca_dev->usb_lock);
677 static int gspca_set_alt0(struct gspca_dev *gspca_dev)
681 if (gspca_dev->alt == 0)
683 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, 0);
685 PDEBUG(D_ERR|D_STREAM, "set alt 0 err %d", ret);
689 /* Note: both the queue and the usb locks should be held when calling this */
690 static void gspca_stream_off(struct gspca_dev *gspca_dev)
692 gspca_dev->streaming = 0;
693 if (gspca_dev->present) {
694 if (gspca_dev->sd_desc->stopN)
695 gspca_dev->sd_desc->stopN(gspca_dev);
696 destroy_urbs(gspca_dev);
697 gspca_set_alt0(gspca_dev);
700 /* always call stop0 to free the subdriver's resources */
701 if (gspca_dev->sd_desc->stop0)
702 gspca_dev->sd_desc->stop0(gspca_dev);
703 PDEBUG(D_STREAM, "stream off OK");
706 static void gspca_set_default_mode(struct gspca_dev *gspca_dev)
710 i = gspca_dev->cam.nmodes - 1; /* take the highest mode */
711 gspca_dev->curr_mode = i;
712 gspca_dev->width = gspca_dev->cam.cam_mode[i].width;
713 gspca_dev->height = gspca_dev->cam.cam_mode[i].height;
714 gspca_dev->pixfmt = gspca_dev->cam.cam_mode[i].pixelformat;
717 static int wxh_to_mode(struct gspca_dev *gspca_dev,
718 int width, int height)
722 for (i = gspca_dev->cam.nmodes; --i > 0; ) {
723 if (width >= gspca_dev->cam.cam_mode[i].width
724 && height >= gspca_dev->cam.cam_mode[i].height)
731 * search a mode with the right pixel format
733 static int gspca_get_mode(struct gspca_dev *gspca_dev,
739 modeU = modeD = mode;
740 while ((modeU < gspca_dev->cam.nmodes) || modeD >= 0) {
742 if (gspca_dev->cam.cam_mode[modeD].pixelformat
746 if (++modeU < gspca_dev->cam.nmodes) {
747 if (gspca_dev->cam.cam_mode[modeU].pixelformat
755 #ifdef CONFIG_VIDEO_ADV_DEBUG
756 static int vidioc_g_register(struct file *file, void *priv,
757 struct v4l2_dbg_register *reg)
760 struct gspca_dev *gspca_dev = priv;
762 if (!gspca_dev->sd_desc->get_chip_ident)
765 if (!gspca_dev->sd_desc->get_register)
768 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
770 if (gspca_dev->present)
771 ret = gspca_dev->sd_desc->get_register(gspca_dev, reg);
774 mutex_unlock(&gspca_dev->usb_lock);
779 static int vidioc_s_register(struct file *file, void *priv,
780 struct v4l2_dbg_register *reg)
783 struct gspca_dev *gspca_dev = priv;
785 if (!gspca_dev->sd_desc->get_chip_ident)
788 if (!gspca_dev->sd_desc->set_register)
791 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
793 if (gspca_dev->present)
794 ret = gspca_dev->sd_desc->set_register(gspca_dev, reg);
797 mutex_unlock(&gspca_dev->usb_lock);
803 static int vidioc_g_chip_ident(struct file *file, void *priv,
804 struct v4l2_dbg_chip_ident *chip)
807 struct gspca_dev *gspca_dev = priv;
809 if (!gspca_dev->sd_desc->get_chip_ident)
812 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
814 if (gspca_dev->present)
815 ret = gspca_dev->sd_desc->get_chip_ident(gspca_dev, chip);
818 mutex_unlock(&gspca_dev->usb_lock);
823 static int vidioc_enum_fmt_vid_cap(struct file *file, void *priv,
824 struct v4l2_fmtdesc *fmtdesc)
826 struct gspca_dev *gspca_dev = priv;
830 /* give an index to each format */
833 for (i = gspca_dev->cam.nmodes; --i >= 0; ) {
834 fmt_tb[index] = gspca_dev->cam.cam_mode[i].pixelformat;
837 if (fmt_tb[j] == fmt_tb[index])
842 if (fmtdesc->index == index)
843 break; /* new format */
845 if (index >= ARRAY_SIZE(fmt_tb))
850 return -EINVAL; /* no more format */
852 fmtdesc->pixelformat = fmt_tb[index];
853 if (gspca_is_compressed(fmt_tb[index]))
854 fmtdesc->flags = V4L2_FMT_FLAG_COMPRESSED;
855 fmtdesc->description[0] = fmtdesc->pixelformat & 0xff;
856 fmtdesc->description[1] = (fmtdesc->pixelformat >> 8) & 0xff;
857 fmtdesc->description[2] = (fmtdesc->pixelformat >> 16) & 0xff;
858 fmtdesc->description[3] = fmtdesc->pixelformat >> 24;
859 fmtdesc->description[4] = '\0';
863 static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
864 struct v4l2_format *fmt)
866 struct gspca_dev *gspca_dev = priv;
869 mode = gspca_dev->curr_mode;
870 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
871 sizeof fmt->fmt.pix);
875 static int try_fmt_vid_cap(struct gspca_dev *gspca_dev,
876 struct v4l2_format *fmt)
878 int w, h, mode, mode2;
880 w = fmt->fmt.pix.width;
881 h = fmt->fmt.pix.height;
884 if (gspca_debug & D_CONF)
885 PDEBUG_MODE("try fmt cap", fmt->fmt.pix.pixelformat, w, h);
887 /* search the closest mode for width and height */
888 mode = wxh_to_mode(gspca_dev, w, h);
890 /* OK if right palette */
891 if (gspca_dev->cam.cam_mode[mode].pixelformat
892 != fmt->fmt.pix.pixelformat) {
894 /* else, search the closest mode with the same pixel format */
895 mode2 = gspca_get_mode(gspca_dev, mode,
896 fmt->fmt.pix.pixelformat);
900 ; * no chance, return this mode */
902 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
903 sizeof fmt->fmt.pix);
904 return mode; /* used when s_fmt */
907 static int vidioc_try_fmt_vid_cap(struct file *file,
909 struct v4l2_format *fmt)
911 struct gspca_dev *gspca_dev = priv;
914 ret = try_fmt_vid_cap(gspca_dev, fmt);
920 static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
921 struct v4l2_format *fmt)
923 struct gspca_dev *gspca_dev = priv;
926 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
929 ret = try_fmt_vid_cap(gspca_dev, fmt);
933 if (gspca_dev->nframes != 0
934 && fmt->fmt.pix.sizeimage > gspca_dev->frsz) {
939 if (ret == gspca_dev->curr_mode) {
941 goto out; /* same mode */
944 if (gspca_dev->streaming) {
948 gspca_dev->width = fmt->fmt.pix.width;
949 gspca_dev->height = fmt->fmt.pix.height;
950 gspca_dev->pixfmt = fmt->fmt.pix.pixelformat;
951 gspca_dev->curr_mode = ret;
955 mutex_unlock(&gspca_dev->queue_lock);
959 static int vidioc_enum_framesizes(struct file *file, void *priv,
960 struct v4l2_frmsizeenum *fsize)
962 struct gspca_dev *gspca_dev = priv;
966 for (i = 0; i < gspca_dev->cam.nmodes; i++) {
967 if (fsize->pixel_format !=
968 gspca_dev->cam.cam_mode[i].pixelformat)
971 if (fsize->index == index) {
972 fsize->type = V4L2_FRMSIZE_TYPE_DISCRETE;
973 fsize->discrete.width =
974 gspca_dev->cam.cam_mode[i].width;
975 fsize->discrete.height =
976 gspca_dev->cam.cam_mode[i].height;
985 static void gspca_release(struct video_device *vfd)
987 struct gspca_dev *gspca_dev = container_of(vfd, struct gspca_dev, vdev);
989 PDEBUG(D_PROBE, "%s released",
990 video_device_node_name(&gspca_dev->vdev));
992 kfree(gspca_dev->usb_buf);
996 static int dev_open(struct file *file)
998 struct gspca_dev *gspca_dev;
1001 PDEBUG(D_STREAM, "[%s] open", current->comm);
1002 gspca_dev = (struct gspca_dev *) video_devdata(file);
1003 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1004 return -ERESTARTSYS;
1005 if (!gspca_dev->present) {
1010 if (gspca_dev->users > 4) { /* (arbitrary value) */
1015 /* protect the subdriver against rmmod */
1016 if (!try_module_get(gspca_dev->module)) {
1023 file->private_data = gspca_dev;
1025 /* activate the v4l2 debug */
1026 if (gspca_debug & D_V4L2)
1027 gspca_dev->vdev.debug |= V4L2_DEBUG_IOCTL
1028 | V4L2_DEBUG_IOCTL_ARG;
1030 gspca_dev->vdev.debug &= ~(V4L2_DEBUG_IOCTL
1031 | V4L2_DEBUG_IOCTL_ARG);
1035 mutex_unlock(&gspca_dev->queue_lock);
1037 PDEBUG(D_ERR|D_STREAM, "open failed err %d", ret);
1039 PDEBUG(D_STREAM, "open done");
1043 static int dev_close(struct file *file)
1045 struct gspca_dev *gspca_dev = file->private_data;
1047 PDEBUG(D_STREAM, "[%s] close", current->comm);
1048 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1049 return -ERESTARTSYS;
1052 /* if the file did the capture, free the streaming resources */
1053 if (gspca_dev->capt_file == file) {
1054 if (gspca_dev->streaming) {
1055 mutex_lock(&gspca_dev->usb_lock);
1056 gspca_stream_off(gspca_dev);
1057 mutex_unlock(&gspca_dev->usb_lock);
1059 frame_free(gspca_dev);
1060 gspca_dev->capt_file = NULL;
1061 gspca_dev->memory = GSPCA_MEMORY_NO;
1063 file->private_data = NULL;
1064 module_put(gspca_dev->module);
1065 mutex_unlock(&gspca_dev->queue_lock);
1067 PDEBUG(D_STREAM, "close done");
1072 static int vidioc_querycap(struct file *file, void *priv,
1073 struct v4l2_capability *cap)
1075 struct gspca_dev *gspca_dev = priv;
1078 /* protect the access to the usb device */
1079 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1080 return -ERESTARTSYS;
1081 if (!gspca_dev->present) {
1085 strncpy(cap->driver, gspca_dev->sd_desc->name, sizeof cap->driver);
1086 if (gspca_dev->dev->product != NULL) {
1087 strncpy(cap->card, gspca_dev->dev->product,
1090 snprintf(cap->card, sizeof cap->card,
1091 "USB Camera (%04x:%04x)",
1092 le16_to_cpu(gspca_dev->dev->descriptor.idVendor),
1093 le16_to_cpu(gspca_dev->dev->descriptor.idProduct));
1095 usb_make_path(gspca_dev->dev, cap->bus_info, sizeof(cap->bus_info));
1096 cap->version = DRIVER_VERSION_NUMBER;
1097 cap->capabilities = V4L2_CAP_VIDEO_CAPTURE
1098 | V4L2_CAP_STREAMING
1099 | V4L2_CAP_READWRITE;
1102 mutex_unlock(&gspca_dev->usb_lock);
1106 static const struct ctrl *get_ctrl(struct gspca_dev *gspca_dev,
1109 const struct ctrl *ctrls;
1112 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
1113 i < gspca_dev->sd_desc->nctrls;
1115 if (gspca_dev->ctrl_dis & (1 << i))
1117 if (id == ctrls->qctrl.id)
1123 static int vidioc_queryctrl(struct file *file, void *priv,
1124 struct v4l2_queryctrl *q_ctrl)
1126 struct gspca_dev *gspca_dev = priv;
1127 const struct ctrl *ctrls;
1133 if (id & V4L2_CTRL_FLAG_NEXT_CTRL) {
1134 id &= V4L2_CTRL_ID_MASK;
1136 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
1137 if (gspca_dev->ctrl_dis & (1 << i))
1139 if (gspca_dev->sd_desc->ctrls[i].qctrl.id < id)
1141 if (ctrls && gspca_dev->sd_desc->ctrls[i].qctrl.id
1144 ctrls = &gspca_dev->sd_desc->ctrls[i];
1147 ctrls = get_ctrl(gspca_dev, id);
1148 i = ctrls - gspca_dev->sd_desc->ctrls;
1152 memcpy(q_ctrl, ctrls, sizeof *q_ctrl);
1153 if (gspca_dev->ctrl_inac & (1 << i))
1154 q_ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
1158 static int vidioc_s_ctrl(struct file *file, void *priv,
1159 struct v4l2_control *ctrl)
1161 struct gspca_dev *gspca_dev = priv;
1162 const struct ctrl *ctrls;
1165 ctrls = get_ctrl(gspca_dev, ctrl->id);
1169 if (ctrl->value < ctrls->qctrl.minimum
1170 || ctrl->value > ctrls->qctrl.maximum)
1172 PDEBUG(D_CONF, "set ctrl [%08x] = %d", ctrl->id, ctrl->value);
1173 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1174 return -ERESTARTSYS;
1175 if (gspca_dev->present)
1176 ret = ctrls->set(gspca_dev, ctrl->value);
1179 mutex_unlock(&gspca_dev->usb_lock);
1183 static int vidioc_g_ctrl(struct file *file, void *priv,
1184 struct v4l2_control *ctrl)
1186 struct gspca_dev *gspca_dev = priv;
1187 const struct ctrl *ctrls;
1190 ctrls = get_ctrl(gspca_dev, ctrl->id);
1194 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1195 return -ERESTARTSYS;
1196 if (gspca_dev->present)
1197 ret = ctrls->get(gspca_dev, &ctrl->value);
1200 mutex_unlock(&gspca_dev->usb_lock);
1204 /*fixme: have an audio flag in gspca_dev?*/
1205 static int vidioc_s_audio(struct file *file, void *priv,
1206 struct v4l2_audio *audio)
1208 if (audio->index != 0)
1213 static int vidioc_g_audio(struct file *file, void *priv,
1214 struct v4l2_audio *audio)
1216 strcpy(audio->name, "Microphone");
1220 static int vidioc_enumaudio(struct file *file, void *priv,
1221 struct v4l2_audio *audio)
1223 if (audio->index != 0)
1226 strcpy(audio->name, "Microphone");
1227 audio->capability = 0;
1232 static int vidioc_querymenu(struct file *file, void *priv,
1233 struct v4l2_querymenu *qmenu)
1235 struct gspca_dev *gspca_dev = priv;
1237 if (!gspca_dev->sd_desc->querymenu)
1239 return gspca_dev->sd_desc->querymenu(gspca_dev, qmenu);
1242 static int vidioc_enum_input(struct file *file, void *priv,
1243 struct v4l2_input *input)
1245 struct gspca_dev *gspca_dev = priv;
1247 if (input->index != 0)
1249 input->type = V4L2_INPUT_TYPE_CAMERA;
1250 input->status = gspca_dev->cam.input_flags;
1251 strncpy(input->name, gspca_dev->sd_desc->name,
1252 sizeof input->name);
1256 static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
1262 static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
1269 static int vidioc_reqbufs(struct file *file, void *priv,
1270 struct v4l2_requestbuffers *rb)
1272 struct gspca_dev *gspca_dev = priv;
1275 switch (rb->memory) {
1276 case GSPCA_MEMORY_READ: /* (internal call) */
1277 case V4L2_MEMORY_MMAP:
1278 case V4L2_MEMORY_USERPTR:
1283 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1284 return -ERESTARTSYS;
1286 if (gspca_dev->memory != GSPCA_MEMORY_NO
1287 && gspca_dev->memory != rb->memory) {
1292 /* only one file may do the capture */
1293 if (gspca_dev->capt_file != NULL
1294 && gspca_dev->capt_file != file) {
1299 /* if allocated, the buffers must not be mapped */
1300 for (i = 0; i < gspca_dev->nframes; i++) {
1301 if (gspca_dev->frame[i].vma_use_count) {
1307 /* stop streaming */
1308 if (gspca_dev->streaming) {
1309 mutex_lock(&gspca_dev->usb_lock);
1310 gspca_stream_off(gspca_dev);
1311 mutex_unlock(&gspca_dev->usb_lock);
1314 /* free the previous allocated buffers, if any */
1315 if (gspca_dev->nframes != 0) {
1316 frame_free(gspca_dev);
1317 gspca_dev->capt_file = NULL;
1319 if (rb->count == 0) /* unrequest */
1321 gspca_dev->memory = rb->memory;
1322 ret = frame_alloc(gspca_dev, rb->count);
1324 rb->count = gspca_dev->nframes;
1325 gspca_dev->capt_file = file;
1328 mutex_unlock(&gspca_dev->queue_lock);
1329 PDEBUG(D_STREAM, "reqbufs st:%d c:%d", ret, rb->count);
1333 static int vidioc_querybuf(struct file *file, void *priv,
1334 struct v4l2_buffer *v4l2_buf)
1336 struct gspca_dev *gspca_dev = priv;
1337 struct gspca_frame *frame;
1339 if (v4l2_buf->index < 0
1340 || v4l2_buf->index >= gspca_dev->nframes)
1343 frame = &gspca_dev->frame[v4l2_buf->index];
1344 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1348 static int vidioc_streamon(struct file *file, void *priv,
1349 enum v4l2_buf_type buf_type)
1351 struct gspca_dev *gspca_dev = priv;
1354 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1356 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1357 return -ERESTARTSYS;
1359 if (gspca_dev->nframes == 0
1360 || !(gspca_dev->frame[0].v4l2_buf.flags & V4L2_BUF_FLAG_QUEUED)) {
1364 if (!gspca_dev->streaming) {
1365 ret = gspca_init_transfer(gspca_dev);
1370 if (gspca_debug & D_STREAM) {
1371 PDEBUG_MODE("stream on OK",
1379 mutex_unlock(&gspca_dev->queue_lock);
1383 static int vidioc_streamoff(struct file *file, void *priv,
1384 enum v4l2_buf_type buf_type)
1386 struct gspca_dev *gspca_dev = priv;
1389 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1391 if (!gspca_dev->streaming)
1393 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1394 return -ERESTARTSYS;
1396 /* stop streaming */
1397 if (mutex_lock_interruptible(&gspca_dev->usb_lock)) {
1401 gspca_stream_off(gspca_dev);
1402 mutex_unlock(&gspca_dev->usb_lock);
1404 /* empty the application queues */
1405 for (i = 0; i < gspca_dev->nframes; i++)
1406 gspca_dev->frame[i].v4l2_buf.flags &= ~BUF_ALL_FLAGS;
1407 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
1408 gspca_dev->last_packet_type = DISCARD_PACKET;
1409 gspca_dev->sequence = 0;
1412 mutex_unlock(&gspca_dev->queue_lock);
1416 static int vidioc_g_jpegcomp(struct file *file, void *priv,
1417 struct v4l2_jpegcompression *jpegcomp)
1419 struct gspca_dev *gspca_dev = priv;
1422 if (!gspca_dev->sd_desc->get_jcomp)
1424 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1425 return -ERESTARTSYS;
1426 if (gspca_dev->present)
1427 ret = gspca_dev->sd_desc->get_jcomp(gspca_dev, jpegcomp);
1430 mutex_unlock(&gspca_dev->usb_lock);
1434 static int vidioc_s_jpegcomp(struct file *file, void *priv,
1435 struct v4l2_jpegcompression *jpegcomp)
1437 struct gspca_dev *gspca_dev = priv;
1440 if (!gspca_dev->sd_desc->set_jcomp)
1442 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1443 return -ERESTARTSYS;
1444 if (gspca_dev->present)
1445 ret = gspca_dev->sd_desc->set_jcomp(gspca_dev, jpegcomp);
1448 mutex_unlock(&gspca_dev->usb_lock);
1452 static int vidioc_g_parm(struct file *filp, void *priv,
1453 struct v4l2_streamparm *parm)
1455 struct gspca_dev *gspca_dev = priv;
1457 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1459 if (gspca_dev->sd_desc->get_streamparm) {
1462 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1463 return -ERESTARTSYS;
1464 if (gspca_dev->present)
1465 ret = gspca_dev->sd_desc->get_streamparm(gspca_dev,
1469 mutex_unlock(&gspca_dev->usb_lock);
1476 static int vidioc_s_parm(struct file *filp, void *priv,
1477 struct v4l2_streamparm *parm)
1479 struct gspca_dev *gspca_dev = priv;
1482 n = parm->parm.capture.readbuffers;
1483 if (n == 0 || n > GSPCA_MAX_FRAMES)
1484 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1486 gspca_dev->nbufread = n;
1488 if (gspca_dev->sd_desc->set_streamparm) {
1491 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1492 return -ERESTARTSYS;
1493 if (gspca_dev->present)
1494 ret = gspca_dev->sd_desc->set_streamparm(gspca_dev,
1498 mutex_unlock(&gspca_dev->usb_lock);
1505 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1506 static int vidiocgmbuf(struct file *file, void *priv,
1507 struct video_mbuf *mbuf)
1509 struct gspca_dev *gspca_dev = file->private_data;
1512 PDEBUG(D_STREAM, "cgmbuf");
1513 if (gspca_dev->nframes == 0) {
1517 struct v4l2_format fmt;
1519 fmt.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1520 i = gspca_dev->cam.nmodes - 1; /* highest mode */
1521 fmt.fmt.pix.width = gspca_dev->cam.cam_mode[i].width;
1522 fmt.fmt.pix.height = gspca_dev->cam.cam_mode[i].height;
1523 fmt.fmt.pix.pixelformat = V4L2_PIX_FMT_BGR24;
1524 ret = vidioc_s_fmt_vid_cap(file, priv, &fmt);
1529 struct v4l2_requestbuffers rb;
1531 memset(&rb, 0, sizeof rb);
1533 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1534 rb.memory = V4L2_MEMORY_MMAP;
1535 ret = vidioc_reqbufs(file, priv, &rb);
1540 mbuf->frames = gspca_dev->nframes;
1541 mbuf->size = gspca_dev->frsz * gspca_dev->nframes;
1542 for (i = 0; i < mbuf->frames; i++)
1543 mbuf->offsets[i] = gspca_dev->frame[i].v4l2_buf.m.offset;
1548 static int dev_mmap(struct file *file, struct vm_area_struct *vma)
1550 struct gspca_dev *gspca_dev = file->private_data;
1551 struct gspca_frame *frame;
1553 unsigned long addr, start, size;
1556 start = vma->vm_start;
1557 size = vma->vm_end - vma->vm_start;
1558 PDEBUG(D_STREAM, "mmap start:%08x size:%d", (int) start, (int) size);
1560 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1561 return -ERESTARTSYS;
1562 if (!gspca_dev->present) {
1566 if (gspca_dev->capt_file != file) {
1572 for (i = 0; i < gspca_dev->nframes; ++i) {
1573 if (gspca_dev->frame[i].v4l2_buf.memory != V4L2_MEMORY_MMAP) {
1574 PDEBUG(D_STREAM, "mmap bad memory type");
1577 if ((gspca_dev->frame[i].v4l2_buf.m.offset >> PAGE_SHIFT)
1579 frame = &gspca_dev->frame[i];
1583 if (frame == NULL) {
1584 PDEBUG(D_STREAM, "mmap no frame buffer found");
1588 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1589 /* v4l1 maps all the buffers */
1591 || size != frame->v4l2_buf.length * gspca_dev->nframes)
1593 if (size != frame->v4l2_buf.length) {
1594 PDEBUG(D_STREAM, "mmap bad size");
1600 * - VM_IO marks the area as being a mmaped region for I/O to a
1601 * device. It also prevents the region from being core dumped.
1603 vma->vm_flags |= VM_IO;
1605 addr = (unsigned long) frame->data;
1607 page = vmalloc_to_page((void *) addr);
1608 ret = vm_insert_page(vma, start, page);
1616 vma->vm_ops = &gspca_vm_ops;
1617 vma->vm_private_data = frame;
1621 mutex_unlock(&gspca_dev->queue_lock);
1626 * wait for a video frame
1628 * If a frame is ready, its index is returned.
1630 static int frame_wait(struct gspca_dev *gspca_dev,
1633 struct gspca_frame *frame;
1636 /* check if a frame is ready */
1637 i = gspca_dev->fr_o;
1638 j = gspca_dev->fr_queue[i];
1639 frame = &gspca_dev->frame[j];
1641 if (!(frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE)) {
1645 /* wait till a frame is ready */
1646 ret = wait_event_interruptible_timeout(gspca_dev->wq,
1647 (frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE) ||
1648 !gspca_dev->streaming || !gspca_dev->present,
1649 msecs_to_jiffies(3000));
1652 if (ret == 0 || !gspca_dev->streaming || !gspca_dev->present)
1656 gspca_dev->fr_o = (i + 1) % gspca_dev->nframes;
1657 PDEBUG(D_FRAM, "frame wait q:%d i:%d o:%d",
1662 if (gspca_dev->sd_desc->dq_callback) {
1663 mutex_lock(&gspca_dev->usb_lock);
1664 if (gspca_dev->present)
1665 gspca_dev->sd_desc->dq_callback(gspca_dev);
1666 mutex_unlock(&gspca_dev->usb_lock);
1672 * dequeue a video buffer
1674 * If nonblock_ing is false, block until a buffer is available.
1676 static int vidioc_dqbuf(struct file *file, void *priv,
1677 struct v4l2_buffer *v4l2_buf)
1679 struct gspca_dev *gspca_dev = priv;
1680 struct gspca_frame *frame;
1683 PDEBUG(D_FRAM, "dqbuf");
1684 if (v4l2_buf->memory != gspca_dev->memory)
1687 if (!gspca_dev->present)
1690 /* if not streaming, be sure the application will not loop forever */
1691 if (!(file->f_flags & O_NONBLOCK)
1692 && !gspca_dev->streaming && gspca_dev->users == 1)
1695 /* only the capturing file may dequeue */
1696 if (gspca_dev->capt_file != file)
1699 /* only one dequeue / read at a time */
1700 if (mutex_lock_interruptible(&gspca_dev->read_lock))
1701 return -ERESTARTSYS;
1703 ret = frame_wait(gspca_dev, file->f_flags & O_NONBLOCK);
1706 i = ret; /* frame index */
1707 frame = &gspca_dev->frame[i];
1708 if (gspca_dev->memory == V4L2_MEMORY_USERPTR) {
1709 if (copy_to_user((__u8 __user *) frame->v4l2_buf.m.userptr,
1711 frame->v4l2_buf.bytesused)) {
1712 PDEBUG(D_ERR|D_STREAM,
1713 "dqbuf cp to user failed");
1718 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_DONE;
1719 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1720 PDEBUG(D_FRAM, "dqbuf %d", i);
1723 mutex_unlock(&gspca_dev->read_lock);
1728 * queue a video buffer
1730 * Attempting to queue a buffer that has already been
1731 * queued will return -EINVAL.
1733 static int vidioc_qbuf(struct file *file, void *priv,
1734 struct v4l2_buffer *v4l2_buf)
1736 struct gspca_dev *gspca_dev = priv;
1737 struct gspca_frame *frame;
1740 PDEBUG(D_FRAM, "qbuf %d", v4l2_buf->index);
1742 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1743 return -ERESTARTSYS;
1745 index = v4l2_buf->index;
1746 if ((unsigned) index >= gspca_dev->nframes) {
1748 "qbuf idx %d >= %d", index, gspca_dev->nframes);
1752 if (v4l2_buf->memory != gspca_dev->memory) {
1753 PDEBUG(D_FRAM, "qbuf bad memory type");
1758 frame = &gspca_dev->frame[index];
1759 if (frame->v4l2_buf.flags & BUF_ALL_FLAGS) {
1760 PDEBUG(D_FRAM, "qbuf bad state");
1765 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_QUEUED;
1767 if (frame->v4l2_buf.memory == V4L2_MEMORY_USERPTR) {
1768 frame->v4l2_buf.m.userptr = v4l2_buf->m.userptr;
1769 frame->v4l2_buf.length = v4l2_buf->length;
1772 /* put the buffer in the 'queued' queue */
1773 i = gspca_dev->fr_q;
1774 gspca_dev->fr_queue[i] = index;
1775 gspca_dev->fr_q = (i + 1) % gspca_dev->nframes;
1776 PDEBUG(D_FRAM, "qbuf q:%d i:%d o:%d",
1781 v4l2_buf->flags |= V4L2_BUF_FLAG_QUEUED;
1782 v4l2_buf->flags &= ~V4L2_BUF_FLAG_DONE;
1785 mutex_unlock(&gspca_dev->queue_lock);
1790 * allocate the resources for read()
1792 static int read_alloc(struct gspca_dev *gspca_dev,
1795 struct v4l2_buffer v4l2_buf;
1798 PDEBUG(D_STREAM, "read alloc");
1799 if (gspca_dev->nframes == 0) {
1800 struct v4l2_requestbuffers rb;
1802 memset(&rb, 0, sizeof rb);
1803 rb.count = gspca_dev->nbufread;
1804 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1805 rb.memory = GSPCA_MEMORY_READ;
1806 ret = vidioc_reqbufs(file, gspca_dev, &rb);
1808 PDEBUG(D_STREAM, "read reqbuf err %d", ret);
1811 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1812 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1813 v4l2_buf.memory = GSPCA_MEMORY_READ;
1814 for (i = 0; i < gspca_dev->nbufread; i++) {
1816 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1818 PDEBUG(D_STREAM, "read qbuf err: %d", ret);
1822 gspca_dev->memory = GSPCA_MEMORY_READ;
1825 /* start streaming */
1826 ret = vidioc_streamon(file, gspca_dev, V4L2_BUF_TYPE_VIDEO_CAPTURE);
1828 PDEBUG(D_STREAM, "read streamon err %d", ret);
1832 static unsigned int dev_poll(struct file *file, poll_table *wait)
1834 struct gspca_dev *gspca_dev = file->private_data;
1837 PDEBUG(D_FRAM, "poll");
1839 poll_wait(file, &gspca_dev->wq, wait);
1841 /* if reqbufs is not done, the user would use read() */
1842 if (gspca_dev->nframes == 0) {
1843 if (gspca_dev->memory != GSPCA_MEMORY_NO)
1844 return POLLERR; /* not the 1st time */
1845 ret = read_alloc(gspca_dev, file);
1850 if (mutex_lock_interruptible(&gspca_dev->queue_lock) != 0)
1853 /* check the next incoming buffer */
1854 i = gspca_dev->fr_o;
1855 i = gspca_dev->fr_queue[i];
1856 if (gspca_dev->frame[i].v4l2_buf.flags & V4L2_BUF_FLAG_DONE)
1857 ret = POLLIN | POLLRDNORM; /* something to read */
1860 mutex_unlock(&gspca_dev->queue_lock);
1861 if (!gspca_dev->present)
1866 static ssize_t dev_read(struct file *file, char __user *data,
1867 size_t count, loff_t *ppos)
1869 struct gspca_dev *gspca_dev = file->private_data;
1870 struct gspca_frame *frame;
1871 struct v4l2_buffer v4l2_buf;
1872 struct timeval timestamp;
1875 PDEBUG(D_FRAM, "read (%zd)", count);
1876 if (!gspca_dev->present)
1878 switch (gspca_dev->memory) {
1879 case GSPCA_MEMORY_NO: /* first time */
1880 ret = read_alloc(gspca_dev, file);
1884 case GSPCA_MEMORY_READ:
1885 if (gspca_dev->capt_file == file)
1893 jiffies_to_timeval(get_jiffies_64(), ×tamp);
1897 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1898 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1899 v4l2_buf.memory = GSPCA_MEMORY_READ;
1900 ret = vidioc_dqbuf(file, gspca_dev, &v4l2_buf);
1902 PDEBUG(D_STREAM, "read dqbuf err %d", ret);
1906 /* if the process slept for more than 1 second,
1907 * get a newer frame */
1908 frame = &gspca_dev->frame[v4l2_buf.index];
1910 break; /* avoid infinite loop */
1911 if (frame->v4l2_buf.timestamp.tv_sec >= timestamp.tv_sec)
1913 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1915 PDEBUG(D_STREAM, "read qbuf err %d", ret);
1920 /* copy the frame */
1921 if (count > frame->v4l2_buf.bytesused)
1922 count = frame->v4l2_buf.bytesused;
1923 ret = copy_to_user(data, frame->data, count);
1925 PDEBUG(D_ERR|D_STREAM,
1926 "read cp to user lack %d / %zd", ret, count);
1932 /* in each case, requeue the buffer */
1933 ret2 = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1939 static struct v4l2_file_operations dev_fops = {
1940 .owner = THIS_MODULE,
1942 .release = dev_close,
1945 .unlocked_ioctl = video_ioctl2,
1949 static const struct v4l2_ioctl_ops dev_ioctl_ops = {
1950 .vidioc_querycap = vidioc_querycap,
1951 .vidioc_dqbuf = vidioc_dqbuf,
1952 .vidioc_qbuf = vidioc_qbuf,
1953 .vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
1954 .vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
1955 .vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
1956 .vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
1957 .vidioc_streamon = vidioc_streamon,
1958 .vidioc_queryctrl = vidioc_queryctrl,
1959 .vidioc_g_ctrl = vidioc_g_ctrl,
1960 .vidioc_s_ctrl = vidioc_s_ctrl,
1961 .vidioc_g_audio = vidioc_g_audio,
1962 .vidioc_s_audio = vidioc_s_audio,
1963 .vidioc_enumaudio = vidioc_enumaudio,
1964 .vidioc_querymenu = vidioc_querymenu,
1965 .vidioc_enum_input = vidioc_enum_input,
1966 .vidioc_g_input = vidioc_g_input,
1967 .vidioc_s_input = vidioc_s_input,
1968 .vidioc_reqbufs = vidioc_reqbufs,
1969 .vidioc_querybuf = vidioc_querybuf,
1970 .vidioc_streamoff = vidioc_streamoff,
1971 .vidioc_g_jpegcomp = vidioc_g_jpegcomp,
1972 .vidioc_s_jpegcomp = vidioc_s_jpegcomp,
1973 .vidioc_g_parm = vidioc_g_parm,
1974 .vidioc_s_parm = vidioc_s_parm,
1975 .vidioc_enum_framesizes = vidioc_enum_framesizes,
1976 #ifdef CONFIG_VIDEO_ADV_DEBUG
1977 .vidioc_g_register = vidioc_g_register,
1978 .vidioc_s_register = vidioc_s_register,
1980 .vidioc_g_chip_ident = vidioc_g_chip_ident,
1981 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1982 .vidiocgmbuf = vidiocgmbuf,
1986 static struct video_device gspca_template = {
1987 .name = "gspca main driver",
1989 .ioctl_ops = &dev_ioctl_ops,
1990 .release = gspca_release,
1994 * probe and create a new gspca device
1996 * This function must be called by the sub-driver when it is
1997 * called for probing a new device.
1999 int gspca_dev_probe(struct usb_interface *intf,
2000 const struct usb_device_id *id,
2001 const struct sd_desc *sd_desc,
2003 struct module *module)
2005 struct usb_interface_descriptor *interface;
2006 struct gspca_dev *gspca_dev;
2007 struct usb_device *dev = interface_to_usbdev(intf);
2010 PDEBUG(D_PROBE, "probing %04x:%04x", id->idVendor, id->idProduct);
2012 /* we don't handle multi-config cameras */
2013 if (dev->descriptor.bNumConfigurations != 1) {
2014 PDEBUG(D_ERR, "Too many config");
2017 interface = &intf->cur_altsetting->desc;
2018 if (interface->bInterfaceNumber > 0) {
2019 PDEBUG(D_ERR, "intf != 0");
2023 /* create the device */
2024 if (dev_size < sizeof *gspca_dev)
2025 dev_size = sizeof *gspca_dev;
2026 gspca_dev = kzalloc(dev_size, GFP_KERNEL);
2028 err("couldn't kzalloc gspca struct");
2031 gspca_dev->usb_buf = kmalloc(USB_BUF_SZ, GFP_KERNEL);
2032 if (!gspca_dev->usb_buf) {
2033 err("out of memory");
2037 gspca_dev->dev = dev;
2038 gspca_dev->iface = interface->bInterfaceNumber;
2039 gspca_dev->nbalt = intf->num_altsetting;
2040 gspca_dev->sd_desc = sd_desc;
2041 gspca_dev->nbufread = 2;
2042 gspca_dev->empty_packet = -1; /* don't check the empty packets */
2044 /* configure the subdriver and initialize the USB device */
2045 ret = sd_desc->config(gspca_dev, id);
2048 ret = sd_desc->init(gspca_dev);
2051 gspca_set_default_mode(gspca_dev);
2053 mutex_init(&gspca_dev->usb_lock);
2054 mutex_init(&gspca_dev->read_lock);
2055 mutex_init(&gspca_dev->queue_lock);
2056 init_waitqueue_head(&gspca_dev->wq);
2058 /* init video stuff */
2059 memcpy(&gspca_dev->vdev, &gspca_template, sizeof gspca_template);
2060 gspca_dev->vdev.parent = &intf->dev;
2061 gspca_dev->module = module;
2062 gspca_dev->present = 1;
2063 ret = video_register_device(&gspca_dev->vdev,
2067 err("video_register_device err %d", ret);
2071 usb_set_intfdata(intf, gspca_dev);
2072 PDEBUG(D_PROBE, "%s created", video_device_node_name(&gspca_dev->vdev));
2075 kfree(gspca_dev->usb_buf);
2079 EXPORT_SYMBOL(gspca_dev_probe);
2084 * This function must be called by the sub-driver
2085 * when the device disconnects, after the specific resources are freed.
2087 void gspca_disconnect(struct usb_interface *intf)
2089 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2091 PDEBUG(D_PROBE, "%s disconnect",
2092 video_device_node_name(&gspca_dev->vdev));
2093 mutex_lock(&gspca_dev->usb_lock);
2094 gspca_dev->present = 0;
2096 if (gspca_dev->streaming) {
2097 destroy_urbs(gspca_dev);
2098 wake_up_interruptible(&gspca_dev->wq);
2101 /* the device is freed at exit of this function */
2102 gspca_dev->dev = NULL;
2103 mutex_unlock(&gspca_dev->usb_lock);
2105 usb_set_intfdata(intf, NULL);
2107 /* release the device */
2108 /* (this will call gspca_release() immediatly or on last close) */
2109 video_unregister_device(&gspca_dev->vdev);
2111 /* PDEBUG(D_PROBE, "disconnect complete"); */
2113 EXPORT_SYMBOL(gspca_disconnect);
2116 int gspca_suspend(struct usb_interface *intf, pm_message_t message)
2118 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2120 if (!gspca_dev->streaming)
2122 gspca_dev->frozen = 1; /* avoid urb error messages */
2123 if (gspca_dev->sd_desc->stopN)
2124 gspca_dev->sd_desc->stopN(gspca_dev);
2125 destroy_urbs(gspca_dev);
2126 gspca_set_alt0(gspca_dev);
2127 if (gspca_dev->sd_desc->stop0)
2128 gspca_dev->sd_desc->stop0(gspca_dev);
2131 EXPORT_SYMBOL(gspca_suspend);
2133 int gspca_resume(struct usb_interface *intf)
2135 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2137 gspca_dev->frozen = 0;
2138 gspca_dev->sd_desc->init(gspca_dev);
2139 if (gspca_dev->streaming)
2140 return gspca_init_transfer(gspca_dev);
2143 EXPORT_SYMBOL(gspca_resume);
2145 /* -- cam driver utility functions -- */
2147 /* auto gain and exposure algorithm based on the knee algorithm described here:
2148 http://ytse.tricolour.net/docs/LowLightOptimization.html
2150 Returns 0 if no changes were made, 1 if the gain and or exposure settings
2152 int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
2153 int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee)
2155 int i, steps, gain, orig_gain, exposure, orig_exposure, autogain;
2156 const struct ctrl *gain_ctrl = NULL;
2157 const struct ctrl *exposure_ctrl = NULL;
2158 const struct ctrl *autogain_ctrl = NULL;
2161 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
2162 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_GAIN)
2163 gain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2164 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_EXPOSURE)
2165 exposure_ctrl = &gspca_dev->sd_desc->ctrls[i];
2166 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_AUTOGAIN)
2167 autogain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2169 if (!gain_ctrl || !exposure_ctrl || !autogain_ctrl) {
2170 PDEBUG(D_ERR, "Error: gspca_auto_gain_n_exposure called "
2171 "on cam without (auto)gain/exposure");
2175 if (gain_ctrl->get(gspca_dev, &gain) ||
2176 exposure_ctrl->get(gspca_dev, &exposure) ||
2177 autogain_ctrl->get(gspca_dev, &autogain) || !autogain)
2181 orig_exposure = exposure;
2183 /* If we are of a multiple of deadzone, do multiple steps to reach the
2184 desired lumination fast (with the risc of a slight overshoot) */
2185 steps = abs(desired_avg_lum - avg_lum) / deadzone;
2187 PDEBUG(D_FRAM, "autogain: lum: %d, desired: %d, steps: %d",
2188 avg_lum, desired_avg_lum, steps);
2190 for (i = 0; i < steps; i++) {
2191 if (avg_lum > desired_avg_lum) {
2192 if (gain > gain_knee)
2194 else if (exposure > exposure_knee)
2196 else if (gain > gain_ctrl->qctrl.default_value)
2198 else if (exposure > exposure_ctrl->qctrl.minimum)
2200 else if (gain > gain_ctrl->qctrl.minimum)
2205 if (gain < gain_ctrl->qctrl.default_value)
2207 else if (exposure < exposure_knee)
2209 else if (gain < gain_knee)
2211 else if (exposure < exposure_ctrl->qctrl.maximum)
2213 else if (gain < gain_ctrl->qctrl.maximum)
2220 if (gain != orig_gain) {
2221 gain_ctrl->set(gspca_dev, gain);
2224 if (exposure != orig_exposure) {
2225 exposure_ctrl->set(gspca_dev, exposure);
2231 EXPORT_SYMBOL(gspca_auto_gain_n_exposure);
2233 /* -- module insert / remove -- */
2234 static int __init gspca_init(void)
2236 info("main v%d.%d.%d registered",
2237 (DRIVER_VERSION_NUMBER >> 16) & 0xff,
2238 (DRIVER_VERSION_NUMBER >> 8) & 0xff,
2239 DRIVER_VERSION_NUMBER & 0xff);
2242 static void __exit gspca_exit(void)
2244 info("main deregistered");
2247 module_init(gspca_init);
2248 module_exit(gspca_exit);
2251 module_param_named(debug, gspca_debug, int, 0644);
2252 MODULE_PARM_DESC(debug,
2253 "Debug (bit) 0x01:error 0x02:probe 0x04:config"
2254 " 0x08:stream 0x10:frame 0x20:packet 0x40:USBin 0x80:USBout"