MAP PERSISTANT_W (rm_map_persistant_w)

Functions
fsp_err_t	RM_MAP_PERSISTANT_W_Open (map_persistant_w_ctrl_t *const p_api_ctrl)
fsp_err_t	RM_MAP_PERSISTANT_W_Close (map_persistant_w_ctrl_t *const p_api_ctrl)
fsp_err_t	RM_MAP_PERSISTANT_W_Read_UINT (map_persistant_w_ctrl_t *const p_api_ctrl, const char *group, const char *name, void *value, uint16_t *data_length)
fsp_err_t	RM_MAP_PERSISTANT_W_Write_UINT (map_persistant_w_ctrl_t *const p_api_ctrl, const char *group, const char *name, void *value, uint32_t len)
fsp_err_t	RM_MAP_PERSISTANT_W_Read_INT (map_persistant_w_ctrl_t *const p_api_ctrl, const char *group, const char *name, int *val)
fsp_err_t	RM_MAP_PERSISTANT_W_Write_INT (map_persistant_w_ctrl_t *const p_api_ctrl, const char *group, const char *name, int value)
fsp_err_t	RM_MAP_PERSISTANT_W_Read_STRING (map_persistant_w_ctrl_t *const p_api_ctrl, const char *group, const char *name, char **val)
fsp_err_t	RM_MAP_PERSISTANT_W_Write_STRING (map_persistant_w_ctrl_t *const p_api_ctrl, const char *group, const char *name, const char *value)
fsp_err_t	RM_MAP_PERSISTANT_W_Write_Auto (map_persistant_w_ctrl_t *const p_api_ctrl, const char *group, const char *name, const char *value)
fsp_err_t	RM_MAP_PERSISTANT_W_Erase (map_persistant_w_ctrl_t *const p_api_ctrl, const char *group, const char *name)
fsp_err_t	RM_MAP_PERSISTANT_W_Erase_GROUP (map_persistant_w_ctrl_t *const p_api_ctrl, const char *group)
fsp_err_t	RM_MAP_PERSISTANT_W_reflash (map_persistant_w_ctrl_t *const p_api_ctrl)
fsp_err_t	RM_MAP_PERSISTANT_W_Display (map_persistant_w_ctrl_t *const p_api_ctrl, const char *groupname, int printall)
fsp_err_t	RM_MAP_PERSISTANT_W_Read_Auto (map_persistant_w_ctrl_t *const p_api_ctrl, const char *groupname, const char *envname, int8_t *data_length, uint8_t **data_ptr)
fsp_err_t	RM_MAP_PERSISTANT_W_Write_BIN (map_persistant_w_ctrl_t *const p_api_ctrl, const char *group, uint32_t id_offset, uint8_t *value)
fsp_err_t	RM_MAP_PERSISTANT_W_Read_BIN (map_persistant_w_ctrl_t *const p_api_ctrl, const char *group, uint32_t id_offset, uint8_t **value)

Detailed Description

Middleware to implement READ/WRITE/ERASE from Persistant storage. This module implements the RM_MAP_PERSISTANT_W Interface.

Overview

RM_MAP_PERSISTANT_W module will implement the API's to READ/WRITE/ERASE to persistant storage using the MAP data structure.

Features

The RM_MAP_PERSISTANT_W module have the following key features:

• Writing, reading, erasing user defined records of any length to data flash.
• Reference data such as calibration data programmed at assembly or test time is preserved.
• Reference data can be updated at run time.
• Fault resilient design.

Usage Notes

• Use the RM_MAP_PERSISTANT_W api's to read/write/erase from persistant storage.

Limitations

None.

Data Structures
struct	map_persistant_w_instance_ctrl_t

Macros
#define	MAP_PERSISTANT_W_OPEN

---

Data Structure Documentation

map_persistant_w_instance_ctrl_t

struct map_persistant_w_instance_ctrl_t

RM_MAP_PERSISTANT_W private control block. DO NOT MODIFY.

Data Fields
uint32_t	map_persistant_w_open	Indicates whether the open() API has been successfully called.
SemaphoreHandle_t	map_persistant_w_mutex	Semaphore to handle synchronization.

Macro Definition Documentation

MAP_PERSISTANT_W_OPEN

#define MAP_PERSISTANT_W_OPEN

"MAP" in ASCII, used to determine if the RM_MAP_PERSISTANT_W is open.

Function Documentation

RM_MAP_PERSISTANT_W_Open()

fsp_err_t RM_MAP_PERSISTANT_W_Open

(

map_persistant_w_ctrl_t *const

p_api_ctrl

)

Perform any necessary initialization for RM_MAP_PERSISTANT_W

Return values

FSP_SUCCESS	RM_MAP_PERSISTANT_W instance opened
FSP_ERR_ALREADY_OPEN	RM_MAP_PERSISTANT_W instance is already open

RM_MAP_PERSISTANT_W_Close()

fsp_err_t RM_MAP_PERSISTANT_W_Close

(

map_persistant_w_ctrl_t *const

p_api_ctrl

)

Close the MAP_PERSISTANT_W Instance

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet

RM_MAP_PERSISTANT_W_Read_UINT()

fsp_err_t RM_MAP_PERSISTANT_W_Read_UINT	(	map_persistant_w_ctrl_t *const	p_api_ctrl,
		const char *	group,
		const char *	name,
		void *	value,
		uint16_t *	data_length
	)

Read unsigned int from the MAP PERSISTANT_W storage

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet

RM_MAP_PERSISTANT_W_Write_UINT()

fsp_err_t RM_MAP_PERSISTANT_W_Write_UINT	(	map_persistant_w_ctrl_t *const	p_api_ctrl,
		const char *	group,
		const char *	name,
		void *	value,
		uint32_t	len
	)

Write unsigned int to MAP PERSISTANT_W Storage

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet

RM_MAP_PERSISTANT_W_Read_INT()

fsp_err_t RM_MAP_PERSISTANT_W_Read_INT	(	map_persistant_w_ctrl_t *const	p_api_ctrl,
		const char *	group,
		const char *	name,
		int *	val
	)

Read the Integer from the MAP PERSISTANT_W Storage

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet

RM_MAP_PERSISTANT_W_Write_INT()

fsp_err_t RM_MAP_PERSISTANT_W_Write_INT	(	map_persistant_w_ctrl_t *const	p_api_ctrl,
		const char *	group,
		const char *	name,
		int	value
	)

Write Integer to the MAP PERSISTANT_W Storage

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet

RM_MAP_PERSISTANT_W_Read_STRING()

fsp_err_t RM_MAP_PERSISTANT_W_Read_STRING	(	map_persistant_w_ctrl_t *const	p_api_ctrl,
		const char *	group,
		const char *	name,
		char **	val
	)

Read the string from the MAP PERSISTANT_W Storage

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet

RM_MAP_PERSISTANT_W_Write_STRING()

fsp_err_t RM_MAP_PERSISTANT_W_Write_STRING	(	map_persistant_w_ctrl_t *const	p_api_ctrl,
		const char *	group,
		const char *	name,
		const char *	value
	)

Write String to the MAP PERSISTANT_W Storage

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet

RM_MAP_PERSISTANT_W_Write_Auto()

fsp_err_t RM_MAP_PERSISTANT_W_Write_Auto	(	map_persistant_w_ctrl_t *const	p_api_ctrl,
		const char *	group,
		const char *	name,
		const char *	value
	)

Write String or int to the MAP PERSISTANT_W Storage

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet

RM_MAP_PERSISTANT_W_Erase()

fsp_err_t RM_MAP_PERSISTANT_W_Erase	(	map_persistant_w_ctrl_t *const	p_api_ctrl,
		const char *	group,
		const char *	name
	)

Erase the entry from MAP PERSISTANT_W Storage

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet

RM_MAP_PERSISTANT_W_Erase_GROUP()

fsp_err_t RM_MAP_PERSISTANT_W_Erase_GROUP	(	map_persistant_w_ctrl_t *const	p_api_ctrl,
		const char *	group
	)

Erase particular group entries from the MAP PERSISTANT_W Storage

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet

RM_MAP_PERSISTANT_W_reflash()

fsp_err_t RM_MAP_PERSISTANT_W_reflash

(

map_persistant_w_ctrl_t *const

p_api_ctrl

)

Reflash the MAP PERSISTANT_W Storage

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet

RM_MAP_PERSISTANT_W_Display()

fsp_err_t RM_MAP_PERSISTANT_W_Display	(	map_persistant_w_ctrl_t *const	p_api_ctrl,
		const char *	groupname,
		int	printall
	)

Display the MAP PERSISTANT_W Storage

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet

RM_MAP_PERSISTANT_W_Read_Auto()

fsp_err_t RM_MAP_PERSISTANT_W_Read_Auto	(	map_persistant_w_ctrl_t *const	p_api_ctrl,
		const char *	groupname,
		const char *	envname,
		int8_t *	data_length,
		uint8_t **	data_ptr
	)

Auto the MAP_PERSISTANT_W Instance

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet

RM_MAP_PERSISTANT_W_Write_BIN()

fsp_err_t RM_MAP_PERSISTANT_W_Write_BIN	(	map_persistant_w_ctrl_t *const	p_api_ctrl,
		const char *	group,
		uint32_t	id_offset,
		uint8_t *	value
	)

Write BINARY with index offset to the MAP PERSISTANT_W Storage

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet

RM_MAP_PERSISTANT_W_Read_BIN()

fsp_err_t RM_MAP_PERSISTANT_W_Read_BIN	(	map_persistant_w_ctrl_t *const	p_api_ctrl,
		const char *	group,
		uint32_t	id_offset,
		uint8_t **	value
	)

Read BINARY with index offset to the MAP PERSISTANT_W Storage

Return values

FSP_SUCCESS	MAP_PERSISTANT_W driver closed
FSP_ERR_ASSERTION	Null Pointer
FSP_ERR_NOT_OPEN	MAP_PERSISTANT_W instance is not open yet