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         for (;;)
  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 }
  99
 100 /** Waits while the target's NVM controller is busy performing an operation, exiting if the
 101  *  timeout period expires.
 102  *
 103  *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
 104  */
 105 bool TINYNVM_WaitWhileNVMControllerBusy(void)
 106 {
 107         /* Poll the STATUS register to check to see if NVM access has been enabled */
 108         for (;;)
 109         {
 110                 /* Send the SIN command to read the TPI STATUS register to see the NVM bus is busy */
 111                 TINYNVM_SendReadNVMRegister(XPROG_Param_NVMCSRRegAddr);
 112
 113                 uint8_t StatusRegister = XPROGTarget_ReceiveByte();
 114
 115                 /* We might have timed out waiting for the status register read response, check here */
 116                 if (!(TimeoutMSRemaining))
 117                   return false;
 118
 119                 /* Check to see if the BUSY flag is still set */
 120                 if (!(StatusRegister & (1 << 7)))
 121                 {
 122                         TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
 123                         return true;
 124                 }
 125         }
 126 }
 127
 128 /** Reads memory from the target's memory spaces.
 129  *
 130  *  \param[in]  ReadAddress  Start address to read from within the target's address space
 131  *  \param[out] ReadBuffer   Buffer to store read data into
 132  *  \param[in]  ReadSize     Length of the data to read from the device
 133  *
 134  *  \return Boolean true if the command sequence complete successfully
 135  */
 136 bool TINYNVM_ReadMemory(const uint16_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize)
 137 {
 138         /* Wait until the NVM controller is no longer busy */
 139         if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 140           return false;
 141
 142         /* Set the NVM control register to the NO OP command for memory reading */
 143         TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
 144         XPROGTarget_SendByte(TINY_NVM_CMD_NOOP);
 145
 146         /* Send the address of the location to read from */
 147         TINYNVM_SendPointerAddress(ReadAddress);
 148
 149         while (ReadSize-- && TimeoutMSRemaining)
 150         {
 151                 /* Read the byte of data from the target */
 152                 XPROGTarget_SendByte(TPI_CMD_SLD | TPI_POINTER_INDIRECT_PI);
 153                 *(ReadBuffer++) = XPROGTarget_ReceiveByte();
 154         }
 155
 156         return (TimeoutMSRemaining != 0);
 157 }
 158
 159 /** Writes word addressed memory to the target's memory spaces.
 160  *
 161  *  \param[in] WriteAddress  Start address to write to within the target's address space
 162  *  \param[in] WriteBuffer   Buffer to source data from
 163  *  \param[in] WriteLength   Total number of bytes to write to the device (must be an integer multiple of 2)
 164  *
 165  *  \return Boolean true if the command sequence complete successfully
 166  */
 167 bool TINYNVM_WriteMemory(const uint16_t WriteAddress, uint8_t* WriteBuffer, uint16_t WriteLength)
 168 {
 169         /* Wait until the NVM controller is no longer busy */
 170         if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 171           return false;
 172
 173         /* Must have an integer number of words to write - if extra byte, word-align via a dummy high byte */
 174         if (WriteLength & 0x01)
 175           WriteBuffer[WriteLength++] = 0xFF;
 176
 177         /* Set the NVM control register to the WORD WRITE command for memory reading */
 178         TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
 179         XPROGTarget_SendByte(TINY_NVM_CMD_WORDWRITE);
 180
 181         /* Send the address of the location to write to */
 182         TINYNVM_SendPointerAddress(WriteAddress);
 183
 184         while (WriteLength)
 185         {
 186                 /* Wait until the NVM controller is no longer busy */
 187                 if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 188                   return false;
 189
 190                 /* Write the low byte of data to the target */
 191                 XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
 192                 XPROGTarget_SendByte(*(WriteBuffer++));
 193
 194                 /* Write the high byte of data to the target */
 195                 XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
 196                 XPROGTarget_SendByte(*(WriteBuffer++));
 197
 198                 /* Need to decrement the write length twice, since we read out a whole word */
 199                 WriteLength -= 2;
 200         }
 201
 202         return true;
 203 }
 204
 205 /** Erases the target's memory space.
 206  *
 207  *  \param[in] EraseCommand  NVM erase command to send to the device
 208  *  \param[in] Address       Address inside the memory space to erase
 209  *
 210  *  \return Boolean true if the command sequence complete successfully
 211  */
 212 bool TINYNVM_EraseMemory(const uint8_t EraseCommand, const uint16_t Address)
 213 {
 214         /* Wait until the NVM controller is no longer busy */
 215         if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 216           return false;
 217
 218         /* Set the NVM control register to the target memory erase command */
 219         TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
 220         XPROGTarget_SendByte(EraseCommand);
 221
 222         /* Write to a high byte location within the target address space to start the erase process */
 223         TINYNVM_SendPointerAddress(Address | 0x0001);
 224         XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT);
 225         XPROGTarget_SendByte(0x00);
 226
 227         /* Wait until the NVM controller is no longer busy */
 228         if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 229           return false;
 230
 231         return true;
 232 }
 233
 234 #endif