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 */
29 #include <linux/module.h>
30 #include <linux/init.h>
32 #include <linux/kernel.h>
33 #include <linux/parport.h>
34 #include <linux/interrupt.h>
35 #include <linux/delay.h>
36 #include <linux/workqueue.h>
37 #include <linux/smp_lock.h>
38 #include <linux/sched.h>
40 #include <linux/kmod.h>
42 /* #define _CPIA_DEBUG_ define for verbose debug output */
45 static int cpia_pp_open(void *privdata);
46 static int cpia_pp_registerCallback(void *privdata, void (*cb) (void *cbdata),
48 static int cpia_pp_transferCmd(void *privdata, u8 *command, u8 *data);
49 static int cpia_pp_streamStart(void *privdata);
50 static int cpia_pp_streamStop(void *privdata);
51 static int cpia_pp_streamRead(void *privdata, u8 *buffer, int noblock);
52 static int cpia_pp_close(void *privdata);
55 #define ABOUT "Parallel port driver for Vision CPiA based cameras"
57 #define PACKET_LENGTH 8
59 /* Magic numbers for defining port-device mappings */
60 #define PPCPIA_PARPORT_UNSPEC -4
61 #define PPCPIA_PARPORT_AUTO -3
62 #define PPCPIA_PARPORT_OFF -2
63 #define PPCPIA_PARPORT_NONE -1
65 static int parport_nr[PARPORT_MAX] = {[0 ... PARPORT_MAX - 1] = PPCPIA_PARPORT_UNSPEC};
66 static char *parport[PARPORT_MAX] = {NULL,};
68 MODULE_AUTHOR("B. Huisman <bhuism@cs.utwente.nl> & Peter Pregler <Peter_Pregler@email.com>");
69 MODULE_DESCRIPTION("Parallel port driver for Vision CPiA based cameras");
70 MODULE_LICENSE("GPL");
72 module_param_array(parport, charp, NULL, 0);
73 MODULE_PARM_DESC(parport, "'auto' or a list of parallel port numbers. Just like lp.");
76 struct pardevice *pdev;
78 struct work_struct cb_task;
79 void (*cb_func)(void *cbdata);
82 wait_queue_head_t wq_stream;
83 /* image state flags */
84 int image_ready; /* we got an interrupt */
85 int image_complete; /* we have seen 4 EOI */
87 int streaming; /* we are in streaming mode */
91 static struct cpia_camera_ops cpia_pp_ops =
94 cpia_pp_registerCallback,
104 static LIST_HEAD(cam_list);
105 static spinlock_t cam_list_lock_pp;
108 static void cpia_parport_enable_irq( struct parport *port ) {
109 parport_enable_irq(port);
114 static void cpia_parport_disable_irq( struct parport *port ) {
115 parport_disable_irq(port);
120 /* Special CPiA PPC modes: These are invoked by using the 1284 Extensibility
121 * Link Flag during negotiation */
122 #define UPLOAD_FLAG 0x08
123 #define NIBBLE_TRANSFER 0x01
124 #define ECP_TRANSFER 0x03
126 #define PARPORT_CHUNK_SIZE PAGE_SIZE
129 static void cpia_pp_run_callback(struct work_struct *work)
131 void (*cb_func)(void *cbdata);
133 struct pp_cam_entry *cam;
135 cam = container_of(work, struct pp_cam_entry, cb_task);
136 cb_func = cam->cb_func;
137 cb_data = cam->cb_data;
142 /****************************************************************************
144 * CPiA-specific low-level parport functions for nibble uploads
146 ***************************************************************************/
147 /* CPiA nonstandard "Nibble" mode (no nDataAvail signal after each byte). */
148 /* The standard kernel parport_ieee1284_read_nibble() fails with the CPiA... */
150 static size_t cpia_read_nibble (struct parport *port,
151 void *buffer, size_t len,
154 /* adapted verbatim, with one change, from
155 parport_ieee1284_read_nibble() in drivers/parport/ieee1284-ops.c */
157 unsigned char *buf = buffer;
159 unsigned char byte = 0;
161 len *= 2; /* in nibbles */
162 for (i=0; i < len; i++) {
163 unsigned char nibble;
165 /* The CPiA firmware suppresses the use of nDataAvail (nFault LO)
166 * after every second nibble to signal that more
167 * data is available. (the total number of Bytes that
168 * should be sent is known; if too few are received, an error
169 * will be recorded after a timeout).
170 * This is incompatible with parport_ieee1284_read_nibble(),
171 * which expects to find nFault LO after every second nibble.
174 /* Solution: modify cpia_read_nibble to only check for
175 * nDataAvail before the first nibble is sent.
178 /* Does the error line indicate end of data? */
179 if (((i /*& 1*/) == 0) &&
180 (parport_read_status(port) & PARPORT_STATUS_ERROR)) {
181 DBG("%s: No more nibble data (%d bytes)\n",
186 /* Event 7: Set nAutoFd low. */
187 parport_frob_control (port,
188 PARPORT_CONTROL_AUTOFD,
189 PARPORT_CONTROL_AUTOFD);
191 /* Event 9: nAck goes low. */
192 port->ieee1284.phase = IEEE1284_PH_REV_DATA;
193 if (parport_wait_peripheral (port,
194 PARPORT_STATUS_ACK, 0)) {
195 /* Timeout -- no more data? */
196 DBG("%s: Nibble timeout at event 9 (%d bytes)\n",
198 parport_frob_control (port, PARPORT_CONTROL_AUTOFD, 0);
204 nibble = parport_read_status (port) >> 3;
206 if ((nibble & 0x10) == 0)
210 /* Event 10: Set nAutoFd high. */
211 parport_frob_control (port, PARPORT_CONTROL_AUTOFD, 0);
213 /* Event 11: nAck goes high. */
214 if (parport_wait_peripheral (port,
216 PARPORT_STATUS_ACK)) {
217 /* Timeout -- no more data? */
218 DBG("%s: Nibble timeout at event 11\n",
232 /* Read the last nibble without checking data avail. */
233 if (parport_read_status (port) & PARPORT_STATUS_ERROR) {
235 /* Go to reverse idle phase. */
236 parport_frob_control (port,
237 PARPORT_CONTROL_AUTOFD,
238 PARPORT_CONTROL_AUTOFD);
239 port->physport->ieee1284.phase = IEEE1284_PH_REV_IDLE;
242 port->physport->ieee1284.phase = IEEE1284_PH_HBUSY_DAVAIL;
248 /* CPiA nonstandard "Nibble Stream" mode (2 nibbles per cycle, instead of 1)
249 * (See CPiA Data sheet p. 31)
251 * "Nibble Stream" mode used by CPiA for uploads to non-ECP ports is a
252 * nonstandard variant of nibble mode which allows the same (mediocre)
253 * data flow of 8 bits per cycle as software-enabled ECP by TRISTATE-capable
254 * parallel ports, but works also for non-TRISTATE-capable ports.
255 * (Standard nibble mode only send 4 bits per cycle)
259 static size_t cpia_read_nibble_stream(struct parport *port,
260 void *buffer, size_t len,
264 unsigned char *buf = buffer;
267 for (i=0; i < len; i++) {
268 unsigned char nibble[2], byte = 0;
271 /* Image Data is complete when 4 consecutive EOI bytes (0xff) are seen */
275 /* Event 7: Set nAutoFd low. */
276 parport_frob_control (port,
277 PARPORT_CONTROL_AUTOFD,
278 PARPORT_CONTROL_AUTOFD);
280 /* Event 9: nAck goes low. */
281 port->ieee1284.phase = IEEE1284_PH_REV_DATA;
282 if (parport_wait_peripheral (port,
283 PARPORT_STATUS_ACK, 0)) {
284 /* Timeout -- no more data? */
285 DBG("%s: Nibble timeout at event 9 (%d bytes)\n",
287 parport_frob_control (port, PARPORT_CONTROL_AUTOFD, 0);
291 /* Read lower nibble */
292 nibble[0] = parport_read_status (port) >>3;
294 /* Event 10: Set nAutoFd high. */
295 parport_frob_control (port, PARPORT_CONTROL_AUTOFD, 0);
297 /* Event 11: nAck goes high. */
298 if (parport_wait_peripheral (port,
300 PARPORT_STATUS_ACK)) {
301 /* Timeout -- no more data? */
302 DBG("%s: Nibble timeout at event 11\n",
307 /* Read upper nibble */
308 nibble[1] = parport_read_status (port) >>3;
310 /* reassemble the byte */
311 for (j = 0; j < 2 ; j++ ) {
313 if ((nibble[j] & 0x10) == 0)
317 byte = (nibble[0] |(nibble[1] << 4));
328 /****************************************************************************
332 ***************************************************************************/
333 static void EndTransferMode(struct pp_cam_entry *cam)
335 parport_negotiate(cam->port, IEEE1284_MODE_COMPAT);
338 /****************************************************************************
342 ***************************************************************************/
343 static int ForwardSetup(struct pp_cam_entry *cam)
347 /* The CPiA uses ECP protocol for Downloads from the Host to the camera.
348 * This will be software-emulated if ECP hardware is not present
351 /* the usual camera maximum response time is 10ms, but after receiving
352 * some commands, it needs up to 40ms. (Data Sheet p. 32)*/
354 for(retry = 0; retry < 4; ++retry) {
355 if(!parport_negotiate(cam->port, IEEE1284_MODE_ECP)) {
361 DBG("Unable to negotiate IEEE1284 ECP Download mode\n");
366 /****************************************************************************
370 ***************************************************************************/
371 static int ReverseSetup(struct pp_cam_entry *cam, int extensibility)
374 int upload_mode, mode = IEEE1284_MODE_ECP;
375 int transfer_mode = ECP_TRANSFER;
377 if (!(cam->port->modes & PARPORT_MODE_ECP) &&
378 !(cam->port->modes & PARPORT_MODE_TRISTATE)) {
379 mode = IEEE1284_MODE_NIBBLE;
380 transfer_mode = NIBBLE_TRANSFER;
384 if(extensibility) mode = UPLOAD_FLAG|transfer_mode|IEEE1284_EXT_LINK;
386 /* the usual camera maximum response time is 10ms, but after
387 * receiving some commands, it needs up to 40ms. */
389 for(retry = 0; retry < 4; ++retry) {
390 if(!parport_negotiate(cam->port, mode)) {
397 DBG("Unable to negotiate upload extensibility mode\n");
399 DBG("Unable to negotiate upload mode\n");
402 if(extensibility) cam->port->ieee1284.mode = upload_mode;
406 /****************************************************************************
410 ***************************************************************************/
411 static int WritePacket(struct pp_cam_entry *cam, const u8 *packet, size_t size)
416 if (packet == NULL) {
419 if (ForwardSetup(cam)) {
420 DBG("Write failed in setup\n");
423 size_written = parport_write(cam->port, packet, size);
424 if(size_written != size) {
425 DBG("Write failed, wrote %d/%d\n", size_written, size);
428 EndTransferMode(cam);
432 /****************************************************************************
436 ***************************************************************************/
437 static int ReadPacket(struct pp_cam_entry *cam, u8 *packet, size_t size)
441 if (packet == NULL) {
444 if (ReverseSetup(cam, 0)) {
448 /* support for CPiA variant nibble reads */
449 if(cam->port->ieee1284.mode == IEEE1284_MODE_NIBBLE) {
450 if(cpia_read_nibble(cam->port, packet, size, 0) != size)
453 if(parport_read(cam->port, packet, size) != size)
456 EndTransferMode(cam);
460 /****************************************************************************
462 * cpia_pp_streamStart
464 ***************************************************************************/
465 static int cpia_pp_streamStart(void *privdata)
467 struct pp_cam_entry *cam = privdata;
471 //if (ReverseSetup(cam,1)) return -EIO;
472 if(cam->stream_irq) cpia_parport_enable_irq(cam->port);
476 /****************************************************************************
480 ***************************************************************************/
481 static int cpia_pp_streamStop(void *privdata)
483 struct pp_cam_entry *cam = privdata;
487 cpia_parport_disable_irq(cam->port);
488 //EndTransferMode(cam);
493 /****************************************************************************
497 ***************************************************************************/
498 static int cpia_pp_read(struct parport *port, u8 *buffer, int len)
502 /* support for CPiA variant "nibble stream" reads */
503 if(port->ieee1284.mode == IEEE1284_MODE_NIBBLE)
504 bytes_read = cpia_read_nibble_stream(port,buffer,len,0);
507 for(bytes_read=0; bytes_read<len; bytes_read += new_bytes) {
508 new_bytes = parport_read(port, buffer+bytes_read,
510 if(new_bytes < 0) break;
516 static int cpia_pp_streamRead(void *privdata, u8 *buffer, int noblock)
518 struct pp_cam_entry *cam = privdata;
520 int i, endseen, block_size, new_bytes;
523 DBG("Internal driver error: cam is NULL\n");
527 DBG("Internal driver error: buffer is NULL\n");
530 //if(cam->streaming) DBG("%d / %d\n", cam->image_ready, noblock);
531 if( cam->stream_irq ) {
532 DBG("%d\n", cam->image_ready);
535 cam->image_complete=0;
536 if (0/*cam->streaming*/) {
537 if(!cam->image_ready) {
538 if(noblock) return -EWOULDBLOCK;
539 interruptible_sleep_on(&cam->wq_stream);
540 if( signal_pending(current) ) return -EINTR;
541 DBG("%d\n", cam->image_ready);
544 if (ReverseSetup(cam, 1)) {
545 DBG("unable to ReverseSetup\n");
550 block_size = PARPORT_CHUNK_SIZE;
551 while( !cam->image_complete ) {
554 new_bytes = cpia_pp_read(cam->port, buffer, block_size );
555 if( new_bytes <= 0 ) {
559 while(++i<new_bytes && endseen<4) {
569 cam->image_complete=1;
572 if( CPIA_MAX_IMAGE_SIZE-read_bytes <= PARPORT_CHUNK_SIZE ) {
573 block_size=CPIA_MAX_IMAGE_SIZE-read_bytes;
576 EndTransferMode(cam);
577 return cam->image_complete ? read_bytes : -EIO;
579 /****************************************************************************
581 * cpia_pp_transferCmd
583 ***************************************************************************/
584 static int cpia_pp_transferCmd(void *privdata, u8 *command, u8 *data)
589 struct pp_cam_entry *cam = privdata;
592 DBG("Internal driver error: cam is NULL\n");
595 if(command == NULL) {
596 DBG("Internal driver error: command is NULL\n");
599 databytes = (((int)command[7])<<8) | command[6];
600 if ((err = WritePacket(cam, command, PACKET_LENGTH)) < 0) {
601 DBG("Error writing command\n");
604 if(command[0] == DATA_IN) {
607 DBG("Internal driver error: data is NULL\n");
610 if((err = ReadPacket(cam, buffer, 8)) < 0) {
611 DBG("Error reading command result\n");
614 memcpy(data, buffer, databytes);
615 } else if(command[0] == DATA_OUT) {
618 DBG("Internal driver error: data is NULL\n");
621 if((err=WritePacket(cam, data, databytes)) < 0){
622 DBG("Error writing command data\n");
628 DBG("Unexpected first byte of command: %x\n", command[0]);
634 /****************************************************************************
638 ***************************************************************************/
639 static int cpia_pp_open(void *privdata)
641 struct pp_cam_entry *cam = (struct pp_cam_entry *)privdata;
646 if(cam->open_count == 0) {
647 if (parport_claim(cam->pdev)) {
648 DBG("failed to claim the port\n");
651 parport_negotiate(cam->port, IEEE1284_MODE_COMPAT);
652 parport_data_forward(cam->port);
653 parport_write_control(cam->port, PARPORT_CONTROL_SELECT);
655 parport_write_control(cam->port,
656 PARPORT_CONTROL_SELECT
657 | PARPORT_CONTROL_INIT);
665 /****************************************************************************
667 * cpia_pp_registerCallback
669 ***************************************************************************/
670 static int cpia_pp_registerCallback(void *privdata, void (*cb)(void *cbdata), void *cbdata)
672 struct pp_cam_entry *cam = privdata;
675 if(cam->port->irq != PARPORT_IRQ_NONE) {
677 cam->cb_data = cbdata;
678 INIT_WORK(&cam->cb_task, cpia_pp_run_callback);
685 /****************************************************************************
689 ***************************************************************************/
690 static int cpia_pp_close(void *privdata)
692 struct pp_cam_entry *cam = privdata;
693 if (--cam->open_count == 0) {
694 parport_release(cam->pdev);
699 /****************************************************************************
703 ***************************************************************************/
704 static int cpia_pp_register(struct parport *port)
706 struct pardevice *pdev = NULL;
707 struct pp_cam_entry *cam;
708 struct cam_data *cpia;
710 if (!(port->modes & PARPORT_MODE_PCSPP)) {
711 LOG("port is not supported by CPiA driver\n");
715 cam = kzalloc(sizeof(struct pp_cam_entry), GFP_KERNEL);
717 LOG("failed to allocate camera structure\n");
721 pdev = parport_register_device(port, "cpia_pp", NULL, NULL,
725 LOG("failed to parport_register_device\n");
732 init_waitqueue_head(&cam->wq_stream);
737 if((cpia = cpia_register_camera(&cpia_pp_ops, cam)) == NULL) {
738 LOG("failed to cpia_register_camera\n");
739 parport_unregister_device(pdev);
743 spin_lock( &cam_list_lock_pp );
744 list_add( &cpia->cam_data_list, &cam_list );
745 spin_unlock( &cam_list_lock_pp );
750 static void cpia_pp_detach (struct parport *port)
752 struct list_head *tmp;
753 struct cam_data *cpia = NULL;
754 struct pp_cam_entry *cam;
756 spin_lock( &cam_list_lock_pp );
757 list_for_each (tmp, &cam_list) {
758 cpia = list_entry(tmp, struct cam_data, cam_data_list);
759 cam = (struct pp_cam_entry *) cpia->lowlevel_data;
760 if (cam && cam->port->number == port->number) {
761 list_del(&cpia->cam_data_list);
766 spin_unlock( &cam_list_lock_pp );
769 DBG("cpia_pp_detach failed to find cam_data in cam_list\n");
773 cam = (struct pp_cam_entry *) cpia->lowlevel_data;
774 cpia_unregister_camera(cpia);
775 if(cam->open_count > 0)
777 parport_unregister_device(cam->pdev);
778 cpia->lowlevel_data = NULL;
782 static void cpia_pp_attach (struct parport *port)
786 switch (parport_nr[0])
788 case PPCPIA_PARPORT_UNSPEC:
789 case PPCPIA_PARPORT_AUTO:
790 if (port->probe_info[0].class != PARPORT_CLASS_MEDIA ||
791 port->probe_info[0].cmdset == NULL ||
792 strncmp(port->probe_info[0].cmdset, "CPIA_1", 6) != 0)
795 cpia_pp_register(port);
800 for (i = 0; i < PARPORT_MAX; ++i) {
801 if (port->number == parport_nr[i]) {
802 cpia_pp_register(port);
810 static struct parport_driver cpia_pp_driver = {
812 .attach = cpia_pp_attach,
813 .detach = cpia_pp_detach,
816 static int __init cpia_pp_init(void)
818 printk(KERN_INFO "%s v%d.%d.%d\n",ABOUT,
819 CPIA_PP_MAJ_VER,CPIA_PP_MIN_VER,CPIA_PP_PATCH_VER);
821 if(parport_nr[0] == PPCPIA_PARPORT_OFF) {
822 printk(" disabled\n");
826 spin_lock_init( &cam_list_lock_pp );
828 if (parport_register_driver (&cpia_pp_driver)) {
829 LOG ("unable to register with parport\n");
835 static int __init cpia_init(void)
838 /* The user gave some parameters. Let's see what they were. */
839 if (!strncmp(parport[0], "auto", 4)) {
840 parport_nr[0] = PPCPIA_PARPORT_AUTO;
843 for (n = 0; n < PARPORT_MAX && parport[n]; n++) {
844 if (!strncmp(parport[n], "none", 4)) {
845 parport_nr[n] = PPCPIA_PARPORT_NONE;
848 unsigned long r = simple_strtoul(parport[n], &ep, 0);
849 if (ep != parport[n]) {
852 LOG("bad port specifier `%s'\n", parport[n]);
859 return cpia_pp_init();
862 static void __exit cpia_cleanup(void)
864 parport_unregister_driver(&cpia_pp_driver);
868 module_init(cpia_init);
869 module_exit(cpia_cleanup);