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 * Add support for KAAN SIM
28 * Fixed bug with Pro-readers and PNP
35 #include <linux/config.h>
36 #include <linux/kernel.h>
37 #include <linux/errno.h>
38 #include <linux/init.h>
39 #include <linux/slab.h>
40 #include <linux/tty.h>
41 #include <linux/tty_driver.h>
42 #include <linux/tty_flip.h>
43 #include <linux/module.h>
44 #include <linux/spinlock.h>
45 #include <asm/uaccess.h>
46 #include <linux/usb.h>
48 #include <linux/ioctl.h>
51 #include "kobil_sct.h"
53 #ifdef CONFIG_USB_SERIAL_DEBUG
59 #include "usb-serial.h"
61 /* Version Information */
62 #define DRIVER_VERSION "12/03/2002"
63 #define DRIVER_AUTHOR "KOBIL Systems GmbH - http://www.kobil.com"
64 #define DRIVER_DESC "KOBIL USB Smart Card Terminal Driver (experimental)"
66 #define KOBIL_VENDOR_ID 0x0D46
67 #define KOBIL_ADAPTER_B_PRODUCT_ID 0x2011
68 #define KOBIL_ADAPTER_K_PRODUCT_ID 0x2012
69 #define KOBIL_USBTWIN_PRODUCT_ID 0x0078
70 #define KOBIL_KAAN_SIM_PRODUCT_ID 0x0081
72 #define KOBIL_TIMEOUT 500
73 #define KOBIL_BUF_LENGTH 300
76 /* Function prototypes */
77 static int kobil_startup (struct usb_serial *serial);
78 static void kobil_shutdown (struct usb_serial *serial);
79 static int kobil_open (struct usb_serial_port *port, struct file *filp);
80 static void kobil_close (struct usb_serial_port *port, struct file *filp);
81 static int kobil_write (struct usb_serial_port *port, int from_user,
82 const unsigned char *buf, int count);
83 static int kobil_write_room(struct usb_serial_port *port);
84 static int kobil_ioctl(struct usb_serial_port *port, struct file *file,
85 unsigned int cmd, unsigned long arg);
86 static void kobil_read_int_callback( struct urb *urb );
87 static void kobil_write_callback( struct urb *purb );
90 static struct usb_device_id id_table [] = {
91 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_ADAPTER_B_PRODUCT_ID) },
92 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_ADAPTER_K_PRODUCT_ID) },
93 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_USBTWIN_PRODUCT_ID) },
94 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_KAAN_SIM_PRODUCT_ID) },
95 { } /* Terminating entry */
99 MODULE_DEVICE_TABLE (usb, id_table);
101 struct usb_serial_device_type kobil_device = {
102 .owner = THIS_MODULE,
103 .name = "KOBIL USB smart card terminal",
104 .id_table = id_table,
105 .num_interrupt_in = NUM_DONT_CARE,
109 .startup = kobil_startup,
110 .shutdown = kobil_shutdown,
111 .ioctl = kobil_ioctl,
113 .close = kobil_close,
114 .write = kobil_write,
115 .write_room = kobil_write_room,
116 .read_int_callback = kobil_read_int_callback,
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
128 struct termios internal_termios;
132 static int kobil_startup (struct usb_serial *serial)
135 struct kobil_private *priv;
136 struct usb_device *pdev;
137 struct usb_config_descriptor *actconfig;
138 struct usb_interface *interface;
139 struct usb_interface_descriptor *altsetting;
140 struct usb_endpoint_descriptor *endpoint;
142 serial->port->private = kmalloc(sizeof(struct kobil_private), GFP_KERNEL);
143 if (!serial->port->private){
147 priv = (struct kobil_private *) serial->port->private;
150 priv->device_type = serial->product;
151 priv->line_state = 0;
153 switch (priv->device_type){
154 case KOBIL_ADAPTER_B_PRODUCT_ID:
155 printk(KERN_DEBUG "KOBIL B1 PRO / KAAN PRO detected\n");
157 case KOBIL_ADAPTER_K_PRODUCT_ID:
158 printk(KERN_DEBUG "KOBIL KAAN Standard Plus / SecOVID Reader Plus detected\n");
160 case KOBIL_USBTWIN_PRODUCT_ID:
161 printk(KERN_DEBUG "KOBIL USBTWIN detected\n");
163 case KOBIL_KAAN_SIM_PRODUCT_ID:
164 printk(KERN_DEBUG "KOBIL KAAN SIM detected\n");
168 // search for the neccessary endpoints
170 actconfig = pdev->actconfig;
171 interface = actconfig->interface;
172 altsetting = interface->altsetting;
173 endpoint = altsetting->endpoint;
175 for (i = 0; i < altsetting->bNumEndpoints; i++) {
176 endpoint = &altsetting->endpoint[i];
177 if (((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) &&
178 ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)) {
179 dbg("%s Found interrupt out endpoint. Address: %d", __FUNCTION__, endpoint->bEndpointAddress);
180 priv->write_int_endpoint_address = endpoint->bEndpointAddress;
182 if (((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN) &&
183 ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)) {
184 dbg("%s Found interrupt in endpoint. Address: %d", __FUNCTION__, endpoint->bEndpointAddress);
185 priv->read_int_endpoint_address = endpoint->bEndpointAddress;
192 static void kobil_shutdown (struct usb_serial *serial)
195 dbg("%s - port %d", __FUNCTION__, serial->port->number);
197 for (i=0; i < serial->num_ports; ++i) {
198 while (serial->port[i].open_count > 0) {
199 kobil_close (&serial->port[i], NULL);
201 if (serial->port[i].private) {
202 kfree(serial->port[i].private);
208 static int kobil_open (struct usb_serial_port *port, struct file *filp)
211 struct kobil_private *priv;
212 unsigned char *transfer_buffer;
213 int transfer_buffer_length = 8;
214 int write_urb_transfer_buffer_length = 8;
216 dbg("%s - port %d", __FUNCTION__, port->number);
217 priv = (struct kobil_private *) port->private;
218 priv->line_state = 0;
220 if (port_paranoia_check (port, __FUNCTION__))
223 // someone sets the dev to 0 if the close method has been called
224 port->interrupt_in_urb->dev = port->serial->dev;
227 /* force low_latency on so that our tty_push actually forces
228 * the data through, otherwise it is scheduled, and with high
229 * data rates (like with OHCI) data can get lost.
231 port->tty->low_latency = 1;
233 // without this, every push_tty_char is echoed :-(
234 port->tty->termios->c_lflag = 0;
235 port->tty->termios->c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN | XCASE);
236 port->tty->termios->c_iflag = IGNBRK | IGNPAR | IXOFF;
237 port->tty->termios->c_oflag &= ~ONLCR; // do NOT translate CR to CR-NL (0x0A -> 0x0A 0x0D)
239 // set up internal termios structure
240 priv->internal_termios.c_iflag = port->tty->termios->c_iflag;
241 priv->internal_termios.c_oflag = port->tty->termios->c_oflag;
242 priv->internal_termios.c_cflag = port->tty->termios->c_cflag;
243 priv->internal_termios.c_lflag = port->tty->termios->c_lflag;
245 for (i=0; i<NCCS; i++) {
246 priv->internal_termios.c_cc[i] = port->tty->termios->c_cc[i];
249 // allocate memory for transfer buffer
250 transfer_buffer = (unsigned char *) kmalloc(transfer_buffer_length, GFP_KERNEL);
251 if (! transfer_buffer) {
254 memset(transfer_buffer, 0, transfer_buffer_length);
257 // allocate write_urb
258 if (!port->write_urb) {
259 dbg("%s - port %d Allocating port->write_urb", __FUNCTION__, port->number);
260 port->write_urb = usb_alloc_urb(0);
261 if (!port->write_urb) {
262 dbg("%s - port %d usb_alloc_urb failed", __FUNCTION__, port->number);
263 kfree(transfer_buffer);
268 // allocate memory for write_urb transfer buffer
269 port->write_urb->transfer_buffer = (unsigned char *) kmalloc(write_urb_transfer_buffer_length, GFP_KERNEL);
270 if (! port->write_urb->transfer_buffer) {
271 kfree(transfer_buffer);
275 // get hardware version
276 result = usb_control_msg( port->serial->dev,
277 usb_rcvctrlpipe(port->serial->dev, 0 ),
278 SUSBCRequest_GetMisc,
279 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
280 SUSBCR_MSC_GetHWVersion,
283 transfer_buffer_length,
286 dbg("%s - port %d Send get_HW_version URB returns: %i", __FUNCTION__, port->number, result);
287 dbg("Harware version: %i.%i.%i", transfer_buffer[0], transfer_buffer[1], transfer_buffer[2] );
289 // get firmware version
290 result = usb_control_msg( port->serial->dev,
291 usb_rcvctrlpipe(port->serial->dev, 0 ),
292 SUSBCRequest_GetMisc,
293 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
294 SUSBCR_MSC_GetFWVersion,
297 transfer_buffer_length,
300 dbg("%s - port %d Send get_FW_version URB returns: %i", __FUNCTION__, port->number, result);
301 dbg("Firmware version: %i.%i.%i", transfer_buffer[0], transfer_buffer[1], transfer_buffer[2] );
303 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID || priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
304 // Setting Baudrate, Parity and Stopbits
305 result = usb_control_msg( port->serial->dev,
306 usb_rcvctrlpipe(port->serial->dev, 0 ),
307 SUSBCRequest_SetBaudRateParityAndStopBits,
308 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
309 SUSBCR_SBR_9600 | SUSBCR_SPASB_EvenParity | SUSBCR_SPASB_1StopBit,
315 dbg("%s - port %d Send set_baudrate URB returns: %i", __FUNCTION__, port->number, result);
318 result = usb_control_msg( port->serial->dev,
319 usb_rcvctrlpipe(port->serial->dev, 0 ),
321 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
322 SUSBCR_MSC_ResetAllQueues,
328 dbg("%s - port %d Send reset_all_queues URB returns: %i", __FUNCTION__, port->number, result);
331 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID || priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
332 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
333 // start reading (Adapter B 'cause PNP string)
334 result = usb_submit_urb( port->interrupt_in_urb );
335 dbg("%s - port %d Send read URB returns: %i", __FUNCTION__, port->number, result);
338 kfree(transfer_buffer);
343 static void kobil_close (struct usb_serial_port *port, struct file *filp)
345 dbg("%s - port %d", __FUNCTION__, port->number);
347 if (port->write_urb){
348 usb_unlink_urb( port->write_urb );
349 usb_free_urb( port->write_urb );
352 if (port->interrupt_in_urb){
353 usb_unlink_urb (port->interrupt_in_urb);
358 static void kobil_read_int_callback( struct urb *purb )
361 struct usb_serial_port *port = (struct usb_serial_port *) purb->context;
362 struct tty_struct *tty;
363 unsigned char *data = purb->transfer_buffer;
366 dbg("%s - port %d", __FUNCTION__, port->number);
369 dbg("%s - port %d Read int status not zero: %d", __FUNCTION__, port->number, purb->status);
374 if (purb->actual_length) {
377 dbg_data = (unsigned char *) kmalloc((3 * purb->actual_length + 10) * sizeof(char), GFP_KERNEL);
381 memset(dbg_data, 0, (3 * purb->actual_length + 10));
382 for (i = 0; i < purb->actual_length; i++) {
383 sprintf(dbg_data +3*i, "%02X ", data[i]);
385 dbg(" <-- %s", dbg_data );
389 for (i = 0; i < purb->actual_length; ++i) {
390 // if we insert more than TTY_FLIPBUF_SIZE characters, we drop them.
391 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
392 tty_flip_buffer_push(tty);
394 // this doesn't actually push the data through unless tty->low_latency is set
395 tty_insert_flip_char(tty, data[i], 0);
397 tty_flip_buffer_push(tty);
402 static void kobil_write_callback( struct urb *purb )
407 static int kobil_write (struct usb_serial_port *port, int from_user,
408 const unsigned char *buf, int count)
413 struct kobil_private * priv;
418 dbg("%s - port %d write request of 0 bytes", __FUNCTION__, port->number);
422 priv = (struct kobil_private *) port->private;
424 if (count > (KOBIL_BUF_LENGTH - priv->filled)) {
425 dbg("%s - port %d Error: write request bigger than buffer size", __FUNCTION__, port->number);
430 data = (unsigned char *) kmalloc((3 * count + 10) * sizeof(char), GFP_KERNEL);
434 memset(data, 0, (3 * count + 10));
435 for (i = 0; i < count; i++) {
436 sprintf(data +3*i, "%02X ", buf[i]);
438 dbg(" %d --> %s", port->number, data );
442 // Copy data to buffer
444 if (copy_from_user(priv->buf + priv->filled, buf, count)) {
448 memcpy (priv->buf + priv->filled, buf, count);
451 priv->filled = priv->filled + count;
454 // only send complete block. TWIN, KAAN SIM and adapter K use the same protocol.
455 if ( ((priv->device_type != KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 2) && (priv->filled >= (priv->buf[1] + 3))) ||
456 ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 3) && (priv->filled >= (priv->buf[2] + 4))) ) {
458 // stop reading (except TWIN and KAAN SIM)
459 if ( (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) || (priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) ) {
460 usb_unlink_urb( port->interrupt_in_urb );
463 todo = priv->filled - priv->cur_pos;
466 // max 8 byte in one urb (endpoint size)
467 length = (todo < 8) ? todo : 8;
468 // copy data to transfer buffer
469 memcpy(port->write_urb->transfer_buffer, priv->buf + priv->cur_pos, length );
471 usb_fill_bulk_urb( port->write_urb,
473 usb_sndbulkpipe( port->serial->dev, priv->write_int_endpoint_address),
474 port->write_urb->transfer_buffer,
476 kobil_write_callback,
480 priv->cur_pos = priv->cur_pos + length;
481 result = usb_submit_urb( port->write_urb );
482 dbg("%s - port %d Send write URB returns: %i", __FUNCTION__, port->number, result);
483 todo = priv->filled - priv->cur_pos;
487 set_current_state(TASK_UNINTERRUPTIBLE);
488 schedule_timeout(24 * HZ / 1000);
496 // start reading (except TWIN and KAAN SIM)
497 if ( (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) || (priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) ) {
498 // someone sets the dev to 0 if the close method has been called
499 port->interrupt_in_urb->dev = port->serial->dev;
502 result = usb_submit_urb( port->interrupt_in_urb );
503 dbg("%s - port %d Send read URB returns: %i", __FUNCTION__, port->number, result);
511 static int kobil_write_room (struct usb_serial_port *port)
517 static int kobil_ioctl(struct usb_serial_port *port, struct file *file,
518 unsigned int cmd, unsigned long arg)
520 struct kobil_private * priv;
523 unsigned short urb_val = 0;
524 unsigned char *transfer_buffer;
525 int transfer_buffer_length = 8;
528 priv = (struct kobil_private *) port->private;
529 if ((priv->device_type == KOBIL_USBTWIN_PRODUCT_ID) || (priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID)) {
530 // This device doesn't support ioctl calls
535 case TCGETS: // 0x5401
536 result = verify_area(VERIFY_WRITE, (void *)arg, sizeof(struct termios));
538 dbg("%s - port %d Error in verify_area", __FUNCTION__, port->number);
541 kernel_termios_to_user_termios((struct termios *)arg, &priv->internal_termios);
544 case TCSETS: // 0x5402
545 if (! &port->tty->termios) {
546 dbg("%s - port %d Error: port->tty->termios is NULL", __FUNCTION__, port->number);
549 result = verify_area(VERIFY_READ, (void *)arg, sizeof(struct termios));
551 dbg("%s - port %d Error in verify_area", __FUNCTION__, port->number);
554 user_termios_to_kernel_termios( &priv->internal_termios, (struct termios *)arg);
556 settings = (unsigned char *) kmalloc(50, GFP_KERNEL);
560 memset(settings, 0, 50);
562 switch (priv->internal_termios.c_cflag & CBAUD) {
564 urb_val = SUSBCR_SBR_1200;
565 strcat(settings, "1200 ");
569 urb_val = SUSBCR_SBR_9600;
570 strcat(settings, "9600 ");
574 urb_val |= (priv->internal_termios.c_cflag & CSTOPB) ? SUSBCR_SPASB_2StopBits : SUSBCR_SPASB_1StopBit;
575 strcat(settings, (priv->internal_termios.c_cflag & CSTOPB) ? "2 StopBits " : "1 StopBit ");
577 if (priv->internal_termios.c_cflag & PARENB) {
578 if (priv->internal_termios.c_cflag & PARODD) {
579 urb_val |= SUSBCR_SPASB_OddParity;
580 strcat(settings, "Odd Parity");
582 urb_val |= SUSBCR_SPASB_EvenParity;
583 strcat(settings, "Even Parity");
586 urb_val |= SUSBCR_SPASB_NoParity;
587 strcat(settings, "No Parity");
589 dbg("%s - port %d setting port to: %s", __FUNCTION__, port->number, settings );
591 result = usb_control_msg( port->serial->dev,
592 usb_rcvctrlpipe(port->serial->dev, 0 ),
593 SUSBCRequest_SetBaudRateParityAndStopBits,
594 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
602 dbg("%s - port %d Send set_baudrate URB returns: %i", __FUNCTION__, port->number, result);
606 case TCFLSH: // 0x540B
607 result = usb_control_msg( port->serial->dev,
608 usb_rcvctrlpipe(port->serial->dev, 0 ),
610 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
611 SUSBCR_MSC_ResetAllQueues,
618 dbg("%s - port %d Send reset_all_queues (FLUSH) URB returns: %i", __FUNCTION__, port->number, result);
619 return ((result < 0) ? -EFAULT : 0);
621 case TIOCMGET: // 0x5415
622 // allocate memory for transfer buffer
623 transfer_buffer = (unsigned char *) kmalloc(transfer_buffer_length, GFP_KERNEL);
624 if (! transfer_buffer) {
627 memset(transfer_buffer, 0, transfer_buffer_length);
630 result = usb_control_msg( port->serial->dev,
631 usb_rcvctrlpipe(port->serial->dev, 0 ),
632 SUSBCRequest_GetStatusLineState,
633 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
637 transfer_buffer_length,
641 dbg("%s - port %d Send get_status_line_state (TIOCMGET) URB returns: %i. Statusline: %02x",
642 __FUNCTION__, port->number, result, transfer_buffer[0]);
644 if ((transfer_buffer[0] & SUSBCR_GSL_DSR) != 0) {
645 priv->line_state |= TIOCM_DSR;
647 priv->line_state &= ~TIOCM_DSR;
650 kfree(transfer_buffer);
651 return put_user(priv->line_state, (unsigned long *) arg);
653 case TIOCMSET: // 0x5418
654 if (get_user(mask, (unsigned long *) arg)){
657 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) {
658 if ((mask & TIOCM_DTR) != 0){
659 dbg("%s - port %d Setting DTR", __FUNCTION__, port->number);
661 dbg("%s - port %d Clearing DTR", __FUNCTION__, port->number);
663 result = usb_control_msg( port->serial->dev,
664 usb_rcvctrlpipe(port->serial->dev, 0 ),
665 SUSBCRequest_SetStatusLinesOrQueues,
666 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
667 ( ((mask & TIOCM_DTR) != 0) ? SUSBCR_SSL_SETDTR : SUSBCR_SSL_CLRDTR),
675 if ((mask & TIOCM_RTS) != 0){
676 dbg("%s - port %d Setting RTS", __FUNCTION__, port->number);
678 dbg("%s - port %d Clearing RTS", __FUNCTION__, port->number);
680 result = usb_control_msg( port->serial->dev,
681 usb_rcvctrlpipe(port->serial->dev, 0 ),
682 SUSBCRequest_SetStatusLinesOrQueues,
683 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
684 (((mask & TIOCM_RTS) != 0) ? SUSBCR_SSL_SETRTS : SUSBCR_SSL_CLRRTS),
691 dbg("%s - port %d Send set_status_line (TIOCMSET) URB returns: %i", __FUNCTION__, port->number, result);
692 return ((result < 0) ? -EFAULT : 0);
698 static int __init kobil_init (void)
700 usb_serial_register (&kobil_device);
702 info(DRIVER_VERSION " " DRIVER_AUTHOR);
709 static void __exit kobil_exit (void)
711 usb_serial_deregister (&kobil_device);
714 module_init(kobil_init);
715 module_exit(kobil_exit);
717 MODULE_AUTHOR( DRIVER_AUTHOR );
718 MODULE_DESCRIPTION( DRIVER_DESC );
719 MODULE_LICENSE( "GPL" );
721 MODULE_PARM(debug, "i");
722 MODULE_PARM_DESC(debug, "Debug enabled or not");