Partial Commit: Move AVRISP project out of the Projects\Incomplete directory.
[pub/lufa.git] / Projects / AVRISP / Lib / V2ProtocolTarget.c
diff --git a/Projects/AVRISP/Lib/V2ProtocolTarget.c b/Projects/AVRISP/Lib/V2ProtocolTarget.c
new file mode 100644 (file)
index 0000000..a39c5e9
--- /dev/null
@@ -0,0 +1,183 @@
+/*\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
+ *  Target-related functions for the V2 Protocol decoder.\r
+ */\r
+\r
+#include "V2ProtocolTarget.h"\r
+\r
+/** Current memory address for FLASH/EEPROM memory read/write commands */\r
+uint32_t CurrentAddress;\r
+\r
+/** Converts the given AVR Studio SCK duration parameter (set by a SET PARAM command from the host) to the nearest\r
+ *  possible SPI clock prescaler mask for passing to the SPI_Init() routine.\r
+ *\r
+ *  \return Nearest SPI prescaler mask for the given SCK frequency\r
+ */\r
+uint8_t V2Protocol_GetSPIPrescalerMask(void)\r
+{\r
+       static const uint8_t SPIMaskFromSCKDuration[TOTAL_PROGRAMMING_SPEEDS] =\r
+       {\r
+       #if (F_CPU == 8000000)\r
+               SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   8MHz SPI, Actual =   4MHz SPI\r
+               SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   4MHz SPI, Actual =   4MHz SPI\r
+               SPI_SPEED_FCPU_DIV_4,    // AVRStudio =   2MHz SPI, Actual =   2MHz SPI\r
+               SPI_SPEED_FCPU_DIV_8,    // AVRStudio =   1MHz SPI, Actual =   1MHz SPI\r
+               SPI_SPEED_FCPU_DIV_16,   // AVRStudio = 500KHz SPI, Actual = 500KHz SPI\r
+               SPI_SPEED_FCPU_DIV_32,   // AVRStudio = 250KHz SPI, Actual = 250KHz SPI\r
+               SPI_SPEED_FCPU_DIV_64    // AVRStudio = 125KHz SPI, Actual = 125KHz SPI \r
+       #if (F_CPU == 16000000)\r
+               SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   8MHz SPI, Actual =   8MHz SPI\r
+               SPI_SPEED_FCPU_DIV_4,    // AVRStudio =   4MHz SPI, Actual =   4MHz SPI\r
+               SPI_SPEED_FCPU_DIV_8,    // AVRStudio =   2MHz SPI, Actual =   2MHz SPI\r
+               SPI_SPEED_FCPU_DIV_16,   // AVRStudio =   1MHz SPI, Actual =   1MHz SPI\r
+               SPI_SPEED_FCPU_DIV_32,   // AVRStudio = 500KHz SPI, Actual = 500KHz SPI\r
+               SPI_SPEED_FCPU_DIV_64,   // AVRStudio = 250KHz SPI, Actual = 250KHz SPI         \r
+               SPI_SPEED_FCPU_DIV_128   // AVRStudio = 125KHz SPI, Actual = 125KHz SPI\r
+       #else\r
+               #error No SPI prescaler masks for chosen F_CPU speed.\r
+       #endif\r
+       };\r
+\r
+       uint8_t SCKDuration = V2Params_GetParameterValue(PARAM_SCK_DURATION);\r
+\r
+       if (SCKDuration >= sizeof(SPIMaskFromSCKDuration))\r
+         SCKDuration = (sizeof(SPIMaskFromSCKDuration) - 1);\r
+         \r
+       return SPIMaskFromSCKDuration[SCKDuration];\r
+}\r
+\r
+/** Asserts or deasserts the target's reset line, using the correct polarity as set by the host using a SET PARAM command.\r
+ *  When not asserted, the line is tristated so as not to intefere with normal device operation.\r
+ *\r
+ *  \param ResetTarget Boolean true when the target should be held in reset, false otherwise\r
+ */\r
+void V2Protocol_ChangeTargetResetLine(bool ResetTarget)\r
+{\r
+       if (ResetTarget)\r
+       {\r
+               RESET_LINE_DDR  |= RESET_LINE_MASK;\r
+               \r
+               if (!(V2Params_GetParameterValue(PARAM_RESET_POLARITY)))\r
+                 RESET_LINE_PORT |= RESET_LINE_MASK;\r
+       }\r
+       else\r
+       {\r
+               RESET_LINE_PORT &= ~RESET_LINE_MASK;\r
+               RESET_LINE_DDR  &= ~RESET_LINE_MASK;\r
+       }\r
+}\r
+\r
+/** Waits until the last issued target memory programming command has completed, via the check mode given and using\r
+ *  the given parameters.\r
+ *\r
+ *  \param ProgrammingMode  Programming mode used and completion check to use, a mask of PROG_MODE_* constants\r
+ *  \param PollAddress  Memory address to poll for completion if polling check mode used\r
+ *  \param PollValue  Poll value to check against if polling check mode used\r
+ *  \param DelayMS  Milliseconds to delay before returning if delay check mode used\r
+ *  \param ReadMemCommand  Device low-level READ MEMORY command to send if value check mode used\r
+ *\r
+ *  \return V2 Protocol status \ref STATUS_CMD_OK if the no timeout occurred, \ref STATUS_RDY_BSY_TOUT or\r
+ *          \ref STATUS_CMD_TOUT otherwise\r
+ */\r
+uint8_t V2Protocol_WaitForProgComplete(uint8_t ProgrammingMode, uint16_t PollAddress, uint8_t PollValue,\r
+                                       uint8_t DelayMS, uint8_t ReadMemCommand)\r
+{\r
+       uint8_t ProgrammingStatus = STATUS_CMD_OK;\r
+\r
+       /* Determine method of Programming Complete check */\r
+       switch (ProgrammingMode & ~(PROG_MODE_PAGED_WRITES_MASK | PROG_MODE_COMMIT_PAGE_MASK))\r
+       {\r
+               case PROG_MODE_WORD_TIMEDELAY_MASK:\r
+               case PROG_MODE_PAGED_TIMEDELAY_MASK:\r
+                       V2Protocol_DelayMS(DelayMS);\r
+                       break;\r
+               case PROG_MODE_WORD_VALUE_MASK:\r
+               case PROG_MODE_PAGED_VALUE_MASK:\r
+                       TCNT0 = 0;\r
+\r
+                       do\r
+                       {\r
+                               SPI_SendByte(ReadMemCommand);\r
+                               SPI_SendByte(PollAddress >> 8);\r
+                               SPI_SendByte(PollAddress & 0xFF);                               \r
+                       }\r
+                       while ((SPI_TransferByte(0x00) != PollValue) && (TCNT0 < TARGET_BUSY_TIMEOUT_MS));\r
+\r
+                       if (TCNT0 >= TARGET_BUSY_TIMEOUT_MS)\r
+                        ProgrammingStatus = STATUS_CMD_TOUT;\r
+                       \r
+                       break;          \r
+               case PROG_MODE_WORD_READYBUSY_MASK:\r
+               case PROG_MODE_PAGED_READYBUSY_MASK:\r
+                       ProgrammingStatus = V2Protocol_WaitWhileTargetBusy();\r
+                       break;\r
+       }\r
+\r
+       return ProgrammingStatus;\r
+}\r
+\r
+/** Waits until the target has completed the last operation, by continuously polling the device's\r
+ *  BUSY flag until it is cleared, or until the \ref TARGET_BUSY_TIMEOUT_MS timeout period has expired.\r
+ *\r
+ *  \return V2 Protocol status \ref STATUS_CMD_OK if the no timeout occurred, \ref STATUS_RDY_BSY_TOUT otherwise\r
+ */\r
+uint8_t V2Protocol_WaitWhileTargetBusy(void)\r
+{\r
+       TCNT0 = 0;\r
+       \r
+       do\r
+       {\r
+               SPI_SendByte(0xF0);\r
+               SPI_SendByte(0x00);\r
+\r
+               SPI_SendByte(0x00);\r
+       }\r
+       while ((SPI_ReceiveByte() & 0x01) && (TCNT0 < TARGET_BUSY_TIMEOUT_MS));\r
+\r
+       if (TCNT0 >= TARGET_BUSY_TIMEOUT_MS)\r
+         return STATUS_RDY_BSY_TOUT;\r
+       else\r
+         return STATUS_CMD_OK;\r
+}\r
+\r
+/** Sends a low-level LOAD EXTENDED ADDRESS command to the target, for addressing of memory beyond the\r
+ *  64KB boundary. This sends the command with the correct address as indicated by the current address\r
+ *  pointer variable set by the host when a SET ADDRESS command is issued.\r
+ */\r
+void V2Protocol_LoadExtendedAddress(void)\r
+{\r
+       SPI_SendByte(0x4D);\r
+       SPI_SendByte(0x00);\r
+       SPI_SendByte((CurrentAddress & 0x00FF0000) >> 16);\r
+       SPI_SendByte(0x00);     \r
+}\r