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
39 /*****************************************************************************/
41 #include <linux/module.h>
42 #include <linux/socket.h>
43 #include <linux/parport.h>
44 #include <linux/init.h>
45 #include <linux/usb.h>
47 /* --------------------------------------------------------------------- */
49 struct parport_uss720_private
{
50 struct usb_device
*usbdev
;
53 unsigned char reg
[7]; /* USB registers */
56 /* --------------------------------------------------------------------- */
58 static int get_1284_register(struct parport
*pp
, unsigned char reg
, unsigned char *val
)
60 struct parport_uss720_private
*priv
= pp
->private_data
;
61 struct usb_device
*usbdev
= priv
->usbdev
;
62 static const unsigned char regindex
[9] = {
63 4, 0, 1, 5, 5, 0, 2, 3, 6
69 ret
= usb_control_msg(usbdev
, usb_rcvctrlpipe(usbdev
,0), 3, 0xc0, ((unsigned int)reg
) << 8, 0, priv
->reg
, 7, HZ
);
71 printk(KERN_DEBUG
"uss720: get_1284_register(%d) failed, status 0x%x\n",
72 (unsigned int)reg
, ret
);
75 printk(KERN_DEBUG
"uss720: get_1284_register(%d) return %02x %02x %02x %02x %02x %02x %02x\n",
76 (unsigned int)reg
, (unsigned int)priv
->reg
[0], (unsigned int)priv
->reg
[1],
77 (unsigned int)priv
->reg
[2], (unsigned int)priv
->reg
[3], (unsigned int)priv
->reg
[4],
78 (unsigned int)priv
->reg
[5], (unsigned int)priv
->reg
[6]);
80 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
81 if (priv
->reg
[2] & priv
->reg
[1] & 0x10)
82 parport_generic_irq(0, pp
, NULL
);
85 *val
= priv
->reg
[(reg
>= 9) ? 0 : regindex
[reg
]];
89 static int set_1284_register(struct parport
*pp
, unsigned char reg
, unsigned char val
)
91 struct parport_uss720_private
*priv
= pp
->private_data
;
92 struct usb_device
*usbdev
= priv
->usbdev
;
97 ret
= usb_control_msg(usbdev
, usb_sndctrlpipe(usbdev
,0), 4, 0x40, (((unsigned int)reg
) << 8) | val
, 0, NULL
, 0, HZ
);
99 printk(KERN_DEBUG
"uss720: set_1284_register(%u,0x%02x) failed, status 0x%x\n",
100 (unsigned int)reg
, (unsigned int)val
, ret
);
103 printk(KERN_DEBUG
"uss720: set_1284_register(%u,0x%02x)\n",
104 (unsigned int)reg
, (unsigned int)val
);
110 /* --------------------------------------------------------------------- */
119 /* Safely change the mode bits in the ECR */
120 static int change_mode(struct parport
*pp
, int m
)
122 struct parport_uss720_private
*priv
= pp
->private_data
;
125 if (get_1284_register(pp
, 6, NULL
))
127 /* Bits <7:5> contain the mode. */
128 mode
= (priv
->reg
[2] >> 5) & 0x7;
131 /* We have to go through mode 000 or 001 */
132 if (mode
> ECR_PS2
&& m
> ECR_PS2
)
133 if (change_mode(pp
, ECR_PS2
))
136 if (m
<= ECR_PS2
&& !(priv
->reg
[1] & 0x20)) {
137 /* This mode resets the FIFO, so we may
138 * have to wait for it to drain first. */
139 long expire
= jiffies
+ pp
->physport
->cad
->timeout
;
141 case ECR_PPF
: /* Parallel Port FIFO mode */
142 case ECR_ECP
: /* ECP Parallel Port mode */
145 if (get_1284_register(pp
, 6, NULL
))
147 if (priv
->reg
[2] & 0x01)
149 if (time_after_eq (jiffies
, expire
))
150 /* The FIFO is stuck. */
152 current
->state
= TASK_INTERRUPTIBLE
;
153 schedule_timeout((HZ
+ 99) / 100);
154 if (signal_pending (current
))
160 if (set_1284_register(pp
, 6, m
<< 5))
166 * Clear TIMEOUT BIT in EPP MODE
168 static int clear_epp_timeout(struct parport
*pp
)
172 if (get_1284_register(pp
, 1, &stat
))
181 static int uss720_irq(int usbstatus
, void *buffer
, int len
, void *dev_id
)
183 struct parport
*pp
= (struct parport
*)dev_id
;
184 struct parport_uss720_private
*priv
= pp
->private_data
;
186 if (usbstatus
!= USB_ST_NOERROR
|| len
< 4 || !buffer
)
188 memcpy(priv
->reg
, buffer
, 4);
189 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
190 if (priv
->reg
[2] & priv
->reg
[1] & 0x10)
191 parport_generic_irq(0, pp
, NULL
);
196 static void parport_uss720_write_data(struct parport
*pp
, unsigned char d
)
198 set_1284_register(pp
, 0, d
);
201 static unsigned char parport_uss720_read_data(struct parport
*pp
)
205 if (get_1284_register(pp
, 0, &ret
))
210 static void parport_uss720_write_control(struct parport
*pp
, unsigned char d
)
212 struct parport_uss720_private
*priv
= pp
->private_data
;
214 d
= (d
& 0xf) | (priv
->reg
[1] & 0xf0);
215 if (set_1284_register(pp
, 2, d
))
220 static unsigned char parport_uss720_read_control(struct parport
*pp
)
222 struct parport_uss720_private
*priv
= pp
->private_data
;
223 return priv
->reg
[1] & 0xf; /* Use soft copy */
226 static unsigned char parport_uss720_frob_control(struct parport
*pp
, unsigned char mask
, unsigned char val
)
228 struct parport_uss720_private
*priv
= pp
->private_data
;
233 d
= (priv
->reg
[1] & (~mask
)) ^ val
;
234 if (set_1284_register(pp
, 2, d
))
240 static unsigned char parport_uss720_read_status(struct parport
*pp
)
244 if (get_1284_register(pp
, 1, &ret
))
249 static void parport_uss720_disable_irq(struct parport
*pp
)
251 struct parport_uss720_private
*priv
= pp
->private_data
;
254 d
= priv
->reg
[1] & ~0x10;
255 if (set_1284_register(pp
, 2, d
))
260 static void parport_uss720_enable_irq(struct parport
*pp
)
262 struct parport_uss720_private
*priv
= pp
->private_data
;
265 d
= priv
->reg
[1] | 0x10;
266 if (set_1284_register(pp
, 2, d
))
271 static void parport_uss720_data_forward (struct parport
*pp
)
273 struct parport_uss720_private
*priv
= pp
->private_data
;
276 d
= priv
->reg
[1] & ~0x20;
277 if (set_1284_register(pp
, 2, d
))
282 static void parport_uss720_data_reverse (struct parport
*pp
)
284 struct parport_uss720_private
*priv
= pp
->private_data
;
287 d
= priv
->reg
[1] | 0x20;
288 if (set_1284_register(pp
, 2, d
))
293 static void parport_uss720_init_state(struct pardevice
*dev
, struct parport_state
*s
)
295 s
->u
.pc
.ctr
= 0xc | (dev
->irq_func
? 0x10 : 0x0);
299 static void parport_uss720_save_state(struct parport
*pp
, struct parport_state
*s
)
301 struct parport_uss720_private
*priv
= pp
->private_data
;
303 if (get_1284_register(pp
, 2, NULL
))
305 s
->u
.pc
.ctr
= priv
->reg
[1];
306 s
->u
.pc
.ecr
= priv
->reg
[2];
309 static void parport_uss720_restore_state(struct parport
*pp
, struct parport_state
*s
)
311 set_1284_register(pp
, 2, s
->u
.pc
.ctr
);
312 set_1284_register(pp
, 6, s
->u
.pc
.ecr
);
313 get_1284_register(pp
, 2, NULL
);
316 static size_t parport_uss720_epp_read_data(struct parport
*pp
, void *buf
, size_t length
, int flags
)
318 struct parport_uss720_private
*priv
= pp
->private_data
;
321 if (change_mode(pp
, ECR_EPP
))
323 for (; got
< length
; got
++) {
324 if (get_1284_register(pp
, 4, (char *)buf
))
327 if (priv
->reg
[0] & 0x01) {
328 clear_epp_timeout(pp
);
332 change_mode(pp
, ECR_PS2
);
336 static size_t parport_uss720_epp_write_data(struct parport
*pp
, const void *buf
, size_t length
, int flags
)
339 struct parport_uss720_private
*priv
= pp
->private_data
;
342 if (change_mode(pp
, ECR_EPP
))
344 for (; written
< length
; written
++) {
345 if (set_1284_register(pp
, 4, (char *)buf
))
348 if (get_1284_register(pp
, 1, NULL
))
350 if (priv
->reg
[0] & 0x01) {
351 clear_epp_timeout(pp
);
355 change_mode(pp
, ECR_PS2
);
358 struct parport_uss720_private
*priv
= pp
->private_data
;
359 struct usb_device
*usbdev
= priv
->usbdev
;
365 if (change_mode(pp
, ECR_EPP
))
367 i
= usb_bulk_msg(usbdev
, usb_sndbulkpipe(usbdev
, 1), (void *)buf
, length
, &rlen
, HZ
*20);
369 printk(KERN_ERR
"uss720: sendbulk ep 1 buf %p len %u rlen %u\n", buf
, length
, rlen
);
370 change_mode(pp
, ECR_PS2
);
375 static size_t parport_uss720_epp_read_addr(struct parport
*pp
, void *buf
, size_t length
, int flags
)
377 struct parport_uss720_private
*priv
= pp
->private_data
;
380 if (change_mode(pp
, ECR_EPP
))
382 for (; got
< length
; got
++) {
383 if (get_1284_register(pp
, 3, (char *)buf
))
386 if (priv
->reg
[0] & 0x01) {
387 clear_epp_timeout(pp
);
391 change_mode(pp
, ECR_PS2
);
395 static size_t parport_uss720_epp_write_addr(struct parport
*pp
, const void *buf
, size_t length
, int flags
)
397 struct parport_uss720_private
*priv
= pp
->private_data
;
400 if (change_mode(pp
, ECR_EPP
))
402 for (; written
< length
; written
++) {
403 if (set_1284_register(pp
, 3, *(char *)buf
))
406 if (get_1284_register(pp
, 1, NULL
))
408 if (priv
->reg
[0] & 0x01) {
409 clear_epp_timeout(pp
);
413 change_mode(pp
, ECR_PS2
);
417 static size_t parport_uss720_ecp_write_data(struct parport
*pp
, const void *buffer
, size_t len
, int flags
)
419 struct parport_uss720_private
*priv
= pp
->private_data
;
420 struct usb_device
*usbdev
= priv
->usbdev
;
426 if (change_mode(pp
, ECR_ECP
))
428 i
= usb_bulk_msg(usbdev
, usb_sndbulkpipe(usbdev
, 1), (void *)buffer
, len
, &rlen
, HZ
*20);
430 printk(KERN_ERR
"uss720: sendbulk ep 1 buf %p len %u rlen %u\n", buffer
, len
, rlen
);
431 change_mode(pp
, ECR_PS2
);
435 static size_t parport_uss720_ecp_read_data(struct parport
*pp
, void *buffer
, size_t len
, int flags
)
437 struct parport_uss720_private
*priv
= pp
->private_data
;
438 struct usb_device
*usbdev
= priv
->usbdev
;
444 if (change_mode(pp
, ECR_ECP
))
446 i
= usb_bulk_msg(usbdev
, usb_rcvbulkpipe(usbdev
, 2), buffer
, len
, &rlen
, HZ
*20);
448 printk(KERN_ERR
"uss720: recvbulk ep 2 buf %p len %u rlen %u\n", buffer
, len
, rlen
);
449 change_mode(pp
, ECR_PS2
);
453 static size_t parport_uss720_ecp_write_addr(struct parport
*pp
, const void *buffer
, size_t len
, int flags
)
457 if (change_mode(pp
, ECR_ECP
))
459 for (; written
< len
; written
++) {
460 if (set_1284_register(pp
, 5, *(char *)buffer
))
464 change_mode(pp
, ECR_PS2
);
468 static size_t parport_uss720_write_compat(struct parport
*pp
, const void *buffer
, size_t len
, int flags
)
470 struct parport_uss720_private
*priv
= pp
->private_data
;
471 struct usb_device
*usbdev
= priv
->usbdev
;
477 if (change_mode(pp
, ECR_PPF
))
479 i
= usb_bulk_msg(usbdev
, usb_sndbulkpipe(usbdev
, 1), (void *)buffer
, len
, &rlen
, HZ
*20);
481 printk(KERN_ERR
"uss720: sendbulk ep 1 buf %p len %u rlen %u\n", buffer
, len
, rlen
);
482 change_mode(pp
, ECR_PS2
);
486 void parport_uss720_inc_use_count(void)
491 void parport_uss720_dec_use_count(void)
496 /* --------------------------------------------------------------------- */
498 static struct parport_operations parport_uss720_ops
=
500 parport_uss720_write_data
,
501 parport_uss720_read_data
,
503 parport_uss720_write_control
,
504 parport_uss720_read_control
,
505 parport_uss720_frob_control
,
507 parport_uss720_read_status
,
509 parport_uss720_enable_irq
,
510 parport_uss720_disable_irq
,
512 parport_uss720_data_forward
,
513 parport_uss720_data_reverse
,
515 parport_uss720_init_state
,
516 parport_uss720_save_state
,
517 parport_uss720_restore_state
,
519 parport_uss720_inc_use_count
,
520 parport_uss720_dec_use_count
,
522 parport_uss720_epp_write_data
,
523 parport_uss720_epp_read_data
,
524 parport_uss720_epp_write_addr
,
525 parport_uss720_epp_read_addr
,
527 parport_uss720_ecp_write_data
,
528 parport_uss720_ecp_read_data
,
529 parport_uss720_ecp_write_addr
,
531 parport_uss720_write_compat
,
532 parport_ieee1284_read_nibble
,
533 parport_ieee1284_read_byte
,
536 /* --------------------------------------------------------------------- */
538 static void * uss720_probe(struct usb_device
*usbdev
, unsigned int ifnum
,
539 const struct usb_device_id
*id
)
541 struct usb_interface_descriptor
*interface
;
542 struct usb_endpoint_descriptor
*endpoint
;
543 struct parport_uss720_private
*priv
;
547 printk(KERN_DEBUG
"uss720: probe: vendor id 0x%x, device id 0x%x\n",
548 usbdev
->descriptor
.idVendor
, usbdev
->descriptor
.idProduct
);
550 /* our known interfaces have 3 alternate settings */
551 if (usbdev
->actconfig
->interface
[ifnum
].num_altsetting
!= 3)
554 i
= usb_set_interface(usbdev
, ifnum
, 2);
555 printk(KERN_DEBUG
"uss720: set inteface result %d\n", i
);
557 interface
= &usbdev
->actconfig
->interface
[ifnum
].altsetting
[2];
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
->bEndpointAddress
, endpoint
->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_proc_register(pp
);
597 parport_announce_port(pp
);
604 parport_unregister_port(pp
);
611 static void uss720_disconnect(struct usb_device
*usbdev
, void *ptr
)
613 struct parport
*pp
= (struct parport
*)ptr
;
614 struct parport_uss720_private
*priv
= pp
->private_data
;
617 usb_release_irq(usbdev
, priv
->irqhandle
, priv
->irqpipe
);
620 parport_proc_unregister(pp
);
621 parport_unregister_port(pp
);
626 /* table of cables that work through this driver */
627 static struct usb_device_id uss720_table
[] = {
628 { idVendor
: 0x047e, idProduct
: 0x1001},
629 { idVendor
: 0x0557, idProduct
: 0x2001},
630 { idVendor
: 0x0729, idProduct
: 0x1284},
631 { } /* Terminating entry */
634 MODULE_DEVICE_TABLE (usb
, uss720_table
);
637 static struct usb_driver uss720_driver
= {
640 disconnect
: uss720_disconnect
,
641 id_table
: uss720_table
,
644 /* --------------------------------------------------------------------- */
646 MODULE_AUTHOR("Thomas M. Sailer, sailer@ife.ee.ethz.ch");
647 MODULE_DESCRIPTION("USB Parport Cable driver for Cables using the Lucent Technologies USS720 Chip");
649 static int __init
uss720_init(void)
651 if (usb_register(&uss720_driver
) < 0)
654 printk(KERN_INFO
"uss720: USB<->IEEE1284 cable driver v0.4 registered.\n"
655 KERN_INFO
"uss720: (C) 1999 by Thomas Sailer, <sailer@ife.ee.ethz.ch>\n");
659 static void __exit
uss720_cleanup(void)
661 usb_deregister(&uss720_driver
);
664 module_init(uss720_init
);
665 module_exit(uss720_cleanup
);
667 /* --------------------------------------------------------------------- */