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