1 /*****************************************************************************/
4 * uss720.c -- USS720 USB Parport Cable.
6 * Copyright (C) 1999, 2005
7 * Thomas Sailer (t.sailer@alumni.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.1999 Created
27 * 0.2 07.08.1999 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.1999 fixing merge errors
33 * 0.4 13.08.1999 Added Vendor/Product ID of Brad Hard's cable
34 * 0.5 20.09.1999 usb_control_msg wrapper used
35 * Nov01.2000 usb_device_table support by Adam J. Richter
36 * 08.04.2001 Identify version on module load. gb
37 * 0.6 02.09.2005 Fix "scheduling in interrupt" problem by making save/restore
38 * context asynchronous
42 /*****************************************************************************/
44 #include <linux/module.h>
45 #include <linux/socket.h>
46 #include <linux/parport.h>
47 #include <linux/init.h>
48 #include <linux/usb.h>
49 #include <linux/delay.h>
50 #include <linux/completion.h>
51 #include <linux/kref.h>
52 #include <linux/slab.h>
57 #define DRIVER_VERSION "v0.6"
58 #define DRIVER_AUTHOR "Thomas M. Sailer, t.sailer@alumni.ethz.ch"
59 #define DRIVER_DESC "USB Parport Cable driver for Cables using the Lucent Technologies USS720 Chip"
61 /* --------------------------------------------------------------------- */
63 struct parport_uss720_private {
64 struct usb_device *usbdev;
66 struct kref ref_count;
67 __u8 reg[7]; /* USB registers */
68 struct list_head asynclist;
72 struct uss720_async_request {
73 struct parport_uss720_private *priv;
74 struct kref ref_count;
75 struct list_head asynclist;
76 struct completion compl;
78 struct usb_ctrlrequest dr;
82 /* --------------------------------------------------------------------- */
84 static void destroy_priv(struct kref *kref)
86 struct parport_uss720_private *priv = container_of(kref, struct parport_uss720_private, ref_count);
88 usb_put_dev(priv->usbdev);
90 dbg("destroying priv datastructure");
93 static void destroy_async(struct kref *kref)
95 struct uss720_async_request *rq = container_of(kref, struct uss720_async_request, ref_count);
96 struct parport_uss720_private *priv = rq->priv;
100 usb_free_urb(rq->urb);
101 spin_lock_irqsave(&priv->asynclock, flags);
102 list_del_init(&rq->asynclist);
103 spin_unlock_irqrestore(&priv->asynclock, flags);
105 kref_put(&priv->ref_count, destroy_priv);
108 /* --------------------------------------------------------------------- */
110 static void async_complete(struct urb *urb)
112 struct uss720_async_request *rq;
114 struct parport_uss720_private *priv;
115 int status = urb->status;
121 err("async_complete: urb error %d", status);
122 } else if (rq->dr.bRequest == 3) {
123 memcpy(priv->reg, rq->reg, sizeof(priv->reg));
125 dbg("async_complete regs %02x %02x %02x %02x %02x %02x %02x",
126 (unsigned int)priv->reg[0], (unsigned int)priv->reg[1], (unsigned int)priv->reg[2],
127 (unsigned int)priv->reg[3], (unsigned int)priv->reg[4], (unsigned int)priv->reg[5],
128 (unsigned int)priv->reg[6]);
130 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
131 if (rq->reg[2] & rq->reg[1] & 0x10 && pp)
132 parport_generic_irq(pp);
134 complete(&rq->compl);
135 kref_put(&rq->ref_count, destroy_async);
138 static struct uss720_async_request *submit_async_request(struct parport_uss720_private *priv,
139 __u8 request, __u8 requesttype, __u16 value, __u16 index,
142 struct usb_device *usbdev;
143 struct uss720_async_request *rq;
149 usbdev = priv->usbdev;
152 rq = kmalloc(sizeof(struct uss720_async_request), mem_flags);
154 err("submit_async_request out of memory");
157 kref_init(&rq->ref_count);
158 INIT_LIST_HEAD(&rq->asynclist);
159 init_completion(&rq->compl);
160 kref_get(&priv->ref_count);
162 rq->urb = usb_alloc_urb(0, mem_flags);
164 kref_put(&rq->ref_count, destroy_async);
165 err("submit_async_request out of memory");
168 rq->dr.bRequestType = requesttype;
169 rq->dr.bRequest = request;
170 rq->dr.wValue = cpu_to_le16(value);
171 rq->dr.wIndex = cpu_to_le16(index);
172 rq->dr.wLength = cpu_to_le16((request == 3) ? sizeof(rq->reg) : 0);
173 usb_fill_control_urb(rq->urb, usbdev, (requesttype & 0x80) ? usb_rcvctrlpipe(usbdev, 0) : usb_sndctrlpipe(usbdev, 0),
174 (unsigned char *)&rq->dr,
175 (request == 3) ? rq->reg : NULL, (request == 3) ? sizeof(rq->reg) : 0, async_complete, rq);
176 /* rq->urb->transfer_flags |= URB_ASYNC_UNLINK; */
177 spin_lock_irqsave(&priv->asynclock, flags);
178 list_add_tail(&rq->asynclist, &priv->asynclist);
179 spin_unlock_irqrestore(&priv->asynclock, flags);
180 ret = usb_submit_urb(rq->urb, mem_flags);
182 kref_get(&rq->ref_count);
185 kref_put(&rq->ref_count, destroy_async);
186 err("submit_async_request submit_urb failed with %d", ret);
190 static unsigned int kill_all_async_requests_priv(struct parport_uss720_private *priv)
192 struct uss720_async_request *rq;
194 unsigned int ret = 0;
196 spin_lock_irqsave(&priv->asynclock, flags);
197 list_for_each_entry(rq, &priv->asynclist, asynclist) {
198 usb_unlink_urb(rq->urb);
201 spin_unlock_irqrestore(&priv->asynclock, flags);
205 /* --------------------------------------------------------------------- */
207 static int get_1284_register(struct parport *pp, unsigned char reg, unsigned char *val, gfp_t mem_flags)
209 struct parport_uss720_private *priv;
210 struct uss720_async_request *rq;
211 static const unsigned char regindex[9] = {
212 4, 0, 1, 5, 5, 0, 2, 3, 6
218 priv = pp->private_data;
219 rq = submit_async_request(priv, 3, 0xc0, ((unsigned int)reg) << 8, 0, mem_flags);
221 err("get_1284_register(%u) failed", (unsigned int)reg);
225 kref_put(&rq->ref_count, destroy_async);
228 if (wait_for_completion_timeout(&rq->compl, HZ)) {
229 ret = rq->urb->status;
230 *val = priv->reg[(reg >= 9) ? 0 : regindex[reg]];
232 printk(KERN_WARNING "get_1284_register: "
233 "usb error %d\n", ret);
234 kref_put(&rq->ref_count, destroy_async);
237 printk(KERN_WARNING "get_1284_register timeout\n");
238 kill_all_async_requests_priv(priv);
242 static int set_1284_register(struct parport *pp, unsigned char reg, unsigned char val, gfp_t mem_flags)
244 struct parport_uss720_private *priv;
245 struct uss720_async_request *rq;
249 priv = pp->private_data;
250 rq = submit_async_request(priv, 4, 0x40, (((unsigned int)reg) << 8) | val, 0, mem_flags);
252 err("set_1284_register(%u,%u) failed", (unsigned int)reg, (unsigned int)val);
255 kref_put(&rq->ref_count, destroy_async);
259 /* --------------------------------------------------------------------- */
268 /* Safely change the mode bits in the ECR */
269 static int change_mode(struct parport *pp, int m)
271 struct parport_uss720_private *priv = pp->private_data;
275 if (get_1284_register(pp, 6, ®, GFP_KERNEL))
277 /* Bits <7:5> contain the mode. */
278 mode = (priv->reg[2] >> 5) & 0x7;
281 /* We have to go through mode 000 or 001 */
282 if (mode > ECR_PS2 && m > ECR_PS2)
283 if (change_mode(pp, ECR_PS2))
286 if (m <= ECR_PS2 && !(priv->reg[1] & 0x20)) {
287 /* This mode resets the FIFO, so we may
288 * have to wait for it to drain first. */
289 unsigned long expire = jiffies + pp->physport->cad->timeout;
291 case ECR_PPF: /* Parallel Port FIFO mode */
292 case ECR_ECP: /* ECP Parallel Port mode */
295 if (get_1284_register(pp, 6, ®, GFP_KERNEL))
297 if (priv->reg[2] & 0x01)
299 if (time_after_eq (jiffies, expire))
300 /* The FIFO is stuck. */
302 msleep_interruptible(10);
303 if (signal_pending (current))
309 if (set_1284_register(pp, 6, m << 5, GFP_KERNEL))
311 if (get_1284_register(pp, 6, ®, GFP_KERNEL))
317 * Clear TIMEOUT BIT in EPP MODE
319 static int clear_epp_timeout(struct parport *pp)
323 if (get_1284_register(pp, 1, &stat, GFP_KERNEL))
332 static int uss720_irq(int usbstatus, void *buffer, int len, void *dev_id)
334 struct parport *pp = (struct parport *)dev_id;
335 struct parport_uss720_private *priv = pp->private_data;
337 if (usbstatus != 0 || len < 4 || !buffer)
339 memcpy(priv->reg, buffer, 4);
340 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
341 if (priv->reg[2] & priv->reg[1] & 0x10)
342 parport_generic_irq(pp);
347 static void parport_uss720_write_data(struct parport *pp, unsigned char d)
349 set_1284_register(pp, 0, d, GFP_KERNEL);
352 static unsigned char parport_uss720_read_data(struct parport *pp)
356 if (get_1284_register(pp, 0, &ret, GFP_KERNEL))
361 static void parport_uss720_write_control(struct parport *pp, unsigned char d)
363 struct parport_uss720_private *priv = pp->private_data;
365 d = (d & 0xf) | (priv->reg[1] & 0xf0);
366 if (set_1284_register(pp, 2, d, GFP_KERNEL))
371 static unsigned char parport_uss720_read_control(struct parport *pp)
373 struct parport_uss720_private *priv = pp->private_data;
374 return priv->reg[1] & 0xf; /* Use soft copy */
377 static unsigned char parport_uss720_frob_control(struct parport *pp, unsigned char mask, unsigned char val)
379 struct parport_uss720_private *priv = pp->private_data;
384 d = (priv->reg[1] & (~mask)) ^ val;
385 if (set_1284_register(pp, 2, d, GFP_KERNEL))
391 static unsigned char parport_uss720_read_status(struct parport *pp)
395 if (get_1284_register(pp, 1, &ret, GFP_KERNEL))
400 static void parport_uss720_disable_irq(struct parport *pp)
402 struct parport_uss720_private *priv = pp->private_data;
405 d = priv->reg[1] & ~0x10;
406 if (set_1284_register(pp, 2, d, GFP_KERNEL))
411 static void parport_uss720_enable_irq(struct parport *pp)
413 struct parport_uss720_private *priv = pp->private_data;
416 d = priv->reg[1] | 0x10;
417 if (set_1284_register(pp, 2, d, GFP_KERNEL))
422 static void parport_uss720_data_forward (struct parport *pp)
424 struct parport_uss720_private *priv = pp->private_data;
427 d = priv->reg[1] & ~0x20;
428 if (set_1284_register(pp, 2, d, GFP_KERNEL))
433 static void parport_uss720_data_reverse (struct parport *pp)
435 struct parport_uss720_private *priv = pp->private_data;
438 d = priv->reg[1] | 0x20;
439 if (set_1284_register(pp, 2, d, GFP_KERNEL))
444 static void parport_uss720_init_state(struct pardevice *dev, struct parport_state *s)
446 s->u.pc.ctr = 0xc | (dev->irq_func ? 0x10 : 0x0);
450 static void parport_uss720_save_state(struct parport *pp, struct parport_state *s)
452 struct parport_uss720_private *priv = pp->private_data;
455 if (get_1284_register(pp, 2, NULL, GFP_ATOMIC))
458 s->u.pc.ctr = priv->reg[1];
459 s->u.pc.ecr = priv->reg[2];
462 static void parport_uss720_restore_state(struct parport *pp, struct parport_state *s)
464 struct parport_uss720_private *priv = pp->private_data;
466 set_1284_register(pp, 2, s->u.pc.ctr, GFP_ATOMIC);
467 set_1284_register(pp, 6, s->u.pc.ecr, GFP_ATOMIC);
468 get_1284_register(pp, 2, NULL, GFP_ATOMIC);
469 priv->reg[1] = s->u.pc.ctr;
470 priv->reg[2] = s->u.pc.ecr;
473 static size_t parport_uss720_epp_read_data(struct parport *pp, void *buf, size_t length, int flags)
475 struct parport_uss720_private *priv = pp->private_data;
478 if (change_mode(pp, ECR_EPP))
480 for (; got < length; got++) {
481 if (get_1284_register(pp, 4, (char *)buf, GFP_KERNEL))
484 if (priv->reg[0] & 0x01) {
485 clear_epp_timeout(pp);
489 change_mode(pp, ECR_PS2);
493 static size_t parport_uss720_epp_write_data(struct parport *pp, const void *buf, size_t length, int flags)
496 struct parport_uss720_private *priv = pp->private_data;
499 if (change_mode(pp, ECR_EPP))
501 for (; written < length; written++) {
502 if (set_1284_register(pp, 4, (char *)buf, GFP_KERNEL))
505 if (get_1284_register(pp, 1, NULL, GFP_KERNEL))
507 if (priv->reg[0] & 0x01) {
508 clear_epp_timeout(pp);
512 change_mode(pp, ECR_PS2);
515 struct parport_uss720_private *priv = pp->private_data;
516 struct usb_device *usbdev = priv->usbdev;
522 if (change_mode(pp, ECR_EPP))
524 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buf, length, &rlen, 20000);
526 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %Zu rlen %u\n", buf, length, rlen);
527 change_mode(pp, ECR_PS2);
532 static size_t parport_uss720_epp_read_addr(struct parport *pp, void *buf, size_t length, int flags)
534 struct parport_uss720_private *priv = pp->private_data;
537 if (change_mode(pp, ECR_EPP))
539 for (; got < length; got++) {
540 if (get_1284_register(pp, 3, (char *)buf, GFP_KERNEL))
543 if (priv->reg[0] & 0x01) {
544 clear_epp_timeout(pp);
548 change_mode(pp, ECR_PS2);
552 static size_t parport_uss720_epp_write_addr(struct parport *pp, const void *buf, size_t length, int flags)
554 struct parport_uss720_private *priv = pp->private_data;
557 if (change_mode(pp, ECR_EPP))
559 for (; written < length; written++) {
560 if (set_1284_register(pp, 3, *(char *)buf, GFP_KERNEL))
563 if (get_1284_register(pp, 1, NULL, GFP_KERNEL))
565 if (priv->reg[0] & 0x01) {
566 clear_epp_timeout(pp);
570 change_mode(pp, ECR_PS2);
574 static size_t parport_uss720_ecp_write_data(struct parport *pp, const void *buffer, size_t len, int flags)
576 struct parport_uss720_private *priv = pp->private_data;
577 struct usb_device *usbdev = priv->usbdev;
583 if (change_mode(pp, ECR_ECP))
585 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buffer, len, &rlen, 20000);
587 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %Zu rlen %u\n", buffer, len, rlen);
588 change_mode(pp, ECR_PS2);
592 static size_t parport_uss720_ecp_read_data(struct parport *pp, void *buffer, size_t len, int flags)
594 struct parport_uss720_private *priv = pp->private_data;
595 struct usb_device *usbdev = priv->usbdev;
601 if (change_mode(pp, ECR_ECP))
603 i = usb_bulk_msg(usbdev, usb_rcvbulkpipe(usbdev, 2), buffer, len, &rlen, 20000);
605 printk(KERN_ERR "uss720: recvbulk ep 2 buf %p len %Zu rlen %u\n", buffer, len, rlen);
606 change_mode(pp, ECR_PS2);
610 static size_t parport_uss720_ecp_write_addr(struct parport *pp, const void *buffer, size_t len, int flags)
614 if (change_mode(pp, ECR_ECP))
616 for (; written < len; written++) {
617 if (set_1284_register(pp, 5, *(char *)buffer, GFP_KERNEL))
621 change_mode(pp, ECR_PS2);
625 static size_t parport_uss720_write_compat(struct parport *pp, const void *buffer, size_t len, int flags)
627 struct parport_uss720_private *priv = pp->private_data;
628 struct usb_device *usbdev = priv->usbdev;
634 if (change_mode(pp, ECR_PPF))
636 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buffer, len, &rlen, 20000);
638 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %Zu rlen %u\n", buffer, len, rlen);
639 change_mode(pp, ECR_PS2);
643 /* --------------------------------------------------------------------- */
645 static struct parport_operations parport_uss720_ops =
647 .owner = THIS_MODULE,
648 .write_data = parport_uss720_write_data,
649 .read_data = parport_uss720_read_data,
651 .write_control = parport_uss720_write_control,
652 .read_control = parport_uss720_read_control,
653 .frob_control = parport_uss720_frob_control,
655 .read_status = parport_uss720_read_status,
657 .enable_irq = parport_uss720_enable_irq,
658 .disable_irq = parport_uss720_disable_irq,
660 .data_forward = parport_uss720_data_forward,
661 .data_reverse = parport_uss720_data_reverse,
663 .init_state = parport_uss720_init_state,
664 .save_state = parport_uss720_save_state,
665 .restore_state = parport_uss720_restore_state,
667 .epp_write_data = parport_uss720_epp_write_data,
668 .epp_read_data = parport_uss720_epp_read_data,
669 .epp_write_addr = parport_uss720_epp_write_addr,
670 .epp_read_addr = parport_uss720_epp_read_addr,
672 .ecp_write_data = parport_uss720_ecp_write_data,
673 .ecp_read_data = parport_uss720_ecp_read_data,
674 .ecp_write_addr = parport_uss720_ecp_write_addr,
676 .compat_write_data = parport_uss720_write_compat,
677 .nibble_read_data = parport_ieee1284_read_nibble,
678 .byte_read_data = parport_ieee1284_read_byte,
681 /* --------------------------------------------------------------------- */
683 static int uss720_probe(struct usb_interface *intf,
684 const struct usb_device_id *id)
686 struct usb_device *usbdev = usb_get_dev(interface_to_usbdev(intf));
687 struct usb_host_interface *interface;
688 struct usb_host_endpoint *endpoint;
689 struct parport_uss720_private *priv;
694 dbg("probe: vendor id 0x%x, device id 0x%x\n",
695 le16_to_cpu(usbdev->descriptor.idVendor),
696 le16_to_cpu(usbdev->descriptor.idProduct));
698 /* our known interfaces have 3 alternate settings */
699 if (intf->num_altsetting != 3) {
703 i = usb_set_interface(usbdev, intf->altsetting->desc.bInterfaceNumber, 2);
704 dbg("set inteface result %d", i);
706 interface = intf->cur_altsetting;
709 * Allocate parport interface
711 if (!(priv = kzalloc(sizeof(struct parport_uss720_private), GFP_KERNEL))) {
716 priv->usbdev = usbdev;
717 kref_init(&priv->ref_count);
718 spin_lock_init(&priv->asynclock);
719 INIT_LIST_HEAD(&priv->asynclist);
720 if (!(pp = parport_register_port(0, PARPORT_IRQ_NONE, PARPORT_DMA_NONE, &parport_uss720_ops))) {
721 printk(KERN_WARNING "uss720: could not register parport\n");
726 pp->private_data = priv;
727 pp->modes = PARPORT_MODE_PCSPP | PARPORT_MODE_TRISTATE | PARPORT_MODE_EPP | PARPORT_MODE_ECP | PARPORT_MODE_COMPAT;
729 /* set the USS720 control register to manual mode, no ECP compression, enable all ints */
730 set_1284_register(pp, 7, 0x00, GFP_KERNEL);
731 set_1284_register(pp, 6, 0x30, GFP_KERNEL); /* PS/2 mode */
732 set_1284_register(pp, 2, 0x0c, GFP_KERNEL);
734 get_1284_register(pp, 0, ®, GFP_KERNEL);
735 dbg("reg: %02x %02x %02x %02x %02x %02x %02x",
736 priv->reg[0], priv->reg[1], priv->reg[2], priv->reg[3], priv->reg[4], priv->reg[5], priv->reg[6]);
738 endpoint = &interface->endpoint[2];
739 dbg("epaddr %d interval %d", endpoint->desc.bEndpointAddress, endpoint->desc.bInterval);
740 parport_announce_port(pp);
742 usb_set_intfdata(intf, pp);
746 kill_all_async_requests_priv(priv);
747 kref_put(&priv->ref_count, destroy_priv);
751 static void uss720_disconnect(struct usb_interface *intf)
753 struct parport *pp = usb_get_intfdata(intf);
754 struct parport_uss720_private *priv;
755 struct usb_device *usbdev;
758 usb_set_intfdata(intf, NULL);
760 priv = pp->private_data;
761 usbdev = priv->usbdev;
764 dbg("parport_remove_port");
765 parport_remove_port(pp);
766 parport_put_port(pp);
767 kill_all_async_requests_priv(priv);
768 kref_put(&priv->ref_count, destroy_priv);
770 dbg("disconnect done");
773 /* table of cables that work through this driver */
774 static const struct usb_device_id uss720_table[] = {
775 { USB_DEVICE(0x047e, 0x1001) },
776 { USB_DEVICE(0x0557, 0x2001) },
777 { USB_DEVICE(0x0729, 0x1284) },
778 { USB_DEVICE(0x1293, 0x0002) },
779 { } /* Terminating entry */
782 MODULE_DEVICE_TABLE (usb, uss720_table);
785 static struct usb_driver uss720_driver = {
787 .probe = uss720_probe,
788 .disconnect = uss720_disconnect,
789 .id_table = uss720_table,
792 /* --------------------------------------------------------------------- */
794 MODULE_AUTHOR(DRIVER_AUTHOR);
795 MODULE_DESCRIPTION(DRIVER_DESC);
796 MODULE_LICENSE("GPL");
798 static int __init uss720_init(void)
801 retval = usb_register(&uss720_driver);
805 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
807 printk(KERN_INFO KBUILD_MODNAME ": NOTE: this is a special purpose "
808 "driver to allow nonstandard\n");
809 printk(KERN_INFO KBUILD_MODNAME ": protocols (eg. bitbang) over "
810 "USS720 usb to parallel cables\n");
811 printk(KERN_INFO KBUILD_MODNAME ": If you just want to connect to a "
812 "printer, use usblp instead\n");
817 static void __exit uss720_cleanup(void)
819 usb_deregister(&uss720_driver);
822 module_init(uss720_init);
823 module_exit(uss720_cleanup);
825 /* --------------------------------------------------------------------- */