Functions
void	wiced_deep_sleep_disable_packet_buffering (void)

wiced_bool_t	wiced_deep_sleep_is_networking_idle (wiced_interface_t interface)

wiced_bool_t	wiced_deep_sleep_save_packet (wiced_buffer_t buffer, wwd_interface_t interface)

void	wiced_deep_sleep_set_networking_ready (void)

wiced_result_t	wiced_get_default_ready_interface (wiced_interface_t *interface)

wiced_interface_t	wiced_get_interface (void)

wiced_result_t	wiced_network_create_packet_pool (uint8_t *memory_pointer, uint32_t memory_size, wiced_network_packet_dir_t direction)

wiced_result_t	wiced_network_deregister_link_callback (wiced_network_link_callback_t link_up_callback, wiced_network_link_callback_t link_down_callback, wiced_interface_t interface)

wiced_result_t	wiced_network_down (wiced_interface_t interface)

wiced_result_t	wiced_network_get_clients_ip_address_list (void *ip_address_list)

wiced_result_t	wiced_network_get_hostname (wiced_hostname_t *name)

wiced_bool_t	wiced_network_is_ip_up (wiced_interface_t interface)

wiced_bool_t	wiced_network_is_up (wiced_interface_t interface)

wiced_result_t	wiced_network_register_link_callback (wiced_network_link_callback_t link_up_callback, void link_up_user_data, wiced_network_link_callback_t link_down_callback, void link_down_user_data, wiced_interface_t interface)

wiced_result_t	wiced_network_resume (void)

wiced_result_t	wiced_network_resume_after_deep_sleep (wiced_interface_t interface, wiced_network_config_t config, const wiced_ip_setting_t *ip_settings)

wiced_result_t	wiced_network_set_hostname (const char *name)

wiced_result_t	wiced_network_suspend (void)

wiced_result_t	wiced_network_up (wiced_interface_t interface, wiced_network_config_t config, const wiced_ip_setting_t *ip_settings)

wiced_result_t	wiced_network_up_default (wiced_interface_t interface, const wiced_ip_setting_t ap_ip_settings)

wiced_result_t	wiced_set_interface (wiced_interface_t interface)

Detailed Description

Functions to manage the network interfaces

Function Documentation

void wiced_deep_sleep_disable_packet_buffering ( void )

Turn off deep sleep packet buffering. This is done on warm-boot to allow DHCP packets up the stack without replaying all buffered traffic.

Note: Currently this is implemented for 4390x platforms only.

Returns

wiced_bool_t wiced_deep_sleep_is_networking_idle ( wiced_interface_t interface )

Check whether there are packets pending before going to deep sleep

Note: Currently this is implemented for 4390x platforms only.

Parameters

[in] interface : The network interface (AP or STA) to be checked for pending packets

Returns: WICED_FALSE if any packets pending, otherwise WICED_TRUE *

wiced_bool_t wiced_deep_sleep_save_packet	(	wiced_buffer_t	buffer,
		wwd_interface_t	interface
	)

Save packets before going into deep sleep.

Note: Currently this is implemented for 4390x platforms only.

Parameters

[in]	buffer	: Pointer to the packet buffer to be saved.
[in]	interface	: The network interface (AP or STA) to which the specified packet belongs.

Returns: WICED_TRUE if the packet buffer is successfully saved, otherwise WICED_FALSE *

void wiced_deep_sleep_set_networking_ready ( void )

Notify application that network interface is ready and push all saved packets up to stack.

Note: Currently this is implemented for 4390x platforms only.

Returns: void

wiced_result_t wiced_get_default_ready_interface ( wiced_interface_t * interface )

Returns the default ready interface

Parameters

[out] interface : Pointer to variable for returning the default ready interface.

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

wiced_interface_t wiced_get_interface ( void )

Returns the currently active interface for iperf application

Returns: wiced_result_t

wiced_result_t wiced_network_create_packet_pool	(	uint8_t *	memory_pointer,
		uint32_t	memory_size,
		wiced_network_packet_dir_t	direction
	)

Creates a network packet pool from a chunk of memory

Parameters

[in]	memory_pointer	: Pointer to a chunk of memory
[in]	memory_size	: Size of the memory chunk
[in]	direction	: Network packet reception or transmission

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

wiced_result_t wiced_network_deregister_link_callback	(	wiced_network_link_callback_t	link_up_callback,
		wiced_network_link_callback_t	link_down_callback,
		wiced_interface_t	interface
	)

De-register network link status callback function/s

Parameters

[in]	link_up_callback	: the optional callback function to deregister for the link up event
[in]	link_down_callback	: the optional callback function to deregister for the link down event
[in]	interface	: The interface to use for de-registering the callbacks.

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

wiced_result_t wiced_network_down ( wiced_interface_t interface )

Brings down a network interface

Parameters

[in] interface : The interface to bring down

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

wiced_result_t wiced_network_get_clients_ip_address_list ( void * ip_address_list )

Fetches list of IP-addresses of associated clients.

Parameters

[in] ip_address_list : the list to be filled with IP-addresses of associated clients.

Returns: wiced_result_t

wiced_result_t wiced_network_get_hostname ( wiced_hostname_t * name )

Get network hostname from DCT

Parameters

[in] name : A pointer to a wiced_hostname_t object to store the hostname

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

wiced_bool_t wiced_network_is_ip_up ( wiced_interface_t interface )

Checks if a network interface is up at the IP layer

Parameters

[in] interface : The interface to check

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

wiced_bool_t wiced_network_is_up ( wiced_interface_t interface )

Checks if a network interface is up at the 802.11 link layer

Parameters

[in] interface : The interface to check

Returns: wiced_bool_t

wiced_result_t wiced_network_register_link_callback	(	wiced_network_link_callback_t	link_up_callback,
		void *	link_up_user_data,
		wiced_network_link_callback_t	link_down_callback,
		void *	link_down_user_data,
		wiced_interface_t	interface
	)

Register callback function/s that gets called when a change in network link status occurs

Parameters

[in]	link_up_callback	: The optional callback function to register for the link up event
[in]	link_up_user_data	: The user data to be provided in the link up callback function
[in]	link_down_callback	: The optional callback function to register for the link down event
[in]	link_down_user_data	The user data to be provided in the link down callback function
[in]	interface	: The interface to use for registering the callbacks.

Returns: WICED_SUCCESS : on success.; WICED_ERROR : if an error occurred with any step

wiced_result_t wiced_network_resume ( void )

Resumes network services

This function resumes network services after suspension with the wiced_network_suspend() function. After calling this function, all network functions are available for use.

Example usage:

 wiced_network_suspend();
 wiced_rtos_delay_milliseconds(DEEP_SLEEP_TIME);
 wiced_network_resume();

Parameters

[in] void

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

wiced_result_t wiced_network_resume_after_deep_sleep	(	wiced_interface_t	interface,
		wiced_network_config_t	config,
		const wiced_ip_setting_t *	ip_settings
	)

Brings up a network interface after deep-sleep

Parameters

[in]	interface	: The interface to bring up
[in]	config	: The network IP configuration
[in]	ip_settings	: Static IP settings that are mandatory for the AP interface, but are optional for the STA interface

Returns: wiced_result_t

wiced_result_t wiced_network_set_hostname ( const char * name )

Set network hostname in DCT

NOTE: This function will change the DCT.

Parameters

[in] name : A null terminated string (Note: this will be truncated to a maximum of 32 characters)

Returns: wiced_result_t

wiced_result_t wiced_network_suspend ( void )

Suspends network services and disables all network related timers

This function must only be called before entering deep sleep. Prior to calling this function, ensure all network sockets are in a disconnected state. After calling this function, networking functions should not be used. To resume network operation, use the wiced_network_resume() function.

Example usage:

 wiced_network_suspend();
 wiced_rtos_delay_milliseconds(DEEP_SLEEP_TIME);
 wiced_network_resume();

Returns: WICED_SUCCESS : Network services are suspended. WICED_ERROR : Network services were unable to be suspended, active sockets still exist

wiced_result_t wiced_network_up	(	wiced_interface_t	interface,
		wiced_network_config_t	config,
		const wiced_ip_setting_t *	ip_settings
	)

Brings up a network interface

Parameters

[in]	interface	: The interface to bring up
[in]	config	: The network IP configuration
[in]	ip_settings	: Static IP settings that are mandatory for the AP interface, but are optional for the STA interface

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

wiced_result_t wiced_network_up_default	(	wiced_interface_t *	interface,
		const wiced_ip_setting_t *	ap_ip_settings
	)

Reads default network interface from DCT and brings up network

Parameters

[out]		Result from reading DCT is stored in interface
[in]	ip_settings	: Static IP settings that are mandatory for the AP interface, but are not used for the STA or ETHERNET interfaces.

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

wiced_result_t wiced_set_interface ( wiced_interface_t interface )

Sets the currently active interface for iperf application

Parameters

[in] interface : the interface to set

Returns: wiced_result_t