wiced_hal_nvram.h File Reference

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

Macros
#define	wiced_hal_write_nvram(vs_id, data_length, p_data, p_status)   wiced_platform_nvram_write(vs_id, data_length, p_data, p_status)
	Writes the data to NVRAM, Application can write up to 255 bytes in one VS id section. More...
#define	wiced_hal_read_nvram(vs_id, data_length, p_data, p_status)   wiced_platform_nvram_read(vs_id, data_length, p_data, p_status)
	Reads the data from NVRAM. More...
#define	wiced_hal_delete_nvram(vs_id, p_status)   wiced_platform_nvram_delete(vs_id, p_status)
	deletes data from NVRAM at specified VS id More...

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

Functions
void	wiced_platform_nvram_delete (uint16_t vs_id, wiced_result_t *p_status)
uint16_t	wiced_platform_nvram_read (uint16_t vs_id, uint16_t data_length, uint8_t *p_data, wiced_result_t *p_status)
uint16_t	wiced_platform_nvram_write (uint16_t vs_id, uint16_t data_length, uint8_t *p_data, wiced_result_t *p_status)

Detailed Description

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

Macro Definition Documentation

#define wiced_hal_delete_nvram	(		vs_id,
			p_status
	)		wiced_platform_nvram_delete(vs_id, 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

#define wiced_hal_read_nvram	(		vs_id,
			data_length,
			p_data,
			p_status
	)		wiced_platform_nvram_read(vs_id, data_length, p_data, 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

#define wiced_hal_write_nvram	(		vs_id,
			data_length,
			p_data,
			p_status
	)		wiced_platform_nvram_write(vs_id, data_length, p_data, 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

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 AIROC internal purpose and not advisable to use by applications