Initialization & configuration

Functions
wiced_result_t	wiced_configure_device (const configuration_entry_t *config)
wiced_result_t	wiced_core_deinit (void)
wiced_result_t	wiced_core_init (void)
wiced_result_t	wiced_deinit (void)
wiced_result_t	wiced_disable_powersave (void)
wiced_result_t	wiced_enable_powersave (void)
wiced_result_t	wiced_init (void)
wiced_result_t	wiced_network_deinit (void)
wiced_result_t	wiced_network_init (void)
wiced_result_t	wiced_reconfigure_device (const configuration_entry_t *config)

Detailed Description

Initialization/De-initialization of WICED and device configuration functions and Initialization/De-initialization of WICED Network Interface

Functions to initialize WICED in a more modular way. wiced_init() = wiced_core_init() + wiced_wlan_connectivity_init() wiced_deinit() = wiced_core_deinit() + wiced_wlan_connectivity_deinit()

Function Documentation

wiced_configure_device()

wiced_result_t wiced_configure_device ( const configuration_entry_t * config )

extern

Runs device configuration (if required)

Parameters

[in]

config

: An array of user configurable variables in configuration_entry_t format. The array must be terminated with a "null" entry {0,0,0,0}

Returns

wiced_result_t WICED_SUCCESS : on success. WICED_ERROR : if an error occurred

wiced_core_deinit()

wiced_result_t wiced_core_deinit

(

void

)

De-initializes the core parts of WICED without touching any WLAN systems

Note

: WLAN should be already de-inited when this function is called

Parameters

[in]

void

Returns

wiced_result_t WICED_SUCCESS : on success. WICED_ERROR : if an error occurred

wiced_core_init()

wiced_result_t wiced_core_init

(

void

)

Initializes the core parts of WICED without starting any WLAN systems

Parameters

[in]

void

Returns

wiced_result_t WICED_SUCCESS : on success. WICED_ERROR : if an error occurred

wiced_deinit()

wiced_result_t wiced_deinit ( void )

extern

De-initializes the WICED system

This function de-initializes the WICED system by :

• bringing down all network interfaces
• deleting all packet pools
• tearing down the event thread
• powering down the WLAN chip

Parameters

[in]

void

Returns

wiced_result_t WICED_SUCCESS : on success. WICED_ERROR : if an error occurred

wiced_disable_powersave()

wiced_result_t wiced_disable_powersave ( void )

extern

Disables all power-save features

This is a convenience functions that calls each of the power-save related functions listed below
Please review the documentation for each function for further information

• wiced_platform_mcu_disable_powersave()
• wiced_wifi_disable_powersave()
• wiced_network_resume()

Parameters

[in]

void

Returns

wiced_result_t WICED_SUCCESS : on success. WICED_ERROR : if an error occurred

wiced_enable_powersave()

wiced_result_t wiced_enable_powersave ( void )

extern

Enables all power-save features

This is a convenience function that calls each of the power-save related functions listed below
Please review the documentation for each function for further information

• wiced_platform_mcu_enable_powersave()
• wiced_wifi_enable_powersave()
• wiced_network_suspend()

Parameters

[in]

void

Returns

wiced_result_t WICED_SUCCESS : on success. WICED_ERROR : if an error occurred

wiced_init()

wiced_result_t wiced_init ( void )

extern

Initializes the WICED system

This function sets up the system by :

• initializing the platform interface
• initializing the RTOS & Network Stack
• initializing the WLAN driver and chip
• starting the event processing thread

Parameters

[in]

void

Returns

wiced_result_t WICED_SUCCESS : on success. WICED_ERROR : if an error occurred

wiced_network_deinit()

wiced_result_t wiced_network_deinit ( void )

extern

De-initializes network sub-system only

Parameters

[in]

void

Returns

wiced_result_t WICED_SUCCESS : on success. WICED_ERROR : if an error occurred

wiced_network_init()

wiced_result_t wiced_network_init ( void )

extern

Initializes network sub-system only

Parameters

[in]

void

Returns

wiced_result_t WICED_SUCCESS : on success. WICED_ERROR : if an error occurred

wiced_reconfigure_device()

wiced_result_t wiced_reconfigure_device ( const configuration_entry_t * config )

extern

Re-runs device configuration

Parameters

[in]

config

: An array of user configurable variables in configuration_entry_t format. The array must be terminated with a "null" entry {0,0,0,0}

Returns

wiced_result_t WICED_SUCCESS : on success. WICED_ERROR : if an error occurred