WFM API messages applicable for an interface in STA mode.

Data Structures
struct	sl_wfx_disconnect_cnf_t
	Confirmation message for sl_wfx_disconnect_req_t .

struct	sl_wfx_disconnect_ind_t
	Indication message used to signal the completion of a disconnection operation.

struct	sl_wfx_get_signal_strength_cnf_t
	Confirmation message for sl_wfx_get_signal_strength_req_t .

struct	sl_wfx_set_pm_mode_req_t
	Request message for setting the power management mode of the device.

struct	sl_wfx_set_pm_mode_cnf_t
	Confirmation message for sl_wfx_set_pm_mode_req_t .

struct	sl_wfx_send_frame_req_t
	Request message for sending a packet to the network.

struct	sl_wfx_send_frame_cnf_t
	Confirmation message for sl_wfx_send_frame_req_t .

struct	sl_wfx_received_ind_t
	Indication message used to signal a received packet.

struct	sl_wfx_start_scan_req_t
	Request message for starting a scan to detect near-by access points.

struct	sl_wfx_start_scan_cnf_t
	Confirmation message for sl_wfx_start_scan_req_t .

struct	sl_wfx_stop_scan_cnf_t
	Confirmation message for sl_wfx_stop_scan_req_t .

struct	sl_wfx_scan_result_ind_t
	Indication message used to signal an access point has been detected.

struct	sl_wfx_scan_complete_ind_t
	Indication message used to signal a scan was completed.

struct	sl_wfx_add_multicast_addr_req_t
	Request message for adding a multicast address to the multicast filter whitelist.

struct	sl_wfx_add_multicast_addr_cnf_t
	Confirmation message for sl_wfx_add_multicast_addr_req_t .

struct	sl_wfx_remove_multicast_addr_req_t
	Request message for removing a multicast address from the multicast filter whitelist.

struct	sl_wfx_remove_multicast_addr_cnf_t
	Confirmation message for sl_wfx_remove_multicast_addr_req_t .

struct	sl_wfx_set_roam_parameters_req_t
	Request message for setting the roaming parameters.

struct	sl_wfx_set_roam_parameters_cnf_t
	Confirmation message for sl_wfx_set_roam_parameters_req_t .

struct	sl_wfx_set_tx_rate_parameters_req_t
	Request message for setting the TX rate set parameters.

struct	sl_wfx_set_tx_rate_parameters_cnf_t
	Confirmation message for sl_wfx_set_tx_rate_parameters_req_t .

struct	sl_wfx_set_arp_ip_address_req_t
	Request message for setting the Address Resolution Protocol (ARP) offloading state.

struct	sl_wfx_set_arp_ip_address_cnf_t
	Confirmation message for sl_wfx_set_arp_ip_address_req_t .

struct	sl_wfx_set_ns_ip_address_req_t
	Request message for setting the Neighbor Discovery Protocol (NDP) offloading state.

struct	sl_wfx_set_ns_ip_address_cnf_t
	Confirmation message for sl_wfx_set_ns_ip_address_req_t .

struct	sl_wfx_set_broadcast_filter_req_t
	Request message for setting broadcast filter state.

struct	sl_wfx_set_broadcast_filter_cnf_t
	Confirmation message for sl_wfx_set_broadcast_filter_req_t .

struct	sl_wfx_set_scan_parameters_req_t
	Request message for setting scan parameters.

struct	sl_wfx_set_scan_parameters_cnf_t
	Confirmation message for sl_wfx_set_scan_parameters_req_t .

struct	sl_wfx_set_max_tx_power_req_t
	Request message for setting the maximum transmit power of the device.

struct	sl_wfx_set_max_tx_power_cnf_t
	Confirmation message for sl_wfx_set_max_tx_power_req_t .

struct	sl_wfx_get_max_tx_power_cnf_t
	Confirmation message for sl_wfx_get_max_tx_power_req_t .

struct	sl_wfx_get_pmk_cnf_t
	Confirmation message for sl_wfx_get_pmk_req_t .

struct	sl_wfx_ext_auth_req_t
	Request message for sl_wfx_ext_auth_req_t .

struct	sl_wfx_ext_auth_cnf_t
	Confirmation message for sl_wfx_ext_auth_req_t .

struct	sl_wfx_ext_auth_ind_t
	Indication message for sl_wfx_ext_auth_ind_t .

struct	sl_wfx_disconnect_req_t
	Request message for disconnecting from a Wi-Fi network.

struct	sl_wfx_get_signal_strength_req_t
	Request message for retrieving the signal strength of connection.

struct	sl_wfx_stop_scan_req_t
	Request message for stopping an ongoing scan.

struct	sl_wfx_get_max_tx_power_req_t
	Request message for getting the maximum transmit power.

struct	sl_wfx_get_pmk_req_t
	Request message for getting the Pairwise Master Key (PMK).

Typedefs
typedef sl_wfx_header_t	SL_WFX_PS_MODE_ERROR_IND
	Indication message used to signal that the device has switched to Fast Power Save.

Detailed Description

WFM API messages applicable for an interface in STA mode.

Data Structure Documentation

◆ sl_wfx_disconnect_cnf_t

struct sl_wfx_disconnect_cnf_t

Confirmation message for sl_wfx_disconnect_req_t .

Definition at line 985 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_disconnect_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_disconnect_ind_t

struct sl_wfx_disconnect_ind_t

Indication message used to signal the completion of a disconnection operation.

The device will send this indication to signal the disconnection request initiated with sl_wfx_disconnect_req_t has been completed. The indication is also sent when the device has lost the connection to an access point and has been unable to regain it.

Definition at line 1019 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_disconnect_ind_body_t	body	Indication message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_get_signal_strength_cnf_t

struct sl_wfx_get_signal_strength_cnf_t

Confirmation message for sl_wfx_get_signal_strength_req_t .

Definition at line 1061 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_get_signal_strength_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_set_pm_mode_req_t

struct sl_wfx_set_pm_mode_req_t

Request message for setting the power management mode of the device.

The host can use this request to enable or disable Wi-Fi power management mechanisms.

Interface mode	Request allowed
idle	No
station	Yes
AP	No

Definition at line 1113 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_set_pm_mode_req_body_t	body	Request message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_set_pm_mode_cnf_t

struct sl_wfx_set_pm_mode_cnf_t

Confirmation message for sl_wfx_set_pm_mode_req_t .

Definition at line 1137 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_set_pm_mode_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_send_frame_req_t

struct sl_wfx_send_frame_req_t

Request message for sending a packet to the network.

The host can use this request to send a packet to the network.

Interface mode	Request allowed
idle	No
station	Yes
AP	Yes

Definition at line 1601 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_send_frame_req_body_t	body	Request message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_send_frame_cnf_t

struct sl_wfx_send_frame_cnf_t

Confirmation message for sl_wfx_send_frame_req_t .

Definition at line 1634 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_send_frame_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_received_ind_t

struct sl_wfx_received_ind_t

Indication message used to signal a received packet.

The device will send this indication to signal a packet has been received.

Definition at line 1674 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_received_ind_body_t	body	Indication message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_start_scan_req_t

struct sl_wfx_start_scan_req_t

Request message for starting a scan to detect near-by access points.

The host can use this request to start a scan operation to detect near-by access points.

Interface mode	Request allowed
idle	Yes
station	Yes
AP	No

Definition at line 1748 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_start_scan_req_body_t	body	Request message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_start_scan_cnf_t

struct sl_wfx_start_scan_cnf_t

Confirmation message for sl_wfx_start_scan_req_t .

Definition at line 1773 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_start_scan_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_stop_scan_cnf_t

struct sl_wfx_stop_scan_cnf_t

Confirmation message for sl_wfx_stop_scan_req_t .

Definition at line 1812 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_stop_scan_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_scan_result_ind_t

struct sl_wfx_scan_result_ind_t

Indication message used to signal an access point has been detected.

The device will send this indication to signal an access point has has been detected during the scan operation.

Definition at line 1870 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_scan_result_ind_body_t	body	Indication message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_scan_complete_ind_t

struct sl_wfx_scan_complete_ind_t

Indication message used to signal a scan was completed.

The device will send this indication to signal a scan operation has been completed.

Definition at line 1897 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_scan_complete_ind_body_t	body	Indication message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_add_multicast_addr_req_t

struct sl_wfx_add_multicast_addr_req_t

Request message for adding a multicast address to the multicast filter whitelist.

The host can use this request to add a multicast address to the multicast filter whitelist. When the first address is added the whitelist, the device will discard all multicast frames whose destination address does not match any of the addresses on the list. The default state is to allow all multicast addresses. The whitelist is reset to the default state when the interface is reset. Up to 8 multicast addresses may be added.
See Filtering for further details.

Interface mode	Request allowed
idle	No
station	Yes
AP	Yes

Definition at line 1936 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_add_multicast_addr_req_body_t	body	Request message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_add_multicast_addr_cnf_t

struct sl_wfx_add_multicast_addr_cnf_t

Confirmation message for sl_wfx_add_multicast_addr_req_t .

Definition at line 1961 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_add_multicast_addr_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_remove_multicast_addr_req_t

struct sl_wfx_remove_multicast_addr_req_t

Request message for removing a multicast address from the multicast filter whitelist.

The host can use this request to remove a multicast address from the multicast filter whitelist.

Interface mode	Request allowed
idle	No
station	Yes
AP	Yes

Definition at line 1993 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_remove_multicast_addr_req_body_t	body	Request message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_remove_multicast_addr_cnf_t

struct sl_wfx_remove_multicast_addr_cnf_t

Confirmation message for sl_wfx_remove_multicast_addr_req_t .

Definition at line 2018 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_remove_multicast_addr_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_set_roam_parameters_req_t

struct sl_wfx_set_roam_parameters_req_t

Request message for setting the roaming parameters.

The host can use this request to configure the roaming parameters used by the device.
See Roaming for further details.

Interface mode	Request allowed
idle	Yes
station	Yes
AP	No

Definition at line 2210 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_set_roam_parameters_req_body_t	body	Request message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_set_roam_parameters_cnf_t

struct sl_wfx_set_roam_parameters_cnf_t

Confirmation message for sl_wfx_set_roam_parameters_req_t .

Definition at line 2235 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_set_roam_parameters_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_set_tx_rate_parameters_req_t

struct sl_wfx_set_tx_rate_parameters_req_t

Request message for setting the TX rate set parameters.

The host can use this request to configure the TX rate set parameters of the device. The rate set determines what data rates will be used by the device to transmit data frames.

Interface mode	Request allowed
idle	Yes
station	Yes
AP	No

Definition at line 2280 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_set_tx_rate_parameters_req_body_t	body	Request message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_set_tx_rate_parameters_cnf_t

struct sl_wfx_set_tx_rate_parameters_cnf_t

Confirmation message for sl_wfx_set_tx_rate_parameters_req_t .

Definition at line 2305 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_set_tx_rate_parameters_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_set_arp_ip_address_req_t

struct sl_wfx_set_arp_ip_address_req_t

Request message for setting the Address Resolution Protocol (ARP) offloading state.

The host can use this request to offload handling of ARP requests to the device. When offloading is enabled, the device will automatically respond to ARP requests with an ARP reply. By default offloading is disabled. Offloading is reset to the default state when the interface is reset.
See Offloading for further details.

Interface mode	Request allowed
idle	No
station	Yes
AP	No

Definition at line 2342 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_set_arp_ip_address_req_body_t	body	Request message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_set_arp_ip_address_cnf_t

struct sl_wfx_set_arp_ip_address_cnf_t

Confirmation message for sl_wfx_set_arp_ip_address_req_t .

Definition at line 2366 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_set_arp_ip_address_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_set_ns_ip_address_req_t

struct sl_wfx_set_ns_ip_address_req_t

Request message for setting the Neighbor Discovery Protocol (NDP) offloading state.

The host can use this request to offload handling of IPv6 Neighbor Solicitations to the device. When offloading is enabled, the device will automatically respond to a solicitation with a Neighbor Advertisement. By default offloading is disabled. Offloading is reset to the default state when the interface is reset.
See Offloading for further details.

Interface mode	Request allowed
idle	No
station	Yes
AP	No

Definition at line 2402 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_set_ns_ip_address_req_body_t	body	Request message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_set_ns_ip_address_cnf_t

struct sl_wfx_set_ns_ip_address_cnf_t

Confirmation message for sl_wfx_set_ns_ip_address_req_t .

Definition at line 2426 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_set_ns_ip_address_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_set_broadcast_filter_req_t

struct sl_wfx_set_broadcast_filter_req_t

Request message for setting broadcast filter state.

The host can use this request to configure the state of the broadcast filter. When enabled, the device will only forward certain broadcast frames to the host and automatically discard the rest.
See Filtering for further details.

Interface mode	Request allowed
idle	No
station	Yes
AP	No

Definition at line 2466 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_set_broadcast_filter_req_body_t	body	Request message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_set_broadcast_filter_cnf_t

struct sl_wfx_set_broadcast_filter_cnf_t

Confirmation message for sl_wfx_set_broadcast_filter_req_t .

Definition at line 2490 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_set_broadcast_filter_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_set_scan_parameters_req_t

struct sl_wfx_set_scan_parameters_req_t

Request message for setting scan parameters.

The host can use this request to configure the scan parameters used by the device.

Interface mode	Request allowed
idle	Yes
station	Yes
AP	No

Definition at line 2539 of file sl_wfx_cmd_api.h .

◆ sl_wfx_set_scan_parameters_cnf_t

struct sl_wfx_set_scan_parameters_cnf_t

Confirmation message for sl_wfx_set_scan_parameters_req_t .

Definition at line 2561 of file sl_wfx_cmd_api.h .

◆ sl_wfx_set_max_tx_power_req_t

struct sl_wfx_set_max_tx_power_req_t

Request message for setting the maximum transmit power of the device.

The host can use this request to set a maximum transmit power. The device can still use a lower transmit power depending on regulatory rules or internal limitations.

Interface mode	Request allowed
idle	Yes
station	Yes
AP	Yes

Definition at line 2781 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_set_max_tx_power_req_body_t	body	Request message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_set_max_tx_power_cnf_t

struct sl_wfx_set_max_tx_power_cnf_t

Confirmation message for sl_wfx_set_max_tx_power_req_t .

Definition at line 2807 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_set_max_tx_power_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_get_max_tx_power_cnf_t

struct sl_wfx_get_max_tx_power_cnf_t

Confirmation message for sl_wfx_get_max_tx_power_req_t .

Definition at line 2858 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_get_max_tx_power_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_get_pmk_cnf_t

struct sl_wfx_get_pmk_cnf_t

Confirmation message for sl_wfx_get_pmk_req_t .

Definition at line 2911 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_get_pmk_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_ext_auth_req_t

struct sl_wfx_ext_auth_req_t

Request message for sl_wfx_ext_auth_req_t .

Definition at line 2998 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_ext_auth_req_body_t	body	Request message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_ext_auth_cnf_t

struct sl_wfx_ext_auth_cnf_t

Confirmation message for sl_wfx_ext_auth_req_t .

Definition at line 3022 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_ext_auth_cnf_body_t	body	Confirmation message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_ext_auth_ind_t

struct sl_wfx_ext_auth_ind_t

Indication message for sl_wfx_ext_auth_ind_t .

Definition at line 3052 of file sl_wfx_cmd_api.h .

Data Fields
sl_wfx_ext_auth_ind_body_t	body	Indication message body.
sl_wfx_header_t	header	Common message header.

◆ sl_wfx_disconnect_req_t

struct sl_wfx_disconnect_req_t

Request message for disconnecting from a Wi-Fi network.

The host can use this request to initiate a disconnection from a Wi-Fi network.

Interface mode	Request allowed
idle	No
station	Yes
AP	No

◆ sl_wfx_get_signal_strength_req_t

struct sl_wfx_get_signal_strength_req_t

Request message for retrieving the signal strength of connection.

The host can use this request to retrieve the signal strength of the connection.

Interface mode	Request allowed
idle	No
station	Yes
AP	No

◆ sl_wfx_stop_scan_req_t

struct sl_wfx_stop_scan_req_t

Request message for stopping an ongoing scan.

The host can use this request to stop an ongoing scan operation.

Interface mode	Request allowed
idle	Yes
station	Yes
AP	No

◆ sl_wfx_get_max_tx_power_req_t

struct sl_wfx_get_max_tx_power_req_t

Request message for getting the maximum transmit power.

The host can use this request to get the current value of maximum transmit power.

Interface mode	Request allowed
idle	Yes
station	Yes
AP	Yes

◆ sl_wfx_get_pmk_req_t

struct sl_wfx_get_pmk_req_t

Request message for getting the Pairwise Master Key (PMK).

The host can use this request to retrieve the Pairwise Master Key (PMK) used to connect to the current secure network. PMK can be given in the next sl_wfx_connect_req_t message to speed up connection process. See Passwords and pass phrases for further details.

Interface mode	Request allowed
idle	No
station	Yes
AP	Yes

Typedef Documentation

◆ SL_WFX_PS_MODE_ERROR_IND

typedef sl_wfx_header_t SL_WFX_PS_MODE_ERROR_IND

Indication message used to signal that the device has switched to Fast Power Save.

This indication occurs when the devices switches to Fast PS as an attempt to mitigate poor performance with U-APSD. Listen interval falls back to 0 (listen to every beacon/DTIM). This can be overridden by issuing SL_WFX_SET_PM_MODE_REQ command again.

Definition at line 1152 of file sl_wfx_cmd_api.h .

API messages in station mode FULL_MAC_API > API messages by mode

Data Structures

Typedefs