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; | |
143 | int result = 0; | |
144 | ||
96fc8e8d | 145 | dev_dbg(&port->dev, "%s - usb_clear_halt\n", __func__); |
1da177e4 LT |
146 | usb_clear_halt(port->serial->dev, port->write_urb->pipe); |
147 | ||
1da177e4 LT |
148 | priv = usb_get_serial_port_data(port); |
149 | spin_lock_irqsave(&priv->lock, flags); | |
150 | priv->rdtodo = 0; | |
151 | priv->wrfilled = 0; | |
152 | priv->wrsent = 0; | |
153 | spin_unlock_irqrestore(&priv->lock, flags); | |
154 | ||
155 | return result; | |
156 | } | |
157 | ||
335f8514 | 158 | static void cyberjack_close(struct usb_serial_port *port) |
1da177e4 | 159 | { |
1bc77f4d JH |
160 | usb_kill_urb(port->write_urb); |
161 | usb_kill_urb(port->read_urb); | |
1da177e4 LT |
162 | } |
163 | ||
95da310e AC |
164 | static int cyberjack_write(struct tty_struct *tty, |
165 | struct usb_serial_port *port, const unsigned char *buf, int count) | |
1da177e4 | 166 | { |
96fc8e8d | 167 | struct device *dev = &port->dev; |
1da177e4 LT |
168 | struct cyberjack_private *priv = usb_get_serial_port_data(port); |
169 | unsigned long flags; | |
170 | int result; | |
171 | int wrexpected; | |
172 | ||
1da177e4 | 173 | if (count == 0) { |
96fc8e8d | 174 | dev_dbg(dev, "%s - write request of 0 bytes\n", __func__); |
a5b6f60c | 175 | return 0; |
1da177e4 LT |
176 | } |
177 | ||
c1cac10c | 178 | if (!test_and_clear_bit(0, &port->write_urbs_free)) { |
96fc8e8d | 179 | dev_dbg(dev, "%s - already writing\n", __func__); |
507ca9bc | 180 | return 0; |
1da177e4 LT |
181 | } |
182 | ||
183 | spin_lock_irqsave(&priv->lock, flags); | |
184 | ||
b9c52f15 | 185 | if (count+priv->wrfilled > sizeof(priv->wrbuf)) { |
1da177e4 | 186 | /* To much data for buffer. Reset buffer. */ |
a5b6f60c | 187 | priv->wrfilled = 0; |
a5b6f60c | 188 | spin_unlock_irqrestore(&priv->lock, flags); |
c1cac10c | 189 | set_bit(0, &port->write_urbs_free); |
a5b6f60c | 190 | return 0; |
1da177e4 LT |
191 | } |
192 | ||
193 | /* Copy data */ | |
b9c52f15 | 194 | memcpy(priv->wrbuf + priv->wrfilled, buf, count); |
1da177e4 | 195 | |
59d33f2f | 196 | usb_serial_debug_data(dev, __func__, count, priv->wrbuf + priv->wrfilled); |
1da177e4 LT |
197 | priv->wrfilled += count; |
198 | ||
b9c52f15 | 199 | if (priv->wrfilled >= 3) { |
1da177e4 | 200 | wrexpected = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3; |
96fc8e8d | 201 | dev_dbg(dev, "%s - expected data: %d\n", __func__, wrexpected); |
b9c52f15 | 202 | } else |
1da177e4 | 203 | wrexpected = sizeof(priv->wrbuf); |
1da177e4 | 204 | |
b9c52f15 | 205 | if (priv->wrfilled >= wrexpected) { |
1da177e4 LT |
206 | /* We have enough data to begin transmission */ |
207 | int length; | |
208 | ||
96fc8e8d | 209 | dev_dbg(dev, "%s - transmitting data (frame 1)\n", __func__); |
b9c52f15 AC |
210 | length = (wrexpected > port->bulk_out_size) ? |
211 | port->bulk_out_size : wrexpected; | |
1da177e4 | 212 | |
b9c52f15 AC |
213 | memcpy(port->write_urb->transfer_buffer, priv->wrbuf, length); |
214 | priv->wrsent = length; | |
1da177e4 LT |
215 | |
216 | /* set up our urb */ | |
fd11961a | 217 | port->write_urb->transfer_buffer_length = length; |
1da177e4 LT |
218 | |
219 | /* send the data out the bulk port */ | |
220 | result = usb_submit_urb(port->write_urb, GFP_ATOMIC); | |
221 | if (result) { | |
194343d9 GKH |
222 | dev_err(&port->dev, |
223 | "%s - failed submitting write urb, error %d", | |
224 | __func__, result); | |
1da177e4 | 225 | /* Throw away data. No better idea what to do with it. */ |
a5b6f60c AC |
226 | priv->wrfilled = 0; |
227 | priv->wrsent = 0; | |
1da177e4 | 228 | spin_unlock_irqrestore(&priv->lock, flags); |
c1cac10c | 229 | set_bit(0, &port->write_urbs_free); |
1da177e4 LT |
230 | return 0; |
231 | } | |
232 | ||
96fc8e8d GKH |
233 | dev_dbg(dev, "%s - priv->wrsent=%d\n", __func__, priv->wrsent); |
234 | dev_dbg(dev, "%s - priv->wrfilled=%d\n", __func__, priv->wrfilled); | |
1da177e4 | 235 | |
b9c52f15 | 236 | if (priv->wrsent >= priv->wrfilled) { |
96fc8e8d | 237 | dev_dbg(dev, "%s - buffer cleaned\n", __func__); |
b9c52f15 | 238 | memset(priv->wrbuf, 0, sizeof(priv->wrbuf)); |
a5b6f60c AC |
239 | priv->wrfilled = 0; |
240 | priv->wrsent = 0; | |
1da177e4 LT |
241 | } |
242 | } | |
243 | ||
244 | spin_unlock_irqrestore(&priv->lock, flags); | |
245 | ||
b9c52f15 AC |
246 | return count; |
247 | } | |
1da177e4 | 248 | |
95da310e | 249 | static int cyberjack_write_room(struct tty_struct *tty) |
1da177e4 | 250 | { |
a5b6f60c | 251 | /* FIXME: .... */ |
1da177e4 LT |
252 | return CYBERJACK_LOCAL_BUF_SIZE; |
253 | } | |
254 | ||
95da310e | 255 | static void cyberjack_read_int_callback(struct urb *urb) |
1da177e4 | 256 | { |
cdc97792 | 257 | struct usb_serial_port *port = urb->context; |
1da177e4 | 258 | struct cyberjack_private *priv = usb_get_serial_port_data(port); |
96fc8e8d | 259 | struct device *dev = &port->dev; |
1da177e4 | 260 | unsigned char *data = urb->transfer_buffer; |
7dcc85cd | 261 | int status = urb->status; |
1da177e4 LT |
262 | int result; |
263 | ||
1da177e4 | 264 | /* the urb might have been killed. */ |
7dcc85cd | 265 | if (status) |
1da177e4 LT |
266 | return; |
267 | ||
59d33f2f | 268 | usb_serial_debug_data(dev, __func__, urb->actual_length, data); |
1da177e4 LT |
269 | |
270 | /* React only to interrupts signaling a bulk_in transfer */ | |
b9c52f15 | 271 | if (urb->actual_length == 4 && data[0] == 0x01) { |
1da177e4 | 272 | short old_rdtodo; |
1da177e4 LT |
273 | |
274 | /* This is a announcement of coming bulk_ins. */ | |
275 | unsigned short size = ((unsigned short)data[3]<<8)+data[2]+3; | |
276 | ||
277 | spin_lock(&priv->lock); | |
278 | ||
279 | old_rdtodo = priv->rdtodo; | |
280 | ||
5287bf72 | 281 | if (old_rdtodo > SHRT_MAX - size) { |
96fc8e8d | 282 | dev_dbg(dev, "To many bulk_in urbs to do.\n"); |
1da177e4 LT |
283 | spin_unlock(&priv->lock); |
284 | goto resubmit; | |
285 | } | |
286 | ||
cd8c5053 | 287 | /* "+=" is probably more fault tolerant than "=" */ |
1da177e4 LT |
288 | priv->rdtodo += size; |
289 | ||
96fc8e8d | 290 | dev_dbg(dev, "%s - rdtodo: %d\n", __func__, priv->rdtodo); |
1da177e4 LT |
291 | |
292 | spin_unlock(&priv->lock); | |
293 | ||
b9c52f15 | 294 | if (!old_rdtodo) { |
1da177e4 | 295 | result = usb_submit_urb(port->read_urb, GFP_ATOMIC); |
b9c52f15 | 296 | if (result) |
96fc8e8d | 297 | dev_err(dev, "%s - failed resubmitting read urb, error %d\n", |
194343d9 | 298 | __func__, result); |
96fc8e8d | 299 | dev_dbg(dev, "%s - usb_submit_urb(read urb)\n", __func__); |
1da177e4 LT |
300 | } |
301 | } | |
302 | ||
303 | resubmit: | |
1da177e4 LT |
304 | result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC); |
305 | if (result) | |
194343d9 | 306 | dev_err(&port->dev, "usb_submit_urb(read int) failed\n"); |
96fc8e8d | 307 | dev_dbg(dev, "%s - usb_submit_urb(int urb)\n", __func__); |
1da177e4 LT |
308 | } |
309 | ||
95da310e | 310 | static void cyberjack_read_bulk_callback(struct urb *urb) |
1da177e4 | 311 | { |
cdc97792 | 312 | struct usb_serial_port *port = urb->context; |
1da177e4 | 313 | struct cyberjack_private *priv = usb_get_serial_port_data(port); |
96fc8e8d | 314 | struct device *dev = &port->dev; |
1da177e4 LT |
315 | unsigned char *data = urb->transfer_buffer; |
316 | short todo; | |
1da177e4 | 317 | int result; |
7dcc85cd | 318 | int status = urb->status; |
1da177e4 | 319 | |
59d33f2f | 320 | usb_serial_debug_data(dev, __func__, urb->actual_length, data); |
7dcc85cd | 321 | if (status) { |
96fc8e8d GKH |
322 | dev_dbg(dev, "%s - nonzero read bulk status received: %d\n", |
323 | __func__, status); | |
1da177e4 LT |
324 | return; |
325 | } | |
326 | ||
1da177e4 | 327 | if (urb->actual_length) { |
05c7cd39 | 328 | tty_insert_flip_string(&port->port, data, urb->actual_length); |
2e124b4a | 329 | tty_flip_buffer_push(&port->port); |
1da177e4 LT |
330 | } |
331 | ||
332 | spin_lock(&priv->lock); | |
333 | ||
334 | /* Reduce urbs to do by one. */ | |
b9c52f15 | 335 | priv->rdtodo -= urb->actual_length; |
1da177e4 | 336 | /* Just to be sure */ |
b9c52f15 AC |
337 | if (priv->rdtodo < 0) |
338 | priv->rdtodo = 0; | |
1da177e4 LT |
339 | todo = priv->rdtodo; |
340 | ||
341 | spin_unlock(&priv->lock); | |
342 | ||
96fc8e8d | 343 | dev_dbg(dev, "%s - rdtodo: %d\n", __func__, todo); |
1da177e4 LT |
344 | |
345 | /* Continue to read if we have still urbs to do. */ | |
b9c52f15 | 346 | if (todo /* || (urb->actual_length==port->bulk_in_endpointAddress)*/) { |
1da177e4 LT |
347 | result = usb_submit_urb(port->read_urb, GFP_ATOMIC); |
348 | if (result) | |
96fc8e8d GKH |
349 | dev_err(dev, "%s - failed resubmitting read urb, error %d\n", |
350 | __func__, result); | |
351 | dev_dbg(dev, "%s - usb_submit_urb(read urb)\n", __func__); | |
1da177e4 LT |
352 | } |
353 | } | |
354 | ||
95da310e | 355 | static void cyberjack_write_bulk_callback(struct urb *urb) |
1da177e4 | 356 | { |
cdc97792 | 357 | struct usb_serial_port *port = urb->context; |
1da177e4 | 358 | struct cyberjack_private *priv = usb_get_serial_port_data(port); |
96fc8e8d | 359 | struct device *dev = &port->dev; |
7dcc85cd | 360 | int status = urb->status; |
1da177e4 | 361 | |
c1cac10c | 362 | set_bit(0, &port->write_urbs_free); |
7dcc85cd | 363 | if (status) { |
96fc8e8d GKH |
364 | dev_dbg(dev, "%s - nonzero write bulk status received: %d\n", |
365 | __func__, status); | |
1da177e4 LT |
366 | return; |
367 | } | |
368 | ||
369 | spin_lock(&priv->lock); | |
370 | ||
371 | /* only do something if we have more data to send */ | |
b9c52f15 | 372 | if (priv->wrfilled) { |
1da177e4 LT |
373 | int length, blksize, result; |
374 | ||
96fc8e8d | 375 | dev_dbg(dev, "%s - transmitting data (frame n)\n", __func__); |
1da177e4 LT |
376 | |
377 | length = ((priv->wrfilled - priv->wrsent) > port->bulk_out_size) ? | |
378 | port->bulk_out_size : (priv->wrfilled - priv->wrsent); | |
379 | ||
b9c52f15 AC |
380 | memcpy(port->write_urb->transfer_buffer, |
381 | priv->wrbuf + priv->wrsent, length); | |
382 | priv->wrsent += length; | |
1da177e4 LT |
383 | |
384 | /* set up our urb */ | |
fd11961a | 385 | port->write_urb->transfer_buffer_length = length; |
1da177e4 LT |
386 | |
387 | /* send the data out the bulk port */ | |
388 | result = usb_submit_urb(port->write_urb, GFP_ATOMIC); | |
389 | if (result) { | |
96fc8e8d | 390 | dev_err(dev, "%s - failed submitting write urb, error %d\n", |
194343d9 | 391 | __func__, result); |
1da177e4 | 392 | /* Throw away data. No better idea what to do with it. */ |
a5b6f60c AC |
393 | priv->wrfilled = 0; |
394 | priv->wrsent = 0; | |
1da177e4 LT |
395 | goto exit; |
396 | } | |
397 | ||
96fc8e8d GKH |
398 | dev_dbg(dev, "%s - priv->wrsent=%d\n", __func__, priv->wrsent); |
399 | dev_dbg(dev, "%s - priv->wrfilled=%d\n", __func__, priv->wrfilled); | |
1da177e4 LT |
400 | |
401 | blksize = ((int)priv->wrbuf[2]<<8)+priv->wrbuf[1]+3; | |
402 | ||
b9c52f15 AC |
403 | if (priv->wrsent >= priv->wrfilled || |
404 | priv->wrsent >= blksize) { | |
96fc8e8d | 405 | dev_dbg(dev, "%s - buffer cleaned\n", __func__); |
b9c52f15 | 406 | memset(priv->wrbuf, 0, sizeof(priv->wrbuf)); |
a5b6f60c AC |
407 | priv->wrfilled = 0; |
408 | priv->wrsent = 0; | |
1da177e4 LT |
409 | } |
410 | } | |
411 | ||
412 | exit: | |
413 | spin_unlock(&priv->lock); | |
cf2c7481 | 414 | usb_serial_port_softint(port); |
1da177e4 LT |
415 | } |
416 | ||
68e24113 | 417 | module_usb_serial_driver(serial_drivers, id_table); |
1da177e4 | 418 | |
b9c52f15 AC |
419 | MODULE_AUTHOR(DRIVER_AUTHOR); |
420 | MODULE_DESCRIPTION(DRIVER_DESC); | |
1da177e4 | 421 | MODULE_LICENSE("GPL"); |