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