Partial Commit: Move AVRISP project out of the Projects\Incomplete directory.
[pub/lufa.git] / Projects / AVRISP / Lib / V2Protocol.h
diff --git a/Projects/AVRISP/Lib/V2Protocol.h b/Projects/AVRISP/Lib/V2Protocol.h
new file mode 100644 (file)
index 0000000..5c8bd75
--- /dev/null
@@ -0,0 +1,84 @@
+/*\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 V2Protocol.c.\r
+ */\r
+\r
+#ifndef _V2_PROTOCOL_
+#define _V2_PROTOCOL_
+
+       /* Includes: */
+               #include <LUFA/Drivers/USB/USB.h>
+               #include <LUFA/Drivers/Peripheral/SPI.h>\r
+               \r
+               #include "../Descriptors.h"
+               #include "V2ProtocolConstants.h"\r
+               #include "V2ProtocolParams.h"
+               #include "V2ProtocolTarget.h"\r
+
+       /* Macros: */\r
+               /** Programmer ID string, returned to the host during the CMD_SIGN_ON command processing */
+               #define PROGRAMMER_ID                   "AVRISP_MK2"\r
+               \r
+               /** Mask for the reading or writing of the high byte in a FLASH word when issuing a low-level programming command */\r
+               #define READ_WRITE_HIGH_BYTE_MASK       (1 << 3)\r
+\r
+               #define PROG_MODE_PAGED_WRITES_MASK     (1 << 0)\r
+               #define PROG_MODE_WORD_TIMEDELAY_MASK   (1 << 1)\r
+               #define PROG_MODE_WORD_VALUE_MASK       (1 << 2)\r
+               #define PROG_MODE_WORD_READYBUSY_MASK   (1 << 3)\r
+               #define PROG_MODE_PAGED_TIMEDELAY_MASK  (1 << 4)\r
+               #define PROG_MODE_PAGED_VALUE_MASK      (1 << 5)\r
+               #define PROG_MODE_PAGED_READYBUSY_MASK  (1 << 6)\r
+               #define PROG_MODE_COMMIT_PAGE_MASK      (1 << 7)\r
+
+       /* Function Prototypes: */\r
+               void V2Protocol_ProcessCommand(void);\r
+               \r
+               #if defined(INCLUDE_FROM_V2PROTOCOL_C)\r
+                       static void V2Protocol_Command_Unknown(uint8_t V2Command);\r
+                       static void V2Protocol_Command_SignOn(void);\r
+                       static void V2Protocol_Command_GetSetParam(uint8_t V2Command);\r
+                       static void V2Protocol_Command_LoadAddress(void);\r
+                       static void V2Protocol_Command_ResetProtection(void);\r
+                       static void V2Protocol_Command_EnterISPMode(void);\r
+                       static void V2Protocol_Command_LeaveISPMode(void);\r
+                       static void V2Protocol_Command_ProgramMemory(uint8_t V2Command);\r
+                       static void V2Protocol_Command_ReadMemory(uint8_t V2Command);\r
+                       static void V2Protocol_Command_ChipErase(void);\r
+                       static void V2Protocol_Command_ReadFuseLockSigOSCCAL(uint8_t V2Command);\r
+                       static void V2Protocol_Command_WriteFuseLock(uint8_t V2Command);\r
+                       static void V2Protocol_Command_SPIMulti(void);\r
+               #endif
+
+#endif
+