this software.\r
*/\r
\r
+/** \file\r
+ *\r
+ * Main source file for the MagStripe reader program. This file contains the main tasks of\r
+ * the project and is responsible for the initial application hardware configuration.\r
+ */\r
+ \r
#include "Magstripe.h"\r
\r
+/** Bit buffers to hold the read bits for each of the three magnetic card tracks before they are transmitted\r
+ * to the host as keyboard presses.\r
+ */\r
BitBuffer_t TrackDataBuffers[3];\r
\r
-USB_ClassInfo_HID_t Keyboard_HID_Interface =\r
+/** LUFA HID Class driver interface configuration and state information. This structure is\r
+ * passed to all HID Class driver functions, so that multiple instances of the same class\r
+ * within a device can be differentiated from one another.\r
+ */\r
+USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =\r
{\r
- .InterfaceNumber = 0,\r
-\r
- .ReportINEndpointNumber = KEYBOARD_EPNUM,\r
- .ReportINEndpointSize = KEYBOARD_EPSIZE,\r
+ .Config =\r
+ {\r
+ .InterfaceNumber = 0,\r
+\r
+ .ReportINEndpointNumber = KEYBOARD_EPNUM,\r
+ .ReportINEndpointSize = KEYBOARD_EPSIZE,\r
+ \r
+ .ReportINBufferSize = sizeof(USB_KeyboardReport_Data_t),\r
+ },\r
+ \r
+ .State =\r
+ {\r
+ // Leave all state values to their defaults \r
+ }\r
};\r
\r
+/** Main program entry point. This routine contains the overall program flow, including initial\r
+ * setup of all components and the main program loop.\r
+ */\r
int main(void)\r
{\r
SetupHardware();\r
if (Magstripe_GetStatus() & MAG_CARDPRESENT)\r
ReadMagstripeData();\r
\r
- USB_HID_USBTask(&Keyboard_HID_Interface);\r
+ HID_Device_USBTask(&Keyboard_HID_Interface);\r
USB_USBTask();\r
}\r
}\r
\r
+/** Configures the board hardware and chip peripherals for the demo's functionality. */\r
void SetupHardware(void)\r
{\r
/* Disable watchdog if enabled by bootloader/fuses */\r
/* Hardware Initialization */\r
Magstripe_Init();\r
USB_Init();\r
+\r
+ /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */\r
+ OCR0A = ((F_CPU / 64) / 1000);\r
+ TCCR0A = (1 << WGM01);\r
+ TCCR0B = ((1 << CS01) | (1 << CS00));\r
+ TIMSK0 = (1 << OCIE0A);\r
}\r
\r
+/** Determines if a card has been inserted, and if so reads in each track's contents into the bit buffers\r
+ * until they are read out to the host as a series of keyboard presses.\r
+ */\r
void ReadMagstripeData(void)\r
{\r
/* Arrays to hold the buffer pointers, clock and data bit masks for the separate card tracks */\r
}\r
}\r
\r
+/** Event handler for the library USB Configuration Changed event. */\r
void EVENT_USB_ConfigurationChanged(void)\r
{\r
- USB_HID_ConfigureEndpoints(&Keyboard_HID_Interface);\r
+ HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface);\r
}\r
\r
+/** Event handler for the library USB Unhandled Control Packet event. */\r
void EVENT_USB_UnhandledControlPacket(void)\r
{\r
- USB_HID_ProcessControlPacket(&Keyboard_HID_Interface);\r
+ HID_Device_ProcessControlPacket(&Keyboard_HID_Interface);\r
}\r
\r
-void EVENT_USB_StartOfFrame(void)\r
+/** Timer 0 CTC ISR, firing once each millisecond to keep track of elapsed idle time in the HID interface. */\r
+ISR(TIMER0_COMPA_vect, ISR_BLOCK)\r
{\r
- USB_HID_RegisterStartOfFrame(&Keyboard_HID_Interface);\r
+ if (Keyboard_HID_Interface.State.IdleMSRemaining)\r
+ Keyboard_HID_Interface.State.IdleMSRemaining--;\r
}\r
\r
-uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData)\r
+/** HID Class driver callback function for the creation of a HID report for the host.\r
+ *\r
+ * \param HIDInterfaceInfo Pointer to the HID interface structure for the HID interface being referenced\r
+ * \param ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID\r
+ * \param ReportData Pointer to the preallocated report buffer where the created report should be stored\r
+ *\r
+ * \return Number of bytes in the created report\r
+ */\r
+uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData)\r
{\r
static bool IsKeyReleaseReport;\r
static bool IsNewlineReport;\r
return sizeof(USB_KeyboardReport_Data_t);\r
}\r
\r
-void CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize)\r
+/** HID Class driver callback function for the processing of a received HID report from the host.\r
+ *\r
+ * \param HIDInterfaceInfo Pointer to the HID interface structure for the HID interface being referenced\r
+ * \param ReportID Report ID of the received report from the host\r
+ * \param ReportData Pointer to the report buffer where the received report is stored\r
+ * \param ReportSize Size in bytes of the report received from the host\r
+ */\r
+void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo, uint8_t ReportID,\r
+ void* ReportData, uint16_t ReportSize)\r
{\r
// Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports\r
}\r