#include <sf_wifi_api.h>

Data Fields
ssp_err_t(*	open )(sf_wifi_ctrl_t p_ctrl, sf_wifi_cfg_t const const p_cfg)
	Initializes the network interface for data transfers. More...

ssp_err_t(*	close )(sf_wifi_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(*	multicastListAdd )(sf_wifi_ctrl_t const p_ctrl, uint8_t const const p_mac_addr)
	Add the given MAC address to the multicast filter list. More...

ssp_err_t(*	multicastListDelete )(sf_wifi_ctrl_t const p_ctrl, uint8_t const const p_mac_addr)

ssp_err_t(*	statisticsGet )(sf_wifi_ctrl_t const p_ctrl, sf_wifi_stats_t const p_wifi_device_stats)
	Get the interface statistics. More...

ssp_err_t(*	transmit )(sf_wifi_ctrl_t const p_ctrl, uint8_t const p_buf, uint32_t length)
	Transmit data packet. More...

ssp_err_t(*	provisioningSet )(sf_wifi_ctrl_t const p_ctrl, sf_wifi_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(*	provisioningGet )(sf_wifi_ctrl_t const p_ctrl, sf_wifi_provisioning_t const p_wifi_provisioning)
	Get the provisioning information of WiFi module. More...

ssp_err_t(*	infoGet )(sf_wifi_ctrl_t const p_ctrl, sf_wifi_info_t const p_wifi_info)
	Get WiFi module information. More...

ssp_err_t(*	scan )(sf_wifi_ctrl_t const p_ctrl, sf_wifi_scan_t const p_scan, uint8_t *const p_cnt)
	Scan for WiFi SSIDs. More...

ssp_err_t(*	ACLAdd )(sf_wifi_ctrl_t const p_ctrl, uint8_t const const p_mac)
	Adds a MAC address to the Access Control List. Valid in AP mode only. More...

ssp_err_t(*	ACLDelete )(sf_wifi_ctrl_t const p_ctrl, uint8_t const const p_mac)
	Deletes a MAC address from Access Control List. Valid in AP mode only. More...

ssp_err_t(*	macAddressGet )(sf_wifi_ctrl_t const p_ctrl, uint8_t const p_mac)
	Get WiFi module MAC address. More...

ssp_err_t(*	macAddressSet )(sf_wifi_ctrl_t const p_ctrl, uint8_t const const p_mac)
	Set WiFi module MAC address. More...

ssp_err_t(*	wpsStart )(sf_wifi_ctrl_t const p_ctrl, sf_wifi_wps_t const const p_wps)
	Start WiFi WPS. 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

◆ ACLAdd

ssp_err_t(* sf_wifi_api_t::ACLAdd) (sf_wifi_ctrl_t *const p_ctrl, uint8_t const *const p_mac)

Adds a MAC address to the Access Control List. Valid in AP mode only.

Parameters

[in]	p_ctrl	Pointer to the control block for the WiFi module.
[in]	p_mac	Pointer to MAC address

◆ ACLDelete

ssp_err_t(* sf_wifi_api_t::ACLDelete) (sf_wifi_ctrl_t *const p_ctrl, uint8_t const *const p_mac)

Deletes a MAC address from Access Control List. Valid in AP mode only.

Parameters

[in]	p_ctrl	Pointer to the control block for the WiFi module.
[in]	p_mac	Pointer to MAC address

◆ close

ssp_err_t(* sf_wifi_api_t::close) (sf_wifi_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.

◆ infoGet

ssp_err_t(* sf_wifi_api_t::infoGet) (sf_wifi_ctrl_t *const p_ctrl, sf_wifi_info_t *const p_wifi_info)

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

◆ macAddressGet

ssp_err_t(* sf_wifi_api_t::macAddressGet) (sf_wifi_ctrl_t *const p_ctrl, uint8_t *const p_mac)

Get WiFi module MAC address.

Parameters

[in]	p_ctrl	Pointer to the control block for the WiFi module.
[out]	p_mac	Pointer to MAC address

◆ macAddressSet

ssp_err_t(* sf_wifi_api_t::macAddressSet) (sf_wifi_ctrl_t *const p_ctrl, uint8_t const *const p_mac)

Set WiFi module MAC address.

Parameters

[in]	p_ctrl	Pointer to the control block for the WiFi module.
[in]	p_mac	Pointer to MAC address

◆ multicastListAdd

ssp_err_t(* sf_wifi_api_t::multicastListAdd) (sf_wifi_ctrl_t *const p_ctrl, uint8_t const *const p_mac_addr)

Add the given MAC address to the multicast filter list.

Parameters

[in]	p_ctrl	Pointer to the control block for the WiFi module.
[in]	p_mac_addr	Pointer to the Mac address.

◆ multicastListDelete

ssp_err_t(* sf_wifi_api_t::multicastListDelete) (sf_wifi_ctrl_t *const p_ctrl, uint8_t const *const p_mac_addr)

Delete the given MAC address from the multicast filter list.

Parameters

[in]	p_ctrl	Pointer to the control block for the WiFi module.
[in]	p_mac_addr	Pointer to the Mac address.

◆ open

ssp_err_t(* sf_wifi_api_t::open) (sf_wifi_ctrl_t *p_ctrl, sf_wifi_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.

◆ provisioningGet

ssp_err_t(* sf_wifi_api_t::provisioningGet) (sf_wifi_ctrl_t *const p_ctrl, sf_wifi_provisioning_t *const p_wifi_provisioning)

Get the provisioning information of WiFi module.

Parameters

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

◆ provisioningSet

ssp_err_t(* sf_wifi_api_t::provisioningSet) (sf_wifi_ctrl_t *const p_ctrl, sf_wifi_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_api_t::scan) (sf_wifi_ctrl_t *const p_ctrl, sf_wifi_scan_t *const p_scan, uint8_t *const p_cnt)

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]	p_cnt	Pointer to variable, specifying maximum number of SSID's to scan and will be updated to number of actual SSIDs scanned by device

◆ statisticsGet

ssp_err_t(* sf_wifi_api_t::statisticsGet) (sf_wifi_ctrl_t *const p_ctrl, sf_wifi_stats_t *const p_wifi_device_stats)

Get the interface statistics.

Parameters

[in]	p_ctrl	Pointer to the control block for the WiFi module.
[out]	p_wifi_device_stats	Pointer to the WiFi module data statistics.

◆ transmit

ssp_err_t(* sf_wifi_api_t::transmit) (sf_wifi_ctrl_t *const p_ctrl, uint8_t *const p_buf, uint32_t length)

Transmit data packet.

Parameters

[in]	p_ctrl	Pointer to the control block for the WiFi module.
[in]	p_buf	Pointer to transmit buffer
[in]	length	Transmit buffer length

◆ versionGet

ssp_err_t(* sf_wifi_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

◆ wpsStart

ssp_err_t(* sf_wifi_api_t::wpsStart) (sf_wifi_ctrl_t *const p_ctrl, sf_wifi_wps_t const *const p_wps)

Start WiFi WPS.

Parameters

[in]	p_ctrl	Pointer to the control block for the WiFi module.
[in]	p_wps	Pointer to WiFi WPS configuration

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

sf_wifi_api.h

Data Fields

Detailed Description

Field Documentation

◆ ACLAdd

◆ ACLDelete

◆ close

◆ infoGet

◆ macAddressGet

◆ macAddressSet

◆ multicastListAdd

◆ multicastListDelete

◆ open

◆ provisioningGet

◆ provisioningSet

◆ scan

◆ statisticsGet

◆ transmit

◆ versionGet

◆ wpsStart