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/slab.h>
29 #include <linux/tty.h>
30 #include <linux/tty_driver.h>
31 #include <linux/tty_flip.h>
32 #include <linux/module.h>
33 #include <linux/spinlock.h>
34 #include <linux/uaccess.h>
35 #include <linux/usb.h>
36 #include <linux/usb/serial.h>
37 #include <linux/ioctl.h>
38 #include "kobil_sct.h"
40 #define DRIVER_AUTHOR "KOBIL Systems GmbH - http://www.kobil.com"
41 #define DRIVER_DESC "KOBIL USB Smart Card Terminal Driver (experimental)"
43 #define KOBIL_VENDOR_ID 0x0D46
44 #define KOBIL_ADAPTER_B_PRODUCT_ID 0x2011
45 #define KOBIL_ADAPTER_K_PRODUCT_ID 0x2012
46 #define KOBIL_USBTWIN_PRODUCT_ID 0x0078
47 #define KOBIL_KAAN_SIM_PRODUCT_ID 0x0081
49 #define KOBIL_TIMEOUT 500
50 #define KOBIL_BUF_LENGTH 300
53 /* Function prototypes */
54 static int kobil_port_probe(struct usb_serial_port
*probe
);
55 static int kobil_port_remove(struct usb_serial_port
*probe
);
56 static int kobil_open(struct tty_struct
*tty
, struct usb_serial_port
*port
);
57 static void kobil_close(struct usb_serial_port
*port
);
58 static int kobil_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
59 const unsigned char *buf
, int count
);
60 static int kobil_write_room(struct tty_struct
*tty
);
61 static int kobil_ioctl(struct tty_struct
*tty
,
62 unsigned int cmd
, unsigned long arg
);
63 static int kobil_tiocmget(struct tty_struct
*tty
);
64 static int kobil_tiocmset(struct tty_struct
*tty
,
65 unsigned int set
, unsigned int clear
);
66 static void kobil_read_int_callback(struct urb
*urb
);
67 static void kobil_write_int_callback(struct urb
*urb
);
68 static void kobil_set_termios(struct tty_struct
*tty
,
69 struct usb_serial_port
*port
, struct ktermios
*old
);
70 static void kobil_init_termios(struct tty_struct
*tty
);
72 static const struct usb_device_id id_table
[] = {
73 { USB_DEVICE(KOBIL_VENDOR_ID
, KOBIL_ADAPTER_B_PRODUCT_ID
) },
74 { USB_DEVICE(KOBIL_VENDOR_ID
, KOBIL_ADAPTER_K_PRODUCT_ID
) },
75 { USB_DEVICE(KOBIL_VENDOR_ID
, KOBIL_USBTWIN_PRODUCT_ID
) },
76 { USB_DEVICE(KOBIL_VENDOR_ID
, KOBIL_KAAN_SIM_PRODUCT_ID
) },
77 { } /* Terminating entry */
79 MODULE_DEVICE_TABLE(usb
, id_table
);
81 static struct usb_serial_driver kobil_device
= {
86 .description
= "KOBIL USB smart card terminal",
89 .num_interrupt_out
= 1,
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
,
102 .write_int_callback
= kobil_write_int_callback
,
105 static struct usb_serial_driver
* const serial_drivers
[] = {
109 struct kobil_private
{
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
)
119 struct usb_serial
*serial
= port
->serial
;
120 struct kobil_private
*priv
;
122 priv
= kmalloc(sizeof(struct kobil_private
), GFP_KERNEL
);
128 priv
->device_type
= le16_to_cpu(serial
->dev
->descriptor
.idProduct
);
130 switch (priv
->device_type
) {
131 case KOBIL_ADAPTER_B_PRODUCT_ID
:
132 dev_dbg(&serial
->dev
->dev
, "KOBIL B1 PRO / KAAN PRO detected\n");
134 case KOBIL_ADAPTER_K_PRODUCT_ID
:
135 dev_dbg(&serial
->dev
->dev
, "KOBIL KAAN Standard Plus / SecOVID Reader Plus detected\n");
137 case KOBIL_USBTWIN_PRODUCT_ID
:
138 dev_dbg(&serial
->dev
->dev
, "KOBIL USBTWIN detected\n");
140 case KOBIL_KAAN_SIM_PRODUCT_ID
:
141 dev_dbg(&serial
->dev
->dev
, "KOBIL KAAN SIM detected\n");
144 usb_set_serial_port_data(port
, priv
);
150 static int kobil_port_remove(struct usb_serial_port
*port
)
152 struct kobil_private
*priv
;
154 priv
= usb_get_serial_port_data(port
);
160 static void kobil_init_termios(struct tty_struct
*tty
)
162 /* Default to echo off and other sane device settings */
163 tty
->termios
.c_lflag
= 0;
164 tty
->termios
.c_iflag
&= ~(ISIG
| ICANON
| ECHO
| IEXTEN
| XCASE
);
165 tty
->termios
.c_iflag
|= IGNBRK
| IGNPAR
| IXOFF
;
166 /* do NOT translate CR to CR-NL (0x0A -> 0x0A 0x0D) */
167 tty
->termios
.c_oflag
&= ~ONLCR
;
170 static int kobil_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
172 struct device
*dev
= &port
->dev
;
174 struct kobil_private
*priv
;
175 unsigned char *transfer_buffer
;
176 int transfer_buffer_length
= 8;
178 priv
= usb_get_serial_port_data(port
);
180 /* allocate memory for transfer buffer */
181 transfer_buffer
= kzalloc(transfer_buffer_length
, GFP_KERNEL
);
182 if (!transfer_buffer
)
185 /* get hardware version */
186 result
= usb_control_msg(port
->serial
->dev
,
187 usb_rcvctrlpipe(port
->serial
->dev
, 0),
188 SUSBCRequest_GetMisc
,
189 USB_TYPE_VENDOR
| USB_RECIP_ENDPOINT
| USB_DIR_IN
,
190 SUSBCR_MSC_GetHWVersion
,
193 transfer_buffer_length
,
196 dev_dbg(dev
, "%s - Send get_HW_version URB returns: %i\n", __func__
, result
);
197 dev_dbg(dev
, "Hardware version: %i.%i.%i\n", transfer_buffer
[0],
198 transfer_buffer
[1], transfer_buffer
[2]);
200 /* get firmware version */
201 result
= usb_control_msg(port
->serial
->dev
,
202 usb_rcvctrlpipe(port
->serial
->dev
, 0),
203 SUSBCRequest_GetMisc
,
204 USB_TYPE_VENDOR
| USB_RECIP_ENDPOINT
| USB_DIR_IN
,
205 SUSBCR_MSC_GetFWVersion
,
208 transfer_buffer_length
,
211 dev_dbg(dev
, "%s - Send get_FW_version URB returns: %i\n", __func__
, result
);
212 dev_dbg(dev
, "Firmware version: %i.%i.%i\n", transfer_buffer
[0],
213 transfer_buffer
[1], transfer_buffer
[2]);
215 if (priv
->device_type
== KOBIL_ADAPTER_B_PRODUCT_ID
||
216 priv
->device_type
== KOBIL_ADAPTER_K_PRODUCT_ID
) {
217 /* Setting Baudrate, Parity and Stopbits */
218 result
= usb_control_msg(port
->serial
->dev
,
219 usb_sndctrlpipe(port
->serial
->dev
, 0),
220 SUSBCRequest_SetBaudRateParityAndStopBits
,
221 USB_TYPE_VENDOR
| USB_RECIP_ENDPOINT
| USB_DIR_OUT
,
222 SUSBCR_SBR_9600
| SUSBCR_SPASB_EvenParity
|
223 SUSBCR_SPASB_1StopBit
,
229 dev_dbg(dev
, "%s - Send set_baudrate URB returns: %i\n", __func__
, result
);
231 /* reset all queues */
232 result
= usb_control_msg(port
->serial
->dev
,
233 usb_sndctrlpipe(port
->serial
->dev
, 0),
235 USB_TYPE_VENDOR
| USB_RECIP_ENDPOINT
| USB_DIR_OUT
,
236 SUSBCR_MSC_ResetAllQueues
,
242 dev_dbg(dev
, "%s - Send reset_all_queues URB returns: %i\n", __func__
, result
);
244 if (priv
->device_type
== KOBIL_USBTWIN_PRODUCT_ID
||
245 priv
->device_type
== KOBIL_ADAPTER_B_PRODUCT_ID
||
246 priv
->device_type
== KOBIL_KAAN_SIM_PRODUCT_ID
) {
247 /* start reading (Adapter B 'cause PNP string) */
248 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
249 dev_dbg(dev
, "%s - Send read URB returns: %i\n", __func__
, result
);
252 kfree(transfer_buffer
);
257 static void kobil_close(struct usb_serial_port
*port
)
259 /* FIXME: Add rts/dtr methods */
260 usb_kill_urb(port
->interrupt_out_urb
);
261 usb_kill_urb(port
->interrupt_in_urb
);
265 static void kobil_read_int_callback(struct urb
*urb
)
268 struct usb_serial_port
*port
= urb
->context
;
269 unsigned char *data
= urb
->transfer_buffer
;
270 int status
= urb
->status
;
273 dev_dbg(&port
->dev
, "%s - Read int status not zero: %d\n", __func__
, status
);
277 if (urb
->actual_length
) {
278 usb_serial_debug_data(&port
->dev
, __func__
, urb
->actual_length
,
280 tty_insert_flip_string(&port
->port
, data
, urb
->actual_length
);
281 tty_flip_buffer_push(&port
->port
);
284 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_ATOMIC
);
285 dev_dbg(&port
->dev
, "%s - Send read URB returns: %i\n", __func__
, result
);
289 static void kobil_write_int_callback(struct urb
*urb
)
294 static int kobil_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
295 const unsigned char *buf
, int count
)
300 struct kobil_private
*priv
;
303 dev_dbg(&port
->dev
, "%s - write request of 0 bytes\n", __func__
);
307 priv
= usb_get_serial_port_data(port
);
309 if (count
> (KOBIL_BUF_LENGTH
- priv
->filled
)) {
310 dev_dbg(&port
->dev
, "%s - Error: write request bigger than buffer size\n", __func__
);
314 /* Copy data to buffer */
315 memcpy(priv
->buf
+ priv
->filled
, buf
, count
);
316 usb_serial_debug_data(&port
->dev
, __func__
, count
, priv
->buf
+ priv
->filled
);
317 priv
->filled
= priv
->filled
+ count
;
319 /* only send complete block. TWIN, KAAN SIM and adapter K
320 use the same protocol. */
321 if (((priv
->device_type
!= KOBIL_ADAPTER_B_PRODUCT_ID
) && (priv
->filled
> 2) && (priv
->filled
>= (priv
->buf
[1] + 3))) ||
322 ((priv
->device_type
== KOBIL_ADAPTER_B_PRODUCT_ID
) && (priv
->filled
> 3) && (priv
->filled
>= (priv
->buf
[2] + 4)))) {
323 /* stop reading (except TWIN and KAAN SIM) */
324 if ((priv
->device_type
== KOBIL_ADAPTER_B_PRODUCT_ID
)
325 || (priv
->device_type
== KOBIL_ADAPTER_K_PRODUCT_ID
))
326 usb_kill_urb(port
->interrupt_in_urb
);
328 todo
= priv
->filled
- priv
->cur_pos
;
331 /* max 8 byte in one urb (endpoint size) */
332 length
= min(todo
, port
->interrupt_out_size
);
333 /* copy data to transfer buffer */
334 memcpy(port
->interrupt_out_buffer
,
335 priv
->buf
+ priv
->cur_pos
, length
);
336 port
->interrupt_out_urb
->transfer_buffer_length
= length
;
338 priv
->cur_pos
= priv
->cur_pos
+ length
;
339 result
= usb_submit_urb(port
->interrupt_out_urb
,
341 dev_dbg(&port
->dev
, "%s - Send write URB returns: %i\n", __func__
, result
);
342 todo
= priv
->filled
- priv
->cur_pos
;
351 /* start reading (except TWIN and KAAN SIM) */
352 if (priv
->device_type
== KOBIL_ADAPTER_B_PRODUCT_ID
||
353 priv
->device_type
== KOBIL_ADAPTER_K_PRODUCT_ID
) {
354 result
= usb_submit_urb(port
->interrupt_in_urb
,
356 dev_dbg(&port
->dev
, "%s - Send read URB returns: %i\n", __func__
, result
);
363 static int kobil_write_room(struct tty_struct
*tty
)
370 static int kobil_tiocmget(struct tty_struct
*tty
)
372 struct usb_serial_port
*port
= tty
->driver_data
;
373 struct kobil_private
*priv
;
375 unsigned char *transfer_buffer
;
376 int transfer_buffer_length
= 8;
378 priv
= usb_get_serial_port_data(port
);
379 if (priv
->device_type
== KOBIL_USBTWIN_PRODUCT_ID
380 || priv
->device_type
== KOBIL_KAAN_SIM_PRODUCT_ID
) {
381 /* This device doesn't support ioctl calls */
385 /* allocate memory for transfer buffer */
386 transfer_buffer
= kzalloc(transfer_buffer_length
, GFP_KERNEL
);
387 if (!transfer_buffer
)
390 result
= usb_control_msg(port
->serial
->dev
,
391 usb_rcvctrlpipe(port
->serial
->dev
, 0),
392 SUSBCRequest_GetStatusLineState
,
393 USB_TYPE_VENDOR
| USB_RECIP_ENDPOINT
| USB_DIR_IN
,
397 transfer_buffer_length
,
400 dev_dbg(&port
->dev
, "%s - Send get_status_line_state URB returns: %i. Statusline: %02x\n",
401 __func__
, result
, transfer_buffer
[0]);
404 if ((transfer_buffer
[0] & SUSBCR_GSL_DSR
) != 0)
406 kfree(transfer_buffer
);
410 static int kobil_tiocmset(struct tty_struct
*tty
,
411 unsigned int set
, unsigned int clear
)
413 struct usb_serial_port
*port
= tty
->driver_data
;
414 struct device
*dev
= &port
->dev
;
415 struct kobil_private
*priv
;
420 /* FIXME: locking ? */
421 priv
= usb_get_serial_port_data(port
);
422 if (priv
->device_type
== KOBIL_USBTWIN_PRODUCT_ID
423 || priv
->device_type
== KOBIL_KAAN_SIM_PRODUCT_ID
) {
424 /* This device doesn't support ioctl calls */
432 if (clear
& TIOCM_RTS
)
434 if (clear
& TIOCM_DTR
)
437 if (priv
->device_type
== KOBIL_ADAPTER_B_PRODUCT_ID
) {
439 dev_dbg(dev
, "%s - Setting DTR\n", __func__
);
441 dev_dbg(dev
, "%s - Clearing DTR\n", __func__
);
442 result
= usb_control_msg(port
->serial
->dev
,
443 usb_sndctrlpipe(port
->serial
->dev
, 0),
444 SUSBCRequest_SetStatusLinesOrQueues
,
445 USB_TYPE_VENDOR
| USB_RECIP_ENDPOINT
| USB_DIR_OUT
,
446 ((dtr
!= 0) ? SUSBCR_SSL_SETDTR
: SUSBCR_SSL_CLRDTR
),
453 dev_dbg(dev
, "%s - Setting RTS\n", __func__
);
455 dev_dbg(dev
, "%s - Clearing RTS\n", __func__
);
456 result
= usb_control_msg(port
->serial
->dev
,
457 usb_sndctrlpipe(port
->serial
->dev
, 0),
458 SUSBCRequest_SetStatusLinesOrQueues
,
459 USB_TYPE_VENDOR
| USB_RECIP_ENDPOINT
| USB_DIR_OUT
,
460 ((rts
!= 0) ? SUSBCR_SSL_SETRTS
: SUSBCR_SSL_CLRRTS
),
466 dev_dbg(dev
, "%s - Send set_status_line URB returns: %i\n", __func__
, result
);
467 return (result
< 0) ? result
: 0;
470 static void kobil_set_termios(struct tty_struct
*tty
,
471 struct usb_serial_port
*port
, struct ktermios
*old
)
473 struct kobil_private
*priv
;
475 unsigned short urb_val
= 0;
476 int c_cflag
= tty
->termios
.c_cflag
;
479 priv
= usb_get_serial_port_data(port
);
480 if (priv
->device_type
== KOBIL_USBTWIN_PRODUCT_ID
||
481 priv
->device_type
== KOBIL_KAAN_SIM_PRODUCT_ID
) {
482 /* This device doesn't support ioctl calls */
483 tty_termios_copy_hw(&tty
->termios
, old
);
487 speed
= tty_get_baud_rate(tty
);
490 urb_val
= SUSBCR_SBR_1200
;
495 urb_val
= SUSBCR_SBR_9600
;
498 urb_val
|= (c_cflag
& CSTOPB
) ? SUSBCR_SPASB_2StopBits
:
499 SUSBCR_SPASB_1StopBit
;
500 if (c_cflag
& PARENB
) {
501 if (c_cflag
& PARODD
)
502 urb_val
|= SUSBCR_SPASB_OddParity
;
504 urb_val
|= SUSBCR_SPASB_EvenParity
;
506 urb_val
|= SUSBCR_SPASB_NoParity
;
507 tty
->termios
.c_cflag
&= ~CMSPAR
;
508 tty_encode_baud_rate(tty
, speed
, speed
);
510 result
= usb_control_msg(port
->serial
->dev
,
511 usb_sndctrlpipe(port
->serial
->dev
, 0),
512 SUSBCRequest_SetBaudRateParityAndStopBits
,
513 USB_TYPE_VENDOR
| USB_RECIP_ENDPOINT
| USB_DIR_OUT
,
522 static int kobil_ioctl(struct tty_struct
*tty
,
523 unsigned int cmd
, unsigned long arg
)
525 struct usb_serial_port
*port
= tty
->driver_data
;
526 struct kobil_private
*priv
= usb_get_serial_port_data(port
);
529 if (priv
->device_type
== KOBIL_USBTWIN_PRODUCT_ID
||
530 priv
->device_type
== KOBIL_KAAN_SIM_PRODUCT_ID
)
531 /* This device doesn't support ioctl calls */
536 result
= usb_control_msg(port
->serial
->dev
,
537 usb_sndctrlpipe(port
->serial
->dev
, 0),
539 USB_TYPE_VENDOR
| USB_RECIP_ENDPOINT
| USB_DIR_OUT
,
540 SUSBCR_MSC_ResetAllQueues
,
548 "%s - Send reset_all_queues (FLUSH) URB returns: %i\n",
550 return (result
< 0) ? -EIO
: 0;
556 module_usb_serial_driver(serial_drivers
, id_table
);
558 MODULE_AUTHOR(DRIVER_AUTHOR
);
559 MODULE_DESCRIPTION(DRIVER_DESC
);
560 MODULE_LICENSE("GPL");