2 * KOBIL USB Smart Card Terminal Driver
4 * Copyright (C) 2002 KOBIL Systems GmbH
5 * Author: Thomas Wahrenbruch
7 * Contact: linuxusb@kobil.de
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.
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.
18 * Thanks to Greg Kroah-Hartman (greg@kroah.com) for his help and
21 * Supported readers: USB TWIN, KAAN Standard Plus and SecOVID Reader Plus
22 * (Adapter K), B1 Professional and KAAN Professional (Adapter B)
26 #include <linux/kernel.h>
27 #include <linux/errno.h>
28 #include <linux/init.h>
29 #include <linux/slab.h>
30 #include <linux/tty.h>
31 #include <linux/tty_driver.h>
32 #include <linux/tty_flip.h>
33 #include <linux/module.h>
34 #include <linux/spinlock.h>
35 #include <linux/uaccess.h>
36 #include <linux/usb.h>
37 #include <linux/usb/serial.h>
38 #include <linux/ioctl.h>
39 #include "kobil_sct.h"
43 /* Version Information */
44 #define DRIVER_VERSION "21/05/2004"
45 #define DRIVER_AUTHOR "KOBIL Systems GmbH - http://www.kobil.com"
46 #define DRIVER_DESC "KOBIL USB Smart Card Terminal Driver (experimental)"
48 #define KOBIL_VENDOR_ID 0x0D46
49 #define KOBIL_ADAPTER_B_PRODUCT_ID 0x2011
50 #define KOBIL_ADAPTER_K_PRODUCT_ID 0x2012
51 #define KOBIL_USBTWIN_PRODUCT_ID 0x0078
52 #define KOBIL_KAAN_SIM_PRODUCT_ID 0x0081
54 #define KOBIL_TIMEOUT 500
55 #define KOBIL_BUF_LENGTH 300
58 /* Function prototypes */
59 static int kobil_startup(struct usb_serial *serial);
60 static void kobil_release(struct usb_serial *serial);
61 static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port);
62 static void kobil_close(struct usb_serial_port *port);
63 static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
64 const unsigned char *buf, int count);
65 static int kobil_write_room(struct tty_struct *tty);
66 static int kobil_ioctl(struct tty_struct *tty,
67 unsigned int cmd, unsigned long arg);
68 static int kobil_tiocmget(struct tty_struct *tty);
69 static int kobil_tiocmset(struct tty_struct *tty,
70 unsigned int set, unsigned int clear);
71 static void kobil_read_int_callback(struct urb *urb);
72 static void kobil_write_callback(struct urb *purb);
73 static void kobil_set_termios(struct tty_struct *tty,
74 struct usb_serial_port *port, struct ktermios *old);
75 static void kobil_init_termios(struct tty_struct *tty);
77 static const struct usb_device_id id_table[] = {
78 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_ADAPTER_B_PRODUCT_ID) },
79 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_ADAPTER_K_PRODUCT_ID) },
80 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_USBTWIN_PRODUCT_ID) },
81 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_KAAN_SIM_PRODUCT_ID) },
82 { } /* Terminating entry */
86 MODULE_DEVICE_TABLE(usb, id_table);
88 static struct usb_driver kobil_driver = {
94 static struct usb_serial_driver kobil_device = {
99 .description = "KOBIL USB smart card terminal",
100 .id_table = id_table,
102 .attach = kobil_startup,
103 .release = kobil_release,
104 .ioctl = kobil_ioctl,
105 .set_termios = kobil_set_termios,
106 .init_termios = kobil_init_termios,
107 .tiocmget = kobil_tiocmget,
108 .tiocmset = kobil_tiocmset,
110 .close = kobil_close,
111 .write = kobil_write,
112 .write_room = kobil_write_room,
113 .read_int_callback = kobil_read_int_callback,
116 static struct usb_serial_driver * const serial_drivers[] = {
120 struct kobil_private {
121 int write_int_endpoint_address;
122 int read_int_endpoint_address;
123 unsigned char buf[KOBIL_BUF_LENGTH]; /* buffer for the APDU to send */
124 int filled; /* index of the last char in buf */
125 int cur_pos; /* index of the next char to send in buf */
130 static int kobil_startup(struct usb_serial *serial)
133 struct kobil_private *priv;
134 struct usb_device *pdev;
135 struct usb_host_config *actconfig;
136 struct usb_interface *interface;
137 struct usb_host_interface *altsetting;
138 struct usb_host_endpoint *endpoint;
140 priv = kmalloc(sizeof(struct kobil_private), GFP_KERNEL);
146 priv->device_type = le16_to_cpu(serial->dev->descriptor.idProduct);
148 switch (priv->device_type) {
149 case KOBIL_ADAPTER_B_PRODUCT_ID:
150 printk(KERN_DEBUG "KOBIL B1 PRO / KAAN PRO detected\n");
152 case KOBIL_ADAPTER_K_PRODUCT_ID:
154 "KOBIL KAAN Standard Plus / SecOVID Reader Plus detected\n");
156 case KOBIL_USBTWIN_PRODUCT_ID:
157 printk(KERN_DEBUG "KOBIL USBTWIN detected\n");
159 case KOBIL_KAAN_SIM_PRODUCT_ID:
160 printk(KERN_DEBUG "KOBIL KAAN SIM detected\n");
163 usb_set_serial_port_data(serial->port[0], priv);
165 /* search for the necessary endpoints */
167 actconfig = pdev->actconfig;
168 interface = actconfig->interface[0];
169 altsetting = interface->cur_altsetting;
170 endpoint = altsetting->endpoint;
172 for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
173 endpoint = &altsetting->endpoint[i];
174 if (usb_endpoint_is_int_out(&endpoint->desc)) {
175 dbg("%s Found interrupt out endpoint. Address: %d",
176 __func__, endpoint->desc.bEndpointAddress);
177 priv->write_int_endpoint_address =
178 endpoint->desc.bEndpointAddress;
180 if (usb_endpoint_is_int_in(&endpoint->desc)) {
181 dbg("%s Found interrupt in endpoint. Address: %d",
182 __func__, endpoint->desc.bEndpointAddress);
183 priv->read_int_endpoint_address =
184 endpoint->desc.bEndpointAddress;
191 static void kobil_release(struct usb_serial *serial)
195 for (i = 0; i < serial->num_ports; ++i)
196 kfree(usb_get_serial_port_data(serial->port[i]));
199 static void kobil_init_termios(struct tty_struct *tty)
201 /* Default to echo off and other sane device settings */
202 tty->termios->c_lflag = 0;
203 tty->termios->c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN | XCASE);
204 tty->termios->c_iflag = IGNBRK | IGNPAR | IXOFF;
205 /* do NOT translate CR to CR-NL (0x0A -> 0x0A 0x0D) */
206 tty->termios->c_oflag &= ~ONLCR;
209 static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port)
212 struct kobil_private *priv;
213 unsigned char *transfer_buffer;
214 int transfer_buffer_length = 8;
215 int write_urb_transfer_buffer_length = 8;
217 priv = usb_get_serial_port_data(port);
219 /* allocate memory for transfer buffer */
220 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
221 if (!transfer_buffer)
224 /* allocate write_urb */
225 if (!port->write_urb) {
226 dbg("%s - port %d Allocating port->write_urb",
227 __func__, port->number);
228 port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
229 if (!port->write_urb) {
230 dbg("%s - port %d usb_alloc_urb failed",
231 __func__, port->number);
232 kfree(transfer_buffer);
237 /* allocate memory for write_urb transfer buffer */
238 port->write_urb->transfer_buffer =
239 kmalloc(write_urb_transfer_buffer_length, GFP_KERNEL);
240 if (!port->write_urb->transfer_buffer) {
241 kfree(transfer_buffer);
242 usb_free_urb(port->write_urb);
243 port->write_urb = NULL;
247 /* get hardware version */
248 result = usb_control_msg(port->serial->dev,
249 usb_rcvctrlpipe(port->serial->dev, 0),
250 SUSBCRequest_GetMisc,
251 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
252 SUSBCR_MSC_GetHWVersion,
255 transfer_buffer_length,
258 dbg("%s - port %d Send get_HW_version URB returns: %i",
259 __func__, port->number, result);
260 dbg("Harware version: %i.%i.%i",
261 transfer_buffer[0], transfer_buffer[1], transfer_buffer[2]);
263 /* get firmware version */
264 result = usb_control_msg(port->serial->dev,
265 usb_rcvctrlpipe(port->serial->dev, 0),
266 SUSBCRequest_GetMisc,
267 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
268 SUSBCR_MSC_GetFWVersion,
271 transfer_buffer_length,
274 dbg("%s - port %d Send get_FW_version URB returns: %i",
275 __func__, port->number, result);
276 dbg("Firmware version: %i.%i.%i",
277 transfer_buffer[0], transfer_buffer[1], transfer_buffer[2]);
279 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
280 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
281 /* Setting Baudrate, Parity and Stopbits */
282 result = usb_control_msg(port->serial->dev,
283 usb_rcvctrlpipe(port->serial->dev, 0),
284 SUSBCRequest_SetBaudRateParityAndStopBits,
285 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
286 SUSBCR_SBR_9600 | SUSBCR_SPASB_EvenParity |
287 SUSBCR_SPASB_1StopBit,
293 dbg("%s - port %d Send set_baudrate URB returns: %i",
294 __func__, port->number, result);
296 /* reset all queues */
297 result = usb_control_msg(port->serial->dev,
298 usb_rcvctrlpipe(port->serial->dev, 0),
300 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
301 SUSBCR_MSC_ResetAllQueues,
307 dbg("%s - port %d Send reset_all_queues URB returns: %i",
308 __func__, port->number, result);
310 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
311 priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
312 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
313 /* start reading (Adapter B 'cause PNP string) */
314 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
315 dbg("%s - port %d Send read URB returns: %i",
316 __func__, port->number, result);
319 kfree(transfer_buffer);
324 static void kobil_close(struct usb_serial_port *port)
326 /* FIXME: Add rts/dtr methods */
327 if (port->write_urb) {
328 usb_poison_urb(port->write_urb);
329 kfree(port->write_urb->transfer_buffer);
330 usb_free_urb(port->write_urb);
331 port->write_urb = NULL;
333 usb_kill_urb(port->interrupt_in_urb);
337 static void kobil_read_int_callback(struct urb *urb)
340 struct usb_serial_port *port = urb->context;
341 struct tty_struct *tty;
342 unsigned char *data = urb->transfer_buffer;
343 int status = urb->status;
344 /* char *dbg_data; */
347 dbg("%s - port %d Read int status not zero: %d",
348 __func__, port->number, status);
352 tty = tty_port_tty_get(&port->port);
353 if (tty && urb->actual_length) {
357 dbg_data = kzalloc((3 * purb->actual_length + 10)
358 * sizeof(char), GFP_KERNEL);
362 for (i = 0; i < purb->actual_length; i++) {
363 sprintf(dbg_data +3*i, "%02X ", data[i]);
365 dbg(" <-- %s", dbg_data);
370 tty_insert_flip_string(tty, data, urb->actual_length);
371 tty_flip_buffer_push(tty);
375 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
376 dbg("%s - port %d Send read URB returns: %i",
377 __func__, port->number, result);
381 static void kobil_write_callback(struct urb *purb)
386 static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
387 const unsigned char *buf, int count)
392 struct kobil_private *priv;
395 dbg("%s - port %d write request of 0 bytes",
396 __func__, port->number);
400 priv = usb_get_serial_port_data(port);
402 if (count > (KOBIL_BUF_LENGTH - priv->filled)) {
403 dbg("%s - port %d Error: write request bigger than buffer size", __func__, port->number);
407 /* Copy data to buffer */
408 memcpy(priv->buf + priv->filled, buf, count);
409 usb_serial_debug_data(debug, &port->dev, __func__, count,
410 priv->buf + priv->filled);
411 priv->filled = priv->filled + count;
413 /* only send complete block. TWIN, KAAN SIM and adapter K
414 use the same protocol. */
415 if (((priv->device_type != KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 2) && (priv->filled >= (priv->buf[1] + 3))) ||
416 ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 3) && (priv->filled >= (priv->buf[2] + 4)))) {
417 /* stop reading (except TWIN and KAAN SIM) */
418 if ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID)
419 || (priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID))
420 usb_kill_urb(port->interrupt_in_urb);
422 todo = priv->filled - priv->cur_pos;
425 /* max 8 byte in one urb (endpoint size) */
426 length = (todo < 8) ? todo : 8;
427 /* copy data to transfer buffer */
428 memcpy(port->write_urb->transfer_buffer,
429 priv->buf + priv->cur_pos, length);
430 usb_fill_int_urb(port->write_urb,
432 usb_sndintpipe(port->serial->dev,
433 priv->write_int_endpoint_address),
434 port->write_urb->transfer_buffer,
436 kobil_write_callback,
441 priv->cur_pos = priv->cur_pos + length;
442 result = usb_submit_urb(port->write_urb, GFP_NOIO);
443 dbg("%s - port %d Send write URB returns: %i",
444 __func__, port->number, result);
445 todo = priv->filled - priv->cur_pos;
454 /* start reading (except TWIN and KAAN SIM) */
455 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
456 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
457 result = usb_submit_urb(port->interrupt_in_urb,
459 dbg("%s - port %d Send read URB returns: %i",
460 __func__, port->number, result);
467 static int kobil_write_room(struct tty_struct *tty)
474 static int kobil_tiocmget(struct tty_struct *tty)
476 struct usb_serial_port *port = tty->driver_data;
477 struct kobil_private *priv;
479 unsigned char *transfer_buffer;
480 int transfer_buffer_length = 8;
482 priv = usb_get_serial_port_data(port);
483 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
484 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
485 /* This device doesn't support ioctl calls */
489 /* allocate memory for transfer buffer */
490 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
491 if (!transfer_buffer)
494 result = usb_control_msg(port->serial->dev,
495 usb_rcvctrlpipe(port->serial->dev, 0),
496 SUSBCRequest_GetStatusLineState,
497 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
501 transfer_buffer_length,
504 dbg("%s - port %d Send get_status_line_state URB returns: %i. Statusline: %02x",
505 __func__, port->number, result, transfer_buffer[0]);
508 if ((transfer_buffer[0] & SUSBCR_GSL_DSR) != 0)
510 kfree(transfer_buffer);
514 static int kobil_tiocmset(struct tty_struct *tty,
515 unsigned int set, unsigned int clear)
517 struct usb_serial_port *port = tty->driver_data;
518 struct kobil_private *priv;
522 unsigned char *transfer_buffer;
523 int transfer_buffer_length = 8;
525 /* FIXME: locking ? */
526 priv = usb_get_serial_port_data(port);
527 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
528 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
529 /* This device doesn't support ioctl calls */
533 /* allocate memory for transfer buffer */
534 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
535 if (!transfer_buffer)
542 if (clear & TIOCM_RTS)
544 if (clear & TIOCM_DTR)
547 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) {
549 dbg("%s - port %d Setting DTR",
550 __func__, port->number);
552 dbg("%s - port %d Clearing DTR",
553 __func__, port->number);
554 result = usb_control_msg(port->serial->dev,
555 usb_rcvctrlpipe(port->serial->dev, 0),
556 SUSBCRequest_SetStatusLinesOrQueues,
557 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
558 ((dtr != 0) ? SUSBCR_SSL_SETDTR : SUSBCR_SSL_CLRDTR),
565 dbg("%s - port %d Setting RTS",
566 __func__, port->number);
568 dbg("%s - port %d Clearing RTS",
569 __func__, port->number);
570 result = usb_control_msg(port->serial->dev,
571 usb_rcvctrlpipe(port->serial->dev, 0),
572 SUSBCRequest_SetStatusLinesOrQueues,
573 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
574 ((rts != 0) ? SUSBCR_SSL_SETRTS : SUSBCR_SSL_CLRRTS),
580 dbg("%s - port %d Send set_status_line URB returns: %i",
581 __func__, port->number, result);
582 kfree(transfer_buffer);
583 return (result < 0) ? result : 0;
586 static void kobil_set_termios(struct tty_struct *tty,
587 struct usb_serial_port *port, struct ktermios *old)
589 struct kobil_private *priv;
591 unsigned short urb_val = 0;
592 int c_cflag = tty->termios->c_cflag;
595 priv = usb_get_serial_port_data(port);
596 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
597 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
598 /* This device doesn't support ioctl calls */
599 *tty->termios = *old;
603 speed = tty_get_baud_rate(tty);
606 urb_val = SUSBCR_SBR_1200;
611 urb_val = SUSBCR_SBR_9600;
614 urb_val |= (c_cflag & CSTOPB) ? SUSBCR_SPASB_2StopBits :
615 SUSBCR_SPASB_1StopBit;
616 if (c_cflag & PARENB) {
617 if (c_cflag & PARODD)
618 urb_val |= SUSBCR_SPASB_OddParity;
620 urb_val |= SUSBCR_SPASB_EvenParity;
622 urb_val |= SUSBCR_SPASB_NoParity;
623 tty->termios->c_cflag &= ~CMSPAR;
624 tty_encode_baud_rate(tty, speed, speed);
626 result = usb_control_msg(port->serial->dev,
627 usb_rcvctrlpipe(port->serial->dev, 0),
628 SUSBCRequest_SetBaudRateParityAndStopBits,
629 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
638 static int kobil_ioctl(struct tty_struct *tty,
639 unsigned int cmd, unsigned long arg)
641 struct usb_serial_port *port = tty->driver_data;
642 struct kobil_private *priv = usb_get_serial_port_data(port);
643 unsigned char *transfer_buffer;
644 int transfer_buffer_length = 8;
647 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
648 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID)
649 /* This device doesn't support ioctl calls */
654 transfer_buffer = kmalloc(transfer_buffer_length, GFP_KERNEL);
655 if (!transfer_buffer)
658 result = usb_control_msg(port->serial->dev,
659 usb_rcvctrlpipe(port->serial->dev, 0),
661 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
662 SUSBCR_MSC_ResetAllQueues,
664 NULL, /* transfer_buffer, */
669 dbg("%s - port %d Send reset_all_queues (FLUSH) URB returns: %i", __func__, port->number, result);
670 kfree(transfer_buffer);
671 return (result < 0) ? -EIO: 0;
677 module_usb_serial_driver(kobil_driver, serial_drivers);
679 MODULE_AUTHOR(DRIVER_AUTHOR);
680 MODULE_DESCRIPTION(DRIVER_DESC);
681 MODULE_LICENSE("GPL");
683 module_param(debug, bool, S_IRUGO | S_IWUSR);
684 MODULE_PARM_DESC(debug, "Debug enabled or not");