1 // SPDX-License-Identifier: GPL-2.0+
2 /*****************************************************************************/
5 * uss720.c -- USS720 USB Parport Cable.
7 * Copyright (C) 1999, 2005, 2010
10 * Based on parport_pc.c
13 * 0.1 04.08.1999 Created
14 * 0.2 07.08.1999 Some fixes mainly suggested by Tim Waugh
15 * Interrupt handling currently disabled because
16 * usb_request_irq crashes somewhere within ohci.c
17 * for no apparent reason (that is for me, anyway)
18 * ECP currently untested
19 * 0.3 10.08.1999 fixing merge errors
20 * 0.4 13.08.1999 Added Vendor/Product ID of Brad Hard's cable
21 * 0.5 20.09.1999 usb_control_msg wrapper used
22 * Nov01.2000 usb_device_table support by Adam J. Richter
23 * 08.04.2001 Identify version on module load. gb
24 * 0.6 02.09.2005 Fix "scheduling in interrupt" problem by making save/restore
25 * context asynchronous
29 /*****************************************************************************/
31 #include <linux/module.h>
32 #include <linux/socket.h>
33 #include <linux/parport.h>
34 #include <linux/init.h>
35 #include <linux/usb.h>
36 #include <linux/delay.h>
37 #include <linux/completion.h>
38 #include <linux/kref.h>
39 #include <linux/slab.h>
40 #include <linux/sched/signal.h>
43 #define DRIVER_DESC "USB Parport Cable driver for Cables using the Lucent Technologies USS720 Chip"
45 /* --------------------------------------------------------------------- */
47 struct parport_uss720_private {
48 struct usb_device *usbdev;
50 struct kref ref_count;
51 __u8 reg[7]; /* USB registers */
52 struct list_head asynclist;
56 struct uss720_async_request {
57 struct parport_uss720_private *priv;
58 struct kref ref_count;
59 struct list_head asynclist;
60 struct completion compl;
62 struct usb_ctrlrequest *dr;
66 /* --------------------------------------------------------------------- */
68 static void destroy_priv(struct kref *kref)
70 struct parport_uss720_private *priv = container_of(kref, struct parport_uss720_private, ref_count);
72 dev_dbg(&priv->usbdev->dev, "destroying priv datastructure\n");
73 usb_put_dev(priv->usbdev);
77 static void destroy_async(struct kref *kref)
79 struct uss720_async_request *rq = container_of(kref, struct uss720_async_request, ref_count);
80 struct parport_uss720_private *priv = rq->priv;
84 usb_free_urb(rq->urb);
86 spin_lock_irqsave(&priv->asynclock, flags);
87 list_del_init(&rq->asynclist);
88 spin_unlock_irqrestore(&priv->asynclock, flags);
90 kref_put(&priv->ref_count, destroy_priv);
93 /* --------------------------------------------------------------------- */
95 static void async_complete(struct urb *urb)
97 struct uss720_async_request *rq;
99 struct parport_uss720_private *priv;
100 int status = urb->status;
106 dev_err(&urb->dev->dev, "async_complete: urb error %d\n",
108 } else if (rq->dr->bRequest == 3) {
109 memcpy(priv->reg, rq->reg, sizeof(priv->reg));
111 dev_dbg(&priv->usbdev->dev, "async_complete regs %7ph\n",
114 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
115 if (rq->reg[2] & rq->reg[1] & 0x10 && pp)
116 parport_generic_irq(pp);
118 complete(&rq->compl);
119 kref_put(&rq->ref_count, destroy_async);
122 static struct uss720_async_request *submit_async_request(struct parport_uss720_private *priv,
123 __u8 request, __u8 requesttype, __u16 value, __u16 index,
126 struct usb_device *usbdev;
127 struct uss720_async_request *rq;
133 usbdev = priv->usbdev;
136 rq = kzalloc(sizeof(struct uss720_async_request), mem_flags);
139 kref_init(&rq->ref_count);
140 INIT_LIST_HEAD(&rq->asynclist);
141 init_completion(&rq->compl);
142 kref_get(&priv->ref_count);
144 rq->urb = usb_alloc_urb(0, mem_flags);
146 kref_put(&rq->ref_count, destroy_async);
149 rq->dr = kmalloc(sizeof(*rq->dr), mem_flags);
151 kref_put(&rq->ref_count, destroy_async);
154 rq->dr->bRequestType = requesttype;
155 rq->dr->bRequest = request;
156 rq->dr->wValue = cpu_to_le16(value);
157 rq->dr->wIndex = cpu_to_le16(index);
158 rq->dr->wLength = cpu_to_le16((request == 3) ? sizeof(rq->reg) : 0);
159 usb_fill_control_urb(rq->urb, usbdev, (requesttype & 0x80) ? usb_rcvctrlpipe(usbdev, 0) : usb_sndctrlpipe(usbdev, 0),
160 (unsigned char *)rq->dr,
161 (request == 3) ? rq->reg : NULL, (request == 3) ? sizeof(rq->reg) : 0, async_complete, rq);
162 /* rq->urb->transfer_flags |= URB_ASYNC_UNLINK; */
163 spin_lock_irqsave(&priv->asynclock, flags);
164 list_add_tail(&rq->asynclist, &priv->asynclist);
165 spin_unlock_irqrestore(&priv->asynclock, flags);
166 kref_get(&rq->ref_count);
167 ret = usb_submit_urb(rq->urb, mem_flags);
170 destroy_async(&rq->ref_count);
171 dev_err(&usbdev->dev, "submit_async_request submit_urb failed with %d\n", ret);
175 static unsigned int kill_all_async_requests_priv(struct parport_uss720_private *priv)
177 struct uss720_async_request *rq;
179 unsigned int ret = 0;
181 spin_lock_irqsave(&priv->asynclock, flags);
182 list_for_each_entry(rq, &priv->asynclist, asynclist) {
183 usb_unlink_urb(rq->urb);
186 spin_unlock_irqrestore(&priv->asynclock, flags);
190 /* --------------------------------------------------------------------- */
192 static int get_1284_register(struct parport *pp, unsigned char reg, unsigned char *val, gfp_t mem_flags)
194 struct parport_uss720_private *priv;
195 struct uss720_async_request *rq;
196 static const unsigned char regindex[9] = {
197 4, 0, 1, 5, 5, 0, 2, 3, 6
203 priv = pp->private_data;
204 rq = submit_async_request(priv, 3, 0xc0, ((unsigned int)reg) << 8, 0, mem_flags);
206 dev_err(&priv->usbdev->dev, "get_1284_register(%u) failed",
211 kref_put(&rq->ref_count, destroy_async);
214 if (wait_for_completion_timeout(&rq->compl, HZ)) {
215 ret = rq->urb->status;
216 *val = priv->reg[(reg >= 9) ? 0 : regindex[reg]];
218 printk(KERN_WARNING "get_1284_register: "
219 "usb error %d\n", ret);
220 kref_put(&rq->ref_count, destroy_async);
223 printk(KERN_WARNING "get_1284_register timeout\n");
224 kill_all_async_requests_priv(priv);
228 static int set_1284_register(struct parport *pp, unsigned char reg, unsigned char val, gfp_t mem_flags)
230 struct parport_uss720_private *priv;
231 struct uss720_async_request *rq;
235 priv = pp->private_data;
236 rq = submit_async_request(priv, 4, 0x40, (((unsigned int)reg) << 8) | val, 0, mem_flags);
238 dev_err(&priv->usbdev->dev, "set_1284_register(%u,%u) failed",
239 (unsigned int)reg, (unsigned int)val);
242 kref_put(&rq->ref_count, destroy_async);
246 /* --------------------------------------------------------------------- */
255 /* Safely change the mode bits in the ECR */
256 static int change_mode(struct parport *pp, int m)
258 struct parport_uss720_private *priv = pp->private_data;
262 if (get_1284_register(pp, 6, ®, GFP_KERNEL))
264 /* Bits <7:5> contain the mode. */
265 mode = (priv->reg[2] >> 5) & 0x7;
268 /* We have to go through mode 000 or 001 */
269 if (mode > ECR_PS2 && m > ECR_PS2)
270 if (change_mode(pp, ECR_PS2))
273 if (m <= ECR_PS2 && !(priv->reg[1] & 0x20)) {
274 /* This mode resets the FIFO, so we may
275 * have to wait for it to drain first. */
276 unsigned long expire = jiffies + pp->physport->cad->timeout;
278 case ECR_PPF: /* Parallel Port FIFO mode */
279 case ECR_ECP: /* ECP Parallel Port mode */
282 if (get_1284_register(pp, 6, ®, GFP_KERNEL))
284 if (priv->reg[2] & 0x01)
286 if (time_after_eq (jiffies, expire))
287 /* The FIFO is stuck. */
289 msleep_interruptible(10);
290 if (signal_pending (current))
296 if (set_1284_register(pp, 6, m << 5, GFP_KERNEL))
298 if (get_1284_register(pp, 6, ®, GFP_KERNEL))
304 * Clear TIMEOUT BIT in EPP MODE
306 static int clear_epp_timeout(struct parport *pp)
310 if (get_1284_register(pp, 1, &stat, GFP_KERNEL))
319 static int uss720_irq(int usbstatus, void *buffer, int len, void *dev_id)
321 struct parport *pp = (struct parport *)dev_id;
322 struct parport_uss720_private *priv = pp->private_data;
324 if (usbstatus != 0 || len < 4 || !buffer)
326 memcpy(priv->reg, buffer, 4);
327 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
328 if (priv->reg[2] & priv->reg[1] & 0x10)
329 parport_generic_irq(pp);
334 static void parport_uss720_write_data(struct parport *pp, unsigned char d)
336 set_1284_register(pp, 0, d, GFP_KERNEL);
339 static unsigned char parport_uss720_read_data(struct parport *pp)
343 if (get_1284_register(pp, 0, &ret, GFP_KERNEL))
348 static void parport_uss720_write_control(struct parport *pp, unsigned char d)
350 struct parport_uss720_private *priv = pp->private_data;
352 d = (d & 0xf) | (priv->reg[1] & 0xf0);
353 if (set_1284_register(pp, 2, d, GFP_KERNEL))
358 static unsigned char parport_uss720_read_control(struct parport *pp)
360 struct parport_uss720_private *priv = pp->private_data;
361 return priv->reg[1] & 0xf; /* Use soft copy */
364 static unsigned char parport_uss720_frob_control(struct parport *pp, unsigned char mask, unsigned char val)
366 struct parport_uss720_private *priv = pp->private_data;
371 d = (priv->reg[1] & (~mask)) ^ val;
372 if (set_1284_register(pp, 2, d, GFP_ATOMIC))
378 static unsigned char parport_uss720_read_status(struct parport *pp)
382 if (get_1284_register(pp, 1, &ret, GFP_ATOMIC))
387 static void parport_uss720_disable_irq(struct parport *pp)
389 struct parport_uss720_private *priv = pp->private_data;
392 d = priv->reg[1] & ~0x10;
393 if (set_1284_register(pp, 2, d, GFP_KERNEL))
398 static void parport_uss720_enable_irq(struct parport *pp)
400 struct parport_uss720_private *priv = pp->private_data;
403 d = priv->reg[1] | 0x10;
404 if (set_1284_register(pp, 2, d, GFP_KERNEL))
409 static void parport_uss720_data_forward (struct parport *pp)
411 struct parport_uss720_private *priv = pp->private_data;
414 d = priv->reg[1] & ~0x20;
415 if (set_1284_register(pp, 2, d, GFP_KERNEL))
420 static void parport_uss720_data_reverse (struct parport *pp)
422 struct parport_uss720_private *priv = pp->private_data;
425 d = priv->reg[1] | 0x20;
426 if (set_1284_register(pp, 2, d, GFP_KERNEL))
431 static void parport_uss720_init_state(struct pardevice *dev, struct parport_state *s)
433 s->u.pc.ctr = 0xc | (dev->irq_func ? 0x10 : 0x0);
437 static void parport_uss720_save_state(struct parport *pp, struct parport_state *s)
439 struct parport_uss720_private *priv = pp->private_data;
442 if (get_1284_register(pp, 2, NULL, GFP_ATOMIC))
445 s->u.pc.ctr = priv->reg[1];
446 s->u.pc.ecr = priv->reg[2];
449 static void parport_uss720_restore_state(struct parport *pp, struct parport_state *s)
451 struct parport_uss720_private *priv = pp->private_data;
453 set_1284_register(pp, 2, s->u.pc.ctr, GFP_ATOMIC);
454 set_1284_register(pp, 6, s->u.pc.ecr, GFP_ATOMIC);
455 get_1284_register(pp, 2, NULL, GFP_ATOMIC);
456 priv->reg[1] = s->u.pc.ctr;
457 priv->reg[2] = s->u.pc.ecr;
460 static size_t parport_uss720_epp_read_data(struct parport *pp, void *buf, size_t length, int flags)
462 struct parport_uss720_private *priv = pp->private_data;
465 if (change_mode(pp, ECR_EPP))
467 for (; got < length; got++) {
468 if (get_1284_register(pp, 4, (char *)buf, GFP_KERNEL))
471 if (priv->reg[0] & 0x01) {
472 clear_epp_timeout(pp);
476 change_mode(pp, ECR_PS2);
480 static size_t parport_uss720_epp_write_data(struct parport *pp, const void *buf, size_t length, int flags)
483 struct parport_uss720_private *priv = pp->private_data;
486 if (change_mode(pp, ECR_EPP))
488 for (; written < length; written++) {
489 if (set_1284_register(pp, 4, (char *)buf, GFP_KERNEL))
492 if (get_1284_register(pp, 1, NULL, GFP_KERNEL))
494 if (priv->reg[0] & 0x01) {
495 clear_epp_timeout(pp);
499 change_mode(pp, ECR_PS2);
502 struct parport_uss720_private *priv = pp->private_data;
503 struct usb_device *usbdev = priv->usbdev;
509 if (change_mode(pp, ECR_EPP))
511 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buf, length, &rlen, 20000);
513 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %zu rlen %u\n", buf, length, rlen);
514 change_mode(pp, ECR_PS2);
519 static size_t parport_uss720_epp_read_addr(struct parport *pp, void *buf, size_t length, int flags)
521 struct parport_uss720_private *priv = pp->private_data;
524 if (change_mode(pp, ECR_EPP))
526 for (; got < length; got++) {
527 if (get_1284_register(pp, 3, (char *)buf, GFP_KERNEL))
530 if (priv->reg[0] & 0x01) {
531 clear_epp_timeout(pp);
535 change_mode(pp, ECR_PS2);
539 static size_t parport_uss720_epp_write_addr(struct parport *pp, const void *buf, size_t length, int flags)
541 struct parport_uss720_private *priv = pp->private_data;
544 if (change_mode(pp, ECR_EPP))
546 for (; written < length; written++) {
547 if (set_1284_register(pp, 3, *(char *)buf, GFP_KERNEL))
550 if (get_1284_register(pp, 1, NULL, GFP_KERNEL))
552 if (priv->reg[0] & 0x01) {
553 clear_epp_timeout(pp);
557 change_mode(pp, ECR_PS2);
561 static size_t parport_uss720_ecp_write_data(struct parport *pp, const void *buffer, size_t len, int flags)
563 struct parport_uss720_private *priv = pp->private_data;
564 struct usb_device *usbdev = priv->usbdev;
570 if (change_mode(pp, ECR_ECP))
572 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buffer, len, &rlen, 20000);
574 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %zu rlen %u\n", buffer, len, rlen);
575 change_mode(pp, ECR_PS2);
579 static size_t parport_uss720_ecp_read_data(struct parport *pp, void *buffer, size_t len, int flags)
581 struct parport_uss720_private *priv = pp->private_data;
582 struct usb_device *usbdev = priv->usbdev;
588 if (change_mode(pp, ECR_ECP))
590 i = usb_bulk_msg(usbdev, usb_rcvbulkpipe(usbdev, 2), buffer, len, &rlen, 20000);
592 printk(KERN_ERR "uss720: recvbulk ep 2 buf %p len %zu rlen %u\n", buffer, len, rlen);
593 change_mode(pp, ECR_PS2);
597 static size_t parport_uss720_ecp_write_addr(struct parport *pp, const void *buffer, size_t len, int flags)
601 if (change_mode(pp, ECR_ECP))
603 for (; written < len; written++) {
604 if (set_1284_register(pp, 5, *(char *)buffer, GFP_KERNEL))
608 change_mode(pp, ECR_PS2);
612 static size_t parport_uss720_write_compat(struct parport *pp, const void *buffer, size_t len, int flags)
614 struct parport_uss720_private *priv = pp->private_data;
615 struct usb_device *usbdev = priv->usbdev;
621 if (change_mode(pp, ECR_PPF))
623 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buffer, len, &rlen, 20000);
625 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %zu rlen %u\n", buffer, len, rlen);
626 change_mode(pp, ECR_PS2);
630 /* --------------------------------------------------------------------- */
632 static struct parport_operations parport_uss720_ops =
634 .owner = THIS_MODULE,
635 .write_data = parport_uss720_write_data,
636 .read_data = parport_uss720_read_data,
638 .write_control = parport_uss720_write_control,
639 .read_control = parport_uss720_read_control,
640 .frob_control = parport_uss720_frob_control,
642 .read_status = parport_uss720_read_status,
644 .enable_irq = parport_uss720_enable_irq,
645 .disable_irq = parport_uss720_disable_irq,
647 .data_forward = parport_uss720_data_forward,
648 .data_reverse = parport_uss720_data_reverse,
650 .init_state = parport_uss720_init_state,
651 .save_state = parport_uss720_save_state,
652 .restore_state = parport_uss720_restore_state,
654 .epp_write_data = parport_uss720_epp_write_data,
655 .epp_read_data = parport_uss720_epp_read_data,
656 .epp_write_addr = parport_uss720_epp_write_addr,
657 .epp_read_addr = parport_uss720_epp_read_addr,
659 .ecp_write_data = parport_uss720_ecp_write_data,
660 .ecp_read_data = parport_uss720_ecp_read_data,
661 .ecp_write_addr = parport_uss720_ecp_write_addr,
663 .compat_write_data = parport_uss720_write_compat,
664 .nibble_read_data = parport_ieee1284_read_nibble,
665 .byte_read_data = parport_ieee1284_read_byte,
668 /* --------------------------------------------------------------------- */
670 static int uss720_probe(struct usb_interface *intf,
671 const struct usb_device_id *id)
673 struct usb_device *usbdev = usb_get_dev(interface_to_usbdev(intf));
674 struct usb_host_interface *interface;
675 struct usb_endpoint_descriptor *epd;
676 struct parport_uss720_private *priv;
681 dev_dbg(&intf->dev, "probe: vendor id 0x%x, device id 0x%x\n",
682 le16_to_cpu(usbdev->descriptor.idVendor),
683 le16_to_cpu(usbdev->descriptor.idProduct));
685 /* our known interfaces have 3 alternate settings */
686 if (intf->num_altsetting != 3) {
690 i = usb_set_interface(usbdev, intf->altsetting->desc.bInterfaceNumber, 2);
691 dev_dbg(&intf->dev, "set interface result %d\n", i);
693 interface = intf->cur_altsetting;
695 if (interface->desc.bNumEndpoints < 3) {
701 * Allocate parport interface
703 priv = kzalloc(sizeof(struct parport_uss720_private), GFP_KERNEL);
709 priv->usbdev = usbdev;
710 kref_init(&priv->ref_count);
711 spin_lock_init(&priv->asynclock);
712 INIT_LIST_HEAD(&priv->asynclist);
713 pp = parport_register_port(0, PARPORT_IRQ_NONE, PARPORT_DMA_NONE, &parport_uss720_ops);
715 printk(KERN_WARNING "uss720: could not register parport\n");
720 pp->private_data = priv;
721 pp->modes = PARPORT_MODE_PCSPP | PARPORT_MODE_TRISTATE | PARPORT_MODE_EPP | PARPORT_MODE_ECP | PARPORT_MODE_COMPAT;
723 /* set the USS720 control register to manual mode, no ECP compression, enable all ints */
724 set_1284_register(pp, 7, 0x00, GFP_KERNEL);
725 set_1284_register(pp, 6, 0x30, GFP_KERNEL); /* PS/2 mode */
726 set_1284_register(pp, 2, 0x0c, GFP_KERNEL);
728 get_1284_register(pp, 0, ®, GFP_KERNEL);
729 dev_dbg(&intf->dev, "reg: %7ph\n", priv->reg);
731 i = usb_find_last_int_in_endpoint(interface, &epd);
733 dev_dbg(&intf->dev, "epaddr %d interval %d\n",
734 epd->bEndpointAddress, epd->bInterval);
736 parport_announce_port(pp);
738 usb_set_intfdata(intf, pp);
743 kill_all_async_requests_priv(priv);
744 kref_put(&priv->ref_count, destroy_priv);
748 static void uss720_disconnect(struct usb_interface *intf)
750 struct parport *pp = usb_get_intfdata(intf);
751 struct parport_uss720_private *priv;
753 dev_dbg(&intf->dev, "disconnect\n");
754 usb_set_intfdata(intf, NULL);
756 priv = pp->private_data;
759 dev_dbg(&intf->dev, "parport_remove_port\n");
760 parport_remove_port(pp);
761 parport_put_port(pp);
762 kill_all_async_requests_priv(priv);
763 kref_put(&priv->ref_count, destroy_priv);
765 dev_dbg(&intf->dev, "disconnect done\n");
768 /* table of cables that work through this driver */
769 static const struct usb_device_id uss720_table[] = {
770 { USB_DEVICE(0x047e, 0x1001) },
771 { USB_DEVICE(0x04b8, 0x0002) },
772 { USB_DEVICE(0x04b8, 0x0003) },
773 { USB_DEVICE(0x050d, 0x0002) },
774 { USB_DEVICE(0x050d, 0x1202) },
775 { USB_DEVICE(0x0557, 0x2001) },
776 { USB_DEVICE(0x05ab, 0x0002) },
777 { USB_DEVICE(0x06c6, 0x0100) },
778 { USB_DEVICE(0x0729, 0x1284) },
779 { USB_DEVICE(0x1293, 0x0002) },
780 { } /* Terminating entry */
783 MODULE_DEVICE_TABLE (usb, uss720_table);
786 static struct usb_driver uss720_driver = {
788 .probe = uss720_probe,
789 .disconnect = uss720_disconnect,
790 .id_table = uss720_table,
793 /* --------------------------------------------------------------------- */
795 MODULE_AUTHOR(DRIVER_AUTHOR);
796 MODULE_DESCRIPTION(DRIVER_DESC);
797 MODULE_LICENSE("GPL");
799 static int __init uss720_init(void)
802 retval = usb_register(&uss720_driver);
806 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
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 /* --------------------------------------------------------------------- */