Projects/AVRISP-MKII/Lib/XPROG/XPROGProtocol.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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 disclaims 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  *  XPROG Protocol handler, to process V2 Protocol wrapped XPROG commands used in Atmel programmer devices.
  34  */
  35
  36 #define  INCLUDE_FROM_XPROGPROTOCOL_C
  37 #include "XPROGProtocol.h"
  38
  39 #if defined(ENABLE_XPROG_PROTOCOL) || defined(__DOXYGEN__)
  40 /** Base absolute address for the target's NVM controller for PDI programming */
  41 uint32_t XPROG_Param_NVMBase       = 0x010001C0;
  42
  43 /** Size in bytes of the target's EEPROM page */
  44 uint16_t XPROG_Param_EEPageSize    = 32;
  45
  46 /** Address of the TPI device's NVMCMD register for TPI programming */
  47 uint8_t  XPROG_Param_NVMCMDRegAddr = 0x33;
  48
  49 /** Address of the TPI device's NVMCSR register for TPI programming */
  50 uint8_t  XPROG_Param_NVMCSRRegAddr = 0x32;
  51
  52 /** Currently selected XPROG programming protocol */
  53 uint8_t  XPROG_SelectedProtocol    = XPRG_PROTOCOL_PDI;
  54
  55 /** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI/TPI
  56  *  programming.
  57  */
  58 void XPROGProtocol_SetMode(void)
  59 {
  60         struct
  61         {
  62                 uint8_t Protocol;
  63         } SetMode_XPROG_Params;
  64
  65         Endpoint_Read_Stream_LE(&SetMode_XPROG_Params, sizeof(SetMode_XPROG_Params), NULL);
  66
  67         Endpoint_ClearOUT();
  68         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
  69         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
  70
  71         XPROG_SelectedProtocol = SetMode_XPROG_Params.Protocol;
  72
  73         Endpoint_Write_8(CMD_XPROG_SETMODE);
  74         Endpoint_Write_8((SetMode_XPROG_Params.Protocol != XPRG_PROTOCOL_JTAG) ? STATUS_CMD_OK : STATUS_CMD_FAILED);
  75         Endpoint_ClearIN();
  76 }
  77
  78 /** Handler for the CMD_XPROG command, which wraps up XPROG commands in a V2 wrapper which need to be
  79  *  removed and processed so that the underlying XPROG command can be handled.
  80  */
  81 void XPROGProtocol_Command(void)
  82 {
  83         uint8_t XPROGCommand = Endpoint_Read_8();
  84
  85         switch (XPROGCommand)
  86         {
  87                 case XPRG_CMD_ENTER_PROGMODE:
  88                         XPROGProtocol_EnterXPROGMode();
  89                         break;
  90                 case XPRG_CMD_LEAVE_PROGMODE:
  91                         XPROGProtocol_LeaveXPROGMode();
  92                         break;
  93                 case XPRG_CMD_ERASE:
  94                         XPROGProtocol_Erase();
  95                         break;
  96                 case XPRG_CMD_WRITE_MEM:
  97                         XPROGProtocol_WriteMemory();
  98                         break;
  99                 case XPRG_CMD_READ_MEM:
 100                         XPROGProtocol_ReadMemory();
 101                         break;
 102                 case XPRG_CMD_CRC:
 103                         XPROGProtocol_ReadCRC();
 104                         break;
 105                 case XPRG_CMD_SET_PARAM:
 106                         XPROGProtocol_SetParam();
 107                         break;
 108         }
 109 }
 110
 111 /** Handler for the XPROG ENTER_PROGMODE command to establish a connection with the attached device. */
 112 static void XPROGProtocol_EnterXPROGMode(void)
 113 {
 114         Endpoint_ClearOUT();
 115         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
 116         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 117
 118         bool NVMBusEnabled = false;
 119
 120         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 121           NVMBusEnabled = XMEGANVM_EnablePDI();
 122         else if (XPROG_SelectedProtocol == XPRG_PROTOCOL_TPI)
 123           NVMBusEnabled = TINYNVM_EnableTPI();
 124
 125         Endpoint_Write_8(CMD_XPROG);
 126         Endpoint_Write_8(XPRG_CMD_ENTER_PROGMODE);
 127         Endpoint_Write_8(NVMBusEnabled ? XPRG_ERR_OK : XPRG_ERR_FAILED);
 128         Endpoint_ClearIN();
 129 }
 130
 131 /** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with
 132  *  the attached device.
 133  */
 134 static void XPROGProtocol_LeaveXPROGMode(void)
 135 {
 136         Endpoint_ClearOUT();
 137         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
 138         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 139
 140         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 141           XMEGANVM_DisablePDI();
 142         else
 143           TINYNVM_DisableTPI();
 144
 145         #if defined(XCK_RESCUE_CLOCK_ENABLE) && defined(ENABLE_ISP_PROTOCOL)
 146         /* If the XCK rescue clock option is enabled, we need to restart it once the
 147          * XPROG mode has been exited, since the XPROG protocol stops it after use. */
 148         ISPTarget_ConfigureRescueClock();
 149         #endif
 150
 151         Endpoint_Write_8(CMD_XPROG);
 152         Endpoint_Write_8(XPRG_CMD_LEAVE_PROGMODE);
 153         Endpoint_Write_8(XPRG_ERR_OK);
 154         Endpoint_ClearIN();
 155 }
 156
 157 /** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
 158 static void XPROGProtocol_Erase(void)
 159 {
 160         uint8_t ReturnStatus = XPRG_ERR_OK;
 161
 162         struct
 163         {
 164                 uint8_t  MemoryType;
 165                 uint32_t Address;
 166         } Erase_XPROG_Params;
 167
 168         Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params), NULL);
 169         Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address);
 170
 171         Endpoint_ClearOUT();
 172         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
 173         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 174
 175         uint8_t EraseCommand;
 176
 177         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 178         {
 179                 /* Determine which NVM command to send to the device depending on the memory to erase */
 180                 switch (Erase_XPROG_Params.MemoryType)
 181                 {
 182                         case XPRG_ERASE_CHIP:
 183                                 EraseCommand = XMEGA_NVM_CMD_CHIPERASE;
 184                                 break;
 185                         case XPRG_ERASE_APP:
 186                                 EraseCommand = XMEGA_NVM_CMD_ERASEAPPSEC;
 187                                 break;
 188                         case XPRG_ERASE_BOOT:
 189                                 EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSEC;
 190                                 break;
 191                         case XPRG_ERASE_EEPROM:
 192                                 EraseCommand = XMEGA_NVM_CMD_ERASEEEPROM;
 193                                 break;
 194                         case XPRG_ERASE_APP_PAGE:
 195                                 EraseCommand = XMEGA_NVM_CMD_ERASEAPPSECPAGE;
 196                                 break;
 197                         case XPRG_ERASE_BOOT_PAGE:
 198                                 EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSECPAGE;
 199                                 break;
 200                         case XPRG_ERASE_EEPROM_PAGE:
 201                                 EraseCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGE;
 202                                 break;
 203                         case XPRG_ERASE_USERSIG:
 204                                 EraseCommand = XMEGA_NVM_CMD_ERASEUSERSIG;
 205                                 break;
 206                         default:
 207                                 EraseCommand = XMEGA_NVM_CMD_NOOP;
 208                                 break;
 209                 }
 210
 211                 /* Erase the target memory, indicate timeout if occurred */
 212                 if (!(XMEGANVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
 213                   ReturnStatus = XPRG_ERR_TIMEOUT;
 214         }
 215         else
 216         {
 217                 if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP)
 218                   EraseCommand = TINY_NVM_CMD_CHIPERASE;
 219                 else
 220                   EraseCommand = TINY_NVM_CMD_SECTIONERASE;
 221
 222                 /* Erase the target memory, indicate timeout if occurred */
 223                 if (!(TINYNVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
 224                   ReturnStatus = XPRG_ERR_TIMEOUT;
 225         }
 226
 227         Endpoint_Write_8(CMD_XPROG);
 228         Endpoint_Write_8(XPRG_CMD_ERASE);
 229         Endpoint_Write_8(ReturnStatus);
 230         Endpoint_ClearIN();
 231 }
 232
 233 /** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
 234 static void XPROGProtocol_WriteMemory(void)
 235 {
 236         uint8_t ReturnStatus = XPRG_ERR_OK;
 237
 238         struct
 239         {
 240                 uint8_t  MemoryType;
 241                 uint8_t  PageMode;
 242                 uint32_t Address;
 243                 uint16_t Length;
 244                 uint8_t  ProgData[256];
 245         } WriteMemory_XPROG_Params;
 246
 247         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
 248                                                             sizeof(WriteMemory_XPROG_Params).ProgData), NULL);
 249         WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
 250         WriteMemory_XPROG_Params.Length  = SwapEndian_16(WriteMemory_XPROG_Params.Length);
 251         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length, NULL);
 252
 253         // The driver will terminate transfers that are a round multiple of the endpoint bank in size with a ZLP, need
 254         // to catch this and discard it before continuing on with packet processing to prevent communication issues
 255         if (((sizeof(uint8_t) + sizeof(WriteMemory_XPROG_Params) - sizeof(WriteMemory_XPROG_Params.ProgData)) +
 256             WriteMemory_XPROG_Params.Length) % AVRISP_DATA_EPSIZE == 0)
 257         {
 258                 Endpoint_ClearOUT();
 259                 Endpoint_WaitUntilReady();
 260         }
 261
 262         Endpoint_ClearOUT();
 263         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
 264         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 265
 266         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 267         {
 268                 /* Assume FLASH page programming by default, as it is the common case */
 269                 uint8_t WriteCommand     = XMEGA_NVM_CMD_WRITEFLASHPAGE;
 270                 uint8_t WriteBuffCommand = XMEGA_NVM_CMD_LOADFLASHPAGEBUFF;
 271                 uint8_t EraseBuffCommand = XMEGA_NVM_CMD_ERASEFLASHPAGEBUFF;
 272                 bool    PagedMemory      = true;
 273
 274                 switch (WriteMemory_XPROG_Params.MemoryType)
 275                 {
 276                         case XPRG_MEM_TYPE_APPL:
 277                                 WriteCommand     = XMEGA_NVM_CMD_WRITEAPPSECPAGE;
 278                                 break;
 279                         case XPRG_MEM_TYPE_BOOT:
 280                                 WriteCommand     = XMEGA_NVM_CMD_WRITEBOOTSECPAGE;
 281                                 break;
 282                         case XPRG_MEM_TYPE_EEPROM:
 283                                 WriteCommand     = XMEGA_NVM_CMD_ERASEWRITEEEPROMPAGE;
 284                                 WriteBuffCommand = XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF;
 285                                 EraseBuffCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGEBUFF;
 286                                 break;
 287                         case XPRG_MEM_TYPE_USERSIG:
 288                                 WriteCommand     = XMEGA_NVM_CMD_WRITEUSERSIG;
 289                                 break;
 290                         case XPRG_MEM_TYPE_FUSE:
 291                                 WriteCommand     = XMEGA_NVM_CMD_WRITEFUSE;
 292                                 PagedMemory      = false;
 293                                 break;
 294                         case XPRG_MEM_TYPE_LOCKBITS:
 295                                 WriteCommand     = XMEGA_NVM_CMD_WRITELOCK;
 296                                 PagedMemory      = false;
 297                                 break;
 298                 }
 299
 300                 /* Send the appropriate memory write commands to the device, indicate timeout if occurred */
 301                 if ((PagedMemory && !(XMEGANVM_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand,
 302                                                                                                            WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,
 303                                                                                                            WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length))) ||
 304                    (!PagedMemory && !(XMEGANVM_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address,
 305                                                                                                            WriteMemory_XPROG_Params.ProgData[0]))))
 306                 {
 307                         ReturnStatus = XPRG_ERR_TIMEOUT;
 308                 }
 309         }
 310         else
 311         {
 312                 /* Send write command to the TPI device, indicate timeout if occurred */
 313                 if (!(TINYNVM_WriteMemory(WriteMemory_XPROG_Params.Address, WriteMemory_XPROG_Params.ProgData,
 314                       WriteMemory_XPROG_Params.Length)))
 315                 {
 316                         ReturnStatus = XPRG_ERR_TIMEOUT;
 317                 }
 318         }
 319
 320         Endpoint_Write_8(CMD_XPROG);
 321         Endpoint_Write_8(XPRG_CMD_WRITE_MEM);
 322         Endpoint_Write_8(ReturnStatus);
 323         Endpoint_ClearIN();
 324 }
 325
 326 /** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 327  *  attached device.
 328  */
 329 static void XPROGProtocol_ReadMemory(void)
 330 {
 331         uint8_t ReturnStatus = XPRG_ERR_OK;
 332
 333         struct
 334         {
 335                 uint8_t  MemoryType;
 336                 uint32_t Address;
 337                 uint16_t Length;
 338         } ReadMemory_XPROG_Params;
 339
 340         Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params), NULL);
 341         ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
 342         ReadMemory_XPROG_Params.Length  = SwapEndian_16(ReadMemory_XPROG_Params.Length);
 343
 344         Endpoint_ClearOUT();
 345         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
 346         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 347
 348         uint8_t ReadBuffer[256];
 349
 350         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 351         {
 352                 /* Read the PDI target's memory, indicate timeout if occurred */
 353                 if (!(XMEGANVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
 354                   ReturnStatus = XPRG_ERR_TIMEOUT;
 355         }
 356         else
 357         {
 358                 /* Read the TPI target's memory, indicate timeout if occurred */
 359                 if (!(TINYNVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
 360                   ReturnStatus = XPRG_ERR_TIMEOUT;
 361         }
 362
 363         Endpoint_Write_8(CMD_XPROG);
 364         Endpoint_Write_8(XPRG_CMD_READ_MEM);
 365         Endpoint_Write_8(ReturnStatus);
 366
 367         if (ReturnStatus == XPRG_ERR_OK)
 368           Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length, NULL);
 369
 370         Endpoint_ClearIN();
 371 }
 372
 373 /** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the
 374  *  attached device's memory and a data set on the host.
 375  */
 376 static void XPROGProtocol_ReadCRC(void)
 377 {
 378         uint8_t ReturnStatus = XPRG_ERR_OK;
 379
 380         struct
 381         {
 382                 uint8_t CRCType;
 383         } ReadCRC_XPROG_Params;
 384
 385         Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params), NULL);
 386
 387         Endpoint_ClearOUT();
 388         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
 389         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 390
 391         uint32_t MemoryCRC;
 392
 393         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 394         {
 395                 uint8_t CRCCommand;
 396
 397                 /* Determine which NVM command to send to the device depending on the memory to CRC */
 398                 switch (ReadCRC_XPROG_Params.CRCType)
 399                 {
 400                         case XPRG_CRC_APP:
 401                                 CRCCommand = XMEGA_NVM_CMD_APPCRC;
 402                                 break;
 403                         case XPRG_CRC_BOOT:
 404                                 CRCCommand = XMEGA_NVM_CMD_BOOTCRC;
 405                                 break;
 406                         default:
 407                                 CRCCommand = XMEGA_NVM_CMD_FLASHCRC;
 408                                 break;
 409                 }
 410
 411                 /* Perform and retrieve the memory CRC, indicate timeout if occurred */
 412                 if (!(XMEGANVM_GetMemoryCRC(CRCCommand, &MemoryCRC)))
 413                   ReturnStatus = XPRG_ERR_TIMEOUT;
 414         }
 415         else
 416         {
 417                 /* TPI does not support memory CRC */
 418                 ReturnStatus = XPRG_ERR_FAILED;
 419         }
 420
 421         Endpoint_Write_8(CMD_XPROG);
 422         Endpoint_Write_8(XPRG_CMD_CRC);
 423         Endpoint_Write_8(ReturnStatus);
 424
 425         if (ReturnStatus == XPRG_ERR_OK)
 426         {
 427                 Endpoint_Write_8(MemoryCRC >> 16);
 428                 Endpoint_Write_16_LE(MemoryCRC & 0xFFFF);
 429         }
 430
 431         Endpoint_ClearIN();
 432 }
 433
 434 /** Handler for the XPROG SET_PARAM command to set a XPROG parameter for use when communicating with the
 435  *  attached device.
 436  */
 437 static void XPROGProtocol_SetParam(void)
 438 {
 439         uint8_t ReturnStatus = XPRG_ERR_OK;
 440
 441         uint8_t XPROGParam = Endpoint_Read_8();
 442
 443         /* Determine which parameter is being set, store the new parameter value */
 444         switch (XPROGParam)
 445         {
 446                 case XPRG_PARAM_NVMBASE:
 447                         XPROG_Param_NVMBase       = Endpoint_Read_32_BE();
 448                         break;
 449                 case XPRG_PARAM_EEPPAGESIZE:
 450                         XPROG_Param_EEPageSize    = Endpoint_Read_16_BE();
 451                         break;
 452                 case XPRG_PARAM_NVMCMD_REG:
 453                         XPROG_Param_NVMCMDRegAddr = Endpoint_Read_8();
 454                         break;
 455                 case XPRG_PARAM_NVMCSR_REG:
 456                         XPROG_Param_NVMCSRRegAddr = Endpoint_Read_8();
 457                         break;
 458                 case XPRG_PARAM_UNKNOWN_1:
 459                         /* TODO: Undocumented parameter added in AVRStudio 5.1, purpose unknown. Must ACK and discard or
 460                                  the communication with AVRStudio 5.1 will fail.
 461                         */
 462                         Endpoint_Discard_16();
 463                         break;
 464                 default:
 465                         ReturnStatus = XPRG_ERR_FAILED;
 466                         break;
 467         }
 468
 469         Endpoint_ClearOUT();
 470         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPADDR);
 471         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 472
 473         Endpoint_Write_8(CMD_XPROG);
 474         Endpoint_Write_8(XPRG_CMD_SET_PARAM);
 475         Endpoint_Write_8(ReturnStatus);
 476         Endpoint_ClearIN();
 477 }
 478
 479 #endif
 480