Complete initial working revision of PDI programming in the AVRISP project (XMEGAs...

[pub/USBasp.git] / Projects / AVRISP / Lib / PDIProtocol.c

diff --git a/Projects/AVRISP/Lib/PDIProtocol.c b/Projects/AVRISP/Lib/PDIProtocol.c
index aa03fc4..1b3fc53 100644 (file)
--- a/Projects/AVRISP/Lib/PDIProtocol.c
+++ b/Projects/AVRISP/Lib/PDIProtocol.c
@@ -37,8 +37,6 @@
 #include "PDIProtocol.h"\r
 \r
 #if defined(ENABLE_PDI_PROTOCOL) || defined(__DOXYGEN__)\r
-#warning PDI Programming Protocol support is incomplete and not currently suitable for general use.\r
-\r
 /** Base absolute address for the target's NVM controller */\r
 uint32_t XPROG_Param_NVMBase;\r
 \r
@@ -164,6 +162,7 @@ static void PDIProtocol_Erase(void)
        \r
        uint8_t EraseCommand = NVM_CMD_NOOP;\r
        \r
+       /* Determine which NVM command to send to the device depending on the memory to erase */\r
        if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP)\r
          EraseCommand = NVM_CMD_CHIPERASE;\r
        else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP)\r
@@ -181,6 +180,7 @@ static void PDIProtocol_Erase(void)
        else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_USERSIG)\r
          EraseCommand = NVM_CMD_ERASEUSERSIG;\r
        \r
+       /* Erase the target memory, indicate timeout if ocurred */\r
        if (!(NVMTarget_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))\r
          ReturnStatus = XPRG_ERR_TIMEOUT;\r
        \r
@@ -213,65 +213,51 @@ static void PDIProtocol_WriteMemory(void)
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
 \r
-\r
-       uint8_t WriteCommand     = NVM_CMD_NOOP;\r
-       uint8_t WriteBuffCommand = NVM_CMD_NOOP;\r
-       uint8_t EraseBuffCommand = NVM_CMD_NOOP;\r
-       bool    PagedMemory      = false;\r
+       /* Assume FLASH page programming by default, as it is the common case */\r
+       uint8_t WriteCommand     = NVM_CMD_WRITEFLASHPAGE;\r
+       uint8_t WriteBuffCommand = NVM_CMD_LOADFLASHPAGEBUFF;\r
+       uint8_t EraseBuffCommand = NVM_CMD_ERASEFLASHPAGEBUFF;\r
+       bool    PagedMemory      = true;\r
        \r
        if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_APPL)\r
        {\r
-               WriteCommand     = NVM_CMD_ERASEWRITEFLASH;\r
-               WriteBuffCommand = NVM_CMD_LOADFLASHPAGEBUFF;\r
-               EraseBuffCommand = NVM_CMD_ERASEFLASHPAGEBUFF;\r
-               PagedMemory      = true;\r
+               WriteCommand     = NVM_CMD_WRITEAPPSECPAGE;\r
        }\r
        else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_BOOT)\r
        {\r
-               WriteCommand     = NVM_CMD_ERASEWRITEFLASH;\r
-               WriteBuffCommand = NVM_CMD_LOADFLASHPAGEBUFF;\r
-               EraseBuffCommand = NVM_CMD_ERASEFLASHPAGEBUFF;\r
-               PagedMemory      = true;\r
+               WriteCommand     = NVM_CMD_WRITEBOOTSECPAGE;\r
        }\r
        else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_EEPROM)\r
        {\r
-               WriteCommand     = NVM_CMD_ERASEWRITEEEPROMPAGE;\r
+               WriteCommand     = NVM_CMD_WRITEEEPROMPAGE;\r
                WriteBuffCommand = NVM_CMD_LOADEEPROMPAGEBUFF;\r
                EraseBuffCommand = NVM_CMD_ERASEEEPROMPAGEBUFF;\r
-               PagedMemory      = true;\r
        }\r
        else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_USERSIG)\r
        {\r
+               /* User signature is paged, but needs us to manually indicate the mode bits since the host doesn't set them */\r
+               WriteMemory_XPROG_Params.PageMode = (XPRG_PAGEMODE_ERASE | XPRG_PAGEMODE_WRITE);\r
                WriteCommand     = NVM_CMD_WRITEUSERSIG;\r
-               WriteBuffCommand = NVM_CMD_LOADFLASHPAGEBUFF;\r
-               EraseBuffCommand = NVM_CMD_ERASEFLASHPAGEBUFF;\r
-               PagedMemory      = true;\r
        }\r
        else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_FUSE)\r
        {\r
-               WriteCommand = NVM_CMD_WRITEFUSE;\r
+               WriteCommand     = NVM_CMD_WRITEFUSE;\r
+               PagedMemory      = false;\r
        }\r
        else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_LOCKBITS)\r
        {\r
-               WriteCommand = NVM_CMD_WRITELOCK;\r
+               WriteCommand     = NVM_CMD_WRITELOCK;\r
+               PagedMemory      = false;\r
        }\r
        \r
-       if (PagedMemory)\r
-       {\r
-               if (!(NVMTarget_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand, \r
-                                               WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,\r
-                                               WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length)))\r
-               {\r
-                       ReturnStatus = XPRG_ERR_TIMEOUT;\r
-               }\r
-       }\r
-       else\r
+       /* Send the appropriate memory write commands to the device, indicate timeout if occurred */\r
+       if ((PagedMemory && !NVMTarget_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand, \r
+                                                          WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,\r
+                                                          WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length)) ||\r
+          (!PagedMemory && !NVMTarget_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address,\r
+                                                      WriteMemory_XPROG_Params.ProgData)))\r
        {\r
-               if (!(NVMTarget_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address, WriteMemory_XPROG_Params.ProgData,\r
-                                                                               WriteMemory_XPROG_Params.Length)))\r
-               {\r
-                       ReturnStatus = XPRG_ERR_TIMEOUT;\r
-               }\r
+               ReturnStatus = XPRG_ERR_TIMEOUT;\r
        }\r
        \r
        Endpoint_Write_Byte(CMD_XPROG);\r
@@ -301,8 +287,9 @@ static void PDIProtocol_ReadMemory(void)
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
 \r
-       uint8_t ReadBuffer[ReadMemory_XPROG_Params.Length];\r
+       uint8_t ReadBuffer[256];\r
        \r
+       /* Read the target's memory, indicate timeout if occurred */\r
        if (!(NVMTarget_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))\r
          ReturnStatus = XPRG_ERR_TIMEOUT;\r
 \r
@@ -335,6 +322,7 @@ static void PDIProtocol_ReadCRC(void)
        uint8_t  CRCCommand = NVM_CMD_NOOP;\r
        uint32_t MemoryCRC;\r
 \r
+       /* Determine which NVM command to send to the device depending on the memory to CRC */\r
        if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_APP)\r
          CRCCommand = NVM_CMD_APPCRC;\r
        else if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_BOOT)\r
@@ -342,6 +330,7 @@ static void PDIProtocol_ReadCRC(void)
        else\r
          CRCCommand = NVM_CMD_FLASHCRC;\r
        \r
+       /* Perform and retrieve the memory CRC, indicate timeout if occurred */\r
        if (!(NVMTarget_GetMemoryCRC(CRCCommand, &MemoryCRC)))\r
          ReturnStatus = XPRG_ERR_TIMEOUT;\r
        \r
@@ -367,6 +356,7 @@ static void PDIProtocol_SetParam(void)
 \r
        uint8_t XPROGParam = Endpoint_Read_Byte();\r
        \r
+       /* Determine which parameter is being set, store the new parameter value */\r
        if (XPROGParam == XPRG_PARAM_NVMBASE)\r
          XPROG_Param_NVMBase = Endpoint_Read_DWord_BE();\r
        else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE)\r