Infineon Logo AIROC BTSDK v4.6 - Documentation
 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages

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

Macros

#define WICED_NVRAM_VSID_START   0x01
 Defines the first usable NVRAM Volatile Section Identifier. More...
 
#define WICED_NVRAM_VSID_END   0x75
 Defines the last usable NVRAM Volatile Section Identifier. More...
 
#define wiced_hal_write_nvram   wiced_hal_write_nvram_patch
 Writes the data to NVRAM, Application can write up to 255 bytes in one VS id section. More...
 

Functions

uint8_t wiced_hal_write_nvram_patch (uint8_t vs_id, uint8_t data_length, uint8_t *p_data, wiced_result_t *p_status)
 
uint8_t wiced_hal_read_nvram (uint8_t vs_id, uint8_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)
 Delete the data from NVRAM. More...
 

Detailed Description

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

Macro Definition Documentation

#define wiced_hal_write_nvram   wiced_hal_write_nvram_patch

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, Application can only write up to 255 bytes
[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
#define WICED_NVRAM_VSID_END   0x75

Defines the last usable NVRAM Volatile Section Identifier.

Application can use the VS ids starting from WICED_NVRAM_VSID_START to WICED_NVRAM_VSID_END

#define WICED_NVRAM_VSID_START   0x01

Defines the first usable NVRAM Volatile Section Identifier.

Application can use the VS ids starting from WICED_NVRAM_VSID_START.

Function Documentation

void wiced_hal_delete_nvram ( uint16_t  vs_id,
wiced_result_t p_status 
)

Delete 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
[out]p_status: Pointer to location where status of the call is returned
uint8_t wiced_hal_read_nvram ( uint8_t  vs_id,
uint8_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