Fix HID class device driver -- if a SetIDle request is issued with the LSB of wValue...

[pub/USBasp.git] / Projects / Magstripe / Magstripe.txt

diff --git a/Projects/Magstripe/Magstripe.txt b/Projects/Magstripe/Magstripe.txt
index d91fddd..739f14a 100644 (file)
--- a/Projects/Magstripe/Magstripe.txt
+++ b/Projects/Magstripe/Magstripe.txt
@@ -5,7 +5,43 @@
  */\r
  \r
 /** \mainpage Denver Gingerich's USBSnoop Magnetic Card Reader Project\r
- * \r
+ *\r
+ *  \section SSec_Compat Demo Compatibility:\r
+ *\r
+ *  The following table indicates what microcontrollers are compatible with this demo.\r
+ *\r
+ *  - AT90USB1287\r
+ *  - AT90USB1286\r
+ *\r
+ *  \section SSec_Info USB Information:\r
+ *\r
+ *  The following table gives a rundown of the USB utilization of this demo.\r
+ *\r
+ * <table>\r
+ *  <tr>\r
+ *   <td><b>USB Mode:</b></td>\r
+ *   <td>Device</td>\r
+ *  </tr>\r
+ *  <tr>\r
+ *   <td><b>USB Class:</b></td>\r
+ *   <td>Human Interface Device (HID)</td>\r
+ *  </tr>\r
+ *  <tr> \r
+ *   <td><b>USB Subclass:</b></td>\r
+ *   <td>Keyboard</td>\r
+ *  </tr>\r
+ *  <tr>\r
+ *   <td><b>Relevant Standards:</b></td>\r
+ *   <td>USBIF HID Standard, USBIF HID Usage Tables</td>\r
+ *  </tr>\r
+ *  <tr>\r
+ *   <td><b>Usable Speeds:</b></td>\r
+ *   <td>Low Speed Mode, Full Speed Mode</td>\r
+ *  </tr>\r
+ * </table>\r
+ *\r
+ *  \section SSec_Description Project Description: \r
+ *\r
  *  Firmware for a USB AVR powered USB TTL magnetic stripe reader (using a card\r
  *  reader such as the Omron V3B-4K) by Denver Gingerich. This project is designed\r
  *  to be used with the open source Stripe Snoop project at http://stripesnoop.sourceforge.net/.\r
@@ -13,7 +49,7 @@
  *  See http://ossguy.com/ss_usb/ for the USB reader hardware project website,\r
  *  including construction and support details.\r
  * \r
- *  To use, connect your magentic card reader device to the USB AVR as follows (pin and port mapping may be adjusted\r
+ *  To use, connect your magnetic card reader device to the USB AVR as follows (pin and port mapping may be adjusted\r
  *  from the project makefile):\r
  * \r
  *  <table>\r
@@ -51,7 +87,6 @@
  *   </tr>\r
  *  </table>\r
  *\r
- * \r
  *  This project is based on the LUFA Keyboard demonstration application,\r
  *  written by Denver Gingerich.\r
  *\r
@@ -60,26 +95,20 @@
  *  obtained from the magnetic stripe reader is "typed" through the keyboard\r
  *  driver as 0's and 1's. After every card swipe, the demo will send a return key.\r
  *\r
- * <table>\r
- *  <tr>\r
- *   <td><b>USB Mode:</b></td>\r
- *   <td>Device</td>\r
- *  </tr>\r
- *  <tr>\r
- *   <td><b>USB Class:</b></td>\r
- *   <td>Human Interface Device (HID)</td>\r
- *  </tr>\r
- *  <tr> \r
- *   <td><b>USB Subclass:</b></td>\r
- *   <td>Keyboard</td>\r
- *  </tr>\r
- *  <tr>\r
- *   <td><b>Relevant Standards:</b></td>\r
- *   <td>USBIF HID Standard, USBIF HID Usage Tables</td>\r
- *  </tr>\r
- *  <tr>\r
- *   <td><b>Usable Speeds:</b></td>\r
- *   <td>Low Speed Mode, Full Speed Mode</td>\r
- *  </tr>\r
- * </table>\r
+ *  \section SSec_Options Project Options\r
+ *\r
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>Define Name:</b></td>\r
+ *    <td><b>Location:</b></td>\r
+ *    <td><b>Description:</b></td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>MAX_BITS</td>\r
+ *    <td>CircularBitBuffer.h</td>\r
+ *    <td>Gives the maximum number of bits per track which can be buffered by the device for later transmission to a host.</td>\r
+ *   </tr>\r
+ *  </table>\r
  */\r