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