Wi-Fi Driver API Reference Manual — FreeRTOS

Wi-Fi Driver API Reference Manual — FreeRTOS#

Main Page#

Introduction#

NXP wireless SoCs require a combination of firmware binary image streamed into the radio subsystem, and driver source code compiled onto the application MCU. The radio driver source code provides APIs that enable a developer to send and receive packets over the radio interfaces by communicating with the firmware images that are streamed into the radio subsystems on start-up.

This manual provides developer reference documentation for Wi-Fi driver and Wi-Fi Connection Manager. Refer to the source code for additional information.

Supported SoC Summary#

SoC	Band	Max Channel Width	Wi-Fi Generation
IW416	2.4/5 GHz	20/40 MHz	Wi-Fi 4 (802.11n)
W8987	2.4/5 GHz	20/40/80 MHz	Wi-Fi 5 (802.11ac)
RW612	2.4/5 GHz	20 MHz	Wi-Fi 6 (802.11ax)
IW610	2.4/5 GHz	20 MHz	Wi-Fi 6 (802.11ax)
IW612	2.4/5 GHz	20/40/80 MHz	Wi-Fi 6 (802.11ax)

Abbreviations and Acronyms#

Abbreviation	Description
ACS	Auto channel selection
AID	Association ID
AMI	Ambient motion index
AMPDU	Aggregate medium access control protocol data unit
AP	Access point
ARP	Address resolution protocol
BSS	Basic service set
BSSID	Basic service set ID
BTM	BSS transition management
CA	Certificate authority
CCK	Complementary code keying
CLI	Command line input
CSI	Channel state information
CW	Continuous wave
DH	Diffie-Hellman
DPP	Device provisioning protocol
DTIM	Delivery traffic indication map
EAP	Extensible authentication protocol
EAP TLS	Extensible authentication protocol transport layer security
FCS	Frame check sequence
FTM	Fine timing measurement
GI	Guard interval
HE	802.11ax high efficiency
HT	802.11n high throughput
HTC	High throughput control
LDPC	Low density parity check
MBO	Multi band operation
MEF	Memory efficient filtering
MFPC	Management frame protection capable
MFPR	Management frame protection required
MIMO	Multiple input multiple output
NAN	Neighbor awareness networking
NSS	N*N MIMO spatial stream
OBSS	Overlapping basic service set
OCE	Optimized connectivity experience
OMI	Operating mode indication
OWE	Opportunistic wireless encryption
P2P	Peer to peer
PBC	Push button configuration
PEAP	Protected extensible authentication protocol
PMF	Protected management frame
PMK	Pairwise master key
PMKSA	Pairwise master key security association
PS	Power-save
PTA	Packet traffic arbitration
PWE	Password element
QoS	Quality of service
RSSI	Received signal strength indicator
RTS	Request to send
SAD	Software antenna diversity
SAE	Simultaneous authentication of equals
SSID	Service set ID
STBC	Space time block code
TBTT	Target beacon transmission time
TIM	Traffic indication map
TSF	Timing synchronization function
TSP	Thermal safeguard protection
TWT	Target wake time
UAPSD	Unscheduled automatic Power-save delivery
VHT	802.11ac very high throughput
WLCMGR	Wi-Fi connection manager
WLS	Wireless location service
WPS	Wi-Fi protected setup

File Index#

File	Description
`wlan.h`	This file provides Wi-Fi APIs for the application

Data Structures
Enumerations
Macros
Functions

Data Structures#

Struct	Supported SoCs
`_Event_Radar_Detected_Info`	All
`ext_coex_pta_cfg`	RW612
`ftm_11mc_nego_cfg_t`	IW612
`ipv4_config`	All
`ipv6_config`	All
`location_cfg_info_t`	IW612
`location_civic_rep_t`	IW612
`ranging_11az_cfg_t`	IW612
`rx_pkt_he_rate_info`	All
`rx_pkt_ht_rate_info`	All
`rx_pkt_rate_info`	All
`rx_pkt_vht_rate_info`	All
`tx_ampdu_prot_mode_para`	RW612, IW610
`tx_pkt_he_rate_info`	All
`tx_pkt_ht_rate_info`	All
`tx_pkt_rate_info`	All
`tx_pkt_vht_rate_info`	All
`wifi_scan_params_t`	All
`wlan_cck_desense_cfg`	RW612, IW610
`wlan_cipher`	All
`wlan_csi_proc_cfg`	RW612
`wlan_diag`	All
`wlan_ieeeps_config`	All
`wlan_ip_config`	All
`wlan_message`	All
`wlan_nan_publish_params_t`	RW612
`wlan_nan_subscribe_params_t`	RW612
`wlan_network`	All
`wlan_network_security`	All
`wlan_rx_abort_cfg`	RW612, IW610
`wlan_rx_abort_cfg_ext`	RW612, IW610
`wlan_scan_result`	All
`wlan_tx_pert_info`	RW612
`wlan_txrx_histogram_info`	All

Data Structure Documentation#

`_Event_Radar_Detected_Info`#

Field	Type	Description
`detect_count`	`t_u32`	Radar detection count.
`reg_domain`	`t_u8`	Regulatory domain: 1=fcc, 2=etsi, 3=mic.
`main_det_type`	`t_u8`	Main detection type: 0=none, 1=pw(chirp), 2=pri(radar).
`pw_chirp_type`	`t_u16`	Pulse width chirp type.
`pw_chirp_idx`	`t_u8`	Pulse width chirp index.
`pw_value`	`t_u8`	Pulse width value.
`pri_radar_type`	`t_u8`	Primary radar type.
`pri_binCnt`	`t_u8`	Primary radar binary counter count.
`binCounter`	`t_u8`	Binary counter array.
`numDfsRecords`	`t_u8`	Number of DFS records.
`dfsRecordHdrs`	`t_u8`	DFS record header array.
`reallyPassed`	`t_u32`	Actual elapsed time in milliseconds.

`ext_coex_pta_cfg`#

Field	Type	Description
`enabled`	`t_u8`	Enable: 0x01, Disable: 0x00.
`ext_WifiBtArb`	`t_u8`	Enable extended Wi-Fi and Bluetooth LE arbitration: 0x01, Disable: 0x00.
`polGrantPin`	`t_u8`	Active high: 0x00, Active low: 0x01.
`enable_PriPtaInt`	`t_u8`	Enable PriPtaInt: 0x01, Disable PriPtaInt: 0x00.
`enable_StatusFromPta`	`t_u8`	State input disable: 0x00, State info is from state pin: 0x01, State info is sampled on priority pin: 0x02.
`setPriSampTiming`	`t_u16`	Timing to sample Priority bit.
`setStateInfoSampTiming`	`t_u16`	Timing to sample TX/RX info.
`extRadioTrafficPrio`	`t_u8`	Enable external traffic TX/RX Priority: 0x01, Disable: 0x00.
`extCoexHwIntWci2`	`t_u8`	Enable wci-2 interface: 0x01, Disable wci-2 interface: 0x00.

External coexistence PTA (Packet Traffic Arbitration) configuration

`ftm_11mc_nego_cfg_t`#

Field	Type	Description
`burst_exponent`	`t_u8`	Indicates how many burst instances are requested for the FTM session.
`burst_duration`	`t_u8`	Indicates the duration of a burst instance.
`min_delta_FTM`	`t_u8`	Minimum time between consecutive FTM frames.
`is_ASAP`	`t_u8`	ASAP/non-ASAP case.
`per_burst_FTM`	`t_u8`	Number of FTMs per burst.
`channel_spacing`	`t_u8`	FTM channel spacing: HT20/HT40/VHT80/…
`burst_period`	`t_u16`	Indicates the interval between two consecutive burst instances.

Structure of FTM_SESSION_CFG TLV data

`ipv4_config`#

Field	Type	Description
`addr_type`	`enum address_types`	Set to ADDR_TYPE_DHCP to use DHCP to obtain the IP address or set to ADDR_TYPE_STATIC to use a static IP. In case of static IP address ip, gw, netmask and dns members should be specified. When using DHCP, the ip, gw, netmask and dns are overwritten by the values obtained from the DHCP server. They should be zeroed out if not used.
`address`	`unsigned`	The IP address of the system in network order.
`gw`	`unsigned`	The default gateway of the system in network order.
`netmask`	`unsigned`	The subnet mask of the system in network order.
`dns1`	`unsigned`	The primary DNS server of the system in network order.
`dns2`	`unsigned`	The secondary DNS server of the system in network order.

This data structure represents an IPv4 address

`ipv6_config`#

Field	Type	Description
`address`	`unsigned`	The IPv6 address of the system in network order.
`addr_type`	`unsigned char`	The address type: linklocal, site-local or global.
`addr_state`	`uint8_t`	The state of IPv6 address (Tentative, Preferred, and so on).

This data structure represents an IPv6 address

`location_cfg_info_t`#

Field	Type	Description
`lat_unc`	`t_u8`	Known latitude uncertainty.
`long_unc`	`t_u8`	Known longitude uncertainty.
`alt_unc`	`t_u8`	Known altitude uncertainty.
`lci_req`	`t_u8`	Include LCI request (expect LCI information from the responder).
`longitude`	`double`	Known longitude.
`latitude`	`double`	Known latitude.
`altitude`	`double`	Known altitude.

LCI (Location configuration information) data for 802.11az ranging

`location_civic_rep_t`#

Field	Type	Description
`civic_location_type`	`t_u8`	Civic location type.
`civic_address_type`	`t_u8`	Civic address type.
`civic_address_length`	`t_u8`	Civic address length.
`civic_req`	`t_u8`	Include an LCI request (Expect LCI info from the responder).
`country_code`	`t_u16`	Country code.

Civic location report for 802.11az ranging

`ranging_11az_cfg_t`#

Field	Type	Description
`format_bw`	`t_u8`	Indicates the channel BW for the session. • 0: HE20. • 1: HE40. • 2: HE80. • 3: HE80+80. • 4: HE160. • 5: HE160_SRF.
`max_i2r_sts_upto80`	`t_u8`	Indicates for bandwidths less than or equal to 80 MHz the maximum number of space-time streams to be used in DL/UL NDP frames in the session.
`max_r2i_sts_upto80`	`t_u8`	Indicates for bandwidths less than or equal to 80 MHz the maximum number of space-time streams to be used in DL/UL NDP frames in the session.
`az_measurement_freq`	`t_u8`	Specifies the measurement frequency in Hz to calculate the measurement interval.
`az_number_of_measurements`	`t_u8`	Indicates the number of measurements to be done for the session.
`i2r_lmr_feedback`	`t_u8`	Initiator lmr feedback.
`civic_req`	`t_u8`	Include location civic request (Expect location civic from responder).
`lci_req`	`t_u8`	Include an LCI request (Expect LCI info from the responder).

Structure of FTM_SESSION_CFG_NTB_RANGING/FTM_SESSION_CFG_TB_RANGING TLV data

`rx_pkt_he_rate_info`#

Field	Type	Description
`hemcs_rxcnt`	`t_u32`	Sum of RX packets for HE rate. The array index represents MCS0~MCS11, the following array indexes have the same effect.
`hestbcrate_rxcnt`	`t_u32`	Sum of RX STBC (space time block code) packets for HE rate.

Sum of RX packets for HE (802.11ax high efficiency) rate

`rx_pkt_ht_rate_info`#

Field	Type	Description
`htmcs_rxcnt`	`t_u32`	Sum of RX packets for HT rate. The array index represents MCS0~MCS15, the following array indexes have the same effect.
`htsgi_rxcnt`	`t_u32`	Sum of TX short GI (guard interval) packets for HT rate.
`htstbcrate_rxcnt`	`t_u32`	Sum of TX STBC (space time block code) packets for HT rate.

Sum of RX packets for HT (802.11n high throughput) rate

`rx_pkt_rate_info`#

Field	Type	Description
`nss_rxcnt`	`t_u32`	Sum of RX NSS (N*N MIMO spatial stream) packets. nss_txcnt[0] is for NSS 1, nss_txcnt[1] is for NSS 2.
`nsts_rxcnt`	`t_u32`	Sum of received packets for all STBC rates.
`bandwidth_rxcnt`	`t_u32`	Sum of received packets for three bandwidth types. bandwidth_rxcnt[0] is for 20 MHz, bandwidth_rxcnt[1] is for 40 MHz, bandwidth_rxcnt[2] is for 80 MHz.
`preamble_rxcnt`	`t_u32`	Sum of received packets for four preamble format types. preamble_txcnt[0] is for preamble format 0, preamble_txcnt[1] is for preamble format 1, preamble_txcnt[2] is for preamble format 2, preamble_txcnt[3] is for preamble format 3, preamble_txcnt[4] and preamble_txcnt[5] are as reserved.
`ldpc_txbfcnt`	`t_u32`	Sum of packets for TX LDPC packets.
`rssi_value`	`t_s32`	Average RSSI.
`rssi_chain0`	`t_s32`	RSSI value of path A.
`rssi_chain1`	`t_s32`	RSSI value of path B.

Sum of RX packets

`rx_pkt_vht_rate_info`#

Field	Type	Description
`vhtmcs_rxcnt`	`t_u32`	Sum of RX packets for VHT rate. The array index represents MCS0~MCS9, the following array indexes have the same effect.
`vhtsgi_rxcnt`	`t_u32`	Sum of RX short GI (guard interval) packets for VHT rate.
`vhtstbcrate_rxcnt`	`t_u32`	Sum of RX STBC (space time block code) packets for VHT rate.

Sum of RX packets for VHT (802.11ac very high throughput) rate

`tx_ampdu_prot_mode_para`#

Field	Type	Description
`mode`	`int`	TX AMPDU protection mode. • 0: Set RTS/CTS mode. • 1: Set CTS to self mode. • 2: Disable protection mode. • 3: Set dynamic RTS/CTS mode.

Set the protection mode for the transmit AMPDU packet

`tx_pkt_he_rate_info`#

Field	Type	Description
`hemcs_txcnt`	`t_u32`	Sum of TX packets for HE rate. The array index represents MCS0~MCS11, the following array indexes have the same effect.
`hestbcrate_txcnt`	`t_u32`	Sum of TX STBC (space time block code) packets for HE rate.

Sum of TX packets for HE (802.11ax high efficiency) rate

`tx_pkt_ht_rate_info`#

Field	Type	Description
`htmcs_txcnt`	`t_u32`	Sum of TX packets for HT rate. The array index represents MCS0~MCS15, the following array indexes have the same effect.
`htsgi_txcnt`	`t_u32`	Sum of TX short GI (guard interval) packets for HT rate.
`htstbcrate_txcnt`	`t_u32`	Sum of TX STBC (space time block code) packets for HT rate.

Sum of TX packets for HT (802.11n high throughput) rate

`tx_pkt_rate_info`#

Field	Type	Description
`nss_txcnt`	`t_u32`	Sum of TX NSS (N*N MIMO spatial stream) packets. nss_txcnt[0] is for NSS 1, nss_txcnt[1] is for NSS 2.
`bandwidth_txcnt`	`t_u32`	Sum of TX packets for three bandwidths. bandwidth_txcnt[0] is for 20 MHz, bandwidth_txcnt[1] is for 40 MHz, bandwidth_txcnt[2] is for 80 MHz.
`preamble_txcnt`	`t_u32`	Sum of RX packets for four preamble format types. preamble_txcnt[0] is for preamble format 0, preamble_txcnt[1] is for preamble format 1, preamble_txcnt[2] is for preamble format 2, preamble_txcnt[3] is for preamble format 3,.
`ldpc_txcnt`	`t_u32`	Sum of TX LDPC (low-density parity check) packets.
`rts_txcnt`	`t_u32`	Sum of TX RTS (request to send) packets.
`ack_RSSI`	`t_s32`	RSSI of ACK packet.

Sum of TX packets

`tx_pkt_vht_rate_info`#

Field	Type	Description
`vhtmcs_txcnt`	`t_u32`	Sum of TX packets for VHT rate. The array index represents MCS0~MCS9, the following array indexes have the same effect.
`vhtsgi_txcnt`	`t_u32`	Sum of TX short GI packets for HT mode.
`vhtstbcrate_txcnt`	`t_u32`	Sum of TX STBC (space time block code) packets for VHT mode.

Sum of TX packets for VHT (802.11ac very high throughput) rate

`wifi_scan_params_t`#

Field	Type	Description
`bssid`	`uint8_t *`	BSSID (basic service set ID).
`ssid`	`char *`	SSID (service set ID).
`channel`	`int`	Channel list.
`bss_type`	`IEEEtypes_Bss_t`	BSS (basic service set) type. • 1: Infrastructure BSS. • 2: Independent BSS.
`scan_duration`	`int`	Time for scan duration.
`split_scan_delay`	`int`	Split scan delay.

This structure is used to configure Wi-Fi scan parameters

`wlan_cck_desense_cfg`#

Field	Type	Description
`mode`	`t_u16`	CCK (complementary code keying) desense mode. • 0: Disable. • 1: Normal. • 2: Dynamic.
`margin`	`int`	Specifies the RSSI margin.
`ceil_thresh`	`int`	Specifies ceil RSSI threshold.
`num_on_intervals`	`int`	CCK (complementary code keying) desense “on” interval count.
`num_off_intervals`	`int`	CCK desense “off” interval count.

CCK (Complementary Code Keying) desensitization configuration

`wlan_cipher`#

Field	Type	Description
`none`	`uint16_t`	1 bit value can be set for none.
`wep40`	`uint16_t`	1 bit value can be set for wep40.
`wep104`	`uint16_t`	1 bit value can be set for wep104.
`tkip`	`uint16_t`	1 bit value can be set for tkip.
`ccmp`	`uint16_t`	1 bit value can be set for ccmp.
`aes_128_cmac`	`uint16_t`	1 bit value can be set for aes 128 cmac.
`gcmp`	`uint16_t`	1 bit value can be set for gcmp.
`sms4`	`uint16_t`	1 bit value can be set for sms4.
`gcmp_256`	`uint16_t`	1 bit value can be set for gcmp 256.
`ccmp_256`	`uint16_t`	1 bit value can be set for ccmp 256.
`rsvd`	`uint16_t`	1 bit is reserved.
`bip_gmac_128`	`uint16_t`	1 bit value can be set for bip gmac 128.
`bip_gmac_256`	`uint16_t`	1 bit value can be set for bip gmac 256.
`bip_cmac_256`	`uint16_t`	1 bit value can be set for bip cmac 256.
`gtk_not_used`	`uint16_t`	1 bit value can be set for gtk not used.
`rsvd2`	`uint16_t`	4 bits are reserved.

Wi-Fi cipher structure

`wlan_csi_proc_cfg`#

Field	Type	Description
`peer_mac`	`uint8_t`	Peer mac address.
`num_csi`	`uint8_t`	Number of CSI to process.
`packet_bandwidth`	`uint8_t`	CSI bandwidth: 20/40/80.
`packet_format`	`uint8_t`	CSI format: legacy/HT/VHT/HE.
`reference_update`	`uint8_t`	Reference Update.

CSI (Channel state information) ambient motion index processing configuration

`wlan_diag`#

Field	Type	Description
`hw_exception_count`	`uint32_t`	Number of hardware exceptions detected by the Wi-Fi driver; reserved, always 0.
`disconnection_count`	`uint32_t`	Number of disconnection events since driver initialization.
`disconnection_dur_sec`	`uint32_t`	Duration in seconds that the Wi-Fi interface has been in a disconnected state.

Wi-Fi diagnostic statistics

`wlan_ieeeps_config`#

Field	Type	Description
`ps_null_interval`	`t_u32`	The interval that STA sends a null packet.
`multiple_dtim_interval`	`t_u32`	The count of listen interval.
`listen_interval`	`t_u32`	Periodic interval that STA listens to AP beacons.
`adhoc_awake_period`	`t_u32`	Periodic awake period for adhoc networks.
`bcn_miss_timeout`	`t_u32`	Beacon miss timeout in milliseconds.
`delay_to_ps`	`t_s32`	The delay of enabling IEEE-PS in milliseconds.
`ps_mode`	`t_u32`	PS mode • 1: PS-auto mode. • 2: PS-poll mode. • 3: PS-null mode.

This structure is for IEEE PS (Power-save) configuration

`wlan_ip_config`#

Field	Type	Description
`ipv6`	`struct ipv6_config`	The network IPv6 address configuration that must be associated with this interface.
`ipv6_count`	`size_t`	The network IPv6 valid addresses count.
`ipv4`	`struct ipv4_config`	The network IPv4 address configuration that must be associated with this interface.

Network IP configuration. This data structure represents the network IP configuration for IPv4 as well as IPv6 addresses

`wlan_message`#

Field	Type	Description
`id`	`t_u16`	Message ID used to identify the message type.
`data`	`void *`	Message data pointer pointing to the data buffer associated with the message.

`wlan_nan_publish_params_t`#

Field	Type	Description
`service_name`	`char *`	Service name for NAN.
`ttl`	`unsigned int`	Time to live (in seconds); 0 = one TX only.
`freq`	`unsigned int`	Default frequency (defaultPublishChannel).
`freq_list`	`char *`	Multi-channel frequencies.
`srv_proto_type`	`nan_service_protocol_type_t`	NAN service protocol type.
`ssi`	`char *`	Service specific information (hexdump).

This structure is used to configure wlan nan publish parameters

`wlan_nan_subscribe_params_t`#

Field	Type	Description
`service_name`	`char *`	Service name for NAN.
`active`	`bool`	Subscribe type: true = active subscribe, false = passive subscribe.
`ttl`	`unsigned int`	Time to live (in seconds); 0 = until first result.
`freq`	`unsigned int`	Selected frequency.
`srv_proto_type`	`nan_service_protocol_type_t`	NAN service protocol type.
`ssi`	`char *`	Service specific information (hexdump).

This structure is used to configure wlan nan subscribe parameters

`wlan_network`#

Field	Type	Description
`id`	`int`	Identifier for network profile.
`wps_network`	`int`	WPS network flag.
`unspecified_network`	`int`	Unspecified network flag.
`name`	`char`	The name of this network profile. Each network profile that is added to the Wi-Fi connection manager must have a unique name.
`ssid`	`char`	The network SSID, represented as a C string of up to 32 characters in length. If this profile is used in the uAP mode, this field is used as the SSID of the network. If this profile is used in the station mode, this field is used to identify the network. Sets the first byte of the SSID to NULL (a 0-length string) to use only the BSSID to find the network.
`bssid`	`char`	The network BSSID, represented as a 6-byte array. If this profile is used in the uAP mode, this field is ignored. If this profile is used in the station mode, this field is used to identify the network. Sets all 6 bytes to 0 to use any BSSID, in which case only the SSID is used to find the network.
`channel`	`unsigned int`	The channel for this network.
`sec_channel_offset`	`uint8_t`	The secondary channel offset *.
`acs_band`	`uint16_t`	The ACS (auto channel selection) band if channel is set to 0.
`chan_list`	`uint8_t`	Array of channel list to scan or NULL for all.
`chan_list_len`	`uint8_t`	Number of channels in the channel list.
`rssi`	`int`	RSSI (received signal strength indicator) value.
`rssi_threshold`	`short`	Specifies RSSI threshold (dBm) for scan.
`select_policy`	`enum wlan_select_policy`	Network selection policy.
`priority`	`int`	Priority group.
`ssid_protection`	`bool`	SSID protection enabled flag.
`ht_capab`	`unsigned short`	HT capabilities info field within HT capabilities information element.
`vht_capab`	`unsigned int`	VHT capabilities info field within VHT capabilities information element.
`vht_oper_chwidth`	`unsigned char`	VHT bandwidth.
`he_oper_chwidth`	`unsigned char`	HE bandwidth.
`type`	`enum wlan_bss_type`	BSS type.
`role`	`enum wlan_bss_role`	The network Wi-Fi mode enum wlan_bss_role. Set this to specify what type of Wi-Fi network mode to use. This can either be WLAN_BSS_ROLE_STA for use in the station mode, or it can be WLAN_BSS_ROLE_UAP for use in the uAP mode.
`security`	`struct wlan_network_security`	The network security configuration specified by struct wlan_network_security for the network.
`ip`	`struct wlan_ip_config`	The network IP address configuration specified by struct wlan_ip_config that must be associated with this interface.
`ssid_specific`	`unsigned`	If set to 1, the ssid field contains the specific SSID for this network. the Wi-Fi connection manager can only connect to networks with matching SSID matches. If set to 0, the ssid field contents are not used when deciding whether to connect to a network or not. The BSSID field is used instead and any network with matching BSSID matches is accepted.
`trans_ssid_specific`	`unsigned`	If set to 1, the ssid field contains the transitional SSID for this network.
`bssid_specific`	`unsigned`	If set to 1, the bssid field contains the specific BSSID for this network. The Wi-Fi connection manager cannot connect to any other network with the same SSID unless the BSSID matches. If set to 0, the Wi-Fi connection manager can connect to any network whose SSID matches.
`channel_specific`	`unsigned`	If set to 1, the channel field contains the specific channel for this network. The Wi-Fi connection manager cannot look for this network on any other channel. If set to 0, the Wi-Fi connection manager can look for this network on any available channel.
`security_specific`	`unsigned`	If set to 0, any security that matches is used. This field is internally set when the security type parameter above is set to WLAN_SECURITY_WILDCARD.
`priority_specific`	`unsigned`	If set to 1, the priority field contains the specific priority for this network. This field can be used to change the order in which wpa_supplicant goes through the networks when selecting a BSS. If set to 0, all networks will get same priority group (0).
`ssid_protect_specific`	`unsigned`	If set to 1, the SSID protection of 4-way handshake will be enabled.
`dot11n`	`unsigned`	The network supports 802.11n.
`dot11ac`	`unsigned`	The network supports 802.11ac.
`dot11ax`	`unsigned`	The network supports 802.11ax.
`__pad0__`	`unsigned`
`ft_1x`	`unsigned`	The network uses FT 802.1x security.
`ft_psk`	`unsigned`	The network uses FT PSK security.
`ft_sae`	`unsigned`	The network uses FT SAE security.
`reserved5`	`unsigned`	Reserved.
`mdid`	`uint16_t`	Mobility Domain ID.
`owe_trans_mode`	`unsigned int`	OWE (opportunistic wireless encryption) Transition mode.
`trans_ssid`	`char`	The network transitional SSID, represented as a C string of up to 32 characters in length.
`trans_ssid_len`	`unsigned int`	Transitional SSID length.
`beacon_period`	`uint16_t`	Beacon period of associated BSS.
`dtim_period`	`uint8_t`	DTIM period of associated BSS.
`btm_mode`	`uint8_t`	BTM mode.
`bss_transition_supported`	`bool`	BSS transition support.
`neighbor_report_supported`	`bool`	Neighbor report support.
`twt_capab`	`bool`	TWT (Target Wake Time) capability flag indicating whether the associated BSS supports TWT.

Wi-Fi network profile This data structure represents a Wi-Fi network profile. It consists of an arbitrary name, Wi-Fi configuration, and IP address configuration. Every network profile is associated with one of the two interfaces. The network profile can be used for the station interface (i.e. to connect to an Access Point) by setting the role field to WLAN_BSS_ROLE_STA. The network profile can be used for the uAP interface (that is, to start its own network) by setting the mode field to WLAN_BSS_ROLE_UAP. If the mode field is WLAN_BSS_ROLE_STA, either of the SSID or BSSID fields are used to identify the network, while the other members like channel and security settings characterize the network. If the mode field is WLAN_BSS_ROLE_UAP, the SSID, channel, and security fields are used to define the network to be started. In both the above cases, the address field is used to determine the type of address assignment to be used for this interface.

`wlan_network_security`#

Field	Type	Description
`type`	`enum wlan_security_type`	Type of network security to use. Specified by the enum wlan_security_type.
`key_mgmt`	`int`	Key management type.
`mcstCipher`	`struct wlan_cipher`	Type of network security Group Cipher suite.
`ucstCipher`	`struct wlan_cipher`	Type of network security Pairwise Cipher suite.
`pkc`	`unsigned`	Proactive key caching.
`group_cipher`	`int`	Type of network security Group Cipher suite.
`pairwise_cipher`	`int`	Type of network security Pairwise Cipher suite.
`group_mgmt_cipher`	`int`	Type of network security Pairwise Cipher suite.
`is_pmf_required`	`bool`	Use when PMF (protected management frame) is required.
`psk`	`char`	Pre-shared key (network password). For WEP networks this is a hex byte sequence of length psk_len, for WPA and WPA2 networks this is an ASCII pass-phrase of length psk_len. This field is ignored for networks with no security.
`psk_len`	`uint8_t`	Length of the WEP key or WPA/WPA2 pass phrase, WLAN_PSK_MIN_LENGTH to WLAN_PSK_MAX_LENGTH. Ignored for networks with no security.
`password`	`char`	WPA3 SAE password, for WPA3 SAE networks this is an ASCII password of length password_len. This field is ignored for networks with no security.
`password_len`	`size_t`	Length of the WPA3 SAE Password, WLAN_PASSWORD_MIN_LENGTH to WLAN_PASSWORD_MAX_LENGTH. Ignored for networks with no security.
`sae_groups`	`char *`	Preference list of enabled groups for SAE. By default (if this parameter is not set), the mandatory group 19 (ECC group defined over a 256-bit prime order field) is preferred, but other groups are also enabled. If this parameter is set, the groups are tried in the indicated order.
`pwe_derivation`	`uint8_t`	SAE (Simultaneous authentication of equals) mechanism for PWE (Password Element) derivation.
`transition_disable`	`uint8_t`	Transition Disable indication.
`owe_groups`	`char *`	OWE Groups.
`pmk`	`char`	PMK (pairwise master key). When pmk_valid is set, this is the PMK calculated from the PSK for WPA/PSK networks. If pmk_valid is not set, this field is ignored. When adding networks with wlan_add_network, users can initialize PMK and set pmk_valid instead of setting the psk. After successfully connecting to a WPA/PSK network, users can call wlan_get_current_network to inspect pmk_valid and pmk. Therefore, the pmk value can be populated in subsequent calls to wlan_add_network. This saves the CPU time required to otherwise calculate the PMK.
`pmk_valid`	`bool`	Flag reports whether PMK is valid or not.
`mfpc`	`int8_t`	Management frame protection capable (MFPC).
`mfpr`	`int8_t`	Management frame protection required (MFPR).
`wpa3_ent`	`unsigned`	WPA3 Enterprise mode.
`wpa3_sb`	`unsigned`	WPA3 Enterprise Suite B mode.
`wpa3_sb_192`	`unsigned`	WPA3 Enterprise Suite B 192 mode.
`eap_ver`	`unsigned`	EAP (Extensible Authentication Protocol) version.
`peap_label`	`unsigned`	PEAP (Protected Extensible Authentication Protocol) label.
`eap_crypto_binding`	`uint8_t`	crypto_binding option can be used to control WLAN_SECURITY_EAP_PEAP_MSCHAPV2, WLAN_SECURITY_EAP_PEAP_TLS and WLAN_SECURITY_EAP_PEAP_GTC version 0 cryptobinding behavior: 0 = do not use cryptobinding (default) 1 = use cryptobinding if the server supports it 2 = require cryptobinding.
`eap_result_ind`	`unsigned`	eap_result_ind=1 can be used to enable WLAN_SECURITY_EAP_SIM, WLAN_SECURITY_EAP_AKA and WLAN_SECURITY_EAP_AKA_PRIME to use protected result indication.
`tls_cipher`	`unsigned char`	Cipher for EAP TLS (Extensible Authentication Protocol Transport Layer Security).
`identity`	`char`	Identity string for EAP.
`anonymous_identity`	`char`	Anonymous identity string for EAP.
`eap_password`	`char`	Password string for the EAP.
`verify_peer_cert`	`bool`	whether verify peer with CA or not false: not verify, true: verify.
`ca_cert_data`	`unsigned char *`	CA (certificate authority) certification blob (binary large object) in PEM (Base64 ASCII)/DER (binary) format.
`ca_cert_len`	`size_t`	CA (certificate authority) certification blob (binary large object) length.
`client_cert_data`	`unsigned char *`	Client certification blob (Binary Large Object) in PEM (Base64 ASCII)/DER (binary) format.
`client_cert_len`	`size_t`	Client certification blob (Binary Large Object) length.
`client_key_data`	`unsigned char *`	Client key blob (Binary Large Object).
`client_key_len`	`size_t`	Client key blob (Binary Large Object) length.
`client_key_passwd`	`char`	Client key password.
`ca_cert_hash`	`char`	CA certification Hash.
`domain_match`	`char`	Domain.
`domain_suffix_match`	`char`	Domain Suffix.
`ca_cert2_data`	`unsigned char *`	CA (certificate authority) certification blob (binary large object) in PEM (Base64 ASCII)/DER (binary) format for phase two.
`ca_cert2_len`	`size_t`	CA (certificate authority) certification blob (binary large object) length for phase two.
`client_cert2_data`	`unsigned char *`	Client certification blob (Binary Large Object) in PEM (Base64 ASCII)/DER (binary) format for phase two.
`client_cert2_len`	`size_t`	Client certification blob (Binary Large Object) length for phase two.
`client_key2_data`	`unsigned char *`	Client key blob (Binary Large Object) for phase two.
`client_key2_len`	`size_t`	Client key blob (Binary Large Object) length for phase two.
`client_key2_passwd`	`char`	Client key password for phase two.
`dh_data`	`unsigned char *`	DH (Diffie Hellman) parameters blob (Binary Large Object).
`dh_len`	`size_t`	DH (Diffie Hellman) parameters blob (Binary Large Object) length.
`server_cert_data`	`unsigned char *`	Server certification blob (Binary Large Object) in PEM (Base64 ASCII)/DER (binary) format.
`server_cert_len`	`size_t`	Server certification blob (Binary Large Object) length.
`server_key_data`	`unsigned char *`	Server key blob (Binary Large Object).
`server_key_len`	`size_t`	Server key blob (Binary Large Object) length.
`server_key_passwd`	`char`	Server key password.
`nusers`	`size_t`	Number of EAP users.
`identities`	`char`	User Identities.
`passwords`	`char`	User Passwords.
`pac_opaque_encr_key`	`char`	Encryption key for EAP-FAST PAC-Opaque values.
`a_id`	`char`	EAP-FAST authority identity (A-ID).
`fast_prov`	`uint8_t`	EAP-FAST provisioning modes: 0 = provisioning disabled 1 = only anonymous provisioning allowed 2 = only authenticated provisioning allowed 3 = both provisioning modes allowed (default).
`dpp_connector`	`unsigned char *`	DPP (device provisioning protocol) connector for DPP network access credentials.
`dpp_c_sign_key`	`unsigned char *`	DPP configurator sign key used to verify DPP configuration objects.
`dpp_net_access_key`	`unsigned char *`	DPP network access key used for DPP network connection authentication.

Network security configuration

`wlan_rx_abort_cfg`#

Field	Type	Description
`enable`	`t_u8`	Enable/Disable RX abort configuration.
`rssi_threshold`	`int`	RX weak RSSI threshold.

RX abort configuration for weak signal rejection

`wlan_rx_abort_cfg_ext`#

Field	Type	Description
`enable`	`int`	Enables or disables dyn RX abort on weak packet RSSI.
`rssi_margin`	`int`	Specifies the RSSI margin.
`ceil_rssi_threshold`	`int`	Specifies ceil RSSI threshold.
`floor_rssi_threshold`	`int`	Specifies floor RSSI threshold.
`current_dynamic_rssi_threshold`	`int`	Current dynamic RSSI threshold.
`rssi_default_config`	`int`	RSSI config: default or user-configured.
`edmac_enable`	`int`	EDMAC status.

Extended dynamic RX abort configuration

`wlan_scan_result`#

Field	Type	Description
`ssid`	`char`	The network SSID, represented as a NULL-terminated C string of 0 to 32 characters. If the network has a hidden SSID, this can be the empty string.
`ssid_len`	`unsigned int`	SSID length.
`bssid`	`char`	The network BSSID, represented as a 6-byte array.
`channel`	`unsigned int`	The network channel.
`type`	`enum wlan_bss_type`	The Wi-Fi network type.
`role`	`enum wlan_bss_role`	The Wi-Fi network mode.
`__pad0__`	`unsigned`
`dot11n`	`unsigned`	The network supports 802.11n. This is set to 0 if the network does not support 802.11n or if the system does not have 802.11n support enabled.
`dot11ac`	`unsigned`	The network supports 802.11ac. This is set to 0 if the network does not support 802.11ac or if the system does not have 802.11ac support enabled.
`dot11ax`	`unsigned`	The network supports 802.11ax. This is set to 0 if the network does not support 802.11ax or if the system does not have 802.11ax support enabled.
`wmm`	`unsigned`	The network supports WMM. This is set to 0 if the network does not support WMM or if the system does not have WMM support enabled.
`wps`	`unsigned`	The network supports WPS. This is set to 0 if the network does not support WPS or if the system does not have WPS support enabled.
`wep`	`unsigned`	The network uses WEP security.
`wpa`	`unsigned`	The network uses WPA security.
`wpa2`	`unsigned`	The network uses WPA2 security.
`wpa2_sha256`	`unsigned`	The network uses WPA2 SHA256 security.
`owe`	`unsigned`	The network uses OWE security.
`wpa3_sae`	`unsigned`	The network uses WPA3 SAE security.
`wpa2_entp`	`unsigned`	The network uses WPA2 Enterprise security.
`wpa3_entp`	`unsigned`	The network uses WPA3 Enterprise security.
`wpa3_1x_sha256`	`unsigned`	The network uses WPA3 Enterprise SHA256 security.
`wpa3_1x_sha384`	`unsigned`	The network uses WPA3 Enterprise SHA384 security.
`ft_1x`	`unsigned`	The network uses FT 802.1x security.
`ft_1x_sha384`	`unsigned`	The network uses FT 892.1x SHA384 security.
`ft_psk`	`unsigned`	The network uses FT PSK security.
`ft_sae`	`unsigned`	The network uses FT SAE security.
`__pad1__`	`unsigned`
`wps_session`	`unsigned int`	WPS Type WPS_SESSION_PBC/ WPS_SESSION_PIN.
`rssi`	`unsigned char`	The signal strength of the beacon.
`trans_ssid`	`char`	The network SSID, represented as a NULL-terminated C string of 0 to 32 characters. If the network has a hidden SSID, this must be the empty string.
`trans_ssid_len`	`unsigned int`	SSID length.
`trans_bssid`	`char`	The network BSSID, represented as a 6-byte array.
`beacon_period`	`uint16_t`	Beacon period.
`dtim_period`	`uint8_t`	DTIM (delivery traffic indication map) period.
`ap_mfpc`	`t_u8`	MFPC (Management Frame Protection Capable) bit of AP (Access Point).
`ap_mfpr`	`t_u8`	MFPR (Management Frame Protection Required) bit of AP (Access Point).
`ap_pwe`	`t_u8`	PWE (Password Element) bit of AP (Access Point).
`neighbor_report_supported`	`bool`	Neighbor report support.
`bss_transition_supported`	`bool`	Bss transition support.

Scan result

`wlan_tx_pert_info`#

Field	Type	Description
`tx_pert_check`	`t_u8`	Enable/Disable TX per tracking.
`tx_pert_check_peroid`	`t_u8`	Check period (unit sec).
`tx_pert_check_ratio`	`t_u8`	(Fail TX packet)/(Total TX packet) ratio (unit 10%) default: 5.
`tx_pert_check_num`	`t_u16`	A watermark of check number (default 5).

TX PER tracking structure Driver sets TX per tracking statistic to firmware. Firmware can check TX packet error rate periodically and report per to host if per is high.

`wlan_txrx_histogram_info`#

Field	Type	Description
`enable`	`t_u8`	Enables or disables.
`action`	`t_u16`	Choose to get TX, RX or both.

TX/RX packet rate histogram information

Enumerations#

Enum	Supported SoCs
`Chan2Offset_e`	All
`ChanBand_e`	All
`ChanWidth_e`	All
`IEEEtypes_Bss_t`	All
`ScanMode_e`	All
`_ENH_PS_MODES`	All
`_Host_Sleep_Action`	All
`address_types`	All
`cli_reset_option`	All
`eap_tls_cipher_type`	RW612, IW610
`nan_service_protocol_type_t`	RW612
`sub_event_id`	RW612, IW610
`wlan_connection_state`	All
`wlan_csi_opt`	RW612, IW610
`wlan_event_reason`	All
`wlan_frequency_bands`	All
`wlan_hostsleep_state`	RW612, IW610
`wlan_mef_type`	RW612, IW610
`wlan_mon_task_event`	All
`wlan_monitor_opt`	All
`wlan_ps_mode`	All
`wlan_ps_state`	All
`wlan_security_type`	All
`wlan_select_policy`	All
`wlan_wakeup_event_t`	All
`wm_wlan_errno`	All

Enumeration Documentation#

`Chan2Offset_e`#

Value	Description
`SECONDARY_CHAN_NONE`	No secondary channel
`SECONDARY_CHAN_ABOVE`	Secondary channel is above the primary channel
`SECONDARY_CHAN_BELOW`	The secondary channel is below the primary channel

`ChanBand_e`#

Value	Description
`Band_2_4_GHz`	2.4 GHz band
`Band_5_GHz`	5 GHz band
`Band_4_GHz`	4 GHz band

`ChanWidth_e`#

Value	Description
`ChanWidth_20_MHz`	20 MHz channel bandwidth
`ChanWidth_10_MHz`	10 MHz channel bandwidth
`ChanWidth_40_MHz`	40 MHz channel bandwidth
`ChanWidth_80_MHz`	80 MHz channel bandwidth

`IEEEtypes_Bss_t`#

Value	Description
`BSS_INFRASTRUCTURE`	Infrastructure BSS mode (STA connects to AP)
`BSS_INDEPENDENT`	Independent BSS mode (IBSS/Ad-hoc)
`BSS_ANY`	Any BSS type

`ScanMode_e`#

Value	Description
`MANUAL_MODE`	Manual channel selection mode
`ACS_MODE`	Auto channel selection (ACS) mode

`_ENH_PS_MODES`#

Value	Description
`GET_PS`	Get the current Power-save mode
`SLEEP_CONFIRM`	Sleep confirm command
`EXT_PS_PARAM`	Extended Power-save parameters
`DIS_AUTO_PS`	Disable auto Power-save mode
`EN_AUTO_PS`	Enable auto Power-save mode

`_Host_Sleep_Action`#

Value	Description
`HS_CONFIGURE`	Configure host sleep parameters
`HS_ACTIVATE`	Activate the host sleep mode

`address_types`#

Value	Description
`ADDR_TYPE_STATIC`	Static IP address
`ADDR_TYPE_DHCP`	Dynamic IP address
`ADDR_TYPE_LLA`	Link level address
`ADDR_TYPE_BRIDGE_MODE`	For Bridge Mode, no IP address

`cli_reset_option`#

Value	Description
`CLI_DISABLE_WIFI`	Disables the Wi-Fi driver
`CLI_ENABLE_WIFI`	Enables the Wi-Fi driver
`CLI_RESET_WIFI`	Reset the Wi-Fi driver

`eap_tls_cipher_type`#

Value	Description
`EAP_TLS_NONE`	No EAP TLS cipher suite
`EAP_TLS_ECC_P384`	EAP TLS with ECDH and ECDSA with p384.
`EAP_TLS_RSA_3K`	EAP TLS with ECDH and RSA with > 3K

`nan_service_protocol_type_t`#

Value	Description
`NAN_SERVICE_PROTO_BONJOUR`	Bonjour service discovery protocol
`NAN_SERVICE_PROTO_GENERIC`	Generic service protocol
`NAN_SERVICE_PROTO_CSA_MATTER`	CSA Matter protocol

`sub_event_id`#

Value	Description
`EVENT_SUB_RSSI_LOW`	Event ID for subscribe event RSSI low
`EVENT_SUB_RSSI_HIGH`	Event ID for subscribe event RSSI high
`EVENT_SUB_SNR_LOW`	Event ID for subscribe event snr low
`EVENT_SUB_SNR_HIGH`	Event ID for subscribe event snr high
`EVENT_SUB_MAX_FAIL`	Event ID for subscribe event max fail
`EVENT_SUB_BEACON_MISSED`	Event ID for subscribe event beacon missed
`EVENT_SUB_DATA_RSSI_LOW`	Event ID for subscribe event data RSSI low
`EVENT_SUB_DATA_RSSI_HIGH`	Event ID for subscribe event data RSSI high
`EVENT_SUB_DATA_SNR_LOW`	Event ID for subscribe event data snr low
`EVENT_SUB_DATA_SNR_HIGH`	Event ID for subscribe event data snr high
`EVENT_SUB_LINK_QUALITY`	Event ID for subscribe event link quality
`EVENT_SUB_PRE_BEACON_LOST`	Event ID for subscribe event pre_beacon_lost
`MAX_EVENT_ID`	Fail event ID

`wlan_connection_state`#

Value	Description
`WLAN_DISCONNECTED`	The Wi-Fi connection manager is not connected and no connection attempt is in progress. It is possible to connect to a network or scan.
`WLAN_CONNECTING`	The Wi-Fi connection manager is not connected but it is currently attempting to connect to a network. It is not possible to scan at this time. It is possible to connect to a different network.
`WLAN_ASSOCIATED`	The Wi-Fi connection manager is not connected but associated
`WLAN_AUTHENTICATED`	The Wi-Fi connection manager is not connected but authenticated
`WLAN_CONNECTED`	The Wi-Fi connection manager is connected. It is possible to scan and connect to another network at this time. Information about the current network configuration is available.
`WLAN_UAP_STARTED`	The Wi-Fi connection manager has started uAP
`WLAN_UAP_STOPPED`	The Wi-Fi connection manager has stopped uAP
`WLAN_SCANNING`	The Wi-Fi connection manager is not connected and network scan is in progress.
`WLAN_ASSOCIATING`	The Wi-Fi connection manager is not connected and network association is in progress.

`wlan_csi_opt`#

Value	Description
`CSI_FILTER_OPT_ADD`	Add a CSI filter entry
`CSI_FILTER_OPT_DELETE`	Delete a CSI filter entry
`CSI_FILTER_OPT_CLEAR`	Clear all CSI filter entries
`CSI_FILTER_OPT_DUMP`	Dump all CSI filter entries

`wlan_event_reason`#

Value	Description
`WLAN_REASON_SUCCESS`	The Wi-Fi connection manager has successfully connected to a network and is now in the WLAN_CONNECTED state.
`WLAN_REASON_AUTH_SUCCESS`	The Wi-Fi connection manager has successfully authenticated to a network and is now in the WLAN_ASSOCIATED state.
`WLAN_REASON_CONNECT_FAILED`	The Wi-Fi connection manager failed to connect before actual connection attempt with AP due to incorrect Wi-Fi network profile. or the Wi-Fi connection manager failed to reconnect to previously connected network and it is now in the WLAN_DISCONNECTED state.
`WLAN_REASON_NETWORK_NOT_FOUND`	The Wi-Fi connection manager could not find the network that it was connecting to and it is now in the WLAN_DISCONNECTED state.
`WLAN_REASON_BGSCAN_NETWORK_NOT_FOUND`	The Wi-Fi connection manager could not find the network in background scan during roam attempt that it was connecting to and it is now in the WLAN_CONNECTED state with previous AP.
`WLAN_REASON_NETWORK_AUTH_FAILED`	The Wi-Fi connection manager failed to authenticate with the network and is now in the WLAN_DISCONNECTED state.
`WLAN_REASON_ADDRESS_SUCCESS`	DHCP lease has been renewed
`WLAN_REASON_ADDRESS_FAILED`	The Wi-Fi connection manager failed to obtain an IP address or TCP stack configuration has failed or the IP address configuration was lost due to a DHCP error. The system is now in the WLAN_DISCONNECTED state.
`WLAN_REASON_LINK_LOST`	The Wi-Fi connection manager has lost the link to the current network
`WLAN_REASON_CHAN_SWITCH`	The Wi-Fi connection manager has received the channel switch announcement from the current network.
`WLAN_REASON_WPS_DISCONNECT`	The Wi-Fi connection manager has disconnected from the WPS network (or has canceled a connection attempt) by request and is now in the WLAN_DISCONNECTED state.
`WLAN_REASON_USER_DISCONNECT`	The Wi-Fi connection manager has disconnected from the current network (or has canceled a connection attempt) by request and is now in the WLAN_DISCONNECTED state.
`WLAN_REASON_INITIALIZED`	The Wi-Fi connection manager is initialized and is ready for use. That is, it’s now possible to scan or to connect to a network.
`WLAN_REASON_INITIALIZATION_FAILED`	The Wi-Fi connection manager has failed to initialize and is therefore not running. It is not possible to scan or to connect to a network. The Wi-Fi connection manager must be stopped and started again via wlan_stop() and wlan_start() respectively.
`WLAN_REASON_FW_HANG`	The Wi-Fi connection manager has entered in hang mode
`WLAN_REASON_FW_RESET`	The Wi-Fi connection manager has reset fw successfully
`WLAN_REASON_PS_ENTER`	The Wi-Fi connection manager has entered Power-save mode
`WLAN_REASON_PS_EXIT`	The Wi-Fi connection manager has exited from Power-save mode
`WLAN_REASON_UAP_SUCCESS`	The Wi-Fi connection manager has started uAP (micro access point)
`WLAN_REASON_UAP_CLIENT_ASSOC`	A Wi-Fi client has joined the uAP BSS network
`WLAN_REASON_UAP_CLIENT_CONN`	A Wi-Fi client has authenticated and connected to the uAP BSS network
`WLAN_REASON_UAP_CLIENT_DISSOC`	A Wi-Fi client has left the uAP BSS network
`WLAN_REASON_UAP_START_FAILED`	The Wi-Fi connection manager has failed to start uAP
`WLAN_REASON_UAP_STOP_FAILED`	The Wi-Fi connection manager has failed to stop uAP
`WLAN_REASON_UAP_STOPPED`	The Wi-Fi connection manager has stopped uAP
`WLAN_REASON_RSSI_LOW`	The Wi-Fi connection manager has received subscribed RSSI low event on station interface as per configured threshold and frequency. If CONFIG_11K, CONFIG_11V, CONFIG_11R or CONFIG_ROAMING enabled then RSSI low event is processed internally.
`WLAN_REASON_RSSI_HIGH`	The Wi-Fi connection manager has received subscribed RSSI high event on station interface as per configured threshold and frequency.
`WLAN_REASON_SNR_LOW`	The Wi-Fi connection manager has received subscribed SNR low event on station interface as per configured threshold and frequency.
`WLAN_REASON_SNR_HIGH`	The Wi-Fi connection manager has received subscribed SNR high event on station interface as per configured threshold and frequency.
`WLAN_REASON_MAX_FAIL`	The Wi-Fi connection manager has received subscribed maximum fail event on station interface as per configured threshold and frequency.
`WLAN_REASON_BEACON_MISSED`	The Wi-Fi connection manager has received subscribed beacon missed fail event on station interface as per configured threshold and frequency.
`WLAN_REASON_DATA_RSSI_LOW`	The Wi-Fi connection manager has received subscribed data RSSI low event on station interface as per configured threshold and frequency.
`WLAN_REASON_DATA_RSSI_HIGH`	The Wi-Fi connection manager has received subscribed data RSSI high event on station interface as per configured threshold and frequency.
`WLAN_REASON_DATA_SNR_LOW`	The Wi-Fi connection manager has received subscribed data SNR low event on station interface as per configured threshold and frequency.
`WLAN_REASON_DATA_SNR_HIGH`	The Wi-Fi connection manager has received subscribed data SNR high event on station interface as per configured threshold and frequency.
`WLAN_REASON_LINK_QUALITY`	The Wi-Fi connection manager has received subscribed link quality event on station interface as per configured link_snr threshold and frequency, link_rate threshold and frequency, link_tx_latency threshold and frequency
`WLAN_REASON_PRE_BEACON_LOST`	The Wi-Fi connection manager has received subscribed pre beacon lost event on station interface as per configured threshold and frequency.
`WLAN_REASON_SCAN_DONE`	Scan is done
`WLAN_REASON_WPS_SESSION_DONE`	WPS session is done

`wlan_frequency_bands`#

Value	Description
`WLAN_FREQ_BAND_2_4_GHZ`	2.4 GHz band
`WLAN_FREQ_BAND_5_GHZ`	5 GHz band
`WLAN_FREQ_BAND_BOTH`	All bands
`WLAN_FREQ_BAND_UNKNOWN`	Invalid frequency band

`wlan_hostsleep_state`#

Value	Description
`HOST_SLEEP_DISABLE`	Host sleep feature disabled
`HOST_SLEEP_ONESHOT`	Host sleep one-shot mode, automatically disabled after triggering once
`HOST_SLEEP_PERIODIC`	Host sleep periodic mode, enters sleep periodically

`wlan_mef_type`#

Value	Description
`MEF_TYPE_DELETE`	Delete MEF entry
`MEF_TYPE_PING`	Ping (ICMP echo request) filter
`MEF_TYPE_ARP`	ARP (Address Resolution Protocol) filter
`MEF_TYPE_MULTICAST`	Multicast filter
`MEF_TYPE_IPV6_NS`	IPv6 Neighbor Solicitation filter
`MEF_TYPE_END`	End of MEF type list

`wlan_mon_task_event`#

Value	Description
`HOST_SLEEP_HANDSHAKE`	Host sleep handshake event
`HOST_SLEEP_EXIT`	Host sleep exit event
`HOST_SLEEP_UART_NOTIFY`	Host sleep UART notify event
`HOST_SLEEP_HS_SKIP`	Host sleep handshake skip event
`WIFI_RECOVERY_REQ`	Wi-Fi recovery request event

`wlan_monitor_opt`#

Value	Description
`MONITOR_FILTER_OPT_ADD_MAC`	Add a MAC address to the monitor filter list
`MONITOR_FILTER_OPT_DELETE_MAC`	Delete a MAC address from the monitor filter list
`MONITOR_FILTER_OPT_CLEAR_MAC`	Clear all MAC addresses from the monitor filter list
`MONITOR_FILTER_OPT_DUMP`	Dump all MAC addresses in the monitor filter list

`wlan_ps_mode`#

Value	Description
`WLAN_ACTIVE`	Active mode
`WLAN_IEEE`	IEEE Power-save mode
`WLAN_DEEP_SLEEP`	Deep sleep Power-save mode
`WLAN_IEEE_DEEP_SLEEP`	IEEE and deep sleep Power-save mode

`wlan_ps_state`#

Value	Description
`PS_STATE_AWAKE`	Awake state, Wi-Fi is in normal operating mode
`PS_STATE_PRE_SLEEP`	Pre-sleep state, preparing to enter sleep
`PS_STATE_SLEEP_CFM`	Sleep confirm state, waiting for firmware to confirm sleep entry
`PS_STATE_SLEEP`	Sleep state, Wi-Fi is in low power sleep mode

`wlan_security_type`#

Value	Description
`WLAN_SECURITY_NONE`	The network does not use security
`WLAN_SECURITY_WEP_OPEN`	The network uses WEP security with open key
`WLAN_SECURITY_WEP_SHARED`	The network uses WEP security with shared key
`WLAN_SECURITY_WPA`	The network uses WPA security with PSK
`WLAN_SECURITY_WPA2`	The network uses WPA2 security with PSK
`WLAN_SECURITY_WPA_WPA2_MIXED`	The network uses WPA/WPA2 mixed security with PSK
`WLAN_SECURITY_WPA2_FT`	The network uses WPA2 security with PSK FT
`WLAN_SECURITY_WPA3_SAE`	The network uses WPA3 security with SAE
`WLAN_SECURITY_WPA3_FT_SAE`	The network uses WPA3 security with SAE FT
`WLAN_SECURITY_WPA3_SAE_EXT_KEY`	The network uses WPA3 security with new SAE AKM suite 24.
`WLAN_SECURITY_WPA2_WPA3_SAE_MIXED`	The network uses WPA2/WPA3 SAE mixed security with PSK
`WLAN_SECURITY_OWE_ONLY`	The network uses OWE only security without Transition mode support
`WLAN_SECURITY_EAP_TLS`	The network uses WPA2 Enterprise EAP-TLS security The identity field in the wlan_network structure is used
`WLAN_SECURITY_EAP_TLS_SHA256`	The network uses WPA2 Enterprise EAP-TLS SHA256 security. The identity field in the wlan_network structure is used
`WLAN_SECURITY_EAP_TLS_FT`	The network uses WPA2 Enterprise EAP-TLS FT security. The identity field in the wlan_network structure is used
`WLAN_SECURITY_EAP_TLS_FT_SHA384`	The network uses WPA2 Enterprise EAP-TLS FT SHA384 security The identity field in the wlan_network structure is used
`WLAN_SECURITY_EAP_TTLS`	The network uses WPA2 Enterprise EAP-TTLS security. The identity field in the wlan_network structure is used
`WLAN_SECURITY_EAP_TTLS_MSCHAPV2`	The network uses WPA2 Enterprise EAP-TTLS-MSCHAPV2 security. The anonymous identity, identity and password fields in the wlan_network structure are used
`WLAN_SECURITY_EAP_PEAP_MSCHAPV2`	The network uses WPA2 Enterprise EAP-PEAP-MSCHAPV2 security. The anonymous identity, identity and password fields in the wlan_network structure are used
`WLAN_SECURITY_EAP_PEAP_TLS`	The network uses WPA2 Enterprise EAP-PEAP-TLS security. The anonymous identity, identity and password fields in the wlan_network structure are used
`WLAN_SECURITY_EAP_PEAP_GTC`	The network uses WPA2 Enterprise EAP-PEAP-GTC security. The anonymous identity, identity and password fields in the wlan_network structure are used
`WLAN_SECURITY_EAP_FAST_MSCHAPV2`	The network uses WPA2 Enterprise EAP-FAST-MSCHAPV2 security. The anonymous identity, identity and password fields in the wlan_network structure are used
`WLAN_SECURITY_EAP_FAST_GTC`	The network uses WPA2 Enterprise EAP-FAST-GTC security The anonymous identity, identity and password fields in the wlan_network structure are used
`WLAN_SECURITY_EAP_SIM`	The network uses WPA2 Enterprise EAP-SIM security The identity and password fields in the wlan_network structure are used
`WLAN_SECURITY_EAP_AKA`	The network uses WPA2 Enterprise EAP-AKA security The identity and password fields in the wlan_network structure are used
`WLAN_SECURITY_EAP_AKA_PRIME`	The network uses WPA2 Enterprise EAP-AKA-PRIME security The identity and password fields in the wlan_network structure are used
`WLAN_SECURITY_DPP`	The network uses DPP security with NAK(Net Access Key)
`WLAN_SECURITY_WILDCARD`	The network can use any security method. This security method is often used when the user only knows the name and passphrase but not the security type.

`wlan_select_policy`#

Value	Description
`WLAN_SELECT_POLICY_MANUAL`	Manual network selection: user selects the network explicitly
`WLAN_SELECT_POLICY_AUTO`	Automatic network selection: driver selects the best network automatically

`wlan_wakeup_event_t`#

Value	Description
`WAKE_ON_ALL_BROADCAST`	Wake-up on broadcast
`WAKE_ON_UNICAST`	Wake-up on unicast
`WAKE_ON_MAC_EVENT`	Wake-up on MAC event
`WAKE_ON_MULTICAST`	Wake-up on multicast
`WAKE_ON_ARP_BROADCAST`	Wake-up on ARP broadcast
`WAKE_ON_MGMT_FRAME`	Wake-up on receiving a management frame

`wm_wlan_errno`#

Value	Description
`WM_E_WLAN_ERRNO_BASE`
`WLAN_ERROR_FW_DNLD_FAILED`	The firmware download operation failed
`WLAN_ERROR_FW_NOT_READY`	The firmware ready register not set
`WLAN_ERROR_CARD_NOT_DETECTED`	The Wi-Fi SoC not found
`WLAN_ERROR_FW_NOT_DETECTED`	The Wi-Fi Firmware is not found
`WLAN_BSSID_NOT_FOUND_IN_SCAN_LIST`	BSSID not found in scan list

Macros#

Macro	Value	Supported SoCs
`ACTION_GET`	`(0U)`	All
`ACTION_SET`	`(1)`	All
`ARG_UNUSED`	`(void)(x)`	All
`AZ_MEASUREMENT_FREQ`	`4 /* in 0.1 Hz increments */`	IW612
`AZ_NUMBER_OF_MEASUREMENTS`	`6`	IW612
`A_ID_MAX_LENGTH`	`33U`	All
`BIN_COUNTER_LEN`	`(7)`	All
`BURST_DURATION`	`11`	IW612
`BURST_EXP`	`3`	IW612
`BURST_PERIOD`	`10`	IW612
`BW`	`13 /* RW610 only allows 20M bandwidth */`	IW612
`CARD_WAKEUP_GPIO_PIN`	`13`	All
`CCK_DESENSE_MODE_DISABLED`	`0`	RW612, IW610
`CCK_DESENSE_MODE_DYNAMIC`	`1`	RW612, IW610
`CCK_DESENSE_MODE_DYN_ENH`	`2`	RW612, IW610
`CIVIC_ADDRESS_TYPE`	`22`	IW612
`CIVIC_COUNTRY_CODE`	`0 /* US */`	IW612
`CIVIC_LOCATION`	`1`	IW612
`CIVIC_LOCATION_TYPE`	`1`	IW612
`CIVIC_REQUEST`	`1`	IW612
`COEX_PTA_FEATURE_DISABLE`	`0`	RW612
`COEX_PTA_FEATURE_ENABLE`	`1`	RW612
`DFS_REC_HDR_LEN`	`(8)`	All
`DFS_REC_HDR_NUM`	`(10)`	All
`DISABLE_TX_RX_HISTOGRAM`	`0x00`	All
`DOMAIN_MATCH_MAX_LENGTH`	`64U`	All
`ENABLE_TX_RX_HISTOGRAM`	`0x01`	All
`EU_CRYPTO_AAD_MAX_LENGTH`	`32U`	All
`EU_CRYPTO_DATA_MAX_LENGTH`	`1300U`	All
`EU_CRYPTO_KEYIV_MAX_LENGTH`	`32U`	All
`EU_CRYPTO_KEY_MAX_LENGTH`	`32U`	All
`EU_CRYPTO_NONCE_MAX_LENGTH`	`14U`	All
`EXT_COEX_PTA_INTERFACE`	`5`	RW612
`EXT_COEX_WCI2_GPIO_INTERFACE`	`7`	RW612
`EXT_COEX_WCI2_INTERFACE`	`6`	RW612
`FILE_TYPE_ENTP_CA_CERT`	`1`	RW612, IW610
`FILE_TYPE_ENTP_CA_CERT2`	`4`	RW612, IW610
`FILE_TYPE_ENTP_CLIENT_CERT`	`2`	RW612, IW610
`FILE_TYPE_ENTP_CLIENT_CERT2`	`5`	RW612, IW610
`FILE_TYPE_ENTP_CLIENT_KEY`	`3`	RW612, IW610
`FILE_TYPE_ENTP_CLIENT_KEY2`	`6`	RW612, IW610
`FILE_TYPE_ENTP_DH_PARAMS`	`10`	RW612, IW610
`FILE_TYPE_ENTP_SERVER_CERT`	`8`	RW612, IW610
`FILE_TYPE_ENTP_SERVER_KEY`	`9`	RW612, IW610
`FILE_TYPE_NONE`	`0`	RW612, IW610
`FLAG_RX_HISTOGRAM`	`0x02`	All
`FLAG_TX_HISTOGRAM`	`0x01`	All
`FORMAT_BW`	`2 /* RW610 only allows 20M bandwidth */`	IW612
`FOR_RANGING`	`0`	IW612
`FTM_ACTION_START`	`1`	IW612
`FTM_ACTION_STOP`	`2`	IW612
`FTM_PER_BURST`	`5`	IW612
`GET_TX_RX_HISTOGRAM`	`0x02`	All
`HASH_MAX_LENGTH`	`40U`	All
`HOST_WAKEUP_GPIO_PIN`	`12`	All
`I2R_LMR_FEEDBACK`	`0 /* allow RSTA to request I2R reporting */`	IW612
`IDENTITY_MAX_LENGTH`	`64U`	All
`IEEEtypes_ADDRESS_SIZE`	`6`	All
`IEEEtypes_SSID_SIZE`	`32U`	All
`IS_ASAP`	`1`	IW612
`LCI_ALTITUDE`	`11.2`	IW612
`LCI_ALTITUDE_UNCERTAINITY`	`15`	IW612
`LCI_LATITIUDE`	`-33.8570095`	IW612
`LCI_LATITUDE_UNCERTAINITY`	`18`	IW612
`LCI_LONGITUDE`	`151.2152005`	IW612
`LCI_LONGITUDE_UNCERTAINITY`	`18`	IW612
`LCI_REQUEST`	`1`	IW612
`MAX_CHANNEL_LIST`	`6`	All
`MAX_I2R_STS_UPTO80`	`0 /* RW610 only allows to send 1 N_STS*/`	IW612
`MAX_R2I_STS_UPTO80`	`0`	IW612
`MAX_SAMP_TIMING`	`200`	RW612
`MAX_USERS`	`8U`	All
`MIN_DELTA`	`60`	IW612
`MIN_SAMP_TIMING`	`20`	RW612
`NUM_CHAN_BAND_ENUMS`	`3`	All
`PAC_OPAQUE_ENCR_KEY_MAX_LENGTH`	`33U`	All
`PASSWORD_MAX_LENGTH`	`128U`	All
`POL_GRANT_PIN_HIGH`	`0`	RW612
`POL_GRANT_PIN_LOW`	`1`	RW612
`PROTO_DOT11AZ_NTB`	`1`	IW612
`PROTO_DOT11AZ_TB`	`2`	IW612
`PROTO_DOT11MC`	`0`	IW612
`SAMPLE_TIMING_VALUE`	`100`	RW612
`STATE_INPUT_DISABLE`	`0`	RW612
`STATE_PRIORITY_PIN`	`2`	RW612
`STATE_PTA_PIN`	`1`	RW612
`TX_AMPDU_CTS_2_SELF`	`1`	RW612, IW610
`TX_AMPDU_DISABLE_PROTECTION`	`2`	RW612, IW610
`TX_AMPDU_DYNAMIC_RTS_CTS`	`3`	RW612, IW610
`TX_AMPDU_RTS_CTS`	`0`	RW612, IW610
`UNSPEC_WPS_NETWORK`	`MBIT(0)`	All
`WLAN_11D_SCAN_LIMIT`	`3U`	All
`WLAN_AMPDU_DENSITY`	`0x30`	RW612, IW610
`WLAN_AMPDU_MMSF`	`0x6`	RW612, IW610
`WLAN_BANDCFG_11AC`	`MBIT(1)`	RW612, IW610, IW612
`WLAN_BANDCFG_11AX`	`MBIT(2)`	RW612, IW610, IW612
`WLAN_BANDCFG_11N`	`MBIT(0)`	All
`WLAN_CIPHER_AES_128_CMAC`	`MBIT(5)`	All
`WLAN_CIPHER_BIP_CMAC_256`	`MBIT(13)`	All
`WLAN_CIPHER_BIP_GMAC_128`	`MBIT(11)`	All
`WLAN_CIPHER_BIP_GMAC_256`	`MBIT(12)`	All
`WLAN_CIPHER_CCMP`	`MBIT(4)`	All
`WLAN_CIPHER_CCMP_256`	`MBIT(9)`	All
`WLAN_CIPHER_GCMP`	`MBIT(6)`	All
`WLAN_CIPHER_GCMP_256`	`MBIT(8)`	All
`WLAN_CIPHER_GTK_NOT_USED`	`MBIT(14)`	All
`WLAN_CIPHER_NONE`	`MBIT(0)`	All
`WLAN_CIPHER_SMS4`	`MBIT(7)`	All
`WLAN_CIPHER_TKIP`	`MBIT(3)`	All
`WLAN_CIPHER_WEP104`	`MBIT(2)`	All
`WLAN_CIPHER_WEP40`	`MBIT(1)`	All
`WLAN_ERROR_ACTION`	`4`	All
`WLAN_ERROR_NOMEM`	`2`	All
`WLAN_ERROR_NONE`	`0`	All
`WLAN_ERROR_NOT_SUPPORTED`	`6`	All
`WLAN_ERROR_PARAM`	`1`	All
`WLAN_ERROR_PS_ACTION`	`5`	All
`WLAN_ERROR_STATE`	`3`	All
`WLAN_HOSTSLEEP_FAIL`	`3`	RW612, IW610
`WLAN_HOSTSLEEP_IN_PROCESS`	`2`	RW612, IW610
`WLAN_HOSTSLEEP_SUCCESS`	`1`	RW612, IW610
`WLAN_KEY_MGMT_CCKM`	`MBIT(14)`	All
`WLAN_KEY_MGMT_DPP`	`MBIT(23)`	All
`WLAN_KEY_MGMT_FILS_SHA256`	`MBIT(18)`	All
`WLAN_KEY_MGMT_FILS_SHA384`	`MBIT(19)`	All
`WLAN_KEY_MGMT_FT`	`(WLAN_KEY_MGMT_FT_PSK	WLAN_KEY_MGMT_FT_IEEE8021X

 WLAN_KEY_MGMT_FT_FILS_SHA256 | WLAN_KEY_MGMT_FT_FILS_SHA384)` | All |

Macro Documentation#

`ACTION_GET`#

Value: (0U)

Action GET

`ACTION_SET`#

Value: (1)

Action SET

`ARG_UNUSED`#

Value: (void)(x)

`AZ_MEASUREMENT_FREQ`#

Value: 4 /* in 0.1 Hz increments */

`AZ_NUMBER_OF_MEASUREMENTS`#

Value: 6

`A_ID_MAX_LENGTH`#

Value: 33U

Maximum length of the A-ID. The A-ID indicates the identity of the authority that issues PACs

`BIN_COUNTER_LEN`#

Value: (7)

`BURST_DURATION`#

Value: 11

`BURST_EXP`#

Value: 3

`BURST_PERIOD`#

Value: 10

`BW`#

Value: 13 /* RW610 only allows 20M bandwidth */

`CARD_WAKEUP_GPIO_PIN`#

Value: 13

`CCK_DESENSE_MODE_DISABLED`#

Value: 0

`CCK_DESENSE_MODE_DYNAMIC`#

Value: 1

`CCK_DESENSE_MODE_DYN_ENH`#

Value: 2

`CIVIC_ADDRESS_TYPE`#

Value: 22

`CIVIC_COUNTRY_CODE`#

Value: 0 /* US */

`CIVIC_LOCATION`#

Value: 1

`CIVIC_LOCATION_TYPE`#

Value: 1

`CIVIC_REQUEST`#

Value: 1

`COEX_PTA_FEATURE_DISABLE`#

Value: 0

`COEX_PTA_FEATURE_ENABLE`#

Value: 1

`DFS_REC_HDR_LEN`#

Value: (8)

`DFS_REC_HDR_NUM`#

Value: (10)

`DISABLE_TX_RX_HISTOGRAM`#

Value: 0x00

`DOMAIN_MATCH_MAX_LENGTH`#

Value: 64U

Maximum length of domain match

`ENABLE_TX_RX_HISTOGRAM`#

Value: 0x01

`EU_CRYPTO_AAD_MAX_LENGTH`#

Value: 32U

`EU_CRYPTO_DATA_MAX_LENGTH`#

Value: 1300U

`EU_CRYPTO_KEYIV_MAX_LENGTH`#

Value: 32U

`EU_CRYPTO_KEY_MAX_LENGTH`#

Value: 32U

`EU_CRYPTO_NONCE_MAX_LENGTH`#

Value: 14U

`EXT_COEX_PTA_INTERFACE`#

Value: 5

`EXT_COEX_WCI2_GPIO_INTERFACE`#

Value: 7

`EXT_COEX_WCI2_INTERFACE`#

Value: 6

`FILE_TYPE_ENTP_CA_CERT`#

Value: 1

`FILE_TYPE_ENTP_CA_CERT2`#

Value: 4

`FILE_TYPE_ENTP_CLIENT_CERT`#

Value: 2

`FILE_TYPE_ENTP_CLIENT_CERT2`#

Value: 5

`FILE_TYPE_ENTP_CLIENT_KEY`#

Value: 3

`FILE_TYPE_ENTP_CLIENT_KEY2`#

Value: 6

`FILE_TYPE_ENTP_DH_PARAMS`#

Value: 10

`FILE_TYPE_ENTP_SERVER_CERT`#

Value: 8

`FILE_TYPE_ENTP_SERVER_KEY`#

Value: 9

`FILE_TYPE_NONE`#

Value: 0

`FLAG_RX_HISTOGRAM`#

Value: 0x02

`FLAG_TX_HISTOGRAM`#

Value: 0x01

`FORMAT_BW`#

Value: 2 /* RW610 only allows 20M bandwidth */

`FOR_RANGING`#

Value: 0

`FTM_ACTION_START`#

Value: 1

`FTM_ACTION_STOP`#

Value: 2

`FTM_PER_BURST`#

Value: 5

`GET_TX_RX_HISTOGRAM`#

Value: 0x02

`HASH_MAX_LENGTH`#

Value: 40U

Maximum length of CA certification hash

`HOST_WAKEUP_GPIO_PIN`#

Value: 12

`I2R_LMR_FEEDBACK`#

Value: 0 /* allow RSTA to request I2R reporting */

`IDENTITY_MAX_LENGTH`#

Value: 64U

An enterprise identity can be up to 64 characters

`IEEEtypes_ADDRESS_SIZE`#

Value: 6

MAC Address length

`IEEEtypes_SSID_SIZE`#

Value: 32U

Maximum SSID length

`IS_ASAP`#

Value: 1

`LCI_ALTITUDE`#

Value: 11.2

`LCI_ALTITUDE_UNCERTAINITY`#

Value: 15

`LCI_LATITIUDE`#

Value: -33.8570095

`LCI_LATITUDE_UNCERTAINITY`#

Value: 18

`LCI_LONGITUDE`#

Value: 151.2152005

`LCI_LONGITUDE_UNCERTAINITY`#

Value: 18

`LCI_REQUEST`#

Value: 1

`MAX_CHANNEL_LIST`#

Value: 6

Configuration for Wi-Fi scan

`MAX_I2R_STS_UPTO80`#

Value: 0 /* RW610 only allows to send 1 N_STS*/

`MAX_R2I_STS_UPTO80`#

Value: 0

`MAX_SAMP_TIMING`#

Value: 200

`MAX_USERS`#

Value: 8U

Maximum identities for EAP server users

`MIN_DELTA`#

Value: 60

`MIN_SAMP_TIMING`#

Value: 20

`NUM_CHAN_BAND_ENUMS`#

Value: 3

`PAC_OPAQUE_ENCR_KEY_MAX_LENGTH`#

Value: 33U

Maximum length of encryption key for EAP-FAST PAC-Opaque values

`PASSWORD_MAX_LENGTH`#

Value: 128U

An enterprise password can be up to 128 characters

`POL_GRANT_PIN_HIGH`#

Value: 0

`POL_GRANT_PIN_LOW`#

Value: 1

`PROTO_DOT11AZ_NTB`#

Value: 1

`PROTO_DOT11AZ_TB`#

Value: 2

`PROTO_DOT11MC`#

Value: 0

`SAMPLE_TIMING_VALUE`#

Value: 100

`STATE_INPUT_DISABLE`#

Value: 0

`STATE_PRIORITY_PIN`#

Value: 2

`STATE_PTA_PIN`#

Value: 1

`TX_AMPDU_CTS_2_SELF`#

Value: 1

`TX_AMPDU_DISABLE_PROTECTION`#

Value: 2

`TX_AMPDU_DYNAMIC_RTS_CTS`#

Value: 3

`TX_AMPDU_RTS_CTS`#

Value: 0

`UNSPEC_WPS_NETWORK`#

Value: MBIT(0)

When the temporary network is of type WPS, bit 0 is 1.

`WLAN_11D_SCAN_LIMIT`#

Value: 3U

`WLAN_AMPDU_DENSITY`#

Value: 0x30

`WLAN_AMPDU_MMSF`#

Value: 0x6

`WLAN_BANDCFG_11AC`#

Value: MBIT(1)

`WLAN_BANDCFG_11AX`#

Value: MBIT(2)

`WLAN_BANDCFG_11N`#

Value: MBIT(0)

`WLAN_CIPHER_AES_128_CMAC`#

Value: MBIT(5)

`WLAN_CIPHER_BIP_CMAC_256`#

Value: MBIT(13)

`WLAN_CIPHER_BIP_GMAC_128`#

Value: MBIT(11)

`WLAN_CIPHER_BIP_GMAC_256`#

Value: MBIT(12)

`WLAN_CIPHER_CCMP`#

Value: MBIT(4)

`WLAN_CIPHER_CCMP_256`#

Value: MBIT(9)

`WLAN_CIPHER_GCMP`#

Value: MBIT(6)

`WLAN_CIPHER_GCMP_256`#

Value: MBIT(8)

`WLAN_CIPHER_GTK_NOT_USED`#

Value: MBIT(14)

`WLAN_CIPHER_NONE`#

Value: MBIT(0)

`WLAN_CIPHER_SMS4`#

Value: MBIT(7)

`WLAN_CIPHER_TKIP`#

Value: MBIT(3)

`WLAN_CIPHER_WEP104`#

Value: MBIT(2)

`WLAN_CIPHER_WEP40`#

Value: MBIT(1)

`WLAN_ERROR_ACTION`#

Value: 4

The operation failed due to an internal error

`WLAN_ERROR_NOMEM`#

Value: 2

The operation could not be performed because there is not enough memory

`WLAN_ERROR_NONE`#

Value: 0

Error codes The operation was successful

`WLAN_ERROR_NOT_SUPPORTED`#

Value: 6

The requested feature is not supported

`WLAN_ERROR_PARAM`#

Value: 1

The operation failed due to an error with one or more parameters

`WLAN_ERROR_PS_ACTION`#

Value: 5

The operation to change the power state could not be performed

`WLAN_ERROR_STATE`#

Value: 3

The operation could not be performed in the current system state

`WLAN_HOSTSLEEP_FAIL`#

Value: 3

`WLAN_HOSTSLEEP_IN_PROCESS`#

Value: 2

`WLAN_HOSTSLEEP_SUCCESS`#

Value: 1

`WLAN_KEY_MGMT_CCKM`#

Value: MBIT(14)

`WLAN_KEY_MGMT_DPP`#

Value: MBIT(23)

`WLAN_KEY_MGMT_FILS_SHA256`#

Value: MBIT(18)

`WLAN_KEY_MGMT_FILS_SHA384`#

Value: MBIT(19)

`WLAN_KEY_MGMT_FT`#

Fast BSS Transition(11r) key management

`WLAN_KEY_MGMT_FT_FILS_SHA256`#

Value: MBIT(20)

`WLAN_KEY_MGMT_FT_FILS_SHA384`#

Value: MBIT(21)

`WLAN_KEY_MGMT_FT_IEEE8021X`#

Value: MBIT(5)

`WLAN_KEY_MGMT_FT_IEEE8021X_SHA384`#

Value: MBIT(24)

`WLAN_KEY_MGMT_FT_PSK`#

Value: MBIT(6)

`WLAN_KEY_MGMT_FT_SAE`#

Value: MBIT(11)

`WLAN_KEY_MGMT_IEEE8021X`#

Value: MBIT(0)

`WLAN_KEY_MGMT_IEEE8021X_NO_WPA`#

Value: MBIT(3)

`WLAN_KEY_MGMT_IEEE8021X_SHA256`#

Value: MBIT(7)

`WLAN_KEY_MGMT_IEEE8021X_SUITE_B`#

Value: MBIT(16)

`WLAN_KEY_MGMT_IEEE8021X_SUITE_B_192`#

Value: MBIT(17)

`WLAN_KEY_MGMT_NONE`#

Value: MBIT(2)

`WLAN_KEY_MGMT_OSEN`#

Value: MBIT(15)

`WLAN_KEY_MGMT_OWE`#

Value: MBIT(22)

`WLAN_KEY_MGMT_PASN`#

Value: MBIT(25)

`WLAN_KEY_MGMT_PSK`#

Value: MBIT(1)

`WLAN_KEY_MGMT_PSK_SHA256`#

Value: MBIT(8)

`WLAN_KEY_MGMT_SAE`#

Value: MBIT(10)

`WLAN_KEY_MGMT_SAE_EXT_KEY`#

Value: MBIT(26)

`WLAN_KEY_MGMT_WAPI_CERT`#

Value: MBIT(13)

`WLAN_KEY_MGMT_WAPI_PSK`#

Value: MBIT(12)

`WLAN_KEY_MGMT_WPA_NONE`#

Value: MBIT(4)

`WLAN_KEY_MGMT_WPS`#

Value: MBIT(9)

`WLAN_MAC_ADDR_LENGTH`#

Value: 6

`WLAN_MAX_KNOWN_NETWORKS`#

Value: CONFIG_WLAN_KNOWN_NETWORKS

The size of the list of known networks maintained by the Wi-Fi connection manager

`WLAN_MAX_STA_FILTER_NUM`#

Value: 16

`WLAN_MGMT_ACTION`#

Value: MBIT(13)

Bitmap for Action frame

`WLAN_MGMT_AUTH`#

Value: MBIT(11)

`WLAN_MGMT_DEAUTH`#

Value: MBIT(12)

`WLAN_MGMT_DIASSOC`#

Value: MBIT(10)

`WLAN_MGMT_PROBE_RQST`#

Value: MBIT(4)

`WLAN_NETWORK_CHAN_LIST_MAX`#

Value: 50U

Maximum number of channels storable in a scan channel list of a network

`WLAN_NETWORK_NAME_MAX_LENGTH`#

Value: 32U

Maximum length for network names. See wlan_network.

`WLAN_NETWORK_NAME_MIN_LENGTH`#

Value: 1U

Minimum length for network names, see wlan_network.

`WLAN_PASSWORD_MAX_LENGTH`#

Value: 255U

A WPA3 password can be up to 255 ASCII characters

`WLAN_PASSWORD_MIN_LENGTH`#

Value: 8U

A WPA3 password must be at least 8 ASCII characters

`WLAN_PMK_LENGTH`#

Value: 32

Length of a pairwise master key (PMK). It’s always 256 bits (32 Bytes)

`WLAN_PSK_MAX_LENGTH`#

Value: 64U

Maximum WPA2 passphrase can be up to 63 ASCII chars + 1 ‘\0’ char

`WLAN_PSK_MIN_LENGTH`#

Value: 8U

A WPA2 passphrase must be at least 8 ASCII characters

`WLAN_REASON_CODE_PREV_AUTH_NOT_VALID`#

Value: 2U

`WLAN_RECONNECT_LIMIT`#

Value: CONFIG_MAX_RECONNECT_LIMIT

The number of times that the Wi-Fi connection manager attempts a reconnection with the network before giving up.

`WLAN_RESCAN_LIMIT`#

Value: CONFIG_MAX_RESCAN_LIMIT

The number of times that the Wi-Fi connection manager looks for a network before giving up.

`WLAN_STATS_GET`#

Value: (priv->x)

`WLAN_STATS_INC`#

Value: (++(priv->x))

Wi-Fi statistics

`WMM_UAPSD_QOS_INFO`#

Value: 0x0F

`WMM_UAPSD_SLEEP_PERIOD`#

Value: 20

`Z_INFO`#

Value: 0

`wlcm_d`#

Functions#

Initialization & Lifecycle#

Function	Supported SoCs
`wlan_basic_cli_deinit`	All
`wlan_basic_cli_init`	All
`wlan_cli_deinit`	All
`wlan_cli_init`	All
`wlan_deinit`	All
`wlan_destroy_all_tasks`	All
`wlan_enhanced_cli_deinit`	All
`wlan_enhanced_cli_init`	All
`wlan_init`	All
`wlan_reset`	All
`wlan_start`	All
`wlan_stop`	All
`wlan_wfa_basic_cli_deinit`	All
`wlan_wfa_basic_cli_init`	All

`wlan_basic_cli_deinit`#

int wlan_basic_cli_deinit (void **)

Unregister basic Wi-Fi CLI commands.

Returns

WLAN_ERROR_NONE if the CLI commands were unregistered.
WLAN_ERROR_ACTION if they were not unregistered (for example. if this function was called while the CLI commands were not registered or were already unregistered).

`wlan_basic_cli_init`#

int wlan_basic_cli_init (void **)

Registers basic Wi-Fi CLI (command line input) commands.

Returns

WLAN_ERROR_NONE if the CLI commands were registered.
WLAN_ERROR_ACTION if they were not registered (for example. if this function was called while the CLI commands were already registered).

`wlan_cli_deinit`#

int wlan_cli_deinit (void **)

Unregister Wi-Fi CLI commands.

Returns

WM_SUCCESS if the CLI commands were unregistered or.
-WM_FAIL if they were not (for example if this function was called while the CLI commands were already unregistered).

`wlan_cli_init`#

int wlan_cli_init (void **)

Registers Wi-Fi CLI (command line input) commands.

Returns

WM_SUCCESS if the CLI commands were registered or.
-WM_FAIL if they were not (for example if this function was called while the CLI commands were already registered).

`wlan_deinit`#

void wlan_deinit (int *action*)

Deinitialize the Wi-Fi driver, send a shutdown command to the Wi-Fi firmware and delete the Wi-Fi driver thread.

Parameters

Parameter	In/Out	Description
`action`	in	Additional action to be taken with deinit. Should input 0 here.

`wlan_destroy_all_tasks`#

void wlan_destroy_all_tasks (void **)

This API destroys all tasks.

`wlan_enhanced_cli_deinit`#

int wlan_enhanced_cli_deinit (void **)

Unregister Wi-Fi enhanced CLI commands.

Returns

WM_SUCCESS if the CLI commands were unregistered or.
-WM_FAIL if they were not unregistered.

`wlan_enhanced_cli_init`#

int wlan_enhanced_cli_init (void **)

Registers Wi-Fi enhanced CLI commands.

Returns

WM_SUCCESS if the CLI commands were registered or.
-WM_FAIL if they were not (for example if this function was called while the CLI commands were already registered).

`wlan_init`#

int wlan_init (const uint8_t * *fw_start_addr*, const size_t *size*)

Initialize the Wi-Fi driver and create the Wi-Fi driver thread.

Parameters

Parameter	In/Out	Description
`fw_start_addr`	in	Start address of the Wi-Fi firmware.
`size`	in	Size of the Wi-Fi firmware.

Returns

WM_SUCCESS if the Wi-Fi connection manager service has initialized successfully.
Negative value if initialization failed.

`wlan_reset`#

void wlan_reset (cli_reset_option *ResetOption*)

Resets the driver.

Parameters

Parameter	In/Out	Description
`ResetOption`	in	Option including enable, disable or reset Wi-Fi driver can be chosen.

`wlan_start`#

int wlan_start (int(*)(enum wlan_event_reason reason, void *data) *cb*)

Starts the Wi-Fi connection manager service.

Parameters

Parameter	In/Out	Description
`cb`	in	A pointer to a callback function that handles Wi-Fi events. All. further WLCMGR events can be notified in this callback. Refer to enum wlan_event_reason for the various events for which this callback is called.

Returns

WM_SUCCESS if the Wi-Fi connection manager service has started successfully.
-WM_E_INVAL if the cb pointer is NULL.
-WM_FAIL if an internal error occurred.
WLAN_ERROR_STATE if the Wi-Fi connection manager is already running.

`wlan_stop`#

int wlan_stop (void **)

Stops the Wi-Fi connection manager service.

Returns

WM_SUCCESS if the Wi-Fi connection manager service has been stopped successfully.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running.

`wlan_wfa_basic_cli_deinit`#

int wlan_wfa_basic_cli_deinit (void **)

Unregister WFA basic Wi-Fi CLI (command line input) commands.

Returns

WLAN_ERROR_NONE if the CLI commands were unregistered or.
WLAN_ERROR_ACTION if they were not unregistered.

`wlan_wfa_basic_cli_init`#

int wlan_wfa_basic_cli_init (void **)

Registers WFA basic Wi-Fi CLI (command line input) commands.

Returns

WLAN_ERROR_NONE if the CLI commands were registered or.
WLAN_ERROR_ACTION if they were not registered (for example if this function was called while the CLI commands were already registered).

Connection Management#

Function	Supported SoCs
`is_sta_associated`	All
`is_sta_connected`	All
`is_sta_ipv4_connected`	All
`is_sta_ipv6_connected`	All
`wlan_connect`	All
`wlan_connect_opt`	All
`wlan_disconnect`	All
`wlan_get_connection_state`	All
`wlan_is_started`	All
`wlan_reassociate`	All
`wlan_wlcmgr_send_msg`	All

`is_sta_associated`#

bool is_sta_associated (void **)

Retrieves the status information of the station interface.

Returns

TRUE if station interface is in or above the WLAN_ASSOCIATED state.
FALSE otherwise.

`is_sta_connected`#

bool is_sta_connected (void **)

Retrieves the status information of the station interface.

Returns

TRUE if station interface is in WLAN_CONNECTED state.
FALSE otherwise.

`is_sta_ipv4_connected`#

bool is_sta_ipv4_connected (void **)

Retrieves the status information of the IPv4 network of the station interface.

Returns

TRUE if ipv4 network of the station interface is in WLAN_CONNECTED state.
FALSE otherwise.

`is_sta_ipv6_connected`#

bool is_sta_ipv6_connected (void **)

Retrieves the status information of the IPv6 network of the station interface.

Returns

TRUE if ipv6 network of the station interface is in WLAN_CONNECTED state.
FALSE otherwise.

`wlan_connect`#

int wlan_connect (char * *name*)

Connect to a Wi-Fi network (access point).

Parameters

Parameter	In/Out	Description
`name`	in	A pointer to a string representing the name of the network to connect to.

Returns

WM_SUCCESS if a connection attempt was started successfully.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running.
-WM_E_INVAL if there are no known networks to connect to or the network specified by name is not in the list of known networks or network name is NULL.
-WM_FAIL if an internal error has occurred.

`wlan_connect_opt`#

int wlan_connect_opt (char * *name*, bool *skip_dfs*)

Connect to a Wi-Fi network (access point) with options.

Parameters

Parameter	In/Out	Description
`name`	in	A pointer to a string representing the name of the network to connect to.
`skip_dfs`	in	Option to skip DFS channel when doing scan.

Returns

WM_SUCCESS if a connection attempt was started successfully.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running.
-WM_E_INVAL if there are no known networks to connect to or the network specified by name is not in the list of known networks or network name is NULL.
-WM_FAIL if an internal error has occurred.

`wlan_disconnect`#

int wlan_disconnect (void **)

Disconnects from the current Wi-Fi network (access point).

Returns

WM_SUCCESS if successful.
WLAN_ERROR_STATE otherwise.

`wlan_get_connection_state`#

int wlan_get_connection_state (enum wlan_connection_state * *state*)

Retrieves the connection state of the station interface.

Parameters

Parameter	In/Out	Description
`state`	out	A pointer to the wlan_connection_state where the current connection state must be copied.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if state is NULL.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running.

`wlan_is_started`#

int wlan_is_started (void **)

Retrieves the status information of if Wi-Fi started.

Returns

TRUE if Wi-Fi network is started.
FALSE if not started.

`wlan_reassociate`#

int wlan_reassociate (void **)

Reassociates with a Wi-Fi network (access point).

Returns

WM_SUCCESS if a reassociation attempt was started successfully.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running. or Wi-Fi connection manager was not in WLAN_CONNECTED state.
-WM_E_INVAL if there are no known networks to connect to.
-WM_FAIL if an internal error has occurred.

`wlan_wlcmgr_send_msg`#

int wlan_wlcmgr_send_msg (enum wlan_bss_type *bss_type*, enum wifi_event *event*, enum wifi_event_reason *reason*, void * *data*)

Sends message to Wi-Fi connection manager thread.

Parameters

Parameter	In/Out	Description
`bss_type`	in
`event`	in	An event from wifi_event.
`reason`	in	A reason code.
`data`	in	A pointer to data buffer associated with event.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

Network Management#

Function	Supported SoCs
`wlan_add_network`	All
`wlan_get_network`	All
`wlan_get_network_byname`	All
`wlan_get_network_count`	All
`wlan_initialize_sta_network`	All
`wlan_remove_all_network_profiles`	All
`wlan_remove_all_networks`	All
`wlan_remove_network`	All

`wlan_add_network`#

int wlan_add_network (struct wlan_network * *network*)

Adds a network profile to the list of known networks.

Parameters

Parameter	In/Out	Description
`network`	in	A pointer to the wlan_network that can be copied to the list of known networks in the Wi-Fi connection manager successfully.

Returns

WM_SUCCESS if the contents pointed to by network have been added to the Wi-Fi connection manager.
-WM_E_INVAL if network is NULL or the network name is not unique or the network name length is not valid or network security is WLAN_SECURITY_WPA3_SAE but Management Frame Protection Capable is not enabled. in wlan_network_security field. if network security type is. WLAN_SECURITY_WPA or WLAN_SECURITY_WPA2 or WLAN_SECURITY_WPA_WPA2_MIXED, but the passphrase length is less than 8 or greater than 63, or the psk length equal to 64 but not hexadecimal digits. if network security type is WLAN_SECURITY_WPA3_SAE, but the password length is less than 8 or greater than 255. if network security type is WLAN_SECURITY_WEP_OPEN or WLAN_SECURITY_WEP_SHARED.
-WM_E_NOMEM if there was no room to add the network.
WLAN_ERROR_STATE if the Wi-Fi connection manager was running and not in the WLAN_DISCONNECTED, WLAN_ASSOCIATED or WLAN_CONNECTED state.

`wlan_get_network`#

int wlan_get_network (unsigned int *index*, struct wlan_network * *network*)

Retrieves the information about a known network using index.

Parameters

Parameter	In/Out	Description
`index`	in	The index of the network to retrieve.
`network`	out	A pointer to the wlan_network where the network configuration for the network at index can be copied.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if network is NULL or index is out of range.

`wlan_get_network_byname`#

int wlan_get_network_byname (char * *name*, struct wlan_network * *network*)

Retrieves information about a known network using name.

Parameters

Parameter	In/Out	Description
`name`	in	The name of the network to retrieve.
`network`	out	A pointer to the wlan_network where the network configuration for the network having name as name must be copied.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if network is NULL or name is NULL.

`wlan_get_network_count`#

int wlan_get_network_count (unsigned int * *count*)

Retrieves the number of networks known to the Wi-Fi connection manager.

Parameters

Parameter	In/Out	Description
`count`	out	A pointer to the memory location where the number of networks must be copied.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if count is NULL.

`wlan_initialize_sta_network`#

void wlan_initialize_sta_network (struct wlan_network * *net*)

Initialize the station network information.

Parameters

Parameter	In/Out	Description
`net`	out	Pointer to the initialized station network.

`wlan_remove_all_network_profiles`#

int wlan_remove_all_network_profiles (void **)

Stops and removes all Wi-Fi network profiles.

Returns

WM_SUCCESS if successful otherwise return -WM_E_INVAL.

`wlan_remove_all_networks`#

int wlan_remove_all_networks (void **)

Stops and removes all Wi-Fi network (access point).

Returns

WM_SUCCESS if successful.

`wlan_remove_network`#

int wlan_remove_network (const char * *name*)

Removes a network profile from the list of known networks.

Parameters

Parameter	In/Out	Description
`name`	in	A pointer to the string representing the name of the network to remove.

Returns

WM_SUCCESS if the network named name was removed from the Wi-Fi connection manager successfully. Otherwise, the network is not removed.
WLAN_ERROR_STATE if the Wi-Fi connection manager was running and the station interface was not in the WLAN_DISCONNECTED state.
-WM_E_INVAL if name is NULL or the network was not found in the list of known networks.
-WM_FAIL if an internal error occurred while trying to disconnect from the network specified for removal.

Network Status#

Function	Supported SoCs
`wlan_get_address`	All
`wlan_get_current_bssid`	All
`wlan_get_current_network`	All
`wlan_get_current_network_bssid`	All
`wlan_get_current_network_ssid`	All

`wlan_get_address`#

int wlan_get_address (struct wlan_ip_config * *addr*)

Retrieves the IP address configuration of the station interface.

Parameters

Parameter	In/Out	Description
`addr`	out	A pointer to the wlan_ip_config.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if addr is NULL.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running or was not in the WLAN_CONNECTED state.
-WM_FAIL if an internal error occurred when retrieving IP address information from the TCP stack.

`wlan_get_current_bssid`#

int wlan_get_current_bssid (uint8_t * *bssid*)

Use this API to get the BSSID of associated BSS when in station mode.

Parameters

Parameter	In/Out	Description
`bssid`	out	A pointer to array(char, length is 6) to store the BSSID.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_get_current_network`#

int wlan_get_current_network (struct wlan_network * *network*)

Retrieves the current network configuration of the station interface.

Parameters

Parameter	In/Out	Description
`network`	out	A pointer to the wlan_network.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if network is NULL.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running or not in the WLAN_CONNECTED state.

`wlan_get_current_network_bssid`#

int wlan_get_current_network_bssid (char * *bssid*)

Retrieves the current network BSSID of the station interface.

Parameters

Parameter	In/Out	Description
`bssid`	out	A pointer to the bssid char string without NULL termination.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if bssid is NULL.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running or not in the WLAN_CONNECTED state.

`wlan_get_current_network_ssid`#

int wlan_get_current_network_ssid (char * *ssid*)

Retrieves the current network SSID of the station interface.

Parameters

Parameter	In/Out	Description
`ssid`	out	A pointer to the ssid char string with NULL termination. The maximum length is 32 (not include NULL termination).

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if ssid is NULL.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running or not in the WLAN_CONNECTED state.

Scan#

Function	Supported SoCs
`get_scan_params`	All
`set_scan_params`	All
`verify_scan_channel_value`	All
`verify_scan_duration_value`	All
`verify_split_scan_delay`	All
`wlan_get_scan_result`	All
`wlan_scan`	All
`wlan_scan_with_opt`	All
`wlan_select_cur_network_by_scan_res`	All
`wlan_set_scan_interval`	All

`get_scan_params`#

int get_scan_params (struct wifi_scan_params_t * *wifi_scan_params*)

Gets the scan parameters.

Parameters

Parameter	In/Out	Description
`wifi_scan_params`	out	Wi-Fi scan parameter structure pointer.

Returns

WM_SUCCESS.

`set_scan_params`#

int set_scan_params (struct wifi_scan_params_t * *wifi_scan_params*)

Sets the scan parameters.

Parameters

Parameter	In/Out	Description
`wifi_scan_params`	in	Wi-Fi scan parameter structure pointer.

Returns

0 if Wi-Fi scan parameters are set successfully, else return -1.

`verify_scan_channel_value`#

int verify_scan_channel_value (int *channel*)

Checks whether the scan channel is valid or not.

Parameters

Parameter	In/Out	Description
`channel`	in	the scan channel.

Returns

0 if the channel is valid, else return -1.

`verify_scan_duration_value`#

int verify_scan_duration_value (int *scan_duration*)

Checks whether the scan duration is valid or not.

Parameters

Parameter	In/Out	Description
`scan_duration`	in	scan duration time.

Returns

0 if the time is valid, else return -1.

`verify_split_scan_delay`#

int verify_split_scan_delay (int *delay*)

Checks whether the scan delay time is valid or not.

Parameters

Parameter	In/Out	Description
`delay`	in	the scan delay time.

Returns

0 if the time is valid, else return -1.

`wlan_get_scan_result`#

int wlan_get_scan_result (unsigned int *index*, struct wlan_scan_result * *res*)

Retrieves a scan result.

Parameters

Parameter	In/Out	Description
`index`	in	The scan result to retrieve.
`res`	out	A pointer to the wlan_scan_result where the scan result information must be copied.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if res is NULL.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running.
-WM_FAIL if the scan result at index could not be retrieved (that is, index is out of range).

`wlan_scan`#

int wlan_scan (int(*)(unsigned int count) *cb*)

Scan for Wi-Fi networks.

Parameters

Parameter	In/Out	Description
`cb`	in	A pointer to the function that should be called to handle scan results when they are available.

Returns

WM_SUCCESS if successful.
-WM_E_NOMEM if failed to allocated memory for wlan_scan_params_v2_t structure.
-WM_E_INVAL if cb scan result callback function pointer is NULL.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running or not in the WLAN_DISCONNECTED or WLAN_CONNECTED states.
-WM_FAIL if an internal error has occurred and the system is unable to scan.

`wlan_scan_with_opt`#

int wlan_scan_with_opt (wlan_scan_params_v2_t *t_wlan_scan_param*)

Scan for Wi-Fi networks using options provided.

Parameters

Parameter	In/Out	Description
`t_wlan_scan_param`	in	A wlan_scan_params_v2_t structure holding a pointer to a function that must be called to handle scan results when they are available, SSID of a Wi-Fi network, BSSID of a Wi-Fi network, number of channels with scan type information and number of probes.

Returns

WM_SUCCESS if successful.
-WM_E_NOMEM if failed to allocated memory for wlan_scan_params_v2_t structure.
-WM_E_INVAL if cb scan result callback function pointer is NULL.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running or not in the WLAN_DISCONNECTED or WLAN_CONNECTED states.
-WM_FAIL if an internal error has occurred and the system is unable to scan.

`wlan_select_cur_network_by_scan_res`#

int wlan_select_cur_network_by_scan_res (unsigned int *scan_index*)

Select (synchronize) current network index according to a scan table entry.

Parameters

Parameter	In/Out	Description
`scan_index`	in	Index into the driver’s scan table.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_scan_interval`#

int wlan_set_scan_interval (int *scan_int*)

Sets the wpa_supplicant scan interval in seconds.

Parameters

Parameter	In/Out	Description
`scan_int`	in	Scan interval in seconds.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

UAP (Micro Access Point)#

Function	Supported SoCs
`is_uap_started`	All
`wlan_get_current_uap_network`	All
`wlan_get_current_uap_network_ssid`	All
`wlan_get_uap_address`	All
`wlan_get_uap_channel`	All
`wlan_get_uap_connection_state`	All
`wlan_get_uap_ed_mac_mode`	All
`wlan_get_uap_max_clients`	All
`wlan_get_uap_supported_max_clients`	All
`wlan_initialize_uap_network`	All
`wlan_set_uap_ed_mac_mode`	All
`wlan_set_uap_mac_addr`	All
`wlan_set_uap_max_clients`	All
`wlan_start_network`	All
`wlan_stop_network`	All
`wlan_uap_ctrl_deauth`	All
`wlan_uap_disconnect_sta`	All
`wlan_uap_get_bandwidth`	All
`wlan_uap_get_beacon_period`	All
`wlan_uap_get_log`	All
`wlan_uap_get_pmfcfg`	All
`wlan_uap_set_bandwidth`	All
`wlan_uap_set_beacon_period`	All
`wlan_uap_set_ecsa`	All
`wlan_uap_set_ecsa_cfg`	All
`wlan_uap_set_hidden_ssid`	All
`wlan_uap_set_htcapinfo`	All
`wlan_uap_set_httxcfg`	All
`wlan_uap_set_scan_chan_list`	All

`is_uap_started`#

bool is_uap_started (void **)

Retrieves the status information of the uAP interface.

Returns

TRUE if uAP interface is in WLAN_UAP_STARTED state.
FALSE otherwise.

`wlan_get_current_uap_network`#

int wlan_get_current_uap_network (struct wlan_network * *network*)

Retrieves the current network configuration of the uAP interface.

Parameters

Parameter	In/Out	Description
`network`	out	A pointer to the wlan_network.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if network is NULL.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running or not in the WLAN_UAP_STARTED state.

`wlan_get_current_uap_network_ssid`#

int wlan_get_current_uap_network_ssid (char * *ssid*)

Retrieves the current network ssid of the uAP interface.

Parameters

Parameter	In/Out	Description
`ssid`	out	A pointer to the ssid char string with NULL termination. The maximum length is 32 (not include NULL termination).

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if ssid is NULL.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running or not in the WLAN_UAP_STARTED state.

`wlan_get_uap_address`#

int wlan_get_uap_address (struct wlan_ip_config * *addr*)

Retrieves the IP address of the uAP interface.

Parameters

Parameter	In/Out	Description
`addr`	out	A pointer to the wlan_ip_config.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if addr is NULL.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running or the uAP interface was not in the WLAN_UAP_STARTED state.
-WM_FAIL if an internal error occurred when retrieving IP address information from the TCP stack.

`wlan_get_uap_channel`#

int wlan_get_uap_channel (int * *channel*)

Retrieves the channel of the uAP interface.

Parameters

Parameter	In/Out	Description
`channel`	out	A pointer to variable that stores channel number.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if channel is NULL.
-WM_FAIL if an internal error has occurred.

`wlan_get_uap_connection_state`#

int wlan_get_uap_connection_state (enum wlan_connection_state * *state*)

Retrieves the connection state of the uAP interface.

Parameters

Parameter	In/Out	Description
`state`	out	A pointer to the wlan_connection_state where the current connection state must be copied.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if state is NULL.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running.

`wlan_get_uap_ed_mac_mode`#

int wlan_get_uap_ed_mac_mode (wlan_ed_mac_ctrl_t * *wlan_ed_mac_ctrl*)

This API can be used to get the current ED MAC mode configuration for the uAP.

Parameters

Parameter	In/Out	Description
`wlan_ed_mac_ctrl`	out	A pointer to wlan_ed_mac_ctrl_t as described in the corresponding set API.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

`wlan_get_uap_max_clients`#

int wlan_get_uap_max_clients (unsigned int * *max_sta_num*)

Gets the current maximum number of stations that can be allowed to connect to the uAP.

Parameters

Parameter	In/Out	Description
`max_sta_num`	out	A pointer to variable where current maximum number of the stations of the uAP interface can be stored.

Returns

WM_SUCCESS if successful.
-WM_FAIL if unsuccessful.

`wlan_get_uap_supported_max_clients`#

unsigned int wlan_get_uap_supported_max_clients (void **)

Gets the maximum number of stations the Wi-Fi firmware supports that are allowed to connect to the uAP.

Returns

Maximum number of stations supported by the Wi-Fi firmware that can connect to the uAP.

`wlan_initialize_uap_network`#

void wlan_initialize_uap_network (struct wlan_network * *net*)

Initialize the uAP network information.

Parameters

Parameter	In/Out	Description
`net`	out	Pointer to the initialized uAP network.

`wlan_set_uap_ed_mac_mode`#

int wlan_set_uap_ed_mac_mode (wlan_ed_mac_ctrl_t *wlan_ed_mac_ctrl*)

Configures Energy Detect MAC mode for the uAP in the Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`wlan_ed_mac_ctrl`	in	Struct with the following fields: ed_ctrl_2g = • 0: Disable EU adaptivity for 2.4 GHz band. ed_ctrl_2g =. • 1: Enable EU adaptivity for 2.4 GHz band. ed_offset_2g =. • 0: Default Energy Detect threshold (0x9). ed_offset_2g = other: Offset value in range 0x80 to 0x7F.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

`wlan_set_uap_mac_addr`#

int wlan_set_uap_mac_addr (uint8_t * *mac*)

Sets the Wi-Fi MAC address for the uAP in the Wi-Fi firmware.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

`wlan_set_uap_max_clients`#

int wlan_set_uap_max_clients (unsigned int *max_sta_num*)

Sets the maximum number of stations that can be allowed to connect to the uAP.

Parameters

Parameter	In/Out	Description
`max_sta_num`	in	Number of maximum stations for uAP.

Returns

WM_SUCCESS if successful.
-WM_FAIL if unsuccessful.

`wlan_start_network`#

int wlan_start_network (const char * *name*)

Starts a Wi-Fi network (access point).

Parameters

Parameter	In/Out	Description
`name`	in	A pointer to string representing the name of the network to connect to.

Returns

WM_SUCCESS if successful.
WLAN_ERROR_STATE if in Power-save state or uAP already running.
-WM_E_INVAL if name was NULL or the network name was not found or it not have a specified SSID.

`wlan_stop_network`#

int wlan_stop_network (const char * *name*)

Stops a Wi-Fi network (access point).

Parameters

Parameter	In/Out	Description
`name`	in	A pointer to a string representing the name of the network to stop.

Returns

WM_SUCCESS if successful.
WLAN_ERROR_STATE if uAP is in Power-save state.
-WM_E_INVAL if name was NULL or the network name was not found or that the network name is not a uAP network or it is a uAP network but does not have a specified SSID.

`wlan_uap_ctrl_deauth`#

void wlan_uap_ctrl_deauth (const bool *enable*)

API to control the deauthentication during uAP channel switch.

Parameters

Parameter	In/Out	Description
`enable`	in	0 Wi-Fi firmware can use default behavior, send deauth packet when uAP moves to another channel. 1: Wi-Fi firmware cannot send deauth packet. when uAP moves to another channel.

`wlan_uap_disconnect_sta`#

int wlan_uap_disconnect_sta (uint8_t * *sta_addr*)

Disconnects to STA which is connected with internal uAP.

Parameters

Parameter	In/Out	Description
`sta_addr`	in	STA MAC address.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_uap_get_bandwidth`#

int wlan_uap_get_bandwidth (uint8_t * *bandwidth*)

API to get the bandwidth of the uAP.

Parameters

Parameter	In/Out	Description
`bandwidth`	out	Wi-Fi AP bandwidth • 1: 20 MHz. • 2: 40 MHz. • 3: 80 MHz.

Returns

WM_SUCCESS if successful otherwise return -WM_FAIL.
-WM_FAIL if command fails.

`wlan_uap_get_beacon_period`#

int wlan_uap_get_beacon_period (void)

API to get the beacon period of the uAP.

Returns

beacon_period: Beacon period in TU (1 TU = 1024 microseconds).

`wlan_uap_get_log`#

int wlan_uap_get_log (wlan_pkt_stats_t * *stats*)

Use this API to get the various statistics of the uAP from Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`stats`	out	A pointer to structure where stats collected from Wi-Fi firmware can be copied. Explore the elements of the wlan_pkt_stats_t structure for more information on stats.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_uap_get_pmfcfg`#

int wlan_uap_get_pmfcfg (uint8_t * *mfpc*, uint8_t * *mfpr*)

Use this API to get the set management frame protection parameters for uAP.

Parameters

Parameter	In/Out	Description
`mfpc`	out	Management frame protection capable (MFPC) • 0: Management frame protection not capable. • 1: Management frame protection capable.
`mfpr`	out	Management frame protection required (MFPR) • 0: Management frame protection optional. • 1: Management frame protection required.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_uap_set_bandwidth`#

int wlan_uap_set_bandwidth (const uint8_t *bandwidth*)

API to set the bandwidth of the uAP.

Parameters

Parameter	In/Out	Description
`bandwidth`	in	Wi-Fi AP bandwidth • 1: 20 MHz. • 2: 40 MHz. • 3: 80 MHz.

Returns

WM_SUCCESS if successful otherwise return -WM_FAIL.
-WM_FAIL if command fails.

`wlan_uap_set_beacon_period`#

void wlan_uap_set_beacon_period (const uint16_t *beacon_period*)

API to set the beacon period of the uAP.

Parameters

Parameter	In/Out	Description
`beacon_period`	in	Beacon period in TU (1 TU = 1024 microseconds)

`wlan_uap_set_ecsa`#

void wlan_uap_set_ecsa (void **)

API to enable the channel switch announcement functionality on uAP.

`wlan_uap_set_ecsa_cfg`#

int wlan_uap_set_ecsa_cfg (t_u8 *block_tx*, t_u8 *oper_class*, t_u8 *channel*, t_u8 *switch_count*, t_u8 *band_width*)

Sends the ecsa configuration parameter to FW.

Parameters

Parameter	In/Out	Description
`block_tx`	in	0 no need to block traffic,1 need block traffic.
`oper_class`	in	Operating class according to IEEE std802.11 spec, refer to Annex E, when 0 is used, automatically get the operclass through bandwidth and channel.
`channel`	in	The channel can switch to.
`switch_count`	in	Channel switch time to send ECSA ie, unit is 110ms.
`band_width`	in	Channel width switch to(optional), only for 5G channels. Depends on the hardware capabilities, when the hardware does not support, it can automatically downgrade. Redfinch support 20M. 0 20MHZ, 1 40M above, 3 40M below, 4 80M, 5 160M

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_uap_set_hidden_ssid`#

int wlan_uap_set_hidden_ssid (const t_u8 *hidden_ssid*)

API to control the SSID broadcast capability of the uAP.

Parameters

Parameter	In/Out	Description
`hidden_ssid`	in	Hidden SSID control hidden_ssid=0: broadcast SSID in beacons. hidden_ssid=1: send empty SSID (length=0) in beacon. hidden_ssid=2: clear SSID (ASCII 0), but keep the original length

Returns

WM_SUCCESS if successful otherwise return -WM_FAIL.
-WM_FAIL if command fails.

`wlan_uap_set_htcapinfo`#

void wlan_uap_set_htcapinfo (const uint16_t *ht_cap_info*)

API to set the HT capability information of the uAP.

Parameters

Parameter	In/Out	Description
`ht_cap_info`	in	- This is a bitmap and should be used as following Bit, 15: L Sig TxOP protection - reserved, set to 0 Bit, 14: 40 MHz intolerant - reserved, set to 0 Bit, 13: PSMP - reserved, set to 0 Bit • 12: DSSS Cck40 MHz mode Bit. • 6: Short GI 40 MHz Bit. • 5: Short GI 20 MHz Bit. • 4: GF preamble Bits. • 1: SuppChanWidth - set to 0 for 2.4 GHz band Bit.

`wlan_uap_set_httxcfg`#

void wlan_uap_set_httxcfg (unsigned short *httxcfg*)

This API can be used to configure various 802.11n specific configuration for transmit (such as short GI, channel bandwidth and green field support) for uAP interface.

Parameters

Parameter	In/Out	Description
`httxcfg`	in	This is a bitmap and should be used as following Bit 15 • -8: Reserved set to 0 Bit. • 7: STBC Enable/Disable Bit. • 6: Short GI in 40 Mhz Enable/Disable Bit. • 5: Short GI in 20 Mhz Enable/Disable Bit. • 4: Green field Enable/Disable Bit 3-2: Reserved set to 1 Bit. • 1: 20/40 Mhz enable disable. Bit. • 0: LDPC Enable/Disable When Bit 1 is set then firmware could transmit in 20Mhz or 40Mhz based on rate adaptation. When this bit is reset then firmware can only transmit in 20Mhz.

`wlan_uap_set_scan_chan_list`#

void wlan_uap_set_scan_chan_list (wifi_scan_chan_list_t *scan_chan_list*)

Sets the number of channels and channel number used during automatic channel selection of the uAP.

Parameters

Parameter	In/Out	Description
`scan_chan_list`	in	A structure holding the number of channels and channel numbers.

Power Management#

Function	Supported SoCs
`wlan_configure_delay_to_ps`	All
`wlan_configure_idle_time`	All
`wlan_configure_listen_interval`	All
`wlan_configure_null_pkt_interval`	All
`wlan_deepsleepps_off`	All
`wlan_deepsleepps_on`	All
`wlan_get_delay_to_ps`	All
`wlan_get_idle_time`	All
`wlan_get_listen_interval`	All
`wlan_get_ps_mode`	All
`wlan_get_ps_mode_cfg`	All
`wlan_ieeeps_off`	All
`wlan_ieeeps_on`	All
`wlan_is_power_save_enabled`	All
`wlan_set_ieeeps_cfg`	All
`wlan_set_ips`	RW612, IW610
`wlan_set_ps_cfg`	All
`wlan_sleep_period`	All

`wlan_configure_delay_to_ps`#

void wlan_configure_delay_to_ps (unsigned int *timeout_ms*)

Sets timeout configuration before Wi-Fi Power-save mode.

Parameters

Parameter	In/Out	Description
`timeout_ms`	in	timeout time, in milliseconds.

`wlan_configure_idle_time`#

void wlan_configure_idle_time (unsigned int *timeout_ms*)

Sets timeout value before Wi-Fi enter deep sleep mode.

`wlan_configure_listen_interval`#

void wlan_configure_listen_interval (int *listen_interval*)

Configures listening interval of IEEE Power-save mode.

Parameters

Parameter	In/Out	Description
`listen_interval`	in	Listen interval as below • 0: Unchanged. • -1: Disable. 1-49: Value in beacon intervals. >=. • 50: Value in TUs.

`wlan_configure_null_pkt_interval`#

void wlan_configure_null_pkt_interval (unsigned int *time_in_secs*)

Configures NULL packet interval of IEEE Power-save mode.

Parameters

Parameter	In/Out	Description
`time_in_secs`	in	-1 Disables null packet transmission, 0: Null packet interval is unchanged. n Null packet interval in seconds.

`wlan_deepsleepps_off`#

int wlan_deepsleepps_off (void **)

Turns off deep sleep Power-save mode.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL otherwise.

`wlan_deepsleepps_on`#

int wlan_deepsleepps_on (void **)

Turns on deep sleep Power-save mode.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL otherwise.

`wlan_get_delay_to_ps`#

unsigned int wlan_get_delay_to_ps (void **)

Gets delay time for Wi-Fi Power-save mode.

Returns

delay time value.

`wlan_get_idle_time`#

unsigned int wlan_get_idle_time (void **)

Gets timeout value of deep sleep mode, in milliseconds.

Returns

idle time value.

`wlan_get_listen_interval`#

unsigned short wlan_get_listen_interval (void **)

Gets listen interval.

Returns

Listen interval value in beacon intervals.

`wlan_get_ps_mode`#

int wlan_get_ps_mode (enum wlan_ps_mode * *ps_mode*)

Gets station interface Power-save mode.

Parameters

Parameter	In/Out	Description
`ps_mode`	out	A pointer to wlan_ps_mode where station interface Power-save mode must be stored.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if ps_mode was NULL.

`wlan_get_ps_mode_cfg`#

int wlan_get_ps_mode_cfg (uint8_t * *ps_mode_cfg*)

Gets station interface Power-save configuration.

Parameters

Parameter	In/Out	Description
`ps_mode_cfg`	out	A pointer to variable that stores Power-save mode configuration.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if ps_mode_cfg was NULL.

`wlan_ieeeps_off`#

int wlan_ieeeps_off (void **)

Turns off IEEE Power-save mode.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL otherwise.

`wlan_ieeeps_on`#

int wlan_ieeeps_on (unsigned int *wakeup_conditions*)

Enables IEEE Power-save with host sleep configuration.

Parameters

Parameter	In/Out	Description
`wakeup_conditions`	in	conditions to wake the host. This should be a logical OR of the conditions in wlan_wakeup_event_t. Typically devices would want to wake up on. WAKE_ON_ALL_BROADCAST, WAKE_ON_UNICAST, WAKE_ON_MAC_EVENT. WAKE_ON_MULTICAST, WAKE_ON_ARP_BROADCAST, WAKE_ON_MGMT_FRAME

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL otherwise.

`wlan_is_power_save_enabled`#

bool wlan_is_power_save_enabled (void **)

Checks whether Wi-Fi Power-save is enabled or not.

Returns

TRUE if Wi-Fi Power-save is enabled, else return FALSE.

`wlan_set_ieeeps_cfg`#

int wlan_set_ieeeps_cfg (struct wlan_ieeeps_config * *ps_cfg*)

Sets configuration parameters of IEEE Power-save mode.

Parameters

Parameter	In/Out	Description
`ps_cfg`	in	Power-save configuration includes multiple parameters.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

`wlan_set_ips`#

int wlan_set_ips (int *option*)

Config IEEE Power-save mode (IPS). If the option is 1, the IPS hardware listens to beacon frames after Wi-Fi CPU enters Power-save mode. When there is work needed to done by Wi-Fi CPU, Wi-Fi CPU can be woken up by ips hardware.

Parameters

Parameter	In/Out	Description
`option`	in	0/1 disable/enable ips.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_ps_cfg`#

void wlan_set_ps_cfg (t_u16 *multiple_dtims*, t_u16 *bcn_miss_timeout*, t_u16 *local_listen_interval*, t_u16 *adhoc_wake_period*, t_u16 *mode*, t_u16 *delay_to_ps*)

Sets the multiple DTIM for the next wakeup RX beacon time.

Parameters

Parameter	In/Out	Description
`multiple_dtims`	in	num dtims, range [1,20]
`bcn_miss_timeout`	in	beacon miss interval.
`local_listen_interval`	in	local listen interval.
`adhoc_wake_period`	in	adhoc awake period.
`mode`	in	mode - ( • 0x01: Firmware automatically chooses PS_POLL or NULL mode. • 0x02: PS_POLL mode. • 0x03: NULL mode.
`delay_to_ps`	in	Delay to PS in milliseconds.

`wlan_sleep_period`#

int wlan_sleep_period (unsigned int * *sleep_period*, t_u8 *action*)

Gets or sets the UAPSD sleep period in the Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`sleep_period`	inout	UAPSD sleep period. Unit is ms.
`action`	in	Set/get action.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

Host Sleep#

Function	Supported SoCs
`wlan_cancel_host_sleep`	RW612, IW610
`wlan_clear_host_sleep_config`	RW612, IW610
`wlan_config_host_sleep`	RW612, IW610
`wlan_get_wakeup_reason`	RW612, IW610
`wlan_hs_post_cfg`	RW612, IW610
`wlan_hs_pre_cfg`	RW612, IW610
`wlan_hs_send_event`	RW612, IW610

`wlan_cancel_host_sleep`#

void wlan_cancel_host_sleep (void **)

Cancel host sleep. This function is called to cancel the host sleep in the firmware.

`wlan_clear_host_sleep_config`#

void wlan_clear_host_sleep_config (void **)

Clears host sleep configurations in the driver. This function clears all the host sleep related configures in driver.

`wlan_config_host_sleep`#

void wlan_config_host_sleep (bool *is_manual*, t_u8 *is_periodic*)

Host sleep configuration. This function may be called to configure host sleep in firmware.

Parameters

Parameter	In/Out	Description
`is_manual`	in	Flag to indicate host enter low power mode with power manager or by command.
`is_periodic`	in	Flag to indicate host enter low power periodically or once with power manager.

`wlan_get_wakeup_reason`#

int wlan_get_wakeup_reason (uint16_t * *hs_wakeup_reason*)

Use this API to get host sleep wakeup reason from Wi-Fi firmware after waking up from host sleep by Wi-Fi.

Parameters

Parameter	In/Out	Description
`hs_wakeup_reason`	out	wakeupReason: • 0: Unknown. • 1: Broadcast data matched. • 2: Multicast data matched. • 3: Unicast data matched. • 4: Maskable event matched. • 5: Non-maskable event matched. • 6: Non-maskable condition matched (EAPoL rekey). • 7: Magic pattern matched. Others: Reserved (set to 0).

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_hs_post_cfg`#

void wlan_hs_post_cfg (void **)

Use this API to get and print the reason for waking up from host sleep.

`wlan_hs_pre_cfg`#

void wlan_hs_pre_cfg (void **)

Use this API to set the configuration before going to host sleep.

`wlan_hs_send_event`#

status_t wlan_hs_send_event (int *id*, void * *data*)

This function sends host sleep events to mon_thread.

Parameters

Parameter	In/Out	Description
`id`	in	Event ID.
`data`	in	Pointer to event msg.

Returns

kStatus_Success if successful else return -WM_FAIL.

TX Power & Rate Control#

Function	Supported SoCs
`wlan_get_data_rate`	All
`wlan_get_sta_tx_power`	All
`wlan_get_txpwrlimit`	All
`wlan_get_txratecfg`	All
`wlan_set_frag`	All
`wlan_set_htcapinfo`	All
`wlan_set_httxcfg`	All
`wlan_set_region_power_cfg`	RW612, IW610, IW612
`wlan_set_rg_power_cfg`	RW612, IW610, IW612
`wlan_set_rts`	All
`wlan_set_ru_power_cfg`	RW612, IW610, IW612
`wlan_set_sta_tx_power`	All
`wlan_set_tx_pert`	RW612
`wlan_set_txpwrlimit`	All
`wlan_set_txratecfg`	All
`wlan_set_txrx_histogram`	All
`wlan_set_uap_frag`	All
`wlan_set_uap_rts`	All
`wlan_set_wwsm_txpwrlimit`	All

`wlan_get_data_rate`#

int wlan_get_data_rate (wlan_ds_rate * *ds_rate*, mlan_bss_type *bss_type*)

Use this API to get the current TX and RX rates along with bandwidth and guard interval information if the rate is 802.11n.

Parameters

Parameter	In/Out	Description
`ds_rate`	in	A pointer to structure which has tx, RX rate information along with bandwidth and guard interval information.
`bss_type`	in	0: STA, 1: uAP.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_get_sta_tx_power`#

int wlan_get_sta_tx_power (t_u32 * *power_level*)

Gets the station transmit power.

Parameters

Parameter	In/Out	Description
`power_level`	out	Transmit power level (unit: dBm).

Returns

WM_SUCCESS if successful.
-WM_FAIL if unsuccessful.

`wlan_get_txpwrlimit`#

int wlan_get_txpwrlimit (wifi_SubBand_t *subband*, wifi_txpwrlimit_t * *txpwrlimit*)

Gets the TRPC (transient receptor potential canonical) channel configuration.

Parameters

Parameter	In/Out	Description
`subband`	in	Where subband is: • 0x00: 2G subband (2.4G: channel 1-14). • 0x10: 5G subband0 (5G: channel 36. • 0x11: 5G subband1 (5G: channel 100. • 0x12: 5G subband2 (5G: channel 149. • 0x13: 5G subband3 (5G: channel 183.
`txpwrlimit`	out	A pointer to wlan_txpwrlimit_t TX power limit configuration structure where Wi-Fi firmware configuration can be copied.

Returns

WM_SUCCESS on success, error otherwise.

`wlan_get_txratecfg`#

int wlan_get_txratecfg (wlan_ds_rate * *ds_rate*, mlan_bss_type *bss_type*)

Use this API to get the transmit data rate.

Parameters

Parameter	In/Out	Description
`ds_rate`	in	A pointer to wlan_ds_rate where TX Rate configuration can be stored.
`bss_type`	in	0: STA, 1: uAP.

Returns

WM_SUCCESS if successful.
-WM_FAIL if unsuccessful.

`wlan_set_frag`#

int wlan_set_frag (int *frag*)

Sets the fragment threshold of STA in Wi-Fi firmware. If the size of packet exceeds the fragment threshold, the packet is divided into fragments. For example, if the fragment threshold is set to 300, a ping packet of size 1300 is divided into 5 fragments.

Parameters

Parameter	In/Out	Description
`frag`	in	The value of fragment threshold configuration.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_htcapinfo`#

int wlan_set_htcapinfo (unsigned int *htcapinfo*)

Use this API to configure some of the parameters in HT capability information IE (such as short GI, channel bandwidth, and green field support).

Parameters

Parameter	In/Out	Description
`htcapinfo`	in	This is a bitmap and should be used as following Bit • 29: Green field Enable/Disable Bit. • 26: RX STBC Support Enable/Disable. (As we support single spatial stream only 1 bit is used for RX STBC) Bit. • 25: TX STBC support Enable/Disable. Bit. • 24: Short GI in 40 Mhz Enable/Disable Bit. • 23: Short GI in 20 Mhz Enable/Disable Bit. • 22: RX LDPC Enable/Disable Bit. • 17: 20/40 Mhz enable disable. Bit. • 8: Enable/Disable 40 MHz intolerant bit in HT capinfo (0 resets this bit.

Returns

WM_SUCCESS if successful.
-WM_FAIL if unsuccessful.

`wlan_set_httxcfg`#

int wlan_set_httxcfg (unsigned short *httxcfg*)

Use this API to configure various 802.11n specific configuration for transmit (such as short GI, channel bandwidth and green field support).

Parameters

Parameter	In/Out	Description
`httxcfg`	in	This is a bitmap and should be used as following Bit 15 • -10: Reserved set to 0 Bit 9-8: RX STBC set to 0x01. 0b00: No spatial streams. 0b01: One spatial stream supported. 0b10: Reserved. 0b11: Reserved. Bit. • 7: STBC Enable/Disable Bit. • 6: Short GI in 40 Mhz Enable/Disable Bit. • 5: Short GI in 20 Mhz Enable/Disable Bit. • 4: Green field Enable/Disable Bit 3-2: Reserved set to 1 Bit. • 1: 20/40 Mhz enable disable. Bit. • 0: LDPC Enable/Disable When Bit 1 is set then firmware could transmit in 20Mhz or 40Mhz based on rate adaptation. When this bit is reset then firmware can only transmit in 20Mhz.

Returns

WM_SUCCESS if successful.
-WM_FAIL if unsuccessful.

`wlan_set_region_power_cfg`#

int wlan_set_region_power_cfg (const t_u8 * *data*, t_u16 *len*)

Sets the compressed (use LZW algorithm) TX power limit configuration.

Parameters

Parameter	In/Out	Description
`data`	in	A pointer to TX power limit configuration.
`len`	in	Length of TX power limit configuration.

Returns

WM_SUCCESS on success, error otherwise.

`wlan_set_rg_power_cfg`#

int wlan_set_rg_power_cfg (t_u16 *region_code*)

Sets the TX power table according to the region code.

Parameters

Parameter	In/Out	Description
`region_code`	in	region code.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rts`#

int wlan_set_rts (int *rts*)

Sets the RTS(Request to Send) threshold of STA in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`rts`	in	the value of rts threshold configuration.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_ru_power_cfg`#

int wlan_set_ru_power_cfg (t_u16 *region_code*)

Sets the resource unit TX power table.

Parameters

Parameter	In/Out	Description
`region_code`	in	region code.

Returns

WM_SUCCESS if successful otherwise failure.

`wlan_set_sta_tx_power`#

int wlan_set_sta_tx_power (t_u32 *power_level*)

Sets the station transmit power.

Parameters

Parameter	In/Out	Description
`power_level`	in	Transmit power level (unit: dBm).

Returns

WM_SUCCESS if successful.
-WM_FAIL if unsuccessful.

`wlan_set_tx_pert`#

void wlan_set_tx_pert (struct wlan_tx_pert_info * *tx_pert*, mlan_bss_type *bss_type*)

Sets the TX per tracking config. This function can be called to set TX per tracking in firmware.

Parameters

Parameter	In/Out	Description
`tx_pert`	in	User configured parameters of TX per tracking period, ratio and number of TX packets.
`bss_type`	in	BSS type for STA or uAP.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

`wlan_set_txpwrlimit`#

int wlan_set_txpwrlimit (wlan_txpwrlimit_t * *txpwrlimit*)

Sets the TRPC (transient receptor potential canonical) channel configuration.

Parameters

Parameter	In/Out	Description
`txpwrlimit`	in	A pointer to wlan_txpwrlimit_t TX power limit configuration.

Returns

WM_SUCCESS on success, error otherwise.

`wlan_set_txratecfg`#

int wlan_set_txratecfg (wlan_ds_rate *ds_rate*, mlan_bss_type *bss_type*)

Use this API to set the transmit data rate.

Parameters

Parameter	In/Out	Description
`ds_rate`	in	struct contains following fields sub_command It should be WIFI_DS_RATE_CFG and rate_cfg should have following parameters. rate_format - This parameter specifies the data rate format used in this command • 0: LG (legacy). • 1: HT. • 2: VHT. • 0: 1 Mbps. • 1: 2 Mbps. • 2: 5.5 Mbps. • 3: 11 Mbps. • 4: 6 Mbps. • 5: 9 Mbps. • 6: 12 Mbps. • 7: 18 Mbps. • 8: 24 Mbps. • 9: 36 Mbps. • 10: 48 Mbps. • 0: MCS0. • 1: MCS1. • 2: MCS2. • 3: MCS3. • 4: MCS4. • 5: MCS5. • 6: MCS6. • 7: MCS7. If STREAM_2X2:. • 8: MCS8. • 9: MCS9. • 10: MCS10. • 11: MCS11. • 12: MCS12. • 13: MCS13. • 14: MCS14. • 0: MCS0. • 1: MCS1. • 2: MCS2. • 3: MCS3. • 4: MCS4. • 5: MCS5. • 6: MCS6. • 7: MCS7. • 8: MCS8. • 1: NSS1. • 2: NSS2.
`bss_type`	in	0: STA, 1: uAP.

Returns

WM_SUCCESS if successful.
-WM_FAIL if unsuccessful.

`wlan_set_txrx_histogram`#

int wlan_set_txrx_histogram (int *bss_type*, struct wlan_txrx_histogram_info * *txrx_histogram*, t_u8 * *data*)

Sets the TX RX histogram config. This function can be called to set TX RX histogram config.

Parameters

Parameter	In/Out	Description
`bss_type`	in	0: STA, 1: uAP.
`txrx_histogram`	in	User configured parameters of TX RX histogram. including enable and action.
`data`	out	TX RX histogram data from FW.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

`wlan_set_uap_frag`#

int wlan_set_uap_frag (int *frag*)

Sets the fragment threshold of the uAP in Wi-Fi firmware. If the size of packet exceeds the fragment threshold, the packet is divided into fragments. For example, if the fragment threshold is set to 300, a ping packet of size 1300 is divided into 5 fragments.

Parameters

Parameter	In/Out	Description
`frag`	in	the value of fragment threshold configuration.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_uap_rts`#

int wlan_set_uap_rts (int *rts*)

Sets the RTS(Request to Send) threshold of the uAP in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`rts`	in	the value of rts threshold configuration.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_wwsm_txpwrlimit`#

int wlan_set_wwsm_txpwrlimit (void **)

Sets worldwide safe mode TX power limits. Set TX power limit and ru TX power limit according to the region code. TX power limit: rg_power_cfg_info ru TX power limit: ru_power_cfg_info.

Returns

WM_SUCCESS if successful.
-WM_FAIL if unsuccessful.

Antenna Configuration#

Function	Supported SoCs
`wlan_dual_ant_duty_cycle`	RW612, IW610
`wlan_get_antcfg`	All
`wlan_get_ext_ant_gain`	All
`wlan_set_antcfg`	All
`wlan_set_ext_ant_gain`	All
`wlan_single_ant_duty_cycle`	RW612, IW610

`wlan_dual_ant_duty_cycle`#

int wlan_dual_ant_duty_cycle (t_u16 *enable*, t_u16 *nbTime*, t_u16 *wlanTime*, t_u16 *wlanBlockTime*)

Sets dual antenna duty cycle.

Parameters

Parameter	In/Out	Description
`enable`	in	enable/disable single duty cycle • 0: Disable. • 1: Enable.
`nbTime`	in	time in units 1ms, no more than wlanTime.
`wlanTime`	in	time in unit 1ms, total duty cycle time.
`wlanBlockTime`	in	time in unit 1ms.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_antcfg`#

int wlan_get_antcfg (uint32_t * *ant*, uint16_t * *evaluate_time*, uint8_t * *evaluate_mode*, uint16_t * *current_antenna*)

This API can be used to get the mode of TX/RX antenna. If SAD (software antenna diversity) is enabled, this API can also be used to get SAD antenna evaluate time interval(antenna mode is antenna diversity when set SAD evaluate time interval).

Parameters

Parameter	In/Out	Description
`ant`	out	pointer to antenna variable. antenna variable: • 1: TX/RX antenna 1. • 2: TX/RX antenna 2. • 0xFFFF: TX/RX antenna diversity.
`evaluate_time`	out	pointer to evaluate_time variable for SAD.
`evaluate_mode`	in
`current_antenna`	out	pointer to current antenna.

Returns

WM_SUCCESS if successful.
WLAN_ERROR_STATE if unsuccessful.

`wlan_get_ext_ant_gain`#

int wlan_get_ext_ant_gain (const uint8_t *band*, const uint8_t *channel*, int8_t * *net_ant_gain*)

Gets computed net antenna gain for a given band and channel.

Parameters

Parameter	In/Out	Description
`band`	in	Band index (0=2.4 GHz, 1=5 GHz).
`channel`	in	Channel number within the specified band.
`net_ant_gain`	out	Pointer to store the computed net gain in dB (int8_t).

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_antcfg`#

int wlan_set_antcfg (uint32_t *ant*, uint16_t *evaluate_time*, uint8_t *evaluate_mode*)

This API can be used to set the mode of TX/RX antenna. If SAD (software antenna diversity) is enabled, this API can also be used to set SAD antenna evaluate time interval(antenna mode is antenna diversity when set SAD evaluate time interval).

Parameters

Parameter	In/Out	Description
`ant`	in	Antenna valid values are • 1: TX/RX antenna 1. • 2: TX/RX antenna 2. • 0xFFFF: TX/RX antenna diversity.
`evaluate_time`	in	SAD evaluate time interval, default value is 6s(0x1770).
`evaluate_mode`	in	• 0: PCB Ant + Ext Ant0. • 1: Ext Ant0 + Ext Ant1. • 2: PCB Ant + Ext Ant1. • 0xFF: Default diversity mode.

Returns

WM_SUCCESS if successful.
WLAN_ERROR_STATE if unsuccessful.

`wlan_set_ext_ant_gain`#

int wlan_set_ext_ant_gain (const int8_t * *ext_ant_gain*, const uint8_t *num_subbands*)

Sets external antenna gain for all sub-bands.

Parameters

Parameter	In/Out	Description
`ext_ant_gain`	in	Pointer to array of per-sub-band gains in dB (int8_t). Array size must match firmware MAX_SUBBAND.
`num_subbands`	in	Number of sub-bands (must be <= WIFI_EXT_ANT_GAIN_MAX_SUBBAND).

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_single_ant_duty_cycle`#

int wlan_single_ant_duty_cycle (t_u16 *enable*, t_u16 *nbTime*, t_u16 *wlanTime*)

Sets single antenna: duty cycle.

Parameters

Parameter	In/Out	Description
`enable`	in	enable/disable single duty cycle • 0: Disable. • 1: Enable.
`nbTime`	in	time in unit 1ms, no more than wlanTime.
`wlanTime`	in	time in unit 1ms, total duty cycle time.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

Channel & Band Configuration#

Function	Supported SoCs
`wlan_get_bandcfg`	All
`wlan_get_chanlist`	All
`wlan_get_current_channel`	All
`wlan_set_bandcfg`	All
`wlan_set_chanlist`	All
`wlan_set_chanlist_and_txpwrlimit`	All
`wlan_set_network_chanlist`	All
`wlan_set_scan_channel_gap`	All

`wlan_get_bandcfg`#

int wlan_get_bandcfg (wlan_bandcfg_t * *bandcfg*)

Gets the band configuration.

Parameters

Parameter	In/Out	Description
`bandcfg`	out	band configuration.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_chanlist`#

int wlan_get_chanlist (wlan_chanlist_t * *chanlist*)

Gets the channel list configuration.

Parameters

Parameter	In/Out	Description
`chanlist`	out	A pointer to wlan_chanlist_t channel list configuration.

Returns

WM_SUCCESS on success, error otherwise.

`wlan_get_current_channel`#

uint8_t wlan_get_current_channel (void **)

Use this API to get the channel number of associated BSS.

Returns

channel number if operation is successful.
0 if command fails.

`wlan_set_bandcfg`#

int wlan_set_bandcfg (wlan_bandcfg_t * *bandcfg*)

Sets the band configuration.

Parameters

Parameter	In/Out	Description
`bandcfg`	in	band configuration.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_chanlist`#

int wlan_set_chanlist (wlan_chanlist_t * *chanlist*)

Sets the channel list configuration.

Parameters

Parameter	In/Out	Description
`chanlist`	in	A pointer to wlan_chanlist_t channel list configuration.

Returns

WM_SUCCESS on success, error otherwise.

`wlan_set_chanlist_and_txpwrlimit`#

int wlan_set_chanlist_and_txpwrlimit (wlan_chanlist_t * *chanlist*, wlan_txpwrlimit_t * *txpwrlimit*)

Sets the channel list and TX power limit configuration.

Parameters

Parameter	In/Out	Description
`chanlist`	in	A pointer to wlan_chanlist_t channel List configuration.
`txpwrlimit`	in	A pointer to wlan_txpwrlimit_t TX power limit configuration.

Returns

WM_SUCCESS on success, error otherwise.

`wlan_set_network_chanlist`#

int wlan_set_network_chanlist (char * *name*, const uint8_t * *chan_list*, uint8_t *num_chans*, enum wlan_frequency_bands *freq_band*)

Sets the channel list for a network.

Parameters

Parameter	In/Out	Description
`name`	in	A pointer to a string representing the name of the network.
`chan_list`	in	A pointer to the channel list.
`num_chans`	in	Number of channels in the channel list.
`freq_band`	in	Frequency band for the channels (e.g., 2.4 GHz, 5 GHz).

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_scan_channel_gap`#

void wlan_set_scan_channel_gap (unsigned *scan_chan_gap*)

Sets the scan channel gap.

Parameters

Parameter	In/Out	Description
`scan_chan_gap`	in	Time gap to be used between two consecutive channels scan.

802.11ax (Wi-Fi 6)#

Function	Supported SoCs
`wlan_11ax_allowed`	RW612, IW610, IW612
`wlan_enable_disable_htc`	RW612, IW610, IW612
`wlan_get_11ax_cfg`	RW612, IW610, IW612
`wlan_get_11ax_rutxpowerlimit_legacy`	RW612, IW610, IW612
`wlan_set_11ax_cfg`	RW612, IW610, IW612
`wlan_set_11ax_rutxpowerlimit`	RW612, IW610, IW612
`wlan_set_11ax_rutxpowerlimit_legacy`	RW612, IW610, IW612
`wlan_set_11ax_tol_time`	RW612, IW610, IW612
`wlan_set_11ax_tx_omi`	RW612, IW610, IW612

`wlan_11ax_allowed`#

int wlan_11ax_allowed (struct wlan_network * *network*)

Checks if 802.11ax is allowed in capability.

Parameters

Parameter	In/Out	Description
`network`	in	A pointer to the wlan_network.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_enable_disable_htc`#

int wlan_enable_disable_htc (uint8_t *option*)

This function is used to enable/disable HTC (high throughput control).

Parameters

Parameter	In/Out	Description
`option`	in	1 => Enable; 0 => Disable.

Returns

WM_SUCCESS if operation is successful, otherwise return -WM_FAIL.

`wlan_get_11ax_cfg`#

wlan_11ax_config_t * wlan_get_11ax_cfg (void **)

Gets default 802.11ax configuration parameters.

Returns

802.11ax configuration parameters default array.

`wlan_get_11ax_rutxpowerlimit_legacy`#

int wlan_get_11ax_rutxpowerlimit_legacy (wlan_rutxpwrlimit_t * *ru_pwr_cfg*)

Use this API to get the resource unit TX power limit by a channel-based approach.

Parameters

Parameter	In/Out	Description
`ru_pwr_cfg`	out	802.11ax rutxpwr of channels to be get from firmware.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_set_11ax_cfg`#

int wlan_set_11ax_cfg (wlan_11ax_config_t * *ax_config*)

Sets 802.11ax configuration parameters.

Parameters

Parameter	In/Out	Description
`ax_config`	in	802.11ax configuration parameters to be sent to firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_11ax_rutxpowerlimit`#

int wlan_set_11ax_rutxpowerlimit (const void * *rutx_pwr_cfg*, uint32_t *rutx_pwr_cfg_len*)

Use this API to set the resource unit TX power limit.

Parameters

Parameter	In/Out	Description
`rutx_pwr_cfg`	in	802.11ax rutxpwr of sub-bands to be sent to firmware. refer to rutxpowerlimit_cfg_set_WW[]
`rutx_pwr_cfg_len`	in	Size of rutx_pwr_cfg buffer.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_set_11ax_rutxpowerlimit_legacy`#

int wlan_set_11ax_rutxpowerlimit_legacy (const wlan_rutxpwrlimit_t * *ru_pwr_cfg*)

Use this API to set the resource unit TX power limit by a channel-based approach.

Parameters

Parameter	In/Out	Description
`ru_pwr_cfg`	in	802.11ax rutxpwr of channels to be sent to firmware.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_set_11ax_tol_time`#

int wlan_set_11ax_tol_time (const t_u32 *tol_time*)

Sets 802.11ax OBSS (overlapping basic service set) narrow bandwidth RU (resource unit) tolerance time In uplink transmission, AP sends a trigger frame to all the stations that can be involved in the upcoming transmission, and then these stations transmit Trigger-based(TB) PPDU in response to the trigger frame. If STA connects to AP which channel is set to 100, STA doesn’t support 26 tones RU. The API should be called when station is in disconnected state.

Parameters

Parameter	In/Out	Description
`tol_time`	in	Valid range [1…3600] tolerance time is in unit of seconds. STA periodically checks AP’s beacon for ext cap bit79 (OBSS Narrow bandwidth RU in OFDMA tolerance support) and sets 20-tone RU tolerance time if ext cap bit79 is not set.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_11ax_tx_omi`#

int wlan_set_11ax_tx_omi (const t_u8 *interface*, const t_u16 *tx_omi*, const t_u8 *tx_option*, const t_u8 *num_data_pkts*)

Use this API to set the set 802.11ax TX OMI (operating mode indication).

Parameters

Parameter	In/Out	Description
`interface`	in	Interface type STA or uAP. • 0: STA. • 1: uAP.
`tx_omi`	in	value to be sent to firmware.
`tx_option`	in	value to be sent to firmware 1: Send OMI (operating mode indication) in QoS (quality of service) data.
`num_data_pkts`	in	value to be sent to firmware num_data_pkts is applied only if OMI is sent in QoS data frame. It specifies the number of consecutive data frames containing the OMI. Minimum value is 1 Maximum value is 16.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

802.11ac (Wi-Fi 5)#

Function	Supported SoCs
`wlan_11ac_allowed`	RW612, IW610, IW612

`wlan_11ac_allowed`#

int wlan_11ac_allowed (struct wlan_network * *network*)

Checks if 802.11ac is allowed in capability.

Parameters

Parameter	In/Out	Description
`network`	in	A pointer to the wlan_network.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

802.11n (Wi-Fi 4)#

Function	Supported SoCs
`wlan_11n_allowed`	All

`wlan_11n_allowed`#

int wlan_11n_allowed (struct wlan_network * *network*)

Checks if 802.11n is allowed in capability.

Parameters

Parameter	In/Out	Description
`network`	in	A pointer to the wlan_network.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

AMPDU & Aggregation#

Function	Supported SoCs
`wlan_tx_ampdu_prot_mode`	RW612, IW610

`wlan_tx_ampdu_prot_mode`#

int wlan_tx_ampdu_prot_mode (tx_ampdu_prot_mode_para * *prot_mode*, t_u16 *action*)

Gets or sets the TX AMPDU protect mode.

Parameters

Parameter	In/Out	Description
`prot_mode`	inout	TX AMPDU protect mode. tx_ampdu_prot_mode_para
`action`	in	Command action • 0: Get TX AMPDU protect mode. • 1: Set TX AMPDU protect mode.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

WMM / QoS#

Function	Supported SoCs
`wlan_set_wmm_uapsd`	All
`wlan_wmm_tx_stats_dump`	All
`wlan_wmm_uapsd_qosinfo`	All

`wlan_set_wmm_uapsd`#

int wlan_set_wmm_uapsd (t_u8 *uapsd_enable*)

Enables or disables the UAPSD in the Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`uapsd_enable`	in	Enable/Disable UAPSD.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

`wlan_wmm_tx_stats_dump`#

void wlan_wmm_tx_stats_dump (int *bss_type*)

`wlan_wmm_uapsd_qosinfo`#

int wlan_wmm_uapsd_qosinfo (t_u8 * *qos_info*, t_u8 *action*)

Sets the QOS info of the UAPSD (unscheduled automatic Power-save delivery) in the Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`qos_info`	inout	UAPSD (unscheduled automatic Power-save delivery) QOS info.
`action`	in	Set/get action.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

Roaming (802.11k/r/v)#

Function	Supported SoCs
`wlan_ft_roam`	All
`wlan_get_host_11k_status`	All
`wlan_get_roaming_status`	All
`wlan_host_11k_cfg`	All
`wlan_host_11k_neighbor_req`	All
`wlan_host_11v_bss_trans_query`	All
`wlan_set_roaming`	All

`wlan_ft_roam`#

int wlan_ft_roam (const t_u8 * *bssid*, const t_u8 *channel*)

Starts FT roaming. This API is used to initiate fast BSS transition-based roaming.

Parameters

Parameter	In/Out	Description
`bssid`	in	BSSID of AP to roam.
`channel`	in	Channel of AP to roam.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_host_11k_status`#

bool wlan_get_host_11k_status (void **)

Gets the enable/disable host 802.11k feature flag.

Returns

TRUE if 802.11k is enabled, return FALSE if 802.11k is disabled.

`wlan_get_roaming_status`#

int wlan_get_roaming_status (void **)

Gets the roaming status.

Returns

1 if roaming is enabled.
0 if roaming is disabled.

`wlan_host_11k_cfg`#

int wlan_host_11k_cfg (int *enable_11k*)

Enables or disables the host 802.11k feature.

Parameters

Parameter	In/Out	Description
`enable_11k`	in	the value of 8 • 0: Disable host 802.11k. • 1: Enable host 802.11k.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_host_11k_neighbor_req`#

int wlan_host_11k_neighbor_req (const char * *ssid*)

Host sends a neighbor report request.

Parameters

Parameter	In/Out	Description
`ssid`	in	The SSID for neighbor report.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_host_11v_bss_trans_query`#

int wlan_host_11v_bss_trans_query (t_u8 *query_reason*)

Host sends a BSS transition management query. STA sends BTM (BSS transition management) query, and the AP supporting 11V will response BTM request, the AP will parse neighbor report in the BTM request and response the BTM response to AP to indicate the receive status.

Parameters

Parameter	In/Out	Description
`query_reason`	in	[0..16] IEEE 802.11v BTM (BSS transition management) Query reasons. Refer to IEEE Std 802.11v-2011 - Table 7-43x-Transition and Transition Query reasons table.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_roaming`#

int wlan_set_roaming (const uint8_t *bitmap*, const uint8_t *rssi_low_threshold*, const uint8_t *snr_low_threshold*)

Sets soft roaming config.

Parameters

Parameter	In/Out	Description
`bitmap`	in	Roaming event bitmap (0=disable, bit0=RSSI_LOW, bit1=SNR_LOW)
`rssi_low_threshold`	in	RSSI low threshold value.
`snr_low_threshold`	in	SNR low threshold value.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

TWT (Target Wake Time)#

Function	Supported SoCs
`wlan_get_btwt_cfg`	RW612, IW610, IW612
`wlan_get_twt_report`	RW612, IW610, IW612
`wlan_get_twt_setup_cfg`	RW612, IW610, IW612
`wlan_get_twt_teardown_cfg`	RW612, IW610, IW612
`wlan_set_btwt_cfg`	RW612, IW610, IW612
`wlan_set_twt_setup_cfg`	RW612, IW610, IW612
`wlan_set_twt_teardown_cfg`	RW612, IW610, IW612
`wlan_twt_information`	RW612, IW610, IW612

`wlan_get_btwt_cfg`#

int wlan_get_btwt_cfg (wlan_btwt_config_t * *btwt_cfg*)

Gets broadcast TWT (target wake time) configuration parameters.

Parameters

Parameter	In/Out	Description
`btwt_cfg`	in	Broadcast TWT Setup parameters to be sent to Firmware.

Returns

WM_SUCCESS if successful otherwise failure.

`wlan_get_twt_report`#

int wlan_get_twt_report (wlan_twt_report_t * *twt_report*)

Gets TWT report.

Parameters

Parameter	In/Out	Description
`twt_report`	out	TWT report parameter.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_twt_setup_cfg`#

wlan_twt_setup_config_t * wlan_get_twt_setup_cfg (void **)

Gets TWT setup configuration parameters.

Returns

TWT setup parameters default array.

`wlan_get_twt_teardown_cfg`#

wlan_twt_teardown_config_t * wlan_get_twt_teardown_cfg (void **)

Gets TWT teardown configuration parameters.

Returns

TWT Teardown parameters default array.

`wlan_set_btwt_cfg`#

int wlan_set_btwt_cfg (wlan_btwt_config_t * *btwt_cfg*)

Sets broadcast TWT (target wake time) configuration parameters.

Parameters

Parameter	In/Out	Description
`btwt_cfg`	in	Broadcast TWT Setup parameters to be sent to Firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_twt_setup_cfg`#

int wlan_set_twt_setup_cfg (const wlan_twt_setup_config_t * *twt_setup*)

Sets TWT setup configuration parameters.

Parameters

Parameter	In/Out	Description
`twt_setup`	in	TWT setup parameters to be sent to firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_twt_teardown_cfg`#

int wlan_set_twt_teardown_cfg (const wlan_twt_teardown_config_t * *teardown_config*)

Sets TWT teardown configuration parameters.

Parameters

Parameter	In/Out	Description
`teardown_config`	in	TWT teardown parameters sent to firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_twt_information`#

int wlan_twt_information (wlan_twt_information_t * *twt_information*)

Twt information.

Parameters

Parameter	In/Out	Description
`twt_information`	out	TWT information.

Returns

WM_SUCCESS if successful otherwise failure.

WPS#

Function	Supported SoCs
`wlan_start_ap_wps_pbc`	All
`wlan_start_ap_wps_pin`	All
`wlan_start_wps_pbc`	All
`wlan_start_wps_pin`	All
`wlan_wps_ap_cancel`	All
`wlan_wps_cancel`	All
`wlan_wps_generate_pin`	All

`wlan_start_ap_wps_pbc`#

int wlan_start_ap_wps_pbc (void **)

Starts WPS PBC session.

Returns

WM_SUCCESS if successful.
-WM_FAIL if unsuccessful.

`wlan_start_ap_wps_pin`#

int wlan_start_ap_wps_pin (const char * *pin*)

Starts WPS pin session.

Parameters

Parameter	In/Out	Description
`pin`	in	Pin for WPS session.

Returns

WM_SUCCESS if the pin entered is valid.
-WM_FAIL if invalid pin entered.

`wlan_start_wps_pbc`#

int wlan_start_wps_pbc (const struct netif * *netif*)

Starts WPS PBC (push button configuration) session.

Parameters

Parameter	In/Out	Description
`netif`	in	Pointer to network interface structure.

Returns

WM_SUCCESS if successful.
-WM_FAIL if unsuccessful.

`wlan_start_wps_pin`#

int wlan_start_wps_pin (const struct netif * *netif*, const char * *pin*)

Starts WPS pin session.

Parameters

Parameter	In/Out	Description
`netif`	in	Pointer to network interface structure.
`pin`	in	Pin for WPS session.

Returns

WM_SUCCESS if the pin entered is valid.
-WM_FAIL if invalid pin entered.

`wlan_wps_ap_cancel`#

int wlan_wps_ap_cancel (void **)

Cancel AP’s WPS session.

Returns

WM_SUCCESS if successful.
-WM_FAIL if unsuccessful.

`wlan_wps_cancel`#

int wlan_wps_cancel (void **)

Cancel WPS session.

Returns

WM_SUCCESS if successful.
-WM_FAIL if unsuccessful.

`wlan_wps_generate_pin`#

void wlan_wps_generate_pin (uint32_t * *pin*)

This function generates a pin for WPS pin session.

Parameters

Parameter	In/Out	Description
`pin`	out	A pointer to a variable where the generated WPS pin will be stored.

DPP (Device Provisioning Protocol)#

Function	Supported SoCs
`wlan_dpp_auth_init`	RW612
`wlan_dpp_bootstrap_gen`	RW612
`wlan_dpp_bootstrap_get_uri`	RW612
`wlan_dpp_chirp`	RW612
`wlan_dpp_configurator_add`	RW612
`wlan_dpp_configurator_params`	RW612
`wlan_dpp_configurator_sign`	RW612
`wlan_dpp_listen`	RW612
`wlan_dpp_mud_url`	RW612
`wlan_dpp_pkex_add`	RW612
`wlan_dpp_qr_code`	RW612
`wlan_dpp_reconfig`	RW612
`wlan_dpp_stop_listen`	RW612

`wlan_dpp_auth_init`#

int wlan_dpp_auth_init (int *is_ap*, const char * *cmd*)

Sends provisioning auth request to responder.

Parameters

Parameter	In/Out	Description
`is_ap`	in	0 is STA, 1 is uAP.
`cmd`	in	“ peer= conf=<sta-dpp/ap-dpp/sta-psk> ….”.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_dpp_bootstrap_gen`#

int wlan_dpp_bootstrap_gen (int *is_ap*, const char * *cmd*)

Generates QR code.

Parameters

Parameter	In/Out	Description
`is_ap`	in	0 is STA, 1 is uAP.
`cmd`	in	“type=qrcode mac= chan=<operating-class/channel>…”.

Returns

bootstrap-id if successful otherwise return -WM_FAIL.

`wlan_dpp_bootstrap_get_uri`#

const char * wlan_dpp_bootstrap_get_uri (int *is_ap*, unsigned int *id*)

Gets QR code by bootstrap-id.

Parameters

Parameter	In/Out	Description
`is_ap`	in	0 is STA, 1 is uAP.
`id`	in	bootstrap-id.

Returns

QR code string if successful otherwise NULL.

`wlan_dpp_chirp`#

int wlan_dpp_chirp (int *is_ap*, const char * *cmd*)

sends DPP presence announcement.

Parameters

Parameter	In/Out	Description
`is_ap`	in	0 is STA, 1 is uAP.
`cmd`	in	“own= listen= …”.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_dpp_configurator_add`#

int wlan_dpp_configurator_add (int *is_ap*, const char * *cmd*)

Adds a DPP (device provisioning protocol) configurator.

Parameters

Parameter	In/Out	Description
`is_ap`	in	0 is STA, 1 is uAP.
`cmd`	in	“curve=P-256”.

Returns

configurator ID if successful otherwise return -WM_FAIL.

`wlan_dpp_configurator_params`#

void wlan_dpp_configurator_params (int *is_ap*, const char * *cmd*)

Sets DPP (device provisioning protocol) configurator parameter.

Parameters

Parameter	In/Out	Description
`is_ap`	in	0 is STA, 1 is uAP.
`cmd`	in	“ conf=<sta-dpp/ap-dpp/sta-psk> ssid= configurator=conf_id…”.

Returns

void.

`wlan_dpp_configurator_sign`#

int wlan_dpp_configurator_sign (int *is_ap*, const char * *cmd*)

Configurator configures itself as an Enrollee AP/STA.

Parameters

Parameter	In/Out	Description
`is_ap`	in	0 is STA, 1 is uAP.
`cmd`	in	“ conf=<sta-dpp/ap-dpp/sta-psk> ssid= configurator=conf_id…”.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_dpp_listen`#

int wlan_dpp_listen (int *is_ap*, const char * *cmd*)

Make device listen to DPP request.

Parameters

Parameter	In/Out	Description
`is_ap`	in	0 is STA, 1 is uAP.
`cmd`	in	“”.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_dpp_mud_url`#

void wlan_dpp_mud_url (int *is_ap*, const char * *cmd*)

MUD URL for enrollee’s DPP configuration request (optional).

Parameters

Parameter	In/Out	Description
`is_ap`	in	0 is STA, 1 is uAP.
`cmd`	in	“https://example.com/mud”.

Returns

void.

`wlan_dpp_pkex_add`#

int wlan_dpp_pkex_add (int *is_ap*, const char * *cmd*)

Sets bootstrapping through PKEX (Public Key Exchange).

Parameters

Parameter	In/Out	Description
`is_ap`	in	0 is STA, 1 is uAP.
`cmd`	in	“own=<bootstrap_id> identifier= code=”.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_dpp_qr_code`#

int wlan_dpp_qr_code (int *is_ap*, char * *uri*)

Enter the QR code in the DPP device.

Parameters

Parameter	In/Out	Description
`is_ap`	in	0 is STA, 1 is uAP.
`uri`	in	QR code provided by other device.

Returns

qr-code-id if successful otherwise return -WM_FAIL.

`wlan_dpp_reconfig`#

int wlan_dpp_reconfig (const char * *cmd*)

DPP reconfig.

Parameters

Parameter	In/Out	Description
`cmd`	in	“ …”.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_dpp_stop_listen`#

int wlan_dpp_stop_listen (int *is_ap*)

DPP stop listen.

Parameters

Parameter	In/Out	Description
`is_ap`	in	0 is STA, 1 is uAP.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

Wi-Fi Direct (P2P)#

Function	Supported SoCs
`wlan_p2p_cancel`	RW612
`wlan_p2p_connect`	RW612
`wlan_p2p_find`	RW612
`wlan_p2p_get_passphrase`	RW612
`wlan_p2p_group_add`	RW612
`wlan_p2p_group_remove`	RW612
`wlan_p2p_invite`	RW612
`wlan_p2p_list_network`	RW612
`wlan_p2p_listen`	RW612
`wlan_p2p_peer`	RW612
`wlan_p2p_peers`	RW612
`wlan_p2p_prov_disc`	RW612
`wlan_p2p_remove_client`	RW612
`wlan_p2p_serv_disc_req`	RW612
`wlan_p2p_serv_disc_resp`	RW612
`wlan_p2p_servvice_add`	RW612
`wlan_p2p_set_listen_channel`	RW612
`wlan_p2p_status`	RW612
`wlan_p2p_stop_find`	RW612

`wlan_p2p_cancel`#

int wlan_p2p_cancel (void **)

Cancel ongoing P2P operations.

Returns

WM_SUCCESS if successful otherwise return -WM_FAIL.

`wlan_p2p_connect`#

int wlan_p2p_connect (char * *cmd*)

Initiate a P2P connection.

Parameters

Parameter	In/Out	Description
`cmd`	in	Connection parameters (e.g. Peer device address, WPS method etc).

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_find`#

int wlan_p2p_find (const char * *cmd*)

Initiate P2P discovery.

Parameters

Parameter	In/Out	Description
`cmd`	in	Optional parameters for discovery (e.g., timeout, type).

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_get_passphrase`#

int wlan_p2p_get_passphrase (void **)

Retrieves the group passphrase.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_group_add`#

int wlan_p2p_group_add (char * *cmd*)

Create a new P2P group.

Parameters

Parameter	In/Out	Description
`cmd`	in	Group configuration parameters.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_group_remove`#

int wlan_p2p_group_remove (char * *cmd*)

Tear down an existing P2P group.

Parameters

Parameter	In/Out	Description
`cmd`	in	The wfd interface name.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_invite`#

int wlan_p2p_invite (char * *cmd*)

Issue a group invitation.

Parameters

Parameter	In/Out	Description
`cmd`	in	Invitation parameters (e.g. Peer address, Group address etc).

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_list_network`#

int wlan_p2p_list_network (char * *buf*, size_t *buflen*, int * *reslen*)

Retrieves configured networks on a P2P interface.

Parameters

Parameter	In/Out	Description
`buf`	out	Pointer to the buffer that will receive the detailed information.
`buflen`	in	The total size of the buf in bytes.
`reslen`	out	Pointer to an integer where the actual length (in bytes) of data written to buf will be stored.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_listen`#

int wlan_p2p_listen (const char * *cmd*)

Initiates P2P listen mode.

Parameters

Parameter	In/Out	Description
`cmd`	in	Optional parameters for listen (e.g. timeout).

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_peer`#

int wlan_p2p_peer (char * *cmd*, char * *peer_info_buf*, int *peer_info_buf_size*, int * *peer_info_len*)

Retrieves detailed information for a specified P2P peer.

Parameters

Parameter	In/Out	Description
`cmd`	in	A generic command string passed to wpa_cli. It should include the necessary parameters (e.g., “p2p_peer <peer_address>”) to specify the target peer.
`peer_info_buf`	out	Pointer to the buffer that will receive the detailed peer information.
`peer_info_buf_size`	in	The total size of the peer_info_buf in bytes.
`peer_info_len`	out	Pointer to an integer where the actual length (in bytes) of data written to peer_info_buf will be stored.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_peers`#

int wlan_p2p_peers (char * *peers_buf*, int *peer_buf_size*, int * *peers_buf_len*)

Retrieves the list of available P2P peers.

Parameters

Parameter	In/Out	Description
`peers_buf`	out	Pointer to the buffer that will receive the list of peer addresses or identifiers.
`peer_buf_size`	in	The total size of the peers_buf in bytes.
`peers_buf_len`	out	Pointer to an integer where the actual length (in bytes) of data written to peers_buf will be stored.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_prov_disc`#

int wlan_p2p_prov_disc (char * *cmd*)

Initiate provisioning discovery.

Parameters

Parameter	In/Out	Description
`cmd`	in	Povisioning discovery parameters (e.g. device_addr, config_methods etc).

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_remove_client`#

int wlan_p2p_remove_client (char * *cmd*)

Removes a client from the P2P group.

Parameters

Parameter	In/Out	Description
`cmd`	in	The address of the client to be removed.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_serv_disc_req`#

int wlan_p2p_serv_disc_req (char * *cmd*)

Sends a service discovery request.

Parameters

Parameter	In/Out	Description
`cmd`	in	Service discovery request parameters.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_serv_disc_resp`#

int wlan_p2p_serv_disc_resp (char * *cmd*)

Sends a service discovery response.

Parameters

Parameter	In/Out	Description
`cmd`	in	Service discovery response parameters.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_servvice_add`#

int wlan_p2p_servvice_add (char * *cmd*)

Advertise a service.

Parameters

Parameter	In/Out	Description
`cmd`	in	A string or binary blob representing the service data.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_set_listen_channel`#

int wlan_p2p_set_listen_channel (t_u8 *channel*, t_u8 *op_class*)

Sets P2P Listen channel.

Parameters

Parameter	In/Out	Description
`channel`	in	Channel to listen on.
`op_class`	in	Operating class of for listen channel.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_status`#

int wlan_p2p_status (char * *buf*, size_t *buflen*, int * *reslen*)

Retrieves detailed information for a P2P interface.

Parameters

Parameter	In/Out	Description
`buf`	out	Pointer to the buffer that will receive the detailed information.
`buflen`	in	The total size of the buf in bytes.
`reslen`	out	Pointer to an integer where the actual length (in bytes) of data written to buf will be stored.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_p2p_stop_find`#

int wlan_p2p_stop_find (void **)

Stops the P2P discovery process.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

NAN (Neighbor Awareness Networking)#

Function	Supported SoCs
`wlan_nan_cancel_publish`	RW612
`wlan_nan_cancel_subscribe`	RW612
`wlan_nan_publish`	RW612
`wlan_nan_subscribe`	RW612
`wlan_nan_transmit`	RW612
`wlan_nan_update_publish`	RW612

`wlan_nan_cancel_publish`#

int wlan_nan_cancel_publish (int *publish_id*)

Cancel NAN USD publish.

Parameters

Parameter	In/Out	Description
`publish_id`	in	publish id to cancel.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_nan_cancel_subscribe`#

int wlan_nan_cancel_subscribe (int *subscribe_id*)

Cancel NAN USD subscribe.

Parameters

Parameter	In/Out	Description
`subscribe_id`	in	subscribe id to cancel.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_nan_publish`#

int wlan_nan_publish (wlan_nan_publish_params_t * *nan_publish*)

Initiate NAN USD publisher.

Parameters

Parameter	In/Out	Description
`nan_publish`	in	A pointer to wlan_nan_publish_params_t to store nan publish parameters.

Returns

publish id if successful otherwise return -WM_FAIL.

`wlan_nan_subscribe`#

int wlan_nan_subscribe (wlan_nan_subscribe_params_t * *nan_subscribe*)

Initiate NAN USD subscriber.

Parameters

Parameter	In/Out	Description
`nan_subscribe`	in	A pointer to wlan_nan_subscribe_params_t to store nan subscribe parameters.

Returns

subscribe id if successful otherwise return -WM_FAIL.

`wlan_nan_transmit`#

int wlan_nan_transmit (int *own_id*, int *peer_id*, uint8_t * *peer_mac*, char * *ssi_tx*)

Initiate NAN USD subscriber.

Parameters

Parameter	In/Out	Description
`own_id`	in	own publish id or subscribe id
`peer_id`	in	peer’s id
`peer_mac`	in	peer’s MAC address
`ssi_tx`	in	service specific information (hexdump)

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_nan_update_publish`#

int wlan_nan_update_publish (int *publish_id*, char * *ssi_update*)

Update NAN USD publish.

Parameters

Parameter	In/Out	Description
`publish_id`	in	Publish session ID to update.
`ssi_update`	in	Updated service specific information string (hexdump).

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

CSI (Channel State Information)#

Function	Supported SoCs
`wlan_csi_cfg`	RW612, IW610
`wlan_get_csi_cfg_param_default`	RW612, IW610
`wlan_register_csi_user_callback`	RW612, IW610
`wlan_reset_csi_filter_data`	RW612, IW610
`wlan_set_csi_cfg_param_default`	RW612, IW610
`wlan_unregister_csi_user_callback`	RW612, IW610

`wlan_csi_cfg`#

int wlan_csi_cfg (wlan_csi_config_params_t * *csi_params*)

Sends the CSI configuration parameter to the firmware.

Parameters

Parameter	In/Out	Description
`csi_params`	in	CSI configuration parameter

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_csi_cfg_param_default`#

wlan_csi_config_params_t * wlan_get_csi_cfg_param_default (void **)

This function gets CSI default configuration data.

Returns

CSI data pointer.

`wlan_register_csi_user_callback`#

int wlan_register_csi_user_callback (int(*)(void *buffer, size_t len) *csi_data_recv_callback*)

This function registers callback which are used to deliver CSI (channel state information) data to user.

Parameters

Parameter	In/Out	Description
`csi_data_recv_callback`	in	Callback to deliver CSI data and max data length is 768 bytes. Process data as soon as possible in callback, or else shall block there. Type of callback return value is int. Memory layout of buffer: size(byte) items Memory layout of buffer (size in bytes: item): - • 2: Buffer length [bit. • 0: 12]. -. • 2: CSI signature. • 4: User defined HeaderID. -. • 2: Packet info. -. • 2: Frame control field for the received packet. -. • 8: Timestamp when packet received. -. • 6: Received packet destination MAC Address. -. • 6: Received packet source MAC address. -. • 1: RSSI for antenna A. -. • 1: RSSI for antenna B. -. • 1: Noise floor for antenna A. -. • 1: Noise floor for antenna B. -. • 1: RX signal strength above noise floor. -. • 1: Channel. -. • 2: User defined chip ID. -. • 4: Reserved. -. • 4: CSI data length in DWORDs. CSI data.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_reset_csi_filter_data`#

void wlan_reset_csi_filter_data (void **)

This function resets Wi-Fi CSI filter data.

`wlan_set_csi_cfg_param_default`#

int wlan_set_csi_cfg_param_default (wlan_csi_config_params_t * *in_csi_cfg*)

This function sets CSI default configuration data.

Parameters

Parameter	In/Out	Description
`in_csi_cfg`	in	CSI default configuration data to be set.

Returns

if successful return 1 else return 0.

`wlan_unregister_csi_user_callback`#

int wlan_unregister_csi_user_callback (void **)

This function unregisters callback, which are used to deliver CSI data to the user.

Returns

WM_SUCCESS if successful.

FTM / 802.11az Ranging#

Function	Supported SoCs
`wlan_ftm_11mc_cfg`	IW612
`wlan_ftm_cfg`	IW612
`wlan_ftm_civic_cfg`	IW612
`wlan_ftm_location_cfg`	IW612
`wlan_ftm_start_stop`	IW612

`wlan_ftm_11mc_cfg`#

int wlan_ftm_11mc_cfg (ftm_11mc_nego_cfg_t * *ftm_11mc_nego_cfg*)

`wlan_ftm_cfg`#

int wlan_ftm_cfg (const t_u8 *protocol*, ranging_11az_cfg_t * *ftm_ranging_cfg*)

Configures the FTM protocol.

Parameters

Parameter	In/Out	Description
`protocol`	in	0: Dot11mc, 1: Dot11az_ntb, 2: Dot11az_tb.
`ftm_ranging_cfg`	in	FTM ranging config.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_ftm_civic_cfg`#

int wlan_ftm_civic_cfg (location_civic_rep_t * *ftm_civic_cfg*)

`wlan_ftm_location_cfg`#

int wlan_ftm_location_cfg (location_cfg_info_t * *ftm_location_cfg*)

`wlan_ftm_start_stop`#

int wlan_ftm_start_stop (const t_u16 *action*, const t_u8 *loop_cnt*, const t_u8 * *mac*, const t_u8 *channel*)

Starts or stops FTM (Wi-Fi fine time measurement) based on the command from CLI.

Parameters

Parameter	In/Out	Description
`action`	in	• 1: start FTM. • 2: stop FTM.
`loop_cnt`	in
`mac`	in
`channel`	in

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

MBO (Multi-Band Operation)#

Function	Supported SoCs
`wlan_mbo_peferch_cfg`	RW612, IW610, IW612
`wlan_mbo_set_cell_capa`	RW612, IW610, IW612
`wlan_mbo_set_oce`	RW612, IW610, IW612

`wlan_mbo_peferch_cfg`#

int wlan_mbo_peferch_cfg (const char * *non_pref_chan*)

Multi band operation (MBO) non-preferred channels.

Parameters

Parameter	In/Out	Description
`non_pref_chan`	in	list of non-preferred channels.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_mbo_set_cell_capa`#

int wlan_mbo_set_cell_capa (t_u8 *cell_capa*)

MBO set cellular data capabilities.

Parameters

Parameter	In/Out	Description
`cell_capa`	in	1 = Cellular data connection available. 2 = Cellular data connection not available 3 = Not cellular capable (default)

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_mbo_set_oce`#

int wlan_mbo_set_oce (t_u8 *oce*)

Optimized connectivity experience (OCE).

Parameters

Parameter	In/Out	Description
`oce`	in	Enable OCE features. 1 = Enable OCE in non-AP STA mode (default; disabled if the driver does not indicate support for OCE in STA mode). 2 = Enable OCE in STA-CFON mode.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

MEF (Management Entity Filter)#

Function	Supported SoCs
`wlan_config_mef`	RW612, IW610
`wlan_mef_set_auto_arp`	RW612, IW610
`wlan_mef_set_auto_ping`	RW612, IW610
`wlan_mef_set_multicast`	RW612, IW610

`wlan_config_mef`#

int wlan_config_mef (int *type*, t_u8 *mef_action*)

This function sets/deletes MEF entries configuration.

Parameters

Parameter	In/Out	Description
`type`	in	MEF type: MEF_TYPE_DELETE, MEF_TYPE_AUTO_PING, MEF_TYPE_AUTO_ARP.
`mef_action`	in	To be 0discard and not wake host, 1discard and wake host 3allow and wake host.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

`wlan_mef_set_auto_arp`#

int wlan_mef_set_auto_arp (t_u8 *mef_action*)

This function sets auto ARP configuration.

Parameters

Parameter	In/Out	Description
`mef_action`	in	To be 0discard and not wake host, 1discard and wake host, 3allow and wake host.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_mef_set_auto_ping`#

int wlan_mef_set_auto_ping (t_u8 *mef_action*)

This function sets auto ping configuration.

Parameters

Parameter	In/Out	Description
`mef_action`	in	To be • 0: Discard ping packet and not wake host. • 1: Discard ping packet and wake host. • 3: Allow ping packet and wake host.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_mef_set_multicast`#

int wlan_mef_set_multicast (t_u8 *mef_action*)

This function sets multicast packet as low power wake up condition.

Parameters

Parameter	In/Out	Description
`mef_action`	in	To be • 0: Discard multicast packet and not wake host. • 1: Discard multicast packet and wake host. • 3: Allow multicast packet and wake host.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

Network Monitor#

Function	Supported SoCs
`wlan_deregister_net_monitor_user_callback`	RW612, IW610
`wlan_net_monitor_cfg`	RW612, IW610
`wlan_register_monitor_user_callback`	RW612, IW610

`wlan_deregister_net_monitor_user_callback`#

void wlan_deregister_net_monitor_user_callback (void **)

This function deregisters the monitor callback.

`wlan_net_monitor_cfg`#

int wlan_net_monitor_cfg (wlan_net_monitor_t * *monitor*)

Sends the network monitor configuration parameter to the firmware.

Parameters

Parameter	In/Out	Description
`monitor`	in	Monitor configuration parameter

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_register_monitor_user_callback`#

void wlan_register_monitor_user_callback (int(*)(void *buffer, t_u16 data_len) *monitor_data_recv_callback*)

This function registers callback, which are used to deliver monitor data to the user.

Parameters

Parameter	In/Out	Description
`monitor_data_recv_callback`	in	Callback to deliver monitor data and data length to user. Memory layout of buffer: offset(byte) items Memory layout of buffer (offset in bytes: item): • 0: RSSI. • 1: 802.11 MAC header. 1 + size of 802.11 MAC header: Frame body.

ED MAC Control#

Function	Supported SoCs
`wlan_get_ed_mac_mode`	All
`wlan_set_ed_mac_mode`	All

`wlan_get_ed_mac_mode`#

int wlan_get_ed_mac_mode (wlan_ed_mac_ctrl_t * *wlan_ed_mac_ctrl*)

This API can be used to get the current ED MAC mode configuration for the station.

Parameters

Parameter	In/Out	Description
`wlan_ed_mac_ctrl`	out	A pointer to wlan_ed_mac_ctrl_t as described in the corresponding set API.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

`wlan_set_ed_mac_mode`#

int wlan_set_ed_mac_mode (wlan_ed_mac_ctrl_t *wlan_ed_mac_ctrl*)

Configures Energy Detect MAC mode for the station in the Wi-Fi Firmware.

Parameters

Parameter	In/Out	Description
`wlan_ed_mac_ctrl`	in	Struct with following parameters ed_ctrl_2g = • 0: Disable EU adaptivity for 2.4 GHz band. ed_ctrl_2g =. • 1: Enable EU adaptivity for 2.4 GHz band. ed_offset_2g =. • 0: Default Energy Detect threshold (0x9). ed_offset_2g = other: Offset value in range 0x80 to 0x7F.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

RF & PHY Configuration#

Function	Supported SoCs
`wlan_auto_null_tx`	RW612, IW610
`wlan_external_coex_pta_cfg`	RW612
`wlan_get_mmsf`	RW612, IW610
`wlan_get_rx_abort_cfg_ext`	RW612, IW610
`wlan_get_tsp_cfg`	RW612, IW610
`wlan_set_ami_cfg`	RW612
`wlan_set_clocksync_cfg`	RW612, IW610
`wlan_set_get_cck_desense_cfg`	RW612, IW610
`wlan_set_get_rx_abort_cfg`	RW612, IW610
`wlan_set_mmsf`	RW612, IW610
`wlan_set_rx_abort_cfg_ext`	RW612, IW610
`wlan_set_tsp_cfg`	RW612, IW610
`wlan_start_stop_ami`	RW612

`wlan_auto_null_tx`#

int wlan_auto_null_tx (wlan_auto_null_tx_t * *auto_null_tx*, mlan_bss_type *bss_type*)

Start/Stop auto TX null. Call this API to auto transmit and one shot quality of service data packets to get the CSI after STA connected one AP or uAP was connected with external STA.

Parameters

Parameter	In/Out	Description
`auto_null_tx`	in	auto null RX information.
`bss_type`	in	• 0: station;. • 1: uAP.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_external_coex_pta_cfg`#

int wlan_external_coex_pta_cfg (ext_coex_pta_cfg *coex_pta_config*)

Sets the external coex PTA (packet traffic arbitration) parameters.

Parameters

Parameter	In/Out	Description
`coex_pta_config`	in	ext_coex_pta_cfg.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_mmsf`#

int wlan_get_mmsf (t_u8 * *enable*, t_u8 * *Density*, t_u8 * *MMSF*)

Gets 802.11ax AMPDU density configuration.

Parameters

Parameter	In/Out	Description
`enable`	out	0 - Disable MMSF; 1 - Enable MMSF.
`Density`	out	AMPDU Density value.
`MMSF`	out	AMPDU MMSF value. Default value is 0x6.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_rx_abort_cfg_ext`#

int wlan_get_rx_abort_cfg_ext (struct wlan_rx_abort_cfg_ext * *cfg*)

Gets the dynamic RX abort configuration from the firmware.

Parameters

Parameter	In/Out	Description
`cfg`	out	A pointer to information buffer.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_tsp_cfg`#

int wlan_get_tsp_cfg (t_u16 * *enable*, t_u32 * *back_off*, t_u32 * *highThreshold*, t_u32 * *lowThreshold*, t_u32 * *dutycycstep*, t_u32 * *dutycycmin*, int * *highthrtemp*, int * *lowthrtemp*, t_u32 * *throttledutycycle*, t_u32 * *rftemppollcnt*, int * *currCAUTemp*, int * *currRFUTemp*)

Gets the TSP (thermal safeguard protection) configuration. TSP algorithm monitors PA Tj and primarily backs off data throughput.

Parameters

Parameter	In/Out	Description
`enable`	out	Enable/Disable TSP algorithm.
`back_off`	out	Power back off [0…20]dB.
`highThreshold`	out	High threshold [0…300]°C.
`lowThreshold`	out	Low threshold [0…300]°C High Threshold is Greater than low threshold.
`dutycycstep`	out	Duty cycle step(percentage)
`dutycycmin`	out	Duty cycle min(percentage)
`highthrtemp`	out	High throttle threshold temperature(celsius)
`lowthrtemp`	out	Low throttle threshold temperature(celsius)
`throttledutycycle`	out	Throttled duty cycle [3…100] (percentage)
`rftemppollcnt`	out	RFU temperature poll/averaging count [1…100] (number of samples per average)
`currCAUTemp`	out	CAU TSEN temperature.
`currRFUTemp`	out	RFU temperature.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_ami_cfg`#

void wlan_set_ami_cfg (wlan_csi_proc_cfg * *cfg*)

This function sets Ambient Motion Index configuration.

Parameters

Parameter	In/Out	Description
`cfg`	in	Ambient Motion Index configuration.

`wlan_set_clocksync_cfg`#

int wlan_set_clocksync_cfg (const wlan_clock_sync_gpio_tsf_t * *tsf_latch*)

Sets clock sync GPIO based TSF (time synchronization function).

Parameters

Parameter	In/Out	Description
`tsf_latch`	in	Clock sync TSF latch parameters to be sent to firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_get_cck_desense_cfg`#

int wlan_set_get_cck_desense_cfg (struct wlan_cck_desense_cfg * *cfg*, t_u16 *action*)

Gets or sets the CCK (complementary code keying) desense configuration to/from firmware.

Parameters

Parameter	In/Out	Description
`cfg`	inout	A pointer to information buffer.
`action`	in	get or set.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_get_rx_abort_cfg`#

int wlan_set_get_rx_abort_cfg (struct wlan_rx_abort_cfg * *cfg*, t_u16 *action*)

Gets or sets the RX abort configuration to or from the firmware.

Parameters

Parameter	In/Out	Description
`cfg`	inout	A pointer to information buffer.
`action`	in	Command action: get or set.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_mmsf`#

int wlan_set_mmsf (const t_u8 *enable*, const t_u8 *Density*, const t_u8 *MMSF*)

Sets 802.11ax AMPDU (aggregate medium access control (MAC) protocol data unit) density configuration.

Parameters

Parameter	In/Out	Description
`enable`	in	0 - Disable MMSF; 1 - Enable MMSF.
`Density`	in	AMPDU density value. Default value is 0x30.
`MMSF`	in	AMPDU MMSF value. Default value is 0x6.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rx_abort_cfg_ext`#

int wlan_set_rx_abort_cfg_ext (const struct wlan_rx_abort_cfg_ext * *cfg*)

Sets the dynamic RX abort configuration to the firmware.

Parameters

Parameter	In/Out	Description
`cfg`	in	A pointer to information buffer.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_tsp_cfg`#

int wlan_set_tsp_cfg (t_u16 *enable*, t_u32 *back_off*, t_u32 *highThreshold*, t_u32 *lowThreshold*, t_u32 *dutycycstep*, t_u32 *dutycycmin*, int *highthrtemp*, int *lowthrtemp*, t_u32 *rftemppollcnt*)

Sets the TSP (thermal safeguard protection) configuration. TSP algorithm monitors and primarily backs off data throughput.

Parameters

Parameter	In/Out	Description
`enable`	in	Enable/Disable tsp algorithm.
`back_off`	in	Power back off [0…20]dB.
`highThreshold`	in	High threshold [0…300]Celsius.
`lowThreshold`	in	Low threshold [0…300]Celsius High threshold is greater than low threshold.
`dutycycstep`	in	Duty cycle step(percentage)
`dutycycmin`	in	Duty cycle min(percentage)
`highthrtemp`	out	High throttle threshold temperature (celsius)
`lowthrtemp`	out	Low throttle threshold temperature (celsius)
`rftemppollcnt`	in	RFU temperature poll/averaging count [1…100] (number of samples per average)

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_start_stop_ami`#

void wlan_start_stop_ami (uint8_t *start*)

Use this API to start or stop calculate Ambient Motion Index.

Parameters

Parameter	In/Out	Description
`start`	in	start/stop • 0: Stop. • 1: Start.

Event Subscription#

Function	Supported SoCs
`wlan_clear_subscribe_event`	RW612, IW610
`wlan_get_subscribe_event`	RW612, IW610
`wlan_set_subscribe_event`	RW612, IW610
`wlan_set_threshold_link_quality`	RW612, IW610

`wlan_clear_subscribe_event`#

int wlan_clear_subscribe_event (unsigned int *event_id*)

Cancel the subscribe event to firmware.

Parameters

Parameter	In/Out	Description
`event_id`	in	event id to clear as per sub_event_id.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_subscribe_event`#

int wlan_get_subscribe_event (wlan_ds_subscribe_evt * *sub_evt*)

Gets all subscribed events from Wi-Fi firmware along with threshold value and report frequency.

Parameters

Parameter	In/Out	Description
`sub_evt`	out	A pointer to wlan_ds_subscribe_evt to store the events data.

Returns

WM_SUCCESS if set successfully, otherwise return failure.

`wlan_set_subscribe_event`#

int wlan_set_subscribe_event (unsigned int *event_id*, unsigned int *thresh_value*, unsigned int *freq*)

Subscribe specified event from the Wi-Fi firmware. Wi-Fi firmware report the registered event to driver upon configured report conditions are met.

Parameters

Parameter	In/Out	Description
`event_id`	in	event to register as per sub_event_id except for EVENT_SUB_LINK_QUALITY.
`thresh_value`	in	the RSSI threshold value (dBm)
`freq`	in	event frequency 0report once, 1report every time happened, N report only happened > N consecutive times.

Returns

WM_SUCCESS if set successfully, otherwise return failure.

`wlan_set_threshold_link_quality`#

int wlan_set_threshold_link_quality (unsigned int *event_id*, unsigned int *link_snr*, unsigned int *link_snr_freq*, unsigned int *link_rate*, unsigned int *link_rate_freq*, unsigned int *link_tx_latency*, unsigned int *link_tx_latency_freq*)

Subscribe link quality event.

Parameters

Parameter	In/Out	Description
`event_id`	in
`link_snr`	in	link quality snr value.
`link_snr_freq`	in	link quality snr freq.
`link_rate`	in	link quality rate.
`link_rate_freq`	in	link quality rate freq.
`link_tx_latency`	in	link quality write latency.
`link_tx_latency_freq`	in	link quality write latency freq.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

Management Frame#

Function	Supported SoCs
`wlan_remain_on_channel`	All
`wlan_rx_mgmt_indication`	All
`wlan_set_sta_mac_filter`	All

`wlan_remain_on_channel`#

int wlan_remain_on_channel (const enum wlan_bss_type *bss_type*, const bool *status*, const uint8_t *channel*, const uint32_t *duration*)

This API is used to set/cancel the remain on channel configuration.

Parameters

Parameter	In/Out	Description
`bss_type`	in	The interface to set channel bss_type 0: STA, 1: uAP.
`status`	in	false : Cancel the remain on channel configuration true : Set the remain on channel configuration.
`channel`	in	The channel to configure.
`duration`	in	The duration for which to remain on the channel in milliseconds.

Returns

WM_SUCCESS on success or error code.

`wlan_rx_mgmt_indication`#

int wlan_rx_mgmt_indication (const enum wlan_bss_type *bss_type*, const uint32_t *mgmt_subtype_mask*, int(*)(const enum wlan_bss_type bss_type, const wlan_mgmt_frame_t *frame, const size_t len) *rx_mgmt_callback*)

This API can be used to start/stop the management frame forwarded to host through data path.

Parameters

Parameter	In/Out	Description
`bss_type`	in	The interface from which management frame needs to be collected 0: STA, 1: uAP.
`mgmt_subtype_mask`	in	Management Subtype Mask If Bit X is set in mask, it means that IEEE Management Frame SubType X is to be filtered and passed through to host. Bit Description [ • 31: 14] Reserved [13] Action frame [12:9] Reserved [8] Beacon [7:6] Reserved [5] Probe response [4] Probe request [3] Reassociation response [2] Reassociation request [1] Association response [0] Association request Support multiple bits set. • 0: Stop forwarding frames. • 1: Start forwarding frames.
`rx_mgmt_callback`	in	The receive callback where the received management frames are passed.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_set_sta_mac_filter`#

int wlan_set_sta_mac_filter (int *filter_mode*, int *mac_count*, unsigned char * *mac_addr*)

Sets the STA MAC filter in Wi-Fi firmware. Apply for uAP mode only. When STA MAC filter enabled, wlan firmware blocks all the packets from station with MAC address in black list and not blocks packets from station with MAC address in white list.

Parameters

Parameter	In/Out	Description
`filter_mode`	in	Channel filter mode (disable/white/black list)
`mac_count`	in	The count of MAC list.
`mac_addr`	in	The pointer to MAC address list.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

Security & Crypto#

Function	Supported SoCs
`wlan_free_entp_cert_files`	RW612, IW610
`wlan_get_entp_cert_files`	RW612, IW610
`wlan_get_pmfcfg`	All
`wlan_pmksa_flush`	All
`wlan_pmksa_list`	All
`wlan_set_crypto_AES_CCMP_decrypt`	All
`wlan_set_crypto_AES_CCMP_encrypt`	All
`wlan_set_crypto_AES_ECB_decrypt`	All
`wlan_set_crypto_AES_ECB_encrypt`	All
`wlan_set_crypto_AES_GCMP_decrypt`	All
`wlan_set_crypto_AES_GCMP_encrypt`	All
`wlan_set_crypto_AES_WRAP_decrypt`	All
`wlan_set_crypto_AES_WRAP_encrypt`	All
`wlan_set_crypto_RC4_decrypt`	All
`wlan_set_crypto_RC4_encrypt`	All
`wlan_set_entp_cert_files`	RW612, IW610
`wlan_set_okc`	All
`wlan_set_reassoc_control`	All

`wlan_free_entp_cert_files`#

void wlan_free_entp_cert_files (void **)

This function frees the temporary memory of enterprise certificate data After add new enterprise network profile, the certificate data has been parsed by mbedtls into another data, which can be freed.

`wlan_get_entp_cert_files`#

t_u32 wlan_get_entp_cert_files (int *cert_type*, t_u8 ** *data*)

This function gets enterprise certificate data from “wlan” global structure.

Parameters

Parameter	In/Out	Description
`cert_type`	in	certificate file type: • 1: FILE_TYPE_ENTP_CA_CERT. • 2: FILE_TYPE_ENTP_CLIENT_CERT. • 3: FILE_TYPE_ENTP_CLIENT_KEY.
`data`	out	raw data of the enterprise certificate file.

Returns

size of raw data.

`wlan_get_pmfcfg`#

int wlan_get_pmfcfg (uint8_t * *mfpc*, uint8_t * *mfpr*)

Use this API to get the management frame protection parameters for sta.

Parameters

Parameter	In/Out	Description
`mfpc`	out	Management frame protection capable (MFPC) • 0: Management frame protection not capable. • 1: Management frame protection capable.
`mfpr`	out	Management frame protection required (MFPR) • 0: Management frame protection optional. • 1: Management frame protection required.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_pmksa_flush`#

int wlan_pmksa_flush (void **)

Flush PTKSA cache entries.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_pmksa_list`#

int wlan_pmksa_list (char * *buf*, size_t *buflen*)

Dumps the text list of entries in the PMKSA (pairwise master key security association) cache.

Parameters

Parameter	In/Out	Description
`buf`	out	Buffer to save PMKSA cache text list.
`buflen`	in	length of the buffer.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_crypto_AES_CCMP_decrypt`#

int wlan_set_crypto_AES_CCMP_decrypt (const t_u8 * *Key*, const t_u16 *KeyLength*, const t_u8 * *AAD*, const t_u16 *AADLength*, const t_u8 * *Nonce*, const t_u16 *NonceLength*, t_u8 * *Data*, t_u16 * *DataLength*)

Sets crypto AES_GCMP algorithm decrypt command parameters.

Parameters

Parameter	In/Out	Description
`Key`	in	key.
`KeyLength`	in	The key length is 16/32.
`AAD`	in	AAD.
`AADLength`	in	The maximum AAD length is 30.
`Nonce`	in	Nonce.
`NonceLength`	in	The nonce length valid range [7,13].
`Data`	in	Data.
`DataLength`	in	The maximum data length is 80.

Returns

WM_SUCCESS if successful.
-WM_E_PERM if not supported.
-WM_FAIL if failed.

`wlan_set_crypto_AES_CCMP_encrypt`#

int wlan_set_crypto_AES_CCMP_encrypt (const t_u8 * *Key*, const t_u16 *KeyLength*, const t_u8 * *AAD*, const t_u16 *AADLength*, const t_u8 * *Nonce*, const t_u16 *NonceLength*, t_u8 * *Data*, t_u16 * *DataLength*)

Sets crypto AES_CCMP (counter mode with cipher block chaining message authentication code protocol) algorithm encrypt command parameters.

Parameters

Parameter	In/Out	Description
`Key`	in	key.
`KeyLength`	in	The key length is 16/32.
`AAD`	in	AAD.
`AADLength`	in	The maximum AAD length is 30.
`Nonce`	in	Nonce.
`NonceLength`	in	The nonce length valid range [7,13].
`Data`	in	Data.
`DataLength`	in	The maximum data length is 80.

Returns

WM_SUCCESS if successful.
-WM_E_PERM if not supported.
-WM_FAIL if failed.

`wlan_set_crypto_AES_ECB_decrypt`#

int wlan_set_crypto_AES_ECB_decrypt (const t_u8 * *Key*, const t_u16 *KeyLength*, const t_u8 * *KeyIV*, const t_u16 *KeyIVLength*, t_u8 * *Data*, t_u16 * *DataLength*)

Sets crypto AES_ECB (advanced encryption standard, electronic codebook) algorithm decrypt command parameters.

Parameters

Parameter	In/Out	Description
`Key`	in	key.
`KeyLength`	in	The key length is 16/24/32.
`KeyIV`	in	KeyIV should point to a 8 bytes array with any value in the array.
`KeyIVLength`	in	The keyIV length is 8.
`Data`	in	Data.
`DataLength`	in	The data length is 16.

Returns

WM_SUCCESS if successful.
-WM_E_PERM if not supported.
-WM_FAIL if failed.

`wlan_set_crypto_AES_ECB_encrypt`#

int wlan_set_crypto_AES_ECB_encrypt (const t_u8 * *Key*, const t_u16 *KeyLength*, const t_u8 * *KeyIV*, const t_u16 *KeyIVLength*, t_u8 * *Data*, t_u16 * *DataLength*)

Sets crypto AES_ECB (advanced encryption standard, electronic codebook) algorithm encrypt command parameters.

Parameters

Parameter	In/Out	Description
`Key`	in	key.
`KeyLength`	in	The key length is 16/24/32.
`KeyIV`	in	KeyIV should point to a 8 bytes array with any value in the array.
`KeyIVLength`	in	The keyIV length is 8.
`Data`	in	Data.
`DataLength`	in	The data length is 16.

Returns

WM_SUCCESS if successful.
-WM_E_PERM if not supported.
-WM_FAIL if failed.

`wlan_set_crypto_AES_GCMP_decrypt`#

int wlan_set_crypto_AES_GCMP_decrypt (const t_u8 * *Key*, const t_u16 *KeyLength*, const t_u8 * *AAD*, const t_u16 *AADLength*, const t_u8 * *Nonce*, const t_u16 *NonceLength*, t_u8 * *Data*, t_u16 * *DataLength*)

Sets crypto AES_GCMP algorithm decrypt command parameters.

Parameters

Parameter	In/Out	Description
`Key`	in	key.
`KeyLength`	in	The key length is 16/32.
`AAD`	in	AAD.
`AADLength`	in	The maximum AAD length is 30.
`Nonce`	in	Nonce.
`NonceLength`	in	The nonce length valid range [7,13].
`Data`	in	Data.
`DataLength`	in	The maximum data length is 80.

Returns

WM_SUCCESS if successful.
-WM_E_PERM if not supported.
-WM_FAIL if failed.

`wlan_set_crypto_AES_GCMP_encrypt`#

int wlan_set_crypto_AES_GCMP_encrypt (const t_u8 * *Key*, const t_u16 *KeyLength*, const t_u8 * *AAD*, const t_u16 *AADLength*, const t_u8 * *Nonce*, const t_u16 *NonceLength*, t_u8 * *Data*, t_u16 * *DataLength*)

Sets crypto AES_GCMP (galois/counter mode with AES-GMAC) algorithm encrypt command parameters.

Parameters

Parameter	In/Out	Description
`Key`	in	key.
`KeyLength`	in	The key length is 16/32.
`AAD`	in	AAD.
`AADLength`	in	The maximum AAD length is 30.
`Nonce`	in	Nonce.
`NonceLength`	in	The nonce length valid range [7,13].
`Data`	in	Data.
`DataLength`	in	The maximum data length is 80.

Returns

WM_SUCCESS if successful.
-WM_E_PERM if not supported.
-WM_FAIL if failed.

`wlan_set_crypto_AES_WRAP_decrypt`#

int wlan_set_crypto_AES_WRAP_decrypt (const t_u8 * *Key*, const t_u16 *KeyLength*, const t_u8 * *KeyIV*, const t_u16 *KeyIVLength*, t_u8 * *Data*, t_u16 * *DataLength*)

Sets crypto AES_WRAP algorithm decrypt command parameters.

Parameters

Parameter	In/Out	Description
`Key`	in	key.
`KeyLength`	in	The key length is 16/24/32.
`KeyIV`	in	KeyIV.
`KeyIVLength`	in	The keyIV length is 8.
`Data`	in	Data.
`DataLength`	in	The data length valid range [8,1016].

Returns

WM_SUCCESS if successful.
-WM_E_PERM if not supported.
-WM_FAIL if failed.

`wlan_set_crypto_AES_WRAP_encrypt`#

int wlan_set_crypto_AES_WRAP_encrypt (const t_u8 * *Key*, const t_u16 *KeyLength*, const t_u8 * *KeyIV*, const t_u16 *KeyIVLength*, t_u8 * *Data*, t_u16 * *DataLength*)

Sets crypto AES_WRAP (advanced encryption standard wrap) algorithm encrypt command parameters.

Parameters

Parameter	In/Out	Description
`Key`	in	key.
`KeyLength`	in	The key length is 16/24/32.
`KeyIV`	in	KeyIV.
`KeyIVLength`	in	The keyIV length is 8.
`Data`	in	Data.
`DataLength`	in	The data length valid range [8,1016].

Returns

WM_SUCCESS if successful.
-WM_E_PERM if not supported.
-WM_FAIL if failed.

`wlan_set_crypto_RC4_decrypt`#

int wlan_set_crypto_RC4_decrypt (const t_u8 * *Key*, const t_u16 *KeyLength*, const t_u8 * *KeyIV*, const t_u16 *KeyIVLength*, t_u8 * *Data*, t_u16 * *DataLength*)

Sets crypto RC4 (rivest cipher 4) algorithm decrypt command parameters.

Parameters

Parameter	In/Out	Description
`Key`	in	key.
`KeyLength`	in	The KeyLength + KeyIVLength valid range [1,256].
`KeyIV`	in	KeyIV.
`KeyIVLength`	in	The KeyLength + KeyIVLength valid range [1,256].
`Data`	in	Data.
`DataLength`	in	The maximum data length is 1200.

Returns

WM_SUCCESS if successful.
-WM_E_PERM if not supported.
-WM_FAIL if failed.

`wlan_set_crypto_RC4_encrypt`#

int wlan_set_crypto_RC4_encrypt (const t_u8 * *Key*, const t_u16 *KeyLength*, const t_u8 * *KeyIV*, const t_u16 *KeyIVLength*, t_u8 * *Data*, t_u16 * *DataLength*)

Sets crypto RC4 (rivest cipher 4) algorithm encrypt command parameters.

Parameters

Parameter	In/Out	Description
`Key`	in	key.
`KeyLength`	in	The KeyLength + KeyIVLength valid range [1,256].
`KeyIV`	in	KeyIV.
`KeyIVLength`	in	The KeyLength + KeyIVLength valid range [1,256].
`Data`	in	Data.
`DataLength`	in	The maximum data length is 1200.

Returns

WM_SUCCESS if successful.
-WM_E_PERM if not supported.
-WM_FAIL if failed.

`wlan_set_entp_cert_files`#

int wlan_set_entp_cert_files (int *cert_type*, t_u8 * *data*, t_u32 *data_len*)

This function specifies the enterprise certificate file This function is used before adding network profile. It can store certificate data in “wlan” global structure.

Parameters

Parameter	In/Out	Description
`cert_type`	in	certificate file type: • 1: FILE_TYPE_ENTP_CA_CERT. • 2: FILE_TYPE_ENTP_CLIENT_CERT. • 3: FILE_TYPE_ENTP_CLIENT_KEY.
`data`	in	raw data of the enterprise certificate file.
`data_len`	in	length of the enterprise certificate file.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_okc`#

int wlan_set_okc (t_u8 *okc*)

Opportunistic key caching (also known as proactive key caching) default This parameter can be used to set the default behavior for the proactive_key_caching parameter. By default, OKC is disabled unless enabled with the global okc=1 parameter or with the per-network pkc(proactive_key_caching)=1 parameter. With okc=1, OKC is enabled by default, but can be disabled with per-network pkc(proactive_key_caching)=0 parameter.

Parameters

Parameter	In/Out	Description
`okc`	in	Enable opportunistic key caching.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_reassoc_control`#

void wlan_set_reassoc_control (bool *reassoc_control*)

Sets the reassociation control in the Wi-Fi connection manager. When reassociation control enabled, Wi-Fi connection manager attempts reconnection with the network for WLAN_RECONNECT_LIMIT times before giving up.

Parameters

Parameter	In/Out	Description
`reassoc_control`	in	Reassociation enable/disable.

WoWLAN (Wake on WLAN)#

Function	Supported SoCs
`wlan_set_ipv6_ns_mef`	RW612, IW610
`wlan_tcp_keep_alive`	All
`wlan_wowlan_cfg_ptn_match`	RW612, IW610
`wlan_wowlan_config`	RW612, IW610

`wlan_set_ipv6_ns_mef`#

int wlan_set_ipv6_ns_mef (t_u8 *mef_action*)

Use this API to enable the IPv6 neighbor solicitation offload in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`mef_action`	in	0discard and not wake host, 1discard and wake host 3allow and wake host.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_tcp_keep_alive`#

int wlan_tcp_keep_alive (wlan_tcp_keep_alive_t * *keep_alive*)

Use this API to configure the TCP keep alive parameters in Wi-Fi firmware. wlan_tcp_keep_alive_t provides the parameters which are available for configuration.

Parameters

Parameter	In/Out	Description
`keep_alive`	in	A pointer to wlan_tcp_keep_alive_t.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_wowlan_cfg_ptn_match`#

int wlan_wowlan_cfg_ptn_match (enum wlan_bss_type *bss_type*, wlan_wowlan_ptn_cfg_t * *ptn_cfg*)

Use this API to enable the WOWLAN (wake-on-wireless-LAN) on magic packet RX in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`bss_type`	in	0for bss type as sta, 1for bss type as uap.
`ptn_cfg`	in	A pointer to wlan_wowlan_ptn_cfg_t containing wake on Wi-Fi pattern configuration.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails

`wlan_wowlan_config`#

int wlan_wowlan_config (uint8_t *is_mef*, t_u32 *wake_up_conds*)

Wowlan (wake on wireless LAN) configuration. This function may be called to configure host sleep in firmware.

Parameters

Parameter	In/Out	Description
`is_mef`	in	Flag to indicate use MEF (memory efficient filtering) condition or not.
`wake_up_conds`	in	Bitmap of default condition.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

Cloud Keep-Alive#

Function	Supported SoCs
`wlan_cloud_keep_alive_enabled`	IW416, IW610, IW612

`wlan_cloud_keep_alive_enabled`#

int wlan_cloud_keep_alive_enabled (t_u32 *dst_ip*, t_u16 *dst_port*)

Gets cloud keep alive status for given destination ip and port.

Parameters

Parameter	In/Out	Description
`dst_ip`	in	Destination ip address.
`dst_port`	in	Destination port.

Returns

1 if enabled otherwise 0.

STA & Filter Management#

Function	Supported SoCs
`wlan_set_multicast`	RW612, IW610
`wlan_set_packet_filters`	All
`wlan_sta_inactivityto`	RW612, IW610

`wlan_set_multicast`#

int wlan_set_multicast (t_u8 *mef_action*)

This function sets multicast MEF (memory efficient filtering) entry.

Parameters

Parameter	In/Out	Description
`mef_action`	in	To be 0discard and not wake host, 1discard and wake host 3allow and wake host.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

`wlan_set_packet_filters`#

int wlan_set_packet_filters (wlan_flt_cfg_t * *flt_cfg*)

Use this API to set packet filters in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`flt_cfg`	in	A pointer to structure which holds the the packet filters wlan_flt_cfg_t.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

memset(&flt_cfg, 0, sizeof(wlan_flt_cfg_t));

flt_cfg.criteria = 2; flt_cfg.nentries = 1;

flt_cfg.mef_entry.mode = 1; flt_cfg.mef_entry.action = 3;

flt_cfg.mef_entry.filter_num = 3;

flt_cfg.mef_entry.filter_item[0].type = TYPE_DNUM_EQ; flt_cfg.mef_entry.filter_item[0].pattern = 80; flt_cfg.mef_entry.filter_item[0].offset = 44; flt_cfg.mef_entry.filter_item[0].num_bytes = 2;

flt_cfg.mef_entry.filter_item[1].type = TYPE_BYTE_EQ; flt_cfg.mef_entry.filter_item[1].repeat = 1; flt_cfg.mef_entry.filter_item[1].offset = 34; flt_cfg.mef_entry.filter_item[1].num_byte_seq = 4; memcpy(flt_cfg.mef_entry.filter_item[1].byte_seq, byte_seq1, 4); flt_cfg.mef_entry.rpn[1] = RPN_TYPE_AND;

flt_cfg.mef_entry.filter_item[2].type = TYPE_BYTE_EQ; flt_cfg.mef_entry.filter_item[2].repeat = 16; flt_cfg.mef_entry.filter_item[2].offset = 14; flt_cfg.mef_entry.filter_item[2].num_byte_seq = 6; memcpy(flt_cfg.mef_entry.filter_item[2].byte_seq, byte_seq2, 6); flt_cfg.mef_entry.rpn[2] = RPN_TYPE_OR;

`wlan_sta_inactivityto`#

int wlan_sta_inactivityto (wlan_inactivity_to_t * *inac_to*, t_u16 *action*)

Gets or sets the inactivity timeout extend.

Parameters

Parameter	In/Out	Description
`inac_to`	in	wlan_inactivity_to_t.
`action`	in	• 0: Get. • 1: Set.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

Statistics & Diagnostics#

Function	Supported SoCs
`wlan_channel_load`	All
`wlan_get_average_signal_strength`	All
`wlan_get_channel_load`	All
`wlan_get_current_nf`	All
`wlan_get_current_rssi`	All
`wlan_get_current_signal_strength`	All
`wlan_get_firmware_version_ext`	All
`wlan_get_log`	All
`wlan_get_signal_info`	All
`wlan_get_stats`	All
`wlan_reset_stats`	All
`wlan_version_extended`	All

`wlan_channel_load`#

int wlan_channel_load (wlan_802_11_chan_load_t * *chan_load*)

Sets the Wi-Fi channel load information.

`wlan_get_average_signal_strength`#

int wlan_get_average_signal_strength (short * *rssi*, int * *snr*)

Gets the average RSSI and signal to noise ratio (average value of the former 8 packets) from Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`rssi`	out	A pointer to a variable to store the average RSSI (Received Signal Strength Indicator) in dBm.
`snr`	out	A pointer to a variable to store the average SNR (Signal to Noise Ratio) in dB.

Returns

WM_SUCCESS if successful.

`wlan_get_channel_load`#

int wlan_get_channel_load (wlan_802_11_chan_load_t * *chan_load*)

Gets the Wi-Fi channel load info.

Parameters

Parameter	In/Out	Description
`chan_load`	out	Pointer to channel load info structure to be filled.

Returns

WM_SUCCESS if successful. Returns -WM_FAIL otherwise.

`wlan_get_current_nf`#

int wlan_get_current_nf (void **)

Gets the current noise floor.

Returns

The noise floor value.

`wlan_get_current_rssi`#

int wlan_get_current_rssi (short * *rssi*)

Gets the current RSSI value.

Parameters

Parameter	In/Out	Description
`rssi`	out	pointer to get the current RSSI (Received Signal Strength Indicator)

Returns

WM_SUCCESS.

`wlan_get_current_signal_strength`#

int wlan_get_current_signal_strength (short * *rssi*, int * *snr*)

Gets the current RSSI and signal to noise ratio from Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`rssi`	out	A pointer to a variable to store the current RSSI (Received Signal Strength Indicator) in dBm.
`snr`	out	A pointer to a variable to store the current SNR (Signal to Noise Ratio) in dB.

Returns

WM_SUCCESS if successful.

`wlan_get_firmware_version_ext`#

char * wlan_get_firmware_version_ext (void **)

Gets the Wi-Fi firmware version extension string.

Returns

Wi-Fi firmware version extension string pointer stored in WLCMGR.

`wlan_get_log`#

int wlan_get_log (wlan_pkt_stats_t * *stats*)

Use this API to get the various statistics of STA from Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`stats`	out	A pointer to structure where stats collected from Wi-Fi firmware can be copied. Explore the elements of the wlan_pkt_stats_t structure for more information on stats.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_get_signal_info`#

int wlan_get_signal_info (wlan_rssi_info_t * *signal*)

Gets RSSI information.

Parameters

Parameter	In/Out	Description
`signal`	out	RSSI information get report buffer.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_stats`#

int wlan_get_stats (wlan_stats_t * *stats*, enum wlan_bss_type *bss_type*)

Use this API to get the various statistics of STA/uAP from Wi-Fi driver.

Parameters

Parameter	In/Out	Description
`stats`	out	A pointer to structure where stats collected from Wi-Fi driver can be copied. Explore the elements of the wlan_stats_t structure for more information on stats.
`bss_type`	in	0: STA, 1: uAP.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_reset_stats`#

int wlan_reset_stats (enum wlan_bss_type *bss_type*)

Use this API to reset the various statistics of STA/uAP from Wi-Fi driver.

Parameters

Parameter	In/Out	Description
`bss_type`	in	0: STA, 1: uAP.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_version_extended`#

void wlan_version_extended (void **)

Use this API to print Wi-Fi driver and firmware extended version on the console.

MAC Address#

Function	Supported SoCs
`wlan_get_mac_address`	All
`wlan_get_mac_address_uap`	All
`wlan_get_wfd_mac_address`	RW612
`wlan_set_mac_addr`	All
`wlan_set_sta_mac_addr`	All

`wlan_get_mac_address`#

int wlan_get_mac_address (unsigned char * *dest*)

Retrieves the Wi-Fi MAC address of the station interface.

Parameters

Parameter	In/Out	Description
`dest`	out	A pointer to a 6-byte array where the MAC address should be copied.

Returns

WM_SUCCESS if the MAC address was copied.
-WM_E_INVAL if dest is NULL.

`wlan_get_mac_address_uap`#

int wlan_get_mac_address_uap (uint8_t * *dest*)

Retrieves the Wi-Fi MAC address of the uAP interface.

Parameters

Parameter	In/Out	Description
`dest`	out	A pointer to a 6-byte array where the MAC address can be copied.

Returns

WM_SUCCESS if the MAC address was copied.
-WM_E_INVAL if dest is NULL.

`wlan_get_wfd_mac_address`#

int wlan_get_wfd_mac_address (unsigned char * *dest*)

Retrieves the wireless MAC address of wfd interface.

Parameters

Parameter	In/Out	Description
`dest`	out	A pointer to a 6-byte array where the MAC address will be copied.

Returns

WM_SUCCESS if the MAC address was copied.
-WM_E_INVAL if dest is NULL.

`wlan_set_mac_addr`#

int wlan_set_mac_addr (uint8_t * *mac*)

Sets the Wi-Fi MAC Address in the Wi-Fi firmware.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

`wlan_set_sta_mac_addr`#

int wlan_set_sta_mac_addr (uint8_t * *mac*)

Sets the Wi-Fi MAC address for the STA in the Wi-Fi firmware.

Returns

WM_SUCCESS if the call was successful.
-WM_FAIL if failed.

Country / Region#

Function	Supported SoCs
`wlan_get_11d_enable_status`	All
`wlan_get_country_code`	All
`wlan_set_11d_state`	All
`wlan_set_country_code`	All
`wlan_set_country_ie_ignore`	All

`wlan_get_11d_enable_status`#

bool wlan_get_11d_enable_status (void **)

Gets the current status of 802.11d support.

Returns

true if 802.11d support is enabled by application.
false if not enabled.

`wlan_get_country_code`#

int wlan_get_country_code (char * *alpha2*)

Gets current country code.

Parameters

Parameter	In/Out	Description
`alpha2`	out	Buffer to store the 2-character country code.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_11d_state`#

int wlan_set_11d_state (int *bss_type*, int *state*)

Sets STA/uAP 802.11d feature Enable/Disable.

Parameters

Parameter	In/Out	Description
`bss_type`	in	0: STA, 1: uAP.
`state`	in	0: disable, 1: enable.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_country_code`#

int wlan_set_country_code (const char * *alpha2*)

Sets the country code.

Parameters

Parameter	In/Out	Description
`alpha2`	in	country code in 3 octets string, 2 octets country code and 1 octet environment Supported 2-octet country codes: WW: World Wide Safe. US: US FCC. CA: IC Canada. SG: Singapore. EU: ETSI. AU: Australia. KR: Republic of Korea. FR: France. JP: Japan. CN: China.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_country_ie_ignore`#

int wlan_set_country_ie_ignore (uint8_t * *ignore*)

Sets ignore region code.

Parameters

Parameter	In/Out	Description
`ignore`	in	0: don’t ignore, 1: ignore.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

Calibration#

Function	Supported SoCs
`wlan_get_cal_data`	All
`wlan_get_otp_user_data`	All
`wlan_set_cal_data`	All

`wlan_get_cal_data`#

int wlan_get_cal_data (wlan_cal_data_t * *cal_data*)

Gets the calibration data from Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`cal_data`	out	Pointer to calibration data structure where calibration data and it’s length should be stored.

Returns

WM_SUCCESS if calibration data read operation is successful.
-WM_E_INVAL if cal_data is not valid.
-WM_FAIL if command fails.

`wlan_get_otp_user_data`#

int wlan_get_otp_user_data (uint8_t * *buf*, uint16_t *len*)

Gets the user data from OTP (one-time programming) memory.

Parameters

Parameter	In/Out	Description
`buf`	out	Pointer to buffer where data should be stored.
`len`	out	Number of bytes to read.

Returns

WM_SUCCESS if user data read operation is successful.
-WM_E_INVAL if buf is not valid or of insufficient size.
-WM_FAIL if user data field is not present or command fails.

`wlan_set_cal_data`#

void wlan_set_cal_data (const uint8_t * *cal_data*, const unsigned int *cal_data_size*)

Sets the Wi-Fi calibration data in the Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`cal_data`	in	The calibration data buffer.
`cal_data_size`	in	Size of calibration data buffer.

Register Access#

Function	Supported SoCs
`wlan_reg_access`	RW612

`wlan_reg_access`#

int wlan_reg_access (wifi_reg_t *type*, uint16_t *action*, uint32_t *offset*, uint32_t * *value*)

This function reads/writes adapter registers value.

Parameters

Parameter	In/Out	Description
`type`	in	Register type: 1 MAC, 2 BBP, 3 RF.
`action`	in	0 read, 1 write
`offset`	in	Specifies the offset location that is to be read/write.
`value`	inout	Value if specified, stand for write action, then that value can be written to that offset in the specified register. Value should be specified in hexadecimal. Otherwise, it stands for read action, the value is updated with read value.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

Utility & Miscellaneous#

Function	Supported SoCs
`is_ep_valid_security`	RW612, IW610
`is_valid_security`	All
`print_mac`	All
`wlan_cfg_rf_he_tb_tx`	All
`wlan_event_callback`	All
`wlan_get_beacon_period`	All
`wlan_get_board_type`	All
`wlan_get_current_wfd_network`	RW612
`wlan_get_current_wfd_network_ssid`	RW612
`wlan_get_diag`	All
`wlan_get_dtim_period`	All
`wlan_get_indrst_cfg`	IW416, IW610, IW612
`wlan_get_region_code`	All
`wlan_get_rf_band`	All
`wlan_get_rf_bandwidth`	All
`wlan_get_rf_channel`	All
`wlan_get_rf_otp_cal_data`	All
`wlan_get_rf_otp_mac_addr`	All
`wlan_get_rf_per`	All
`wlan_get_rf_radio_mode`	All
`wlan_get_rf_rx_antenna`	All
`wlan_get_rf_tx_antenna`	All
`wlan_get_rf_xtal`	All
`wlan_get_scan_raw_frame`	All
`wlan_get_status_code`	All
`wlan_get_temperature`	RW612
`wlan_get_tsf`	All
`wlan_get_tsf_info`	RW612, IW610
`wlan_get_turbo_mode`	All
`wlan_get_uap_turbo_mode`	All
`wlan_get_wlan_region_code`	IW416, IW610, IW612
`wlan_host_set_sta_mac_filter`	All
`wlan_init_nb`	IW416
`wlan_is_wmm_uapsd_enabled`	All
`wlan_nb_task_cleanup`	IW416
`wlan_recovery_test`	RW612
`wlan_register_fw_dump_cb`	IW610, IW612
`wlan_register_uap_prov_deinit_cb`	RW612
`wlan_rf_disable_11ax`	All
`wlan_rf_trigger_frame_cfg`	All
`wlan_send_hostcmd`	IW416, IW610, IW612
`wlan_set_indrst_cfg`	IW416, IW610, IW612
`wlan_set_network_ip_byname`	All
`wlan_set_region_code`	All
`wlan_set_rf_band`	All
`wlan_set_rf_bandwidth`	All
`wlan_set_rf_channel`	All
`wlan_set_rf_otp_cal_data`	All
`wlan_set_rf_otp_mac_addr`	All
`wlan_set_rf_radio_mode`	All
`wlan_set_rf_rx_antenna`	All
`wlan_set_rf_rx_mac_filter`	All
`wlan_set_rf_test_mode`	All
`wlan_set_rf_tx_antenna`	All
`wlan_set_rf_tx_cont_mode`	All
`wlan_set_rf_tx_frame`	All
`wlan_set_rf_tx_power`	All
`wlan_set_rf_xtal`	All
`wlan_set_rssi_threshold`	All
`wlan_set_turbo_mode`	All
`wlan_set_uap_turbo_mode`	All
`wlan_stop_all_networks`	RW612
`wlan_string_dup`	All
`wlan_test_mode_cli_deinit`	All
`wlan_test_mode_cli_init`	All
`wlan_unassoc_ftm_cfg`	IW612
`wlan_unset_rf_test_mode`	All

`is_ep_valid_security`#

int is_ep_valid_security (int *security*)

`is_valid_security`#

int is_valid_security (int *security*)

`print_mac`#

void print_mac (const char * *mac*)

`wlan_cfg_rf_he_tb_tx`#

int wlan_cfg_rf_he_tb_tx (uint16_t *enable*, uint16_t *qnum*, uint16_t *aid*, uint16_t *axq_mu_timer*, int16_t *tx_power*)

Sets the RF HE TB TX in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`enable`	in	Enable/Disable trigger response mode.
`qnum`	in	AXQ to be used for the trigger response frame.
`aid`	in	AID of the peer to which response is to be generated.
`axq_mu_timer`	in	MU timer for the AXQ on which response is sent.
`tx_power`	in	TxPwr to be configured for the response.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_event_callback`#

int wlan_event_callback (enum wlan_event_reason *reason*, void * *data*)

`wlan_get_beacon_period`#

uint16_t wlan_get_beacon_period (void **)

Use this API to get the beacon period of associated BSS from the cached state information.

Returns

beacon_period if operation is successful.
0 if command fails.

`wlan_get_board_type`#

uint32_t wlan_get_board_type (void **)

Gets the board type.

Returns

board type. 0x02: RW610_PACKAGE_TYPE_BGA. 0xFF: Others.

`wlan_get_current_wfd_network`#

int wlan_get_current_wfd_network (struct wlan_network * *network*)

Retrieves the current network configuration of the WFD interface.

Parameters

Parameter	In/Out	Description
`network`	out	A pointer to the wlan_network.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if network is NULL.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running or not in the WLAN_UAP_STARTED state.

`wlan_get_current_wfd_network_ssid`#

int wlan_get_current_wfd_network_ssid (char * *ssid*)

Retrieves the current network ssid of the WFD interface.

Parameters

Parameter	In/Out	Description
`ssid`	out	A pointer to the ssid char string with NULL termination. The maximum length is 32 (not include NULL termination).

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if ssid is NULL.
WLAN_ERROR_STATE if the Wi-Fi connection manager was not running or not in the WLAN_UAP_STARTED state.

`wlan_get_diag`#

int wlan_get_diag (struct wlan_diag * *diag*)

Gets the Wi-Fi diagnostic statistics.

Parameters

Parameter	In/Out	Description
`diag`	out	Pointer to wlan_diag to store the result.

Returns

WM_SUCCESS if successful.
-WM_E_INVAL if a NULL pointer is passed.

`wlan_get_dtim_period`#

uint8_t wlan_get_dtim_period (void **)

Use this API to get the DTIM period of associated BSS. When this API called, the radio sends a probe request to the AP for this information.

Returns

dtim_period if operation is successful.
0 if DTIM IE is not found in AP’s Probe response.

`wlan_get_indrst_cfg`#

int wlan_get_indrst_cfg (wifi_indrst_cfg_t * *indrst_cfg*)

`wlan_get_region_code`#

int wlan_get_region_code (unsigned int * *region_code*)

Gets region code.

Parameters

Parameter	In/Out	Description
`region_code`	out	pointer The value: • 0x00: World Wide Safe. • 0x10: US FCC / Singapore. • 0x20: IC Canada. • 0x30: ETSI / Australia / Republic of Korea. • 0x32: France. • 0x50: China. • 0xFF: Japan.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_rf_band`#

int wlan_get_rf_band (uint8_t * *band*)

Gets the RF band from Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`band`	out	A Pointer to a variable where RF band is to be stored.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_rf_bandwidth`#

int wlan_get_rf_bandwidth (uint8_t * *bandwidth*)

Gets the RF bandwidth from Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`bandwidth`	out	A Pointer to a variable where bandwidth to get.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_rf_channel`#

int wlan_get_rf_channel (uint8_t * *channel*)

Gets the RF channel from Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`channel`	out	A pointer to a variable where channel number to get.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_rf_otp_cal_data`#

int wlan_get_rf_otp_cal_data (uint8_t * *cal_data*)

Gets the RF OTP calculate data from Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`cal_data`	out	A pointer to a variable where OTP calculate data is to be stored.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_rf_otp_mac_addr`#

int wlan_get_rf_otp_mac_addr (uint8_t * *mac*)

Gets the RF OTP MAC address from Wi-Fi firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_rf_per`#

int wlan_get_rf_per (uint32_t * *rx_tot_pkt_count*, uint32_t * *rx_mcast_bcast_count*, uint32_t * *rx_pkt_fcs_error*)

Gets the RF RX total packet and multicast/broadcast packet count.

Parameters

Parameter	In/Out	Description
`rx_tot_pkt_count`	out	A Pointer to a variable where RX total packet count to get.
`rx_mcast_bcast_count`	out	A Pointer to a variable where RX total multicast/broadcast packet count to get.
`rx_pkt_fcs_error`	out	A Pointer to a variable where RX total packet count with FCS (frame check sequence) error to get.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_rf_radio_mode`#

int wlan_get_rf_radio_mode (uint8_t * *mode*)

Gets the RF radio mode from Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`mode`	out	A pointer to a variable where radio mode number to get.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_rf_rx_antenna`#

int wlan_get_rf_rx_antenna (uint8_t * *antenna*)

Gets the RF RX antenna from Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`antenna`	out	A Pointer to a variable where RX antenna is to be stored.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_rf_tx_antenna`#

int wlan_get_rf_tx_antenna (uint8_t * *antenna*)

Gets the RF TX antenna from Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`antenna`	out	A Pointer to a variable where TX antenna is to be stored.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_rf_xtal`#

int wlan_get_rf_xtal (uint8_t * *extension*, uint8_t * *xtal_cal*)

Gets the RF crystal calibration from Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`extension`	out	A Pointer to a variable indicate RF xtal from internal or external crystal.
`xtal_cal`	out	A Pointer to a variable where RF crystal calibration is to be stored.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_scan_raw_frame`#

int wlan_get_scan_raw_frame (unsigned int *index*, uint8_t * *buf*, size_t *buf_len*, size_t * *frame_len*, uint32_t * *freq*, int8_t * *rssi*)

Gets a reconstructed raw 802.11 beacon frame for a scan result entry. The frame includes MAC header (24B) + fixed fields (12B) + IEs.

Parameters

Parameter	In/Out	Description
`index`	in	Index into scan table
`buf`	out	Buffer to write frame into
`buf_len`	in	Size of buffer
`frame_len`	out	Actual total frame length (may exceed buf_len)
`freq`	out	Frequency in MHz
`rssi`	out	RSSI in dBm (negative value)

Returns

WM_SUCCESS on success or error code.

`wlan_get_status_code`#

t_u16 wlan_get_status_code (enum wlan_event_reason *reason*)

Gets 802.11 Status Code.

Parameters

Parameter	In/Out	Description
`reason`	in	wlcmgr event reason.

Returns

status code defined in IEEE 802.11-2020 standard.

`wlan_get_temperature`#

int32_t wlan_get_temperature (void **)

Gets the board temperature.

Returns

Board temperature in degrees Celsius.

`wlan_get_tsf`#

int wlan_get_tsf (uint32_t * *tsf_high*, uint32_t * *tsf_low*)

Use this API to get the TSF (timing synchronization function) from Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`tsf_high`	in	Pointer to store TSF higher 32bits.
`tsf_low`	in	Pointer to store TSF lower 32bits.

Returns

WM_SUCCESS if operation is successful.
-WM_FAIL if command fails.

`wlan_get_tsf_info`#

int wlan_get_tsf_info (wlan_tsf_info_t * *tsf_info*)

Gets TSF info from firmware using GPIO latch.

Parameters

Parameter	In/Out	Description
`tsf_info`	out	TSF info parameter received from firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_turbo_mode`#

int wlan_get_turbo_mode (t_u8 * *mode*)

Gets the turbo mode.

Parameters

Parameter	In/Out	Description
`mode`	out	turbo mode • 0: Disable turbo mode. • 1: Turbo mode 1. • 2: Turbo mode 2. • 3: Turbo mode 3.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_uap_turbo_mode`#

int wlan_get_uap_turbo_mode (t_u8 * *mode*)

Gets the uAP turbo mode.

Parameters

Parameter	In/Out	Description
`mode`	out	turbo mode • 0: Disable turbo mode. • 1: Turbo mode 1. • 2: Turbo mode 2. • 3: Turbo mode 3.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_get_wlan_region_code`#

const char * wlan_get_wlan_region_code (void **)

Gets the Wi-Fi region code from TX power config.

Returns

Wi-Fi region code in string format.

`wlan_host_set_sta_mac_filter`#

int wlan_host_set_sta_mac_filter (int *filter_mode*, int *mac_count*, unsigned char * *mac_addr*)

`wlan_init_nb`#

int wlan_init_nb (const uint8_t * *fw_start_addr*, const size_t *size*, int(*)(enum wlan_event_reason reason, void *data) *cb*)

Initialize Wi-Fi driver and create the Wi-Fi driver thread in non blocking mode. This API creates a new thread and performs wlan_init and wlan_start API calls internally.

Parameters

Parameter	In/Out	Description
`fw_start_addr`	in	Start address of the Wi-Fi firmware.
`size`	in	Size of the Wi-Fi firmware.
`cb`	in	A pointer to a callback function that handles Wi-Fi events. All. further WLCMGR events can be notified in this callback. Refer to enum wlan_event_reason for the various events for which this callback is called.

Returns

WM_SUCCESS if the Wi-Fi connection manager service has initialized successfully.
Negative value if initialization failed.

`wlan_is_wmm_uapsd_enabled`#

t_u8 wlan_is_wmm_uapsd_enabled (void **)

Checks whether UAPSD is enabled or not.

Returns

true if UAPSD is enabled.
false if UAPSD is disabled.

`wlan_nb_task_cleanup`#

void wlan_nb_task_cleanup (void **)

Wait for the task created by wlan_init_nb() to complete and destroy it. Call this from the application task after wlan_init_nb().

`wlan_recovery_test`#

int wlan_recovery_test (void **)

`wlan_register_fw_dump_cb`#

void wlan_register_fw_dump_cb (void(*)(void) *wlan_usb_init_cb*, int(*)() *wlan_usb_mount_cb*, int(*)(char *test_file_name) *wlan_usb_file_open_cb*, int(*)(uint8_t *data, size_t data_len) *wlan_usb_file_write_cb*, int(*)() *wlan_usb_file_close_cb*)

This function registers callbacks which are used to generate firmware dump on USB device.

Parameters

Parameter	In/Out	Description
`wlan_usb_init_cb`	in	Callback to initialize usb device.
`wlan_usb_mount_cb`	in	Callback to mount usb device.
`wlan_usb_file_open_cb`	in	Callback to open file on usb device for firmware dump.
`wlan_usb_file_write_cb`	in	Callback to write firmware dump data to opened file.
`wlan_usb_file_close_cb`	in	Callback to close firmware dump file.

`wlan_register_uap_prov_deinit_cb`#

void wlan_register_uap_prov_deinit_cb (int(*)(void) *cb*)

UAP provisioning deinit callback function.

`wlan_rf_disable_11ax`#

int wlan_rf_disable_11ax (void **)

Disables the RF 11AX in Wi-Fi firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_rf_trigger_frame_cfg`#

int wlan_rf_trigger_frame_cfg (uint32_t *Enable_tx*, uint32_t *Standalone_hetb*, uint8_t *FRAME_CTRL_TYPE*, uint8_t *FRAME_CTRL_SUBTYPE*, uint16_t *FRAME_DURATION*, uint64_t *TriggerType*, uint64_t *UlLen*, uint64_t *MoreTF*, uint64_t *CSRequired*, uint64_t *UlBw*, uint64_t *LTFType*, uint64_t *LTFMode*, uint64_t *LTFSymbol*, uint64_t *UlSTBC*, uint64_t *LdpcESS*, uint64_t *ApTxPwr*, uint64_t *PreFecPadFct*, uint64_t *PeDisambig*, uint64_t *SpatialReuse*, uint64_t *Doppler*, uint64_t *HeSig2*, uint32_t *AID12*, uint32_t *RUAllocReg*, uint32_t *RUAlloc*, uint32_t *UlCodingType*, uint32_t *UlMCS*, uint32_t *UlDCM*, uint32_t *SSAlloc*, uint8_t *UlTargetRSSI*, uint8_t *MPDU_MU_SF*, uint8_t *TID_AL*, uint8_t *AC_PL*, uint8_t *Pref_AC*)

Sets the RF Trigger Frame Config in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`Enable_tx`	in	Enable or Disable trigger frame transmission.
`Standalone_hetb`	in	Enable or Disable Standalone HE TB support.
`FRAME_CTRL_TYPE`	in	Frame control type.
`FRAME_CTRL_SUBTYPE`	in	Frame control subtype.
`FRAME_DURATION`	in	Max Duration time.
`TriggerType`	in	Identifies the Trigger frame variant and its encoding.
`UlLen`	in	Indicates the value of the L-SIG LENGTH field of the solicited HE TB PPDU.
`MoreTF`	in	Indicates whether a subsequent Trigger frame is scheduled for transmission or not.
`CSRequired`	in	Required to use ED to sense the medium and to consider the medium state and the NAV in. determining whether to respond or not.
`UlBw`	in	Indicates the bandwidth in the HE-SIG-A field of the HE TB PPDU.
`LTFType`	in	Indicates the LTF type of the HE TB PPDU response.
`LTFMode`	in	Indicates the LTF mode for an HE TB PPDU.
`LTFSymbol`	in	Indicates the number of LTF symbols present in the HE TB PPDU.
`UlSTBC`	in	Indicates the status of STBC encoding for the solicited HE TB PPDUs.
`LdpcESS`	in	Indicates the status of the LDPC extra symbol segment.
`ApTxPwr`	in	Indicates the AP’s combined transmit power at the transmit antenna connector of all the antennas. used to transmit the triggering PPDU.
`PreFecPadFct`	in	Indicates the pre-FEC padding factor.
`PeDisambig`	in	Indicates PE disambiguity.
`SpatialReuse`	in	Carries the values to be included in the Spatial Reuse. fields in the HE-SIG-A field of the solicited HE TB PPDUs.
`Doppler`	in	Indicate that a midamble is present in the HE TB PPDU.
`HeSig2`	in	Carries the value to be included in the Reserved field in the HE-SIG-A2 subfield of. the solicited HE TB PPDUs.
`AID12`	in	If set to 0 allocates one or more contiguous RA-RUs for associated STAs.
`RUAllocReg`	in	RUAllocReg.
`RUAlloc`	in	Identifies the size and the location of the RU.
`UlCodingType`	in	Indicates the code type of the solicited HE TB PPDU.
`UlMCS`	in	Indicates the HE-MCS of the solicited HE TB PPDU.
`UlDCM`	in	Indicates DCM of the solicited HE TB PPDU.
`SSAlloc`	in	Indicates the spatial streams of the solicited HE TB PPDU.
`UlTargetRSSI`	in	Indicates the expected receive signal power.
`MPDU_MU_SF`	in	Used for calculating the value by which the minimum MPDU start spacing is multiplied.
`TID_AL`	in	Indicates the MPDUs allowed in an A-MPDU carried in the HE TB PPDU and the maximum number of TIDs. that can be aggregated by the STA in the A-MPDU.
`AC_PL`	in	Reserved.
`Pref_AC`	in	Indicates the lowest AC that is recommended for aggregation of MPDUs in the A-MPDU contained in. the HE TB PPDU sent as a response to the trigger frame.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_send_hostcmd`#

int wlan_send_hostcmd (const void * *cmd_buf*, uint32_t *cmd_buf_len*, void * *host_resp_buf*, uint32_t *resp_buf_len*, uint32_t * *reqd_resp_len*)

This function sends the host command to firmware and copies back response to caller provided buffer in case of success response from firmware is not parsed by this function but just copied back to the caller buffer.

Parameters

Parameter	In/Out	Description
`cmd_buf`	in	Buffer containing the host command with header.
`cmd_buf_len`	in	length of valid bytes in cmd_buf.
`host_resp_buf`	out	Caller provided buffer, in case of success command response is copied to this. buffer can be same as cmd_buf
`resp_buf_len`	in	resp_buf’s allocated length.
`reqd_resp_len`	out	length of valid bytes in response buffer if successful otherwise invalid.

Returns

WM_SUCCESS in case of success.
WM_E_INBIG in case cmd_buf_len is bigger than the commands that can be handled by driver.
WM_E_INSMALL in case cmd_buf_len is smaller than the minimum length. Minimum length is at least. the length of command header. see Note for same.
WM_E_OUTBIG in case the. resp_buf_len is not sufficient to copy response from firmware. reqd_resp_len is updated with the response size.
WM_E_INVAL in case cmd_buf_len and resp_buf_len have invalid values.
WM_E_NOMEM in case cmd_buf, resp_buf and reqd_resp_len are NULL.

2 bytes: Command. 2 bytes: Size. 2 bytes: Sequence number. 2 bytes: Result. Rest of buffer length is Command/Response Body.

`wlan_set_indrst_cfg`#

int wlan_set_indrst_cfg (const wifi_indrst_cfg_t * *indrst_cfg*)

Sets the GPIO-independent reset configuration.

Parameters

Parameter	In/Out	Description
`indrst_cfg`	in	GPIO independent reset configuration to be sent to firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_network_ip_byname`#

int wlan_set_network_ip_byname (char * *name*, struct wlan_ip_config * *ip*)

`wlan_set_region_code`#

int wlan_set_region_code (unsigned int *region_code*)

Sets region code.

Parameters

Parameter	In/Out	Description
`region_code`	in	region code to be set.

Returns

WM_SUCCESS if successful otherwise fail.

`wlan_set_rf_band`#

int wlan_set_rf_band (const uint8_t *band*)

Sets the RF band in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`band`	in	The bandwidth to be set in Wi-Fi firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rf_bandwidth`#

int wlan_set_rf_bandwidth (const uint8_t *bandwidth*)

Sets the RF bandwidth in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`bandwidth`	in	The bandwidth to be set in Wi-Fi firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rf_channel`#

int wlan_set_rf_channel (const uint8_t *channel*)

Sets the RF channel in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`channel`	in	The channel number to be set in Wi-Fi firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rf_otp_cal_data`#

int wlan_set_rf_otp_cal_data (const uint8_t * *cal_data*, uint32_t *cal_data_len*)

Sets the RF OTP calculate data in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`cal_data`	in	A Pointer to a variable where OTP calculate data is to be stored.
`cal_data_len`	in	The length of OTP calculate data.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rf_otp_mac_addr`#

int wlan_set_rf_otp_mac_addr (uint8_t * *mac*)

Sets the RF OTP (one-time password) MAC address in Wi-Fi firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rf_radio_mode`#

int wlan_set_rf_radio_mode (const uint8_t *mode*)

Sets the RF radio mode in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`mode`	in	The radio mode number to be set in Wi-Fi firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rf_rx_antenna`#

int wlan_set_rf_rx_antenna (const uint8_t *antenna*)

Sets the RF RX antenna in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`antenna`	in	The RX antenna to be set in Wi-Fi firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rf_rx_mac_filter`#

int wlan_set_rf_rx_mac_filter (uint8_t * *addr*)

Adds RX peer mac filter.

Parameters

Parameter	In/Out	Description
`addr`	in	only receive packets from this mac address.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rf_test_mode`#

int wlan_set_rf_test_mode (void **)

Sets the RF test mode in Wi-Fi firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rf_tx_antenna`#

int wlan_set_rf_tx_antenna (const uint8_t *antenna*)

Sets the RF TX antenna in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`antenna`	in	The TX antenna to be set in Wi-Fi firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rf_tx_cont_mode`#

int wlan_set_rf_tx_cont_mode (const uint32_t *enable_tx*, const uint32_t *cw_mode*, const uint32_t *payload_pattern*, const uint32_t *cs_mode*, const uint32_t *act_sub_ch*, const uint32_t *tx_rate*)

Sets the RF TX continuous mode in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`enable_tx`	in	Enable TX.
`cw_mode`	in	Set CW (continuous wave) mode.
`payload_pattern`	in	Set payload pattern.
`cs_mode`	in	Set CS mode.
`act_sub_ch`	in	Active subchannel.
`tx_rate`	in	Set TX rate.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rf_tx_frame`#

int wlan_set_rf_tx_frame (const uint32_t *enable*, const uint32_t *data_rate*, const uint32_t *frame_pattern*, const uint32_t *frame_length*, const uint16_t *adjust_burst_sifs*, const uint32_t *burst_sifs_in_us*, const uint32_t *short_preamble*, const uint32_t *act_sub_ch*, const uint32_t *short_gi*, const uint32_t *adv_coding*, const uint32_t *tx_bf*, const uint32_t *gf_mode*, const uint32_t *stbc*, const uint8_t * *bssid*, const uint32_t *signal_bw*, const uint32_t *NumPkt*, const uint32_t *MaxPE*, const uint32_t *BeamChange*, const uint32_t *Dcm*, const uint32_t *Doppler*, const uint32_t *MidP*, const uint32_t *QNum*)

Sets the RF TX Frame in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`enable`	in	Enable/Disable RF TX Frame.
`data_rate`	in	Rate index corresponding to legacy/HT/VHT rates.
`frame_pattern`	in	Payload pattern.
`frame_length`	in	Payload length.
`adjust_burst_sifs`	in	Enable/Disable adjust burst SIFS3 Gap.
`burst_sifs_in_us`	in	Burst SIFS in us.
`short_preamble`	in	Enable/Disable short preamble.
`act_sub_ch`	in	Enable/Disable active sub channel.
`short_gi`	in	Short guard interval.
`adv_coding`	in	Enable/Disable adv coding.
`tx_bf`	in	Enable/Disable beamforming.
`gf_mode`	in	Enable/Disable green field mode.
`stbc`	in	Enable/Disable STBC.
`bssid`	in	BSSID.
`signal_bw`	in	Signal BW.
`NumPkt`	in	Number of packets.
`MaxPE`	in	Max pkt extension.
`BeamChange`	in	Beam change.
`Dcm`	in	DCM enable.
`Doppler`	in	Doppler enable.
`MidP`	in	Midamble periodicity.
`QNum`	in	Tx queue num that holds the trigger-based response pkts.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rf_tx_power`#

int wlan_set_rf_tx_power (const uint32_t *power*, const uint8_t *mod*, const uint8_t *path_id*)

Sets the RF RX power in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`power`	in	The RF RX power to be set in Wi-Fi firmware. For RW610, transmit output power level control range is -10 dBm to 22 dBm as per the data sheet.
`mod`	in	The modulation to be set in Wi-Fi firmware.
`path_id`	in	The Path ID to be set in Wi-Fi firmware.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rf_xtal`#

int wlan_set_rf_xtal (const uint8_t *xtal_cal*)

Sets the RF crystal calibration in Wi-Fi firmware.

Parameters

Parameter	In/Out	Description
`xtal_cal`	in	The crystal calibration offset to be set in Wi-Fi firmware, range [0,255].

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_rssi_threshold`#

int wlan_set_rssi_threshold (int *rssithr*)

`wlan_set_turbo_mode`#

int wlan_set_turbo_mode (t_u8 *mode*)

Sets the turbo mode.

Parameters

Parameter	In/Out	Description
`mode`	in	turbo mode • 0: Disable turbo mode. • 1: Turbo mode 1. • 2: Turbo mode 2. • 3: Turbo mode 3.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_set_uap_turbo_mode`#

int wlan_set_uap_turbo_mode (t_u8 *mode*)

Sets the uAP turbo mode.

Parameters

Parameter	In/Out	Description
`mode`	in	turbo mode • 0: Disable turbo mode. • 1: Turbo mode 1. • 2: Turbo mode 2. • 3: Turbo mode 3.

Returns

WM_SUCCESS if successful.
-WM_FAIL if failed.

`wlan_stop_all_networks`#

int wlan_stop_all_networks (void **)

Stops all Wi-Fi network.

Returns

WM_SUCCESS if successful.

`wlan_string_dup`#

char * wlan_string_dup (const char * *s*)

Allocate memory for a string and copy the string to the allocated memory.

Parameters

Parameter	In/Out	Description
`s`	in	the source/target string.

Returns

new string if successful, otherwise return -WM_FAIL.

`wlan_test_mode_cli_deinit`#

int wlan_test_mode_cli_deinit (void **)

Unregister Wi-Fi test mode CLI commands.

Returns

WM_SUCCESS if the CLI commands were unregistered or.
-WM_FAIL if they were not unregistered.

`wlan_test_mode_cli_init`#

int wlan_test_mode_cli_init (void **)

Registers Wi-Fi test mode CLI commands.

Returns

WM_SUCCESS if the CLI commands were registered or.
-WM_FAIL if they were not (for example if this function was called while the CLI commands were already registered).

`wlan_unassoc_ftm_cfg`#

int wlan_unassoc_ftm_cfg (const t_u16 *action*, const t_u16 *config*)

`wlan_unset_rf_test_mode`#

int wlan_unset_rf_test_mode (void **)

Unsets the RF test mode in Wi-Fi firmware.

Returns

WM_SUCCESS if successful.

Wi-Fi Driver API Reference Manual — FreeRTOS

Contents

Wi-Fi Driver API Reference Manual — FreeRTOS#

Main Page#

Introduction#

Supported SoC Summary#

Abbreviations and Acronyms#

File Index#

Table of Contents

Data Structures#

Data Structure Documentation#

_Event_Radar_Detected_Info#

ext_coex_pta_cfg#

ftm_11mc_nego_cfg_t#

ipv4_config#

ipv6_config#

location_cfg_info_t#

location_civic_rep_t#

ranging_11az_cfg_t#

rx_pkt_he_rate_info#

rx_pkt_ht_rate_info#

rx_pkt_rate_info#

rx_pkt_vht_rate_info#

tx_ampdu_prot_mode_para#

tx_pkt_he_rate_info#

tx_pkt_ht_rate_info#

tx_pkt_rate_info#

tx_pkt_vht_rate_info#

wifi_scan_params_t#

wlan_cck_desense_cfg#

wlan_cipher#

wlan_csi_proc_cfg#

wlan_diag#

wlan_ieeeps_config#

wlan_ip_config#

wlan_message#

wlan_nan_publish_params_t#

wlan_nan_subscribe_params_t#

wlan_network#

wlan_network_security#

wlan_rx_abort_cfg#

wlan_rx_abort_cfg_ext#

wlan_scan_result#

wlan_tx_pert_info#

wlan_txrx_histogram_info#

Enumerations#

Enumeration Documentation#

Chan2Offset_e#

ChanBand_e#

ChanWidth_e#

IEEEtypes_Bss_t#

ScanMode_e#

_ENH_PS_MODES#

_Host_Sleep_Action#

address_types#

cli_reset_option#

eap_tls_cipher_type#

nan_service_protocol_type_t#

sub_event_id#

wlan_connection_state#

wlan_csi_opt#

wlan_event_reason#

wlan_frequency_bands#

wlan_hostsleep_state#

wlan_mef_type#

wlan_mon_task_event#

wlan_monitor_opt#

wlan_ps_mode#

wlan_ps_state#

wlan_security_type#

wlan_select_policy#

wlan_wakeup_event_t#

wm_wlan_errno#

Macros#

Macro Documentation#

ACTION_GET#

ACTION_SET#

ARG_UNUSED#

AZ_MEASUREMENT_FREQ#

AZ_NUMBER_OF_MEASUREMENTS#

`_Event_Radar_Detected_Info`#

`ext_coex_pta_cfg`#

`ftm_11mc_nego_cfg_t`#

`ipv4_config`#

`ipv6_config`#

`location_cfg_info_t`#

`location_civic_rep_t`#

`ranging_11az_cfg_t`#

`rx_pkt_he_rate_info`#

`rx_pkt_ht_rate_info`#

`rx_pkt_rate_info`#

`rx_pkt_vht_rate_info`#

`tx_ampdu_prot_mode_para`#

`tx_pkt_he_rate_info`#

`tx_pkt_ht_rate_info`#

`tx_pkt_rate_info`#

`tx_pkt_vht_rate_info`#

`wifi_scan_params_t`#

`wlan_cck_desense_cfg`#

`wlan_cipher`#

`wlan_csi_proc_cfg`#

`wlan_diag`#

`wlan_ieeeps_config`#

`wlan_ip_config`#

`wlan_message`#

`wlan_nan_publish_params_t`#

`wlan_nan_subscribe_params_t`#

`wlan_network`#

`wlan_network_security`#

`wlan_rx_abort_cfg`#

`wlan_rx_abort_cfg_ext`#

`wlan_scan_result`#

`wlan_tx_pert_info`#

`wlan_txrx_histogram_info`#

`Chan2Offset_e`#

`ChanBand_e`#

`ChanWidth_e`#

`IEEEtypes_Bss_t`#

`ScanMode_e`#

`_ENH_PS_MODES`#

`_Host_Sleep_Action`#

`address_types`#

`cli_reset_option`#

`eap_tls_cipher_type`#

`nan_service_protocol_type_t`#

`sub_event_id`#

`wlan_connection_state`#

`wlan_csi_opt`#

`wlan_event_reason`#

`wlan_frequency_bands`#

`wlan_hostsleep_state`#

`wlan_mef_type`#

`wlan_mon_task_event`#

`wlan_monitor_opt`#

`wlan_ps_mode`#

`wlan_ps_state`#

`wlan_security_type`#

`wlan_select_policy`#

`wlan_wakeup_event_t`#

`wm_wlan_errno`#

`ACTION_GET`#

`ACTION_SET`#

`ARG_UNUSED`#

`AZ_MEASUREMENT_FREQ`#

`AZ_NUMBER_OF_MEASUREMENTS`#

`A_ID_MAX_LENGTH`#

`BIN_COUNTER_LEN`#

`BURST_DURATION`#

`BURST_EXP`#

`BURST_PERIOD`#

`BW`#

`CARD_WAKEUP_GPIO_PIN`#

`CCK_DESENSE_MODE_DISABLED`#

`CCK_DESENSE_MODE_DYNAMIC`#

`CCK_DESENSE_MODE_DYN_ENH`#

`CIVIC_ADDRESS_TYPE`#

`CIVIC_COUNTRY_CODE`#

`CIVIC_LOCATION`#

`CIVIC_LOCATION_TYPE`#

`CIVIC_REQUEST`#