sf_wifi_qca4010_api_t Struct Reference

#include <sf_wifi_qca4010_api.h>

Data Fields
ssp_err_t(*	open )(sf_wifi_qca4010_ctrl_t *p_ctrl, sf_wifi_qca4010_cfg_t const *const p_cfg)
	Initializes the network interface for data transfers. More...
ssp_err_t(*	close )(sf_wifi_qca4010_ctrl_t *const p_ctrl)
	De-initialize the network interface and may put it in low power mode or power it off. Close the driver, disable the driver link, disable interrupt. More...
ssp_err_t(*	provisioningSet )(sf_wifi_qca4010_ctrl_t *const p_ctrl, sf_wifi_qca4010_provisioning_t const *const p_wifi_provisioning)
	Set WiFi module provisioning which will configure the module in AP or Client mode. More...
ssp_err_t(*	wifiStatusGet )(sf_wifi_qca4010_ctrl_t *const p_ctrl, sf_wifi_qca4010_status_t *const p_wifi_status)
	Get WiFi module information. More...
ssp_err_t(*	scan )(sf_wifi_qca4010_ctrl_t *const p_ctrl, sf_wifi_qca4010_scan_t *const p_scan, uint8_t count)
	Scan for WiFi SSIDs. More...
ssp_err_t(*	CommandSend )(sf_wifi_qca4010_ctrl_t *const p_ctrl, sf_wifi_qca4010_cmd_resp_t *const p_input_at_command, sf_wifi_qca4010_cmd_resp_t *const p_output, uint32_t const timeout)
	Send AT command given by user. More...
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)
	Gets version and stores it in provided pointer p_version. More...

Detailed Description

Framework API structure. Implementations will use the following API.

Field Documentation

close

ssp_err_t(* sf_wifi_qca4010_api_t::close) (sf_wifi_qca4010_ctrl_t *const p_ctrl)

De-initialize the network interface and may put it in low power mode or power it off. Close the driver, disable the driver link, disable interrupt.

Parameters

[in,out]

p_ctrl

Pointer to the control block for the WiFi module.

CommandSend

ssp_err_t(* sf_wifi_qca4010_api_t::CommandSend) (sf_wifi_qca4010_ctrl_t *const p_ctrl, sf_wifi_qca4010_cmd_resp_t *const p_input_at_command, sf_wifi_qca4010_cmd_resp_t *const p_output, uint32_t const timeout)

Send AT command given by user.

Parameters

[in]	p_ctrl	Pointer to the control block for the WiFi module.
[in]	p_input_at_command	Pointer to structure which contains Modem command to send
[in,out]	p_output	Pointer to buffer in which response will be sent to user, Also user will pass the size of the buffer which is pointed by p_output
[in]	timeout	Timeout for which framework will wait for response in milliseconds

open

ssp_err_t(* sf_wifi_qca4010_api_t::open) (sf_wifi_qca4010_ctrl_t *p_ctrl, sf_wifi_qca4010_cfg_t const *const p_cfg)

Initializes the network interface for data transfers.

Initial driver configuration, enable the driver link, enable interrupts and make device ready for data transfer.

Parameters

[in,out]	p_ctrl	Pointer to user-provided storage for the control block.
[in]	p_cfg	Pointer to WiFi configuration structure.

provisioningSet

ssp_err_t(* sf_wifi_qca4010_api_t::provisioningSet) (sf_wifi_qca4010_ctrl_t *const p_ctrl, sf_wifi_qca4010_provisioning_t const *const p_wifi_provisioning)

Set WiFi module provisioning which will configure the module in AP or Client mode.

Parameters

[in]	p_ctrl	Pointer to the control block for the WiFi module.
[in]	p_wifi_provisioning	Pointer to WiFi provisioning structure

scan

ssp_err_t(* sf_wifi_qca4010_api_t::scan) (sf_wifi_qca4010_ctrl_t *const p_ctrl, sf_wifi_qca4010_scan_t *const p_scan, uint8_t count)

Scan for WiFi SSIDs.

Parameters

[in]	p_ctrl	Pointer to the control block for the WiFi module.
[out]	p_scan	Pointer to structure which will hold scan result. It is the responsibility of the caller to ensure that adequate space is available to hold scan results.
[in,out]	count	Variable specifying maximum number of SSID's to scan and will be updated to number of actual SSIDs scanned by device

versionGet

ssp_err_t(* sf_wifi_qca4010_api_t::versionGet) (ssp_version_t *const p_version)

Gets version and stores it in provided pointer p_version.

Parameters

[out]

p_version

pointer to memory location to return version number

wifiStatusGet

ssp_err_t(* sf_wifi_qca4010_api_t::wifiStatusGet) (sf_wifi_qca4010_ctrl_t *const p_ctrl, sf_wifi_qca4010_status_t *const p_wifi_status)

Get WiFi module information.

Parameters

[in]	p_ctrl	Pointer to the control block for the WiFi module.
[out]	p_wifi_info	Pointer to WiFi module information structure

---

The documentation for this struct was generated from the following file:

• sf_wifi_qca4010_api.h