WiFi Power Saving functions

Functions
wiced_result_t	wiced_wifi_disable_powersave (void)
wiced_result_t	wiced_wifi_disable_powersave_interface (wiced_interface_t interface)
wiced_result_t	wiced_wifi_enable_powersave (void)
wiced_result_t	wiced_wifi_enable_powersave_interface (wiced_interface_t interface)
wiced_result_t	wiced_wifi_enable_powersave_with_throughput (uint16_t return_to_sleep_delay_ms)
wiced_result_t	wiced_wifi_enable_powersave_with_throughput_interface (uint16_t return_to_sleep_delay_ms, wiced_interface_t interface)
wwd_result_t	wwd_wifi_disable_powersave (void)
wwd_result_t	wwd_wifi_disable_powersave_interface (wwd_interface_t interface)
wwd_result_t	wwd_wifi_enable_powersave (void)
wwd_result_t	wwd_wifi_enable_powersave_interface (wwd_interface_t interface)
wwd_result_t	wwd_wifi_enable_powersave_with_throughput (uint16_t return_to_sleep_delay)
wwd_result_t	wwd_wifi_enable_powersave_with_throughput_interface (uint16_t return_to_sleep_delay, wwd_interface_t interface)
wwd_result_t	wwd_wifi_get_powersave_interface (wwd_interface_t interface, uint32_t *mode)

Detailed Description

WICED Wi-Fi functions for WLAN low power modes

Function Documentation

wiced_result_t wiced_wifi_disable_powersave

(

void

)

Disable 802.11 power save mode

Returns

wiced_result_t

wiced_result_t wiced_wifi_disable_powersave_interface

(

wiced_interface_t

interface

)

Disable 802.11 power save mode on specified interface

Parameters

[in]

interface

: The variable to set WLAN interface type

Returns

wiced_result_t

wiced_result_t wiced_wifi_enable_powersave

(

void

)

Enables powersave mode without regard for throughput reduction This function enables (legacy) 802.11 PS-Poll mode and should be used to achieve the lowest power consumption possible when the Wi-Fi device is primarily passively listening to the network

Warning

: An accurate 32kHz clock reference must be connected to the WLAN sleep clock input pin while the WLAN chip is in powersave mode! Failure to meet this requirement will result in poor WLAN performance The sleep clock reference is typically configured in the file: <WICED-SDK>/include/platforms/<PLATFORM_NAME>/platform.h

Parameters

[in]

void

None

Returns

wiced_result_t

wiced_result_t wiced_wifi_enable_powersave_interface

(

wiced_interface_t

interface

)

Enables powersave mode on specified interface without regard for throughput reduction This function enables (legacy) 802.11 PS-Poll mode and should be used to achieve the lowest power consumption possible when the Wi-Fi device is primarily passively listening to the network

Warning

: An accurate 32kHz clock reference must be connected to the WLAN sleep clock input pin while the WLAN chip is in powersave mode! Failure to meet this requirement will result in poor WLAN performance The sleep clock reference is typically configured in the file <WICED-SDK>/include/platforms/<PLATFORM_NAME>/platform.h

Parameters

[in]

interface

: The variable to set WLAN interface type

Returns

wiced_result_t

wiced_result_t wiced_wifi_enable_powersave_with_throughput

(

uint16_t

return_to_sleep_delay_ms

)

Enables power-save mode while attempting to maximize throughput

Network traffic is typically bursty. Reception of a packet often means that another packet will be received shortly afterwards (and vice versa for transmit) In high throughput power-save mode, rather then entering power-save mode immediately after receiving or sending a packet, the WLAN chip will wait for a timeout period before returning to sleep

Note

: return_to_sleep_delay must be set to a multiple of 10.

Warning

: An accurate 32kHz clock reference must be connected to the WLAN sleep clock input pin while the WLAN chip is in powersave mode! Failure to meet this requirement will result in poor WLAN performance. The sleep clock reference is typically configured in the file: <WICED-SDK>/include/platforms/<PLATFORM_NAME>/platform.h

Parameters

[in]

return_to_sleep_delay

: Timeout period (in milliseconds) before the WLAN chip returns to sleep

Returns

wiced_result_t

wiced_result_t wiced_wifi_enable_powersave_with_throughput_interface	(	uint16_t	return_to_sleep_delay_ms,
		wiced_interface_t	interface
	)

Enables powersave mode on specified interface while attempting to maximise throughput

Network traffic is typically bursty. Reception of a packet often means that another packet will be received shortly afterwards (and vice versa for transmit) In high throughput powersave mode, rather then entering powersave mode immediately after receiving or sending a packet, the WLAN chip will wait for a timeout period before returning to sleep

Note

: return_to_sleep_delay must be set to a multiple of 10.

Warning

: An accurate 32kHz clock reference must be connected to the WLAN sleep clock input pin while the WLAN chip is in powersave mode Failure to meet this requirement will result in poor WLAN performance. The sleep clock reference is typically configured in the file: <WICED-SDK>/include/platforms/<PLATFORM_NAME>/platform.h

Parameters

[in]	return_to_sleep_delay	: Timeout period (in milliseconds) before the WLAN chip returns to sleep
[in]	interface	: The variable to set WLAN interface type

Returns

wiced_result_t

wwd_result_t wwd_wifi_disable_powersave

(

void

)

Disables 802.11 power save mode

Returns

WWD_SUCCESS : if power save mode was successfully disabled Error code : if power save mode was not successfully disabled

wwd_result_t wwd_wifi_disable_powersave_interface

(

wwd_interface_t

interface

)

Disables 802.11 power save mode on specified interface

Returns

WWD_SUCCESS : if power save mode was successfully disabled Error code : if power save mode was not successfully disabled

Parameters

[in]

interface

: The variable to set WLAN interface type

wwd_result_t wwd_wifi_enable_powersave

(

void

)

Enables powersave mode without regard for throughput reduction

This function enables (legacy) 802.11 PS-Poll mode and should be used to achieve the lowest power consumption possible when the Wi-Fi device is primarily passively listening to the network

Returns

wwd_result_t

wwd_result_t wwd_wifi_enable_powersave_interface

(

wwd_interface_t

interface

)

Enables powersave mode on specified interface without regard for throughput reduction

This function enables (legacy) 802.11 PS-Poll mode and should be used to achieve the lowest power consumption possible when the Wi-Fi device is primarily passively listening to the network

Parameters

[in]

interface

: The variable to set WLAN interface type

Returns

wwd_result_t

wwd_result_t wwd_wifi_enable_powersave_with_throughput

(

uint16_t

return_to_sleep_delay

)

Enables powersave mode while attempting to maximise throughput

Network traffic is typically bursty. Reception of a packet often means that another packet will be received shortly afterwards (and vice versa for transmit).

In high throughput powersave mode, rather then entering powersave mode immediately after receiving or sending a packet, the WLAN chip waits for a timeout period before returning to sleep.

Returns

WWD_SUCCESS : if power save mode was successfully enabled Error code : if power save mode was not successfully enabled

Parameters

[in]

return_to_sleep_delay

: The variable to set return to sleep delay.*

return to sleep delay must be set to a multiple of 10 and not equal to zero.

wwd_result_t wwd_wifi_enable_powersave_with_throughput_interface	(	uint16_t	return_to_sleep_delay,
		wwd_interface_t	interface
	)

Enables powersave mode on specified interface while attempting to maximise throughput

Network traffic is typically bursty. Reception of a packet often means that another packet will be received shortly afterwards (and vice versa for transmit).

In high throughput powersave mode, rather then entering powersave mode immediately after receiving or sending a packet, the WLAN chip waits for a timeout period before returning to sleep.

Returns

WWD_SUCCESS : if power save mode was successfully enabled Error code : if power save mode was not successfully enabled

Parameters

[in]	return_to_sleep_delay	: The variable to set return to sleep delay.*
[in]	interface	: The variable to set WLAN interface type

return to sleep delay must be set to a multiple of 10 and not equal to zero.

wwd_result_t wwd_wifi_get_powersave_interface	(	wwd_interface_t	interface,
		uint32_t *	mode
	)

Get powersave mode on specified interface

Parameters

[in]	interface	: The interface to query for powersave state
[out]	mode	: the value of the current powersave state: PM1_POWERSAVE_MODE, PM2_POWERSAVE_MODE, NO_POWERSAVE_MODE

Returns

wwd_result_t