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
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
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>
53 #include <sys/module.h>
56 #include <machine/bus.h>
57 #include <machine/resource.h>
60 #include <dev/cmx/cmxvar.h>
61 #include <dev/cmx/cmxreg.h>
64 #define DEBUG_printf(dev, fmt, args...) \
65 device_printf(dev, "%s: " fmt, __FUNCTION__, ##args)
67 #define DEBUG_printf(dev, fmt, args...)
70 #define SPIN_COUNT 1000
71 #define WAIT_TICKS (hz/100)
72 #define POLL_TICKS (hz/10)
75 #define CCID_DRIVER_BULK_DEFAULT_TIMEOUT (150*hz)
76 #define CCID_DRIVER_ASYNC_POWERUP_TIMEOUT (35*hz)
77 #define CCID_DRIVER_MINIMUM_TIMEOUT (3*hz)
80 static char BSRBITS[] = "\020"
81 "\01BULK_OUT_FULL" /* 0x01 */
82 "\02BULK_IN_FULL" /* 0x02 */
83 "\03(0x04)"; /* 0x04 */
85 static char SCRBITS[] = "\020"
86 "\01POWER_DOWN" /* 0x01 */
87 "\02PULSE_INTERRUPT" /* 0x02 */
88 "\03HOST_TO_READER_DONE" /* 0x04 */
89 "\04READER_TO_HOST_DONE" /* 0x08 */
90 "\05ACK_NOTIFY" /* 0x10 */
91 "\06EN_NOTIFY" /* 0x20 */
93 "\10HOST_TO_READER_START"; /* 0x80 */
95 static char POLLBITS[] = "\020"
96 "\01POLLIN" /* 0x0001 */
97 "\02POLLPRI" /* 0x0002 */
98 "\03POLLOUT" /* 0x0004 */
99 "\04POLLERR" /* 0x0008 */
100 "\05POLLHUP" /* 0x0010 */
101 "\06POLLINVAL" /* 0x0020 */
102 "\07POLLRDNORM" /* 0x0040 */
103 "\10POLLRDBAND" /* 0x0080 */
104 "\11POLLWRBAND"; /* 0x0100 */
105 static char MODEBITS[] = "\020"
106 "\01READ" /* 0x0001 */
107 "\02WRITE" /* 0x0002 */
108 "\03NONBLOCK" /* 0x0004 */
109 "\04APPEND" /* 0x0008 */
110 "\05SHLOCK" /* 0x0010 */
111 "\06EXLOCK" /* 0x0020 */
112 "\07ASYNC" /* 0x0040 */
113 "\10FSYNC" /* 0x0080 */
114 "\11NOFOLLOW" /* 0x0100 */
115 "\12CREAT" /* 0x0200 */
116 "\13TRUNK" /* 0x0400 */
117 "\14EXCL" /* 0x0800 */
118 "\15(0x1000)" /* 0x1000 */
119 "\16(0x2000)" /* 0x2000 */
120 "\17HASLOCK" /* 0x4000 */
121 "\20NOCTTY" /* 0x8000 */
122 "\21DIRECT"; /* 0x00010000 */
123 #endif /* CMX_DEBUG */
125 devclass_t cmx_devclass;
127 static d_open_t cmx_open;
128 static d_close_t cmx_close;
129 static d_read_t cmx_read;
130 static d_write_t cmx_write;
131 static d_poll_t cmx_poll;
133 static void cmx_intr(void *arg);
136 static struct cdevsw cmx_cdevsw = {
137 .d_version = D_VERSION,
139 .d_close = cmx_close,
141 .d_write = cmx_write,
147 * Initialize the softc structure. Must be called from
148 * the bus specific device allocation routine.
151 cmx_init_softc(device_t dev)
153 struct cmx_softc *sc = device_get_softc(dev);
155 sc->timeout = CCID_DRIVER_MINIMUM_TIMEOUT;
159 * Allocate driver resources. Must be called from the
160 * bus specific device allocation routine. Caller must
161 * ensure to call cmx_release_resources to free the
162 * resources when detaching.
163 * Return zero if successful, and ENOMEM if the resources
164 * could not be allocated.
167 cmx_alloc_resources(device_t dev)
169 struct cmx_softc *sc = device_get_softc(dev);
174 sc->ioport = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
175 &sc->ioport_rid, RF_ACTIVE);
177 device_printf(dev, "failed to allocate io port\n");
180 sc->bst = rman_get_bustag(sc->ioport);
181 sc->bsh = rman_get_bushandle(sc->ioport);
184 sc->irq = bus_alloc_resource_any(dev, SYS_RES_IRQ,
185 &sc->irq_rid, RF_ACTIVE);
187 device_printf(dev, "failed to allocate irq\n");
190 if ((rv = bus_setup_intr(dev, sc->irq, INTR_TYPE_TTY,
191 cmx_intr, sc, &sc->ih)) != 0) {
192 device_printf(dev, "failed to set up irq\n");
197 mtx_init(&sc->mtx, device_get_nameunit(dev),
199 MTX_DEF | MTX_RECURSE);
200 callout_init_mtx(&sc->ch, &sc->mtx, 0);
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 mtx_destroy(&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_cdevsw, 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);
280 callout_drain(&sc->ch);
281 selwakeuppri(&sc->sel, PZERO);
287 destroy_dev(sc->cdev);
289 DEBUG_printf(dev, "releasing resources\n");
290 cmx_release_resources(dev);
295 * Wait for buffer status register events. If test is non-zero,
296 * wait until flags are set, otherwise wait until flags are unset.
297 * Will spin SPIN_COUNT times, then sleep until timeout is reached.
298 * Returns zero if event happened, EIO if the timeout was reached,
299 * and ENXIO if the device was detached in the meantime. When that
300 * happens, the caller must quit immediately, since a detach is
304 cmx_wait_BSR(struct cmx_softc *sc, uint8_t flags, int test)
308 for (int i = 0; i < SPIN_COUNT; i++) {
309 if (cmx_test_BSR(sc, flags, test))
313 for (int i = 0; i * WAIT_TICKS < sc->timeout; i++) {
314 if (cmx_test_BSR(sc, flags, test))
316 rv = tsleep(sc, PWAIT|PCATCH, "cmx", WAIT_TICKS);
318 * Currently, the only reason for waking up with
319 * rv == 0 is when we are detaching, in which
320 * case sc->dying is always 1.
333 * Set the sync control register to val. Before and after writing
334 * to the SCR, we wait for the BSR to not signal BULK_OUT_FULL.
335 * Returns zero if successful, or whatever errors cmx_wait_BSR can
336 * return. ENXIO signals that the device has been detached in the
337 * meantime, and that we should leave the kernel immediately.
340 cmx_sync_write_SCR(struct cmx_softc *sc, uint8_t val)
344 if ((rv = cmx_wait_BSR(sc, BSR_BULK_OUT_FULL, 0)) != 0) {
348 cmx_write_SCR(sc, val);
350 if ((rv = cmx_wait_BSR(sc, BSR_BULK_OUT_FULL, 0)) != 0) {
358 * Returns a suitable timeout value based on the given command byte.
359 * Some commands appear to need longer timeout values than others.
361 static inline unsigned long
362 cmx_timeout_by_cmd(uint8_t cmd)
365 case CMD_PC_TO_RDR_XFRBLOCK:
366 case CMD_PC_TO_RDR_SECURE:
367 case CMD_PC_TO_RDR_TEST_SECURE:
368 case CMD_PC_TO_RDR_OK_SECURE:
369 return CCID_DRIVER_BULK_DEFAULT_TIMEOUT;
371 case CMD_PC_TO_RDR_ICCPOWERON:
372 return 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 return CCID_DRIVER_MINIMUM_TIMEOUT;
387 * Periodical callout routine, polling the reader for data
388 * availability. If the reader signals data ready for reading,
389 * wakes up the processes which are waiting in select()/poll().
390 * Otherwise, reschedules itself with a delay of POLL_TICKS.
395 struct cmx_softc *sc = xsc;
399 if (sc->polling && !sc->dying) {
400 bsr = cmx_read_BSR(sc);
401 DEBUG_printf(sc->dev, "BSR=%b\n", bsr, BSRBITS);
402 if (cmx_test(bsr, BSR_BULK_IN_FULL, 1)) {
404 selwakeuppri(&sc->sel, PZERO);
406 callout_reset(&sc->ch, POLL_TICKS, cmx_tick, sc);
413 * Open the character device. Only a single process may open the
417 cmx_open(struct cdev *cdev, int flags, int fmt, struct thread *td)
419 struct cmx_softc *sc = cdev->si_drv1;
421 if (sc == NULL || sc->dying)
432 DEBUG_printf(sc->dev, "open (flags=%b thread=%p)\n",
433 flags, MODEBITS, td);
438 * Close the character device.
441 cmx_close(struct cdev *cdev, int flags, int fmt, struct thread *td)
443 struct cmx_softc *sc = cdev->si_drv1;
445 if (sc == NULL || sc->dying)
454 DEBUG_printf(sc->dev, "disabling polling\n");
455 callout_stop(&sc->ch);
458 callout_drain(&sc->ch);
459 selwakeuppri(&sc->sel, PZERO);
465 DEBUG_printf(sc->dev, "close (flags=%b thread=%p)\n",
466 flags, MODEBITS, td);
471 * Read from the character device.
472 * Returns zero if successful, ENXIO if dying, EINVAL if an attempt
473 * was made to read less than CMX_MIN_RDLEN bytes or less than the
474 * device has available, or any of the errors that cmx_sync_write_SCR
475 * can return. Partial reads are not supported.
478 cmx_read(struct cdev *cdev, struct uio *uio, int flag)
480 struct cmx_softc *sc = cdev->si_drv1;
481 unsigned long bytes_left;
483 int rv, amnt, offset;
485 if (sc == NULL || sc->dying)
488 DEBUG_printf(sc->dev, "called (len=%d flag=%b)\n",
489 uio->uio_resid, flag, MODEBITS);
493 DEBUG_printf(sc->dev, "disabling polling\n");
494 callout_stop(&sc->ch);
497 callout_drain(&sc->ch);
498 selwakeuppri(&sc->sel, PZERO);
503 if (uio->uio_resid == 0) {
507 if (uio->uio_resid < CMX_MIN_RDLEN) {
511 if (flag & O_NONBLOCK) {
512 if (cmx_test_BSR(sc, BSR_BULK_IN_FULL, 0)) {
517 for (int i = 0; i < 5; i++) {
518 if ((rv = cmx_wait_BSR(sc, BSR_BULK_IN_FULL, 1)) != 0) {
521 sc->buf[i] = cmx_read_DTR(sc);
522 DEBUG_printf(sc->dev, "buf[%02x]=%02x\n", i, sc->buf[i]);
525 bytes_left = CMX_MIN_RDLEN +
526 (0x000000FF&((char)sc->buf[1])) +
527 (0x0000FF00&((char)sc->buf[2] << 8)) +
528 (0x00FF0000&((char)sc->buf[3] << 16)) +
529 (0xFF000000&((char)sc->buf[4] << 24));
530 DEBUG_printf(sc->dev, "msgsz=%lu\n", bytes_left);
532 if (uio->uio_resid < bytes_left) {
536 offset = 5; /* prefetched header */
537 while (bytes_left > 0) {
538 amnt = MIN(bytes_left, sizeof(sc->buf));
540 for (int i = offset; i < amnt; i++) {
541 if ((rv = cmx_wait_BSR(sc, BSR_BULK_IN_FULL, 1))!=0) {
544 sc->buf[i] = cmx_read_DTR(sc);
545 DEBUG_printf(sc->dev, "buf[%02x]=%02x\n",
549 if ((rv = uiomove(sc->buf, amnt, uio)) != 0) {
550 DEBUG_printf(sc->dev, "uiomove failed (%d)\n", rv);
559 if ((rv = cmx_wait_BSR(sc, BSR_BULK_IN_FULL, 1)) != 0) {
563 if ((rv = cmx_sync_write_SCR(sc, SCR_READER_TO_HOST_DONE)) != 0) {
567 uc = cmx_read_DTR(sc);
568 DEBUG_printf(sc->dev, "success (DTR=%02x)\n", uc);
573 * Write to the character device.
574 * Returns zero if successful, NXIO if dying, EINVAL if less data
575 * written than CMX_MIN_WRLEN, or any of the errors that cmx_sync_SCR
579 cmx_write(struct cdev *cdev, struct uio *uio, int flag)
581 struct cmx_softc *sc = cdev->si_drv1;
584 if (sc == NULL || sc->dying)
587 DEBUG_printf(sc->dev, "called (len=%d flag=%b)\n",
588 uio->uio_resid, flag, MODEBITS);
590 if (uio->uio_resid == 0) {
594 if (uio->uio_resid < CMX_MIN_WRLEN) {
598 if ((rv = cmx_sync_write_SCR(sc, SCR_HOST_TO_READER_START)) != 0) {
603 while (uio->uio_resid > 0) {
604 amnt = MIN(uio->uio_resid, sizeof(sc->buf));
606 if ((rv = uiomove(sc->buf, amnt, uio)) != 0) {
607 DEBUG_printf(sc->dev, "uiomove failed (%d)\n", rv);
608 /* wildly guessed attempt to notify device */
609 sc->timeout = CCID_DRIVER_MINIMUM_TIMEOUT;
610 cmx_sync_write_SCR(sc, SCR_HOST_TO_READER_DONE);
614 if (sc->timeout == 0) {
615 sc->timeout = cmx_timeout_by_cmd(sc->buf[0]);
616 DEBUG_printf(sc->dev, "cmd=%02x timeout=%lu\n",
617 sc->buf[0], sc->timeout);
620 for (int i = 0; i < amnt; i++) {
621 if ((rv = cmx_wait_BSR(sc, BSR_BULK_OUT_FULL, 0))!=0) {
624 cmx_write_DTR(sc, sc->buf[i]);
625 DEBUG_printf(sc->dev, "buf[%02x]=%02x\n",
630 if ((rv = cmx_sync_write_SCR(sc, SCR_HOST_TO_READER_DONE)) != 0) {
634 DEBUG_printf(sc->dev, "success\n");
639 * Poll handler. Writing is always possible, reading is only possible
640 * if BSR_BULK_IN_FULL is set. Will start the cmx_tick callout and
644 cmx_poll(struct cdev *cdev, int events, struct thread *td)
646 struct cmx_softc *sc = cdev->si_drv1;
650 if (sc == NULL || sc->dying)
653 bsr = cmx_read_BSR(sc);
654 DEBUG_printf(sc->dev, "called (events=%b BSR=%b)\n",
655 events, POLLBITS, bsr, BSRBITS);
657 revents = events & (POLLOUT | POLLWRNORM);
658 if (events & (POLLIN | POLLRDNORM)) {
659 if (cmx_test(bsr, BSR_BULK_IN_FULL, 1)) {
660 revents |= events & (POLLIN | POLLRDNORM);
662 selrecord(td, &sc->sel);
665 DEBUG_printf(sc->dev, "enabling polling\n");
667 callout_reset(&sc->ch, POLL_TICKS,
670 DEBUG_printf(sc->dev, "already polling\n");
676 DEBUG_printf(sc->dev, "success (revents=%b)\n", revents, POLLBITS);
683 * Interrupt handler. Currently has no function except to
684 * print register status (if debugging is also enabled).
689 struct cmx_softc *sc = (struct cmx_softc *)arg;
691 if (sc == NULL || sc->dying)
694 DEBUG_printf(sc->dev, "received interrupt (SCR=%b BSR=%b)\n",
695 cmx_read_SCR(sc), SCRBITS,
696 cmx_read_BSR(sc), BSRBITS);