Changed HIDParser to only zero out important values in the Parsed HID Report Item...
[pub/USBasp.git] / Projects / Magstripe / Magstripe.c
index 1963973..3ea5052 100644 (file)
 /** 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
+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
@@ -54,14 +60,10 @@ USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =
 \r
                                .ReportINEndpointNumber  = KEYBOARD_EPNUM,\r
                                .ReportINEndpointSize    = KEYBOARD_EPSIZE,\r
-                               \r
-                               .ReportINBufferSize      = sizeof(USB_KeyboardReport_Data_t),\r
+\r
+                               .PrevReportINBuffer      = PrevKeyboardHIDReportBuffer,\r
+                               .PrevReportINBufferSize  = sizeof(PrevKeyboardHIDReportBuffer),\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
@@ -71,7 +73,7 @@ int main(void)
 {\r
        SetupHardware();\r
        \r
-       for (uint8_t Buffer = 0; Buffer < 3; Buffer++)\r
+       for (uint8_t Buffer = 0; Buffer < TOTAL_TRACKS; Buffer++)\r
          BitBuffer_Init(&TrackDataBuffers[Buffer]);\r
 \r
        for (;;)\r
@@ -97,12 +99,6 @@ void SetupHardware(void)
        /* 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
@@ -124,12 +120,13 @@ void ReadMagstripeData(void)
 \r
        while (Magstripe_LCL & MAG_CARDPRESENT)\r
        {\r
-               for (uint8_t Track = 0; Track < 3; Track++)\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
@@ -137,85 +134,79 @@ void ReadMagstripeData(void)
                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_ConfigurationChanged(void)\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_UnhandledControlPacket(void)\r
+void EVENT_USB_Device_UnhandledControlRequest(void)\r
 {\r
-       HID_Device_ProcessControlPacket(&Keyboard_HID_Interface);\r
+       HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);\r
 }\r
 \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
+/** Event handler for the USB device Start Of Frame event. */\r
+void EVENT_USB_Device_StartOfFrame(void)\r
 {\r
-       if (Keyboard_HID_Interface.State.IdleMSRemaining)\r
-         Keyboard_HID_Interface.State.IdleMSRemaining--;\r
+       HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);\r
 }\r
 \r
-/** HID Class driver callback function for the creation of a HID report for the host.\r
+/** HID class driver callback function for the creation of HID reports to 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
+ *  \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[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 Number of bytes in the created report\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
-uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData)\r
+bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,\r
+                                         void* ReportData, uint16_t* ReportSize)\r
 {\r
+       USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;\r
+\r
        static bool IsKeyReleaseReport;\r
-       static bool IsNewlineReport;\r
 \r
-       BitBuffer_t*               Buffer         = NULL;\r
-       USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;\r
-               \r
-       /* Key reports must be interleaved with 0 Key Code reports to release the keys, or repeated keys will be ignored */\r
-       IsKeyReleaseReport = !IsKeyReleaseReport;       \r
+       /* Key reports must be interleaved with key release reports, or repeated keys will be ignored */\r
+       IsKeyReleaseReport = !IsKeyReleaseReport;\r
 \r
-       if (IsKeyReleaseReport)\r
+       if ((IsKeyReleaseReport) || (CurrentTrackBuffer == &TrackDataBuffers[TOTAL_TRACKS]))\r
        {\r
-               KeyboardReport->KeyCode = 0;\r
+               /* No more data to send, or key release report between key presses */\r
+               KeyboardReport->KeyCode = KEY_NONE;\r
        }\r
-       else if (IsNewlineReport)\r
+       else if (!(CurrentTrackBuffer->Elements))\r
        {\r
-               IsNewlineReport = false;\r
+               /* End of current track, send an enter press and change to the next track's buffer */\r
                KeyboardReport->KeyCode = KEY_ENTER;\r
+               CurrentTrackBuffer++;\r
        }\r
        else\r
        {\r
-               if (TrackDataBuffers[0].Elements)\r
-                 Buffer = &TrackDataBuffers[0];\r
-               else if (TrackDataBuffers[1].Elements)\r
-                 Buffer = &TrackDataBuffers[1];                        \r
-               else if (TrackDataBuffers[2].Elements)\r
-                 Buffer = &TrackDataBuffers[2];\r
-               else\r
-                 return 0;\r
-\r
-               KeyboardReport->KeyCode = BitBuffer_GetNextBit(Buffer) ? KEY_1 : KEY_0;\r
-               \r
-               /* If buffer now empty, next report must be a newline to seperate track data */\r
-               if (!(Buffer->Elements))\r
-                 IsNewlineReport = true;\r
+               /* Still data in the current track; convert next bit to a 1 or 0 keypress */\r
+               KeyboardReport->KeyCode = BitBuffer_GetNextBit(CurrentTrackBuffer) ? KEY_1 : KEY_0;\r
        }\r
        \r
-       return sizeof(USB_KeyboardReport_Data_t);\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 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
+ *  \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* HIDInterfaceInfo, uint8_t ReportID,\r
-                                          void* ReportData, uint16_t ReportSize)\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