MT7687 API Reference  LinkIt SDK v4
Enumeration

Overview

Enumerations

enum  wifi_event_t {
  WIFI_EVENT_IOT_CONNECTED = 0,
  WIFI_EVENT_IOT_SCAN_COMPLETE,
  WIFI_EVENT_IOT_DISCONNECTED,
  WIFI_EVENT_IOT_PORT_SECURE,
  WIFI_EVENT_IOT_REPORT_BEACON_PROBE_RESPONSE,
  WIFI_EVENT_IOT_WPS_COMPLETE,
  WIFI_EVENT_IOT_INIT_COMPLETE,
  WIFI_EVENT_IOT_REPORT_FILTERED_FRAME,
  WIFI_EVENT_IOT_CONNECTION_FAILED,
  WIFI_EVENT_MAX_NUMBER
}
 This enumeration defines the supported events generated by the Wi-Fi driver. More...
 
enum  wifi_rx_filter_t {
  WIFI_RX_FILTER_DROP_STBC_BCN_BC_MC,
  WIFI_RX_FILTER_DROP_FCS_ERR,
  WIFI_RX_FILTER_RESERVED,
  WIFI_RX_FILTER_DROP_VER_NOT_0,
  WIFI_RX_FILTER_DROP_PROBE_REQ,
  WIFI_RX_FILTER_DROP_MC_FRAME,
  WIFI_RX_FILTER_DROP_BC_FRAME,
  WIFI_RX_FILTER_RM_FRAME_REPORT_EN = 12,
  WIFI_RX_FILTER_DROP_CTRL_RSV,
  WIFI_RX_FILTER_DROP_CTS,
  WIFI_RX_FILTER_DROP_RTS,
  WIFI_RX_FILTER_DROP_DUPLICATE,
  WIFI_RX_FILTER_DROP_NOT_MY_BSSID,
  WIFI_RX_FILTER_DROP_NOT_UC2ME,
  WIFI_RX_FILTER_DROP_DIFF_BSSID_BTIM,
  WIFI_RX_FILTER_DROP_NDPA
}
 This enumeration defines the RX filter register's bitmap. More...
 
enum  wifi_auth_mode_t {
  WIFI_AUTH_MODE_OPEN = 0,
  WIFI_AUTH_MODE_SHARED,
  WIFI_AUTH_MODE_AUTO_WEP,
  WIFI_AUTH_MODE_WPA,
  WIFI_AUTH_MODE_WPA_PSK,
  WIFI_AUTH_MODE_WPA_None,
  WIFI_AUTH_MODE_WPA2,
  WIFI_AUTH_MODE_WPA2_PSK,
  WIFI_AUTH_MODE_WPA_WPA2,
  WIFI_AUTH_MODE_WPA_PSK_WPA2_PSK
}
 This enumeration defines the wireless authentication mode to indicate the Wi-Fi device’s authentication attribute. More...
 
enum  wifi_encrypt_type_t {
  WIFI_ENCRYPT_TYPE_WEP_ENABLED = 0,
  WIFI_ENCRYPT_TYPE_ENCRYPT1_ENABLED = WIFI_ENCRYPT_TYPE_WEP_ENABLED,
  WIFI_ENCRYPT_TYPE_WEP_DISABLED = 1,
  WIFI_ENCRYPT_TYPE_ENCRYPT_DISABLED = WIFI_ENCRYPT_TYPE_WEP_DISABLED,
  WIFI_ENCRYPT_TYPE_WEP_KEY_ABSENT = 2,
  WIFI_ENCRYPT_TYPE_ENCRYPT_KEY_ABSENT = WIFI_ENCRYPT_TYPE_WEP_KEY_ABSENT,
  WIFI_ENCRYPT_TYPE_WEP_NOT_SUPPORTED = 3,
  WIFI_ENCRYPT_TYPE_ENCRYPT_NOT_SUPPORTED = WIFI_ENCRYPT_TYPE_WEP_NOT_SUPPORTED,
  WIFI_ENCRYPT_TYPE_TKIP_ENABLED = 4,
  WIFI_ENCRYPT_TYPE_ENCRYPT2_ENABLED = WIFI_ENCRYPT_TYPE_TKIP_ENABLED,
  WIFI_ENCRYPT_TYPE_AES_ENABLED = 6,
  WIFI_ENCRYPT_TYPE_ENCRYPT3_ENABLED = WIFI_ENCRYPT_TYPE_AES_ENABLED,
  WIFI_ENCRYPT_TYPE_AES_KEY_ABSENT = 7,
  WIFI_ENCRYPT_TYPE_TKIP_AES_MIX = 8,
  WIFI_ENCRYPT_TYPE_ENCRYPT4_ENABLED = WIFI_ENCRYPT_TYPE_TKIP_AES_MIX,
  WIFI_ENCRYPT_TYPE_TKIP_AES_KEY_ABSENT = 9,
  WIFI_ENCRYPT_TYPE_GROUP_WEP40_ENABLED = 10,
  WIFI_ENCRYPT_TYPE_GROUP_WEP104_ENABLED = 11
}
 This enumeration defines the wireless encryption type to indicate the Wi-Fi device’s encryption attribute. More...
 
enum  wifi_phy_mode_t {
  WIFI_PHY_11BG_MIXED = 0,
  WIFI_PHY_11B,
  WIFI_PHY_11A,
  WIFI_PHY_11ABG_MIXED,
  WIFI_PHY_11G,
  WIFI_PHY_11ABGN_MIXED,
  WIFI_PHY_11N_2_4G,
  WIFI_PHY_11GN_MIXED,
  WIFI_PHY_11AN_MIXED,
  WIFI_PHY_11BGN_MIXED,
  WIFI_PHY_11AGN_MIXED,
  WIFI_PHY_11N_5G
}
 This enumeration defines the wireless physical mode. More...
 
enum  wifi_security_cipher_suits_t {
  WIFI_CIPHER_NONE = 0,
  WIFI_CIPHER_WEP64,
  WIFI_CIPHER_WEP128,
  WIFI_CIPHER_TKIP,
  WIFI_CIPHER_AES,
  WIFI_CIPHER_CKIP64,
  WIFI_CIPHER_CKIP128,
  WIFI_CIPHER_CKIP152,
  WIFI_CIPHER_SMS4,
  WIFI_CIPHER_WEP152,
  WIFI_CIPHER_BIP,
  WIFI_CIPHER_WAPI,
  WIFI_CIPHER_TKIP_NO_MIC
}
 This enumeration defines wireless security cipher suits. More...
 
enum  wifi_bandwidth_ext_t {
  WIFI_BANDWIDTH_EXT_40MHZ_UP,
  WIFI_BANDWIDTH_EXT_40MHZ_BELOW
}
 This enumeration defines 40MHz bandwidth extension. More...
 
enum  wifi_power_saving_mode_t {
  WIFI_POWER_SAVING_MODE_OFF = 0,
  WIFI_POWER_SAVING_MODE_LEGACY,
  WIFI_POWER_SAVING_MODE_FAST
}
 This enumeration defines three power saving modes. More...
 
enum  wps_device_password_id_t {
  WIFI_WPS_DPID_DEFAULT = 0x0000,
  WIFI_WPS_DPID_USER_SPECIFIED = 0x0001,
  WIFI_WPS_DPID_MACHINE_SPECIFIED = 0x0002,
  WIFI_WPS_DPID_REKEY = 0x0003,
  WIFI_WPS_DPID_PUSHBUTTON = 0x0004,
  WIFI_WPS_DPID_REGISTRAR_SPECIFIED = 0x0005,
  WIFI_WPS_DPID_MAX_NUMBER = 0xFFFF
}
 This enumeration of device password ID is used for WPS. More...
 
enum  wps_config_method_t {
  WIFI_WPS_CONFIG_USBA = 0x0001,
  WIFI_WPS_CONFIG_ETHERNET = 0x0002,
  WIFI_WPS_CONFIG_LABEL = 0x0004,
  WIFI_WPS_CONFIG_DISPLAY = 0x0008,
  WIFI_WPS_CONFIG_EXTERNAL_NFC_TOKEN = 0x0010,
  WIFI_WPS_CONFIG_INTEGRATED_NFC_TOKEN = 0x0020,
  WIFI_WPS_CONFIG_NFC_INTERFACE = 0x0040,
  WIFI_WPS_CONFIG_PUSHBUTTON = 0x0080,
  WIFI_WPS_CONFIG_KEYPAD = 0x0100,
  WIFI_WPS_CONFIG_VIRTUAL_PUSHBUTTON = 0x0280,
  WIFI_WPS_CONFIG_PHY_PUSHBUTTON = 0x0480,
  WIFI_WPS_CONFIG_VIRTUAL_DISPLAY = 0x2008,
  WIFI_WPS_CONFIG_PHY_DISPLAY = 0x4008
}
 This enumeration lists the configuration methods supported by the Enrollee or Registrar. More...
 

Enumeration Type Documentation

This enumeration defines the wireless authentication mode to indicate the Wi-Fi device’s authentication attribute.

Enumerator
WIFI_AUTH_MODE_OPEN 

Open mode.

WIFI_AUTH_MODE_SHARED 

Not supported.

WIFI_AUTH_MODE_AUTO_WEP 

Not supported.

WIFI_AUTH_MODE_WPA 

Not supported.

WIFI_AUTH_MODE_WPA_PSK 

WPA_PSK.

WIFI_AUTH_MODE_WPA_None 

Not supported.

WIFI_AUTH_MODE_WPA2 

Not supported.

WIFI_AUTH_MODE_WPA2_PSK 

WPA2_PSK.

WIFI_AUTH_MODE_WPA_WPA2 

Not supported.

WIFI_AUTH_MODE_WPA_PSK_WPA2_PSK 

Mixture mode.

This enumeration defines 40MHz bandwidth extension.

Enumerator
WIFI_BANDWIDTH_EXT_40MHZ_UP 

40MHz up.

WIFI_BANDWIDTH_EXT_40MHZ_BELOW 

40MHz below.

This enumeration defines the wireless encryption type to indicate the Wi-Fi device’s encryption attribute.

Enumerator
WIFI_ENCRYPT_TYPE_WEP_ENABLED 

WEP encryption type.

WIFI_ENCRYPT_TYPE_ENCRYPT1_ENABLED 

WEP encryption type.

WIFI_ENCRYPT_TYPE_WEP_DISABLED 

No encryption.

WIFI_ENCRYPT_TYPE_ENCRYPT_DISABLED 

No encryption.

WIFI_ENCRYPT_TYPE_WEP_KEY_ABSENT 

Not supported.

WIFI_ENCRYPT_TYPE_ENCRYPT_KEY_ABSENT 

Not supported.

WIFI_ENCRYPT_TYPE_WEP_NOT_SUPPORTED 

Not supported.

WIFI_ENCRYPT_TYPE_ENCRYPT_NOT_SUPPORTED 

Not supported.

WIFI_ENCRYPT_TYPE_TKIP_ENABLED 

TKIP encryption.

WIFI_ENCRYPT_TYPE_ENCRYPT2_ENABLED 

TKIP encryption.

WIFI_ENCRYPT_TYPE_AES_ENABLED 

AES encryption.

WIFI_ENCRYPT_TYPE_ENCRYPT3_ENABLED 

AES encryption.

WIFI_ENCRYPT_TYPE_AES_KEY_ABSENT 

Not supported.

WIFI_ENCRYPT_TYPE_TKIP_AES_MIX 

TKIP or AES mix.

WIFI_ENCRYPT_TYPE_ENCRYPT4_ENABLED 

TKIP or AES mix.

WIFI_ENCRYPT_TYPE_TKIP_AES_KEY_ABSENT 

Not supported.

WIFI_ENCRYPT_TYPE_GROUP_WEP40_ENABLED 

Not supported.

WIFI_ENCRYPT_TYPE_GROUP_WEP104_ENABLED 

Not supported.

This enumeration defines the supported events generated by the Wi-Fi driver.

The event will be sent to the upper layer handler registered in wifi_connection_register_event_handler().

Enumerator
WIFI_EVENT_IOT_CONNECTED 

Connected event.

WIFI_EVENT_IOT_SCAN_COMPLETE 

Scan completed event.

WIFI_EVENT_IOT_DISCONNECTED 

Disconnected event.

WIFI_EVENT_IOT_PORT_SECURE 

Secure event, mainly processed in supplicant.

It can be used at the DHCP start.

WIFI_EVENT_IOT_REPORT_BEACON_PROBE_RESPONSE 

Sends notification, if beacon or probe request is received.

WIFI_EVENT_IOT_WPS_COMPLETE 

Credential event, sends notification when WPS process is complete.

WIFI_EVENT_IOT_INIT_COMPLETE 

Initialization complete event.

WIFI_EVENT_IOT_REPORT_FILTERED_FRAME 

Report the expected packet frame.

WIFI_EVENT_IOT_CONNECTION_FAILED 

Connection has failed.

This option is not available yet.

This enumeration defines the wireless physical mode.

Enumerator
WIFI_PHY_11BG_MIXED 

0, 2.4GHz band.

WIFI_PHY_11B 

1, 2.4GHz band.

WIFI_PHY_11A 

2, 5GHz band.

WIFI_PHY_11ABG_MIXED 

3, both 2.4G and 5G band.

WIFI_PHY_11G 

4, 2.4GHz band.

WIFI_PHY_11ABGN_MIXED 

5, both 2.4G and 5G band.

WIFI_PHY_11N_2_4G 

6, 11n-only with 2.4GHz band.

WIFI_PHY_11GN_MIXED 

7, 2.4GHz band.

WIFI_PHY_11AN_MIXED 

8, 5GHz band.

WIFI_PHY_11BGN_MIXED 

9, 2.4GHz band.

WIFI_PHY_11AGN_MIXED 

10, both 2.4G and 5G band.

WIFI_PHY_11N_5G 

11, 11n-only with 5GHz band.

This enumeration defines three power saving modes.

Enumerator
WIFI_POWER_SAVING_MODE_OFF 

WIFI_POWER_SAVING_MODE_OFF is a power saving mode that keeps the radio powered up continuously to ensure there is a minimal lag in response time.

This power saving setting consumes the most power but offers the highest throughput.

WIFI_POWER_SAVING_MODE_LEGACY 

WIFI_POWER_SAVING_MODE_LEGACY: The access point buffers incoming messages for the radio.

The radio occasionally 'wakes up' to determine if any buffered messages are waiting and then returns to sleep mode after it has responded to each message. This setting conserves the most power but also provides the lowest throughput. It is recommended for radios in which power consumption is the most important (such as small battery-operated devices).

WIFI_POWER_SAVING_MODE_FAST 

WIFI_POWER_SAVING_MODE_FAST is a power saving mode that switches between power saving and WIFI_POWER_SAVING_MODE_OFF modes, depending on the network traffic.

For example, it switches to WIFI_POWER_SAVING_MODE_OFF mode after receiving a large number of packets and switches back to power saving mode after the packets have been retrieved. Fast is recommended when power consumption and throughput are a concern.

This enumeration defines the RX filter register's bitmap.

Each bit indicates a specific drop frame.

Enumerator
WIFI_RX_FILTER_DROP_STBC_BCN_BC_MC 

bit 0 Drops the STBC beacon/BC/MC frames.

WIFI_RX_FILTER_DROP_FCS_ERR 

bit 1 Drops the FCS error frames.

WIFI_RX_FILTER_RESERVED 

bit 2 A reserved bit, not used.

WIFI_RX_FILTER_DROP_VER_NOT_0 

bit 3 Drops the version field of Frame Control field.

It cannot be 0.

WIFI_RX_FILTER_DROP_PROBE_REQ 

bit 4 Drops the probe request frame.

WIFI_RX_FILTER_DROP_MC_FRAME 

bit 5 Drops multicast frame.

WIFI_RX_FILTER_DROP_BC_FRAME 

bit 6 Drops broadcast frame.

WIFI_RX_FILTER_RM_FRAME_REPORT_EN 

bit 12 Enables report frames.

WIFI_RX_FILTER_DROP_CTRL_RSV 

bit 13 Drops reserved definition control frames.

WIFI_RX_FILTER_DROP_CTS 

bit 14 Drops CTS frames.

WIFI_RX_FILTER_DROP_RTS 

bit 15 Drops RTS frames.

WIFI_RX_FILTER_DROP_DUPLICATE 

bit 16 Drops duplicate frames.

WIFI_RX_FILTER_DROP_NOT_MY_BSSID 

bit 17 Drops not my BSSID frames.

WIFI_RX_FILTER_DROP_NOT_UC2ME 

bit 18 Drops not unicast to me frames.

WIFI_RX_FILTER_DROP_DIFF_BSSID_BTIM 

bit 19 Drops different BSSID TIM (Traffic Indication Map) Broadcast frame.

WIFI_RX_FILTER_DROP_NDPA 

bit 20 Drops the NDPA or not.

This enumeration defines wireless security cipher suits.

Enumerator
WIFI_CIPHER_NONE 

0, No cipher.

WIFI_CIPHER_WEP64 

1, WEP64 cipher.

WIFI_CIPHER_WEP128 

2, WEP128 cipher.

WIFI_CIPHER_TKIP 

3, TKIP cipher.

WIFI_CIPHER_AES 

4, AES cipher.

WIFI_CIPHER_CKIP64 

5, CKIP64 cipher.

WIFI_CIPHER_CKIP128 

6, CKIP128 cipher.

WIFI_CIPHER_CKIP152 

7, CKIP152 cipher.

WIFI_CIPHER_SMS4 

8, SMS4 cipher.

WIFI_CIPHER_WEP152 

9, WEP152 cipher.

WIFI_CIPHER_BIP 

10, BIP cipher.

WIFI_CIPHER_WAPI 

11, WAPI cipher.

WIFI_CIPHER_TKIP_NO_MIC 

12, TKIP_NO_MIC cipher.

This enumeration lists the configuration methods supported by the Enrollee or Registrar.

For more information, please refer to Table 33, "Configuration Methods" in chapter 12, "Data Element Definitions" of the Wi-Fi Simple Configuration Technical Specification V2.0.5.

Enumerator
WIFI_WPS_CONFIG_USBA 
Deprecated:
Ignored in WPS version 2.0.
WIFI_WPS_CONFIG_ETHERNET 
Deprecated:
Ignored in WPS version 2.0.
WIFI_WPS_CONFIG_LABEL 

8-digit static PIN.

WIFI_WPS_CONFIG_DISPLAY 

A dynamic PIN from a display.

WIFI_WPS_CONFIG_EXTERNAL_NFC_TOKEN 

The NFC tag is used for WPS.

WIFI_WPS_CONFIG_INTEGRATED_NFC_TOKEN 

The NFC tag is integrated in the device.

WIFI_WPS_CONFIG_NFC_INTERFACE 

The device contains an NFC interface.

WIFI_WPS_CONFIG_PUSHBUTTON 

WPS PBC supports either a physical or a virtual pushbutton.

WIFI_WPS_CONFIG_KEYPAD 

Device is capable of entering a PIN.

WIFI_WPS_CONFIG_VIRTUAL_PUSHBUTTON 

WPS PBC supports software user interface.

WIFI_WPS_CONFIG_PHY_PUSHBUTTON 

WPS PBC available on a physical push button of the device.

WIFI_WPS_CONFIG_VIRTUAL_DISPLAY 

The dynamic PIN is displayed through a remote user interface, such as an HTML page.

WIFI_WPS_CONFIG_PHY_DISPLAY 

The dynamic PIN is shown on a display that is part of the device.

This enumeration of device password ID is used for WPS.

This enumeration is only applicable when the boolean variable selected_registrar inside wifi_wps_element_t is true. For more information, please refer to Table 37, "Device Password ID" in chapter 12, "Data Element Definitions" of the Wi-Fi Simple Configuration Technical Specification V2.0.5.

Enumerator
WIFI_WPS_DPID_DEFAULT 

Default value or use PIN if selected_registrar is true.

WIFI_WPS_DPID_USER_SPECIFIED 

User specified.

WIFI_WPS_DPID_MACHINE_SPECIFIED 

Machine specified.

WIFI_WPS_DPID_REKEY 

Rekey.

WIFI_WPS_DPID_PUSHBUTTON 

Pushbutton.

WIFI_WPS_DPID_REGISTRAR_SPECIFIED 

Registrar specified.