Data Structures
struct	tstrM2mPwrMode

struct	tstrM2mTxPwrLevel

struct	tstrM2mEnableLogs

struct	tstrM2mBatteryVoltage

struct	tstrM2mWifiGainsParams

struct	tstrM2mWifiWepParams

struct	tstr1xAuthCredentials

union	tuniM2MWifiAuth

struct	tstrM2MWifiSecInfo

struct	tstrM2mWifiConnect

struct	tstrM2MWPSConnect

struct	tstrM2MWPSInfo

struct	tstrM2MDefaultConnResp

struct	tstrM2MScanOption

struct	tstrM2MScanRegion

struct	tstrM2MScan

struct	tstrCyptoResp

struct	tstrM2mScanDone

struct	tstrM2mReqScanResult

struct	tstrM2mWifiscanResult

struct	tstrM2mWifiStateChanged

struct	tstrM2mPsType

struct	tstrM2mSlpReqTime

struct	tstrM2mLsnInt

struct	tstrM2MWifiMonitorModeCtrl

struct	tstrM2MWifiRxPacketInfo

struct	tstrM2MWifiTxPacketInfo

struct	tstrM2MP2PConnect

struct	tstrM2MAPConfig

struct	tstrM2mServerInit

struct	tstrM2mClientState

struct	tstrM2Mservercmd

struct	tstrM2mSetMacAddress

struct	tstrM2MDeviceNameConfig

struct	tstrM2MIPConfig

struct	tstrM2mIpRsvdPkt

struct	tstrM2MProvisionModeConfig

struct	tstrM2MProvisionInfo

struct	tstrM2MConnInfo

struct	tstrOtaInitHdr

struct	tstrOtaControlSec

struct	tstrOtaUpdateStatusResp

struct	tstrOtaUpdateInfo

struct	tstrSystemTime

struct	tstrM2MMulticastMac

struct	tstrPrng

struct	tstrTlsCrlEntry

struct	tstrTlsCrlInfo

struct	tstrTlsSrvSecFileEntry

struct	tstrTlsSrvSecHdr

struct	tstrSslSetActiveCsList

struct	tstrM2mPwrState

Typedefs
typedef void(*	tpfOtaNotifCb) (tstrOtaUpdateInfo *pstrOtaUpdateInfo)

typedef void(*	tpfOtaUpdateCb) (uint8 u8OtaUpdateStatusType, uint8 u8OtaUpdateStatus)

Enumerations
enum	tenuOtaError { OTA_SUCCESS = (0), OTA_ERR_WORKING_IMAGE_LOAD_FAIL = ((sint8) -1), OTA_ERR_INVAILD_CONTROL_SEC = ((sint8) -2), M2M_ERR_OTA_SWITCH_FAIL = ((sint8) -3), M2M_ERR_OTA_START_UPDATE_FAIL = ((sint8) -4), M2M_ERR_OTA_ROLLBACK_FAIL = ((sint8) -5), M2M_ERR_OTA_INVAILD_FLASH_SIZE = ((sint8) -6), M2M_ERR_OTA_INVAILD_ARG = ((sint8) -7), M2M_ERR_OTA_INPROGRESS = ((sint8) -8) }

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	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	tenuM2mPwrMode { PWR_AUTO = ((uint8) 1), PWR_LOW1, PWR_LOW2, PWR_HIGH }

enum	tenuM2mTxPwrLevel { TX_PWR_HIGH = ((uint8) 1), TX_PWR_MED, TX_PWR_LOW }

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_CRYPTO, M2M_REQ_GROUP_SIGMA }

enum	tenuM2mReqpkt { M2M_REQ_CONFIG_PKT, M2M_REQ_DATA_PKT = 0x80 }

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_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_GET_PRNG, M2M_WIFI_RESP_GET_PRNG, M2M_WIFI_REQ_SCAN_SSID_LIST, M2M_WIFI_REQ_SET_GAINS, M2M_WIFI_REQ_PASSIVE_SCAN, M2M_WIFI_MAX_CONFIG_ALL }

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_MAX_STA_ALL }

enum	tenuM2mApCmd { M2M_WIFI_REQ_ENABLE_AP = M2M_AP_CMD_BASE, M2M_WIFI_REQ_DISABLE_AP, M2M_WIFI_REQ_RESTART_AP, M2M_WIFI_MAX_AP_ALL }

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 }

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 }

enum	tenuM2mOtaCmd { M2M_OTA_REQ_NOTIF_SET_URL = M2M_OTA_CMD_BASE, M2M_OTA_REQ_NOTIF_CHECK_FOR_UPDATE, M2M_OTA_REQ_NOTIF_SCHED, M2M_OTA_REQ_START_FW_UPDATE, M2M_OTA_REQ_SWITCH_FIRMWARE, M2M_OTA_REQ_ROLLBACK_FW, M2M_OTA_RESP_NOTIF_UPDATE_INFO, M2M_OTA_RESP_UPDATE_STATUS, M2M_OTA_REQ_TEST, M2M_OTA_REQ_START_CRT_UPDATE, M2M_OTA_REQ_SWITCH_CRT_IMG, M2M_OTA_REQ_ROLLBACK_CRT, M2M_OTA_REQ_ABORT, M2M_OTA_MAX_ALL }

enum	tenuM2mCryptoCmd { M2M_CRYPTO_REQ_SHA256_INIT = M2M_CRYPTO_CMD_BASE, M2M_CRYPTO_RESP_SHA256_INIT, M2M_CRYPTO_REQ_SHA256_UPDATE, M2M_CRYPTO_RESP_SHA256_UPDATE, M2M_CRYPTO_REQ_SHA256_FINSIH, M2M_CRYPTO_RESP_SHA256_FINSIH, M2M_CRYPTO_REQ_RSA_SIGN_GEN, M2M_CRYPTO_RESP_RSA_SIGN_GEN, M2M_CRYPTO_REQ_RSA_SIGN_VERIFY, M2M_CRYPTO_RESP_RSA_SIGN_VERIFY, M2M_CRYPTO_MAX_ALL }

enum	tenuM2mIpCmd { M2M_IP_REQ_STATIC_IP_CONF = ((uint8) 10), M2M_IP_REQ_ENABLE_DHCP, M2M_IP_REQ_DISABLE_DHCP }

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 }

enum	tenuM2mSslCmd { M2M_SSL_REQ_CERT_VERIF, M2M_SSL_REQ_ECC, M2M_SSL_RESP_ECC, M2M_SSL_IND_CRL, M2M_SSL_IND_CERTS_ECC, M2M_SSL_REQ_SET_CS_LIST, M2M_SSL_RESP_SET_CS_LIST }

enum	tenuM2mConnState { M2M_WIFI_DISCONNECTED = 0, M2M_WIFI_CONNECTED, M2M_WIFI_UNDEF = 0xff }

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 }

enum	tenuM2mSsidMode { SSID_MODE_VISIBLE = 0, SSID_MODE_HIDDEN }

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) }

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) }

enum	tenuPowerSaveModes { M2M_NO_PS, M2M_PS_AUTOMATIC, M2M_PS_H_AUTOMATIC, M2M_PS_DEEP_AUTOMATIC, M2M_PS_MANUAL }

enum	tenuM2mWifiMode { M2M_WIFI_MODE_NORMAL = ((uint8) 1), M2M_WIFI_MODE_ATE_HIGH, M2M_WIFI_MODE_ATE_LOW, M2M_WIFI_MODE_ETHERNET, M2M_WIFI_MODE_MAX }

enum	tenuWPSTrigger { WPS_PIN_TRIGGER = 0, WPS_PBC_TRIGGER = 4 }

enum	tenuOtaUpdateStatus { OTA_STATUS_SUCSESS = 0, OTA_STATUS_FAIL = 1, OTA_STATUS_INVAILD_ARG = 2, OTA_STATUS_INVAILD_RB_IMAGE = 3, OTA_STATUS_INVAILD_FLASH_SIZE = 4, OTA_STATUS_AlREADY_ENABLED = 5, OTA_STATUS_UPDATE_INPROGRESS = 6, OTA_STATUS_IMAGE_VERIF_FAILED = 7, OTA_STATUS_CONNECTION_ERROR = 8, OTA_STATUS_SERVER_ERROR = 9, OTA_STATUS_ABORTED = 10 }

enum	tenuOtaUpdateStatusType { DL_STATUS = 1, SW_STATUS = 2, RB_STATUS = 3, AB_STATUS = 4 }

enum	tenuSslCertExpSettings { SSL_CERT_EXP_CHECK_DISABLE, SSL_CERT_EXP_CHECK_ENABLE, SSL_CERT_EXP_CHECK_EN_IF_SYS_TIME }

Detailed Description

Typedef Documentation

◆ tpfOtaNotifCb

void(* tpfOtaNotifCb)(tstrOtaUpdateInfo *)

A callback to get notification about a potential OTA update.

Parameters

[in] pstrOtaUpdateInfo A structure to provide notification payload.

See also: tstrOtaUpdateInfo

Warning: The notification is not supported (Not implemented yet)

◆ tpfOtaUpdateCb

void(* tpfOtaUpdateCb)(uint8 u8OtaUpdateStatusType,uint8 u8OtaUpdateStatus)

A callback to get OTA status update, the callback provide the status type and its status. The OTA callback provides the download status, the switch to the downloaded firmware status and roll-back status.

Parameters

[in]	u8OtaUpdateStatusType	Possible values are listed in tenuOtaUpdateStatusType.
[in]	u8OtaUpdateStatus	Possible values are listed as enumerated by tenuOtaUpdateStatus.

See also: tenuOtaUpdateStatusType tenuOtaUpdateStatus

Enumeration Type Documentation

◆ tenuOtaError

enum tenuOtaError

Enumerator
OTA_SUCCESS	OTA Success status
OTA_ERR_WORKING_IMAGE_LOAD_FAIL	Failure to load the firmware image
OTA_ERR_INVAILD_CONTROL_SEC	Control structure is being corrupted
M2M_ERR_OTA_SWITCH_FAIL	switching to the updated image failed as may be the image is invalid
M2M_ERR_OTA_START_UPDATE_FAIL	OTA update fail due to multiple reasons Connection failure Image integrity fail
M2M_ERR_OTA_ROLLBACK_FAIL	Roll-back failed due to Roll-back image is not valid
M2M_ERR_OTA_INVAILD_FLASH_SIZE	The OTA Support at least 4MB flash size, if the above error will appear if the current flash is less than 4M
M2M_ERR_OTA_INVAILD_ARG	Ota still in progress
M2M_ERR_OTA_INPROGRESS	Invalid argument in any OTA Function

◆ tenuM2mConnChangedErrcode

enum tenuM2mConnChangedErrcode

Enumerator
M2M_ERR_SCAN_FAIL	Indicate that the WINC board has failed to perform the scan operation.
M2M_ERR_JOIN_FAIL	Indicate that the WINC board has failed to join the BSS .
M2M_ERR_AUTH_FAIL	Indicate that the WINC board has failed to authenticate with the AP.
M2M_ERR_ASSOC_FAIL	Indicate that the WINC board has failed to associate with the AP.
M2M_ERR_CONN_INPROGRESS	Indicate that the WINC board has another connection request in progress.

◆ tenuM2mWepKeyIndex

enum tenuM2mWepKeyIndex

Enumerator
M2M_WIFI_WEP_KEY_INDEX_1
M2M_WIFI_WEP_KEY_INDEX_2
M2M_WIFI_WEP_KEY_INDEX_3
M2M_WIFI_WEP_KEY_INDEX_4	Index for WEP key Authentication

◆ tenuM2mPwrMode

enum tenuM2mPwrMode

Enumerator
PWR_AUTO	FW will decide the best power mode to use internally.
PWR_LOW1
PWR_LOW2
PWR_HIGH

◆ tenuM2mTxPwrLevel

enum 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

◆ tenuM2mReqGroup

enum 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_CRYPTO
M2M_REQ_GROUP_SIGMA

◆ tenuM2mReqpkt

enum tenuM2mReqpkt

Enumerator
M2M_REQ_CONFIG_PKT
M2M_REQ_DATA_PKT

◆ tenuM2mConfigCmd

enum 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_GET_CONN_INFO	Request connection information command.
M2M_WIFI_RESP_CONN_INFO	Connect with default AP response.
M2M_WIFI_REQ_SET_DEVICE_NAME	Set the WINC device name property.
M2M_WIFI_REQ_START_PROVISION_MODE	Start the provisioning mode for the M2M Device.
M2M_WIFI_RESP_PROVISION_INFO	Send the provisioning information to the host.
M2M_WIFI_REQ_STOP_PROVISION_MODE	Stop the current running provision mode.
M2M_WIFI_REQ_SET_SYS_TIME	Set time of day from host.
M2M_WIFI_REQ_ENABLE_SNTP_CLIENT	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	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	Add Custom ELement to Beacon Managament Frame.
M2M_WIFI_REQ_SCAN	Request scan command.
M2M_WIFI_RESP_SCAN_DONE	Scan complete notification response.
M2M_WIFI_REQ_SCAN_RESULT	Request Scan results command.
M2M_WIFI_RESP_SCAN_RESULT	Request Scan results resopnse.
M2M_WIFI_REQ_SET_SCAN_OPTION	Set Scan options "slot time, slot number .. etc" .
M2M_WIFI_REQ_SET_SCAN_REGION	Set scan region.
M2M_WIFI_REQ_SET_POWER_PROFILE	The API shall set power mode to one of 3 modes
M2M_WIFI_REQ_SET_TX_POWER	API to set TX power.
M2M_WIFI_REQ_SET_BATTERY_VOLTAGE	API to set Battery Voltage.
M2M_WIFI_REQ_SET_ENABLE_LOGS	API to set Battery Voltage.
M2M_WIFI_REQ_GET_SYS_TIME	REQ GET time of day from WINC.
M2M_WIFI_RESP_GET_SYS_TIME	RESP time of day from host.
M2M_WIFI_REQ_SEND_ETHERNET_PACKET	Send Ethernet packet in bypass mode.
M2M_WIFI_RESP_ETHERNET_RX_PACKET	Receive Ethernet packet in bypass mode.
M2M_WIFI_REQ_SET_MAC_MCAST	Set the WINC multicast filters.
M2M_WIFI_REQ_GET_PRNG	Request PRNG.
M2M_WIFI_RESP_GET_PRNG	Response for PRNG.
M2M_WIFI_REQ_SCAN_SSID_LIST	Request scan with list of hidden SSID plus the broadcast scan.
M2M_WIFI_REQ_SET_GAINS	Request set the PPA gain
M2M_WIFI_REQ_PASSIVE_SCAN	Request a passivr scan command.
M2M_WIFI_MAX_CONFIG_ALL

◆ tenuM2mStaCmd

enum tenuM2mStaCmd

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

Enumerator
M2M_WIFI_REQ_CONNECT	Connect with AP command.
M2M_WIFI_REQ_DEFAULT_CONNECT	Connect with default AP command.
M2M_WIFI_RESP_DEFAULT_CONNECT	Request connection information response.
M2M_WIFI_REQ_DISCONNECT	Request to disconnect from AP command.
M2M_WIFI_RESP_CON_STATE_CHANGED	Connection state changed response.
M2M_WIFI_REQ_SLEEP	Set PS mode command.
M2M_WIFI_REQ_WPS_SCAN	Request WPS scan command.
M2M_WIFI_REQ_WPS	Request WPS start command.
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 command.
M2M_WIFI_REQ_DHCP_CONF	Response indicating that IP address was obtained.
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 indicating a conflict in obtained IP address. The user should re attempt the DHCP request.
M2M_WIFI_REQ_ENABLE_MONITORING	Request to enable monitor mode command.
M2M_WIFI_REQ_DISABLE_MONITORING	Request to disable monitor mode command.
M2M_WIFI_RESP_WIFI_RX_PACKET	Indicate that a packet was received in monitor mode.
M2M_WIFI_REQ_SEND_WIFI_PACKET	Send packet in monitor mode.
M2M_WIFI_REQ_LSN_INT	Set WiFi listen interval.
M2M_WIFI_REQ_DOZE	Used to force the WINC to sleep in manual PS mode.
M2M_WIFI_MAX_STA_ALL

◆ tenuM2mApCmd

enum tenuM2mApCmd

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

Enumerator
M2M_WIFI_REQ_ENABLE_AP	Enable AP mode command.
M2M_WIFI_REQ_DISABLE_AP	Disable AP mode command.
M2M_WIFI_REQ_RESTART_AP
M2M_WIFI_MAX_AP_ALL

◆ tenuM2mP2pCmd

enum 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	Enable P2P mode command.
M2M_WIFI_REQ_DISABLE_P2P	Disable P2P mode command.
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

◆ tenuM2mServerCmd

enum tenuM2mServerCmd

This enum contains all the WINC commands while in PS mode. These command are currently not supported.

Enumerator
M2M_WIFI_REQ_CLIENT_CTRL
M2M_WIFI_RESP_CLIENT_INFO
M2M_WIFI_REQ_SERVER_INIT
M2M_WIFI_MAX_SERVER_ALL

◆ tenuM2mOtaCmd

enum tenuM2mOtaCmd

Enumerator
M2M_OTA_REQ_NOTIF_SET_URL
M2M_OTA_REQ_NOTIF_CHECK_FOR_UPDATE
M2M_OTA_REQ_NOTIF_SCHED
M2M_OTA_REQ_START_FW_UPDATE
M2M_OTA_REQ_SWITCH_FIRMWARE
M2M_OTA_REQ_ROLLBACK_FW
M2M_OTA_RESP_NOTIF_UPDATE_INFO
M2M_OTA_RESP_UPDATE_STATUS
M2M_OTA_REQ_TEST
M2M_OTA_REQ_START_CRT_UPDATE
M2M_OTA_REQ_SWITCH_CRT_IMG
M2M_OTA_REQ_ROLLBACK_CRT
M2M_OTA_REQ_ABORT
M2M_OTA_MAX_ALL

◆ tenuM2mCryptoCmd

enum tenuM2mCryptoCmd

Enumerator
M2M_CRYPTO_REQ_SHA256_INIT
M2M_CRYPTO_RESP_SHA256_INIT
M2M_CRYPTO_REQ_SHA256_UPDATE
M2M_CRYPTO_RESP_SHA256_UPDATE
M2M_CRYPTO_REQ_SHA256_FINSIH
M2M_CRYPTO_RESP_SHA256_FINSIH
M2M_CRYPTO_REQ_RSA_SIGN_GEN
M2M_CRYPTO_RESP_RSA_SIGN_GEN
M2M_CRYPTO_REQ_RSA_SIGN_VERIFY
M2M_CRYPTO_RESP_RSA_SIGN_VERIFY
M2M_CRYPTO_MAX_ALL

◆ tenuM2mIpCmd

enum tenuM2mIpCmd

Enumerator
M2M_IP_REQ_STATIC_IP_CONF
M2M_IP_REQ_ENABLE_DHCP
M2M_IP_REQ_DISABLE_DHCP

◆ tenuM2mSigmaCmd

enum tenuM2mSigmaCmd

Enumerator
M2M_SIGMA_ENABLE
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

◆ tenuM2mSslCmd

enum tenuM2mSslCmd

Enumerator
M2M_SSL_REQ_CERT_VERIF
M2M_SSL_REQ_ECC
M2M_SSL_RESP_ECC
M2M_SSL_IND_CRL
M2M_SSL_IND_CERTS_ECC
M2M_SSL_REQ_SET_CS_LIST
M2M_SSL_RESP_SET_CS_LIST

◆ tenuM2mConnState

enum tenuM2mConnState

Wi-Fi Connection State.

Enumerator
M2M_WIFI_DISCONNECTED	Wi-Fi state is disconnected.
M2M_WIFI_CONNECTED	Wi-Fi state is connected.
M2M_WIFI_UNDEF	Undefined Wi-Fi State.

◆ tenuM2mSecType

enum tenuM2mSecType

Wi-Fi Supported Security types.

Wi-Fi Supported 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.

◆ tenuM2mSsidMode

enum tenuM2mSsidMode

Enumerator
SSID_MODE_VISIBLE	SSID is visible to others.
SSID_MODE_HIDDEN	SSID is hidden.

◆ tenuM2mScanCh

enum tenuM2mScanCh

Wi-Fi RF Channels.

See also: tstrM2MScan tstrM2MScanOption

Enumerator
M2M_WIFI_CH_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

◆ tenuM2mScanRegion

enum tenuM2mScanRegion

Wi-Fi RF Channels.

Enumerator
REG_CH_1
REG_CH_2
REG_CH_3
REG_CH_4
REG_CH_5
REG_CH_6
REG_CH_7
REG_CH_8
REG_CH_9
REG_CH_10
REG_CH_11
REG_CH_12
REG_CH_13
REG_CH_14
REG_CH_ALL
NORTH_AMERICA
EUROPE	11 channel
ASIA	13 channel

◆ tenuPowerSaveModes

enum tenuPowerSaveModes

Power Save Modes.

Enumerator
M2M_NO_PS	Power save is disabled.
M2M_PS_AUTOMATIC	Power save is done automatically by the WINC. This mode doesn't disable all of the WINC modules and use higher amount of power than the H_AUTOMATIC and the DEEP_AUTOMATIC modes..
M2M_PS_H_AUTOMATIC	Power save is done automatically by the WINC. Achieve higher power save than the AUTOMATIC mode by shutting down more parts of the WINC board.
M2M_PS_DEEP_AUTOMATIC	Power save is done automatically by the WINC. Achieve the highest possible power save.
M2M_PS_MANUAL	Power save is done manually by the user.

◆ tenuM2mWifiMode

enum tenuM2mWifiMode

Wi-Fi Operation Mode.

Enumerator
M2M_WIFI_MODE_NORMAL	Normal Mode means to run customer firmware version.
M2M_WIFI_MODE_ATE_HIGH	Config Mode in HIGH POWER means to run production test firmware version which is known as ATE (Burst) firmware.
M2M_WIFI_MODE_ATE_LOW	Config Mode in LOW POWER means to run production test firmware version which is known as ATE (Burst) firmware.
M2M_WIFI_MODE_ETHERNET	etherent Mode
M2M_WIFI_MODE_MAX

◆ tenuWPSTrigger

enum tenuWPSTrigger

WPS Triggering Methods.

Enumerator
WPS_PIN_TRIGGER	WPS is triggered in PIN method.
WPS_PBC_TRIGGER	WPS is triggered via push button.

◆ tenuOtaUpdateStatus

enum tenuOtaUpdateStatus

OTA return status.

Enumerator
OTA_STATUS_SUCSESS	OTA Success with not errors.
OTA_STATUS_FAIL	OTA generic fail.
OTA_STATUS_INVAILD_ARG	Invalid or malformed download URL.
OTA_STATUS_INVAILD_RB_IMAGE	Invalid rollback image.
OTA_STATUS_INVAILD_FLASH_SIZE	Flash size on device is not enough for OTA.
OTA_STATUS_AlREADY_ENABLED	An OTA operation is already enabled.
OTA_STATUS_UPDATE_INPROGRESS	An OTA operation update is in progress
OTA_STATUS_IMAGE_VERIF_FAILED	OTA Verfication failed
OTA_STATUS_CONNECTION_ERROR	OTA connection error
OTA_STATUS_SERVER_ERROR	OTA server Error (file not found or else ...)
OTA_STATUS_ABORTED	OTA download has been aborted by the application.

◆ tenuOtaUpdateStatusType

enum tenuOtaUpdateStatusType

OTA update Status type.

Enumerator
DL_STATUS	Download OTA file status
SW_STATUS	Switching to the upgrade firmware status
RB_STATUS	Roll-back status
AB_STATUS	Abort status

◆ tenuSslCertExpSettings

enum tenuSslCertExpSettings

SSL Certificate Expiry Validation Options.

Enumerator
SSL_CERT_EXP_CHECK_DISABLE	ALWAYS OFF. Ignore certificate expiration date validation. If a certificate is expired or there is no configured system time, the SSL connection SUCCEEDs.
SSL_CERT_EXP_CHECK_ENABLE	ALWAYS ON. Validate certificate expiration date. If a certificate is expired or there is no configured system time, the SSL connection FAILs.
SSL_CERT_EXP_CHECK_EN_IF_SYS_TIME	CONDITIONAL VALIDATION (Default setting at startup). Validate the certificate expiration date only if there is a configured system time. If there is no configured system time, the certificate expiration is bypassed and the SSL connection SUCCEEDs.

WINC1500 IoT Software APIs: DataTypes

WINC1500 IoT Software API

Data Structures

Typedefs

Enumerations