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@suse.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>
41 #include <linux/videodev.h>
42 #include <linux/usb.h>
43 #include <linux/vmalloc.h>
45 #include <linux/slab.h>
46 #include <linux/smp_lock.h>
47 #include <linux/mutex.h>
48 #include <linux/firmware.h>
49 #include <linux/ihex.h>
52 // #define VICAM_DEBUG
55 #define ADBG(lineno,fmt,args...) printk(fmt, jiffies, __func__, lineno, ##args)
56 #define DBG(fmt,args...) ADBG((__LINE__),KERN_DEBUG __FILE__"(%ld):%s (%d):"fmt,##args)
58 #define DBG(fmn,args...) do {} while(0)
61 #define DRIVER_AUTHOR "Joe Burks, jburks@wavicle.org"
62 #define DRIVER_DESC "ViCam WebCam Driver"
64 /* Define these values to match your device */
65 #define USB_VICAM_VENDOR_ID 0x04c1
66 #define USB_VICAM_PRODUCT_ID 0x009d
67 #define USB_COMPRO_VENDOR_ID 0x0602
68 #define USB_COMPRO_PRODUCT_ID 0x1001
70 #define VICAM_BYTES_PER_PIXEL 3
71 #define VICAM_MAX_READ_SIZE (512*242+128)
72 #define VICAM_MAX_FRAME_SIZE (VICAM_BYTES_PER_PIXEL*320*240)
73 #define VICAM_FRAMES 2
75 #define VICAM_HEADER_SIZE 64
77 /* rvmalloc / rvfree copied from usbvideo.c
79 * Not sure why these are not yet non-statics which I can reference through
80 * usbvideo.h the same as it is in 2.4.20. I bet this will get fixed sometime
84 static void *rvmalloc(unsigned long size)
89 size = PAGE_ALIGN(size);
90 mem = vmalloc_32(size);
94 memset(mem, 0, size); /* Clear the ram out, no junk to the user */
95 adr = (unsigned long) mem;
97 SetPageReserved(vmalloc_to_page((void *)adr));
105 static void rvfree(void *mem, unsigned long size)
112 adr = (unsigned long) mem;
113 while ((long) size > 0) {
114 ClearPageReserved(vmalloc_to_page((void *)adr));
121 struct vicam_camera {
122 u16 shutter_speed; // capture shutter speed
123 u16 gain; // capture gain
125 u8 *raw_image; // raw data captured from the camera
126 u8 *framebuf; // processed data in RGB24 format
127 u8 *cntrlbuf; // area used to send control msgs
129 struct video_device vdev; // v4l video device
130 struct usb_device *udev; // usb device
132 /* guard against simultaneous accesses to the camera */
133 struct mutex cam_lock;
141 static int vicam_probe( struct usb_interface *intf, const struct usb_device_id *id);
142 static void vicam_disconnect(struct usb_interface *intf);
143 static void read_frame(struct vicam_camera *cam, int framenum);
144 static void vicam_decode_color(const u8 *, u8 *);
146 static int __send_control_msg(struct vicam_camera *cam,
155 /* cp must be memory that has been allocated by kmalloc */
157 status = usb_control_msg(cam->udev,
158 usb_sndctrlpipe(cam->udev, 0),
160 USB_DIR_OUT | USB_TYPE_VENDOR |
161 USB_RECIP_DEVICE, value, index,
164 status = min(status, 0);
167 printk(KERN_INFO "Failed sending control message, error %d.\n",
174 static int send_control_msg(struct vicam_camera *cam,
181 int status = -ENODEV;
182 mutex_lock(&cam->cam_lock);
184 status = __send_control_msg(cam, request, value,
187 mutex_unlock(&cam->cam_lock);
191 initialize_camera(struct vicam_camera *cam)
194 const struct ihex_binrec *rec;
195 const struct firmware *uninitialized_var(fw);
197 err = request_ihex_firmware(&fw, "vicam/firmware.fw", &cam->udev->dev);
199 printk(KERN_ERR "Failed to load \"vicam/firmware.fw\": %d\n",
204 for (rec = (void *)fw->data; rec; rec = ihex_next_binrec(rec)) {
205 memcpy(cam->cntrlbuf, rec->data, be16_to_cpu(rec->len));
207 err = send_control_msg(cam, 0xff, 0, 0,
208 cam->cntrlbuf, be16_to_cpu(rec->len));
213 release_firmware(fw);
219 set_camera_power(struct vicam_camera *cam, int state)
223 if ((status = send_control_msg(cam, 0x50, state, 0, NULL, 0)) < 0)
227 send_control_msg(cam, 0x55, 1, 0, NULL, 0);
234 vicam_ioctl(struct file *file, unsigned int ioctlnr, unsigned long arg)
236 void __user *user_arg = (void __user *)arg;
237 struct vicam_camera *cam = file->private_data;
244 /* query capabilities */
247 struct video_capability b;
250 memset(&b, 0, sizeof(b));
251 strcpy(b.name, "ViCam-based Camera");
252 b.type = VID_TYPE_CAPTURE;
255 b.maxwidth = 320; /* VIDEOSIZE_CIF */
257 b.minwidth = 320; /* VIDEOSIZE_48_48 */
260 if (copy_to_user(user_arg, &b, sizeof(b)))
265 /* get/set video source - we are a camera and nothing else */
268 struct video_channel v;
270 DBG("VIDIOCGCHAN\n");
271 if (copy_from_user(&v, user_arg, sizeof(v))) {
275 if (v.channel != 0) {
281 strcpy(v.name, "Camera");
284 v.type = VIDEO_TYPE_CAMERA;
287 if (copy_to_user(user_arg, &v, sizeof(v)))
296 if (copy_from_user(&v, user_arg, sizeof(v)))
298 DBG("VIDIOCSCHAN %d\n", v);
300 if (retval == 0 && v != 0)
306 /* image properties */
309 struct video_picture vp;
310 DBG("VIDIOCGPICT\n");
311 memset(&vp, 0, sizeof (struct video_picture));
312 vp.brightness = cam->gain << 8;
314 vp.palette = VIDEO_PALETTE_RGB24;
315 if (copy_to_user(user_arg, &vp, sizeof (struct video_picture)))
322 struct video_picture vp;
324 if (copy_from_user(&vp, user_arg, sizeof(vp))) {
329 DBG("VIDIOCSPICT depth = %d, pal = %d\n", vp.depth,
332 cam->gain = vp.brightness >> 8;
335 || vp.palette != VIDEO_PALETTE_RGB24)
341 /* get/set capture window */
344 struct video_window vw;
356 if (copy_to_user(user_arg, (void *)&vw, sizeof(vw)))
359 // I'm not sure what the deal with a capture window is, it is very poorly described
360 // in the doc. So I won't support it now.
367 struct video_window vw;
369 if (copy_from_user(&vw, user_arg, sizeof(vw))) {
374 DBG("VIDIOCSWIN %d x %d\n", vw.width, vw.height);
376 if ( vw.width != 320 || vw.height != 240 )
385 struct video_mbuf vm;
388 DBG("VIDIOCGMBUF\n");
389 memset(&vm, 0, sizeof (vm));
391 VICAM_MAX_FRAME_SIZE * VICAM_FRAMES;
392 vm.frames = VICAM_FRAMES;
393 for (i = 0; i < VICAM_FRAMES; i++)
394 vm.offsets[i] = VICAM_MAX_FRAME_SIZE * i;
396 if (copy_to_user(user_arg, (void *)&vm, sizeof(vm)))
404 struct video_mmap vm;
407 if (copy_from_user((void *)&vm, user_arg, sizeof(vm))) {
412 DBG("VIDIOCMCAPTURE frame=%d, height=%d, width=%d, format=%d.\n",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 /* the videodev_lock held above us protects us from
487 * simultaneous opens...for now. we probably shouldn't
488 * rely on this fact forever.
492 if (cam->open_count > 0) {
494 "vicam_open called on already opened camera");
499 cam->raw_image = kmalloc(VICAM_MAX_READ_SIZE, GFP_KERNEL);
500 if (!cam->raw_image) {
505 cam->framebuf = rvmalloc(VICAM_MAX_FRAME_SIZE * VICAM_FRAMES);
506 if (!cam->framebuf) {
507 kfree(cam->raw_image);
512 cam->cntrlbuf = kmalloc(PAGE_SIZE, GFP_KERNEL);
513 if (!cam->cntrlbuf) {
514 kfree(cam->raw_image);
515 rvfree(cam->framebuf, VICAM_MAX_FRAME_SIZE * VICAM_FRAMES);
520 // First upload firmware, then turn the camera on
522 if (!cam->is_initialized) {
523 initialize_camera(cam);
525 cam->is_initialized = 1;
528 set_camera_power(cam, 1);
530 cam->needsDummyRead = 1;
533 file->private_data = cam;
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) {
573 static void vicam_decode_color(const u8 *data, u8 *rgb)
575 /* vicam_decode_color - Convert from Vicam Y-Cr-Cb to RGB
576 * Copyright (C) 2002 Monroe Williams (monroe@pobox.com)
584 data += VICAM_HEADER_SIZE;
586 for( i = 0; i < 240; i++, data += 512 ) {
587 const int y = ( i * 242 ) / 240;
592 if ( y == 242 - 1 ) {
599 for ( j = 0; j < 320; j++, rgb += 3 ) {
600 const int x = ( j * 512 ) / 320;
601 const u8 * const src = &data[x];
603 if ( x == 512 - 1 ) {
607 Cr = ( src[prevX] - src[0] ) +
608 ( src[nextX] - src[0] );
611 Cb = ( src[prevY] - src[prevX + prevY] ) +
612 ( src[prevY] - src[nextX + prevY] ) +
613 ( src[nextY] - src[prevX + nextY] ) +
614 ( src[nextY] - src[nextX + nextY] );
617 Y = 1160 * ( src[0] + ( Cr / 2 ) - 16 );
625 if ( ( x ^ i ) & 1 ) {
630 rgb[0] = clamp( ( ( Y + ( 2017 * Cb ) ) +
631 500 ) / 900, 0, 255 );
632 rgb[1] = clamp( ( ( Y - ( 392 * Cb ) -
634 500 ) / 1000, 0, 255 );
635 rgb[2] = clamp( ( ( Y + ( 1594 * Cr ) ) +
636 500 ) / 1300, 0, 255 );
646 read_frame(struct vicam_camera *cam, int framenum)
648 unsigned char *request = cam->cntrlbuf;
653 if (cam->needsDummyRead) {
654 cam->needsDummyRead = 0;
655 read_frame(cam, framenum);
658 memset(request, 0, 16);
659 request[0] = cam->gain; // 0 = 0% gain, FF = 100% gain
661 request[1] = 0; // 512x242 capture
663 request[2] = 0x90; // the function of these two bytes
664 request[3] = 0x07; // is not yet understood
666 if (cam->shutter_speed > 60) {
669 ((-15631900 / cam->shutter_speed) + 260533) / 1000;
670 request[4] = realShutter & 0xFF;
671 request[5] = (realShutter >> 8) & 0xFF;
676 realShutter = 15600 / cam->shutter_speed - 1;
679 request[6] = realShutter & 0xFF;
680 request[7] = realShutter >> 8;
683 // Per John Markus Bjørndalen, byte at index 8 causes problems if it isn't 0
685 // bytes 9-15 do not seem to affect exposure or image quality
687 mutex_lock(&cam->cam_lock);
693 n = __send_control_msg(cam, 0x51, 0x80, 0, request, 16);
697 " Problem sending frame capture control message");
701 n = usb_bulk_msg(cam->udev,
702 usb_rcvbulkpipe(cam->udev, cam->bulkEndpoint),
704 512 * 242 + 128, &actual_length, 10000);
707 printk(KERN_ERR "Problem during bulk read of frame data: %d\n",
712 mutex_unlock(&cam->cam_lock);
716 vicam_read( struct file *file, char __user *buf, size_t count, loff_t *ppos )
718 struct vicam_camera *cam = file->private_data;
720 DBG("read %d bytes.\n", (int) count);
722 if (*ppos >= VICAM_MAX_FRAME_SIZE) {
729 vicam_decode_color(cam->raw_image,
731 0 * VICAM_MAX_FRAME_SIZE);
734 count = min_t(size_t, count, VICAM_MAX_FRAME_SIZE - *ppos);
736 if (copy_to_user(buf, &cam->framebuf[*ppos], count)) {
742 if (count == VICAM_MAX_FRAME_SIZE) {
751 vicam_mmap(struct file *file, struct vm_area_struct *vma)
753 // TODO: allocate the raw frame buffer if necessary
754 unsigned long page, pos;
755 unsigned long start = vma->vm_start;
756 unsigned long size = vma->vm_end-vma->vm_start;
757 struct vicam_camera *cam = file->private_data;
762 DBG("vicam_mmap: %ld\n", size);
764 /* We let mmap allocate as much as it wants because Linux was adding 2048 bytes
765 * to the size the application requested for mmap and it was screwing apps up.
766 if (size > VICAM_FRAMES*VICAM_MAX_FRAME_SIZE)
770 pos = (unsigned long)cam->framebuf;
772 page = vmalloc_to_pfn((void *)pos);
773 if (remap_pfn_range(vma, start, page, PAGE_SIZE, PAGE_SHARED))
778 if (size > PAGE_SIZE)
787 static const struct v4l2_file_operations vicam_fops = {
788 .owner = THIS_MODULE,
790 .release = vicam_close,
793 .ioctl = vicam_ioctl,
796 static struct video_device vicam_template = {
797 .name = "ViCam-based USB Camera",
799 .release = video_device_release_empty,
802 /* table of devices that work with this driver */
803 static struct usb_device_id vicam_table[] = {
804 {USB_DEVICE(USB_VICAM_VENDOR_ID, USB_VICAM_PRODUCT_ID)},
805 {USB_DEVICE(USB_COMPRO_VENDOR_ID, USB_COMPRO_PRODUCT_ID)},
806 {} /* Terminating entry */
809 MODULE_DEVICE_TABLE(usb, vicam_table);
811 static struct usb_driver vicam_driver = {
813 .probe = vicam_probe,
814 .disconnect = vicam_disconnect,
815 .id_table = vicam_table
820 * @intf: the interface
823 * Called by the usb core when a new device is connected that it thinks
824 * this driver might be interested in.
827 vicam_probe( struct usb_interface *intf, const struct usb_device_id *id)
829 struct usb_device *dev = interface_to_usbdev(intf);
830 int bulkEndpoint = 0;
831 const struct usb_host_interface *interface;
832 const struct usb_endpoint_descriptor *endpoint;
833 struct vicam_camera *cam;
835 printk(KERN_INFO "ViCam based webcam connected\n");
837 interface = intf->cur_altsetting;
839 DBG(KERN_DEBUG "Interface %d. has %u. endpoints!\n",
840 interface->desc.bInterfaceNumber, (unsigned) (interface->desc.bNumEndpoints));
841 endpoint = &interface->endpoint[0].desc;
843 if (usb_endpoint_is_bulk_in(endpoint)) {
844 /* we found a bulk in endpoint */
845 bulkEndpoint = endpoint->bEndpointAddress;
848 "No bulk in endpoint was found ?! (this is bad)\n");
852 kzalloc(sizeof (struct vicam_camera), GFP_KERNEL)) == NULL) {
854 "could not allocate kernel memory for vicam_camera struct\n");
859 cam->shutter_speed = 15;
861 mutex_init(&cam->cam_lock);
863 memcpy(&cam->vdev, &vicam_template, sizeof(vicam_template));
864 video_set_drvdata(&cam->vdev, cam);
867 cam->bulkEndpoint = bulkEndpoint;
869 if (video_register_device(&cam->vdev, VFL_TYPE_GRABBER, -1) < 0) {
871 printk(KERN_WARNING "video_register_device failed\n");
875 printk(KERN_INFO "ViCam webcam driver now controlling device %s\n",
876 video_device_node_name(&cam->vdev));
878 usb_set_intfdata (intf, cam);
884 vicam_disconnect(struct usb_interface *intf)
887 struct vicam_camera *cam = usb_get_intfdata (intf);
888 usb_set_intfdata (intf, NULL);
890 /* we must unregister the device before taking its
891 * cam_lock. This is because the video open call
892 * holds the same lock as video unregister. if we
893 * unregister inside of the cam_lock and open also
894 * uses the cam_lock, we get deadlock.
897 video_unregister_device(&cam->vdev);
899 /* stop the camera from being used */
901 mutex_lock(&cam->cam_lock);
903 /* mark the camera as gone */
907 /* the only thing left to do is synchronize with
908 * our close/release function on who should release
909 * the camera memory. if there are any users using the
910 * camera, it's their job. if there are no users,
914 open_count = cam->open_count;
916 mutex_unlock(&cam->cam_lock);
922 printk(KERN_DEBUG "ViCam-based WebCam disconnected\n");
931 DBG(KERN_INFO "ViCam-based WebCam driver startup\n");
932 retval = usb_register(&vicam_driver);
934 printk(KERN_WARNING "usb_register failed!\n");
942 "ViCam-based WebCam driver shutdown\n");
944 usb_deregister(&vicam_driver);
947 module_init(usb_vicam_init);
948 module_exit(usb_vicam_exit);
950 MODULE_AUTHOR(DRIVER_AUTHOR);
951 MODULE_DESCRIPTION(DRIVER_DESC);
952 MODULE_LICENSE("GPL");
953 MODULE_FIRMWARE("vicam/firmware.fw");