Ensure the DFU bootloader disables and clears the activity LED toggle timer when...

[pub/USBasp.git] / Projects / AVRISP-MKII / Lib / XPROG / TINYNVM.c

diff --git a/Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c b/Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
index f981504..df0374d 100644 (file)
--- a/Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
+++ b/Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2012.
+

   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 2012  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.


@@ -77,7 +77,7 @@ static void TINYNVM_SendWriteNVMRegister(const uint8_t Address)
 bool TINYNVM_WaitWhileNVMBusBusy(void)
 {
        /* Poll the STATUS register to check to see if NVM access has been enabled */
 bool TINYNVM_WaitWhileNVMBusBusy(void)
 {
        /* Poll the STATUS register to check to see if NVM access has been enabled */

-       while (TimeoutMSRemaining)
+       for (;;)

        {
                /* Send the SLDCS command to read the TPI STATUS register to see the NVM bus is active */
                XPROGTarget_SendByte(TPI_CMD_SLDCS | TPI_STATUS_REG);
        {
                /* Send the SLDCS command to read the TPI STATUS register to see the NVM bus is active */
                XPROGTarget_SendByte(TPI_CMD_SLDCS | TPI_STATUS_REG);


@@ -85,18 +85,13 @@ 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 (!(TimeoutTicksRemaining))

                  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;

        }
        }

-
-       return false;

 }
 
 /** Waits while the target's NVM controller is busy performing an operation, exiting if the
 }
 
 /** Waits while the target's NVM controller is busy performing an operation, exiting if the


@@ -107,7 +102,7 @@ bool TINYNVM_WaitWhileNVMBusBusy(void)
 bool TINYNVM_WaitWhileNVMControllerBusy(void)
 {
        /* Poll the STATUS register to check to see if NVM access has been enabled */
 bool TINYNVM_WaitWhileNVMControllerBusy(void)
 {
        /* Poll the STATUS register to check to see if NVM access has been enabled */

-       while (TimeoutMSRemaining)
+       for (;;)

        {
                /* Send the SIN command to read the TPI STATUS register to see the NVM bus is busy */
                TINYNVM_SendReadNVMRegister(XPROG_Param_NVMCSRRegAddr);
        {
                /* Send the SIN command to read the TPI STATUS register to see the NVM bus is busy */
                TINYNVM_SendReadNVMRegister(XPROG_Param_NVMCSRRegAddr);


@@ -115,18 +110,53 @@ 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 (!(TimeoutTicksRemaining))

                  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 32 USART bits */
+       XPROGTarget_SendByte(TPI_CMD_SSTCS | TPI_CTRL_REG);
+       XPROGTarget_SendByte(0x02);
+
+       /* 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();

 
 

-       return false;
+       do
+       {
+               /* Clear the NVMEN bit in the TPI STATUS register to disable TPI mode */
+               XPROGTarget_SendByte(TPI_CMD_SSTCS | TPI_STATUS_REG);
+               XPROGTarget_SendByte(0x00);
+
+               /* Read back the STATUS register, check to see if it took effect */
+               XPROGTarget_SendByte(TPI_CMD_SLDCS | PDI_RESET_REG);
+       } while (XPROGTarget_ReceiveByte() != 0x00);
+
+       XPROGTarget_DisableTargetTPI();

 }
 
 /** Reads memory from the target's memory spaces.
 }
 
 /** Reads memory from the target's memory spaces.


@@ -137,7 +167,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()))


@@ -146,18 +178,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-- && TimeoutTicksRemaining)

        {
                /* 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 (TimeoutTicksRemaining > 0);

 }
 
 /** Writes word addressed memory to the target's memory spaces.
 }
 
 /** Writes word addressed memory to the target's memory spaces.


@@ -168,23 +200,25 @@ 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;
 

-       /* Set the NVM control register to the WORD WRITE command for memory reading */
+       /* Set the NVM control register to the WORD WRITE command for memory writing */

        TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
        XPROGTarget_SendByte(TINY_NVM_CMD_WORDWRITE);
        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 */


@@ -194,15 +228,15 @@ 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++));
 

-               /* Need to decrement the write length twice, since we read out a whole word */
+               /* Need to decrement the write length twice, since we wrote a whole two-byte word */

                WriteLength -= 2;
        }
                WriteLength -= 2;
        }

-       
+

        return true;
 }
 
        return true;
 }
 


@@ -213,7 +247,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()))


@@ -231,8 +266,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

+