Add svn:eol-style property to source files, so that the line endings are correctly...
[pub/USBasp.git] / Projects / Magstripe / Magstripe.c
index 39149b4..6dbceb6 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting \r
-  documentation, and that the name of the author not be used in \r
-  advertising or publicity pertaining to distribution of the \r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  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[TOTAL_TRACKS];\r
-\r
-/** Pointer to the current track buffer being sent to the host. */\r
-BitBuffer_t* CurrentTrackBuffer = &TrackDataBuffers[TOTAL_TRACKS];\r
-\r
-/** Buffer to hold the previously generated Keyboard HID report, for comparison purposes inside the HID class driver. */\r
-uint8_t PrevKeyboardHIDReportBuffer[sizeof(USB_KeyboardReport_Data_t)];\r
-\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
-               .Config =\r
-                       {\r
-                               .InterfaceNumber            = 0,\r
-\r
-                               .ReportINEndpointNumber     = KEYBOARD_EPNUM,\r
-                               .ReportINEndpointSize       = KEYBOARD_EPSIZE,\r
-                               .ReportINEndpointDoubleBank = KEYBOARD_EPSIZE,\r
-\r
-                               .PrevReportINBuffer         = PrevKeyboardHIDReportBuffer,\r
-                               .PrevReportINBufferSize     = sizeof(PrevKeyboardHIDReportBuffer),\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
-       \r
-       for (uint8_t Buffer = 0; Buffer < TOTAL_TRACKS; Buffer++)\r
-         BitBuffer_Init(&TrackDataBuffers[Buffer]);\r
-         \r
-       sei();\r
-\r
-       for (;;)\r
-       {\r
-               if (Magstripe_GetStatus() & MAG_CARDPRESENT)\r
-                 ReadMagstripeData();\r
-\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
-       MCUSR &= ~(1 << WDRF);\r
-       wdt_disable();\r
-\r
-       /* Disable clock division */\r
-       clock_prescale_set(clock_div_1);\r
-\r
-       /* Hardware Initialization */\r
-       Magstripe_Init();\r
-       USB_Init();\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
-       const struct\r
-       {\r
-               uint8_t ClockMask;\r
-               uint8_t DataMask;       \r
-       } TrackInfo[] = {{MAG_T1_CLOCK, MAG_T1_DATA},\r
-                        {MAG_T2_CLOCK, MAG_T2_DATA},\r
-                        {MAG_T3_CLOCK, MAG_T3_DATA}};\r
-\r
-       uint8_t Magstripe_Prev = 0;\r
-       uint8_t Magstripe_LCL  = Magstripe_GetStatus();\r
-\r
-       while (Magstripe_LCL & MAG_CARDPRESENT)\r
-       {\r
-               for (uint8_t Track = 0; Track < TOTAL_TRACKS; Track++)\r
-               {\r
-                       bool DataPinLevel      = ((Magstripe_LCL & TrackInfo[Track].DataMask) != 0);\r
-                       bool ClockPinLevel     = ((Magstripe_LCL & TrackInfo[Track].ClockMask) != 0);\r
-                       bool ClockLevelChanged = (((Magstripe_LCL ^ Magstripe_Prev) & TrackInfo[Track].ClockMask) != 0);\r
-               \r
-                       /* Sample data on rising clock edges from the card reader */\r
-                       if (ClockPinLevel && ClockLevelChanged)\r
-                         BitBuffer_StoreNextBit(&TrackDataBuffers[Track], DataPinLevel);\r
-               }\r
-\r
-               Magstripe_Prev = Magstripe_LCL;\r
-               Magstripe_LCL  = Magstripe_GetStatus();\r
-       }\r
-       \r
-       CurrentTrackBuffer = &TrackDataBuffers[0];\r
-}\r
-\r
-/** Event handler for the library USB Configuration Changed event. */\r
-void EVENT_USB_Device_ConfigurationChanged(void)\r
-{\r
-       HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface);\r
-       \r
-       USB_Device_EnableSOFEvents();\r
-}\r
-\r
-/** Event handler for the library USB Unhandled Control Packet event. */\r
-void EVENT_USB_Device_UnhandledControlRequest(void)\r
-{\r
-       HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);\r
-}\r
-\r
-/** Event handler for the USB device Start Of Frame event. */\r
-void EVENT_USB_Device_StartOfFrame(void)\r
-{\r
-       HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);\r
-}\r
-\r
-/** HID class driver callback function for the creation of HID reports to the host.\r
- *\r
- *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
- *  \param[in,out] ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID\r
- *  \param[in] ReportType  Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature\r
- *  \param[out] ReportData  Pointer to a buffer where the created report should be stored\r
- *  \param[out] ReportSize  Number of bytes written in the report (or zero if no report is to be sent\r
- *\r
- *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent\r
- */\r
-bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,\r
-                                         const uint8_t ReportType, void* ReportData, uint16_t* ReportSize)\r
-{\r
-       USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;\r
-\r
-       static bool IsKeyReleaseReport;\r
-\r
-       /* Key reports must be interleaved with key release reports, or repeated keys will be ignored */\r
-       IsKeyReleaseReport = !IsKeyReleaseReport;\r
-\r
-       if ((IsKeyReleaseReport) || (CurrentTrackBuffer == &TrackDataBuffers[TOTAL_TRACKS]))\r
-       {\r
-               /* No more data to send, or key release report between key presses */\r
-               KeyboardReport->KeyCode[0] = KEY_NONE;\r
-       }\r
-       else if (!(CurrentTrackBuffer->Elements))\r
-       {\r
-               /* End of current track, send an enter press and change to the next track's buffer */\r
-               KeyboardReport->KeyCode[0] = KEY_ENTER;\r
-               CurrentTrackBuffer++;\r
-       }\r
-       else\r
-       {\r
-               /* Still data in the current track; convert next bit to a 1 or 0 keypress */\r
-               KeyboardReport->KeyCode[0] = BitBuffer_GetNextBit(CurrentTrackBuffer) ? KEY_1 : KEY_0;\r
-       }\r
-       \r
-       *ReportSize = sizeof(USB_KeyboardReport_Data_t);\r
-       return false;\r
-}\r
-\r
-/** HID Class driver callback function for the processing of a received HID report from the host.\r
- *\r
- *  \param[in] HIDInterfaceInfo  Pointer to the HID interface structure for the HID interface being referenced\r
- *  \param[in] ReportID          Report ID of the received report from the host\r
- *  \param[in] ReportData        Pointer to the report buffer where the received report is stored\r
- *  \param[in] ReportSize        Size in bytes of the report received from the host\r
- */\r
-void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,\r
-                                          const void* ReportData, const 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
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2010.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this 
+  software and its documentation for any purpose is hereby granted
+  without fee, 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.
+*/
+/** \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.
+ */
+#include "Magstripe.h"
+
+/** 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.
+ */
+BitBuffer_t TrackDataBuffers[TOTAL_TRACKS];
+
+/** Pointer to the current track buffer being sent to the host. */
+BitBuffer_t* CurrentTrackBuffer = &TrackDataBuffers[TOTAL_TRACKS];
+
+/** Buffer to hold the previously generated Keyboard HID report, for comparison purposes inside the HID class driver. */
+uint8_t PrevKeyboardHIDReportBuffer[sizeof(USB_KeyboardReport_Data_t)];
+
+/** 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.
+ */
+USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =
+       {
+               .Config =
+                       {
+                               .InterfaceNumber            = 0,
+
+                               .ReportINEndpointNumber     = KEYBOARD_EPNUM,
+                               .ReportINEndpointSize       = KEYBOARD_EPSIZE,
+                               .ReportINEndpointDoubleBank = KEYBOARD_EPSIZE,
+
+                               .PrevReportINBuffer         = PrevKeyboardHIDReportBuffer,
+                               .PrevReportINBufferSize     = sizeof(PrevKeyboardHIDReportBuffer),
+                       },
+       };
+
+/** Main program entry point. This routine contains the overall program flow, including initial
+ *  setup of all components and the main program loop.
+ */
+int main(void)
+{
+       SetupHardware();
+       
+       for (uint8_t Buffer = 0; Buffer < TOTAL_TRACKS; Buffer++)
+         BitBuffer_Init(&TrackDataBuffers[Buffer]);
+         
+       sei();
+
+       for (;;)
+       {
+               if (Magstripe_GetStatus() & MAG_CARDPRESENT)
+                 ReadMagstripeData();
+
+               HID_Device_USBTask(&Keyboard_HID_Interface);
+               USB_USBTask();
+       }
+}
+
+/** Configures the board hardware and chip peripherals for the demo's functionality. */
+void SetupHardware(void)
+{
+       /* Disable watchdog if enabled by bootloader/fuses */
+       MCUSR &= ~(1 << WDRF);
+       wdt_disable();
+
+       /* Disable clock division */
+       clock_prescale_set(clock_div_1);
+
+       /* Hardware Initialization */
+       Magstripe_Init();
+       USB_Init();
+}
+
+/** 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.
+ */
+void ReadMagstripeData(void)
+{
+       /* 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}};
+
+       uint8_t Magstripe_Prev = 0;
+       uint8_t Magstripe_LCL  = Magstripe_GetStatus();
+
+       while (Magstripe_LCL & MAG_CARDPRESENT)
+       {
+               for (uint8_t Track = 0; Track < TOTAL_TRACKS; 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);
+               
+                       /* Sample data on rising clock edges from the card reader */
+                       if (ClockPinLevel && ClockLevelChanged)
+                         BitBuffer_StoreNextBit(&TrackDataBuffers[Track], DataPinLevel);
+               }
+
+               Magstripe_Prev = Magstripe_LCL;
+               Magstripe_LCL  = Magstripe_GetStatus();
+       }
+       
+       CurrentTrackBuffer = &TrackDataBuffers[0];
+}
+
+/** Event handler for the library USB Configuration Changed event. */
+void EVENT_USB_Device_ConfigurationChanged(void)
+{
+       HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface);
+       
+       USB_Device_EnableSOFEvents();
+}
+
+/** Event handler for the library USB Unhandled Control Packet event. */
+void EVENT_USB_Device_UnhandledControlRequest(void)
+{
+       HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);
+}
+
+/** Event handler for the USB device Start Of Frame event. */
+void EVENT_USB_Device_StartOfFrame(void)
+{
+       HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);
+}
+
+/** HID class driver callback function for the creation of HID reports to the host.
+ *
+ *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure 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[in] ReportType  Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
+ *  \param[out] ReportData  Pointer to a buffer where the created report should be stored
+ *  \param[out] ReportSize  Number of bytes written in the report (or zero if no report is to be sent
+ *
+ *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
+ */
+bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
+                                         const uint8_t ReportType, void* ReportData, uint16_t* ReportSize)
+{
+       USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
+
+       static bool IsKeyReleaseReport;
+
+       /* Key reports must be interleaved with key release reports, or repeated keys will be ignored */
+       IsKeyReleaseReport = !IsKeyReleaseReport;
+
+       if ((IsKeyReleaseReport) || (CurrentTrackBuffer == &TrackDataBuffers[TOTAL_TRACKS]))
+       {
+               /* No more data to send, or key release report between key presses */
+               KeyboardReport->KeyCode[0] = KEY_NONE;
+       }
+       else if (!(CurrentTrackBuffer->Elements))
+       {
+               /* End of current track, send an enter press and change to the next track's buffer */
+               KeyboardReport->KeyCode[0] = KEY_ENTER;
+               CurrentTrackBuffer++;
+       }
+       else
+       {
+               /* Still data in the current track; convert next bit to a 1 or 0 keypress */
+               KeyboardReport->KeyCode[0] = BitBuffer_GetNextBit(CurrentTrackBuffer) ? KEY_1 : KEY_0;
+       }
+       
+       *ReportSize = sizeof(USB_KeyboardReport_Data_t);
+       return false;
+}
+
+/** HID Class driver callback function for the processing of a received HID report from the host.
+ *
+ *  \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
+ */
+void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
+                                          const void* ReportData, const uint16_t ReportSize)
+{
+       // Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports
+}