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/sched.h>
39 #include <linux/kmod.h>
41 /* #define _CPIA_DEBUG_ define for verbose debug output */
44 static int cpia_pp_open(void *privdata);
45 static int cpia_pp_registerCallback(void *privdata, void (*cb) (void *cbdata),
47 static int cpia_pp_transferCmd(void *privdata, u8 *command, u8 *data);
48 static int cpia_pp_streamStart(void *privdata);
49 static int cpia_pp_streamStop(void *privdata);
50 static int cpia_pp_streamRead(void *privdata, u8 *buffer, int noblock);
51 static int cpia_pp_close(void *privdata);
54 #define ABOUT "Parallel port driver for Vision CPiA based cameras"
56 #define PACKET_LENGTH 8
58 /* Magic numbers for defining port-device mappings */
59 #define PPCPIA_PARPORT_UNSPEC -4
60 #define PPCPIA_PARPORT_AUTO -3
61 #define PPCPIA_PARPORT_OFF -2
62 #define PPCPIA_PARPORT_NONE -1
64 static int parport_nr[PARPORT_MAX] = {[0 ... PARPORT_MAX - 1] = PPCPIA_PARPORT_UNSPEC};
65 static char *parport[PARPORT_MAX] = {NULL,};
67 MODULE_AUTHOR("B. Huisman <bhuism@cs.utwente.nl> & Peter Pregler <Peter_Pregler@email.com>");
68 MODULE_DESCRIPTION("Parallel port driver for Vision CPiA based cameras");
69 MODULE_LICENSE("GPL");
71 module_param_array(parport, charp, NULL, 0);
72 MODULE_PARM_DESC(parport, "'auto' or a list of parallel port numbers. Just like lp.");
75 struct pardevice *pdev;
77 struct work_struct cb_task;
78 void (*cb_func)(void *cbdata);
81 wait_queue_head_t wq_stream;
82 /* image state flags */
83 int image_ready; /* we got an interrupt */
84 int image_complete; /* we have seen 4 EOI */
86 int streaming; /* we are in streaming mode */
90 static struct cpia_camera_ops cpia_pp_ops =
93 cpia_pp_registerCallback,
103 static LIST_HEAD(cam_list);
104 static spinlock_t cam_list_lock_pp;
107 static void cpia_parport_enable_irq( struct parport *port ) {
108 parport_enable_irq(port);
113 static void cpia_parport_disable_irq( struct parport *port ) {
114 parport_disable_irq(port);
119 /* Special CPiA PPC modes: These are invoked by using the 1284 Extensibility
120 * Link Flag during negotiation */
121 #define UPLOAD_FLAG 0x08
122 #define NIBBLE_TRANSFER 0x01
123 #define ECP_TRANSFER 0x03
125 #define PARPORT_CHUNK_SIZE PAGE_SIZE
128 static void cpia_pp_run_callback(struct work_struct *work)
130 void (*cb_func)(void *cbdata);
132 struct pp_cam_entry *cam;
134 cam = container_of(work, struct pp_cam_entry, cb_task);
135 cb_func = cam->cb_func;
136 cb_data = cam->cb_data;
141 /****************************************************************************
143 * CPiA-specific low-level parport functions for nibble uploads
145 ***************************************************************************/
146 /* CPiA nonstandard "Nibble" mode (no nDataAvail signal after each byte). */
147 /* The standard kernel parport_ieee1284_read_nibble() fails with the CPiA... */
149 static size_t cpia_read_nibble (struct parport *port,
150 void *buffer, size_t len,
153 /* adapted verbatim, with one change, from
154 parport_ieee1284_read_nibble() in drivers/parport/ieee1284-ops.c */
156 unsigned char *buf = buffer;
158 unsigned char byte = 0;
160 len *= 2; /* in nibbles */
161 for (i=0; i < len; i++) {
162 unsigned char nibble;
164 /* The CPiA firmware suppresses the use of nDataAvail (nFault LO)
165 * after every second nibble to signal that more
166 * data is available. (the total number of Bytes that
167 * should be sent is known; if too few are received, an error
168 * will be recorded after a timeout).
169 * This is incompatible with parport_ieee1284_read_nibble(),
170 * which expects to find nFault LO after every second nibble.
173 /* Solution: modify cpia_read_nibble to only check for
174 * nDataAvail before the first nibble is sent.
177 /* Does the error line indicate end of data? */
178 if (((i /*& 1*/) == 0) &&
179 (parport_read_status(port) & PARPORT_STATUS_ERROR)) {
180 DBG("%s: No more nibble data (%d bytes)\n",
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",
231 /* Read the last nibble without checking data avail. */
232 if (parport_read_status (port) & PARPORT_STATUS_ERROR) {
234 /* Go to reverse idle phase. */
235 parport_frob_control (port,
236 PARPORT_CONTROL_AUTOFD,
237 PARPORT_CONTROL_AUTOFD);
238 port->physport->ieee1284.phase = IEEE1284_PH_REV_IDLE;
241 port->physport->ieee1284.phase = IEEE1284_PH_HBUSY_DAVAIL;
247 /* CPiA nonstandard "Nibble Stream" mode (2 nibbles per cycle, instead of 1)
248 * (See CPiA Data sheet p. 31)
250 * "Nibble Stream" mode used by CPiA for uploads to non-ECP ports is a
251 * nonstandard variant of nibble mode which allows the same (mediocre)
252 * data flow of 8 bits per cycle as software-enabled ECP by TRISTATE-capable
253 * parallel ports, but works also for non-TRISTATE-capable ports.
254 * (Standard nibble mode only send 4 bits per cycle)
258 static size_t cpia_read_nibble_stream(struct parport *port,
259 void *buffer, size_t len,
263 unsigned char *buf = buffer;
266 for (i=0; i < len; i++) {
267 unsigned char nibble[2], byte = 0;
270 /* Image Data is complete when 4 consecutive EOI bytes (0xff) are seen */
274 /* Event 7: Set nAutoFd low. */
275 parport_frob_control (port,
276 PARPORT_CONTROL_AUTOFD,
277 PARPORT_CONTROL_AUTOFD);
279 /* Event 9: nAck goes low. */
280 port->ieee1284.phase = IEEE1284_PH_REV_DATA;
281 if (parport_wait_peripheral (port,
282 PARPORT_STATUS_ACK, 0)) {
283 /* Timeout -- no more data? */
284 DBG("%s: Nibble timeout at event 9 (%d bytes)\n",
286 parport_frob_control (port, PARPORT_CONTROL_AUTOFD, 0);
290 /* Read lower nibble */
291 nibble[0] = parport_read_status (port) >>3;
293 /* Event 10: Set nAutoFd high. */
294 parport_frob_control (port, PARPORT_CONTROL_AUTOFD, 0);
296 /* Event 11: nAck goes high. */
297 if (parport_wait_peripheral (port,
299 PARPORT_STATUS_ACK)) {
300 /* Timeout -- no more data? */
301 DBG("%s: Nibble timeout at event 11\n",
306 /* Read upper nibble */
307 nibble[1] = parport_read_status (port) >>3;
309 /* reassemble the byte */
310 for (j = 0; j < 2 ; j++ ) {
312 if ((nibble[j] & 0x10) == 0)
316 byte = (nibble[0] |(nibble[1] << 4));
327 /****************************************************************************
331 ***************************************************************************/
332 static void EndTransferMode(struct pp_cam_entry *cam)
334 parport_negotiate(cam->port, IEEE1284_MODE_COMPAT);
337 /****************************************************************************
341 ***************************************************************************/
342 static int ForwardSetup(struct pp_cam_entry *cam)
346 /* The CPiA uses ECP protocol for Downloads from the Host to the camera.
347 * This will be software-emulated if ECP hardware is not present
350 /* the usual camera maximum response time is 10ms, but after receiving
351 * some commands, it needs up to 40ms. (Data Sheet p. 32)*/
353 for(retry = 0; retry < 4; ++retry) {
354 if(!parport_negotiate(cam->port, IEEE1284_MODE_ECP)) {
360 DBG("Unable to negotiate IEEE1284 ECP Download mode\n");
365 /****************************************************************************
369 ***************************************************************************/
370 static int ReverseSetup(struct pp_cam_entry *cam, int extensibility)
373 int upload_mode, mode = IEEE1284_MODE_ECP;
374 int transfer_mode = ECP_TRANSFER;
376 if (!(cam->port->modes & PARPORT_MODE_ECP) &&
377 !(cam->port->modes & PARPORT_MODE_TRISTATE)) {
378 mode = IEEE1284_MODE_NIBBLE;
379 transfer_mode = NIBBLE_TRANSFER;
383 if(extensibility) mode = UPLOAD_FLAG|transfer_mode|IEEE1284_EXT_LINK;
385 /* the usual camera maximum response time is 10ms, but after
386 * receiving some commands, it needs up to 40ms. */
388 for(retry = 0; retry < 4; ++retry) {
389 if(!parport_negotiate(cam->port, mode)) {
396 DBG("Unable to negotiate upload extensibility mode\n");
398 DBG("Unable to negotiate upload mode\n");
401 if(extensibility) cam->port->ieee1284.mode = upload_mode;
405 /****************************************************************************
409 ***************************************************************************/
410 static int WritePacket(struct pp_cam_entry *cam, const u8 *packet, size_t size)
415 if (packet == NULL) {
418 if (ForwardSetup(cam)) {
419 DBG("Write failed in setup\n");
422 size_written = parport_write(cam->port, packet, size);
423 if(size_written != size) {
424 DBG("Write failed, wrote %d/%d\n", size_written, size);
427 EndTransferMode(cam);
431 /****************************************************************************
435 ***************************************************************************/
436 static int ReadPacket(struct pp_cam_entry *cam, u8 *packet, size_t size)
440 if (packet == NULL) {
443 if (ReverseSetup(cam, 0)) {
447 /* support for CPiA variant nibble reads */
448 if(cam->port->ieee1284.mode == IEEE1284_MODE_NIBBLE) {
449 if(cpia_read_nibble(cam->port, packet, size, 0) != size)
452 if(parport_read(cam->port, packet, size) != size)
455 EndTransferMode(cam);
459 /****************************************************************************
461 * cpia_pp_streamStart
463 ***************************************************************************/
464 static int cpia_pp_streamStart(void *privdata)
466 struct pp_cam_entry *cam = privdata;
470 //if (ReverseSetup(cam,1)) return -EIO;
471 if(cam->stream_irq) cpia_parport_enable_irq(cam->port);
475 /****************************************************************************
479 ***************************************************************************/
480 static int cpia_pp_streamStop(void *privdata)
482 struct pp_cam_entry *cam = privdata;
486 cpia_parport_disable_irq(cam->port);
487 //EndTransferMode(cam);
492 /****************************************************************************
496 ***************************************************************************/
497 static int cpia_pp_read(struct parport *port, u8 *buffer, int len)
501 /* support for CPiA variant "nibble stream" reads */
502 if(port->ieee1284.mode == IEEE1284_MODE_NIBBLE)
503 bytes_read = cpia_read_nibble_stream(port,buffer,len,0);
506 for(bytes_read=0; bytes_read<len; bytes_read += new_bytes) {
507 new_bytes = parport_read(port, buffer+bytes_read,
509 if(new_bytes < 0) break;
515 static int cpia_pp_streamRead(void *privdata, u8 *buffer, int noblock)
517 struct pp_cam_entry *cam = privdata;
519 int i, endseen, block_size, new_bytes;
522 DBG("Internal driver error: cam is NULL\n");
526 DBG("Internal driver error: buffer is NULL\n");
529 //if(cam->streaming) DBG("%d / %d\n", cam->image_ready, noblock);
530 if( cam->stream_irq ) {
531 DBG("%d\n", cam->image_ready);
534 cam->image_complete=0;
535 if (0/*cam->streaming*/) {
536 if(!cam->image_ready) {
537 if(noblock) return -EWOULDBLOCK;
538 interruptible_sleep_on(&cam->wq_stream);
539 if( signal_pending(current) ) return -EINTR;
540 DBG("%d\n", cam->image_ready);
543 if (ReverseSetup(cam, 1)) {
544 DBG("unable to ReverseSetup\n");
549 block_size = PARPORT_CHUNK_SIZE;
550 while( !cam->image_complete ) {
553 new_bytes = cpia_pp_read(cam->port, buffer, block_size );
554 if( new_bytes <= 0 ) {
558 while(++i<new_bytes && endseen<4) {
568 cam->image_complete=1;
571 if( CPIA_MAX_IMAGE_SIZE-read_bytes <= PARPORT_CHUNK_SIZE ) {
572 block_size=CPIA_MAX_IMAGE_SIZE-read_bytes;
575 EndTransferMode(cam);
576 return cam->image_complete ? read_bytes : -EIO;
578 /****************************************************************************
580 * cpia_pp_transferCmd
582 ***************************************************************************/
583 static int cpia_pp_transferCmd(void *privdata, u8 *command, u8 *data)
588 struct pp_cam_entry *cam = privdata;
591 DBG("Internal driver error: cam is NULL\n");
594 if(command == NULL) {
595 DBG("Internal driver error: command is NULL\n");
598 databytes = (((int)command[7])<<8) | command[6];
599 if ((err = WritePacket(cam, command, PACKET_LENGTH)) < 0) {
600 DBG("Error writing command\n");
603 if(command[0] == DATA_IN) {
606 DBG("Internal driver error: data is NULL\n");
609 if((err = ReadPacket(cam, buffer, 8)) < 0) {
610 DBG("Error reading command result\n");
613 memcpy(data, buffer, databytes);
614 } else if(command[0] == DATA_OUT) {
617 DBG("Internal driver error: data is NULL\n");
620 if((err=WritePacket(cam, data, databytes)) < 0){
621 DBG("Error writing command data\n");
627 DBG("Unexpected first byte of command: %x\n", command[0]);
633 /****************************************************************************
637 ***************************************************************************/
638 static int cpia_pp_open(void *privdata)
640 struct pp_cam_entry *cam = (struct pp_cam_entry *)privdata;
645 if(cam->open_count == 0) {
646 if (parport_claim(cam->pdev)) {
647 DBG("failed to claim the port\n");
650 parport_negotiate(cam->port, IEEE1284_MODE_COMPAT);
651 parport_data_forward(cam->port);
652 parport_write_control(cam->port, PARPORT_CONTROL_SELECT);
654 parport_write_control(cam->port,
655 PARPORT_CONTROL_SELECT
656 | PARPORT_CONTROL_INIT);
664 /****************************************************************************
666 * cpia_pp_registerCallback
668 ***************************************************************************/
669 static int cpia_pp_registerCallback(void *privdata, void (*cb)(void *cbdata), void *cbdata)
671 struct pp_cam_entry *cam = privdata;
674 if(cam->port->irq != PARPORT_IRQ_NONE) {
676 cam->cb_data = cbdata;
677 INIT_WORK(&cam->cb_task, cpia_pp_run_callback);
684 /****************************************************************************
688 ***************************************************************************/
689 static int cpia_pp_close(void *privdata)
691 struct pp_cam_entry *cam = privdata;
692 if (--cam->open_count == 0) {
693 parport_release(cam->pdev);
698 /****************************************************************************
702 ***************************************************************************/
703 static int cpia_pp_register(struct parport *port)
705 struct pardevice *pdev = NULL;
706 struct pp_cam_entry *cam;
707 struct cam_data *cpia;
709 if (!(port->modes & PARPORT_MODE_PCSPP)) {
710 LOG("port is not supported by CPiA driver\n");
714 cam = kzalloc(sizeof(struct pp_cam_entry), GFP_KERNEL);
716 LOG("failed to allocate camera structure\n");
720 pdev = parport_register_device(port, "cpia_pp", NULL, NULL,
724 LOG("failed to parport_register_device\n");
731 init_waitqueue_head(&cam->wq_stream);
736 if((cpia = cpia_register_camera(&cpia_pp_ops, cam)) == NULL) {
737 LOG("failed to cpia_register_camera\n");
738 parport_unregister_device(pdev);
742 spin_lock( &cam_list_lock_pp );
743 list_add( &cpia->cam_data_list, &cam_list );
744 spin_unlock( &cam_list_lock_pp );
749 static void cpia_pp_detach (struct parport *port)
751 struct list_head *tmp;
752 struct cam_data *cpia = NULL;
753 struct pp_cam_entry *cam;
755 spin_lock( &cam_list_lock_pp );
756 list_for_each (tmp, &cam_list) {
757 cpia = list_entry(tmp, struct cam_data, cam_data_list);
758 cam = (struct pp_cam_entry *) cpia->lowlevel_data;
759 if (cam && cam->port->number == port->number) {
760 list_del(&cpia->cam_data_list);
765 spin_unlock( &cam_list_lock_pp );
768 DBG("cpia_pp_detach failed to find cam_data in cam_list\n");
772 cam = (struct pp_cam_entry *) cpia->lowlevel_data;
773 cpia_unregister_camera(cpia);
774 if(cam->open_count > 0)
776 parport_unregister_device(cam->pdev);
777 cpia->lowlevel_data = NULL;
781 static void cpia_pp_attach (struct parport *port)
785 switch (parport_nr[0])
787 case PPCPIA_PARPORT_UNSPEC:
788 case PPCPIA_PARPORT_AUTO:
789 if (port->probe_info[0].class != PARPORT_CLASS_MEDIA ||
790 port->probe_info[0].cmdset == NULL ||
791 strncmp(port->probe_info[0].cmdset, "CPIA_1", 6) != 0)
794 cpia_pp_register(port);
799 for (i = 0; i < PARPORT_MAX; ++i) {
800 if (port->number == parport_nr[i]) {
801 cpia_pp_register(port);
809 static struct parport_driver cpia_pp_driver = {
811 .attach = cpia_pp_attach,
812 .detach = cpia_pp_detach,
815 static int __init cpia_pp_init(void)
817 printk(KERN_INFO "%s v%d.%d.%d\n",ABOUT,
818 CPIA_PP_MAJ_VER,CPIA_PP_MIN_VER,CPIA_PP_PATCH_VER);
820 if(parport_nr[0] == PPCPIA_PARPORT_OFF) {
821 printk(" disabled\n");
825 spin_lock_init( &cam_list_lock_pp );
827 if (parport_register_driver (&cpia_pp_driver)) {
828 LOG ("unable to register with parport\n");
834 static int __init cpia_init(void)
837 /* The user gave some parameters. Let's see what they were. */
838 if (!strncmp(parport[0], "auto", 4)) {
839 parport_nr[0] = PPCPIA_PARPORT_AUTO;
842 for (n = 0; n < PARPORT_MAX && parport[n]; n++) {
843 if (!strncmp(parport[n], "none", 4)) {
844 parport_nr[n] = PPCPIA_PARPORT_NONE;
847 unsigned long r = simple_strtoul(parport[n], &ep, 0);
848 if (ep != parport[n]) {
851 LOG("bad port specifier `%s'\n", parport[n]);
858 return cpia_pp_init();
861 static void __exit cpia_cleanup(void)
863 parport_unregister_driver(&cpia_pp_driver);
867 module_init(cpia_init);
868 module_exit(cpia_cleanup);