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 DBG("%s: No more nibble data (%d bytes)\n",
178 /* Event 7: Set nAutoFd low. */
179 parport_frob_control (port
,
180 PARPORT_CONTROL_AUTOFD
,
181 PARPORT_CONTROL_AUTOFD
);
183 /* Event 9: nAck goes low. */
184 port
->ieee1284
.phase
= IEEE1284_PH_REV_DATA
;
185 if (parport_wait_peripheral (port
,
186 PARPORT_STATUS_ACK
, 0)) {
187 /* Timeout -- no more data? */
188 DBG("%s: Nibble timeout at event 9 (%d bytes)\n",
190 parport_frob_control (port
, PARPORT_CONTROL_AUTOFD
, 0);
196 nibble
= parport_read_status (port
) >> 3;
198 if ((nibble
& 0x10) == 0)
202 /* Event 10: Set nAutoFd high. */
203 parport_frob_control (port
, PARPORT_CONTROL_AUTOFD
, 0);
205 /* Event 11: nAck goes high. */
206 if (parport_wait_peripheral (port
,
208 PARPORT_STATUS_ACK
)) {
209 /* Timeout -- no more data? */
210 DBG("%s: Nibble timeout at event 11\n",
224 /* Read the last nibble without checking data avail. */
225 if (parport_read_status (port
) & PARPORT_STATUS_ERROR
) {
227 /* Go to reverse idle phase. */
228 parport_frob_control (port
,
229 PARPORT_CONTROL_AUTOFD
,
230 PARPORT_CONTROL_AUTOFD
);
231 port
->physport
->ieee1284
.phase
= IEEE1284_PH_REV_IDLE
;
234 port
->physport
->ieee1284
.phase
= IEEE1284_PH_HBUSY_DAVAIL
;
240 /* CPiA nonstandard "Nibble Stream" mode (2 nibbles per cycle, instead of 1)
241 * (See CPiA Data sheet p. 31)
243 * "Nibble Stream" mode used by CPiA for uploads to non-ECP ports is a
244 * nonstandard variant of nibble mode which allows the same (mediocre)
245 * data flow of 8 bits per cycle as software-enabled ECP by TRISTATE-capable
246 * parallel ports, but works also for non-TRISTATE-capable ports.
247 * (Standard nibble mode only send 4 bits per cycle)
251 static size_t cpia_read_nibble_stream(struct parport
*port
,
252 void *buffer
, size_t len
,
256 unsigned char *buf
= buffer
;
259 for (i
=0; i
< len
; i
++) {
260 unsigned char nibble
[2], byte
= 0;
263 /* Image Data is complete when 4 consecutive EOI bytes (0xff) are seen */
267 /* Event 7: Set nAutoFd low. */
268 parport_frob_control (port
,
269 PARPORT_CONTROL_AUTOFD
,
270 PARPORT_CONTROL_AUTOFD
);
272 /* Event 9: nAck goes low. */
273 port
->ieee1284
.phase
= IEEE1284_PH_REV_DATA
;
274 if (parport_wait_peripheral (port
,
275 PARPORT_STATUS_ACK
, 0)) {
276 /* Timeout -- no more data? */
277 DBG("%s: Nibble timeout at event 9 (%d bytes)\n",
279 parport_frob_control (port
, PARPORT_CONTROL_AUTOFD
, 0);
283 /* Read lower nibble */
284 nibble
[0] = parport_read_status (port
) >>3;
286 /* Event 10: Set nAutoFd high. */
287 parport_frob_control (port
, PARPORT_CONTROL_AUTOFD
, 0);
289 /* Event 11: nAck goes high. */
290 if (parport_wait_peripheral (port
,
292 PARPORT_STATUS_ACK
)) {
293 /* Timeout -- no more data? */
294 DBG("%s: Nibble timeout at event 11\n",
299 /* Read upper nibble */
300 nibble
[1] = parport_read_status (port
) >>3;
302 /* reassemble the byte */
303 for (j
= 0; j
< 2 ; j
++ ) {
305 if ((nibble
[j
] & 0x10) == 0)
309 byte
= (nibble
[0] |(nibble
[1] << 4));
320 /****************************************************************************
324 ***************************************************************************/
325 static void EndTransferMode(struct pp_cam_entry
*cam
)
327 parport_negotiate(cam
->port
, IEEE1284_MODE_COMPAT
);
330 /****************************************************************************
334 ***************************************************************************/
335 static int ForwardSetup(struct pp_cam_entry
*cam
)
339 /* The CPiA uses ECP protocol for Downloads from the Host to the camera.
340 * This will be software-emulated if ECP hardware is not present
343 /* the usual camera maximum response time is 10ms, but after receiving
344 * some commands, it needs up to 40ms. (Data Sheet p. 32)*/
346 for(retry
= 0; retry
< 4; ++retry
) {
347 if(!parport_negotiate(cam
->port
, IEEE1284_MODE_ECP
)) {
353 DBG("Unable to negotiate IEEE1284 ECP Download mode\n");
358 /****************************************************************************
362 ***************************************************************************/
363 static int ReverseSetup(struct pp_cam_entry
*cam
, int extensibility
)
366 int upload_mode
, mode
= IEEE1284_MODE_ECP
;
367 int transfer_mode
= ECP_TRANSFER
;
369 if (!(cam
->port
->modes
& PARPORT_MODE_ECP
) &&
370 !(cam
->port
->modes
& PARPORT_MODE_TRISTATE
)) {
371 mode
= IEEE1284_MODE_NIBBLE
;
372 transfer_mode
= NIBBLE_TRANSFER
;
376 if(extensibility
) mode
= UPLOAD_FLAG
|transfer_mode
|IEEE1284_EXT_LINK
;
378 /* the usual camera maximum response time is 10ms, but after
379 * receiving some commands, it needs up to 40ms. */
381 for(retry
= 0; retry
< 4; ++retry
) {
382 if(!parport_negotiate(cam
->port
, mode
)) {
389 DBG("Unable to negotiate upload extensibility mode\n");
391 DBG("Unable to negotiate upload mode\n");
394 if(extensibility
) cam
->port
->ieee1284
.mode
= upload_mode
;
398 /****************************************************************************
402 ***************************************************************************/
403 static int WritePacket(struct pp_cam_entry
*cam
, const u8
*packet
, size_t size
)
408 if (packet
== NULL
) {
411 if (ForwardSetup(cam
)) {
412 DBG("Write failed in setup\n");
415 size_written
= parport_write(cam
->port
, packet
, size
);
416 if(size_written
!= size
) {
417 DBG("Write failed, wrote %d/%d\n", size_written
, size
);
420 EndTransferMode(cam
);
424 /****************************************************************************
428 ***************************************************************************/
429 static int ReadPacket(struct pp_cam_entry
*cam
, u8
*packet
, size_t size
)
433 if (packet
== NULL
) {
436 if (ReverseSetup(cam
, 0)) {
440 /* support for CPiA variant nibble reads */
441 if(cam
->port
->ieee1284
.mode
== IEEE1284_MODE_NIBBLE
) {
442 if(cpia_read_nibble(cam
->port
, packet
, size
, 0) != size
)
445 if(parport_read(cam
->port
, packet
, size
) != size
)
448 EndTransferMode(cam
);
452 /****************************************************************************
454 * cpia_pp_streamStart
456 ***************************************************************************/
457 static int cpia_pp_streamStart(void *privdata
)
459 struct pp_cam_entry
*cam
= privdata
;
463 //if (ReverseSetup(cam,1)) return -EIO;
464 if(cam
->stream_irq
) cpia_parport_enable_irq(cam
->port
);
468 /****************************************************************************
472 ***************************************************************************/
473 static int cpia_pp_streamStop(void *privdata
)
475 struct pp_cam_entry
*cam
= privdata
;
479 cpia_parport_disable_irq(cam
->port
);
480 //EndTransferMode(cam);
485 /****************************************************************************
489 ***************************************************************************/
490 static int cpia_pp_read(struct parport
*port
, u8
*buffer
, int len
)
494 /* support for CPiA variant "nibble stream" reads */
495 if(port
->ieee1284
.mode
== IEEE1284_MODE_NIBBLE
)
496 bytes_read
= cpia_read_nibble_stream(port
,buffer
,len
,0);
499 for(bytes_read
=0; bytes_read
<len
; bytes_read
+= new_bytes
) {
500 new_bytes
= parport_read(port
, buffer
+bytes_read
,
502 if(new_bytes
< 0) break;
508 static int cpia_pp_streamRead(void *privdata
, u8
*buffer
, int noblock
)
510 struct pp_cam_entry
*cam
= privdata
;
512 int i
, endseen
, block_size
, new_bytes
;
515 DBG("Internal driver error: cam is NULL\n");
519 DBG("Internal driver error: buffer is NULL\n");
522 //if(cam->streaming) DBG("%d / %d\n", cam->image_ready, noblock);
523 if( cam
->stream_irq
) {
524 DBG("%d\n", cam
->image_ready
);
527 cam
->image_complete
=0;
528 if (0/*cam->streaming*/) {
529 if(!cam
->image_ready
) {
530 if(noblock
) return -EWOULDBLOCK
;
531 interruptible_sleep_on(&cam
->wq_stream
);
532 if( signal_pending(current
) ) return -EINTR
;
533 DBG("%d\n", cam
->image_ready
);
536 if (ReverseSetup(cam
, 1)) {
537 DBG("unable to ReverseSetup\n");
542 block_size
= PARPORT_CHUNK_SIZE
;
543 while( !cam
->image_complete
) {
546 new_bytes
= cpia_pp_read(cam
->port
, buffer
, block_size
);
547 if( new_bytes
<= 0 ) {
551 while(++i
<new_bytes
&& endseen
<4) {
561 cam
->image_complete
=1;
564 if( CPIA_MAX_IMAGE_SIZE
-read_bytes
<= PARPORT_CHUNK_SIZE
) {
565 block_size
=CPIA_MAX_IMAGE_SIZE
-read_bytes
;
568 EndTransferMode(cam
);
569 return cam
->image_complete
? read_bytes
: -EIO
;
571 /****************************************************************************
573 * cpia_pp_transferCmd
575 ***************************************************************************/
576 static int cpia_pp_transferCmd(void *privdata
, u8
*command
, u8
*data
)
581 struct pp_cam_entry
*cam
= privdata
;
584 DBG("Internal driver error: cam is NULL\n");
587 if(command
== NULL
) {
588 DBG("Internal driver error: command is NULL\n");
591 databytes
= (((int)command
[7])<<8) | command
[6];
592 if ((err
= WritePacket(cam
, command
, PACKET_LENGTH
)) < 0) {
593 DBG("Error writing command\n");
596 if(command
[0] == DATA_IN
) {
599 DBG("Internal driver error: data is NULL\n");
602 if((err
= ReadPacket(cam
, buffer
, 8)) < 0) {
603 DBG("Error reading command result\n");
606 memcpy(data
, buffer
, databytes
);
607 } else if(command
[0] == DATA_OUT
) {
610 DBG("Internal driver error: data is NULL\n");
613 if((err
=WritePacket(cam
, data
, databytes
)) < 0){
614 DBG("Error writing command data\n");
620 DBG("Unexpected first byte of command: %x\n", command
[0]);
626 /****************************************************************************
630 ***************************************************************************/
631 static int cpia_pp_open(void *privdata
)
633 struct pp_cam_entry
*cam
= (struct pp_cam_entry
*)privdata
;
638 if(cam
->open_count
== 0) {
639 if (parport_claim(cam
->pdev
)) {
640 DBG("failed to claim the port\n");
643 parport_negotiate(cam
->port
, IEEE1284_MODE_COMPAT
);
644 parport_data_forward(cam
->port
);
645 parport_write_control(cam
->port
, PARPORT_CONTROL_SELECT
);
647 parport_write_control(cam
->port
,
648 PARPORT_CONTROL_SELECT
649 | PARPORT_CONTROL_INIT
);
657 /****************************************************************************
659 * cpia_pp_registerCallback
661 ***************************************************************************/
662 static int cpia_pp_registerCallback(void *privdata
, void (*cb
)(void *cbdata
), void *cbdata
)
664 struct pp_cam_entry
*cam
= privdata
;
667 if(cam
->port
->irq
!= PARPORT_IRQ_NONE
) {
668 INIT_WORK(&cam
->cb_task
, cb
, cbdata
);
675 /****************************************************************************
679 ***************************************************************************/
680 static int cpia_pp_close(void *privdata
)
682 struct pp_cam_entry
*cam
= privdata
;
683 if (--cam
->open_count
== 0) {
684 parport_release(cam
->pdev
);
689 /****************************************************************************
693 ***************************************************************************/
694 static int cpia_pp_register(struct parport
*port
)
696 struct pardevice
*pdev
= NULL
;
697 struct pp_cam_entry
*cam
;
698 struct cam_data
*cpia
;
700 if (!(port
->modes
& PARPORT_MODE_PCSPP
)) {
701 LOG("port is not supported by CPiA driver\n");
705 cam
= kzalloc(sizeof(struct pp_cam_entry
), GFP_KERNEL
);
707 LOG("failed to allocate camera structure\n");
711 pdev
= parport_register_device(port
, "cpia_pp", NULL
, NULL
,
715 LOG("failed to parport_register_device\n");
722 init_waitqueue_head(&cam
->wq_stream
);
727 if((cpia
= cpia_register_camera(&cpia_pp_ops
, cam
)) == NULL
) {
728 LOG("failed to cpia_register_camera\n");
729 parport_unregister_device(pdev
);
733 spin_lock( &cam_list_lock_pp
);
734 list_add( &cpia
->cam_data_list
, &cam_list
);
735 spin_unlock( &cam_list_lock_pp
);
740 static void cpia_pp_detach (struct parport
*port
)
742 struct list_head
*tmp
;
743 struct cam_data
*cpia
= NULL
;
744 struct pp_cam_entry
*cam
;
746 spin_lock( &cam_list_lock_pp
);
747 list_for_each (tmp
, &cam_list
) {
748 cpia
= list_entry(tmp
, struct cam_data
, cam_data_list
);
749 cam
= (struct pp_cam_entry
*) cpia
->lowlevel_data
;
750 if (cam
&& cam
->port
->number
== port
->number
) {
751 list_del(&cpia
->cam_data_list
);
756 spin_unlock( &cam_list_lock_pp
);
759 DBG("cpia_pp_detach failed to find cam_data in cam_list\n");
763 cam
= (struct pp_cam_entry
*) cpia
->lowlevel_data
;
764 cpia_unregister_camera(cpia
);
765 if(cam
->open_count
> 0)
767 parport_unregister_device(cam
->pdev
);
768 cpia
->lowlevel_data
= NULL
;
772 static void cpia_pp_attach (struct parport
*port
)
776 switch (parport_nr
[0])
778 case PPCPIA_PARPORT_UNSPEC
:
779 case PPCPIA_PARPORT_AUTO
:
780 if (port
->probe_info
[0].class != PARPORT_CLASS_MEDIA
||
781 port
->probe_info
[0].cmdset
== NULL
||
782 strncmp(port
->probe_info
[0].cmdset
, "CPIA_1", 6) != 0)
785 cpia_pp_register(port
);
790 for (i
= 0; i
< PARPORT_MAX
; ++i
) {
791 if (port
->number
== parport_nr
[i
]) {
792 cpia_pp_register(port
);
800 static struct parport_driver cpia_pp_driver
= {
802 .attach
= cpia_pp_attach
,
803 .detach
= cpia_pp_detach
,
806 int cpia_pp_init(void)
808 printk(KERN_INFO
"%s v%d.%d.%d\n",ABOUT
,
809 CPIA_PP_MAJ_VER
,CPIA_PP_MIN_VER
,CPIA_PP_PATCH_VER
);
811 if(parport_nr
[0] == PPCPIA_PARPORT_OFF
) {
812 printk(" disabled\n");
816 spin_lock_init( &cam_list_lock_pp
);
818 if (parport_register_driver (&cpia_pp_driver
)) {
819 LOG ("unable to register with parport\n");
826 int init_module(void)
829 /* The user gave some parameters. Let's see what they were. */
830 if (!strncmp(parport
[0], "auto", 4)) {
831 parport_nr
[0] = PPCPIA_PARPORT_AUTO
;
834 for (n
= 0; n
< PARPORT_MAX
&& parport
[n
]; n
++) {
835 if (!strncmp(parport
[n
], "none", 4)) {
836 parport_nr
[n
] = PPCPIA_PARPORT_NONE
;
839 unsigned long r
= simple_strtoul(parport
[n
], &ep
, 0);
840 if (ep
!= parport
[n
]) {
843 LOG("bad port specifier `%s'\n", parport
[n
]);
850 return cpia_pp_init();
853 void cleanup_module(void)
855 parport_unregister_driver (&cpia_pp_driver
);
861 static int __init
cpia_pp_setup(char *str
)
863 if (!strncmp(str
, "parport", 7)) {
864 int n
= simple_strtoul(str
+ 7, NULL
, 10);
865 if (parport_ptr
< PARPORT_MAX
) {
866 parport_nr
[parport_ptr
++] = n
;
868 LOG("too many ports, %s ignored.\n", str
);
870 } else if (!strcmp(str
, "auto")) {
871 parport_nr
[0] = PPCPIA_PARPORT_AUTO
;
872 } else if (!strcmp(str
, "none")) {
873 parport_nr
[parport_ptr
++] = PPCPIA_PARPORT_NONE
;
879 __setup("cpia_pp=", cpia_pp_setup
);