1 /*****************************************************************************/
4 * uss720.c -- USS720 USB Parport Cable.
6 * Copyright (C) 1999, 2005, 2010
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>
53 #include <linux/sched/signal.h>
58 #define DRIVER_VERSION "v0.6"
59 #define DRIVER_AUTHOR "Thomas M. Sailer, t.sailer@alumni.ethz.ch"
60 #define DRIVER_DESC "USB Parport Cable driver for Cables using the Lucent Technologies USS720 Chip"
62 /* --------------------------------------------------------------------- */
64 struct parport_uss720_private {
65 struct usb_device *usbdev;
67 struct kref ref_count;
68 __u8 reg[7]; /* USB registers */
69 struct list_head asynclist;
73 struct uss720_async_request {
74 struct parport_uss720_private *priv;
75 struct kref ref_count;
76 struct list_head asynclist;
77 struct completion compl;
79 struct usb_ctrlrequest *dr;
83 /* --------------------------------------------------------------------- */
85 static void destroy_priv(struct kref *kref)
87 struct parport_uss720_private *priv = container_of(kref, struct parport_uss720_private, ref_count);
89 dev_dbg(&priv->usbdev->dev, "destroying priv datastructure\n");
90 usb_put_dev(priv->usbdev);
94 static void destroy_async(struct kref *kref)
96 struct uss720_async_request *rq = container_of(kref, struct uss720_async_request, ref_count);
97 struct parport_uss720_private *priv = rq->priv;
101 usb_free_urb(rq->urb);
103 spin_lock_irqsave(&priv->asynclock, flags);
104 list_del_init(&rq->asynclist);
105 spin_unlock_irqrestore(&priv->asynclock, flags);
107 kref_put(&priv->ref_count, destroy_priv);
110 /* --------------------------------------------------------------------- */
112 static void async_complete(struct urb *urb)
114 struct uss720_async_request *rq;
116 struct parport_uss720_private *priv;
117 int status = urb->status;
123 dev_err(&urb->dev->dev, "async_complete: urb error %d\n",
125 } else if (rq->dr->bRequest == 3) {
126 memcpy(priv->reg, rq->reg, sizeof(priv->reg));
128 dev_dbg(&priv->usbdev->dev, "async_complete regs %7ph\n",
131 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
132 if (rq->reg[2] & rq->reg[1] & 0x10 && pp)
133 parport_generic_irq(pp);
135 complete(&rq->compl);
136 kref_put(&rq->ref_count, destroy_async);
139 static struct uss720_async_request *submit_async_request(struct parport_uss720_private *priv,
140 __u8 request, __u8 requesttype, __u16 value, __u16 index,
143 struct usb_device *usbdev;
144 struct uss720_async_request *rq;
150 usbdev = priv->usbdev;
153 rq = kzalloc(sizeof(struct uss720_async_request), mem_flags);
156 kref_init(&rq->ref_count);
157 INIT_LIST_HEAD(&rq->asynclist);
158 init_completion(&rq->compl);
159 kref_get(&priv->ref_count);
161 rq->urb = usb_alloc_urb(0, mem_flags);
163 kref_put(&rq->ref_count, destroy_async);
166 rq->dr = kmalloc(sizeof(*rq->dr), mem_flags);
168 kref_put(&rq->ref_count, destroy_async);
171 rq->dr->bRequestType = requesttype;
172 rq->dr->bRequest = request;
173 rq->dr->wValue = cpu_to_le16(value);
174 rq->dr->wIndex = cpu_to_le16(index);
175 rq->dr->wLength = cpu_to_le16((request == 3) ? sizeof(rq->reg) : 0);
176 usb_fill_control_urb(rq->urb, usbdev, (requesttype & 0x80) ? usb_rcvctrlpipe(usbdev, 0) : usb_sndctrlpipe(usbdev, 0),
177 (unsigned char *)rq->dr,
178 (request == 3) ? rq->reg : NULL, (request == 3) ? sizeof(rq->reg) : 0, async_complete, rq);
179 /* rq->urb->transfer_flags |= URB_ASYNC_UNLINK; */
180 spin_lock_irqsave(&priv->asynclock, flags);
181 list_add_tail(&rq->asynclist, &priv->asynclist);
182 spin_unlock_irqrestore(&priv->asynclock, flags);
183 kref_get(&rq->ref_count);
184 ret = usb_submit_urb(rq->urb, mem_flags);
187 destroy_async(&rq->ref_count);
188 dev_err(&usbdev->dev, "submit_async_request submit_urb failed with %d\n", ret);
192 static unsigned int kill_all_async_requests_priv(struct parport_uss720_private *priv)
194 struct uss720_async_request *rq;
196 unsigned int ret = 0;
198 spin_lock_irqsave(&priv->asynclock, flags);
199 list_for_each_entry(rq, &priv->asynclist, asynclist) {
200 usb_unlink_urb(rq->urb);
203 spin_unlock_irqrestore(&priv->asynclock, flags);
207 /* --------------------------------------------------------------------- */
209 static int get_1284_register(struct parport *pp, unsigned char reg, unsigned char *val, gfp_t mem_flags)
211 struct parport_uss720_private *priv;
212 struct uss720_async_request *rq;
213 static const unsigned char regindex[9] = {
214 4, 0, 1, 5, 5, 0, 2, 3, 6
220 priv = pp->private_data;
221 rq = submit_async_request(priv, 3, 0xc0, ((unsigned int)reg) << 8, 0, mem_flags);
223 dev_err(&priv->usbdev->dev, "get_1284_register(%u) failed",
228 kref_put(&rq->ref_count, destroy_async);
231 if (wait_for_completion_timeout(&rq->compl, HZ)) {
232 ret = rq->urb->status;
233 *val = priv->reg[(reg >= 9) ? 0 : regindex[reg]];
235 printk(KERN_WARNING "get_1284_register: "
236 "usb error %d\n", ret);
237 kref_put(&rq->ref_count, destroy_async);
240 printk(KERN_WARNING "get_1284_register timeout\n");
241 kill_all_async_requests_priv(priv);
245 static int set_1284_register(struct parport *pp, unsigned char reg, unsigned char val, gfp_t mem_flags)
247 struct parport_uss720_private *priv;
248 struct uss720_async_request *rq;
252 priv = pp->private_data;
253 rq = submit_async_request(priv, 4, 0x40, (((unsigned int)reg) << 8) | val, 0, mem_flags);
255 dev_err(&priv->usbdev->dev, "set_1284_register(%u,%u) failed",
256 (unsigned int)reg, (unsigned int)val);
259 kref_put(&rq->ref_count, destroy_async);
263 /* --------------------------------------------------------------------- */
272 /* Safely change the mode bits in the ECR */
273 static int change_mode(struct parport *pp, int m)
275 struct parport_uss720_private *priv = pp->private_data;
279 if (get_1284_register(pp, 6, ®, GFP_KERNEL))
281 /* Bits <7:5> contain the mode. */
282 mode = (priv->reg[2] >> 5) & 0x7;
285 /* We have to go through mode 000 or 001 */
286 if (mode > ECR_PS2 && m > ECR_PS2)
287 if (change_mode(pp, ECR_PS2))
290 if (m <= ECR_PS2 && !(priv->reg[1] & 0x20)) {
291 /* This mode resets the FIFO, so we may
292 * have to wait for it to drain first. */
293 unsigned long expire = jiffies + pp->physport->cad->timeout;
295 case ECR_PPF: /* Parallel Port FIFO mode */
296 case ECR_ECP: /* ECP Parallel Port mode */
299 if (get_1284_register(pp, 6, ®, GFP_KERNEL))
301 if (priv->reg[2] & 0x01)
303 if (time_after_eq (jiffies, expire))
304 /* The FIFO is stuck. */
306 msleep_interruptible(10);
307 if (signal_pending (current))
313 if (set_1284_register(pp, 6, m << 5, GFP_KERNEL))
315 if (get_1284_register(pp, 6, ®, GFP_KERNEL))
321 * Clear TIMEOUT BIT in EPP MODE
323 static int clear_epp_timeout(struct parport *pp)
327 if (get_1284_register(pp, 1, &stat, GFP_KERNEL))
336 static int uss720_irq(int usbstatus, void *buffer, int len, void *dev_id)
338 struct parport *pp = (struct parport *)dev_id;
339 struct parport_uss720_private *priv = pp->private_data;
341 if (usbstatus != 0 || len < 4 || !buffer)
343 memcpy(priv->reg, buffer, 4);
344 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
345 if (priv->reg[2] & priv->reg[1] & 0x10)
346 parport_generic_irq(pp);
351 static void parport_uss720_write_data(struct parport *pp, unsigned char d)
353 set_1284_register(pp, 0, d, GFP_KERNEL);
356 static unsigned char parport_uss720_read_data(struct parport *pp)
360 if (get_1284_register(pp, 0, &ret, GFP_KERNEL))
365 static void parport_uss720_write_control(struct parport *pp, unsigned char d)
367 struct parport_uss720_private *priv = pp->private_data;
369 d = (d & 0xf) | (priv->reg[1] & 0xf0);
370 if (set_1284_register(pp, 2, d, GFP_KERNEL))
375 static unsigned char parport_uss720_read_control(struct parport *pp)
377 struct parport_uss720_private *priv = pp->private_data;
378 return priv->reg[1] & 0xf; /* Use soft copy */
381 static unsigned char parport_uss720_frob_control(struct parport *pp, unsigned char mask, unsigned char val)
383 struct parport_uss720_private *priv = pp->private_data;
388 d = (priv->reg[1] & (~mask)) ^ val;
389 if (set_1284_register(pp, 2, d, GFP_KERNEL))
395 static unsigned char parport_uss720_read_status(struct parport *pp)
399 if (get_1284_register(pp, 1, &ret, GFP_KERNEL))
404 static void parport_uss720_disable_irq(struct parport *pp)
406 struct parport_uss720_private *priv = pp->private_data;
409 d = priv->reg[1] & ~0x10;
410 if (set_1284_register(pp, 2, d, GFP_KERNEL))
415 static void parport_uss720_enable_irq(struct parport *pp)
417 struct parport_uss720_private *priv = pp->private_data;
420 d = priv->reg[1] | 0x10;
421 if (set_1284_register(pp, 2, d, GFP_KERNEL))
426 static void parport_uss720_data_forward (struct parport *pp)
428 struct parport_uss720_private *priv = pp->private_data;
431 d = priv->reg[1] & ~0x20;
432 if (set_1284_register(pp, 2, d, GFP_KERNEL))
437 static void parport_uss720_data_reverse (struct parport *pp)
439 struct parport_uss720_private *priv = pp->private_data;
442 d = priv->reg[1] | 0x20;
443 if (set_1284_register(pp, 2, d, GFP_KERNEL))
448 static void parport_uss720_init_state(struct pardevice *dev, struct parport_state *s)
450 s->u.pc.ctr = 0xc | (dev->irq_func ? 0x10 : 0x0);
454 static void parport_uss720_save_state(struct parport *pp, struct parport_state *s)
456 struct parport_uss720_private *priv = pp->private_data;
459 if (get_1284_register(pp, 2, NULL, GFP_ATOMIC))
462 s->u.pc.ctr = priv->reg[1];
463 s->u.pc.ecr = priv->reg[2];
466 static void parport_uss720_restore_state(struct parport *pp, struct parport_state *s)
468 struct parport_uss720_private *priv = pp->private_data;
470 set_1284_register(pp, 2, s->u.pc.ctr, GFP_ATOMIC);
471 set_1284_register(pp, 6, s->u.pc.ecr, GFP_ATOMIC);
472 get_1284_register(pp, 2, NULL, GFP_ATOMIC);
473 priv->reg[1] = s->u.pc.ctr;
474 priv->reg[2] = s->u.pc.ecr;
477 static size_t parport_uss720_epp_read_data(struct parport *pp, void *buf, size_t length, int flags)
479 struct parport_uss720_private *priv = pp->private_data;
482 if (change_mode(pp, ECR_EPP))
484 for (; got < length; got++) {
485 if (get_1284_register(pp, 4, (char *)buf, GFP_KERNEL))
488 if (priv->reg[0] & 0x01) {
489 clear_epp_timeout(pp);
493 change_mode(pp, ECR_PS2);
497 static size_t parport_uss720_epp_write_data(struct parport *pp, const void *buf, size_t length, int flags)
500 struct parport_uss720_private *priv = pp->private_data;
503 if (change_mode(pp, ECR_EPP))
505 for (; written < length; written++) {
506 if (set_1284_register(pp, 4, (char *)buf, GFP_KERNEL))
509 if (get_1284_register(pp, 1, NULL, GFP_KERNEL))
511 if (priv->reg[0] & 0x01) {
512 clear_epp_timeout(pp);
516 change_mode(pp, ECR_PS2);
519 struct parport_uss720_private *priv = pp->private_data;
520 struct usb_device *usbdev = priv->usbdev;
526 if (change_mode(pp, ECR_EPP))
528 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buf, length, &rlen, 20000);
530 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %zu rlen %u\n", buf, length, rlen);
531 change_mode(pp, ECR_PS2);
536 static size_t parport_uss720_epp_read_addr(struct parport *pp, void *buf, size_t length, int flags)
538 struct parport_uss720_private *priv = pp->private_data;
541 if (change_mode(pp, ECR_EPP))
543 for (; got < length; got++) {
544 if (get_1284_register(pp, 3, (char *)buf, GFP_KERNEL))
547 if (priv->reg[0] & 0x01) {
548 clear_epp_timeout(pp);
552 change_mode(pp, ECR_PS2);
556 static size_t parport_uss720_epp_write_addr(struct parport *pp, const void *buf, size_t length, int flags)
558 struct parport_uss720_private *priv = pp->private_data;
561 if (change_mode(pp, ECR_EPP))
563 for (; written < length; written++) {
564 if (set_1284_register(pp, 3, *(char *)buf, GFP_KERNEL))
567 if (get_1284_register(pp, 1, NULL, GFP_KERNEL))
569 if (priv->reg[0] & 0x01) {
570 clear_epp_timeout(pp);
574 change_mode(pp, ECR_PS2);
578 static size_t parport_uss720_ecp_write_data(struct parport *pp, const void *buffer, size_t len, int flags)
580 struct parport_uss720_private *priv = pp->private_data;
581 struct usb_device *usbdev = priv->usbdev;
587 if (change_mode(pp, ECR_ECP))
589 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buffer, len, &rlen, 20000);
591 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %zu rlen %u\n", buffer, len, rlen);
592 change_mode(pp, ECR_PS2);
596 static size_t parport_uss720_ecp_read_data(struct parport *pp, void *buffer, size_t len, int flags)
598 struct parport_uss720_private *priv = pp->private_data;
599 struct usb_device *usbdev = priv->usbdev;
605 if (change_mode(pp, ECR_ECP))
607 i = usb_bulk_msg(usbdev, usb_rcvbulkpipe(usbdev, 2), buffer, len, &rlen, 20000);
609 printk(KERN_ERR "uss720: recvbulk ep 2 buf %p len %zu rlen %u\n", buffer, len, rlen);
610 change_mode(pp, ECR_PS2);
614 static size_t parport_uss720_ecp_write_addr(struct parport *pp, const void *buffer, size_t len, int flags)
618 if (change_mode(pp, ECR_ECP))
620 for (; written < len; written++) {
621 if (set_1284_register(pp, 5, *(char *)buffer, GFP_KERNEL))
625 change_mode(pp, ECR_PS2);
629 static size_t parport_uss720_write_compat(struct parport *pp, const void *buffer, size_t len, int flags)
631 struct parport_uss720_private *priv = pp->private_data;
632 struct usb_device *usbdev = priv->usbdev;
638 if (change_mode(pp, ECR_PPF))
640 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buffer, len, &rlen, 20000);
642 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %zu rlen %u\n", buffer, len, rlen);
643 change_mode(pp, ECR_PS2);
647 /* --------------------------------------------------------------------- */
649 static struct parport_operations parport_uss720_ops =
651 .owner = THIS_MODULE,
652 .write_data = parport_uss720_write_data,
653 .read_data = parport_uss720_read_data,
655 .write_control = parport_uss720_write_control,
656 .read_control = parport_uss720_read_control,
657 .frob_control = parport_uss720_frob_control,
659 .read_status = parport_uss720_read_status,
661 .enable_irq = parport_uss720_enable_irq,
662 .disable_irq = parport_uss720_disable_irq,
664 .data_forward = parport_uss720_data_forward,
665 .data_reverse = parport_uss720_data_reverse,
667 .init_state = parport_uss720_init_state,
668 .save_state = parport_uss720_save_state,
669 .restore_state = parport_uss720_restore_state,
671 .epp_write_data = parport_uss720_epp_write_data,
672 .epp_read_data = parport_uss720_epp_read_data,
673 .epp_write_addr = parport_uss720_epp_write_addr,
674 .epp_read_addr = parport_uss720_epp_read_addr,
676 .ecp_write_data = parport_uss720_ecp_write_data,
677 .ecp_read_data = parport_uss720_ecp_read_data,
678 .ecp_write_addr = parport_uss720_ecp_write_addr,
680 .compat_write_data = parport_uss720_write_compat,
681 .nibble_read_data = parport_ieee1284_read_nibble,
682 .byte_read_data = parport_ieee1284_read_byte,
685 /* --------------------------------------------------------------------- */
687 static int uss720_probe(struct usb_interface *intf,
688 const struct usb_device_id *id)
690 struct usb_device *usbdev = usb_get_dev(interface_to_usbdev(intf));
691 struct usb_host_interface *interface;
692 struct usb_host_endpoint *endpoint;
693 struct parport_uss720_private *priv;
698 dev_dbg(&intf->dev, "probe: vendor id 0x%x, device id 0x%x\n",
699 le16_to_cpu(usbdev->descriptor.idVendor),
700 le16_to_cpu(usbdev->descriptor.idProduct));
702 /* our known interfaces have 3 alternate settings */
703 if (intf->num_altsetting != 3) {
707 i = usb_set_interface(usbdev, intf->altsetting->desc.bInterfaceNumber, 2);
708 dev_dbg(&intf->dev, "set interface result %d\n", i);
710 interface = intf->cur_altsetting;
712 if (interface->desc.bNumEndpoints < 3) {
718 * Allocate parport interface
720 priv = kzalloc(sizeof(struct parport_uss720_private), GFP_KERNEL);
726 priv->usbdev = usbdev;
727 kref_init(&priv->ref_count);
728 spin_lock_init(&priv->asynclock);
729 INIT_LIST_HEAD(&priv->asynclist);
730 pp = parport_register_port(0, PARPORT_IRQ_NONE, PARPORT_DMA_NONE, &parport_uss720_ops);
732 printk(KERN_WARNING "uss720: could not register parport\n");
737 pp->private_data = priv;
738 pp->modes = PARPORT_MODE_PCSPP | PARPORT_MODE_TRISTATE | PARPORT_MODE_EPP | PARPORT_MODE_ECP | PARPORT_MODE_COMPAT;
740 /* set the USS720 control register to manual mode, no ECP compression, enable all ints */
741 set_1284_register(pp, 7, 0x00, GFP_KERNEL);
742 set_1284_register(pp, 6, 0x30, GFP_KERNEL); /* PS/2 mode */
743 set_1284_register(pp, 2, 0x0c, GFP_KERNEL);
745 get_1284_register(pp, 0, ®, GFP_KERNEL);
746 dev_dbg(&intf->dev, "reg: %7ph\n", priv->reg);
748 endpoint = &interface->endpoint[2];
749 dev_dbg(&intf->dev, "epaddr %d interval %d\n",
750 endpoint->desc.bEndpointAddress, endpoint->desc.bInterval);
751 parport_announce_port(pp);
753 usb_set_intfdata(intf, pp);
757 kill_all_async_requests_priv(priv);
758 kref_put(&priv->ref_count, destroy_priv);
762 static void uss720_disconnect(struct usb_interface *intf)
764 struct parport *pp = usb_get_intfdata(intf);
765 struct parport_uss720_private *priv;
766 struct usb_device *usbdev;
768 dev_dbg(&intf->dev, "disconnect\n");
769 usb_set_intfdata(intf, NULL);
771 priv = pp->private_data;
772 usbdev = priv->usbdev;
775 dev_dbg(&intf->dev, "parport_remove_port\n");
776 parport_remove_port(pp);
777 parport_put_port(pp);
778 kill_all_async_requests_priv(priv);
779 kref_put(&priv->ref_count, destroy_priv);
781 dev_dbg(&intf->dev, "disconnect done\n");
784 /* table of cables that work through this driver */
785 static const struct usb_device_id uss720_table[] = {
786 { USB_DEVICE(0x047e, 0x1001) },
787 { USB_DEVICE(0x0557, 0x2001) },
788 { USB_DEVICE(0x0729, 0x1284) },
789 { USB_DEVICE(0x1293, 0x0002) },
790 { USB_DEVICE(0x050d, 0x0002) },
791 { } /* Terminating entry */
794 MODULE_DEVICE_TABLE (usb, uss720_table);
797 static struct usb_driver uss720_driver = {
799 .probe = uss720_probe,
800 .disconnect = uss720_disconnect,
801 .id_table = uss720_table,
804 /* --------------------------------------------------------------------- */
806 MODULE_AUTHOR(DRIVER_AUTHOR);
807 MODULE_DESCRIPTION(DRIVER_DESC);
808 MODULE_LICENSE("GPL");
810 static int __init uss720_init(void)
813 retval = usb_register(&uss720_driver);
817 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
819 printk(KERN_INFO KBUILD_MODNAME ": NOTE: this is a special purpose "
820 "driver to allow nonstandard\n");
821 printk(KERN_INFO KBUILD_MODNAME ": protocols (eg. bitbang) over "
822 "USS720 usb to parallel cables\n");
823 printk(KERN_INFO KBUILD_MODNAME ": If you just want to connect to a "
824 "printer, use usblp instead\n");
829 static void __exit uss720_cleanup(void)
831 usb_deregister(&uss720_driver);
834 module_init(uss720_init);
835 module_exit(uss720_cleanup);
837 /* --------------------------------------------------------------------- */