2 * Video4Linux Colour QuickCam driver
3 * Copyright 1997-2000 Philip Blundell <philb@gnu.org>
7 * parport=auto -- probe all parports (default)
8 * parport=0 -- parport0 becomes qcam1
9 * parport=2,0,1 -- parports 2,0,1 are tried in that order
11 * probe=0 -- do no probing, assume camera is present
12 * probe=1 -- use IEEE-1284 autoprobe data only (default)
13 * probe=2 -- probe aggressively for cameras
15 * force_rgb=1 -- force data format to RGB (default is BGR)
17 * The parport parameter controls which parports will be scanned.
18 * Scanning all parports causes some printers to print a garbage page.
19 * -- March 14, 1999 Billy Donahue <billy@escape.com>
21 * Fixed data format to BGR, added force_rgb parameter. Added missing
22 * parport_unregister_driver() on module removal.
23 * -- May 28, 2000 Claudio Matsuoka <claudio@conectiva.com>
26 #include <linux/module.h>
27 #include <linux/delay.h>
28 #include <linux/errno.h>
30 #include <linux/init.h>
31 #include <linux/kernel.h>
32 #include <linux/slab.h>
34 #include <linux/parport.h>
35 #include <linux/sched.h>
36 #include <linux/videodev.h>
37 #include <media/v4l2-common.h>
38 #include <linux/mutex.h>
40 #include <asm/uaccess.h>
43 struct video_device vdev;
44 struct pardevice *pdev;
45 struct parport *pport;
47 int ccd_width, ccd_height;
49 int contrast, brightness, whitebal;
51 unsigned int bidirectional;
58 /* The three possible QuickCam modes */
59 #define QC_MILLIONS 0x18
60 #define QC_BILLIONS 0x10
61 #define QC_THOUSANDS 0x08 /* with VIDEC compression (not supported) */
63 /* The three possible decimations */
64 #define QC_DECIMATION_1 0
65 #define QC_DECIMATION_2 2
66 #define QC_DECIMATION_4 4
68 #define BANNER "Colour QuickCam for Video4Linux v0.05"
70 static int parport[MAX_CAMS] = { [1 ... MAX_CAMS-1] = -1 };
72 static int force_rgb = 0;
73 static int video_nr = -1;
75 static inline void qcam_set_ack(struct qcam_device *qcam, unsigned int i)
77 /* note: the QC specs refer to the PCAck pin by voltage, not
78 software level. PC ports have builtin inverters. */
79 parport_frob_control(qcam->pport, 8, i?8:0);
82 static inline unsigned int qcam_ready1(struct qcam_device *qcam)
84 return (parport_read_status(qcam->pport) & 0x8)?1:0;
87 static inline unsigned int qcam_ready2(struct qcam_device *qcam)
89 return (parport_read_data(qcam->pport) & 0x1)?1:0;
92 static unsigned int qcam_await_ready1(struct qcam_device *qcam,
95 unsigned long oldjiffies = jiffies;
98 for (oldjiffies = jiffies; (jiffies - oldjiffies) < msecs_to_jiffies(40); )
99 if (qcam_ready1(qcam) == value)
102 /* If the camera didn't respond within 1/25 second, poll slowly
104 for (i = 0; i < 50; i++)
106 if (qcam_ready1(qcam) == value)
108 msleep_interruptible(100);
111 /* Probably somebody pulled the plug out. Not much we can do. */
112 printk(KERN_ERR "c-qcam: ready1 timeout (%d) %x %x\n", value,
113 parport_read_status(qcam->pport),
114 parport_read_control(qcam->pport));
118 static unsigned int qcam_await_ready2(struct qcam_device *qcam, int value)
120 unsigned long oldjiffies = jiffies;
123 for (oldjiffies = jiffies; (jiffies - oldjiffies) < msecs_to_jiffies(40); )
124 if (qcam_ready2(qcam) == value)
127 /* If the camera didn't respond within 1/25 second, poll slowly
129 for (i = 0; i < 50; i++)
131 if (qcam_ready2(qcam) == value)
133 msleep_interruptible(100);
136 /* Probably somebody pulled the plug out. Not much we can do. */
137 printk(KERN_ERR "c-qcam: ready2 timeout (%d) %x %x %x\n", value,
138 parport_read_status(qcam->pport),
139 parport_read_control(qcam->pport),
140 parport_read_data(qcam->pport));
144 static int qcam_read_data(struct qcam_device *qcam)
147 qcam_set_ack(qcam, 0);
148 if (qcam_await_ready1(qcam, 1)) return -1;
149 idata = parport_read_status(qcam->pport) & 0xf0;
150 qcam_set_ack(qcam, 1);
151 if (qcam_await_ready1(qcam, 0)) return -1;
152 idata |= (parport_read_status(qcam->pport) >> 4);
156 static int qcam_write_data(struct qcam_device *qcam, unsigned int data)
159 parport_write_data(qcam->pport, data);
160 idata = qcam_read_data(qcam);
163 printk(KERN_WARNING "cqcam: sent %x but received %x\n", data,
170 static inline int qcam_set(struct qcam_device *qcam, unsigned int cmd, unsigned int data)
172 if (qcam_write_data(qcam, cmd))
174 if (qcam_write_data(qcam, data))
179 static inline int qcam_get(struct qcam_device *qcam, unsigned int cmd)
181 if (qcam_write_data(qcam, cmd))
183 return qcam_read_data(qcam);
186 static int qc_detect(struct qcam_device *qcam)
188 unsigned int stat, ostat, i, count = 0;
190 /* The probe routine below is not very reliable. The IEEE-1284
191 probe takes precedence. */
192 /* XXX Currently parport provides no way to distinguish between
193 "the IEEE probe was not done" and "the probe was done, but
194 no device was found". Fix this one day. */
195 if (qcam->pport->probe_info[0].class == PARPORT_CLASS_MEDIA
196 && qcam->pport->probe_info[0].model
197 && !strcmp(qcam->pdev->port->probe_info[0].model,
198 "Color QuickCam 2.0")) {
199 printk(KERN_DEBUG "QuickCam: Found by IEEE1284 probe.\n");
206 parport_write_control(qcam->pport, 0xc);
208 /* look for a heartbeat */
209 ostat = stat = parport_read_status(qcam->pport);
210 for (i=0; i<250; i++)
213 stat = parport_read_status(qcam->pport);
216 if (++count >= 3) return 1;
221 /* Reset the camera and try again */
222 parport_write_control(qcam->pport, 0xc);
223 parport_write_control(qcam->pport, 0x8);
225 parport_write_control(qcam->pport, 0xc);
229 ostat = stat = parport_read_status(qcam->pport);
230 for (i=0; i<250; i++)
233 stat = parport_read_status(qcam->pport);
236 if (++count >= 3) return 1;
241 /* no (or flatline) camera, give up */
245 static void qc_reset(struct qcam_device *qcam)
247 parport_write_control(qcam->pport, 0xc);
248 parport_write_control(qcam->pport, 0x8);
250 parport_write_control(qcam->pport, 0xc);
254 /* Reset the QuickCam and program for brightness, contrast,
255 * white-balance, and resolution. */
257 static void qc_setup(struct qcam_device *q)
261 /* Set the brightness. */
262 qcam_set(q, 11, q->brightness);
264 /* Set the height and width. These refer to the actual
265 CCD area *before* applying the selected decimation. */
266 qcam_set(q, 17, q->ccd_height);
267 qcam_set(q, 19, q->ccd_width / 2);
269 /* Set top and left. */
270 qcam_set(q, 0xd, q->top);
271 qcam_set(q, 0xf, q->left);
273 /* Set contrast and white balance. */
274 qcam_set(q, 0x19, q->contrast);
275 qcam_set(q, 0x1f, q->whitebal);
281 /* Read some bytes from the camera and put them in the buffer.
282 nbytes should be a multiple of 3, because bidirectional mode gives
283 us three bytes at a time. */
285 static unsigned int qcam_read_bytes(struct qcam_device *q, unsigned char *buf, unsigned int nbytes)
287 unsigned int bytes = 0;
290 if (q->bidirectional)
292 /* It's a bidirectional port */
293 while (bytes < nbytes)
295 unsigned int lo1, hi1, lo2, hi2;
296 unsigned char r, g, b;
298 if (qcam_await_ready2(q, 1)) return bytes;
299 lo1 = parport_read_data(q->pport) >> 1;
300 hi1 = ((parport_read_status(q->pport) >> 3) & 0x1f) ^ 0x10;
302 if (qcam_await_ready2(q, 0)) return bytes;
303 lo2 = parport_read_data(q->pport) >> 1;
304 hi2 = ((parport_read_status(q->pport) >> 3) & 0x1f) ^ 0x10;
306 r = (lo1 | ((hi1 & 1)<<7));
307 g = ((hi1 & 0x1e)<<3) | ((hi2 & 0x1e)>>1);
308 b = (lo2 | ((hi2 & 1)<<7));
322 /* It's a unidirectional port */
323 int i = 0, n = bytes;
324 unsigned char rgb[3];
326 while (bytes < nbytes)
330 if (qcam_await_ready1(q, 1)) return bytes;
331 hi = (parport_read_status(q->pport) & 0xf0);
333 if (qcam_await_ready1(q, 0)) return bytes;
334 lo = (parport_read_status(q->pport) & 0xf0);
337 rgb[(i = bytes++ % 3)] = (hi | (lo >> 4)) ^ 0x88;
361 static long qc_capture(struct qcam_device *q, char __user *buf, unsigned long len)
363 unsigned lines, pixelsperline, bitsperxfer;
364 unsigned int is_bi_dir = q->bidirectional;
365 size_t wantlen, outptr = 0;
368 if (!access_ok(VERIFY_WRITE, buf, len))
371 /* Wait for camera to become ready */
374 int i = qcam_get(q, 41);
385 if (qcam_set(q, 7, (q->mode | (is_bi_dir?1:0)) + 1))
389 pixelsperline = q->width;
390 bitsperxfer = (is_bi_dir) ? 24 : 8;
394 /* Turn the port around */
395 parport_data_reverse(q->pport);
398 if (qcam_await_ready1(q, 1)) {
403 if (qcam_await_ready1(q, 0)) {
409 wantlen = lines * pixelsperline * 24 / 8;
414 s = (wantlen > BUFSZ)?BUFSZ:wantlen;
415 t = qcam_read_bytes(q, tmpbuf, s);
418 size_t sz = len - outptr;
420 if (__copy_to_user(buf+outptr, tmpbuf, sz))
434 printk("qcam: short read.\n");
436 parport_data_forward(q->pport);
445 l = qcam_read_bytes(q, tmpbuf, 3);
447 } while (l && (tmpbuf[0] == 0x7e || tmpbuf[1] == 0x7e || tmpbuf[2] == 0x7e));
449 if (tmpbuf[0] != 0xe || tmpbuf[1] != 0x0 || tmpbuf[2] != 0xf)
450 printk("qcam: bad EOF\n");
452 if (tmpbuf[0] != 0xf || tmpbuf[1] != 0x0 || tmpbuf[2] != 0xe)
453 printk("qcam: bad EOF\n");
456 if (qcam_await_ready1(q, 1))
458 printk("qcam: no ack after EOF\n");
459 parport_data_forward(q->pport);
463 parport_data_forward(q->pport);
466 if (qcam_await_ready1(q, 0))
468 printk("qcam: no ack to port turnaround\n");
477 l = qcam_read_bytes(q, tmpbuf, 1);
479 } while (l && tmpbuf[0] == 0x7e);
480 l = qcam_read_bytes(q, tmpbuf+1, 2);
482 if (tmpbuf[0] != 0xe || tmpbuf[1] != 0x0 || tmpbuf[2] != 0xf)
483 printk("qcam: bad EOF\n");
485 if (tmpbuf[0] != 0xf || tmpbuf[1] != 0x0 || tmpbuf[2] != 0xe)
486 printk("qcam: bad EOF\n");
490 qcam_write_data(q, 0);
495 * Video4linux interfacing
498 static int qcam_do_ioctl(struct inode *inode, struct file *file,
499 unsigned int cmd, void *arg)
501 struct video_device *dev = video_devdata(file);
502 struct qcam_device *qcam=(struct qcam_device *)dev;
508 struct video_capability *b = arg;
509 strcpy(b->name, "Quickcam");
510 b->type = VID_TYPE_CAPTURE|VID_TYPE_SCALES;
521 struct video_channel *v = arg;
526 /* Good question.. its composite or SVHS so.. */
527 v->type = VIDEO_TYPE_CAMERA;
528 strcpy(v->name, "Camera");
533 struct video_channel *v = arg;
540 struct video_tuner *v = arg;
543 memset(v,0,sizeof(*v));
544 strcpy(v->name, "Format");
545 v->mode = VIDEO_MODE_AUTO;
550 struct video_tuner *v = arg;
553 if(v->mode!=VIDEO_MODE_AUTO)
559 struct video_picture *p = arg;
562 p->brightness=qcam->brightness<<8;
563 p->contrast=qcam->contrast<<8;
564 p->whiteness=qcam->whitebal<<8;
566 p->palette=VIDEO_PALETTE_RGB24;
571 struct video_picture *p = arg;
576 if (p->depth != 24 || p->palette != VIDEO_PALETTE_RGB24)
580 * Now load the camera.
582 qcam->brightness = p->brightness>>8;
583 qcam->contrast = p->contrast>>8;
584 qcam->whitebal = p->whiteness>>8;
586 mutex_lock(&qcam->lock);
587 parport_claim_or_block(qcam->pdev);
589 parport_release(qcam->pdev);
590 mutex_unlock(&qcam->lock);
595 struct video_window *vw = arg;
601 if(vw->height<60||vw->height>240)
603 if(vw->width<80||vw->width>320)
608 qcam->mode = QC_DECIMATION_4;
610 if(vw->width>=160 && vw->height>=120)
614 qcam->mode = QC_DECIMATION_2;
616 if(vw->width>=320 && vw->height>=240)
620 qcam->mode = QC_DECIMATION_1;
622 qcam->mode |= QC_MILLIONS;
624 if(vw->width>=640 && vw->height>=480)
628 qcam->mode = QC_BILLIONS | QC_DECIMATION_1;
631 /* Ok we figured out what to use from our
633 mutex_lock(&qcam->lock);
634 parport_claim_or_block(qcam->pdev);
636 parport_release(qcam->pdev);
637 mutex_unlock(&qcam->lock);
642 struct video_window *vw = arg;
643 memset(vw, 0, sizeof(*vw));
644 vw->width=qcam->width;
645 vw->height=qcam->height;
664 static int qcam_ioctl(struct inode *inode, struct file *file,
665 unsigned int cmd, unsigned long arg)
667 return video_usercopy(inode, file, cmd, arg, qcam_do_ioctl);
670 static ssize_t qcam_read(struct file *file, char __user *buf,
671 size_t count, loff_t *ppos)
673 struct video_device *v = video_devdata(file);
674 struct qcam_device *qcam=(struct qcam_device *)v;
677 mutex_lock(&qcam->lock);
678 parport_claim_or_block(qcam->pdev);
679 /* Probably should have a semaphore against multiple users */
680 len = qc_capture(qcam, buf,count);
681 parport_release(qcam->pdev);
682 mutex_unlock(&qcam->lock);
686 /* video device template */
687 static const struct file_operations qcam_fops = {
688 .owner = THIS_MODULE,
689 .open = video_exclusive_open,
690 .release = video_exclusive_release,
692 .compat_ioctl = v4l_compat_ioctl32,
697 static struct video_device qcam_template=
699 .owner = THIS_MODULE,
700 .name = "Colour QuickCam",
701 .type = VID_TYPE_CAPTURE,
705 /* Initialize the QuickCam driver control structure. */
707 static struct qcam_device *qcam_init(struct parport *port)
709 struct qcam_device *q;
711 q = kmalloc(sizeof(struct qcam_device), GFP_KERNEL);
716 q->pdev = parport_register_device(port, "c-qcam", NULL, NULL,
719 q->bidirectional = (q->pport->modes & PARPORT_MODE_TRISTATE)?1:0;
723 printk(KERN_ERR "c-qcam: couldn't register for %s.\n",
729 memcpy(&q->vdev, &qcam_template, sizeof(qcam_template));
731 mutex_init(&q->lock);
732 q->width = q->ccd_width = 320;
733 q->height = q->ccd_height = 240;
734 q->mode = QC_MILLIONS | QC_DECIMATION_1;
743 static struct qcam_device *qcams[MAX_CAMS];
744 static unsigned int num_cams = 0;
746 static int init_cqcam(struct parport *port)
748 struct qcam_device *qcam;
750 if (parport[0] != -1)
752 /* The user gave specific instructions */
754 for (i = 0; i < MAX_CAMS && parport[i] != -1; i++)
756 if (parport[0] == port->number)
763 if (num_cams == MAX_CAMS)
766 qcam = qcam_init(port);
770 parport_claim_or_block(qcam->pdev);
774 if (probe && qc_detect(qcam)==0)
776 parport_release(qcam->pdev);
777 parport_unregister_device(qcam->pdev);
784 parport_release(qcam->pdev);
786 if (video_register_device(&qcam->vdev, VFL_TYPE_GRABBER, video_nr)==-1)
788 printk(KERN_ERR "Unable to register Colour QuickCam on %s\n",
790 parport_unregister_device(qcam->pdev);
795 printk(KERN_INFO "video%d: Colour QuickCam found on %s\n",
796 qcam->vdev.minor, qcam->pport->name);
798 qcams[num_cams++] = qcam;
803 static void close_cqcam(struct qcam_device *qcam)
805 video_unregister_device(&qcam->vdev);
806 parport_unregister_device(qcam->pdev);
810 static void cq_attach(struct parport *port)
815 static void cq_detach(struct parport *port)
817 /* Write this some day. */
820 static struct parport_driver cqcam_driver = {
826 static int __init cqcam_init (void)
830 return parport_register_driver(&cqcam_driver);
833 static void __exit cqcam_cleanup (void)
837 for (i = 0; i < num_cams; i++)
838 close_cqcam(qcams[i]);
840 parport_unregister_driver(&cqcam_driver);
843 MODULE_AUTHOR("Philip Blundell <philb@gnu.org>");
844 MODULE_DESCRIPTION(BANNER);
845 MODULE_LICENSE("GPL");
847 /* FIXME: parport=auto would never have worked, surely? --RR */
848 MODULE_PARM_DESC(parport ,"parport=<auto|n[,n]...> for port detection method\n\
849 probe=<0|1|2> for camera detection method\n\
850 force_rgb=<0|1> for RGB data format (default BGR)");
851 module_param_array(parport, int, NULL, 0);
852 module_param(probe, int, 0);
853 module_param(force_rgb, bool, 0);
854 module_param(video_nr, int, 0);
856 module_init(cqcam_init);
857 module_exit(cqcam_cleanup);