nvm.c

#include <stdlib.h>
#include <string.h>
#include "app.h"
#include "devices.h"
#include "ihex.h"
#include "link.h"
#include "log.h"
#include "nvm.h"
#include "progress.h"
#include "updi.h"

static bool NVM_Progmode = false;

/** \brief Read info about current device
 *
 * \return
 *
 */
bool NVM_GetDeviceInfo(void)
{
  LOG_Print(LOG_LEVEL_INFO, "Reading device info");
  return true;//self.application.device_info()
}

/** \brief Enter programming mode
 *
 * \return true if succeed
 *
 */
bool NVM_EnterProgmode()
{
  LOG_Print(LOG_LEVEL_INFO, "Entering NVM programming mode");

  APP_EnterProgmode(false);
  NVM_Progmode = APP_EnterProgmode(true);

  return NVM_Progmode;
}

/** \brief Leave programming mode
 *
 * \return Nothing
 *
 */
void NVM_LeaveProgmode(void)
{
  LOG_Print(LOG_LEVEL_INFO, "Leaving NVM programming mode");
  APP_LeaveProgmode();
  NVM_Progmode = false;
}

/** \brief Unlock and erase a device
 *
 * \return Nothing
 *
 */
void NVM_UnlockDevice(void)
{
  if (NVM_Progmode == true)
  {
    LOG_Print(LOG_LEVEL_WARNING, "Device already unlocked");
    return;
  }

  // Unlock after using the NVM key results in prog mode.
  if (APP_Unlock() == true)
    NVM_Progmode = true;
}

/** \brief Erase chip flash memory
 *
 * \return true if succeed
 *
 */
bool NVM_ChipErase(void)
{
  if (NVM_Progmode == false)
  {
    LOG_Print(LOG_LEVEL_ERROR, "Enter progmode first!");
    return false;
  }

  return APP_ChipErase();
}

/** \brief Read data from flash memory
 *
 * \param [in] address Starting address
 * \param [out] data Buffer to write data
 * \param [in] size Length of data to read
 * \return true if succeed
 *
 */
bool NVM_ReadFlash(uint16_t address, uint8_t *data, uint16_t size)
{
  uint16_t i;
  uint16_t pages;
  uint8_t page_size;
  uint8_t err_counter;

  // Must be in prog mode here
  if (NVM_Progmode == false)
  {
    LOG_Print(LOG_LEVEL_ERROR, "Enter progmode first!");
    return false;
  }

  page_size = DEVICES_GetPageSize();

  // Find the number of pages
  pages = size / page_size;
  if (size % page_size != 0)
    pages++;

  PROGRESS_Print(0, pages, "Reading: ", '#');
  i = 0;

  err_counter = 0;
  // Read out page-wise for convenience
  while (i < pages)
  {
    LOG_Print(LOG_LEVEL_INFO, "Reading page at 0x%04X", address);
    if (APP_ReadDataWords(address, &data[i * page_size], DEVICES_GetPageSize() >> 1) == false)
    {
      // error occurred, try once more
      err_counter++;
      if (err_counter > NVM_MAX_ERRORS)
      {
        PROGRESS_Break();
        return false;
      }
      continue;
    } else
    {
      err_counter = 0;
    }
    i++;
    // show progress bar
    PROGRESS_Print(i, pages, "Reading: ", '#');
    address += page_size;
  }

  return true;
}

/** \brief Write data buffer to flash
 *
 * \param [in] address Address to start writing
 * \param [in] data Data buffer to write
 * \param [in] size Length of data
 * \return true if succeed
 *
 */
bool NVM_WriteFlash(uint16_t address, uint8_t *data, uint16_t size)
{
  uint8_t page_size;
  uint16_t pages;
  uint16_t i;
  uint8_t err_counter;

  // Must be in prog mode
  if (NVM_Progmode == false)
  {
    LOG_Print(LOG_LEVEL_ERROR, "Enter progmode first!");
    return false;
  }

  page_size = DEVICES_GetPageSize();

  // Divide up into pages
  pages = size / page_size;
  if (size % page_size != 0)
    pages++;

  PROGRESS_Print(0, pages, "Writing: ", '#');
  i = 0;

  err_counter = 0;
  // Program each page
  while (i < pages)
  {
    LOG_Print(LOG_LEVEL_INFO, "Writing page at 0x%04X", address);
    if (APP_WriteNvm(address, &data[i * page_size], page_size, true) == false)
    {
      err_counter++;
      if (err_counter > NVM_MAX_ERRORS)
      {
        PROGRESS_Break();
        return false;
      }
      continue;
    } else
    {
      err_counter = 0;
    }
    i++;
    // show progress bar
    PROGRESS_Print(i, pages, "Writing: ", '#');
    address += page_size;
  }

  return true;
}

/** \brief Read fuse value
 *
 * \param [in] fusenum Number of the fuse
 * \return Fuse value as uint8_t
 *
 */
uint8_t NVM_ReadFuse(uint8_t fusenum)
{
  uint16_t address;

  // Must be in prog mode
  if (NVM_Progmode == false)
  {
    LOG_Print(LOG_LEVEL_ERROR, "Enter progmode first!");
    return false;
  }

  address = DEVICES_GetFusesAddress() + fusenum;

  return LINK_ld(address);
}

/** \brief Write fuse value
 *
 * \param [in] fusenum Number of the fuse
 * \param [in] value Fuse value
 * \return true if succeed
 *
 */
bool NVM_WriteFuse(uint8_t fusenum, uint8_t value)
{
  uint16_t fuse_address;
  uint16_t address;
  uint8_t data;

  // Must be in prog mode
  if (NVM_Progmode == false)
  {
    LOG_Print(LOG_LEVEL_ERROR, "Enter progmode first!");
    return false;
  }

  if (!APP_WaitFlashReady())
  {
    LOG_Print(LOG_LEVEL_ERROR, "Flash not ready for fuse setting");
    return false;
  }

  fuse_address = DEVICES_GetFusesAddress() + fusenum;

  address = DEVICES_GetNvmctrlAddress() + UPDI_NVMCTRL_ADDRL;
  data = (uint8_t)(fuse_address & 0xff);
  APP_WriteData(address, &data, sizeof(uint8_t));

  address = DEVICES_GetNvmctrlAddress() + UPDI_NVMCTRL_ADDRH;
  data = (uint8_t)(fuse_address >> 8);
  APP_WriteData(address, &data, sizeof(uint8_t));

  address = DEVICES_GetNvmctrlAddress() + UPDI_NVMCTRL_DATAL;
  APP_WriteData(address, &value, sizeof(uint8_t));

  address = DEVICES_GetNvmctrlAddress() + UPDI_NVMCTRL_CTRLA;
  data = UPDI_NVMCTRL_CTRLA_WRITE_FUSE;
  APP_WriteData(address, &data, sizeof(uint8_t));

  return true;
}

/** \brief Load data from Intel HEX format
 *
 * \param [in] filename Name of the HEX file
 * \param [in] address Chip starting address
 * \param [in] len Length of the data
 * \return true if succeed
 *
 */
bool NVM_LoadIhex(char *filename, uint16_t address, uint16_t len)
{
  uint8_t *fdata;
  uint8_t errCode;
  uint16_t max_addr, min_addr;
  FILE *fp;
  bool res = false;

  fdata = malloc(len);
  if (!fdata)
  {
    LOG_Print(LOG_LEVEL_ERROR, "Unable to allocate %d bytes\n", (int)len);
    return false;
  }
  if ((fp = fopen(filename, "rt")) == NULL)
  {
    LOG_Print(LOG_LEVEL_ERROR, "Unable to open file: %s", filename);
    free(fdata);
    return false;
  }
  max_addr = 0;
  min_addr = 0;
  errCode = IHEX_ReadFile(fp, fdata, len, &max_addr);
  switch (errCode)
  {
    case IHEX_ERROR_FILE:
    case IHEX_ERROR_SIZE:
    case IHEX_ERROR_FMT:
    case IHEX_ERROR_CRC:
      LOG_Print(LOG_LEVEL_ERROR, "Problem reading Hex file");
      res = false;
      break;
    case IHEX_ERROR_NONE:
      // write data buffer to flash
      res = NVM_WriteFlash(address, fdata, max_addr - min_addr);
      break;
  }
  free(fdata);
  fclose(fp);

  // Size check: not implemented yet

  return res;
}

/** \brief Save file to Intel HEX format
 *
 * \param [in] filename Name of the HEX file
 * \param [in] address Chip starting address
 * \param [in] len Length of data
 * \return true if succeed
 *
 */
bool NVM_SaveIhex(char *filename, uint16_t address, uint16_t len)
{
  uint8_t *fdata;
  FILE *fp;
  bool res = false;

  fdata = malloc(len);
  if (!fdata)
  {
    LOG_Print(LOG_LEVEL_ERROR, "Unable to allocate %d bytes", (int)len);
    return false;
  }
  memset(fdata, 0xff, len);
  if ((fp = fopen(filename, "w")) == NULL)
  {
    LOG_Print(LOG_LEVEL_ERROR, "Unable to open file: %s", filename);
  } else
  {
    if (NVM_ReadFlash(address, fdata, len) == false)
    {
      LOG_Print(LOG_LEVEL_ERROR, "Reading from device failed");
    } else
    {
      if (IHEX_WriteFile(fp, fdata, len) == IHEX_ERROR_NONE)
        res = true;
      else
        LOG_Print(LOG_LEVEL_ERROR, "Problem writing Hex file");
    }
    fclose(fp);
  }
  free(fdata);

  return res;
}