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 .disconnect = usb_serial_disconnect,
95 static struct usb_serial_driver kobil_device = {
100 .description = "KOBIL USB smart card terminal",
101 .id_table = id_table,
103 .attach = kobil_startup,
104 .release = kobil_release,
105 .ioctl = kobil_ioctl,
106 .set_termios = kobil_set_termios,
107 .init_termios = kobil_init_termios,
108 .tiocmget = kobil_tiocmget,
109 .tiocmset = kobil_tiocmset,
111 .close = kobil_close,
112 .write = kobil_write,
113 .write_room = kobil_write_room,
114 .read_int_callback = kobil_read_int_callback,
117 static struct usb_serial_driver * const serial_drivers[] = {
121 struct kobil_private {
122 int write_int_endpoint_address;
123 int read_int_endpoint_address;
124 unsigned char buf[KOBIL_BUF_LENGTH]; /* buffer for the APDU to send */
125 int filled; /* index of the last char in buf */
126 int cur_pos; /* index of the next char to send in buf */
131 static int kobil_startup(struct usb_serial *serial)
134 struct kobil_private *priv;
135 struct usb_device *pdev;
136 struct usb_host_config *actconfig;
137 struct usb_interface *interface;
138 struct usb_host_interface *altsetting;
139 struct usb_host_endpoint *endpoint;
141 priv = kmalloc(sizeof(struct kobil_private), GFP_KERNEL);
147 priv->device_type = le16_to_cpu(serial->dev->descriptor.idProduct);
149 switch (priv->device_type) {
150 case KOBIL_ADAPTER_B_PRODUCT_ID:
151 printk(KERN_DEBUG "KOBIL B1 PRO / KAAN PRO detected\n");
153 case KOBIL_ADAPTER_K_PRODUCT_ID:
155 "KOBIL KAAN Standard Plus / SecOVID Reader Plus detected\n");
157 case KOBIL_USBTWIN_PRODUCT_ID:
158 printk(KERN_DEBUG "KOBIL USBTWIN detected\n");
160 case KOBIL_KAAN_SIM_PRODUCT_ID:
161 printk(KERN_DEBUG "KOBIL KAAN SIM detected\n");
164 usb_set_serial_port_data(serial->port[0], priv);
166 /* search for the necessary endpoints */
168 actconfig = pdev->actconfig;
169 interface = actconfig->interface[0];
170 altsetting = interface->cur_altsetting;
171 endpoint = altsetting->endpoint;
173 for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
174 endpoint = &altsetting->endpoint[i];
175 if (usb_endpoint_is_int_out(&endpoint->desc)) {
176 dbg("%s Found interrupt out endpoint. Address: %d",
177 __func__, endpoint->desc.bEndpointAddress);
178 priv->write_int_endpoint_address =
179 endpoint->desc.bEndpointAddress;
181 if (usb_endpoint_is_int_in(&endpoint->desc)) {
182 dbg("%s Found interrupt in endpoint. Address: %d",
183 __func__, endpoint->desc.bEndpointAddress);
184 priv->read_int_endpoint_address =
185 endpoint->desc.bEndpointAddress;
192 static void kobil_release(struct usb_serial *serial)
196 for (i = 0; i < serial->num_ports; ++i)
197 kfree(usb_get_serial_port_data(serial->port[i]));
200 static void kobil_init_termios(struct tty_struct *tty)
202 /* Default to echo off and other sane device settings */
203 tty->termios->c_lflag = 0;
204 tty->termios->c_lflag &= ~(ISIG | ICANON | ECHO | IEXTEN | XCASE);
205 tty->termios->c_iflag = IGNBRK | IGNPAR | IXOFF;
206 /* do NOT translate CR to CR-NL (0x0A -> 0x0A 0x0D) */
207 tty->termios->c_oflag &= ~ONLCR;
210 static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port)
213 struct kobil_private *priv;
214 unsigned char *transfer_buffer;
215 int transfer_buffer_length = 8;
216 int write_urb_transfer_buffer_length = 8;
218 priv = usb_get_serial_port_data(port);
220 /* allocate memory for transfer buffer */
221 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
222 if (!transfer_buffer)
225 /* allocate write_urb */
226 if (!port->write_urb) {
227 dbg("%s - port %d Allocating port->write_urb",
228 __func__, port->number);
229 port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
230 if (!port->write_urb) {
231 dbg("%s - port %d usb_alloc_urb failed",
232 __func__, port->number);
233 kfree(transfer_buffer);
238 /* allocate memory for write_urb transfer buffer */
239 port->write_urb->transfer_buffer =
240 kmalloc(write_urb_transfer_buffer_length, GFP_KERNEL);
241 if (!port->write_urb->transfer_buffer) {
242 kfree(transfer_buffer);
243 usb_free_urb(port->write_urb);
244 port->write_urb = NULL;
248 /* get hardware version */
249 result = usb_control_msg(port->serial->dev,
250 usb_rcvctrlpipe(port->serial->dev, 0),
251 SUSBCRequest_GetMisc,
252 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
253 SUSBCR_MSC_GetHWVersion,
256 transfer_buffer_length,
259 dbg("%s - port %d Send get_HW_version URB returns: %i",
260 __func__, port->number, result);
261 dbg("Harware version: %i.%i.%i",
262 transfer_buffer[0], transfer_buffer[1], transfer_buffer[2]);
264 /* get firmware version */
265 result = usb_control_msg(port->serial->dev,
266 usb_rcvctrlpipe(port->serial->dev, 0),
267 SUSBCRequest_GetMisc,
268 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
269 SUSBCR_MSC_GetFWVersion,
272 transfer_buffer_length,
275 dbg("%s - port %d Send get_FW_version URB returns: %i",
276 __func__, port->number, result);
277 dbg("Firmware version: %i.%i.%i",
278 transfer_buffer[0], transfer_buffer[1], transfer_buffer[2]);
280 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
281 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
282 /* Setting Baudrate, Parity and Stopbits */
283 result = usb_control_msg(port->serial->dev,
284 usb_rcvctrlpipe(port->serial->dev, 0),
285 SUSBCRequest_SetBaudRateParityAndStopBits,
286 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
287 SUSBCR_SBR_9600 | SUSBCR_SPASB_EvenParity |
288 SUSBCR_SPASB_1StopBit,
294 dbg("%s - port %d Send set_baudrate URB returns: %i",
295 __func__, port->number, result);
297 /* reset all queues */
298 result = usb_control_msg(port->serial->dev,
299 usb_rcvctrlpipe(port->serial->dev, 0),
301 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
302 SUSBCR_MSC_ResetAllQueues,
308 dbg("%s - port %d Send reset_all_queues URB returns: %i",
309 __func__, port->number, result);
311 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
312 priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
313 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
314 /* start reading (Adapter B 'cause PNP string) */
315 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
316 dbg("%s - port %d Send read URB returns: %i",
317 __func__, port->number, result);
320 kfree(transfer_buffer);
325 static void kobil_close(struct usb_serial_port *port)
327 /* FIXME: Add rts/dtr methods */
328 if (port->write_urb) {
329 usb_poison_urb(port->write_urb);
330 kfree(port->write_urb->transfer_buffer);
331 usb_free_urb(port->write_urb);
332 port->write_urb = NULL;
334 usb_kill_urb(port->interrupt_in_urb);
338 static void kobil_read_int_callback(struct urb *urb)
341 struct usb_serial_port *port = urb->context;
342 struct tty_struct *tty;
343 unsigned char *data = urb->transfer_buffer;
344 int status = urb->status;
345 /* char *dbg_data; */
348 dbg("%s - port %d Read int status not zero: %d",
349 __func__, port->number, status);
353 tty = tty_port_tty_get(&port->port);
354 if (tty && urb->actual_length) {
358 dbg_data = kzalloc((3 * purb->actual_length + 10)
359 * sizeof(char), GFP_KERNEL);
363 for (i = 0; i < purb->actual_length; i++) {
364 sprintf(dbg_data +3*i, "%02X ", data[i]);
366 dbg(" <-- %s", dbg_data);
371 tty_insert_flip_string(tty, data, urb->actual_length);
372 tty_flip_buffer_push(tty);
376 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
377 dbg("%s - port %d Send read URB returns: %i",
378 __func__, port->number, result);
382 static void kobil_write_callback(struct urb *purb)
387 static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
388 const unsigned char *buf, int count)
393 struct kobil_private *priv;
396 dbg("%s - port %d write request of 0 bytes",
397 __func__, port->number);
401 priv = usb_get_serial_port_data(port);
403 if (count > (KOBIL_BUF_LENGTH - priv->filled)) {
404 dbg("%s - port %d Error: write request bigger than buffer size", __func__, port->number);
408 /* Copy data to buffer */
409 memcpy(priv->buf + priv->filled, buf, count);
410 usb_serial_debug_data(debug, &port->dev, __func__, count,
411 priv->buf + priv->filled);
412 priv->filled = priv->filled + count;
414 /* only send complete block. TWIN, KAAN SIM and adapter K
415 use the same protocol. */
416 if (((priv->device_type != KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 2) && (priv->filled >= (priv->buf[1] + 3))) ||
417 ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 3) && (priv->filled >= (priv->buf[2] + 4)))) {
418 /* stop reading (except TWIN and KAAN SIM) */
419 if ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID)
420 || (priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID))
421 usb_kill_urb(port->interrupt_in_urb);
423 todo = priv->filled - priv->cur_pos;
426 /* max 8 byte in one urb (endpoint size) */
427 length = (todo < 8) ? todo : 8;
428 /* copy data to transfer buffer */
429 memcpy(port->write_urb->transfer_buffer,
430 priv->buf + priv->cur_pos, length);
431 usb_fill_int_urb(port->write_urb,
433 usb_sndintpipe(port->serial->dev,
434 priv->write_int_endpoint_address),
435 port->write_urb->transfer_buffer,
437 kobil_write_callback,
442 priv->cur_pos = priv->cur_pos + length;
443 result = usb_submit_urb(port->write_urb, GFP_NOIO);
444 dbg("%s - port %d Send write URB returns: %i",
445 __func__, port->number, result);
446 todo = priv->filled - priv->cur_pos;
455 /* start reading (except TWIN and KAAN SIM) */
456 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
457 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
458 result = usb_submit_urb(port->interrupt_in_urb,
460 dbg("%s - port %d Send read URB returns: %i",
461 __func__, port->number, result);
468 static int kobil_write_room(struct tty_struct *tty)
475 static int kobil_tiocmget(struct tty_struct *tty)
477 struct usb_serial_port *port = tty->driver_data;
478 struct kobil_private *priv;
480 unsigned char *transfer_buffer;
481 int transfer_buffer_length = 8;
483 priv = usb_get_serial_port_data(port);
484 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
485 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
486 /* This device doesn't support ioctl calls */
490 /* allocate memory for transfer buffer */
491 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
492 if (!transfer_buffer)
495 result = usb_control_msg(port->serial->dev,
496 usb_rcvctrlpipe(port->serial->dev, 0),
497 SUSBCRequest_GetStatusLineState,
498 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
502 transfer_buffer_length,
505 dbg("%s - port %d Send get_status_line_state URB returns: %i. Statusline: %02x",
506 __func__, port->number, result, transfer_buffer[0]);
509 if ((transfer_buffer[0] & SUSBCR_GSL_DSR) != 0)
511 kfree(transfer_buffer);
515 static int kobil_tiocmset(struct tty_struct *tty,
516 unsigned int set, unsigned int clear)
518 struct usb_serial_port *port = tty->driver_data;
519 struct kobil_private *priv;
523 unsigned char *transfer_buffer;
524 int transfer_buffer_length = 8;
526 /* FIXME: locking ? */
527 priv = usb_get_serial_port_data(port);
528 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
529 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
530 /* This device doesn't support ioctl calls */
534 /* allocate memory for transfer buffer */
535 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
536 if (!transfer_buffer)
543 if (clear & TIOCM_RTS)
545 if (clear & TIOCM_DTR)
548 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) {
550 dbg("%s - port %d Setting DTR",
551 __func__, port->number);
553 dbg("%s - port %d Clearing DTR",
554 __func__, port->number);
555 result = usb_control_msg(port->serial->dev,
556 usb_rcvctrlpipe(port->serial->dev, 0),
557 SUSBCRequest_SetStatusLinesOrQueues,
558 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
559 ((dtr != 0) ? SUSBCR_SSL_SETDTR : SUSBCR_SSL_CLRDTR),
566 dbg("%s - port %d Setting RTS",
567 __func__, port->number);
569 dbg("%s - port %d Clearing RTS",
570 __func__, port->number);
571 result = usb_control_msg(port->serial->dev,
572 usb_rcvctrlpipe(port->serial->dev, 0),
573 SUSBCRequest_SetStatusLinesOrQueues,
574 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
575 ((rts != 0) ? SUSBCR_SSL_SETRTS : SUSBCR_SSL_CLRRTS),
581 dbg("%s - port %d Send set_status_line URB returns: %i",
582 __func__, port->number, result);
583 kfree(transfer_buffer);
584 return (result < 0) ? result : 0;
587 static void kobil_set_termios(struct tty_struct *tty,
588 struct usb_serial_port *port, struct ktermios *old)
590 struct kobil_private *priv;
592 unsigned short urb_val = 0;
593 int c_cflag = tty->termios->c_cflag;
596 priv = usb_get_serial_port_data(port);
597 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
598 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
599 /* This device doesn't support ioctl calls */
600 *tty->termios = *old;
604 speed = tty_get_baud_rate(tty);
607 urb_val = SUSBCR_SBR_1200;
612 urb_val = SUSBCR_SBR_9600;
615 urb_val |= (c_cflag & CSTOPB) ? SUSBCR_SPASB_2StopBits :
616 SUSBCR_SPASB_1StopBit;
617 if (c_cflag & PARENB) {
618 if (c_cflag & PARODD)
619 urb_val |= SUSBCR_SPASB_OddParity;
621 urb_val |= SUSBCR_SPASB_EvenParity;
623 urb_val |= SUSBCR_SPASB_NoParity;
624 tty->termios->c_cflag &= ~CMSPAR;
625 tty_encode_baud_rate(tty, speed, speed);
627 result = usb_control_msg(port->serial->dev,
628 usb_rcvctrlpipe(port->serial->dev, 0),
629 SUSBCRequest_SetBaudRateParityAndStopBits,
630 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
639 static int kobil_ioctl(struct tty_struct *tty,
640 unsigned int cmd, unsigned long arg)
642 struct usb_serial_port *port = tty->driver_data;
643 struct kobil_private *priv = usb_get_serial_port_data(port);
644 unsigned char *transfer_buffer;
645 int transfer_buffer_length = 8;
648 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
649 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID)
650 /* This device doesn't support ioctl calls */
655 transfer_buffer = kmalloc(transfer_buffer_length, GFP_KERNEL);
656 if (!transfer_buffer)
659 result = usb_control_msg(port->serial->dev,
660 usb_rcvctrlpipe(port->serial->dev, 0),
662 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
663 SUSBCR_MSC_ResetAllQueues,
665 NULL, /* transfer_buffer, */
670 dbg("%s - port %d Send reset_all_queues (FLUSH) URB returns: %i", __func__, port->number, result);
671 kfree(transfer_buffer);
672 return (result < 0) ? -EIO: 0;
678 module_usb_serial_driver(kobil_driver, serial_drivers);
680 MODULE_AUTHOR(DRIVER_AUTHOR);
681 MODULE_DESCRIPTION(DRIVER_DESC);
682 MODULE_LICENSE("GPL");
684 module_param(debug, bool, S_IRUGO | S_IWUSR);
685 MODULE_PARM_DESC(debug, "Debug enabled or not");