Make seperate ISP, PDI and TPI folders in the AVRISP project Lib subdirectory to...
[pub/lufa.git] / Projects / AVRISP / Lib / ISP / ISPProtocol.h
diff --git a/Projects/AVRISP/Lib/ISP/ISPProtocol.h b/Projects/AVRISP/Lib/ISP/ISPProtocol.h
new file mode 100644 (file)
index 0000000..85a669a
--- /dev/null
@@ -0,0 +1,97 @@
+/*\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 ISPProtocol.c.\r
+ */\r
+\r
+#ifndef _ISP_PROTOCOL_\r
+#define _ISP_PROTOCOL_\r
+\r
+       /* Includes: */\r
+               #include <avr/io.h>\r
+               \r
+               #include "V2Protocol.h"\r
+               \r
+       /* Preprocessor Checks: */\r
+               #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))\r
+                       #undef ENABLE_ISP_PROTOCOL\r
+                       #undef ENABLE_TPI_PROTOCOL\r
+                       \r
+                       #if !defined(ENABLE_PDI_PROTOCOL)\r
+                               #define ENABLE_PDI_PROTOCOL\r
+                       #endif\r
+               #endif\r
+\r
+       /* Macros: */\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
+\r
+       /* Inline Functions: */\r
+               /** Blocking delay for a given number of milliseconds, via a hardware timer.\r
+                *\r
+                *  \param[in] DelayMS  Number of milliseconds to delay for\r
+                */\r
+               static inline void ISPProtocol_DelayMS(uint8_t DelayMS)\r
+               {\r
+                       TCNT0 = 0;\r
+                       TIFR0 = (1 << OCF1A);\r
+\r
+                       while (DelayMS)\r
+                       {\r
+                               if (TIFR0 & (1 << OCF1A))\r
+                               {\r
+                                       TIFR0 = (1 << OCF1A);\r
+                                       DelayMS--;\r
+                               }\r
+                       }\r
+               }\r
+\r
+       /* Function Prototypes: */\r
+               void ISPProtocol_EnterISPMode(void);\r
+               void ISPProtocol_LeaveISPMode(void);\r
+               void ISPProtocol_ProgramMemory(const uint8_t V2Command);\r
+               void ISPProtocol_ReadMemory(const uint8_t V2Command);\r
+               void ISPProtocol_ChipErase(void);\r
+               void ISPProtocol_ReadFuseLockSigOSCCAL(const uint8_t V2Command);\r
+               void ISPProtocol_WriteFuseLock(const uint8_t V2Command);\r
+               void ISPProtocol_SPIMulti(void);\r
+\r
+#endif\r