API messages
WFM API messages.
Detailed Description
WFM API messages.
Data Structure Documentation
◆ sl_wfx_set_mac_address_req_body_t
struct sl_wfx_set_mac_address_req_body_t |
Request message body for sl_wfx_set_mac_address_req_t .
Field | Default value | Reset to default value |
---|---|---|
MAC address | device dependent | when device reset |
Definition at line
735
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | mac_addr[6] | MAC address of the interface. |
uint16_t | reserved | Reserved, set to zero. |
◆ sl_wfx_set_mac_address_req_t
struct sl_wfx_set_mac_address_req_t |
Request message to set MAC address of the interface.
The host can use this request to set the MAC address of 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.
Interface mode | Request allowed |
---|---|
idle | Yes |
station | No |
AP | No |
Definition at line
756
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_mac_address_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_mac_address_cnf_body_t
struct sl_wfx_set_mac_address_cnf_body_t |
Confirmation message body for sl_wfx_set_mac_address_cnf_t .
Definition at line
766
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_set_mac_address_cnf_t
struct sl_wfx_set_mac_address_cnf_t |
Confirmation message for sl_wfx_set_mac_address_req_t .
Definition at line
780
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_mac_address_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_connect_req_body_t
struct sl_wfx_connect_req_body_t |
Request message body for sl_wfx_connect_req_t .
Definition at line
790
of file
sl_wfx_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.
|
uint8_t | ie_data[] |
Vendor-specific IE data added to the 802.11 Association Request frames.
The IE data must be in 802.11 Vendor-Specific Element format. It may contain multiple concatenated IEs, up to the maximum length.
|
uint16_t | ie_data_length |
Length of vendor-specific Information Element (IE) data.
0 - 255 : The amount of bytes. |
uint16_t | mgmt_frame_protection |
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 | password_length |
Length of the network password.
0 - 64 : The amount of bytes. |
uint8_t | prevent_roaming |
Boolean option to prevent roaming between access points.
0
: The device may roam to any matching access point within the same network.
|
uint8_t | security_mode |
Security mode of the network.
WFM_SECURITY_MODE_OPEN
: The device will only connect to an unsecured Access Point.
|
sl_wfx_ssid_def_t | ssid_def | Service Set Identifier (SSID) of the network. |
◆ sl_wfx_connect_req_t
struct sl_wfx_connect_req_t |
Request message for connecting to a Wi-Fi network.
The host can use this request to initiate a connection to a Wi-Fi network. An ongoing connection attempt can be canceled by sending sl_wfx_disconnect_req_t message. Completion of the connection request will be signaled by sl_wfx_connect_ind_t message. It may take up to 10 seconds to receive the message.
Interface mode | Request allowed |
---|---|
idle | Yes |
station | No |
AP | No |
Definition at line
874
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_connect_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_connect_cnf_body_t
struct sl_wfx_connect_cnf_body_t |
Confirmation message body for sl_wfx_connect_cnf_t .
Definition at line
884
of file
sl_wfx_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
sl_wfx_connect_ind_t
.
|
◆ sl_wfx_connect_cnf_t
struct sl_wfx_connect_cnf_t |
Confirmation message for sl_wfx_connect_req_t .
Definition at line
898
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_connect_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_connect_ind_body_t
struct sl_wfx_connect_ind_body_t |
Indication message body for sl_wfx_connect_ind_t .
Definition at line
908
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_connect_ind_t
struct sl_wfx_connect_ind_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 sl_wfx_connect_req_t has been completed. The indication is also sent when the device autonomously roams to another access point.
Definition at line
948
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_connect_ind_body_t | body | Indication message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_disconnect_cnf_body_t
struct sl_wfx_disconnect_cnf_body_t |
Confirmation message body for sl_wfx_disconnect_cnf_t .
Definition at line
971
of file
sl_wfx_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
sl_wfx_disconnect_ind_t
.
|
◆ sl_wfx_disconnect_cnf_t
struct sl_wfx_disconnect_cnf_t |
Confirmation message for sl_wfx_disconnect_req_t .
Definition at line
985
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_disconnect_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_disconnect_ind_body_t
struct sl_wfx_disconnect_ind_body_t |
Indication message body for sl_wfx_disconnect_ind_t .
Definition at line
995
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_disconnect_ind_t
struct sl_wfx_disconnect_ind_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 sl_wfx_disconnect_req_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
1019
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_disconnect_ind_body_t | body | Indication message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_get_signal_strength_cnf_body_t
struct sl_wfx_get_signal_strength_cnf_body_t |
Confirmation message body for sl_wfx_get_signal_strength_cnf_t .
Definition at line
1042
of file
sl_wfx_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.
|
◆ sl_wfx_get_signal_strength_cnf_t
struct sl_wfx_get_signal_strength_cnf_t |
Confirmation message for sl_wfx_get_signal_strength_req_t .
Definition at line
1061
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_get_signal_strength_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_pm_mode_req_body_t
struct sl_wfx_set_pm_mode_req_body_t |
Request message body for sl_wfx_set_pm_mode_req_t .
Field | Default value | Reset to default value |
---|---|---|
power_mode | WFM_PM_MODE_ACTIVE | when interface stopped |
listen_interval | 0 | when interface stopped |
Definition at line
1077
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint16_t | listen_interval |
Number of beacons/DTIMs to skip while sleeping.
0
: wake-up on every beacon/DTIM.
|
uint8_t | polling_strategy |
Power save polling strategy.
WFM_PM_POLL_UAPSD
: the device will use U-APSD (default).
|
uint8_t | power_mode |
Power management mode.
WFM_PM_MODE_ACTIVE
: the device will not use Wi-Fi power management mechanisms.
|
◆ sl_wfx_set_pm_mode_req_t
struct sl_wfx_set_pm_mode_req_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.
Interface mode | Request allowed |
---|---|
idle | No |
station | Yes |
AP | No |
Definition at line
1113
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_pm_mode_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_pm_mode_cnf_body_t
struct sl_wfx_set_pm_mode_cnf_body_t |
Confirmation message body for sl_wfx_set_pm_mode_cnf_t .
Definition at line
1123
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_set_pm_mode_cnf_t
struct sl_wfx_set_pm_mode_cnf_t |
Confirmation message for sl_wfx_set_pm_mode_req_t .
Definition at line
1137
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_pm_mode_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_start_ap_req_body_t
struct sl_wfx_start_ap_req_body_t |
Request message body for sl_wfx_start_ap_req_t .
Definition at line
1157
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint16_t | beacon_ie_data_length |
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 | client_isolation |
Boolean option to isolate connected clients from each other.
0
: The device will allow connected clients to communicate with each other.
|
uint8_t | hidden_ssid |
Boolean option to hide the network.
0
: The device will advertise the SSID of the network to any near-by stations.
|
uint8_t | ie_data[] |
Vendor-specific IE data added to the 802.11 Beacon frames and Probe Response frames.
The IE data must be in 802.11 Vendor-Specific Element format. It may contain multiple concatenated IEs, up to the maximum length. First part of the IE data, up to the amount of bytes specified in BeaconIeDataLength, is added to the Beacon frames. The remaining part whose length is defined in ProbeRespIeDataLength is added to the Probe Response frames.
|
uint8_t | mgmt_frame_protection |
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 | password_length |
Length of the network password.
0 - 64 : The amount of bytes. |
uint16_t | probe_resp_ie_data_length |
Length of vendor-specific Information Element (IE) data in 802.11 Probe Response frames.
0 - 255 : The amount of bytes. |
uint8_t | security_mode |
Security mode of the Access Point.
WFM_SECURITY_MODE_OPEN
: The device will only allow unsecured connections.
|
sl_wfx_ssid_def_t | ssid_def | Service Set Identifier (SSID) of the network. |
◆ sl_wfx_start_ap_req_t
struct sl_wfx_start_ap_req_t |
Request message for starting a Wi-Fi network.
The host can use this request to initiate a Wi-Fi network.
Interface mode | Request allowed |
---|---|
idle | Yes |
station | No |
AP | No |
Definition at line
1248
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_start_ap_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_start_ap_cnf_body_t
struct sl_wfx_start_ap_cnf_body_t |
Confirmation message body for sl_wfx_start_ap_cnf_t .
Definition at line
1258
of file
sl_wfx_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
sl_wfx_start_ap_ind_t
.
|
◆ sl_wfx_start_ap_cnf_t
struct sl_wfx_start_ap_cnf_t |
Confirmation message for sl_wfx_start_ap_req_t .
Definition at line
1272
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_start_ap_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_start_ap_ind_body_t
struct sl_wfx_start_ap_ind_body_t |
Indication message body for sl_wfx_start_ap_ind_t .
Definition at line
1282
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_start_ap_ind_t
struct sl_wfx_start_ap_ind_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 sl_wfx_start_ap_req_t has been completed.
Definition at line
1298
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_start_ap_ind_body_t | body | Indication message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_update_ap_req_body_t
struct sl_wfx_update_ap_req_body_t |
Request message body for sl_wfx_update_ap_req_t .
Definition at line
1308
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint16_t | beacon_ie_data_length |
Length of vendor-specific Information Element (IE) data in 802.11 Beacon frames.
0 - 255 : The amount of bytes. |
uint8_t | ie_data[] |
Vendor-specific IE data added to the 802.11 Beacon frames and Probe Response frames.
The IE data must be in 802.11 Vendor-Specific Element format. It may contain multiple concatenated IEs, up to the maximum length. First part of the IE data, up to the amount of bytes specified in BeaconIeDataLength, is added to the Beacon frames. The remaining part whose length is defined in ProbeRespIeDataLength is added to the Probe Response frames.
|
uint16_t | probe_resp_ie_data_length |
Length of vendor-specific Information Element (IE) data in 802.11 Probe Response frames.
0 - 255 : The amount of bytes. |
◆ sl_wfx_update_ap_req_t
struct sl_wfx_update_ap_req_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.
Interface mode | Request allowed |
---|---|
idle | No |
station | No |
AP | Yes |
Definition at line
1342
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_update_ap_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_update_ap_cnf_body_t
struct sl_wfx_update_ap_cnf_body_t |
Confirmation message body for sl_wfx_update_ap_cnf_t .
Definition at line
1352
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_update_ap_cnf_t
struct sl_wfx_update_ap_cnf_t |
Confirmation message for sl_wfx_update_ap_req_t .
Definition at line
1366
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_update_ap_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_stop_ap_cnf_body_t
struct sl_wfx_stop_ap_cnf_body_t |
Confirmation message body for sl_wfx_stop_ap_cnf_t .
Definition at line
1389
of file
sl_wfx_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
sl_wfx_stop_ap_ind_t
.
|
◆ sl_wfx_stop_ap_cnf_t
struct sl_wfx_stop_ap_cnf_t |
Confirmation message for sl_wfx_stop_ap_req_t .
Definition at line
1403
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_stop_ap_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_ap_client_connected_ind_body_t
struct sl_wfx_ap_client_connected_ind_body_t |
Indication message body for sl_wfx_ap_client_connected_ind_t .
Definition at line
1423
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | mac[6] | MAC address of the station. |
◆ sl_wfx_ap_client_connected_ind_t
struct sl_wfx_ap_client_connected_ind_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
1436
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_ap_client_connected_ind_body_t | body | Indication message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_ap_client_rejected_ind_body_t
struct sl_wfx_ap_client_rejected_ind_body_t |
Indication message body for sl_wfx_ap_client_rejected_ind_t .
Definition at line
1446
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_ap_client_rejected_ind_t
struct sl_wfx_ap_client_rejected_ind_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
1469
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_ap_client_rejected_ind_body_t | body | Indication message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_disconnect_ap_client_req_body_t
struct sl_wfx_disconnect_ap_client_req_body_t |
Request message body for sl_wfx_disconnect_ap_client_req_t .
Definition at line
1479
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | mac[6] | MAC address of the station. |
◆ sl_wfx_disconnect_ap_client_req_t
struct sl_wfx_disconnect_ap_client_req_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.
Interface mode | Request allowed |
---|---|
idle | No |
station | No |
AP | Yes |
Definition at line
1497
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_disconnect_ap_client_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_disconnect_ap_client_cnf_body_t
struct sl_wfx_disconnect_ap_client_cnf_body_t |
Confirmation message body for sl_wfx_disconnect_ap_client_cnf_t .
Definition at line
1507
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_disconnect_ap_client_cnf_t
struct sl_wfx_disconnect_ap_client_cnf_t |
Confirmation message for sl_wfx_disconnect_ap_client_req_t .
Definition at line
1521
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_disconnect_ap_client_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_ap_client_disconnected_ind_body_t
struct sl_wfx_ap_client_disconnected_ind_body_t |
Indication message body for sl_wfx_ap_client_disconnected_ind_t .
Definition at line
1531
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_ap_client_disconnected_ind_t
struct sl_wfx_ap_client_disconnected_ind_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
1550
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_ap_client_disconnected_ind_body_t | body | Indication message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_send_frame_req_body_t
struct sl_wfx_send_frame_req_body_t |
Request message body for sl_wfx_send_frame_req_t .
Definition at line
1560
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | frame_type |
Packet type.
0 : Data packet with Ethernet II frame header. |
uint8_t | packet_data[] |
Data of the packet.
See Packet types for further details. |
uint32_t | packet_data_length |
Length of packet data.
1 - 1604 : The amount of bytes. |
uint16_t | packet_id |
Packet ID number.
0 - 65535
: Host-assigned unique number for the packet.
|
uint8_t | priority |
User Priority level.
0 - 7 : 802.1D Priority field value. |
◆ sl_wfx_send_frame_req_t
struct sl_wfx_send_frame_req_t |
Request message for sending a packet to the network.
The host can use this request to send a packet to the network.
Interface mode | Request allowed |
---|---|
idle | No |
station | Yes |
AP | Yes |
Definition at line
1601
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_send_frame_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_send_frame_cnf_body_t
struct sl_wfx_send_frame_cnf_body_t |
Confirmation message body for sl_wfx_send_frame_cnf_t .
Definition at line
1611
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_send_frame_cnf_t
struct sl_wfx_send_frame_cnf_t |
Confirmation message for sl_wfx_send_frame_req_t .
Definition at line
1634
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_send_frame_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_received_ind_body_t
struct sl_wfx_received_ind_body_t |
Indication message body for sl_wfx_received_ind_t .
Definition at line
1644
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | frame[] |
Packet data, including the padding bytes before the packet data.
See Packet types for further details. |
uint16_t | frame_length |
Length of packet data excluding the padding bytes.
1 - 2310 : The amount of bytes. |
uint8_t | frame_padding |
The amount of padding bytes before the packet data.
0 - 3 : The amount of bytes. |
uint8_t | frame_type |
Packet type.
0 : Data packet with Ethernet II frame header. |
◆ sl_wfx_received_ind_t
struct sl_wfx_received_ind_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
1674
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_received_ind_body_t | body | Indication message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_start_scan_req_body_t
struct sl_wfx_start_scan_req_body_t |
Request message body for sl_wfx_start_scan_req_t .
Definition at line
1684
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint16_t | channel_list_count |
The amount of specific channels to scan.
0
: The device will scan all channels
|
uint8_t | data[] |
Data for the variable-length scan parameters.
The variable-length scan parameters are concatenated together without any padding between the different parameters.
1 - 13
: The channel number to scan per byte.
Must contain the same number of WfmHiSsidDef_t elements as specified in SsidListCount.
The IE data must be in 802.11 Vendor-Specific Element format. It may contain multiple concatenated IEs, up to the maximum length.
broadcast address
: The device will send Probe Request frames to all devices.
|
uint16_t | ie_data_length |
Length of vendor-specific Information Element (IE) data in 802.11 Probe Request frames.
0 - 255 : The amount of bytes. |
uint16_t | scan_mode |
Scan mode.
WFM_SCAN_MODE_PASSIVE
: The device will perform a passive scan.
|
uint16_t | ssid_list_count |
The amount of specific SSIDs to scan.
0
: The device will perform a broadcast scan
|
◆ sl_wfx_start_scan_req_t
struct sl_wfx_start_scan_req_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.
Interface mode | Request allowed |
---|---|
idle | Yes |
station | Yes |
AP | No |
Definition at line
1748
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_start_scan_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_start_scan_cnf_body_t
struct sl_wfx_start_scan_cnf_body_t |
Confirmation message body for sl_wfx_start_scan_cnf_t .
Definition at line
1758
of file
sl_wfx_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
sl_wfx_scan_complete_ind_t
.
|
◆ sl_wfx_start_scan_cnf_t
struct sl_wfx_start_scan_cnf_t |
Confirmation message for sl_wfx_start_scan_req_t .
Definition at line
1773
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_start_scan_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_stop_scan_cnf_body_t
struct sl_wfx_stop_scan_cnf_body_t |
Confirmation message body for sl_wfx_stop_scan_cnf_t .
Definition at line
1797
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_stop_scan_cnf_t
struct sl_wfx_stop_scan_cnf_t |
Confirmation message for sl_wfx_stop_scan_req_t .
Definition at line
1812
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_stop_scan_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_scan_result_ind_body_t
struct sl_wfx_scan_result_ind_body_t |
Indication message body for sl_wfx_scan_result_ind_t .
Definition at line
1822
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint16_t | channel |
Channel of the access point.
1 - 13 : Channel number. |
uint8_t | ie_data[] | Access point IE data from the 802.11 Beacon or Probe Response frame. |
uint16_t | ie_data_length | 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. |
uint8_t | reserved1 | Reserved. |
uint16_t | reserved2 | Reserved. |
sl_wfx_security_mode_bitmask_t | security_mode | Security Capabilities of the network. |
sl_wfx_ssid_def_t | ssid_def | Service Set Identifier (SSID) of the network. |
◆ sl_wfx_scan_result_ind_t
struct sl_wfx_scan_result_ind_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
1870
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_scan_result_ind_body_t | body | Indication message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_scan_complete_ind_body_t
struct sl_wfx_scan_complete_ind_body_t |
Indication message body for sl_wfx_scan_complete_ind_t .
Definition at line
1880
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_scan_complete_ind_t
struct sl_wfx_scan_complete_ind_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
1897
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_scan_complete_ind_body_t | body | Indication message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_add_multicast_addr_req_body_t
struct sl_wfx_add_multicast_addr_req_body_t |
Request message body for sl_wfx_add_multicast_addr_req_t .
Definition at line
1907
of file
sl_wfx_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.
|
◆ sl_wfx_add_multicast_addr_req_t
struct sl_wfx_add_multicast_addr_req_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. The whitelist is reset to the default state when the interface is reset. Up to 8 multicast addresses may be added.
See
Filtering
for further details.
Interface mode | Request allowed |
---|---|
idle | No |
station | Yes |
AP | Yes |
Definition at line
1936
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_add_multicast_addr_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_add_multicast_addr_cnf_body_t
struct sl_wfx_add_multicast_addr_cnf_body_t |
Confirmation message body for sl_wfx_add_multicast_addr_cnf_t .
Definition at line
1946
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_add_multicast_addr_cnf_t
struct sl_wfx_add_multicast_addr_cnf_t |
Confirmation message for sl_wfx_add_multicast_addr_req_t .
Definition at line
1961
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_add_multicast_addr_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_remove_multicast_addr_req_body_t
struct sl_wfx_remove_multicast_addr_req_body_t |
Request message body for sl_wfx_remove_multicast_addr_req_t .
Definition at line
1971
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | mac[6] |
MAC address to remove.
multicast address
: The device will remove the given address from the whitelist.
|
◆ sl_wfx_remove_multicast_addr_req_t
struct sl_wfx_remove_multicast_addr_req_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.
Interface mode | Request allowed |
---|---|
idle | No |
station | Yes |
AP | Yes |
Definition at line
1993
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_remove_multicast_addr_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_remove_multicast_addr_cnf_body_t
struct sl_wfx_remove_multicast_addr_cnf_body_t |
Confirmation message body for sl_wfx_remove_multicast_addr_cnf_t .
Definition at line
2003
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_remove_multicast_addr_cnf_t
struct sl_wfx_remove_multicast_addr_cnf_t |
Confirmation message for sl_wfx_remove_multicast_addr_req_t .
Definition at line
2018
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_remove_multicast_addr_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_max_ap_client_count_req_body_t
struct sl_wfx_set_max_ap_client_count_req_body_t |
Request message body for sl_wfx_set_max_ap_client_count_req_t .
Field | Default value | Reset to default value |
---|---|---|
Count | 8 | when interface stopped |
Definition at line
2033
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | count |
Maximum number of connected clients.
0
: The device will set the limit value to the device default.
|
◆ sl_wfx_set_max_ap_client_count_req_t
struct sl_wfx_set_max_ap_client_count_req_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.
Interface mode | Request allowed |
---|---|
idle | No |
station | No |
AP | Yes |
Definition at line
2054
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_max_ap_client_count_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_max_ap_client_count_cnf_body_t
struct sl_wfx_set_max_ap_client_count_cnf_body_t |
Confirmation message body for sl_wfx_set_max_ap_client_count_cnf_t .
Definition at line
2064
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_set_max_ap_client_count_cnf_t
struct sl_wfx_set_max_ap_client_count_cnf_t |
Confirmation message for sl_wfx_set_max_ap_client_count_req_t .
Definition at line
2078
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_max_ap_client_count_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_max_ap_client_inactivity_req_body_t
struct sl_wfx_set_max_ap_client_inactivity_req_body_t |
Request message body for sl_wfx_set_max_ap_client_inactivity_req_t .
Field | Default value | Reset to default value |
---|---|---|
inactivity_timeout | 65 | when interface stopped |
Definition at line
2093
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | inactivity_timeout |
Maximum amount of client idle time.
0
: The device will set the limit value to the device default.
|
◆ sl_wfx_set_max_ap_client_inactivity_req_t
struct sl_wfx_set_max_ap_client_inactivity_req_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.
Interface mode | Request allowed |
---|---|
idle | No |
station | No |
AP | Yes |
Definition at line
2114
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_max_ap_client_inactivity_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_max_ap_client_inactivity_cnf_body_t
struct sl_wfx_set_max_ap_client_inactivity_cnf_body_t |
Confirmation message body for sl_wfx_set_max_ap_client_count_cnf_t .
Definition at line
2124
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_set_max_ap_client_inactivity_cnf_t
struct sl_wfx_set_max_ap_client_inactivity_cnf_t |
Confirmation message for sl_wfx_set_max_ap_client_inactivity_req_t .
Definition at line
2138
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_max_ap_client_inactivity_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_roam_parameters_req_body_t
struct sl_wfx_set_roam_parameters_req_body_t |
Request message body for sl_wfx_set_roam_parameters_req_t .
Field | Default value | Reset to default value |
---|---|---|
rcpi_threshold | 60 | when device reset |
rcpi_hysteresis | 120 | when device reset |
beacon_lost_count | 10 | when device reset |
channel_list_count | 13 | when device reset |
channel_number | 1 to 13 | when device reset |
Definition at line
2157
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | beacon_lost_count |
Beacon loss limit for a roaming attempt.
0
: The device will set the limit value to the device default.
|
uint8_t | channel_list_count |
The amount of specific channels to scan.
0
: The device will set the channel list to the device default.
|
uint8_t | channel_number[] |
List of specific channels to scan.
1 - 13
: The channel number to scan per byte.
|
uint8_t | rcpi_hysteresis |
Upper RCPI limit that must be attained before triggering roaming again.
0
: The device will set the limit value to the device default.
|
uint8_t | rcpi_threshold |
Received Channel Power Indicator (RCPI) limit for a roaming attempt.
0
: The device will set the limit value to the device default.
|
◆ sl_wfx_set_roam_parameters_req_t
struct sl_wfx_set_roam_parameters_req_t |
Request message for setting the roaming parameters.
The host can use this request to configure the roaming parameters used by the device.
See
Roaming
for further details.
Interface mode | Request allowed |
---|---|
idle | Yes |
station | Yes |
AP | No |
Definition at line
2210
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_roam_parameters_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_roam_parameters_cnf_body_t
struct sl_wfx_set_roam_parameters_cnf_body_t |
Confirmation message body for sl_wfx_set_roam_parameters_cnf_t .
Definition at line
2220
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_set_roam_parameters_cnf_t
struct sl_wfx_set_roam_parameters_cnf_t |
Confirmation message for sl_wfx_set_roam_parameters_req_t .
Definition at line
2235
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_roam_parameters_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_tx_rate_parameters_req_body_t
struct sl_wfx_set_tx_rate_parameters_req_body_t |
Request message body for sl_wfx_set_tx_rate_parameters_req_t .
Field | Default value | Reset to default value |
---|---|---|
rate_set_bitmask | all 802.11bg rates, MCS 0 - 7 | when device reset |
Definition at line
2250
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_rate_set_bitmask_t | rate_set_bitmask | TX rate set parameters. |
uint16_t | reserved | Reserved, set to zero. |
uint16_t | use_minstrel | Set to 1 to use Minstrel rate algorithm. |
◆ sl_wfx_set_tx_rate_parameters_req_t
struct sl_wfx_set_tx_rate_parameters_req_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.
Interface mode | Request allowed |
---|---|
idle | Yes |
station | Yes |
AP | No |
Definition at line
2280
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_tx_rate_parameters_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_tx_rate_parameters_cnf_body_t
struct sl_wfx_set_tx_rate_parameters_cnf_body_t |
Confirmation message body for sl_wfx_set_tx_rate_parameters_cnf_t .
Definition at line
2290
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_set_tx_rate_parameters_cnf_t
struct sl_wfx_set_tx_rate_parameters_cnf_t |
Confirmation message for sl_wfx_set_tx_rate_parameters_req_t .
Definition at line
2305
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_tx_rate_parameters_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_arp_ip_address_req_body_t
struct sl_wfx_set_arp_ip_address_req_body_t |
Request message body for sl_wfx_set_arp_ip_address_req_t .
Definition at line
2315
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | arp_ip_addr[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.
|
◆ sl_wfx_set_arp_ip_address_req_t
struct sl_wfx_set_arp_ip_address_req_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. By default offloading is disabled. Offloading is reset to the default state when the interface is reset.
See
Offloading
for further details.
Interface mode | Request allowed |
---|---|
idle | No |
station | Yes |
AP | No |
Definition at line
2342
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_arp_ip_address_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_arp_ip_address_cnf_body_t
struct sl_wfx_set_arp_ip_address_cnf_body_t |
Confirmation message body for sl_wfx_set_arp_ip_address_cnf_t .
Definition at line
2352
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_set_arp_ip_address_cnf_t
struct sl_wfx_set_arp_ip_address_cnf_t |
Confirmation message for sl_wfx_set_arp_ip_address_req_t .
Definition at line
2366
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_arp_ip_address_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_ns_ip_address_req_body_t
struct sl_wfx_set_ns_ip_address_req_body_t |
Request message body for sl_wfx_set_ns_ip_address_req_t .
Definition at line
2376
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_ns_ip_addr_t | ns_ip_addr[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.
|
◆ sl_wfx_set_ns_ip_address_req_t
struct sl_wfx_set_ns_ip_address_req_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. By default offloading is disabled. Offloading is reset to the default state when the interface is reset.
See
Offloading
for further details.
Interface mode | Request allowed |
---|---|
idle | No |
station | Yes |
AP | No |
Definition at line
2402
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_ns_ip_address_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_ns_ip_address_cnf_body_t
struct sl_wfx_set_ns_ip_address_cnf_body_t |
Confirmation message body for sl_wfx_set_ns_ip_address_cnf_t .
Definition at line
2412
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_set_ns_ip_address_cnf_t
struct sl_wfx_set_ns_ip_address_cnf_t |
Confirmation message for sl_wfx_set_ns_ip_address_req_t .
Definition at line
2426
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_ns_ip_address_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_broadcast_filter_req_body_t
struct sl_wfx_set_broadcast_filter_req_body_t |
Request message body for sl_wfx_set_broadcast_filter_req_t .
Field | Default value | Reset to default value |
---|---|---|
Filter | 0 | when interface stopped |
Definition at line
2441
of file
sl_wfx_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.
|
◆ sl_wfx_set_broadcast_filter_req_t
struct sl_wfx_set_broadcast_filter_req_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.
See
Filtering
for further details.
Interface mode | Request allowed |
---|---|
idle | No |
station | Yes |
AP | No |
Definition at line
2466
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_broadcast_filter_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_broadcast_filter_cnf_body_t
struct sl_wfx_set_broadcast_filter_cnf_body_t |
Confirmation message body for sl_wfx_set_broadcast_filter_cnf_t .
Definition at line
2476
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_set_broadcast_filter_cnf_t
struct sl_wfx_set_broadcast_filter_cnf_t |
Confirmation message for sl_wfx_set_broadcast_filter_req_t .
Definition at line
2490
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_broadcast_filter_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_scan_parameters_req_body_t
struct sl_wfx_set_scan_parameters_req_body_t |
Request message body for sl_wfx_set_scan_parameters_req_t .
Field | Default value | Reset to default value |
---|---|---|
active_channel_time | 50 | when device reset |
passive_channel_time | 110 | when device reset |
num_of_probe_requests | 1 | when device reset |
Definition at line
2507
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_set_scan_parameters_req_t
struct sl_wfx_set_scan_parameters_req_t |
Request message for setting scan parameters.
The host can use this request to configure the scan parameters used by the device.
Interface mode | Request allowed |
---|---|
idle | Yes |
station | Yes |
AP | No |
Definition at line
2539
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_set_scan_parameters_cnf_body_t
struct sl_wfx_set_scan_parameters_cnf_body_t |
Confirmation message body for sl_wfx_set_scan_parameters_cnf_t .
Definition at line
2547
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_set_scan_parameters_cnf_t
struct sl_wfx_set_scan_parameters_cnf_t |
Confirmation message for sl_wfx_set_scan_parameters_req_t .
Definition at line
2561
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_set_unicast_filter_req_body_t
struct sl_wfx_set_unicast_filter_req_body_t |
Request message body for sl_wfx_set_unicast_filter_req_t .
Field | Default value | Reset to default value |
---|---|---|
Filter | 1 | when interface stopped |
Definition at line
2574
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | filter |
Boolean option for unicast filtering.
0
: The device will forward all received unicast frames to the host.
|
◆ sl_wfx_set_unicast_filter_req_t
struct sl_wfx_set_unicast_filter_req_t |
Request message for setting unicast filter state.
The host can use this request to configure the state of the unicast filter. When enabled, the device will only forward certain unicast frames to the host and automatically discard the rest.
See
Filtering
for further details.
Interface mode | Request allowed |
---|---|
idle | No |
station | No |
AP | Yes |
Definition at line
2599
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_unicast_filter_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_unicast_filter_cnf_body_t
struct sl_wfx_set_unicast_filter_cnf_body_t |
Confirmation message body for sl_wfx_set_unicast_filter_cnf_t .
Definition at line
2609
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | status |
Status of the set request.
WFM_STATUS_SUCCESS
: the set request was completed successfully.
|
◆ sl_wfx_set_unicast_filter_cnf_t
struct sl_wfx_set_unicast_filter_cnf_t |
Confirmation message for sl_wfx_set_unicast_filter_req_t .
Definition at line
2623
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_unicast_filter_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_add_whitelist_addr_req_body_t
struct sl_wfx_add_whitelist_addr_req_body_t |
Request message body for sl_wfx_add_whitelist_addr_req_t .
Definition at line
2633
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | mac[6] |
MAC address to add.
broadcast address
: The device will allow all MAC addresses.
|
◆ sl_wfx_add_whitelist_addr_req_t
struct sl_wfx_add_whitelist_addr_req_t |
Request message for adding a MAC address to the device whitelist.
The host can use this request to add a MAC address to the list of allowed MAC addresses. When the first address is added the whitelist, the device will prevent communication with any devices whose MAC address does not match any of the addresses on the list. Setting a whitelist will clear all entries from the device blacklist. The default state is to allow all MAC addresses. The whitelist is reset to the default state when the interface is reset. Up to 8 MAC addresses may be added.
See
Filtering
for further details.
Interface mode | Request allowed |
---|---|
idle | No |
station | No |
AP | Yes |
Definition at line
2659
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_add_whitelist_addr_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_add_whitelist_addr_cnf_body_t
struct sl_wfx_add_whitelist_addr_cnf_body_t |
Confirmation message body for sl_wfx_add_whitelist_addr_cnf_t .
Definition at line
2669
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | status |
Status of the add request.
WFM_STATUS_SUCCESS
: the add request was completed successfully.
|
◆ sl_wfx_add_whitelist_addr_cnf_t
struct sl_wfx_add_whitelist_addr_cnf_t |
Confirmation message for sl_wfx_add_whitelist_addr_req_t .
Definition at line
2683
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_add_whitelist_addr_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_add_blacklist_addr_req_body_t
struct sl_wfx_add_blacklist_addr_req_body_t |
Request message body for sl_wfx_add_blacklist_addr_req_t .
Definition at line
2693
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | mac[6] |
MAC address to add.
broadcast address
: The device will deny all MAC addresses.
|
◆ sl_wfx_add_blacklist_addr_req_t
struct sl_wfx_add_blacklist_addr_req_t |
Request message for adding a MAC address to the device blacklist.
The host can use this request to add a MAC address to the list of denied MAC addresses. When the first address is added the blacklist, the device will prevent communication with any device whose MAC address matches any of the addresses on the list. Setting a blacklist will clear all entries from the device whitelist. The default state is to allow all MAC addresses. The blacklist is reset to the default state when the interface is reset. Up to 8 MAC addresses may be added.
See
Filtering
for further details.
Interface mode | Request allowed |
---|---|
idle | No |
station | No |
AP | Yes |
Definition at line
2719
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_add_blacklist_addr_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_add_blacklist_addr_cnf_body_t
struct sl_wfx_add_blacklist_addr_cnf_body_t |
Confirmation message body for sl_wfx_add_blacklist_addr_cnf_t .
Definition at line
2729
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | status |
Status of the add request.
WFM_STATUS_SUCCESS
: the add request was completed successfully.
|
◆ sl_wfx_add_blacklist_addr_cnf_t
struct sl_wfx_add_blacklist_addr_cnf_t |
Confirmation message for sl_wfx_add_blacklist_addr_req_t .
Definition at line
2743
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_add_blacklist_addr_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_max_tx_power_req_body_t
struct sl_wfx_set_max_tx_power_req_body_t |
Request message body for sl_wfx_set_max_tx_power_req_t .
Field | Default value | Reset to default value |
---|---|---|
max_tx_power | device dependent | when device reset |
Definition at line
2758
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
int32_t | max_tx_power |
Maximum transmit power to set.
Expressed in units of 0.1d_bm. |
◆ sl_wfx_set_max_tx_power_req_t
struct sl_wfx_set_max_tx_power_req_t |
Request message for setting the maximum transmit power of the device.
The host can use this request to set a maximum transmit power. The device can still use a lower transmit power depending on regulatory rules or internal limitations.
Interface mode | Request allowed |
---|---|
idle | Yes |
station | Yes |
AP | Yes |
Definition at line
2781
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_max_tx_power_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_set_max_tx_power_cnf_body_t
struct sl_wfx_set_max_tx_power_cnf_body_t |
Confirmation message body for sl_wfx_set_max_tx_power_cnf_t .
Definition at line
2791
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | status |
Status of the add request.
WFM_STATUS_SUCCESS
: the add request was completed successfully.
|
◆ sl_wfx_set_max_tx_power_cnf_t
struct sl_wfx_set_max_tx_power_cnf_t |
Confirmation message for sl_wfx_set_max_tx_power_req_t .
Definition at line
2807
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_set_max_tx_power_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_get_max_tx_power_cnf_body_t
struct sl_wfx_get_max_tx_power_cnf_body_t |
Confirmation message body for sl_wfx_get_max_tx_power_cnf_t .
Definition at line
2832
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
int32_t | max_tx_power_rf_port1 |
Maximum transmit power for RF port 1.
Expressed in units of 0.1d_bm. |
int32_t | max_tx_power_rf_port2 |
Maximum transmit power for RF port 2.
Expressed in units of 0.1d_bm. |
uint32_t | status |
Status of the add request.
WFM_STATUS_SUCCESS
: the add request was completed successfully.
|
◆ sl_wfx_get_max_tx_power_cnf_t
struct sl_wfx_get_max_tx_power_cnf_t |
Confirmation message for sl_wfx_get_max_tx_power_req_t .
Definition at line
2858
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_get_max_tx_power_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_get_pmk_cnf_body_t
struct sl_wfx_get_pmk_cnf_body_t |
Confirmation message body for sl_wfx_get_pmk_cnf_t .
Definition at line
2885
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | password[64] |
PMK of the network.
WPA PMK
: 64 bytes in HEX format.
|
uint32_t | password_length |
Length of the Pairwise Master Key.
0 - 64 : The amount of bytes. |
uint32_t | status |
Status of the add request.
WFM_STATUS_SUCCESS
: the get request was completed successfully.
|
◆ sl_wfx_get_pmk_cnf_t
struct sl_wfx_get_pmk_cnf_t |
Confirmation message for sl_wfx_get_pmk_req_t .
Definition at line
2911
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_get_pmk_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_get_ap_client_signal_strength_req_body_t
struct sl_wfx_get_ap_client_signal_strength_req_body_t |
Request message body for sl_wfx_get_ap_client_signal_strength_req_t .
Definition at line
2921
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | mac[6] | MAC address of the station. |
◆ sl_wfx_get_ap_client_signal_strength_req_t
struct sl_wfx_get_ap_client_signal_strength_req_t |
Request message for retrieving the signal strength of a client of the started Wi-Fi network.
The host can use this request to retrieve the signal strength of a client of the started Wi-Fi network.
Interface mode | Request allowed |
---|---|
idle | No |
station | No |
AP | Yes |
Definition at line
2939
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_get_ap_client_signal_strength_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_get_ap_client_signal_strength_cnf_body_t
struct sl_wfx_get_ap_client_signal_strength_cnf_body_t |
Confirmation message body for sl_wfx_get_ap_client_signal_strength_cnf_t .
Definition at line
2949
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint32_t | rcpi |
Received Channel Power Indicator (RCPI) of the client.
See Received Channel Power Indicator for further details. |
uint32_t | status |
Status of the get request.
WFM_STATUS_SUCCESS
: the get request was completed.
|
◆ sl_wfx_get_ap_client_signal_strength_cnf_t
struct sl_wfx_get_ap_client_signal_strength_cnf_t |
Confirmation message for sl_wfx_get_ap_client_signal_strength_req_t .
Definition at line
2968
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_get_ap_client_signal_strength_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_ext_auth_req_body_t
struct sl_wfx_ext_auth_req_body_t |
Request message body for sl_wfx_ext_auth_req_t .
Definition at line
2978
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | auth_data[] | The authentication message. |
uint16_t | auth_data_length | Length of the authentication message. |
uint16_t | auth_data_type |
Type of the authentication message.
See sl_wfx_ext_auth_data_type_t for enumeration values. |
◆ sl_wfx_ext_auth_req_t
struct sl_wfx_ext_auth_req_t |
Request message for sl_wfx_ext_auth_req_t .
Definition at line
2998
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_ext_auth_req_body_t | body | Request message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_ext_auth_cnf_body_t
struct sl_wfx_ext_auth_cnf_body_t |
Confirmation message body for sl_wfx_ext_auth_cnf_t .
Definition at line
3008
of file
sl_wfx_cmd_api.h
.
◆ sl_wfx_ext_auth_cnf_t
struct sl_wfx_ext_auth_cnf_t |
Confirmation message for sl_wfx_ext_auth_req_t .
Definition at line
3022
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_ext_auth_cnf_body_t | body | Confirmation message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_ext_auth_ind_body_t
struct sl_wfx_ext_auth_ind_body_t |
Indication message body for sl_wfx_ext_auth_ind_t .
Definition at line
3032
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
uint8_t | auth_data[] | The authentication message. |
uint16_t | auth_data_length | Length of the authentication message. |
uint16_t | auth_data_type |
Type of the authentication message.
See sl_wfx_ext_auth_data_type_t for enumeration values. |
◆ sl_wfx_ext_auth_ind_t
struct sl_wfx_ext_auth_ind_t |
Indication message for sl_wfx_ext_auth_ind_t .
Definition at line
3052
of file
sl_wfx_cmd_api.h
.
Data Fields | ||
---|---|---|
sl_wfx_ext_auth_ind_body_t | body | Indication message body. |
sl_wfx_header_t | header | Common message header. |
◆ sl_wfx_disconnect_req_t
struct sl_wfx_disconnect_req_t |
Request message for disconnecting from a Wi-Fi network.
The host can use this request to initiate a disconnection from a Wi-Fi network.
Interface mode | Request allowed |
---|---|
idle | No |
station | Yes |
AP | No |
◆ sl_wfx_get_signal_strength_req_t
struct sl_wfx_get_signal_strength_req_t |
Request message for retrieving the signal strength of connection.
The host can use this request to retrieve the signal strength of the connection.
Interface mode | Request allowed |
---|---|
idle | No |
station | Yes |
AP | No |
◆ sl_wfx_stop_ap_req_t
struct sl_wfx_stop_ap_req_t |
Request message for stopping the started Wi-Fi network.
The host can use this request to stop the started Wi-Fi network.
Interface mode | Request allowed |
---|---|
idle | No |
station | No |
AP | Yes |
◆ sl_wfx_stop_ap_ind_t
struct sl_wfx_stop_ap_ind_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 sl_wfx_stop_ap_req_t has been completed. The indication is also sent when the started network has encountered a fatal error.
◆ sl_wfx_stop_scan_req_t
struct sl_wfx_stop_scan_req_t |
Request message for stopping an ongoing scan.
The host can use this request to stop an ongoing scan operation.
Interface mode | Request allowed |
---|---|
idle | Yes |
station | Yes |
AP | No |
◆ sl_wfx_get_max_tx_power_req_t
struct sl_wfx_get_max_tx_power_req_t |
Request message for getting the maximum transmit power.
The host can use this request to get the current value of maximum transmit power.
Interface mode | Request allowed |
---|---|
idle | Yes |
station | Yes |
AP | Yes |
◆ sl_wfx_get_pmk_req_t
struct sl_wfx_get_pmk_req_t |
Request message for getting the Pairwise Master Key (PMK).
The host can use this request to retrieve the Pairwise Master Key (PMK) used to connect to the current secure network. PMK can be given in the next sl_wfx_connect_req_t message to speed up connection process. See Passwords and pass phrases for further details.
Interface mode | Request allowed |
---|---|
idle | No |
station | Yes |
AP | Yes |