X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/1f8dfd0205d431351425f468627984280b21cd5a..4f74075fad7f1e7a35d04ff534d9d6a57d2b97fc:/Projects/AVRISP/Lib/PDIProtocol.c diff --git a/Projects/AVRISP/Lib/PDIProtocol.c b/Projects/AVRISP/Lib/PDIProtocol.c index b095a49c5..1b3fc53c4 100644 --- a/Projects/AVRISP/Lib/PDIProtocol.c +++ b/Projects/AVRISP/Lib/PDIProtocol.c @@ -28,17 +28,19 @@ this software. */ -#if defined(ENABLE_XPROG_PROTOCOL) - /** \file * * PDI Protocol handler, to process V2 Protocol wrapped PDI commands used in Atmel programmer devices. */ -#define INCLUDE_FROM_XPROG_C +#define INCLUDE_FROM_PDIPROTOCOL_C #include "PDIProtocol.h" +#if defined(ENABLE_PDI_PROTOCOL) || defined(__DOXYGEN__) +/** Base absolute address for the target's NVM controller */ uint32_t XPROG_Param_NVMBase; + +/** Size in bytes of the target's EEPROM page */ uint32_t XPROG_Param_EEPageSize; /** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI @@ -57,10 +59,13 @@ void PDIProtocol_XPROG_SetMode(void) Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN); Endpoint_Write_Byte(CMD_XPROG_SETMODE); - Endpoint_Write_Byte(SetMode_XPROG_Params.Protocol ? STATUS_CMD_FAILED : STATUS_CMD_OK); + Endpoint_Write_Byte((SetMode_XPROG_Params.Protocol == XPRG_PROTOCOL_PDI) ? STATUS_CMD_OK : STATUS_CMD_FAILED); Endpoint_ClearIN(); } +/** Handler for the CMD_XPROG command, which wraps up XPROG commands in a V2 wrapper which need to be + * removed and processed so that the underlying XPROG command can be handled. + */ void PDIProtocol_XPROG_Command(void) { uint8_t XPROGCommand = Endpoint_Read_Byte(); @@ -74,7 +79,7 @@ void PDIProtocol_XPROG_Command(void) PDIProtocol_LeaveXPROGMode(); break; case XPRG_CMD_ERASE: - PDIProtocol_EraseChip(); + PDIProtocol_Erase(); break; case XPRG_CMD_WRITE_MEM: PDIProtocol_WriteMemory(); @@ -91,7 +96,55 @@ void PDIProtocol_XPROG_Command(void) } } -static void PDIProtocol_EraseChip(void) +/** Handler for the XPROG ENTER_PROGMODE command to establish a PDI connection with the attached device. */ +static void PDIProtocol_EnterXPROGMode(void) +{ + Endpoint_ClearOUT(); + Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN); + + /* Enable PDI programming mode with the attached target */ + PDITarget_EnableTargetPDI(); + + /* Store the RESET key into the RESET PDI register to keep the XMEGA in reset */ + PDITarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG); + PDITarget_SendByte(PDI_RESET_KEY); + + /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */ + PDITarget_SendByte(PDI_CMD_KEY); + for (uint8_t i = sizeof(PDI_NVMENABLE_KEY); i > 0; i--) + PDITarget_SendByte(PDI_NVMENABLE_KEY[i - 1]); + + /* Wait until the NVM bus becomes active */ + bool NVMBusEnabled = PDITarget_WaitWhileNVMBusBusy(); + + Endpoint_Write_Byte(CMD_XPROG); + Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE); + Endpoint_Write_Byte(NVMBusEnabled ? XPRG_ERR_OK : XPRG_ERR_FAILED); + Endpoint_ClearIN(); +} + +/** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with + * the attached device. + */ +static void PDIProtocol_LeaveXPROGMode(void) +{ + Endpoint_ClearOUT(); + Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN); + + /* Clear the RESET key in the RESET PDI register to allow the XMEGA to run */ + PDITarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG); + PDITarget_SendByte(0x00); + + PDITarget_DisableTargetPDI(); + + Endpoint_Write_Byte(CMD_XPROG); + Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE); + Endpoint_Write_Byte(XPRG_ERR_OK); + Endpoint_ClearIN(); +} + +/** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */ +static void PDIProtocol_Erase(void) { uint8_t ReturnStatus = XPRG_ERR_OK; @@ -102,11 +155,34 @@ static void PDIProtocol_EraseChip(void) } Erase_XPROG_Params; Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params)); + Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address); Endpoint_ClearOUT(); Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN); - // TODO: Send erase command here via PDI protocol + uint8_t EraseCommand = NVM_CMD_NOOP; + + /* Determine which NVM command to send to the device depending on the memory to erase */ + if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP) + EraseCommand = NVM_CMD_CHIPERASE; + else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP) + EraseCommand = NVM_CMD_ERASEAPPSEC; + else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT) + EraseCommand = NVM_CMD_ERASEBOOTSEC; + else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM) + EraseCommand = NVM_CMD_ERASEEEPROM; + else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP_PAGE) + EraseCommand = NVM_CMD_ERASEAPPSECPAGE; + else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT_PAGE) + EraseCommand = NVM_CMD_ERASEBOOTSECPAGE; + else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM_PAGE) + EraseCommand = NVM_CMD_ERASEEEPROMPAGE; + else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_USERSIG) + EraseCommand = NVM_CMD_ERASEUSERSIG; + + /* Erase the target memory, indicate timeout if ocurred */ + if (!(NVMTarget_EraseMemory(EraseCommand, Erase_XPROG_Params.Address))) + ReturnStatus = XPRG_ERR_TIMEOUT; Endpoint_Write_Byte(CMD_XPROG); Endpoint_Write_Byte(XPRG_CMD_ERASE); @@ -114,6 +190,7 @@ static void PDIProtocol_EraseChip(void) Endpoint_ClearIN(); } +/** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */ static void PDIProtocol_WriteMemory(void) { uint8_t ReturnStatus = XPRG_ERR_OK; @@ -121,6 +198,7 @@ static void PDIProtocol_WriteMemory(void) struct { uint8_t MemoryType; + uint8_t PageMode; uint32_t Address; uint16_t Length; uint8_t ProgData[256]; @@ -134,15 +212,63 @@ static void PDIProtocol_WriteMemory(void) Endpoint_ClearOUT(); Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN); + + /* Assume FLASH page programming by default, as it is the common case */ + uint8_t WriteCommand = NVM_CMD_WRITEFLASHPAGE; + uint8_t WriteBuffCommand = NVM_CMD_LOADFLASHPAGEBUFF; + uint8_t EraseBuffCommand = NVM_CMD_ERASEFLASHPAGEBUFF; + bool PagedMemory = true; - // TODO: Send program command here via PDI protocol + if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_APPL) + { + WriteCommand = NVM_CMD_WRITEAPPSECPAGE; + } + else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_BOOT) + { + WriteCommand = NVM_CMD_WRITEBOOTSECPAGE; + } + else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_EEPROM) + { + WriteCommand = NVM_CMD_WRITEEEPROMPAGE; + WriteBuffCommand = NVM_CMD_LOADEEPROMPAGEBUFF; + EraseBuffCommand = NVM_CMD_ERASEEEPROMPAGEBUFF; + } + else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_USERSIG) + { + /* User signature is paged, but needs us to manually indicate the mode bits since the host doesn't set them */ + WriteMemory_XPROG_Params.PageMode = (XPRG_PAGEMODE_ERASE | XPRG_PAGEMODE_WRITE); + WriteCommand = NVM_CMD_WRITEUSERSIG; + } + else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_FUSE) + { + WriteCommand = NVM_CMD_WRITEFUSE; + PagedMemory = false; + } + else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_LOCKBITS) + { + WriteCommand = NVM_CMD_WRITELOCK; + PagedMemory = false; + } + + /* Send the appropriate memory write commands to the device, indicate timeout if occurred */ + if ((PagedMemory && !NVMTarget_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand, + WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address, + WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length)) || + (!PagedMemory && !NVMTarget_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address, + WriteMemory_XPROG_Params.ProgData))) + { + ReturnStatus = XPRG_ERR_TIMEOUT; + } Endpoint_Write_Byte(CMD_XPROG); - Endpoint_Write_Byte(XPRG_CMD_READ_MEM); + Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM); Endpoint_Write_Byte(ReturnStatus); Endpoint_ClearIN(); } +/** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the + * attached device. + */ static void PDIProtocol_ReadMemory(void) { uint8_t ReturnStatus = XPRG_ERR_OK; @@ -160,41 +286,53 @@ static void PDIProtocol_ReadMemory(void) Endpoint_ClearOUT(); Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN); + + uint8_t ReadBuffer[256]; - // TODO: Send read command here via PDI protocol - + /* Read the target's memory, indicate timeout if occurred */ + if (!(NVMTarget_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length))) + ReturnStatus = XPRG_ERR_TIMEOUT; + Endpoint_Write_Byte(CMD_XPROG); Endpoint_Write_Byte(XPRG_CMD_READ_MEM); Endpoint_Write_Byte(ReturnStatus); - - // START TEMP - uint8_t ProgData[256]; - for (uint16_t i = 0; i < ReadMemory_XPROG_Params.Length; i++) - ProgData[i] = i; - Endpoint_Write_Stream_LE(ProgData, ReadMemory_XPROG_Params.Length); - - if (!Endpoint_IsReadWriteAllowed()) - { - Endpoint_ClearIN(); - while(!(Endpoint_IsReadWriteAllowed())); - } - // END TEMP + + if (ReturnStatus == XPRG_ERR_OK) + Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length); Endpoint_ClearIN(); } +/** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the + * attached device's memory and a data set on the host. + */ static void PDIProtocol_ReadCRC(void) { uint8_t ReturnStatus = XPRG_ERR_OK; - - uint8_t CRCType = Endpoint_Read_Byte(); + struct + { + uint8_t CRCType; + } ReadCRC_XPROG_Params; + + Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params)); Endpoint_ClearOUT(); Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN); - uint32_t MemoryCRC = 0; + uint8_t CRCCommand = NVM_CMD_NOOP; + uint32_t MemoryCRC; + + /* Determine which NVM command to send to the device depending on the memory to CRC */ + if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_APP) + CRCCommand = NVM_CMD_APPCRC; + else if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_BOOT) + CRCCommand = NVM_CMD_BOOTCRC; + else + CRCCommand = NVM_CMD_FLASHCRC; - // TODO: Read device CRC for desired memory via PDI protocol + /* Perform and retrieve the memory CRC, indicate timeout if occurred */ + if (!(NVMTarget_GetMemoryCRC(CRCCommand, &MemoryCRC))) + ReturnStatus = XPRG_ERR_TIMEOUT; Endpoint_Write_Byte(CMD_XPROG); Endpoint_Write_Byte(XPRG_CMD_CRC); @@ -209,44 +347,20 @@ static void PDIProtocol_ReadCRC(void) Endpoint_ClearIN(); } -static void PDIProtocol_EnterXPROGMode(void) -{ - uint8_t ReturnStatus = XPRG_ERR_OK; - - Endpoint_ClearOUT(); - Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN); - - // TODO: Enter device programming mode here via PDI protocol - - Endpoint_Write_Byte(CMD_XPROG); - Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE); - Endpoint_Write_Byte(ReturnStatus); - Endpoint_ClearIN(); -} - -static void PDIProtocol_LeaveXPROGMode(void) -{ - Endpoint_ClearOUT(); - Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN); - - // TODO: Exit device programming mode here via PDI protocol - - Endpoint_Write_Byte(CMD_XPROG); - Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE); - Endpoint_Write_Byte(XPRG_ERR_OK); - Endpoint_ClearIN(); -} - +/** Handler for the XPROG SET_PARAM command to set a PDI parameter for use when communicating with the + * attached device. + */ static void PDIProtocol_SetParam(void) { uint8_t ReturnStatus = XPRG_ERR_OK; uint8_t XPROGParam = Endpoint_Read_Byte(); + /* Determine which parameter is being set, store the new parameter value */ if (XPROGParam == XPRG_PARAM_NVMBASE) - XPROG_Param_NVMBase = Endpoint_Read_DWord_LE(); + XPROG_Param_NVMBase = Endpoint_Read_DWord_BE(); else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE) - XPROG_Param_EEPageSize = Endpoint_Read_Word_LE(); + XPROG_Param_EEPageSize = Endpoint_Read_Word_BE(); else ReturnStatus = XPRG_ERR_FAILED;