Fixed SerialStream driver not setting stdin to the created serial stream.

[pub/USBasp.git] / Projects / Magstripe / Magstripe.c

diff --git a/Projects/Magstripe/Magstripe.c b/Projects/Magstripe/Magstripe.c
index 871db28..88950cc 100644 (file)
--- a/Projects/Magstripe/Magstripe.c
+++ b/Projects/Magstripe/Magstripe.c
@@ -1,22 +1,22 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Denver Gingerich (denver [at] ossguy [dot] com)\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  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
+  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 without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -29,25 +29,52 @@
   this software.\r
 */\r
  \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
 #include "Magstripe.h"\r
 \r

-BitBuffer_t TrackDataBuffers[3];\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
 \r

-USB_ClassInfo_HID_t Keyboard_HID_Interface =\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
        {\r

-               .InterfaceNumber         = 0,\r
+               .Config =\r
+                       {\r
+                               .InterfaceNumber            = 0,\r

 \r
 \r

-               .ReportINEndpointNumber  = KEYBOARD_EPNUM,\r
-               .ReportINEndpointSize    = KEYBOARD_EPSIZE,\r
-               \r
-               .ReportINBufferSize      = sizeof(USB_KeyboardReport_Data_t),\r
+                               .ReportINEndpointNumber     = KEYBOARD_EPNUM,\r
+                               .ReportINEndpointSize       = KEYBOARD_EPSIZE,\r
+                               .ReportINEndpointDoubleBank = KEYBOARD_EPSIZE,\r
+\r
+                               .PrevReportINBuffer         = PrevKeyboardHIDReportBuffer,\r
+                               .PrevReportINBufferSize     = sizeof(PrevKeyboardHIDReportBuffer),\r
+                       },\r

        };\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
 int main(void)\r
 {\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
          BitBuffer_Init(&TrackDataBuffers[Buffer]);\r
 \r
        for (;;)\r


@@ -55,11 +82,12 @@ int main(void)
                if (Magstripe_GetStatus() & MAG_CARDPRESENT)\r
                  ReadMagstripeData();\r
 \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
                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
 void SetupHardware(void)\r
 {\r
        /* Disable watchdog if enabled by bootloader/fuses */\r


@@ -72,14 +100,11 @@ void SetupHardware(void)
        /* Hardware Initialization */\r
        Magstripe_Init();\r
        USB_Init();\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
 }\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
 void ReadMagstripeData(void)\r
 {\r
        /* Arrays to hold the buffer pointers, clock and data bit masks for the separate card tracks */\r


@@ -96,12 +121,13 @@ void ReadMagstripeData(void)
 \r
        while (Magstripe_LCL & MAG_CARDPRESENT)\r
        {\r
 \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
                {\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
                        if (ClockPinLevel && ClockLevelChanged)\r
                          BitBuffer_StoreNextBit(&TrackDataBuffers[Track], DataPinLevel);\r
                }\r


@@ -109,66 +135,80 @@ void ReadMagstripeData(void)
                Magstripe_Prev = Magstripe_LCL;\r
                Magstripe_LCL  = Magstripe_GetStatus();\r
        }\r
                Magstripe_Prev = Magstripe_LCL;\r
                Magstripe_LCL  = Magstripe_GetStatus();\r
        }\r

+       \r
+       CurrentTrackBuffer = &TrackDataBuffers[0];\r

 }\r
 \r
 }\r
 \r

-void EVENT_USB_ConfigurationChanged(void)\r
+/** Event handler for the library USB Configuration Changed event. */\r
+void EVENT_USB_Device_ConfigurationChanged(void)\r

 {\r
 {\r

-       USB_HID_ConfigureEndpoints(&Keyboard_HID_Interface);\r
+       HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface);\r
+       \r
+       USB_Device_EnableSOFEvents();\r

 }\r
 \r
 }\r
 \r

-void EVENT_USB_UnhandledControlPacket(void)\r
+/** Event handler for the library USB Unhandled Control Packet event. */\r
+void EVENT_USB_Device_UnhandledControlRequest(void)\r

 {\r
 {\r

-       USB_HID_ProcessControlPacket(&Keyboard_HID_Interface);\r
+       HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);\r

 }\r
 \r
 }\r
 \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
 {\r

-       if (Keyboard_HID_Interface.IdleMSRemaining)\r
-         Keyboard_HID_Interface.IdleMSRemaining--;\r
+       HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);\r

 }\r
 \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 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
 {\r

+       USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;\r
+\r

        static bool IsKeyReleaseReport;\r
        static bool IsKeyReleaseReport;\r

-       static bool IsNewlineReport;\r

 \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
 \r

-       if (IsKeyReleaseReport)\r
+       if ((IsKeyReleaseReport) || (CurrentTrackBuffer == &TrackDataBuffers[TOTAL_TRACKS]))\r

        {\r
        {\r

-               KeyboardReport->KeyCode = 0;\r
+               /* No more data to send, or key release report between key presses */\r
+               KeyboardReport->KeyCode[0] = KEY_NONE;\r

        }\r
        }\r

-       else if (IsNewlineReport)\r
+       else if (!(CurrentTrackBuffer->Elements))\r

        {\r
        {\r

-               IsNewlineReport = false;\r
-               KeyboardReport->KeyCode = KEY_ENTER;\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
        }\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[0] = BitBuffer_GetNextBit(CurrentTrackBuffer) ? KEY_1 : KEY_0;\r

        }\r
        \r
        }\r
        \r

-       return sizeof(USB_KeyboardReport_Data_t);\r
+       *ReportSize = sizeof(USB_KeyboardReport_Data_t);\r
+       return false;\r

 }\r
 \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[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
 {\r
        // Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports\r
 }\r