Oops - wrong casting on the Configuration Descriptor pointer advance routine.

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

diff --git a/Projects/AVRISP/Lib/PDIProtocol.c b/Projects/AVRISP/Lib/PDIProtocol.c
index c919561..ecd2fe9 100644 (file)
--- a/Projects/AVRISP/Lib/PDIProtocol.c
+++ b/Projects/AVRISP/Lib/PDIProtocol.c
@@ -28,7 +28,9 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

-#if defined(ENABLE_XPROG_PROTOCOL)\r
+#if defined(ENABLE_PDI_PROTOCOL) || defined(__DOXYGEN__)\r
+\r
+#warning PDI Programming Protocol support is incomplete and not currently suitable for use.\r

 \r
 /** \file\r
  *\r
 \r
 /** \file\r
  *\r


@@ -61,6 +63,9 @@ void PDIProtocol_XPROG_SetMode(void)
        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,60 +96,55 @@ void PDIProtocol_XPROG_Command(void)
        }\r
 }\r
 \r
        }\r
 }\r
 \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
 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
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
        \r

-       PDIDATA_LINE_DDR  |= PDIDATA_LINE_MASK;\r
-       PDICLOCK_LINE_DDR |= PDICLOCK_LINE_MASK;\r
+       /* Enable PDI programming mode with the attached target */\r
+       PDITarget_EnableTargetPDI();\r

        \r
        \r

-       PDIDATA_LINE_PORT |= PDIDATA_LINE_MASK;\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
 \r

-       _delay_us(1);\r
-       \r
-       for (uint8_t i = 0; i < 16; i++)\r
-       {\r
-               PDICLOCK_LINE_PORT ^= PDICLOCK_LINE_MASK;\r
-               PDICLOCK_LINE_PORT ^= PDICLOCK_LINE_MASK;\r
-       }\r
-               \r
-       static const uint8_t NVMKey[8] = {0x12, 0x89, 0xAB, 0x45, 0xCD, 0xD8, 0x88, 0xFF};\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
        PDITarget_SendByte(PDI_CMD_KEY);        \r

-       for (uint8_t i = 0; i < 8; i++)\r
-         PDITarget_SendByte(NVMKey[i]);\r
+       for (uint8_t i = sizeof(PDI_NVMENABLE_KEY); i > 0; i--)\r
+         PDITarget_SendByte(PDI_NVMENABLE_KEY[i - 1]);\r

 \r
 \r

-       PDITarget_SendByte(PDI_CMD_LDCS | PD_STATUS_REG);       \r
-       if (!(PDITarget_ReceiveByte() & PDI_STATUS_NVM))\r
-         ReturnStatus = XPRG_ERR_FAILED;\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
        \r
        Endpoint_Write_Byte(CMD_XPROG);\r
        Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);\r

-       Endpoint_Write_Byte(ReturnStatus);\r
+       Endpoint_Write_Byte(NVMBusEnabled ? XPRG_ERR_OK : XPRG_ERR_FAILED);\r

        Endpoint_ClearIN();\r
 }\r
 \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
 static void PDIProtocol_LeaveXPROGMode(void)\r
 {\r
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
        \r

-       PDIDATA_LINE_DDR   &= ~PDIDATA_LINE_MASK;\r
-       PDICLOCK_LINE_DDR  &= ~PDICLOCK_LINE_MASK;\r
+       /* Clear the RESET key into 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
 \r

-       PDIDATA_LINE_PORT  &= ~PDIDATA_LINE_MASK;\r
-       PDICLOCK_LINE_PORT &= ~PDICLOCK_LINE_MASK;\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
        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

-static void PDIProtocol_EraseChip(void)\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


@@ -167,6 +167,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


@@ -196,6 +197,9 @@ static void PDIProtocol_WriteMemory(void)
        Endpoint_ClearIN();\r
 }\r
 \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


@@ -214,40 +218,68 @@ static void PDIProtocol_ReadMemory(void)
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
        \r
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
        \r

-       // TODO: Send read command here via PDI protocol\r
+       if (ReadMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_USERSIG)\r
+       {\r
+               PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_1BYTE << 2));\r
+               PDITarget_SendAddress(DATAMEM_BASE | DATAMEM_NVM_CMD);\r
+               PDITarget_SendByte(NVM_CMD_READUSERSIG);\r
+\r
+               \r
+       }\r

        \r
        Endpoint_Write_Byte(CMD_XPROG);\r
        Endpoint_Write_Byte(XPRG_CMD_READ_MEM);\r
        Endpoint_Write_Byte(ReturnStatus);\r
        \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
        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
        uint32_t MemoryCRC = 0;\r
        Endpoint_ClearOUT();\r
        Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
        \r
        uint32_t MemoryCRC = 0;\r

+       uint8_t  CRCReadCommand;\r
+\r
+       if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_APP)\r
+         CRCReadCommand = NVM_CMD_APPCRC;\r
+       else if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_BOOT)\r
+         CRCReadCommand = NVM_CMD_BOOTCRC;\r
+       else\r
+         CRCReadCommand = NVM_CMD_FLASHCRC;\r

        \r
        \r

-       // TODO: Read device CRC for desired memory via PDI protocol\r
+       /* Set the NVM command to the correct CRC read command */\r
+       PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_1BYTE << 2));\r
+       PDITarget_SendAddress(DATAMEM_BASE | DATAMEM_NVM_CMD);\r
+       PDITarget_SendByte(CRCReadCommand);\r
+\r
+       /* Set CMDEX bit in NVM CTRLA register to start the CRC generation */\r
+       PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_1BYTE << 2));\r
+       PDITarget_SendAddress(DATAMEM_BASE | DATAMEM_NVM_CTRLA);\r
+       PDITarget_SendByte(1 << 0);\r
+\r
+       /* Wait until the NVM bus and controller is no longer busy */\r
+       PDITarget_WaitWhileNVMBusBusy();\r
+       PDITarget_WaitWhileNVMControllerBusy();\r
+       \r
+       /* Read the three byte generated CRC value */\r
+       PDITarget_SendByte(PDI_CMD_LDS | (PDI_DATSIZE_3BYTES << 2));\r
+       PDITarget_SendAddress(DATAMEM_BASE | DATAMEM_NVM_DAT0);\r
+       MemoryCRC  = PDITarget_ReceiveByte();\r
+       MemoryCRC |= ((uint16_t)PDITarget_ReceiveByte() << 8);\r
+       MemoryCRC |= ((uint32_t)PDITarget_ReceiveByte() << 16);\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


@@ -262,6 +294,9 @@ static void PDIProtocol_ReadCRC(void)
        Endpoint_ClearIN();     \r
 }\r
 \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
 static void PDIProtocol_SetParam(void)\r
 {\r
        uint8_t ReturnStatus = XPRG_ERR_OK;\r