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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 disclaims 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 (!(TimeoutTicksRemaining))
  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 (!(TimeoutTicksRemaining))
 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 32 USART bits */
 135         XPROGTarget_SendByte(PDI_CMD_STCS | PDI_CTRL_REG);
 136         XPROGTarget_SendByte(0x02);
 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         *CRCDest = 0;
 178
 179         /* Wait until the NVM controller is no longer busy */
 180         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 181           return false;
 182
 183         /* Set the NVM command to the correct CRC read command */
 184         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 185         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 186         XPROGTarget_SendByte(CRCCommand);
 187
 188         /* Set CMDEX bit in NVM CTRLA register to start the CRC generation */
 189         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 190         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
 191         XPROGTarget_SendByte(XMEGA_NVM_BIT_CTRLA_CMDEX);
 192
 193         /* Wait until the NVM bus is ready again */
 194         if (!(XMEGANVM_WaitWhileNVMBusBusy()))
 195           return false;
 196
 197         /* Wait until the NVM controller is no longer busy */
 198         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 199           return false;
 200
 201         /* Load the PDI pointer register with the DAT0 register start address */
 202         XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
 203         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_DAT0);
 204
 205         /* Send the REPEAT command to grab the CRC bytes */
 206         XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
 207         XPROGTarget_SendByte(XMEGA_CRC_LENGTH_BYTES - 1);
 208
 209         /* Read in the CRC bytes from the target */
 210         XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
 211         for (uint8_t i = 0; i < XMEGA_CRC_LENGTH_BYTES; i++)
 212           ((uint8_t*)CRCDest)[i] = XPROGTarget_ReceiveByte();
 213
 214         return (TimeoutTicksRemaining > 0);
 215 }
 216
 217 /** Reads memory from the target's memory spaces.
 218  *
 219  *  \param[in]  ReadAddress  Start address to read from within the target's address space
 220  *  \param[out] ReadBuffer   Buffer to store read data into
 221  *  \param[in]  ReadSize     Number of bytes to read
 222  *
 223  *  \return Boolean true if the command sequence complete successfully
 224  */
 225 bool XMEGANVM_ReadMemory(const uint32_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize)
 226 {
 227         /* Wait until the NVM controller is no longer busy */
 228         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 229           return false;
 230
 231         /* Send the READNVM command to the NVM controller for reading of an arbitrary location */
 232         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 233         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 234         XPROGTarget_SendByte(XMEGA_NVM_CMD_READNVM);
 235
 236         /* Load the PDI pointer register with the start address we want to read from */
 237         XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
 238         XMEGANVM_SendAddress(ReadAddress);
 239
 240         /* Send the REPEAT command with the specified number of bytes to read */
 241         XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
 242         XPROGTarget_SendByte(ReadSize - 1);
 243
 244         /* Send a LD command with indirect access and post-increment to read out the bytes */
 245         XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
 246         while (ReadSize-- && TimeoutTicksRemaining)
 247           *(ReadBuffer++) = XPROGTarget_ReceiveByte();
 248
 249         return (TimeoutTicksRemaining > 0);
 250 }
 251
 252 /** Writes byte addressed memory to the target's memory spaces.
 253  *
 254  *  \param[in]  WriteCommand  Command to send to the device to write each memory byte
 255  *  \param[in]  WriteAddress  Address to write to within the target's address space
 256  *  \param[in]  Byte          Byte to write to the target
 257  *
 258  *  \return Boolean true if the command sequence complete successfully
 259  */
 260 bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand, const uint32_t WriteAddress, const uint8_t Byte)
 261 {
 262         /* Wait until the NVM controller is no longer busy */
 263         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 264           return false;
 265
 266         /* Send the memory write command to the target */
 267         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 268         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 269         XPROGTarget_SendByte(WriteCommand);
 270
 271         /* Send new memory byte to the memory of the target */
 272         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 273         XMEGANVM_SendAddress(WriteAddress);
 274         XPROGTarget_SendByte(Byte);
 275
 276         return true;
 277 }
 278
 279 /** Writes page addressed memory to the target's memory spaces.
 280  *
 281  *  \param[in]  WriteBuffCommand  Command to send to the device to write a byte to the memory page buffer
 282  *  \param[in]  EraseBuffCommand  Command to send to the device to erase the memory page buffer
 283  *  \param[in]  WritePageCommand  Command to send to the device to write the page buffer to the destination memory
 284  *  \param[in]  PageMode          Bitfield indicating what operations need to be executed on the specified page
 285  *  \param[in]  WriteAddress      Start address to write the page data to within the target's address space
 286  *  \param[in]  WriteBuffer       Buffer to source data from
 287  *  \param[in]  WriteSize         Number of bytes to write
 288  *
 289  *  \return Boolean true if the command sequence complete successfully
 290  */
 291 bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand, const uint8_t EraseBuffCommand,
 292                               const uint8_t WritePageCommand, const uint8_t PageMode, const uint32_t WriteAddress,
 293                               const uint8_t* WriteBuffer, uint16_t WriteSize)
 294 {
 295         if (PageMode & XPRG_PAGEMODE_ERASE)
 296         {
 297                 /* Wait until the NVM controller is no longer busy */
 298                 if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 299                   return false;
 300
 301                 /* Send the memory buffer erase command to the target */
 302                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 303                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 304                 XPROGTarget_SendByte(EraseBuffCommand);
 305
 306                 /* Set CMDEX bit in NVM CTRLA register to start the buffer erase */
 307                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 308                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
 309                 XPROGTarget_SendByte(XMEGA_NVM_BIT_CTRLA_CMDEX);
 310         }
 311
 312         if (WriteSize)
 313         {
 314                 /* Wait until the NVM controller is no longer busy */
 315                 if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 316                   return false;
 317
 318                 /* Send the memory buffer write command to the target */
 319                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 320                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 321                 XPROGTarget_SendByte(WriteBuffCommand);
 322
 323                 /* Load the PDI pointer register with the start address we want to write to */
 324                 XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
 325                 XMEGANVM_SendAddress(WriteAddress);
 326
 327                 /* Send the REPEAT command with the specified number of bytes to write */
 328                 XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
 329                 XPROGTarget_SendByte(WriteSize - 1);
 330
 331                 /* Send a ST command with indirect access and post-increment to write the bytes */
 332                 XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
 333                 while (WriteSize--)
 334                   XPROGTarget_SendByte(*(WriteBuffer++));
 335         }
 336
 337         if (PageMode & XPRG_PAGEMODE_WRITE)
 338         {
 339                 /* Wait until the NVM controller is no longer busy */
 340                 if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 341                   return false;
 342
 343                 /* Send the memory write command to the target */
 344                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 345                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 346                 XPROGTarget_SendByte(WritePageCommand);
 347
 348                 /* Send the address of the first page location to write the memory page */
 349                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 350                 XMEGANVM_SendAddress(WriteAddress);
 351                 XPROGTarget_SendByte(0x00);
 352         }
 353
 354         return true;
 355 }
 356
 357 /** Erases a specific memory space of the target.
 358  *
 359  *  \param[in] EraseCommand  NVM erase command to send to the device
 360  *  \param[in] Address       Address inside the memory space to erase
 361  *
 362  *  \return Boolean true if the command sequence complete successfully
 363  */
 364 bool XMEGANVM_EraseMemory(const uint8_t EraseCommand, const uint32_t Address)
 365 {
 366         /* Wait until the NVM controller is no longer busy */
 367         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 368           return false;
 369
 370         /* EEPROM and Chip erasures are triggered differently to FLASH section erasures */
 371         if (EraseCommand == XMEGA_NVM_CMD_CHIPERASE)
 372         {
 373                 /* Send the memory erase command to the target */
 374                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 375                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 376                 XPROGTarget_SendByte(EraseCommand);
 377
 378                 /* Set CMDEX bit in NVM CTRLA register to start the erase sequence */
 379                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 380                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
 381                 XPROGTarget_SendByte(XMEGA_NVM_BIT_CTRLA_CMDEX);
 382         }
 383         else if (EraseCommand == XMEGA_NVM_CMD_ERASEEEPROM)
 384         {
 385                 /* Send the EEPROM page buffer erase command to the target */
 386                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 387                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 388                 XPROGTarget_SendByte(XMEGA_NVM_CMD_ERASEEEPROMPAGEBUFF);
 389
 390                 /* Set CMDEX bit in NVM CTRLA register to start the buffer erase */
 391                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 392                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
 393                 XPROGTarget_SendByte(XMEGA_NVM_BIT_CTRLA_CMDEX);
 394
 395                 /* Wait until the NVM controller is no longer busy */
 396                 if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 397                   return false;
 398
 399                 /* Send the EEPROM memory buffer write command to the target */
 400                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 401                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 402                 XPROGTarget_SendByte(XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF);
 403
 404                 /* Load the PDI pointer register with the EEPROM page start address */
 405                 XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
 406                 XMEGANVM_SendAddress(Address);
 407
 408                 /* Send the REPEAT command with the specified number of bytes to write */
 409                 XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
 410                 XPROGTarget_SendByte(XPROG_Param_EEPageSize - 1);
 411
 412                 /* Send a ST command with indirect access and post-increment to tag each byte in the EEPROM page buffer */
 413                 XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
 414                 for (uint8_t PageByte = 0; PageByte < XPROG_Param_EEPageSize; PageByte++)
 415                   XPROGTarget_SendByte(0x00);
 416
 417                 /* Send the memory erase command to the target */
 418                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 419                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 420                 XPROGTarget_SendByte(EraseCommand);
 421
 422                 /* Set CMDEX bit in NVM CTRLA register to start the EEPROM erase sequence */
 423                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 424                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
 425                 XPROGTarget_SendByte(XMEGA_NVM_BIT_CTRLA_CMDEX);
 426         }
 427         else
 428         {
 429                 /* Send the memory erase command to the target */
 430                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 431                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 432                 XPROGTarget_SendByte(EraseCommand);
 433
 434                 /* Other erase modes just need us to address a byte within the target memory space */
 435                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 436                 XMEGANVM_SendAddress(Address);
 437                 XPROGTarget_SendByte(0x00);
 438         }
 439
 440         /* Wait until the NVM bus is ready again */
 441         if (!(XMEGANVM_WaitWhileNVMBusBusy()))
 442           return false;
 443
 444         return true;
 445 }
 446
 447 #endif
 448