X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/d1e52660368d34d693131f6aff3c8fd8584162e5..cf313989e6f451a3b6058db94929a51bc1b5e68b:/Projects/Magstripe/Magstripe.c?ds=sidebyside diff --git a/Projects/Magstripe/Magstripe.c b/Projects/Magstripe/Magstripe.c index 5cd107e9a..087e5109e 100644 --- a/Projects/Magstripe/Magstripe.c +++ b/Projects/Magstripe/Magstripe.c @@ -29,23 +29,52 @@ 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" -BitBuffer_t TrackDataBuffers[3]; +/** 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]; -USB_ClassInfo_HID_t Keyboard_HID_Interface = - { - .InterfaceNumber = 0, +/** Pointer to the current track buffer being sent to the host. */ +BitBuffer_t* CurrentTrackBuffer = &TrackDataBuffers[TOTAL_TRACKS]; - .ReportINEndpointNumber = KEYBOARD_EPNUM, - .ReportINEndpointSize = KEYBOARD_EPSIZE, +/** 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, + + .ReportINBufferSize = sizeof(USB_KeyboardReport_Data_t), + }, + + .State = + { + // Leave all state values to their defaults + } }; +/** 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 < 3; Buffer++) + for (uint8_t Buffer = 0; Buffer < TOTAL_TRACKS; Buffer++) BitBuffer_Init(&TrackDataBuffers[Buffer]); for (;;) @@ -53,11 +82,12 @@ int main(void) if (Magstripe_GetStatus() & MAG_CARDPRESENT) ReadMagstripeData(); - USB_HID_USBTask(&Keyboard_HID_Interface); + 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 */ @@ -70,8 +100,17 @@ void SetupHardware(void) /* Hardware Initialization */ Magstripe_Init(); USB_Init(); + + /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */ + OCR0A = ((F_CPU / 64) / 1000); + TCCR0A = (1 << WGM01); + TCCR0B = ((1 << CS01) | (1 << CS00)); + TIMSK0 = (1 << OCIE0A); } +/** 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 */ @@ -88,12 +127,13 @@ void ReadMagstripeData(void) while (Magstripe_LCL & MAG_CARDPRESENT) { - for (uint8_t Track = 0; Track < 3; Track++) + 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); } @@ -101,65 +141,75 @@ void ReadMagstripeData(void) Magstripe_Prev = Magstripe_LCL; Magstripe_LCL = Magstripe_GetStatus(); } + + CurrentTrackBuffer = &TrackDataBuffers[0]; } +/** Event handler for the library USB Configuration Changed event. */ void EVENT_USB_ConfigurationChanged(void) { - USB_HID_ConfigureEndpoints(&Keyboard_HID_Interface); + HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface); } +/** Event handler for the library USB Unhandled Control Packet event. */ void EVENT_USB_UnhandledControlPacket(void) { - USB_HID_ProcessControlPacket(&Keyboard_HID_Interface); + HID_Device_ProcessControlPacket(&Keyboard_HID_Interface); } -void EVENT_USB_StartOfFrame(void) +/** Timer 0 CTC ISR, firing once each millisecond to keep track of elapsed idle time in the HID interface. */ +ISR(TIMER0_COMPA_vect, ISR_BLOCK) { - USB_HID_RegisterStartOfFrame(&Keyboard_HID_Interface); + if (Keyboard_HID_Interface.State.IdleMSRemaining) + Keyboard_HID_Interface.State.IdleMSRemaining--; } -uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData) +/** HID Class driver callback function for the creation of a HID report for the host. + * + * \param[in] HIDInterfaceInfo Pointer to the HID interface structure for the HID interface 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[out] ReportData Pointer to the preallocated report buffer where the created report should be stored + * + * \return Number of bytes in the created report + */ +uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID, void* ReportData) { + USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData; + static bool IsKeyReleaseReport; - static bool IsNewlineReport; - BitBuffer_t* Buffer = NULL; - USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData; - - /* Key reports must be interleaved with 0 Key Code reports to release the keys, or repeated keys will be ignored */ - IsKeyReleaseReport = !IsKeyReleaseReport; + /* Key reports must be interleaved with key release reports, or repeated keys will be ignored */ + IsKeyReleaseReport = !IsKeyReleaseReport; - if (IsKeyReleaseReport) + if ((IsKeyReleaseReport) || (CurrentTrackBuffer == &TrackDataBuffers[TOTAL_TRACKS])) { - KeyboardReport->KeyCode = 0; + /* No more data to send, or key release report between key presses */ + KeyboardReport->KeyCode = KEY_NONE; } - else if (IsNewlineReport) + else if (!(CurrentTrackBuffer->Elements)) { - IsNewlineReport = false; + /* End of current track, send an enter press and change to the next track's buffer */ KeyboardReport->KeyCode = KEY_ENTER; + CurrentTrackBuffer++; } else { - if (TrackDataBuffers[0].Elements) - Buffer = &TrackDataBuffers[0]; - else if (TrackDataBuffers[1].Elements) - Buffer = &TrackDataBuffers[1]; - else if (TrackDataBuffers[2].Elements) - Buffer = &TrackDataBuffers[2]; - else - return 0; - - KeyboardReport->KeyCode = BitBuffer_GetNextBit(Buffer) ? KEY_1 : KEY_0; - - /* If buffer now empty, next report must be a newline to seperate track data */ - if (!(Buffer->Elements)) - IsNewlineReport = true; + /* Still data in the current track; convert next bit to a 1 or 0 keypress */ + KeyboardReport->KeyCode = BitBuffer_GetNextBit(CurrentTrackBuffer) ? KEY_1 : KEY_0; } return sizeof(USB_KeyboardReport_Data_t); } -void CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize) +/** 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 }