2 * A driver for the Omnikey PCMCIA smartcard reader CardMan 4040
4 * (c) 2000-2004 Omnikey AG (http://www.omnikey.com/)
6 * (C) 2005-2006 Harald Welte <laforge@gnumonks.org>
7 * - add support for poll()
10 * - adhere to linux kernel coding style and policies
11 * - support 2.6.13 "new style" pcmcia interface
12 * - add class interface for udev device creation
14 * The device basically is a USB CCID compliant device that has been
15 * attached to an I/O-Mapped FIFO.
17 * All rights reserved, Dual BSD/GPL Licensed.
20 #include <linux/kernel.h>
21 #include <linux/module.h>
22 #include <linux/slab.h>
23 #include <linux/init.h>
25 #include <linux/delay.h>
26 #include <linux/poll.h>
27 #include <linux/smp_lock.h>
28 #include <linux/wait.h>
29 #include <asm/uaccess.h>
32 #include <pcmcia/cistpl.h>
33 #include <pcmcia/cisreg.h>
34 #include <pcmcia/ciscode.h>
35 #include <pcmcia/ds.h>
37 #include "cm4040_cs.h"
40 #define reader_to_dev(x) (&x->p_dev->dev)
42 /* n (debug level) is ignored */
43 /* additional debug output may be enabled by re-compiling with
45 /* #define CM4040_DEBUG */
46 #define DEBUGP(n, rdr, x, args...) do { \
47 dev_dbg(reader_to_dev(rdr), "%s:" x, \
48 __func__ , ## args); \
51 #define CCID_DRIVER_BULK_DEFAULT_TIMEOUT (150*HZ)
52 #define CCID_DRIVER_ASYNC_POWERUP_TIMEOUT (35*HZ)
53 #define CCID_DRIVER_MINIMUM_TIMEOUT (3*HZ)
54 #define READ_WRITE_BUFFER_SIZE 512
55 #define POLL_LOOP_COUNT 1000
57 /* how often to poll for fifo status change */
58 #define POLL_PERIOD msecs_to_jiffies(10)
60 static void reader_release(struct pcmcia_device *link);
63 static struct class *cmx_class;
65 #define BS_READABLE 0x01
66 #define BS_WRITABLE 0x02
69 struct pcmcia_device *p_dev;
70 wait_queue_head_t devq;
71 wait_queue_head_t poll_wait;
72 wait_queue_head_t read_wait;
73 wait_queue_head_t write_wait;
74 unsigned long buffer_status;
75 unsigned long timeout;
76 unsigned char s_buf[READ_WRITE_BUFFER_SIZE];
77 unsigned char r_buf[READ_WRITE_BUFFER_SIZE];
78 struct timer_list poll_timer;
81 static struct pcmcia_device *dev_table[CM_MAX_DEV];
87 static inline void xoutb(unsigned char val, unsigned short port)
89 pr_debug("outb(val=%.2x,port=%.4x)\n", val, port);
93 static inline unsigned char xinb(unsigned short port)
98 pr_debug("%.2x=inb(%.4x)\n", val, port);
103 /* poll the device fifo status register. not to be confused with
104 * the poll syscall. */
105 static void cm4040_do_poll(unsigned long dummy)
107 struct reader_dev *dev = (struct reader_dev *) dummy;
108 unsigned int obs = xinb(dev->p_dev->resource[0]->start
109 + REG_OFFSET_BUFFER_STATUS);
111 if ((obs & BSR_BULK_IN_FULL)) {
112 set_bit(BS_READABLE, &dev->buffer_status);
113 DEBUGP(4, dev, "waking up read_wait\n");
114 wake_up_interruptible(&dev->read_wait);
116 clear_bit(BS_READABLE, &dev->buffer_status);
118 if (!(obs & BSR_BULK_OUT_FULL)) {
119 set_bit(BS_WRITABLE, &dev->buffer_status);
120 DEBUGP(4, dev, "waking up write_wait\n");
121 wake_up_interruptible(&dev->write_wait);
123 clear_bit(BS_WRITABLE, &dev->buffer_status);
125 if (dev->buffer_status)
126 wake_up_interruptible(&dev->poll_wait);
128 mod_timer(&dev->poll_timer, jiffies + POLL_PERIOD);
131 static void cm4040_stop_poll(struct reader_dev *dev)
133 del_timer_sync(&dev->poll_timer);
136 static int wait_for_bulk_out_ready(struct reader_dev *dev)
139 int iobase = dev->p_dev->resource[0]->start;
141 for (i = 0; i < POLL_LOOP_COUNT; i++) {
142 if ((xinb(iobase + REG_OFFSET_BUFFER_STATUS)
143 & BSR_BULK_OUT_FULL) == 0) {
144 DEBUGP(4, dev, "BulkOut empty (i=%d)\n", i);
149 DEBUGP(4, dev, "wait_event_interruptible_timeout(timeout=%ld\n",
151 rc = wait_event_interruptible_timeout(dev->write_wait,
152 test_and_clear_bit(BS_WRITABLE,
153 &dev->buffer_status),
157 DEBUGP(4, dev, "woke up: BulkOut empty\n");
159 DEBUGP(4, dev, "woke up: BulkOut full, returning 0 :(\n");
161 DEBUGP(4, dev, "woke up: signal arrived\n");
166 /* Write to Sync Control Register */
167 static int write_sync_reg(unsigned char val, struct reader_dev *dev)
169 int iobase = dev->p_dev->resource[0]->start;
172 rc = wait_for_bulk_out_ready(dev);
176 xoutb(val, iobase + REG_OFFSET_SYNC_CONTROL);
177 rc = wait_for_bulk_out_ready(dev);
184 static int wait_for_bulk_in_ready(struct reader_dev *dev)
187 int iobase = dev->p_dev->resource[0]->start;
189 for (i = 0; i < POLL_LOOP_COUNT; i++) {
190 if ((xinb(iobase + REG_OFFSET_BUFFER_STATUS)
191 & BSR_BULK_IN_FULL) == BSR_BULK_IN_FULL) {
192 DEBUGP(3, dev, "BulkIn full (i=%d)\n", i);
197 DEBUGP(4, dev, "wait_event_interruptible_timeout(timeout=%ld\n",
199 rc = wait_event_interruptible_timeout(dev->read_wait,
200 test_and_clear_bit(BS_READABLE,
201 &dev->buffer_status),
204 DEBUGP(4, dev, "woke up: BulkIn full\n");
206 DEBUGP(4, dev, "woke up: BulkIn not full, returning 0 :(\n");
208 DEBUGP(4, dev, "woke up: signal arrived\n");
213 static ssize_t cm4040_read(struct file *filp, char __user *buf,
214 size_t count, loff_t *ppos)
216 struct reader_dev *dev = filp->private_data;
217 int iobase = dev->p_dev->resource[0]->start;
218 size_t bytes_to_read;
220 size_t min_bytes_to_read;
224 DEBUGP(2, dev, "-> cm4040_read(%s,%d)\n", current->comm, current->pid);
232 if (filp->f_flags & O_NONBLOCK) {
233 DEBUGP(4, dev, "filep->f_flags O_NONBLOCK set\n");
234 DEBUGP(2, dev, "<- cm4040_read (failure)\n");
238 if (!pcmcia_dev_present(dev->p_dev))
241 for (i = 0; i < 5; i++) {
242 rc = wait_for_bulk_in_ready(dev);
244 DEBUGP(5, dev, "wait_for_bulk_in_ready rc=%.2x\n", rc);
245 DEBUGP(2, dev, "<- cm4040_read (failed)\n");
246 if (rc == -ERESTARTSYS)
250 dev->r_buf[i] = xinb(iobase + REG_OFFSET_BULK_IN);
252 pr_debug("%lu:%2x ", i, dev->r_buf[i]);
259 bytes_to_read = 5 + le32_to_cpu(*(__le32 *)&dev->r_buf[1]);
261 DEBUGP(6, dev, "BytesToRead=%zu\n", bytes_to_read);
263 min_bytes_to_read = min(count, bytes_to_read + 5);
264 min_bytes_to_read = min_t(size_t, min_bytes_to_read, READ_WRITE_BUFFER_SIZE);
266 DEBUGP(6, dev, "Min=%zu\n", min_bytes_to_read);
268 for (i = 0; i < (min_bytes_to_read-5); i++) {
269 rc = wait_for_bulk_in_ready(dev);
271 DEBUGP(5, dev, "wait_for_bulk_in_ready rc=%.2x\n", rc);
272 DEBUGP(2, dev, "<- cm4040_read (failed)\n");
273 if (rc == -ERESTARTSYS)
277 dev->r_buf[i+5] = xinb(iobase + REG_OFFSET_BULK_IN);
279 pr_debug("%lu:%2x ", i, dev->r_buf[i]);
286 *ppos = min_bytes_to_read;
287 if (copy_to_user(buf, dev->r_buf, min_bytes_to_read))
290 rc = wait_for_bulk_in_ready(dev);
292 DEBUGP(5, dev, "wait_for_bulk_in_ready rc=%.2x\n", rc);
293 DEBUGP(2, dev, "<- cm4040_read (failed)\n");
294 if (rc == -ERESTARTSYS)
299 rc = write_sync_reg(SCR_READER_TO_HOST_DONE, dev);
301 DEBUGP(5, dev, "write_sync_reg c=%.2x\n", rc);
302 DEBUGP(2, dev, "<- cm4040_read (failed)\n");
303 if (rc == -ERESTARTSYS)
309 uc = xinb(iobase + REG_OFFSET_BULK_IN);
311 DEBUGP(2, dev, "<- cm4040_read (successfully)\n");
312 return min_bytes_to_read;
315 static ssize_t cm4040_write(struct file *filp, const char __user *buf,
316 size_t count, loff_t *ppos)
318 struct reader_dev *dev = filp->private_data;
319 int iobase = dev->p_dev->resource[0]->start;
322 unsigned int bytes_to_write;
324 DEBUGP(2, dev, "-> cm4040_write(%s,%d)\n", current->comm, current->pid);
327 DEBUGP(2, dev, "<- cm4040_write empty read (successfully)\n");
331 if ((count < 5) || (count > READ_WRITE_BUFFER_SIZE)) {
332 DEBUGP(2, dev, "<- cm4040_write buffersize=%Zd < 5\n", count);
336 if (filp->f_flags & O_NONBLOCK) {
337 DEBUGP(4, dev, "filep->f_flags O_NONBLOCK set\n");
338 DEBUGP(4, dev, "<- cm4040_write (failure)\n");
342 if (!pcmcia_dev_present(dev->p_dev))
345 bytes_to_write = count;
346 if (copy_from_user(dev->s_buf, buf, bytes_to_write))
349 switch (dev->s_buf[0]) {
350 case CMD_PC_TO_RDR_XFRBLOCK:
351 case CMD_PC_TO_RDR_SECURE:
352 case CMD_PC_TO_RDR_TEST_SECURE:
353 case CMD_PC_TO_RDR_OK_SECURE:
354 dev->timeout = CCID_DRIVER_BULK_DEFAULT_TIMEOUT;
357 case CMD_PC_TO_RDR_ICCPOWERON:
358 dev->timeout = CCID_DRIVER_ASYNC_POWERUP_TIMEOUT;
361 case CMD_PC_TO_RDR_GETSLOTSTATUS:
362 case CMD_PC_TO_RDR_ICCPOWEROFF:
363 case CMD_PC_TO_RDR_GETPARAMETERS:
364 case CMD_PC_TO_RDR_RESETPARAMETERS:
365 case CMD_PC_TO_RDR_SETPARAMETERS:
366 case CMD_PC_TO_RDR_ESCAPE:
367 case CMD_PC_TO_RDR_ICCCLOCK:
369 dev->timeout = CCID_DRIVER_MINIMUM_TIMEOUT;
373 rc = write_sync_reg(SCR_HOST_TO_READER_START, dev);
375 DEBUGP(5, dev, "write_sync_reg c=%.2Zx\n", rc);
376 DEBUGP(2, dev, "<- cm4040_write (failed)\n");
377 if (rc == -ERESTARTSYS)
383 DEBUGP(4, dev, "start \n");
385 for (i = 0; i < bytes_to_write; i++) {
386 rc = wait_for_bulk_out_ready(dev);
388 DEBUGP(5, dev, "wait_for_bulk_out_ready rc=%.2Zx\n",
390 DEBUGP(2, dev, "<- cm4040_write (failed)\n");
391 if (rc == -ERESTARTSYS)
397 xoutb(dev->s_buf[i],iobase + REG_OFFSET_BULK_OUT);
399 DEBUGP(4, dev, "end\n");
401 rc = write_sync_reg(SCR_HOST_TO_READER_DONE, dev);
404 DEBUGP(5, dev, "write_sync_reg c=%.2Zx\n", rc);
405 DEBUGP(2, dev, "<- cm4040_write (failed)\n");
406 if (rc == -ERESTARTSYS)
412 DEBUGP(2, dev, "<- cm4040_write (successfully)\n");
416 static unsigned int cm4040_poll(struct file *filp, poll_table *wait)
418 struct reader_dev *dev = filp->private_data;
419 unsigned int mask = 0;
421 poll_wait(filp, &dev->poll_wait, wait);
423 if (test_and_clear_bit(BS_READABLE, &dev->buffer_status))
424 mask |= POLLIN | POLLRDNORM;
425 if (test_and_clear_bit(BS_WRITABLE, &dev->buffer_status))
426 mask |= POLLOUT | POLLWRNORM;
428 DEBUGP(2, dev, "<- cm4040_poll(%u)\n", mask);
433 static int cm4040_open(struct inode *inode, struct file *filp)
435 struct reader_dev *dev;
436 struct pcmcia_device *link;
437 int minor = iminor(inode);
440 if (minor >= CM_MAX_DEV)
444 link = dev_table[minor];
445 if (link == NULL || !pcmcia_dev_present(link)) {
456 filp->private_data = dev;
458 if (filp->f_flags & O_NONBLOCK) {
459 DEBUGP(4, dev, "filep->f_flags O_NONBLOCK set\n");
466 dev->poll_timer.data = (unsigned long) dev;
467 mod_timer(&dev->poll_timer, jiffies + POLL_PERIOD);
469 DEBUGP(2, dev, "<- cm4040_open (successfully)\n");
470 ret = nonseekable_open(inode, filp);
476 static int cm4040_close(struct inode *inode, struct file *filp)
478 struct reader_dev *dev = filp->private_data;
479 struct pcmcia_device *link;
480 int minor = iminor(inode);
482 DEBUGP(2, dev, "-> cm4040_close(maj/min=%d.%d)\n", imajor(inode),
485 if (minor >= CM_MAX_DEV)
488 link = dev_table[minor];
492 cm4040_stop_poll(dev);
497 DEBUGP(2, dev, "<- cm4040_close\n");
501 static void cm4040_reader_release(struct pcmcia_device *link)
503 struct reader_dev *dev = link->priv;
505 DEBUGP(3, dev, "-> cm4040_reader_release\n");
507 DEBUGP(3, dev, KERN_INFO MODULE_NAME ": delaying release "
508 "until process has terminated\n");
509 wait_event(dev->devq, (link->open == 0));
511 DEBUGP(3, dev, "<- cm4040_reader_release\n");
515 static int cm4040_config_check(struct pcmcia_device *p_dev, void *priv_data)
517 return pcmcia_request_io(p_dev);
521 static int reader_config(struct pcmcia_device *link, int devno)
523 struct reader_dev *dev;
526 link->config_flags |= CONF_AUTO_SET_IO;
528 if (pcmcia_loop_config(link, cm4040_config_check, NULL))
531 fail_rc = pcmcia_enable_device(link);
533 dev_printk(KERN_INFO, &link->dev,
534 "pcmcia_enable_device failed 0x%x\n",
541 DEBUGP(2, dev, "device " DEVICE_NAME "%d at %pR\n", devno,
543 DEBUGP(2, dev, "<- reader_config (succ)\n");
548 reader_release(link);
552 static void reader_release(struct pcmcia_device *link)
554 cm4040_reader_release(link);
555 pcmcia_disable_device(link);
558 static int reader_probe(struct pcmcia_device *link)
560 struct reader_dev *dev;
563 for (i = 0; i < CM_MAX_DEV; i++) {
564 if (dev_table[i] == NULL)
571 dev = kzalloc(sizeof(struct reader_dev), GFP_KERNEL);
575 dev->timeout = CCID_DRIVER_MINIMUM_TIMEOUT;
576 dev->buffer_status = 0;
583 init_waitqueue_head(&dev->devq);
584 init_waitqueue_head(&dev->poll_wait);
585 init_waitqueue_head(&dev->read_wait);
586 init_waitqueue_head(&dev->write_wait);
587 setup_timer(&dev->poll_timer, cm4040_do_poll, 0);
589 ret = reader_config(link, i);
596 device_create(cmx_class, NULL, MKDEV(major, i), NULL, "cmx%d", i);
601 static void reader_detach(struct pcmcia_device *link)
603 struct reader_dev *dev = link->priv;
607 for (devno = 0; devno < CM_MAX_DEV; devno++) {
608 if (dev_table[devno] == link)
611 if (devno == CM_MAX_DEV)
614 reader_release(link);
616 dev_table[devno] = NULL;
619 device_destroy(cmx_class, MKDEV(major, devno));
624 static const struct file_operations reader_fops = {
625 .owner = THIS_MODULE,
627 .write = cm4040_write,
629 .release = cm4040_close,
633 static struct pcmcia_device_id cm4040_ids[] = {
634 PCMCIA_DEVICE_MANF_CARD(0x0223, 0x0200),
635 PCMCIA_DEVICE_PROD_ID12("OMNIKEY", "CardMan 4040",
636 0xE32CDD8C, 0x8F23318B),
639 MODULE_DEVICE_TABLE(pcmcia, cm4040_ids);
641 static struct pcmcia_driver reader_driver = {
642 .owner = THIS_MODULE,
644 .probe = reader_probe,
645 .remove = reader_detach,
646 .id_table = cm4040_ids,
649 static int __init cm4040_init(void)
653 cmx_class = class_create(THIS_MODULE, "cardman_4040");
654 if (IS_ERR(cmx_class))
655 return PTR_ERR(cmx_class);
657 major = register_chrdev(0, DEVICE_NAME, &reader_fops);
659 printk(KERN_WARNING MODULE_NAME
660 ": could not get major number\n");
661 class_destroy(cmx_class);
665 rc = pcmcia_register_driver(&reader_driver);
667 unregister_chrdev(major, DEVICE_NAME);
668 class_destroy(cmx_class);
675 static void __exit cm4040_exit(void)
677 pcmcia_unregister_driver(&reader_driver);
678 unregister_chrdev(major, DEVICE_NAME);
679 class_destroy(cmx_class);
682 module_init(cm4040_init);
683 module_exit(cm4040_exit);
684 MODULE_LICENSE("Dual BSD/GPL");