2 * stk-webcam.c : Driver for Syntek 1125 USB webcam controller
4 * Copyright (C) 2006 Nicolas VIVIEN
5 * Copyright 2007-2008 Jaime Velasco Juan <jsagarribay@gmail.com>
7 * Some parts are inspired from cafe_ccic.c
8 * Copyright 2006-2007 Jonathan Corbet
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include <linux/module.h>
26 #include <linux/init.h>
27 #include <linux/kernel.h>
28 #include <linux/errno.h>
29 #include <linux/slab.h>
31 #include <linux/dmi.h>
32 #include <linux/usb.h>
34 #include <linux/vmalloc.h>
35 #include <linux/videodev2.h>
36 #include <media/v4l2-common.h>
37 #include <media/v4l2-ioctl.h>
38 #include <media/v4l2-event.h>
40 #include "stk-webcam.h"
43 static int hflip = -1;
44 module_param(hflip, int, 0444);
45 MODULE_PARM_DESC(hflip, "Horizontal image flip (mirror). Defaults to 0");
47 static int vflip = -1;
48 module_param(vflip, int, 0444);
49 MODULE_PARM_DESC(vflip, "Vertical image flip. Defaults to 0");
52 module_param(debug, int, 0444);
53 MODULE_PARM_DESC(debug, "Debug v4l ioctls. Defaults to 0");
55 MODULE_LICENSE("GPL");
56 MODULE_AUTHOR("Jaime Velasco Juan <jsagarribay@gmail.com> and Nicolas VIVIEN");
57 MODULE_DESCRIPTION("Syntek DC1125 webcam driver");
59 /* Some cameras have audio interfaces, we aren't interested in those */
60 static struct usb_device_id stkwebcam_table[] = {
61 { USB_DEVICE_AND_INTERFACE_INFO(0x174f, 0xa311, 0xff, 0xff, 0xff) },
62 { USB_DEVICE_AND_INTERFACE_INFO(0x05e1, 0x0501, 0xff, 0xff, 0xff) },
65 MODULE_DEVICE_TABLE(usb, stkwebcam_table);
68 * The stk webcam laptop module is mounted upside down in some laptops :(
70 * Some background information (thanks to Hans de Goede for providing this):
72 * 1) Once upon a time the stkwebcam driver was written
74 * 2) The webcam in question was used mostly in Asus laptop models, including
75 * the laptop of the original author of the driver, and in these models, in
76 * typical Asus fashion (see the long long list for uvc cams inside v4l-utils),
77 * they mounted the webcam-module the wrong way up. So the hflip and vflip
78 * module options were given a default value of 1 (the correct value for
79 * upside down mounted models)
81 * 3) Years later I got a bug report from a user with a laptop with stkwebcam,
82 * where the module was actually mounted the right way up, and thus showed
83 * upside down under Linux. So now I was facing the choice of 2 options:
85 * a) Add a not-upside-down list to stkwebcam, which overrules the default.
87 * b) Do it like all the other drivers do, and make the default right for
88 * cams mounted the proper way and add an upside-down model list, with
89 * models where we need to flip-by-default.
91 * Despite knowing that going b) would cause a period of pain where we were
92 * building the table I opted to go for option b), since a) is just too ugly,
93 * and worse different from how every other driver does it leading to
94 * confusion in the long run. This change was made in kernel 3.6.
96 * So for any user report about upside-down images since kernel 3.6 ask them
97 * to provide the output of 'sudo dmidecode' so the laptop can be added in
100 static const struct dmi_system_id stk_upside_down_dmi_table[] = {
104 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
105 DMI_MATCH(DMI_PRODUCT_NAME, "G1")
108 .ident = "ASUS F3JC",
110 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
111 DMI_MATCH(DMI_PRODUCT_NAME, "F3JC")
117 DMI_MATCH(DMI_SYS_VENDOR, "HCL Infosystems Limited"),
118 DMI_MATCH(DMI_PRODUCT_NAME, "T12Rg-H")
128 int stk_camera_write_reg(struct stk_camera *dev, u16 index, u8 value)
130 struct usb_device *udev = dev->udev;
133 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
135 USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
147 int stk_camera_read_reg(struct stk_camera *dev, u16 index, int *value)
149 struct usb_device *udev = dev->udev;
153 buf = kmalloc(sizeof(u8), GFP_KERNEL);
157 ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
159 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
166 memcpy(value, buf, sizeof(u8));
172 static int stk_start_stream(struct stk_camera *dev)
176 int value_116, value_117;
178 if (!is_present(dev))
180 if (!is_memallocd(dev) || !is_initialised(dev)) {
181 STK_ERROR("FIXME: Buffers are not allocated\n");
184 ret = usb_set_interface(dev->udev, 0, 5);
187 STK_ERROR("usb_set_interface failed !\n");
188 if (stk_sensor_wakeup(dev))
189 STK_ERROR("error awaking the sensor\n");
191 stk_camera_read_reg(dev, 0x0116, &value_116);
192 stk_camera_read_reg(dev, 0x0117, &value_117);
194 stk_camera_write_reg(dev, 0x0116, 0x0000);
195 stk_camera_write_reg(dev, 0x0117, 0x0000);
197 stk_camera_read_reg(dev, 0x0100, &value);
198 stk_camera_write_reg(dev, 0x0100, value | 0x80);
200 stk_camera_write_reg(dev, 0x0116, value_116);
201 stk_camera_write_reg(dev, 0x0117, value_117);
202 for (i = 0; i < MAX_ISO_BUFS; i++) {
203 if (dev->isobufs[i].urb) {
204 ret = usb_submit_urb(dev->isobufs[i].urb, GFP_KERNEL);
205 atomic_inc(&dev->urbs_used);
214 static int stk_stop_stream(struct stk_camera *dev)
218 if (is_present(dev)) {
219 stk_camera_read_reg(dev, 0x0100, &value);
220 stk_camera_write_reg(dev, 0x0100, value & ~0x80);
221 if (dev->isobufs != NULL) {
222 for (i = 0; i < MAX_ISO_BUFS; i++) {
223 if (dev->isobufs[i].urb)
224 usb_kill_urb(dev->isobufs[i].urb);
227 unset_streaming(dev);
229 if (usb_set_interface(dev->udev, 0, 0))
230 STK_ERROR("usb_set_interface failed !\n");
231 if (stk_sensor_sleep(dev))
232 STK_ERROR("error suspending the sensor\n");
238 * This seems to be the shortest init sequence we
239 * must do in order to find the sensor
240 * Bit 5 of reg. 0x0000 here is important, when reset to 0 the sensor
241 * is also reset. Maybe powers down it?
242 * Rest of values don't make a difference
245 static struct regval stk1125_initvals[] = {
246 /*TODO: What means this sequence? */
275 static int stk_initialise(struct stk_camera *dev)
279 if (!is_present(dev))
281 if (is_initialised(dev))
283 rv = stk1125_initvals;
284 while (rv->reg != 0xffff) {
285 ret = stk_camera_write_reg(dev, rv->reg, rv->val);
290 if (stk_sensor_init(dev) == 0) {
291 set_initialised(dev);
297 /* *********************************************** */
299 * This function is called as an URB transfert is complete (Isochronous pipe).
300 * So, the traitement is done in interrupt time, so it has be fast, not crash,
301 * and not stall. Neat.
303 static void stk_isoc_handler(struct urb *urb)
310 unsigned char *fill = NULL;
311 unsigned char *iso_buf = NULL;
313 struct stk_camera *dev;
314 struct stk_sio_buffer *fb;
316 dev = (struct stk_camera *) urb->context;
319 STK_ERROR("isoc_handler called with NULL device !\n");
323 if (urb->status == -ENOENT || urb->status == -ECONNRESET
324 || urb->status == -ESHUTDOWN) {
325 atomic_dec(&dev->urbs_used);
329 spin_lock_irqsave(&dev->spinlock, flags);
331 if (urb->status != -EINPROGRESS && urb->status != 0) {
332 STK_ERROR("isoc_handler: urb->status == %d\n", urb->status);
336 if (list_empty(&dev->sio_avail)) {
337 /*FIXME Stop streaming after a while */
338 (void) (printk_ratelimit() &&
339 STK_ERROR("isoc_handler without available buffer!\n"));
342 fb = list_first_entry(&dev->sio_avail,
343 struct stk_sio_buffer, list);
344 fill = fb->buffer + fb->v4lbuf.bytesused;
346 for (i = 0; i < urb->number_of_packets; i++) {
347 if (urb->iso_frame_desc[i].status != 0) {
348 if (urb->iso_frame_desc[i].status != -EXDEV)
349 STK_ERROR("Frame %d has error %d\n", i,
350 urb->iso_frame_desc[i].status);
353 framelen = urb->iso_frame_desc[i].actual_length;
354 iso_buf = urb->transfer_buffer + urb->iso_frame_desc[i].offset;
357 continue; /* no data */
360 * we found something informational from there
361 * the isoc frames have to type of headers
362 * type1: 00 xx 00 00 or 20 xx 00 00
363 * type2: 80 xx 00 00 00 00 00 00 or a0 xx 00 00 00 00 00 00
364 * xx is a sequencer which has never been seen over 0x3f
365 * imho data written down looks like bayer, i see similarities
366 * after every 640 bytes
368 if (*iso_buf & 0x80) {
371 /* This marks a new frame */
372 if (fb->v4lbuf.bytesused != 0
373 && fb->v4lbuf.bytesused != dev->frame_size) {
374 (void) (printk_ratelimit() &&
375 STK_ERROR("frame %d, "
376 "bytesused=%d, skipping\n",
377 i, fb->v4lbuf.bytesused));
378 fb->v4lbuf.bytesused = 0;
380 } else if (fb->v4lbuf.bytesused == dev->frame_size) {
381 if (list_is_singular(&dev->sio_avail)) {
382 /* Always reuse the last buffer */
383 fb->v4lbuf.bytesused = 0;
386 list_move_tail(dev->sio_avail.next,
388 wake_up(&dev->wait_frame);
389 fb = list_first_entry(&dev->sio_avail,
390 struct stk_sio_buffer, list);
391 fb->v4lbuf.bytesused = 0;
400 /* Our buffer is full !!! */
401 if (framelen + fb->v4lbuf.bytesused > dev->frame_size) {
402 (void) (printk_ratelimit() &&
403 STK_ERROR("Frame buffer overflow, lost sync\n"));
404 /*FIXME Do something here? */
407 spin_unlock_irqrestore(&dev->spinlock, flags);
408 memcpy(fill, iso_buf, framelen);
409 spin_lock_irqsave(&dev->spinlock, flags);
412 /* New size of our buffer */
413 fb->v4lbuf.bytesused += framelen;
417 spin_unlock_irqrestore(&dev->spinlock, flags);
418 urb->dev = dev->udev;
419 ret = usb_submit_urb(urb, GFP_ATOMIC);
421 STK_ERROR("Error (%d) re-submitting urb in stk_isoc_handler.\n",
426 /* -------------------------------------------- */
428 static int stk_prepare_iso(struct stk_camera *dev)
433 struct usb_device *udev;
440 STK_ERROR("isobufs already allocated. Bad\n");
442 dev->isobufs = kcalloc(MAX_ISO_BUFS, sizeof(*dev->isobufs),
444 if (dev->isobufs == NULL) {
445 STK_ERROR("Unable to allocate iso buffers\n");
448 for (i = 0; i < MAX_ISO_BUFS; i++) {
449 if (dev->isobufs[i].data == NULL) {
450 kbuf = kzalloc(ISO_BUFFER_SIZE, GFP_KERNEL);
452 STK_ERROR("Failed to allocate iso buffer %d\n",
456 dev->isobufs[i].data = kbuf;
458 STK_ERROR("isobuf data already allocated\n");
459 if (dev->isobufs[i].urb == NULL) {
460 urb = usb_alloc_urb(ISO_FRAMES_PER_DESC, GFP_KERNEL);
463 dev->isobufs[i].urb = urb;
465 STK_ERROR("Killing URB\n");
466 usb_kill_urb(dev->isobufs[i].urb);
467 urb = dev->isobufs[i].urb;
471 urb->pipe = usb_rcvisocpipe(udev, dev->isoc_ep);
472 urb->transfer_flags = URB_ISO_ASAP;
473 urb->transfer_buffer = dev->isobufs[i].data;
474 urb->transfer_buffer_length = ISO_BUFFER_SIZE;
475 urb->complete = stk_isoc_handler;
477 urb->start_frame = 0;
478 urb->number_of_packets = ISO_FRAMES_PER_DESC;
480 for (j = 0; j < ISO_FRAMES_PER_DESC; j++) {
481 urb->iso_frame_desc[j].offset = j * ISO_MAX_FRAME_SIZE;
482 urb->iso_frame_desc[j].length = ISO_MAX_FRAME_SIZE;
489 for (i = 0; i < MAX_ISO_BUFS && dev->isobufs[i].data; i++)
490 kfree(dev->isobufs[i].data);
491 for (i = 0; i < MAX_ISO_BUFS && dev->isobufs[i].urb; i++)
492 usb_free_urb(dev->isobufs[i].urb);
498 static void stk_clean_iso(struct stk_camera *dev)
502 if (dev == NULL || dev->isobufs == NULL)
505 for (i = 0; i < MAX_ISO_BUFS; i++) {
508 urb = dev->isobufs[i].urb;
510 if (atomic_read(&dev->urbs_used) && is_present(dev))
514 kfree(dev->isobufs[i].data);
518 unset_memallocd(dev);
521 static int stk_setup_siobuf(struct stk_camera *dev, int index)
523 struct stk_sio_buffer *buf = dev->sio_bufs + index;
524 INIT_LIST_HEAD(&buf->list);
525 buf->v4lbuf.length = PAGE_ALIGN(dev->frame_size);
526 buf->buffer = vmalloc_user(buf->v4lbuf.length);
527 if (buf->buffer == NULL)
531 buf->v4lbuf.index = index;
532 buf->v4lbuf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
533 buf->v4lbuf.flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC;
534 buf->v4lbuf.field = V4L2_FIELD_NONE;
535 buf->v4lbuf.memory = V4L2_MEMORY_MMAP;
536 buf->v4lbuf.m.offset = 2*index*buf->v4lbuf.length;
540 static int stk_free_sio_buffers(struct stk_camera *dev)
545 if (dev->n_sbufs == 0 || dev->sio_bufs == NULL)
548 * If any buffers are mapped, we cannot free them at all.
550 for (i = 0; i < dev->n_sbufs; i++) {
551 if (dev->sio_bufs[i].mapcount > 0)
557 spin_lock_irqsave(&dev->spinlock, flags);
558 INIT_LIST_HEAD(&dev->sio_avail);
559 INIT_LIST_HEAD(&dev->sio_full);
560 nbufs = dev->n_sbufs;
562 spin_unlock_irqrestore(&dev->spinlock, flags);
563 for (i = 0; i < nbufs; i++)
564 vfree(dev->sio_bufs[i].buffer);
565 kfree(dev->sio_bufs);
566 dev->sio_bufs = NULL;
570 static int stk_prepare_sio_buffers(struct stk_camera *dev, unsigned n_sbufs)
573 if (dev->sio_bufs != NULL)
574 STK_ERROR("sio_bufs already allocated\n");
576 dev->sio_bufs = kzalloc(n_sbufs * sizeof(struct stk_sio_buffer),
578 if (dev->sio_bufs == NULL)
580 for (i = 0; i < n_sbufs; i++) {
581 if (stk_setup_siobuf(dev, i))
582 return (dev->n_sbufs > 1 ? 0 : -ENOMEM);
589 static int stk_allocate_buffers(struct stk_camera *dev, unsigned n_sbufs)
592 err = stk_prepare_iso(dev);
597 err = stk_prepare_sio_buffers(dev, n_sbufs);
599 stk_free_sio_buffers(dev);
605 static void stk_free_buffers(struct stk_camera *dev)
608 stk_free_sio_buffers(dev);
610 /* -------------------------------------------- */
612 /* v4l file operations */
614 static int v4l_stk_open(struct file *fp)
616 struct stk_camera *dev = video_drvdata(fp);
619 if (dev == NULL || !is_present(dev))
622 if (mutex_lock_interruptible(&dev->lock))
624 if (!dev->first_init)
625 stk_camera_write_reg(dev, 0x0, 0x24);
629 err = v4l2_fh_open(fp);
631 usb_autopm_get_interface(dev->interface);
632 mutex_unlock(&dev->lock);
636 static int v4l_stk_release(struct file *fp)
638 struct stk_camera *dev = video_drvdata(fp);
640 mutex_lock(&dev->lock);
641 if (dev->owner == fp) {
642 stk_stop_stream(dev);
643 stk_free_buffers(dev);
644 stk_camera_write_reg(dev, 0x0, 0x49); /* turn off the LED */
645 unset_initialised(dev);
650 usb_autopm_put_interface(dev->interface);
651 mutex_unlock(&dev->lock);
652 return v4l2_fh_release(fp);
655 static ssize_t stk_read(struct file *fp, char __user *buf,
656 size_t count, loff_t *f_pos)
661 struct stk_sio_buffer *sbuf;
662 struct stk_camera *dev = video_drvdata(fp);
664 if (!is_present(dev))
666 if (dev->owner && (!dev->reading || dev->owner != fp))
669 if (!is_streaming(dev)) {
670 if (stk_initialise(dev)
671 || stk_allocate_buffers(dev, 3)
672 || stk_start_stream(dev))
675 spin_lock_irqsave(&dev->spinlock, flags);
676 for (i = 0; i < dev->n_sbufs; i++) {
677 list_add_tail(&dev->sio_bufs[i].list, &dev->sio_avail);
678 dev->sio_bufs[i].v4lbuf.flags = V4L2_BUF_FLAG_QUEUED;
680 spin_unlock_irqrestore(&dev->spinlock, flags);
683 if (fp->f_flags & O_NONBLOCK && list_empty(&dev->sio_full))
685 ret = wait_event_interruptible(dev->wait_frame,
686 !list_empty(&dev->sio_full) || !is_present(dev));
689 if (!is_present(dev))
692 if (count + *f_pos > dev->frame_size)
693 count = dev->frame_size - *f_pos;
694 spin_lock_irqsave(&dev->spinlock, flags);
695 if (list_empty(&dev->sio_full)) {
696 spin_unlock_irqrestore(&dev->spinlock, flags);
697 STK_ERROR("BUG: No siobufs ready\n");
700 sbuf = list_first_entry(&dev->sio_full, struct stk_sio_buffer, list);
701 spin_unlock_irqrestore(&dev->spinlock, flags);
703 if (copy_to_user(buf, sbuf->buffer + *f_pos, count))
708 if (*f_pos >= dev->frame_size) {
710 spin_lock_irqsave(&dev->spinlock, flags);
711 list_move_tail(&sbuf->list, &dev->sio_avail);
712 spin_unlock_irqrestore(&dev->spinlock, flags);
717 static ssize_t v4l_stk_read(struct file *fp, char __user *buf,
718 size_t count, loff_t *f_pos)
720 struct stk_camera *dev = video_drvdata(fp);
723 if (mutex_lock_interruptible(&dev->lock))
725 ret = stk_read(fp, buf, count, f_pos);
726 mutex_unlock(&dev->lock);
730 static unsigned int v4l_stk_poll(struct file *fp, poll_table *wait)
732 struct stk_camera *dev = video_drvdata(fp);
733 unsigned res = v4l2_ctrl_poll(fp, wait);
735 poll_wait(fp, &dev->wait_frame, wait);
737 if (!is_present(dev))
740 if (!list_empty(&dev->sio_full))
741 return res | POLLIN | POLLRDNORM;
747 static void stk_v4l_vm_open(struct vm_area_struct *vma)
749 struct stk_sio_buffer *sbuf = vma->vm_private_data;
752 static void stk_v4l_vm_close(struct vm_area_struct *vma)
754 struct stk_sio_buffer *sbuf = vma->vm_private_data;
756 if (sbuf->mapcount == 0)
757 sbuf->v4lbuf.flags &= ~V4L2_BUF_FLAG_MAPPED;
759 static const struct vm_operations_struct stk_v4l_vm_ops = {
760 .open = stk_v4l_vm_open,
761 .close = stk_v4l_vm_close
764 static int v4l_stk_mmap(struct file *fp, struct vm_area_struct *vma)
768 unsigned long offset = vma->vm_pgoff << PAGE_SHIFT;
769 struct stk_camera *dev = video_drvdata(fp);
770 struct stk_sio_buffer *sbuf = NULL;
772 if (!(vma->vm_flags & VM_WRITE) || !(vma->vm_flags & VM_SHARED))
775 for (i = 0; i < dev->n_sbufs; i++) {
776 if (dev->sio_bufs[i].v4lbuf.m.offset == offset) {
777 sbuf = dev->sio_bufs + i;
783 ret = remap_vmalloc_range(vma, sbuf->buffer, 0);
786 vma->vm_flags |= VM_DONTEXPAND;
787 vma->vm_private_data = sbuf;
788 vma->vm_ops = &stk_v4l_vm_ops;
789 sbuf->v4lbuf.flags |= V4L2_BUF_FLAG_MAPPED;
790 stk_v4l_vm_open(vma);
794 /* v4l ioctl handlers */
796 static int stk_vidioc_querycap(struct file *filp,
797 void *priv, struct v4l2_capability *cap)
799 struct stk_camera *dev = video_drvdata(filp);
801 strcpy(cap->driver, "stk");
802 strcpy(cap->card, "stk");
803 usb_make_path(dev->udev, cap->bus_info, sizeof(cap->bus_info));
805 cap->device_caps = V4L2_CAP_VIDEO_CAPTURE
806 | V4L2_CAP_READWRITE | V4L2_CAP_STREAMING;
807 cap->capabilities = cap->device_caps | V4L2_CAP_DEVICE_CAPS;
811 static int stk_vidioc_enum_input(struct file *filp,
812 void *priv, struct v4l2_input *input)
814 if (input->index != 0)
817 strcpy(input->name, "Syntek USB Camera");
818 input->type = V4L2_INPUT_TYPE_CAMERA;
823 static int stk_vidioc_g_input(struct file *filp, void *priv, unsigned int *i)
829 static int stk_vidioc_s_input(struct file *filp, void *priv, unsigned int i)
831 return i ? -EINVAL : 0;
834 static int stk_s_ctrl(struct v4l2_ctrl *ctrl)
836 struct stk_camera *dev =
837 container_of(ctrl->handler, struct stk_camera, hdl);
840 case V4L2_CID_BRIGHTNESS:
841 return stk_sensor_set_brightness(dev, ctrl->val);
843 if (dmi_check_system(stk_upside_down_dmi_table))
844 dev->vsettings.hflip = !ctrl->val;
846 dev->vsettings.hflip = ctrl->val;
849 if (dmi_check_system(stk_upside_down_dmi_table))
850 dev->vsettings.vflip = !ctrl->val;
852 dev->vsettings.vflip = ctrl->val;
861 static int stk_vidioc_enum_fmt_vid_cap(struct file *filp,
862 void *priv, struct v4l2_fmtdesc *fmtd)
864 switch (fmtd->index) {
866 fmtd->pixelformat = V4L2_PIX_FMT_RGB565;
867 strcpy(fmtd->description, "r5g6b5");
870 fmtd->pixelformat = V4L2_PIX_FMT_RGB565X;
871 strcpy(fmtd->description, "r5g6b5BE");
874 fmtd->pixelformat = V4L2_PIX_FMT_UYVY;
875 strcpy(fmtd->description, "yuv4:2:2");
878 fmtd->pixelformat = V4L2_PIX_FMT_SBGGR8;
879 strcpy(fmtd->description, "Raw bayer");
882 fmtd->pixelformat = V4L2_PIX_FMT_YUYV;
883 strcpy(fmtd->description, "yuv4:2:2");
891 static struct stk_size {
896 { .w = 1280, .h = 1024, .m = MODE_SXGA, },
897 { .w = 640, .h = 480, .m = MODE_VGA, },
898 { .w = 352, .h = 288, .m = MODE_CIF, },
899 { .w = 320, .h = 240, .m = MODE_QVGA, },
900 { .w = 176, .h = 144, .m = MODE_QCIF, },
903 static int stk_vidioc_g_fmt_vid_cap(struct file *filp,
904 void *priv, struct v4l2_format *f)
906 struct v4l2_pix_format *pix_format = &f->fmt.pix;
907 struct stk_camera *dev = video_drvdata(filp);
910 for (i = 0; i < ARRAY_SIZE(stk_sizes) &&
911 stk_sizes[i].m != dev->vsettings.mode; i++)
913 if (i == ARRAY_SIZE(stk_sizes)) {
914 STK_ERROR("ERROR: mode invalid\n");
917 pix_format->width = stk_sizes[i].w;
918 pix_format->height = stk_sizes[i].h;
919 pix_format->field = V4L2_FIELD_NONE;
920 pix_format->colorspace = V4L2_COLORSPACE_SRGB;
921 pix_format->pixelformat = dev->vsettings.palette;
922 if (dev->vsettings.palette == V4L2_PIX_FMT_SBGGR8)
923 pix_format->bytesperline = pix_format->width;
925 pix_format->bytesperline = 2 * pix_format->width;
926 pix_format->sizeimage = pix_format->bytesperline
927 * pix_format->height;
931 static int stk_try_fmt_vid_cap(struct file *filp,
932 struct v4l2_format *fmtd, int *idx)
935 switch (fmtd->fmt.pix.pixelformat) {
936 case V4L2_PIX_FMT_RGB565:
937 case V4L2_PIX_FMT_RGB565X:
938 case V4L2_PIX_FMT_UYVY:
939 case V4L2_PIX_FMT_YUYV:
940 case V4L2_PIX_FMT_SBGGR8:
945 for (i = 1; i < ARRAY_SIZE(stk_sizes); i++) {
946 if (fmtd->fmt.pix.width > stk_sizes[i].w)
949 if (i == ARRAY_SIZE(stk_sizes)
950 || (abs(fmtd->fmt.pix.width - stk_sizes[i-1].w)
951 < abs(fmtd->fmt.pix.width - stk_sizes[i].w))) {
952 fmtd->fmt.pix.height = stk_sizes[i-1].h;
953 fmtd->fmt.pix.width = stk_sizes[i-1].w;
957 fmtd->fmt.pix.height = stk_sizes[i].h;
958 fmtd->fmt.pix.width = stk_sizes[i].w;
963 fmtd->fmt.pix.field = V4L2_FIELD_NONE;
964 fmtd->fmt.pix.colorspace = V4L2_COLORSPACE_SRGB;
965 if (fmtd->fmt.pix.pixelformat == V4L2_PIX_FMT_SBGGR8)
966 fmtd->fmt.pix.bytesperline = fmtd->fmt.pix.width;
968 fmtd->fmt.pix.bytesperline = 2 * fmtd->fmt.pix.width;
969 fmtd->fmt.pix.sizeimage = fmtd->fmt.pix.bytesperline
970 * fmtd->fmt.pix.height;
974 static int stk_vidioc_try_fmt_vid_cap(struct file *filp,
975 void *priv, struct v4l2_format *fmtd)
977 return stk_try_fmt_vid_cap(filp, fmtd, NULL);
980 static int stk_setup_format(struct stk_camera *dev)
984 if (dev->vsettings.palette == V4L2_PIX_FMT_SBGGR8)
988 while (i < ARRAY_SIZE(stk_sizes) &&
989 stk_sizes[i].m != dev->vsettings.mode)
991 if (i == ARRAY_SIZE(stk_sizes)) {
992 STK_ERROR("Something is broken in %s\n", __func__);
995 /* This registers controls some timings, not sure of what. */
996 stk_camera_write_reg(dev, 0x001b, 0x0e);
997 if (dev->vsettings.mode == MODE_SXGA)
998 stk_camera_write_reg(dev, 0x001c, 0x0e);
1000 stk_camera_write_reg(dev, 0x001c, 0x46);
1002 * Registers 0x0115 0x0114 are the size of each line (bytes),
1003 * regs 0x0117 0x0116 are the heigth of the image.
1005 stk_camera_write_reg(dev, 0x0115,
1006 ((stk_sizes[i].w * depth) >> 8) & 0xff);
1007 stk_camera_write_reg(dev, 0x0114,
1008 (stk_sizes[i].w * depth) & 0xff);
1009 stk_camera_write_reg(dev, 0x0117,
1010 (stk_sizes[i].h >> 8) & 0xff);
1011 stk_camera_write_reg(dev, 0x0116,
1012 stk_sizes[i].h & 0xff);
1013 return stk_sensor_configure(dev);
1016 static int stk_vidioc_s_fmt_vid_cap(struct file *filp,
1017 void *priv, struct v4l2_format *fmtd)
1021 struct stk_camera *dev = video_drvdata(filp);
1025 if (!is_present(dev))
1027 if (is_streaming(dev))
1031 ret = stk_try_fmt_vid_cap(filp, fmtd, &idx);
1035 dev->vsettings.palette = fmtd->fmt.pix.pixelformat;
1036 stk_free_buffers(dev);
1037 dev->frame_size = fmtd->fmt.pix.sizeimage;
1038 dev->vsettings.mode = stk_sizes[idx].m;
1040 stk_initialise(dev);
1041 return stk_setup_format(dev);
1044 static int stk_vidioc_reqbufs(struct file *filp,
1045 void *priv, struct v4l2_requestbuffers *rb)
1047 struct stk_camera *dev = video_drvdata(filp);
1051 if (rb->memory != V4L2_MEMORY_MMAP)
1053 if (is_streaming(dev)
1054 || (dev->owner && dev->owner != filp))
1056 stk_free_buffers(dev);
1057 if (rb->count == 0) {
1058 stk_camera_write_reg(dev, 0x0, 0x49); /* turn off the LED */
1059 unset_initialised(dev);
1065 /*FIXME If they ask for zero, we must stop streaming and free */
1068 /* Arbitrary limit */
1069 else if (rb->count > 5)
1072 stk_allocate_buffers(dev, rb->count);
1073 rb->count = dev->n_sbufs;
1077 static int stk_vidioc_querybuf(struct file *filp,
1078 void *priv, struct v4l2_buffer *buf)
1080 struct stk_camera *dev = video_drvdata(filp);
1081 struct stk_sio_buffer *sbuf;
1083 if (buf->index >= dev->n_sbufs)
1085 sbuf = dev->sio_bufs + buf->index;
1086 *buf = sbuf->v4lbuf;
1090 static int stk_vidioc_qbuf(struct file *filp,
1091 void *priv, struct v4l2_buffer *buf)
1093 struct stk_camera *dev = video_drvdata(filp);
1094 struct stk_sio_buffer *sbuf;
1095 unsigned long flags;
1097 if (buf->memory != V4L2_MEMORY_MMAP)
1100 if (buf->index >= dev->n_sbufs)
1102 sbuf = dev->sio_bufs + buf->index;
1103 if (sbuf->v4lbuf.flags & V4L2_BUF_FLAG_QUEUED)
1105 sbuf->v4lbuf.flags |= V4L2_BUF_FLAG_QUEUED;
1106 sbuf->v4lbuf.flags &= ~V4L2_BUF_FLAG_DONE;
1107 spin_lock_irqsave(&dev->spinlock, flags);
1108 list_add_tail(&sbuf->list, &dev->sio_avail);
1109 *buf = sbuf->v4lbuf;
1110 spin_unlock_irqrestore(&dev->spinlock, flags);
1114 static int stk_vidioc_dqbuf(struct file *filp,
1115 void *priv, struct v4l2_buffer *buf)
1117 struct stk_camera *dev = video_drvdata(filp);
1118 struct stk_sio_buffer *sbuf;
1119 unsigned long flags;
1122 if (!is_streaming(dev))
1125 if (filp->f_flags & O_NONBLOCK && list_empty(&dev->sio_full))
1126 return -EWOULDBLOCK;
1127 ret = wait_event_interruptible(dev->wait_frame,
1128 !list_empty(&dev->sio_full) || !is_present(dev));
1131 if (!is_present(dev))
1134 spin_lock_irqsave(&dev->spinlock, flags);
1135 sbuf = list_first_entry(&dev->sio_full, struct stk_sio_buffer, list);
1136 list_del_init(&sbuf->list);
1137 spin_unlock_irqrestore(&dev->spinlock, flags);
1138 sbuf->v4lbuf.flags &= ~V4L2_BUF_FLAG_QUEUED;
1139 sbuf->v4lbuf.flags |= V4L2_BUF_FLAG_DONE;
1140 sbuf->v4lbuf.sequence = ++dev->sequence;
1141 v4l2_get_timestamp(&sbuf->v4lbuf.timestamp);
1143 *buf = sbuf->v4lbuf;
1147 static int stk_vidioc_streamon(struct file *filp,
1148 void *priv, enum v4l2_buf_type type)
1150 struct stk_camera *dev = video_drvdata(filp);
1151 if (is_streaming(dev))
1153 if (dev->sio_bufs == NULL)
1156 return stk_start_stream(dev);
1159 static int stk_vidioc_streamoff(struct file *filp,
1160 void *priv, enum v4l2_buf_type type)
1162 struct stk_camera *dev = video_drvdata(filp);
1163 unsigned long flags;
1165 stk_stop_stream(dev);
1166 spin_lock_irqsave(&dev->spinlock, flags);
1167 INIT_LIST_HEAD(&dev->sio_avail);
1168 INIT_LIST_HEAD(&dev->sio_full);
1169 for (i = 0; i < dev->n_sbufs; i++) {
1170 INIT_LIST_HEAD(&dev->sio_bufs[i].list);
1171 dev->sio_bufs[i].v4lbuf.flags = 0;
1173 spin_unlock_irqrestore(&dev->spinlock, flags);
1178 static int stk_vidioc_g_parm(struct file *filp,
1179 void *priv, struct v4l2_streamparm *sp)
1181 /*FIXME This is not correct */
1182 sp->parm.capture.timeperframe.numerator = 1;
1183 sp->parm.capture.timeperframe.denominator = 30;
1184 sp->parm.capture.readbuffers = 2;
1188 static int stk_vidioc_enum_framesizes(struct file *filp,
1189 void *priv, struct v4l2_frmsizeenum *frms)
1191 if (frms->index >= ARRAY_SIZE(stk_sizes))
1193 switch (frms->pixel_format) {
1194 case V4L2_PIX_FMT_RGB565:
1195 case V4L2_PIX_FMT_RGB565X:
1196 case V4L2_PIX_FMT_UYVY:
1197 case V4L2_PIX_FMT_YUYV:
1198 case V4L2_PIX_FMT_SBGGR8:
1199 frms->type = V4L2_FRMSIZE_TYPE_DISCRETE;
1200 frms->discrete.width = stk_sizes[frms->index].w;
1201 frms->discrete.height = stk_sizes[frms->index].h;
1203 default: return -EINVAL;
1207 static const struct v4l2_ctrl_ops stk_ctrl_ops = {
1208 .s_ctrl = stk_s_ctrl,
1211 static struct v4l2_file_operations v4l_stk_fops = {
1212 .owner = THIS_MODULE,
1213 .open = v4l_stk_open,
1214 .release = v4l_stk_release,
1215 .read = v4l_stk_read,
1216 .poll = v4l_stk_poll,
1217 .mmap = v4l_stk_mmap,
1218 .unlocked_ioctl = video_ioctl2,
1221 static const struct v4l2_ioctl_ops v4l_stk_ioctl_ops = {
1222 .vidioc_querycap = stk_vidioc_querycap,
1223 .vidioc_enum_fmt_vid_cap = stk_vidioc_enum_fmt_vid_cap,
1224 .vidioc_try_fmt_vid_cap = stk_vidioc_try_fmt_vid_cap,
1225 .vidioc_s_fmt_vid_cap = stk_vidioc_s_fmt_vid_cap,
1226 .vidioc_g_fmt_vid_cap = stk_vidioc_g_fmt_vid_cap,
1227 .vidioc_enum_input = stk_vidioc_enum_input,
1228 .vidioc_s_input = stk_vidioc_s_input,
1229 .vidioc_g_input = stk_vidioc_g_input,
1230 .vidioc_reqbufs = stk_vidioc_reqbufs,
1231 .vidioc_querybuf = stk_vidioc_querybuf,
1232 .vidioc_qbuf = stk_vidioc_qbuf,
1233 .vidioc_dqbuf = stk_vidioc_dqbuf,
1234 .vidioc_streamon = stk_vidioc_streamon,
1235 .vidioc_streamoff = stk_vidioc_streamoff,
1236 .vidioc_g_parm = stk_vidioc_g_parm,
1237 .vidioc_enum_framesizes = stk_vidioc_enum_framesizes,
1238 .vidioc_log_status = v4l2_ctrl_log_status,
1239 .vidioc_subscribe_event = v4l2_ctrl_subscribe_event,
1240 .vidioc_unsubscribe_event = v4l2_event_unsubscribe,
1243 static void stk_v4l_dev_release(struct video_device *vd)
1245 struct stk_camera *dev = vdev_to_camera(vd);
1247 if (dev->sio_bufs != NULL || dev->isobufs != NULL)
1248 STK_ERROR("We are leaking memory\n");
1249 usb_put_intf(dev->interface);
1253 static struct video_device stk_v4l_data = {
1254 .name = "stkwebcam",
1255 .fops = &v4l_stk_fops,
1256 .ioctl_ops = &v4l_stk_ioctl_ops,
1257 .release = stk_v4l_dev_release,
1261 static int stk_register_video_device(struct stk_camera *dev)
1265 dev->vdev = stk_v4l_data;
1266 dev->vdev.lock = &dev->lock;
1267 dev->vdev.v4l2_dev = &dev->v4l2_dev;
1268 video_set_drvdata(&dev->vdev, dev);
1269 err = video_register_device(&dev->vdev, VFL_TYPE_GRABBER, -1);
1271 STK_ERROR("v4l registration failed\n");
1273 STK_INFO("Syntek USB2.0 Camera is now controlling device %s\n",
1274 video_device_node_name(&dev->vdev));
1281 static int stk_camera_probe(struct usb_interface *interface,
1282 const struct usb_device_id *id)
1284 struct v4l2_ctrl_handler *hdl;
1288 struct stk_camera *dev = NULL;
1289 struct usb_device *udev = interface_to_usbdev(interface);
1290 struct usb_host_interface *iface_desc;
1291 struct usb_endpoint_descriptor *endpoint;
1293 dev = kzalloc(sizeof(struct stk_camera), GFP_KERNEL);
1295 STK_ERROR("Out of memory !\n");
1298 err = v4l2_device_register(&interface->dev, &dev->v4l2_dev);
1300 dev_err(&udev->dev, "couldn't register v4l2_device\n");
1305 v4l2_ctrl_handler_init(hdl, 3);
1306 v4l2_ctrl_new_std(hdl, &stk_ctrl_ops,
1307 V4L2_CID_BRIGHTNESS, 0, 0xff, 0x1, 0x60);
1308 v4l2_ctrl_new_std(hdl, &stk_ctrl_ops,
1309 V4L2_CID_HFLIP, 0, 1, 1, 1);
1310 v4l2_ctrl_new_std(hdl, &stk_ctrl_ops,
1311 V4L2_CID_VFLIP, 0, 1, 1, 1);
1314 dev_err(&udev->dev, "couldn't register control\n");
1317 dev->v4l2_dev.ctrl_handler = hdl;
1319 spin_lock_init(&dev->spinlock);
1320 mutex_init(&dev->lock);
1321 init_waitqueue_head(&dev->wait_frame);
1322 dev->first_init = 1; /* webcam LED management */
1325 dev->interface = interface;
1326 usb_get_intf(interface);
1329 dev->vsettings.hflip = hflip;
1330 else if (dmi_check_system(stk_upside_down_dmi_table))
1331 dev->vsettings.hflip = 1;
1333 dev->vsettings.hflip = 0;
1335 dev->vsettings.vflip = vflip;
1336 else if (dmi_check_system(stk_upside_down_dmi_table))
1337 dev->vsettings.vflip = 1;
1339 dev->vsettings.vflip = 0;
1343 /* Set up the endpoint information
1344 * use only the first isoc-in endpoint
1345 * for the current alternate setting */
1346 iface_desc = interface->cur_altsetting;
1348 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
1349 endpoint = &iface_desc->endpoint[i].desc;
1352 && usb_endpoint_is_isoc_in(endpoint)) {
1353 /* we found an isoc in endpoint */
1354 dev->isoc_ep = usb_endpoint_num(endpoint);
1358 if (!dev->isoc_ep) {
1359 STK_ERROR("Could not find isoc-in endpoint");
1363 dev->vsettings.palette = V4L2_PIX_FMT_RGB565;
1364 dev->vsettings.mode = MODE_VGA;
1365 dev->frame_size = 640 * 480 * 2;
1367 INIT_LIST_HEAD(&dev->sio_avail);
1368 INIT_LIST_HEAD(&dev->sio_full);
1370 usb_set_intfdata(interface, dev);
1372 err = stk_register_video_device(dev);
1379 v4l2_ctrl_handler_free(hdl);
1380 v4l2_device_unregister(&dev->v4l2_dev);
1385 static void stk_camera_disconnect(struct usb_interface *interface)
1387 struct stk_camera *dev = usb_get_intfdata(interface);
1389 usb_set_intfdata(interface, NULL);
1392 wake_up_interruptible(&dev->wait_frame);
1394 STK_INFO("Syntek USB2.0 Camera release resources device %s\n",
1395 video_device_node_name(&dev->vdev));
1397 video_unregister_device(&dev->vdev);
1398 v4l2_ctrl_handler_free(&dev->hdl);
1399 v4l2_device_unregister(&dev->v4l2_dev);
1403 static int stk_camera_suspend(struct usb_interface *intf, pm_message_t message)
1405 struct stk_camera *dev = usb_get_intfdata(intf);
1406 if (is_streaming(dev)) {
1407 stk_stop_stream(dev);
1408 /* yes, this is ugly */
1414 static int stk_camera_resume(struct usb_interface *intf)
1416 struct stk_camera *dev = usb_get_intfdata(intf);
1417 if (!is_initialised(dev))
1419 unset_initialised(dev);
1420 stk_initialise(dev);
1421 stk_camera_write_reg(dev, 0x0, 0x49);
1422 stk_setup_format(dev);
1423 if (is_streaming(dev))
1424 stk_start_stream(dev);
1429 static struct usb_driver stk_camera_driver = {
1430 .name = "stkwebcam",
1431 .probe = stk_camera_probe,
1432 .disconnect = stk_camera_disconnect,
1433 .id_table = stkwebcam_table,
1435 .suspend = stk_camera_suspend,
1436 .resume = stk_camera_resume,
1440 module_usb_driver(stk_camera_driver);