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 /* #define PCMCIA_DEBUG 6 */
22 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/slab.h>
25 #include <linux/init.h>
27 #include <linux/delay.h>
28 #include <linux/poll.h>
29 #include <linux/wait.h>
30 #include <asm/uaccess.h>
33 #include <pcmcia/cs_types.h>
34 #include <pcmcia/cs.h>
35 #include <pcmcia/cistpl.h>
36 #include <pcmcia/cisreg.h>
37 #include <pcmcia/ciscode.h>
38 #include <pcmcia/ds.h>
40 #include "cm4040_cs.h"
44 #define reader_to_dev(x) (&handle_to_dev(x->p_dev))
45 static int pc_debug
= PCMCIA_DEBUG
;
46 module_param(pc_debug
, int, 0600);
47 #define DEBUGP(n, rdr, x, args...) do { \
48 if (pc_debug >= (n)) \
49 dev_printk(KERN_DEBUG, reader_to_dev(rdr), "%s:" x, \
50 __FUNCTION__ , ##args); \
53 #define DEBUGP(n, rdr, x, args...)
56 static char *version
=
57 "OMNIKEY CardMan 4040 v1.1.0gm5 - All bugs added by Harald Welte";
59 #define CCID_DRIVER_BULK_DEFAULT_TIMEOUT (150*HZ)
60 #define CCID_DRIVER_ASYNC_POWERUP_TIMEOUT (35*HZ)
61 #define CCID_DRIVER_MINIMUM_TIMEOUT (3*HZ)
62 #define READ_WRITE_BUFFER_SIZE 512
63 #define POLL_LOOP_COUNT 1000
65 /* how often to poll for fifo status change */
66 #define POLL_PERIOD msecs_to_jiffies(10)
68 static void reader_release(struct pcmcia_device
*link
);
71 static struct class *cmx_class
;
73 #define BS_READABLE 0x01
74 #define BS_WRITABLE 0x02
77 struct pcmcia_device
*p_dev
;
79 wait_queue_head_t devq
;
80 wait_queue_head_t poll_wait
;
81 wait_queue_head_t read_wait
;
82 wait_queue_head_t write_wait
;
83 unsigned long buffer_status
;
84 unsigned long timeout
;
85 unsigned char s_buf
[READ_WRITE_BUFFER_SIZE
];
86 unsigned char r_buf
[READ_WRITE_BUFFER_SIZE
];
87 struct timer_list poll_timer
;
90 static struct pcmcia_device
*dev_table
[CM_MAX_DEV
];
96 static inline void xoutb(unsigned char val
, unsigned short port
)
99 printk(KERN_DEBUG
"outb(val=%.2x,port=%.4x)\n", val
, port
);
103 static inline unsigned char xinb(unsigned short port
)
109 printk(KERN_DEBUG
"%.2x=inb(%.4x)\n", val
, port
);
114 /* poll the device fifo status register. not to be confused with
115 * the poll syscall. */
116 static void cm4040_do_poll(unsigned long dummy
)
118 struct reader_dev
*dev
= (struct reader_dev
*) dummy
;
119 unsigned int obs
= xinb(dev
->p_dev
->io
.BasePort1
120 + REG_OFFSET_BUFFER_STATUS
);
122 if ((obs
& BSR_BULK_IN_FULL
)) {
123 set_bit(BS_READABLE
, &dev
->buffer_status
);
124 DEBUGP(4, dev
, "waking up read_wait\n");
125 wake_up_interruptible(&dev
->read_wait
);
127 clear_bit(BS_READABLE
, &dev
->buffer_status
);
129 if (!(obs
& BSR_BULK_OUT_FULL
)) {
130 set_bit(BS_WRITABLE
, &dev
->buffer_status
);
131 DEBUGP(4, dev
, "waking up write_wait\n");
132 wake_up_interruptible(&dev
->write_wait
);
134 clear_bit(BS_WRITABLE
, &dev
->buffer_status
);
136 if (dev
->buffer_status
)
137 wake_up_interruptible(&dev
->poll_wait
);
139 mod_timer(&dev
->poll_timer
, jiffies
+ POLL_PERIOD
);
142 static void cm4040_stop_poll(struct reader_dev
*dev
)
144 del_timer_sync(&dev
->poll_timer
);
147 static int wait_for_bulk_out_ready(struct reader_dev
*dev
)
150 int iobase
= dev
->p_dev
->io
.BasePort1
;
152 for (i
= 0; i
< POLL_LOOP_COUNT
; i
++) {
153 if ((xinb(iobase
+ REG_OFFSET_BUFFER_STATUS
)
154 & BSR_BULK_OUT_FULL
) == 0) {
155 DEBUGP(4, dev
, "BulkOut empty (i=%d)\n", i
);
160 DEBUGP(4, dev
, "wait_event_interruptible_timeout(timeout=%ld\n",
162 rc
= wait_event_interruptible_timeout(dev
->write_wait
,
163 test_and_clear_bit(BS_WRITABLE
,
164 &dev
->buffer_status
),
168 DEBUGP(4, dev
, "woke up: BulkOut empty\n");
170 DEBUGP(4, dev
, "woke up: BulkOut full, returning 0 :(\n");
172 DEBUGP(4, dev
, "woke up: signal arrived\n");
177 /* Write to Sync Control Register */
178 static int write_sync_reg(unsigned char val
, struct reader_dev
*dev
)
180 int iobase
= dev
->p_dev
->io
.BasePort1
;
183 rc
= wait_for_bulk_out_ready(dev
);
187 xoutb(val
, iobase
+ REG_OFFSET_SYNC_CONTROL
);
188 rc
= wait_for_bulk_out_ready(dev
);
195 static int wait_for_bulk_in_ready(struct reader_dev
*dev
)
198 int iobase
= dev
->p_dev
->io
.BasePort1
;
200 for (i
= 0; i
< POLL_LOOP_COUNT
; i
++) {
201 if ((xinb(iobase
+ REG_OFFSET_BUFFER_STATUS
)
202 & BSR_BULK_IN_FULL
) == BSR_BULK_IN_FULL
) {
203 DEBUGP(3, dev
, "BulkIn full (i=%d)\n", i
);
208 DEBUGP(4, dev
, "wait_event_interruptible_timeout(timeout=%ld\n",
210 rc
= wait_event_interruptible_timeout(dev
->read_wait
,
211 test_and_clear_bit(BS_READABLE
,
212 &dev
->buffer_status
),
215 DEBUGP(4, dev
, "woke up: BulkIn full\n");
217 DEBUGP(4, dev
, "woke up: BulkIn not full, returning 0 :(\n");
219 DEBUGP(4, dev
, "woke up: signal arrived\n");
224 static ssize_t
cm4040_read(struct file
*filp
, char __user
*buf
,
225 size_t count
, loff_t
*ppos
)
227 struct reader_dev
*dev
= filp
->private_data
;
228 int iobase
= dev
->p_dev
->io
.BasePort1
;
229 size_t bytes_to_read
;
231 size_t min_bytes_to_read
;
235 DEBUGP(2, dev
, "-> cm4040_read(%s,%d)\n", current
->comm
, current
->pid
);
243 if (filp
->f_flags
& O_NONBLOCK
) {
244 DEBUGP(4, dev
, "filep->f_flags O_NONBLOCK set\n");
245 DEBUGP(2, dev
, "<- cm4040_read (failure)\n");
249 if (!pcmcia_dev_present(dev
->p_dev
))
252 for (i
= 0; i
< 5; i
++) {
253 rc
= wait_for_bulk_in_ready(dev
);
255 DEBUGP(5, dev
, "wait_for_bulk_in_ready rc=%.2x\n", rc
);
256 DEBUGP(2, dev
, "<- cm4040_read (failed)\n");
257 if (rc
== -ERESTARTSYS
)
261 dev
->r_buf
[i
] = xinb(iobase
+ REG_OFFSET_BULK_IN
);
264 printk(KERN_DEBUG
"%lu:%2x ", i
, dev
->r_buf
[i
]);
271 bytes_to_read
= 5 + le32_to_cpu(*(__le32
*)&dev
->r_buf
[1]);
273 DEBUGP(6, dev
, "BytesToRead=%lu\n", bytes_to_read
);
275 min_bytes_to_read
= min(count
, bytes_to_read
+ 5);
276 min_bytes_to_read
= min_t(size_t, min_bytes_to_read
, READ_WRITE_BUFFER_SIZE
);
278 DEBUGP(6, dev
, "Min=%lu\n", min_bytes_to_read
);
280 for (i
= 0; i
< (min_bytes_to_read
-5); i
++) {
281 rc
= wait_for_bulk_in_ready(dev
);
283 DEBUGP(5, dev
, "wait_for_bulk_in_ready rc=%.2x\n", rc
);
284 DEBUGP(2, dev
, "<- cm4040_read (failed)\n");
285 if (rc
== -ERESTARTSYS
)
289 dev
->r_buf
[i
+5] = xinb(iobase
+ REG_OFFSET_BULK_IN
);
292 printk(KERN_DEBUG
"%lu:%2x ", i
, dev
->r_buf
[i
]);
299 *ppos
= min_bytes_to_read
;
300 if (copy_to_user(buf
, dev
->r_buf
, min_bytes_to_read
))
303 rc
= wait_for_bulk_in_ready(dev
);
305 DEBUGP(5, dev
, "wait_for_bulk_in_ready rc=%.2x\n", rc
);
306 DEBUGP(2, dev
, "<- cm4040_read (failed)\n");
307 if (rc
== -ERESTARTSYS
)
312 rc
= write_sync_reg(SCR_READER_TO_HOST_DONE
, dev
);
314 DEBUGP(5, dev
, "write_sync_reg c=%.2x\n", rc
);
315 DEBUGP(2, dev
, "<- cm4040_read (failed)\n");
316 if (rc
== -ERESTARTSYS
)
322 uc
= xinb(iobase
+ REG_OFFSET_BULK_IN
);
324 DEBUGP(2, dev
, "<- cm4040_read (successfully)\n");
325 return min_bytes_to_read
;
328 static ssize_t
cm4040_write(struct file
*filp
, const char __user
*buf
,
329 size_t count
, loff_t
*ppos
)
331 struct reader_dev
*dev
= filp
->private_data
;
332 int iobase
= dev
->p_dev
->io
.BasePort1
;
335 unsigned int bytes_to_write
;
337 DEBUGP(2, dev
, "-> cm4040_write(%s,%d)\n", current
->comm
, current
->pid
);
340 DEBUGP(2, dev
, "<- cm4040_write empty read (successfully)\n");
344 if ((count
< 5) || (count
> READ_WRITE_BUFFER_SIZE
)) {
345 DEBUGP(2, dev
, "<- cm4040_write buffersize=%Zd < 5\n", count
);
349 if (filp
->f_flags
& O_NONBLOCK
) {
350 DEBUGP(4, dev
, "filep->f_flags O_NONBLOCK set\n");
351 DEBUGP(4, dev
, "<- cm4040_write (failure)\n");
355 if (!pcmcia_dev_present(dev
->p_dev
))
358 bytes_to_write
= count
;
359 if (copy_from_user(dev
->s_buf
, buf
, bytes_to_write
))
362 switch (dev
->s_buf
[0]) {
363 case CMD_PC_TO_RDR_XFRBLOCK
:
364 case CMD_PC_TO_RDR_SECURE
:
365 case CMD_PC_TO_RDR_TEST_SECURE
:
366 case CMD_PC_TO_RDR_OK_SECURE
:
367 dev
->timeout
= CCID_DRIVER_BULK_DEFAULT_TIMEOUT
;
370 case CMD_PC_TO_RDR_ICCPOWERON
:
371 dev
->timeout
= CCID_DRIVER_ASYNC_POWERUP_TIMEOUT
;
374 case CMD_PC_TO_RDR_GETSLOTSTATUS
:
375 case CMD_PC_TO_RDR_ICCPOWEROFF
:
376 case CMD_PC_TO_RDR_GETPARAMETERS
:
377 case CMD_PC_TO_RDR_RESETPARAMETERS
:
378 case CMD_PC_TO_RDR_SETPARAMETERS
:
379 case CMD_PC_TO_RDR_ESCAPE
:
380 case CMD_PC_TO_RDR_ICCCLOCK
:
382 dev
->timeout
= CCID_DRIVER_MINIMUM_TIMEOUT
;
386 rc
= write_sync_reg(SCR_HOST_TO_READER_START
, dev
);
388 DEBUGP(5, dev
, "write_sync_reg c=%.2Zx\n", rc
);
389 DEBUGP(2, dev
, "<- cm4040_write (failed)\n");
390 if (rc
== -ERESTARTSYS
)
396 DEBUGP(4, dev
, "start \n");
398 for (i
= 0; i
< bytes_to_write
; i
++) {
399 rc
= wait_for_bulk_out_ready(dev
);
401 DEBUGP(5, dev
, "wait_for_bulk_out_ready rc=%.2Zx\n",
403 DEBUGP(2, dev
, "<- cm4040_write (failed)\n");
404 if (rc
== -ERESTARTSYS
)
410 xoutb(dev
->s_buf
[i
],iobase
+ REG_OFFSET_BULK_OUT
);
412 DEBUGP(4, dev
, "end\n");
414 rc
= write_sync_reg(SCR_HOST_TO_READER_DONE
, dev
);
417 DEBUGP(5, dev
, "write_sync_reg c=%.2Zx\n", rc
);
418 DEBUGP(2, dev
, "<- cm4040_write (failed)\n");
419 if (rc
== -ERESTARTSYS
)
425 DEBUGP(2, dev
, "<- cm4040_write (successfully)\n");
429 static unsigned int cm4040_poll(struct file
*filp
, poll_table
*wait
)
431 struct reader_dev
*dev
= filp
->private_data
;
432 unsigned int mask
= 0;
434 poll_wait(filp
, &dev
->poll_wait
, wait
);
436 if (test_and_clear_bit(BS_READABLE
, &dev
->buffer_status
))
437 mask
|= POLLIN
| POLLRDNORM
;
438 if (test_and_clear_bit(BS_WRITABLE
, &dev
->buffer_status
))
439 mask
|= POLLOUT
| POLLWRNORM
;
441 DEBUGP(2, dev
, "<- cm4040_poll(%u)\n", mask
);
446 static int cm4040_open(struct inode
*inode
, struct file
*filp
)
448 struct reader_dev
*dev
;
449 struct pcmcia_device
*link
;
450 int minor
= iminor(inode
);
452 if (minor
>= CM_MAX_DEV
)
455 link
= dev_table
[minor
];
456 if (link
== NULL
|| !pcmcia_dev_present(link
))
463 filp
->private_data
= dev
;
465 if (filp
->f_flags
& O_NONBLOCK
) {
466 DEBUGP(4, dev
, "filep->f_flags O_NONBLOCK set\n");
472 dev
->poll_timer
.data
= (unsigned long) dev
;
473 mod_timer(&dev
->poll_timer
, jiffies
+ POLL_PERIOD
);
475 DEBUGP(2, dev
, "<- cm4040_open (successfully)\n");
476 return nonseekable_open(inode
, filp
);
479 static int cm4040_close(struct inode
*inode
, struct file
*filp
)
481 struct reader_dev
*dev
= filp
->private_data
;
482 struct pcmcia_device
*link
;
483 int minor
= iminor(inode
);
485 DEBUGP(2, dev
, "-> cm4040_close(maj/min=%d.%d)\n", imajor(inode
),
488 if (minor
>= CM_MAX_DEV
)
491 link
= dev_table
[minor
];
495 cm4040_stop_poll(dev
);
500 DEBUGP(2, dev
, "<- cm4040_close\n");
504 static void cm4040_reader_release(struct pcmcia_device
*link
)
506 struct reader_dev
*dev
= link
->priv
;
508 DEBUGP(3, dev
, "-> cm4040_reader_release\n");
510 DEBUGP(3, dev
, KERN_INFO MODULE_NAME
": delaying release "
511 "until process has terminated\n");
512 wait_event(dev
->devq
, (link
->open
== 0));
514 DEBUGP(3, dev
, "<- cm4040_reader_release\n");
518 static int reader_config(struct pcmcia_device
*link
, int devno
)
520 struct reader_dev
*dev
;
524 int fail_fn
, fail_rc
;
527 tuple
.Attributes
= 0;
528 tuple
.TupleData
= buf
;
529 tuple
.TupleDataMax
= sizeof(buf
);
530 tuple
.TupleOffset
= 0;
532 link
->io
.BasePort2
= 0;
533 link
->io
.NumPorts2
= 0;
534 link
->io
.Attributes2
= 0;
535 tuple
.DesiredTuple
= CISTPL_CFTABLE_ENTRY
;
536 for (rc
= pcmcia_get_first_tuple(link
, &tuple
);
538 rc
= pcmcia_get_next_tuple(link
, &tuple
)) {
539 rc
= pcmcia_get_tuple_data(link
, &tuple
);
540 if (rc
!= CS_SUCCESS
)
542 rc
= pcmcia_parse_tuple(link
, &tuple
, &parse
);
543 if (rc
!= CS_SUCCESS
)
546 link
->conf
.ConfigIndex
= parse
.cftable_entry
.index
;
548 if (!parse
.cftable_entry
.io
.nwin
)
551 link
->io
.BasePort1
= parse
.cftable_entry
.io
.win
[0].base
;
552 link
->io
.NumPorts1
= parse
.cftable_entry
.io
.win
[0].len
;
553 link
->io
.Attributes1
= IO_DATA_PATH_WIDTH_AUTO
;
554 if (!(parse
.cftable_entry
.io
.flags
& CISTPL_IO_8BIT
))
555 link
->io
.Attributes1
= IO_DATA_PATH_WIDTH_16
;
556 if (!(parse
.cftable_entry
.io
.flags
& CISTPL_IO_16BIT
))
557 link
->io
.Attributes1
= IO_DATA_PATH_WIDTH_8
;
558 link
->io
.IOAddrLines
= parse
.cftable_entry
.io
.flags
559 & CISTPL_IO_LINES_MASK
;
560 rc
= pcmcia_request_io(link
, &link
->io
);
562 dev_printk(KERN_INFO
, &handle_to_dev(link
), "foo");
563 if (rc
== CS_SUCCESS
)
566 dev_printk(KERN_INFO
, &handle_to_dev(link
),
567 "pcmcia_request_io failed 0x%x\n", rc
);
569 if (rc
!= CS_SUCCESS
)
572 link
->conf
.IntType
= 00000002;
574 if ((fail_rc
= pcmcia_request_configuration(link
,&link
->conf
))
576 fail_fn
= RequestConfiguration
;
577 dev_printk(KERN_INFO
, &handle_to_dev(link
),
578 "pcmcia_request_configuration failed 0x%x\n",
584 sprintf(dev
->node
.dev_name
, DEVICE_NAME
"%d", devno
);
585 dev
->node
.major
= major
;
586 dev
->node
.minor
= devno
;
587 dev
->node
.next
= &dev
->node
;
589 DEBUGP(2, dev
, "device " DEVICE_NAME
"%d at 0x%.4x-0x%.4x\n", devno
,
590 link
->io
.BasePort1
, link
->io
.BasePort1
+link
->io
.NumPorts1
);
591 DEBUGP(2, dev
, "<- reader_config (succ)\n");
596 reader_release(link
);
600 static void reader_release(struct pcmcia_device
*link
)
602 cm4040_reader_release(link
);
603 pcmcia_disable_device(link
);
606 static int reader_probe(struct pcmcia_device
*link
)
608 struct reader_dev
*dev
;
611 for (i
= 0; i
< CM_MAX_DEV
; i
++) {
612 if (dev_table
[i
] == NULL
)
619 dev
= kzalloc(sizeof(struct reader_dev
), GFP_KERNEL
);
623 dev
->timeout
= CCID_DRIVER_MINIMUM_TIMEOUT
;
624 dev
->buffer_status
= 0;
629 link
->conf
.IntType
= INT_MEMORY_AND_IO
;
632 init_waitqueue_head(&dev
->devq
);
633 init_waitqueue_head(&dev
->poll_wait
);
634 init_waitqueue_head(&dev
->read_wait
);
635 init_waitqueue_head(&dev
->write_wait
);
636 setup_timer(&dev
->poll_timer
, cm4040_do_poll
, 0);
638 ret
= reader_config(link
, i
);
645 device_create(cmx_class
, NULL
, MKDEV(major
, i
), "cmx%d", i
);
650 static void reader_detach(struct pcmcia_device
*link
)
652 struct reader_dev
*dev
= link
->priv
;
656 for (devno
= 0; devno
< CM_MAX_DEV
; devno
++) {
657 if (dev_table
[devno
] == link
)
660 if (devno
== CM_MAX_DEV
)
663 reader_release(link
);
665 dev_table
[devno
] = NULL
;
668 device_destroy(cmx_class
, MKDEV(major
, devno
));
673 static const struct file_operations reader_fops
= {
674 .owner
= THIS_MODULE
,
676 .write
= cm4040_write
,
678 .release
= cm4040_close
,
682 static struct pcmcia_device_id cm4040_ids
[] = {
683 PCMCIA_DEVICE_MANF_CARD(0x0223, 0x0200),
684 PCMCIA_DEVICE_PROD_ID12("OMNIKEY", "CardMan 4040",
685 0xE32CDD8C, 0x8F23318B),
688 MODULE_DEVICE_TABLE(pcmcia
, cm4040_ids
);
690 static struct pcmcia_driver reader_driver
= {
691 .owner
= THIS_MODULE
,
695 .probe
= reader_probe
,
696 .remove
= reader_detach
,
697 .id_table
= cm4040_ids
,
700 static int __init
cm4040_init(void)
704 printk(KERN_INFO
"%s\n", version
);
705 cmx_class
= class_create(THIS_MODULE
, "cardman_4040");
706 if (IS_ERR(cmx_class
))
707 return PTR_ERR(cmx_class
);
709 major
= register_chrdev(0, DEVICE_NAME
, &reader_fops
);
711 printk(KERN_WARNING MODULE_NAME
712 ": could not get major number\n");
713 class_destroy(cmx_class
);
717 rc
= pcmcia_register_driver(&reader_driver
);
719 unregister_chrdev(major
, DEVICE_NAME
);
720 class_destroy(cmx_class
);
727 static void __exit
cm4040_exit(void)
729 printk(KERN_INFO MODULE_NAME
": unloading\n");
730 pcmcia_unregister_driver(&reader_driver
);
731 unregister_chrdev(major
, DEVICE_NAME
);
732 class_destroy(cmx_class
);
735 module_init(cm4040_init
);
736 module_exit(cm4040_exit
);
737 MODULE_LICENSE("Dual BSD/GPL");