Demos/Device/LowLevel/CCID/CCID.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \mainpage CCID Device Demo
   8  *
   9  *  \section Sec_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  \li Series 7 USB AVRs (AT90USBxxx7)
  14  *  \li Series 6 USB AVRs (AT90USBxxx6)
  15  *  \li Series 4 USB AVRs (ATMEGAxxU4)
  16  *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
  17  *  \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
  18  *  \li Series B XMEGA AVRs (ATXMEGAxxxBx)
  19  *  \li Series C XMEGA AVRs (ATXMEGAxxxCx)
  20  *
  21  *  \section Sec_Info USB Information:
  22  *
  23  *  The following table gives a rundown of the USB utilization of this demo.
  24  *
  25  *  <table>
  26  *   <tr>
  27  *    <td><b>USB Mode:</b></td>
  28  *    <td>Device</td>
  29  *   </tr>
  30  *   <tr>
  31  *    <td><b>USB Class:</b></td>
  32  *    <td>CCID Class</td>
  33  *   </tr>
  34   *   <tr>
  35  *    <td><b>USB Subclass:</b></td>
  36  *    <td>None</td>
  37  *   </tr>
  38  *    <td><b>Relevant Standards:</b></td>
  39  *    <td>USB CCID 1.1 Specification for Integrated Circuit(s) Cards Interface Devices</td>
  40  *    <td>ISO 7816-3</td>
  41  *   </tr>
  42  *   <tr>
  43  *    <td><b>Supported USB Speeds:</b></td>
  44  *    <td>Full Speed Mode</td>
  45  *   </tr>
  46  *  </table>
  47  *
  48  *  \section Sec_Description Project Description:
  49  *
  50  *  CCID demonstration application. This gives a simple reference
  51  *  application for implementing a USB CCID device. If you want to test this
  52  *  in Linux, you must change the following file:
  53  *  /usr/lib/pcsc/drivers/ifd-ccid.bundle/Contents/Info.plist
  54  *  and add a VID, PID and friendly name.
  55  *
  56  *  This device was not tested on Windows.
  57  *
  58  *  On start-up the system will automatically enumerate and function
  59  *  as a CCID device with one slot already inserted. Upon detection, the device
  60  *  will send an ATR to the device, which can use it to determine
  61  *  host capabilities. Developers can use user applications to send APDUs
  62  *  back and forth to the device
  63  *
  64  */
  65