SF WIFI QCA4010 Framework Interface

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

Data Structures
struct	sf_wifi_qca4010_status_t
struct	sf_wifi_qca4010_at_cmd_set_t
struct	sf_wifi_qca4010_cmd_resp_t
struct	sf_wifi_qca4010_cfg_t
struct	sf_wifi_qca4010_provisioning_t
struct	sf_wifi_qca4010_scan_t
struct	sf_wifi_qca4010_uart_extend_cfg_t
struct	sf_wifi_qca4010_queue_cfg_t
struct	sf_wifi_qca4010_extended_cfg_t
struct	sf_wifi_qca4010_ctrl_t
struct	sf_wifi_qca4010_api_t
struct	sf_wifi_qca4010_instance_t

Macros
#define	SF_WIFI_QCA4010_API_VERSION_MAJOR   (2U)
#define	SF_WIFI_QCA4010_API_VERSION_MINOR   (0U)
#define	SF_WIFI_QCA4010_SSID_LENGTH   (32U)
	WiFi SSID length.
#define	SF_WIFI_QCA4010_BSSID_LENGTH   (6U)
	WiFi BSSID length.
#define	SF_WIFI_QCA4010_SECURITY_KEY_LENGTH   (128U)
	WiFi Security Key length.
#define	SF_WIFI_QCA4010_MUTEX_GET_TIMEOUT_TICKS   (200U)
	Default timeout for getting mutex.
#define	MAC_ADDRESS_LEN   (18U)
#define	PHY_MODE_LEN   (6U)
#define	ACCESS_MODE_LEN   (10U)
#define	POWER_MODE_LEN   (10U)

Enumerations
enum	sf_wifi_qca4010_at_cmd_index_t {   SF_WIFI_QCA4010_AT_CMD_INDEX_AT = 0, SF_WIFI_QCA4010_AT_CMD_INDEX_ATZ0, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_BAUD_CHECK, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_BAUD_SET,   SF_WIFI_QCA4010_AT_CMD_INDEX_AT_SAVE, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_ECHO, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_SET_HARDWARE_MODE, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_RESULT_CODE_FROMAT,   SF_WIFI_QCA4010_AT_CMD_INDEX_AT_UART_TRANSMISSION_FLOW_CONTROL_QUERY, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_UART_TRANSMISSION_FLOW_CONTROL, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_ESCAPE_GUARD_TIME, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_BUFFER_SIZE,   SF_WIFI_QCA4010_AT_CMD_INDEX_AT_DISCONNECT_AP, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_BUFFER_TIMEOUT, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_SCAN_SSID, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_INITIATE_AP_MODE,   SF_WIFI_QCA4010_AT_CMD_INDEX_AT_CONNECT_OPEN_AP, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_CONNECT_WPA_AP, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_ASSIGN_AP_CHANNEL, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_INITIATE_OPEN_AP,   SF_WIFI_QCA4010_AT_CMD_INDEX_AT_INITIATE_WPA_AP, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_ASSIGN_WEP_KEY, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_INITIATE_WEP_AP, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_CONNECT_WEP_AP,   SF_WIFI_QCA4010_AT_CMD_INDEX_AT_WIFI_STATUS, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_DISCONNECT_ACCESS_POINT, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_INIT_SECOND_UART, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_CHANGE_UART_ASSIGNMENT,   SF_WIFI_QCA4010_AT_CMD_INDEX_AT_CHANGE_UART_ASSIGNMENT_IN_CLOSE, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_SWITCH_BACK_TO_DATA_MODE, SF_WIFI_QCA4010_AT_CMD_INDEX_AT_EXIT_DATA_MODE }
enum	sf_wifi_qca4010_interface_hw_mode_t { SF_WIFI_QCA4010_INTERFACE_HW_MODE_11B, SF_WIFI_QCA4010_INTERFACE_HW_MODE_11G, SF_WIFI_QCA4010_INTERFACE_HW_MODE_11N }
enum	sf_wifi_qca4010_reset_type_t { SF_WIFI_QCA4010_RESET_TYPE_SOFT, SF_WIFI_QCA4010_RESET_TYPE_HARD }
enum	sf_wifi_qca4010_interface_mode_t { SF_WIFI_QCA4010_INTERFACE_MODE_AP, SF_WIFI_QCA4010_INTERFACE_MODE_CLIENT }
enum	sf_wifi_qca4010_security_type_t { SF_WIFI_QCA4010_SECURITY_TYPE_OPEN = 0, SF_WIFI_QCA4010_SECURITY_TYPE_WEP, SF_WIFI_QCA4010_SECURITY_TYPE_WPA, SF_WIFI_QCA4010_SECURITY_TYPE_WPA2 }
enum	sf_wifi_qca4010_encryption_type_t { SF_WIFI_QCA4010_ENCRYPTION_TYPE_TKIP = 0, SF_WIFI_QCA4010_ENCRYPTION_TYPE_CCMP }

Detailed Description

RTOS-integrated SF WIFI QCA4010 Framework Interface.

Summary

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

Macro Definition Documentation

ACCESS_MODE_LEN

#define ACCESS_MODE_LEN   (10U)

Mode len

MAC_ADDRESS_LEN

#define MAC_ADDRESS_LEN   (18U)

Mac address len

PHY_MODE_LEN

#define PHY_MODE_LEN   (6U)

phy mode len

POWER_MODE_LEN

#define POWER_MODE_LEN   (10U)

power mode len

SF_WIFI_QCA4010_API_VERSION_MAJOR

#define SF_WIFI_QCA4010_API_VERSION_MAJOR   (2U)

Major Version of the API defined in this file

SF_WIFI_QCA4010_API_VERSION_MINOR

#define SF_WIFI_QCA4010_API_VERSION_MINOR   (0U)

Minor Version of the API defined in this file

Enumeration Type Documentation

sf_wifi_qca4010_at_cmd_index_t

enum sf_wifi_qca4010_at_cmd_index_t

Enumeration for AT command index

Enumerator
SF_WIFI_QCA4010_AT_CMD_INDEX_AT	Index for Command AT.
SF_WIFI_QCA4010_AT_CMD_INDEX_ATZ0	Index for Command ATZ0.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_BAUD_CHECK	Index for Command to check whether modem is responding after baud update.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_BAUD_SET	Index for Command to set baud rate of wifi.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_SAVE	Index for Command AT&W.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_ECHO	Index for Command ATE0.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_SET_HARDWARE_MODE	Index for Command ATWPHYMODE.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_RESULT_CODE_FROMAT	Index for Command ATV.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_UART_TRANSMISSION_FLOW_CONTROL_QUERY	Index for Command ATS108?
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_UART_TRANSMISSION_FLOW_CONTROL	Index for Command ATS108=1.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_ESCAPE_GUARD_TIME	Index for Command ATS12=1.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_BUFFER_SIZE	Index for Command Set buffer size for socket receive (ATBSIZE)
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_DISCONNECT_AP	Index for Command disconnect from currently connected Access Point.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_BUFFER_TIMEOUT	Index for Command to the system wait to send UART-received data to network.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_SCAN_SSID	Index for Command to the scan available ssid.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_INITIATE_AP_MODE	Index for Command to initiate AP mode.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_CONNECT_OPEN_AP	Index for Command to the connect open AP.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_CONNECT_WPA_AP	Index for Command to the connect to WPA-configured Access Point.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_ASSIGN_AP_CHANNEL	Index for Command to assign channel to AP.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_INITIATE_OPEN_AP	Index for Command to initiate Open AP.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_INITIATE_WPA_AP	Index for Command to initiate WPA/WPA2 AP.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_ASSIGN_WEP_KEY	Index for Command to assign WEP key.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_INITIATE_WEP_AP	Index for Command to initiate WEP AP.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_CONNECT_WEP_AP	Index for Command to connect to WEP AP.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_WIFI_STATUS	Index for Command to the get wifi status.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_DISCONNECT_ACCESS_POINT	Index for Command to disconnect current access point.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_INIT_SECOND_UART	Index for Command to init second uart.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_CHANGE_UART_ASSIGNMENT	Change UART assignments for command and data.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_CHANGE_UART_ASSIGNMENT_IN_CLOSE	Change UART assignments for command and data in close if num_uart = 2.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_SWITCH_BACK_TO_DATA_MODE	Index for Command to switch to data mode.
SF_WIFI_QCA4010_AT_CMD_INDEX_AT_EXIT_DATA_MODE	Index for Command to switch to command mode.

sf_wifi_qca4010_encryption_type_t

enum sf_wifi_qca4010_encryption_type_t

WiFi Encryption type

Enumerator
SF_WIFI_QCA4010_ENCRYPTION_TYPE_TKIP	Temporal Key Integrity Protocol.
SF_WIFI_QCA4010_ENCRYPTION_TYPE_CCMP	CTR mode with CBC-MAC Protocol.

sf_wifi_qca4010_interface_hw_mode_t

enum sf_wifi_qca4010_interface_hw_mode_t

WiFi Hardware mode

Enumerator
SF_WIFI_QCA4010_INTERFACE_HW_MODE_11B	802.11b
SF_WIFI_QCA4010_INTERFACE_HW_MODE_11G	802.11g
SF_WIFI_QCA4010_INTERFACE_HW_MODE_11N	802.11n

sf_wifi_qca4010_interface_mode_t

enum sf_wifi_qca4010_interface_mode_t

WiFi Interface mode

Enumerator
SF_WIFI_QCA4010_INTERFACE_MODE_AP	Access Point mode.
SF_WIFI_QCA4010_INTERFACE_MODE_CLIENT	Station Mode.

sf_wifi_qca4010_reset_type_t

enum sf_wifi_qca4010_reset_type_t

Wifi Module reset type

Enumerator
SF_WIFI_QCA4010_RESET_TYPE_SOFT	Soft reset module using AT command.
SF_WIFI_QCA4010_RESET_TYPE_HARD	Hard reset module by toggling Reset Pin.

sf_wifi_qca4010_security_type_t

enum sf_wifi_qca4010_security_type_t

WiFi Security type

Enumerator
SF_WIFI_QCA4010_SECURITY_TYPE_OPEN	Open. No encryption used.
SF_WIFI_QCA4010_SECURITY_TYPE_WEP	10 or 26 digit hexadecimal string
SF_WIFI_QCA4010_SECURITY_TYPE_WPA	WiFi Protected Access.
SF_WIFI_QCA4010_SECURITY_TYPE_WPA2	WiFi Protected Access v2.