Functions
void	wiced_wifi_deep_sleep_get_status_string (uint8_t *output, uint16_t max_output_length)

wiced_result_t	wiced_wifi_ds1_config (wiced_interface_t interface, wiced_offloads_container_t *offload_value, uint32_t ulp_wait_milliseconds)

wiced_result_t	wiced_wifi_ds1_disable (wiced_interface_t interface)

wiced_result_t	wiced_wifi_ds1_enable (wiced_interface_t interface)

void	wiced_wifi_ds1_notify_link_change (void)

wiced_result_t	wiced_wifi_ds1_set_complete_callback (wiced_wifi_ds1_complete_callback_t callback, void *user_parameter)

wiced_result_t	wiced_wifi_enter_ds1 (wiced_interface_t interface, wiced_offload_t offload_type, wiced_offload_value_t *offload_value, uint32_t ulp_wait_milliseconds)

wiced_result_t	wiced_wifi_enter_ds1_debug (wiced_interface_t interface, wiced_offload_t offload_type, wiced_offload_value_t offload_value, uint32_t ulp_wait_milliseconds, wiced_ds1_debug_t debug_overrides)

wiced_result_t	wiced_wifi_wake_ds1 (wiced_interface_t interface)

Detailed Description

WICED Wi-Fi functions for DS1 (Wi-Fi Deep Sleep) Entry/Exit and Debug.

Function Documentation

◆ wiced_wifi_deep_sleep_get_status_string()

void wiced_wifi_deep_sleep_get_status_string	(	uint8_t *	output,
		uint16_t	max_output_length )

extern

Return a string description of the WICED DS1 state (string describes whether DS1 is configured, enabled on host and firmware or not)

Parameters

[out]	output	: null delimited string is written into this buffer
[in]	max_output_length	: maximum amount of chars, including null that the output string can contain

◆ wiced_wifi_ds1_config()

wiced_result_t wiced_wifi_ds1_config	(	wiced_interface_t	interface,
		wiced_offloads_container_t *	offload_value,
		uint32_t	ulp_wait_milliseconds )

extern

Set configuration for entering the Wi-Fi deep sleep (DS1) state. Will be used to enter DS1 after wiced_wifi_ds1_enable has been called, when all preconditions are satisfied.

Parameters

[in]	interface	: interface to use for offload start and DS1 enter
[in]	offload_type	: type of offload to init
[in]	offload_value	: parameters for the offload; this memory must not be freed until after wiced_wifi_ds1_disable is invoked
[in]	ulp_wait_milliseconds	: seconds to wait prior to entering DS1

Returns: wiced_result_t

◆ wiced_wifi_ds1_disable()

wiced_result_t wiced_wifi_ds1_disable ( wiced_interface_t interface )

extern

Disable deep sleep 1 (DS1) state. Put WICED in state to never use Wi-Fi deep sleeping. WICED will leave Wi-Fi deep sleep if already sleeping and will not re-enter until wiced_wifi_ds1_enable is called again.

Parameters

[in] interface : interface to use for offload start and DS1 enter

Returns: wiced_result_t

◆ wiced_wifi_ds1_enable()

wiced_result_t wiced_wifi_ds1_enable ( wiced_interface_t interface )

extern

Enable deep sleep 1 (DS1) state. Put firmware in state to enter Wi-Fi deep sleep whenever possible. Preconditions for entering DS1: STA is associated; no other interfaces are active for 802.11. (AP and GO must both be disabled.)

Parameters

[in] interface : interface to use for offload start and DS1 enter

Returns: wiced_result_t

◆ wiced_wifi_ds1_notify_link_change()

void wiced_wifi_ds1_notify_link_change ( void )

extern

This API is called when a STA, AP, GO, or GC have a connection created or destroyed

◆ wiced_wifi_ds1_set_complete_callback()

wiced_result_t wiced_wifi_ds1_set_complete_callback	(	wiced_wifi_ds1_complete_callback_t	callback,
		void *	user_parameter )

extern

Get a callback when the wifi module has entered the deep sleep 1 (DS1) state.

Parameters

[in]	callback	: function to call whenever DS1 entry is detected
[in]	user_parameter	parameter to pass to the callback function when the callback is made

Returns: wiced_result_t

◆ wiced_wifi_enter_ds1()

wiced_result_t wiced_wifi_enter_ds1	(	wiced_interface_t	interface,
		wiced_offload_t	offload_type,
		wiced_offload_value_t *	offload_value,
		uint32_t	ulp_wait_milliseconds )

extern

Enter deep sleep 1 (DS1) state. First init specified offload type, wait the number of seconds, then enter DS1.

Parameters

[in]	interface	: interface to use for offload start and DS1 enter
[in]	offload_type	: type of offload to init
[in]	offload_value	: parameters for the offload
[in]	ulp_wait_milliseconds	: seconds to wait prior to entering DS1

Note: : Calling this after Equivalent to calling configure and then immediate attempted entry into DS1 (Deep sleep is suspended, config is updated, and then attempt is made to enter DS1) Failure to enter deepsleep leaves WICED state as DS1 enabled.

Returns: wiced_result_t

◆ wiced_wifi_enter_ds1_debug()

wiced_result_t wiced_wifi_enter_ds1_debug	(	wiced_interface_t	interface,
		wiced_offload_t	offload_type,
		wiced_offload_value_t *	offload_value,
		uint32_t	ulp_wait_milliseconds,
		wiced_ds1_debug_t *	debug_overrides )

extern

Enter deep sleep 1 (DS1) state. First init specified offload type, wait the number of seconds, then enter DS1.

Parameters

[in]	interface	: interface to use for offload start and DS1 enter
[in]	offload_type	: type of offload to init
[in]	offload_value	: parameters for the offload
[in]	ulp_wait_milliseconds	: seconds to wait prior to entering DS1
[in]	debug_options	: parameters used for controlling low level debug

Returns: wiced_result_t

◆ wiced_wifi_wake_ds1()

wiced_result_t wiced_wifi_wake_ds1 ( wiced_interface_t interface )

extern

Exit deep sleep 1 (DS1) state.

Parameters

[in] interface : interface to use for DS1 exit

Note: Calling this when DS1 is not enabled or when not deep sleeping results in an error return.

Returns: wiced_result_t

Functions

Detailed Description

Function Documentation

◆ wiced_wifi_deep_sleep_get_status_string()

◆ wiced_wifi_ds1_config()

◆ wiced_wifi_ds1_disable()

◆ wiced_wifi_ds1_enable()

◆ wiced_wifi_ds1_notify_link_change()

◆ wiced_wifi_ds1_set_complete_callback()

◆ wiced_wifi_enter_ds1()

◆ wiced_wifi_enter_ds1_debug()

◆ wiced_wifi_wake_ds1()