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 static 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 /** Sends a SIN command to the target with the specified I/O address, ready for the data byte to be written.
  53  *
  54  *  \param[in] Address  6-bit I/O address to write to in the target's I/O memory space
  55  */
  56 static void TINYNVM_SendReadNVMRegister(uint8_t Address)
  57 {
  58         /* The TPI command for reading from the I/O space uses wierd addressing, where the I/O address's upper
  59          * two bits of the 6-bit address are shifted left once */
  60         XPROGTarget_SendByte(TPI_CMD_SIN | ((Address & 0x30) << 1) | (Address & 0x0F));
  61 }
  62
  63 /** Sends a SOUT command to the target with the specified I/O address, ready for the data byte to be read.
  64  *
  65  *  \param[in] Address  6-bit I/O address to read from in the target's I/O memory space
  66  */
  67 static void TINYNVM_SendWriteNVMRegister(uint8_t Address)
  68 {
  69         /* The TPI command for writing to the I/O space uses wierd addressing, where the I/O address's upper
  70          * two bits of the 6-bit address are shifted left once */
  71         XPROGTarget_SendByte(TPI_CMD_SOUT | ((Address & 0x30) << 1) | (Address & 0x0F));
  72 }
  73
  74 /** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read.
  75  *
  76  *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
  77  */
  78 bool TINYNVM_WaitWhileNVMBusBusy(void)
  79 {
  80         /* Poll the STATUS register to check to see if NVM access has been enabled */
  81         while (TimeoutMSRemaining)
  82         {
  83                 /* Send the SLDCS command to read the TPI STATUS register to see the NVM bus is active */
  84                 XPROGTarget_SendByte(TPI_CMD_SLDCS | TPI_STATUS_REG);
  85                 if (XPROGTarget_ReceiveByte() & TPI_STATUS_NVM)
  86                   return true;
  87         }
  88
  89         return false;
  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 TINYNVM_WaitWhileNVMControllerBusy(void)
  98 {
  99         /* Poll the STATUS register to check to see if NVM access has been enabled */
 100         while (TimeoutMSRemaining)
 101         {
 102                 /* Send the SIN command to read the TPI STATUS register to see the NVM bus is active */
 103                 TINYNVM_SendReadNVMRegister(XPROG_Param_NVMCSRRegAddr);
 104                 if (XPROGTarget_ReceiveByte() & (1 << 7))
 105                   return true;
 106         }
 107
 108         return false;
 109 }
 110
 111 /** Reads memory from the target's memory spaces.
 112  *
 113  *  \param[in]  ReadAddress  Start address to read from within the target's address space
 114  *  \param[out] ReadBuffer   Buffer to store read data into
 115  *  \param[in]  ReadSize     Length of the data to read from the device
 116  *
 117  *  \return Boolean true if the command sequence complete successfully
 118  */
 119 bool TINYNVM_ReadMemory(const uint16_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize)
 120 {
 121         /* Wait until the NVM controller is no longer busy */
 122         if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 123           return false;
 124
 125         /* Set the NVM control register to the NO OP command for memory reading */
 126         TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
 127         XPROGTarget_SendByte(TINY_NVM_CMD_NOOP);
 128
 129         /* Send the address of the location to read from */
 130         TINYNVM_SendPointerAddress(ReadAddress);
 131
 132         while (ReadSize--)
 133         {
 134                 /* Read the byte of data from the target */
 135                 XPROGTarget_SendByte(TPI_CMD_SLD | TPI_POINTER_INDIRECT_PI);
 136                 *(ReadBuffer++) = XPROGTarget_ReceiveByte();
 137         }
 138
 139         return true;
 140 }
 141
 142 /** Writes byte addressed memory to the target's memory spaces.
 143  *
 144  *  \param[in]  WriteAddress  Start address to write to within the target's address space
 145  *  \param[in]  WriteBuffer   Buffer to source data from
 146  *  \param[in]  WriteLength   Total number of bytes to write to the device
 147  *
 148  *  \return Boolean true if the command sequence complete successfully
 149  */
 150 bool TINYNVM_WriteMemory(const uint16_t WriteAddress, const uint8_t* WriteBuffer, uint16_t WriteLength)
 151 {
 152         /* Wait until the NVM controller is no longer busy */
 153         if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 154           return false;
 155
 156         /* Set the NVM control register to the WORD WRITE command for memory reading */
 157         TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
 158         XPROGTarget_SendByte(TINY_NVM_CMD_WORDWRITE);
 159
 160         /* Send the address of the location to write to */
 161         TINYNVM_SendPointerAddress(WriteAddress);
 162
 163         while (WriteLength--)
 164         {
 165                 /* Write the byte of data to the target */
 166                 XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
 167                 XPROGTarget_SendByte(*(WriteBuffer++));
 168         }
 169
 170         return true;
 171 }
 172
 173 /** Erases the target's memory space.
 174  *
 175  *  \return Boolean true if the command sequence complete successfully
 176  */
 177 bool TINYNVM_EraseMemory(void)
 178 {
 179         /* Wait until the NVM controller is no longer busy */
 180         if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 181           return false;
 182
 183         /* Set the NVM control register to the CHIP ERASE command to erase the target */
 184         TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
 185         XPROGTarget_SendByte(TINY_NVM_CMD_CHIPERASE);
 186
 187         /* Wait until the NVM bus is ready again */
 188         if (!(TINYNVM_WaitWhileNVMBusBusy()))
 189           return false;
 190
 191         return true;
 192 }
 193
 194 #endif