Fix incorrect macro guard in the UC3 EndpointStream header file.
[pub/USBasp.git] / Projects / AVRISP-MKII / Lib / XPROG / TINYNVM.c
index e0e2479..891ae8d 100644 (file)
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+
   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
@@ -43,9 +43,9 @@ static void TINYNVM_SendPointerAddress(const uint16_t AbsoluteAddress)
 {
        /* Send the given 16-bit address to the target, LSB first */
        XPROGTarget_SendByte(TPI_CMD_SSTPR | 0);
 {
        /* Send the given 16-bit address to the target, LSB first */
        XPROGTarget_SendByte(TPI_CMD_SSTPR | 0);
-       XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[0]);
+       XPROGTarget_SendByte(AbsoluteAddress & 0xFF);
        XPROGTarget_SendByte(TPI_CMD_SSTPR | 1);
        XPROGTarget_SendByte(TPI_CMD_SSTPR | 1);
-       XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[1]);
+       XPROGTarget_SendByte(AbsoluteAddress >> 8);
 }
 
 /** Sends a SIN command to the target with the specified I/O address, ready for the data byte to be written.
 }
 
 /** Sends a SIN command to the target with the specified I/O address, ready for the data byte to be written.
@@ -85,15 +85,12 @@ bool TINYNVM_WaitWhileNVMBusBusy(void)
                uint8_t StatusRegister = XPROGTarget_ReceiveByte();
 
                /* We might have timed out waiting for the status register read response, check here */
                uint8_t StatusRegister = XPROGTarget_ReceiveByte();
 
                /* We might have timed out waiting for the status register read response, check here */
-               if (!(TimeoutMSRemaining))
+               if (TimeoutExpired)
                  return false;
 
                /* Check the status register read response to see if the NVM bus is enabled */
                if (StatusRegister & TPI_STATUS_NVM)
                  return false;
 
                /* Check the status register read response to see if the NVM bus is enabled */
                if (StatusRegister & TPI_STATUS_NVM)
-               {
-                       TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
-                       return true;
-               }
+                 return true;
        }
 }
 
        }
 }
 
@@ -113,18 +110,49 @@ bool TINYNVM_WaitWhileNVMControllerBusy(void)
                uint8_t StatusRegister = XPROGTarget_ReceiveByte();
 
                /* We might have timed out waiting for the status register read response, check here */
                uint8_t StatusRegister = XPROGTarget_ReceiveByte();
 
                /* We might have timed out waiting for the status register read response, check here */
-               if (!(TimeoutMSRemaining))
+               if (TimeoutExpired)
                  return false;
 
                /* Check to see if the BUSY flag is still set */
                if (!(StatusRegister & (1 << 7)))
                  return false;
 
                /* Check to see if the BUSY flag is still set */
                if (!(StatusRegister & (1 << 7)))
-               {
-                       TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
-                       return true;
-               }
+                 return true;
        }
 }
 
        }
 }
 
+/** Enables the physical TPI interface on the target and enables access to the internal NVM controller.
+ *
+ *  \return Boolean true if the TPI interface was enabled successfully, false otherwise
+ */
+bool TINYNVM_EnableTPI(void)
+{
+       /* Enable TPI programming mode with the attached target */
+       XPROGTarget_EnableTargetTPI();
+
+       /* Lower direction change guard time to 0 USART bits */
+       XPROGTarget_SendByte(TPI_CMD_SSTCS | TPI_CTRL_REG);
+       XPROGTarget_SendByte(0x07);
+
+       /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
+       XPROGTarget_SendByte(TPI_CMD_SKEY);
+       for (uint8_t i = sizeof(TPI_NVMENABLE_KEY); i > 0; i--)
+         XPROGTarget_SendByte(TPI_NVMENABLE_KEY[i - 1]);
+
+       /* Wait until the NVM bus becomes active */
+       return TINYNVM_WaitWhileNVMBusBusy();
+}
+
+/** Removes access to the target's NVM controller and physically disables the target's physical TPI interface. */
+void TINYNVM_DisableTPI(void)
+{
+       TINYNVM_WaitWhileNVMBusBusy();
+
+       /* Clear the NVMEN bit in the TPI STATUS register to disable TPI mode */
+       XPROGTarget_SendByte(TPI_CMD_SSTCS | TPI_STATUS_REG);
+       XPROGTarget_SendByte(0x00);
+
+       XPROGTarget_DisableTargetTPI();
+}
+
 /** Reads memory from the target's memory spaces.
  *
  *  \param[in]  ReadAddress  Start address to read from within the target's address space
 /** Reads memory from the target's memory spaces.
  *
  *  \param[in]  ReadAddress  Start address to read from within the target's address space
@@ -133,7 +161,9 @@ bool TINYNVM_WaitWhileNVMControllerBusy(void)
  *
  *  \return Boolean true if the command sequence complete successfully
  */
  *
  *  \return Boolean true if the command sequence complete successfully
  */
-bool TINYNVM_ReadMemory(const uint16_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize)
+bool TINYNVM_ReadMemory(const uint16_t ReadAddress,
+                        uint8_t* ReadBuffer,
+                        uint16_t ReadSize)
 {
        /* Wait until the NVM controller is no longer busy */
        if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 {
        /* Wait until the NVM controller is no longer busy */
        if (!(TINYNVM_WaitWhileNVMControllerBusy()))
@@ -142,18 +172,18 @@ bool TINYNVM_ReadMemory(const uint16_t ReadAddress, uint8_t* ReadBuffer, uint16_
        /* Set the NVM control register to the NO OP command for memory reading */
        TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
        XPROGTarget_SendByte(TINY_NVM_CMD_NOOP);
        /* Set the NVM control register to the NO OP command for memory reading */
        TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
        XPROGTarget_SendByte(TINY_NVM_CMD_NOOP);
-       
+
        /* Send the address of the location to read from */
        TINYNVM_SendPointerAddress(ReadAddress);
        /* Send the address of the location to read from */
        TINYNVM_SendPointerAddress(ReadAddress);
-       
-       while (ReadSize-- && TimeoutMSRemaining)
+
+       while (ReadSize-- && !(TimeoutExpired))
        {
                /* Read the byte of data from the target */
                XPROGTarget_SendByte(TPI_CMD_SLD | TPI_POINTER_INDIRECT_PI);
                *(ReadBuffer++) = XPROGTarget_ReceiveByte();
        }
        {
                /* Read the byte of data from the target */
                XPROGTarget_SendByte(TPI_CMD_SLD | TPI_POINTER_INDIRECT_PI);
                *(ReadBuffer++) = XPROGTarget_ReceiveByte();
        }
-       
-       return (TimeoutMSRemaining != 0);
+
+       return (TimeoutExpired == false);
 }
 
 /** Writes word addressed memory to the target's memory spaces.
 }
 
 /** Writes word addressed memory to the target's memory spaces.
@@ -164,12 +194,14 @@ bool TINYNVM_ReadMemory(const uint16_t ReadAddress, uint8_t* ReadBuffer, uint16_
  *
  *  \return Boolean true if the command sequence complete successfully
  */
  *
  *  \return Boolean true if the command sequence complete successfully
  */
-bool TINYNVM_WriteMemory(const uint16_t WriteAddress, uint8_t* WriteBuffer, uint16_t WriteLength)
+bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
+                         uint8_t* WriteBuffer,
+                         uint16_t WriteLength)
 {
        /* Wait until the NVM controller is no longer busy */
        if (!(TINYNVM_WaitWhileNVMControllerBusy()))
          return false;
 {
        /* Wait until the NVM controller is no longer busy */
        if (!(TINYNVM_WaitWhileNVMControllerBusy()))
          return false;
-         
+
        /* Must have an integer number of words to write - if extra byte, word-align via a dummy high byte */
        if (WriteLength & 0x01)
          WriteBuffer[WriteLength++] = 0xFF;
        /* Must have an integer number of words to write - if extra byte, word-align via a dummy high byte */
        if (WriteLength & 0x01)
          WriteBuffer[WriteLength++] = 0xFF;
@@ -177,10 +209,10 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress, uint8_t* WriteBuffer, uint
        /* Set the NVM control register to the WORD WRITE command for memory reading */
        TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
        XPROGTarget_SendByte(TINY_NVM_CMD_WORDWRITE);
        /* Set the NVM control register to the WORD WRITE command for memory reading */
        TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
        XPROGTarget_SendByte(TINY_NVM_CMD_WORDWRITE);
-       
+
        /* Send the address of the location to write to */
        TINYNVM_SendPointerAddress(WriteAddress);
        /* Send the address of the location to write to */
        TINYNVM_SendPointerAddress(WriteAddress);
-       
+
        while (WriteLength)
        {
                /* Wait until the NVM controller is no longer busy */
        while (WriteLength)
        {
                /* Wait until the NVM controller is no longer busy */
@@ -190,7 +222,7 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress, uint8_t* WriteBuffer, uint
                /* Write the low byte of data to the target */
                XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
                XPROGTarget_SendByte(*(WriteBuffer++));
                /* Write the low byte of data to the target */
                XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
                XPROGTarget_SendByte(*(WriteBuffer++));
-               
+
                /* Write the high byte of data to the target */
                XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
                XPROGTarget_SendByte(*(WriteBuffer++));
                /* Write the high byte of data to the target */
                XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
                XPROGTarget_SendByte(*(WriteBuffer++));
@@ -198,7 +230,7 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress, uint8_t* WriteBuffer, uint
                /* Need to decrement the write length twice, since we read out a whole word */
                WriteLength -= 2;
        }
                /* Need to decrement the write length twice, since we read out a whole word */
                WriteLength -= 2;
        }
-       
+
        return true;
 }
 
        return true;
 }
 
@@ -209,7 +241,8 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress, uint8_t* WriteBuffer, uint
  *
  *  \return Boolean true if the command sequence complete successfully
  */
  *
  *  \return Boolean true if the command sequence complete successfully
  */
-bool TINYNVM_EraseMemory(const uint8_t EraseCommand, const uint16_t Address)
+bool TINYNVM_EraseMemory(const uint8_t EraseCommand,
+                         const uint16_t Address)
 {
        /* Wait until the NVM controller is no longer busy */
        if (!(TINYNVM_WaitWhileNVMControllerBusy()))
 {
        /* Wait until the NVM controller is no longer busy */
        if (!(TINYNVM_WaitWhileNVMControllerBusy()))
@@ -227,8 +260,9 @@ bool TINYNVM_EraseMemory(const uint8_t EraseCommand, const uint16_t Address)
        /* Wait until the NVM controller is no longer busy */
        if (!(TINYNVM_WaitWhileNVMControllerBusy()))
          return false;
        /* Wait until the NVM controller is no longer busy */
        if (!(TINYNVM_WaitWhileNVMControllerBusy()))
          return false;
-       
+
        return true;
 }
 
 #endif
        return true;
 }
 
 #endif
+