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
46 #define DRIVER_AUTHOR "Matthias Bruestle"
47 #define DRIVER_DESC "REINER SCT cyberJack pinpad/e-com USB Chipcard Reader Driver"
50 #define CYBERJACK_VENDOR_ID 0x0C4B
51 #define CYBERJACK_PRODUCT_ID 0x0100
53 /* Function prototypes */
54 static void cyberjack_disconnect(struct usb_serial *serial);
55 static int cyberjack_port_probe(struct usb_serial_port *port);
56 static int cyberjack_port_remove(struct usb_serial_port *port);
57 static int cyberjack_open(struct tty_struct *tty,
58 struct usb_serial_port *port);
59 static void cyberjack_close(struct usb_serial_port *port);
60 static int cyberjack_write(struct tty_struct *tty,
61 struct usb_serial_port *port, const unsigned char *buf, int count);
62 static int cyberjack_write_room(struct tty_struct *tty);
63 static void cyberjack_read_int_callback(struct urb *urb);
64 static void cyberjack_read_bulk_callback(struct urb *urb);
65 static void cyberjack_write_bulk_callback(struct urb *urb);
67 static const struct usb_device_id id_table[] = {
68 { USB_DEVICE(CYBERJACK_VENDOR_ID, CYBERJACK_PRODUCT_ID) },
69 { } /* Terminating entry */
72 MODULE_DEVICE_TABLE(usb, id_table);
74 static struct usb_serial_driver cyberjack_device = {
79 .description = "Reiner SCT Cyberjack USB card reader",
82 .disconnect = cyberjack_disconnect,
83 .port_probe = cyberjack_port_probe,
84 .port_remove = cyberjack_port_remove,
85 .open = cyberjack_open,
86 .close = cyberjack_close,
87 .write = cyberjack_write,
88 .write_room = cyberjack_write_room,
89 .read_int_callback = cyberjack_read_int_callback,
90 .read_bulk_callback = cyberjack_read_bulk_callback,
91 .write_bulk_callback = cyberjack_write_bulk_callback,
94 static struct usb_serial_driver * const serial_drivers[] = {
95 &cyberjack_device, NULL
98 struct cyberjack_private {
99 spinlock_t lock; /* Lock for SMP */
100 short rdtodo; /* Bytes still to read */
101 unsigned char wrbuf[5*64]; /* Buffer for collecting data to write */
102 short wrfilled; /* Overall data size we already got */
103 short wrsent; /* Data already sent */
106 static int cyberjack_port_probe(struct usb_serial_port *port)
108 struct cyberjack_private *priv;
111 priv = kmalloc(sizeof(struct cyberjack_private), GFP_KERNEL);
115 spin_lock_init(&priv->lock);
120 usb_set_serial_port_data(port, priv);
122 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
124 dev_err(&port->dev, "usb_submit_urb(read int) failed\n");
129 static int cyberjack_port_remove(struct usb_serial_port *port)
131 struct cyberjack_private *priv;
133 priv = usb_get_serial_port_data(port);
139 static void cyberjack_disconnect(struct usb_serial *serial)
143 for (i = 0; i < serial->num_ports; ++i)
144 usb_kill_urb(serial->port[i]->interrupt_in_urb);
147 static int cyberjack_open(struct tty_struct *tty,
148 struct usb_serial_port *port)
150 struct cyberjack_private *priv;
154 dev_dbg(&port->dev, "%s - usb_clear_halt\n", __func__);
155 usb_clear_halt(port->serial->dev, port->write_urb->pipe);
157 priv = usb_get_serial_port_data(port);
158 spin_lock_irqsave(&priv->lock, flags);
162 spin_unlock_irqrestore(&priv->lock, flags);
167 static void cyberjack_close(struct usb_serial_port *port)
169 if (port->serial->dev) {
170 /* shutdown any bulk reads that might be going on */
171 usb_kill_urb(port->write_urb);
172 usb_kill_urb(port->read_urb);
176 static int cyberjack_write(struct tty_struct *tty,
177 struct usb_serial_port *port, const unsigned char *buf, int count)
179 struct device *dev = &port->dev;
180 struct cyberjack_private *priv = usb_get_serial_port_data(port);
186 dev_dbg(dev, "%s - write request of 0 bytes\n", __func__);
190 if (!test_and_clear_bit(0, &port->write_urbs_free)) {
191 dev_dbg(dev, "%s - already writing\n", __func__);
195 spin_lock_irqsave(&priv->lock, flags);
197 if (count+priv->wrfilled > sizeof(priv->wrbuf)) {
198 /* To much data for buffer. Reset buffer. */
200 spin_unlock_irqrestore(&priv->lock, flags);
201 set_bit(0, &port->write_urbs_free);
206 memcpy(priv->wrbuf + priv->wrfilled, buf, count);
208 usb_serial_debug_data(dev, __func__, count, priv->wrbuf + priv->wrfilled);
209 priv->wrfilled += count;
211 if (priv->wrfilled >= 3) {
212 wrexpected = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3;
213 dev_dbg(dev, "%s - expected data: %d\n", __func__, wrexpected);
215 wrexpected = sizeof(priv->wrbuf);
217 if (priv->wrfilled >= wrexpected) {
218 /* We have enough data to begin transmission */
221 dev_dbg(dev, "%s - transmitting data (frame 1)\n", __func__);
222 length = (wrexpected > port->bulk_out_size) ?
223 port->bulk_out_size : wrexpected;
225 memcpy(port->write_urb->transfer_buffer, priv->wrbuf, length);
226 priv->wrsent = length;
229 port->write_urb->transfer_buffer_length = length;
231 /* send the data out the bulk port */
232 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
235 "%s - failed submitting write urb, error %d",
237 /* Throw away data. No better idea what to do with it. */
240 spin_unlock_irqrestore(&priv->lock, flags);
241 set_bit(0, &port->write_urbs_free);
245 dev_dbg(dev, "%s - priv->wrsent=%d\n", __func__, priv->wrsent);
246 dev_dbg(dev, "%s - priv->wrfilled=%d\n", __func__, priv->wrfilled);
248 if (priv->wrsent >= priv->wrfilled) {
249 dev_dbg(dev, "%s - buffer cleaned\n", __func__);
250 memset(priv->wrbuf, 0, sizeof(priv->wrbuf));
256 spin_unlock_irqrestore(&priv->lock, flags);
261 static int cyberjack_write_room(struct tty_struct *tty)
264 return CYBERJACK_LOCAL_BUF_SIZE;
267 static void cyberjack_read_int_callback(struct urb *urb)
269 struct usb_serial_port *port = urb->context;
270 struct cyberjack_private *priv = usb_get_serial_port_data(port);
271 struct device *dev = &port->dev;
272 unsigned char *data = urb->transfer_buffer;
273 int status = urb->status;
276 /* the urb might have been killed. */
280 usb_serial_debug_data(dev, __func__, urb->actual_length, data);
282 /* React only to interrupts signaling a bulk_in transfer */
283 if (urb->actual_length == 4 && data[0] == 0x01) {
286 /* This is a announcement of coming bulk_ins. */
287 unsigned short size = ((unsigned short)data[3]<<8)+data[2]+3;
289 spin_lock(&priv->lock);
291 old_rdtodo = priv->rdtodo;
293 if (old_rdtodo + size < old_rdtodo) {
294 dev_dbg(dev, "To many bulk_in urbs to do.\n");
295 spin_unlock(&priv->lock);
299 /* "+=" is probably more fault tollerant than "=" */
300 priv->rdtodo += size;
302 dev_dbg(dev, "%s - rdtodo: %d\n", __func__, priv->rdtodo);
304 spin_unlock(&priv->lock);
307 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
309 dev_err(dev, "%s - failed resubmitting read urb, error %d\n",
311 dev_dbg(dev, "%s - usb_submit_urb(read urb)\n", __func__);
316 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
318 dev_err(&port->dev, "usb_submit_urb(read int) failed\n");
319 dev_dbg(dev, "%s - usb_submit_urb(int urb)\n", __func__);
322 static void cyberjack_read_bulk_callback(struct urb *urb)
324 struct usb_serial_port *port = urb->context;
325 struct cyberjack_private *priv = usb_get_serial_port_data(port);
326 struct device *dev = &port->dev;
327 struct tty_struct *tty;
328 unsigned char *data = urb->transfer_buffer;
331 int status = urb->status;
333 usb_serial_debug_data(dev, __func__, urb->actual_length, data);
335 dev_dbg(dev, "%s - nonzero read bulk status received: %d\n",
340 tty = tty_port_tty_get(&port->port);
342 dev_dbg(dev, "%s - ignoring since device not open\n", __func__);
345 if (urb->actual_length) {
346 tty_insert_flip_string(tty, data, urb->actual_length);
347 tty_flip_buffer_push(tty);
351 spin_lock(&priv->lock);
353 /* Reduce urbs to do by one. */
354 priv->rdtodo -= urb->actual_length;
355 /* Just to be sure */
356 if (priv->rdtodo < 0)
360 spin_unlock(&priv->lock);
362 dev_dbg(dev, "%s - rdtodo: %d\n", __func__, todo);
364 /* Continue to read if we have still urbs to do. */
365 if (todo /* || (urb->actual_length==port->bulk_in_endpointAddress)*/) {
366 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
368 dev_err(dev, "%s - failed resubmitting read urb, error %d\n",
370 dev_dbg(dev, "%s - usb_submit_urb(read urb)\n", __func__);
374 static void cyberjack_write_bulk_callback(struct urb *urb)
376 struct usb_serial_port *port = urb->context;
377 struct cyberjack_private *priv = usb_get_serial_port_data(port);
378 struct device *dev = &port->dev;
379 int status = urb->status;
381 set_bit(0, &port->write_urbs_free);
383 dev_dbg(dev, "%s - nonzero write bulk status received: %d\n",
388 spin_lock(&priv->lock);
390 /* only do something if we have more data to send */
391 if (priv->wrfilled) {
392 int length, blksize, result;
394 dev_dbg(dev, "%s - transmitting data (frame n)\n", __func__);
396 length = ((priv->wrfilled - priv->wrsent) > port->bulk_out_size) ?
397 port->bulk_out_size : (priv->wrfilled - priv->wrsent);
399 memcpy(port->write_urb->transfer_buffer,
400 priv->wrbuf + priv->wrsent, length);
401 priv->wrsent += length;
404 port->write_urb->transfer_buffer_length = length;
406 /* send the data out the bulk port */
407 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
409 dev_err(dev, "%s - failed submitting write urb, error %d\n",
411 /* Throw away data. No better idea what to do with it. */
417 dev_dbg(dev, "%s - priv->wrsent=%d\n", __func__, priv->wrsent);
418 dev_dbg(dev, "%s - priv->wrfilled=%d\n", __func__, priv->wrfilled);
420 blksize = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3;
422 if (priv->wrsent >= priv->wrfilled ||
423 priv->wrsent >= blksize) {
424 dev_dbg(dev, "%s - buffer cleaned\n", __func__);
425 memset(priv->wrbuf, 0, sizeof(priv->wrbuf));
432 spin_unlock(&priv->lock);
433 usb_serial_port_softint(port);
436 module_usb_serial_driver(serial_drivers, id_table);
438 MODULE_AUTHOR(DRIVER_AUTHOR);
439 MODULE_DESCRIPTION(DRIVER_DESC);
440 MODULE_LICENSE("GPL");