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