Types#

This section provides a reference to Wi-Fi API data types.

Modules#

sl_wifi_buffer_configuration_t

sl_wifi_buffer_t

sl_wifi_channel_t

sl_wifi_ssid_t

sl_wifi_roam_configuration_t

sl_wifi_firmware_version_t

sl_wifi_scan_result_t

sl_wifi_extended_scan_result_t

sl_wifi_extended_scan_result_parameters_t

sl_wifi_scan_configuration_t

sl_wifi_advanced_scan_configuration_t

sl_wifi_ap_configuration_t

sl_wifi_advanced_ap_configuration_t

sl_wifi_channel_bitmap_t

sl_wifi_client_configuration_t

sl_wifi_advanced_client_configuration_t

sl_wifi_psk_credential_t

sl_wifi_pmk_credential_t

sl_wifi_wep_credential_t

sl_wifi_eap_credential_t

sl_wifi_credential_t

sl_wifi_twt_request_t

sl_wifi_twt_selection_t

sl_wifi_reschedule_twt_config_t

sl_wifi_status_t

sl_wifi_statistics_t

sl_wifi_operational_statistics_t

sl_wifi_p2p_configuration_t

sl_wifi_event_data_t

sl_wifi_wps_pin_t

sl_wifi_listen_interval_t

sl_wifi_listen_interval_v2_t

sl_wifi_client_info_t

sl_wifi_client_info_response_t

sl_wifi_max_tx_power_t

sl_wifi_async_stats_response_t

sl_wifi_rx_stats_request_t

sl_wifi_transmitter_test_info_t

sl_wifi_freq_offset_t

sl_wifi_dpd_calib_data_t

sl_wifi_multicast_filter_info_t

sl_wifi_tsf64_t

sl_wifi_transceiver_tx_data_control_t

sl_wifi_transceiver_cw_config_t

sl_wifi_transceiver_parameters_t

sl_wifi_transceiver_set_channel_t

sl_wifi_transceiver_peer_update_t

sl_wifi_transceiver_mcast_filter_t

sl_wifi_transceiver_configuration_t

sl_wifi_transceiver_tx_data_confirmation_t

sl_wifi_transceiver_rx_data_t

sl_wifi_module_state_stats_response_t

sl_wifi_system_fw_version_info_t

sl_wifi_fw_version_ext_info_t

sl_wifi_firmware_header_t

sl_wifi_ap_reconfiguration_t

sl_wifi_timeout_t

sl_wifi_request_tx_test_info_t

sl_wifi_advanced_stats_response_t

sl_wifi_twt_response_t

Enumerations#

enum
SL_WIFI_TX_FRAME_BUFFER
SL_WIFI_RX_FRAME_BUFFER
SL_WIFI_CONTROL_BUFFER
SL_WIFI_SCAN_RESULT_BUFFER
}

Enumeration for types of Wi-Fi buffers.

enum
SL_WIFI_SYSTEM_WLAN_ONLY_MODE = 0
SL_WIFI_SYSTEM_WLAN_MODE = 1
SL_WIFI_SYSTEM_BLUETOOTH_MODE = 4
SL_WIFI_SYSTEM_WLAN_BLUETOOTH_MODE = 5
SL_WIFI_SYSTEM_DUAL_MODE = 8
SL_WIFI_SYSTEM_WLAN_DUAL_MODE = 9
SL_WIFI_SYSTEM_BLE_MODE = 12
SL_WIFI_SYSTEM_WLAN_BLE_MODE = 13
__SL_WIFI_FORCE_COEX_ENUM_16BIT = 0xFFFF
}

Wireless co-existence mode.

enum
SL_WIFI_CLIENT_MODE = 0
SL_WIFI_ENTERPRISE_CLIENT_MODE = 2
SL_WIFI_ACCESS_POINT_MODE = 6
SL_WIFI_TRANSCEIVER_MODE = 7
SL_WIFI_TRANSMIT_TEST_MODE = 8
SL_WIFI_CONCURRENT_MODE = 9
__SL_WIFI_FORCE_OPERATION_ENUM_16BIT = 0xFFFF
}

Enumeration of Wi-Fi operation modes for the Si91x wireless device.

enum
SL_WIFI_SYSTEM_HIGH_PERFORMANCE
SL_WIFI_SYSTEM_ASSOCIATED_POWER_SAVE
SL_WIFI_SYSTEM_ASSOCIATED_POWER_SAVE_LOW_LATENCY
SL_WIFI_SYSTEM_DEEP_SLEEP_WITHOUT_RAM_RETENTION
SL_WIFI_SYSTEM_DEEP_SLEEP_WITH_RAM_RETENTION
}

Performance profile.

Typedefs#

typedef sl_status_t(*
sl_wifi_event_handler_t)(sl_wifi_event_t event, sl_wifi_buffer_t *buffer)

Generic callback for handling Wi-Fi events.

typedef uint32_t

Wi-Fi credential handle.

Wi-Fi Access Point dynamic configuration structure.

Enumeration Documentation#

sl_wifi_buffer_type_t#

sl_wifi_buffer_type_t

Enumeration for types of Wi-Fi buffers.

Enumerator
SL_WIFI_TX_FRAME_BUFFER

Buffer for sending socket data to NWP.

SL_WIFI_RX_FRAME_BUFFER

Buffer for storing response from NWP.

SL_WIFI_CONTROL_BUFFER

Buffer for sending command to NWP.

SL_WIFI_SCAN_RESULT_BUFFER

Buffer for storing scan results.


sl_wifi_system_coex_mode_t#

sl_wifi_system_coex_mode_t

Wireless co-existence mode.

Note

  • Only BLE, WLAN, and WLAN + BLE modes are supported.

Enumerator
SL_WIFI_SYSTEM_WLAN_ONLY_MODE

Wireless local area network (WLAN) only mode.

SL_WIFI_SYSTEM_WLAN_MODE

WLAN mode (not currently supported)

SL_WIFI_SYSTEM_BLUETOOTH_MODE

Bluetooth only mode (not currently supported)

SL_WIFI_SYSTEM_WLAN_BLUETOOTH_MODE

WLAN and Bluetooth mode (not currently supported)

SL_WIFI_SYSTEM_DUAL_MODE

Dual mode (not currently supported)

SL_WIFI_SYSTEM_WLAN_DUAL_MODE

WLAN dual mode (not currently supported)

SL_WIFI_SYSTEM_BLE_MODE

Bluetooth Low Energy (BLE) only mode, used when power save mode is not needed.

SL_WIFI_SYSTEM_WLAN_BLE_MODE

WLAN and BLE mode.

__SL_WIFI_FORCE_COEX_ENUM_16BIT

Force the enumeration to be 16-bit.


sl_wifi_operation_mode_t#

sl_wifi_operation_mode_t

Enumeration of Wi-Fi operation modes for the Si91x wireless device.

This enumeration defines the various operation modes supported by the wireless device. Each mode configures the device for a specific use case, such as client mode, access point mode, or transceiver mode.

Enumerator
SL_WIFI_CLIENT_MODE

Wi-Fi personal client mode.

SL_WIFI_ENTERPRISE_CLIENT_MODE

Wi-Fi enterprise client mode.

SL_WIFI_ACCESS_POINT_MODE

Wi-Fi access point mode.

SL_WIFI_TRANSCEIVER_MODE

Wi-Fi transceiver mode.

SL_WIFI_TRANSMIT_TEST_MODE

Wi-Fi transmit test mode.

SL_WIFI_CONCURRENT_MODE

Wi-Fi concurrent mode.

__SL_WIFI_FORCE_OPERATION_ENUM_16BIT

Force the enumeration to be 16-bit.


sl_wifi_system_performance_profile_t#

sl_wifi_system_performance_profile_t

Performance profile.

Enumerator
SL_WIFI_SYSTEM_HIGH_PERFORMANCE

Power save is disabled and throughput is maximum.

SL_WIFI_SYSTEM_ASSOCIATED_POWER_SAVE

Low power profile when the device is associated with an AP (MAX PSP).

SL_WIFI_SYSTEM_ASSOCIATED_POWER_SAVE_LOW_LATENCY

Low power profile when the device is associated with an AP (FAST PSP).

SL_WIFI_SYSTEM_DEEP_SLEEP_WITHOUT_RAM_RETENTION

Deep Sleep without RAM Retention when the device is not associated with AP.

SL_WIFI_SYSTEM_DEEP_SLEEP_WITH_RAM_RETENTION

Deep Sleep with RAM Retention when the device is not associated with AP.


Typedef Documentation#

sl_wifi_event_handler_t#

sl_wifi_event_handler_t )(sl_wifi_event_t event, sl_wifi_buffer_t *buffer)

Generic callback for handling Wi-Fi events.

Parameters
TypeDirectionArgument NameDescription
N/Aevent

Wi-Fi event of type sl_wifi_event_t.

N/Abuffer

Pointer to a Wi-Fi buffer contains information related to the event, of type sl_wifi_buffer_t

Returns

Note

  • In case of event failure, SL_WIFI_FAIL_EVENT_STATUS_INDICATION bit is set in the event. The data would be of type sl_status_t, and data_length can be ignored.


sl_wifi_credential_id_t#

typedef uint32_t sl_wifi_credential_id_t

Wi-Fi credential handle.


sl_si91x_ap_reconfiguration_t#

typedef sl_wifi_ap_reconfiguration_t sl_si91x_ap_reconfiguration_t

Wi-Fi Access Point dynamic configuration structure.