RM_MAP_PERSISTANT_W Interface

Detailed Description

Interface for accessing MAP_PERSISTANT_W Storage.

Summary

This section defines the API for the MAP_PERSISTANT_W (Storage) Module. The MAP_PERSISTANT_W Module provides interface to control, access, write to persistant storage .

Data Structures
struct	map_persistant_w_api_t
struct	map_persistant_w_instance_t

Typedefs
typedef void	map_persistant_w_ctrl_t

---

Data Structure Documentation

map_persistant_w_api_t

struct map_persistant_w_api_t

MAP_PERSISTANT_W driver structure. General MAP_PERSISTANT_W functions implemented at the HAL layer will follow this API.

Data Fields
fsp_err_t(*	open )(map_persistant_w_ctrl_t *const p_ctrl)
fsp_err_t(*	close )(map_persistant_w_ctrl_t *const p_ctrl)
fsp_err_t(*	read_uint )(map_persistant_w_ctrl_t *const p_ctrl, const char *group, const char *name, void *val, uint16_t *data_length)
fsp_err_t(*	write_uint )(map_persistant_w_ctrl_t *const p_ctrl, const char *group, const char *name, void *val, uint32_t len)
fsp_err_t(*	read_int )(map_persistant_w_ctrl_t *const p_ctrl, const char *group, const char *name, int *val)
fsp_err_t(*	write_int )(map_persistant_w_ctrl_t *const p_ctrl, const char *group, const char *name, int val)
fsp_err_t(*	read_string )(map_persistant_w_ctrl_t *const p_ctrl, const char *group, const char *name, char **val)
fsp_err_t(*	write_string )(map_persistant_w_ctrl_t *const p_ctrl, const char *group, const char *name, const char *val)
fsp_err_t(*	erase )(map_persistant_w_ctrl_t *const p_ctrl, const char *group, const char *name)
fsp_err_t(*	erase_group )(map_persistant_w_ctrl_t *const p_ctrl, const char *group)

Field Documentation

open

fsp_err_t(* map_persistant_w_api_t::open) (map_persistant_w_ctrl_t *const p_ctrl)

Open the MAP module. Add constraint for RAM

Parameters

[in]

p_ctrl

Pointer to MAP handle.

close

fsp_err_t(* map_persistant_w_api_t::close) (map_persistant_w_ctrl_t *const p_ctrl)

Close the MAP module.

Parameters

[in]

p_ctrl

Pointer to MAP device handle

Return values

FSP_SUCCESS

Configuration was successful.

read_uint

fsp_err_t(* map_persistant_w_api_t::read_uint) (map_persistant_w_ctrl_t *const p_ctrl, const char *group, const char *name, void *val, uint16_t *data_length)

Close the MAP module.

Parameters

[in]	p_ctrl	Pointer to MAP device handle
[in]	group	Group of the variable
[in]	name	Name of the variable
[in,out]	val	Updates the return value

Return values

FSP_SUCCESS

Configuration was successful.

write_uint

fsp_err_t(* map_persistant_w_api_t::write_uint) (map_persistant_w_ctrl_t *const p_ctrl, const char *group, const char *name, void *val, uint32_t len)

Close the MAP module.

Parameters

[in]	p_ctrl	Pointer to MAP device handle
[in]	group	Group of the variable
[in]	name	Name of the variable
[in]	val	Value to be updated

Return values

FSP_SUCCESS

Configuration was successful.

read_int

fsp_err_t(* map_persistant_w_api_t::read_int) (map_persistant_w_ctrl_t *const p_ctrl, const char *group, const char *name, int *val)

Close the MAP module.

Parameters

[in]	p_ctrl	Pointer to MAP device handle
[in]	group	Group of the variable
[in]	name	Name of the variable
[in,out]	val	Updates the return value

Return values

FSP_SUCCESS

Configuration was successful.

write_int

fsp_err_t(* map_persistant_w_api_t::write_int) (map_persistant_w_ctrl_t *const p_ctrl, const char *group, const char *name, int val)

Close the MAP module.

Parameters

[in]	p_ctrl	Pointer to MAP device handle
[in]	group	Group of the variable
[in]	name	Name of the variable
[in]	val	Value to be updated

Return values

FSP_SUCCESS

Configuration was successful.

read_string

fsp_err_t(* map_persistant_w_api_t::read_string) (map_persistant_w_ctrl_t *const p_ctrl, const char *group, const char *name, char **val)

Close the MAP module.

Parameters

[in]	p_ctrl	Pointer to MAP device handle
[in]	group	Group of the variable
[in]	name	Name of the variable

Return values

FSP_SUCCESS

Configuration was successful.

write_string

fsp_err_t(* map_persistant_w_api_t::write_string) (map_persistant_w_ctrl_t *const p_ctrl, const char *group, const char *name, const char *val)

Close the MAP module.

Parameters

[in]	p_ctrl	Pointer to MAP device handle
[in]	group	Group of the variable
[in]	name	Name of the variable
[in]	val	Value to be updated

Return values

FSP_SUCCESS

Configuration was successful.

erase

fsp_err_t(* map_persistant_w_api_t::erase) (map_persistant_w_ctrl_t *const p_ctrl, const char *group, const char *name)

Close the MAP module.

Parameters

[in]	p_ctrl	Pointer to MAP device handle
[in]	group	Group of the variable
[in]	name	Name of the variable

Return values

FSP_SUCCESS

Configuration was successful.

erase_group

fsp_err_t(* map_persistant_w_api_t::erase_group) (map_persistant_w_ctrl_t *const p_ctrl, const char *group)

Close the MAP module.

Parameters

[in]	p_ctrl	Pointer to MAP device handle
[in]	group	Group of the variable

Return values

FSP_SUCCESS

Configuration was successful.

map_persistant_w_instance_t

struct map_persistant_w_instance_t

This structure encompasses everything that is needed to use an instance of this interface.

Data Fields
map_persistant_w_ctrl_t *	p_ctrl	Pointer to the control structure for this instance.
map_persistant_w_cfg_t const *const	p_cfg	Pointer to the configuration structure for this instance.
map_persistant_w_api_t const *const	p_api	Pointer to the API structure for this instance.

Typedef Documentation

map_persistant_w_ctrl_t

typedef void map_persistant_w_ctrl_t

MAP control block. Allocate an instance specific control block to pass into the MAP API calls.