cfn_sal_utl_kv.h File Reference

Abstract Key-Value (KV) storage service interface. More...

#include "cfn_sal.h"

Go to the source code of this file.

Data Structures
struct	cfn_sal_utl_key_value_config_t
struct	cfn_sal_utl_key_value_api_s
	Key-Value Store Virtual Method Table (VMT). More...

Macros
#define	CFN_SAL_UTL_TYPE_KEY_VALUE   CFN_SAL_TYPE('K', 'V', 'S')

Typedefs
typedef struct cfn_sal_utl_key_value_s	cfn_sal_utl_key_value_t
typedef struct cfn_sal_utl_key_value_api_s	cfn_sal_utl_key_value_api_t
typedef void(*	cfn_sal_utl_key_value_callback_t) (cfn_sal_utl_key_value_t *driver, uint32_t event, uint32_t error, void *user_arg)

Functions
	CFN_HAL_VMT_CHECK (struct cfn_sal_utl_key_value_api_s)
	CFN_SAL_CREATE_DRIVER_TYPE (sal_utl_key_value, cfn_sal_utl_key_value_config_t, cfn_sal_utl_key_value_api_t, cfn_sal_phy_t, cfn_sal_utl_key_value_callback_t)
CFN_HAL_INLINE void	cfn_sal_utl_key_value_populate (cfn_sal_utl_key_value_t *driver, uint32_t peripheral_id, void *dependency, const cfn_sal_utl_key_value_api_t *api, const cfn_sal_phy_t *phy, const cfn_sal_utl_key_value_config_t *config, cfn_sal_utl_key_value_callback_t callback, void *user_arg)
cfn_hal_error_code_t	cfn_sal_utl_key_value_construct (cfn_sal_utl_key_value_t *driver, const cfn_sal_utl_key_value_config_t *config, const cfn_sal_phy_t *phy, void *dependency, cfn_sal_utl_key_value_callback_t callback, void *user_arg)
cfn_hal_error_code_t	cfn_sal_utl_key_value_destruct (cfn_sal_utl_key_value_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_init (cfn_sal_utl_key_value_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_deinit (cfn_sal_utl_key_value_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_config_set (cfn_sal_utl_key_value_t *driver, const cfn_sal_utl_key_value_config_t *config)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_config_get (cfn_sal_utl_key_value_t *driver, cfn_sal_utl_key_value_config_t *config)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_callback_register (cfn_sal_utl_key_value_t *driver, cfn_sal_utl_key_value_callback_t callback, void *user_arg)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_power_state_set (cfn_sal_utl_key_value_t *driver, cfn_hal_power_state_t state)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_event_enable (cfn_sal_utl_key_value_t *driver, uint32_t event_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_event_disable (cfn_sal_utl_key_value_t *driver, uint32_t event_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_event_get (cfn_sal_utl_key_value_t *driver, uint32_t *event_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_error_enable (cfn_sal_utl_key_value_t *driver, uint32_t error_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_error_disable (cfn_sal_utl_key_value_t *driver, uint32_t error_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_error_get (cfn_sal_utl_key_value_t *driver, uint32_t *error_mask)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_set (cfn_sal_utl_key_value_t *driver, const char *key, const void *val, size_t len)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_get (cfn_sal_utl_key_value_t *driver, const char *key, void *val_buf, size_t max_len, size_t *actual_len)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_del (cfn_sal_utl_key_value_t *driver, const char *key)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_clear (cfn_sal_utl_key_value_t *driver)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_sal_utl_key_value_get_info (cfn_sal_utl_key_value_t *driver, size_t *used_bytes, size_t *total_bytes)

Detailed Description

Abstract Key-Value (KV) storage service interface.

Macro Definition Documentation

CFN_SAL_UTL_TYPE_KEY_VALUE

#define CFN_SAL_UTL_TYPE_KEY_VALUE   CFN_SAL_TYPE('K', 'V', 'S')

Typedef Documentation

cfn_sal_utl_key_value_api_t

typedef struct cfn_sal_utl_key_value_api_s cfn_sal_utl_key_value_api_t

cfn_sal_utl_key_value_callback_t

typedef void(* cfn_sal_utl_key_value_callback_t) (cfn_sal_utl_key_value_t *driver, uint32_t event, uint32_t error, void *user_arg)

cfn_sal_utl_key_value_t

typedef struct cfn_sal_utl_key_value_s cfn_sal_utl_key_value_t

Function Documentation

CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK

(

struct cfn_sal_utl_key_value_api_s

)

CFN_SAL_CREATE_DRIVER_TYPE()

CFN_SAL_CREATE_DRIVER_TYPE	(	sal_utl_key_value	,
		cfn_sal_utl_key_value_config_t	,
		cfn_sal_utl_key_value_api_t	,
		cfn_sal_phy_t	,
		cfn_sal_utl_key_value_callback_t
	)

cfn_sal_utl_key_value_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_callback_register	(	cfn_sal_utl_key_value_t *	driver,
		cfn_sal_utl_key_value_callback_t	callback,
		void *	user_arg
	)

cfn_sal_utl_key_value_clear()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_clear

(

cfn_sal_utl_key_value_t *

driver

)

cfn_sal_utl_key_value_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_config_get	(	cfn_sal_utl_key_value_t *	driver,
		cfn_sal_utl_key_value_config_t *	config
	)

cfn_sal_utl_key_value_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_config_set	(	cfn_sal_utl_key_value_t *	driver,
		const cfn_sal_utl_key_value_config_t *	config
	)

cfn_sal_utl_key_value_construct()

cfn_hal_error_code_t cfn_sal_utl_key_value_construct	(	cfn_sal_utl_key_value_t *	driver,
		const cfn_sal_utl_key_value_config_t *	config,
		const cfn_sal_phy_t *	phy,
		void *	dependency,
		cfn_sal_utl_key_value_callback_t	callback,
		void *	user_arg
	)

cfn_sal_utl_key_value_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_deinit

(

cfn_sal_utl_key_value_t *

driver

)

cfn_sal_utl_key_value_del()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_del	(	cfn_sal_utl_key_value_t *	driver,
		const char *	key
	)

cfn_sal_utl_key_value_destruct()

cfn_hal_error_code_t cfn_sal_utl_key_value_destruct

(

cfn_sal_utl_key_value_t *

driver

)

cfn_sal_utl_key_value_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_error_disable	(	cfn_sal_utl_key_value_t *	driver,
		uint32_t	error_mask
	)

cfn_sal_utl_key_value_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_error_enable	(	cfn_sal_utl_key_value_t *	driver,
		uint32_t	error_mask
	)

cfn_sal_utl_key_value_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_error_get	(	cfn_sal_utl_key_value_t *	driver,
		uint32_t *	error_mask
	)

cfn_sal_utl_key_value_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_event_disable	(	cfn_sal_utl_key_value_t *	driver,
		uint32_t	event_mask
	)

cfn_sal_utl_key_value_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_event_enable	(	cfn_sal_utl_key_value_t *	driver,
		uint32_t	event_mask
	)

cfn_sal_utl_key_value_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_event_get	(	cfn_sal_utl_key_value_t *	driver,
		uint32_t *	event_mask
	)

cfn_sal_utl_key_value_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_get	(	cfn_sal_utl_key_value_t *	driver,
		const char *	key,
		void *	val_buf,
		size_t	max_len,
		size_t *	actual_len
	)

cfn_sal_utl_key_value_get_info()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_get_info	(	cfn_sal_utl_key_value_t *	driver,
		size_t *	used_bytes,
		size_t *	total_bytes
	)

cfn_sal_utl_key_value_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_init

(

cfn_sal_utl_key_value_t *

driver

)

cfn_sal_utl_key_value_populate()

CFN_HAL_INLINE void cfn_sal_utl_key_value_populate	(	cfn_sal_utl_key_value_t *	driver,
		uint32_t	peripheral_id,
		void *	dependency,
		const cfn_sal_utl_key_value_api_t *	api,
		const cfn_sal_phy_t *	phy,
		const cfn_sal_utl_key_value_config_t *	config,
		cfn_sal_utl_key_value_callback_t	callback,
		void *	user_arg
	)

cfn_sal_utl_key_value_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_power_state_set	(	cfn_sal_utl_key_value_t *	driver,
		cfn_hal_power_state_t	state
	)

cfn_sal_utl_key_value_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_key_value_set	(	cfn_sal_utl_key_value_t *	driver,
		const char *	key,
		const void *	val,
		size_t	len
	)