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