 |
Synergy Software Package User's Manual
|
|
Synergy Software Package User's Manual
|
RTOS-integrated WiFi On Chip Stack Framework example. Implementation of SILEX WiFi Driver. It implements the following interfaces: More...
Macros | |
| #define | SF_WIFI_QCA4010_ONCHIP_CODE_VERSION_MAJOR (2U) |
| #define | SF_WIFI_QCA4010_ONCHIP_CODE_VERSION_MINOR (0U) |
RTOS-integrated WiFi On Chip Stack Framework example. Implementation of SILEX WiFi Driver. It implements the following interfaces:
| #define SF_WIFI_QCA4010_ONCHIP_CODE_VERSION_MAJOR (2U) |
WiFi Interface. Major Version of code that implements the API defined in this file
| #define SF_WIFI_QCA4010_ONCHIP_CODE_VERSION_MINOR (0U) |
Minor Version of code that implements the API defined in this file
| ssp_err_t SF_WIFI_QCA4010_ONCHIP_STACK_Close | ( | sf_wifi_qca4010_onchip_stack_ctrl_t *const | p_ctrl | ) |
Close the Wifi Device driver.
| [in] | p_ctrl | Wifi control block Implements sf_wifi_qca4010_onchip_stack_api_t::close Calls the low level wifi device driver's Close API to close the wifi Driver. |
| SSP_SUCCESS | Wifi Driver stop successfully. |
| SSP_ERR_NOT_OPEN | Device is not opened. |
| SSP_ERR_ASSERTION | Argument NULL is passed |
| SSP_ERR_WIFI_FAILED | Driver De-initialization failed |
| SSP_ERR_IN_USE | Device already in use |
| SSP_ERR_INTERNAL | Internal Error occurred |
Get Mutex
Close lower level wifi driver
Release the mutex
Delete Mutex
| ssp_err_t SF_WIFI_QCA4010_ONCHIP_STACK_DhcpServerStart | ( | sf_wifi_qca4010_onchip_stack_ctrl_t *const | p_ctrl, |
| ULONG * | p_start_ip, | ||
| ULONG * | p_end_ip | ||
| ) |
Starts DHCP server.
Implements sf_wifi_qca4010_onchip_stack_api_t::dhcpServerStart Starts DHCP server using on CHIP networking stack support.
| [in] | p_ctrl | Wifi control block |
| [in] | p_start_ip | Pointer to Start IP address |
| [in] | p_end_ip | Pointer to End IP address |
| SSP_SUCCESS | Successfully started DHCP Server |
| SSP_ERR_ASSERTION | Argument NULL is passed |
| SSP_ERR_NOT_OPEN | WiFi Driver in not open |
| SSP_ERR_IN_USE | Device already in use |
| SSP_ERR_WIFI_FAILED | Error occurred with command to Wifi module. |
Get the mutex
Start DHCP server
Release the mutex
| ssp_err_t SF_WIFI_QCA4010_ONCHIP_STACK_DhcpServerStop | ( | sf_wifi_qca4010_onchip_stack_ctrl_t *const | p_ctrl, |
| ULONG * | p_start_ip, | ||
| ULONG * | p_end_ip | ||
| ) |
Stops DHCP server.
Implements sf_wifi_qca4010_onchip_stack_api_t::dhcpServerStop Stops DHCP server using on CHIP networking stack support.
| [in] | p_ctrl | Wifi control block |
| [in] | p_start_ip | Pointer to Start IP |
| [in] | p_end_ip | Pointer to End IP |
| SSP_SUCCESS | Successfully stopped DHCP Server |
| SSP_ERR_ASSERTION | Argument NULL is passed |
| SSP_ERR_NOT_OPEN | WiFi Driver is not open |
| SSP_ERR_IN_USE | Device already in use |
| SSP_ERR_WIFI_FAILED | Error occurred with command to Wifi module. |
Get mutex
Stop DHCP server
Release the mutex
| ssp_err_t SF_WIFI_QCA4010_ONCHIP_STACK_IPAddressConfigure | ( | sf_wifi_qca4010_onchip_stack_ctrl_t *const | p_ctrl, |
| sf_wifi_qca4010_onchip_stack_ip_cfg_t *const | p_ip_cfg | ||
| ) |
Configure static IP or enable DHCP.
Implements sf_wifi_qca4010_onchip_stack_api_t::ipAddressConfigure Configures the IP address of the interface or enables DHCP using on CHIP networking stack support.
| [in] | p_ctrl | Wifi control block |
| [out] | p_ip_cfg | Pointer to IP Address configuration structure |
| SSP_SUCCESS | Successfully configured IP address. |
| SSP_ERR_ASSERTION | Argument NULL is passed |
| SSP_ERR_NOT_OPEN | WiFi Driver in not open |
| SSP_ERR_UNSUPPORTED | Functionality Unsupported |
| SSP_ERR_IN_USE | Device already in use |
| SSP_ERR_WIFI_FAILED | IP configuration failed. |
| SSP_ERR_INTERNAL | Internal Error occurred |
Get Mutex
Configure static IP or enable DHCP
Release the mutex
| ssp_err_t SF_WIFI_QCA4010_ONCHIP_STACK_Open | ( | sf_wifi_qca4010_onchip_stack_ctrl_t * | p_ctrl, |
| sf_wifi_qca4010_onchip_stack_cfg_t const *const | p_cfg | ||
| ) |
Open the WiFi Device driver to use the Onchip stack support.
Implements sf_wifi_qca4010_onchip_stack_api_t::open Calls the low level WiFi device driver's Open API to Initialize the WiFi Device Driver, for using onchip stack.
| SSP_SUCCESS | Module initialization successful |
| SSP_ERR_ALREADY_OPEN | WiFi module is already opened |
| SSP_ERR_WIFI_INIT_FAILED | WiFi module initialization failed |
| SSP_ERR_ASSERTION | Argument NULL is passed |
| SSP_ERR_IN_USE | Module in use |
| SSP_ERR_WIFI_FAILED | Failed to initialize |
| SSP_ERR_INTERNAL | Internal Error occurred |
Create Mutex for Synchronization
Get Mutex Lock
Initialize Wifi module
Initialize Socket Interface global variable , if module open is successful or already open
Release Mutex
| ssp_err_t SF_WIFI_QCA4010_ONCHIP_STACK_Ping | ( | sf_wifi_qca4010_onchip_stack_ctrl_t *const | p_ctrl, |
| ULONG * | p_ip_addr, | ||
| uint32_t | count, | ||
| uint32_t | interval_ms | ||
| ) |
Ping an IP address on the network.
| [in] | p_ctrl | Pointer to control structure. |
| [in] | p_ip_addr | Pointer to IP address. |
| [in] | count | Number of ping attempts. |
| [in] | interval_ms | Interval between ping attempts. |
| SSP_SUCCESS | Function completed successfully. |
| SSP_ERR_WIFI_FAILED | Error occurred with command to Wifi module. |
| SSP_ERR_ASSERTION | Assertion error occurred. |
| SSP_ERR_NOT_OPEN | The instance has not been opened. |
| SSP_ERR_IN_USE | Device already in use |
Get Mutex
Ping specified IP address
Release the mutex
| ssp_err_t SF_WIFI_QCA4010_ONCHIP_STACK_VersionGet | ( | ssp_version_t *const | p_version | ) |
This function gets the version information of the underlying driver.
Implements sf_wifi_qca4010_onchip_stack_api_t::versionGet
| [out] | p_version | Driver version information |
| SSP_ERR_ASSERTION | Argument NULL is passed |
| SSP_SUCCESS | Successfully read version information |