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>
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_poll_t cmx_poll;
135 static void cmx_intr(void *arg);
138 #define CDEV_MAJOR 185
139 static struct dev_ops cmx_ops = {
140 { "cmx", CDEV_MAJOR, 0 },
142 .d_close = cmx_close,
144 .d_write = cmx_write,
149 * Initialize the softc structure. Must be called from
150 * the bus specific device allocation routine.
153 cmx_init_softc(device_t dev)
155 struct cmx_softc *sc = device_get_softc(dev);
157 sc->timeout = CCID_DRIVER_MINIMUM_TIMEOUT;
161 * Allocate driver resources. Must be called from the
162 * bus specific device allocation routine. Caller must
163 * ensure to call cmx_release_resources to free the
164 * resources when detaching.
165 * Return zero if successful, and ENOMEM if the resources
166 * could not be allocated.
169 cmx_alloc_resources(device_t dev)
171 struct cmx_softc *sc = device_get_softc(dev);
176 sc->ioport = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
177 &sc->ioport_rid, RF_ACTIVE);
179 device_printf(dev, "failed to allocate io port\n");
182 sc->bst = rman_get_bustag(sc->ioport);
183 sc->bsh = rman_get_bushandle(sc->ioport);
186 sc->irq = bus_alloc_resource_any(dev, SYS_RES_IRQ,
187 &sc->irq_rid, RF_ACTIVE);
189 device_printf(dev, "failed to allocate irq\n");
192 if ((rv = bus_setup_intr(dev, sc->irq, 0, cmx_intr, sc,
193 &sc->ih, NULL)) != 0) {
194 device_printf(dev, "failed to set up irq\n");
199 lockinit(&sc->mtx, "cmx softc lock", 0, LK_CANRECURSE);
200 callout_init(&sc->ch);
206 * Release the resources allocated by cmx_allocate_resources.
209 cmx_release_resources(device_t dev)
211 struct cmx_softc *sc = device_get_softc(dev);
213 lockuninit(&sc->mtx);
217 bus_teardown_intr(dev, sc->irq, sc->ih);
221 bus_release_resource(dev, SYS_RES_IRQ,
222 sc->irq_rid, sc->irq);
228 bus_deactivate_resource(dev, SYS_RES_IOPORT,
229 sc->ioport_rid, sc->ioport);
230 bus_release_resource(dev, SYS_RES_IOPORT,
231 sc->ioport_rid, sc->ioport);
238 * Bus independant device attachment routine. Creates the
239 * character device node.
242 cmx_attach(device_t dev)
244 struct cmx_softc *sc = device_get_softc(dev);
246 if (!sc || sc->dying)
249 sc->cdev = make_dev(&cmx_ops, 0, UID_ROOT, GID_WHEEL, 0600,
250 "cmx%d", device_get_unit(dev));
252 device_printf(dev, "failed to create character device\n");
255 sc->cdev->si_drv1 = sc;
261 * Bus independant device detachment routine. Makes sure all
262 * allocated resources are freed, callouts disabled and waiting
263 * processes unblocked.
266 cmx_detach(device_t dev)
268 struct cmx_softc *sc = device_get_softc(dev);
270 DEBUG_printf(dev, "called\n");
276 DEBUG_printf(sc->dev, "disabling polling\n");
277 callout_stop(&sc->ch);
286 DEBUG_printf(dev, "releasing resources\n");
287 cmx_release_resources(dev);
288 dev_ops_remove_minor(&cmx_ops, device_get_unit(dev));
294 * Wait for buffer status register events. If test is non-zero,
295 * wait until flags are set, otherwise wait until flags are unset.
296 * Will spin SPIN_COUNT times, then sleep until timeout is reached.
297 * Returns zero if event happened, EIO if the timeout was reached,
298 * and ENXIO if the device was detached in the meantime. When that
299 * happens, the caller must quit immediately, since a detach is
303 cmx_wait_BSR(struct cmx_softc *sc, uint8_t flags, int test)
307 for (int i = 0; i < SPIN_COUNT; i++) {
308 if (cmx_test_BSR(sc, flags, test))
312 for (int i = 0; i * WAIT_TICKS < sc->timeout; i++) {
313 if (cmx_test_BSR(sc, flags, test))
315 rv = tsleep(sc, PCATCH, "cmx", WAIT_TICKS);
317 * Currently, the only reason for waking up with
318 * rv == 0 is when we are detaching, in which
319 * case sc->dying is always 1.
332 * Set the sync control register to val. Before and after writing
333 * to the SCR, we wait for the BSR to not signal BULK_OUT_FULL.
334 * Returns zero if successful, or whatever errors cmx_wait_BSR can
335 * return. ENXIO signals that the device has been detached in the
336 * meantime, and that we should leave the kernel immediately.
339 cmx_sync_write_SCR(struct cmx_softc *sc, uint8_t val)
343 if ((rv = cmx_wait_BSR(sc, BSR_BULK_OUT_FULL, 0)) != 0) {
347 cmx_write_SCR(sc, val);
349 if ((rv = cmx_wait_BSR(sc, BSR_BULK_OUT_FULL, 0)) != 0) {
357 * Returns a suitable timeout value based on the given command byte.
358 * Some commands appear to need longer timeout values than others.
360 static inline unsigned long
361 cmx_timeout_by_cmd(uint8_t cmd)
364 case CMD_PC_TO_RDR_XFRBLOCK:
365 case CMD_PC_TO_RDR_SECURE:
366 case CMD_PC_TO_RDR_TEST_SECURE:
367 case CMD_PC_TO_RDR_OK_SECURE:
368 return CCID_DRIVER_BULK_DEFAULT_TIMEOUT;
370 case CMD_PC_TO_RDR_ICCPOWERON:
371 return CCID_DRIVER_ASYNC_POWERUP_TIMEOUT;
373 case CMD_PC_TO_RDR_GETSLOTSTATUS:
374 case CMD_PC_TO_RDR_ICCPOWEROFF:
375 case CMD_PC_TO_RDR_GETPARAMETERS:
376 case CMD_PC_TO_RDR_RESETPARAMETERS:
377 case CMD_PC_TO_RDR_SETPARAMETERS:
378 case CMD_PC_TO_RDR_ESCAPE:
379 case CMD_PC_TO_RDR_ICCCLOCK:
381 return CCID_DRIVER_MINIMUM_TIMEOUT;
386 * Periodical callout routine, polling the reader for data
387 * availability. If the reader signals data ready for reading,
388 * wakes up the processes which are waiting in select()/poll().
389 * Otherwise, reschedules itself with a delay of POLL_TICKS.
394 struct cmx_softc *sc = xsc;
398 if (sc->polling && !sc->dying) {
399 bsr = cmx_read_BSR(sc);
400 DEBUG_printf(sc->dev, "BSR=%b\n", bsr, BSRBITS);
401 if (cmx_test(bsr, BSR_BULK_IN_FULL, 1)) {
405 callout_reset(&sc->ch, POLL_TICKS, cmx_tick, sc);
412 * Open the character device. Only a single process may open the
416 cmx_open(struct dev_open_args *ap)
418 cdev_t dev = ap->a_head.a_dev;
419 struct cmx_softc *sc;
421 sc = devclass_get_softc(cmx_devclass, minor(dev));
422 if (sc == NULL || sc->dying)
433 DEBUG_printf(sc->dev, "open (flags=%b thread=%p)\n",
434 ap->a_oflags, MODEBITS, curthread);
439 * Close the character device.
442 cmx_close(struct dev_close_args *ap)
444 cdev_t dev = ap->a_head.a_dev;
445 struct cmx_softc *sc;
447 sc = devclass_get_softc(cmx_devclass, minor(dev));
448 if (sc == NULL || sc->dying)
457 DEBUG_printf(sc->dev, "disabling polling\n");
458 callout_stop(&sc->ch);
467 DEBUG_printf(sc->dev, "close (flags=%b thread=%p)\n",
468 ap->a_fflag, MODEBITS, curthread);
473 * Read from the character device.
474 * Returns zero if successful, ENXIO if dying, EINVAL if an attempt
475 * was made to read less than CMX_MIN_RDLEN bytes or less than the
476 * device has available, or any of the errors that cmx_sync_write_SCR
477 * can return. Partial reads are not supported.
480 cmx_read(struct dev_read_args *ap)
482 cdev_t dev = ap->a_head.a_dev;
483 struct cmx_softc *sc;
484 struct uio *uio = ap->a_uio;
485 unsigned long bytes_left;
487 int rv, amnt, offset;
489 sc = devclass_get_softc(cmx_devclass, minor(dev));
490 if (sc == NULL || sc->dying)
493 DEBUG_printf(sc->dev, "called (len=%d flag=%b)\n",
494 uio->uio_resid, ap->a_ioflag, MODEBITS);
498 DEBUG_printf(sc->dev, "disabling polling\n");
499 callout_stop(&sc->ch);
507 if (uio->uio_resid == 0) {
511 if (uio->uio_resid < CMX_MIN_RDLEN) {
515 if (ap->a_ioflag & O_NONBLOCK) {
516 if (cmx_test_BSR(sc, BSR_BULK_IN_FULL, 0)) {
521 for (int i = 0; i < 5; i++) {
522 if ((rv = cmx_wait_BSR(sc, BSR_BULK_IN_FULL, 1)) != 0) {
525 sc->buf[i] = cmx_read_DTR(sc);
526 DEBUG_printf(sc->dev, "buf[%02x]=%02x\n", i, sc->buf[i]);
529 bytes_left = CMX_MIN_RDLEN +
530 (0x000000FF&((char)sc->buf[1])) +
531 (0x0000FF00&((char)sc->buf[2] << 8)) +
532 (0x00FF0000&((char)sc->buf[3] << 16)) +
533 (0xFF000000&((char)sc->buf[4] << 24));
534 DEBUG_printf(sc->dev, "msgsz=%lu\n", bytes_left);
536 if (uio->uio_resid < bytes_left) {
540 offset = 5; /* prefetched header */
541 while (bytes_left > 0) {
542 amnt = MIN(bytes_left, sizeof(sc->buf));
544 for (int i = offset; i < amnt; i++) {
545 if ((rv = cmx_wait_BSR(sc, BSR_BULK_IN_FULL, 1))!=0) {
548 sc->buf[i] = cmx_read_DTR(sc);
549 DEBUG_printf(sc->dev, "buf[%02x]=%02x\n",
553 if ((rv = uiomove(sc->buf, amnt, uio)) != 0) {
554 DEBUG_printf(sc->dev, "uiomove failed (%d)\n", rv);
563 if ((rv = cmx_wait_BSR(sc, BSR_BULK_IN_FULL, 1)) != 0) {
567 if ((rv = cmx_sync_write_SCR(sc, SCR_READER_TO_HOST_DONE)) != 0) {
571 uc = cmx_read_DTR(sc);
572 DEBUG_printf(sc->dev, "success (DTR=%02x)\n", uc);
577 * Write to the character device.
578 * Returns zero if successful, NXIO if dying, EINVAL if less data
579 * written than CMX_MIN_WRLEN, or any of the errors that cmx_sync_SCR
583 cmx_write(struct dev_write_args *ap)
585 cdev_t dev = ap->a_head.a_dev;
586 struct cmx_softc *sc;
587 struct uio *uio = ap->a_uio;
590 sc = devclass_get_softc(cmx_devclass, minor(dev));
591 if (sc == NULL || sc->dying)
594 DEBUG_printf(sc->dev, "called (len=%d flag=%b)\n",
595 uio->uio_resid, ap->a_ioflag, MODEBITS);
597 if (uio->uio_resid == 0) {
601 if (uio->uio_resid < CMX_MIN_WRLEN) {
605 if ((rv = cmx_sync_write_SCR(sc, SCR_HOST_TO_READER_START)) != 0) {
610 while (uio->uio_resid > 0) {
611 amnt = MIN(uio->uio_resid, sizeof(sc->buf));
613 if ((rv = uiomove(sc->buf, amnt, uio)) != 0) {
614 DEBUG_printf(sc->dev, "uiomove failed (%d)\n", rv);
615 /* wildly guessed attempt to notify device */
616 sc->timeout = CCID_DRIVER_MINIMUM_TIMEOUT;
617 cmx_sync_write_SCR(sc, SCR_HOST_TO_READER_DONE);
621 if (sc->timeout == 0) {
622 sc->timeout = cmx_timeout_by_cmd(sc->buf[0]);
623 DEBUG_printf(sc->dev, "cmd=%02x timeout=%lu\n",
624 sc->buf[0], sc->timeout);
627 for (int i = 0; i < amnt; i++) {
628 if ((rv = cmx_wait_BSR(sc, BSR_BULK_OUT_FULL, 0))!=0) {
631 cmx_write_DTR(sc, sc->buf[i]);
632 DEBUG_printf(sc->dev, "buf[%02x]=%02x\n",
637 if ((rv = cmx_sync_write_SCR(sc, SCR_HOST_TO_READER_DONE)) != 0) {
641 DEBUG_printf(sc->dev, "success\n");
646 * Poll handler. Writing is always possible, reading is only possible
647 * if BSR_BULK_IN_FULL is set. Will start the cmx_tick callout and
651 cmx_poll(struct dev_poll_args *ap)
653 cdev_t dev = ap->a_head.a_dev;
654 struct cmx_softc *sc;
658 sc = devclass_get_softc(cmx_devclass, minor(dev));
659 if (sc == NULL || sc->dying)
662 bsr = cmx_read_BSR(sc);
663 DEBUG_printf(sc->dev, "called (events=%b BSR=%b)\n",
664 ap->a_events, POLLBITS, bsr, BSRBITS);
666 revents = ap->a_events & (POLLOUT | POLLWRNORM);
667 if (ap->a_events & (POLLIN | POLLRDNORM)) {
668 if (cmx_test(bsr, BSR_BULK_IN_FULL, 1)) {
669 revents |= ap->a_events & (POLLIN | POLLRDNORM);
671 selrecord(curthread, &sc->sel);
674 DEBUG_printf(sc->dev, "enabling polling\n");
676 callout_reset(&sc->ch, POLL_TICKS,
679 DEBUG_printf(sc->dev, "already polling\n");
685 DEBUG_printf(sc->dev, "success (revents=%b)\n", revents, POLLBITS);
692 * Interrupt handler. Currently has no function except to
693 * print register status (if debugging is also enabled).
698 struct cmx_softc *sc = (struct cmx_softc *)arg;
700 if (sc == NULL || sc->dying)
703 DEBUG_printf(sc->dev, "received interrupt (SCR=%b BSR=%b)\n",
704 cmx_read_SCR(sc), SCRBITS,
705 cmx_read_BSR(sc), BSRBITS);