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 bool 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         .disconnect =   usb_serial_disconnect,
  83         .id_table =     id_table,
  84 };
  85
  86 static struct usb_serial_driver cyberjack_device = {
  87         .driver = {
  88                 .owner =        THIS_MODULE,
  89                 .name =         "cyberjack",
  90         },
  91         .description =          "Reiner SCT Cyberjack USB card reader",
  92         .id_table =             id_table,
  93         .num_ports =            1,
  94         .attach =               cyberjack_startup,
  95         .disconnect =           cyberjack_disconnect,
  96         .release =              cyberjack_release,
  97         .open =                 cyberjack_open,
  98         .close =                cyberjack_close,
  99         .write =                cyberjack_write,
 100         .write_room =           cyberjack_write_room,
 101         .read_int_callback =    cyberjack_read_int_callback,
 102         .read_bulk_callback =   cyberjack_read_bulk_callback,
 103         .write_bulk_callback =  cyberjack_write_bulk_callback,
 104 };
 105
 106 static struct usb_serial_driver * const serial_drivers[] = {
 107         &cyberjack_device, NULL
 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         /* 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                 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_disconnect(struct usb_serial *serial)
 152 {
 153         int i;
 154
 155         for (i = 0; i < serial->num_ports; ++i)
 156                 usb_kill_urb(serial->port[i]->interrupt_in_urb);
 157 }
 158
 159 static void cyberjack_release(struct usb_serial *serial)
 160 {
 161         int i;
 162
 163         for (i = 0; i < serial->num_ports; ++i) {
 164                 /* My special items, the standard routines free my urbs */
 165                 kfree(usb_get_serial_port_data(serial->port[i]));
 166         }
 167 }
 168
 169 static int  cyberjack_open(struct tty_struct *tty,
 170                                         struct usb_serial_port *port)
 171 {
 172         struct cyberjack_private *priv;
 173         unsigned long flags;
 174         int result = 0;
 175
 176         dbg("%s - usb_clear_halt", __func__);
 177         usb_clear_halt(port->serial->dev, port->write_urb->pipe);
 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)
 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 cyberjack_private *priv = usb_get_serial_port_data(port);
 202         unsigned long flags;
 203         int result;
 204         int wrexpected;
 205
 206         if (count == 0) {
 207                 dbg("%s - write request of 0 bytes", __func__);
 208                 return 0;
 209         }
 210
 211         if (!test_and_clear_bit(0, &port->write_urbs_free)) {
 212                 dbg("%s - already writing", __func__);
 213                 return 0;
 214         }
 215
 216         spin_lock_irqsave(&priv->lock, flags);
 217
 218         if (count+priv->wrfilled > sizeof(priv->wrbuf)) {
 219                 /* To much data for buffer. Reset buffer. */
 220                 priv->wrfilled = 0;
 221                 spin_unlock_irqrestore(&priv->lock, flags);
 222                 set_bit(0, &port->write_urbs_free);
 223                 return 0;
 224         }
 225
 226         /* Copy data */
 227         memcpy(priv->wrbuf + priv->wrfilled, buf, count);
 228
 229         usb_serial_debug_data(debug, &port->dev, __func__, count,
 230                 priv->wrbuf + priv->wrfilled);
 231         priv->wrfilled += count;
 232
 233         if (priv->wrfilled >= 3) {
 234                 wrexpected = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3;
 235                 dbg("%s - expected data: %d", __func__, wrexpected);
 236         } else
 237                 wrexpected = sizeof(priv->wrbuf);
 238
 239         if (priv->wrfilled >= wrexpected) {
 240                 /* We have enough data to begin transmission */
 241                 int length;
 242
 243                 dbg("%s - transmitting data (frame 1)", __func__);
 244                 length = (wrexpected > port->bulk_out_size) ?
 245                                         port->bulk_out_size : wrexpected;
 246
 247                 memcpy(port->write_urb->transfer_buffer, priv->wrbuf, length);
 248                 priv->wrsent = length;
 249
 250                 /* set up our urb */
 251                 port->write_urb->transfer_buffer_length = length;
 252
 253                 /* send the data out the bulk port */
 254                 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
 255                 if (result) {
 256                         dev_err(&port->dev,
 257                                 "%s - failed submitting write urb, error %d",
 258                                 __func__, result);
 259                         /* Throw away data. No better idea what to do with it. */
 260                         priv->wrfilled = 0;
 261                         priv->wrsent = 0;
 262                         spin_unlock_irqrestore(&priv->lock, flags);
 263                         set_bit(0, &port->write_urbs_free);
 264                         return 0;
 265                 }
 266
 267                 dbg("%s - priv->wrsent=%d", __func__, priv->wrsent);
 268                 dbg("%s - priv->wrfilled=%d", __func__, priv->wrfilled);
 269
 270                 if (priv->wrsent >= priv->wrfilled) {
 271                         dbg("%s - buffer cleaned", __func__);
 272                         memset(priv->wrbuf, 0, sizeof(priv->wrbuf));
 273                         priv->wrfilled = 0;
 274                         priv->wrsent = 0;
 275                 }
 276         }
 277
 278         spin_unlock_irqrestore(&priv->lock, flags);
 279
 280         return count;
 281 }
 282
 283 static int cyberjack_write_room(struct tty_struct *tty)
 284 {
 285         /* FIXME: .... */
 286         return CYBERJACK_LOCAL_BUF_SIZE;
 287 }
 288
 289 static void cyberjack_read_int_callback(struct urb *urb)
 290 {
 291         struct usb_serial_port *port = urb->context;
 292         struct cyberjack_private *priv = usb_get_serial_port_data(port);
 293         unsigned char *data = urb->transfer_buffer;
 294         int status = urb->status;
 295         int result;
 296
 297         /* the urb might have been killed. */
 298         if (status)
 299                 return;
 300
 301         usb_serial_debug_data(debug, &port->dev, __func__,
 302                                                 urb->actual_length, data);
 303
 304         /* React only to interrupts signaling a bulk_in transfer */
 305         if (urb->actual_length == 4 && data[0] == 0x01) {
 306                 short old_rdtodo;
 307
 308                 /* This is a announcement of coming bulk_ins. */
 309                 unsigned short size = ((unsigned short)data[3]<<8)+data[2]+3;
 310
 311                 spin_lock(&priv->lock);
 312
 313                 old_rdtodo = priv->rdtodo;
 314
 315                 if (old_rdtodo + size < old_rdtodo) {
 316                         dbg("To many bulk_in urbs to do.");
 317                         spin_unlock(&priv->lock);
 318                         goto resubmit;
 319                 }
 320
 321                 /* "+=" is probably more fault tollerant than "=" */
 322                 priv->rdtodo += size;
 323
 324                 dbg("%s - rdtodo: %d", __func__, priv->rdtodo);
 325
 326                 spin_unlock(&priv->lock);
 327
 328                 if (!old_rdtodo) {
 329                         result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
 330                         if (result)
 331                                 dev_err(&port->dev, "%s - failed resubmitting "
 332                                         "read urb, error %d\n",
 333                                         __func__, result);
 334                         dbg("%s - usb_submit_urb(read urb)", __func__);
 335                 }
 336         }
 337
 338 resubmit:
 339         result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
 340         if (result)
 341                 dev_err(&port->dev, "usb_submit_urb(read int) failed\n");
 342         dbg("%s - usb_submit_urb(int urb)", __func__);
 343 }
 344
 345 static void cyberjack_read_bulk_callback(struct urb *urb)
 346 {
 347         struct usb_serial_port *port = urb->context;
 348         struct cyberjack_private *priv = usb_get_serial_port_data(port);
 349         struct tty_struct *tty;
 350         unsigned char *data = urb->transfer_buffer;
 351         short todo;
 352         int result;
 353         int status = urb->status;
 354
 355         usb_serial_debug_data(debug, &port->dev, __func__,
 356                                                 urb->actual_length, data);
 357         if (status) {
 358                 dbg("%s - nonzero read bulk status received: %d",
 359                     __func__, status);
 360                 return;
 361         }
 362
 363         tty = tty_port_tty_get(&port->port);
 364         if (!tty) {
 365                 dbg("%s - ignoring since device not open", __func__);
 366                 return;
 367         }
 368         if (urb->actual_length) {
 369                 tty_insert_flip_string(tty, data, urb->actual_length);
 370                 tty_flip_buffer_push(tty);
 371         }
 372         tty_kref_put(tty);
 373
 374         spin_lock(&priv->lock);
 375
 376         /* Reduce urbs to do by one. */
 377         priv->rdtodo -= urb->actual_length;
 378         /* Just to be sure */
 379         if (priv->rdtodo < 0)
 380                 priv->rdtodo = 0;
 381         todo = priv->rdtodo;
 382
 383         spin_unlock(&priv->lock);
 384
 385         dbg("%s - rdtodo: %d", __func__, todo);
 386
 387         /* Continue to read if we have still urbs to do. */
 388         if (todo /* || (urb->actual_length==port->bulk_in_endpointAddress)*/) {
 389                 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
 390                 if (result)
 391                         dev_err(&port->dev, "%s - failed resubmitting read "
 392                                 "urb, error %d\n", __func__, result);
 393                 dbg("%s - usb_submit_urb(read urb)", __func__);
 394         }
 395 }
 396
 397 static void cyberjack_write_bulk_callback(struct urb *urb)
 398 {
 399         struct usb_serial_port *port = urb->context;
 400         struct cyberjack_private *priv = usb_get_serial_port_data(port);
 401         int status = urb->status;
 402
 403         set_bit(0, &port->write_urbs_free);
 404         if (status) {
 405                 dbg("%s - nonzero write bulk status received: %d",
 406                     __func__, status);
 407                 return;
 408         }
 409
 410         spin_lock(&priv->lock);
 411
 412         /* only do something if we have more data to send */
 413         if (priv->wrfilled) {
 414                 int length, blksize, result;
 415
 416                 dbg("%s - transmitting data (frame n)", __func__);
 417
 418                 length = ((priv->wrfilled - priv->wrsent) > port->bulk_out_size) ?
 419                         port->bulk_out_size : (priv->wrfilled - priv->wrsent);
 420
 421                 memcpy(port->write_urb->transfer_buffer,
 422                                         priv->wrbuf + priv->wrsent, length);
 423                 priv->wrsent += length;
 424
 425                 /* set up our urb */
 426                 port->write_urb->transfer_buffer_length = length;
 427
 428                 /* send the data out the bulk port */
 429                 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
 430                 if (result) {
 431                         dev_err(&port->dev,
 432                                 "%s - failed submitting write urb, error %d\n",
 433                                 __func__, result);
 434                         /* Throw away data. No better idea what to do with it. */
 435                         priv->wrfilled = 0;
 436                         priv->wrsent = 0;
 437                         goto exit;
 438                 }
 439
 440                 dbg("%s - priv->wrsent=%d", __func__, priv->wrsent);
 441                 dbg("%s - priv->wrfilled=%d", __func__, priv->wrfilled);
 442
 443                 blksize = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3;
 444
 445                 if (priv->wrsent >= priv->wrfilled ||
 446                                         priv->wrsent >= blksize) {
 447                         dbg("%s - buffer cleaned", __func__);
 448                         memset(priv->wrbuf, 0, sizeof(priv->wrbuf));
 449                         priv->wrfilled = 0;
 450                         priv->wrsent = 0;
 451                 }
 452         }
 453
 454 exit:
 455         spin_unlock(&priv->lock);
 456         usb_serial_port_softint(port);
 457 }
 458
 459 module_usb_serial_driver(cyberjack_driver, serial_drivers);
 460
 461 MODULE_AUTHOR(DRIVER_AUTHOR);
 462 MODULE_DESCRIPTION(DRIVER_DESC);
 463 MODULE_VERSION(DRIVER_VERSION);
 464 MODULE_LICENSE("GPL");
 465
 466 module_param(debug, bool, S_IRUGO | S_IWUSR);
 467 MODULE_PARM_DESC(debug, "Debug enabled or not");