+/*\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
+#if defined(ENABLE_ISP_PROTOCOL) || defined(__DOXYGEN__)\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
+ ISPProtocol_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
+ ISPProtocol_DelayMS(Enter_ISP_Params.PinStabDelayMS);\r
+\r
+ for (uint8_t RByte = 0; RByte < sizeof(ResponseBytes); RByte++)\r
+ {\r
+ ISPProtocol_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
+ ISPProtocol_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
+ ISPProtocol_DelayMS(Leave_ISP_Params.PreDelayMS);\r
+ ISPTarget_ChangeTargetResetLine(false);\r
+ SPI_ShutDown();\r
+ ISPProtocol_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) -\r
+ sizeof(Write_Memory_Params.ProgData)));\r
+\r
+\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
+ ISPProtocol_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
+\r
+#endif
\ No newline at end of file
projects / pub / lufa.git / blobdiff