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 DEPRECATION NOTICE
  38 This driver is scheduled for removal prior to the release of
  39 .Fx 13.0
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 driver provides support for the PCCARD based
  44 .Em Omnikey CardMan 4040
  45 smartcard reader.
  46 The driver provides a character device special file based
  47 .Em Chip/Smart Card Interface Devices (CCID)
  48 interface.
  49 The driver implements what the vendor calls the
  50 .Em Synchronous API
  51 onto the smartcard reader device.
  52 .Pp
  53 Reading and writing is synchronous, meaning that a call to
  54 .Xr write 2
  55 directly corresponds to a complete CCID command sent to the
  56 device, while the following
  57 .Xr read 2
  58 will return the complete answer from the reader.
  59 There is no support for partial reads or writes.
  60 There is no upper limit on
  61 CCID request or response sizes, but the complete CCID request
  62 must be sent to the driver in
  63 .Xr write 2
  64 and the complete CCID response must fit into the buffer
  65 supplied to
  66 .Xr read 2 .
  67 .Pp
  68 Non-blocking I/O,
  69 .Xr select 2
  70 and
  71 .Xr poll 2
  72 are supported and work as expected.
  73 An open file descriptor
  74 will always be ready for writing, but only ready for reading
  75 if the device indicates that it has data available.
  76 .Sh FILES
  77 .Bl -tag -width /usr/ports/security/openct -compact
  78 .It Pa /dev/cmx\fBn\fP
  79 Character device special file.
  80 .It Pa /usr/ports/security/openct
  81 OpenCT, a userspace smartcard daemon containing a
  82 .Em CCID
  83 driver which directly supports
  84 .Nm
  85 devices.
  86 .\".It Pa /usr/ports/devel/pcsc-lite
  87 .\"PC/SC-Lite, a userspace smartcard daemon.
  88 .\".It Pa /usr/ports/devel/libccid
  89 .\"libccid, a generic
  90 .\".Em CCID
  91 .\"driver for use by PC/SC-Lite to interface to
  92 .\".Nm
  93 .\"devices.
  94 .El
  95 .Sh COMPATIBILITY
  96 Userland smartcard code written for the vendor's Linux drivers
  97 should work with the
  98 .Nm
  99 driver without modification.
 100 .Sh SEE ALSO
 101 .Xr pccard 4
 102 .Sh HISTORY
 103 The
 104 .Nm cmx
 105 driver first appeared in
 106 .Fx 7.1 .
 107 .Sh AUTHORS
 108 .An -nosplit
 109 The
 110 .Nm
 111 driver was written by
 112 .An Daniel Roethlisberger Aq Mt daniel@roe.ch ,
 113 originally based on the Linux driver v1.1.0 by
 114 .An Omnikey GmbH Lk www.omnikey.com .
 115 Early testing and bug fixes by
 116 .An Marcin Cieslak Aq Mt saper@system.pl .
 117 .Sh BUGS
 118 .An -nosplit
 119 The way the
 120 .Nm
 121 driver talks to the CardMan 4040 is a bit rough.
 122 Due to the complete lack of hardware documentation other than vendor drivers
 123 for other operating systems, the gory details of the device's
 124 I/O registers are not understood very well.
 125 There may be error conditions which can only be solved by physically
 126 reinserting the reader.