Factor out all the ISP related code into a seperate ISPProtocol set of files in the...
authorDean Camera <dean@fourwalledcubicle.com>
Wed, 2 Dec 2009 12:02:01 +0000 (12:02 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Wed, 2 Dec 2009 12:02:01 +0000 (12:02 +0000)
Projects/AVRISP/Lib/ISPProtocol.c [new file with mode: 0644]
Projects/AVRISP/Lib/ISPProtocol.h [new file with mode: 0644]
Projects/AVRISP/Lib/V2Protocol.c
Projects/AVRISP/Lib/V2Protocol.h
Projects/AVRISP/Lib/V2ProtocolConstants.h
Projects/AVRISP/Lib/V2ProtocolParams.c
Projects/AVRISP/Lib/V2ProtocolParams.h
Projects/AVRISP/Lib/V2ProtocolTarget.c
Projects/AVRISP/Lib/V2ProtocolTarget.h
Projects/AVRISP/makefile

diff --git a/Projects/AVRISP/Lib/ISPProtocol.c b/Projects/AVRISP/Lib/ISPProtocol.c
new file mode 100644 (file)
index 0000000..bfd917a
--- /dev/null
@@ -0,0 +1,467 @@
+/*\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
+ *  ISP Protocol handler, to process V2 Protocol wrapped ISP commands used in Atmel programmer devices.\r
+ */\r
+\r
+#include "ISPProtocol.h"\r
+\r
+/** Handler for the CMD_ENTER_PROGMODE_ISP command, which attempts to enter programming mode on\r
+ *  the attached device, returning success or failure back to the host.\r
+ */\r
+void ISPProtocol_EnterISPMode(void)\r
+{\r
+       struct\r
+       {\r
+               uint8_t TimeoutMS;\r
+               uint8_t PinStabDelayMS;\r
+               uint8_t ExecutionDelayMS;\r
+               uint8_t SynchLoops;\r
+               uint8_t ByteDelay;\r
+               uint8_t PollValue;\r
+               uint8_t PollIndex;\r
+               uint8_t EnterProgBytes[4];\r
+       } Enter_ISP_Params;\r
+       \r
+       Endpoint_Read_Stream_LE(&Enter_ISP_Params, sizeof(Enter_ISP_Params));\r
+\r
+       Endpoint_ClearOUT();\r
+       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
+\r
+       uint8_t ResponseStatus = STATUS_CMD_FAILED;\r
+       \r
+       CurrentAddress = 0;\r
+\r
+       V2Protocol_DelayMS(Enter_ISP_Params.ExecutionDelayMS);    \r
+       SPI_Init(ISPTarget_GetSPIPrescalerMask() | SPI_SCK_LEAD_RISING | SPI_SAMPLE_LEADING | SPI_MODE_MASTER);\r
+               \r
+       while (Enter_ISP_Params.SynchLoops-- && (ResponseStatus == STATUS_CMD_FAILED))\r
+       {\r
+               uint8_t ResponseBytes[4];\r
+\r
+               ISPTarget_ChangeTargetResetLine(true);\r
+               V2Protocol_DelayMS(Enter_ISP_Params.PinStabDelayMS);\r
+\r
+               for (uint8_t RByte = 0; RByte < sizeof(ResponseBytes); RByte++)\r
+               {\r
+                       V2Protocol_DelayMS(Enter_ISP_Params.ByteDelay);\r
+                       ResponseBytes[RByte] = SPI_TransferByte(Enter_ISP_Params.EnterProgBytes[RByte]);\r
+               }\r
+               \r
+               /* Check if polling disabled, or if the polled value matches the expected value */\r
+               if (!(Enter_ISP_Params.PollIndex) || (ResponseBytes[Enter_ISP_Params.PollIndex - 1] == Enter_ISP_Params.PollValue))\r
+               {\r
+                       ResponseStatus = STATUS_CMD_OK;\r
+               }\r
+               else\r
+               {\r
+                       ISPTarget_ChangeTargetResetLine(false);\r
+                       V2Protocol_DelayMS(Enter_ISP_Params.PinStabDelayMS);\r
+               }\r
+       }\r
+\r
+       Endpoint_Write_Byte(CMD_ENTER_PROGMODE_ISP);\r
+       Endpoint_Write_Byte(ResponseStatus);\r
+       Endpoint_ClearIN();\r
+}\r
+\r
+/** Handler for the CMD_LEAVE_ISP command, which releases the target from programming mode. */\r
+void ISPProtocol_LeaveISPMode(void)\r
+{\r
+       struct\r
+       {\r
+               uint8_t PreDelayMS;\r
+               uint8_t PostDelayMS;\r
+       } Leave_ISP_Params;\r
+\r
+       Endpoint_Read_Stream_LE(&Leave_ISP_Params, sizeof(Leave_ISP_Params));\r
+       \r
+       Endpoint_ClearOUT();\r
+       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
+\r
+       V2Protocol_DelayMS(Leave_ISP_Params.PreDelayMS);\r
+       ISPTarget_ChangeTargetResetLine(false);\r
+       SPI_ShutDown();\r
+       V2Protocol_DelayMS(Leave_ISP_Params.PostDelayMS);\r
+\r
+       Endpoint_Write_Byte(CMD_LEAVE_PROGMODE_ISP);\r
+       Endpoint_Write_Byte(STATUS_CMD_OK);\r
+       Endpoint_ClearIN();\r
+}\r
+\r
+/** Handler for the CMD_PROGRAM_FLASH_ISP and CMD_PROGRAM_EEPROM_ISP commands, writing out bytes,\r
+ *  words or pages of data to the attached device.\r
+ *\r
+ *  \param[in] V2Command  Issued V2 Protocol command byte from the host\r
+ */\r
+void ISPProtocol_ProgramMemory(uint8_t V2Command)\r
+{\r
+       struct\r
+       {\r
+               uint16_t BytesToWrite;\r
+               uint8_t  ProgrammingMode;\r
+               uint8_t  DelayMS;\r
+               uint8_t  ProgrammingCommands[3];\r
+               uint8_t  PollValue1;\r
+               uint8_t  PollValue2;\r
+               uint8_t  ProgData[256]; // Note, the Jungo driver has a very short ACK timeout period, need to buffer the\r
+       } Write_Memory_Params;      // whole page and ACK the packet as fast as possible to prevent it from aborting\r
+       \r
+       Endpoint_Read_Stream_LE(&Write_Memory_Params, sizeof(Write_Memory_Params) - sizeof(Write_Memory_Params.ProgData));\r
+       Write_Memory_Params.BytesToWrite = SwapEndian_16(Write_Memory_Params.BytesToWrite);\r
+       \r
+       if (Write_Memory_Params.BytesToWrite > sizeof(Write_Memory_Params.ProgData))\r
+       {\r
+               Endpoint_ClearOUT();\r
+               Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
+\r
+               Endpoint_Write_Byte(V2Command);\r
+               Endpoint_Write_Byte(STATUS_CMD_FAILED);\r
+               Endpoint_ClearIN();\r
+               return;\r
+       }\r
+       \r
+       Endpoint_Read_Stream_LE(&Write_Memory_Params.ProgData, Write_Memory_Params.BytesToWrite);\r
+\r
+       Endpoint_ClearOUT();\r
+       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
+\r
+       uint8_t  ProgrammingStatus = STATUS_CMD_OK;     \r
+       uint16_t PollAddress       = 0;\r
+       uint8_t  PollValue         = (V2Command == CMD_PROGRAM_FLASH_ISP) ? Write_Memory_Params.PollValue1 :\r
+                                                                           Write_Memory_Params.PollValue2;\r
+       uint8_t* NextWriteByte = Write_Memory_Params.ProgData;\r
+\r
+       if (MustSetAddress)\r
+       {\r
+               if (CurrentAddress & (1UL << 31))\r
+                 ISPTarget_LoadExtendedAddress();\r
+\r
+               MustSetAddress = false;\r
+       }\r
+\r
+       if (Write_Memory_Params.ProgrammingMode & PROG_MODE_PAGED_WRITES_MASK)\r
+       {\r
+               uint16_t StartAddress = (CurrentAddress & 0xFFFF);\r
+       \r
+               /* Paged mode memory programming */\r
+               for (uint16_t CurrentByte = 0; CurrentByte < Write_Memory_Params.BytesToWrite; CurrentByte++)\r
+               {\r
+                       bool    IsOddByte   = (CurrentByte & 0x01);\r
+                       uint8_t ByteToWrite = *(NextWriteByte++);\r
+               \r
+                       if (IsOddByte && (V2Command == CMD_PROGRAM_FLASH_ISP))\r
+                         Write_Memory_Params.ProgrammingCommands[0] |=  READ_WRITE_HIGH_BYTE_MASK;\r
+                       else\r
+                         Write_Memory_Params.ProgrammingCommands[0] &= ~READ_WRITE_HIGH_BYTE_MASK;\r
+                         \r
+                       SPI_SendByte(Write_Memory_Params.ProgrammingCommands[0]);\r
+                       SPI_SendByte(CurrentAddress >> 8);\r
+                       SPI_SendByte(CurrentAddress & 0xFF);\r
+                       SPI_SendByte(ByteToWrite);\r
+                       \r
+                       if (!(PollAddress) && (ByteToWrite != PollValue))\r
+                       {\r
+                               if (IsOddByte && (V2Command == CMD_PROGRAM_FLASH_ISP))\r
+                                 Write_Memory_Params.ProgrammingCommands[2] |= READ_WRITE_HIGH_BYTE_MASK;\r
+                                 \r
+                               PollAddress = (CurrentAddress & 0xFFFF);                                \r
+                       }               \r
+\r
+                       if (IsOddByte || (V2Command == CMD_PROGRAM_EEPROM_ISP))\r
+                         CurrentAddress++;\r
+               }\r
+               \r
+               /* If the current page must be committed, send the PROGRAM PAGE command to the target */\r
+               if (Write_Memory_Params.ProgrammingMode & PROG_MODE_COMMIT_PAGE_MASK)\r
+               {\r
+                       SPI_SendByte(Write_Memory_Params.ProgrammingCommands[1]);\r
+                       SPI_SendByte(StartAddress >> 8);\r
+                       SPI_SendByte(StartAddress & 0xFF);\r
+                       SPI_SendByte(0x00);\r
+                       \r
+                       /* Check if polling is possible, if not switch to timed delay mode */\r
+                       if (!(PollAddress))\r
+                       {\r
+                               Write_Memory_Params.ProgrammingMode &= ~PROG_MODE_PAGED_VALUE_MASK;\r
+                               Write_Memory_Params.ProgrammingMode |=  PROG_MODE_PAGED_TIMEDELAY_MASK;                         \r
+                       }\r
+\r
+                       ProgrammingStatus = ISPTarget_WaitForProgComplete(Write_Memory_Params.ProgrammingMode, PollAddress, PollValue,\r
+                                                                         Write_Memory_Params.DelayMS, Write_Memory_Params.ProgrammingCommands[2]);\r
+               }\r
+       }\r
+       else\r
+       {\r
+               /* Word/byte mode memory programming */\r
+               for (uint16_t CurrentByte = 0; CurrentByte < Write_Memory_Params.BytesToWrite; CurrentByte++)\r
+               {\r
+                       bool    IsOddByte   = (CurrentByte & 0x01);\r
+                       uint8_t ByteToWrite = *(NextWriteByte++);\r
+               \r
+                       if (IsOddByte && (V2Command == CMD_READ_FLASH_ISP))\r
+                         Write_Memory_Params.ProgrammingCommands[0] |=  READ_WRITE_HIGH_BYTE_MASK;\r
+                       else\r
+                         Write_Memory_Params.ProgrammingCommands[0] &= ~READ_WRITE_HIGH_BYTE_MASK;                     \r
+                         \r
+                       SPI_SendByte(Write_Memory_Params.ProgrammingCommands[0]);\r
+                       SPI_SendByte(CurrentAddress >> 8);\r
+                       SPI_SendByte(CurrentAddress & 0xFF);\r
+                       SPI_SendByte(ByteToWrite);\r
+                       \r
+                       if (ByteToWrite != PollValue)\r
+                       {\r
+                               if (IsOddByte && (V2Command == CMD_PROGRAM_FLASH_ISP))\r
+                                 Write_Memory_Params.ProgrammingCommands[2] |= READ_WRITE_HIGH_BYTE_MASK;\r
+                                 \r
+                               PollAddress = (CurrentAddress & 0xFFFF);\r
+                       }\r
+\r
+                       if (IsOddByte || (V2Command == CMD_PROGRAM_EEPROM_ISP))\r
+                         CurrentAddress++;\r
+                       \r
+                       ProgrammingStatus = ISPTarget_WaitForProgComplete(Write_Memory_Params.ProgrammingMode, PollAddress, PollValue,\r
+                                                                         Write_Memory_Params.DelayMS, Write_Memory_Params.ProgrammingCommands[2]);\r
+                         \r
+                       if (ProgrammingStatus != STATUS_CMD_OK)\r
+                         break;\r
+               }\r
+       }\r
+\r
+       Endpoint_Write_Byte(V2Command);\r
+       Endpoint_Write_Byte(ProgrammingStatus);\r
+       Endpoint_ClearIN();\r
+}\r
+\r
+/** Handler for the CMD_READ_FLASH_ISP and CMD_READ_EEPROM_ISP commands, reading in bytes,\r
+ *  words or pages of data from the attached device.\r
+ *\r
+ *  \param[in] V2Command  Issued V2 Protocol command byte from the host\r
+ */\r
+void ISPProtocol_ReadMemory(uint8_t V2Command)\r
+{\r
+       struct\r
+       {\r
+               uint16_t BytesToRead;\r
+               uint8_t  ReadMemoryCommand;\r
+       } Read_Memory_Params;\r
+       \r
+       Endpoint_Read_Stream_LE(&Read_Memory_Params, sizeof(Read_Memory_Params));\r
+       Read_Memory_Params.BytesToRead = SwapEndian_16(Read_Memory_Params.BytesToRead);\r
+       \r
+       Endpoint_ClearOUT();\r
+       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
+       \r
+       Endpoint_Write_Byte(V2Command);\r
+       Endpoint_Write_Byte(STATUS_CMD_OK);\r
+       \r
+       if (MustSetAddress)\r
+       {\r
+               if (CurrentAddress & (1UL << 31))\r
+                 ISPTarget_LoadExtendedAddress();\r
+\r
+               MustSetAddress = false;\r
+       }\r
+\r
+       for (uint16_t CurrentByte = 0; CurrentByte < Read_Memory_Params.BytesToRead; CurrentByte++)\r
+       {\r
+               bool IsOddByte = (CurrentByte & 0x01);\r
+\r
+               if (IsOddByte && (V2Command == CMD_READ_FLASH_ISP))\r
+                 Read_Memory_Params.ReadMemoryCommand |=  READ_WRITE_HIGH_BYTE_MASK;\r
+               else\r
+                 Read_Memory_Params.ReadMemoryCommand &= ~READ_WRITE_HIGH_BYTE_MASK;\r
+\r
+               SPI_SendByte(Read_Memory_Params.ReadMemoryCommand);\r
+               SPI_SendByte(CurrentAddress >> 8);\r
+               SPI_SendByte(CurrentAddress & 0xFF);\r
+               Endpoint_Write_Byte(SPI_ReceiveByte());\r
+               \r
+               /* Check if the endpoint bank is currently full */\r
+               if (!(Endpoint_IsReadWriteAllowed()))\r
+               {\r
+                       Endpoint_ClearIN();\r
+                       Endpoint_WaitUntilReady();\r
+               }\r
+               \r
+               if ((IsOddByte && (V2Command == CMD_READ_FLASH_ISP)) || (V2Command == CMD_READ_EEPROM_ISP))\r
+                 CurrentAddress++;\r
+       }\r
+\r
+       Endpoint_Write_Byte(STATUS_CMD_OK);\r
+\r
+       bool IsEndpointFull = !(Endpoint_IsReadWriteAllowed());\r
+       Endpoint_ClearIN();\r
+       \r
+       /* Ensure last packet is a short packet to terminate the transfer */\r
+       if (IsEndpointFull)\r
+       {\r
+               Endpoint_WaitUntilReady();      \r
+               Endpoint_ClearIN();\r
+               Endpoint_WaitUntilReady();      \r
+       }\r
+}\r
+\r
+/** Handler for the CMD_CHI_ERASE_ISP command, clearing the target's FLASH memory. */\r
+void ISPProtocol_ChipErase(void)\r
+{\r
+       struct\r
+       {\r
+               uint8_t EraseDelayMS;\r
+               uint8_t PollMethod;\r
+               uint8_t EraseCommandBytes[4];\r
+       } Erase_Chip_Params;\r
+       \r
+       Endpoint_Read_Stream_LE(&Erase_Chip_Params, sizeof(Erase_Chip_Params));\r
+       \r
+       Endpoint_ClearOUT();\r
+       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
+       \r
+       uint8_t ResponseStatus = STATUS_CMD_OK;\r
+       \r
+       for (uint8_t SByte = 0; SByte < sizeof(Erase_Chip_Params.EraseCommandBytes); SByte++)\r
+         SPI_SendByte(Erase_Chip_Params.EraseCommandBytes[SByte]);\r
+\r
+       if (!(Erase_Chip_Params.PollMethod))\r
+         V2Protocol_DelayMS(Erase_Chip_Params.EraseDelayMS);\r
+       else\r
+         ResponseStatus = ISPTarget_WaitWhileTargetBusy();\r
+         \r
+       Endpoint_Write_Byte(CMD_CHIP_ERASE_ISP);\r
+       Endpoint_Write_Byte(ResponseStatus);\r
+       Endpoint_ClearIN();\r
+}\r
+\r
+/** Handler for the CMD_READ_FUSE_ISP, CMD_READ_LOCK_ISP, CMD_READ_SIGNATURE_ISP and CMD_READ_OSCCAL commands,\r
+ *  reading the requested configuration byte from the device.\r
+ *\r
+ *  \param[in] V2Command  Issued V2 Protocol command byte from the host\r
+ */\r
+void ISPProtocol_ReadFuseLockSigOSCCAL(uint8_t V2Command)\r
+{\r
+       struct\r
+       {\r
+               uint8_t RetByte;\r
+               uint8_t ReadCommandBytes[4];\r
+       } Read_FuseLockSigOSCCAL_Params;\r
+       \r
+       Endpoint_Read_Stream_LE(&Read_FuseLockSigOSCCAL_Params, sizeof(Read_FuseLockSigOSCCAL_Params));\r
+\r
+       Endpoint_ClearOUT();\r
+       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
+\r
+       uint8_t ResponseBytes[4];\r
+               \r
+       for (uint8_t RByte = 0; RByte < sizeof(ResponseBytes); RByte++)\r
+         ResponseBytes[RByte] = SPI_TransferByte(Read_FuseLockSigOSCCAL_Params.ReadCommandBytes[RByte]);\r
+               \r
+       Endpoint_Write_Byte(V2Command);\r
+       Endpoint_Write_Byte(STATUS_CMD_OK);\r
+       Endpoint_Write_Byte(ResponseBytes[Read_FuseLockSigOSCCAL_Params.RetByte - 1]);\r
+       Endpoint_Write_Byte(STATUS_CMD_OK);\r
+       Endpoint_ClearIN();\r
+}\r
+\r
+/** Handler for the CMD_WRITE_FUSE_ISP and CMD_WRITE_LOCK_ISP commands, writing the requested configuration\r
+ *  byte to the device.\r
+ *\r
+ *  \param[in] V2Command  Issued V2 Protocol command byte from the host\r
+ */\r
+void ISPProtocol_WriteFuseLock(uint8_t V2Command)\r
+{\r
+       struct\r
+       {\r
+               uint8_t WriteCommandBytes[4];\r
+       } Write_FuseLockSig_Params;\r
+       \r
+       Endpoint_Read_Stream_LE(&Write_FuseLockSig_Params, sizeof(Write_FuseLockSig_Params));\r
+\r
+       Endpoint_ClearOUT();\r
+       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
+\r
+       for (uint8_t SByte = 0; SByte < sizeof(Write_FuseLockSig_Params.WriteCommandBytes); SByte++)\r
+         SPI_SendByte(Write_FuseLockSig_Params.WriteCommandBytes[SByte]);\r
+               \r
+       Endpoint_Write_Byte(V2Command);\r
+       Endpoint_Write_Byte(STATUS_CMD_OK);\r
+       Endpoint_Write_Byte(STATUS_CMD_OK);\r
+       Endpoint_ClearIN();\r
+}\r
+\r
+/** Handler for the CMD_SPI_MULTI command, writing and reading arbitrary SPI data to and from the attached device. */\r
+void ISPProtocol_SPIMulti(void)\r
+{\r
+       struct\r
+       {\r
+               uint8_t TxBytes;\r
+               uint8_t RxBytes;\r
+               uint8_t RxStartAddr;\r
+               uint8_t TxData[255];\r
+       } SPI_Multi_Params;\r
+       \r
+       Endpoint_Read_Stream_LE(&SPI_Multi_Params, sizeof(SPI_Multi_Params) - sizeof(SPI_Multi_Params.TxData));\r
+       Endpoint_Read_Stream_LE(&SPI_Multi_Params.TxData, SPI_Multi_Params.TxBytes);\r
+       \r
+       Endpoint_ClearOUT();\r
+       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
+       \r
+       Endpoint_Write_Byte(CMD_SPI_MULTI);\r
+       Endpoint_Write_Byte(STATUS_CMD_OK);\r
+\r
+       uint8_t CurrTxPos = 0;\r
+       uint8_t CurrRxPos = 0;\r
+\r
+       /* Write out bytes to transmit until the start of the bytes to receive is met */\r
+       while (CurrTxPos < SPI_Multi_Params.RxStartAddr)\r
+       {\r
+               if (CurrTxPos < SPI_Multi_Params.TxBytes)\r
+                 SPI_SendByte(SPI_Multi_Params.TxData[CurrTxPos]);\r
+               else\r
+                 SPI_SendByte(0);\r
+               \r
+               CurrTxPos++;\r
+       }\r
+\r
+       /* Transmit remaining bytes with padding as needed, read in response bytes */\r
+       while (CurrRxPos < SPI_Multi_Params.RxBytes)\r
+       {\r
+               if (CurrTxPos < SPI_Multi_Params.TxBytes)\r
+                 Endpoint_Write_Byte(SPI_TransferByte(SPI_Multi_Params.TxData[CurrTxPos++]));\r
+               else\r
+                 Endpoint_Write_Byte(SPI_ReceiveByte());\r
+               \r
+               CurrRxPos++;\r
+       }       \r
+       \r
+       Endpoint_Write_Byte(STATUS_CMD_OK);\r
+       Endpoint_ClearIN();\r
+}\r
diff --git a/Projects/AVRISP/Lib/ISPProtocol.h b/Projects/AVRISP/Lib/ISPProtocol.h
new file mode 100644 (file)
index 0000000..5a91f59
--- /dev/null
@@ -0,0 +1,67 @@
+/*\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
+       /* 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
+       /* Function Prototypes: */\r
+               void ISPProtocol_EnterISPMode(void);\r
+               void ISPProtocol_LeaveISPMode(void);\r
+               void ISPProtocol_ProgramMemory(uint8_t V2Command);\r
+               void ISPProtocol_ReadMemory(uint8_t V2Command);\r
+               void ISPProtocol_ChipErase(void);\r
+               void ISPProtocol_ReadFuseLockSigOSCCAL(uint8_t V2Command);\r
+               void ISPProtocol_WriteFuseLock(uint8_t V2Command);\r
+               void ISPProtocol_SPIMulti(void);\r
+\r
+#endif\r
index e45be54..c0028f7 100644 (file)
 #define  INCLUDE_FROM_V2PROTOCOL_C\r
 #include "V2Protocol.h"\r
 \r
+/** Current memory address for FLASH/EEPROM memory read/write commands */\r
+uint32_t CurrentAddress;\r
+\r
+/** Flag to indicate that the next read/write operation must update the device's current address */\r
+bool MustSetAddress;\r
+\r
+\r
 /** Master V2 Protocol packet handler, for received V2 Protocol packets from a connected host.\r
  *  This routine decodes the issued command and passes off the handling of the command to the\r
  *  appropriate function.\r
@@ -60,34 +67,38 @@ void V2Protocol_ProcessCommand(void)
                        V2Protocol_ResetProtection();\r
                        break;\r
                case CMD_ENTER_PROGMODE_ISP:\r
-                       V2Protocol_ISP_EnterISPMode();\r
+                       ISPProtocol_EnterISPMode();\r
                        break;\r
                case CMD_LEAVE_PROGMODE_ISP:\r
-                       V2Protocol_ISP_LeaveISPMode();\r
+                       ISPProtocol_LeaveISPMode();\r
                        break;\r
                case CMD_PROGRAM_FLASH_ISP:\r
                case CMD_PROGRAM_EEPROM_ISP:\r
-                       V2Protocol_ISP_ProgramMemory(V2Command);                        \r
+                       ISPProtocol_ProgramMemory(V2Command);                   \r
                        break;\r
                case CMD_READ_FLASH_ISP:\r
                case CMD_READ_EEPROM_ISP:\r
-                       V2Protocol_ISP_ReadMemory(V2Command);\r
+                       ISPProtocol_ReadMemory(V2Command);\r
                        break;\r
                case CMD_CHIP_ERASE_ISP:\r
-                       V2Protocol_ISP_ChipErase();\r
+                       ISPProtocol_ChipErase();\r
                        break;\r
+#if defined(ENABLE_XPROG_PROTOCOL)\r
+               case CMD_XPROG_SETMODE:\r
+                       V2Protocol_XPROG_SetMode();\r
+#endif\r
                case CMD_READ_FUSE_ISP:\r
                case CMD_READ_LOCK_ISP:\r
                case CMD_READ_SIGNATURE_ISP:\r
                case CMD_READ_OSCCAL_ISP:\r
-                       V2Protocol_ISP_ReadFuseLockSigOSCCAL(V2Command);\r
+                       ISPProtocol_ReadFuseLockSigOSCCAL(V2Command);\r
                        break;\r
                case CMD_PROGRAM_FUSE_ISP:\r
                case CMD_PROGRAM_LOCK_ISP:\r
-                       V2Protocol_ISP_WriteFuseLock(V2Command);\r
+                       ISPProtocol_WriteFuseLock(V2Command);\r
                        break;\r
                case CMD_SPI_MULTI:\r
-                       V2Protocol_ISP_SPIMulti();\r
+                       ISPProtocol_SPIMulti();\r
                        break;\r
                default:\r
                        V2Protocol_UnknownCommand(V2Command);\r
@@ -196,425 +207,9 @@ static void V2Protocol_LoadAddress(void)
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
        \r
-       if (CurrentAddress & (1UL << 31))\r
-         V2Protocol_LoadExtendedAddress();\r
+       MustSetAddress = true;\r
 \r
        Endpoint_Write_Byte(CMD_LOAD_ADDRESS);\r
        Endpoint_Write_Byte(STATUS_CMD_OK);\r
        Endpoint_ClearIN();\r
 }\r
-\r
-/** Handler for the CMD_ENTER_PROGMODE_ISP command, which attempts to enter programming mode on\r
- *  the attached device, returning success or failure back to the host.\r
- */\r
-static void V2Protocol_ISP_EnterISPMode(void)\r
-{\r
-       struct\r
-       {\r
-               uint8_t TimeoutMS;\r
-               uint8_t PinStabDelayMS;\r
-               uint8_t ExecutionDelayMS;\r
-               uint8_t SynchLoops;\r
-               uint8_t ByteDelay;\r
-               uint8_t PollValue;\r
-               uint8_t PollIndex;\r
-               uint8_t EnterProgBytes[4];\r
-       } Enter_ISP_Params;\r
-       \r
-       Endpoint_Read_Stream_LE(&Enter_ISP_Params, sizeof(Enter_ISP_Params));\r
-\r
-       Endpoint_ClearOUT();\r
-       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
-\r
-       uint8_t ResponseStatus = STATUS_CMD_FAILED;\r
-       \r
-       CurrentAddress = 0;\r
-\r
-       V2Protocol_DelayMS(Enter_ISP_Params.ExecutionDelayMS);    \r
-       SPI_Init(V2Protocol_GetSPIPrescalerMask() | SPI_SCK_LEAD_RISING | SPI_SAMPLE_LEADING | SPI_MODE_MASTER);\r
-               \r
-       while (Enter_ISP_Params.SynchLoops-- && (ResponseStatus == STATUS_CMD_FAILED))\r
-       {\r
-               uint8_t ResponseBytes[4];\r
-\r
-               V2Protocol_ChangeTargetResetLine(true);\r
-               V2Protocol_DelayMS(Enter_ISP_Params.PinStabDelayMS);\r
-\r
-               for (uint8_t RByte = 0; RByte < sizeof(ResponseBytes); RByte++)\r
-               {\r
-                       V2Protocol_DelayMS(Enter_ISP_Params.ByteDelay);\r
-                       ResponseBytes[RByte] = SPI_TransferByte(Enter_ISP_Params.EnterProgBytes[RByte]);\r
-               }\r
-               \r
-               /* Check if polling disabled, or if the polled value matches the expected value */\r
-               if (!(Enter_ISP_Params.PollIndex) || (ResponseBytes[Enter_ISP_Params.PollIndex - 1] == Enter_ISP_Params.PollValue))\r
-               {\r
-                       ResponseStatus = STATUS_CMD_OK;\r
-               }\r
-               else\r
-               {\r
-                       V2Protocol_ChangeTargetResetLine(false);\r
-                       V2Protocol_DelayMS(Enter_ISP_Params.PinStabDelayMS);\r
-               }\r
-       }\r
-\r
-       Endpoint_Write_Byte(CMD_ENTER_PROGMODE_ISP);\r
-       Endpoint_Write_Byte(ResponseStatus);\r
-       Endpoint_ClearIN();\r
-}\r
-\r
-/** Handler for the CMD_LEAVE_ISP command, which releases the target from programming mode. */\r
-static void V2Protocol_ISP_LeaveISPMode(void)\r
-{\r
-       struct\r
-       {\r
-               uint8_t PreDelayMS;\r
-               uint8_t PostDelayMS;\r
-       } Leave_ISP_Params;\r
-\r
-       Endpoint_Read_Stream_LE(&Leave_ISP_Params, sizeof(Leave_ISP_Params));\r
-       \r
-       Endpoint_ClearOUT();\r
-       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
-\r
-       V2Protocol_DelayMS(Leave_ISP_Params.PreDelayMS);\r
-       V2Protocol_ChangeTargetResetLine(false);\r
-       SPI_ShutDown();\r
-       V2Protocol_DelayMS(Leave_ISP_Params.PostDelayMS);\r
-\r
-       Endpoint_Write_Byte(CMD_LEAVE_PROGMODE_ISP);\r
-       Endpoint_Write_Byte(STATUS_CMD_OK);\r
-       Endpoint_ClearIN();\r
-}\r
-\r
-/** Handler for the CMD_PROGRAM_FLASH_ISP and CMD_PROGRAM_EEPROM_ISP commands, writing out bytes,\r
- *  words or pages of data to the attached device.\r
- *\r
- *  \param[in] V2Command  Issued V2 Protocol command byte from the host\r
- */\r
-static void V2Protocol_ISP_ProgramMemory(uint8_t V2Command)\r
-{\r
-       struct\r
-       {\r
-               uint16_t BytesToWrite;\r
-               uint8_t  ProgrammingMode;\r
-               uint8_t  DelayMS;\r
-               uint8_t  ProgrammingCommands[3];\r
-               uint8_t  PollValue1;\r
-               uint8_t  PollValue2;\r
-               uint8_t  ProgData[256]; // Note, the Jungo driver has a very short ACK timeout period, need to buffer the\r
-       } Write_Memory_Params;      // whole page and ACK the packet as fast as possible to prevent it from aborting\r
-       \r
-       Endpoint_Read_Stream_LE(&Write_Memory_Params, sizeof(Write_Memory_Params) - sizeof(Write_Memory_Params.ProgData));\r
-       Write_Memory_Params.BytesToWrite = SwapEndian_16(Write_Memory_Params.BytesToWrite);\r
-       \r
-       if (Write_Memory_Params.BytesToWrite > sizeof(Write_Memory_Params.ProgData))\r
-       {\r
-               Endpoint_ClearOUT();\r
-               Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
-\r
-               Endpoint_Write_Byte(V2Command);\r
-               Endpoint_Write_Byte(STATUS_CMD_FAILED);\r
-               Endpoint_ClearIN();\r
-               return;\r
-       }\r
-       \r
-       Endpoint_Read_Stream_LE(&Write_Memory_Params.ProgData, Write_Memory_Params.BytesToWrite);\r
-\r
-       Endpoint_ClearOUT();\r
-       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
-\r
-       uint8_t  ProgrammingStatus = STATUS_CMD_OK;     \r
-       uint16_t PollAddress       = 0;\r
-       uint8_t  PollValue         = (V2Command == CMD_PROGRAM_FLASH_ISP) ? Write_Memory_Params.PollValue1 :\r
-                                                                           Write_Memory_Params.PollValue2;\r
-       uint8_t* NextWriteByte = Write_Memory_Params.ProgData;\r
-\r
-       if (Write_Memory_Params.ProgrammingMode & PROG_MODE_PAGED_WRITES_MASK)\r
-       {\r
-               uint16_t StartAddress = (CurrentAddress & 0xFFFF);\r
-       \r
-               /* Paged mode memory programming */\r
-               for (uint16_t CurrentByte = 0; CurrentByte < Write_Memory_Params.BytesToWrite; CurrentByte++)\r
-               {\r
-                       bool    IsOddByte   = (CurrentByte & 0x01);\r
-                       uint8_t ByteToWrite = *(NextWriteByte++);\r
-               \r
-                       if (IsOddByte && (V2Command == CMD_PROGRAM_FLASH_ISP))\r
-                         Write_Memory_Params.ProgrammingCommands[0] |=  READ_WRITE_HIGH_BYTE_MASK;\r
-                       else\r
-                         Write_Memory_Params.ProgrammingCommands[0] &= ~READ_WRITE_HIGH_BYTE_MASK;\r
-                         \r
-                       SPI_SendByte(Write_Memory_Params.ProgrammingCommands[0]);\r
-                       SPI_SendByte(CurrentAddress >> 8);\r
-                       SPI_SendByte(CurrentAddress & 0xFF);\r
-                       SPI_SendByte(ByteToWrite);\r
-                       \r
-                       if (!(PollAddress) && (ByteToWrite != PollValue))\r
-                       {\r
-                               if (IsOddByte && (V2Command == CMD_PROGRAM_FLASH_ISP))\r
-                                 Write_Memory_Params.ProgrammingCommands[2] |= READ_WRITE_HIGH_BYTE_MASK;\r
-                                 \r
-                               PollAddress = (CurrentAddress & 0xFFFF);                                \r
-                       }               \r
-\r
-                       if (IsOddByte || (V2Command == CMD_PROGRAM_EEPROM_ISP))\r
-                         CurrentAddress++;\r
-               }\r
-               \r
-               /* If the current page must be committed, send the PROGRAM PAGE command to the target */\r
-               if (Write_Memory_Params.ProgrammingMode & PROG_MODE_COMMIT_PAGE_MASK)\r
-               {\r
-                       SPI_SendByte(Write_Memory_Params.ProgrammingCommands[1]);\r
-                       SPI_SendByte(StartAddress >> 8);\r
-                       SPI_SendByte(StartAddress & 0xFF);\r
-                       SPI_SendByte(0x00);\r
-                       \r
-                       /* Check if polling is possible, if not switch to timed delay mode */\r
-                       if (!(PollAddress))\r
-                       {\r
-                               Write_Memory_Params.ProgrammingMode &= ~PROG_MODE_PAGED_VALUE_MASK;\r
-                               Write_Memory_Params.ProgrammingMode |=  PROG_MODE_PAGED_TIMEDELAY_MASK;                         \r
-                       }\r
-\r
-                       ProgrammingStatus = V2Protocol_WaitForProgComplete(Write_Memory_Params.ProgrammingMode, PollAddress, PollValue,\r
-                                                                                                                          Write_Memory_Params.DelayMS, Write_Memory_Params.ProgrammingCommands[2]);\r
-               }\r
-       }\r
-       else\r
-       {\r
-               /* Word/byte mode memory programming */\r
-               for (uint16_t CurrentByte = 0; CurrentByte < Write_Memory_Params.BytesToWrite; CurrentByte++)\r
-               {\r
-                       bool    IsOddByte   = (CurrentByte & 0x01);\r
-                       uint8_t ByteToWrite = *(NextWriteByte++);\r
-               \r
-                       if (IsOddByte && (V2Command == CMD_READ_FLASH_ISP))\r
-                         Write_Memory_Params.ProgrammingCommands[0] |=  READ_WRITE_HIGH_BYTE_MASK;\r
-                       else\r
-                         Write_Memory_Params.ProgrammingCommands[0] &= ~READ_WRITE_HIGH_BYTE_MASK;                     \r
-                         \r
-                       SPI_SendByte(Write_Memory_Params.ProgrammingCommands[0]);\r
-                       SPI_SendByte(CurrentAddress >> 8);\r
-                       SPI_SendByte(CurrentAddress & 0xFF);\r
-                       SPI_SendByte(ByteToWrite);\r
-                       \r
-                       if (ByteToWrite != PollValue)\r
-                       {\r
-                               if (IsOddByte && (V2Command == CMD_PROGRAM_FLASH_ISP))\r
-                                 Write_Memory_Params.ProgrammingCommands[2] |= READ_WRITE_HIGH_BYTE_MASK;\r
-                                 \r
-                               PollAddress = (CurrentAddress & 0xFFFF);\r
-                       }\r
-\r
-                       if (IsOddByte || (V2Command == CMD_PROGRAM_EEPROM_ISP))\r
-                         CurrentAddress++;\r
-                       \r
-                       ProgrammingStatus = V2Protocol_WaitForProgComplete(Write_Memory_Params.ProgrammingMode, PollAddress, PollValue,\r
-                                                                          Write_Memory_Params.DelayMS, Write_Memory_Params.ProgrammingCommands[2]);\r
-                         \r
-                       if (ProgrammingStatus != STATUS_CMD_OK)\r
-                         break;\r
-               }\r
-       }\r
-\r
-       Endpoint_Write_Byte(V2Command);\r
-       Endpoint_Write_Byte(ProgrammingStatus);\r
-       Endpoint_ClearIN();\r
-}\r
-\r
-/** Handler for the CMD_READ_FLASH_ISP and CMD_READ_EEPROM_ISP commands, reading in bytes,\r
- *  words or pages of data from the attached device.\r
- *\r
- *  \param[in] V2Command  Issued V2 Protocol command byte from the host\r
- */\r
-static void V2Protocol_ISP_ReadMemory(uint8_t V2Command)\r
-{\r
-       struct\r
-       {\r
-               uint16_t BytesToRead;\r
-               uint8_t  ReadMemoryCommand;\r
-       } Read_Memory_Params;\r
-       \r
-       Endpoint_Read_Stream_LE(&Read_Memory_Params, sizeof(Read_Memory_Params));\r
-       Read_Memory_Params.BytesToRead = SwapEndian_16(Read_Memory_Params.BytesToRead);\r
-       \r
-       Endpoint_ClearOUT();\r
-       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
-       \r
-       Endpoint_Write_Byte(V2Command);\r
-       Endpoint_Write_Byte(STATUS_CMD_OK);\r
-       \r
-       for (uint16_t CurrentByte = 0; CurrentByte < Read_Memory_Params.BytesToRead; CurrentByte++)\r
-       {\r
-               bool IsOddByte = (CurrentByte & 0x01);\r
-\r
-               if (IsOddByte && (V2Command == CMD_READ_FLASH_ISP))\r
-                 Read_Memory_Params.ReadMemoryCommand |=  READ_WRITE_HIGH_BYTE_MASK;\r
-               else\r
-                 Read_Memory_Params.ReadMemoryCommand &= ~READ_WRITE_HIGH_BYTE_MASK;\r
-\r
-               SPI_SendByte(Read_Memory_Params.ReadMemoryCommand);\r
-               SPI_SendByte(CurrentAddress >> 8);\r
-               SPI_SendByte(CurrentAddress & 0xFF);\r
-               Endpoint_Write_Byte(SPI_ReceiveByte());\r
-               \r
-               /* Check if the endpoint bank is currently full */\r
-               if (!(Endpoint_IsReadWriteAllowed()))\r
-               {\r
-                       Endpoint_ClearIN();\r
-                       Endpoint_WaitUntilReady();\r
-               }\r
-               \r
-               if ((IsOddByte && (V2Command == CMD_READ_FLASH_ISP)) || (V2Command == CMD_READ_EEPROM_ISP))\r
-                 CurrentAddress++;\r
-       }\r
-\r
-       Endpoint_Write_Byte(STATUS_CMD_OK);\r
-\r
-       bool IsEndpointFull = !(Endpoint_IsReadWriteAllowed());\r
-       Endpoint_ClearIN();\r
-       \r
-       /* Ensure last packet is a short packet to terminate the transfer */\r
-       if (IsEndpointFull)\r
-       {\r
-               Endpoint_WaitUntilReady();      \r
-               Endpoint_ClearIN();\r
-               Endpoint_WaitUntilReady();      \r
-       }\r
-}\r
-\r
-/** Handler for the CMD_CHI_ERASE_ISP command, clearing the target's FLASH memory. */\r
-static void V2Protocol_ISP_ChipErase(void)\r
-{\r
-       struct\r
-       {\r
-               uint8_t EraseDelayMS;\r
-               uint8_t PollMethod;\r
-               uint8_t EraseCommandBytes[4];\r
-       } Erase_Chip_Params;\r
-       \r
-       Endpoint_Read_Stream_LE(&Erase_Chip_Params, sizeof(Erase_Chip_Params));\r
-       \r
-       Endpoint_ClearOUT();\r
-       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
-       \r
-       uint8_t ResponseStatus = STATUS_CMD_OK;\r
-       \r
-       for (uint8_t SByte = 0; SByte < sizeof(Erase_Chip_Params.EraseCommandBytes); SByte++)\r
-         SPI_SendByte(Erase_Chip_Params.EraseCommandBytes[SByte]);\r
-\r
-       if (!(Erase_Chip_Params.PollMethod))\r
-         V2Protocol_DelayMS(Erase_Chip_Params.EraseDelayMS);\r
-       else\r
-         ResponseStatus = V2Protocol_WaitWhileTargetBusy();\r
-         \r
-       Endpoint_Write_Byte(CMD_CHIP_ERASE_ISP);\r
-       Endpoint_Write_Byte(ResponseStatus);\r
-       Endpoint_ClearIN();\r
-}\r
-\r
-/** Handler for the CMD_READ_FUSE_ISP, CMD_READ_LOCK_ISP, CMD_READ_SIGNATURE_ISP and CMD_READ_OSCCAL commands,\r
- *  reading the requested configuration byte from the device.\r
- *\r
- *  \param[in] V2Command  Issued V2 Protocol command byte from the host\r
- */\r
-static void V2Protocol_ISP_ReadFuseLockSigOSCCAL(uint8_t V2Command)\r
-{\r
-       struct\r
-       {\r
-               uint8_t RetByte;\r
-               uint8_t ReadCommandBytes[4];\r
-       } Read_FuseLockSigOSCCAL_Params;\r
-       \r
-       Endpoint_Read_Stream_LE(&Read_FuseLockSigOSCCAL_Params, sizeof(Read_FuseLockSigOSCCAL_Params));\r
-\r
-       Endpoint_ClearOUT();\r
-       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
-\r
-       uint8_t ResponseBytes[4];\r
-               \r
-       for (uint8_t RByte = 0; RByte < sizeof(ResponseBytes); RByte++)\r
-         ResponseBytes[RByte] = SPI_TransferByte(Read_FuseLockSigOSCCAL_Params.ReadCommandBytes[RByte]);\r
-               \r
-       Endpoint_Write_Byte(V2Command);\r
-       Endpoint_Write_Byte(STATUS_CMD_OK);\r
-       Endpoint_Write_Byte(ResponseBytes[Read_FuseLockSigOSCCAL_Params.RetByte - 1]);\r
-       Endpoint_Write_Byte(STATUS_CMD_OK);\r
-       Endpoint_ClearIN();\r
-}\r
-\r
-/** Handler for the CMD_WRITE_FUSE_ISP and CMD_WRITE_LOCK_ISP commands, writing the requested configuration\r
- *  byte to the device.\r
- *\r
- *  \param[in] V2Command  Issued V2 Protocol command byte from the host\r
- */\r
-static void V2Protocol_ISP_WriteFuseLock(uint8_t V2Command)\r
-{\r
-       struct\r
-       {\r
-               uint8_t WriteCommandBytes[4];\r
-       } Write_FuseLockSig_Params;\r
-       \r
-       Endpoint_Read_Stream_LE(&Write_FuseLockSig_Params, sizeof(Write_FuseLockSig_Params));\r
-\r
-       Endpoint_ClearOUT();\r
-       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
-\r
-       for (uint8_t SByte = 0; SByte < sizeof(Write_FuseLockSig_Params.WriteCommandBytes); SByte++)\r
-         SPI_SendByte(Write_FuseLockSig_Params.WriteCommandBytes[SByte]);\r
-               \r
-       Endpoint_Write_Byte(V2Command);\r
-       Endpoint_Write_Byte(STATUS_CMD_OK);\r
-       Endpoint_Write_Byte(STATUS_CMD_OK);\r
-       Endpoint_ClearIN();\r
-}\r
-\r
-/** Handler for the CMD_SPI_MULTI command, writing and reading arbitrary SPI data to and from the attached device. */\r
-static void V2Protocol_ISP_SPIMulti(void)\r
-{\r
-       struct\r
-       {\r
-               uint8_t TxBytes;\r
-               uint8_t RxBytes;\r
-               uint8_t RxStartAddr;\r
-               uint8_t TxData[255];\r
-       } SPI_Multi_Params;\r
-       \r
-       Endpoint_Read_Stream_LE(&SPI_Multi_Params, sizeof(SPI_Multi_Params) - sizeof(SPI_Multi_Params.TxData));\r
-       Endpoint_Read_Stream_LE(&SPI_Multi_Params.TxData, SPI_Multi_Params.TxBytes);\r
-       \r
-       Endpoint_ClearOUT();\r
-       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
-       \r
-       Endpoint_Write_Byte(CMD_SPI_MULTI);\r
-       Endpoint_Write_Byte(STATUS_CMD_OK);\r
-\r
-       uint8_t CurrTxPos = 0;\r
-       uint8_t CurrRxPos = 0;\r
-\r
-       /* Write out bytes to transmit until the start of the bytes to receive is met */\r
-       while (CurrTxPos < SPI_Multi_Params.RxStartAddr)\r
-       {\r
-               if (CurrTxPos < SPI_Multi_Params.TxBytes)\r
-                 SPI_SendByte(SPI_Multi_Params.TxData[CurrTxPos]);\r
-               else\r
-                 SPI_SendByte(0);\r
-               \r
-               CurrTxPos++;\r
-       }\r
-\r
-       /* Transmit remaining bytes with padding as needed, read in response bytes */\r
-       while (CurrRxPos < SPI_Multi_Params.RxBytes)\r
-       {\r
-               if (CurrTxPos < SPI_Multi_Params.TxBytes)\r
-                 Endpoint_Write_Byte(SPI_TransferByte(SPI_Multi_Params.TxData[CurrTxPos++]));\r
-               else\r
-                 Endpoint_Write_Byte(SPI_ReceiveByte());\r
-               \r
-               CurrRxPos++;\r
-       }       \r
-       \r
-       Endpoint_Write_Byte(STATUS_CMD_OK);\r
-       Endpoint_ClearIN();\r
-}\r
index 63a2347..b311478 100644 (file)
                #include "../Descriptors.h"
                #include "V2ProtocolConstants.h"\r
                #include "V2ProtocolParams.h"
-               #include "V2ProtocolTarget.h"\r
+               #include "ISPProtocol.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
-
+               /** Timeout in milliseconds of target busy-wait loops waiting for a command to complete */\r
+               #define TARGET_BUSY_TIMEOUT_MS    240\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 V2Protocol_DelayMS(uint8_t DelayMS)\r
+               {\r
+                       TCNT0 = 0;\r
+                       while (TCNT0 < DelayMS);\r
+               }
+\r
+       /* External Variables: */\r
+               extern uint32_t CurrentAddress;\r
+               extern bool MustSetAddress;\r
+\r
        /* Function Prototypes: */\r
                void V2Protocol_ProcessCommand(void);\r
                \r
                        static void V2Protocol_GetSetParam(uint8_t V2Command);\r
                        static void V2Protocol_ResetProtection(void);\r
                        static void V2Protocol_LoadAddress(void);\r
-                       static void V2Protocol_ISP_EnterISPMode(void);\r
-                       static void V2Protocol_ISP_LeaveISPMode(void);\r
-                       static void V2Protocol_ISP_ProgramMemory(uint8_t V2Command);\r
-                       static void V2Protocol_ISP_ReadMemory(uint8_t V2Command);\r
-                       static void V2Protocol_ISP_ChipErase(void);\r
-                       static void V2Protocol_ISP_ReadFuseLockSigOSCCAL(uint8_t V2Command);\r
-                       static void V2Protocol_ISP_WriteFuseLock(uint8_t V2Command);\r
-                       static void V2Protocol_ISP_SPIMulti(void);\r
                #endif
 
 #endif
index dce660a..5e6bd36 100644 (file)
                #define CMD_READ_OSCCAL_ISP         0x1C\r
                #define CMD_SPI_MULTI               0x1D\r
 \r
+               #define CMD_XPROG                   0x50\r
+               #define CMD_XPROG_SETMODE           0x51\r
+\r
+               #define XPRG_CMD_ENTER_PROGMODE 0x01\r
+               #define XPRG_CMD_LEAVE_PROGMODE 0x02\r
+               #define XPRG_CMD_ERASE 0x03\r
+               #define XPRG_CMD_WRITE_MEM 0x04\r
+               #define XPRG_CMD_READ_MEM 0x05\r
+               #define XPRG_CMD_CRC 0x06\r
+               #define XPRG_CMD_SET_PARAM 0x07\r
+\r
+               #define XPRG_MEM_TYPE_APPL 1\r
+               #define XPRG_MEM_TYPE_BOOT 2\r
+               #define XPRG_MEM_TYPE_EEPROM 3\r
+               #define XPRG_MEM_TYPE_FUSE 4\r
+               #define XPRG_MEM_TYPE_LOCKBITS 5\r
+               #define XPRG_MEM_TYPE_USERSIG 6\r
+               #define XPRG_MEM_TYPE_FACTORY_CALIBRATION 7\r
+\r
+               #define XPRG_ERASE_CHIP 1\r
+               #define XPRG_ERASE_APP 2\r
+               #define XPRG_ERASE_BOOT 3\r
+               #define XPRG_ERASE_EEPROM 4\r
+               #define XPRG_ERASE_APP_PAGE 5\r
+               #define XPRG_ERASE_BOOT_PAGE 6\r
+               #define XPRG_ERASE_EEPROM_PAGE 7\r
+               #define XPRG_ERASE_USERSIG 8\r
+\r
+               #define XPRG_MEM_WRITE_ERASE 0\r
+               #define XPRG_MEM_WRITE_WRITE 1\r
+\r
+               #define XPRG_CRC_APP 1\r
+               #define XPRG_CRC_BOOT 2\r
+               #define XPRG_CRC_FLASH 3\r
+\r
+               #define XPRG_ERR_OK 0\r
+               #define XPRG_ERR_FAILED 1\r
+               #define XPRG_ERR_COLLISION 2\r
+               #define XPRG_ERR_TIMEOUT 3\r
+\r
+               #define XPRG_PARAM_NVMBASE 0x01\r
+               #define XPRG_PARAM_EEPPAGESIZE 0x02\r
+\r
                #define STATUS_CMD_OK               0x00\r
                #define STATUS_CMD_TOUT             0x80\r
                #define STATUS_RDY_BSY_TOUT         0x81\r
index 62149b4..f6b057f 100644 (file)
@@ -67,7 +67,7 @@ static ParameterItem_t ParameterTable[] =
                  .ParamPrivileges = PARAM_PRIV_READ                    },\r
 \r
                { .ParamID          = PARAM_SCK_DURATION,\r
-                 .ParamValue       = (TOTAL_PROGRAMMING_SPEEDS - 1),\r
+                 .ParamValue       = (TOTAL_ISP_PROGRAMMING_SPEEDS - 1),\r
                  .ParamPrivileges = PARAM_PRIV_READ | PARAM_PRIV_WRITE },\r
 \r
                { .ParamID          = PARAM_RESET_POLARITY,\r
index b27a4ea..6a5c25f 100644 (file)
@@ -48,6 +48,7 @@
                \r
                #include "V2Protocol.h"\r
                #include "V2ProtocolConstants.h"\r
+               #include "V2ProtocolTarget.h"\r
 \r
        /* Macros: */\r
                /** Parameter privilege mask to allow the host PC to read the parameter's value */\r
index 80e8be1..b5de9ba 100644 (file)
 \r
 /** \file\r
  *\r
- *  Target-related functions for the V2 Protocol decoder.\r
+ *  Target-related functions for the ISP 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
+uint8_t ISPTarget_GetSPIPrescalerMask(void)\r
 {\r
        static const uint8_t SPIMaskFromSCKDuration[] =\r
        {\r
@@ -81,7 +78,7 @@ uint8_t V2Protocol_GetSPIPrescalerMask(void)
  *\r
  *  \param[in] ResetTarget Boolean true when the target should be held in reset, false otherwise\r
  */\r
-void V2Protocol_ChangeTargetResetLine(bool ResetTarget)\r
+void ISPTarget_ChangeTargetResetLine(bool ResetTarget)\r
 {\r
        if (ResetTarget)\r
        {\r
@@ -109,8 +106,8 @@ void V2Protocol_ChangeTargetResetLine(bool ResetTarget)
  *  \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
+uint8_t ISPTarget_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
@@ -139,7 +136,7 @@ uint8_t V2Protocol_WaitForProgComplete(uint8_t ProgrammingMode, uint16_t PollAdd
                        break;          \r
                case PROG_MODE_WORD_READYBUSY_MASK:\r
                case PROG_MODE_PAGED_READYBUSY_MASK:\r
-                       ProgrammingStatus = V2Protocol_WaitWhileTargetBusy();\r
+                       ProgrammingStatus = ISPTarget_WaitWhileTargetBusy();\r
                        break;\r
        }\r
 \r
@@ -151,7 +148,7 @@ uint8_t V2Protocol_WaitForProgComplete(uint8_t ProgrammingMode, uint16_t PollAdd
  *\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
+uint8_t ISPTarget_WaitWhileTargetBusy(void)\r
 {\r
        TCNT0 = 0;\r
        \r
@@ -174,7 +171,7 @@ uint8_t V2Protocol_WaitWhileTargetBusy(void)
  *  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
+void ISPTarget_LoadExtendedAddress(void)\r
 {\r
        SPI_SendByte(0x4D);\r
        SPI_SendByte(0x00);\r
index 0de7b39..121d789 100644 (file)
 \r
 /** \file\r
  *\r
- *  Header file for V2ProtocolTarget.c.\r
+ *  Header file for ISPTarget.c.\r
  */\r
 \r
-#ifndef _V2_PROTOCOL_TARGET_\r
-#define _V2_PROTOCOL_TARGET_\r
+#ifndef _ISP_TARGET_\r
+#define _ISP_TARGET_\r
 \r
        /* Includes: */\r
                #include <avr/io.h>\r
 \r
        /* Macros: */\r
                /** Total number of allowable ISP programming speeds supported by the device */\r
-               #define TOTAL_PROGRAMMING_SPEEDS  7\r
-\r
-               /** Timeout in milliseconds of target busy-wait loops waiting for a command to complete */\r
-               #define TARGET_BUSY_TIMEOUT_MS    240\r
-               \r
-       /* External Variables: */\r
-               extern uint32_t CurrentAddress;\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 V2Protocol_DelayMS(uint8_t DelayMS)\r
-               {\r
-                       TCNT0 = 0;\r
-                       while (TCNT0 < DelayMS);\r
-               }\r
+               #define TOTAL_ISP_PROGRAMMING_SPEEDS  7\r
 \r
        /* Function Prototypes: */\r
-                       uint8_t V2Protocol_GetSPIPrescalerMask(void);\r
-                       void    V2Protocol_ChangeTargetResetLine(bool ResetTarget);\r
-                       void    V2Protocol_DelayMS(uint8_t MS);\r
-                       uint8_t V2Protocol_WaitForProgComplete(uint8_t ProgrammingMode, uint16_t PollAddress, uint8_t PollValue,\r
+                       uint8_t ISPTarget_GetSPIPrescalerMask(void);\r
+                       void    ISPTarget_ChangeTargetResetLine(bool ResetTarget);\r
+                       uint8_t ISPTarget_WaitForProgComplete(uint8_t ProgrammingMode, uint16_t PollAddress, uint8_t PollValue,\r
                                                    uint8_t DelayMS, uint8_t ReadMemCommand);\r
-                       uint8_t V2Protocol_WaitWhileTargetBusy(void);\r
-                       void    V2Protocol_LoadExtendedAddress(void);\r
+                       uint8_t ISPTarget_WaitWhileTargetBusy(void);\r
+                       void    ISPTarget_LoadExtendedAddress(void);\r
 \r
 #endif\r
index e89c5e8..bc63e95 100644 (file)
@@ -130,6 +130,7 @@ SRC = $(TARGET).c                                                 \
       Lib/V2Protocol.c                                            \\r
       Lib/V2ProtocolParams.c                                      \\r
       Lib/V2ProtocolTarget.c                                      \\r
+      Lib/ISPProtocol.c                                           \\r
          $(LUFA_PATH)/LUFA/Drivers/USB/LowLevel/DevChapter9.c        \\r
          $(LUFA_PATH)/LUFA/Drivers/USB/LowLevel/Endpoint.c           \\r
          $(LUFA_PATH)/LUFA/Drivers/USB/LowLevel/Host.c               \\r