Minor documentation improvements.

[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 49d5766..6d947af 100644 (file)
--- a/Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
+++ b/Projects/AVRISP-MKII/Lib/XPROG/TINYNVM.c
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2013.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this

   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages


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


@@ -55,8 +55,8 @@ static void TINYNVM_SendPointerAddress(const uint16_t AbsoluteAddress)
 static void TINYNVM_SendReadNVMRegister(const uint8_t Address)
 {
        /* The TPI command for reading from the I/O space uses strange addressing, where the I/O address's upper
 static void TINYNVM_SendReadNVMRegister(const uint8_t Address)
 {
        /* The TPI command for reading from the I/O space uses strange addressing, where the I/O address's upper

-        * two bits of the 6-bit address are shifted left once */
-       XPROGTarget_SendByte(TPI_CMD_SIN | ((Address & 0x30) << 1) | (Address & 0x0F));
+        * two bits of the 6-bit address are shifted left once - use function to reduce code size */
+       XPROGTarget_SendByte(TPI_CMD_SIN(Address));

 }
 
 /** Sends a SOUT command to the target with the specified I/O address, ready for the data byte to be read.
 }
 
 /** Sends a SOUT command to the target with the specified I/O address, ready for the data byte to be read.


@@ -66,13 +66,13 @@ static void TINYNVM_SendReadNVMRegister(const uint8_t Address)
 static void TINYNVM_SendWriteNVMRegister(const uint8_t Address)
 {
        /* The TPI command for reading from the I/O space uses strange addressing, where the I/O address's upper
 static void TINYNVM_SendWriteNVMRegister(const uint8_t Address)
 {
        /* The TPI command for reading from the I/O space uses strange addressing, where the I/O address's upper

-        * two bits of the 6-bit address are shifted left once */
-       XPROGTarget_SendByte(TPI_CMD_SOUT | ((Address & 0x30) << 1) | (Address & 0x0F));
+        * two bits of the 6-bit address are shifted left once - use function to reduce code size */
+       XPROGTarget_SendByte(TPI_CMD_SOUT(Address));

 }
 
 /** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read.
  *
 }
 
 /** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read.
  *

- *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
+ *  \return Boolean \c true if the NVM controller became ready within the timeout period, \c false otherwise

  */
 bool TINYNVM_WaitWhileNVMBusBusy(void)
 {
  */
 bool TINYNVM_WaitWhileNVMBusBusy(void)
 {


@@ -80,12 +80,12 @@ bool TINYNVM_WaitWhileNVMBusBusy(void)
        for (;;)
        {
                /* Send the SLDCS command to read the TPI STATUS register to see the NVM bus is active */
        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);
+               XPROGTarget_SendByte(TPI_CMD_SLDCS(TPI_REG_STATUS));

 
                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 (TimeoutExpired)
+               if (!(TimeoutTicksRemaining))

                  return false;
 
                /* Check the status register read response to see if the NVM bus is enabled */
                  return false;
 
                /* Check the status register read response to see if the NVM bus is enabled */


@@ -97,7 +97,7 @@ bool TINYNVM_WaitWhileNVMBusBusy(void)
 /** Waits while the target's NVM controller is busy performing an operation, exiting if the
  *  timeout period expires.
  *
 /** Waits while the target's NVM controller is busy performing an operation, exiting if the
  *  timeout period expires.
  *

- *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
+ *  \return Boolean \c true if the NVM controller became ready within the timeout period, \c false otherwise

  */
 bool TINYNVM_WaitWhileNVMControllerBusy(void)
 {
  */
 bool TINYNVM_WaitWhileNVMControllerBusy(void)
 {


@@ -110,7 +110,7 @@ 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 (TimeoutExpired)
+               if (!(TimeoutTicksRemaining))

                  return false;
 
                /* Check to see if the BUSY flag is still set */
                  return false;
 
                /* Check to see if the BUSY flag is still set */


@@ -121,16 +121,16 @@ bool TINYNVM_WaitWhileNVMControllerBusy(void)
 
 /** Enables the physical TPI interface on the target and enables access to the internal NVM controller.
  *
 
 /** 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
+ *  \return Boolean \c true if the TPI interface was enabled successfully, \c false otherwise

  */
 bool TINYNVM_EnableTPI(void)
 {
        /* Enable TPI programming mode with the attached target */
        XPROGTarget_EnableTargetTPI();
 
  */
 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);
+       /* Lower direction change guard time to 32 USART bits */
+       XPROGTarget_SendByte(TPI_CMD_SSTCS(TPI_REG_CTRL));
+       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);
 
        /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
        XPROGTarget_SendByte(TPI_CMD_SKEY);


@@ -146,9 +146,15 @@ void TINYNVM_DisableTPI(void)
 {
        TINYNVM_WaitWhileNVMBusBusy();
 
 {
        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);
+       do
+       {
+               /* Clear the NVMEN bit in the TPI STATUS register to disable TPI mode */
+               XPROGTarget_SendByte(TPI_CMD_SSTCS(TPI_REG_STATUS));
+               XPROGTarget_SendByte(0x00);
+
+               /* Read back the STATUS register, check to see if it took effect */
+               XPROGTarget_SendByte(TPI_CMD_SLDCS(TPI_REG_STATUS));
+       } while (XPROGTarget_ReceiveByte() != 0x00);

 
        XPROGTarget_DisableTargetTPI();
 }
 
        XPROGTarget_DisableTargetTPI();
 }


@@ -159,7 +165,7 @@ void TINYNVM_DisableTPI(void)
  *  \param[out] ReadBuffer   Buffer to store read data into
  *  \param[in]  ReadSize     Length of the data to read from the device
  *
  *  \param[out] ReadBuffer   Buffer to store read data into
  *  \param[in]  ReadSize     Length of the data to read from the device
  *

- *  \return Boolean true if the command sequence complete successfully
+ *  \return Boolean \c true if the command sequence complete successfully

  */
 bool TINYNVM_ReadMemory(const uint16_t ReadAddress,
                         uint8_t* ReadBuffer,
  */
 bool TINYNVM_ReadMemory(const uint16_t ReadAddress,
                         uint8_t* ReadBuffer,


@@ -176,14 +182,14 @@ bool TINYNVM_ReadMemory(const uint16_t ReadAddress,
        /* 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-- && !(TimeoutExpired))
+       while (ReadSize-- && TimeoutTicksRemaining)

        {
                /* Read the byte of data from the target */
        {
                /* Read the byte of data from the target */

-               XPROGTarget_SendByte(TPI_CMD_SLD | TPI_POINTER_INDIRECT_PI);
+               XPROGTarget_SendByte(TPI_CMD_SLD(TPI_POINTER_INDIRECT_PI));

                *(ReadBuffer++) = XPROGTarget_ReceiveByte();
        }
 
                *(ReadBuffer++) = XPROGTarget_ReceiveByte();
        }
 

-       return (TimeoutExpired == false);
+       return (TimeoutTicksRemaining > 0);

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


@@ -192,7 +198,7 @@ bool TINYNVM_ReadMemory(const uint16_t ReadAddress,
  *  \param[in] WriteBuffer   Buffer to source data from
  *  \param[in] WriteLength   Total number of bytes to write to the device (must be an integer multiple of 2)
  *
  *  \param[in] WriteBuffer   Buffer to source data from
  *  \param[in] WriteLength   Total number of bytes to write to the device (must be an integer multiple of 2)
  *

- *  \return Boolean true if the command sequence complete successfully
+ *  \return Boolean \c true if the command sequence complete successfully

  */
 bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
                          uint8_t* WriteBuffer,
  */
 bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
                          uint8_t* WriteBuffer,


@@ -206,7 +212,7 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
        if (WriteLength & 0x01)
          WriteBuffer[WriteLength++] = 0xFF;
 
        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);
 


@@ -220,14 +226,14 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
                  return false;
 
                /* Write the low byte of data to the target */
                  return false;
 
                /* Write the low byte of data to the target */

-               XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
+               XPROGTarget_SendByte(TPI_CMD_SST(TPI_POINTER_INDIRECT_PI));

                XPROGTarget_SendByte(*(WriteBuffer++));
 
                /* Write the high byte of data to the target */
                XPROGTarget_SendByte(*(WriteBuffer++));
 
                /* Write the high byte of data to the target */

-               XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
+               XPROGTarget_SendByte(TPI_CMD_SST(TPI_POINTER_INDIRECT_PI));

                XPROGTarget_SendByte(*(WriteBuffer++));
 
                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;
        }
 


@@ -239,7 +245,7 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
  *  \param[in] EraseCommand  NVM erase command to send to the device
  *  \param[in] Address       Address inside the memory space to erase
  *
  *  \param[in] EraseCommand  NVM erase command to send to the device
  *  \param[in] Address       Address inside the memory space to erase
  *

- *  \return Boolean true if the command sequence complete successfully
+ *  \return Boolean \c 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)


@@ -254,7 +260,7 @@ bool TINYNVM_EraseMemory(const uint8_t EraseCommand,
 
        /* Write to a high byte location within the target address space to start the erase process */
        TINYNVM_SendPointerAddress(Address | 0x0001);
 
        /* Write to a high byte location within the target address space to start the erase process */
        TINYNVM_SendPointerAddress(Address | 0x0001);

-       XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT);
+       XPROGTarget_SendByte(TPI_CMD_SST(TPI_POINTER_INDIRECT));

        XPROGTarget_SendByte(0x00);
 
        /* Wait until the NVM controller is no longer busy */
        XPROGTarget_SendByte(0x00);
 
        /* Wait until the NVM controller is no longer busy */