wiced_wifi.h File Reference

Data Structures
struct	wiced_custom_ie_info_t
struct	wiced_scan_handler_result_t
struct	wiced_wps_credential_t
struct	wiced_wps_device_detail_t

Macros
#define	WICED_WIFI_CH_TO_BAND(channel)
#define	WIFI_FLAG_MESH   (1 << 0)
#define	WIFI_FLAG_MESH_GATEWAY   (1 << 5)
#define	WIFI_FLAG_MESH_MCAST_REBROADCAST   (1 << 1)

Typedefs
typedef void(*	wiced_wifi_nan_event_handler_t) (const void *event_header, const uint8_t *event_data)
typedef void(*	wiced_wifi_rrm_event_handler_t) (const void *event_header, const uint8_t *event_data)
typedef void(*	wiced_wifi_softap_event_handler_t) (wiced_wifi_softap_event_t event, const wiced_mac_t *mac_address)

Enumerations
enum	wiced_wifi_softap_event_t { WICED_AP_UNKNOWN_EVENT , WICED_AP_STA_JOINED_EVENT , WICED_AP_STA_LEAVE_EVENT }
enum	wiced_wps_configuration_method_t {   WPS_CONFIG_USBA = 0x0001 , WPS_CONFIG_ETHERNET = 0x0002 , WPS_CONFIG_LABEL = 0x0004 , WPS_CONFIG_DISPLAY = 0x0008 ,   WPS_CONFIG_EXTERNAL_NFC_TOKEN = 0x0010 , WPS_CONFIG_INTEGRATED_NFC_TOKEN = 0x0020 , WPS_CONFIG_NFC_INTERFACE = 0x0040 , WPS_CONFIG_PUSH_BUTTON = 0x0080 ,   WPS_CONFIG_KEYPAD = 0x0100 , WPS_CONFIG_VIRTUAL_PUSH_BUTTON = 0x0280 , WPS_CONFIG_PHYSICAL_PUSH_BUTTON = 0x0480 , WPS_CONFIG_VIRTUAL_DISPLAY_PIN = 0x2008 ,   WPS_CONFIG_PHYSICAL_DISPLAY_PIN = 0x4008 }
enum	wiced_wps_device_category_t {   WICED_WPS_DEVICE_COMPUTER = 1 , WICED_WPS_DEVICE_INPUT = 2 , WICED_WPS_DEVICE_PRINT_SCAN_FAX_COPY = 3 , WICED_WPS_DEVICE_CAMERA = 4 ,   WICED_WPS_DEVICE_STORAGE = 5 , WICED_WPS_DEVICE_NETWORK_INFRASTRUCTURE = 6 , WICED_WPS_DEVICE_DISPLAY = 7 , WICED_WPS_DEVICE_MULTIMEDIA = 8 ,   WICED_WPS_DEVICE_GAMING = 9 , WICED_WPS_DEVICE_TELEPHONE = 10 , WICED_WPS_DEVICE_AUDIO = 11 , WICED_WPS_DEVICE_OTHER = 0xFF }
enum	wiced_wps_mode_t { WICED_WPS_PBC_MODE = 1 , WICED_WPS_PIN_MODE = 2 }

Functions
wiced_result_t	wiced_get_bss_info (wl_bss_info_t *bi, wwd_interface_t interface)
wiced_result_t	wiced_nan_config_disable (void)
wiced_result_t	wiced_nan_config_enable (wiced_wifi_nan_event_handler_t nan_event_handler)
wiced_result_t	wiced_status_result (void)
wiced_result_t	wiced_stop_ap (void)
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_add_keep_alive (wiced_keep_alive_packet_t *keep_alive_packet_info)
wiced_result_t	wiced_wifi_add_packet_filter (const wiced_packet_filter_t *settings)
wiced_result_t	wiced_wifi_clear_packet_filter_stats (uint32_t filter_id)
wiced_result_t	wiced_wifi_disable_11n_support (wiced_interface_t interface, wiced_bool_t disable)
wiced_result_t	wiced_wifi_disable_keep_alive (uint8_t id)
wiced_result_t	wiced_wifi_disable_packet_filter (uint8_t filter_id)
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_down (void)
wiced_result_t	wiced_wifi_enable_packet_filter (uint8_t filter_id)
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)
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_ap_client_rssi (int32_t *rssi, const wiced_mac_t *client_mac_addr)
wiced_result_t	wiced_wifi_get_ap_info (wiced_bss_info_t *ap_info, wiced_security_t *security)
wiced_result_t	wiced_wifi_get_associated_client_list (void *client_list_buffer, uint16_t buffer_length)
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_gci_mask (uint32_t *gci_mask)
wiced_result_t	wiced_wifi_get_ht_mode (wiced_interface_t interface, wiced_ht_mode_t *ht_mode)
wiced_result_t	wiced_wifi_get_keep_alive (wiced_keep_alive_packet_t *keep_alive_packet_info)
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_packet_filter_mask_and_pattern (uint32_t filter_id, uint32_t max_size, uint8_t *mask, uint8_t *pattern, uint32_t *size_out)
wiced_result_t	wiced_wifi_get_packet_filter_stats (uint8_t filter_id, wiced_packet_filter_stats_t *stats)
wiced_result_t	wiced_wifi_get_packet_filters (uint32_t max_count, uint32_t offset, wiced_packet_filter_t *list, uint32_t *count_out)
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_bool_t	wiced_wifi_is_sta_link_up (void)
wiced_result_t	wiced_wifi_join_adhoc (char *ssid, uint8_t ssid_length, wiced_security_t auth_type, uint8_t *security_key, uint16_t key_length, char *channel, char *ip, char *netmask, char *gateway)
wiced_result_t	wiced_wifi_join_halt (wiced_bool_t halt)
wiced_result_t	wiced_wifi_join_specific (char *ssid, uint8_t ssid_length, wiced_security_t auth_type, uint8_t *security_key, uint16_t key_length, char *bssid, char *channel, char *ip, char *netmask, char *gateway)
wiced_result_t	wiced_wifi_pno_start (wiced_ssid_t *ssid, wiced_security_t security, wiced_scan_result_handler_t handler, void *user_data)
wiced_result_t	wiced_wifi_pno_stop (void)
wiced_result_t	wiced_wifi_register_nan_event_handler (wiced_wifi_nan_event_handler_t event_handler)
wiced_result_t	wiced_wifi_register_pno_callback (wiced_scan_result_handler_t pno_handler, void *user_data)
wiced_result_t	wiced_wifi_register_rrm_event_handler (wiced_wifi_rrm_event_handler_t event_handler)
wiced_result_t	wiced_wifi_register_softap_event_handler (wiced_wifi_softap_event_handler_t softap_event_handler)
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_remove_packet_filter (uint8_t filter_id)
wiced_result_t	wiced_wifi_scan_disable (void)
wiced_result_t	wiced_wifi_scan_networks (wiced_scan_result_handler_t results_handler, void *user_data)
wiced_result_t	wiced_wifi_scan_networks_ex (wiced_scan_result_handler_t results_handler, void *user_data, wiced_scan_type_t scan_type, wiced_bss_type_t bss_type, const wiced_ssid_t *optional_ssid, const wiced_mac_t *optional_mac, const uint16_t *optional_channel_list, const wiced_scan_extended_params_t *optional_extended_params, wiced_interface_t interface)
wiced_result_t	wiced_wifi_send_gci_mailbox_message (uint32_t data)
wiced_result_t	wiced_wifi_set_gci_mask (uint32_t gci_mask)
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_packet_filter_mode (wiced_packet_filter_mode_t mode)
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_start_ap_with_custom_ie (wiced_ssid_t *ssid, wiced_security_t security, const char *key, uint8_t channel, const wiced_custom_ie_info_t *ie)
wiced_result_t	wiced_wifi_unregister_nan_event_handler (void)
wiced_result_t	wiced_wifi_unregister_rrm_event_handler (void)
wiced_result_t	wiced_wifi_unregister_softap_event_handler (void)
wiced_result_t	wiced_wifi_up (void)
wiced_result_t	wiced_wlan_connectivity_deinit (void)
wiced_result_t	wiced_wlan_connectivity_init (void)
wiced_result_t	wiced_wlan_connectivity_resume_after_deep_sleep (void)
wiced_result_t	wiced_wps_enrollee (wiced_wps_mode_t mode, const wiced_wps_device_detail_t *details, const char *password, wiced_wps_credential_t *credentials, uint16_t credential_count)
wiced_result_t	wiced_wps_registrar (wiced_wps_mode_t mode, const wiced_wps_device_detail_t *details, const char *password, wiced_wps_credential_t *credentials, uint16_t credential_count)

Detailed Description

Defines functions to perform Wi-Fi operations

Macro Definition Documentation

WICED_WIFI_CH_TO_BAND

#define WICED_WIFI_CH_TO_BAND

(

channel

)

Value:

( ( wwd_channel_to_wl_band( channel ) == WL_CHANSPEC_BAND_2G ) ? WICED_802_11_BAND_2_4GHZ : WICED_802_11_BAND_5GHZ )

Macro to determine the band (2.4GHz, 5GHz) of a channel

WIFI_FLAG_MESH

#define WIFI_FLAG_MESH   (1 << 0)

Misc WiFi flags stored in DCT structure platform_dct_misc_config_t field wifi_flags MESH master enable/disable

WIFI_FLAG_MESH_GATEWAY

#define WIFI_FLAG_MESH_GATEWAY   (1 << 5)

This machine a Gateway with an additional STA interface (to connect to AP)

WIFI_FLAG_MESH_MCAST_REBROADCAST

#define WIFI_FLAG_MESH_MCAST_REBROADCAST   (1 << 1)

MESH mcast rebroadcast

Typedef Documentation

wiced_wifi_nan_event_handler_t

typedef void(* wiced_wifi_nan_event_handler_t) (const void *event_header, const uint8_t *event_data)

Event handler to get NAN event header and NAN event data

Parameters

[out]	const	void* event_header : event header
[out]	const	uint8_t* event_data: event_data

wiced_wifi_rrm_event_handler_t

typedef void(* wiced_wifi_rrm_event_handler_t) (const void *event_header, const uint8_t *event_data)

Event handler to get RRM event header and RRM event data

Parameters

[out]	const	void* event_header : event header
[out]	const	uint8_t* event_data: event_data

wiced_wifi_softap_event_handler_t

typedef void(* wiced_wifi_softap_event_handler_t) (wiced_wifi_softap_event_t event, const wiced_mac_t *mac_address)

Soft AP event handler

Parameters

[in]	event	: SoftAP event that caused this callback
[in]	mac_address	: Mac address of STA that caused this event

Enumeration Type Documentation

wiced_wifi_softap_event_t

enum wiced_wifi_softap_event_t

WICED SoftAP events

Enumerator
WICED_AP_UNKNOWN_EVENT	Unknown SoftAP event
WICED_AP_STA_JOINED_EVENT	a STA joined our SoftAP
WICED_AP_STA_LEAVE_EVENT	a STA left our SoftAP

wiced_wps_configuration_method_t

enum wiced_wps_configuration_method_t

WPS Configuration Methods from the WSC2.0 spec

Enumerator
WPS_CONFIG_USBA	USBA
WPS_CONFIG_ETHERNET	ETHERNET
WPS_CONFIG_LABEL	LABEL
WPS_CONFIG_DISPLAY	DISPLAY
WPS_CONFIG_EXTERNAL_NFC_TOKEN	EXTERNAL_NFC_TOKEN
WPS_CONFIG_INTEGRATED_NFC_TOKEN	INTEGRATED_NFC_TOKEN
WPS_CONFIG_NFC_INTERFACE	NFC_INTERFACE
WPS_CONFIG_PUSH_BUTTON	PUSH_BUTTON
WPS_CONFIG_KEYPAD	KEYPAD
WPS_CONFIG_VIRTUAL_PUSH_BUTTON	VIRTUAL_PUSH_BUTTON
WPS_CONFIG_PHYSICAL_PUSH_BUTTON	PHYSICAL_PUSH_BUTTON
WPS_CONFIG_VIRTUAL_DISPLAY_PIN	VIRTUAL_DISPLAY_PIN
WPS_CONFIG_PHYSICAL_DISPLAY_PIN	PHYSICAL_DISPLAY_PIN

wiced_wps_device_category_t

enum wiced_wps_device_category_t

WPS Device Category from the WSC2.0 spec

Enumerator
WICED_WPS_DEVICE_COMPUTER	COMPUTER
WICED_WPS_DEVICE_INPUT	INPUT
WICED_WPS_DEVICE_PRINT_SCAN_FAX_COPY	PRINT_SCAN_FAX_COPY
WICED_WPS_DEVICE_CAMERA	CAMERA
WICED_WPS_DEVICE_STORAGE	STORAGE
WICED_WPS_DEVICE_NETWORK_INFRASTRUCTURE	NETWORK_INFRASTRUCTURE
WICED_WPS_DEVICE_DISPLAY	DISPLAY
WICED_WPS_DEVICE_MULTIMEDIA	MULTIMEDIA
WICED_WPS_DEVICE_GAMING	GAMING
WICED_WPS_DEVICE_TELEPHONE	TELEPHONE
WICED_WPS_DEVICE_AUDIO	AUDIO
WICED_WPS_DEVICE_OTHER	OTHER

wiced_wps_mode_t

enum wiced_wps_mode_t

WPS Connection Mode

Enumerator
WICED_WPS_PBC_MODE	Push button mode
WICED_WPS_PIN_MODE	PIN mode