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 = {
90 .probe = usb_serial_probe,
91 .disconnect = usb_serial_disconnect,
96 static struct usb_serial_driver kobil_device = {
101 .description = "KOBIL USB smart card terminal",
102 .id_table = id_table,
104 .attach = kobil_startup,
105 .release = kobil_release,
106 .ioctl = kobil_ioctl,
107 .set_termios = kobil_set_termios,
108 .init_termios = kobil_init_termios,
109 .tiocmget = kobil_tiocmget,
110 .tiocmset = kobil_tiocmset,
112 .close = kobil_close,
113 .write = kobil_write,
114 .write_room = kobil_write_room,
115 .read_int_callback = kobil_read_int_callback,
118 static struct usb_serial_driver * const serial_drivers[] = {
122 struct kobil_private {
123 int write_int_endpoint_address;
124 int read_int_endpoint_address;
125 unsigned char buf[KOBIL_BUF_LENGTH]; /* buffer for the APDU to send */
126 int filled; /* index of the last char in buf */
127 int cur_pos; /* index of the next char to send in buf */
132 static int kobil_startup(struct usb_serial *serial)
135 struct kobil_private *priv;
136 struct usb_device *pdev;
137 struct usb_host_config *actconfig;
138 struct usb_interface *interface;
139 struct usb_host_interface *altsetting;
140 struct usb_host_endpoint *endpoint;
142 priv = kmalloc(sizeof(struct kobil_private), GFP_KERNEL);
148 priv->device_type = le16_to_cpu(serial->dev->descriptor.idProduct);
150 switch (priv->device_type) {
151 case KOBIL_ADAPTER_B_PRODUCT_ID:
152 printk(KERN_DEBUG "KOBIL B1 PRO / KAAN PRO detected\n");
154 case KOBIL_ADAPTER_K_PRODUCT_ID:
156 "KOBIL KAAN Standard Plus / SecOVID Reader Plus detected\n");
158 case KOBIL_USBTWIN_PRODUCT_ID:
159 printk(KERN_DEBUG "KOBIL USBTWIN detected\n");
161 case KOBIL_KAAN_SIM_PRODUCT_ID:
162 printk(KERN_DEBUG "KOBIL KAAN SIM detected\n");
165 usb_set_serial_port_data(serial->port[0], priv);
167 /* search for the necessary endpoints */
169 actconfig = pdev->actconfig;
170 interface = actconfig->interface[0];
171 altsetting = interface->cur_altsetting;
172 endpoint = altsetting->endpoint;
174 for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
175 endpoint = &altsetting->endpoint[i];
176 if (usb_endpoint_is_int_out(&endpoint->desc)) {
177 dbg("%s Found interrupt out endpoint. Address: %d",
178 __func__, endpoint->desc.bEndpointAddress);
179 priv->write_int_endpoint_address =
180 endpoint->desc.bEndpointAddress;
182 if (usb_endpoint_is_int_in(&endpoint->desc)) {
183 dbg("%s Found interrupt in endpoint. Address: %d",
184 __func__, endpoint->desc.bEndpointAddress);
185 priv->read_int_endpoint_address =
186 endpoint->desc.bEndpointAddress;
193 static void kobil_release(struct usb_serial *serial)
196 dbg("%s - port %d", __func__, serial->port[0]->number);
198 for (i = 0; i < serial->num_ports; ++i)
199 kfree(usb_get_serial_port_data(serial->port[i]));
202 static void kobil_init_termios(struct tty_struct *tty)
204 /* Default to echo off and other sane device settings */
205 tty->termios->c_lflag = 0;
206 tty->termios->c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN | XCASE);
207 tty->termios->c_iflag = IGNBRK | IGNPAR | IXOFF;
208 /* do NOT translate CR to CR-NL (0x0A -> 0x0A 0x0D) */
209 tty->termios->c_oflag &= ~ONLCR;
212 static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port)
215 struct kobil_private *priv;
216 unsigned char *transfer_buffer;
217 int transfer_buffer_length = 8;
218 int write_urb_transfer_buffer_length = 8;
220 dbg("%s - port %d", __func__, port->number);
221 priv = usb_get_serial_port_data(port);
223 /* allocate memory for transfer buffer */
224 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
225 if (!transfer_buffer)
228 /* allocate write_urb */
229 if (!port->write_urb) {
230 dbg("%s - port %d Allocating port->write_urb",
231 __func__, port->number);
232 port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
233 if (!port->write_urb) {
234 dbg("%s - port %d usb_alloc_urb failed",
235 __func__, port->number);
236 kfree(transfer_buffer);
241 /* allocate memory for write_urb transfer buffer */
242 port->write_urb->transfer_buffer =
243 kmalloc(write_urb_transfer_buffer_length, GFP_KERNEL);
244 if (!port->write_urb->transfer_buffer) {
245 kfree(transfer_buffer);
246 usb_free_urb(port->write_urb);
247 port->write_urb = NULL;
251 /* get hardware version */
252 result = usb_control_msg(port->serial->dev,
253 usb_rcvctrlpipe(port->serial->dev, 0),
254 SUSBCRequest_GetMisc,
255 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
256 SUSBCR_MSC_GetHWVersion,
259 transfer_buffer_length,
262 dbg("%s - port %d Send get_HW_version URB returns: %i",
263 __func__, port->number, result);
264 dbg("Harware version: %i.%i.%i",
265 transfer_buffer[0], transfer_buffer[1], transfer_buffer[2]);
267 /* get firmware version */
268 result = usb_control_msg(port->serial->dev,
269 usb_rcvctrlpipe(port->serial->dev, 0),
270 SUSBCRequest_GetMisc,
271 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
272 SUSBCR_MSC_GetFWVersion,
275 transfer_buffer_length,
278 dbg("%s - port %d Send get_FW_version URB returns: %i",
279 __func__, port->number, result);
280 dbg("Firmware version: %i.%i.%i",
281 transfer_buffer[0], transfer_buffer[1], transfer_buffer[2]);
283 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
284 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
285 /* Setting Baudrate, Parity and Stopbits */
286 result = usb_control_msg(port->serial->dev,
287 usb_rcvctrlpipe(port->serial->dev, 0),
288 SUSBCRequest_SetBaudRateParityAndStopBits,
289 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
290 SUSBCR_SBR_9600 | SUSBCR_SPASB_EvenParity |
291 SUSBCR_SPASB_1StopBit,
297 dbg("%s - port %d Send set_baudrate URB returns: %i",
298 __func__, port->number, result);
300 /* reset all queues */
301 result = usb_control_msg(port->serial->dev,
302 usb_rcvctrlpipe(port->serial->dev, 0),
304 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
305 SUSBCR_MSC_ResetAllQueues,
311 dbg("%s - port %d Send reset_all_queues URB returns: %i",
312 __func__, port->number, result);
314 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
315 priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
316 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
317 /* start reading (Adapter B 'cause PNP string) */
318 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
319 dbg("%s - port %d Send read URB returns: %i",
320 __func__, port->number, result);
323 kfree(transfer_buffer);
328 static void kobil_close(struct usb_serial_port *port)
330 dbg("%s - port %d", __func__, port->number);
332 /* FIXME: Add rts/dtr methods */
333 if (port->write_urb) {
334 usb_poison_urb(port->write_urb);
335 kfree(port->write_urb->transfer_buffer);
336 usb_free_urb(port->write_urb);
337 port->write_urb = NULL;
339 usb_kill_urb(port->interrupt_in_urb);
343 static void kobil_read_int_callback(struct urb *urb)
346 struct usb_serial_port *port = urb->context;
347 struct tty_struct *tty;
348 unsigned char *data = urb->transfer_buffer;
349 int status = urb->status;
350 /* char *dbg_data; */
352 dbg("%s - port %d", __func__, port->number);
355 dbg("%s - port %d Read int status not zero: %d",
356 __func__, port->number, status);
360 tty = tty_port_tty_get(&port->port);
361 if (tty && urb->actual_length) {
365 dbg_data = kzalloc((3 * purb->actual_length + 10)
366 * sizeof(char), GFP_KERNEL);
370 for (i = 0; i < purb->actual_length; i++) {
371 sprintf(dbg_data +3*i, "%02X ", data[i]);
373 dbg(" <-- %s", dbg_data);
378 tty_insert_flip_string(tty, data, urb->actual_length);
379 tty_flip_buffer_push(tty);
383 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
384 dbg("%s - port %d Send read URB returns: %i",
385 __func__, port->number, result);
389 static void kobil_write_callback(struct urb *purb)
394 static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
395 const unsigned char *buf, int count)
400 struct kobil_private *priv;
403 dbg("%s - port %d write request of 0 bytes",
404 __func__, port->number);
408 priv = usb_get_serial_port_data(port);
410 if (count > (KOBIL_BUF_LENGTH - priv->filled)) {
411 dbg("%s - port %d Error: write request bigger than buffer size", __func__, port->number);
415 /* Copy data to buffer */
416 memcpy(priv->buf + priv->filled, buf, count);
417 usb_serial_debug_data(debug, &port->dev, __func__, count,
418 priv->buf + priv->filled);
419 priv->filled = priv->filled + count;
421 /* only send complete block. TWIN, KAAN SIM and adapter K
422 use the same protocol. */
423 if (((priv->device_type != KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 2) && (priv->filled >= (priv->buf[1] + 3))) ||
424 ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 3) && (priv->filled >= (priv->buf[2] + 4)))) {
425 /* stop reading (except TWIN and KAAN SIM) */
426 if ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID)
427 || (priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID))
428 usb_kill_urb(port->interrupt_in_urb);
430 todo = priv->filled - priv->cur_pos;
433 /* max 8 byte in one urb (endpoint size) */
434 length = (todo < 8) ? todo : 8;
435 /* copy data to transfer buffer */
436 memcpy(port->write_urb->transfer_buffer,
437 priv->buf + priv->cur_pos, length);
438 usb_fill_int_urb(port->write_urb,
440 usb_sndintpipe(port->serial->dev,
441 priv->write_int_endpoint_address),
442 port->write_urb->transfer_buffer,
444 kobil_write_callback,
449 priv->cur_pos = priv->cur_pos + length;
450 result = usb_submit_urb(port->write_urb, GFP_NOIO);
451 dbg("%s - port %d Send write URB returns: %i",
452 __func__, port->number, result);
453 todo = priv->filled - priv->cur_pos;
462 /* start reading (except TWIN and KAAN SIM) */
463 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
464 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
465 result = usb_submit_urb(port->interrupt_in_urb,
467 dbg("%s - port %d Send read URB returns: %i",
468 __func__, port->number, result);
475 static int kobil_write_room(struct tty_struct *tty)
477 /* dbg("%s - port %d", __func__, port->number); */
483 static int kobil_tiocmget(struct tty_struct *tty)
485 struct usb_serial_port *port = tty->driver_data;
486 struct kobil_private *priv;
488 unsigned char *transfer_buffer;
489 int transfer_buffer_length = 8;
491 priv = usb_get_serial_port_data(port);
492 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
493 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
494 /* This device doesn't support ioctl calls */
498 /* allocate memory for transfer buffer */
499 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
500 if (!transfer_buffer)
503 result = usb_control_msg(port->serial->dev,
504 usb_rcvctrlpipe(port->serial->dev, 0),
505 SUSBCRequest_GetStatusLineState,
506 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
510 transfer_buffer_length,
513 dbg("%s - port %d Send get_status_line_state URB returns: %i. Statusline: %02x",
514 __func__, port->number, result, transfer_buffer[0]);
517 if ((transfer_buffer[0] & SUSBCR_GSL_DSR) != 0)
519 kfree(transfer_buffer);
523 static int kobil_tiocmset(struct tty_struct *tty,
524 unsigned int set, unsigned int clear)
526 struct usb_serial_port *port = tty->driver_data;
527 struct kobil_private *priv;
531 unsigned char *transfer_buffer;
532 int transfer_buffer_length = 8;
534 /* FIXME: locking ? */
535 priv = usb_get_serial_port_data(port);
536 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
537 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
538 /* This device doesn't support ioctl calls */
542 /* allocate memory for transfer buffer */
543 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
544 if (!transfer_buffer)
551 if (clear & TIOCM_RTS)
553 if (clear & TIOCM_DTR)
556 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) {
558 dbg("%s - port %d Setting DTR",
559 __func__, port->number);
561 dbg("%s - port %d Clearing DTR",
562 __func__, port->number);
563 result = usb_control_msg(port->serial->dev,
564 usb_rcvctrlpipe(port->serial->dev, 0),
565 SUSBCRequest_SetStatusLinesOrQueues,
566 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
567 ((dtr != 0) ? SUSBCR_SSL_SETDTR : SUSBCR_SSL_CLRDTR),
574 dbg("%s - port %d Setting RTS",
575 __func__, port->number);
577 dbg("%s - port %d Clearing RTS",
578 __func__, port->number);
579 result = usb_control_msg(port->serial->dev,
580 usb_rcvctrlpipe(port->serial->dev, 0),
581 SUSBCRequest_SetStatusLinesOrQueues,
582 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
583 ((rts != 0) ? SUSBCR_SSL_SETRTS : SUSBCR_SSL_CLRRTS),
589 dbg("%s - port %d Send set_status_line URB returns: %i",
590 __func__, port->number, result);
591 kfree(transfer_buffer);
592 return (result < 0) ? result : 0;
595 static void kobil_set_termios(struct tty_struct *tty,
596 struct usb_serial_port *port, struct ktermios *old)
598 struct kobil_private *priv;
600 unsigned short urb_val = 0;
601 int c_cflag = tty->termios->c_cflag;
604 priv = usb_get_serial_port_data(port);
605 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
606 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
607 /* This device doesn't support ioctl calls */
608 *tty->termios = *old;
612 speed = tty_get_baud_rate(tty);
615 urb_val = SUSBCR_SBR_1200;
620 urb_val = SUSBCR_SBR_9600;
623 urb_val |= (c_cflag & CSTOPB) ? SUSBCR_SPASB_2StopBits :
624 SUSBCR_SPASB_1StopBit;
625 if (c_cflag & PARENB) {
626 if (c_cflag & PARODD)
627 urb_val |= SUSBCR_SPASB_OddParity;
629 urb_val |= SUSBCR_SPASB_EvenParity;
631 urb_val |= SUSBCR_SPASB_NoParity;
632 tty->termios->c_cflag &= ~CMSPAR;
633 tty_encode_baud_rate(tty, speed, speed);
635 result = usb_control_msg(port->serial->dev,
636 usb_rcvctrlpipe(port->serial->dev, 0),
637 SUSBCRequest_SetBaudRateParityAndStopBits,
638 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
647 static int kobil_ioctl(struct tty_struct *tty,
648 unsigned int cmd, unsigned long arg)
650 struct usb_serial_port *port = tty->driver_data;
651 struct kobil_private *priv = usb_get_serial_port_data(port);
652 unsigned char *transfer_buffer;
653 int transfer_buffer_length = 8;
656 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
657 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID)
658 /* This device doesn't support ioctl calls */
663 transfer_buffer = kmalloc(transfer_buffer_length, GFP_KERNEL);
664 if (!transfer_buffer)
667 result = usb_control_msg(port->serial->dev,
668 usb_rcvctrlpipe(port->serial->dev, 0),
670 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
671 SUSBCR_MSC_ResetAllQueues,
673 NULL, /* transfer_buffer, */
678 dbg("%s - port %d Send reset_all_queues (FLUSH) URB returns: %i", __func__, port->number, result);
679 kfree(transfer_buffer);
680 return (result < 0) ? -EIO: 0;
686 module_usb_serial_driver(kobil_driver, serial_drivers);
688 MODULE_AUTHOR(DRIVER_AUTHOR);
689 MODULE_DESCRIPTION(DRIVER_DESC);
690 MODULE_LICENSE("GPL");
692 module_param(debug, bool, S_IRUGO | S_IWUSR);
693 MODULE_PARM_DESC(debug, "Debug enabled or not");