/*
LUFA Library
- Copyright (C) Dean Camera, 2012.
+ Copyright (C) Dean Camera, 2013.
dean [at] fourwalledcubicle [dot] com
www.lufa-lib.org
*/
/*
- Copyright 2012 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
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
/** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read or CRC
* calculation.
*
- * \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 XMEGANVM_WaitWhileNVMBusBusy(void)
{
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 */
/** 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 XMEGANVM_WaitWhileNVMControllerBusy(void)
{
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 */
/** 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
+ * \return Boolean \c true if the PDI interface was enabled successfully, \c false otherwise
*/
bool XMEGANVM_EnablePDI(void)
{
* \param[in] CRCCommand NVM CRC command to issue to the target
* \param[out] CRCDest CRC Destination when read from the target
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean \c true if the command sequence complete successfully
*/
-bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand, uint32_t* const CRCDest)
+bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand,
+ uint32_t* const CRCDest)
{
+ *CRCDest = 0;
+
/* Wait until the NVM controller is no longer busy */
if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
return false;
for (uint8_t i = 0; i < XMEGA_CRC_LENGTH_BYTES; i++)
((uint8_t*)CRCDest)[i] = XPROGTarget_ReceiveByte();
- return (TimeoutExpired == false);
+ return (TimeoutTicksRemaining > 0);
}
/** Reads memory from the target's memory spaces.
* \param[out] ReadBuffer Buffer to store read data into
* \param[in] ReadSize Number of bytes to read
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean \c true if the command sequence complete successfully
*/
-bool XMEGANVM_ReadMemory(const uint32_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize)
+bool XMEGANVM_ReadMemory(const uint32_t ReadAddress,
+ uint8_t* ReadBuffer,
+ uint16_t ReadSize)
{
/* Wait until the NVM controller is no longer busy */
if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
/* 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-- && !(TimeoutExpired))
+ while (ReadSize-- && TimeoutTicksRemaining)
*(ReadBuffer++) = XPROGTarget_ReceiveByte();
- return (TimeoutExpired == false);
+ return (TimeoutTicksRemaining > 0);
}
/** Writes byte addressed memory to the target's memory spaces.
* \param[in] WriteAddress Address to write to within the target's address space
* \param[in] Byte Byte to write to the target
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean \c true if the command sequence complete successfully
*/
-bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand, const uint32_t WriteAddress, const uint8_t Byte)
+bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand,
+ const uint32_t WriteAddress,
+ const uint8_t Byte)
{
/* Wait until the NVM controller is no longer busy */
if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
* \param[in] WriteBuffer Buffer to source data from
* \param[in] WriteSize Number of bytes to write
*
- * \return Boolean true if the command sequence complete successfully
+ * \return Boolean \c true if the command sequence complete successfully
*/
-bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand, const uint8_t EraseBuffCommand,
- const uint8_t WritePageCommand, const uint8_t PageMode, const uint32_t WriteAddress,
- const uint8_t* WriteBuffer, uint16_t WriteSize)
+bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand,
+ const uint8_t EraseBuffCommand,
+ const uint8_t WritePageCommand,
+ const uint8_t PageMode,
+ const uint32_t WriteAddress,
+ const uint8_t* WriteBuffer,
+ uint16_t WriteSize)
{
if (PageMode & XPRG_PAGEMODE_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 XMEGANVM_EraseMemory(const uint8_t EraseCommand, const uint32_t Address)
+bool XMEGANVM_EraseMemory(const uint8_t EraseCommand,
+ const uint32_t Address)
{
/* Wait until the NVM controller is no longer busy */
if (!(XMEGANVM_WaitWhileNVMControllerBusy()))