480 lines
14 KiB
C
480 lines
14 KiB
C
/*
|
|
LUFA Library
|
|
Copyright (C) Dean Camera, 2017.
|
|
|
|
dean [at] fourwalledcubicle [dot] com
|
|
www.lufa-lib.org
|
|
*/
|
|
|
|
/*
|
|
Copyright 2017 Dean Camera (dean [at] fourwalledcubicle [dot] com)
|
|
|
|
Permission to use, copy, modify, distribute, and sell this
|
|
software and its documentation for any purpose is hereby granted
|
|
without fee, provided that the above copyright notice appear in
|
|
all copies and that both that the copyright notice and this
|
|
permission notice and warranty disclaimer appear in supporting
|
|
documentation, and that the name of the author not be used in
|
|
advertising or publicity pertaining to distribution of the
|
|
software without specific, written prior permission.
|
|
|
|
The author disclaims all warranties with regard to this
|
|
software, including all implied warranties of merchantability
|
|
and fitness. In no event shall the author be liable for any
|
|
special, indirect or consequential damages or any damages
|
|
whatsoever resulting from loss of use, data or profits, whether
|
|
in an action of contract, negligence or other tortious action,
|
|
arising out of or in connection with the use or performance of
|
|
this software.
|
|
*/
|
|
|
|
/** \file
|
|
*
|
|
* XPROG Protocol handler, to process V2 Protocol wrapped XPROG commands used in Atmel programmer devices.
|
|
*/
|
|
|
|
#define INCLUDE_FROM_XPROGPROTOCOL_C
|
|
#include "XPROGProtocol.h"
|
|
|
|
#if defined(ENABLE_XPROG_PROTOCOL) || defined(__DOXYGEN__)
|
|
/** Base absolute address for the target's NVM controller for PDI programming */
|
|
uint32_t XPROG_Param_NVMBase = 0x010001C0;
|
|
|
|
/** Size in bytes of the target's EEPROM page */
|
|
uint16_t XPROG_Param_EEPageSize = 32;
|
|
|
|
/** Address of the TPI device's NVMCMD register for TPI programming */
|
|
uint8_t XPROG_Param_NVMCMDRegAddr = 0x33;
|
|
|
|
/** Address of the TPI device's NVMCSR register for TPI programming */
|
|
uint8_t XPROG_Param_NVMCSRRegAddr = 0x32;
|
|
|
|
/** Currently selected XPROG programming protocol */
|
|
uint8_t XPROG_SelectedProtocol = XPROG_PROTOCOL_PDI;
|
|
|
|
/** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI/TPI
|
|
* programming.
|
|
*/
|
|
void XPROGProtocol_SetMode(void)
|
|
{
|
|
struct
|
|
{
|
|
uint8_t Protocol;
|
|
} SetMode_XPROG_Params;
|
|
|
|
Endpoint_Read_Stream_LE(&SetMode_XPROG_Params, sizeof(SetMode_XPROG_Params), NULL);
|
|
|
|
Endpoint_ClearOUT();
|
|
Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
|
|
Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
|
|
|
|
XPROG_SelectedProtocol = SetMode_XPROG_Params.Protocol;
|
|
|
|
Endpoint_Write_8(CMD_XPROG_SETMODE);
|
|
Endpoint_Write_8((SetMode_XPROG_Params.Protocol != XPROG_PROTOCOL_JTAG) ? 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 XPROGProtocol_Command(void)
|
|
{
|
|
uint8_t XPROGCommand = Endpoint_Read_8();
|
|
|
|
switch (XPROGCommand)
|
|
{
|
|
case XPROG_CMD_ENTER_PROGMODE:
|
|
XPROGProtocol_EnterXPROGMode();
|
|
break;
|
|
case XPROG_CMD_LEAVE_PROGMODE:
|
|
XPROGProtocol_LeaveXPROGMode();
|
|
break;
|
|
case XPROG_CMD_ERASE:
|
|
XPROGProtocol_Erase();
|
|
break;
|
|
case XPROG_CMD_WRITE_MEM:
|
|
XPROGProtocol_WriteMemory();
|
|
break;
|
|
case XPROG_CMD_READ_MEM:
|
|
XPROGProtocol_ReadMemory();
|
|
break;
|
|
case XPROG_CMD_CRC:
|
|
XPROGProtocol_ReadCRC();
|
|
break;
|
|
case XPROG_CMD_SET_PARAM:
|
|
XPROGProtocol_SetParam();
|
|
break;
|
|
}
|
|
}
|
|
|
|
/** Handler for the XPROG ENTER_PROGMODE command to establish a connection with the attached device. */
|
|
static void XPROGProtocol_EnterXPROGMode(void)
|
|
{
|
|
Endpoint_ClearOUT();
|
|
Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
|
|
Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
|
|
|
|
bool NVMBusEnabled = false;
|
|
|
|
if (XPROG_SelectedProtocol == XPROG_PROTOCOL_PDI)
|
|
NVMBusEnabled = XMEGANVM_EnablePDI();
|
|
else if (XPROG_SelectedProtocol == XPROG_PROTOCOL_TPI)
|
|
NVMBusEnabled = TINYNVM_EnableTPI();
|
|
|
|
Endpoint_Write_8(CMD_XPROG);
|
|
Endpoint_Write_8(XPROG_CMD_ENTER_PROGMODE);
|
|
Endpoint_Write_8(NVMBusEnabled ? XPROG_ERR_OK : XPROG_ERR_FAILED);
|
|
Endpoint_ClearIN();
|
|
}
|
|
|
|
/** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with
|
|
* the attached device.
|
|
*/
|
|
static void XPROGProtocol_LeaveXPROGMode(void)
|
|
{
|
|
Endpoint_ClearOUT();
|
|
Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
|
|
Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
|
|
|
|
if (XPROG_SelectedProtocol == XPROG_PROTOCOL_PDI)
|
|
XMEGANVM_DisablePDI();
|
|
else
|
|
TINYNVM_DisableTPI();
|
|
|
|
#if defined(XCK_RESCUE_CLOCK_ENABLE) && defined(ENABLE_ISP_PROTOCOL)
|
|
/* If the XCK rescue clock option is enabled, we need to restart it once the
|
|
* XPROG mode has been exited, since the XPROG protocol stops it after use. */
|
|
ISPTarget_ConfigureRescueClock();
|
|
#endif
|
|
|
|
Endpoint_Write_8(CMD_XPROG);
|
|
Endpoint_Write_8(XPROG_CMD_LEAVE_PROGMODE);
|
|
Endpoint_Write_8(XPROG_ERR_OK);
|
|
Endpoint_ClearIN();
|
|
}
|
|
|
|
/** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
|
|
static void XPROGProtocol_Erase(void)
|
|
{
|
|
uint8_t ReturnStatus = XPROG_ERR_OK;
|
|
|
|
struct
|
|
{
|
|
uint8_t MemoryType;
|
|
uint32_t Address;
|
|
} Erase_XPROG_Params;
|
|
|
|
Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params), NULL);
|
|
Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address);
|
|
|
|
Endpoint_ClearOUT();
|
|
Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
|
|
Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
|
|
|
|
uint8_t EraseCommand;
|
|
|
|
if (XPROG_SelectedProtocol == XPROG_PROTOCOL_PDI)
|
|
{
|
|
/* Determine which NVM command to send to the device depending on the memory to erase */
|
|
switch (Erase_XPROG_Params.MemoryType)
|
|
{
|
|
case XPROG_ERASE_CHIP:
|
|
EraseCommand = XMEGA_NVM_CMD_CHIPERASE;
|
|
break;
|
|
case XPROG_ERASE_APP:
|
|
EraseCommand = XMEGA_NVM_CMD_ERASEAPPSEC;
|
|
break;
|
|
case XPROG_ERASE_BOOT:
|
|
EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSEC;
|
|
break;
|
|
case XPROG_ERASE_EEPROM:
|
|
EraseCommand = XMEGA_NVM_CMD_ERASEEEPROM;
|
|
break;
|
|
case XPROG_ERASE_APP_PAGE:
|
|
EraseCommand = XMEGA_NVM_CMD_ERASEAPPSECPAGE;
|
|
break;
|
|
case XPROG_ERASE_BOOT_PAGE:
|
|
EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSECPAGE;
|
|
break;
|
|
case XPROG_ERASE_EEPROM_PAGE:
|
|
EraseCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGE;
|
|
break;
|
|
case XPROG_ERASE_USERSIG:
|
|
EraseCommand = XMEGA_NVM_CMD_ERASEUSERSIG;
|
|
break;
|
|
default:
|
|
EraseCommand = XMEGA_NVM_CMD_NOOP;
|
|
break;
|
|
}
|
|
|
|
/* Erase the target memory, indicate timeout if occurred */
|
|
if (!(XMEGANVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
|
|
ReturnStatus = XPROG_ERR_TIMEOUT;
|
|
}
|
|
else
|
|
{
|
|
if (Erase_XPROG_Params.MemoryType == XPROG_ERASE_CHIP)
|
|
EraseCommand = TINY_NVM_CMD_CHIPERASE;
|
|
else
|
|
EraseCommand = TINY_NVM_CMD_SECTIONERASE;
|
|
|
|
/* Erase the target memory, indicate timeout if occurred */
|
|
if (!(TINYNVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
|
|
ReturnStatus = XPROG_ERR_TIMEOUT;
|
|
}
|
|
|
|
Endpoint_Write_8(CMD_XPROG);
|
|
Endpoint_Write_8(XPROG_CMD_ERASE);
|
|
Endpoint_Write_8(ReturnStatus);
|
|
Endpoint_ClearIN();
|
|
}
|
|
|
|
/** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
|
|
static void XPROGProtocol_WriteMemory(void)
|
|
{
|
|
uint8_t ReturnStatus = XPROG_ERR_OK;
|
|
|
|
struct
|
|
{
|
|
uint8_t MemoryType;
|
|
uint8_t PageMode;
|
|
uint32_t Address;
|
|
uint16_t Length;
|
|
uint8_t ProgData[256];
|
|
} WriteMemory_XPROG_Params;
|
|
|
|
Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
|
|
sizeof(WriteMemory_XPROG_Params).ProgData), NULL);
|
|
WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
|
|
WriteMemory_XPROG_Params.Length = SwapEndian_16(WriteMemory_XPROG_Params.Length);
|
|
Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length, NULL);
|
|
|
|
// The driver will terminate transfers that are a round multiple of the endpoint bank in size with a ZLP, need
|
|
// to catch this and discard it before continuing on with packet processing to prevent communication issues
|
|
if (((sizeof(uint8_t) + sizeof(WriteMemory_XPROG_Params) - sizeof(WriteMemory_XPROG_Params.ProgData)) +
|
|
WriteMemory_XPROG_Params.Length) % AVRISP_DATA_EPSIZE == 0)
|
|
{
|
|
Endpoint_ClearOUT();
|
|
Endpoint_WaitUntilReady();
|
|
}
|
|
|
|
Endpoint_ClearOUT();
|
|
Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
|
|
Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
|
|
|
|
if (XPROG_SelectedProtocol == XPROG_PROTOCOL_PDI)
|
|
{
|
|
/* Assume FLASH page programming by default, as it is the common case */
|
|
uint8_t WriteCommand = XMEGA_NVM_CMD_WRITEFLASHPAGE;
|
|
uint8_t WriteBuffCommand = XMEGA_NVM_CMD_LOADFLASHPAGEBUFF;
|
|
uint8_t EraseBuffCommand = XMEGA_NVM_CMD_ERASEFLASHPAGEBUFF;
|
|
bool PagedMemory = true;
|
|
|
|
switch (WriteMemory_XPROG_Params.MemoryType)
|
|
{
|
|
case XPROG_MEM_TYPE_APPL:
|
|
WriteCommand = XMEGA_NVM_CMD_WRITEAPPSECPAGE;
|
|
break;
|
|
case XPROG_MEM_TYPE_BOOT:
|
|
WriteCommand = XMEGA_NVM_CMD_WRITEBOOTSECPAGE;
|
|
break;
|
|
case XPROG_MEM_TYPE_EEPROM:
|
|
WriteCommand = XMEGA_NVM_CMD_ERASEWRITEEEPROMPAGE;
|
|
WriteBuffCommand = XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF;
|
|
EraseBuffCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGEBUFF;
|
|
break;
|
|
case XPROG_MEM_TYPE_USERSIG:
|
|
WriteCommand = XMEGA_NVM_CMD_WRITEUSERSIG;
|
|
break;
|
|
case XPROG_MEM_TYPE_FUSE:
|
|
WriteCommand = XMEGA_NVM_CMD_WRITEFUSE;
|
|
PagedMemory = false;
|
|
break;
|
|
case XPROG_MEM_TYPE_LOCKBITS:
|
|
WriteCommand = XMEGA_NVM_CMD_WRITELOCK;
|
|
PagedMemory = false;
|
|
break;
|
|
}
|
|
|
|
/* Send the appropriate memory write commands to the device, indicate timeout if occurred */
|
|
if ((PagedMemory && !(XMEGANVM_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand,
|
|
WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,
|
|
WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length))) ||
|
|
(!PagedMemory && !(XMEGANVM_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address,
|
|
WriteMemory_XPROG_Params.ProgData[0]))))
|
|
{
|
|
ReturnStatus = XPROG_ERR_TIMEOUT;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
/* Send write command to the TPI device, indicate timeout if occurred */
|
|
if (!(TINYNVM_WriteMemory(WriteMemory_XPROG_Params.Address, WriteMemory_XPROG_Params.ProgData,
|
|
WriteMemory_XPROG_Params.Length)))
|
|
{
|
|
ReturnStatus = XPROG_ERR_TIMEOUT;
|
|
}
|
|
}
|
|
|
|
Endpoint_Write_8(CMD_XPROG);
|
|
Endpoint_Write_8(XPROG_CMD_WRITE_MEM);
|
|
Endpoint_Write_8(ReturnStatus);
|
|
Endpoint_ClearIN();
|
|
}
|
|
|
|
/** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
|
|
* attached device.
|
|
*/
|
|
static void XPROGProtocol_ReadMemory(void)
|
|
{
|
|
uint8_t ReturnStatus = XPROG_ERR_OK;
|
|
|
|
struct
|
|
{
|
|
uint8_t MemoryType;
|
|
uint32_t Address;
|
|
uint16_t Length;
|
|
} ReadMemory_XPROG_Params;
|
|
|
|
Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params), NULL);
|
|
ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
|
|
ReadMemory_XPROG_Params.Length = SwapEndian_16(ReadMemory_XPROG_Params.Length);
|
|
|
|
Endpoint_ClearOUT();
|
|
Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
|
|
Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
|
|
|
|
uint8_t ReadBuffer[256];
|
|
|
|
if (XPROG_SelectedProtocol == XPROG_PROTOCOL_PDI)
|
|
{
|
|
/* Read the PDI target's memory, indicate timeout if occurred */
|
|
if (!(XMEGANVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
|
|
ReturnStatus = XPROG_ERR_TIMEOUT;
|
|
}
|
|
else
|
|
{
|
|
/* Read the TPI target's memory, indicate timeout if occurred */
|
|
if (!(TINYNVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
|
|
ReturnStatus = XPROG_ERR_TIMEOUT;
|
|
}
|
|
|
|
Endpoint_Write_8(CMD_XPROG);
|
|
Endpoint_Write_8(XPROG_CMD_READ_MEM);
|
|
Endpoint_Write_8(ReturnStatus);
|
|
|
|
if (ReturnStatus == XPROG_ERR_OK)
|
|
Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length, NULL);
|
|
|
|
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 XPROGProtocol_ReadCRC(void)
|
|
{
|
|
uint8_t ReturnStatus = XPROG_ERR_OK;
|
|
|
|
struct
|
|
{
|
|
uint8_t CRCType;
|
|
} ReadCRC_XPROG_Params;
|
|
|
|
Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params), NULL);
|
|
|
|
Endpoint_ClearOUT();
|
|
Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
|
|
Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
|
|
|
|
uint32_t MemoryCRC;
|
|
|
|
if (XPROG_SelectedProtocol == XPROG_PROTOCOL_PDI)
|
|
{
|
|
uint8_t CRCCommand;
|
|
|
|
/* Determine which NVM command to send to the device depending on the memory to CRC */
|
|
switch (ReadCRC_XPROG_Params.CRCType)
|
|
{
|
|
case XPROG_CRC_APP:
|
|
CRCCommand = XMEGA_NVM_CMD_APPCRC;
|
|
break;
|
|
case XPROG_CRC_BOOT:
|
|
CRCCommand = XMEGA_NVM_CMD_BOOTCRC;
|
|
break;
|
|
default:
|
|
CRCCommand = XMEGA_NVM_CMD_FLASHCRC;
|
|
break;
|
|
}
|
|
|
|
/* Perform and retrieve the memory CRC, indicate timeout if occurred */
|
|
if (!(XMEGANVM_GetMemoryCRC(CRCCommand, &MemoryCRC)))
|
|
ReturnStatus = XPROG_ERR_TIMEOUT;
|
|
}
|
|
else
|
|
{
|
|
/* TPI does not support memory CRC */
|
|
ReturnStatus = XPROG_ERR_FAILED;
|
|
}
|
|
|
|
Endpoint_Write_8(CMD_XPROG);
|
|
Endpoint_Write_8(XPROG_CMD_CRC);
|
|
Endpoint_Write_8(ReturnStatus);
|
|
|
|
if (ReturnStatus == XPROG_ERR_OK)
|
|
{
|
|
Endpoint_Write_8(MemoryCRC >> 16);
|
|
Endpoint_Write_16_LE(MemoryCRC & 0xFFFF);
|
|
}
|
|
|
|
Endpoint_ClearIN();
|
|
}
|
|
|
|
/** Handler for the XPROG SET_PARAM command to set a XPROG parameter for use when communicating with the
|
|
* attached device.
|
|
*/
|
|
static void XPROGProtocol_SetParam(void)
|
|
{
|
|
uint8_t ReturnStatus = XPROG_ERR_OK;
|
|
|
|
uint8_t XPROGParam = Endpoint_Read_8();
|
|
|
|
/* Determine which parameter is being set, store the new parameter value */
|
|
switch (XPROGParam)
|
|
{
|
|
case XPROG_PARAM_NVMBASE:
|
|
XPROG_Param_NVMBase = Endpoint_Read_32_BE();
|
|
break;
|
|
case XPROG_PARAM_EEPPAGESIZE:
|
|
XPROG_Param_EEPageSize = Endpoint_Read_16_BE();
|
|
break;
|
|
case XPROG_PARAM_NVMCMD_REG:
|
|
XPROG_Param_NVMCMDRegAddr = Endpoint_Read_8();
|
|
break;
|
|
case XPROG_PARAM_NVMCSR_REG:
|
|
XPROG_Param_NVMCSRRegAddr = Endpoint_Read_8();
|
|
break;
|
|
case XPROG_PARAM_UNKNOWN_1:
|
|
/* TODO: Undocumented parameter added in AVRStudio 5.1, purpose unknown. Must ACK and discard or
|
|
the communication with AVRStudio 5.1 will fail.
|
|
*/
|
|
Endpoint_Discard_16();
|
|
break;
|
|
default:
|
|
ReturnStatus = XPROG_ERR_FAILED;
|
|
break;
|
|
}
|
|
|
|
Endpoint_ClearOUT();
|
|
Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
|
|
Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
|
|
|
|
Endpoint_Write_8(CMD_XPROG);
|
|
Endpoint_Write_8(XPROG_CMD_SET_PARAM);
|
|
Endpoint_Write_8(ReturnStatus);
|
|
Endpoint_ClearIN();
|
|
}
|
|
|
|
#endif
|
|
|