1 /* 2 * KOBIL USB Smart Card Terminal Driver 3 * 4 * Copyright (C) 2002 KOBIL Systems GmbH 5 * Author: Thomas Wahrenbruch 6 * 7 * Contact: linuxusb@kobil.de 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 * Supported readers: USB TWIN, KAAN Standard Plus and SecOVID Reader Plus 22 * (Adapter K), B1 Professional and KAAN Professional (Adapter B) 23 */ 24 25 26 #include <linux/kernel.h> 27 #include <linux/errno.h> 28 #include <linux/slab.h> 29 #include <linux/tty.h> 30 #include <linux/tty_driver.h> 31 #include <linux/tty_flip.h> 32 #include <linux/module.h> 33 #include <linux/spinlock.h> 34 #include <linux/uaccess.h> 35 #include <linux/usb.h> 36 #include <linux/usb/serial.h> 37 #include <linux/ioctl.h> 38 #include "kobil_sct.h" 39 40 #define DRIVER_AUTHOR "KOBIL Systems GmbH - http://www.kobil.com" 41 #define DRIVER_DESC "KOBIL USB Smart Card Terminal Driver (experimental)" 42 43 #define KOBIL_VENDOR_ID 0x0D46 44 #define KOBIL_ADAPTER_B_PRODUCT_ID 0x2011 45 #define KOBIL_ADAPTER_K_PRODUCT_ID 0x2012 46 #define KOBIL_USBTWIN_PRODUCT_ID 0x0078 47 #define KOBIL_KAAN_SIM_PRODUCT_ID 0x0081 48 49 #define KOBIL_TIMEOUT 500 50 #define KOBIL_BUF_LENGTH 300 51 52 53 /* Function prototypes */ 54 static int kobil_port_probe(struct usb_serial_port *probe); 55 static int kobil_port_remove(struct usb_serial_port *probe); 56 static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port); 57 static void kobil_close(struct usb_serial_port *port); 58 static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port, 59 const unsigned char *buf, int count); 60 static int kobil_write_room(struct tty_struct *tty); 61 static int kobil_ioctl(struct tty_struct *tty, 62 unsigned int cmd, unsigned long arg); 63 static int kobil_tiocmget(struct tty_struct *tty); 64 static int kobil_tiocmset(struct tty_struct *tty, 65 unsigned int set, unsigned int clear); 66 static void kobil_read_int_callback(struct urb *urb); 67 static void kobil_write_int_callback(struct urb *urb); 68 static void kobil_set_termios(struct tty_struct *tty, 69 struct usb_serial_port *port, struct ktermios *old); 70 static void kobil_init_termios(struct tty_struct *tty); 71 72 static const struct usb_device_id id_table[] = { 73 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_ADAPTER_B_PRODUCT_ID) }, 74 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_ADAPTER_K_PRODUCT_ID) }, 75 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_USBTWIN_PRODUCT_ID) }, 76 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_KAAN_SIM_PRODUCT_ID) }, 77 { } /* Terminating entry */ 78 }; 79 MODULE_DEVICE_TABLE(usb, id_table); 80 81 static struct usb_serial_driver kobil_device = { 82 .driver = { 83 .owner = THIS_MODULE, 84 .name = "kobil", 85 }, 86 .description = "KOBIL USB smart card terminal", 87 .id_table = id_table, 88 .num_ports = 1, 89 .num_interrupt_out = 1, 90 .port_probe = kobil_port_probe, 91 .port_remove = kobil_port_remove, 92 .ioctl = kobil_ioctl, 93 .set_termios = kobil_set_termios, 94 .init_termios = kobil_init_termios, 95 .tiocmget = kobil_tiocmget, 96 .tiocmset = kobil_tiocmset, 97 .open = kobil_open, 98 .close = kobil_close, 99 .write = kobil_write, 100 .write_room = kobil_write_room, 101 .read_int_callback = kobil_read_int_callback, 102 .write_int_callback = kobil_write_int_callback, 103 }; 104 105 static struct usb_serial_driver * const serial_drivers[] = { 106 &kobil_device, NULL 107 }; 108 109 struct kobil_private { 110 unsigned char buf[KOBIL_BUF_LENGTH]; /* buffer for the APDU to send */ 111 int filled; /* index of the last char in buf */ 112 int cur_pos; /* index of the next char to send in buf */ 113 __u16 device_type; 114 }; 115 116 117 static int kobil_port_probe(struct usb_serial_port *port) 118 { 119 struct usb_serial *serial = port->serial; 120 struct kobil_private *priv; 121 122 priv = kmalloc(sizeof(struct kobil_private), GFP_KERNEL); 123 if (!priv) 124 return -ENOMEM; 125 126 priv->filled = 0; 127 priv->cur_pos = 0; 128 priv->device_type = le16_to_cpu(serial->dev->descriptor.idProduct); 129 130 switch (priv->device_type) { 131 case KOBIL_ADAPTER_B_PRODUCT_ID: 132 dev_dbg(&serial->dev->dev, "KOBIL B1 PRO / KAAN PRO detected\n"); 133 break; 134 case KOBIL_ADAPTER_K_PRODUCT_ID: 135 dev_dbg(&serial->dev->dev, "KOBIL KAAN Standard Plus / SecOVID Reader Plus detected\n"); 136 break; 137 case KOBIL_USBTWIN_PRODUCT_ID: 138 dev_dbg(&serial->dev->dev, "KOBIL USBTWIN detected\n"); 139 break; 140 case KOBIL_KAAN_SIM_PRODUCT_ID: 141 dev_dbg(&serial->dev->dev, "KOBIL KAAN SIM detected\n"); 142 break; 143 } 144 usb_set_serial_port_data(port, priv); 145 146 return 0; 147 } 148 149 150 static int kobil_port_remove(struct usb_serial_port *port) 151 { 152 struct kobil_private *priv; 153 154 priv = usb_get_serial_port_data(port); 155 kfree(priv); 156 157 return 0; 158 } 159 160 static void kobil_init_termios(struct tty_struct *tty) 161 { 162 /* Default to echo off and other sane device settings */ 163 tty->termios.c_lflag = 0; 164 tty->termios.c_iflag &= ~(ISIG | ICANON | ECHO | IEXTEN | XCASE); 165 tty->termios.c_iflag |= IGNBRK | IGNPAR | IXOFF; 166 /* do NOT translate CR to CR-NL (0x0A -> 0x0A 0x0D) */ 167 tty->termios.c_oflag &= ~ONLCR; 168 } 169 170 static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port) 171 { 172 struct device *dev = &port->dev; 173 int result = 0; 174 struct kobil_private *priv; 175 unsigned char *transfer_buffer; 176 int transfer_buffer_length = 8; 177 178 priv = usb_get_serial_port_data(port); 179 180 /* allocate memory for transfer buffer */ 181 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL); 182 if (!transfer_buffer) 183 return -ENOMEM; 184 185 /* get hardware version */ 186 result = usb_control_msg(port->serial->dev, 187 usb_rcvctrlpipe(port->serial->dev, 0), 188 SUSBCRequest_GetMisc, 189 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN, 190 SUSBCR_MSC_GetHWVersion, 191 0, 192 transfer_buffer, 193 transfer_buffer_length, 194 KOBIL_TIMEOUT 195 ); 196 dev_dbg(dev, "%s - Send get_HW_version URB returns: %i\n", __func__, result); 197 dev_dbg(dev, "Hardware version: %i.%i.%i\n", transfer_buffer[0], 198 transfer_buffer[1], transfer_buffer[2]); 199 200 /* get firmware version */ 201 result = usb_control_msg(port->serial->dev, 202 usb_rcvctrlpipe(port->serial->dev, 0), 203 SUSBCRequest_GetMisc, 204 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN, 205 SUSBCR_MSC_GetFWVersion, 206 0, 207 transfer_buffer, 208 transfer_buffer_length, 209 KOBIL_TIMEOUT 210 ); 211 dev_dbg(dev, "%s - Send get_FW_version URB returns: %i\n", __func__, result); 212 dev_dbg(dev, "Firmware version: %i.%i.%i\n", transfer_buffer[0], 213 transfer_buffer[1], transfer_buffer[2]); 214 215 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID || 216 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) { 217 /* Setting Baudrate, Parity and Stopbits */ 218 result = usb_control_msg(port->serial->dev, 219 usb_sndctrlpipe(port->serial->dev, 0), 220 SUSBCRequest_SetBaudRateParityAndStopBits, 221 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT, 222 SUSBCR_SBR_9600 | SUSBCR_SPASB_EvenParity | 223 SUSBCR_SPASB_1StopBit, 224 0, 225 NULL, 226 0, 227 KOBIL_TIMEOUT 228 ); 229 dev_dbg(dev, "%s - Send set_baudrate URB returns: %i\n", __func__, result); 230 231 /* reset all queues */ 232 result = usb_control_msg(port->serial->dev, 233 usb_sndctrlpipe(port->serial->dev, 0), 234 SUSBCRequest_Misc, 235 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT, 236 SUSBCR_MSC_ResetAllQueues, 237 0, 238 NULL, 239 0, 240 KOBIL_TIMEOUT 241 ); 242 dev_dbg(dev, "%s - Send reset_all_queues URB returns: %i\n", __func__, result); 243 } 244 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID || 245 priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID || 246 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) { 247 /* start reading (Adapter B 'cause PNP string) */ 248 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL); 249 dev_dbg(dev, "%s - Send read URB returns: %i\n", __func__, result); 250 } 251 252 kfree(transfer_buffer); 253 return 0; 254 } 255 256 257 static void kobil_close(struct usb_serial_port *port) 258 { 259 /* FIXME: Add rts/dtr methods */ 260 usb_kill_urb(port->interrupt_out_urb); 261 usb_kill_urb(port->interrupt_in_urb); 262 } 263 264 265 static void kobil_read_int_callback(struct urb *urb) 266 { 267 int result; 268 struct usb_serial_port *port = urb->context; 269 unsigned char *data = urb->transfer_buffer; 270 int status = urb->status; 271 272 if (status) { 273 dev_dbg(&port->dev, "%s - Read int status not zero: %d\n", __func__, status); 274 return; 275 } 276 277 if (urb->actual_length) { 278 usb_serial_debug_data(&port->dev, __func__, urb->actual_length, 279 data); 280 tty_insert_flip_string(&port->port, data, urb->actual_length); 281 tty_flip_buffer_push(&port->port); 282 } 283 284 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC); 285 dev_dbg(&port->dev, "%s - Send read URB returns: %i\n", __func__, result); 286 } 287 288 289 static void kobil_write_int_callback(struct urb *urb) 290 { 291 } 292 293 294 static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port, 295 const unsigned char *buf, int count) 296 { 297 int length = 0; 298 int result = 0; 299 int todo = 0; 300 struct kobil_private *priv; 301 302 if (count == 0) { 303 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__); 304 return 0; 305 } 306 307 priv = usb_get_serial_port_data(port); 308 309 if (count > (KOBIL_BUF_LENGTH - priv->filled)) { 310 dev_dbg(&port->dev, "%s - Error: write request bigger than buffer size\n", __func__); 311 return -ENOMEM; 312 } 313 314 /* Copy data to buffer */ 315 memcpy(priv->buf + priv->filled, buf, count); 316 usb_serial_debug_data(&port->dev, __func__, count, priv->buf + priv->filled); 317 priv->filled = priv->filled + count; 318 319 /* only send complete block. TWIN, KAAN SIM and adapter K 320 use the same protocol. */ 321 if (((priv->device_type != KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 2) && (priv->filled >= (priv->buf[1] + 3))) || 322 ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 3) && (priv->filled >= (priv->buf[2] + 4)))) { 323 /* stop reading (except TWIN and KAAN SIM) */ 324 if ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) 325 || (priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID)) 326 usb_kill_urb(port->interrupt_in_urb); 327 328 todo = priv->filled - priv->cur_pos; 329 330 while (todo > 0) { 331 /* max 8 byte in one urb (endpoint size) */ 332 length = min(todo, port->interrupt_out_size); 333 /* copy data to transfer buffer */ 334 memcpy(port->interrupt_out_buffer, 335 priv->buf + priv->cur_pos, length); 336 port->interrupt_out_urb->transfer_buffer_length = length; 337 338 priv->cur_pos = priv->cur_pos + length; 339 result = usb_submit_urb(port->interrupt_out_urb, 340 GFP_ATOMIC); 341 dev_dbg(&port->dev, "%s - Send write URB returns: %i\n", __func__, result); 342 todo = priv->filled - priv->cur_pos; 343 344 if (todo > 0) 345 msleep(24); 346 } 347 348 priv->filled = 0; 349 priv->cur_pos = 0; 350 351 /* start reading (except TWIN and KAAN SIM) */ 352 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID || 353 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) { 354 result = usb_submit_urb(port->interrupt_in_urb, 355 GFP_ATOMIC); 356 dev_dbg(&port->dev, "%s - Send read URB returns: %i\n", __func__, result); 357 } 358 } 359 return count; 360 } 361 362 363 static int kobil_write_room(struct tty_struct *tty) 364 { 365 /* FIXME */ 366 return 8; 367 } 368 369 370 static int kobil_tiocmget(struct tty_struct *tty) 371 { 372 struct usb_serial_port *port = tty->driver_data; 373 struct kobil_private *priv; 374 int result; 375 unsigned char *transfer_buffer; 376 int transfer_buffer_length = 8; 377 378 priv = usb_get_serial_port_data(port); 379 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID 380 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) { 381 /* This device doesn't support ioctl calls */ 382 return -EINVAL; 383 } 384 385 /* allocate memory for transfer buffer */ 386 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL); 387 if (!transfer_buffer) 388 return -ENOMEM; 389 390 result = usb_control_msg(port->serial->dev, 391 usb_rcvctrlpipe(port->serial->dev, 0), 392 SUSBCRequest_GetStatusLineState, 393 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN, 394 0, 395 0, 396 transfer_buffer, 397 transfer_buffer_length, 398 KOBIL_TIMEOUT); 399 400 dev_dbg(&port->dev, "%s - Send get_status_line_state URB returns: %i. Statusline: %02x\n", 401 __func__, result, transfer_buffer[0]); 402 403 result = 0; 404 if ((transfer_buffer[0] & SUSBCR_GSL_DSR) != 0) 405 result = TIOCM_DSR; 406 kfree(transfer_buffer); 407 return result; 408 } 409 410 static int kobil_tiocmset(struct tty_struct *tty, 411 unsigned int set, unsigned int clear) 412 { 413 struct usb_serial_port *port = tty->driver_data; 414 struct device *dev = &port->dev; 415 struct kobil_private *priv; 416 int result; 417 int dtr = 0; 418 int rts = 0; 419 420 /* FIXME: locking ? */ 421 priv = usb_get_serial_port_data(port); 422 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID 423 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) { 424 /* This device doesn't support ioctl calls */ 425 return -EINVAL; 426 } 427 428 if (set & TIOCM_RTS) 429 rts = 1; 430 if (set & TIOCM_DTR) 431 dtr = 1; 432 if (clear & TIOCM_RTS) 433 rts = 0; 434 if (clear & TIOCM_DTR) 435 dtr = 0; 436 437 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) { 438 if (dtr != 0) 439 dev_dbg(dev, "%s - Setting DTR\n", __func__); 440 else 441 dev_dbg(dev, "%s - Clearing DTR\n", __func__); 442 result = usb_control_msg(port->serial->dev, 443 usb_sndctrlpipe(port->serial->dev, 0), 444 SUSBCRequest_SetStatusLinesOrQueues, 445 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT, 446 ((dtr != 0) ? SUSBCR_SSL_SETDTR : SUSBCR_SSL_CLRDTR), 447 0, 448 NULL, 449 0, 450 KOBIL_TIMEOUT); 451 } else { 452 if (rts != 0) 453 dev_dbg(dev, "%s - Setting RTS\n", __func__); 454 else 455 dev_dbg(dev, "%s - Clearing RTS\n", __func__); 456 result = usb_control_msg(port->serial->dev, 457 usb_sndctrlpipe(port->serial->dev, 0), 458 SUSBCRequest_SetStatusLinesOrQueues, 459 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT, 460 ((rts != 0) ? SUSBCR_SSL_SETRTS : SUSBCR_SSL_CLRRTS), 461 0, 462 NULL, 463 0, 464 KOBIL_TIMEOUT); 465 } 466 dev_dbg(dev, "%s - Send set_status_line URB returns: %i\n", __func__, result); 467 return (result < 0) ? result : 0; 468 } 469 470 static void kobil_set_termios(struct tty_struct *tty, 471 struct usb_serial_port *port, struct ktermios *old) 472 { 473 struct kobil_private *priv; 474 int result; 475 unsigned short urb_val = 0; 476 int c_cflag = tty->termios.c_cflag; 477 speed_t speed; 478 479 priv = usb_get_serial_port_data(port); 480 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID || 481 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) { 482 /* This device doesn't support ioctl calls */ 483 tty_termios_copy_hw(&tty->termios, old); 484 return; 485 } 486 487 speed = tty_get_baud_rate(tty); 488 switch (speed) { 489 case 1200: 490 urb_val = SUSBCR_SBR_1200; 491 break; 492 default: 493 speed = 9600; 494 case 9600: 495 urb_val = SUSBCR_SBR_9600; 496 break; 497 } 498 urb_val |= (c_cflag & CSTOPB) ? SUSBCR_SPASB_2StopBits : 499 SUSBCR_SPASB_1StopBit; 500 if (c_cflag & PARENB) { 501 if (c_cflag & PARODD) 502 urb_val |= SUSBCR_SPASB_OddParity; 503 else 504 urb_val |= SUSBCR_SPASB_EvenParity; 505 } else 506 urb_val |= SUSBCR_SPASB_NoParity; 507 tty->termios.c_cflag &= ~CMSPAR; 508 tty_encode_baud_rate(tty, speed, speed); 509 510 result = usb_control_msg(port->serial->dev, 511 usb_sndctrlpipe(port->serial->dev, 0), 512 SUSBCRequest_SetBaudRateParityAndStopBits, 513 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT, 514 urb_val, 515 0, 516 NULL, 517 0, 518 KOBIL_TIMEOUT 519 ); 520 } 521 522 static int kobil_ioctl(struct tty_struct *tty, 523 unsigned int cmd, unsigned long arg) 524 { 525 struct usb_serial_port *port = tty->driver_data; 526 struct kobil_private *priv = usb_get_serial_port_data(port); 527 int result; 528 529 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID || 530 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) 531 /* This device doesn't support ioctl calls */ 532 return -ENOIOCTLCMD; 533 534 switch (cmd) { 535 case TCFLSH: 536 result = usb_control_msg(port->serial->dev, 537 usb_sndctrlpipe(port->serial->dev, 0), 538 SUSBCRequest_Misc, 539 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT, 540 SUSBCR_MSC_ResetAllQueues, 541 0, 542 NULL, 543 0, 544 KOBIL_TIMEOUT 545 ); 546 547 dev_dbg(&port->dev, 548 "%s - Send reset_all_queues (FLUSH) URB returns: %i\n", 549 __func__, result); 550 return (result < 0) ? -EIO: 0; 551 default: 552 return -ENOIOCTLCMD; 553 } 554 } 555 556 module_usb_serial_driver(serial_drivers, id_table); 557 558 MODULE_AUTHOR(DRIVER_AUTHOR); 559 MODULE_DESCRIPTION(DRIVER_DESC); 560 MODULE_LICENSE("GPL"); 561