NVRAM

Defines the interface for reading and writing any data to the NVRAM. More...

Enumerations
enum	{ WICED_NVRAM_VSID_START = 0x200, WICED_NVRAM_VSID_END = 0x3FFF }
	Defines the first usable NVRAM Volatile Section Identifier. More...
enum	{ WICED_NVRAM_SSID_START = 0x2000, WICED_NVRAM_SSID_END = 0x3FFF }
	Defines the first usable NVRAM Static Section Identifier. More...

Functions
uint16_t	wiced_hal_write_nvram (uint16_t vs_id, uint16_t data_length, uint8_t *p_data, wiced_result_t *p_status)
	Writes the data to NVRAM, Application can write up to 255 bytes in one VS id section. More...
uint16_t	wiced_hal_read_nvram (uint16_t vs_id, uint16_t data_length, uint8_t *p_data, wiced_result_t *p_status)
	Reads the data from NVRAM. More...
void	wiced_hal_delete_nvram (uint16_t vs_id, wiced_result_t *p_status)
	deletes data from NVRAM at specified VS id More...
uint16_t	wiced_hal_read_nvram_static (uint16_t ss_id, uint16_t data_length, void *p_data, wiced_result_t *p_status)
	Reads the static data from NVRAM. More...

Detailed Description

Defines the interface for reading and writing any data to the NVRAM.

Enumeration Type Documentation

anonymous enum

Defines the first usable NVRAM Volatile Section Identifier.

Application can use the VS ids starting from WICED_NVRAM_VSID_START.to WICED_NVRAM_VSID_END Note: Values less than 0x200 reserved for internal purpose and not advisable to use by applications

anonymous enum

Defines the first usable NVRAM Static Section Identifier.

Application can use the SS IDs starting from WICED_NVRAM_SSID_START to WICED_NVRAM_SSID_END Note: Values less than 0x2000 reserved for AIROC internal purpose and not available to use by applications

Function Documentation

void wiced_hal_delete_nvram	(	uint16_t	vs_id,
		wiced_result_t *	p_status
	)

deletes data from NVRAM at specified VS id

Parameters

[in]	vs_id	: Volatile Section Identifier. Application can use the VS ids from WICED_NVRAM_VSID_START to WICED_NVRAM_VSID_END
[out]	p_status	: Pointer to location where status of the call is returned

Returns

void

uint16_t wiced_hal_read_nvram	(	uint16_t	vs_id,
		uint16_t	data_length,
		uint8_t *	p_data,
		wiced_result_t *	p_status
	)

Reads the data from NVRAM.

Parameters

[in]	vs_id	: Volatile Section Identifier. Application can use the VS ids from WICED_NVRAM_VSID_START to WICED_NVRAM_VSID_END
[in]	data_length	: Length of the data to be read from NVRAM
[out]	p_data	: Pointer to the buffer to which data will be copied
[out]	p_status	: Pointer to location where status of the call is returned

Returns

the number of bytes read, 0 on failure

uint16_t wiced_hal_read_nvram_static	(	uint16_t	ss_id,
		uint16_t	data_length,
		void *	p_data,
		wiced_result_t *	p_status
	)

Reads the static data from NVRAM.

Parameters

[in]	ss_id	: Static Section Identifier. Application can use the SS IDs from WICED_NVRAM_SSID_START to WICED_NVRAM_SSID_END
[in]	data_length	: Length of the data to be read from NVRAM
[out]	p_data	: Pointer to the buffer to which data will be copied
[out]	p_status	: Pointer to location where status of the call is returned

Returns

the number of bytes read, 0 on failure

uint16_t wiced_hal_write_nvram	(	uint16_t	vs_id,
		uint16_t	data_length,
		uint8_t *	p_data,
		wiced_result_t *	p_status
	)

Writes the data to NVRAM, Application can write up to 255 bytes in one VS id section.

Parameters

[in]	vs_id	: Volatile Section Identifier. Application can use the VS ids from WICED_NVRAM_VSID_START to WICED_NVRAM_VSID_END
[in]	data_length	: Length of the data to be written to the NVRAM,
[in]	p_data	: Pointer to the data to be written to the NVRAM
[out]	p_status	: Pointer to location where status of the call is returned

Returns

number of bytes written, 0 on error