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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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  *  Target-related functions for the XMEGA target's NVM module.
  34  */
  35
  36 #define  INCLUDE_FROM_XMEGA_NVM_C
  37 #include "XMEGANVM.h"
  38
  39 #if defined(ENABLE_XPROG_PROTOCOL) || defined(__DOXYGEN__)
  40
  41 /** Sends the given 32-bit absolute address to the target.
  42  *
  43  *  \param[in] AbsoluteAddress  Absolute address to send to the target
  44  */
  45 static void XMEGANVM_SendAddress(const uint32_t AbsoluteAddress)
  46 {
  47         /* Send the given 32-bit address to the target, LSB first */
  48         XPROGTarget_SendByte(AbsoluteAddress &  0xFF);
  49         XPROGTarget_SendByte(AbsoluteAddress >> 8);
  50         XPROGTarget_SendByte(AbsoluteAddress >> 16);
  51         XPROGTarget_SendByte(AbsoluteAddress >> 24);
  52 }
  53
  54 /** Sends the given NVM register address to the target.
  55  *
  56  *  \param[in] Register  NVM register whose absolute address is to be sent
  57  */
  58 static void XMEGANVM_SendNVMRegAddress(const uint8_t Register)
  59 {
  60         /* Determine the absolute register address from the NVM base memory address and the NVM register address */
  61         uint32_t Address = XPROG_Param_NVMBase | Register;
  62
  63         /* Send the calculated 32-bit address to the target, LSB first */
  64         XMEGANVM_SendAddress(Address);
  65 }
  66
  67 /** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read or CRC
  68  *  calculation.
  69  *
  70  *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
  71  */
  72 bool XMEGANVM_WaitWhileNVMBusBusy(void)
  73 {
  74         /* Poll the STATUS register to check to see if NVM access has been enabled */
  75         for (;;)
  76         {
  77                 /* Send the LDCS command to read the PDI STATUS register to see the NVM bus is active */
  78                 XPROGTarget_SendByte(PDI_CMD_LDCS | PDI_STATUS_REG);
  79
  80                 uint8_t StatusRegister = XPROGTarget_ReceiveByte();
  81
  82                 /* We might have timed out waiting for the status register read response, check here */
  83                 if (TimeoutExpired)
  84                   return false;
  85
  86                 /* Check the status register read response to see if the NVM bus is enabled */
  87                 if (StatusRegister & PDI_STATUS_NVM)
  88                   return true;
  89         }
  90 }
  91
  92 /** Waits while the target's NVM controller is busy performing an operation, exiting if the
  93  *  timeout period expires.
  94  *
  95  *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
  96  */
  97 bool XMEGANVM_WaitWhileNVMControllerBusy(void)
  98 {
  99         /* Preload the pointer register with the NVM STATUS register address to check the BUSY flag */
 100         XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
 101         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_STATUS);
 102
 103         /* Poll the NVM STATUS register while the NVM controller is busy */
 104         for (;;)
 105         {
 106                 /* Fetch the current status value via the pointer register (without auto-increment afterwards) */
 107                 XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT << 2) | PDI_DATSIZE_1BYTE);
 108
 109                 uint8_t StatusRegister = XPROGTarget_ReceiveByte();
 110
 111                 /* We might have timed out waiting for the status register read response, check here */
 112                 if (TimeoutExpired)
 113                   return false;
 114
 115                 /* Check to see if the BUSY flag is still set */
 116                 if (!(StatusRegister & (1 << 7)))
 117                   return true;
 118         }
 119 }
 120
 121 /** Enables the physical PDI interface on the target and enables access to the internal NVM controller.
 122  *
 123  *  \return Boolean true if the PDI interface was enabled successfully, false otherwise
 124  */
 125 bool XMEGANVM_EnablePDI(void)
 126 {
 127         /* Enable PDI programming mode with the attached target */
 128         XPROGTarget_EnableTargetPDI();
 129
 130         /* Store the RESET key into the RESET PDI register to keep the XMEGA in reset */
 131         XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
 132         XPROGTarget_SendByte(PDI_RESET_KEY);
 133
 134         /* Lower direction change guard time to 0 USART bits */
 135         XPROGTarget_SendByte(PDI_CMD_STCS | PDI_CTRL_REG);
 136         XPROGTarget_SendByte(0x07);
 137
 138         /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
 139         XPROGTarget_SendByte(PDI_CMD_KEY);
 140         for (uint8_t i = sizeof(PDI_NVMENABLE_KEY); i > 0; i--)
 141           XPROGTarget_SendByte(PDI_NVMENABLE_KEY[i - 1]);
 142
 143         /* Wait until the NVM bus becomes active */
 144         return XMEGANVM_WaitWhileNVMBusBusy();
 145 }
 146
 147 /** Removes access to the target's NVM controller and physically disables the target's physical PDI interface. */
 148 void XMEGANVM_DisablePDI(void)
 149 {
 150         XMEGANVM_WaitWhileNVMBusBusy();
 151
 152         /* Clear the RESET key in the RESET PDI register to allow the XMEGA to run - must perform this until the
 153          * change takes effect, as in some cases it takes multiple writes (silicon bug?).
 154          */
 155         do
 156         {
 157                 /* Clear reset register */
 158                 XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
 159                 XPROGTarget_SendByte(0x00);
 160
 161                 /* Read back the reset register, check to see if it took effect */
 162                 XPROGTarget_SendByte(PDI_CMD_LDCS | PDI_RESET_REG);
 163         } while (XPROGTarget_ReceiveByte() != 0x00);
 164
 165         XPROGTarget_DisableTargetPDI();
 166 }
 167
 168 /** Retrieves the CRC value of the given memory space.
 169  *
 170  *  \param[in]  CRCCommand  NVM CRC command to issue to the target
 171  *  \param[out] CRCDest     CRC Destination when read from the target
 172  *
 173  *  \return Boolean true if the command sequence complete successfully
 174  */
 175 bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand, uint32_t* const CRCDest)
 176 {
 177         /* Wait until the NVM controller is no longer busy */
 178         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 179           return false;
 180
 181         /* Set the NVM command to the correct CRC read command */
 182         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 183         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 184         XPROGTarget_SendByte(CRCCommand);
 185
 186         /* Set CMDEX bit in NVM CTRLA register to start the CRC generation */
 187         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 188         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
 189         XPROGTarget_SendByte(XMEGA_NVM_BIT_CTRLA_CMDEX);
 190
 191         /* Wait until the NVM bus is ready again */
 192         if (!(XMEGANVM_WaitWhileNVMBusBusy()))
 193           return false;
 194
 195         /* Wait until the NVM controller is no longer busy */
 196         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 197           return false;
 198
 199         /* Load the PDI pointer register with the DAT0 register start address */
 200         XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
 201         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_DAT0);
 202
 203         /* Send the REPEAT command to grab the CRC bytes */
 204         XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
 205         XPROGTarget_SendByte(XMEGA_CRC_LENGTH_BYTES - 1);
 206
 207         /* Read in the CRC bytes from the target */
 208         XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
 209         for (uint8_t i = 0; i < XMEGA_CRC_LENGTH_BYTES; i++)
 210           ((uint8_t*)CRCDest)[i] = XPROGTarget_ReceiveByte();
 211
 212         return (TimeoutExpired == false);
 213 }
 214
 215 /** Reads memory from the target's memory spaces.
 216  *
 217  *  \param[in]  ReadAddress  Start address to read from within the target's address space
 218  *  \param[out] ReadBuffer   Buffer to store read data into
 219  *  \param[in]  ReadSize     Number of bytes to read
 220  *
 221  *  \return Boolean true if the command sequence complete successfully
 222  */
 223 bool XMEGANVM_ReadMemory(const uint32_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize)
 224 {
 225         /* Wait until the NVM controller is no longer busy */
 226         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 227           return false;
 228
 229         /* Send the READNVM command to the NVM controller for reading of an arbitrary location */
 230         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 231         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 232         XPROGTarget_SendByte(XMEGA_NVM_CMD_READNVM);
 233
 234         /* Load the PDI pointer register with the start address we want to read from */
 235         XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
 236         XMEGANVM_SendAddress(ReadAddress);
 237
 238         /* Send the REPEAT command with the specified number of bytes to read */
 239         XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
 240         XPROGTarget_SendByte(ReadSize - 1);
 241
 242         /* Send a LD command with indirect access and post-increment to read out the bytes */
 243         XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
 244         while (ReadSize-- && !(TimeoutExpired))
 245           *(ReadBuffer++) = XPROGTarget_ReceiveByte();
 246
 247         return (TimeoutExpired == false);
 248 }
 249
 250 /** Writes byte addressed memory to the target's memory spaces.
 251  *
 252  *  \param[in]  WriteCommand  Command to send to the device to write each memory byte
 253  *  \param[in]  WriteAddress  Address to write to within the target's address space
 254  *  \param[in]  Byte          Byte to write to the target
 255  *
 256  *  \return Boolean true if the command sequence complete successfully
 257  */
 258 bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand, const uint32_t WriteAddress, const uint8_t Byte)
 259 {
 260         /* Wait until the NVM controller is no longer busy */
 261         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 262           return false;
 263
 264         /* Send the memory write command to the target */
 265         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 266         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 267         XPROGTarget_SendByte(WriteCommand);
 268
 269         /* Send new memory byte to the memory of the target */
 270         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 271         XMEGANVM_SendAddress(WriteAddress);
 272         XPROGTarget_SendByte(Byte);
 273
 274         return true;
 275 }
 276
 277 /** Writes page addressed memory to the target's memory spaces.
 278  *
 279  *  \param[in]  WriteBuffCommand  Command to send to the device to write a byte to the memory page buffer
 280  *  \param[in]  EraseBuffCommand  Command to send to the device to erase the memory page buffer
 281  *  \param[in]  WritePageCommand  Command to send to the device to write the page buffer to the destination memory
 282  *  \param[in]  PageMode          Bitfield indicating what operations need to be executed on the specified page
 283  *  \param[in]  WriteAddress      Start address to write the page data to within the target's address space
 284  *  \param[in]  WriteBuffer       Buffer to source data from
 285  *  \param[in]  WriteSize         Number of bytes to write
 286  *
 287  *  \return Boolean true if the command sequence complete successfully
 288  */
 289 bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand, const uint8_t EraseBuffCommand,
 290                               const uint8_t WritePageCommand, const uint8_t PageMode, const uint32_t WriteAddress,
 291                               const uint8_t* WriteBuffer, uint16_t WriteSize)
 292 {
 293         if (PageMode & XPRG_PAGEMODE_ERASE)
 294         {
 295                 /* Wait until the NVM controller is no longer busy */
 296                 if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 297                   return false;
 298
 299                 /* Send the memory buffer erase command to the target */
 300                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 301                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 302                 XPROGTarget_SendByte(EraseBuffCommand);
 303
 304                 /* Set CMDEX bit in NVM CTRLA register to start the buffer erase */
 305                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 306                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
 307                 XPROGTarget_SendByte(XMEGA_NVM_BIT_CTRLA_CMDEX);
 308         }
 309
 310         if (WriteSize)
 311         {
 312                 /* Wait until the NVM controller is no longer busy */
 313                 if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 314                   return false;
 315
 316                 /* Send the memory buffer write command to the target */
 317                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 318                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 319                 XPROGTarget_SendByte(WriteBuffCommand);
 320
 321                 /* Load the PDI pointer register with the start address we want to write to */
 322                 XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
 323                 XMEGANVM_SendAddress(WriteAddress);
 324
 325                 /* Send the REPEAT command with the specified number of bytes to write */
 326                 XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
 327                 XPROGTarget_SendByte(WriteSize - 1);
 328
 329                 /* Send a ST command with indirect access and post-increment to write the bytes */
 330                 XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
 331                 while (WriteSize--)
 332                   XPROGTarget_SendByte(*(WriteBuffer++));
 333         }
 334
 335         if (PageMode & XPRG_PAGEMODE_WRITE)
 336         {
 337                 /* Wait until the NVM controller is no longer busy */
 338                 if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 339                   return false;
 340
 341                 /* Send the memory write command to the target */
 342                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 343                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 344                 XPROGTarget_SendByte(WritePageCommand);
 345
 346                 /* Send the address of the first page location to write the memory page */
 347                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 348                 XMEGANVM_SendAddress(WriteAddress);
 349                 XPROGTarget_SendByte(0x00);
 350         }
 351
 352         return true;
 353 }
 354
 355 /** Erases a specific memory space of the target.
 356  *
 357  *  \param[in] EraseCommand  NVM erase command to send to the device
 358  *  \param[in] Address       Address inside the memory space to erase
 359  *
 360  *  \return Boolean true if the command sequence complete successfully
 361  */
 362 bool XMEGANVM_EraseMemory(const uint8_t EraseCommand, const uint32_t Address)
 363 {
 364         /* Wait until the NVM controller is no longer busy */
 365         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 366           return false;
 367
 368         /* EEPROM and Chip erasures are triggered differently to FLASH section erasures */
 369         if (EraseCommand == XMEGA_NVM_CMD_CHIPERASE)
 370         {
 371                 /* Send the memory erase command to the target */
 372                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 373                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 374                 XPROGTarget_SendByte(EraseCommand);
 375
 376                 /* Set CMDEX bit in NVM CTRLA register to start the erase sequence */
 377                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 378                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
 379                 XPROGTarget_SendByte(XMEGA_NVM_BIT_CTRLA_CMDEX);
 380         }
 381         else if (EraseCommand == XMEGA_NVM_CMD_ERASEEEPROM)
 382         {
 383                 /* Send the EEPROM page buffer erase command to the target */
 384                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 385                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 386                 XPROGTarget_SendByte(XMEGA_NVM_CMD_ERASEEEPROMPAGEBUFF);
 387
 388                 /* Set CMDEX bit in NVM CTRLA register to start the buffer erase */
 389                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 390                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
 391                 XPROGTarget_SendByte(XMEGA_NVM_BIT_CTRLA_CMDEX);
 392
 393                 /* Wait until the NVM controller is no longer busy */
 394                 if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 395                   return false;
 396
 397                 /* Send the EEPROM memory buffer write command to the target */
 398                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 399                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 400                 XPROGTarget_SendByte(XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF);
 401
 402                 /* Load the PDI pointer register with the EEPROM page start address */
 403                 XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
 404                 XMEGANVM_SendAddress(Address);
 405
 406                 /* Send the REPEAT command with the specified number of bytes to write */
 407                 XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
 408                 XPROGTarget_SendByte(XPROG_Param_EEPageSize - 1);
 409
 410                 /* Send a ST command with indirect access and post-increment to tag each byte in the EEPROM page buffer */
 411                 XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
 412                 for (uint8_t PageByte = 0; PageByte < XPROG_Param_EEPageSize; PageByte++)
 413                   XPROGTarget_SendByte(0x00);
 414
 415                 /* Send the memory erase command to the target */
 416                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 417                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 418                 XPROGTarget_SendByte(EraseCommand);
 419
 420                 /* Set CMDEX bit in NVM CTRLA register to start the EEPROM erase sequence */
 421                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 422                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
 423                 XPROGTarget_SendByte(XMEGA_NVM_BIT_CTRLA_CMDEX);
 424         }
 425         else
 426         {
 427                 /* Send the memory erase command to the target */
 428                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 429                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 430                 XPROGTarget_SendByte(EraseCommand);
 431
 432                 /* Other erase modes just need us to address a byte within the target memory space */
 433                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 434                 XMEGANVM_SendAddress(Address);
 435                 XPROGTarget_SendByte(0x00);
 436         }
 437
 438         /* Wait until the NVM bus is ready again */
 439         if (!(XMEGANVM_WaitWhileNVMBusBusy()))
 440           return false;
 441
 442         return true;
 443 }
 444
 445 #endif
 446