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