cyberjack.c 11 KB

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