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 if (gspca_dev->pkt_size == 0)
516 psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
518 psize = gspca_dev->pkt_size;
519 npkt = gspca_dev->cam.npkt;
521 npkt = 32; /* default value */
522 bsize = psize * npkt;
524 "isoc %d pkts size %d = bsize:%d",
529 bsize = gspca_dev->cam.bulk_size;
532 PDEBUG(D_STREAM, "bulk bsize:%d", bsize);
533 if (gspca_dev->cam.bulk_nurbs != 0)
534 nurbs = gspca_dev->cam.bulk_nurbs;
539 gspca_dev->nurbs = nurbs;
540 for (n = 0; n < nurbs; n++) {
541 urb = usb_alloc_urb(npkt, GFP_KERNEL);
543 err("usb_alloc_urb failed");
544 destroy_urbs(gspca_dev);
547 urb->transfer_buffer = usb_buffer_alloc(gspca_dev->dev,
552 if (urb->transfer_buffer == NULL) {
554 err("usb_buffer_urb failed");
555 destroy_urbs(gspca_dev);
558 gspca_dev->urb[n] = urb;
559 urb->dev = gspca_dev->dev;
560 urb->context = gspca_dev;
561 urb->transfer_buffer_length = bsize;
562 if (npkt != 0) { /* ISOC */
563 urb->pipe = usb_rcvisocpipe(gspca_dev->dev,
564 ep->desc.bEndpointAddress);
565 urb->transfer_flags = URB_ISO_ASAP
566 | URB_NO_TRANSFER_DMA_MAP;
567 urb->interval = ep->desc.bInterval;
568 urb->complete = isoc_irq;
569 urb->number_of_packets = npkt;
570 for (i = 0; i < npkt; i++) {
571 urb->iso_frame_desc[i].length = psize;
572 urb->iso_frame_desc[i].offset = psize * i;
575 urb->pipe = usb_rcvbulkpipe(gspca_dev->dev,
576 ep->desc.bEndpointAddress),
577 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
578 urb->complete = bulk_irq;
585 * start the USB transfer
587 static int gspca_init_transfer(struct gspca_dev *gspca_dev)
589 struct usb_host_endpoint *ep;
592 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
595 if (!gspca_dev->present) {
600 /* set the higher alternate setting and
601 * loop until urb submit succeeds */
602 gspca_dev->alt = gspca_dev->nbalt;
603 if (gspca_dev->sd_desc->isoc_init) {
604 ret = gspca_dev->sd_desc->isoc_init(gspca_dev);
608 ep = get_ep(gspca_dev);
614 PDEBUG(D_STREAM, "init transfer alt %d", gspca_dev->alt);
615 ret = create_urbs(gspca_dev, ep);
619 /* clear the bulk endpoint */
620 if (gspca_dev->cam.bulk)
621 usb_clear_halt(gspca_dev->dev,
622 gspca_dev->urb[0]->pipe);
625 ret = gspca_dev->sd_desc->start(gspca_dev);
627 destroy_urbs(gspca_dev);
630 gspca_dev->streaming = 1;
632 /* some bulk transfers are started by the subdriver */
633 if (gspca_dev->cam.bulk && gspca_dev->cam.bulk_nurbs == 0)
636 /* submit the URBs */
637 for (n = 0; n < gspca_dev->nurbs; n++) {
638 ret = usb_submit_urb(gspca_dev->urb[n], GFP_KERNEL);
644 PDEBUG(D_ERR|D_STREAM,
645 "usb_submit_urb alt %d err %d", gspca_dev->alt, ret);
646 gspca_dev->streaming = 0;
647 destroy_urbs(gspca_dev);
651 /* the bandwidth is not wide enough
652 * negociate or try a lower alternate setting */
653 msleep(20); /* wait for kill complete */
654 if (gspca_dev->sd_desc->isoc_nego) {
655 ret = gspca_dev->sd_desc->isoc_nego(gspca_dev);
659 ep = get_ep(gspca_dev);
667 mutex_unlock(&gspca_dev->usb_lock);
671 static int gspca_set_alt0(struct gspca_dev *gspca_dev)
675 if (gspca_dev->alt == 0)
677 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, 0);
679 PDEBUG(D_ERR|D_STREAM, "set alt 0 err %d", ret);
683 /* Note: both the queue and the usb locks should be held when calling this */
684 static void gspca_stream_off(struct gspca_dev *gspca_dev)
686 gspca_dev->streaming = 0;
687 if (gspca_dev->present) {
688 if (gspca_dev->sd_desc->stopN)
689 gspca_dev->sd_desc->stopN(gspca_dev);
690 destroy_urbs(gspca_dev);
691 gspca_set_alt0(gspca_dev);
694 /* always call stop0 to free the subdriver's resources */
695 if (gspca_dev->sd_desc->stop0)
696 gspca_dev->sd_desc->stop0(gspca_dev);
697 PDEBUG(D_STREAM, "stream off OK");
700 static void gspca_set_default_mode(struct gspca_dev *gspca_dev)
704 i = gspca_dev->cam.nmodes - 1; /* take the highest mode */
705 gspca_dev->curr_mode = i;
706 gspca_dev->width = gspca_dev->cam.cam_mode[i].width;
707 gspca_dev->height = gspca_dev->cam.cam_mode[i].height;
708 gspca_dev->pixfmt = gspca_dev->cam.cam_mode[i].pixelformat;
711 static int wxh_to_mode(struct gspca_dev *gspca_dev,
712 int width, int height)
716 for (i = gspca_dev->cam.nmodes; --i > 0; ) {
717 if (width >= gspca_dev->cam.cam_mode[i].width
718 && height >= gspca_dev->cam.cam_mode[i].height)
725 * search a mode with the right pixel format
727 static int gspca_get_mode(struct gspca_dev *gspca_dev,
733 modeU = modeD = mode;
734 while ((modeU < gspca_dev->cam.nmodes) || modeD >= 0) {
736 if (gspca_dev->cam.cam_mode[modeD].pixelformat
740 if (++modeU < gspca_dev->cam.nmodes) {
741 if (gspca_dev->cam.cam_mode[modeU].pixelformat
749 #ifdef CONFIG_VIDEO_ADV_DEBUG
750 static int vidioc_g_register(struct file *file, void *priv,
751 struct v4l2_dbg_register *reg)
754 struct gspca_dev *gspca_dev = priv;
756 if (!gspca_dev->sd_desc->get_chip_ident)
759 if (!gspca_dev->sd_desc->get_register)
762 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
764 if (gspca_dev->present)
765 ret = gspca_dev->sd_desc->get_register(gspca_dev, reg);
768 mutex_unlock(&gspca_dev->usb_lock);
773 static int vidioc_s_register(struct file *file, void *priv,
774 struct v4l2_dbg_register *reg)
777 struct gspca_dev *gspca_dev = priv;
779 if (!gspca_dev->sd_desc->get_chip_ident)
782 if (!gspca_dev->sd_desc->set_register)
785 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
787 if (gspca_dev->present)
788 ret = gspca_dev->sd_desc->set_register(gspca_dev, reg);
791 mutex_unlock(&gspca_dev->usb_lock);
797 static int vidioc_g_chip_ident(struct file *file, void *priv,
798 struct v4l2_dbg_chip_ident *chip)
801 struct gspca_dev *gspca_dev = priv;
803 if (!gspca_dev->sd_desc->get_chip_ident)
806 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
808 if (gspca_dev->present)
809 ret = gspca_dev->sd_desc->get_chip_ident(gspca_dev, chip);
812 mutex_unlock(&gspca_dev->usb_lock);
817 static int vidioc_enum_fmt_vid_cap(struct file *file, void *priv,
818 struct v4l2_fmtdesc *fmtdesc)
820 struct gspca_dev *gspca_dev = priv;
824 /* give an index to each format */
827 for (i = gspca_dev->cam.nmodes; --i >= 0; ) {
828 fmt_tb[index] = gspca_dev->cam.cam_mode[i].pixelformat;
831 if (fmt_tb[j] == fmt_tb[index])
836 if (fmtdesc->index == index)
837 break; /* new format */
839 if (index >= ARRAY_SIZE(fmt_tb))
844 return -EINVAL; /* no more format */
846 fmtdesc->pixelformat = fmt_tb[index];
847 if (gspca_is_compressed(fmt_tb[index]))
848 fmtdesc->flags = V4L2_FMT_FLAG_COMPRESSED;
849 fmtdesc->description[0] = fmtdesc->pixelformat & 0xff;
850 fmtdesc->description[1] = (fmtdesc->pixelformat >> 8) & 0xff;
851 fmtdesc->description[2] = (fmtdesc->pixelformat >> 16) & 0xff;
852 fmtdesc->description[3] = fmtdesc->pixelformat >> 24;
853 fmtdesc->description[4] = '\0';
857 static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
858 struct v4l2_format *fmt)
860 struct gspca_dev *gspca_dev = priv;
863 mode = gspca_dev->curr_mode;
864 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
865 sizeof fmt->fmt.pix);
869 static int try_fmt_vid_cap(struct gspca_dev *gspca_dev,
870 struct v4l2_format *fmt)
872 int w, h, mode, mode2;
874 w = fmt->fmt.pix.width;
875 h = fmt->fmt.pix.height;
878 if (gspca_debug & D_CONF)
879 PDEBUG_MODE("try fmt cap", fmt->fmt.pix.pixelformat, w, h);
881 /* search the closest mode for width and height */
882 mode = wxh_to_mode(gspca_dev, w, h);
884 /* OK if right palette */
885 if (gspca_dev->cam.cam_mode[mode].pixelformat
886 != fmt->fmt.pix.pixelformat) {
888 /* else, search the closest mode with the same pixel format */
889 mode2 = gspca_get_mode(gspca_dev, mode,
890 fmt->fmt.pix.pixelformat);
894 ; * no chance, return this mode */
896 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
897 sizeof fmt->fmt.pix);
898 return mode; /* used when s_fmt */
901 static int vidioc_try_fmt_vid_cap(struct file *file,
903 struct v4l2_format *fmt)
905 struct gspca_dev *gspca_dev = priv;
908 ret = try_fmt_vid_cap(gspca_dev, fmt);
914 static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
915 struct v4l2_format *fmt)
917 struct gspca_dev *gspca_dev = priv;
920 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
923 ret = try_fmt_vid_cap(gspca_dev, fmt);
927 if (gspca_dev->nframes != 0
928 && fmt->fmt.pix.sizeimage > gspca_dev->frsz) {
933 if (ret == gspca_dev->curr_mode) {
935 goto out; /* same mode */
938 if (gspca_dev->streaming) {
942 gspca_dev->width = fmt->fmt.pix.width;
943 gspca_dev->height = fmt->fmt.pix.height;
944 gspca_dev->pixfmt = fmt->fmt.pix.pixelformat;
945 gspca_dev->curr_mode = ret;
949 mutex_unlock(&gspca_dev->queue_lock);
953 static int vidioc_enum_framesizes(struct file *file, void *priv,
954 struct v4l2_frmsizeenum *fsize)
956 struct gspca_dev *gspca_dev = priv;
960 for (i = 0; i < gspca_dev->cam.nmodes; i++) {
961 if (fsize->pixel_format !=
962 gspca_dev->cam.cam_mode[i].pixelformat)
965 if (fsize->index == index) {
966 fsize->type = V4L2_FRMSIZE_TYPE_DISCRETE;
967 fsize->discrete.width =
968 gspca_dev->cam.cam_mode[i].width;
969 fsize->discrete.height =
970 gspca_dev->cam.cam_mode[i].height;
979 static void gspca_release(struct video_device *vfd)
981 struct gspca_dev *gspca_dev = container_of(vfd, struct gspca_dev, vdev);
983 PDEBUG(D_STREAM, "device released");
985 kfree(gspca_dev->usb_buf);
989 static int dev_open(struct file *file)
991 struct gspca_dev *gspca_dev;
994 PDEBUG(D_STREAM, "%s open", current->comm);
995 gspca_dev = (struct gspca_dev *) video_devdata(file);
996 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
998 if (!gspca_dev->present) {
1003 if (gspca_dev->users > 4) { /* (arbitrary value) */
1008 /* protect the subdriver against rmmod */
1009 if (!try_module_get(gspca_dev->module)) {
1016 file->private_data = gspca_dev;
1018 /* activate the v4l2 debug */
1019 if (gspca_debug & D_V4L2)
1020 gspca_dev->vdev.debug |= V4L2_DEBUG_IOCTL
1021 | V4L2_DEBUG_IOCTL_ARG;
1023 gspca_dev->vdev.debug &= ~(V4L2_DEBUG_IOCTL
1024 | V4L2_DEBUG_IOCTL_ARG);
1028 mutex_unlock(&gspca_dev->queue_lock);
1030 PDEBUG(D_ERR|D_STREAM, "open failed err %d", ret);
1032 PDEBUG(D_STREAM, "open done");
1036 static int dev_close(struct file *file)
1038 struct gspca_dev *gspca_dev = file->private_data;
1040 PDEBUG(D_STREAM, "%s close", current->comm);
1041 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1042 return -ERESTARTSYS;
1045 /* if the file did the capture, free the streaming resources */
1046 if (gspca_dev->capt_file == file) {
1047 if (gspca_dev->streaming) {
1048 mutex_lock(&gspca_dev->usb_lock);
1049 gspca_stream_off(gspca_dev);
1050 mutex_unlock(&gspca_dev->usb_lock);
1052 frame_free(gspca_dev);
1053 gspca_dev->capt_file = NULL;
1054 gspca_dev->memory = GSPCA_MEMORY_NO;
1056 file->private_data = NULL;
1057 module_put(gspca_dev->module);
1058 mutex_unlock(&gspca_dev->queue_lock);
1060 PDEBUG(D_STREAM, "close done");
1065 static int vidioc_querycap(struct file *file, void *priv,
1066 struct v4l2_capability *cap)
1068 struct gspca_dev *gspca_dev = priv;
1071 /* protect the access to the usb device */
1072 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1073 return -ERESTARTSYS;
1074 if (!gspca_dev->present) {
1078 strncpy(cap->driver, gspca_dev->sd_desc->name, sizeof cap->driver);
1079 if (gspca_dev->dev->product != NULL) {
1080 strncpy(cap->card, gspca_dev->dev->product,
1083 snprintf(cap->card, sizeof cap->card,
1084 "USB Camera (%04x:%04x)",
1085 le16_to_cpu(gspca_dev->dev->descriptor.idVendor),
1086 le16_to_cpu(gspca_dev->dev->descriptor.idProduct));
1088 usb_make_path(gspca_dev->dev, cap->bus_info, sizeof(cap->bus_info));
1089 cap->version = DRIVER_VERSION_NUMBER;
1090 cap->capabilities = V4L2_CAP_VIDEO_CAPTURE
1091 | V4L2_CAP_STREAMING
1092 | V4L2_CAP_READWRITE;
1095 mutex_unlock(&gspca_dev->usb_lock);
1099 static const struct ctrl *get_ctrl(struct gspca_dev *gspca_dev,
1102 const struct ctrl *ctrls;
1105 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
1106 i < gspca_dev->sd_desc->nctrls;
1108 if (gspca_dev->ctrl_dis & (1 << i))
1110 if (id == ctrls->qctrl.id)
1116 static int vidioc_queryctrl(struct file *file, void *priv,
1117 struct v4l2_queryctrl *q_ctrl)
1119 struct gspca_dev *gspca_dev = priv;
1120 const struct ctrl *ctrls;
1126 if (id & V4L2_CTRL_FLAG_NEXT_CTRL) {
1127 id &= V4L2_CTRL_ID_MASK;
1129 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
1130 if (gspca_dev->ctrl_dis & (1 << i))
1132 if (gspca_dev->sd_desc->ctrls[i].qctrl.id < id)
1134 if (ctrls && gspca_dev->sd_desc->ctrls[i].qctrl.id
1137 ctrls = &gspca_dev->sd_desc->ctrls[i];
1140 ctrls = get_ctrl(gspca_dev, id);
1144 memcpy(q_ctrl, ctrls, sizeof *q_ctrl);
1148 static int vidioc_s_ctrl(struct file *file, void *priv,
1149 struct v4l2_control *ctrl)
1151 struct gspca_dev *gspca_dev = priv;
1152 const struct ctrl *ctrls;
1155 ctrls = get_ctrl(gspca_dev, ctrl->id);
1159 if (ctrl->value < ctrls->qctrl.minimum
1160 || ctrl->value > ctrls->qctrl.maximum)
1162 PDEBUG(D_CONF, "set ctrl [%08x] = %d", ctrl->id, ctrl->value);
1163 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1164 return -ERESTARTSYS;
1165 if (gspca_dev->present)
1166 ret = ctrls->set(gspca_dev, ctrl->value);
1169 mutex_unlock(&gspca_dev->usb_lock);
1173 static int vidioc_g_ctrl(struct file *file, void *priv,
1174 struct v4l2_control *ctrl)
1176 struct gspca_dev *gspca_dev = priv;
1177 const struct ctrl *ctrls;
1180 ctrls = get_ctrl(gspca_dev, ctrl->id);
1184 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1185 return -ERESTARTSYS;
1186 if (gspca_dev->present)
1187 ret = ctrls->get(gspca_dev, &ctrl->value);
1190 mutex_unlock(&gspca_dev->usb_lock);
1194 /*fixme: have an audio flag in gspca_dev?*/
1195 static int vidioc_s_audio(struct file *file, void *priv,
1196 struct v4l2_audio *audio)
1198 if (audio->index != 0)
1203 static int vidioc_g_audio(struct file *file, void *priv,
1204 struct v4l2_audio *audio)
1206 strcpy(audio->name, "Microphone");
1210 static int vidioc_enumaudio(struct file *file, void *priv,
1211 struct v4l2_audio *audio)
1213 if (audio->index != 0)
1216 strcpy(audio->name, "Microphone");
1217 audio->capability = 0;
1222 static int vidioc_querymenu(struct file *file, void *priv,
1223 struct v4l2_querymenu *qmenu)
1225 struct gspca_dev *gspca_dev = priv;
1227 if (!gspca_dev->sd_desc->querymenu)
1229 return gspca_dev->sd_desc->querymenu(gspca_dev, qmenu);
1232 static int vidioc_enum_input(struct file *file, void *priv,
1233 struct v4l2_input *input)
1235 struct gspca_dev *gspca_dev = priv;
1237 if (input->index != 0)
1239 input->type = V4L2_INPUT_TYPE_CAMERA;
1240 input->status = gspca_dev->cam.input_flags;
1241 strncpy(input->name, gspca_dev->sd_desc->name,
1242 sizeof input->name);
1246 static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
1252 static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
1259 static int vidioc_reqbufs(struct file *file, void *priv,
1260 struct v4l2_requestbuffers *rb)
1262 struct gspca_dev *gspca_dev = priv;
1265 switch (rb->memory) {
1266 case GSPCA_MEMORY_READ: /* (internal call) */
1267 case V4L2_MEMORY_MMAP:
1268 case V4L2_MEMORY_USERPTR:
1273 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1274 return -ERESTARTSYS;
1276 if (gspca_dev->memory != GSPCA_MEMORY_NO
1277 && gspca_dev->memory != rb->memory) {
1282 /* only one file may do the capture */
1283 if (gspca_dev->capt_file != NULL
1284 && gspca_dev->capt_file != file) {
1289 /* if allocated, the buffers must not be mapped */
1290 for (i = 0; i < gspca_dev->nframes; i++) {
1291 if (gspca_dev->frame[i].vma_use_count) {
1297 /* stop streaming */
1298 if (gspca_dev->streaming) {
1299 mutex_lock(&gspca_dev->usb_lock);
1300 gspca_stream_off(gspca_dev);
1301 mutex_unlock(&gspca_dev->usb_lock);
1304 /* free the previous allocated buffers, if any */
1305 if (gspca_dev->nframes != 0) {
1306 frame_free(gspca_dev);
1307 gspca_dev->capt_file = NULL;
1309 if (rb->count == 0) /* unrequest */
1311 gspca_dev->memory = rb->memory;
1312 ret = frame_alloc(gspca_dev, rb->count);
1314 rb->count = gspca_dev->nframes;
1315 gspca_dev->capt_file = file;
1318 mutex_unlock(&gspca_dev->queue_lock);
1319 PDEBUG(D_STREAM, "reqbufs st:%d c:%d", ret, rb->count);
1323 static int vidioc_querybuf(struct file *file, void *priv,
1324 struct v4l2_buffer *v4l2_buf)
1326 struct gspca_dev *gspca_dev = priv;
1327 struct gspca_frame *frame;
1329 if (v4l2_buf->index < 0
1330 || v4l2_buf->index >= gspca_dev->nframes)
1333 frame = &gspca_dev->frame[v4l2_buf->index];
1334 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1338 static int vidioc_streamon(struct file *file, void *priv,
1339 enum v4l2_buf_type buf_type)
1341 struct gspca_dev *gspca_dev = priv;
1344 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1346 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1347 return -ERESTARTSYS;
1349 if (gspca_dev->nframes == 0
1350 || !(gspca_dev->frame[0].v4l2_buf.flags & V4L2_BUF_FLAG_QUEUED)) {
1354 if (!gspca_dev->streaming) {
1355 ret = gspca_init_transfer(gspca_dev);
1360 if (gspca_debug & D_STREAM) {
1361 PDEBUG_MODE("stream on OK",
1369 mutex_unlock(&gspca_dev->queue_lock);
1373 static int vidioc_streamoff(struct file *file, void *priv,
1374 enum v4l2_buf_type buf_type)
1376 struct gspca_dev *gspca_dev = priv;
1379 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1381 if (!gspca_dev->streaming)
1383 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1384 return -ERESTARTSYS;
1386 /* stop streaming */
1387 if (mutex_lock_interruptible(&gspca_dev->usb_lock)) {
1391 gspca_stream_off(gspca_dev);
1392 mutex_unlock(&gspca_dev->usb_lock);
1394 /* empty the application queues */
1395 for (i = 0; i < gspca_dev->nframes; i++)
1396 gspca_dev->frame[i].v4l2_buf.flags &= ~BUF_ALL_FLAGS;
1397 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
1398 gspca_dev->last_packet_type = DISCARD_PACKET;
1399 gspca_dev->sequence = 0;
1402 mutex_unlock(&gspca_dev->queue_lock);
1406 static int vidioc_g_jpegcomp(struct file *file, void *priv,
1407 struct v4l2_jpegcompression *jpegcomp)
1409 struct gspca_dev *gspca_dev = priv;
1412 if (!gspca_dev->sd_desc->get_jcomp)
1414 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1415 return -ERESTARTSYS;
1416 if (gspca_dev->present)
1417 ret = gspca_dev->sd_desc->get_jcomp(gspca_dev, jpegcomp);
1420 mutex_unlock(&gspca_dev->usb_lock);
1424 static int vidioc_s_jpegcomp(struct file *file, void *priv,
1425 struct v4l2_jpegcompression *jpegcomp)
1427 struct gspca_dev *gspca_dev = priv;
1430 if (!gspca_dev->sd_desc->set_jcomp)
1432 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1433 return -ERESTARTSYS;
1434 if (gspca_dev->present)
1435 ret = gspca_dev->sd_desc->set_jcomp(gspca_dev, jpegcomp);
1438 mutex_unlock(&gspca_dev->usb_lock);
1442 static int vidioc_g_parm(struct file *filp, void *priv,
1443 struct v4l2_streamparm *parm)
1445 struct gspca_dev *gspca_dev = priv;
1447 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1449 if (gspca_dev->sd_desc->get_streamparm) {
1452 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1453 return -ERESTARTSYS;
1454 if (gspca_dev->present)
1455 ret = gspca_dev->sd_desc->get_streamparm(gspca_dev,
1459 mutex_unlock(&gspca_dev->usb_lock);
1466 static int vidioc_s_parm(struct file *filp, void *priv,
1467 struct v4l2_streamparm *parm)
1469 struct gspca_dev *gspca_dev = priv;
1472 n = parm->parm.capture.readbuffers;
1473 if (n == 0 || n > GSPCA_MAX_FRAMES)
1474 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1476 gspca_dev->nbufread = n;
1478 if (gspca_dev->sd_desc->set_streamparm) {
1481 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1482 return -ERESTARTSYS;
1483 if (gspca_dev->present)
1484 ret = gspca_dev->sd_desc->set_streamparm(gspca_dev,
1488 mutex_unlock(&gspca_dev->usb_lock);
1495 static int vidioc_s_std(struct file *filp, void *priv,
1501 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1502 static int vidiocgmbuf(struct file *file, void *priv,
1503 struct video_mbuf *mbuf)
1505 struct gspca_dev *gspca_dev = file->private_data;
1508 PDEBUG(D_STREAM, "cgmbuf");
1509 if (gspca_dev->nframes == 0) {
1513 struct v4l2_format fmt;
1515 fmt.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1516 i = gspca_dev->cam.nmodes - 1; /* highest mode */
1517 fmt.fmt.pix.width = gspca_dev->cam.cam_mode[i].width;
1518 fmt.fmt.pix.height = gspca_dev->cam.cam_mode[i].height;
1519 fmt.fmt.pix.pixelformat = V4L2_PIX_FMT_BGR24;
1520 ret = vidioc_s_fmt_vid_cap(file, priv, &fmt);
1525 struct v4l2_requestbuffers rb;
1527 memset(&rb, 0, sizeof rb);
1529 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1530 rb.memory = V4L2_MEMORY_MMAP;
1531 ret = vidioc_reqbufs(file, priv, &rb);
1536 mbuf->frames = gspca_dev->nframes;
1537 mbuf->size = gspca_dev->frsz * gspca_dev->nframes;
1538 for (i = 0; i < mbuf->frames; i++)
1539 mbuf->offsets[i] = gspca_dev->frame[i].v4l2_buf.m.offset;
1544 static int dev_mmap(struct file *file, struct vm_area_struct *vma)
1546 struct gspca_dev *gspca_dev = file->private_data;
1547 struct gspca_frame *frame;
1549 unsigned long addr, start, size;
1552 start = vma->vm_start;
1553 size = vma->vm_end - vma->vm_start;
1554 PDEBUG(D_STREAM, "mmap start:%08x size:%d", (int) start, (int) size);
1556 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1557 return -ERESTARTSYS;
1558 if (!gspca_dev->present) {
1562 if (gspca_dev->capt_file != file) {
1568 for (i = 0; i < gspca_dev->nframes; ++i) {
1569 if (gspca_dev->frame[i].v4l2_buf.memory != V4L2_MEMORY_MMAP) {
1570 PDEBUG(D_STREAM, "mmap bad memory type");
1573 if ((gspca_dev->frame[i].v4l2_buf.m.offset >> PAGE_SHIFT)
1575 frame = &gspca_dev->frame[i];
1579 if (frame == NULL) {
1580 PDEBUG(D_STREAM, "mmap no frame buffer found");
1584 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1585 /* v4l1 maps all the buffers */
1587 || size != frame->v4l2_buf.length * gspca_dev->nframes)
1589 if (size != frame->v4l2_buf.length) {
1590 PDEBUG(D_STREAM, "mmap bad size");
1596 * - VM_IO marks the area as being a mmaped region for I/O to a
1597 * device. It also prevents the region from being core dumped.
1599 vma->vm_flags |= VM_IO;
1601 addr = (unsigned long) frame->data;
1603 page = vmalloc_to_page((void *) addr);
1604 ret = vm_insert_page(vma, start, page);
1612 vma->vm_ops = &gspca_vm_ops;
1613 vma->vm_private_data = frame;
1617 mutex_unlock(&gspca_dev->queue_lock);
1622 * wait for a video frame
1624 * If a frame is ready, its index is returned.
1626 static int frame_wait(struct gspca_dev *gspca_dev,
1629 struct gspca_frame *frame;
1632 /* check if a frame is ready */
1633 i = gspca_dev->fr_o;
1634 j = gspca_dev->fr_queue[i];
1635 frame = &gspca_dev->frame[j];
1637 if (!(frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE)) {
1641 /* wait till a frame is ready */
1642 ret = wait_event_interruptible_timeout(gspca_dev->wq,
1643 (frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE) ||
1644 !gspca_dev->streaming || !gspca_dev->present,
1645 msecs_to_jiffies(3000));
1648 if (ret == 0 || !gspca_dev->streaming || !gspca_dev->present)
1652 gspca_dev->fr_o = (i + 1) % gspca_dev->nframes;
1653 PDEBUG(D_FRAM, "frame wait q:%d i:%d o:%d",
1658 if (gspca_dev->sd_desc->dq_callback) {
1659 mutex_lock(&gspca_dev->usb_lock);
1660 if (gspca_dev->present)
1661 gspca_dev->sd_desc->dq_callback(gspca_dev);
1662 mutex_unlock(&gspca_dev->usb_lock);
1668 * dequeue a video buffer
1670 * If nonblock_ing is false, block until a buffer is available.
1672 static int vidioc_dqbuf(struct file *file, void *priv,
1673 struct v4l2_buffer *v4l2_buf)
1675 struct gspca_dev *gspca_dev = priv;
1676 struct gspca_frame *frame;
1679 PDEBUG(D_FRAM, "dqbuf");
1680 if (v4l2_buf->memory != gspca_dev->memory)
1683 if (!gspca_dev->present)
1686 /* if not streaming, be sure the application will not loop forever */
1687 if (!(file->f_flags & O_NONBLOCK)
1688 && !gspca_dev->streaming && gspca_dev->users == 1)
1691 /* only the capturing file may dequeue */
1692 if (gspca_dev->capt_file != file)
1695 /* only one dequeue / read at a time */
1696 if (mutex_lock_interruptible(&gspca_dev->read_lock))
1697 return -ERESTARTSYS;
1699 ret = frame_wait(gspca_dev, file->f_flags & O_NONBLOCK);
1702 i = ret; /* frame index */
1703 frame = &gspca_dev->frame[i];
1704 if (gspca_dev->memory == V4L2_MEMORY_USERPTR) {
1705 if (copy_to_user((__u8 __user *) frame->v4l2_buf.m.userptr,
1707 frame->v4l2_buf.bytesused)) {
1708 PDEBUG(D_ERR|D_STREAM,
1709 "dqbuf cp to user failed");
1714 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_DONE;
1715 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1716 PDEBUG(D_FRAM, "dqbuf %d", i);
1719 mutex_unlock(&gspca_dev->read_lock);
1724 * queue a video buffer
1726 * Attempting to queue a buffer that has already been
1727 * queued will return -EINVAL.
1729 static int vidioc_qbuf(struct file *file, void *priv,
1730 struct v4l2_buffer *v4l2_buf)
1732 struct gspca_dev *gspca_dev = priv;
1733 struct gspca_frame *frame;
1736 PDEBUG(D_FRAM, "qbuf %d", v4l2_buf->index);
1738 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1739 return -ERESTARTSYS;
1741 index = v4l2_buf->index;
1742 if ((unsigned) index >= gspca_dev->nframes) {
1744 "qbuf idx %d >= %d", index, gspca_dev->nframes);
1748 if (v4l2_buf->memory != gspca_dev->memory) {
1749 PDEBUG(D_FRAM, "qbuf bad memory type");
1754 frame = &gspca_dev->frame[index];
1755 if (frame->v4l2_buf.flags & BUF_ALL_FLAGS) {
1756 PDEBUG(D_FRAM, "qbuf bad state");
1761 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_QUEUED;
1763 if (frame->v4l2_buf.memory == V4L2_MEMORY_USERPTR) {
1764 frame->v4l2_buf.m.userptr = v4l2_buf->m.userptr;
1765 frame->v4l2_buf.length = v4l2_buf->length;
1768 /* put the buffer in the 'queued' queue */
1769 i = gspca_dev->fr_q;
1770 gspca_dev->fr_queue[i] = index;
1771 gspca_dev->fr_q = (i + 1) % gspca_dev->nframes;
1772 PDEBUG(D_FRAM, "qbuf q:%d i:%d o:%d",
1777 v4l2_buf->flags |= V4L2_BUF_FLAG_QUEUED;
1778 v4l2_buf->flags &= ~V4L2_BUF_FLAG_DONE;
1781 mutex_unlock(&gspca_dev->queue_lock);
1786 * allocate the resources for read()
1788 static int read_alloc(struct gspca_dev *gspca_dev,
1791 struct v4l2_buffer v4l2_buf;
1794 PDEBUG(D_STREAM, "read alloc");
1795 if (gspca_dev->nframes == 0) {
1796 struct v4l2_requestbuffers rb;
1798 memset(&rb, 0, sizeof rb);
1799 rb.count = gspca_dev->nbufread;
1800 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1801 rb.memory = GSPCA_MEMORY_READ;
1802 ret = vidioc_reqbufs(file, gspca_dev, &rb);
1804 PDEBUG(D_STREAM, "read reqbuf err %d", ret);
1807 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1808 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1809 v4l2_buf.memory = GSPCA_MEMORY_READ;
1810 for (i = 0; i < gspca_dev->nbufread; i++) {
1812 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1814 PDEBUG(D_STREAM, "read qbuf err: %d", ret);
1818 gspca_dev->memory = GSPCA_MEMORY_READ;
1821 /* start streaming */
1822 ret = vidioc_streamon(file, gspca_dev, V4L2_BUF_TYPE_VIDEO_CAPTURE);
1824 PDEBUG(D_STREAM, "read streamon err %d", ret);
1828 static unsigned int dev_poll(struct file *file, poll_table *wait)
1830 struct gspca_dev *gspca_dev = file->private_data;
1833 PDEBUG(D_FRAM, "poll");
1835 poll_wait(file, &gspca_dev->wq, wait);
1837 /* if reqbufs is not done, the user would use read() */
1838 if (gspca_dev->nframes == 0) {
1839 if (gspca_dev->memory != GSPCA_MEMORY_NO)
1840 return POLLERR; /* not the 1st time */
1841 ret = read_alloc(gspca_dev, file);
1846 if (mutex_lock_interruptible(&gspca_dev->queue_lock) != 0)
1849 /* check the next incoming buffer */
1850 i = gspca_dev->fr_o;
1851 i = gspca_dev->fr_queue[i];
1852 if (gspca_dev->frame[i].v4l2_buf.flags & V4L2_BUF_FLAG_DONE)
1853 ret = POLLIN | POLLRDNORM; /* something to read */
1856 mutex_unlock(&gspca_dev->queue_lock);
1857 if (!gspca_dev->present)
1862 static ssize_t dev_read(struct file *file, char __user *data,
1863 size_t count, loff_t *ppos)
1865 struct gspca_dev *gspca_dev = file->private_data;
1866 struct gspca_frame *frame;
1867 struct v4l2_buffer v4l2_buf;
1868 struct timeval timestamp;
1871 PDEBUG(D_FRAM, "read (%zd)", count);
1872 if (!gspca_dev->present)
1874 switch (gspca_dev->memory) {
1875 case GSPCA_MEMORY_NO: /* first time */
1876 ret = read_alloc(gspca_dev, file);
1880 case GSPCA_MEMORY_READ:
1881 if (gspca_dev->capt_file == file)
1889 jiffies_to_timeval(get_jiffies_64(), ×tamp);
1893 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1894 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1895 v4l2_buf.memory = GSPCA_MEMORY_READ;
1896 ret = vidioc_dqbuf(file, gspca_dev, &v4l2_buf);
1898 PDEBUG(D_STREAM, "read dqbuf err %d", ret);
1902 /* if the process slept for more than 1 second,
1903 * get a newer frame */
1904 frame = &gspca_dev->frame[v4l2_buf.index];
1906 break; /* avoid infinite loop */
1907 if (frame->v4l2_buf.timestamp.tv_sec >= timestamp.tv_sec)
1909 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1911 PDEBUG(D_STREAM, "read qbuf err %d", ret);
1916 /* copy the frame */
1917 if (count > frame->v4l2_buf.bytesused)
1918 count = frame->v4l2_buf.bytesused;
1919 ret = copy_to_user(data, frame->data, count);
1921 PDEBUG(D_ERR|D_STREAM,
1922 "read cp to user lack %d / %zd", ret, count);
1928 /* in each case, requeue the buffer */
1929 ret2 = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1935 static struct v4l2_file_operations dev_fops = {
1936 .owner = THIS_MODULE,
1938 .release = dev_close,
1941 .unlocked_ioctl = video_ioctl2,
1945 static const struct v4l2_ioctl_ops dev_ioctl_ops = {
1946 .vidioc_querycap = vidioc_querycap,
1947 .vidioc_dqbuf = vidioc_dqbuf,
1948 .vidioc_qbuf = vidioc_qbuf,
1949 .vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
1950 .vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
1951 .vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
1952 .vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
1953 .vidioc_streamon = vidioc_streamon,
1954 .vidioc_queryctrl = vidioc_queryctrl,
1955 .vidioc_g_ctrl = vidioc_g_ctrl,
1956 .vidioc_s_ctrl = vidioc_s_ctrl,
1957 .vidioc_g_audio = vidioc_g_audio,
1958 .vidioc_s_audio = vidioc_s_audio,
1959 .vidioc_enumaudio = vidioc_enumaudio,
1960 .vidioc_querymenu = vidioc_querymenu,
1961 .vidioc_enum_input = vidioc_enum_input,
1962 .vidioc_g_input = vidioc_g_input,
1963 .vidioc_s_input = vidioc_s_input,
1964 .vidioc_reqbufs = vidioc_reqbufs,
1965 .vidioc_querybuf = vidioc_querybuf,
1966 .vidioc_streamoff = vidioc_streamoff,
1967 .vidioc_g_jpegcomp = vidioc_g_jpegcomp,
1968 .vidioc_s_jpegcomp = vidioc_s_jpegcomp,
1969 .vidioc_g_parm = vidioc_g_parm,
1970 .vidioc_s_parm = vidioc_s_parm,
1971 .vidioc_s_std = vidioc_s_std,
1972 .vidioc_enum_framesizes = vidioc_enum_framesizes,
1973 #ifdef CONFIG_VIDEO_ADV_DEBUG
1974 .vidioc_g_register = vidioc_g_register,
1975 .vidioc_s_register = vidioc_s_register,
1977 .vidioc_g_chip_ident = vidioc_g_chip_ident,
1978 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1979 .vidiocgmbuf = vidiocgmbuf,
1983 static struct video_device gspca_template = {
1984 .name = "gspca main driver",
1986 .ioctl_ops = &dev_ioctl_ops,
1987 .release = gspca_release,
1992 * probe and create a new gspca device
1994 * This function must be called by the sub-driver when it is
1995 * called for probing a new device.
1997 int gspca_dev_probe(struct usb_interface *intf,
1998 const struct usb_device_id *id,
1999 const struct sd_desc *sd_desc,
2001 struct module *module)
2003 struct usb_interface_descriptor *interface;
2004 struct gspca_dev *gspca_dev;
2005 struct usb_device *dev = interface_to_usbdev(intf);
2008 PDEBUG(D_PROBE, "probing %04x:%04x", id->idVendor, id->idProduct);
2010 /* we don't handle multi-config cameras */
2011 if (dev->descriptor.bNumConfigurations != 1)
2013 interface = &intf->cur_altsetting->desc;
2014 if (interface->bInterfaceNumber > 0)
2017 /* create the device */
2018 if (dev_size < sizeof *gspca_dev)
2019 dev_size = sizeof *gspca_dev;
2020 gspca_dev = kzalloc(dev_size, GFP_KERNEL);
2022 err("couldn't kzalloc gspca struct");
2025 gspca_dev->usb_buf = kmalloc(USB_BUF_SZ, GFP_KERNEL);
2026 if (!gspca_dev->usb_buf) {
2027 err("out of memory");
2031 gspca_dev->dev = dev;
2032 gspca_dev->iface = interface->bInterfaceNumber;
2033 gspca_dev->nbalt = intf->num_altsetting;
2034 gspca_dev->sd_desc = sd_desc;
2035 gspca_dev->nbufread = 2;
2036 gspca_dev->empty_packet = -1; /* don't check the empty packets */
2038 /* configure the subdriver and initialize the USB device */
2039 ret = sd_desc->config(gspca_dev, id);
2042 ret = sd_desc->init(gspca_dev);
2045 ret = gspca_set_alt0(gspca_dev);
2048 gspca_set_default_mode(gspca_dev);
2050 mutex_init(&gspca_dev->usb_lock);
2051 mutex_init(&gspca_dev->read_lock);
2052 mutex_init(&gspca_dev->queue_lock);
2053 init_waitqueue_head(&gspca_dev->wq);
2055 /* init video stuff */
2056 memcpy(&gspca_dev->vdev, &gspca_template, sizeof gspca_template);
2057 gspca_dev->vdev.parent = &intf->dev;
2058 gspca_dev->module = module;
2059 gspca_dev->present = 1;
2060 ret = video_register_device(&gspca_dev->vdev,
2064 err("video_register_device err %d", ret);
2068 usb_set_intfdata(intf, gspca_dev);
2069 PDEBUG(D_PROBE, "probe ok");
2072 kfree(gspca_dev->usb_buf);
2076 EXPORT_SYMBOL(gspca_dev_probe);
2081 * This function must be called by the sub-driver
2082 * when the device disconnects, after the specific resources are freed.
2084 void gspca_disconnect(struct usb_interface *intf)
2086 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2088 mutex_lock(&gspca_dev->usb_lock);
2089 gspca_dev->present = 0;
2091 if (gspca_dev->streaming) {
2092 destroy_urbs(gspca_dev);
2093 wake_up_interruptible(&gspca_dev->wq);
2096 /* the device is freed at exit of this function */
2097 gspca_dev->dev = NULL;
2098 mutex_unlock(&gspca_dev->usb_lock);
2100 usb_set_intfdata(intf, NULL);
2102 /* release the device */
2103 /* (this will call gspca_release() immediatly or on last close) */
2104 video_unregister_device(&gspca_dev->vdev);
2106 PDEBUG(D_PROBE, "disconnect complete");
2108 EXPORT_SYMBOL(gspca_disconnect);
2111 int gspca_suspend(struct usb_interface *intf, pm_message_t message)
2113 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2115 if (!gspca_dev->streaming)
2117 gspca_dev->frozen = 1; /* avoid urb error messages */
2118 if (gspca_dev->sd_desc->stopN)
2119 gspca_dev->sd_desc->stopN(gspca_dev);
2120 destroy_urbs(gspca_dev);
2121 gspca_set_alt0(gspca_dev);
2122 if (gspca_dev->sd_desc->stop0)
2123 gspca_dev->sd_desc->stop0(gspca_dev);
2126 EXPORT_SYMBOL(gspca_suspend);
2128 int gspca_resume(struct usb_interface *intf)
2130 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
2132 gspca_dev->frozen = 0;
2133 gspca_dev->sd_desc->init(gspca_dev);
2134 if (gspca_dev->streaming)
2135 return gspca_init_transfer(gspca_dev);
2138 EXPORT_SYMBOL(gspca_resume);
2140 /* -- cam driver utility functions -- */
2142 /* auto gain and exposure algorithm based on the knee algorithm described here:
2143 http://ytse.tricolour.net/docs/LowLightOptimization.html
2145 Returns 0 if no changes were made, 1 if the gain and or exposure settings
2147 int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
2148 int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee)
2150 int i, steps, gain, orig_gain, exposure, orig_exposure, autogain;
2151 const struct ctrl *gain_ctrl = NULL;
2152 const struct ctrl *exposure_ctrl = NULL;
2153 const struct ctrl *autogain_ctrl = NULL;
2156 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
2157 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_GAIN)
2158 gain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2159 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_EXPOSURE)
2160 exposure_ctrl = &gspca_dev->sd_desc->ctrls[i];
2161 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_AUTOGAIN)
2162 autogain_ctrl = &gspca_dev->sd_desc->ctrls[i];
2164 if (!gain_ctrl || !exposure_ctrl || !autogain_ctrl) {
2165 PDEBUG(D_ERR, "Error: gspca_auto_gain_n_exposure called "
2166 "on cam without (auto)gain/exposure");
2170 if (gain_ctrl->get(gspca_dev, &gain) ||
2171 exposure_ctrl->get(gspca_dev, &exposure) ||
2172 autogain_ctrl->get(gspca_dev, &autogain) || !autogain)
2176 orig_exposure = exposure;
2178 /* If we are of a multiple of deadzone, do multiple steps to reach the
2179 desired lumination fast (with the risc of a slight overshoot) */
2180 steps = abs(desired_avg_lum - avg_lum) / deadzone;
2182 PDEBUG(D_FRAM, "autogain: lum: %d, desired: %d, steps: %d",
2183 avg_lum, desired_avg_lum, steps);
2185 for (i = 0; i < steps; i++) {
2186 if (avg_lum > desired_avg_lum) {
2187 if (gain > gain_knee)
2189 else if (exposure > exposure_knee)
2191 else if (gain > gain_ctrl->qctrl.default_value)
2193 else if (exposure > exposure_ctrl->qctrl.minimum)
2195 else if (gain > gain_ctrl->qctrl.minimum)
2200 if (gain < gain_ctrl->qctrl.default_value)
2202 else if (exposure < exposure_knee)
2204 else if (gain < gain_knee)
2206 else if (exposure < exposure_ctrl->qctrl.maximum)
2208 else if (gain < gain_ctrl->qctrl.maximum)
2215 if (gain != orig_gain) {
2216 gain_ctrl->set(gspca_dev, gain);
2219 if (exposure != orig_exposure) {
2220 exposure_ctrl->set(gspca_dev, exposure);
2226 EXPORT_SYMBOL(gspca_auto_gain_n_exposure);
2228 /* -- module insert / remove -- */
2229 static int __init gspca_init(void)
2231 info("main v%d.%d.%d registered",
2232 (DRIVER_VERSION_NUMBER >> 16) & 0xff,
2233 (DRIVER_VERSION_NUMBER >> 8) & 0xff,
2234 DRIVER_VERSION_NUMBER & 0xff);
2237 static void __exit gspca_exit(void)
2239 info("main deregistered");
2242 module_init(gspca_init);
2243 module_exit(gspca_exit);
2246 module_param_named(debug, gspca_debug, int, 0644);
2247 MODULE_PARM_DESC(debug,
2248 "Debug (bit) 0x01:error 0x02:probe 0x04:config"
2249 " 0x08:stream 0x10:frame 0x20:packet 0x40:USBin 0x80:USBout"