X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/032a83e9e1bda3b4724870ad65310414a8020351..a7880ac1cdbfe8ddaf957173bc08f334aad8bca7:/Projects/Magstripe/Magstripe.txt

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