Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.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  *  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(((uint8_t*)&AbsoluteAddress)[0]);
  49         XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[1]);
  50         XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[2]);
  51         XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[3]);
  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         while (TimeoutMSRemaining)
  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                 if (XPROGTarget_ReceiveByte() & PDI_STATUS_NVM)
  80                 {
  81                         TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
  82                         return true;
  83                 }
  84
  85                 /* Manage software timeout */
  86                 if (TIFR0 & (1 << OCF0A))
  87                 {
  88                         TIFR0 |= (1 << OCF0A);
  89                         TimeoutMSRemaining--;
  90                 }
  91         }
  92
  93         return false;
  94 }
  95
  96 /** Waits while the target's NVM controller is busy performing an operation, exiting if the
  97  *  timeout period expires.
  98  *
  99  *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
 100  */
 101 bool XMEGANVM_WaitWhileNVMControllerBusy(void)
 102 {
 103         /* Poll the NVM STATUS register while the NVM controller is busy */
 104         while (TimeoutMSRemaining)
 105         {
 106                 /* Send a LDS command to read the NVM STATUS register to check the BUSY flag */
 107                 XPROGTarget_SendByte(PDI_CMD_LDS | (PDI_DATSIZE_4BYTES << 2));
 108                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_STATUS);
 109
 110                 /* Check to see if the BUSY flag is still set */
 111                 if (!(XPROGTarget_ReceiveByte() & (1 << 7)))
 112                 {
 113                         TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
 114                         return true;
 115                 }
 116
 117                 /* Manage software timeout */
 118                 if (TIFR0 & (1 << OCF0A))
 119                 {
 120                         TIFR0 |= (1 << OCF0A);
 121                         TimeoutMSRemaining--;
 122                 }
 123         }
 124
 125         return false;
 126 }
 127
 128 /** Retrieves the CRC value of the given memory space.
 129  *
 130  *  \param[in]  CRCCommand  NVM CRC command to issue to the target
 131  *  \param[out] CRCDest     CRC Destination when read from the target
 132  *
 133  *  \return Boolean true if the command sequence complete successfully
 134  */
 135 bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand, uint32_t* const CRCDest)
 136 {
 137         /* Wait until the NVM controller is no longer busy */
 138         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 139           return false;
 140
 141         /* Set the NVM command to the correct CRC read command */
 142         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 143         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 144         XPROGTarget_SendByte(CRCCommand);
 145
 146         /* Set CMDEX bit in NVM CTRLA register to start the CRC generation */
 147         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 148         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
 149         XPROGTarget_SendByte(1 << 0);
 150
 151         /* Wait until the NVM bus is ready again */
 152         if (!(XMEGANVM_WaitWhileNVMBusBusy()))
 153           return false;
 154
 155         /* Wait until the NVM controller is no longer busy */
 156         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 157           return false;
 158
 159         /* Load the PDI pointer register with the DAT0 register start address */
 160         XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
 161         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_DAT0);
 162
 163         /* Send the REPEAT command to grab the CRC bytes */
 164         XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
 165         XPROGTarget_SendByte(XMEGA_CRC_LENGTH - 1);
 166
 167         /* Read in the CRC bytes from the target */
 168         XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
 169         for (uint8_t i = 0; i < XMEGA_CRC_LENGTH; i++)
 170           ((uint8_t*)CRCDest)[i] = XPROGTarget_ReceiveByte();
 171
 172         return true;
 173 }
 174
 175 /** Reads memory from the target's memory spaces.
 176  *
 177  *  \param[in]  ReadAddress  Start address to read from within the target's address space
 178  *  \param[out] ReadBuffer   Buffer to store read data into
 179  *  \param[in]  ReadSize     Number of bytes to read
 180  *
 181  *  \return Boolean true if the command sequence complete successfully
 182  */
 183 bool XMEGANVM_ReadMemory(const uint32_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize)
 184 {
 185         /* Wait until the NVM controller is no longer busy */
 186         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 187           return false;
 188
 189         /* Send the READNVM command to the NVM controller for reading of an arbitrary location */
 190         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 191         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 192         XPROGTarget_SendByte(XMEGA_NVM_CMD_READNVM);
 193
 194         /* Load the PDI pointer register with the start address we want to read from */
 195         XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
 196         XMEGANVM_SendAddress(ReadAddress);
 197
 198         /* Send the REPEAT command with the specified number of bytes to read */
 199         XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
 200         XPROGTarget_SendByte(ReadSize - 1);
 201
 202         /* Send a LD command with indirect access and postincrement to read out the bytes */
 203         XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
 204         while (ReadSize--)
 205           *(ReadBuffer++) = XPROGTarget_ReceiveByte();
 206
 207         return true;
 208 }
 209
 210 /** Writes byte addressed memory to the target's memory spaces.
 211  *
 212  *  \param[in]  WriteCommand  Command to send to the device to write each memory byte
 213  *  \param[in]  WriteAddress  Address to write to within the target's address space
 214  *  \param[in]  Byte          Byte to write to the target
 215  *
 216  *  \return Boolean true if the command sequence complete successfully
 217  */
 218 bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand, const uint32_t WriteAddress, const uint8_t Byte)
 219 {
 220         /* Wait until the NVM controller is no longer busy */
 221         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 222           return false;
 223
 224         /* Send the memory write command to the target */
 225         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 226         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 227         XPROGTarget_SendByte(WriteCommand);
 228
 229         /* Send new memory byte to the memory to the target */
 230         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 231         XMEGANVM_SendAddress(WriteAddress);
 232         XPROGTarget_SendByte(Byte);
 233
 234         return true;
 235 }
 236
 237 /** Writes page addressed memory to the target's memory spaces.
 238  *
 239  *  \param[in]  WriteBuffCommand  Command to send to the device to write a byte to the memory page buffer
 240  *  \param[in]  EraseBuffCommand  Command to send to the device to erase the memory page buffer
 241  *  \param[in]  WritePageCommand  Command to send to the device to write the page buffer to the destination memory
 242  *  \param[in]  PageMode          Bitfield indicating what operations need to be executed on the specified page
 243  *  \param[in]  WriteAddress      Start address to write the page data to within the target's address space
 244  *  \param[in]  WriteBuffer       Buffer to source data from
 245  *  \param[in]  WriteSize         Number of bytes to write
 246  *
 247  *  \return Boolean true if the command sequence complete successfully
 248  */
 249 bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand, const uint8_t EraseBuffCommand,
 250                               const uint8_t WritePageCommand, const uint8_t PageMode, const uint32_t WriteAddress,
 251                               const uint8_t* WriteBuffer, uint16_t WriteSize)
 252 {
 253         if (PageMode & XPRG_PAGEMODE_ERASE)
 254         {
 255                 /* Wait until the NVM controller is no longer busy */
 256                 if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 257                   return false;
 258
 259                 /* Send the memory buffer erase command to the target */
 260                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 261                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 262                 XPROGTarget_SendByte(EraseBuffCommand);
 263
 264                 /* Set CMDEX bit in NVM CTRLA register to start the buffer erase */
 265                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 266                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
 267                 XPROGTarget_SendByte(1 << 0);
 268         }
 269
 270         if (WriteSize)
 271         {
 272                 /* Wait until the NVM controller is no longer busy */
 273                 if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 274                   return false;
 275
 276                 /* Send the memory buffer write command to the target */
 277                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 278                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 279                 XPROGTarget_SendByte(WriteBuffCommand);
 280
 281                 /* Load the PDI pointer register with the start address we want to write to */
 282                 XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
 283                 XMEGANVM_SendAddress(WriteAddress);
 284
 285                 /* Send the REPEAT command with the specified number of bytes to write */
 286                 XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
 287                 XPROGTarget_SendByte(WriteSize - 1);
 288
 289                 /* Send a ST command with indirect access and postincrement to write the bytes */
 290                 XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
 291                 while (WriteSize--)
 292                   XPROGTarget_SendByte(*(WriteBuffer++));
 293         }
 294
 295         if (PageMode & XPRG_PAGEMODE_WRITE)
 296         {
 297                 /* Wait until the NVM controller is no longer busy */
 298                 if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 299                   return false;
 300
 301                 /* Send the memory write command to the target */
 302                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 303                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 304                 XPROGTarget_SendByte(WritePageCommand);
 305
 306                 /* Send the address of the first page location to write the memory page */
 307                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 308                 XMEGANVM_SendAddress(WriteAddress);
 309                 XPROGTarget_SendByte(0x00);
 310         }
 311
 312         return true;
 313 }
 314
 315 /** Erases a specific memory space of the target.
 316  *
 317  *  \param[in] EraseCommand  NVM erase command to send to the device
 318  *  \param[in] Address  Address inside the memory space to erase
 319  *
 320  *  \return Boolean true if the command sequence complete successfully
 321  */
 322 bool XMEGANVM_EraseMemory(const uint8_t EraseCommand, const uint32_t Address)
 323 {
 324         /* Wait until the NVM controller is no longer busy */
 325         if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
 326           return false;
 327
 328         /* Send the memory erase command to the target */
 329         XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 330         XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
 331         XPROGTarget_SendByte(EraseCommand);
 332
 333         /* Chip erase is handled separately, since it's procedure is different to other erase types */
 334         if (EraseCommand == XMEGA_NVM_CMD_CHIPERASE)
 335         {
 336                 /* Set CMDEX bit in NVM CTRLA register to start the chip erase */
 337                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 338                 XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
 339                 XPROGTarget_SendByte(1 << 0);
 340         }
 341         else
 342         {
 343                 /* Other erase modes just need us to address a byte within the target memory space */
 344                 XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
 345                 XMEGANVM_SendAddress(Address);
 346                 XPROGTarget_SendByte(0x00);
 347         }
 348
 349         /* Wait until the NVM bus is ready again */
 350         if (!(XMEGANVM_WaitWhileNVMBusBusy()))
 351           return false;
 352
 353         return true;
 354 }
 355
 356 #endif