Enumerated Types

group group_wcm_enums

Enums

enum cy_wcm_ip_version_t

cy_wcm_ip_version_t: IP Version.

Values:

enumerator CY_WCM_IP_VER_V4

Denotes IPv4 version.

enumerator CY_WCM_IP_VER_V6

Denotes IPv6 version.

enum cy_wcm_ipv6_type_t

cy_wcm_ipv6_type_t: IPV6 types.

Values:

Denotes IPv6 link-local address type.

enumerator CY_WCM_IPV6_GLOBAL

Denotes IPv6 global address type.

enum cy_wcm_security_t

cy_wcm_security_t: Enumeration of Wi-Fi Security Modes.

Values:

enumerator CY_WCM_SECURITY_OPEN

Open security.

enumerator CY_WCM_SECURITY_WEP_PSK

WEP PSK security with open authentication.

enumerator CY_WCM_SECURITY_WEP_SHARED

WEP PSK security with shared authentication.

enumerator CY_WCM_SECURITY_WPA_TKIP_PSK

WPA PSK security with TKIP.

enumerator CY_WCM_SECURITY_WPA_AES_PSK

WPA PSK security with AES.

enumerator CY_WCM_SECURITY_WPA_MIXED_PSK

WPA PSK security with AES and TKIP.

enumerator CY_WCM_SECURITY_WPA2_AES_PSK

WPA2 PSK security with AES.

enumerator CY_WCM_SECURITY_WPA2_TKIP_PSK

WPA2 PSK security with TKIP.

enumerator CY_WCM_SECURITY_WPA2_MIXED_PSK

WPA2 PSK security with AES and TKIP.

enumerator CY_WCM_SECURITY_WPA2_FBT_PSK

WPA2 FBT PSK security with AES and TKIP.

enumerator CY_WCM_SECURITY_WPA3_SAE

WPA3 security with AES.

enumerator CY_WCM_SECURITY_WPA2_WPA_AES_PSK

WPA2 WPA PSK Security with AES.

enumerator CY_WCM_SECURITY_WPA2_WPA_MIXED_PSK

WPA2 WPA PSK Security with AES & TKIP.

enumerator CY_WCM_SECURITY_WPA3_WPA2_PSK

WPA3 WPA2 PSK security with AES.

enumerator CY_WCM_SECURITY_WPA_TKIP_ENT

WPA Enterprise Security with TKIP.

enumerator CY_WCM_SECURITY_WPA_AES_ENT

WPA Enterprise Security with AES.

enumerator CY_WCM_SECURITY_WPA_MIXED_ENT

WPA Enterprise Security with AES and TKIP.

enumerator CY_WCM_SECURITY_WPA2_TKIP_ENT

WPA2 Enterprise Security with TKIP.

enumerator CY_WCM_SECURITY_WPA2_AES_ENT

WPA2 Enterprise Security with AES.

enumerator CY_WCM_SECURITY_WPA2_MIXED_ENT

WPA2 Enterprise Security with AES and TKIP.

enumerator CY_WCM_SECURITY_WPA2_FBT_ENT

WPA2 Enterprise Security with AES and FBT.

enumerator CY_WCM_SECURITY_IBSS_OPEN

Open security on IBSS ad hoc network.

enumerator CY_WCM_SECURITY_WPS_SECURE

WPS with AES security.

enumerator CY_WCM_SECURITY_UNKNOWN

Returned by cy_wcm_scan_result_callback_t if security is unknown.

Do not pass this to the join function!

enumerator CY_WCM_SECURITY_FORCE_32_BIT

Exists only to force whd_security_t type to 32 bits.

enum cy_wcm_wifi_band_t

cy_wcm_wifi_band_t: Enumeration of 802.11 Radio Bands.

Values:

enumerator CY_WCM_WIFI_BAND_ANY

The platform will choose an available band.

enumerator CY_WCM_WIFI_BAND_5GHZ

5-GHz radio band.

enumerator CY_WCM_WIFI_BAND_2_4GHZ

2.4-GHz radio band.

enum cy_wcm_scan_rssi_range_t

cy_wcm_scan_rssi_range_t: Enumeration of RSSI Range.

Values:

enumerator CY_WCM_SCAN_RSSI_FAIR

Wi-Fi RSSI values greater than -90 dBm.

enumerator CY_WCM_SCAN_RSSI_GOOD

Wi-Fi RSSI values greater than -60 dBm.

enumerator CY_WCM_SCAN_RSSI_EXCELLENT

Wi-Fi RSSI values greater than -40 dBm.

enum cy_wcm_interface_t

cy_wcm_interface_t: Enumeration of WCM Interfaces Types.

Values:

enumerator CY_WCM_INTERFACE_TYPE_STA

STA or Client interface.

enumerator CY_WCM_INTERFACE_TYPE_AP

SoftAP interface.

enumerator CY_WCM_INTERFACE_TYPE_AP_STA

Concurrent AP + STA mode.

enum cy_wcm_scan_status_t

cy_wcm_scan_status_t: Enumeration of Scan Status.

Values:

enumerator CY_WCM_SCAN_INCOMPLETE

Scan is in progress; more scan results will be returned.

enumerator CY_WCM_SCAN_COMPLETE

Scan is completed.

enum cy_wcm_wps_mode_t

cy_wcm_wps_mode_t: Enumeration of WPS Connection Modes.

Values:

enumerator CY_WCM_WPS_PBC_MODE

Push button mode.

enumerator CY_WCM_WPS_PIN_MODE

PIN mode.

enum cy_wcm_wps_configuration_method_t

cy_wcm_wps_configuration_method_t: Enumeration of WPS Configuration Method.

Values:

enumerator CY_WCM_WPS_CONFIG_USBA

USB configuration.

enumerator CY_WCM_WPS_CONFIG_ETHERNET

Ethernet configuration.

enumerator CY_WCM_WPS_CONFIG_LABEL

Label configuration.

enumerator CY_WCM_WPS_CONFIG_DISPLAY

Display configuration.

enumerator CY_WCM_WPS_CONFIG_EXTERNAL_NFC_TOKEN

External NFC configuration.

enumerator CY_WCM_WPS_CONFIG_INTEGRATED_NFC_TOKEN

Internal NFC configuration.

enumerator CY_WCM_WPS_CONFIG_NFC_INTERFACE

NFC interface.

enumerator CY_WCM_WPS_CONFIG_PUSH_BUTTON

Push button configuration.

enumerator CY_WCM_WPS_CONFIG_KEYPAD

Keypad configuration.

enumerator CY_WCM_WPS_CONFIG_VIRTUAL_PUSH_BUTTON

Virtual push button configuration.

enumerator CY_WCM_WPS_CONFIG_PHYSICAL_PUSH_BUTTON

Physical push button configuration.

enumerator CY_WCM_WPS_CONFIG_VIRTUAL_DISPLAY_PIN

Virtual display pin configuration.

enumerator CY_WCM_WPS_CONFIG_PHYSICAL_DISPLAY_PIN

Physical display pin configuration.

enum cy_wcm_wps_authentication_type_t

cy_wcm_wps_authentication_type_t: Enumeration of WPS Authentication Types.

Values:

enumerator CY_WCM_WPS_OPEN_AUTHENTICATION

Authentication type OPEN.

enumerator CY_WCM_WPS_WPA_PSK_AUTHENTICATION

WPA-PSK authentication type - Deprecated in version 2.0.

enumerator CY_WCM_WPS_SHARED_AUTHENTICATION

WPS-SHARED authentication type - Deprecated in version 2.0.

enumerator CY_WCM_WPS_WPA_ENTERPRISE_AUTHENTICATION

WPA-ENTERPRISE authentication type - Deprecated in version 2.0.

enumerator CY_WCM_WPS_WPA2_ENTERPRISE_AUTHENTICATION

WPA2-ENTERPRISE authentication type.

enumerator CY_WCM_WPS_WPA2_PSK_AUTHENTICATION

WPA2-PSK authentication type.

enumerator CY_WCM_WPS_WPA2_WPA_PSK_MIXED_AUTHENTICATION

WPA2-WPA-PSK authentication type.

enum cy_wcm_wps_encryption_type_t

cy_wcm_wps_encryption_type_t: Enumeration of WPS Encryption Type.

Values:

enumerator CY_WCM_WPS_MIXED_ENCRYPTION

MIXED encryption.

enumerator CY_WCM_WPS_AES_ENCRYPTION

AES encryption.

enumerator CY_WCM_WPS_TKIP_ENCRYPTION

TKIP encryption - Deprecated in WSC 2.0.

enumerator CY_WCM_WPS_WEP_ENCRYPTION

WEP encryption - Deprecated in WSC 2.0.

enumerator CY_WCM_WPS_NO_ENCRYPTION

OPEN - No encryption.

enumerator CY_WCM_WPS_NO_UNDEFINED

Undefined encryption type.

enum cy_wcm_wps_device_category_t

cy_wcm_wps_device_category_t: Enumeration of WPS Device Category from the WSC 2.0 Spec.

Values:

enumerator CY_WCM_WPS_DEVICE_COMPUTER

Computer devices.

enumerator CY_WCM_WPS_DEVICE_INPUT

Input devices.

enumerator CY_WCM_WPS_DEVICE_PRINT_SCAN_FAX_COPY

Devices such as printers, scanners, faxes and copiers.

enumerator CY_WCM_WPS_DEVICE_CAMERA

Camera devices.

enumerator CY_WCM_WPS_DEVICE_STORAGE

Storage devices.

enumerator CY_WCM_WPS_DEVICE_NETWORK_INFRASTRUCTURE

Network infrastructure devices.

enumerator CY_WCM_WPS_DEVICE_DISPLAY

Display devices.

enumerator CY_WCM_WPS_DEVICE_MULTIMEDIA

Multimedia devices.

enumerator CY_WCM_WPS_DEVICE_GAMING

Gaming devices.

enumerator CY_WCM_WPS_DEVICE_TELEPHONE

Telephony devices.

enumerator CY_WCM_WPS_DEVICE_AUDIO

Audio devices.

enumerator CY_WCM_WPS_DEVICE_DOCK

Docking devices.

enumerator CY_WCM_WPS_DEVICE_OTHER

Other devices.

enum cy_wcm_event_t

cy_wcm_event_t: Enumeration of WCM Events.

Values:

enumerator CY_WCM_EVENT_CONNECTING

STA connecting to an AP.

enumerator CY_WCM_EVENT_CONNECTED

STA connected to the AP.

enumerator CY_WCM_EVENT_CONNECT_FAILED

STA connection to the AP failed.

enumerator CY_WCM_EVENT_RECONNECTED

STA reconnected to the AP.

enumerator CY_WCM_EVENT_DISCONNECTED

STA disconnected from the AP.

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

enumerator CY_WCM_EVENT_STA_JOINED_SOFTAP

An STA device connected to SoftAP.

enumerator CY_WCM_EVENT_STA_LEFT_SOFTAP

An STA device disconnected from SoftAP.

enum cy_wcm_scan_filter_type_t

cy_wcm_scan_filter_type_t: Enumeration of Scan Filter Types.

Values:

enumerator CY_WCM_SCAN_FILTER_TYPE_SSID

SSID-based scan filtering.

enumerator CY_WCM_SCAN_FILTER_TYPE_MAC

MAC-based scan filtering.

enumerator CY_WCM_SCAN_FILTER_TYPE_BAND

Band-based scan filtering.

enumerator CY_WCM_SCAN_FILTER_TYPE_RSSI

RSSI-based scan filtering.

enum cy_wcm_bss_type_t

cy_wcm_bss_type_t: Enumeration of Network Types.

Values:

enumerator CY_WCM_BSS_TYPE_INFRASTRUCTURE

Infrastructure network.

enumerator CY_WCM_BSS_TYPE_ADHOC

802.11 ad hoc IBSS network.

enumerator CY_WCM_BSS_TYPE_ANY

Either infrastructure or ad hoc network.

enumerator CY_WCM_BSS_TYPE_MESH

802.11 mesh network.

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

enum cy_wcm_ie_mask_t

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

Values:

enumerator CY_WCM_IE_MASK_BEACON

Denotes mask for beacon packet.

enumerator CY_WCM_IE_MASK_PROBE_RESPONSE

Denotes mask for probe response packet.

enumerator CY_WCM_IE_MASK_ASSOC_RESPONSE

Denotes mask for association response packet.

enumerator CY_WCM_IE_MASK_AUTH_RESPONSE

Denotes mask for authentication response packet.

enumerator CY_WCM_IE_MASK_PROBE_REQUEST

Denotes mask for probe request packet.

enumerator CY_WCM_IE_MASK_ASSOC_REQUEST

Denotes mask for association request packet.

enumerator CY_WCM_IE_MASK_CUSTOM

Denotes mask for custom IE identifier.