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); 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 .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 .disconnect = cyberjack_disconnect, 99 .release = cyberjack_release, 100 .open = cyberjack_open, 101 .close = cyberjack_close, 102 .write = cyberjack_write, 103 .write_room = cyberjack_write_room, 104 .read_int_callback = cyberjack_read_int_callback, 105 .read_bulk_callback = cyberjack_read_bulk_callback, 106 .write_bulk_callback = cyberjack_write_bulk_callback, 107 }; 108 109 struct cyberjack_private { 110 spinlock_t lock; /* Lock for SMP */ 111 short rdtodo; /* Bytes still to read */ 112 unsigned char wrbuf[5*64]; /* Buffer for collecting data to write */ 113 short wrfilled; /* Overall data size we already got */ 114 short wrsent; /* Data already sent */ 115 }; 116 117 /* do some startup allocations not currently performed by usb_serial_probe() */ 118 static int cyberjack_startup(struct usb_serial *serial) 119 { 120 struct cyberjack_private *priv; 121 int i; 122 123 dbg("%s", __func__); 124 125 /* allocate the private data structure */ 126 priv = kmalloc(sizeof(struct cyberjack_private), GFP_KERNEL); 127 if (!priv) 128 return -ENOMEM; 129 130 /* set initial values */ 131 spin_lock_init(&priv->lock); 132 priv->rdtodo = 0; 133 priv->wrfilled = 0; 134 priv->wrsent = 0; 135 usb_set_serial_port_data(serial->port[0], priv); 136 137 init_waitqueue_head(&serial->port[0]->write_wait); 138 139 for (i = 0; i < serial->num_ports; ++i) { 140 int result; 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_disconnect(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 } 161 162 static void cyberjack_release(struct usb_serial *serial) 163 { 164 int i; 165 166 dbg("%s", __func__); 167 168 for (i = 0; i < serial->num_ports; ++i) { 169 /* My special items, the standard routines free my urbs */ 170 kfree(usb_get_serial_port_data(serial->port[i])); 171 } 172 } 173 174 static int cyberjack_open(struct tty_struct *tty, 175 struct usb_serial_port *port) 176 { 177 struct cyberjack_private *priv; 178 unsigned long flags; 179 int result = 0; 180 181 dbg("%s - port %d", __func__, port->number); 182 183 dbg("%s - usb_clear_halt", __func__); 184 usb_clear_halt(port->serial->dev, port->write_urb->pipe); 185 186 priv = usb_get_serial_port_data(port); 187 spin_lock_irqsave(&priv->lock, flags); 188 priv->rdtodo = 0; 189 priv->wrfilled = 0; 190 priv->wrsent = 0; 191 spin_unlock_irqrestore(&priv->lock, flags); 192 193 return result; 194 } 195 196 static void cyberjack_close(struct usb_serial_port *port) 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 if (!test_and_clear_bit(0, &port->write_urbs_free)) { 224 dbg("%s - already writing", __func__); 225 return 0; 226 } 227 228 spin_lock_irqsave(&priv->lock, flags); 229 230 if (count+priv->wrfilled > sizeof(priv->wrbuf)) { 231 /* To much data for buffer. Reset buffer. */ 232 priv->wrfilled = 0; 233 spin_unlock_irqrestore(&priv->lock, flags); 234 set_bit(0, &port->write_urbs_free); 235 return 0; 236 } 237 238 /* Copy data */ 239 memcpy(priv->wrbuf + priv->wrfilled, buf, count); 240 241 usb_serial_debug_data(debug, &port->dev, __func__, count, 242 priv->wrbuf + priv->wrfilled); 243 priv->wrfilled += count; 244 245 if (priv->wrfilled >= 3) { 246 wrexpected = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3; 247 dbg("%s - expected data: %d", __func__, wrexpected); 248 } else 249 wrexpected = sizeof(priv->wrbuf); 250 251 if (priv->wrfilled >= wrexpected) { 252 /* We have enough data to begin transmission */ 253 int length; 254 255 dbg("%s - transmitting data (frame 1)", __func__); 256 length = (wrexpected > port->bulk_out_size) ? 257 port->bulk_out_size : wrexpected; 258 259 memcpy(port->write_urb->transfer_buffer, priv->wrbuf, length); 260 priv->wrsent = length; 261 262 /* set up our urb */ 263 usb_fill_bulk_urb(port->write_urb, serial->dev, 264 usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress), 265 port->write_urb->transfer_buffer, length, 266 ((serial->type->write_bulk_callback) ? 267 serial->type->write_bulk_callback : 268 cyberjack_write_bulk_callback), 269 port); 270 271 /* send the data out the bulk port */ 272 result = usb_submit_urb(port->write_urb, GFP_ATOMIC); 273 if (result) { 274 dev_err(&port->dev, 275 "%s - failed submitting write urb, error %d", 276 __func__, result); 277 /* Throw away data. No better idea what to do with it. */ 278 priv->wrfilled = 0; 279 priv->wrsent = 0; 280 spin_unlock_irqrestore(&priv->lock, flags); 281 set_bit(0, &port->write_urbs_free); 282 return 0; 283 } 284 285 dbg("%s - priv->wrsent=%d", __func__, priv->wrsent); 286 dbg("%s - priv->wrfilled=%d", __func__, priv->wrfilled); 287 288 if (priv->wrsent >= priv->wrfilled) { 289 dbg("%s - buffer cleaned", __func__); 290 memset(priv->wrbuf, 0, sizeof(priv->wrbuf)); 291 priv->wrfilled = 0; 292 priv->wrsent = 0; 293 } 294 } 295 296 spin_unlock_irqrestore(&priv->lock, flags); 297 298 return count; 299 } 300 301 static int cyberjack_write_room(struct tty_struct *tty) 302 { 303 /* FIXME: .... */ 304 return CYBERJACK_LOCAL_BUF_SIZE; 305 } 306 307 static void cyberjack_read_int_callback(struct urb *urb) 308 { 309 struct usb_serial_port *port = urb->context; 310 struct cyberjack_private *priv = usb_get_serial_port_data(port); 311 unsigned char *data = urb->transfer_buffer; 312 int status = urb->status; 313 int result; 314 315 dbg("%s - port %d", __func__, port->number); 316 317 /* the urb might have been killed. */ 318 if (status) 319 return; 320 321 usb_serial_debug_data(debug, &port->dev, __func__, 322 urb->actual_length, data); 323 324 /* React only to interrupts signaling a bulk_in transfer */ 325 if (urb->actual_length == 4 && data[0] == 0x01) { 326 short old_rdtodo; 327 328 /* This is a announcement of coming bulk_ins. */ 329 unsigned short size = ((unsigned short)data[3]<<8)+data[2]+3; 330 331 spin_lock(&priv->lock); 332 333 old_rdtodo = priv->rdtodo; 334 335 if (old_rdtodo + size < old_rdtodo) { 336 dbg("To many bulk_in urbs to do."); 337 spin_unlock(&priv->lock); 338 goto resubmit; 339 } 340 341 /* "+=" is probably more fault tollerant than "=" */ 342 priv->rdtodo += size; 343 344 dbg("%s - rdtodo: %d", __func__, priv->rdtodo); 345 346 spin_unlock(&priv->lock); 347 348 if (!old_rdtodo) { 349 result = usb_submit_urb(port->read_urb, GFP_ATOMIC); 350 if (result) 351 dev_err(&port->dev, "%s - failed resubmitting " 352 "read urb, error %d\n", 353 __func__, result); 354 dbg("%s - usb_submit_urb(read urb)", __func__); 355 } 356 } 357 358 resubmit: 359 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC); 360 if (result) 361 dev_err(&port->dev, "usb_submit_urb(read int) failed\n"); 362 dbg("%s - usb_submit_urb(int urb)", __func__); 363 } 364 365 static void cyberjack_read_bulk_callback(struct urb *urb) 366 { 367 struct usb_serial_port *port = urb->context; 368 struct cyberjack_private *priv = usb_get_serial_port_data(port); 369 struct tty_struct *tty; 370 unsigned char *data = urb->transfer_buffer; 371 short todo; 372 int result; 373 int status = urb->status; 374 375 dbg("%s - port %d", __func__, port->number); 376 377 usb_serial_debug_data(debug, &port->dev, __func__, 378 urb->actual_length, data); 379 if (status) { 380 dbg("%s - nonzero read bulk status received: %d", 381 __func__, status); 382 return; 383 } 384 385 tty = tty_port_tty_get(&port->port); 386 if (!tty) { 387 dbg("%s - ignoring since device not open", __func__); 388 return; 389 } 390 if (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 result = usb_submit_urb(port->read_urb, GFP_ATOMIC); 412 if (result) 413 dev_err(&port->dev, "%s - failed resubmitting read " 414 "urb, error %d\n", __func__, result); 415 dbg("%s - usb_submit_urb(read urb)", __func__); 416 } 417 } 418 419 static void cyberjack_write_bulk_callback(struct urb *urb) 420 { 421 struct usb_serial_port *port = urb->context; 422 struct cyberjack_private *priv = usb_get_serial_port_data(port); 423 int status = urb->status; 424 425 dbg("%s - port %d", __func__, port->number); 426 427 set_bit(0, &port->write_urbs_free); 428 if (status) { 429 dbg("%s - nonzero write bulk status received: %d", 430 __func__, status); 431 return; 432 } 433 434 spin_lock(&priv->lock); 435 436 /* only do something if we have more data to send */ 437 if (priv->wrfilled) { 438 int length, blksize, result; 439 440 dbg("%s - transmitting data (frame n)", __func__); 441 442 length = ((priv->wrfilled - priv->wrsent) > port->bulk_out_size) ? 443 port->bulk_out_size : (priv->wrfilled - priv->wrsent); 444 445 memcpy(port->write_urb->transfer_buffer, 446 priv->wrbuf + priv->wrsent, length); 447 priv->wrsent += length; 448 449 /* set up our urb */ 450 usb_fill_bulk_urb(port->write_urb, port->serial->dev, 451 usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress), 452 port->write_urb->transfer_buffer, length, 453 ((port->serial->type->write_bulk_callback) ? 454 port->serial->type->write_bulk_callback : 455 cyberjack_write_bulk_callback), 456 port); 457 458 /* send the data out the bulk port */ 459 result = usb_submit_urb(port->write_urb, GFP_ATOMIC); 460 if (result) { 461 dev_err(&port->dev, 462 "%s - failed submitting write urb, error %d\n", 463 __func__, result); 464 /* Throw away data. No better idea what to do with it. */ 465 priv->wrfilled = 0; 466 priv->wrsent = 0; 467 goto exit; 468 } 469 470 dbg("%s - priv->wrsent=%d", __func__, priv->wrsent); 471 dbg("%s - priv->wrfilled=%d", __func__, priv->wrfilled); 472 473 blksize = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3; 474 475 if (priv->wrsent >= priv->wrfilled || 476 priv->wrsent >= blksize) { 477 dbg("%s - buffer cleaned", __func__); 478 memset(priv->wrbuf, 0, sizeof(priv->wrbuf)); 479 priv->wrfilled = 0; 480 priv->wrsent = 0; 481 } 482 } 483 484 exit: 485 spin_unlock(&priv->lock); 486 usb_serial_port_softint(port); 487 } 488 489 static int __init cyberjack_init(void) 490 { 491 int retval; 492 retval = usb_serial_register(&cyberjack_device); 493 if (retval) 494 goto failed_usb_serial_register; 495 retval = usb_register(&cyberjack_driver); 496 if (retval) 497 goto failed_usb_register; 498 499 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION " " 500 DRIVER_AUTHOR "\n"); 501 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n"); 502 503 return 0; 504 failed_usb_register: 505 usb_serial_deregister(&cyberjack_device); 506 failed_usb_serial_register: 507 return retval; 508 } 509 510 static void __exit cyberjack_exit(void) 511 { 512 usb_deregister(&cyberjack_driver); 513 usb_serial_deregister(&cyberjack_device); 514 } 515 516 module_init(cyberjack_init); 517 module_exit(cyberjack_exit); 518 519 MODULE_AUTHOR(DRIVER_AUTHOR); 520 MODULE_DESCRIPTION(DRIVER_DESC); 521 MODULE_VERSION(DRIVER_VERSION); 522 MODULE_LICENSE("GPL"); 523 524 module_param(debug, bool, S_IRUGO | S_IWUSR); 525 MODULE_PARM_DESC(debug, "Debug enabled or not"); 526