wiced_resource.h File Reference

Data Structures
struct	filesystem_resource_handle_t
struct	memory_resource_handle_t
struct	resource_hnd_t

Macros
#define	RESOURCE_RESULT_LIST(prefix)

Enumerations
enum	resource_location_t { RESOURCE_IN_MEMORY , RESOURCE_IN_FILESYSTEM , RESOURCE_IN_EXTERNAL_STORAGE }
enum	resource_result_t

Functions
resource_result_t	resource_free_readonly_buffer (const resource_hnd_t *handle, const void *buffer)
resource_result_t	resource_get_readonly_buffer (const resource_hnd_t *resource, uint32_t offset, uint32_t maxsize, uint32_t *size_out, const void **buffer)
resource_result_t	resource_read (const resource_hnd_t *resource, uint32_t offset, uint32_t maxsize, uint32_t *size, void *buffer)

Detailed Description

WICED Resource API's The Resource Management functions reads resource from a resource location and returns the number of bytes from an offset in an caller filled buffer.

Functions to get the resource size and resource data

The Resource could be one of the three locations

• Wiced Filesystem (File System)
• Internal Memory (Embedded Flash memory)
• External Storage ( External Flash connected via SPI interface)

Macro Definition Documentation

RESOURCE_RESULT_LIST

#define RESOURCE_RESULT_LIST

(

prefix

)

Value:

    RESULT_ENUM(  prefix, SUCCESS,                         0 ),                              \
    RESULT_ENUM(  prefix, UNSUPPORTED,                     7 ),                 \
    RESULT_ENUM(  prefix, OUT_OF_HEAP_SPACE,               8 ),       \
    RESULT_ENUM(  prefix, OFFSET_TOO_BIG,               4001 ),          \
    RESULT_ENUM(  prefix, FILE_OPEN_FAIL,               4002 ),         \
    RESULT_ENUM(  prefix, FILE_SEEK_FAIL,               4003 ),    \
    RESULT_ENUM(  prefix, FILE_READ_FAIL,               4004 ),

Failed to read resource file

Enumeration Type Documentation

resource_location_t

enum resource_location_t

Enumerator
RESOURCE_IN_MEMORY	resource location in memory
RESOURCE_IN_FILESYSTEM	resource location in filesystem
RESOURCE_IN_EXTERNAL_STORAGE	resource location in external storage

resource_result_t

enum resource_result_t

Result type for WICED Resource function