Projects/Magstripe/Magstripe.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Denver Gingerich (denver [at] ossguy [dot] com)
  11   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  12
  13   Permission to use, copy, modify, and distribute this software
  14   and its documentation for any purpose and without fee is hereby
  15   granted, provided that the above copyright notice appear in all
  16   copies and that both that the copyright notice and this
  17   permission notice and warranty disclaimer appear in supporting
  18   documentation, and that the name of the author not be used in
  19   advertising or publicity pertaining to distribution of the
  20   software without specific, written prior permission.
  21
  22   The author disclaim all warranties with regard to this
  23   software, including all implied warranties of merchantability
  24   and fitness.  In no event shall the author be liable for any
  25   special, indirect or consequential damages or any damages
  26   whatsoever resulting from loss of use, data or profits, whether
  27   in an action of contract, negligence or other tortious action,
  28   arising out of or in connection with the use or performance of
  29   this software.
  30 */
  31
  32 /** \file
  33  *
  34  *  Header file for Magstripe.c.
  35  */
  36
  37 #ifndef _MAGSTRIPE_H_
  38 #define _MAGSTRIPE_H_
  39
  40         /* Includes: */
  41                 #include <avr/io.h>
  42                 #include <avr/wdt.h>
  43                 #include <avr/power.h>
  44
  45                 #include "Descriptors.h"
  46                 #include "Lib/MagstripeHW.h"
  47                 #include "Lib/CircularBitBuffer.h"
  48
  49                 #include <LUFA/Version.h>
  50                 #include <LUFA/Drivers/USB/USB.h>
  51                 #include <LUFA/Drivers/USB/Class/HID.h>
  52
  53         /* Macros: */
  54                 /** Total number of tracks which can be read from the card, between 1 and 3. */
  55                 #define TOTAL_TRACKS       3
  56
  57                 /** HID keyboard keycode to indicate that no is currently pressed. */
  58                 #define KEY_NONE           0
  59
  60                 /** HID keyboard keycode to indicate that the "1" key is currently pressed. */
  61                 #define KEY_1              30
  62
  63                 /** HID keyboard keycode to indicate that the "0" key is currently pressed. */
  64                 #define KEY_0              39
  65
  66                 /** HID keyboard keycode to indicate that the enter key is currently pressed. */
  67                 #define KEY_ENTER          40
  68
  69         /* Type Defines: */
  70                 /** Type define for the keyboard report structure. This structure matches the report layout
  71                  *  given to the host in the HID Report descriptor, as well as matches the boot protocol report
  72                  *  structure. This means that this one report structure can be used in both Report and Boot Protocol
  73                  *  modes. */
  74                 typedef struct
  75                 {
  76                         uint8_t Modifier; /**< Modifier byte, indicating pressed modifier keys such as CTRL or ALT */
  77                         uint8_t Reserved; /**< Reserved for OEM use, always set to 0 */
  78                         uint8_t KeyCode; /**< Key code array for pressed keys - up to six can be given simultaneously */
  79                 } USB_KeyboardReport_Data_t;
  80
  81         /* Function Prototypes: */
  82                 void SetupHardware(void);
  83                 void ReadMagstripeData(void);
  84
  85                 void EVENT_USB_Device_ConfigurationChanged(void);
  86                 void EVENT_USB_Device_UnhandledControlRequest(void);
  87
  88                 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
  89                                                  void* ReportData, uint16_t* ReportSize);
  90                 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
  91                                                           const void* ReportData, const uint16_t ReportSize);
  92
  93 #endif