USB: sierra: remove incorrect usage of the urb status field
[linux-2.6] / drivers / usb / serial / cyberjack.c
1 /*
2  *  REINER SCT cyberJack pinpad/e-com USB Chipcard Reader Driver
3  *
4  *  Copyright (C) 2001  REINER SCT
5  *  Author: Matthias Bruestle
6  *
7  *  Contact: support@reiner-sct.com (see MAINTAINERS)
8  *
9  *  This program is largely derived from work by the linux-usb group
10  *  and associated source files.  Please see the usb/serial files for
11  *  individual credits and copyrights.
12  *
13  *  This program is free software; you can redistribute it and/or modify
14  *  it under the terms of the GNU General Public License as published by
15  *  the Free Software Foundation; either version 2 of the License, or
16  *  (at your option) any later version.
17  *
18  *  Thanks to Greg Kroah-Hartman (greg@kroah.com) for his help and
19  *  patience.
20  *
21  *  In case of problems, please write to the contact e-mail address
22  *  mentioned above.
23  *
24  *  Please note that later models of the cyberjack reader family are
25  *  supported by a libusb-based userspace device driver.
26  *
27  *  Homepage: http://www.reiner-sct.de/support/treiber_cyberjack.php#linux
28  */
29
30
31 #include <linux/kernel.h>
32 #include <linux/errno.h>
33 #include <linux/init.h>
34 #include <linux/slab.h>
35 #include <linux/tty.h>
36 #include <linux/tty_driver.h>
37 #include <linux/tty_flip.h>
38 #include <linux/module.h>
39 #include <linux/spinlock.h>
40 #include <asm/uaccess.h>
41 #include <linux/usb.h>
42 #include <linux/usb/serial.h>
43
44 #define CYBERJACK_LOCAL_BUF_SIZE 32
45
46 static int debug;
47
48 /*
49  * Version Information
50  */
51 #define DRIVER_VERSION "v1.01"
52 #define DRIVER_AUTHOR "Matthias Bruestle"
53 #define DRIVER_DESC "REINER SCT cyberJack pinpad/e-com USB Chipcard Reader Driver"
54
55
56 #define CYBERJACK_VENDOR_ID     0x0C4B
57 #define CYBERJACK_PRODUCT_ID    0x0100
58
59 /* Function prototypes */
60 static int cyberjack_startup (struct usb_serial *serial);
61 static void cyberjack_shutdown (struct usb_serial *serial);
62 static int  cyberjack_open (struct usb_serial_port *port, struct file *filp);
63 static void cyberjack_close (struct usb_serial_port *port, struct file *filp);
64 static int cyberjack_write (struct usb_serial_port *port, const unsigned char *buf, int count);
65 static int cyberjack_write_room( struct usb_serial_port *port );
66 static void cyberjack_read_int_callback (struct urb *urb);
67 static void cyberjack_read_bulk_callback (struct urb *urb);
68 static void cyberjack_write_bulk_callback (struct urb *urb);
69
70 static struct usb_device_id id_table [] = {
71         { USB_DEVICE(CYBERJACK_VENDOR_ID, CYBERJACK_PRODUCT_ID) },
72         { }                     /* Terminating entry */
73 };
74
75 MODULE_DEVICE_TABLE (usb, id_table);
76
77 static struct usb_driver cyberjack_driver = {
78         .name =         "cyberjack",
79         .probe =        usb_serial_probe,
80         .disconnect =   usb_serial_disconnect,
81         .id_table =     id_table,
82         .no_dynamic_id =        1,
83 };
84
85 static struct usb_serial_driver cyberjack_device = {
86         .driver = {
87                 .owner =        THIS_MODULE,
88                 .name =         "cyberjack",
89         },
90         .description =          "Reiner SCT Cyberjack USB card reader",
91         .usb_driver =           &cyberjack_driver,
92         .id_table =             id_table,
93         .num_interrupt_in =     1,
94         .num_bulk_in =          1,
95         .num_bulk_out =         1,
96         .num_ports =            1,
97         .attach =               cyberjack_startup,
98         .shutdown =             cyberjack_shutdown,
99         .open =                 cyberjack_open,
100         .close =                cyberjack_close,
101         .write =                cyberjack_write,
102         .write_room =           cyberjack_write_room,
103         .read_int_callback =    cyberjack_read_int_callback,
104         .read_bulk_callback =   cyberjack_read_bulk_callback,
105         .write_bulk_callback =  cyberjack_write_bulk_callback,
106 };
107
108 struct cyberjack_private {
109         spinlock_t      lock;           /* Lock for SMP */
110         short           rdtodo;         /* Bytes still to read */
111         unsigned char   wrbuf[5*64];    /* Buffer for collecting data to write */
112         short           wrfilled;       /* Overall data size we already got */
113         short           wrsent;         /* Data already sent */
114 };
115
116 /* do some startup allocations not currently performed by usb_serial_probe() */
117 static int cyberjack_startup (struct usb_serial *serial)
118 {
119         struct cyberjack_private *priv;
120         int i;
121
122         dbg("%s", __FUNCTION__);
123
124         /* allocate the private data structure */
125         priv = kmalloc(sizeof(struct cyberjack_private), GFP_KERNEL);
126         if (!priv)
127                 return -ENOMEM;
128
129         /* set initial values */
130         spin_lock_init(&priv->lock);
131         priv->rdtodo = 0;
132         priv->wrfilled = 0;
133         priv->wrsent = 0;
134         usb_set_serial_port_data(serial->port[0], priv);
135
136         init_waitqueue_head(&serial->port[0]->write_wait);
137
138         for (i = 0; i < serial->num_ports; ++i) {
139                 int result;
140                 serial->port[i]->interrupt_in_urb->dev = serial->dev;
141                 result = usb_submit_urb(serial->port[i]->interrupt_in_urb, 
142                                         GFP_KERNEL);
143                 if (result)
144                         err(" usb_submit_urb(read int) failed");
145                 dbg("%s - usb_submit_urb(int urb)", __FUNCTION__);
146         }
147
148         return( 0 );
149 }
150
151 static void cyberjack_shutdown (struct usb_serial *serial)
152 {
153         int i;
154         
155         dbg("%s", __FUNCTION__);
156
157         for (i=0; i < serial->num_ports; ++i) {
158                 usb_kill_urb(serial->port[i]->interrupt_in_urb);
159                 /* My special items, the standard routines free my urbs */
160                 kfree(usb_get_serial_port_data(serial->port[i]));
161                 usb_set_serial_port_data(serial->port[i], NULL);
162         }
163 }
164         
165 static int  cyberjack_open (struct usb_serial_port *port, struct file *filp)
166 {
167         struct cyberjack_private *priv;
168         unsigned long flags;
169         int result = 0;
170
171         dbg("%s - port %d", __FUNCTION__, port->number);
172
173         dbg("%s - usb_clear_halt", __FUNCTION__ );
174         usb_clear_halt(port->serial->dev, port->write_urb->pipe);
175
176         /* force low_latency on so that our tty_push actually forces
177          * the data through, otherwise it is scheduled, and with high
178          * data rates (like with OHCI) data can get lost.
179          */
180         port->tty->low_latency = 1;
181
182         priv = usb_get_serial_port_data(port);
183         spin_lock_irqsave(&priv->lock, flags);
184         priv->rdtodo = 0;
185         priv->wrfilled = 0;
186         priv->wrsent = 0;
187         spin_unlock_irqrestore(&priv->lock, flags);
188
189         return result;
190 }
191
192 static void cyberjack_close (struct usb_serial_port *port, struct file *filp)
193 {
194         dbg("%s - port %d", __FUNCTION__, port->number);
195
196         if (port->serial->dev) {
197                 /* shutdown any bulk reads that might be going on */
198                 usb_kill_urb(port->write_urb);
199                 usb_kill_urb(port->read_urb);
200         }
201 }
202
203 static int cyberjack_write (struct usb_serial_port *port, const unsigned char *buf, int count)
204 {
205         struct usb_serial *serial = port->serial;
206         struct cyberjack_private *priv = usb_get_serial_port_data(port);
207         unsigned long flags;
208         int result;
209         int wrexpected;
210
211         dbg("%s - port %d", __FUNCTION__, port->number);
212
213         if (count == 0) {
214                 dbg("%s - write request of 0 bytes", __FUNCTION__);
215                 return (0);
216         }
217
218         spin_lock_bh(&port->lock);
219         if (port->write_urb_busy) {
220                 spin_unlock_bh(&port->lock);
221                 dbg("%s - already writing", __FUNCTION__);
222                 return 0;
223         }
224         port->write_urb_busy = 1;
225         spin_unlock_bh(&port->lock);
226
227         spin_lock_irqsave(&priv->lock, flags);
228
229         if( (count+priv->wrfilled)>sizeof(priv->wrbuf) ) {
230                 /* To much data for buffer. Reset buffer. */
231                 priv->wrfilled=0;
232                 spin_unlock_irqrestore(&priv->lock, flags);
233                 port->write_urb_busy = 0;
234                 return (0);
235         }
236
237         /* Copy data */
238         memcpy (priv->wrbuf+priv->wrfilled, buf, count);
239
240         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count,
241                 priv->wrbuf+priv->wrfilled);
242         priv->wrfilled += count;
243
244         if( priv->wrfilled >= 3 ) {
245                 wrexpected = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3;
246                 dbg("%s - expected data: %d", __FUNCTION__, wrexpected);
247         } else {
248                 wrexpected = sizeof(priv->wrbuf);
249         }
250
251         if( priv->wrfilled >= wrexpected ) {
252                 /* We have enough data to begin transmission */
253                 int length;
254
255                 dbg("%s - transmitting data (frame 1)", __FUNCTION__);
256                 length = (wrexpected > port->bulk_out_size) ? port->bulk_out_size : wrexpected;
257
258                 memcpy (port->write_urb->transfer_buffer, priv->wrbuf, length );
259                 priv->wrsent=length;
260
261                 /* set up our urb */
262                 usb_fill_bulk_urb(port->write_urb, serial->dev, 
263                               usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress),
264                               port->write_urb->transfer_buffer, length,
265                               ((serial->type->write_bulk_callback) ? 
266                                serial->type->write_bulk_callback : 
267                                cyberjack_write_bulk_callback), 
268                               port);
269
270                 /* send the data out the bulk port */
271                 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
272                 if (result) {
273                         err("%s - failed submitting write urb, error %d", __FUNCTION__, result);
274                         /* Throw away data. No better idea what to do with it. */
275                         priv->wrfilled=0;
276                         priv->wrsent=0;
277                         spin_unlock_irqrestore(&priv->lock, flags);
278                         port->write_urb_busy = 0;
279                         return 0;
280                 }
281
282                 dbg("%s - priv->wrsent=%d", __FUNCTION__,priv->wrsent);
283                 dbg("%s - priv->wrfilled=%d", __FUNCTION__,priv->wrfilled);
284
285                 if( priv->wrsent>=priv->wrfilled ) {
286                         dbg("%s - buffer cleaned", __FUNCTION__);
287                         memset( priv->wrbuf, 0, sizeof(priv->wrbuf) );
288                         priv->wrfilled=0;
289                         priv->wrsent=0;
290                 }
291         }
292
293         spin_unlock_irqrestore(&priv->lock, flags);
294
295         return (count);
296
297
298 static int cyberjack_write_room( struct usb_serial_port *port )
299 {
300         return CYBERJACK_LOCAL_BUF_SIZE;
301 }
302
303 static void cyberjack_read_int_callback( struct urb *urb )
304 {
305         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
306         struct cyberjack_private *priv = usb_get_serial_port_data(port);
307         unsigned char *data = urb->transfer_buffer;
308         int status = urb->status;
309         int result;
310
311         dbg("%s - port %d", __FUNCTION__, port->number);
312
313         /* the urb might have been killed. */
314         if (status)
315                 return;
316
317         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
318
319         /* React only to interrupts signaling a bulk_in transfer */
320         if( (urb->actual_length==4) && (data[0]==0x01) ) {
321                 short old_rdtodo;
322                 int result;
323
324                 /* This is a announcement of coming bulk_ins. */
325                 unsigned short size = ((unsigned short)data[3]<<8)+data[2]+3;
326
327                 spin_lock(&priv->lock);
328
329                 old_rdtodo = priv->rdtodo;
330
331                 if( (old_rdtodo+size)<(old_rdtodo) ) {
332                         dbg( "To many bulk_in urbs to do." );
333                         spin_unlock(&priv->lock);
334                         goto resubmit;
335                 }
336
337                 /* "+=" is probably more fault tollerant than "=" */
338                 priv->rdtodo += size;
339
340                 dbg("%s - rdtodo: %d", __FUNCTION__, priv->rdtodo);
341
342                 spin_unlock(&priv->lock);
343
344                 if( !old_rdtodo ) {
345                         port->read_urb->dev = port->serial->dev;
346                         result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
347                         if( result )
348                                 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
349                         dbg("%s - usb_submit_urb(read urb)", __FUNCTION__);
350                 }
351         }
352
353 resubmit:
354         port->interrupt_in_urb->dev = port->serial->dev;
355         result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
356         if (result)
357                 err(" usb_submit_urb(read int) failed");
358         dbg("%s - usb_submit_urb(int urb)", __FUNCTION__);
359 }
360
361 static void cyberjack_read_bulk_callback (struct urb *urb)
362 {
363         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
364         struct cyberjack_private *priv = usb_get_serial_port_data(port);
365         struct tty_struct *tty;
366         unsigned char *data = urb->transfer_buffer;
367         short todo;
368         int result;
369         int status = urb->status;
370
371         dbg("%s - port %d", __FUNCTION__, port->number);
372
373         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
374         if (status) {
375                 dbg("%s - nonzero read bulk status received: %d",
376                     __FUNCTION__, status);
377                 return;
378         }
379
380         tty = port->tty;
381         if (!tty) {
382                 dbg("%s - ignoring since device not open\n", __FUNCTION__);
383                 return;
384         }
385         if (urb->actual_length) {
386                 tty_buffer_request_room(tty, urb->actual_length);
387                 tty_insert_flip_string(tty, data, urb->actual_length);
388                 tty_flip_buffer_push(tty);
389         }
390
391         spin_lock(&priv->lock);
392
393         /* Reduce urbs to do by one. */
394         priv->rdtodo-=urb->actual_length;
395         /* Just to be sure */
396         if ( priv->rdtodo<0 ) priv->rdtodo = 0;
397         todo = priv->rdtodo;
398
399         spin_unlock(&priv->lock);
400
401         dbg("%s - rdtodo: %d", __FUNCTION__, todo);
402
403         /* Continue to read if we have still urbs to do. */
404         if( todo /* || (urb->actual_length==port->bulk_in_endpointAddress)*/ ) {
405                 port->read_urb->dev = port->serial->dev;
406                 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
407                 if (result)
408                         err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
409                 dbg("%s - usb_submit_urb(read urb)", __FUNCTION__);
410         }
411 }
412
413 static void cyberjack_write_bulk_callback (struct urb *urb)
414 {
415         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
416         struct cyberjack_private *priv = usb_get_serial_port_data(port);
417         int status = urb->status;
418
419         dbg("%s - port %d", __FUNCTION__, port->number);
420
421         port->write_urb_busy = 0;
422         if (status) {
423                 dbg("%s - nonzero write bulk status received: %d",
424                     __FUNCTION__, status);
425                 return;
426         }
427
428         spin_lock(&priv->lock);
429
430         /* only do something if we have more data to send */
431         if( priv->wrfilled ) {
432                 int length, blksize, result;
433
434                 dbg("%s - transmitting data (frame n)", __FUNCTION__);
435
436                 length = ((priv->wrfilled - priv->wrsent) > port->bulk_out_size) ?
437                         port->bulk_out_size : (priv->wrfilled - priv->wrsent);
438
439                 memcpy (port->write_urb->transfer_buffer, priv->wrbuf + priv->wrsent,
440                         length );
441                 priv->wrsent+=length;
442
443                 /* set up our urb */
444                 usb_fill_bulk_urb(port->write_urb, port->serial->dev, 
445                               usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
446                               port->write_urb->transfer_buffer, length,
447                               ((port->serial->type->write_bulk_callback) ? 
448                                port->serial->type->write_bulk_callback : 
449                                cyberjack_write_bulk_callback), 
450                               port);
451
452                 /* send the data out the bulk port */
453                 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
454                 if (result) {
455                         err("%s - failed submitting write urb, error %d", __FUNCTION__, result);
456                         /* Throw away data. No better idea what to do with it. */
457                         priv->wrfilled=0;
458                         priv->wrsent=0;
459                         goto exit;
460                 }
461
462                 dbg("%s - priv->wrsent=%d", __FUNCTION__,priv->wrsent);
463                 dbg("%s - priv->wrfilled=%d", __FUNCTION__,priv->wrfilled);
464
465                 blksize = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3;
466
467                 if( (priv->wrsent>=priv->wrfilled) || (priv->wrsent>=blksize) ) {
468                         dbg("%s - buffer cleaned", __FUNCTION__);
469                         memset( priv->wrbuf, 0, sizeof(priv->wrbuf) );
470                         priv->wrfilled=0;
471                         priv->wrsent=0;
472                 }
473         }
474
475 exit:
476         spin_unlock(&priv->lock);
477         usb_serial_port_softint(port);
478 }
479
480 static int __init cyberjack_init (void)
481 {
482         int retval;
483         retval  = usb_serial_register(&cyberjack_device);
484         if (retval)
485                 goto failed_usb_serial_register;
486         retval = usb_register(&cyberjack_driver);
487         if (retval) 
488                 goto failed_usb_register;
489
490         info(DRIVER_VERSION " " DRIVER_AUTHOR);
491         info(DRIVER_DESC);
492
493         return 0;
494 failed_usb_register:
495         usb_serial_deregister(&cyberjack_device);
496 failed_usb_serial_register:
497         return retval;
498 }
499
500 static void __exit cyberjack_exit (void)
501 {
502         usb_deregister (&cyberjack_driver);
503         usb_serial_deregister (&cyberjack_device);
504 }
505
506 module_init(cyberjack_init);
507 module_exit(cyberjack_exit);
508
509 MODULE_AUTHOR( DRIVER_AUTHOR );
510 MODULE_DESCRIPTION( DRIVER_DESC );
511 MODULE_VERSION( DRIVER_VERSION );
512 MODULE_LICENSE("GPL");
513
514 module_param(debug, bool, S_IRUGO | S_IWUSR);
515 MODULE_PARM_DESC(debug, "Debug enabled or not");