[Pcsclite-cvs-commit] r2744 - /trunk/PCSC/doc/ifdhandler-3.tex

[rousseau at users.alioth.debian.org]

Author: rousseau
Date: Thu Jan 17 09:25:01 2008
New Revision: 2744

URL: http://svn.debian.org/wsvn/pcsclite/?sc=1&rev=2744
Log:
more details about deviceName argument of IFDHCreateChannelByName()

Modified:
    trunk/PCSC/doc/ifdhandler-3.tex

Modified: trunk/PCSC/doc/ifdhandler-3.tex
URL: http://svn.debian.org/wsvn/pcsclite/trunk/PCSC/doc/ifdhandler-3.tex?rev=2744&op=diff
==============================================================================
--- trunk/PCSC/doc/ifdhandler-3.tex (original)
+++ trunk/PCSC/doc/ifdhandler-3.tex Thu Jan 17 09:25:01 2008
@@ -47,7 +47,7 @@
 \title{MUSCLE PC/SC IFD Driver API}
 \author{David Corcoran \& Ludovic Rousseau\\
 \url{corcoran at musclecard.com}, \url{ludovic.rousseau at free.fr}}
-\date{July 28, 2004}
+\date{\today}
 
 \begin{document}
 
@@ -77,6 +77,9 @@
 information \\
 \hline
 3.2.0 & Jan 10, 2007 & document \texttt{IFD\_GENERATE\_HOTPLUG} capability \\
+\hline
+3.3.0 & Jan 17, 2008 & more details about \texttt{deviceName} argument
+of \texttt{IFDHCreateChannelByName()} \\
 \hline
 \end{tabular}
 
@@ -560,10 +563,28 @@
 For drivers configured by \texttt{/etc/reader.conf} this is the value of
 the field \texttt{DEVICENAME}.
 
-For USB drivers under platforms using
+For USB drivers the \texttt{DeviceName} must start with
+\texttt{usb:VID/PID}. \texttt{VID} is the Vendor ID and \texttt{PID} is
+the Product ID. Both are a 4-digits hex number.
+
+Typically the string is generated by:
+\begin{verbatim}
+printf("usb:%04x/%04x", idVendor, idProduct);
+\end{verbatim}
+
+The \texttt{DeviceName} string may also contain a more specialised
+identification string. This additional information is used to
+differentiate between two identical readers connected at the same time.
+In this case the driver can't differentiate the two readers using VID
+and PID and must use some additional information identifying the USB
+port used by each readers.
+
+\begin{itemize}
+\item libusb
+
+For USB drivers using
 \texttt{libusb}\footnote{\url{http://libusb.sourceforge.net/}} for USB
-abstraction (Any Unix except MacOSX) the \texttt{DeviceName} field uses
-the string generated by:
+abstraction the \texttt{DeviceName} the string may be generated by:
 \begin{verbatim}
 printf("usb:%04x/%04x:libusb:%s:%s",
     idVendor, idProduct,
@@ -571,11 +592,11 @@
 \end{verbatim}
 
 So it is something like: \texttt{usb:08e6/3437:libusb:001:042} under
-Linux.
+GNU/Linux.
+
+\end{itemize}
 
 It is the responsibility of the driver to correctly identify the reader.
-This scheme was put in place to be able to distinguish two identical
-readers connected at the same time.
 
 \end{itemize}