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 #warning TPI Protocol support is currently incomplete and is not suitable for general use.
  41
  42 /** Sends the given pointer address to the target's TPI pointer register */
  43 void TINYNVM_SendPointerAddress(const uint16_t AbsoluteAddress)
  44 {
  45         /* Send the given 16-bit address to the target, LSB first */
  46         XPROGTarget_SendByte(TPI_CMD_SSTPR | 0);
  47         XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[0]);
  48         XPROGTarget_SendByte(TPI_CMD_SSTPR | 1);
  49         XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[1]);
  50 }
  51
  52 /** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read.
  53  *
  54  *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
  55  */
  56 bool TINYNVM_WaitWhileNVMBusBusy(void)
  57 {
  58         /* Poll the STATUS register to check to see if NVM access has been enabled */
  59         while (TimeoutMSRemaining)
  60         {
  61                 /* Send the SLDCS command to read the TPI STATUS register to see the NVM bus is active */
  62                 XPROGTarget_SendByte(TPI_CMD_SLDCS | TPI_STATUS_REG);
  63                 if (XPROGTarget_ReceiveByte() & TPI_STATUS_NVM)
  64                   return true;
  65         }
  66
  67         return false;
  68 }
  69
  70 /** Waits while the target's NVM controller is busy performing an operation, exiting if the
  71  *  timeout period expires.
  72  *
  73  *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
  74  */
  75 bool TINYNVM_WaitWhileNVMControllerBusy(void)
  76 {
  77         /* Poll the STATUS register to check to see if NVM access has been enabled */
  78         while (TimeoutMSRemaining)
  79         {
  80                 /* Send the SIN command to read the TPI STATUS register to see the NVM bus is active */
  81                 XPROGTarget_SendByte(TPI_CMD_SIN | XPROG_Param_NVMCSRRegAddr);
  82                 if (XPROGTarget_ReceiveByte() & (1 << 7))
  83                   return true;
  84         }
  85
  86         return false;
  87 }
  88
  89 /** Reads memory from the target's memory spaces.
  90  *
  91  *  \param[in]  ReadAddress  Start address to read from within the target's address space
  92  *  \param[out] ReadBuffer   Buffer to store read data into
  93  *  \param[in]  ReadSize     Length of the data to read from the device
  94  *
  95  *  \return Boolean true if the command sequence complete successfully
  96  */
  97 bool TINYNVM_ReadMemory(const uint32_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize)
  98 {
  99         /* Wait until the NVM controller is no longer busy */
 100         if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 101           return false;
 102
 103         /* Set the NVM control register to the NO OP command for memory reading */
 104         XPROGTarget_SendByte(TPI_CMD_SOUT | XPROG_Param_NVMCMDRegAddr);
 105         XPROGTarget_SendByte(TINY_NVM_CMD_NOOP);
 106
 107         /* Send the address of the location to read from */
 108         TINYNVM_SendPointerAddress(ReadAddress);
 109
 110         while (ReadSize--)
 111         {
 112                 /* Read the byte of data from the target */
 113                 XPROGTarget_SendByte(TPI_CMD_SLD | TPI_POINTER_INDIRECT_PI);
 114                 *(ReadBuffer++) = XPROGTarget_ReceiveByte();
 115         }
 116
 117         return true;
 118 }
 119
 120 /** Writes byte addressed memory to the target's memory spaces.
 121  *
 122  *  \param[in]  WriteAddress  Start address to write to within the target's address space
 123  *  \param[in]  WriteBuffer   Buffer to source data from
 124  *  \param[in]  WriteLength   Total number of bytes to write to the device
 125  *
 126  *  \return Boolean true if the command sequence complete successfully
 127  */
 128 bool TINYNVM_WriteMemory(const uint32_t WriteAddress, const uint8_t* WriteBuffer, uint16_t WriteLength)
 129 {
 130         /* Wait until the NVM controller is no longer busy */
 131         if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 132           return false;
 133
 134         /* Set the NVM control register to the WORD WRITE command for memory reading */
 135         XPROGTarget_SendByte(TPI_CMD_SOUT | XPROG_Param_NVMCMDRegAddr);
 136         XPROGTarget_SendByte(TINY_NVM_CMD_WORDWRITE);
 137
 138         /* Send the address of the location to write to */
 139         TINYNVM_SendPointerAddress(WriteAddress);
 140
 141         while (WriteLength--)
 142         {
 143                 /* Write the byte of data to the target */
 144                 XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
 145                 XPROGTarget_SendByte(*(WriteBuffer++));
 146         }
 147
 148         return true;
 149 }
 150
 151 /** Erases the target's memory space.
 152  *
 153  *  \return Boolean true if the command sequence complete successfully
 154  */
 155 bool TINYNVM_EraseMemory(void)
 156 {
 157         /* Wait until the NVM controller is no longer busy */
 158         if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 159           return false;
 160
 161         /* Set the NVM control register to the CHIP ERASE command to erase the target */
 162         XPROGTarget_SendByte(TPI_CMD_SOUT | XPROG_Param_NVMCMDRegAddr);
 163         XPROGTarget_SendByte(TINY_NVM_CMD_CHIPERASE);
 164
 165         /* Wait until the NVM bus is ready again */
 166         if (!(TINYNVM_WaitWhileNVMBusBusy()))
 167           return false;
 168
 169         return true;
 170 }
 171
 172 #endif