API constant valuesFULL_MAC_API

WFM API constant values.

Macros

#define WFM_API_MAC_ADDR_SIZE   API_MAC_ADDR_SIZE
 Length of MAC address element.
 
#define WFM_API_BSSID_SIZE   6
 Length of BSSID element.
 
#define WFM_API_PASSWORD_SIZE   64
 Length of password element.
 
#define WFM_API_MAC_SIZE   6
 Length of MAC address element.
 
#define WFM_API_CHANNEL_NUMBER_SIZE   14
 Maximum length of channel list element.
 
#define WFM_API_SSID_DEF_SIZE   2
 Maximum length of SSID list element.
 
#define WFM_API_SSID_SIZE   32
 Length of Service Set Identifier (SSID) element.
 
#define WFM_API_ARP_IP_ADDR_SIZE   2
 Length of ARP IP address list element.
 
#define WFM_API_NS_IP_ADDR_SIZE   2
 Length of NS IP address list element.
 
#define WFM_API_IPV6_ADDR_SIZE   16
 Length of IPv6 address element.

Enumerations

enum  WfmClientIsolation {
  WFM_CLIENT_ISOLATION_DISABLED = 0x0,
  WFM_CLIENT_ISOLATION_ENABLED = 0x1
}
 Client Isolation toggling.
 
enum  WfmFrameType {
  WFM_FRAME_TYPE_MGMT = 0x0,
  WFM_FRAME_TYPE_ACTION = 0x4,
  WFM_FRAME_TYPE_DATA = 0x8
}
 Type of the frame to be sent.
 
enum  WfmHiddenSsid {
  WFM_HIDDEN_SSID_FALSE = 0x0,
  WFM_HIDDEN_SSID_TRUE = 0x1
}
 Hidden SSID toggling.
 
enum  WfmMaxPhyRate {
  WFM_MAX_PHY_RATE_B_1MBPS = 0x0,
  WFM_MAX_PHY_RATE_B_2MBPS = 0x1,
  WFM_MAX_PHY_RATE_B_5P5MBPS = 0x2,
  WFM_MAX_PHY_RATE_B_11MBPS = 0x3,
  WFM_MAX_PHY_RATE_G_6MBPS = 0x6,
  WFM_MAX_PHY_RATE_G_12MBPS = 0x7,
  WFM_MAX_PHY_RATE_G_18MBPS = 0x8,
  WFM_MAX_PHY_RATE_G_24MBPS = 0x9,
  WFM_MAX_PHY_RATE_G_36MBPS = 0xa,
  WFM_MAX_PHY_RATE_G_42MBPS = 0xb,
  WFM_MAX_PHY_RATE_G_48MBPS = 0xc,
  WFM_MAX_PHY_RATE_G_54MBPS = 0xd,
  WFM_MAX_PHY_RATE_N_6P5MBPS = 0xe,
  WFM_MAX_PHY_RATE_N_13MBPS = 0xf,
  WFM_MAX_PHY_RATE_N_19P5MBPS = 0x10,
  WFM_MAX_PHY_RATE_N_26MBPS = 0x11,
  WFM_MAX_PHY_RATE_N_39MBPS = 0x12,
  WFM_MAX_PHY_RATE_N_52MBPS = 0x13,
  WFM_MAX_PHY_RATE_N_58P5MBPS = 0x14,
  WFM_MAX_PHY_RATE_N_65MBPS = 0x15
}
 Maximum data rate used by an AP.
 
enum  WfmMgmtFrameProtection {
  WFM_MGMT_FRAME_PROTECTION_DISABLED = 0x0,
  WFM_MGMT_FRAME_PROTECTION_OPTIONAL = 0x1,
  WFM_MGMT_FRAME_PROTECTION_MANDATORY = 0x2
}
 Device Protected Management Frame mode.
 
enum  WfmPmMode {
  WFM_PM_MODE_ACTIVE = 0x0,
  WFM_PM_MODE_PS = 0x1,
  WFM_PM_MODE_DTIM = 0x2
}
 Device power management mode.
 
enum  WfmPriority {
  WFM_PRIORITY_BE = 0x0,
  WFM_PRIORITY_BK = 0x1,
  WFM_PRIORITY_VI = 0x2,
  WFM_PRIORITY_VO = 0x3
}
 Data priority level.
 
enum  WfmReason {
  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  WfmScanMode {
  WFM_SCAN_MODE_PASSIVE = 0x0,
  WFM_SCAN_MODE_ACTIVE = 0x1
}
 Scan mode to be used.
 
enum  WfmSecurityMode {
  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  WfmStatus {
  WFM_STATUS_SUCCESS = 0x0,
  WFM_STATUS_INVALID_PARAMETER = 0x1,
  WFM_STATUS_WRONG_STATE = 0x2,
  WFM_STATUS_GENERAL_FAILURE = 0x3
}
 Full MAC (UMAC) confirmation possible values for returned 'Status' field.

Detailed Description

WFM API constant values.

Macro Definition Documentation

◆ WFM_API_ARP_IP_ADDR_SIZE

#define WFM_API_ARP_IP_ADDR_SIZE   2

Length of ARP IP address list element.

Definition at line 143 of file wfm_cmd_api.h.

◆ WFM_API_BSSID_SIZE

#define WFM_API_BSSID_SIZE   6

Length of BSSID element.

Definition at line 131 of file wfm_cmd_api.h.

◆ WFM_API_CHANNEL_NUMBER_SIZE

#define WFM_API_CHANNEL_NUMBER_SIZE   14

Maximum length of channel list element.

Definition at line 137 of file wfm_cmd_api.h.

◆ WFM_API_IPV6_ADDR_SIZE

#define WFM_API_IPV6_ADDR_SIZE   16

Length of IPv6 address element.

Definition at line 147 of file wfm_cmd_api.h.

◆ WFM_API_MAC_ADDR_SIZE

#define WFM_API_MAC_ADDR_SIZE   API_MAC_ADDR_SIZE

Length of MAC address element.

Definition at line 129 of file wfm_cmd_api.h.

◆ WFM_API_MAC_SIZE

#define WFM_API_MAC_SIZE   6

Length of MAC address element.

Definition at line 135 of file wfm_cmd_api.h.

◆ WFM_API_NS_IP_ADDR_SIZE

#define WFM_API_NS_IP_ADDR_SIZE   2

Length of NS IP address list element.

Definition at line 145 of file wfm_cmd_api.h.

◆ WFM_API_PASSWORD_SIZE

#define WFM_API_PASSWORD_SIZE   64

Length of password element.

Definition at line 133 of file wfm_cmd_api.h.

Referenced by wf200_start_ap_command().

◆ WFM_API_SSID_DEF_SIZE

#define WFM_API_SSID_DEF_SIZE   2

Maximum length of SSID list element.

Definition at line 139 of file wfm_cmd_api.h.

◆ WFM_API_SSID_SIZE

#define WFM_API_SSID_SIZE   32

Length of Service Set Identifier (SSID) element.

Definition at line 141 of file wfm_cmd_api.h.

Enumeration Type Documentation

◆ WfmClientIsolation

Client Isolation toggling.

Enumerator
WFM_CLIENT_ISOLATION_DISABLED 

Client isolation disabled.

WFM_CLIENT_ISOLATION_ENABLED 

Client isolation enabled.

Definition at line 152 of file wfm_cmd_api.h.

◆ WfmFrameType

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

◆ WfmHiddenSsid

Hidden SSID toggling.

Enumerator
WFM_HIDDEN_SSID_FALSE 

SSID not hidden.

WFM_HIDDEN_SSID_TRUE 

SSID hidden.

Definition at line 172 of file wfm_cmd_api.h.

◆ WfmMaxPhyRate

Maximum data rate used by an AP.

Enumerator
WFM_MAX_PHY_RATE_B_1MBPS 

Data rate 802.11b 1Mbps.

WFM_MAX_PHY_RATE_B_2MBPS 

Data rate 802.11b 2Mbps.

WFM_MAX_PHY_RATE_B_5P5MBPS 

Data rate 802.11b 5.5Mbps.

WFM_MAX_PHY_RATE_B_11MBPS 

Data rate 802.11b 11Mbps.

WFM_MAX_PHY_RATE_G_6MBPS 

Data rate 802.11g 6Mbps.

WFM_MAX_PHY_RATE_G_12MBPS 

Data rate 802.11g 12Mbps.

WFM_MAX_PHY_RATE_G_18MBPS 

Data rate 802.11g 18Mbps.

WFM_MAX_PHY_RATE_G_24MBPS 

Data rate 802.11g 24Mbps.

WFM_MAX_PHY_RATE_G_36MBPS 

Data rate 802.11g 36Mbps.

WFM_MAX_PHY_RATE_G_42MBPS 

Data rate 802.11g 42Mbps.

WFM_MAX_PHY_RATE_G_48MBPS 

Data rate 802.11g 48Mbps.

WFM_MAX_PHY_RATE_G_54MBPS 

Data rate 802.11g 54Mbps.

WFM_MAX_PHY_RATE_N_6P5MBPS 

Data rate 802.11n 6.5Mbps.

WFM_MAX_PHY_RATE_N_13MBPS 

Data rate 802.11n 13Mbps.

WFM_MAX_PHY_RATE_N_19P5MBPS 

Data rate 802.11n 19.5Mbps.

WFM_MAX_PHY_RATE_N_26MBPS 

Data rate 802.11n 26Mbps.

WFM_MAX_PHY_RATE_N_39MBPS 

Data rate 802.11n 39Mbps.

WFM_MAX_PHY_RATE_N_52MBPS 

Data rate 802.11n 52Mbps.

WFM_MAX_PHY_RATE_N_58P5MBPS 

Data rate 802.11n 58.5Mbps.

WFM_MAX_PHY_RATE_N_65MBPS 

Data rate 802.11n 65Mbps.

Definition at line 180 of file wfm_cmd_api.h.

◆ WfmMgmtFrameProtection

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

◆ WfmPmMode

enum WfmPmMode

Device power management mode.

Enumerator
WFM_PM_MODE_ACTIVE 

Always on.

WFM_PM_MODE_PS 

Use PowerSave and wake up on beacons.

WFM_PM_MODE_DTIM 

Use PowerSave and wake up on DTIM.

Definition at line 215 of file wfm_cmd_api.h.

◆ WfmPriority

Data priority level.

Enumerator
WFM_PRIORITY_BE 

Best Effort.

WFM_PRIORITY_BK 

Background.

WFM_PRIORITY_VI 

Video.

WFM_PRIORITY_VO 

Voice.

Definition at line 224 of file wfm_cmd_api.h.

◆ WfmReason

enum WfmReason

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

◆ WfmScanMode

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

◆ WfmSecurityMode

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

◆ WfmStatus

enum WfmStatus

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 firmware 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.

Definition at line 266 of file wfm_cmd_api.h.