]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * REINER SCT cyberJack pinpad/e-com USB Chipcard Reader Driver | |
3 | * | |
4 | * Copyright (C) 2001 REINER SCT | |
5 | * Author: Matthias Bruestle | |
6 | * | |
7 | * Contact: support@reiner-sct.com (see MAINTAINERS) | |
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 | * In case of problems, please write to the contact e-mail address | |
22 | * mentioned above. | |
23 | * | |
24 | * Please note that later models of the cyberjack reader family are | |
25 | * supported by a libusb-based userspace device driver. | |
26 | * | |
27 | * Homepage: http://www.reiner-sct.de/support/treiber_cyberjack.php#linux | |
28 | */ | |
29 | ||
30 | ||
31 | #include <linux/config.h> | |
32 | #include <linux/kernel.h> | |
33 | #include <linux/errno.h> | |
34 | #include <linux/init.h> | |
35 | #include <linux/slab.h> | |
36 | #include <linux/tty.h> | |
37 | #include <linux/tty_driver.h> | |
38 | #include <linux/tty_flip.h> | |
39 | #include <linux/module.h> | |
40 | #include <linux/spinlock.h> | |
41 | #include <asm/uaccess.h> | |
42 | #include <linux/usb.h> | |
43 | #include "usb-serial.h" | |
44 | ||
45 | #define CYBERJACK_LOCAL_BUF_SIZE 32 | |
46 | ||
47 | static int debug; | |
48 | ||
49 | /* | |
50 | * Version Information | |
51 | */ | |
52 | #define DRIVER_VERSION "v1.01" | |
53 | #define DRIVER_AUTHOR "Matthias Bruestle" | |
54 | #define DRIVER_DESC "REINER SCT cyberJack pinpad/e-com USB Chipcard Reader Driver" | |
55 | ||
56 | ||
57 | #define CYBERJACK_VENDOR_ID 0x0C4B | |
58 | #define CYBERJACK_PRODUCT_ID 0x0100 | |
59 | ||
60 | /* Function prototypes */ | |
61 | static int cyberjack_startup (struct usb_serial *serial); | |
62 | static void cyberjack_shutdown (struct usb_serial *serial); | |
63 | static int cyberjack_open (struct usb_serial_port *port, struct file *filp); | |
64 | static void cyberjack_close (struct usb_serial_port *port, struct file *filp); | |
65 | static int cyberjack_write (struct usb_serial_port *port, const unsigned char *buf, int count); | |
66 | static int cyberjack_write_room( struct usb_serial_port *port ); | |
67 | static void cyberjack_read_int_callback (struct urb *urb, struct pt_regs *regs); | |
68 | static void cyberjack_read_bulk_callback (struct urb *urb, struct pt_regs *regs); | |
69 | static void cyberjack_write_bulk_callback (struct urb *urb, struct pt_regs *regs); | |
70 | ||
71 | static struct usb_device_id id_table [] = { | |
72 | { USB_DEVICE(CYBERJACK_VENDOR_ID, CYBERJACK_PRODUCT_ID) }, | |
73 | { } /* Terminating entry */ | |
74 | }; | |
75 | ||
76 | MODULE_DEVICE_TABLE (usb, id_table); | |
77 | ||
78 | static struct usb_driver cyberjack_driver = { | |
79 | .owner = THIS_MODULE, | |
80 | .name = "cyberjack", | |
81 | .probe = usb_serial_probe, | |
82 | .disconnect = usb_serial_disconnect, | |
83 | .id_table = id_table, | |
84 | }; | |
85 | ||
ea65370d | 86 | static struct usb_serial_driver cyberjack_device = { |
18fcac35 GKH |
87 | .driver = { |
88 | .owner = THIS_MODULE, | |
269bda1c | 89 | .name = "cyberjack", |
18fcac35 | 90 | }, |
269bda1c | 91 | .description = "Reiner SCT Cyberjack USB card reader", |
1da177e4 LT |
92 | .id_table = id_table, |
93 | .num_interrupt_in = 1, | |
94 | .num_bulk_in = 1, | |
95 | .num_bulk_out = 1, | |
96 | .num_ports = 1, | |
97 | .attach = cyberjack_startup, | |
98 | .shutdown = cyberjack_shutdown, | |
99 | .open = cyberjack_open, | |
100 | .close = cyberjack_close, | |
101 | .write = cyberjack_write, | |
102 | .write_room = cyberjack_write_room, | |
103 | .read_int_callback = cyberjack_read_int_callback, | |
104 | .read_bulk_callback = cyberjack_read_bulk_callback, | |
105 | .write_bulk_callback = cyberjack_write_bulk_callback, | |
106 | }; | |
107 | ||
108 | struct cyberjack_private { | |
109 | spinlock_t lock; /* Lock for SMP */ | |
110 | short rdtodo; /* Bytes still to read */ | |
111 | unsigned char wrbuf[5*64]; /* Buffer for collecting data to write */ | |
112 | short wrfilled; /* Overall data size we already got */ | |
113 | short wrsent; /* Data already sent */ | |
114 | }; | |
115 | ||
116 | /* do some startup allocations not currently performed by usb_serial_probe() */ | |
117 | static int cyberjack_startup (struct usb_serial *serial) | |
118 | { | |
119 | struct cyberjack_private *priv; | |
120 | int i; | |
121 | ||
122 | dbg("%s", __FUNCTION__); | |
123 | ||
124 | /* allocate the private data structure */ | |
125 | priv = kmalloc(sizeof(struct cyberjack_private), GFP_KERNEL); | |
126 | if (!priv) | |
127 | return -ENOMEM; | |
128 | ||
129 | /* set initial values */ | |
130 | spin_lock_init(&priv->lock); | |
131 | priv->rdtodo = 0; | |
132 | priv->wrfilled = 0; | |
133 | priv->wrsent = 0; | |
134 | usb_set_serial_port_data(serial->port[0], priv); | |
135 | ||
136 | init_waitqueue_head(&serial->port[0]->write_wait); | |
137 | ||
138 | for (i = 0; i < serial->num_ports; ++i) { | |
139 | int result; | |
140 | serial->port[i]->interrupt_in_urb->dev = serial->dev; | |
141 | result = usb_submit_urb(serial->port[i]->interrupt_in_urb, | |
142 | GFP_KERNEL); | |
143 | if (result) | |
144 | err(" usb_submit_urb(read int) failed"); | |
145 | dbg("%s - usb_submit_urb(int urb)", __FUNCTION__); | |
146 | } | |
147 | ||
148 | return( 0 ); | |
149 | } | |
150 | ||
151 | static void cyberjack_shutdown (struct usb_serial *serial) | |
152 | { | |
153 | int i; | |
154 | ||
155 | dbg("%s", __FUNCTION__); | |
156 | ||
157 | for (i=0; i < serial->num_ports; ++i) { | |
158 | usb_kill_urb(serial->port[i]->interrupt_in_urb); | |
159 | /* My special items, the standard routines free my urbs */ | |
160 | kfree(usb_get_serial_port_data(serial->port[i])); | |
161 | usb_set_serial_port_data(serial->port[i], NULL); | |
162 | } | |
163 | } | |
164 | ||
165 | static int cyberjack_open (struct usb_serial_port *port, struct file *filp) | |
166 | { | |
167 | struct cyberjack_private *priv; | |
168 | unsigned long flags; | |
169 | int result = 0; | |
170 | ||
171 | dbg("%s - port %d", __FUNCTION__, port->number); | |
172 | ||
173 | dbg("%s - usb_clear_halt", __FUNCTION__ ); | |
174 | usb_clear_halt(port->serial->dev, port->write_urb->pipe); | |
175 | ||
176 | /* force low_latency on so that our tty_push actually forces | |
177 | * the data through, otherwise it is scheduled, and with high | |
178 | * data rates (like with OHCI) data can get lost. | |
179 | */ | |
180 | port->tty->low_latency = 1; | |
181 | ||
182 | priv = usb_get_serial_port_data(port); | |
183 | spin_lock_irqsave(&priv->lock, flags); | |
184 | priv->rdtodo = 0; | |
185 | priv->wrfilled = 0; | |
186 | priv->wrsent = 0; | |
187 | spin_unlock_irqrestore(&priv->lock, flags); | |
188 | ||
189 | return result; | |
190 | } | |
191 | ||
192 | static void cyberjack_close (struct usb_serial_port *port, struct file *filp) | |
193 | { | |
194 | dbg("%s - port %d", __FUNCTION__, port->number); | |
195 | ||
196 | if (port->serial->dev) { | |
197 | /* shutdown any bulk reads that might be going on */ | |
198 | usb_kill_urb(port->write_urb); | |
199 | usb_kill_urb(port->read_urb); | |
200 | } | |
201 | } | |
202 | ||
203 | static int cyberjack_write (struct usb_serial_port *port, const unsigned char *buf, int count) | |
204 | { | |
205 | struct usb_serial *serial = port->serial; | |
206 | struct cyberjack_private *priv = usb_get_serial_port_data(port); | |
207 | unsigned long flags; | |
208 | int result; | |
209 | int wrexpected; | |
210 | ||
211 | dbg("%s - port %d", __FUNCTION__, port->number); | |
212 | ||
213 | if (count == 0) { | |
214 | dbg("%s - write request of 0 bytes", __FUNCTION__); | |
215 | return (0); | |
216 | } | |
217 | ||
507ca9bc GKH |
218 | spin_lock(&port->lock); |
219 | if (port->write_urb_busy) { | |
220 | spin_unlock(&port->lock); | |
1da177e4 | 221 | dbg("%s - already writing", __FUNCTION__); |
507ca9bc | 222 | return 0; |
1da177e4 | 223 | } |
507ca9bc GKH |
224 | port->write_urb_busy = 1; |
225 | spin_unlock(&port->lock); | |
1da177e4 LT |
226 | |
227 | spin_lock_irqsave(&priv->lock, flags); | |
228 | ||
229 | if( (count+priv->wrfilled)>sizeof(priv->wrbuf) ) { | |
230 | /* To much data for buffer. Reset buffer. */ | |
231 | priv->wrfilled=0; | |
232 | spin_unlock_irqrestore(&priv->lock, flags); | |
507ca9bc | 233 | port->write_urb_busy = 0; |
1da177e4 LT |
234 | return (0); |
235 | } | |
236 | ||
237 | /* Copy data */ | |
238 | memcpy (priv->wrbuf+priv->wrfilled, buf, count); | |
239 | ||
240 | usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, | |
241 | priv->wrbuf+priv->wrfilled); | |
242 | priv->wrfilled += count; | |
243 | ||
244 | if( priv->wrfilled >= 3 ) { | |
245 | wrexpected = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3; | |
246 | dbg("%s - expected data: %d", __FUNCTION__, wrexpected); | |
247 | } else { | |
248 | wrexpected = sizeof(priv->wrbuf); | |
249 | } | |
250 | ||
251 | if( priv->wrfilled >= wrexpected ) { | |
252 | /* We have enough data to begin transmission */ | |
253 | int length; | |
254 | ||
255 | dbg("%s - transmitting data (frame 1)", __FUNCTION__); | |
256 | length = (wrexpected > port->bulk_out_size) ? port->bulk_out_size : wrexpected; | |
257 | ||
258 | memcpy (port->write_urb->transfer_buffer, priv->wrbuf, length ); | |
259 | priv->wrsent=length; | |
260 | ||
261 | /* set up our urb */ | |
262 | usb_fill_bulk_urb(port->write_urb, serial->dev, | |
263 | usb_sndbulkpipe(serial->dev, port->bulk_out_endpointAddress), | |
264 | port->write_urb->transfer_buffer, length, | |
265 | ((serial->type->write_bulk_callback) ? | |
266 | serial->type->write_bulk_callback : | |
267 | cyberjack_write_bulk_callback), | |
268 | port); | |
269 | ||
270 | /* send the data out the bulk port */ | |
271 | result = usb_submit_urb(port->write_urb, GFP_ATOMIC); | |
272 | if (result) { | |
273 | err("%s - failed submitting write urb, error %d", __FUNCTION__, result); | |
274 | /* Throw away data. No better idea what to do with it. */ | |
275 | priv->wrfilled=0; | |
276 | priv->wrsent=0; | |
277 | spin_unlock_irqrestore(&priv->lock, flags); | |
507ca9bc | 278 | port->write_urb_busy = 0; |
1da177e4 LT |
279 | return 0; |
280 | } | |
281 | ||
282 | dbg("%s - priv->wrsent=%d", __FUNCTION__,priv->wrsent); | |
283 | dbg("%s - priv->wrfilled=%d", __FUNCTION__,priv->wrfilled); | |
284 | ||
285 | if( priv->wrsent>=priv->wrfilled ) { | |
286 | dbg("%s - buffer cleaned", __FUNCTION__); | |
287 | memset( priv->wrbuf, 0, sizeof(priv->wrbuf) ); | |
288 | priv->wrfilled=0; | |
289 | priv->wrsent=0; | |
290 | } | |
291 | } | |
292 | ||
293 | spin_unlock_irqrestore(&priv->lock, flags); | |
294 | ||
295 | return (count); | |
296 | } | |
297 | ||
298 | static int cyberjack_write_room( struct usb_serial_port *port ) | |
299 | { | |
300 | return CYBERJACK_LOCAL_BUF_SIZE; | |
301 | } | |
302 | ||
303 | static void cyberjack_read_int_callback( struct urb *urb, struct pt_regs *regs ) | |
304 | { | |
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; | |
308 | int result; | |
309 | ||
310 | dbg("%s - port %d", __FUNCTION__, port->number); | |
311 | ||
312 | /* the urb might have been killed. */ | |
313 | if (urb->status) | |
314 | return; | |
315 | ||
316 | usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data); | |
317 | ||
318 | /* React only to interrupts signaling a bulk_in transfer */ | |
319 | if( (urb->actual_length==4) && (data[0]==0x01) ) { | |
320 | short old_rdtodo; | |
321 | int result; | |
322 | ||
323 | /* This is a announcement of coming bulk_ins. */ | |
324 | unsigned short size = ((unsigned short)data[3]<<8)+data[2]+3; | |
325 | ||
326 | spin_lock(&priv->lock); | |
327 | ||
328 | old_rdtodo = priv->rdtodo; | |
329 | ||
330 | if( (old_rdtodo+size)<(old_rdtodo) ) { | |
331 | dbg( "To many bulk_in urbs to do." ); | |
332 | spin_unlock(&priv->lock); | |
333 | goto resubmit; | |
334 | } | |
335 | ||
336 | /* "+=" is probably more fault tollerant than "=" */ | |
337 | priv->rdtodo += size; | |
338 | ||
339 | dbg("%s - rdtodo: %d", __FUNCTION__, priv->rdtodo); | |
340 | ||
341 | spin_unlock(&priv->lock); | |
342 | ||
343 | if( !old_rdtodo ) { | |
344 | port->read_urb->dev = port->serial->dev; | |
345 | result = usb_submit_urb(port->read_urb, GFP_ATOMIC); | |
346 | if( result ) | |
347 | err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result); | |
348 | dbg("%s - usb_submit_urb(read urb)", __FUNCTION__); | |
349 | } | |
350 | } | |
351 | ||
352 | resubmit: | |
353 | port->interrupt_in_urb->dev = port->serial->dev; | |
354 | result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC); | |
355 | if (result) | |
356 | err(" usb_submit_urb(read int) failed"); | |
357 | dbg("%s - usb_submit_urb(int urb)", __FUNCTION__); | |
358 | } | |
359 | ||
360 | static void cyberjack_read_bulk_callback (struct urb *urb, struct pt_regs *regs) | |
361 | { | |
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; | |
366 | short todo; | |
367 | int i; | |
368 | int result; | |
369 | ||
370 | dbg("%s - port %d", __FUNCTION__, port->number); | |
371 | ||
372 | usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data); | |
373 | if (urb->status) { | |
374 | dbg("%s - nonzero read bulk status received: %d", __FUNCTION__, urb->status); | |
375 | return; | |
376 | } | |
377 | ||
378 | tty = port->tty; | |
379 | if (!tty) { | |
380 | dbg("%s - ignoring since device not open\n", __FUNCTION__); | |
381 | return; | |
382 | } | |
383 | if (urb->actual_length) { | |
384 | for (i = 0; i < urb->actual_length ; ++i) { | |
385 | /* if we insert more than TTY_FLIPBUF_SIZE characters, we drop them. */ | |
386 | if(tty->flip.count >= TTY_FLIPBUF_SIZE) { | |
387 | tty_flip_buffer_push(tty); | |
388 | } | |
389 | /* this doesn't actually push the data through unless tty->low_latency is set */ | |
390 | tty_insert_flip_char(tty, data[i], 0); | |
391 | } | |
392 | tty_flip_buffer_push(tty); | |
393 | } | |
394 | ||
395 | spin_lock(&priv->lock); | |
396 | ||
397 | /* Reduce urbs to do by one. */ | |
398 | priv->rdtodo-=urb->actual_length; | |
399 | /* Just to be sure */ | |
400 | if ( priv->rdtodo<0 ) priv->rdtodo = 0; | |
401 | todo = priv->rdtodo; | |
402 | ||
403 | spin_unlock(&priv->lock); | |
404 | ||
405 | dbg("%s - rdtodo: %d", __FUNCTION__, todo); | |
406 | ||
407 | /* Continue to read if we have still urbs to do. */ | |
408 | if( todo /* || (urb->actual_length==port->bulk_in_endpointAddress)*/ ) { | |
409 | port->read_urb->dev = port->serial->dev; | |
410 | result = usb_submit_urb(port->read_urb, GFP_ATOMIC); | |
411 | if (result) | |
412 | err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result); | |
413 | dbg("%s - usb_submit_urb(read urb)", __FUNCTION__); | |
414 | } | |
415 | } | |
416 | ||
417 | static void cyberjack_write_bulk_callback (struct urb *urb, struct pt_regs *regs) | |
418 | { | |
419 | struct usb_serial_port *port = (struct usb_serial_port *)urb->context; | |
420 | struct cyberjack_private *priv = usb_get_serial_port_data(port); | |
421 | ||
422 | dbg("%s - port %d", __FUNCTION__, port->number); | |
507ca9bc GKH |
423 | |
424 | port->write_urb_busy = 0; | |
1da177e4 LT |
425 | if (urb->status) { |
426 | dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status); | |
427 | return; | |
428 | } | |
429 | ||
430 | spin_lock(&priv->lock); | |
431 | ||
432 | /* only do something if we have more data to send */ | |
433 | if( priv->wrfilled ) { | |
434 | int length, blksize, result; | |
435 | ||
1da177e4 LT |
436 | dbg("%s - transmitting data (frame n)", __FUNCTION__); |
437 | ||
438 | length = ((priv->wrfilled - priv->wrsent) > port->bulk_out_size) ? | |
439 | port->bulk_out_size : (priv->wrfilled - priv->wrsent); | |
440 | ||
441 | memcpy (port->write_urb->transfer_buffer, priv->wrbuf + priv->wrsent, | |
442 | length ); | |
443 | priv->wrsent+=length; | |
444 | ||
445 | /* set up our urb */ | |
446 | usb_fill_bulk_urb(port->write_urb, port->serial->dev, | |
447 | usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress), | |
448 | port->write_urb->transfer_buffer, length, | |
449 | ((port->serial->type->write_bulk_callback) ? | |
450 | port->serial->type->write_bulk_callback : | |
451 | cyberjack_write_bulk_callback), | |
452 | port); | |
453 | ||
454 | /* send the data out the bulk port */ | |
455 | result = usb_submit_urb(port->write_urb, GFP_ATOMIC); | |
456 | if (result) { | |
457 | err("%s - failed submitting write urb, error %d", __FUNCTION__, result); | |
458 | /* Throw away data. No better idea what to do with it. */ | |
459 | priv->wrfilled=0; | |
460 | priv->wrsent=0; | |
461 | goto exit; | |
462 | } | |
463 | ||
464 | dbg("%s - priv->wrsent=%d", __FUNCTION__,priv->wrsent); | |
465 | dbg("%s - priv->wrfilled=%d", __FUNCTION__,priv->wrfilled); | |
466 | ||
467 | blksize = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3; | |
468 | ||
469 | if( (priv->wrsent>=priv->wrfilled) || (priv->wrsent>=blksize) ) { | |
470 | dbg("%s - buffer cleaned", __FUNCTION__); | |
471 | memset( priv->wrbuf, 0, sizeof(priv->wrbuf) ); | |
472 | priv->wrfilled=0; | |
473 | priv->wrsent=0; | |
474 | } | |
475 | } | |
476 | ||
477 | exit: | |
478 | spin_unlock(&priv->lock); | |
479 | schedule_work(&port->work); | |
480 | } | |
481 | ||
482 | static int __init cyberjack_init (void) | |
483 | { | |
484 | int retval; | |
485 | retval = usb_serial_register(&cyberjack_device); | |
486 | if (retval) | |
487 | goto failed_usb_serial_register; | |
488 | retval = usb_register(&cyberjack_driver); | |
489 | if (retval) | |
490 | goto failed_usb_register; | |
491 | ||
492 | info(DRIVER_VERSION " " DRIVER_AUTHOR); | |
493 | info(DRIVER_DESC); | |
494 | ||
495 | return 0; | |
496 | failed_usb_register: | |
497 | usb_serial_deregister(&cyberjack_device); | |
498 | failed_usb_serial_register: | |
499 | return retval; | |
500 | } | |
501 | ||
502 | static void __exit cyberjack_exit (void) | |
503 | { | |
504 | usb_deregister (&cyberjack_driver); | |
505 | usb_serial_deregister (&cyberjack_device); | |
506 | } | |
507 | ||
508 | module_init(cyberjack_init); | |
509 | module_exit(cyberjack_exit); | |
510 | ||
511 | MODULE_AUTHOR( DRIVER_AUTHOR ); | |
512 | MODULE_DESCRIPTION( DRIVER_DESC ); | |
513 | MODULE_VERSION( DRIVER_VERSION ); | |
514 | MODULE_LICENSE("GPL"); | |
515 | ||
516 | module_param(debug, bool, S_IRUGO | S_IWUSR); | |
517 | MODULE_PARM_DESC(debug, "Debug enabled or not"); |