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 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 dev_err(&serial->dev->dev, 145 "usb_submit_urb(read int) failed\n"); 146 dbg("%s - usb_submit_urb(int urb)", __func__); 147 } 148 149 return 0; 150 } 151 152 static void cyberjack_shutdown(struct usb_serial *serial) 153 { 154 int i; 155 156 dbg("%s", __func__); 157 158 for (i = 0; i < serial->num_ports; ++i) { 159 usb_kill_urb(serial->port[i]->interrupt_in_urb); 160 /* My special items, the standard routines free my urbs */ 161 kfree(usb_get_serial_port_data(serial->port[i])); 162 usb_set_serial_port_data(serial->port[i], NULL); 163 } 164 } 165 166 static int cyberjack_open(struct tty_struct *tty, 167 struct usb_serial_port *port, struct file *filp) 168 { 169 struct cyberjack_private *priv; 170 unsigned long flags; 171 int result = 0; 172 173 dbg("%s - port %d", __func__, port->number); 174 175 dbg("%s - usb_clear_halt", __func__); 176 usb_clear_halt(port->serial->dev, port->write_urb->pipe); 177 178 /* force low_latency on so that our tty_push actually forces 179 * the data through, otherwise it is scheduled, and with high 180 * data rates (like with OHCI) data can get lost. 181 */ 182 if (tty) 183 tty->low_latency = 1; 184 185 priv = usb_get_serial_port_data(port); 186 spin_lock_irqsave(&priv->lock, flags); 187 priv->rdtodo = 0; 188 priv->wrfilled = 0; 189 priv->wrsent = 0; 190 spin_unlock_irqrestore(&priv->lock, flags); 191 192 return result; 193 } 194 195 static void cyberjack_close(struct tty_struct *tty, 196 struct usb_serial_port *port, struct file *filp) 197 { 198 dbg("%s - port %d", __func__, port->number); 199 200 if (port->serial->dev) { 201 /* shutdown any bulk reads that might be going on */ 202 usb_kill_urb(port->write_urb); 203 usb_kill_urb(port->read_urb); 204 } 205 } 206 207 static int cyberjack_write(struct tty_struct *tty, 208 struct usb_serial_port *port, const unsigned char *buf, int count) 209 { 210 struct usb_serial *serial = port->serial; 211 struct cyberjack_private *priv = usb_get_serial_port_data(port); 212 unsigned long flags; 213 int result; 214 int wrexpected; 215 216 dbg("%s - port %d", __func__, port->number); 217 218 if (count == 0) { 219 dbg("%s - write request of 0 bytes", __func__); 220 return 0; 221 } 222 223 spin_lock_bh(&port->lock); 224 if (port->write_urb_busy) { 225 spin_unlock_bh(&port->lock); 226 dbg("%s - already writing", __func__); 227 return 0; 228 } 229 port->write_urb_busy = 1; 230 spin_unlock_bh(&port->lock); 231 232 spin_lock_irqsave(&priv->lock, flags); 233 234 if (count+priv->wrfilled > sizeof(priv->wrbuf)) { 235 /* To much data for buffer. Reset buffer. */ 236 priv->wrfilled = 0; 237 port->write_urb_busy = 0; 238 spin_unlock_irqrestore(&priv->lock, flags); 239 return 0; 240 } 241 242 /* Copy data */ 243 memcpy(priv->wrbuf + priv->wrfilled, buf, count); 244 245 usb_serial_debug_data(debug, &port->dev, __func__, count, 246 priv->wrbuf + priv->wrfilled); 247 priv->wrfilled += count; 248 249 if (priv->wrfilled >= 3) { 250 wrexpected = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3; 251 dbg("%s - expected data: %d", __func__, wrexpected); 252 } else 253 wrexpected = sizeof(priv->wrbuf); 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) ? 261 port->bulk_out_size : wrexpected; 262 263 memcpy(port->write_urb->transfer_buffer, priv->wrbuf, length); 264 priv->wrsent = length; 265 266 /* set up our urb */ 267 usb_fill_bulk_urb(port->write_urb, serial->dev, 268 usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress), 269 port->write_urb->transfer_buffer, length, 270 ((serial->type->write_bulk_callback) ? 271 serial->type->write_bulk_callback : 272 cyberjack_write_bulk_callback), 273 port); 274 275 /* send the data out the bulk port */ 276 result = usb_submit_urb(port->write_urb, GFP_ATOMIC); 277 if (result) { 278 dev_err(&port->dev, 279 "%s - failed submitting write urb, error %d", 280 __func__, result); 281 /* Throw away data. No better idea what to do with it. */ 282 priv->wrfilled = 0; 283 priv->wrsent = 0; 284 spin_unlock_irqrestore(&priv->lock, flags); 285 port->write_urb_busy = 0; 286 return 0; 287 } 288 289 dbg("%s - priv->wrsent=%d", __func__, priv->wrsent); 290 dbg("%s - priv->wrfilled=%d", __func__, priv->wrfilled); 291 292 if (priv->wrsent >= priv->wrfilled) { 293 dbg("%s - buffer cleaned", __func__); 294 memset(priv->wrbuf, 0, sizeof(priv->wrbuf)); 295 priv->wrfilled = 0; 296 priv->wrsent = 0; 297 } 298 } 299 300 spin_unlock_irqrestore(&priv->lock, flags); 301 302 return count; 303 } 304 305 static int cyberjack_write_room(struct tty_struct *tty) 306 { 307 /* FIXME: .... */ 308 return CYBERJACK_LOCAL_BUF_SIZE; 309 } 310 311 static void cyberjack_read_int_callback(struct urb *urb) 312 { 313 struct usb_serial_port *port = urb->context; 314 struct cyberjack_private *priv = usb_get_serial_port_data(port); 315 unsigned char *data = urb->transfer_buffer; 316 int status = urb->status; 317 int result; 318 319 dbg("%s - port %d", __func__, port->number); 320 321 /* the urb might have been killed. */ 322 if (status) 323 return; 324 325 usb_serial_debug_data(debug, &port->dev, __func__, 326 urb->actual_length, data); 327 328 /* React only to interrupts signaling a bulk_in transfer */ 329 if (urb->actual_length == 4 && data[0] == 0x01) { 330 short old_rdtodo; 331 332 /* This is a announcement of coming bulk_ins. */ 333 unsigned short size = ((unsigned short)data[3]<<8)+data[2]+3; 334 335 spin_lock(&priv->lock); 336 337 old_rdtodo = priv->rdtodo; 338 339 if (old_rdtodo + size < old_rdtodo) { 340 dbg("To many bulk_in urbs to do."); 341 spin_unlock(&priv->lock); 342 goto resubmit; 343 } 344 345 /* "+=" is probably more fault tollerant than "=" */ 346 priv->rdtodo += size; 347 348 dbg("%s - rdtodo: %d", __func__, priv->rdtodo); 349 350 spin_unlock(&priv->lock); 351 352 if (!old_rdtodo) { 353 port->read_urb->dev = port->serial->dev; 354 result = usb_submit_urb(port->read_urb, GFP_ATOMIC); 355 if (result) 356 dev_err(&port->dev, "%s - failed resubmitting " 357 "read urb, error %d\n", 358 __func__, result); 359 dbg("%s - usb_submit_urb(read urb)", __func__); 360 } 361 } 362 363 resubmit: 364 port->interrupt_in_urb->dev = port->serial->dev; 365 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC); 366 if (result) 367 dev_err(&port->dev, "usb_submit_urb(read int) failed\n"); 368 dbg("%s - usb_submit_urb(int urb)", __func__); 369 } 370 371 static void cyberjack_read_bulk_callback(struct urb *urb) 372 { 373 struct usb_serial_port *port = urb->context; 374 struct cyberjack_private *priv = usb_get_serial_port_data(port); 375 struct tty_struct *tty; 376 unsigned char *data = urb->transfer_buffer; 377 short todo; 378 int result; 379 int status = urb->status; 380 381 dbg("%s - port %d", __func__, port->number); 382 383 usb_serial_debug_data(debug, &port->dev, __func__, 384 urb->actual_length, data); 385 if (status) { 386 dbg("%s - nonzero read bulk status received: %d", 387 __func__, status); 388 return; 389 } 390 391 tty = tty_port_tty_get(&port->port); 392 if (!tty) { 393 dbg("%s - ignoring since device not open\n", __func__); 394 return; 395 } 396 if (urb->actual_length) { 397 tty_buffer_request_room(tty, 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"); 534