2 * Copyright (c) 2006-2007 Daniel Roethlisberger <daniel@roe.ch>
3 * Copyright (c) 2000-2004 OMNIKEY GmbH (www.omnikey.com)
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice unmodified, this list of conditions, and the following
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * $FreeBSD: src/sys/dev/cmx/cmx.c,v 1.1 2008/03/06 08:09:45 rink Exp $
29 * $DragonFly: src/sys/dev/misc/cmx/cmx.c,v 1.2 2008/08/08 18:33:11 hasso Exp $
33 * OMNIKEY CardMan 4040 a.k.a. CardMan eXtended (cmx) driver.
34 * This is a PCMCIA based smartcard reader which seems to work
35 * like an I/O port mapped USB CCID smartcard device.
37 * I/O originally based on Linux driver version 1.1.0 by OMNIKEY.
38 * Dual GPL/BSD. Almost all of the code has been rewritten.
39 * $Omnikey: cm4040_cs.c,v 1.7 2004/10/04 09:08:50 jp Exp $
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/kernel.h>
45 #include <sys/sockio.h>
47 #include <sys/event.h>
49 #include <sys/fcntl.h>
51 #include <sys/selinfo.h>
52 #include <sys/types.h>
54 #include <sys/device.h>
55 #include <sys/thread2.h>
57 #include <sys/module.h>
59 #include <sys/resource.h>
66 #define DEBUG_printf(dev, fmt, args...) \
67 device_printf(dev, "%s: " fmt, __FUNCTION__, ##args)
69 #define DEBUG_printf(dev, fmt, args...)
72 #define SPIN_COUNT 1000
73 #define WAIT_TICKS (hz/100)
74 #define POLL_TICKS (hz/10)
77 #define CCID_DRIVER_BULK_DEFAULT_TIMEOUT (150*hz)
78 #define CCID_DRIVER_ASYNC_POWERUP_TIMEOUT (35*hz)
79 #define CCID_DRIVER_MINIMUM_TIMEOUT (3*hz)
82 static char BSRBITS[] = "\020"
83 "\01BULK_OUT_FULL" /* 0x01 */
84 "\02BULK_IN_FULL" /* 0x02 */
85 "\03(0x04)"; /* 0x04 */
87 static char SCRBITS[] = "\020"
88 "\01POWER_DOWN" /* 0x01 */
89 "\02PULSE_INTERRUPT" /* 0x02 */
90 "\03HOST_TO_READER_DONE" /* 0x04 */
91 "\04READER_TO_HOST_DONE" /* 0x08 */
92 "\05ACK_NOTIFY" /* 0x10 */
93 "\06EN_NOTIFY" /* 0x20 */
95 "\10HOST_TO_READER_START"; /* 0x80 */
97 static char POLLBITS[] = "\020"
98 "\01POLLIN" /* 0x0001 */
99 "\02POLLPRI" /* 0x0002 */
100 "\03POLLOUT" /* 0x0004 */
101 "\04POLLERR" /* 0x0008 */
102 "\05POLLHUP" /* 0x0010 */
103 "\06POLLINVAL" /* 0x0020 */
104 "\07POLLRDNORM" /* 0x0040 */
105 "\10POLLRDBAND" /* 0x0080 */
106 "\11POLLWRBAND"; /* 0x0100 */
107 static char MODEBITS[] = "\020"
108 "\01READ" /* 0x0001 */
109 "\02WRITE" /* 0x0002 */
110 "\03NONBLOCK" /* 0x0004 */
111 "\04APPEND" /* 0x0008 */
112 "\05SHLOCK" /* 0x0010 */
113 "\06EXLOCK" /* 0x0020 */
114 "\07ASYNC" /* 0x0040 */
115 "\10FSYNC" /* 0x0080 */
116 "\11NOFOLLOW" /* 0x0100 */
117 "\12CREAT" /* 0x0200 */
118 "\13TRUNK" /* 0x0400 */
119 "\14EXCL" /* 0x0800 */
120 "\15(0x1000)" /* 0x1000 */
121 "\16(0x2000)" /* 0x2000 */
122 "\17HASLOCK" /* 0x4000 */
123 "\20NOCTTY" /* 0x8000 */
124 "\21DIRECT"; /* 0x00010000 */
125 #endif /* CMX_DEBUG */
127 devclass_t cmx_devclass;
129 static d_open_t cmx_open;
130 static d_close_t cmx_close;
131 static d_read_t cmx_read;
132 static d_write_t cmx_write;
133 static d_kqfilter_t cmx_kqfilter;
135 static void cmx_intr(void *arg);
138 static void cmx_filter_detach(struct knote *);
139 static int cmx_filter_read(struct knote *, long);
140 static int cmx_filter_write(struct knote *, long);
142 #define CDEV_MAJOR 185
143 static struct dev_ops cmx_ops = {
144 { "cmx", CDEV_MAJOR, D_KQFILTER },
146 .d_close = cmx_close,
148 .d_write = cmx_write,
149 .d_kqfilter = cmx_kqfilter
153 * Initialize the softc structure. Must be called from
154 * the bus specific device allocation routine.
157 cmx_init_softc(device_t dev)
159 struct cmx_softc *sc = device_get_softc(dev);
161 sc->timeout = CCID_DRIVER_MINIMUM_TIMEOUT;
165 * Allocate driver resources. Must be called from the
166 * bus specific device allocation routine. Caller must
167 * ensure to call cmx_release_resources to free the
168 * resources when detaching.
169 * Return zero if successful, and ENOMEM if the resources
170 * could not be allocated.
173 cmx_alloc_resources(device_t dev)
175 struct cmx_softc *sc = device_get_softc(dev);
180 sc->ioport = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
181 &sc->ioport_rid, RF_ACTIVE);
183 device_printf(dev, "failed to allocate io port\n");
186 sc->bst = rman_get_bustag(sc->ioport);
187 sc->bsh = rman_get_bushandle(sc->ioport);
190 sc->irq = bus_alloc_resource_any(dev, SYS_RES_IRQ,
191 &sc->irq_rid, RF_ACTIVE);
193 device_printf(dev, "failed to allocate irq\n");
196 if ((rv = bus_setup_intr(dev, sc->irq, 0, cmx_intr, sc,
197 &sc->ih, NULL)) != 0) {
198 device_printf(dev, "failed to set up irq\n");
203 lockinit(&sc->mtx, "cmx softc lock", 0, LK_CANRECURSE);
204 callout_init(&sc->ch);
210 * Release the resources allocated by cmx_allocate_resources.
213 cmx_release_resources(device_t dev)
215 struct cmx_softc *sc = device_get_softc(dev);
217 lockuninit(&sc->mtx);
221 bus_teardown_intr(dev, sc->irq, sc->ih);
225 bus_release_resource(dev, SYS_RES_IRQ,
226 sc->irq_rid, sc->irq);
232 bus_deactivate_resource(dev, SYS_RES_IOPORT,
233 sc->ioport_rid, sc->ioport);
234 bus_release_resource(dev, SYS_RES_IOPORT,
235 sc->ioport_rid, sc->ioport);
242 * Bus independant device attachment routine. Creates the
243 * character device node.
246 cmx_attach(device_t dev)
248 struct cmx_softc *sc = device_get_softc(dev);
250 if (!sc || sc->dying)
253 sc->cdev = make_dev(&cmx_ops, 0, UID_ROOT, GID_WHEEL, 0600,
254 "cmx%d", device_get_unit(dev));
256 device_printf(dev, "failed to create character device\n");
259 sc->cdev->si_drv1 = sc;
265 * Bus independant device detachment routine. Makes sure all
266 * allocated resources are freed, callouts disabled and waiting
267 * processes unblocked.
270 cmx_detach(device_t dev)
272 struct cmx_softc *sc = device_get_softc(dev);
274 DEBUG_printf(dev, "called\n");
280 DEBUG_printf(sc->dev, "disabling polling\n");
281 callout_stop(&sc->ch);
285 KNOTE(&sc->sel.si_note, 0);
291 DEBUG_printf(dev, "releasing resources\n");
292 cmx_release_resources(dev);
293 dev_ops_remove_minor(&cmx_ops, device_get_unit(dev));
299 * Wait for buffer status register events. If test is non-zero,
300 * wait until flags are set, otherwise wait until flags are unset.
301 * Will spin SPIN_COUNT times, then sleep until timeout is reached.
302 * Returns zero if event happened, EIO if the timeout was reached,
303 * and ENXIO if the device was detached in the meantime. When that
304 * happens, the caller must quit immediately, since a detach is
308 cmx_wait_BSR(struct cmx_softc *sc, uint8_t flags, int test)
312 for (int i = 0; i < SPIN_COUNT; i++) {
313 if (cmx_test_BSR(sc, flags, test))
317 for (int i = 0; i * WAIT_TICKS < sc->timeout; i++) {
318 if (cmx_test_BSR(sc, flags, test))
320 rv = tsleep(sc, PCATCH, "cmx", WAIT_TICKS);
322 * Currently, the only reason for waking up with
323 * rv == 0 is when we are detaching, in which
324 * case sc->dying is always 1.
337 * Set the sync control register to val. Before and after writing
338 * to the SCR, we wait for the BSR to not signal BULK_OUT_FULL.
339 * Returns zero if successful, or whatever errors cmx_wait_BSR can
340 * return. ENXIO signals that the device has been detached in the
341 * meantime, and that we should leave the kernel immediately.
344 cmx_sync_write_SCR(struct cmx_softc *sc, uint8_t val)
348 if ((rv = cmx_wait_BSR(sc, BSR_BULK_OUT_FULL, 0)) != 0) {
352 cmx_write_SCR(sc, val);
354 if ((rv = cmx_wait_BSR(sc, BSR_BULK_OUT_FULL, 0)) != 0) {
362 * Returns a suitable timeout value based on the given command byte.
363 * Some commands appear to need longer timeout values than others.
365 static inline unsigned long
366 cmx_timeout_by_cmd(uint8_t cmd)
369 case CMD_PC_TO_RDR_XFRBLOCK:
370 case CMD_PC_TO_RDR_SECURE:
371 case CMD_PC_TO_RDR_TEST_SECURE:
372 case CMD_PC_TO_RDR_OK_SECURE:
373 return CCID_DRIVER_BULK_DEFAULT_TIMEOUT;
375 case CMD_PC_TO_RDR_ICCPOWERON:
376 return CCID_DRIVER_ASYNC_POWERUP_TIMEOUT;
378 case CMD_PC_TO_RDR_GETSLOTSTATUS:
379 case CMD_PC_TO_RDR_ICCPOWEROFF:
380 case CMD_PC_TO_RDR_GETPARAMETERS:
381 case CMD_PC_TO_RDR_RESETPARAMETERS:
382 case CMD_PC_TO_RDR_SETPARAMETERS:
383 case CMD_PC_TO_RDR_ESCAPE:
384 case CMD_PC_TO_RDR_ICCCLOCK:
386 return CCID_DRIVER_MINIMUM_TIMEOUT;
391 * Periodical callout routine, polling the reader for data
392 * availability. If the reader signals data ready for reading,
393 * wakes up the processes which are waiting in select()/poll().
394 * Otherwise, reschedules itself with a delay of POLL_TICKS.
399 struct cmx_softc *sc = xsc;
403 if (sc->polling && !sc->dying) {
404 bsr = cmx_read_BSR(sc);
405 DEBUG_printf(sc->dev, "BSR=%b\n", bsr, BSRBITS);
406 if (cmx_test(bsr, BSR_BULK_IN_FULL, 1)) {
409 KNOTE(&sc->sel.si_note, 0);
411 callout_reset(&sc->ch, POLL_TICKS, cmx_tick, sc);
418 * Open the character device. Only a single process may open the
422 cmx_open(struct dev_open_args *ap)
424 cdev_t dev = ap->a_head.a_dev;
425 struct cmx_softc *sc;
427 sc = devclass_get_softc(cmx_devclass, minor(dev));
428 if (sc == NULL || sc->dying)
439 DEBUG_printf(sc->dev, "open (flags=%b thread=%p)\n",
440 ap->a_oflags, MODEBITS, curthread);
445 * Close the character device.
448 cmx_close(struct dev_close_args *ap)
450 cdev_t dev = ap->a_head.a_dev;
451 struct cmx_softc *sc;
453 sc = devclass_get_softc(cmx_devclass, minor(dev));
454 if (sc == NULL || sc->dying)
463 DEBUG_printf(sc->dev, "disabling polling\n");
464 callout_stop(&sc->ch);
468 KNOTE(&sc->sel.si_note, 0);
474 DEBUG_printf(sc->dev, "close (flags=%b thread=%p)\n",
475 ap->a_fflag, MODEBITS, curthread);
480 * Read from the character device.
481 * Returns zero if successful, ENXIO if dying, EINVAL if an attempt
482 * was made to read less than CMX_MIN_RDLEN bytes or less than the
483 * device has available, or any of the errors that cmx_sync_write_SCR
484 * can return. Partial reads are not supported.
487 cmx_read(struct dev_read_args *ap)
489 cdev_t dev = ap->a_head.a_dev;
490 struct cmx_softc *sc;
491 struct uio *uio = ap->a_uio;
492 unsigned long bytes_left;
494 int rv, amnt, offset;
496 sc = devclass_get_softc(cmx_devclass, minor(dev));
497 if (sc == NULL || sc->dying)
500 DEBUG_printf(sc->dev, "called (len=%d flag=%b)\n",
501 uio->uio_resid, ap->a_ioflag, MODEBITS);
505 DEBUG_printf(sc->dev, "disabling polling\n");
506 callout_stop(&sc->ch);
510 KNOTE(&sc->sel.si_note, 0);
515 if (uio->uio_resid == 0) {
519 if (uio->uio_resid < CMX_MIN_RDLEN) {
523 if (ap->a_ioflag & O_NONBLOCK) {
524 if (cmx_test_BSR(sc, BSR_BULK_IN_FULL, 0)) {
529 for (int i = 0; i < 5; i++) {
530 if ((rv = cmx_wait_BSR(sc, BSR_BULK_IN_FULL, 1)) != 0) {
533 sc->buf[i] = cmx_read_DTR(sc);
534 DEBUG_printf(sc->dev, "buf[%02x]=%02x\n", i, sc->buf[i]);
537 bytes_left = CMX_MIN_RDLEN +
538 (0x000000FF&((char)sc->buf[1])) +
539 (0x0000FF00&((char)sc->buf[2] << 8)) +
540 (0x00FF0000&((char)sc->buf[3] << 16)) +
541 (0xFF000000&((char)sc->buf[4] << 24));
542 DEBUG_printf(sc->dev, "msgsz=%lu\n", bytes_left);
544 if (uio->uio_resid < bytes_left) {
548 offset = 5; /* prefetched header */
549 while (bytes_left > 0) {
550 amnt = MIN(bytes_left, sizeof(sc->buf));
552 for (int i = offset; i < amnt; i++) {
553 if ((rv = cmx_wait_BSR(sc, BSR_BULK_IN_FULL, 1))!=0) {
556 sc->buf[i] = cmx_read_DTR(sc);
557 DEBUG_printf(sc->dev, "buf[%02x]=%02x\n",
561 if ((rv = uiomove(sc->buf, amnt, uio)) != 0) {
562 DEBUG_printf(sc->dev, "uiomove failed (%d)\n", rv);
571 if ((rv = cmx_wait_BSR(sc, BSR_BULK_IN_FULL, 1)) != 0) {
575 if ((rv = cmx_sync_write_SCR(sc, SCR_READER_TO_HOST_DONE)) != 0) {
579 uc = cmx_read_DTR(sc);
580 DEBUG_printf(sc->dev, "success (DTR=%02x)\n", uc);
585 * Write to the character device.
586 * Returns zero if successful, NXIO if dying, EINVAL if less data
587 * written than CMX_MIN_WRLEN, or any of the errors that cmx_sync_SCR
591 cmx_write(struct dev_write_args *ap)
593 cdev_t dev = ap->a_head.a_dev;
594 struct cmx_softc *sc;
595 struct uio *uio = ap->a_uio;
598 sc = devclass_get_softc(cmx_devclass, minor(dev));
599 if (sc == NULL || sc->dying)
602 DEBUG_printf(sc->dev, "called (len=%d flag=%b)\n",
603 uio->uio_resid, ap->a_ioflag, MODEBITS);
605 if (uio->uio_resid == 0) {
609 if (uio->uio_resid < CMX_MIN_WRLEN) {
613 if ((rv = cmx_sync_write_SCR(sc, SCR_HOST_TO_READER_START)) != 0) {
618 while (uio->uio_resid > 0) {
619 amnt = MIN(uio->uio_resid, sizeof(sc->buf));
621 if ((rv = uiomove(sc->buf, amnt, uio)) != 0) {
622 DEBUG_printf(sc->dev, "uiomove failed (%d)\n", rv);
623 /* wildly guessed attempt to notify device */
624 sc->timeout = CCID_DRIVER_MINIMUM_TIMEOUT;
625 cmx_sync_write_SCR(sc, SCR_HOST_TO_READER_DONE);
629 if (sc->timeout == 0) {
630 sc->timeout = cmx_timeout_by_cmd(sc->buf[0]);
631 DEBUG_printf(sc->dev, "cmd=%02x timeout=%lu\n",
632 sc->buf[0], sc->timeout);
635 for (int i = 0; i < amnt; i++) {
636 if ((rv = cmx_wait_BSR(sc, BSR_BULK_OUT_FULL, 0))!=0) {
639 cmx_write_DTR(sc, sc->buf[i]);
640 DEBUG_printf(sc->dev, "buf[%02x]=%02x\n",
645 if ((rv = cmx_sync_write_SCR(sc, SCR_HOST_TO_READER_DONE)) != 0) {
649 DEBUG_printf(sc->dev, "success\n");
653 static struct filterops cmx_read_filterops =
654 { 1, NULL, cmx_filter_detach, cmx_filter_read };
655 static struct filterops cmx_write_filterops =
656 { 1, NULL, cmx_filter_detach, cmx_filter_write };
659 * Kevent handler. Writing is always possible, reading is only possible
660 * if BSR_BULK_IN_FULL is set. Will start the cmx_tick callout and
664 cmx_kqfilter(struct dev_kqfilter_args *ap)
666 cdev_t dev = ap->a_head.a_dev;
667 struct knote *kn = ap->a_kn;
668 struct cmx_softc *sc;
673 sc = devclass_get_softc(cmx_devclass, minor(dev));
675 switch (kn->kn_filter) {
677 kn->kn_fop = &cmx_read_filterops;
678 kn->kn_hook = (caddr_t)sc;
681 kn->kn_fop = &cmx_write_filterops;
682 kn->kn_hook = (caddr_t)sc;
685 ap->a_result = EOPNOTSUPP;
690 klist = &sc->sel.si_note;
691 SLIST_INSERT_HEAD(klist, kn, kn_selnext);
698 cmx_filter_detach(struct knote *kn)
700 struct cmx_softc *sc = (struct cmx_softc *)kn->kn_hook;
704 klist = &sc->sel.si_note;
705 SLIST_REMOVE(klist, kn, knote, kn_selnext);
710 cmx_filter_read(struct knote *kn, long hint)
712 struct cmx_softc *sc = (struct cmx_softc *)kn->kn_hook;
716 if (sc == NULL || sc->dying) {
717 kn->kn_flags |= EV_EOF;
721 bsr = cmx_read_BSR(sc);
722 if (cmx_test(bsr, BSR_BULK_IN_FULL, 1)) {
728 callout_reset(&sc->ch, POLL_TICKS,
738 cmx_filter_write(struct knote *kn, long hint)
745 * Interrupt handler. Currently has no function except to
746 * print register status (if debugging is also enabled).
751 struct cmx_softc *sc = (struct cmx_softc *)arg;
753 if (sc == NULL || sc->dying)
756 DEBUG_printf(sc->dev, "received interrupt (SCR=%b BSR=%b)\n",
757 cmx_read_SCR(sc), SCRBITS,
758 cmx_read_BSR(sc), BSRBITS);