API messages in station mode

WFM API messages applicable for an interface in STA mode. More...

Classes
struct	sl_wfx_disconnect_cnf_s
	Confirmation message for sl_wfx_disconnect_req_t. More...
struct	sl_wfx_disconnect_ind_s
	Indication message used to signal the completion of a disconnection operation. More...
struct	sl_wfx_get_signal_strength_cnf_s
	Confirmation message for sl_wfx_get_signal_strength_req_t. More...
struct	sl_wfx_set_pm_mode_req_s
	Request message for setting the power management mode of the device. More...
struct	sl_wfx_set_pm_mode_cnf_s
	Confirmation message for sl_wfx_set_pm_mode_req_t. More...
struct	sl_wfx_send_frame_req_s
	Request message for sending a packet to the network. More...
struct	sl_wfx_send_frame_cnf_s
	Confirmation message for sl_wfx_send_frame_req_t. More...
struct	sl_wfx_received_ind_s
	Indication message used to signal a received packet. More...
struct	sl_wfx_start_scan_req_s
	Request message for starting a scan to detect near-by access points. More...
struct	sl_wfx_start_scan_cnf_s
	Confirmation message for sl_wfx_start_scan_req_t. More...
struct	sl_wfx_stop_scan_cnf_s
	Confirmation message for sl_wfx_stop_scan_req_t. More...
struct	sl_wfx_scan_result_ind_s
	Indication message used to signal an access point has been detected. More...
struct	sl_wfx_scan_complete_ind_s
	Indication message used to signal a scan was completed. More...
struct	sl_wfx_add_multicast_addr_req_s
	Request message for adding a multicast address to the multicast filter whitelist. More...
struct	sl_wfx_add_multicast_addr_cnf_s
	Confirmation message for sl_wfx_add_multicast_addr_req_t. More...
struct	sl_wfx_remove_multicast_addr_req_s
	Request message for removing a multicast address from the multicast filter whitelist. More...
struct	sl_wfx_remove_multicast_addr_cnf_s
	Confirmation message for sl_wfx_remove_multicast_addr_req_t. More...
struct	sl_wfx_set_roam_parameters_req_s
	Request message for setting the roaming parameters. More...
struct	sl_wfx_set_roam_parameters_cnf_s
	Confirmation message for sl_wfx_set_roam_parameters_req_t. More...
struct	sl_wfx_set_tx_rate_parameters_req_s
	Request message for setting the TX rate set parameters. More...
struct	sl_wfx_set_tx_rate_parameters_cnf_s
	Confirmation message for sl_wfx_set_tx_rate_parameters_req_t. More...
struct	sl_wfx_set_arp_ip_address_req_s
	Request message for setting the Address Resolution Protocol (ARP) offloading state. More...
struct	sl_wfx_set_arp_ip_address_cnf_s
	Confirmation message for sl_wfx_set_arp_ip_address_req_t. More...
struct	sl_wfx_set_ns_ip_address_req_s
	Request message for setting the Neighbor Discovery Protocol (NDP) offloading state. More...
struct	sl_wfx_set_ns_ip_address_cnf_s
	Confirmation message for sl_wfx_set_ns_ip_address_req_t. More...
struct	sl_wfx_set_broadcast_filter_req_s
	Request message for setting broadcast filter state. More...
struct	sl_wfx_set_broadcast_filter_cnf_s
	Confirmation message for sl_wfx_set_broadcast_filter_req_t. More...
struct	sl_wfx_set_scan_parameters_req_s
	Request message for setting scan parameters. More...
struct	sl_wfx_set_scan_parameters_cnf_s
	Confirmation message for sl_wfx_set_scan_parameters_req_t. More...
struct	sl_wfx_set_max_tx_power_req_s
	Request message for setting the maximum transmit power of the device. More...
struct	sl_wfx_set_max_tx_power_cnf_s
	Confirmation message for sl_wfx_set_max_tx_power_req_t. More...
struct	sl_wfx_get_max_tx_power_cnf_s
	Confirmation message for sl_wfx_get_max_tx_power_req_t. More...
struct	sl_wfx_get_pmk_cnf_s
	Confirmation message for sl_wfx_get_pmk_req_t. More...
struct	sl_wfx_ext_auth_cnf_s
	Confirmation message for sl_wfx_ext_auth_req_t. More...
struct	sl_wfx_disconnect_req_t
	Request message for disconnecting from a Wi-Fi network. More...
struct	sl_wfx_get_signal_strength_req_t
	Request message for retrieving the signal strength of connection. More...
struct	sl_wfx_stop_scan_req_t
	Request message for stopping an ongoing scan. More...
struct	sl_wfx_get_max_tx_power_req_t
	Request message for getting the maximum transmit power. More...
struct	sl_wfx_get_pmk_req_t
	Request message for getting the Pairwise Master Key (PMK). More...

Typedefs
typedef struct sl_wfx_disconnect_cnf_s	sl_wfx_disconnect_cnf_t
	Confirmation message for sl_wfx_disconnect_req_t.
typedef struct sl_wfx_disconnect_ind_s	sl_wfx_disconnect_ind_t
	Indication message used to signal the completion of a disconnection operation. More...
typedef struct sl_wfx_get_signal_strength_cnf_s	sl_wfx_get_signal_strength_cnf_t
	Confirmation message for sl_wfx_get_signal_strength_req_t.
typedef struct sl_wfx_set_pm_mode_req_s	sl_wfx_set_pm_mode_req_t
	Request message for setting the power management mode of the device. More...
typedef struct sl_wfx_set_pm_mode_cnf_s	sl_wfx_set_pm_mode_cnf_t
	Confirmation message for sl_wfx_set_pm_mode_req_t.
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. More...
typedef struct sl_wfx_start_scan_req_s	sl_wfx_start_scan_req_t
	Request message for starting a scan to detect near-by access points. More...
typedef struct sl_wfx_start_scan_cnf_s	sl_wfx_start_scan_cnf_t
	Confirmation message for sl_wfx_start_scan_req_t.
typedef struct sl_wfx_stop_scan_cnf_s	sl_wfx_stop_scan_cnf_t
	Confirmation message for sl_wfx_stop_scan_req_t.
typedef struct sl_wfx_scan_result_ind_s	sl_wfx_scan_result_ind_t
	Indication message used to signal an access point has been detected. More...
typedef struct sl_wfx_scan_complete_ind_s	sl_wfx_scan_complete_ind_t
	Indication message used to signal a scan was completed. More...
typedef struct sl_wfx_set_roam_parameters_req_s	sl_wfx_set_roam_parameters_req_t
	Request message for setting the roaming parameters. More...
typedef struct sl_wfx_set_roam_parameters_cnf_s	sl_wfx_set_roam_parameters_cnf_t
	Confirmation message for sl_wfx_set_roam_parameters_req_t.
typedef struct sl_wfx_set_tx_rate_parameters_req_s	sl_wfx_set_tx_rate_parameters_req_t
	Request message for setting the TX rate set parameters. More...
typedef struct sl_wfx_set_tx_rate_parameters_cnf_s	sl_wfx_set_tx_rate_parameters_cnf_t
	Confirmation message for sl_wfx_set_tx_rate_parameters_req_t.
typedef struct sl_wfx_set_arp_ip_address_req_s	sl_wfx_set_arp_ip_address_req_t
	Request message for setting the Address Resolution Protocol (ARP) offloading state. More...
typedef struct sl_wfx_set_arp_ip_address_cnf_s	sl_wfx_set_arp_ip_address_cnf_t
	Confirmation message for sl_wfx_set_arp_ip_address_req_t.
typedef struct sl_wfx_set_ns_ip_address_req_s	sl_wfx_set_ns_ip_address_req_t
	Request message for setting the Neighbor Discovery Protocol (NDP) offloading state. More...
typedef struct sl_wfx_set_ns_ip_address_cnf_s	sl_wfx_set_ns_ip_address_cnf_t
	Confirmation message for sl_wfx_set_ns_ip_address_req_t.
typedef struct sl_wfx_set_broadcast_filter_req_s	sl_wfx_set_broadcast_filter_req_t
	Request message for setting broadcast filter state. More...
typedef struct sl_wfx_set_broadcast_filter_cnf_s	sl_wfx_set_broadcast_filter_cnf_t
	Confirmation message for sl_wfx_set_broadcast_filter_req_t.
typedef struct sl_wfx_set_scan_parameters_req_s	sl_wfx_set_scan_parameters_req_t
	Request message for setting scan parameters. More...
typedef struct sl_wfx_set_scan_parameters_cnf_s	sl_wfx_set_scan_parameters_cnf_t
	Confirmation message for sl_wfx_set_scan_parameters_req_t.
typedef struct sl_wfx_ext_auth_cnf_s	sl_wfx_ext_auth_cnf_t
	Confirmation message for sl_wfx_ext_auth_req_t.

Detailed Description

WFM API messages applicable for an interface in STA mode.

Typedef Documentation

sl_wfx_disconnect_ind_t

typedef struct sl_wfx_disconnect_ind_s 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.

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.

sl_wfx_scan_complete_ind_t

typedef struct sl_wfx_scan_complete_ind_s 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.

sl_wfx_scan_result_ind_t

typedef struct sl_wfx_scan_result_ind_s 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.

sl_wfx_set_arp_ip_address_req_t

typedef struct sl_wfx_set_arp_ip_address_req_s 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

sl_wfx_set_broadcast_filter_req_t

typedef struct sl_wfx_set_broadcast_filter_req_s 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

sl_wfx_set_ns_ip_address_req_t

typedef struct sl_wfx_set_ns_ip_address_req_s 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

sl_wfx_set_pm_mode_req_t

typedef struct sl_wfx_set_pm_mode_req_s 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

sl_wfx_set_roam_parameters_req_t

typedef struct sl_wfx_set_roam_parameters_req_s 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

sl_wfx_set_scan_parameters_req_t

typedef struct sl_wfx_set_scan_parameters_req_s 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

sl_wfx_set_tx_rate_parameters_req_t

typedef struct sl_wfx_set_tx_rate_parameters_req_s 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

sl_wfx_start_scan_req_t

typedef struct sl_wfx_start_scan_req_s 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