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                 XPROGTarget_DisableTargetPDI();
 180         }
 181         else
 182         {
 183                 TINYNVM_WaitWhileNVMBusBusy();
 184
 185                 /* Clear the NVMEN bit in the TPI CONTROL register to disable TPI mode */
 186                 XPROGTarget_SendByte(TPI_CMD_SSTCS | TPI_CTRL_REG);
 187                 XPROGTarget_SendByte(0x00);
 188
 189                 XPROGTarget_DisableTargetTPI();
 190         }
 191
 192         Endpoint_Write_Byte(CMD_XPROG);
 193         Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
 194         Endpoint_Write_Byte(XPRG_ERR_OK);
 195         Endpoint_ClearIN();
 196 }
 197
 198 /** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
 199 static void XPROGProtocol_Erase(void)
 200 {
 201         uint8_t ReturnStatus = XPRG_ERR_OK;
 202
 203         struct
 204         {
 205                 uint8_t  MemoryType;
 206                 uint32_t Address;
 207         } Erase_XPROG_Params;
 208
 209         Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params), NO_STREAM_CALLBACK);
 210         Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address);
 211
 212         Endpoint_ClearOUT();
 213         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 214
 215         uint8_t EraseCommand;
 216
 217         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 218         {
 219                 /* Determine which NVM command to send to the device depending on the memory to erase */
 220                 switch (Erase_XPROG_Params.MemoryType)
 221                 {
 222                         case XPRG_ERASE_CHIP:
 223                                 EraseCommand = XMEGA_NVM_CMD_CHIPERASE;
 224                                 break;
 225                         case XPRG_ERASE_APP:
 226                                 EraseCommand = XMEGA_NVM_CMD_ERASEAPPSEC;
 227                                 break;
 228                         case XPRG_ERASE_BOOT:
 229                                 EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSEC;
 230                                 break;
 231                         case XPRG_ERASE_EEPROM:
 232                                 EraseCommand = XMEGA_NVM_CMD_ERASEEEPROM;
 233                                 break;
 234                         case XPRG_ERASE_APP_PAGE:
 235                                 EraseCommand = XMEGA_NVM_CMD_ERASEAPPSECPAGE;
 236                                 break;
 237                         case XPRG_ERASE_BOOT_PAGE:
 238                                 EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSECPAGE;
 239                                 break;
 240                         case XPRG_ERASE_EEPROM_PAGE:
 241                                 EraseCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGE;
 242                                 break;
 243                         case XPRG_ERASE_USERSIG:
 244                                 EraseCommand = XMEGA_NVM_CMD_ERASEUSERSIG;
 245                                 break;
 246                         default:
 247                                 EraseCommand = XMEGA_NVM_CMD_NOOP;
 248                                 break;
 249                 }
 250
 251                 /* Erase the target memory, indicate timeout if ocurred */
 252                 if (!(XMEGANVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
 253                   ReturnStatus = XPRG_ERR_TIMEOUT;
 254         }
 255         else
 256         {
 257                 if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP)
 258                   EraseCommand = TINY_NVM_CMD_CHIPERASE;
 259                 else
 260                   EraseCommand = TINY_NVM_CMD_SECTIONERASE;
 261
 262                 /* Erase the target memory, indicate timeout if ocurred */
 263                 if (!(TINYNVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
 264                   ReturnStatus = XPRG_ERR_TIMEOUT;
 265         }
 266
 267         Endpoint_Write_Byte(CMD_XPROG);
 268         Endpoint_Write_Byte(XPRG_CMD_ERASE);
 269         Endpoint_Write_Byte(ReturnStatus);
 270         Endpoint_ClearIN();
 271 }
 272
 273 /** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
 274 static void XPROGProtocol_WriteMemory(void)
 275 {
 276         uint8_t ReturnStatus = XPRG_ERR_OK;
 277
 278         struct
 279         {
 280                 uint8_t  MemoryType;
 281                 uint8_t  PageMode;
 282                 uint32_t Address;
 283                 uint16_t Length;
 284                 uint8_t  ProgData[256];
 285         } WriteMemory_XPROG_Params;
 286
 287         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
 288                                                             sizeof(WriteMemory_XPROG_Params).ProgData), NO_STREAM_CALLBACK);
 289         WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
 290         WriteMemory_XPROG_Params.Length  = SwapEndian_16(WriteMemory_XPROG_Params.Length);
 291         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length, NO_STREAM_CALLBACK);
 292
 293         Endpoint_ClearOUT();
 294         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 295
 296         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 297         {
 298                 /* Assume FLASH page programming by default, as it is the common case */
 299                 uint8_t WriteCommand     = XMEGA_NVM_CMD_WRITEFLASHPAGE;
 300                 uint8_t WriteBuffCommand = XMEGA_NVM_CMD_LOADFLASHPAGEBUFF;
 301                 uint8_t EraseBuffCommand = XMEGA_NVM_CMD_ERASEFLASHPAGEBUFF;
 302                 bool    PagedMemory      = true;
 303
 304                 switch (WriteMemory_XPROG_Params.MemoryType)
 305                 {
 306                         case XPRG_MEM_TYPE_APPL:
 307                                 WriteCommand     = XMEGA_NVM_CMD_WRITEAPPSECPAGE;
 308                                 break;
 309                         case XPRG_MEM_TYPE_BOOT:
 310                                 WriteCommand     = XMEGA_NVM_CMD_WRITEBOOTSECPAGE;
 311                                 break;
 312                         case XPRG_MEM_TYPE_EEPROM:
 313                                 WriteCommand     = XMEGA_NVM_CMD_WRITEEEPROMPAGE;
 314                                 WriteBuffCommand = XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF;
 315                                 EraseBuffCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGEBUFF;
 316                                 break;
 317                         case XPRG_MEM_TYPE_USERSIG:
 318                                 /* User signature is paged, but needs us to manually indicate the mode bits since the host doesn't set them */
 319                                 WriteMemory_XPROG_Params.PageMode = (XPRG_PAGEMODE_ERASE | XPRG_PAGEMODE_WRITE);
 320                                 WriteCommand     = XMEGA_NVM_CMD_WRITEUSERSIG;
 321                                 break;
 322                         case XPRG_MEM_TYPE_FUSE:
 323                                 WriteCommand     = XMEGA_NVM_CMD_WRITEFUSE;
 324                                 PagedMemory      = false;
 325                                 break;
 326                         case XPRG_MEM_TYPE_LOCKBITS:
 327                                 WriteCommand     = XMEGA_NVM_CMD_WRITELOCK;
 328                                 PagedMemory      = false;
 329                                 break;
 330                 }
 331
 332                 /* Send the appropriate memory write commands to the device, indicate timeout if occurred */
 333                 if ((PagedMemory && !(XMEGANVM_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand,
 334                                                                                                            WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,
 335                                                                                                            WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length))) ||
 336                    (!PagedMemory && !(XMEGANVM_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address,
 337                                                                                                            WriteMemory_XPROG_Params.ProgData[0]))))
 338                 {
 339                         ReturnStatus = XPRG_ERR_TIMEOUT;
 340                 }
 341         }
 342         else
 343         {
 344                 /* Send write command to the TPI device, indicate timeout if occurred */
 345                 if (!(TINYNVM_WriteMemory(WriteMemory_XPROG_Params.Address, WriteMemory_XPROG_Params.ProgData,
 346                       WriteMemory_XPROG_Params.Length)))
 347                 {
 348                         ReturnStatus = XPRG_ERR_TIMEOUT;
 349                 }
 350         }
 351
 352         Endpoint_Write_Byte(CMD_XPROG);
 353         Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM);
 354         Endpoint_Write_Byte(ReturnStatus);
 355         Endpoint_ClearIN();
 356 }
 357
 358 /** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 359  *  attached device.
 360  */
 361 static void XPROGProtocol_ReadMemory(void)
 362 {
 363         uint8_t ReturnStatus = XPRG_ERR_OK;
 364
 365         struct
 366         {
 367                 uint8_t  MemoryType;
 368                 uint32_t Address;
 369                 uint16_t Length;
 370         } ReadMemory_XPROG_Params;
 371
 372         Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params), NO_STREAM_CALLBACK);
 373         ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
 374         ReadMemory_XPROG_Params.Length  = SwapEndian_16(ReadMemory_XPROG_Params.Length);
 375
 376         Endpoint_ClearOUT();
 377         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 378
 379         uint8_t ReadBuffer[256];
 380
 381         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 382         {
 383                 /* Read the PDI target's memory, indicate timeout if occurred */
 384                 if (!(XMEGANVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
 385                   ReturnStatus = XPRG_ERR_TIMEOUT;
 386         }
 387         else
 388         {
 389                 /* Read the TPI target's memory, indicate timeout if occurred */
 390                 if (!(TINYNVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
 391                   ReturnStatus = XPRG_ERR_TIMEOUT;
 392         }
 393
 394         Endpoint_Write_Byte(CMD_XPROG);
 395         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 396         Endpoint_Write_Byte(ReturnStatus);
 397
 398         if (ReturnStatus == XPRG_ERR_OK)
 399           Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length, NO_STREAM_CALLBACK);
 400
 401         Endpoint_ClearIN();
 402 }
 403
 404 /** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the
 405  *  attached device's memory and a data set on the host.
 406  */
 407 static void XPROGProtocol_ReadCRC(void)
 408 {
 409         uint8_t ReturnStatus = XPRG_ERR_OK;
 410
 411         struct
 412         {
 413                 uint8_t CRCType;
 414         } ReadCRC_XPROG_Params;
 415
 416         Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params), NO_STREAM_CALLBACK);
 417
 418         Endpoint_ClearOUT();
 419         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 420
 421         uint32_t MemoryCRC;
 422
 423         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 424         {
 425                 uint8_t CRCCommand;
 426
 427                 /* Determine which NVM command to send to the device depending on the memory to CRC */
 428                 switch (ReadCRC_XPROG_Params.CRCType)
 429                 {
 430                         case XPRG_CRC_APP:
 431                                 CRCCommand = XMEGA_NVM_CMD_APPCRC;
 432                                 break;
 433                         case XPRG_CRC_BOOT:
 434                                 CRCCommand = XMEGA_NVM_CMD_BOOTCRC;
 435                                 break;
 436                         default:
 437                                 CRCCommand = XMEGA_NVM_CMD_FLASHCRC;
 438                                 break;
 439                 }
 440
 441                 /* Perform and retrieve the memory CRC, indicate timeout if occurred */
 442                 if (!(XMEGANVM_GetMemoryCRC(CRCCommand, &MemoryCRC)))
 443                   ReturnStatus = XPRG_ERR_TIMEOUT;
 444         }
 445         else
 446         {
 447                 /* TPI does not support memory CRC */
 448                 ReturnStatus = XPRG_ERR_FAILED;
 449         }
 450
 451         Endpoint_Write_Byte(CMD_XPROG);
 452         Endpoint_Write_Byte(XPRG_CMD_CRC);
 453         Endpoint_Write_Byte(ReturnStatus);
 454
 455         if (ReturnStatus == XPRG_ERR_OK)
 456         {
 457                 Endpoint_Write_Byte(MemoryCRC >> 16);
 458                 Endpoint_Write_Word_LE(MemoryCRC & 0xFFFF);
 459         }
 460
 461         Endpoint_ClearIN();
 462 }
 463
 464 /** Handler for the XPROG SET_PARAM command to set a XPROG parameter for use when communicating with the
 465  *  attached device.
 466  */
 467 static void XPROGProtocol_SetParam(void)
 468 {
 469         uint8_t ReturnStatus = XPRG_ERR_OK;
 470
 471         uint8_t XPROGParam = Endpoint_Read_Byte();
 472
 473         /* Determine which parameter is being set, store the new parameter value */
 474         switch (XPROGParam)
 475         {
 476                 case XPRG_PARAM_NVMBASE:
 477                         XPROG_Param_NVMBase = Endpoint_Read_DWord_BE();
 478                         break;
 479                 case XPRG_PARAM_EEPPAGESIZE:
 480                         XPROG_Param_EEPageSize = Endpoint_Read_Word_BE();
 481                         break;
 482                 case XPRG_PARAM_NVMCMD_REG:
 483                         XPROG_Param_NVMCMDRegAddr = Endpoint_Read_Byte();
 484                         break;
 485                 case XPRG_PARAM_NVMCSR_REG:
 486                         XPROG_Param_NVMCSRRegAddr = Endpoint_Read_Byte();
 487                         break;
 488                 default:
 489                         ReturnStatus = XPRG_ERR_FAILED;
 490                         break;
 491         }
 492
 493         Endpoint_ClearOUT();
 494         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 495
 496         Endpoint_Write_Byte(CMD_XPROG);
 497         Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);
 498         Endpoint_Write_Byte(ReturnStatus);
 499         Endpoint_ClearIN();
 500 }
 501
 502 #endif