Get ARP Offload Agent Enable from Device (WLAN)

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[out]	agent_enable	: pointer to store value

Returns

whd_result_t

Set ARP Offload Agent Enable in Device (WLAN) Set Enable/Disable of ARP Offload Agent.

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	agent_enable	: Enable=1 / Disable=0

Returns

whd_result_t

Clear ARP Offload cache in Device (WLAN)

Parameters

[in]

ifp

: pointer to handle instance of whd interface

Returns

whd_result_t

Get ARP Offload Feature Flags from Device (WLAN)

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[out]	features	: ptr to store currently set features - bit flags CY_ARP_OL_AGENT_ENABLE, etc. ARL_OL_AGENT | ARL_OL_SNOOP | ARP_OL_HOST_AUTO_REPLY | ARP_OL_PEER_AUTO_REPLY

Returns

whd_result_t

Print ARP Offload Feature Flags in Human readable form to console.

Parameters

[in]	features	: feature flags to set (you can OR '|' multiple flags) CY_ARP_OL_AGENT_ENABLE, etc. ARL_OL_AGENT | ARL_OL_SNOOP | ARP_OL_HOST_AUTO_REPLY | ARP_OL_PEER_AUTO_REPLY
[in]	title	: Optional: Title for output (NULL == no title)

Returns

whd_result_t

Set ARP Offload Feature Flags in Device (WLAN)

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	features	: features to set value (you can OR ('|') multiple flags) CY_ARP_OL_AGENT_ENABLE, etc. ARL_OL_AGENT | ARL_OL_SNOOP | ARP_OL_HOST_AUTO_REPLY | ARP_OL_PEER_AUTO_REPLY

Returns

whd_result_t

Add ARP Offload Host IP Identifier(s) to HostIP List to Device (WLAN)

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	host_ipv4_list	: pointer to host_ip data (IPv4, 1 uint32_t per ip addr)
[in]	count	: Number of array elements in host_ip

Returns

whd_result_t

Add One ARP Offload Host IP Identifier to HostIP List (mbed-style IP string) to Device (WLAN)

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	ip_addr	: pointer to ip string (as returned from mbedos calls)

Returns

whd_result_t

Clear all ARP Offload Host IP Identifier List.

Parameters

[in]

ifp

: pointer to handle instance of whd interface

Returns

whd_result_t

Clear One ARP Offload Host IP Identifier from Host IP List in Device (WLAN)

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	ipv4_addr	: ip addr expressed as a uint32_t

Returns

whd_result_t

Clear One ARP Offload Host IP Identifier from Host IP List (mbed-style IP string) in Device (WLAN)

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	ip_addr	: pointer to ip string (as returned from mbedos calls)

Returns

whd_result_t

Get ARP Offload Host IP Identifiers from Device (WLAN)

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	count	: Number of array elements in host_ip
[out]	host_ipv4_list	: Pointer to structure array to store host_ip data
[out]	filled	: Number of array elements filled by this routine

Returns

whd_result_t

Get ARP Offload Peer Age from Device (WLAN) Length of time in seconds before aging out an entry in the WLAN processor ARP table.

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[out]	seconds	: pointer to store value

Returns

whd_result_t

Set ARP Offload Peer Age in Device (WLAN) Length of time in seconds before aging out an entry in the WLAN processor ARP table.

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	seconds	: Seconds to age out IP

Returns

whd_result_t

Clear ARP Offload statistics in Device (WLAN)

Parameters

[in]

ifp

: pointer to handle instance of whd interface

Returns

whd_result_t

Get ARP Offload statistics from Device (WLAN)

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[out]	stats	: Ptr to store statistics whd_arp_stats_t

Returns

whd_result_t

Print ARP Offload statistics NOTE: call whd_arp_stats_get(), then print them using this function.

Parameters

[in]	arp_stats	: Ptr to ARP statistics structure
[in]	title	: Optional: Title for output (NULL == no title)

Returns

whd_result_t

Get version of Device (WLAN) Firmware.

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[out]	version	: pointer to store version #

Returns

whd_result_t

A filter must be added (e.g.

created) before it can be enabled.

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	settings	: Ptr to filter settings whd_packet_filter_t

Returns

whd_result_t

After a filter has been added it can be enabled or disabled as needed.

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	filter_id	: filter to disable

Returns

whd_result_t

After a filter has been added it can be enabled or disabled as needed.

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	filter_id	: filter to enable

Returns

whd_result_t

Filters are implemented in WLAN subsystem as a bit pattern and matching bit mask that are applied to incoming packets.

This API retrieves the pattern and mask.

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	filter_id	: which filter to retrieve
[in]	max_size	: size of both mask and pattern buffers
[out]	mask	: mask for this filter
[out]	pattern	: pattern for this filter
[out]	size_out	: length of both mask and pattern

Returns

whd_result_t

Return the stats associated with a filter.

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	filter_id	: which filter
[out]	stats	: Ptr to store statistics wl_pkt_filter_stats_t

Returns

whd_result_t

Remove a previously added filter.

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	filter_id	: filter to remove

Returns

whd_result_t

Return the stats associated with a filter.

Parameters

[in]	ifp	: Pointer to handle instance of whd interface
[in]	index	: index for TCP offload connection
[out]	whd_connect	: tko_connect structure buffer from Firmware
[in]	buflen	: Buffer given for tko_connect

Returns

whd_result_t

Return the tko status for all indexes.

Parameters

[in]	ifp	: Pointer to handle instance of whd interface
[out]	tko_status	: Ptr to store tko_status

Returns

whd_result_t

Return the stats associated with a filter.

Parameters

[in]	ifp	: Pointer to handle instance of whd interface
[out]	max	: returns Max TCP connections supported by WLAN Firmware

Returns

whd_result_t

Set/Get TKO retry & interval parameters.

Parameters

[in]	ifp	: Pointer to handle instance of whd interface
[in]	whd_tko_retry	: whd retry & interval parameters structure
[in]	set	: Set/Get Flag

Returns

whd_result_t

Return the stats associated with a filter.

Parameters

[in]	ifp	: Pointer to handle instance of whd interface
[in]	enable	: Enable/Disable TCP Keepalive offload

Returns

whd_result_t

Clear the packet filter stats associated with a filter id.

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	filter_id	: which filter

Returns

whd_result_t

Enable WHD internal supplicant and set WPA2 passphrase in case of WPA3/WPA2 transition mode.

Parameters

ifp	Pointer to handle instance of whd interface
security_key_psk	The security key (passphrase) which is to be set
psk_length	length of the key
auth_type	Authentication type: WHD_SECURITY_WPA3_WPA2_PSK

Returns

WHD_SUCCESS when the supplicant variable and wpa2 passphrase is set Error code if an error occurred

Enable WHD internal supplicant.

Parameters

ifp	Pointer to handle instance of whd interface
auth_type	Authentication type

Returns

WHD_SUCCESS when the supplicant variable is set Error code if an error occurred

Retrieve the latest STA EDCF AC parameters.

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

Parameters

ifp	Pointer to handle instance of whd interface
acp	The location where the array of AC parameters will be stored

Returns

WHD_SUCCESS if the AC Parameters were successfully retrieved Error code if the AC Parameters were not retrieved

Retrieve the associated STA's RSSI value.

Parameters

ifp	: Pointer to handle instance of whd interface
rssi	: The location where the RSSI value will be stored
client_mac	: Pointer to associated client's MAC address

Returns

WHD_SUCCESS : if the RSSI was successfully retrieved Error code : if the RSSI was not retrieved

Get the BSSID of the interface.

Parameters

ifp	Pointer to the whd_interface_t
bssid	Returns the BSSID address (mac address) if associated

Returns

WHD_SUCCESS or Error code

Get the current channel on the WLAN radio.

Note

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

Parameters

ifp	Pointer to handle instance of whd interface
channel	Pointer to receive the current channel

Returns

WHD_SUCCESS if the channel was successfully retrieved Error code if the channel was not successfully retrieved

Gets the current value of all beacon listen interval variables.

Parameters

ifp	Pointer to handle instance of whd interface
li	Powersave listen interval values listen_interval_beacon : The current value of the listen interval set as a multiple of the beacon period listen_interval_dtim : The current value of the listen interval set as a multiple of the DTIM period listen_interval_assoc : The current value of the listen interval sent to access points in an association request frame

Returns

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

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

Parameters

ifp	Pointer to handle instance of whd interface
mac	Pointer to a variable that the current MAC address will be written to

Returns

WHD_SUCCESS or Error code

Retrieve the latest RSSI value.

Parameters

ifp	Pointer to handle instance of whd interface
rssi	The location where the RSSI value will be stored

Returns

WHD_SUCCESS if the RSSI was successfully retrieved Error code if the RSSI was not retrieved

Determines if a particular interface is ready to transceive ethernet packets.

Parameters

ifp	Pointer to handle instance of whd interface

Returns

WHD_SUCCESS if the interface is ready to transceive ethernet packets WHD_NOTFOUND no AP with a matching SSID was found WHD_NOT_AUTHENTICATED Matching AP was found but it won't let you authenticate. This can occur if this device is in the block list on the AP. WHD_NOT_KEYED Device has authenticated and associated but has not completed the key exchange. This can occur if the passphrase is incorrect. Error code if the interface is not ready to transceive ethernet packets

Manage the addition and removal of custom IEs.

Parameters

ifp	Pointer to handle instance of whd interface
action	the action to take (add or remove IE)
oui	the oui of the custom IE
subtype	the IE sub-type
data	a pointer to the buffer that hold the custom IE
length	the length of the buffer pointed to by 'data'
which_packets	A mask to indicate in which all packets this IE should be included. See whd_ie_packet_flag_t.

Returns

WHD_SUCCESS if the custom IE action was successful Error code if the custom IE action failed

Registers interest in a multicast address.

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

Parameters

ifp	Pointer to handle instance of whd interface
mac	Ethernet MAC address

Returns

WHD_SUCCESS if the address was registered successfully Error code if the address was not registered

Set the SAE password.

Parameters

ifp	Pointer to handle instance of whd interface
security_key	The security key (password) which is to be set
key_length	length of the key

Returns

WHD_SUCCESS when the key is set Error code if an error occurred

Send a pre-prepared action frame.

Parameters

ifp	Pointer to handle instance of whd interface
af_params	A pointer to a pre-prepared action frame structure

Returns

WHD_SUCCESS or Error code

Set the current channel on the WLAN radio.

Note

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

Parameters

ifp	Pointer to handle instance of whd interface
channel	The desired channel

Returns

WHD_SUCCESS if the channel was successfully set Error code if the channel was not successfully set

Set coex configuration.

Parameters

ifp	Pointer to handle instance of whd interface
coex_config	Pointer to the structure whd_coex_config_t

Returns

WHD_SUCCESS or Error code

Sets the 802.11 powersave listen interval for a Wi-Fi client, and communicates the listen interval to the Access Point.

The listen interval will be set to (listen_interval x time_unit) seconds.

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

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

Parameters

ifp	Pointer to handle instance of whd interface
listen_interval	The desired beacon listen interval
time_unit	The listen interval time unit; options are beacon period or DTIM period.

Returns

WHD_SUCCESS If the listen interval was successfully set. Error code If the listen interval was not successfully set.

Set the passphrase.

Parameters

ifp	Pointer to handle instance of whd interface
security_key	The security key (passphrase) which is to be set
key_length	length of the key

Returns

WHD_SUCCESS when the key is set Error code if an error occurred

After a filter has been added it can be enabled or disabled as needed.

Parameters

[in]	ifp	: pointer to handle instance of whd interface
[in]	filter_id	: filter to disable/enable
[in]	enable	: Enable/Disable Flag

Returns

whd_result_t

Unregisters interest in a multicast address.

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

Parameters

ifp	Pointer to handle instance of whd interface
mac	Ethernet MAC address

Returns

WHD_SUCCESS if the address was unregistered successfully Error code if the address was not unregistered