2 * cpia_pp CPiA Parallel Port driver
4 * Supports CPiA based parallel port Video Camera's.
6 * (C) Copyright 1999 Bas Huisman <bhuism@cs.utwente.nl>
7 * (C) Copyright 1999-2000 Scott J. Bertin <sbertin@securenym.net>,
8 * (C) Copyright 1999-2000 Peter Pregler <Peter_Pregler@email.com>
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
13 * (at your option) any later version.
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., 675 Mass Ave, Cambridge, MA 02139, USA.
25 /* define _CPIA_DEBUG_ for verbose debug output (see cpia.h) */
26 /* #define _CPIA_DEBUG_ 1 */
28 #include <linux/config.h>
30 #include <linux/module.h>
31 #include <linux/init.h>
33 #include <linux/kernel.h>
34 #include <linux/parport.h>
35 #include <linux/interrupt.h>
36 #include <linux/delay.h>
37 #include <linux/workqueue.h>
38 #include <linux/smp_lock.h>
39 #include <linux/sched.h>
41 #include <linux/kmod.h>
43 /* #define _CPIA_DEBUG_ define for verbose debug output */
46 static int cpia_pp_open(void *privdata);
47 static int cpia_pp_registerCallback(void *privdata, void (*cb) (void *cbdata),
49 static int cpia_pp_transferCmd(void *privdata, u8 *command, u8 *data);
50 static int cpia_pp_streamStart(void *privdata);
51 static int cpia_pp_streamStop(void *privdata);
52 static int cpia_pp_streamRead(void *privdata, u8 *buffer, int noblock);
53 static int cpia_pp_close(void *privdata);
56 #define ABOUT "Parallel port driver for Vision CPiA based cameras"
58 #define PACKET_LENGTH 8
60 /* Magic numbers for defining port-device mappings */
61 #define PPCPIA_PARPORT_UNSPEC -4
62 #define PPCPIA_PARPORT_AUTO -3
63 #define PPCPIA_PARPORT_OFF -2
64 #define PPCPIA_PARPORT_NONE -1
67 static int parport_nr[PARPORT_MAX] = {[0 ... PARPORT_MAX - 1] = PPCPIA_PARPORT_UNSPEC};
68 static char *parport[PARPORT_MAX] = {NULL,};
70 MODULE_AUTHOR("B. Huisman <bhuism@cs.utwente.nl> & Peter Pregler <Peter_Pregler@email.com>");
71 MODULE_DESCRIPTION("Parallel port driver for Vision CPiA based cameras");
72 MODULE_LICENSE("GPL");
74 module_param_array(parport, charp, NULL, 0);
75 MODULE_PARM_DESC(parport, "'auto' or a list of parallel port numbers. Just like lp.");
77 static int parport_nr[PARPORT_MAX] __initdata =
78 {[0 ... PARPORT_MAX - 1] = PPCPIA_PARPORT_UNSPEC};
79 static int parport_ptr = 0;
83 struct pardevice *pdev;
85 struct work_struct cb_task;
87 wait_queue_head_t wq_stream;
88 /* image state flags */
89 int image_ready; /* we got an interrupt */
90 int image_complete; /* we have seen 4 EOI */
92 int streaming; /* we are in streaming mode */
96 static struct cpia_camera_ops cpia_pp_ops =
99 cpia_pp_registerCallback,
109 static LIST_HEAD(cam_list);
110 static spinlock_t cam_list_lock_pp;
113 static void cpia_parport_enable_irq( struct parport *port ) {
114 parport_enable_irq(port);
119 static void cpia_parport_disable_irq( struct parport *port ) {
120 parport_disable_irq(port);
125 /* Special CPiA PPC modes: These are invoked by using the 1284 Extensibility
126 * Link Flag during negotiation */
127 #define UPLOAD_FLAG 0x08
128 #define NIBBLE_TRANSFER 0x01
129 #define ECP_TRANSFER 0x03
131 #define PARPORT_CHUNK_SIZE PAGE_SIZE
134 /****************************************************************************
136 * CPiA-specific low-level parport functions for nibble uploads
138 ***************************************************************************/
139 /* CPiA nonstandard "Nibble" mode (no nDataAvail signal after each byte). */
140 /* The standard kernel parport_ieee1284_read_nibble() fails with the CPiA... */
142 static size_t cpia_read_nibble (struct parport *port,
143 void *buffer, size_t len,
146 /* adapted verbatim, with one change, from
147 parport_ieee1284_read_nibble() in drivers/parport/ieee1284-ops.c */
149 unsigned char *buf = buffer;
151 unsigned char byte = 0;
153 len *= 2; /* in nibbles */
154 for (i=0; i < len; i++) {
155 unsigned char nibble;
157 /* The CPiA firmware suppresses the use of nDataAvail (nFault LO)
158 * after every second nibble to signal that more
159 * data is available. (the total number of Bytes that
160 * should be sent is known; if too few are received, an error
161 * will be recorded after a timeout).
162 * This is incompatible with parport_ieee1284_read_nibble(),
163 * which expects to find nFault LO after every second nibble.
166 /* Solution: modify cpia_read_nibble to only check for
167 * nDataAvail before the first nibble is sent.
170 /* Does the error line indicate end of data? */
171 if (((i /*& 1*/) == 0) &&
172 (parport_read_status(port) & PARPORT_STATUS_ERROR)) {
173 port->physport->ieee1284.phase = IEEE1284_PH_HBUSY_DNA;
174 DBG("%s: No more nibble data (%d bytes)\n",
177 /* Go to reverse idle phase. */
178 parport_frob_control (port,
179 PARPORT_CONTROL_AUTOFD,
180 PARPORT_CONTROL_AUTOFD);
181 port->physport->ieee1284.phase = IEEE1284_PH_REV_IDLE;
185 /* Event 7: Set nAutoFd low. */
186 parport_frob_control (port,
187 PARPORT_CONTROL_AUTOFD,
188 PARPORT_CONTROL_AUTOFD);
190 /* Event 9: nAck goes low. */
191 port->ieee1284.phase = IEEE1284_PH_REV_DATA;
192 if (parport_wait_peripheral (port,
193 PARPORT_STATUS_ACK, 0)) {
194 /* Timeout -- no more data? */
195 DBG("%s: Nibble timeout at event 9 (%d bytes)\n",
197 parport_frob_control (port, PARPORT_CONTROL_AUTOFD, 0);
203 nibble = parport_read_status (port) >> 3;
205 if ((nibble & 0x10) == 0)
209 /* Event 10: Set nAutoFd high. */
210 parport_frob_control (port, PARPORT_CONTROL_AUTOFD, 0);
212 /* Event 11: nAck goes high. */
213 if (parport_wait_peripheral (port,
215 PARPORT_STATUS_ACK)) {
216 /* Timeout -- no more data? */
217 DBG("%s: Nibble timeout at event 11\n",
230 i /= 2; /* i is now in bytes */
233 /* Read the last nibble without checking data avail. */
234 port = port->physport;
235 if (parport_read_status (port) & PARPORT_STATUS_ERROR)
236 port->ieee1284.phase = IEEE1284_PH_HBUSY_DNA;
238 port->ieee1284.phase = IEEE1284_PH_HBUSY_DAVAIL;
244 /* CPiA nonstandard "Nibble Stream" mode (2 nibbles per cycle, instead of 1)
245 * (See CPiA Data sheet p. 31)
247 * "Nibble Stream" mode used by CPiA for uploads to non-ECP ports is a
248 * nonstandard variant of nibble mode which allows the same (mediocre)
249 * data flow of 8 bits per cycle as software-enabled ECP by TRISTATE-capable
250 * parallel ports, but works also for non-TRISTATE-capable ports.
251 * (Standard nibble mode only send 4 bits per cycle)
255 static size_t cpia_read_nibble_stream(struct parport *port,
256 void *buffer, size_t len,
260 unsigned char *buf = buffer;
263 for (i=0; i < len; i++) {
264 unsigned char nibble[2], byte = 0;
267 /* Image Data is complete when 4 consecutive EOI bytes (0xff) are seen */
271 /* Event 7: Set nAutoFd low. */
272 parport_frob_control (port,
273 PARPORT_CONTROL_AUTOFD,
274 PARPORT_CONTROL_AUTOFD);
276 /* Event 9: nAck goes low. */
277 port->ieee1284.phase = IEEE1284_PH_REV_DATA;
278 if (parport_wait_peripheral (port,
279 PARPORT_STATUS_ACK, 0)) {
280 /* Timeout -- no more data? */
281 DBG("%s: Nibble timeout at event 9 (%d bytes)\n",
283 parport_frob_control (port, PARPORT_CONTROL_AUTOFD, 0);
287 /* Read lower nibble */
288 nibble[0] = parport_read_status (port) >>3;
290 /* Event 10: Set nAutoFd high. */
291 parport_frob_control (port, PARPORT_CONTROL_AUTOFD, 0);
293 /* Event 11: nAck goes high. */
294 if (parport_wait_peripheral (port,
296 PARPORT_STATUS_ACK)) {
297 /* Timeout -- no more data? */
298 DBG("%s: Nibble timeout at event 11\n",
303 /* Read upper nibble */
304 nibble[1] = parport_read_status (port) >>3;
306 /* reassemble the byte */
307 for (j = 0; j < 2 ; j++ ) {
309 if ((nibble[j] & 0x10) == 0)
313 byte = (nibble[0] |(nibble[1] << 4));
324 /****************************************************************************
328 ***************************************************************************/
329 static void EndTransferMode(struct pp_cam_entry *cam)
331 parport_negotiate(cam->port, IEEE1284_MODE_COMPAT);
334 /****************************************************************************
338 ***************************************************************************/
339 static int ForwardSetup(struct pp_cam_entry *cam)
343 /* The CPiA uses ECP protocol for Downloads from the Host to the camera.
344 * This will be software-emulated if ECP hardware is not present
347 /* the usual camera maximum response time is 10ms, but after receiving
348 * some commands, it needs up to 40ms. (Data Sheet p. 32)*/
350 for(retry = 0; retry < 4; ++retry) {
351 if(!parport_negotiate(cam->port, IEEE1284_MODE_ECP)) {
357 DBG("Unable to negotiate IEEE1284 ECP Download mode\n");
362 /****************************************************************************
366 ***************************************************************************/
367 static int ReverseSetup(struct pp_cam_entry *cam, int extensibility)
370 int upload_mode, mode = IEEE1284_MODE_ECP;
371 int transfer_mode = ECP_TRANSFER;
373 if (!(cam->port->modes & PARPORT_MODE_ECP) &&
374 !(cam->port->modes & PARPORT_MODE_TRISTATE)) {
375 mode = IEEE1284_MODE_NIBBLE;
376 transfer_mode = NIBBLE_TRANSFER;
380 if(extensibility) mode = UPLOAD_FLAG|transfer_mode|IEEE1284_EXT_LINK;
382 /* the usual camera maximum response time is 10ms, but after
383 * receiving some commands, it needs up to 40ms. */
385 for(retry = 0; retry < 4; ++retry) {
386 if(!parport_negotiate(cam->port, mode)) {
393 DBG("Unable to negotiate upload extensibility mode\n");
395 DBG("Unable to negotiate upload mode\n");
398 if(extensibility) cam->port->ieee1284.mode = upload_mode;
402 /****************************************************************************
406 ***************************************************************************/
407 static int WritePacket(struct pp_cam_entry *cam, const u8 *packet, size_t size)
412 if (packet == NULL) {
415 if (ForwardSetup(cam)) {
416 DBG("Write failed in setup\n");
419 size_written = parport_write(cam->port, packet, size);
420 if(size_written != size) {
421 DBG("Write failed, wrote %d/%d\n", size_written, size);
424 EndTransferMode(cam);
428 /****************************************************************************
432 ***************************************************************************/
433 static int ReadPacket(struct pp_cam_entry *cam, u8 *packet, size_t size)
437 if (packet == NULL) {
440 if (ReverseSetup(cam, 0)) {
444 /* support for CPiA variant nibble reads */
445 if(cam->port->ieee1284.mode == IEEE1284_MODE_NIBBLE) {
446 if(cpia_read_nibble(cam->port, packet, size, 0) != size)
449 if(parport_read(cam->port, packet, size) != size)
452 EndTransferMode(cam);
456 /****************************************************************************
458 * cpia_pp_streamStart
460 ***************************************************************************/
461 static int cpia_pp_streamStart(void *privdata)
463 struct pp_cam_entry *cam = privdata;
467 //if (ReverseSetup(cam,1)) return -EIO;
468 if(cam->stream_irq) cpia_parport_enable_irq(cam->port);
472 /****************************************************************************
476 ***************************************************************************/
477 static int cpia_pp_streamStop(void *privdata)
479 struct pp_cam_entry *cam = privdata;
483 cpia_parport_disable_irq(cam->port);
484 //EndTransferMode(cam);
489 /****************************************************************************
493 ***************************************************************************/
494 static int cpia_pp_read(struct parport *port, u8 *buffer, int len)
498 /* support for CPiA variant "nibble stream" reads */
499 if(port->ieee1284.mode == IEEE1284_MODE_NIBBLE)
500 bytes_read = cpia_read_nibble_stream(port,buffer,len,0);
503 for(bytes_read=0; bytes_read<len; bytes_read += new_bytes) {
504 new_bytes = parport_read(port, buffer+bytes_read,
506 if(new_bytes < 0) break;
512 static int cpia_pp_streamRead(void *privdata, u8 *buffer, int noblock)
514 struct pp_cam_entry *cam = privdata;
516 int i, endseen, block_size, new_bytes;
519 DBG("Internal driver error: cam is NULL\n");
523 DBG("Internal driver error: buffer is NULL\n");
526 //if(cam->streaming) DBG("%d / %d\n", cam->image_ready, noblock);
527 if( cam->stream_irq ) {
528 DBG("%d\n", cam->image_ready);
531 cam->image_complete=0;
532 if (0/*cam->streaming*/) {
533 if(!cam->image_ready) {
534 if(noblock) return -EWOULDBLOCK;
535 interruptible_sleep_on(&cam->wq_stream);
536 if( signal_pending(current) ) return -EINTR;
537 DBG("%d\n", cam->image_ready);
540 if (ReverseSetup(cam, 1)) {
541 DBG("unable to ReverseSetup\n");
546 block_size = PARPORT_CHUNK_SIZE;
547 while( !cam->image_complete ) {
550 new_bytes = cpia_pp_read(cam->port, buffer, block_size );
551 if( new_bytes <= 0 ) {
555 while(++i<new_bytes && endseen<4) {
565 cam->image_complete=1;
568 if( CPIA_MAX_IMAGE_SIZE-read_bytes <= PARPORT_CHUNK_SIZE ) {
569 block_size=CPIA_MAX_IMAGE_SIZE-read_bytes;
572 EndTransferMode(cam);
573 return cam->image_complete ? read_bytes : -EIO;
575 /****************************************************************************
577 * cpia_pp_transferCmd
579 ***************************************************************************/
580 static int cpia_pp_transferCmd(void *privdata, u8 *command, u8 *data)
585 struct pp_cam_entry *cam = privdata;
588 DBG("Internal driver error: cam is NULL\n");
591 if(command == NULL) {
592 DBG("Internal driver error: command is NULL\n");
595 databytes = (((int)command[7])<<8) | command[6];
596 if ((err = WritePacket(cam, command, PACKET_LENGTH)) < 0) {
597 DBG("Error writing command\n");
600 if(command[0] == DATA_IN) {
603 DBG("Internal driver error: data is NULL\n");
606 if((err = ReadPacket(cam, buffer, 8)) < 0) {
607 DBG("Error reading command result\n");
610 memcpy(data, buffer, databytes);
611 } else if(command[0] == DATA_OUT) {
614 DBG("Internal driver error: data is NULL\n");
617 if((err=WritePacket(cam, data, databytes)) < 0){
618 DBG("Error writing command data\n");
624 DBG("Unexpected first byte of command: %x\n", command[0]);
630 /****************************************************************************
634 ***************************************************************************/
635 static int cpia_pp_open(void *privdata)
637 struct pp_cam_entry *cam = (struct pp_cam_entry *)privdata;
642 if(cam->open_count == 0) {
643 if (parport_claim(cam->pdev)) {
644 DBG("failed to claim the port\n");
647 parport_negotiate(cam->port, IEEE1284_MODE_COMPAT);
648 parport_data_forward(cam->port);
649 parport_write_control(cam->port, PARPORT_CONTROL_SELECT);
651 parport_write_control(cam->port,
652 PARPORT_CONTROL_SELECT
653 | PARPORT_CONTROL_INIT);
661 /****************************************************************************
663 * cpia_pp_registerCallback
665 ***************************************************************************/
666 static int cpia_pp_registerCallback(void *privdata, void (*cb)(void *cbdata), void *cbdata)
668 struct pp_cam_entry *cam = privdata;
671 if(cam->port->irq != PARPORT_IRQ_NONE) {
672 INIT_WORK(&cam->cb_task, cb, cbdata);
679 /****************************************************************************
683 ***************************************************************************/
684 static int cpia_pp_close(void *privdata)
686 struct pp_cam_entry *cam = privdata;
687 if (--cam->open_count == 0) {
688 parport_release(cam->pdev);
693 /****************************************************************************
697 ***************************************************************************/
698 static int cpia_pp_register(struct parport *port)
700 struct pardevice *pdev = NULL;
701 struct pp_cam_entry *cam;
702 struct cam_data *cpia;
704 if (!(port->modes & PARPORT_MODE_PCSPP)) {
705 LOG("port is not supported by CPiA driver\n");
709 cam = kmalloc(sizeof(struct pp_cam_entry), GFP_KERNEL);
711 LOG("failed to allocate camera structure\n");
714 memset(cam,0,sizeof(struct pp_cam_entry));
716 pdev = parport_register_device(port, "cpia_pp", NULL, NULL,
720 LOG("failed to parport_register_device\n");
727 init_waitqueue_head(&cam->wq_stream);
732 if((cpia = cpia_register_camera(&cpia_pp_ops, cam)) == NULL) {
733 LOG("failed to cpia_register_camera\n");
734 parport_unregister_device(pdev);
738 spin_lock( &cam_list_lock_pp );
739 list_add( &cpia->cam_data_list, &cam_list );
740 spin_unlock( &cam_list_lock_pp );
745 static void cpia_pp_detach (struct parport *port)
747 struct list_head *tmp;
748 struct cam_data *cpia = NULL;
749 struct pp_cam_entry *cam;
751 spin_lock( &cam_list_lock_pp );
752 list_for_each (tmp, &cam_list) {
753 cpia = list_entry(tmp, struct cam_data, cam_data_list);
754 cam = (struct pp_cam_entry *) cpia->lowlevel_data;
755 if (cam && cam->port->number == port->number) {
756 list_del(&cpia->cam_data_list);
761 spin_unlock( &cam_list_lock_pp );
764 DBG("cpia_pp_detach failed to find cam_data in cam_list\n");
768 cam = (struct pp_cam_entry *) cpia->lowlevel_data;
769 cpia_unregister_camera(cpia);
770 if(cam->open_count > 0)
772 parport_unregister_device(cam->pdev);
773 cpia->lowlevel_data = NULL;
777 static void cpia_pp_attach (struct parport *port)
781 switch (parport_nr[0])
783 case PPCPIA_PARPORT_UNSPEC:
784 case PPCPIA_PARPORT_AUTO:
785 if (port->probe_info[0].class != PARPORT_CLASS_MEDIA ||
786 port->probe_info[0].cmdset == NULL ||
787 strncmp(port->probe_info[0].cmdset, "CPIA_1", 6) != 0)
790 cpia_pp_register(port);
795 for (i = 0; i < PARPORT_MAX; ++i) {
796 if (port->number == parport_nr[i]) {
797 cpia_pp_register(port);
805 static struct parport_driver cpia_pp_driver = {
807 .attach = cpia_pp_attach,
808 .detach = cpia_pp_detach,
811 int cpia_pp_init(void)
813 printk(KERN_INFO "%s v%d.%d.%d\n",ABOUT,
814 CPIA_PP_MAJ_VER,CPIA_PP_MIN_VER,CPIA_PP_PATCH_VER);
816 if(parport_nr[0] == PPCPIA_PARPORT_OFF) {
817 printk(" disabled\n");
821 spin_lock_init( &cam_list_lock_pp );
823 if (parport_register_driver (&cpia_pp_driver)) {
824 LOG ("unable to register with parport\n");
831 int init_module(void)
834 /* The user gave some parameters. Let's see what they were. */
835 if (!strncmp(parport[0], "auto", 4)) {
836 parport_nr[0] = PPCPIA_PARPORT_AUTO;
839 for (n = 0; n < PARPORT_MAX && parport[n]; n++) {
840 if (!strncmp(parport[n], "none", 4)) {
841 parport_nr[n] = PPCPIA_PARPORT_NONE;
844 unsigned long r = simple_strtoul(parport[n], &ep, 0);
845 if (ep != parport[n]) {
848 LOG("bad port specifier `%s'\n", parport[n]);
855 return cpia_pp_init();
858 void cleanup_module(void)
860 parport_unregister_driver (&cpia_pp_driver);
866 static int __init cpia_pp_setup(char *str)
868 if (!strncmp(str, "parport", 7)) {
869 int n = simple_strtoul(str + 7, NULL, 10);
870 if (parport_ptr < PARPORT_MAX) {
871 parport_nr[parport_ptr++] = n;
873 LOG("too many ports, %s ignored.\n", str);
875 } else if (!strcmp(str, "auto")) {
876 parport_nr[0] = PPCPIA_PARPORT_AUTO;
877 } else if (!strcmp(str, "none")) {
878 parport_nr[parport_ptr++] = PPCPIA_PARPORT_NONE;
884 __setup("cpia_pp=", cpia_pp_setup);