RTOS-integrated SF WIFI Framework Interface. More...

Data Structures
struct	sf_wifi_ip_addr_t

struct	sf_wifi_info_t

struct	sf_wifi_callback_args_t

struct	sf_wifi_provisioning_t

struct	sf_wifi_cfg_t

struct	sf_wifi_stats_t

struct	sf_wifi_scan_t

struct	sf_wifi_wps_t

struct	sf_wifi_ctrl_t

struct	sf_wifi_api_t

struct	sf_wifi_instance_t

Macros
#define	SF_WIFI_API_VERSION_MAJOR (2U)

#define	SF_WIFI_API_VERSION_MINOR (0U)

#define	SF_WIFI_SSID_LENGTH (32U)
	WiFi SSID length.

#define	SF_WIFI_SECURITY_KEY_LENGTH (128U)
	WiFi Security Key length.

#define	SF_WIFI_MAC_ADDR_LENGTH (6U)
	WiFi MAC address length.

#define	SF_WIFI_WPS_PIN_LENGTH (8U)
	WiFi WPS Pin length.

#define	SF_WIFI_TRUE (1U)
	Boolean True condition.

#define	SF_WIFI_FALSE (0U)
	Boolean False condition.

#define	SF_WIFI_NULL_BYTE ((uint8_t)'\0')
	NULL Byte.

#define	SF_WIFI_SIZE_FOR_NULL_BYTE (1U)
	Size in byte for NULL.

#define	SF_WIFI_IPV4_ADDRESS(a, b, c, d)

Enumerations
enum	sf_wifi_ip_addr_version_t { SF_WIFI_IP_ADDR_VERSION_4, SF_WIFI_IP_ADDR_VERSION_6 }

enum	sf_wifi_interface_mode_t { SF_WIFI_INTERFACE_MODE_AP, SF_WIFI_INTERFACE_MODE_CLIENT }

enum	sf_wifi_wep_key_format_t { SF_WIFI_WEP_KEY_FORMAT_ASCII, SF_WIFI_WEP_KEY_FORMAT_HEX }

enum	sf_wifi_security_type_t { SF_WIFI_SECURITY_TYPE_OPEN, SF_WIFI_SECURITY_TYPE_WEP, SF_WIFI_SECURITY_TYPE_WPA, SF_WIFI_SECURITY_TYPE_WPA2 }

enum	sf_wifi_encryption_type_t { SF_WIFI_ENCRYPTION_TYPE_AUTO, SF_WIFI_ENCRYPTION_TYPE_TKIP, SF_WIFI_ENCRYPTION_TYPE_CCMP, SF_WIFI_ENCRYPTION_TYPE_WEP, SF_WIFI_ENCRYPTION_TYPE_NONE }

enum	sf_wifi_bss_type_t { SF_WIFI_BSS_TYPE_INFRASTRUCTURE = 0, SF_WIFI_BSS_TYPE_ADHOC = 1, SF_WIFI_BSS_TYPE_ANY = 2, SF_WIFI_BSS_TYPE_UNKNOWN = -1 }

enum	sf_wifi_interface_hw_mode_t { SF_WIFI_INTERFACE_HW_MODE_11A, SF_WIFI_INTERFACE_HW_MODE_11B, SF_WIFI_INTERFACE_HW_MODE_11G, SF_WIFI_INTERFACE_HW_MODE_11N }

enum	sf_wifi_rts_t { SF_WIFI_RTS_DISABLE, SF_WIFI_RTS_ENABLE }

enum	sf_wifi_preamble_t { SF_WIFI_PREAMBLE_SHORT, SF_WIFI_PREAMBLE_LONG }

enum	sf_wifi_wmm_t { SF_WIFI_WMM_DISABLE, SF_WIFI_WMM_ENABLE }

enum	sf_wifi_high_throughput_t { SF_WIFI_HIGH_THROUGHPUT_DISABLE, SF_WIFI_HIGH_THROUGHPUT_ENABLE }

enum	sf_wifi_ssid_broadcast_t { SF_WIFI_SSID_BROADCAST_DISABLE, SF_WIFI_SSID_BROADCAST_ENABLE }

enum	sf_wifi_wds_t { SF_WIFI_WDS_DISABLE, SF_WIFI_WDS_ENABLE }

enum	sf_wifi_mandatory_high_throughput_t { SF_WIFI_MANDATORY_HIGH_THROUGHPUT_DISABLE, SF_WIFI_MANDATORY_HIGH_THROUGHPUT_ENABLE }

enum	sf_wifi_auto_negotiation_t { SF_WIFI_AUTO_NEGOTIATION_DISABLE, SF_WIFI_AUTO_NEGOTIATION_ENABLE }

enum	sf_wifi_access_control_t { SF_WIFI_ACCESS_CONTROL_DISABLE, SF_WIFI_ACCESS_CONTROL_DENY, SF_WIFI_ACCESS_CONTROL_ALLOW }

enum	sf_wifi_wps_mode_t { SF_WIFI_WPS_MODE_PUSHBUTTON, SF_WIFI_WPS_MODE_PIN }

enum	sf_wifi_event_t { SF_WIFI_EVENT_RX = (1 << 0), SF_WIFI_EVENT_AP_CONNECT = (1 << 1), SF_WIFI_EVENT_AP_DISCONNECT = (1 << 2), SF_WIFI_EVENT_CLIENT_CONNECT = (1 << 3), SF_WIFI_EVENT_CLIENT_DISCONNECT = (1 << 4) }

Detailed Description

RTOS-integrated SF WIFI Framework Interface.

Summary

This SSP Interface provides access to the ThreadX-aware SF WIFI Framework.

Macro Definition Documentation

◆ SF_WIFI_API_VERSION_MAJOR

#define SF_WIFI_API_VERSION_MAJOR (2U)

Major Version of the API defined in this file

◆ SF_WIFI_API_VERSION_MINOR

#define SF_WIFI_API_VERSION_MINOR (0U)

Minor Version of the API defined in this file

◆ SF_WIFI_IPV4_ADDRESS

#define SF_WIFI_IPV4_ADDRESS	(	a,
		b,
		c,
		d
	)

Value:

((((uint32_t) a) << (24U)) | (((uint32_t) b) << (16U)) | \

(((uint32_t) c) << (8U)) | ((uint32_t) d))

IP Address Generation Macro

Enumeration Type Documentation

◆ sf_wifi_access_control_t

enum sf_wifi_access_control_t

WiFi Framework AccessContol mode

Enumerator
SF_WIFI_ACCESS_CONTROL_DISABLE	Disable MAC address matching.
SF_WIFI_ACCESS_CONTROL_DENY	Deny association to stations on the MAC list.
SF_WIFI_ACCESS_CONTROL_ALLOW	Allow association to stations on the MAC list.

◆ sf_wifi_auto_negotiation_t

enum sf_wifi_auto_negotiation_t

WiFi Auto Negotiation flag

Enumerator
SF_WIFI_AUTO_NEGOTIATION_DISABLE	Auto negotiation disable.
SF_WIFI_AUTO_NEGOTIATION_ENABLE	Auto negotiation enable.

◆ sf_wifi_bss_type_t

enum sf_wifi_bss_type_t

WiFi BSS type

Enumerator
SF_WIFI_BSS_TYPE_INFRASTRUCTURE	Infrastructure network.
SF_WIFI_BSS_TYPE_ADHOC	802.11 ad-hoc IBSS network
SF_WIFI_BSS_TYPE_ANY	Either infrastructure or ad-hoc network.
SF_WIFI_BSS_TYPE_UNKNOWN	BSS type is unknown.

◆ sf_wifi_encryption_type_t

enum sf_wifi_encryption_type_t

WiFi Encryption type

Enumerator
SF_WIFI_ENCRYPTION_TYPE_AUTO	Automatic selection of encryption protocol.
SF_WIFI_ENCRYPTION_TYPE_TKIP	Temporal Key Integrity Protocol. Used by WPA.
SF_WIFI_ENCRYPTION_TYPE_CCMP	CTR mode with CBC-MAC Protocol. Used by WPA2.
SF_WIFI_ENCRYPTION_TYPE_WEP	WEP mode. Used by WEP.
SF_WIFI_ENCRYPTION_TYPE_NONE	No Encryption. Used by Open Security type.

◆ sf_wifi_event_t

enum sf_wifi_event_t

WiFi Framework event codes

Enumerator
SF_WIFI_EVENT_RX	Packet received event.
SF_WIFI_EVENT_AP_CONNECT	Device Associated Successfully with AP.
SF_WIFI_EVENT_AP_DISCONNECT	Device Disconnected with AP.
SF_WIFI_EVENT_CLIENT_CONNECT	Client Associated Successfully with device AP.
SF_WIFI_EVENT_CLIENT_DISCONNECT	Client Disconnected from device AP.

◆ sf_wifi_high_throughput_t

enum sf_wifi_high_throughput_t

WiFi High Throughput flag

Enumerator
SF_WIFI_HIGH_THROUGHPUT_DISABLE	Disable high throughput mode.
SF_WIFI_HIGH_THROUGHPUT_ENABLE	Enable high throughput mode. Also requires WMM to be enabled.

◆ sf_wifi_interface_hw_mode_t

enum sf_wifi_interface_hw_mode_t

WiFi Hardware mode

Enumerator
SF_WIFI_INTERFACE_HW_MODE_11A	802.11a
SF_WIFI_INTERFACE_HW_MODE_11B	802.11b
SF_WIFI_INTERFACE_HW_MODE_11G	802.11g
SF_WIFI_INTERFACE_HW_MODE_11N	802.11n

◆ sf_wifi_interface_mode_t

enum sf_wifi_interface_mode_t

WiFi Interface mode

Enumerator
SF_WIFI_INTERFACE_MODE_AP	Access Point mode.
SF_WIFI_INTERFACE_MODE_CLIENT	Station Mode.

◆ sf_wifi_ip_addr_version_t

enum sf_wifi_ip_addr_version_t

IP address version

Enumerator
SF_WIFI_IP_ADDR_VERSION_4	IPv4 address.
SF_WIFI_IP_ADDR_VERSION_6	IPv6 address.

◆ sf_wifi_mandatory_high_throughput_t

enum sf_wifi_mandatory_high_throughput_t

WiFi Mandatory High Throughput flag

Enumerator
SF_WIFI_MANDATORY_HIGH_THROUGHPUT_DISABLE	Disable Mandatory HT requirement.
SF_WIFI_MANDATORY_HIGH_THROUGHPUT_ENABLE	Enable mandatory HT requirement.

◆ sf_wifi_preamble_t

enum sf_wifi_preamble_t

WiFi Preamble type

Enumerator
SF_WIFI_PREAMBLE_SHORT	Use short preamble.
SF_WIFI_PREAMBLE_LONG	Use long preamble.

◆ sf_wifi_rts_t

enum sf_wifi_rts_t

WiFi RTS flag

Enumerator
SF_WIFI_RTS_DISABLE	Disable RTS/CTS handshake.
SF_WIFI_RTS_ENABLE	Enable RTS/CTS handshake.

◆ sf_wifi_security_type_t

enum sf_wifi_security_type_t

WiFi Security type

Enumerator
SF_WIFI_SECURITY_TYPE_OPEN	Open. No encryption used.
SF_WIFI_SECURITY_TYPE_WEP	128-bit WEP OPEN ASCII
SF_WIFI_SECURITY_TYPE_WPA	WiFi Protected Access.
SF_WIFI_SECURITY_TYPE_WPA2	WiFi Protected Access v2.

◆ sf_wifi_ssid_broadcast_t

enum sf_wifi_ssid_broadcast_t

WiFi SSID Broadcast flag

Enumerator
SF_WIFI_SSID_BROADCAST_DISABLE	Disable SSID Broadcast.
SF_WIFI_SSID_BROADCAST_ENABLE	Enable SSID Broadcast.

◆ sf_wifi_wds_t

enum sf_wifi_wds_t

WiFi WDS Flasg

Enumerator
SF_WIFI_WDS_DISABLE	Disable WDS.
SF_WIFI_WDS_ENABLE	Enable WDS.

◆ sf_wifi_wep_key_format_t

enum sf_wifi_wep_key_format_t

WiFi WEP Key Format

Enumerator
SF_WIFI_WEP_KEY_FORMAT_ASCII	WEP Key in ASCII.
SF_WIFI_WEP_KEY_FORMAT_HEX	WEP Key in Hex.

◆ sf_wifi_wmm_t

enum sf_wifi_wmm_t

WiFi WMM flag

Enumerator
SF_WIFI_WMM_DISABLE	Disable WMM.
SF_WIFI_WMM_ENABLE	Enable WMM.

◆ sf_wifi_wps_mode_t

enum sf_wifi_wps_mode_t

WiFi WPS mode

Enumerator
SF_WIFI_WPS_MODE_PUSHBUTTON	WPS Push button method.
SF_WIFI_WPS_MODE_PIN	WPS pin method.

Data Structures

Macros

Enumerations