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->description[0] = fmtdesc->pixelformat & 0xff;
769 fmtdesc->description[1] = (fmtdesc->pixelformat >> 8) & 0xff;
770 fmtdesc->description[2] = (fmtdesc->pixelformat >> 16) & 0xff;
771 fmtdesc->description[3] = fmtdesc->pixelformat >> 24;
772 fmtdesc->description[4] = '\0';
776 static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
777 struct v4l2_format *fmt)
779 struct gspca_dev *gspca_dev = priv;
782 mode = gspca_dev->curr_mode;
783 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
784 sizeof fmt->fmt.pix);
788 static int try_fmt_vid_cap(struct gspca_dev *gspca_dev,
789 struct v4l2_format *fmt)
791 int w, h, mode, mode2;
793 w = fmt->fmt.pix.width;
794 h = fmt->fmt.pix.height;
797 if (gspca_debug & D_CONF)
798 PDEBUG_MODE("try fmt cap", fmt->fmt.pix.pixelformat, w, h);
800 /* search the closest mode for width and height */
801 mode = wxh_to_mode(gspca_dev, w, h);
803 /* OK if right palette */
804 if (gspca_dev->cam.cam_mode[mode].pixelformat
805 != fmt->fmt.pix.pixelformat) {
807 /* else, search the closest mode with the same pixel format */
808 mode2 = gspca_get_mode(gspca_dev, mode,
809 fmt->fmt.pix.pixelformat);
813 ; * no chance, return this mode */
815 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
816 sizeof fmt->fmt.pix);
817 return mode; /* used when s_fmt */
820 static int vidioc_try_fmt_vid_cap(struct file *file,
822 struct v4l2_format *fmt)
824 struct gspca_dev *gspca_dev = priv;
827 ret = try_fmt_vid_cap(gspca_dev, fmt);
833 static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
834 struct v4l2_format *fmt)
836 struct gspca_dev *gspca_dev = priv;
839 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
842 ret = try_fmt_vid_cap(gspca_dev, fmt);
846 if (gspca_dev->nframes != 0
847 && fmt->fmt.pix.sizeimage > gspca_dev->frsz) {
852 if (ret == gspca_dev->curr_mode) {
854 goto out; /* same mode */
857 if (gspca_dev->streaming) {
861 gspca_dev->width = fmt->fmt.pix.width;
862 gspca_dev->height = fmt->fmt.pix.height;
863 gspca_dev->pixfmt = fmt->fmt.pix.pixelformat;
864 gspca_dev->curr_mode = ret;
868 mutex_unlock(&gspca_dev->queue_lock);
872 static void gspca_release(struct video_device *vfd)
874 struct gspca_dev *gspca_dev = container_of(vfd, struct gspca_dev, vdev);
876 PDEBUG(D_STREAM, "device released");
878 kfree(gspca_dev->usb_buf);
882 static int dev_open(struct file *file)
884 struct gspca_dev *gspca_dev;
887 PDEBUG(D_STREAM, "%s open", current->comm);
888 gspca_dev = (struct gspca_dev *) video_devdata(file);
889 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
891 if (!gspca_dev->present) {
896 if (gspca_dev->users > 4) { /* (arbitrary value) */
901 /* protect the subdriver against rmmod */
902 if (!try_module_get(gspca_dev->module)) {
909 file->private_data = gspca_dev;
911 /* activate the v4l2 debug */
912 if (gspca_debug & D_V4L2)
913 gspca_dev->vdev.debug |= V4L2_DEBUG_IOCTL
914 | V4L2_DEBUG_IOCTL_ARG;
916 gspca_dev->vdev.debug &= ~(V4L2_DEBUG_IOCTL
917 | V4L2_DEBUG_IOCTL_ARG);
921 mutex_unlock(&gspca_dev->queue_lock);
923 PDEBUG(D_ERR|D_STREAM, "open failed err %d", ret);
925 PDEBUG(D_STREAM, "open done");
929 static int dev_close(struct file *file)
931 struct gspca_dev *gspca_dev = file->private_data;
933 PDEBUG(D_STREAM, "%s close", current->comm);
934 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
938 /* if the file did the capture, free the streaming resources */
939 if (gspca_dev->capt_file == file) {
940 if (gspca_dev->streaming) {
941 mutex_lock(&gspca_dev->usb_lock);
942 gspca_stream_off(gspca_dev);
943 mutex_unlock(&gspca_dev->usb_lock);
945 frame_free(gspca_dev);
946 gspca_dev->capt_file = NULL;
947 gspca_dev->memory = GSPCA_MEMORY_NO;
949 file->private_data = NULL;
950 module_put(gspca_dev->module);
951 mutex_unlock(&gspca_dev->queue_lock);
953 PDEBUG(D_STREAM, "close done");
958 static int vidioc_querycap(struct file *file, void *priv,
959 struct v4l2_capability *cap)
961 struct gspca_dev *gspca_dev = priv;
964 /* protect the access to the usb device */
965 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
967 if (!gspca_dev->present) {
971 strncpy(cap->driver, gspca_dev->sd_desc->name, sizeof cap->driver);
972 if (gspca_dev->dev->product != NULL) {
973 strncpy(cap->card, gspca_dev->dev->product,
976 snprintf(cap->card, sizeof cap->card,
977 "USB Camera (%04x:%04x)",
978 le16_to_cpu(gspca_dev->dev->descriptor.idVendor),
979 le16_to_cpu(gspca_dev->dev->descriptor.idProduct));
981 usb_make_path(gspca_dev->dev, cap->bus_info, sizeof(cap->bus_info));
982 cap->version = DRIVER_VERSION_NUMBER;
983 cap->capabilities = V4L2_CAP_VIDEO_CAPTURE
985 | V4L2_CAP_READWRITE;
988 mutex_unlock(&gspca_dev->usb_lock);
992 static int vidioc_queryctrl(struct file *file, void *priv,
993 struct v4l2_queryctrl *q_ctrl)
995 struct gspca_dev *gspca_dev = priv;
1001 if (id & V4L2_CTRL_FLAG_NEXT_CTRL) {
1002 id &= V4L2_CTRL_ID_MASK;
1004 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
1005 if (gspca_dev->sd_desc->ctrls[i].qctrl.id < id)
1011 if (gspca_dev->sd_desc->ctrls[i].qctrl.id
1012 > gspca_dev->sd_desc->ctrls[ix].qctrl.id)
1017 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
1018 if (id == gspca_dev->sd_desc->ctrls[i].qctrl.id) {
1025 memcpy(q_ctrl, &gspca_dev->sd_desc->ctrls[ix].qctrl,
1027 if (gspca_dev->ctrl_dis & (1 << ix))
1028 q_ctrl->flags |= V4L2_CTRL_FLAG_DISABLED;
1032 static int vidioc_s_ctrl(struct file *file, void *priv,
1033 struct v4l2_control *ctrl)
1035 struct gspca_dev *gspca_dev = priv;
1036 const struct ctrl *ctrls;
1039 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
1040 i < gspca_dev->sd_desc->nctrls;
1042 if (ctrl->id != ctrls->qctrl.id)
1044 if (gspca_dev->ctrl_dis & (1 << i))
1046 if (ctrl->value < ctrls->qctrl.minimum
1047 || ctrl->value > ctrls->qctrl.maximum)
1049 PDEBUG(D_CONF, "set ctrl [%08x] = %d", ctrl->id, ctrl->value);
1050 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1051 return -ERESTARTSYS;
1052 if (gspca_dev->present)
1053 ret = ctrls->set(gspca_dev, ctrl->value);
1056 mutex_unlock(&gspca_dev->usb_lock);
1062 static int vidioc_g_ctrl(struct file *file, void *priv,
1063 struct v4l2_control *ctrl)
1065 struct gspca_dev *gspca_dev = priv;
1067 const struct ctrl *ctrls;
1070 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
1071 i < gspca_dev->sd_desc->nctrls;
1073 if (ctrl->id != ctrls->qctrl.id)
1075 if (gspca_dev->ctrl_dis & (1 << i))
1077 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1078 return -ERESTARTSYS;
1079 if (gspca_dev->present)
1080 ret = ctrls->get(gspca_dev, &ctrl->value);
1083 mutex_unlock(&gspca_dev->usb_lock);
1089 /*fixme: have an audio flag in gspca_dev?*/
1090 static int vidioc_s_audio(struct file *file, void *priv,
1091 struct v4l2_audio *audio)
1093 if (audio->index != 0)
1098 static int vidioc_g_audio(struct file *file, void *priv,
1099 struct v4l2_audio *audio)
1101 strcpy(audio->name, "Microphone");
1105 static int vidioc_enumaudio(struct file *file, void *priv,
1106 struct v4l2_audio *audio)
1108 if (audio->index != 0)
1111 strcpy(audio->name, "Microphone");
1112 audio->capability = 0;
1117 static int vidioc_querymenu(struct file *file, void *priv,
1118 struct v4l2_querymenu *qmenu)
1120 struct gspca_dev *gspca_dev = priv;
1122 if (!gspca_dev->sd_desc->querymenu)
1124 return gspca_dev->sd_desc->querymenu(gspca_dev, qmenu);
1127 static int vidioc_enum_input(struct file *file, void *priv,
1128 struct v4l2_input *input)
1130 struct gspca_dev *gspca_dev = priv;
1132 if (input->index != 0)
1134 input->type = V4L2_INPUT_TYPE_CAMERA;
1135 input->status = gspca_dev->cam.input_flags;
1136 strncpy(input->name, gspca_dev->sd_desc->name,
1137 sizeof input->name);
1141 static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
1147 static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
1154 static int vidioc_reqbufs(struct file *file, void *priv,
1155 struct v4l2_requestbuffers *rb)
1157 struct gspca_dev *gspca_dev = priv;
1160 switch (rb->memory) {
1161 case GSPCA_MEMORY_READ: /* (internal call) */
1162 case V4L2_MEMORY_MMAP:
1163 case V4L2_MEMORY_USERPTR:
1168 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1169 return -ERESTARTSYS;
1171 if (gspca_dev->memory != GSPCA_MEMORY_NO
1172 && gspca_dev->memory != rb->memory) {
1177 /* only one file may do the capture */
1178 if (gspca_dev->capt_file != NULL
1179 && gspca_dev->capt_file != file) {
1184 /* if allocated, the buffers must not be mapped */
1185 for (i = 0; i < gspca_dev->nframes; i++) {
1186 if (gspca_dev->frame[i].vma_use_count) {
1192 /* stop streaming */
1193 if (gspca_dev->streaming) {
1194 mutex_lock(&gspca_dev->usb_lock);
1195 gspca_stream_off(gspca_dev);
1196 mutex_unlock(&gspca_dev->usb_lock);
1199 /* free the previous allocated buffers, if any */
1200 if (gspca_dev->nframes != 0) {
1201 frame_free(gspca_dev);
1202 gspca_dev->capt_file = NULL;
1204 if (rb->count == 0) /* unrequest */
1206 gspca_dev->memory = rb->memory;
1207 ret = frame_alloc(gspca_dev, rb->count);
1209 rb->count = gspca_dev->nframes;
1210 gspca_dev->capt_file = file;
1213 mutex_unlock(&gspca_dev->queue_lock);
1214 PDEBUG(D_STREAM, "reqbufs st:%d c:%d", ret, rb->count);
1218 static int vidioc_querybuf(struct file *file, void *priv,
1219 struct v4l2_buffer *v4l2_buf)
1221 struct gspca_dev *gspca_dev = priv;
1222 struct gspca_frame *frame;
1224 if (v4l2_buf->index < 0
1225 || v4l2_buf->index >= gspca_dev->nframes)
1228 frame = &gspca_dev->frame[v4l2_buf->index];
1229 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1233 static int vidioc_streamon(struct file *file, void *priv,
1234 enum v4l2_buf_type buf_type)
1236 struct gspca_dev *gspca_dev = priv;
1239 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1241 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1242 return -ERESTARTSYS;
1244 if (gspca_dev->nframes == 0
1245 || !(gspca_dev->frame[0].v4l2_buf.flags & V4L2_BUF_FLAG_QUEUED)) {
1249 if (!gspca_dev->streaming) {
1250 ret = gspca_init_transfer(gspca_dev);
1255 if (gspca_debug & D_STREAM) {
1256 PDEBUG_MODE("stream on OK",
1264 mutex_unlock(&gspca_dev->queue_lock);
1268 static int vidioc_streamoff(struct file *file, void *priv,
1269 enum v4l2_buf_type buf_type)
1271 struct gspca_dev *gspca_dev = priv;
1274 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1276 if (!gspca_dev->streaming)
1278 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1279 return -ERESTARTSYS;
1281 /* stop streaming */
1282 if (mutex_lock_interruptible(&gspca_dev->usb_lock)) {
1286 gspca_stream_off(gspca_dev);
1287 mutex_unlock(&gspca_dev->usb_lock);
1289 /* empty the application queues */
1290 for (i = 0; i < gspca_dev->nframes; i++)
1291 gspca_dev->frame[i].v4l2_buf.flags &= ~BUF_ALL_FLAGS;
1292 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
1293 gspca_dev->last_packet_type = DISCARD_PACKET;
1294 gspca_dev->sequence = 0;
1297 mutex_unlock(&gspca_dev->queue_lock);
1301 static int vidioc_g_jpegcomp(struct file *file, void *priv,
1302 struct v4l2_jpegcompression *jpegcomp)
1304 struct gspca_dev *gspca_dev = priv;
1307 if (!gspca_dev->sd_desc->get_jcomp)
1309 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1310 return -ERESTARTSYS;
1311 if (gspca_dev->present)
1312 ret = gspca_dev->sd_desc->get_jcomp(gspca_dev, jpegcomp);
1315 mutex_unlock(&gspca_dev->usb_lock);
1319 static int vidioc_s_jpegcomp(struct file *file, void *priv,
1320 struct v4l2_jpegcompression *jpegcomp)
1322 struct gspca_dev *gspca_dev = priv;
1325 if (!gspca_dev->sd_desc->set_jcomp)
1327 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1328 return -ERESTARTSYS;
1329 if (gspca_dev->present)
1330 ret = gspca_dev->sd_desc->set_jcomp(gspca_dev, jpegcomp);
1333 mutex_unlock(&gspca_dev->usb_lock);
1337 static int vidioc_g_parm(struct file *filp, void *priv,
1338 struct v4l2_streamparm *parm)
1340 struct gspca_dev *gspca_dev = priv;
1342 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1344 if (gspca_dev->sd_desc->get_streamparm) {
1347 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1348 return -ERESTARTSYS;
1349 if (gspca_dev->present)
1350 ret = gspca_dev->sd_desc->get_streamparm(gspca_dev,
1354 mutex_unlock(&gspca_dev->usb_lock);
1361 static int vidioc_s_parm(struct file *filp, void *priv,
1362 struct v4l2_streamparm *parm)
1364 struct gspca_dev *gspca_dev = priv;
1367 n = parm->parm.capture.readbuffers;
1368 if (n == 0 || n > GSPCA_MAX_FRAMES)
1369 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1371 gspca_dev->nbufread = n;
1373 if (gspca_dev->sd_desc->set_streamparm) {
1376 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1377 return -ERESTARTSYS;
1378 if (gspca_dev->present)
1379 ret = gspca_dev->sd_desc->set_streamparm(gspca_dev,
1383 mutex_unlock(&gspca_dev->usb_lock);
1390 static int vidioc_s_std(struct file *filp, void *priv,
1396 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1397 static int vidiocgmbuf(struct file *file, void *priv,
1398 struct video_mbuf *mbuf)
1400 struct gspca_dev *gspca_dev = file->private_data;
1403 PDEBUG(D_STREAM, "cgmbuf");
1404 if (gspca_dev->nframes == 0) {
1408 struct v4l2_format fmt;
1410 fmt.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1411 i = gspca_dev->cam.nmodes - 1; /* highest mode */
1412 fmt.fmt.pix.width = gspca_dev->cam.cam_mode[i].width;
1413 fmt.fmt.pix.height = gspca_dev->cam.cam_mode[i].height;
1414 fmt.fmt.pix.pixelformat = V4L2_PIX_FMT_BGR24;
1415 ret = vidioc_s_fmt_vid_cap(file, priv, &fmt);
1420 struct v4l2_requestbuffers rb;
1422 memset(&rb, 0, sizeof rb);
1424 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1425 rb.memory = V4L2_MEMORY_MMAP;
1426 ret = vidioc_reqbufs(file, priv, &rb);
1431 mbuf->frames = gspca_dev->nframes;
1432 mbuf->size = gspca_dev->frsz * gspca_dev->nframes;
1433 for (i = 0; i < mbuf->frames; i++)
1434 mbuf->offsets[i] = gspca_dev->frame[i].v4l2_buf.m.offset;
1439 static int dev_mmap(struct file *file, struct vm_area_struct *vma)
1441 struct gspca_dev *gspca_dev = file->private_data;
1442 struct gspca_frame *frame;
1444 unsigned long addr, start, size;
1447 start = vma->vm_start;
1448 size = vma->vm_end - vma->vm_start;
1449 PDEBUG(D_STREAM, "mmap start:%08x size:%d", (int) start, (int) size);
1451 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1452 return -ERESTARTSYS;
1453 if (!gspca_dev->present) {
1457 if (gspca_dev->capt_file != file) {
1463 for (i = 0; i < gspca_dev->nframes; ++i) {
1464 if (gspca_dev->frame[i].v4l2_buf.memory != V4L2_MEMORY_MMAP) {
1465 PDEBUG(D_STREAM, "mmap bad memory type");
1468 if ((gspca_dev->frame[i].v4l2_buf.m.offset >> PAGE_SHIFT)
1470 frame = &gspca_dev->frame[i];
1474 if (frame == NULL) {
1475 PDEBUG(D_STREAM, "mmap no frame buffer found");
1479 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1480 /* v4l1 maps all the buffers */
1482 || size != frame->v4l2_buf.length * gspca_dev->nframes)
1484 if (size != frame->v4l2_buf.length) {
1485 PDEBUG(D_STREAM, "mmap bad size");
1491 * - VM_IO marks the area as being a mmaped region for I/O to a
1492 * device. It also prevents the region from being core dumped.
1494 vma->vm_flags |= VM_IO;
1496 addr = (unsigned long) frame->data;
1498 page = vmalloc_to_page((void *) addr);
1499 ret = vm_insert_page(vma, start, page);
1507 vma->vm_ops = &gspca_vm_ops;
1508 vma->vm_private_data = frame;
1512 mutex_unlock(&gspca_dev->queue_lock);
1517 * wait for a video frame
1519 * If a frame is ready, its index is returned.
1521 static int frame_wait(struct gspca_dev *gspca_dev,
1524 struct gspca_frame *frame;
1527 /* check if a frame is ready */
1528 i = gspca_dev->fr_o;
1529 j = gspca_dev->fr_queue[i];
1530 frame = &gspca_dev->frame[j];
1532 if (!(frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE)) {
1536 /* wait till a frame is ready */
1537 ret = wait_event_interruptible_timeout(gspca_dev->wq,
1538 (frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE) ||
1539 !gspca_dev->streaming || !gspca_dev->present,
1540 msecs_to_jiffies(3000));
1543 if (ret == 0 || !gspca_dev->streaming || !gspca_dev->present)
1547 gspca_dev->fr_o = (i + 1) % gspca_dev->nframes;
1548 PDEBUG(D_FRAM, "frame wait q:%d i:%d o:%d",
1553 if (gspca_dev->sd_desc->dq_callback) {
1554 mutex_lock(&gspca_dev->usb_lock);
1555 if (gspca_dev->present)
1556 gspca_dev->sd_desc->dq_callback(gspca_dev);
1557 mutex_unlock(&gspca_dev->usb_lock);
1563 * dequeue a video buffer
1565 * If nonblock_ing is false, block until a buffer is available.
1567 static int vidioc_dqbuf(struct file *file, void *priv,
1568 struct v4l2_buffer *v4l2_buf)
1570 struct gspca_dev *gspca_dev = priv;
1571 struct gspca_frame *frame;
1574 PDEBUG(D_FRAM, "dqbuf");
1575 if (v4l2_buf->memory != gspca_dev->memory)
1578 if (!gspca_dev->present)
1581 /* if not streaming, be sure the application will not loop forever */
1582 if (!(file->f_flags & O_NONBLOCK)
1583 && !gspca_dev->streaming && gspca_dev->users == 1)
1586 /* only the capturing file may dequeue */
1587 if (gspca_dev->capt_file != file)
1590 /* only one dequeue / read at a time */
1591 if (mutex_lock_interruptible(&gspca_dev->read_lock))
1592 return -ERESTARTSYS;
1594 ret = frame_wait(gspca_dev, file->f_flags & O_NONBLOCK);
1597 i = ret; /* frame index */
1598 frame = &gspca_dev->frame[i];
1599 if (gspca_dev->memory == V4L2_MEMORY_USERPTR) {
1600 if (copy_to_user((__u8 __user *) frame->v4l2_buf.m.userptr,
1602 frame->v4l2_buf.bytesused)) {
1603 PDEBUG(D_ERR|D_STREAM,
1604 "dqbuf cp to user failed");
1609 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_DONE;
1610 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1611 PDEBUG(D_FRAM, "dqbuf %d", i);
1614 mutex_unlock(&gspca_dev->read_lock);
1619 * queue a video buffer
1621 * Attempting to queue a buffer that has already been
1622 * queued will return -EINVAL.
1624 static int vidioc_qbuf(struct file *file, void *priv,
1625 struct v4l2_buffer *v4l2_buf)
1627 struct gspca_dev *gspca_dev = priv;
1628 struct gspca_frame *frame;
1631 PDEBUG(D_FRAM, "qbuf %d", v4l2_buf->index);
1633 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1634 return -ERESTARTSYS;
1636 index = v4l2_buf->index;
1637 if ((unsigned) index >= gspca_dev->nframes) {
1639 "qbuf idx %d >= %d", index, gspca_dev->nframes);
1643 if (v4l2_buf->memory != gspca_dev->memory) {
1644 PDEBUG(D_FRAM, "qbuf bad memory type");
1649 frame = &gspca_dev->frame[index];
1650 if (frame->v4l2_buf.flags & BUF_ALL_FLAGS) {
1651 PDEBUG(D_FRAM, "qbuf bad state");
1656 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_QUEUED;
1658 if (frame->v4l2_buf.memory == V4L2_MEMORY_USERPTR) {
1659 frame->v4l2_buf.m.userptr = v4l2_buf->m.userptr;
1660 frame->v4l2_buf.length = v4l2_buf->length;
1663 /* put the buffer in the 'queued' queue */
1664 i = gspca_dev->fr_q;
1665 gspca_dev->fr_queue[i] = index;
1666 gspca_dev->fr_q = (i + 1) % gspca_dev->nframes;
1667 PDEBUG(D_FRAM, "qbuf q:%d i:%d o:%d",
1672 v4l2_buf->flags |= V4L2_BUF_FLAG_QUEUED;
1673 v4l2_buf->flags &= ~V4L2_BUF_FLAG_DONE;
1676 mutex_unlock(&gspca_dev->queue_lock);
1681 * allocate the resources for read()
1683 static int read_alloc(struct gspca_dev *gspca_dev,
1686 struct v4l2_buffer v4l2_buf;
1689 PDEBUG(D_STREAM, "read alloc");
1690 if (gspca_dev->nframes == 0) {
1691 struct v4l2_requestbuffers rb;
1693 memset(&rb, 0, sizeof rb);
1694 rb.count = gspca_dev->nbufread;
1695 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1696 rb.memory = GSPCA_MEMORY_READ;
1697 ret = vidioc_reqbufs(file, gspca_dev, &rb);
1699 PDEBUG(D_STREAM, "read reqbuf err %d", ret);
1702 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1703 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1704 v4l2_buf.memory = GSPCA_MEMORY_READ;
1705 for (i = 0; i < gspca_dev->nbufread; i++) {
1707 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1709 PDEBUG(D_STREAM, "read qbuf err: %d", ret);
1713 gspca_dev->memory = GSPCA_MEMORY_READ;
1716 /* start streaming */
1717 ret = vidioc_streamon(file, gspca_dev, V4L2_BUF_TYPE_VIDEO_CAPTURE);
1719 PDEBUG(D_STREAM, "read streamon err %d", ret);
1723 static unsigned int dev_poll(struct file *file, poll_table *wait)
1725 struct gspca_dev *gspca_dev = file->private_data;
1728 PDEBUG(D_FRAM, "poll");
1730 poll_wait(file, &gspca_dev->wq, wait);
1732 /* if reqbufs is not done, the user would use read() */
1733 if (gspca_dev->nframes == 0) {
1734 if (gspca_dev->memory != GSPCA_MEMORY_NO)
1735 return POLLERR; /* not the 1st time */
1736 ret = read_alloc(gspca_dev, file);
1741 if (mutex_lock_interruptible(&gspca_dev->queue_lock) != 0)
1744 /* check the next incoming buffer */
1745 i = gspca_dev->fr_o;
1746 i = gspca_dev->fr_queue[i];
1747 if (gspca_dev->frame[i].v4l2_buf.flags & V4L2_BUF_FLAG_DONE)
1748 ret = POLLIN | POLLRDNORM; /* something to read */
1751 mutex_unlock(&gspca_dev->queue_lock);
1752 if (!gspca_dev->present)
1757 static ssize_t dev_read(struct file *file, char __user *data,
1758 size_t count, loff_t *ppos)
1760 struct gspca_dev *gspca_dev = file->private_data;
1761 struct gspca_frame *frame;
1762 struct v4l2_buffer v4l2_buf;
1763 struct timeval timestamp;
1766 PDEBUG(D_FRAM, "read (%zd)", count);
1767 if (!gspca_dev->present)
1769 switch (gspca_dev->memory) {
1770 case GSPCA_MEMORY_NO: /* first time */
1771 ret = read_alloc(gspca_dev, file);
1775 case GSPCA_MEMORY_READ:
1776 if (gspca_dev->capt_file == file)
1784 jiffies_to_timeval(get_jiffies_64(), ×tamp);
1788 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1789 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1790 v4l2_buf.memory = GSPCA_MEMORY_READ;
1791 ret = vidioc_dqbuf(file, gspca_dev, &v4l2_buf);
1793 PDEBUG(D_STREAM, "read dqbuf err %d", ret);
1797 /* if the process slept for more than 1 second,
1798 * get a newer frame */
1799 frame = &gspca_dev->frame[v4l2_buf.index];
1801 break; /* avoid infinite loop */
1802 if (frame->v4l2_buf.timestamp.tv_sec >= timestamp.tv_sec)
1804 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1806 PDEBUG(D_STREAM, "read qbuf err %d", ret);
1811 /* copy the frame */
1812 if (count > frame->v4l2_buf.bytesused)
1813 count = frame->v4l2_buf.bytesused;
1814 ret = copy_to_user(data, frame->data, count);
1816 PDEBUG(D_ERR|D_STREAM,
1817 "read cp to user lack %d / %zd", ret, count);
1823 /* in each case, requeue the buffer */
1824 ret2 = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1830 static struct v4l2_file_operations dev_fops = {
1831 .owner = THIS_MODULE,
1833 .release = dev_close,
1836 .unlocked_ioctl = video_ioctl2,
1840 static const struct v4l2_ioctl_ops dev_ioctl_ops = {
1841 .vidioc_querycap = vidioc_querycap,
1842 .vidioc_dqbuf = vidioc_dqbuf,
1843 .vidioc_qbuf = vidioc_qbuf,
1844 .vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
1845 .vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
1846 .vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
1847 .vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
1848 .vidioc_streamon = vidioc_streamon,
1849 .vidioc_queryctrl = vidioc_queryctrl,
1850 .vidioc_g_ctrl = vidioc_g_ctrl,
1851 .vidioc_s_ctrl = vidioc_s_ctrl,
1852 .vidioc_g_audio = vidioc_g_audio,
1853 .vidioc_s_audio = vidioc_s_audio,
1854 .vidioc_enumaudio = vidioc_enumaudio,
1855 .vidioc_querymenu = vidioc_querymenu,
1856 .vidioc_enum_input = vidioc_enum_input,
1857 .vidioc_g_input = vidioc_g_input,
1858 .vidioc_s_input = vidioc_s_input,
1859 .vidioc_reqbufs = vidioc_reqbufs,
1860 .vidioc_querybuf = vidioc_querybuf,
1861 .vidioc_streamoff = vidioc_streamoff,
1862 .vidioc_g_jpegcomp = vidioc_g_jpegcomp,
1863 .vidioc_s_jpegcomp = vidioc_s_jpegcomp,
1864 .vidioc_g_parm = vidioc_g_parm,
1865 .vidioc_s_parm = vidioc_s_parm,
1866 .vidioc_s_std = vidioc_s_std,
1867 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1868 .vidiocgmbuf = vidiocgmbuf,
1872 static struct video_device gspca_template = {
1873 .name = "gspca main driver",
1875 .ioctl_ops = &dev_ioctl_ops,
1876 .release = gspca_release,
1881 * probe and create a new gspca device
1883 * This function must be called by the sub-driver when it is
1884 * called for probing a new device.
1886 int gspca_dev_probe(struct usb_interface *intf,
1887 const struct usb_device_id *id,
1888 const struct sd_desc *sd_desc,
1890 struct module *module)
1892 struct usb_interface_descriptor *interface;
1893 struct gspca_dev *gspca_dev;
1894 struct usb_device *dev = interface_to_usbdev(intf);
1897 PDEBUG(D_PROBE, "probing %04x:%04x", id->idVendor, id->idProduct);
1899 /* we don't handle multi-config cameras */
1900 if (dev->descriptor.bNumConfigurations != 1)
1902 interface = &intf->cur_altsetting->desc;
1903 if (interface->bInterfaceNumber > 0)
1906 /* create the device */
1907 if (dev_size < sizeof *gspca_dev)
1908 dev_size = sizeof *gspca_dev;
1909 gspca_dev = kzalloc(dev_size, GFP_KERNEL);
1911 err("couldn't kzalloc gspca struct");
1914 gspca_dev->usb_buf = kmalloc(USB_BUF_SZ, GFP_KERNEL);
1915 if (!gspca_dev->usb_buf) {
1916 err("out of memory");
1920 gspca_dev->dev = dev;
1921 gspca_dev->iface = interface->bInterfaceNumber;
1922 gspca_dev->nbalt = intf->num_altsetting;
1923 gspca_dev->sd_desc = sd_desc;
1924 gspca_dev->nbufread = 2;
1925 gspca_dev->empty_packet = -1; /* don't check the empty packets */
1927 /* configure the subdriver and initialize the USB device */
1928 ret = sd_desc->config(gspca_dev, id);
1931 ret = sd_desc->init(gspca_dev);
1934 ret = gspca_set_alt0(gspca_dev);
1937 gspca_set_default_mode(gspca_dev);
1939 mutex_init(&gspca_dev->usb_lock);
1940 mutex_init(&gspca_dev->read_lock);
1941 mutex_init(&gspca_dev->queue_lock);
1942 init_waitqueue_head(&gspca_dev->wq);
1944 /* init video stuff */
1945 memcpy(&gspca_dev->vdev, &gspca_template, sizeof gspca_template);
1946 gspca_dev->vdev.parent = &dev->dev;
1947 gspca_dev->module = module;
1948 gspca_dev->present = 1;
1949 ret = video_register_device(&gspca_dev->vdev,
1953 err("video_register_device err %d", ret);
1957 usb_set_intfdata(intf, gspca_dev);
1958 PDEBUG(D_PROBE, "probe ok");
1961 kfree(gspca_dev->usb_buf);
1965 EXPORT_SYMBOL(gspca_dev_probe);
1970 * This function must be called by the sub-driver
1971 * when the device disconnects, after the specific resources are freed.
1973 void gspca_disconnect(struct usb_interface *intf)
1975 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
1977 mutex_lock(&gspca_dev->usb_lock);
1978 gspca_dev->present = 0;
1980 if (gspca_dev->streaming) {
1981 destroy_urbs(gspca_dev);
1982 wake_up_interruptible(&gspca_dev->wq);
1985 /* the device is freed at exit of this function */
1986 gspca_dev->dev = NULL;
1987 mutex_unlock(&gspca_dev->usb_lock);
1989 usb_set_intfdata(intf, NULL);
1991 /* release the device */
1992 /* (this will call gspca_release() immediatly or on last close) */
1993 video_unregister_device(&gspca_dev->vdev);
1995 PDEBUG(D_PROBE, "disconnect complete");
1997 EXPORT_SYMBOL(gspca_disconnect);
2000 int gspca_suspend(struct usb_interface *intf, pm_message_t message)
2002 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2004 if (!gspca_dev->streaming)
2006 gspca_dev->frozen = 1; /* avoid urb error messages */
2007 if (gspca_dev->sd_desc->stopN)
2008 gspca_dev->sd_desc->stopN(gspca_dev);
2009 destroy_urbs(gspca_dev);
2010 gspca_set_alt0(gspca_dev);
2011 if (gspca_dev->sd_desc->stop0)
2012 gspca_dev->sd_desc->stop0(gspca_dev);
2015 EXPORT_SYMBOL(gspca_suspend);
2017 int gspca_resume(struct usb_interface *intf)
2019 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2021 gspca_dev->frozen = 0;
2022 gspca_dev->sd_desc->init(gspca_dev);
2023 if (gspca_dev->streaming)
2024 return gspca_init_transfer(gspca_dev);
2027 EXPORT_SYMBOL(gspca_resume);
2029 /* -- cam driver utility functions -- */
2031 /* auto gain and exposure algorithm based on the knee algorithm described here:
2032 http://ytse.tricolour.net/docs/LowLightOptimization.html
2034 Returns 0 if no changes were made, 1 if the gain and or exposure settings
2036 int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
2037 int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee)
2039 int i, steps, gain, orig_gain, exposure, orig_exposure, autogain;
2040 const struct ctrl *gain_ctrl = NULL;
2041 const struct ctrl *exposure_ctrl = NULL;
2042 const struct ctrl *autogain_ctrl = NULL;
2045 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
2046 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_GAIN)
2047 gain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2048 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_EXPOSURE)
2049 exposure_ctrl = &gspca_dev->sd_desc->ctrls[i];
2050 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_AUTOGAIN)
2051 autogain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2053 if (!gain_ctrl || !exposure_ctrl || !autogain_ctrl) {
2054 PDEBUG(D_ERR, "Error: gspca_auto_gain_n_exposure called "
2055 "on cam without (auto)gain/exposure");
2059 if (gain_ctrl->get(gspca_dev, &gain) ||
2060 exposure_ctrl->get(gspca_dev, &exposure) ||
2061 autogain_ctrl->get(gspca_dev, &autogain) || !autogain)
2065 orig_exposure = exposure;
2067 /* If we are of a multiple of deadzone, do multiple steps to reach the
2068 desired lumination fast (with the risc of a slight overshoot) */
2069 steps = abs(desired_avg_lum - avg_lum) / deadzone;
2071 PDEBUG(D_FRAM, "autogain: lum: %d, desired: %d, steps: %d",
2072 avg_lum, desired_avg_lum, steps);
2074 for (i = 0; i < steps; i++) {
2075 if (avg_lum > desired_avg_lum) {
2076 if (gain > gain_knee)
2078 else if (exposure > exposure_knee)
2080 else if (gain > gain_ctrl->qctrl.default_value)
2082 else if (exposure > exposure_ctrl->qctrl.minimum)
2084 else if (gain > gain_ctrl->qctrl.minimum)
2089 if (gain < gain_ctrl->qctrl.default_value)
2091 else if (exposure < exposure_knee)
2093 else if (gain < gain_knee)
2095 else if (exposure < exposure_ctrl->qctrl.maximum)
2097 else if (gain < gain_ctrl->qctrl.maximum)
2104 if (gain != orig_gain) {
2105 gain_ctrl->set(gspca_dev, gain);
2108 if (exposure != orig_exposure) {
2109 exposure_ctrl->set(gspca_dev, exposure);
2115 EXPORT_SYMBOL(gspca_auto_gain_n_exposure);
2117 /* -- module insert / remove -- */
2118 static int __init gspca_init(void)
2120 info("main v%d.%d.%d registered",
2121 (DRIVER_VERSION_NUMBER >> 16) & 0xff,
2122 (DRIVER_VERSION_NUMBER >> 8) & 0xff,
2123 DRIVER_VERSION_NUMBER & 0xff);
2126 static void __exit gspca_exit(void)
2128 info("main deregistered");
2131 module_init(gspca_init);
2132 module_exit(gspca_exit);
2135 module_param_named(debug, gspca_debug, int, 0644);
2136 MODULE_PARM_DESC(debug,
2137 "Debug (bit) 0x01:error 0x02:probe 0x04:config"
2138 " 0x08:stream 0x10:frame 0x20:packet 0x40:USBin 0x80:USBout"