1.5.14.11 NVMCTRL_DATA_FLASH_RowErase Function

C

bool NVMCTRL_DATA_FLASH_RowErase( uint32_t address)

Summary

Erases a Row in the DATA_FLASH.

Description

This function will erase one row in DATA_FLASH. The address of the row to be erased is specified by the address parameter. This address can be any address in the row. Unlike the NVMCTRL_RowErase() function, calling this function will not cause the CPU execution to stall. If the interrupt operation was enabled and if a callback was registered, then the callback function will be called. The NVMCTRL_IsBusy() function can be used to poll for completion of the operation.

The application should ensure that there are no other operations in progress before calling this function. This function is blocking if the library was generated (in MHC) with the interrupt option disabled. If blocking, the function will exit only after write operation has completed.

This function is not blocking if the library was generated with the interrupt option enabled. In this mode, the function initiates the operation and then exits. The application can either register a callback function or call the NVMCTRL_IsBusy() function periodically to check for completion of the operation. Once the operation is complete, the NVMCTRL_ErrorGet() function can be called to check operation success. Erasing a row will erase all the contents of all the pages in the row.

Precondition

The NVMCTRL_Initialize() function should have been called once. Also validate if NVM controller is ready to accept new request by calling NVMCTRL_IsBusy(). The size of the DATA_FLASH memory should have been configured in the NVM User Configuration.

Parameters

Returns

Always returns true.

Example

// This code snippet shows how the NVMCTRL_DATA_FLASH_RowErase function is
// called to erase the row at locatioin SOME_DATA_FLASH_ROW.

NVMCTRL_Initialize();

// Erase the row. This will erase all the pages in the row.
NVMCTRL_DATA_FLASH_RowErase(SOME_DATA_FLASH_ROW);
while(NVMCTRL_IsBusy());

if(NVMCTRL_ErrorGet() == NVMCTRL_ERROR_NONE)
{
    // Operation was successful.
}

Remarks

None.