Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.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 TINY target's NVM module.
  34  */
  35
  36 #define  INCLUDE_FROM_TINYNVM_C
  37 #include "TINYNVM.h"
  38
  39 #if defined(ENABLE_XPROG_PROTOCOL) || defined(__DOXYGEN__)
  40
  41 /** Sends the given pointer address to the target's TPI pointer register */
  42 static void TINYNVM_SendPointerAddress(const uint16_t AbsoluteAddress)
  43 {
  44         /* Send the given 16-bit address to the target, LSB first */
  45         XPROGTarget_SendByte(TPI_CMD_SSTPR | 0);
  46         XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[0]);
  47         XPROGTarget_SendByte(TPI_CMD_SSTPR | 1);
  48         XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[1]);
  49 }
  50
  51 /** Sends a SIN command to the target with the specified I/O address, ready for the data byte to be written.
  52  *
  53  *  \param[in] Address  6-bit I/O address to write to in the target's I/O memory space
  54  */
  55 static void TINYNVM_SendReadNVMRegister(const uint8_t Address)
  56 {
  57         /* The TPI command for reading from the I/O space uses strange addressing, where the I/O address's upper
  58          * two bits of the 6-bit address are shifted left once */
  59         XPROGTarget_SendByte(TPI_CMD_SIN | ((Address & 0x30) << 1) | (Address & 0x0F));
  60 }
  61
  62 /** Sends a SOUT command to the target with the specified I/O address, ready for the data byte to be read.
  63  *
  64  *  \param[in] Address  6-bit I/O address to read from in the target's I/O memory space
  65  */
  66 static void TINYNVM_SendWriteNVMRegister(const uint8_t Address)
  67 {
  68         /* The TPI command for reading from the I/O space uses strange addressing, where the I/O address's upper
  69          * two bits of the 6-bit address are shifted left once */
  70         XPROGTarget_SendByte(TPI_CMD_SOUT | ((Address & 0x30) << 1) | (Address & 0x0F));
  71 }
  72
  73 /** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read.
  74  *
  75  *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
  76  */
  77 bool TINYNVM_WaitWhileNVMBusBusy(void)
  78 {
  79         /* Poll the STATUS register to check to see if NVM access has been enabled */
  80         while (TimeoutMSRemaining)
  81         {
  82                 /* Send the SLDCS command to read the TPI STATUS register to see the NVM bus is active */
  83                 XPROGTarget_SendByte(TPI_CMD_SLDCS | TPI_STATUS_REG);
  84
  85                 uint8_t StatusRegister = XPROGTarget_ReceiveByte();
  86
  87                 /* We might have timed out waiting for the status register read response, check here */
  88                 if (!(TimeoutMSRemaining))
  89                   return false;
  90
  91                 /* Check the status register read response to see if the NVM bus is enabled */
  92                 if (StatusRegister & TPI_STATUS_NVM)
  93                 {
  94                         TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
  95                         return true;
  96                 }
  97
  98                 /* Manage software timeout */
  99                 if (TIFR0 & (1 << OCF0A))
 100                 {
 101                         TIFR0 |= (1 << OCF0A);
 102                         TimeoutMSRemaining--;
 103                 }
 104         }
 105
 106         return false;
 107 }
 108
 109 /** Waits while the target's NVM controller is busy performing an operation, exiting if the
 110  *  timeout period expires.
 111  *
 112  *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
 113  */
 114 bool TINYNVM_WaitWhileNVMControllerBusy(void)
 115 {
 116         /* Poll the STATUS register to check to see if NVM access has been enabled */
 117         while (TimeoutMSRemaining)
 118         {
 119                 /* Send the SIN command to read the TPI STATUS register to see the NVM bus is busy */
 120                 TINYNVM_SendReadNVMRegister(XPROG_Param_NVMCSRRegAddr);
 121
 122                 uint8_t StatusRegister = XPROGTarget_ReceiveByte();
 123
 124                 /* We might have timed out waiting for the status register read response, check here */
 125                 if (!(TimeoutMSRemaining))
 126                   return false;
 127
 128                 /* Check to see if the BUSY flag is still set */
 129                 if (!(StatusRegister & (1 << 7)))
 130                 {
 131                         TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
 132                         return true;
 133                 }
 134
 135                 /* Manage software timeout */
 136                 if (TIFR0 & (1 << OCF0A))
 137                 {
 138                         TIFR0 |= (1 << OCF0A);
 139                         TimeoutMSRemaining--;
 140                 }
 141         }
 142
 143         return false;
 144 }
 145
 146 /** Reads memory from the target's memory spaces.
 147  *
 148  *  \param[in]  ReadAddress  Start address to read from within the target's address space
 149  *  \param[out] ReadBuffer   Buffer to store read data into
 150  *  \param[in]  ReadSize     Length of the data to read from the device
 151  *
 152  *  \return Boolean true if the command sequence complete successfully
 153  */
 154 bool TINYNVM_ReadMemory(const uint16_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize)
 155 {
 156         /* Wait until the NVM controller is no longer busy */
 157         if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 158           return false;
 159
 160         /* Set the NVM control register to the NO OP command for memory reading */
 161         TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
 162         XPROGTarget_SendByte(TINY_NVM_CMD_NOOP);
 163
 164         /* Send the address of the location to read from */
 165         TINYNVM_SendPointerAddress(ReadAddress);
 166
 167         while (ReadSize-- && TimeoutMSRemaining)
 168         {
 169                 /* Read the byte of data from the target */
 170                 XPROGTarget_SendByte(TPI_CMD_SLD | TPI_POINTER_INDIRECT_PI);
 171                 *(ReadBuffer++) = XPROGTarget_ReceiveByte();
 172         }
 173
 174         return (TimeoutMSRemaining != 0);
 175 }
 176
 177 /** Writes word addressed memory to the target's memory spaces.
 178  *
 179  *  \param[in] WriteAddress  Start address to write to within the target's address space
 180  *  \param[in] WriteBuffer   Buffer to source data from
 181  *  \param[in] WriteLength   Total number of bytes to write to the device (must be an integer multiple of 2)
 182  *
 183  *  \return Boolean true if the command sequence complete successfully
 184  */
 185 bool TINYNVM_WriteMemory(const uint16_t WriteAddress, uint8_t* WriteBuffer, uint16_t WriteLength)
 186 {
 187         /* Wait until the NVM controller is no longer busy */
 188         if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 189           return false;
 190
 191         /* Must have an integer number of words to write - if extra byte, word-align via a dummy high byte */
 192         if (WriteLength & 0x01)
 193           WriteBuffer[WriteLength++] = 0xFF;
 194
 195         /* Set the NVM control register to the WORD WRITE command for memory reading */
 196         TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
 197         XPROGTarget_SendByte(TINY_NVM_CMD_WORDWRITE);
 198
 199         /* Send the address of the location to write to */
 200         TINYNVM_SendPointerAddress(WriteAddress);
 201
 202         while (WriteLength)
 203         {
 204                 /* Wait until the NVM controller is no longer busy */
 205                 if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 206                   return false;
 207
 208                 /* Write the low byte of data to the target */
 209                 XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
 210                 XPROGTarget_SendByte(*(WriteBuffer++));
 211
 212                 /* Write the high byte of data to the target */
 213                 XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
 214                 XPROGTarget_SendByte(*(WriteBuffer++));
 215
 216                 /* Need to decrement the write length twice, since we read out a whole word */
 217                 WriteLength -= 2;
 218         }
 219
 220         return true;
 221 }
 222
 223 /** Erases the target's memory space.
 224  *
 225  *  \param[in] EraseCommand  NVM erase command to send to the device
 226  *  \param[in] Address       Address inside the memory space to erase
 227  *
 228  *  \return Boolean true if the command sequence complete successfully
 229  */
 230 bool TINYNVM_EraseMemory(const uint8_t EraseCommand, const uint16_t Address)
 231 {
 232         /* Wait until the NVM controller is no longer busy */
 233         if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 234           return false;
 235
 236         /* Set the NVM control register to the target memory erase command */
 237         TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
 238         XPROGTarget_SendByte(EraseCommand);
 239
 240         /* Write to a high byte location within the target address space to start the erase process */
 241         TINYNVM_SendPointerAddress(Address | 0x0001);
 242         XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT);
 243         XPROGTarget_SendByte(0x00);
 244
 245         /* Wait until the NVM controller is no longer busy */
 246         if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 247           return false;
 248
 249         return true;
 250 }
 251
 252 #endif