5.11.0.0R3
Software Development Kit
 
Loading...
Searching...
No Matches
wwd_constants.h File Reference

Macros

#define WL_NAN_TTL_UNTIL_CANCEL   0xFFFFFFFF
 
#define WLAN_RESULT_LIST(prefix)
 
#define WWD_RESULT_LIST(prefix)
 

Enumerations

enum  wiced_802_11_band_t { WICED_802_11_BAND_5GHZ = 0 , WICED_802_11_BAND_2_4GHZ = 1 }
 
enum  wiced_antenna_t { WICED_ANTENNA_1 = 0 , WICED_ANTENNA_2 = 1 , WICED_ANTENNA_AUTO = 3 }
 
enum  wiced_auth_status_t { WICED_AUTH_EXT_REQ , WICED_AUTH_EXT_FRAME_RX }
 
enum  wiced_bool_t
 
enum  wiced_bss_type_t {
  WICED_BSS_TYPE_INFRASTRUCTURE = 0 , WICED_BSS_TYPE_ADHOC = 1 , WICED_BSS_TYPE_ANY = 2 , WICED_BSS_TYPE_MESH = 3 ,
  WICED_BSS_TYPE_UNKNOWN = -1
}
 
enum  wiced_custom_ie_action_t { WICED_ADD_CUSTOM_IE , WICED_REMOVE_CUSTOM_IE }
 
enum  wiced_ht_mode_t { WICED_HT_MODE_HT20 = 0 , WICED_HT_MODE_HT40 = 1 , WICED_HT_MODE_HT_MIX = 2 }
 
enum  wiced_ie_packet_flag_t {
  VENDOR_IE_BEACON = 0x1 , VENDOR_IE_PROBE_RESPONSE = 0x2 , VENDOR_IE_ASSOC_RESPONSE = 0x4 , VENDOR_IE_AUTH_RESPONSE = 0x8 ,
  VENDOR_IE_PROBE_REQUEST = 0x10 , VENDOR_IE_ASSOC_REQUEST = 0x20 , VENDOR_IE_CUSTOM = 0x100
}
 
enum  wiced_ip_header_tos_t {
  TOS_VO7 = 7 , TOS_VO = 6 , TOS_VI = 5 , TOS_VI4 = 4 ,
  TOS_BE = 0 , TOS_EE = 3 , TOS_BK = 1 , TOS_LE = 2
}
 
enum  wiced_listen_interval_time_unit_t { WICED_LISTEN_INTERVAL_TIME_UNIT_BEACON , WICED_LISTEN_INTERVAL_TIME_UNIT_DTIM }
 
enum  wiced_packet_filter_mode_t { WICED_PACKET_FILTER_MODE_FORWARD = 1 , WICED_PACKET_FILTER_MODE_DISCARD = 0 }
 
enum  wiced_packet_filter_rule_t { WICED_PACKET_FILTER_RULE_POSITIVE_MATCHING = 0 , WICED_PACKET_FILTER_RULE_NEGATIVE_MATCHING = 1 }
 
enum  wiced_qos_access_category_t { WMM_AC_BE = 0 , WMM_AC_BK = 1 , WMM_AC_VI = 2 , WMM_AC_VO = 3 }
 
enum  wiced_scan_result_flag_t { WICED_SCAN_RESULT_FLAG_RSSI_OFF_CHANNEL = 0x01 , WICED_SCAN_RESULT_FLAG_BEACON = 0x02 , WICED_SCAN_RESULT_FLAG_SAE_H2E = 0x04 }
 
enum  wiced_scan_type_t {
  WICED_SCAN_TYPE_ACTIVE = 0x00 , WICED_SCAN_TYPE_PASSIVE = 0x01 , WICED_SCAN_TYPE_PNO = 0x02 , WICED_SCAN_TYPE_PROHIBITED_CHANNELS = 0x04 ,
  WICED_SCAN_TYPE_NO_BSSID_FILTER = 0x08
}
 
enum  wiced_security_t {
  WICED_SECURITY_OPEN = 0 , WICED_SECURITY_WEP_PSK = WEP_ENABLED , WICED_SECURITY_WEP_SHARED = ( WEP_ENABLED | SHARED_ENABLED ) , WICED_SECURITY_WPA_TKIP_PSK = ( WPA_SECURITY | TKIP_ENABLED ) ,
  WICED_SECURITY_WPA_AES_PSK = ( WPA_SECURITY | AES_ENABLED ) , WICED_SECURITY_WPA_MIXED_PSK = ( WPA_SECURITY | AES_ENABLED | TKIP_ENABLED ) , WICED_SECURITY_WPA2_AES_PSK = ( WPA2_SECURITY | AES_ENABLED ) , WICED_SECURITY_WPA2_TKIP_PSK = ( WPA2_SECURITY | TKIP_ENABLED ) ,
  WICED_SECURITY_WPA2_MIXED_PSK = ( WPA2_SECURITY | AES_ENABLED | TKIP_ENABLED ) , WICED_SECURITY_WPA2_FBT_PSK = ( WPA2_SECURITY | AES_ENABLED | FBT_ENABLED) , WICED_SECURITY_WPA3_SAE = ( WPA3_SECURITY | AES_ENABLED ) , WICED_SECURITY_WPA3_WPA2_PSK = ( WPA3_SECURITY | WPA2_SECURITY | AES_ENABLED ) ,
  WICED_SECURITY_WPA_TKIP_ENT = ( ENTERPRISE_ENABLED | WPA_SECURITY | TKIP_ENABLED ) , WICED_SECURITY_WPA_AES_ENT = ( ENTERPRISE_ENABLED | WPA_SECURITY | AES_ENABLED ) , WICED_SECURITY_WPA_MIXED_ENT = ( ENTERPRISE_ENABLED | WPA_SECURITY | AES_ENABLED | TKIP_ENABLED ) , WICED_SECURITY_WPA2_TKIP_ENT = ( ENTERPRISE_ENABLED | WPA2_SECURITY | TKIP_ENABLED ) ,
  WICED_SECURITY_WPA2_AES_ENT = ( ENTERPRISE_ENABLED | WPA2_SECURITY | AES_ENABLED ) , WICED_SECURITY_WPA2_MIXED_ENT = ( ENTERPRISE_ENABLED | WPA2_SECURITY | AES_ENABLED | TKIP_ENABLED ) , WICED_SECURITY_WPA2_FBT_ENT = ( ENTERPRISE_ENABLED | WPA2_SECURITY | AES_ENABLED | FBT_ENABLED) , WICED_SECURITY_IBSS_OPEN = ( IBSS_ENABLED ) ,
  WICED_SECURITY_WPS_OPEN = ( WPS_ENABLED ) , WICED_SECURITY_WPS_SECURE = ( WPS_ENABLED | AES_ENABLED) , WICED_SECURITY_UNKNOWN = -1 , WICED_SECURITY_FORCE_32_BIT = 0x7fffffff
}
 
enum  wwd_cnt_xtlv_id {
  WL_CNT_XTLV_WLC = 0x100 , WL_CNT_XTLV_WLC_RINIT_RSN = 0x101 , WL_CNT_XTLV_CNTV_LE10_UCODE = 0x200 , WL_CNT_XTLV_LT40_UCODE_V1 = 0x300 ,
  WL_CNT_XTLV_GE40_UCODE_V1 = 0x400 , WL_CNT_XTLV_GE64_UCODEX_V1 = 0x800
}
 
enum  wwd_dot11_reason_code_t { WWD_DOT11_RC_RESERVED = 0 , WWD_DOT11_RC_UNSPECIFIED = 1 }
 
enum  wwd_interface_t {
  WWD_STA_INTERFACE = 0 , WWD_AP_INTERFACE = 1 , WWD_P2P_INTERFACE = 2 , WWD_ETHERNET_INTERFACE = 3 ,
  WWD_INTERFACE_MAX , WWD_INTERFACE_FORCE_32_BIT = 0x7fffffff
}
 
enum  wwd_io_state_t
 
enum  wwd_nan_band_t
 
enum  wwd_result_t
 

Detailed Description

Defines common constants used with WICED

Macro Definition Documentation

◆ WL_NAN_TTL_UNTIL_CANCEL

#define WL_NAN_TTL_UNTIL_CANCEL   0xFFFFFFFF

Special values for time to live (ttl) parameter

◆ WLAN_RESULT_LIST

#define WLAN_RESULT_LIST ( prefix)

Disabled in this build

◆ WWD_RESULT_LIST

#define WWD_RESULT_LIST ( prefix)

CLM blob download failed

Enumeration Type Documentation

◆ wiced_802_11_band_t

Enumeration of 802.11 radio bands

Enumerator
WICED_802_11_BAND_5GHZ 

Denotes 5GHz radio band

WICED_802_11_BAND_2_4GHZ 

Denotes 2.4GHz radio band

◆ wiced_antenna_t

Enumeration of antenna selection options

Enumerator
WICED_ANTENNA_1 

Denotes antenna 1

WICED_ANTENNA_2 

Denotes antenna 2

WICED_ANTENNA_AUTO 

Denotes auto diversity, the best antenna is automatically selected

◆ wiced_auth_status_t

  • * Structure for storing status of auth event
Enumerator
WICED_AUTH_EXT_REQ 

Request authentication received

WICED_AUTH_EXT_FRAME_RX 

Authentication frame received

◆ wiced_bool_t

Boolean values

◆ wiced_bss_type_t

Enumeration of network types

Enumerator
WICED_BSS_TYPE_INFRASTRUCTURE 

Denotes infrastructure network

WICED_BSS_TYPE_ADHOC 

Denotes an 802.11 ad-hoc IBSS network

WICED_BSS_TYPE_ANY 

Denotes either infrastructure or ad-hoc network

WICED_BSS_TYPE_MESH 

Denotes 802.11 mesh network

WICED_BSS_TYPE_UNKNOWN 

May be returned by scan function if BSS type is unknown. Do not pass this to the Join function

◆ wiced_custom_ie_action_t

Enumeration of custom IE management actions

Enumerator
WICED_ADD_CUSTOM_IE 

Add a custom IE

WICED_REMOVE_CUSTOM_IE 

Remove a custom IE

◆ wiced_ht_mode_t

List of HT modes supported

Enumerator
WICED_HT_MODE_HT20 

HT20 mode is set on the band

WICED_HT_MODE_HT40 

HT40 mode is set on the band

WICED_HT_MODE_HT_MIX 

HT20 mode is set for 2.4 band and HT40 is set for 5 GHz band

◆ wiced_ie_packet_flag_t

Enumeration of applicable packet mask bits for custom Information Elements (IEs)

Enumerator
VENDOR_IE_BEACON 

Denotes beacon packet

VENDOR_IE_PROBE_RESPONSE 

Denotes probe response packet

VENDOR_IE_ASSOC_RESPONSE 

Denotes association response packet

VENDOR_IE_AUTH_RESPONSE 

Denotes authentication response packet

VENDOR_IE_PROBE_REQUEST 

Denotes probe request packet

VENDOR_IE_ASSOC_REQUEST 

Denotes association request packet

VENDOR_IE_CUSTOM 

Denotes a custom IE identifier

◆ wiced_ip_header_tos_t

Enumeration of IP header Type of Service (TOS) values, which map to 802.11 QoS traffic classes

Enumerator
TOS_VO7 

0xE0, 111 0 0000 (7) AC_VO tos/dscp values

TOS_VO 

0xD0, 110 0 0000 (6) AC_VO

TOS_VI 

0xA0, 101 0 0000 (5) AC_VI

TOS_VI4 

0x80, 100 0 0000 (4) AC_VI

TOS_BE 

0x00, 000 0 0000 (0) AC_BE

TOS_EE 

0x60, 011 0 0000 (3) AC_BE

TOS_BK 

0x20, 001 0 0000 (1) AC_BK

TOS_LE 

0x40, 010 0 0000 (2) AC_BK

◆ wiced_listen_interval_time_unit_t

Enumeration of listen interval time unit types

Enumerator
WICED_LISTEN_INTERVAL_TIME_UNIT_BEACON 

Time units specified in beacon periods

WICED_LISTEN_INTERVAL_TIME_UNIT_DTIM 

Time units specified in DTIM periods

◆ wiced_packet_filter_mode_t

Enumeration of packet filter modes

Enumerator
WICED_PACKET_FILTER_MODE_FORWARD 

Packet filter engine forwards matching packets, discards non-matching packets

WICED_PACKET_FILTER_MODE_DISCARD 

Packet filter engine discards matching packets, forwards non-matching packets

◆ wiced_packet_filter_rule_t

Enumeration of packet filter rules

Enumerator
WICED_PACKET_FILTER_RULE_POSITIVE_MATCHING 

Specifies that a filter should match a given pattern

WICED_PACKET_FILTER_RULE_NEGATIVE_MATCHING 

Specifies that a filter should NOT match a given pattern

◆ wiced_qos_access_category_t

Enumeration of 802.11 QoS, i.e. WMM, traffic classes

Enumerator
WMM_AC_BE 

Best Effort

WMM_AC_BK 

Background

WMM_AC_VI 

Video

WMM_AC_VO 

Voice

◆ wiced_scan_result_flag_t

Enumeration of scan result flags

Enumerator
WICED_SCAN_RESULT_FLAG_RSSI_OFF_CHANNEL 

RSSI came from an off channel DSSS (1 or 1 Mb) Rx

WICED_SCAN_RESULT_FLAG_BEACON 

Beacon (vs probe response)

◆ wiced_scan_type_t

Enumeration of methods of scanning

Enumerator
WICED_SCAN_TYPE_ACTIVE 

Actively scan a network by sending 802.11 probe(s)

WICED_SCAN_TYPE_PASSIVE 

Passively scan a network by listening for beacons from APs

WICED_SCAN_TYPE_PNO 

Use preferred network offload to detect an AP

WICED_SCAN_TYPE_PROHIBITED_CHANNELS 

Permit (passively) scanning a channel that isn't valid for the current country

WICED_SCAN_TYPE_NO_BSSID_FILTER 

Return a scan record for each beacon or probe response RX'ed

◆ wiced_security_t

Enumeration of Wi-Fi security modes

Enumerator
WICED_SECURITY_OPEN 

Open security

WICED_SECURITY_WEP_PSK 

WEP PSK Security with open authentication

WICED_SECURITY_WEP_SHARED 

WEP PSK Security with shared authentication

WICED_SECURITY_WPA_TKIP_PSK 

WPA PSK Security with TKIP

WICED_SECURITY_WPA_AES_PSK 

WPA PSK Security with AES

WICED_SECURITY_WPA_MIXED_PSK 

WPA PSK Security with AES & TKIP

WICED_SECURITY_WPA2_AES_PSK 

WPA2 PSK Security with AES

WICED_SECURITY_WPA2_TKIP_PSK 

WPA2 PSK Security with TKIP

WICED_SECURITY_WPA2_MIXED_PSK 

WPA2 PSK Security with AES & TKIP

WICED_SECURITY_WPA2_FBT_PSK 

WPA2 FBT PSK Security with AES & TKIP

WICED_SECURITY_WPA3_SAE 

WPA3 Security with AES

WICED_SECURITY_WPA3_WPA2_PSK 

WPA3 WPA2 PSK Security with AES

WICED_SECURITY_WPA_TKIP_ENT 

WPA Enterprise Security with TKIP

WICED_SECURITY_WPA_AES_ENT 

WPA Enterprise Security with AES

WICED_SECURITY_WPA_MIXED_ENT 

WPA Enterprise Security with AES & TKIP

WICED_SECURITY_WPA2_TKIP_ENT 

WPA2 Enterprise Security with TKIP

WICED_SECURITY_WPA2_AES_ENT 

WPA2 Enterprise Security with AES

WICED_SECURITY_WPA2_MIXED_ENT 

WPA2 Enterprise Security with AES & TKIP

WICED_SECURITY_IBSS_OPEN 

Open security on IBSS ad-hoc network

WICED_SECURITY_WPS_OPEN 

WPS with open security

WICED_SECURITY_WPS_SECURE 

WPS with AES security

WICED_SECURITY_UNKNOWN 

May be returned by scan function if security is unknown. Do not pass this to the join function!

WICED_SECURITY_FORCE_32_BIT 

Exists only to force wiced_security_t type to 32 bits

◆ wwd_cnt_xtlv_id

Enumerator
WL_CNT_XTLV_WLC 

WLC layer counters

WL_CNT_XTLV_WLC_RINIT_RSN 

WLC layer reinitreason extension

WL_CNT_XTLV_CNTV_LE10_UCODE 

wl counter ver < 11 UCODE MACSTAT

WL_CNT_XTLV_LT40_UCODE_V1 

corerev < 40 UCODE MACSTAT

WL_CNT_XTLV_GE40_UCODE_V1 

corerev >= 40 UCODE MACSTAT

◆ wwd_dot11_reason_code_t

Enumeration of Dot11 Reason Codes

Enumerator
WWD_DOT11_RC_RESERVED 

Reserved

WWD_DOT11_RC_UNSPECIFIED 

Unspecified

◆ wwd_interface_t

Enumeration of WICED interfaces.

Note
The config interface is a virtual interface that shares the softAP interface
Enumerator
WWD_STA_INTERFACE 

STA or Client Interface

WWD_AP_INTERFACE 

softAP Interface

WWD_P2P_INTERFACE 

P2P Interface

WWD_ETHERNET_INTERFACE 

Ethernet Interface

WWD_INTERFACE_FORCE_32_BIT 

DO NOT USE - MUST BE LAST INTERFACE VALUE - used for counting interfaces Exists only to force wwd_interface_t type to 32 bits

◆ wwd_io_state_t

I/O State Values

◆ wwd_nan_band_t

Definitions of different NAN Bands

◆ wwd_result_t

Common result type for WICED functions