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