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