2 * Main USB camera driver
4 * Copyright (C) 2008-2009 Jean-Francois Moine (http://moinejf.free.fr)
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #define MODULE_NAME "gspca"
23 #include <linux/init.h>
24 #include <linux/version.h>
26 #include <linux/vmalloc.h>
27 #include <linux/sched.h>
28 #include <linux/slab.h>
30 #include <linux/string.h>
31 #include <linux/pagemap.h>
34 #include <linux/uaccess.h>
35 #include <linux/jiffies.h>
36 #include <media/v4l2-ioctl.h>
41 #define DEF_NURBS 3 /* default number of URBs */
42 #if DEF_NURBS > MAX_NURBS
43 #error "DEF_NURBS too big"
46 MODULE_AUTHOR("Jean-Francois Moine <http://moinejf.free.fr>");
47 MODULE_DESCRIPTION("GSPCA USB Camera Driver");
48 MODULE_LICENSE("GPL");
50 #define DRIVER_VERSION_NUMBER KERNEL_VERSION(2, 6, 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;
453 && ep->desc.wMaxPacketSize != 0)
460 * look for an input (isoc or bulk) endpoint
462 * The endpoint is defined by the subdriver.
463 * Use only the first isoc (some Zoran - 0x0572:0x0001 - have two such ep).
464 * This routine may be called many times when the bandwidth is too small
465 * (the bandwidth is checked on urb submit).
467 static struct usb_host_endpoint *get_ep(struct gspca_dev *gspca_dev)
469 struct usb_interface *intf;
470 struct usb_host_endpoint *ep;
473 intf = usb_ifnum_to_if(gspca_dev->dev, gspca_dev->iface);
475 xfer = gspca_dev->cam.bulk ? USB_ENDPOINT_XFER_BULK
476 : USB_ENDPOINT_XFER_ISOC;
477 i = gspca_dev->alt; /* previous alt setting */
479 ep = alt_xfer(&intf->altsetting[i], xfer);
484 err("no transfer endpoint found");
487 PDEBUG(D_STREAM, "use alt %d ep 0x%02x",
488 i, ep->desc.bEndpointAddress);
489 if (gspca_dev->nbalt > 1) {
490 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, i);
492 err("set alt %d err %d", i, ret);
496 gspca_dev->alt = i; /* memorize the current alt setting */
501 * create the URBs for image transfer
503 static int create_urbs(struct gspca_dev *gspca_dev,
504 struct usb_host_endpoint *ep)
507 int n, nurbs, i, psize, npkt, bsize;
509 /* calculate the packet size and the number of packets */
510 psize = le16_to_cpu(ep->desc.wMaxPacketSize);
512 if (!gspca_dev->cam.bulk) { /* isoc */
514 /* See paragraph 5.9 / table 5-11 of the usb 2.0 spec. */
515 psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
516 npkt = gspca_dev->cam.npkt;
518 npkt = 32; /* default value */
519 bsize = psize * npkt;
521 "isoc %d pkts size %d = bsize:%d",
526 bsize = gspca_dev->cam.bulk_size;
529 PDEBUG(D_STREAM, "bulk bsize:%d", bsize);
530 if (gspca_dev->cam.bulk_nurbs != 0)
531 nurbs = gspca_dev->cam.bulk_nurbs;
536 gspca_dev->nurbs = nurbs;
537 for (n = 0; n < nurbs; n++) {
538 urb = usb_alloc_urb(npkt, GFP_KERNEL);
540 err("usb_alloc_urb failed");
541 destroy_urbs(gspca_dev);
544 urb->transfer_buffer = usb_buffer_alloc(gspca_dev->dev,
549 if (urb->transfer_buffer == NULL) {
551 err("usb_buffer_urb failed");
552 destroy_urbs(gspca_dev);
555 gspca_dev->urb[n] = urb;
556 urb->dev = gspca_dev->dev;
557 urb->context = gspca_dev;
558 urb->transfer_buffer_length = bsize;
559 if (npkt != 0) { /* ISOC */
560 urb->pipe = usb_rcvisocpipe(gspca_dev->dev,
561 ep->desc.bEndpointAddress);
562 urb->transfer_flags = URB_ISO_ASAP
563 | URB_NO_TRANSFER_DMA_MAP;
564 urb->interval = ep->desc.bInterval;
565 urb->complete = isoc_irq;
566 urb->number_of_packets = npkt;
567 for (i = 0; i < npkt; i++) {
568 urb->iso_frame_desc[i].length = psize;
569 urb->iso_frame_desc[i].offset = psize * i;
572 urb->pipe = usb_rcvbulkpipe(gspca_dev->dev,
573 ep->desc.bEndpointAddress),
574 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
575 urb->complete = bulk_irq;
582 * start the USB transfer
584 static int gspca_init_transfer(struct gspca_dev *gspca_dev)
586 struct usb_host_endpoint *ep;
589 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
592 if (!gspca_dev->present) {
597 /* set the higher alternate setting and
598 * loop until urb submit succeeds */
599 gspca_dev->alt = gspca_dev->nbalt;
601 PDEBUG(D_STREAM, "init transfer alt %d", gspca_dev->alt);
602 ep = get_ep(gspca_dev);
607 ret = create_urbs(gspca_dev, ep);
611 /* clear the bulk endpoint */
612 if (gspca_dev->cam.bulk)
613 usb_clear_halt(gspca_dev->dev,
614 gspca_dev->urb[0]->pipe);
617 ret = gspca_dev->sd_desc->start(gspca_dev);
619 destroy_urbs(gspca_dev);
622 gspca_dev->streaming = 1;
624 /* some bulk transfers are started by the subdriver */
625 if (gspca_dev->cam.bulk && gspca_dev->cam.bulk_nurbs == 0)
628 /* submit the URBs */
629 for (n = 0; n < gspca_dev->nurbs; n++) {
630 ret = usb_submit_urb(gspca_dev->urb[n], GFP_KERNEL);
632 PDEBUG(D_ERR|D_STREAM,
633 "usb_submit_urb [%d] err %d", n, ret);
634 gspca_dev->streaming = 0;
635 destroy_urbs(gspca_dev);
636 if (ret == -ENOSPC) {
637 msleep(20); /* wait for kill
639 break; /* try the previous alt */
648 mutex_unlock(&gspca_dev->usb_lock);
652 static int gspca_set_alt0(struct gspca_dev *gspca_dev)
656 if (gspca_dev->alt == 0)
658 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, 0);
660 PDEBUG(D_ERR|D_STREAM, "set alt 0 err %d", ret);
664 /* Note: both the queue and the usb locks should be held when calling this */
665 static void gspca_stream_off(struct gspca_dev *gspca_dev)
667 gspca_dev->streaming = 0;
668 if (gspca_dev->present) {
669 if (gspca_dev->sd_desc->stopN)
670 gspca_dev->sd_desc->stopN(gspca_dev);
671 destroy_urbs(gspca_dev);
672 gspca_set_alt0(gspca_dev);
675 /* always call stop0 to free the subdriver's resources */
676 if (gspca_dev->sd_desc->stop0)
677 gspca_dev->sd_desc->stop0(gspca_dev);
678 PDEBUG(D_STREAM, "stream off OK");
681 static void gspca_set_default_mode(struct gspca_dev *gspca_dev)
685 i = gspca_dev->cam.nmodes - 1; /* take the highest mode */
686 gspca_dev->curr_mode = i;
687 gspca_dev->width = gspca_dev->cam.cam_mode[i].width;
688 gspca_dev->height = gspca_dev->cam.cam_mode[i].height;
689 gspca_dev->pixfmt = gspca_dev->cam.cam_mode[i].pixelformat;
692 static int wxh_to_mode(struct gspca_dev *gspca_dev,
693 int width, int height)
697 for (i = gspca_dev->cam.nmodes; --i > 0; ) {
698 if (width >= gspca_dev->cam.cam_mode[i].width
699 && height >= gspca_dev->cam.cam_mode[i].height)
706 * search a mode with the right pixel format
708 static int gspca_get_mode(struct gspca_dev *gspca_dev,
714 modeU = modeD = mode;
715 while ((modeU < gspca_dev->cam.nmodes) || modeD >= 0) {
717 if (gspca_dev->cam.cam_mode[modeD].pixelformat
721 if (++modeU < gspca_dev->cam.nmodes) {
722 if (gspca_dev->cam.cam_mode[modeU].pixelformat
730 static int vidioc_enum_fmt_vid_cap(struct file *file, void *priv,
731 struct v4l2_fmtdesc *fmtdesc)
733 struct gspca_dev *gspca_dev = priv;
737 /* give an index to each format */
740 for (i = gspca_dev->cam.nmodes; --i >= 0; ) {
741 fmt_tb[index] = gspca_dev->cam.cam_mode[i].pixelformat;
744 if (fmt_tb[j] == fmt_tb[index])
749 if (fmtdesc->index == index)
750 break; /* new format */
752 if (index >= ARRAY_SIZE(fmt_tb))
757 return -EINVAL; /* no more format */
759 fmtdesc->pixelformat = fmt_tb[index];
760 if (gspca_is_compressed(fmt_tb[index]))
761 fmtdesc->flags = V4L2_FMT_FLAG_COMPRESSED;
762 fmtdesc->description[0] = fmtdesc->pixelformat & 0xff;
763 fmtdesc->description[1] = (fmtdesc->pixelformat >> 8) & 0xff;
764 fmtdesc->description[2] = (fmtdesc->pixelformat >> 16) & 0xff;
765 fmtdesc->description[3] = fmtdesc->pixelformat >> 24;
766 fmtdesc->description[4] = '\0';
770 static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
771 struct v4l2_format *fmt)
773 struct gspca_dev *gspca_dev = priv;
776 mode = gspca_dev->curr_mode;
777 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
778 sizeof fmt->fmt.pix);
782 static int try_fmt_vid_cap(struct gspca_dev *gspca_dev,
783 struct v4l2_format *fmt)
785 int w, h, mode, mode2;
787 w = fmt->fmt.pix.width;
788 h = fmt->fmt.pix.height;
791 if (gspca_debug & D_CONF)
792 PDEBUG_MODE("try fmt cap", fmt->fmt.pix.pixelformat, w, h);
794 /* search the closest mode for width and height */
795 mode = wxh_to_mode(gspca_dev, w, h);
797 /* OK if right palette */
798 if (gspca_dev->cam.cam_mode[mode].pixelformat
799 != fmt->fmt.pix.pixelformat) {
801 /* else, search the closest mode with the same pixel format */
802 mode2 = gspca_get_mode(gspca_dev, mode,
803 fmt->fmt.pix.pixelformat);
807 ; * no chance, return this mode */
809 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
810 sizeof fmt->fmt.pix);
811 return mode; /* used when s_fmt */
814 static int vidioc_try_fmt_vid_cap(struct file *file,
816 struct v4l2_format *fmt)
818 struct gspca_dev *gspca_dev = priv;
821 ret = try_fmt_vid_cap(gspca_dev, fmt);
827 static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
828 struct v4l2_format *fmt)
830 struct gspca_dev *gspca_dev = priv;
833 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
836 ret = try_fmt_vid_cap(gspca_dev, fmt);
840 if (gspca_dev->nframes != 0
841 && fmt->fmt.pix.sizeimage > gspca_dev->frsz) {
846 if (ret == gspca_dev->curr_mode) {
848 goto out; /* same mode */
851 if (gspca_dev->streaming) {
855 gspca_dev->width = fmt->fmt.pix.width;
856 gspca_dev->height = fmt->fmt.pix.height;
857 gspca_dev->pixfmt = fmt->fmt.pix.pixelformat;
858 gspca_dev->curr_mode = ret;
862 mutex_unlock(&gspca_dev->queue_lock);
866 static int vidioc_enum_framesizes(struct file *file, void *priv,
867 struct v4l2_frmsizeenum *fsize)
869 struct gspca_dev *gspca_dev = priv;
873 for (i = 0; i < gspca_dev->cam.nmodes; i++) {
874 if (fsize->pixel_format !=
875 gspca_dev->cam.cam_mode[i].pixelformat)
878 if (fsize->index == index) {
879 fsize->type = V4L2_FRMSIZE_TYPE_DISCRETE;
880 fsize->discrete.width =
881 gspca_dev->cam.cam_mode[i].width;
882 fsize->discrete.height =
883 gspca_dev->cam.cam_mode[i].height;
892 static void gspca_release(struct video_device *vfd)
894 struct gspca_dev *gspca_dev = container_of(vfd, struct gspca_dev, vdev);
896 PDEBUG(D_STREAM, "device released");
898 kfree(gspca_dev->usb_buf);
902 static int dev_open(struct file *file)
904 struct gspca_dev *gspca_dev;
907 PDEBUG(D_STREAM, "%s open", current->comm);
908 gspca_dev = (struct gspca_dev *) video_devdata(file);
909 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
911 if (!gspca_dev->present) {
916 if (gspca_dev->users > 4) { /* (arbitrary value) */
921 /* protect the subdriver against rmmod */
922 if (!try_module_get(gspca_dev->module)) {
929 file->private_data = gspca_dev;
931 /* activate the v4l2 debug */
932 if (gspca_debug & D_V4L2)
933 gspca_dev->vdev.debug |= V4L2_DEBUG_IOCTL
934 | V4L2_DEBUG_IOCTL_ARG;
936 gspca_dev->vdev.debug &= ~(V4L2_DEBUG_IOCTL
937 | V4L2_DEBUG_IOCTL_ARG);
941 mutex_unlock(&gspca_dev->queue_lock);
943 PDEBUG(D_ERR|D_STREAM, "open failed err %d", ret);
945 PDEBUG(D_STREAM, "open done");
949 static int dev_close(struct file *file)
951 struct gspca_dev *gspca_dev = file->private_data;
953 PDEBUG(D_STREAM, "%s close", current->comm);
954 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
958 /* if the file did the capture, free the streaming resources */
959 if (gspca_dev->capt_file == file) {
960 if (gspca_dev->streaming) {
961 mutex_lock(&gspca_dev->usb_lock);
962 gspca_stream_off(gspca_dev);
963 mutex_unlock(&gspca_dev->usb_lock);
965 frame_free(gspca_dev);
966 gspca_dev->capt_file = NULL;
967 gspca_dev->memory = GSPCA_MEMORY_NO;
969 file->private_data = NULL;
970 module_put(gspca_dev->module);
971 mutex_unlock(&gspca_dev->queue_lock);
973 PDEBUG(D_STREAM, "close done");
978 static int vidioc_querycap(struct file *file, void *priv,
979 struct v4l2_capability *cap)
981 struct gspca_dev *gspca_dev = priv;
984 /* protect the access to the usb device */
985 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
987 if (!gspca_dev->present) {
991 strncpy(cap->driver, gspca_dev->sd_desc->name, sizeof cap->driver);
992 if (gspca_dev->dev->product != NULL) {
993 strncpy(cap->card, gspca_dev->dev->product,
996 snprintf(cap->card, sizeof cap->card,
997 "USB Camera (%04x:%04x)",
998 le16_to_cpu(gspca_dev->dev->descriptor.idVendor),
999 le16_to_cpu(gspca_dev->dev->descriptor.idProduct));
1001 usb_make_path(gspca_dev->dev, cap->bus_info, sizeof(cap->bus_info));
1002 cap->version = DRIVER_VERSION_NUMBER;
1003 cap->capabilities = V4L2_CAP_VIDEO_CAPTURE
1004 | V4L2_CAP_STREAMING
1005 | V4L2_CAP_READWRITE;
1008 mutex_unlock(&gspca_dev->usb_lock);
1012 static const struct ctrl *get_ctrl(struct gspca_dev *gspca_dev,
1015 const struct ctrl *ctrls;
1018 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
1019 i < gspca_dev->sd_desc->nctrls;
1021 if (gspca_dev->ctrl_dis & (1 << i))
1023 if (id == ctrls->qctrl.id)
1029 static int vidioc_queryctrl(struct file *file, void *priv,
1030 struct v4l2_queryctrl *q_ctrl)
1032 struct gspca_dev *gspca_dev = priv;
1033 const struct ctrl *ctrls;
1039 if (id & V4L2_CTRL_FLAG_NEXT_CTRL) {
1040 id &= V4L2_CTRL_ID_MASK;
1042 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
1043 if (gspca_dev->ctrl_dis & (1 << i))
1045 if (gspca_dev->sd_desc->ctrls[i].qctrl.id < id)
1047 if (ctrls && gspca_dev->sd_desc->ctrls[i].qctrl.id
1050 ctrls = &gspca_dev->sd_desc->ctrls[i];
1053 ctrls = get_ctrl(gspca_dev, id);
1057 memcpy(q_ctrl, ctrls, sizeof *q_ctrl);
1061 static int vidioc_s_ctrl(struct file *file, void *priv,
1062 struct v4l2_control *ctrl)
1064 struct gspca_dev *gspca_dev = priv;
1065 const struct ctrl *ctrls;
1068 ctrls = get_ctrl(gspca_dev, ctrl->id);
1072 if (ctrl->value < ctrls->qctrl.minimum
1073 || ctrl->value > ctrls->qctrl.maximum)
1075 PDEBUG(D_CONF, "set ctrl [%08x] = %d", ctrl->id, ctrl->value);
1076 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1077 return -ERESTARTSYS;
1078 if (gspca_dev->present)
1079 ret = ctrls->set(gspca_dev, ctrl->value);
1082 mutex_unlock(&gspca_dev->usb_lock);
1086 static int vidioc_g_ctrl(struct file *file, void *priv,
1087 struct v4l2_control *ctrl)
1089 struct gspca_dev *gspca_dev = priv;
1090 const struct ctrl *ctrls;
1093 ctrls = get_ctrl(gspca_dev, ctrl->id);
1097 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1098 return -ERESTARTSYS;
1099 if (gspca_dev->present)
1100 ret = ctrls->get(gspca_dev, &ctrl->value);
1103 mutex_unlock(&gspca_dev->usb_lock);
1107 /*fixme: have an audio flag in gspca_dev?*/
1108 static int vidioc_s_audio(struct file *file, void *priv,
1109 struct v4l2_audio *audio)
1111 if (audio->index != 0)
1116 static int vidioc_g_audio(struct file *file, void *priv,
1117 struct v4l2_audio *audio)
1119 strcpy(audio->name, "Microphone");
1123 static int vidioc_enumaudio(struct file *file, void *priv,
1124 struct v4l2_audio *audio)
1126 if (audio->index != 0)
1129 strcpy(audio->name, "Microphone");
1130 audio->capability = 0;
1135 static int vidioc_querymenu(struct file *file, void *priv,
1136 struct v4l2_querymenu *qmenu)
1138 struct gspca_dev *gspca_dev = priv;
1140 if (!gspca_dev->sd_desc->querymenu)
1142 return gspca_dev->sd_desc->querymenu(gspca_dev, qmenu);
1145 static int vidioc_enum_input(struct file *file, void *priv,
1146 struct v4l2_input *input)
1148 struct gspca_dev *gspca_dev = priv;
1150 if (input->index != 0)
1152 input->type = V4L2_INPUT_TYPE_CAMERA;
1153 input->status = gspca_dev->cam.input_flags;
1154 strncpy(input->name, gspca_dev->sd_desc->name,
1155 sizeof input->name);
1159 static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
1165 static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
1172 static int vidioc_reqbufs(struct file *file, void *priv,
1173 struct v4l2_requestbuffers *rb)
1175 struct gspca_dev *gspca_dev = priv;
1178 switch (rb->memory) {
1179 case GSPCA_MEMORY_READ: /* (internal call) */
1180 case V4L2_MEMORY_MMAP:
1181 case V4L2_MEMORY_USERPTR:
1186 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1187 return -ERESTARTSYS;
1189 if (gspca_dev->memory != GSPCA_MEMORY_NO
1190 && gspca_dev->memory != rb->memory) {
1195 /* only one file may do the capture */
1196 if (gspca_dev->capt_file != NULL
1197 && gspca_dev->capt_file != file) {
1202 /* if allocated, the buffers must not be mapped */
1203 for (i = 0; i < gspca_dev->nframes; i++) {
1204 if (gspca_dev->frame[i].vma_use_count) {
1210 /* stop streaming */
1211 if (gspca_dev->streaming) {
1212 mutex_lock(&gspca_dev->usb_lock);
1213 gspca_stream_off(gspca_dev);
1214 mutex_unlock(&gspca_dev->usb_lock);
1217 /* free the previous allocated buffers, if any */
1218 if (gspca_dev->nframes != 0) {
1219 frame_free(gspca_dev);
1220 gspca_dev->capt_file = NULL;
1222 if (rb->count == 0) /* unrequest */
1224 gspca_dev->memory = rb->memory;
1225 ret = frame_alloc(gspca_dev, rb->count);
1227 rb->count = gspca_dev->nframes;
1228 gspca_dev->capt_file = file;
1231 mutex_unlock(&gspca_dev->queue_lock);
1232 PDEBUG(D_STREAM, "reqbufs st:%d c:%d", ret, rb->count);
1236 static int vidioc_querybuf(struct file *file, void *priv,
1237 struct v4l2_buffer *v4l2_buf)
1239 struct gspca_dev *gspca_dev = priv;
1240 struct gspca_frame *frame;
1242 if (v4l2_buf->index < 0
1243 || v4l2_buf->index >= gspca_dev->nframes)
1246 frame = &gspca_dev->frame[v4l2_buf->index];
1247 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1251 static int vidioc_streamon(struct file *file, void *priv,
1252 enum v4l2_buf_type buf_type)
1254 struct gspca_dev *gspca_dev = priv;
1257 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1259 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1260 return -ERESTARTSYS;
1262 if (gspca_dev->nframes == 0
1263 || !(gspca_dev->frame[0].v4l2_buf.flags & V4L2_BUF_FLAG_QUEUED)) {
1267 if (!gspca_dev->streaming) {
1268 ret = gspca_init_transfer(gspca_dev);
1273 if (gspca_debug & D_STREAM) {
1274 PDEBUG_MODE("stream on OK",
1282 mutex_unlock(&gspca_dev->queue_lock);
1286 static int vidioc_streamoff(struct file *file, void *priv,
1287 enum v4l2_buf_type buf_type)
1289 struct gspca_dev *gspca_dev = priv;
1292 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1294 if (!gspca_dev->streaming)
1296 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1297 return -ERESTARTSYS;
1299 /* stop streaming */
1300 if (mutex_lock_interruptible(&gspca_dev->usb_lock)) {
1304 gspca_stream_off(gspca_dev);
1305 mutex_unlock(&gspca_dev->usb_lock);
1307 /* empty the application queues */
1308 for (i = 0; i < gspca_dev->nframes; i++)
1309 gspca_dev->frame[i].v4l2_buf.flags &= ~BUF_ALL_FLAGS;
1310 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
1311 gspca_dev->last_packet_type = DISCARD_PACKET;
1312 gspca_dev->sequence = 0;
1315 mutex_unlock(&gspca_dev->queue_lock);
1319 static int vidioc_g_jpegcomp(struct file *file, void *priv,
1320 struct v4l2_jpegcompression *jpegcomp)
1322 struct gspca_dev *gspca_dev = priv;
1325 if (!gspca_dev->sd_desc->get_jcomp)
1327 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1328 return -ERESTARTSYS;
1329 if (gspca_dev->present)
1330 ret = gspca_dev->sd_desc->get_jcomp(gspca_dev, jpegcomp);
1333 mutex_unlock(&gspca_dev->usb_lock);
1337 static int vidioc_s_jpegcomp(struct file *file, void *priv,
1338 struct v4l2_jpegcompression *jpegcomp)
1340 struct gspca_dev *gspca_dev = priv;
1343 if (!gspca_dev->sd_desc->set_jcomp)
1345 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1346 return -ERESTARTSYS;
1347 if (gspca_dev->present)
1348 ret = gspca_dev->sd_desc->set_jcomp(gspca_dev, jpegcomp);
1351 mutex_unlock(&gspca_dev->usb_lock);
1355 static int vidioc_g_parm(struct file *filp, void *priv,
1356 struct v4l2_streamparm *parm)
1358 struct gspca_dev *gspca_dev = priv;
1360 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1362 if (gspca_dev->sd_desc->get_streamparm) {
1365 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1366 return -ERESTARTSYS;
1367 if (gspca_dev->present)
1368 ret = gspca_dev->sd_desc->get_streamparm(gspca_dev,
1372 mutex_unlock(&gspca_dev->usb_lock);
1379 static int vidioc_s_parm(struct file *filp, void *priv,
1380 struct v4l2_streamparm *parm)
1382 struct gspca_dev *gspca_dev = priv;
1385 n = parm->parm.capture.readbuffers;
1386 if (n == 0 || n > GSPCA_MAX_FRAMES)
1387 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1389 gspca_dev->nbufread = n;
1391 if (gspca_dev->sd_desc->set_streamparm) {
1394 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1395 return -ERESTARTSYS;
1396 if (gspca_dev->present)
1397 ret = gspca_dev->sd_desc->set_streamparm(gspca_dev,
1401 mutex_unlock(&gspca_dev->usb_lock);
1408 static int vidioc_s_std(struct file *filp, void *priv,
1414 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1415 static int vidiocgmbuf(struct file *file, void *priv,
1416 struct video_mbuf *mbuf)
1418 struct gspca_dev *gspca_dev = file->private_data;
1421 PDEBUG(D_STREAM, "cgmbuf");
1422 if (gspca_dev->nframes == 0) {
1426 struct v4l2_format fmt;
1428 fmt.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1429 i = gspca_dev->cam.nmodes - 1; /* highest mode */
1430 fmt.fmt.pix.width = gspca_dev->cam.cam_mode[i].width;
1431 fmt.fmt.pix.height = gspca_dev->cam.cam_mode[i].height;
1432 fmt.fmt.pix.pixelformat = V4L2_PIX_FMT_BGR24;
1433 ret = vidioc_s_fmt_vid_cap(file, priv, &fmt);
1438 struct v4l2_requestbuffers rb;
1440 memset(&rb, 0, sizeof rb);
1442 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1443 rb.memory = V4L2_MEMORY_MMAP;
1444 ret = vidioc_reqbufs(file, priv, &rb);
1449 mbuf->frames = gspca_dev->nframes;
1450 mbuf->size = gspca_dev->frsz * gspca_dev->nframes;
1451 for (i = 0; i < mbuf->frames; i++)
1452 mbuf->offsets[i] = gspca_dev->frame[i].v4l2_buf.m.offset;
1457 static int dev_mmap(struct file *file, struct vm_area_struct *vma)
1459 struct gspca_dev *gspca_dev = file->private_data;
1460 struct gspca_frame *frame;
1462 unsigned long addr, start, size;
1465 start = vma->vm_start;
1466 size = vma->vm_end - vma->vm_start;
1467 PDEBUG(D_STREAM, "mmap start:%08x size:%d", (int) start, (int) size);
1469 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1470 return -ERESTARTSYS;
1471 if (!gspca_dev->present) {
1475 if (gspca_dev->capt_file != file) {
1481 for (i = 0; i < gspca_dev->nframes; ++i) {
1482 if (gspca_dev->frame[i].v4l2_buf.memory != V4L2_MEMORY_MMAP) {
1483 PDEBUG(D_STREAM, "mmap bad memory type");
1486 if ((gspca_dev->frame[i].v4l2_buf.m.offset >> PAGE_SHIFT)
1488 frame = &gspca_dev->frame[i];
1492 if (frame == NULL) {
1493 PDEBUG(D_STREAM, "mmap no frame buffer found");
1497 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1498 /* v4l1 maps all the buffers */
1500 || size != frame->v4l2_buf.length * gspca_dev->nframes)
1502 if (size != frame->v4l2_buf.length) {
1503 PDEBUG(D_STREAM, "mmap bad size");
1509 * - VM_IO marks the area as being a mmaped region for I/O to a
1510 * device. It also prevents the region from being core dumped.
1512 vma->vm_flags |= VM_IO;
1514 addr = (unsigned long) frame->data;
1516 page = vmalloc_to_page((void *) addr);
1517 ret = vm_insert_page(vma, start, page);
1525 vma->vm_ops = &gspca_vm_ops;
1526 vma->vm_private_data = frame;
1530 mutex_unlock(&gspca_dev->queue_lock);
1535 * wait for a video frame
1537 * If a frame is ready, its index is returned.
1539 static int frame_wait(struct gspca_dev *gspca_dev,
1542 struct gspca_frame *frame;
1545 /* check if a frame is ready */
1546 i = gspca_dev->fr_o;
1547 j = gspca_dev->fr_queue[i];
1548 frame = &gspca_dev->frame[j];
1550 if (!(frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE)) {
1554 /* wait till a frame is ready */
1555 ret = wait_event_interruptible_timeout(gspca_dev->wq,
1556 (frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE) ||
1557 !gspca_dev->streaming || !gspca_dev->present,
1558 msecs_to_jiffies(3000));
1561 if (ret == 0 || !gspca_dev->streaming || !gspca_dev->present)
1565 gspca_dev->fr_o = (i + 1) % gspca_dev->nframes;
1566 PDEBUG(D_FRAM, "frame wait q:%d i:%d o:%d",
1571 if (gspca_dev->sd_desc->dq_callback) {
1572 mutex_lock(&gspca_dev->usb_lock);
1573 if (gspca_dev->present)
1574 gspca_dev->sd_desc->dq_callback(gspca_dev);
1575 mutex_unlock(&gspca_dev->usb_lock);
1581 * dequeue a video buffer
1583 * If nonblock_ing is false, block until a buffer is available.
1585 static int vidioc_dqbuf(struct file *file, void *priv,
1586 struct v4l2_buffer *v4l2_buf)
1588 struct gspca_dev *gspca_dev = priv;
1589 struct gspca_frame *frame;
1592 PDEBUG(D_FRAM, "dqbuf");
1593 if (v4l2_buf->memory != gspca_dev->memory)
1596 if (!gspca_dev->present)
1599 /* if not streaming, be sure the application will not loop forever */
1600 if (!(file->f_flags & O_NONBLOCK)
1601 && !gspca_dev->streaming && gspca_dev->users == 1)
1604 /* only the capturing file may dequeue */
1605 if (gspca_dev->capt_file != file)
1608 /* only one dequeue / read at a time */
1609 if (mutex_lock_interruptible(&gspca_dev->read_lock))
1610 return -ERESTARTSYS;
1612 ret = frame_wait(gspca_dev, file->f_flags & O_NONBLOCK);
1615 i = ret; /* frame index */
1616 frame = &gspca_dev->frame[i];
1617 if (gspca_dev->memory == V4L2_MEMORY_USERPTR) {
1618 if (copy_to_user((__u8 __user *) frame->v4l2_buf.m.userptr,
1620 frame->v4l2_buf.bytesused)) {
1621 PDEBUG(D_ERR|D_STREAM,
1622 "dqbuf cp to user failed");
1627 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_DONE;
1628 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1629 PDEBUG(D_FRAM, "dqbuf %d", i);
1632 mutex_unlock(&gspca_dev->read_lock);
1637 * queue a video buffer
1639 * Attempting to queue a buffer that has already been
1640 * queued will return -EINVAL.
1642 static int vidioc_qbuf(struct file *file, void *priv,
1643 struct v4l2_buffer *v4l2_buf)
1645 struct gspca_dev *gspca_dev = priv;
1646 struct gspca_frame *frame;
1649 PDEBUG(D_FRAM, "qbuf %d", v4l2_buf->index);
1651 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1652 return -ERESTARTSYS;
1654 index = v4l2_buf->index;
1655 if ((unsigned) index >= gspca_dev->nframes) {
1657 "qbuf idx %d >= %d", index, gspca_dev->nframes);
1661 if (v4l2_buf->memory != gspca_dev->memory) {
1662 PDEBUG(D_FRAM, "qbuf bad memory type");
1667 frame = &gspca_dev->frame[index];
1668 if (frame->v4l2_buf.flags & BUF_ALL_FLAGS) {
1669 PDEBUG(D_FRAM, "qbuf bad state");
1674 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_QUEUED;
1676 if (frame->v4l2_buf.memory == V4L2_MEMORY_USERPTR) {
1677 frame->v4l2_buf.m.userptr = v4l2_buf->m.userptr;
1678 frame->v4l2_buf.length = v4l2_buf->length;
1681 /* put the buffer in the 'queued' queue */
1682 i = gspca_dev->fr_q;
1683 gspca_dev->fr_queue[i] = index;
1684 gspca_dev->fr_q = (i + 1) % gspca_dev->nframes;
1685 PDEBUG(D_FRAM, "qbuf q:%d i:%d o:%d",
1690 v4l2_buf->flags |= V4L2_BUF_FLAG_QUEUED;
1691 v4l2_buf->flags &= ~V4L2_BUF_FLAG_DONE;
1694 mutex_unlock(&gspca_dev->queue_lock);
1699 * allocate the resources for read()
1701 static int read_alloc(struct gspca_dev *gspca_dev,
1704 struct v4l2_buffer v4l2_buf;
1707 PDEBUG(D_STREAM, "read alloc");
1708 if (gspca_dev->nframes == 0) {
1709 struct v4l2_requestbuffers rb;
1711 memset(&rb, 0, sizeof rb);
1712 rb.count = gspca_dev->nbufread;
1713 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1714 rb.memory = GSPCA_MEMORY_READ;
1715 ret = vidioc_reqbufs(file, gspca_dev, &rb);
1717 PDEBUG(D_STREAM, "read reqbuf err %d", ret);
1720 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1721 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1722 v4l2_buf.memory = GSPCA_MEMORY_READ;
1723 for (i = 0; i < gspca_dev->nbufread; i++) {
1725 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1727 PDEBUG(D_STREAM, "read qbuf err: %d", ret);
1731 gspca_dev->memory = GSPCA_MEMORY_READ;
1734 /* start streaming */
1735 ret = vidioc_streamon(file, gspca_dev, V4L2_BUF_TYPE_VIDEO_CAPTURE);
1737 PDEBUG(D_STREAM, "read streamon err %d", ret);
1741 static unsigned int dev_poll(struct file *file, poll_table *wait)
1743 struct gspca_dev *gspca_dev = file->private_data;
1746 PDEBUG(D_FRAM, "poll");
1748 poll_wait(file, &gspca_dev->wq, wait);
1750 /* if reqbufs is not done, the user would use read() */
1751 if (gspca_dev->nframes == 0) {
1752 if (gspca_dev->memory != GSPCA_MEMORY_NO)
1753 return POLLERR; /* not the 1st time */
1754 ret = read_alloc(gspca_dev, file);
1759 if (mutex_lock_interruptible(&gspca_dev->queue_lock) != 0)
1762 /* check the next incoming buffer */
1763 i = gspca_dev->fr_o;
1764 i = gspca_dev->fr_queue[i];
1765 if (gspca_dev->frame[i].v4l2_buf.flags & V4L2_BUF_FLAG_DONE)
1766 ret = POLLIN | POLLRDNORM; /* something to read */
1769 mutex_unlock(&gspca_dev->queue_lock);
1770 if (!gspca_dev->present)
1775 static ssize_t dev_read(struct file *file, char __user *data,
1776 size_t count, loff_t *ppos)
1778 struct gspca_dev *gspca_dev = file->private_data;
1779 struct gspca_frame *frame;
1780 struct v4l2_buffer v4l2_buf;
1781 struct timeval timestamp;
1784 PDEBUG(D_FRAM, "read (%zd)", count);
1785 if (!gspca_dev->present)
1787 switch (gspca_dev->memory) {
1788 case GSPCA_MEMORY_NO: /* first time */
1789 ret = read_alloc(gspca_dev, file);
1793 case GSPCA_MEMORY_READ:
1794 if (gspca_dev->capt_file == file)
1802 jiffies_to_timeval(get_jiffies_64(), ×tamp);
1806 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1807 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1808 v4l2_buf.memory = GSPCA_MEMORY_READ;
1809 ret = vidioc_dqbuf(file, gspca_dev, &v4l2_buf);
1811 PDEBUG(D_STREAM, "read dqbuf err %d", ret);
1815 /* if the process slept for more than 1 second,
1816 * get a newer frame */
1817 frame = &gspca_dev->frame[v4l2_buf.index];
1819 break; /* avoid infinite loop */
1820 if (frame->v4l2_buf.timestamp.tv_sec >= timestamp.tv_sec)
1822 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1824 PDEBUG(D_STREAM, "read qbuf err %d", ret);
1829 /* copy the frame */
1830 if (count > frame->v4l2_buf.bytesused)
1831 count = frame->v4l2_buf.bytesused;
1832 ret = copy_to_user(data, frame->data, count);
1834 PDEBUG(D_ERR|D_STREAM,
1835 "read cp to user lack %d / %zd", ret, count);
1841 /* in each case, requeue the buffer */
1842 ret2 = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1848 static struct v4l2_file_operations dev_fops = {
1849 .owner = THIS_MODULE,
1851 .release = dev_close,
1854 .unlocked_ioctl = video_ioctl2,
1858 static const struct v4l2_ioctl_ops dev_ioctl_ops = {
1859 .vidioc_querycap = vidioc_querycap,
1860 .vidioc_dqbuf = vidioc_dqbuf,
1861 .vidioc_qbuf = vidioc_qbuf,
1862 .vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
1863 .vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
1864 .vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
1865 .vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
1866 .vidioc_streamon = vidioc_streamon,
1867 .vidioc_queryctrl = vidioc_queryctrl,
1868 .vidioc_g_ctrl = vidioc_g_ctrl,
1869 .vidioc_s_ctrl = vidioc_s_ctrl,
1870 .vidioc_g_audio = vidioc_g_audio,
1871 .vidioc_s_audio = vidioc_s_audio,
1872 .vidioc_enumaudio = vidioc_enumaudio,
1873 .vidioc_querymenu = vidioc_querymenu,
1874 .vidioc_enum_input = vidioc_enum_input,
1875 .vidioc_g_input = vidioc_g_input,
1876 .vidioc_s_input = vidioc_s_input,
1877 .vidioc_reqbufs = vidioc_reqbufs,
1878 .vidioc_querybuf = vidioc_querybuf,
1879 .vidioc_streamoff = vidioc_streamoff,
1880 .vidioc_g_jpegcomp = vidioc_g_jpegcomp,
1881 .vidioc_s_jpegcomp = vidioc_s_jpegcomp,
1882 .vidioc_g_parm = vidioc_g_parm,
1883 .vidioc_s_parm = vidioc_s_parm,
1884 .vidioc_s_std = vidioc_s_std,
1885 .vidioc_enum_framesizes = vidioc_enum_framesizes,
1886 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1887 .vidiocgmbuf = vidiocgmbuf,
1891 static struct video_device gspca_template = {
1892 .name = "gspca main driver",
1894 .ioctl_ops = &dev_ioctl_ops,
1895 .release = gspca_release,
1900 * probe and create a new gspca device
1902 * This function must be called by the sub-driver when it is
1903 * called for probing a new device.
1905 int gspca_dev_probe(struct usb_interface *intf,
1906 const struct usb_device_id *id,
1907 const struct sd_desc *sd_desc,
1909 struct module *module)
1911 struct usb_interface_descriptor *interface;
1912 struct gspca_dev *gspca_dev;
1913 struct usb_device *dev = interface_to_usbdev(intf);
1916 PDEBUG(D_PROBE, "probing %04x:%04x", id->idVendor, id->idProduct);
1918 /* we don't handle multi-config cameras */
1919 if (dev->descriptor.bNumConfigurations != 1)
1921 interface = &intf->cur_altsetting->desc;
1922 if (interface->bInterfaceNumber > 0)
1925 /* create the device */
1926 if (dev_size < sizeof *gspca_dev)
1927 dev_size = sizeof *gspca_dev;
1928 gspca_dev = kzalloc(dev_size, GFP_KERNEL);
1930 err("couldn't kzalloc gspca struct");
1933 gspca_dev->usb_buf = kmalloc(USB_BUF_SZ, GFP_KERNEL);
1934 if (!gspca_dev->usb_buf) {
1935 err("out of memory");
1939 gspca_dev->dev = dev;
1940 gspca_dev->iface = interface->bInterfaceNumber;
1941 gspca_dev->nbalt = intf->num_altsetting;
1942 gspca_dev->sd_desc = sd_desc;
1943 gspca_dev->nbufread = 2;
1944 gspca_dev->empty_packet = -1; /* don't check the empty packets */
1946 /* configure the subdriver and initialize the USB device */
1947 ret = sd_desc->config(gspca_dev, id);
1950 ret = sd_desc->init(gspca_dev);
1953 ret = gspca_set_alt0(gspca_dev);
1956 gspca_set_default_mode(gspca_dev);
1958 mutex_init(&gspca_dev->usb_lock);
1959 mutex_init(&gspca_dev->read_lock);
1960 mutex_init(&gspca_dev->queue_lock);
1961 init_waitqueue_head(&gspca_dev->wq);
1963 /* init video stuff */
1964 memcpy(&gspca_dev->vdev, &gspca_template, sizeof gspca_template);
1965 gspca_dev->vdev.parent = &intf->dev;
1966 gspca_dev->module = module;
1967 gspca_dev->present = 1;
1968 ret = video_register_device(&gspca_dev->vdev,
1972 err("video_register_device err %d", ret);
1976 usb_set_intfdata(intf, gspca_dev);
1977 PDEBUG(D_PROBE, "probe ok");
1980 kfree(gspca_dev->usb_buf);
1984 EXPORT_SYMBOL(gspca_dev_probe);
1989 * This function must be called by the sub-driver
1990 * when the device disconnects, after the specific resources are freed.
1992 void gspca_disconnect(struct usb_interface *intf)
1994 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
1996 mutex_lock(&gspca_dev->usb_lock);
1997 gspca_dev->present = 0;
1999 if (gspca_dev->streaming) {
2000 destroy_urbs(gspca_dev);
2001 wake_up_interruptible(&gspca_dev->wq);
2004 /* the device is freed at exit of this function */
2005 gspca_dev->dev = NULL;
2006 mutex_unlock(&gspca_dev->usb_lock);
2008 usb_set_intfdata(intf, NULL);
2010 /* release the device */
2011 /* (this will call gspca_release() immediatly or on last close) */
2012 video_unregister_device(&gspca_dev->vdev);
2014 PDEBUG(D_PROBE, "disconnect complete");
2016 EXPORT_SYMBOL(gspca_disconnect);
2019 int gspca_suspend(struct usb_interface *intf, pm_message_t message)
2021 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2023 if (!gspca_dev->streaming)
2025 gspca_dev->frozen = 1; /* avoid urb error messages */
2026 if (gspca_dev->sd_desc->stopN)
2027 gspca_dev->sd_desc->stopN(gspca_dev);
2028 destroy_urbs(gspca_dev);
2029 gspca_set_alt0(gspca_dev);
2030 if (gspca_dev->sd_desc->stop0)
2031 gspca_dev->sd_desc->stop0(gspca_dev);
2034 EXPORT_SYMBOL(gspca_suspend);
2036 int gspca_resume(struct usb_interface *intf)
2038 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2040 gspca_dev->frozen = 0;
2041 gspca_dev->sd_desc->init(gspca_dev);
2042 if (gspca_dev->streaming)
2043 return gspca_init_transfer(gspca_dev);
2046 EXPORT_SYMBOL(gspca_resume);
2048 /* -- cam driver utility functions -- */
2050 /* auto gain and exposure algorithm based on the knee algorithm described here:
2051 http://ytse.tricolour.net/docs/LowLightOptimization.html
2053 Returns 0 if no changes were made, 1 if the gain and or exposure settings
2055 int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
2056 int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee)
2058 int i, steps, gain, orig_gain, exposure, orig_exposure, autogain;
2059 const struct ctrl *gain_ctrl = NULL;
2060 const struct ctrl *exposure_ctrl = NULL;
2061 const struct ctrl *autogain_ctrl = NULL;
2064 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
2065 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_GAIN)
2066 gain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2067 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_EXPOSURE)
2068 exposure_ctrl = &gspca_dev->sd_desc->ctrls[i];
2069 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_AUTOGAIN)
2070 autogain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2072 if (!gain_ctrl || !exposure_ctrl || !autogain_ctrl) {
2073 PDEBUG(D_ERR, "Error: gspca_auto_gain_n_exposure called "
2074 "on cam without (auto)gain/exposure");
2078 if (gain_ctrl->get(gspca_dev, &gain) ||
2079 exposure_ctrl->get(gspca_dev, &exposure) ||
2080 autogain_ctrl->get(gspca_dev, &autogain) || !autogain)
2084 orig_exposure = exposure;
2086 /* If we are of a multiple of deadzone, do multiple steps to reach the
2087 desired lumination fast (with the risc of a slight overshoot) */
2088 steps = abs(desired_avg_lum - avg_lum) / deadzone;
2090 PDEBUG(D_FRAM, "autogain: lum: %d, desired: %d, steps: %d",
2091 avg_lum, desired_avg_lum, steps);
2093 for (i = 0; i < steps; i++) {
2094 if (avg_lum > desired_avg_lum) {
2095 if (gain > gain_knee)
2097 else if (exposure > exposure_knee)
2099 else if (gain > gain_ctrl->qctrl.default_value)
2101 else if (exposure > exposure_ctrl->qctrl.minimum)
2103 else if (gain > gain_ctrl->qctrl.minimum)
2108 if (gain < gain_ctrl->qctrl.default_value)
2110 else if (exposure < exposure_knee)
2112 else if (gain < gain_knee)
2114 else if (exposure < exposure_ctrl->qctrl.maximum)
2116 else if (gain < gain_ctrl->qctrl.maximum)
2123 if (gain != orig_gain) {
2124 gain_ctrl->set(gspca_dev, gain);
2127 if (exposure != orig_exposure) {
2128 exposure_ctrl->set(gspca_dev, exposure);
2134 EXPORT_SYMBOL(gspca_auto_gain_n_exposure);
2136 /* -- module insert / remove -- */
2137 static int __init gspca_init(void)
2139 info("main v%d.%d.%d registered",
2140 (DRIVER_VERSION_NUMBER >> 16) & 0xff,
2141 (DRIVER_VERSION_NUMBER >> 8) & 0xff,
2142 DRIVER_VERSION_NUMBER & 0xff);
2145 static void __exit gspca_exit(void)
2147 info("main deregistered");
2150 module_init(gspca_init);
2151 module_exit(gspca_exit);
2154 module_param_named(debug, gspca_debug, int, 0644);
2155 MODULE_PARM_DESC(debug,
2156 "Debug (bit) 0x01:error 0x02:probe 0x04:config"
2157 " 0x08:stream 0x10:frame 0x20:packet 0x40:USBin 0x80:USBout"