Update UC3 platform driver support to use the bitmasks defined in the header files...

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

diff --git a/Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.c b/Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.c
index 22f4e93..e4f1186 100644 (file)
--- a/Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.c
+++ b/Projects/AVRISP-MKII/Lib/XPROG/XMEGANVM.c
@@ -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


@@ -45,10 +45,10 @@
 static void XMEGANVM_SendAddress(const uint32_t AbsoluteAddress)
 {
        /* Send the given 32-bit address to the target, LSB first */
 static void XMEGANVM_SendAddress(const uint32_t AbsoluteAddress)
 {
        /* Send the given 32-bit address to the target, LSB first */

-       XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[0]);
-       XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[1]);
-       XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[2]);
-       XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[3]);
+       XPROGTarget_SendByte(AbsoluteAddress &  0xFF);
+       XPROGTarget_SendByte(AbsoluteAddress >> 8);
+       XPROGTarget_SendByte(AbsoluteAddress >> 16);
+       XPROGTarget_SendByte(AbsoluteAddress >> 24);

 }
 
 /** Sends the given NVM register address to the target.
 }
 
 /** Sends the given NVM register address to the target.


@@ -76,13 +76,13 @@ bool XMEGANVM_WaitWhileNVMBusBusy(void)
        {
                /* Send the LDCS command to read the PDI STATUS register to see the NVM bus is active */
                XPROGTarget_SendByte(PDI_CMD_LDCS | PDI_STATUS_REG);
        {
                /* Send the LDCS command to read the PDI STATUS register to see the NVM bus is active */
                XPROGTarget_SendByte(PDI_CMD_LDCS | PDI_STATUS_REG);

-               
+

                uint8_t StatusRegister = XPROGTarget_ReceiveByte();
                uint8_t StatusRegister = XPROGTarget_ReceiveByte();

-               
+

                /* We might have timed out waiting for the status register read response, check here */
                /* We might have timed out waiting for the status register read response, check here */

-               if (!(TimeoutTicksRemaining))
+               if (TimeoutExpired)

                  return false;
                  return false;

-               
+

                /* Check the status register read response to see if the NVM bus is enabled */
                if (StatusRegister & PDI_STATUS_NVM)
                  return true;
                /* Check the status register read response to see if the NVM bus is enabled */
                if (StatusRegister & PDI_STATUS_NVM)
                  return true;


@@ -96,17 +96,20 @@ bool XMEGANVM_WaitWhileNVMBusBusy(void)
  */
 bool XMEGANVM_WaitWhileNVMControllerBusy(void)
 {
  */
 bool XMEGANVM_WaitWhileNVMControllerBusy(void)
 {

+       /* Preload the pointer register with the NVM STATUS register address to check the BUSY flag */
+       XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
+       XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_STATUS);
+

        /* Poll the NVM STATUS register while the NVM controller is busy */
        for (;;)
        {
        /* Poll the NVM STATUS register while the NVM controller is busy */
        for (;;)
        {

-               /* Send a LDS command to read the NVM STATUS register to check the BUSY flag */
-               XPROGTarget_SendByte(PDI_CMD_LDS | (PDI_DATSIZE_4BYTES << 2));
-               XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_STATUS);
-               
+               /* Fetch the current status value via the pointer register (without auto-increment afterwards) */
+               XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT << 2) | PDI_DATSIZE_1BYTE);
+

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

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


@@ -115,6 +118,48 @@ bool XMEGANVM_WaitWhileNVMControllerBusy(void)
        }
 }
 
        }
 }
 

+/** Enables the physical PDI interface on the target and enables access to the internal NVM controller.
+ *
+ *  \return Boolean true if the PDI interface was enabled successfully, false otherwise
+ */
+bool XMEGANVM_EnablePDI(void)
+{
+       /* Enable PDI programming mode with the attached target */
+       XPROGTarget_EnableTargetPDI();
+
+       /* Store the RESET key into the RESET PDI register to keep the XMEGA in reset */
+       XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
+       XPROGTarget_SendByte(PDI_RESET_KEY);
+
+       /* Lower direction change guard time to 0 USART bits */
+       XPROGTarget_SendByte(PDI_CMD_STCS | PDI_CTRL_REG);
+       XPROGTarget_SendByte(0x07);
+
+       /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
+       XPROGTarget_SendByte(PDI_CMD_KEY);
+       for (uint8_t i = sizeof(PDI_NVMENABLE_KEY); i > 0; i--)
+         XPROGTarget_SendByte(PDI_NVMENABLE_KEY[i - 1]);
+
+       /* Wait until the NVM bus becomes active */
+       return XMEGANVM_WaitWhileNVMBusBusy();
+}
+
+/** Removes access to the target's NVM controller and physically disables the target's physical PDI interface. */
+void XMEGANVM_DisablePDI(void)
+{
+       XMEGANVM_WaitWhileNVMBusBusy();
+
+       /* Clear the RESET key in the RESET PDI register to allow the XMEGA to run */
+       XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
+       XPROGTarget_SendByte(0x00);
+
+       /* Do it twice to make sure it takes effect (silicon bug?) */
+       XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
+       XPROGTarget_SendByte(0x00);
+
+       XPROGTarget_DisableTargetPDI();
+}
+

 /** Retrieves the CRC value of the given memory space.
  *
  *  \param[in]  CRCCommand  NVM CRC command to issue to the target
 /** Retrieves the CRC value of the given memory space.
  *
  *  \param[in]  CRCCommand  NVM CRC command to issue to the target


@@ -127,7 +172,7 @@ bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand, uint32_t* const CRCDest)
        /* Wait until the NVM controller is no longer busy */
        if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
          return false;
        /* Wait until the NVM controller is no longer busy */
        if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
          return false;

-         
+

        /* Set the NVM command to the correct CRC read command */
        XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
        XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
        /* Set the NVM command to the correct CRC read command */
        XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
        XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);


@@ -145,7 +190,7 @@ bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand, uint32_t* const CRCDest)
        /* Wait until the NVM controller is no longer busy */
        if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
          return false;
        /* Wait until the NVM controller is no longer busy */
        if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
          return false;

-       
+

        /* Load the PDI pointer register with the DAT0 register start address */
        XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
        XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_DAT0);
        /* Load the PDI pointer register with the DAT0 register start address */
        XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
        XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_DAT0);


@@ -153,13 +198,13 @@ bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand, uint32_t* const CRCDest)
        /* Send the REPEAT command to grab the CRC bytes */
        XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
        XPROGTarget_SendByte(XMEGA_CRC_LENGTH - 1);
        /* Send the REPEAT command to grab the CRC bytes */
        XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
        XPROGTarget_SendByte(XMEGA_CRC_LENGTH - 1);

-       
+

        /* Read in the CRC bytes from the target */
        XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
        for (uint8_t i = 0; i < XMEGA_CRC_LENGTH; i++)
          ((uint8_t*)CRCDest)[i] = XPROGTarget_ReceiveByte();
        /* Read in the CRC bytes from the target */
        XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
        for (uint8_t i = 0; i < XMEGA_CRC_LENGTH; i++)
          ((uint8_t*)CRCDest)[i] = XPROGTarget_ReceiveByte();

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

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


@@ -175,7 +220,7 @@ bool XMEGANVM_ReadMemory(const uint32_t ReadAddress, uint8_t* ReadBuffer, uint16
        /* Wait until the NVM controller is no longer busy */
        if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
          return false;
        /* Wait until the NVM controller is no longer busy */
        if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
          return false;

-       
+

        /* Send the READNVM command to the NVM controller for reading of an arbitrary location */
        XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
        XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
        /* Send the READNVM command to the NVM controller for reading of an arbitrary location */
        XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
        XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);


@@ -188,13 +233,13 @@ bool XMEGANVM_ReadMemory(const uint32_t ReadAddress, uint8_t* ReadBuffer, uint16
        /* Send the REPEAT command with the specified number of bytes to read */
        XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
        XPROGTarget_SendByte(ReadSize - 1);
        /* Send the REPEAT command with the specified number of bytes to read */
        XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
        XPROGTarget_SendByte(ReadSize - 1);

-               
+

        /* Send a LD command with indirect access and post-increment to read out the bytes */
        XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
        /* Send a LD command with indirect access and post-increment to read out the bytes */
        XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);

-       while (ReadSize-- && TimeoutTicksRemaining)
+       while (ReadSize-- && !(TimeoutExpired))

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

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

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


@@ -215,12 +260,12 @@ bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand, const uint32_t WriteAd
        XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
        XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
        XPROGTarget_SendByte(WriteCommand);
        XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
        XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
        XPROGTarget_SendByte(WriteCommand);

-       
+

        /* Send new memory byte to the memory of the target */
        XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
        XMEGANVM_SendAddress(WriteAddress);
        XPROGTarget_SendByte(Byte);
        /* Send new memory byte to the memory of the target */
        XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
        XMEGANVM_SendAddress(WriteAddress);
        XPROGTarget_SendByte(Byte);

-       
+

        return true;
 }
 
        return true;
 }
 


@@ -275,13 +320,13 @@ bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand, const uint8_t Eras
                /* Send the REPEAT command with the specified number of bytes to write */
                XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
                XPROGTarget_SendByte(WriteSize - 1);
                /* Send the REPEAT command with the specified number of bytes to write */
                XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
                XPROGTarget_SendByte(WriteSize - 1);

-                       
+

                /* Send a ST command with indirect access and post-increment to write the bytes */
                XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
                while (WriteSize--)
                  XPROGTarget_SendByte(*(WriteBuffer++));
        }
                /* Send a ST command with indirect access and post-increment to write the bytes */
                XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
                while (WriteSize--)
                  XPROGTarget_SendByte(*(WriteBuffer++));
        }

-       
+

        if (PageMode & XPRG_PAGEMODE_WRITE)
        {
                /* Wait until the NVM controller is no longer busy */
        if (PageMode & XPRG_PAGEMODE_WRITE)
        {
                /* Wait until the NVM controller is no longer busy */


@@ -292,7 +337,7 @@ bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand, const uint8_t Eras
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
                XPROGTarget_SendByte(WritePageCommand);
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
                XPROGTarget_SendByte(WritePageCommand);

-               
+

                /* Send the address of the first page location to write the memory page */
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendAddress(WriteAddress);
                /* Send the address of the first page location to write the memory page */
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendAddress(WriteAddress);


@@ -322,11 +367,11 @@ bool XMEGANVM_EraseMemory(const uint8_t EraseCommand, const uint32_t Address)
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
                XPROGTarget_SendByte(EraseCommand);
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
                XPROGTarget_SendByte(EraseCommand);

-       
+

                /* Set CMDEX bit in NVM CTRLA register to start the erase sequence */
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
                /* Set CMDEX bit in NVM CTRLA register to start the erase sequence */
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);

-               XPROGTarget_SendByte(1 << 0);   
+               XPROGTarget_SendByte(1 << 0);

        }
        else if (EraseCommand == XMEGA_NVM_CMD_ERASEEEPROM)
        {
        }
        else if (EraseCommand == XMEGA_NVM_CMD_ERASEEEPROM)
        {


@@ -356,21 +401,21 @@ bool XMEGANVM_EraseMemory(const uint8_t EraseCommand, const uint32_t Address)
                /* Send the REPEAT command with the specified number of bytes to write */
                XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
                XPROGTarget_SendByte(XPROG_Param_EEPageSize - 1);
                /* Send the REPEAT command with the specified number of bytes to write */
                XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
                XPROGTarget_SendByte(XPROG_Param_EEPageSize - 1);

-                       
+

                /* Send a ST command with indirect access and post-increment to tag each byte in the EEPROM page buffer */
                XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
                for (uint8_t PageByte = 0; PageByte < XPROG_Param_EEPageSize; PageByte++)
                  XPROGTarget_SendByte(0x00);
                /* Send a ST command with indirect access and post-increment to tag each byte in the EEPROM page buffer */
                XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
                for (uint8_t PageByte = 0; PageByte < XPROG_Param_EEPageSize; PageByte++)
                  XPROGTarget_SendByte(0x00);

-       
+

                /* Send the memory erase command to the target */
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
                XPROGTarget_SendByte(EraseCommand);
                /* Send the memory erase command to the target */
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
                XPROGTarget_SendByte(EraseCommand);

-       
+

                /* Set CMDEX bit in NVM CTRLA register to start the EEPROM erase sequence */
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
                /* Set CMDEX bit in NVM CTRLA register to start the EEPROM erase sequence */
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);

-               XPROGTarget_SendByte(1 << 0);           
+               XPROGTarget_SendByte(1 << 0);

        }
        else
        {
        }
        else
        {


@@ -378,18 +423,19 @@ bool XMEGANVM_EraseMemory(const uint8_t EraseCommand, const uint32_t Address)
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
                XPROGTarget_SendByte(EraseCommand);
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
                XPROGTarget_SendByte(EraseCommand);

-       
+

                /* Other erase modes just need us to address a byte within the target memory space */
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendAddress(Address);
                XPROGTarget_SendByte(0x00);
        }
                /* Other erase modes just need us to address a byte within the target memory space */
                XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
                XMEGANVM_SendAddress(Address);
                XPROGTarget_SendByte(0x00);
        }

-       
+

        /* Wait until the NVM bus is ready again */
        if (!(XMEGANVM_WaitWhileNVMBusBusy()))
          return false;
        /* Wait until the NVM bus is ready again */
        if (!(XMEGANVM_WaitWhileNVMBusBusy()))
          return false;

-         
+

        return true;
 }
 
 #endif
        return true;
 }
 
 #endif

+