4.18.4 NVMCTRL with Sector Operations

This file contains API prototypes and other data types for the Non-Volatile Memory (NVM) driver.

Version: NVM Driver Version 6.0.0

#include "../mcc_generated_files/system/system.h"

#define FLASH_ADDRESS (PROGMEM_SIZE - 5) //Flash address at which data is to be written

void FLASH_Example_PageErase_RowWrite_Read(void)
{
    flash_address_t flashStartPageAddress;
    uint16_t index;
    flash_data_t flashWriteData[PROGMEM_PAGE_SIZE];
    nvm_status_t errorStatus = NVM_OK;
    bool readError = false;

    //Get the starting address of the page containing the given address
    flashStartPageAddress = FLASH_PageAddressGet(FLASH_ADDRESS);
  
    //Erase entire page
    NVM_UnlockKeySet(UNLOCK_KEY_PAGE_ERASE);
   
    errorStatus = FLASH_PageErase(flashStartPageAddress);
    NVM_UnlockKeyClear();
    if (errorStatus == NVM_OK)
    {
        printf("FLASH_PageErase passed \r\n");
    }
    else
    {
        printf("FLASH_PageErase failed \r\n");
        NVM_StatusClear();
    }

    //Prepare row data
    for (index = 0; index < PROGMEM_PAGE_SIZE; index++)
    {
        flashWriteData[index] = (flash_data_t) index;
    }

    //Write data to Flash row
    NVM_UnlockKeySet(UNLOCK_KEY_ROW_WRITE);
    errorStatus = FLASH_RowWrite(flashStartPageAddress, flashWriteData);
    NVM_UnlockKeyClear();
    if (errorStatus == NVM_OK)
    {
        printf("FLASH_RowWrite passed \r\n");
    }
    else
    {
        printf("FLASH_RowWrite failed \r\n");
        NVM_StatusClear();
    }

    //Read and verify row data
    for (index = 0; index < PROGMEM_PAGE_SIZE; index++)
    {
        if (FLASH_Read(flashStartPageAddress + index) != flashWriteData[index])
        {
            readError = true;
            break;
        }
    }

    if (readError == false)
    {
        printf("FLASH_Read passed \r\n");
    }
    else
    {
        printf("FLASH_Read failed \r\n");
    }
}

#include "../mcc_generated_files/system/system.h"

#define FLASH_ADDRESS (PROGMEM_SIZE - 5) //Flash address at which data is to be written

void FLASH_Example_PageErase_Write_Read(void)
{
    flash_address_t flashStartPageAddress;
    nvm_status_t errorStatus = NVM_OK;

    //Get the starting address of the page containing the given address
    flashStartPageAddress = FLASH_PageAddressGet(FLASH_ADDRESS);

    //Erase entire page
    NVM_UnlockKeySet(UNLOCK_KEY_PAGE_ERASE);
    errorStatus = FLASH_PageErase(flashStartPageAddress);
    NVM_UnlockKeyClear();
    if (errorStatus == NVM_OK)
    {
        printf("FLASH_PageErase passed \r\n");
    }
    else
    {
        printf("FLASH_PageErase failed \r\n");
        NVM_StatusClear();
    }

    //Write one word (0xAAAA) at the beginning of the page
    NVM_UnlockKeySet(UNLOCK_KEY_WORD_BYTE_WRITE); 
    errorStatus = FLASH_Write(flashStartPageAddress, 0xAAAA);
    NVM_UnlockKeyClear();
    if (errorStatus == NVM_OK)
    {
        printf("FLASH_Write passed \r\n");
    }
    else
    {
        printf("FLASH_Write failed \r\n");
        NVM_StatusClear();
    }

    //Verify FLASH_WordWrite by reading
    if (0xAAAA == (uint16_t) (FLASH_Read(flashStartPageAddress + 1) << 8 | FLASH_Read(flashStartPageAddress)))
    {
        printf("FLASH_Read passed \r\n");
    }
    else
    {
        printf("FLASH_Read failed \r\n");
    }
}

#include "../mcc_generated_files/system/system.h"

#define FLASH_ADDRESS (PROGMEM_SIZE - 5) //Flash address at which data is to be written

flash_data_t flashWriteData[PROGMEM_PAGE_SIZE] __at(BUFFER_RAM_START_ADDRESS);

void FLASH_Example_UpdateSelectiveLocations(void)
{
    flash_address_t flashStartPageAddress;
    uint16_t flashAddressOffset;
    nvm_status_t errorStatus = NVM_OK;
    bool readError = false;  

    //Get the starting address of the page containing the given address
    flashStartPageAddress = FLASH_PageAddressGet(FLASH_ADDRESS);

    //Read entire row in buffer RAM 
    NVM_UnlockKeySet(UNLOCK_KEY_ROW_READ);  
    errorStatus = FLASH_RowRead(flashStartPageAddress, flashWriteData);
    NVM_UnlockKeyClear();
    if (errorStatus == NVM_OK)
    {
        printf("FLASH_RowRead passed \r\n");
    }
    else
    {
        printf("FLASH_RowRead failed \r\n");
        NVM_StatusClear();
    }
    
    //Get offset from the starting address of the page
    flashAddressOffset = FLASH_PageOffsetGet(FLASH_ADDRESS);

    //Update 4 bytes
    flashWriteData[flashAddressOffset] = 0x0A;
    flashWriteData[flashAddressOffset + 1] = 0x1A;
    flashWriteData[flashAddressOffset + 2] = 0x2A;
    flashWriteData[flashAddressOffset + 3] = 0x3A;

    //Erase entire Flash page
    NVM_UnlockKeySet(UNLOCK_KEY_PAGE_ERASE);
    errorStatus = FLASH_PageErase(flashStartPageAddress);
    NVM_UnlockKeyClear();
    if (errorStatus == NVM_OK)
    {
        printf("FLASH_PageErase passed \r\n");
    }
    else
    {
        printf("FLASH_PageErase failed \r\n");
        NVM_StatusClear();
    }

    //Write data to Flash row
    NVM_UnlockKeySet(UNLOCK_KEY_ROW_WRITE);
    errorStatus = FLASH_RowWrite(flashStartPageAddress, flashWriteData);
    NVM_UnlockKeyClear();
    if (errorStatus == NVM_OK)
    {
        printf("FLASH_RowWrite passed \r\n");
    }
    else
    {
        printf("FLASH_RowWrite failed \r\n");
        NVM_StatusClear();
    }

    //Read and verify row data
    for (flashAddressOffset = 0; flashAddressOffset < PROGMEM_PAGE_SIZE; flashAddressOffset++)
    {
        if (FLASH_Read(flashStartPageAddress + flashAddressOffset) != flashWriteData[flashAddressOffset])
        {
            readError = true;
            break;
        }
    }

    if (readError == false)
    {
        printf("FLASH_Read passed \r\n");
    }
    else
    {
        printf("FLASH_Read failed \r\n");
    }
}

#include "../mcc_generated_files/system/system.h"

#define EEPROM_ADDRESS (EEPROM_START_ADDRESS) //EEPROM address at which data is to be written

void EEPROM_Write_Read(void)
{
    eeprom_data_t eepromWriteData[8];
    uint8_t count;
    bool readError = false;

    //Prepare data
    for (count = 0; count < 8; count++)
    {
        eepromWriteData[count] = 0xA1 + count;
    }

    for (count = 0; count < 8; count++)
    {
        //Write EEPROM byte
        NVM_UnlockKeySet(UNLOCK_KEY_WORD_BYTE_WRITE);
        EEPROM_Write(EEPROM_ADDRESS + count, eepromWriteData[count]);
        NVM_UnlockKeyClear();
        while (NVM_IsBusy());
        if (NVM_StatusGet() == NVM_OK)
        {
            printf("EEPROM_Write passed \r\n");
        }
        else
        {
            printf("EEPROM_Write failed \r\n");
            NVM_StatusClear();
        }
    }

    //Read and verify
    for (count = 0; count < 8; count++)
    {
        if (EEPROM_Read(EEPROM_ADDRESS + count) != eepromWriteData[count])
        {
            readError = true;
            break;
        }
    }

    if (readError == false)
    {
        printf("EEPROM_Read passed \r\n");
    }
    else
    {
        printf("EEPROM_Read failed \r\n");
    }
}

#include "mcc_generated_files/system/system.h"

#define DEVICE_ID_ADDRESS (0x3FFFFEU) //Compare with the device data sheet to see if the address is correct

void NVM_Example_DeviceID_Read(void)
{ 
    printf("Device ID : 0x%X \r\n", DeviceID_Read(DEVICE_ID_ADDRESS));
}

#include "mcc_generated_files/system/system.h"

#define CONFIG_TO_BE_UPDATED_ADDRESS (0x300000U) //CONFIG1L address (Compare with the device data sheet to see if the address is correct)
#define FIRST_CONFIG_ADDRESS (0x300000U) //Compare with the device data sheet to see if the address is correct
#define _CONFIG1_FEXTOSC_MASK (0b111)

configuration_data_t configurationData[CONFIGURATION_ROW_SIZE] __at(BUFFER_RAM_START_ADDRESS);

void NVM_Example_Configuration_UpdateSpecifcSetting(void)
{
    configuration_address_t configurationToBeUpdatedAddress = CONFIG_TO_BE_UPDATED_ADDRESS;   
    nvm_status_t errorStatus = NVM_OK;   
    bool readError = false;
    configuration_address_t configurationIndex;
        
    //Read
    NVM_UnlockKeySet(UNLOCK_KEY_ROW_READ);
    errorStatus = CONFIGURATION_RowRead(FIRST_CONFIG_ADDRESS, configurationData);
    NVM_UnlockKeyClear();
    if (errorStatus == NVM_OK)
    {
        printf("CONFIGURATION_RowRead passed \r\n");
    }
    else
    {
        printf("CONFIGURATION_RowRead failed \r\n");
        NVM_StatusClear();
    }
    
    //Modify 
    configurationData[configurationToBeUpdatedAddress - FIRST_CONFIG_ADDRESS] &= (~((configuration_data_t)_CONFIG1_FEXTOSC_MASK)); //Clear External Oscillator Mode Selection bits
    
    //Write
    NVM_UnlockKeySet(UNLOCK_KEY_ROW_WRITE);
    errorStatus = CONFIGURATION_RowWrite(FIRST_CONFIG_ADDRESS, configurationData);
    NVM_UnlockKeyClear();
    if (errorStatus == NVM_OK)
    {
        printf("CONFIGURATION_RowWrite passed \r\n");
    }
    else
    {
        printf("CONFIGURATION_RowWrite failed \r\n");
        NVM_StatusClear();
    }
 
    //Read again to verify
    for (configurationIndex = FIRST_CONFIG_ADDRESS; configurationIndex <= LAST_CONFIG_ADDRESS; configurationIndex++)
    {
        if (CONFIGURATION_Read(configurationIndex) != configurationData[configurationIndex - FIRST_CONFIG_ADDRESS])
        {
            readError = true;
            break;
        }
    }

    if (readError == false)
    {
        printf("CONFIGURATION_Read passed \r\n");
    }
    else
    {
        printf("CONFIGURATION_Read failed \r\n");
    }
}

• void NVM_Initialize (void)

  Initializes the NVM driver.

• bool NVM_IsBusy (void)

  Checks if the NVM is busy with the read/write/erase commands.

• nvm_status_t NVM_StatusGet (void)

  Returns the status of the last NVM operation.

• void NVM_StatusClear (void)

  Clears the NVM error status.

• void NVM_UnlockKeySet (uint16_t unlockKey)

  Sets the unlock keys required to perform any erase or write operations on Flash and EEPROM.

• void NVM_UnlockKeyClear (void)

  Clears the previously configured unlock keys.

• flash_data_t FLASH_Read (flash_address_t address)

  Reads a byte from the given address of Flash.

• nvm_status_t FLASH_RowRead (flash_address_t address, flash_data_t *dataBuffer)

  Reads one entire Flash row/sector from the given starting address of the row (the first byte location). The size of the buffer must be one Flash row and the address must be aligned with the row boundary. Use FLASH_PageAddressGet() to obtain the starting address of the row. As this is a non-portable API, it may not be supported by all 8-bit PIC® and AVR® devices.

• nvm_status_t FLASH_Write (flash_address_t address, uint16_t data)

  Writes a word at the given Flash address. As this is a non-portable API, it may not be supported by all 8-bit PIC® and AVR® devices.

• nvm_status_t FLASH_RowWrite (flash_address_t address, flash_data_t *dataBuffer)

  Writes one entire Flash row/sector from the given starting address of the row (the first byte location). The size of the input buffer must be one Flash row and the address must be aligned with the row boundary. Use FLASH_PageAddressGet() to obtain the starting address of the row.

• nvm_status_t FLASH_PageErase (flash_address_t address)

  Erases one Flash page/sector containing the given address.

• flash_address_t FLASH_PageAddressGet (flash_address_t address)

  Returns the starting address of the page/sector (the first byte location) containing the given Flash address.

• uint16_t FLASH_PageOffsetGet (flash_address_t address)

  Returns the offset from the starting address of the page/sector (the first byte location).

• eeprom_data_t EEPROM_Read (eeprom_address_t address)

  Reads one byte from the given EEPROM address.

• void EEPROM_Write (eeprom_address_t address, eeprom_data_t data)

  Writes one byte to the given EEPROM address. The NVM busy status must be checked using the NVM_IsBusy() API to know if the write operation is completed.

• device_id_data_t DeviceID_Read (device_id_address_t address)

  Reads the Device ID.

• configuration_data_t CONFIGURATION_Read (configuration_address_t address)

  Reads one Configuration byte.

• nvm_status_t CONFIGURATION_RowRead (configuration_address_t address, configuration_data_t *dataBuffer)

  Reads all the Configuration Words. The size of the buffer must be one Configuration row/sector and the address must be aligned with the row boundary. Use FLASH_PageAddressGet() to obtain the starting address of the row.

• nvm_status_t CONFIGURATION_RowWrite (configuration_address_t address, configuration_data_t *dataBuffer)

  Writes all the Configuration Words. The size of the buffer must be one Configuration row/sector and the address must be aligned with the row boundary (the first Configuration word location). Use FLASH_PageAddressGet() to obtain the starting address of the row.

• void NVM_InterruptEnable (void)

  Enables the NVM interrupt.

• void NVM_InterruptDisable (void)

  Disables the NVM interrupt.

• void NVM_ISR (void)

  NVM Interrupt Service Routine (ISR) function.

• void NVM_CallbackRegister (void(*CallbackHandler)(void))

  Setter function for the NVM interrupt callback.

• __near static volatile uint8_t unlockKeyLow

• __near static volatile uint8_t unlockKeyHigh

• static void(* NVM_Callback )(void) = NULL

• void NVM_Initialize (void)

  Initializes the NVM driver.

• bool NVM_IsBusy (void)

  Checks if the NVM is busy with the read/write/erase commands.

• nvm_status_t NVM_StatusGet (void)

  Returns the status of the last NVM operation.

• void NVM_StatusClear (void)

  Clears the NVM error status.

• void NVM_UnlockKeySet (uint16_t unlockKey)

  Sets the unlock keys required to perform any erase or write operations on Flash and EEPROM.

• void NVM_UnlockKeyClear (void)

  Clears the previously configured unlock keys.

• flash_data_t FLASH_Read (flash_address_t address)

  Reads a byte from the given address of Flash.

• nvm_status_t FLASH_RowRead (flash_address_t address, flash_data_t *dataBuffer)

  Reads one entire Flash row/sector from the given starting address of the row (the first byte location). The size of the buffer must be one Flash row and the address must be aligned with the row boundary. Use FLASH_PageAddressGet() to obtain the starting address of the row. As this is a non-portable API, it may not be supported by all 8-bit PIC® and AVR® devices.

• nvm_status_t FLASH_Write (flash_address_t address, uint16_t data)

  Writes a word at the given Flash address. As this is a non-portable API, it may not be supported by all 8-bit PIC® and AVR® devices.

• nvm_status_t FLASH_RowWrite (flash_address_t address, flash_data_t *dataBuffer)

  Writes one entire Flash row/sector from the given starting address of the row (the first byte location). The size of the input buffer must be one Flash row and the address must be aligned with the row boundary. Use FLASH_PageAddressGet() to obtain the starting address of the row.

• nvm_status_t FLASH_PageErase (flash_address_t address)

  Erases one Flash page/sector containing the given address.

• flash_address_t FLASH_PageAddressGet (flash_address_t address)

  Returns the starting address of the page/sector (the first byte location) containing the given Flash address.

• uint16_t FLASH_PageOffsetGet (flash_address_t address)

  Returns the offset from the starting address of the page/sector (the first byte location).

• eeprom_data_t EEPROM_Read (eeprom_address_t address)

  Reads one byte from the given EEPROM address.

• void EEPROM_Write (eeprom_address_t address, eeprom_data_t data)

  Writes one byte to the given EEPROM address. The NVM busy status must be checked using the NVM_IsBusy() API to know if the write operation is completed.

• device_id_data_t DeviceID_Read (device_id_address_t address)

  Reads the Device ID.

• configuration_data_t CONFIGURATION_Read (configuration_address_t address)

  Reads one Configuration byte.

• nvm_status_t CONFIGURATION_RowRead (configuration_address_t address, configuration_data_t *dataBuffer)

  Reads all the Configuration Words. The size of the buffer must be one Configuration row/sector and the address must be aligned with the row boundary. Use FLASH_PageAddressGet() to obtain the starting address of the row.

• nvm_status_t CONFIGURATION_RowWrite (configuration_address_t address, configuration_data_t *dataBuffer)

  Writes all the Configuration Words. The size of the buffer must be one Configuration row/sector and the address must be aligned with the row boundary (the first Configuration word location). Use FLASH_PageAddressGet() to obtain the starting address of the row.

• void NVM_InterruptEnable (void)

  Enables the NVM interrupt.

• void NVM_InterruptDisable (void)

  Disables the NVM interrupt.

• void NVM_ISR (void)

  NVM Interrupt Service Routine (ISR) function.

• void NVM_CallbackRegister (void(*CallbackHandler)(void))

  Setter function for the NVM interrupt callback.

• #define PROGMEM_PAGE_SIZE (256U)

• #define PROGMEM_SIZE (0x020000U)

• #define BUFFER_RAM_START_ADDRESS (0xD00U)

• #define EEPROM_START_ADDRESS (0x310000U)

• #define EEPROM_SIZE (1024U)

• #define CONFIGURATION_ROW_SIZE (16U)

• #define UNLOCK_KEY_WORD_BYTE_WRITE (0xAA55U)

• #define UNLOCK_KEY_ROW_READ (0x44BBU)

• #define UNLOCK_KEY_ROW_WRITE (0x22DDU)

• #define UNLOCK_KEY_PAGE_ERASE (0x33CCU)

• #define FLASH_ErasePageAddressGet FLASH_PageAddressGet

• #define FLASH_ErasePageOffsetGet FLASH_PageOffsetGet

• typedef uint8_t flash_data_t

  Data type for the Flash data.

• typedef uint24_t flash_address_t

  Data type for the Flash address.

• typedef uint8_t eeprom_data_t

  Data type for the EEPROM data.

• typedef uint24_t eeprom_address_t

  Data type for the EEPROM address.

• typedef uint16_t device_id_data_t

  Data type for the Device ID data.

• typedef uint24_t device_id_address_t

  Data type for the Device ID address.

• typedef uint8_t configuration_data_t

  Data type for the Configurations settings data.

• typedef uint24_t configuration_address_t

  Data type for the Configurations settings address.

• enum nvm_status_t { NVM_OK, NVM_ERROR, NVM_OK, NVM_ERROR }

  Contains the return codes for the NVM driver APIs.

• void NVM_Initialize (void)

  Initializes the NVM driver.

• bool NVM_IsBusy (void)

  Checks if the NVM is busy with the read/write/erase commands.

• nvm_status_t NVM_StatusGet (void)

  Returns the status of the last NVM operation.

• void NVM_StatusClear (void)

  Clears the NVM error status.

• void NVM_UnlockKeySet (uint16_t unlockKey)

  Sets the unlock keys required to perform any erase or write operations on Flash and EEPROM.

• void NVM_UnlockKeyClear (void)

  Clears the previously configured unlock keys.

• flash_data_t FLASH_Read (flash_address_t address)

  Reads a byte from the given address of Flash.

• nvm_status_t FLASH_RowRead (flash_address_t address, flash_data_t *dataBuffer)

  Reads one entire Flash row/sector from the given starting address of the row (the first byte location). The size of the buffer must be one Flash row and the address must be aligned with the row boundary. Use FLASH_PageAddressGet() to obtain the starting address of the row. As this is a non-portable API, it may not be supported by all 8-bit PIC® and AVR® devices.

• nvm_status_t FLASH_Write (flash_address_t address, uint16_t data)

  Writes a word at the given Flash address. As this is a non-portable API, it may not be supported by all 8-bit PIC® and AVR® devices.

• nvm_status_t FLASH_RowWrite (flash_address_t address, flash_data_t *dataBuffer)

  Writes one entire Flash row/sector from the given starting address of the row (the first byte location). The size of the input buffer must be one Flash row and the address must be aligned with the row boundary. Use FLASH_PageAddressGet() to obtain the starting address of the row.

• nvm_status_t FLASH_PageErase (flash_address_t address)

  Erases one Flash page/sector containing the given address.

• flash_address_t FLASH_PageAddressGet (flash_address_t address)

  Returns the starting address of the page/sector (the first byte location) containing the given Flash address.

• uint16_t FLASH_PageOffsetGet (flash_address_t address)

  Returns the offset from the starting address of the page/sector (the first byte location).

• eeprom_data_t EEPROM_Read (eeprom_address_t address)

  Reads one byte from the given EEPROM address.

• void EEPROM_Write (eeprom_address_t address, eeprom_data_t data)

  Writes one byte to the given EEPROM address. The NVM busy status must be checked using the NVM_IsBusy() API to know if the write operation is completed.

• device_id_data_t DeviceID_Read (device_id_address_t address)

  Reads the Device ID.

• configuration_data_t CONFIGURATION_Read (configuration_address_t address)

  Reads one Configuration byte.

• nvm_status_t CONFIGURATION_RowRead (configuration_address_t address, configuration_data_t *dataBuffer)

  Reads all the Configuration Words. The size of the buffer must be one Configuration row/sector and the address must be aligned with the row boundary. Use FLASH_PageAddressGet() to obtain the starting address of the row.

• nvm_status_t CONFIGURATION_RowWrite (configuration_address_t address, configuration_data_t *dataBuffer)

  Writes all the Configuration Words. The size of the buffer must be one Configuration row/sector and the address must be aligned with the row boundary (the first Configuration word location). Use FLASH_PageAddressGet() to obtain the starting address of the row.

• __near static volatile uint8_t unlockKeyLow

• __near static volatile uint8_t unlockKeyHigh

• void NVM_Initialize (void)

  Initializes the NVM driver.

• bool NVM_IsBusy (void)

  Checks if the NVM is busy with the read/write/erase commands.

• nvm_status_t NVM_StatusGet (void)

  Returns the status of the last NVM operation.

• void NVM_StatusClear (void)

  Clears the NVM error status.

• void NVM_UnlockKeySet (uint16_t unlockKey)

  Sets the unlock keys required to perform any erase or write operations on Flash and EEPROM.

• void NVM_UnlockKeyClear (void)

  Clears the previously configured unlock keys.

• flash_data_t FLASH_Read (flash_address_t address)

  Reads a byte from the given address of Flash.

• nvm_status_t FLASH_RowRead (flash_address_t address, flash_data_t *dataBuffer)

  Reads one entire Flash row/sector from the given starting address of the row (the first byte location). The size of the buffer must be one Flash row and the address must be aligned with the row boundary. Use FLASH_PageAddressGet() to obtain the starting address of the row. As this is a non-portable API, it may not be supported by all 8-bit PIC® and AVR® devices.

• nvm_status_t FLASH_Write (flash_address_t address, uint16_t data)

  Writes a word at the given Flash address. As this is a non-portable API, it may not be supported by all 8-bit PIC® and AVR® devices.

• nvm_status_t FLASH_RowWrite (flash_address_t address, flash_data_t *dataBuffer)

  Writes one entire Flash row/sector from the given starting address of the row (the first byte location). The size of the input buffer must be one Flash row and the address must be aligned with the row boundary. Use FLASH_PageAddressGet() to obtain the starting address of the row.

• nvm_status_t FLASH_PageErase (flash_address_t address)

  Erases one Flash page/sector containing the given address.

• flash_address_t FLASH_PageAddressGet (flash_address_t address)

  Returns the starting address of the page/sector (the first byte location) containing the given Flash address.

• uint16_t FLASH_PageOffsetGet (flash_address_t address)

  Returns the offset from the starting address of the page/sector (the first byte location).

• eeprom_data_t EEPROM_Read (eeprom_address_t address)

  Reads one byte from the given EEPROM address.

• void EEPROM_Write (eeprom_address_t address, eeprom_data_t data)

  Writes one byte to the given EEPROM address. The NVM busy status must be checked using the NVM_IsBusy() API to know if the write operation is completed.

• device_id_data_t DeviceID_Read (device_id_address_t address)

  Reads the Device ID.

• configuration_data_t CONFIGURATION_Read (configuration_address_t address)

  Reads one Configuration byte.

• nvm_status_t CONFIGURATION_RowRead (configuration_address_t address, configuration_data_t *dataBuffer)

  Reads all the Configuration Words. The size of the buffer must be one Configuration row/sector and the address must be aligned with the row boundary. Use FLASH_PageAddressGet() to obtain the starting address of the row.

• nvm_status_t CONFIGURATION_RowWrite (configuration_address_t address, configuration_data_t *dataBuffer)

  Writes all the Configuration Words. The size of the buffer must be one Configuration row/sector and the address must be aligned with the row boundary (the first Configuration word location). Use FLASH_PageAddressGet() to obtain the starting address of the row.

• #define PROGMEM_PAGE_SIZE (256U)

• #define PROGMEM_SIZE (0x020000U)

• #define BUFFER_RAM_START_ADDRESS (0xD00U)

• #define EEPROM_START_ADDRESS (0x310000U)

• #define EEPROM_SIZE (1024U)

• #define CONFIGURATION_ROW_SIZE (16U)

• #define UNLOCK_KEY_WORD_BYTE_WRITE (0xAA55U)

• #define UNLOCK_KEY_ROW_READ (0x44BBU)

• #define UNLOCK_KEY_ROW_WRITE (0x22DDU)

• #define UNLOCK_KEY_PAGE_ERASE (0x33CCU)

• #define FLASH_ErasePageAddressGet FLASH_PageAddressGet

• #define FLASH_ErasePageOffsetGet FLASH_PageOffsetGet

• typedef uint8_t flash_data_t

  Data type for the Flash data.

• typedef uint24_t flash_address_t

  Data type for the Flash address.

• typedef uint8_t eeprom_data_t

  Data type for the EEPROM data.

• typedef uint24_t eeprom_address_t

  Data type for the EEPROM address.

• typedef uint16_t device_id_data_t

  Data type for the Device ID data.

• typedef uint24_t device_id_address_t

  Data type for the Device ID address.

• typedef uint8_t configuration_data_t

  Data type for the Configurations settings data.

• typedef uint24_t configuration_address_t

  Data type for the Configurations settings address.

• enum nvm_status_t { NVM_OK, NVM_ERROR, NVM_OK, NVM_ERROR }