share/man/man4/cmx.4

   1 .\"
   2 .\" Copyright (c) 2006-2007 Daniel Roethlisberger <daniel@roe.ch>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice unmodified, this list of conditions, and the following
  10 .\"    disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd July 7, 2007
  30 .Dt CMX 4
  31 .Os
  32 .Sh NAME
  33 .Nm cmx
  34 .Nd Omnikey CardMan 4040 smartcard reader device driver
  35 .Sh SYNOPSIS
  36 .Cd device cmx
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 driver provides support for the PCCARD based
  41 .Em Omnikey CardMan 4040
  42 smartcard reader.
  43 The driver provides a character device special file based
  44 .Em Chip/Smart Card Interface Devices (CCID)
  45 interface.
  46 The driver implements what the vendor calls the
  47 .Em Synchronous API
  48 onto the smartcard reader device.
  49 .Pp
  50 Reading and writing is synchronous, meaning that a call to
  51 .Xr write 2
  52 directly corresponds to a complete CCID command sent to the
  53 device, while the following
  54 .Xr read 2
  55 will return the complete answer from the reader.
  56 There is no support for partial reads or writes.
  57 There is no upper limit on
  58 CCID request or response sizes, but the complete CCID request
  59 must be sent to the driver in
  60 .Xr write 2
  61 and the complete CCID response must fit into the buffer
  62 supplied to
  63 .Xr read 2 .
  64 .Pp
  65 Non-blocking I/O,
  66 .Xr select 2
  67 and
  68 .Xr poll 2
  69 are supported and work as expected.
  70 An open file descriptor
  71 will always be ready for writing, but only ready for reading
  72 if the device indicates that it has data available.
  73 .Sh FILES
  74 .Bl -tag -width /usr/ports/security/openct -compact
  75 .It Pa /dev/cmx\fBn\fP
  76 Character device special file.
  77 .It Pa /usr/ports/security/openct
  78 OpenCT, a userspace smartcard daemon containing a
  79 .Em CCID
  80 driver which directly supports
  81 .Nm
  82 devices.
  83 .\".It Pa /usr/ports/devel/pcsc-lite
  84 .\"PC/SC-Lite, a userspace smartcard daemon.
  85 .\".It Pa /usr/ports/devel/libccid
  86 .\"libccid, a generic
  87 .\".Em CCID
  88 .\"driver for use by PC/SC-Lite to interface to
  89 .\".Nm
  90 .\"devices.
  91 .El
  92 .Sh COMPATIBILITY
  93 Userland smartcard code written for the vendor's Linux drivers
  94 should work with the
  95 .Nm
  96 driver without modification.
  97 .Sh SEE ALSO
  98 .Xr pccard 4
  99 .Sh HISTORY
 100 The
 101 .Nm cmx
 102 driver first appeared in
 103 .Fx 7.1 .
 104 .Sh AUTHORS
 105 .An -nosplit
 106 The
 107 .Nm
 108 driver was written by
 109 .An Daniel Roethlisberger Aq Mt daniel@roe.ch ,
 110 originally based on the Linux driver v1.1.0 by
 111 .An Omnikey GmbH Lk www.omnikey.com .
 112 Early testing and bug fixes by
 113 .An Marcin Cieslak Aq Mt saper@system.pl .
 114 .Sh BUGS
 115 .An -nosplit
 116 The way the
 117 .Nm
 118 driver talks to the CardMan 4040 is a bit rough.
 119 Due to the complete lack of hardware documentation other than vendor drivers
 120 for other operating systems, the gory details of the device's
 121 I/O registers are not understood very well.
 122 There may be error conditions which can only be solved by physically
 123 reinserting the reader.