USB: replace remaining __FUNCTION__ occurrences
[linux-2.6.git] / 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_ports =            1,
94         .attach =               cyberjack_startup,
95         .shutdown =             cyberjack_shutdown,
96         .open =                 cyberjack_open,
97         .close =                cyberjack_close,
98         .write =                cyberjack_write,
99         .write_room =           cyberjack_write_room,
100         .read_int_callback =    cyberjack_read_int_callback,
101         .read_bulk_callback =   cyberjack_read_bulk_callback,
102         .write_bulk_callback =  cyberjack_write_bulk_callback,
103 };
104
105 struct cyberjack_private {
106         spinlock_t      lock;           /* Lock for SMP */
107         short           rdtodo;         /* Bytes still to read */
108         unsigned char   wrbuf[5*64];    /* Buffer for collecting data to write */
109         short           wrfilled;       /* Overall data size we already got */
110         short           wrsent;         /* Data already sent */
111 };
112
113 /* do some startup allocations not currently performed by usb_serial_probe() */
114 static int cyberjack_startup (struct usb_serial *serial)
115 {
116         struct cyberjack_private *priv;
117         int i;
118
119         dbg("%s", __func__);
120
121         /* allocate the private data structure */
122         priv = kmalloc(sizeof(struct cyberjack_private), GFP_KERNEL);
123         if (!priv)
124                 return -ENOMEM;
125
126         /* set initial values */
127         spin_lock_init(&priv->lock);
128         priv->rdtodo = 0;
129         priv->wrfilled = 0;
130         priv->wrsent = 0;
131         usb_set_serial_port_data(serial->port[0], priv);
132
133         init_waitqueue_head(&serial->port[0]->write_wait);
134
135         for (i = 0; i < serial->num_ports; ++i) {
136                 int result;
137                 serial->port[i]->interrupt_in_urb->dev = serial->dev;
138                 result = usb_submit_urb(serial->port[i]->interrupt_in_urb, 
139                                         GFP_KERNEL);
140                 if (result)
141                         err(" usb_submit_urb(read int) failed");
142                 dbg("%s - usb_submit_urb(int urb)", __func__);
143         }
144
145         return( 0 );
146 }
147
148 static void cyberjack_shutdown (struct usb_serial *serial)
149 {
150         int i;
151         
152         dbg("%s", __func__);
153
154         for (i=0; i < serial->num_ports; ++i) {
155                 usb_kill_urb(serial->port[i]->interrupt_in_urb);
156                 /* My special items, the standard routines free my urbs */
157                 kfree(usb_get_serial_port_data(serial->port[i]));
158                 usb_set_serial_port_data(serial->port[i], NULL);
159         }
160 }
161         
162 static int  cyberjack_open (struct usb_serial_port *port, struct file *filp)
163 {
164         struct cyberjack_private *priv;
165         unsigned long flags;
166         int result = 0;
167
168         dbg("%s - port %d", __func__, port->number);
169
170         dbg("%s - usb_clear_halt", __func__ );
171         usb_clear_halt(port->serial->dev, port->write_urb->pipe);
172
173         /* force low_latency on so that our tty_push actually forces
174          * the data through, otherwise it is scheduled, and with high
175          * data rates (like with OHCI) data can get lost.
176          */
177         port->tty->low_latency = 1;
178
179         priv = usb_get_serial_port_data(port);
180         spin_lock_irqsave(&priv->lock, flags);
181         priv->rdtodo = 0;
182         priv->wrfilled = 0;
183         priv->wrsent = 0;
184         spin_unlock_irqrestore(&priv->lock, flags);
185
186         return result;
187 }
188
189 static void cyberjack_close (struct usb_serial_port *port, struct file *filp)
190 {
191         dbg("%s - port %d", __func__, port->number);
192
193         if (port->serial->dev) {
194                 /* shutdown any bulk reads that might be going on */
195                 usb_kill_urb(port->write_urb);
196                 usb_kill_urb(port->read_urb);
197         }
198 }
199
200 static int cyberjack_write (struct usb_serial_port *port, const unsigned char *buf, int count)
201 {
202         struct usb_serial *serial = port->serial;
203         struct cyberjack_private *priv = usb_get_serial_port_data(port);
204         unsigned long flags;
205         int result;
206         int wrexpected;
207
208         dbg("%s - port %d", __func__, port->number);
209
210         if (count == 0) {
211                 dbg("%s - write request of 0 bytes", __func__);
212                 return (0);
213         }
214
215         spin_lock_bh(&port->lock);
216         if (port->write_urb_busy) {
217                 spin_unlock_bh(&port->lock);
218                 dbg("%s - already writing", __func__);
219                 return 0;
220         }
221         port->write_urb_busy = 1;
222         spin_unlock_bh(&port->lock);
223
224         spin_lock_irqsave(&priv->lock, flags);
225
226         if( (count+priv->wrfilled)>sizeof(priv->wrbuf) ) {
227                 /* To much data for buffer. Reset buffer. */
228                 priv->wrfilled=0;
229                 spin_unlock_irqrestore(&priv->lock, flags);
230                 port->write_urb_busy = 0;
231                 return (0);
232         }
233
234         /* Copy data */
235         memcpy (priv->wrbuf+priv->wrfilled, buf, count);
236
237         usb_serial_debug_data(debug, &port->dev, __func__, count,
238                 priv->wrbuf+priv->wrfilled);
239         priv->wrfilled += count;
240
241         if( priv->wrfilled >= 3 ) {
242                 wrexpected = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3;
243                 dbg("%s - expected data: %d", __func__, wrexpected);
244         } else {
245                 wrexpected = sizeof(priv->wrbuf);
246         }
247
248         if( priv->wrfilled >= wrexpected ) {
249                 /* We have enough data to begin transmission */
250                 int length;
251
252                 dbg("%s - transmitting data (frame 1)", __func__);
253                 length = (wrexpected > port->bulk_out_size) ? port->bulk_out_size : wrexpected;
254
255                 memcpy (port->write_urb->transfer_buffer, priv->wrbuf, length );
256                 priv->wrsent=length;
257
258                 /* set up our urb */
259                 usb_fill_bulk_urb(port->write_urb, serial->dev, 
260                               usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress),
261                               port->write_urb->transfer_buffer, length,
262                               ((serial->type->write_bulk_callback) ? 
263                                serial->type->write_bulk_callback : 
264                                cyberjack_write_bulk_callback), 
265                               port);
266
267                 /* send the data out the bulk port */
268                 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
269                 if (result) {
270                         err("%s - failed submitting write urb, error %d", __func__, result);
271                         /* Throw away data. No better idea what to do with it. */
272                         priv->wrfilled=0;
273                         priv->wrsent=0;
274                         spin_unlock_irqrestore(&priv->lock, flags);
275                         port->write_urb_busy = 0;
276                         return 0;
277                 }
278
279                 dbg("%s - priv->wrsent=%d", __func__,priv->wrsent);
280                 dbg("%s - priv->wrfilled=%d", __func__,priv->wrfilled);
281
282                 if( priv->wrsent>=priv->wrfilled ) {
283                         dbg("%s - buffer cleaned", __func__);
284                         memset( priv->wrbuf, 0, sizeof(priv->wrbuf) );
285                         priv->wrfilled=0;
286                         priv->wrsent=0;
287                 }
288         }
289
290         spin_unlock_irqrestore(&priv->lock, flags);
291
292         return (count);
293
294
295 static int cyberjack_write_room( struct usb_serial_port *port )
296 {
297         return CYBERJACK_LOCAL_BUF_SIZE;
298 }
299
300 static void cyberjack_read_int_callback( struct urb *urb )
301 {
302         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
303         struct cyberjack_private *priv = usb_get_serial_port_data(port);
304         unsigned char *data = urb->transfer_buffer;
305         int status = urb->status;
306         int result;
307
308         dbg("%s - port %d", __func__, port->number);
309
310         /* the urb might have been killed. */
311         if (status)
312                 return;
313
314         usb_serial_debug_data(debug, &port->dev, __func__, urb->actual_length, data);
315
316         /* React only to interrupts signaling a bulk_in transfer */
317         if( (urb->actual_length==4) && (data[0]==0x01) ) {
318                 short old_rdtodo;
319
320                 /* This is a announcement of coming bulk_ins. */
321                 unsigned short size = ((unsigned short)data[3]<<8)+data[2]+3;
322
323                 spin_lock(&priv->lock);
324
325                 old_rdtodo = priv->rdtodo;
326
327                 if( (old_rdtodo+size)<(old_rdtodo) ) {
328                         dbg( "To many bulk_in urbs to do." );
329                         spin_unlock(&priv->lock);
330                         goto resubmit;
331                 }
332
333                 /* "+=" is probably more fault tollerant than "=" */
334                 priv->rdtodo += size;
335
336                 dbg("%s - rdtodo: %d", __func__, priv->rdtodo);
337
338                 spin_unlock(&priv->lock);
339
340                 if( !old_rdtodo ) {
341                         port->read_urb->dev = port->serial->dev;
342                         result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
343                         if( result )
344                                 err("%s - failed resubmitting read urb, error %d", __func__, result);
345                         dbg("%s - usb_submit_urb(read urb)", __func__);
346                 }
347         }
348
349 resubmit:
350         port->interrupt_in_urb->dev = port->serial->dev;
351         result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
352         if (result)
353                 err(" usb_submit_urb(read int) failed");
354         dbg("%s - usb_submit_urb(int urb)", __func__);
355 }
356
357 static void cyberjack_read_bulk_callback (struct urb *urb)
358 {
359         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
360         struct cyberjack_private *priv = usb_get_serial_port_data(port);
361         struct tty_struct *tty;
362         unsigned char *data = urb->transfer_buffer;
363         short todo;
364         int result;
365         int status = urb->status;
366
367         dbg("%s - port %d", __func__, port->number);
368
369         usb_serial_debug_data(debug, &port->dev, __func__, urb->actual_length, data);
370         if (status) {
371                 dbg("%s - nonzero read bulk status received: %d",
372                     __func__, status);
373                 return;
374         }
375
376         tty = port->tty;
377         if (!tty) {
378                 dbg("%s - ignoring since device not open\n", __func__);
379                 return;
380         }
381         if (urb->actual_length) {
382                 tty_buffer_request_room(tty, urb->actual_length);
383                 tty_insert_flip_string(tty, data, urb->actual_length);
384                 tty_flip_buffer_push(tty);
385         }
386
387         spin_lock(&priv->lock);
388
389         /* Reduce urbs to do by one. */
390         priv->rdtodo-=urb->actual_length;
391         /* Just to be sure */
392         if ( priv->rdtodo<0 ) priv->rdtodo = 0;
393         todo = priv->rdtodo;
394
395         spin_unlock(&priv->lock);
396
397         dbg("%s - rdtodo: %d", __func__, todo);
398
399         /* Continue to read if we have still urbs to do. */
400         if( todo /* || (urb->actual_length==port->bulk_in_endpointAddress)*/ ) {
401                 port->read_urb->dev = port->serial->dev;
402                 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
403                 if (result)
404                         err("%s - failed resubmitting read urb, error %d", __func__, result);
405                 dbg("%s - usb_submit_urb(read urb)", __func__);
406         }
407 }
408
409 static void cyberjack_write_bulk_callback (struct urb *urb)
410 {
411         struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
412         struct cyberjack_private *priv = usb_get_serial_port_data(port);
413         int status = urb->status;
414
415         dbg("%s - port %d", __func__, port->number);
416
417         port->write_urb_busy = 0;
418         if (status) {
419                 dbg("%s - nonzero write bulk status received: %d",
420                     __func__, status);
421                 return;
422         }
423
424         spin_lock(&priv->lock);
425
426         /* only do something if we have more data to send */
427         if( priv->wrfilled ) {
428                 int length, blksize, result;
429
430                 dbg("%s - transmitting data (frame n)", __func__);
431
432                 length = ((priv->wrfilled - priv->wrsent) > port->bulk_out_size) ?
433                         port->bulk_out_size : (priv->wrfilled - priv->wrsent);
434
435                 memcpy (port->write_urb->transfer_buffer, priv->wrbuf + priv->wrsent,
436                         length );
437                 priv->wrsent+=length;
438
439                 /* set up our urb */
440                 usb_fill_bulk_urb(port->write_urb, port->serial->dev, 
441                               usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
442                               port->write_urb->transfer_buffer, length,
443                               ((port->serial->type->write_bulk_callback) ? 
444                                port->serial->type->write_bulk_callback : 
445                                cyberjack_write_bulk_callback), 
446                               port);
447
448                 /* send the data out the bulk port */
449                 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
450                 if (result) {
451                         err("%s - failed submitting write urb, error %d", __func__, result);
452                         /* Throw away data. No better idea what to do with it. */
453                         priv->wrfilled=0;
454                         priv->wrsent=0;
455                         goto exit;
456                 }
457
458                 dbg("%s - priv->wrsent=%d", __func__,priv->wrsent);
459                 dbg("%s - priv->wrfilled=%d", __func__,priv->wrfilled);
460
461                 blksize = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3;
462
463                 if( (priv->wrsent>=priv->wrfilled) || (priv->wrsent>=blksize) ) {
464                         dbg("%s - buffer cleaned", __func__);
465                         memset( priv->wrbuf, 0, sizeof(priv->wrbuf) );
466                         priv->wrfilled=0;
467                         priv->wrsent=0;
468                 }
469         }
470
471 exit:
472         spin_unlock(&priv->lock);
473         usb_serial_port_softint(port);
474 }
475
476 static int __init cyberjack_init (void)
477 {
478         int retval;
479         retval  = usb_serial_register(&cyberjack_device);
480         if (retval)
481                 goto failed_usb_serial_register;
482         retval = usb_register(&cyberjack_driver);
483         if (retval) 
484                 goto failed_usb_register;
485
486         info(DRIVER_VERSION " " DRIVER_AUTHOR);
487         info(DRIVER_DESC);
488
489         return 0;
490 failed_usb_register:
491         usb_serial_deregister(&cyberjack_device);
492 failed_usb_serial_register:
493         return retval;
494 }
495
496 static void __exit cyberjack_exit (void)
497 {
498         usb_deregister (&cyberjack_driver);
499         usb_serial_deregister (&cyberjack_device);
500 }
501
502 module_init(cyberjack_init);
503 module_exit(cyberjack_exit);
504
505 MODULE_AUTHOR( DRIVER_AUTHOR );
506 MODULE_DESCRIPTION( DRIVER_DESC );
507 MODULE_VERSION( DRIVER_VERSION );
508 MODULE_LICENSE("GPL");
509
510 module_param(debug, bool, S_IRUGO | S_IWUSR);
511 MODULE_PARM_DESC(debug, "Debug enabled or not");