Enumerated types

General Description

Enumerations
enum	cy_wcm_ip_version_t {   CY_WCM_IP_VER_V4 = 4 ,   CY_WCM_IP_VER_V6 = 6 }
	IP Version. More...
enum	cy_wcm_ipv6_type_t {   CY_WCM_IPV6_LINK_LOCAL = 0 ,   CY_WCM_IPV6_GLOBAL }
	IPV6 types. More...
enum	cy_wcm_security_t {   CY_WCM_SECURITY_OPEN = 0 ,   CY_WCM_SECURITY_WEP_PSK = WEP_ENABLED ,   CY_WCM_SECURITY_WEP_SHARED = ( WEP_ENABLED | SHARED_ENABLED ) ,   CY_WCM_SECURITY_WPA_TKIP_PSK = ( WPA_SECURITY | TKIP_ENABLED ) ,   CY_WCM_SECURITY_WPA_AES_PSK = ( WPA_SECURITY | AES_ENABLED ) ,   CY_WCM_SECURITY_WPA_MIXED_PSK = ( WPA_SECURITY | AES_ENABLED | TKIP_ENABLED ) ,   CY_WCM_SECURITY_WPA2_AES_PSK = ( WPA2_SECURITY | AES_ENABLED ) ,   CY_WCM_SECURITY_WPA2_AES_PSK_SHA256 = ( WPA2_SECURITY | WPA2_SHA256_SECURITY | AES_ENABLED ) ,   CY_WCM_SECURITY_WPA2_TKIP_PSK = ( WPA2_SECURITY | TKIP_ENABLED ) ,   CY_WCM_SECURITY_WPA2_MIXED_PSK = ( WPA2_SECURITY | AES_ENABLED | TKIP_ENABLED ) ,   CY_WCM_SECURITY_WPA2_FBT_PSK = ( WPA2_SECURITY | AES_ENABLED | FBT_ENABLED) ,   CY_WCM_SECURITY_WPA3_SAE = ( WPA3_SECURITY | AES_ENABLED ) ,   CY_WCM_SECURITY_WPA2_WPA_AES_PSK = (WPA2_SECURITY | WPA_SECURITY | AES_ENABLED) ,   CY_WCM_SECURITY_WPA2_WPA_MIXED_PSK = (WPA2_SECURITY | WPA_SECURITY | AES_ENABLED | TKIP_ENABLED) ,   CY_WCM_SECURITY_WPA3_WPA2_PSK = ( WPA3_SECURITY | WPA2_SECURITY | AES_ENABLED ) ,   CY_WCM_SECURITY_WPA_TKIP_ENT = (ENTERPRISE_ENABLED | WPA_SECURITY | TKIP_ENABLED) ,   CY_WCM_SECURITY_WPA_AES_ENT = (ENTERPRISE_ENABLED | WPA_SECURITY | AES_ENABLED) ,   CY_WCM_SECURITY_WPA_MIXED_ENT = (ENTERPRISE_ENABLED | WPA_SECURITY | AES_ENABLED | TKIP_ENABLED) ,   CY_WCM_SECURITY_WPA2_TKIP_ENT = (ENTERPRISE_ENABLED | WPA2_SECURITY | TKIP_ENABLED) ,   CY_WCM_SECURITY_WPA2_AES_ENT = (ENTERPRISE_ENABLED | WPA2_SECURITY | AES_ENABLED) ,   CY_WCM_SECURITY_WPA2_MIXED_ENT = (ENTERPRISE_ENABLED | WPA2_SECURITY | AES_ENABLED | TKIP_ENABLED) ,   CY_WCM_SECURITY_WPA2_FBT_ENT = (ENTERPRISE_ENABLED | WPA2_SECURITY | AES_ENABLED | FBT_ENABLED) ,   CY_WCM_SECURITY_IBSS_OPEN = ( IBSS_ENABLED ) ,   CY_WCM_SECURITY_WPS_SECURE = ( WPS_ENABLED | AES_ENABLED) ,   CY_WCM_SECURITY_UNKNOWN = -1 ,   CY_WCM_SECURITY_FORCE_32_BIT = 0x7fffffff }
	Enumeration of Wi-Fi Security Modes. More...
enum	cy_wcm_wifi_band_t {   CY_WCM_WIFI_BAND_ANY = 0 ,   CY_WCM_WIFI_BAND_5GHZ ,   CY_WCM_WIFI_BAND_2_4GHZ }
	Enumeration of 802.11 radio bands. More...
enum	cy_wcm_scan_rssi_range_t {   CY_WCM_SCAN_RSSI_FAIR = -90 ,   CY_WCM_SCAN_RSSI_GOOD = -60 ,   CY_WCM_SCAN_RSSI_EXCELLENT = -40 }
	Enumeration of RSSI range. More...
enum	cy_wcm_interface_t {   CY_WCM_INTERFACE_TYPE_STA = 0 ,   CY_WCM_INTERFACE_TYPE_AP ,   CY_WCM_INTERFACE_TYPE_AP_STA }
	Enumeration of WCM interfaces types. More...
enum	cy_wcm_powersave_mode_t {   CY_WCM_NO_POWERSAVE_MODE = NO_POWERSAVE_MODE ,   CY_WCM_PM1_POWERSAVE_MODE = PM1_POWERSAVE_MODE ,   CY_WCM_PM2_POWERSAVE_MODE = PM2_POWERSAVE_MODE }
	Enumeration of WCM Powersave Modes. More...
enum	cy_wcm_scan_status_t {   CY_WCM_SCAN_INCOMPLETE ,   CY_WCM_SCAN_COMPLETE }
	Enumeration of scan status. More...
enum	cy_wcm_wps_mode_t {   CY_WCM_WPS_PBC_MODE ,   CY_WCM_WPS_PIN_MODE }
	Enumeration of WPS connection modes. More...
enum	cy_wcm_wps_configuration_method_t {   CY_WCM_WPS_CONFIG_USBA = 0x0001 ,   CY_WCM_WPS_CONFIG_ETHERNET = 0x0002 ,   CY_WCM_WPS_CONFIG_LABEL = 0x0004 ,   CY_WCM_WPS_CONFIG_DISPLAY = 0x0008 ,   CY_WCM_WPS_CONFIG_EXTERNAL_NFC_TOKEN = 0x0010 ,   CY_WCM_WPS_CONFIG_INTEGRATED_NFC_TOKEN = 0x0020 ,   CY_WCM_WPS_CONFIG_NFC_INTERFACE = 0x0040 ,   CY_WCM_WPS_CONFIG_PUSH_BUTTON = 0x0080 ,   CY_WCM_WPS_CONFIG_KEYPAD = 0x0100 ,   CY_WCM_WPS_CONFIG_VIRTUAL_PUSH_BUTTON = 0x0280 ,   CY_WCM_WPS_CONFIG_PHYSICAL_PUSH_BUTTON = 0x0480 ,   CY_WCM_WPS_CONFIG_VIRTUAL_DISPLAY_PIN = 0x2008 ,   CY_WCM_WPS_CONFIG_PHYSICAL_DISPLAY_PIN = 0x4008 }
	Enumeration of WPS configuration method. More...
enum	cy_wcm_wps_authentication_type_t {   CY_WCM_WPS_OPEN_AUTHENTICATION = 0x0001 ,   CY_WCM_WPS_WPA_PSK_AUTHENTICATION = 0x0002 ,   CY_WCM_WPS_SHARED_AUTHENTICATION = 0x0004 ,   CY_WCM_WPS_WPA_ENTERPRISE_AUTHENTICATION = 0x0008 ,   CY_WCM_WPS_WPA2_ENTERPRISE_AUTHENTICATION = 0x0010 ,   CY_WCM_WPS_WPA2_PSK_AUTHENTICATION = 0x0020 ,   CY_WCM_WPS_WPA2_WPA_PSK_MIXED_AUTHENTICATION = 0x0022 }
	Enumeration of WPS authentication types. More...
enum	cy_wcm_wps_encryption_type_t {   CY_WCM_WPS_MIXED_ENCRYPTION = 0x000c ,   CY_WCM_WPS_AES_ENCRYPTION = 0x0008 ,   CY_WCM_WPS_TKIP_ENCRYPTION = 0x0004 ,   CY_WCM_WPS_WEP_ENCRYPTION = 0x0002 ,   CY_WCM_WPS_NO_ENCRYPTION = 0x0001 ,   CY_WCM_WPS_NO_UNDEFINED = 0x0000 }
	Enumeration of WPS encryption type. More...
enum	cy_wcm_wps_device_category_t {   CY_WCM_WPS_DEVICE_COMPUTER = 1 ,   CY_WCM_WPS_DEVICE_INPUT = 2 ,   CY_WCM_WPS_DEVICE_PRINT_SCAN_FAX_COPY = 3 ,   CY_WCM_WPS_DEVICE_CAMERA = 4 ,   CY_WCM_WPS_DEVICE_STORAGE = 5 ,   CY_WCM_WPS_DEVICE_NETWORK_INFRASTRUCTURE = 6 ,   CY_WCM_WPS_DEVICE_DISPLAY = 7 ,   CY_WCM_WPS_DEVICE_MULTIMEDIA = 8 ,   CY_WCM_WPS_DEVICE_GAMING = 9 ,   CY_WCM_WPS_DEVICE_TELEPHONE = 10 ,   CY_WCM_WPS_DEVICE_AUDIO = 11 ,   CY_WCM_WPS_DEVICE_DOCK = 12 ,   CY_WCM_WPS_DEVICE_OTHER = 0xFF }
	Enumeration of WPS device category from the WSC 2.0 spec. More...
enum	cy_wcm_event_t {   CY_WCM_EVENT_CONNECTING = 0 ,   CY_WCM_EVENT_CONNECTED ,   CY_WCM_EVENT_CONNECT_FAILED ,   CY_WCM_EVENT_RECONNECTED ,   CY_WCM_EVENT_DISCONNECTED ,   CY_WCM_EVENT_IP_CHANGED ,   CY_WCM_EVENT_INITIATED_RETRY ,   CY_WCM_EVENT_STA_JOINED_SOFTAP ,   CY_WCM_EVENT_STA_LEFT_SOFTAP }
	Enumeration of WCM events. More...
enum	cy_wcm_scan_filter_type_t {   CY_WCM_SCAN_FILTER_TYPE_SSID = 0 ,   CY_WCM_SCAN_FILTER_TYPE_MAC ,   CY_WCM_SCAN_FILTER_TYPE_BAND ,   CY_WCM_SCAN_FILTER_TYPE_RSSI }
	Enumeration of scan filter types. More...
enum	cy_wcm_bss_type_t {   CY_WCM_BSS_TYPE_INFRASTRUCTURE = 0 ,   CY_WCM_BSS_TYPE_ADHOC = 1 ,   CY_WCM_BSS_TYPE_ANY = 2 ,   CY_WCM_BSS_TYPE_MESH = 3 ,   CY_WCM_BSS_TYPE_UNKNOWN = -1 }
	Enumeration of network types. More...
enum	cy_wcm_ie_mask_t {   CY_WCM_IE_MASK_BEACON = 0x1 ,   CY_WCM_IE_MASK_PROBE_RESPONSE = 0x2 ,   CY_WCM_IE_MASK_ASSOC_RESPONSE = 0x4 ,   CY_WCM_IE_MASK_AUTH_RESPONSE = 0x8 ,   CY_WCM_IE_MASK_PROBE_REQUEST = 0x10 ,   CY_WCM_IE_MASK_ASSOC_REQUEST = 0x20 ,   CY_WCM_IE_MASK_CUSTOM = 0x100 }
	Enumeration of applicable packet mask bits for custom information elements (IEs) More...

Enumeration Type Documentation

cy_wcm_ip_version_t

enum cy_wcm_ip_version_t

IP Version.

Enumerator
CY_WCM_IP_VER_V4	Denotes IPv4 version.
CY_WCM_IP_VER_V6	Denotes IPv6 version.

cy_wcm_ipv6_type_t

enum cy_wcm_ipv6_type_t

IPV6 types.

Enumerator
CY_WCM_IPV6_LINK_LOCAL	Denotes IPv6 link-local address type.
CY_WCM_IPV6_GLOBAL	Denotes IPv6 global address type.

cy_wcm_security_t

enum cy_wcm_security_t

Enumeration of Wi-Fi Security Modes.

Enumerator
CY_WCM_SECURITY_OPEN	Open security.
CY_WCM_SECURITY_WEP_PSK	WEP PSK security with open authentication.
CY_WCM_SECURITY_WEP_SHARED	WEP PSK security with shared authentication.
CY_WCM_SECURITY_WPA_TKIP_PSK	WPA PSK security with TKIP.
CY_WCM_SECURITY_WPA_AES_PSK	WPA PSK security with AES.
CY_WCM_SECURITY_WPA_MIXED_PSK	WPA PSK security with AES and TKIP.
CY_WCM_SECURITY_WPA2_AES_PSK	WPA2 PSK security with AES.
CY_WCM_SECURITY_WPA2_AES_PSK_SHA256	WPA2 PSK SHA256 Security with AES
CY_WCM_SECURITY_WPA2_TKIP_PSK	WPA2 PSK security with TKIP.
CY_WCM_SECURITY_WPA2_MIXED_PSK	WPA2 PSK security with AES and TKIP.
CY_WCM_SECURITY_WPA2_FBT_PSK	WPA2 FBT PSK security with AES and TKIP.
CY_WCM_SECURITY_WPA3_SAE	WPA3 security with AES.
CY_WCM_SECURITY_WPA2_WPA_AES_PSK	WPA2 WPA PSK Security with AES
CY_WCM_SECURITY_WPA2_WPA_MIXED_PSK	WPA2 WPA PSK Security with AES & TKIP.
CY_WCM_SECURITY_WPA3_WPA2_PSK	WPA3 WPA2 PSK security with AES.
CY_WCM_SECURITY_WPA_TKIP_ENT	WPA Enterprise Security with TKIP.
CY_WCM_SECURITY_WPA_AES_ENT	WPA Enterprise Security with AES
CY_WCM_SECURITY_WPA_MIXED_ENT	WPA Enterprise Security with AES and TKIP.
CY_WCM_SECURITY_WPA2_TKIP_ENT	WPA2 Enterprise Security with TKIP.
CY_WCM_SECURITY_WPA2_AES_ENT	WPA2 Enterprise Security with AES.
CY_WCM_SECURITY_WPA2_MIXED_ENT	WPA2 Enterprise Security with AES and TKIP.
CY_WCM_SECURITY_WPA2_FBT_ENT	WPA2 Enterprise Security with AES and FBT.
CY_WCM_SECURITY_IBSS_OPEN	Open security on IBSS ad hoc network.
CY_WCM_SECURITY_WPS_SECURE	WPS with AES security.
CY_WCM_SECURITY_UNKNOWN	Returned by cy_wcm_scan_result_callback_t if security is unknown. Do not pass this to the join function!
CY_WCM_SECURITY_FORCE_32_BIT	Exists only to force whd_security_t type to 32 bits.

cy_wcm_wifi_band_t

enum cy_wcm_wifi_band_t

Enumeration of 802.11 radio bands.

Enumerator
CY_WCM_WIFI_BAND_ANY	Platform will choose an available band.
CY_WCM_WIFI_BAND_5GHZ	5-GHz radio band.
CY_WCM_WIFI_BAND_2_4GHZ	2.4-GHz radio band.

cy_wcm_scan_rssi_range_t

enum cy_wcm_scan_rssi_range_t

Enumeration of RSSI range.

Enumerator
CY_WCM_SCAN_RSSI_FAIR	Wi-Fi RSSI values greater than -90 dBm.
CY_WCM_SCAN_RSSI_GOOD	Wi-Fi RSSI values greater than -60 dBm.
CY_WCM_SCAN_RSSI_EXCELLENT	Wi-Fi RSSI values greater than -40 dBm.

cy_wcm_interface_t

enum cy_wcm_interface_t

Enumeration of WCM interfaces types.

Enumerator
CY_WCM_INTERFACE_TYPE_STA	STA or client interface.
CY_WCM_INTERFACE_TYPE_AP	SoftAP interface.
CY_WCM_INTERFACE_TYPE_AP_STA	Concurrent AP + STA mode.

cy_wcm_powersave_mode_t

enum cy_wcm_powersave_mode_t

Enumeration of WCM Powersave Modes.

Enumerator
CY_WCM_NO_POWERSAVE_MODE	No power savings.
CY_WCM_PM1_POWERSAVE_MODE	Powersave mode on specified interface without regard for throughput reduction.
CY_WCM_PM2_POWERSAVE_MODE	Powersave mode on specified interface with High throughput.

cy_wcm_scan_status_t

enum cy_wcm_scan_status_t

Enumeration of scan status.

Enumerator
CY_WCM_SCAN_INCOMPLETE	Scan is in progress; more scan results will be returned.
CY_WCM_SCAN_COMPLETE	Scan is completed.

cy_wcm_wps_mode_t

enum cy_wcm_wps_mode_t

Enumeration of WPS connection modes.

Enumerator
CY_WCM_WPS_PBC_MODE	Push button mode.
CY_WCM_WPS_PIN_MODE	PIN mode.

cy_wcm_wps_configuration_method_t

enum cy_wcm_wps_configuration_method_t

Enumeration of WPS configuration method.

Enumerator
CY_WCM_WPS_CONFIG_USBA	USB configuration.
CY_WCM_WPS_CONFIG_ETHERNET	Ethernet configuration.
CY_WCM_WPS_CONFIG_LABEL	Label configuration.
CY_WCM_WPS_CONFIG_DISPLAY	Display configuration.
CY_WCM_WPS_CONFIG_EXTERNAL_NFC_TOKEN	External NFC configuration.
CY_WCM_WPS_CONFIG_INTEGRATED_NFC_TOKEN	Internal NFC configuration.
CY_WCM_WPS_CONFIG_NFC_INTERFACE	NFC interface.
CY_WCM_WPS_CONFIG_PUSH_BUTTON	Push button configuration.
CY_WCM_WPS_CONFIG_KEYPAD	Keypad configuration.
CY_WCM_WPS_CONFIG_VIRTUAL_PUSH_BUTTON	Virtual push button configuration.
CY_WCM_WPS_CONFIG_PHYSICAL_PUSH_BUTTON	Physical push button configuration.
CY_WCM_WPS_CONFIG_VIRTUAL_DISPLAY_PIN	Virtual display pin configuration.
CY_WCM_WPS_CONFIG_PHYSICAL_DISPLAY_PIN	Physical display pin configuration.

cy_wcm_wps_authentication_type_t

enum cy_wcm_wps_authentication_type_t

Enumeration of WPS authentication types.

Enumerator
CY_WCM_WPS_OPEN_AUTHENTICATION	Authentication type OPEN.
CY_WCM_WPS_WPA_PSK_AUTHENTICATION	WPA-PSK authentication type - Deprecated in version 2.0.
CY_WCM_WPS_SHARED_AUTHENTICATION	WPS-SHARED authentication type - Deprecated in version 2.0.
CY_WCM_WPS_WPA_ENTERPRISE_AUTHENTICATION	WPA-ENTERPRISE authentication type - Deprecated in version 2.0.
CY_WCM_WPS_WPA2_ENTERPRISE_AUTHENTICATION	WPA2-ENTERPRISE authentication type.
CY_WCM_WPS_WPA2_PSK_AUTHENTICATION	WPA2-PSK authentication type.
CY_WCM_WPS_WPA2_WPA_PSK_MIXED_AUTHENTICATION	WPA2-WPA-PSK authentication type.

cy_wcm_wps_encryption_type_t

enum cy_wcm_wps_encryption_type_t

Enumeration of WPS encryption type.

Enumerator
CY_WCM_WPS_MIXED_ENCRYPTION	MIXED encryption.
CY_WCM_WPS_AES_ENCRYPTION	AES encryption.
CY_WCM_WPS_TKIP_ENCRYPTION	TKIP encryption - Deprecated in WSC 2.0.
CY_WCM_WPS_WEP_ENCRYPTION	WEP encryption - Deprecated in WSC 2.0.
CY_WCM_WPS_NO_ENCRYPTION	OPEN - No encryption.
CY_WCM_WPS_NO_UNDEFINED	Undefined encryption type.

cy_wcm_wps_device_category_t

enum cy_wcm_wps_device_category_t

Enumeration of WPS device category from the WSC 2.0 spec.

Enumerator
CY_WCM_WPS_DEVICE_COMPUTER	Computer devices.
CY_WCM_WPS_DEVICE_INPUT	Input devices.
CY_WCM_WPS_DEVICE_PRINT_SCAN_FAX_COPY	Devices such as printers, scanners, faxes and copiers.
CY_WCM_WPS_DEVICE_CAMERA	Camera devices.
CY_WCM_WPS_DEVICE_STORAGE	Storage devices.
CY_WCM_WPS_DEVICE_NETWORK_INFRASTRUCTURE	Network infrastructure devices.
CY_WCM_WPS_DEVICE_DISPLAY	Display devices.
CY_WCM_WPS_DEVICE_MULTIMEDIA	Multimedia devices.
CY_WCM_WPS_DEVICE_GAMING	Gaming devices.
CY_WCM_WPS_DEVICE_TELEPHONE	Telephony devices.
CY_WCM_WPS_DEVICE_AUDIO	Audio devices.
CY_WCM_WPS_DEVICE_DOCK	Docking devices.
CY_WCM_WPS_DEVICE_OTHER	Other devices.

cy_wcm_event_t

enum cy_wcm_event_t

Enumeration of WCM events.

Enumerator
CY_WCM_EVENT_CONNECTING	STA connecting to an AP.
CY_WCM_EVENT_CONNECTED	STA connected to the AP.
CY_WCM_EVENT_CONNECT_FAILED	STA connection to the AP failed.
CY_WCM_EVENT_RECONNECTED	STA reconnected to the AP.
CY_WCM_EVENT_DISCONNECTED	STA disconnected from the AP.
CY_WCM_EVENT_IP_CHANGED	IP address change event. This event is notified after connection, re-connection, and IP address change due to DHCP renewal.
CY_WCM_EVENT_INITIATED_RETRY	Indicates that WCM will initiate a retry logic to re-connect to the AP.
CY_WCM_EVENT_STA_JOINED_SOFTAP	An STA device connected to SoftAP.
CY_WCM_EVENT_STA_LEFT_SOFTAP	An STA device disconnected from SoftAP.

cy_wcm_scan_filter_type_t

enum cy_wcm_scan_filter_type_t

Enumeration of scan filter types.

Enumerator
CY_WCM_SCAN_FILTER_TYPE_SSID	SSID-based scan filtering.
CY_WCM_SCAN_FILTER_TYPE_MAC	MAC-based scan filtering.
CY_WCM_SCAN_FILTER_TYPE_BAND	Band-based scan filtering.
CY_WCM_SCAN_FILTER_TYPE_RSSI	RSSI-based scan filtering.

cy_wcm_bss_type_t

enum cy_wcm_bss_type_t

Enumeration of network types.

Enumerator
CY_WCM_BSS_TYPE_INFRASTRUCTURE	Infrastructure network.
CY_WCM_BSS_TYPE_ADHOC	802.11 ad hoc IBSS network.
CY_WCM_BSS_TYPE_ANY	Either infrastructure or ad hoc network.
CY_WCM_BSS_TYPE_MESH	802.11 mesh network.
CY_WCM_BSS_TYPE_UNKNOWN	Returned by cy_wcm_scan_result_callback_t if BSS type is unknown. Do not pass this to the Join function.

cy_wcm_ie_mask_t

enum cy_wcm_ie_mask_t

Enumeration of applicable packet mask bits for custom information elements (IEs)

Enumerator
CY_WCM_IE_MASK_BEACON	Denotes mask for beacon packet.
CY_WCM_IE_MASK_PROBE_RESPONSE	Denotes mask for probe response packet.
CY_WCM_IE_MASK_ASSOC_RESPONSE	Denotes mask for association response packet.
CY_WCM_IE_MASK_AUTH_RESPONSE	Denotes mask for authentication response packet.
CY_WCM_IE_MASK_PROBE_REQUEST	Denotes mask for probe request packet.
CY_WCM_IE_MASK_ASSOC_REQUEST	Denotes mask for association request packet.
CY_WCM_IE_MASK_CUSTOM	Denotes mask for custom IE identifier.