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 if (serial->num_interrupt_out < serial->num_ports) {
154 dev_err(&serial->interface->dev, "missing interrupt-out endpoint\n");
158 priv = kmalloc(sizeof(struct kobil_private), GFP_KERNEL);
164 priv->device_type = le16_to_cpu(serial->dev->descriptor.idProduct);
166 switch (priv->device_type) {
167 case KOBIL_ADAPTER_B_PRODUCT_ID:
168 printk(KERN_DEBUG "KOBIL B1 PRO / KAAN PRO detected\n");
170 case KOBIL_ADAPTER_K_PRODUCT_ID:
172 "KOBIL KAAN Standard Plus / SecOVID Reader Plus detected\n");
174 case KOBIL_USBTWIN_PRODUCT_ID:
175 printk(KERN_DEBUG "KOBIL USBTWIN detected\n");
177 case KOBIL_KAAN_SIM_PRODUCT_ID:
178 printk(KERN_DEBUG "KOBIL KAAN SIM detected\n");
181 usb_set_serial_port_data(serial->port[0], priv);
183 /* search for the necessary endpoints */
185 actconfig = pdev->actconfig;
186 interface = actconfig->interface[0];
187 altsetting = interface->cur_altsetting;
188 endpoint = altsetting->endpoint;
190 for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
191 endpoint = &altsetting->endpoint[i];
192 if (usb_endpoint_is_int_out(&endpoint->desc)) {
193 dbg("%s Found interrupt out endpoint. Address: %d",
194 __func__, endpoint->desc.bEndpointAddress);
195 priv->write_int_endpoint_address =
196 endpoint->desc.bEndpointAddress;
198 if (usb_endpoint_is_int_in(&endpoint->desc)) {
199 dbg("%s Found interrupt in endpoint. Address: %d",
200 __func__, endpoint->desc.bEndpointAddress);
201 priv->read_int_endpoint_address =
202 endpoint->desc.bEndpointAddress;
209 static void kobil_release(struct usb_serial *serial)
212 dbg("%s - port %d", __func__, serial->port[0]->number);
214 for (i = 0; i < serial->num_ports; ++i)
215 kfree(usb_get_serial_port_data(serial->port[i]));
218 static void kobil_init_termios(struct tty_struct *tty)
220 /* Default to echo off and other sane device settings */
221 tty->termios->c_lflag = 0;
222 tty->termios->c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN | XCASE);
223 tty->termios->c_iflag = IGNBRK | IGNPAR | IXOFF;
224 /* do NOT translate CR to CR-NL (0x0A -> 0x0A 0x0D) */
225 tty->termios->c_oflag &= ~ONLCR;
228 static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port)
231 struct kobil_private *priv;
232 unsigned char *transfer_buffer;
233 int transfer_buffer_length = 8;
234 int write_urb_transfer_buffer_length = 8;
236 dbg("%s - port %d", __func__, port->number);
237 priv = usb_get_serial_port_data(port);
239 /* someone sets the dev to 0 if the close method has been called */
240 port->interrupt_in_urb->dev = port->serial->dev;
242 /* allocate memory for transfer buffer */
243 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
244 if (!transfer_buffer)
247 /* allocate write_urb */
248 if (!port->write_urb) {
249 dbg("%s - port %d Allocating port->write_urb",
250 __func__, port->number);
251 port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
252 if (!port->write_urb) {
253 dbg("%s - port %d usb_alloc_urb failed",
254 __func__, port->number);
255 kfree(transfer_buffer);
260 /* allocate memory for write_urb transfer buffer */
261 port->write_urb->transfer_buffer =
262 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",
282 __func__, port->number, result);
283 dbg("Harware version: %i.%i.%i",
284 transfer_buffer[0], transfer_buffer[1], transfer_buffer[2]);
286 /* get firmware version */
287 result = usb_control_msg(port->serial->dev,
288 usb_rcvctrlpipe(port->serial->dev, 0),
289 SUSBCRequest_GetMisc,
290 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
291 SUSBCR_MSC_GetFWVersion,
294 transfer_buffer_length,
297 dbg("%s - port %d Send get_FW_version URB returns: %i",
298 __func__, port->number, result);
299 dbg("Firmware version: %i.%i.%i",
300 transfer_buffer[0], transfer_buffer[1], transfer_buffer[2]);
302 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
303 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 |
310 SUSBCR_SPASB_1StopBit,
316 dbg("%s - port %d Send set_baudrate URB returns: %i",
317 __func__, port->number, result);
319 /* reset all queues */
320 result = usb_control_msg(port->serial->dev,
321 usb_rcvctrlpipe(port->serial->dev, 0),
323 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
324 SUSBCR_MSC_ResetAllQueues,
330 dbg("%s - port %d Send reset_all_queues URB returns: %i",
331 __func__, port->number, result);
333 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
334 priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
335 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
336 /* start reading (Adapter B 'cause PNP string) */
337 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
338 dbg("%s - port %d Send read URB returns: %i",
339 __func__, port->number, result);
342 kfree(transfer_buffer);
347 static void kobil_close(struct usb_serial_port *port)
349 dbg("%s - port %d", __func__, port->number);
351 /* FIXME: Add rts/dtr methods */
352 if (port->write_urb) {
353 usb_poison_urb(port->write_urb);
354 kfree(port->write_urb->transfer_buffer);
355 usb_free_urb(port->write_urb);
356 port->write_urb = NULL;
358 usb_kill_urb(port->interrupt_in_urb);
362 static void kobil_read_int_callback(struct urb *urb)
365 struct usb_serial_port *port = urb->context;
366 struct tty_struct *tty;
367 unsigned char *data = urb->transfer_buffer;
368 int status = urb->status;
369 /* char *dbg_data; */
371 dbg("%s - port %d", __func__, port->number);
374 dbg("%s - port %d Read int status not zero: %d",
375 __func__, port->number, status);
379 tty = tty_port_tty_get(&port->port);
380 if (tty && urb->actual_length) {
384 dbg_data = kzalloc((3 * purb->actual_length + 10)
385 * sizeof(char), GFP_KERNEL);
389 for (i = 0; i < purb->actual_length; i++) {
390 sprintf(dbg_data +3*i, "%02X ", data[i]);
392 dbg(" <-- %s", dbg_data);
397 tty_insert_flip_string(tty, data, urb->actual_length);
398 tty_flip_buffer_push(tty);
401 /* someone sets the dev to 0 if the close method has been called */
402 port->interrupt_in_urb->dev = port->serial->dev;
404 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
405 dbg("%s - port %d Send read URB returns: %i",
406 __func__, port->number, result);
410 static void kobil_write_callback(struct urb *purb)
415 static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
416 const unsigned char *buf, int count)
421 struct kobil_private *priv;
424 dbg("%s - port %d write request of 0 bytes",
425 __func__, port->number);
429 priv = usb_get_serial_port_data(port);
431 if (count > (KOBIL_BUF_LENGTH - priv->filled)) {
432 dbg("%s - port %d Error: write request bigger than buffer size", __func__, port->number);
436 /* Copy data to buffer */
437 memcpy(priv->buf + priv->filled, buf, count);
438 usb_serial_debug_data(debug, &port->dev, __func__, count,
439 priv->buf + priv->filled);
440 priv->filled = priv->filled + count;
442 /* only send complete block. TWIN, KAAN SIM and adapter K
443 use the same protocol. */
444 if (((priv->device_type != KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 2) && (priv->filled >= (priv->buf[1] + 3))) ||
445 ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 3) && (priv->filled >= (priv->buf[2] + 4)))) {
446 /* stop reading (except TWIN and KAAN SIM) */
447 if ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID)
448 || (priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID))
449 usb_kill_urb(port->interrupt_in_urb);
451 todo = priv->filled - priv->cur_pos;
454 /* max 8 byte in one urb (endpoint size) */
455 length = (todo < 8) ? todo : 8;
456 /* copy data to transfer buffer */
457 memcpy(port->write_urb->transfer_buffer,
458 priv->buf + priv->cur_pos, length);
459 usb_fill_int_urb(port->write_urb,
461 usb_sndintpipe(port->serial->dev,
462 priv->write_int_endpoint_address),
463 port->write_urb->transfer_buffer,
465 kobil_write_callback,
470 priv->cur_pos = priv->cur_pos + length;
471 result = usb_submit_urb(port->write_urb,
473 dbg("%s - port %d Send write URB returns: %i",
474 __func__, port->number, result);
475 todo = priv->filled - priv->cur_pos;
484 /* someone sets the dev to 0 if the close method
486 port->interrupt_in_urb->dev = port->serial->dev;
488 /* start reading (except TWIN and KAAN SIM) */
489 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
490 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
491 /* someone sets the dev to 0 if the close method has
493 port->interrupt_in_urb->dev = port->serial->dev;
495 result = usb_submit_urb(port->interrupt_in_urb,
497 dbg("%s - port %d Send read URB returns: %i",
498 __func__, port->number, result);
505 static int kobil_write_room(struct tty_struct *tty)
507 /* dbg("%s - port %d", __func__, port->number); */
513 static int kobil_tiocmget(struct tty_struct *tty)
515 struct usb_serial_port *port = tty->driver_data;
516 struct kobil_private *priv;
518 unsigned char *transfer_buffer;
519 int transfer_buffer_length = 8;
521 priv = usb_get_serial_port_data(port);
522 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
523 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
524 /* This device doesn't support ioctl calls */
528 /* allocate memory for transfer buffer */
529 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
530 if (!transfer_buffer)
533 result = usb_control_msg(port->serial->dev,
534 usb_rcvctrlpipe(port->serial->dev, 0),
535 SUSBCRequest_GetStatusLineState,
536 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
540 transfer_buffer_length,
543 dbg("%s - port %d Send get_status_line_state URB returns: %i. Statusline: %02x",
544 __func__, port->number, result, transfer_buffer[0]);
547 if ((transfer_buffer[0] & SUSBCR_GSL_DSR) != 0)
549 kfree(transfer_buffer);
553 static int kobil_tiocmset(struct tty_struct *tty,
554 unsigned int set, unsigned int clear)
556 struct usb_serial_port *port = tty->driver_data;
557 struct kobil_private *priv;
561 unsigned char *transfer_buffer;
562 int transfer_buffer_length = 8;
564 /* FIXME: locking ? */
565 priv = usb_get_serial_port_data(port);
566 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
567 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
568 /* This device doesn't support ioctl calls */
572 /* allocate memory for transfer buffer */
573 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
574 if (!transfer_buffer)
581 if (clear & TIOCM_RTS)
583 if (clear & TIOCM_DTR)
586 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) {
588 dbg("%s - port %d Setting DTR",
589 __func__, port->number);
591 dbg("%s - port %d Clearing DTR",
592 __func__, port->number);
593 result = usb_control_msg(port->serial->dev,
594 usb_rcvctrlpipe(port->serial->dev, 0),
595 SUSBCRequest_SetStatusLinesOrQueues,
596 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
597 ((dtr != 0) ? SUSBCR_SSL_SETDTR : SUSBCR_SSL_CLRDTR),
604 dbg("%s - port %d Setting RTS",
605 __func__, port->number);
607 dbg("%s - port %d Clearing RTS",
608 __func__, port->number);
609 result = usb_control_msg(port->serial->dev,
610 usb_rcvctrlpipe(port->serial->dev, 0),
611 SUSBCRequest_SetStatusLinesOrQueues,
612 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
613 ((rts != 0) ? SUSBCR_SSL_SETRTS : SUSBCR_SSL_CLRRTS),
619 dbg("%s - port %d Send set_status_line URB returns: %i",
620 __func__, port->number, result);
621 kfree(transfer_buffer);
622 return (result < 0) ? result : 0;
625 static void kobil_set_termios(struct tty_struct *tty,
626 struct usb_serial_port *port, struct ktermios *old)
628 struct kobil_private *priv;
630 unsigned short urb_val = 0;
631 int c_cflag = tty->termios->c_cflag;
634 priv = usb_get_serial_port_data(port);
635 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
636 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
637 /* This device doesn't support ioctl calls */
638 *tty->termios = *old;
642 speed = tty_get_baud_rate(tty);
645 urb_val = SUSBCR_SBR_1200;
650 urb_val = SUSBCR_SBR_9600;
653 urb_val |= (c_cflag & CSTOPB) ? SUSBCR_SPASB_2StopBits :
654 SUSBCR_SPASB_1StopBit;
655 if (c_cflag & PARENB) {
656 if (c_cflag & PARODD)
657 urb_val |= SUSBCR_SPASB_OddParity;
659 urb_val |= SUSBCR_SPASB_EvenParity;
661 urb_val |= SUSBCR_SPASB_NoParity;
662 tty->termios->c_cflag &= ~CMSPAR;
663 tty_encode_baud_rate(tty, speed, speed);
665 result = usb_control_msg(port->serial->dev,
666 usb_rcvctrlpipe(port->serial->dev, 0),
667 SUSBCRequest_SetBaudRateParityAndStopBits,
668 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
677 static int kobil_ioctl(struct tty_struct *tty,
678 unsigned int cmd, unsigned long arg)
680 struct usb_serial_port *port = tty->driver_data;
681 struct kobil_private *priv = usb_get_serial_port_data(port);
682 unsigned char *transfer_buffer;
683 int transfer_buffer_length = 8;
686 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
687 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID)
688 /* This device doesn't support ioctl calls */
693 transfer_buffer = kmalloc(transfer_buffer_length, GFP_KERNEL);
694 if (!transfer_buffer)
697 result = usb_control_msg(port->serial->dev,
698 usb_rcvctrlpipe(port->serial->dev, 0),
700 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
701 SUSBCR_MSC_ResetAllQueues,
703 NULL, /* transfer_buffer, */
708 dbg("%s - port %d Send reset_all_queues (FLUSH) URB returns: %i", __func__, port->number, result);
709 kfree(transfer_buffer);
710 return (result < 0) ? -EIO: 0;
716 static int __init kobil_init(void)
719 retval = usb_serial_register(&kobil_device);
721 goto failed_usb_serial_register;
722 retval = usb_register(&kobil_driver);
724 goto failed_usb_register;
726 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
731 usb_serial_deregister(&kobil_device);
732 failed_usb_serial_register:
737 static void __exit kobil_exit(void)
739 usb_deregister(&kobil_driver);
740 usb_serial_deregister(&kobil_device);
743 module_init(kobil_init);
744 module_exit(kobil_exit);
746 MODULE_AUTHOR(DRIVER_AUTHOR);
747 MODULE_DESCRIPTION(DRIVER_DESC);
748 MODULE_LICENSE("GPL");
750 module_param(debug, bool, S_IRUGO | S_IWUSR);
751 MODULE_PARM_DESC(debug, "Debug enabled or not");