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)
25 * Fix bug with P'n'P readers
28 * Add support for KAAN SIM
38 #include <linux/kernel.h>
39 #include <linux/errno.h>
40 #include <linux/init.h>
41 #include <linux/slab.h>
42 #include <linux/tty.h>
43 #include <linux/tty_driver.h>
44 #include <linux/tty_flip.h>
45 #include <linux/module.h>
46 #include <linux/spinlock.h>
47 #include <linux/uaccess.h>
48 #include <linux/usb.h>
49 #include <linux/usb/serial.h>
50 #include <linux/ioctl.h>
51 #include "kobil_sct.h"
55 /* Version Information */
56 #define DRIVER_VERSION "21/05/2004"
57 #define DRIVER_AUTHOR "KOBIL Systems GmbH - http://www.kobil.com"
58 #define DRIVER_DESC "KOBIL USB Smart Card Terminal Driver (experimental)"
60 #define KOBIL_VENDOR_ID 0x0D46
61 #define KOBIL_ADAPTER_B_PRODUCT_ID 0x2011
62 #define KOBIL_ADAPTER_K_PRODUCT_ID 0x2012
63 #define KOBIL_USBTWIN_PRODUCT_ID 0x0078
64 #define KOBIL_KAAN_SIM_PRODUCT_ID 0x0081
66 #define KOBIL_TIMEOUT 500
67 #define KOBIL_BUF_LENGTH 300
70 /* Function prototypes */
71 static int kobil_startup(struct usb_serial *serial);
72 static void kobil_release(struct usb_serial *serial);
73 static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port);
74 static void kobil_close(struct usb_serial_port *port);
75 static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
76 const unsigned char *buf, int count);
77 static int kobil_write_room(struct tty_struct *tty);
78 static int kobil_ioctl(struct tty_struct *tty,
79 unsigned int cmd, unsigned long arg);
80 static int kobil_tiocmget(struct tty_struct *tty);
81 static int kobil_tiocmset(struct tty_struct *tty,
82 unsigned int set, unsigned int clear);
83 static void kobil_read_int_callback(struct urb *urb);
84 static void kobil_write_callback(struct urb *purb);
85 static void kobil_set_termios(struct tty_struct *tty,
86 struct usb_serial_port *port, struct ktermios *old);
87 static void kobil_init_termios(struct tty_struct *tty);
89 static const struct usb_device_id id_table[] = {
90 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_ADAPTER_B_PRODUCT_ID) },
91 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_ADAPTER_K_PRODUCT_ID) },
92 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_USBTWIN_PRODUCT_ID) },
93 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_KAAN_SIM_PRODUCT_ID) },
94 { } /* Terminating entry */
98 MODULE_DEVICE_TABLE(usb, id_table);
100 static struct usb_driver kobil_driver = {
102 .probe = usb_serial_probe,
103 .disconnect = usb_serial_disconnect,
104 .id_table = id_table,
109 static struct usb_serial_driver kobil_device = {
111 .owner = THIS_MODULE,
114 .description = "KOBIL USB smart card terminal",
115 .usb_driver = &kobil_driver,
116 .id_table = id_table,
118 .attach = kobil_startup,
119 .release = kobil_release,
120 .ioctl = kobil_ioctl,
121 .set_termios = kobil_set_termios,
122 .init_termios = kobil_init_termios,
123 .tiocmget = kobil_tiocmget,
124 .tiocmset = kobil_tiocmset,
126 .close = kobil_close,
127 .write = kobil_write,
128 .write_room = kobil_write_room,
129 .read_int_callback = kobil_read_int_callback,
133 struct kobil_private {
134 int write_int_endpoint_address;
135 int read_int_endpoint_address;
136 unsigned char buf[KOBIL_BUF_LENGTH]; /* buffer for the APDU to send */
137 int filled; /* index of the last char in buf */
138 int cur_pos; /* index of the next char to send in buf */
143 static int kobil_startup(struct usb_serial *serial)
146 struct kobil_private *priv;
147 struct usb_device *pdev;
148 struct usb_host_config *actconfig;
149 struct usb_interface *interface;
150 struct usb_host_interface *altsetting;
151 struct usb_host_endpoint *endpoint;
153 priv = kmalloc(sizeof(struct kobil_private), GFP_KERNEL);
159 priv->device_type = le16_to_cpu(serial->dev->descriptor.idProduct);
161 switch (priv->device_type) {
162 case KOBIL_ADAPTER_B_PRODUCT_ID:
163 printk(KERN_DEBUG "KOBIL B1 PRO / KAAN PRO detected\n");
165 case KOBIL_ADAPTER_K_PRODUCT_ID:
167 "KOBIL KAAN Standard Plus / SecOVID Reader Plus detected\n");
169 case KOBIL_USBTWIN_PRODUCT_ID:
170 printk(KERN_DEBUG "KOBIL USBTWIN detected\n");
172 case KOBIL_KAAN_SIM_PRODUCT_ID:
173 printk(KERN_DEBUG "KOBIL KAAN SIM detected\n");
176 usb_set_serial_port_data(serial->port[0], priv);
178 /* search for the necessary endpoints */
180 actconfig = pdev->actconfig;
181 interface = actconfig->interface[0];
182 altsetting = interface->cur_altsetting;
183 endpoint = altsetting->endpoint;
185 for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
186 endpoint = &altsetting->endpoint[i];
187 if (usb_endpoint_is_int_out(&endpoint->desc)) {
188 dbg("%s Found interrupt out endpoint. Address: %d",
189 __func__, endpoint->desc.bEndpointAddress);
190 priv->write_int_endpoint_address =
191 endpoint->desc.bEndpointAddress;
193 if (usb_endpoint_is_int_in(&endpoint->desc)) {
194 dbg("%s Found interrupt in endpoint. Address: %d",
195 __func__, endpoint->desc.bEndpointAddress);
196 priv->read_int_endpoint_address =
197 endpoint->desc.bEndpointAddress;
204 static void kobil_release(struct usb_serial *serial)
207 dbg("%s - port %d", __func__, serial->port[0]->number);
209 for (i = 0; i < serial->num_ports; ++i)
210 kfree(usb_get_serial_port_data(serial->port[i]));
213 static void kobil_init_termios(struct tty_struct *tty)
215 /* Default to echo off and other sane device settings */
216 tty->termios->c_lflag = 0;
217 tty->termios->c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN | XCASE);
218 tty->termios->c_iflag = IGNBRK | IGNPAR | IXOFF;
219 /* do NOT translate CR to CR-NL (0x0A -> 0x0A 0x0D) */
220 tty->termios->c_oflag &= ~ONLCR;
223 static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port)
226 struct kobil_private *priv;
227 unsigned char *transfer_buffer;
228 int transfer_buffer_length = 8;
229 int write_urb_transfer_buffer_length = 8;
231 dbg("%s - port %d", __func__, port->number);
232 priv = usb_get_serial_port_data(port);
234 /* someone sets the dev to 0 if the close method has been called */
235 port->interrupt_in_urb->dev = port->serial->dev;
237 /* allocate memory for transfer buffer */
238 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
239 if (!transfer_buffer)
242 /* allocate write_urb */
243 if (!port->write_urb) {
244 dbg("%s - port %d Allocating port->write_urb",
245 __func__, port->number);
246 port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
247 if (!port->write_urb) {
248 dbg("%s - port %d usb_alloc_urb failed",
249 __func__, port->number);
250 kfree(transfer_buffer);
255 /* allocate memory for write_urb transfer buffer */
256 port->write_urb->transfer_buffer =
257 kmalloc(write_urb_transfer_buffer_length, GFP_KERNEL);
258 if (!port->write_urb->transfer_buffer) {
259 kfree(transfer_buffer);
260 usb_free_urb(port->write_urb);
261 port->write_urb = NULL;
265 /* get hardware version */
266 result = usb_control_msg(port->serial->dev,
267 usb_rcvctrlpipe(port->serial->dev, 0),
268 SUSBCRequest_GetMisc,
269 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
270 SUSBCR_MSC_GetHWVersion,
273 transfer_buffer_length,
276 dbg("%s - port %d Send get_HW_version URB returns: %i",
277 __func__, port->number, result);
278 dbg("Harware version: %i.%i.%i",
279 transfer_buffer[0], transfer_buffer[1], transfer_buffer[2]);
281 /* get firmware version */
282 result = usb_control_msg(port->serial->dev,
283 usb_rcvctrlpipe(port->serial->dev, 0),
284 SUSBCRequest_GetMisc,
285 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
286 SUSBCR_MSC_GetFWVersion,
289 transfer_buffer_length,
292 dbg("%s - port %d Send get_FW_version URB returns: %i",
293 __func__, port->number, result);
294 dbg("Firmware version: %i.%i.%i",
295 transfer_buffer[0], transfer_buffer[1], transfer_buffer[2]);
297 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
298 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
299 /* Setting Baudrate, Parity and Stopbits */
300 result = usb_control_msg(port->serial->dev,
301 usb_rcvctrlpipe(port->serial->dev, 0),
302 SUSBCRequest_SetBaudRateParityAndStopBits,
303 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
304 SUSBCR_SBR_9600 | SUSBCR_SPASB_EvenParity |
305 SUSBCR_SPASB_1StopBit,
311 dbg("%s - port %d Send set_baudrate URB returns: %i",
312 __func__, port->number, result);
314 /* reset all queues */
315 result = usb_control_msg(port->serial->dev,
316 usb_rcvctrlpipe(port->serial->dev, 0),
318 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
319 SUSBCR_MSC_ResetAllQueues,
325 dbg("%s - port %d Send reset_all_queues URB returns: %i",
326 __func__, port->number, result);
328 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
329 priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
330 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
331 /* start reading (Adapter B 'cause PNP string) */
332 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
333 dbg("%s - port %d Send read URB returns: %i",
334 __func__, port->number, result);
337 kfree(transfer_buffer);
342 static void kobil_close(struct usb_serial_port *port)
344 dbg("%s - port %d", __func__, port->number);
346 /* FIXME: Add rts/dtr methods */
347 if (port->write_urb) {
348 usb_poison_urb(port->write_urb);
349 kfree(port->write_urb->transfer_buffer);
350 usb_free_urb(port->write_urb);
351 port->write_urb = NULL;
353 usb_kill_urb(port->interrupt_in_urb);
357 static void kobil_read_int_callback(struct urb *urb)
360 struct usb_serial_port *port = urb->context;
361 struct tty_struct *tty;
362 unsigned char *data = urb->transfer_buffer;
363 int status = urb->status;
364 /* char *dbg_data; */
366 dbg("%s - port %d", __func__, port->number);
369 dbg("%s - port %d Read int status not zero: %d",
370 __func__, port->number, status);
374 tty = tty_port_tty_get(&port->port);
375 if (urb->actual_length) {
379 dbg_data = kzalloc((3 * purb->actual_length + 10)
380 * sizeof(char), GFP_KERNEL);
384 for (i = 0; i < purb->actual_length; i++) {
385 sprintf(dbg_data +3*i, "%02X ", data[i]);
387 dbg(" <-- %s", dbg_data);
392 tty_insert_flip_string(tty, data, urb->actual_length);
393 tty_flip_buffer_push(tty);
396 /* someone sets the dev to 0 if the close method has been called */
397 port->interrupt_in_urb->dev = port->serial->dev;
399 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
400 dbg("%s - port %d Send read URB returns: %i",
401 __func__, port->number, result);
405 static void kobil_write_callback(struct urb *purb)
410 static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
411 const unsigned char *buf, int count)
416 struct kobil_private *priv;
419 dbg("%s - port %d write request of 0 bytes",
420 __func__, port->number);
424 priv = usb_get_serial_port_data(port);
426 if (count > (KOBIL_BUF_LENGTH - priv->filled)) {
427 dbg("%s - port %d Error: write request bigger than buffer size", __func__, port->number);
431 /* Copy data to buffer */
432 memcpy(priv->buf + priv->filled, buf, count);
433 usb_serial_debug_data(debug, &port->dev, __func__, count,
434 priv->buf + priv->filled);
435 priv->filled = priv->filled + count;
437 /* only send complete block. TWIN, KAAN SIM and adapter K
438 use the same protocol. */
439 if (((priv->device_type != KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 2) && (priv->filled >= (priv->buf[1] + 3))) ||
440 ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 3) && (priv->filled >= (priv->buf[2] + 4)))) {
441 /* stop reading (except TWIN and KAAN SIM) */
442 if ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID)
443 || (priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID))
444 usb_kill_urb(port->interrupt_in_urb);
446 todo = priv->filled - priv->cur_pos;
449 /* max 8 byte in one urb (endpoint size) */
450 length = (todo < 8) ? todo : 8;
451 /* copy data to transfer buffer */
452 memcpy(port->write_urb->transfer_buffer,
453 priv->buf + priv->cur_pos, length);
454 usb_fill_int_urb(port->write_urb,
456 usb_sndintpipe(port->serial->dev,
457 priv->write_int_endpoint_address),
458 port->write_urb->transfer_buffer,
460 kobil_write_callback,
465 priv->cur_pos = priv->cur_pos + length;
466 result = usb_submit_urb(port->write_urb, GFP_NOIO);
467 dbg("%s - port %d Send write URB returns: %i",
468 __func__, port->number, result);
469 todo = priv->filled - priv->cur_pos;
478 /* someone sets the dev to 0 if the close method
480 port->interrupt_in_urb->dev = port->serial->dev;
482 /* start reading (except TWIN and KAAN SIM) */
483 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
484 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
485 /* someone sets the dev to 0 if the close method has
487 port->interrupt_in_urb->dev = port->serial->dev;
489 result = usb_submit_urb(port->interrupt_in_urb,
491 dbg("%s - port %d Send read URB returns: %i",
492 __func__, port->number, result);
499 static int kobil_write_room(struct tty_struct *tty)
501 /* dbg("%s - port %d", __func__, port->number); */
507 static int kobil_tiocmget(struct tty_struct *tty)
509 struct usb_serial_port *port = tty->driver_data;
510 struct kobil_private *priv;
512 unsigned char *transfer_buffer;
513 int transfer_buffer_length = 8;
515 priv = usb_get_serial_port_data(port);
516 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
517 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
518 /* This device doesn't support ioctl calls */
522 /* allocate memory for transfer buffer */
523 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
524 if (!transfer_buffer)
527 result = usb_control_msg(port->serial->dev,
528 usb_rcvctrlpipe(port->serial->dev, 0),
529 SUSBCRequest_GetStatusLineState,
530 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
534 transfer_buffer_length,
537 dbg("%s - port %d Send get_status_line_state URB returns: %i. Statusline: %02x",
538 __func__, port->number, result, transfer_buffer[0]);
541 if ((transfer_buffer[0] & SUSBCR_GSL_DSR) != 0)
543 kfree(transfer_buffer);
547 static int kobil_tiocmset(struct tty_struct *tty,
548 unsigned int set, unsigned int clear)
550 struct usb_serial_port *port = tty->driver_data;
551 struct kobil_private *priv;
555 unsigned char *transfer_buffer;
556 int transfer_buffer_length = 8;
558 /* FIXME: locking ? */
559 priv = usb_get_serial_port_data(port);
560 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
561 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
562 /* This device doesn't support ioctl calls */
566 /* allocate memory for transfer buffer */
567 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
568 if (!transfer_buffer)
575 if (clear & TIOCM_RTS)
577 if (clear & TIOCM_DTR)
580 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) {
582 dbg("%s - port %d Setting DTR",
583 __func__, port->number);
585 dbg("%s - port %d Clearing DTR",
586 __func__, port->number);
587 result = usb_control_msg(port->serial->dev,
588 usb_rcvctrlpipe(port->serial->dev, 0),
589 SUSBCRequest_SetStatusLinesOrQueues,
590 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
591 ((dtr != 0) ? SUSBCR_SSL_SETDTR : SUSBCR_SSL_CLRDTR),
598 dbg("%s - port %d Setting RTS",
599 __func__, port->number);
601 dbg("%s - port %d Clearing RTS",
602 __func__, port->number);
603 result = usb_control_msg(port->serial->dev,
604 usb_rcvctrlpipe(port->serial->dev, 0),
605 SUSBCRequest_SetStatusLinesOrQueues,
606 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
607 ((rts != 0) ? SUSBCR_SSL_SETRTS : SUSBCR_SSL_CLRRTS),
613 dbg("%s - port %d Send set_status_line URB returns: %i",
614 __func__, port->number, result);
615 kfree(transfer_buffer);
616 return (result < 0) ? result : 0;
619 static void kobil_set_termios(struct tty_struct *tty,
620 struct usb_serial_port *port, struct ktermios *old)
622 struct kobil_private *priv;
624 unsigned short urb_val = 0;
625 int c_cflag = tty->termios->c_cflag;
628 priv = usb_get_serial_port_data(port);
629 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
630 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
631 /* This device doesn't support ioctl calls */
632 *tty->termios = *old;
636 speed = tty_get_baud_rate(tty);
639 urb_val = SUSBCR_SBR_1200;
644 urb_val = SUSBCR_SBR_9600;
647 urb_val |= (c_cflag & CSTOPB) ? SUSBCR_SPASB_2StopBits :
648 SUSBCR_SPASB_1StopBit;
649 if (c_cflag & PARENB) {
650 if (c_cflag & PARODD)
651 urb_val |= SUSBCR_SPASB_OddParity;
653 urb_val |= SUSBCR_SPASB_EvenParity;
655 urb_val |= SUSBCR_SPASB_NoParity;
656 tty->termios->c_cflag &= ~CMSPAR;
657 tty_encode_baud_rate(tty, speed, speed);
659 result = usb_control_msg(port->serial->dev,
660 usb_rcvctrlpipe(port->serial->dev, 0),
661 SUSBCRequest_SetBaudRateParityAndStopBits,
662 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
671 static int kobil_ioctl(struct tty_struct *tty,
672 unsigned int cmd, unsigned long arg)
674 struct usb_serial_port *port = tty->driver_data;
675 struct kobil_private *priv = usb_get_serial_port_data(port);
676 unsigned char *transfer_buffer;
677 int transfer_buffer_length = 8;
680 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
681 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID)
682 /* This device doesn't support ioctl calls */
687 transfer_buffer = kmalloc(transfer_buffer_length, GFP_KERNEL);
688 if (!transfer_buffer)
691 result = usb_control_msg(port->serial->dev,
692 usb_rcvctrlpipe(port->serial->dev, 0),
694 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
695 SUSBCR_MSC_ResetAllQueues,
697 NULL, /* transfer_buffer, */
702 dbg("%s - port %d Send reset_all_queues (FLUSH) URB returns: %i", __func__, port->number, result);
703 kfree(transfer_buffer);
704 return (result < 0) ? -EIO: 0;
710 static int __init kobil_init(void)
713 retval = usb_serial_register(&kobil_device);
715 goto failed_usb_serial_register;
716 retval = usb_register(&kobil_driver);
718 goto failed_usb_register;
720 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
725 usb_serial_deregister(&kobil_device);
726 failed_usb_serial_register:
731 static void __exit kobil_exit(void)
733 usb_deregister(&kobil_driver);
734 usb_serial_deregister(&kobil_device);
737 module_init(kobil_init);
738 module_exit(kobil_exit);
740 MODULE_AUTHOR(DRIVER_AUTHOR);
741 MODULE_DESCRIPTION(DRIVER_DESC);
742 MODULE_LICENSE("GPL");
744 module_param(debug, bool, S_IRUGO | S_IWUSR);
745 MODULE_PARM_DESC(debug, "Debug enabled or not");