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