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