File: /usr/src/linux/drivers/usb/uss720.c
1 /*****************************************************************************/
2
3 /*
4 * uss720.c -- USS720 USB Parport Cable.
5 *
6 * Copyright (C) 1999
7 * Thomas Sailer (sailer@ife.ee.ethz.ch)
8 *
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.
13 *
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.
18 *
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.
22 *
23 * Based on parport_pc.c
24 *
25 * History:
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
37 *
38 */
39
40 /*****************************************************************************/
41
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>
47
48 /*
49 * Version Information
50 */
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"
54
55 /* --------------------------------------------------------------------- */
56
57 struct parport_uss720_private {
58 struct usb_device *usbdev;
59 void *irqhandle;
60 unsigned int irqpipe;
61 unsigned char reg[7]; /* USB registers */
62 };
63
64 /* --------------------------------------------------------------------- */
65
66 static int get_1284_register(struct parport *pp, unsigned char reg, unsigned char *val)
67 {
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
72 };
73 int ret;
74
75 if (!usbdev)
76 return -1;
77 ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev,0), 3, 0xc0, ((unsigned int)reg) << 8, 0, priv->reg, 7, HZ);
78 if (ret) {
79 printk(KERN_DEBUG "uss720: get_1284_register(%d) failed, status 0x%x\n",
80 (unsigned int)reg, ret);
81 } else {
82 #if 0
83 printk(KERN_DEBUG "uss720: get_1284_register(%d) return %02x %02x %02x %02x %02x %02x %02x\n",
84 (unsigned int)reg, (unsigned int)priv->reg[0], (unsigned int)priv->reg[1],
85 (unsigned int)priv->reg[2], (unsigned int)priv->reg[3], (unsigned int)priv->reg[4],
86 (unsigned int)priv->reg[5], (unsigned int)priv->reg[6]);
87 #endif
88 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
89 if (priv->reg[2] & priv->reg[1] & 0x10)
90 parport_generic_irq(0, pp, NULL);
91 }
92 if (val)
93 *val = priv->reg[(reg >= 9) ? 0 : regindex[reg]];
94 return ret;
95 }
96
97 static int set_1284_register(struct parport *pp, unsigned char reg, unsigned char val)
98 {
99 struct parport_uss720_private *priv = pp->private_data;
100 struct usb_device *usbdev = priv->usbdev;
101 int ret;
102
103 if (!usbdev)
104 return -1;
105 ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev,0), 4, 0x40, (((unsigned int)reg) << 8) | val, 0, NULL, 0, HZ);
106 if (ret) {
107 printk(KERN_DEBUG "uss720: set_1284_register(%u,0x%02x) failed, status 0x%x\n",
108 (unsigned int)reg, (unsigned int)val, ret);
109 } else {
110 #if 0
111 printk(KERN_DEBUG "uss720: set_1284_register(%u,0x%02x)\n",
112 (unsigned int)reg, (unsigned int)val);
113 #endif
114 }
115 return ret;
116 }
117
118 /* --------------------------------------------------------------------- */
119
120 /* ECR modes */
121 #define ECR_SPP 00
122 #define ECR_PS2 01
123 #define ECR_PPF 02
124 #define ECR_ECP 03
125 #define ECR_EPP 04
126
127 /* Safely change the mode bits in the ECR */
128 static int change_mode(struct parport *pp, int m)
129 {
130 struct parport_uss720_private *priv = pp->private_data;
131 int mode;
132
133 if (get_1284_register(pp, 6, NULL))
134 return -EIO;
135 /* Bits <7:5> contain the mode. */
136 mode = (priv->reg[2] >> 5) & 0x7;
137 if (mode == m)
138 return 0;
139 /* We have to go through mode 000 or 001 */
140 if (mode > ECR_PS2 && m > ECR_PS2)
141 if (change_mode(pp, ECR_PS2))
142 return -EIO;
143
144 if (m <= ECR_PS2 && !(priv->reg[1] & 0x20)) {
145 /* This mode resets the FIFO, so we may
146 * have to wait for it to drain first. */
147 long expire = jiffies + pp->physport->cad->timeout;
148 switch (mode) {
149 case ECR_PPF: /* Parallel Port FIFO mode */
150 case ECR_ECP: /* ECP Parallel Port mode */
151 /* Poll slowly. */
152 for (;;) {
153 if (get_1284_register(pp, 6, NULL))
154 return -EIO;
155 if (priv->reg[2] & 0x01)
156 break;
157 if (time_after_eq (jiffies, expire))
158 /* The FIFO is stuck. */
159 return -EBUSY;
160 current->state = TASK_INTERRUPTIBLE;
161 schedule_timeout((HZ + 99) / 100);
162 if (signal_pending (current))
163 break;
164 }
165 }
166 }
167 /* Set the mode. */
168 if (set_1284_register(pp, 6, m << 5))
169 return -EIO;
170 return 0;
171 }
172
173 /*
174 * Clear TIMEOUT BIT in EPP MODE
175 */
176 static int clear_epp_timeout(struct parport *pp)
177 {
178 unsigned char stat;
179
180 if (get_1284_register(pp, 1, &stat))
181 return 1;
182 return stat & 1;
183 }
184
185 /*
186 * Access functions.
187 */
188 #if 0
189 static int uss720_irq(int usbstatus, void *buffer, int len, void *dev_id)
190 {
191 struct parport *pp = (struct parport *)dev_id;
192 struct parport_uss720_private *priv = pp->private_data;
193
194 if (usbstatus != USB_ST_NOERROR || len < 4 || !buffer)
195 return 1;
196 memcpy(priv->reg, buffer, 4);
197 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
198 if (priv->reg[2] & priv->reg[1] & 0x10)
199 parport_generic_irq(0, pp, NULL);
200 return 1;
201 }
202 #endif
203
204 static void parport_uss720_write_data(struct parport *pp, unsigned char d)
205 {
206 set_1284_register(pp, 0, d);
207 }
208
209 static unsigned char parport_uss720_read_data(struct parport *pp)
210 {
211 unsigned char ret;
212
213 if (get_1284_register(pp, 0, &ret))
214 return 0;
215 return ret;
216 }
217
218 static void parport_uss720_write_control(struct parport *pp, unsigned char d)
219 {
220 struct parport_uss720_private *priv = pp->private_data;
221
222 d = (d & 0xf) | (priv->reg[1] & 0xf0);
223 if (set_1284_register(pp, 2, d))
224 return;
225 priv->reg[1] = d;
226 }
227
228 static unsigned char parport_uss720_read_control(struct parport *pp)
229 {
230 struct parport_uss720_private *priv = pp->private_data;
231 return priv->reg[1] & 0xf; /* Use soft copy */
232 }
233
234 static unsigned char parport_uss720_frob_control(struct parport *pp, unsigned char mask, unsigned char val)
235 {
236 struct parport_uss720_private *priv = pp->private_data;
237 unsigned char d;
238
239 mask &= 0x0f;
240 val &= 0x0f;
241 d = (priv->reg[1] & (~mask)) ^ val;
242 if (set_1284_register(pp, 2, d))
243 return 0;
244 priv->reg[1] = d;
245 return d & 0xf;
246 }
247
248 static unsigned char parport_uss720_read_status(struct parport *pp)
249 {
250 unsigned char ret;
251
252 if (get_1284_register(pp, 1, &ret))
253 return 0;
254 return ret & 0xf8;
255 }
256
257 static void parport_uss720_disable_irq(struct parport *pp)
258 {
259 struct parport_uss720_private *priv = pp->private_data;
260 unsigned char d;
261
262 d = priv->reg[1] & ~0x10;
263 if (set_1284_register(pp, 2, d))
264 return;
265 priv->reg[1] = d;
266 }
267
268 static void parport_uss720_enable_irq(struct parport *pp)
269 {
270 struct parport_uss720_private *priv = pp->private_data;
271 unsigned char d;
272
273 d = priv->reg[1] | 0x10;
274 if (set_1284_register(pp, 2, d))
275 return;
276 priv->reg[1] = d;
277 }
278
279 static void parport_uss720_data_forward (struct parport *pp)
280 {
281 struct parport_uss720_private *priv = pp->private_data;
282 unsigned char d;
283
284 d = priv->reg[1] & ~0x20;
285 if (set_1284_register(pp, 2, d))
286 return;
287 priv->reg[1] = d;
288 }
289
290 static void parport_uss720_data_reverse (struct parport *pp)
291 {
292 struct parport_uss720_private *priv = pp->private_data;
293 unsigned char d;
294
295 d = priv->reg[1] | 0x20;
296 if (set_1284_register(pp, 2, d))
297 return;
298 priv->reg[1] = d;
299 }
300
301 static void parport_uss720_init_state(struct pardevice *dev, struct parport_state *s)
302 {
303 s->u.pc.ctr = 0xc | (dev->irq_func ? 0x10 : 0x0);
304 s->u.pc.ecr = 0x24;
305 }
306
307 static void parport_uss720_save_state(struct parport *pp, struct parport_state *s)
308 {
309 struct parport_uss720_private *priv = pp->private_data;
310
311 if (get_1284_register(pp, 2, NULL))
312 return;
313 s->u.pc.ctr = priv->reg[1];
314 s->u.pc.ecr = priv->reg[2];
315 }
316
317 static void parport_uss720_restore_state(struct parport *pp, struct parport_state *s)
318 {
319 set_1284_register(pp, 2, s->u.pc.ctr);
320 set_1284_register(pp, 6, s->u.pc.ecr);
321 get_1284_register(pp, 2, NULL);
322 }
323
324 static size_t parport_uss720_epp_read_data(struct parport *pp, void *buf, size_t length, int flags)
325 {
326 struct parport_uss720_private *priv = pp->private_data;
327 size_t got = 0;
328
329 if (change_mode(pp, ECR_EPP))
330 return 0;
331 for (; got < length; got++) {
332 if (get_1284_register(pp, 4, (char *)buf))
333 break;
334 ((char*)buf)++;
335 if (priv->reg[0] & 0x01) {
336 clear_epp_timeout(pp);
337 break;
338 }
339 }
340 change_mode(pp, ECR_PS2);
341 return got;
342 }
343
344 static size_t parport_uss720_epp_write_data(struct parport *pp, const void *buf, size_t length, int flags)
345 {
346 #if 0
347 struct parport_uss720_private *priv = pp->private_data;
348 size_t written = 0;
349
350 if (change_mode(pp, ECR_EPP))
351 return 0;
352 for (; written < length; written++) {
353 if (set_1284_register(pp, 4, (char *)buf))
354 break;
355 ((char*)buf)++;
356 if (get_1284_register(pp, 1, NULL))
357 break;
358 if (priv->reg[0] & 0x01) {
359 clear_epp_timeout(pp);
360 break;
361 }
362 }
363 change_mode(pp, ECR_PS2);
364 return written;
365 #else
366 struct parport_uss720_private *priv = pp->private_data;
367 struct usb_device *usbdev = priv->usbdev;
368 int rlen;
369 int i;
370
371 if (!usbdev)
372 return 0;
373 if (change_mode(pp, ECR_EPP))
374 return 0;
375 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buf, length, &rlen, HZ*20);
376 if (i)
377 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %Zu rlen %u\n", buf, length, rlen);
378 change_mode(pp, ECR_PS2);
379 return rlen;
380 #endif
381 }
382
383 static size_t parport_uss720_epp_read_addr(struct parport *pp, void *buf, size_t length, int flags)
384 {
385 struct parport_uss720_private *priv = pp->private_data;
386 size_t got = 0;
387
388 if (change_mode(pp, ECR_EPP))
389 return 0;
390 for (; got < length; got++) {
391 if (get_1284_register(pp, 3, (char *)buf))
392 break;
393 ((char*)buf)++;
394 if (priv->reg[0] & 0x01) {
395 clear_epp_timeout(pp);
396 break;
397 }
398 }
399 change_mode(pp, ECR_PS2);
400 return got;
401 }
402
403 static size_t parport_uss720_epp_write_addr(struct parport *pp, const void *buf, size_t length, int flags)
404 {
405 struct parport_uss720_private *priv = pp->private_data;
406 size_t written = 0;
407
408 if (change_mode(pp, ECR_EPP))
409 return 0;
410 for (; written < length; written++) {
411 if (set_1284_register(pp, 3, *(char *)buf))
412 break;
413 ((char*)buf)++;
414 if (get_1284_register(pp, 1, NULL))
415 break;
416 if (priv->reg[0] & 0x01) {
417 clear_epp_timeout(pp);
418 break;
419 }
420 }
421 change_mode(pp, ECR_PS2);
422 return written;
423 }
424
425 static size_t parport_uss720_ecp_write_data(struct parport *pp, const void *buffer, size_t len, int flags)
426 {
427 struct parport_uss720_private *priv = pp->private_data;
428 struct usb_device *usbdev = priv->usbdev;
429 int rlen;
430 int i;
431
432 if (!usbdev)
433 return 0;
434 if (change_mode(pp, ECR_ECP))
435 return 0;
436 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buffer, len, &rlen, HZ*20);
437 if (i)
438 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %Zu rlen %u\n", buffer, len, rlen);
439 change_mode(pp, ECR_PS2);
440 return rlen;
441 }
442
443 static size_t parport_uss720_ecp_read_data(struct parport *pp, void *buffer, size_t len, int flags)
444 {
445 struct parport_uss720_private *priv = pp->private_data;
446 struct usb_device *usbdev = priv->usbdev;
447 int rlen;
448 int i;
449
450 if (!usbdev)
451 return 0;
452 if (change_mode(pp, ECR_ECP))
453 return 0;
454 i = usb_bulk_msg(usbdev, usb_rcvbulkpipe(usbdev, 2), buffer, len, &rlen, HZ*20);
455 if (i)
456 printk(KERN_ERR "uss720: recvbulk ep 2 buf %p len %Zu rlen %u\n", buffer, len, rlen);
457 change_mode(pp, ECR_PS2);
458 return rlen;
459 }
460
461 static size_t parport_uss720_ecp_write_addr(struct parport *pp, const void *buffer, size_t len, int flags)
462 {
463 size_t written = 0;
464
465 if (change_mode(pp, ECR_ECP))
466 return 0;
467 for (; written < len; written++) {
468 if (set_1284_register(pp, 5, *(char *)buffer))
469 break;
470 ((char*)buffer)++;
471 }
472 change_mode(pp, ECR_PS2);
473 return written;
474 }
475
476 static size_t parport_uss720_write_compat(struct parport *pp, const void *buffer, size_t len, int flags)
477 {
478 struct parport_uss720_private *priv = pp->private_data;
479 struct usb_device *usbdev = priv->usbdev;
480 int rlen;
481 int i;
482
483 if (!usbdev)
484 return 0;
485 if (change_mode(pp, ECR_PPF))
486 return 0;
487 i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buffer, len, &rlen, HZ*20);
488 if (i)
489 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %Zu rlen %u\n", buffer, len, rlen);
490 change_mode(pp, ECR_PS2);
491 return rlen;
492 }
493
494 void parport_uss720_inc_use_count(void)
495 {
496 MOD_INC_USE_COUNT;
497 }
498
499 void parport_uss720_dec_use_count(void)
500 {
501 MOD_DEC_USE_COUNT;
502 }
503
504 /* --------------------------------------------------------------------- */
505
506 static struct parport_operations parport_uss720_ops =
507 {
508 parport_uss720_write_data,
509 parport_uss720_read_data,
510
511 parport_uss720_write_control,
512 parport_uss720_read_control,
513 parport_uss720_frob_control,
514
515 parport_uss720_read_status,
516
517 parport_uss720_enable_irq,
518 parport_uss720_disable_irq,
519
520 parport_uss720_data_forward,
521 parport_uss720_data_reverse,
522
523 parport_uss720_init_state,
524 parport_uss720_save_state,
525 parport_uss720_restore_state,
526
527 parport_uss720_inc_use_count,
528 parport_uss720_dec_use_count,
529
530 parport_uss720_epp_write_data,
531 parport_uss720_epp_read_data,
532 parport_uss720_epp_write_addr,
533 parport_uss720_epp_read_addr,
534
535 parport_uss720_ecp_write_data,
536 parport_uss720_ecp_read_data,
537 parport_uss720_ecp_write_addr,
538
539 parport_uss720_write_compat,
540 parport_ieee1284_read_nibble,
541 parport_ieee1284_read_byte,
542 };
543
544 /* --------------------------------------------------------------------- */
545
546 static void * uss720_probe(struct usb_device *usbdev, unsigned int ifnum,
547 const struct usb_device_id *id)
548 {
549 struct usb_interface_descriptor *interface;
550 struct usb_endpoint_descriptor *endpoint;
551 struct parport_uss720_private *priv;
552 struct parport *pp;
553 int i;
554
555 printk(KERN_DEBUG "uss720: probe: vendor id 0x%x, device id 0x%x\n",
556 usbdev->descriptor.idVendor, usbdev->descriptor.idProduct);
557
558 /* our known interfaces have 3 alternate settings */
559 if (usbdev->actconfig->interface[ifnum].num_altsetting != 3)
560 return NULL;
561
562 i = usb_set_interface(usbdev, ifnum, 2);
563 printk(KERN_DEBUG "uss720: set inteface result %d\n", i);
564
565 interface = &usbdev->actconfig->interface[ifnum].altsetting[2];
566
567 /*
568 * Allocate parport interface
569 */
570 printk(KERN_INFO "uss720: (C) 1999 by Thomas Sailer, <sailer@ife.ee.ethz.ch>\n");
571
572 if (!(priv = kmalloc(sizeof(struct parport_uss720_private), GFP_KERNEL)))
573 return NULL;
574 if (!(pp = parport_register_port(0, PARPORT_IRQ_NONE, PARPORT_DMA_NONE, &parport_uss720_ops))) {
575 printk(KERN_WARNING "usb-uss720: could not register parport\n");
576 goto probe_abort;
577 }
578
579 pp->private_data = priv;
580 priv->usbdev = usbdev;
581 pp->modes = PARPORT_MODE_PCSPP | PARPORT_MODE_TRISTATE | PARPORT_MODE_EPP | PARPORT_MODE_ECP | PARPORT_MODE_COMPAT;
582
583 /* set the USS720 control register to manual mode, no ECP compression, enable all ints */
584 set_1284_register(pp, 7, 0x00);
585 set_1284_register(pp, 6, 0x30); /* PS/2 mode */
586 set_1284_register(pp, 2, 0x0c);
587 /* debugging */
588 get_1284_register(pp, 0, NULL);
589 printk("uss720: reg: %02x %02x %02x %02x %02x %02x %02x\n",
590 priv->reg[0], priv->reg[1], priv->reg[2], priv->reg[3], priv->reg[4], priv->reg[5], priv->reg[6]);
591
592 endpoint = &interface->endpoint[2];
593 printk(KERN_DEBUG "uss720: epaddr %d interval %d\n", endpoint->bEndpointAddress, endpoint->bInterval);
594 #if 0
595 priv->irqpipe = usb_rcvctrlpipe(usbdev, endpoint->bEndpointAddress);
596 i = usb_request_irq(usbdev, priv->irqpipe,
597 uss720_irq, endpoint->bInterval,
598 pp, &priv->irqhandle);
599 if (i) {
600 printk (KERN_WARNING "usb-uss720: usb_request_irq failed (0x%x)\n", i);
601 goto probe_abort_port;
602 }
603 #endif
604 parport_proc_register(pp);
605 parport_announce_port(pp);
606
607 MOD_INC_USE_COUNT;
608 return pp;
609
610 #if 0
611 probe_abort_port:
612 parport_unregister_port(pp);
613 #endif
614 probe_abort:
615 kfree(priv);
616 return NULL;
617 }
618
619 static void uss720_disconnect(struct usb_device *usbdev, void *ptr)
620 {
621 struct parport *pp = (struct parport *)ptr;
622 struct parport_uss720_private *priv = pp->private_data;
623
624 #if 0
625 usb_release_irq(usbdev, priv->irqhandle, priv->irqpipe);
626 #endif
627 priv->usbdev = NULL;
628 parport_proc_unregister(pp);
629 parport_unregister_port(pp);
630 kfree(priv);
631 MOD_DEC_USE_COUNT;
632 }
633
634 /* table of cables that work through this driver */
635 static struct usb_device_id uss720_table [] = {
636 { USB_DEVICE(0x047e, 0x1001) },
637 { USB_DEVICE(0x0557, 0x2001) },
638 { USB_DEVICE(0x0729, 0x1284) },
639 { } /* Terminating entry */
640 };
641
642 MODULE_DEVICE_TABLE (usb, uss720_table);
643
644
645 static struct usb_driver uss720_driver = {
646 name: "uss720",
647 probe: uss720_probe,
648 disconnect: uss720_disconnect,
649 id_table: uss720_table,
650 };
651
652 /* --------------------------------------------------------------------- */
653
654 MODULE_AUTHOR( DRIVER_AUTHOR );
655 MODULE_DESCRIPTION( DRIVER_DESC );
656
657 static int __init uss720_init(void)
658 {
659 if (usb_register(&uss720_driver) < 0)
660 return -1;
661
662 info(DRIVER_VERSION ":" DRIVER_DESC);
663 return 0;
664 }
665
666 static void __exit uss720_cleanup(void)
667 {
668 usb_deregister(&uss720_driver);
669 }
670
671 module_init(uss720_init);
672 module_exit(uss720_cleanup);
673
674 /* --------------------------------------------------------------------- */
675