EEPROM_EMULATION: EEPROM emulation memory driver

Overview

The MCUXpresso SDK provides a peripheral driver for the eeprom emulation module of MCUXpresso SDK devices.

Typical use case

Refer to the driver examples codes located at <SDK_ROOT>/boards/<BOARD>/driver_examples/eeprom_emulation

Data Structures
struct	eeprom_emulation_config_t
	Eeprom emulation driver state information. More...
struct	eeprom_emulation_handle_t
	Eeprom emulation handle, users should not touch the content of the handle. More...

Driver version
#define	EE_EEPROM_EMULATION_DRIVER_VERSION   (MAKE_VERSION(2, 0, 0))
	EEPROM Emulation driver version. More...

Initialization and deinitialization
void	EE_GetDefaultConfig (eeprom_emulation_config_t *config)
void	EE_SetEepromEmulationInfo (eeprom_emulation_handle_t *handle, eeprom_emulation_config_t *config)
uint32_t	EE_Init (eeprom_emulation_handle_t *handle)
uint32_t	EE_WriteData (eeprom_emulation_handle_t *handle, uint16_t dataID, uint32_t source)
uint32_t	EE_ReadData (eeprom_emulation_handle_t *handle, uint16_t dataID, uint32_t *recordAddr)
uint32_t	EE_ReportStatus (eeprom_emulation_handle_t *handle)
uint32_t	EE_Deinit (eeprom_emulation_handle_t *handle)
uint32_t	EE_Main (eeprom_emulation_handle_t *handle)
uint32_t	EE_NextSector (eeprom_emulation_handle_t *handle, uint32_t addr)
uint32_t	EE_PrevSector (eeprom_emulation_handle_t *handle, uint32_t addr)
uint32_t	EE_VerifyRecordStatus (eeprom_emulation_handle_t *handle, uint32_t dest, uint32_t expData)
uint32_t	EE_VerifySectorHeader (eeprom_emulation_handle_t *handle, uint32_t dest, uint32_t expData)
uint32_t	EE_MultiProgram (eeprom_emulation_handle_t *handle, uint32_t dest, uint32_t size, uint8_t *pData)
uint32_t	EE_CopyRecord (eeprom_emulation_handle_t *handle, eeprom_emulation_data_record_t dataRecord, uint8_t remainData[])
uint32_t	EE_SwapSector (eeprom_emulation_handle_t *handle)
uint32_t	EE_SearchInSector (eeprom_emulation_handle_t *handle, uint16_t expID, uint32_t sectorAddress)
uint32_t	EE_SearchBlankSpace (eeprom_emulation_handle_t *handle, uint32_t sectorAddress)
uint32_t	EE_SearchInAllActives (eeprom_emulation_handle_t *handle, uint16_t dataID)
uint32_t	EE_SearchLoop (eeprom_emulation_handle_t *handle, uint16_t dataID)
uint32_t	EE_BlankCheck (eeprom_emulation_handle_t *handle, uint32_t address, uint32_t size)
uint8_t	EE_GetSectorStatus (eeprom_emulation_handle_t *handle, uint32_t sectorAddress)
uint32_t	EE_FindActSector (eeprom_emulation_handle_t *handle, uint32_t sectorAddress, bool closestFlag, bool nextFlag)
uint8_t	EE_GetSectorNumber (eeprom_emulation_handle_t *handle, uint8_t expStatus)
uint32_t	EE_ValidateDeadIndicator (eeprom_emulation_handle_t *handle, uint32_t sectorAddress)
uint32_t	EE_ValidateEraseCycle (eeprom_emulation_handle_t *handle, uint32_t sectorAddress, uint8_t *pData)
uint32_t	EE_ValidateActIndicator (eeprom_emulation_handle_t *handle, uint32_t sectorAddress)
uint32_t	EE_ReEraseEeprom (eeprom_emulation_handle_t *handle, uint32_t sectorAddress)
uint32_t	EE_CheckAvailabilityStatus (eeprom_emulation_handle_t *handle)
	AT_QUICKACCESS_SECTION_CODE (uint32_t EE_FlashEraseAll(eeprom_emulation_handle_t *handle))
uint32_t	EE_FlashCheckErrorCode (void)
	AT_QUICKACCESS_SECTION_CODE (uint32_t EE_SyncFlashErase(eeprom_emulation_handle_t *handle, uint32_t destination))
	AT_QUICKACCESS_SECTION_CODE (uint32_t EE_FlashEraseVerifySection(eeprom_emulation_handle_t *handle, uint32_t destination, uint16_t Number, uint8_t marginLevel))
	AT_QUICKACCESS_SECTION_CODE (uint32_t EE_SingleProgram(eeprom_emulation_handle_t *handle, uint32_t destination, uint8_t *pData))
void	FLASH_CACHE_Disable (void)

---

Data Structure Documentation

struct eeprom_emulation_config_t

An instance of this structure is allocated by the user of the eeprom emulation driver and passed into each of the driver APIs.

struct eeprom_emulation_handle_t

Macro Definition Documentation

#define EE_EEPROM_EMULATION_DRIVER_VERSION   (MAKE_VERSION(2, 0, 0))