API messagesFULL_MAC_API
WFM API messages.
Data Structures | |
struct | WfmHiSetMacAddressReqBody_t |
Request message body for WfmHiSetMacAddressReq_t. | |
struct | WfmHiSetMacAddressReq_t |
Request message to set MAC address of the interface. | |
struct | WfmHiSetMacAddressCnfBody_t |
Confirmation message body for WfmHiSetMacAddressCnf_t. | |
struct | WfmHiSetMacAddressCnf_t |
Confirmation message for WfmHiSetMacAddressReq_t. | |
struct | WfmHiConnectReqBody_t |
Request message body for WfmHiConnectReq_t. | |
struct | WfmHiConnectReq_t |
Request message for connecting to a Wi-Fi network. | |
struct | WfmHiConnectCnfBody_t |
Confirmation message body for WfmHiConnectCnf_t. | |
struct | WfmHiConnectCnf_t |
Confirmation message for WfmHiConnectReq_t. | |
struct | WfmHiConnectIndBody_t |
Indication message body for WfmHiConnectInd_t. | |
struct | WfmHiConnectInd_t |
Indication message used to signal the completion of a connection operation. | |
struct | WfmHiDisconnectCnfBody_t |
Confirmation message body for WfmHiDisconnectCnf_t. | |
struct | WfmHiDisconnectCnf_t |
Confirmation message for WfmHiDisconnectReq_t. | |
struct | WfmHiDisconnectIndBody_t |
Indication message body for WfmHiDisconnectInd_t. | |
struct | WfmHiDisconnectInd_t |
Indication message used to signal the completion of a disconnection operation. | |
struct | WfmHiGetSignalStrengthCnfBody_t |
Confirmation message body for WfmHiGetSignalStrengthCnf_t. | |
struct | WfmHiGetSignalStrengthCnf_t |
Confirmation message for WfmHiGetSignalStrengthReq_t. | |
struct | WfmHiSetPmModeReqBody_t |
Request message body for WfmHiSetPmModeReq_t. | |
struct | WfmHiSetPmModeReq_t |
Request message for setting the power management mode of the device. | |
struct | WfmHiSetPmModeCnfBody_t |
Confirmation message body for WfmHiSetPmModeCnf_t. | |
struct | WfmHiSetPmModeCnf_t |
Confirmation message for WfmHiSetPmModeReq_t. | |
struct | WfmHiStartApReqBody_t |
Request message body for WfmHiStartApReq_t. | |
struct | WfmHiStartApReq_t |
Request message for starting a Wi-Fi network. | |
struct | WfmHiStartApCnfBody_t |
Confirmation message body for WfmHiStartApCnf_t. | |
struct | WfmHiStartApCnf_t |
Confirmation message for WfmHiStartApReq_t. | |
struct | WfmHiStartApIndBody_t |
Indication message body for WfmHiStartApInd_t. | |
struct | WfmHiStartApInd_t |
Indication message used to signal the completion of a start request. | |
struct | WfmHiUpdateApReqBody_t |
Request message body for WfmHiUpdateApReq_t. | |
struct | WfmHiUpdateApReq_t |
Request message for updating parameters of the started Wi-Fi network. | |
struct | WfmHiUpdateApCnfBody_t |
Confirmation message body for WfmHiUpdateApCnf_t. | |
struct | WfmHiUpdateApCnf_t |
Confirmation message for WfmHiUpdateApReq_t. | |
struct | WfmHiStopApCnfBody_t |
Confirmation message body for WfmHiStopApCnf_t. | |
struct | WfmHiStopApCnf_t |
Confirmation message for WfmHiStopApReq_t. | |
struct | WfmHiApClientConnectedIndBody_t |
Indication message body for WfmHiApClientConnectedInd_t. | |
struct | WfmHiApClientConnectedInd_t |
Indication message used to signal a connected station. | |
struct | WfmHiApClientRejectedIndBody_t |
Indication message body for WfmHiApClientRejectedInd_t. | |
struct | WfmHiApClientRejectedInd_t |
Indication message used to signal a rejected connection attempt from a station. | |
struct | WfmHiDisconnectApClientReqBody_t |
Request message body for WfmHiDisconnectApClientReq_t. | |
struct | WfmHiDisconnectApClientReq_t |
Request message for disconnecting a client from the started Wi-Fi network. | |
struct | WfmHiDisconnectApClientCnfBody_t |
Confirmation message body for WfmHiDisconnectApClientCnf_t. | |
struct | WfmHiDisconnectApClientCnf_t |
Confirmation message for WfmHiDisconnectApClientReq_t. | |
struct | WfmHiApClientDisconnectedIndBody_t |
Indication message body for WfmHiApClientDisconnectedInd_t. | |
struct | WfmHiApClientDisconnectedInd_t |
Indication message used to signal a disconnected station. | |
struct | WfmHiSendFrameReqBody_t |
Request message body for WfmHiSendFrameReq_t. | |
struct | WfmHiSendFrameReq_t |
Request message for sending a packet to the network. | |
struct | WfmHiSendFrameCnfBody_t |
Confirmation message body for WfmHiSendFrameCnf_t. | |
struct | WfmHiSendFrameCnf_t |
Confirmation message for WfmHiSendFrameReq_t. | |
struct | WfmHiReceivedIndBody_t |
Indication message body for WfmHiReceivedInd_t. | |
struct | WfmHiReceivedInd_t |
Indication message used to signal a received packet. | |
struct | WfmHiStartScanReqBody_t |
Request message body for WfmHiStartScanReq_t. | |
struct | WfmHiStartScanReq_t |
Request message for starting a scan to detect near-by access points. | |
struct | WfmHiStartScanCnfBody_t |
Confirmation message body for WfmHiStartScanCnf_t. | |
struct | WfmHiStartScanCnf_t |
Confirmation message for WfmHiStartScanReq_t. | |
struct | WfmHiStopScanCnfBody_t |
Confirmation message body for WfmHiStopScanCnf_t. | |
struct | WfmHiStopScanCnf_t |
Confirmation message for WfmHiStopScanReq_t. | |
struct | WfmHiScanResultIndBody_t |
Indication message body for WfmHiScanResultInd_t. | |
struct | WfmHiScanResultInd_t |
Indication message used to signal an access point has been detected. | |
struct | WfmHiScanCompleteIndBody_t |
Indication message body for WfmHiScanCompleteInd_t. | |
struct | WfmHiScanCompleteInd_t |
Indication message used to signal a scan was completed. | |
struct | WfmHiJoinIbssReqBody_t |
Request message body for WfmHiJoinIbssReq_t. | |
struct | WfmHiJoinIbssReq_t |
Request message for connecting to or starting an IBSS network. | |
struct | WfmHiJoinIbssCnfBody_t |
Confirmation message body for WfmHiJoinIbssCnf_t. | |
struct | WfmHiJoinIbssCnf_t |
Confirmation message for WfmHiJoinIbssReq_t. | |
struct | WfmHiJoinIbssIndBody_t |
Indication message body for WfmHiJoinIbssInd_t. | |
struct | WfmHiJoinIbssInd_t |
Indication message used to signal the completion of a join request. | |
struct | WfmHiLeaveIbssCnfBody_t |
Confirmation message body for WfmHiLeaveIbssCnf_t. | |
struct | WfmHiLeaveIbssCnf_t |
Confirmation message for WfmHiLeaveIbssReq_t. | |
struct | WfmHiAddMulticastAddrReqBody_t |
Request message body for WfmHiAddMulticastAddrReq_t. | |
struct | WfmHiAddMulticastAddrReq_t |
Request message for adding a multicast address to the multicast filter whitelist. | |
struct | WfmHiAddMulticastAddrCnfBody_t |
Confirmation message body for WfmHiAddMulticastAddrCnf_t. | |
struct | WfmHiAddMulticastAddrCnf_t |
Confirmation message for WfmHiAddMulticastAddrReq_t. | |
struct | WfmHiRemoveMulticastAddrReqBody_t |
Request message body for WfmHiRemoveMulticastAddrReq_t. | |
struct | WfmHiRemoveMulticastAddrReq_t |
Request message for removing a multicast address from the multicast filter whitelist. | |
struct | WfmHiRemoveMulticastAddrCnfBody_t |
Confirmation message body for WfmHiRemoveMulticastAddrCnf_t. | |
struct | WfmHiRemoveMulticastAddrCnf_t |
Confirmation message for WfmHiRemoveMulticastAddrReq_t. | |
struct | WfmHiSetMaxApClientCountReqBody_t |
Request message body for WfmHiSetMaxApClientCountReq_t. | |
struct | WfmHiSetMaxApClientCountReq_t |
Request message for setting the maximum number of connected clients. | |
struct | WfmHiSetMaxApClientCountCnfBody_t |
Confirmation message body for WfmHiSetMaxApClientCountCnf_t. | |
struct | WfmHiSetMaxApClientCountCnf_t |
Confirmation message for WfmHiSetMaxApClientCountReq_t. | |
struct | WfmHiSetMaxApClientInactivityReqBody_t |
Request message body for WfmHiSetMaxApClientInactivityReq_t. | |
struct | WfmHiSetMaxApClientInactivityReq_t |
Request message for setting the maximum number of connected clients. | |
struct | WfmHiSetMaxApClientInactivityCnfBody_t |
Confirmation message body for WfmHiSetMaxApClientCountCnf_t. | |
struct | WfmHiSetMaxApClientInactivityCnf_t |
Confirmation message for WfmHiSetMaxApClientInactivityReq_t. | |
struct | WfmHiSetRoamParametersReqBody_t |
Request message body for WfmHiSetRoamParametersReq_t. | |
struct | WfmHiSetRoamParametersReq_t |
Request message for setting the roaming parameters. | |
struct | WfmHiSetRoamParametersCnfBody_t |
Confirmation message body for WfmHiSetRoamParametersCnf_t. | |
struct | WfmHiSetRoamParametersCnf_t |
Confirmation message for WfmHiSetRoamParametersReq_t. | |
struct | WfmHiSetTxRateParametersReqBody_t |
Request message body for WfmHiSetTxRateParametersReq_t. | |
struct | WfmHiSetTxRateParametersReq_t |
Request message for setting the TX rate set parameters. | |
struct | WfmHiSetTxRateParametersCnfBody_t |
Confirmation message body for WfmHiSetTxRateParametersCnf_t. | |
struct | WfmHiSetTxRateParametersCnf_t |
Confirmation message for WfmHiSetTxRateParametersReq_t. | |
struct | WfmHiSetArpIpAddressReqBody_t |
Request message body for WfmHiSetArpIpAddressReq_t. | |
struct | WfmHiSetArpIpAddressReq_t |
Request message for setting the Address Resolution Protocol (ARP) offloading state. | |
struct | WfmHiSetArpIpAddressCnfBody_t |
Confirmation message body for WfmHiSetArpIpAddressCnf_t. | |
struct | WfmHiSetArpIpAddressCnf_t |
Confirmation message for WfmHiSetArpIpAddressReq_t. | |
struct | WfmHiSetNsIpAddressReqBody_t |
Request message body for WfmHiSetNsIpAddressReq_t. | |
struct | WfmHiSetNsIpAddressReq_t |
Request message for setting the Neighbor Discovery Protocol (NDP) offloading state. | |
struct | WfmHiSetNsIpAddressCnfBody_t |
Confirmation message body for WfmHiSetNsIpAddressCnf_t. | |
struct | WfmHiSetNsIpAddressCnf_t |
Confirmation message for WfmHiSetNsIpAddressReq_t. | |
struct | WfmHiSetBroadcastFilterReqBody_t |
Request message body for WfmHiSetBroadcastFilterReq_t. | |
struct | WfmHiSetBroadcastFilterReq_t |
Request message for setting broadcast filter state. | |
struct | WfmHiSetBroadcastFilterCnfBody_t |
Confirmation message body for WfmHiSetBroadcastFilterCnf_t. | |
struct | WfmHiSetBroadcastFilterCnf_t |
Confirmation message for WfmHiSetBroadcastFilterReq_t. | |
struct | WfmHiSetScanParametersReqBody_t |
Request message body for WfmHiSetScanParametersReq_t. | |
struct | WfmHiSetScanParametersReq_t |
Request message for setting scan parameters. | |
struct | WfmHiSetScanParametersCnfBody_t |
Confirmation message body for WfmHiSetScanParametersCnf_t. | |
struct | WfmHiSetScanParametersCnf_t |
Confirmation message for WfmHiSetScanParametersReq_t. | |
struct | WfmHiDisconnectReq_t |
Request message for disconnecting from a Wi-Fi network. | |
struct | WfmHiGetSignalStrengthReq_t |
Request message for retrieving the signal strength of connection. | |
struct | WfmHiStopApReq_t |
Request message for stopping the started Wi-Fi network. | |
struct | WfmHiStopApInd_t |
Indication message used to signal the completion of a stop operation. | |
struct | WfmHiStopScanReq_t |
Request message for stopping an ongoing scan. | |
struct | WfmHiLeaveIbssReq_t |
Request message for disconnecting from an IBSS network. | |
struct | WfmHiLeaveIbssInd_t |
Indication message used to signal the completion of a disconnect operation. |
Detailed Description
WFM API messages.
Data Structure Documentation
◆ WfmHiSetMacAddressReqBody_t
struct WfmHiSetMacAddressReqBody_t |
Request message body for WfmHiSetMacAddressReq_t.
Definition at line 636
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | MacAddr[6] | MAC address of the interface. |
uint16_t | Reserved | Reserved, set to zero. |
◆ WfmHiSetMacAddressReq_t
struct WfmHiSetMacAddressReq_t |
Request message to set MAC address of the interface.
The host can use this request to set the MAC address an interface. If not set, the device will use a built-in MAC address. Note that if multiple interfaces are used, the MAC address MUST be different on each interface.
Definition at line 651
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetMacAddressReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetMacAddressCnfBody_t
struct WfmHiSetMacAddressCnfBody_t |
Confirmation message body for WfmHiSetMacAddressCnf_t.
Definition at line 661
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the set request. WFM_STATUS_SUCCESS: the set request was completed successfully. |
◆ WfmHiSetMacAddressCnf_t
struct WfmHiSetMacAddressCnf_t |
Confirmation message for WfmHiSetMacAddressReq_t.
Definition at line 675
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetMacAddressCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiConnectReqBody_t
struct WfmHiConnectReqBody_t |
Request message body for WfmHiConnectReq_t.
Definition at line 685
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | BSSID[6] |
Basic Service Set Identifier (BSSID) of the access point. broadcast address: The device will connect to any matching access point. |
uint16_t | Channel |
Channel of the access point. 0: The device will connect to a matching access point on any channel. |
uint16_t | IeDataLength |
Length of vendor-specific Information Element (IE) data. 0 - 255: The amount of bytes. |
uint16_t | MgmtFrameProtection |
Protected Management Frames (PMF) mode. WFM_MGMT_FRAME_PROTECTION_DISABLED: The device will not use PMF even if supported by the access point. |
uint8_t | Password[64] |
Password of the network. 64-bit WEP key: 5 bytes in ASCII format or 10 bytes in HEX format. |
uint16_t | PasswordLength |
Length of the network password. 0 - 64: The amount of bytes. |
uint8_t | PreventRoaming |
Boolean option to prevent roaming between access points. 0: The device may roam to any matching access point within the same network. |
uint8_t | SecurityMode |
Security mode of the network. WFM_SECURITY_MODE_OPEN: The device will only connect to an unsecured access point. |
WfmHiSsidDef_t | SsidDef | Service Set Identifier (SSID) of the network. |
◆ WfmHiConnectReq_t
struct WfmHiConnectReq_t |
Request message for connecting to a Wi-Fi network.
The host can use this request to iniate a connection to a Wi-Fi network.
Successful connection request moves the interface to Wi-Fi client state.
Definition at line 760
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiConnectReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiConnectCnfBody_t
struct WfmHiConnectCnfBody_t |
Confirmation message body for WfmHiConnectCnf_t.
Definition at line 770
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the connection request. WFM_STATUS_SUCCESS: the connection request was accepted. It will be completed by WfmHiConnectInd_t. |
◆ WfmHiConnectCnf_t
struct WfmHiConnectCnf_t |
Confirmation message for WfmHiConnectReq_t.
Definition at line 784
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiConnectCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiConnectIndBody_t
struct WfmHiConnectIndBody_t |
Indication message body for WfmHiConnectInd_t.
Definition at line 794
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | BeaconInterval | Beacon Interval of the connected access point. |
uint16_t | Channel |
Channel of the connected access point. 1 - 13: Channel number. |
uint8_t | DtimPeriod |
DTIM period of the connected access point. 1 - 255: DTIM period. |
uint8_t | Mac[6] | MAC address of the connected access point. |
uint16_t | MaxPhyRate |
Maximum PHY data rate supported by the connection. See WfmMaxPhyRate for enumeration values. |
uint32_t | Status |
Status of the connection request. WFM_STATUS_SUCCESS: the connection request was completed successfully. |
◆ WfmHiConnectInd_t
struct WfmHiConnectInd_t |
Indication message used to signal the completion of a connection operation.
The device will send this indication to signal the connection request initiated with WfmHiConnectReq_t has been completed. The indication is also sent when the device autonomously roams to another access point.
Definition at line 834
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiConnectIndBody_t | Body | Indication message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiDisconnectCnfBody_t
struct WfmHiDisconnectCnfBody_t |
Confirmation message body for WfmHiDisconnectCnf_t.
Definition at line 853
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the disconnection request. WFM_STATUS_SUCCESS: the disconnection request was accepted. It will be completed by WfmHiDisconnectInd_t. |
◆ WfmHiDisconnectCnf_t
struct WfmHiDisconnectCnf_t |
Confirmation message for WfmHiDisconnectReq_t.
Definition at line 867
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiDisconnectCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiDisconnectIndBody_t
struct WfmHiDisconnectIndBody_t |
Indication message body for WfmHiDisconnectInd_t.
Definition at line 877
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | Mac[6] | MAC address of the access point. |
uint16_t | Reason |
Reason for disconnection. WFM_REASON_UNSPECIFIED: The device was disconnected or it disconnected on its own. |
◆ WfmHiDisconnectInd_t
struct WfmHiDisconnectInd_t |
Indication message used to signal the completion of a disconnection operation.
The device will send this indication to signal the disconnection request initiated with WfmHiDisconnectReq_t has been completed. The indication is also sent when the device has lost the connection to an access point and has been unable to regain it.
Definition at line 897
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiDisconnectIndBody_t | Body | Indication message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiGetSignalStrengthCnfBody_t
struct WfmHiGetSignalStrengthCnfBody_t |
Confirmation message body for WfmHiGetSignalStrengthCnf_t.
Definition at line 915
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Rcpi |
Received Channel Power Indicator (RCPI) of the connection. See Received Channel Power Indicator for further details. |
uint32_t | Status |
Status of the get request. WFM_STATUS_SUCCESS: the get request was completed. |
◆ WfmHiGetSignalStrengthCnf_t
struct WfmHiGetSignalStrengthCnf_t |
Confirmation message for WfmHiGetSignalStrengthReq_t.
Definition at line 934
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiGetSignalStrengthCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetPmModeReqBody_t
struct WfmHiSetPmModeReqBody_t |
Request message body for WfmHiSetPmModeReq_t.
Definition at line 944
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint16_t | ListenInterval |
Number of beacons/DTIMs to skip while sleeping. 0: wake-up on every beacon/DTIM. |
uint16_t | PowerMode |
Power management mode. WFM_PM_MODE_ACTIVE: the device will not use Wi-Fi power management mechanisms. |
◆ WfmHiSetPmModeReq_t
struct WfmHiSetPmModeReq_t |
Request message for setting the power management mode of the device.
The host can use this request to enable or disable Wi-Fi power management mechanisms.
Definition at line 967
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetPmModeReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetPmModeCnfBody_t
struct WfmHiSetPmModeCnfBody_t |
Confirmation message body for WfmHiSetPmModeCnf_t.
Definition at line 977
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the power management request. WFM_STATUS_SUCCESS: the power management request was completed. |
◆ WfmHiSetPmModeCnf_t
struct WfmHiSetPmModeCnf_t |
Confirmation message for WfmHiSetPmModeReq_t.
Definition at line 991
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetPmModeCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiStartApReqBody_t
struct WfmHiStartApReqBody_t |
Request message body for WfmHiStartApReq_t.
Definition at line 1001
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint16_t | BeaconIeDataLength |
Length of vendor-specific Information Element (IE) data in 802.11 Beacon frames. 0 - 255: The amount of bytes. |
uint16_t | Channel |
Channel of the access point. 1 - 13: The device will create the access point on the given channel. |
uint8_t | ClientIsolation |
Boolean option to isolate connected clients from each other. 0: The device will allow connected clients to communicate with each other. |
uint8_t | HiddenSsid |
Boolean option to hide the network. 0: The device will advertise the SSID of the network to any near-by stations. |
uint8_t | MgmtFrameProtection |
Protected Management Frames (PMF) mode. WFM_MGMT_FRAME_PROTECTION_DISABLED: The device will not use PMF even if supported by the connecting station. |
uint8_t | Password[64] |
Password of the network. 64-bit WEP key: 5 bytes in ASCII format or 10 bytes in HEX format. |
uint16_t | PasswordLength |
Length of the network password. 0 - 64: The amount of bytes. |
uint16_t | ProbeRespIeDataLength |
Length of vendor-specific Information Element (IE) data in 802.11 Probe Response frames. 0 - 255: The amount of bytes. |
uint8_t | SecurityMode |
Security mode of the access point. WFM_SECURITY_MODE_OPEN: The device will only allow unsecured connections. |
WfmHiSsidDef_t | SsidDef | Service Set Identifier (SSID) of the network. |
◆ WfmHiStartApReq_t
struct WfmHiStartApReq_t |
Request message for starting a Wi-Fi network.
The host can use this request to iniate a Wi-Fi network.
Successful start request moves the interface to Wi-Fi access point state.
Definition at line 1090
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiStartApReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiStartApCnfBody_t
struct WfmHiStartApCnfBody_t |
Confirmation message body for WfmHiStartApCnf_t.
Definition at line 1100
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the start request. WFM_STATUS_SUCCESS: the start request was accepted. It will be completed by WfmHiStartApInd_t. |
◆ WfmHiStartApCnf_t
struct WfmHiStartApCnf_t |
Confirmation message for WfmHiStartApReq_t.
Definition at line 1114
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiStartApCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiStartApIndBody_t
struct WfmHiStartApIndBody_t |
Indication message body for WfmHiStartApInd_t.
Definition at line 1124
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the start request. WFM_STATUS_SUCCESS: the start request was completed successfully. |
◆ WfmHiStartApInd_t
struct WfmHiStartApInd_t |
Indication message used to signal the completion of a start request.
The device will send this indication to signal the start request initiated with WfmHiStartApReq_t has been completed.
Definition at line 1140
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiStartApIndBody_t | Body | Indication message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiUpdateApReqBody_t
struct WfmHiUpdateApReqBody_t |
Request message body for WfmHiUpdateApReq_t.
Definition at line 1150
of file wfm_cmd_api.h
.
◆ WfmHiUpdateApReq_t
struct WfmHiUpdateApReq_t |
Request message for updating parameters of the started Wi-Fi network.
The host can use this request to update parameters of the started Wi-Fi network.
Definition at line 1182
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiUpdateApReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiUpdateApCnfBody_t
struct WfmHiUpdateApCnfBody_t |
Confirmation message body for WfmHiUpdateApCnf_t.
Definition at line 1192
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the update request. WFM_STATUS_SUCCESS: the update request was completed. |
◆ WfmHiUpdateApCnf_t
struct WfmHiUpdateApCnf_t |
Confirmation message for WfmHiUpdateApReq_t.
Definition at line 1206
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiUpdateApCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiStopApCnfBody_t
struct WfmHiStopApCnfBody_t |
Confirmation message body for WfmHiStopApCnf_t.
Definition at line 1225
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the stop request. WFM_STATUS_SUCCESS: the stop request was accepted. It will be completed by WfmHiStopApInd_t. |
◆ WfmHiStopApCnf_t
struct WfmHiStopApCnf_t |
Confirmation message for WfmHiStopApReq_t.
Definition at line 1239
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiStopApCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiApClientConnectedIndBody_t
struct WfmHiApClientConnectedIndBody_t |
Indication message body for WfmHiApClientConnectedInd_t.
Definition at line 1259
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | Mac[6] | MAC address of the station. |
◆ WfmHiApClientConnectedInd_t
struct WfmHiApClientConnectedInd_t |
Indication message used to signal a connected station.
The device will send this indication to signal a station has connected to the started network.
Definition at line 1272
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiApClientConnectedIndBody_t | Body | Indication message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiApClientRejectedIndBody_t
struct WfmHiApClientRejectedIndBody_t |
Indication message body for WfmHiApClientRejectedInd_t.
Definition at line 1282
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | Mac[6] | MAC address of the station. |
uint16_t | Reason |
Reason for rejection. WFM_REASON_TIMEOUT: A timeout occurred during a station connection attempt. |
◆ WfmHiApClientRejectedInd_t
struct WfmHiApClientRejectedInd_t |
Indication message used to signal a rejected connection attempt from a station.
The device will send this indication to signal a station has attempted connection to the started network and was rejected by the device.
Definition at line 1303
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiApClientRejectedIndBody_t | Body | Indication message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiDisconnectApClientReqBody_t
struct WfmHiDisconnectApClientReqBody_t |
Request message body for WfmHiDisconnectApClientReq_t.
Definition at line 1313
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | Mac[6] | MAC address of the station. |
◆ WfmHiDisconnectApClientReq_t
struct WfmHiDisconnectApClientReq_t |
Request message for disconnecting a client from the started Wi-Fi network.
The host can use this request to disconnect a client from the started Wi-Fi network.
Definition at line 1325
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiDisconnectApClientReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiDisconnectApClientCnfBody_t
struct WfmHiDisconnectApClientCnfBody_t |
Confirmation message body for WfmHiDisconnectApClientCnf_t.
Definition at line 1335
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the disconnect request. WFM_STATUS_SUCCESS: the disconnect request was completed. |
◆ WfmHiDisconnectApClientCnf_t
struct WfmHiDisconnectApClientCnf_t |
Confirmation message for WfmHiDisconnectApClientReq_t.
Definition at line 1349
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiDisconnectApClientCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiApClientDisconnectedIndBody_t
struct WfmHiApClientDisconnectedIndBody_t |
Indication message body for WfmHiApClientDisconnectedInd_t.
Definition at line 1359
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | Mac[6] | MAC address of the station. |
uint16_t | Reason |
Reason for disconnection. WFM_REASON_LEAVING_BSS: The station was disconnected or it disconnected on its own. |
◆ WfmHiApClientDisconnectedInd_t
struct WfmHiApClientDisconnectedInd_t |
Indication message used to signal a disconnected station.
The device will send this indication to signal a station has left the started network.
Definition at line 1378
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiApClientDisconnectedIndBody_t | Body | Indication message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSendFrameReqBody_t
struct WfmHiSendFrameReqBody_t |
Request message body for WfmHiSendFrameReq_t.
Definition at line 1388
of file wfm_cmd_api.h
.
◆ WfmHiSendFrameReq_t
struct WfmHiSendFrameReq_t |
Request message for sending a packet to the network.
The host can use this request to send a packet to the network.
Definition at line 1424
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSendFrameReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSendFrameCnfBody_t
struct WfmHiSendFrameCnfBody_t |
Confirmation message body for WfmHiSendFrameCnf_t.
Definition at line 1434
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint16_t | PacketId | Packet ID number from the corresponding request. |
uint16_t | Reserved | Reserved. |
uint32_t | Status |
Status of the send request. WFM_STATUS_SUCCESS: the send request was completed. |
◆ WfmHiSendFrameCnf_t
struct WfmHiSendFrameCnf_t |
Confirmation message for WfmHiSendFrameReq_t.
Definition at line 1458
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSendFrameCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiReceivedIndBody_t
struct WfmHiReceivedIndBody_t |
Indication message body for WfmHiReceivedInd_t.
Definition at line 1468
of file wfm_cmd_api.h
.
◆ WfmHiReceivedInd_t
struct WfmHiReceivedInd_t |
Indication message used to signal a received packet.
The device will send this indication to signal a packet has been received.
Definition at line 1503
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiReceivedIndBody_t | Body | Indication message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiStartScanReqBody_t
struct WfmHiStartScanReqBody_t |
Request message body for WfmHiStartScanReq_t.
Definition at line 1513
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint16_t | ChannelListCount |
The amount of specific channels to scan. 0: The device will scan all channels |
uint16_t | IeDataLength |
Length of vendor-specific Information Element (IE) data in 802.11 Probe Request frames. 0 - 255: The amount of bytes. |
uint16_t | ScanMode |
Scan mode. WFM_SCAN_MODE_PASSIVE: The device will perform a passive scan. |
uint16_t | SsidListCount |
The amount of specific SSIDs to scan. 0: The device will perform a broadcast scan |
◆ WfmHiStartScanReq_t
struct WfmHiStartScanReq_t |
Request message for starting a scan to detect near-by access points.
The host can use this request to start a scan operation to detect near-by access points.
Definition at line 1567
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiStartScanReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiStartScanCnfBody_t
struct WfmHiStartScanCnfBody_t |
Confirmation message body for WfmHiStartScanCnf_t.
Definition at line 1577
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the scan request. WFM_STATUS_SUCCESS: the scan request was accepted. It will be completed by WfmHiScanCompleteInd_t. |
◆ WfmHiStartScanCnf_t
struct WfmHiStartScanCnf_t |
Confirmation message for WfmHiStartScanReq_t.
Definition at line 1592
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiStartScanCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiStopScanCnfBody_t
struct WfmHiStopScanCnfBody_t |
Confirmation message body for WfmHiStopScanCnf_t.
Definition at line 1611
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the stop request. WFM_STATUS_SUCCESS: the stop request was accepted. It will be completed by WfmHiScanResultInd_t. |
◆ WfmHiStopScanCnf_t
struct WfmHiStopScanCnf_t |
Confirmation message for WfmHiStopScanReq_t.
Definition at line 1626
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiStopScanCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiScanResultIndBody_t
struct WfmHiScanResultIndBody_t |
Indication message body for WfmHiScanResultInd_t.
Definition at line 1636
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint16_t | Channel |
Channel of the access point. 1 - 13: Channel number. |
uint16_t | IeDataLength | Length of access point Information Element (IE) data in bytes. |
uint8_t | Mac[6] | MAC address of the access point. |
uint16_t | Rcpi |
Received Channel Power Indicator (RCPI) of the access point. See Received Channel Power Indicator for further details. |
uint32_t | Reserved | Reserved. |
WfmHiSsidDef_t | SsidDef | Service Set Identifier (SSID) of the network. |
◆ WfmHiScanResultInd_t
struct WfmHiScanResultInd_t |
Indication message used to signal an access point has been detected.
The device will send this indication to signal an access point has has been detected during the scan operation.
Definition at line 1676
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiScanResultIndBody_t | Body | Indication message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiScanCompleteIndBody_t
struct WfmHiScanCompleteIndBody_t |
Indication message body for WfmHiScanCompleteInd_t.
Definition at line 1686
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the scan request. WFM_STATUS_SUCCESS: the scan request was completed. |
◆ WfmHiScanCompleteInd_t
struct WfmHiScanCompleteInd_t |
Indication message used to signal a scan was completed.
The device will send this indication to signal a scan operation has been completed.
Definition at line 1703
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiScanCompleteIndBody_t | Body | Indication message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiJoinIbssReqBody_t
struct WfmHiJoinIbssReqBody_t |
Request message body for WfmHiJoinIbssReq_t.
Definition at line 1713
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Channel |
Channel of the network. 0: The device will connect to a matching network on any channel. |
uint8_t | Password[64] |
Password of the network. 64-bit WEP key: 5 bytes in ASCII format or 10 bytes in HEX format. |
uint16_t | PasswordLength |
Length of the network password. 0 - 26: The amount of bytes. |
uint16_t | SecurityMode |
Security mode of the network. WFM_SECURITY_MODE_OPEN: The device will only use unsecured connections. |
WfmHiSsidDef_t | SsidDef | Service Set Identifier (SSID) of the network. |
◆ WfmHiJoinIbssReq_t
struct WfmHiJoinIbssReq_t |
Request message for connecting to or starting an IBSS network.
The host can use this request to connect to an IBSS network. If no existing network is found, the device will start a new network.
Successful join request moves the interface to IBSS station state.
Definition at line 1752
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiJoinIbssReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiJoinIbssCnfBody_t
struct WfmHiJoinIbssCnfBody_t |
Confirmation message body for WfmHiJoinIbssCnf_t.
Definition at line 1762
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the join request. WFM_STATUS_SUCCESS: the join request was accepted. It will be completed by WfmHiJoinIbssInd_t. |
◆ WfmHiJoinIbssCnf_t
struct WfmHiJoinIbssCnf_t |
Confirmation message for WfmHiJoinIbssReq_t.
Definition at line 1776
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiJoinIbssCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiJoinIbssIndBody_t
struct WfmHiJoinIbssIndBody_t |
Indication message body for WfmHiJoinIbssInd_t.
Definition at line 1786
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | Bssid[6] |
Basic Service Set Identifier (BSSID) of the network.
|
uint16_t | Reserved | Reserved. |
uint32_t | Status |
Status of the join request. WFM_STATUS_SUCCESS: the join request was completed successfully. |
◆ WfmHiJoinIbssInd_t
struct WfmHiJoinIbssInd_t |
Indication message used to signal the completion of a join request.
The device will send this indication to signal the join request initiated with WfmHiJoinIbssReq_t has been completed.
Definition at line 1811
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiJoinIbssIndBody_t | Body | Indication message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiLeaveIbssCnfBody_t
struct WfmHiLeaveIbssCnfBody_t |
Confirmation message body for WfmHiLeaveIbssCnf_t.
Definition at line 1830
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the disconnect request. WFM_STATUS_SUCCESS: the disconnect request was accepted. It will be completed by WfmHiLeaveIbssInd_t. |
◆ WfmHiLeaveIbssCnf_t
struct WfmHiLeaveIbssCnf_t |
Confirmation message for WfmHiLeaveIbssReq_t.
Definition at line 1844
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiLeaveIbssCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiAddMulticastAddrReqBody_t
struct WfmHiAddMulticastAddrReqBody_t |
Request message body for WfmHiAddMulticastAddrReq_t.
Definition at line 1864
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | Mac[6] |
MAC address to add. broadcast address: The device will empty the whitelist and allow all multicast addresses. |
◆ WfmHiAddMulticastAddrReq_t
struct WfmHiAddMulticastAddrReq_t |
Request message for adding a multicast address to the multicast filter whitelist.
The host can use this request to add a multicast address to the multicast filter whitelist. When the first address is added the whitelist, the device will discard all multicast frames whose destination address does not match any of the addresses on the list. The default state is to allow all multicast addresses.
See Filtering for further details.
Definition at line 1885
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiAddMulticastAddrReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiAddMulticastAddrCnfBody_t
struct WfmHiAddMulticastAddrCnfBody_t |
Confirmation message body for WfmHiAddMulticastAddrCnf_t.
Definition at line 1895
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the add request. WFM_STATUS_SUCCESS: the add request was completed successfully. |
◆ WfmHiAddMulticastAddrCnf_t
struct WfmHiAddMulticastAddrCnf_t |
Confirmation message for WfmHiAddMulticastAddrReq_t.
Definition at line 1910
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiAddMulticastAddrCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiRemoveMulticastAddrReqBody_t
struct WfmHiRemoveMulticastAddrReqBody_t |
Request message body for WfmHiRemoveMulticastAddrReq_t.
Definition at line 1920
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | Mac[6] |
MAC address to remove. unicast address: The device will remove the given address from the whitelist. |
◆ WfmHiRemoveMulticastAddrReq_t
struct WfmHiRemoveMulticastAddrReq_t |
Request message for removing a multicast address from the multicast filter whitelist.
The host can use this request to remove a multicast address from the multicast filter whitelist.
Definition at line 1936
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiRemoveMulticastAddrReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiRemoveMulticastAddrCnfBody_t
struct WfmHiRemoveMulticastAddrCnfBody_t |
Confirmation message body for WfmHiRemoveMulticastAddrCnf_t.
Definition at line 1946
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the remove request. WFM_STATUS_SUCCESS: the remove request was completed successfully. |
◆ WfmHiRemoveMulticastAddrCnf_t
struct WfmHiRemoveMulticastAddrCnf_t |
Confirmation message for WfmHiRemoveMulticastAddrReq_t.
Definition at line 1961
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiRemoveMulticastAddrCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetMaxApClientCountReqBody_t
struct WfmHiSetMaxApClientCountReqBody_t |
Request message body for WfmHiSetMaxApClientCountReq_t.
Definition at line 1971
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Count |
Maximum number of connected clients. 0: The device will set the limit value to the firmware default. |
◆ WfmHiSetMaxApClientCountReq_t
struct WfmHiSetMaxApClientCountReq_t |
Request message for setting the maximum number of connected clients.
The host can use this request to limit the number of stations that can connect the started Wi-Fi network.
Definition at line 1986
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetMaxApClientCountReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetMaxApClientCountCnfBody_t
struct WfmHiSetMaxApClientCountCnfBody_t |
Confirmation message body for WfmHiSetMaxApClientCountCnf_t.
Definition at line 1996
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the set request. WFM_STATUS_SUCCESS: the set request was completed successfully. |
◆ WfmHiSetMaxApClientCountCnf_t
struct WfmHiSetMaxApClientCountCnf_t |
Confirmation message for WfmHiSetMaxApClientCountReq_t.
Definition at line 2010
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetMaxApClientCountCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetMaxApClientInactivityReqBody_t
struct WfmHiSetMaxApClientInactivityReqBody_t |
Request message body for WfmHiSetMaxApClientInactivityReq_t.
Definition at line 2020
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | InactivityTimeout |
Maximum amount of client idle time. 0: The device will set the limit value to the firmware default. |
◆ WfmHiSetMaxApClientInactivityReq_t
struct WfmHiSetMaxApClientInactivityReq_t |
Request message for setting the maximum number of connected clients.
The host can use this request to limit the number of stations that can connect the started Wi-Fi network.
Definition at line 2035
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetMaxApClientInactivityReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetMaxApClientInactivityCnfBody_t
struct WfmHiSetMaxApClientInactivityCnfBody_t |
Confirmation message body for WfmHiSetMaxApClientCountCnf_t.
Definition at line 2045
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the set request. WFM_STATUS_SUCCESS: the set request was completed successfully. |
◆ WfmHiSetMaxApClientInactivityCnf_t
struct WfmHiSetMaxApClientInactivityCnf_t |
Confirmation message for WfmHiSetMaxApClientInactivityReq_t.
Definition at line 2059
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetMaxApClientInactivityCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetRoamParametersReqBody_t
struct WfmHiSetRoamParametersReqBody_t |
Request message body for WfmHiSetRoamParametersReq_t.
Definition at line 2069
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | BeaconLostCount |
Beacon loss limit for a roaming attempt. 0: The device will set the limit value to the firmware default. |
uint8_t | ChannelListCount |
The amount of specific channels to scan. 0: The device will scan all channels. |
uint8_t | RcpiHysteresis |
Upper RCPI limit that must be attained before triggering roaming again. 0: The device will set the limit value to the firmware default. |
uint8_t | RcpiThreshold |
Received Channel Power Indicator (RCPI) limit for a roaming attempt. 0: The device will set the limit value to the firmware default. |
◆ WfmHiSetRoamParametersReq_t
struct WfmHiSetRoamParametersReq_t |
Request message for setting the roaming parameters.
The host can use this request to configure the roaming parameters of the device.
See Roaming for further details.
Definition at line 2116
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetRoamParametersReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetRoamParametersCnfBody_t
struct WfmHiSetRoamParametersCnfBody_t |
Confirmation message body for WfmHiSetRoamParametersCnf_t.
Definition at line 2126
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the set request. WFM_STATUS_SUCCESS: the set request was completed successfully. |
◆ WfmHiSetRoamParametersCnf_t
struct WfmHiSetRoamParametersCnf_t |
Confirmation message for WfmHiSetRoamParametersReq_t.
Definition at line 2141
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetRoamParametersCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetTxRateParametersReqBody_t
struct WfmHiSetTxRateParametersReqBody_t |
Request message body for WfmHiSetTxRateParametersReq_t.
Definition at line 2151
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiRateSetBitmask_t | RateSetBitmask | TX rate set parameters. |
uint32_t | Reserved | Reserved, set to zero. |
◆ WfmHiSetTxRateParametersReq_t
struct WfmHiSetTxRateParametersReq_t |
Request message for setting the TX rate set parameters.
The host can use this request to configure the TX rate set parameters of the device. The rate set determines what data rates will be used by the device to transmit data frames.
Definition at line 2171
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetTxRateParametersReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetTxRateParametersCnfBody_t
struct WfmHiSetTxRateParametersCnfBody_t |
Confirmation message body for WfmHiSetTxRateParametersCnf_t.
Definition at line 2181
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the set request. WFM_STATUS_SUCCESS: the set request was completed successfully. |
◆ WfmHiSetTxRateParametersCnf_t
struct WfmHiSetTxRateParametersCnf_t |
Confirmation message for WfmHiSetTxRateParametersReq_t.
Definition at line 2196
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetTxRateParametersCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetArpIpAddressReqBody_t
struct WfmHiSetArpIpAddressReqBody_t |
Request message body for WfmHiSetArpIpAddressReq_t.
Definition at line 2206
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | ArpIpAddr[2] |
List of offloaded ARP IP addresses. The device will automatically reply to an ARP request that matches one the addresses on the list. Note that addresses not in use must be set to zero. Offloading is disabled by setting all addresses to zero. |
◆ WfmHiSetArpIpAddressReq_t
struct WfmHiSetArpIpAddressReq_t |
Request message for setting the Address Resolution Protocol (ARP) offloading state.
The host can use this request to offload handling of ARP requests to the device. When offloading is enabled, the device will automatically respond to ARP requests with an ARP reply.
See Offloading for further details.
Definition at line 2226
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetArpIpAddressReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetArpIpAddressCnfBody_t
struct WfmHiSetArpIpAddressCnfBody_t |
Confirmation message body for WfmHiSetArpIpAddressCnf_t.
Definition at line 2236
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the set request. WFM_STATUS_SUCCESS: the set request was completed successfully. |
◆ WfmHiSetArpIpAddressCnf_t
struct WfmHiSetArpIpAddressCnf_t |
Confirmation message for WfmHiSetArpIpAddressReq_t.
Definition at line 2250
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetArpIpAddressCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetNsIpAddressReqBody_t
struct WfmHiSetNsIpAddressReqBody_t |
Request message body for WfmHiSetNsIpAddressReq_t.
Definition at line 2260
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiNsIpAddr_t | NsIpAddr[2] |
List of offloaded NS IP addresses. The device will automatically reply to a NS that matches one the addresses on the list. Note that addresses not in use must be set to zero. Offloading is disabled by setting all addresses to zero. |
◆ WfmHiSetNsIpAddressReq_t
struct WfmHiSetNsIpAddressReq_t |
Request message for setting the Neighbor Discovery Protocol (NDP) offloading state.
The host can use this request to offload handling of IPv6 Neighbor Solicitations to the device. When offloading is enabled, the device will automatically respond to a solicitation with a Neighbor Advertisement.
See Offloading for further details.
Definition at line 2279
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetNsIpAddressReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetNsIpAddressCnfBody_t
struct WfmHiSetNsIpAddressCnfBody_t |
Confirmation message body for WfmHiSetNsIpAddressCnf_t.
Definition at line 2289
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the set request. WFM_STATUS_SUCCESS: the set request was completed successfully. |
◆ WfmHiSetNsIpAddressCnf_t
struct WfmHiSetNsIpAddressCnf_t |
Confirmation message for WfmHiSetNsIpAddressReq_t.
Definition at line 2303
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetNsIpAddressCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetBroadcastFilterReqBody_t
struct WfmHiSetBroadcastFilterReqBody_t |
Request message body for WfmHiSetBroadcastFilterReq_t.
Definition at line 2313
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Filter |
Boolean option for broadcast filtering. 0: The device will forward all received broadcast frames to the host. |
◆ WfmHiSetBroadcastFilterReq_t
struct WfmHiSetBroadcastFilterReq_t |
Request message for setting broadcast filter state.
The host can use this request to configure the state of the broadcast filter. When enabled, the device will only forward certain broadcast frames to the host and automatically discard the rest. The default state is to allow all broadcast traffic.
See Filtering for further details.
Definition at line 2333
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetBroadcastFilterReqBody_t | Body | Request message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetBroadcastFilterCnfBody_t
struct WfmHiSetBroadcastFilterCnfBody_t |
Confirmation message body for WfmHiSetBroadcastFilterCnf_t.
Definition at line 2343
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the set request. WFM_STATUS_SUCCESS: the set request was completed successfully. |
◆ WfmHiSetBroadcastFilterCnf_t
struct WfmHiSetBroadcastFilterCnf_t |
Confirmation message for WfmHiSetBroadcastFilterReq_t.
Definition at line 2357
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
WfmHiSetBroadcastFilterCnfBody_t | Body | Confirmation message body. |
HiMsgHdr_t | Header | Common message header. |
◆ WfmHiSetScanParametersReqBody_t
struct WfmHiSetScanParametersReqBody_t |
Request message body for WfmHiSetScanParametersReq_t.
Definition at line 2367
of file wfm_cmd_api.h
.
◆ WfmHiSetScanParametersReq_t
struct WfmHiSetScanParametersReq_t |
Request message for setting scan parameters.
The host can use this request to configure scans.
Definition at line 2391
of file wfm_cmd_api.h
.
◆ WfmHiSetScanParametersCnfBody_t
struct WfmHiSetScanParametersCnfBody_t |
Confirmation message body for WfmHiSetScanParametersCnf_t.
Definition at line 2399
of file wfm_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | Status |
Status of the set request. WFM_STATUS_SUCCESS: the set request was completed successfully. |
◆ WfmHiSetScanParametersCnf_t
struct WfmHiSetScanParametersCnf_t |
Confirmation message for WfmHiSetScanParametersReq_t.
Definition at line 2413
of file wfm_cmd_api.h
.
◆ WfmHiDisconnectReq_t
struct WfmHiDisconnectReq_t |
Request message for disconnecting from a Wi-Fi network.
The host can use this request to iniate a disconnection from a Wi-Fi network.
Successful disconnection request moves the interface to Idle state.
◆ WfmHiGetSignalStrengthReq_t
struct WfmHiGetSignalStrengthReq_t |
Request message for retrieving the signal strength of connection.
The host can use this request to retrieve the signal strength of the connection.
◆ WfmHiStopApReq_t
struct WfmHiStopApReq_t |
Request message for stopping the started Wi-Fi network.
The host can use this request to stop the started Wi-Fi network.
Successful stop request moves the interface to Idle state.
◆ WfmHiStopApInd_t
struct WfmHiStopApInd_t |
Indication message used to signal the completion of a stop operation.
The device will send this indication to signal the stop request initiated with WfmHiStopApReq_t has been completed. The indication is also sent when the started network has encountered a fatal error.
◆ WfmHiStopScanReq_t
struct WfmHiStopScanReq_t |
Request message for stopping an ongoing scan.
The host can use this request to stop an ongoing scan operation.
◆ WfmHiLeaveIbssReq_t
struct WfmHiLeaveIbssReq_t |
Request message for disconnecting from an IBSS network.
The host can use this request to disconnect from an IBSS network.
Successful disconnect request moves the interface to Idle state.
◆ WfmHiLeaveIbssInd_t
struct WfmHiLeaveIbssInd_t |
Indication message used to signal the completion of a disconnect operation.
The device will send this indication to signal the disconnect request initiated with WfmHiLeaveIbssReq_t has been completed. The indication is also sent when the network has encountered a fatal error.