Typedefs | Enumerations
Enumeration/Typedefs
Collaboration diagram for Enumeration/Typedefs:

Typedefs

typedef void(* tpfAppEthCb) (uint8 u8MsgType, void *pvMsg, void *pvCtrlBuf)
 Ethernet (Bypass mode) notification callback function receiving Bypass mode events as defined in the Wi-Fi responses enumeration tenuM2mStaCmd. More...
 
typedef void(* tpfAppMonCb) (tstrM2MWifiRxPacketInfo *pstrWifiRxPacket, uint8 *pu8Payload, uint16 u16PayloadSize)
 Wi-Fi monitoring mode callback function. This function delivers all received wi-Fi packets to the application. Applications requiring to operate in the monitoring shall call the function m2m_wifi_enable_monitoring_mode, each frame received will invoke a single call to this callback function. Monitoring mode may be disabled by calling m2m_wifi_disable_monitoring_mode. More...
 
typedef void(* tpfAppWifiCb) (uint8 u8MsgType, void *pvMsg)
 This is the main callback function for the Wi-Fi driver and is responsible for processing any M2M_WIFI events that are received on the Wi-Fi interface. These events (notifications) are usually received in response to earlier Wi-Fi requests such as m2m_wifi_request_scan, and m2m_wifi_connect. More...
 

Enumerations

enum  tenuInfoElementId {
  ISSID = 0, ISUPRATES = 1, IFHPARMS = 2, IDSPARMS = 3,
  ICFPARMS = 4, ITIM = 5, IIBPARMS = 6, ICOUNTRY = 7,
  IEDCAPARAMS = 12, ITSPEC = 13, ITCLAS = 14, ISCHED = 15,
  ICTEXT = 16, IPOWERCONSTRAINT = 32, IPOWERCAPABILITY = 33, ITPCREQUEST = 34,
  ITPCREPORT = 35, ISUPCHANNEL = 36, ICHSWANNOUNC = 37, IMEASUREMENTREQUEST = 38,
  IMEASUREMENTREPORT = 39, IQUIET = 40, IIBSSDFS = 41, IERPINFO = 42,
  ITSDELAY = 43, ITCLASPROCESS = 44, IHTCAP = 45, IQOSCAP = 46,
  IRSNELEMENT = 48, IEXSUPRATES = 50, IEXCHSWANNOUNC = 60, IHTOPERATION = 61,
  ISECCHOFF = 62, I2040COEX = 72, I2040INTOLCHREPORT = 73, IOBSSSCAN = 74,
  IEXTCAP = 127, IWMM = 221, IWPAELEMENT = 221
}
 Enumeration for the Wi-Fi Information Element(IE) IDs, which indicates the specific type of IEs. IEs are management frame information included in management frames. More...
 
enum  tenuM2mApCmd { M2M_WIFI_REQ_ENABLE_AP = M2M_AP_CMD_BASE, M2M_WIFI_REQ_DISABLE_AP, M2M_WIFI_MAX_AP_ALL }
 This enum contains all the 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, 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_MAX_CONFIG_ALL
}
 This enum contains all the 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_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  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 all the 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
}
 
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
}
 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  tenuM2mSslCmd {
  M2M_SSL_REQ_CERT_VERIF, M2M_SSL_REQ_ECC, M2M_SSL_RESP_ECC, M2M_SSL_RSV,
  M2M_SSL_REQ_WRITE_OWN_CERTS, M2M_SSL_REQ_SET_CS_LIST, M2M_SSL_RESP_SET_CS_LIST, M2M_SSL_RESP_WRITE_OWN_CERTS
}
 This enum contains WINC commands related to TLS handshake. More...
 
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_MAX_STA_ALL
}
 This enum contains all the 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 }
 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  tenuSubTypes {
  ASSOC_REQ = 0x00, ASSOC_RSP = 0x10, REASSOC_REQ = 0x20, REASSOC_RSP = 0x30,
  PROBE_REQ = 0x40, PROBE_RSP = 0x50, BEACON = 0x80, ATIM = 0x90,
  DISASOC = 0xA0, AUTH = 0xB0, DEAUTH = 0xC0, ACTION = 0xD0,
  PS_POLL = 0xA4, RTS = 0xB4, CTS = 0xC4, ACK = 0xD4,
  CFEND = 0xE4, CFEND_ACK = 0xF4, BLOCKACK_REQ = 0x84, BLOCKACK = 0x94,
  DATA = 0x08, DATA_ACK = 0x18, DATA_POLL = 0x28, DATA_POLL_ACK = 0x38,
  NULL_FRAME = 0x48, CFACK = 0x58, CFPOLL = 0x68, CFPOLL_ACK = 0x78,
  QOS_DATA = 0x88, QOS_DATA_ACK = 0x98, QOS_DATA_POLL = 0xA8, QOS_DATA_POLL_ACK = 0xB8,
  QOS_NULL_FRAME = 0xC8, QOS_CFPOLL = 0xE8, QOS_CFPOLL_ACK = 0xF8
}
 Enumeration for Wi-Fi MAC Frame subtype code (6-bit). The frame subtypes fall into one of the three frame type groups as defined in tenuWifiFrameType (MANAGEMENT, CONTROL & DATA). More...
 
enum  tenuWifiCapability {
  ESS = 0x01, IBSS = 0x02, POLLABLE = 0x04, POLLREQ = 0x08,
  PRIVACY = 0x10, SHORTPREAMBLE = 0x20, SHORTSLOT = 0x400, PBCC = 0x40,
  CHANNELAGILITY = 0x80, SPECTRUM_MGMT = 0x100, DSSS_OFDM = 0x2000
}
 Enumeration for capability Information field bit. The value of the capability information field from the 802.11 management frames received by the wireless LAN interface. Defining the capabilities of the Wi-Fi system. More...
 
enum  tenuWifiFrameType { MANAGEMENT = 0x00, CONTROL = 0x04, DATA_BASICTYPE = 0x08, RESERVED = 0x0C }
 Enumeration for Wi-Fi MAC frame type codes (2-bit) The following types are used to identify the type of frame sent or received. Each frame type constitutes a number of frame subtypes as defined in tenuSubTypes to specify the exact type of frame. More...
 
enum  tenuWPSTrigger { WPS_PIN_TRIGGER = 0, WPS_PBC_TRIGGER = 4 }
 This enum contains the WPS triggering methods. More...
 

Detailed Description

Typedef Documentation

◆ tpfAppEthCb

tpfAppEthCb

Ethernet (Bypass mode) notification callback function receiving Bypass mode events as defined in the Wi-Fi responses enumeration tenuM2mStaCmd.

If bypass mode is enabled, applications must ensure this callback function is registered with the Wi-Fi driver by calling m2m_wifi_init.

Parameters
[in]u8MsgTypeType of notification. Possible types are:
[in]pvMsgA pointer to a buffer containing the notification parameters (if any). This must be casted to the data type uint8 *.
[in]pvControlBufA pointer to control buffer describing the accompanied message. This must be casted to the data type tstrM2mIpCtrlBuf.
See also
m2m_wifi_init

Definition at line 300 of file m2m_wifi.h.

◆ tpfAppMonCb

tpfAppMonCb

Wi-Fi monitoring mode callback function. This function delivers all received wi-Fi packets to the application. Applications requiring to operate in the monitoring shall call the function m2m_wifi_enable_monitoring_mode, each frame received will invoke a single call to this callback function. Monitoring mode may be disabled by calling m2m_wifi_disable_monitoring_mode.

Parameters
[in]pstrWifiRxPacketPointer to a structure holding the Wi-Fi packet header parameters.
[in]pu8PayloadPointer to the buffer holding the Wi-Fi packet payload information required by the application starting from the defined OFFSET by the application (when calling m2m_wifi_enable_monitoring_mode). Could hold a value of NULL, if the application does not need any data from the payload.
[in]u16PayloadSizeThe size of the payload in bytes.
See also
m2m_wifi_enable_monitoring_mode
Warning
u16PayloadSize may not exceed the buffer size given through m2m_wifi_enable_monitoring_mode.

Definition at line 330 of file m2m_wifi.h.

◆ tpfAppWifiCb

tpfAppWifiCb

This is the main callback function for the Wi-Fi driver and is responsible for processing any M2M_WIFI events that are received on the Wi-Fi interface. These events (notifications) are usually received in response to earlier Wi-Fi requests such as m2m_wifi_request_scan, and m2m_wifi_connect.

Most Wi-Fi APIs are asynchronous and calling them generates information that is passed back via this callback - for instance m2m_wifi_request_scan will return a set of detected networks.

Applications must ensure a callback function is registered with the Wi-Fi driver by calling m2m_wifi_init.

Parameters
[in]u8MsgTypeType of notification. Possible types are:
[in]pvMsgA pointer to a buffer containing the notification parameters (if any). It should be Casted to the data type associated with type of notification.
See also
tstrM2mWifiStateChanged tstrM2MWPSInfo tstrM2mScanDone tstrM2mWifiscanResult m2m_wifi_init

Definition at line 271 of file m2m_wifi.h.

Enumeration Type Documentation

◆ tenuInfoElementId

Enumeration for the Wi-Fi Information Element(IE) IDs, which indicates the specific type of IEs. IEs are management frame information included in management frames.

Values are defined as per the IEEE 802.11 standard.

Warning
This functionality is not supported by current WINC firmware.
Enumerator
ISSID 

Service Set Identifier (SSID)

ISUPRATES 

Supported Rates

IFHPARMS 

FH parameter set

IDSPARMS 

DS parameter set

ICFPARMS 

CF parameter set

ITIM 

Traffic Information Map

IIBPARMS 

IBSS parameter set

ICOUNTRY 

Country element.

IEDCAPARAMS 

EDCA parameter set

ITSPEC 

Traffic Specification

ITCLAS 

Traffic Classification

ISCHED 

Schedule.

ICTEXT 

Challenge Text

IPOWERCONSTRAINT 

Power Constraint.

IPOWERCAPABILITY 

Power Capability

ITPCREQUEST 

TPC Request

ITPCREPORT 

TPC Report

ISUPCHANNEL 

Supported channel list

ICHSWANNOUNC 

Channel Switch Announcement

IMEASUREMENTREQUEST 

Measurement request

IMEASUREMENTREPORT 

Measurement report

IQUIET 

Quiet element Info

IIBSSDFS 

IBSS DFS

IERPINFO 

ERP Information

ITSDELAY 

TS Delay

ITCLASPROCESS 

TCLAS Processing

IHTCAP 

HT Capabilities

IQOSCAP 

QoS Capability

IRSNELEMENT 

RSN Information Element

IEXSUPRATES 

Extended Supported Rates

IEXCHSWANNOUNC 

Extended Ch Switch Announcement

IHTOPERATION 

HT Information

ISECCHOFF 

Secondary Channel Offset

I2040COEX 

20/40 Coexistence IE

I2040INTOLCHREPORT 

20/40 Intolerant channel report

IOBSSSCAN 

OBSS Scan parameters

IEXTCAP 

Extended capability

IWMM 

WMM parameters

IWPAELEMENT 

WPA Information Element

Definition at line 157 of file m2m_wifi.h.

◆ tenuM2mApCmd

This enum contains all the WINC commands while in AP mode.

Enumerator
M2M_WIFI_REQ_ENABLE_AP 

Request to enable AP mode.

M2M_WIFI_REQ_DISABLE_AP 

Request to disable AP mode.

M2M_WIFI_MAX_AP_ALL 

Definition at line 680 of file m2m_types.h.

◆ tenuM2mConfigCmd

This enum contains all the 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 

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 debuging

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_MAX_CONFIG_ALL 

Definition at line 536 of file m2m_types.h.

◆ tenuM2mConnChangedErrcode

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.

Definition at line 466 of file m2m_types.h.

◆ tenuM2mConnState

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_UNDEF 

Undefined Wi-Fi State.

Definition at line 805 of file m2m_types.h.

◆ tenuM2mDefaultConnErrcode

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.

Definition at line 447 of file m2m_types.h.

◆ tenuM2mIpCmd

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.

Definition at line 738 of file m2m_types.h.

◆ tenuM2mP2pCmd

This enum contains all the 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 

Definition at line 695 of file m2m_types.h.

◆ tenuM2mPwrMode

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.

Definition at line 501 of file m2m_types.h.

◆ tenuM2mReqGroup

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 

Definition at line 401 of file m2m_types.h.

◆ tenuM2mReqpkt

Enumerator
M2M_REQ_CONFIG_PKT 
M2M_REQ_DATA_PKT 

Definition at line 417 of file m2m_types.h.

◆ tenuM2mScanCh

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 

Definition at line 856 of file m2m_types.h.

◆ tenuM2mScanRegion

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

Definition at line 895 of file m2m_types.h.

◆ tenuM2mSecType

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 user-name/password authentication.

Definition at line 821 of file m2m_types.h.

◆ tenuM2mServerCmd

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 

Definition at line 718 of file m2m_types.h.

◆ tenuM2mSetGainsErrcode

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

Definition at line 487 of file m2m_types.h.

◆ tenuM2mSigmaCmd

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

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.

Definition at line 754 of file m2m_types.h.

◆ tenuM2mSsidMode

Enumerator
SSID_MODE_VISIBLE 

SSID is visible to others.

SSID_MODE_HIDDEN 

SSID is hidden.

Definition at line 842 of file m2m_types.h.

◆ tenuM2mSslCmd

This enum contains WINC commands related to TLS handshake.

Enumerator
M2M_SSL_REQ_CERT_VERIF 
M2M_SSL_REQ_ECC 
M2M_SSL_RESP_ECC 
M2M_SSL_RSV 
M2M_SSL_REQ_WRITE_OWN_CERTS 
M2M_SSL_REQ_SET_CS_LIST 
M2M_SSL_RESP_SET_CS_LIST 
M2M_SSL_RESP_WRITE_OWN_CERTS 

Definition at line 786 of file m2m_types.h.

◆ tenuM2mStaCmd

This enum contains all the WINC commands while in Station mode.

Enumerator
M2M_WIFI_REQ_CONNECT 

Request to connect with an specified AP.

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_MAX_STA_ALL 

Definition at line 624 of file m2m_types.h.

◆ tenuM2mTxPwrLevel

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

Definition at line 519 of file m2m_types.h.

◆ tenuM2mWepKeyIndex

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

Definition at line 429 of file m2m_types.h.

◆ tenuM2mWifiMode

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

Enumerator
M2M_WIFI_MODE_NORMAL 

Customer firmware.

M2M_WIFI_MODE_CONFIG 

Production test firmware.

Definition at line 967 of file m2m_types.h.

◆ tenuPowerSaveModes

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 WINC3400Power save is done automatically by the WINC. Achieves the highest possible power save.

M2M_PS_MANUAL 

This powersave mode is not supported on WINC3400

Definition at line 942 of file m2m_types.h.

◆ tenuRootCertPubKeyType

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.

Definition at line 997 of file m2m_types.h.

◆ tenuSubTypes

Enumeration for Wi-Fi MAC Frame subtype code (6-bit). The frame subtypes fall into one of the three frame type groups as defined in tenuWifiFrameType (MANAGEMENT, CONTROL & DATA).

Values are defined as per the IEEE 802.11 standard.

Remarks
The following sub-frame types are useful for advanced user usage when symbol CONF_MGMT is defined and the application developer requires to monitor the frame transmission and reception.
Warning
This functionality is not supported by current WINC firmware.
See also
tenuWifiFrameType
Enumerator
ASSOC_REQ 

Management: Association Request

ASSOC_RSP 

Management: Association Response

REASSOC_REQ 

Management: Re-Association Request

REASSOC_RSP 

Management: Re-Association Response

PROBE_REQ 

Management: Probe Request

PROBE_RSP 

Management: Probe Response

BEACON 

Management: Beacon

ATIM 

Management: Announcement Traffic Information Map

DISASOC 

Management: Disassociation

AUTH 

Management: Authentication

DEAUTH 

Management: Deauthentication

ACTION 

Management: Action

PS_POLL 

Control: Power Save Poll

RTS 

Control: Request to Send

CTS 

Control: Clear to Send

ACK 

Control: Acknowledgement

CFEND 

Control: End of Contention Free Period

CFEND_ACK 

Control: ACK of data from STA + CFEND

BLOCKACK_REQ 

Control: Block Acknoweledgement Request

BLOCKACK 

Control: Block Acknowledgement

DATA 

Data: A non-QoS data frame

DATA_ACK 

Data: Data + CF-Ack

DATA_POLL 

Data: Data + CF-Poll

DATA_POLL_ACK 

Data: Data + CF-Ack + CF-Poll

NULL_FRAME 

Data: Null (no data)

CFACK 

Data: CF-Ack (no data)

CFPOLL 

Data: CF-Poll (no data)

CFPOLL_ACK 

Data: CF-Poll + CF-Ack (no data)

QOS_DATA 

Data: A QoS data frame

QOS_DATA_ACK 

Data: QoS data + CF-Ack

QOS_DATA_POLL 

Data: QoS data + CF-Poll

QOS_DATA_POLL_ACK 

Data: QoS data + CF-Ack + CF-Poll

QOS_NULL_FRAME 

Data: QoS Null (no data)

QOS_CFPOLL 

Data: Qos CF-Poll (no data)

QOS_CFPOLL_ACK 

Data: QoS CF-Poll + CF-Ack (no data)

Definition at line 100 of file m2m_wifi.h.

◆ tenuWifiCapability

Enumeration for capability Information field bit. The value of the capability information field from the 802.11 management frames received by the wireless LAN interface. Defining the capabilities of the Wi-Fi system.

Values are defined as per the IEEE 802.11 standard.

Warning
This functionality is not supported by current WINC firmware.
Enumerator
ESS 

ESS capability

IBSS 

IBSS mode

POLLABLE 

CF Pollable

POLLREQ 

Request to be polled

PRIVACY 

WEP encryption supported

SHORTPREAMBLE 

Short Preamble is supported

SHORTSLOT 

Short Slot is supported

PBCC 

PBCC

CHANNELAGILITY 

Channel Agility

SPECTRUM_MGMT 

Spectrum Management

DSSS_OFDM 

DSSS-OFDM

Definition at line 213 of file m2m_wifi.h.

◆ tenuWifiFrameType

Enumeration for Wi-Fi MAC frame type codes (2-bit) The following types are used to identify the type of frame sent or received. Each frame type constitutes a number of frame subtypes as defined in tenuSubTypes to specify the exact type of frame.

Values are defined as per the IEEE 802.11 standard.

Remarks
The following frame types are useful for advanced user usage when symbol CONF_MGMT is defined and the user application requires to monitor the frame transmission and reception.
Warning
This functionality is not supported by current WINC firmware.
See also
tenuSubTypes
Enumerator
MANAGEMENT 

Wi-Fi Management frame (Probe Req/Resp, Beacon, Association Req/Resp ...etc).

CONTROL 

Wi-Fi Control frame (eg. ACK frame).

DATA_BASICTYPE 

Wi-Fi Data frame.

RESERVED 

Definition at line 74 of file m2m_wifi.h.

◆ tenuWPSTrigger

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.

Definition at line 983 of file m2m_types.h.



inertial_sense_ros
Author(s):
autogenerated on Sat Sep 19 2020 03:19:07