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