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 #define DRIVER_AUTHOR "Matthias Bruestle" 47 #define DRIVER_DESC "REINER SCT cyberJack pinpad/e-com USB Chipcard Reader Driver" 48 49 50 #define CYBERJACK_VENDOR_ID 0x0C4B 51 #define CYBERJACK_PRODUCT_ID 0x0100 52 53 /* Function prototypes */ 54 static int cyberjack_port_probe(struct usb_serial_port *port); 55 static int cyberjack_port_remove(struct usb_serial_port *port); 56 static int cyberjack_open(struct tty_struct *tty, 57 struct usb_serial_port *port); 58 static void cyberjack_close(struct usb_serial_port *port); 59 static int cyberjack_write(struct tty_struct *tty, 60 struct usb_serial_port *port, const unsigned char *buf, int count); 61 static int cyberjack_write_room(struct tty_struct *tty); 62 static void cyberjack_read_int_callback(struct urb *urb); 63 static void cyberjack_read_bulk_callback(struct urb *urb); 64 static void cyberjack_write_bulk_callback(struct urb *urb); 65 66 static const struct usb_device_id id_table[] = { 67 { USB_DEVICE(CYBERJACK_VENDOR_ID, CYBERJACK_PRODUCT_ID) }, 68 { } /* Terminating entry */ 69 }; 70 71 MODULE_DEVICE_TABLE(usb, id_table); 72 73 static struct usb_serial_driver cyberjack_device = { 74 .driver = { 75 .owner = THIS_MODULE, 76 .name = "cyberjack", 77 }, 78 .description = "Reiner SCT Cyberjack USB card reader", 79 .id_table = id_table, 80 .num_ports = 1, 81 .port_probe = cyberjack_port_probe, 82 .port_remove = cyberjack_port_remove, 83 .open = cyberjack_open, 84 .close = cyberjack_close, 85 .write = cyberjack_write, 86 .write_room = cyberjack_write_room, 87 .read_int_callback = cyberjack_read_int_callback, 88 .read_bulk_callback = cyberjack_read_bulk_callback, 89 .write_bulk_callback = cyberjack_write_bulk_callback, 90 }; 91 92 static struct usb_serial_driver * const serial_drivers[] = { 93 &cyberjack_device, NULL 94 }; 95 96 struct cyberjack_private { 97 spinlock_t lock; /* Lock for SMP */ 98 short rdtodo; /* Bytes still to read */ 99 unsigned char wrbuf[5*64]; /* Buffer for collecting data to write */ 100 short wrfilled; /* Overall data size we already got */ 101 short wrsent; /* Data already sent */ 102 }; 103 104 static int cyberjack_port_probe(struct usb_serial_port *port) 105 { 106 struct cyberjack_private *priv; 107 int result; 108 109 priv = kmalloc(sizeof(struct cyberjack_private), GFP_KERNEL); 110 if (!priv) 111 return -ENOMEM; 112 113 spin_lock_init(&priv->lock); 114 priv->rdtodo = 0; 115 priv->wrfilled = 0; 116 priv->wrsent = 0; 117 118 usb_set_serial_port_data(port, priv); 119 120 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL); 121 if (result) 122 dev_err(&port->dev, "usb_submit_urb(read int) failed\n"); 123 124 return 0; 125 } 126 127 static int cyberjack_port_remove(struct usb_serial_port *port) 128 { 129 struct cyberjack_private *priv; 130 131 usb_kill_urb(port->interrupt_in_urb); 132 133 priv = usb_get_serial_port_data(port); 134 kfree(priv); 135 136 return 0; 137 } 138 139 static int cyberjack_open(struct tty_struct *tty, 140 struct usb_serial_port *port) 141 { 142 struct cyberjack_private *priv; 143 unsigned long flags; 144 int result = 0; 145 146 dev_dbg(&port->dev, "%s - usb_clear_halt\n", __func__); 147 usb_clear_halt(port->serial->dev, port->write_urb->pipe); 148 149 priv = usb_get_serial_port_data(port); 150 spin_lock_irqsave(&priv->lock, flags); 151 priv->rdtodo = 0; 152 priv->wrfilled = 0; 153 priv->wrsent = 0; 154 spin_unlock_irqrestore(&priv->lock, flags); 155 156 return result; 157 } 158 159 static void cyberjack_close(struct usb_serial_port *port) 160 { 161 usb_kill_urb(port->write_urb); 162 usb_kill_urb(port->read_urb); 163 } 164 165 static int cyberjack_write(struct tty_struct *tty, 166 struct usb_serial_port *port, const unsigned char *buf, int count) 167 { 168 struct device *dev = &port->dev; 169 struct cyberjack_private *priv = usb_get_serial_port_data(port); 170 unsigned long flags; 171 int result; 172 int wrexpected; 173 174 if (count == 0) { 175 dev_dbg(dev, "%s - write request of 0 bytes\n", __func__); 176 return 0; 177 } 178 179 if (!test_and_clear_bit(0, &port->write_urbs_free)) { 180 dev_dbg(dev, "%s - already writing\n", __func__); 181 return 0; 182 } 183 184 spin_lock_irqsave(&priv->lock, flags); 185 186 if (count+priv->wrfilled > sizeof(priv->wrbuf)) { 187 /* To much data for buffer. Reset buffer. */ 188 priv->wrfilled = 0; 189 spin_unlock_irqrestore(&priv->lock, flags); 190 set_bit(0, &port->write_urbs_free); 191 return 0; 192 } 193 194 /* Copy data */ 195 memcpy(priv->wrbuf + priv->wrfilled, buf, count); 196 197 usb_serial_debug_data(dev, __func__, count, priv->wrbuf + priv->wrfilled); 198 priv->wrfilled += count; 199 200 if (priv->wrfilled >= 3) { 201 wrexpected = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3; 202 dev_dbg(dev, "%s - expected data: %d\n", __func__, wrexpected); 203 } else 204 wrexpected = sizeof(priv->wrbuf); 205 206 if (priv->wrfilled >= wrexpected) { 207 /* We have enough data to begin transmission */ 208 int length; 209 210 dev_dbg(dev, "%s - transmitting data (frame 1)\n", __func__); 211 length = (wrexpected > port->bulk_out_size) ? 212 port->bulk_out_size : wrexpected; 213 214 memcpy(port->write_urb->transfer_buffer, priv->wrbuf, length); 215 priv->wrsent = length; 216 217 /* set up our urb */ 218 port->write_urb->transfer_buffer_length = length; 219 220 /* send the data out the bulk port */ 221 result = usb_submit_urb(port->write_urb, GFP_ATOMIC); 222 if (result) { 223 dev_err(&port->dev, 224 "%s - failed submitting write urb, error %d", 225 __func__, result); 226 /* Throw away data. No better idea what to do with it. */ 227 priv->wrfilled = 0; 228 priv->wrsent = 0; 229 spin_unlock_irqrestore(&priv->lock, flags); 230 set_bit(0, &port->write_urbs_free); 231 return 0; 232 } 233 234 dev_dbg(dev, "%s - priv->wrsent=%d\n", __func__, priv->wrsent); 235 dev_dbg(dev, "%s - priv->wrfilled=%d\n", __func__, priv->wrfilled); 236 237 if (priv->wrsent >= priv->wrfilled) { 238 dev_dbg(dev, "%s - buffer cleaned\n", __func__); 239 memset(priv->wrbuf, 0, sizeof(priv->wrbuf)); 240 priv->wrfilled = 0; 241 priv->wrsent = 0; 242 } 243 } 244 245 spin_unlock_irqrestore(&priv->lock, flags); 246 247 return count; 248 } 249 250 static int cyberjack_write_room(struct tty_struct *tty) 251 { 252 /* FIXME: .... */ 253 return CYBERJACK_LOCAL_BUF_SIZE; 254 } 255 256 static void cyberjack_read_int_callback(struct urb *urb) 257 { 258 struct usb_serial_port *port = urb->context; 259 struct cyberjack_private *priv = usb_get_serial_port_data(port); 260 struct device *dev = &port->dev; 261 unsigned char *data = urb->transfer_buffer; 262 int status = urb->status; 263 int result; 264 265 /* the urb might have been killed. */ 266 if (status) 267 return; 268 269 usb_serial_debug_data(dev, __func__, urb->actual_length, data); 270 271 /* React only to interrupts signaling a bulk_in transfer */ 272 if (urb->actual_length == 4 && data[0] == 0x01) { 273 short old_rdtodo; 274 275 /* This is a announcement of coming bulk_ins. */ 276 unsigned short size = ((unsigned short)data[3]<<8)+data[2]+3; 277 278 spin_lock(&priv->lock); 279 280 old_rdtodo = priv->rdtodo; 281 282 if (old_rdtodo > SHRT_MAX - size) { 283 dev_dbg(dev, "To many bulk_in urbs to do.\n"); 284 spin_unlock(&priv->lock); 285 goto resubmit; 286 } 287 288 /* "+=" is probably more fault tollerant than "=" */ 289 priv->rdtodo += size; 290 291 dev_dbg(dev, "%s - rdtodo: %d\n", __func__, priv->rdtodo); 292 293 spin_unlock(&priv->lock); 294 295 if (!old_rdtodo) { 296 result = usb_submit_urb(port->read_urb, GFP_ATOMIC); 297 if (result) 298 dev_err(dev, "%s - failed resubmitting read urb, error %d\n", 299 __func__, result); 300 dev_dbg(dev, "%s - usb_submit_urb(read urb)\n", __func__); 301 } 302 } 303 304 resubmit: 305 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC); 306 if (result) 307 dev_err(&port->dev, "usb_submit_urb(read int) failed\n"); 308 dev_dbg(dev, "%s - usb_submit_urb(int urb)\n", __func__); 309 } 310 311 static void cyberjack_read_bulk_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 struct device *dev = &port->dev; 316 unsigned char *data = urb->transfer_buffer; 317 short todo; 318 int result; 319 int status = urb->status; 320 321 usb_serial_debug_data(dev, __func__, urb->actual_length, data); 322 if (status) { 323 dev_dbg(dev, "%s - nonzero read bulk status received: %d\n", 324 __func__, status); 325 return; 326 } 327 328 if (urb->actual_length) { 329 tty_insert_flip_string(&port->port, data, urb->actual_length); 330 tty_flip_buffer_push(&port->port); 331 } 332 333 spin_lock(&priv->lock); 334 335 /* Reduce urbs to do by one. */ 336 priv->rdtodo -= urb->actual_length; 337 /* Just to be sure */ 338 if (priv->rdtodo < 0) 339 priv->rdtodo = 0; 340 todo = priv->rdtodo; 341 342 spin_unlock(&priv->lock); 343 344 dev_dbg(dev, "%s - rdtodo: %d\n", __func__, todo); 345 346 /* Continue to read if we have still urbs to do. */ 347 if (todo /* || (urb->actual_length==port->bulk_in_endpointAddress)*/) { 348 result = usb_submit_urb(port->read_urb, GFP_ATOMIC); 349 if (result) 350 dev_err(dev, "%s - failed resubmitting read urb, error %d\n", 351 __func__, result); 352 dev_dbg(dev, "%s - usb_submit_urb(read urb)\n", __func__); 353 } 354 } 355 356 static void cyberjack_write_bulk_callback(struct urb *urb) 357 { 358 struct usb_serial_port *port = urb->context; 359 struct cyberjack_private *priv = usb_get_serial_port_data(port); 360 struct device *dev = &port->dev; 361 int status = urb->status; 362 363 set_bit(0, &port->write_urbs_free); 364 if (status) { 365 dev_dbg(dev, "%s - nonzero write bulk status received: %d\n", 366 __func__, status); 367 return; 368 } 369 370 spin_lock(&priv->lock); 371 372 /* only do something if we have more data to send */ 373 if (priv->wrfilled) { 374 int length, blksize, result; 375 376 dev_dbg(dev, "%s - transmitting data (frame n)\n", __func__); 377 378 length = ((priv->wrfilled - priv->wrsent) > port->bulk_out_size) ? 379 port->bulk_out_size : (priv->wrfilled - priv->wrsent); 380 381 memcpy(port->write_urb->transfer_buffer, 382 priv->wrbuf + priv->wrsent, length); 383 priv->wrsent += length; 384 385 /* set up our urb */ 386 port->write_urb->transfer_buffer_length = length; 387 388 /* send the data out the bulk port */ 389 result = usb_submit_urb(port->write_urb, GFP_ATOMIC); 390 if (result) { 391 dev_err(dev, "%s - failed submitting write urb, error %d\n", 392 __func__, result); 393 /* Throw away data. No better idea what to do with it. */ 394 priv->wrfilled = 0; 395 priv->wrsent = 0; 396 goto exit; 397 } 398 399 dev_dbg(dev, "%s - priv->wrsent=%d\n", __func__, priv->wrsent); 400 dev_dbg(dev, "%s - priv->wrfilled=%d\n", __func__, priv->wrfilled); 401 402 blksize = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3; 403 404 if (priv->wrsent >= priv->wrfilled || 405 priv->wrsent >= blksize) { 406 dev_dbg(dev, "%s - buffer cleaned\n", __func__); 407 memset(priv->wrbuf, 0, sizeof(priv->wrbuf)); 408 priv->wrfilled = 0; 409 priv->wrsent = 0; 410 } 411 } 412 413 exit: 414 spin_unlock(&priv->lock); 415 usb_serial_port_softint(port); 416 } 417 418 module_usb_serial_driver(serial_drivers, id_table); 419 420 MODULE_AUTHOR(DRIVER_AUTHOR); 421 MODULE_DESCRIPTION(DRIVER_DESC); 422 MODULE_LICENSE("GPL"); 423