1 // SPDX-License-Identifier: GPL-2.0+
3 * KOBIL USB Smart Card Terminal Driver
5 * Copyright (C) 2002 KOBIL Systems GmbH
6 * Author: Thomas Wahrenbruch
8 * Contact: linuxusb@kobil.de
10 * This program is largely derived from work by the linux-usb group
11 * and associated source files. Please see the usb/serial files for
12 * individual credits and copyrights.
14 * Thanks to Greg Kroah-Hartman (greg@kroah.com) for his help and
17 * Supported readers: USB TWIN, KAAN Standard Plus and SecOVID Reader Plus
18 * (Adapter K), B1 Professional and KAAN Professional (Adapter B)
22 #include <linux/kernel.h>
23 #include <linux/errno.h>
24 #include <linux/slab.h>
25 #include <linux/tty.h>
26 #include <linux/tty_driver.h>
27 #include <linux/tty_flip.h>
28 #include <linux/module.h>
29 #include <linux/spinlock.h>
30 #include <linux/uaccess.h>
31 #include <linux/usb.h>
32 #include <linux/usb/serial.h>
33 #include <linux/ioctl.h>
34 #include "kobil_sct.h"
36 #define DRIVER_AUTHOR "KOBIL Systems GmbH - http://www.kobil.com"
37 #define DRIVER_DESC "KOBIL USB Smart Card Terminal Driver (experimental)"
39 #define KOBIL_VENDOR_ID 0x0D46
40 #define KOBIL_ADAPTER_B_PRODUCT_ID 0x2011
41 #define KOBIL_ADAPTER_K_PRODUCT_ID 0x2012
42 #define KOBIL_USBTWIN_PRODUCT_ID 0x0078
43 #define KOBIL_KAAN_SIM_PRODUCT_ID 0x0081
45 #define KOBIL_TIMEOUT 500
46 #define KOBIL_BUF_LENGTH 300
49 /* Function prototypes */
50 static int kobil_port_probe(struct usb_serial_port *probe);
51 static void kobil_port_remove(struct usb_serial_port *probe);
52 static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port);
53 static void kobil_close(struct usb_serial_port *port);
54 static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
55 const unsigned char *buf, int count);
56 static unsigned int kobil_write_room(struct tty_struct *tty);
57 static int kobil_ioctl(struct tty_struct *tty,
58 unsigned int cmd, unsigned long arg);
59 static int kobil_tiocmget(struct tty_struct *tty);
60 static int kobil_tiocmset(struct tty_struct *tty,
61 unsigned int set, unsigned int clear);
62 static void kobil_read_int_callback(struct urb *urb);
63 static void kobil_write_int_callback(struct urb *urb);
64 static void kobil_set_termios(struct tty_struct *tty,
65 struct usb_serial_port *port,
66 const struct ktermios *old);
67 static void kobil_init_termios(struct tty_struct *tty);
69 static const struct usb_device_id id_table[] = {
70 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_ADAPTER_B_PRODUCT_ID) },
71 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_ADAPTER_K_PRODUCT_ID) },
72 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_USBTWIN_PRODUCT_ID) },
73 { USB_DEVICE(KOBIL_VENDOR_ID, KOBIL_KAAN_SIM_PRODUCT_ID) },
74 { } /* Terminating entry */
76 MODULE_DEVICE_TABLE(usb, id_table);
78 static struct usb_serial_driver kobil_device = {
83 .description = "KOBIL USB smart card terminal",
86 .num_interrupt_out = 1,
87 .port_probe = kobil_port_probe,
88 .port_remove = kobil_port_remove,
90 .set_termios = kobil_set_termios,
91 .init_termios = kobil_init_termios,
92 .tiocmget = kobil_tiocmget,
93 .tiocmset = kobil_tiocmset,
97 .write_room = kobil_write_room,
98 .read_int_callback = kobil_read_int_callback,
99 .write_int_callback = kobil_write_int_callback,
102 static struct usb_serial_driver * const serial_drivers[] = {
106 struct kobil_private {
107 unsigned char buf[KOBIL_BUF_LENGTH]; /* buffer for the APDU to send */
108 int filled; /* index of the last char in buf */
109 int cur_pos; /* index of the next char to send in buf */
114 static int kobil_port_probe(struct usb_serial_port *port)
116 struct usb_serial *serial = port->serial;
117 struct kobil_private *priv;
119 priv = kmalloc(sizeof(struct kobil_private), GFP_KERNEL);
125 priv->device_type = le16_to_cpu(serial->dev->descriptor.idProduct);
127 switch (priv->device_type) {
128 case KOBIL_ADAPTER_B_PRODUCT_ID:
129 dev_dbg(&serial->dev->dev, "KOBIL B1 PRO / KAAN PRO detected\n");
131 case KOBIL_ADAPTER_K_PRODUCT_ID:
132 dev_dbg(&serial->dev->dev, "KOBIL KAAN Standard Plus / SecOVID Reader Plus detected\n");
134 case KOBIL_USBTWIN_PRODUCT_ID:
135 dev_dbg(&serial->dev->dev, "KOBIL USBTWIN detected\n");
137 case KOBIL_KAAN_SIM_PRODUCT_ID:
138 dev_dbg(&serial->dev->dev, "KOBIL KAAN SIM detected\n");
141 usb_set_serial_port_data(port, priv);
147 static void kobil_port_remove(struct usb_serial_port *port)
149 struct kobil_private *priv;
151 priv = usb_get_serial_port_data(port);
155 static void kobil_init_termios(struct tty_struct *tty)
157 /* Default to echo off and other sane device settings */
158 tty->termios.c_lflag = 0;
159 tty->termios.c_iflag &= ~(ISIG | ICANON | ECHO | IEXTEN | XCASE);
160 tty->termios.c_iflag |= IGNBRK | IGNPAR | IXOFF;
161 /* do NOT translate CR to CR-NL (0x0A -> 0x0A 0x0D) */
162 tty->termios.c_oflag &= ~ONLCR;
165 static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port)
167 struct device *dev = &port->dev;
169 struct kobil_private *priv;
170 unsigned char *transfer_buffer;
171 int transfer_buffer_length = 8;
173 priv = usb_get_serial_port_data(port);
175 /* allocate memory for transfer buffer */
176 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
177 if (!transfer_buffer)
180 /* get hardware version */
181 result = usb_control_msg(port->serial->dev,
182 usb_rcvctrlpipe(port->serial->dev, 0),
183 SUSBCRequest_GetMisc,
184 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
185 SUSBCR_MSC_GetHWVersion,
188 transfer_buffer_length,
191 dev_dbg(dev, "%s - Send get_HW_version URB returns: %i\n", __func__, result);
193 dev_dbg(dev, "Hardware version: %i.%i.%i\n", transfer_buffer[0],
194 transfer_buffer[1], transfer_buffer[2]);
197 /* get firmware version */
198 result = usb_control_msg(port->serial->dev,
199 usb_rcvctrlpipe(port->serial->dev, 0),
200 SUSBCRequest_GetMisc,
201 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
202 SUSBCR_MSC_GetFWVersion,
205 transfer_buffer_length,
208 dev_dbg(dev, "%s - Send get_FW_version URB returns: %i\n", __func__, result);
210 dev_dbg(dev, "Firmware version: %i.%i.%i\n", transfer_buffer[0],
211 transfer_buffer[1], transfer_buffer[2]);
214 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
215 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
216 /* Setting Baudrate, Parity and Stopbits */
217 result = usb_control_msg(port->serial->dev,
218 usb_sndctrlpipe(port->serial->dev, 0),
219 SUSBCRequest_SetBaudRateParityAndStopBits,
220 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
221 SUSBCR_SBR_9600 | SUSBCR_SPASB_EvenParity |
222 SUSBCR_SPASB_1StopBit,
228 dev_dbg(dev, "%s - Send set_baudrate URB returns: %i\n", __func__, result);
230 /* reset all queues */
231 result = usb_control_msg(port->serial->dev,
232 usb_sndctrlpipe(port->serial->dev, 0),
234 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
235 SUSBCR_MSC_ResetAllQueues,
241 dev_dbg(dev, "%s - Send reset_all_queues URB returns: %i\n", __func__, result);
243 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
244 priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
245 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
246 /* start reading (Adapter B 'cause PNP string) */
247 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
248 dev_dbg(dev, "%s - Send read URB returns: %i\n", __func__, result);
251 kfree(transfer_buffer);
256 static void kobil_close(struct usb_serial_port *port)
258 /* FIXME: Add rts/dtr methods */
259 usb_kill_urb(port->interrupt_out_urb);
260 usb_kill_urb(port->interrupt_in_urb);
264 static void kobil_read_int_callback(struct urb *urb)
267 struct usb_serial_port *port = urb->context;
268 unsigned char *data = urb->transfer_buffer;
269 int status = urb->status;
272 dev_dbg(&port->dev, "%s - Read int status not zero: %d\n", __func__, status);
276 if (urb->actual_length) {
277 usb_serial_debug_data(&port->dev, __func__, urb->actual_length,
279 tty_insert_flip_string(&port->port, data, urb->actual_length);
280 tty_flip_buffer_push(&port->port);
283 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
284 dev_dbg(&port->dev, "%s - Send read URB returns: %i\n", __func__, result);
288 static void kobil_write_int_callback(struct urb *urb)
293 static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
294 const unsigned char *buf, int count)
299 struct kobil_private *priv;
302 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
306 priv = usb_get_serial_port_data(port);
308 if (count > (KOBIL_BUF_LENGTH - priv->filled)) {
309 dev_dbg(&port->dev, "%s - Error: write request bigger than buffer size\n", __func__);
313 /* Copy data to buffer */
314 memcpy(priv->buf + priv->filled, buf, count);
315 usb_serial_debug_data(&port->dev, __func__, count, priv->buf + priv->filled);
316 priv->filled = priv->filled + count;
318 /* only send complete block. TWIN, KAAN SIM and adapter K
319 use the same protocol. */
320 if (((priv->device_type != KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 2) && (priv->filled >= (priv->buf[1] + 3))) ||
321 ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 3) && (priv->filled >= (priv->buf[2] + 4)))) {
322 /* stop reading (except TWIN and KAAN SIM) */
323 if ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID)
324 || (priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID))
325 usb_kill_urb(port->interrupt_in_urb);
327 todo = priv->filled - priv->cur_pos;
330 /* max 8 byte in one urb (endpoint size) */
331 length = min(todo, port->interrupt_out_size);
332 /* copy data to transfer buffer */
333 memcpy(port->interrupt_out_buffer,
334 priv->buf + priv->cur_pos, length);
335 port->interrupt_out_urb->transfer_buffer_length = length;
337 priv->cur_pos = priv->cur_pos + length;
338 result = usb_submit_urb(port->interrupt_out_urb,
340 dev_dbg(&port->dev, "%s - Send write URB returns: %i\n", __func__, result);
341 todo = priv->filled - priv->cur_pos;
350 /* start reading (except TWIN and KAAN SIM) */
351 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
352 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
353 result = usb_submit_urb(port->interrupt_in_urb,
355 dev_dbg(&port->dev, "%s - Send read URB returns: %i\n", __func__, result);
362 static unsigned int kobil_write_room(struct tty_struct *tty)
369 static int kobil_tiocmget(struct tty_struct *tty)
371 struct usb_serial_port *port = tty->driver_data;
372 struct kobil_private *priv;
374 unsigned char *transfer_buffer;
375 int transfer_buffer_length = 8;
377 priv = usb_get_serial_port_data(port);
378 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
379 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
380 /* This device doesn't support ioctl calls */
384 /* allocate memory for transfer buffer */
385 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
386 if (!transfer_buffer)
389 result = usb_control_msg(port->serial->dev,
390 usb_rcvctrlpipe(port->serial->dev, 0),
391 SUSBCRequest_GetStatusLineState,
392 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
396 transfer_buffer_length,
399 dev_dbg(&port->dev, "Send get_status_line_state URB returns: %i\n",
407 dev_dbg(&port->dev, "Statusline: %02x\n", transfer_buffer[0]);
410 if ((transfer_buffer[0] & SUSBCR_GSL_DSR) != 0)
413 kfree(transfer_buffer);
417 static int kobil_tiocmset(struct tty_struct *tty,
418 unsigned int set, unsigned int clear)
420 struct usb_serial_port *port = tty->driver_data;
421 struct device *dev = &port->dev;
422 struct kobil_private *priv;
427 /* FIXME: locking ? */
428 priv = usb_get_serial_port_data(port);
429 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
430 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
431 /* This device doesn't support ioctl calls */
439 if (clear & TIOCM_RTS)
441 if (clear & TIOCM_DTR)
444 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) {
446 dev_dbg(dev, "%s - Setting DTR\n", __func__);
448 dev_dbg(dev, "%s - Clearing DTR\n", __func__);
449 result = usb_control_msg(port->serial->dev,
450 usb_sndctrlpipe(port->serial->dev, 0),
451 SUSBCRequest_SetStatusLinesOrQueues,
452 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
453 ((dtr != 0) ? SUSBCR_SSL_SETDTR : SUSBCR_SSL_CLRDTR),
460 dev_dbg(dev, "%s - Setting RTS\n", __func__);
462 dev_dbg(dev, "%s - Clearing RTS\n", __func__);
463 result = usb_control_msg(port->serial->dev,
464 usb_sndctrlpipe(port->serial->dev, 0),
465 SUSBCRequest_SetStatusLinesOrQueues,
466 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
467 ((rts != 0) ? SUSBCR_SSL_SETRTS : SUSBCR_SSL_CLRRTS),
473 dev_dbg(dev, "%s - Send set_status_line URB returns: %i\n", __func__, result);
474 return (result < 0) ? result : 0;
477 static void kobil_set_termios(struct tty_struct *tty,
478 struct usb_serial_port *port,
479 const struct ktermios *old)
481 struct kobil_private *priv;
483 unsigned short urb_val = 0;
484 int c_cflag = tty->termios.c_cflag;
487 priv = usb_get_serial_port_data(port);
488 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
489 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
490 /* This device doesn't support ioctl calls */
491 tty_termios_copy_hw(&tty->termios, old);
495 speed = tty_get_baud_rate(tty);
498 urb_val = SUSBCR_SBR_1200;
504 urb_val = SUSBCR_SBR_9600;
507 urb_val |= (c_cflag & CSTOPB) ? SUSBCR_SPASB_2StopBits :
508 SUSBCR_SPASB_1StopBit;
509 if (c_cflag & PARENB) {
510 if (c_cflag & PARODD)
511 urb_val |= SUSBCR_SPASB_OddParity;
513 urb_val |= SUSBCR_SPASB_EvenParity;
515 urb_val |= SUSBCR_SPASB_NoParity;
516 tty->termios.c_cflag &= ~CMSPAR;
517 tty_encode_baud_rate(tty, speed, speed);
519 result = usb_control_msg(port->serial->dev,
520 usb_sndctrlpipe(port->serial->dev, 0),
521 SUSBCRequest_SetBaudRateParityAndStopBits,
522 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
530 dev_err(&port->dev, "failed to update line settings: %d\n",
535 static int kobil_ioctl(struct tty_struct *tty,
536 unsigned int cmd, unsigned long arg)
538 struct usb_serial_port *port = tty->driver_data;
539 struct kobil_private *priv = usb_get_serial_port_data(port);
542 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
543 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID)
544 /* This device doesn't support ioctl calls */
549 result = usb_control_msg(port->serial->dev,
550 usb_sndctrlpipe(port->serial->dev, 0),
552 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
553 SUSBCR_MSC_ResetAllQueues,
561 "%s - Send reset_all_queues (FLUSH) URB returns: %i\n",
563 return (result < 0) ? -EIO: 0;
569 module_usb_serial_driver(serial_drivers, id_table);
571 MODULE_AUTHOR(DRIVER_AUTHOR);
572 MODULE_DESCRIPTION(DRIVER_DESC);
573 MODULE_LICENSE("GPL");