1 /*****************************************************************************/
4 * uss720.c -- USS720 USB Parport Cable.
7 * Thomas Sailer (sailer@ife.ee.ethz.ch)
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 * Based on parport_pc.c
26 * 0.1 04.08.99 Created
27 * 0.2 07.08.99 Some fixes mainly suggested by Tim Waugh
28 * Interrupt handling currently disabled because
29 * usb_request_irq crashes somewhere within ohci.c
30 * for no apparent reason (that is for me, anyway)
31 * ECP currently untested
32 * 0.3 10.08.99 fixing merge errors
33 * 0.4 13.08.99 Added Vendor/Product ID of Brad Hard's cable
34 * 0.5 20.09.99 usb_control_msg wrapper used
35 * Nov01.00 usb_device_table support by Adam J. Richter
36 * 08.04.01 Identify version on module load. gb
40 /*****************************************************************************/
42 #include <linux/module.h>
43 #include <linux/socket.h>
44 #include <linux/parport.h>
45 #include <linux/init.h>
46 #include <linux/usb.h>
47 #include <linux/delay.h>
52 #define DRIVER_VERSION "v0.5"
53 #define DRIVER_AUTHOR "Thomas M. Sailer, sailer@ife.ee.ethz.ch"
54 #define DRIVER_DESC "USB Parport Cable driver for Cables using the Lucent Technologies USS720 Chip"
56 /* --------------------------------------------------------------------- */
58 struct parport_uss720_private
{
59 struct usb_device
*usbdev
;
62 unsigned char reg
[7]; /* USB registers */
65 /* --------------------------------------------------------------------- */
67 static int get_1284_register(struct parport
*pp
, unsigned char reg
, unsigned char *val
)
69 struct parport_uss720_private
*priv
= pp
->private_data
;
70 struct usb_device
*usbdev
= priv
->usbdev
;
71 static const unsigned char regindex
[9] = {
72 4, 0, 1, 5, 5, 0, 2, 3, 6
78 ret
= usb_control_msg(usbdev
, usb_rcvctrlpipe(usbdev
,0), 3, 0xc0, ((unsigned int)reg
) << 8, 0, priv
->reg
, 7, 1000);
80 printk(KERN_DEBUG
"uss720: get_1284_register(%d) failed, status 0x%x expected 7\n",
81 (unsigned int)reg
, ret
);
85 printk(KERN_DEBUG
"uss720: get_1284_register(%d) return %02x %02x %02x %02x %02x %02x %02x\n",
86 (unsigned int)reg
, (unsigned int)priv
->reg
[0], (unsigned int)priv
->reg
[1],
87 (unsigned int)priv
->reg
[2], (unsigned int)priv
->reg
[3], (unsigned int)priv
->reg
[4],
88 (unsigned int)priv
->reg
[5], (unsigned int)priv
->reg
[6]);
90 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
91 if (priv
->reg
[2] & priv
->reg
[1] & 0x10)
92 parport_generic_irq(0, pp
, NULL
);
96 *val
= priv
->reg
[(reg
>= 9) ? 0 : regindex
[reg
]];
100 static int set_1284_register(struct parport
*pp
, unsigned char reg
, unsigned char val
)
102 struct parport_uss720_private
*priv
= pp
->private_data
;
103 struct usb_device
*usbdev
= priv
->usbdev
;
108 ret
= usb_control_msg(usbdev
, usb_sndctrlpipe(usbdev
,0), 4, 0x40, (((unsigned int)reg
) << 8) | val
, 0, NULL
, 0, 1000);
110 printk(KERN_DEBUG
"uss720: set_1284_register(%u,0x%02x) failed, status 0x%x\n",
111 (unsigned int)reg
, (unsigned int)val
, ret
);
114 printk(KERN_DEBUG
"uss720: set_1284_register(%u,0x%02x)\n",
115 (unsigned int)reg
, (unsigned int)val
);
121 /* --------------------------------------------------------------------- */
130 /* Safely change the mode bits in the ECR */
131 static int change_mode(struct parport
*pp
, int m
)
133 struct parport_uss720_private
*priv
= pp
->private_data
;
136 if (get_1284_register(pp
, 6, NULL
))
138 /* Bits <7:5> contain the mode. */
139 mode
= (priv
->reg
[2] >> 5) & 0x7;
142 /* We have to go through mode 000 or 001 */
143 if (mode
> ECR_PS2
&& m
> ECR_PS2
)
144 if (change_mode(pp
, ECR_PS2
))
147 if (m
<= ECR_PS2
&& !(priv
->reg
[1] & 0x20)) {
148 /* This mode resets the FIFO, so we may
149 * have to wait for it to drain first. */
150 unsigned long expire
= jiffies
+ pp
->physport
->cad
->timeout
;
152 case ECR_PPF
: /* Parallel Port FIFO mode */
153 case ECR_ECP
: /* ECP Parallel Port mode */
156 if (get_1284_register(pp
, 6, NULL
))
158 if (priv
->reg
[2] & 0x01)
160 if (time_after_eq (jiffies
, expire
))
161 /* The FIFO is stuck. */
163 msleep_interruptible(10);
164 if (signal_pending (current
))
170 if (set_1284_register(pp
, 6, m
<< 5))
176 * Clear TIMEOUT BIT in EPP MODE
178 static int clear_epp_timeout(struct parport
*pp
)
182 if (get_1284_register(pp
, 1, &stat
))
191 static int uss720_irq(int usbstatus
, void *buffer
, int len
, void *dev_id
)
193 struct parport
*pp
= (struct parport
*)dev_id
;
194 struct parport_uss720_private
*priv
= pp
->private_data
;
196 if (usbstatus
!= 0 || len
< 4 || !buffer
)
198 memcpy(priv
->reg
, buffer
, 4);
199 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
200 if (priv
->reg
[2] & priv
->reg
[1] & 0x10)
201 parport_generic_irq(0, pp
, NULL
);
206 static void parport_uss720_write_data(struct parport
*pp
, unsigned char d
)
208 set_1284_register(pp
, 0, d
);
211 static unsigned char parport_uss720_read_data(struct parport
*pp
)
215 if (get_1284_register(pp
, 0, &ret
))
220 static void parport_uss720_write_control(struct parport
*pp
, unsigned char d
)
222 struct parport_uss720_private
*priv
= pp
->private_data
;
224 d
= (d
& 0xf) | (priv
->reg
[1] & 0xf0);
225 if (set_1284_register(pp
, 2, d
))
230 static unsigned char parport_uss720_read_control(struct parport
*pp
)
232 struct parport_uss720_private
*priv
= pp
->private_data
;
233 return priv
->reg
[1] & 0xf; /* Use soft copy */
236 static unsigned char parport_uss720_frob_control(struct parport
*pp
, unsigned char mask
, unsigned char val
)
238 struct parport_uss720_private
*priv
= pp
->private_data
;
243 d
= (priv
->reg
[1] & (~mask
)) ^ val
;
244 if (set_1284_register(pp
, 2, d
))
250 static unsigned char parport_uss720_read_status(struct parport
*pp
)
254 if (get_1284_register(pp
, 1, &ret
))
259 static void parport_uss720_disable_irq(struct parport
*pp
)
261 struct parport_uss720_private
*priv
= pp
->private_data
;
264 d
= priv
->reg
[1] & ~0x10;
265 if (set_1284_register(pp
, 2, d
))
270 static void parport_uss720_enable_irq(struct parport
*pp
)
272 struct parport_uss720_private
*priv
= pp
->private_data
;
275 d
= priv
->reg
[1] | 0x10;
276 if (set_1284_register(pp
, 2, d
))
281 static void parport_uss720_data_forward (struct parport
*pp
)
283 struct parport_uss720_private
*priv
= pp
->private_data
;
286 d
= priv
->reg
[1] & ~0x20;
287 if (set_1284_register(pp
, 2, d
))
292 static void parport_uss720_data_reverse (struct parport
*pp
)
294 struct parport_uss720_private
*priv
= pp
->private_data
;
297 d
= priv
->reg
[1] | 0x20;
298 if (set_1284_register(pp
, 2, d
))
303 static void parport_uss720_init_state(struct pardevice
*dev
, struct parport_state
*s
)
305 s
->u
.pc
.ctr
= 0xc | (dev
->irq_func
? 0x10 : 0x0);
309 static void parport_uss720_save_state(struct parport
*pp
, struct parport_state
*s
)
311 struct parport_uss720_private
*priv
= pp
->private_data
;
313 if (get_1284_register(pp
, 2, NULL
))
315 s
->u
.pc
.ctr
= priv
->reg
[1];
316 s
->u
.pc
.ecr
= priv
->reg
[2];
319 static void parport_uss720_restore_state(struct parport
*pp
, struct parport_state
*s
)
321 set_1284_register(pp
, 2, s
->u
.pc
.ctr
);
322 set_1284_register(pp
, 6, s
->u
.pc
.ecr
);
323 get_1284_register(pp
, 2, NULL
);
326 static size_t parport_uss720_epp_read_data(struct parport
*pp
, void *buf
, size_t length
, int flags
)
328 struct parport_uss720_private
*priv
= pp
->private_data
;
331 if (change_mode(pp
, ECR_EPP
))
333 for (; got
< length
; got
++) {
334 if (get_1284_register(pp
, 4, (char *)buf
))
337 if (priv
->reg
[0] & 0x01) {
338 clear_epp_timeout(pp
);
342 change_mode(pp
, ECR_PS2
);
346 static size_t parport_uss720_epp_write_data(struct parport
*pp
, const void *buf
, size_t length
, int flags
)
349 struct parport_uss720_private
*priv
= pp
->private_data
;
352 if (change_mode(pp
, ECR_EPP
))
354 for (; written
< length
; written
++) {
355 if (set_1284_register(pp
, 4, (char *)buf
))
358 if (get_1284_register(pp
, 1, NULL
))
360 if (priv
->reg
[0] & 0x01) {
361 clear_epp_timeout(pp
);
365 change_mode(pp
, ECR_PS2
);
368 struct parport_uss720_private
*priv
= pp
->private_data
;
369 struct usb_device
*usbdev
= priv
->usbdev
;
375 if (change_mode(pp
, ECR_EPP
))
377 i
= usb_bulk_msg(usbdev
, usb_sndbulkpipe(usbdev
, 1), (void *)buf
, length
, &rlen
, 20000);
379 printk(KERN_ERR
"uss720: sendbulk ep 1 buf %p len %Zu rlen %u\n", buf
, length
, rlen
);
380 change_mode(pp
, ECR_PS2
);
385 static size_t parport_uss720_epp_read_addr(struct parport
*pp
, void *buf
, size_t length
, int flags
)
387 struct parport_uss720_private
*priv
= pp
->private_data
;
390 if (change_mode(pp
, ECR_EPP
))
392 for (; got
< length
; got
++) {
393 if (get_1284_register(pp
, 3, (char *)buf
))
396 if (priv
->reg
[0] & 0x01) {
397 clear_epp_timeout(pp
);
401 change_mode(pp
, ECR_PS2
);
405 static size_t parport_uss720_epp_write_addr(struct parport
*pp
, const void *buf
, size_t length
, int flags
)
407 struct parport_uss720_private
*priv
= pp
->private_data
;
410 if (change_mode(pp
, ECR_EPP
))
412 for (; written
< length
; written
++) {
413 if (set_1284_register(pp
, 3, *(char *)buf
))
416 if (get_1284_register(pp
, 1, NULL
))
418 if (priv
->reg
[0] & 0x01) {
419 clear_epp_timeout(pp
);
423 change_mode(pp
, ECR_PS2
);
427 static size_t parport_uss720_ecp_write_data(struct parport
*pp
, const void *buffer
, size_t len
, int flags
)
429 struct parport_uss720_private
*priv
= pp
->private_data
;
430 struct usb_device
*usbdev
= priv
->usbdev
;
436 if (change_mode(pp
, ECR_ECP
))
438 i
= usb_bulk_msg(usbdev
, usb_sndbulkpipe(usbdev
, 1), (void *)buffer
, len
, &rlen
, 20000);
440 printk(KERN_ERR
"uss720: sendbulk ep 1 buf %p len %Zu rlen %u\n", buffer
, len
, rlen
);
441 change_mode(pp
, ECR_PS2
);
445 static size_t parport_uss720_ecp_read_data(struct parport
*pp
, void *buffer
, size_t len
, int flags
)
447 struct parport_uss720_private
*priv
= pp
->private_data
;
448 struct usb_device
*usbdev
= priv
->usbdev
;
454 if (change_mode(pp
, ECR_ECP
))
456 i
= usb_bulk_msg(usbdev
, usb_rcvbulkpipe(usbdev
, 2), buffer
, len
, &rlen
, 20000);
458 printk(KERN_ERR
"uss720: recvbulk ep 2 buf %p len %Zu rlen %u\n", buffer
, len
, rlen
);
459 change_mode(pp
, ECR_PS2
);
463 static size_t parport_uss720_ecp_write_addr(struct parport
*pp
, const void *buffer
, size_t len
, int flags
)
467 if (change_mode(pp
, ECR_ECP
))
469 for (; written
< len
; written
++) {
470 if (set_1284_register(pp
, 5, *(char *)buffer
))
474 change_mode(pp
, ECR_PS2
);
478 static size_t parport_uss720_write_compat(struct parport
*pp
, const void *buffer
, size_t len
, int flags
)
480 struct parport_uss720_private
*priv
= pp
->private_data
;
481 struct usb_device
*usbdev
= priv
->usbdev
;
487 if (change_mode(pp
, ECR_PPF
))
489 i
= usb_bulk_msg(usbdev
, usb_sndbulkpipe(usbdev
, 1), (void *)buffer
, len
, &rlen
, 20000);
491 printk(KERN_ERR
"uss720: sendbulk ep 1 buf %p len %Zu rlen %u\n", buffer
, len
, rlen
);
492 change_mode(pp
, ECR_PS2
);
496 /* --------------------------------------------------------------------- */
498 static struct parport_operations parport_uss720_ops
=
500 .owner
= THIS_MODULE
,
501 .write_data
= parport_uss720_write_data
,
502 .read_data
= parport_uss720_read_data
,
504 .write_control
= parport_uss720_write_control
,
505 .read_control
= parport_uss720_read_control
,
506 .frob_control
= parport_uss720_frob_control
,
508 .read_status
= parport_uss720_read_status
,
510 .enable_irq
= parport_uss720_enable_irq
,
511 .disable_irq
= parport_uss720_disable_irq
,
513 .data_forward
= parport_uss720_data_forward
,
514 .data_reverse
= parport_uss720_data_reverse
,
516 .init_state
= parport_uss720_init_state
,
517 .save_state
= parport_uss720_save_state
,
518 .restore_state
= parport_uss720_restore_state
,
520 .epp_write_data
= parport_uss720_epp_write_data
,
521 .epp_read_data
= parport_uss720_epp_read_data
,
522 .epp_write_addr
= parport_uss720_epp_write_addr
,
523 .epp_read_addr
= parport_uss720_epp_read_addr
,
525 .ecp_write_data
= parport_uss720_ecp_write_data
,
526 .ecp_read_data
= parport_uss720_ecp_read_data
,
527 .ecp_write_addr
= parport_uss720_ecp_write_addr
,
529 .compat_write_data
= parport_uss720_write_compat
,
530 .nibble_read_data
= parport_ieee1284_read_nibble
,
531 .byte_read_data
= parport_ieee1284_read_byte
,
534 /* --------------------------------------------------------------------- */
536 static int uss720_probe(struct usb_interface
*intf
,
537 const struct usb_device_id
*id
)
539 struct usb_device
*usbdev
= interface_to_usbdev(intf
);
540 struct usb_host_interface
*interface
;
541 struct usb_host_endpoint
*endpoint
;
542 struct parport_uss720_private
*priv
;
546 printk(KERN_DEBUG
"uss720: probe: vendor id 0x%x, device id 0x%x\n",
547 le16_to_cpu(usbdev
->descriptor
.idVendor
),
548 le16_to_cpu(usbdev
->descriptor
.idProduct
));
550 /* our known interfaces have 3 alternate settings */
551 if (intf
->num_altsetting
!= 3)
554 i
= usb_set_interface(usbdev
, intf
->altsetting
->desc
.bInterfaceNumber
, 2);
555 printk(KERN_DEBUG
"uss720: set inteface result %d\n", i
);
557 interface
= intf
->cur_altsetting
;
560 * Allocate parport interface
562 printk(KERN_INFO
"uss720: (C) 1999 by Thomas Sailer, <sailer@ife.ee.ethz.ch>\n");
564 if (!(priv
= kmalloc(sizeof(struct parport_uss720_private
), GFP_KERNEL
)))
566 if (!(pp
= parport_register_port(0, PARPORT_IRQ_NONE
, PARPORT_DMA_NONE
, &parport_uss720_ops
))) {
567 printk(KERN_WARNING
"usb-uss720: could not register parport\n");
571 pp
->private_data
= priv
;
572 priv
->usbdev
= usbdev
;
573 pp
->modes
= PARPORT_MODE_PCSPP
| PARPORT_MODE_TRISTATE
| PARPORT_MODE_EPP
| PARPORT_MODE_ECP
| PARPORT_MODE_COMPAT
;
575 /* set the USS720 control register to manual mode, no ECP compression, enable all ints */
576 set_1284_register(pp
, 7, 0x00);
577 set_1284_register(pp
, 6, 0x30); /* PS/2 mode */
578 set_1284_register(pp
, 2, 0x0c);
580 get_1284_register(pp
, 0, NULL
);
581 printk("uss720: reg: %02x %02x %02x %02x %02x %02x %02x\n",
582 priv
->reg
[0], priv
->reg
[1], priv
->reg
[2], priv
->reg
[3], priv
->reg
[4], priv
->reg
[5], priv
->reg
[6]);
584 endpoint
= &interface
->endpoint
[2];
585 printk(KERN_DEBUG
"uss720: epaddr %d interval %d\n", endpoint
->desc
.bEndpointAddress
, endpoint
->desc
.bInterval
);
587 priv
->irqpipe
= usb_rcvctrlpipe(usbdev
, endpoint
->bEndpointAddress
);
588 i
= usb_request_irq(usbdev
, priv
->irqpipe
,
589 uss720_irq
, endpoint
->bInterval
,
590 pp
, &priv
->irqhandle
);
592 printk (KERN_WARNING
"usb-uss720: usb_request_irq failed (0x%x)\n", i
);
593 goto probe_abort_port
;
596 parport_announce_port(pp
);
598 usb_set_intfdata (intf
, pp
);
603 parport_put_port(pp
);
610 static void uss720_disconnect(struct usb_interface
*intf
)
612 struct parport
*pp
= usb_get_intfdata (intf
);
613 struct parport_uss720_private
*priv
;
615 usb_set_intfdata (intf
, NULL
);
617 priv
= pp
->private_data
;
618 parport_remove_port(pp
);
620 usb_release_irq(usbdev
, priv
->irqhandle
, priv
->irqpipe
);
623 parport_put_port(pp
);
628 /* table of cables that work through this driver */
629 static struct usb_device_id uss720_table
[] = {
630 { USB_DEVICE(0x047e, 0x1001) },
631 { USB_DEVICE(0x0557, 0x2001) },
632 { USB_DEVICE(0x0729, 0x1284) },
633 { USB_DEVICE(0x1293, 0x0002) },
634 { } /* Terminating entry */
637 MODULE_DEVICE_TABLE (usb
, uss720_table
);
640 static struct usb_driver uss720_driver
= {
641 .owner
= THIS_MODULE
,
643 .probe
= uss720_probe
,
644 .disconnect
= uss720_disconnect
,
645 .id_table
= uss720_table
,
648 /* --------------------------------------------------------------------- */
650 MODULE_AUTHOR( DRIVER_AUTHOR
);
651 MODULE_DESCRIPTION( DRIVER_DESC
);
652 MODULE_LICENSE("GPL");
654 static int __init
uss720_init(void)
657 retval
= usb_register(&uss720_driver
);
661 info(DRIVER_VERSION
":" DRIVER_DESC
);
666 static void __exit
uss720_cleanup(void)
668 usb_deregister(&uss720_driver
);
671 module_init(uss720_init
);
672 module_exit(uss720_cleanup
);
674 /* --------------------------------------------------------------------- */