WFM API constant values.

Macros
#define	SL_WFX_FMAC_MAC_ADDR_SIZE SL_WFX_MAC_ADDR_SIZE
	Length of the MAC address element.

#define	SL_WFX_FMAC_BSSID_SIZE SL_WFX_BSSID_SIZE
	Length of the BSSID element.

#define	SL_WFX_PASSWORD_SIZE 64
	Length of the password element.

#define	SL_WFX_CHANNEL_NUMBER_SIZE 14
	Maximum length of the channel list element.

#define	SL_WFX_SSID_DEF_SIZE 2
	Maximum length of the SSID list element.

#define	SL_WFX_FMAC_SSID_SIZE SL_WFX_SSID_SIZE
	Length of the Service Set Identifier (SSID) element.

#define	SL_WFX_ARP_IP_ADDR_SIZE 2
	Length of the ARP IP address list element.

#define	SL_WFX_NS_IP_ADDR_SIZE 2
	Length of the NS IP address list element.

#define	SL_WFX_IPV6_ADDR_SIZE 16
	Length of the IPv6 address element.

Enumerations
enum	sl_wfx_client_isolation_t { WFM_CLIENT_ISOLATION_DISABLED = 0x0, WFM_CLIENT_ISOLATION_ENABLED = 0x1 }
	Client Isolation toggling.

enum	sl_wfx_frame_type_t { WFM_FRAME_TYPE_MGMT = 0x0, WFM_FRAME_TYPE_ACTION = 0x4, WFM_FRAME_TYPE_DATA = 0x8 }
	Type of frame to be sent.

enum	sl_wfx_hidden_ssid_t { WFM_HIDDEN_SSID_FALSE = 0x0, WFM_HIDDEN_SSID_TRUE = 0x1 }
	Hidden SSID toggling.

enum	sl_wfx_mgmt_frame_protection_t { WFM_MGMT_FRAME_PROTECTION_DISABLED = 0x0, WFM_MGMT_FRAME_PROTECTION_OPTIONAL = 0x1, WFM_MGMT_FRAME_PROTECTION_MANDATORY = 0x2 }
	Device Protected Management Frame mode.

enum	sl_wfx_pm_mode_t { WFM_PM_MODE_ACTIVE = 0x0, WFM_PM_MODE_PS = 0x1, WFM_PM_MODE_DTIM = 0x2 }
	Device power management mode.

enum	sl_wfx_priority_t { WFM_PRIORITY_BE0 = 0x0, WFM_PRIORITY_BK1 = 0x1, WFM_PRIORITY_BK2 = 0x2, WFM_PRIORITY_BE3 = 0x3, WFM_PRIORITY_VI4 = 0x4, WFM_PRIORITY_VI5 = 0x5, WFM_PRIORITY_VO6 = 0x6, WFM_PRIORITY_VO7 = 0x7 }
	Data priority level per 802.1D.

enum	sl_wfx_reason_t { WFM_REASON_UNSPECIFIED = 0x0, WFM_REASON_TIMEOUT = 0x1, WFM_REASON_LEAVING_BSS = 0x2, WFM_REASON_UNKNOWN_STA = 0x3, WFM_REASON_AP_FULL = 0x4, WFM_REASON_AUTHENTICATION_FAILURE = 0x5 }
	Reasons for AP to reject or disconnect a client.

enum	sl_wfx_disconnected_reason_t { WFM_DISCONNECTED_REASON_UNSPECIFIED = 0x0, WFM_DISCONNECTED_REASON_AP_LOST = 0x1, WFM_DISCONNECTED_REASON_REJECTED = 0x2, WFM_DISCONNECTED_REASON_LEAVING_BSS = 0x3, WFM_DISCONNECTED_REASON_WPA_COUNTERMEASURES = 0x4 }
	Reasons for STA disconnection.

enum	sl_wfx_scan_mode_t { WFM_SCAN_MODE_PASSIVE = 0x0, WFM_SCAN_MODE_ACTIVE = 0x1 }
	Scan mode to be used.

enum	sl_wfx_security_mode_t { WFM_SECURITY_MODE_OPEN = 0x0, WFM_SECURITY_MODE_WEP = 0x1, WFM_SECURITY_MODE_WPA2_WPA1_PSK = 0x2, WFM_SECURITY_MODE_WPA2_PSK = 0x4 }
	Security mode of a network.

enum	sl_wfx_fmac_status_t { WFM_STATUS_SUCCESS = 0x0, WFM_STATUS_INVALID_PARAMETER = 0x1, WFM_STATUS_WRONG_STATE = 0x2, WFM_STATUS_GENERAL_FAILURE = 0x3, WFM_STATUS_CHANNEL_NOT_ALLOWED = 0x4, WFM_STATUS_WARNING = 0x5, WFM_STATUS_NO_MATCHING_AP = 0x6, WFM_STATUS_CONNECTION_ABORTED = 0x7, WFM_STATUS_CONNECTION_TIMEOUT = 0x8, WFM_STATUS_CONNECTION_REJECTED_BY_AP = 0x9, WFM_STATUS_CONNECTION_AUTH_FAILURE = 0xA, WFM_STATUS_RETRY_EXCEEDED = 0x13, WFM_STATUS_TX_LIFETIME_EXCEEDED = 0x14 }
	Full MAC (UMAC) confirmation possible values for a returned 'status' field.

Detailed Description

WFM API constant values.

Macro Definition Documentation

◆ SL_WFX_ARP_IP_ADDR_SIZE

#define SL_WFX_ARP_IP_ADDR_SIZE 2

Length of the ARP IP address list element.

Definition at line 217 of file sl_wfx_cmd_api.h .

◆ SL_WFX_CHANNEL_NUMBER_SIZE

#define SL_WFX_CHANNEL_NUMBER_SIZE 14

Maximum length of the channel list element.

Definition at line 211 of file sl_wfx_cmd_api.h .

◆ SL_WFX_FMAC_BSSID_SIZE

#define SL_WFX_FMAC_BSSID_SIZE SL_WFX_BSSID_SIZE

Length of the BSSID element.

Definition at line 207 of file sl_wfx_cmd_api.h .

◆ SL_WFX_FMAC_MAC_ADDR_SIZE

#define SL_WFX_FMAC_MAC_ADDR_SIZE SL_WFX_MAC_ADDR_SIZE

Length of the MAC address element.

Definition at line 205 of file sl_wfx_cmd_api.h .

◆ SL_WFX_FMAC_SSID_SIZE

#define SL_WFX_FMAC_SSID_SIZE SL_WFX_SSID_SIZE

Length of the Service Set Identifier (SSID) element.

Definition at line 215 of file sl_wfx_cmd_api.h .

◆ SL_WFX_IPV6_ADDR_SIZE

#define SL_WFX_IPV6_ADDR_SIZE 16

Length of the IPv6 address element.

Definition at line 221 of file sl_wfx_cmd_api.h .

◆ SL_WFX_NS_IP_ADDR_SIZE

#define SL_WFX_NS_IP_ADDR_SIZE 2

Length of the NS IP address list element.

Definition at line 219 of file sl_wfx_cmd_api.h .

◆ SL_WFX_PASSWORD_SIZE

#define SL_WFX_PASSWORD_SIZE 64

Length of the password element.

Definition at line 209 of file sl_wfx_cmd_api.h .

◆ SL_WFX_SSID_DEF_SIZE

#define SL_WFX_SSID_DEF_SIZE 2

Maximum length of the SSID list element.

Definition at line 213 of file sl_wfx_cmd_api.h .

Enumeration Type Documentation

◆ sl_wfx_client_isolation_t

enum sl_wfx_client_isolation_t

Client Isolation toggling.

Enumerator
WFM_CLIENT_ISOLATION_DISABLED	Client isolation disabled.
WFM_CLIENT_ISOLATION_ENABLED	Client isolation enabled.

Definition at line 226 of file sl_wfx_cmd_api.h .

◆ sl_wfx_disconnected_reason_t

enum sl_wfx_disconnected_reason_t

Reasons for STA disconnection.

Enumerator
WFM_DISCONNECTED_REASON_UNSPECIFIED	Unspecified reason.
WFM_DISCONNECTED_REASON_AP_LOST	AP timed out.
WFM_DISCONNECTED_REASON_REJECTED	Disconnected by AP.
WFM_DISCONNECTED_REASON_LEAVING_BSS	Leaving intentionally.
WFM_DISCONNECTED_REASON_WPA_COUNTERMEASURES	WPA countermeasures triggered a disconnection.

Definition at line 298 of file sl_wfx_cmd_api.h .

◆ sl_wfx_fmac_status_t

enum sl_wfx_fmac_status_t

Full MAC (UMAC) confirmation possible values for a returned 'status' field.

All Full MAC (UMAC) confirmation messages have a field 'status' just after the message header.
A value of zero indicates the request has completed successfully.

Enumerator
WFM_STATUS_SUCCESS	The device has successfully completed a request.
WFM_STATUS_INVALID_PARAMETER	A request contains one or more invalid parameters.
WFM_STATUS_WRONG_STATE	The request cannot be performed because the device is in an inappropriate state.
WFM_STATUS_GENERAL_FAILURE	The request failed due to an error.
WFM_STATUS_CHANNEL_NOT_ALLOWED	The request failed due to regulatory limitations.
WFM_STATUS_WARNING	The request is successful but some parameters have been ignored.
WFM_STATUS_NO_MATCHING_AP	The request failed because no suitable AP was found for the connection.
WFM_STATUS_CONNECTION_ABORTED	The request failed because the user issued a WFM_HI_DISCONNECT_REQ before completing the connection.
WFM_STATUS_CONNECTION_TIMEOUT	The request failed because a timeout occurred during connection.
WFM_STATUS_CONNECTION_REJECTED_BY_AP	The request failed because the AP rejected the connection.
WFM_STATUS_CONNECTION_AUTH_FAILURE	The request failed because the WPA handshake did not complete successfully.
WFM_STATUS_RETRY_EXCEEDED	The request failed because the retry limit was exceeded.
WFM_STATUS_TX_LIFETIME_EXCEEDED	The request failed because the MSDU life time was exceeded.

Definition at line 330 of file sl_wfx_cmd_api.h .

◆ sl_wfx_frame_type_t

enum sl_wfx_frame_type_t

Type of frame to be sent.

Value unused, all frames are considered to be Data by default.
Support for the other types will be added later.

Enumerator
WFM_FRAME_TYPE_MGMT	Management Frame.
WFM_FRAME_TYPE_ACTION	Action Frame.
WFM_FRAME_TYPE_DATA	Data Frame.

Definition at line 237 of file sl_wfx_cmd_api.h .

◆ sl_wfx_hidden_ssid_t

enum sl_wfx_hidden_ssid_t

Hidden SSID toggling.

Enumerator
WFM_HIDDEN_SSID_FALSE	SSID not hidden.
WFM_HIDDEN_SSID_TRUE	SSID hidden.

Definition at line 246 of file sl_wfx_cmd_api.h .

◆ sl_wfx_mgmt_frame_protection_t

enum sl_wfx_mgmt_frame_protection_t

Device Protected Management Frame mode.

Enumerator
WFM_MGMT_FRAME_PROTECTION_DISABLED	PMF disabled.
WFM_MGMT_FRAME_PROTECTION_OPTIONAL	PMF optional.
WFM_MGMT_FRAME_PROTECTION_MANDATORY	PMF mandatory.

Definition at line 254 of file sl_wfx_cmd_api.h .

◆ sl_wfx_pm_mode_t

enum sl_wfx_pm_mode_t

Device power management mode.

Enumerator
WFM_PM_MODE_ACTIVE	Always on.
WFM_PM_MODE_PS	Use power_save and wake up on beacons.
WFM_PM_MODE_DTIM	Use power_save and wake up on DTIM.

Definition at line 263 of file sl_wfx_cmd_api.h .

◆ sl_wfx_priority_t

enum sl_wfx_priority_t

Data priority level per 802.1D.

Enumerator
WFM_PRIORITY_BE0	Best Effort.
WFM_PRIORITY_BK1	Background.
WFM_PRIORITY_BK2	Background.
WFM_PRIORITY_BE3	Best Effort.
WFM_PRIORITY_VI4	Video.
WFM_PRIORITY_VI5	Video.
WFM_PRIORITY_VO6	Voice.
WFM_PRIORITY_VO7	Voice.

Definition at line 272 of file sl_wfx_cmd_api.h .

◆ sl_wfx_reason_t

enum sl_wfx_reason_t

Reasons for AP to reject or disconnect a client.

Enumerator
WFM_REASON_UNSPECIFIED	Unspecified reason (unused)
WFM_REASON_TIMEOUT	Client timed out.
WFM_REASON_LEAVING_BSS	Client left.
WFM_REASON_UNKNOWN_STA	Client not authenticated.
WFM_REASON_AP_FULL	Too many clients already connected.
WFM_REASON_AUTHENTICATION_FAILURE	WPA authentication failed.

Definition at line 286 of file sl_wfx_cmd_api.h .

◆ sl_wfx_scan_mode_t

enum sl_wfx_scan_mode_t

Scan mode to be used.

Enumerator
WFM_SCAN_MODE_PASSIVE	Passive scan: listen for beacons only.
WFM_SCAN_MODE_ACTIVE	Active scan: send probe requests.

Definition at line 309 of file sl_wfx_cmd_api.h .

◆ sl_wfx_security_mode_t

enum sl_wfx_security_mode_t

Security mode of a network.

Enumerator
WFM_SECURITY_MODE_OPEN	No security.
WFM_SECURITY_MODE_WEP	Use WEP.
WFM_SECURITY_MODE_WPA2_WPA1_PSK	Use WPA1 or WPA2.
WFM_SECURITY_MODE_WPA2_PSK	Use only WPA2.

Definition at line 317 of file sl_wfx_cmd_api.h .

API constant valuesFULL_MAC_API

Macros

Enumerations