2 * REINER SCT cyberJack pinpad/e-com USB Chipcard Reader Driver
4 * Copyright (C) 2001 REINER SCT
5 * Author: Matthias Bruestle
7 * Contact: support@reiner-sct.com (see MAINTAINERS)
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 * In case of problems, please write to the contact e-mail address
24 * Please note that later models of the cyberjack reader family are
25 * supported by a libusb-based userspace device driver.
27 * Homepage: http://www.reiner-sct.de/support/treiber_cyberjack.php#linux
31 #include <linux/kernel.h>
32 #include <linux/errno.h>
33 #include <linux/init.h>
34 #include <linux/slab.h>
35 #include <linux/tty.h>
36 #include <linux/tty_driver.h>
37 #include <linux/tty_flip.h>
38 #include <linux/module.h>
39 #include <linux/spinlock.h>
40 #include <linux/uaccess.h>
41 #include <linux/usb.h>
42 #include <linux/usb/serial.h>
44 #define CYBERJACK_LOCAL_BUF_SIZE 32
51 #define DRIVER_VERSION "v1.01"
52 #define DRIVER_AUTHOR "Matthias Bruestle"
53 #define DRIVER_DESC "REINER SCT cyberJack pinpad/e-com USB Chipcard Reader Driver"
56 #define CYBERJACK_VENDOR_ID 0x0C4B
57 #define CYBERJACK_PRODUCT_ID 0x0100
59 /* Function prototypes */
60 static int cyberjack_startup(struct usb_serial *serial);
61 static void cyberjack_disconnect(struct usb_serial *serial);
62 static void cyberjack_release(struct usb_serial *serial);
63 static int cyberjack_open(struct tty_struct *tty,
64 struct usb_serial_port *port);
65 static void cyberjack_close(struct usb_serial_port *port);
66 static int cyberjack_write(struct tty_struct *tty,
67 struct usb_serial_port *port, const unsigned char *buf, int count);
68 static int cyberjack_write_room(struct tty_struct *tty);
69 static void cyberjack_read_int_callback(struct urb *urb);
70 static void cyberjack_read_bulk_callback(struct urb *urb);
71 static void cyberjack_write_bulk_callback(struct urb *urb);
73 static const struct usb_device_id id_table[] = {
74 { USB_DEVICE(CYBERJACK_VENDOR_ID, CYBERJACK_PRODUCT_ID) },
75 { } /* Terminating entry */
78 MODULE_DEVICE_TABLE(usb, id_table);
80 static struct usb_driver cyberjack_driver = {
82 .probe = usb_serial_probe,
83 .disconnect = usb_serial_disconnect,
87 static struct usb_serial_driver cyberjack_device = {
92 .description = "Reiner SCT Cyberjack USB card reader",
95 .attach = cyberjack_startup,
96 .disconnect = cyberjack_disconnect,
97 .release = cyberjack_release,
98 .open = cyberjack_open,
99 .close = cyberjack_close,
100 .write = cyberjack_write,
101 .write_room = cyberjack_write_room,
102 .read_int_callback = cyberjack_read_int_callback,
103 .read_bulk_callback = cyberjack_read_bulk_callback,
104 .write_bulk_callback = cyberjack_write_bulk_callback,
107 static struct usb_serial_driver * const serial_drivers[] = {
108 &cyberjack_device, NULL
111 struct cyberjack_private {
112 spinlock_t lock; /* Lock for SMP */
113 short rdtodo; /* Bytes still to read */
114 unsigned char wrbuf[5*64]; /* Buffer for collecting data to write */
115 short wrfilled; /* Overall data size we already got */
116 short wrsent; /* Data already sent */
119 /* do some startup allocations not currently performed by usb_serial_probe() */
120 static int cyberjack_startup(struct usb_serial *serial)
122 struct cyberjack_private *priv;
127 /* allocate the private data structure */
128 priv = kmalloc(sizeof(struct cyberjack_private), GFP_KERNEL);
132 /* set initial values */
133 spin_lock_init(&priv->lock);
137 usb_set_serial_port_data(serial->port[0], priv);
139 init_waitqueue_head(&serial->port[0]->write_wait);
141 for (i = 0; i < serial->num_ports; ++i) {
143 result = usb_submit_urb(serial->port[i]->interrupt_in_urb,
146 dev_err(&serial->dev->dev,
147 "usb_submit_urb(read int) failed\n");
148 dbg("%s - usb_submit_urb(int urb)", __func__);
154 static void cyberjack_disconnect(struct usb_serial *serial)
160 for (i = 0; i < serial->num_ports; ++i)
161 usb_kill_urb(serial->port[i]->interrupt_in_urb);
164 static void cyberjack_release(struct usb_serial *serial)
170 for (i = 0; i < serial->num_ports; ++i) {
171 /* My special items, the standard routines free my urbs */
172 kfree(usb_get_serial_port_data(serial->port[i]));
176 static int cyberjack_open(struct tty_struct *tty,
177 struct usb_serial_port *port)
179 struct cyberjack_private *priv;
183 dbg("%s - port %d", __func__, port->number);
185 dbg("%s - usb_clear_halt", __func__);
186 usb_clear_halt(port->serial->dev, port->write_urb->pipe);
188 priv = usb_get_serial_port_data(port);
189 spin_lock_irqsave(&priv->lock, flags);
193 spin_unlock_irqrestore(&priv->lock, flags);
198 static void cyberjack_close(struct usb_serial_port *port)
200 dbg("%s - port %d", __func__, port->number);
202 if (port->serial->dev) {
203 /* shutdown any bulk reads that might be going on */
204 usb_kill_urb(port->write_urb);
205 usb_kill_urb(port->read_urb);
209 static int cyberjack_write(struct tty_struct *tty,
210 struct usb_serial_port *port, const unsigned char *buf, int count)
212 struct cyberjack_private *priv = usb_get_serial_port_data(port);
217 dbg("%s - port %d", __func__, port->number);
220 dbg("%s - write request of 0 bytes", __func__);
224 if (!test_and_clear_bit(0, &port->write_urbs_free)) {
225 dbg("%s - already writing", __func__);
229 spin_lock_irqsave(&priv->lock, flags);
231 if (count+priv->wrfilled > sizeof(priv->wrbuf)) {
232 /* To much data for buffer. Reset buffer. */
234 spin_unlock_irqrestore(&priv->lock, flags);
235 set_bit(0, &port->write_urbs_free);
240 memcpy(priv->wrbuf + priv->wrfilled, buf, count);
242 usb_serial_debug_data(debug, &port->dev, __func__, count,
243 priv->wrbuf + priv->wrfilled);
244 priv->wrfilled += count;
246 if (priv->wrfilled >= 3) {
247 wrexpected = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3;
248 dbg("%s - expected data: %d", __func__, wrexpected);
250 wrexpected = sizeof(priv->wrbuf);
252 if (priv->wrfilled >= wrexpected) {
253 /* We have enough data to begin transmission */
256 dbg("%s - transmitting data (frame 1)", __func__);
257 length = (wrexpected > port->bulk_out_size) ?
258 port->bulk_out_size : wrexpected;
260 memcpy(port->write_urb->transfer_buffer, priv->wrbuf, length);
261 priv->wrsent = length;
264 port->write_urb->transfer_buffer_length = length;
266 /* send the data out the bulk port */
267 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
270 "%s - failed submitting write urb, error %d",
272 /* Throw away data. No better idea what to do with it. */
275 spin_unlock_irqrestore(&priv->lock, flags);
276 set_bit(0, &port->write_urbs_free);
280 dbg("%s - priv->wrsent=%d", __func__, priv->wrsent);
281 dbg("%s - priv->wrfilled=%d", __func__, priv->wrfilled);
283 if (priv->wrsent >= priv->wrfilled) {
284 dbg("%s - buffer cleaned", __func__);
285 memset(priv->wrbuf, 0, sizeof(priv->wrbuf));
291 spin_unlock_irqrestore(&priv->lock, flags);
296 static int cyberjack_write_room(struct tty_struct *tty)
299 return CYBERJACK_LOCAL_BUF_SIZE;
302 static void cyberjack_read_int_callback(struct urb *urb)
304 struct usb_serial_port *port = urb->context;
305 struct cyberjack_private *priv = usb_get_serial_port_data(port);
306 unsigned char *data = urb->transfer_buffer;
307 int status = urb->status;
310 dbg("%s - port %d", __func__, port->number);
312 /* the urb might have been killed. */
316 usb_serial_debug_data(debug, &port->dev, __func__,
317 urb->actual_length, data);
319 /* React only to interrupts signaling a bulk_in transfer */
320 if (urb->actual_length == 4 && data[0] == 0x01) {
323 /* This is a announcement of coming bulk_ins. */
324 unsigned short size = ((unsigned short)data[3]<<8)+data[2]+3;
326 spin_lock(&priv->lock);
328 old_rdtodo = priv->rdtodo;
330 if (old_rdtodo + size < old_rdtodo) {
331 dbg("To many bulk_in urbs to do.");
332 spin_unlock(&priv->lock);
336 /* "+=" is probably more fault tollerant than "=" */
337 priv->rdtodo += size;
339 dbg("%s - rdtodo: %d", __func__, priv->rdtodo);
341 spin_unlock(&priv->lock);
344 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
346 dev_err(&port->dev, "%s - failed resubmitting "
347 "read urb, error %d\n",
349 dbg("%s - usb_submit_urb(read urb)", __func__);
354 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
356 dev_err(&port->dev, "usb_submit_urb(read int) failed\n");
357 dbg("%s - usb_submit_urb(int urb)", __func__);
360 static void cyberjack_read_bulk_callback(struct urb *urb)
362 struct usb_serial_port *port = urb->context;
363 struct cyberjack_private *priv = usb_get_serial_port_data(port);
364 struct tty_struct *tty;
365 unsigned char *data = urb->transfer_buffer;
368 int status = urb->status;
370 dbg("%s - port %d", __func__, port->number);
372 usb_serial_debug_data(debug, &port->dev, __func__,
373 urb->actual_length, data);
375 dbg("%s - nonzero read bulk status received: %d",
380 tty = tty_port_tty_get(&port->port);
382 dbg("%s - ignoring since device not open", __func__);
385 if (urb->actual_length) {
386 tty_insert_flip_string(tty, data, urb->actual_length);
387 tty_flip_buffer_push(tty);
391 spin_lock(&priv->lock);
393 /* Reduce urbs to do by one. */
394 priv->rdtodo -= urb->actual_length;
395 /* Just to be sure */
396 if (priv->rdtodo < 0)
400 spin_unlock(&priv->lock);
402 dbg("%s - rdtodo: %d", __func__, todo);
404 /* Continue to read if we have still urbs to do. */
405 if (todo /* || (urb->actual_length==port->bulk_in_endpointAddress)*/) {
406 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
408 dev_err(&port->dev, "%s - failed resubmitting read "
409 "urb, error %d\n", __func__, result);
410 dbg("%s - usb_submit_urb(read urb)", __func__);
414 static void cyberjack_write_bulk_callback(struct urb *urb)
416 struct usb_serial_port *port = urb->context;
417 struct cyberjack_private *priv = usb_get_serial_port_data(port);
418 int status = urb->status;
420 dbg("%s - port %d", __func__, port->number);
422 set_bit(0, &port->write_urbs_free);
424 dbg("%s - nonzero write bulk status received: %d",
429 spin_lock(&priv->lock);
431 /* only do something if we have more data to send */
432 if (priv->wrfilled) {
433 int length, blksize, result;
435 dbg("%s - transmitting data (frame n)", __func__);
437 length = ((priv->wrfilled - priv->wrsent) > port->bulk_out_size) ?
438 port->bulk_out_size : (priv->wrfilled - priv->wrsent);
440 memcpy(port->write_urb->transfer_buffer,
441 priv->wrbuf + priv->wrsent, length);
442 priv->wrsent += length;
445 port->write_urb->transfer_buffer_length = length;
447 /* send the data out the bulk port */
448 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
451 "%s - failed submitting write urb, error %d\n",
453 /* Throw away data. No better idea what to do with it. */
459 dbg("%s - priv->wrsent=%d", __func__, priv->wrsent);
460 dbg("%s - priv->wrfilled=%d", __func__, priv->wrfilled);
462 blksize = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3;
464 if (priv->wrsent >= priv->wrfilled ||
465 priv->wrsent >= blksize) {
466 dbg("%s - buffer cleaned", __func__);
467 memset(priv->wrbuf, 0, sizeof(priv->wrbuf));
474 spin_unlock(&priv->lock);
475 usb_serial_port_softint(port);
478 module_usb_serial_driver(cyberjack_driver, serial_drivers);
480 MODULE_AUTHOR(DRIVER_AUTHOR);
481 MODULE_DESCRIPTION(DRIVER_DESC);
482 MODULE_VERSION(DRIVER_VERSION);
483 MODULE_LICENSE("GPL");
485 module_param(debug, bool, S_IRUGO | S_IWUSR);
486 MODULE_PARM_DESC(debug, "Debug enabled or not");