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 int read_int_endpoint_address;
111 unsigned char buf[KOBIL_BUF_LENGTH]; /* buffer for the APDU to send */
112 int filled; /* index of the last char in buf */
113 int cur_pos; /* index of the next char to send in buf */
118 static int kobil_port_probe(struct usb_serial_port *port)
121 struct usb_serial *serial = port->serial;
122 struct kobil_private *priv;
123 struct usb_device *pdev;
124 struct usb_host_config *actconfig;
125 struct usb_interface *interface;
126 struct usb_host_interface *altsetting;
127 struct usb_host_endpoint *endpoint;
129 priv = kmalloc(sizeof(struct kobil_private), GFP_KERNEL);
135 priv->device_type = le16_to_cpu(serial->dev->descriptor.idProduct);
137 switch (priv->device_type) {
138 case KOBIL_ADAPTER_B_PRODUCT_ID:
139 dev_dbg(&serial->dev->dev, "KOBIL B1 PRO / KAAN PRO detected\n");
141 case KOBIL_ADAPTER_K_PRODUCT_ID:
142 dev_dbg(&serial->dev->dev, "KOBIL KAAN Standard Plus / SecOVID Reader Plus detected\n");
144 case KOBIL_USBTWIN_PRODUCT_ID:
145 dev_dbg(&serial->dev->dev, "KOBIL USBTWIN detected\n");
147 case KOBIL_KAAN_SIM_PRODUCT_ID:
148 dev_dbg(&serial->dev->dev, "KOBIL KAAN SIM detected\n");
151 usb_set_serial_port_data(port, priv);
153 /* search for the necessary endpoints */
155 actconfig = pdev->actconfig;
156 interface = actconfig->interface[0];
157 altsetting = interface->cur_altsetting;
158 endpoint = altsetting->endpoint;
160 for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
161 endpoint = &altsetting->endpoint[i];
162 if (usb_endpoint_is_int_out(&endpoint->desc)) {
163 dev_dbg(&serial->dev->dev,
164 "%s Found interrupt out endpoint. Address: %d\n",
165 __func__, endpoint->desc.bEndpointAddress);
166 priv->write_int_endpoint_address =
167 endpoint->desc.bEndpointAddress;
169 if (usb_endpoint_is_int_in(&endpoint->desc)) {
170 dev_dbg(&serial->dev->dev,
171 "%s Found interrupt in endpoint. Address: %d\n",
172 __func__, endpoint->desc.bEndpointAddress);
173 priv->read_int_endpoint_address =
174 endpoint->desc.bEndpointAddress;
181 static int kobil_port_remove(struct usb_serial_port *port)
183 struct kobil_private *priv;
185 priv = usb_get_serial_port_data(port);
191 static void kobil_init_termios(struct tty_struct *tty)
193 /* Default to echo off and other sane device settings */
194 tty->termios.c_lflag = 0;
195 tty->termios.c_iflag &= ~(ISIG | ICANON | ECHO | IEXTEN | XCASE);
196 tty->termios.c_iflag |= IGNBRK | IGNPAR | IXOFF;
197 /* do NOT translate CR to CR-NL (0x0A -> 0x0A 0x0D) */
198 tty->termios.c_oflag &= ~ONLCR;
201 static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port)
203 struct device *dev = &port->dev;
205 struct kobil_private *priv;
206 unsigned char *transfer_buffer;
207 int transfer_buffer_length = 8;
208 int write_urb_transfer_buffer_length = 8;
210 priv = usb_get_serial_port_data(port);
212 /* allocate memory for transfer buffer */
213 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
214 if (!transfer_buffer)
217 /* allocate write_urb */
218 if (!port->write_urb) {
219 dev_dbg(dev, "%s - Allocating port->write_urb\n", __func__);
220 port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
221 if (!port->write_urb) {
222 dev_dbg(dev, "%s - usb_alloc_urb failed\n", __func__);
223 kfree(transfer_buffer);
228 /* allocate memory for write_urb transfer buffer */
229 port->write_urb->transfer_buffer =
230 kmalloc(write_urb_transfer_buffer_length, GFP_KERNEL);
231 if (!port->write_urb->transfer_buffer) {
232 kfree(transfer_buffer);
233 usb_free_urb(port->write_urb);
234 port->write_urb = NULL;
238 /* get hardware version */
239 result = usb_control_msg(port->serial->dev,
240 usb_rcvctrlpipe(port->serial->dev, 0),
241 SUSBCRequest_GetMisc,
242 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
243 SUSBCR_MSC_GetHWVersion,
246 transfer_buffer_length,
249 dev_dbg(dev, "%s - Send get_HW_version URB returns: %i\n", __func__, result);
250 dev_dbg(dev, "Harware version: %i.%i.%i\n", transfer_buffer[0],
251 transfer_buffer[1], transfer_buffer[2]);
253 /* get firmware version */
254 result = usb_control_msg(port->serial->dev,
255 usb_rcvctrlpipe(port->serial->dev, 0),
256 SUSBCRequest_GetMisc,
257 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
258 SUSBCR_MSC_GetFWVersion,
261 transfer_buffer_length,
264 dev_dbg(dev, "%s - Send get_FW_version URB returns: %i\n", __func__, result);
265 dev_dbg(dev, "Firmware version: %i.%i.%i\n", transfer_buffer[0],
266 transfer_buffer[1], transfer_buffer[2]);
268 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
269 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
270 /* Setting Baudrate, Parity and Stopbits */
271 result = usb_control_msg(port->serial->dev,
272 usb_rcvctrlpipe(port->serial->dev, 0),
273 SUSBCRequest_SetBaudRateParityAndStopBits,
274 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
275 SUSBCR_SBR_9600 | SUSBCR_SPASB_EvenParity |
276 SUSBCR_SPASB_1StopBit,
282 dev_dbg(dev, "%s - Send set_baudrate URB returns: %i\n", __func__, result);
284 /* reset all queues */
285 result = usb_control_msg(port->serial->dev,
286 usb_rcvctrlpipe(port->serial->dev, 0),
288 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
289 SUSBCR_MSC_ResetAllQueues,
295 dev_dbg(dev, "%s - Send reset_all_queues URB returns: %i\n", __func__, result);
297 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
298 priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
299 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
300 /* start reading (Adapter B 'cause PNP string) */
301 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
302 dev_dbg(dev, "%s - Send read URB returns: %i\n", __func__, result);
305 kfree(transfer_buffer);
310 static void kobil_close(struct usb_serial_port *port)
312 /* FIXME: Add rts/dtr methods */
313 if (port->write_urb) {
314 usb_poison_urb(port->write_urb);
315 kfree(port->write_urb->transfer_buffer);
316 usb_free_urb(port->write_urb);
317 port->write_urb = NULL;
319 usb_kill_urb(port->interrupt_in_urb);
323 static void kobil_read_int_callback(struct urb *urb)
326 struct usb_serial_port *port = urb->context;
327 unsigned char *data = urb->transfer_buffer;
328 int status = urb->status;
331 dev_dbg(&port->dev, "%s - Read int status not zero: %d\n", __func__, status);
335 if (urb->actual_length) {
341 dbg_data = kzalloc((3 * purb->actual_length + 10)
342 * sizeof(char), GFP_KERNEL);
346 for (i = 0; i < purb->actual_length; i++) {
347 sprintf(dbg_data +3*i, "%02X ", data[i]);
349 dev_dbg(&port->dev, " <-- %s\n", dbg_data);
354 tty_insert_flip_string(&port->port, data, urb->actual_length);
355 tty_flip_buffer_push(&port->port);
358 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
359 dev_dbg(&port->dev, "%s - Send read URB returns: %i\n", __func__, result);
363 static void kobil_write_callback(struct urb *purb)
368 static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
369 const unsigned char *buf, int count)
374 struct kobil_private *priv;
377 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
381 priv = usb_get_serial_port_data(port);
383 if (count > (KOBIL_BUF_LENGTH - priv->filled)) {
384 dev_dbg(&port->dev, "%s - Error: write request bigger than buffer size\n", __func__);
388 /* Copy data to buffer */
389 memcpy(priv->buf + priv->filled, buf, count);
390 usb_serial_debug_data(&port->dev, __func__, count, priv->buf + priv->filled);
391 priv->filled = priv->filled + count;
393 /* only send complete block. TWIN, KAAN SIM and adapter K
394 use the same protocol. */
395 if (((priv->device_type != KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 2) && (priv->filled >= (priv->buf[1] + 3))) ||
396 ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 3) && (priv->filled >= (priv->buf[2] + 4)))) {
397 /* stop reading (except TWIN and KAAN SIM) */
398 if ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID)
399 || (priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID))
400 usb_kill_urb(port->interrupt_in_urb);
402 todo = priv->filled - priv->cur_pos;
405 /* max 8 byte in one urb (endpoint size) */
406 length = (todo < 8) ? todo : 8;
407 /* copy data to transfer buffer */
408 memcpy(port->write_urb->transfer_buffer,
409 priv->buf + priv->cur_pos, length);
410 usb_fill_int_urb(port->write_urb,
412 usb_sndintpipe(port->serial->dev,
413 priv->write_int_endpoint_address),
414 port->write_urb->transfer_buffer,
416 kobil_write_callback,
421 priv->cur_pos = priv->cur_pos + length;
422 result = usb_submit_urb(port->write_urb, GFP_NOIO);
423 dev_dbg(&port->dev, "%s - Send write URB returns: %i\n", __func__, result);
424 todo = priv->filled - priv->cur_pos;
433 /* start reading (except TWIN and KAAN SIM) */
434 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
435 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
436 result = usb_submit_urb(port->interrupt_in_urb,
438 dev_dbg(&port->dev, "%s - Send read URB returns: %i\n", __func__, result);
445 static int kobil_write_room(struct tty_struct *tty)
452 static int kobil_tiocmget(struct tty_struct *tty)
454 struct usb_serial_port *port = tty->driver_data;
455 struct kobil_private *priv;
457 unsigned char *transfer_buffer;
458 int transfer_buffer_length = 8;
460 priv = usb_get_serial_port_data(port);
461 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
462 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
463 /* This device doesn't support ioctl calls */
467 /* allocate memory for transfer buffer */
468 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
469 if (!transfer_buffer)
472 result = usb_control_msg(port->serial->dev,
473 usb_rcvctrlpipe(port->serial->dev, 0),
474 SUSBCRequest_GetStatusLineState,
475 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
479 transfer_buffer_length,
482 dev_dbg(&port->dev, "%s - Send get_status_line_state URB returns: %i. Statusline: %02x\n",
483 __func__, result, transfer_buffer[0]);
486 if ((transfer_buffer[0] & SUSBCR_GSL_DSR) != 0)
488 kfree(transfer_buffer);
492 static int kobil_tiocmset(struct tty_struct *tty,
493 unsigned int set, unsigned int clear)
495 struct usb_serial_port *port = tty->driver_data;
496 struct device *dev = &port->dev;
497 struct kobil_private *priv;
501 unsigned char *transfer_buffer;
502 int transfer_buffer_length = 8;
504 /* FIXME: locking ? */
505 priv = usb_get_serial_port_data(port);
506 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
507 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
508 /* This device doesn't support ioctl calls */
512 /* allocate memory for transfer buffer */
513 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
514 if (!transfer_buffer)
521 if (clear & TIOCM_RTS)
523 if (clear & TIOCM_DTR)
526 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) {
528 dev_dbg(dev, "%s - Setting DTR\n", __func__);
530 dev_dbg(dev, "%s - Clearing DTR\n", __func__);
531 result = usb_control_msg(port->serial->dev,
532 usb_rcvctrlpipe(port->serial->dev, 0),
533 SUSBCRequest_SetStatusLinesOrQueues,
534 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
535 ((dtr != 0) ? SUSBCR_SSL_SETDTR : SUSBCR_SSL_CLRDTR),
542 dev_dbg(dev, "%s - Setting RTS\n", __func__);
544 dev_dbg(dev, "%s - Clearing RTS\n", __func__);
545 result = usb_control_msg(port->serial->dev,
546 usb_rcvctrlpipe(port->serial->dev, 0),
547 SUSBCRequest_SetStatusLinesOrQueues,
548 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
549 ((rts != 0) ? SUSBCR_SSL_SETRTS : SUSBCR_SSL_CLRRTS),
555 dev_dbg(dev, "%s - Send set_status_line URB returns: %i\n", __func__, result);
556 kfree(transfer_buffer);
557 return (result < 0) ? result : 0;
560 static void kobil_set_termios(struct tty_struct *tty,
561 struct usb_serial_port *port, struct ktermios *old)
563 struct kobil_private *priv;
565 unsigned short urb_val = 0;
566 int c_cflag = tty->termios.c_cflag;
569 priv = usb_get_serial_port_data(port);
570 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
571 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
572 /* This device doesn't support ioctl calls */
573 tty_termios_copy_hw(&tty->termios, old);
577 speed = tty_get_baud_rate(tty);
580 urb_val = SUSBCR_SBR_1200;
585 urb_val = SUSBCR_SBR_9600;
588 urb_val |= (c_cflag & CSTOPB) ? SUSBCR_SPASB_2StopBits :
589 SUSBCR_SPASB_1StopBit;
590 if (c_cflag & PARENB) {
591 if (c_cflag & PARODD)
592 urb_val |= SUSBCR_SPASB_OddParity;
594 urb_val |= SUSBCR_SPASB_EvenParity;
596 urb_val |= SUSBCR_SPASB_NoParity;
597 tty->termios.c_cflag &= ~CMSPAR;
598 tty_encode_baud_rate(tty, speed, speed);
600 result = usb_control_msg(port->serial->dev,
601 usb_rcvctrlpipe(port->serial->dev, 0),
602 SUSBCRequest_SetBaudRateParityAndStopBits,
603 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
612 static int kobil_ioctl(struct tty_struct *tty,
613 unsigned int cmd, unsigned long arg)
615 struct usb_serial_port *port = tty->driver_data;
616 struct kobil_private *priv = usb_get_serial_port_data(port);
617 unsigned char *transfer_buffer;
618 int transfer_buffer_length = 8;
621 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
622 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID)
623 /* This device doesn't support ioctl calls */
628 transfer_buffer = kmalloc(transfer_buffer_length, GFP_KERNEL);
629 if (!transfer_buffer)
632 result = usb_control_msg(port->serial->dev,
633 usb_rcvctrlpipe(port->serial->dev, 0),
635 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
636 SUSBCR_MSC_ResetAllQueues,
638 NULL, /* transfer_buffer, */
644 "%s - Send reset_all_queues (FLUSH) URB returns: %i", __func__, result);
645 kfree(transfer_buffer);
646 return (result < 0) ? -EIO: 0;
652 module_usb_serial_driver(serial_drivers, id_table);
654 MODULE_AUTHOR(DRIVER_AUTHOR);
655 MODULE_DESCRIPTION(DRIVER_DESC);
656 MODULE_LICENSE("GPL");