Loading...
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * KOBIL USB Smart Card Terminal Driver
4 *
5 * Copyright (C) 2002 KOBIL Systems GmbH
6 * Author: Thomas Wahrenbruch
7 *
8 * Contact: linuxusb@kobil.de
9 *
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.
13 *
14 * Thanks to Greg Kroah-Hartman (greg@kroah.com) for his help and
15 * patience.
16 *
17 * Supported readers: USB TWIN, KAAN Standard Plus and SecOVID Reader Plus
18 * (Adapter K), B1 Professional and KAAN Professional (Adapter B)
19 */
20
21
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"
35
36#define DRIVER_AUTHOR "KOBIL Systems GmbH - http://www.kobil.com"
37#define DRIVER_DESC "KOBIL USB Smart Card Terminal Driver (experimental)"
38
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
44
45#define KOBIL_TIMEOUT 500
46#define KOBIL_BUF_LENGTH 300
47
48
49/* Function prototypes */
50static int kobil_port_probe(struct usb_serial_port *probe);
51static void kobil_port_remove(struct usb_serial_port *probe);
52static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port);
53static void kobil_close(struct usb_serial_port *port);
54static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
55 const unsigned char *buf, int count);
56static unsigned int kobil_write_room(struct tty_struct *tty);
57static int kobil_ioctl(struct tty_struct *tty,
58 unsigned int cmd, unsigned long arg);
59static int kobil_tiocmget(struct tty_struct *tty);
60static int kobil_tiocmset(struct tty_struct *tty,
61 unsigned int set, unsigned int clear);
62static void kobil_read_int_callback(struct urb *urb);
63static void kobil_write_int_callback(struct urb *urb);
64static void kobil_set_termios(struct tty_struct *tty,
65 struct usb_serial_port *port,
66 const struct ktermios *old);
67static void kobil_init_termios(struct tty_struct *tty);
68
69static 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 */
75};
76MODULE_DEVICE_TABLE(usb, id_table);
77
78static struct usb_serial_driver kobil_device = {
79 .driver = {
80 .name = "kobil",
81 },
82 .description = "KOBIL USB smart card terminal",
83 .id_table = id_table,
84 .num_ports = 1,
85 .num_interrupt_out = 1,
86 .port_probe = kobil_port_probe,
87 .port_remove = kobil_port_remove,
88 .ioctl = kobil_ioctl,
89 .set_termios = kobil_set_termios,
90 .init_termios = kobil_init_termios,
91 .tiocmget = kobil_tiocmget,
92 .tiocmset = kobil_tiocmset,
93 .open = kobil_open,
94 .close = kobil_close,
95 .write = kobil_write,
96 .write_room = kobil_write_room,
97 .read_int_callback = kobil_read_int_callback,
98 .write_int_callback = kobil_write_int_callback,
99};
100
101static struct usb_serial_driver * const serial_drivers[] = {
102 &kobil_device, NULL
103};
104
105struct kobil_private {
106 unsigned char buf[KOBIL_BUF_LENGTH]; /* buffer for the APDU to send */
107 int filled; /* index of the last char in buf */
108 int cur_pos; /* index of the next char to send in buf */
109 __u16 device_type;
110};
111
112
113static int kobil_port_probe(struct usb_serial_port *port)
114{
115 struct usb_serial *serial = port->serial;
116 struct kobil_private *priv;
117
118 priv = kmalloc(sizeof(struct kobil_private), GFP_KERNEL);
119 if (!priv)
120 return -ENOMEM;
121
122 priv->filled = 0;
123 priv->cur_pos = 0;
124 priv->device_type = le16_to_cpu(serial->dev->descriptor.idProduct);
125
126 switch (priv->device_type) {
127 case KOBIL_ADAPTER_B_PRODUCT_ID:
128 dev_dbg(&serial->dev->dev, "KOBIL B1 PRO / KAAN PRO detected\n");
129 break;
130 case KOBIL_ADAPTER_K_PRODUCT_ID:
131 dev_dbg(&serial->dev->dev, "KOBIL KAAN Standard Plus / SecOVID Reader Plus detected\n");
132 break;
133 case KOBIL_USBTWIN_PRODUCT_ID:
134 dev_dbg(&serial->dev->dev, "KOBIL USBTWIN detected\n");
135 break;
136 case KOBIL_KAAN_SIM_PRODUCT_ID:
137 dev_dbg(&serial->dev->dev, "KOBIL KAAN SIM detected\n");
138 break;
139 }
140 usb_set_serial_port_data(port, priv);
141
142 return 0;
143}
144
145
146static void kobil_port_remove(struct usb_serial_port *port)
147{
148 struct kobil_private *priv;
149
150 priv = usb_get_serial_port_data(port);
151 kfree(priv);
152}
153
154static void kobil_init_termios(struct tty_struct *tty)
155{
156 /* Default to echo off and other sane device settings */
157 tty->termios.c_lflag = 0;
158 tty->termios.c_iflag = IGNBRK | IGNPAR | IXOFF;
159 /* do NOT translate CR to CR-NL (0x0A -> 0x0A 0x0D) */
160 tty->termios.c_oflag &= ~ONLCR;
161}
162
163static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port)
164{
165 struct device *dev = &port->dev;
166 int result = 0;
167 struct kobil_private *priv;
168 unsigned char *transfer_buffer;
169 int transfer_buffer_length = 8;
170
171 priv = usb_get_serial_port_data(port);
172
173 /* allocate memory for transfer buffer */
174 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
175 if (!transfer_buffer)
176 return -ENOMEM;
177
178 /* get hardware version */
179 result = usb_control_msg(port->serial->dev,
180 usb_rcvctrlpipe(port->serial->dev, 0),
181 SUSBCRequest_GetMisc,
182 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
183 SUSBCR_MSC_GetHWVersion,
184 0,
185 transfer_buffer,
186 transfer_buffer_length,
187 KOBIL_TIMEOUT
188 );
189 dev_dbg(dev, "%s - Send get_HW_version URB returns: %i\n", __func__, result);
190 if (result >= 3) {
191 dev_dbg(dev, "Hardware version: %i.%i.%i\n", transfer_buffer[0],
192 transfer_buffer[1], transfer_buffer[2]);
193 }
194
195 /* get firmware version */
196 result = usb_control_msg(port->serial->dev,
197 usb_rcvctrlpipe(port->serial->dev, 0),
198 SUSBCRequest_GetMisc,
199 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
200 SUSBCR_MSC_GetFWVersion,
201 0,
202 transfer_buffer,
203 transfer_buffer_length,
204 KOBIL_TIMEOUT
205 );
206 dev_dbg(dev, "%s - Send get_FW_version URB returns: %i\n", __func__, result);
207 if (result >= 3) {
208 dev_dbg(dev, "Firmware version: %i.%i.%i\n", transfer_buffer[0],
209 transfer_buffer[1], transfer_buffer[2]);
210 }
211
212 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
213 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
214 /* Setting Baudrate, Parity and Stopbits */
215 result = usb_control_msg(port->serial->dev,
216 usb_sndctrlpipe(port->serial->dev, 0),
217 SUSBCRequest_SetBaudRateParityAndStopBits,
218 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
219 SUSBCR_SBR_9600 | SUSBCR_SPASB_EvenParity |
220 SUSBCR_SPASB_1StopBit,
221 0,
222 NULL,
223 0,
224 KOBIL_TIMEOUT
225 );
226 dev_dbg(dev, "%s - Send set_baudrate URB returns: %i\n", __func__, result);
227
228 /* reset all queues */
229 result = usb_control_msg(port->serial->dev,
230 usb_sndctrlpipe(port->serial->dev, 0),
231 SUSBCRequest_Misc,
232 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
233 SUSBCR_MSC_ResetAllQueues,
234 0,
235 NULL,
236 0,
237 KOBIL_TIMEOUT
238 );
239 dev_dbg(dev, "%s - Send reset_all_queues URB returns: %i\n", __func__, result);
240 }
241 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
242 priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
243 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
244 /* start reading (Adapter B 'cause PNP string) */
245 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
246 dev_dbg(dev, "%s - Send read URB returns: %i\n", __func__, result);
247 }
248
249 kfree(transfer_buffer);
250 return 0;
251}
252
253
254static void kobil_close(struct usb_serial_port *port)
255{
256 /* FIXME: Add rts/dtr methods */
257 usb_kill_urb(port->interrupt_out_urb);
258 usb_kill_urb(port->interrupt_in_urb);
259}
260
261
262static void kobil_read_int_callback(struct urb *urb)
263{
264 int result;
265 struct usb_serial_port *port = urb->context;
266 unsigned char *data = urb->transfer_buffer;
267 int status = urb->status;
268
269 if (status) {
270 dev_dbg(&port->dev, "%s - Read int status not zero: %d\n", __func__, status);
271 return;
272 }
273
274 if (urb->actual_length) {
275 usb_serial_debug_data(&port->dev, __func__, urb->actual_length,
276 data);
277 tty_insert_flip_string(&port->port, data, urb->actual_length);
278 tty_flip_buffer_push(&port->port);
279 }
280
281 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
282 dev_dbg(&port->dev, "%s - Send read URB returns: %i\n", __func__, result);
283}
284
285
286static void kobil_write_int_callback(struct urb *urb)
287{
288}
289
290
291static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
292 const unsigned char *buf, int count)
293{
294 int length = 0;
295 int result = 0;
296 int todo = 0;
297 struct kobil_private *priv;
298
299 if (count == 0) {
300 dev_dbg(&port->dev, "%s - write request of 0 bytes\n", __func__);
301 return 0;
302 }
303
304 priv = usb_get_serial_port_data(port);
305
306 if (count > (KOBIL_BUF_LENGTH - priv->filled)) {
307 dev_dbg(&port->dev, "%s - Error: write request bigger than buffer size\n", __func__);
308 return -ENOMEM;
309 }
310
311 /* Copy data to buffer */
312 memcpy(priv->buf + priv->filled, buf, count);
313 usb_serial_debug_data(&port->dev, __func__, count, priv->buf + priv->filled);
314 priv->filled = priv->filled + count;
315
316 /* only send complete block. TWIN, KAAN SIM and adapter K
317 use the same protocol. */
318 if (((priv->device_type != KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 2) && (priv->filled >= (priv->buf[1] + 3))) ||
319 ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 3) && (priv->filled >= (priv->buf[2] + 4)))) {
320 /* stop reading (except TWIN and KAAN SIM) */
321 if ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID)
322 || (priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID))
323 usb_kill_urb(port->interrupt_in_urb);
324
325 todo = priv->filled - priv->cur_pos;
326
327 while (todo > 0) {
328 /* max 8 byte in one urb (endpoint size) */
329 length = min(todo, port->interrupt_out_size);
330 /* copy data to transfer buffer */
331 memcpy(port->interrupt_out_buffer,
332 priv->buf + priv->cur_pos, length);
333 port->interrupt_out_urb->transfer_buffer_length = length;
334
335 priv->cur_pos = priv->cur_pos + length;
336 result = usb_submit_urb(port->interrupt_out_urb,
337 GFP_ATOMIC);
338 dev_dbg(&port->dev, "%s - Send write URB returns: %i\n", __func__, result);
339 todo = priv->filled - priv->cur_pos;
340
341 if (todo > 0)
342 msleep(24);
343 }
344
345 priv->filled = 0;
346 priv->cur_pos = 0;
347
348 /* start reading (except TWIN and KAAN SIM) */
349 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
350 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
351 result = usb_submit_urb(port->interrupt_in_urb,
352 GFP_ATOMIC);
353 dev_dbg(&port->dev, "%s - Send read URB returns: %i\n", __func__, result);
354 }
355 }
356 return count;
357}
358
359
360static unsigned int kobil_write_room(struct tty_struct *tty)
361{
362 /* FIXME */
363 return 8;
364}
365
366
367static int kobil_tiocmget(struct tty_struct *tty)
368{
369 struct usb_serial_port *port = tty->driver_data;
370 struct kobil_private *priv;
371 int result;
372 unsigned char *transfer_buffer;
373 int transfer_buffer_length = 8;
374
375 priv = usb_get_serial_port_data(port);
376 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
377 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
378 /* This device doesn't support ioctl calls */
379 return -EINVAL;
380 }
381
382 /* allocate memory for transfer buffer */
383 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
384 if (!transfer_buffer)
385 return -ENOMEM;
386
387 result = usb_control_msg(port->serial->dev,
388 usb_rcvctrlpipe(port->serial->dev, 0),
389 SUSBCRequest_GetStatusLineState,
390 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
391 0,
392 0,
393 transfer_buffer,
394 transfer_buffer_length,
395 KOBIL_TIMEOUT);
396
397 dev_dbg(&port->dev, "Send get_status_line_state URB returns: %i\n",
398 result);
399 if (result < 1) {
400 if (result >= 0)
401 result = -EIO;
402 goto out_free;
403 }
404
405 dev_dbg(&port->dev, "Statusline: %02x\n", transfer_buffer[0]);
406
407 result = 0;
408 if ((transfer_buffer[0] & SUSBCR_GSL_DSR) != 0)
409 result = TIOCM_DSR;
410out_free:
411 kfree(transfer_buffer);
412 return result;
413}
414
415static int kobil_tiocmset(struct tty_struct *tty,
416 unsigned int set, unsigned int clear)
417{
418 struct usb_serial_port *port = tty->driver_data;
419 struct device *dev = &port->dev;
420 struct kobil_private *priv;
421 int result;
422 int dtr = 0;
423 int rts = 0;
424
425 /* FIXME: locking ? */
426 priv = usb_get_serial_port_data(port);
427 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
428 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
429 /* This device doesn't support ioctl calls */
430 return -EINVAL;
431 }
432
433 if (set & TIOCM_RTS)
434 rts = 1;
435 if (set & TIOCM_DTR)
436 dtr = 1;
437 if (clear & TIOCM_RTS)
438 rts = 0;
439 if (clear & TIOCM_DTR)
440 dtr = 0;
441
442 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) {
443 if (dtr != 0)
444 dev_dbg(dev, "%s - Setting DTR\n", __func__);
445 else
446 dev_dbg(dev, "%s - Clearing DTR\n", __func__);
447 result = usb_control_msg(port->serial->dev,
448 usb_sndctrlpipe(port->serial->dev, 0),
449 SUSBCRequest_SetStatusLinesOrQueues,
450 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
451 ((dtr != 0) ? SUSBCR_SSL_SETDTR : SUSBCR_SSL_CLRDTR),
452 0,
453 NULL,
454 0,
455 KOBIL_TIMEOUT);
456 } else {
457 if (rts != 0)
458 dev_dbg(dev, "%s - Setting RTS\n", __func__);
459 else
460 dev_dbg(dev, "%s - Clearing RTS\n", __func__);
461 result = usb_control_msg(port->serial->dev,
462 usb_sndctrlpipe(port->serial->dev, 0),
463 SUSBCRequest_SetStatusLinesOrQueues,
464 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
465 ((rts != 0) ? SUSBCR_SSL_SETRTS : SUSBCR_SSL_CLRRTS),
466 0,
467 NULL,
468 0,
469 KOBIL_TIMEOUT);
470 }
471 dev_dbg(dev, "%s - Send set_status_line URB returns: %i\n", __func__, result);
472 return (result < 0) ? result : 0;
473}
474
475static void kobil_set_termios(struct tty_struct *tty,
476 struct usb_serial_port *port,
477 const struct ktermios *old)
478{
479 struct kobil_private *priv;
480 int result;
481 unsigned short urb_val = 0;
482 int c_cflag = tty->termios.c_cflag;
483 speed_t speed;
484
485 priv = usb_get_serial_port_data(port);
486 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
487 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
488 /* This device doesn't support ioctl calls */
489 tty_termios_copy_hw(&tty->termios, old);
490 return;
491 }
492
493 speed = tty_get_baud_rate(tty);
494 switch (speed) {
495 case 1200:
496 urb_val = SUSBCR_SBR_1200;
497 break;
498 default:
499 speed = 9600;
500 fallthrough;
501 case 9600:
502 urb_val = SUSBCR_SBR_9600;
503 break;
504 }
505 urb_val |= (c_cflag & CSTOPB) ? SUSBCR_SPASB_2StopBits :
506 SUSBCR_SPASB_1StopBit;
507 if (c_cflag & PARENB) {
508 if (c_cflag & PARODD)
509 urb_val |= SUSBCR_SPASB_OddParity;
510 else
511 urb_val |= SUSBCR_SPASB_EvenParity;
512 } else
513 urb_val |= SUSBCR_SPASB_NoParity;
514 tty->termios.c_cflag &= ~CMSPAR;
515 tty_encode_baud_rate(tty, speed, speed);
516
517 result = usb_control_msg(port->serial->dev,
518 usb_sndctrlpipe(port->serial->dev, 0),
519 SUSBCRequest_SetBaudRateParityAndStopBits,
520 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
521 urb_val,
522 0,
523 NULL,
524 0,
525 KOBIL_TIMEOUT
526 );
527 if (result) {
528 dev_err(&port->dev, "failed to update line settings: %d\n",
529 result);
530 }
531}
532
533static int kobil_ioctl(struct tty_struct *tty,
534 unsigned int cmd, unsigned long arg)
535{
536 struct usb_serial_port *port = tty->driver_data;
537 struct kobil_private *priv = usb_get_serial_port_data(port);
538 int result;
539
540 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
541 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID)
542 /* This device doesn't support ioctl calls */
543 return -ENOIOCTLCMD;
544
545 switch (cmd) {
546 case TCFLSH:
547 result = usb_control_msg(port->serial->dev,
548 usb_sndctrlpipe(port->serial->dev, 0),
549 SUSBCRequest_Misc,
550 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
551 SUSBCR_MSC_ResetAllQueues,
552 0,
553 NULL,
554 0,
555 KOBIL_TIMEOUT
556 );
557
558 dev_dbg(&port->dev,
559 "%s - Send reset_all_queues (FLUSH) URB returns: %i\n",
560 __func__, result);
561 return (result < 0) ? -EIO: 0;
562 default:
563 return -ENOIOCTLCMD;
564 }
565}
566
567module_usb_serial_driver(serial_drivers, id_table);
568
569MODULE_AUTHOR(DRIVER_AUTHOR);
570MODULE_DESCRIPTION(DRIVER_DESC);
571MODULE_LICENSE("GPL");
1/*
2 * KOBIL USB Smart Card Terminal Driver
3 *
4 * Copyright (C) 2002 KOBIL Systems GmbH
5 * Author: Thomas Wahrenbruch
6 *
7 * Contact: linuxusb@kobil.de
8 *
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.
12 *
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.
17 *
18 * Thanks to Greg Kroah-Hartman (greg@kroah.com) for his help and
19 * patience.
20 *
21 * Supported readers: USB TWIN, KAAN Standard Plus and SecOVID Reader Plus
22 * (Adapter K), B1 Professional and KAAN Professional (Adapter B)
23 */
24
25
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"
40
41static bool debug;
42
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)"
47
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
53
54#define KOBIL_TIMEOUT 500
55#define KOBIL_BUF_LENGTH 300
56
57
58/* Function prototypes */
59static int kobil_startup(struct usb_serial *serial);
60static void kobil_release(struct usb_serial *serial);
61static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port);
62static void kobil_close(struct usb_serial_port *port);
63static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
64 const unsigned char *buf, int count);
65static int kobil_write_room(struct tty_struct *tty);
66static int kobil_ioctl(struct tty_struct *tty,
67 unsigned int cmd, unsigned long arg);
68static int kobil_tiocmget(struct tty_struct *tty);
69static int kobil_tiocmset(struct tty_struct *tty,
70 unsigned int set, unsigned int clear);
71static void kobil_read_int_callback(struct urb *urb);
72static void kobil_write_callback(struct urb *purb);
73static void kobil_set_termios(struct tty_struct *tty,
74 struct usb_serial_port *port, struct ktermios *old);
75static void kobil_init_termios(struct tty_struct *tty);
76
77static 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 */
83};
84MODULE_DEVICE_TABLE(usb, id_table);
85
86static struct usb_serial_driver kobil_device = {
87 .driver = {
88 .owner = THIS_MODULE,
89 .name = "kobil",
90 },
91 .description = "KOBIL USB smart card terminal",
92 .id_table = id_table,
93 .num_ports = 1,
94 .attach = kobil_startup,
95 .release = kobil_release,
96 .ioctl = kobil_ioctl,
97 .set_termios = kobil_set_termios,
98 .init_termios = kobil_init_termios,
99 .tiocmget = kobil_tiocmget,
100 .tiocmset = kobil_tiocmset,
101 .open = kobil_open,
102 .close = kobil_close,
103 .write = kobil_write,
104 .write_room = kobil_write_room,
105 .read_int_callback = kobil_read_int_callback,
106};
107
108static struct usb_serial_driver * const serial_drivers[] = {
109 &kobil_device, NULL
110};
111
112struct kobil_private {
113 int write_int_endpoint_address;
114 int read_int_endpoint_address;
115 unsigned char buf[KOBIL_BUF_LENGTH]; /* buffer for the APDU to send */
116 int filled; /* index of the last char in buf */
117 int cur_pos; /* index of the next char to send in buf */
118 __u16 device_type;
119};
120
121
122static int kobil_startup(struct usb_serial *serial)
123{
124 int i;
125 struct kobil_private *priv;
126 struct usb_device *pdev;
127 struct usb_host_config *actconfig;
128 struct usb_interface *interface;
129 struct usb_host_interface *altsetting;
130 struct usb_host_endpoint *endpoint;
131
132 priv = kmalloc(sizeof(struct kobil_private), GFP_KERNEL);
133 if (!priv)
134 return -ENOMEM;
135
136 priv->filled = 0;
137 priv->cur_pos = 0;
138 priv->device_type = le16_to_cpu(serial->dev->descriptor.idProduct);
139
140 switch (priv->device_type) {
141 case KOBIL_ADAPTER_B_PRODUCT_ID:
142 printk(KERN_DEBUG "KOBIL B1 PRO / KAAN PRO detected\n");
143 break;
144 case KOBIL_ADAPTER_K_PRODUCT_ID:
145 printk(KERN_DEBUG
146 "KOBIL KAAN Standard Plus / SecOVID Reader Plus detected\n");
147 break;
148 case KOBIL_USBTWIN_PRODUCT_ID:
149 printk(KERN_DEBUG "KOBIL USBTWIN detected\n");
150 break;
151 case KOBIL_KAAN_SIM_PRODUCT_ID:
152 printk(KERN_DEBUG "KOBIL KAAN SIM detected\n");
153 break;
154 }
155 usb_set_serial_port_data(serial->port[0], priv);
156
157 /* search for the necessary endpoints */
158 pdev = serial->dev;
159 actconfig = pdev->actconfig;
160 interface = actconfig->interface[0];
161 altsetting = interface->cur_altsetting;
162 endpoint = altsetting->endpoint;
163
164 for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
165 endpoint = &altsetting->endpoint[i];
166 if (usb_endpoint_is_int_out(&endpoint->desc)) {
167 dbg("%s Found interrupt out endpoint. Address: %d",
168 __func__, endpoint->desc.bEndpointAddress);
169 priv->write_int_endpoint_address =
170 endpoint->desc.bEndpointAddress;
171 }
172 if (usb_endpoint_is_int_in(&endpoint->desc)) {
173 dbg("%s Found interrupt in endpoint. Address: %d",
174 __func__, endpoint->desc.bEndpointAddress);
175 priv->read_int_endpoint_address =
176 endpoint->desc.bEndpointAddress;
177 }
178 }
179 return 0;
180}
181
182
183static void kobil_release(struct usb_serial *serial)
184{
185 int i;
186
187 for (i = 0; i < serial->num_ports; ++i)
188 kfree(usb_get_serial_port_data(serial->port[i]));
189}
190
191static void kobil_init_termios(struct tty_struct *tty)
192{
193 /* Default to echo off and other sane device settings */
194 tty->termios->c_lflag = 0;
195 tty->termios->c_lflag &= ~(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;
199}
200
201static int kobil_open(struct tty_struct *tty, struct usb_serial_port *port)
202{
203 int result = 0;
204 struct kobil_private *priv;
205 unsigned char *transfer_buffer;
206 int transfer_buffer_length = 8;
207 int write_urb_transfer_buffer_length = 8;
208
209 priv = usb_get_serial_port_data(port);
210
211 /* allocate memory for transfer buffer */
212 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
213 if (!transfer_buffer)
214 return -ENOMEM;
215
216 /* allocate write_urb */
217 if (!port->write_urb) {
218 dbg("%s - port %d Allocating port->write_urb",
219 __func__, port->number);
220 port->write_urb = usb_alloc_urb(0, GFP_KERNEL);
221 if (!port->write_urb) {
222 dbg("%s - port %d usb_alloc_urb failed",
223 __func__, port->number);
224 kfree(transfer_buffer);
225 return -ENOMEM;
226 }
227 }
228
229 /* allocate memory for write_urb transfer buffer */
230 port->write_urb->transfer_buffer =
231 kmalloc(write_urb_transfer_buffer_length, GFP_KERNEL);
232 if (!port->write_urb->transfer_buffer) {
233 kfree(transfer_buffer);
234 usb_free_urb(port->write_urb);
235 port->write_urb = NULL;
236 return -ENOMEM;
237 }
238
239 /* get hardware version */
240 result = usb_control_msg(port->serial->dev,
241 usb_rcvctrlpipe(port->serial->dev, 0),
242 SUSBCRequest_GetMisc,
243 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
244 SUSBCR_MSC_GetHWVersion,
245 0,
246 transfer_buffer,
247 transfer_buffer_length,
248 KOBIL_TIMEOUT
249 );
250 dbg("%s - port %d Send get_HW_version URB returns: %i",
251 __func__, port->number, result);
252 dbg("Harware version: %i.%i.%i",
253 transfer_buffer[0], transfer_buffer[1], transfer_buffer[2]);
254
255 /* get firmware version */
256 result = usb_control_msg(port->serial->dev,
257 usb_rcvctrlpipe(port->serial->dev, 0),
258 SUSBCRequest_GetMisc,
259 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
260 SUSBCR_MSC_GetFWVersion,
261 0,
262 transfer_buffer,
263 transfer_buffer_length,
264 KOBIL_TIMEOUT
265 );
266 dbg("%s - port %d Send get_FW_version URB returns: %i",
267 __func__, port->number, result);
268 dbg("Firmware version: %i.%i.%i",
269 transfer_buffer[0], transfer_buffer[1], transfer_buffer[2]);
270
271 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
272 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
273 /* Setting Baudrate, Parity and Stopbits */
274 result = usb_control_msg(port->serial->dev,
275 usb_rcvctrlpipe(port->serial->dev, 0),
276 SUSBCRequest_SetBaudRateParityAndStopBits,
277 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
278 SUSBCR_SBR_9600 | SUSBCR_SPASB_EvenParity |
279 SUSBCR_SPASB_1StopBit,
280 0,
281 transfer_buffer,
282 0,
283 KOBIL_TIMEOUT
284 );
285 dbg("%s - port %d Send set_baudrate URB returns: %i",
286 __func__, port->number, result);
287
288 /* reset all queues */
289 result = usb_control_msg(port->serial->dev,
290 usb_rcvctrlpipe(port->serial->dev, 0),
291 SUSBCRequest_Misc,
292 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
293 SUSBCR_MSC_ResetAllQueues,
294 0,
295 transfer_buffer,
296 0,
297 KOBIL_TIMEOUT
298 );
299 dbg("%s - port %d Send reset_all_queues URB returns: %i",
300 __func__, port->number, result);
301 }
302 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
303 priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
304 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
305 /* start reading (Adapter B 'cause PNP string) */
306 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
307 dbg("%s - port %d Send read URB returns: %i",
308 __func__, port->number, result);
309 }
310
311 kfree(transfer_buffer);
312 return 0;
313}
314
315
316static void kobil_close(struct usb_serial_port *port)
317{
318 /* FIXME: Add rts/dtr methods */
319 if (port->write_urb) {
320 usb_poison_urb(port->write_urb);
321 kfree(port->write_urb->transfer_buffer);
322 usb_free_urb(port->write_urb);
323 port->write_urb = NULL;
324 }
325 usb_kill_urb(port->interrupt_in_urb);
326}
327
328
329static void kobil_read_int_callback(struct urb *urb)
330{
331 int result;
332 struct usb_serial_port *port = urb->context;
333 struct tty_struct *tty;
334 unsigned char *data = urb->transfer_buffer;
335 int status = urb->status;
336/* char *dbg_data; */
337
338 if (status) {
339 dbg("%s - port %d Read int status not zero: %d",
340 __func__, port->number, status);
341 return;
342 }
343
344 tty = tty_port_tty_get(&port->port);
345 if (tty && urb->actual_length) {
346
347 /* BEGIN DEBUG */
348 /*
349 dbg_data = kzalloc((3 * purb->actual_length + 10)
350 * sizeof(char), GFP_KERNEL);
351 if (! dbg_data) {
352 return;
353 }
354 for (i = 0; i < purb->actual_length; i++) {
355 sprintf(dbg_data +3*i, "%02X ", data[i]);
356 }
357 dbg(" <-- %s", dbg_data);
358 kfree(dbg_data);
359 */
360 /* END DEBUG */
361
362 tty_insert_flip_string(tty, data, urb->actual_length);
363 tty_flip_buffer_push(tty);
364 }
365 tty_kref_put(tty);
366
367 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
368 dbg("%s - port %d Send read URB returns: %i",
369 __func__, port->number, result);
370}
371
372
373static void kobil_write_callback(struct urb *purb)
374{
375}
376
377
378static int kobil_write(struct tty_struct *tty, struct usb_serial_port *port,
379 const unsigned char *buf, int count)
380{
381 int length = 0;
382 int result = 0;
383 int todo = 0;
384 struct kobil_private *priv;
385
386 if (count == 0) {
387 dbg("%s - port %d write request of 0 bytes",
388 __func__, port->number);
389 return 0;
390 }
391
392 priv = usb_get_serial_port_data(port);
393
394 if (count > (KOBIL_BUF_LENGTH - priv->filled)) {
395 dbg("%s - port %d Error: write request bigger than buffer size", __func__, port->number);
396 return -ENOMEM;
397 }
398
399 /* Copy data to buffer */
400 memcpy(priv->buf + priv->filled, buf, count);
401 usb_serial_debug_data(debug, &port->dev, __func__, count,
402 priv->buf + priv->filled);
403 priv->filled = priv->filled + count;
404
405 /* only send complete block. TWIN, KAAN SIM and adapter K
406 use the same protocol. */
407 if (((priv->device_type != KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 2) && (priv->filled >= (priv->buf[1] + 3))) ||
408 ((priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) && (priv->filled > 3) && (priv->filled >= (priv->buf[2] + 4)))) {
409 /* stop 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 usb_kill_urb(port->interrupt_in_urb);
413
414 todo = priv->filled - priv->cur_pos;
415
416 while (todo > 0) {
417 /* max 8 byte in one urb (endpoint size) */
418 length = (todo < 8) ? todo : 8;
419 /* copy data to transfer buffer */
420 memcpy(port->write_urb->transfer_buffer,
421 priv->buf + priv->cur_pos, length);
422 usb_fill_int_urb(port->write_urb,
423 port->serial->dev,
424 usb_sndintpipe(port->serial->dev,
425 priv->write_int_endpoint_address),
426 port->write_urb->transfer_buffer,
427 length,
428 kobil_write_callback,
429 port,
430 8
431 );
432
433 priv->cur_pos = priv->cur_pos + length;
434 result = usb_submit_urb(port->write_urb, GFP_NOIO);
435 dbg("%s - port %d Send write URB returns: %i",
436 __func__, port->number, result);
437 todo = priv->filled - priv->cur_pos;
438
439 if (todo > 0)
440 msleep(24);
441 }
442
443 priv->filled = 0;
444 priv->cur_pos = 0;
445
446 /* start reading (except TWIN and KAAN SIM) */
447 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID ||
448 priv->device_type == KOBIL_ADAPTER_K_PRODUCT_ID) {
449 result = usb_submit_urb(port->interrupt_in_urb,
450 GFP_NOIO);
451 dbg("%s - port %d Send read URB returns: %i",
452 __func__, port->number, result);
453 }
454 }
455 return count;
456}
457
458
459static int kobil_write_room(struct tty_struct *tty)
460{
461 /* FIXME */
462 return 8;
463}
464
465
466static int kobil_tiocmget(struct tty_struct *tty)
467{
468 struct usb_serial_port *port = tty->driver_data;
469 struct kobil_private *priv;
470 int result;
471 unsigned char *transfer_buffer;
472 int transfer_buffer_length = 8;
473
474 priv = usb_get_serial_port_data(port);
475 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
476 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
477 /* This device doesn't support ioctl calls */
478 return -EINVAL;
479 }
480
481 /* allocate memory for transfer buffer */
482 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
483 if (!transfer_buffer)
484 return -ENOMEM;
485
486 result = usb_control_msg(port->serial->dev,
487 usb_rcvctrlpipe(port->serial->dev, 0),
488 SUSBCRequest_GetStatusLineState,
489 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_IN,
490 0,
491 0,
492 transfer_buffer,
493 transfer_buffer_length,
494 KOBIL_TIMEOUT);
495
496 dbg("%s - port %d Send get_status_line_state URB returns: %i. Statusline: %02x",
497 __func__, port->number, result, transfer_buffer[0]);
498
499 result = 0;
500 if ((transfer_buffer[0] & SUSBCR_GSL_DSR) != 0)
501 result = TIOCM_DSR;
502 kfree(transfer_buffer);
503 return result;
504}
505
506static int kobil_tiocmset(struct tty_struct *tty,
507 unsigned int set, unsigned int clear)
508{
509 struct usb_serial_port *port = tty->driver_data;
510 struct kobil_private *priv;
511 int result;
512 int dtr = 0;
513 int rts = 0;
514 unsigned char *transfer_buffer;
515 int transfer_buffer_length = 8;
516
517 /* FIXME: locking ? */
518 priv = usb_get_serial_port_data(port);
519 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID
520 || priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
521 /* This device doesn't support ioctl calls */
522 return -EINVAL;
523 }
524
525 /* allocate memory for transfer buffer */
526 transfer_buffer = kzalloc(transfer_buffer_length, GFP_KERNEL);
527 if (!transfer_buffer)
528 return -ENOMEM;
529
530 if (set & TIOCM_RTS)
531 rts = 1;
532 if (set & TIOCM_DTR)
533 dtr = 1;
534 if (clear & TIOCM_RTS)
535 rts = 0;
536 if (clear & TIOCM_DTR)
537 dtr = 0;
538
539 if (priv->device_type == KOBIL_ADAPTER_B_PRODUCT_ID) {
540 if (dtr != 0)
541 dbg("%s - port %d Setting DTR",
542 __func__, port->number);
543 else
544 dbg("%s - port %d Clearing DTR",
545 __func__, port->number);
546 result = usb_control_msg(port->serial->dev,
547 usb_rcvctrlpipe(port->serial->dev, 0),
548 SUSBCRequest_SetStatusLinesOrQueues,
549 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
550 ((dtr != 0) ? SUSBCR_SSL_SETDTR : SUSBCR_SSL_CLRDTR),
551 0,
552 transfer_buffer,
553 0,
554 KOBIL_TIMEOUT);
555 } else {
556 if (rts != 0)
557 dbg("%s - port %d Setting RTS",
558 __func__, port->number);
559 else
560 dbg("%s - port %d Clearing RTS",
561 __func__, port->number);
562 result = usb_control_msg(port->serial->dev,
563 usb_rcvctrlpipe(port->serial->dev, 0),
564 SUSBCRequest_SetStatusLinesOrQueues,
565 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
566 ((rts != 0) ? SUSBCR_SSL_SETRTS : SUSBCR_SSL_CLRRTS),
567 0,
568 transfer_buffer,
569 0,
570 KOBIL_TIMEOUT);
571 }
572 dbg("%s - port %d Send set_status_line URB returns: %i",
573 __func__, port->number, result);
574 kfree(transfer_buffer);
575 return (result < 0) ? result : 0;
576}
577
578static void kobil_set_termios(struct tty_struct *tty,
579 struct usb_serial_port *port, struct ktermios *old)
580{
581 struct kobil_private *priv;
582 int result;
583 unsigned short urb_val = 0;
584 int c_cflag = tty->termios->c_cflag;
585 speed_t speed;
586
587 priv = usb_get_serial_port_data(port);
588 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
589 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID) {
590 /* This device doesn't support ioctl calls */
591 *tty->termios = *old;
592 return;
593 }
594
595 speed = tty_get_baud_rate(tty);
596 switch (speed) {
597 case 1200:
598 urb_val = SUSBCR_SBR_1200;
599 break;
600 default:
601 speed = 9600;
602 case 9600:
603 urb_val = SUSBCR_SBR_9600;
604 break;
605 }
606 urb_val |= (c_cflag & CSTOPB) ? SUSBCR_SPASB_2StopBits :
607 SUSBCR_SPASB_1StopBit;
608 if (c_cflag & PARENB) {
609 if (c_cflag & PARODD)
610 urb_val |= SUSBCR_SPASB_OddParity;
611 else
612 urb_val |= SUSBCR_SPASB_EvenParity;
613 } else
614 urb_val |= SUSBCR_SPASB_NoParity;
615 tty->termios->c_cflag &= ~CMSPAR;
616 tty_encode_baud_rate(tty, speed, speed);
617
618 result = usb_control_msg(port->serial->dev,
619 usb_rcvctrlpipe(port->serial->dev, 0),
620 SUSBCRequest_SetBaudRateParityAndStopBits,
621 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
622 urb_val,
623 0,
624 NULL,
625 0,
626 KOBIL_TIMEOUT
627 );
628}
629
630static int kobil_ioctl(struct tty_struct *tty,
631 unsigned int cmd, unsigned long arg)
632{
633 struct usb_serial_port *port = tty->driver_data;
634 struct kobil_private *priv = usb_get_serial_port_data(port);
635 unsigned char *transfer_buffer;
636 int transfer_buffer_length = 8;
637 int result;
638
639 if (priv->device_type == KOBIL_USBTWIN_PRODUCT_ID ||
640 priv->device_type == KOBIL_KAAN_SIM_PRODUCT_ID)
641 /* This device doesn't support ioctl calls */
642 return -ENOIOCTLCMD;
643
644 switch (cmd) {
645 case TCFLSH:
646 transfer_buffer = kmalloc(transfer_buffer_length, GFP_KERNEL);
647 if (!transfer_buffer)
648 return -ENOBUFS;
649
650 result = usb_control_msg(port->serial->dev,
651 usb_rcvctrlpipe(port->serial->dev, 0),
652 SUSBCRequest_Misc,
653 USB_TYPE_VENDOR | USB_RECIP_ENDPOINT | USB_DIR_OUT,
654 SUSBCR_MSC_ResetAllQueues,
655 0,
656 NULL, /* transfer_buffer, */
657 0,
658 KOBIL_TIMEOUT
659 );
660
661 dbg("%s - port %d Send reset_all_queues (FLUSH) URB returns: %i", __func__, port->number, result);
662 kfree(transfer_buffer);
663 return (result < 0) ? -EIO: 0;
664 default:
665 return -ENOIOCTLCMD;
666 }
667}
668
669module_usb_serial_driver(serial_drivers, id_table);
670
671MODULE_AUTHOR(DRIVER_AUTHOR);
672MODULE_DESCRIPTION(DRIVER_DESC);
673MODULE_LICENSE("GPL");
674
675module_param(debug, bool, S_IRUGO | S_IWUSR);
676MODULE_PARM_DESC(debug, "Debug enabled or not");