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, 8, 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 be 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 const 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)
141 PDEBUG(D_ERR|D_PACK, "urb status: %d", urb->status);
144 pkt_scan = gspca_dev->sd_desc->pkt_scan;
145 for (i = 0; i < urb->number_of_packets; i++) {
147 /* check the availability of the frame buffer */
148 frame = gspca_get_i_frame(gspca_dev);
150 gspca_dev->last_packet_type = DISCARD_PACKET;
154 /* check the packet status and length */
155 len = urb->iso_frame_desc[i].actual_length;
157 if (gspca_dev->empty_packet == 0)
158 gspca_dev->empty_packet = 1;
161 st = urb->iso_frame_desc[i].status;
164 "ISOC data error: [%d] len=%d, status=%d",
166 gspca_dev->last_packet_type = DISCARD_PACKET;
170 /* let the packet be analyzed by the subdriver */
171 PDEBUG(D_PACK, "packet [%d] o:%d l:%d",
172 i, urb->iso_frame_desc[i].offset, len);
173 data = (u8 *) urb->transfer_buffer
174 + urb->iso_frame_desc[i].offset;
175 pkt_scan(gspca_dev, frame, data, len);
179 /* resubmit the URB */
180 st = usb_submit_urb(urb, GFP_ATOMIC);
182 PDEBUG(D_ERR|D_PACK, "usb_submit_urb() ret %d", st);
186 * ISOC message interrupt from the USB device
188 * Analyse each packet and call the subdriver for copy to the frame buffer.
190 static void isoc_irq(struct urb *urb)
192 struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
194 PDEBUG(D_PACK, "isoc irq");
195 if (!gspca_dev->streaming)
197 fill_frame(gspca_dev, urb);
201 * bulk message interrupt from the USB device
203 static void bulk_irq(struct urb *urb)
205 struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
206 struct gspca_frame *frame;
209 PDEBUG(D_PACK, "bulk irq");
210 if (!gspca_dev->streaming)
212 switch (urb->status) {
216 return; /* disconnection */
222 if (gspca_dev->frozen)
225 PDEBUG(D_ERR|D_PACK, "urb status: %d", urb->status);
229 /* check the availability of the frame buffer */
230 frame = gspca_get_i_frame(gspca_dev);
232 gspca_dev->last_packet_type = DISCARD_PACKET;
234 PDEBUG(D_PACK, "packet l:%d", urb->actual_length);
235 gspca_dev->sd_desc->pkt_scan(gspca_dev,
237 urb->transfer_buffer,
242 /* resubmit the URB */
243 if (gspca_dev->cam.bulk_nurbs != 0) {
244 st = usb_submit_urb(urb, GFP_ATOMIC);
246 PDEBUG(D_ERR|D_PACK, "usb_submit_urb() ret %d", st);
251 * add data to the current frame
253 * This function is called by the subdrivers at interrupt level.
255 * To build a frame, these ones must add
257 * - 0 or many INTER_PACKETs
259 * DISCARD_PACKET invalidates the whole frame.
260 * On LAST_PACKET, a new frame is returned.
262 struct gspca_frame *gspca_frame_add(struct gspca_dev *gspca_dev,
263 enum gspca_packet_type packet_type,
264 struct gspca_frame *frame,
270 PDEBUG(D_PACK, "add t:%d l:%d", packet_type, len);
272 /* when start of a new frame, if the current frame buffer
273 * is not queued, discard the whole frame */
274 if (packet_type == FIRST_PACKET) {
275 if ((frame->v4l2_buf.flags & BUF_ALL_FLAGS)
276 != V4L2_BUF_FLAG_QUEUED) {
277 gspca_dev->last_packet_type = DISCARD_PACKET;
280 frame->data_end = frame->data;
281 jiffies_to_timeval(get_jiffies_64(),
282 &frame->v4l2_buf.timestamp);
283 frame->v4l2_buf.sequence = ++gspca_dev->sequence;
284 } else if (gspca_dev->last_packet_type == DISCARD_PACKET) {
285 if (packet_type == LAST_PACKET)
286 gspca_dev->last_packet_type = packet_type;
290 /* append the packet to the frame buffer */
292 if (frame->data_end - frame->data + len
293 > frame->v4l2_buf.length) {
294 PDEBUG(D_ERR|D_PACK, "frame overflow %zd > %d",
295 frame->data_end - frame->data + len,
296 frame->v4l2_buf.length);
297 packet_type = DISCARD_PACKET;
299 memcpy(frame->data_end, data, len);
300 frame->data_end += len;
303 gspca_dev->last_packet_type = packet_type;
305 /* if last packet, wake up the application and advance in the queue */
306 if (packet_type == LAST_PACKET) {
307 frame->v4l2_buf.bytesused = frame->data_end - frame->data;
308 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_QUEUED;
309 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_DONE;
310 wake_up_interruptible(&gspca_dev->wq); /* event = new frame */
311 i = (gspca_dev->fr_i + 1) % gspca_dev->nframes;
313 PDEBUG(D_FRAM, "frame complete len:%d q:%d i:%d o:%d",
314 frame->v4l2_buf.bytesused,
318 j = gspca_dev->fr_queue[i];
319 frame = &gspca_dev->frame[j];
323 EXPORT_SYMBOL(gspca_frame_add);
325 static int gspca_is_compressed(__u32 format)
328 case V4L2_PIX_FMT_MJPEG:
329 case V4L2_PIX_FMT_JPEG:
330 case V4L2_PIX_FMT_SPCA561:
331 case V4L2_PIX_FMT_PAC207:
332 case V4L2_PIX_FMT_MR97310A:
338 static void *rvmalloc(unsigned long size)
343 mem = vmalloc_32(size);
345 adr = (unsigned long) mem;
346 while ((long) size > 0) {
347 SetPageReserved(vmalloc_to_page((void *) adr));
355 static void rvfree(void *mem, long size)
359 adr = (unsigned long) mem;
361 ClearPageReserved(vmalloc_to_page((void *) adr));
368 static int frame_alloc(struct gspca_dev *gspca_dev,
371 struct gspca_frame *frame;
375 i = gspca_dev->curr_mode;
376 frsz = gspca_dev->cam.cam_mode[i].sizeimage;
377 PDEBUG(D_STREAM, "frame alloc frsz: %d", frsz);
378 frsz = PAGE_ALIGN(frsz);
379 gspca_dev->frsz = frsz;
380 if (count > GSPCA_MAX_FRAMES)
381 count = GSPCA_MAX_FRAMES;
382 gspca_dev->frbuf = rvmalloc(frsz * count);
383 if (!gspca_dev->frbuf) {
384 err("frame alloc failed");
387 gspca_dev->nframes = count;
388 for (i = 0; i < count; i++) {
389 frame = &gspca_dev->frame[i];
390 frame->v4l2_buf.index = i;
391 frame->v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
392 frame->v4l2_buf.flags = 0;
393 frame->v4l2_buf.field = V4L2_FIELD_NONE;
394 frame->v4l2_buf.length = frsz;
395 frame->v4l2_buf.memory = gspca_dev->memory;
396 frame->v4l2_buf.sequence = 0;
397 frame->data = frame->data_end =
398 gspca_dev->frbuf + i * frsz;
399 frame->v4l2_buf.m.offset = i * frsz;
401 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
402 gspca_dev->last_packet_type = DISCARD_PACKET;
403 gspca_dev->sequence = 0;
407 static void frame_free(struct gspca_dev *gspca_dev)
411 PDEBUG(D_STREAM, "frame free");
412 if (gspca_dev->frbuf != NULL) {
413 rvfree(gspca_dev->frbuf,
414 gspca_dev->nframes * gspca_dev->frsz);
415 gspca_dev->frbuf = NULL;
416 for (i = 0; i < gspca_dev->nframes; i++)
417 gspca_dev->frame[i].data = NULL;
419 gspca_dev->nframes = 0;
422 static void destroy_urbs(struct gspca_dev *gspca_dev)
427 PDEBUG(D_STREAM, "kill transfer");
428 for (i = 0; i < MAX_NURBS; i++) {
429 urb = gspca_dev->urb[i];
433 gspca_dev->urb[i] = NULL;
435 if (urb->transfer_buffer != NULL)
436 usb_buffer_free(gspca_dev->dev,
437 urb->transfer_buffer_length,
438 urb->transfer_buffer,
445 * look for an input transfer endpoint in an alternate setting
447 static struct usb_host_endpoint *alt_xfer(struct usb_host_interface *alt,
450 struct usb_host_endpoint *ep;
453 for (i = 0; i < alt->desc.bNumEndpoints; i++) {
454 ep = &alt->endpoint[i];
455 attr = ep->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
457 && ep->desc.wMaxPacketSize != 0)
464 * look for an input (isoc or bulk) endpoint
466 * The endpoint is defined by the subdriver.
467 * Use only the first isoc (some Zoran - 0x0572:0x0001 - have two such ep).
468 * This routine may be called many times when the bandwidth is too small
469 * (the bandwidth is checked on urb submit).
471 static struct usb_host_endpoint *get_ep(struct gspca_dev *gspca_dev)
473 struct usb_interface *intf;
474 struct usb_host_endpoint *ep;
477 intf = usb_ifnum_to_if(gspca_dev->dev, gspca_dev->iface);
479 xfer = gspca_dev->cam.bulk ? USB_ENDPOINT_XFER_BULK
480 : USB_ENDPOINT_XFER_ISOC;
481 i = gspca_dev->alt; /* previous alt setting */
482 if (gspca_dev->cam.reverse_alts) {
483 while (++i < gspca_dev->nbalt) {
484 ep = alt_xfer(&intf->altsetting[i], xfer);
490 ep = alt_xfer(&intf->altsetting[i], xfer);
496 err("no transfer endpoint found");
499 PDEBUG(D_STREAM, "use alt %d ep 0x%02x",
500 i, ep->desc.bEndpointAddress);
501 gspca_dev->alt = i; /* memorize the current alt setting */
502 if (gspca_dev->nbalt > 1) {
503 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, i);
505 err("set alt %d err %d", i, ret);
513 * create the URBs for image transfer
515 static int create_urbs(struct gspca_dev *gspca_dev,
516 struct usb_host_endpoint *ep)
519 int n, nurbs, i, psize, npkt, bsize;
521 /* calculate the packet size and the number of packets */
522 psize = le16_to_cpu(ep->desc.wMaxPacketSize);
524 if (!gspca_dev->cam.bulk) { /* isoc */
526 /* See paragraph 5.9 / table 5-11 of the usb 2.0 spec. */
527 if (gspca_dev->pkt_size == 0)
528 psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
530 psize = gspca_dev->pkt_size;
531 npkt = gspca_dev->cam.npkt;
533 npkt = 32; /* default value */
534 bsize = psize * npkt;
536 "isoc %d pkts size %d = bsize:%d",
541 bsize = gspca_dev->cam.bulk_size;
544 PDEBUG(D_STREAM, "bulk bsize:%d", bsize);
545 if (gspca_dev->cam.bulk_nurbs != 0)
546 nurbs = gspca_dev->cam.bulk_nurbs;
551 gspca_dev->nurbs = nurbs;
552 for (n = 0; n < nurbs; n++) {
553 urb = usb_alloc_urb(npkt, GFP_KERNEL);
555 err("usb_alloc_urb failed");
556 destroy_urbs(gspca_dev);
559 urb->transfer_buffer = usb_buffer_alloc(gspca_dev->dev,
564 if (urb->transfer_buffer == NULL) {
566 err("usb_buffer_urb failed");
567 destroy_urbs(gspca_dev);
570 gspca_dev->urb[n] = urb;
571 urb->dev = gspca_dev->dev;
572 urb->context = gspca_dev;
573 urb->transfer_buffer_length = bsize;
574 if (npkt != 0) { /* ISOC */
575 urb->pipe = usb_rcvisocpipe(gspca_dev->dev,
576 ep->desc.bEndpointAddress);
577 urb->transfer_flags = URB_ISO_ASAP
578 | URB_NO_TRANSFER_DMA_MAP;
579 urb->interval = ep->desc.bInterval;
580 urb->complete = isoc_irq;
581 urb->number_of_packets = npkt;
582 for (i = 0; i < npkt; i++) {
583 urb->iso_frame_desc[i].length = psize;
584 urb->iso_frame_desc[i].offset = psize * i;
587 urb->pipe = usb_rcvbulkpipe(gspca_dev->dev,
588 ep->desc.bEndpointAddress),
589 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
590 urb->complete = bulk_irq;
597 * start the USB transfer
599 static int gspca_init_transfer(struct gspca_dev *gspca_dev)
601 struct usb_host_endpoint *ep;
604 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
607 if (!gspca_dev->present) {
612 /* set the higher alternate setting and
613 * loop until urb submit succeeds */
614 if (gspca_dev->cam.reverse_alts)
617 gspca_dev->alt = gspca_dev->nbalt;
619 if (gspca_dev->sd_desc->isoc_init) {
620 ret = gspca_dev->sd_desc->isoc_init(gspca_dev);
624 ep = get_ep(gspca_dev);
630 PDEBUG(D_STREAM, "init transfer alt %d", gspca_dev->alt);
631 ret = create_urbs(gspca_dev, ep);
635 /* clear the bulk endpoint */
636 if (gspca_dev->cam.bulk)
637 usb_clear_halt(gspca_dev->dev,
638 gspca_dev->urb[0]->pipe);
641 ret = gspca_dev->sd_desc->start(gspca_dev);
643 destroy_urbs(gspca_dev);
646 gspca_dev->streaming = 1;
648 /* some bulk transfers are started by the subdriver */
649 if (gspca_dev->cam.bulk && gspca_dev->cam.bulk_nurbs == 0)
652 /* submit the URBs */
653 for (n = 0; n < gspca_dev->nurbs; n++) {
654 ret = usb_submit_urb(gspca_dev->urb[n], GFP_KERNEL);
660 PDEBUG(D_ERR|D_STREAM,
661 "usb_submit_urb alt %d err %d", gspca_dev->alt, ret);
662 gspca_dev->streaming = 0;
663 destroy_urbs(gspca_dev);
667 /* the bandwidth is not wide enough
668 * negociate or try a lower alternate setting */
669 msleep(20); /* wait for kill complete */
670 if (gspca_dev->sd_desc->isoc_nego) {
671 ret = gspca_dev->sd_desc->isoc_nego(gspca_dev);
675 ep = get_ep(gspca_dev);
683 mutex_unlock(&gspca_dev->usb_lock);
687 static int gspca_set_alt0(struct gspca_dev *gspca_dev)
691 if (gspca_dev->alt == 0)
693 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, 0);
695 PDEBUG(D_ERR|D_STREAM, "set alt 0 err %d", ret);
699 /* Note: both the queue and the usb locks should be held when calling this */
700 static void gspca_stream_off(struct gspca_dev *gspca_dev)
702 gspca_dev->streaming = 0;
703 if (gspca_dev->present) {
704 if (gspca_dev->sd_desc->stopN)
705 gspca_dev->sd_desc->stopN(gspca_dev);
706 destroy_urbs(gspca_dev);
707 gspca_set_alt0(gspca_dev);
710 /* always call stop0 to free the subdriver's resources */
711 if (gspca_dev->sd_desc->stop0)
712 gspca_dev->sd_desc->stop0(gspca_dev);
713 PDEBUG(D_STREAM, "stream off OK");
716 static void gspca_set_default_mode(struct gspca_dev *gspca_dev)
720 i = gspca_dev->cam.nmodes - 1; /* take the highest mode */
721 gspca_dev->curr_mode = i;
722 gspca_dev->width = gspca_dev->cam.cam_mode[i].width;
723 gspca_dev->height = gspca_dev->cam.cam_mode[i].height;
724 gspca_dev->pixfmt = gspca_dev->cam.cam_mode[i].pixelformat;
727 static int wxh_to_mode(struct gspca_dev *gspca_dev,
728 int width, int height)
732 for (i = gspca_dev->cam.nmodes; --i > 0; ) {
733 if (width >= gspca_dev->cam.cam_mode[i].width
734 && height >= gspca_dev->cam.cam_mode[i].height)
741 * search a mode with the right pixel format
743 static int gspca_get_mode(struct gspca_dev *gspca_dev,
749 modeU = modeD = mode;
750 while ((modeU < gspca_dev->cam.nmodes) || modeD >= 0) {
752 if (gspca_dev->cam.cam_mode[modeD].pixelformat
756 if (++modeU < gspca_dev->cam.nmodes) {
757 if (gspca_dev->cam.cam_mode[modeU].pixelformat
765 #ifdef CONFIG_VIDEO_ADV_DEBUG
766 static int vidioc_g_register(struct file *file, void *priv,
767 struct v4l2_dbg_register *reg)
770 struct gspca_dev *gspca_dev = priv;
772 if (!gspca_dev->sd_desc->get_chip_ident)
775 if (!gspca_dev->sd_desc->get_register)
778 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
780 if (gspca_dev->present)
781 ret = gspca_dev->sd_desc->get_register(gspca_dev, reg);
784 mutex_unlock(&gspca_dev->usb_lock);
789 static int vidioc_s_register(struct file *file, void *priv,
790 struct v4l2_dbg_register *reg)
793 struct gspca_dev *gspca_dev = priv;
795 if (!gspca_dev->sd_desc->get_chip_ident)
798 if (!gspca_dev->sd_desc->set_register)
801 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
803 if (gspca_dev->present)
804 ret = gspca_dev->sd_desc->set_register(gspca_dev, reg);
807 mutex_unlock(&gspca_dev->usb_lock);
813 static int vidioc_g_chip_ident(struct file *file, void *priv,
814 struct v4l2_dbg_chip_ident *chip)
817 struct gspca_dev *gspca_dev = priv;
819 if (!gspca_dev->sd_desc->get_chip_ident)
822 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
824 if (gspca_dev->present)
825 ret = gspca_dev->sd_desc->get_chip_ident(gspca_dev, chip);
828 mutex_unlock(&gspca_dev->usb_lock);
833 static int vidioc_enum_fmt_vid_cap(struct file *file, void *priv,
834 struct v4l2_fmtdesc *fmtdesc)
836 struct gspca_dev *gspca_dev = priv;
840 /* give an index to each format */
843 for (i = gspca_dev->cam.nmodes; --i >= 0; ) {
844 fmt_tb[index] = gspca_dev->cam.cam_mode[i].pixelformat;
847 if (fmt_tb[j] == fmt_tb[index])
852 if (fmtdesc->index == index)
853 break; /* new format */
855 if (index >= ARRAY_SIZE(fmt_tb))
860 return -EINVAL; /* no more format */
862 fmtdesc->pixelformat = fmt_tb[index];
863 if (gspca_is_compressed(fmt_tb[index]))
864 fmtdesc->flags = V4L2_FMT_FLAG_COMPRESSED;
865 fmtdesc->description[0] = fmtdesc->pixelformat & 0xff;
866 fmtdesc->description[1] = (fmtdesc->pixelformat >> 8) & 0xff;
867 fmtdesc->description[2] = (fmtdesc->pixelformat >> 16) & 0xff;
868 fmtdesc->description[3] = fmtdesc->pixelformat >> 24;
869 fmtdesc->description[4] = '\0';
873 static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
874 struct v4l2_format *fmt)
876 struct gspca_dev *gspca_dev = priv;
879 mode = gspca_dev->curr_mode;
880 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
881 sizeof fmt->fmt.pix);
885 static int try_fmt_vid_cap(struct gspca_dev *gspca_dev,
886 struct v4l2_format *fmt)
888 int w, h, mode, mode2;
890 w = fmt->fmt.pix.width;
891 h = fmt->fmt.pix.height;
894 if (gspca_debug & D_CONF)
895 PDEBUG_MODE("try fmt cap", fmt->fmt.pix.pixelformat, w, h);
897 /* search the closest mode for width and height */
898 mode = wxh_to_mode(gspca_dev, w, h);
900 /* OK if right palette */
901 if (gspca_dev->cam.cam_mode[mode].pixelformat
902 != fmt->fmt.pix.pixelformat) {
904 /* else, search the closest mode with the same pixel format */
905 mode2 = gspca_get_mode(gspca_dev, mode,
906 fmt->fmt.pix.pixelformat);
910 ; * no chance, return this mode */
912 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
913 sizeof fmt->fmt.pix);
914 return mode; /* used when s_fmt */
917 static int vidioc_try_fmt_vid_cap(struct file *file,
919 struct v4l2_format *fmt)
921 struct gspca_dev *gspca_dev = priv;
924 ret = try_fmt_vid_cap(gspca_dev, fmt);
930 static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
931 struct v4l2_format *fmt)
933 struct gspca_dev *gspca_dev = priv;
936 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
939 ret = try_fmt_vid_cap(gspca_dev, fmt);
943 if (gspca_dev->nframes != 0
944 && fmt->fmt.pix.sizeimage > gspca_dev->frsz) {
949 if (ret == gspca_dev->curr_mode) {
951 goto out; /* same mode */
954 if (gspca_dev->streaming) {
958 gspca_dev->width = fmt->fmt.pix.width;
959 gspca_dev->height = fmt->fmt.pix.height;
960 gspca_dev->pixfmt = fmt->fmt.pix.pixelformat;
961 gspca_dev->curr_mode = ret;
965 mutex_unlock(&gspca_dev->queue_lock);
969 static int vidioc_enum_framesizes(struct file *file, void *priv,
970 struct v4l2_frmsizeenum *fsize)
972 struct gspca_dev *gspca_dev = priv;
976 for (i = 0; i < gspca_dev->cam.nmodes; i++) {
977 if (fsize->pixel_format !=
978 gspca_dev->cam.cam_mode[i].pixelformat)
981 if (fsize->index == index) {
982 fsize->type = V4L2_FRMSIZE_TYPE_DISCRETE;
983 fsize->discrete.width =
984 gspca_dev->cam.cam_mode[i].width;
985 fsize->discrete.height =
986 gspca_dev->cam.cam_mode[i].height;
995 static void gspca_release(struct video_device *vfd)
997 struct gspca_dev *gspca_dev = container_of(vfd, struct gspca_dev, vdev);
999 PDEBUG(D_PROBE, "/dev/video%d released", gspca_dev->vdev.num);
1001 kfree(gspca_dev->usb_buf);
1005 static int dev_open(struct file *file)
1007 struct gspca_dev *gspca_dev;
1010 PDEBUG(D_STREAM, "[%s] open", current->comm);
1011 gspca_dev = (struct gspca_dev *) video_devdata(file);
1012 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1013 return -ERESTARTSYS;
1014 if (!gspca_dev->present) {
1019 if (gspca_dev->users > 4) { /* (arbitrary value) */
1024 /* protect the subdriver against rmmod */
1025 if (!try_module_get(gspca_dev->module)) {
1032 file->private_data = gspca_dev;
1034 /* activate the v4l2 debug */
1035 if (gspca_debug & D_V4L2)
1036 gspca_dev->vdev.debug |= V4L2_DEBUG_IOCTL
1037 | V4L2_DEBUG_IOCTL_ARG;
1039 gspca_dev->vdev.debug &= ~(V4L2_DEBUG_IOCTL
1040 | V4L2_DEBUG_IOCTL_ARG);
1044 mutex_unlock(&gspca_dev->queue_lock);
1046 PDEBUG(D_ERR|D_STREAM, "open failed err %d", ret);
1048 PDEBUG(D_STREAM, "open done");
1052 static int dev_close(struct file *file)
1054 struct gspca_dev *gspca_dev = file->private_data;
1056 PDEBUG(D_STREAM, "[%s] close", current->comm);
1057 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1058 return -ERESTARTSYS;
1061 /* if the file did the capture, free the streaming resources */
1062 if (gspca_dev->capt_file == file) {
1063 if (gspca_dev->streaming) {
1064 mutex_lock(&gspca_dev->usb_lock);
1065 gspca_stream_off(gspca_dev);
1066 mutex_unlock(&gspca_dev->usb_lock);
1068 frame_free(gspca_dev);
1069 gspca_dev->capt_file = NULL;
1070 gspca_dev->memory = GSPCA_MEMORY_NO;
1072 file->private_data = NULL;
1073 module_put(gspca_dev->module);
1074 mutex_unlock(&gspca_dev->queue_lock);
1076 PDEBUG(D_STREAM, "close done");
1081 static int vidioc_querycap(struct file *file, void *priv,
1082 struct v4l2_capability *cap)
1084 struct gspca_dev *gspca_dev = priv;
1087 /* protect the access to the usb device */
1088 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1089 return -ERESTARTSYS;
1090 if (!gspca_dev->present) {
1094 strncpy(cap->driver, gspca_dev->sd_desc->name, sizeof cap->driver);
1095 if (gspca_dev->dev->product != NULL) {
1096 strncpy(cap->card, gspca_dev->dev->product,
1099 snprintf(cap->card, sizeof cap->card,
1100 "USB Camera (%04x:%04x)",
1101 le16_to_cpu(gspca_dev->dev->descriptor.idVendor),
1102 le16_to_cpu(gspca_dev->dev->descriptor.idProduct));
1104 usb_make_path(gspca_dev->dev, cap->bus_info, sizeof(cap->bus_info));
1105 cap->version = DRIVER_VERSION_NUMBER;
1106 cap->capabilities = V4L2_CAP_VIDEO_CAPTURE
1107 | V4L2_CAP_STREAMING
1108 | V4L2_CAP_READWRITE;
1111 mutex_unlock(&gspca_dev->usb_lock);
1115 static const struct ctrl *get_ctrl(struct gspca_dev *gspca_dev,
1118 const struct ctrl *ctrls;
1121 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
1122 i < gspca_dev->sd_desc->nctrls;
1124 if (gspca_dev->ctrl_dis & (1 << i))
1126 if (id == ctrls->qctrl.id)
1132 static int vidioc_queryctrl(struct file *file, void *priv,
1133 struct v4l2_queryctrl *q_ctrl)
1135 struct gspca_dev *gspca_dev = priv;
1136 const struct ctrl *ctrls;
1142 if (id & V4L2_CTRL_FLAG_NEXT_CTRL) {
1143 id &= V4L2_CTRL_ID_MASK;
1145 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
1146 if (gspca_dev->ctrl_dis & (1 << i))
1148 if (gspca_dev->sd_desc->ctrls[i].qctrl.id < id)
1150 if (ctrls && gspca_dev->sd_desc->ctrls[i].qctrl.id
1153 ctrls = &gspca_dev->sd_desc->ctrls[i];
1156 ctrls = get_ctrl(gspca_dev, id);
1160 memcpy(q_ctrl, ctrls, sizeof *q_ctrl);
1164 static int vidioc_s_ctrl(struct file *file, void *priv,
1165 struct v4l2_control *ctrl)
1167 struct gspca_dev *gspca_dev = priv;
1168 const struct ctrl *ctrls;
1171 ctrls = get_ctrl(gspca_dev, ctrl->id);
1175 if (ctrl->value < ctrls->qctrl.minimum
1176 || ctrl->value > ctrls->qctrl.maximum)
1178 PDEBUG(D_CONF, "set ctrl [%08x] = %d", ctrl->id, ctrl->value);
1179 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1180 return -ERESTARTSYS;
1181 if (gspca_dev->present)
1182 ret = ctrls->set(gspca_dev, ctrl->value);
1185 mutex_unlock(&gspca_dev->usb_lock);
1189 static int vidioc_g_ctrl(struct file *file, void *priv,
1190 struct v4l2_control *ctrl)
1192 struct gspca_dev *gspca_dev = priv;
1193 const struct ctrl *ctrls;
1196 ctrls = get_ctrl(gspca_dev, ctrl->id);
1200 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1201 return -ERESTARTSYS;
1202 if (gspca_dev->present)
1203 ret = ctrls->get(gspca_dev, &ctrl->value);
1206 mutex_unlock(&gspca_dev->usb_lock);
1210 /*fixme: have an audio flag in gspca_dev?*/
1211 static int vidioc_s_audio(struct file *file, void *priv,
1212 struct v4l2_audio *audio)
1214 if (audio->index != 0)
1219 static int vidioc_g_audio(struct file *file, void *priv,
1220 struct v4l2_audio *audio)
1222 strcpy(audio->name, "Microphone");
1226 static int vidioc_enumaudio(struct file *file, void *priv,
1227 struct v4l2_audio *audio)
1229 if (audio->index != 0)
1232 strcpy(audio->name, "Microphone");
1233 audio->capability = 0;
1238 static int vidioc_querymenu(struct file *file, void *priv,
1239 struct v4l2_querymenu *qmenu)
1241 struct gspca_dev *gspca_dev = priv;
1243 if (!gspca_dev->sd_desc->querymenu)
1245 return gspca_dev->sd_desc->querymenu(gspca_dev, qmenu);
1248 static int vidioc_enum_input(struct file *file, void *priv,
1249 struct v4l2_input *input)
1251 struct gspca_dev *gspca_dev = priv;
1253 if (input->index != 0)
1255 input->type = V4L2_INPUT_TYPE_CAMERA;
1256 input->status = gspca_dev->cam.input_flags;
1257 strncpy(input->name, gspca_dev->sd_desc->name,
1258 sizeof input->name);
1262 static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
1268 static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
1275 static int vidioc_reqbufs(struct file *file, void *priv,
1276 struct v4l2_requestbuffers *rb)
1278 struct gspca_dev *gspca_dev = priv;
1281 switch (rb->memory) {
1282 case GSPCA_MEMORY_READ: /* (internal call) */
1283 case V4L2_MEMORY_MMAP:
1284 case V4L2_MEMORY_USERPTR:
1289 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1290 return -ERESTARTSYS;
1292 if (gspca_dev->memory != GSPCA_MEMORY_NO
1293 && gspca_dev->memory != rb->memory) {
1298 /* only one file may do the capture */
1299 if (gspca_dev->capt_file != NULL
1300 && gspca_dev->capt_file != file) {
1305 /* if allocated, the buffers must not be mapped */
1306 for (i = 0; i < gspca_dev->nframes; i++) {
1307 if (gspca_dev->frame[i].vma_use_count) {
1313 /* stop streaming */
1314 if (gspca_dev->streaming) {
1315 mutex_lock(&gspca_dev->usb_lock);
1316 gspca_stream_off(gspca_dev);
1317 mutex_unlock(&gspca_dev->usb_lock);
1320 /* free the previous allocated buffers, if any */
1321 if (gspca_dev->nframes != 0) {
1322 frame_free(gspca_dev);
1323 gspca_dev->capt_file = NULL;
1325 if (rb->count == 0) /* unrequest */
1327 gspca_dev->memory = rb->memory;
1328 ret = frame_alloc(gspca_dev, rb->count);
1330 rb->count = gspca_dev->nframes;
1331 gspca_dev->capt_file = file;
1334 mutex_unlock(&gspca_dev->queue_lock);
1335 PDEBUG(D_STREAM, "reqbufs st:%d c:%d", ret, rb->count);
1339 static int vidioc_querybuf(struct file *file, void *priv,
1340 struct v4l2_buffer *v4l2_buf)
1342 struct gspca_dev *gspca_dev = priv;
1343 struct gspca_frame *frame;
1345 if (v4l2_buf->index < 0
1346 || v4l2_buf->index >= gspca_dev->nframes)
1349 frame = &gspca_dev->frame[v4l2_buf->index];
1350 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1354 static int vidioc_streamon(struct file *file, void *priv,
1355 enum v4l2_buf_type buf_type)
1357 struct gspca_dev *gspca_dev = priv;
1360 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1362 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1363 return -ERESTARTSYS;
1365 if (gspca_dev->nframes == 0
1366 || !(gspca_dev->frame[0].v4l2_buf.flags & V4L2_BUF_FLAG_QUEUED)) {
1370 if (!gspca_dev->streaming) {
1371 ret = gspca_init_transfer(gspca_dev);
1376 if (gspca_debug & D_STREAM) {
1377 PDEBUG_MODE("stream on OK",
1385 mutex_unlock(&gspca_dev->queue_lock);
1389 static int vidioc_streamoff(struct file *file, void *priv,
1390 enum v4l2_buf_type buf_type)
1392 struct gspca_dev *gspca_dev = priv;
1395 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1397 if (!gspca_dev->streaming)
1399 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1400 return -ERESTARTSYS;
1402 /* stop streaming */
1403 if (mutex_lock_interruptible(&gspca_dev->usb_lock)) {
1407 gspca_stream_off(gspca_dev);
1408 mutex_unlock(&gspca_dev->usb_lock);
1410 /* empty the application queues */
1411 for (i = 0; i < gspca_dev->nframes; i++)
1412 gspca_dev->frame[i].v4l2_buf.flags &= ~BUF_ALL_FLAGS;
1413 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
1414 gspca_dev->last_packet_type = DISCARD_PACKET;
1415 gspca_dev->sequence = 0;
1418 mutex_unlock(&gspca_dev->queue_lock);
1422 static int vidioc_g_jpegcomp(struct file *file, void *priv,
1423 struct v4l2_jpegcompression *jpegcomp)
1425 struct gspca_dev *gspca_dev = priv;
1428 if (!gspca_dev->sd_desc->get_jcomp)
1430 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1431 return -ERESTARTSYS;
1432 if (gspca_dev->present)
1433 ret = gspca_dev->sd_desc->get_jcomp(gspca_dev, jpegcomp);
1436 mutex_unlock(&gspca_dev->usb_lock);
1440 static int vidioc_s_jpegcomp(struct file *file, void *priv,
1441 struct v4l2_jpegcompression *jpegcomp)
1443 struct gspca_dev *gspca_dev = priv;
1446 if (!gspca_dev->sd_desc->set_jcomp)
1448 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1449 return -ERESTARTSYS;
1450 if (gspca_dev->present)
1451 ret = gspca_dev->sd_desc->set_jcomp(gspca_dev, jpegcomp);
1454 mutex_unlock(&gspca_dev->usb_lock);
1458 static int vidioc_g_parm(struct file *filp, void *priv,
1459 struct v4l2_streamparm *parm)
1461 struct gspca_dev *gspca_dev = priv;
1463 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1465 if (gspca_dev->sd_desc->get_streamparm) {
1468 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1469 return -ERESTARTSYS;
1470 if (gspca_dev->present)
1471 ret = gspca_dev->sd_desc->get_streamparm(gspca_dev,
1475 mutex_unlock(&gspca_dev->usb_lock);
1482 static int vidioc_s_parm(struct file *filp, void *priv,
1483 struct v4l2_streamparm *parm)
1485 struct gspca_dev *gspca_dev = priv;
1488 n = parm->parm.capture.readbuffers;
1489 if (n == 0 || n > GSPCA_MAX_FRAMES)
1490 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1492 gspca_dev->nbufread = n;
1494 if (gspca_dev->sd_desc->set_streamparm) {
1497 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1498 return -ERESTARTSYS;
1499 if (gspca_dev->present)
1500 ret = gspca_dev->sd_desc->set_streamparm(gspca_dev,
1504 mutex_unlock(&gspca_dev->usb_lock);
1511 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1512 static int vidiocgmbuf(struct file *file, void *priv,
1513 struct video_mbuf *mbuf)
1515 struct gspca_dev *gspca_dev = file->private_data;
1518 PDEBUG(D_STREAM, "cgmbuf");
1519 if (gspca_dev->nframes == 0) {
1523 struct v4l2_format fmt;
1525 fmt.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1526 i = gspca_dev->cam.nmodes - 1; /* highest mode */
1527 fmt.fmt.pix.width = gspca_dev->cam.cam_mode[i].width;
1528 fmt.fmt.pix.height = gspca_dev->cam.cam_mode[i].height;
1529 fmt.fmt.pix.pixelformat = V4L2_PIX_FMT_BGR24;
1530 ret = vidioc_s_fmt_vid_cap(file, priv, &fmt);
1535 struct v4l2_requestbuffers rb;
1537 memset(&rb, 0, sizeof rb);
1539 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1540 rb.memory = V4L2_MEMORY_MMAP;
1541 ret = vidioc_reqbufs(file, priv, &rb);
1546 mbuf->frames = gspca_dev->nframes;
1547 mbuf->size = gspca_dev->frsz * gspca_dev->nframes;
1548 for (i = 0; i < mbuf->frames; i++)
1549 mbuf->offsets[i] = gspca_dev->frame[i].v4l2_buf.m.offset;
1554 static int dev_mmap(struct file *file, struct vm_area_struct *vma)
1556 struct gspca_dev *gspca_dev = file->private_data;
1557 struct gspca_frame *frame;
1559 unsigned long addr, start, size;
1562 start = vma->vm_start;
1563 size = vma->vm_end - vma->vm_start;
1564 PDEBUG(D_STREAM, "mmap start:%08x size:%d", (int) start, (int) size);
1566 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1567 return -ERESTARTSYS;
1568 if (!gspca_dev->present) {
1572 if (gspca_dev->capt_file != file) {
1578 for (i = 0; i < gspca_dev->nframes; ++i) {
1579 if (gspca_dev->frame[i].v4l2_buf.memory != V4L2_MEMORY_MMAP) {
1580 PDEBUG(D_STREAM, "mmap bad memory type");
1583 if ((gspca_dev->frame[i].v4l2_buf.m.offset >> PAGE_SHIFT)
1585 frame = &gspca_dev->frame[i];
1589 if (frame == NULL) {
1590 PDEBUG(D_STREAM, "mmap no frame buffer found");
1594 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1595 /* v4l1 maps all the buffers */
1597 || size != frame->v4l2_buf.length * gspca_dev->nframes)
1599 if (size != frame->v4l2_buf.length) {
1600 PDEBUG(D_STREAM, "mmap bad size");
1606 * - VM_IO marks the area as being a mmaped region for I/O to a
1607 * device. It also prevents the region from being core dumped.
1609 vma->vm_flags |= VM_IO;
1611 addr = (unsigned long) frame->data;
1613 page = vmalloc_to_page((void *) addr);
1614 ret = vm_insert_page(vma, start, page);
1622 vma->vm_ops = &gspca_vm_ops;
1623 vma->vm_private_data = frame;
1627 mutex_unlock(&gspca_dev->queue_lock);
1632 * wait for a video frame
1634 * If a frame is ready, its index is returned.
1636 static int frame_wait(struct gspca_dev *gspca_dev,
1639 struct gspca_frame *frame;
1642 /* check if a frame is ready */
1643 i = gspca_dev->fr_o;
1644 j = gspca_dev->fr_queue[i];
1645 frame = &gspca_dev->frame[j];
1647 if (!(frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE)) {
1651 /* wait till a frame is ready */
1652 ret = wait_event_interruptible_timeout(gspca_dev->wq,
1653 (frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE) ||
1654 !gspca_dev->streaming || !gspca_dev->present,
1655 msecs_to_jiffies(3000));
1658 if (ret == 0 || !gspca_dev->streaming || !gspca_dev->present)
1662 gspca_dev->fr_o = (i + 1) % gspca_dev->nframes;
1663 PDEBUG(D_FRAM, "frame wait q:%d i:%d o:%d",
1668 if (gspca_dev->sd_desc->dq_callback) {
1669 mutex_lock(&gspca_dev->usb_lock);
1670 if (gspca_dev->present)
1671 gspca_dev->sd_desc->dq_callback(gspca_dev);
1672 mutex_unlock(&gspca_dev->usb_lock);
1678 * dequeue a video buffer
1680 * If nonblock_ing is false, block until a buffer is available.
1682 static int vidioc_dqbuf(struct file *file, void *priv,
1683 struct v4l2_buffer *v4l2_buf)
1685 struct gspca_dev *gspca_dev = priv;
1686 struct gspca_frame *frame;
1689 PDEBUG(D_FRAM, "dqbuf");
1690 if (v4l2_buf->memory != gspca_dev->memory)
1693 if (!gspca_dev->present)
1696 /* if not streaming, be sure the application will not loop forever */
1697 if (!(file->f_flags & O_NONBLOCK)
1698 && !gspca_dev->streaming && gspca_dev->users == 1)
1701 /* only the capturing file may dequeue */
1702 if (gspca_dev->capt_file != file)
1705 /* only one dequeue / read at a time */
1706 if (mutex_lock_interruptible(&gspca_dev->read_lock))
1707 return -ERESTARTSYS;
1709 ret = frame_wait(gspca_dev, file->f_flags & O_NONBLOCK);
1712 i = ret; /* frame index */
1713 frame = &gspca_dev->frame[i];
1714 if (gspca_dev->memory == V4L2_MEMORY_USERPTR) {
1715 if (copy_to_user((__u8 __user *) frame->v4l2_buf.m.userptr,
1717 frame->v4l2_buf.bytesused)) {
1718 PDEBUG(D_ERR|D_STREAM,
1719 "dqbuf cp to user failed");
1724 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_DONE;
1725 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1726 PDEBUG(D_FRAM, "dqbuf %d", i);
1729 mutex_unlock(&gspca_dev->read_lock);
1734 * queue a video buffer
1736 * Attempting to queue a buffer that has already been
1737 * queued will return -EINVAL.
1739 static int vidioc_qbuf(struct file *file, void *priv,
1740 struct v4l2_buffer *v4l2_buf)
1742 struct gspca_dev *gspca_dev = priv;
1743 struct gspca_frame *frame;
1746 PDEBUG(D_FRAM, "qbuf %d", v4l2_buf->index);
1748 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1749 return -ERESTARTSYS;
1751 index = v4l2_buf->index;
1752 if ((unsigned) index >= gspca_dev->nframes) {
1754 "qbuf idx %d >= %d", index, gspca_dev->nframes);
1758 if (v4l2_buf->memory != gspca_dev->memory) {
1759 PDEBUG(D_FRAM, "qbuf bad memory type");
1764 frame = &gspca_dev->frame[index];
1765 if (frame->v4l2_buf.flags & BUF_ALL_FLAGS) {
1766 PDEBUG(D_FRAM, "qbuf bad state");
1771 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_QUEUED;
1773 if (frame->v4l2_buf.memory == V4L2_MEMORY_USERPTR) {
1774 frame->v4l2_buf.m.userptr = v4l2_buf->m.userptr;
1775 frame->v4l2_buf.length = v4l2_buf->length;
1778 /* put the buffer in the 'queued' queue */
1779 i = gspca_dev->fr_q;
1780 gspca_dev->fr_queue[i] = index;
1781 gspca_dev->fr_q = (i + 1) % gspca_dev->nframes;
1782 PDEBUG(D_FRAM, "qbuf q:%d i:%d o:%d",
1787 v4l2_buf->flags |= V4L2_BUF_FLAG_QUEUED;
1788 v4l2_buf->flags &= ~V4L2_BUF_FLAG_DONE;
1791 mutex_unlock(&gspca_dev->queue_lock);
1796 * allocate the resources for read()
1798 static int read_alloc(struct gspca_dev *gspca_dev,
1801 struct v4l2_buffer v4l2_buf;
1804 PDEBUG(D_STREAM, "read alloc");
1805 if (gspca_dev->nframes == 0) {
1806 struct v4l2_requestbuffers rb;
1808 memset(&rb, 0, sizeof rb);
1809 rb.count = gspca_dev->nbufread;
1810 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1811 rb.memory = GSPCA_MEMORY_READ;
1812 ret = vidioc_reqbufs(file, gspca_dev, &rb);
1814 PDEBUG(D_STREAM, "read reqbuf err %d", ret);
1817 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1818 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1819 v4l2_buf.memory = GSPCA_MEMORY_READ;
1820 for (i = 0; i < gspca_dev->nbufread; i++) {
1822 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1824 PDEBUG(D_STREAM, "read qbuf err: %d", ret);
1828 gspca_dev->memory = GSPCA_MEMORY_READ;
1831 /* start streaming */
1832 ret = vidioc_streamon(file, gspca_dev, V4L2_BUF_TYPE_VIDEO_CAPTURE);
1834 PDEBUG(D_STREAM, "read streamon err %d", ret);
1838 static unsigned int dev_poll(struct file *file, poll_table *wait)
1840 struct gspca_dev *gspca_dev = file->private_data;
1843 PDEBUG(D_FRAM, "poll");
1845 poll_wait(file, &gspca_dev->wq, wait);
1847 /* if reqbufs is not done, the user would use read() */
1848 if (gspca_dev->nframes == 0) {
1849 if (gspca_dev->memory != GSPCA_MEMORY_NO)
1850 return POLLERR; /* not the 1st time */
1851 ret = read_alloc(gspca_dev, file);
1856 if (mutex_lock_interruptible(&gspca_dev->queue_lock) != 0)
1859 /* check the next incoming buffer */
1860 i = gspca_dev->fr_o;
1861 i = gspca_dev->fr_queue[i];
1862 if (gspca_dev->frame[i].v4l2_buf.flags & V4L2_BUF_FLAG_DONE)
1863 ret = POLLIN | POLLRDNORM; /* something to read */
1866 mutex_unlock(&gspca_dev->queue_lock);
1867 if (!gspca_dev->present)
1872 static ssize_t dev_read(struct file *file, char __user *data,
1873 size_t count, loff_t *ppos)
1875 struct gspca_dev *gspca_dev = file->private_data;
1876 struct gspca_frame *frame;
1877 struct v4l2_buffer v4l2_buf;
1878 struct timeval timestamp;
1881 PDEBUG(D_FRAM, "read (%zd)", count);
1882 if (!gspca_dev->present)
1884 switch (gspca_dev->memory) {
1885 case GSPCA_MEMORY_NO: /* first time */
1886 ret = read_alloc(gspca_dev, file);
1890 case GSPCA_MEMORY_READ:
1891 if (gspca_dev->capt_file == file)
1899 jiffies_to_timeval(get_jiffies_64(), ×tamp);
1903 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1904 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1905 v4l2_buf.memory = GSPCA_MEMORY_READ;
1906 ret = vidioc_dqbuf(file, gspca_dev, &v4l2_buf);
1908 PDEBUG(D_STREAM, "read dqbuf err %d", ret);
1912 /* if the process slept for more than 1 second,
1913 * get a newer frame */
1914 frame = &gspca_dev->frame[v4l2_buf.index];
1916 break; /* avoid infinite loop */
1917 if (frame->v4l2_buf.timestamp.tv_sec >= timestamp.tv_sec)
1919 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1921 PDEBUG(D_STREAM, "read qbuf err %d", ret);
1926 /* copy the frame */
1927 if (count > frame->v4l2_buf.bytesused)
1928 count = frame->v4l2_buf.bytesused;
1929 ret = copy_to_user(data, frame->data, count);
1931 PDEBUG(D_ERR|D_STREAM,
1932 "read cp to user lack %d / %zd", ret, count);
1938 /* in each case, requeue the buffer */
1939 ret2 = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1945 static struct v4l2_file_operations dev_fops = {
1946 .owner = THIS_MODULE,
1948 .release = dev_close,
1951 .unlocked_ioctl = video_ioctl2,
1955 static const struct v4l2_ioctl_ops dev_ioctl_ops = {
1956 .vidioc_querycap = vidioc_querycap,
1957 .vidioc_dqbuf = vidioc_dqbuf,
1958 .vidioc_qbuf = vidioc_qbuf,
1959 .vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
1960 .vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
1961 .vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
1962 .vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
1963 .vidioc_streamon = vidioc_streamon,
1964 .vidioc_queryctrl = vidioc_queryctrl,
1965 .vidioc_g_ctrl = vidioc_g_ctrl,
1966 .vidioc_s_ctrl = vidioc_s_ctrl,
1967 .vidioc_g_audio = vidioc_g_audio,
1968 .vidioc_s_audio = vidioc_s_audio,
1969 .vidioc_enumaudio = vidioc_enumaudio,
1970 .vidioc_querymenu = vidioc_querymenu,
1971 .vidioc_enum_input = vidioc_enum_input,
1972 .vidioc_g_input = vidioc_g_input,
1973 .vidioc_s_input = vidioc_s_input,
1974 .vidioc_reqbufs = vidioc_reqbufs,
1975 .vidioc_querybuf = vidioc_querybuf,
1976 .vidioc_streamoff = vidioc_streamoff,
1977 .vidioc_g_jpegcomp = vidioc_g_jpegcomp,
1978 .vidioc_s_jpegcomp = vidioc_s_jpegcomp,
1979 .vidioc_g_parm = vidioc_g_parm,
1980 .vidioc_s_parm = vidioc_s_parm,
1981 .vidioc_enum_framesizes = vidioc_enum_framesizes,
1982 #ifdef CONFIG_VIDEO_ADV_DEBUG
1983 .vidioc_g_register = vidioc_g_register,
1984 .vidioc_s_register = vidioc_s_register,
1986 .vidioc_g_chip_ident = vidioc_g_chip_ident,
1987 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1988 .vidiocgmbuf = vidiocgmbuf,
1992 static struct video_device gspca_template = {
1993 .name = "gspca main driver",
1995 .ioctl_ops = &dev_ioctl_ops,
1996 .release = gspca_release,
2001 * probe and create a new gspca device
2003 * This function must be called by the sub-driver when it is
2004 * called for probing a new device.
2006 int gspca_dev_probe(struct usb_interface *intf,
2007 const struct usb_device_id *id,
2008 const struct sd_desc *sd_desc,
2010 struct module *module)
2012 struct usb_interface_descriptor *interface;
2013 struct gspca_dev *gspca_dev;
2014 struct usb_device *dev = interface_to_usbdev(intf);
2017 PDEBUG(D_PROBE, "probing %04x:%04x", id->idVendor, id->idProduct);
2019 /* we don't handle multi-config cameras */
2020 if (dev->descriptor.bNumConfigurations != 1) {
2021 PDEBUG(D_ERR, "Too many config");
2024 interface = &intf->cur_altsetting->desc;
2025 if (interface->bInterfaceNumber > 0) {
2026 PDEBUG(D_ERR, "intf != 0");
2030 /* create the device */
2031 if (dev_size < sizeof *gspca_dev)
2032 dev_size = sizeof *gspca_dev;
2033 gspca_dev = kzalloc(dev_size, GFP_KERNEL);
2035 err("couldn't kzalloc gspca struct");
2038 gspca_dev->usb_buf = kmalloc(USB_BUF_SZ, GFP_KERNEL);
2039 if (!gspca_dev->usb_buf) {
2040 err("out of memory");
2044 gspca_dev->dev = dev;
2045 gspca_dev->iface = interface->bInterfaceNumber;
2046 gspca_dev->nbalt = intf->num_altsetting;
2047 gspca_dev->sd_desc = sd_desc;
2048 gspca_dev->nbufread = 2;
2049 gspca_dev->empty_packet = -1; /* don't check the empty packets */
2051 /* configure the subdriver and initialize the USB device */
2052 ret = sd_desc->config(gspca_dev, id);
2055 ret = sd_desc->init(gspca_dev);
2058 ret = gspca_set_alt0(gspca_dev);
2061 gspca_set_default_mode(gspca_dev);
2063 mutex_init(&gspca_dev->usb_lock);
2064 mutex_init(&gspca_dev->read_lock);
2065 mutex_init(&gspca_dev->queue_lock);
2066 init_waitqueue_head(&gspca_dev->wq);
2068 /* init video stuff */
2069 memcpy(&gspca_dev->vdev, &gspca_template, sizeof gspca_template);
2070 gspca_dev->vdev.parent = &intf->dev;
2071 gspca_dev->module = module;
2072 gspca_dev->present = 1;
2073 ret = video_register_device(&gspca_dev->vdev,
2077 err("video_register_device err %d", ret);
2081 usb_set_intfdata(intf, gspca_dev);
2082 PDEBUG(D_PROBE, "/dev/video%d created", gspca_dev->vdev.num);
2085 kfree(gspca_dev->usb_buf);
2089 EXPORT_SYMBOL(gspca_dev_probe);
2094 * This function must be called by the sub-driver
2095 * when the device disconnects, after the specific resources are freed.
2097 void gspca_disconnect(struct usb_interface *intf)
2099 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2101 PDEBUG(D_PROBE, "/dev/video%d disconnect", gspca_dev->vdev.num);
2102 mutex_lock(&gspca_dev->usb_lock);
2103 gspca_dev->present = 0;
2105 if (gspca_dev->streaming) {
2106 destroy_urbs(gspca_dev);
2107 wake_up_interruptible(&gspca_dev->wq);
2110 /* the device is freed at exit of this function */
2111 gspca_dev->dev = NULL;
2112 mutex_unlock(&gspca_dev->usb_lock);
2114 usb_set_intfdata(intf, NULL);
2116 /* release the device */
2117 /* (this will call gspca_release() immediatly or on last close) */
2118 video_unregister_device(&gspca_dev->vdev);
2120 /* PDEBUG(D_PROBE, "disconnect complete"); */
2122 EXPORT_SYMBOL(gspca_disconnect);
2125 int gspca_suspend(struct usb_interface *intf, pm_message_t message)
2127 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2129 if (!gspca_dev->streaming)
2131 gspca_dev->frozen = 1; /* avoid urb error messages */
2132 if (gspca_dev->sd_desc->stopN)
2133 gspca_dev->sd_desc->stopN(gspca_dev);
2134 destroy_urbs(gspca_dev);
2135 gspca_set_alt0(gspca_dev);
2136 if (gspca_dev->sd_desc->stop0)
2137 gspca_dev->sd_desc->stop0(gspca_dev);
2140 EXPORT_SYMBOL(gspca_suspend);
2142 int gspca_resume(struct usb_interface *intf)
2144 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2146 gspca_dev->frozen = 0;
2147 gspca_dev->sd_desc->init(gspca_dev);
2148 if (gspca_dev->streaming)
2149 return gspca_init_transfer(gspca_dev);
2152 EXPORT_SYMBOL(gspca_resume);
2154 /* -- cam driver utility functions -- */
2156 /* auto gain and exposure algorithm based on the knee algorithm described here:
2157 http://ytse.tricolour.net/docs/LowLightOptimization.html
2159 Returns 0 if no changes were made, 1 if the gain and or exposure settings
2161 int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
2162 int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee)
2164 int i, steps, gain, orig_gain, exposure, orig_exposure, autogain;
2165 const struct ctrl *gain_ctrl = NULL;
2166 const struct ctrl *exposure_ctrl = NULL;
2167 const struct ctrl *autogain_ctrl = NULL;
2170 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
2171 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_GAIN)
2172 gain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2173 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_EXPOSURE)
2174 exposure_ctrl = &gspca_dev->sd_desc->ctrls[i];
2175 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_AUTOGAIN)
2176 autogain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2178 if (!gain_ctrl || !exposure_ctrl || !autogain_ctrl) {
2179 PDEBUG(D_ERR, "Error: gspca_auto_gain_n_exposure called "
2180 "on cam without (auto)gain/exposure");
2184 if (gain_ctrl->get(gspca_dev, &gain) ||
2185 exposure_ctrl->get(gspca_dev, &exposure) ||
2186 autogain_ctrl->get(gspca_dev, &autogain) || !autogain)
2190 orig_exposure = exposure;
2192 /* If we are of a multiple of deadzone, do multiple steps to reach the
2193 desired lumination fast (with the risc of a slight overshoot) */
2194 steps = abs(desired_avg_lum - avg_lum) / deadzone;
2196 PDEBUG(D_FRAM, "autogain: lum: %d, desired: %d, steps: %d",
2197 avg_lum, desired_avg_lum, steps);
2199 for (i = 0; i < steps; i++) {
2200 if (avg_lum > desired_avg_lum) {
2201 if (gain > gain_knee)
2203 else if (exposure > exposure_knee)
2205 else if (gain > gain_ctrl->qctrl.default_value)
2207 else if (exposure > exposure_ctrl->qctrl.minimum)
2209 else if (gain > gain_ctrl->qctrl.minimum)
2214 if (gain < gain_ctrl->qctrl.default_value)
2216 else if (exposure < exposure_knee)
2218 else if (gain < gain_knee)
2220 else if (exposure < exposure_ctrl->qctrl.maximum)
2222 else if (gain < gain_ctrl->qctrl.maximum)
2229 if (gain != orig_gain) {
2230 gain_ctrl->set(gspca_dev, gain);
2233 if (exposure != orig_exposure) {
2234 exposure_ctrl->set(gspca_dev, exposure);
2240 EXPORT_SYMBOL(gspca_auto_gain_n_exposure);
2242 /* -- module insert / remove -- */
2243 static int __init gspca_init(void)
2245 info("main v%d.%d.%d registered",
2246 (DRIVER_VERSION_NUMBER >> 16) & 0xff,
2247 (DRIVER_VERSION_NUMBER >> 8) & 0xff,
2248 DRIVER_VERSION_NUMBER & 0xff);
2251 static void __exit gspca_exit(void)
2253 info("main deregistered");
2256 module_init(gspca_init);
2257 module_exit(gspca_exit);
2260 module_param_named(debug, gspca_debug, int, 0644);
2261 MODULE_PARM_DESC(debug,
2262 "Debug (bit) 0x01:error 0x02:probe 0x04:config"
2263 " 0x08:stream 0x10:frame 0x20:packet 0x40:USBin 0x80:USBout"