+++ /dev/null
-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\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_PDIPROTOCOL_C\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 = 0x010001C0;\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
- * XMEGA programming (either PDI or JTAG). Only PDI programming is supported.\r
- */\r
-void PDIProtocol_XPROG_SetMode(void)\r
-{\r
- struct\r
- {\r
- uint8_t Protocol;\r
- } SetMode_XPROG_Params;\r
- \r
- Endpoint_Read_Stream_LE(&SetMode_XPROG_Params, sizeof(SetMode_XPROG_Params));\r
-\r
- Endpoint_ClearOUT();\r
- Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
- \r
- Endpoint_Write_Byte(CMD_XPROG_SETMODE);\r
- Endpoint_Write_Byte((SetMode_XPROG_Params.Protocol == XPRG_PROTOCOL_PDI) ? STATUS_CMD_OK : STATUS_CMD_FAILED);\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
-\r
- switch (XPROGCommand)\r
- {\r
- case XPRG_CMD_ENTER_PROGMODE:\r
- PDIProtocol_EnterXPROGMode();\r
- break;\r
- case XPRG_CMD_LEAVE_PROGMODE:\r
- PDIProtocol_LeaveXPROGMode();\r
- break;\r
- case XPRG_CMD_ERASE:\r
- PDIProtocol_Erase();\r
- break;\r
- case XPRG_CMD_WRITE_MEM:\r
- PDIProtocol_WriteMemory();\r
- break;\r
- case XPRG_CMD_READ_MEM:\r
- PDIProtocol_ReadMemory();\r
- break;\r
- case XPRG_CMD_CRC:\r
- PDIProtocol_ReadCRC();\r
- break;\r
- case XPRG_CMD_SET_PARAM:\r
- PDIProtocol_SetParam();\r
- break;\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
- 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
- struct\r
- {\r
- uint8_t MemoryType;\r
- uint32_t Address;\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
- uint8_t EraseCommand = XMEGA_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 = XMEGA_NVM_CMD_CHIPERASE;\r
- else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP)\r
- EraseCommand = XMEGA_NVM_CMD_ERASEAPPSEC;\r
- else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT)\r
- EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSEC;\r
- else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM)\r
- EraseCommand = XMEGA_NVM_CMD_ERASEEEPROM;\r
- else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP_PAGE)\r
- EraseCommand = XMEGA_NVM_CMD_ERASEAPPSECPAGE;\r
- else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT_PAGE)\r
- EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSECPAGE;\r
- else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM_PAGE)\r
- EraseCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGE;\r
- else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_USERSIG)\r
- EraseCommand = XMEGA_NVM_CMD_ERASEUSERSIG;\r
- \r
- /* Erase the target memory, indicate timeout if ocurred */\r
- if (!(XMEGANVM_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
- Endpoint_Write_Byte(ReturnStatus);\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
-\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
- } WriteMemory_XPROG_Params;\r
- \r
- Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -\r
- sizeof(WriteMemory_XPROG_Params).ProgData));\r
- WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);\r
- WriteMemory_XPROG_Params.Length = SwapEndian_16(WriteMemory_XPROG_Params.Length);\r
- Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length);\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 = XMEGA_NVM_CMD_WRITEFLASHPAGE;\r
- uint8_t WriteBuffCommand = XMEGA_NVM_CMD_LOADFLASHPAGEBUFF;\r
- uint8_t EraseBuffCommand = XMEGA_NVM_CMD_ERASEFLASHPAGEBUFF;\r
- bool PagedMemory = true;\r
- \r
- if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_APPL)\r
- {\r
- WriteCommand = XMEGA_NVM_CMD_WRITEAPPSECPAGE;\r
- }\r
- else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_BOOT)\r
- {\r
- WriteCommand = XMEGA_NVM_CMD_WRITEBOOTSECPAGE;\r
- }\r
- else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_EEPROM)\r
- {\r
- WriteCommand = XMEGA_NVM_CMD_WRITEEEPROMPAGE;\r
- WriteBuffCommand = XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF;\r
- EraseBuffCommand = XMEGA_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 = XMEGA_NVM_CMD_WRITEUSERSIG;\r
- }\r
- else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_FUSE)\r
- {\r
- WriteCommand = XMEGA_NVM_CMD_WRITEFUSE;\r
- PagedMemory = false;\r
- }\r
- else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_LOCKBITS)\r
- {\r
- WriteCommand = XMEGA_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 && !XMEGANVM_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand, \r
- WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,\r
- WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length)) ||\r
- (!PagedMemory && !XMEGANVM_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
- Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM);\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
-\r
- struct\r
- {\r
- uint8_t MemoryType;\r
- uint32_t Address;\r
- uint16_t Length;\r
- } ReadMemory_XPROG_Params;\r
- \r
- Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params));\r
- ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);\r
- ReadMemory_XPROG_Params.Length = SwapEndian_16(ReadMemory_XPROG_Params.Length);\r
-\r
- Endpoint_ClearOUT();\r
- Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
-\r
- uint8_t ReadBuffer[256];\r
- \r
- /* Read the target's memory, indicate timeout if occurred */\r
- if (!(XMEGANVM_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
- \r
- if (ReturnStatus == XPRG_ERR_OK)\r
- Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length);\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
- \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
- uint8_t CRCCommand = XMEGA_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 = XMEGA_NVM_CMD_APPCRC;\r
- else if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_BOOT)\r
- CRCCommand = XMEGA_NVM_CMD_BOOTCRC;\r
- else\r
- CRCCommand = XMEGA_NVM_CMD_FLASHCRC;\r
- \r
- /* Perform and retrieve the memory CRC, indicate timeout if occurred */\r
- if (!(XMEGANVM_GetMemoryCRC(CRCCommand, &MemoryCRC)))\r
- ReturnStatus = XPRG_ERR_TIMEOUT;\r
- \r
- Endpoint_Write_Byte(CMD_XPROG);\r
- Endpoint_Write_Byte(XPRG_CMD_CRC);\r
- Endpoint_Write_Byte(ReturnStatus);\r
- \r
- if (ReturnStatus == XPRG_ERR_OK)\r
- {\r
- Endpoint_Write_Byte(MemoryCRC >> 16);\r
- Endpoint_Write_Word_LE(MemoryCRC & 0xFFFF); \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
-\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
- XPROG_Param_EEPageSize = Endpoint_Read_Word_BE();\r
- else\r
- ReturnStatus = XPRG_ERR_FAILED;\r
- \r
- Endpoint_ClearOUT();\r
- Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);\r
- \r
- Endpoint_Write_Byte(CMD_XPROG);\r
- Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);\r
- Endpoint_Write_Byte(ReturnStatus);\r
- Endpoint_ClearIN();\r
-}\r
-\r
-#endif\r
projects / pub / lufa.git / blobdiff