2 * REINER SCT cyberJack pinpad/e-com USB Chipcard Reader Driver
4 * Copyright (C) 2001 REINER SCT
5 * Author: Matthias Bruestle
7 * Contact: linux-usb@sii.li (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
26 #include <linux/config.h>
27 #include <linux/kernel.h>
28 #include <linux/errno.h>
29 #include <linux/init.h>
30 #include <linux/slab.h>
31 #include <linux/tty.h>
32 #include <linux/tty_driver.h>
33 #include <linux/tty_flip.h>
34 #include <linux/module.h>
35 #include <linux/spinlock.h>
36 #include <asm/uaccess.h>
37 #include <linux/usb.h>
38 #include "usb-serial.h"
40 #define CYBERJACK_LOCAL_BUF_SIZE 32
47 #define DRIVER_VERSION "v1.0"
48 #define DRIVER_AUTHOR "Matthias Bruestle"
49 #define DRIVER_DESC "REINER SCT cyberJack pinpad/e-com USB Chipcard Reader Driver"
52 #define CYBERJACK_VENDOR_ID 0x0C4B
53 #define CYBERJACK_PRODUCT_ID 0x0100
55 /* Function prototypes */
56 static int cyberjack_startup (struct usb_serial *serial);
57 static void cyberjack_shutdown (struct usb_serial *serial);
58 static int cyberjack_open (struct usb_serial_port *port, struct file *filp);
59 static void cyberjack_close (struct usb_serial_port *port, struct file *filp);
60 static int cyberjack_write (struct usb_serial_port *port, int from_user,
61 const unsigned char *buf, int count);
62 static int cyberjack_write_room( struct usb_serial_port *port );
63 static void cyberjack_read_int_callback (struct urb *urb, struct pt_regs *regs);
64 static void cyberjack_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
65 static void cyberjack_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
67 static 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_driver cyberjack_driver = {
77 .probe = usb_serial_probe,
78 .disconnect = usb_serial_disconnect,
82 static struct usb_serial_device_type cyberjack_device = {
84 .name = "Reiner SCT Cyberjack USB card reader",
85 .short_name = "cyberjack",
87 .num_interrupt_in = 1,
91 .attach = cyberjack_startup,
92 .shutdown = cyberjack_shutdown,
93 .open = cyberjack_open,
94 .close = cyberjack_close,
95 .write = cyberjack_write,
96 .write_room = cyberjack_write_room,
97 .read_int_callback = cyberjack_read_int_callback,
98 .read_bulk_callback = cyberjack_read_bulk_callback,
99 .write_bulk_callback = cyberjack_write_bulk_callback,
102 struct cyberjack_private {
103 spinlock_t lock; /* Lock for SMP */
104 short rdtodo; /* Bytes still to read */
105 unsigned char wrbuf[5*64]; /* Buffer for collecting data to write */
106 short wrfilled; /* Overall data size we already got */
107 short wrsent; /* Data already sent */
110 /* do some startup allocations not currently performed by usb_serial_probe() */
111 static int cyberjack_startup (struct usb_serial *serial)
113 struct cyberjack_private *priv;
115 dbg("%s", __FUNCTION__);
117 /* allocate the private data structure */
118 priv = kmalloc(sizeof(struct cyberjack_private), GFP_KERNEL);
122 /* set initial values */
123 spin_lock_init(&priv->lock);
127 usb_set_serial_port_data(serial->port[0], priv);
129 init_waitqueue_head(&serial->port[0]->write_wait);
134 static void cyberjack_shutdown (struct usb_serial *serial)
138 dbg("%s", __FUNCTION__);
140 for (i=0; i < serial->num_ports; ++i) {
141 /* My special items, the standard routines free my urbs */
142 kfree(usb_get_serial_port_data(serial->port[i]));
143 usb_set_serial_port_data(serial->port[i], NULL);
147 static int cyberjack_open (struct usb_serial_port *port, struct file *filp)
149 struct cyberjack_private *priv;
153 dbg("%s - port %d", __FUNCTION__, port->number);
155 dbg("%s - usb_clear_halt", __FUNCTION__ );
156 usb_clear_halt(port->serial->dev, port->write_urb->pipe);
158 /* force low_latency on so that our tty_push actually forces
159 * the data through, otherwise it is scheduled, and with high
160 * data rates (like with OHCI) data can get lost.
162 port->tty->low_latency = 1;
164 priv = usb_get_serial_port_data(port);
165 spin_lock_irqsave(&priv->lock, flags);
169 spin_unlock_irqrestore(&priv->lock, flags);
171 /* shutdown any bulk reads that might be going on */
172 usb_unlink_urb (port->write_urb);
173 usb_unlink_urb (port->read_urb);
174 usb_unlink_urb (port->interrupt_in_urb);
176 port->interrupt_in_urb->dev = port->serial->dev;
177 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
179 err(" usb_submit_urb(read int) failed");
180 dbg("%s - usb_submit_urb(int urb)", __FUNCTION__);
185 static void cyberjack_close (struct usb_serial_port *port, struct file *filp)
187 dbg("%s - port %d", __FUNCTION__, port->number);
189 if (port->serial->dev) {
190 /* shutdown any bulk reads that might be going on */
191 usb_unlink_urb (port->write_urb);
192 usb_unlink_urb (port->read_urb);
193 usb_unlink_urb (port->interrupt_in_urb);
194 dbg("%s - usb_clear_halt", __FUNCTION__ );
195 usb_clear_halt(port->serial->dev, port->write_urb->pipe);
196 usb_clear_halt(port->serial->dev, port->read_urb->pipe);
197 usb_clear_halt(port->serial->dev, port->interrupt_in_urb->pipe);
201 static int cyberjack_write (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count)
203 struct usb_serial *serial = port->serial;
204 struct cyberjack_private *priv = usb_get_serial_port_data(port);
209 dbg("%s - port %d", __FUNCTION__, port->number);
210 dbg("%s - from_user %d", __FUNCTION__, from_user);
213 dbg("%s - write request of 0 bytes", __FUNCTION__);
217 if (port->write_urb->status == -EINPROGRESS) {
218 dbg("%s - already writing", __FUNCTION__);
222 spin_lock_irqsave(&priv->lock, flags);
224 if( (count+priv->wrfilled)>sizeof(priv->wrbuf) ) {
225 /* To much data for buffer. Reset buffer. */
227 spin_unlock_irqrestore(&priv->lock, flags);
233 if (copy_from_user(priv->wrbuf+priv->wrfilled, buf, count)) {
234 spin_unlock_irqrestore(&priv->lock, flags);
238 memcpy (priv->wrbuf+priv->wrfilled, buf, count);
241 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count,
242 priv->wrbuf+priv->wrfilled);
243 priv->wrfilled += count;
245 if( priv->wrfilled >= 3 ) {
246 wrexpected = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3;
247 dbg("%s - expected data: %d", __FUNCTION__, wrexpected);
249 wrexpected = sizeof(priv->wrbuf);
252 if( priv->wrfilled >= wrexpected ) {
253 /* We have enough data to begin transmission */
256 dbg("%s - transmitting data (frame 1)", __FUNCTION__);
257 length = (wrexpected > port->bulk_out_size) ? port->bulk_out_size : wrexpected;
259 memcpy (port->write_urb->transfer_buffer, priv->wrbuf, length );
263 usb_fill_bulk_urb(port->write_urb, serial->dev,
264 usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress),
265 port->write_urb->transfer_buffer, length,
266 ((serial->type->write_bulk_callback) ?
267 serial->type->write_bulk_callback :
268 cyberjack_write_bulk_callback),
271 /* send the data out the bulk port */
272 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
274 err("%s - failed submitting write urb, error %d", __FUNCTION__, result);
275 /* Throw away data. No better idea what to do with it. */
278 spin_unlock_irqrestore(&priv->lock, flags);
282 dbg("%s - priv->wrsent=%d", __FUNCTION__,priv->wrsent);
283 dbg("%s - priv->wrfilled=%d", __FUNCTION__,priv->wrfilled);
285 if( priv->wrsent>=priv->wrfilled ) {
286 dbg("%s - buffer cleaned", __FUNCTION__);
287 memset( priv->wrbuf, 0, sizeof(priv->wrbuf) );
293 spin_unlock_irqrestore(&priv->lock, flags);
298 static int cyberjack_write_room( struct usb_serial_port *port )
300 return CYBERJACK_LOCAL_BUF_SIZE;
303 static void cyberjack_read_int_callback( struct urb *urb, struct pt_regs *regs )
305 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
306 struct cyberjack_private *priv = usb_get_serial_port_data(port);
307 unsigned char *data = urb->transfer_buffer;
310 dbg("%s - port %d", __FUNCTION__, port->number);
312 /* the urb might have been killed. */
316 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
318 /* React only to interrupts signaling a bulk_in transfer */
319 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", __FUNCTION__, priv->rdtodo);
341 spin_unlock(&priv->lock);
344 port->read_urb->dev = port->serial->dev;
345 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
347 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
348 dbg("%s - usb_submit_urb(read urb)", __FUNCTION__);
353 port->interrupt_in_urb->dev = port->serial->dev;
354 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
356 err(" usb_submit_urb(read int) failed");
357 dbg("%s - usb_submit_urb(int urb)", __FUNCTION__);
360 static void cyberjack_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
362 struct usb_serial_port *port = (struct usb_serial_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;
370 dbg("%s - port %d", __FUNCTION__, port->number);
372 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
374 dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status);
379 if (urb->actual_length) {
380 for (i = 0; i < urb->actual_length ; ++i) {
381 /* if we insert more than TTY_FLIPBUF_SIZE characters, we drop them. */
382 if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
383 tty_flip_buffer_push(tty);
385 /* this doesn't actually push the data through unless tty->low_latency is set */
386 tty_insert_flip_char(tty, data[i], 0);
388 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 ) priv->rdtodo = 0;
399 spin_unlock(&priv->lock);
401 dbg("%s - rdtodo: %d", __FUNCTION__, todo);
403 /* Continue to read if we have still urbs to do. */
404 if( todo /* || (urb->actual_length==port->bulk_in_endpointAddress)*/ ) {
405 port->read_urb->dev = port->serial->dev;
406 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
408 err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
409 dbg("%s - usb_submit_urb(read urb)", __FUNCTION__);
413 static void cyberjack_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
415 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
416 struct cyberjack_private *priv = usb_get_serial_port_data(port);
418 dbg("%s - port %d", __FUNCTION__, port->number);
421 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
425 spin_lock(&priv->lock);
427 /* only do something if we have more data to send */
428 if( priv->wrfilled ) {
429 int length, blksize, result;
431 if (port->write_urb->status == -EINPROGRESS) {
432 dbg("%s - already writing", __FUNCTION__);
433 spin_unlock(&priv->lock);
437 dbg("%s - transmitting data (frame n)", __FUNCTION__);
439 length = ((priv->wrfilled - priv->wrsent) > port->bulk_out_size) ?
440 port->bulk_out_size : (priv->wrfilled - priv->wrsent);
442 memcpy (port->write_urb->transfer_buffer, priv->wrbuf + priv->wrsent,
444 priv->wrsent+=length;
447 usb_fill_bulk_urb(port->write_urb, port->serial->dev,
448 usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
449 port->write_urb->transfer_buffer, length,
450 ((port->serial->type->write_bulk_callback) ?
451 port->serial->type->write_bulk_callback :
452 cyberjack_write_bulk_callback),
455 /* send the data out the bulk port */
456 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
458 err("%s - failed submitting write urb, error %d", __FUNCTION__, result);
459 /* Throw away data. No better idea what to do with it. */
465 dbg("%s - priv->wrsent=%d", __FUNCTION__,priv->wrsent);
466 dbg("%s - priv->wrfilled=%d", __FUNCTION__,priv->wrfilled);
468 blksize = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3;
470 if( (priv->wrsent>=priv->wrfilled) || (priv->wrsent>=blksize) ) {
471 dbg("%s - buffer cleaned", __FUNCTION__);
472 memset( priv->wrbuf, 0, sizeof(priv->wrbuf) );
479 spin_unlock(&priv->lock);
480 schedule_work(&port->work);
483 static int __init cyberjack_init (void)
486 retval = usb_serial_register(&cyberjack_device);
488 goto failed_usb_serial_register;
489 retval = usb_register(&cyberjack_driver);
491 goto failed_usb_register;
493 info(DRIVER_VERSION " " DRIVER_AUTHOR);
498 usb_serial_deregister(&cyberjack_device);
499 failed_usb_serial_register:
503 static void __exit cyberjack_exit (void)
505 usb_deregister (&cyberjack_driver);
506 usb_serial_deregister (&cyberjack_device);
509 module_init(cyberjack_init);
510 module_exit(cyberjack_exit);
512 MODULE_AUTHOR( DRIVER_AUTHOR );
513 MODULE_DESCRIPTION( DRIVER_DESC );
514 MODULE_LICENSE("GPL");
516 module_param(debug, bool, S_IRUGO | S_IWUSR);
517 MODULE_PARM_DESC(debug, "Debug enabled or not");