Projects/AVRISP/Lib/PDIProtocol.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  PDI Protocol handler, to process V2 Protocol wrapped PDI commands used in Atmel programmer devices.
  34  */
  35
  36 #define  INCLUDE_FROM_PDIPROTOCOL_C
  37 #include "PDIProtocol.h"
  38
  39 #if defined(ENABLE_PDI_PROTOCOL) || defined(__DOXYGEN__)
  40 /** Base absolute address for the target's NVM controller */
  41 uint32_t XPROG_Param_NVMBase = 0x010001C0;
  42
  43 /** Size in bytes of the target's EEPROM page */
  44 uint32_t XPROG_Param_EEPageSize;
  45
  46 /** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI
  47  *  XMEGA programming (either PDI or JTAG). Only PDI programming is supported.
  48  */
  49 void PDIProtocol_XPROG_SetMode(void)
  50 {
  51         struct
  52         {
  53                 uint8_t Protocol;
  54         } SetMode_XPROG_Params;
  55
  56         Endpoint_Read_Stream_LE(&SetMode_XPROG_Params, sizeof(SetMode_XPROG_Params));
  57
  58         Endpoint_ClearOUT();
  59         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
  60
  61         Endpoint_Write_Byte(CMD_XPROG_SETMODE);
  62         Endpoint_Write_Byte((SetMode_XPROG_Params.Protocol == XPRG_PROTOCOL_PDI) ? STATUS_CMD_OK : STATUS_CMD_FAILED);
  63         Endpoint_ClearIN();
  64 }
  65
  66 /** Handler for the CMD_XPROG command, which wraps up XPROG commands in a V2 wrapper which need to be
  67  *  removed and processed so that the underlying XPROG command can be handled.
  68  */
  69 void PDIProtocol_XPROG_Command(void)
  70 {
  71         uint8_t XPROGCommand = Endpoint_Read_Byte();
  72
  73         switch (XPROGCommand)
  74         {
  75                 case XPRG_CMD_ENTER_PROGMODE:
  76                         PDIProtocol_EnterXPROGMode();
  77                         break;
  78                 case XPRG_CMD_LEAVE_PROGMODE:
  79                         PDIProtocol_LeaveXPROGMode();
  80                         break;
  81                 case XPRG_CMD_ERASE:
  82                         PDIProtocol_Erase();
  83                         break;
  84                 case XPRG_CMD_WRITE_MEM:
  85                         PDIProtocol_WriteMemory();
  86                         break;
  87                 case XPRG_CMD_READ_MEM:
  88                         PDIProtocol_ReadMemory();
  89                         break;
  90                 case XPRG_CMD_CRC:
  91                         PDIProtocol_ReadCRC();
  92                         break;
  93                 case XPRG_CMD_SET_PARAM:
  94                         PDIProtocol_SetParam();
  95                         break;
  96         }
  97 }
  98
  99 /** Handler for the XPROG ENTER_PROGMODE command to establish a PDI connection with the attached device. */
 100 static void PDIProtocol_EnterXPROGMode(void)
 101 {
 102         Endpoint_ClearOUT();
 103         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 104
 105         /* Enable PDI programming mode with the attached target */
 106         PDITarget_EnableTargetPDI();
 107
 108         /* Store the RESET key into the RESET PDI register to keep the XMEGA in reset */
 109         PDITarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
 110         PDITarget_SendByte(PDI_RESET_KEY);
 111
 112         /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
 113         PDITarget_SendByte(PDI_CMD_KEY);
 114         for (uint8_t i = sizeof(PDI_NVMENABLE_KEY); i > 0; i--)
 115           PDITarget_SendByte(PDI_NVMENABLE_KEY[i - 1]);
 116
 117         /* Wait until the NVM bus becomes active */
 118         bool NVMBusEnabled = PDITarget_WaitWhileNVMBusBusy();
 119
 120         Endpoint_Write_Byte(CMD_XPROG);
 121         Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);
 122         Endpoint_Write_Byte(NVMBusEnabled ? XPRG_ERR_OK : XPRG_ERR_FAILED);
 123         Endpoint_ClearIN();
 124 }
 125
 126 /** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with
 127  *  the attached device.
 128  */
 129 static void PDIProtocol_LeaveXPROGMode(void)
 130 {
 131         Endpoint_ClearOUT();
 132         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 133
 134         /* Clear the RESET key in the RESET PDI register to allow the XMEGA to run */
 135         PDITarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
 136         PDITarget_SendByte(0x00);
 137
 138         PDITarget_DisableTargetPDI();
 139
 140         Endpoint_Write_Byte(CMD_XPROG);
 141         Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
 142         Endpoint_Write_Byte(XPRG_ERR_OK);
 143         Endpoint_ClearIN();
 144 }
 145
 146 /** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
 147 static void PDIProtocol_Erase(void)
 148 {
 149         uint8_t ReturnStatus = XPRG_ERR_OK;
 150
 151         struct
 152         {
 153                 uint8_t  MemoryType;
 154                 uint32_t Address;
 155         } Erase_XPROG_Params;
 156
 157         Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params));
 158         Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address);
 159
 160         Endpoint_ClearOUT();
 161         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 162
 163         uint8_t EraseCommand = NVM_CMD_NOOP;
 164
 165         /* Determine which NVM command to send to the device depending on the memory to erase */
 166         if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP)
 167           EraseCommand = NVM_CMD_CHIPERASE;
 168         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP)
 169           EraseCommand = NVM_CMD_ERASEAPPSEC;
 170         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT)
 171           EraseCommand = NVM_CMD_ERASEBOOTSEC;
 172         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM)
 173           EraseCommand = NVM_CMD_ERASEEEPROM;
 174         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP_PAGE)
 175           EraseCommand = NVM_CMD_ERASEAPPSECPAGE;
 176         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT_PAGE)
 177           EraseCommand = NVM_CMD_ERASEBOOTSECPAGE;
 178         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM_PAGE)
 179           EraseCommand = NVM_CMD_ERASEEEPROMPAGE;
 180         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_USERSIG)
 181           EraseCommand = NVM_CMD_ERASEUSERSIG;
 182
 183         /* Erase the target memory, indicate timeout if ocurred */
 184         if (!(NVMTarget_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
 185           ReturnStatus = XPRG_ERR_TIMEOUT;
 186
 187         Endpoint_Write_Byte(CMD_XPROG);
 188         Endpoint_Write_Byte(XPRG_CMD_ERASE);
 189         Endpoint_Write_Byte(ReturnStatus);
 190         Endpoint_ClearIN();
 191 }
 192
 193 /** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
 194 static void PDIProtocol_WriteMemory(void)
 195 {
 196         uint8_t ReturnStatus = XPRG_ERR_OK;
 197
 198         struct
 199         {
 200                 uint8_t  MemoryType;
 201                 uint8_t  PageMode;
 202                 uint32_t Address;
 203                 uint16_t Length;
 204                 uint8_t  ProgData[256];
 205         } WriteMemory_XPROG_Params;
 206
 207         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
 208                                                             sizeof(WriteMemory_XPROG_Params).ProgData));
 209         WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
 210         WriteMemory_XPROG_Params.Length  = SwapEndian_16(WriteMemory_XPROG_Params.Length);
 211         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length);
 212
 213         Endpoint_ClearOUT();
 214         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 215
 216         /* Assume FLASH page programming by default, as it is the common case */
 217         uint8_t WriteCommand     = NVM_CMD_WRITEFLASHPAGE;
 218         uint8_t WriteBuffCommand = NVM_CMD_LOADFLASHPAGEBUFF;
 219         uint8_t EraseBuffCommand = NVM_CMD_ERASEFLASHPAGEBUFF;
 220         bool    PagedMemory      = true;
 221
 222         if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_APPL)
 223         {
 224                 WriteCommand     = NVM_CMD_WRITEAPPSECPAGE;
 225         }
 226         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_BOOT)
 227         {
 228                 WriteCommand     = NVM_CMD_WRITEBOOTSECPAGE;
 229         }
 230         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_EEPROM)
 231         {
 232                 WriteCommand     = NVM_CMD_WRITEEEPROMPAGE;
 233                 WriteBuffCommand = NVM_CMD_LOADEEPROMPAGEBUFF;
 234                 EraseBuffCommand = NVM_CMD_ERASEEEPROMPAGEBUFF;
 235         }
 236         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_USERSIG)
 237         {
 238                 /* User signature is paged, but needs us to manually indicate the mode bits since the host doesn't set them */
 239                 WriteMemory_XPROG_Params.PageMode = (XPRG_PAGEMODE_ERASE | XPRG_PAGEMODE_WRITE);
 240                 WriteCommand     = NVM_CMD_WRITEUSERSIG;
 241         }
 242         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_FUSE)
 243         {
 244                 WriteCommand     = NVM_CMD_WRITEFUSE;
 245                 PagedMemory      = false;
 246         }
 247         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_LOCKBITS)
 248         {
 249                 WriteCommand     = NVM_CMD_WRITELOCK;
 250                 PagedMemory      = false;
 251         }
 252
 253         /* Send the appropriate memory write commands to the device, indicate timeout if occurred */
 254         if ((PagedMemory && !NVMTarget_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand,
 255                                                            WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,
 256                                                            WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length)) ||
 257            (!PagedMemory && !NVMTarget_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address,
 258                                                        WriteMemory_XPROG_Params.ProgData)))
 259         {
 260                 ReturnStatus = XPRG_ERR_TIMEOUT;
 261         }
 262
 263         Endpoint_Write_Byte(CMD_XPROG);
 264         Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM);
 265         Endpoint_Write_Byte(ReturnStatus);
 266         Endpoint_ClearIN();
 267 }
 268
 269 /** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 270  *  attached device.
 271  */
 272 static void PDIProtocol_ReadMemory(void)
 273 {
 274         uint8_t ReturnStatus = XPRG_ERR_OK;
 275
 276         struct
 277         {
 278                 uint8_t  MemoryType;
 279                 uint32_t Address;
 280                 uint16_t Length;
 281         } ReadMemory_XPROG_Params;
 282
 283         Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params));
 284         ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
 285         ReadMemory_XPROG_Params.Length  = SwapEndian_16(ReadMemory_XPROG_Params.Length);
 286
 287         Endpoint_ClearOUT();
 288         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 289
 290         uint8_t ReadBuffer[256];
 291
 292         /* Read the target's memory, indicate timeout if occurred */
 293         if (!(NVMTarget_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
 294           ReturnStatus = XPRG_ERR_TIMEOUT;
 295
 296         Endpoint_Write_Byte(CMD_XPROG);
 297         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 298         Endpoint_Write_Byte(ReturnStatus);
 299
 300         if (ReturnStatus == XPRG_ERR_OK)
 301           Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length);
 302
 303         Endpoint_ClearIN();
 304 }
 305
 306 /** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the
 307  *  attached device's memory and a data set on the host.
 308  */
 309 static void PDIProtocol_ReadCRC(void)
 310 {
 311         uint8_t ReturnStatus = XPRG_ERR_OK;
 312
 313         struct
 314         {
 315                 uint8_t CRCType;
 316         } ReadCRC_XPROG_Params;
 317
 318         Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params));
 319         Endpoint_ClearOUT();
 320         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 321
 322         uint8_t  CRCCommand = NVM_CMD_NOOP;
 323         uint32_t MemoryCRC;
 324
 325         /* Determine which NVM command to send to the device depending on the memory to CRC */
 326         if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_APP)
 327           CRCCommand = NVM_CMD_APPCRC;
 328         else if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_BOOT)
 329           CRCCommand = NVM_CMD_BOOTCRC;
 330         else
 331           CRCCommand = NVM_CMD_FLASHCRC;
 332
 333         /* Perform and retrieve the memory CRC, indicate timeout if occurred */
 334         if (!(NVMTarget_GetMemoryCRC(CRCCommand, &MemoryCRC)))
 335           ReturnStatus = XPRG_ERR_TIMEOUT;
 336
 337         Endpoint_Write_Byte(CMD_XPROG);
 338         Endpoint_Write_Byte(XPRG_CMD_CRC);
 339         Endpoint_Write_Byte(ReturnStatus);
 340
 341         if (ReturnStatus == XPRG_ERR_OK)
 342         {
 343                 Endpoint_Write_Byte(MemoryCRC >> 16);
 344                 Endpoint_Write_Word_LE(MemoryCRC & 0xFFFF);
 345         }
 346
 347         Endpoint_ClearIN();
 348 }
 349
 350 /** Handler for the XPROG SET_PARAM command to set a PDI parameter for use when communicating with the
 351  *  attached device.
 352  */
 353 static void PDIProtocol_SetParam(void)
 354 {
 355         uint8_t ReturnStatus = XPRG_ERR_OK;
 356
 357         uint8_t XPROGParam = Endpoint_Read_Byte();
 358
 359         /* Determine which parameter is being set, store the new parameter value */
 360         if (XPROGParam == XPRG_PARAM_NVMBASE)
 361           XPROG_Param_NVMBase = Endpoint_Read_DWord_BE();
 362         else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE)
 363           XPROG_Param_EEPageSize = Endpoint_Read_Word_BE();
 364         else
 365           ReturnStatus = XPRG_ERR_FAILED;
 366
 367         Endpoint_ClearOUT();
 368         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 369
 370         Endpoint_Write_Byte(CMD_XPROG);
 371         Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);
 372         Endpoint_Write_Byte(ReturnStatus);
 373         Endpoint_ClearIN();
 374 }
 375
 376 #endif