5.11.0.0R3
Software Development Kit
 
Loading...
Searching...
No Matches
wwd_wifi.h File Reference

Data Structures

struct  wwd_auth_req_status
 

Macros

#define PMKID_LEN   (16)
 

Typedefs

typedef void(* wiced_rrm_report_callback_t) (wwd_rrm_report_t **result_ptr)
 
typedef void(* wiced_scan_result_callback_t) (wiced_scan_result_t **result_ptr, void *user_data, wiced_scan_status_t status)
 
typedef struct wwd_auth_req_status wwd_auth_req_status_t
 
typedef void(* wwd_auth_result_callback_t) (void *result_ptr, uint32_t len, wiced_auth_status_t status, uint8_t *flag, void *user_data)
 

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)
 
wwd_result_t wwd_ampdu_clear_dump (wwd_interface_t interface)
 
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_dump (wwd_interface_t interface, uint8_t *dump_buf, uint16_t len, char *cmd, uint16_t cmd_len)
 
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)
 
wwd_result_t wwd_get_txrx_frag (uint32_t *txfrag, uint32_t *rxfrag)
 
wwd_result_t wwd_join_mesh (const wiced_ssid_t *ssid, wiced_security_t auth_type, const uint8_t *security_key, uint8_t key_length, wwd_interface_t interface)
 
void wwd_log_event (const wwd_event_header_t *event_header, const uint8_t *event_data)
 
wwd_result_t wwd_mesh_filter (wiced_mac_t *mac, wwd_interface_t interface)
 
wwd_result_t wwd_mesh_status (char *result_buf, uint16_t result_buf_sz)
 
wwd_result_t wwd_nan_config_band (uint8_t band)
 
wwd_result_t wwd_nan_config_clear_counters (void)
 
wwd_result_t wwd_nan_config_cluster_id (wiced_bool_t set, wwd_nan_cluster_id_t *ether_addr)
 
wwd_result_t wwd_nan_config_device_state (wiced_bool_t set, uint8_t *role)
 
wwd_result_t wwd_nan_config_disable (void)
 
wwd_result_t wwd_nan_config_discover_window_length (wiced_bool_t set, uint16_t *dw_len)
 
wwd_result_t wwd_nan_config_discovery_beacon_interval (wiced_bool_t set, uint16_t *interval)
 
wwd_result_t wwd_nan_config_enable (void)
 
wwd_result_t wwd_nan_config_get_count (wwd_nan_config_count_t *config_count)
 
wwd_result_t wwd_nan_config_get_status (wwd_nan_state_t *nan_state)
 
wwd_result_t wwd_nan_config_hop_count (wiced_bool_t set, uint8_t *hop_count)
 
wwd_result_t wwd_nan_config_hop_limit (wiced_bool_t set, uint8_t *hop_limit)
 
wwd_result_t wwd_nan_config_interface_address (wiced_bool_t set, struct ether_addr *addr)
 
wwd_result_t wwd_nan_config_oui (wiced_bool_t enable, wwd_nan_config_oui_type_t *oui_type)
 
wwd_result_t wwd_nan_config_rssi_threshold (wiced_bool_t set, wwd_nan_config_rssi_threshold_t *rssi_thresh)
 
wwd_result_t wwd_nan_config_service_discovery_frame_tx_time (wiced_bool_t set, uint16_t *time)
 
wwd_result_t wwd_nan_config_service_id_beacon (wiced_bool_t set, wwd_nan_sid_beacon_control_t *service_id_bcn_control)
 
wwd_result_t wwd_nan_config_set_chanspec (chanspec_t *chanspec)
 
wwd_result_t wwd_nan_config_stop_beacon_transmit (wiced_bool_t set, uint16_t *stop_beacon)
 
wwd_result_t wwd_nan_config_warmup_time (wiced_bool_t set, uint32_t *warmup_time)
 
wwd_result_t wwd_nan_election_host_enable (wiced_bool_t set, uint8_t *host_enable)
 
wwd_result_t wwd_nan_election_join (wwd_nan_join_t *join)
 
wwd_result_t wwd_nan_election_merge (wiced_bool_t set, uint8_t *enable_merge)
 
wwd_result_t wwd_nan_election_metric_config (wwd_nan_election_metric_config_t *config)
 
wwd_result_t wwd_nan_election_metric_state_get (wwd_nan_election_metric_config_t *config)
 
wwd_result_t wwd_nan_election_stop (wwd_nan_cluster_id_t *cluster_id)
 
wwd_result_t wwd_nan_sd_cancel_publish (uint8_t instance_id)
 
wwd_result_t wwd_nan_sd_cancel_subscribe (uint8_t instance_id)
 
wwd_result_t wwd_nan_sd_publish (wiced_bool_t set, wwd_nan_sd_publish_t *nan_sd_params)
 
wwd_result_t wwd_nan_sd_publish_list (wwd_nan_service_list_t *nan_service_list)
 
wwd_result_t wwd_nan_sd_subscribe (wiced_bool_t set, wwd_nan_sd_subscribe_t *nan_sd_params)
 
wwd_result_t wwd_nan_sd_subscribe_list (wwd_nan_service_list_t *nan_service_list)
 
wwd_result_t wwd_nan_sd_transmit (wwd_nan_sd_transmit_t *nan_sd_transmit)
 
wwd_result_t wwd_nan_sync_timeslot_release (uint32_t *release)
 
wwd_result_t wwd_nan_sync_timeslot_reserve (wwd_nan_timeslot_t *reserve)
 
wwd_result_t wwd_phyrate_log (unsigned int mode)
 
wwd_result_t wwd_reset_statistics_counters (void)
 
wwd_result_t wwd_set_mesh_auth_proto (uint32_t auth_proto, wwd_interface_t interface)
 
wwd_result_t wwd_set_mesh_auto_peer (uint32_t auto_peer, wwd_interface_t interface)
 
wwd_result_t wwd_set_mesh_channel (uint32_t channel, wwd_interface_t interface)
 
wwd_result_t wwd_set_mesh_mcast_rebroadcast (uint32_t mcast_rebro, wwd_interface_t interface)
 
wwd_result_t wwd_set_mesh_security (wiced_security_t auth_type, wwd_interface_t interface)
 
wwd_result_t wwd_wifi_abort_scan (void)
 
wwd_result_t wwd_wifi_ap_init (wiced_ssid_t *ssid, wiced_security_t auth_type, const uint8_t *security_key, uint8_t key_length, uint8_t channel)
 
wwd_result_t wwd_wifi_ap_up (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)
 
wwd_result_t wwd_wifi_disable_powersave (void)
 
wwd_result_t wwd_wifi_disable_powersave_interface (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_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_fast_bss_transition_capabilities (wwd_interface_t interface, wiced_bool_t *enable)
 
wwd_result_t wwd_wifi_fast_bss_transition_over_distribution_system (wwd_interface_t interface, wiced_bool_t set, int *value)
 
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)
 
uint32_t wwd_wifi_get_bandwidth (void)
 
wwd_result_t wwd_wifi_get_bw (uint32_t *bandwidth)
 
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_current_band (wwd_interface_t interface, uint32_t *current_band)
 
wwd_result_t wwd_wifi_get_flags (uint32_t *wifi_flags, wwd_interface_t interface)
 
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_pm_mode (wwd_interface_t interface, uint32_t *pmmode)
 
wwd_result_t wwd_wifi_get_powersave_interface (wwd_interface_t interface, uint32_t *mode)
 
wwd_result_t wwd_wifi_get_preferred_association_band (int32_t *band)
 
wwd_result_t wwd_wifi_get_radio_resource_management_capabilities (wwd_interface_t interface, radio_resource_management_capability_ie_t *rrm_cap)
 
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_scan_params (uint32_t *assoc_time, uint32_t *unassoc_time, uint32_t *passive_time, uint32_t *home_time, uint32_t *nprobes)
 
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)
 
wiced_bool_t wwd_wifi_is_mesh_enabled (void)
 
wiced_bool_t wwd_wifi_is_mesh_mcast_rebroadcast_enabled (void)
 
wwd_result_t wwd_wifi_is_ready_to_transceive (wwd_interface_t interface)
 
wwd_result_t wwd_wifi_join (const wiced_ssid_t *ssid, wiced_security_t auth_type, const uint8_t *security_key, uint8_t key_length, host_semaphore_type_t *semaphore, wwd_interface_t interface)
 
wwd_result_t wwd_wifi_join_halt (wiced_bool_t halt)
 
wiced_bool_t wwd_wifi_join_is_ready_to_halt (wwd_interface_t interface)
 
wwd_result_t wwd_wifi_join_specific (const wiced_scan_result_t *ap, const uint8_t *security_key, uint8_t key_length, host_semaphore_type_t *semaphore, wwd_interface_t interface)
 
wwd_result_t wwd_wifi_leave (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)
 
wwd_result_t wwd_wifi_pno_add_network (wiced_ssid_t *ssid, wiced_security_t security)
 
wwd_result_t wwd_wifi_pno_clear (void)
 
wwd_result_t wwd_wifi_pno_start (void)
 
wwd_result_t wwd_wifi_pno_stop (void)
 
void wwd_wifi_prioritize_acparams (const wiced_edcf_ac_param_t *acp, int *priority)
 
wwd_result_t wwd_wifi_radio_resource_management_beacon_req (wwd_interface_t interface, radio_resource_management_beacon_req_t *rrm_bcn_req)
 
wwd_result_t wwd_wifi_radio_resource_management_channel_load_req (wwd_interface_t interface, radio_resource_management_req_t *rrm_chload_req)
 
wwd_result_t wwd_wifi_radio_resource_management_frame_req (wwd_interface_t interface, radio_resource_management_framereq_t *rrm_framereq)
 
wwd_result_t wwd_wifi_radio_resource_management_link_management_req (wwd_interface_t interface, wiced_mac_t *ea)
 
wwd_result_t wwd_wifi_radio_resource_management_neighbor_add_neighbor (wwd_interface_t interface, radio_resource_management_nbr_element_t *nbr_elt, uint16_t buflen)
 
wwd_result_t wwd_wifi_radio_resource_management_neighbor_del_neighbor (wwd_interface_t interface, wiced_mac_t *bssid)
 
wwd_result_t wwd_wifi_radio_resource_management_neighbor_list (wwd_interface_t interface, uint8_t *buffer, uint16_t buflen)
 
wwd_result_t wwd_wifi_radio_resource_management_neighbor_req (wwd_interface_t interface, wiced_ssid_t *ssid)
 
wwd_result_t wwd_wifi_radio_resource_management_noise_req (wwd_interface_t interface, radio_resource_management_req_t *rrm_noise_req)
 
wwd_result_t wwd_wifi_radio_resource_management_stat_req (wwd_interface_t interface, radio_resource_management_statreq_t *rrm_statreq)
 
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_scan (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_scan_result_callback_t callback, wiced_scan_result_t **result_ptr, void *user_data, 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_bandwidth (uint8_t bandwidth)
 
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_flags (uint32_t *wifi_flags, wwd_interface_t interface)
 
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_radio_resource_management_capabilities (wwd_interface_t interface, radio_resource_management_capability_ie_t *rrm_cap)
 
wwd_result_t wwd_wifi_set_raw_packet_processor (wwd_wifi_raw_packet_processor_t function)
 
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_scan_params (uint32_t assoc_time, uint32_t unassoc_time, uint32_t passive_time, uint32_t home_time, uint32_t nprobes)
 
wwd_result_t wwd_wifi_set_scan_suppress (wiced_bool_t enable_suppression)
 
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_start_ap (wiced_ssid_t *ssid, wiced_security_t auth_type, const uint8_t *security_key, uint8_t key_length, uint8_t channel)
 
wwd_result_t wwd_wifi_stop_ap (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

Prototypes of functions for controlling the Wi-Fi system

This file provides prototypes for end-user functions which allow actions such as scanning for Wi-Fi networks, joining Wi-Fi networks, getting the MAC address, etc

Macro Definition Documentation

◆ PMKID_LEN

#define PMKID_LEN   (16)

PMKID LENGTH

Typedef Documentation

◆ wwd_auth_req_status_t

Structure used by both dongle and host dongle asks host to start auth(SAE), host updates auth status to dongle.

◆ wwd_auth_result_callback_t

typedef void(* wwd_auth_result_callback_t) (void *result_ptr, uint32_t len, wiced_auth_status_t status, uint8_t *flag, void *user_data)

Auth result callback function pointer type

Parameters
result_prtA pointer to the pointer that indicates where to put the auth result
lenthe size of result
statusStatus of auth process
flagflag of h2e will be indicated in auth request event, otherwise is NULL.
user_datauser specific data that will be passed directly to the callback function

Function Documentation

◆ wwd_ampdu_clear_dump()

wwd_result_t wwd_ampdu_clear_dump ( wwd_interface_t interface)

To simulate the "wl ampdu_clear_dump" command

◆ wwd_get_dump()

wwd_result_t wwd_get_dump ( wwd_interface_t interface,
uint8_t * dump_buf,
uint16_t len,
char * cmd,
uint16_t cmd_len )

To simulate "wl dump" command

Parameters
[out]dump_buf: Output buffer from the dump command.
[in]interface: Current Interface, ex:- STA, AP etc len : length of the output buffer cmd : additional commands for the dump, ex:- ampdu cmd_len : length of the command
Returns
wwd_result_t

◆ wwd_get_txrx_frag()

wwd_result_t wwd_get_txrx_frag ( uint32_t * txfrag,
uint32_t * rxfrag )

To get tx/rx frag counters data

◆ wwd_wifi_get_bandwidth()

uint32_t wwd_wifi_get_bandwidth ( void )

get bandwidth

Returns
uint32_t : bandwidth

◆ wwd_wifi_get_bw()

wwd_result_t wwd_wifi_get_bw ( uint32_t * bandwidth)

To get the bandwidth

◆ wwd_wifi_get_current_band()

wwd_result_t wwd_wifi_get_current_band ( wwd_interface_t interface,
uint32_t * current_band )

To get the current band

◆ wwd_wifi_get_pm_mode()

wwd_result_t wwd_wifi_get_pm_mode ( wwd_interface_t interface,
uint32_t * pmmode )

To get Wi-Fi PM mode

◆ wwd_wifi_set_bandwidth()

wwd_result_t wwd_wifi_set_bandwidth ( uint8_t bandwidth)

Set bandwidth

Parameters
[in]arg: bandwidth 20/40/80
Returns
wwd_result indicating if the operation success.

◆ wwd_wifi_set_raw_packet_processor()

wwd_result_t wwd_wifi_set_raw_packet_processor ( wwd_wifi_raw_packet_processor_t function)
extern

Sets a handler functions for monitor mode

Packets received in monitor mode have raw 802.11 headers and cannot be processed by the normal stack. Use this function to set a handler function which will process and free the raw packets received in monitor mode.

Parameters
func: function pointer to handler. Set to NULL to clear handler.
Returns
result code