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 (ctrls->qctrl.id < id)
1047 if (ctrls != NULL) {
1048 if (gspca_dev->sd_desc->ctrls[i].qctrl.id
1052 ctrls = &gspca_dev->sd_desc->ctrls[i];
1055 ctrls = get_ctrl(gspca_dev, id);
1059 memcpy(q_ctrl, ctrls, sizeof *q_ctrl);
1063 static int vidioc_s_ctrl(struct file *file, void *priv,
1064 struct v4l2_control *ctrl)
1066 struct gspca_dev *gspca_dev = priv;
1067 const struct ctrl *ctrls;
1070 ctrls = get_ctrl(gspca_dev, ctrl->id);
1074 if (ctrl->value < ctrls->qctrl.minimum
1075 || ctrl->value > ctrls->qctrl.maximum)
1077 PDEBUG(D_CONF, "set ctrl [%08x] = %d", ctrl->id, ctrl->value);
1078 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1079 return -ERESTARTSYS;
1080 if (gspca_dev->present)
1081 ret = ctrls->set(gspca_dev, ctrl->value);
1084 mutex_unlock(&gspca_dev->usb_lock);
1088 static int vidioc_g_ctrl(struct file *file, void *priv,
1089 struct v4l2_control *ctrl)
1091 struct gspca_dev *gspca_dev = priv;
1092 const struct ctrl *ctrls;
1095 ctrls = get_ctrl(gspca_dev, ctrl->id);
1099 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1100 return -ERESTARTSYS;
1101 if (gspca_dev->present)
1102 ret = ctrls->get(gspca_dev, &ctrl->value);
1105 mutex_unlock(&gspca_dev->usb_lock);
1109 /*fixme: have an audio flag in gspca_dev?*/
1110 static int vidioc_s_audio(struct file *file, void *priv,
1111 struct v4l2_audio *audio)
1113 if (audio->index != 0)
1118 static int vidioc_g_audio(struct file *file, void *priv,
1119 struct v4l2_audio *audio)
1121 strcpy(audio->name, "Microphone");
1125 static int vidioc_enumaudio(struct file *file, void *priv,
1126 struct v4l2_audio *audio)
1128 if (audio->index != 0)
1131 strcpy(audio->name, "Microphone");
1132 audio->capability = 0;
1137 static int vidioc_querymenu(struct file *file, void *priv,
1138 struct v4l2_querymenu *qmenu)
1140 struct gspca_dev *gspca_dev = priv;
1142 if (!gspca_dev->sd_desc->querymenu)
1144 return gspca_dev->sd_desc->querymenu(gspca_dev, qmenu);
1147 static int vidioc_enum_input(struct file *file, void *priv,
1148 struct v4l2_input *input)
1150 struct gspca_dev *gspca_dev = priv;
1152 if (input->index != 0)
1154 input->type = V4L2_INPUT_TYPE_CAMERA;
1155 input->status = gspca_dev->cam.input_flags;
1156 strncpy(input->name, gspca_dev->sd_desc->name,
1157 sizeof input->name);
1161 static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
1167 static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
1174 static int vidioc_reqbufs(struct file *file, void *priv,
1175 struct v4l2_requestbuffers *rb)
1177 struct gspca_dev *gspca_dev = priv;
1180 switch (rb->memory) {
1181 case GSPCA_MEMORY_READ: /* (internal call) */
1182 case V4L2_MEMORY_MMAP:
1183 case V4L2_MEMORY_USERPTR:
1188 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1189 return -ERESTARTSYS;
1191 if (gspca_dev->memory != GSPCA_MEMORY_NO
1192 && gspca_dev->memory != rb->memory) {
1197 /* only one file may do the capture */
1198 if (gspca_dev->capt_file != NULL
1199 && gspca_dev->capt_file != file) {
1204 /* if allocated, the buffers must not be mapped */
1205 for (i = 0; i < gspca_dev->nframes; i++) {
1206 if (gspca_dev->frame[i].vma_use_count) {
1212 /* stop streaming */
1213 if (gspca_dev->streaming) {
1214 mutex_lock(&gspca_dev->usb_lock);
1215 gspca_stream_off(gspca_dev);
1216 mutex_unlock(&gspca_dev->usb_lock);
1219 /* free the previous allocated buffers, if any */
1220 if (gspca_dev->nframes != 0) {
1221 frame_free(gspca_dev);
1222 gspca_dev->capt_file = NULL;
1224 if (rb->count == 0) /* unrequest */
1226 gspca_dev->memory = rb->memory;
1227 ret = frame_alloc(gspca_dev, rb->count);
1229 rb->count = gspca_dev->nframes;
1230 gspca_dev->capt_file = file;
1233 mutex_unlock(&gspca_dev->queue_lock);
1234 PDEBUG(D_STREAM, "reqbufs st:%d c:%d", ret, rb->count);
1238 static int vidioc_querybuf(struct file *file, void *priv,
1239 struct v4l2_buffer *v4l2_buf)
1241 struct gspca_dev *gspca_dev = priv;
1242 struct gspca_frame *frame;
1244 if (v4l2_buf->index < 0
1245 || v4l2_buf->index >= gspca_dev->nframes)
1248 frame = &gspca_dev->frame[v4l2_buf->index];
1249 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1253 static int vidioc_streamon(struct file *file, void *priv,
1254 enum v4l2_buf_type buf_type)
1256 struct gspca_dev *gspca_dev = priv;
1259 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1261 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1262 return -ERESTARTSYS;
1264 if (gspca_dev->nframes == 0
1265 || !(gspca_dev->frame[0].v4l2_buf.flags & V4L2_BUF_FLAG_QUEUED)) {
1269 if (!gspca_dev->streaming) {
1270 ret = gspca_init_transfer(gspca_dev);
1275 if (gspca_debug & D_STREAM) {
1276 PDEBUG_MODE("stream on OK",
1284 mutex_unlock(&gspca_dev->queue_lock);
1288 static int vidioc_streamoff(struct file *file, void *priv,
1289 enum v4l2_buf_type buf_type)
1291 struct gspca_dev *gspca_dev = priv;
1294 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1296 if (!gspca_dev->streaming)
1298 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1299 return -ERESTARTSYS;
1301 /* stop streaming */
1302 if (mutex_lock_interruptible(&gspca_dev->usb_lock)) {
1306 gspca_stream_off(gspca_dev);
1307 mutex_unlock(&gspca_dev->usb_lock);
1309 /* empty the application queues */
1310 for (i = 0; i < gspca_dev->nframes; i++)
1311 gspca_dev->frame[i].v4l2_buf.flags &= ~BUF_ALL_FLAGS;
1312 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
1313 gspca_dev->last_packet_type = DISCARD_PACKET;
1314 gspca_dev->sequence = 0;
1317 mutex_unlock(&gspca_dev->queue_lock);
1321 static int vidioc_g_jpegcomp(struct file *file, void *priv,
1322 struct v4l2_jpegcompression *jpegcomp)
1324 struct gspca_dev *gspca_dev = priv;
1327 if (!gspca_dev->sd_desc->get_jcomp)
1329 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1330 return -ERESTARTSYS;
1331 if (gspca_dev->present)
1332 ret = gspca_dev->sd_desc->get_jcomp(gspca_dev, jpegcomp);
1335 mutex_unlock(&gspca_dev->usb_lock);
1339 static int vidioc_s_jpegcomp(struct file *file, void *priv,
1340 struct v4l2_jpegcompression *jpegcomp)
1342 struct gspca_dev *gspca_dev = priv;
1345 if (!gspca_dev->sd_desc->set_jcomp)
1347 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1348 return -ERESTARTSYS;
1349 if (gspca_dev->present)
1350 ret = gspca_dev->sd_desc->set_jcomp(gspca_dev, jpegcomp);
1353 mutex_unlock(&gspca_dev->usb_lock);
1357 static int vidioc_g_parm(struct file *filp, void *priv,
1358 struct v4l2_streamparm *parm)
1360 struct gspca_dev *gspca_dev = priv;
1362 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1364 if (gspca_dev->sd_desc->get_streamparm) {
1367 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1368 return -ERESTARTSYS;
1369 if (gspca_dev->present)
1370 ret = gspca_dev->sd_desc->get_streamparm(gspca_dev,
1374 mutex_unlock(&gspca_dev->usb_lock);
1381 static int vidioc_s_parm(struct file *filp, void *priv,
1382 struct v4l2_streamparm *parm)
1384 struct gspca_dev *gspca_dev = priv;
1387 n = parm->parm.capture.readbuffers;
1388 if (n == 0 || n > GSPCA_MAX_FRAMES)
1389 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1391 gspca_dev->nbufread = n;
1393 if (gspca_dev->sd_desc->set_streamparm) {
1396 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1397 return -ERESTARTSYS;
1398 if (gspca_dev->present)
1399 ret = gspca_dev->sd_desc->set_streamparm(gspca_dev,
1403 mutex_unlock(&gspca_dev->usb_lock);
1410 static int vidioc_s_std(struct file *filp, void *priv,
1416 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1417 static int vidiocgmbuf(struct file *file, void *priv,
1418 struct video_mbuf *mbuf)
1420 struct gspca_dev *gspca_dev = file->private_data;
1423 PDEBUG(D_STREAM, "cgmbuf");
1424 if (gspca_dev->nframes == 0) {
1428 struct v4l2_format fmt;
1430 fmt.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1431 i = gspca_dev->cam.nmodes - 1; /* highest mode */
1432 fmt.fmt.pix.width = gspca_dev->cam.cam_mode[i].width;
1433 fmt.fmt.pix.height = gspca_dev->cam.cam_mode[i].height;
1434 fmt.fmt.pix.pixelformat = V4L2_PIX_FMT_BGR24;
1435 ret = vidioc_s_fmt_vid_cap(file, priv, &fmt);
1440 struct v4l2_requestbuffers rb;
1442 memset(&rb, 0, sizeof rb);
1444 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1445 rb.memory = V4L2_MEMORY_MMAP;
1446 ret = vidioc_reqbufs(file, priv, &rb);
1451 mbuf->frames = gspca_dev->nframes;
1452 mbuf->size = gspca_dev->frsz * gspca_dev->nframes;
1453 for (i = 0; i < mbuf->frames; i++)
1454 mbuf->offsets[i] = gspca_dev->frame[i].v4l2_buf.m.offset;
1459 static int dev_mmap(struct file *file, struct vm_area_struct *vma)
1461 struct gspca_dev *gspca_dev = file->private_data;
1462 struct gspca_frame *frame;
1464 unsigned long addr, start, size;
1467 start = vma->vm_start;
1468 size = vma->vm_end - vma->vm_start;
1469 PDEBUG(D_STREAM, "mmap start:%08x size:%d", (int) start, (int) size);
1471 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1472 return -ERESTARTSYS;
1473 if (!gspca_dev->present) {
1477 if (gspca_dev->capt_file != file) {
1483 for (i = 0; i < gspca_dev->nframes; ++i) {
1484 if (gspca_dev->frame[i].v4l2_buf.memory != V4L2_MEMORY_MMAP) {
1485 PDEBUG(D_STREAM, "mmap bad memory type");
1488 if ((gspca_dev->frame[i].v4l2_buf.m.offset >> PAGE_SHIFT)
1490 frame = &gspca_dev->frame[i];
1494 if (frame == NULL) {
1495 PDEBUG(D_STREAM, "mmap no frame buffer found");
1499 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1500 /* v4l1 maps all the buffers */
1502 || size != frame->v4l2_buf.length * gspca_dev->nframes)
1504 if (size != frame->v4l2_buf.length) {
1505 PDEBUG(D_STREAM, "mmap bad size");
1511 * - VM_IO marks the area as being a mmaped region for I/O to a
1512 * device. It also prevents the region from being core dumped.
1514 vma->vm_flags |= VM_IO;
1516 addr = (unsigned long) frame->data;
1518 page = vmalloc_to_page((void *) addr);
1519 ret = vm_insert_page(vma, start, page);
1527 vma->vm_ops = &gspca_vm_ops;
1528 vma->vm_private_data = frame;
1532 mutex_unlock(&gspca_dev->queue_lock);
1537 * wait for a video frame
1539 * If a frame is ready, its index is returned.
1541 static int frame_wait(struct gspca_dev *gspca_dev,
1544 struct gspca_frame *frame;
1547 /* check if a frame is ready */
1548 i = gspca_dev->fr_o;
1549 j = gspca_dev->fr_queue[i];
1550 frame = &gspca_dev->frame[j];
1552 if (!(frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE)) {
1556 /* wait till a frame is ready */
1557 ret = wait_event_interruptible_timeout(gspca_dev->wq,
1558 (frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE) ||
1559 !gspca_dev->streaming || !gspca_dev->present,
1560 msecs_to_jiffies(3000));
1563 if (ret == 0 || !gspca_dev->streaming || !gspca_dev->present)
1567 gspca_dev->fr_o = (i + 1) % gspca_dev->nframes;
1568 PDEBUG(D_FRAM, "frame wait q:%d i:%d o:%d",
1573 if (gspca_dev->sd_desc->dq_callback) {
1574 mutex_lock(&gspca_dev->usb_lock);
1575 if (gspca_dev->present)
1576 gspca_dev->sd_desc->dq_callback(gspca_dev);
1577 mutex_unlock(&gspca_dev->usb_lock);
1583 * dequeue a video buffer
1585 * If nonblock_ing is false, block until a buffer is available.
1587 static int vidioc_dqbuf(struct file *file, void *priv,
1588 struct v4l2_buffer *v4l2_buf)
1590 struct gspca_dev *gspca_dev = priv;
1591 struct gspca_frame *frame;
1594 PDEBUG(D_FRAM, "dqbuf");
1595 if (v4l2_buf->memory != gspca_dev->memory)
1598 if (!gspca_dev->present)
1601 /* if not streaming, be sure the application will not loop forever */
1602 if (!(file->f_flags & O_NONBLOCK)
1603 && !gspca_dev->streaming && gspca_dev->users == 1)
1606 /* only the capturing file may dequeue */
1607 if (gspca_dev->capt_file != file)
1610 /* only one dequeue / read at a time */
1611 if (mutex_lock_interruptible(&gspca_dev->read_lock))
1612 return -ERESTARTSYS;
1614 ret = frame_wait(gspca_dev, file->f_flags & O_NONBLOCK);
1617 i = ret; /* frame index */
1618 frame = &gspca_dev->frame[i];
1619 if (gspca_dev->memory == V4L2_MEMORY_USERPTR) {
1620 if (copy_to_user((__u8 __user *) frame->v4l2_buf.m.userptr,
1622 frame->v4l2_buf.bytesused)) {
1623 PDEBUG(D_ERR|D_STREAM,
1624 "dqbuf cp to user failed");
1629 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_DONE;
1630 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1631 PDEBUG(D_FRAM, "dqbuf %d", i);
1634 mutex_unlock(&gspca_dev->read_lock);
1639 * queue a video buffer
1641 * Attempting to queue a buffer that has already been
1642 * queued will return -EINVAL.
1644 static int vidioc_qbuf(struct file *file, void *priv,
1645 struct v4l2_buffer *v4l2_buf)
1647 struct gspca_dev *gspca_dev = priv;
1648 struct gspca_frame *frame;
1651 PDEBUG(D_FRAM, "qbuf %d", v4l2_buf->index);
1653 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1654 return -ERESTARTSYS;
1656 index = v4l2_buf->index;
1657 if ((unsigned) index >= gspca_dev->nframes) {
1659 "qbuf idx %d >= %d", index, gspca_dev->nframes);
1663 if (v4l2_buf->memory != gspca_dev->memory) {
1664 PDEBUG(D_FRAM, "qbuf bad memory type");
1669 frame = &gspca_dev->frame[index];
1670 if (frame->v4l2_buf.flags & BUF_ALL_FLAGS) {
1671 PDEBUG(D_FRAM, "qbuf bad state");
1676 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_QUEUED;
1678 if (frame->v4l2_buf.memory == V4L2_MEMORY_USERPTR) {
1679 frame->v4l2_buf.m.userptr = v4l2_buf->m.userptr;
1680 frame->v4l2_buf.length = v4l2_buf->length;
1683 /* put the buffer in the 'queued' queue */
1684 i = gspca_dev->fr_q;
1685 gspca_dev->fr_queue[i] = index;
1686 gspca_dev->fr_q = (i + 1) % gspca_dev->nframes;
1687 PDEBUG(D_FRAM, "qbuf q:%d i:%d o:%d",
1692 v4l2_buf->flags |= V4L2_BUF_FLAG_QUEUED;
1693 v4l2_buf->flags &= ~V4L2_BUF_FLAG_DONE;
1696 mutex_unlock(&gspca_dev->queue_lock);
1701 * allocate the resources for read()
1703 static int read_alloc(struct gspca_dev *gspca_dev,
1706 struct v4l2_buffer v4l2_buf;
1709 PDEBUG(D_STREAM, "read alloc");
1710 if (gspca_dev->nframes == 0) {
1711 struct v4l2_requestbuffers rb;
1713 memset(&rb, 0, sizeof rb);
1714 rb.count = gspca_dev->nbufread;
1715 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1716 rb.memory = GSPCA_MEMORY_READ;
1717 ret = vidioc_reqbufs(file, gspca_dev, &rb);
1719 PDEBUG(D_STREAM, "read reqbuf err %d", ret);
1722 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1723 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1724 v4l2_buf.memory = GSPCA_MEMORY_READ;
1725 for (i = 0; i < gspca_dev->nbufread; i++) {
1727 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1729 PDEBUG(D_STREAM, "read qbuf err: %d", ret);
1733 gspca_dev->memory = GSPCA_MEMORY_READ;
1736 /* start streaming */
1737 ret = vidioc_streamon(file, gspca_dev, V4L2_BUF_TYPE_VIDEO_CAPTURE);
1739 PDEBUG(D_STREAM, "read streamon err %d", ret);
1743 static unsigned int dev_poll(struct file *file, poll_table *wait)
1745 struct gspca_dev *gspca_dev = file->private_data;
1748 PDEBUG(D_FRAM, "poll");
1750 poll_wait(file, &gspca_dev->wq, wait);
1752 /* if reqbufs is not done, the user would use read() */
1753 if (gspca_dev->nframes == 0) {
1754 if (gspca_dev->memory != GSPCA_MEMORY_NO)
1755 return POLLERR; /* not the 1st time */
1756 ret = read_alloc(gspca_dev, file);
1761 if (mutex_lock_interruptible(&gspca_dev->queue_lock) != 0)
1764 /* check the next incoming buffer */
1765 i = gspca_dev->fr_o;
1766 i = gspca_dev->fr_queue[i];
1767 if (gspca_dev->frame[i].v4l2_buf.flags & V4L2_BUF_FLAG_DONE)
1768 ret = POLLIN | POLLRDNORM; /* something to read */
1771 mutex_unlock(&gspca_dev->queue_lock);
1772 if (!gspca_dev->present)
1777 static ssize_t dev_read(struct file *file, char __user *data,
1778 size_t count, loff_t *ppos)
1780 struct gspca_dev *gspca_dev = file->private_data;
1781 struct gspca_frame *frame;
1782 struct v4l2_buffer v4l2_buf;
1783 struct timeval timestamp;
1786 PDEBUG(D_FRAM, "read (%zd)", count);
1787 if (!gspca_dev->present)
1789 switch (gspca_dev->memory) {
1790 case GSPCA_MEMORY_NO: /* first time */
1791 ret = read_alloc(gspca_dev, file);
1795 case GSPCA_MEMORY_READ:
1796 if (gspca_dev->capt_file == file)
1804 jiffies_to_timeval(get_jiffies_64(), ×tamp);
1808 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1809 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1810 v4l2_buf.memory = GSPCA_MEMORY_READ;
1811 ret = vidioc_dqbuf(file, gspca_dev, &v4l2_buf);
1813 PDEBUG(D_STREAM, "read dqbuf err %d", ret);
1817 /* if the process slept for more than 1 second,
1818 * get a newer frame */
1819 frame = &gspca_dev->frame[v4l2_buf.index];
1821 break; /* avoid infinite loop */
1822 if (frame->v4l2_buf.timestamp.tv_sec >= timestamp.tv_sec)
1824 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1826 PDEBUG(D_STREAM, "read qbuf err %d", ret);
1831 /* copy the frame */
1832 if (count > frame->v4l2_buf.bytesused)
1833 count = frame->v4l2_buf.bytesused;
1834 ret = copy_to_user(data, frame->data, count);
1836 PDEBUG(D_ERR|D_STREAM,
1837 "read cp to user lack %d / %zd", ret, count);
1843 /* in each case, requeue the buffer */
1844 ret2 = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1850 static struct v4l2_file_operations dev_fops = {
1851 .owner = THIS_MODULE,
1853 .release = dev_close,
1856 .unlocked_ioctl = video_ioctl2,
1860 static const struct v4l2_ioctl_ops dev_ioctl_ops = {
1861 .vidioc_querycap = vidioc_querycap,
1862 .vidioc_dqbuf = vidioc_dqbuf,
1863 .vidioc_qbuf = vidioc_qbuf,
1864 .vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
1865 .vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
1866 .vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
1867 .vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
1868 .vidioc_streamon = vidioc_streamon,
1869 .vidioc_queryctrl = vidioc_queryctrl,
1870 .vidioc_g_ctrl = vidioc_g_ctrl,
1871 .vidioc_s_ctrl = vidioc_s_ctrl,
1872 .vidioc_g_audio = vidioc_g_audio,
1873 .vidioc_s_audio = vidioc_s_audio,
1874 .vidioc_enumaudio = vidioc_enumaudio,
1875 .vidioc_querymenu = vidioc_querymenu,
1876 .vidioc_enum_input = vidioc_enum_input,
1877 .vidioc_g_input = vidioc_g_input,
1878 .vidioc_s_input = vidioc_s_input,
1879 .vidioc_reqbufs = vidioc_reqbufs,
1880 .vidioc_querybuf = vidioc_querybuf,
1881 .vidioc_streamoff = vidioc_streamoff,
1882 .vidioc_g_jpegcomp = vidioc_g_jpegcomp,
1883 .vidioc_s_jpegcomp = vidioc_s_jpegcomp,
1884 .vidioc_g_parm = vidioc_g_parm,
1885 .vidioc_s_parm = vidioc_s_parm,
1886 .vidioc_s_std = vidioc_s_std,
1887 .vidioc_enum_framesizes = vidioc_enum_framesizes,
1888 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1889 .vidiocgmbuf = vidiocgmbuf,
1893 static struct video_device gspca_template = {
1894 .name = "gspca main driver",
1896 .ioctl_ops = &dev_ioctl_ops,
1897 .release = gspca_release,
1902 * probe and create a new gspca device
1904 * This function must be called by the sub-driver when it is
1905 * called for probing a new device.
1907 int gspca_dev_probe(struct usb_interface *intf,
1908 const struct usb_device_id *id,
1909 const struct sd_desc *sd_desc,
1911 struct module *module)
1913 struct usb_interface_descriptor *interface;
1914 struct gspca_dev *gspca_dev;
1915 struct usb_device *dev = interface_to_usbdev(intf);
1918 PDEBUG(D_PROBE, "probing %04x:%04x", id->idVendor, id->idProduct);
1920 /* we don't handle multi-config cameras */
1921 if (dev->descriptor.bNumConfigurations != 1)
1923 interface = &intf->cur_altsetting->desc;
1924 if (interface->bInterfaceNumber > 0)
1927 /* create the device */
1928 if (dev_size < sizeof *gspca_dev)
1929 dev_size = sizeof *gspca_dev;
1930 gspca_dev = kzalloc(dev_size, GFP_KERNEL);
1932 err("couldn't kzalloc gspca struct");
1935 gspca_dev->usb_buf = kmalloc(USB_BUF_SZ, GFP_KERNEL);
1936 if (!gspca_dev->usb_buf) {
1937 err("out of memory");
1941 gspca_dev->dev = dev;
1942 gspca_dev->iface = interface->bInterfaceNumber;
1943 gspca_dev->nbalt = intf->num_altsetting;
1944 gspca_dev->sd_desc = sd_desc;
1945 gspca_dev->nbufread = 2;
1946 gspca_dev->empty_packet = -1; /* don't check the empty packets */
1948 /* configure the subdriver and initialize the USB device */
1949 ret = sd_desc->config(gspca_dev, id);
1952 ret = sd_desc->init(gspca_dev);
1955 ret = gspca_set_alt0(gspca_dev);
1958 gspca_set_default_mode(gspca_dev);
1960 mutex_init(&gspca_dev->usb_lock);
1961 mutex_init(&gspca_dev->read_lock);
1962 mutex_init(&gspca_dev->queue_lock);
1963 init_waitqueue_head(&gspca_dev->wq);
1965 /* init video stuff */
1966 memcpy(&gspca_dev->vdev, &gspca_template, sizeof gspca_template);
1967 gspca_dev->vdev.parent = &intf->dev;
1968 gspca_dev->module = module;
1969 gspca_dev->present = 1;
1970 ret = video_register_device(&gspca_dev->vdev,
1974 err("video_register_device err %d", ret);
1978 usb_set_intfdata(intf, gspca_dev);
1979 PDEBUG(D_PROBE, "probe ok");
1982 kfree(gspca_dev->usb_buf);
1986 EXPORT_SYMBOL(gspca_dev_probe);
1991 * This function must be called by the sub-driver
1992 * when the device disconnects, after the specific resources are freed.
1994 void gspca_disconnect(struct usb_interface *intf)
1996 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
1998 mutex_lock(&gspca_dev->usb_lock);
1999 gspca_dev->present = 0;
2001 if (gspca_dev->streaming) {
2002 destroy_urbs(gspca_dev);
2003 wake_up_interruptible(&gspca_dev->wq);
2006 /* the device is freed at exit of this function */
2007 gspca_dev->dev = NULL;
2008 mutex_unlock(&gspca_dev->usb_lock);
2010 usb_set_intfdata(intf, NULL);
2012 /* release the device */
2013 /* (this will call gspca_release() immediatly or on last close) */
2014 video_unregister_device(&gspca_dev->vdev);
2016 PDEBUG(D_PROBE, "disconnect complete");
2018 EXPORT_SYMBOL(gspca_disconnect);
2021 int gspca_suspend(struct usb_interface *intf, pm_message_t message)
2023 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2025 if (!gspca_dev->streaming)
2027 gspca_dev->frozen = 1; /* avoid urb error messages */
2028 if (gspca_dev->sd_desc->stopN)
2029 gspca_dev->sd_desc->stopN(gspca_dev);
2030 destroy_urbs(gspca_dev);
2031 gspca_set_alt0(gspca_dev);
2032 if (gspca_dev->sd_desc->stop0)
2033 gspca_dev->sd_desc->stop0(gspca_dev);
2036 EXPORT_SYMBOL(gspca_suspend);
2038 int gspca_resume(struct usb_interface *intf)
2040 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2042 gspca_dev->frozen = 0;
2043 gspca_dev->sd_desc->init(gspca_dev);
2044 if (gspca_dev->streaming)
2045 return gspca_init_transfer(gspca_dev);
2048 EXPORT_SYMBOL(gspca_resume);
2050 /* -- cam driver utility functions -- */
2052 /* auto gain and exposure algorithm based on the knee algorithm described here:
2053 http://ytse.tricolour.net/docs/LowLightOptimization.html
2055 Returns 0 if no changes were made, 1 if the gain and or exposure settings
2057 int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
2058 int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee)
2060 int i, steps, gain, orig_gain, exposure, orig_exposure, autogain;
2061 const struct ctrl *gain_ctrl = NULL;
2062 const struct ctrl *exposure_ctrl = NULL;
2063 const struct ctrl *autogain_ctrl = NULL;
2066 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
2067 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_GAIN)
2068 gain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2069 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_EXPOSURE)
2070 exposure_ctrl = &gspca_dev->sd_desc->ctrls[i];
2071 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_AUTOGAIN)
2072 autogain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2074 if (!gain_ctrl || !exposure_ctrl || !autogain_ctrl) {
2075 PDEBUG(D_ERR, "Error: gspca_auto_gain_n_exposure called "
2076 "on cam without (auto)gain/exposure");
2080 if (gain_ctrl->get(gspca_dev, &gain) ||
2081 exposure_ctrl->get(gspca_dev, &exposure) ||
2082 autogain_ctrl->get(gspca_dev, &autogain) || !autogain)
2086 orig_exposure = exposure;
2088 /* If we are of a multiple of deadzone, do multiple steps to reach the
2089 desired lumination fast (with the risc of a slight overshoot) */
2090 steps = abs(desired_avg_lum - avg_lum) / deadzone;
2092 PDEBUG(D_FRAM, "autogain: lum: %d, desired: %d, steps: %d",
2093 avg_lum, desired_avg_lum, steps);
2095 for (i = 0; i < steps; i++) {
2096 if (avg_lum > desired_avg_lum) {
2097 if (gain > gain_knee)
2099 else if (exposure > exposure_knee)
2101 else if (gain > gain_ctrl->qctrl.default_value)
2103 else if (exposure > exposure_ctrl->qctrl.minimum)
2105 else if (gain > gain_ctrl->qctrl.minimum)
2110 if (gain < gain_ctrl->qctrl.default_value)
2112 else if (exposure < exposure_knee)
2114 else if (gain < gain_knee)
2116 else if (exposure < exposure_ctrl->qctrl.maximum)
2118 else if (gain < gain_ctrl->qctrl.maximum)
2125 if (gain != orig_gain) {
2126 gain_ctrl->set(gspca_dev, gain);
2129 if (exposure != orig_exposure) {
2130 exposure_ctrl->set(gspca_dev, exposure);
2136 EXPORT_SYMBOL(gspca_auto_gain_n_exposure);
2138 /* -- module insert / remove -- */
2139 static int __init gspca_init(void)
2141 info("main v%d.%d.%d registered",
2142 (DRIVER_VERSION_NUMBER >> 16) & 0xff,
2143 (DRIVER_VERSION_NUMBER >> 8) & 0xff,
2144 DRIVER_VERSION_NUMBER & 0xff);
2147 static void __exit gspca_exit(void)
2149 info("main deregistered");
2152 module_init(gspca_init);
2153 module_exit(gspca_exit);
2156 module_param_named(debug, gspca_debug, int, 0644);
2157 MODULE_PARM_DESC(debug,
2158 "Debug (bit) 0x01:error 0x02:probe 0x04:config"
2159 " 0x08:stream 0x10:frame 0x20:packet 0x40:USBin 0x80:USBout"