ESI EEPROM Emulation support

Introduction

Functions
void	bsp_eeprom_emulation_init (void)
	Initialize the EEPROM cache in volatile RAM. If the non-volatile storage has valid data(read is performed using eeprom_read callback from bsp_params passed during bsp_init), load from there. Otherwise it loads predefined EEPROM in application using default_tiesc_eeprom from bsp_params passed during bsp_init. More...
int32_t	bsp_eeprom_load_esc_registers (PRUICSS_Handle pruIcssHandle, int32_t reload_flag)
	For loading ESC registers from EEPROM during first boot/reload after validating CRC. More...
int32_t	bsp_eeprom_emulation_reload (PRUICSS_Handle pruIcssHandle)
	Perform reload operation after validating EEPROM CRC. More...
void	bsp_eeprom_emulation_command_ack (PRUICSS_Handle pruIcssHandle)
	Perform reload operation after validating EEPROM CRC, Wrapper API for SSC. More...
void	bsp_eeprom_emulation_flush (void)
	Flush the EEPROM cache to non-volatile storage. Write is performed using eeprom_write callback from bsp_params passed during bsp_init. More...
void	bsp_eeprom_emulation_exit (void)
	Call EEPROM flush on exit. More...
uint8_t *	bsp_get_eeprom_cache_base (void)
	Return pointer to volatile EEPROM cache in FWHAL for processing to access the EEPROM. More...
void	bsp_set_eeprom_updated_time (void)
	Set EEPROM update time. More...
uint32_t	bsp_get_eeprom_updated_time (void)
	Get EEPROM Updated time. More...
void	bsp_set_eeprom_update_status (uint8_t status)
	Indicate to FWHAL whether EEPROM is written for flushing to non-volatile storage. Typically called on EEPROM write detection from stack. More...
uint8_t	bsp_get_eeprom_update_status (void)
	Read the EEPROM update status from FWHAL. Typically called from low priority task periodically check EEPROM dirty status for flush. More...

Function Documentation

bsp_eeprom_emulation_init()

void bsp_eeprom_emulation_init

(

void

)

Initialize the EEPROM cache in volatile RAM. If the non-volatile storage has valid data(read is performed using eeprom_read callback from bsp_params passed during bsp_init), load from there. Otherwise it loads predefined EEPROM in application using default_tiesc_eeprom from bsp_params passed during bsp_init.

bsp_eeprom_load_esc_registers()

int32_t bsp_eeprom_load_esc_registers	(	PRUICSS_Handle	pruIcssHandle,
		int32_t	reload_flag
	)

For loading ESC registers from EEPROM during first boot/reload after validating CRC.

Parameters

pruIcssHandle	PRUSS handle
reload_flag	If set reload command is being executed else first boot in progress

Return values

0	On successful load of registers -1: On CRC error

bsp_eeprom_emulation_reload()

int32_t bsp_eeprom_emulation_reload

(

PRUICSS_Handle

pruIcssHandle

)

Perform reload operation after validating EEPROM CRC.

Parameters

pruIcssHandle

PRUSS handle

Return values

0	On successful load of registers -1: On CRC error

bsp_eeprom_emulation_command_ack()

void bsp_eeprom_emulation_command_ack

(

PRUICSS_Handle

pruIcssHandle

)

Perform reload operation after validating EEPROM CRC, Wrapper API for SSC.

Parameters

pruIcssHandle

PRUSS handle

bsp_eeprom_emulation_flush()

void bsp_eeprom_emulation_flush

(

void

)

Flush the EEPROM cache to non-volatile storage. Write is performed using eeprom_write callback from bsp_params passed during bsp_init.

bsp_eeprom_emulation_exit()

void bsp_eeprom_emulation_exit

(

void

)

Call EEPROM flush on exit.

bsp_get_eeprom_cache_base()

uint8_t* bsp_get_eeprom_cache_base

(

void

)

Return pointer to volatile EEPROM cache in FWHAL for processing to access the EEPROM.

Return values

Pointer

to volatile EEPROM cache start to the stack/application for EEPROM access

bsp_set_eeprom_updated_time()

void bsp_set_eeprom_updated_time

(

void

)

Set EEPROM update time.

bsp_get_eeprom_updated_time()

uint32_t bsp_get_eeprom_updated_time

(

void

)

Get EEPROM Updated time.

Return values

EEPROM

updated time

bsp_set_eeprom_update_status()

void bsp_set_eeprom_update_status

(

uint8_t

status

)

Indicate to FWHAL whether EEPROM is written for flushing to non-volatile storage. Typically called on EEPROM write detection from stack.

Parameters

status

Update the FWHAL EEPROM update status.

bsp_get_eeprom_update_status()

uint8_t bsp_get_eeprom_update_status

(

void

)

Read the EEPROM update status from FWHAL. Typically called from low priority task periodically check EEPROM dirty status for flush.

Return values

EEPROM

updated status