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"
41 #define DRIVER_AUTHOR "KOBIL Systems GmbH - http://www.kobil.com"
42 #define DRIVER_DESC "KOBIL USB Smart Card Terminal Driver (experimental)"
44 #define KOBIL_VENDOR_ID 0x0D46
45 #define KOBIL_ADAPTER_B_PRODUCT_ID 0x2011
46 #define KOBIL_ADAPTER_K_PRODUCT_ID 0x2012
47 #define KOBIL_USBTWIN_PRODUCT_ID 0x0078
48 #define KOBIL_KAAN_SIM_PRODUCT_ID 0x0081
50 #define KOBIL_TIMEOUT 500
51 #define KOBIL_BUF_LENGTH 300
54 /* Function prototypes */
55 static int kobil_port_probe(struct usb_serial_port *probe);
56 static int kobil_port_remove(struct usb_serial_port *probe);
57 static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port);
58 static void kobil_close(struct usb_serial_port *port);
59 static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
60 const unsigned char *buf, int count);
61 static int kobil_write_room(struct tty_struct *tty);
62 static int kobil_ioctl(struct tty_struct *tty,
63 unsigned int cmd, unsigned long arg);
64 static int kobil_tiocmget(struct tty_struct *tty);
65 static int kobil_tiocmset(struct tty_struct *tty,
66 unsigned int set, unsigned int clear);
67 static void kobil_read_int_callback(struct urb *urb);
68 static void kobil_write_callback(struct urb *purb);
69 static void kobil_set_termios(struct tty_struct *tty,
70 struct usb_serial_port *port, struct ktermios *old);
71 static void kobil_init_termios(struct tty_struct *tty);
73 static const struct usb_device_id id_table[] = {
74 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_ADAPTER_B_PRODUCT_ID) },
75 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_ADAPTER_K_PRODUCT_ID) },
76 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_USBTWIN_PRODUCT_ID) },
77 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_KAAN_SIM_PRODUCT_ID) },
78 { } /* Terminating entry */
80 MODULE_DEVICE_TABLE(usb, id_table);
82 static struct usb_serial_driver kobil_device = {
87 .description = "KOBIL USB smart card terminal",
90 .port_probe = kobil_port_probe,
91 .port_remove = kobil_port_remove,
93 .set_termios = kobil_set_termios,
94 .init_termios = kobil_init_termios,
95 .tiocmget = kobil_tiocmget,
96 .tiocmset = kobil_tiocmset,
100 .write_room = kobil_write_room,
101 .read_int_callback = kobil_read_int_callback,
104 static struct usb_serial_driver * const serial_drivers[] = {
108 struct kobil_private {
109 int write_int_endpoint_address;
110 unsigned char buf[KOBIL_BUF_LENGTH]; /* buffer for the APDU to send */
111 int filled; /* index of the last char in buf */
112 int cur_pos; /* index of the next char to send in buf */
117 static int kobil_port_probe(struct usb_serial_port *port)
120 struct usb_serial *serial = port->serial;
121 struct kobil_private *priv;
122 struct usb_device *pdev;
123 struct usb_host_config *actconfig;
124 struct usb_interface *interface;
125 struct usb_host_interface *altsetting;
126 struct usb_host_endpoint *endpoint;
128 priv = kmalloc(sizeof(struct kobil_private), GFP_KERNEL);
134 priv->device_type = le16_to_cpu(serial->dev->descriptor.idProduct);
136 switch (priv->device_type) {
137 case KOBIL_ADAPTER_B_PRODUCT_ID:
138 dev_dbg(&serial->dev->dev, "KOBIL B1 PRO / KAAN PRO detected\n");
140 case KOBIL_ADAPTER_K_PRODUCT_ID:
141 dev_dbg(&serial->dev->dev, "KOBIL KAAN Standard Plus / SecOVID Reader Plus detected\n");
143 case KOBIL_USBTWIN_PRODUCT_ID:
144 dev_dbg(&serial->dev->dev, "KOBIL USBTWIN detected\n");
146 case KOBIL_KAAN_SIM_PRODUCT_ID:
147 dev_dbg(&serial->dev->dev, "KOBIL KAAN SIM detected\n");
150 usb_set_serial_port_data(port, priv);
152 /* search for the necessary endpoints */
154 actconfig = pdev->actconfig;
155 interface = actconfig->interface[0];
156 altsetting = interface->cur_altsetting;
157 endpoint = altsetting->endpoint;
159 for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
160 endpoint = &altsetting->endpoint[i];
161 if (usb_endpoint_is_int_out(&endpoint->desc)) {
162 dev_dbg(&serial->dev->dev,
163 "%s Found interrupt out endpoint. Address: %d\n",
164 __func__, endpoint->desc.bEndpointAddress);
165 priv->write_int_endpoint_address =
166 endpoint->desc.bEndpointAddress;
173 static int kobil_port_remove(struct usb_serial_port *port)
175 struct kobil_private *priv;
177 priv = usb_get_serial_port_data(port);
183 static void kobil_init_termios(struct tty_struct *tty)
185 /* Default to echo off and other sane device settings */
186 tty->termios.c_lflag = 0;
187 tty->termios.c_iflag &= ~(ISIG | ICANON | ECHO | IEXTEN | XCASE);
188 tty->termios.c_iflag |= IGNBRK | IGNPAR | IXOFF;
189 /* do NOT translate CR to CR-NL (0x0A -> 0x0A 0x0D) */
190 tty->termios.c_oflag &= ~ONLCR;
193 static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port)
195 struct device *dev = &port->dev;
197 struct kobil_private *priv;
198 unsigned char *transfer_buffer;
199 int transfer_buffer_length = 8;
200 int write_urb_transfer_buffer_length = 8;
202 priv = usb_get_serial_port_data(port);
204 /* allocate memory for transfer buffer */
205 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
206 if (!transfer_buffer)
209 /* allocate write_urb */
210 if (!port->write_urb) {
211 dev_dbg(dev, "%s - Allocating port->write_urb\n", __func__);
212 port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
213 if (!port->write_urb) {
214 dev_dbg(dev, "%s - usb_alloc_urb failed\n", __func__);
215 kfree(transfer_buffer);
220 /* allocate memory for write_urb transfer buffer */
221 port->write_urb->transfer_buffer =
222 kmalloc(write_urb_transfer_buffer_length, GFP_KERNEL);
223 if (!port->write_urb->transfer_buffer) {
224 kfree(transfer_buffer);
225 usb_free_urb(port->write_urb);
226 port->write_urb = NULL;
230 /* get hardware version */
231 result = usb_control_msg(port->serial->dev,
232 usb_rcvctrlpipe(port->serial->dev, 0),
233 SUSBCRequest_GetMisc,
234 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
235 SUSBCR_MSC_GetHWVersion,
238 transfer_buffer_length,
241 dev_dbg(dev, "%s - Send get_HW_version URB returns: %i\n", __func__, result);
242 dev_dbg(dev, "Harware version: %i.%i.%i\n", transfer_buffer[0],
243 transfer_buffer[1], transfer_buffer[2]);
245 /* get firmware version */
246 result = usb_control_msg(port->serial->dev,
247 usb_rcvctrlpipe(port->serial->dev, 0),
248 SUSBCRequest_GetMisc,
249 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
250 SUSBCR_MSC_GetFWVersion,
253 transfer_buffer_length,
256 dev_dbg(dev, "%s - Send get_FW_version URB returns: %i\n", __func__, result);
257 dev_dbg(dev, "Firmware version: %i.%i.%i\n", transfer_buffer[0],
258 transfer_buffer[1], transfer_buffer[2]);
260 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
261 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
262 /* Setting Baudrate, Parity and Stopbits */
263 result = usb_control_msg(port->serial->dev,
264 usb_rcvctrlpipe(port->serial->dev, 0),
265 SUSBCRequest_SetBaudRateParityAndStopBits,
266 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
267 SUSBCR_SBR_9600 | SUSBCR_SPASB_EvenParity |
268 SUSBCR_SPASB_1StopBit,
274 dev_dbg(dev, "%s - Send set_baudrate URB returns: %i\n", __func__, result);
276 /* reset all queues */
277 result = usb_control_msg(port->serial->dev,
278 usb_rcvctrlpipe(port->serial->dev, 0),
280 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
281 SUSBCR_MSC_ResetAllQueues,
287 dev_dbg(dev, "%s - Send reset_all_queues URB returns: %i\n", __func__, result);
289 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
290 priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
291 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
292 /* start reading (Adapter B 'cause PNP string) */
293 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
294 dev_dbg(dev, "%s - Send read URB returns: %i\n", __func__, result);
297 kfree(transfer_buffer);
302 static void kobil_close(struct usb_serial_port *port)
304 /* FIXME: Add rts/dtr methods */
305 if (port->write_urb) {
306 usb_poison_urb(port->write_urb);
307 kfree(port->write_urb->transfer_buffer);
308 usb_free_urb(port->write_urb);
309 port->write_urb = NULL;
311 usb_kill_urb(port->interrupt_in_urb);
315 static void kobil_read_int_callback(struct urb *urb)
318 struct usb_serial_port *port = urb->context;
319 unsigned char *data = urb->transfer_buffer;
320 int status = urb->status;
323 dev_dbg(&port->dev, "%s - Read int status not zero: %d\n", __func__, status);
327 if (urb->actual_length) {
328 usb_serial_debug_data(&port->dev, __func__, urb->actual_length,
330 tty_insert_flip_string(&port->port, data, urb->actual_length);
331 tty_flip_buffer_push(&port->port);
334 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
335 dev_dbg(&port->dev, "%s - Send read URB returns: %i\n", __func__, result);
339 static void kobil_write_callback(struct urb *purb)
344 static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
345 const unsigned char *buf, int count)
350 struct kobil_private *priv;
353 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
357 priv = usb_get_serial_port_data(port);
359 if (count > (KOBIL_BUF_LENGTH - priv->filled)) {
360 dev_dbg(&port->dev, "%s - Error: write request bigger than buffer size\n", __func__);
364 /* Copy data to buffer */
365 memcpy(priv->buf + priv->filled, buf, count);
366 usb_serial_debug_data(&port->dev, __func__, count, priv->buf + priv->filled);
367 priv->filled = priv->filled + count;
369 /* only send complete block. TWIN, KAAN SIM and adapter K
370 use the same protocol. */
371 if (((priv->device_type != KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 2) && (priv->filled >= (priv->buf[1] + 3))) ||
372 ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 3) && (priv->filled >= (priv->buf[2] + 4)))) {
373 /* stop reading (except TWIN and KAAN SIM) */
374 if ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID)
375 || (priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID))
376 usb_kill_urb(port->interrupt_in_urb);
378 todo = priv->filled - priv->cur_pos;
381 /* max 8 byte in one urb (endpoint size) */
382 length = (todo < 8) ? todo : 8;
383 /* copy data to transfer buffer */
384 memcpy(port->write_urb->transfer_buffer,
385 priv->buf + priv->cur_pos, length);
386 usb_fill_int_urb(port->write_urb,
388 usb_sndintpipe(port->serial->dev,
389 priv->write_int_endpoint_address),
390 port->write_urb->transfer_buffer,
392 kobil_write_callback,
397 priv->cur_pos = priv->cur_pos + length;
398 result = usb_submit_urb(port->write_urb, GFP_NOIO);
399 dev_dbg(&port->dev, "%s - Send write URB returns: %i\n", __func__, result);
400 todo = priv->filled - priv->cur_pos;
409 /* start reading (except TWIN and KAAN SIM) */
410 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
411 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
412 result = usb_submit_urb(port->interrupt_in_urb,
414 dev_dbg(&port->dev, "%s - Send read URB returns: %i\n", __func__, result);
421 static int kobil_write_room(struct tty_struct *tty)
428 static int kobil_tiocmget(struct tty_struct *tty)
430 struct usb_serial_port *port = tty->driver_data;
431 struct kobil_private *priv;
433 unsigned char *transfer_buffer;
434 int transfer_buffer_length = 8;
436 priv = usb_get_serial_port_data(port);
437 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
438 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
439 /* This device doesn't support ioctl calls */
443 /* allocate memory for transfer buffer */
444 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
445 if (!transfer_buffer)
448 result = usb_control_msg(port->serial->dev,
449 usb_rcvctrlpipe(port->serial->dev, 0),
450 SUSBCRequest_GetStatusLineState,
451 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
455 transfer_buffer_length,
458 dev_dbg(&port->dev, "%s - Send get_status_line_state URB returns: %i. Statusline: %02x\n",
459 __func__, result, transfer_buffer[0]);
462 if ((transfer_buffer[0] & SUSBCR_GSL_DSR) != 0)
464 kfree(transfer_buffer);
468 static int kobil_tiocmset(struct tty_struct *tty,
469 unsigned int set, unsigned int clear)
471 struct usb_serial_port *port = tty->driver_data;
472 struct device *dev = &port->dev;
473 struct kobil_private *priv;
477 unsigned char *transfer_buffer;
478 int transfer_buffer_length = 8;
480 /* FIXME: locking ? */
481 priv = usb_get_serial_port_data(port);
482 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
483 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
484 /* This device doesn't support ioctl calls */
488 /* allocate memory for transfer buffer */
489 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
490 if (!transfer_buffer)
497 if (clear & TIOCM_RTS)
499 if (clear & TIOCM_DTR)
502 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) {
504 dev_dbg(dev, "%s - Setting DTR\n", __func__);
506 dev_dbg(dev, "%s - Clearing DTR\n", __func__);
507 result = usb_control_msg(port->serial->dev,
508 usb_rcvctrlpipe(port->serial->dev, 0),
509 SUSBCRequest_SetStatusLinesOrQueues,
510 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
511 ((dtr != 0) ? SUSBCR_SSL_SETDTR : SUSBCR_SSL_CLRDTR),
518 dev_dbg(dev, "%s - Setting RTS\n", __func__);
520 dev_dbg(dev, "%s - Clearing RTS\n", __func__);
521 result = usb_control_msg(port->serial->dev,
522 usb_rcvctrlpipe(port->serial->dev, 0),
523 SUSBCRequest_SetStatusLinesOrQueues,
524 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
525 ((rts != 0) ? SUSBCR_SSL_SETRTS : SUSBCR_SSL_CLRRTS),
531 dev_dbg(dev, "%s - Send set_status_line URB returns: %i\n", __func__, result);
532 kfree(transfer_buffer);
533 return (result < 0) ? result : 0;
536 static void kobil_set_termios(struct tty_struct *tty,
537 struct usb_serial_port *port, struct ktermios *old)
539 struct kobil_private *priv;
541 unsigned short urb_val = 0;
542 int c_cflag = tty->termios.c_cflag;
545 priv = usb_get_serial_port_data(port);
546 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
547 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
548 /* This device doesn't support ioctl calls */
549 tty_termios_copy_hw(&tty->termios, old);
553 speed = tty_get_baud_rate(tty);
556 urb_val = SUSBCR_SBR_1200;
561 urb_val = SUSBCR_SBR_9600;
564 urb_val |= (c_cflag & CSTOPB) ? SUSBCR_SPASB_2StopBits :
565 SUSBCR_SPASB_1StopBit;
566 if (c_cflag & PARENB) {
567 if (c_cflag & PARODD)
568 urb_val |= SUSBCR_SPASB_OddParity;
570 urb_val |= SUSBCR_SPASB_EvenParity;
572 urb_val |= SUSBCR_SPASB_NoParity;
573 tty->termios.c_cflag &= ~CMSPAR;
574 tty_encode_baud_rate(tty, speed, speed);
576 result = usb_control_msg(port->serial->dev,
577 usb_rcvctrlpipe(port->serial->dev, 0),
578 SUSBCRequest_SetBaudRateParityAndStopBits,
579 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
588 static int kobil_ioctl(struct tty_struct *tty,
589 unsigned int cmd, unsigned long arg)
591 struct usb_serial_port *port = tty->driver_data;
592 struct kobil_private *priv = usb_get_serial_port_data(port);
593 unsigned char *transfer_buffer;
594 int transfer_buffer_length = 8;
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 */
604 transfer_buffer = kmalloc(transfer_buffer_length, GFP_KERNEL);
605 if (!transfer_buffer)
608 result = usb_control_msg(port->serial->dev,
609 usb_rcvctrlpipe(port->serial->dev, 0),
611 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
612 SUSBCR_MSC_ResetAllQueues,
614 NULL, /* transfer_buffer, */
620 "%s - Send reset_all_queues (FLUSH) URB returns: %i", __func__, result);
621 kfree(transfer_buffer);
622 return (result < 0) ? -EIO: 0;
628 module_usb_serial_driver(serial_drivers, id_table);
630 MODULE_AUTHOR(DRIVER_AUTHOR);
631 MODULE_DESCRIPTION(DRIVER_DESC);
632 MODULE_LICENSE("GPL");