2 * Main USB camera driver
4 * V4L2 by Jean-Francois Moine <http://moinejf.free.fr>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
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>
33 #include <linux/kref.h>
35 #include <linux/uaccess.h>
36 #include <linux/jiffies.h>
37 #include <media/v4l2-ioctl.h>
42 #define DEF_NURBS 2 /* default number of URBs */
44 MODULE_AUTHOR("Jean-Francois Moine <http://moinejf.free.fr>");
45 MODULE_DESCRIPTION("GSPCA USB Camera Driver");
46 MODULE_LICENSE("GPL");
48 #define DRIVER_VERSION_NUMBER KERNEL_VERSION(2, 3, 0)
50 static int video_nr = -1;
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 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 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 struct gspca_frame *frame;
130 __u8 *data; /* address of data in the iso message */
134 if (urb->status != 0) {
136 if (!gspca_dev->frozen)
138 PDEBUG(D_ERR|D_PACK, "urb status: %d", urb->status);
139 return; /* disconnection ? */
141 pkt_scan = gspca_dev->sd_desc->pkt_scan;
142 for (i = 0; i < urb->number_of_packets; i++) {
144 /* check the availability of the frame buffer */
145 frame = gspca_get_i_frame(gspca_dev);
147 gspca_dev->last_packet_type = DISCARD_PACKET;
151 /* check the packet status and length */
152 len = urb->iso_frame_desc[i].actual_length;
155 st = urb->iso_frame_desc[i].status;
158 "ISOC data error: [%d] len=%d, status=%d",
160 gspca_dev->last_packet_type = DISCARD_PACKET;
164 /* let the packet be analyzed by the subdriver */
165 PDEBUG(D_PACK, "packet [%d] o:%d l:%d",
166 i, urb->iso_frame_desc[i].offset, len);
167 data = (__u8 *) urb->transfer_buffer
168 + urb->iso_frame_desc[i].offset;
169 pkt_scan(gspca_dev, frame, data, len);
172 /* resubmit the URB */
174 st = usb_submit_urb(urb, GFP_ATOMIC);
176 PDEBUG(D_ERR|D_PACK, "usb_submit_urb() ret %d", st);
180 * ISOC message interrupt from the USB device
182 * Analyse each packet and call the subdriver for copy to the frame buffer.
184 static void isoc_irq(struct urb *urb
187 struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
189 PDEBUG(D_PACK, "isoc irq");
190 if (!gspca_dev->streaming)
192 fill_frame(gspca_dev, urb);
196 * bulk message interrupt from the USB device
198 static void bulk_irq(struct urb *urb
201 struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
202 struct gspca_frame *frame;
204 PDEBUG(D_PACK, "bulk irq");
205 if (!gspca_dev->streaming)
207 if (urb->status != 0 && urb->status != -ECONNRESET) {
209 if (!gspca_dev->frozen)
211 PDEBUG(D_ERR|D_PACK, "urb status: %d", urb->status);
212 return; /* disconnection ? */
215 /* check the availability of the frame buffer */
216 frame = gspca_get_i_frame(gspca_dev);
218 gspca_dev->last_packet_type = DISCARD_PACKET;
220 PDEBUG(D_PACK, "packet l:%d", urb->actual_length);
221 gspca_dev->sd_desc->pkt_scan(gspca_dev,
223 urb->transfer_buffer,
229 * add data to the current frame
231 * This function is called by the subdrivers at interrupt level.
233 * To build a frame, these ones must add
235 * - 0 or many INTER_PACKETs
237 * DISCARD_PACKET invalidates the whole frame.
238 * On LAST_PACKET, a new frame is returned.
240 struct gspca_frame *gspca_frame_add(struct gspca_dev *gspca_dev,
241 enum gspca_packet_type packet_type,
242 struct gspca_frame *frame,
248 PDEBUG(D_PACK, "add t:%d l:%d", packet_type, len);
250 /* when start of a new frame, if the current frame buffer
251 * is not queued, discard the whole frame */
252 if (packet_type == FIRST_PACKET) {
253 if ((frame->v4l2_buf.flags & BUF_ALL_FLAGS)
254 != V4L2_BUF_FLAG_QUEUED) {
255 gspca_dev->last_packet_type = DISCARD_PACKET;
258 frame->data_end = frame->data;
259 jiffies_to_timeval(get_jiffies_64(),
260 &frame->v4l2_buf.timestamp);
261 frame->v4l2_buf.sequence = ++gspca_dev->sequence;
262 } else if (gspca_dev->last_packet_type == DISCARD_PACKET) {
263 if (packet_type == LAST_PACKET)
264 gspca_dev->last_packet_type = packet_type;
268 /* append the packet to the frame buffer */
270 if (frame->data_end - frame->data + len
271 > frame->v4l2_buf.length) {
272 PDEBUG(D_ERR|D_PACK, "frame overflow %zd > %d",
273 frame->data_end - frame->data + len,
274 frame->v4l2_buf.length);
275 packet_type = DISCARD_PACKET;
277 memcpy(frame->data_end, data, len);
278 frame->data_end += len;
281 gspca_dev->last_packet_type = packet_type;
283 /* if last packet, wake up the application and advance in the queue */
284 if (packet_type == LAST_PACKET) {
285 frame->v4l2_buf.bytesused = frame->data_end - frame->data;
286 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_QUEUED;
287 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_DONE;
288 atomic_inc(&gspca_dev->nevent);
289 wake_up_interruptible(&gspca_dev->wq); /* event = new frame */
290 i = (gspca_dev->fr_i + 1) % gspca_dev->nframes;
292 PDEBUG(D_FRAM, "frame complete len:%d q:%d i:%d o:%d",
293 frame->v4l2_buf.bytesused,
297 j = gspca_dev->fr_queue[i];
298 frame = &gspca_dev->frame[j];
302 EXPORT_SYMBOL(gspca_frame_add);
304 static int gspca_is_compressed(__u32 format)
307 case V4L2_PIX_FMT_MJPEG:
308 case V4L2_PIX_FMT_JPEG:
309 case V4L2_PIX_FMT_SPCA561:
310 case V4L2_PIX_FMT_PAC207:
316 static void *rvmalloc(unsigned long size)
321 mem = vmalloc_32(size);
323 adr = (unsigned long) mem;
324 while ((long) size > 0) {
325 SetPageReserved(vmalloc_to_page((void *) adr));
333 static void rvfree(void *mem, long size)
337 adr = (unsigned long) mem;
339 ClearPageReserved(vmalloc_to_page((void *) adr));
346 static int frame_alloc(struct gspca_dev *gspca_dev,
349 struct gspca_frame *frame;
353 i = gspca_dev->curr_mode;
354 frsz = gspca_dev->cam.cam_mode[i].sizeimage;
355 PDEBUG(D_STREAM, "frame alloc frsz: %d", frsz);
356 frsz = PAGE_ALIGN(frsz);
357 gspca_dev->frsz = frsz;
358 if (count > GSPCA_MAX_FRAMES)
359 count = GSPCA_MAX_FRAMES;
360 gspca_dev->frbuf = rvmalloc(frsz * count);
361 if (!gspca_dev->frbuf) {
362 err("frame alloc failed");
365 gspca_dev->nframes = count;
366 for (i = 0; i < count; i++) {
367 frame = &gspca_dev->frame[i];
368 frame->v4l2_buf.index = i;
369 frame->v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
370 frame->v4l2_buf.flags = 0;
371 frame->v4l2_buf.field = V4L2_FIELD_NONE;
372 frame->v4l2_buf.length = frsz;
373 frame->v4l2_buf.memory = gspca_dev->memory;
374 frame->v4l2_buf.sequence = 0;
375 frame->data = frame->data_end =
376 gspca_dev->frbuf + i * frsz;
377 frame->v4l2_buf.m.offset = i * frsz;
379 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
380 gspca_dev->last_packet_type = DISCARD_PACKET;
381 gspca_dev->sequence = 0;
382 atomic_set(&gspca_dev->nevent, 0);
386 static void frame_free(struct gspca_dev *gspca_dev)
390 PDEBUG(D_STREAM, "frame free");
391 if (gspca_dev->frbuf != NULL) {
392 rvfree(gspca_dev->frbuf,
393 gspca_dev->nframes * gspca_dev->frsz);
394 gspca_dev->frbuf = NULL;
395 for (i = 0; i < gspca_dev->nframes; i++)
396 gspca_dev->frame[i].data = NULL;
398 gspca_dev->nframes = 0;
401 static void destroy_urbs(struct gspca_dev *gspca_dev)
406 PDEBUG(D_STREAM, "kill transfer");
407 for (i = 0; i < MAX_NURBS; i++) {
408 urb = gspca_dev->urb[i];
412 gspca_dev->urb[i] = NULL;
414 if (urb->transfer_buffer != NULL)
415 usb_buffer_free(gspca_dev->dev,
416 urb->transfer_buffer_length,
417 urb->transfer_buffer,
424 * look for an input transfer endpoint in an alternate setting
426 static struct usb_host_endpoint *alt_xfer(struct usb_host_interface *alt,
430 struct usb_host_endpoint *ep;
433 epaddr |= USB_DIR_IN;
434 for (i = 0; i < alt->desc.bNumEndpoints; i++) {
435 ep = &alt->endpoint[i];
436 if (ep->desc.bEndpointAddress == epaddr) {
437 attr = ep->desc.bmAttributes
438 & USB_ENDPOINT_XFERTYPE_MASK;
448 * look for an input (isoc or bulk) endpoint
450 * The endpoint is defined by the subdriver.
451 * Use only the first isoc (some Zoran - 0x0572:0x0001 - have two such ep).
452 * This routine may be called many times when the bandwidth is too small
453 * (the bandwidth is checked on urb submit).
455 static struct usb_host_endpoint *get_ep(struct gspca_dev *gspca_dev)
457 struct usb_interface *intf;
458 struct usb_host_endpoint *ep;
461 intf = usb_ifnum_to_if(gspca_dev->dev, gspca_dev->iface);
463 i = gspca_dev->alt; /* previous alt setting */
466 while (--i > 0) { /* alt 0 is unusable */
467 ep = alt_xfer(&intf->altsetting[i],
468 gspca_dev->cam.epaddr,
469 USB_ENDPOINT_XFER_ISOC);
474 /* if no isoc, try bulk */
476 ep = alt_xfer(&intf->altsetting[0],
477 gspca_dev->cam.epaddr,
478 USB_ENDPOINT_XFER_BULK);
480 err("no transfer endpoint found");
484 PDEBUG(D_STREAM, "use alt %d ep 0x%02x",
485 i, ep->desc.bEndpointAddress);
487 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, i);
489 err("set interface err %d", ret);
493 gspca_dev->alt = i; /* memorize the current alt setting */
498 * create the URBs for image transfer
500 static int create_urbs(struct gspca_dev *gspca_dev,
501 struct usb_host_endpoint *ep)
504 int n, nurbs, i, psize, npkt, bsize;
506 /* calculate the packet size and the number of packets */
507 psize = le16_to_cpu(ep->desc.wMaxPacketSize);
509 if (gspca_dev->alt != 0) { /* isoc */
511 /* See paragraph 5.9 / table 5-11 of the usb 2.0 spec. */
512 psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
513 npkt = ISO_MAX_SIZE / psize;
514 if (npkt > ISO_MAX_PKT)
516 bsize = psize * npkt;
518 "isoc %d pkts size %d = bsize:%d",
523 bsize = gspca_dev->cam. bulk_size;
526 PDEBUG(D_STREAM, "bulk bsize:%d", bsize);
530 gspca_dev->nurbs = nurbs;
531 for (n = 0; n < nurbs; n++) {
532 urb = usb_alloc_urb(npkt, GFP_KERNEL);
534 err("usb_alloc_urb failed");
535 destroy_urbs(gspca_dev);
538 urb->transfer_buffer = usb_buffer_alloc(gspca_dev->dev,
543 if (urb->transfer_buffer == NULL) {
545 err("usb_buffer_urb failed");
546 destroy_urbs(gspca_dev);
549 gspca_dev->urb[n] = urb;
550 urb->dev = gspca_dev->dev;
551 urb->context = gspca_dev;
552 urb->transfer_buffer_length = bsize;
553 if (npkt != 0) { /* ISOC */
554 urb->pipe = usb_rcvisocpipe(gspca_dev->dev,
555 ep->desc.bEndpointAddress);
556 urb->transfer_flags = URB_ISO_ASAP
557 | URB_NO_TRANSFER_DMA_MAP;
558 urb->interval = ep->desc.bInterval;
559 urb->complete = isoc_irq;
560 urb->number_of_packets = npkt;
561 for (i = 0; i < npkt; i++) {
562 urb->iso_frame_desc[i].length = psize;
563 urb->iso_frame_desc[i].offset = psize * i;
566 urb->pipe = usb_rcvbulkpipe(gspca_dev->dev,
567 ep->desc.bEndpointAddress),
568 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
569 urb->complete = bulk_irq;
576 * start the USB transfer
578 static int gspca_init_transfer(struct gspca_dev *gspca_dev)
580 struct usb_host_endpoint *ep;
583 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
586 /* set the higher alternate setting and
587 * loop until urb submit succeeds */
588 gspca_dev->alt = gspca_dev->nbalt;
590 PDEBUG(D_STREAM, "init transfer alt %d", gspca_dev->alt);
591 ep = get_ep(gspca_dev);
596 ret = create_urbs(gspca_dev, ep);
600 /* clear the bulk endpoint */
601 if (gspca_dev->alt == 0) /* if bulk transfer */
602 usb_clear_halt(gspca_dev->dev,
603 usb_rcvintpipe(gspca_dev->dev,
604 gspca_dev->cam.epaddr));
607 ret = gspca_dev->sd_desc->start(gspca_dev);
609 destroy_urbs(gspca_dev);
612 gspca_dev->streaming = 1;
613 atomic_set(&gspca_dev->nevent, 0);
615 /* bulk transfers are started by the subdriver */
616 if (gspca_dev->alt == 0)
619 /* submit the URBs */
620 for (n = 0; n < gspca_dev->nurbs; n++) {
621 ret = usb_submit_urb(gspca_dev->urb[n], GFP_KERNEL);
623 PDEBUG(D_ERR|D_STREAM,
624 "usb_submit_urb [%d] err %d", n, ret);
625 gspca_dev->streaming = 0;
626 destroy_urbs(gspca_dev);
628 break; /* try the previous alt */
636 mutex_unlock(&gspca_dev->usb_lock);
640 static int gspca_set_alt0(struct gspca_dev *gspca_dev)
644 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, 0);
646 PDEBUG(D_ERR|D_STREAM, "set interface 0 err %d", ret);
650 /* Note: both the queue and the usb locks should be held when calling this */
651 static void gspca_stream_off(struct gspca_dev *gspca_dev)
653 gspca_dev->streaming = 0;
654 atomic_set(&gspca_dev->nevent, 0);
655 if (gspca_dev->present
656 && gspca_dev->sd_desc->stopN)
657 gspca_dev->sd_desc->stopN(gspca_dev);
658 destroy_urbs(gspca_dev);
659 gspca_set_alt0(gspca_dev);
660 if (gspca_dev->sd_desc->stop0)
661 gspca_dev->sd_desc->stop0(gspca_dev);
662 PDEBUG(D_STREAM, "stream off OK");
665 static void gspca_set_default_mode(struct gspca_dev *gspca_dev)
669 i = gspca_dev->cam.nmodes - 1; /* take the highest mode */
670 gspca_dev->curr_mode = i;
671 gspca_dev->width = gspca_dev->cam.cam_mode[i].width;
672 gspca_dev->height = gspca_dev->cam.cam_mode[i].height;
673 gspca_dev->pixfmt = gspca_dev->cam.cam_mode[i].pixelformat;
676 static int wxh_to_mode(struct gspca_dev *gspca_dev,
677 int width, int height)
681 for (i = gspca_dev->cam.nmodes; --i > 0; ) {
682 if (width >= gspca_dev->cam.cam_mode[i].width
683 && height >= gspca_dev->cam.cam_mode[i].height)
690 * search a mode with the right pixel format
692 static int gspca_get_mode(struct gspca_dev *gspca_dev,
698 modeU = modeD = mode;
699 while ((modeU < gspca_dev->cam.nmodes) || modeD >= 0) {
701 if (gspca_dev->cam.cam_mode[modeD].pixelformat
705 if (++modeU < gspca_dev->cam.nmodes) {
706 if (gspca_dev->cam.cam_mode[modeU].pixelformat
714 static int vidioc_enum_fmt_vid_cap(struct file *file, void *priv,
715 struct v4l2_fmtdesc *fmtdesc)
717 struct gspca_dev *gspca_dev = priv;
721 /* give an index to each format */
724 for (i = gspca_dev->cam.nmodes; --i >= 0; ) {
725 fmt_tb[index] = gspca_dev->cam.cam_mode[i].pixelformat;
728 if (fmt_tb[j] == fmt_tb[index])
733 if (fmtdesc->index == index)
734 break; /* new format */
736 if (index >= sizeof fmt_tb / sizeof fmt_tb[0])
741 return -EINVAL; /* no more format */
743 fmtdesc->pixelformat = fmt_tb[index];
744 if (gspca_is_compressed(fmt_tb[index]))
745 fmtdesc->flags = V4L2_FMT_FLAG_COMPRESSED;
746 fmtdesc->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
747 fmtdesc->description[0] = fmtdesc->pixelformat & 0xff;
748 fmtdesc->description[1] = (fmtdesc->pixelformat >> 8) & 0xff;
749 fmtdesc->description[2] = (fmtdesc->pixelformat >> 16) & 0xff;
750 fmtdesc->description[3] = fmtdesc->pixelformat >> 24;
751 fmtdesc->description[4] = '\0';
755 static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
756 struct v4l2_format *fmt)
758 struct gspca_dev *gspca_dev = priv;
761 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
763 mode = gspca_dev->curr_mode;
764 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
765 sizeof fmt->fmt.pix);
769 static int try_fmt_vid_cap(struct gspca_dev *gspca_dev,
770 struct v4l2_format *fmt)
772 int w, h, mode, mode2;
774 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
776 w = fmt->fmt.pix.width;
777 h = fmt->fmt.pix.height;
780 if (gspca_debug & D_CONF)
781 PDEBUG_MODE("try fmt cap", fmt->fmt.pix.pixelformat, w, h);
783 /* search the closest mode for width and height */
784 mode = wxh_to_mode(gspca_dev, w, h);
786 /* OK if right palette */
787 if (gspca_dev->cam.cam_mode[mode].pixelformat
788 != fmt->fmt.pix.pixelformat) {
790 /* else, search the closest mode with the same pixel format */
791 mode2 = gspca_get_mode(gspca_dev, mode,
792 fmt->fmt.pix.pixelformat);
796 ; * no chance, return this mode */
798 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
799 sizeof fmt->fmt.pix);
800 return mode; /* used when s_fmt */
803 static int vidioc_try_fmt_vid_cap(struct file *file,
805 struct v4l2_format *fmt)
807 struct gspca_dev *gspca_dev = priv;
810 ret = try_fmt_vid_cap(gspca_dev, fmt);
816 static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
817 struct v4l2_format *fmt)
819 struct gspca_dev *gspca_dev = priv;
822 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
825 ret = try_fmt_vid_cap(gspca_dev, fmt);
829 if (gspca_dev->nframes != 0
830 && fmt->fmt.pix.sizeimage > gspca_dev->frsz) {
835 if (ret == gspca_dev->curr_mode) {
837 goto out; /* same mode */
840 if (gspca_dev->streaming) {
844 gspca_dev->width = fmt->fmt.pix.width;
845 gspca_dev->height = fmt->fmt.pix.height;
846 gspca_dev->pixfmt = fmt->fmt.pix.pixelformat;
847 gspca_dev->curr_mode = ret;
851 mutex_unlock(&gspca_dev->queue_lock);
855 static void gspca_delete(struct kref *kref)
857 struct gspca_dev *gspca_dev = container_of(kref, struct gspca_dev, kref);
859 PDEBUG(D_STREAM, "device deleted");
861 kfree(gspca_dev->usb_buf);
865 static int dev_open(struct inode *inode, struct file *file)
867 struct gspca_dev *gspca_dev;
870 PDEBUG(D_STREAM, "%s open", current->comm);
871 gspca_dev = (struct gspca_dev *) video_devdata(file);
872 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
874 if (!gspca_dev->present) {
879 if (gspca_dev->users > 4) { /* (arbitrary value) */
884 /* protect the subdriver against rmmod */
885 if (!try_module_get(gspca_dev->module)) {
893 kref_get(&gspca_dev->kref);
895 file->private_data = gspca_dev;
897 /* activate the v4l2 debug */
898 if (gspca_debug & D_V4L2)
899 gspca_dev->vdev.debug |= V4L2_DEBUG_IOCTL
900 | V4L2_DEBUG_IOCTL_ARG;
902 gspca_dev->vdev.debug &= ~(V4L2_DEBUG_IOCTL
903 | V4L2_DEBUG_IOCTL_ARG);
907 mutex_unlock(&gspca_dev->queue_lock);
909 PDEBUG(D_ERR|D_STREAM, "open failed err %d", ret);
911 PDEBUG(D_STREAM, "open done");
915 static int dev_close(struct inode *inode, struct file *file)
917 struct gspca_dev *gspca_dev = file->private_data;
919 PDEBUG(D_STREAM, "%s close", current->comm);
920 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
924 /* if the file did the capture, free the streaming resources */
925 if (gspca_dev->capt_file == file) {
926 if (gspca_dev->streaming) {
927 mutex_lock(&gspca_dev->usb_lock);
928 gspca_stream_off(gspca_dev);
929 mutex_unlock(&gspca_dev->usb_lock);
931 frame_free(gspca_dev);
932 gspca_dev->capt_file = NULL;
933 gspca_dev->memory = GSPCA_MEMORY_NO;
935 file->private_data = NULL;
936 module_put(gspca_dev->module);
937 mutex_unlock(&gspca_dev->queue_lock);
939 PDEBUG(D_STREAM, "close done");
941 kref_put(&gspca_dev->kref, gspca_delete);
946 static int vidioc_querycap(struct file *file, void *priv,
947 struct v4l2_capability *cap)
949 struct gspca_dev *gspca_dev = priv;
951 memset(cap, 0, sizeof *cap);
952 strncpy(cap->driver, gspca_dev->sd_desc->name, sizeof cap->driver);
953 if (gspca_dev->dev->product != NULL) {
954 strncpy(cap->card, gspca_dev->dev->product,
957 snprintf(cap->card, sizeof cap->card,
958 "USB Camera (%04x:%04x)",
959 le16_to_cpu(gspca_dev->dev->descriptor.idVendor),
960 le16_to_cpu(gspca_dev->dev->descriptor.idProduct));
962 strncpy(cap->bus_info, gspca_dev->dev->bus->bus_name,
963 sizeof cap->bus_info);
964 cap->version = DRIVER_VERSION_NUMBER;
965 cap->capabilities = V4L2_CAP_VIDEO_CAPTURE
967 | V4L2_CAP_READWRITE;
971 static int vidioc_queryctrl(struct file *file, void *priv,
972 struct v4l2_queryctrl *q_ctrl)
974 struct gspca_dev *gspca_dev = priv;
980 if (id & V4L2_CTRL_FLAG_NEXT_CTRL) {
981 id &= V4L2_CTRL_ID_MASK;
983 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
984 if (gspca_dev->sd_desc->ctrls[i].qctrl.id < id)
990 if (gspca_dev->sd_desc->ctrls[i].qctrl.id
991 > gspca_dev->sd_desc->ctrls[ix].qctrl.id)
996 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
997 if (id == gspca_dev->sd_desc->ctrls[i].qctrl.id) {
1004 memcpy(q_ctrl, &gspca_dev->sd_desc->ctrls[ix].qctrl,
1006 if (gspca_dev->ctrl_dis & (1 << ix))
1007 q_ctrl->flags |= V4L2_CTRL_FLAG_DISABLED;
1011 static int vidioc_s_ctrl(struct file *file, void *priv,
1012 struct v4l2_control *ctrl)
1014 struct gspca_dev *gspca_dev = priv;
1015 const struct ctrl *ctrls;
1018 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
1019 i < gspca_dev->sd_desc->nctrls;
1021 if (ctrl->id != ctrls->qctrl.id)
1023 if (gspca_dev->ctrl_dis & (1 << i))
1025 if (ctrl->value < ctrls->qctrl.minimum
1026 || ctrl->value > ctrls->qctrl.maximum)
1028 PDEBUG(D_CONF, "set ctrl [%08x] = %d", ctrl->id, ctrl->value);
1029 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1030 return -ERESTARTSYS;
1031 ret = ctrls->set(gspca_dev, ctrl->value);
1032 mutex_unlock(&gspca_dev->usb_lock);
1038 static int vidioc_g_ctrl(struct file *file, void *priv,
1039 struct v4l2_control *ctrl)
1041 struct gspca_dev *gspca_dev = priv;
1043 const struct ctrl *ctrls;
1046 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
1047 i < gspca_dev->sd_desc->nctrls;
1049 if (ctrl->id != ctrls->qctrl.id)
1051 if (gspca_dev->ctrl_dis & (1 << i))
1053 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1054 return -ERESTARTSYS;
1055 ret = ctrls->get(gspca_dev, &ctrl->value);
1056 mutex_unlock(&gspca_dev->usb_lock);
1062 static int vidioc_querymenu(struct file *file, void *priv,
1063 struct v4l2_querymenu *qmenu)
1065 struct gspca_dev *gspca_dev = priv;
1067 if (!gspca_dev->sd_desc->querymenu)
1069 return gspca_dev->sd_desc->querymenu(gspca_dev, qmenu);
1072 static int vidioc_enum_input(struct file *file, void *priv,
1073 struct v4l2_input *input)
1075 struct gspca_dev *gspca_dev = priv;
1077 if (input->index != 0)
1079 memset(input, 0, sizeof *input);
1080 input->type = V4L2_INPUT_TYPE_CAMERA;
1081 strncpy(input->name, gspca_dev->sd_desc->name,
1082 sizeof input->name);
1086 static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
1092 static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
1099 static int vidioc_reqbufs(struct file *file, void *priv,
1100 struct v4l2_requestbuffers *rb)
1102 struct gspca_dev *gspca_dev = priv;
1105 if (rb->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1107 switch (rb->memory) {
1108 case GSPCA_MEMORY_READ: /* (internal call) */
1109 case V4L2_MEMORY_MMAP:
1110 case V4L2_MEMORY_USERPTR:
1115 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1116 return -ERESTARTSYS;
1118 if (gspca_dev->memory != GSPCA_MEMORY_NO
1119 && gspca_dev->memory != rb->memory) {
1124 /* only one file may do the capture */
1125 if (gspca_dev->capt_file != NULL
1126 && gspca_dev->capt_file != file) {
1131 /* if allocated, the buffers must not be mapped */
1132 for (i = 0; i < gspca_dev->nframes; i++) {
1133 if (gspca_dev->frame[i].vma_use_count) {
1139 /* stop streaming */
1140 if (gspca_dev->streaming) {
1141 mutex_lock(&gspca_dev->usb_lock);
1142 gspca_stream_off(gspca_dev);
1143 mutex_unlock(&gspca_dev->usb_lock);
1146 /* free the previous allocated buffers, if any */
1147 if (gspca_dev->nframes != 0) {
1148 frame_free(gspca_dev);
1149 gspca_dev->capt_file = NULL;
1151 if (rb->count == 0) /* unrequest */
1153 gspca_dev->memory = rb->memory;
1154 ret = frame_alloc(gspca_dev, rb->count);
1156 rb->count = gspca_dev->nframes;
1157 gspca_dev->capt_file = file;
1160 mutex_unlock(&gspca_dev->queue_lock);
1161 PDEBUG(D_STREAM, "reqbufs st:%d c:%d", ret, rb->count);
1165 static int vidioc_querybuf(struct file *file, void *priv,
1166 struct v4l2_buffer *v4l2_buf)
1168 struct gspca_dev *gspca_dev = priv;
1169 struct gspca_frame *frame;
1171 if (v4l2_buf->type != V4L2_BUF_TYPE_VIDEO_CAPTURE
1172 || v4l2_buf->index < 0
1173 || v4l2_buf->index >= gspca_dev->nframes)
1176 frame = &gspca_dev->frame[v4l2_buf->index];
1177 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1181 static int vidioc_streamon(struct file *file, void *priv,
1182 enum v4l2_buf_type buf_type)
1184 struct gspca_dev *gspca_dev = priv;
1187 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1189 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1190 return -ERESTARTSYS;
1191 if (!gspca_dev->present) {
1195 if (gspca_dev->nframes == 0) {
1199 if (!gspca_dev->streaming) {
1200 ret = gspca_init_transfer(gspca_dev);
1205 if (gspca_debug & D_STREAM) {
1206 PDEBUG_MODE("stream on OK",
1214 mutex_unlock(&gspca_dev->queue_lock);
1218 static int vidioc_streamoff(struct file *file, void *priv,
1219 enum v4l2_buf_type buf_type)
1221 struct gspca_dev *gspca_dev = priv;
1224 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1226 if (!gspca_dev->streaming)
1228 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1229 return -ERESTARTSYS;
1231 /* stop streaming */
1232 if (mutex_lock_interruptible(&gspca_dev->usb_lock)) {
1236 gspca_stream_off(gspca_dev);
1237 mutex_unlock(&gspca_dev->usb_lock);
1239 /* empty the application queues */
1240 for (i = 0; i < gspca_dev->nframes; i++)
1241 gspca_dev->frame[i].v4l2_buf.flags &= ~BUF_ALL_FLAGS;
1242 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
1243 gspca_dev->last_packet_type = DISCARD_PACKET;
1244 gspca_dev->sequence = 0;
1245 atomic_set(&gspca_dev->nevent, 0);
1248 mutex_unlock(&gspca_dev->queue_lock);
1252 static int vidioc_g_jpegcomp(struct file *file, void *priv,
1253 struct v4l2_jpegcompression *jpegcomp)
1255 struct gspca_dev *gspca_dev = priv;
1258 if (!gspca_dev->sd_desc->get_jcomp)
1260 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1261 return -ERESTARTSYS;
1262 ret = gspca_dev->sd_desc->get_jcomp(gspca_dev, jpegcomp);
1263 mutex_unlock(&gspca_dev->usb_lock);
1267 static int vidioc_s_jpegcomp(struct file *file, void *priv,
1268 struct v4l2_jpegcompression *jpegcomp)
1270 struct gspca_dev *gspca_dev = priv;
1273 if (!gspca_dev->sd_desc->set_jcomp)
1275 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1276 return -ERESTARTSYS;
1277 ret = gspca_dev->sd_desc->set_jcomp(gspca_dev, jpegcomp);
1278 mutex_unlock(&gspca_dev->usb_lock);
1282 static int vidioc_g_parm(struct file *filp, void *priv,
1283 struct v4l2_streamparm *parm)
1285 struct gspca_dev *gspca_dev = priv;
1287 memset(parm, 0, sizeof *parm);
1288 parm->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1289 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1293 static int vidioc_s_parm(struct file *filp, void *priv,
1294 struct v4l2_streamparm *parm)
1296 struct gspca_dev *gspca_dev = priv;
1299 n = parm->parm.capture.readbuffers;
1300 if (n == 0 || n > GSPCA_MAX_FRAMES)
1301 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1303 gspca_dev->nbufread = n;
1307 static int vidioc_s_std(struct file *filp, void *priv,
1313 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1314 static int vidiocgmbuf(struct file *file, void *priv,
1315 struct video_mbuf *mbuf)
1317 struct gspca_dev *gspca_dev = file->private_data;
1320 PDEBUG(D_STREAM, "cgmbuf");
1321 if (gspca_dev->nframes == 0) {
1325 struct v4l2_format fmt;
1327 memset(&fmt, 0, sizeof fmt);
1328 fmt.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1329 i = gspca_dev->cam.nmodes - 1; /* highest mode */
1330 fmt.fmt.pix.width = gspca_dev->cam.cam_mode[i].width;
1331 fmt.fmt.pix.height = gspca_dev->cam.cam_mode[i].height;
1332 fmt.fmt.pix.pixelformat = V4L2_PIX_FMT_BGR24;
1333 ret = vidioc_s_fmt_vid_cap(file, priv, &fmt);
1338 struct v4l2_requestbuffers rb;
1340 memset(&rb, 0, sizeof rb);
1342 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1343 rb.memory = V4L2_MEMORY_MMAP;
1344 ret = vidioc_reqbufs(file, priv, &rb);
1349 mbuf->frames = gspca_dev->nframes;
1350 mbuf->size = gspca_dev->frsz * gspca_dev->nframes;
1351 for (i = 0; i < mbuf->frames; i++)
1352 mbuf->offsets[i] = gspca_dev->frame[i].v4l2_buf.m.offset;
1357 static int dev_mmap(struct file *file, struct vm_area_struct *vma)
1359 struct gspca_dev *gspca_dev = file->private_data;
1360 struct gspca_frame *frame;
1362 unsigned long addr, start, size;
1365 start = vma->vm_start;
1366 size = vma->vm_end - vma->vm_start;
1367 PDEBUG(D_STREAM, "mmap start:%08x size:%d", (int) start, (int) size);
1369 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1370 return -ERESTARTSYS;
1371 if (!gspca_dev->present) {
1375 if (gspca_dev->capt_file != file) {
1381 for (i = 0; i < gspca_dev->nframes; ++i) {
1382 if (gspca_dev->frame[i].v4l2_buf.memory != V4L2_MEMORY_MMAP) {
1383 PDEBUG(D_STREAM, "mmap bad memory type");
1386 if ((gspca_dev->frame[i].v4l2_buf.m.offset >> PAGE_SHIFT)
1388 frame = &gspca_dev->frame[i];
1392 if (frame == NULL) {
1393 PDEBUG(D_STREAM, "mmap no frame buffer found");
1397 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1398 /* v4l1 maps all the buffers */
1400 || size != frame->v4l2_buf.length * gspca_dev->nframes)
1402 if (size != frame->v4l2_buf.length) {
1403 PDEBUG(D_STREAM, "mmap bad size");
1409 * - VM_IO marks the area as being a mmaped region for I/O to a
1410 * device. It also prevents the region from being core dumped.
1412 vma->vm_flags |= VM_IO;
1414 addr = (unsigned long) frame->data;
1416 page = vmalloc_to_page((void *) addr);
1417 ret = vm_insert_page(vma, start, page);
1425 vma->vm_ops = &gspca_vm_ops;
1426 vma->vm_private_data = frame;
1430 mutex_unlock(&gspca_dev->queue_lock);
1435 * wait for a video frame
1437 * If a frame is ready, its index is returned.
1439 static int frame_wait(struct gspca_dev *gspca_dev,
1442 struct gspca_frame *frame;
1445 /* check if a frame is ready */
1446 i = gspca_dev->fr_o;
1447 j = gspca_dev->fr_queue[i];
1448 frame = &gspca_dev->frame[j];
1449 if (frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE) {
1450 atomic_dec(&gspca_dev->nevent);
1453 if (nonblock_ing) /* no frame yet */
1456 /* wait till a frame is ready */
1458 ret = wait_event_interruptible_timeout(gspca_dev->wq,
1459 atomic_read(&gspca_dev->nevent) > 0,
1460 msecs_to_jiffies(3000));
1463 return ret; /* interrupt */
1464 return -EIO; /* timeout */
1466 atomic_dec(&gspca_dev->nevent);
1467 if (!gspca_dev->streaming || !gspca_dev->present)
1469 i = gspca_dev->fr_o;
1470 j = gspca_dev->fr_queue[i];
1471 frame = &gspca_dev->frame[j];
1472 if (frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE)
1476 gspca_dev->fr_o = (i + 1) % gspca_dev->nframes;
1477 PDEBUG(D_FRAM, "frame wait q:%d i:%d o:%d",
1482 if (gspca_dev->sd_desc->dq_callback) {
1483 mutex_lock(&gspca_dev->usb_lock);
1484 gspca_dev->sd_desc->dq_callback(gspca_dev);
1485 mutex_unlock(&gspca_dev->usb_lock);
1491 * dequeue a video buffer
1493 * If nonblock_ing is false, block until a buffer is available.
1495 static int vidioc_dqbuf(struct file *file, void *priv,
1496 struct v4l2_buffer *v4l2_buf)
1498 struct gspca_dev *gspca_dev = priv;
1499 struct gspca_frame *frame;
1502 PDEBUG(D_FRAM, "dqbuf");
1503 if (v4l2_buf->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1505 if (v4l2_buf->memory != gspca_dev->memory)
1508 /* if not streaming, be sure the application will not loop forever */
1509 if (!(file->f_flags & O_NONBLOCK)
1510 && !gspca_dev->streaming && gspca_dev->users == 1)
1513 /* only the capturing file may dequeue */
1514 if (gspca_dev->capt_file != file)
1517 /* only one dequeue / read at a time */
1518 if (mutex_lock_interruptible(&gspca_dev->read_lock))
1519 return -ERESTARTSYS;
1521 ret = frame_wait(gspca_dev, file->f_flags & O_NONBLOCK);
1524 i = ret; /* frame index */
1525 frame = &gspca_dev->frame[i];
1526 if (gspca_dev->memory == V4L2_MEMORY_USERPTR) {
1527 if (copy_to_user((__u8 __user *) frame->v4l2_buf.m.userptr,
1529 frame->v4l2_buf.bytesused)) {
1530 PDEBUG(D_ERR|D_STREAM,
1531 "dqbuf cp to user failed");
1536 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_DONE;
1537 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1538 PDEBUG(D_FRAM, "dqbuf %d", i);
1541 mutex_unlock(&gspca_dev->read_lock);
1546 * queue a video buffer
1548 * Attempting to queue a buffer that has already been
1549 * queued will return -EINVAL.
1551 static int vidioc_qbuf(struct file *file, void *priv,
1552 struct v4l2_buffer *v4l2_buf)
1554 struct gspca_dev *gspca_dev = priv;
1555 struct gspca_frame *frame;
1558 PDEBUG(D_FRAM, "qbuf %d", v4l2_buf->index);
1559 if (v4l2_buf->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1562 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1563 return -ERESTARTSYS;
1565 index = v4l2_buf->index;
1566 if ((unsigned) index >= gspca_dev->nframes) {
1568 "qbuf idx %d >= %d", index, gspca_dev->nframes);
1572 if (v4l2_buf->memory != gspca_dev->memory) {
1573 PDEBUG(D_FRAM, "qbuf bad memory type");
1578 frame = &gspca_dev->frame[index];
1579 if (frame->v4l2_buf.flags & BUF_ALL_FLAGS) {
1580 PDEBUG(D_FRAM, "qbuf bad state");
1585 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_QUEUED;
1587 if (frame->v4l2_buf.memory == V4L2_MEMORY_USERPTR) {
1588 frame->v4l2_buf.m.userptr = v4l2_buf->m.userptr;
1589 frame->v4l2_buf.length = v4l2_buf->length;
1592 /* put the buffer in the 'queued' queue */
1593 i = gspca_dev->fr_q;
1594 gspca_dev->fr_queue[i] = index;
1595 gspca_dev->fr_q = (i + 1) % gspca_dev->nframes;
1596 PDEBUG(D_FRAM, "qbuf q:%d i:%d o:%d",
1601 v4l2_buf->flags |= V4L2_BUF_FLAG_QUEUED;
1602 v4l2_buf->flags &= ~V4L2_BUF_FLAG_DONE;
1605 mutex_unlock(&gspca_dev->queue_lock);
1610 * allocate the resources for read()
1612 static int read_alloc(struct gspca_dev *gspca_dev,
1615 struct v4l2_buffer v4l2_buf;
1618 PDEBUG(D_STREAM, "read alloc");
1619 if (gspca_dev->nframes == 0) {
1620 struct v4l2_requestbuffers rb;
1622 memset(&rb, 0, sizeof rb);
1623 rb.count = gspca_dev->nbufread;
1624 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1625 rb.memory = GSPCA_MEMORY_READ;
1626 ret = vidioc_reqbufs(file, gspca_dev, &rb);
1628 PDEBUG(D_STREAM, "read reqbuf err %d", ret);
1631 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1632 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1633 v4l2_buf.memory = GSPCA_MEMORY_READ;
1634 for (i = 0; i < gspca_dev->nbufread; i++) {
1636 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1638 PDEBUG(D_STREAM, "read qbuf err: %d", ret);
1642 gspca_dev->memory = GSPCA_MEMORY_READ;
1645 /* start streaming */
1646 ret = vidioc_streamon(file, gspca_dev, V4L2_BUF_TYPE_VIDEO_CAPTURE);
1648 PDEBUG(D_STREAM, "read streamon err %d", ret);
1652 static unsigned int dev_poll(struct file *file, poll_table *wait)
1654 struct gspca_dev *gspca_dev = file->private_data;
1657 PDEBUG(D_FRAM, "poll");
1659 poll_wait(file, &gspca_dev->wq, wait);
1660 if (!gspca_dev->present)
1663 /* if reqbufs is not done, the user would use read() */
1664 if (gspca_dev->nframes == 0) {
1665 if (gspca_dev->memory != GSPCA_MEMORY_NO)
1666 return POLLERR; /* not the 1st time */
1667 ret = read_alloc(gspca_dev, file);
1672 if (mutex_lock_interruptible(&gspca_dev->queue_lock) != 0)
1674 if (!gspca_dev->present) {
1679 /* check the next incoming buffer */
1680 i = gspca_dev->fr_o;
1681 i = gspca_dev->fr_queue[i];
1682 if (gspca_dev->frame[i].v4l2_buf.flags & V4L2_BUF_FLAG_DONE)
1683 ret = POLLIN | POLLRDNORM; /* something to read */
1687 mutex_unlock(&gspca_dev->queue_lock);
1691 static ssize_t dev_read(struct file *file, char __user *data,
1692 size_t count, loff_t *ppos)
1694 struct gspca_dev *gspca_dev = file->private_data;
1695 struct gspca_frame *frame;
1696 struct v4l2_buffer v4l2_buf;
1697 struct timeval timestamp;
1700 PDEBUG(D_FRAM, "read (%zd)", count);
1701 if (!gspca_dev->present)
1703 switch (gspca_dev->memory) {
1704 case GSPCA_MEMORY_NO: /* first time */
1705 ret = read_alloc(gspca_dev, file);
1709 case GSPCA_MEMORY_READ:
1710 if (gspca_dev->capt_file == file)
1718 jiffies_to_timeval(get_jiffies_64(), ×tamp);
1722 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1723 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1724 v4l2_buf.memory = GSPCA_MEMORY_READ;
1725 ret = vidioc_dqbuf(file, gspca_dev, &v4l2_buf);
1727 PDEBUG(D_STREAM, "read dqbuf err %d", ret);
1731 /* if the process slept for more than 1 second,
1732 * get a newer frame */
1733 frame = &gspca_dev->frame[v4l2_buf.index];
1735 break; /* avoid infinite loop */
1736 if (frame->v4l2_buf.timestamp.tv_sec >= timestamp.tv_sec)
1738 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1740 PDEBUG(D_STREAM, "read qbuf err %d", ret);
1745 /* copy the frame */
1746 if (count > frame->v4l2_buf.bytesused)
1747 count = frame->v4l2_buf.bytesused;
1748 ret = copy_to_user(data, frame->data, count);
1750 PDEBUG(D_ERR|D_STREAM,
1751 "read cp to user lack %d / %zd", ret, count);
1757 /* in each case, requeue the buffer */
1758 ret2 = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1764 static struct file_operations dev_fops = {
1765 .owner = THIS_MODULE,
1767 .release = dev_close,
1770 .ioctl = video_ioctl2,
1771 #ifdef CONFIG_COMPAT
1772 .compat_ioctl = v4l_compat_ioctl32,
1774 .llseek = no_llseek,
1778 static const struct v4l2_ioctl_ops dev_ioctl_ops = {
1779 .vidioc_querycap = vidioc_querycap,
1780 .vidioc_dqbuf = vidioc_dqbuf,
1781 .vidioc_qbuf = vidioc_qbuf,
1782 .vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
1783 .vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
1784 .vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
1785 .vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
1786 .vidioc_streamon = vidioc_streamon,
1787 .vidioc_queryctrl = vidioc_queryctrl,
1788 .vidioc_g_ctrl = vidioc_g_ctrl,
1789 .vidioc_s_ctrl = vidioc_s_ctrl,
1790 .vidioc_querymenu = vidioc_querymenu,
1791 .vidioc_enum_input = vidioc_enum_input,
1792 .vidioc_g_input = vidioc_g_input,
1793 .vidioc_s_input = vidioc_s_input,
1794 .vidioc_reqbufs = vidioc_reqbufs,
1795 .vidioc_querybuf = vidioc_querybuf,
1796 .vidioc_streamoff = vidioc_streamoff,
1797 .vidioc_g_jpegcomp = vidioc_g_jpegcomp,
1798 .vidioc_s_jpegcomp = vidioc_s_jpegcomp,
1799 .vidioc_g_parm = vidioc_g_parm,
1800 .vidioc_s_parm = vidioc_s_parm,
1801 .vidioc_s_std = vidioc_s_std,
1802 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1803 .vidiocgmbuf = vidiocgmbuf,
1807 static struct video_device gspca_template = {
1808 .name = "gspca main driver",
1810 .ioctl_ops = &dev_ioctl_ops,
1811 .release = video_device_release,
1816 * probe and create a new gspca device
1818 * This function must be called by the sub-driver when it is
1819 * called for probing a new device.
1821 int gspca_dev_probe(struct usb_interface *intf,
1822 const struct usb_device_id *id,
1823 const struct sd_desc *sd_desc,
1825 struct module *module)
1827 struct usb_interface_descriptor *interface;
1828 struct gspca_dev *gspca_dev;
1829 struct usb_device *dev = interface_to_usbdev(intf);
1832 PDEBUG(D_PROBE, "probing %04x:%04x", id->idVendor, id->idProduct);
1834 /* we don't handle multi-config cameras */
1835 if (dev->descriptor.bNumConfigurations != 1)
1837 interface = &intf->cur_altsetting->desc;
1838 if (interface->bInterfaceNumber > 0)
1841 /* create the device */
1842 if (dev_size < sizeof *gspca_dev)
1843 dev_size = sizeof *gspca_dev;
1844 gspca_dev = kzalloc(dev_size, GFP_KERNEL);
1846 err("couldn't kzalloc gspca struct");
1849 kref_init(&gspca_dev->kref);
1850 gspca_dev->usb_buf = kmalloc(USB_BUF_SZ, GFP_KERNEL);
1851 if (!gspca_dev->usb_buf) {
1852 err("out of memory");
1856 gspca_dev->dev = dev;
1857 gspca_dev->iface = interface->bInterfaceNumber;
1858 gspca_dev->nbalt = intf->num_altsetting;
1859 gspca_dev->sd_desc = sd_desc;
1860 gspca_dev->nbufread = 2;
1862 /* configure the subdriver and initialize the USB device */
1863 ret = gspca_dev->sd_desc->config(gspca_dev, id);
1866 ret = gspca_dev->sd_desc->init(gspca_dev);
1869 ret = gspca_set_alt0(gspca_dev);
1872 gspca_set_default_mode(gspca_dev);
1874 mutex_init(&gspca_dev->usb_lock);
1875 mutex_init(&gspca_dev->read_lock);
1876 mutex_init(&gspca_dev->queue_lock);
1877 init_waitqueue_head(&gspca_dev->wq);
1879 /* init video stuff */
1880 gspca_dev->vdev = video_device_alloc();
1881 memcpy(gspca_dev->vdev, &gspca_template, sizeof gspca_template);
1882 gspca_dev->vdev->parent = &dev->dev;
1883 gspca_dev->module = module;
1884 gspca_dev->present = 1;
1885 ret = video_register_device(&gspca_dev->vdev,
1889 err("video_register_device err %d", ret);
1893 usb_set_intfdata(intf, gspca_dev);
1894 PDEBUG(D_PROBE, "probe ok");
1897 kfree(gspca_dev->usb_buf);
1901 EXPORT_SYMBOL(gspca_dev_probe);
1906 * This function must be called by the sub-driver
1907 * when the device disconnects, after the specific resources are freed.
1909 void gspca_disconnect(struct usb_interface *intf)
1911 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
1913 usb_set_intfdata(intf, NULL);
1915 /* release the device */
1916 /* (this will call gspca_release() immediatly or on last close) */
1917 video_unregister_device(&gspca_dev->vdev);
1919 kref_put(&gspca_dev->kref, gspca_delete);
1921 PDEBUG(D_PROBE, "disconnect complete");
1923 EXPORT_SYMBOL(gspca_disconnect);
1926 int gspca_suspend(struct usb_interface *intf, pm_message_t message)
1928 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
1930 if (!gspca_dev->streaming)
1932 gspca_dev->frozen = 1; /* avoid urb error messages */
1933 if (gspca_dev->sd_desc->stopN)
1934 gspca_dev->sd_desc->stopN(gspca_dev);
1935 destroy_urbs(gspca_dev);
1936 gspca_set_alt0(gspca_dev);
1937 if (gspca_dev->sd_desc->stop0)
1938 gspca_dev->sd_desc->stop0(gspca_dev);
1941 EXPORT_SYMBOL(gspca_suspend);
1943 int gspca_resume(struct usb_interface *intf)
1945 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
1947 gspca_dev->frozen = 0;
1948 gspca_dev->sd_desc->init(gspca_dev);
1949 if (gspca_dev->streaming)
1950 return gspca_init_transfer(gspca_dev);
1953 EXPORT_SYMBOL(gspca_resume);
1955 /* -- cam driver utility functions -- */
1957 /* auto gain and exposure algorithm based on the knee algorithm described here:
1958 http://ytse.tricolour.net/docs/LowLightOptimization.html
1960 Returns 0 if no changes were made, 1 if the gain and or exposure settings
1962 int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
1963 int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee)
1965 int i, steps, gain, orig_gain, exposure, orig_exposure, autogain;
1966 const struct ctrl *gain_ctrl = NULL;
1967 const struct ctrl *exposure_ctrl = NULL;
1968 const struct ctrl *autogain_ctrl = NULL;
1971 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
1972 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_GAIN)
1973 gain_ctrl = &gspca_dev->sd_desc->ctrls[i];
1974 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_EXPOSURE)
1975 exposure_ctrl = &gspca_dev->sd_desc->ctrls[i];
1976 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_AUTOGAIN)
1977 autogain_ctrl = &gspca_dev->sd_desc->ctrls[i];
1979 if (!gain_ctrl || !exposure_ctrl || !autogain_ctrl) {
1980 PDEBUG(D_ERR, "Error: gspca_auto_gain_n_exposure called "
1981 "on cam without (auto)gain/exposure");
1985 if (gain_ctrl->get(gspca_dev, &gain) ||
1986 exposure_ctrl->get(gspca_dev, &exposure) ||
1987 autogain_ctrl->get(gspca_dev, &autogain) || !autogain)
1991 orig_exposure = exposure;
1993 /* If we are of a multiple of deadzone, do multiple steps to reach the
1994 desired lumination fast (with the risc of a slight overshoot) */
1995 steps = abs(desired_avg_lum - avg_lum) / deadzone;
1997 PDEBUG(D_FRAM, "autogain: lum: %d, desired: %d, steps: %d\n",
1998 avg_lum, desired_avg_lum, steps);
2000 for (i = 0; i < steps; i++) {
2001 if (avg_lum > desired_avg_lum) {
2002 if (gain > gain_knee)
2004 else if (exposure > exposure_knee)
2006 else if (gain > gain_ctrl->qctrl.default_value)
2008 else if (exposure > exposure_ctrl->qctrl.minimum)
2010 else if (gain > gain_ctrl->qctrl.minimum)
2015 if (gain < gain_ctrl->qctrl.default_value)
2017 else if (exposure < exposure_knee)
2019 else if (gain < gain_knee)
2021 else if (exposure < exposure_ctrl->qctrl.maximum)
2023 else if (gain < gain_ctrl->qctrl.maximum)
2030 if (gain != orig_gain) {
2031 gain_ctrl->set(gspca_dev, gain);
2034 if (exposure != orig_exposure) {
2035 exposure_ctrl->set(gspca_dev, exposure);
2041 EXPORT_SYMBOL(gspca_auto_gain_n_exposure);
2043 /* -- module insert / remove -- */
2044 static int __init gspca_init(void)
2046 info("main v%d.%d.%d registered",
2047 (DRIVER_VERSION_NUMBER >> 16) & 0xff,
2048 (DRIVER_VERSION_NUMBER >> 8) & 0xff,
2049 DRIVER_VERSION_NUMBER & 0xff);
2052 static void __exit gspca_exit(void)
2054 info("main deregistered");
2057 module_init(gspca_init);
2058 module_exit(gspca_exit);
2061 module_param_named(debug, gspca_debug, int, 0644);
2062 MODULE_PARM_DESC(debug,
2063 "Debug (bit) 0x01:error 0x02:probe 0x04:config"
2064 " 0x08:stream 0x10:frame 0x20:packet 0x40:USBin 0x80:USBout"