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>
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, 5, 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 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) {
135 if (urb->status == -ESHUTDOWN)
136 return; /* disconnection */
138 if (!gspca_dev->frozen)
140 PDEBUG(D_ERR|D_PACK, "urb status: %d", urb->status);
143 pkt_scan = gspca_dev->sd_desc->pkt_scan;
144 for (i = 0; i < urb->number_of_packets; i++) {
146 /* check the availability of the frame buffer */
147 frame = gspca_get_i_frame(gspca_dev);
149 gspca_dev->last_packet_type = DISCARD_PACKET;
153 /* check the packet status and length */
154 len = urb->iso_frame_desc[i].actual_length;
156 if (gspca_dev->empty_packet == 0)
157 gspca_dev->empty_packet = 1;
160 st = urb->iso_frame_desc[i].status;
163 "ISOC data error: [%d] len=%d, status=%d",
165 gspca_dev->last_packet_type = DISCARD_PACKET;
169 /* let the packet be analyzed by the subdriver */
170 PDEBUG(D_PACK, "packet [%d] o:%d l:%d",
171 i, urb->iso_frame_desc[i].offset, len);
172 data = (u8 *) urb->transfer_buffer
173 + urb->iso_frame_desc[i].offset;
174 pkt_scan(gspca_dev, frame, data, len);
177 /* resubmit the URB */
178 st = usb_submit_urb(urb, GFP_ATOMIC);
180 PDEBUG(D_ERR|D_PACK, "usb_submit_urb() ret %d", st);
184 * ISOC message interrupt from the USB device
186 * Analyse each packet and call the subdriver for copy to the frame buffer.
188 static void isoc_irq(struct urb *urb)
190 struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
192 PDEBUG(D_PACK, "isoc irq");
193 if (!gspca_dev->streaming)
195 fill_frame(gspca_dev, urb);
199 * bulk message interrupt from the USB device
201 static void bulk_irq(struct urb *urb)
203 struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
204 struct gspca_frame *frame;
207 PDEBUG(D_PACK, "bulk irq");
208 if (!gspca_dev->streaming)
210 switch (urb->status) {
214 return; /* disconnection */
220 if (!gspca_dev->frozen)
222 PDEBUG(D_ERR|D_PACK, "urb status: %d", urb->status);
226 /* check the availability of the frame buffer */
227 frame = gspca_get_i_frame(gspca_dev);
229 gspca_dev->last_packet_type = DISCARD_PACKET;
231 PDEBUG(D_PACK, "packet l:%d", urb->actual_length);
232 gspca_dev->sd_desc->pkt_scan(gspca_dev,
234 urb->transfer_buffer,
238 /* resubmit the URB */
239 if (gspca_dev->cam.bulk_nurbs != 0) {
240 st = usb_submit_urb(urb, GFP_ATOMIC);
242 PDEBUG(D_ERR|D_PACK, "usb_submit_urb() ret %d", st);
247 * add data to the current frame
249 * This function is called by the subdrivers at interrupt level.
251 * To build a frame, these ones must add
253 * - 0 or many INTER_PACKETs
255 * DISCARD_PACKET invalidates the whole frame.
256 * On LAST_PACKET, a new frame is returned.
258 struct gspca_frame *gspca_frame_add(struct gspca_dev *gspca_dev,
259 enum gspca_packet_type packet_type,
260 struct gspca_frame *frame,
266 PDEBUG(D_PACK, "add t:%d l:%d", packet_type, len);
268 /* when start of a new frame, if the current frame buffer
269 * is not queued, discard the whole frame */
270 if (packet_type == FIRST_PACKET) {
271 if ((frame->v4l2_buf.flags & BUF_ALL_FLAGS)
272 != V4L2_BUF_FLAG_QUEUED) {
273 gspca_dev->last_packet_type = DISCARD_PACKET;
276 frame->data_end = frame->data;
277 jiffies_to_timeval(get_jiffies_64(),
278 &frame->v4l2_buf.timestamp);
279 frame->v4l2_buf.sequence = ++gspca_dev->sequence;
280 } else if (gspca_dev->last_packet_type == DISCARD_PACKET) {
281 if (packet_type == LAST_PACKET)
282 gspca_dev->last_packet_type = packet_type;
286 /* append the packet to the frame buffer */
288 if (frame->data_end - frame->data + len
289 > frame->v4l2_buf.length) {
290 PDEBUG(D_ERR|D_PACK, "frame overflow %zd > %d",
291 frame->data_end - frame->data + len,
292 frame->v4l2_buf.length);
293 packet_type = DISCARD_PACKET;
295 memcpy(frame->data_end, data, len);
296 frame->data_end += len;
299 gspca_dev->last_packet_type = packet_type;
301 /* if last packet, wake up the application and advance in the queue */
302 if (packet_type == LAST_PACKET) {
303 frame->v4l2_buf.bytesused = frame->data_end - frame->data;
304 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_QUEUED;
305 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_DONE;
306 wake_up_interruptible(&gspca_dev->wq); /* event = new frame */
307 i = (gspca_dev->fr_i + 1) % gspca_dev->nframes;
309 PDEBUG(D_FRAM, "frame complete len:%d q:%d i:%d o:%d",
310 frame->v4l2_buf.bytesused,
314 j = gspca_dev->fr_queue[i];
315 frame = &gspca_dev->frame[j];
319 EXPORT_SYMBOL(gspca_frame_add);
321 static int gspca_is_compressed(__u32 format)
324 case V4L2_PIX_FMT_MJPEG:
325 case V4L2_PIX_FMT_JPEG:
326 case V4L2_PIX_FMT_SPCA561:
327 case V4L2_PIX_FMT_PAC207:
328 case V4L2_PIX_FMT_MR97310A:
334 static void *rvmalloc(unsigned long size)
339 mem = vmalloc_32(size);
341 adr = (unsigned long) mem;
342 while ((long) size > 0) {
343 SetPageReserved(vmalloc_to_page((void *) adr));
351 static void rvfree(void *mem, long size)
355 adr = (unsigned long) mem;
357 ClearPageReserved(vmalloc_to_page((void *) adr));
364 static int frame_alloc(struct gspca_dev *gspca_dev,
367 struct gspca_frame *frame;
371 i = gspca_dev->curr_mode;
372 frsz = gspca_dev->cam.cam_mode[i].sizeimage;
373 PDEBUG(D_STREAM, "frame alloc frsz: %d", frsz);
374 frsz = PAGE_ALIGN(frsz);
375 gspca_dev->frsz = frsz;
376 if (count > GSPCA_MAX_FRAMES)
377 count = GSPCA_MAX_FRAMES;
378 gspca_dev->frbuf = rvmalloc(frsz * count);
379 if (!gspca_dev->frbuf) {
380 err("frame alloc failed");
383 gspca_dev->nframes = count;
384 for (i = 0; i < count; i++) {
385 frame = &gspca_dev->frame[i];
386 frame->v4l2_buf.index = i;
387 frame->v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
388 frame->v4l2_buf.flags = 0;
389 frame->v4l2_buf.field = V4L2_FIELD_NONE;
390 frame->v4l2_buf.length = frsz;
391 frame->v4l2_buf.memory = gspca_dev->memory;
392 frame->v4l2_buf.sequence = 0;
393 frame->data = frame->data_end =
394 gspca_dev->frbuf + i * frsz;
395 frame->v4l2_buf.m.offset = i * frsz;
397 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
398 gspca_dev->last_packet_type = DISCARD_PACKET;
399 gspca_dev->sequence = 0;
403 static void frame_free(struct gspca_dev *gspca_dev)
407 PDEBUG(D_STREAM, "frame free");
408 if (gspca_dev->frbuf != NULL) {
409 rvfree(gspca_dev->frbuf,
410 gspca_dev->nframes * gspca_dev->frsz);
411 gspca_dev->frbuf = NULL;
412 for (i = 0; i < gspca_dev->nframes; i++)
413 gspca_dev->frame[i].data = NULL;
415 gspca_dev->nframes = 0;
418 static void destroy_urbs(struct gspca_dev *gspca_dev)
423 PDEBUG(D_STREAM, "kill transfer");
424 for (i = 0; i < MAX_NURBS; i++) {
425 urb = gspca_dev->urb[i];
429 gspca_dev->urb[i] = NULL;
431 if (urb->transfer_buffer != NULL)
432 usb_buffer_free(gspca_dev->dev,
433 urb->transfer_buffer_length,
434 urb->transfer_buffer,
441 * look for an input transfer endpoint in an alternate setting
443 static struct usb_host_endpoint *alt_xfer(struct usb_host_interface *alt,
446 struct usb_host_endpoint *ep;
449 for (i = 0; i < alt->desc.bNumEndpoints; i++) {
450 ep = &alt->endpoint[i];
451 attr = ep->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
459 * look for an input (isoc or bulk) endpoint
461 * The endpoint is defined by the subdriver.
462 * Use only the first isoc (some Zoran - 0x0572:0x0001 - have two such ep).
463 * This routine may be called many times when the bandwidth is too small
464 * (the bandwidth is checked on urb submit).
466 static struct usb_host_endpoint *get_ep(struct gspca_dev *gspca_dev)
468 struct usb_interface *intf;
469 struct usb_host_endpoint *ep;
472 intf = usb_ifnum_to_if(gspca_dev->dev, gspca_dev->iface);
474 i = gspca_dev->alt; /* previous alt setting */
478 ep = alt_xfer(&intf->altsetting[i],
479 USB_ENDPOINT_XFER_ISOC);
484 /* if no isoc, try bulk (alt 0 only) */
486 ep = alt_xfer(&intf->altsetting[0],
487 USB_ENDPOINT_XFER_BULK);
489 err("no transfer endpoint found");
495 PDEBUG(D_STREAM, "use alt %d ep 0x%02x",
496 i, ep->desc.bEndpointAddress);
498 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, i);
500 err("set interface err %d", ret);
504 gspca_dev->alt = i; /* memorize the current alt setting */
509 * create the URBs for image transfer
511 static int create_urbs(struct gspca_dev *gspca_dev,
512 struct usb_host_endpoint *ep)
515 int n, nurbs, i, psize, npkt, bsize;
517 /* calculate the packet size and the number of packets */
518 psize = le16_to_cpu(ep->desc.wMaxPacketSize);
520 if (!gspca_dev->bulk) { /* isoc */
522 /* See paragraph 5.9 / table 5-11 of the usb 2.0 spec. */
523 psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
524 npkt = ISO_MAX_SIZE / psize;
525 if (npkt > ISO_MAX_PKT)
527 bsize = psize * npkt;
529 "isoc %d pkts size %d = bsize:%d",
534 bsize = gspca_dev->cam.bulk_size;
537 PDEBUG(D_STREAM, "bulk bsize:%d", bsize);
538 if (gspca_dev->cam.bulk_nurbs != 0)
539 nurbs = gspca_dev->cam.bulk_nurbs;
544 gspca_dev->nurbs = nurbs;
545 for (n = 0; n < nurbs; n++) {
546 urb = usb_alloc_urb(npkt, GFP_KERNEL);
548 err("usb_alloc_urb failed");
549 destroy_urbs(gspca_dev);
552 urb->transfer_buffer = usb_buffer_alloc(gspca_dev->dev,
557 if (urb->transfer_buffer == NULL) {
559 err("usb_buffer_urb failed");
560 destroy_urbs(gspca_dev);
563 gspca_dev->urb[n] = urb;
564 urb->dev = gspca_dev->dev;
565 urb->context = gspca_dev;
566 urb->transfer_buffer_length = bsize;
567 if (npkt != 0) { /* ISOC */
568 urb->pipe = usb_rcvisocpipe(gspca_dev->dev,
569 ep->desc.bEndpointAddress);
570 urb->transfer_flags = URB_ISO_ASAP
571 | URB_NO_TRANSFER_DMA_MAP;
572 urb->interval = ep->desc.bInterval;
573 urb->complete = isoc_irq;
574 urb->number_of_packets = npkt;
575 for (i = 0; i < npkt; i++) {
576 urb->iso_frame_desc[i].length = psize;
577 urb->iso_frame_desc[i].offset = psize * i;
580 urb->pipe = usb_rcvbulkpipe(gspca_dev->dev,
581 ep->desc.bEndpointAddress),
582 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
583 urb->complete = bulk_irq;
590 * start the USB transfer
592 static int gspca_init_transfer(struct gspca_dev *gspca_dev)
594 struct usb_host_endpoint *ep;
597 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
600 if (!gspca_dev->present) {
605 /* set the higher alternate setting and
606 * loop until urb submit succeeds */
607 gspca_dev->alt = gspca_dev->nbalt;
609 PDEBUG(D_STREAM, "init transfer alt %d", gspca_dev->alt);
610 ep = get_ep(gspca_dev);
615 ret = create_urbs(gspca_dev, ep);
619 /* clear the bulk endpoint */
621 usb_clear_halt(gspca_dev->dev,
622 gspca_dev->urb[0]->pipe);
625 ret = gspca_dev->sd_desc->start(gspca_dev);
627 destroy_urbs(gspca_dev);
630 gspca_dev->streaming = 1;
632 /* some bulk transfers are started by the subdriver */
633 if (gspca_dev->bulk && gspca_dev->cam.bulk_nurbs == 0)
636 /* submit the URBs */
637 for (n = 0; n < gspca_dev->nurbs; n++) {
638 ret = usb_submit_urb(gspca_dev->urb[n], GFP_KERNEL);
640 PDEBUG(D_ERR|D_STREAM,
641 "usb_submit_urb [%d] err %d", n, ret);
642 gspca_dev->streaming = 0;
643 destroy_urbs(gspca_dev);
644 if (ret == -ENOSPC) {
645 msleep(20); /* wait for kill
647 break; /* try the previous alt */
656 mutex_unlock(&gspca_dev->usb_lock);
660 static int gspca_set_alt0(struct gspca_dev *gspca_dev)
664 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, 0);
666 PDEBUG(D_ERR|D_STREAM, "set alt 0 err %d", ret);
670 /* Note: both the queue and the usb locks should be held when calling this */
671 static void gspca_stream_off(struct gspca_dev *gspca_dev)
673 gspca_dev->streaming = 0;
674 if (gspca_dev->present) {
675 if (gspca_dev->sd_desc->stopN)
676 gspca_dev->sd_desc->stopN(gspca_dev);
677 destroy_urbs(gspca_dev);
678 gspca_set_alt0(gspca_dev);
681 /* always call stop0 to free the subdriver's resources */
682 if (gspca_dev->sd_desc->stop0)
683 gspca_dev->sd_desc->stop0(gspca_dev);
684 PDEBUG(D_STREAM, "stream off OK");
687 static void gspca_set_default_mode(struct gspca_dev *gspca_dev)
691 i = gspca_dev->cam.nmodes - 1; /* take the highest mode */
692 gspca_dev->curr_mode = i;
693 gspca_dev->width = gspca_dev->cam.cam_mode[i].width;
694 gspca_dev->height = gspca_dev->cam.cam_mode[i].height;
695 gspca_dev->pixfmt = gspca_dev->cam.cam_mode[i].pixelformat;
698 static int wxh_to_mode(struct gspca_dev *gspca_dev,
699 int width, int height)
703 for (i = gspca_dev->cam.nmodes; --i > 0; ) {
704 if (width >= gspca_dev->cam.cam_mode[i].width
705 && height >= gspca_dev->cam.cam_mode[i].height)
712 * search a mode with the right pixel format
714 static int gspca_get_mode(struct gspca_dev *gspca_dev,
720 modeU = modeD = mode;
721 while ((modeU < gspca_dev->cam.nmodes) || modeD >= 0) {
723 if (gspca_dev->cam.cam_mode[modeD].pixelformat
727 if (++modeU < gspca_dev->cam.nmodes) {
728 if (gspca_dev->cam.cam_mode[modeU].pixelformat
736 static int vidioc_enum_fmt_vid_cap(struct file *file, void *priv,
737 struct v4l2_fmtdesc *fmtdesc)
739 struct gspca_dev *gspca_dev = priv;
743 /* give an index to each format */
746 for (i = gspca_dev->cam.nmodes; --i >= 0; ) {
747 fmt_tb[index] = gspca_dev->cam.cam_mode[i].pixelformat;
750 if (fmt_tb[j] == fmt_tb[index])
755 if (fmtdesc->index == index)
756 break; /* new format */
758 if (index >= ARRAY_SIZE(fmt_tb))
763 return -EINVAL; /* no more format */
765 fmtdesc->pixelformat = fmt_tb[index];
766 if (gspca_is_compressed(fmt_tb[index]))
767 fmtdesc->flags = V4L2_FMT_FLAG_COMPRESSED;
768 fmtdesc->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
769 fmtdesc->description[0] = fmtdesc->pixelformat & 0xff;
770 fmtdesc->description[1] = (fmtdesc->pixelformat >> 8) & 0xff;
771 fmtdesc->description[2] = (fmtdesc->pixelformat >> 16) & 0xff;
772 fmtdesc->description[3] = fmtdesc->pixelformat >> 24;
773 fmtdesc->description[4] = '\0';
777 static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
778 struct v4l2_format *fmt)
780 struct gspca_dev *gspca_dev = priv;
783 mode = gspca_dev->curr_mode;
784 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
785 sizeof fmt->fmt.pix);
789 static int try_fmt_vid_cap(struct gspca_dev *gspca_dev,
790 struct v4l2_format *fmt)
792 int w, h, mode, mode2;
794 w = fmt->fmt.pix.width;
795 h = fmt->fmt.pix.height;
798 if (gspca_debug & D_CONF)
799 PDEBUG_MODE("try fmt cap", fmt->fmt.pix.pixelformat, w, h);
801 /* search the closest mode for width and height */
802 mode = wxh_to_mode(gspca_dev, w, h);
804 /* OK if right palette */
805 if (gspca_dev->cam.cam_mode[mode].pixelformat
806 != fmt->fmt.pix.pixelformat) {
808 /* else, search the closest mode with the same pixel format */
809 mode2 = gspca_get_mode(gspca_dev, mode,
810 fmt->fmt.pix.pixelformat);
814 ; * no chance, return this mode */
816 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
817 sizeof fmt->fmt.pix);
818 return mode; /* used when s_fmt */
821 static int vidioc_try_fmt_vid_cap(struct file *file,
823 struct v4l2_format *fmt)
825 struct gspca_dev *gspca_dev = priv;
828 ret = try_fmt_vid_cap(gspca_dev, fmt);
834 static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
835 struct v4l2_format *fmt)
837 struct gspca_dev *gspca_dev = priv;
840 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
843 ret = try_fmt_vid_cap(gspca_dev, fmt);
847 if (gspca_dev->nframes != 0
848 && fmt->fmt.pix.sizeimage > gspca_dev->frsz) {
853 if (ret == gspca_dev->curr_mode) {
855 goto out; /* same mode */
858 if (gspca_dev->streaming) {
862 gspca_dev->width = fmt->fmt.pix.width;
863 gspca_dev->height = fmt->fmt.pix.height;
864 gspca_dev->pixfmt = fmt->fmt.pix.pixelformat;
865 gspca_dev->curr_mode = ret;
869 mutex_unlock(&gspca_dev->queue_lock);
873 static void gspca_release(struct video_device *vfd)
875 struct gspca_dev *gspca_dev = container_of(vfd, struct gspca_dev, vdev);
877 PDEBUG(D_STREAM, "device released");
879 kfree(gspca_dev->usb_buf);
883 static int dev_open(struct file *file)
885 struct gspca_dev *gspca_dev;
888 PDEBUG(D_STREAM, "%s open", current->comm);
889 gspca_dev = (struct gspca_dev *) video_devdata(file);
890 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
892 if (!gspca_dev->present) {
897 if (gspca_dev->users > 4) { /* (arbitrary value) */
902 /* protect the subdriver against rmmod */
903 if (!try_module_get(gspca_dev->module)) {
910 file->private_data = gspca_dev;
912 /* activate the v4l2 debug */
913 if (gspca_debug & D_V4L2)
914 gspca_dev->vdev.debug |= V4L2_DEBUG_IOCTL
915 | V4L2_DEBUG_IOCTL_ARG;
917 gspca_dev->vdev.debug &= ~(V4L2_DEBUG_IOCTL
918 | V4L2_DEBUG_IOCTL_ARG);
922 mutex_unlock(&gspca_dev->queue_lock);
924 PDEBUG(D_ERR|D_STREAM, "open failed err %d", ret);
926 PDEBUG(D_STREAM, "open done");
930 static int dev_close(struct file *file)
932 struct gspca_dev *gspca_dev = file->private_data;
934 PDEBUG(D_STREAM, "%s close", current->comm);
935 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
939 /* if the file did the capture, free the streaming resources */
940 if (gspca_dev->capt_file == file) {
941 if (gspca_dev->streaming) {
942 mutex_lock(&gspca_dev->usb_lock);
943 gspca_stream_off(gspca_dev);
944 mutex_unlock(&gspca_dev->usb_lock);
946 frame_free(gspca_dev);
947 gspca_dev->capt_file = NULL;
948 gspca_dev->memory = GSPCA_MEMORY_NO;
950 file->private_data = NULL;
951 module_put(gspca_dev->module);
952 mutex_unlock(&gspca_dev->queue_lock);
954 PDEBUG(D_STREAM, "close done");
959 static int vidioc_querycap(struct file *file, void *priv,
960 struct v4l2_capability *cap)
962 struct gspca_dev *gspca_dev = priv;
965 memset(cap, 0, sizeof *cap);
967 /* protect the access to the usb device */
968 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
970 if (!gspca_dev->present) {
974 strncpy(cap->driver, gspca_dev->sd_desc->name, sizeof cap->driver);
975 if (gspca_dev->dev->product != NULL) {
976 strncpy(cap->card, gspca_dev->dev->product,
979 snprintf(cap->card, sizeof cap->card,
980 "USB Camera (%04x:%04x)",
981 le16_to_cpu(gspca_dev->dev->descriptor.idVendor),
982 le16_to_cpu(gspca_dev->dev->descriptor.idProduct));
984 usb_make_path(gspca_dev->dev, cap->bus_info, sizeof(cap->bus_info));
985 cap->version = DRIVER_VERSION_NUMBER;
986 cap->capabilities = V4L2_CAP_VIDEO_CAPTURE
988 | V4L2_CAP_READWRITE;
991 mutex_unlock(&gspca_dev->usb_lock);
995 static int vidioc_queryctrl(struct file *file, void *priv,
996 struct v4l2_queryctrl *q_ctrl)
998 struct gspca_dev *gspca_dev = priv;
1004 if (id & V4L2_CTRL_FLAG_NEXT_CTRL) {
1005 id &= V4L2_CTRL_ID_MASK;
1007 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
1008 if (gspca_dev->sd_desc->ctrls[i].qctrl.id < id)
1014 if (gspca_dev->sd_desc->ctrls[i].qctrl.id
1015 > gspca_dev->sd_desc->ctrls[ix].qctrl.id)
1020 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
1021 if (id == gspca_dev->sd_desc->ctrls[i].qctrl.id) {
1028 memcpy(q_ctrl, &gspca_dev->sd_desc->ctrls[ix].qctrl,
1030 if (gspca_dev->ctrl_dis & (1 << ix))
1031 q_ctrl->flags |= V4L2_CTRL_FLAG_DISABLED;
1035 static int vidioc_s_ctrl(struct file *file, void *priv,
1036 struct v4l2_control *ctrl)
1038 struct gspca_dev *gspca_dev = priv;
1039 const struct ctrl *ctrls;
1042 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
1043 i < gspca_dev->sd_desc->nctrls;
1045 if (ctrl->id != ctrls->qctrl.id)
1047 if (gspca_dev->ctrl_dis & (1 << i))
1049 if (ctrl->value < ctrls->qctrl.minimum
1050 || ctrl->value > ctrls->qctrl.maximum)
1052 PDEBUG(D_CONF, "set ctrl [%08x] = %d", ctrl->id, ctrl->value);
1053 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1054 return -ERESTARTSYS;
1055 if (gspca_dev->present)
1056 ret = ctrls->set(gspca_dev, ctrl->value);
1059 mutex_unlock(&gspca_dev->usb_lock);
1065 static int vidioc_g_ctrl(struct file *file, void *priv,
1066 struct v4l2_control *ctrl)
1068 struct gspca_dev *gspca_dev = priv;
1070 const struct ctrl *ctrls;
1073 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
1074 i < gspca_dev->sd_desc->nctrls;
1076 if (ctrl->id != ctrls->qctrl.id)
1078 if (gspca_dev->ctrl_dis & (1 << i))
1080 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1081 return -ERESTARTSYS;
1082 if (gspca_dev->present)
1083 ret = ctrls->get(gspca_dev, &ctrl->value);
1086 mutex_unlock(&gspca_dev->usb_lock);
1092 /*fixme: have an audio flag in gspca_dev?*/
1093 static int vidioc_s_audio(struct file *file, void *priv,
1094 struct v4l2_audio *audio)
1096 if (audio->index != 0)
1101 static int vidioc_g_audio(struct file *file, void *priv,
1102 struct v4l2_audio *audio)
1104 strcpy(audio->name, "Microphone");
1108 static int vidioc_enumaudio(struct file *file, void *priv,
1109 struct v4l2_audio *audio)
1111 if (audio->index != 0)
1114 strcpy(audio->name, "Microphone");
1115 audio->capability = 0;
1120 static int vidioc_querymenu(struct file *file, void *priv,
1121 struct v4l2_querymenu *qmenu)
1123 struct gspca_dev *gspca_dev = priv;
1125 if (!gspca_dev->sd_desc->querymenu)
1127 return gspca_dev->sd_desc->querymenu(gspca_dev, qmenu);
1130 static int vidioc_enum_input(struct file *file, void *priv,
1131 struct v4l2_input *input)
1133 struct gspca_dev *gspca_dev = priv;
1135 if (input->index != 0)
1137 input->type = V4L2_INPUT_TYPE_CAMERA;
1138 strncpy(input->name, gspca_dev->sd_desc->name,
1139 sizeof input->name);
1143 static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
1149 static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
1156 static int vidioc_reqbufs(struct file *file, void *priv,
1157 struct v4l2_requestbuffers *rb)
1159 struct gspca_dev *gspca_dev = priv;
1162 switch (rb->memory) {
1163 case GSPCA_MEMORY_READ: /* (internal call) */
1164 case V4L2_MEMORY_MMAP:
1165 case V4L2_MEMORY_USERPTR:
1170 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1171 return -ERESTARTSYS;
1173 if (gspca_dev->memory != GSPCA_MEMORY_NO
1174 && gspca_dev->memory != rb->memory) {
1179 /* only one file may do the capture */
1180 if (gspca_dev->capt_file != NULL
1181 && gspca_dev->capt_file != file) {
1186 /* if allocated, the buffers must not be mapped */
1187 for (i = 0; i < gspca_dev->nframes; i++) {
1188 if (gspca_dev->frame[i].vma_use_count) {
1194 /* stop streaming */
1195 if (gspca_dev->streaming) {
1196 mutex_lock(&gspca_dev->usb_lock);
1197 gspca_stream_off(gspca_dev);
1198 mutex_unlock(&gspca_dev->usb_lock);
1201 /* free the previous allocated buffers, if any */
1202 if (gspca_dev->nframes != 0) {
1203 frame_free(gspca_dev);
1204 gspca_dev->capt_file = NULL;
1206 if (rb->count == 0) /* unrequest */
1208 gspca_dev->memory = rb->memory;
1209 ret = frame_alloc(gspca_dev, rb->count);
1211 rb->count = gspca_dev->nframes;
1212 gspca_dev->capt_file = file;
1215 mutex_unlock(&gspca_dev->queue_lock);
1216 PDEBUG(D_STREAM, "reqbufs st:%d c:%d", ret, rb->count);
1220 static int vidioc_querybuf(struct file *file, void *priv,
1221 struct v4l2_buffer *v4l2_buf)
1223 struct gspca_dev *gspca_dev = priv;
1224 struct gspca_frame *frame;
1226 if (v4l2_buf->index < 0
1227 || v4l2_buf->index >= gspca_dev->nframes)
1230 frame = &gspca_dev->frame[v4l2_buf->index];
1231 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1235 static int vidioc_streamon(struct file *file, void *priv,
1236 enum v4l2_buf_type buf_type)
1238 struct gspca_dev *gspca_dev = priv;
1241 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1243 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1244 return -ERESTARTSYS;
1246 if (gspca_dev->nframes == 0
1247 || !(gspca_dev->frame[0].v4l2_buf.flags & V4L2_BUF_FLAG_QUEUED)) {
1251 if (!gspca_dev->streaming) {
1252 ret = gspca_init_transfer(gspca_dev);
1257 if (gspca_debug & D_STREAM) {
1258 PDEBUG_MODE("stream on OK",
1266 mutex_unlock(&gspca_dev->queue_lock);
1270 static int vidioc_streamoff(struct file *file, void *priv,
1271 enum v4l2_buf_type buf_type)
1273 struct gspca_dev *gspca_dev = priv;
1276 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1278 if (!gspca_dev->streaming)
1280 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1281 return -ERESTARTSYS;
1283 /* stop streaming */
1284 if (mutex_lock_interruptible(&gspca_dev->usb_lock)) {
1288 gspca_stream_off(gspca_dev);
1289 mutex_unlock(&gspca_dev->usb_lock);
1291 /* empty the application queues */
1292 for (i = 0; i < gspca_dev->nframes; i++)
1293 gspca_dev->frame[i].v4l2_buf.flags &= ~BUF_ALL_FLAGS;
1294 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
1295 gspca_dev->last_packet_type = DISCARD_PACKET;
1296 gspca_dev->sequence = 0;
1299 mutex_unlock(&gspca_dev->queue_lock);
1303 static int vidioc_g_jpegcomp(struct file *file, void *priv,
1304 struct v4l2_jpegcompression *jpegcomp)
1306 struct gspca_dev *gspca_dev = priv;
1309 if (!gspca_dev->sd_desc->get_jcomp)
1311 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1312 return -ERESTARTSYS;
1313 if (gspca_dev->present)
1314 ret = gspca_dev->sd_desc->get_jcomp(gspca_dev, jpegcomp);
1317 mutex_unlock(&gspca_dev->usb_lock);
1321 static int vidioc_s_jpegcomp(struct file *file, void *priv,
1322 struct v4l2_jpegcompression *jpegcomp)
1324 struct gspca_dev *gspca_dev = priv;
1327 if (!gspca_dev->sd_desc->set_jcomp)
1329 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1330 return -ERESTARTSYS;
1331 if (gspca_dev->present)
1332 ret = gspca_dev->sd_desc->set_jcomp(gspca_dev, jpegcomp);
1335 mutex_unlock(&gspca_dev->usb_lock);
1339 static int vidioc_g_parm(struct file *filp, void *priv,
1340 struct v4l2_streamparm *parm)
1342 struct gspca_dev *gspca_dev = priv;
1344 parm->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1345 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1347 if (gspca_dev->sd_desc->get_streamparm) {
1350 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1351 return -ERESTARTSYS;
1352 if (gspca_dev->present)
1353 ret = gspca_dev->sd_desc->get_streamparm(gspca_dev,
1357 mutex_unlock(&gspca_dev->usb_lock);
1364 static int vidioc_s_parm(struct file *filp, void *priv,
1365 struct v4l2_streamparm *parm)
1367 struct gspca_dev *gspca_dev = priv;
1370 n = parm->parm.capture.readbuffers;
1371 if (n == 0 || n > GSPCA_MAX_FRAMES)
1372 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1374 gspca_dev->nbufread = n;
1376 if (gspca_dev->sd_desc->set_streamparm) {
1379 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1380 return -ERESTARTSYS;
1381 if (gspca_dev->present)
1382 ret = gspca_dev->sd_desc->set_streamparm(gspca_dev,
1386 mutex_unlock(&gspca_dev->usb_lock);
1393 static int vidioc_s_std(struct file *filp, void *priv,
1399 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1400 static int vidiocgmbuf(struct file *file, void *priv,
1401 struct video_mbuf *mbuf)
1403 struct gspca_dev *gspca_dev = file->private_data;
1406 PDEBUG(D_STREAM, "cgmbuf");
1407 if (gspca_dev->nframes == 0) {
1411 struct v4l2_format fmt;
1413 fmt.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1414 i = gspca_dev->cam.nmodes - 1; /* highest mode */
1415 fmt.fmt.pix.width = gspca_dev->cam.cam_mode[i].width;
1416 fmt.fmt.pix.height = gspca_dev->cam.cam_mode[i].height;
1417 fmt.fmt.pix.pixelformat = V4L2_PIX_FMT_BGR24;
1418 ret = vidioc_s_fmt_vid_cap(file, priv, &fmt);
1423 struct v4l2_requestbuffers rb;
1425 memset(&rb, 0, sizeof rb);
1427 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1428 rb.memory = V4L2_MEMORY_MMAP;
1429 ret = vidioc_reqbufs(file, priv, &rb);
1434 mbuf->frames = gspca_dev->nframes;
1435 mbuf->size = gspca_dev->frsz * gspca_dev->nframes;
1436 for (i = 0; i < mbuf->frames; i++)
1437 mbuf->offsets[i] = gspca_dev->frame[i].v4l2_buf.m.offset;
1442 static int dev_mmap(struct file *file, struct vm_area_struct *vma)
1444 struct gspca_dev *gspca_dev = file->private_data;
1445 struct gspca_frame *frame;
1447 unsigned long addr, start, size;
1450 start = vma->vm_start;
1451 size = vma->vm_end - vma->vm_start;
1452 PDEBUG(D_STREAM, "mmap start:%08x size:%d", (int) start, (int) size);
1454 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1455 return -ERESTARTSYS;
1456 if (!gspca_dev->present) {
1460 if (gspca_dev->capt_file != file) {
1466 for (i = 0; i < gspca_dev->nframes; ++i) {
1467 if (gspca_dev->frame[i].v4l2_buf.memory != V4L2_MEMORY_MMAP) {
1468 PDEBUG(D_STREAM, "mmap bad memory type");
1471 if ((gspca_dev->frame[i].v4l2_buf.m.offset >> PAGE_SHIFT)
1473 frame = &gspca_dev->frame[i];
1477 if (frame == NULL) {
1478 PDEBUG(D_STREAM, "mmap no frame buffer found");
1482 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1483 /* v4l1 maps all the buffers */
1485 || size != frame->v4l2_buf.length * gspca_dev->nframes)
1487 if (size != frame->v4l2_buf.length) {
1488 PDEBUG(D_STREAM, "mmap bad size");
1494 * - VM_IO marks the area as being a mmaped region for I/O to a
1495 * device. It also prevents the region from being core dumped.
1497 vma->vm_flags |= VM_IO;
1499 addr = (unsigned long) frame->data;
1501 page = vmalloc_to_page((void *) addr);
1502 ret = vm_insert_page(vma, start, page);
1510 vma->vm_ops = &gspca_vm_ops;
1511 vma->vm_private_data = frame;
1515 mutex_unlock(&gspca_dev->queue_lock);
1520 * wait for a video frame
1522 * If a frame is ready, its index is returned.
1524 static int frame_wait(struct gspca_dev *gspca_dev,
1527 struct gspca_frame *frame;
1530 /* check if a frame is ready */
1531 i = gspca_dev->fr_o;
1532 j = gspca_dev->fr_queue[i];
1533 frame = &gspca_dev->frame[j];
1535 if (!(frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE)) {
1539 /* wait till a frame is ready */
1540 ret = wait_event_interruptible_timeout(gspca_dev->wq,
1541 (frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE) ||
1542 !gspca_dev->streaming || !gspca_dev->present,
1543 msecs_to_jiffies(3000));
1546 if (ret == 0 || !gspca_dev->streaming || !gspca_dev->present)
1550 gspca_dev->fr_o = (i + 1) % gspca_dev->nframes;
1551 PDEBUG(D_FRAM, "frame wait q:%d i:%d o:%d",
1556 if (gspca_dev->sd_desc->dq_callback) {
1557 mutex_lock(&gspca_dev->usb_lock);
1558 if (gspca_dev->present)
1559 gspca_dev->sd_desc->dq_callback(gspca_dev);
1560 mutex_unlock(&gspca_dev->usb_lock);
1566 * dequeue a video buffer
1568 * If nonblock_ing is false, block until a buffer is available.
1570 static int vidioc_dqbuf(struct file *file, void *priv,
1571 struct v4l2_buffer *v4l2_buf)
1573 struct gspca_dev *gspca_dev = priv;
1574 struct gspca_frame *frame;
1577 PDEBUG(D_FRAM, "dqbuf");
1578 if (v4l2_buf->memory != gspca_dev->memory)
1581 if (!gspca_dev->present)
1584 /* if not streaming, be sure the application will not loop forever */
1585 if (!(file->f_flags & O_NONBLOCK)
1586 && !gspca_dev->streaming && gspca_dev->users == 1)
1589 /* only the capturing file may dequeue */
1590 if (gspca_dev->capt_file != file)
1593 /* only one dequeue / read at a time */
1594 if (mutex_lock_interruptible(&gspca_dev->read_lock))
1595 return -ERESTARTSYS;
1597 ret = frame_wait(gspca_dev, file->f_flags & O_NONBLOCK);
1600 i = ret; /* frame index */
1601 frame = &gspca_dev->frame[i];
1602 if (gspca_dev->memory == V4L2_MEMORY_USERPTR) {
1603 if (copy_to_user((__u8 __user *) frame->v4l2_buf.m.userptr,
1605 frame->v4l2_buf.bytesused)) {
1606 PDEBUG(D_ERR|D_STREAM,
1607 "dqbuf cp to user failed");
1612 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_DONE;
1613 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1614 PDEBUG(D_FRAM, "dqbuf %d", i);
1617 mutex_unlock(&gspca_dev->read_lock);
1622 * queue a video buffer
1624 * Attempting to queue a buffer that has already been
1625 * queued will return -EINVAL.
1627 static int vidioc_qbuf(struct file *file, void *priv,
1628 struct v4l2_buffer *v4l2_buf)
1630 struct gspca_dev *gspca_dev = priv;
1631 struct gspca_frame *frame;
1634 PDEBUG(D_FRAM, "qbuf %d", v4l2_buf->index);
1636 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1637 return -ERESTARTSYS;
1639 index = v4l2_buf->index;
1640 if ((unsigned) index >= gspca_dev->nframes) {
1642 "qbuf idx %d >= %d", index, gspca_dev->nframes);
1646 if (v4l2_buf->memory != gspca_dev->memory) {
1647 PDEBUG(D_FRAM, "qbuf bad memory type");
1652 frame = &gspca_dev->frame[index];
1653 if (frame->v4l2_buf.flags & BUF_ALL_FLAGS) {
1654 PDEBUG(D_FRAM, "qbuf bad state");
1659 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_QUEUED;
1661 if (frame->v4l2_buf.memory == V4L2_MEMORY_USERPTR) {
1662 frame->v4l2_buf.m.userptr = v4l2_buf->m.userptr;
1663 frame->v4l2_buf.length = v4l2_buf->length;
1666 /* put the buffer in the 'queued' queue */
1667 i = gspca_dev->fr_q;
1668 gspca_dev->fr_queue[i] = index;
1669 gspca_dev->fr_q = (i + 1) % gspca_dev->nframes;
1670 PDEBUG(D_FRAM, "qbuf q:%d i:%d o:%d",
1675 v4l2_buf->flags |= V4L2_BUF_FLAG_QUEUED;
1676 v4l2_buf->flags &= ~V4L2_BUF_FLAG_DONE;
1679 mutex_unlock(&gspca_dev->queue_lock);
1684 * allocate the resources for read()
1686 static int read_alloc(struct gspca_dev *gspca_dev,
1689 struct v4l2_buffer v4l2_buf;
1692 PDEBUG(D_STREAM, "read alloc");
1693 if (gspca_dev->nframes == 0) {
1694 struct v4l2_requestbuffers rb;
1696 memset(&rb, 0, sizeof rb);
1697 rb.count = gspca_dev->nbufread;
1698 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1699 rb.memory = GSPCA_MEMORY_READ;
1700 ret = vidioc_reqbufs(file, gspca_dev, &rb);
1702 PDEBUG(D_STREAM, "read reqbuf err %d", ret);
1705 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1706 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1707 v4l2_buf.memory = GSPCA_MEMORY_READ;
1708 for (i = 0; i < gspca_dev->nbufread; i++) {
1710 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1712 PDEBUG(D_STREAM, "read qbuf err: %d", ret);
1716 gspca_dev->memory = GSPCA_MEMORY_READ;
1719 /* start streaming */
1720 ret = vidioc_streamon(file, gspca_dev, V4L2_BUF_TYPE_VIDEO_CAPTURE);
1722 PDEBUG(D_STREAM, "read streamon err %d", ret);
1726 static unsigned int dev_poll(struct file *file, poll_table *wait)
1728 struct gspca_dev *gspca_dev = file->private_data;
1731 PDEBUG(D_FRAM, "poll");
1733 poll_wait(file, &gspca_dev->wq, wait);
1735 /* if reqbufs is not done, the user would use read() */
1736 if (gspca_dev->nframes == 0) {
1737 if (gspca_dev->memory != GSPCA_MEMORY_NO)
1738 return POLLERR; /* not the 1st time */
1739 ret = read_alloc(gspca_dev, file);
1744 if (mutex_lock_interruptible(&gspca_dev->queue_lock) != 0)
1747 /* check the next incoming buffer */
1748 i = gspca_dev->fr_o;
1749 i = gspca_dev->fr_queue[i];
1750 if (gspca_dev->frame[i].v4l2_buf.flags & V4L2_BUF_FLAG_DONE)
1751 ret = POLLIN | POLLRDNORM; /* something to read */
1754 mutex_unlock(&gspca_dev->queue_lock);
1755 if (!gspca_dev->present)
1760 static ssize_t dev_read(struct file *file, char __user *data,
1761 size_t count, loff_t *ppos)
1763 struct gspca_dev *gspca_dev = file->private_data;
1764 struct gspca_frame *frame;
1765 struct v4l2_buffer v4l2_buf;
1766 struct timeval timestamp;
1769 PDEBUG(D_FRAM, "read (%zd)", count);
1770 if (!gspca_dev->present)
1772 switch (gspca_dev->memory) {
1773 case GSPCA_MEMORY_NO: /* first time */
1774 ret = read_alloc(gspca_dev, file);
1778 case GSPCA_MEMORY_READ:
1779 if (gspca_dev->capt_file == file)
1787 jiffies_to_timeval(get_jiffies_64(), ×tamp);
1791 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1792 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1793 v4l2_buf.memory = GSPCA_MEMORY_READ;
1794 ret = vidioc_dqbuf(file, gspca_dev, &v4l2_buf);
1796 PDEBUG(D_STREAM, "read dqbuf err %d", ret);
1800 /* if the process slept for more than 1 second,
1801 * get a newer frame */
1802 frame = &gspca_dev->frame[v4l2_buf.index];
1804 break; /* avoid infinite loop */
1805 if (frame->v4l2_buf.timestamp.tv_sec >= timestamp.tv_sec)
1807 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1809 PDEBUG(D_STREAM, "read qbuf err %d", ret);
1814 /* copy the frame */
1815 if (count > frame->v4l2_buf.bytesused)
1816 count = frame->v4l2_buf.bytesused;
1817 ret = copy_to_user(data, frame->data, count);
1819 PDEBUG(D_ERR|D_STREAM,
1820 "read cp to user lack %d / %zd", ret, count);
1826 /* in each case, requeue the buffer */
1827 ret2 = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1833 static struct v4l2_file_operations dev_fops = {
1834 .owner = THIS_MODULE,
1836 .release = dev_close,
1839 .unlocked_ioctl = video_ioctl2,
1843 static const struct v4l2_ioctl_ops dev_ioctl_ops = {
1844 .vidioc_querycap = vidioc_querycap,
1845 .vidioc_dqbuf = vidioc_dqbuf,
1846 .vidioc_qbuf = vidioc_qbuf,
1847 .vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
1848 .vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
1849 .vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
1850 .vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
1851 .vidioc_streamon = vidioc_streamon,
1852 .vidioc_queryctrl = vidioc_queryctrl,
1853 .vidioc_g_ctrl = vidioc_g_ctrl,
1854 .vidioc_s_ctrl = vidioc_s_ctrl,
1855 .vidioc_g_audio = vidioc_g_audio,
1856 .vidioc_s_audio = vidioc_s_audio,
1857 .vidioc_enumaudio = vidioc_enumaudio,
1858 .vidioc_querymenu = vidioc_querymenu,
1859 .vidioc_enum_input = vidioc_enum_input,
1860 .vidioc_g_input = vidioc_g_input,
1861 .vidioc_s_input = vidioc_s_input,
1862 .vidioc_reqbufs = vidioc_reqbufs,
1863 .vidioc_querybuf = vidioc_querybuf,
1864 .vidioc_streamoff = vidioc_streamoff,
1865 .vidioc_g_jpegcomp = vidioc_g_jpegcomp,
1866 .vidioc_s_jpegcomp = vidioc_s_jpegcomp,
1867 .vidioc_g_parm = vidioc_g_parm,
1868 .vidioc_s_parm = vidioc_s_parm,
1869 .vidioc_s_std = vidioc_s_std,
1870 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1871 .vidiocgmbuf = vidiocgmbuf,
1875 static struct video_device gspca_template = {
1876 .name = "gspca main driver",
1878 .ioctl_ops = &dev_ioctl_ops,
1879 .release = gspca_release,
1884 * probe and create a new gspca device
1886 * This function must be called by the sub-driver when it is
1887 * called for probing a new device.
1889 int gspca_dev_probe(struct usb_interface *intf,
1890 const struct usb_device_id *id,
1891 const struct sd_desc *sd_desc,
1893 struct module *module)
1895 struct usb_interface_descriptor *interface;
1896 struct gspca_dev *gspca_dev;
1897 struct usb_device *dev = interface_to_usbdev(intf);
1900 PDEBUG(D_PROBE, "probing %04x:%04x", id->idVendor, id->idProduct);
1902 /* we don't handle multi-config cameras */
1903 if (dev->descriptor.bNumConfigurations != 1)
1905 interface = &intf->cur_altsetting->desc;
1906 if (interface->bInterfaceNumber > 0)
1909 /* create the device */
1910 if (dev_size < sizeof *gspca_dev)
1911 dev_size = sizeof *gspca_dev;
1912 gspca_dev = kzalloc(dev_size, GFP_KERNEL);
1914 err("couldn't kzalloc gspca struct");
1917 gspca_dev->usb_buf = kmalloc(USB_BUF_SZ, GFP_KERNEL);
1918 if (!gspca_dev->usb_buf) {
1919 err("out of memory");
1923 gspca_dev->dev = dev;
1924 gspca_dev->iface = interface->bInterfaceNumber;
1925 gspca_dev->nbalt = intf->num_altsetting;
1926 gspca_dev->sd_desc = sd_desc;
1927 gspca_dev->nbufread = 2;
1928 gspca_dev->empty_packet = -1; /* don't check the empty packets */
1930 /* configure the subdriver and initialize the USB device */
1931 ret = sd_desc->config(gspca_dev, id);
1934 ret = sd_desc->init(gspca_dev);
1937 ret = gspca_set_alt0(gspca_dev);
1940 gspca_set_default_mode(gspca_dev);
1942 mutex_init(&gspca_dev->usb_lock);
1943 mutex_init(&gspca_dev->read_lock);
1944 mutex_init(&gspca_dev->queue_lock);
1945 init_waitqueue_head(&gspca_dev->wq);
1947 /* init video stuff */
1948 memcpy(&gspca_dev->vdev, &gspca_template, sizeof gspca_template);
1949 gspca_dev->vdev.parent = &dev->dev;
1950 gspca_dev->module = module;
1951 gspca_dev->present = 1;
1952 ret = video_register_device(&gspca_dev->vdev,
1956 err("video_register_device err %d", ret);
1960 usb_set_intfdata(intf, gspca_dev);
1961 PDEBUG(D_PROBE, "probe ok");
1964 kfree(gspca_dev->usb_buf);
1968 EXPORT_SYMBOL(gspca_dev_probe);
1973 * This function must be called by the sub-driver
1974 * when the device disconnects, after the specific resources are freed.
1976 void gspca_disconnect(struct usb_interface *intf)
1978 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
1980 mutex_lock(&gspca_dev->usb_lock);
1981 gspca_dev->present = 0;
1983 if (gspca_dev->streaming) {
1984 destroy_urbs(gspca_dev);
1985 wake_up_interruptible(&gspca_dev->wq);
1988 /* the device is freed at exit of this function */
1989 gspca_dev->dev = NULL;
1990 mutex_unlock(&gspca_dev->usb_lock);
1992 usb_set_intfdata(intf, NULL);
1994 /* release the device */
1995 /* (this will call gspca_release() immediatly or on last close) */
1996 video_unregister_device(&gspca_dev->vdev);
1998 PDEBUG(D_PROBE, "disconnect complete");
2000 EXPORT_SYMBOL(gspca_disconnect);
2003 int gspca_suspend(struct usb_interface *intf, pm_message_t message)
2005 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2007 if (!gspca_dev->streaming)
2009 gspca_dev->frozen = 1; /* avoid urb error messages */
2010 if (gspca_dev->sd_desc->stopN)
2011 gspca_dev->sd_desc->stopN(gspca_dev);
2012 destroy_urbs(gspca_dev);
2013 gspca_set_alt0(gspca_dev);
2014 if (gspca_dev->sd_desc->stop0)
2015 gspca_dev->sd_desc->stop0(gspca_dev);
2018 EXPORT_SYMBOL(gspca_suspend);
2020 int gspca_resume(struct usb_interface *intf)
2022 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2024 gspca_dev->frozen = 0;
2025 gspca_dev->sd_desc->init(gspca_dev);
2026 if (gspca_dev->streaming)
2027 return gspca_init_transfer(gspca_dev);
2030 EXPORT_SYMBOL(gspca_resume);
2032 /* -- cam driver utility functions -- */
2034 /* auto gain and exposure algorithm based on the knee algorithm described here:
2035 http://ytse.tricolour.net/docs/LowLightOptimization.html
2037 Returns 0 if no changes were made, 1 if the gain and or exposure settings
2039 int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
2040 int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee)
2042 int i, steps, gain, orig_gain, exposure, orig_exposure, autogain;
2043 const struct ctrl *gain_ctrl = NULL;
2044 const struct ctrl *exposure_ctrl = NULL;
2045 const struct ctrl *autogain_ctrl = NULL;
2048 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
2049 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_GAIN)
2050 gain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2051 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_EXPOSURE)
2052 exposure_ctrl = &gspca_dev->sd_desc->ctrls[i];
2053 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_AUTOGAIN)
2054 autogain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2056 if (!gain_ctrl || !exposure_ctrl || !autogain_ctrl) {
2057 PDEBUG(D_ERR, "Error: gspca_auto_gain_n_exposure called "
2058 "on cam without (auto)gain/exposure");
2062 if (gain_ctrl->get(gspca_dev, &gain) ||
2063 exposure_ctrl->get(gspca_dev, &exposure) ||
2064 autogain_ctrl->get(gspca_dev, &autogain) || !autogain)
2068 orig_exposure = exposure;
2070 /* If we are of a multiple of deadzone, do multiple steps to reach the
2071 desired lumination fast (with the risc of a slight overshoot) */
2072 steps = abs(desired_avg_lum - avg_lum) / deadzone;
2074 PDEBUG(D_FRAM, "autogain: lum: %d, desired: %d, steps: %d",
2075 avg_lum, desired_avg_lum, steps);
2077 for (i = 0; i < steps; i++) {
2078 if (avg_lum > desired_avg_lum) {
2079 if (gain > gain_knee)
2081 else if (exposure > exposure_knee)
2083 else if (gain > gain_ctrl->qctrl.default_value)
2085 else if (exposure > exposure_ctrl->qctrl.minimum)
2087 else if (gain > gain_ctrl->qctrl.minimum)
2092 if (gain < gain_ctrl->qctrl.default_value)
2094 else if (exposure < exposure_knee)
2096 else if (gain < gain_knee)
2098 else if (exposure < exposure_ctrl->qctrl.maximum)
2100 else if (gain < gain_ctrl->qctrl.maximum)
2107 if (gain != orig_gain) {
2108 gain_ctrl->set(gspca_dev, gain);
2111 if (exposure != orig_exposure) {
2112 exposure_ctrl->set(gspca_dev, exposure);
2118 EXPORT_SYMBOL(gspca_auto_gain_n_exposure);
2120 /* -- module insert / remove -- */
2121 static int __init gspca_init(void)
2123 info("main v%d.%d.%d registered",
2124 (DRIVER_VERSION_NUMBER >> 16) & 0xff,
2125 (DRIVER_VERSION_NUMBER >> 8) & 0xff,
2126 DRIVER_VERSION_NUMBER & 0xff);
2129 static void __exit gspca_exit(void)
2131 info("main deregistered");
2134 module_init(gspca_init);
2135 module_exit(gspca_exit);
2138 module_param_named(debug, gspca_debug, int, 0644);
2139 MODULE_PARM_DESC(debug,
2140 "Debug (bit) 0x01:error 0x02:probe 0x04:config"
2141 " 0x08:stream 0x10:frame 0x20:packet 0x40:USBin 0x80:USBout"