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 | ||
1da177e4 LT |
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> | |
b9c52f15 | 40 | #include <linux/uaccess.h> |
1da177e4 | 41 | #include <linux/usb.h> |
a969888c | 42 | #include <linux/usb/serial.h> |
1da177e4 LT |
43 | |
44 | #define CYBERJACK_LOCAL_BUF_SIZE 32 | |
45 | ||
1da177e4 LT |
46 | #define DRIVER_AUTHOR "Matthias Bruestle" |
47 | #define DRIVER_DESC "REINER SCT cyberJack pinpad/e-com USB Chipcard Reader Driver" | |
48 | ||
49 | ||
50 | #define CYBERJACK_VENDOR_ID 0x0C4B | |
51 | #define CYBERJACK_PRODUCT_ID 0x0100 | |
52 | ||
53 | /* Function prototypes */ | |
f9c99bb8 | 54 | static void cyberjack_disconnect(struct usb_serial *serial); |
a9556040 JH |
55 | static int cyberjack_port_probe(struct usb_serial_port *port); |
56 | static int cyberjack_port_remove(struct usb_serial_port *port); | |
95da310e | 57 | static int cyberjack_open(struct tty_struct *tty, |
a509a7e4 | 58 | struct usb_serial_port *port); |
335f8514 | 59 | static void cyberjack_close(struct usb_serial_port *port); |
95da310e AC |
60 | static int cyberjack_write(struct tty_struct *tty, |
61 | struct usb_serial_port *port, const unsigned char *buf, int count); | |
b9c52f15 | 62 | static int cyberjack_write_room(struct tty_struct *tty); |
95da310e AC |
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); | |
1da177e4 | 66 | |
7d40d7e8 | 67 | static const struct usb_device_id id_table[] = { |
1da177e4 LT |
68 | { USB_DEVICE(CYBERJACK_VENDOR_ID, CYBERJACK_PRODUCT_ID) }, |
69 | { } /* Terminating entry */ | |
70 | }; | |
71 | ||
b9c52f15 | 72 | MODULE_DEVICE_TABLE(usb, id_table); |
1da177e4 | 73 | |
ea65370d | 74 | static struct usb_serial_driver cyberjack_device = { |
18fcac35 GKH |
75 | .driver = { |
76 | .owner = THIS_MODULE, | |
269bda1c | 77 | .name = "cyberjack", |
18fcac35 | 78 | }, |
269bda1c | 79 | .description = "Reiner SCT Cyberjack USB card reader", |
1da177e4 | 80 | .id_table = id_table, |
1da177e4 | 81 | .num_ports = 1, |
f9c99bb8 | 82 | .disconnect = cyberjack_disconnect, |
a9556040 JH |
83 | .port_probe = cyberjack_port_probe, |
84 | .port_remove = cyberjack_port_remove, | |
1da177e4 LT |
85 | .open = cyberjack_open, |
86 | .close = cyberjack_close, | |
87 | .write = cyberjack_write, | |
d9b1b787 | 88 | .write_room = cyberjack_write_room, |
1da177e4 LT |
89 | .read_int_callback = cyberjack_read_int_callback, |
90 | .read_bulk_callback = cyberjack_read_bulk_callback, | |
91 | .write_bulk_callback = cyberjack_write_bulk_callback, | |
92 | }; | |
93 | ||
08a4f6bc AS |
94 | static struct usb_serial_driver * const serial_drivers[] = { |
95 | &cyberjack_device, NULL | |
96 | }; | |
97 | ||
1da177e4 LT |
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 */ | |
104 | }; | |
105 | ||
a9556040 | 106 | static int cyberjack_port_probe(struct usb_serial_port *port) |
1da177e4 LT |
107 | { |
108 | struct cyberjack_private *priv; | |
a9556040 | 109 | int result; |
1da177e4 | 110 | |
1da177e4 LT |
111 | priv = kmalloc(sizeof(struct cyberjack_private), GFP_KERNEL); |
112 | if (!priv) | |
113 | return -ENOMEM; | |
114 | ||
1da177e4 LT |
115 | spin_lock_init(&priv->lock); |
116 | priv->rdtodo = 0; | |
117 | priv->wrfilled = 0; | |
118 | priv->wrsent = 0; | |
a9556040 JH |
119 | |
120 | usb_set_serial_port_data(port, priv); | |
121 | ||
122 | result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL); | |
123 | if (result) | |
124 | dev_err(&port->dev, "usb_submit_urb(read int) failed\n"); | |
1da177e4 | 125 | |
b9c52f15 | 126 | return 0; |
1da177e4 LT |
127 | } |
128 | ||
a9556040 | 129 | static int cyberjack_port_remove(struct usb_serial_port *port) |
1da177e4 | 130 | { |
a9556040 | 131 | struct cyberjack_private *priv; |
b9c52f15 | 132 | |
a9556040 JH |
133 | priv = usb_get_serial_port_data(port); |
134 | kfree(priv); | |
135 | ||
136 | return 0; | |
f9c99bb8 AS |
137 | } |
138 | ||
a9556040 | 139 | static void cyberjack_disconnect(struct usb_serial *serial) |
f9c99bb8 AS |
140 | { |
141 | int i; | |
142 | ||
a9556040 JH |
143 | for (i = 0; i < serial->num_ports; ++i) |
144 | usb_kill_urb(serial->port[i]->interrupt_in_urb); | |
1da177e4 | 145 | } |
b9c52f15 | 146 | |
95da310e | 147 | static int cyberjack_open(struct tty_struct *tty, |
a509a7e4 | 148 | struct usb_serial_port *port) |
1da177e4 LT |
149 | { |
150 | struct cyberjack_private *priv; | |
151 | unsigned long flags; | |
152 | int result = 0; | |
153 | ||
96fc8e8d | 154 | dev_dbg(&port->dev, "%s - usb_clear_halt\n", __func__); |
1da177e4 LT |
155 | usb_clear_halt(port->serial->dev, port->write_urb->pipe); |
156 | ||
1da177e4 LT |
157 | priv = usb_get_serial_port_data(port); |
158 | spin_lock_irqsave(&priv->lock, flags); | |
159 | priv->rdtodo = 0; | |
160 | priv->wrfilled = 0; | |
161 | priv->wrsent = 0; | |
162 | spin_unlock_irqrestore(&priv->lock, flags); | |
163 | ||
164 | return result; | |
165 | } | |
166 | ||
335f8514 | 167 | static void cyberjack_close(struct usb_serial_port *port) |
1da177e4 | 168 | { |
1da177e4 LT |
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); | |
173 | } | |
174 | } | |
175 | ||
95da310e AC |
176 | static int cyberjack_write(struct tty_struct *tty, |
177 | struct usb_serial_port *port, const unsigned char *buf, int count) | |
1da177e4 | 178 | { |
96fc8e8d | 179 | struct device *dev = &port->dev; |
1da177e4 LT |
180 | struct cyberjack_private *priv = usb_get_serial_port_data(port); |
181 | unsigned long flags; | |
182 | int result; | |
183 | int wrexpected; | |
184 | ||
1da177e4 | 185 | if (count == 0) { |
96fc8e8d | 186 | dev_dbg(dev, "%s - write request of 0 bytes\n", __func__); |
a5b6f60c | 187 | return 0; |
1da177e4 LT |
188 | } |
189 | ||
c1cac10c | 190 | if (!test_and_clear_bit(0, &port->write_urbs_free)) { |
96fc8e8d | 191 | dev_dbg(dev, "%s - already writing\n", __func__); |
507ca9bc | 192 | return 0; |
1da177e4 LT |
193 | } |
194 | ||
195 | spin_lock_irqsave(&priv->lock, flags); | |
196 | ||
b9c52f15 | 197 | if (count+priv->wrfilled > sizeof(priv->wrbuf)) { |
1da177e4 | 198 | /* To much data for buffer. Reset buffer. */ |
a5b6f60c | 199 | priv->wrfilled = 0; |
a5b6f60c | 200 | spin_unlock_irqrestore(&priv->lock, flags); |
c1cac10c | 201 | set_bit(0, &port->write_urbs_free); |
a5b6f60c | 202 | return 0; |
1da177e4 LT |
203 | } |
204 | ||
205 | /* Copy data */ | |
b9c52f15 | 206 | memcpy(priv->wrbuf + priv->wrfilled, buf, count); |
1da177e4 | 207 | |
59d33f2f | 208 | usb_serial_debug_data(dev, __func__, count, priv->wrbuf + priv->wrfilled); |
1da177e4 LT |
209 | priv->wrfilled += count; |
210 | ||
b9c52f15 | 211 | if (priv->wrfilled >= 3) { |
1da177e4 | 212 | wrexpected = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3; |
96fc8e8d | 213 | dev_dbg(dev, "%s - expected data: %d\n", __func__, wrexpected); |
b9c52f15 | 214 | } else |
1da177e4 | 215 | wrexpected = sizeof(priv->wrbuf); |
1da177e4 | 216 | |
b9c52f15 | 217 | if (priv->wrfilled >= wrexpected) { |
1da177e4 LT |
218 | /* We have enough data to begin transmission */ |
219 | int length; | |
220 | ||
96fc8e8d | 221 | dev_dbg(dev, "%s - transmitting data (frame 1)\n", __func__); |
b9c52f15 AC |
222 | length = (wrexpected > port->bulk_out_size) ? |
223 | port->bulk_out_size : wrexpected; | |
1da177e4 | 224 | |
b9c52f15 AC |
225 | memcpy(port->write_urb->transfer_buffer, priv->wrbuf, length); |
226 | priv->wrsent = length; | |
1da177e4 LT |
227 | |
228 | /* set up our urb */ | |
fd11961a | 229 | port->write_urb->transfer_buffer_length = length; |
1da177e4 LT |
230 | |
231 | /* send the data out the bulk port */ | |
232 | result = usb_submit_urb(port->write_urb, GFP_ATOMIC); | |
233 | if (result) { | |
194343d9 GKH |
234 | dev_err(&port->dev, |
235 | "%s - failed submitting write urb, error %d", | |
236 | __func__, result); | |
1da177e4 | 237 | /* Throw away data. No better idea what to do with it. */ |
a5b6f60c AC |
238 | priv->wrfilled = 0; |
239 | priv->wrsent = 0; | |
1da177e4 | 240 | spin_unlock_irqrestore(&priv->lock, flags); |
c1cac10c | 241 | set_bit(0, &port->write_urbs_free); |
1da177e4 LT |
242 | return 0; |
243 | } | |
244 | ||
96fc8e8d GKH |
245 | dev_dbg(dev, "%s - priv->wrsent=%d\n", __func__, priv->wrsent); |
246 | dev_dbg(dev, "%s - priv->wrfilled=%d\n", __func__, priv->wrfilled); | |
1da177e4 | 247 | |
b9c52f15 | 248 | if (priv->wrsent >= priv->wrfilled) { |
96fc8e8d | 249 | dev_dbg(dev, "%s - buffer cleaned\n", __func__); |
b9c52f15 | 250 | memset(priv->wrbuf, 0, sizeof(priv->wrbuf)); |
a5b6f60c AC |
251 | priv->wrfilled = 0; |
252 | priv->wrsent = 0; | |
1da177e4 LT |
253 | } |
254 | } | |
255 | ||
256 | spin_unlock_irqrestore(&priv->lock, flags); | |
257 | ||
b9c52f15 AC |
258 | return count; |
259 | } | |
1da177e4 | 260 | |
95da310e | 261 | static int cyberjack_write_room(struct tty_struct *tty) |
1da177e4 | 262 | { |
a5b6f60c | 263 | /* FIXME: .... */ |
1da177e4 LT |
264 | return CYBERJACK_LOCAL_BUF_SIZE; |
265 | } | |
266 | ||
95da310e | 267 | static void cyberjack_read_int_callback(struct urb *urb) |
1da177e4 | 268 | { |
cdc97792 | 269 | struct usb_serial_port *port = urb->context; |
1da177e4 | 270 | struct cyberjack_private *priv = usb_get_serial_port_data(port); |
96fc8e8d | 271 | struct device *dev = &port->dev; |
1da177e4 | 272 | unsigned char *data = urb->transfer_buffer; |
7dcc85cd | 273 | int status = urb->status; |
1da177e4 LT |
274 | int result; |
275 | ||
1da177e4 | 276 | /* the urb might have been killed. */ |
7dcc85cd | 277 | if (status) |
1da177e4 LT |
278 | return; |
279 | ||
59d33f2f | 280 | usb_serial_debug_data(dev, __func__, urb->actual_length, data); |
1da177e4 LT |
281 | |
282 | /* React only to interrupts signaling a bulk_in transfer */ | |
b9c52f15 | 283 | if (urb->actual_length == 4 && data[0] == 0x01) { |
1da177e4 | 284 | short old_rdtodo; |
1da177e4 LT |
285 | |
286 | /* This is a announcement of coming bulk_ins. */ | |
287 | unsigned short size = ((unsigned short)data[3]<<8)+data[2]+3; | |
288 | ||
289 | spin_lock(&priv->lock); | |
290 | ||
291 | old_rdtodo = priv->rdtodo; | |
292 | ||
b9c52f15 | 293 | if (old_rdtodo + size < old_rdtodo) { |
96fc8e8d | 294 | dev_dbg(dev, "To many bulk_in urbs to do.\n"); |
1da177e4 LT |
295 | spin_unlock(&priv->lock); |
296 | goto resubmit; | |
297 | } | |
298 | ||
299 | /* "+=" is probably more fault tollerant than "=" */ | |
300 | priv->rdtodo += size; | |
301 | ||
96fc8e8d | 302 | dev_dbg(dev, "%s - rdtodo: %d\n", __func__, priv->rdtodo); |
1da177e4 LT |
303 | |
304 | spin_unlock(&priv->lock); | |
305 | ||
b9c52f15 | 306 | if (!old_rdtodo) { |
1da177e4 | 307 | result = usb_submit_urb(port->read_urb, GFP_ATOMIC); |
b9c52f15 | 308 | if (result) |
96fc8e8d | 309 | dev_err(dev, "%s - failed resubmitting read urb, error %d\n", |
194343d9 | 310 | __func__, result); |
96fc8e8d | 311 | dev_dbg(dev, "%s - usb_submit_urb(read urb)\n", __func__); |
1da177e4 LT |
312 | } |
313 | } | |
314 | ||
315 | resubmit: | |
1da177e4 LT |
316 | result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC); |
317 | if (result) | |
194343d9 | 318 | dev_err(&port->dev, "usb_submit_urb(read int) failed\n"); |
96fc8e8d | 319 | dev_dbg(dev, "%s - usb_submit_urb(int urb)\n", __func__); |
1da177e4 LT |
320 | } |
321 | ||
95da310e | 322 | static void cyberjack_read_bulk_callback(struct urb *urb) |
1da177e4 | 323 | { |
cdc97792 | 324 | struct usb_serial_port *port = urb->context; |
1da177e4 | 325 | struct cyberjack_private *priv = usb_get_serial_port_data(port); |
96fc8e8d | 326 | struct device *dev = &port->dev; |
1da177e4 LT |
327 | struct tty_struct *tty; |
328 | unsigned char *data = urb->transfer_buffer; | |
329 | short todo; | |
1da177e4 | 330 | int result; |
7dcc85cd | 331 | int status = urb->status; |
1da177e4 | 332 | |
59d33f2f | 333 | usb_serial_debug_data(dev, __func__, urb->actual_length, data); |
7dcc85cd | 334 | if (status) { |
96fc8e8d GKH |
335 | dev_dbg(dev, "%s - nonzero read bulk status received: %d\n", |
336 | __func__, status); | |
1da177e4 LT |
337 | return; |
338 | } | |
339 | ||
4a90f09b | 340 | tty = tty_port_tty_get(&port->port); |
1da177e4 | 341 | if (!tty) { |
96fc8e8d | 342 | dev_dbg(dev, "%s - ignoring since device not open\n", __func__); |
1da177e4 LT |
343 | return; |
344 | } | |
345 | if (urb->actual_length) { | |
05c7cd39 | 346 | tty_insert_flip_string(&port->port, data, urb->actual_length); |
b9c52f15 | 347 | tty_flip_buffer_push(tty); |
1da177e4 | 348 | } |
4a90f09b | 349 | tty_kref_put(tty); |
1da177e4 LT |
350 | |
351 | spin_lock(&priv->lock); | |
352 | ||
353 | /* Reduce urbs to do by one. */ | |
b9c52f15 | 354 | priv->rdtodo -= urb->actual_length; |
1da177e4 | 355 | /* Just to be sure */ |
b9c52f15 AC |
356 | if (priv->rdtodo < 0) |
357 | priv->rdtodo = 0; | |
1da177e4 LT |
358 | todo = priv->rdtodo; |
359 | ||
360 | spin_unlock(&priv->lock); | |
361 | ||
96fc8e8d | 362 | dev_dbg(dev, "%s - rdtodo: %d\n", __func__, todo); |
1da177e4 LT |
363 | |
364 | /* Continue to read if we have still urbs to do. */ | |
b9c52f15 | 365 | if (todo /* || (urb->actual_length==port->bulk_in_endpointAddress)*/) { |
1da177e4 LT |
366 | result = usb_submit_urb(port->read_urb, GFP_ATOMIC); |
367 | if (result) | |
96fc8e8d GKH |
368 | dev_err(dev, "%s - failed resubmitting read urb, error %d\n", |
369 | __func__, result); | |
370 | dev_dbg(dev, "%s - usb_submit_urb(read urb)\n", __func__); | |
1da177e4 LT |
371 | } |
372 | } | |
373 | ||
95da310e | 374 | static void cyberjack_write_bulk_callback(struct urb *urb) |
1da177e4 | 375 | { |
cdc97792 | 376 | struct usb_serial_port *port = urb->context; |
1da177e4 | 377 | struct cyberjack_private *priv = usb_get_serial_port_data(port); |
96fc8e8d | 378 | struct device *dev = &port->dev; |
7dcc85cd | 379 | int status = urb->status; |
1da177e4 | 380 | |
c1cac10c | 381 | set_bit(0, &port->write_urbs_free); |
7dcc85cd | 382 | if (status) { |
96fc8e8d GKH |
383 | dev_dbg(dev, "%s - nonzero write bulk status received: %d\n", |
384 | __func__, status); | |
1da177e4 LT |
385 | return; |
386 | } | |
387 | ||
388 | spin_lock(&priv->lock); | |
389 | ||
390 | /* only do something if we have more data to send */ | |
b9c52f15 | 391 | if (priv->wrfilled) { |
1da177e4 LT |
392 | int length, blksize, result; |
393 | ||
96fc8e8d | 394 | dev_dbg(dev, "%s - transmitting data (frame n)\n", __func__); |
1da177e4 LT |
395 | |
396 | length = ((priv->wrfilled - priv->wrsent) > port->bulk_out_size) ? | |
397 | port->bulk_out_size : (priv->wrfilled - priv->wrsent); | |
398 | ||
b9c52f15 AC |
399 | memcpy(port->write_urb->transfer_buffer, |
400 | priv->wrbuf + priv->wrsent, length); | |
401 | priv->wrsent += length; | |
1da177e4 LT |
402 | |
403 | /* set up our urb */ | |
fd11961a | 404 | port->write_urb->transfer_buffer_length = length; |
1da177e4 LT |
405 | |
406 | /* send the data out the bulk port */ | |
407 | result = usb_submit_urb(port->write_urb, GFP_ATOMIC); | |
408 | if (result) { | |
96fc8e8d | 409 | dev_err(dev, "%s - failed submitting write urb, error %d\n", |
194343d9 | 410 | __func__, result); |
1da177e4 | 411 | /* Throw away data. No better idea what to do with it. */ |
a5b6f60c AC |
412 | priv->wrfilled = 0; |
413 | priv->wrsent = 0; | |
1da177e4 LT |
414 | goto exit; |
415 | } | |
416 | ||
96fc8e8d GKH |
417 | dev_dbg(dev, "%s - priv->wrsent=%d\n", __func__, priv->wrsent); |
418 | dev_dbg(dev, "%s - priv->wrfilled=%d\n", __func__, priv->wrfilled); | |
1da177e4 LT |
419 | |
420 | blksize = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3; | |
421 | ||
b9c52f15 AC |
422 | if (priv->wrsent >= priv->wrfilled || |
423 | priv->wrsent >= blksize) { | |
96fc8e8d | 424 | dev_dbg(dev, "%s - buffer cleaned\n", __func__); |
b9c52f15 | 425 | memset(priv->wrbuf, 0, sizeof(priv->wrbuf)); |
a5b6f60c AC |
426 | priv->wrfilled = 0; |
427 | priv->wrsent = 0; | |
1da177e4 LT |
428 | } |
429 | } | |
430 | ||
431 | exit: | |
432 | spin_unlock(&priv->lock); | |
cf2c7481 | 433 | usb_serial_port_softint(port); |
1da177e4 LT |
434 | } |
435 | ||
68e24113 | 436 | module_usb_serial_driver(serial_drivers, id_table); |
1da177e4 | 437 | |
b9c52f15 AC |
438 | MODULE_AUTHOR(DRIVER_AUTHOR); |
439 | MODULE_DESCRIPTION(DRIVER_DESC); | |
1da177e4 | 440 | MODULE_LICENSE("GPL"); |