2 * Main USB camera driver
4 * V4L2 by Jean-Francois Moine <http://moinejf.free.fr>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #define MODULE_NAME "gspca"
23 #include <linux/init.h>
25 #include <linux/vmalloc.h>
26 #include <linux/sched.h>
27 #include <linux/slab.h>
29 #include <linux/string.h>
30 #include <linux/pagemap.h>
33 #include <linux/uaccess.h>
34 #include <linux/jiffies.h>
35 #include <media/v4l2-ioctl.h>
40 #define DEF_NURBS 2 /* default number of URBs */
42 MODULE_AUTHOR("Jean-Francois Moine <http://moinejf.free.fr>");
43 MODULE_DESCRIPTION("GSPCA USB Camera Driver");
44 MODULE_LICENSE("GPL");
46 #define DRIVER_VERSION_NUMBER KERNEL_VERSION(2, 2, 0)
48 static int video_nr = -1;
50 #ifdef CONFIG_VIDEO_ADV_DEBUG
51 int gspca_debug = D_ERR | D_PROBE;
52 EXPORT_SYMBOL(gspca_debug);
54 static void PDEBUG_MODE(char *txt, __u32 pixfmt, int w, int h)
56 if ((pixfmt >> 24) >= '0' && (pixfmt >> 24) <= 'z') {
57 PDEBUG(D_CONF|D_STREAM, "%s %c%c%c%c %dx%d",
61 (pixfmt >> 16) & 0xff,
65 PDEBUG(D_CONF|D_STREAM, "%s 0x%08x %dx%d",
72 #define PDEBUG_MODE(txt, pixfmt, w, h)
75 /* specific memory types - !! should different from V4L2_MEMORY_xxx */
76 #define GSPCA_MEMORY_NO 0 /* V4L2_MEMORY_xxx starts from 1 */
77 #define GSPCA_MEMORY_READ 7
79 #define BUF_ALL_FLAGS (V4L2_BUF_FLAG_QUEUED | V4L2_BUF_FLAG_DONE)
84 static void gspca_vm_open(struct vm_area_struct *vma)
86 struct gspca_frame *frame = vma->vm_private_data;
88 frame->vma_use_count++;
89 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_MAPPED;
92 static void gspca_vm_close(struct vm_area_struct *vma)
94 struct gspca_frame *frame = vma->vm_private_data;
96 if (--frame->vma_use_count <= 0)
97 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_MAPPED;
100 static struct vm_operations_struct gspca_vm_ops = {
101 .open = gspca_vm_open,
102 .close = gspca_vm_close,
106 * fill a video frame from an URB and resubmit
108 static void fill_frame(struct gspca_dev *gspca_dev,
111 struct gspca_frame *frame;
112 __u8 *data; /* address of data in the iso message */
116 if (urb->status != 0) {
117 PDEBUG(D_ERR|D_PACK, "urb status: %d", urb->status);
118 return; /* disconnection ? */
120 pkt_scan = gspca_dev->sd_desc->pkt_scan;
121 for (i = 0; i < urb->number_of_packets; i++) {
123 /* check the availability of the frame buffer */
125 j = gspca_dev->fr_queue[j];
126 frame = &gspca_dev->frame[j];
127 if ((frame->v4l2_buf.flags & BUF_ALL_FLAGS)
128 != V4L2_BUF_FLAG_QUEUED) {
129 gspca_dev->last_packet_type = DISCARD_PACKET;
133 /* check the packet status and length */
134 len = urb->iso_frame_desc[i].actual_length;
137 st = urb->iso_frame_desc[i].status;
140 "ISOC data error: [%d] len=%d, status=%d",
142 gspca_dev->last_packet_type = DISCARD_PACKET;
146 /* let the packet be analyzed by the subdriver */
147 PDEBUG(D_PACK, "packet [%d] o:%d l:%d",
148 i, urb->iso_frame_desc[i].offset, len);
149 data = (__u8 *) urb->transfer_buffer
150 + urb->iso_frame_desc[i].offset;
151 pkt_scan(gspca_dev, frame, data, len);
154 /* resubmit the URB */
156 st = usb_submit_urb(urb, GFP_ATOMIC);
158 PDEBUG(D_ERR|D_PACK, "usb_submit_urb() ret %d", st);
162 * ISOC message interrupt from the USB device
164 * Analyse each packet and call the subdriver for copy to the frame buffer.
166 static void isoc_irq(struct urb *urb
169 struct gspca_dev *gspca_dev = (struct gspca_dev *) urb->context;
171 PDEBUG(D_PACK, "isoc irq");
172 if (!gspca_dev->streaming)
174 fill_frame(gspca_dev, urb);
178 * add data to the current frame
180 * This function is called by the subdrivers at interrupt level.
182 * To build a frame, these ones must add
184 * - 0 or many INTER_PACKETs
186 * DISCARD_PACKET invalidates the whole frame.
187 * On LAST_PACKET, a new frame is returned.
189 struct gspca_frame *gspca_frame_add(struct gspca_dev *gspca_dev,
191 struct gspca_frame *frame,
197 PDEBUG(D_PACK, "add t:%d l:%d", packet_type, len);
199 /* when start of a new frame, if the current frame buffer
200 * is not queued, discard the whole frame */
201 if (packet_type == FIRST_PACKET) {
202 if ((frame->v4l2_buf.flags & BUF_ALL_FLAGS)
203 != V4L2_BUF_FLAG_QUEUED) {
204 gspca_dev->last_packet_type = DISCARD_PACKET;
207 frame->data_end = frame->data;
208 jiffies_to_timeval(get_jiffies_64(),
209 &frame->v4l2_buf.timestamp);
210 frame->v4l2_buf.sequence = ++gspca_dev->sequence;
211 } else if (gspca_dev->last_packet_type == DISCARD_PACKET) {
212 if (packet_type == LAST_PACKET)
213 gspca_dev->last_packet_type = packet_type;
217 /* append the packet to the frame buffer */
219 if (frame->data_end - frame->data + len
220 > frame->v4l2_buf.length) {
221 PDEBUG(D_ERR|D_PACK, "frame overflow %zd > %d",
222 frame->data_end - frame->data + len,
223 frame->v4l2_buf.length);
224 packet_type = DISCARD_PACKET;
226 memcpy(frame->data_end, data, len);
227 frame->data_end += len;
230 gspca_dev->last_packet_type = packet_type;
232 /* if last packet, wake the application and advance in the queue */
233 if (packet_type == LAST_PACKET) {
234 frame->v4l2_buf.bytesused = frame->data_end - frame->data;
235 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_QUEUED;
236 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_DONE;
237 atomic_inc(&gspca_dev->nevent);
238 wake_up_interruptible(&gspca_dev->wq); /* event = new frame */
239 i = (gspca_dev->fr_i + 1) % gspca_dev->nframes;
241 PDEBUG(D_FRAM, "frame complete len:%d q:%d i:%d o:%d",
242 frame->v4l2_buf.bytesused,
246 j = gspca_dev->fr_queue[i];
247 frame = &gspca_dev->frame[j];
251 EXPORT_SYMBOL(gspca_frame_add);
253 static int gspca_is_compressed(__u32 format)
256 case V4L2_PIX_FMT_MJPEG:
257 case V4L2_PIX_FMT_JPEG:
258 case V4L2_PIX_FMT_SPCA561:
259 case V4L2_PIX_FMT_PAC207:
265 static void *rvmalloc(unsigned long size)
270 /* size = PAGE_ALIGN(size); (already done) */
271 mem = vmalloc_32(size);
273 adr = (unsigned long) mem;
274 while ((long) size > 0) {
275 SetPageReserved(vmalloc_to_page((void *) adr));
283 static void rvfree(void *mem, long size)
287 adr = (unsigned long) mem;
289 ClearPageReserved(vmalloc_to_page((void *) adr));
296 static int frame_alloc(struct gspca_dev *gspca_dev,
299 struct gspca_frame *frame;
303 i = gspca_dev->curr_mode;
304 frsz = gspca_dev->cam.cam_mode[i].sizeimage;
305 PDEBUG(D_STREAM, "frame alloc frsz: %d", frsz);
306 frsz = PAGE_ALIGN(frsz);
307 gspca_dev->frsz = frsz;
308 if (count > GSPCA_MAX_FRAMES)
309 count = GSPCA_MAX_FRAMES;
310 gspca_dev->frbuf = rvmalloc(frsz * count);
311 if (!gspca_dev->frbuf) {
312 err("frame alloc failed");
315 gspca_dev->nframes = count;
316 for (i = 0; i < count; i++) {
317 frame = &gspca_dev->frame[i];
318 frame->v4l2_buf.index = i;
319 frame->v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
320 frame->v4l2_buf.flags = 0;
321 frame->v4l2_buf.field = V4L2_FIELD_NONE;
322 frame->v4l2_buf.length = frsz;
323 frame->v4l2_buf.memory = gspca_dev->memory;
324 frame->v4l2_buf.sequence = 0;
325 frame->data = frame->data_end =
326 gspca_dev->frbuf + i * frsz;
327 frame->v4l2_buf.m.offset = i * frsz;
329 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
330 gspca_dev->last_packet_type = DISCARD_PACKET;
331 gspca_dev->sequence = 0;
332 atomic_set(&gspca_dev->nevent, 0);
336 static void frame_free(struct gspca_dev *gspca_dev)
340 PDEBUG(D_STREAM, "frame free");
341 if (gspca_dev->frbuf != NULL) {
342 rvfree(gspca_dev->frbuf,
343 gspca_dev->nframes * gspca_dev->frsz);
344 gspca_dev->frbuf = NULL;
345 for (i = 0; i < gspca_dev->nframes; i++)
346 gspca_dev->frame[i].data = NULL;
348 gspca_dev->nframes = 0;
351 static void destroy_urbs(struct gspca_dev *gspca_dev)
356 PDEBUG(D_STREAM, "kill transfer");
357 for (i = 0; i < MAX_NURBS; ++i) {
358 urb = gspca_dev->urb[i];
362 gspca_dev->urb[i] = NULL;
364 if (urb->transfer_buffer != NULL)
365 usb_buffer_free(gspca_dev->dev,
366 urb->transfer_buffer_length,
367 urb->transfer_buffer,
374 * search an input isochronous endpoint in an alternate setting
376 static struct usb_host_endpoint *alt_isoc(struct usb_host_interface *alt,
379 struct usb_host_endpoint *ep;
382 epaddr |= USB_DIR_IN;
383 for (i = 0; i < alt->desc.bNumEndpoints; i++) {
384 ep = &alt->endpoint[i];
385 if (ep->desc.bEndpointAddress == epaddr) {
386 attr = ep->desc.bmAttributes
387 & USB_ENDPOINT_XFERTYPE_MASK;
388 if (attr == USB_ENDPOINT_XFER_ISOC)
397 * search an input isochronous endpoint
399 * The endpoint is defined by the subdriver.
400 * Use only the first isoc (some Zoran - 0x0572:0x0001 - have two such ep).
401 * This routine may be called many times when the bandwidth is too small
402 * (the bandwidth is checked on urb submit).
404 static struct usb_host_endpoint *get_isoc_ep(struct gspca_dev *gspca_dev)
406 struct usb_interface *intf;
407 struct usb_host_endpoint *ep;
410 intf = usb_ifnum_to_if(gspca_dev->dev, gspca_dev->iface);
412 i = gspca_dev->alt; /* previous alt setting */
413 while (--i > 0) { /* alt 0 is unusable */
414 ep = alt_isoc(&intf->altsetting[i], gspca_dev->cam.epaddr);
419 err("no ISOC endpoint found");
422 PDEBUG(D_STREAM, "use ISOC alt %d ep 0x%02x",
423 i, ep->desc.bEndpointAddress);
424 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, i);
426 err("set interface err %d", ret);
429 gspca_dev->alt = i; /* memorize the current alt setting */
434 * create the isochronous URBs
436 static int create_urbs(struct gspca_dev *gspca_dev,
437 struct usb_host_endpoint *ep)
440 int n, nurbs, i, psize, npkt, bsize;
442 /* calculate the packet size and the number of packets */
443 psize = le16_to_cpu(ep->desc.wMaxPacketSize);
445 /* See paragraph 5.9 / table 5-11 of the usb 2.0 spec. */
446 psize = (psize & 0x07ff) * (1 + ((psize >> 11) & 3));
447 npkt = ISO_MAX_SIZE / psize;
448 if (npkt > ISO_MAX_PKT)
450 bsize = psize * npkt;
452 "isoc %d pkts size %d (bsize:%d)", npkt, psize, bsize);
454 gspca_dev->nurbs = nurbs;
455 for (n = 0; n < nurbs; n++) {
456 urb = usb_alloc_urb(npkt, GFP_KERNEL);
458 err("usb_alloc_urb failed");
461 urb->transfer_buffer = usb_buffer_alloc(gspca_dev->dev,
466 if (urb->transfer_buffer == NULL) {
468 destroy_urbs(gspca_dev);
469 err("usb_buffer_urb failed");
472 gspca_dev->urb[n] = urb;
473 urb->dev = gspca_dev->dev;
474 urb->context = gspca_dev;
475 urb->pipe = usb_rcvisocpipe(gspca_dev->dev,
476 ep->desc.bEndpointAddress);
477 urb->transfer_flags = URB_ISO_ASAP
478 | URB_NO_TRANSFER_DMA_MAP;
479 urb->interval = ep->desc.bInterval;
480 urb->complete = isoc_irq;
481 urb->number_of_packets = npkt;
482 urb->transfer_buffer_length = bsize;
483 for (i = 0; i < npkt; i++) {
484 urb->iso_frame_desc[i].length = psize;
485 urb->iso_frame_desc[i].offset = psize * i;
492 * start the USB transfer
494 static int gspca_init_transfer(struct gspca_dev *gspca_dev)
496 struct usb_host_endpoint *ep;
499 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
502 /* set the higher alternate setting and
503 * loop until urb submit succeeds */
504 gspca_dev->alt = gspca_dev->nbalt;
506 PDEBUG(D_STREAM, "init transfer alt %d", gspca_dev->alt);
507 ep = get_isoc_ep(gspca_dev);
512 ret = create_urbs(gspca_dev, ep);
517 gspca_dev->sd_desc->start(gspca_dev);
518 gspca_dev->streaming = 1;
519 atomic_set(&gspca_dev->nevent, 0);
521 /* submit the URBs */
522 for (n = 0; n < gspca_dev->nurbs; n++) {
523 ret = usb_submit_urb(gspca_dev->urb[n], GFP_KERNEL);
525 PDEBUG(D_ERR|D_STREAM,
526 "usb_submit_urb [%d] err %d", n, ret);
527 gspca_dev->streaming = 0;
528 destroy_urbs(gspca_dev);
530 break; /* try the previous alt */
538 mutex_unlock(&gspca_dev->usb_lock);
542 static int gspca_set_alt0(struct gspca_dev *gspca_dev)
546 ret = usb_set_interface(gspca_dev->dev, gspca_dev->iface, 0);
548 PDEBUG(D_ERR|D_STREAM, "set interface 0 err %d", ret);
552 /* Note both the queue and the usb lock should be hold when calling this */
553 static void gspca_stream_off(struct gspca_dev *gspca_dev)
555 gspca_dev->streaming = 0;
556 atomic_set(&gspca_dev->nevent, 0);
557 if (gspca_dev->present) {
558 gspca_dev->sd_desc->stopN(gspca_dev);
559 destroy_urbs(gspca_dev);
560 gspca_set_alt0(gspca_dev);
561 gspca_dev->sd_desc->stop0(gspca_dev);
562 PDEBUG(D_STREAM, "stream off OK");
566 static void gspca_set_default_mode(struct gspca_dev *gspca_dev)
570 i = gspca_dev->cam.nmodes - 1; /* take the highest mode */
571 gspca_dev->curr_mode = i;
572 gspca_dev->width = gspca_dev->cam.cam_mode[i].width;
573 gspca_dev->height = gspca_dev->cam.cam_mode[i].height;
574 gspca_dev->pixfmt = gspca_dev->cam.cam_mode[i].pixelformat;
577 static int wxh_to_mode(struct gspca_dev *gspca_dev,
578 int width, int height)
582 for (i = gspca_dev->cam.nmodes; --i > 0; ) {
583 if (width >= gspca_dev->cam.cam_mode[i].width
584 && height >= gspca_dev->cam.cam_mode[i].height)
591 * search a mode with the right pixel format
593 static int gspca_get_mode(struct gspca_dev *gspca_dev,
599 modeU = modeD = mode;
600 while ((modeU < gspca_dev->cam.nmodes) || modeD >= 0) {
602 if (gspca_dev->cam.cam_mode[modeD].pixelformat
606 if (++modeU < gspca_dev->cam.nmodes) {
607 if (gspca_dev->cam.cam_mode[modeU].pixelformat
615 static int vidioc_enum_fmt_vid_cap(struct file *file, void *priv,
616 struct v4l2_fmtdesc *fmtdesc)
618 struct gspca_dev *gspca_dev = priv;
622 /* give an index to each format */
625 for (i = gspca_dev->cam.nmodes; --i >= 0; ) {
626 fmt_tb[index] = gspca_dev->cam.cam_mode[i].pixelformat;
629 if (fmt_tb[j] == fmt_tb[index])
634 if (fmtdesc->index == index)
635 break; /* new format */
637 if (index >= sizeof fmt_tb / sizeof fmt_tb[0])
642 return -EINVAL; /* no more format */
644 fmtdesc->pixelformat = fmt_tb[index];
645 if (gspca_is_compressed(fmt_tb[index]))
646 fmtdesc->flags = V4L2_FMT_FLAG_COMPRESSED;
647 fmtdesc->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
648 fmtdesc->description[0] = fmtdesc->pixelformat & 0xff;
649 fmtdesc->description[1] = (fmtdesc->pixelformat >> 8) & 0xff;
650 fmtdesc->description[2] = (fmtdesc->pixelformat >> 16) & 0xff;
651 fmtdesc->description[3] = fmtdesc->pixelformat >> 24;
652 fmtdesc->description[4] = '\0';
656 static int vidioc_g_fmt_vid_cap(struct file *file, void *priv,
657 struct v4l2_format *fmt)
659 struct gspca_dev *gspca_dev = priv;
662 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
664 mode = gspca_dev->curr_mode;
665 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
666 sizeof fmt->fmt.pix);
670 static int try_fmt_vid_cap(struct gspca_dev *gspca_dev,
671 struct v4l2_format *fmt)
673 int w, h, mode, mode2;
675 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
677 w = fmt->fmt.pix.width;
678 h = fmt->fmt.pix.height;
680 #ifdef CONFIG_VIDEO_ADV_DEBUG
681 if (gspca_debug & D_CONF)
682 PDEBUG_MODE("try fmt cap", fmt->fmt.pix.pixelformat, w, h);
684 /* search the closest mode for width and height */
685 mode = wxh_to_mode(gspca_dev, w, h);
687 /* OK if right palette */
688 if (gspca_dev->cam.cam_mode[mode].pixelformat
689 != fmt->fmt.pix.pixelformat) {
691 /* else, search the closest mode with the same pixel format */
692 mode2 = gspca_get_mode(gspca_dev, mode,
693 fmt->fmt.pix.pixelformat);
697 ; * no chance, return this mode */
699 memcpy(&fmt->fmt.pix, &gspca_dev->cam.cam_mode[mode],
700 sizeof fmt->fmt.pix);
701 return mode; /* used when s_fmt */
704 static int vidioc_try_fmt_vid_cap(struct file *file,
706 struct v4l2_format *fmt)
708 struct gspca_dev *gspca_dev = priv;
711 ret = try_fmt_vid_cap(gspca_dev, fmt);
717 static int vidioc_s_fmt_vid_cap(struct file *file, void *priv,
718 struct v4l2_format *fmt)
720 struct gspca_dev *gspca_dev = priv;
723 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
726 ret = try_fmt_vid_cap(gspca_dev, fmt);
730 if (gspca_dev->nframes != 0
731 && fmt->fmt.pix.sizeimage > gspca_dev->frsz) {
736 if (ret == gspca_dev->curr_mode) {
738 goto out; /* same mode */
741 if (gspca_dev->streaming) {
745 gspca_dev->width = fmt->fmt.pix.width;
746 gspca_dev->height = fmt->fmt.pix.height;
747 gspca_dev->pixfmt = fmt->fmt.pix.pixelformat;
748 gspca_dev->curr_mode = ret;
752 mutex_unlock(&gspca_dev->queue_lock);
756 static int dev_open(struct inode *inode, struct file *file)
758 struct gspca_dev *gspca_dev;
761 PDEBUG(D_STREAM, "%s open", current->comm);
762 gspca_dev = (struct gspca_dev *) video_devdata(file);
763 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
765 if (!gspca_dev->present) {
770 /* if not done yet, initialize the sensor */
771 if (gspca_dev->users == 0) {
772 if (mutex_lock_interruptible(&gspca_dev->usb_lock)) {
776 ret = gspca_dev->sd_desc->open(gspca_dev);
777 mutex_unlock(&gspca_dev->usb_lock);
779 PDEBUG(D_ERR|D_CONF, "init device failed %d", ret);
782 } else if (gspca_dev->users > 4) { /* (arbitrary value) */
787 file->private_data = gspca_dev;
788 #ifdef CONFIG_VIDEO_ADV_DEBUG
789 /* activate the v4l2 debug */
790 if (gspca_debug & D_V4L2)
791 gspca_dev->vdev.debug |= 3;
793 gspca_dev->vdev.debug &= ~3;
796 mutex_unlock(&gspca_dev->queue_lock);
798 PDEBUG(D_ERR|D_STREAM, "open failed err %d", ret);
800 PDEBUG(D_STREAM, "open done");
804 static int dev_close(struct inode *inode, struct file *file)
806 struct gspca_dev *gspca_dev = file->private_data;
808 PDEBUG(D_STREAM, "%s close", current->comm);
809 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
813 /* if the file did the capture, free the streaming resources */
814 if (gspca_dev->capt_file == file) {
815 mutex_lock(&gspca_dev->usb_lock);
816 if (gspca_dev->streaming)
817 gspca_stream_off(gspca_dev);
818 gspca_dev->sd_desc->close(gspca_dev);
819 mutex_unlock(&gspca_dev->usb_lock);
820 frame_free(gspca_dev);
821 gspca_dev->capt_file = NULL;
822 gspca_dev->memory = GSPCA_MEMORY_NO;
824 file->private_data = NULL;
825 mutex_unlock(&gspca_dev->queue_lock);
826 PDEBUG(D_STREAM, "close done");
830 static int vidioc_querycap(struct file *file, void *priv,
831 struct v4l2_capability *cap)
833 struct gspca_dev *gspca_dev = priv;
835 memset(cap, 0, sizeof *cap);
836 strncpy(cap->driver, gspca_dev->sd_desc->name, sizeof cap->driver);
837 strncpy(cap->card, gspca_dev->cam.dev_name, sizeof cap->card);
838 strncpy(cap->bus_info, gspca_dev->dev->bus->bus_name,
839 sizeof cap->bus_info);
840 cap->version = DRIVER_VERSION_NUMBER;
841 cap->capabilities = V4L2_CAP_VIDEO_CAPTURE
843 | V4L2_CAP_READWRITE;
847 /* the use of V4L2_CTRL_FLAG_NEXT_CTRL asks for the controls to be sorted */
848 static int vidioc_queryctrl(struct file *file, void *priv,
849 struct v4l2_queryctrl *q_ctrl)
851 struct gspca_dev *gspca_dev = priv;
856 if (id & V4L2_CTRL_FLAG_NEXT_CTRL) {
857 id &= V4L2_CTRL_ID_MASK;
859 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
860 if (id >= gspca_dev->sd_desc->ctrls[i].qctrl.id) {
862 &gspca_dev->sd_desc->ctrls[i].qctrl,
869 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
870 if (id == gspca_dev->sd_desc->ctrls[i].qctrl.id) {
872 &gspca_dev->sd_desc->ctrls[i].qctrl,
877 if (id >= V4L2_CID_BASE
878 && id <= V4L2_CID_LASTP1) {
879 q_ctrl->flags |= V4L2_CTRL_FLAG_DISABLED;
885 static int vidioc_s_ctrl(struct file *file, void *priv,
886 struct v4l2_control *ctrl)
888 struct gspca_dev *gspca_dev = priv;
889 const struct ctrl *ctrls;
892 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
893 i < gspca_dev->sd_desc->nctrls;
895 if (ctrl->id != ctrls->qctrl.id)
897 if (ctrl->value < ctrls->qctrl.minimum
898 && ctrl->value > ctrls->qctrl.maximum)
900 PDEBUG(D_CONF, "set ctrl [%08x] = %d", ctrl->id, ctrl->value);
901 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
903 ret = ctrls->set(gspca_dev, ctrl->value);
904 mutex_unlock(&gspca_dev->usb_lock);
910 static int vidioc_g_ctrl(struct file *file, void *priv,
911 struct v4l2_control *ctrl)
913 struct gspca_dev *gspca_dev = priv;
915 const struct ctrl *ctrls;
918 for (i = 0, ctrls = gspca_dev->sd_desc->ctrls;
919 i < gspca_dev->sd_desc->nctrls;
921 if (ctrl->id != ctrls->qctrl.id)
923 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
925 ret = ctrls->get(gspca_dev, &ctrl->value);
926 mutex_unlock(&gspca_dev->usb_lock);
932 static int vidioc_querymenu(struct file *file, void *priv,
933 struct v4l2_querymenu *qmenu)
935 struct gspca_dev *gspca_dev = priv;
937 if (!gspca_dev->sd_desc->querymenu)
939 return gspca_dev->sd_desc->querymenu(gspca_dev, qmenu);
942 static int vidioc_enum_input(struct file *file, void *priv,
943 struct v4l2_input *input)
945 struct gspca_dev *gspca_dev = priv;
947 if (input->index != 0)
949 memset(input, 0, sizeof *input);
950 input->type = V4L2_INPUT_TYPE_CAMERA;
951 strncpy(input->name, gspca_dev->sd_desc->name,
956 static int vidioc_g_input(struct file *file, void *priv, unsigned int *i)
962 static int vidioc_s_input(struct file *file, void *priv, unsigned int i)
969 static int vidioc_reqbufs(struct file *file, void *priv,
970 struct v4l2_requestbuffers *rb)
972 struct gspca_dev *gspca_dev = priv;
975 if (rb->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
977 switch (rb->memory) {
978 case GSPCA_MEMORY_READ: /* (internal call) */
979 case V4L2_MEMORY_MMAP:
980 case V4L2_MEMORY_USERPTR:
985 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
988 if (gspca_dev->memory != GSPCA_MEMORY_NO
989 && gspca_dev->memory != rb->memory) {
994 /* only one file may do the capture */
995 if (gspca_dev->capt_file != NULL
996 && gspca_dev->capt_file != file) {
1001 /* if allocated, the buffers must not be mapped */
1002 for (i = 0; i < gspca_dev->nframes; i++) {
1003 if (gspca_dev->frame[i].vma_use_count) {
1009 /* stop streaming */
1010 if (gspca_dev->streaming) {
1011 mutex_lock(&gspca_dev->usb_lock);
1012 gspca_stream_off(gspca_dev);
1013 mutex_unlock(&gspca_dev->usb_lock);
1016 /* free the previous allocated buffers, if any */
1017 if (gspca_dev->nframes != 0) {
1018 frame_free(gspca_dev);
1019 gspca_dev->capt_file = NULL;
1021 if (rb->count == 0) /* unrequest */
1023 gspca_dev->memory = rb->memory;
1024 ret = frame_alloc(gspca_dev, rb->count);
1026 rb->count = gspca_dev->nframes;
1027 gspca_dev->capt_file = file;
1030 mutex_unlock(&gspca_dev->queue_lock);
1031 PDEBUG(D_STREAM, "reqbufs st:%d c:%d", ret, rb->count);
1035 static int vidioc_querybuf(struct file *file, void *priv,
1036 struct v4l2_buffer *v4l2_buf)
1038 struct gspca_dev *gspca_dev = priv;
1039 struct gspca_frame *frame;
1041 if (v4l2_buf->type != V4L2_BUF_TYPE_VIDEO_CAPTURE
1042 || v4l2_buf->index < 0
1043 || v4l2_buf->index >= gspca_dev->nframes)
1046 frame = &gspca_dev->frame[v4l2_buf->index];
1047 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1051 static int vidioc_streamon(struct file *file, void *priv,
1052 enum v4l2_buf_type buf_type)
1054 struct gspca_dev *gspca_dev = priv;
1057 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1059 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1060 return -ERESTARTSYS;
1061 if (!gspca_dev->present) {
1065 if (gspca_dev->nframes == 0) {
1069 if (!gspca_dev->streaming) {
1070 ret = gspca_init_transfer(gspca_dev);
1074 #ifdef CONFIG_VIDEO_ADV_DEBUG
1075 if (gspca_debug & D_STREAM) {
1076 PDEBUG_MODE("stream on OK",
1084 mutex_unlock(&gspca_dev->queue_lock);
1088 static int vidioc_streamoff(struct file *file, void *priv,
1089 enum v4l2_buf_type buf_type)
1091 struct gspca_dev *gspca_dev = priv;
1094 if (buf_type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1096 if (!gspca_dev->streaming)
1098 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1099 return -ERESTARTSYS;
1101 /* stop streaming */
1102 if (mutex_lock_interruptible(&gspca_dev->usb_lock)) {
1106 gspca_stream_off(gspca_dev);
1107 mutex_unlock(&gspca_dev->usb_lock);
1109 /* empty the application queues */
1110 for (i = 0; i < gspca_dev->nframes; i++)
1111 gspca_dev->frame[i].v4l2_buf.flags &= ~BUF_ALL_FLAGS;
1112 gspca_dev->fr_i = gspca_dev->fr_o = gspca_dev->fr_q = 0;
1113 gspca_dev->last_packet_type = DISCARD_PACKET;
1114 gspca_dev->sequence = 0;
1115 atomic_set(&gspca_dev->nevent, 0);
1118 mutex_unlock(&gspca_dev->queue_lock);
1122 static int vidioc_g_jpegcomp(struct file *file, void *priv,
1123 struct v4l2_jpegcompression *jpegcomp)
1125 struct gspca_dev *gspca_dev = priv;
1128 if (!gspca_dev->sd_desc->get_jcomp)
1130 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1131 return -ERESTARTSYS;
1132 ret = gspca_dev->sd_desc->get_jcomp(gspca_dev, jpegcomp);
1133 mutex_unlock(&gspca_dev->usb_lock);
1137 static int vidioc_s_jpegcomp(struct file *file, void *priv,
1138 struct v4l2_jpegcompression *jpegcomp)
1140 struct gspca_dev *gspca_dev = priv;
1143 if (mutex_lock_interruptible(&gspca_dev->usb_lock))
1144 return -ERESTARTSYS;
1145 if (!gspca_dev->sd_desc->set_jcomp)
1147 ret = gspca_dev->sd_desc->set_jcomp(gspca_dev, jpegcomp);
1148 mutex_unlock(&gspca_dev->usb_lock);
1152 static int vidioc_g_parm(struct file *filp, void *priv,
1153 struct v4l2_streamparm *parm)
1155 struct gspca_dev *gspca_dev = priv;
1157 memset(parm, 0, sizeof *parm);
1158 parm->type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1159 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1163 static int vidioc_s_parm(struct file *filp, void *priv,
1164 struct v4l2_streamparm *parm)
1166 struct gspca_dev *gspca_dev = priv;
1169 n = parm->parm.capture.readbuffers;
1170 if (n == 0 || n > GSPCA_MAX_FRAMES)
1171 parm->parm.capture.readbuffers = gspca_dev->nbufread;
1173 gspca_dev->nbufread = n;
1177 static int vidioc_s_std(struct file *filp, void *priv,
1183 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1184 static int vidiocgmbuf(struct file *file, void *priv,
1185 struct video_mbuf *mbuf)
1187 struct gspca_dev *gspca_dev = file->private_data;
1190 PDEBUG(D_STREAM, "cgmbuf");
1191 if (gspca_dev->nframes == 0) {
1195 struct v4l2_format fmt;
1197 memset(&fmt, 0, sizeof fmt);
1198 fmt.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1199 i = gspca_dev->cam.nmodes - 1; /* highest mode */
1200 fmt.fmt.pix.width = gspca_dev->cam.cam_mode[i].width;
1201 fmt.fmt.pix.height = gspca_dev->cam.cam_mode[i].height;
1202 fmt.fmt.pix.pixelformat = V4L2_PIX_FMT_BGR24;
1203 ret = vidioc_s_fmt_vid_cap(file, priv, &fmt);
1208 struct v4l2_requestbuffers rb;
1210 memset(&rb, 0, sizeof rb);
1212 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1213 rb.memory = V4L2_MEMORY_MMAP;
1214 ret = vidioc_reqbufs(file, priv, &rb);
1219 mbuf->frames = gspca_dev->nframes;
1220 mbuf->size = gspca_dev->frsz * gspca_dev->nframes;
1221 for (i = 0; i < mbuf->frames; i++)
1222 mbuf->offsets[i] = gspca_dev->frame[i].v4l2_buf.m.offset;
1227 static int dev_mmap(struct file *file, struct vm_area_struct *vma)
1229 struct gspca_dev *gspca_dev = file->private_data;
1230 struct gspca_frame *frame;
1232 unsigned long addr, start, size;
1235 start = vma->vm_start;
1236 size = vma->vm_end - vma->vm_start;
1237 PDEBUG(D_STREAM, "mmap start:%08x size:%d", (int) start, (int) size);
1239 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1240 return -ERESTARTSYS;
1241 if (!gspca_dev->present) {
1245 if (gspca_dev->capt_file != file) {
1251 for (i = 0; i < gspca_dev->nframes; ++i) {
1252 if (gspca_dev->frame[i].v4l2_buf.memory != V4L2_MEMORY_MMAP) {
1253 PDEBUG(D_STREAM, "mmap bad memory type");
1256 if ((gspca_dev->frame[i].v4l2_buf.m.offset >> PAGE_SHIFT)
1258 frame = &gspca_dev->frame[i];
1262 if (frame == NULL) {
1263 PDEBUG(D_STREAM, "mmap no frame buffer found");
1267 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1268 /* v4l1 maps all the buffers */
1270 || size != frame->v4l2_buf.length * gspca_dev->nframes)
1272 if (size != frame->v4l2_buf.length) {
1273 PDEBUG(D_STREAM, "mmap bad size");
1279 * - VM_IO marks the area as being a mmaped region for I/O to a
1280 * device. It also prevents the region from being core dumped.
1282 vma->vm_flags |= VM_IO;
1284 addr = (unsigned long) frame->data;
1286 page = vmalloc_to_page((void *) addr);
1287 ret = vm_insert_page(vma, start, page);
1295 vma->vm_ops = &gspca_vm_ops;
1296 vma->vm_private_data = frame;
1300 mutex_unlock(&gspca_dev->queue_lock);
1305 * wait for a video frame
1307 * If a frame is ready, its index is returned.
1309 static int frame_wait(struct gspca_dev *gspca_dev,
1312 struct gspca_frame *frame;
1315 /* check if a frame is ready */
1316 i = gspca_dev->fr_o;
1317 j = gspca_dev->fr_queue[i];
1318 frame = &gspca_dev->frame[j];
1319 if (frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE) {
1320 atomic_dec(&gspca_dev->nevent);
1323 if (nonblock_ing) /* no frame yet */
1326 /* wait till a frame is ready */
1328 ret = wait_event_interruptible_timeout(gspca_dev->wq,
1329 atomic_read(&gspca_dev->nevent) > 0,
1330 msecs_to_jiffies(3000));
1333 return ret; /* interrupt */
1334 return -EIO; /* timeout */
1336 atomic_dec(&gspca_dev->nevent);
1337 if (!gspca_dev->streaming || !gspca_dev->present)
1339 i = gspca_dev->fr_o;
1340 j = gspca_dev->fr_queue[i];
1341 frame = &gspca_dev->frame[j];
1342 if (frame->v4l2_buf.flags & V4L2_BUF_FLAG_DONE)
1346 gspca_dev->fr_o = (i + 1) % gspca_dev->nframes;
1347 PDEBUG(D_FRAM, "frame wait q:%d i:%d o:%d",
1352 if (gspca_dev->sd_desc->dq_callback) {
1353 mutex_lock(&gspca_dev->usb_lock);
1354 gspca_dev->sd_desc->dq_callback(gspca_dev);
1355 mutex_unlock(&gspca_dev->usb_lock);
1361 * dequeue a video buffer
1363 * If nonblock_ing is false, block until a buffer is available.
1365 static int vidioc_dqbuf(struct file *file, void *priv,
1366 struct v4l2_buffer *v4l2_buf)
1368 struct gspca_dev *gspca_dev = priv;
1369 struct gspca_frame *frame;
1372 PDEBUG(D_FRAM, "dqbuf");
1373 if (v4l2_buf->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1375 if (v4l2_buf->memory != gspca_dev->memory)
1378 /* if not streaming, be sure the application will not loop forever */
1379 if (!(file->f_flags & O_NONBLOCK)
1380 && !gspca_dev->streaming && gspca_dev->users == 1)
1383 /* only the capturing file may dequeue */
1384 if (gspca_dev->capt_file != file)
1387 /* only one dequeue / read at a time */
1388 if (mutex_lock_interruptible(&gspca_dev->read_lock))
1389 return -ERESTARTSYS;
1391 ret = frame_wait(gspca_dev, file->f_flags & O_NONBLOCK);
1394 i = ret; /* frame index */
1395 frame = &gspca_dev->frame[i];
1396 if (gspca_dev->memory == V4L2_MEMORY_USERPTR) {
1397 if (copy_to_user((__u8 *) frame->v4l2_buf.m.userptr,
1399 frame->v4l2_buf.bytesused)) {
1400 PDEBUG(D_ERR|D_STREAM,
1401 "dqbuf cp to user failed");
1406 frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_DONE;
1407 memcpy(v4l2_buf, &frame->v4l2_buf, sizeof *v4l2_buf);
1408 PDEBUG(D_FRAM, "dqbuf %d", i);
1411 mutex_unlock(&gspca_dev->read_lock);
1416 * queue a video buffer
1418 * Attempting to queue a buffer that has already been
1419 * queued will return -EINVAL.
1421 static int vidioc_qbuf(struct file *file, void *priv,
1422 struct v4l2_buffer *v4l2_buf)
1424 struct gspca_dev *gspca_dev = priv;
1425 struct gspca_frame *frame;
1428 PDEBUG(D_FRAM, "qbuf %d", v4l2_buf->index);
1429 if (v4l2_buf->type != V4L2_BUF_TYPE_VIDEO_CAPTURE)
1432 if (mutex_lock_interruptible(&gspca_dev->queue_lock))
1433 return -ERESTARTSYS;
1435 index = v4l2_buf->index;
1436 if ((unsigned) index >= gspca_dev->nframes) {
1438 "qbuf idx %d >= %d", index, gspca_dev->nframes);
1442 if (v4l2_buf->memory != gspca_dev->memory) {
1443 PDEBUG(D_FRAM, "qbuf bad memory type");
1448 frame = &gspca_dev->frame[index];
1449 if (frame->v4l2_buf.flags & BUF_ALL_FLAGS) {
1450 PDEBUG(D_FRAM, "qbuf bad state");
1455 frame->v4l2_buf.flags |= V4L2_BUF_FLAG_QUEUED;
1456 /* frame->v4l2_buf.flags &= ~V4L2_BUF_FLAG_DONE; */
1458 if (frame->v4l2_buf.memory == V4L2_MEMORY_USERPTR) {
1459 frame->v4l2_buf.m.userptr = v4l2_buf->m.userptr;
1460 frame->v4l2_buf.length = v4l2_buf->length;
1463 /* put the buffer in the 'queued' queue */
1464 i = gspca_dev->fr_q;
1465 gspca_dev->fr_queue[i] = index;
1466 gspca_dev->fr_q = (i + 1) % gspca_dev->nframes;
1467 PDEBUG(D_FRAM, "qbuf q:%d i:%d o:%d",
1472 v4l2_buf->flags |= V4L2_BUF_FLAG_QUEUED;
1473 v4l2_buf->flags &= ~V4L2_BUF_FLAG_DONE;
1476 mutex_unlock(&gspca_dev->queue_lock);
1481 * allocate the resources for read()
1483 static int read_alloc(struct gspca_dev *gspca_dev,
1486 struct v4l2_buffer v4l2_buf;
1489 PDEBUG(D_STREAM, "read alloc");
1490 if (gspca_dev->nframes == 0) {
1491 struct v4l2_requestbuffers rb;
1493 memset(&rb, 0, sizeof rb);
1494 rb.count = gspca_dev->nbufread;
1495 rb.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1496 rb.memory = GSPCA_MEMORY_READ;
1497 ret = vidioc_reqbufs(file, gspca_dev, &rb);
1499 PDEBUG(D_STREAM, "read reqbuf err %d", ret);
1502 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1503 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1504 v4l2_buf.memory = GSPCA_MEMORY_READ;
1505 for (i = 0; i < gspca_dev->nbufread; i++) {
1507 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1509 PDEBUG(D_STREAM, "read qbuf err: %d", ret);
1513 gspca_dev->memory = GSPCA_MEMORY_READ;
1516 /* start streaming */
1517 ret = vidioc_streamon(file, gspca_dev, V4L2_BUF_TYPE_VIDEO_CAPTURE);
1519 PDEBUG(D_STREAM, "read streamon err %d", ret);
1523 static unsigned int dev_poll(struct file *file, poll_table *wait)
1525 struct gspca_dev *gspca_dev = file->private_data;
1528 PDEBUG(D_FRAM, "poll");
1530 poll_wait(file, &gspca_dev->wq, wait);
1531 if (!gspca_dev->present)
1534 /* if reqbufs is not done, the user would use read() */
1535 if (gspca_dev->nframes == 0) {
1536 if (gspca_dev->memory != GSPCA_MEMORY_NO)
1537 return POLLERR; /* not the 1st time */
1538 ret = read_alloc(gspca_dev, file);
1543 if (mutex_lock_interruptible(&gspca_dev->queue_lock) != 0)
1545 if (!gspca_dev->present) {
1550 /* check the next incoming buffer */
1551 i = gspca_dev->fr_o;
1552 i = gspca_dev->fr_queue[i];
1553 if (gspca_dev->frame[i].v4l2_buf.flags & V4L2_BUF_FLAG_DONE)
1554 ret = POLLIN | POLLRDNORM; /* something to read */
1558 mutex_unlock(&gspca_dev->queue_lock);
1562 static ssize_t dev_read(struct file *file, char __user *data,
1563 size_t count, loff_t *ppos)
1565 struct gspca_dev *gspca_dev = file->private_data;
1566 struct gspca_frame *frame;
1567 struct v4l2_buffer v4l2_buf;
1568 struct timeval timestamp;
1571 PDEBUG(D_FRAM, "read (%zd)", count);
1572 if (!gspca_dev->present)
1574 switch (gspca_dev->memory) {
1575 case GSPCA_MEMORY_NO: /* first time */
1576 ret = read_alloc(gspca_dev, file);
1580 case GSPCA_MEMORY_READ:
1581 if (gspca_dev->capt_file == file)
1589 jiffies_to_timeval(get_jiffies_64(), ×tamp);
1593 memset(&v4l2_buf, 0, sizeof v4l2_buf);
1594 v4l2_buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
1595 v4l2_buf.memory = GSPCA_MEMORY_READ;
1596 ret = vidioc_dqbuf(file, gspca_dev, &v4l2_buf);
1598 PDEBUG(D_STREAM, "read dqbuf err %d", ret);
1602 /* if the process slept for more than 1 second,
1603 * get anewer frame */
1604 frame = &gspca_dev->frame[v4l2_buf.index];
1606 break; /* avoid infinite loop */
1607 if (frame->v4l2_buf.timestamp.tv_sec >= timestamp.tv_sec)
1609 ret = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1611 PDEBUG(D_STREAM, "read qbuf err %d", ret);
1616 /* copy the frame */
1617 if (count > frame->v4l2_buf.bytesused)
1618 count = frame->v4l2_buf.bytesused;
1619 ret = copy_to_user(data, frame->data, count);
1621 PDEBUG(D_ERR|D_STREAM,
1622 "read cp to user lack %d / %zd", ret, count);
1628 /* in each case, requeue the buffer */
1629 ret2 = vidioc_qbuf(file, gspca_dev, &v4l2_buf);
1635 static void dev_release(struct video_device *vfd)
1640 static struct file_operations dev_fops = {
1641 .owner = THIS_MODULE,
1643 .release = dev_close,
1646 .ioctl = video_ioctl2,
1647 #ifdef CONFIG_COMPAT
1648 .compat_ioctl = v4l_compat_ioctl32,
1650 .llseek = no_llseek,
1654 static const struct v4l2_ioctl_ops dev_ioctl_ops = {
1655 .vidioc_querycap = vidioc_querycap,
1656 .vidioc_dqbuf = vidioc_dqbuf,
1657 .vidioc_qbuf = vidioc_qbuf,
1658 .vidioc_enum_fmt_vid_cap = vidioc_enum_fmt_vid_cap,
1659 .vidioc_try_fmt_vid_cap = vidioc_try_fmt_vid_cap,
1660 .vidioc_g_fmt_vid_cap = vidioc_g_fmt_vid_cap,
1661 .vidioc_s_fmt_vid_cap = vidioc_s_fmt_vid_cap,
1662 .vidioc_streamon = vidioc_streamon,
1663 .vidioc_queryctrl = vidioc_queryctrl,
1664 .vidioc_g_ctrl = vidioc_g_ctrl,
1665 .vidioc_s_ctrl = vidioc_s_ctrl,
1666 .vidioc_querymenu = vidioc_querymenu,
1667 .vidioc_enum_input = vidioc_enum_input,
1668 .vidioc_g_input = vidioc_g_input,
1669 .vidioc_s_input = vidioc_s_input,
1670 .vidioc_reqbufs = vidioc_reqbufs,
1671 .vidioc_querybuf = vidioc_querybuf,
1672 .vidioc_streamoff = vidioc_streamoff,
1673 .vidioc_g_jpegcomp = vidioc_g_jpegcomp,
1674 .vidioc_s_jpegcomp = vidioc_s_jpegcomp,
1675 .vidioc_g_parm = vidioc_g_parm,
1676 .vidioc_s_parm = vidioc_s_parm,
1677 .vidioc_s_std = vidioc_s_std,
1678 #ifdef CONFIG_VIDEO_V4L1_COMPAT
1679 .vidiocgmbuf = vidiocgmbuf,
1683 static struct video_device gspca_template = {
1684 .name = "gspca main driver",
1685 .type = VID_TYPE_CAPTURE,
1687 .ioctl_ops = &dev_ioctl_ops,
1688 .release = dev_release, /* mandatory */
1693 * probe and create a new gspca device
1695 * This function must be called by the sub-driver when it is
1696 * called for probing a new device.
1698 int gspca_dev_probe(struct usb_interface *intf,
1699 const struct usb_device_id *id,
1700 const struct sd_desc *sd_desc,
1702 struct module *module)
1704 struct usb_interface_descriptor *interface;
1705 struct gspca_dev *gspca_dev;
1706 struct usb_device *dev = interface_to_usbdev(intf);
1709 PDEBUG(D_PROBE, "probing %04x:%04x", id->idVendor, id->idProduct);
1711 /* we don't handle multi-config cameras */
1712 if (dev->descriptor.bNumConfigurations != 1)
1714 interface = &intf->cur_altsetting->desc;
1715 if (interface->bInterfaceNumber > 0)
1718 /* create the device */
1719 if (dev_size < sizeof *gspca_dev)
1720 dev_size = sizeof *gspca_dev;
1721 gspca_dev = kzalloc(dev_size, GFP_KERNEL);
1722 if (gspca_dev == NULL) {
1723 err("couldn't kzalloc gspca struct");
1726 gspca_dev->dev = dev;
1727 gspca_dev->iface = interface->bInterfaceNumber;
1728 gspca_dev->nbalt = intf->num_altsetting;
1729 gspca_dev->sd_desc = sd_desc;
1730 /* gspca_dev->users = 0; (done by kzalloc) */
1731 gspca_dev->nbufread = 2;
1733 /* configure the subdriver */
1734 ret = gspca_dev->sd_desc->config(gspca_dev, id);
1737 ret = gspca_set_alt0(gspca_dev);
1740 gspca_set_default_mode(gspca_dev);
1742 mutex_init(&gspca_dev->usb_lock);
1743 mutex_init(&gspca_dev->read_lock);
1744 mutex_init(&gspca_dev->queue_lock);
1745 init_waitqueue_head(&gspca_dev->wq);
1747 /* init video stuff */
1748 memcpy(&gspca_dev->vdev, &gspca_template, sizeof gspca_template);
1749 gspca_dev->vdev.parent = &dev->dev;
1750 memcpy(&gspca_dev->fops, &dev_fops, sizeof gspca_dev->fops);
1751 gspca_dev->vdev.fops = &gspca_dev->fops;
1752 gspca_dev->fops.owner = module; /* module protection */
1753 ret = video_register_device(&gspca_dev->vdev,
1757 err("video_register_device err %d", ret);
1761 gspca_dev->present = 1;
1762 usb_set_intfdata(intf, gspca_dev);
1763 PDEBUG(D_PROBE, "probe ok");
1769 EXPORT_SYMBOL(gspca_dev_probe);
1774 * This function must be called by the sub-driver
1775 * when the device disconnects, after the specific resources are freed.
1777 void gspca_disconnect(struct usb_interface *intf)
1779 struct gspca_dev *gspca_dev = usb_get_intfdata(intf);
1783 gspca_dev->present = 0;
1784 mutex_lock(&gspca_dev->queue_lock);
1785 mutex_lock(&gspca_dev->usb_lock);
1786 gspca_dev->streaming = 0;
1787 destroy_urbs(gspca_dev);
1788 mutex_unlock(&gspca_dev->usb_lock);
1789 mutex_unlock(&gspca_dev->queue_lock);
1790 while (gspca_dev->users != 0) { /* wait until fully closed */
1791 atomic_inc(&gspca_dev->nevent);
1792 wake_up_interruptible(&gspca_dev->wq); /* wake processes */
1795 /* We don't want people trying to open up the device */
1796 video_unregister_device(&gspca_dev->vdev);
1797 /* Free the memory */
1799 PDEBUG(D_PROBE, "disconnect complete");
1801 EXPORT_SYMBOL(gspca_disconnect);
1803 /* -- cam driver utility functions -- */
1805 /* auto gain and exposure algorithm based on the knee algorithm described here:
1806 http://ytse.tricolour.net/docs/LowLightOptimization.html
1808 Returns 0 if no changes were made, 1 if the gain and or exposure settings
1810 int gspca_auto_gain_n_exposure(struct gspca_dev *gspca_dev, int avg_lum,
1811 int desired_avg_lum, int deadzone, int gain_knee, int exposure_knee)
1813 int i, steps, gain, orig_gain, exposure, orig_exposure, autogain;
1814 const struct ctrl *gain_ctrl = NULL;
1815 const struct ctrl *exposure_ctrl = NULL;
1816 const struct ctrl *autogain_ctrl = NULL;
1819 for (i = 0; i < gspca_dev->sd_desc->nctrls; i++) {
1820 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_GAIN)
1821 gain_ctrl = &gspca_dev->sd_desc->ctrls[i];
1822 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_EXPOSURE)
1823 exposure_ctrl = &gspca_dev->sd_desc->ctrls[i];
1824 if (gspca_dev->sd_desc->ctrls[i].qctrl.id == V4L2_CID_AUTOGAIN)
1825 autogain_ctrl = &gspca_dev->sd_desc->ctrls[i];
1827 if (!gain_ctrl || !exposure_ctrl || !autogain_ctrl) {
1828 PDEBUG(D_ERR, "Error: gspca_auto_gain_n_exposure called "
1829 "on cam without (auto)gain/exposure");
1833 if (gain_ctrl->get(gspca_dev, &gain) ||
1834 exposure_ctrl->get(gspca_dev, &exposure) ||
1835 autogain_ctrl->get(gspca_dev, &autogain) || !autogain)
1839 orig_exposure = exposure;
1841 /* If we are of a multiple of deadzone, do multiple steps to reach the
1842 desired lumination fast (with the risc of a slight overshoot) */
1843 steps = abs(desired_avg_lum - avg_lum) / deadzone;
1845 PDEBUG(D_FRAM, "autogain: lum: %d, desired: %d, steps: %d\n",
1846 avg_lum, desired_avg_lum, steps);
1848 for (i = 0; i < steps; i++) {
1849 if (avg_lum > desired_avg_lum) {
1850 if (gain > gain_knee)
1852 else if (exposure > exposure_knee)
1854 else if (gain > gain_ctrl->qctrl.default_value)
1856 else if (exposure > exposure_ctrl->qctrl.minimum)
1858 else if (gain > gain_ctrl->qctrl.minimum)
1863 if (gain < gain_ctrl->qctrl.default_value)
1865 else if (exposure < exposure_knee)
1867 else if (gain < gain_knee)
1869 else if (exposure < exposure_ctrl->qctrl.maximum)
1871 else if (gain < gain_ctrl->qctrl.maximum)
1878 if (gain != orig_gain) {
1879 gain_ctrl->set(gspca_dev, gain);
1882 if (exposure != orig_exposure) {
1883 exposure_ctrl->set(gspca_dev, exposure);
1889 EXPORT_SYMBOL(gspca_auto_gain_n_exposure);
1891 /* -- module insert / remove -- */
1892 static int __init gspca_init(void)
1894 info("main v%d.%d.%d registered",
1895 (DRIVER_VERSION_NUMBER >> 16) & 0xff,
1896 (DRIVER_VERSION_NUMBER >> 8) & 0xff,
1897 DRIVER_VERSION_NUMBER & 0xff);
1900 static void __exit gspca_exit(void)
1902 info("main deregistered");
1905 module_init(gspca_init);
1906 module_exit(gspca_exit);
1908 #ifdef CONFIG_VIDEO_ADV_DEBUG
1909 module_param_named(debug, gspca_debug, int, 0644);
1910 MODULE_PARM_DESC(debug,
1911 "Debug (bit) 0x01:error 0x02:probe 0x04:config"
1912 " 0x08:stream 0x10:frame 0x20:packet 0x40:USBin 0x80:USBout"