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);
78 static void destroy_async(struct kref *kref)
80 struct uss720_async_request *rq = container_of(kref, struct uss720_async_request, ref_count);
81 struct parport_uss720_private *priv = rq->priv;
85 usb_free_urb(rq->urb);
87 spin_lock_irqsave(&priv->asynclock, flags);
88 list_del_init(&rq->asynclist);
89 spin_unlock_irqrestore(&priv->asynclock, flags);
91 kref_put(&priv->ref_count, destroy_priv);
94 /* --------------------------------------------------------------------- */
96 static void async_complete(struct urb *urb)
98 struct uss720_async_request *rq;
100 struct parport_uss720_private *priv;
101 int status = urb->status;
107 dev_err(&urb->dev->dev, "async_complete: urb error %d\n",
109 } else if (rq->dr->bRequest == 3) {
110 memcpy(priv->reg, rq->reg, sizeof(priv->reg));
112 dev_dbg(&priv->usbdev->dev, "async_complete regs %7ph\n",
115 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
116 if (rq->reg[2] & rq->reg[1] & 0x10 && pp)
117 parport_generic_irq(pp);
119 complete(&rq->compl);
120 kref_put(&rq->ref_count, destroy_async);
123 static struct uss720_async_request *submit_async_request(struct parport_uss720_private *priv,
124 __u8 request, __u8 requesttype, __u16 value, __u16 index,
127 struct usb_device *usbdev;
128 struct uss720_async_request *rq;
134 usbdev = priv->usbdev;
137 rq = kzalloc(sizeof(struct uss720_async_request), mem_flags);
140 kref_init(&rq->ref_count);
141 INIT_LIST_HEAD(&rq->asynclist);
142 init_completion(&rq->compl);
143 kref_get(&priv->ref_count);
145 rq->urb = usb_alloc_urb(0, mem_flags);
147 kref_put(&rq->ref_count, destroy_async);
150 rq->dr = kmalloc(sizeof(*rq->dr), mem_flags);
152 kref_put(&rq->ref_count, destroy_async);
155 rq->dr->bRequestType = requesttype;
156 rq->dr->bRequest = request;
157 rq->dr->wValue = cpu_to_le16(value);
158 rq->dr->wIndex = cpu_to_le16(index);
159 rq->dr->wLength = cpu_to_le16((request == 3) ? sizeof(rq->reg) : 0);
160 usb_fill_control_urb(rq->urb, usbdev, (requesttype & 0x80) ? usb_rcvctrlpipe(usbdev, 0) : usb_sndctrlpipe(usbdev, 0),
161 (unsigned char *)rq->dr,
162 (request == 3) ? rq->reg : NULL, (request == 3) ? sizeof(rq->reg) : 0, async_complete, rq);
163 /* rq->urb->transfer_flags |= URB_ASYNC_UNLINK; */
164 spin_lock_irqsave(&priv->asynclock, flags);
165 list_add_tail(&rq->asynclist, &priv->asynclist);
166 spin_unlock_irqrestore(&priv->asynclock, flags);
167 kref_get(&rq->ref_count);
168 ret = usb_submit_urb(rq->urb, mem_flags);
171 destroy_async(&rq->ref_count);
172 dev_err(&usbdev->dev, "submit_async_request submit_urb failed with %d\n", ret);
176 static unsigned int kill_all_async_requests_priv(struct parport_uss720_private *priv)
178 struct uss720_async_request *rq;
180 unsigned int ret = 0;
182 spin_lock_irqsave(&priv->asynclock, flags);
183 list_for_each_entry(rq, &priv->asynclist, asynclist) {
184 usb_unlink_urb(rq->urb);
187 spin_unlock_irqrestore(&priv->asynclock, flags);
191 /* --------------------------------------------------------------------- */
193 static int get_1284_register(struct parport *pp, unsigned char reg, unsigned char *val, gfp_t mem_flags)
195 struct parport_uss720_private *priv;
196 struct uss720_async_request *rq;
197 static const unsigned char regindex[9] = {
198 4, 0, 1, 5, 5, 0, 2, 3, 6
204 priv = pp->private_data;
205 rq = submit_async_request(priv, 3, 0xc0, ((unsigned int)reg) << 8, 0, mem_flags);
207 dev_err(&priv->usbdev->dev, "get_1284_register(%u) failed",
212 kref_put(&rq->ref_count, destroy_async);
215 if (wait_for_completion_timeout(&rq->compl, HZ)) {
216 ret = rq->urb->status;
217 *val = priv->reg[(reg >= 9) ? 0 : regindex[reg]];
219 printk(KERN_WARNING "get_1284_register: "
220 "usb error %d\n", ret);
221 kref_put(&rq->ref_count, destroy_async);
224 printk(KERN_WARNING "get_1284_register timeout\n");
225 kill_all_async_requests_priv(priv);
229 static int set_1284_register(struct parport *pp, unsigned char reg, unsigned char val, gfp_t mem_flags)
231 struct parport_uss720_private *priv;
232 struct uss720_async_request *rq;
236 priv = pp->private_data;
237 rq = submit_async_request(priv, 4, 0x40, (((unsigned int)reg) << 8) | val, 0, mem_flags);
239 dev_err(&priv->usbdev->dev, "set_1284_register(%u,%u) failed",
240 (unsigned int)reg, (unsigned int)val);
243 kref_put(&rq->ref_count, destroy_async);
247 /* --------------------------------------------------------------------- */
256 /* Safely change the mode bits in the ECR */
257 static int change_mode(struct parport *pp, int m)
259 struct parport_uss720_private *priv = pp->private_data;
263 if (get_1284_register(pp, 6, ®, GFP_KERNEL))
265 /* Bits <7:5> contain the mode. */
266 mode = (priv->reg[2] >> 5) & 0x7;
269 /* We have to go through mode 000 or 001 */
270 if (mode > ECR_PS2 && m > ECR_PS2)
271 if (change_mode(pp, ECR_PS2))
274 if (m <= ECR_PS2 && !(priv->reg[1] & 0x20)) {
275 /* This mode resets the FIFO, so we may
276 * have to wait for it to drain first. */
277 unsigned long expire = jiffies + pp->physport->cad->timeout;
279 case ECR_PPF: /* Parallel Port FIFO mode */
280 case ECR_ECP: /* ECP Parallel Port mode */
283 if (get_1284_register(pp, 6, ®, GFP_KERNEL))
285 if (priv->reg[2] & 0x01)
287 if (time_after_eq (jiffies, expire))
288 /* The FIFO is stuck. */
290 msleep_interruptible(10);
291 if (signal_pending (current))
297 if (set_1284_register(pp, 6, m << 5, GFP_KERNEL))
299 if (get_1284_register(pp, 6, ®, GFP_KERNEL))
305 * Clear TIMEOUT BIT in EPP MODE
307 static int clear_epp_timeout(struct parport *pp)
311 if (get_1284_register(pp, 1, &stat, GFP_KERNEL))
320 static int uss720_irq(int usbstatus, void *buffer, int len, void *dev_id)
322 struct parport *pp = (struct parport *)dev_id;
323 struct parport_uss720_private *priv = pp->private_data;
325 if (usbstatus != 0 || len < 4 || !buffer)
327 memcpy(priv->reg, buffer, 4);
328 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
329 if (priv->reg[2] & priv->reg[1] & 0x10)
330 parport_generic_irq(pp);
335 static void parport_uss720_write_data(struct parport *pp, unsigned char d)
337 set_1284_register(pp, 0, d, GFP_KERNEL);
340 static unsigned char parport_uss720_read_data(struct parport *pp)
344 if (get_1284_register(pp, 0, &ret, GFP_KERNEL))
349 static void parport_uss720_write_control(struct parport *pp, unsigned char d)
351 struct parport_uss720_private *priv = pp->private_data;
353 d = (d & 0xf) | (priv->reg[1] & 0xf0);
354 if (set_1284_register(pp, 2, d, GFP_KERNEL))
359 static unsigned char parport_uss720_read_control(struct parport *pp)
361 struct parport_uss720_private *priv = pp->private_data;
362 return priv->reg[1] & 0xf; /* Use soft copy */
365 static unsigned char parport_uss720_frob_control(struct parport *pp, unsigned char mask, unsigned char val)
367 struct parport_uss720_private *priv = pp->private_data;
372 d = (priv->reg[1] & (~mask)) ^ val;
373 if (set_1284_register(pp, 2, d, GFP_ATOMIC))
379 static unsigned char parport_uss720_read_status(struct parport *pp)
383 if (get_1284_register(pp, 1, &ret, GFP_ATOMIC))
388 static void parport_uss720_disable_irq(struct parport *pp)
390 struct parport_uss720_private *priv = pp->private_data;
393 d = priv->reg[1] & ~0x10;
394 if (set_1284_register(pp, 2, d, GFP_KERNEL))
399 static void parport_uss720_enable_irq(struct parport *pp)
401 struct parport_uss720_private *priv = pp->private_data;
404 d = priv->reg[1] | 0x10;
405 if (set_1284_register(pp, 2, d, GFP_KERNEL))
410 static void parport_uss720_data_forward (struct parport *pp)
412 struct parport_uss720_private *priv = pp->private_data;
415 d = priv->reg[1] & ~0x20;
416 if (set_1284_register(pp, 2, d, GFP_KERNEL))
421 static void parport_uss720_data_reverse (struct parport *pp)
423 struct parport_uss720_private *priv = pp->private_data;
426 d = priv->reg[1] | 0x20;
427 if (set_1284_register(pp, 2, d, GFP_KERNEL))
432 static void parport_uss720_init_state(struct pardevice *dev, struct parport_state *s)
434 s->u.pc.ctr = 0xc | (dev->irq_func ? 0x10 : 0x0);
438 static void parport_uss720_save_state(struct parport *pp, struct parport_state *s)
440 struct parport_uss720_private *priv = pp->private_data;
443 if (get_1284_register(pp, 2, NULL, GFP_ATOMIC))
446 s->u.pc.ctr = priv->reg[1];
447 s->u.pc.ecr = priv->reg[2];
450 static void parport_uss720_restore_state(struct parport *pp, struct parport_state *s)
452 struct parport_uss720_private *priv = pp->private_data;
454 set_1284_register(pp, 2, s->u.pc.ctr, GFP_ATOMIC);
455 set_1284_register(pp, 6, s->u.pc.ecr, GFP_ATOMIC);
456 get_1284_register(pp, 2, NULL, GFP_ATOMIC);
457 priv->reg[1] = s->u.pc.ctr;
458 priv->reg[2] = s->u.pc.ecr;
461 static size_t parport_uss720_epp_read_data(struct parport *pp, void *buf, size_t length, int flags)
463 struct parport_uss720_private *priv = pp->private_data;
466 if (change_mode(pp, ECR_EPP))
468 for (; got < length; got++) {
469 if (get_1284_register(pp, 4, (char *)buf, GFP_KERNEL))
472 if (priv->reg[0] & 0x01) {
473 clear_epp_timeout(pp);
477 change_mode(pp, ECR_PS2);
481 static size_t parport_uss720_epp_write_data(struct parport *pp, const void *buf, size_t length, int flags)
484 struct parport_uss720_private *priv = pp->private_data;
487 if (change_mode(pp, ECR_EPP))
489 for (; written < length; written++) {
490 if (set_1284_register(pp, 4, (char *)buf, GFP_KERNEL))
493 if (get_1284_register(pp, 1, NULL, GFP_KERNEL))
495 if (priv->reg[0] & 0x01) {
496 clear_epp_timeout(pp);
500 change_mode(pp, ECR_PS2);
503 struct parport_uss720_private *priv = pp->private_data;
504 struct usb_device *usbdev = priv->usbdev;
510 if (change_mode(pp, ECR_EPP))
512 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buf, length, &rlen, 20000);
514 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %zu rlen %u\n", buf, length, rlen);
515 change_mode(pp, ECR_PS2);
520 static size_t parport_uss720_epp_read_addr(struct parport *pp, void *buf, size_t length, int flags)
522 struct parport_uss720_private *priv = pp->private_data;
525 if (change_mode(pp, ECR_EPP))
527 for (; got < length; got++) {
528 if (get_1284_register(pp, 3, (char *)buf, GFP_KERNEL))
531 if (priv->reg[0] & 0x01) {
532 clear_epp_timeout(pp);
536 change_mode(pp, ECR_PS2);
540 static size_t parport_uss720_epp_write_addr(struct parport *pp, const void *buf, size_t length, int flags)
542 struct parport_uss720_private *priv = pp->private_data;
545 if (change_mode(pp, ECR_EPP))
547 for (; written < length; written++) {
548 if (set_1284_register(pp, 3, *(char *)buf, GFP_KERNEL))
551 if (get_1284_register(pp, 1, NULL, GFP_KERNEL))
553 if (priv->reg[0] & 0x01) {
554 clear_epp_timeout(pp);
558 change_mode(pp, ECR_PS2);
562 static size_t parport_uss720_ecp_write_data(struct parport *pp, const void *buffer, size_t len, int flags)
564 struct parport_uss720_private *priv = pp->private_data;
565 struct usb_device *usbdev = priv->usbdev;
571 if (change_mode(pp, ECR_ECP))
573 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buffer, len, &rlen, 20000);
575 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %zu rlen %u\n", buffer, len, rlen);
576 change_mode(pp, ECR_PS2);
580 static size_t parport_uss720_ecp_read_data(struct parport *pp, void *buffer, size_t len, int flags)
582 struct parport_uss720_private *priv = pp->private_data;
583 struct usb_device *usbdev = priv->usbdev;
589 if (change_mode(pp, ECR_ECP))
591 i = usb_bulk_msg(usbdev, usb_rcvbulkpipe(usbdev, 2), buffer, len, &rlen, 20000);
593 printk(KERN_ERR "uss720: recvbulk ep 2 buf %p len %zu rlen %u\n", buffer, len, rlen);
594 change_mode(pp, ECR_PS2);
598 static size_t parport_uss720_ecp_write_addr(struct parport *pp, const void *buffer, size_t len, int flags)
602 if (change_mode(pp, ECR_ECP))
604 for (; written < len; written++) {
605 if (set_1284_register(pp, 5, *(char *)buffer, GFP_KERNEL))
609 change_mode(pp, ECR_PS2);
613 static size_t parport_uss720_write_compat(struct parport *pp, const void *buffer, size_t len, int flags)
615 struct parport_uss720_private *priv = pp->private_data;
616 struct usb_device *usbdev = priv->usbdev;
622 if (change_mode(pp, ECR_PPF))
624 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buffer, len, &rlen, 20000);
626 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %zu rlen %u\n", buffer, len, rlen);
627 change_mode(pp, ECR_PS2);
631 /* --------------------------------------------------------------------- */
633 static struct parport_operations parport_uss720_ops =
635 .owner = THIS_MODULE,
636 .write_data = parport_uss720_write_data,
637 .read_data = parport_uss720_read_data,
639 .write_control = parport_uss720_write_control,
640 .read_control = parport_uss720_read_control,
641 .frob_control = parport_uss720_frob_control,
643 .read_status = parport_uss720_read_status,
645 .enable_irq = parport_uss720_enable_irq,
646 .disable_irq = parport_uss720_disable_irq,
648 .data_forward = parport_uss720_data_forward,
649 .data_reverse = parport_uss720_data_reverse,
651 .init_state = parport_uss720_init_state,
652 .save_state = parport_uss720_save_state,
653 .restore_state = parport_uss720_restore_state,
655 .epp_write_data = parport_uss720_epp_write_data,
656 .epp_read_data = parport_uss720_epp_read_data,
657 .epp_write_addr = parport_uss720_epp_write_addr,
658 .epp_read_addr = parport_uss720_epp_read_addr,
660 .ecp_write_data = parport_uss720_ecp_write_data,
661 .ecp_read_data = parport_uss720_ecp_read_data,
662 .ecp_write_addr = parport_uss720_ecp_write_addr,
664 .compat_write_data = parport_uss720_write_compat,
665 .nibble_read_data = parport_ieee1284_read_nibble,
666 .byte_read_data = parport_ieee1284_read_byte,
669 /* --------------------------------------------------------------------- */
671 static int uss720_probe(struct usb_interface *intf,
672 const struct usb_device_id *id)
674 struct usb_device *usbdev = usb_get_dev(interface_to_usbdev(intf));
675 struct usb_host_interface *interface;
676 struct usb_endpoint_descriptor *epd;
677 struct parport_uss720_private *priv;
682 dev_dbg(&intf->dev, "probe: vendor id 0x%x, device id 0x%x\n",
683 le16_to_cpu(usbdev->descriptor.idVendor),
684 le16_to_cpu(usbdev->descriptor.idProduct));
686 /* our known interfaces have 3 alternate settings */
687 if (intf->num_altsetting != 3) {
691 i = usb_set_interface(usbdev, intf->altsetting->desc.bInterfaceNumber, 2);
692 dev_dbg(&intf->dev, "set interface result %d\n", i);
694 interface = intf->cur_altsetting;
696 if (interface->desc.bNumEndpoints < 3) {
702 * Allocate parport interface
704 priv = kzalloc(sizeof(struct parport_uss720_private), GFP_KERNEL);
710 priv->usbdev = usbdev;
711 kref_init(&priv->ref_count);
712 spin_lock_init(&priv->asynclock);
713 INIT_LIST_HEAD(&priv->asynclist);
714 pp = parport_register_port(0, PARPORT_IRQ_NONE, PARPORT_DMA_NONE, &parport_uss720_ops);
716 printk(KERN_WARNING "uss720: could not register parport\n");
721 pp->private_data = priv;
722 pp->modes = PARPORT_MODE_PCSPP | PARPORT_MODE_TRISTATE | PARPORT_MODE_EPP | PARPORT_MODE_ECP | PARPORT_MODE_COMPAT;
724 /* set the USS720 control register to manual mode, no ECP compression, enable all ints */
725 set_1284_register(pp, 7, 0x00, GFP_KERNEL);
726 set_1284_register(pp, 6, 0x30, GFP_KERNEL); /* PS/2 mode */
727 set_1284_register(pp, 2, 0x0c, GFP_KERNEL);
729 get_1284_register(pp, 0, ®, GFP_KERNEL);
730 dev_dbg(&intf->dev, "reg: %7ph\n", priv->reg);
732 i = usb_find_last_int_in_endpoint(interface, &epd);
734 dev_dbg(&intf->dev, "epaddr %d interval %d\n",
735 epd->bEndpointAddress, epd->bInterval);
737 parport_announce_port(pp);
739 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;
758 dev_dbg(&intf->dev, "parport_remove_port\n");
759 parport_remove_port(pp);
760 parport_put_port(pp);
761 kill_all_async_requests_priv(priv);
762 kref_put(&priv->ref_count, destroy_priv);
764 dev_dbg(&intf->dev, "disconnect done\n");
767 /* table of cables that work through this driver */
768 static const struct usb_device_id uss720_table[] = {
769 { USB_DEVICE(0x047e, 0x1001) },
770 { USB_DEVICE(0x04b8, 0x0002) },
771 { USB_DEVICE(0x04b8, 0x0003) },
772 { USB_DEVICE(0x050d, 0x0002) },
773 { USB_DEVICE(0x050d, 0x1202) },
774 { USB_DEVICE(0x0557, 0x2001) },
775 { USB_DEVICE(0x05ab, 0x0002) },
776 { USB_DEVICE(0x06c6, 0x0100) },
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_DESC "\n");
806 printk(KERN_INFO KBUILD_MODNAME ": NOTE: this is a special purpose "
807 "driver to allow nonstandard\n");
808 printk(KERN_INFO KBUILD_MODNAME ": protocols (eg. bitbang) over "
809 "USS720 usb to parallel cables\n");
810 printk(KERN_INFO KBUILD_MODNAME ": If you just want to connect to a "
811 "printer, use usblp instead\n");
816 static void __exit uss720_cleanup(void)
818 usb_deregister(&uss720_driver);
821 module_init(uss720_init);
822 module_exit(uss720_cleanup);
824 /* --------------------------------------------------------------------- */