Fixed incorrect signature reported in the CDC class bootloader for the ATMEGA32U2.
[pub/USBasp.git] / Projects / Magstripe / Magstripe.h
index fbf68e5..946ef2e 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\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
-  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
- *  Header file for Magstripe.c.\r
- */\r
-\r
-#ifndef _MAGSTRIPE_H_\r
-#define _MAGSTRIPE_H_\r
-\r
-       /* Includes: */\r
-               #include <avr/io.h>\r
-               #include <avr/wdt.h>\r
-               #include <avr/interrupt.h>\r
-               #include <avr/power.h>\r
-               #include <stdbool.h>\r
-               #include <string.h>\r
-\r
-               #include "Descriptors.h"\r
-               #include "MagstripeHW.h"\r
-               #include "CircularBitBuffer.h"\r
-\r
-               #include <LUFA/Version.h>                    // Library Version Information\r
-               #include <LUFA/Common/ButtLoadTag.h>         // PROGMEM tags readable by the ButtLoad project\r
-               #include <LUFA/Drivers/USB/USB.h>            // USB Functionality\r
-               #include <LUFA/Scheduler/Scheduler.h>        // Simple scheduler for task management\r
-\r
-               \r
-       /* Task Definitions: */\r
-               /** Task definition for the keyboard and magnetic card reading task. */\r
-               TASK(USB_Keyboard_Report);\r
-               \r
-               TASK(Magstripe_Read);\r
-\r
-       /* Macros: */\r
-               /** HID Class Specific Request to get the current HID report from the device. */\r
-               #define REQ_GetReport      0x01\r
-\r
-               /** HID Class Specific Request to get the current device idle count. */\r
-               #define REQ_GetIdle        0x02\r
-\r
-               /** HID Class Specific Request to set the current HID report to the device. */\r
-               #define REQ_SetReport      0x09\r
-\r
-               /** HID Class Specific Request to set the device's idle count. */\r
-               #define REQ_SetIdle        0x0A\r
-\r
-               /** HID Class Specific Request to get the current HID report protocol mode. */\r
-               #define REQ_GetProtocol    0x03\r
-\r
-               /** HID Class Specific Request to set the current HID report protocol mode. */\r
-               #define REQ_SetProtocol    0x0B\r
-               \r
-               /** HID keyboard keycode to indicate that the "1" key is currently pressed. */\r
-               #define KEY_1              30\r
-\r
-               /** HID keyboard keycode to indicate that the "0" key is currently pressed. */\r
-               #define KEY_0              39\r
-\r
-               /** HID keyboard keycode to indicate that the enter key is currently pressed. */\r
-               #define KEY_ENTER          40\r
-               \r
-       /* Type Defines: */\r
-               /** Type define for the keyboard report structure. This structure matches the report layout\r
-                *  given to the host in the HID Report descriptor, as well as matches the boot protocol report\r
-                *  structure. This means that this one report structure can be used in both Report and Boot Protocol\r
-                *  modes. */\r
-               typedef struct\r
-               {\r
-                       uint8_t Modifier; /**< Modifier byte, indicating pressed modifier keys such as CTRL or ALT */\r
-                       uint8_t Reserved; /**< Reserved for OEM use, always set to 0 */\r
-                       uint8_t KeyCode; /**< Key code array for pressed keys - up to six can be given simultaneously */\r
-               } USB_KeyboardReport_Data_t;\r
-\r
-       /* Event Handlers: */\r
-               /** Indicates that this module will catch the USB_Connect event when thrown by the library. */\r
-               HANDLES_EVENT(USB_Connect);\r
-\r
-               /** Indicates that this module will catch the USB_Disconnect event when thrown by the library. */\r
-               HANDLES_EVENT(USB_Disconnect);\r
-\r
-               /** Indicates that this module will catch the USB_ConfigurationChanged event when thrown by the library. */\r
-               HANDLES_EVENT(USB_ConfigurationChanged);\r
-\r
-               /** Indicates that this module will catch the USB_UnhandledControlPacket event when thrown by the library. */\r
-               HANDLES_EVENT(USB_UnhandledControlPacket);\r
-               \r
-       /* Function Prototypes: */\r
-               bool GetNextReport(USB_KeyboardReport_Data_t* ReportData);\r
-               void SendKey(USB_KeyboardReport_Data_t* KeyboardReportData, uint8_t Key);\r
-               void Send(USB_KeyboardReport_Data_t* KeyboardReportData, bool SendReport);\r
-               \r
-#endif\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
+ *
+ *  Header file for Magstripe.c.
+ */
+
+#ifndef _MAGSTRIPE_H_
+#define _MAGSTRIPE_H_
+
+       /* Includes: */
+               #include <avr/io.h>
+               #include <avr/wdt.h>
+               #include <avr/power.h>
+               #include <avr/interrupt.h>
+
+               #include "Descriptors.h"
+               #include "Lib/MagstripeHW.h"
+               #include "Lib/CircularBitBuffer.h"
+
+               #include <LUFA/Version.h>
+               #include <LUFA/Drivers/USB/USB.h>
+               #include <LUFA/Drivers/USB/Class/HID.h>
+
+       /* Macros: */
+               /** Total number of tracks which can be read from the card, between 1 and 3. */
+               #define TOTAL_TRACKS       3
+       
+               /** HID keyboard keycode to indicate that no is currently pressed. */
+               #define KEY_NONE           0
+       
+               /** HID keyboard keycode to indicate that the "1" key is currently pressed. */
+               #define KEY_1              30
+
+               /** HID keyboard keycode to indicate that the "0" key is currently pressed. */
+               #define KEY_0              39
+
+               /** HID keyboard keycode to indicate that the enter key is currently pressed. */
+               #define KEY_ENTER          40
+       
+       /* Function Prototypes: */
+               void SetupHardware(void);
+               void ReadMagstripeData(void);
+               
+               void EVENT_USB_Device_ConfigurationChanged(void);
+               void EVENT_USB_Device_UnhandledControlRequest(void);
+               void EVENT_USB_Device_StartOfFrame(void);
+
+               bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
+                                                        uint8_t* const ReportID,
+                                                 const uint8_t ReportType,
+                                                        void* ReportData,
+                                                        uint16_t* const ReportSize);
+               void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
+                                                         const uint8_t ReportID, 
+                                                         const uint8_t ReportType,
+                                                         const void* ReportData,
+                                                         const uint16_t ReportSize);
+                                                                                                                 
+#endif