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
36 * 08.04.01 Identify version on module load. gb
40 /*****************************************************************************/
42 #include <linux/module.h>
43 #include <linux/socket.h>
44 #include <linux/parport.h>
45 #include <linux/init.h>
46 #include <linux/usb.h>
51 #define DRIVER_VERSION "v0.5"
52 #define DRIVER_AUTHOR "Thomas M. Sailer, sailer@ife.ee.ethz.ch"
53 #define DRIVER_DESC "USB Parport Cable driver for Cables using the Lucent Technologies USS720 Chip"
55 /* --------------------------------------------------------------------- */
57 struct parport_uss720_private {
58 struct usb_device *usbdev;
61 unsigned char reg[7]; /* USB registers */
64 /* --------------------------------------------------------------------- */
66 static int get_1284_register(struct parport *pp, unsigned char reg, unsigned char *val)
68 struct parport_uss720_private *priv = pp->private_data;
69 struct usb_device *usbdev = priv->usbdev;
70 static const unsigned char regindex[9] = {
71 4, 0, 1, 5, 5, 0, 2, 3, 6
77 ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev,0), 3, 0xc0, ((unsigned int)reg) << 8, 0, priv->reg, 7, HZ);
79 printk(KERN_DEBUG "uss720: get_1284_register(%d) failed, status 0x%x expected 7\n",
80 (unsigned int)reg, ret);
84 printk(KERN_DEBUG "uss720: get_1284_register(%d) return %02x %02x %02x %02x %02x %02x %02x\n",
85 (unsigned int)reg, (unsigned int)priv->reg[0], (unsigned int)priv->reg[1],
86 (unsigned int)priv->reg[2], (unsigned int)priv->reg[3], (unsigned int)priv->reg[4],
87 (unsigned int)priv->reg[5], (unsigned int)priv->reg[6]);
89 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
90 if (priv->reg[2] & priv->reg[1] & 0x10)
91 parport_generic_irq(0, pp, NULL);
95 *val = priv->reg[(reg >= 9) ? 0 : regindex[reg]];
99 static int set_1284_register(struct parport *pp, unsigned char reg, unsigned char val)
101 struct parport_uss720_private *priv = pp->private_data;
102 struct usb_device *usbdev = priv->usbdev;
107 ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev,0), 4, 0x40, (((unsigned int)reg) << 8) | val, 0, NULL, 0, HZ);
109 printk(KERN_DEBUG "uss720: set_1284_register(%u,0x%02x) failed, status 0x%x\n",
110 (unsigned int)reg, (unsigned int)val, ret);
113 printk(KERN_DEBUG "uss720: set_1284_register(%u,0x%02x)\n",
114 (unsigned int)reg, (unsigned int)val);
120 /* --------------------------------------------------------------------- */
129 /* Safely change the mode bits in the ECR */
130 static int change_mode(struct parport *pp, int m)
132 struct parport_uss720_private *priv = pp->private_data;
135 if (get_1284_register(pp, 6, NULL))
137 /* Bits <7:5> contain the mode. */
138 mode = (priv->reg[2] >> 5) & 0x7;
141 /* We have to go through mode 000 or 001 */
142 if (mode > ECR_PS2 && m > ECR_PS2)
143 if (change_mode(pp, ECR_PS2))
146 if (m <= ECR_PS2 && !(priv->reg[1] & 0x20)) {
147 /* This mode resets the FIFO, so we may
148 * have to wait for it to drain first. */
149 long expire = jiffies + pp->physport->cad->timeout;
151 case ECR_PPF: /* Parallel Port FIFO mode */
152 case ECR_ECP: /* ECP Parallel Port mode */
155 if (get_1284_register(pp, 6, NULL))
157 if (priv->reg[2] & 0x01)
159 if (time_after_eq (jiffies, expire))
160 /* The FIFO is stuck. */
162 set_current_state(TASK_INTERRUPTIBLE);
163 schedule_timeout((HZ + 99) / 100);
164 if (signal_pending (current))
170 if (set_1284_register(pp, 6, m << 5))
176 * Clear TIMEOUT BIT in EPP MODE
178 static int clear_epp_timeout(struct parport *pp)
182 if (get_1284_register(pp, 1, &stat))
191 static int uss720_irq(int usbstatus, void *buffer, int len, void *dev_id)
193 struct parport *pp = (struct parport *)dev_id;
194 struct parport_uss720_private *priv = pp->private_data;
196 if (usbstatus != USB_ST_NOERROR || len < 4 || !buffer)
198 memcpy(priv->reg, buffer, 4);
199 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
200 if (priv->reg[2] & priv->reg[1] & 0x10)
201 parport_generic_irq(0, pp, NULL);
206 static void parport_uss720_write_data(struct parport *pp, unsigned char d)
208 set_1284_register(pp, 0, d);
211 static unsigned char parport_uss720_read_data(struct parport *pp)
215 if (get_1284_register(pp, 0, &ret))
220 static void parport_uss720_write_control(struct parport *pp, unsigned char d)
222 struct parport_uss720_private *priv = pp->private_data;
224 d = (d & 0xf) | (priv->reg[1] & 0xf0);
225 if (set_1284_register(pp, 2, d))
230 static unsigned char parport_uss720_read_control(struct parport *pp)
232 struct parport_uss720_private *priv = pp->private_data;
233 return priv->reg[1] & 0xf; /* Use soft copy */
236 static unsigned char parport_uss720_frob_control(struct parport *pp, unsigned char mask, unsigned char val)
238 struct parport_uss720_private *priv = pp->private_data;
243 d = (priv->reg[1] & (~mask)) ^ val;
244 if (set_1284_register(pp, 2, d))
250 static unsigned char parport_uss720_read_status(struct parport *pp)
254 if (get_1284_register(pp, 1, &ret))
259 static void parport_uss720_disable_irq(struct parport *pp)
261 struct parport_uss720_private *priv = pp->private_data;
264 d = priv->reg[1] & ~0x10;
265 if (set_1284_register(pp, 2, d))
270 static void parport_uss720_enable_irq(struct parport *pp)
272 struct parport_uss720_private *priv = pp->private_data;
275 d = priv->reg[1] | 0x10;
276 if (set_1284_register(pp, 2, d))
281 static void parport_uss720_data_forward (struct parport *pp)
283 struct parport_uss720_private *priv = pp->private_data;
286 d = priv->reg[1] & ~0x20;
287 if (set_1284_register(pp, 2, d))
292 static void parport_uss720_data_reverse (struct parport *pp)
294 struct parport_uss720_private *priv = pp->private_data;
297 d = priv->reg[1] | 0x20;
298 if (set_1284_register(pp, 2, d))
303 static void parport_uss720_init_state(struct pardevice *dev, struct parport_state *s)
305 s->u.pc.ctr = 0xc | (dev->irq_func ? 0x10 : 0x0);
309 static void parport_uss720_save_state(struct parport *pp, struct parport_state *s)
311 struct parport_uss720_private *priv = pp->private_data;
313 if (get_1284_register(pp, 2, NULL))
315 s->u.pc.ctr = priv->reg[1];
316 s->u.pc.ecr = priv->reg[2];
319 static void parport_uss720_restore_state(struct parport *pp, struct parport_state *s)
321 set_1284_register(pp, 2, s->u.pc.ctr);
322 set_1284_register(pp, 6, s->u.pc.ecr);
323 get_1284_register(pp, 2, NULL);
326 static size_t parport_uss720_epp_read_data(struct parport *pp, void *buf, size_t length, int flags)
328 struct parport_uss720_private *priv = pp->private_data;
332 if (change_mode(pp, ECR_EPP))
334 for (; got < length; got++) {
335 if (get_1284_register(pp, 4, buff))
338 if (priv->reg[0] & 0x01) {
339 clear_epp_timeout(pp);
343 change_mode(pp, ECR_PS2);
347 static size_t parport_uss720_epp_write_data(struct parport *pp, const void *buf, size_t length, int flags)
350 struct parport_uss720_private *priv = pp->private_data;
352 const char *buff = buf;
354 if (change_mode(pp, ECR_EPP))
356 for (; written < length; written++) {
357 if (set_1284_register(pp, 4, *buff))
360 if (get_1284_register(pp, 1, NULL))
362 if (priv->reg[0] & 0x01) {
363 clear_epp_timeout(pp);
367 change_mode(pp, ECR_PS2);
370 struct parport_uss720_private *priv = pp->private_data;
371 struct usb_device *usbdev = priv->usbdev;
377 if (change_mode(pp, ECR_EPP))
379 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buf, length, &rlen, HZ*20);
381 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %Zu rlen %u\n", buf, length, rlen);
382 change_mode(pp, ECR_PS2);
387 static size_t parport_uss720_epp_read_addr(struct parport *pp, void *buf, size_t length, int flags)
389 struct parport_uss720_private *priv = pp->private_data;
393 if (change_mode(pp, ECR_EPP))
395 for (; got < length; got++) {
396 if (get_1284_register(pp, 3, buff))
399 if (priv->reg[0] & 0x01) {
400 clear_epp_timeout(pp);
404 change_mode(pp, ECR_PS2);
408 static size_t parport_uss720_epp_write_addr(struct parport *pp, const void *buf, size_t length, int flags)
410 struct parport_uss720_private *priv = pp->private_data;
412 const char *buff = buf;
414 if (change_mode(pp, ECR_EPP))
416 for (; written < length; written++) {
417 if (set_1284_register(pp, 3, *buff))
420 if (get_1284_register(pp, 1, NULL))
422 if (priv->reg[0] & 0x01) {
423 clear_epp_timeout(pp);
427 change_mode(pp, ECR_PS2);
431 static size_t parport_uss720_ecp_write_data(struct parport *pp, const void *buffer, size_t len, int flags)
433 struct parport_uss720_private *priv = pp->private_data;
434 struct usb_device *usbdev = priv->usbdev;
440 if (change_mode(pp, ECR_ECP))
442 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buffer, len, &rlen, HZ*20);
444 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %Zu rlen %u\n", buffer, len, rlen);
445 change_mode(pp, ECR_PS2);
449 static size_t parport_uss720_ecp_read_data(struct parport *pp, void *buffer, size_t len, int flags)
451 struct parport_uss720_private *priv = pp->private_data;
452 struct usb_device *usbdev = priv->usbdev;
458 if (change_mode(pp, ECR_ECP))
460 i = usb_bulk_msg(usbdev, usb_rcvbulkpipe(usbdev, 2), buffer, len, &rlen, HZ*20);
462 printk(KERN_ERR "uss720: recvbulk ep 2 buf %p len %Zu rlen %u\n", buffer, len, rlen);
463 change_mode(pp, ECR_PS2);
467 static size_t parport_uss720_ecp_write_addr(struct parport *pp, const void *buffer, size_t len, int flags)
470 const char *buff = buffer;
472 if (change_mode(pp, ECR_ECP))
474 for (; written < len; written++) {
475 if (set_1284_register(pp, 5, *buff))
479 change_mode(pp, ECR_PS2);
483 static size_t parport_uss720_write_compat(struct parport *pp, const void *buffer, size_t len, int flags)
485 struct parport_uss720_private *priv = pp->private_data;
486 struct usb_device *usbdev = priv->usbdev;
492 if (change_mode(pp, ECR_PPF))
494 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buffer, len, &rlen, HZ*20);
496 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %Zu rlen %u\n", buffer, len, rlen);
497 change_mode(pp, ECR_PS2);
501 void parport_uss720_inc_use_count(void)
506 void parport_uss720_dec_use_count(void)
511 /* --------------------------------------------------------------------- */
513 static struct parport_operations parport_uss720_ops =
515 parport_uss720_write_data,
516 parport_uss720_read_data,
518 parport_uss720_write_control,
519 parport_uss720_read_control,
520 parport_uss720_frob_control,
522 parport_uss720_read_status,
524 parport_uss720_enable_irq,
525 parport_uss720_disable_irq,
527 parport_uss720_data_forward,
528 parport_uss720_data_reverse,
530 parport_uss720_init_state,
531 parport_uss720_save_state,
532 parport_uss720_restore_state,
534 parport_uss720_inc_use_count,
535 parport_uss720_dec_use_count,
537 parport_uss720_epp_write_data,
538 parport_uss720_epp_read_data,
539 parport_uss720_epp_write_addr,
540 parport_uss720_epp_read_addr,
542 parport_uss720_ecp_write_data,
543 parport_uss720_ecp_read_data,
544 parport_uss720_ecp_write_addr,
546 parport_uss720_write_compat,
547 parport_ieee1284_read_nibble,
548 parport_ieee1284_read_byte,
551 /* --------------------------------------------------------------------- */
553 static void * uss720_probe(struct usb_device *usbdev, unsigned int ifnum,
554 const struct usb_device_id *id)
556 struct usb_interface_descriptor *interface;
557 struct usb_endpoint_descriptor *endpoint;
558 struct parport_uss720_private *priv;
562 printk(KERN_DEBUG "uss720: probe: vendor id 0x%x, device id 0x%x\n",
563 usbdev->descriptor.idVendor, usbdev->descriptor.idProduct);
565 /* our known interfaces have 3 alternate settings */
566 if (usbdev->actconfig->interface[ifnum].num_altsetting != 3)
569 i = usb_set_interface(usbdev, ifnum, 2);
570 printk(KERN_DEBUG "uss720: set inteface result %d\n", i);
572 interface = &usbdev->actconfig->interface[ifnum].altsetting[2];
575 * Allocate parport interface
577 printk(KERN_INFO "uss720: (C) 1999 by Thomas Sailer, <sailer@ife.ee.ethz.ch>\n");
579 if (!(priv = kmalloc(sizeof(struct parport_uss720_private), GFP_KERNEL)))
581 if (!(pp = parport_register_port(0, PARPORT_IRQ_NONE, PARPORT_DMA_NONE, &parport_uss720_ops))) {
582 printk(KERN_WARNING "usb-uss720: could not register parport\n");
586 pp->private_data = priv;
587 priv->usbdev = usbdev;
588 pp->modes = PARPORT_MODE_PCSPP | PARPORT_MODE_TRISTATE | PARPORT_MODE_EPP | PARPORT_MODE_ECP | PARPORT_MODE_COMPAT;
590 /* set the USS720 control register to manual mode, no ECP compression, enable all ints */
591 set_1284_register(pp, 7, 0x00);
592 set_1284_register(pp, 6, 0x30); /* PS/2 mode */
593 set_1284_register(pp, 2, 0x0c);
595 get_1284_register(pp, 0, NULL);
596 printk("uss720: reg: %02x %02x %02x %02x %02x %02x %02x\n",
597 priv->reg[0], priv->reg[1], priv->reg[2], priv->reg[3], priv->reg[4], priv->reg[5], priv->reg[6]);
599 endpoint = &interface->endpoint[2];
600 printk(KERN_DEBUG "uss720: epaddr %d interval %d\n", endpoint->bEndpointAddress, endpoint->bInterval);
602 priv->irqpipe = usb_rcvctrlpipe(usbdev, endpoint->bEndpointAddress);
603 i = usb_request_irq(usbdev, priv->irqpipe,
604 uss720_irq, endpoint->bInterval,
605 pp, &priv->irqhandle);
607 printk (KERN_WARNING "usb-uss720: usb_request_irq failed (0x%x)\n", i);
608 goto probe_abort_port;
611 parport_proc_register(pp);
612 parport_announce_port(pp);
619 parport_unregister_port(pp);
626 static void uss720_disconnect(struct usb_device *usbdev, void *ptr)
628 struct parport *pp = (struct parport *)ptr;
629 struct parport_uss720_private *priv = pp->private_data;
632 usb_release_irq(usbdev, priv->irqhandle, priv->irqpipe);
635 parport_proc_unregister(pp);
636 parport_unregister_port(pp);
641 /* table of cables that work through this driver */
642 static struct usb_device_id uss720_table [] = {
643 { USB_DEVICE(0x047e, 0x1001) },
644 { USB_DEVICE(0x0557, 0x2001) },
645 { USB_DEVICE(0x0729, 0x1284) },
646 { USB_DEVICE(0x1293, 0x0002) },
647 { } /* Terminating entry */
650 MODULE_DEVICE_TABLE (usb, uss720_table);
653 static struct usb_driver uss720_driver = {
656 disconnect: uss720_disconnect,
657 id_table: uss720_table,
660 /* --------------------------------------------------------------------- */
662 MODULE_AUTHOR( DRIVER_AUTHOR );
663 MODULE_DESCRIPTION( DRIVER_DESC );
664 MODULE_LICENSE("GPL");
666 static int __init uss720_init(void)
668 if (usb_register(&uss720_driver) < 0)
671 info(DRIVER_VERSION ":" DRIVER_DESC);
675 static void __exit uss720_cleanup(void)
677 usb_deregister(&uss720_driver);
680 module_init(uss720_init);
681 module_exit(uss720_cleanup);
683 /* --------------------------------------------------------------------- */