Functions
void	convert_security_type_to_string (wiced_security_t security, char *out_str, uint16_t out_str_len)

void	print_scan_result (wiced_scan_result_t *record)

wiced_result_t	wiced_wifi_add_custom_ie (wiced_interface_t interface, const wiced_custom_ie_info_t *ie_info)

wiced_result_t	wiced_wifi_disable_11n_support (wiced_interface_t interface, wiced_bool_t disable)

wiced_result_t	wiced_wifi_down (void)

wiced_result_t	wiced_wifi_find_ap (const char ssid, wiced_scan_result_t ap_info, const uint16_t *optional_channel_list)

wiced_result_t	wiced_wifi_get_channel (uint32_t *channel)

wiced_result_t	wiced_wifi_get_counters (wwd_interface_t interface, wiced_counters_t *counters)

wiced_result_t	wiced_wifi_get_ht_mode (wiced_interface_t interface, wiced_ht_mode_t *ht_mode)

wiced_result_t	wiced_wifi_get_listen_interval (wiced_listen_interval_t *li)

wiced_result_t	wiced_wifi_get_mac_address (wiced_mac_t *mac)

wiced_result_t	wiced_wifi_get_roam_trigger (int32_t *trigger_level)

wiced_result_t	wiced_wifi_get_roam_trigger_per_band (int32_t *trigger_level, wiced_802_11_band_t band)

wiced_result_t	wiced_wifi_remove_custom_ie (wiced_interface_t interface, const wiced_custom_ie_info_t *ie_info)

wiced_result_t	wiced_wifi_set_ht_mode (wiced_interface_t interface, wiced_ht_mode_t ht_mode)

wiced_result_t	wiced_wifi_set_listen_interval (uint8_t listen_interval, wiced_listen_interval_time_unit_t time_unit)

wiced_result_t	wiced_wifi_set_listen_interval_assoc (uint16_t listen_interval)

wiced_result_t	wiced_wifi_set_roam_trigger (int32_t trigger_level)

wiced_result_t	wiced_wifi_set_roam_trigger_per_band (int32_t trigger_level, wiced_802_11_band_t band)

wiced_result_t	wiced_wifi_up (void)

wl_chanspec_t	wwd_channel_to_wl_band (uint32_t channel)

uint32_t	wwd_get_bss_index (wwd_interface_t interface)

wwd_result_t	wwd_get_counters (wiced_counters_t *data)

wwd_result_t	wwd_get_phyrate_log (wiced_phyrate_log_t *data)

wwd_result_t	wwd_get_phyrate_log_size (unsigned int *size)

wwd_result_t	wwd_get_phyrate_statistics_counters (wiced_phyrate_counters_t *counts_buffer, unsigned int size)

void	wwd_log_event (const wwd_event_header_t event_header, const uint8_t event_data)

wwd_result_t	wwd_phyrate_log (unsigned int mode)

wwd_result_t	wwd_reset_statistics_counters (void)

wwd_result_t	wwd_wifi_deauth_all_associated_client_stas (wwd_dot11_reason_code_t reason, wwd_interface_t interface)

wwd_result_t	wwd_wifi_deauth_sta (const wiced_mac_t *mac, wwd_dot11_reason_code_t reason, wwd_interface_t interface)

void	wwd_wifi_edcf_ac_params_print (const wiced_edcf_ac_param_t acp, const int priority)

wwd_result_t	wwd_wifi_get_acparams_sta (wiced_edcf_ac_param_t *acp)

wwd_result_t	wwd_wifi_get_and_cache_mac_address (wwd_interface_t interface)

wwd_result_t	wwd_wifi_get_ap_client_rssi (int32_t rssi, const wiced_mac_t client_mac_addr)

wwd_result_t	wwd_wifi_get_cap (char buffer, uint16_t buflen, char cap)

wwd_result_t	wwd_wifi_get_cca_for_channel (uint32_t channels, uint32_t duration, uint8_t scores, uint32_t nchans)

wwd_result_t	wwd_wifi_get_ccode (wwd_country_t *ccode)

wwd_result_t	wwd_wifi_get_channel (wwd_interface_t interface, uint32_t *channel)

wwd_result_t	wwd_wifi_get_channels (wwd_interface_t interface, wl_uint32_list_t *channels)

wwd_result_t	wwd_wifi_get_clm_version (char *version, uint8_t length)

wwd_result_t	wwd_wifi_get_counters (wwd_interface_t interface, wiced_counters_t *counters)

wwd_result_t	wwd_wifi_get_ht_mode (wwd_interface_t interface, wiced_ht_mode_t *ht_mode)

wwd_result_t	wwd_wifi_get_listen_interval (wiced_listen_interval_t *li)

wwd_result_t	wwd_wifi_get_mac_address (wiced_mac_t *mac, wwd_interface_t interface)

wwd_result_t	wwd_wifi_get_max_associations (uint32_t *max_assoc)

wwd_result_t	wwd_wifi_get_noise (int32_t *noise)

wwd_result_t	wwd_wifi_get_preferred_association_band (int32_t *band)

wwd_result_t	wwd_wifi_get_rate (wwd_interface_t interface, uint32_t *rate)

wwd_result_t	wwd_wifi_get_roam_delta (int32_t *trigger_delta)

wwd_result_t	wwd_wifi_get_roam_delta_per_band (int32_t *trigger_delta, wiced_802_11_band_t band)

wwd_result_t	wwd_wifi_get_roam_scan_period (uint32_t *roam_scan_period)

wwd_result_t	wwd_wifi_get_roam_trigger (int32_t *trigger_level)

wwd_result_t	wwd_wifi_get_roam_trigger_per_band (int32_t *trigger_level, wiced_802_11_band_t band)

wwd_result_t	wwd_wifi_get_rssi (int32_t *rssi)

wwd_result_t	wwd_wifi_get_supplicant_eapol_key_timeout (wwd_interface_t interface, int32_t *eapol_key_timeout)

wwd_result_t	wwd_wifi_get_supported_band_list (wiced_band_list_t *band_list)

wwd_result_t	wwd_wifi_get_tx_power (uint8_t *dbm)

wwd_result_t	wwd_wifi_get_wifi_memuse (char *version, uint8_t length)

wwd_result_t	wwd_wifi_get_wifi_version (char *version, uint8_t length)

wwd_result_t	wwd_wifi_is_ready_to_transceive (wwd_interface_t interface)

void	wwd_wifi_link_update (void)

wwd_result_t	wwd_wifi_manage_custom_ie (wwd_interface_t interface, wiced_custom_ie_action_t action, const uint8_t oui, uint8_t subtype, const void data, uint16_t length, uint16_t which_packets)

wiced_bool_t	wwd_wifi_p2p_is_go_up (void)

void	wwd_wifi_p2p_set_go_is_up (wiced_bool_t is_up)

void	wwd_wifi_prioritize_acparams (const wiced_edcf_ac_param_t acp, int priority)

void	wwd_wifi_register_link_update_callback (void(*callback_function)(void))

wwd_result_t	wwd_wifi_register_multicast_address (const wiced_mac_t *mac)

wwd_result_t	wwd_wifi_register_multicast_address_for_interface (const wiced_mac_t *mac, wwd_interface_t interface)

wwd_result_t	wwd_wifi_select_antenna (wiced_antenna_t antenna)

wwd_result_t	wwd_wifi_send_action_frame (const wiced_action_frame_t *action_frame, wwd_interface_t interface)

wwd_result_t	wwd_wifi_send_csa (const wiced_chan_switch_t *csa, wwd_interface_t interface)

wwd_result_t	wwd_wifi_set_11n_support (wwd_interface_t interface, wiced_11n_support_t value)

wwd_result_t	wwd_wifi_set_ampdu_parameters (void)

wwd_result_t	wwd_wifi_set_block_ack_window_size (wwd_interface_t interface)

wwd_result_t	wwd_wifi_set_ccode (wwd_country_t *ccode)

wwd_result_t	wwd_wifi_set_channel (wwd_interface_t interface, uint32_t channel)

wwd_result_t	wwd_wifi_set_custom_country_code (const wiced_country_info_t *country_code)

wwd_result_t	wwd_wifi_set_down (void)

wwd_result_t	wwd_wifi_set_fw_cmd_debug_mode (wiced_bool_t enable)

wwd_result_t	wwd_wifi_set_ht_mode (wwd_interface_t interface, wiced_ht_mode_t ht_mode)

wwd_result_t	wwd_wifi_set_legacy_rate (wwd_interface_t interface, int32_t rate)

wwd_result_t	wwd_wifi_set_listen_interval (uint8_t listen_interval, wiced_listen_interval_time_unit_t time_unit)

wwd_result_t	wwd_wifi_set_listen_interval_assoc (uint16_t listen_interval)

wwd_result_t	wwd_wifi_set_mac_address (wiced_mac_t mac, wwd_interface_t interface)

wwd_result_t	wwd_wifi_set_mcs_rate (wwd_interface_t interface, int32_t mcs, wiced_bool_t mcsonly)

wwd_result_t	wwd_wifi_set_preferred_association_band (int32_t band)

wwd_result_t	wwd_wifi_set_roam_delta (int32_t trigger_delta)

wwd_result_t	wwd_wifi_set_roam_delta_per_band (int32_t trigger_delta, wiced_802_11_band_t band)

wwd_result_t	wwd_wifi_set_roam_scan_period (uint32_t roam_scan_period)

wwd_result_t	wwd_wifi_set_roam_trigger (int32_t trigger_level)

wwd_result_t	wwd_wifi_set_roam_trigger_per_band (int32_t trigger_level, wiced_802_11_band_t band)

wwd_result_t	wwd_wifi_set_supplicant_eapol_key_timeout (wwd_interface_t interface, int32_t eapol_key_timeout)

wwd_result_t	wwd_wifi_set_tx_power (uint8_t dbm)

wwd_result_t	wwd_wifi_set_up (void)

wwd_result_t	wwd_wifi_turn_off_roam (wiced_bool_t disable)

wwd_result_t	wwd_wifi_unregister_multicast_address (const wiced_mac_t *mac)

wwd_result_t	wwd_wifi_unregister_multicast_address_for_interface (const wiced_mac_t *mac, wwd_interface_t interface)

wwd_result_t	wwd_wifi_update_tos_map (void)

Detailed Description

WICED functions to

find AP
find best channel
Add/remove custome ie
wifi up/down
set/get roam triggers
get channel
get MAC address of Wifi interface
get wifi counters
set/get listen intervals
set/get HT (high throughput) mode
disable 11n support

WICED functions to

find AP
find best channel
Add/remove custome ie
wifi up/down
set/get roam triggers
get channel
get MAC address of Wifi interface
get wifi counters
set/get listen intervals
set/get HT (high throughput) mode
disable 11n support

Function Documentation

◆ convert_security_type_to_string()

void convert_security_type_to_string	(	wiced_security_t	security,
		char *	out_str,
		uint16_t	out_str_len )

extern

Convert a security bitmap to string

Parameters

[in]	security	: security of type wiced_security_t
[in]	out_str	: a character array to store output
[in]	out_str_len	: length of out_str char array

◆ print_scan_result()

void print_scan_result ( wiced_scan_result_t * record )

extern

Prints partial details of a scan result on a single line

Parameters

[in] record : A pointer to the wiced_scan_result_t record

Prints partial details of a scan result on a single line

Parameters

[in] record A pointer to the wiced_scan_result_t record

◆ wiced_wifi_add_custom_ie()

wiced_result_t wiced_wifi_add_custom_ie	(	wiced_interface_t	interface,
		const wiced_custom_ie_info_t *	ie_info )

extern

Add Wi-Fi custom IE

Parameters

[in]	interface	: Interface to add custom IE
[in]	ie_info	: Pointer to the structure which contains custom IE information

Returns: wiced_result_t

◆ wiced_wifi_disable_11n_support()

wiced_result_t wiced_wifi_disable_11n_support	(	wiced_interface_t	interface,
		wiced_bool_t	disable )

extern

Disable / enable 11n mode

NOTE: Ensure WiFi core and network is down before invoking this function. Refer wiced_wifi_down() API for details.

Parameters

[in]	interface	: Disables 11n mode on the given interface
[in]	disable	: Boolean to indicate if 11n mode to be disabled/enabled. If set to WICED_TRUE, 11n mode will be disabled.

Returns: wiced_result_t

◆ wiced_wifi_down()

wiced_result_t wiced_wifi_down ( void )

extern

Bring down Wi-Fi core preserving calibration

WARNING: This brings down the Wi-Fi core and all existing network connections. Bring up the Wi-Fi core using wiced_wifi_up() and bring up the required network connections using wiced_network_up().

Returns: wiced_result_t

◆ wiced_wifi_find_ap()

wiced_result_t wiced_wifi_find_ap	(	const char *	ssid,
		wiced_scan_result_t *	ap_info,
		const uint16_t *	optional_channel_list )

extern

Finds the AP and its information for the given SSID

Parameters

[in]	ssid	: SSID of the access point for which user wants to find information. It must be a NULL terminated string 32 characters or less
[out]	ap_info	: Pointer to the structure to store AP information.
[in]	optional_channel_list	: An optional channel list to restrict which channels are scanned. Note that the last entry must be 0 If NULL, the scan will be performed on all supported Wi-Fi channels.

Returns: wiced_result_t

◆ wiced_wifi_get_channel()

wiced_result_t wiced_wifi_get_channel ( uint32_t * channel )

extern

Get the current channel on STA interface

Parameters

[out] channel : A pointer to the variable where the channel value will be written

Returns: wiced_result_t

◆ wiced_wifi_get_counters()

wiced_result_t wiced_wifi_get_counters	(	wwd_interface_t	interface,
		wiced_counters_t *	counters )

extern

Get WLAN counter statistics for the interface provided

Parameters

[in]	interface	: The interface for which the counters are requested
[out]	counters	: A pointer to the structure where the counter data will be written

Returns: wiced_result_t

◆ wiced_wifi_get_ht_mode()

wiced_result_t wiced_wifi_get_ht_mode	(	wiced_interface_t	interface,
		wiced_ht_mode_t *	ht_mode )

extern

Gets the HT mode for the given interface

Parameters

[out]	ht_mode	: Pointer to the enum to store the currently used HT mode of the given interface.
[in]	interface	: Interface for which HT mode to be identified.

Returns: wiced_result_t

◆ wiced_wifi_get_listen_interval()

wiced_result_t wiced_wifi_get_listen_interval ( wiced_listen_interval_t * li )

extern

Gets the current value of all beacon listen interval variables

Parameters

[out] li : The current value of all listen interval settings

Returns: wiced_result_t

◆ wiced_wifi_get_mac_address()

wiced_result_t wiced_wifi_get_mac_address ( wiced_mac_t * mac )

extern

Retrieves the current Media Access Control (MAC) address (or Ethernet hardware address) of the 802.11 device

Parameters

mac	Pointer to a variable that the current MAC address will be written to

Returns: wiced_result_t

◆ wiced_wifi_get_roam_trigger()

wiced_result_t wiced_wifi_get_roam_trigger ( int32_t * trigger_level )

extern

Get roam trigger level for the 2.4 Gigahertz band

Parameters

trigger_level : Trigger level in dBm. Pointer to store current roam trigger level value

Returns: wiced_result_t

◆ wiced_wifi_get_roam_trigger_per_band()

wiced_result_t wiced_wifi_get_roam_trigger_per_band	(	int32_t *	trigger_level,
		wiced_802_11_band_t	band )

extern

Get roam trigger level for the given band

Parameters

trigger_level	: Trigger level in dBm. Pointer to store current roam trigger level value
band	: which band to use for the roam trigger query

Returns: wiced_result_t

◆ wiced_wifi_remove_custom_ie()

wiced_result_t wiced_wifi_remove_custom_ie	(	wiced_interface_t	interface,
		const wiced_custom_ie_info_t *	ie_info )

extern

Remove Wi-Fi custom IE

Parameters

[in]	interface	: Interface to remove custom IE
[in]	ie_info	: Pointer to the structure which contains custom IE information

Returns: wiced_result_t

◆ wiced_wifi_set_ht_mode()

wiced_result_t wiced_wifi_set_ht_mode	(	wiced_interface_t	interface,
		wiced_ht_mode_t	ht_mode )

extern

Sets the HT mode for the given interface

NOTE: Ensure WiFi core and network is down before invoking this function. Refer wiced_wifi_down() and wiced_network_down() functions for details.

Parameters

[in]	ht_mode	: HT mode to be set for the given interface
[in]	interface	: Interface for which HT Mode to be set

Returns: wiced_result_t

◆ wiced_wifi_set_listen_interval()

wiced_result_t wiced_wifi_set_listen_interval	(	uint8_t	listen_interval,
		wiced_listen_interval_time_unit_t	time_unit )

extern

Sets the 802.11 powersave listen interval for a Wi-Fi client, and communicates the listen interval to the Access Point. The listen interval will be set to (listen_interval x time_unit) seconds.

The default value for the listen interval is 0. With the default value set, the Wi-Fi device wakes to listen for AP beacons every DTIM period.

If the DTIM listen interval is non-zero, the DTIM listen interval will over ride the beacon listen interval value.

If it is necessary to set the listen interval sent to the AP to a value other than the value set by this function, use the additional association listen interval API : wiced_wifi_set_listen_interval_assoc()

Note: This function applies to 802.11 powersave operation. Please read the WICED Powersave Application Note provided in the WICED-SDK/Doc directory for further information about the operation of the 802.11 listen interval.

Parameters

[in]	listen_interval	: The desired beacon listen interval
[in]	time_unit	: The listen interval time unit; options are beacon period or DTIM period

Returns: wiced_result_t

◆ wiced_wifi_set_listen_interval_assoc()

wiced_result_t wiced_wifi_set_listen_interval_assoc ( uint16_t listen_interval )

extern

Sets the 802.11 powersave beacon listen interval communicated to Wi-Fi Access Points

This function is used by Wi-Fi clients to set the value of the beacon listen interval sent to the AP (in the association request frame) during the association process.

To set the client listen interval as well, use the wiced_wifi_set_listen_interval() API

Note: This function applies to 802.11 powersave operation. Please read the WICED Powersave Application Note provided in the WICED-SDK/Doc directory for further information about the operation of the 802.11 listen interval.

Parameters

listen_interval : The beacon listen interval sent to the AP during association. The time unit is specified in multiples of beacon periods.

Returns: wiced_result_t

◆ wiced_wifi_set_roam_trigger()

wiced_result_t wiced_wifi_set_roam_trigger ( int32_t trigger_level )

extern

Set roam trigger level for all bands

Parameters

[in] trigger_level : Trigger level in dBm. The Wi-Fi device will search for a new AP to connect to once the
signal from the AP (it is currently associated with) drops below the roam trigger level. Valid value range: 2 to -100 0 : Default roaming trigger 1 : Optimize for bandwidth roaming trigger 2 : Optimize for distance roaming trigger -1 to -100: Roaming will be triggered based on the specified RSSI value

Returns: wiced_result_t

◆ wiced_wifi_set_roam_trigger_per_band()

wiced_result_t wiced_wifi_set_roam_trigger_per_band	(	int32_t	trigger_level,
		wiced_802_11_band_t	band )

extern

Set roam trigger level for given band

Parameters

[in]	trigger_level	: Trigger level in dBm. The Wi-Fi device will search for a new AP to connect to once the signal from the AP (it is currently associated with) drops below the roam trigger level. Valid value range: 2 to -100 0 : Default roaming trigger 1 : Optimize for bandwidth roaming trigger 2 : Optimize for distance roaming trigger -1 to -100: Roaming will be triggered based on the specified RSSI value
[in]	band	: band on which to set the roam trigger

Returns: wiced_result_t

◆ wiced_wifi_up()

wiced_result_t wiced_wifi_up ( void )

extern

Brings up Wi-Fi core

Returns: wiced_result_t

◆ wwd_channel_to_wl_band()

wl_chanspec_t wwd_channel_to_wl_band ( uint32_t channel )

externinline

Map channel to its band, comparing channel to max 2g channel

Parameters

channel : The channel to map to a band

Returns: : WL_CHANSPEC_BAND_2G or WL_CHANSPEC_BAND_5G

◆ wwd_get_bss_index()

uint32_t wwd_get_bss_index ( wwd_interface_t interface )

extern

Gets the BSS index that the given interface is mapped to in Wiced

Parameters

interface : the interface for which to get the BSS index

Returns: BSS index

◆ wwd_get_counters()

wwd_result_t wwd_get_counters ( wiced_counters_t * data )

Returns the WiFi driver statistics counters since the last reset.

Parameters

[in] a pointer to the counter statistics buffer to fill

Returns: WWD_SUCCESS or Error code

◆ wwd_get_phyrate_log()

wwd_result_t wwd_get_phyrate_log ( wiced_phyrate_log_t * data )

Returns the WiFi driver phyrate log since the last reset.

Parameters

[in] a pointer to the phyrate counts buffer to fill

Returns: WWD_SUCCESS or Error code

◆ wwd_get_phyrate_log_size()

wwd_result_t wwd_get_phyrate_log_size ( unsigned int * size )

Returns the WiFi driver phyrate log size since the last reset

Parameters

[out] size of the phyrate counts buffer

Returns: WWD_SUCCESS or Error code

◆ wwd_get_phyrate_statistics_counters()

wwd_result_t wwd_get_phyrate_statistics_counters	(	wiced_phyrate_counters_t *	counts_buffer,
		unsigned int	size )

Returns the WiFi driver phyrate statistics sinc the last reset.

Parameters

[in]	a	pointer to the phyrate counts
[in]	size	of the phyrate counts buffer

Returns: WWD_SUCCESS or Error code

◆ wwd_log_event()

void wwd_log_event	(	const wwd_event_header_t *	event_header,
		const uint8_t *	event_data )

Print out an event's information for debugging help

◆ wwd_phyrate_log()

wwd_result_t wwd_phyrate_log ( unsigned int mode )

Starts or stops the WiFi driver Phyrate logging facility.

Parameters

[in] a mode selector where 0 = stop, 1 = start TX, 2= start RX

Returns: WWD_SUCCESS or Error code

◆ wwd_reset_statistics_counters()

wwd_result_t wwd_reset_statistics_counters ( void )

Resets WiFi driver statistic counters

Returns: WWD_SUCCESS or Error code

◆ wwd_wifi_deauth_all_associated_client_stas()

wwd_result_t wwd_wifi_deauth_all_associated_client_stas	(	wwd_dot11_reason_code_t	reason,
		wwd_interface_t	interface )

extern

Deauthenticates all client STAs associated to SoftAP or Group Owner

Parameters

[in]	reason	: Deauthentication reason code
[in]	interface	: SoftAP interface or P2P interface

Returns: WWD_SUCCESS : On successful deauthentication of the other STA WWD_ERROR : If an error occurred

◆ wwd_wifi_deauth_sta()

wwd_result_t wwd_wifi_deauth_sta	(	const wiced_mac_t *	mac,
		wwd_dot11_reason_code_t	reason,
		wwd_interface_t	interface )

extern

Deauthenticates a STA which may or may not be associated to SoftAP or Group Owner

Parameters

[in]	mac	: Pointer to a variable containing the MAC address to which the deauthentication will be sent
[in]	reason	: Deauthentication reason code
[in]	interface	: SoftAP interface or P2P interface

Returns: WWD_SUCCESS : On successful deauthentication of the other STA WWD_ERROR : If an error occurred

◆ wwd_wifi_edcf_ac_params_print()

void wwd_wifi_edcf_ac_params_print	(	const wiced_edcf_ac_param_t *	acp,
		const int *	priority )

extern

Print access category parameters with their priority (1-4, where 4 is highest priority)

Parameters

acp	Pointer to an array of AC parameters
priority	Pointer to a matching array of priority values

Returns

◆ wwd_wifi_get_acparams_sta()

wwd_result_t wwd_wifi_get_acparams_sta ( wiced_edcf_ac_param_t * acp )

extern

Retrieve the latest STA EDCF AC parameters

Retrieve the latest Station (STA) interface EDCF (Enhanced Distributed Coordination Function) Access Category parameters

Parameters

acp	The location where the array of AC parameters will be stored

Returns: WWD_SUCCESS : if the AC Parameters were successfully retrieved Error code : if the AC Parameters were not retrieved

◆ wwd_wifi_get_and_cache_mac_address()

wwd_result_t wwd_wifi_get_and_cache_mac_address ( wwd_interface_t interface )

extern

Retrieves the current Media Access Control (MAC) address (or Ethernet hardware address) of the 802.11 device and store it to local cache, so subsequent wwd_wifi_get_mac_address() be faster.

Returns: WWD_SUCCESS or Error code

◆ wwd_wifi_get_ap_client_rssi()

wwd_result_t wwd_wifi_get_ap_client_rssi	(	int32_t *	rssi,
		const wiced_mac_t *	client_mac_addr )

extern

Retrieve the latest RSSI value of the AP client

Parameters

rssi	The location where the RSSI value will be stored
client_mac_addr	Mac address of the AP client Please note that you can get the full list of AP clients currently connected to Wiced AP by calling a function wwd_wifi_get_associated_client_list

Returns: WWD_SUCCESS : if the RSSI was succesfully retrieved Error code : if the RSSI was not retrieved

◆ wwd_wifi_get_cap()

wwd_result_t wwd_wifi_get_cap	(	char *	buffer,
		uint16_t	buflen,
		char *	cap )

extern

This function gets the feature capabilities string from the WLAN firmware.

Parameters

char	* : pointer to string buffer
uint16_t	: length of string buffer
const	char * : Optional. If nonnull string, return WWD_SUCCESS if cap is present. Failure otherwise. Allows for simple checking of a specific capability.

Returns: : status WWD_SUCCESS or failure

◆ wwd_wifi_get_cca_for_channel()

wwd_result_t wwd_wifi_get_cca_for_channel	(	uint32_t *	channels,
		uint32_t	duration,
		uint8_t *	scores,
		uint32_t	nchans )

extern

Given a specific channel, return Clear Channel Assesment (CCA) score for that channel.

Parameters

channels	List of 20 Mhz channels to measure
duration	How long to measure for each channel, in milliseconds.
scores	List of resulting scores.
nchans	Number of entries in channels and scores.

Returns: WWD_SUCCESS : Success Error code : Unable to perform measurement

◆ wwd_wifi_get_ccode()

wwd_result_t wwd_wifi_get_ccode ( wwd_country_t * country )

extern

Get current country code

Parameters

[out] ccode : Pointer to output current ccode

Returns: wwd_result_t

Country code related functions

◆ wwd_wifi_get_channel()

wwd_result_t wwd_wifi_get_channel	(	wwd_interface_t	interface,
		uint32_t *	channel )

extern

Get the current channel on the WLAN radio

NOTE: on most WLAN devices this will get the channel for both AP AND STA (since there is only one radio - it cannot be on two channels simulaneously)

Parameters

interface	: The interface to set
channel	: pointer which receives the current channel

Returns: WWD_SUCCESS : if the channel was successfully retrieved Error code : if the channel was not successfully retrieved

◆ wwd_wifi_get_channels()

wwd_result_t wwd_wifi_get_channels	(	wwd_interface_t	interface,
		wl_uint32_list_t *	channels )

extern

Get the channel list on the WLAN radio

NOTE: on most WLAN devices this will get the channel list for both AP AND STA

Parameters

interface	: The interface to set
channels	: pointer which receives the channel list

Returns: WWD_SUCCESS : if the channel was successfully retrieved Error code : if the channel was not successfully retrieved

◆ wwd_wifi_get_clm_version()

wwd_result_t wwd_wifi_get_clm_version	(	char *	version,
		uint8_t	length )

extern

Retrieves the WLAN CLM version

Parameters

[out]	Pointer	to a buffer that version information will be written to
[in]	Length	of the buffer

Returns: wwd_result_t

◆ wwd_wifi_get_counters()

wwd_result_t wwd_wifi_get_counters	(	wwd_interface_t	interface,
		wiced_counters_t *	counters )

extern

Get the counters for the provided interface

Parameters

interface : The interface from which the counters are requested counters : A pointer to the structure where the counter data will be written

Returns: WWD_SUCCESS : if the counters were successfully read Error code : if the counters were not successfully read

◆ wwd_wifi_get_ht_mode()

wwd_result_t wwd_wifi_get_ht_mode	(	wwd_interface_t	interface,
		wiced_ht_mode_t *	ht_mode )

extern

Gets the current HT mode of the given interface

Parameters

interface : the interface for which current HT mode to be identified ht_mode : pointers to store the results (i.e., currently configured HT mode)

Returns: WICED_SUCCESS : if success Error code : error code to indicate the type of error, if HT mode could not be successfully get

◆ wwd_wifi_get_listen_interval()

wwd_result_t wwd_wifi_get_listen_interval ( wiced_listen_interval_t * li )

extern

Gets the current value of all beacon listen interval variables

Parameters

listen_interval_beacon	: The current value of the listen interval set as a multiple of the beacon period
listen_interval_dtim	: The current value of the listen interval set as a multiple of the DTIM period
listen_interval_assoc	: The current value of the listen interval sent to access points in an association request frame

Returns: WWD_SUCCESS : If all listen interval values are read successfully Error code : If at least one of the listen interval values are NOT read successfully

◆ wwd_wifi_get_mac_address()

wwd_result_t wwd_wifi_get_mac_address	(	wiced_mac_t *	mac,
		wwd_interface_t	interface )

extern

Retrieves the current Media Access Control (MAC) address (or Ethernet hardware address) of the 802.11 device

Parameters

mac	Pointer to a variable that the current MAC address will be written to

Returns: WWD_SUCCESS or Error code

◆ wwd_wifi_get_max_associations()

wwd_result_t wwd_wifi_get_max_associations ( uint32_t * max_assoc )

extern

Get the maximum number of associations supported by all interfaces (STA and Soft AP)

Parameters

max_assoc : The maximum number of associations supported by the STA and Soft AP interfaces. For example if the STA interface is associated then the Soft AP can support (max_assoc - 1) associated clients.

Returns: WICED_SUCCESS : if the maximum number of associated clients was successfully read WICED_ERROR : if the maximum number of associated clients was not successfully read

◆ wwd_wifi_get_noise()

wwd_result_t wwd_wifi_get_noise ( int32_t * noise )

extern

Get the average PHY noise detected on the antenna. This is valid only after TX. Defined only on STA interface

Parameters

noise : reports average noise

Returns: WWD_SUCCESS : if success Error code : if Link quality was not enabled or not successful

◆ wwd_wifi_get_preferred_association_band()

wwd_result_t wwd_wifi_get_preferred_association_band ( int32_t * band )

Get the preferred band for association by the radio chip

Parameters

band	: pointer to a variable that will hold the band information (auto, 2.4 GHz or 5 GHz)

Returns: WWD_SUCCESS : if success Error code : if not successful

◆ wwd_wifi_get_rate()

wwd_result_t wwd_wifi_get_rate	(	wwd_interface_t	interface,
		uint32_t *	rate )

extern

Get the current data rate for the provided interface

Parameters

interface : The interface from which the rate is requested rate : A pointer to the uint32_t where the value will be returned in 500Kbits/s units, 0 for auto

Returns: WWD_SUCCESS : if the rate was successfully read Error code : if the rate was not successfully read

◆ wwd_wifi_get_roam_delta()

wwd_result_t wwd_wifi_get_roam_delta ( int32_t * trigger_delta )

extern

Get roam trigger delta value for 2.4 Gigahertz band

Parameters

trigger_delta : Trigger delta is in dBm. Pointer to store the current roam trigger delta value

Returns: WWD_SUCCESS : if the roam trigger delta was successfully get Error code : if the roam trigger delta was not successfully get

◆ wwd_wifi_get_roam_delta_per_band()

wwd_result_t wwd_wifi_get_roam_delta_per_band	(	int32_t *	trigger_delta,
		wiced_802_11_band_t	band )

extern

Get roam trigger delta value for given band

Parameters

trigger_delta	: Trigger delta is in dBm. Pointer to store the current roam trigger delta value
band	: Get roam delta for this band

Returns: WWD_SUCCESS : if the roam trigger delta was successfully get Error code : if the roam trigger delta was not successfully get

◆ wwd_wifi_get_roam_scan_period()

wwd_result_t wwd_wifi_get_roam_scan_period ( uint32_t * roam_scan_period )

extern

Get roam scan period

Parameters

roam_scan_period : Roam scan period is in secs. Pointer to store the current partial scan period

Returns: WWD_SUCCESS : if the roam scan period was successfully get Error code : if the roam scan period was not successfully get

◆ wwd_wifi_get_roam_trigger()

wwd_result_t wwd_wifi_get_roam_trigger ( int32_t * trigger_level )

extern

Get roam trigger level for the 2.4 Gigahertz band

Parameters

trigger_level : Trigger level in dBm. Pointer to store current roam trigger level value

Returns: WWD_SUCCESS : if the roam trigger was successfully get Error code : if the roam trigger was not successfully get

◆ wwd_wifi_get_roam_trigger_per_band()

wwd_result_t wwd_wifi_get_roam_trigger_per_band	(	int32_t *	trigger_level,
		wiced_802_11_band_t	band )

extern

Get roam trigger level for the given band

Parameters

trigger_level	: Trigger level in dBm. Pointer to store current roam trigger level value
band	: Get roam trigger for this band

Returns: WWD_SUCCESS : if the roam trigger was successfully get Error code : if the roam trigger was not successfully get

◆ wwd_wifi_get_rssi()

wwd_result_t wwd_wifi_get_rssi ( int32_t * rssi )

extern

Retrieve the latest RSSI value

Parameters

rssi	The location where the RSSI value will be stored

Returns: WWD_SUCCESS : if the RSSI was succesfully retrieved Error code : if the RSSI was not retrieved

◆ wwd_wifi_get_supplicant_eapol_key_timeout()

wwd_result_t wwd_wifi_get_supplicant_eapol_key_timeout	(	wwd_interface_t	interface,
		int32_t *	eapol_key_timeout )

extern

Gets the current EAPOL key timeout for the given interface

Parameters

interface : the interface for which we want the EAPOL key timeout eapol_key_timeout : pointer to store the EAPOL key timeout value

Returns: WICED_SUCCESS : if success Error code : error code to indicate the type of error

◆ wwd_wifi_get_supported_band_list()

wwd_result_t wwd_wifi_get_supported_band_list ( wiced_band_list_t * band_list )

extern

Get the bands supported by the radio chip

Parameters

band_list : pointer to a structure that will hold the band list information

Returns: WWD_SUCCESS : if success Error code : if not successful

◆ wwd_wifi_get_tx_power()

wwd_result_t wwd_wifi_get_tx_power ( uint8_t * dbm )

extern

Gets the tx power in dBm units

Parameters

dbm	: The variable to receive the tx power in dbm.

Returns: WWD_SUCCESS : if successful Error code : if not successful

◆ wwd_wifi_get_wifi_memuse()

wwd_result_t wwd_wifi_get_wifi_memuse	(	char *	version,
		uint8_t	length )

extern

Retrieves current memory usage of WLAN processor

Parameters

[out]	Pointer	to a buffer that information will be written to
[in]	Length	of the buffer

Returns: wwd_result_t

◆ wwd_wifi_get_wifi_version()

wwd_result_t wwd_wifi_get_wifi_version	(	char *	version,
		uint8_t	length )

extern

Retrieves the WLAN firmware version

Parameters

[out]	Pointer	to a buffer that version information will be written to
[in]	Length	of the buffer

Returns: wwd_result_t

◆ wwd_wifi_is_ready_to_transceive()

wwd_result_t wwd_wifi_is_ready_to_transceive ( wwd_interface_t interface )

extern

Determines if a particular interface is ready to transceive ethernet packets

Parameters

Radio interface to check, options are WICED_STA_INTERFACE, WICED_AP_INTERFACE

Returns: WWD_SUCCESS : if the interface is ready to transceive ethernet packets; WICED_NOTFOUND : no AP with a matching SSID was found; WICED_NOT_AUTHENTICATED: a matching AP was found but it won't let you authenticate. This can occur if this device is in the block list on the AP.; WICED_NOT_KEYED: the device has authenticated and associated but has not completed the key exchange. This can occur if the passphrase is incorrect.; Error code : if the interface is not ready to transceive ethernet packets

◆ wwd_wifi_link_update()

void wwd_wifi_link_update ( void )

extern

Called to notify WWD that there has been a link change WWD in turn will call the link update callback, if it has been registered

◆ wwd_wifi_manage_custom_ie()

wwd_result_t wwd_wifi_manage_custom_ie	(	wwd_interface_t	interface,
		wiced_custom_ie_action_t	action,
		const uint8_t *	oui,
		uint8_t	subtype,
		const void *	data,
		uint16_t	length,
		uint16_t	which_packets )

extern

Manage the addition and removal of custom IEs

Parameters

interface	: interface on which the operation to be performed
action	: the action to take (add or remove IE)
oui	: the oui of the custom IE
subtype	: the IE sub-type
data	: a pointer to the buffer that hold the custom IE
length	: the length of the buffer pointed to by 'data'
which_packets	a mask of which packets this IE should be included in. See wiced_ie_packet_flag_t

Returns: WWD_SUCCESS : if the custom IE action was successful Error code : if the custom IE action failed

◆ wwd_wifi_p2p_is_go_up()

wiced_bool_t wwd_wifi_p2p_is_go_up ( void )

extern

Returns: WICED_TRUE if the P2P GO is currently up

◆ wwd_wifi_p2p_set_go_is_up()

void wwd_wifi_p2p_set_go_is_up ( wiced_bool_t is_up )

extern

Set whether the p2p GO is up or not

Parameters

is_up : specify whether the p2p GO is up currently or not

◆ wwd_wifi_prioritize_acparams()

void wwd_wifi_prioritize_acparams	(	const wiced_edcf_ac_param_t *	acp,
		int *	priority )

extern

Prioritize access category parameters as a function of min and max contention windows and backoff slots

Parameters

acp	Pointer to an array of AC parameters
priority	Pointer to a matching array of priority values

Returns

◆ wwd_wifi_register_link_update_callback()

void wwd_wifi_register_link_update_callback ( void(* callback_function )(void) )

extern

Used by WICED to get notified that wireless link state has changed The callback function any time STA, AP, or GO link states change

◆ wwd_wifi_register_multicast_address()

wwd_result_t wwd_wifi_register_multicast_address ( const wiced_mac_t * mac )

extern

Registers interest in a multicast address Once a multicast address has been registered, all packets detected on the medium destined for that address are forwarded to the host. Otherwise they are ignored.

Parameters

mac	Ethernet MAC address

Returns: WWD_SUCCESS : if the address was registered successfully Error code : if the address was not registered

◆ wwd_wifi_register_multicast_address_for_interface()

wwd_result_t wwd_wifi_register_multicast_address_for_interface	(	const wiced_mac_t *	mac,
		wwd_interface_t	interface )

extern

Registers interest in a multicast address Similar to wwd_wifi_register_multicast_address but able to define interface

Parameters

mac	: Ethernet MAC address
interface	Wireless interface

Returns: WWD_SUCCESS : if the address was registered successfully Error code : if the address was not registered

◆ wwd_wifi_select_antenna()

wwd_result_t wwd_wifi_select_antenna ( wiced_antenna_t antenna )

extern

Select the Wi-Fi antenna antenna = 0 -> select antenna 0 antenna = 1 -> select antenna 1 antenna = 3 -> enable auto antenna selection ie. automatic diversity

Parameters

antenna The antenna configuration to use

Returns: WWD_SUCCESS : if the antenna selection was successfully set Error code : if the antenna selection was not set

◆ wwd_wifi_send_action_frame()

wwd_result_t wwd_wifi_send_action_frame	(	const wiced_action_frame_t *	action_frame,
		wwd_interface_t	interface )

extern

Send a pre-prepared action frame

Parameters

action_frame	: A pointer to a pre-prepared action frame structure
interface	: The interface that is sending the action frame (WWD_STA_INTERFACE, WWD_AP_INTERFACE or WWD_P2P_INTERFACE)

Returns: WWD_SUCCESS or Error code

◆ wwd_wifi_send_csa()

wwd_result_t wwd_wifi_send_csa	(	const wiced_chan_switch_t *	csa,
		wwd_interface_t	interface )

extern

This function will send a channel switch announcement and switch to the specificed channel at the specified time.

Parameters

[in]	wiced_chan_switch_t	pointer to channel switch information
	interface	: WWD_AP_INTERFACE (works only in AP mode)

Returns: wwd_result_t

◆ wwd_wifi_set_11n_support()

wwd_result_t wwd_wifi_set_11n_support	(	wwd_interface_t	interface,
		wiced_11n_support_t	value )

extern

Enable or disable 11n support (support only for pre-11n modes)

NOTE: Ensure Wi-Fi core and network is down before invoking this function. Refer to wiced_wifi_down() for more details.

Parameters

interface : The interface for which 11n mode is being controlled. Currently only STA supported disable : Boolean value which if TRUE will turn 11n off and if FALSE will turn 11n on

Returns: WICED_SUCCESS : if the 11n was successfully turned off WICED_ERROR : if the 11n was not successfully turned off

◆ wwd_wifi_set_ampdu_parameters()

wwd_result_t wwd_wifi_set_ampdu_parameters ( void )

extern

Set the AMPDU parameters for both Soft AP and STA

Sets various AMPDU parameters for Soft AP and STA to ensure that the number of buffers dedicated to AMPDUs does not exceed the resources of the chip. Both Soft AP and STA interfaces must be down.

Returns: WICED_SUCCESS : if the AMPDU parameters were successfully set WICED_ERROR : if the AMPDU parameters were not successfully set

Sets the chip specific AMPDU parameters for AP and STA For SDK 3.0, and beyond, each chip will need it's own function for setting AMPDU parameters.

◆ wwd_wifi_set_block_ack_window_size()

wwd_result_t wwd_wifi_set_block_ack_window_size ( wwd_interface_t interface )

extern

Set the AMPDU Block Ack window size for both Soft AP and STA

Sets the AMPDU Block Ack window size for Soft AP and STA. Soft AP and STA interfaces may be up.

Parameters

interface : STA or Soft AP interface.

Returns: WICED_SUCCESS : if the Block Ack window size was successfully set WICED_ERROR : if the Block Ack window size was not successfully set

Sets the chip specific AMPDU parameters for AP and STA For SDK 3.0, and beyond, each chip will need it's own function for setting AMPDU parameters.

◆ wwd_wifi_set_ccode()

wwd_result_t wwd_wifi_set_ccode ( wwd_country_t * ccode )

extern

Set current country code to ccode

Parameters

[in] ccode : Pointer to input ccode to be set

Returns: wwd_result_t

◆ wwd_wifi_set_channel()

wwd_result_t wwd_wifi_set_channel	(	wwd_interface_t	interface,
		uint32_t	channel )

extern

Set the current channel on the WLAN radio

NOTE: on most WLAN devices this will set the channel for both AP AND STA (since there is only one radio - it cannot be on two channels simulaneously)

Parameters

interface	: The interface to set
channel	: The desired channel

Returns: WWD_SUCCESS : if the channel was successfully set Error code : if the channel was not successfully set

◆ wwd_wifi_set_custom_country_code()

wwd_result_t wwd_wifi_set_custom_country_code ( const wiced_country_info_t * country_code )

extern

Set a custom WLAN country code

Parameters

[in] country_code Country code information

Returns: wwd_result_t

◆ wwd_wifi_set_down()

wwd_result_t wwd_wifi_set_down ( void )

extern

Bring down the Wi-Fi core

WARNING / NOTE: This brings down the Wi-Fi core and existing network connections will be lost. Re-establish the network by calling wiced_wifi_up() and wiced_network_up(). Refer those APIs for more details.

Returns: WWD_SUCCESS : if success Error code : if fails

Set the Wi-Fi device down. Internal use only

Parameters

interface

Returns

◆ wwd_wifi_set_fw_cmd_debug_mode()

wwd_result_t wwd_wifi_set_fw_cmd_debug_mode ( wiced_bool_t enable )

extern

Print out additional information for SET operations

Parameters

enable try read back and print out values after they are SET in firmware if this is true

Returns: WWD_SUCCESS : if success Error code : if fails

◆ wwd_wifi_set_ht_mode()

wwd_result_t wwd_wifi_set_ht_mode	(	wwd_interface_t	interface,
		wiced_ht_mode_t	ht_mode )

extern

Sets HT mode for the given interface

NOTE: Ensure WiFi core and network is down before invoking this function. Refer wiced_wifi_down() API for more details.

Parameters

interface : the interface for which HT mode to be changed. ht_mode : enumeration value which indicates the HT mode

Returns: WICED_SUCCESS : if success Error code : error code to indicate the type of error, if HT mode could not be successfully set

◆ wwd_wifi_set_legacy_rate()

wwd_result_t wwd_wifi_set_legacy_rate	(	wwd_interface_t	interface,
		int32_t	rate )

extern

Set the legacy (CCK/OFDM) transmit data rate for the provided interface

Parameters

interface : The interface for which the rate is going to be set rate : uint32_t where the rate value is given in 500Kbits/s units, 0 for auto

Returns: WWD_SUCCESS : if the rate was successfully set Error code : if the rate was not successfully set

◆ wwd_wifi_set_listen_interval()

wwd_result_t wwd_wifi_set_listen_interval	(	uint8_t	listen_interval,
		wiced_listen_interval_time_unit_t	time_unit )

extern

Sets the 802.11 powersave listen interval for a Wi-Fi client, and communicates the listen interval to the Access Point. The listen interval will be set to (listen_interval x time_unit) seconds.

The default value for the listen interval is 0. With the default value set, the Wi-Fi device wakes to listen for AP beacons every DTIM period.

If the DTIM listen interval is non-zero, the DTIM listen interval will over ride the beacon listen interval value.

If it is necessary to set the listen interval sent to the AP to a value other than the value set by this function, use the additional association listen interval API : wwd_wifi_set_listen_interval_assoc()

NOTE: This function applies to 802.11 powersave operation. Please read the WICED powersave application note for further information about the operation of the 802.11 listen interval.

Parameters

listen_interval	: The desired beacon listen interval
time_unit	: The listen interval time unit; options are beacon period or DTIM period.

Returns: WWD_SUCCESS : If the listen interval was successfully set. Error code : If the listen interval was not successfully set.

◆ wwd_wifi_set_listen_interval_assoc()

wwd_result_t wwd_wifi_set_listen_interval_assoc ( uint16_t listen_interval )

extern

Sets the 802.11 powersave beacon listen interval communicated to Wi-Fi Access Points

This function is used by Wi-Fi clients to set the value of the beacon listen interval sent to the AP (in the association request frame) during the association process.

To set the client listen interval as well, use the wwd_wifi_set_listen_interval() API

This function applies to 802.11 powersave operation. Please read the WICED powersave application note for further information about the operation of the 802.11 listen interval.

Parameters

listen_interval : The beacon listen interval sent to the AP during association. The time unit is specified in multiples of beacon periods.

Returns: WWD_SUCCESS : if listen interval was successfully set Error code : if listen interval was not successfully set

◆ wwd_wifi_set_mac_address()

wwd_result_t wwd_wifi_set_mac_address	(	wiced_mac_t	mac,
		wwd_interface_t	interface )

extern

WARNING : This function is for internal use only!

This function sets the current Media Access Control (MAC) address of the 802.11 device. To override the MAC address in the Wi-Fi OTP or NVRAM add a global define in the application makefile as shown below. With this define in place, the MAC address stored in the DCT is used instead of the MAC in the OTP or NVRAM.

In <WICED-SDK>/App/my_app/my_app.mk add the following global define GLOBAL_DEFINES := MAC_ADDRESS_SET_BY_HOST Further information about MAC addresses is available in the following automatically generated file AFTER building your first application <WICED-SDK>/generated_mac_address.txt

NOTE: Ensure Wi-Fi core and network is down before invoking this function. Refer wiced_wifi_down() API for details.

Parameters

[in] mac Wi-Fi MAC address

Returns: WWD_SUCCESS or Error code

◆ wwd_wifi_set_mcs_rate()

wwd_result_t wwd_wifi_set_mcs_rate	(	wwd_interface_t	interface,
		int32_t	mcs,
		wiced_bool_t	mcsonly )

extern

Set the MCS index transmit data rate for the provided interface

Parameters

interface : The interface for which the rate is going to be set mcs : int32_t where the mcs index is given, -1 for auto mcsonly : indicate that only the mcs index should be changed

Returns: WWD_SUCCESS : if the rate was successfully set Error code : if the rate was not successfully set

◆ wwd_wifi_set_preferred_association_band()

wwd_result_t wwd_wifi_set_preferred_association_band ( int32_t band )

Set the preferred band for association by the radio chip Defined only on STA interface

Parameters

band	: preferred band (auto, 2.4 GHz or 5 GHz)

Returns: WWD_SUCCESS : if success Error code : if setting the preferred band was not successful

◆ wwd_wifi_set_roam_delta()

wwd_result_t wwd_wifi_set_roam_delta ( int32_t trigger_delta )

extern

Set roam trigger delta value for all bands

Parameters

trigger_delta : Trigger delta is in dBm. After a roaming is triggered - The successful roam will happen
when a target AP with RSSI better than the current serving AP by at least trigger_delta (in dB)

Returns: WWD_SUCCESS : if the roam trigger delta was successfully set Error code : if the roam trigger delta was not successfully set

◆ wwd_wifi_set_roam_delta_per_band()

wwd_result_t wwd_wifi_set_roam_delta_per_band	(	int32_t	trigger_delta,
		wiced_802_11_band_t	band )

extern

Set roam trigger delta value for given band

Parameters

trigger_delta	: Trigger delta is in dBm. After a roaming is triggered - The successful roam will happen when a target AP with RSSI better than the current serving AP by at least trigger_delta (in dB)
band	: Get roam delta for this band

Returns: WWD_SUCCESS : if the roam trigger delta was successfully set Error code : if the roam trigger delta was not successfully set

◆ wwd_wifi_set_roam_scan_period()

wwd_result_t wwd_wifi_set_roam_scan_period ( uint32_t roam_scan_period )

extern

Set roam scan period

Parameters

roam_scan_period : Roam scan period is in secs. Updates the partial scan period - for partial scan - Only for STA

Returns: WWD_SUCCESS : if the roam scan period was successfully set Error code : if the roam scan period was not successfully set

◆ wwd_wifi_set_roam_trigger()

wwd_result_t wwd_wifi_set_roam_trigger ( int32_t trigger_level )

extern

Set roam trigger level for all bands

Parameters

trigger_level : Trigger level in dBm. The Wi-Fi device will search for a new AP to connect to once the
signal from the AP (it is currently associated with) drops below the roam trigger level

Returns: WWD_SUCCESS : if the roam trigger was successfully set Error code : if the roam trigger was not successfully set

◆ wwd_wifi_set_roam_trigger_per_band()

wwd_result_t wwd_wifi_set_roam_trigger_per_band	(	int32_t	trigger_level,
		wiced_802_11_band_t	band )

extern

Set roam trigger level for the specified band

Parameters

trigger_level	: Trigger level in dBm. The Wi-Fi device will search for a new AP to connect to once the signal from the AP (it is currently associated with) drops below the roam trigger level
band	: Modify the roam trigger for this band

Returns: WWD_SUCCESS : if the roam trigger was successfully set Error code : if the roam trigger was not successfully set

◆ wwd_wifi_set_supplicant_eapol_key_timeout()

wwd_result_t wwd_wifi_set_supplicant_eapol_key_timeout	(	wwd_interface_t	interface,
		int32_t	eapol_key_timeout )

extern

Sets the current EAPOL key timeout for the given interface

Parameters

interface : the interface for which we want to set the EAPOL key timeout eapol_key_timeout : EAPOL key timeout value

Returns: WICED_SUCCESS : if success Error code : error code to indicate the type of error

◆ wwd_wifi_set_tx_power()

wwd_result_t wwd_wifi_set_tx_power ( uint8_t dbm )

extern

Sets the tx power in dBm units

Parameters

dbm	: The desired tx power in dbm. If set to -1 (0xFF) the default value is restored.

Returns: WWD_SUCCESS : if tx power was successfully set Error code : if tx power was not successfully set

◆ wwd_wifi_set_up()

wwd_result_t wwd_wifi_set_up ( void )

extern

Brings up the Wi-Fi core

Returns: WWD_SUCCESS : if success Error code : if fails

◆ wwd_wifi_turn_off_roam()

wwd_result_t wwd_wifi_turn_off_roam ( wiced_bool_t disable )

extern

Turn off roaming

Parameters

disable : Boolean value which if TRUE will turn roaming off and if FALSE will turn roaming on

Returns: WICED_SUCCESS : if the roaming was successfully turned off WICED_ERROR : if the roaming was not successfully turned off

◆ wwd_wifi_unregister_multicast_address()

wwd_result_t wwd_wifi_unregister_multicast_address ( const wiced_mac_t * mac )

extern

Unregisters interest in a multicast address Once a multicast address has been unregistered, all packets detected on the medium destined for that address are ignored.

Parameters

mac	Ethernet MAC address

Returns: WWD_SUCCESS : if the address was unregistered successfully Error code : if the address was not unregistered

◆ wwd_wifi_unregister_multicast_address_for_interface()

wwd_result_t wwd_wifi_unregister_multicast_address_for_interface	(	const wiced_mac_t *	mac,
		wwd_interface_t	interface )

extern

Unregisters interest in a multicast address Similar to wwd_wifi_unregister_multicast_address but able to define interface.

Parameters

mac	: Ethernet MAC address
interface	Wireless interface

Returns: WWD_SUCCESS : if the address was unregistered successfully Error code : if the address was not unregistered

◆ wwd_wifi_update_tos_map()

wwd_result_t wwd_wifi_update_tos_map ( void )

extern

For each traffic priority (0..7) look up the 802.11 Access Category that is mapped to this type of service and update the TOS map with the priority that the AP actually allows

Returns: WICED_SUCCESS : if the WICED_ERROR : if the AC Parameters were not retrieved

Functions

Detailed Description

Function Documentation

◆ convert_security_type_to_string()

◆ print_scan_result()

◆ wiced_wifi_add_custom_ie()

◆ wiced_wifi_disable_11n_support()

◆ wiced_wifi_down()

◆ wiced_wifi_find_ap()

◆ wiced_wifi_get_channel()

◆ wiced_wifi_get_counters()

◆ wiced_wifi_get_ht_mode()

◆ wiced_wifi_get_listen_interval()

◆ wiced_wifi_get_mac_address()

◆ wiced_wifi_get_roam_trigger()

◆ wiced_wifi_get_roam_trigger_per_band()

◆ wiced_wifi_remove_custom_ie()

◆ wiced_wifi_set_ht_mode()

◆ wiced_wifi_set_listen_interval()

◆ wiced_wifi_set_listen_interval_assoc()

◆ wiced_wifi_set_roam_trigger()

◆ wiced_wifi_set_roam_trigger_per_band()

◆ wiced_wifi_up()

◆ wwd_channel_to_wl_band()

◆ wwd_get_bss_index()

◆ wwd_get_counters()

◆ wwd_get_phyrate_log()

◆ wwd_get_phyrate_log_size()

◆ wwd_get_phyrate_statistics_counters()

◆ wwd_log_event()

◆ wwd_phyrate_log()

◆ wwd_reset_statistics_counters()

◆ wwd_wifi_deauth_all_associated_client_stas()

◆ wwd_wifi_deauth_sta()

◆ wwd_wifi_edcf_ac_params_print()

◆ wwd_wifi_get_acparams_sta()

◆ wwd_wifi_get_and_cache_mac_address()

◆ wwd_wifi_get_ap_client_rssi()

◆ wwd_wifi_get_cap()

◆ wwd_wifi_get_cca_for_channel()

◆ wwd_wifi_get_ccode()

◆ wwd_wifi_get_channel()

◆ wwd_wifi_get_channels()

◆ wwd_wifi_get_clm_version()

◆ wwd_wifi_get_counters()

◆ wwd_wifi_get_ht_mode()

◆ wwd_wifi_get_listen_interval()

◆ wwd_wifi_get_mac_address()

◆ wwd_wifi_get_max_associations()

◆ wwd_wifi_get_noise()

◆ wwd_wifi_get_preferred_association_band()

◆ wwd_wifi_get_rate()

◆ wwd_wifi_get_roam_delta()

◆ wwd_wifi_get_roam_delta_per_band()

◆ wwd_wifi_get_roam_scan_period()

◆ wwd_wifi_get_roam_trigger()

◆ wwd_wifi_get_roam_trigger_per_band()

◆ wwd_wifi_get_rssi()

◆ wwd_wifi_get_supplicant_eapol_key_timeout()

◆ wwd_wifi_get_supported_band_list()

◆ wwd_wifi_get_tx_power()

◆ wwd_wifi_get_wifi_memuse()

◆ wwd_wifi_get_wifi_version()

◆ wwd_wifi_is_ready_to_transceive()

◆ wwd_wifi_link_update()

◆ wwd_wifi_manage_custom_ie()

◆ wwd_wifi_p2p_is_go_up()

◆ wwd_wifi_p2p_set_go_is_up()

◆ wwd_wifi_prioritize_acparams()

◆ wwd_wifi_register_link_update_callback()

◆ wwd_wifi_register_multicast_address()

◆ wwd_wifi_register_multicast_address_for_interface()

◆ wwd_wifi_select_antenna()

◆ wwd_wifi_send_action_frame()

◆ wwd_wifi_send_csa()

◆ wwd_wifi_set_11n_support()

◆ wwd_wifi_set_ampdu_parameters()

◆ wwd_wifi_set_block_ack_window_size()

◆ wwd_wifi_set_ccode()

◆ wwd_wifi_set_channel()