Magstripe.c 7.54 KB
Newer Older
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
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2009  Denver Gingerich (denver [at] ossguy [dot] com)
  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)

  Permission to use, copy, modify, and distribute this software
  and its documentation for any purpose and without fee is hereby
  granted, provided that the above copyright notice appear in all
  copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/
 
32
33
34
35
36
37
/** \file
 *
 *  Main source file for the MagStripe reader program. This file contains the main tasks of
 *  the project and is responsible for the initial application hardware configuration.
 */
 
38
39
#include "Magstripe.h"

40
41
42
/** Bit buffers to hold the read bits for each of the three magnetic card tracks before they are transmitted
 *  to the host as keyboard presses.
 */
43
BitBuffer_t TrackDataBuffers[3];
44

45
46
47
48
/** LUFA HID Class driver interface configuration and state information. This structure is
 *  passed to all HID Class driver functions, so that multiple instances of the same class
 *  within a device can be differentiated from one another.
 */
49
USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =
50
	{
Dean Camera's avatar
Dean Camera committed
51
52
53
54
55
56
57
58
59
		.Config =
			{
				.InterfaceNumber         = 0,

				.ReportINEndpointNumber  = KEYBOARD_EPNUM,
				.ReportINEndpointSize    = KEYBOARD_EPSIZE,
				
				.ReportINBufferSize      = sizeof(USB_KeyboardReport_Data_t),
			},
60
		
Dean Camera's avatar
Dean Camera committed
61
62
63
64
		.State =
			{
				// Leave all state values to their defaults				
			}
65
	};
66

67
68
69
/** Main program entry point. This routine contains the overall program flow, including initial
 *  setup of all components and the main program loop.
 */
70
71
72
73
74
75
int main(void)
{
	SetupHardware();
	
	for (uint8_t Buffer = 0; Buffer < 3; Buffer++)
	  BitBuffer_Init(&TrackDataBuffers[Buffer]);
76

77
78
79
80
	for (;;)
	{
		if (Magstripe_GetStatus() & MAG_CARDPRESENT)
		  ReadMagstripeData();
81

Dean Camera's avatar
Dean Camera committed
82
		HID_Device_USBTask(&Keyboard_HID_Interface);
83
84
85
		USB_USBTask();
	}
}
86

87
/** Configures the board hardware and chip peripherals for the demo's functionality. */
88
void SetupHardware(void)
89
90
91
92
93
{
	/* Disable watchdog if enabled by bootloader/fuses */
	MCUSR &= ~(1 << WDRF);
	wdt_disable();

94
95
	/* Disable clock division */
	clock_prescale_set(clock_div_1);
96
97
98
99

	/* Hardware Initialization */
	Magstripe_Init();
	USB_Init();
100
101
102
103
104
105

	/* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */
	OCR0A  = ((F_CPU / 64) / 1000);
	TCCR0A = (1 << WGM01);
	TCCR0B = ((1 << CS01) | (1 << CS00));
	TIMSK0 = (1 << OCIE0A);
106
107
}

108
109
110
/** Determines if a card has been inserted, and if so reads in each track's contents into the bit buffers
 *  until they are read out to the host as a series of keyboard presses.
 */
111
void ReadMagstripeData(void)
112
{
113
114
115
116
117
118
119
120
	/* Arrays to hold the buffer pointers, clock and data bit masks for the separate card tracks */
	const struct
	{
		uint8_t ClockMask;
		uint8_t DataMask;	
	} TrackInfo[] = {{MAG_T1_CLOCK, MAG_T1_DATA},
	                 {MAG_T2_CLOCK, MAG_T2_DATA},
	                 {MAG_T3_CLOCK, MAG_T3_DATA}};
121

122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
	uint8_t Magstripe_Prev = 0;
	uint8_t Magstripe_LCL  = Magstripe_GetStatus();

	while (Magstripe_LCL & MAG_CARDPRESENT)
	{
		for (uint8_t Track = 0; Track < 3; Track++)
		{
			bool DataPinLevel      = ((Magstripe_LCL & TrackInfo[Track].DataMask) != 0);
			bool ClockPinLevel     = ((Magstripe_LCL & TrackInfo[Track].ClockMask) != 0);
			bool ClockLevelChanged = (((Magstripe_LCL ^ Magstripe_Prev) & TrackInfo[Track].ClockMask) != 0);
		
			if (ClockPinLevel && ClockLevelChanged)
			  BitBuffer_StoreNextBit(&TrackDataBuffers[Track], DataPinLevel);
		}

		Magstripe_Prev = Magstripe_LCL;
		Magstripe_LCL  = Magstripe_GetStatus();
	}
140
141
}

142
/** Event handler for the library USB Configuration Changed event. */
143
void EVENT_USB_ConfigurationChanged(void)
144
{
Dean Camera's avatar
Dean Camera committed
145
	HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface);
146
147
}

148
/** Event handler for the library USB Unhandled Control Packet event. */
149
void EVENT_USB_UnhandledControlPacket(void)
150
{
Dean Camera's avatar
Dean Camera committed
151
	HID_Device_ProcessControlPacket(&Keyboard_HID_Interface);
152
153
}

154
/** Timer 0 CTC ISR, firing once each millisecond to keep track of elapsed idle time in the HID interface. */
155
ISR(TIMER0_COMPA_vect, ISR_BLOCK)
156
{
Dean Camera's avatar
Dean Camera committed
157
158
	if (Keyboard_HID_Interface.State.IdleMSRemaining)
	  Keyboard_HID_Interface.State.IdleMSRemaining--;
159
160
}

161
162
/** HID Class driver callback function for the creation of a HID report for the host.
 *
163
164
165
 *  \param[in] HIDInterfaceInfo  Pointer to the HID interface structure for the HID interface being referenced
 *  \param[in,out] ReportID      Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 *  \param[out] ReportData       Pointer to the preallocated report buffer where the created report should be stored
166
167
168
 *
 *  \return Number of bytes in the created report
 */
Dean Camera's avatar
Dean Camera committed
169
uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData)
170
{
171
172
	static bool IsKeyReleaseReport;
	static bool IsNewlineReport;
173

174
175
	BitBuffer_t*               Buffer         = NULL;
	USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
176
		
177
178
	/* Key reports must be interleaved with 0 Key Code reports to release the keys, or repeated keys will be ignored */
	IsKeyReleaseReport = !IsKeyReleaseReport;	
179

180
	if (IsKeyReleaseReport)
181
	{
182
		KeyboardReport->KeyCode = 0;
183
	}
184
	else if (IsNewlineReport)
185
	{
186
187
188
189
		IsNewlineReport = false;
		KeyboardReport->KeyCode = KEY_ENTER;
	}
	else
190
	{
191
192
193
194
195
196
197
198
199
200
		if (TrackDataBuffers[0].Elements)
		  Buffer = &TrackDataBuffers[0];
		else if (TrackDataBuffers[1].Elements)
		  Buffer = &TrackDataBuffers[1];			
		else if (TrackDataBuffers[2].Elements)
		  Buffer = &TrackDataBuffers[2];
		else
		  return 0;

		KeyboardReport->KeyCode = BitBuffer_GetNextBit(Buffer) ? KEY_1 : KEY_0;
201
		
202
203
204
		/* If buffer now empty, next report must be a newline to seperate track data */
		if (!(Buffer->Elements))
		  IsNewlineReport = true;
205
206
	}
	
207
	return sizeof(USB_KeyboardReport_Data_t);
208
209
}

210
211
/** HID Class driver callback function for the processing of a received HID report from the host.
 *
212
213
214
215
 *  \param[in] HIDInterfaceInfo  Pointer to the HID interface structure for the HID interface being referenced
 *  \param[in] ReportID          Report ID of the received report from the host
 *  \param[in] ReportData        Pointer to the report buffer where the received report is stored
 *  \param[in] ReportSize        Size in bytes of the report received from the host
216
 */
Dean Camera's avatar
Dean Camera committed
217
218
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo, uint8_t ReportID,
                                          void* ReportData, uint16_t ReportSize)
219
{
220
	// Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports
221
}