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