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 gspca_dev->usb_err = 0;
771 if (gspca_dev->present)
772 ret = gspca_dev->sd_desc->get_register(gspca_dev, reg);
775 mutex_unlock(&gspca_dev->usb_lock);
780 static int vidioc_s_register(struct file *file, void *priv,
781 struct v4l2_dbg_register *reg)
784 struct gspca_dev *gspca_dev = priv;
786 if (!gspca_dev->sd_desc->get_chip_ident)
789 if (!gspca_dev->sd_desc->set_register)
792 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
794 gspca_dev->usb_err = 0;
795 if (gspca_dev->present)
796 ret = gspca_dev->sd_desc->set_register(gspca_dev, reg);
799 mutex_unlock(&gspca_dev->usb_lock);
805 static int vidioc_g_chip_ident(struct file *file, void *priv,
806 struct v4l2_dbg_chip_ident *chip)
809 struct gspca_dev *gspca_dev = priv;
811 if (!gspca_dev->sd_desc->get_chip_ident)
814 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
816 gspca_dev->usb_err = 0;
817 if (gspca_dev->present)
818 ret = gspca_dev->sd_desc->get_chip_ident(gspca_dev, chip);
821 mutex_unlock(&gspca_dev->usb_lock);
826 static int vidioc_enum_fmt_vid_cap(struct file *file, void *priv,
827 struct v4l2_fmtdesc *fmtdesc)
829 struct gspca_dev *gspca_dev = priv;
833 /* give an index to each format */
836 for (i = gspca_dev->cam.nmodes; --i >= 0; ) {
837 fmt_tb[index] = gspca_dev->cam.cam_mode[i].pixelformat;
840 if (fmt_tb[j] == fmt_tb[index])
845 if (fmtdesc->index == index)
846 break; /* new format */
848 if (index >= ARRAY_SIZE(fmt_tb))
853 return -EINVAL; /* no more format */
855 fmtdesc->pixelformat = fmt_tb[index];
856 if (gspca_is_compressed(fmt_tb[index]))
857 fmtdesc->flags = V4L2_FMT_FLAG_COMPRESSED;
858 fmtdesc->description[0] = fmtdesc->pixelformat & 0xff;
859 fmtdesc->description[1] = (fmtdesc->pixelformat >> 8) & 0xff;
860 fmtdesc->description[2] = (fmtdesc->pixelformat >> 16) & 0xff;
861 fmtdesc->description[3] = fmtdesc->pixelformat >> 24;
862 fmtdesc->description[4] = '\0';
866 static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
867 struct v4l2_format *fmt)
869 struct gspca_dev *gspca_dev = priv;
872 mode = gspca_dev->curr_mode;
873 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
874 sizeof fmt->fmt.pix);
878 static int try_fmt_vid_cap(struct gspca_dev *gspca_dev,
879 struct v4l2_format *fmt)
881 int w, h, mode, mode2;
883 w = fmt->fmt.pix.width;
884 h = fmt->fmt.pix.height;
887 if (gspca_debug & D_CONF)
888 PDEBUG_MODE("try fmt cap", fmt->fmt.pix.pixelformat, w, h);
890 /* search the closest mode for width and height */
891 mode = wxh_to_mode(gspca_dev, w, h);
893 /* OK if right palette */
894 if (gspca_dev->cam.cam_mode[mode].pixelformat
895 != fmt->fmt.pix.pixelformat) {
897 /* else, search the closest mode with the same pixel format */
898 mode2 = gspca_get_mode(gspca_dev, mode,
899 fmt->fmt.pix.pixelformat);
903 ; * no chance, return this mode */
905 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
906 sizeof fmt->fmt.pix);
907 return mode; /* used when s_fmt */
910 static int vidioc_try_fmt_vid_cap(struct file *file,
912 struct v4l2_format *fmt)
914 struct gspca_dev *gspca_dev = priv;
917 ret = try_fmt_vid_cap(gspca_dev, fmt);
923 static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
924 struct v4l2_format *fmt)
926 struct gspca_dev *gspca_dev = priv;
929 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
932 ret = try_fmt_vid_cap(gspca_dev, fmt);
936 if (gspca_dev->nframes != 0
937 && fmt->fmt.pix.sizeimage > gspca_dev->frsz) {
942 if (ret == gspca_dev->curr_mode) {
944 goto out; /* same mode */
947 if (gspca_dev->streaming) {
951 gspca_dev->width = fmt->fmt.pix.width;
952 gspca_dev->height = fmt->fmt.pix.height;
953 gspca_dev->pixfmt = fmt->fmt.pix.pixelformat;
954 gspca_dev->curr_mode = ret;
958 mutex_unlock(&gspca_dev->queue_lock);
962 static int vidioc_enum_framesizes(struct file *file, void *priv,
963 struct v4l2_frmsizeenum *fsize)
965 struct gspca_dev *gspca_dev = priv;
969 for (i = 0; i < gspca_dev->cam.nmodes; i++) {
970 if (fsize->pixel_format !=
971 gspca_dev->cam.cam_mode[i].pixelformat)
974 if (fsize->index == index) {
975 fsize->type = V4L2_FRMSIZE_TYPE_DISCRETE;
976 fsize->discrete.width =
977 gspca_dev->cam.cam_mode[i].width;
978 fsize->discrete.height =
979 gspca_dev->cam.cam_mode[i].height;
988 static int vidioc_enum_frameintervals(struct file *filp, void *priv,
989 struct v4l2_frmivalenum *fival)
991 struct gspca_dev *gspca_dev = priv;
992 int mode = wxh_to_mode(gspca_dev, fival->width, fival->height);
995 if (gspca_dev->cam.mode_framerates == NULL ||
996 gspca_dev->cam.mode_framerates[mode].nrates == 0)
999 if (fival->pixel_format !=
1000 gspca_dev->cam.cam_mode[mode].pixelformat)
1003 for (i = 0; i < gspca_dev->cam.mode_framerates[mode].nrates; i++) {
1004 if (fival->index == i) {
1005 fival->type = V4L2_FRMSIZE_TYPE_DISCRETE;
1006 fival->discrete.numerator = 1;
1007 fival->discrete.denominator =
1008 gspca_dev->cam.mode_framerates[mode].rates[i];
1016 static void gspca_release(struct video_device *vfd)
1018 struct gspca_dev *gspca_dev = container_of(vfd, struct gspca_dev, vdev);
1020 PDEBUG(D_PROBE, "%s released",
1021 video_device_node_name(&gspca_dev->vdev));
1023 kfree(gspca_dev->usb_buf);
1027 static int dev_open(struct file *file)
1029 struct gspca_dev *gspca_dev;
1032 PDEBUG(D_STREAM, "[%s] open", current->comm);
1033 gspca_dev = (struct gspca_dev *) video_devdata(file);
1034 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1035 return -ERESTARTSYS;
1036 if (!gspca_dev->present) {
1041 if (gspca_dev->users > 4) { /* (arbitrary value) */
1046 /* protect the subdriver against rmmod */
1047 if (!try_module_get(gspca_dev->module)) {
1054 file->private_data = gspca_dev;
1056 /* activate the v4l2 debug */
1057 if (gspca_debug & D_V4L2)
1058 gspca_dev->vdev.debug |= V4L2_DEBUG_IOCTL
1059 | V4L2_DEBUG_IOCTL_ARG;
1061 gspca_dev->vdev.debug &= ~(V4L2_DEBUG_IOCTL
1062 | V4L2_DEBUG_IOCTL_ARG);
1066 mutex_unlock(&gspca_dev->queue_lock);
1068 PDEBUG(D_ERR|D_STREAM, "open failed err %d", ret);
1070 PDEBUG(D_STREAM, "open done");
1074 static int dev_close(struct file *file)
1076 struct gspca_dev *gspca_dev = file->private_data;
1078 PDEBUG(D_STREAM, "[%s] close", current->comm);
1079 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1080 return -ERESTARTSYS;
1083 /* if the file did the capture, free the streaming resources */
1084 if (gspca_dev->capt_file == file) {
1085 if (gspca_dev->streaming) {
1086 mutex_lock(&gspca_dev->usb_lock);
1087 gspca_dev->usb_err = 0;
1088 gspca_stream_off(gspca_dev);
1089 mutex_unlock(&gspca_dev->usb_lock);
1091 frame_free(gspca_dev);
1092 gspca_dev->capt_file = NULL;
1093 gspca_dev->memory = GSPCA_MEMORY_NO;
1095 file->private_data = NULL;
1096 module_put(gspca_dev->module);
1097 mutex_unlock(&gspca_dev->queue_lock);
1099 PDEBUG(D_STREAM, "close done");
1104 static int vidioc_querycap(struct file *file, void *priv,
1105 struct v4l2_capability *cap)
1107 struct gspca_dev *gspca_dev = priv;
1110 /* protect the access to the usb device */
1111 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1112 return -ERESTARTSYS;
1113 if (!gspca_dev->present) {
1117 strncpy(cap->driver, gspca_dev->sd_desc->name, sizeof cap->driver);
1118 if (gspca_dev->dev->product != NULL) {
1119 strncpy(cap->card, gspca_dev->dev->product,
1122 snprintf(cap->card, sizeof cap->card,
1123 "USB Camera (%04x:%04x)",
1124 le16_to_cpu(gspca_dev->dev->descriptor.idVendor),
1125 le16_to_cpu(gspca_dev->dev->descriptor.idProduct));
1127 usb_make_path(gspca_dev->dev, cap->bus_info, sizeof(cap->bus_info));
1128 cap->version = DRIVER_VERSION_NUMBER;
1129 cap->capabilities = V4L2_CAP_VIDEO_CAPTURE
1130 | V4L2_CAP_STREAMING
1131 | V4L2_CAP_READWRITE;
1134 mutex_unlock(&gspca_dev->usb_lock);
1138 static const struct ctrl *get_ctrl(struct gspca_dev *gspca_dev,
1141 const struct ctrl *ctrls;
1144 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
1145 i < gspca_dev->sd_desc->nctrls;
1147 if (gspca_dev->ctrl_dis & (1 << i))
1149 if (id == ctrls->qctrl.id)
1155 static int vidioc_queryctrl(struct file *file, void *priv,
1156 struct v4l2_queryctrl *q_ctrl)
1158 struct gspca_dev *gspca_dev = priv;
1159 const struct ctrl *ctrls;
1165 if (id & V4L2_CTRL_FLAG_NEXT_CTRL) {
1166 id &= V4L2_CTRL_ID_MASK;
1168 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
1169 if (gspca_dev->ctrl_dis & (1 << i))
1171 if (gspca_dev->sd_desc->ctrls[i].qctrl.id < id)
1173 if (ctrls && gspca_dev->sd_desc->ctrls[i].qctrl.id
1176 ctrls = &gspca_dev->sd_desc->ctrls[i];
1181 ctrls = get_ctrl(gspca_dev, id);
1184 i = ctrls - gspca_dev->sd_desc->ctrls;
1186 memcpy(q_ctrl, ctrls, sizeof *q_ctrl);
1187 if (gspca_dev->ctrl_inac & (1 << i))
1188 q_ctrl->flags |= V4L2_CTRL_FLAG_INACTIVE;
1192 static int vidioc_s_ctrl(struct file *file, void *priv,
1193 struct v4l2_control *ctrl)
1195 struct gspca_dev *gspca_dev = priv;
1196 const struct ctrl *ctrls;
1199 ctrls = get_ctrl(gspca_dev, ctrl->id);
1203 if (ctrl->value < ctrls->qctrl.minimum
1204 || ctrl->value > ctrls->qctrl.maximum)
1206 PDEBUG(D_CONF, "set ctrl [%08x] = %d", ctrl->id, ctrl->value);
1207 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1208 return -ERESTARTSYS;
1209 gspca_dev->usb_err = 0;
1210 if (gspca_dev->present)
1211 ret = ctrls->set(gspca_dev, ctrl->value);
1214 mutex_unlock(&gspca_dev->usb_lock);
1218 static int vidioc_g_ctrl(struct file *file, void *priv,
1219 struct v4l2_control *ctrl)
1221 struct gspca_dev *gspca_dev = priv;
1222 const struct ctrl *ctrls;
1225 ctrls = get_ctrl(gspca_dev, ctrl->id);
1229 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1230 return -ERESTARTSYS;
1231 gspca_dev->usb_err = 0;
1232 if (gspca_dev->present)
1233 ret = ctrls->get(gspca_dev, &ctrl->value);
1236 mutex_unlock(&gspca_dev->usb_lock);
1240 /*fixme: have an audio flag in gspca_dev?*/
1241 static int vidioc_s_audio(struct file *file, void *priv,
1242 struct v4l2_audio *audio)
1244 if (audio->index != 0)
1249 static int vidioc_g_audio(struct file *file, void *priv,
1250 struct v4l2_audio *audio)
1252 strcpy(audio->name, "Microphone");
1256 static int vidioc_enumaudio(struct file *file, void *priv,
1257 struct v4l2_audio *audio)
1259 if (audio->index != 0)
1262 strcpy(audio->name, "Microphone");
1263 audio->capability = 0;
1268 static int vidioc_querymenu(struct file *file, void *priv,
1269 struct v4l2_querymenu *qmenu)
1271 struct gspca_dev *gspca_dev = priv;
1273 if (!gspca_dev->sd_desc->querymenu)
1275 return gspca_dev->sd_desc->querymenu(gspca_dev, qmenu);
1278 static int vidioc_enum_input(struct file *file, void *priv,
1279 struct v4l2_input *input)
1281 struct gspca_dev *gspca_dev = priv;
1283 if (input->index != 0)
1285 input->type = V4L2_INPUT_TYPE_CAMERA;
1286 input->status = gspca_dev->cam.input_flags;
1287 strncpy(input->name, gspca_dev->sd_desc->name,
1288 sizeof input->name);
1292 static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
1298 static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
1305 static int vidioc_reqbufs(struct file *file, void *priv,
1306 struct v4l2_requestbuffers *rb)
1308 struct gspca_dev *gspca_dev = priv;
1311 switch (rb->memory) {
1312 case GSPCA_MEMORY_READ: /* (internal call) */
1313 case V4L2_MEMORY_MMAP:
1314 case V4L2_MEMORY_USERPTR:
1319 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1320 return -ERESTARTSYS;
1322 if (gspca_dev->memory != GSPCA_MEMORY_NO
1323 && gspca_dev->memory != rb->memory) {
1328 /* only one file may do the capture */
1329 if (gspca_dev->capt_file != NULL
1330 && gspca_dev->capt_file != file) {
1335 /* if allocated, the buffers must not be mapped */
1336 for (i = 0; i < gspca_dev->nframes; i++) {
1337 if (gspca_dev->frame[i].vma_use_count) {
1343 /* stop streaming */
1344 if (gspca_dev->streaming) {
1345 mutex_lock(&gspca_dev->usb_lock);
1346 gspca_dev->usb_err = 0;
1347 gspca_stream_off(gspca_dev);
1348 mutex_unlock(&gspca_dev->usb_lock);
1351 /* free the previous allocated buffers, if any */
1352 if (gspca_dev->nframes != 0) {
1353 frame_free(gspca_dev);
1354 gspca_dev->capt_file = NULL;
1356 if (rb->count == 0) /* unrequest */
1358 gspca_dev->memory = rb->memory;
1359 ret = frame_alloc(gspca_dev, rb->count);
1361 rb->count = gspca_dev->nframes;
1362 gspca_dev->capt_file = file;
1365 mutex_unlock(&gspca_dev->queue_lock);
1366 PDEBUG(D_STREAM, "reqbufs st:%d c:%d", ret, rb->count);
1370 static int vidioc_querybuf(struct file *file, void *priv,
1371 struct v4l2_buffer *v4l2_buf)
1373 struct gspca_dev *gspca_dev = priv;
1374 struct gspca_frame *frame;
1376 if (v4l2_buf->index < 0
1377 || v4l2_buf->index >= gspca_dev->nframes)
1380 frame = &gspca_dev->frame[v4l2_buf->index];
1381 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1385 static int vidioc_streamon(struct file *file, void *priv,
1386 enum v4l2_buf_type buf_type)
1388 struct gspca_dev *gspca_dev = priv;
1391 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1393 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1394 return -ERESTARTSYS;
1396 if (gspca_dev->nframes == 0
1397 || !(gspca_dev->frame[0].v4l2_buf.flags & V4L2_BUF_FLAG_QUEUED)) {
1401 if (!gspca_dev->streaming) {
1402 ret = gspca_init_transfer(gspca_dev);
1407 if (gspca_debug & D_STREAM) {
1408 PDEBUG_MODE("stream on OK",
1416 mutex_unlock(&gspca_dev->queue_lock);
1420 static int vidioc_streamoff(struct file *file, void *priv,
1421 enum v4l2_buf_type buf_type)
1423 struct gspca_dev *gspca_dev = priv;
1426 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1428 if (!gspca_dev->streaming)
1430 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1431 return -ERESTARTSYS;
1433 /* stop streaming */
1434 if (mutex_lock_interruptible(&gspca_dev->usb_lock)) {
1438 gspca_dev->usb_err = 0;
1439 gspca_stream_off(gspca_dev);
1440 mutex_unlock(&gspca_dev->usb_lock);
1442 /* empty the application queues */
1443 for (i = 0; i < gspca_dev->nframes; i++)
1444 gspca_dev->frame[i].v4l2_buf.flags &= ~BUF_ALL_FLAGS;
1445 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
1446 gspca_dev->last_packet_type = DISCARD_PACKET;
1447 gspca_dev->sequence = 0;
1450 mutex_unlock(&gspca_dev->queue_lock);
1454 static int vidioc_g_jpegcomp(struct file *file, void *priv,
1455 struct v4l2_jpegcompression *jpegcomp)
1457 struct gspca_dev *gspca_dev = priv;
1460 if (!gspca_dev->sd_desc->get_jcomp)
1462 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1463 return -ERESTARTSYS;
1464 gspca_dev->usb_err = 0;
1465 if (gspca_dev->present)
1466 ret = gspca_dev->sd_desc->get_jcomp(gspca_dev, jpegcomp);
1469 mutex_unlock(&gspca_dev->usb_lock);
1473 static int vidioc_s_jpegcomp(struct file *file, void *priv,
1474 struct v4l2_jpegcompression *jpegcomp)
1476 struct gspca_dev *gspca_dev = priv;
1479 if (!gspca_dev->sd_desc->set_jcomp)
1481 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1482 return -ERESTARTSYS;
1483 gspca_dev->usb_err = 0;
1484 if (gspca_dev->present)
1485 ret = gspca_dev->sd_desc->set_jcomp(gspca_dev, jpegcomp);
1488 mutex_unlock(&gspca_dev->usb_lock);
1492 static int vidioc_g_parm(struct file *filp, void *priv,
1493 struct v4l2_streamparm *parm)
1495 struct gspca_dev *gspca_dev = priv;
1497 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1499 if (gspca_dev->sd_desc->get_streamparm) {
1502 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1503 return -ERESTARTSYS;
1504 gspca_dev->usb_err = 0;
1505 if (gspca_dev->present)
1506 ret = gspca_dev->sd_desc->get_streamparm(gspca_dev,
1510 mutex_unlock(&gspca_dev->usb_lock);
1517 static int vidioc_s_parm(struct file *filp, void *priv,
1518 struct v4l2_streamparm *parm)
1520 struct gspca_dev *gspca_dev = priv;
1523 n = parm->parm.capture.readbuffers;
1524 if (n == 0 || n > GSPCA_MAX_FRAMES)
1525 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1527 gspca_dev->nbufread = n;
1529 if (gspca_dev->sd_desc->set_streamparm) {
1532 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1533 return -ERESTARTSYS;
1534 gspca_dev->usb_err = 0;
1535 if (gspca_dev->present)
1536 ret = gspca_dev->sd_desc->set_streamparm(gspca_dev,
1540 mutex_unlock(&gspca_dev->usb_lock);
1547 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1548 static int vidiocgmbuf(struct file *file, void *priv,
1549 struct video_mbuf *mbuf)
1551 struct gspca_dev *gspca_dev = file->private_data;
1554 PDEBUG(D_STREAM, "cgmbuf");
1555 if (gspca_dev->nframes == 0) {
1559 struct v4l2_format fmt;
1561 fmt.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1562 i = gspca_dev->cam.nmodes - 1; /* highest mode */
1563 fmt.fmt.pix.width = gspca_dev->cam.cam_mode[i].width;
1564 fmt.fmt.pix.height = gspca_dev->cam.cam_mode[i].height;
1565 fmt.fmt.pix.pixelformat = V4L2_PIX_FMT_BGR24;
1566 ret = vidioc_s_fmt_vid_cap(file, priv, &fmt);
1571 struct v4l2_requestbuffers rb;
1573 memset(&rb, 0, sizeof rb);
1575 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1576 rb.memory = V4L2_MEMORY_MMAP;
1577 ret = vidioc_reqbufs(file, priv, &rb);
1582 mbuf->frames = gspca_dev->nframes;
1583 mbuf->size = gspca_dev->frsz * gspca_dev->nframes;
1584 for (i = 0; i < mbuf->frames; i++)
1585 mbuf->offsets[i] = gspca_dev->frame[i].v4l2_buf.m.offset;
1590 static int dev_mmap(struct file *file, struct vm_area_struct *vma)
1592 struct gspca_dev *gspca_dev = file->private_data;
1593 struct gspca_frame *frame;
1595 unsigned long addr, start, size;
1598 start = vma->vm_start;
1599 size = vma->vm_end - vma->vm_start;
1600 PDEBUG(D_STREAM, "mmap start:%08x size:%d", (int) start, (int) size);
1602 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1603 return -ERESTARTSYS;
1604 if (!gspca_dev->present) {
1608 if (gspca_dev->capt_file != file) {
1614 for (i = 0; i < gspca_dev->nframes; ++i) {
1615 if (gspca_dev->frame[i].v4l2_buf.memory != V4L2_MEMORY_MMAP) {
1616 PDEBUG(D_STREAM, "mmap bad memory type");
1619 if ((gspca_dev->frame[i].v4l2_buf.m.offset >> PAGE_SHIFT)
1621 frame = &gspca_dev->frame[i];
1625 if (frame == NULL) {
1626 PDEBUG(D_STREAM, "mmap no frame buffer found");
1630 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1631 /* v4l1 maps all the buffers */
1633 || size != frame->v4l2_buf.length * gspca_dev->nframes)
1635 if (size != frame->v4l2_buf.length) {
1636 PDEBUG(D_STREAM, "mmap bad size");
1642 * - VM_IO marks the area as being a mmaped region for I/O to a
1643 * device. It also prevents the region from being core dumped.
1645 vma->vm_flags |= VM_IO;
1647 addr = (unsigned long) frame->data;
1649 page = vmalloc_to_page((void *) addr);
1650 ret = vm_insert_page(vma, start, page);
1658 vma->vm_ops = &gspca_vm_ops;
1659 vma->vm_private_data = frame;
1663 mutex_unlock(&gspca_dev->queue_lock);
1668 * wait for a video frame
1670 * If a frame is ready, its index is returned.
1672 static int frame_wait(struct gspca_dev *gspca_dev,
1675 struct gspca_frame *frame;
1678 /* check if a frame is ready */
1679 i = gspca_dev->fr_o;
1680 j = gspca_dev->fr_queue[i];
1681 frame = &gspca_dev->frame[j];
1683 if (!(frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE)) {
1687 /* wait till a frame is ready */
1688 ret = wait_event_interruptible_timeout(gspca_dev->wq,
1689 (frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE) ||
1690 !gspca_dev->streaming || !gspca_dev->present,
1691 msecs_to_jiffies(3000));
1694 if (ret == 0 || !gspca_dev->streaming || !gspca_dev->present)
1698 gspca_dev->fr_o = (i + 1) % gspca_dev->nframes;
1699 PDEBUG(D_FRAM, "frame wait q:%d i:%d o:%d",
1704 if (gspca_dev->sd_desc->dq_callback) {
1705 mutex_lock(&gspca_dev->usb_lock);
1706 gspca_dev->usb_err = 0;
1707 if (gspca_dev->present)
1708 gspca_dev->sd_desc->dq_callback(gspca_dev);
1709 mutex_unlock(&gspca_dev->usb_lock);
1715 * dequeue a video buffer
1717 * If nonblock_ing is false, block until a buffer is available.
1719 static int vidioc_dqbuf(struct file *file, void *priv,
1720 struct v4l2_buffer *v4l2_buf)
1722 struct gspca_dev *gspca_dev = priv;
1723 struct gspca_frame *frame;
1726 PDEBUG(D_FRAM, "dqbuf");
1727 if (v4l2_buf->memory != gspca_dev->memory)
1730 if (!gspca_dev->present)
1733 /* if not streaming, be sure the application will not loop forever */
1734 if (!(file->f_flags & O_NONBLOCK)
1735 && !gspca_dev->streaming && gspca_dev->users == 1)
1738 /* only the capturing file may dequeue */
1739 if (gspca_dev->capt_file != file)
1742 /* only one dequeue / read at a time */
1743 if (mutex_lock_interruptible(&gspca_dev->read_lock))
1744 return -ERESTARTSYS;
1746 ret = frame_wait(gspca_dev, file->f_flags & O_NONBLOCK);
1749 i = ret; /* frame index */
1750 frame = &gspca_dev->frame[i];
1751 if (gspca_dev->memory == V4L2_MEMORY_USERPTR) {
1752 if (copy_to_user((__u8 __user *) frame->v4l2_buf.m.userptr,
1754 frame->v4l2_buf.bytesused)) {
1755 PDEBUG(D_ERR|D_STREAM,
1756 "dqbuf cp to user failed");
1761 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_DONE;
1762 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1763 PDEBUG(D_FRAM, "dqbuf %d", i);
1766 mutex_unlock(&gspca_dev->read_lock);
1771 * queue a video buffer
1773 * Attempting to queue a buffer that has already been
1774 * queued will return -EINVAL.
1776 static int vidioc_qbuf(struct file *file, void *priv,
1777 struct v4l2_buffer *v4l2_buf)
1779 struct gspca_dev *gspca_dev = priv;
1780 struct gspca_frame *frame;
1783 PDEBUG(D_FRAM, "qbuf %d", v4l2_buf->index);
1785 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1786 return -ERESTARTSYS;
1788 index = v4l2_buf->index;
1789 if ((unsigned) index >= gspca_dev->nframes) {
1791 "qbuf idx %d >= %d", index, gspca_dev->nframes);
1795 if (v4l2_buf->memory != gspca_dev->memory) {
1796 PDEBUG(D_FRAM, "qbuf bad memory type");
1801 frame = &gspca_dev->frame[index];
1802 if (frame->v4l2_buf.flags & BUF_ALL_FLAGS) {
1803 PDEBUG(D_FRAM, "qbuf bad state");
1808 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_QUEUED;
1810 if (frame->v4l2_buf.memory == V4L2_MEMORY_USERPTR) {
1811 frame->v4l2_buf.m.userptr = v4l2_buf->m.userptr;
1812 frame->v4l2_buf.length = v4l2_buf->length;
1815 /* put the buffer in the 'queued' queue */
1816 i = gspca_dev->fr_q;
1817 gspca_dev->fr_queue[i] = index;
1818 if (gspca_dev->fr_i == i)
1819 gspca_dev->cur_frame = frame;
1820 gspca_dev->fr_q = (i + 1) % gspca_dev->nframes;
1821 PDEBUG(D_FRAM, "qbuf q:%d i:%d o:%d",
1826 v4l2_buf->flags |= V4L2_BUF_FLAG_QUEUED;
1827 v4l2_buf->flags &= ~V4L2_BUF_FLAG_DONE;
1830 mutex_unlock(&gspca_dev->queue_lock);
1835 * allocate the resources for read()
1837 static int read_alloc(struct gspca_dev *gspca_dev,
1840 struct v4l2_buffer v4l2_buf;
1843 PDEBUG(D_STREAM, "read alloc");
1844 if (gspca_dev->nframes == 0) {
1845 struct v4l2_requestbuffers rb;
1847 memset(&rb, 0, sizeof rb);
1848 rb.count = gspca_dev->nbufread;
1849 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1850 rb.memory = GSPCA_MEMORY_READ;
1851 ret = vidioc_reqbufs(file, gspca_dev, &rb);
1853 PDEBUG(D_STREAM, "read reqbuf err %d", ret);
1856 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1857 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1858 v4l2_buf.memory = GSPCA_MEMORY_READ;
1859 for (i = 0; i < gspca_dev->nbufread; i++) {
1861 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1863 PDEBUG(D_STREAM, "read qbuf err: %d", ret);
1867 gspca_dev->memory = GSPCA_MEMORY_READ;
1870 /* start streaming */
1871 ret = vidioc_streamon(file, gspca_dev, V4L2_BUF_TYPE_VIDEO_CAPTURE);
1873 PDEBUG(D_STREAM, "read streamon err %d", ret);
1877 static unsigned int dev_poll(struct file *file, poll_table *wait)
1879 struct gspca_dev *gspca_dev = file->private_data;
1882 PDEBUG(D_FRAM, "poll");
1884 poll_wait(file, &gspca_dev->wq, wait);
1886 /* if reqbufs is not done, the user would use read() */
1887 if (gspca_dev->nframes == 0) {
1888 if (gspca_dev->memory != GSPCA_MEMORY_NO)
1889 return POLLERR; /* not the 1st time */
1890 ret = read_alloc(gspca_dev, file);
1895 if (mutex_lock_interruptible(&gspca_dev->queue_lock) != 0)
1898 /* check the next incoming buffer */
1899 i = gspca_dev->fr_o;
1900 i = gspca_dev->fr_queue[i];
1901 if (gspca_dev->frame[i].v4l2_buf.flags & V4L2_BUF_FLAG_DONE)
1902 ret = POLLIN | POLLRDNORM; /* something to read */
1905 mutex_unlock(&gspca_dev->queue_lock);
1906 if (!gspca_dev->present)
1911 static ssize_t dev_read(struct file *file, char __user *data,
1912 size_t count, loff_t *ppos)
1914 struct gspca_dev *gspca_dev = file->private_data;
1915 struct gspca_frame *frame;
1916 struct v4l2_buffer v4l2_buf;
1917 struct timeval timestamp;
1920 PDEBUG(D_FRAM, "read (%zd)", count);
1921 if (!gspca_dev->present)
1923 switch (gspca_dev->memory) {
1924 case GSPCA_MEMORY_NO: /* first time */
1925 ret = read_alloc(gspca_dev, file);
1929 case GSPCA_MEMORY_READ:
1930 if (gspca_dev->capt_file == file)
1938 jiffies_to_timeval(get_jiffies_64(), ×tamp);
1942 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1943 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1944 v4l2_buf.memory = GSPCA_MEMORY_READ;
1945 ret = vidioc_dqbuf(file, gspca_dev, &v4l2_buf);
1947 PDEBUG(D_STREAM, "read dqbuf err %d", ret);
1951 /* if the process slept for more than 1 second,
1952 * get a newer frame */
1953 frame = &gspca_dev->frame[v4l2_buf.index];
1955 break; /* avoid infinite loop */
1956 if (frame->v4l2_buf.timestamp.tv_sec >= timestamp.tv_sec)
1958 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1960 PDEBUG(D_STREAM, "read qbuf err %d", ret);
1965 /* copy the frame */
1966 if (count > frame->v4l2_buf.bytesused)
1967 count = frame->v4l2_buf.bytesused;
1968 ret = copy_to_user(data, frame->data, count);
1970 PDEBUG(D_ERR|D_STREAM,
1971 "read cp to user lack %d / %zd", ret, count);
1977 /* in each case, requeue the buffer */
1978 ret2 = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1984 static struct v4l2_file_operations dev_fops = {
1985 .owner = THIS_MODULE,
1987 .release = dev_close,
1990 .unlocked_ioctl = video_ioctl2,
1994 static const struct v4l2_ioctl_ops dev_ioctl_ops = {
1995 .vidioc_querycap = vidioc_querycap,
1996 .vidioc_dqbuf = vidioc_dqbuf,
1997 .vidioc_qbuf = vidioc_qbuf,
1998 .vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
1999 .vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
2000 .vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
2001 .vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
2002 .vidioc_streamon = vidioc_streamon,
2003 .vidioc_queryctrl = vidioc_queryctrl,
2004 .vidioc_g_ctrl = vidioc_g_ctrl,
2005 .vidioc_s_ctrl = vidioc_s_ctrl,
2006 .vidioc_g_audio = vidioc_g_audio,
2007 .vidioc_s_audio = vidioc_s_audio,
2008 .vidioc_enumaudio = vidioc_enumaudio,
2009 .vidioc_querymenu = vidioc_querymenu,
2010 .vidioc_enum_input = vidioc_enum_input,
2011 .vidioc_g_input = vidioc_g_input,
2012 .vidioc_s_input = vidioc_s_input,
2013 .vidioc_reqbufs = vidioc_reqbufs,
2014 .vidioc_querybuf = vidioc_querybuf,
2015 .vidioc_streamoff = vidioc_streamoff,
2016 .vidioc_g_jpegcomp = vidioc_g_jpegcomp,
2017 .vidioc_s_jpegcomp = vidioc_s_jpegcomp,
2018 .vidioc_g_parm = vidioc_g_parm,
2019 .vidioc_s_parm = vidioc_s_parm,
2020 .vidioc_enum_framesizes = vidioc_enum_framesizes,
2021 .vidioc_enum_frameintervals = vidioc_enum_frameintervals,
2022 #ifdef CONFIG_VIDEO_ADV_DEBUG
2023 .vidioc_g_register = vidioc_g_register,
2024 .vidioc_s_register = vidioc_s_register,
2026 .vidioc_g_chip_ident = vidioc_g_chip_ident,
2027 #ifdef CONFIG_VIDEO_V4L1_COMPAT
2028 .vidiocgmbuf = vidiocgmbuf,
2032 static struct video_device gspca_template = {
2033 .name = "gspca main driver",
2035 .ioctl_ops = &dev_ioctl_ops,
2036 .release = gspca_release,
2040 * probe and create a new gspca device
2042 * This function must be called by the sub-driver when it is
2043 * called for probing a new device.
2045 int gspca_dev_probe(struct usb_interface *intf,
2046 const struct usb_device_id *id,
2047 const struct sd_desc *sd_desc,
2049 struct module *module)
2051 struct usb_interface_descriptor *interface;
2052 struct gspca_dev *gspca_dev;
2053 struct usb_device *dev = interface_to_usbdev(intf);
2056 PDEBUG(D_PROBE, "probing %04x:%04x", id->idVendor, id->idProduct);
2058 /* we don't handle multi-config cameras */
2059 if (dev->descriptor.bNumConfigurations != 1) {
2060 PDEBUG(D_ERR, "Too many config");
2063 interface = &intf->cur_altsetting->desc;
2064 if (interface->bInterfaceNumber > 0) {
2065 PDEBUG(D_ERR, "intf != 0");
2069 /* create the device */
2070 if (dev_size < sizeof *gspca_dev)
2071 dev_size = sizeof *gspca_dev;
2072 gspca_dev = kzalloc(dev_size, GFP_KERNEL);
2074 err("couldn't kzalloc gspca struct");
2077 gspca_dev->usb_buf = kmalloc(USB_BUF_SZ, GFP_KERNEL);
2078 if (!gspca_dev->usb_buf) {
2079 err("out of memory");
2083 gspca_dev->dev = dev;
2084 gspca_dev->iface = interface->bInterfaceNumber;
2085 gspca_dev->nbalt = intf->num_altsetting;
2086 gspca_dev->sd_desc = sd_desc;
2087 gspca_dev->nbufread = 2;
2088 gspca_dev->empty_packet = -1; /* don't check the empty packets */
2090 /* configure the subdriver and initialize the USB device */
2091 ret = sd_desc->config(gspca_dev, id);
2094 ret = sd_desc->init(gspca_dev);
2097 gspca_set_default_mode(gspca_dev);
2099 mutex_init(&gspca_dev->usb_lock);
2100 mutex_init(&gspca_dev->read_lock);
2101 mutex_init(&gspca_dev->queue_lock);
2102 init_waitqueue_head(&gspca_dev->wq);
2104 /* init video stuff */
2105 memcpy(&gspca_dev->vdev, &gspca_template, sizeof gspca_template);
2106 gspca_dev->vdev.parent = &intf->dev;
2107 gspca_dev->module = module;
2108 gspca_dev->present = 1;
2109 ret = video_register_device(&gspca_dev->vdev,
2113 err("video_register_device err %d", ret);
2117 usb_set_intfdata(intf, gspca_dev);
2118 PDEBUG(D_PROBE, "%s created", video_device_node_name(&gspca_dev->vdev));
2121 kfree(gspca_dev->usb_buf);
2125 EXPORT_SYMBOL(gspca_dev_probe);
2130 * This function must be called by the sub-driver
2131 * when the device disconnects, after the specific resources are freed.
2133 void gspca_disconnect(struct usb_interface *intf)
2135 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2137 PDEBUG(D_PROBE, "%s disconnect",
2138 video_device_node_name(&gspca_dev->vdev));
2139 mutex_lock(&gspca_dev->usb_lock);
2140 gspca_dev->present = 0;
2142 if (gspca_dev->streaming) {
2143 destroy_urbs(gspca_dev);
2144 wake_up_interruptible(&gspca_dev->wq);
2147 /* the device is freed at exit of this function */
2148 gspca_dev->dev = NULL;
2149 mutex_unlock(&gspca_dev->usb_lock);
2151 usb_set_intfdata(intf, NULL);
2153 /* release the device */
2154 /* (this will call gspca_release() immediatly or on last close) */
2155 video_unregister_device(&gspca_dev->vdev);
2157 /* PDEBUG(D_PROBE, "disconnect complete"); */
2159 EXPORT_SYMBOL(gspca_disconnect);
2162 int gspca_suspend(struct usb_interface *intf, pm_message_t message)
2164 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2166 if (!gspca_dev->streaming)
2168 gspca_dev->frozen = 1; /* avoid urb error messages */
2169 if (gspca_dev->sd_desc->stopN)
2170 gspca_dev->sd_desc->stopN(gspca_dev);
2171 destroy_urbs(gspca_dev);
2172 gspca_set_alt0(gspca_dev);
2173 if (gspca_dev->sd_desc->stop0)
2174 gspca_dev->sd_desc->stop0(gspca_dev);
2177 EXPORT_SYMBOL(gspca_suspend);
2179 int gspca_resume(struct usb_interface *intf)
2181 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2183 gspca_dev->frozen = 0;
2184 gspca_dev->sd_desc->init(gspca_dev);
2185 if (gspca_dev->streaming)
2186 return gspca_init_transfer(gspca_dev);
2189 EXPORT_SYMBOL(gspca_resume);
2191 /* -- cam driver utility functions -- */
2193 /* auto gain and exposure algorithm based on the knee algorithm described here:
2194 http://ytse.tricolour.net/docs/LowLightOptimization.html
2196 Returns 0 if no changes were made, 1 if the gain and or exposure settings
2198 int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
2199 int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee)
2201 int i, steps, gain, orig_gain, exposure, orig_exposure, autogain;
2202 const struct ctrl *gain_ctrl = NULL;
2203 const struct ctrl *exposure_ctrl = NULL;
2204 const struct ctrl *autogain_ctrl = NULL;
2207 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
2208 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_GAIN)
2209 gain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2210 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_EXPOSURE)
2211 exposure_ctrl = &gspca_dev->sd_desc->ctrls[i];
2212 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_AUTOGAIN)
2213 autogain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2215 if (!gain_ctrl || !exposure_ctrl || !autogain_ctrl) {
2216 PDEBUG(D_ERR, "Error: gspca_auto_gain_n_exposure called "
2217 "on cam without (auto)gain/exposure");
2221 if (gain_ctrl->get(gspca_dev, &gain) ||
2222 exposure_ctrl->get(gspca_dev, &exposure) ||
2223 autogain_ctrl->get(gspca_dev, &autogain) || !autogain)
2227 orig_exposure = exposure;
2229 /* If we are of a multiple of deadzone, do multiple steps to reach the
2230 desired lumination fast (with the risc of a slight overshoot) */
2231 steps = abs(desired_avg_lum - avg_lum) / deadzone;
2233 PDEBUG(D_FRAM, "autogain: lum: %d, desired: %d, steps: %d",
2234 avg_lum, desired_avg_lum, steps);
2236 for (i = 0; i < steps; i++) {
2237 if (avg_lum > desired_avg_lum) {
2238 if (gain > gain_knee)
2240 else if (exposure > exposure_knee)
2242 else if (gain > gain_ctrl->qctrl.default_value)
2244 else if (exposure > exposure_ctrl->qctrl.minimum)
2246 else if (gain > gain_ctrl->qctrl.minimum)
2251 if (gain < gain_ctrl->qctrl.default_value)
2253 else if (exposure < exposure_knee)
2255 else if (gain < gain_knee)
2257 else if (exposure < exposure_ctrl->qctrl.maximum)
2259 else if (gain < gain_ctrl->qctrl.maximum)
2266 if (gain != orig_gain) {
2267 gain_ctrl->set(gspca_dev, gain);
2270 if (exposure != orig_exposure) {
2271 exposure_ctrl->set(gspca_dev, exposure);
2277 EXPORT_SYMBOL(gspca_auto_gain_n_exposure);
2279 /* -- module insert / remove -- */
2280 static int __init gspca_init(void)
2282 info("main v%d.%d.%d registered",
2283 (DRIVER_VERSION_NUMBER >> 16) & 0xff,
2284 (DRIVER_VERSION_NUMBER >> 8) & 0xff,
2285 DRIVER_VERSION_NUMBER & 0xff);
2288 static void __exit gspca_exit(void)
2290 info("main deregistered");
2293 module_init(gspca_init);
2294 module_exit(gspca_exit);
2297 module_param_named(debug, gspca_debug, int, 0644);
2298 MODULE_PARM_DESC(debug,
2299 "Debug (bit) 0x01:error 0x02:probe 0x04:config"
2300 " 0x08:stream 0x10:frame 0x20:packet 0x40:USBin 0x80:USBout"