aboutsummaryrefslogtreecommitdiffstats
path: root/Projects/Magstripe/Magstripe.txt
blob: 19586277a447c4249c045918a20e50ace857e506 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/** \file
 *
 *  This file contains special DoxyGen information for the generation of the main page and other special
 *  documentation pages. It is not a project source file.
 */
 
/** \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 <a>http://stripesnoop.sourceforge.net/</a>.
 * 
 *  See <a>http://ossguy.com/ss_usb/</a> for the USB reader hardware project website,
 *  including construction and support details.
 * 
 *  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>
 *   <tr>
 *    <td><b>Signal:</b></td>
 *    <td><b>AVR Port:</b></td>
 *   </tr>
 *   <tr>
 *    <td>Track 1 Data</td>
 *    <td>PORTC, Pin 1</td>
 *   </tr>
 *   <tr>
 *    <td>Track 1 Clock</td>
 *    <td>PORTC, Pin 2</td>
 *   </tr>
 *   <tr>
 *    <td>Track 2 Data</td>
 *    <td>PORTC, Pin 3</td>
 *   </tr>
 *   <tr>
 *    <td>Track 2 Clock</td>
 *    <td>PORTC, Pin 0</td>
 *   </tr>
 *   <tr>
 *    <td>Track 3 Data</td>
 *    <td>PORTC, Pin 5</td>
 *   </tr>
 *   <tr>
 *    <td>Track 3 Clock</td>
 *    <td>PORTC, Pin 6</td>
 *   </tr>
 *   <tr>
 *    <td>Card Detect</td>
 *    <td>PORTC, Pin 4</td>
 *   </tr>
 *  </table>
 *
 *  This project is based on the LUFA Keyboard demonstration application,
 *  written by Denver Gingerich.
 *
 *  This application uses a keyboard HID driver to communicate the data collected
 *  a TTL magnetic stripe reader to the connected computer. The raw bitstream
 *  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.
 *
 *  \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>
 */