Speed up bit-banged USART code in the AVRISP project.

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

diff --git a/Projects/AVRISP/Lib/PDIProtocol.c b/Projects/AVRISP/Lib/PDIProtocol.c
index b095a49..1b3fc53 100644 (file)
--- a/Projects/AVRISP/Lib/PDIProtocol.c
+++ b/Projects/AVRISP/Lib/PDIProtocol.c
@@ -28,17 +28,19 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

-#if defined(ENABLE_XPROG_PROTOCOL)\r
-\r

 /** \file\r
  *\r
  *  PDI Protocol handler, to process V2 Protocol wrapped PDI commands used in Atmel programmer devices.\r
  */\r
 \r
 /** \file\r
  *\r
  *  PDI Protocol handler, to process V2 Protocol wrapped PDI commands used in Atmel programmer devices.\r
  */\r
 \r

-#define  INCLUDE_FROM_XPROG_C\r
+#define  INCLUDE_FROM_PDIPROTOCOL_C\r

 #include "PDIProtocol.h"\r
 \r
 #include "PDIProtocol.h"\r
 \r

+#if defined(ENABLE_PDI_PROTOCOL) || defined(__DOXYGEN__)\r
+/** Base absolute address for the target's NVM controller */\r

 uint32_t XPROG_Param_NVMBase;\r
 uint32_t XPROG_Param_NVMBase;\r

+\r
+/** Size in bytes of the target's EEPROM page */\r

 uint32_t XPROG_Param_EEPageSize;\r
 \r
 /** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI\r
 uint32_t XPROG_Param_EEPageSize;\r
 \r
 /** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI\r


@@ -57,10 +59,13 @@ void PDIProtocol_XPROG_SetMode(void)
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
        \r
        Endpoint_Write_Byte(CMD_XPROG_SETMODE);\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
        \r
        Endpoint_Write_Byte(CMD_XPROG_SETMODE);\r

-       Endpoint_Write_Byte(SetMode_XPROG_Params.Protocol ? STATUS_CMD_FAILED : STATUS_CMD_OK);\r
+       Endpoint_Write_Byte((SetMode_XPROG_Params.Protocol == XPRG_PROTOCOL_PDI) ? STATUS_CMD_OK : STATUS_CMD_FAILED);\r

        Endpoint_ClearIN();     \r
 }\r
 \r
        Endpoint_ClearIN();     \r
 }\r
 \r

+/** Handler for the CMD_XPROG command, which wraps up XPROG commands in a V2 wrapper which need to be\r
+ *  removed and processed so that the underlying XPROG command can be handled.\r
+ */\r

 void PDIProtocol_XPROG_Command(void)\r
 {\r
        uint8_t XPROGCommand = Endpoint_Read_Byte();\r
 void PDIProtocol_XPROG_Command(void)\r
 {\r
        uint8_t XPROGCommand = Endpoint_Read_Byte();\r


@@ -74,7 +79,7 @@ void PDIProtocol_XPROG_Command(void)
                        PDIProtocol_LeaveXPROGMode();\r
                        break;\r
                case XPRG_CMD_ERASE:\r
                        PDIProtocol_LeaveXPROGMode();\r
                        break;\r
                case XPRG_CMD_ERASE:\r

-                       PDIProtocol_EraseChip();\r
+                       PDIProtocol_Erase();\r

                        break;\r
                case XPRG_CMD_WRITE_MEM:\r
                        PDIProtocol_WriteMemory();\r
                        break;\r
                case XPRG_CMD_WRITE_MEM:\r
                        PDIProtocol_WriteMemory();\r


@@ -91,7 +96,55 @@ void PDIProtocol_XPROG_Command(void)
        }\r
 }\r
 \r
        }\r
 }\r
 \r

-static void PDIProtocol_EraseChip(void)\r
+/** Handler for the XPROG ENTER_PROGMODE command to establish a PDI connection with the attached device. */\r
+static void PDIProtocol_EnterXPROGMode(void)\r
+{\r
+       Endpoint_ClearOUT();\r
+       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
+       \r
+       /* Enable PDI programming mode with the attached target */\r
+       PDITarget_EnableTargetPDI();\r
+       \r
+       /* Store the RESET key into the RESET PDI register to keep the XMEGA in reset */\r
+       PDITarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);       \r
+       PDITarget_SendByte(PDI_RESET_KEY);\r
+\r
+       /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */\r
+       PDITarget_SendByte(PDI_CMD_KEY);        \r
+       for (uint8_t i = sizeof(PDI_NVMENABLE_KEY); i > 0; i--)\r
+         PDITarget_SendByte(PDI_NVMENABLE_KEY[i - 1]);\r
+\r
+       /* Wait until the NVM bus becomes active */\r
+       bool NVMBusEnabled = PDITarget_WaitWhileNVMBusBusy();\r
+       \r
+       Endpoint_Write_Byte(CMD_XPROG);\r
+       Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);\r
+       Endpoint_Write_Byte(NVMBusEnabled ? XPRG_ERR_OK : XPRG_ERR_FAILED);\r
+       Endpoint_ClearIN();\r
+}\r
+\r
+/** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with\r
+ *  the attached device.\r
+ */\r
+static void PDIProtocol_LeaveXPROGMode(void)\r
+{\r
+       Endpoint_ClearOUT();\r
+       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
+       \r
+       /* Clear the RESET key in the RESET PDI register to allow the XMEGA to run */\r
+       PDITarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);       \r
+       PDITarget_SendByte(0x00);\r
+\r
+       PDITarget_DisableTargetPDI();\r
+\r
+       Endpoint_Write_Byte(CMD_XPROG);\r
+       Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);\r
+       Endpoint_Write_Byte(XPRG_ERR_OK);\r
+       Endpoint_ClearIN();\r
+}\r
+\r
+/** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */\r
+static void PDIProtocol_Erase(void)\r

 {\r
        uint8_t ReturnStatus = XPRG_ERR_OK;\r
 \r
 {\r
        uint8_t ReturnStatus = XPRG_ERR_OK;\r
 \r


@@ -102,11 +155,34 @@ static void PDIProtocol_EraseChip(void)
        } Erase_XPROG_Params;\r
 \r
        Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params));\r
        } Erase_XPROG_Params;\r
 \r
        Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params));\r

+       Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address);\r

 \r
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
        \r
 \r
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
        \r

-       // TODO: Send erase command here via PDI protocol\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
+         EraseCommand = NVM_CMD_ERASEAPPSEC;\r
+       else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT)\r
+         EraseCommand = NVM_CMD_ERASEBOOTSEC;\r
+       else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM)\r
+         EraseCommand = NVM_CMD_ERASEEEPROM;\r
+       else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP_PAGE)\r
+         EraseCommand = NVM_CMD_ERASEAPPSECPAGE;\r
+       else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT_PAGE)\r
+         EraseCommand = NVM_CMD_ERASEBOOTSECPAGE;\r
+       else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM_PAGE)\r
+         EraseCommand = NVM_CMD_ERASEEEPROMPAGE;\r
+       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
        Endpoint_Write_Byte(CMD_XPROG);\r
        Endpoint_Write_Byte(XPRG_CMD_ERASE);\r
        \r
        Endpoint_Write_Byte(CMD_XPROG);\r
        Endpoint_Write_Byte(XPRG_CMD_ERASE);\r


@@ -114,6 +190,7 @@ static void PDIProtocol_EraseChip(void)
        Endpoint_ClearIN();     \r
 }\r
 \r
        Endpoint_ClearIN();     \r
 }\r
 \r

+/** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */\r

 static void PDIProtocol_WriteMemory(void)\r
 {\r
        uint8_t ReturnStatus = XPRG_ERR_OK;\r
 static void PDIProtocol_WriteMemory(void)\r
 {\r
        uint8_t ReturnStatus = XPRG_ERR_OK;\r


@@ -121,6 +198,7 @@ static void PDIProtocol_WriteMemory(void)
        struct\r
        {\r
                uint8_t  MemoryType;\r
        struct\r
        {\r
                uint8_t  MemoryType;\r

+               uint8_t  PageMode;\r

                uint32_t Address;\r
                uint16_t Length;\r
                uint8_t  ProgData[256];\r
                uint32_t Address;\r
                uint16_t Length;\r
                uint8_t  ProgData[256];\r


@@ -134,15 +212,63 @@ static void PDIProtocol_WriteMemory(void)
 \r
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
 \r
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r

+\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
        \r

-       // TODO: Send program command here via PDI protocol\r
+       if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_APPL)\r
+       {\r
+               WriteCommand     = NVM_CMD_WRITEAPPSECPAGE;\r
+       }\r
+       else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_BOOT)\r
+       {\r
+               WriteCommand     = NVM_CMD_WRITEBOOTSECPAGE;\r
+       }\r
+       else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_EEPROM)\r
+       {\r
+               WriteCommand     = NVM_CMD_WRITEEEPROMPAGE;\r
+               WriteBuffCommand = NVM_CMD_LOADEEPROMPAGEBUFF;\r
+               EraseBuffCommand = NVM_CMD_ERASEEEPROMPAGEBUFF;\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
+       }\r
+       else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_FUSE)\r
+       {\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
+               PagedMemory      = false;\r
+       }\r
+       \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
+               ReturnStatus = XPRG_ERR_TIMEOUT;\r
+       }\r

        \r
        Endpoint_Write_Byte(CMD_XPROG);\r
        \r
        Endpoint_Write_Byte(CMD_XPROG);\r

-       Endpoint_Write_Byte(XPRG_CMD_READ_MEM);\r
+       Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM);\r

        Endpoint_Write_Byte(ReturnStatus);      \r
        Endpoint_ClearIN();\r
 }\r
 \r
        Endpoint_Write_Byte(ReturnStatus);      \r
        Endpoint_ClearIN();\r
 }\r
 \r

+/** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the\r
+ *  attached device.\r
+ */\r

 static void PDIProtocol_ReadMemory(void)\r
 {\r
        uint8_t ReturnStatus = XPRG_ERR_OK;\r
 static void PDIProtocol_ReadMemory(void)\r
 {\r
        uint8_t ReturnStatus = XPRG_ERR_OK;\r


@@ -160,41 +286,53 @@ static void PDIProtocol_ReadMemory(void)
 \r
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
 \r
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r

+\r
+       uint8_t ReadBuffer[256];\r

        \r
        \r

-       // TODO: Send read command here via PDI protocol\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

        Endpoint_Write_Byte(CMD_XPROG);\r
        Endpoint_Write_Byte(XPRG_CMD_READ_MEM);\r
        Endpoint_Write_Byte(ReturnStatus);\r
        Endpoint_Write_Byte(CMD_XPROG);\r
        Endpoint_Write_Byte(XPRG_CMD_READ_MEM);\r
        Endpoint_Write_Byte(ReturnStatus);\r

-\r
-       // START TEMP\r
-       uint8_t ProgData[256];\r
-       for (uint16_t i = 0; i < ReadMemory_XPROG_Params.Length; i++)\r
-         ProgData[i] = i;\r
-       Endpoint_Write_Stream_LE(ProgData, ReadMemory_XPROG_Params.Length);\r
-\r
-       if (!Endpoint_IsReadWriteAllowed())\r
-       {\r
-               Endpoint_ClearIN();     \r
-               while(!(Endpoint_IsReadWriteAllowed()));\r
-       }\r
-       // END TEMP\r
+       \r
+       if (ReturnStatus == XPRG_ERR_OK)\r
+         Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length);\r

        \r
        Endpoint_ClearIN();\r
 }\r
 \r
        \r
        Endpoint_ClearIN();\r
 }\r
 \r

+/** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the\r
+ *  attached device's memory and a data set on the host.\r
+ */\r

 static void PDIProtocol_ReadCRC(void)\r
 {\r
        uint8_t ReturnStatus = XPRG_ERR_OK;\r
 static void PDIProtocol_ReadCRC(void)\r
 {\r
        uint8_t ReturnStatus = XPRG_ERR_OK;\r

-\r
-       uint8_t CRCType = Endpoint_Read_Byte();\r

        \r
        \r

+       struct\r
+       {\r
+               uint8_t CRCType;\r
+       } ReadCRC_XPROG_Params;\r
+       \r
+       Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params));\r

        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
        \r
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
        \r

-       uint32_t MemoryCRC = 0;\r
+       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
+         CRCCommand = NVM_CMD_BOOTCRC;\r
+       else\r
+         CRCCommand = NVM_CMD_FLASHCRC;\r

        \r
        \r

-       // TODO: Read device CRC for desired memory via PDI protocol\r
+       /* Perform and retrieve the memory CRC, indicate timeout if occurred */\r
+       if (!(NVMTarget_GetMemoryCRC(CRCCommand, &MemoryCRC)))\r
+         ReturnStatus = XPRG_ERR_TIMEOUT;\r

        \r
        Endpoint_Write_Byte(CMD_XPROG);\r
        Endpoint_Write_Byte(XPRG_CMD_CRC);\r
        \r
        Endpoint_Write_Byte(CMD_XPROG);\r
        Endpoint_Write_Byte(XPRG_CMD_CRC);\r


@@ -209,44 +347,20 @@ static void PDIProtocol_ReadCRC(void)
        Endpoint_ClearIN();     \r
 }\r
 \r
        Endpoint_ClearIN();     \r
 }\r
 \r

-static void PDIProtocol_EnterXPROGMode(void)\r
-{\r
-       uint8_t ReturnStatus = XPRG_ERR_OK;\r
-\r
-       Endpoint_ClearOUT();\r
-       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
-       \r
-       // TODO: Enter device programming mode here via PDI protocol\r
-       \r
-       Endpoint_Write_Byte(CMD_XPROG);\r
-       Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);\r
-       Endpoint_Write_Byte(ReturnStatus);\r
-       Endpoint_ClearIN();\r
-}\r
-\r
-static void PDIProtocol_LeaveXPROGMode(void)\r
-{\r
-       Endpoint_ClearOUT();\r
-       Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
-       \r
-       // TODO: Exit device programming mode here via PDI protocol\r
-\r
-       Endpoint_Write_Byte(CMD_XPROG);\r
-       Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);\r
-       Endpoint_Write_Byte(XPRG_ERR_OK);\r
-       Endpoint_ClearIN();\r
-}\r
-\r
+/** Handler for the XPROG SET_PARAM command to set a PDI parameter for use when communicating with the\r
+ *  attached device.\r
+ */\r

 static void PDIProtocol_SetParam(void)\r
 {\r
        uint8_t ReturnStatus = XPRG_ERR_OK;\r
 \r
        uint8_t XPROGParam = Endpoint_Read_Byte();\r
        \r
 static void PDIProtocol_SetParam(void)\r
 {\r
        uint8_t ReturnStatus = XPRG_ERR_OK;\r
 \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
        if (XPROGParam == XPRG_PARAM_NVMBASE)\r

-         XPROG_Param_NVMBase = Endpoint_Read_DWord_LE();\r
+         XPROG_Param_NVMBase = Endpoint_Read_DWord_BE();\r

        else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE)\r
        else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE)\r

-         XPROG_Param_EEPageSize = Endpoint_Read_Word_LE();\r
+         XPROG_Param_EEPageSize = Endpoint_Read_Word_BE();\r

        else\r
          ReturnStatus = XPRG_ERR_FAILED;\r
        \r
        else\r
          ReturnStatus = XPRG_ERR_FAILED;\r
        \r