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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 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  *  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;
  45
  46 /** Address of the TPI device's NVMCMD register for TPI programming */
  47 uint8_t  XPROG_Param_NVMCMDRegAddr;
  48
  49 /** Address of the TPI device's NVMCSR register for TPI programming */
  50 uint8_t  XPROG_Param_NVMCSRRegAddr;
  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), NO_STREAM_CALLBACK);
  66
  67         Endpoint_ClearOUT();
  68         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
  69
  70         XPROG_SelectedProtocol = SetMode_XPROG_Params.Protocol;
  71
  72         Endpoint_Write_Byte(CMD_XPROG_SETMODE);
  73         Endpoint_Write_Byte((SetMode_XPROG_Params.Protocol != XPRG_PROTOCOL_JTAG) ? STATUS_CMD_OK : STATUS_CMD_FAILED);
  74         Endpoint_ClearIN();
  75 }
  76
  77 /** Handler for the CMD_XPROG command, which wraps up XPROG commands in a V2 wrapper which need to be
  78  *  removed and processed so that the underlying XPROG command can be handled.
  79  */
  80 void XPROGProtocol_Command(void)
  81 {
  82         uint8_t XPROGCommand = Endpoint_Read_Byte();
  83
  84         switch (XPROGCommand)
  85         {
  86                 case XPRG_CMD_ENTER_PROGMODE:
  87                         XPROGProtocol_EnterXPROGMode();
  88                         break;
  89                 case XPRG_CMD_LEAVE_PROGMODE:
  90                         XPROGProtocol_LeaveXPROGMode();
  91                         break;
  92                 case XPRG_CMD_ERASE:
  93                         XPROGProtocol_Erase();
  94                         break;
  95                 case XPRG_CMD_WRITE_MEM:
  96                         XPROGProtocol_WriteMemory();
  97                         break;
  98                 case XPRG_CMD_READ_MEM:
  99                         XPROGProtocol_ReadMemory();
 100                         break;
 101                 case XPRG_CMD_CRC:
 102                         XPROGProtocol_ReadCRC();
 103                         break;
 104                 case XPRG_CMD_SET_PARAM:
 105                         XPROGProtocol_SetParam();
 106                         break;
 107         }
 108 }
 109
 110 /** Handler for the XPROG ENTER_PROGMODE command to establish a connection with the attached device. */
 111 static void XPROGProtocol_EnterXPROGMode(void)
 112 {
 113         Endpoint_ClearOUT();
 114         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 115
 116         bool NVMBusEnabled;
 117
 118         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 119         {
 120                 /* Enable PDI programming mode with the attached target */
 121                 XPROGTarget_EnableTargetPDI();
 122
 123                 /* Store the RESET key into the RESET PDI register to keep the XMEGA in reset */
 124                 XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
 125                 XPROGTarget_SendByte(PDI_RESET_KEY);
 126
 127                 /* Lower direction change guard time to 0 USART bits */
 128                 XPROGTarget_SendByte(PDI_CMD_STCS | PDI_CTRL_REG);
 129                 XPROGTarget_SendByte(0x07);
 130
 131                 /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
 132                 XPROGTarget_SendByte(PDI_CMD_KEY);
 133                 for (uint8_t i = sizeof(PDI_NVMENABLE_KEY); i > 0; i--)
 134                   XPROGTarget_SendByte(PDI_NVMENABLE_KEY[i - 1]);
 135
 136                 /* Wait until the NVM bus becomes active */
 137                 NVMBusEnabled = XMEGANVM_WaitWhileNVMBusBusy();
 138         }
 139         else
 140         {
 141                 /* Enable TPI programming mode with the attached target */
 142                 XPROGTarget_EnableTargetTPI();
 143
 144                 /* Lower direction change guard time to 0 USART bits */
 145                 XPROGTarget_SendByte(TPI_CMD_SSTCS | TPI_CTRL_REG);
 146                 XPROGTarget_SendByte(0x07);
 147
 148                 /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
 149                 XPROGTarget_SendByte(TPI_CMD_SKEY);
 150                 for (uint8_t i = sizeof(TPI_NVMENABLE_KEY); i > 0; i--)
 151                   XPROGTarget_SendByte(TPI_NVMENABLE_KEY[i - 1]);
 152
 153                 /* Wait until the NVM bus becomes active */
 154                 NVMBusEnabled = TINYNVM_WaitWhileNVMBusBusy();
 155         }
 156
 157         Endpoint_Write_Byte(CMD_XPROG);
 158         Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);
 159         Endpoint_Write_Byte(NVMBusEnabled ? XPRG_ERR_OK : XPRG_ERR_FAILED);
 160         Endpoint_ClearIN();
 161 }
 162
 163 /** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with
 164  *  the attached device.
 165  */
 166 static void XPROGProtocol_LeaveXPROGMode(void)
 167 {
 168         Endpoint_ClearOUT();
 169         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 170
 171         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 172         {
 173                 XMEGANVM_WaitWhileNVMBusBusy();
 174
 175                 /* Clear the RESET key in the RESET PDI register to allow the XMEGA to run */
 176                 XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
 177                 XPROGTarget_SendByte(0x00);
 178
 179                 /* Clear /RESET key twice (for some reason this needs to be done twice to take effect) */
 180                 XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
 181                 XPROGTarget_SendByte(0x00);
 182
 183                 XPROGTarget_DisableTargetPDI();
 184         }
 185         else
 186         {
 187                 TINYNVM_WaitWhileNVMBusBusy();
 188
 189                 /* Clear the NVMEN bit in the TPI CONTROL register to disable TPI mode */
 190                 XPROGTarget_SendByte(TPI_CMD_SSTCS | TPI_CTRL_REG);
 191                 XPROGTarget_SendByte(0x00);
 192
 193                 XPROGTarget_DisableTargetTPI();
 194         }
 195
 196         Endpoint_Write_Byte(CMD_XPROG);
 197         Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
 198         Endpoint_Write_Byte(XPRG_ERR_OK);
 199         Endpoint_ClearIN();
 200 }
 201
 202 /** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
 203 static void XPROGProtocol_Erase(void)
 204 {
 205         uint8_t ReturnStatus = XPRG_ERR_OK;
 206
 207         struct
 208         {
 209                 uint8_t  MemoryType;
 210                 uint32_t Address;
 211         } Erase_XPROG_Params;
 212
 213         Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params), NO_STREAM_CALLBACK);
 214         Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address);
 215
 216         Endpoint_ClearOUT();
 217         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 218
 219         uint8_t EraseCommand;
 220
 221         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 222         {
 223                 /* Determine which NVM command to send to the device depending on the memory to erase */
 224                 switch (Erase_XPROG_Params.MemoryType)
 225                 {
 226                         case XPRG_ERASE_CHIP:
 227                                 EraseCommand = XMEGA_NVM_CMD_CHIPERASE;
 228                                 break;
 229                         case XPRG_ERASE_APP:
 230                                 EraseCommand = XMEGA_NVM_CMD_ERASEAPPSEC;
 231                                 break;
 232                         case XPRG_ERASE_BOOT:
 233                                 EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSEC;
 234                                 break;
 235                         case XPRG_ERASE_EEPROM:
 236                                 EraseCommand = XMEGA_NVM_CMD_ERASEEEPROM;
 237                                 break;
 238                         case XPRG_ERASE_APP_PAGE:
 239                                 EraseCommand = XMEGA_NVM_CMD_ERASEAPPSECPAGE;
 240                                 break;
 241                         case XPRG_ERASE_BOOT_PAGE:
 242                                 EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSECPAGE;
 243                                 break;
 244                         case XPRG_ERASE_EEPROM_PAGE:
 245                                 EraseCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGE;
 246                                 break;
 247                         case XPRG_ERASE_USERSIG:
 248                                 EraseCommand = XMEGA_NVM_CMD_ERASEUSERSIG;
 249                                 break;
 250                         default:
 251                                 EraseCommand = XMEGA_NVM_CMD_NOOP;
 252                                 break;
 253                 }
 254
 255                 /* Erase the target memory, indicate timeout if ocurred */
 256                 if (!(XMEGANVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
 257                   ReturnStatus = XPRG_ERR_TIMEOUT;
 258         }
 259         else
 260         {
 261                 if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP)
 262                   EraseCommand = TINY_NVM_CMD_CHIPERASE;
 263                 else
 264                   EraseCommand = TINY_NVM_CMD_SECTIONERASE;
 265
 266                 /* Erase the target memory, indicate timeout if ocurred */
 267                 if (!(TINYNVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
 268                   ReturnStatus = XPRG_ERR_TIMEOUT;
 269         }
 270
 271         Endpoint_Write_Byte(CMD_XPROG);
 272         Endpoint_Write_Byte(XPRG_CMD_ERASE);
 273         Endpoint_Write_Byte(ReturnStatus);
 274         Endpoint_ClearIN();
 275 }
 276
 277 /** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
 278 static void XPROGProtocol_WriteMemory(void)
 279 {
 280         uint8_t ReturnStatus = XPRG_ERR_OK;
 281
 282         struct
 283         {
 284                 uint8_t  MemoryType;
 285                 uint8_t  PageMode;
 286                 uint32_t Address;
 287                 uint16_t Length;
 288                 uint8_t  ProgData[256];
 289         } WriteMemory_XPROG_Params;
 290
 291         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
 292                                                             sizeof(WriteMemory_XPROG_Params).ProgData), NO_STREAM_CALLBACK);
 293         WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
 294         WriteMemory_XPROG_Params.Length  = SwapEndian_16(WriteMemory_XPROG_Params.Length);
 295         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length, NO_STREAM_CALLBACK);
 296
 297         Endpoint_ClearOUT();
 298         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 299
 300         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 301         {
 302                 /* Assume FLASH page programming by default, as it is the common case */
 303                 uint8_t WriteCommand     = XMEGA_NVM_CMD_WRITEFLASHPAGE;
 304                 uint8_t WriteBuffCommand = XMEGA_NVM_CMD_LOADFLASHPAGEBUFF;
 305                 uint8_t EraseBuffCommand = XMEGA_NVM_CMD_ERASEFLASHPAGEBUFF;
 306                 bool    PagedMemory      = true;
 307
 308                 switch (WriteMemory_XPROG_Params.MemoryType)
 309                 {
 310                         case XPRG_MEM_TYPE_APPL:
 311                                 WriteCommand     = XMEGA_NVM_CMD_WRITEAPPSECPAGE;
 312                                 break;
 313                         case XPRG_MEM_TYPE_BOOT:
 314                                 WriteCommand     = XMEGA_NVM_CMD_WRITEBOOTSECPAGE;
 315                                 break;
 316                         case XPRG_MEM_TYPE_EEPROM:
 317                                 WriteCommand     = XMEGA_NVM_CMD_WRITEEEPROMPAGE;
 318                                 WriteBuffCommand = XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF;
 319                                 EraseBuffCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGEBUFF;
 320                                 break;
 321                         case XPRG_MEM_TYPE_USERSIG:
 322                                 /* User signature is paged, but needs us to manually indicate the mode bits since the host doesn't set them */
 323                                 WriteMemory_XPROG_Params.PageMode = (XPRG_PAGEMODE_ERASE | XPRG_PAGEMODE_WRITE);
 324                                 WriteCommand     = XMEGA_NVM_CMD_WRITEUSERSIG;
 325                                 break;
 326                         case XPRG_MEM_TYPE_FUSE:
 327                                 WriteCommand     = XMEGA_NVM_CMD_WRITEFUSE;
 328                                 PagedMemory      = false;
 329                                 break;
 330                         case XPRG_MEM_TYPE_LOCKBITS:
 331                                 WriteCommand     = XMEGA_NVM_CMD_WRITELOCK;
 332                                 PagedMemory      = false;
 333                                 break;
 334                 }
 335
 336                 /* Send the appropriate memory write commands to the device, indicate timeout if occurred */
 337                 if ((PagedMemory && !(XMEGANVM_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand,
 338                                                                                                            WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,
 339                                                                                                            WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length))) ||
 340                    (!PagedMemory && !(XMEGANVM_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address,
 341                                                                                                            WriteMemory_XPROG_Params.ProgData[0]))))
 342                 {
 343                         ReturnStatus = XPRG_ERR_TIMEOUT;
 344                 }
 345         }
 346         else
 347         {
 348                 /* Send write command to the TPI device, indicate timeout if occurred */
 349                 if (!(TINYNVM_WriteMemory(WriteMemory_XPROG_Params.Address, WriteMemory_XPROG_Params.ProgData,
 350                       WriteMemory_XPROG_Params.Length)))
 351                 {
 352                         ReturnStatus = XPRG_ERR_TIMEOUT;
 353                 }
 354         }
 355
 356         Endpoint_Write_Byte(CMD_XPROG);
 357         Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM);
 358         Endpoint_Write_Byte(ReturnStatus);
 359         Endpoint_ClearIN();
 360 }
 361
 362 /** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 363  *  attached device.
 364  */
 365 static void XPROGProtocol_ReadMemory(void)
 366 {
 367         uint8_t ReturnStatus = XPRG_ERR_OK;
 368
 369         struct
 370         {
 371                 uint8_t  MemoryType;
 372                 uint32_t Address;
 373                 uint16_t Length;
 374         } ReadMemory_XPROG_Params;
 375
 376         Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params), NO_STREAM_CALLBACK);
 377         ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
 378         ReadMemory_XPROG_Params.Length  = SwapEndian_16(ReadMemory_XPROG_Params.Length);
 379
 380         Endpoint_ClearOUT();
 381         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 382
 383         uint8_t ReadBuffer[256];
 384
 385         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 386         {
 387                 /* Read the PDI target's memory, indicate timeout if occurred */
 388                 if (!(XMEGANVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
 389                   ReturnStatus = XPRG_ERR_TIMEOUT;
 390         }
 391         else
 392         {
 393                 /* Read the TPI target's memory, indicate timeout if occurred */
 394                 if (!(TINYNVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
 395                   ReturnStatus = XPRG_ERR_TIMEOUT;
 396         }
 397
 398         Endpoint_Write_Byte(CMD_XPROG);
 399         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 400         Endpoint_Write_Byte(ReturnStatus);
 401
 402         if (ReturnStatus == XPRG_ERR_OK)
 403           Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length, NO_STREAM_CALLBACK);
 404
 405         Endpoint_ClearIN();
 406 }
 407
 408 /** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the
 409  *  attached device's memory and a data set on the host.
 410  */
 411 static void XPROGProtocol_ReadCRC(void)
 412 {
 413         uint8_t ReturnStatus = XPRG_ERR_OK;
 414
 415         struct
 416         {
 417                 uint8_t CRCType;
 418         } ReadCRC_XPROG_Params;
 419
 420         Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params), NO_STREAM_CALLBACK);
 421
 422         Endpoint_ClearOUT();
 423         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 424
 425         uint32_t MemoryCRC;
 426
 427         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 428         {
 429                 uint8_t CRCCommand;
 430
 431                 /* Determine which NVM command to send to the device depending on the memory to CRC */
 432                 switch (ReadCRC_XPROG_Params.CRCType)
 433                 {
 434                         case XPRG_CRC_APP:
 435                                 CRCCommand = XMEGA_NVM_CMD_APPCRC;
 436                                 break;
 437                         case XPRG_CRC_BOOT:
 438                                 CRCCommand = XMEGA_NVM_CMD_BOOTCRC;
 439                                 break;
 440                         default:
 441                                 CRCCommand = XMEGA_NVM_CMD_FLASHCRC;
 442                                 break;
 443                 }
 444
 445                 /* Perform and retrieve the memory CRC, indicate timeout if occurred */
 446                 if (!(XMEGANVM_GetMemoryCRC(CRCCommand, &MemoryCRC)))
 447                   ReturnStatus = XPRG_ERR_TIMEOUT;
 448         }
 449         else
 450         {
 451                 /* TPI does not support memory CRC */
 452                 ReturnStatus = XPRG_ERR_FAILED;
 453         }
 454
 455         Endpoint_Write_Byte(CMD_XPROG);
 456         Endpoint_Write_Byte(XPRG_CMD_CRC);
 457         Endpoint_Write_Byte(ReturnStatus);
 458
 459         if (ReturnStatus == XPRG_ERR_OK)
 460         {
 461                 Endpoint_Write_Byte(MemoryCRC >> 16);
 462                 Endpoint_Write_Word_LE(MemoryCRC & 0xFFFF);
 463         }
 464
 465         Endpoint_ClearIN();
 466 }
 467
 468 /** Handler for the XPROG SET_PARAM command to set a XPROG parameter for use when communicating with the
 469  *  attached device.
 470  */
 471 static void XPROGProtocol_SetParam(void)
 472 {
 473         uint8_t ReturnStatus = XPRG_ERR_OK;
 474
 475         uint8_t XPROGParam = Endpoint_Read_Byte();
 476
 477         /* Determine which parameter is being set, store the new parameter value */
 478         switch (XPROGParam)
 479         {
 480                 case XPRG_PARAM_NVMBASE:
 481                         XPROG_Param_NVMBase = Endpoint_Read_DWord_BE();
 482                         break;
 483                 case XPRG_PARAM_EEPPAGESIZE:
 484                         XPROG_Param_EEPageSize = Endpoint_Read_Word_BE();
 485                         break;
 486                 case XPRG_PARAM_NVMCMD_REG:
 487                         XPROG_Param_NVMCMDRegAddr = Endpoint_Read_Byte();
 488                         break;
 489                 case XPRG_PARAM_NVMCSR_REG:
 490                         XPROG_Param_NVMCSRRegAddr = Endpoint_Read_Byte();
 491                         break;
 492                 default:
 493                         ReturnStatus = XPRG_ERR_FAILED;
 494                         break;
 495         }
 496
 497         Endpoint_ClearOUT();
 498         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 499
 500         Endpoint_Write_Byte(CMD_XPROG);
 501         Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);
 502         Endpoint_Write_Byte(ReturnStatus);
 503         Endpoint_ClearIN();
 504 }
 505
 506 #endif