Modules | |
| Function | |
| m2m_wifi_init | |
| Synchronous initialization functions for the WILC driver. | |
| m2m_wifi_deinit | |
| Synchronous deinitialization function to the WILC1000 driver. | |
| m2m_wifi_handle_events | |
| Synchronous M2M event handler function, responsible for handling interrupts received from the WILC firmware. | |
| m2m_wifi_connect | |
| Asynchronous wi-fi connection function to a specific AP. | |
| m2m_wifi_disconnect | |
| Synchronous wi-fi disconnection function, requesting a Wi-Fi disconnect from the currently connected AP. | |
| m2m_wifi_get_connection_info | |
| Asynchronous connection status retrieval function, retrieves the status information of the currently connected AP. | |
| m2m_wifi_set_mac_address | |
| Synchronous dual MAC address assigning to the WILC1500 . | |
| m2m_wifi_wps | |
| Asynchronous WPS triggering function. | |
| m2m_wifi_wps_disable | |
| Disable the NMC1500 WPS operation. | |
| m2m_wifi_p2p | |
| Asynchronous Wi-Fi direct (P2P) enabling mode function. | |
| m2m_wifi_p2p_disconnect | |
| Disable the NMC1500 device Wi-Fi direct mode (P2P). | |
| m2m_wifi_enable_ap | |
| Asychronous wi-fi hotspot enabling function. | |
| m2m_wifi_disable_ap | |
| Synchronous wi-fi hotspot disabling function. | |
| m2m_wifi_set_scan_options | |
| Synchronous wi-fi scan settings function. | |
| m2m_wifi_set_scan_region | |
| Synchronous wi-fi scan region setting function. | |
| m2m_wifi_request_scan | |
| Asynchronous wi-fi scan request on the given channel. | |
| m2m_wifi_get_num_ap_found | |
| Synchronous function to retrieve the number of AP's found in the last scan request, The function read the number of AP's from global variable which updated in the wi-fi callback fucntion through the M2M_WIFI_RESP_SCAN_DONE event. | |
| m2m_wifi_req_scan_result | |
| Synchronous call to read the AP information from the SCAN Result list with the given index. | |
| m2m_wifi_req_curr_rssi | |
| Asynchronous request for the current RSSI of the connected AP. | |
| m2m_wifi_get_otp_mac_address | |
| Request the MAC address stored on the OTP (one time programmable) memory of the device. | |
| m2m_wifi_get_mac_address | |
| Function to retrieve the current MAC address. | |
| m2m_wifi_set_sleep_mode | |
| Synchronous power-save mode setting function for the NMC1500. | |
| m2m_wifi_get_sleep_mode | |
| Synchronous power save mode retrieval function. | |
Data Structures | |
| struct | tstr1xAuthCredentials |
| Credentials for the user to authenticate with the AAA server (WPA-Enterprise Mode IEEE802.1x). More... | |
| struct | tstrEthInitParam |
| Structure to hold ethernet interface parameters. More... | |
| struct | tstrM2MAPAssocInfo |
| M2M association information of the connected station in the AP mode. More... | |
| struct | tstrM2MAPConfig |
| AP Configuration. More... | |
| struct | tstrM2MAssocEntryInfo |
| M2M association information of of an assoicated entry in the AP mode. More... | |
| struct | tstrM2MConnInfo |
| M2M Provisioning Information obtained from the HTTP Provisioning server. More... | |
| struct | tstrM2MDataBufCtrl |
| 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 is placed in the tstrEthInitParam structure in the au8ethRcvBuf attribute. This following information is retreived in the host when an event M2M_WIFI_RESP_ETHERNET_RX_PACKET is received in the wi-fi callback function tpfAppWifiCb. More... | |
| struct | tstrM2MDeviceNameConfig |
| Device name. More... | |
| struct | tstrM2MIfId |
| Set Intrface ID. More... | |
| struct | tstrM2MIPConfig |
| Static IP configuration. More... | |
| struct | tstrM2mIpRsvdPkt |
| Received Packet Size and Data Offset. More... | |
| struct | tstrM2mLsnInt |
| Listen interval. More... | |
| struct | tstrM2MMulticastMac |
| M2M add/remove multicast mac address. More... | |
| struct | tstrM2MP2PConnect |
| Set the device to operate in the Wi-Fi Direct (P2P) mode. More... | |
| struct | tstrM2MP2pDevInfo |
| P2P Pin. More... | |
| struct | tstrM2MPinInfo |
| PIN Number (input) More... | |
| struct | tstrM2mPsType |
| Power Save Configuration. More... | |
| struct | tstrM2mReqScanResult |
| Scan Result Request. More... | |
| struct | tstrM2MScan |
| Wi-Fi Scan Request. More... | |
| struct | tstrM2mScanDone |
| Wi-Fi Scan Result. More... | |
| struct | tstrM2MScanList |
| Wi-Fi channel list regulation. More... | |
| struct | tstrM2MScanOption |
| struct | tstrM2MScanRegion |
| Wi-Fi channel regulation region information. More... | |
| struct | tstrM2mSetMacAddress |
| Sets the MAC address from application. It is only intended for testing purpose. This method is not used for production SW. Production SW reads MAC Address from EFUSE. More... | |
| struct | tstrM2mTxPwrLevel |
| Tx power level. More... | |
| struct | tstrM2MUserMaxTxRate |
| User specified Max Tx Rate. More... | |
| struct | tstrM2mWifiConnect |
| Wi-Fi Connect Request. More... | |
| struct | tstrM2MWifiMonitorModeCtrl |
| Wi-Fi Monitor Mode Filter. More... | |
| struct | tstrM2MWifiRxPacketInfo |
| Wi-Fi RX Frame Header. More... | |
| struct | tstrM2mWifiscanResult |
| Wi-Fi Scan Result. More... | |
| struct | tstrM2MWifiSecInfo |
| Authentication credentials to connect to a Wi-Fi network. More... | |
| struct | tstrM2mWifiStateChanged |
| Wi-Fi Connection State. More... | |
| struct | tstrM2MWifiTxPacketInfo |
| Wi-Fi Tx Packet Info. More... | |
| struct | tstrM2mWifiWepParams |
| WEP security key parameters. More... | |
| struct | tstrM2MWPSConnect |
| WPS Configuration parameters. More... | |
| struct | tstrM2MWPSInfo |
| WPS Result. More... | |
| struct | tstrSystemTime |
| Used for time storage. More... | |
| struct | tstrWifiInitParam |
Structure, holding the Wi-Fi configuration attributes such as the Wi-Fi callback, monitoring mode callback and Ethernet parameter initialization structure.More... | |
| union | tuCtrlStruct |
| union | tuniM2MWifiAuth |
| Wi-Fi Security Parameters for all supported security modes. More... | |
Macros | |
| #define | PAD_SZ(x) (4 - ((x) % 4)) |
Typedefs | |
| typedef void(* | tpfAppEthCb )(uint8 u8MsgType, void *pvMsg, void *pvCtrlBuf) |
| Ethernet notification callback function receiving events as defined in the Wi-Fi reponses 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 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. More... | |
| typedef void(* | tpfAppWifiCb )(uint8 u8MsgType, void *pvMsg) |
| 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. More... | |
Functions | |
| NMI_API sint8 | m2m_wifi_set_p2p_pin (uint8 *pu8PinNumber, uint8 u8PinLength) |
| NMI_API sint8 | m2m_wifi_set_device_name (uint8 *pu8DeviceName, uint8 u8DeviceNameLength) |
| Set the WILC1000 device name which is used as P2P device name. More... | |
| #define PAD_SZ | ( | x | ) | (4 - ((x) % 4)) |
< Padding bytes for forcing 4-byte alignment
| tpfAppEthCb |
Ethernet notification callback function receiving events as defined in the Wi-Fi reponses enumeration tenuM2mStaCmd.
| [in] | u8MsgType | Type of notification. Possible types are: |
| [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 tstrM2MDataBufCtrl in case of M2M_WIFI_RESP_ETHERNET_RX_PACKET event. |
| tpfAppMonCb |
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.
| [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. |
| tpfAppWifiCb |
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.
| [in] | u8MsgType | Type of notification. Possible types are: /ref M2M_WIFI_RESP_CON_STATE_CHANGED /ref M2M_WIFI_RESP_CONN_INFO /ref M2M_WIFI_REQ_WPS /ref M2M_WIFI_RESP_SCAN_DONE /ref M2M_WIFI_RESP_SCAN_RESULT /ref M2M_WIFI_RESP_CURRENT_RSSI /ref M2M_WIFI_RESP_DEFAULT_CONNECT /ref M2M_WIFI_RESP_ETHERNET_RX_PACKET |
In case Monitoring mode is used: M2M_WIFI_RESP_WIFI_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. |
| enum tenuAntSelGpio |
| enum tenuAntSwitchMode |
| enum tenuControlInterface |
| enum tenuM2mApCmd |
This enum contains all the WILC commands while in AP mode.
| enum tenuM2mConfigCmd |
This enum contains all the host commands used to configure the WILC board.
| enum tenuM2mConnState |
| enum tenuM2mP2pCmd |
| enum tenuM2mScanCh |
| enum tenuM2mScanRegion |
| enum tenuM2mSecType |
Wi-Fi Supported Security types.
Wi-Fi Supported SSID types.
| enum tenuM2mSsidMode |
| enum tenuM2mStaCmd |
This enum contains all the WILC commands while in Station mode.
| enum tenuM2mWepAuthType |
| enum tenuM2mWepKeyIndex |
enum holding P2P Control interface for different concurrency modes
| enum tenuP2PTrigger |
| enum tenuPowerSaveModes |
| enum 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.
| enum tenuTxDataRate |
This enum contains all the phy tx rates.
| enum 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 constitues 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.
| 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 | |
| enum tenuWPSTrigger |
Set the WILC1000 device name which is used as P2P device name.
m2m_wifi_set_device_name Set the WILC device name which is to be used as a P2P device name.
| [in] | pu8DeviceName | Buffer holding the device name. |
| [in] | u8DeviceNameLength | Length of the device name. |
| [in] | pu8DeviceName | Buffer holding the device name. |
| [in] | u8DeviceNameLength | Length of the device name. Should not exceed the maximum device name's length M2M_DEVICE_NAME_MAX. |
References tstrM2MDeviceNameConfig::au8DeviceName, hif_send(), M2M_DEVICE_NAME_MAX, m2m_memcpy(), M2M_REQ_GRP_WIFI, M2M_WIFI_REQ_SET_DEVICE_NAME, and NULL.
Referenced by os_m2m_wifi_set_device_name_imp().
| [in] | pu8PinNumber | PIN number for P2P PIN method. It must follow the rules stated by the WPS Standard. |
| [in] | u8PinLength | Length of the PIN number. Should not exceed the maximum P2P_MAX_PIN_SIZE. |
References tstrM2MPinInfo::au8Pin, hif_send(), m2m_memcpy(), M2M_REQ_GRP_WIFI, M2M_WIFI_P2P_AUTH_RES, and NULL.
Referenced by m2m_wifi_allow_p2p_connection(), and os_m2m_wifi_set_p2p_pin_imp().
1.8.5