2 * USB ViCam WebCam driver
3 * Copyright (c) 2002 Joe Burks (jburks@wavicle.org),
4 * Christopher L Cheney (ccheney@cheney.cx),
5 * Pavel Machek (pavel@ucw.cz),
6 * John Tyner (jtyner@cs.ucr.edu),
7 * Monroe Williams (monroe@pobox.com)
9 * Supports 3COM HomeConnect PC Digital WebCam
10 * Supports Compro PS39U WebCam
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 * This source code is based heavily on the CPiA webcam driver which was
27 * written by Peter Pregler, Scott J. Bertin and Johannes Erdfelt
29 * Portions of this code were also copied from usbvideo.c
31 * Special thanks to the whole team at Sourceforge for help making
32 * this driver become a reality. Notably:
33 * Andy Armstrong who reverse engineered the color encoding and
34 * Pavel Machek and Chris Cheney who worked on reverse engineering the
35 * camera controls and wrote the first generation driver.
38 #include <linux/kernel.h>
39 #include <linux/module.h>
40 #include <linux/init.h>
42 #include <linux/usb.h>
43 #include <linux/vmalloc.h>
45 #include <linux/slab.h>
46 #include <linux/mutex.h>
47 #include <linux/firmware.h>
48 #include <linux/ihex.h>
51 /* #define VICAM_DEBUG */
54 #define ADBG(lineno, fmt, args...) printk(fmt, jiffies, __func__, lineno, ##args)
55 #define DBG(fmt, args...) ADBG((__LINE__), KERN_DEBUG __FILE__"(%ld):%s (%d):"fmt, ##args)
57 #define DBG(fmn, args...) do {} while (0)
60 #define DRIVER_AUTHOR "Joe Burks, jburks@wavicle.org"
61 #define DRIVER_DESC "ViCam WebCam Driver"
63 /* Define these values to match your device */
64 #define USB_VICAM_VENDOR_ID 0x04c1
65 #define USB_VICAM_PRODUCT_ID 0x009d
66 #define USB_COMPRO_VENDOR_ID 0x0602
67 #define USB_COMPRO_PRODUCT_ID 0x1001
69 #define VICAM_BYTES_PER_PIXEL 3
70 #define VICAM_MAX_READ_SIZE (512*242+128)
71 #define VICAM_MAX_FRAME_SIZE (VICAM_BYTES_PER_PIXEL*320*240)
72 #define VICAM_FRAMES 2
74 #define VICAM_HEADER_SIZE 64
76 /* rvmalloc / rvfree copied from usbvideo.c
78 * Not sure why these are not yet non-statics which I can reference through
79 * usbvideo.h the same as it is in 2.4.20. I bet this will get fixed sometime
83 static void *rvmalloc(unsigned long size)
88 size = PAGE_ALIGN(size);
89 mem = vmalloc_32(size);
93 memset(mem, 0, size); /* Clear the ram out, no junk to the user */
94 adr = (unsigned long) mem;
96 SetPageReserved(vmalloc_to_page((void *)adr));
104 static void rvfree(void *mem, unsigned long size)
111 adr = (unsigned long) mem;
112 while ((long) size > 0) {
113 ClearPageReserved(vmalloc_to_page((void *)adr));
120 struct vicam_camera {
121 u16 shutter_speed; /* capture shutter speed */
122 u16 gain; /* capture gain */
124 u8 *raw_image; /* raw data captured from the camera */
125 u8 *framebuf; /* processed data in RGB24 format */
126 u8 *cntrlbuf; /* area used to send control msgs */
128 struct video_device vdev; /* v4l video device */
129 struct usb_device *udev; /* usb device */
131 /* guard against simultaneous accesses to the camera */
132 struct mutex cam_lock;
140 static int vicam_probe(struct usb_interface *intf, const struct usb_device_id *id);
141 static void vicam_disconnect(struct usb_interface *intf);
142 static void read_frame(struct vicam_camera *cam, int framenum);
143 static void vicam_decode_color(const u8 *, u8 *);
145 static int __send_control_msg(struct vicam_camera *cam,
154 /* cp must be memory that has been allocated by kmalloc */
156 status = usb_control_msg(cam->udev,
157 usb_sndctrlpipe(cam->udev, 0),
159 USB_DIR_OUT | USB_TYPE_VENDOR |
160 USB_RECIP_DEVICE, value, index,
163 status = min(status, 0);
166 printk(KERN_INFO "Failed sending control message, error %d.\n",
173 static int send_control_msg(struct vicam_camera *cam,
180 int status = -ENODEV;
181 mutex_lock(&cam->cam_lock);
183 status = __send_control_msg(cam, request, value,
186 mutex_unlock(&cam->cam_lock);
190 initialize_camera(struct vicam_camera *cam)
193 const struct ihex_binrec *rec;
194 const struct firmware *uninitialized_var(fw);
196 err = request_ihex_firmware(&fw, "vicam/firmware.fw", &cam->udev->dev);
198 printk(KERN_ERR "Failed to load \"vicam/firmware.fw\": %d\n",
203 for (rec = (void *)fw->data; rec; rec = ihex_next_binrec(rec)) {
204 memcpy(cam->cntrlbuf, rec->data, be16_to_cpu(rec->len));
206 err = send_control_msg(cam, 0xff, 0, 0,
207 cam->cntrlbuf, be16_to_cpu(rec->len));
212 release_firmware(fw);
218 set_camera_power(struct vicam_camera *cam, int state)
222 status = send_control_msg(cam, 0x50, state, 0, NULL, 0);
227 send_control_msg(cam, 0x55, 1, 0, NULL, 0);
233 vicam_ioctl(struct file *file, unsigned int ioctlnr, unsigned long arg)
235 void __user *user_arg = (void __user *)arg;
236 struct vicam_camera *cam = file->private_data;
243 /* query capabilities */
246 struct video_capability b;
249 memset(&b, 0, sizeof(b));
250 strcpy(b.name, "ViCam-based Camera");
251 b.type = VID_TYPE_CAPTURE;
254 b.maxwidth = 320; /* VIDEOSIZE_CIF */
256 b.minwidth = 320; /* VIDEOSIZE_48_48 */
259 if (copy_to_user(user_arg, &b, sizeof(b)))
264 /* get/set video source - we are a camera and nothing else */
267 struct video_channel v;
269 DBG("VIDIOCGCHAN\n");
270 if (copy_from_user(&v, user_arg, sizeof(v))) {
274 if (v.channel != 0) {
280 strcpy(v.name, "Camera");
283 v.type = VIDEO_TYPE_CAMERA;
286 if (copy_to_user(user_arg, &v, sizeof(v)))
295 if (copy_from_user(&v, user_arg, sizeof(v)))
297 DBG("VIDIOCSCHAN %d\n", v);
299 if (retval == 0 && v != 0)
305 /* image properties */
308 struct video_picture vp;
309 DBG("VIDIOCGPICT\n");
310 memset(&vp, 0, sizeof(struct video_picture));
311 vp.brightness = cam->gain << 8;
313 vp.palette = VIDEO_PALETTE_RGB24;
314 if (copy_to_user(user_arg, &vp, sizeof(struct video_picture)))
321 struct video_picture vp;
323 if (copy_from_user(&vp, user_arg, sizeof(vp))) {
328 DBG("VIDIOCSPICT depth = %d, pal = %d\n", vp.depth,
331 cam->gain = vp.brightness >> 8;
334 || vp.palette != VIDEO_PALETTE_RGB24)
340 /* get/set capture window */
343 struct video_window vw;
355 if (copy_to_user(user_arg, (void *)&vw, sizeof(vw)))
358 /* I'm not sure what the deal with a capture window is, it is very poorly described
359 * in the doc. So I won't support it now. */
366 struct video_window vw;
368 if (copy_from_user(&vw, user_arg, sizeof(vw))) {
373 DBG("VIDIOCSWIN %d x %d\n", vw.width, vw.height);
375 if (vw.width != 320 || vw.height != 240)
384 struct video_mbuf vm;
387 DBG("VIDIOCGMBUF\n");
388 memset(&vm, 0, sizeof(vm));
390 VICAM_MAX_FRAME_SIZE * VICAM_FRAMES;
391 vm.frames = VICAM_FRAMES;
392 for (i = 0; i < VICAM_FRAMES; i++)
393 vm.offsets[i] = VICAM_MAX_FRAME_SIZE * i;
395 if (copy_to_user(user_arg, (void *)&vm, sizeof(vm)))
403 struct video_mmap vm;
404 /* int video_size; */
406 if (copy_from_user((void *)&vm, user_arg, sizeof(vm))) {
411 DBG("VIDIOCMCAPTURE frame=%d, height=%d, width=%d, format=%d.\n",
412 vm.frame, vm.width, vm.height, vm.format);
414 if (vm.frame >= VICAM_FRAMES || vm.format != VIDEO_PALETTE_RGB24)
417 /* in theory right here we'd start the image capturing
418 * (fill in a bulk urb and submit it asynchronously)
420 * Instead we're going to do a total hack job for now and
421 * retrieve the frame in VIDIOCSYNC */
430 if (copy_from_user((void *)&frame, user_arg, sizeof(int))) {
434 DBG("VIDIOCSYNC: %d\n", frame);
436 read_frame(cam, frame);
437 vicam_decode_color(cam->raw_image,
439 frame * VICAM_MAX_FRAME_SIZE);
444 /* pointless to implement overlay with this camera */
452 /* tuner interface - we have none */
460 /* audio interface - we have none */
466 retval = -ENOIOCTLCMD;
474 vicam_open(struct file *file)
476 struct vicam_camera *cam = video_drvdata(file);
482 "vicam video_device improperly initialized");
486 /* cam_lock/open_count protects us from simultaneous opens
487 * ... for now. we probably shouldn't rely on this fact forever.
490 mutex_lock(&cam->cam_lock);
491 if (cam->open_count > 0) {
493 "vicam_open called on already opened camera");
494 mutex_unlock(&cam->cam_lock);
498 cam->raw_image = kmalloc(VICAM_MAX_READ_SIZE, GFP_KERNEL);
499 if (!cam->raw_image) {
500 mutex_unlock(&cam->cam_lock);
504 cam->framebuf = rvmalloc(VICAM_MAX_FRAME_SIZE * VICAM_FRAMES);
505 if (!cam->framebuf) {
506 kfree(cam->raw_image);
507 mutex_unlock(&cam->cam_lock);
511 cam->cntrlbuf = kmalloc(PAGE_SIZE, GFP_KERNEL);
512 if (!cam->cntrlbuf) {
513 kfree(cam->raw_image);
514 rvfree(cam->framebuf, VICAM_MAX_FRAME_SIZE * VICAM_FRAMES);
515 mutex_unlock(&cam->cam_lock);
519 cam->needsDummyRead = 1;
522 file->private_data = cam;
523 mutex_unlock(&cam->cam_lock);
526 /* First upload firmware, then turn the camera on */
528 if (!cam->is_initialized) {
529 initialize_camera(cam);
531 cam->is_initialized = 1;
534 set_camera_power(cam, 1);
540 vicam_close(struct file *file)
542 struct vicam_camera *cam = file->private_data;
544 struct usb_device *udev;
548 /* it's not the end of the world if
549 * we fail to turn the camera off.
552 set_camera_power(cam, 0);
554 kfree(cam->raw_image);
555 rvfree(cam->framebuf, VICAM_MAX_FRAME_SIZE * VICAM_FRAMES);
556 kfree(cam->cntrlbuf);
558 mutex_lock(&cam->cam_lock);
561 open_count = cam->open_count;
564 mutex_unlock(&cam->cam_lock);
566 if (!open_count && !udev)
572 static void vicam_decode_color(const u8 *data, u8 *rgb)
574 /* vicam_decode_color - Convert from Vicam Y-Cr-Cb to RGB
575 * Copyright (C) 2002 Monroe Williams (monroe@pobox.com)
583 data += VICAM_HEADER_SIZE;
585 for (i = 0; i < 240; i++, data += 512) {
586 const int y = (i * 242) / 240;
597 for (j = 0; j < 320; j++, rgb += 3) {
598 const int x = (j * 512) / 320;
599 const u8 * const src = &data[x];
604 Cr = (src[prevX] - src[0]) +
605 (src[nextX] - src[0]);
608 Cb = (src[prevY] - src[prevX + prevY]) +
609 (src[prevY] - src[nextX + prevY]) +
610 (src[nextY] - src[prevX + nextY]) +
611 (src[nextY] - src[nextX + nextY]);
614 Y = 1160 * (src[0] + (Cr / 2) - 16);
627 rgb[0] = clamp(((Y + (2017 * Cb)) +
629 rgb[1] = clamp(((Y - (392 * Cb) -
631 500) / 1000, 0, 255);
632 rgb[2] = clamp(((Y + (1594 * Cr)) +
633 500) / 1300, 0, 255);
643 read_frame(struct vicam_camera *cam, int framenum)
645 unsigned char *request = cam->cntrlbuf;
650 if (cam->needsDummyRead) {
651 cam->needsDummyRead = 0;
652 read_frame(cam, framenum);
655 memset(request, 0, 16);
656 request[0] = cam->gain; /* 0 = 0% gain, FF = 100% gain */
658 request[1] = 0; /* 512x242 capture */
660 request[2] = 0x90; /* the function of these two bytes */
661 request[3] = 0x07; /* is not yet understood */
663 if (cam->shutter_speed > 60) {
666 ((-15631900 / cam->shutter_speed) + 260533) / 1000;
667 request[4] = realShutter & 0xFF;
668 request[5] = (realShutter >> 8) & 0xFF;
673 realShutter = 15600 / cam->shutter_speed - 1;
676 request[6] = realShutter & 0xFF;
677 request[7] = realShutter >> 8;
680 /* Per John Markus Bjørndalen, byte at index 8 causes problems if it isn't 0*/
682 /* bytes 9-15 do not seem to affect exposure or image quality */
684 mutex_lock(&cam->cam_lock);
689 n = __send_control_msg(cam, 0x51, 0x80, 0, request, 16);
693 " Problem sending frame capture control message");
697 n = usb_bulk_msg(cam->udev,
698 usb_rcvbulkpipe(cam->udev, cam->bulkEndpoint),
700 512 * 242 + 128, &actual_length, 10000);
703 printk(KERN_ERR "Problem during bulk read of frame data: %d\n",
708 mutex_unlock(&cam->cam_lock);
712 vicam_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)
714 struct vicam_camera *cam = file->private_data;
716 DBG("read %d bytes.\n", (int) count);
718 if (*ppos >= VICAM_MAX_FRAME_SIZE) {
725 vicam_decode_color(cam->raw_image,
727 0 * VICAM_MAX_FRAME_SIZE);
730 count = min_t(size_t, count, VICAM_MAX_FRAME_SIZE - *ppos);
732 if (copy_to_user(buf, &cam->framebuf[*ppos], count))
737 if (count == VICAM_MAX_FRAME_SIZE)
745 vicam_mmap(struct file *file, struct vm_area_struct *vma)
747 /* TODO: allocate the raw frame buffer if necessary */
748 unsigned long page, pos;
749 unsigned long start = vma->vm_start;
750 unsigned long size = vma->vm_end-vma->vm_start;
751 struct vicam_camera *cam = file->private_data;
756 DBG("vicam_mmap: %ld\n", size);
758 /* We let mmap allocate as much as it wants because Linux was adding 2048 bytes
759 * to the size the application requested for mmap and it was screwing apps up.
760 if (size > VICAM_FRAMES*VICAM_MAX_FRAME_SIZE)
764 pos = (unsigned long)cam->framebuf;
766 page = vmalloc_to_pfn((void *)pos);
767 if (remap_pfn_range(vma, start, page, PAGE_SIZE, PAGE_SHARED))
772 if (size > PAGE_SIZE)
781 static const struct v4l2_file_operations vicam_fops = {
782 .owner = THIS_MODULE,
784 .release = vicam_close,
787 .ioctl = vicam_ioctl,
790 static struct video_device vicam_template = {
791 .name = "ViCam-based USB Camera",
793 .release = video_device_release_empty,
796 /* table of devices that work with this driver */
797 static struct usb_device_id vicam_table[] = {
798 {USB_DEVICE(USB_VICAM_VENDOR_ID, USB_VICAM_PRODUCT_ID)},
799 {USB_DEVICE(USB_COMPRO_VENDOR_ID, USB_COMPRO_PRODUCT_ID)},
800 {} /* Terminating entry */
803 MODULE_DEVICE_TABLE(usb, vicam_table);
805 static struct usb_driver vicam_driver = {
807 .probe = vicam_probe,
808 .disconnect = vicam_disconnect,
809 .id_table = vicam_table
814 * @intf: the interface
817 * Called by the usb core when a new device is connected that it thinks
818 * this driver might be interested in.
821 vicam_probe(struct usb_interface *intf, const struct usb_device_id *id)
823 struct usb_device *dev = interface_to_usbdev(intf);
824 int bulkEndpoint = 0;
825 const struct usb_host_interface *interface;
826 const struct usb_endpoint_descriptor *endpoint;
827 struct vicam_camera *cam;
829 printk(KERN_INFO "ViCam based webcam connected\n");
831 interface = intf->cur_altsetting;
833 DBG(KERN_DEBUG "Interface %d. has %u. endpoints!\n",
834 interface->desc.bInterfaceNumber, (unsigned) (interface->desc.bNumEndpoints));
835 endpoint = &interface->endpoint[0].desc;
837 if (usb_endpoint_is_bulk_in(endpoint)) {
838 /* we found a bulk in endpoint */
839 bulkEndpoint = endpoint->bEndpointAddress;
842 "No bulk in endpoint was found ?! (this is bad)\n");
845 cam = kzalloc(sizeof(struct vicam_camera), GFP_KERNEL);
848 "could not allocate kernel memory for vicam_camera struct\n");
853 cam->shutter_speed = 15;
855 mutex_init(&cam->cam_lock);
857 memcpy(&cam->vdev, &vicam_template, sizeof(vicam_template));
858 video_set_drvdata(&cam->vdev, cam);
861 cam->bulkEndpoint = bulkEndpoint;
863 if (video_register_device(&cam->vdev, VFL_TYPE_GRABBER, -1) < 0) {
865 printk(KERN_WARNING "video_register_device failed\n");
869 printk(KERN_INFO "ViCam webcam driver now controlling device %s\n",
870 video_device_node_name(&cam->vdev));
872 usb_set_intfdata(intf, cam);
878 vicam_disconnect(struct usb_interface *intf)
881 struct vicam_camera *cam = usb_get_intfdata(intf);
882 usb_set_intfdata(intf, NULL);
884 /* we must unregister the device before taking its
885 * cam_lock. This is because the video open call
886 * holds the same lock as video unregister. if we
887 * unregister inside of the cam_lock and open also
888 * uses the cam_lock, we get deadlock.
891 video_unregister_device(&cam->vdev);
893 /* stop the camera from being used */
895 mutex_lock(&cam->cam_lock);
897 /* mark the camera as gone */
901 /* the only thing left to do is synchronize with
902 * our close/release function on who should release
903 * the camera memory. if there are any users using the
904 * camera, it's their job. if there are no users,
908 open_count = cam->open_count;
910 mutex_unlock(&cam->cam_lock);
915 printk(KERN_DEBUG "ViCam-based WebCam disconnected\n");
924 DBG(KERN_INFO "ViCam-based WebCam driver startup\n");
925 retval = usb_register(&vicam_driver);
927 printk(KERN_WARNING "usb_register failed!\n");
935 "ViCam-based WebCam driver shutdown\n");
937 usb_deregister(&vicam_driver);
940 module_init(usb_vicam_init);
941 module_exit(usb_vicam_exit);
943 MODULE_AUTHOR(DRIVER_AUTHOR);
944 MODULE_DESCRIPTION(DRIVER_DESC);
945 MODULE_LICENSE("GPL");
946 MODULE_FIRMWARE("vicam/firmware.fw");