arising out of or in connection with the use or performance of\r
this software.\r
*/\r
-\r
+ \r
/** \file\r
*\r
- * Main source file for the MagStripe application. This file contains the code which drives\r
- * the USB keyboard interface from the magnetic card stripe reader device.\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
-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
- { .Task = USB_USBTask , .TaskStatus = TASK_STOP },\r
- { .Task = USB_Keyboard_Report , .TaskStatus = TASK_STOP },\r
- { .Task = Magstripe_Read , .TaskStatus = TASK_STOP },\r
-};\r
-\r
-/* Global Variables */\r
-/** Indicates if the device is using Report Protocol mode, instead of Boot Protocol mode. Boot Protocol mode\r
- * is a special reporting mode used by compatible PC BIOS to support USB keyboards before a full OS and USB\r
- * driver has been loaded, by using predefined report structures indicated in the USB HID standard.\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
-bool UsingReportProtocol = true;\r
+BitBuffer_t TrackDataBuffers[TOTAL_TRACKS];\r
\r
-/** Total idle period in milliseconds set by the host via a SetIdle request, used to silence the report endpoint\r
- * until the report data changes or the idle period elapsed. Generally used to implement hardware key repeats, or\r
- * by some BIOS to reduce the number of reports when in Boot Protocol mode.\r
- */\r
-uint8_t IdleCount = 0;\r
+/** Pointer to the current track buffer being sent to the host. */\r
+BitBuffer_t* CurrentTrackBuffer = &TrackDataBuffers[TOTAL_TRACKS];\r
\r
-/** Milliseconds remaining counter for the HID class SetIdle and GetIdle requests, used to silence the report\r
- * endpoint for an amount of time indicated by the host or until the report changes.\r
- */\r
-uint16_t IdleMSRemaining = 0;\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
-/** Circular buffer to hold the read bits from track 1 of the inserted magnetic card. */\r
-BitBuffer_t Track1Data;\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
-/** Circular buffer to hold the read bits from track 2 of the inserted magnetic card. */\r
-BitBuffer_t Track2Data;\r
+ .ReportINEndpointNumber = KEYBOARD_EPNUM,\r
+ .ReportINEndpointSize = KEYBOARD_EPSIZE,\r
\r
-/** Circular buffer to hold the read bits from track 3 of the inserted magnetic card. */\r
-BitBuffer_t Track3Data;\r
+ .PrevReportINBuffer = PrevKeyboardHIDReportBuffer,\r
+ .PrevReportINBufferSize = sizeof(PrevKeyboardHIDReportBuffer),\r
+ },\r
+ };\r
\r
-/** Delay counter between successive key strokes. This is to prevent the OS from ignoring multiple keys in a short\r
- * period of time due to key repeats. Two milliseconds works for most OSes.\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
-uint8_t KeyDelayRemaining;\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
+ for (;;)\r
+ {\r
+ if (Magstripe_GetStatus() & MAG_CARDPRESENT)\r
+ ReadMagstripeData();\r
\r
-/** Main program entry point. This routine configures the hardware required by the application, then\r
- * starts the scheduler to run the application tasks.\r
- */\r
-int main(void)\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
\r
/* Hardware Initialization */\r
Magstripe_Init();\r
- \r
- /* Buffer Initialization */\r
- BitBuffer_Init(&Track1Data);\r
- BitBuffer_Init(&Track2Data);\r
- BitBuffer_Init(&Track3Data);\r
- \r
- /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */\r
- OCR0A = 0xFA;\r
- TCCR0A = (1 << WGM01);\r
- TCCR0B = ((1 << CS01) | (1 << CS00));\r
- TIMSK0 = (1 << OCIE0A);\r
- \r
- /* Initialize Scheduler so that it can be used */\r
- Scheduler_Init();\r
-\r
- /* Initialize USB Subsystem */\r
USB_Init();\r
- \r
- /* Scheduling - routine never returns, so put this last in the main function */\r
- Scheduler_Start();\r
-}\r
-\r
-/** Event handler for the USB_Connect event. This starts the USB task. */\r
-EVENT_HANDLER(USB_Connect)\r
-{\r
- /* Start USB management task */\r
- Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
-}\r
-\r
-/** Event handler for the USB_Disconnect event. This stops the USB and keyboard report tasks. */\r
-EVENT_HANDLER(USB_Disconnect)\r
-{\r
- /* Stop running keyboard reporting, card reading and USB management tasks */\r
- Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_STOP);\r
- Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
- Scheduler_SetTaskMode(Magstripe_Read, TASK_STOP);\r
-}\r
-\r
-/** Event handler for the USB_ConfigurationChanged event. This configures the device's endpoints ready\r
- * to relay reports to the host, and starts the keyboard report task.\r
- */\r
-EVENT_HANDLER(USB_ConfigurationChanged)\r
-{\r
- /* Setup Keyboard Keycode Report Endpoint */\r
- Endpoint_ConfigureEndpoint(KEYBOARD_EPNUM, EP_TYPE_INTERRUPT,\r
- ENDPOINT_DIR_IN, KEYBOARD_EPSIZE,\r
- ENDPOINT_BANK_SINGLE);\r
- \r
- /* Default to report protocol on connect */\r
- UsingReportProtocol = true;\r
-\r
- /* Start Keyboard reporting and card reading tasks */\r
- Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_RUN);\r
- Scheduler_SetTaskMode(Magstripe_Read, TASK_RUN);\r
}\r
\r
-/** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific\r
- * control requests that are not handled internally by the USB library, so that they can be handled appropriately\r
- * for the application.\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
-EVENT_HANDLER(USB_UnhandledControlPacket)\r
+void ReadMagstripeData(void)\r
{\r
- /* Handle HID Class specific requests */\r
- switch (bRequest)\r
+ /* Arrays to hold the buffer pointers, clock and data bit masks for the separate card tracks */\r
+ const struct\r
{\r
- case REQ_GetReport:\r
- if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
- {\r
- USB_KeyboardReport_Data_t KeyboardReportData;\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
- /* Create the next keyboard report for transmission to the host */\r
- GetNextReport(&KeyboardReportData);\r
-\r
- /* Ignore report type and ID number value */\r
- Endpoint_Discard_Word();\r
- \r
- /* Ignore unused Interface number value */\r
- Endpoint_Discard_Word();\r
-\r
- /* Read in the number of bytes in the report to send to the host */\r
- uint16_t wLength = Endpoint_Read_Word_LE();\r
- \r
- /* If trying to send more bytes than exist to the host, clamp the value at the report size */\r
- if (wLength > sizeof(KeyboardReportData))\r
- wLength = sizeof(KeyboardReportData);\r
+ uint8_t Magstripe_Prev = 0;\r
+ uint8_t Magstripe_LCL = Magstripe_GetStatus();\r
\r
- Endpoint_ClearSETUP();\r
- \r
- /* Write the report data to the control endpoint */\r
- Endpoint_Write_Control_Stream_LE(&KeyboardReportData, wLength);\r
- \r
- /* Finalize the stream transfer to send the last packet or clear the host abort */\r
- Endpoint_ClearOUT();\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
- break;\r
- case REQ_GetProtocol:\r
- if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
- {\r
- Endpoint_ClearSETUP();\r
- \r
- /* Write the current protocol flag to the host */\r
- Endpoint_Write_Byte(UsingReportProtocol);\r
- \r
- /* Send the flag to the host */\r
- Endpoint_ClearIN();\r
-\r
- /* Acknowledge status stage */\r
- while (!(Endpoint_IsOUTReceived()));\r
- Endpoint_ClearOUT();\r
- }\r
- \r
- break;\r
- case REQ_SetProtocol:\r
- if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
- {\r
- /* Read in the wValue parameter containing the new protocol mode */\r
- uint16_t wValue = Endpoint_Read_Word_LE();\r
- \r
- Endpoint_ClearSETUP();\r
+ /* Sample data on rising clock edges from the card reader */\r
+ if (ClockPinLevel && ClockLevelChanged)\r
+ BitBuffer_StoreNextBit(&TrackDataBuffers[Track], DataPinLevel);\r
+ }\r
\r
- /* Set or clear the flag depending on what the host indicates that the current Protocol should be */\r
- UsingReportProtocol = (wValue != 0x0000);\r
- \r
- /* Acknowledge status stage */\r
- while (!(Endpoint_IsINReady()));\r
- Endpoint_ClearIN();\r
- }\r
- \r
- break;\r
- case REQ_SetIdle:\r
- if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
- {\r
- /* Read in the wValue parameter containing the idle period */\r
- uint16_t wValue = Endpoint_Read_Word_LE();\r
- \r
- Endpoint_ClearSETUP();\r
- \r
- /* Get idle period in MSB */\r
- IdleCount = (wValue >> 8);\r
- \r
- /* Acknowledge status stage */\r
- while (!(Endpoint_IsINReady()));\r
- Endpoint_ClearIN();\r
- }\r
- \r
- break;\r
- case REQ_GetIdle:\r
- if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
- { \r
- Endpoint_ClearSETUP();\r
- \r
- /* Write the current idle duration to the host */\r
- Endpoint_Write_Byte(IdleCount);\r
- \r
- /* Send the flag to the host */\r
- Endpoint_ClearIN();\r
+ Magstripe_Prev = Magstripe_LCL;\r
+ Magstripe_LCL = Magstripe_GetStatus();\r
+ }\r
+ \r
+ CurrentTrackBuffer = &TrackDataBuffers[0];\r
+}\r
\r
- /* Acknowledge status stage */\r
- while (!(Endpoint_IsOUTReceived()));\r
- Endpoint_ClearOUT();\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
- break;\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
-/** ISR for the timer 0 compare vector. This ISR fires once each millisecond, and decrements the counter indicating\r
- * the number of milliseconds left to idle (not send the host reports) if the device has been instructed to idle\r
- * by the host via a SetIdle class specific request.\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
- /* One millisecond has elapsed, decrement the idle time remaining counter if it has not already elapsed */\r
- if (IdleMSRemaining)\r
- IdleMSRemaining--;\r
- \r
- if (KeyDelayRemaining)\r
- KeyDelayRemaining--;\r
+ HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);\r
}\r
\r
-/** Constructs a keyboard report indicating the currently pressed keyboard keys to the host.\r
+/** HID class driver callback function for the creation of HID reports to the host.\r
*\r
- * \param ReportData Pointer to a USB_KeyboardReport_Data_t report structure where the resulting report should\r
- * 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 Boolean true if the current report is different to the previous report, false otherwise\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 GetNextReport(USB_KeyboardReport_Data_t* 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
- static bool OddReport = false;\r
- static bool MustRelease = false;\r
- \r
- BitBuffer_t* Buffer = NULL;\r
+ USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;\r
\r
- /* Clear the report contents */\r
- memset(ReportData, 0, sizeof(USB_KeyboardReport_Data_t));\r
+ static bool IsKeyReleaseReport;\r
\r
- /* Get the next non-empty track data buffer */\r
- if (Track1Data.Elements)\r
- Buffer = &Track1Data;\r
- else if (Track2Data.Elements)\r
- Buffer = &Track2Data; \r
- else if (Track3Data.Elements)\r
- Buffer = &Track3Data;\r
+ /* Key reports must be interleaved with key release reports, or repeated keys will be ignored */\r
+ IsKeyReleaseReport = !IsKeyReleaseReport;\r
\r
- if (Buffer != NULL)\r
+ if ((IsKeyReleaseReport) || (CurrentTrackBuffer == &TrackDataBuffers[TOTAL_TRACKS]))\r
{\r
- /* Toggle the odd report number indicator */\r
- OddReport = !OddReport;\r
- \r
- /* Set the flag indicating that a null report must eventually be sent to release all pressed keys */\r
- MustRelease = true;\r
-\r
- /* Only send the next key on odd reports, so that they are interspersed with null reports to release keys */\r
- if (OddReport)\r
- {\r
- /* Set the report key code to the key code for the next data bit */\r
- ReportData->KeyCode = BitBuffer_GetNextBit(Buffer) ? KEY_1 : KEY_0;\r
- \r
- /* If buffer is now empty, a new line must be sent instead of the terminating bit */\r
- if (!(Buffer->Elements))\r
- {\r
- /* Set the keycode to the code for an enter key press */\r
- ReportData->KeyCode = KEY_ENTER; \r
- }\r
- }\r
-\r
- return true;\r
+ /* No more data to send, or key release report between key presses */\r
+ KeyboardReport->KeyCode = KEY_NONE;\r
}\r
- else if (MustRelease)\r
+ else if (!(CurrentTrackBuffer->Elements))\r
{\r
- /* Leave key code to null (0), to release all pressed keys */\r
- return true;\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
- \r
- return false;\r
-}\r
-\r
-/** Task to read out data from inserted magnetic cards and place the separate track data into their respective\r
- * data buffers for later sending to the host as keyboard key presses.\r
- */\r
-TASK(Magstripe_Read)\r
-{\r
- /* Arrays to hold the buffer pointers, clock and data bit masks for the separate card tracks */\r
- const struct\r
- {\r
- BitBuffer_t* Buffer;\r
- uint8_t ClockMask;\r
- uint8_t DataMask; \r
- } TrackInfo[] = {{&Track1Data, MAG_T1_CLOCK, MAG_T1_DATA},\r
- {&Track2Data, MAG_T2_CLOCK, MAG_T2_DATA},\r
- {&Track3Data, MAG_T3_CLOCK, MAG_T3_DATA}};\r
-\r
- /* Previous magnetic card control line' status, for later comparison */\r
- uint8_t Magstripe_Prev = 0;\r
- \r
- /* Buffered current card reader control line' status */\r
- uint8_t Magstripe_LCL = Magstripe_GetStatus();\r
-\r
- /* Exit the task early if no card is present in the reader */\r
- if (!(Magstripe_LCL & MAG_CARDPRESENT))\r
- return;\r
-\r
- /* Read out card data while a card is present */\r
- while (Magstripe_LCL & MAG_CARDPRESENT)\r
+ else\r
{\r
- /* Read out the next bit for each track of the card */\r
- for (uint8_t Track = 0; Track < 3; Track++)\r
- {\r
- /* Current data line status for the current card track */\r
- bool DataLevel = ((Magstripe_LCL & TrackInfo[Track].DataMask) != 0);\r
-\r
- /* Current clock line status for the current card track */\r
- bool ClockLevel = ((Magstripe_LCL & TrackInfo[Track].ClockMask) != 0);\r
-\r
- /* Current track clock transition check */\r
- bool ClockChanged = (((Magstripe_LCL ^ Magstripe_Prev) & TrackInfo[Track].ClockMask) != 0);\r
- \r
- /* Sample the next bit on the falling edge of the track's clock line, store key code into the track's buffer */\r
- if (ClockLevel && ClockChanged)\r
- BitBuffer_StoreNextBit(TrackInfo[Track].Buffer, DataLevel);\r
- }\r
-\r
- /* Retain the current card reader control line states for later edge detection */\r
- Magstripe_Prev = Magstripe_LCL;\r
- \r
- /* Retrieve the new card reader control line states */\r
- Magstripe_LCL = Magstripe_GetStatus();\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
- /* Add terminators to the end of each track buffer */\r
- BitBuffer_StoreNextBit(&Track1Data, 0);\r
- BitBuffer_StoreNextBit(&Track2Data, 0);\r
- BitBuffer_StoreNextBit(&Track3Data, 0);\r
+ *ReportSize = sizeof(USB_KeyboardReport_Data_t);\r
+ return false;\r
}\r
\r
-/** Task for the magnetic card reading and keyboard report generation. This task waits until a card is inserted,\r
- * then reads off the card data and sends it to the host as a series of keyboard key presses via keyboard reports.\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
-TASK(USB_Keyboard_Report)\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
- USB_KeyboardReport_Data_t KeyboardReportData;\r
- bool SendReport = false;\r
- \r
- /* Check if the USB system is connected to a host */\r
- if (USB_IsConnected)\r
- {\r
- /* Select the Keyboard Report Endpoint */\r
- Endpoint_SelectEndpoint(KEYBOARD_EPNUM);\r
-\r
- /* Check if Keyboard Endpoint Ready for Read/Write */\r
- if (Endpoint_IsReadWriteAllowed())\r
- {\r
- /* Only fetch the next key to send once the period between key presses has elapsed */\r
- if (!(KeyDelayRemaining))\r
- {\r
- /* Create the next keyboard report for transmission to the host */\r
- SendReport = GetNextReport(&KeyboardReportData);\r
- }\r
- \r
- /* Check if the idle period is set and has elapsed */\r
- if (IdleCount && !(IdleMSRemaining))\r
- {\r
- /* Idle period elapsed, indicate that a report must be sent */\r
- SendReport = true;\r
- \r
- /* Reset the idle time remaining counter, must multiply by 4 to get the duration in milliseconds */\r
- IdleMSRemaining = (IdleCount << 2);\r
- }\r
-\r
- /* Write the keyboard report if a report is to be sent to the host */\r
- if (SendReport)\r
- {\r
- /* Write Keyboard Report Data */\r
- Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(USB_KeyboardReport_Data_t));\r
-\r
- /* Finalize the stream transfer to send the last packet */\r
- Endpoint_ClearIN();\r
-\r
- /* Reset the key delay period counter */\r
- KeyDelayRemaining = 2;\r
- }\r
- }\r
- }\r
+ // Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports\r
}\r
projects / pub / USBasp.git / blobdiff