API constant valuesFULL_MAC_API

WFM API constant values.

Macros

#define SL_WFX_FMAC_MAC_ADDR_SIZE   SL_WFX_MAC_ADDR_SIZE
 Length of MAC address element.
 
#define SL_WFX_FMAC_BSSID_SIZE   SL_WFX_BSSID_SIZE
 Length of BSSID element.
 
#define SL_WFX_PASSWORD_SIZE   64
 Length of password element.
 
#define SL_WFX_CHANNEL_NUMBER_SIZE   14
 Maximum length of channel list element.
 
#define SL_WFX_SSID_DEF_SIZE   2
 Maximum length of SSID list element.
 
#define SL_WFX_FMAC_SSID_SIZE   SL_WFX_SSID_SIZE
 Length of Service Set Identifier (SSID) element.
 
#define SL_WFX_ARP_IP_ADDR_SIZE   2
 Length of ARP IP address list element.
 
#define SL_WFX_NS_IP_ADDR_SIZE   2
 Length of NS IP address list element.
 
#define SL_WFX_IPV6_ADDR_SIZE   16
 Length of 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 the 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_BE = 0x0,
  WFM_PRIORITY_BK = 0x1,
  WFM_PRIORITY_VI = 0x2,
  WFM_PRIORITY_VO = 0x3
}
 Data priority level.
 
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
}
 Reasons for Ineo AP to reject or disconnect a client.
 
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
}
 Full MAC (UMAC) confirmation possible values for 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 ARP IP address list element.

Definition at line 226 of file wfm_cmd_api.h.

◆ SL_WFX_CHANNEL_NUMBER_SIZE

#define SL_WFX_CHANNEL_NUMBER_SIZE   14

Maximum length of channel list element.

Definition at line 220 of file wfm_cmd_api.h.

◆ SL_WFX_FMAC_BSSID_SIZE

#define SL_WFX_FMAC_BSSID_SIZE   SL_WFX_BSSID_SIZE

Length of BSSID element.

Definition at line 216 of file wfm_cmd_api.h.

◆ SL_WFX_FMAC_MAC_ADDR_SIZE

#define SL_WFX_FMAC_MAC_ADDR_SIZE   SL_WFX_MAC_ADDR_SIZE

Length of MAC address element.

Definition at line 214 of file wfm_cmd_api.h.

◆ SL_WFX_FMAC_SSID_SIZE

#define SL_WFX_FMAC_SSID_SIZE   SL_WFX_SSID_SIZE

Length of Service Set Identifier (SSID) element.

Definition at line 224 of file wfm_cmd_api.h.

◆ SL_WFX_IPV6_ADDR_SIZE

#define SL_WFX_IPV6_ADDR_SIZE   16

Length of IPv6 address element.

Definition at line 230 of file wfm_cmd_api.h.

◆ SL_WFX_NS_IP_ADDR_SIZE

#define SL_WFX_NS_IP_ADDR_SIZE   2

Length of NS IP address list element.

Definition at line 228 of file wfm_cmd_api.h.

◆ SL_WFX_PASSWORD_SIZE

#define SL_WFX_PASSWORD_SIZE   64

Length of password element.

Definition at line 218 of file wfm_cmd_api.h.

◆ SL_WFX_SSID_DEF_SIZE

#define SL_WFX_SSID_DEF_SIZE   2

Maximum length of SSID list element.

Definition at line 222 of file wfm_cmd_api.h.

Enumeration Type Documentation

◆ 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 235 of file wfm_cmd_api.h.

◆ sl_wfx_fmac_status_t

Full MAC (UMAC) confirmation possible values for 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.

Definition at line 323 of file wfm_cmd_api.h.

◆ sl_wfx_frame_type_t

Type of the 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 246 of file wfm_cmd_api.h.

◆ 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 255 of file wfm_cmd_api.h.

◆ 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 263 of file wfm_cmd_api.h.

◆ 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 272 of file wfm_cmd_api.h.

◆ sl_wfx_priority_t

Data priority level.

Enumerator
WFM_PRIORITY_BE 

Best Effort.

WFM_PRIORITY_BK 

Background.

WFM_PRIORITY_VI 

Video.

WFM_PRIORITY_VO 

Voice.

Definition at line 281 of file wfm_cmd_api.h.

◆ sl_wfx_reason_t

Reasons for Ineo 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.

Definition at line 291 of file wfm_cmd_api.h.

◆ 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 302 of file wfm_cmd_api.h.

◆ 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 310 of file wfm_cmd_api.h.