GNU Linux-libre 4.14.266-gnu1
[releases.git] / drivers / usb / misc / uss720.c
1 /*****************************************************************************/
2
3 /*
4  *      uss720.c  --  USS720 USB Parport Cable.
5  *
6  *      Copyright (C) 1999, 2005, 2010
7  *          Thomas Sailer (t.sailer@alumni.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.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
39  *
40  */
41
42 /*****************************************************************************/
43
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>
54
55 #define DRIVER_AUTHOR "Thomas M. Sailer, t.sailer@alumni.ethz.ch"
56 #define DRIVER_DESC "USB Parport Cable driver for Cables using the Lucent Technologies USS720 Chip"
57
58 /* --------------------------------------------------------------------- */
59
60 struct parport_uss720_private {
61         struct usb_device *usbdev;
62         struct parport *pp;
63         struct kref ref_count;
64         __u8 reg[7];  /* USB registers */
65         struct list_head asynclist;
66         spinlock_t asynclock;
67 };
68
69 struct uss720_async_request {
70         struct parport_uss720_private *priv;
71         struct kref ref_count;
72         struct list_head asynclist;
73         struct completion compl;
74         struct urb *urb;
75         struct usb_ctrlrequest *dr;
76         __u8 reg[7];
77 };
78
79 /* --------------------------------------------------------------------- */
80
81 static void destroy_priv(struct kref *kref)
82 {
83         struct parport_uss720_private *priv = container_of(kref, struct parport_uss720_private, ref_count);
84
85         dev_dbg(&priv->usbdev->dev, "destroying priv datastructure\n");
86         usb_put_dev(priv->usbdev);
87         kfree(priv);
88 }
89
90 static void destroy_async(struct kref *kref)
91 {
92         struct uss720_async_request *rq = container_of(kref, struct uss720_async_request, ref_count);
93         struct parport_uss720_private *priv = rq->priv;
94         unsigned long flags;
95
96         if (likely(rq->urb))
97                 usb_free_urb(rq->urb);
98         kfree(rq->dr);
99         spin_lock_irqsave(&priv->asynclock, flags);
100         list_del_init(&rq->asynclist);
101         spin_unlock_irqrestore(&priv->asynclock, flags);
102         kfree(rq);
103         kref_put(&priv->ref_count, destroy_priv);
104 }
105
106 /* --------------------------------------------------------------------- */
107
108 static void async_complete(struct urb *urb)
109 {
110         struct uss720_async_request *rq;
111         struct parport *pp;
112         struct parport_uss720_private *priv;
113         int status = urb->status;
114
115         rq = urb->context;
116         priv = rq->priv;
117         pp = priv->pp;
118         if (status) {
119                 dev_err(&urb->dev->dev, "async_complete: urb error %d\n",
120                         status);
121         } else if (rq->dr->bRequest == 3) {
122                 memcpy(priv->reg, rq->reg, sizeof(priv->reg));
123 #if 0
124                 dev_dbg(&priv->usbdev->dev, "async_complete regs %7ph\n",
125                         priv->reg);
126 #endif
127                 /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
128                 if (rq->reg[2] & rq->reg[1] & 0x10 && pp)
129                         parport_generic_irq(pp);
130         }
131         complete(&rq->compl);
132         kref_put(&rq->ref_count, destroy_async);
133 }
134
135 static struct uss720_async_request *submit_async_request(struct parport_uss720_private *priv,
136                                                          __u8 request, __u8 requesttype, __u16 value, __u16 index,
137                                                          gfp_t mem_flags)
138 {
139         struct usb_device *usbdev;
140         struct uss720_async_request *rq;
141         unsigned long flags;
142         int ret;
143
144         if (!priv)
145                 return NULL;
146         usbdev = priv->usbdev;
147         if (!usbdev)
148                 return NULL;
149         rq = kzalloc(sizeof(struct uss720_async_request), mem_flags);
150         if (!rq)
151                 return NULL;
152         kref_init(&rq->ref_count);
153         INIT_LIST_HEAD(&rq->asynclist);
154         init_completion(&rq->compl);
155         kref_get(&priv->ref_count);
156         rq->priv = priv;
157         rq->urb = usb_alloc_urb(0, mem_flags);
158         if (!rq->urb) {
159                 kref_put(&rq->ref_count, destroy_async);
160                 return NULL;
161         }
162         rq->dr = kmalloc(sizeof(*rq->dr), mem_flags);
163         if (!rq->dr) {
164                 kref_put(&rq->ref_count, destroy_async);
165                 return NULL;
166         }
167         rq->dr->bRequestType = requesttype;
168         rq->dr->bRequest = request;
169         rq->dr->wValue = cpu_to_le16(value);
170         rq->dr->wIndex = cpu_to_le16(index);
171         rq->dr->wLength = cpu_to_le16((request == 3) ? sizeof(rq->reg) : 0);
172         usb_fill_control_urb(rq->urb, usbdev, (requesttype & 0x80) ? usb_rcvctrlpipe(usbdev, 0) : usb_sndctrlpipe(usbdev, 0),
173                              (unsigned char *)rq->dr,
174                              (request == 3) ? rq->reg : NULL, (request == 3) ? sizeof(rq->reg) : 0, async_complete, rq);
175         /* rq->urb->transfer_flags |= URB_ASYNC_UNLINK; */
176         spin_lock_irqsave(&priv->asynclock, flags);
177         list_add_tail(&rq->asynclist, &priv->asynclist);
178         spin_unlock_irqrestore(&priv->asynclock, flags);
179         kref_get(&rq->ref_count);
180         ret = usb_submit_urb(rq->urb, mem_flags);
181         if (!ret)
182                 return rq;
183         destroy_async(&rq->ref_count);
184         dev_err(&usbdev->dev, "submit_async_request submit_urb failed with %d\n", ret);
185         return NULL;
186 }
187
188 static unsigned int kill_all_async_requests_priv(struct parport_uss720_private *priv)
189 {
190         struct uss720_async_request *rq;
191         unsigned long flags;
192         unsigned int ret = 0;
193
194         spin_lock_irqsave(&priv->asynclock, flags);
195         list_for_each_entry(rq, &priv->asynclist, asynclist) {
196                 usb_unlink_urb(rq->urb);
197                 ret++;
198         }
199         spin_unlock_irqrestore(&priv->asynclock, flags);
200         return ret;
201 }
202
203 /* --------------------------------------------------------------------- */
204
205 static int get_1284_register(struct parport *pp, unsigned char reg, unsigned char *val, gfp_t mem_flags)
206 {
207         struct parport_uss720_private *priv;
208         struct uss720_async_request *rq;
209         static const unsigned char regindex[9] = {
210                 4, 0, 1, 5, 5, 0, 2, 3, 6
211         };
212         int ret;
213
214         if (!pp)
215                 return -EIO;
216         priv = pp->private_data;
217         rq = submit_async_request(priv, 3, 0xc0, ((unsigned int)reg) << 8, 0, mem_flags);
218         if (!rq) {
219                 dev_err(&priv->usbdev->dev, "get_1284_register(%u) failed",
220                         (unsigned int)reg);
221                 return -EIO;
222         }
223         if (!val) {
224                 kref_put(&rq->ref_count, destroy_async);
225                 return 0;
226         }
227         if (wait_for_completion_timeout(&rq->compl, HZ)) {
228                 ret = rq->urb->status;
229                 *val = priv->reg[(reg >= 9) ? 0 : regindex[reg]];
230                 if (ret)
231                         printk(KERN_WARNING "get_1284_register: "
232                                "usb error %d\n", ret);
233                 kref_put(&rq->ref_count, destroy_async);
234                 return ret;
235         }
236         printk(KERN_WARNING "get_1284_register timeout\n");
237         kill_all_async_requests_priv(priv);
238         return -EIO;
239 }
240
241 static int set_1284_register(struct parport *pp, unsigned char reg, unsigned char val, gfp_t mem_flags)
242 {
243         struct parport_uss720_private *priv;
244         struct uss720_async_request *rq;
245
246         if (!pp)
247                 return -EIO;
248         priv = pp->private_data;
249         rq = submit_async_request(priv, 4, 0x40, (((unsigned int)reg) << 8) | val, 0, mem_flags);
250         if (!rq) {
251                 dev_err(&priv->usbdev->dev, "set_1284_register(%u,%u) failed",
252                         (unsigned int)reg, (unsigned int)val);
253                 return -EIO;
254         }
255         kref_put(&rq->ref_count, destroy_async);
256         return 0;
257 }
258
259 /* --------------------------------------------------------------------- */
260
261 /* ECR modes */
262 #define ECR_SPP 00
263 #define ECR_PS2 01
264 #define ECR_PPF 02
265 #define ECR_ECP 03
266 #define ECR_EPP 04
267
268 /* Safely change the mode bits in the ECR */
269 static int change_mode(struct parport *pp, int m)
270 {
271         struct parport_uss720_private *priv = pp->private_data;
272         int mode;
273         __u8 reg;
274
275         if (get_1284_register(pp, 6, &reg, GFP_KERNEL))
276                 return -EIO;
277         /* Bits <7:5> contain the mode. */
278         mode = (priv->reg[2] >> 5) & 0x7;
279         if (mode == m)
280                 return 0;
281         /* We have to go through mode 000 or 001 */
282         if (mode > ECR_PS2 && m > ECR_PS2)
283                 if (change_mode(pp, ECR_PS2))
284                         return -EIO;
285
286         if (m <= ECR_PS2 && !(priv->reg[1] & 0x20)) {
287                 /* This mode resets the FIFO, so we may
288                  * have to wait for it to drain first. */
289                 unsigned long expire = jiffies + pp->physport->cad->timeout;
290                 switch (mode) {
291                 case ECR_PPF: /* Parallel Port FIFO mode */
292                 case ECR_ECP: /* ECP Parallel Port mode */
293                         /* Poll slowly. */
294                         for (;;) {
295                                 if (get_1284_register(pp, 6, &reg, GFP_KERNEL))
296                                         return -EIO;
297                                 if (priv->reg[2] & 0x01)
298                                         break;
299                                 if (time_after_eq (jiffies, expire))
300                                         /* The FIFO is stuck. */
301                                         return -EBUSY;
302                                 msleep_interruptible(10);
303                                 if (signal_pending (current))
304                                         break;
305                         }
306                 }
307         }
308         /* Set the mode. */
309         if (set_1284_register(pp, 6, m << 5, GFP_KERNEL))
310                 return -EIO;
311         if (get_1284_register(pp, 6, &reg, GFP_KERNEL))
312                 return -EIO;
313         return 0;
314 }
315
316 /*
317  * Clear TIMEOUT BIT in EPP MODE
318  */
319 static int clear_epp_timeout(struct parport *pp)
320 {
321         unsigned char stat;
322
323         if (get_1284_register(pp, 1, &stat, GFP_KERNEL))
324                 return 1;
325         return stat & 1;
326 }
327
328 /*
329  * Access functions.
330  */
331 #if 0
332 static int uss720_irq(int usbstatus, void *buffer, int len, void *dev_id)
333 {
334         struct parport *pp = (struct parport *)dev_id;
335         struct parport_uss720_private *priv = pp->private_data; 
336
337         if (usbstatus != 0 || len < 4 || !buffer)
338                 return 1;
339         memcpy(priv->reg, buffer, 4);
340         /* if nAck interrupts are enabled and we have an interrupt, call the interrupt procedure */
341         if (priv->reg[2] & priv->reg[1] & 0x10)
342                 parport_generic_irq(pp);
343         return 1;
344 }
345 #endif
346
347 static void parport_uss720_write_data(struct parport *pp, unsigned char d)
348 {
349         set_1284_register(pp, 0, d, GFP_KERNEL);
350 }
351
352 static unsigned char parport_uss720_read_data(struct parport *pp)
353 {
354         unsigned char ret;
355
356         if (get_1284_register(pp, 0, &ret, GFP_KERNEL))
357                 return 0;
358         return ret;
359 }
360
361 static void parport_uss720_write_control(struct parport *pp, unsigned char d)
362 {
363         struct parport_uss720_private *priv = pp->private_data; 
364
365         d = (d & 0xf) | (priv->reg[1] & 0xf0);
366         if (set_1284_register(pp, 2, d, GFP_KERNEL))
367                 return;
368         priv->reg[1] = d;
369 }
370
371 static unsigned char parport_uss720_read_control(struct parport *pp)
372 {
373         struct parport_uss720_private *priv = pp->private_data; 
374         return priv->reg[1] & 0xf; /* Use soft copy */
375 }
376
377 static unsigned char parport_uss720_frob_control(struct parport *pp, unsigned char mask, unsigned char val)
378 {
379         struct parport_uss720_private *priv = pp->private_data; 
380         unsigned char d;
381
382         mask &= 0x0f;
383         val &= 0x0f;
384         d = (priv->reg[1] & (~mask)) ^ val;
385         if (set_1284_register(pp, 2, d, GFP_ATOMIC))
386                 return 0;
387         priv->reg[1] = d;
388         return d & 0xf;
389 }
390
391 static unsigned char parport_uss720_read_status(struct parport *pp)
392 {
393         unsigned char ret;
394
395         if (get_1284_register(pp, 1, &ret, GFP_ATOMIC))
396                 return 0;
397         return ret & 0xf8;
398 }
399
400 static void parport_uss720_disable_irq(struct parport *pp)
401 {
402         struct parport_uss720_private *priv = pp->private_data; 
403         unsigned char d;
404
405         d = priv->reg[1] & ~0x10;
406         if (set_1284_register(pp, 2, d, GFP_KERNEL))
407                 return;
408         priv->reg[1] = d;
409 }
410
411 static void parport_uss720_enable_irq(struct parport *pp)
412 {
413         struct parport_uss720_private *priv = pp->private_data; 
414         unsigned char d;
415
416         d = priv->reg[1] | 0x10;
417         if (set_1284_register(pp, 2, d, GFP_KERNEL))
418                 return;
419         priv->reg[1] = d;
420 }
421
422 static void parport_uss720_data_forward (struct parport *pp)
423 {
424         struct parport_uss720_private *priv = pp->private_data; 
425         unsigned char d;
426
427         d = priv->reg[1] & ~0x20;
428         if (set_1284_register(pp, 2, d, GFP_KERNEL))
429                 return;
430         priv->reg[1] = d;
431 }
432
433 static void parport_uss720_data_reverse (struct parport *pp)
434 {
435         struct parport_uss720_private *priv = pp->private_data; 
436         unsigned char d;
437
438         d = priv->reg[1] | 0x20;
439         if (set_1284_register(pp, 2, d, GFP_KERNEL))
440                 return;
441         priv->reg[1] = d;
442 }
443
444 static void parport_uss720_init_state(struct pardevice *dev, struct parport_state *s)
445 {
446         s->u.pc.ctr = 0xc | (dev->irq_func ? 0x10 : 0x0);
447         s->u.pc.ecr = 0x24;
448 }
449
450 static void parport_uss720_save_state(struct parport *pp, struct parport_state *s)
451 {
452         struct parport_uss720_private *priv = pp->private_data; 
453
454 #if 0
455         if (get_1284_register(pp, 2, NULL, GFP_ATOMIC))
456                 return;
457 #endif
458         s->u.pc.ctr = priv->reg[1];
459         s->u.pc.ecr = priv->reg[2];
460 }
461
462 static void parport_uss720_restore_state(struct parport *pp, struct parport_state *s)
463 {
464         struct parport_uss720_private *priv = pp->private_data;
465
466         set_1284_register(pp, 2, s->u.pc.ctr, GFP_ATOMIC);
467         set_1284_register(pp, 6, s->u.pc.ecr, GFP_ATOMIC);
468         get_1284_register(pp, 2, NULL, GFP_ATOMIC);
469         priv->reg[1] = s->u.pc.ctr;
470         priv->reg[2] = s->u.pc.ecr;
471 }
472
473 static size_t parport_uss720_epp_read_data(struct parport *pp, void *buf, size_t length, int flags)
474 {
475         struct parport_uss720_private *priv = pp->private_data; 
476         size_t got = 0;
477
478         if (change_mode(pp, ECR_EPP))
479                 return 0;
480         for (; got < length; got++) {
481                 if (get_1284_register(pp, 4, (char *)buf, GFP_KERNEL))
482                         break;
483                 buf++;
484                 if (priv->reg[0] & 0x01) {
485                         clear_epp_timeout(pp);
486                         break;
487                 }
488         }
489         change_mode(pp, ECR_PS2);
490         return got;
491 }
492
493 static size_t parport_uss720_epp_write_data(struct parport *pp, const void *buf, size_t length, int flags)
494 {
495 #if 0
496         struct parport_uss720_private *priv = pp->private_data; 
497         size_t written = 0;
498
499         if (change_mode(pp, ECR_EPP))
500                 return 0;
501         for (; written < length; written++) {
502                 if (set_1284_register(pp, 4, (char *)buf, GFP_KERNEL))
503                         break;
504                 ((char*)buf)++;
505                 if (get_1284_register(pp, 1, NULL, GFP_KERNEL))
506                         break;
507                 if (priv->reg[0] & 0x01) {
508                         clear_epp_timeout(pp);
509                         break;
510                 }
511         }
512         change_mode(pp, ECR_PS2);
513         return written;
514 #else
515         struct parport_uss720_private *priv = pp->private_data;
516         struct usb_device *usbdev = priv->usbdev;
517         int rlen;
518         int i;
519
520         if (!usbdev)
521                 return 0;
522         if (change_mode(pp, ECR_EPP))
523                 return 0;
524         i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buf, length, &rlen, 20000);
525         if (i)
526                 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %zu rlen %u\n", buf, length, rlen);
527         change_mode(pp, ECR_PS2);
528         return rlen;
529 #endif
530 }
531
532 static size_t parport_uss720_epp_read_addr(struct parport *pp, void *buf, size_t length, int flags)
533 {
534         struct parport_uss720_private *priv = pp->private_data; 
535         size_t got = 0;
536
537         if (change_mode(pp, ECR_EPP))
538                 return 0;
539         for (; got < length; got++) {
540                 if (get_1284_register(pp, 3, (char *)buf, GFP_KERNEL))
541                         break;
542                 buf++;
543                 if (priv->reg[0] & 0x01) {
544                         clear_epp_timeout(pp);
545                         break;
546                 }
547         }
548         change_mode(pp, ECR_PS2);
549         return got;
550 }
551
552 static size_t parport_uss720_epp_write_addr(struct parport *pp, const void *buf, size_t length, int flags)
553 {
554         struct parport_uss720_private *priv = pp->private_data; 
555         size_t written = 0;
556
557         if (change_mode(pp, ECR_EPP))
558                 return 0;
559         for (; written < length; written++) {
560                 if (set_1284_register(pp, 3, *(char *)buf, GFP_KERNEL))
561                         break;
562                 buf++;
563                 if (get_1284_register(pp, 1, NULL, GFP_KERNEL))
564                         break;
565                 if (priv->reg[0] & 0x01) {
566                         clear_epp_timeout(pp);
567                         break;
568                 }
569         }
570         change_mode(pp, ECR_PS2);
571         return written;
572 }
573
574 static size_t parport_uss720_ecp_write_data(struct parport *pp, const void *buffer, size_t len, int flags)
575 {
576         struct parport_uss720_private *priv = pp->private_data;
577         struct usb_device *usbdev = priv->usbdev;
578         int rlen;
579         int i;
580
581         if (!usbdev)
582                 return 0;
583         if (change_mode(pp, ECR_ECP))
584                 return 0;
585         i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buffer, len, &rlen, 20000);
586         if (i)
587                 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %zu rlen %u\n", buffer, len, rlen);
588         change_mode(pp, ECR_PS2);
589         return rlen;
590 }
591
592 static size_t parport_uss720_ecp_read_data(struct parport *pp, void *buffer, size_t len, int flags)
593 {
594         struct parport_uss720_private *priv = pp->private_data;
595         struct usb_device *usbdev = priv->usbdev;
596         int rlen;
597         int i;
598
599         if (!usbdev)
600                 return 0;
601         if (change_mode(pp, ECR_ECP))
602                 return 0;
603         i = usb_bulk_msg(usbdev, usb_rcvbulkpipe(usbdev, 2), buffer, len, &rlen, 20000);
604         if (i)
605                 printk(KERN_ERR "uss720: recvbulk ep 2 buf %p len %zu rlen %u\n", buffer, len, rlen);
606         change_mode(pp, ECR_PS2);
607         return rlen;
608 }
609
610 static size_t parport_uss720_ecp_write_addr(struct parport *pp, const void *buffer, size_t len, int flags)
611 {
612         size_t written = 0;
613
614         if (change_mode(pp, ECR_ECP))
615                 return 0;
616         for (; written < len; written++) {
617                 if (set_1284_register(pp, 5, *(char *)buffer, GFP_KERNEL))
618                         break;
619                 buffer++;
620         }
621         change_mode(pp, ECR_PS2);
622         return written;
623 }
624
625 static size_t parport_uss720_write_compat(struct parport *pp, const void *buffer, size_t len, int flags)
626 {
627         struct parport_uss720_private *priv = pp->private_data;
628         struct usb_device *usbdev = priv->usbdev;
629         int rlen;
630         int i;
631
632         if (!usbdev)
633                 return 0;
634         if (change_mode(pp, ECR_PPF))
635                 return 0;
636         i = usb_bulk_msg(usbdev, usb_sndbulkpipe(usbdev, 1), (void *)buffer, len, &rlen, 20000);
637         if (i)
638                 printk(KERN_ERR "uss720: sendbulk ep 1 buf %p len %zu rlen %u\n", buffer, len, rlen);
639         change_mode(pp, ECR_PS2);
640         return rlen;
641 }
642
643 /* --------------------------------------------------------------------- */
644
645 static struct parport_operations parport_uss720_ops = 
646 {
647         .owner =                THIS_MODULE,
648         .write_data =           parport_uss720_write_data,
649         .read_data =            parport_uss720_read_data,
650
651         .write_control =        parport_uss720_write_control,
652         .read_control =         parport_uss720_read_control,
653         .frob_control =         parport_uss720_frob_control,
654
655         .read_status =          parport_uss720_read_status,
656
657         .enable_irq =           parport_uss720_enable_irq,
658         .disable_irq =          parport_uss720_disable_irq,
659
660         .data_forward =         parport_uss720_data_forward,
661         .data_reverse =         parport_uss720_data_reverse,
662
663         .init_state =           parport_uss720_init_state,
664         .save_state =           parport_uss720_save_state,
665         .restore_state =        parport_uss720_restore_state,
666
667         .epp_write_data =       parport_uss720_epp_write_data,
668         .epp_read_data =        parport_uss720_epp_read_data,
669         .epp_write_addr =       parport_uss720_epp_write_addr,
670         .epp_read_addr =        parport_uss720_epp_read_addr,
671
672         .ecp_write_data =       parport_uss720_ecp_write_data,
673         .ecp_read_data =        parport_uss720_ecp_read_data,
674         .ecp_write_addr =       parport_uss720_ecp_write_addr,
675
676         .compat_write_data =    parport_uss720_write_compat,
677         .nibble_read_data =     parport_ieee1284_read_nibble,
678         .byte_read_data =       parport_ieee1284_read_byte,
679 };
680
681 /* --------------------------------------------------------------------- */
682
683 static int uss720_probe(struct usb_interface *intf,
684                         const struct usb_device_id *id)
685 {
686         struct usb_device *usbdev = usb_get_dev(interface_to_usbdev(intf));
687         struct usb_host_interface *interface;
688         struct usb_endpoint_descriptor *epd;
689         struct parport_uss720_private *priv;
690         struct parport *pp;
691         unsigned char reg;
692         int i;
693
694         dev_dbg(&intf->dev, "probe: vendor id 0x%x, device id 0x%x\n",
695                 le16_to_cpu(usbdev->descriptor.idVendor),
696                 le16_to_cpu(usbdev->descriptor.idProduct));
697
698         /* our known interfaces have 3 alternate settings */
699         if (intf->num_altsetting != 3) {
700                 usb_put_dev(usbdev);
701                 return -ENODEV;
702         }
703         i = usb_set_interface(usbdev, intf->altsetting->desc.bInterfaceNumber, 2);
704         dev_dbg(&intf->dev, "set interface result %d\n", i);
705
706         interface = intf->cur_altsetting;
707
708         if (interface->desc.bNumEndpoints < 3) {
709                 usb_put_dev(usbdev);
710                 return -ENODEV;
711         }
712
713         /*
714          * Allocate parport interface 
715          */
716         priv = kzalloc(sizeof(struct parport_uss720_private), GFP_KERNEL);
717         if (!priv) {
718                 usb_put_dev(usbdev);
719                 return -ENOMEM;
720         }
721         priv->pp = NULL;
722         priv->usbdev = usbdev;
723         kref_init(&priv->ref_count);
724         spin_lock_init(&priv->asynclock);
725         INIT_LIST_HEAD(&priv->asynclist);
726         pp = parport_register_port(0, PARPORT_IRQ_NONE, PARPORT_DMA_NONE, &parport_uss720_ops);
727         if (!pp) {
728                 printk(KERN_WARNING "uss720: could not register parport\n");
729                 goto probe_abort;
730         }
731
732         priv->pp = pp;
733         pp->private_data = priv;
734         pp->modes = PARPORT_MODE_PCSPP | PARPORT_MODE_TRISTATE | PARPORT_MODE_EPP | PARPORT_MODE_ECP | PARPORT_MODE_COMPAT;
735
736         /* set the USS720 control register to manual mode, no ECP compression, enable all ints */
737         set_1284_register(pp, 7, 0x00, GFP_KERNEL);
738         set_1284_register(pp, 6, 0x30, GFP_KERNEL);  /* PS/2 mode */
739         set_1284_register(pp, 2, 0x0c, GFP_KERNEL);
740         /* debugging */
741         get_1284_register(pp, 0, &reg, GFP_KERNEL);
742         dev_dbg(&intf->dev, "reg: %7ph\n", priv->reg);
743
744         i = usb_find_last_int_in_endpoint(interface, &epd);
745         if (!i) {
746                 dev_dbg(&intf->dev, "epaddr %d interval %d\n",
747                                 epd->bEndpointAddress, epd->bInterval);
748         }
749         parport_announce_port(pp);
750
751         usb_set_intfdata(intf, pp);
752         usb_put_dev(usbdev);
753         return 0;
754
755 probe_abort:
756         kill_all_async_requests_priv(priv);
757         kref_put(&priv->ref_count, destroy_priv);
758         return -ENODEV;
759 }
760
761 static void uss720_disconnect(struct usb_interface *intf)
762 {
763         struct parport *pp = usb_get_intfdata(intf);
764         struct parport_uss720_private *priv;
765         struct usb_device *usbdev;
766
767         dev_dbg(&intf->dev, "disconnect\n");
768         usb_set_intfdata(intf, NULL);
769         if (pp) {
770                 priv = pp->private_data;
771                 usbdev = priv->usbdev;
772                 priv->usbdev = NULL;
773                 priv->pp = NULL;
774                 dev_dbg(&intf->dev, "parport_remove_port\n");
775                 parport_remove_port(pp);
776                 parport_put_port(pp);
777                 kill_all_async_requests_priv(priv);
778                 kref_put(&priv->ref_count, destroy_priv);
779         }
780         dev_dbg(&intf->dev, "disconnect done\n");
781 }
782
783 /* table of cables that work through this driver */
784 static const struct usb_device_id uss720_table[] = {
785         { USB_DEVICE(0x047e, 0x1001) },
786         { USB_DEVICE(0x0557, 0x2001) },
787         { USB_DEVICE(0x0729, 0x1284) },
788         { USB_DEVICE(0x1293, 0x0002) },
789         { USB_DEVICE(0x050d, 0x0002) },
790         { }                                             /* Terminating entry */
791 };
792
793 MODULE_DEVICE_TABLE (usb, uss720_table);
794
795
796 static struct usb_driver uss720_driver = {
797         .name =         "uss720",
798         .probe =        uss720_probe,
799         .disconnect =   uss720_disconnect,
800         .id_table =     uss720_table,
801 };
802
803 /* --------------------------------------------------------------------- */
804
805 MODULE_AUTHOR(DRIVER_AUTHOR);
806 MODULE_DESCRIPTION(DRIVER_DESC);
807 MODULE_LICENSE("GPL");
808
809 static int __init uss720_init(void)
810 {
811         int retval;
812         retval = usb_register(&uss720_driver);
813         if (retval)
814                 goto out;
815
816         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
817         printk(KERN_INFO KBUILD_MODNAME ": NOTE: this is a special purpose "
818                "driver to allow nonstandard\n");
819         printk(KERN_INFO KBUILD_MODNAME ": protocols (eg. bitbang) over "
820                "USS720 usb to parallel cables\n");
821         printk(KERN_INFO KBUILD_MODNAME ": If you just want to connect to a "
822                "printer, use usblp instead\n");
823 out:
824         return retval;
825 }
826
827 static void __exit uss720_cleanup(void)
828 {
829         usb_deregister(&uss720_driver);
830 }
831
832 module_init(uss720_init);
833 module_exit(uss720_cleanup);
834
835 /* --------------------------------------------------------------------- */