Projects/AVRISP/Lib/XPROG/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         Serial_TxByte(SetMode_XPROG_Params.Protocol);
  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 = XMEGA_NVM_CMD_NOOP;
 166
 167         /* Determine which NVM command to send to the device depending on the memory to erase */
 168         if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP)
 169           EraseCommand = XMEGA_NVM_CMD_CHIPERASE;
 170         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP)
 171           EraseCommand = XMEGA_NVM_CMD_ERASEAPPSEC;
 172         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT)
 173           EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSEC;
 174         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM)
 175           EraseCommand = XMEGA_NVM_CMD_ERASEEEPROM;
 176         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP_PAGE)
 177           EraseCommand = XMEGA_NVM_CMD_ERASEAPPSECPAGE;
 178         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT_PAGE)
 179           EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSECPAGE;
 180         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM_PAGE)
 181           EraseCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGE;
 182         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_USERSIG)
 183           EraseCommand = XMEGA_NVM_CMD_ERASEUSERSIG;
 184
 185         /* Erase the target memory, indicate timeout if ocurred */
 186         if (!(XMEGANVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
 187           ReturnStatus = XPRG_ERR_TIMEOUT;
 188
 189         Endpoint_Write_Byte(CMD_XPROG);
 190         Endpoint_Write_Byte(XPRG_CMD_ERASE);
 191         Endpoint_Write_Byte(ReturnStatus);
 192         Endpoint_ClearIN();
 193 }
 194
 195 /** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
 196 static void PDIProtocol_WriteMemory(void)
 197 {
 198         uint8_t ReturnStatus = XPRG_ERR_OK;
 199
 200         struct
 201         {
 202                 uint8_t  MemoryType;
 203                 uint8_t  PageMode;
 204                 uint32_t Address;
 205                 uint16_t Length;
 206                 uint8_t  ProgData[256];
 207         } WriteMemory_XPROG_Params;
 208
 209         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
 210                                                             sizeof(WriteMemory_XPROG_Params).ProgData));
 211         WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
 212         WriteMemory_XPROG_Params.Length  = SwapEndian_16(WriteMemory_XPROG_Params.Length);
 213         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length);
 214
 215         Endpoint_ClearOUT();
 216         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 217
 218         /* Assume FLASH page programming by default, as it is the common case */
 219         uint8_t WriteCommand     = XMEGA_NVM_CMD_WRITEFLASHPAGE;
 220         uint8_t WriteBuffCommand = XMEGA_NVM_CMD_LOADFLASHPAGEBUFF;
 221         uint8_t EraseBuffCommand = XMEGA_NVM_CMD_ERASEFLASHPAGEBUFF;
 222         bool    PagedMemory      = true;
 223
 224         if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_APPL)
 225         {
 226                 WriteCommand     = XMEGA_NVM_CMD_WRITEAPPSECPAGE;
 227         }
 228         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_BOOT)
 229         {
 230                 WriteCommand     = XMEGA_NVM_CMD_WRITEBOOTSECPAGE;
 231         }
 232         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_EEPROM)
 233         {
 234                 WriteCommand     = XMEGA_NVM_CMD_WRITEEEPROMPAGE;
 235                 WriteBuffCommand = XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF;
 236                 EraseBuffCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGEBUFF;
 237         }
 238         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_USERSIG)
 239         {
 240                 /* User signature is paged, but needs us to manually indicate the mode bits since the host doesn't set them */
 241                 WriteMemory_XPROG_Params.PageMode = (XPRG_PAGEMODE_ERASE | XPRG_PAGEMODE_WRITE);
 242                 WriteCommand     = XMEGA_NVM_CMD_WRITEUSERSIG;
 243         }
 244         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_FUSE)
 245         {
 246                 WriteCommand     = XMEGA_NVM_CMD_WRITEFUSE;
 247                 PagedMemory      = false;
 248         }
 249         else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_LOCKBITS)
 250         {
 251                 WriteCommand     = XMEGA_NVM_CMD_WRITELOCK;
 252                 PagedMemory      = false;
 253         }
 254
 255         /* Send the appropriate memory write commands to the device, indicate timeout if occurred */
 256         if ((PagedMemory && !XMEGANVM_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand,
 257                                                            WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,
 258                                                            WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length)) ||
 259            (!PagedMemory && !XMEGANVM_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address,
 260                                                        WriteMemory_XPROG_Params.ProgData)))
 261         {
 262                 ReturnStatus = XPRG_ERR_TIMEOUT;
 263         }
 264
 265         Endpoint_Write_Byte(CMD_XPROG);
 266         Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM);
 267         Endpoint_Write_Byte(ReturnStatus);
 268         Endpoint_ClearIN();
 269 }
 270
 271 /** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 272  *  attached device.
 273  */
 274 static void PDIProtocol_ReadMemory(void)
 275 {
 276         uint8_t ReturnStatus = XPRG_ERR_OK;
 277
 278         struct
 279         {
 280                 uint8_t  MemoryType;
 281                 uint32_t Address;
 282                 uint16_t Length;
 283         } ReadMemory_XPROG_Params;
 284
 285         Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params));
 286         ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
 287         ReadMemory_XPROG_Params.Length  = SwapEndian_16(ReadMemory_XPROG_Params.Length);
 288
 289         Endpoint_ClearOUT();
 290         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 291
 292         uint8_t ReadBuffer[256];
 293
 294         /* Read the target's memory, indicate timeout if occurred */
 295         if (!(XMEGANVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
 296           ReturnStatus = XPRG_ERR_TIMEOUT;
 297
 298         Endpoint_Write_Byte(CMD_XPROG);
 299         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 300         Endpoint_Write_Byte(ReturnStatus);
 301
 302         if (ReturnStatus == XPRG_ERR_OK)
 303           Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length);
 304
 305         Endpoint_ClearIN();
 306 }
 307
 308 /** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the
 309  *  attached device's memory and a data set on the host.
 310  */
 311 static void PDIProtocol_ReadCRC(void)
 312 {
 313         uint8_t ReturnStatus = XPRG_ERR_OK;
 314
 315         struct
 316         {
 317                 uint8_t CRCType;
 318         } ReadCRC_XPROG_Params;
 319
 320         Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params));
 321         Endpoint_ClearOUT();
 322         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 323
 324         uint8_t  CRCCommand = XMEGA_NVM_CMD_NOOP;
 325         uint32_t MemoryCRC;
 326
 327         /* Determine which NVM command to send to the device depending on the memory to CRC */
 328         if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_APP)
 329           CRCCommand = XMEGA_NVM_CMD_APPCRC;
 330         else if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_BOOT)
 331           CRCCommand = XMEGA_NVM_CMD_BOOTCRC;
 332         else
 333           CRCCommand = XMEGA_NVM_CMD_FLASHCRC;
 334
 335         /* Perform and retrieve the memory CRC, indicate timeout if occurred */
 336         if (!(XMEGANVM_GetMemoryCRC(CRCCommand, &MemoryCRC)))
 337           ReturnStatus = XPRG_ERR_TIMEOUT;
 338
 339         Endpoint_Write_Byte(CMD_XPROG);
 340         Endpoint_Write_Byte(XPRG_CMD_CRC);
 341         Endpoint_Write_Byte(ReturnStatus);
 342
 343         if (ReturnStatus == XPRG_ERR_OK)
 344         {
 345                 Endpoint_Write_Byte(MemoryCRC >> 16);
 346                 Endpoint_Write_Word_LE(MemoryCRC & 0xFFFF);
 347         }
 348
 349         Endpoint_ClearIN();
 350 }
 351
 352 /** Handler for the XPROG SET_PARAM command to set a PDI parameter for use when communicating with the
 353  *  attached device.
 354  */
 355 static void PDIProtocol_SetParam(void)
 356 {
 357         uint8_t ReturnStatus = XPRG_ERR_OK;
 358
 359         uint8_t XPROGParam = Endpoint_Read_Byte();
 360
 361         /* Determine which parameter is being set, store the new parameter value */
 362         if (XPROGParam == XPRG_PARAM_NVMBASE)
 363           XPROG_Param_NVMBase = Endpoint_Read_DWord_BE();
 364         else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE)
 365           XPROG_Param_EEPageSize = Endpoint_Read_Word_BE();
 366         else
 367           ReturnStatus = XPRG_ERR_FAILED;
 368
 369         Endpoint_ClearOUT();
 370         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 371
 372         Endpoint_Write_Byte(CMD_XPROG);
 373         Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);
 374         Endpoint_Write_Byte(ReturnStatus);
 375         Endpoint_ClearIN();
 376 }
 377
 378 #endif