DataTypes
[WLAN]

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

Parameters:

[in]	u8MsgType	Type of notification. Possible types are: [M2M_WIFI_RESP_ETHERNET_RX_PACKET](M2M_WIFI_RESP_ETHERNET_RX_PACKET)
[in]	pvMsg	A pointer to a buffer containing the notification parameters (if any). It should be casted to the correct data type corresponding to the notification type. For example, it could be a pointer to the buffer holding the received frame in case of M2M_WIFI_RESP_ETHERNET_RX_PACKET event.
[in]	pvControlBuf	A pointer to control buffer describing the accompanied message. To be casted to tstrM2mIpCtrlBuf in case of M2M_WIFI_RESP_ETHERNET_RX_PACKET event.

Warning:

Make sure that the application defines ETH_MODE.

See also:

m2m_wifi_init

Definition at line 427 of file m2m_wifi.h.

Wi-Fi monitoring mode callback function. This function delivers all received wi-Fi packets through the Wi-Fi interface. Applications requiring to operate in the monitoring should call the asynchronous function m2m_wifi_enable_monitoring_mode and expect to receive the Wi-Fi packets through this callback function, when the event is received. To disable the monitoring mode a call to m2m_wifi_disable_monitoring_mode should be made.

Parameters:

[in]	pstrWifiRxPacket	Pointer to a structure holding the Wi-Fi packet header parameters.
[in]	pu8Payload	Pointer 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]	u16PayloadSize	The size of the payload in bytes.

See also:

m2m_wifi_enable_monitoring_mode,m2m_wifi_init

Warning:

u16PayloadSize should not exceed the buffer size given through m2m_wifi_enable_monitoring_mode.

Definition at line 456 of file m2m_wifi.h.

Wi-Fi's main callback function handler, for handling the M2M_WIFI events received on the Wi-Fi interface. Such notifications are received in response to Wi-Fi/P2P operations such as m2m_wifi_request_scan, m2m_wifi_connect. Wi-Fi/P2P operations are implemented in an asynchronous mode, and all incoming information/status are to be handled through this callback function when the corresponding notification is received. Applications are expected to assign this wi-fi callback function by calling m2m_wifi_init.

Parameters:

[in]

u8MsgType

Type of notifications. Possible types are: /ref M2M_WIFI_RESP_CON_STATE_CHANGED /ref M2M_WIFI_RESP_CONN_INFO /ref M2M_WIFI_REQ_DHCP_CONF /ref M2M_WIFI_REQ_WPS /ref M2M_WIFI_RESP_IP_CONFLICT /ref M2M_WIFI_RESP_SCAN_DONE /ref M2M_WIFI_RESP_SCAN_RESULT /ref M2M_WIFI_RESP_CURRENT_RSSI /ref M2M_WIFI_RESP_CLIENT_INFO /ref M2M_WIFI_RESP_PROVISION_INFO /ref M2M_WIFI_RESP_DEFAULT_CONNECT

In case Ethernet/Bypass mode is defined : M2M_WIFI_RESP_ETHERNET_RX_PACKET

In case monitoring mode is used: M2M_WIFI_RESP_WIFI_RX_PACKET

Parameters:

[in]

pvMsg

A pointer to a buffer containing the notification parameters (if any). It should be casted to the correct data type corresponding to the notification type.

See also:

tstrM2mWifiStateChanged tstrM2MWPSInfo tstrM2mScanDone tstrM2mWifiscanResult

Definition at line 396 of file m2m_wifi.h.

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)

Definition at line 72 of file m2m_ota.h.

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

Definition at line 90 of file m2m_ota.h.

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.

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
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 173 of file m2m_wifi.h.

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.

Definition at line 832 of file m2m_types.h.

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.

Definition at line 628 of file m2m_types.h.

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.

Definition at line 462 of file m2m_types.h.

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.

Definition at line 988 of file m2m_types.h.

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.

Definition at line 852 of file m2m_types.h.

Enumerator:

PWR_AUTO

FW will decide the best power mode to use internally.

Definition at line 502 of file m2m_types.h.

Wi-Fi RF Channels.

See also:

tstrM2MScan tstrM2MScanOption

Definition at line 1052 of file m2m_types.h.

Wi-Fi RF Channels.

Enumerator:

EUROPE	11 channel
ASIA	13 channel

Definition at line 1077 of file m2m_types.h.

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.

Definition at line 1007 of file m2m_types.h.

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

Definition at line 880 of file m2m_types.h.

Enumerator:

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

Definition at line 1033 of file m2m_types.h.

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.

Definition at line 761 of file m2m_types.h.

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 535 of file m2m_types.h.

Enumerator:

M2M_WIFI_WEP_KEY_INDEX_4

Index for WEP key Authentication

Definition at line 486 of file m2m_types.h.

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

Definition at line 1144 of file m2m_types.h.

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

Definition at line 413 of file m2m_types.h.

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.

Definition at line 2107 of file m2m_types.h.

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

Definition at line 2138 of file m2m_types.h.

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.

Definition at line 1113 of file m2m_types.h.

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.

Definition at line 2341 of file m2m_types.h.

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 CONF_MGMT is defined and the application developer requires to monitor the frame transmission and reception.

See also:

tenuWifiFrameType tstrM2MWifiMonitorModeCtrl

Enumerator:

ASSOC_REQ	Sub-Types related to Management Sub-Types
M2M_WIFI_FRAME_SUB_TYPE_ANY	Set monitor mode to receive any of the frames types

Definition at line 116 of file m2m_wifi.h.

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 316 of file m2m_wifi.h.

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 monitoring mode is used (defining CONF_MGMT) and the user application requires to monitor the frame transmission and reception.

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.
M2M_WIFI_FRAME_TYPE_ANY	Set monitor mode to receive any of the frames types

Definition at line 82 of file m2m_wifi.h.

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 1167 of file m2m_types.h.