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 #warning PDI Programming Protocol support is incomplete and not currently suitable for general use.
  41
  42 /** Base absolute address for the target's NVM controller */
  43 uint32_t XPROG_Param_NVMBase;
  44
  45 /** Size in bytes of the target's EEPROM page */
  46 uint32_t XPROG_Param_EEPageSize;
  47
  48 /** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI
  49  *  XMEGA programming (either PDI or JTAG). Only PDI programming is supported.
  50  */
  51 void PDIProtocol_XPROG_SetMode(void)
  52 {
  53         struct
  54         {
  55                 uint8_t Protocol;
  56         } SetMode_XPROG_Params;
  57
  58         Endpoint_Read_Stream_LE(&SetMode_XPROG_Params, sizeof(SetMode_XPROG_Params));
  59
  60         Endpoint_ClearOUT();
  61         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
  62
  63         Endpoint_Write_Byte(CMD_XPROG_SETMODE);
  64         Endpoint_Write_Byte((SetMode_XPROG_Params.Protocol == XPRG_PROTOCOL_PDI) ? STATUS_CMD_OK : STATUS_CMD_FAILED);
  65         Endpoint_ClearIN();
  66 }
  67
  68 /** Handler for the CMD_XPROG command, which wraps up XPROG commands in a V2 wrapper which need to be
  69  *  removed and processed so that the underlying XPROG command can be handled.
  70  */
  71 void PDIProtocol_XPROG_Command(void)
  72 {
  73         uint8_t XPROGCommand = Endpoint_Read_Byte();
  74
  75         switch (XPROGCommand)
  76         {
  77                 case XPRG_CMD_ENTER_PROGMODE:
  78                         PDIProtocol_EnterXPROGMode();
  79                         break;
  80                 case XPRG_CMD_LEAVE_PROGMODE:
  81                         PDIProtocol_LeaveXPROGMode();
  82                         break;
  83                 case XPRG_CMD_ERASE:
  84                         PDIProtocol_Erase();
  85                         break;
  86                 case XPRG_CMD_WRITE_MEM:
  87                         PDIProtocol_WriteMemory();
  88                         break;
  89                 case XPRG_CMD_READ_MEM:
  90                         PDIProtocol_ReadMemory();
  91                         break;
  92                 case XPRG_CMD_CRC:
  93                         PDIProtocol_ReadCRC();
  94                         break;
  95                 case XPRG_CMD_SET_PARAM:
  96                         PDIProtocol_SetParam();
  97                         break;
  98         }
  99 }
 100
 101 /** Handler for the XPROG ENTER_PROGMODE command to establish a PDI connection with the attached device. */
 102 static void PDIProtocol_EnterXPROGMode(void)
 103 {
 104         Endpoint_ClearOUT();
 105         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 106
 107         /* Enable PDI programming mode with the attached target */
 108         PDITarget_EnableTargetPDI();
 109
 110         /* Store the RESET key into the RESET PDI register to keep the XMEGA in reset */
 111         PDITarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
 112         PDITarget_SendByte(PDI_RESET_KEY);
 113
 114         /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
 115         PDITarget_SendByte(PDI_CMD_KEY);
 116         for (uint8_t i = sizeof(PDI_NVMENABLE_KEY); i > 0; i--)
 117           PDITarget_SendByte(PDI_NVMENABLE_KEY[i - 1]);
 118
 119         /* Wait until the NVM bus becomes active */
 120         bool NVMBusEnabled = PDITarget_WaitWhileNVMBusBusy();
 121
 122         Endpoint_Write_Byte(CMD_XPROG);
 123         Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);
 124         Endpoint_Write_Byte(NVMBusEnabled ? XPRG_ERR_OK : XPRG_ERR_FAILED);
 125         Endpoint_ClearIN();
 126 }
 127
 128 /** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with
 129  *  the attached device.
 130  */
 131 static void PDIProtocol_LeaveXPROGMode(void)
 132 {
 133         Endpoint_ClearOUT();
 134         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 135
 136         /* Clear the RESET key in the RESET PDI register to allow the XMEGA to run */
 137         PDITarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
 138         PDITarget_SendByte(0x00);
 139
 140         PDITarget_DisableTargetPDI();
 141
 142         Endpoint_Write_Byte(CMD_XPROG);
 143         Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
 144         Endpoint_Write_Byte(XPRG_ERR_OK);
 145         Endpoint_ClearIN();
 146 }
 147
 148 /** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
 149 static void PDIProtocol_Erase(void)
 150 {
 151         uint8_t ReturnStatus = XPRG_ERR_OK;
 152
 153         struct
 154         {
 155                 uint8_t  MemoryType;
 156                 uint32_t Address;
 157         } Erase_XPROG_Params;
 158
 159         Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params));
 160         Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address);
 161
 162         Endpoint_ClearOUT();
 163         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 164
 165         uint8_t EraseCommand = NVM_CMD_NOOP;
 166
 167         if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP)
 168           EraseCommand = NVM_CMD_CHIPERASE;
 169         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP)
 170           EraseCommand = NVM_CMD_ERASEAPPSEC;
 171         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT)
 172           EraseCommand = NVM_CMD_ERASEBOOTSEC;
 173         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM)
 174           EraseCommand = NVM_CMD_ERASEEEPROM;
 175         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP_PAGE)
 176           EraseCommand = NVM_CMD_ERASEAPPSECPAGE;
 177         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT_PAGE)
 178           EraseCommand = NVM_CMD_ERASEBOOTSECPAGE;
 179         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM_PAGE)
 180           EraseCommand = NVM_CMD_ERASEEEPROMPAGE;
 181         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_USERSIG)
 182           EraseCommand = NVM_CMD_ERASEUSERSIG;
 183
 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
 217         uint8_t WriteCommand     = NVM_CMD_NOOP;
 218         uint8_t WriteBuffCommand = NVM_CMD_NOOP;
 219         uint8_t EraseBuffCommand = NVM_CMD_NOOP;
 220         bool    PagedMemory      = false;
 221
 222         if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_APPL)
 223         {
 224                 WriteCommand     = NVM_CMD_ERASEWRITEFLASH;
 225                 WriteBuffCommand = NVM_CMD_LOADFLASHPAGEBUFF;
 226                 EraseBuffCommand = NVM_CMD_ERASEFLASHPAGEBUFF;
 227                 PagedMemory      = true;
 228         }
 229         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_BOOT)
 230         {
 231                 WriteCommand     = NVM_CMD_ERASEWRITEFLASH;
 232                 WriteBuffCommand = NVM_CMD_LOADFLASHPAGEBUFF;
 233                 EraseBuffCommand = NVM_CMD_ERASEFLASHPAGEBUFF;
 234                 PagedMemory      = true;
 235         }
 236         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_EEPROM)
 237         {
 238                 WriteCommand     = NVM_CMD_ERASEWRITEEEPROMPAGE;
 239                 WriteBuffCommand = NVM_CMD_LOADEEPROMPAGEBUFF;
 240                 EraseBuffCommand = NVM_CMD_ERASEEEPROMPAGEBUFF;
 241                 PagedMemory      = true;
 242         }
 243         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_USERSIG)
 244         {
 245                 WriteCommand     = NVM_CMD_WRITEUSERSIG;
 246                 WriteBuffCommand = NVM_CMD_LOADFLASHPAGEBUFF;
 247                 EraseBuffCommand = NVM_CMD_ERASEFLASHPAGEBUFF;
 248                 PagedMemory      = true;
 249         }
 250         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_FUSE)
 251         {
 252                 WriteCommand = NVM_CMD_WRITEFUSE;
 253         }
 254         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_LOCKBITS)
 255         {
 256                 WriteCommand = NVM_CMD_WRITELOCK;
 257         }
 258
 259         if (PagedMemory)
 260         {
 261                 if (!(NVMTarget_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand,
 262                                                 WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,
 263                                                 WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length)))
 264                 {
 265                         ReturnStatus = XPRG_ERR_TIMEOUT;
 266                 }
 267         }
 268         else
 269         {
 270                 if (!(NVMTarget_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address, WriteMemory_XPROG_Params.ProgData,
 271                                                                                 WriteMemory_XPROG_Params.Length)))
 272                 {
 273                         ReturnStatus = XPRG_ERR_TIMEOUT;
 274                 }
 275         }
 276
 277         Endpoint_Write_Byte(CMD_XPROG);
 278         Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM);
 279         Endpoint_Write_Byte(ReturnStatus);
 280         Endpoint_ClearIN();
 281 }
 282
 283 /** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 284  *  attached device.
 285  */
 286 static void PDIProtocol_ReadMemory(void)
 287 {
 288         uint8_t ReturnStatus = XPRG_ERR_OK;
 289
 290         struct
 291         {
 292                 uint8_t  MemoryType;
 293                 uint32_t Address;
 294                 uint16_t Length;
 295         } ReadMemory_XPROG_Params;
 296
 297         Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params));
 298         ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
 299         ReadMemory_XPROG_Params.Length  = SwapEndian_16(ReadMemory_XPROG_Params.Length);
 300
 301         Endpoint_ClearOUT();
 302         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 303
 304         uint8_t ReadBuffer[ReadMemory_XPROG_Params.Length];
 305
 306         if (!(NVMTarget_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
 307           ReturnStatus = XPRG_ERR_TIMEOUT;
 308
 309         Endpoint_Write_Byte(CMD_XPROG);
 310         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 311         Endpoint_Write_Byte(ReturnStatus);
 312
 313         if (ReturnStatus == XPRG_ERR_OK)
 314           Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length);
 315
 316         Endpoint_ClearIN();
 317 }
 318
 319 /** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the
 320  *  attached device's memory and a data set on the host.
 321  */
 322 static void PDIProtocol_ReadCRC(void)
 323 {
 324         uint8_t ReturnStatus = XPRG_ERR_OK;
 325
 326         struct
 327         {
 328                 uint8_t CRCType;
 329         } ReadCRC_XPROG_Params;
 330
 331         Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params));
 332         Endpoint_ClearOUT();
 333         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 334
 335         uint8_t  CRCCommand = NVM_CMD_NOOP;
 336         uint32_t MemoryCRC;
 337
 338         if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_APP)
 339           CRCCommand = NVM_CMD_APPCRC;
 340         else if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_BOOT)
 341           CRCCommand = NVM_CMD_BOOTCRC;
 342         else
 343           CRCCommand = NVM_CMD_FLASHCRC;
 344
 345         if (!(NVMTarget_GetMemoryCRC(CRCCommand, &MemoryCRC)))
 346           ReturnStatus = XPRG_ERR_TIMEOUT;
 347
 348         Endpoint_Write_Byte(CMD_XPROG);
 349         Endpoint_Write_Byte(XPRG_CMD_CRC);
 350         Endpoint_Write_Byte(ReturnStatus);
 351
 352         if (ReturnStatus == XPRG_ERR_OK)
 353         {
 354                 Endpoint_Write_Byte(MemoryCRC >> 16);
 355                 Endpoint_Write_Word_LE(MemoryCRC & 0xFFFF);
 356         }
 357
 358         Endpoint_ClearIN();
 359 }
 360
 361 /** Handler for the XPROG SET_PARAM command to set a PDI parameter for use when communicating with the
 362  *  attached device.
 363  */
 364 static void PDIProtocol_SetParam(void)
 365 {
 366         uint8_t ReturnStatus = XPRG_ERR_OK;
 367
 368         uint8_t XPROGParam = Endpoint_Read_Byte();
 369
 370         if (XPROGParam == XPRG_PARAM_NVMBASE)
 371           XPROG_Param_NVMBase = Endpoint_Read_DWord_BE();
 372         else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE)
 373           XPROG_Param_EEPageSize = Endpoint_Read_Word_BE();
 374         else
 375           ReturnStatus = XPRG_ERR_FAILED;
 376
 377         Endpoint_ClearOUT();
 378         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 379
 380         Endpoint_Write_Byte(CMD_XPROG);
 381         Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);
 382         Endpoint_Write_Byte(ReturnStatus);
 383         Endpoint_ClearIN();
 384 }
 385
 386 #endif