Clean up and add more comments to the AVRISP-MKII project. Make sure the SPI_MULTI...
[pub/USBasp.git] / Projects / AVRISP-MKII / Lib / ISP / ISPProtocol.c
index 3a7e640..936c9ab 100644 (file)
@@ -65,7 +65,9 @@ void ISPProtocol_EnterISPMode(void)
 \r
        ISPProtocol_DelayMS(Enter_ISP_Params.ExecutionDelayMS); \r
        SPI_Init(ISPTarget_GetSPIPrescalerMask() | SPI_SCK_LEAD_RISING | SPI_SAMPLE_LEADING | SPI_MODE_MASTER);\r
-               \r
+\r
+       /* Continuously attempt to synchronize with the target until either the number of attempts specified\r
+        * by the host has exceeded, or the the device sends back the expected response values */\r
        while (Enter_ISP_Params.SynchLoops-- && (ResponseStatus == STATUS_CMD_FAILED))\r
        {\r
                uint8_t ResponseBytes[4];\r
@@ -110,6 +112,7 @@ void ISPProtocol_LeaveISPMode(void)
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
 \r
+       /* Perform pre-exit delay, release the target /RESET, disable the SPI bus and perform the post-exit delay */\r
        ISPProtocol_DelayMS(Leave_ISP_Params.PreDelayMS);\r
        ISPTarget_ChangeTargetResetLine(false);\r
        SPI_ShutDown();\r
@@ -166,6 +169,9 @@ void ISPProtocol_ProgramMemory(uint8_t V2Command)
                                                                            Write_Memory_Params.PollValue2;\r
        uint8_t* NextWriteByte = Write_Memory_Params.ProgData;\r
 \r
+       /* Check to see if the host has issued a SET ADDRESS command and we haven't sent a\r
+        * LOAD EXTENDED ADDRESS command (if needed, used when operating beyond the 128KB\r
+        * FLASH barrier) */\r
        if (MustSetAddress)\r
        {\r
                if (CurrentAddress & (1UL << 31))\r
@@ -174,6 +180,7 @@ void ISPProtocol_ProgramMemory(uint8_t V2Command)
                MustSetAddress = false;\r
        }\r
 \r
+       /* Check the programming mode desired by the host, either Paged or Word memory writes */\r
        if (Write_Memory_Params.ProgrammingMode & PROG_MODE_PAGED_WRITES_MASK)\r
        {\r
                uint16_t StartAddress = (CurrentAddress & 0xFFFF);\r
@@ -184,16 +191,16 @@ void ISPProtocol_ProgramMemory(uint8_t V2Command)
                        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
+                       /* AVR FLASH addressing requires us to modify the write command based on if we are writing a high\r
+                        * or low byte at the current word address */\r
+                       Write_Memory_Params.ProgrammingCommands[0] ^= READ_WRITE_HIGH_BYTE_MASK;\r
+\r
+                       /* Check to see the write completion method, to see if we have a valid polling address */\r
                        if (!(PollAddress) && (ByteToWrite != PollValue))\r
                        {\r
                                if (IsOddByte && (V2Command == CMD_PROGRAM_FLASH_ISP))\r
@@ -289,6 +296,9 @@ void ISPProtocol_ReadMemory(uint8_t V2Command)
        Endpoint_Write_Byte(V2Command);\r
        Endpoint_Write_Byte(STATUS_CMD_OK);\r
        \r
+       /* Check to see if the host has issued a SET ADDRESS command and we haven't sent a\r
+        * LOAD EXTENDED ADDRESS command (if needed, used when operating beyond the 128KB\r
+        * FLASH barrier) */\r
        if (MustSetAddress)\r
        {\r
                if (CurrentAddress & (1UL << 31))\r
@@ -297,28 +307,30 @@ void ISPProtocol_ReadMemory(uint8_t V2Command)
                MustSetAddress = false;\r
        }\r
 \r
+       /* Read each byte from the device and write them to the packet for the host */\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
+               /* Read the next byte from the desired memory space in the device */\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
+               /* Check if the endpoint bank is currently full, if so send the packet */\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
+               /* AVR FLASH addressing requires us to modify the read command based on if we are reading a high\r
+                * or low byte at the current word address */\r
+               if (V2Command == CMD_READ_FLASH_ISP)\r
+                 Read_Memory_Params.ReadMemoryCommand ^= READ_WRITE_HIGH_BYTE_MASK;\r
+\r
+               /* Only increment the current address if we have read both bytes in the current word when in FLASH\r
+                * read mode, or for each byte when in EEPROM read mode */               \r
+               if (((CurrentByte & 0x01) && (V2Command == CMD_READ_FLASH_ISP)) || (V2Command == CMD_READ_EEPROM_ISP))\r
                  CurrentAddress++;\r
        }\r
 \r
@@ -353,9 +365,11 @@ void ISPProtocol_ChipErase(void)
        \r
        uint8_t ResponseStatus = STATUS_CMD_OK;\r
        \r
+       /* Send the chip erase commands as given by the host to the device */\r
        for (uint8_t SByte = 0; SByte < sizeof(Erase_Chip_Params.EraseCommandBytes); SByte++)\r
          SPI_SendByte(Erase_Chip_Params.EraseCommandBytes[SByte]);\r
 \r
+       /* Use appropriate command completion check as given by the host (delay or busy polling) */\r
        if (!(Erase_Chip_Params.PollMethod))\r
          ISPProtocol_DelayMS(Erase_Chip_Params.EraseDelayMS);\r
        else\r
@@ -385,7 +399,8 @@ void ISPProtocol_ReadFuseLockSigOSCCAL(uint8_t V2Command)
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
 \r
        uint8_t ResponseBytes[4];\r
-               \r
+\r
+       /* Send the Fuse or Lock byte read commands as given by the host to the device, store response */\r
        for (uint8_t RByte = 0; RByte < sizeof(ResponseBytes); RByte++)\r
          ResponseBytes[RByte] = SPI_TransferByte(Read_FuseLockSigOSCCAL_Params.ReadCommandBytes[RByte]);\r
                \r
@@ -413,6 +428,7 @@ void ISPProtocol_WriteFuseLock(uint8_t V2Command)
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
 \r
+       /* Send the Fuse or Lock byte program commands as given by the host to the device */\r
        for (uint8_t SByte = 0; SByte < sizeof(Write_FuseLockSig_Params.WriteCommandBytes); SByte++)\r
          SPI_SendByte(Write_FuseLockSig_Params.WriteCommandBytes[SByte]);\r
                \r
@@ -463,12 +479,29 @@ void ISPProtocol_SPIMulti(void)
                  Endpoint_Write_Byte(SPI_TransferByte(SPI_Multi_Params.TxData[CurrTxPos++]));\r
                else\r
                  Endpoint_Write_Byte(SPI_ReceiveByte());\r
+                 \r
+               /* Check to see if we have filled the endpoint bank and need to send the packet */\r
+               if (!(Endpoint_IsReadWriteAllowed()))\r
+               {\r
+                       Endpoint_ClearIN();\r
+                       Endpoint_WaitUntilReady();\r
+               }\r
                \r
                CurrRxPos++;\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
 #endif
\ No newline at end of file