Moved all source to the trunk directory.
authorDean Camera <dean@fourwalledcubicle.com>
Mon, 23 Feb 2009 07:08:24 +0000 (07:08 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Mon, 23 Feb 2009 07:08:24 +0000 (07:08 +0000)
26 files changed:
Projects/AVRISP_Programmer/AVRISP_Firmware_Design.txt [new file with mode: 0644]
Projects/AVRISP_Programmer/AVRISP_Programmer.aps [new file with mode: 0644]
Projects/AVRISP_Programmer/AVRISP_Programmer.c [new file with mode: 0644]
Projects/AVRISP_Programmer/AVRISP_Programmer.h [new file with mode: 0644]
Projects/AVRISP_Programmer/AVRISP_Programmer.txt [new file with mode: 0644]
Projects/AVRISP_Programmer/AVRISP_Programmer_Picture.jpg [new file with mode: 0644]
Projects/AVRISP_Programmer/Descriptors.c [new file with mode: 0644]
Projects/AVRISP_Programmer/Descriptors.h [new file with mode: 0644]
Projects/AVRISP_Programmer/Doxygen.conf [new file with mode: 0644]
Projects/AVRISP_Programmer/LUFA AVRISP_Programmer.inf [new file with mode: 0644]
Projects/AVRISP_Programmer/RingBuff.c [new file with mode: 0644]
Projects/AVRISP_Programmer/RingBuff.h [new file with mode: 0644]
Projects/AVRISP_Programmer/Sample_Programming_Session.txt [new file with mode: 0644]
Projects/AVRISP_Programmer/makefile [new file with mode: 0644]
Projects/Magstripe/CircularBitBuffer.c [new file with mode: 0644]
Projects/Magstripe/CircularBitBuffer.h [new file with mode: 0644]
Projects/Magstripe/Descriptors.c [new file with mode: 0644]
Projects/Magstripe/Descriptors.h [new file with mode: 0644]
Projects/Magstripe/Doxygen.conf [new file with mode: 0644]
Projects/Magstripe/Magstripe.aps [new file with mode: 0644]
Projects/Magstripe/Magstripe.c [new file with mode: 0644]
Projects/Magstripe/Magstripe.h [new file with mode: 0644]
Projects/Magstripe/Magstripe.txt [new file with mode: 0644]
Projects/Magstripe/MagstripeHW.h [new file with mode: 0644]
Projects/Magstripe/makefile [new file with mode: 0644]
Projects/makefile [new file with mode: 0644]

diff --git a/Projects/AVRISP_Programmer/AVRISP_Firmware_Design.txt b/Projects/AVRISP_Programmer/AVRISP_Firmware_Design.txt
new file mode 100644 (file)
index 0000000..643454d
--- /dev/null
@@ -0,0 +1,176 @@
+Instructions for converting the LUFA USBtoSerial Demo to an AVR ISP Programmer.\r
+By Opendous Inc., Copyright under the Creative Commons Attribution License:\r
+http://creativecommons.org/licenses/by/3.0/\r
+\r
+1) Start with the LUFA/Demos/USBtoSerial firmware.\r
+    - rename USBtoSerial.c, USBtoSerial.h, and USBtoSerial.aps to\r
+      AVRISP_Programmer.*\r
+    - edit AVRISP_Programmer.aps and rename all instances of "USBtoSerial" to\r
+      "AVRISP_Programmer"\r
+    - copy AVRISP_Programmer.txt from an older version of AVRISP_Programmer\r
+\r
+2) Edit makefile by changing TARGET from "USBtoSerial" to "AVRISP_Programmer"\r
+\r
+3) Edit AVRISP_Programmer.h:\r
+    - change ifdef _USB_TO_SERIAL_H to _AVRISP_PROGRAMMER_H_\r
+    - rename ReconfigureUSART(void) to ReconfigureSPI(void)\r
+    - add  void processHostSPIRequest(void);  &  void delay_ms(uint8_t dly);\r
+    - replace the define for Serial.h with one for SPI.h:\r
+      #include <libs/LUFA/Drivers/AT90USBXXX/SPI.h>\r
+\r
+4) Make alterations to Descriptors.c\r
+    - change manufacturer string to "www.AVRopendous.org", length=19\r
+    - change product string to "LUFA-Based AVR ISP Programmer", length=29\r
+\r
+5) Edit Ringbuff.h to enable the Peek Command:  #define BUFF_USEPEEK\r
+\r
+6) Edit AVRISP_Programmer.c:\r
+    - change #include "USBtoSerial.h"  to  #include "AVRISP_Programmer.h"\r
+    - change BUTTLOADTAG(ProjName to "LUFA AVR910 ISP Programmer"\r
+    - in main(), rename ReconfigureUSART() to Reconfigure();\r
+    - in EVENT_HANDLER(USB_UnhandledControlPacket), rename ReconfigureUSART\r
+    - delete the ISRs: ISR(USART1_RX_vect)  &  ISR(USART1_TX_vect)\r
+    - delete ReconfigureUSART(void)\r
+    - add  void ReconfigureSPI(void),  void processHostSPIRequest(void),\r
+      and  void delay_ms(uint8_t dly)  from a previous version\r
+    - add Timer1 and SPI initialization code to main():\r
+           /* Hardware Initialization */\r
+           //LEDs_Init();\r
+           DDRB = 0;\r
+           PORTB = 0;\r
+           DDRC |= ((1 << PC2) | (1 << PC4) | (1 << PC5) | (1 << PC6) | (1 << PC7)); //AT90USBxx2\r
+           // PC2 is also used for RESET, so set it HIGH initially - note 'P' command sets it to LOW (Active)\r
+           PORTC |= ((1 << PC2) | (1 << PC4) | (1 << PC5) | (1 << PC6) | (1 << PC7)); //AT90USBxx2\r
+           DDRD = 0;\r
+           PORTD = (1 << PB7); // only PB7(HWB) should be High as this is the bootloader pin\r
+           // Prepare PortB for SPI - set PB0(^SS), PB1(SCK), PB2(MOSI) as output as well as all other pins except PB3(MISO)\r
+           DDRB = (1 << PB0) | (1 << PB1) | (1 << PB2) | (0 << PB3) | (1 << PB4) | (1 << PB5) | (1 << PB6) | (1 << PB7);\r
+           PORTB |= (1 << PB0);\r
+\r
+           // initialize Timer1 for use in delay function\r
+           TCCR1A = 0;\r
+           //TCCR1B = (1 << CS10); // no prescaling, use CLK\r
+           TCCR1B = ((1 << CS12) | (1 << CS10)); // prescale by CLK/1024\r
+           // 8MHz/1024 = 7813 ticks per second --> ~8 ticks per millisecond (ms)\r
+           timerval = TCNT1; // start timer1\r
+\r
+    - In TASK(CDC_Task) in the\r
+        if (USB_IsConnected) {\r
+            if (Endpoint_ReadWriteAllowed()) {\r
+                while (Endpoint_BytesInEndpoint()) {\r
+                    ...\r
+      structure, after  Buffer_StoreElement(&Rx_Buffer, Endpoint_Read_Byte()):\r
+\r
+        /* Each time there is an element, check which comand should be\r
+               run and if enough data is available to run that command.\r
+               There are 1-byte, 2-byte, 3-byte, 4-byte commands, and 5-byte commands\r
+               Remember that the "which command" byte counts as 1 */\r
+        if (Rx_Buffer.Elements == 0) {\r
+               // do nothing, wait for data\r
+        } else {\r
+               tempByte = Buffer_PeekElement(&Rx_Buffer); // peek at first element\r
+\r
+                       /* make sure the issued command and associated data are all ready */\r
+               if (Rx_Buffer.Elements == 1) { // zero data byte command\r
+                       if ((tempByte == 'P') | (tempByte == 'a') | (tempByte == 'm') |\r
+                       (tempByte == 'R') | (tempByte == 'd') | (tempByte == 'e') |\r
+                       (tempByte == 'L') | (tempByte == 's') | (tempByte == 't') | \r
+                       (tempByte == 'S') | (tempByte == 'V') | (tempByte == 'v') |\r
+                       (tempByte == 'p') | (tempByte == 'F')) {\r
+               processHostSPIRequest(); // command has enough data, process it\r
+                       }\r
+               } else if (Rx_Buffer.Elements == 2) { // one data byte command\r
+                       if ((tempByte == 'T') | (tempByte == 'c') | (tempByte == 'C') |\r
+                               (tempByte == 'D') | (tempByte == 'l') | (tempByte == 'f') |\r
+                               (tempByte == 'x') | (tempByte == 'y')) {\r
+                               processHostSPIRequest(); // command has enough data, process it\r
+                       }\r
+               } else if (Rx_Buffer.Elements == 3) { // two data byte command\r
+                       if ((tempByte == 'A') | (tempByte == 'Z')) {\r
+                               processHostSPIRequest(); // command has enough data, process it\r
+                       }\r
+               } else if (Rx_Buffer.Elements == 4) { // three data byte command\r
+                       if ((tempByte == ':')) {\r
+               processHostSPIRequest(); // command has enough data, process it\r
+                       }\r
+               } else if (Rx_Buffer.Elements == 5) { // four data byte command\r
+                       if ((tempByte == '.')) {\r
+                               processHostSPIRequest(); // command has enough data, process it\r
+                       }\r
+               } else {\r
+                       // do nothing\r
+               }\r
+        }\r
+\r
+    - need to add code to flush the buffer.  Change:\r
+        /* Check if Rx buffer contains data */\r
+               if (Rx_Buffer.Elements)\r
+               {\r
+                       /* Initiate the transmission of the buffer contents if USART idle*/\r
+                       if (!(Transmitting))\r
+                       {\r
+                               Transmitting = true;\r
+                               Serial_TxByte(Buffer_GetElement(&Rx_Buffer));\r
+                       }\r
+               }\r
+      To:\r
+        /* Check if Rx buffer contains data */\r
+               if (Rx_Buffer.Elements)\r
+               {\r
+                       /* Initiate the transmission of the buffer contents if USART idle*/\r
+                       if (!(Transmitting))\r
+                       {\r
+                               Transmitting = true;\r
+                               /* The following flushes the receive buffer to prepare for new\r
+                   data and commands. Need to flush the buffer as the command\r
+                   byte which is peeked above needs to be dealt with, otherwise\r
+                   the command bytes will overflow the buffer eventually */\r
+                               //Buffer_GetElement(&Rx_Buffer); // also works\r
+                               Buffer_Initialize(&Rx_Buffer);\r
+                       }\r
+               }\r
+\r
+    - need to add the following defines and globals:\r
+        #define RESETPORT       PORTB\r
+        #define RESETPIN        PB0\r
+        #define RESETPORT2      PORTC\r
+        #define RESETPIN2       PC2\r
+        #define CR_HEX          '\r'\r
+\r
+        #define DELAY_VERYSHORT    0x01\r
+        #define DELAY_SHORT        0x02\r
+        #define DELAY_MEDIUM       0x03\r
+        #define DELAY_LONG         0x05\r
+        #define DELAY_MULTIPLE     0x04\r
+\r
+        /*  AVR Device Codes - Can have a maximum of 14 but can be any you want.\r
+            Note that these are completely irrelevent.  If AVRdude supports a\r
+            device, then that device is programmable.  Use -F switch to ignore\r
+            device codes. */\r
+        #define AVRDEVCODE01   0x55 /* ATtiny12 */\r
+        #define AVRDEVCODE02   0x56 /* ATtiny15 */\r
+        #define AVRDEVCODE03   0x5E /* ATtiny261 */\r
+        #define AVRDEVCODE04   0x76 /* ATmega8 */\r
+        #define AVRDEVCODE05   0x74 /* ATmega16 */\r
+        #define AVRDEVCODE06   0x72 /* ATmega32 */\r
+        #define AVRDEVCODE07   0x45 /* ATmega64 */\r
+        #define AVRDEVCODE08   0x74 /* ATmega644 */\r
+        #define AVRDEVCODE09   0x43 /* ATmega128 */\r
+        #define AVRDEVCODE10   0x63 /* ATmega162 */\r
+        #define AVRDEVCODE11   0x78 /* ATmega169 */\r
+        #define AVRDEVCODE12   0x6C /* AT90S4434 */\r
+        #define AVRDEVCODE13   0x38 /* AT90S8515A */\r
+        #define AVRDEVCODE14   0x65 /* AT90S8555 */\r
+\r
+        /* some global variables used throughout */\r
+        uint8_t tempIOreg = 0;\r
+        uint8_t tempIOreg2 = 0;\r
+        uint8_t tempIOreg3 = 0;\r
+        uint8_t tempIOreg4 = 0;\r
+        uint8_t dataWidth = 0;\r
+        uint8_t firstRun = 1;\r
+        uint8_t deviceCode = 0;\r
+        uint8_t tempByte = 0;\r
+        uint16_t currAddress = 0;\r
+        uint16_t timerval = 0;\r
+\r
diff --git a/Projects/AVRISP_Programmer/AVRISP_Programmer.aps b/Projects/AVRISP_Programmer/AVRISP_Programmer.aps
new file mode 100644 (file)
index 0000000..7480023
--- /dev/null
@@ -0,0 +1 @@
+<AVRStudio><MANAGEMENT><ProjectName>AVRISP_Programmer</ProjectName><Created>30-Sep-2008 14:18:39</Created><LastEdit>30-Sep-2008 14:18:52</LastEdit><ICON>241</ICON><ProjectType>0</ProjectType><Created>30-Sep-2008 14:18:39</Created><Version>4</Version><Build>4, 14, 0, 589</Build><ProjectTypeName>AVR GCC</ProjectTypeName></MANAGEMENT><CODE_CREATION><ObjectFile></ObjectFile><EntryFile></EntryFile><SaveFolder>C:\Users\Dean\Documents\Electronics\Projects\WORK\MyUSBWORK\Demos\AVRISP_Programmer\</SaveFolder></CODE_CREATION><DEBUG_TARGET><CURRENT_TARGET></CURRENT_TARGET><CURRENT_PART></CURRENT_PART><BREAKPOINTS></BREAKPOINTS><IO_EXPAND><HIDE>false</HIDE></IO_EXPAND><REGISTERNAMES><Register>R00</Register><Register>R01</Register><Register>R02</Register><Register>R03</Register><Register>R04</Register><Register>R05</Register><Register>R06</Register><Register>R07</Register><Register>R08</Register><Register>R09</Register><Register>R10</Register><Register>R11</Register><Register>R12</Register><Register>R13</Register><Register>R14</Register><Register>R15</Register><Register>R16</Register><Register>R17</Register><Register>R18</Register><Register>R19</Register><Register>R20</Register><Register>R21</Register><Register>R22</Register><Register>R23</Register><Register>R24</Register><Register>R25</Register><Register>R26</Register><Register>R27</Register><Register>R28</Register><Register>R29</Register><Register>R30</Register><Register>R31</Register></REGISTERNAMES><COM>Auto</COM><COMType>0</COMType><WATCHNUM>0</WATCHNUM><WATCHNAMES><Pane0></Pane0><Pane1></Pane1><Pane2></Pane2><Pane3></Pane3></WATCHNAMES><BreakOnTrcaeFull>0</BreakOnTrcaeFull></DEBUG_TARGET><Debugger><Triggers></Triggers></Debugger><AVRGCCPLUGIN><FILES><SOURCEFILE>Descriptors.c</SOURCEFILE><SOURCEFILE>RingBuff.c</SOURCEFILE><SOURCEFILE>AVRISP_Programmer.c</SOURCEFILE><HEADERFILE>Descriptors.h</HEADERFILE><HEADERFILE>RingBuff.h</HEADERFILE><HEADERFILE>AVRISP_Programmer.h</HEADERFILE><OTHERFILE>makefile</OTHERFILE></FILES><CONFIGS><CONFIG><NAME>default</NAME><USESEXTERNALMAKEFILE>YES</USESEXTERNALMAKEFILE><EXTERNALMAKEFILE>makefile</EXTERNALMAKEFILE><PART>atmega128</PART><HEX>1</HEX><LIST>1</LIST><MAP>1</MAP><OUTPUTFILENAME>AVRISP_Programmer.elf</OUTPUTFILENAME><OUTPUTDIR>default\</OUTPUTDIR><ISDIRTY>1</ISDIRTY><OPTIONS/><INCDIRS/><LIBDIRS/><LIBS/><LINKOBJECTS/><OPTIONSFORALL>-Wall -gdwarf-2 -std=gnu99 -Os -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums</OPTIONSFORALL><LINKEROPTIONS></LINKEROPTIONS><SEGMENTS/></CONFIG></CONFIGS><LASTCONFIG>default</LASTCONFIG><USES_WINAVR>1</USES_WINAVR><GCC_LOC>C:\WinAVR-20080512\bin\avr-gcc.exe</GCC_LOC><MAKE_LOC>C:\WinAVR-20080512\utils\bin\make.exe</MAKE_LOC></AVRGCCPLUGIN><IOView><usergroups/><sort sorted="0" column="0" ordername="0" orderaddress="0" ordergroup="0"/></IOView><Files></Files><Events><Bookmarks></Bookmarks></Events><Trace><Filters></Filters></Trace></AVRStudio>\r
diff --git a/Projects/AVRISP_Programmer/AVRISP_Programmer.c b/Projects/AVRISP_Programmer/AVRISP_Programmer.c
new file mode 100644 (file)
index 0000000..4dc18cd
--- /dev/null
@@ -0,0 +1,886 @@
+/*\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  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  AVR ISP Programmer code Copyright 2009  Opendous Inc. (www.opendous.org)\r
+  For more info and usage instructions for this firmware, visit:\r
+  http://code.google.com/p/avropendous/wiki/AVR_ISP_Programmer\r
+\r
+  Note that this firmware is designed to work with AVRdude:\r
+  http://savannah.nongnu.org/projects/avrdude\r
+  But should work with other software that supports the AVR910 ISP\r
+  programmer or STK200 hardware.\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
+/*\r
+    Usage:\r
+     avrdude -vv -F -P COM7 -c avr910 -p t261\r
+       Note -F flag which overrides signature check and enables programming\r
+       of any "In-System Programmable via SPI Port" AVR MCU.  Part number,\r
+       t261, should be set to your target device.\r
+     avrdude -vv -F -P COM7 -c avr910 -p t261 -U flash:w:PROG.hex\r
+       PROG.hex is the hex file to program your t261 AVR with\r
+     avrdude -vv -F -P COM7 -b 115200 -c avr910 -p t261 -U flash:w:test.hex\r
+       The -b 115200 sets the SPI clock to 62.5kHz from the default 125kHz and may\r
+       work when the default programming speed fails.\r
+     AVROSP.exe -dATtiny261 -cCOM7 -rf\r
+       AVRosp is the Open Source AVR ISP Programming Software available from Atmel.com\r
+\r
+    Note: on Linux systems, COM7 should be replaced with someting like /dev/ttyACM0\r
+          You can determine this value by running dmesg after plugging in the device\r
+    Note: you must RESET the programmer after each use (AVRdude session).\r
+\r
+    Note: If you experience errors with older devices, try changing the DELAY defines\r
+\r
+    MISO, MOSI, and SCK are connected directly from the AVRopendous board\r
+    to the pin of the same functionality on the target.  RESET pin on the target\r
+    can be connected either to SS (PB0), or PC2.  Do not have any other pins\r
+    connected - especially HWB pin, to avoid unintentional behaviour.\r
+\r
+    AVR910 functionality was overlayed on USBtoSerial  functionality.\r
+    Keep this in mind when looking over the code.\r
+    Default target speed is 125kHz and corresponds to 19200 baud, which\r
+    is the default setting for AVRdude.\r
+\r
+    Changing "Baud-Rate" will change the SPI speed.  Defualt SPI clock speed\r
+    is 8Mhz / 4 = 2MHz.  8Mhz is the device clock speed.  This is the setting at\r
+    9600 baud.  The following is a table of baud-rate vs. SPI Speed that will result\r
+         9600 = 2Mhz\r
+         14400 = 1MHz\r
+         19200 = 125kHz (AVRdude Default)\r
+         38400 = 250kHz\r
+         57600 = 500kHz\r
+         115200 = 62.5kHz\r
+\r
+       Before running, you will need to install the INF file that\r
+       is located in the project directory. This will enable\r
+       Windows to use its inbuilt CDC drivers, negating the need\r
+       for special Windows drivers for the device. To install,\r
+       right-click the .INF file and choose the Install option.\r
+*/\r
+\r
+/*     TODO: - fix the requirement that a RESET must be performed after each session, which\r
+            is only an issue under Windows.  Everything works fine under Linux\r
+*/\r
+\r
+#include "AVRISP_Programmer.h"\r
+\r
+/* Project Tags, for reading out using the ButtLoad project */\r
+BUTTLOADTAG(ProjName,    "LUFA AVR910 ISP Programmer");\r
+BUTTLOADTAG(BuildTime,   __TIME__);\r
+BUTTLOADTAG(BuildDate,   __DATE__);\r
+BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\r
+\r
+\r
+#define RESETPORT       PORTB\r
+#define RESETPIN        PB0\r
+#define RESETPORT2      PORTC\r
+#define RESETPIN2       PC2\r
+#define CR_HEX          '\r'\r
+\r
+#define DELAY_VERYSHORT    0x01\r
+#define DELAY_SHORT        0x02\r
+#define DELAY_MEDIUM       0x03\r
+#define DELAY_LONG         0x05\r
+#define DELAY_MULTIPLE     0x02\r
+\r
+\r
+/*  AVR Device Codes - Can have a maximum of 14 but can be any you want.\r
+    Note that these are completely irrelevent.  If AVRdude supports a device,\r
+    then that device is programmable.  Use -F switch to ignore device codes. */\r
+#define AVRDEVCODE01   0x55 /* ATtiny12 */\r
+#define AVRDEVCODE02   0x56 /* ATtiny15 */\r
+#define AVRDEVCODE03   0x5E /* ATtiny261 */\r
+#define AVRDEVCODE04   0x76 /* ATmega8 */\r
+#define AVRDEVCODE05   0x74 /*ATmega16 */\r
+#define AVRDEVCODE06   0x72 /* ATmega32 */\r
+#define AVRDEVCODE07   0x45 /* ATmega64 */\r
+#define AVRDEVCODE08   0x74 /* ATmega644 */\r
+#define AVRDEVCODE09   0x43 /* ATmega128 */\r
+#define AVRDEVCODE10   0x63 /* ATmega162 */\r
+#define AVRDEVCODE11   0x78 /* ATmega169 */\r
+#define AVRDEVCODE12   0x6C /* AT90S4434 */\r
+#define AVRDEVCODE13   0x38 /* AT90S8515A */\r
+#define AVRDEVCODE14   0x65 /* AT90S8555 */\r
+\r
+\r
+/* Scheduler Task List */\r
+TASK_LIST\r
+{\r
+       { Task: USB_USBTask          , TaskStatus: TASK_STOP },\r
+       { Task: CDC_Task             , TaskStatus: TASK_STOP },\r
+};\r
+\r
+/* Globals: */\r
+/** Contains the current baud rate and other settings of the virtual serial port.\r
+ *\r
+    These values are set by the host via a class-specific request, and the physical USART should be reconfigured to match the\r
+    new settings each time they are changed by the host.\r
+ */\r
+CDC_Line_Coding_t LineCoding = { BaudRateBPS: 9600,\r
+                                 CharFormat:  OneStopBit,\r
+                                 ParityType:  Parity_None,\r
+                                 DataBits:    8            };\r
+\r
+/** Ring (circular) buffer to hold the RX data - data from the host to the attached device on the serial port. */\r
+RingBuff_t Rx_Buffer;\r
+\r
+/** Ring (circular) buffer to hold the TX data - data from the attached device on the serial port to the host. */\r
+RingBuff_t Tx_Buffer;\r
+\r
+/** Flag to indicate if the USART is currently transmitting data from the Rx_Buffer circular buffer. */\r
+volatile bool Transmitting = false;\r
+\r
+\r
+/* some global variables used throughout */\r
+uint8_t tempIOreg = 0;\r
+uint8_t tempIOreg2 = 0;\r
+uint8_t tempIOreg3 = 0;\r
+uint8_t tempIOreg4 = 0;\r
+uint8_t dataWidth = 0;\r
+uint8_t firstRun = 1;\r
+uint8_t deviceCode = 0;\r
+uint8_t tempByte = 0;\r
+uint16_t currAddress = 0;\r
+uint16_t timerval = 0;\r
+\r
+\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
+{\r
+       /* Disable watchdog if enabled by bootloader/fuses */\r
+       MCUSR &= ~(1 << WDRF);\r
+       wdt_disable();\r
+\r
+       /* Disable Clock Division */\r
+       SetSystemClockPrescaler(0);\r
+\r
+       /* Hardware Initialization */\r
+       LEDs_Init();\r
+       ReconfigureSPI();\r
+    // prepare PortB\r
+       DDRB = 0;\r
+       PORTB = 0;\r
+       DDRC |= ((1 << PC2) | (1 << PC4) | (1 << PC5) | (1 << PC6) | (1 << PC7)); //AT90USBxx2\r
+       // PC2 is also used for RESET, so set it HIGH initially - note 'P' command sets it to LOW (Active)\r
+       PORTC |= ((1 << PC2) | (1 << PC4) | (1 << PC5) | (1 << PC6) | (1 << PC7)); //AT90USBxx2\r
+       DDRD = 0;\r
+       PORTD = (1 << PB7); // only PB7(HWB) should be High as this is the bootloader pin\r
+       // Prepare PortB for SPI - set PB0(^SS), PB1(SCK), PB2(MOSI) as output as well as all other pins except PB3(MISO)\r
+       DDRB = (1 << PB0) | (1 << PB1) | (1 << PB2) | (0 << PB3) | (1 << PB4) | (1 << PB5) | (1 << PB6) | (1 << PB7);\r
+       PORTB |= (1 << PB0);\r
+    // make sure DataFlash devices to not interfere - deselect them by setting PE0 and PE1 HIGH:\r
+    PORTE = 0xFF;\r
+    DDRE = 0xFF;\r
+\r
+       // initialize Timer1 for use in delay function\r
+       TCCR1A = 0;\r
+       //TCCR1B = (1 << CS10); // no prescaling, use CLK\r
+       TCCR1B = ((1 << CS12) | (1 << CS10)); // prescale by CLK/1024\r
+       // 8MHz/1024 = 7813 ticks per second --> ~8 ticks per millisecond (ms)\r
+       timerval = TCNT1; // start timer1\r
+\r
+\r
+       /* Ringbuffer Initialization */\r
+       Buffer_Initialize(&Rx_Buffer);\r
+       Buffer_Initialize(&Tx_Buffer);\r
+       \r
+       /* Indicate USB not ready */\r
+       UpdateStatus(Status_USBNotReady);\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 indicates that the device is enumerating via the status LEDs and\r
+    starts the library USB task to begin the enumeration and USB management process.\r
+ */\r
+EVENT_HANDLER(USB_Connect)\r
+{\r
+       /* Start USB management task */\r
+       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
+\r
+       /* Indicate USB enumerating */\r
+       UpdateStatus(Status_USBEnumerating);\r
+}\r
+\r
+/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via\r
+    the status LEDs and stops the USB management and CDC management tasks.\r
+ */\r
+EVENT_HANDLER(USB_Disconnect)\r
+{\r
+       /* Stop running CDC and USB management tasks */\r
+       Scheduler_SetTaskMode(CDC_Task, TASK_STOP);\r
+       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
+\r
+       /* Indicate USB not ready */\r
+       UpdateStatus(Status_USBNotReady);\r
+}\r
+\r
+/** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration\r
+    of the USB device after enumeration - the device endpoints are configured and the CDC management task started.\r
+ */\r
+EVENT_HANDLER(USB_ConfigurationChanged)\r
+{\r
+       /* Setup CDC Notification, Rx and Tx Endpoints */\r
+       Endpoint_ConfigureEndpoint(CDC_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT,\r
+                                      ENDPOINT_DIR_IN, CDC_NOTIFICATION_EPSIZE,\r
+                                  ENDPOINT_BANK_SINGLE);\r
+\r
+       Endpoint_ConfigureEndpoint(CDC_TX_EPNUM, EP_TYPE_BULK,\r
+                                      ENDPOINT_DIR_IN, CDC_TXRX_EPSIZE,\r
+                                  ENDPOINT_BANK_SINGLE);\r
+\r
+       Endpoint_ConfigureEndpoint(CDC_RX_EPNUM, EP_TYPE_BULK,\r
+                                      ENDPOINT_DIR_OUT, CDC_TXRX_EPSIZE,\r
+                                  ENDPOINT_BANK_SINGLE);\r
+\r
+       /* Indicate USB connected and ready */\r
+       UpdateStatus(Status_USBReady);\r
+\r
+       /* Start CDC task */\r
+       Scheduler_SetTaskMode(CDC_Task, 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 (including the CDC control commands,\r
+    which are all issued via the control endpoint), so that they can be handled appropriately for the application.\r
+ */\r
+EVENT_HANDLER(USB_UnhandledControlPacket)\r
+{\r
+       uint8_t* LineCodingData = (uint8_t*)&LineCoding;\r
+\r
+       /* Process CDC specific control requests */\r
+       switch (bRequest)\r
+       {\r
+               case REQ_GetLineEncoding:\r
+                       if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       {       \r
+                               /* Acknowedge the SETUP packet, ready for data transfer */\r
+                               Endpoint_ClearSetupReceived();\r
+\r
+                               /* Write the line coding data to the control endpoint */\r
+                               Endpoint_Write_Control_Stream_LE(LineCodingData, sizeof(LineCoding));\r
+                               \r
+                               /* Finalize the stream transfer to send the last packet or clear the host abort */\r
+                               Endpoint_ClearSetupOUT();\r
+                       }\r
+                       \r
+                       break;\r
+               case REQ_SetLineEncoding:\r
+                       if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       {\r
+                               /* Acknowedge the SETUP packet, ready for data transfer */\r
+                               Endpoint_ClearSetupReceived();\r
+\r
+                               /* Read the line coding data in from the host into the global struct */\r
+                               Endpoint_Read_Control_Stream_LE(LineCodingData, sizeof(LineCoding));\r
+\r
+                               /* Finalize the stream transfer to clear the last packet from the host */\r
+                               Endpoint_ClearSetupIN();\r
+                               \r
+                               /* Reconfigure the USART with the new settings */\r
+                               ReconfigureSPI();\r
+                       }\r
+       \r
+                       break;\r
+               case REQ_SetControlLineState:\r
+                       if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       {\r
+#if 0\r
+                               /* NOTE: Here you can read in the line state mask from the host, to get the current state of the output handshake\r
+                                        lines. The mask is read in from the wValue parameter, and can be masked against the CONTROL_LINE_OUT_* masks\r
+                                        to determine the RTS and DTR line states using the following code:\r
+                               */\r
+\r
+                               uint16_t wIndex = Endpoint_Read_Word_LE();\r
+                                       \r
+                               // Do something with the given line states in wIndex\r
+#endif\r
+                               \r
+                               /* Acknowedge the SETUP packet, ready for data transfer */\r
+                               Endpoint_ClearSetupReceived();\r
+                               \r
+                               /* Send an empty packet to acknowedge the command */\r
+                               Endpoint_ClearSetupIN();\r
+                       }\r
+       \r
+                       break;\r
+       }\r
+}\r
+\r
+/** Task to manage CDC data transmission and reception to and from the host, from and to the physical USART. */\r
+TASK(CDC_Task)\r
+{\r
+       if (USB_IsConnected)\r
+       {\r
+#if 0\r
+               /* NOTE: Here you can use the notification endpoint to send back line state changes to the host, for the special RS-232\r
+                                handshake signal lines (and some error states), via the CONTROL_LINE_IN_* masks and the following code:\r
+               */\r
+\r
+               USB_Notification_Header_t Notification = (USB_Notification_Header_t)\r
+                       {\r
+                               NotificationType: (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),\r
+                               Notification:     NOTIF_SerialState,\r
+                               wValue:           0,\r
+                               wIndex:           0,\r
+                               wLength:          sizeof(uint16_t),\r
+                       };\r
+                       \r
+               uint16_t LineStateMask;\r
+               \r
+               // Set LineStateMask here to a mask of CONTROL_LINE_IN_* masks to set the input handshake line states to send to the host\r
+               \r
+               Endpoint_SelectEndpoint(CDC_NOTIFICATION_EPNUM);\r
+               Endpoint_Write_Stream_LE(&Notification, sizeof(Notification));\r
+               Endpoint_Write_Stream_LE(&LineStateMask, sizeof(LineStateMask));\r
+               Endpoint_ClearCurrentBank();\r
+#endif\r
+\r
+               /* Select the Serial Rx Endpoint */\r
+               Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
+               \r
+               if (Endpoint_ReadWriteAllowed())\r
+               {\r
+                       /* Read the received data endpoint into the transmission buffer */\r
+                       while (Endpoint_BytesInEndpoint())\r
+                       {\r
+                               /* Wait until the buffer has space for a new character */\r
+                               while (!((BUFF_STATICSIZE - Rx_Buffer.Elements)));\r
+                       \r
+                               /* Store each character from the endpoint */\r
+                               Buffer_StoreElement(&Rx_Buffer, Endpoint_Read_Byte());\r
+\r
+\r
+\r
+\r
+                /* Each time there is an element, check which comand should be\r
+                       run and if enough data is available to run that command.\r
+                       There are 1-byte, 2-byte, 3-byte, 4-byte commands, and 5-byte commands\r
+                       Remember that the "which command" byte counts as 1 */\r
+                if (Rx_Buffer.Elements == 0) {\r
+                       // do nothing, wait for data\r
+                } else {\r
+                       tempByte = Buffer_PeekElement(&Rx_Buffer); // peek at first element\r
+\r
+                               /* make sure the issued command and associated data are all ready */\r
+                       if (Rx_Buffer.Elements == 1) { // zero data byte command\r
+                               if ((tempByte == 'P') | (tempByte == 'a') | (tempByte == 'm') |\r
+                               (tempByte == 'R') | (tempByte == 'd') | (tempByte == 'e') |\r
+                               (tempByte == 'L') | (tempByte == 's') | (tempByte == 't') | \r
+                               (tempByte == 'S') | (tempByte == 'V') | (tempByte == 'v') |\r
+                               (tempByte == 'p') | (tempByte == 'F')) {\r
+                       processHostSPIRequest(); // command has enough data, process it\r
+                               }\r
+                       } else if (Rx_Buffer.Elements == 2) { // one data byte command\r
+                               if ((tempByte == 'T') | (tempByte == 'c') | (tempByte == 'C') |\r
+                                       (tempByte == 'D') | (tempByte == 'l') | (tempByte == 'f') |\r
+                                       (tempByte == 'x') | (tempByte == 'y')) {\r
+                                       processHostSPIRequest(); // command has enough data, process it\r
+                               }\r
+                       } else if (Rx_Buffer.Elements == 3) { // two data byte command\r
+                               if ((tempByte == 'A') | (tempByte == 'Z')) {\r
+                                       processHostSPIRequest(); // command has enough data, process it\r
+                               }\r
+                       } else if (Rx_Buffer.Elements == 4) { // three data byte command\r
+                               if ((tempByte == ':')) {\r
+                       processHostSPIRequest(); // command has enough data, process it\r
+                               }\r
+                       } else if (Rx_Buffer.Elements == 5) { // four data byte command\r
+                               if ((tempByte == '.')) {\r
+                                       processHostSPIRequest(); // command has enough data, process it\r
+                               }\r
+                       } else {\r
+                               // do nothing\r
+                       }\r
+                }\r
+\r
+\r
+\r
+                       }\r
+                       \r
+                       /* Clear the endpoint buffer */\r
+                       Endpoint_ClearCurrentBank();\r
+               }\r
+               \r
+               /* Check if Rx buffer contains data */\r
+               if (Rx_Buffer.Elements)\r
+               {\r
+                       /* Initiate the transmission of the buffer contents if USART idle */\r
+                       if (!(Transmitting))\r
+                       {\r
+                               Transmitting = true;\r
+                               /* The following flushes the receive buffer to prepare for new data and commands */\r
+                               /* Need to flush the buffer as the command byte which is peeked above needs to be */\r
+                               /*  dealt with, otherwise the command bytes will overflow the buffer eventually */\r
+                               //Buffer_GetElement(&Rx_Buffer); // works also\r
+                               Buffer_Initialize(&Rx_Buffer);\r
+                       }\r
+               }\r
+\r
+               /* Select the Serial Tx Endpoint */\r
+               Endpoint_SelectEndpoint(CDC_TX_EPNUM);\r
+\r
+               /* Check if the Tx buffer contains anything to be sent to the host */\r
+               if (Tx_Buffer.Elements)\r
+               {\r
+                       /* Wait until Serial Tx Endpoint Ready for Read/Write */\r
+                       while (!(Endpoint_ReadWriteAllowed()));\r
+                       \r
+                       /* Check before sending the data if the endpoint is completely full */\r
+                       bool IsFull = (Endpoint_BytesInEndpoint() == CDC_TXRX_EPSIZE);\r
+                       \r
+                       /* Write the transmission buffer contents to the received data endpoint */\r
+                       while (Tx_Buffer.Elements && (Endpoint_BytesInEndpoint() < CDC_TXRX_EPSIZE))\r
+                         Endpoint_Write_Byte(Buffer_GetElement(&Tx_Buffer));\r
+                       \r
+                       /* Send the data */\r
+                       Endpoint_ClearCurrentBank();\r
+\r
+                       /* If a full endpoint was sent, we need to send an empty packet afterwards to terminate the transfer */\r
+                       if (IsFull)\r
+                       {\r
+                               /* Wait until Serial Tx Endpoint Ready for Read/Write */\r
+                               while (!(Endpoint_ReadWriteAllowed()));\r
+\r
+                               /* Send an empty packet to terminate the transfer */\r
+                               Endpoint_ClearCurrentBank();\r
+                       }\r
+               }\r
+       }\r
+}\r
+\r
+\r
+\r
+/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to\r
+    log to a serial port, or anything else that is suitable for status updates.\r
+ *\r
+    \param CurrentStatus  Current status of the system, from the USBtoSerial_StatusCodes_t enum\r
+ */\r
+void UpdateStatus(uint8_t CurrentStatus)\r
+{\r
+       uint8_t LEDMask = LEDS_NO_LEDS;\r
+       \r
+       /* Set the LED mask to the appropriate LED mask based on the given status code */\r
+       switch (CurrentStatus)\r
+       {\r
+               case Status_USBNotReady:\r
+                       LEDMask = (LEDS_LED1);\r
+                       break;\r
+               case Status_USBEnumerating:\r
+                       LEDMask = (LEDS_LED1 | LEDS_LED2);\r
+                       break;\r
+               case Status_USBReady:\r
+                       LEDMask = (LEDS_LED2 | LEDS_LED4);\r
+                       break;\r
+       }\r
+       \r
+       /* Set the board LEDs to the new LED mask */\r
+       LEDs_SetAllLEDs(LEDMask);\r
+}\r
+\r
+\r
+/** Reconfigures SPI to match the current serial port settings issued by the host. */\r
+void ReconfigureSPI(void)\r
+{\r
+       uint8_t SPCRmask = (1 << SPE) | (1 << MSTR); // always enable SPI as Master\r
+       uint8_t SPSRmask = 0;\r
+\r
+       /* Determine data width */\r
+       if (LineCoding.ParityType == Parity_Odd) {\r
+               dataWidth = 16;\r
+       } else if (LineCoding.ParityType == Parity_Even) {\r
+               dataWidth = 32;\r
+       } else if (LineCoding.ParityType == Parity_None) {\r
+               dataWidth = 8;\r
+       }\r
+\r
+       /* Determine stop bits - 1.5 stop bits is set as 1 stop bit due to hardware limitations */\r
+       /* For SPI, determine whether format is LSB or MSB */\r
+       if (LineCoding.CharFormat == TwoStopBits) {     \r
+               SPCRmask |= (1 << DORD);\r
+       } else if (LineCoding.CharFormat == OneStopBit) {\r
+               SPCRmask |= (0 << DORD);\r
+       }\r
+\r
+       /* Determine data size - 5, 6, 7, or 8 bits are supported */\r
+       /* Changing line coding changes SPI Mode\r
+               CPOL=0, CPHA=0 Sample (Rising) Setup (Falling) SPI-Mode0 == 8 bits line coding\r
+               CPOL=0, CPHA=1 Setup (Rising) Sample (Falling) SPI-Mode1 == 7 bits line coding\r
+               CPOL=1, CPHA=0 Sample (Falling) Setup (Rising) SPI-Mode2 == 6 bits line coding\r
+               CPOL=1, CPHA=1 Setup (Falling) Sample (Rising) SPI-Mode3 == 5 bits line coding\r
+       */\r
+       if (LineCoding.DataBits == 5) {\r
+               SPCRmask |= ((1 << CPOL) | (1 << CPHA));\r
+       } else if (LineCoding.DataBits == 6) {\r
+               SPCRmask |= ((1 << CPOL) | (0 << CPHA));\r
+       } else if (LineCoding.DataBits == 7) {\r
+               SPCRmask |= ((0 << CPOL) | (1 << CPHA));\r
+       } else if (LineCoding.DataBits == 8) {\r
+               SPCRmask |= ((0 << CPOL) | (0 << CPHA));\r
+       }\r
+\r
+\r
+       /* Set the USART baud rate register to the desired baud rate value */\r
+       /* also alter the SPI speed via value of baud rate */\r
+       if        (LineCoding.BaudRateBPS == 9600) {    // 2Mhz SPI (Fosc / 4)\r
+               SPCRmask |= ((0 << SPR1) | (0 << SPR0));\r
+               SPSRmask |= (0 << SPI2X);\r
+       } else if (LineCoding.BaudRateBPS == 14400) {   // 1Mhz SPI (Fosc / 8)\r
+               SPCRmask |= ((0 << SPR1) | (1 << SPR0));\r
+               SPSRmask |= (1 << SPI2X);\r
+       } else if (LineCoding.BaudRateBPS == 57600) {   // 500kHz SPI (Fosc / 16)\r
+               SPCRmask |= ((0 << SPR1) | (1 << SPR0));\r
+               SPSRmask |= (0 << SPI2X);\r
+       } else if (LineCoding.BaudRateBPS == 38400) {   // 250kHz SPI (Fosc / 32)\r
+               SPCRmask |= ((1 << SPR1) | (0 << SPR0));\r
+               SPSRmask |= (1 << SPI2X);\r
+       } else if (LineCoding.BaudRateBPS == 19200) {   // 125kHz SPI (Fosc / 64)\r
+               SPCRmask |= ((1 << SPR1) | (0 << SPR0));\r
+               SPSRmask |= (0 << SPI2X);\r
+       } else if (LineCoding.BaudRateBPS == 115200) {  // 62.5kHz SPI (Fosc / 128)\r
+               SPCRmask |= ((1 << SPR1) | (1 << SPR0));\r
+               SPSRmask |= (0 << SPI2X);\r
+       }\r
+\r
+       SPCR = SPCRmask;\r
+       SPSR = SPSRmask;\r
+\r
+       // only read if first run\r
+       if (firstRun) {\r
+               tempIOreg = SPSR; //need to read to initiliaze\r
+               tempIOreg = SPDR; //need to read to initiliaze\r
+               firstRun = 0;\r
+       }\r
+\r
+}\r
+\r
+\r
+/* process data according to AVR910 protocol */\r
+void processHostSPIRequest(void) {\r
+\r
+       uint8_t readByte1 = 0;\r
+       uint8_t readByte2 = 0;\r
+       uint8_t readByte3 = 0;\r
+       uint8_t readByte4 = 0;\r
+       uint8_t firstByte = 0;\r
+\r
+       /*      Taken from a90isp_ver23.asm:\r
+               +-------------+------------+------+\r
+               ;*  Commands                           | Host writes | Host reads |      |\r
+               ;*  --------                           +-----+-------+------+-----+      |\r
+               ;*                                     | ID  | data  | data |     | Note |\r
+               ;* +-----------------------------------+-----+-------+------+-----+------+\r
+               ;* | Enter programming mode            | 'P' |       |      | 13d |   1  |\r
+               ;* | Report autoincrement address      | 'a' |       |      | 'Y' |      |\r
+               ;* | Set address                       | 'A' | ah al |      | 13d |   2  |\r
+               ;* | Write program memory, low byte    | 'c' |    dd |      | 13d |   3  |\r
+               ;* | Write program memory, high byte   | 'C' |    dd |      | 13d |   3  |\r
+               ;* | Issue Page Write                  | 'm' |       |      | 13d |      |\r
+               ;* | Read program memory               | 'R' |       |dd(dd)|     |   4  |\r
+               ;* | Write data memory                 | 'D' |    dd |      | 13d |      |\r
+               ;* | Read data memory                  | 'd' |       |   dd |     |      |\r
+               ;* | Chip erase                        | 'e' |       |      | 13d |      |\r
+               ;* | Write lock bits                   | 'l' |    dd |      | 13d |      |\r
+               ;* | Write fuse bits                   | 'f' |    dd |      | 13d |  11  |\r
+               ;* | Read fuse and lock bits           | 'F' |       |   dd |     |  11  |\r
+               ;* | Leave programming mode            | 'L' |       |      | 13d |   5  |\r
+               ;* | Select device type                | 'T' |    dd |      | 13d |   6  |\r
+               ;* | Read signature bytes              | 's' |       | 3*dd |     |      |\r
+               ;* | Return supported device codes     | 't' |       | n*dd | 00d |   7  |\r
+               ;* | Return software identifier        | 'S' |       | s[7] |     |   8  |\r
+               ;* | Return sofware version            | 'V' |       |dd dd |     |   9  |\r
+               ;* | Return hardware version           | 'v' |       |dd dd |     |   9  |\r
+               ;* | Return programmer type            | 'p' |       |   dd |     |  10  |\r
+               ;* | Set LED                           | 'x' |    dd |      | 13d |  12  |\r
+               ;* | Clear LED                         | 'y' |    dd |      | 13d |  12  |\r
+               ;* | Universial command                | ':' |  3*dd |   dd | 13d |      |\r
+               ;* | New universal command                 | '.' |  4*dd |   dd | 13d |      |\r
+               ;* | Special test command                  | 'Z' |  2*dd |   dd |     |      |\r
+       */\r
+\r
+       firstByte = Buffer_GetElement(&Rx_Buffer);\r
+       Buffer_Initialize(&Tx_Buffer); // make sure the buffer is clear before proceeding\r
+\r
+       if        (firstByte == 'P') { // enter Programming mode\r
+               // enable SPI -- already done\r
+               // enter programming mode on target:\r
+               //PORTB = 0; // set clock to zero\r
+               RESETPORT = (1 << RESETPIN); // set RESET pin on target to 1\r
+               RESETPORT2 = (1 << RESETPIN2);\r
+               delay_ms(DELAY_SHORT);\r
+               //RESETPORT = (RESETPORT & ~(1 << RESETPIN)); // set RESET pin on target to 0 - Active\r
+               RESETPORT = 0x00;\r
+               RESETPORT2 = 0;\r
+               delay_ms(DELAY_SHORT);\r
+               SPI_SendByte(0xAC);\r
+               SPI_SendByte(0x53);\r
+               SPI_SendByte(0x00);\r
+               SPI_SendByte(0x00);\r
+               delay_ms(DELAY_VERYSHORT);\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == 'T') { // Select device type\r
+               deviceCode = Buffer_GetElement(&Rx_Buffer); // set device type\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == 'a') { // Report autoincrement address\r
+               Buffer_StoreElement(&Tx_Buffer, 'Y'); // return 'Y' - Auto-increment enabled\r
+\r
+       } else if (firstByte == 'A') { //Load Address\r
+               // get two bytes over serial and set currAddress to them\r
+               readByte1 = Buffer_GetElement(&Rx_Buffer); // high byte\r
+               readByte2 = Buffer_GetElement(&Rx_Buffer); // low byte\r
+               currAddress = (readByte1 << 8) | (readByte2);\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == 'c') { // Write program memory, low byte\r
+               // send 4 bytes over SPI; 0x40, then Address High Byte, then Low, then data\r
+               readByte1 = Buffer_GetElement(&Rx_Buffer);\r
+               SPI_SendByte(0x40);\r
+               SPI_SendByte((currAddress >> 8)); // high byte\r
+               SPI_SendByte((currAddress)); // low byte\r
+               SPI_SendByte(readByte1); // data\r
+               delay_ms(DELAY_MEDIUM); // certain MCUs require a delay of about 24585 cycles\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == 'C') { // Write program memory, high byte\r
+               // send 4 bytes over SPI; 0x48, then Address High Byte, then Low, then data\r
+               readByte1 = Buffer_GetElement(&Rx_Buffer);\r
+               SPI_SendByte(0x48);\r
+               SPI_SendByte((currAddress >> 8)); // high byte\r
+               SPI_SendByte((currAddress)); // low byte\r
+               SPI_SendByte(readByte1); // data\r
+               currAddress++; // increment currAddress\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == 'm') { // Write Program Memory Page\r
+               // send 4 bytes over SPI; 0x4c, then Address High Byte, then Low, then 0x00\r
+               SPI_SendByte(0x4C);\r
+               SPI_SendByte((currAddress >> 8)); // high byte\r
+               SPI_SendByte((currAddress)); // low byte\r
+               SPI_SendByte(0x00);\r
+               delay_ms(DELAY_LONG);\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == 'R') { // Read Program Memory\r
+               // send 4 bytes over SPI; 0x28, then Address High Byte, then Low, then send back read data from 4th byte over serial\r
+               SPI_SendByte(0x28);\r
+               SPI_SendByte((currAddress >> 8)); // high byte\r
+               SPI_SendByte((currAddress)); // low byte\r
+               readByte1 = SPI_TransferByte(0x00); // read in data\r
+               Buffer_StoreElement(&Tx_Buffer, readByte1);\r
+               // send 4 bytes over SPI; 0x20, then Address High Byte, then Low, then send back read data from 4th byte over serial\r
+               SPI_SendByte(0x20);\r
+               SPI_SendByte((currAddress >> 8)); // high byte\r
+               SPI_SendByte((currAddress)); // low byte\r
+               readByte2 = SPI_TransferByte(0x00); // read in data\r
+               Buffer_StoreElement(&Tx_Buffer, readByte2);\r
+               currAddress++; // increment currAddress\r
+\r
+       } else if (firstByte == 'D') { // Write Data Memory\r
+               // send 4 bytes over SPI; 0xc0, then Address High Byte, then Low, then data\r
+               readByte1 = Buffer_GetElement(&Rx_Buffer);\r
+               SPI_SendByte(0xC0);\r
+               SPI_SendByte((currAddress >> 8)); // high byte\r
+               SPI_SendByte((currAddress)); // low byte\r
+               SPI_SendByte(readByte1); // data\r
+               delay_ms(DELAY_MEDIUM);\r
+               currAddress++; // increment currAddress\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == 'd') { // Read Data Memory\r
+               // send 4 bytes over SPI; 0xa0, then Address High Byte, then Low, then send back read data from 4th byte over serial\r
+               SPI_SendByte(0xA0);\r
+               SPI_SendByte((currAddress >> 8)); // high byte\r
+               SPI_SendByte((currAddress)); // low byte\r
+               readByte1 = SPI_TransferByte(0x00); // read in data\r
+               Buffer_StoreElement(&Tx_Buffer, readByte1);\r
+               currAddress++; // increment currAddress\r
+\r
+       } else if (firstByte == 'e') { // erase the target device\r
+               // send 4 bytes over SPI; 0xac, 0x80, 0x04, 0x00\r
+               SPI_SendByte(0xAC);\r
+               SPI_SendByte(0x80);\r
+               SPI_SendByte(0x04);\r
+               SPI_SendByte(0x00);\r
+               delay_ms(DELAY_LONG);\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == 'l') { // write lock bits\r
+               // send 4 bytes over SPI; 0xac, [andi s_data 0x06], 0xe0, 0x00\r
+               readByte1 = Buffer_GetElement(&Rx_Buffer); // read in lock bits data\r
+               SPI_SendByte(0xAC);\r
+               SPI_SendByte(((0x06 & readByte1) | 0xE0)); // TODO - is this correct???\r
+               SPI_SendByte(0x00);\r
+               SPI_SendByte(0x00);\r
+               delay_ms(DELAY_MEDIUM);\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == 'f') { // write fuse bits\r
+               // ignore this command, but need to remove data from the receive buffer\r
+               readByte1 = Buffer_GetElement(&Rx_Buffer);\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == 'L') { // leave programming mode\r
+               RESETPORT |= (1 << RESETPIN); // set RESET pin on target to 1\r
+               RESETPORT2 |= (1 << RESETPIN2); // set RESET pin on target to 1\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == 's') { // Read signature bytes\r
+               // send 4 bytes over SPI; 0x30, 0x00, 0x02, read and send last byte over serial\r
+               SPI_SendByte(0x30);\r
+               SPI_SendByte(0x00);\r
+               SPI_SendByte(0x02);\r
+               readByte1 = SPI_TransferByte(0x00); // read in data\r
+               Buffer_StoreElement(&Tx_Buffer, readByte1);\r
+               SPI_SendByte(0x30);\r
+               SPI_SendByte(0x00);\r
+               SPI_SendByte(0x01);\r
+               readByte1 = SPI_TransferByte(0x00); // read in data\r
+               Buffer_StoreElement(&Tx_Buffer, readByte1);\r
+               SPI_SendByte(0x30);\r
+               SPI_SendByte(0x00);\r
+               SPI_SendByte(0x00);\r
+               readByte1 = SPI_TransferByte(0x00); // read in data\r
+               Buffer_StoreElement(&Tx_Buffer, readByte1);\r
+\r
+       } else if (firstByte == 't') { // Return supported device codes\r
+               Buffer_StoreElement(&Tx_Buffer, AVRDEVCODE01);\r
+               Buffer_StoreElement(&Tx_Buffer, AVRDEVCODE02);\r
+               Buffer_StoreElement(&Tx_Buffer, AVRDEVCODE03);\r
+               Buffer_StoreElement(&Tx_Buffer, AVRDEVCODE04);\r
+               Buffer_StoreElement(&Tx_Buffer, AVRDEVCODE05);\r
+               Buffer_StoreElement(&Tx_Buffer, AVRDEVCODE06);\r
+               Buffer_StoreElement(&Tx_Buffer, AVRDEVCODE07);\r
+               Buffer_StoreElement(&Tx_Buffer, AVRDEVCODE08);\r
+               Buffer_StoreElement(&Tx_Buffer, AVRDEVCODE09);\r
+               Buffer_StoreElement(&Tx_Buffer, AVRDEVCODE10);\r
+               Buffer_StoreElement(&Tx_Buffer, AVRDEVCODE11);\r
+               Buffer_StoreElement(&Tx_Buffer, AVRDEVCODE12);\r
+               Buffer_StoreElement(&Tx_Buffer, AVRDEVCODE13);\r
+               Buffer_StoreElement(&Tx_Buffer, AVRDEVCODE14);\r
+               Buffer_StoreElement(&Tx_Buffer, 0x00);\r
+\r
+       } else if (firstByte == 'S') { // Return software identifier\r
+               // return string[7] with "AVR ISP"\r
+               Buffer_StoreElement(&Tx_Buffer, 'A');\r
+               Buffer_StoreElement(&Tx_Buffer, 'V');\r
+               Buffer_StoreElement(&Tx_Buffer, 'R');\r
+               Buffer_StoreElement(&Tx_Buffer, 0x20);\r
+               Buffer_StoreElement(&Tx_Buffer, 'I');\r
+               Buffer_StoreElement(&Tx_Buffer, 'S');\r
+               Buffer_StoreElement(&Tx_Buffer, 'P');\r
+\r
+       } else if (firstByte == 'V') { // Return sofware version\r
+               //return two bytes, software Major then Minor\r
+               Buffer_StoreElement(&Tx_Buffer, '2');\r
+               Buffer_StoreElement(&Tx_Buffer, '3');\r
+\r
+       } else if (firstByte == 'v') { // Return hardware version\r
+               //return two bytes, hardware Major then Minor   \r
+               Buffer_StoreElement(&Tx_Buffer, ('1'));\r
+               Buffer_StoreElement(&Tx_Buffer, ('0'));\r
+\r
+       } else if (firstByte == 'p') { // Return programmer type\r
+               // return 'S' for Serial Programmer\r
+               Buffer_StoreElement(&Tx_Buffer, 'S');\r
+\r
+       } else if (firstByte == 'x') { // set LED\r
+               // ignore this command, but need to remove data from the receive buffer\r
+               readByte1 = Buffer_GetElement(&Rx_Buffer);\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == 'y') { // clear LED\r
+               // ignore this command, but need to remove data from the receive buffer\r
+               readByte1 = Buffer_GetElement(&Rx_Buffer);\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == ':') { // Universal Command\r
+               // get 3 bytes over serial\r
+               readByte1 = Buffer_GetElement(&Rx_Buffer);\r
+               readByte2 = Buffer_GetElement(&Rx_Buffer);\r
+               readByte3 = Buffer_GetElement(&Rx_Buffer);\r
+               SPI_SendByte(readByte1);\r
+               SPI_SendByte(readByte2);\r
+               SPI_SendByte(readByte3);\r
+               readByte1 = SPI_TransferByte(0x00);\r
+               Buffer_StoreElement(&Tx_Buffer, readByte1);\r
+               delay_ms(DELAY_MEDIUM);\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == '.') { // New Universal Command\r
+               // get 4 bytes over serial\r
+               readByte1 = Buffer_GetElement(&Rx_Buffer);\r
+               readByte2 = Buffer_GetElement(&Rx_Buffer);\r
+               readByte3 = Buffer_GetElement(&Rx_Buffer);\r
+               readByte4 = Buffer_GetElement(&Rx_Buffer);\r
+               SPI_SendByte(readByte1);\r
+               SPI_SendByte(readByte2);\r
+               SPI_SendByte(readByte3);\r
+               readByte1 = SPI_TransferByte(readByte4);\r
+               Buffer_StoreElement(&Tx_Buffer, readByte1);\r
+               delay_ms(DELAY_MEDIUM);\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+\r
+       } else if (firstByte == 'Z') { // Special test command\r
+               // do nothing, but need to remove data from the receive buffer\r
+               readByte1 = Buffer_GetElement(&Rx_Buffer);\r
+               readByte2 = Buffer_GetElement(&Rx_Buffer);\r
+\r
+       } else {\r
+               // do nothing, but need to return with a carriage return\r
+               Buffer_StoreElement(&Tx_Buffer, CR_HEX); // return carriage return (CR_HEX) if successful\r
+       }\r
+}\r
+\r
+\r
+void delay_ms(uint8_t dly) {\r
+       uint16_t endtime = 0;\r
+\r
+       endtime = TCNT1;\r
+       if (endtime > 63486) {\r
+               endtime = (dly * DELAY_MULTIPLE);\r
+       } else {\r
+               endtime += (dly * DELAY_MULTIPLE);\r
+       }\r
+\r
+       timerval = TCNT1;\r
+       while (timerval < endtime) {\r
+               timerval = TCNT1;\r
+       }\r
+}\r
diff --git a/Projects/AVRISP_Programmer/AVRISP_Programmer.h b/Projects/AVRISP_Programmer/AVRISP_Programmer.h
new file mode 100644 (file)
index 0000000..e78ba29
--- /dev/null
@@ -0,0 +1,194 @@
+/*\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  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 USBtoSerial.c.\r
+ */\r
+\r
+#ifndef _AVRISP_PROGRAMMER_H_\r
+#define _AVRISP_PROGRAMMER_H_\r
+\r
+       /* Includes: */\r
+               #include <avr/io.h>\r
+               #include <avr/wdt.h>\r
+               #include <avr/interrupt.h>\r
+\r
+               #include "Descriptors.h"\r
+               #include "RingBuff.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/Drivers/AT90USBXXX/SPI.h>          // SPI driver\r
+               #include <LUFA/Drivers/Board/LEDs.h>              // LEDs driver\r
+               #include <LUFA/Scheduler/Scheduler.h>             // Simple scheduler for task management\r
+\r
+       /* Macros: */\r
+               /** CDC Class specific request to get the current virtual serial port configuration settings. */\r
+               #define REQ_GetLineEncoding          0x21\r
+\r
+               /** CDC Class specific request to set the current virtual serial port configuration settings. */\r
+               #define REQ_SetLineEncoding          0x20\r
+\r
+               /** CDC Class specific request to set the current virtual serial port handshake line states. */\r
+               #define REQ_SetControlLineState      0x22\r
+               \r
+               /** Notification type constant for a change in the virtual serial port handshake line states, for\r
+                *  use with a USB_Notification_Header_t notification structure when sent to the host via the CDC \r
+                *  notification endpoint.\r
+                */\r
+               #define NOTIF_SerialState            0x20\r
+\r
+               /** Mask for the DTR handshake line for use with the REQ_SetControlLineState class specific request\r
+                *  from the host, to indicate that the DTR line state should be high.\r
+                */\r
+               #define CONTROL_LINE_OUT_DTR         (1 << 0)\r
+\r
+               /** Mask for the RTS handshake line for use with the REQ_SetControlLineState class specific request\r
+                *  from the host, to indicate that theRTS line state should be high.\r
+                */\r
+               #define CONTROL_LINE_OUT_RTS         (1 << 1)\r
+               \r
+               /** Mask for the DCD handshake line for use with the a NOTIF_SerialState class specific notification\r
+                *  from the device to the host, to indicate that the DCD line state is currently high.\r
+                */\r
+               #define CONTROL_LINE_IN_DCD          (1 << 0)\r
+\r
+               /** Mask for the DSR handshake line for use with the a NOTIF_SerialState class specific notification\r
+                *  from the device to the host, to indicate that the DSR line state is currently high.\r
+                */\r
+               #define CONTROL_LINE_IN_DSR          (1 << 1)\r
+\r
+               /** Mask for the BREAK handshake line for use with the a NOTIF_SerialState class specific notification\r
+                *  from the device to the host, to indicate that the BREAK line state is currently high.\r
+                */\r
+               #define CONTROL_LINE_IN_BREAK        (1 << 2)\r
+\r
+               /** Mask for the RING handshake line for use with the a NOTIF_SerialState class specific notification\r
+                *  from the device to the host, to indicate that the RING line state is currently high.\r
+                */\r
+               #define CONTROL_LINE_IN_RING         (1 << 3)\r
+\r
+               /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,\r
+                *  to indicate that a framing error has ocurred on the virtual serial port.\r
+                */\r
+               #define CONTROL_LINE_IN_FRAMEERROR   (1 << 4)\r
+\r
+               /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,\r
+                *  to indicate that a parity error has ocurred on the virtual serial port.\r
+                */\r
+               #define CONTROL_LINE_IN_PARITYERROR  (1 << 5)\r
+\r
+               /** Mask for use with the a NOTIF_SerialState class specific notification from the device to the host,\r
+                *  to indicate that a data overrun error has ocurred on the virtual serial port.\r
+                */\r
+               #define CONTROL_LINE_IN_OVERRUNERROR (1 << 6)\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
+       /* Type Defines: */\r
+               /** Type define for the virtual serial port line encoding settings, for storing the current USART configuration\r
+                *  as set by the host via a class specific request.\r
+                */\r
+               typedef struct\r
+               {\r
+                       uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */\r
+                       uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the\r
+                                             *   CDCDevice_CDC_LineCodingFormats_t enum\r
+                                             */\r
+                       uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the\r
+                                             *   CDCDevice_LineCodingParity_t enum\r
+                                             */\r
+                       uint8_t  DataBits; /**< Bits of data per charater of the virtual serial port */\r
+               } CDC_Line_Coding_t;\r
+               \r
+               /** Type define for a CDC notification, sent to the host via the CDC notification endpoint to indicate a\r
+                *  change in the device state asynchronously.\r
+                */\r
+               typedef struct\r
+               {\r
+                       uint8_t  NotificationType; /**< Notification type, a mask of REQDIR_*, REQTYPE_* and REQREC_* constants\r
+                                                   *   from the library StdRequestType.h header\r
+                                                   */\r
+                       uint8_t  Notification; /**< Notification value, a NOTIF_* constant */\r
+                       uint16_t wValue; /**< Notification wValue, notification-specific */\r
+                       uint16_t wIndex; /**< Notification wIndex, notification-specific */\r
+                       uint16_t wLength; /**< Notification wLength, notification-specific */\r
+               } USB_Notification_Header_t;\r
+               \r
+       /* Enums: */\r
+               /** Enum for the possible line encoding formats of a virtual serial port. */\r
+               enum CDCDevice_CDC_LineCodingFormats_t\r
+               {\r
+                       OneStopBit          = 0, /**< Each frame contains one stop bit */\r
+                       OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */\r
+                       TwoStopBits         = 2, /**< Each frame contains two stop bits */\r
+               };\r
+               \r
+               /** Enum for the possible line encoding parity settings of a virtual serial port. */\r
+               enum CDCDevice_LineCodingParity_t\r
+               {\r
+                       Parity_None         = 0, /**< No parity bit mode on each frame */\r
+                       Parity_Odd          = 1, /**< Odd parity bit mode on each frame */\r
+                       Parity_Even         = 2, /**< Even parity bit mode on each frame */\r
+                       Parity_Mark         = 3, /**< Mark parity bit mode on each frame */\r
+                       Parity_Space        = 4, /**< Space parity bit mode on each frame */\r
+               };\r
+\r
+               /** Enum for the possible status codes for passing to the UpdateStatus() function. */\r
+               enum USBtoSerial_StatusCodes_t\r
+               {\r
+                       Status_USBNotReady    = 0, /**< USB is not ready (disconnected from a USB host) */\r
+                       Status_USBEnumerating = 1, /**< USB interface is enumerating */\r
+                       Status_USBReady       = 2, /**< USB interface is connected and ready */\r
+               };\r
+               \r
+       /* Tasks: */\r
+               TASK(CDC_Task);\r
+\r
+       /* Function Prototypes: */\r
+               void ReconfigureSPI(void);\r
+               void UpdateStatus(uint8_t CurrentStatus);\r
+               void processHostSPIRequest(void);\r
+               void delay_ms(uint8_t dly);\r
+\r
+#endif\r
diff --git a/Projects/AVRISP_Programmer/AVRISP_Programmer.txt b/Projects/AVRISP_Programmer/AVRISP_Programmer.txt
new file mode 100644 (file)
index 0000000..1872cfb
--- /dev/null
@@ -0,0 +1,89 @@
+/** \file\r
+ *\r
+ *  This file contains special DoxyGen information for the generation of the main page and other special\r
+ *  documentation pages. It is not a project source file.\r
+ */\r
\r
+/** \mainpage AVRISP_Programmer\r
+ *\r
+ *  Communications Device Class demonstration application.\r
+ *  This gives a simple reference application for implementing\r
+ *  a USB to Serial converter using the CDC class.  Data communicated\r
+ *  over the USB Virtual Serial Port according to Atmel's AVR910\r
+ *  protocol is used to program AVR MCUs that are\r
+ *  "In-System Programmable via SPI Port".\r
+ *\r
+ *  After running this firmware for the first time on a new computer,\r
+ *  you will need to supply the .INF file located in this demo\r
+ *  project's directory as the device's driver when running under\r
+ *  Windows. This will enable Windows to use its inbuilt CDC drivers,\r
+ *  negating the need for custom drivers for the device. Other\r
+ *  Operating Systems should automatically use their own inbuilt\r
+ *  CDC-ACM drivers.\r
+ *\r
+ *  Usage:\r
+ *   avrdude -vv -F -P COM7 -c avr910 -p t261\r
+ *     Note -F flag which overrides signature check and enables programming\r
+ *     of any "In-System Programmable via SPI Port" AVR MCU.  Part number,\r
+ *     t261, should be set to your target device.\r
+ *   avrdude -vv -F -P COM7 -c avr910 -p t261 -U flash:w:PROG.hex\r
+ *     PROG.hex is the hex file to program your t261 AVR with\r
+ *   avrdude -vv -F -P COM7 -b 115200 -c avr910 -p t261 -U flash:w:test.hex\r
+ *     The -b 115200 sets the SPI clock to 62.5kHz from the default 125kHz and may\r
+ *     work when the default programming speed fails.\r
+ * AVROSP.exe -dATtiny261 -cCOM7 -rf\r
+ *     AVRosp is the Open Source AVR ISP Programming Software available from Atmel.com\r
+ *\r
+ *  Note: on Linux systems, COM7 should be replaced with someting like /dev/ttyACM0\r
+ *        You can determine this value by running dmesg after plugging in the device\r
+ *  Note: you must RESET the programmer after each use (AVRdude session).\r
+ *\r
+ *  Note: If you experience errors with older devices, try changing DELAY_LONG\r
+ *  to a larger value, such as 0xFF in AVRISP_Programmer.c\r
+ *\r
+ *  MISO, MOSI, and SCK are connected directly from the AVRopendous board\r
+ *  to the pin of the same functionality on the target.  RESET pin on the target\r
+ *  can be connected either to SS (PB0), or PC2.  Do not have any other pins\r
+ *  connected - especially HWB pin, to avoid unintentional behaviour.\r
+ *\r
+ *  AVR910 functionality was overlayed on USBtoSerial  functionality.\r
+ *  Keep this in mind when looking over the code.\r
+ *  Default target speed is 125kHz and corresponds to 19200 baud, which\r
+ *  is the default setting for AVRdude.\r
+ *\r
+ *  Changing "Baud-Rate" will change the SPI speed.  Defualt SPI clock speed\r
+ *  is 8Mhz / 4 = 2MHz.  8Mhz is the device clock speed.  This is the setting at\r
+ *  9600 baud.  The following is a table of baud-rate vs. SPI Speed that will result\r
+ *       9600 = 2Mhz\r
+ *       14400 = 1MHz\r
+ *       19200 = 125kHz (AVRdude Default)\r
+ *       38400 = 250kHz\r
+ *       57600 = 500kHz\r
+ *       115200 = 62.5kHz\r
+ *\r
+ *\r
+ *\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>USB Mode:</b></td>\r
+ *    <td>Device</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>USB Class:</b></td>\r
+ *    <td>Communications Device Class (CDC)</td>\r
+ *   </tr>\r
+ *   <tr> \r
+ *    <td><b>USB Subclass:</b></td>\r
+ *    <td>Abstract Control Model (ACM)</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Relevant Standards:</b></td>\r
+ *    <td>USBIF CDC Class Standard</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Usable Speeds:</b></td>\r
+ *    <td>Full Speed Mode</td>\r
+ *   </tr>\r
+ *  </table>\r
+ */\r
diff --git a/Projects/AVRISP_Programmer/AVRISP_Programmer_Picture.jpg b/Projects/AVRISP_Programmer/AVRISP_Programmer_Picture.jpg
new file mode 100644 (file)
index 0000000..87ec3d4
Binary files /dev/null and b/Projects/AVRISP_Programmer/AVRISP_Programmer_Picture.jpg differ
diff --git a/Projects/AVRISP_Programmer/Descriptors.c b/Projects/AVRISP_Programmer/Descriptors.c
new file mode 100644 (file)
index 0000000..5f3ffca
--- /dev/null
@@ -0,0 +1,263 @@
+/*\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  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
+ *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special \r
+ *  computer-readable structures which the host requests upon device enumeration, to determine\r
+ *  the device's capabilities and functions.  \r
+ */\r
+\r
+#include "Descriptors.h"\r
+\r
+/** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall\r
+ *  device characteristics, including the supported USB version, control endpoint size and the\r
+ *  number of device configurations. The descriptor is read out by the USB host when the enumeration\r
+ *  process begins.\r
+ */\r
+USB_Descriptor_Device_t PROGMEM DeviceDescriptor =\r
+{\r
+       Header:                 {Size: sizeof(USB_Descriptor_Device_t), Type: DTYPE_Device},\r
+               \r
+       USBSpecification:       VERSION_BCD(01.10),\r
+       Class:                  0x02,\r
+       SubClass:               0x00,\r
+       Protocol:               0x00,\r
+                               \r
+       Endpoint0Size:          8,\r
+               \r
+       VendorID:               0x03EB,\r
+       ProductID:              0x204F,\r
+       ReleaseNumber:          0x0000,\r
+               \r
+       ManufacturerStrIndex:   0x01,\r
+       ProductStrIndex:        0x02,\r
+       SerialNumStrIndex:      NO_DESCRIPTOR,\r
+               \r
+       NumberOfConfigurations: 1\r
+};\r
+\r
+/** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage\r
+ *  of the device in one of its supported configurations, including information about any device interfaces\r
+ *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting\r
+ *  a configuration so that the host may correctly communicate with the USB device.\r
+ */\r
+USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =\r
+{\r
+       Config:\r
+               {\r
+                       Header:                 {Size: sizeof(USB_Descriptor_Configuration_Header_t), Type: DTYPE_Configuration},\r
+\r
+                       TotalConfigurationSize: sizeof(USB_Descriptor_Configuration_t),\r
+                       TotalInterfaces:        2,\r
+                               \r
+                       ConfigurationNumber:    1,\r
+                       ConfigurationStrIndex:  NO_DESCRIPTOR,\r
+                               \r
+                       ConfigAttributes:       (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),\r
+                       \r
+                       MaxPowerConsumption:    USB_CONFIG_POWER_MA(100)\r
+               },\r
+               \r
+       CCI_Interface:\r
+               {\r
+                       Header:                 {Size: sizeof(USB_Descriptor_Interface_t), Type: DTYPE_Interface},\r
+\r
+                       InterfaceNumber:        0,\r
+                       AlternateSetting:       0,\r
+                       \r
+                       TotalEndpoints:         1,\r
+                               \r
+                       Class:                  0x02,\r
+                       SubClass:               0x02,\r
+                       Protocol:               0x01,\r
+                               \r
+                       InterfaceStrIndex:      NO_DESCRIPTOR\r
+               },\r
+\r
+       CDC_Functional_IntHeader:\r
+               {\r
+                       Header:                 {Size: sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), Type: 0x24},\r
+                       SubType:                0x00,\r
+                       \r
+                       Data:                   {0x01, 0x10}\r
+               },\r
+\r
+       CDC_Functional_CallManagement:\r
+               {\r
+                       Header:                 {Size: sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), Type: 0x24},\r
+                       SubType:                0x01,\r
+                       \r
+                       Data:                   {0x03, 0x01}\r
+               },\r
+\r
+       CDC_Functional_AbstractControlManagement:\r
+               {\r
+                       Header:                 {Size: sizeof(CDC_FUNCTIONAL_DESCRIPTOR(1)), Type: 0x24},\r
+                       SubType:                0x02,\r
+                       \r
+                       Data:                   {0x06}\r
+               },\r
+               \r
+       CDC_Functional_Union:\r
+               {\r
+                       Header:                 {Size: sizeof(CDC_FUNCTIONAL_DESCRIPTOR(2)), Type: 0x24},\r
+                       SubType:                0x06,\r
+                       \r
+                       Data:                   {0x00, 0x01}\r
+               },\r
+\r
+       ManagementEndpoint:\r
+               {\r
+                       Header:                 {Size: sizeof(USB_Descriptor_Endpoint_t), Type: DTYPE_Endpoint},\r
+                                                                                \r
+                       EndpointAddress:        (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_NOTIFICATION_EPNUM),\r
+                       Attributes:                     EP_TYPE_INTERRUPT,\r
+                       EndpointSize:           CDC_NOTIFICATION_EPSIZE,\r
+                       PollingIntervalMS:              0xFF\r
+               },\r
+\r
+       DCI_Interface:\r
+               {\r
+                       Header:                 {Size: sizeof(USB_Descriptor_Interface_t), Type: DTYPE_Interface},\r
+\r
+                       InterfaceNumber:        1,\r
+                       AlternateSetting:       0,\r
+                       \r
+                       TotalEndpoints:         2,\r
+                               \r
+                       Class:                  0x0A,\r
+                       SubClass:               0x00,\r
+                       Protocol:               0x00,\r
+                               \r
+                       InterfaceStrIndex:      NO_DESCRIPTOR\r
+               },\r
+\r
+       DataOutEndpoint:\r
+               {\r
+                       Header:                 {Size: sizeof(USB_Descriptor_Endpoint_t), Type: DTYPE_Endpoint},\r
+                                                                                \r
+                       EndpointAddress:        (ENDPOINT_DESCRIPTOR_DIR_OUT | CDC_RX_EPNUM),\r
+                       Attributes:                     EP_TYPE_BULK,\r
+                       EndpointSize:           CDC_TXRX_EPSIZE,\r
+                       PollingIntervalMS:              0x00\r
+               },\r
+               \r
+       DataInEndpoint:\r
+               {\r
+                       Header:                 {Size: sizeof(USB_Descriptor_Endpoint_t), Type: DTYPE_Endpoint},\r
+                                                                                \r
+                       EndpointAddress:        (ENDPOINT_DESCRIPTOR_DIR_IN | CDC_TX_EPNUM),\r
+                       Attributes:                     EP_TYPE_BULK,\r
+                       EndpointSize:           CDC_TXRX_EPSIZE,\r
+                       PollingIntervalMS:              0x00\r
+               }\r
+};\r
+\r
+/** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests\r
+ *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate\r
+ *  via the language ID table available at USB.org what languages the device supports for its string descriptors.\r
+ */\r
+USB_Descriptor_String_t PROGMEM LanguageString =\r
+{\r
+       Header:                 {Size: USB_STRING_LEN(1), Type: DTYPE_String},\r
+               \r
+       UnicodeString:          {LANGUAGE_ID_ENG}\r
+};\r
+\r
+/** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable\r
+ *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device\r
+ *  Descriptor.\r
+ */\r
+USB_Descriptor_String_t PROGMEM ManufacturerString =\r
+{\r
+       Header:                 {Size: USB_STRING_LEN(19), Type: DTYPE_String},\r
+               \r
+       UnicodeString:          L"www.AVRopendous.org"\r
+};\r
+\r
+/** Product descriptor string. This is a Unicode string containing the product's details in human readable form,\r
+ *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device\r
+ *  Descriptor.\r
+ */\r
+USB_Descriptor_String_t PROGMEM ProductString =\r
+{\r
+       Header:                 {Size: USB_STRING_LEN(29), Type: DTYPE_String},\r
+               \r
+       UnicodeString:          L"LUFA-Based AVR ISP Programmer"\r
+};\r
+\r
+/** This function is called by the library when in device mode, and must be overridden (see StdDescriptors.h\r
+ *  documentation) by the application code so that the address and size of a requested descriptor can be given\r
+ *  to the USB library. When the device recieves a Get Descriptor request on the control endpoint, this function\r
+ *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the\r
+ *  USB host.\r
+ */\r
+uint16_t USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)\r
+{\r
+       const uint8_t  DescriptorType   = (wValue >> 8);\r
+       const uint8_t  DescriptorNumber = (wValue & 0xFF);\r
+\r
+       void*    Address = NULL;\r
+       uint16_t Size    = NO_DESCRIPTOR;\r
+\r
+       switch (DescriptorType)\r
+       {\r
+               case DTYPE_Device:\r
+                       Address = DESCRIPTOR_ADDRESS(DeviceDescriptor);\r
+                       Size    = sizeof(USB_Descriptor_Device_t);\r
+                       break;\r
+               case DTYPE_Configuration:\r
+                       Address = DESCRIPTOR_ADDRESS(ConfigurationDescriptor);\r
+                       Size    = sizeof(USB_Descriptor_Configuration_t);\r
+                       break;\r
+               case DTYPE_String:\r
+                       switch (DescriptorNumber)\r
+                       {\r
+                               case 0x00:\r
+                                       Address = DESCRIPTOR_ADDRESS(LanguageString);\r
+                                       Size    = pgm_read_byte(&LanguageString.Header.Size);\r
+                                       break;\r
+                               case 0x01:\r
+                                       Address = DESCRIPTOR_ADDRESS(ManufacturerString);\r
+                                       Size    = pgm_read_byte(&ManufacturerString.Header.Size);\r
+                                       break;\r
+                               case 0x02:\r
+                                       Address = DESCRIPTOR_ADDRESS(ProductString);\r
+                                       Size    = pgm_read_byte(&ProductString.Header.Size);\r
+                                       break;\r
+                       }\r
+                       \r
+                       break;\r
+       }\r
+       \r
+       *DescriptorAddress = Address;\r
+       return Size;\r
+}\r
diff --git a/Projects/AVRISP_Programmer/Descriptors.h b/Projects/AVRISP_Programmer/Descriptors.h
new file mode 100644 (file)
index 0000000..bec5e40
--- /dev/null
@@ -0,0 +1,98 @@
+/*\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  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 Descriptors.c.\r
+ */\r
\r
+#ifndef _DESCRIPTORS_H_\r
+#define _DESCRIPTORS_H_\r
+\r
+       /* Includes: */\r
+               #include <LUFA/Drivers/USB/USB.h>\r
+\r
+               #include <avr/pgmspace.h>\r
+\r
+       /* Macros: */\r
+               /** Macro to define a CDC class-specific functional descriptor. CDC functional descriptors have a\r
+                *  uniform structure but variable sized data payloads, thus cannot be represented accurately by\r
+                *  a single typedef struct. A macro is used instead so that functional descriptors can be created\r
+                *  easily by specifying the size of the payload. This allows sizeof() to work correctly.\r
+                *\r
+                *  \param DataSize  Size in bytes of the CDC functional descriptor's data payload\r
+                */\r
+               #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)        \\r
+                    struct                                        \\r
+                    {                                             \\r
+                         USB_Descriptor_Header_t Header;          \\r
+                             uint8_t                 SubType;         \\r
+                         uint8_t                 Data[DataSize];  \\r
+                    }\r
+                        \r
+               /** Endpoint number of the CDC device-to-host notification IN endpoint. */\r
+               #define CDC_NOTIFICATION_EPNUM         2\r
+\r
+               /** Endpoint number of the CDC device-to-host data IN endpoint. */\r
+               #define CDC_TX_EPNUM                   3        \r
+\r
+               /** Endpoint number of the CDC host-to-device data OUT endpoint. */\r
+               #define CDC_RX_EPNUM                   4        \r
+\r
+               /** Size in bytes of the CDC device-to-host notification IN endpoint. */\r
+               #define CDC_NOTIFICATION_EPSIZE        8\r
+\r
+               /** Size in bytes of the CDC data IN and OUT endpoints. */\r
+               #define CDC_TXRX_EPSIZE                16       \r
+\r
+       /* Type Defines: */\r
+               /** Type define for the device configuration descriptor structure. This must be defined in the\r
+                *  application code, as the configuration descriptor contains several sub-descriptors which\r
+                *  vary between devices, and which describe the device's usage to the host.\r
+                */\r
+               typedef struct\r
+               {\r
+                       USB_Descriptor_Configuration_Header_t    Config;\r
+                       USB_Descriptor_Interface_t               CCI_Interface;\r
+                       CDC_FUNCTIONAL_DESCRIPTOR(2)             CDC_Functional_IntHeader;\r
+                       CDC_FUNCTIONAL_DESCRIPTOR(2)             CDC_Functional_CallManagement;\r
+                       CDC_FUNCTIONAL_DESCRIPTOR(1)             CDC_Functional_AbstractControlManagement;\r
+                       CDC_FUNCTIONAL_DESCRIPTOR(2)             CDC_Functional_Union;\r
+                       USB_Descriptor_Endpoint_t                ManagementEndpoint;\r
+                       USB_Descriptor_Interface_t               DCI_Interface;\r
+                       USB_Descriptor_Endpoint_t                DataOutEndpoint;\r
+                       USB_Descriptor_Endpoint_t                DataInEndpoint;\r
+               } USB_Descriptor_Configuration_t;\r
+\r
+       /* Function Prototypes: */\r
+               uint16_t USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)\r
+                                          ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);\r
+\r
+#endif\r
diff --git a/Projects/AVRISP_Programmer/Doxygen.conf b/Projects/AVRISP_Programmer/Doxygen.conf
new file mode 100644 (file)
index 0000000..1eb8c54
--- /dev/null
@@ -0,0 +1,1485 @@
+# Doxyfile 1.5.7.1\r
+\r
+# This file describes the settings to be used by the documentation system\r
+# doxygen (www.doxygen.org) for a project\r
+#\r
+# All text after a hash (#) is considered a comment and will be ignored\r
+# The format is:\r
+#       TAG = value [value, ...]\r
+# For lists items can also be appended using:\r
+#       TAG += value [value, ...]\r
+# Values that contain spaces should be placed between quotes (" ")\r
+\r
+#---------------------------------------------------------------------------\r
+# Project related configuration options\r
+#---------------------------------------------------------------------------\r
+\r
+# This tag specifies the encoding used for all characters in the config file \r
+# that follow. The default is UTF-8 which is also the encoding used for all \r
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the \r
+# iconv built into libc) for the transcoding. See \r
+# http://www.gnu.org/software/libiconv for the list of possible encodings.\r
+\r
+DOXYFILE_ENCODING      = UTF-8\r
+\r
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded \r
+# by quotes) that should identify the project.\r
+\r
+PROJECT_NAME           = "LUFA Library - USB to Serial Device Demo"\r
+\r
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. \r
+# This could be handy for archiving the generated documentation or \r
+# if some version control system is used.\r
+\r
+PROJECT_NUMBER         = 0.0.0\r
+\r
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) \r
+# base path where the generated documentation will be put. \r
+# If a relative path is entered, it will be relative to the location \r
+# where doxygen was started. If left blank the current directory will be used.\r
+\r
+OUTPUT_DIRECTORY       = ./Documentation/\r
+\r
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create \r
+# 4096 sub-directories (in 2 levels) under the output directory of each output \r
+# format and will distribute the generated files over these directories. \r
+# Enabling this option can be useful when feeding doxygen a huge amount of \r
+# source files, where putting all generated files in the same directory would \r
+# otherwise cause performance problems for the file system.\r
+\r
+CREATE_SUBDIRS         = YES\r
+\r
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all \r
+# documentation generated by doxygen is written. Doxygen will use this \r
+# information to generate all constant output in the proper language. \r
+# The default language is English, other supported languages are: \r
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, \r
+# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, \r
+# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), \r
+# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, \r
+# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, \r
+# Spanish, Swedish, and Ukrainian.\r
+\r
+OUTPUT_LANGUAGE        = English\r
+\r
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will \r
+# include brief member descriptions after the members that are listed in \r
+# the file and class documentation (similar to JavaDoc). \r
+# Set to NO to disable this.\r
+\r
+BRIEF_MEMBER_DESC      = YES\r
+\r
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend \r
+# the brief description of a member or function before the detailed description. \r
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the \r
+# brief descriptions will be completely suppressed.\r
+\r
+REPEAT_BRIEF           = YES\r
+\r
+# This tag implements a quasi-intelligent brief description abbreviator \r
+# that is used to form the text in various listings. Each string \r
+# in this list, if found as the leading text of the brief description, will be \r
+# stripped from the text and the result after processing the whole list, is \r
+# used as the annotated text. Otherwise, the brief description is used as-is. \r
+# If left blank, the following values are used ("$name" is automatically \r
+# replaced with the name of the entity): "The $name class" "The $name widget" \r
+# "The $name file" "is" "provides" "specifies" "contains" \r
+# "represents" "a" "an" "the"\r
+\r
+ABBREVIATE_BRIEF       = "The $name class" \\r
+                         "The $name widget" \\r
+                         "The $name file" \\r
+                         is \\r
+                         provides \\r
+                         specifies \\r
+                         contains \\r
+                         represents \\r
+                         a \\r
+                         an \\r
+                         the\r
+\r
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then \r
+# Doxygen will generate a detailed section even if there is only a brief \r
+# description.\r
+\r
+ALWAYS_DETAILED_SEC    = NO\r
+\r
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all \r
+# inherited members of a class in the documentation of that class as if those \r
+# members were ordinary class members. Constructors, destructors and assignment \r
+# operators of the base classes will not be shown.\r
+\r
+INLINE_INHERITED_MEMB  = NO\r
+\r
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full \r
+# path before files name in the file list and in the header files. If set \r
+# to NO the shortest path that makes the file name unique will be used.\r
+\r
+FULL_PATH_NAMES        = YES\r
+\r
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag \r
+# can be used to strip a user-defined part of the path. Stripping is \r
+# only done if one of the specified strings matches the left-hand part of \r
+# the path. The tag can be used to show relative paths in the file list. \r
+# If left blank the directory from which doxygen is run is used as the \r
+# path to strip.\r
+\r
+STRIP_FROM_PATH        = \r
+\r
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of \r
+# the path mentioned in the documentation of a class, which tells \r
+# the reader which header file to include in order to use a class. \r
+# If left blank only the name of the header file containing the class \r
+# definition is used. Otherwise one should specify the include paths that \r
+# are normally passed to the compiler using the -I flag.\r
+\r
+STRIP_FROM_INC_PATH    = \r
+\r
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter \r
+# (but less readable) file names. This can be useful is your file systems \r
+# doesn't support long names like on DOS, Mac, or CD-ROM.\r
+\r
+SHORT_NAMES            = YES\r
+\r
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen \r
+# will interpret the first line (until the first dot) of a JavaDoc-style \r
+# comment as the brief description. If set to NO, the JavaDoc \r
+# comments will behave just like regular Qt-style comments \r
+# (thus requiring an explicit @brief command for a brief description.)\r
+\r
+JAVADOC_AUTOBRIEF      = NO\r
+\r
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will \r
+# interpret the first line (until the first dot) of a Qt-style \r
+# comment as the brief description. If set to NO, the comments \r
+# will behave just like regular Qt-style comments (thus requiring \r
+# an explicit \brief command for a brief description.)\r
+\r
+QT_AUTOBRIEF           = NO\r
+\r
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen \r
+# treat a multi-line C++ special comment block (i.e. a block of //! or /// \r
+# comments) as a brief description. This used to be the default behaviour. \r
+# The new default is to treat a multi-line C++ comment block as a detailed \r
+# description. Set this tag to YES if you prefer the old behaviour instead.\r
+\r
+MULTILINE_CPP_IS_BRIEF = NO\r
+\r
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented \r
+# member inherits the documentation from any documented member that it \r
+# re-implements.\r
+\r
+INHERIT_DOCS           = YES\r
+\r
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce \r
+# a new page for each member. If set to NO, the documentation of a member will \r
+# be part of the file/class/namespace that contains it.\r
+\r
+SEPARATE_MEMBER_PAGES  = NO\r
+\r
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. \r
+# Doxygen uses this value to replace tabs by spaces in code fragments.\r
+\r
+TAB_SIZE               = 4\r
+\r
+# This tag can be used to specify a number of aliases that acts \r
+# as commands in the documentation. An alias has the form "name=value". \r
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to \r
+# put the command \sideeffect (or @sideeffect) in the documentation, which \r
+# will result in a user-defined paragraph with heading "Side Effects:". \r
+# You can put \n's in the value part of an alias to insert newlines.\r
+\r
+ALIASES                = \r
+\r
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C \r
+# sources only. Doxygen will then generate output that is more tailored for C. \r
+# For instance, some of the names that are used will be different. The list \r
+# of all members will be omitted, etc.\r
+\r
+OPTIMIZE_OUTPUT_FOR_C  = YES\r
+\r
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java \r
+# sources only. Doxygen will then generate output that is more tailored for \r
+# Java. For instance, namespaces will be presented as packages, qualified \r
+# scopes will look different, etc.\r
+\r
+OPTIMIZE_OUTPUT_JAVA   = NO\r
+\r
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran \r
+# sources only. Doxygen will then generate output that is more tailored for \r
+# Fortran.\r
+\r
+OPTIMIZE_FOR_FORTRAN   = NO\r
+\r
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL \r
+# sources. Doxygen will then generate output that is tailored for \r
+# VHDL.\r
+\r
+OPTIMIZE_OUTPUT_VHDL   = NO\r
+\r
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want \r
+# to include (a tag file for) the STL sources as input, then you should \r
+# set this tag to YES in order to let doxygen match functions declarations and \r
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. \r
+# func(std::string) {}). This also make the inheritance and collaboration \r
+# diagrams that involve STL classes more complete and accurate.\r
+\r
+BUILTIN_STL_SUPPORT    = NO\r
+\r
+# If you use Microsoft's C++/CLI language, you should set this option to YES to\r
+# enable parsing support.\r
+\r
+CPP_CLI_SUPPORT        = NO\r
+\r
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. \r
+# Doxygen will parse them like normal C++ but will assume all classes use public \r
+# instead of private inheritance when no explicit protection keyword is present.\r
+\r
+SIP_SUPPORT            = NO\r
+\r
+# For Microsoft's IDL there are propget and propput attributes to indicate getter \r
+# and setter methods for a property. Setting this option to YES (the default) \r
+# will make doxygen to replace the get and set methods by a property in the \r
+# documentation. This will only work if the methods are indeed getting or \r
+# setting a simple type. If this is not the case, or you want to show the \r
+# methods anyway, you should set this option to NO.\r
+\r
+IDL_PROPERTY_SUPPORT   = YES\r
+\r
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC \r
+# tag is set to YES, then doxygen will reuse the documentation of the first \r
+# member in the group (if any) for the other members of the group. By default \r
+# all members of a group must be documented explicitly.\r
+\r
+DISTRIBUTE_GROUP_DOC   = NO\r
+\r
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of \r
+# the same type (for instance a group of public functions) to be put as a \r
+# subgroup of that type (e.g. under the Public Functions section). Set it to \r
+# NO to prevent subgrouping. Alternatively, this can be done per class using \r
+# the \nosubgrouping command.\r
+\r
+SUBGROUPING            = YES\r
+\r
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum \r
+# is documented as struct, union, or enum with the name of the typedef. So \r
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct \r
+# with name TypeT. When disabled the typedef will appear as a member of a file, \r
+# namespace, or class. And the struct will be named TypeS. This can typically \r
+# be useful for C code in case the coding convention dictates that all compound \r
+# types are typedef'ed and only the typedef is referenced, never the tag name.\r
+\r
+TYPEDEF_HIDES_STRUCT   = NO\r
+\r
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to \r
+# determine which symbols to keep in memory and which to flush to disk.\r
+# When the cache is full, less often used symbols will be written to disk.\r
+# For small to medium size projects (<1000 input files) the default value is \r
+# probably good enough. For larger projects a too small cache size can cause \r
+# doxygen to be busy swapping symbols to and from disk most of the time \r
+# causing a significant performance penality. \r
+# If the system has enough physical memory increasing the cache will improve the \r
+# performance by keeping more symbols in memory. Note that the value works on \r
+# a logarithmic scale so increasing the size by one will rougly double the \r
+# memory usage. The cache size is given by this formula: \r
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, \r
+# corresponding to a cache size of 2^16 = 65536 symbols\r
+\r
+SYMBOL_CACHE_SIZE      = 0\r
+\r
+#---------------------------------------------------------------------------\r
+# Build related configuration options\r
+#---------------------------------------------------------------------------\r
+\r
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in \r
+# documentation are documented, even if no documentation was available. \r
+# Private class members and static file members will be hidden unless \r
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES\r
+\r
+EXTRACT_ALL            = YES\r
+\r
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class \r
+# will be included in the documentation.\r
+\r
+EXTRACT_PRIVATE        = YES\r
+\r
+# If the EXTRACT_STATIC tag is set to YES all static members of a file \r
+# will be included in the documentation.\r
+\r
+EXTRACT_STATIC         = YES\r
+\r
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) \r
+# defined locally in source files will be included in the documentation. \r
+# If set to NO only classes defined in header files are included.\r
+\r
+EXTRACT_LOCAL_CLASSES  = YES\r
+\r
+# This flag is only useful for Objective-C code. When set to YES local \r
+# methods, which are defined in the implementation section but not in \r
+# the interface are included in the documentation. \r
+# If set to NO (the default) only methods in the interface are included.\r
+\r
+EXTRACT_LOCAL_METHODS  = NO\r
+\r
+# If this flag is set to YES, the members of anonymous namespaces will be \r
+# extracted and appear in the documentation as a namespace called \r
+# 'anonymous_namespace{file}', where file will be replaced with the base \r
+# name of the file that contains the anonymous namespace. By default \r
+# anonymous namespace are hidden.\r
+\r
+EXTRACT_ANON_NSPACES   = NO\r
+\r
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all \r
+# undocumented members of documented classes, files or namespaces. \r
+# If set to NO (the default) these members will be included in the \r
+# various overviews, but no documentation section is generated. \r
+# This option has no effect if EXTRACT_ALL is enabled.\r
+\r
+HIDE_UNDOC_MEMBERS     = NO\r
+\r
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all \r
+# undocumented classes that are normally visible in the class hierarchy. \r
+# If set to NO (the default) these classes will be included in the various \r
+# overviews. This option has no effect if EXTRACT_ALL is enabled.\r
+\r
+HIDE_UNDOC_CLASSES     = NO\r
+\r
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all \r
+# friend (class|struct|union) declarations. \r
+# If set to NO (the default) these declarations will be included in the \r
+# documentation.\r
+\r
+HIDE_FRIEND_COMPOUNDS  = NO\r
+\r
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any \r
+# documentation blocks found inside the body of a function. \r
+# If set to NO (the default) these blocks will be appended to the \r
+# function's detailed documentation block.\r
+\r
+HIDE_IN_BODY_DOCS      = NO\r
+\r
+# The INTERNAL_DOCS tag determines if documentation \r
+# that is typed after a \internal command is included. If the tag is set \r
+# to NO (the default) then the documentation will be excluded. \r
+# Set it to YES to include the internal documentation.\r
+\r
+INTERNAL_DOCS          = NO\r
+\r
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate \r
+# file names in lower-case letters. If set to YES upper-case letters are also \r
+# allowed. This is useful if you have classes or files whose names only differ \r
+# in case and if your file system supports case sensitive file names. Windows \r
+# and Mac users are advised to set this option to NO.\r
+\r
+CASE_SENSE_NAMES       = NO\r
+\r
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen \r
+# will show members with their full class and namespace scopes in the \r
+# documentation. If set to YES the scope will be hidden.\r
+\r
+HIDE_SCOPE_NAMES       = NO\r
+\r
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen \r
+# will put a list of the files that are included by a file in the documentation \r
+# of that file.\r
+\r
+SHOW_INCLUDE_FILES     = YES\r
+\r
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] \r
+# is inserted in the documentation for inline members.\r
+\r
+INLINE_INFO            = YES\r
+\r
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen \r
+# will sort the (detailed) documentation of file and class members \r
+# alphabetically by member name. If set to NO the members will appear in \r
+# declaration order.\r
+\r
+SORT_MEMBER_DOCS       = YES\r
+\r
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the \r
+# brief documentation of file, namespace and class members alphabetically \r
+# by member name. If set to NO (the default) the members will appear in \r
+# declaration order.\r
+\r
+SORT_BRIEF_DOCS        = NO\r
+\r
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the \r
+# hierarchy of group names into alphabetical order. If set to NO (the default) \r
+# the group names will appear in their defined order.\r
+\r
+SORT_GROUP_NAMES       = NO\r
+\r
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be \r
+# sorted by fully-qualified names, including namespaces. If set to \r
+# NO (the default), the class list will be sorted only by class name, \r
+# not including the namespace part. \r
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.\r
+# Note: This option applies only to the class list, not to the \r
+# alphabetical list.\r
+\r
+SORT_BY_SCOPE_NAME     = NO\r
+\r
+# The GENERATE_TODOLIST tag can be used to enable (YES) or \r
+# disable (NO) the todo list. This list is created by putting \todo \r
+# commands in the documentation.\r
+\r
+GENERATE_TODOLIST      = NO\r
+\r
+# The GENERATE_TESTLIST tag can be used to enable (YES) or \r
+# disable (NO) the test list. This list is created by putting \test \r
+# commands in the documentation.\r
+\r
+GENERATE_TESTLIST      = NO\r
+\r
+# The GENERATE_BUGLIST tag can be used to enable (YES) or \r
+# disable (NO) the bug list. This list is created by putting \bug \r
+# commands in the documentation.\r
+\r
+GENERATE_BUGLIST       = NO\r
+\r
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or \r
+# disable (NO) the deprecated list. This list is created by putting \r
+# \deprecated commands in the documentation.\r
+\r
+GENERATE_DEPRECATEDLIST= YES\r
+\r
+# The ENABLED_SECTIONS tag can be used to enable conditional \r
+# documentation sections, marked by \if sectionname ... \endif.\r
+\r
+ENABLED_SECTIONS       = \r
+\r
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines \r
+# the initial value of a variable or define consists of for it to appear in \r
+# the documentation. If the initializer consists of more lines than specified \r
+# here it will be hidden. Use a value of 0 to hide initializers completely. \r
+# The appearance of the initializer of individual variables and defines in the \r
+# documentation can be controlled using \showinitializer or \hideinitializer \r
+# command in the documentation regardless of this setting.\r
+\r
+MAX_INITIALIZER_LINES  = 30\r
+\r
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated \r
+# at the bottom of the documentation of classes and structs. If set to YES the \r
+# list will mention the files that were used to generate the documentation.\r
+\r
+SHOW_USED_FILES        = YES\r
+\r
+# If the sources in your project are distributed over multiple directories \r
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy \r
+# in the documentation. The default is NO.\r
+\r
+SHOW_DIRECTORIES       = YES\r
+\r
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.\r
+# This will remove the Files entry from the Quick Index and from the \r
+# Folder Tree View (if specified). The default is YES.\r
+\r
+SHOW_FILES             = YES\r
+\r
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the \r
+# Namespaces page.  This will remove the Namespaces entry from the Quick Index\r
+# and from the Folder Tree View (if specified). The default is YES.\r
+\r
+SHOW_NAMESPACES        = YES\r
+\r
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that \r
+# doxygen should invoke to get the current version for each file (typically from \r
+# the version control system). Doxygen will invoke the program by executing (via \r
+# popen()) the command <command> <input-file>, where <command> is the value of \r
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file \r
+# provided by doxygen. Whatever the program writes to standard output \r
+# is used as the file version. See the manual for examples.\r
+\r
+FILE_VERSION_FILTER    = \r
+\r
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by \r
+# doxygen. The layout file controls the global structure of the generated output files \r
+# in an output format independent way. The create the layout file that represents \r
+# doxygen's defaults, run doxygen with the -l option. You can optionally specify a \r
+# file name after the option, if omitted DoxygenLayout.xml will be used as the name \r
+# of the layout file.\r
+\r
+LAYOUT_FILE            = \r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to warning and progress messages\r
+#---------------------------------------------------------------------------\r
+\r
+# The QUIET tag can be used to turn on/off the messages that are generated \r
+# by doxygen. Possible values are YES and NO. If left blank NO is used.\r
+\r
+QUIET                  = YES\r
+\r
+# The WARNINGS tag can be used to turn on/off the warning messages that are \r
+# generated by doxygen. Possible values are YES and NO. If left blank \r
+# NO is used.\r
+\r
+WARNINGS               = YES\r
+\r
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings \r
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will \r
+# automatically be disabled.\r
+\r
+WARN_IF_UNDOCUMENTED   = YES\r
+\r
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for \r
+# potential errors in the documentation, such as not documenting some \r
+# parameters in a documented function, or documenting parameters that \r
+# don't exist or using markup commands wrongly.\r
+\r
+WARN_IF_DOC_ERROR      = YES\r
+\r
+# This WARN_NO_PARAMDOC option can be abled to get warnings for \r
+# functions that are documented, but have no documentation for their parameters \r
+# or return value. If set to NO (the default) doxygen will only warn about \r
+# wrong or incomplete parameter documentation, but not about the absence of \r
+# documentation.\r
+\r
+WARN_NO_PARAMDOC       = YES\r
+\r
+# The WARN_FORMAT tag determines the format of the warning messages that \r
+# doxygen can produce. The string should contain the $file, $line, and $text \r
+# tags, which will be replaced by the file and line number from which the \r
+# warning originated and the warning text. Optionally the format may contain \r
+# $version, which will be replaced by the version of the file (if it could \r
+# be obtained via FILE_VERSION_FILTER)\r
+\r
+WARN_FORMAT            = "$file:$line: $text"\r
+\r
+# The WARN_LOGFILE tag can be used to specify a file to which warning \r
+# and error messages should be written. If left blank the output is written \r
+# to stderr.\r
+\r
+WARN_LOGFILE           = \r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the input files\r
+#---------------------------------------------------------------------------\r
+\r
+# The INPUT tag can be used to specify the files and/or directories that contain \r
+# documented source files. You may enter file names like "myfile.cpp" or \r
+# directories like "/usr/src/myproject". Separate the files or directories \r
+# with spaces.\r
+\r
+INPUT                  = ./\r
+\r
+# This tag can be used to specify the character encoding of the source files \r
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is \r
+# also the default input encoding. Doxygen uses libiconv (or the iconv built \r
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for \r
+# the list of possible encodings.\r
+\r
+INPUT_ENCODING         = UTF-8\r
+\r
+# If the value of the INPUT tag contains directories, you can use the \r
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp \r
+# and *.h) to filter out the source-files in the directories. If left \r
+# blank the following patterns are tested: \r
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx \r
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90\r
+\r
+FILE_PATTERNS          = *.h \\r
+                         *.c \\r
+                                                *.txt\r
+\r
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories \r
+# should be searched for input files as well. Possible values are YES and NO. \r
+# If left blank NO is used.\r
+\r
+RECURSIVE              = YES\r
+\r
+# The EXCLUDE tag can be used to specify files and/or directories that should \r
+# excluded from the INPUT source files. This way you can easily exclude a \r
+# subdirectory from a directory tree whose root is specified with the INPUT tag.\r
+\r
+EXCLUDE                = \r
+\r
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or \r
+# directories that are symbolic links (a Unix filesystem feature) are excluded \r
+# from the input.\r
+\r
+EXCLUDE_SYMLINKS       = NO\r
+\r
+# If the value of the INPUT tag contains directories, you can use the \r
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude \r
+# certain files from those directories. Note that the wildcards are matched \r
+# against the file with absolute path, so to exclude all test directories \r
+# for example use the pattern */test/*\r
+\r
+EXCLUDE_PATTERNS       = */LowLevel/USBMode.h\r
+\r
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names \r
+# (namespaces, classes, functions, etc.) that should be excluded from the \r
+# output. The symbol name can be a fully qualified name, a word, or if the \r
+# wildcard * is used, a substring. Examples: ANamespace, AClass, \r
+# AClass::ANamespace, ANamespace::*Test\r
+\r
+EXCLUDE_SYMBOLS        = __*\r
+\r
+# The EXAMPLE_PATH tag can be used to specify one or more files or \r
+# directories that contain example code fragments that are included (see \r
+# the \include command).\r
+\r
+EXAMPLE_PATH           = \r
+\r
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the \r
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp \r
+# and *.h) to filter out the source-files in the directories. If left \r
+# blank all files are included.\r
+\r
+EXAMPLE_PATTERNS       = *\r
+\r
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be \r
+# searched for input files to be used with the \include or \dontinclude \r
+# commands irrespective of the value of the RECURSIVE tag. \r
+# Possible values are YES and NO. If left blank NO is used.\r
+\r
+EXAMPLE_RECURSIVE      = NO\r
+\r
+# The IMAGE_PATH tag can be used to specify one or more files or \r
+# directories that contain image that are included in the documentation (see \r
+# the \image command).\r
+\r
+IMAGE_PATH             = \r
+\r
+# The INPUT_FILTER tag can be used to specify a program that doxygen should \r
+# invoke to filter for each input file. Doxygen will invoke the filter program \r
+# by executing (via popen()) the command <filter> <input-file>, where <filter> \r
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an \r
+# input file. Doxygen will then use the output that the filter program writes \r
+# to standard output.  If FILTER_PATTERNS is specified, this tag will be \r
+# ignored.\r
+\r
+INPUT_FILTER           = \r
+\r
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern \r
+# basis.  Doxygen will compare the file name with each pattern and apply the \r
+# filter if there is a match.  The filters are a list of the form: \r
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further \r
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER \r
+# is applied to all files.\r
+\r
+FILTER_PATTERNS        = \r
+\r
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using \r
+# INPUT_FILTER) will be used to filter the input files when producing source \r
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).\r
+\r
+FILTER_SOURCE_FILES    = NO\r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to source browsing\r
+#---------------------------------------------------------------------------\r
+\r
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will \r
+# be generated. Documented entities will be cross-referenced with these sources. \r
+# Note: To get rid of all source code in the generated output, make sure also \r
+# VERBATIM_HEADERS is set to NO.\r
+\r
+SOURCE_BROWSER         = NO\r
+\r
+# Setting the INLINE_SOURCES tag to YES will include the body \r
+# of functions and classes directly in the documentation.\r
+\r
+INLINE_SOURCES         = NO\r
+\r
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct \r
+# doxygen to hide any special comment blocks from generated source code \r
+# fragments. Normal C and C++ comments will always remain visible.\r
+\r
+STRIP_CODE_COMMENTS    = YES\r
+\r
+# If the REFERENCED_BY_RELATION tag is set to YES \r
+# then for each documented function all documented \r
+# functions referencing it will be listed.\r
+\r
+REFERENCED_BY_RELATION = NO\r
+\r
+# If the REFERENCES_RELATION tag is set to YES \r
+# then for each documented function all documented entities \r
+# called/used by that function will be listed.\r
+\r
+REFERENCES_RELATION    = NO\r
+\r
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)\r
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from\r
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will\r
+# link to the source code.  Otherwise they will link to the documentstion.\r
+\r
+REFERENCES_LINK_SOURCE = NO\r
+\r
+# If the USE_HTAGS tag is set to YES then the references to source code \r
+# will point to the HTML generated by the htags(1) tool instead of doxygen \r
+# built-in source browser. The htags tool is part of GNU's global source \r
+# tagging system (see http://www.gnu.org/software/global/global.html). You \r
+# will need version 4.8.6 or higher.\r
+\r
+USE_HTAGS              = NO\r
+\r
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen \r
+# will generate a verbatim copy of the header file for each class for \r
+# which an include is specified. Set to NO to disable this.\r
+\r
+VERBATIM_HEADERS       = NO\r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the alphabetical class index\r
+#---------------------------------------------------------------------------\r
+\r
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index \r
+# of all compounds will be generated. Enable this if the project \r
+# contains a lot of classes, structs, unions or interfaces.\r
+\r
+ALPHABETICAL_INDEX     = YES\r
+\r
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then \r
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns \r
+# in which this list will be split (can be a number in the range [1..20])\r
+\r
+COLS_IN_ALPHA_INDEX    = 5\r
+\r
+# In case all classes in a project start with a common prefix, all \r
+# classes will be put under the same header in the alphabetical index. \r
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that \r
+# should be ignored while generating the index headers.\r
+\r
+IGNORE_PREFIX          = \r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the HTML output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will \r
+# generate HTML output.\r
+\r
+GENERATE_HTML          = YES\r
+\r
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. \r
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
+# put in front of it. If left blank `html' will be used as the default path.\r
+\r
+HTML_OUTPUT            = html\r
+\r
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for \r
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank \r
+# doxygen will generate files with .html extension.\r
+\r
+HTML_FILE_EXTENSION    = .html\r
+\r
+# The HTML_HEADER tag can be used to specify a personal HTML header for \r
+# each generated HTML page. If it is left blank doxygen will generate a \r
+# standard header.\r
+\r
+HTML_HEADER            = \r
+\r
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for \r
+# each generated HTML page. If it is left blank doxygen will generate a \r
+# standard footer.\r
+\r
+HTML_FOOTER            = \r
+\r
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading \r
+# style sheet that is used by each HTML page. It can be used to \r
+# fine-tune the look of the HTML output. If the tag is left blank doxygen \r
+# will generate a default style sheet. Note that doxygen will try to copy \r
+# the style sheet file to the HTML output directory, so don't put your own \r
+# stylesheet in the HTML output directory as well, or it will be erased!\r
+\r
+HTML_STYLESHEET        = \r
+\r
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, \r
+# files or namespaces will be aligned in HTML using tables. If set to \r
+# NO a bullet list will be used.\r
+\r
+HTML_ALIGN_MEMBERS     = YES\r
+\r
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML \r
+# documentation will contain sections that can be hidden and shown after the \r
+# page has loaded. For this to work a browser that supports \r
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox \r
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).\r
+\r
+HTML_DYNAMIC_SECTIONS  = YES\r
+\r
+# If the GENERATE_DOCSET tag is set to YES, additional index files \r
+# will be generated that can be used as input for Apple's Xcode 3 \r
+# integrated development environment, introduced with OSX 10.5 (Leopard). \r
+# To create a documentation set, doxygen will generate a Makefile in the \r
+# HTML output directory. Running make will produce the docset in that \r
+# directory and running "make install" will install the docset in \r
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find \r
+# it at startup. \r
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.\r
+\r
+GENERATE_DOCSET        = NO\r
+\r
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the \r
+# feed. A documentation feed provides an umbrella under which multiple \r
+# documentation sets from a single provider (such as a company or product suite) \r
+# can be grouped.\r
+\r
+DOCSET_FEEDNAME        = "Doxygen generated docs"\r
+\r
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that \r
+# should uniquely identify the documentation set bundle. This should be a \r
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen \r
+# will append .docset to the name.\r
+\r
+DOCSET_BUNDLE_ID       = org.doxygen.Project\r
+\r
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files \r
+# will be generated that can be used as input for tools like the \r
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) \r
+# of the generated HTML documentation.\r
+\r
+GENERATE_HTMLHELP      = NO\r
+\r
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can \r
+# be used to specify the file name of the resulting .chm file. You \r
+# can add a path in front of the file if the result should not be \r
+# written to the html output directory.\r
+\r
+CHM_FILE               = \r
+\r
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can \r
+# be used to specify the location (absolute path including file name) of \r
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run \r
+# the HTML help compiler on the generated index.hhp.\r
+\r
+HHC_LOCATION           = \r
+\r
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag \r
+# controls if a separate .chi index file is generated (YES) or that \r
+# it should be included in the master .chm file (NO).\r
+\r
+GENERATE_CHI           = NO\r
+\r
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING\r
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file\r
+# content.\r
+\r
+CHM_INDEX_ENCODING     = \r
+\r
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag \r
+# controls whether a binary table of contents is generated (YES) or a \r
+# normal table of contents (NO) in the .chm file.\r
+\r
+BINARY_TOC             = NO\r
+\r
+# The TOC_EXPAND flag can be set to YES to add extra items for group members \r
+# to the contents of the HTML help documentation and to the tree view.\r
+\r
+TOC_EXPAND             = YES\r
+\r
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER \r
+# are set, an additional index file will be generated that can be used as input for \r
+# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated \r
+# HTML documentation.\r
+\r
+GENERATE_QHP           = NO\r
+\r
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can \r
+# be used to specify the file name of the resulting .qch file. \r
+# The path specified is relative to the HTML output folder.\r
+\r
+QCH_FILE               = \r
+\r
+# The QHP_NAMESPACE tag specifies the namespace to use when generating \r
+# Qt Help Project output. For more information please see \r
+# <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.\r
+\r
+QHP_NAMESPACE          = org.doxygen.Project\r
+\r
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating \r
+# Qt Help Project output. For more information please see \r
+# <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.\r
+\r
+QHP_VIRTUAL_FOLDER     = doc\r
+\r
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can \r
+# be used to specify the location of Qt's qhelpgenerator. \r
+# If non-empty doxygen will try to run qhelpgenerator on the generated \r
+# .qhp file .\r
+\r
+QHG_LOCATION           = \r
+\r
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at \r
+# top of each HTML page. The value NO (the default) enables the index and \r
+# the value YES disables it.\r
+\r
+DISABLE_INDEX          = NO\r
+\r
+# This tag can be used to set the number of enum values (range [1..20]) \r
+# that doxygen will group on one line in the generated HTML documentation.\r
+\r
+ENUM_VALUES_PER_LINE   = 1\r
+\r
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index\r
+# structure should be generated to display hierarchical information.\r
+# If the tag value is set to FRAME, a side panel will be generated\r
+# containing a tree-like index structure (just like the one that \r
+# is generated for HTML Help). For this to work a browser that supports \r
+# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, \r
+# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are \r
+# probably better off using the HTML help feature. Other possible values \r
+# for this tag are: HIERARCHIES, which will generate the Groups, Directories,\r
+# and Class Hierarchy pages using a tree view instead of an ordered list;\r
+# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which\r
+# disables this behavior completely. For backwards compatibility with previous\r
+# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE\r
+# respectively.\r
+\r
+GENERATE_TREEVIEW      = YES\r
+\r
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be \r
+# used to set the initial width (in pixels) of the frame in which the tree \r
+# is shown.\r
+\r
+TREEVIEW_WIDTH         = 250\r
+\r
+# Use this tag to change the font size of Latex formulas included \r
+# as images in the HTML documentation. The default is 10. Note that \r
+# when you change the font size after a successful doxygen run you need \r
+# to manually remove any form_*.png images from the HTML output directory \r
+# to force them to be regenerated.\r
+\r
+FORMULA_FONTSIZE       = 10\r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the LaTeX output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will \r
+# generate Latex output.\r
+\r
+GENERATE_LATEX         = NO\r
+\r
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. \r
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
+# put in front of it. If left blank `latex' will be used as the default path.\r
+\r
+LATEX_OUTPUT           = latex\r
+\r
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be \r
+# invoked. If left blank `latex' will be used as the default command name.\r
+\r
+LATEX_CMD_NAME         = latex\r
+\r
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to \r
+# generate index for LaTeX. If left blank `makeindex' will be used as the \r
+# default command name.\r
+\r
+MAKEINDEX_CMD_NAME     = makeindex\r
+\r
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact \r
+# LaTeX documents. This may be useful for small projects and may help to \r
+# save some trees in general.\r
+\r
+COMPACT_LATEX          = NO\r
+\r
+# The PAPER_TYPE tag can be used to set the paper type that is used \r
+# by the printer. Possible values are: a4, a4wide, letter, legal and \r
+# executive. If left blank a4wide will be used.\r
+\r
+PAPER_TYPE             = a4wide\r
+\r
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX \r
+# packages that should be included in the LaTeX output.\r
+\r
+EXTRA_PACKAGES         = \r
+\r
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for \r
+# the generated latex document. The header should contain everything until \r
+# the first chapter. If it is left blank doxygen will generate a \r
+# standard header. Notice: only use this tag if you know what you are doing!\r
+\r
+LATEX_HEADER           = \r
+\r
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated \r
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will \r
+# contain links (just like the HTML output) instead of page references \r
+# This makes the output suitable for online browsing using a pdf viewer.\r
+\r
+PDF_HYPERLINKS         = YES\r
+\r
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of \r
+# plain latex in the generated Makefile. Set this option to YES to get a \r
+# higher quality PDF documentation.\r
+\r
+USE_PDFLATEX           = YES\r
+\r
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. \r
+# command to the generated LaTeX files. This will instruct LaTeX to keep \r
+# running if errors occur, instead of asking the user for help. \r
+# This option is also used when generating formulas in HTML.\r
+\r
+LATEX_BATCHMODE        = NO\r
+\r
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not \r
+# include the index chapters (such as File Index, Compound Index, etc.) \r
+# in the output.\r
+\r
+LATEX_HIDE_INDICES     = NO\r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the RTF output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output \r
+# The RTF output is optimized for Word 97 and may not look very pretty with \r
+# other RTF readers or editors.\r
+\r
+GENERATE_RTF           = NO\r
+\r
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. \r
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
+# put in front of it. If left blank `rtf' will be used as the default path.\r
+\r
+RTF_OUTPUT             = rtf\r
+\r
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact \r
+# RTF documents. This may be useful for small projects and may help to \r
+# save some trees in general.\r
+\r
+COMPACT_RTF            = NO\r
+\r
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated \r
+# will contain hyperlink fields. The RTF file will \r
+# contain links (just like the HTML output) instead of page references. \r
+# This makes the output suitable for online browsing using WORD or other \r
+# programs which support those fields. \r
+# Note: wordpad (write) and others do not support links.\r
+\r
+RTF_HYPERLINKS         = NO\r
+\r
+# Load stylesheet definitions from file. Syntax is similar to doxygen's \r
+# config file, i.e. a series of assignments. You only have to provide \r
+# replacements, missing definitions are set to their default value.\r
+\r
+RTF_STYLESHEET_FILE    = \r
+\r
+# Set optional variables used in the generation of an rtf document. \r
+# Syntax is similar to doxygen's config file.\r
+\r
+RTF_EXTENSIONS_FILE    = \r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the man page output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will \r
+# generate man pages\r
+\r
+GENERATE_MAN           = NO\r
+\r
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. \r
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
+# put in front of it. If left blank `man' will be used as the default path.\r
+\r
+MAN_OUTPUT             = man\r
+\r
+# The MAN_EXTENSION tag determines the extension that is added to \r
+# the generated man pages (default is the subroutine's section .3)\r
+\r
+MAN_EXTENSION          = .3\r
+\r
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output, \r
+# then it will generate one additional man file for each entity \r
+# documented in the real man page(s). These additional files \r
+# only source the real man page, but without them the man command \r
+# would be unable to find the correct page. The default is NO.\r
+\r
+MAN_LINKS              = NO\r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the XML output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_XML tag is set to YES Doxygen will \r
+# generate an XML file that captures the structure of \r
+# the code including all documentation.\r
+\r
+GENERATE_XML           = NO\r
+\r
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. \r
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
+# put in front of it. If left blank `xml' will be used as the default path.\r
+\r
+XML_OUTPUT             = xml\r
+\r
+# The XML_SCHEMA tag can be used to specify an XML schema, \r
+# which can be used by a validating XML parser to check the \r
+# syntax of the XML files.\r
+\r
+XML_SCHEMA             = \r
+\r
+# The XML_DTD tag can be used to specify an XML DTD, \r
+# which can be used by a validating XML parser to check the \r
+# syntax of the XML files.\r
+\r
+XML_DTD                = \r
+\r
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will \r
+# dump the program listings (including syntax highlighting \r
+# and cross-referencing information) to the XML output. Note that \r
+# enabling this will significantly increase the size of the XML output.\r
+\r
+XML_PROGRAMLISTING     = YES\r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options for the AutoGen Definitions output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will \r
+# generate an AutoGen Definitions (see autogen.sf.net) file \r
+# that captures the structure of the code including all \r
+# documentation. Note that this feature is still experimental \r
+# and incomplete at the moment.\r
+\r
+GENERATE_AUTOGEN_DEF   = NO\r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the Perl module output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will \r
+# generate a Perl module file that captures the structure of \r
+# the code including all documentation. Note that this \r
+# feature is still experimental and incomplete at the \r
+# moment.\r
+\r
+GENERATE_PERLMOD       = NO\r
+\r
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate \r
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able \r
+# to generate PDF and DVI output from the Perl module output.\r
+\r
+PERLMOD_LATEX          = NO\r
+\r
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be \r
+# nicely formatted so it can be parsed by a human reader.  This is useful \r
+# if you want to understand what is going on.  On the other hand, if this \r
+# tag is set to NO the size of the Perl module output will be much smaller \r
+# and Perl will parse it just the same.\r
+\r
+PERLMOD_PRETTY         = YES\r
+\r
+# The names of the make variables in the generated doxyrules.make file \r
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. \r
+# This is useful so different doxyrules.make files included by the same \r
+# Makefile don't overwrite each other's variables.\r
+\r
+PERLMOD_MAKEVAR_PREFIX = \r
+\r
+#---------------------------------------------------------------------------\r
+# Configuration options related to the preprocessor   \r
+#---------------------------------------------------------------------------\r
+\r
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will \r
+# evaluate all C-preprocessor directives found in the sources and include \r
+# files.\r
+\r
+ENABLE_PREPROCESSING   = YES\r
+\r
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro \r
+# names in the source code. If set to NO (the default) only conditional \r
+# compilation will be performed. Macro expansion can be done in a controlled \r
+# way by setting EXPAND_ONLY_PREDEF to YES.\r
+\r
+MACRO_EXPANSION        = YES\r
+\r
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES \r
+# then the macro expansion is limited to the macros specified with the \r
+# PREDEFINED and EXPAND_AS_DEFINED tags.\r
+\r
+EXPAND_ONLY_PREDEF     = YES\r
+\r
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files \r
+# in the INCLUDE_PATH (see below) will be search if a #include is found.\r
+\r
+SEARCH_INCLUDES        = YES\r
+\r
+# The INCLUDE_PATH tag can be used to specify one or more directories that \r
+# contain include files that are not input files but should be processed by \r
+# the preprocessor.\r
+\r
+INCLUDE_PATH           = \r
+\r
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard \r
+# patterns (like *.h and *.hpp) to filter out the header-files in the \r
+# directories. If left blank, the patterns specified with FILE_PATTERNS will \r
+# be used.\r
+\r
+INCLUDE_FILE_PATTERNS  = \r
+\r
+# The PREDEFINED tag can be used to specify one or more macro names that \r
+# are defined before the preprocessor is started (similar to the -D option of \r
+# gcc). The argument of the tag is a list of macros of the form: name \r
+# or name=definition (no spaces). If the definition and the = are \r
+# omitted =1 is assumed. To prevent a macro definition from being \r
+# undefined via #undef or recursively expanded use the := operator \r
+# instead of the = operator.\r
+\r
+PREDEFINED             = __DOXYGEN__\r
+\r
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then \r
+# this tag can be used to specify a list of macro names that should be expanded. \r
+# The macro definition that is found in the sources will be used. \r
+# Use the PREDEFINED tag if you want to use a different macro definition.\r
+\r
+EXPAND_AS_DEFINED      = BUTTLOADTAG\r
+\r
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then \r
+# doxygen's preprocessor will remove all function-like macros that are alone \r
+# on a line, have an all uppercase name, and do not end with a semicolon. Such \r
+# function macros are typically used for boiler-plate code, and will confuse \r
+# the parser if not removed.\r
+\r
+SKIP_FUNCTION_MACROS   = YES\r
+\r
+#---------------------------------------------------------------------------\r
+# Configuration::additions related to external references   \r
+#---------------------------------------------------------------------------\r
+\r
+# The TAGFILES option can be used to specify one or more tagfiles. \r
+# Optionally an initial location of the external documentation \r
+# can be added for each tagfile. The format of a tag file without \r
+# this location is as follows: \r
+#   TAGFILES = file1 file2 ... \r
+# Adding location for the tag files is done as follows: \r
+#   TAGFILES = file1=loc1 "file2 = loc2" ... \r
+# where "loc1" and "loc2" can be relative or absolute paths or \r
+# URLs. If a location is present for each tag, the installdox tool \r
+# does not have to be run to correct the links.\r
+# Note that each tag file must have a unique name\r
+# (where the name does NOT include the path)\r
+# If a tag file is not located in the directory in which doxygen \r
+# is run, you must also specify the path to the tagfile here.\r
+\r
+TAGFILES               = \r
+\r
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create \r
+# a tag file that is based on the input files it reads.\r
+\r
+GENERATE_TAGFILE       = \r
+\r
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed \r
+# in the class index. If set to NO only the inherited external classes \r
+# will be listed.\r
+\r
+ALLEXTERNALS           = NO\r
+\r
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed \r
+# in the modules index. If set to NO, only the current project's groups will \r
+# be listed.\r
+\r
+EXTERNAL_GROUPS        = YES\r
+\r
+# The PERL_PATH should be the absolute path and name of the perl script \r
+# interpreter (i.e. the result of `which perl').\r
+\r
+PERL_PATH              = /usr/bin/perl\r
+\r
+#---------------------------------------------------------------------------\r
+# Configuration options related to the dot tool   \r
+#---------------------------------------------------------------------------\r
+\r
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will \r
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base \r
+# or super classes. Setting the tag to NO turns the diagrams off. Note that \r
+# this option is superseded by the HAVE_DOT option below. This is only a \r
+# fallback. It is recommended to install and use dot, since it yields more \r
+# powerful graphs.\r
+\r
+CLASS_DIAGRAMS         = NO\r
+\r
+# You can define message sequence charts within doxygen comments using the \msc \r
+# command. Doxygen will then run the mscgen tool (see \r
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the \r
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where \r
+# the mscgen tool resides. If left empty the tool is assumed to be found in the \r
+# default search path.\r
+\r
+MSCGEN_PATH            = \r
+\r
+# If set to YES, the inheritance and collaboration graphs will hide \r
+# inheritance and usage relations if the target is undocumented \r
+# or is not a class.\r
+\r
+HIDE_UNDOC_RELATIONS   = YES\r
+\r
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is \r
+# available from the path. This tool is part of Graphviz, a graph visualization \r
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section \r
+# have no effect if this option is set to NO (the default)\r
+\r
+HAVE_DOT               = NO\r
+\r
+# By default doxygen will write a font called FreeSans.ttf to the output \r
+# directory and reference it in all dot files that doxygen generates. This \r
+# font does not include all possible unicode characters however, so when you need \r
+# these (or just want a differently looking font) you can specify the font name \r
+# using DOT_FONTNAME. You need need to make sure dot is able to find the font, \r
+# which can be done by putting it in a standard location or by setting the \r
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory \r
+# containing the font.\r
+\r
+DOT_FONTNAME           = FreeSans\r
+\r
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. \r
+# The default size is 10pt.\r
+\r
+DOT_FONTSIZE           = 10\r
+\r
+# By default doxygen will tell dot to use the output directory to look for the \r
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a \r
+# different font using DOT_FONTNAME you can set the path where dot \r
+# can find it using this tag.\r
+\r
+DOT_FONTPATH           = \r
+\r
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen \r
+# will generate a graph for each documented class showing the direct and \r
+# indirect inheritance relations. Setting this tag to YES will force the \r
+# the CLASS_DIAGRAMS tag to NO.\r
+\r
+CLASS_GRAPH            = NO\r
+\r
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen \r
+# will generate a graph for each documented class showing the direct and \r
+# indirect implementation dependencies (inheritance, containment, and \r
+# class references variables) of the class with other documented classes.\r
+\r
+COLLABORATION_GRAPH    = NO\r
+\r
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen \r
+# will generate a graph for groups, showing the direct groups dependencies\r
+\r
+GROUP_GRAPHS           = NO\r
+\r
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and \r
+# collaboration diagrams in a style similar to the OMG's Unified Modeling \r
+# Language.\r
+\r
+UML_LOOK               = NO\r
+\r
+# If set to YES, the inheritance and collaboration graphs will show the \r
+# relations between templates and their instances.\r
+\r
+TEMPLATE_RELATIONS     = NO\r
+\r
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT \r
+# tags are set to YES then doxygen will generate a graph for each documented \r
+# file showing the direct and indirect include dependencies of the file with \r
+# other documented files.\r
+\r
+INCLUDE_GRAPH          = NO\r
+\r
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and \r
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each \r
+# documented header file showing the documented files that directly or \r
+# indirectly include this file.\r
+\r
+INCLUDED_BY_GRAPH      = NO\r
+\r
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then \r
+# doxygen will generate a call dependency graph for every global function \r
+# or class method. Note that enabling this option will significantly increase \r
+# the time of a run. So in most cases it will be better to enable call graphs \r
+# for selected functions only using the \callgraph command.\r
+\r
+CALL_GRAPH             = NO\r
+\r
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then \r
+# doxygen will generate a caller dependency graph for every global function \r
+# or class method. Note that enabling this option will significantly increase \r
+# the time of a run. So in most cases it will be better to enable caller \r
+# graphs for selected functions only using the \callergraph command.\r
+\r
+CALLER_GRAPH           = NO\r
+\r
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen \r
+# will graphical hierarchy of all classes instead of a textual one.\r
+\r
+GRAPHICAL_HIERARCHY    = NO\r
+\r
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES \r
+# then doxygen will show the dependencies a directory has on other directories \r
+# in a graphical way. The dependency relations are determined by the #include\r
+# relations between the files in the directories.\r
+\r
+DIRECTORY_GRAPH        = NO\r
+\r
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images \r
+# generated by dot. Possible values are png, jpg, or gif\r
+# If left blank png will be used.\r
+\r
+DOT_IMAGE_FORMAT       = png\r
+\r
+# The tag DOT_PATH can be used to specify the path where the dot tool can be \r
+# found. If left blank, it is assumed the dot tool can be found in the path.\r
+\r
+DOT_PATH               = "C:/Program Files/Graphviz2.18/bin"\r
+\r
+# The DOTFILE_DIRS tag can be used to specify one or more directories that \r
+# contain dot files that are included in the documentation (see the \r
+# \dotfile command).\r
+\r
+DOTFILE_DIRS           = \r
+\r
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of \r
+# nodes that will be shown in the graph. If the number of nodes in a graph \r
+# becomes larger than this value, doxygen will truncate the graph, which is \r
+# visualized by representing a node as a red box. Note that doxygen if the \r
+# number of direct children of the root node in a graph is already larger than \r
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note \r
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.\r
+\r
+DOT_GRAPH_MAX_NODES    = 15\r
+\r
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the \r
+# graphs generated by dot. A depth value of 3 means that only nodes reachable \r
+# from the root by following a path via at most 3 edges will be shown. Nodes \r
+# that lay further from the root node will be omitted. Note that setting this \r
+# option to 1 or 2 may greatly reduce the computation time needed for large \r
+# code bases. Also note that the size of a graph can be further restricted by \r
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.\r
+\r
+MAX_DOT_GRAPH_DEPTH    = 2\r
+\r
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent \r
+# background. This is disabled by default, because dot on Windows does not \r
+# seem to support this out of the box. Warning: Depending on the platform used, \r
+# enabling this option may lead to badly anti-aliased labels on the edges of \r
+# a graph (i.e. they become hard to read).\r
+\r
+DOT_TRANSPARENT        = YES\r
+\r
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output \r
+# files in one run (i.e. multiple -o and -T options on the command line). This \r
+# makes dot run faster, but since only newer versions of dot (>1.8.10) \r
+# support this, this feature is disabled by default.\r
+\r
+DOT_MULTI_TARGETS      = NO\r
+\r
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will \r
+# generate a legend page explaining the meaning of the various boxes and \r
+# arrows in the dot generated graphs.\r
+\r
+GENERATE_LEGEND        = YES\r
+\r
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will \r
+# remove the intermediate dot files that are used to generate \r
+# the various graphs.\r
+\r
+DOT_CLEANUP            = YES\r
+\r
+#---------------------------------------------------------------------------\r
+# Configuration::additions related to the search engine   \r
+#---------------------------------------------------------------------------\r
+\r
+# The SEARCHENGINE tag specifies whether or not a search engine should be \r
+# used. If set to NO the values of all tags below this one will be ignored.\r
+\r
+SEARCHENGINE           = NO\r
diff --git a/Projects/AVRISP_Programmer/LUFA AVRISP_Programmer.inf b/Projects/AVRISP_Programmer/LUFA AVRISP_Programmer.inf
new file mode 100644 (file)
index 0000000..bd9c8bf
--- /dev/null
@@ -0,0 +1,55 @@
+;  Windows LUFA USB to Serial Setup File\r
+; Copyright (c) 2000 Microsoft Corporation\r
+\r
+[Version] \r
+Signature="$Windows NT$" \r
+Class=Ports\r
+ClassGuid={4D36E978-E325-11CE-BFC1-08002BE10318} \r
+Provider=%COMPANY% \r
+LayoutFile=layout.inf\r
+DriverVer=06/06/2006,1.0.0.0\r
+\r
+[Manufacturer] \r
+%MFGNAME% = ManufName\r
+\r
+[DestinationDirs] \r
+DefaultDestDir=12 \r
+\r
+[ManufName] \r
+%Modem3% = Modem3, USB\VID_03EB&PID_204B\r
+\r
+;------------------------------------------------------------------------------\r
+;  Windows 2000/XP Sections\r
+;------------------------------------------------------------------------------\r
+\r
+[Modem3.nt]\r
+CopyFiles=USBModemCopyFileSection\r
+AddReg=Modem3.nt.AddReg \r
+\r
+[USBModemCopyFileSection]\r
+usbser.sys,,,0x20\r
+\r
+[Modem3.nt.AddReg] \r
+HKR,,DevLoader,,*ntkern \r
+HKR,,NTMPDriver,,usbser.sys \r
+HKR,,EnumPropPages32,,"MsPorts.dll,SerialPortPropPageProvider" \r
+\r
+[Modem3.nt.Services] \r
+AddService=usbser, 0x00000002, DriverService\r
+\r
+[DriverService] \r
+DisplayName=%SERVICE%\r
+ServiceType=1\r
+StartType=3\r
+ErrorControl=1\r
+ServiceBinary=%12%\usbser.sys \r
+\r
+;------------------------------------------------------------------------------\r
+;  String Definitions\r
+;------------------------------------------------------------------------------\r
+\r
+[Strings] \r
+COMPANY="LUFA Library"\r
+MFGNAME="Dean Camera"\r
+Modem3="USB Virtual Serial Port" \r
+SERVICE="USB Virtual Serial Port CDC Driver"
\ No newline at end of file
diff --git a/Projects/AVRISP_Programmer/RingBuff.c b/Projects/AVRISP_Programmer/RingBuff.c
new file mode 100644 (file)
index 0000000..1f477f1
--- /dev/null
@@ -0,0 +1,120 @@
+/*\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  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
+#include "RingBuff.h"\r
+\r
+void Buffer_Initialize(RingBuff_t* Buffer)\r
+{\r
+       BUFF_ATOMIC_BLOCK\r
+       {\r
+               Buffer->InPtr    = (RingBuff_Data_t*)&Buffer->Buffer;\r
+               Buffer->OutPtr   = (RingBuff_Data_t*)&Buffer->Buffer;\r
+               Buffer->Elements = 0;\r
+       }\r
+}\r
+\r
+void Buffer_StoreElement(RingBuff_t* Buffer, RingBuff_Data_t Data)\r
+{\r
+       BUFF_ATOMIC_BLOCK\r
+       {\r
+       #if defined(BUFF_DROPOLD)\r
+               if (Buffer->Elements == BUFF_LENGTH)\r
+               {\r
+                       Buffer->OutPtr++;\r
+       \r
+                       if (Buffer->OutPtr == &Buffer->Buffer[BUFF_LENGTH])\r
+                         Buffer->OutPtr = (RingBuff_Data_t*)&Buffer->Buffer;\r
+               }\r
+               else\r
+               {\r
+                       Buffer->Elements++;\r
+               }\r
+       #elif defined(BUFF_DROPNEW)\r
+               if (Buffer->Elements == BUFF_LENGTH)\r
+                 return;\r
+       \r
+                 Buffer->Elements++;\r
+       #elif defined(BUFF_NODROPCHECK)\r
+                 Buffer->Elements++;\r
+       #endif\r
+       \r
+               *(Buffer->InPtr) = Data;\r
+               Buffer->InPtr++;\r
+       \r
+               if (Buffer->InPtr == &Buffer->Buffer[BUFF_LENGTH])\r
+                 Buffer->InPtr = (RingBuff_Data_t*)&Buffer->Buffer;\r
+       }\r
+}\r
+\r
+RingBuff_Data_t Buffer_GetElement(RingBuff_t* Buffer)\r
+{\r
+       RingBuff_Data_t BuffData;\r
+       \r
+       BUFF_ATOMIC_BLOCK\r
+       {\r
+#if defined(BUFF_EMPTYRETURNSZERO)\r
+               if (!(Buffer->Elements))\r
+                 return 0;\r
+#elif !defined(BUFF_NOEMPTYCHECK)\r
+       #error No empty buffer check behaviour specified.\r
+#endif\r
+\r
+               BuffData = *(Buffer->OutPtr);\r
+       \r
+               Buffer->OutPtr++;\r
+               Buffer->Elements--;\r
+       \r
+               if (Buffer->OutPtr == &Buffer->Buffer[BUFF_LENGTH])\r
+                 Buffer->OutPtr = (RingBuff_Data_t*)&Buffer->Buffer;\r
+       }\r
+       \r
+       return BuffData;\r
+}\r
+\r
+#if defined(BUFF_USEPEEK)\r
+RingBuff_Data_t Buffer_PeekElement(const RingBuff_t* Buffer)\r
+{\r
+       RingBuff_Data_t BuffData;\r
+\r
+       BUFF_ATOMIC_BLOCK\r
+       {\r
+#if defined(BUFF_EMPTYRETURNSZERO)\r
+               if (!(Buffer->Elements))\r
+                 return 0;\r
+#elif !defined(BUFF_NOEMPTYCHECK)\r
+       #error No empty buffer check behaviour specified.\r
+#endif\r
+\r
+               BuffData = *(Buffer->OutPtr);\r
+       }\r
+\r
+       return BuffData;\r
+}\r
+#endif\r
diff --git a/Projects/AVRISP_Programmer/RingBuff.h b/Projects/AVRISP_Programmer/RingBuff.h
new file mode 100644 (file)
index 0000000..68e4a6e
--- /dev/null
@@ -0,0 +1,116 @@
+/*\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  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
+/* Buffer Configuration: */\r
+   /* Buffer length - select static size of created ringbuffers: */\r
+        #define BUFF_STATICSIZE 128      // Set to the static ringbuffer size for all ringbuffers (place size after define)\r
+\r
+   /* Volatile mode - uncomment to make buffers volatile, for use in ISRs, etc: */\r
+        #define BUFF_VOLATILE            // Uncomment to cause all ring buffers to become volatile (and atomic if multi-byte) in access\r
+\r
+   /* Drop mode - select behaviour when Buffer_StoreElement called on a full buffer: */\r
+     #define BUFF_DROPOLD             // Uncomment to cause full ring buffers to drop the oldest character to make space when full\r
+     // #define BUFF_DROPNEW          // Uncomment to cause full ring buffers to drop the new character when full\r
+     // #define BUFF_NODROPCHECK      // Uncomment to ignore full ring buffer checks - checking left to user!\r
+\r
+   /* Underflow behaviour - select behaviour when Buffer_GetElement is called with an empty ringbuffer: */\r
+     //#define BUFF_EMPTYRETURNSZERO  // Uncomment to return 0 when an empty ringbuffer is read\r
+     #define BUFF_NOEMPTYCHECK        // Uncomment to disable checking of empty ringbuffers - checking left to user!\r
+       \r
+   /* Buffer storage type - set the datatype for the stored data */\r
+     #define BUFF_DATATYPE uint8_t    // Change to the data type that is going to be stored into the buffer\r
+       \r
+   /* Peek routine - uncomment to include the peek routine (fetches next byte without removing it from the buffer */\r
+     #define BUFF_USEPEEK\r
+               \r
+#ifndef _RINGBUFF_H_\r
+#define _RINGBUFF_H_\r
+\r
+       /* Includes: */\r
+       #include <avr/io.h>\r
+       #include <avr/interrupt.h>\r
+       #include <util/atomic.h>\r
+       #include <limits.h>\r
+\r
+       #include <LUFA/Common/Common.h>\r
+\r
+       /* Defines and checks: */\r
+       #if defined(BUFF_STATICSIZE)\r
+               #define BUFF_LENGTH BUFF_STATICSIZE\r
+       #else\r
+               #error No buffer length specified!\r
+       #endif\r
+\r
+       #if !(defined(BUFF_DROPOLD) || defined(BUFF_DROPNEW) || defined(BUFF_NODROPCHECK))\r
+               #error No buffer drop mode specified.\r
+       #endif\r
+\r
+       #if !defined(BUFF_DATATYPE)\r
+               #error Ringbuffer storage data type not specified.\r
+       #endif\r
+\r
+       #if defined(BUFF_VOLATILE)\r
+               #define BUFF_MODE            volatile\r
+               #define BUFF_ATOMIC_BLOCK    ATOMIC_BLOCK(ATOMIC_RESTORESTATE)\r
+       #else\r
+               #define BUFF_MODE\r
+               #define BUFF_ATOMIC_BLOCK\r
+       #endif\r
+\r
+       #if (BUFF_STATICSIZE   > LONG_MAX)\r
+               #define RingBuff_Elements_t uint64_t\r
+       #elif (BUFF_STATICSIZE > INT_MAX)\r
+               #define RingBuff_Elements_t uint32_t\r
+       #elif (BUFF_STATICSIZE > CHAR_MAX)\r
+               #define RingBuff_Elements_t uint16_t\r
+       #else\r
+               #define RingBuff_Elements_t uint8_t\r
+       #endif\r
+       \r
+       /* Type Defines: */\r
+       typedef BUFF_DATATYPE RingBuff_Data_t;\r
+\r
+       typedef BUFF_MODE struct\r
+       {\r
+               RingBuff_Data_t      Buffer[BUFF_LENGTH];\r
+               RingBuff_Data_t*     InPtr;\r
+               RingBuff_Data_t*     OutPtr;\r
+               RingBuff_Elements_t  Elements;\r
+       } RingBuff_t;\r
+               \r
+       /* Function Prototypes: */\r
+       void            Buffer_Initialize(RingBuff_t* Buff);\r
+       void            Buffer_StoreElement(RingBuff_t* Buffer, RingBuff_Data_t Data);\r
+       RingBuff_Data_t Buffer_GetElement(RingBuff_t* Buffer);\r
+       #if defined(BUFF_USEPEEK)\r
+               RingBuff_Data_t Buffer_PeekElement(const RingBuff_t* Buffer);\r
+       #endif\r
+       \r
+#endif\r
diff --git a/Projects/AVRISP_Programmer/Sample_Programming_Session.txt b/Projects/AVRISP_Programmer/Sample_Programming_Session.txt
new file mode 100644 (file)
index 0000000..b5af76e
--- /dev/null
@@ -0,0 +1,104 @@
+ubuntu@ubuntu:~/LUFA/Bootloaders/LUFA_DFU_Bootloader_AT90USB162$  sudo avrdude -vv -F -P /dev/ttyACM0 -c avr910 -p usb162 -U flash:w:BootloaderDFU.hex\r
+\r
+avrdude: Version 5.5, compiled on May  9 2008 at 13:04:46\r
+         Copyright (c) 2000-2005 Brian Dean, http://www.bdmicro.com/\r
+\r
+         System wide configuration file is "/etc/avrdude.conf"\r
+         User configuration file is "/home/ubuntu/.avrduderc"\r
+         User configuration file does not exist or is not a regular file, skipping\r
+\r
+         Using Port            : /dev/ttyACM0\r
+         Using Programmer      : avr910\r
+         AVR Part              : AT90USB162\r
+         Chip Erase delay      : 9000 us\r
+         PAGEL                 : PD7\r
+         BS2                   : PA0\r
+         RESET disposition     : dedicated\r
+         RETRY pulse           : SCK\r
+         serial program mode   : yes\r
+         parallel program mode : yes\r
+         Timeout               : 200\r
+         StabDelay             : 100\r
+         CmdexeDelay           : 25\r
+         SyncLoops             : 32\r
+         ByteDelay             : 0\r
+         PollIndex             : 3\r
+         PollValue             : 0x53\r
+         Memory Detail         :\r
+\r
+                                  Block Poll               Page                       Polled\r
+           Memory Type Mode Delay Size  Indx Paged  Size   Size #Pages MinW  MaxW   ReadBack\r
+           ----------- ---- ----- ----- ---- ------ ------ ---- ------ ----- ----- ---------\r
+           eeprom        65    10     8    0 no        512    4      0  9000  9000 0x00 0x00\r
+           flash         65     6   128    0 yes     16384  128    128  4500  4500 0x00 0x00\r
+           lfuse          0     0     0    0 no          1    0      0  9000  9000 0x00 0x00\r
+           hfuse          0     0     0    0 no          1    0      0  9000  9000 0x00 0x00\r
+           efuse          0     0     0    0 no          1    0      0  9000  9000 0x00 0x00\r
+           lock           0     0     0    0 no          1    0      0  9000  9000 0x00 0x00\r
+           calibration    0     0     0    0 no          1    0      0     0     0 0x00 0x00\r
+           signature      0     0     0    0 no          3    0      0     0     0 0x00 0x00\r
+\r
+         Programmer Type : avr910\r
+         Description     : Atmel Low Cost Serial Programmer\r
+\r
+Found programmer: Id = "AVR ISP"; type = S\r
+    Software Version = 2.3; Hardware Version = 1.0\r
+Programmer supports auto addr increment.\r
+\r
+Programmer supports the following devices:\r
+    Device code: 0x55 = ATtiny12\r
+    Device code: 0x56 = ATtiny15\r
+    Device code: 0x5e = ATtiny2313\r
+    Device code: 0x76 = ATMEGA8\r
+    Device code: 0x74 = ATMEGA6450\r
+    Device code: 0x72 = ATMEGA32\r
+    Device code: 0x45 = ATMEGA64\r
+    Device code: 0x74 = ATMEGA6450\r
+    Device code: 0x43 = ATMEGA128\r
+    Device code: 0x63 = ATMEGA162\r
+    Device code: 0x78 = ATMEGA169\r
+    Device code: 0x6c = AT90S4434\r
+    Device code: 0x38 = AT90S8515\r
+    Device code: 0x65 = (unknown)\r
+\r
+avrdude: warning: selected device is not supported by programmer: usb162\r
+avrdude: AVR device initialized and ready to accept instructions\r
+\r
+Reading | ################################################## | 100% 0.00s\r
+\r
+avrdude: Device signature = 0x1e9482\r
+avrdude: safemode: lfuse reads as 5E\r
+avrdude: safemode: hfuse reads as D9\r
+avrdude: safemode: efuse reads as F4\r
+avrdude: NOTE: FLASH memory has been specified, an erase cycle will be performed\r
+         To disable this feature, specify the -D option.\r
+avrdude: erasing chip\r
+avrdude: reading input file "BootloaderDFU.hex"\r
+avrdude: input file BootloaderDFU.hex auto detected as Intel Hex\r
+avrdude: writing flash (16066 bytes):\r
+\r
+Writing | ################################################## | 100% 33.39s\r
+\r
+\r
+\r
+avrdude: 16066 bytes of flash written\r
+avrdude: verifying flash memory against BootloaderDFU.hex:\r
+avrdude: load data flash data from input file BootloaderDFU.hex:\r
+avrdude: input file BootloaderDFU.hex auto detected as Intel Hex\r
+avrdude: input file BootloaderDFU.hex contains 16066 bytes\r
+avrdude: reading on-chip flash data:\r
+\r
+Reading | ################################################## | 100% 16.07s\r
+\r
+\r
+\r
+avrdude: verifying ...\r
+avrdude: 16066 bytes of flash verified\r
+\r
+avrdude: safemode: lfuse reads as 5E\r
+avrdude: safemode: hfuse reads as D9\r
+avrdude: safemode: efuse reads as F4\r
+avrdude: safemode: Fuses OK\r
+\r
+avrdude done.  Thank you.
+
diff --git a/Projects/AVRISP_Programmer/makefile b/Projects/AVRISP_Programmer/makefile
new file mode 100644 (file)
index 0000000..d6617dc
--- /dev/null
@@ -0,0 +1,704 @@
+# Hey Emacs, this is a -*- makefile -*-\r
+#----------------------------------------------------------------------------\r
+# WinAVR Makefile Template written by Eric B. Weddington, Jörg Wunsch, et al.\r
+#  >> Modified for use with the LUFA project. <<\r
+#\r
+# Released to the Public Domain\r
+#\r
+# Additional material for this makefile was written by:\r
+# Peter Fleury\r
+# Tim Henigan\r
+# Colin O'Flynn\r
+# Reiner Patommel\r
+# Markus Pfaff\r
+# Sander Pool\r
+# Frederik Rouleau\r
+# Carlos Lamas\r
+# Dean Camera\r
+# Opendous Inc.\r
+# Denver Gingerich\r
+#\r
+#----------------------------------------------------------------------------\r
+# On command line:\r
+#\r
+# make all = Make software.\r
+#\r
+# make clean = Clean out built project files.\r
+#\r
+# make coff = Convert ELF to AVR COFF.\r
+#\r
+# make extcoff = Convert ELF to AVR Extended COFF.\r
+#\r
+# make program = Download the hex file to the device, using avrdude.\r
+#                Please customize the avrdude settings below first!\r
+#\r
+# make dfu = Download the hex file to the device, using dfu-programmer (must\r
+#            have dfu-programmer installed).\r
+#\r
+# make flip = Download the hex file to the device, using Atmel FLIP (must\r
+#             have Atmel FLIP installed).\r
+#\r
+# make dfu-ee = Download the eeprom file to the device, using dfu-programmer\r
+#               (must have dfu-programmer installed).\r
+#\r
+# make flip-ee = Download the eeprom file to the device, using Atmel FLIP\r
+#                (must have Atmel FLIP installed).\r
+#\r
+# make doxygen = Generate DoxyGen documentation for the project (must have\r
+#                DoxyGen installed)\r
+#\r
+# make debug = Start either simulavr or avarice as specified for debugging, \r
+#              with avr-gdb or avr-insight as the front end for debugging.\r
+#\r
+# make filename.s = Just compile filename.c into the assembler code only.\r
+#\r
+# make filename.i = Create a preprocessed source file for use in submitting\r
+#                   bug reports to the GCC project.\r
+#\r
+# To rebuild project do "make clean" then "make all".\r
+#----------------------------------------------------------------------------\r
+\r
+\r
+# MCU name\r
+MCU = at90usb1287\r
+\r
+\r
+# Target board (USBKEY, STK525, STK526, RZUSBSTICK, USER or blank for projects not requiring\r
+# LUFA board drivers). If USER is selected, put custom board drivers in a directory called \r
+# "Board" inside the application directory.\r
+BOARD  = USBKEY\r
+\r
+\r
+# Processor frequency.\r
+#     This will define a symbol, F_CPU, in all source code files equal to the \r
+#     processor frequency. You can then use this symbol in your source code to \r
+#     calculate timings. Do NOT tack on a 'UL' at the end, this will be done\r
+#     automatically to create a 32-bit value in your source code.\r
+#     Typical values are:\r
+#         F_CPU =  1000000\r
+#         F_CPU =  1843200\r
+#         F_CPU =  2000000\r
+#         F_CPU =  3686400\r
+#         F_CPU =  4000000\r
+#         F_CPU =  7372800\r
+#         F_CPU =  8000000\r
+#         F_CPU = 11059200\r
+#         F_CPU = 14745600\r
+#         F_CPU = 16000000\r
+#         F_CPU = 18432000\r
+#         F_CPU = 20000000\r
+F_CPU = 8000000\r
+\r
+\r
+# Output format. (can be srec, ihex, binary)\r
+FORMAT = ihex\r
+\r
+\r
+# Target file name (without extension).\r
+TARGET = AVRISP_Programmer\r
+\r
+\r
+# Object files directory\r
+#     To put object files in current directory, use a dot (.), do NOT make\r
+#     this an empty or blank macro!\r
+OBJDIR = .\r
+\r
+\r
+# List C source files here. (C dependencies are automatically generated.)\r
+SRC = $(TARGET).c                                          \\r
+         Descriptors.c                                        \\r
+         RingBuff.c                                           \\r
+         ../../LUFA/Scheduler/Scheduler.c                     \\r
+         ../../LUFA/Drivers/AT90USBXXX/Serial.c               \\r
+         ../../LUFA/Drivers/USB/LowLevel/LowLevel.c           \\r
+         ../../LUFA/Drivers/USB/LowLevel/Endpoint.c           \\r
+         ../../LUFA/Drivers/USB/LowLevel/DevChapter9.c        \\r
+         ../../LUFA/Drivers/USB/HighLevel/USBTask.c           \\r
+         ../../LUFA/Drivers/USB/HighLevel/USBInterrupt.c      \\r
+         ../../LUFA/Drivers/USB/HighLevel/Events.c            \\r
+         ../../LUFA/Drivers/USB/HighLevel/StdDescriptors.c    \\r
+         \r
+# List C++ source files here. (C dependencies are automatically generated.)\r
+CPPSRC = \r
+\r
+\r
+# List Assembler source files here.\r
+#     Make them always end in a capital .S.  Files ending in a lowercase .s\r
+#     will not be considered source files but generated files (assembler\r
+#     output from the compiler), and will be deleted upon "make clean"!\r
+#     Even though the DOS/Win* filesystem matches both .s and .S the same,\r
+#     it will preserve the spelling of the filenames, and gcc itself does\r
+#     care about how the name is spelled on its command-line.\r
+ASRC =\r
+\r
+\r
+# Optimization level, can be [0, 1, 2, 3, s]. \r
+#     0 = turn off optimization. s = optimize for size.\r
+#     (Note: 3 is not always the best optimization level. See avr-libc FAQ.)\r
+OPT = s\r
+\r
+\r
+# Debugging format.\r
+#     Native formats for AVR-GCC's -g are dwarf-2 [default] or stabs.\r
+#     AVR Studio 4.10 requires dwarf-2.\r
+#     AVR [Extended] COFF format requires stabs, plus an avr-objcopy run.\r
+DEBUG = dwarf-2\r
+\r
+\r
+# List any extra directories to look for include files here.\r
+#     Each directory must be seperated by a space.\r
+#     Use forward slashes for directory separators.\r
+#     For a directory that has spaces, enclose it in quotes.\r
+EXTRAINCDIRS = ../../\r
+\r
+\r
+# Compiler flag to set the C Standard level.\r
+#     c89   = "ANSI" C\r
+#     gnu89 = c89 plus GCC extensions\r
+#     c99   = ISO C99 standard (not yet fully implemented)\r
+#     gnu99 = c99 plus GCC extensions\r
+CSTANDARD = -std=gnu99\r
+\r
+\r
+# Place -D or -U options here for C sources\r
+CDEFS  = -DF_CPU=$(F_CPU)UL -DBOARD=BOARD_$(BOARD) -DUSE_NONSTANDARD_DESCRIPTOR_NAMES -DNO_STREAM_CALLBACKS\r
+CDEFS += -DUSB_DEVICE_ONLY -DUSE_STATIC_OPTIONS="(USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)"\r
+\r
+\r
+# Place -D or -U options here for ASM sources\r
+ADEFS = -DF_CPU=$(F_CPU)\r
+\r
+\r
+# Place -D or -U options here for C++ sources\r
+CPPDEFS = -DF_CPU=$(F_CPU)UL\r
+#CPPDEFS += -D__STDC_LIMIT_MACROS\r
+#CPPDEFS += -D__STDC_CONSTANT_MACROS\r
+\r
+\r
+\r
+#---------------- Compiler Options C ----------------\r
+#  -g*:          generate debugging information\r
+#  -O*:          optimization level\r
+#  -f...:        tuning, see GCC manual and avr-libc documentation\r
+#  -Wall...:     warning level\r
+#  -Wa,...:      tell GCC to pass this to the assembler.\r
+#    -adhlns...: create assembler listing\r
+CFLAGS = -g$(DEBUG)\r
+CFLAGS += $(CDEFS)\r
+CFLAGS += -O$(OPT)\r
+CFLAGS += -funsigned-char\r
+CFLAGS += -funsigned-bitfields\r
+CFLAGS += -ffunction-sections\r
+CFLAGS += -fpack-struct\r
+CFLAGS += -fshort-enums\r
+CFLAGS += -finline-limit=20\r
+CFLAGS += -Wall\r
+CFLAGS += -Wstrict-prototypes\r
+CFLAGS += -Wundef\r
+#CFLAGS += -fno-unit-at-a-time\r
+#CFLAGS += -Wunreachable-code\r
+#CFLAGS += -Wsign-compare\r
+CFLAGS += -Wa,-adhlns=$(<:%.c=$(OBJDIR)/%.lst)\r
+CFLAGS += $(patsubst %,-I%,$(EXTRAINCDIRS))\r
+CFLAGS += $(CSTANDARD)\r
+\r
+\r
+#---------------- Compiler Options C++ ----------------\r
+#  -g*:          generate debugging information\r
+#  -O*:          optimization level\r
+#  -f...:        tuning, see GCC manual and avr-libc documentation\r
+#  -Wall...:     warning level\r
+#  -Wa,...:      tell GCC to pass this to the assembler.\r
+#    -adhlns...: create assembler listing\r
+CPPFLAGS = -g$(DEBUG)\r
+CPPFLAGS += $(CPPDEFS)\r
+CPPFLAGS += -O$(OPT)\r
+CPPFLAGS += -funsigned-char\r
+CPPFLAGS += -funsigned-bitfields\r
+CPPFLAGS += -fpack-struct\r
+CPPFLAGS += -fshort-enums\r
+CPPFLAGS += -fno-exceptions\r
+CPPFLAGS += -Wall\r
+CFLAGS += -Wundef\r
+#CPPFLAGS += -mshort-calls\r
+#CPPFLAGS += -fno-unit-at-a-time\r
+#CPPFLAGS += -Wstrict-prototypes\r
+#CPPFLAGS += -Wunreachable-code\r
+#CPPFLAGS += -Wsign-compare\r
+CPPFLAGS += -Wa,-adhlns=$(<:%.cpp=$(OBJDIR)/%.lst)\r
+CPPFLAGS += $(patsubst %,-I%,$(EXTRAINCDIRS))\r
+#CPPFLAGS += $(CSTANDARD)\r
+\r
+\r
+#---------------- Assembler Options ----------------\r
+#  -Wa,...:   tell GCC to pass this to the assembler.\r
+#  -adhlns:   create listing\r
+#  -gstabs:   have the assembler create line number information; note that\r
+#             for use in COFF files, additional information about filenames\r
+#             and function names needs to be present in the assembler source\r
+#             files -- see avr-libc docs [FIXME: not yet described there]\r
+#  -listing-cont-lines: Sets the maximum number of continuation lines of hex \r
+#       dump that will be displayed for a given single line of source input.\r
+ASFLAGS = $(ADEFS) -Wa,-adhlns=$(<:%.S=$(OBJDIR)/%.lst),-gstabs,--listing-cont-lines=100\r
+\r
+\r
+#---------------- Library Options ----------------\r
+# Minimalistic printf version\r
+PRINTF_LIB_MIN = -Wl,-u,vfprintf -lprintf_min\r
+\r
+# Floating point printf version (requires MATH_LIB = -lm below)\r
+PRINTF_LIB_FLOAT = -Wl,-u,vfprintf -lprintf_flt\r
+\r
+# If this is left blank, then it will use the Standard printf version.\r
+PRINTF_LIB = \r
+#PRINTF_LIB = $(PRINTF_LIB_MIN)\r
+#PRINTF_LIB = $(PRINTF_LIB_FLOAT)\r
+\r
+\r
+# Minimalistic scanf version\r
+SCANF_LIB_MIN = -Wl,-u,vfscanf -lscanf_min\r
+\r
+# Floating point + %[ scanf version (requires MATH_LIB = -lm below)\r
+SCANF_LIB_FLOAT = -Wl,-u,vfscanf -lscanf_flt\r
+\r
+# If this is left blank, then it will use the Standard scanf version.\r
+SCANF_LIB = \r
+#SCANF_LIB = $(SCANF_LIB_MIN)\r
+#SCANF_LIB = $(SCANF_LIB_FLOAT)\r
+\r
+\r
+MATH_LIB = -lm\r
+\r
+\r
+# List any extra directories to look for libraries here.\r
+#     Each directory must be seperated by a space.\r
+#     Use forward slashes for directory separators.\r
+#     For a directory that has spaces, enclose it in quotes.\r
+EXTRALIBDIRS = \r
+\r
+\r
+\r
+#---------------- External Memory Options ----------------\r
+\r
+# 64 KB of external RAM, starting after internal RAM (ATmega128!),\r
+# used for variables (.data/.bss) and heap (malloc()).\r
+#EXTMEMOPTS = -Wl,-Tdata=0x801100,--defsym=__heap_end=0x80ffff\r
+\r
+# 64 KB of external RAM, starting after internal RAM (ATmega128!),\r
+# only used for heap (malloc()).\r
+#EXTMEMOPTS = -Wl,--section-start,.data=0x801100,--defsym=__heap_end=0x80ffff\r
+\r
+EXTMEMOPTS =\r
+\r
+\r
+\r
+#---------------- Linker Options ----------------\r
+#  -Wl,...:     tell GCC to pass this to linker.\r
+#    -Map:      create map file\r
+#    --cref:    add cross reference to  map file\r
+LDFLAGS = -Wl,-Map=$(TARGET).map,--cref\r
+LDFLAGS += -Wl,--relax \r
+LDFLAGS += -Wl,--gc-sections\r
+LDFLAGS += $(EXTMEMOPTS)\r
+LDFLAGS += $(patsubst %,-L%,$(EXTRALIBDIRS))\r
+LDFLAGS += $(PRINTF_LIB) $(SCANF_LIB) $(MATH_LIB)\r
+#LDFLAGS += -T linker_script.x\r
+\r
+\r
+\r
+#---------------- Programming Options (avrdude) ----------------\r
+\r
+# Programming hardware: alf avr910 avrisp bascom bsd \r
+# dt006 pavr picoweb pony-stk200 sp12 stk200 stk500\r
+#\r
+# Type: avrdude -c ?\r
+# to get a full listing.\r
+#\r
+AVRDUDE_PROGRAMMER = jtagmkII\r
+\r
+# com1 = serial port. Use lpt1 to connect to parallel port.\r
+AVRDUDE_PORT = usb\r
+\r
+AVRDUDE_WRITE_FLASH = -U flash:w:$(TARGET).hex\r
+#AVRDUDE_WRITE_EEPROM = -U eeprom:w:$(TARGET).eep\r
+\r
+\r
+# Uncomment the following if you want avrdude's erase cycle counter.\r
+# Note that this counter needs to be initialized first using -Yn,\r
+# see avrdude manual.\r
+#AVRDUDE_ERASE_COUNTER = -y\r
+\r
+# Uncomment the following if you do /not/ wish a verification to be\r
+# performed after programming the device.\r
+#AVRDUDE_NO_VERIFY = -V\r
+\r
+# Increase verbosity level.  Please use this when submitting bug\r
+# reports about avrdude. See <http://savannah.nongnu.org/projects/avrdude> \r
+# to submit bug reports.\r
+#AVRDUDE_VERBOSE = -v -v\r
+\r
+AVRDUDE_FLAGS = -p $(MCU) -P $(AVRDUDE_PORT) -c $(AVRDUDE_PROGRAMMER)\r
+AVRDUDE_FLAGS += $(AVRDUDE_NO_VERIFY)\r
+AVRDUDE_FLAGS += $(AVRDUDE_VERBOSE)\r
+AVRDUDE_FLAGS += $(AVRDUDE_ERASE_COUNTER)\r
+\r
+\r
+\r
+#---------------- Debugging Options ----------------\r
+\r
+# For simulavr only - target MCU frequency.\r
+DEBUG_MFREQ = $(F_CPU)\r
+\r
+# Set the DEBUG_UI to either gdb or insight.\r
+# DEBUG_UI = gdb\r
+DEBUG_UI = insight\r
+\r
+# Set the debugging back-end to either avarice, simulavr.\r
+DEBUG_BACKEND = avarice\r
+#DEBUG_BACKEND = simulavr\r
+\r
+# GDB Init Filename.\r
+GDBINIT_FILE = __avr_gdbinit\r
+\r
+# When using avarice settings for the JTAG\r
+JTAG_DEV = /dev/com1\r
+\r
+# Debugging port used to communicate between GDB / avarice / simulavr.\r
+DEBUG_PORT = 4242\r
+\r
+# Debugging host used to communicate between GDB / avarice / simulavr, normally\r
+#     just set to localhost unless doing some sort of crazy debugging when \r
+#     avarice is running on a different computer.\r
+DEBUG_HOST = localhost\r
+\r
+\r
+\r
+#============================================================================\r
+\r
+\r
+# Define programs and commands.\r
+SHELL = sh\r
+CC = avr-gcc\r
+OBJCOPY = avr-objcopy\r
+OBJDUMP = avr-objdump\r
+SIZE = avr-size\r
+AR = avr-ar rcs\r
+NM = avr-nm\r
+AVRDUDE = avrdude\r
+REMOVE = rm -f\r
+REMOVEDIR = rm -rf\r
+COPY = cp\r
+WINSHELL = cmd\r
+\r
+# Define Messages\r
+# English\r
+MSG_ERRORS_NONE = Errors: none\r
+MSG_BEGIN = -------- begin --------\r
+MSG_END = --------  end  --------\r
+MSG_SIZE_BEFORE = Size before: \r
+MSG_SIZE_AFTER = Size after:\r
+MSG_COFF = Converting to AVR COFF:\r
+MSG_EXTENDED_COFF = Converting to AVR Extended COFF:\r
+MSG_FLASH = Creating load file for Flash:\r
+MSG_EEPROM = Creating load file for EEPROM:\r
+MSG_EXTENDED_LISTING = Creating Extended Listing:\r
+MSG_SYMBOL_TABLE = Creating Symbol Table:\r
+MSG_LINKING = Linking:\r
+MSG_COMPILING = Compiling C:\r
+MSG_COMPILING_CPP = Compiling C++:\r
+MSG_ASSEMBLING = Assembling:\r
+MSG_CLEANING = Cleaning project:\r
+MSG_CREATING_LIBRARY = Creating library:\r
+\r
+\r
+\r
+\r
+# Define all object files.\r
+OBJ = $(SRC:%.c=$(OBJDIR)/%.o) $(CPPSRC:%.cpp=$(OBJDIR)/%.o) $(ASRC:%.S=$(OBJDIR)/%.o) \r
+\r
+# Define all listing files.\r
+LST = $(SRC:%.c=$(OBJDIR)/%.lst) $(CPPSRC:%.cpp=$(OBJDIR)/%.lst) $(ASRC:%.S=$(OBJDIR)/%.lst) \r
+\r
+\r
+# Compiler flags to generate dependency files.\r
+GENDEPFLAGS = -MMD -MP -MF .dep/$(@F).d\r
+\r
+\r
+# Combine all necessary flags and optional flags.\r
+# Add target processor to flags.\r
+ALL_CFLAGS = -mmcu=$(MCU) -I. $(CFLAGS) $(GENDEPFLAGS)\r
+ALL_CPPFLAGS = -mmcu=$(MCU) -I. -x c++ $(CPPFLAGS) $(GENDEPFLAGS)\r
+ALL_ASFLAGS = -mmcu=$(MCU) -I. -x assembler-with-cpp $(ASFLAGS)\r
+\r
+\r
+\r
+\r
+\r
+# Default target.\r
+all: begin gccversion sizebefore build checkhooks checklibmode sizeafter end\r
+\r
+# Change the build target to build a HEX file or a library.\r
+build: elf hex eep lss sym\r
+#build: lib\r
+\r
+\r
+elf: $(TARGET).elf\r
+hex: $(TARGET).hex\r
+eep: $(TARGET).eep\r
+lss: $(TARGET).lss\r
+sym: $(TARGET).sym\r
+LIBNAME=lib$(TARGET).a\r
+lib: $(LIBNAME)\r
+\r
+\r
+\r
+# Eye candy.\r
+# AVR Studio 3.x does not check make's exit code but relies on\r
+# the following magic strings to be generated by the compile job.\r
+begin:\r
+       @echo\r
+       @echo $(MSG_BEGIN)\r
+\r
+end:\r
+       @echo $(MSG_END)\r
+       @echo\r
+\r
+\r
+# Display size of file.\r
+HEXSIZE = $(SIZE) --target=$(FORMAT) $(TARGET).hex\r
+ELFSIZE = $(SIZE) $(MCU_FLAG) $(FORMAT_FLAG) $(TARGET).elf\r
+MCU_FLAG = $(shell $(SIZE) --help | grep -- --mcu > /dev/null && echo --mcu=$(MCU) )\r
+FORMAT_FLAG = $(shell $(SIZE) --help | grep -- --format=.*avr > /dev/null && echo --format=avr )\r
+\r
+sizebefore:\r
+       @if test -f $(TARGET).elf; then echo; echo $(MSG_SIZE_BEFORE); $(ELFSIZE); \\r
+       2>/dev/null; echo; fi\r
+\r
+sizeafter:\r
+       @if test -f $(TARGET).elf; then echo; echo $(MSG_SIZE_AFTER); $(ELFSIZE); \\r
+       2>/dev/null; echo; fi\r
+\r
+checkhooks: build\r
+       @echo\r
+       @echo ------- Unhooked LUFA Events -------\r
+       @$(shell) (grep -s '^Event.*LUFA/.*\\.o' $(TARGET).map | \\r
+                  cut -d' ' -f1 | cut -d'_' -f2- | grep ".*") || \\r
+                          echo "(None)"\r
+       @echo ----- End Unhooked LUFA Events -----\r
+       \r
+checklibmode:\r
+       @echo\r
+       @echo ----------- Library Mode -----------\r
+       @$(shell) ($(CC) $(ALL_CFLAGS) -E -dM - < /dev/null \\r
+                 | grep 'USB_\(DEVICE\|HOST\)_ONLY' | cut -d' ' -f2 | grep ".*") \\r
+                 || echo "No specific mode (both device and host mode allowable)."\r
+       @echo ------------------------------------\r
+\r
+# Display compiler version information.\r
+gccversion : \r
+       @$(CC) --version\r
+\r
+\r
+\r
+# Program the device.  \r
+program: $(TARGET).hex $(TARGET).eep\r
+       $(AVRDUDE) $(AVRDUDE_FLAGS) $(AVRDUDE_WRITE_FLASH) $(AVRDUDE_WRITE_EEPROM)\r
+\r
+flip: $(TARGET).hex\r
+       batchisp -hardware usb -device $(MCU) -operation erase f\r
+       batchisp -hardware usb -device $(MCU) -operation loadbuffer $(TARGET).hex program\r
+       batchisp -hardware usb -device $(MCU) -operation start reset 0\r
+\r
+dfu: $(TARGET).hex\r
+       dfu-programmer $(MCU) erase\r
+       dfu-programmer $(MCU) flash --debug 1 $(TARGET).hex\r
+       dfu-programmer $(MCU) reset\r
+\r
+flip-ee: $(TARGET).hex $(TARGET).eep\r
+       copy $(TARGET).eep $(TARGET)eep.hex\r
+       batchisp -hardware usb -device $(MCU) -operation memory EEPROM erase\r
+       batchisp -hardware usb -device $(MCU) -operation memory EEPROM loadbuffer $(TARGET)eep.hex program\r
+       batchisp -hardware usb -device $(MCU) -operation start reset 0\r
+\r
+dfu-ee: $(TARGET).hex $(TARGET).eep\r
+       dfu-programmer $(MCU) erase\r
+       dfu-programmer $(MCU) eeprom --debug 1 $(TARGET).eep\r
+       dfu-programmer $(MCU) reset\r
+\r
+# Generate avr-gdb config/init file which does the following:\r
+#     define the reset signal, load the target file, connect to target, and set \r
+#     a breakpoint at main().\r
+gdb-config: \r
+       @$(REMOVE) $(GDBINIT_FILE)\r
+       @echo define reset >> $(GDBINIT_FILE)\r
+       @echo SIGNAL SIGHUP >> $(GDBINIT_FILE)\r
+       @echo end >> $(GDBINIT_FILE)\r
+       @echo file $(TARGET).elf >> $(GDBINIT_FILE)\r
+       @echo target remote $(DEBUG_HOST):$(DEBUG_PORT)  >> $(GDBINIT_FILE)\r
+ifeq ($(DEBUG_BACKEND),simulavr)\r
+       @echo load  >> $(GDBINIT_FILE)\r
+endif\r
+       @echo break main >> $(GDBINIT_FILE)\r
+\r
+debug: gdb-config $(TARGET).elf\r
+ifeq ($(DEBUG_BACKEND), avarice)\r
+       @echo Starting AVaRICE - Press enter when "waiting to connect" message displays.\r
+       @$(WINSHELL) /c start avarice --jtag $(JTAG_DEV) --erase --program --file \\r
+       $(TARGET).elf $(DEBUG_HOST):$(DEBUG_PORT)\r
+       @$(WINSHELL) /c pause\r
+\r
+else\r
+       @$(WINSHELL) /c start simulavr --gdbserver --device $(MCU) --clock-freq \\r
+       $(DEBUG_MFREQ) --port $(DEBUG_PORT)\r
+endif\r
+       @$(WINSHELL) /c start avr-$(DEBUG_UI) --command=$(GDBINIT_FILE)\r
+\r
+\r
+\r
+\r
+# Convert ELF to COFF for use in debugging / simulating in AVR Studio or VMLAB.\r
+COFFCONVERT = $(OBJCOPY) --debugging\r
+COFFCONVERT += --change-section-address .data-0x800000\r
+COFFCONVERT += --change-section-address .bss-0x800000\r
+COFFCONVERT += --change-section-address .noinit-0x800000\r
+COFFCONVERT += --change-section-address .eeprom-0x810000\r
+\r
+\r
+\r
+coff: $(TARGET).elf\r
+       @echo\r
+       @echo $(MSG_COFF) $(TARGET).cof\r
+       $(COFFCONVERT) -O coff-avr $< $(TARGET).cof\r
+\r
+\r
+extcoff: $(TARGET).elf\r
+       @echo\r
+       @echo $(MSG_EXTENDED_COFF) $(TARGET).cof\r
+       $(COFFCONVERT) -O coff-ext-avr $< $(TARGET).cof\r
+\r
+\r
+\r
+# Create final output files (.hex, .eep) from ELF output file.\r
+%.hex: %.elf\r
+       @echo\r
+       @echo $(MSG_FLASH) $@\r
+       $(OBJCOPY) -O $(FORMAT) -R .eeprom $< $@\r
+\r
+%.eep: %.elf\r
+       @echo\r
+       @echo $(MSG_EEPROM) $@\r
+       -$(OBJCOPY) -j .eeprom --set-section-flags=.eeprom="alloc,load" \\r
+       --change-section-lma .eeprom=0 --no-change-warnings -O $(FORMAT) $< $@ || exit 0\r
+\r
+# Create extended listing file from ELF output file.\r
+%.lss: %.elf\r
+       @echo\r
+       @echo $(MSG_EXTENDED_LISTING) $@\r
+       $(OBJDUMP) -h -z -S $< > $@\r
+\r
+# Create a symbol table from ELF output file.\r
+%.sym: %.elf\r
+       @echo\r
+       @echo $(MSG_SYMBOL_TABLE) $@\r
+       $(NM) -n $< > $@\r
+\r
+\r
+\r
+# Create library from object files.\r
+.SECONDARY : $(TARGET).a\r
+.PRECIOUS : $(OBJ)\r
+%.a: $(OBJ)\r
+       @echo\r
+       @echo $(MSG_CREATING_LIBRARY) $@\r
+       $(AR) $@ $(OBJ)\r
+\r
+\r
+# Link: create ELF output file from object files.\r
+.SECONDARY : $(TARGET).elf\r
+.PRECIOUS : $(OBJ)\r
+%.elf: $(OBJ)\r
+       @echo\r
+       @echo $(MSG_LINKING) $@\r
+       $(CC) $(ALL_CFLAGS) $^ --output $@ $(LDFLAGS)\r
+\r
+\r
+# Compile: create object files from C source files.\r
+$(OBJDIR)/%.o : %.c\r
+       @echo\r
+       @echo $(MSG_COMPILING) $<\r
+       $(CC) -c $(ALL_CFLAGS) $< -o $@ \r
+\r
+\r
+# Compile: create object files from C++ source files.\r
+$(OBJDIR)/%.o : %.cpp\r
+       @echo\r
+       @echo $(MSG_COMPILING_CPP) $<\r
+       $(CC) -c $(ALL_CPPFLAGS) $< -o $@ \r
+\r
+\r
+# Compile: create assembler files from C source files.\r
+%.s : %.c\r
+       $(CC) -S $(ALL_CFLAGS) $< -o $@\r
+\r
+\r
+# Compile: create assembler files from C++ source files.\r
+%.s : %.cpp\r
+       $(CC) -S $(ALL_CPPFLAGS) $< -o $@\r
+\r
+\r
+# Assemble: create object files from assembler source files.\r
+$(OBJDIR)/%.o : %.S\r
+       @echo\r
+       @echo $(MSG_ASSEMBLING) $<\r
+       $(CC) -c $(ALL_ASFLAGS) $< -o $@\r
+\r
+\r
+# Create preprocessed source for use in sending a bug report.\r
+%.i : %.c\r
+       $(CC) -E -mmcu=$(MCU) -I. $(CFLAGS) $< -o $@ \r
+       \r
+\r
+# Target: clean project.\r
+clean: begin clean_list clean_binary end\r
+\r
+clean_binary:\r
+       $(REMOVE) $(TARGET).hex\r
+\r
+clean_list:\r
+       @echo $(MSG_CLEANING)\r
+       $(REMOVE) $(TARGET).eep\r
+       $(REMOVE) $(TARGET).cof\r
+       $(REMOVE) $(TARGET).elf\r
+       $(REMOVE) $(TARGET).map\r
+       $(REMOVE) $(TARGET).sym\r
+       $(REMOVE) $(TARGET).lss\r
+       $(REMOVE) $(SRC:%.c=$(OBJDIR)/%.o)\r
+       $(REMOVE) $(SRC:%.c=$(OBJDIR)/%.lst)\r
+       $(REMOVE) $(SRC:.c=.s)\r
+       $(REMOVE) $(SRC:.c=.d)\r
+       $(REMOVE) $(SRC:.c=.i)\r
+       $(REMOVEDIR) .dep\r
+\r
+\r
+doxygen:\r
+       @echo Generating Project Documentation...\r
+       @doxygen Doxygen.conf\r
+       @echo Documentation Generation Complete.\r
+\r
+clean_doxygen:\r
+       rm -rf Documentation\r
+\r
+# Create object files directory\r
+$(shell mkdir $(OBJDIR) 2>/dev/null)\r
+\r
+\r
+# Include the dependency files.\r
+-include $(shell mkdir .dep 2>/dev/null) $(wildcard .dep/*)\r
+\r
+\r
+# Listing of phony targets.\r
+.PHONY : all checkhooks checklibmode begin  \\r
+finish end sizebefore sizeafter gccversion  \\r
+build elf hex eep lss sym coff extcoff      \\r
+clean clean_list clean_binary program debug \\r
+gdb-config doxygen dfu flip\r
diff --git a/Projects/Magstripe/CircularBitBuffer.c b/Projects/Magstripe/CircularBitBuffer.c
new file mode 100644 (file)
index 0000000..5d23762
--- /dev/null
@@ -0,0 +1,113 @@
+/*\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
+/** Circular bit buffer library. This will allow for individual bits\r
+ *  to be stored in packed form inside circular buffers, to reduce\r
+ *  overall RAM usage.\r
+ */\r
+\r
+#include "CircularBitBuffer.h"\r
+\r
+/** Function to initialize or reset a bit buffer, ready for data to be stored into it. */\r
+void BitBuffer_Init(BitBuffer_t* Buffer)\r
+{\r
+       /* Reset the number of stored bits in the buffer */\r
+       Buffer->Elements        = 0;\r
+       \r
+       /* Reset the data in and out pointer structures in the buffer to the first buffer bit */\r
+       Buffer->In.CurrentByte  = Buffer->Data;\r
+       Buffer->In.ByteMask     = (1 << 0);\r
+       Buffer->Out.CurrentByte = Buffer->Data;\r
+       Buffer->Out.ByteMask    = (1 << 0);\r
+}\r
+\r
+/** Function to store the given bit into the given bit buffer. */\r
+void BitBuffer_StoreNextBit(BitBuffer_t* Buffer, bool Bit)\r
+{\r
+       /* If the bit to store is true, set the next bit in the buffer */\r
+       if (Bit)\r
+         *Buffer->In.CurrentByte |= Buffer->In.ByteMask;\r
+       \r
+       /* Increment the number of stored bits in the buffer counter */\r
+       Buffer->Elements++;\r
+       \r
+       /* Check if the current buffer byte is full of stored bits */\r
+       if (Buffer->In.ByteMask == (1 << 7))\r
+       {\r
+               /* Check if the end of the buffer has been reached, if so reset to start of buffer, otherwise advance to next bit */\r
+               if (Buffer->In.CurrentByte != &Buffer->Data[sizeof(Buffer->Data) - 1])\r
+                 Buffer->In.CurrentByte++;\r
+               else\r
+                 Buffer->In.CurrentByte = Buffer->Data;\r
+                 \r
+               /* Reset the storage bit mask in the current buffer byte to the first bit */            \r
+               Buffer->In.ByteMask = (1 << 0);\r
+       }\r
+       else\r
+       {\r
+               /* Shift the current storage bit mask to the next bit in the current byte */\r
+               Buffer->In.ByteMask <<= 1;\r
+       }\r
+}\r
+\r
+/** Function to retrieve the next bit stored in the given bit buffer. */\r
+bool BitBuffer_GetNextBit(BitBuffer_t* Buffer)\r
+{      \r
+       /* Retrieve the value of the next bit stored in the buffer */\r
+       bool Bit = ((*Buffer->Out.CurrentByte & Buffer->Out.ByteMask) != 0);\r
+\r
+       /* Clear the buffer bit */\r
+       *Buffer->Out.CurrentByte &= ~Buffer->Out.ByteMask;\r
+\r
+       /* Decrement the number of stored bits in the buffer counter */\r
+       Buffer->Elements--;\r
+       \r
+       /* Check if the current buffer byte is empty of stored bits */  \r
+       if (Buffer->Out.ByteMask == (1 << 7))\r
+       {\r
+               /* Check if the end of the buffer has been reached, if so reset to start of buffer, otherwise advance to next bit */\r
+               if (Buffer->Out.CurrentByte != &Buffer->Data[sizeof(Buffer->Data) - 1])\r
+                 Buffer->Out.CurrentByte++;\r
+               else\r
+                 Buffer->Out.CurrentByte = Buffer->Data;               \r
+               \r
+               /* Reset the retrieval bit mask in the current buffer byte to the first bit */          \r
+               Buffer->Out.ByteMask = (1 << 0);\r
+       }\r
+       else\r
+       {\r
+               /* Shift the current retrieval bit mask to the next bit in the current byte */\r
+               Buffer->Out.ByteMask <<= 1;\r
+       }\r
+\r
+       /* Return the retrieved bit from the buffer */\r
+       return Bit;\r
+}\r
diff --git a/Projects/Magstripe/CircularBitBuffer.h b/Projects/Magstripe/CircularBitBuffer.h
new file mode 100644 (file)
index 0000000..52410f6
--- /dev/null
@@ -0,0 +1,95 @@
+/*\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 CircularBitBuffer.c.\r
+ */\r
+\r
+#ifndef _CIRCULARBITBUFFER_H_\r
+#define _CIRCULARBITBUFFER_H_\r
+\r
+       /* Includes: */\r
+               #include <avr/io.h>\r
+               #include <stdbool.h>\r
+               \r
+               #include <LUFA/Common/Common.h>\r
+\r
+       /* Macros: */\r
+               #if (defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \\r
+                    defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__)) || defined(__DOXYGEN__)\r
+                       /** Maximum number of bits which can be stored into a bit buffer. The memory usage is one eigth of this value per buffer. */\r
+                       #define MAX_BITS 20480\r
+               #else\r
+                       #define MAX_BITS 1024\r
+               #endif\r
+               \r
+       /* Type Defines: */\r
+               /* Type define for a pointer to a bit in a bit buffer. */\r
+               typedef struct\r
+               {\r
+                       uint8_t* CurrentByte; /**< Pointer to the current byte in the buffer */\r
+                       uint8_t  ByteMask; /**< Mask of the current bit in the buffer */\r
+               } BitBufferPointer_t;\r
+\r
+               /** Type define for a circular packet bit buffer. */\r
+               typedef struct\r
+               {\r
+                       uint8_t            Data[MAX_BITS / 8]; /**< Buffer to hold the stored bits in packed form */\r
+                       uint16_t           Elements; /**< Number of stored bits in the bit buffer */\r
+                       \r
+                       BitBufferPointer_t In; /**< Bit pointer to the next storage location in the buffer */\r
+                       BitBufferPointer_t Out; /**< Bit pointer to the next retrieval location in the buffer */\r
+               } BitBuffer_t;\r
+               \r
+       /* Function Prototypes: */      \r
+               /** Initializes or resets a given bit buffer, ready to store new bits.\r
+                *  \r
+                *  \param Buffer  Bit buffer to initialize\r
+                */\r
+               void BitBuffer_Init(BitBuffer_t* Buffer) ATTR_NON_NULL_PTR_ARG(1);\r
+               \r
+               /** Stores a bit into the next location inside a given bit buffer.\r
+                *\r
+                *  \param Buffer  Bit buffer to store a bit into\r
+                *  \param Bit  Bit to store into the buffer\r
+                */\r
+               void BitBuffer_StoreNextBit(BitBuffer_t* Buffer, bool Bit) ATTR_NON_NULL_PTR_ARG(1);\r
+               \r
+               /** Retrieves a bit from the next location inside a given bit buffer.\r
+                *\r
+                *  \param Buffer  Bit buffer to store a bit into\r
+                *\r
+                *  \return Next bit from the buffer\r
+                */\r
+               bool BitBuffer_GetNextBit(BitBuffer_t* Buffer) ATTR_NON_NULL_PTR_ARG(1);\r
+               \r
+#endif\r
diff --git a/Projects/Magstripe/Descriptors.c b/Projects/Magstripe/Descriptors.c
new file mode 100644 (file)
index 0000000..6811f52
--- /dev/null
@@ -0,0 +1,247 @@
+/*\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
+ *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special \r
+ *  computer-readable structures which the host requests upon device enumeration, to determine\r
+ *  the device's capabilities and functions.  \r
+ */\r
\r
+#include "Descriptors.h"\r
+\r
+/** HID report descriptor. This is a HID class specific descriptor, which defines the structure of the\r
+ *  reports sent and received by the HID device to and from the USB host. It indicates what data is sent,\r
+ *  where in the report each element is located and exactly how the data should be interpreted and used.\r
+ *\r
+ *  See the HID class specification for more information on HID report descriptors.\r
+ */\r
+USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] =\r
+{\r
+       0x05, 0x01,          /* Usage Page (Generic Desktop)                    */\r
+       0x09, 0x06,          /* Usage (Keyboard)                                */\r
+       0xa1, 0x01,          /* Collection (Application)                        */\r
+       0x05, 0x07,          /*   Usage Page (Key Codes)                        */\r
+       0x19, 0xe0,          /*   Usage Minimum (Keyboard LeftControl)          */\r
+       0x29, 0xe7,          /*   Usage Maximum (Keyboard Right GUI)            */\r
+       0x15, 0x00,          /*   Logical Minimum (0)                           */\r
+       0x25, 0x01,          /*   Logical Maximum (1)                           */\r
+       0x75, 0x01,          /*   Report Size (1)                               */\r
+       0x95, 0x08,          /*   Report Count (8)                              */\r
+       0x81, 0x02,          /*   Input (Data, Variable, Absolute)              */\r
+       0x95, 0x01,          /*   Report Count (1)                              */\r
+       0x75, 0x08,          /*   Report Size (8)                               */\r
+       0x81, 0x03,          /*   Input (Const, Variable, Absolute)             */\r
+       0x95, 0x01,          /*   Report Count (1)                              */\r
+       0x75, 0x08,          /*   Report Size (8)                               */\r
+       0x15, 0x00,          /*   Logical Minimum (0)                           */\r
+       0x25, 0x65,          /*   Logical Maximum (101)                         */\r
+       0x05, 0x07,          /*   Usage Page (Keyboard)                         */\r
+       0x19, 0x00,          /*   Usage Minimum (Reserved (no event indicated)) */\r
+       0x29, 0x65,          /*   Usage Maximum (Keyboard Application)          */\r
+       0x81, 0x00,          /*   Input (Data, Array, Absolute)                 */\r
+       0xc0                 /* End Collection                                  */\r
+};\r
+\r
+/** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall\r
+ *  device characteristics, including the supported USB version, control endpoint size and the\r
+ *  number of device configurations. The descriptor is read out by the USB host when the enumeration\r
+ *  process begins.\r
+ */\r
+USB_Descriptor_Device_t PROGMEM DeviceDescriptor =\r
+{\r
+       Header:                 {Size: sizeof(USB_Descriptor_Device_t), Type: DTYPE_Device},\r
+               \r
+       USBSpecification:       VERSION_BCD(01.10),\r
+       Class:                  0x00,\r
+       SubClass:               0x00,\r
+       Protocol:               0x00,\r
+                               \r
+       Endpoint0Size:          8,\r
+               \r
+       VendorID:               0x03EB,\r
+       ProductID:              0x2042,\r
+       ReleaseNumber:          0x0000,\r
+               \r
+       ManufacturerStrIndex:   0x01,\r
+       ProductStrIndex:        0x02,\r
+       SerialNumStrIndex:      NO_DESCRIPTOR,\r
+               \r
+       NumberOfConfigurations: 1\r
+};\r
+\r
+/** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage\r
+ *  of the device in one of its supported configurations, including information about any device interfaces\r
+ *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting\r
+ *  a configuration so that the host may correctly communicate with the USB device.\r
+ */\r
+USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =\r
+{\r
+       Config:\r
+               {\r
+                       Header:                 {Size: sizeof(USB_Descriptor_Configuration_Header_t), Type: DTYPE_Configuration},\r
+\r
+                       TotalConfigurationSize: sizeof(USB_Descriptor_Configuration_t),\r
+                       TotalInterfaces:        1,\r
+                               \r
+                       ConfigurationNumber:    1,\r
+                       ConfigurationStrIndex:  NO_DESCRIPTOR,\r
+                               \r
+                       ConfigAttributes:       (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),\r
+                       \r
+                       MaxPowerConsumption:    USB_CONFIG_POWER_MA(100)\r
+               },\r
+               \r
+       Interface:\r
+               {\r
+                       Header:                 {Size: sizeof(USB_Descriptor_Interface_t), Type: DTYPE_Interface},\r
+\r
+                       InterfaceNumber:        0x00,\r
+                       AlternateSetting:       0x00,\r
+                       \r
+                       TotalEndpoints:         1,\r
+                               \r
+                       Class:                  0x03,\r
+                       SubClass:               0x01,\r
+                       Protocol:               0x01,\r
+                               \r
+                       InterfaceStrIndex:      NO_DESCRIPTOR\r
+               },\r
+\r
+       KeyboardHID:\r
+               {  \r
+                       Header:                 {Size: sizeof(USB_Descriptor_HID_t), Type: DTYPE_HID},\r
+                       \r
+                       HIDSpec:                VERSION_BCD(01.11),\r
+                       CountryCode:            0x00,\r
+                       TotalHIDReports:        0x01,\r
+                       HIDReportType:          DTYPE_Report,\r
+                       HIDReportLength:        sizeof(KeyboardReport)\r
+               },\r
+               \r
+       KeyboardEndpoint:\r
+               {\r
+                       Header:                 {Size: sizeof(USB_Descriptor_Endpoint_t), Type: DTYPE_Endpoint},\r
+\r
+                       EndpointAddress:        (ENDPOINT_DESCRIPTOR_DIR_IN | KEYBOARD_EPNUM),\r
+                       Attributes:             EP_TYPE_INTERRUPT,\r
+                       EndpointSize:           KEYBOARD_EPSIZE,\r
+                       PollingIntervalMS:      0x02\r
+               },\r
+};\r
+\r
+/** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests\r
+ *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate\r
+ *  via the language ID table available at USB.org what languages the device supports for its string descriptors. */ \r
+USB_Descriptor_String_t PROGMEM LanguageString =\r
+{\r
+       Header:                 {Size: USB_STRING_LEN(1), Type: DTYPE_String},\r
+               \r
+       UnicodeString:          {LANGUAGE_ID_ENG}\r
+};\r
+\r
+/** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable\r
+ *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device\r
+ *  Descriptor.\r
+ */\r
+USB_Descriptor_String_t PROGMEM ManufacturerString =\r
+{\r
+       Header:                 {Size: USB_STRING_LEN(32), Type: DTYPE_String},\r
+               \r
+       UnicodeString:          L"Dean Camera and Denver Gingerich"\r
+};\r
+\r
+/** Product descriptor string. This is a Unicode string containing the product's details in human readable form,\r
+ *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device\r
+ *  Descriptor.\r
+ */\r
+USB_Descriptor_String_t PROGMEM ProductString =\r
+{\r
+       Header:                 {Size: USB_STRING_LEN(20), Type: DTYPE_String},\r
+               \r
+       UnicodeString:          L"Magnetic Card Reader"\r
+};\r
+\r
+/** This function is called by the library when in device mode, and must be overridden (see StdDescriptors.h\r
+ *  documentation) by the application code so that the address and size of a requested descriptor can be given\r
+ *  to the USB library. When the device recieves a Get Descriptor request on the control endpoint, this function\r
+ *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the\r
+ *  USB host.\r
+ */\r
+uint16_t USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)\r
+{\r
+       const uint8_t  DescriptorType   = (wValue >> 8);\r
+       const uint8_t  DescriptorNumber = (wValue & 0xFF);\r
+\r
+       void*    Address = NULL;\r
+       uint16_t Size    = NO_DESCRIPTOR;\r
+\r
+       switch (DescriptorType)\r
+       {\r
+               case DTYPE_Device:\r
+                       Address = DESCRIPTOR_ADDRESS(DeviceDescriptor);\r
+                       Size    = sizeof(USB_Descriptor_Device_t);\r
+                       break;\r
+               case DTYPE_Configuration:\r
+                       Address = DESCRIPTOR_ADDRESS(ConfigurationDescriptor);\r
+                       Size    = sizeof(USB_Descriptor_Configuration_t);\r
+                       break;\r
+               case DTYPE_String:\r
+                       switch (DescriptorNumber)\r
+                       {\r
+                               case 0x00:\r
+                                       Address = DESCRIPTOR_ADDRESS(LanguageString);\r
+                                       Size    = pgm_read_byte(&LanguageString.Header.Size);\r
+                                       break;\r
+                               case 0x01:\r
+                                       Address = DESCRIPTOR_ADDRESS(ManufacturerString);\r
+                                       Size    = pgm_read_byte(&ManufacturerString.Header.Size);\r
+                                       break;\r
+                               case 0x02:\r
+                                       Address = DESCRIPTOR_ADDRESS(ProductString);\r
+                                       Size    = pgm_read_byte(&ProductString.Header.Size);\r
+                                       break;\r
+                       }\r
+                       \r
+                       break;\r
+               case DTYPE_HID:\r
+                       Address = DESCRIPTOR_ADDRESS(ConfigurationDescriptor.KeyboardHID);\r
+                       Size    = sizeof(USB_Descriptor_HID_t);\r
+                       break;\r
+               case DTYPE_Report:\r
+                       Address = DESCRIPTOR_ADDRESS(KeyboardReport);\r
+                       Size    = sizeof(KeyboardReport);\r
+                       break;\r
+       }\r
+       \r
+       *DescriptorAddress = Address;\r
+       return Size;\r
+}\r
diff --git a/Projects/Magstripe/Descriptors.h b/Projects/Magstripe/Descriptors.h
new file mode 100644 (file)
index 0000000..2f58545
--- /dev/null
@@ -0,0 +1,98 @@
+/*\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 Descriptors.c.\r
+ */\r
+\r
+#ifndef _DESCRIPTORS_H_\r
+#define _DESCRIPTORS_H_\r
+\r
+       /* Includes: */\r
+               #include <LUFA/Drivers/USB/USB.h>\r
+\r
+               #include <avr/pgmspace.h>\r
+\r
+       /* Type Defines: */\r
+               /** Type define for the HID class specific HID descriptor. A HID descriptor is used in HID class devices\r
+                *  to give information about the HID device, including the HID specification used, and the report descriptors\r
+                *  the device contains to describe how the HID device should be controlled.\r
+                */\r
+               typedef struct\r
+               {\r
+                       USB_Descriptor_Header_t Header; /**< Standard USB descriptor header */\r
+                               \r
+                       uint16_t                HIDSpec; /**< HID specification implemented by the device, in BCD form */\r
+                       uint8_t                 CountryCode; /**< Country code for the country the HID device is localised for */\r
+               \r
+                       uint8_t                 TotalHIDReports; /**< Total number of HID reports linked to this HID interface */\r
+\r
+                       uint8_t                 HIDReportType; /**< Type of the first HID report descriptor */\r
+                       uint16_t                HIDReportLength; /**< Length of the first HID report descriptor */\r
+               } USB_Descriptor_HID_t;\r
+\r
+               /** Type define for the data type used for the HID Report descriptor data elements. A HID report\r
+                *  descriptor contains an array of this data type, indicating how the reports from and to the\r
+                *  device are formatted and how the report data is to be used by the host.\r
+                */\r
+               typedef uint8_t USB_Descriptor_HIDReport_Datatype_t;\r
+\r
+               /** Type define for the device configuration descriptor structure. This must be defined in the\r
+                *  application code, as the configuration descriptor contains several sub-descriptors which\r
+                *  vary between devices, and which describe the device's usage to the host.\r
+                */\r
+               typedef struct\r
+               {\r
+                       USB_Descriptor_Configuration_Header_t Config; /**< Configuration descriptor header structure */\r
+                       USB_Descriptor_Interface_t            Interface; /**< Keyboard interface descriptor */\r
+                       USB_Descriptor_HID_t                  KeyboardHID; /**< Keyboard HID descriptor */\r
+               USB_Descriptor_Endpoint_t             KeyboardEndpoint; /**< Keyboard key report endpoint descriptor */\r
+               } USB_Descriptor_Configuration_t;\r
+                                       \r
+       /* Macros: */\r
+               /** Endpoint number of the keyboard key press reporting endpoint. */\r
+               #define KEYBOARD_EPNUM               1\r
+               \r
+               /** Size of the keyboard report endpoints, in bytes. */\r
+               #define KEYBOARD_EPSIZE              8\r
+\r
+               /** Descriptor type value for a HID descriptor. */\r
+               #define DTYPE_HID                    0x21\r
+\r
+               /** Descriptor type value for a HID report. */\r
+               #define DTYPE_Report                 0x22\r
+\r
+       /* Function Prototypes: */\r
+               uint16_t USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)\r
+                                          ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);\r
+\r
+#endif\r
diff --git a/Projects/Magstripe/Doxygen.conf b/Projects/Magstripe/Doxygen.conf
new file mode 100644 (file)
index 0000000..4d0abf9
--- /dev/null
@@ -0,0 +1,1485 @@
+# Doxyfile 1.5.7.1\r
+\r
+# This file describes the settings to be used by the documentation system\r
+# doxygen (www.doxygen.org) for a project\r
+#\r
+# All text after a hash (#) is considered a comment and will be ignored\r
+# The format is:\r
+#       TAG = value [value, ...]\r
+# For lists items can also be appended using:\r
+#       TAG += value [value, ...]\r
+# Values that contain spaces should be placed between quotes (" ")\r
+\r
+#---------------------------------------------------------------------------\r
+# Project related configuration options\r
+#---------------------------------------------------------------------------\r
+\r
+# This tag specifies the encoding used for all characters in the config file \r
+# that follow. The default is UTF-8 which is also the encoding used for all \r
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the \r
+# iconv built into libc) for the transcoding. See \r
+# http://www.gnu.org/software/libiconv for the list of possible encodings.\r
+\r
+DOXYFILE_ENCODING      = UTF-8\r
+\r
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded \r
+# by quotes) that should identify the project.\r
+\r
+PROJECT_NAME           = "Denver Gingerich's Stripe Snoop Project"\r
+\r
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. \r
+# This could be handy for archiving the generated documentation or \r
+# if some version control system is used.\r
+\r
+PROJECT_NUMBER         = 0.0.0\r
+\r
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) \r
+# base path where the generated documentation will be put. \r
+# If a relative path is entered, it will be relative to the location \r
+# where doxygen was started. If left blank the current directory will be used.\r
+\r
+OUTPUT_DIRECTORY       = ./Documentation/\r
+\r
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create \r
+# 4096 sub-directories (in 2 levels) under the output directory of each output \r
+# format and will distribute the generated files over these directories. \r
+# Enabling this option can be useful when feeding doxygen a huge amount of \r
+# source files, where putting all generated files in the same directory would \r
+# otherwise cause performance problems for the file system.\r
+\r
+CREATE_SUBDIRS         = YES\r
+\r
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all \r
+# documentation generated by doxygen is written. Doxygen will use this \r
+# information to generate all constant output in the proper language. \r
+# The default language is English, other supported languages are: \r
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, \r
+# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, \r
+# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), \r
+# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, \r
+# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, \r
+# Spanish, Swedish, and Ukrainian.\r
+\r
+OUTPUT_LANGUAGE        = English\r
+\r
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will \r
+# include brief member descriptions after the members that are listed in \r
+# the file and class documentation (similar to JavaDoc). \r
+# Set to NO to disable this.\r
+\r
+BRIEF_MEMBER_DESC      = YES\r
+\r
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend \r
+# the brief description of a member or function before the detailed description. \r
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the \r
+# brief descriptions will be completely suppressed.\r
+\r
+REPEAT_BRIEF           = YES\r
+\r
+# This tag implements a quasi-intelligent brief description abbreviator \r
+# that is used to form the text in various listings. Each string \r
+# in this list, if found as the leading text of the brief description, will be \r
+# stripped from the text and the result after processing the whole list, is \r
+# used as the annotated text. Otherwise, the brief description is used as-is. \r
+# If left blank, the following values are used ("$name" is automatically \r
+# replaced with the name of the entity): "The $name class" "The $name widget" \r
+# "The $name file" "is" "provides" "specifies" "contains" \r
+# "represents" "a" "an" "the"\r
+\r
+ABBREVIATE_BRIEF       = "The $name class" \\r
+                         "The $name widget" \\r
+                         "The $name file" \\r
+                         is \\r
+                         provides \\r
+                         specifies \\r
+                         contains \\r
+                         represents \\r
+                         a \\r
+                         an \\r
+                         the\r
+\r
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then \r
+# Doxygen will generate a detailed section even if there is only a brief \r
+# description.\r
+\r
+ALWAYS_DETAILED_SEC    = NO\r
+\r
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all \r
+# inherited members of a class in the documentation of that class as if those \r
+# members were ordinary class members. Constructors, destructors and assignment \r
+# operators of the base classes will not be shown.\r
+\r
+INLINE_INHERITED_MEMB  = NO\r
+\r
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full \r
+# path before files name in the file list and in the header files. If set \r
+# to NO the shortest path that makes the file name unique will be used.\r
+\r
+FULL_PATH_NAMES        = YES\r
+\r
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag \r
+# can be used to strip a user-defined part of the path. Stripping is \r
+# only done if one of the specified strings matches the left-hand part of \r
+# the path. The tag can be used to show relative paths in the file list. \r
+# If left blank the directory from which doxygen is run is used as the \r
+# path to strip.\r
+\r
+STRIP_FROM_PATH        = \r
+\r
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of \r
+# the path mentioned in the documentation of a class, which tells \r
+# the reader which header file to include in order to use a class. \r
+# If left blank only the name of the header file containing the class \r
+# definition is used. Otherwise one should specify the include paths that \r
+# are normally passed to the compiler using the -I flag.\r
+\r
+STRIP_FROM_INC_PATH    = \r
+\r
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter \r
+# (but less readable) file names. This can be useful is your file systems \r
+# doesn't support long names like on DOS, Mac, or CD-ROM.\r
+\r
+SHORT_NAMES            = YES\r
+\r
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen \r
+# will interpret the first line (until the first dot) of a JavaDoc-style \r
+# comment as the brief description. If set to NO, the JavaDoc \r
+# comments will behave just like regular Qt-style comments \r
+# (thus requiring an explicit @brief command for a brief description.)\r
+\r
+JAVADOC_AUTOBRIEF      = NO\r
+\r
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will \r
+# interpret the first line (until the first dot) of a Qt-style \r
+# comment as the brief description. If set to NO, the comments \r
+# will behave just like regular Qt-style comments (thus requiring \r
+# an explicit \brief command for a brief description.)\r
+\r
+QT_AUTOBRIEF           = NO\r
+\r
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen \r
+# treat a multi-line C++ special comment block (i.e. a block of //! or /// \r
+# comments) as a brief description. This used to be the default behaviour. \r
+# The new default is to treat a multi-line C++ comment block as a detailed \r
+# description. Set this tag to YES if you prefer the old behaviour instead.\r
+\r
+MULTILINE_CPP_IS_BRIEF = NO\r
+\r
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented \r
+# member inherits the documentation from any documented member that it \r
+# re-implements.\r
+\r
+INHERIT_DOCS           = YES\r
+\r
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce \r
+# a new page for each member. If set to NO, the documentation of a member will \r
+# be part of the file/class/namespace that contains it.\r
+\r
+SEPARATE_MEMBER_PAGES  = NO\r
+\r
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. \r
+# Doxygen uses this value to replace tabs by spaces in code fragments.\r
+\r
+TAB_SIZE               = 4\r
+\r
+# This tag can be used to specify a number of aliases that acts \r
+# as commands in the documentation. An alias has the form "name=value". \r
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to \r
+# put the command \sideeffect (or @sideeffect) in the documentation, which \r
+# will result in a user-defined paragraph with heading "Side Effects:". \r
+# You can put \n's in the value part of an alias to insert newlines.\r
+\r
+ALIASES                = \r
+\r
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C \r
+# sources only. Doxygen will then generate output that is more tailored for C. \r
+# For instance, some of the names that are used will be different. The list \r
+# of all members will be omitted, etc.\r
+\r
+OPTIMIZE_OUTPUT_FOR_C  = YES\r
+\r
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java \r
+# sources only. Doxygen will then generate output that is more tailored for \r
+# Java. For instance, namespaces will be presented as packages, qualified \r
+# scopes will look different, etc.\r
+\r
+OPTIMIZE_OUTPUT_JAVA   = NO\r
+\r
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran \r
+# sources only. Doxygen will then generate output that is more tailored for \r
+# Fortran.\r
+\r
+OPTIMIZE_FOR_FORTRAN   = NO\r
+\r
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL \r
+# sources. Doxygen will then generate output that is tailored for \r
+# VHDL.\r
+\r
+OPTIMIZE_OUTPUT_VHDL   = NO\r
+\r
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want \r
+# to include (a tag file for) the STL sources as input, then you should \r
+# set this tag to YES in order to let doxygen match functions declarations and \r
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. \r
+# func(std::string) {}). This also make the inheritance and collaboration \r
+# diagrams that involve STL classes more complete and accurate.\r
+\r
+BUILTIN_STL_SUPPORT    = NO\r
+\r
+# If you use Microsoft's C++/CLI language, you should set this option to YES to\r
+# enable parsing support.\r
+\r
+CPP_CLI_SUPPORT        = NO\r
+\r
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. \r
+# Doxygen will parse them like normal C++ but will assume all classes use public \r
+# instead of private inheritance when no explicit protection keyword is present.\r
+\r
+SIP_SUPPORT            = NO\r
+\r
+# For Microsoft's IDL there are propget and propput attributes to indicate getter \r
+# and setter methods for a property. Setting this option to YES (the default) \r
+# will make doxygen to replace the get and set methods by a property in the \r
+# documentation. This will only work if the methods are indeed getting or \r
+# setting a simple type. If this is not the case, or you want to show the \r
+# methods anyway, you should set this option to NO.\r
+\r
+IDL_PROPERTY_SUPPORT   = YES\r
+\r
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC \r
+# tag is set to YES, then doxygen will reuse the documentation of the first \r
+# member in the group (if any) for the other members of the group. By default \r
+# all members of a group must be documented explicitly.\r
+\r
+DISTRIBUTE_GROUP_DOC   = NO\r
+\r
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of \r
+# the same type (for instance a group of public functions) to be put as a \r
+# subgroup of that type (e.g. under the Public Functions section). Set it to \r
+# NO to prevent subgrouping. Alternatively, this can be done per class using \r
+# the \nosubgrouping command.\r
+\r
+SUBGROUPING            = YES\r
+\r
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum \r
+# is documented as struct, union, or enum with the name of the typedef. So \r
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct \r
+# with name TypeT. When disabled the typedef will appear as a member of a file, \r
+# namespace, or class. And the struct will be named TypeS. This can typically \r
+# be useful for C code in case the coding convention dictates that all compound \r
+# types are typedef'ed and only the typedef is referenced, never the tag name.\r
+\r
+TYPEDEF_HIDES_STRUCT   = NO\r
+\r
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to \r
+# determine which symbols to keep in memory and which to flush to disk.\r
+# When the cache is full, less often used symbols will be written to disk.\r
+# For small to medium size projects (<1000 input files) the default value is \r
+# probably good enough. For larger projects a too small cache size can cause \r
+# doxygen to be busy swapping symbols to and from disk most of the time \r
+# causing a significant performance penality. \r
+# If the system has enough physical memory increasing the cache will improve the \r
+# performance by keeping more symbols in memory. Note that the value works on \r
+# a logarithmic scale so increasing the size by one will rougly double the \r
+# memory usage. The cache size is given by this formula: \r
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, \r
+# corresponding to a cache size of 2^16 = 65536 symbols\r
+\r
+SYMBOL_CACHE_SIZE      = 0\r
+\r
+#---------------------------------------------------------------------------\r
+# Build related configuration options\r
+#---------------------------------------------------------------------------\r
+\r
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in \r
+# documentation are documented, even if no documentation was available. \r
+# Private class members and static file members will be hidden unless \r
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES\r
+\r
+EXTRACT_ALL            = YES\r
+\r
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class \r
+# will be included in the documentation.\r
+\r
+EXTRACT_PRIVATE        = YES\r
+\r
+# If the EXTRACT_STATIC tag is set to YES all static members of a file \r
+# will be included in the documentation.\r
+\r
+EXTRACT_STATIC         = YES\r
+\r
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) \r
+# defined locally in source files will be included in the documentation. \r
+# If set to NO only classes defined in header files are included.\r
+\r
+EXTRACT_LOCAL_CLASSES  = YES\r
+\r
+# This flag is only useful for Objective-C code. When set to YES local \r
+# methods, which are defined in the implementation section but not in \r
+# the interface are included in the documentation. \r
+# If set to NO (the default) only methods in the interface are included.\r
+\r
+EXTRACT_LOCAL_METHODS  = NO\r
+\r
+# If this flag is set to YES, the members of anonymous namespaces will be \r
+# extracted and appear in the documentation as a namespace called \r
+# 'anonymous_namespace{file}', where file will be replaced with the base \r
+# name of the file that contains the anonymous namespace. By default \r
+# anonymous namespace are hidden.\r
+\r
+EXTRACT_ANON_NSPACES   = NO\r
+\r
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all \r
+# undocumented members of documented classes, files or namespaces. \r
+# If set to NO (the default) these members will be included in the \r
+# various overviews, but no documentation section is generated. \r
+# This option has no effect if EXTRACT_ALL is enabled.\r
+\r
+HIDE_UNDOC_MEMBERS     = NO\r
+\r
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all \r
+# undocumented classes that are normally visible in the class hierarchy. \r
+# If set to NO (the default) these classes will be included in the various \r
+# overviews. This option has no effect if EXTRACT_ALL is enabled.\r
+\r
+HIDE_UNDOC_CLASSES     = NO\r
+\r
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all \r
+# friend (class|struct|union) declarations. \r
+# If set to NO (the default) these declarations will be included in the \r
+# documentation.\r
+\r
+HIDE_FRIEND_COMPOUNDS  = NO\r
+\r
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any \r
+# documentation blocks found inside the body of a function. \r
+# If set to NO (the default) these blocks will be appended to the \r
+# function's detailed documentation block.\r
+\r
+HIDE_IN_BODY_DOCS      = NO\r
+\r
+# The INTERNAL_DOCS tag determines if documentation \r
+# that is typed after a \internal command is included. If the tag is set \r
+# to NO (the default) then the documentation will be excluded. \r
+# Set it to YES to include the internal documentation.\r
+\r
+INTERNAL_DOCS          = NO\r
+\r
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate \r
+# file names in lower-case letters. If set to YES upper-case letters are also \r
+# allowed. This is useful if you have classes or files whose names only differ \r
+# in case and if your file system supports case sensitive file names. Windows \r
+# and Mac users are advised to set this option to NO.\r
+\r
+CASE_SENSE_NAMES       = NO\r
+\r
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen \r
+# will show members with their full class and namespace scopes in the \r
+# documentation. If set to YES the scope will be hidden.\r
+\r
+HIDE_SCOPE_NAMES       = NO\r
+\r
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen \r
+# will put a list of the files that are included by a file in the documentation \r
+# of that file.\r
+\r
+SHOW_INCLUDE_FILES     = YES\r
+\r
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] \r
+# is inserted in the documentation for inline members.\r
+\r
+INLINE_INFO            = YES\r
+\r
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen \r
+# will sort the (detailed) documentation of file and class members \r
+# alphabetically by member name. If set to NO the members will appear in \r
+# declaration order.\r
+\r
+SORT_MEMBER_DOCS       = YES\r
+\r
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the \r
+# brief documentation of file, namespace and class members alphabetically \r
+# by member name. If set to NO (the default) the members will appear in \r
+# declaration order.\r
+\r
+SORT_BRIEF_DOCS        = NO\r
+\r
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the \r
+# hierarchy of group names into alphabetical order. If set to NO (the default) \r
+# the group names will appear in their defined order.\r
+\r
+SORT_GROUP_NAMES       = NO\r
+\r
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be \r
+# sorted by fully-qualified names, including namespaces. If set to \r
+# NO (the default), the class list will be sorted only by class name, \r
+# not including the namespace part. \r
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.\r
+# Note: This option applies only to the class list, not to the \r
+# alphabetical list.\r
+\r
+SORT_BY_SCOPE_NAME     = NO\r
+\r
+# The GENERATE_TODOLIST tag can be used to enable (YES) or \r
+# disable (NO) the todo list. This list is created by putting \todo \r
+# commands in the documentation.\r
+\r
+GENERATE_TODOLIST      = NO\r
+\r
+# The GENERATE_TESTLIST tag can be used to enable (YES) or \r
+# disable (NO) the test list. This list is created by putting \test \r
+# commands in the documentation.\r
+\r
+GENERATE_TESTLIST      = NO\r
+\r
+# The GENERATE_BUGLIST tag can be used to enable (YES) or \r
+# disable (NO) the bug list. This list is created by putting \bug \r
+# commands in the documentation.\r
+\r
+GENERATE_BUGLIST       = NO\r
+\r
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or \r
+# disable (NO) the deprecated list. This list is created by putting \r
+# \deprecated commands in the documentation.\r
+\r
+GENERATE_DEPRECATEDLIST= YES\r
+\r
+# The ENABLED_SECTIONS tag can be used to enable conditional \r
+# documentation sections, marked by \if sectionname ... \endif.\r
+\r
+ENABLED_SECTIONS       = \r
+\r
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines \r
+# the initial value of a variable or define consists of for it to appear in \r
+# the documentation. If the initializer consists of more lines than specified \r
+# here it will be hidden. Use a value of 0 to hide initializers completely. \r
+# The appearance of the initializer of individual variables and defines in the \r
+# documentation can be controlled using \showinitializer or \hideinitializer \r
+# command in the documentation regardless of this setting.\r
+\r
+MAX_INITIALIZER_LINES  = 30\r
+\r
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated \r
+# at the bottom of the documentation of classes and structs. If set to YES the \r
+# list will mention the files that were used to generate the documentation.\r
+\r
+SHOW_USED_FILES        = YES\r
+\r
+# If the sources in your project are distributed over multiple directories \r
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy \r
+# in the documentation. The default is NO.\r
+\r
+SHOW_DIRECTORIES       = YES\r
+\r
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.\r
+# This will remove the Files entry from the Quick Index and from the \r
+# Folder Tree View (if specified). The default is YES.\r
+\r
+SHOW_FILES             = YES\r
+\r
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the \r
+# Namespaces page.  This will remove the Namespaces entry from the Quick Index\r
+# and from the Folder Tree View (if specified). The default is YES.\r
+\r
+SHOW_NAMESPACES        = YES\r
+\r
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that \r
+# doxygen should invoke to get the current version for each file (typically from \r
+# the version control system). Doxygen will invoke the program by executing (via \r
+# popen()) the command <command> <input-file>, where <command> is the value of \r
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file \r
+# provided by doxygen. Whatever the program writes to standard output \r
+# is used as the file version. See the manual for examples.\r
+\r
+FILE_VERSION_FILTER    = \r
+\r
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by \r
+# doxygen. The layout file controls the global structure of the generated output files \r
+# in an output format independent way. The create the layout file that represents \r
+# doxygen's defaults, run doxygen with the -l option. You can optionally specify a \r
+# file name after the option, if omitted DoxygenLayout.xml will be used as the name \r
+# of the layout file.\r
+\r
+LAYOUT_FILE            = \r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to warning and progress messages\r
+#---------------------------------------------------------------------------\r
+\r
+# The QUIET tag can be used to turn on/off the messages that are generated \r
+# by doxygen. Possible values are YES and NO. If left blank NO is used.\r
+\r
+QUIET                  = YES\r
+\r
+# The WARNINGS tag can be used to turn on/off the warning messages that are \r
+# generated by doxygen. Possible values are YES and NO. If left blank \r
+# NO is used.\r
+\r
+WARNINGS               = YES\r
+\r
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings \r
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will \r
+# automatically be disabled.\r
+\r
+WARN_IF_UNDOCUMENTED   = YES\r
+\r
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for \r
+# potential errors in the documentation, such as not documenting some \r
+# parameters in a documented function, or documenting parameters that \r
+# don't exist or using markup commands wrongly.\r
+\r
+WARN_IF_DOC_ERROR      = YES\r
+\r
+# This WARN_NO_PARAMDOC option can be abled to get warnings for \r
+# functions that are documented, but have no documentation for their parameters \r
+# or return value. If set to NO (the default) doxygen will only warn about \r
+# wrong or incomplete parameter documentation, but not about the absence of \r
+# documentation.\r
+\r
+WARN_NO_PARAMDOC       = YES\r
+\r
+# The WARN_FORMAT tag determines the format of the warning messages that \r
+# doxygen can produce. The string should contain the $file, $line, and $text \r
+# tags, which will be replaced by the file and line number from which the \r
+# warning originated and the warning text. Optionally the format may contain \r
+# $version, which will be replaced by the version of the file (if it could \r
+# be obtained via FILE_VERSION_FILTER)\r
+\r
+WARN_FORMAT            = "$file:$line: $text"\r
+\r
+# The WARN_LOGFILE tag can be used to specify a file to which warning \r
+# and error messages should be written. If left blank the output is written \r
+# to stderr.\r
+\r
+WARN_LOGFILE           = \r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the input files\r
+#---------------------------------------------------------------------------\r
+\r
+# The INPUT tag can be used to specify the files and/or directories that contain \r
+# documented source files. You may enter file names like "myfile.cpp" or \r
+# directories like "/usr/src/myproject". Separate the files or directories \r
+# with spaces.\r
+\r
+INPUT                  = ./\r
+\r
+# This tag can be used to specify the character encoding of the source files \r
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is \r
+# also the default input encoding. Doxygen uses libiconv (or the iconv built \r
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for \r
+# the list of possible encodings.\r
+\r
+INPUT_ENCODING         = UTF-8\r
+\r
+# If the value of the INPUT tag contains directories, you can use the \r
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp \r
+# and *.h) to filter out the source-files in the directories. If left \r
+# blank the following patterns are tested: \r
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx \r
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90\r
+\r
+FILE_PATTERNS          = *.h \\r
+                         *.c \\r
+                                                *.txt\r
+\r
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories \r
+# should be searched for input files as well. Possible values are YES and NO. \r
+# If left blank NO is used.\r
+\r
+RECURSIVE              = YES\r
+\r
+# The EXCLUDE tag can be used to specify files and/or directories that should \r
+# excluded from the INPUT source files. This way you can easily exclude a \r
+# subdirectory from a directory tree whose root is specified with the INPUT tag.\r
+\r
+EXCLUDE                = \r
+\r
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or \r
+# directories that are symbolic links (a Unix filesystem feature) are excluded \r
+# from the input.\r
+\r
+EXCLUDE_SYMLINKS       = NO\r
+\r
+# If the value of the INPUT tag contains directories, you can use the \r
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude \r
+# certain files from those directories. Note that the wildcards are matched \r
+# against the file with absolute path, so to exclude all test directories \r
+# for example use the pattern */test/*\r
+\r
+EXCLUDE_PATTERNS       = */LowLevel/USBMode.h\r
+\r
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names \r
+# (namespaces, classes, functions, etc.) that should be excluded from the \r
+# output. The symbol name can be a fully qualified name, a word, or if the \r
+# wildcard * is used, a substring. Examples: ANamespace, AClass, \r
+# AClass::ANamespace, ANamespace::*Test\r
+\r
+EXCLUDE_SYMBOLS        = __*\r
+\r
+# The EXAMPLE_PATH tag can be used to specify one or more files or \r
+# directories that contain example code fragments that are included (see \r
+# the \include command).\r
+\r
+EXAMPLE_PATH           = \r
+\r
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the \r
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp \r
+# and *.h) to filter out the source-files in the directories. If left \r
+# blank all files are included.\r
+\r
+EXAMPLE_PATTERNS       = *\r
+\r
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be \r
+# searched for input files to be used with the \include or \dontinclude \r
+# commands irrespective of the value of the RECURSIVE tag. \r
+# Possible values are YES and NO. If left blank NO is used.\r
+\r
+EXAMPLE_RECURSIVE      = NO\r
+\r
+# The IMAGE_PATH tag can be used to specify one or more files or \r
+# directories that contain image that are included in the documentation (see \r
+# the \image command).\r
+\r
+IMAGE_PATH             = \r
+\r
+# The INPUT_FILTER tag can be used to specify a program that doxygen should \r
+# invoke to filter for each input file. Doxygen will invoke the filter program \r
+# by executing (via popen()) the command <filter> <input-file>, where <filter> \r
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an \r
+# input file. Doxygen will then use the output that the filter program writes \r
+# to standard output.  If FILTER_PATTERNS is specified, this tag will be \r
+# ignored.\r
+\r
+INPUT_FILTER           = \r
+\r
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern \r
+# basis.  Doxygen will compare the file name with each pattern and apply the \r
+# filter if there is a match.  The filters are a list of the form: \r
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further \r
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER \r
+# is applied to all files.\r
+\r
+FILTER_PATTERNS        = \r
+\r
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using \r
+# INPUT_FILTER) will be used to filter the input files when producing source \r
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).\r
+\r
+FILTER_SOURCE_FILES    = NO\r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to source browsing\r
+#---------------------------------------------------------------------------\r
+\r
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will \r
+# be generated. Documented entities will be cross-referenced with these sources. \r
+# Note: To get rid of all source code in the generated output, make sure also \r
+# VERBATIM_HEADERS is set to NO.\r
+\r
+SOURCE_BROWSER         = NO\r
+\r
+# Setting the INLINE_SOURCES tag to YES will include the body \r
+# of functions and classes directly in the documentation.\r
+\r
+INLINE_SOURCES         = NO\r
+\r
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct \r
+# doxygen to hide any special comment blocks from generated source code \r
+# fragments. Normal C and C++ comments will always remain visible.\r
+\r
+STRIP_CODE_COMMENTS    = YES\r
+\r
+# If the REFERENCED_BY_RELATION tag is set to YES \r
+# then for each documented function all documented \r
+# functions referencing it will be listed.\r
+\r
+REFERENCED_BY_RELATION = NO\r
+\r
+# If the REFERENCES_RELATION tag is set to YES \r
+# then for each documented function all documented entities \r
+# called/used by that function will be listed.\r
+\r
+REFERENCES_RELATION    = NO\r
+\r
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)\r
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from\r
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will\r
+# link to the source code.  Otherwise they will link to the documentstion.\r
+\r
+REFERENCES_LINK_SOURCE = NO\r
+\r
+# If the USE_HTAGS tag is set to YES then the references to source code \r
+# will point to the HTML generated by the htags(1) tool instead of doxygen \r
+# built-in source browser. The htags tool is part of GNU's global source \r
+# tagging system (see http://www.gnu.org/software/global/global.html). You \r
+# will need version 4.8.6 or higher.\r
+\r
+USE_HTAGS              = NO\r
+\r
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen \r
+# will generate a verbatim copy of the header file for each class for \r
+# which an include is specified. Set to NO to disable this.\r
+\r
+VERBATIM_HEADERS       = NO\r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the alphabetical class index\r
+#---------------------------------------------------------------------------\r
+\r
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index \r
+# of all compounds will be generated. Enable this if the project \r
+# contains a lot of classes, structs, unions or interfaces.\r
+\r
+ALPHABETICAL_INDEX     = YES\r
+\r
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then \r
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns \r
+# in which this list will be split (can be a number in the range [1..20])\r
+\r
+COLS_IN_ALPHA_INDEX    = 5\r
+\r
+# In case all classes in a project start with a common prefix, all \r
+# classes will be put under the same header in the alphabetical index. \r
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that \r
+# should be ignored while generating the index headers.\r
+\r
+IGNORE_PREFIX          = \r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the HTML output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will \r
+# generate HTML output.\r
+\r
+GENERATE_HTML          = YES\r
+\r
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. \r
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
+# put in front of it. If left blank `html' will be used as the default path.\r
+\r
+HTML_OUTPUT            = html\r
+\r
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for \r
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank \r
+# doxygen will generate files with .html extension.\r
+\r
+HTML_FILE_EXTENSION    = .html\r
+\r
+# The HTML_HEADER tag can be used to specify a personal HTML header for \r
+# each generated HTML page. If it is left blank doxygen will generate a \r
+# standard header.\r
+\r
+HTML_HEADER            = \r
+\r
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for \r
+# each generated HTML page. If it is left blank doxygen will generate a \r
+# standard footer.\r
+\r
+HTML_FOOTER            = \r
+\r
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading \r
+# style sheet that is used by each HTML page. It can be used to \r
+# fine-tune the look of the HTML output. If the tag is left blank doxygen \r
+# will generate a default style sheet. Note that doxygen will try to copy \r
+# the style sheet file to the HTML output directory, so don't put your own \r
+# stylesheet in the HTML output directory as well, or it will be erased!\r
+\r
+HTML_STYLESHEET        = \r
+\r
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, \r
+# files or namespaces will be aligned in HTML using tables. If set to \r
+# NO a bullet list will be used.\r
+\r
+HTML_ALIGN_MEMBERS     = YES\r
+\r
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML \r
+# documentation will contain sections that can be hidden and shown after the \r
+# page has loaded. For this to work a browser that supports \r
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox \r
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).\r
+\r
+HTML_DYNAMIC_SECTIONS  = YES\r
+\r
+# If the GENERATE_DOCSET tag is set to YES, additional index files \r
+# will be generated that can be used as input for Apple's Xcode 3 \r
+# integrated development environment, introduced with OSX 10.5 (Leopard). \r
+# To create a documentation set, doxygen will generate a Makefile in the \r
+# HTML output directory. Running make will produce the docset in that \r
+# directory and running "make install" will install the docset in \r
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find \r
+# it at startup. \r
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.\r
+\r
+GENERATE_DOCSET        = NO\r
+\r
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the \r
+# feed. A documentation feed provides an umbrella under which multiple \r
+# documentation sets from a single provider (such as a company or product suite) \r
+# can be grouped.\r
+\r
+DOCSET_FEEDNAME        = "Doxygen generated docs"\r
+\r
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that \r
+# should uniquely identify the documentation set bundle. This should be a \r
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen \r
+# will append .docset to the name.\r
+\r
+DOCSET_BUNDLE_ID       = org.doxygen.Project\r
+\r
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files \r
+# will be generated that can be used as input for tools like the \r
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) \r
+# of the generated HTML documentation.\r
+\r
+GENERATE_HTMLHELP      = NO\r
+\r
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can \r
+# be used to specify the file name of the resulting .chm file. You \r
+# can add a path in front of the file if the result should not be \r
+# written to the html output directory.\r
+\r
+CHM_FILE               = \r
+\r
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can \r
+# be used to specify the location (absolute path including file name) of \r
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run \r
+# the HTML help compiler on the generated index.hhp.\r
+\r
+HHC_LOCATION           = \r
+\r
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag \r
+# controls if a separate .chi index file is generated (YES) or that \r
+# it should be included in the master .chm file (NO).\r
+\r
+GENERATE_CHI           = NO\r
+\r
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING\r
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file\r
+# content.\r
+\r
+CHM_INDEX_ENCODING     = \r
+\r
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag \r
+# controls whether a binary table of contents is generated (YES) or a \r
+# normal table of contents (NO) in the .chm file.\r
+\r
+BINARY_TOC             = NO\r
+\r
+# The TOC_EXPAND flag can be set to YES to add extra items for group members \r
+# to the contents of the HTML help documentation and to the tree view.\r
+\r
+TOC_EXPAND             = YES\r
+\r
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER \r
+# are set, an additional index file will be generated that can be used as input for \r
+# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated \r
+# HTML documentation.\r
+\r
+GENERATE_QHP           = NO\r
+\r
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can \r
+# be used to specify the file name of the resulting .qch file. \r
+# The path specified is relative to the HTML output folder.\r
+\r
+QCH_FILE               = \r
+\r
+# The QHP_NAMESPACE tag specifies the namespace to use when generating \r
+# Qt Help Project output. For more information please see \r
+# <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.\r
+\r
+QHP_NAMESPACE          = org.doxygen.Project\r
+\r
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating \r
+# Qt Help Project output. For more information please see \r
+# <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.\r
+\r
+QHP_VIRTUAL_FOLDER     = doc\r
+\r
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can \r
+# be used to specify the location of Qt's qhelpgenerator. \r
+# If non-empty doxygen will try to run qhelpgenerator on the generated \r
+# .qhp file .\r
+\r
+QHG_LOCATION           = \r
+\r
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at \r
+# top of each HTML page. The value NO (the default) enables the index and \r
+# the value YES disables it.\r
+\r
+DISABLE_INDEX          = NO\r
+\r
+# This tag can be used to set the number of enum values (range [1..20]) \r
+# that doxygen will group on one line in the generated HTML documentation.\r
+\r
+ENUM_VALUES_PER_LINE   = 1\r
+\r
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index\r
+# structure should be generated to display hierarchical information.\r
+# If the tag value is set to FRAME, a side panel will be generated\r
+# containing a tree-like index structure (just like the one that \r
+# is generated for HTML Help). For this to work a browser that supports \r
+# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, \r
+# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are \r
+# probably better off using the HTML help feature. Other possible values \r
+# for this tag are: HIERARCHIES, which will generate the Groups, Directories,\r
+# and Class Hierarchy pages using a tree view instead of an ordered list;\r
+# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which\r
+# disables this behavior completely. For backwards compatibility with previous\r
+# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE\r
+# respectively.\r
+\r
+GENERATE_TREEVIEW      = YES\r
+\r
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be \r
+# used to set the initial width (in pixels) of the frame in which the tree \r
+# is shown.\r
+\r
+TREEVIEW_WIDTH         = 250\r
+\r
+# Use this tag to change the font size of Latex formulas included \r
+# as images in the HTML documentation. The default is 10. Note that \r
+# when you change the font size after a successful doxygen run you need \r
+# to manually remove any form_*.png images from the HTML output directory \r
+# to force them to be regenerated.\r
+\r
+FORMULA_FONTSIZE       = 10\r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the LaTeX output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will \r
+# generate Latex output.\r
+\r
+GENERATE_LATEX         = NO\r
+\r
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. \r
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
+# put in front of it. If left blank `latex' will be used as the default path.\r
+\r
+LATEX_OUTPUT           = latex\r
+\r
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be \r
+# invoked. If left blank `latex' will be used as the default command name.\r
+\r
+LATEX_CMD_NAME         = latex\r
+\r
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to \r
+# generate index for LaTeX. If left blank `makeindex' will be used as the \r
+# default command name.\r
+\r
+MAKEINDEX_CMD_NAME     = makeindex\r
+\r
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact \r
+# LaTeX documents. This may be useful for small projects and may help to \r
+# save some trees in general.\r
+\r
+COMPACT_LATEX          = NO\r
+\r
+# The PAPER_TYPE tag can be used to set the paper type that is used \r
+# by the printer. Possible values are: a4, a4wide, letter, legal and \r
+# executive. If left blank a4wide will be used.\r
+\r
+PAPER_TYPE             = a4wide\r
+\r
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX \r
+# packages that should be included in the LaTeX output.\r
+\r
+EXTRA_PACKAGES         = \r
+\r
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for \r
+# the generated latex document. The header should contain everything until \r
+# the first chapter. If it is left blank doxygen will generate a \r
+# standard header. Notice: only use this tag if you know what you are doing!\r
+\r
+LATEX_HEADER           = \r
+\r
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated \r
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will \r
+# contain links (just like the HTML output) instead of page references \r
+# This makes the output suitable for online browsing using a pdf viewer.\r
+\r
+PDF_HYPERLINKS         = YES\r
+\r
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of \r
+# plain latex in the generated Makefile. Set this option to YES to get a \r
+# higher quality PDF documentation.\r
+\r
+USE_PDFLATEX           = YES\r
+\r
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. \r
+# command to the generated LaTeX files. This will instruct LaTeX to keep \r
+# running if errors occur, instead of asking the user for help. \r
+# This option is also used when generating formulas in HTML.\r
+\r
+LATEX_BATCHMODE        = NO\r
+\r
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not \r
+# include the index chapters (such as File Index, Compound Index, etc.) \r
+# in the output.\r
+\r
+LATEX_HIDE_INDICES     = NO\r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the RTF output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output \r
+# The RTF output is optimized for Word 97 and may not look very pretty with \r
+# other RTF readers or editors.\r
+\r
+GENERATE_RTF           = NO\r
+\r
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. \r
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
+# put in front of it. If left blank `rtf' will be used as the default path.\r
+\r
+RTF_OUTPUT             = rtf\r
+\r
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact \r
+# RTF documents. This may be useful for small projects and may help to \r
+# save some trees in general.\r
+\r
+COMPACT_RTF            = NO\r
+\r
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated \r
+# will contain hyperlink fields. The RTF file will \r
+# contain links (just like the HTML output) instead of page references. \r
+# This makes the output suitable for online browsing using WORD or other \r
+# programs which support those fields. \r
+# Note: wordpad (write) and others do not support links.\r
+\r
+RTF_HYPERLINKS         = NO\r
+\r
+# Load stylesheet definitions from file. Syntax is similar to doxygen's \r
+# config file, i.e. a series of assignments. You only have to provide \r
+# replacements, missing definitions are set to their default value.\r
+\r
+RTF_STYLESHEET_FILE    = \r
+\r
+# Set optional variables used in the generation of an rtf document. \r
+# Syntax is similar to doxygen's config file.\r
+\r
+RTF_EXTENSIONS_FILE    = \r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the man page output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will \r
+# generate man pages\r
+\r
+GENERATE_MAN           = NO\r
+\r
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. \r
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
+# put in front of it. If left blank `man' will be used as the default path.\r
+\r
+MAN_OUTPUT             = man\r
+\r
+# The MAN_EXTENSION tag determines the extension that is added to \r
+# the generated man pages (default is the subroutine's section .3)\r
+\r
+MAN_EXTENSION          = .3\r
+\r
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output, \r
+# then it will generate one additional man file for each entity \r
+# documented in the real man page(s). These additional files \r
+# only source the real man page, but without them the man command \r
+# would be unable to find the correct page. The default is NO.\r
+\r
+MAN_LINKS              = NO\r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the XML output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_XML tag is set to YES Doxygen will \r
+# generate an XML file that captures the structure of \r
+# the code including all documentation.\r
+\r
+GENERATE_XML           = NO\r
+\r
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. \r
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be \r
+# put in front of it. If left blank `xml' will be used as the default path.\r
+\r
+XML_OUTPUT             = xml\r
+\r
+# The XML_SCHEMA tag can be used to specify an XML schema, \r
+# which can be used by a validating XML parser to check the \r
+# syntax of the XML files.\r
+\r
+XML_SCHEMA             = \r
+\r
+# The XML_DTD tag can be used to specify an XML DTD, \r
+# which can be used by a validating XML parser to check the \r
+# syntax of the XML files.\r
+\r
+XML_DTD                = \r
+\r
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will \r
+# dump the program listings (including syntax highlighting \r
+# and cross-referencing information) to the XML output. Note that \r
+# enabling this will significantly increase the size of the XML output.\r
+\r
+XML_PROGRAMLISTING     = YES\r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options for the AutoGen Definitions output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will \r
+# generate an AutoGen Definitions (see autogen.sf.net) file \r
+# that captures the structure of the code including all \r
+# documentation. Note that this feature is still experimental \r
+# and incomplete at the moment.\r
+\r
+GENERATE_AUTOGEN_DEF   = NO\r
+\r
+#---------------------------------------------------------------------------\r
+# configuration options related to the Perl module output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will \r
+# generate a Perl module file that captures the structure of \r
+# the code including all documentation. Note that this \r
+# feature is still experimental and incomplete at the \r
+# moment.\r
+\r
+GENERATE_PERLMOD       = NO\r
+\r
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate \r
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able \r
+# to generate PDF and DVI output from the Perl module output.\r
+\r
+PERLMOD_LATEX          = NO\r
+\r
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be \r
+# nicely formatted so it can be parsed by a human reader.  This is useful \r
+# if you want to understand what is going on.  On the other hand, if this \r
+# tag is set to NO the size of the Perl module output will be much smaller \r
+# and Perl will parse it just the same.\r
+\r
+PERLMOD_PRETTY         = YES\r
+\r
+# The names of the make variables in the generated doxyrules.make file \r
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. \r
+# This is useful so different doxyrules.make files included by the same \r
+# Makefile don't overwrite each other's variables.\r
+\r
+PERLMOD_MAKEVAR_PREFIX = \r
+\r
+#---------------------------------------------------------------------------\r
+# Configuration options related to the preprocessor   \r
+#---------------------------------------------------------------------------\r
+\r
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will \r
+# evaluate all C-preprocessor directives found in the sources and include \r
+# files.\r
+\r
+ENABLE_PREPROCESSING   = YES\r
+\r
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro \r
+# names in the source code. If set to NO (the default) only conditional \r
+# compilation will be performed. Macro expansion can be done in a controlled \r
+# way by setting EXPAND_ONLY_PREDEF to YES.\r
+\r
+MACRO_EXPANSION        = YES\r
+\r
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES \r
+# then the macro expansion is limited to the macros specified with the \r
+# PREDEFINED and EXPAND_AS_DEFINED tags.\r
+\r
+EXPAND_ONLY_PREDEF     = YES\r
+\r
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files \r
+# in the INCLUDE_PATH (see below) will be search if a #include is found.\r
+\r
+SEARCH_INCLUDES        = YES\r
+\r
+# The INCLUDE_PATH tag can be used to specify one or more directories that \r
+# contain include files that are not input files but should be processed by \r
+# the preprocessor.\r
+\r
+INCLUDE_PATH           = \r
+\r
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard \r
+# patterns (like *.h and *.hpp) to filter out the header-files in the \r
+# directories. If left blank, the patterns specified with FILE_PATTERNS will \r
+# be used.\r
+\r
+INCLUDE_FILE_PATTERNS  = \r
+\r
+# The PREDEFINED tag can be used to specify one or more macro names that \r
+# are defined before the preprocessor is started (similar to the -D option of \r
+# gcc). The argument of the tag is a list of macros of the form: name \r
+# or name=definition (no spaces). If the definition and the = are \r
+# omitted =1 is assumed. To prevent a macro definition from being \r
+# undefined via #undef or recursively expanded use the := operator \r
+# instead of the = operator.\r
+\r
+PREDEFINED             = __DOXYGEN__\r
+\r
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then \r
+# this tag can be used to specify a list of macro names that should be expanded. \r
+# The macro definition that is found in the sources will be used. \r
+# Use the PREDEFINED tag if you want to use a different macro definition.\r
+\r
+EXPAND_AS_DEFINED      = BUTTLOADTAG\r
+\r
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then \r
+# doxygen's preprocessor will remove all function-like macros that are alone \r
+# on a line, have an all uppercase name, and do not end with a semicolon. Such \r
+# function macros are typically used for boiler-plate code, and will confuse \r
+# the parser if not removed.\r
+\r
+SKIP_FUNCTION_MACROS   = YES\r
+\r
+#---------------------------------------------------------------------------\r
+# Configuration::additions related to external references   \r
+#---------------------------------------------------------------------------\r
+\r
+# The TAGFILES option can be used to specify one or more tagfiles. \r
+# Optionally an initial location of the external documentation \r
+# can be added for each tagfile. The format of a tag file without \r
+# this location is as follows: \r
+#   TAGFILES = file1 file2 ... \r
+# Adding location for the tag files is done as follows: \r
+#   TAGFILES = file1=loc1 "file2 = loc2" ... \r
+# where "loc1" and "loc2" can be relative or absolute paths or \r
+# URLs. If a location is present for each tag, the installdox tool \r
+# does not have to be run to correct the links.\r
+# Note that each tag file must have a unique name\r
+# (where the name does NOT include the path)\r
+# If a tag file is not located in the directory in which doxygen \r
+# is run, you must also specify the path to the tagfile here.\r
+\r
+TAGFILES               = \r
+\r
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create \r
+# a tag file that is based on the input files it reads.\r
+\r
+GENERATE_TAGFILE       = \r
+\r
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed \r
+# in the class index. If set to NO only the inherited external classes \r
+# will be listed.\r
+\r
+ALLEXTERNALS           = NO\r
+\r
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed \r
+# in the modules index. If set to NO, only the current project's groups will \r
+# be listed.\r
+\r
+EXTERNAL_GROUPS        = YES\r
+\r
+# The PERL_PATH should be the absolute path and name of the perl script \r
+# interpreter (i.e. the result of `which perl').\r
+\r
+PERL_PATH              = /usr/bin/perl\r
+\r
+#---------------------------------------------------------------------------\r
+# Configuration options related to the dot tool   \r
+#---------------------------------------------------------------------------\r
+\r
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will \r
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base \r
+# or super classes. Setting the tag to NO turns the diagrams off. Note that \r
+# this option is superseded by the HAVE_DOT option below. This is only a \r
+# fallback. It is recommended to install and use dot, since it yields more \r
+# powerful graphs.\r
+\r
+CLASS_DIAGRAMS         = NO\r
+\r
+# You can define message sequence charts within doxygen comments using the \msc \r
+# command. Doxygen will then run the mscgen tool (see \r
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the \r
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where \r
+# the mscgen tool resides. If left empty the tool is assumed to be found in the \r
+# default search path.\r
+\r
+MSCGEN_PATH            = \r
+\r
+# If set to YES, the inheritance and collaboration graphs will hide \r
+# inheritance and usage relations if the target is undocumented \r
+# or is not a class.\r
+\r
+HIDE_UNDOC_RELATIONS   = YES\r
+\r
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is \r
+# available from the path. This tool is part of Graphviz, a graph visualization \r
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section \r
+# have no effect if this option is set to NO (the default)\r
+\r
+HAVE_DOT               = NO\r
+\r
+# By default doxygen will write a font called FreeSans.ttf to the output \r
+# directory and reference it in all dot files that doxygen generates. This \r
+# font does not include all possible unicode characters however, so when you need \r
+# these (or just want a differently looking font) you can specify the font name \r
+# using DOT_FONTNAME. You need need to make sure dot is able to find the font, \r
+# which can be done by putting it in a standard location or by setting the \r
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory \r
+# containing the font.\r
+\r
+DOT_FONTNAME           = FreeSans\r
+\r
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. \r
+# The default size is 10pt.\r
+\r
+DOT_FONTSIZE           = 10\r
+\r
+# By default doxygen will tell dot to use the output directory to look for the \r
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a \r
+# different font using DOT_FONTNAME you can set the path where dot \r
+# can find it using this tag.\r
+\r
+DOT_FONTPATH           = \r
+\r
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen \r
+# will generate a graph for each documented class showing the direct and \r
+# indirect inheritance relations. Setting this tag to YES will force the \r
+# the CLASS_DIAGRAMS tag to NO.\r
+\r
+CLASS_GRAPH            = NO\r
+\r
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen \r
+# will generate a graph for each documented class showing the direct and \r
+# indirect implementation dependencies (inheritance, containment, and \r
+# class references variables) of the class with other documented classes.\r
+\r
+COLLABORATION_GRAPH    = NO\r
+\r
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen \r
+# will generate a graph for groups, showing the direct groups dependencies\r
+\r
+GROUP_GRAPHS           = NO\r
+\r
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and \r
+# collaboration diagrams in a style similar to the OMG's Unified Modeling \r
+# Language.\r
+\r
+UML_LOOK               = NO\r
+\r
+# If set to YES, the inheritance and collaboration graphs will show the \r
+# relations between templates and their instances.\r
+\r
+TEMPLATE_RELATIONS     = NO\r
+\r
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT \r
+# tags are set to YES then doxygen will generate a graph for each documented \r
+# file showing the direct and indirect include dependencies of the file with \r
+# other documented files.\r
+\r
+INCLUDE_GRAPH          = NO\r
+\r
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and \r
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each \r
+# documented header file showing the documented files that directly or \r
+# indirectly include this file.\r
+\r
+INCLUDED_BY_GRAPH      = NO\r
+\r
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then \r
+# doxygen will generate a call dependency graph for every global function \r
+# or class method. Note that enabling this option will significantly increase \r
+# the time of a run. So in most cases it will be better to enable call graphs \r
+# for selected functions only using the \callgraph command.\r
+\r
+CALL_GRAPH             = NO\r
+\r
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then \r
+# doxygen will generate a caller dependency graph for every global function \r
+# or class method. Note that enabling this option will significantly increase \r
+# the time of a run. So in most cases it will be better to enable caller \r
+# graphs for selected functions only using the \callergraph command.\r
+\r
+CALLER_GRAPH           = NO\r
+\r
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen \r
+# will graphical hierarchy of all classes instead of a textual one.\r
+\r
+GRAPHICAL_HIERARCHY    = NO\r
+\r
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES \r
+# then doxygen will show the dependencies a directory has on other directories \r
+# in a graphical way. The dependency relations are determined by the #include\r
+# relations between the files in the directories.\r
+\r
+DIRECTORY_GRAPH        = NO\r
+\r
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images \r
+# generated by dot. Possible values are png, jpg, or gif\r
+# If left blank png will be used.\r
+\r
+DOT_IMAGE_FORMAT       = png\r
+\r
+# The tag DOT_PATH can be used to specify the path where the dot tool can be \r
+# found. If left blank, it is assumed the dot tool can be found in the path.\r
+\r
+DOT_PATH               = "C:/Program Files/Graphviz2.18/bin"\r
+\r
+# The DOTFILE_DIRS tag can be used to specify one or more directories that \r
+# contain dot files that are included in the documentation (see the \r
+# \dotfile command).\r
+\r
+DOTFILE_DIRS           = \r
+\r
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of \r
+# nodes that will be shown in the graph. If the number of nodes in a graph \r
+# becomes larger than this value, doxygen will truncate the graph, which is \r
+# visualized by representing a node as a red box. Note that doxygen if the \r
+# number of direct children of the root node in a graph is already larger than \r
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note \r
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.\r
+\r
+DOT_GRAPH_MAX_NODES    = 15\r
+\r
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the \r
+# graphs generated by dot. A depth value of 3 means that only nodes reachable \r
+# from the root by following a path via at most 3 edges will be shown. Nodes \r
+# that lay further from the root node will be omitted. Note that setting this \r
+# option to 1 or 2 may greatly reduce the computation time needed for large \r
+# code bases. Also note that the size of a graph can be further restricted by \r
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.\r
+\r
+MAX_DOT_GRAPH_DEPTH    = 2\r
+\r
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent \r
+# background. This is disabled by default, because dot on Windows does not \r
+# seem to support this out of the box. Warning: Depending on the platform used, \r
+# enabling this option may lead to badly anti-aliased labels on the edges of \r
+# a graph (i.e. they become hard to read).\r
+\r
+DOT_TRANSPARENT        = YES\r
+\r
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output \r
+# files in one run (i.e. multiple -o and -T options on the command line). This \r
+# makes dot run faster, but since only newer versions of dot (>1.8.10) \r
+# support this, this feature is disabled by default.\r
+\r
+DOT_MULTI_TARGETS      = NO\r
+\r
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will \r
+# generate a legend page explaining the meaning of the various boxes and \r
+# arrows in the dot generated graphs.\r
+\r
+GENERATE_LEGEND        = YES\r
+\r
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will \r
+# remove the intermediate dot files that are used to generate \r
+# the various graphs.\r
+\r
+DOT_CLEANUP            = YES\r
+\r
+#---------------------------------------------------------------------------\r
+# Configuration::additions related to the search engine   \r
+#---------------------------------------------------------------------------\r
+\r
+# The SEARCHENGINE tag specifies whether or not a search engine should be \r
+# used. If set to NO the values of all tags below this one will be ignored.\r
+\r
+SEARCHENGINE           = NO\r
diff --git a/Projects/Magstripe/Magstripe.aps b/Projects/Magstripe/Magstripe.aps
new file mode 100644 (file)
index 0000000..86d011a
--- /dev/null
@@ -0,0 +1 @@
+<AVRStudio><MANAGEMENT><ProjectName>Magstripe</ProjectName><Created>30-Sep-2008 14:19:14</Created><LastEdit>30-Sep-2008 14:19:28</LastEdit><ICON>241</ICON><ProjectType>0</ProjectType><Created>30-Sep-2008 14:19:14</Created><Version>4</Version><Build>4, 14, 0, 589</Build><ProjectTypeName>AVR GCC</ProjectTypeName></MANAGEMENT><CODE_CREATION><ObjectFile></ObjectFile><EntryFile></EntryFile><SaveFolder>C:\Users\Dean\Documents\Electronics\Projects\WORK\MyUSBWORK\Projects\Magstripe\</SaveFolder></CODE_CREATION><DEBUG_TARGET><CURRENT_TARGET></CURRENT_TARGET><CURRENT_PART></CURRENT_PART><BREAKPOINTS></BREAKPOINTS><IO_EXPAND><HIDE>false</HIDE></IO_EXPAND><REGISTERNAMES><Register>R00</Register><Register>R01</Register><Register>R02</Register><Register>R03</Register><Register>R04</Register><Register>R05</Register><Register>R06</Register><Register>R07</Register><Register>R08</Register><Register>R09</Register><Register>R10</Register><Register>R11</Register><Register>R12</Register><Register>R13</Register><Register>R14</Register><Register>R15</Register><Register>R16</Register><Register>R17</Register><Register>R18</Register><Register>R19</Register><Register>R20</Register><Register>R21</Register><Register>R22</Register><Register>R23</Register><Register>R24</Register><Register>R25</Register><Register>R26</Register><Register>R27</Register><Register>R28</Register><Register>R29</Register><Register>R30</Register><Register>R31</Register></REGISTERNAMES><COM>Auto</COM><COMType>0</COMType><WATCHNUM>0</WATCHNUM><WATCHNAMES><Pane0></Pane0><Pane1></Pane1><Pane2></Pane2><Pane3></Pane3></WATCHNAMES><BreakOnTrcaeFull>0</BreakOnTrcaeFull></DEBUG_TARGET><Debugger><Triggers></Triggers></Debugger><AVRGCCPLUGIN><FILES><SOURCEFILE>Descriptors.c</SOURCEFILE><SOURCEFILE>Magstripe.c</SOURCEFILE><HEADERFILE>Descriptors.h</HEADERFILE><HEADERFILE>Magstripe.h</HEADERFILE><HEADERFILE>MagstripeHW.h</HEADERFILE><OTHERFILE>makefile</OTHERFILE></FILES><CONFIGS><CONFIG><NAME>default</NAME><USESEXTERNALMAKEFILE>YES</USESEXTERNALMAKEFILE><EXTERNALMAKEFILE>makefile</EXTERNALMAKEFILE><PART>atmega128</PART><HEX>1</HEX><LIST>1</LIST><MAP>1</MAP><OUTPUTFILENAME>Magstripe.elf</OUTPUTFILENAME><OUTPUTDIR>default\</OUTPUTDIR><ISDIRTY>1</ISDIRTY><OPTIONS/><INCDIRS/><LIBDIRS/><LIBS/><LINKOBJECTS/><OPTIONSFORALL>-Wall -gdwarf-2 -std=gnu99 -Os -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums</OPTIONSFORALL><LINKEROPTIONS></LINKEROPTIONS><SEGMENTS/></CONFIG></CONFIGS><LASTCONFIG>default</LASTCONFIG><USES_WINAVR>1</USES_WINAVR><GCC_LOC>C:\WinAVR-20080512\bin\avr-gcc.exe</GCC_LOC><MAKE_LOC>C:\WinAVR-20080512\utils\bin\make.exe</MAKE_LOC></AVRGCCPLUGIN><IOView><usergroups/><sort sorted="0" column="0" ordername="0" orderaddress="0" ordergroup="0"/></IOView><Files></Files><Events><Bookmarks></Bookmarks></Events><Trace><Filters></Filters></Trace></AVRStudio>\r
diff --git a/Projects/Magstripe/Magstripe.c b/Projects/Magstripe/Magstripe.c
new file mode 100644 (file)
index 0000000..3696c12
--- /dev/null
@@ -0,0 +1,436 @@
+/*\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
+ *  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
+ */\r
\r
+#include "Magstripe.h"\r
+\r
+/* Project Tags, for reading out using the ButtLoad project */\r
+BUTTLOADTAG(ProjName,    "Magstripe Reader");\r
+BUTTLOADTAG(BuildTime,   __TIME__);\r
+BUTTLOADTAG(BuildDate,   __DATE__);\r
+BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\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
+ */\r
+bool UsingReportProtocol = true;\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
+\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
+\r
+/** Circular buffer to hold the read bits from track 1 of the inserted magnetic card. */\r
+BitBuffer_t Track1Data;\r
+\r
+/** Circular buffer to hold the read bits from track 2 of the inserted magnetic card. */\r
+BitBuffer_t Track2Data;\r
+\r
+/** Circular buffer to hold the read bits from track 3 of the inserted magnetic card. */\r
+BitBuffer_t Track3Data;\r
+\r
+/** Delay counter between sucessive 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
+ */\r
+uint8_t KeyDelayRemaining;\r
+\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
+{\r
+       /* Disable watchdog if enabled by bootloader/fuses */\r
+       MCUSR &= ~(1 << WDRF);\r
+       wdt_disable();\r
+\r
+       /* Disable Clock Division */\r
+       SetSystemClockPrescaler(0);\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
+ */\r
+EVENT_HANDLER(USB_UnhandledControlPacket)\r
+{\r
+       /* Handle HID Class specific requests */\r
+       switch (bRequest)\r
+       {\r
+               case REQ_GetReport:\r
+                       if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       {\r
+                               USB_KeyboardReport_Data_t KeyboardReportData;\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
+\r
+                               Endpoint_ClearSetupReceived();\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_ClearSetupOUT();\r
+                       }\r
+               \r
+                       break;\r
+               case REQ_GetProtocol:\r
+                       if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       {\r
+                               Endpoint_ClearSetupReceived();\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_ClearSetupIN();\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_ClearSetupReceived();\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
+                               /* Send an empty packet to acknowedge the command */\r
+                               Endpoint_ClearSetupIN();\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_ClearSetupReceived();\r
+                               \r
+                               /* Get idle period in MSB */\r
+                               IdleCount = (wValue >> 8);\r
+                               \r
+                               /* Send an empty packet to acknowedge the command */\r
+                               Endpoint_ClearSetupIN();\r
+                       }\r
+                       \r
+                       break;\r
+               case REQ_GetIdle:\r
+                       if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
+                       {               \r
+                               Endpoint_ClearSetupReceived();\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_ClearSetupIN();\r
+                       }\r
+\r
+                       break;\r
+       }\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
+{\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
+}\r
+\r
+/** Constructs a keyboard report indicating the currently pressed keyboard keys 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
+ *\r
+ *  \return Boolean true if the current report is different to the previous report, false otherwise\r
+ */\r
+bool GetNextReport(USB_KeyboardReport_Data_t* ReportData)\r
+{\r
+       static bool OddReport   = false;\r
+       static bool MustRelease = false;\r
+       \r
+       BitBuffer_t* Buffer     = NULL;\r
+\r
+       /* Clear the report contents */\r
+       memset(ReportData, 0, sizeof(USB_KeyboardReport_Data_t));\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
+\r
+       if (Buffer != NULL)\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 interpersed 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[0] = 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[0] = KEY_ENTER;                             \r
+                       }\r
+               }\r
+\r
+               return true;\r
+       }\r
+       else if (MustRelease)\r
+       {\r
+               /* Leave key code to null (0), to release all pressed keys */\r
+               return true;\r
+       }\r
+       \r
+       return false;\r
+}\r
+\r
+/** Task to read out data from inserted magnetic cards and place the seperate 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 seperate 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
+       {\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
+       }\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
+}\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 keypresses via keyboard reports.\r
+ */\r
+TASK(USB_Keyboard_Report)\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_ReadWriteAllowed())\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_ClearCurrentBank();\r
+\r
+                               /* Reset the key delay period counter */\r
+                               KeyDelayRemaining = 2;\r
+                       }\r
+               }\r
+       }\r
+}\r
diff --git a/Projects/Magstripe/Magstripe.h b/Projects/Magstripe/Magstripe.h
new file mode 100644 (file)
index 0000000..cde2fcd
--- /dev/null
@@ -0,0 +1,121 @@
+/*\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 <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[6]; /**< 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
diff --git a/Projects/Magstripe/Magstripe.txt b/Projects/Magstripe/Magstripe.txt
new file mode 100644 (file)
index 0000000..d91fddd
--- /dev/null
@@ -0,0 +1,85 @@
+/** \file\r
+ *\r
+ *  This file contains special DoxyGen information for the generation of the main page and other special\r
+ *  documentation pages. It is not a project source file.\r
+ */\r
\r
+/** \mainpage Denver Gingerich's USBSnoop Magnetic Card Reader Project\r
+ * \r
+ *  Firmware for a USB AVR powered USB TTL magnetic stripe reader (using a card\r
+ *  reader such as the Omron V3B-4K) by Denver Gingerich. This project is designed\r
+ *  to be used with the open source Stripe Snoop project at http://stripesnoop.sourceforge.net/.\r
+ * \r
+ *  See http://ossguy.com/ss_usb/ for the USB reader hardware project website,\r
+ *  including construction and support details.\r
+ * \r
+ *  To use, connect your magentic card reader device to the USB AVR as follows (pin and port mapping may be adjusted\r
+ *  from the project makefile):\r
+ * \r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>Signal:</b></td>\r
+ *    <td><b>AVR Port:</b></td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>Track 1 Data</td>\r
+ *    <td>PORTC, Pin 1</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>Track 1 Clock</td>\r
+ *    <td>PORTC, Pin 2</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>Track 2 Data</td>\r
+ *    <td>PORTC, Pin 3</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>Track 2 Clock</td>\r
+ *    <td>PORTC, Pin 0</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>Track 3 Data</td>\r
+ *    <td>PORTC, Pin 5</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>Track 3 Clock</td>\r
+ *    <td>PORTC, Pin 6</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>Card Detect</td>\r
+ *    <td>PORTC, Pin 4</td>\r
+ *   </tr>\r
+ *  </table>\r
+ *\r
+ * \r
+ *  This project is based on the LUFA Keyboard demonstration application,\r
+ *  written by Denver Gingerich.\r
+ *\r
+ *  This application uses a keyboard HID driver to communicate the data collected\r
+ *  a TTL magnetic stripe reader to the connected computer. The raw bitstream\r
+ *  obtained from the magnetic stripe reader is "typed" through the keyboard\r
+ *  driver as 0's and 1's. After every card swipe, the demo will send a return key.\r
+ *\r
+ * <table>\r
+ *  <tr>\r
+ *   <td><b>USB Mode:</b></td>\r
+ *   <td>Device</td>\r
+ *  </tr>\r
+ *  <tr>\r
+ *   <td><b>USB Class:</b></td>\r
+ *   <td>Human Interface Device (HID)</td>\r
+ *  </tr>\r
+ *  <tr> \r
+ *   <td><b>USB Subclass:</b></td>\r
+ *   <td>Keyboard</td>\r
+ *  </tr>\r
+ *  <tr>\r
+ *   <td><b>Relevant Standards:</b></td>\r
+ *   <td>USBIF HID Standard, USBIF HID Usage Tables</td>\r
+ *  </tr>\r
+ *  <tr>\r
+ *   <td><b>Usable Speeds:</b></td>\r
+ *   <td>Low Speed Mode, Full Speed Mode</td>\r
+ *  </tr>\r
+ * </table>\r
+ */\r
diff --git a/Projects/Magstripe/MagstripeHW.h b/Projects/Magstripe/MagstripeHW.h
new file mode 100644 (file)
index 0000000..c468118
--- /dev/null
@@ -0,0 +1,100 @@
+/*
+  Copyright 2009  Denver Gingerich (denver [at] ossguy [dot] com)
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, and distribute this software
+  and its documentation for any purpose and without fee is hereby
+  granted, 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.
+*/
+
+/*
+       NOTE: The user of this include file MUST define the following macros
+       prior to including the file:
+
+       MAG_T1_CLOCK_PIN   Pin connected to Track 1 clock wire (ie. PORTC1)
+       MAG_T1_DATA_PIN    Pin connected to Track 1 data wire (ie. PORTC2)
+       MAG_T2_CLOCK_PIN   Pin connected to Track 2 clock wire (ie. PORTC3)
+       MAG_T2_DATA_PIN    Pin connected to Track 2 data wire (ie. PORTC0)
+       MAG_T3_CLOCK_PIN   Pin connected to Track 3 clock wire (ie. PORTC5)
+       MAG_T3_DATA_PIN    Pin connected to Track 3 data wire (ie. PORTC6)
+       MAG_CLS_PIN        Pin connected to card loaded wire (ie. PORTC4)
+       MAG_PIN            PIN macro for the reader's port (ie. PINC)
+       MAG_DDR            DDR macro for the reader's port (ie. DDRC)
+       MAG_PORT           PORT macro for the reader's port (ie. PORTC)
+
+       The example macros listed above assume that the Track 2 data wire is
+       connected to pin 0 on port C, the Track 2 clock wire is connected to
+       pin 3 on port C (similarly for Tracks 1 and 3), and the card loaded
+       wire is connected to pin 4 on port C.
+
+       If the magstripe reader you are using only reads one or two tracks,
+       then set the clock and data pins for the tracks it doesn't read to a
+       pin that is unused.  For example, on the AT90USBKey, any of the pins on
+       port C that do not have wires attached will be unused since they are
+       not connected to any onboard devices (such as the joystick or
+       temperature sensor).
+
+       Connecting wires to pins on different ports (ie. a data wire to pin 0
+       on port C and a clock wire to pin 0 on port D) is currently
+       unsupported.  All pins specified above must be on the same port.
+*/
+
+/** \file
+ *
+ *  Driver header for a TTL Magnetic Card reader device (such as the Omron V3B-4K).
+ */
+
+#ifndef _MAGSTRIPEHW_H_
+#define _MAGSTRIPEHW_H_
+
+       /* Includes: */
+               #include <avr/io.h>
+
+               #include <LUFA/Common/Common.h>
+
+       /* Private Interface - For use in library only: */
+               /* Macros: */
+                       /** Mask of the track data, clock and card detection pins. */
+                       #define MAG_MASK    (MAG_T1_DATA | MAG_T1_CLOCK | \
+                                            MAG_T2_DATA | MAG_T2_CLOCK | \
+                                            MAG_T3_DATA | MAG_T3_CLOCK | \
+                                            MAG_CARDPRESENT)
+
+       /* Public Interface - May be used in end-application: */
+               /* Inline Functions: */
+                       /** Initializes the magnetic stripe card reader ports and pins so that the card reader
+                        *  device can be controlled and read by the card reader driver. This must be called before
+                        *  trying to read any of the card reader's status lines.
+                        */
+                       static inline void Magstripe_Init(void)
+                       {
+                               MAG_DDR  &= ~MAG_MASK;
+                               MAG_PORT |=  MAG_MASK;
+                       };
+
+                       /** Returns the status of all the magnetic card reader's outputs.
+                        *
+                        *  \return A mask indicating which card lines are high or low
+                        */
+                       static inline uint8_t Magstripe_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
+                       static inline uint8_t Magstripe_GetStatus(void)
+                       {
+                               /* Magstripe IOs are active low and must be inverted when read */
+                               return ((uint8_t)~MAG_PIN & MAG_MASK);
+                       }
+
+#endif
diff --git a/Projects/Magstripe/makefile b/Projects/Magstripe/makefile
new file mode 100644 (file)
index 0000000..2ea5536
--- /dev/null
@@ -0,0 +1,712 @@
+# Hey Emacs, this is a -*- makefile -*-
+#----------------------------------------------------------------------------
+# WinAVR Makefile Template written by Eric B. Weddington, Jörg Wunsch, et al.
+#  >> Modified for use with the LUFA project. <<
+#
+# Released to the Public Domain
+#
+# Additional material for this makefile was written by:
+# Peter Fleury
+# Tim Henigan
+# Colin O'Flynn
+# Reiner Patommel
+# Markus Pfaff
+# Sander Pool
+# Frederik Rouleau
+# Carlos Lamas
+# Dean Camera
+# Opendous Inc.
+# Denver Gingerich
+#
+#----------------------------------------------------------------------------
+# On command line:
+#
+# make all = Make software.
+#
+# make clean = Clean out built project files.
+#
+# make coff = Convert ELF to AVR COFF.
+#
+# make extcoff = Convert ELF to AVR Extended COFF.
+#
+# make program = Download the hex file to the device, using avrdude.
+#                Please customize the avrdude settings below first!
+#
+# make dfu = Download the hex file to the device, using dfu-programmer (must
+#            have dfu-programmer installed).
+#
+# make flip = Download the hex file to the device, using Atmel FLIP (must
+#             have Atmel FLIP installed).
+#
+# make dfu-ee = Download the eeprom file to the device, using dfu-programmer
+#               (must have dfu-programmer installed).
+#
+# make flip-ee = Download the eeprom file to the device, using Atmel FLIP
+#                (must have Atmel FLIP installed).
+#
+# make doxygen = Generate DoxyGen documentation for the project (must have
+#                DoxyGen installed)
+#
+# make debug = Start either simulavr or avarice as specified for debugging, 
+#              with avr-gdb or avr-insight as the front end for debugging.
+#
+# make filename.s = Just compile filename.c into the assembler code only.
+#
+# make filename.i = Create a preprocessed source file for use in submitting
+#                   bug reports to the GCC project.
+#
+# To rebuild project do "make clean" then "make all".
+#----------------------------------------------------------------------------
+
+
+# MCU name
+MCU = at90usb1287
+
+
+# Target board (see library BoardTypes.h documentation, USER or blank for projects not requiring
+# LUFA board drivers). If USER is selected, put custom board drivers in a directory called 
+# "Board" inside the application directory.
+BOARD  = USBKEY
+
+
+# Processor frequency.
+#     This will define a symbol, F_CPU, in all source code files equal to the 
+#     processor frequency. You can then use this symbol in your source code to 
+#     calculate timings. Do NOT tack on a 'UL' at the end, this will be done
+#     automatically to create a 32-bit value in your source code.
+#     Typical values are:
+#         F_CPU =  1000000
+#         F_CPU =  1843200
+#         F_CPU =  2000000
+#         F_CPU =  3686400
+#         F_CPU =  4000000
+#         F_CPU =  7372800
+#         F_CPU =  8000000
+#         F_CPU = 11059200
+#         F_CPU = 14745600
+#         F_CPU = 16000000
+#         F_CPU = 18432000
+#         F_CPU = 20000000
+F_CPU = 16000000
+
+
+# Output format. (can be srec, ihex, binary)
+FORMAT = ihex
+
+
+# Target file name (without extension).
+TARGET = Magstripe
+
+
+# Object files directory
+#     To put object files in current directory, use a dot (.), do NOT make
+#     this an empty or blank macro!
+OBJDIR = .
+
+
+# List C source files here. (C dependencies are automatically generated.)
+SRC = $(TARGET).c                                          \
+         Descriptors.c                                        \
+         CircularBitBuffer.c                                  \
+         ../../LUFA/Scheduler/Scheduler.c                     \
+         ../../LUFA/Drivers/USB/LowLevel/LowLevel.c           \
+         ../../LUFA/Drivers/USB/LowLevel/Endpoint.c           \
+         ../../LUFA/Drivers/USB/LowLevel/DevChapter9.c        \
+         ../../LUFA/Drivers/USB/HighLevel/USBTask.c           \
+         ../../LUFA/Drivers/USB/HighLevel/USBInterrupt.c      \
+         ../../LUFA/Drivers/USB/HighLevel/Events.c            \
+         ../../LUFA/Drivers/USB/HighLevel/StdDescriptors.c    \
+         
+# List C++ source files here. (C dependencies are automatically generated.)
+CPPSRC = 
+
+
+# List Assembler source files here.
+#     Make them always end in a capital .S.  Files ending in a lowercase .s
+#     will not be considered source files but generated files (assembler
+#     output from the compiler), and will be deleted upon "make clean"!
+#     Even though the DOS/Win* filesystem matches both .s and .S the same,
+#     it will preserve the spelling of the filenames, and gcc itself does
+#     care about how the name is spelled on its command-line.
+ASRC =
+
+
+# Optimization level, can be [0, 1, 2, 3, s]. 
+#     0 = turn off optimization. s = optimize for size.
+#     (Note: 3 is not always the best optimization level. See avr-libc FAQ.)
+OPT = s
+
+
+# Debugging format.
+#     Native formats for AVR-GCC's -g are dwarf-2 [default] or stabs.
+#     AVR Studio 4.10 requires dwarf-2.
+#     AVR [Extended] COFF format requires stabs, plus an avr-objcopy run.
+DEBUG = dwarf-2
+
+
+# List any extra directories to look for include files here.
+#     Each directory must be seperated by a space.
+#     Use forward slashes for directory separators.
+#     For a directory that has spaces, enclose it in quotes.
+EXTRAINCDIRS = ../../
+
+
+# Compiler flag to set the C Standard level.
+#     c89   = "ANSI" C
+#     gnu89 = c89 plus GCC extensions
+#     c99   = ISO C99 standard (not yet fully implemented)
+#     gnu99 = c99 plus GCC extensions
+CSTANDARD = -std=gnu99
+
+
+# Place -D or -U options here for C sources
+CDEFS  = -DF_CPU=$(F_CPU)UL -DBOARD=BOARD_$(BOARD) -DUSE_NONSTANDARD_DESCRIPTOR_NAMES -DNO_STREAM_CALLBACKS
+CDEFS += -DUSB_DEVICE_ONLY -DUSE_STATIC_OPTIONS="(USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)"
+
+CDEFS += -DMAG_T1_CLOCK="(1 << 0)"
+CDEFS += -DMAG_T1_DATA="(1 << 1)"
+CDEFS += -DMAG_T2_CLOCK="(1 << 2)"
+CDEFS += -DMAG_T2_DATA="(1 << 3)"
+CDEFS += -DMAG_T3_CLOCK="(1 << 4)"
+CDEFS += -DMAG_T3_DATA="(1 << 5)"
+CDEFS += -DMAG_CARDPRESENT="(1 << 6)"
+CDEFS += -DMAG_PIN=PINB
+CDEFS += -DMAG_DDR=DDRB
+CDEFS += -DMAG_PORT=PORTB
+
+# Place -D or -U options here for ASM sources
+ADEFS = -DF_CPU=$(F_CPU)
+
+
+# Place -D or -U options here for C++ sources
+CPPDEFS = -DF_CPU=$(F_CPU)UL
+#CPPDEFS += -D__STDC_LIMIT_MACROS
+#CPPDEFS += -D__STDC_CONSTANT_MACROS
+
+
+
+#---------------- Compiler Options C ----------------
+#  -g*:          generate debugging information
+#  -O*:          optimization level
+#  -f...:        tuning, see GCC manual and avr-libc documentation
+#  -Wall...:     warning level
+#  -Wa,...:      tell GCC to pass this to the assembler.
+#    -adhlns...: create assembler listing
+CFLAGS = -g$(DEBUG)
+CFLAGS += $(CDEFS)
+CFLAGS += -O$(OPT)
+CFLAGS += -funsigned-char
+CFLAGS += -funsigned-bitfields
+CFLAGS += -fpack-struct
+CFLAGS += -fshort-enums
+CFLAGS += -ffunction-sections
+CFLAGS += -finline-limit=20
+CFLAGS += -Wall
+CFLAGS += -Wstrict-prototypes
+CFLAGS += -Wundef
+#CFLAGS += -fno-unit-at-a-time
+#CFLAGS += -Wunreachable-code
+#CFLAGS += -Wsign-compare
+CFLAGS += -Wa,-adhlns=$(<:%.c=$(OBJDIR)/%.lst)
+CFLAGS += $(patsubst %,-I%,$(EXTRAINCDIRS))
+CFLAGS += $(CSTANDARD)
+
+
+#---------------- Compiler Options C++ ----------------
+#  -g*:          generate debugging information
+#  -O*:          optimization level
+#  -f...:        tuning, see GCC manual and avr-libc documentation
+#  -Wall...:     warning level
+#  -Wa,...:      tell GCC to pass this to the assembler.
+#    -adhlns...: create assembler listing
+CPPFLAGS = -g$(DEBUG)
+CPPFLAGS += $(CPPDEFS)
+CPPFLAGS += -O$(OPT)
+CPPFLAGS += -funsigned-char
+CPPFLAGS += -funsigned-bitfields
+CPPFLAGS += -fpack-struct
+CPPFLAGS += -fshort-enums
+CPPFLAGS += -fno-exceptions
+CPPFLAGS += -Wall
+CFLAGS += -Wundef
+#CPPFLAGS += -fno-unit-at-a-time
+#CPPFLAGS += -Wstrict-prototypes
+#CPPFLAGS += -Wunreachable-code
+#CPPFLAGS += -Wsign-compare
+CPPFLAGS += -Wa,-adhlns=$(<:%.cpp=$(OBJDIR)/%.lst)
+CPPFLAGS += $(patsubst %,-I%,$(EXTRAINCDIRS))
+#CPPFLAGS += $(CSTANDARD)
+
+
+#---------------- Assembler Options ----------------
+#  -Wa,...:   tell GCC to pass this to the assembler.
+#  -adhlns:   create listing
+#  -gstabs:   have the assembler create line number information; note that
+#             for use in COFF files, additional information about filenames
+#             and function names needs to be present in the assembler source
+#             files -- see avr-libc docs [FIXME: not yet described there]
+#  -listing-cont-lines: Sets the maximum number of continuation lines of hex 
+#       dump that will be displayed for a given single line of source input.
+ASFLAGS = $(ADEFS) -Wa,-adhlns=$(<:%.S=$(OBJDIR)/%.lst),-gstabs,--listing-cont-lines=100
+
+
+#---------------- Library Options ----------------
+# Minimalistic printf version
+PRINTF_LIB_MIN = -Wl,-u,vfprintf -lprintf_min
+
+# Floating point printf version (requires MATH_LIB = -lm below)
+PRINTF_LIB_FLOAT = -Wl,-u,vfprintf -lprintf_flt
+
+# If this is left blank, then it will use the Standard printf version.
+PRINTF_LIB = 
+#PRINTF_LIB = $(PRINTF_LIB_MIN)
+#PRINTF_LIB = $(PRINTF_LIB_FLOAT)
+
+
+# Minimalistic scanf version
+SCANF_LIB_MIN = -Wl,-u,vfscanf -lscanf_min
+
+# Floating point + %[ scanf version (requires MATH_LIB = -lm below)
+SCANF_LIB_FLOAT = -Wl,-u,vfscanf -lscanf_flt
+
+# If this is left blank, then it will use the Standard scanf version.
+SCANF_LIB = 
+#SCANF_LIB = $(SCANF_LIB_MIN)
+#SCANF_LIB = $(SCANF_LIB_FLOAT)
+
+
+MATH_LIB = -lm
+
+
+# List any extra directories to look for libraries here.
+#     Each directory must be seperated by a space.
+#     Use forward slashes for directory separators.
+#     For a directory that has spaces, enclose it in quotes.
+EXTRALIBDIRS = 
+
+
+
+#---------------- External Memory Options ----------------
+
+# 64 KB of external RAM, starting after internal RAM (ATmega128!),
+# used for variables (.data/.bss) and heap (malloc()).
+#EXTMEMOPTS = -Wl,-Tdata=0x801100,--defsym=__heap_end=0x80ffff
+
+# 64 KB of external RAM, starting after internal RAM (ATmega128!),
+# only used for heap (malloc()).
+#EXTMEMOPTS = -Wl,--section-start,.data=0x801100,--defsym=__heap_end=0x80ffff
+
+EXTMEMOPTS =
+
+
+
+#---------------- Linker Options ----------------
+#  -Wl,...:     tell GCC to pass this to linker.
+#    -Map:      create map file
+#    --cref:    add cross reference to  map file
+LDFLAGS = -Wl,-Map=$(TARGET).map,--cref
+LDFLAGS += -Wl,--relax
+LDFLAGS += -Wl,--gc-sections
+LDFLAGS += $(EXTMEMOPTS)
+LDFLAGS += $(patsubst %,-L%,$(EXTRALIBDIRS))
+LDFLAGS += $(PRINTF_LIB) $(SCANF_LIB) $(MATH_LIB)
+#LDFLAGS += -T linker_script.x
+
+
+
+#---------------- Programming Options (avrdude) ----------------
+
+# Programming hardware: alf avr910 avrisp bascom bsd 
+# dt006 pavr picoweb pony-stk200 sp12 stk200 stk500
+#
+# Type: avrdude -c ?
+# to get a full listing.
+#
+AVRDUDE_PROGRAMMER = jtagmkII
+
+# com1 = serial port. Use lpt1 to connect to parallel port.
+AVRDUDE_PORT = usb
+
+AVRDUDE_WRITE_FLASH = -U flash:w:$(TARGET).hex
+#AVRDUDE_WRITE_EEPROM = -U eeprom:w:$(TARGET).eep
+
+
+# Uncomment the following if you want avrdude's erase cycle counter.
+# Note that this counter needs to be initialized first using -Yn,
+# see avrdude manual.
+#AVRDUDE_ERASE_COUNTER = -y
+
+# Uncomment the following if you do /not/ wish a verification to be
+# performed after programming the device.
+#AVRDUDE_NO_VERIFY = -V
+
+# Increase verbosity level.  Please use this when submitting bug
+# reports about avrdude. See <http://savannah.nongnu.org/projects/avrdude> 
+# to submit bug reports.
+#AVRDUDE_VERBOSE = -v -v
+
+AVRDUDE_FLAGS = -p $(MCU) -P $(AVRDUDE_PORT) -c $(AVRDUDE_PROGRAMMER)
+AVRDUDE_FLAGS += $(AVRDUDE_NO_VERIFY)
+AVRDUDE_FLAGS += $(AVRDUDE_VERBOSE)
+AVRDUDE_FLAGS += $(AVRDUDE_ERASE_COUNTER)
+
+
+
+#---------------- Debugging Options ----------------
+
+# For simulavr only - target MCU frequency.
+DEBUG_MFREQ = $(F_CPU)
+
+# Set the DEBUG_UI to either gdb or insight.
+# DEBUG_UI = gdb
+DEBUG_UI = insight
+
+# Set the debugging back-end to either avarice, simulavr.
+DEBUG_BACKEND = avarice
+#DEBUG_BACKEND = simulavr
+
+# GDB Init Filename.
+GDBINIT_FILE = __avr_gdbinit
+
+# When using avarice settings for the JTAG
+JTAG_DEV = /dev/com1
+
+# Debugging port used to communicate between GDB / avarice / simulavr.
+DEBUG_PORT = 4242
+
+# Debugging host used to communicate between GDB / avarice / simulavr, normally
+#     just set to localhost unless doing some sort of crazy debugging when 
+#     avarice is running on a different computer.
+DEBUG_HOST = localhost
+
+
+
+#============================================================================
+
+
+# Define programs and commands.
+SHELL = sh
+CC = avr-gcc
+OBJCOPY = avr-objcopy
+OBJDUMP = avr-objdump
+SIZE = avr-size
+AR = avr-ar rcs
+NM = avr-nm
+AVRDUDE = avrdude
+REMOVE = rm -f
+REMOVEDIR = rm -rf
+COPY = cp
+WINSHELL = cmd
+
+# Define Messages
+# English
+MSG_ERRORS_NONE = Errors: none
+MSG_BEGIN = -------- begin --------
+MSG_END = --------  end  --------
+MSG_SIZE_BEFORE = Size before: 
+MSG_SIZE_AFTER = Size after:
+MSG_COFF = Converting to AVR COFF:
+MSG_EXTENDED_COFF = Converting to AVR Extended COFF:
+MSG_FLASH = Creating load file for Flash:
+MSG_EEPROM = Creating load file for EEPROM:
+MSG_EXTENDED_LISTING = Creating Extended Listing:
+MSG_SYMBOL_TABLE = Creating Symbol Table:
+MSG_LINKING = Linking:
+MSG_COMPILING = Compiling C:
+MSG_COMPILING_CPP = Compiling C++:
+MSG_ASSEMBLING = Assembling:
+MSG_CLEANING = Cleaning project:
+MSG_CREATING_LIBRARY = Creating library:
+
+
+
+
+# Define all object files.
+OBJ = $(SRC:%.c=$(OBJDIR)/%.o) $(CPPSRC:%.cpp=$(OBJDIR)/%.o) $(ASRC:%.S=$(OBJDIR)/%.o) 
+
+# Define all listing files.
+LST = $(SRC:%.c=$(OBJDIR)/%.lst) $(CPPSRC:%.cpp=$(OBJDIR)/%.lst) $(ASRC:%.S=$(OBJDIR)/%.lst) 
+
+
+# Compiler flags to generate dependency files.
+GENDEPFLAGS = -MMD -MP -MF .dep/$(@F).d
+
+
+# Combine all necessary flags and optional flags.
+# Add target processor to flags.
+ALL_CFLAGS = -mmcu=$(MCU) -I. $(CFLAGS) $(GENDEPFLAGS)
+ALL_CPPFLAGS = -mmcu=$(MCU) -I. -x c++ $(CPPFLAGS) $(GENDEPFLAGS)
+ALL_ASFLAGS = -mmcu=$(MCU) -I. -x assembler-with-cpp $(ASFLAGS)
+
+
+
+
+
+# Default target.
+all: begin gccversion sizebefore build checkhooks checklibmode sizeafter end
+
+# Change the build target to build a HEX file or a library.
+build: elf hex eep lss sym
+#build: lib
+
+
+elf: $(TARGET).elf
+hex: $(TARGET).hex
+eep: $(TARGET).eep
+lss: $(TARGET).lss
+sym: $(TARGET).sym
+LIBNAME=lib$(TARGET).a
+lib: $(LIBNAME)
+
+
+
+# Eye candy.
+# AVR Studio 3.x does not check make's exit code but relies on
+# the following magic strings to be generated by the compile job.
+begin:
+       @echo
+       @echo $(MSG_BEGIN)
+
+end:
+       @echo $(MSG_END)
+       @echo
+
+
+# Display size of file.
+HEXSIZE = $(SIZE) --target=$(FORMAT) $(TARGET).hex
+ELFSIZE = $(SIZE) $(MCU_FLAG) $(FORMAT_FLAG) $(TARGET).elf
+MCU_FLAG = $(shell $(SIZE) --help | grep -- --mcu > /dev/null && echo --mcu=$(MCU) )
+FORMAT_FLAG = $(shell $(SIZE) --help | grep -- --format=.*avr > /dev/null && echo --format=avr )
+
+sizebefore:
+       @if test -f $(TARGET).elf; then echo; echo $(MSG_SIZE_BEFORE); $(ELFSIZE); \
+       2>/dev/null; echo; fi
+
+sizeafter:
+       @if test -f $(TARGET).elf; then echo; echo $(MSG_SIZE_AFTER); $(ELFSIZE); \
+       2>/dev/null; echo; fi
+
+checkhooks: build
+       @echo
+       @echo ------- Unhooked LUFA Events -------
+       @$(shell) (grep -s '^Event.*LUFA/.*\\.o' $(TARGET).map | \
+                  cut -d' ' -f1 | cut -d'_' -f2- | grep ".*") || \
+                          echo "(None)"
+       @echo ----- End Unhooked LUFA Events -----
+
+checklibmode:
+       @echo
+       @echo ----------- Library Mode -----------
+       @$(shell) ($(CC) $(ALL_CFLAGS) -E -dM - < /dev/null \
+                 | grep 'USB_\(DEVICE\|HOST\)_ONLY' | cut -d' ' -f2 | grep ".*") \
+                 || echo "No specific mode (both device and host mode allowable)."
+       @echo ------------------------------------
+
+# Display compiler version information.
+gccversion : 
+       @$(CC) --version
+
+
+
+# Program the device.  
+program: $(TARGET).hex $(TARGET).eep
+       $(AVRDUDE) $(AVRDUDE_FLAGS) $(AVRDUDE_WRITE_FLASH) $(AVRDUDE_WRITE_EEPROM)
+
+flip: $(TARGET).hex
+       batchisp -hardware usb -device $(MCU) -operation erase f
+       batchisp -hardware usb -device $(MCU) -operation loadbuffer $(TARGET).hex program
+       batchisp -hardware usb -device $(MCU) -operation start reset 0
+
+dfu: $(TARGET).hex
+       dfu-programmer $(MCU) erase
+       dfu-programmer $(MCU) flash --debug 1 $(TARGET).hex
+       dfu-programmer $(MCU) reset
+
+flip-ee: $(TARGET).hex $(TARGET).eep
+       copy $(TARGET).eep $(TARGET)eep.hex
+       batchisp -hardware usb -device $(MCU) -operation memory EEPROM erase
+       batchisp -hardware usb -device $(MCU) -operation memory EEPROM loadbuffer $(TARGET)eep.hex program
+       batchisp -hardware usb -device $(MCU) -operation start reset 0
+
+dfu-ee: $(TARGET).hex $(TARGET).eep
+       dfu-programmer $(MCU) erase
+       dfu-programmer $(MCU) eeprom --debug 1 $(TARGET).eep
+       dfu-programmer $(MCU) reset
+
+# Generate avr-gdb config/init file which does the following:
+#     define the reset signal, load the target file, connect to target, and set 
+#     a breakpoint at main().
+gdb-config: 
+       @$(REMOVE) $(GDBINIT_FILE)
+       @echo define reset >> $(GDBINIT_FILE)
+       @echo SIGNAL SIGHUP >> $(GDBINIT_FILE)
+       @echo end >> $(GDBINIT_FILE)
+       @echo file $(TARGET).elf >> $(GDBINIT_FILE)
+       @echo target remote $(DEBUG_HOST):$(DEBUG_PORT)  >> $(GDBINIT_FILE)
+ifeq ($(DEBUG_BACKEND),simulavr)
+       @echo load  >> $(GDBINIT_FILE)
+endif
+       @echo break main >> $(GDBINIT_FILE)
+
+debug: gdb-config $(TARGET).elf
+ifeq ($(DEBUG_BACKEND), avarice)
+       @echo Starting AVaRICE - Press enter when "waiting to connect" message displays.
+       @$(WINSHELL) /c start avarice --jtag $(JTAG_DEV) --erase --program --file \
+       $(TARGET).elf $(DEBUG_HOST):$(DEBUG_PORT)
+       @$(WINSHELL) /c pause
+
+else
+       @$(WINSHELL) /c start simulavr --gdbserver --device $(MCU) --clock-freq \
+       $(DEBUG_MFREQ) --port $(DEBUG_PORT)
+endif
+       @$(WINSHELL) /c start avr-$(DEBUG_UI) --command=$(GDBINIT_FILE)
+
+
+
+
+# Convert ELF to COFF for use in debugging / simulating in AVR Studio or VMLAB.
+COFFCONVERT = $(OBJCOPY) --debugging
+COFFCONVERT += --change-section-address .data-0x800000
+COFFCONVERT += --change-section-address .bss-0x800000
+COFFCONVERT += --change-section-address .noinit-0x800000
+COFFCONVERT += --change-section-address .eeprom-0x810000
+
+
+
+coff: $(TARGET).elf
+       @echo
+       @echo $(MSG_COFF) $(TARGET).cof
+       $(COFFCONVERT) -O coff-avr $< $(TARGET).cof
+
+
+extcoff: $(TARGET).elf
+       @echo
+       @echo $(MSG_EXTENDED_COFF) $(TARGET).cof
+       $(COFFCONVERT) -O coff-ext-avr $< $(TARGET).cof
+
+
+
+# Create final output files (.hex, .eep) from ELF output file.
+%.hex: %.elf
+       @echo
+       @echo $(MSG_FLASH) $@
+       $(OBJCOPY) -O $(FORMAT) -R .eeprom $< $@
+
+%.eep: %.elf
+       @echo
+       @echo $(MSG_EEPROM) $@
+       -$(OBJCOPY) -j .eeprom --set-section-flags=.eeprom="alloc,load" \
+       --change-section-lma .eeprom=0 --no-change-warnings -O $(FORMAT) $< $@ || exit 0
+
+# Create extended listing file from ELF output file.
+%.lss: %.elf
+       @echo
+       @echo $(MSG_EXTENDED_LISTING) $@
+       $(OBJDUMP) -h -z -S $< > $@
+
+# Create a symbol table from ELF output file.
+%.sym: %.elf
+       @echo
+       @echo $(MSG_SYMBOL_TABLE) $@
+       $(NM) -n $< > $@
+
+
+
+# Create library from object files.
+.SECONDARY : $(TARGET).a
+.PRECIOUS : $(OBJ)
+%.a: $(OBJ)
+       @echo
+       @echo $(MSG_CREATING_LIBRARY) $@
+       $(AR) $@ $(OBJ)
+
+
+# Link: create ELF output file from object files.
+.SECONDARY : $(TARGET).elf
+.PRECIOUS : $(OBJ)
+%.elf: $(OBJ)
+       @echo
+       @echo $(MSG_LINKING) $@
+       $(CC) $(ALL_CFLAGS) $^ --output $@ $(LDFLAGS)
+
+
+# Compile: create object files from C source files.
+$(OBJDIR)/%.o : %.c
+       @echo
+       @echo $(MSG_COMPILING) $<
+       $(CC) -c $(ALL_CFLAGS) $< -o $@ 
+
+
+# Compile: create object files from C++ source files.
+$(OBJDIR)/%.o : %.cpp
+       @echo
+       @echo $(MSG_COMPILING_CPP) $<
+       $(CC) -c $(ALL_CPPFLAGS) $< -o $@ 
+
+
+# Compile: create assembler files from C source files.
+%.s : %.c
+       $(CC) -S $(ALL_CFLAGS) $< -o $@
+
+
+# Compile: create assembler files from C++ source files.
+%.s : %.cpp
+       $(CC) -S $(ALL_CPPFLAGS) $< -o $@
+
+
+# Assemble: create object files from assembler source files.
+$(OBJDIR)/%.o : %.S
+       @echo
+       @echo $(MSG_ASSEMBLING) $<
+       $(CC) -c $(ALL_ASFLAGS) $< -o $@
+
+
+# Create preprocessed source for use in sending a bug report.
+%.i : %.c
+       $(CC) -E -mmcu=$(MCU) -I. $(CFLAGS) $< -o $@ 
+       
+
+# Target: clean project.
+clean: begin clean_list clean_binary end
+
+clean_binary:
+       $(REMOVE) $(TARGET).hex
+
+clean_list:
+       @echo $(MSG_CLEANING)
+       $(REMOVE) $(TARGET).eep
+       $(REMOVE) $(TARGET).cof
+       $(REMOVE) $(TARGET).elf
+       $(REMOVE) $(TARGET).map
+       $(REMOVE) $(TARGET).sym
+       $(REMOVE) $(TARGET).lss
+       $(REMOVE) $(SRC:%.c=$(OBJDIR)/%.o)
+       $(REMOVE) $(SRC:%.c=$(OBJDIR)/%.lst)
+       $(REMOVE) $(SRC:.c=.s)
+       $(REMOVE) $(SRC:.c=.d)
+       $(REMOVE) $(SRC:.c=.i)
+       $(REMOVEDIR) .dep
+
+
+doxygen:
+       @echo Generating Project Documentation...
+       @doxygen Doxygen.conf
+       @echo Documentation Generation Complete.
+
+clean_doxygen:
+       rm -rf Documentation
+
+# Create object files directory
+$(shell mkdir $(OBJDIR) 2>/dev/null)
+
+
+# Include the dependency files.
+-include $(shell mkdir .dep 2>/dev/null) $(wildcard .dep/*)
+
+
+# Listing of phony targets.
+.PHONY : all checkhooks checklibmode begin  \
+finish end sizebefore sizeafter gccversion  \
+build elf hex eep lss sym coff extcoff      \
+clean clean_list clean_binary program debug \
+gdb-config doxygen dfu flip
diff --git a/Projects/makefile b/Projects/makefile
new file mode 100644 (file)
index 0000000..50851a3
--- /dev/null
@@ -0,0 +1,25 @@
+#
+#             LUFA Library
+#     Copyright (C) Dean Camera, 2009.
+#              
+#  dean [at] fourwalledcubicle [dot] com
+#      www.fourwalledcubicle.com
+#
+
+# Makefile to build all the LUFA Projects. Call with "make all" to
+# rebuild all projects.
+
+# Projects are pre-cleaned before each one is built, to ensure any
+# custom LUFA library build options are reflected in the compiled
+# code.
+
+all:
+       make -C Magstripe clean
+       make -C Magstripe all
+       
+       make -C AVRISP_Programmer clean
+       make -C AVRISP_Programmer all
+
+%:
+       make -C Magstripe $@
+       make -C AVRISP_Programmer $@