Microchip® Advanced Software Framework

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Enumerations and Typedefs

    Specifies the enums and Data Structures used by the Wlan APIs.

Data Structures

struct  tstr1xAuthCredentials
 
struct  tstrAuth1xMschap2
 
struct  tstrAuth1xTls
 
struct  tstrAuthPsk
 
struct  tstrAuthWep
 
struct  tstrEthInitParam
 Structure to hold Ethernet interface parameters. Structure is to be defined and have its attributes set, based on the application's functionality before a call is made to initialize the wi-fi operations by calling the m2m_wifi_init function. Part of the wi-fi configuration structure tstrWifiInitParam. Applications shouldn't need to define this structure, if the bypass mode is not defined. More...
 
struct  tstrM2mIpCtrlBuf
 Structure holding the incoming buffer's data size information, indicating the data size of the buffer and the remaining buffer's data size. The data of the buffer which holds the packet sent to the host when in the bypass mode, is placed in the tstrEthInitParam::au8ethRcvBuf attribute. This following information is retrieved in the host when an event M2M_WIFI_RESP_ETHERNET_RX_PACKET is received in the Wi-Fi callback function tpfAppWifiCb. More...
 
struct  tstrM2mWifiWepParams
 
struct  tstrNetworkId
 
struct  tstrWifiInitParam
 
Structure, holding the Wi-fi configuration attributes such as the wi-fi callback , monitoring mode callback and Ethernet parameter initialization structure.
More...
 

Enumerations

enum  tenu1xOption {
  WIFI_1X_BYPASS_SERVER_AUTH,
  WIFI_1X_TIME_VERIF_MODE,
  WIFI_1X_SESSION_CACHING,
  WIFI_1X_SPECIFIC_ROOTCERT
}
 
enum  tenuCredStoreOption {
  WIFI_CRED_DONTSAVE,
  WIFI_CRED_SAVE_UNENCRYPTED,
  WIFI_CRED_SAVE_ENCRYPTED
}
 
enum  tenuM2mApCmd {
  M2M_WIFI_REQ_ENABLE_AP_LEGACY = M2M_AP_CMD_BASE,
  M2M_WIFI_REQ_DISABLE_AP,
  M2M_WIFI_REQ_ENABLE_AP,
  M2M_WIFI_MAX_AP_ALL
}
 This enum contains WINC commands while in AP mode. More...
 
enum  tenuM2mConfigCmd {
  M2M_WIFI_REQ_RESTART = M2M_CONFIG_CMD_BASE,
  M2M_WIFI_REQ_SET_MAC_ADDRESS,
  M2M_WIFI_REQ_CURRENT_RSSI,
  M2M_WIFI_RESP_CURRENT_RSSI,
  M2M_WIFI_REQ_RESTRICT_BLE,
  M2M_WIFI_REQ_UNRESTRICT_BLE,
  M2M_WIFI_REQ_GET_CONN_INFO,
  M2M_WIFI_RESP_CONN_INFO,
  M2M_WIFI_REQ_SET_DEVICE_NAME,
  M2M_WIFI_REQ_START_PROVISION_MODE_LEGACY,
  M2M_WIFI_RESP_PROVISION_INFO,
  M2M_WIFI_REQ_STOP_PROVISION_MODE,
  M2M_WIFI_REQ_SET_SYS_TIME,
  M2M_WIFI_REQ_ENABLE_SNTP_CLIENT,
  M2M_WIFI_REQ_DISABLE_SNTP_CLIENT,
  M2M_WIFI_RESP_MEMORY_RECOVER,
  M2M_WIFI_REQ_CUST_INFO_ELEMENT,
  M2M_WIFI_REQ_SCAN,
  M2M_WIFI_RESP_SCAN_DONE,
  M2M_WIFI_REQ_SCAN_RESULT,
  M2M_WIFI_RESP_SCAN_RESULT,
  M2M_WIFI_REQ_SET_SCAN_OPTION,
  M2M_WIFI_REQ_SET_SCAN_REGION,
  M2M_WIFI_REQ_SET_POWER_PROFILE,
  M2M_WIFI_REQ_SET_TX_POWER,
  M2M_WIFI_REQ_SET_BATTERY_VOLTAGE,
  M2M_WIFI_REQ_SET_ENABLE_LOGS,
  M2M_WIFI_REQ_GET_SYS_TIME,
  M2M_WIFI_RESP_GET_SYS_TIME,
  M2M_WIFI_REQ_SEND_ETHERNET_PACKET,
  M2M_WIFI_RESP_ETHERNET_RX_PACKET,
  M2M_WIFI_REQ_SET_MAC_MCAST,
  M2M_WIFI_REQ_BLE_API_SEND,
  M2M_WIFI_RESP_BLE_API_RECV,
  M2M_WIFI_REQ_SET_GAIN_TABLE,
  M2M_WIFI_RESP_SET_GAIN_TABLE,
  M2M_WIFI_REQ_PASSIVE_SCAN,
  M2M_WIFI_REQ_CONFIG_SNTP,
  M2M_WIFI_REQ_START_PROVISION_MODE,
  M2M_WIFI_MAX_CONFIG_ALL
}
 This enum contains host commands used to configure the WINC board. More...
 
enum  tenuM2mConnChangedErrcode {
  M2M_ERR_SCAN_FAIL = ((uint8)1),
  M2M_ERR_JOIN_FAIL,
  M2M_ERR_AUTH_FAIL,
  M2M_ERR_ASSOC_FAIL,
  M2M_ERR_CONN_INPROGRESS
}
 
enum  tenuM2mConnState {
  M2M_WIFI_DISCONNECTED = 0,
  M2M_WIFI_CONNECTED,
  M2M_WIFI_ROAMED,
  M2M_WIFI_UNDEF = 0xff
}
 This enum contains all the Wi-Fi connection states. More...
 
enum  tenuM2mDefaultConnErrcode {
  M2M_DEFAULT_CONN_INPROGRESS = ((sint8)-23),
  M2M_DEFAULT_CONN_FAIL,
  M2M_DEFAULT_CONN_SCAN_MISMATCH,
  M2M_DEFAULT_CONN_EMPTY_LIST
}
 
enum  tenuM2mGenCmd {
  M2M_WIFI_REQRSP_DELETE_APID = M2M_GEN_CMD_BASE,
  M2M_WIFI_REQ_ROAMING,
  M2M_WIFI_REQ_SCAN_SSID_LIST,
  M2M_WIFI_REQ_SET_STOP_SCAN_OPTION,
  M2M_WIFI_MAX_GEN_ALL
}
 This enum contains additional WINC commands (overflow of previous enums). More...
 
enum  tenuM2mIpCmd {
  M2M_IP_REQ_STATIC_IP_CONF = ((uint8) 10),
  M2M_IP_REQ_ENABLE_DHCP,
  M2M_IP_REQ_DISABLE_DHCP
}
 This enum contains all the WINC commands related to IP. More...
 
enum  tenuM2mP2pCmd {
  M2M_WIFI_REQ_P2P_INT_CONNECT = M2M_P2P_CMD_BASE,
  M2M_WIFI_REQ_ENABLE_P2P,
  M2M_WIFI_REQ_DISABLE_P2P,
  M2M_WIFI_REQ_P2P_REPOST,
  M2M_WIFI_MAX_P2P_ALL
}
 This enum contains WINC commands while in P2P mode. More...
 
enum  tenuM2mPwrMode {
  PWR_AUTO = ((uint8) 1),
  PWR_LOW1,
  PWR_LOW2,
  PWR_HIGH
}
 
enum  tenuM2mReqGroup {
  M2M_REQ_GROUP_MAIN = 0,
  M2M_REQ_GROUP_WIFI,
  M2M_REQ_GROUP_IP,
  M2M_REQ_GROUP_HIF,
  M2M_REQ_GROUP_OTA,
  M2M_REQ_GROUP_SSL,
  M2M_REQ_GROUP_SIGMA,
  M2M_REQ_GROUP_INTERNAL
}
 
enum  tenuM2mReqpkt {
  M2M_REQ_CONFIG_PKT,
  M2M_REQ_DATA_PKT = 0x80
}
 
enum  tenuM2mScanCh {
  M2M_WIFI_CH_1 = ((uint8) 1),
  M2M_WIFI_CH_2,
  M2M_WIFI_CH_3,
  M2M_WIFI_CH_4,
  M2M_WIFI_CH_5,
  M2M_WIFI_CH_6,
  M2M_WIFI_CH_7,
  M2M_WIFI_CH_8,
  M2M_WIFI_CH_9,
  M2M_WIFI_CH_10,
  M2M_WIFI_CH_11,
  M2M_WIFI_CH_12,
  M2M_WIFI_CH_13,
  M2M_WIFI_CH_14,
  M2M_WIFI_CH_ALL = ((uint8) 255)
}
 This enum contains all the Wi-Fi RF channels. More...
 
enum  tenuM2mScanRegion {
  REG_CH_1 = ((uint16) 1 << 0),
  REG_CH_2 = ((uint16) 1 << 1),
  REG_CH_3 = ((uint16) 1 << 2),
  REG_CH_4 = ((uint16) 1 << 3),
  REG_CH_5 = ((uint16) 1 << 4),
  REG_CH_6 = ((uint16) 1 << 5),
  REG_CH_7 = ((uint16) 1 << 6),
  REG_CH_8 = ((uint16) 1 << 7),
  REG_CH_9 = ((uint16) 1 << 8),
  REG_CH_10 = ((uint16) 1 << 9),
  REG_CH_11 = ((uint16) 1 << 10),
  REG_CH_12 = ((uint16) 1 << 11),
  REG_CH_13 = ((uint16) 1 << 12),
  REG_CH_14 = ((uint16) 1 << 13),
  REG_CH_ALL = ((uint16) 0x3FFF),
  NORTH_AMERICA = ((uint16) 0x7FF),
  EUROPE = ((uint16) 0x1FFF),
  ASIA = ((uint16) 0x3FFF)
}
 This enum contains all the Wi-Fi channel regions. More...
 
enum  tenuM2mSecType {
  M2M_WIFI_SEC_INVALID = 0,
  M2M_WIFI_SEC_OPEN,
  M2M_WIFI_SEC_WPA_PSK,
  M2M_WIFI_SEC_WEP,
  M2M_WIFI_SEC_802_1X,
  M2M_WIFI_NUM_AUTH_TYPES
}
 This enum contains all the supported Wi-Fi security types. More...
 
enum  tenuM2mServerCmd {
  M2M_WIFI_REQ_CLIENT_CTRL = M2M_SERVER_CMD_BASE,
  M2M_WIFI_RESP_CLIENT_INFO,
  M2M_WIFI_REQ_SERVER_INIT,
  M2M_WIFI_MAX_SERVER_ALL
}
 These commands are currently not supported. More...
 
enum  tenuM2mSetGainsErrcode {
  M2M_ERR_GAIN_TABLE_INVALID = ((sint8)-10),
  M2M_ERR_READ_GAIN_TABLE
}
 
enum  tenuM2mSigmaCmd {
  M2M_SIGMA_ENABLE = ((uint8) 3),
  M2M_SIGMA_TA_START,
  M2M_SIGMA_TA_STATS,
  M2M_SIGMA_TA_RECEIVE_STOP,
  M2M_SIGMA_ICMP_ARP,
  M2M_SIGMA_ICMP_RX,
  M2M_SIGMA_ICMP_TX,
  M2M_SIGMA_UDP_TX,
  M2M_SIGMA_UDP_TX_DEFER,
  M2M_SIGMA_SECURITY_POLICY,
  M2M_SIGMA_SET_SYSTIME
}
 This enum contains all the WINC commands related to Sigma. More...
 
enum  tenuM2mSsidMode {
  SSID_MODE_VISIBLE = 0,
  SSID_MODE_HIDDEN
}
 
enum  tenuM2mStaCmd {
  M2M_WIFI_REQ_CONNECT = M2M_STA_CMD_BASE,
  M2M_WIFI_REQ_DEFAULT_CONNECT,
  M2M_WIFI_RESP_DEFAULT_CONNECT,
  M2M_WIFI_REQ_DISCONNECT,
  M2M_WIFI_RESP_CON_STATE_CHANGED,
  M2M_WIFI_REQ_SLEEP,
  M2M_WIFI_REQ_WPS_SCAN,
  M2M_WIFI_REQ_WPS,
  M2M_WIFI_REQ_START_WPS,
  M2M_WIFI_REQ_DISABLE_WPS,
  M2M_WIFI_REQ_DHCP_CONF,
  M2M_WIFI_RESP_IP_CONFIGURED,
  M2M_WIFI_RESP_IP_CONFLICT,
  M2M_WIFI_REQ_ENABLE_MONITORING,
  M2M_WIFI_REQ_DISABLE_MONITORING,
  M2M_WIFI_RESP_WIFI_RX_PACKET,
  M2M_WIFI_REQ_SEND_WIFI_PACKET,
  M2M_WIFI_REQ_LSN_INT,
  M2M_WIFI_REQ_DOZE,
  M2M_WIFI_REQ_GET_PRNG,
  M2M_WIFI_RESP_GET_PRNG,
  M2M_WIFI_REQ_CONN,
  M2M_WIFI_IND_CONN_PARAM,
  M2M_WIFI_MAX_STA_ALL
}
 This enum contains WINC commands while in Station mode. More...
 
enum  tenuM2mTxPwrLevel {
  TX_PWR_HIGH = ((uint8) 1),
  TX_PWR_MED,
  TX_PWR_LOW
}
 
enum  tenuM2mWepKeyIndex {
  M2M_WIFI_WEP_KEY_INDEX_1 = ((uint8) 1),
  M2M_WIFI_WEP_KEY_INDEX_2,
  M2M_WIFI_WEP_KEY_INDEX_3,
  M2M_WIFI_WEP_KEY_INDEX_4
}
 
enum  tenuM2mWifiMode {
  M2M_WIFI_MODE_NORMAL = ((uint8) 1),
  M2M_WIFI_MODE_CONFIG,
  M2M_WIFI_MODE_ETHERNET,
  M2M_WIFI_MODE_MAX
}
 This enum contains all the supported Wi-Fi Operation Modes. More...
 
enum  tenuPowerSaveModes {
  M2M_NO_PS,
  M2M_PS_AUTOMATIC,
  M2M_PS_H_AUTOMATIC,
  M2M_PS_DEEP_AUTOMATIC,
  M2M_PS_MANUAL
}
 This enum contains all the supported Wi-Fi Power Save modes. More...
 
enum  tenuRootCertPubKeyType {
  ROOT_CERT_PUBKEY_RSA = 1,
  ROOT_CERT_PUBKEY_ECDSA = 2
}
 This enum contains the supported public key types for TLS root certificates. More...
 
enum  tenuSNTPUseDHCP {
  SNTP_DISABLE_DHCP = 0,
  SNTP_ENABLE_DHCP = 1
}
 Use NTP server provided by the DHCP server. More...
 
enum  tenuTlsCertExpSettings {
  TLS_CERT_EXP_CHECK_DISABLE,
  TLS_CERT_EXP_CHECK_ENABLE,
  TLS_CERT_EXP_CHECK_EN_IF_SYS_TIME
}
 TLS Certificate Expiry Validation Options. More...
 
enum  tenuWifiState {
  WIFI_STATE_DEINIT,
  WIFI_STATE_INIT,
  WIFI_STATE_START
}
 Enumeration for Wi-Fi state The following is used to track the state of the wifi (not initialized, initialized or started) More...
 
enum  tenuWPSTrigger {
  WPS_PIN_TRIGGER = 0,
  WPS_PBC_TRIGGER = 4
}
 This enum contains the WPS triggering methods. More...
 

Remarks
Enumerator
WIFI_1X_BYPASS_SERVER_AUTH 

Server authentication for 802.1x connections. Values are of type int.
0: Authenticate server; Default, Recommended.
1: Bypass server authentication.

WIFI_1X_TIME_VERIF_MODE 

Mode for checking expiry of server certificate chain. Values are of type tenuTlsCertExpSettings. Default is TLS_CERT_EXP_CHECK_EN_IF_SYS_TIME.

WIFI_1X_SESSION_CACHING 

TLS session caching on/off for 802.1x connections. Values are of type int.
0: Session caching off.
1: Session caching on; Default.
Note that the WINC implementation of PEAPv0 does not support session caching; this setting is ignored for PEAPv0 methods.

WIFI_1X_SPECIFIC_ROOTCERT 

SHA1 digest of subject name of the root certificate to be used during server authentication. Values are:
20-byte arrays: authentication is limited to this particular root certificate; Recommended
0-byte array: authentication can succeed with any certificate in the WINC root certificate store; Default.

Remarks
Enumerator
WIFI_CRED_DONTSAVE 

Credentials will not be stored in WINC flash.

WIFI_CRED_SAVE_UNENCRYPTED 

Credentials will be stored unencrypted in WINC flash.

WIFI_CRED_SAVE_ENCRYPTED 

Credentials will be stored encrypted in WINC flash. The encryption is not secure; it is merely intended to prevent sensitive information being leaked by an opportunistic read of WINC flash contents. The encryption keys involve WINC efuse contents, so WINC efuses should not be written while this option is in use.

This enum contains WINC commands while in AP mode.

Enumerator
M2M_WIFI_REQ_ENABLE_AP_LEGACY 

Request to enable AP mode.

M2M_WIFI_REQ_DISABLE_AP 

Request to disable AP mode.

M2M_WIFI_REQ_ENABLE_AP 

Request to enable AP mode.

M2M_WIFI_MAX_AP_ALL 

This enum contains host commands used to configure the WINC board.

Enumerator
M2M_WIFI_REQ_RESTART 

Restart the WINC MAC layer, it's doesn't restart the IP layer.

M2M_WIFI_REQ_SET_MAC_ADDRESS 

Set the WINC mac address (not possible for production effused boards).

M2M_WIFI_REQ_CURRENT_RSSI 

Request the current connected AP RSSI.

M2M_WIFI_RESP_CURRENT_RSSI 

Response to M2M_WIFI_REQ_CURRENT_RSSI with the RSSI value.

M2M_WIFI_REQ_RESTRICT_BLE 

Request restrict ble.

M2M_WIFI_REQ_UNRESTRICT_BLE 

Request unrestrict ble.

M2M_WIFI_REQ_GET_CONN_INFO 

Request connection information.

M2M_WIFI_RESP_CONN_INFO 

Response to M2M_WIFI_REQ_GET_CONN_INFO with the connection information.

M2M_WIFI_REQ_SET_DEVICE_NAME 

Request to set WINC device name property.

M2M_WIFI_REQ_START_PROVISION_MODE_LEGACY 

Request to start provisioning mode.

M2M_WIFI_RESP_PROVISION_INFO 

Response to the host with the provisioning information.

M2M_WIFI_REQ_STOP_PROVISION_MODE 

Request to stop provision mode.

M2M_WIFI_REQ_SET_SYS_TIME 

Request to set system time.

M2M_WIFI_REQ_ENABLE_SNTP_CLIENT 

Request to enable the simple network time protocol to get the time from the Internet. This is required for security purposes.

M2M_WIFI_REQ_DISABLE_SNTP_CLIENT 

Request to disable the simple network time protocol for applications that do not need it.

M2M_WIFI_RESP_MEMORY_RECOVER 

Reserved for debugging

M2M_WIFI_REQ_CUST_INFO_ELEMENT 

Request to add custom information to the Beacons IE.

M2M_WIFI_REQ_SCAN 

Request scan command.

M2M_WIFI_RESP_SCAN_DONE 

Response to notify scan complete.

M2M_WIFI_REQ_SCAN_RESULT 

Request for scan results.

M2M_WIFI_RESP_SCAN_RESULT 

Response to provide the scan results.

M2M_WIFI_REQ_SET_SCAN_OPTION 

Request to set scan options "slot time, slot number .. etc".

M2M_WIFI_REQ_SET_SCAN_REGION 

Request to set scan region.

M2M_WIFI_REQ_SET_POWER_PROFILE 

Request to set the Power Profile.

M2M_WIFI_REQ_SET_TX_POWER 

Request to set the TX Power.

M2M_WIFI_REQ_SET_BATTERY_VOLTAGE 

Request to set the Battery Voltage.

M2M_WIFI_REQ_SET_ENABLE_LOGS 

Request to enable logs.

M2M_WIFI_REQ_GET_SYS_TIME 

Request to get system time.

M2M_WIFI_RESP_GET_SYS_TIME 

Response to retrieve the system time.

M2M_WIFI_REQ_SEND_ETHERNET_PACKET 

Request to send Ethernet packet in bypass mode.

M2M_WIFI_RESP_ETHERNET_RX_PACKET 

Response to receive an Ethernet packet in bypass mode.

M2M_WIFI_REQ_SET_MAC_MCAST 

Request to set multicast filters.

M2M_WIFI_REQ_BLE_API_SEND 

Request to send an Encapsulated BLE API MSG

M2M_WIFI_RESP_BLE_API_RECV 

Response to receive an Encapsulated BLE API MSG

M2M_WIFI_REQ_SET_GAIN_TABLE 

Request to use Gain table from Flash

M2M_WIFI_RESP_SET_GAIN_TABLE 

Response to fail to use Gain table from Flash

M2M_WIFI_REQ_PASSIVE_SCAN 

Request a passive scan.

M2M_WIFI_REQ_CONFIG_SNTP 

Configure NTP servers.

M2M_WIFI_REQ_START_PROVISION_MODE 

Request to start provisioning mode.

M2M_WIFI_MAX_CONFIG_ALL 
Enumerator
M2M_ERR_SCAN_FAIL 

Failure to perform the scan operation.

M2M_ERR_JOIN_FAIL 

Failure to join the BSS.

M2M_ERR_AUTH_FAIL 

Failure to authenticate with the AP.

M2M_ERR_ASSOC_FAIL 

Failure to associate with the AP.

M2M_ERR_CONN_INPROGRESS 

Failure due to another connection being in progress.

This enum contains all the Wi-Fi connection states.

Enumerator
M2M_WIFI_DISCONNECTED 

Wi-Fi state is disconnected.

M2M_WIFI_CONNECTED 

Wi-Fi state is connected.

M2M_WIFI_ROAMED 

Wi-Fi state is roamed to new AP.

M2M_WIFI_UNDEF 

Undefined Wi-Fi State.

Enumerator
M2M_DEFAULT_CONN_INPROGRESS 

Failure response due to another connection being already in progress

M2M_DEFAULT_CONN_FAIL 

Failure to connect to the cached network

M2M_DEFAULT_CONN_SCAN_MISMATCH 

Failure to find any of the cached networks in the scan results.

M2M_DEFAULT_CONN_EMPTY_LIST 

Failure due to empty network list.

This enum contains additional WINC commands (overflow of previous enums).

Enumerator
M2M_WIFI_REQRSP_DELETE_APID 

Request/response to delete security credentials from WINC flash. (Processing matches tenuM2mConfigCmd.)

M2M_WIFI_REQ_ROAMING 

Request to enable/disable wifi roaming. (Processing matches tenuM2mConfigCmd.)

M2M_WIFI_REQ_SCAN_SSID_LIST 

Request scan with list of hidden SSID plus the broadcast scan.

M2M_WIFI_REQ_SET_STOP_SCAN_OPTION 

Set Scan option to stop on first result. (Processing matches tenuM2mConfigCmd.)

M2M_WIFI_MAX_GEN_ALL 

This enum contains all the WINC commands related to IP.

Enumerator
M2M_IP_REQ_STATIC_IP_CONF 

Request to set static IP.

M2M_IP_REQ_ENABLE_DHCP 

Request to enable DHCP.

M2M_IP_REQ_DISABLE_DHCP 

Request to disable DHCP.

This enum contains WINC commands while in P2P mode.

Enumerator
M2M_WIFI_REQ_P2P_INT_CONNECT 

This command is for internal use by the WINC and should not be used by the host driver.

M2M_WIFI_REQ_ENABLE_P2P 

Request to enable P2P mode.

M2M_WIFI_REQ_DISABLE_P2P 

Request to disable P2P mode.

M2M_WIFI_REQ_P2P_REPOST 

This command is for internal use by the WINC and should not be used by the host driver.

M2M_WIFI_MAX_P2P_ALL 
Enumerator
PWR_AUTO 

Automatic power mode.

PWR_LOW1 

Low power mode #1. RX current 60mA.

PWR_LOW2 

Low power mode #2, RX current 55mA, sensitivity is less by 3dBm

PWR_HIGH 

High power mode: RX current 100mA.

Enumerator
M2M_REQ_GROUP_MAIN 
M2M_REQ_GROUP_WIFI 
M2M_REQ_GROUP_IP 
M2M_REQ_GROUP_HIF 
M2M_REQ_GROUP_OTA 
M2M_REQ_GROUP_SSL 
M2M_REQ_GROUP_SIGMA 
M2M_REQ_GROUP_INTERNAL 
Enumerator
M2M_REQ_CONFIG_PKT 
M2M_REQ_DATA_PKT 

This enum contains all the Wi-Fi RF channels.

Enumerator
M2M_WIFI_CH_1 

Channel 1.

M2M_WIFI_CH_2 

Channel 2.

M2M_WIFI_CH_3 

Channel 3.

M2M_WIFI_CH_4 

Channel 4.

M2M_WIFI_CH_5 

Channel 5.

M2M_WIFI_CH_6 

Channel 6.

M2M_WIFI_CH_7 

Channel 7.

M2M_WIFI_CH_8 

Channel 8.

M2M_WIFI_CH_9 

Channel 9.

M2M_WIFI_CH_10 

Channel 10.

M2M_WIFI_CH_11 

Channel 11.

M2M_WIFI_CH_12 

Channel 12.

M2M_WIFI_CH_13 

Channel 13.

M2M_WIFI_CH_14 

Channel 14.

M2M_WIFI_CH_ALL 

This enum contains all the Wi-Fi channel regions.

Enumerator
REG_CH_1 

Region channel 1.

REG_CH_2 

Region channel 2.

REG_CH_3 

Region channel 3.

REG_CH_4 

Region channel 4.

REG_CH_5 

Region channel 5.

REG_CH_6 

Region channel 6.

REG_CH_7 

Region channel 7.

REG_CH_8 

Region channel 8.

REG_CH_9 

Region channel 9.

REG_CH_10 

Region channel 10.

REG_CH_11 

Region channel 11.

REG_CH_12 

Region channel 12.

REG_CH_13 

Region channel 13.

REG_CH_14 

Region channel 14.

REG_CH_ALL 

Region for all channels.

NORTH_AMERICA 

North America region with 11 channels

EUROPE 

Europe region with 13 channels

ASIA 

Asia region with 14 channels

This enum contains all the supported Wi-Fi security types.

This enum contains all the supported Wi-Fi SSID types.

Enumerator
M2M_WIFI_SEC_INVALID 

Invalid security type.

M2M_WIFI_SEC_OPEN 

Wi-Fi network is not secured.

M2M_WIFI_SEC_WPA_PSK 

Wi-Fi network is secured with WPA/WPA2 personal(PSK).

M2M_WIFI_SEC_WEP 

Security type WEP (40 or 104) OPEN OR SHARED.

M2M_WIFI_SEC_802_1X 

Wi-Fi network is secured with WPA/WPA2 Enterprise.IEEE802.1x.

M2M_WIFI_NUM_AUTH_TYPES 

Upper limit for enum value.

These commands are currently not supported.

Enumerator
M2M_WIFI_REQ_CLIENT_CTRL 

Currently not supported.

M2M_WIFI_RESP_CLIENT_INFO 

Currently not supported.

M2M_WIFI_REQ_SERVER_INIT 

Currently not supported.

M2M_WIFI_MAX_SERVER_ALL 
Enumerator
M2M_ERR_GAIN_TABLE_INVALID 

Failure response due to trying to use an invalid table

M2M_ERR_READ_GAIN_TABLE 

Failure to read gains from flash

This enum contains all the WINC commands related to Sigma.

Enumerator
M2M_SIGMA_ENABLE 

Enable Sigma.

M2M_SIGMA_TA_START 

Start the traffic agent.

M2M_SIGMA_TA_STATS 

Get traffic statistics.

M2M_SIGMA_TA_RECEIVE_STOP 

Stop receiving from the traffic agent.

M2M_SIGMA_ICMP_ARP 

Send ARP.

M2M_SIGMA_ICMP_RX 

Receive ICMP.

M2M_SIGMA_ICMP_TX 

Transmit ICMP.

M2M_SIGMA_UDP_TX 

Transmit UDP.

M2M_SIGMA_UDP_TX_DEFER 

Transmit UDP defer.

M2M_SIGMA_SECURITY_POLICY 

Set security policy.

M2M_SIGMA_SET_SYSTIME 

Set system time.

Enumerator
SSID_MODE_VISIBLE 

SSID is visible to others.

SSID_MODE_HIDDEN 

SSID is hidden.

This enum contains WINC commands while in Station mode.

Enumerator
M2M_WIFI_REQ_CONNECT 

Request to connect with a specified AP. This command is deprecated in favour of M2M_WIFI_REQ_CONN.

M2M_WIFI_REQ_DEFAULT_CONNECT 

Request to connect with a cached AP.

M2M_WIFI_RESP_DEFAULT_CONNECT 

Response for the default connect.

M2M_WIFI_REQ_DISCONNECT 

Request to disconnect from the AP.

M2M_WIFI_RESP_CON_STATE_CHANGED 

Response to indicate a change in the connection state.

M2M_WIFI_REQ_SLEEP 

Request to sleep.

M2M_WIFI_REQ_WPS_SCAN 

Request to WPS scan.

M2M_WIFI_REQ_WPS 

Request to start WPS.

M2M_WIFI_REQ_START_WPS 

This command is for internal use by the WINC and should not be used by the host driver.

M2M_WIFI_REQ_DISABLE_WPS 

Request to disable WPS.

M2M_WIFI_REQ_DHCP_CONF 

Response to indicate the obtained IP address.

M2M_WIFI_RESP_IP_CONFIGURED 

This command is for internal use by the WINC and should not be used by the host driver.

M2M_WIFI_RESP_IP_CONFLICT 

Response to indicate a conflict in obtained IP address. The user should re attempt the DHCP request.

M2M_WIFI_REQ_ENABLE_MONITORING 

Request to enable monitor mode.

M2M_WIFI_REQ_DISABLE_MONITORING 

Request to disable monitor mode.

M2M_WIFI_RESP_WIFI_RX_PACKET 

Response to indicate a packet was received in monitor mode.

M2M_WIFI_REQ_SEND_WIFI_PACKET 

Request to send a packet in monitor mode.

M2M_WIFI_REQ_LSN_INT 

Request to set the listen interval.

M2M_WIFI_REQ_DOZE 

Request to doze

M2M_WIFI_REQ_GET_PRNG 

Request PRNG.

M2M_WIFI_RESP_GET_PRNG 

Response for PRNG.

M2M_WIFI_REQ_CONN 

New command to connect with AP. This replaces M2M_WIFI_REQ_CONNECT. (Firmware continues to handle M2M_WIFI_REQ_CONNECT for backwards compatibility purposes.)

M2M_WIFI_IND_CONN_PARAM 

Provide extra information (such as Enterprise client certificate) required for connection.

M2M_WIFI_MAX_STA_ALL 
Enumerator
TX_PWR_HIGH 

PPA Gain 6dbm PA Gain 18dbm

TX_PWR_MED 

PPA Gain 6dbm PA Gain 12dbm

TX_PWR_LOW 

PPA Gain 6dbm PA Gain 6dbm

Enumerator
M2M_WIFI_WEP_KEY_INDEX_1 

Index 1 for WEP key Authentication

M2M_WIFI_WEP_KEY_INDEX_2 

Index 2 for WEP key Authentication

M2M_WIFI_WEP_KEY_INDEX_3 

Index 3 for WEP key Authentication

M2M_WIFI_WEP_KEY_INDEX_4 

Index 4 for WEP key Authentication

This enum contains all the supported Wi-Fi Operation Modes.

Enumerator
M2M_WIFI_MODE_NORMAL 

Customer firmware.

M2M_WIFI_MODE_CONFIG 

Production test firmware.

M2M_WIFI_MODE_ETHERNET 

Ethernet Mode

M2M_WIFI_MODE_MAX 

This enum contains all the supported Wi-Fi Power Save modes.

Enumerator
M2M_NO_PS 

Power save is disabled.

M2M_PS_AUTOMATIC 
M2M_PS_H_AUTOMATIC 

This powersave mode is not supported on WINC3400

M2M_PS_DEEP_AUTOMATIC 

This powersave mode is not supported on WINC3400 Power save is done automatically by the WINC. Achieves the highest possible power save.

M2M_PS_MANUAL 

This powersave mode is not supported on WINC3400

This enum contains the supported public key types for TLS root certificates.

Enumerator
ROOT_CERT_PUBKEY_RSA 

RSA public key.

ROOT_CERT_PUBKEY_ECDSA 

ECDSA public key.

Use NTP server provided by the DHCP server.

Enumerator
SNTP_DISABLE_DHCP 

Don't use the NTP server provided by the DHCP server when falling back.

SNTP_ENABLE_DHCP 

Use the NTP server provided by the DHCP server when falling back.

TLS Certificate Expiry Validation Options.

Remarks
Enumerator
TLS_CERT_EXP_CHECK_DISABLE 

Certificate expiry is not checked. Server authentication does not depend on expiry of certificates.

TLS_CERT_EXP_CHECK_ENABLE 

Certificate expiry is checked and current time is required. Server authentication fails if a certificate has expired or the current time is unknown.

TLS_CERT_EXP_CHECK_EN_IF_SYS_TIME 

Certificate expiry is only checked if current time is known. Server authentication fails if a certificate has expired; passes if the current time is unknown.

Enumeration for Wi-Fi state The following is used to track the state of the wifi (not initialized, initialized or started)

Remarks
This is useful when putting the WINC in "download mode" to access the flash via SPI. By using m2m_wifi_get_state and checking against the desired state, it is possible to validate if the Application can proceed with the WINC flash access or not.
Enumerator
WIFI_STATE_DEINIT 

Wifi is not initialized

WIFI_STATE_INIT 

Wifi has been initialized. WINC flash access is possible via m2m_flash APIs.

WIFI_STATE_START 

Wifi has started

This enum contains the WPS triggering methods.

Enumerator
WPS_PIN_TRIGGER 

WPS is triggered in PIN method.

WPS_PBC_TRIGGER 

WPS is triggered via push button.