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 <asm/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_shutdown (struct usb_serial *serial);
73 static int kobil_open (struct usb_serial_port *port, struct file *filp);
74 static void kobil_close (struct usb_serial_port *port, struct file *filp);
75 static int kobil_write (struct usb_serial_port *port,
76 const unsigned char *buf, int count);
77 static int kobil_write_room(struct usb_serial_port *port);
78 static int kobil_ioctl(struct usb_serial_port *port, struct file *file,
79 unsigned int cmd, unsigned long arg);
80 static int kobil_tiocmget(struct usb_serial_port *port, struct file *file);
81 static int kobil_tiocmset(struct usb_serial_port *port, struct file *file,
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 usb_serial_port *port, struct ktermios *old);
88 static struct usb_device_id id_table [] = {
89 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_ADAPTER_B_PRODUCT_ID) },
90 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_ADAPTER_K_PRODUCT_ID) },
91 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_USBTWIN_PRODUCT_ID) },
92 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_KAAN_SIM_PRODUCT_ID) },
93 { } /* Terminating entry */
97 MODULE_DEVICE_TABLE (usb, id_table);
99 static struct usb_driver kobil_driver = {
101 .probe = usb_serial_probe,
102 .disconnect = usb_serial_disconnect,
103 .id_table = id_table,
108 static struct usb_serial_driver kobil_device = {
110 .owner = THIS_MODULE,
113 .description = "KOBIL USB smart card terminal",
114 .usb_driver = &kobil_driver,
115 .id_table = id_table,
116 .num_interrupt_in = NUM_DONT_CARE,
117 .num_interrupt_out = NUM_DONT_CARE,
121 .attach = kobil_startup,
122 .shutdown = kobil_shutdown,
123 .ioctl = kobil_ioctl,
124 .set_termios = kobil_set_termios,
125 .tiocmget = kobil_tiocmget,
126 .tiocmset = kobil_tiocmset,
128 .close = kobil_close,
129 .write = kobil_write,
130 .write_room = kobil_write_room,
131 .read_int_callback = kobil_read_int_callback,
135 struct kobil_private {
136 int write_int_endpoint_address;
137 int read_int_endpoint_address;
138 unsigned char buf[KOBIL_BUF_LENGTH]; // buffer for the APDU to send
139 int filled; // index of the last char in buf
140 int cur_pos; // index of the next char to send in buf
145 static int kobil_startup (struct usb_serial *serial)
148 struct kobil_private *priv;
149 struct usb_device *pdev;
150 struct usb_host_config *actconfig;
151 struct usb_interface *interface;
152 struct usb_host_interface *altsetting;
153 struct usb_host_endpoint *endpoint;
155 priv = kmalloc(sizeof(struct kobil_private), GFP_KERNEL);
162 priv->device_type = le16_to_cpu(serial->dev->descriptor.idProduct);
164 switch (priv->device_type){
165 case KOBIL_ADAPTER_B_PRODUCT_ID:
166 printk(KERN_DEBUG "KOBIL B1 PRO / KAAN PRO detected\n");
168 case KOBIL_ADAPTER_K_PRODUCT_ID:
169 printk(KERN_DEBUG "KOBIL KAAN Standard Plus / SecOVID Reader Plus detected\n");
171 case KOBIL_USBTWIN_PRODUCT_ID:
172 printk(KERN_DEBUG "KOBIL USBTWIN detected\n");
174 case KOBIL_KAAN_SIM_PRODUCT_ID:
175 printk(KERN_DEBUG "KOBIL KAAN SIM detected\n");
178 usb_set_serial_port_data(serial->port[0], priv);
180 // search for the necessary endpoints
182 actconfig = pdev->actconfig;
183 interface = actconfig->interface[0];
184 altsetting = interface->cur_altsetting;
185 endpoint = altsetting->endpoint;
187 for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
188 endpoint = &altsetting->endpoint[i];
189 if (usb_endpoint_is_int_out(&endpoint->desc)) {
190 dbg("%s Found interrupt out endpoint. Address: %d", __FUNCTION__, endpoint->desc.bEndpointAddress);
191 priv->write_int_endpoint_address = endpoint->desc.bEndpointAddress;
193 if (usb_endpoint_is_int_in(&endpoint->desc)) {
194 dbg("%s Found interrupt in endpoint. Address: %d", __FUNCTION__, endpoint->desc.bEndpointAddress);
195 priv->read_int_endpoint_address = endpoint->desc.bEndpointAddress;
202 static void kobil_shutdown (struct usb_serial *serial)
205 dbg("%s - port %d", __FUNCTION__, serial->port[0]->number);
207 for (i=0; i < serial->num_ports; ++i) {
208 while (serial->port[i]->open_count > 0) {
209 kobil_close (serial->port[i], NULL);
211 kfree(usb_get_serial_port_data(serial->port[i]));
212 usb_set_serial_port_data(serial->port[i], NULL);
217 static int kobil_open (struct usb_serial_port *port, struct file *filp)
220 struct kobil_private *priv;
221 unsigned char *transfer_buffer;
222 int transfer_buffer_length = 8;
223 int write_urb_transfer_buffer_length = 8;
225 dbg("%s - port %d", __FUNCTION__, port->number);
226 priv = usb_get_serial_port_data(port);
228 // someone sets the dev to 0 if the close method has been called
229 port->interrupt_in_urb->dev = port->serial->dev;
232 /* force low_latency on so that our tty_push actually forces
233 * the data through, otherwise it is scheduled, and with high
234 * data rates (like with OHCI) data can get lost.
236 port->tty->low_latency = 1;
238 // without this, every push_tty_char is echoed :-(
239 port->tty->termios->c_lflag = 0;
240 port->tty->termios->c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN | XCASE);
241 port->tty->termios->c_iflag = IGNBRK | IGNPAR | IXOFF;
242 port->tty->termios->c_oflag &= ~ONLCR; // do NOT translate CR to CR-NL (0x0A -> 0x0A 0x0D)
244 // allocate memory for transfer buffer
245 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
246 if (! transfer_buffer) {
250 // allocate write_urb
251 if (!port->write_urb) {
252 dbg("%s - port %d Allocating port->write_urb", __FUNCTION__, port->number);
253 port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
254 if (!port->write_urb) {
255 dbg("%s - port %d usb_alloc_urb failed", __FUNCTION__, port->number);
256 kfree(transfer_buffer);
261 // allocate memory for write_urb transfer buffer
262 port->write_urb->transfer_buffer = kmalloc(write_urb_transfer_buffer_length, GFP_KERNEL);
263 if (! port->write_urb->transfer_buffer) {
264 kfree(transfer_buffer);
265 usb_free_urb(port->write_urb);
266 port->write_urb = NULL;
270 // get hardware version
271 result = usb_control_msg( port->serial->dev,
272 usb_rcvctrlpipe(port->serial->dev, 0 ),
273 SUSBCRequest_GetMisc,
274 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
275 SUSBCR_MSC_GetHWVersion,
278 transfer_buffer_length,
281 dbg("%s - port %d Send get_HW_version URB returns: %i", __FUNCTION__, port->number, result);
282 dbg("Harware version: %i.%i.%i", transfer_buffer[0], transfer_buffer[1], transfer_buffer[2] );
284 // get firmware version
285 result = usb_control_msg( port->serial->dev,
286 usb_rcvctrlpipe(port->serial->dev, 0 ),
287 SUSBCRequest_GetMisc,
288 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
289 SUSBCR_MSC_GetFWVersion,
292 transfer_buffer_length,
295 dbg("%s - port %d Send get_FW_version URB returns: %i", __FUNCTION__, port->number, result);
296 dbg("Firmware version: %i.%i.%i", transfer_buffer[0], transfer_buffer[1], transfer_buffer[2] );
298 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID || 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 | SUSBCR_SPASB_1StopBit,
310 dbg("%s - port %d Send set_baudrate URB returns: %i", __FUNCTION__, port->number, result);
313 result = usb_control_msg( port->serial->dev,
314 usb_rcvctrlpipe(port->serial->dev, 0 ),
316 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
317 SUSBCR_MSC_ResetAllQueues,
323 dbg("%s - port %d Send reset_all_queues URB returns: %i", __FUNCTION__, port->number, result);
325 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID || priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
326 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
327 // start reading (Adapter B 'cause PNP string)
328 result = usb_submit_urb( port->interrupt_in_urb, GFP_ATOMIC );
329 dbg("%s - port %d Send read URB returns: %i", __FUNCTION__, port->number, result);
332 kfree(transfer_buffer);
337 static void kobil_close (struct usb_serial_port *port, struct file *filp)
339 dbg("%s - port %d", __FUNCTION__, port->number);
341 if (port->write_urb) {
342 usb_kill_urb(port->write_urb);
343 usb_free_urb( port->write_urb );
344 port->write_urb = NULL;
346 usb_kill_urb(port->interrupt_in_urb);
350 static void kobil_read_int_callback(struct urb *urb)
353 struct usb_serial_port *port = urb->context;
354 struct tty_struct *tty;
355 unsigned char *data = urb->transfer_buffer;
356 int status = urb->status;
359 dbg("%s - port %d", __FUNCTION__, port->number);
362 dbg("%s - port %d Read int status not zero: %d",
363 __FUNCTION__, port->number, status);
368 if (urb->actual_length) {
372 dbg_data = kzalloc((3 * purb->actual_length + 10) * sizeof(char), GFP_KERNEL);
376 for (i = 0; i < purb->actual_length; i++) {
377 sprintf(dbg_data +3*i, "%02X ", data[i]);
379 dbg(" <-- %s", dbg_data );
384 tty_buffer_request_room(tty, urb->actual_length);
385 tty_insert_flip_string(tty, data, urb->actual_length);
386 tty_flip_buffer_push(tty);
389 // someone sets the dev to 0 if the close method has been called
390 port->interrupt_in_urb->dev = port->serial->dev;
392 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
393 dbg("%s - port %d Send read URB returns: %i", __FUNCTION__, port->number, result);
397 static void kobil_write_callback( struct urb *purb )
402 static int kobil_write (struct usb_serial_port *port,
403 const unsigned char *buf, int count)
408 struct kobil_private * priv;
411 dbg("%s - port %d write request of 0 bytes", __FUNCTION__, port->number);
415 priv = usb_get_serial_port_data(port);
417 if (count > (KOBIL_BUF_LENGTH - priv->filled)) {
418 dbg("%s - port %d Error: write request bigger than buffer size", __FUNCTION__, port->number);
422 // Copy data to buffer
423 memcpy (priv->buf + priv->filled, buf, count);
425 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, priv->buf + priv->filled);
427 priv->filled = priv->filled + count;
430 // only send complete block. TWIN, KAAN SIM and adapter K use the same protocol.
431 if ( ((priv->device_type != KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 2) && (priv->filled >= (priv->buf[1] + 3))) ||
432 ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 3) && (priv->filled >= (priv->buf[2] + 4))) ) {
434 // stop reading (except TWIN and KAAN SIM)
435 if ( (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) || (priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) )
436 usb_kill_urb(port->interrupt_in_urb);
438 todo = priv->filled - priv->cur_pos;
441 // max 8 byte in one urb (endpoint size)
442 length = (todo < 8) ? todo : 8;
443 // copy data to transfer buffer
444 memcpy(port->write_urb->transfer_buffer, priv->buf + priv->cur_pos, length );
445 usb_fill_int_urb( port->write_urb,
447 usb_sndintpipe(port->serial->dev, priv->write_int_endpoint_address),
448 port->write_urb->transfer_buffer,
450 kobil_write_callback,
455 priv->cur_pos = priv->cur_pos + length;
456 result = usb_submit_urb( port->write_urb, GFP_NOIO );
457 dbg("%s - port %d Send write URB returns: %i", __FUNCTION__, port->number, result);
458 todo = priv->filled - priv->cur_pos;
469 // someone sets the dev to 0 if the close method has been called
470 port->interrupt_in_urb->dev = port->serial->dev;
472 // start reading (except TWIN and KAAN SIM)
473 if ( (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) || (priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) ) {
474 // someone sets the dev to 0 if the close method has been called
475 port->interrupt_in_urb->dev = port->serial->dev;
477 result = usb_submit_urb( port->interrupt_in_urb, GFP_NOIO );
478 dbg("%s - port %d Send read URB returns: %i", __FUNCTION__, port->number, result);
485 static int kobil_write_room (struct usb_serial_port *port)
487 //dbg("%s - port %d", __FUNCTION__, port->number);
492 static int kobil_tiocmget(struct usb_serial_port *port, struct file *file)
494 struct kobil_private * priv;
496 unsigned char *transfer_buffer;
497 int transfer_buffer_length = 8;
499 priv = usb_get_serial_port_data(port);
500 if ((priv->device_type == KOBIL_USBTWIN_PRODUCT_ID) || (priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID)) {
501 // This device doesn't support ioctl calls
505 // allocate memory for transfer buffer
506 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
507 if (!transfer_buffer) {
511 result = usb_control_msg( port->serial->dev,
512 usb_rcvctrlpipe(port->serial->dev, 0 ),
513 SUSBCRequest_GetStatusLineState,
514 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
518 transfer_buffer_length,
521 dbg("%s - port %d Send get_status_line_state URB returns: %i. Statusline: %02x",
522 __FUNCTION__, port->number, result, transfer_buffer[0]);
525 if ((transfer_buffer[0] & SUSBCR_GSL_DSR) != 0)
527 kfree(transfer_buffer);
531 static int kobil_tiocmset(struct usb_serial_port *port, struct file *file,
532 unsigned int set, unsigned int clear)
534 struct kobil_private * priv;
538 unsigned char *transfer_buffer;
539 int transfer_buffer_length = 8;
541 /* FIXME: locking ? */
542 priv = usb_get_serial_port_data(port);
543 if ((priv->device_type == KOBIL_USBTWIN_PRODUCT_ID) || (priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID)) {
544 // This device doesn't support ioctl calls
548 // allocate memory for transfer buffer
549 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
550 if (! transfer_buffer) {
558 if (clear & TIOCM_RTS)
560 if (clear & TIOCM_DTR)
563 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) {
565 dbg("%s - port %d Setting DTR", __FUNCTION__, port->number);
567 dbg("%s - port %d Clearing DTR", __FUNCTION__, port->number);
568 result = usb_control_msg( port->serial->dev,
569 usb_rcvctrlpipe(port->serial->dev, 0 ),
570 SUSBCRequest_SetStatusLinesOrQueues,
571 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
572 ((dtr != 0) ? SUSBCR_SSL_SETDTR : SUSBCR_SSL_CLRDTR),
579 dbg("%s - port %d Setting RTS", __FUNCTION__, port->number);
581 dbg("%s - port %d Clearing RTS", __FUNCTION__, port->number);
582 result = usb_control_msg( port->serial->dev,
583 usb_rcvctrlpipe(port->serial->dev, 0 ),
584 SUSBCRequest_SetStatusLinesOrQueues,
585 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
586 ((rts != 0) ? SUSBCR_SSL_SETRTS : SUSBCR_SSL_CLRRTS),
592 dbg("%s - port %d Send set_status_line URB returns: %i", __FUNCTION__, port->number, result);
593 kfree(transfer_buffer);
594 return (result < 0) ? result : 0;
597 static void kobil_set_termios(struct usb_serial_port *port, struct ktermios *old)
599 struct kobil_private * priv;
601 unsigned short urb_val = 0;
602 int c_cflag = port->tty->termios->c_cflag;
606 priv = usb_get_serial_port_data(port);
607 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID)
608 // This device doesn't support ioctl calls
611 switch (speed = tty_get_baud_rate(port->tty)) {
613 urb_val = SUSBCR_SBR_1200;
618 urb_val = SUSBCR_SBR_9600;
621 urb_val |= (c_cflag & CSTOPB) ? SUSBCR_SPASB_2StopBits : SUSBCR_SPASB_1StopBit;
623 settings = kzalloc(50, GFP_KERNEL);
627 sprintf(settings, "%d ", speed);
629 if (c_cflag & PARENB) {
630 if (c_cflag & PARODD) {
631 urb_val |= SUSBCR_SPASB_OddParity;
632 strcat(settings, "Odd Parity");
634 urb_val |= SUSBCR_SPASB_EvenParity;
635 strcat(settings, "Even Parity");
638 urb_val |= SUSBCR_SPASB_NoParity;
639 strcat(settings, "No Parity");
641 port->tty->termios->c_cflag &= ~CMSPAR;
642 tty_encode_baud_rate(port->tty, speed, speed);
644 result = usb_control_msg( port->serial->dev,
645 usb_rcvctrlpipe(port->serial->dev, 0 ),
646 SUSBCRequest_SetBaudRateParityAndStopBits,
647 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
657 static int kobil_ioctl(struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
659 struct kobil_private * priv = usb_get_serial_port_data(port);
660 unsigned char *transfer_buffer;
661 int transfer_buffer_length = 8;
664 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID)
665 // This device doesn't support ioctl calls
669 case TCFLSH: // 0x540B
670 transfer_buffer = kmalloc(transfer_buffer_length, GFP_KERNEL);
671 if (! transfer_buffer)
674 result = usb_control_msg( port->serial->dev,
675 usb_rcvctrlpipe(port->serial->dev, 0 ),
677 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
678 SUSBCR_MSC_ResetAllQueues,
680 NULL,//transfer_buffer,
685 dbg("%s - port %d Send reset_all_queues (FLUSH) URB returns: %i", __FUNCTION__, port->number, result);
686 kfree(transfer_buffer);
687 return (result < 0) ? -EFAULT : 0;
693 static int __init kobil_init (void)
696 retval = usb_serial_register(&kobil_device);
698 goto failed_usb_serial_register;
699 retval = usb_register(&kobil_driver);
701 goto failed_usb_register;
703 info(DRIVER_VERSION " " DRIVER_AUTHOR);
708 usb_serial_deregister(&kobil_device);
709 failed_usb_serial_register:
714 static void __exit kobil_exit (void)
716 usb_deregister (&kobil_driver);
717 usb_serial_deregister (&kobil_device);
720 module_init(kobil_init);
721 module_exit(kobil_exit);
723 MODULE_AUTHOR( DRIVER_AUTHOR );
724 MODULE_DESCRIPTION( DRIVER_DESC );
725 MODULE_LICENSE( "GPL" );
727 module_param(debug, bool, S_IRUGO | S_IWUSR);
728 MODULE_PARM_DESC(debug, "Debug enabled or not");