sf_wifi_onchip_stack_api_t Struct Reference

#include <sf_wifi_onchip_stack_api.h>

Data Fields
ssp_err_t(*	open )(sf_wifi_onchip_stack_ctrl_t *p_ctrl, sf_wifi_onchip_stack_cfg_t const *const p_cfg)
	Pointer to function which initializes the network interface for data transfers. More...
ssp_err_t(*	close )(sf_wifi_onchip_stack_ctrl_t *const p_ctrl)
	Pointer to function which un-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(*	ipAddressCfg )(sf_wifi_onchip_stack_ctrl_t *const p_ctrl, sf_wifi_onchip_stack_ip_cfg_t *const p_cfg)
	Configures IP address of the interface. More...
ssp_err_t(*	dhcpServerStart )(sf_wifi_onchip_stack_ctrl_t *const p_ctrl, sf_wifi_ip_addr_t const *const p_start_ip, sf_wifi_ip_addr_t const *const p_end_ip)
	Starts DHCP server on the interface. More...
ssp_err_t(*	dhcpServerStop )(sf_wifi_onchip_stack_ctrl_t *const p_ctrl)
	Stop DHCP server on the interface. 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_onchip_stack_api_t::close) (sf_wifi_onchip_stack_ctrl_t *const p_ctrl)

Pointer to function which un-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

dhcpServerStart

ssp_err_t(* sf_wifi_onchip_stack_api_t::dhcpServerStart) (sf_wifi_onchip_stack_ctrl_t *const p_ctrl, sf_wifi_ip_addr_t const *const p_start_ip, sf_wifi_ip_addr_t const *const p_end_ip)

Starts DHCP server on the interface.

Parameters

[in]	p_ctrl	Pointer to the control block
[in]	p_start_ip	Pointer to start IP address
[in]	p_end_ip	Pointer to end IP address

dhcpServerStop

ssp_err_t(* sf_wifi_onchip_stack_api_t::dhcpServerStop) (sf_wifi_onchip_stack_ctrl_t *const p_ctrl)

Stop DHCP server on the interface.

Parameters

[in]

p_ctrl

Pointer to the control block

ipAddressCfg

ssp_err_t(* sf_wifi_onchip_stack_api_t::ipAddressCfg) (sf_wifi_onchip_stack_ctrl_t *const p_ctrl, sf_wifi_onchip_stack_ip_cfg_t *const p_cfg)

Configures IP address of the interface.

Parameters

[in]	p_ctrl	Pointer to the control block
[in,out]	p_cfg	Pointer to IP configuration structure.

open

ssp_err_t(* sf_wifi_onchip_stack_api_t::open) (sf_wifi_onchip_stack_ctrl_t *p_ctrl, sf_wifi_onchip_stack_cfg_t const *const p_cfg)

Pointer to function which 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 configuration structure.

versionGet

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

---

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

• sf_wifi_onchip_stack_api.h