diff --git a/README.md b/README.md index 0b5e7b1..bf91a91 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,128 @@ # Wi-Fi Connection Manager (WCM) -WCM is a library which helps application developers to manage Wi-Fi Connectivity. The library provides a set of APIs that can be used to establish and monitor Wi-Fi connections on Cypress platforms that support Wi-Fi connectivity. + +WCM is a library which helps application developers to manage Wi-Fi connectivity. The library provides a set of APIs that can be used to establish and monitor Wi-Fi connections on Infineon platforms that support Wi-Fi connectivity. The library APIs are thread-safe. The library monitors the Wi-Fi connection and can notifies connection state changes through an event notification mechanism. The library also provides APIs to connect to a Wi-Fi network using Wi-Fi Protected Setup (WPS) methods. -## Features and Functionality +## Multi-core architecture and virtual API support + +The library supports multi-core architecture by making a subset of APIs available as virtual APIs. The virtualization of the WCM library helps to access the WCM APIs defined in one core from the other core using Inter Process Communication (IPC). The WCM can now be run on two cores simultaneously, with one core containing the full connectivity stack (primary core) and the other core containing the subset of virtual-only APIs (secondary core). + +The virtual APIs pipe the API requests over IPC to the primary core where the API is actually executed and the result is passed back to the secondary core. This virtualization abstracts out the implementation details and complexity of IPC, thus making multi-core connectivity application development simple. + +For more information on virtualization, see the [Virtual Connectivity Manager](https://github.com/Infineon/virtual-connectivity-manager) library. + + +## Features and functionality + The current implementation has the following features and functionality: -* Supports WPA3 personal network security. -* Supports STA, SoftAP, and Concurrent(simultaneous Soft-AP + STA) modes. -* Support for WPS - Enrollee role. -* Exposes Wi-Fi APIs to scan, join, and leave the Wi-Fi network. -* Connection monitoring: Monitors active connections and link events. Automatically reconnects to the AP if the connection with the AP is lost intermittently. Notifies the connection state change through event notification registration mechanism. -* This library is part of AnyCloud framework that supports connectivity applications based on FreeRTOS, lwIP, and mbed TLS. -* The library is built on top of the abstraction-rtos library that provides the RTOS abstraction API for FreeRTOS. - -## Supported Platforms + +- Supports WPA3 personal network security +- Supports STA, SoftAP, and Concurrent (simultaneous Soft-AP + STA) modes +- Support for WPS - Enrollee role +- Exposes Wi-Fi APIs to scan, join, and leave the Wi-Fi network +- Connection monitoring: Monitors active connections and link events. Automatically reconnects to the AP if the connection with the AP is lost intermittently. Notifies the connection state change through the event notification registration mechanism. +- Part of the AnyCloud framework that supports connectivity applications based on FreeRTOS, lwIP, and mbed TLS +- Built on top of the abstraction-rtos library that provides the RTOS abstraction API for FreeRTOS +- Supports multi-core architecture by providing the following APIs as virtual APIs: + - `cy_wcm_is_connected_to_ap` + - `cy_wcm_register_event_callback` + - `cy_wcm_deregister_event_callback` + + +## Supported platforms + This library and its features are supported on the following Infineon platforms: -* [PSoC™ 6 Wi-Fi BT Prototyping Kit (CY8CPROTO-062-4343W)](https://www.cypress.com/documentation/development-kitsboards/psoc-6-wi-fi-bt-prototyping-kit-cy8cproto-062-4343w) -* [PSoC™ 62S2 Wi-Fi BT Pioneer Kit (CY8CKIT-062S2-43012)](https://www.cypress.com/documentation/development-kitsboards/psoc-62s2-wi-fi-bt-pioneer-kit-cy8ckit-062s2-43012) +- [PSoC™ 6 Wi-Fi BT prototyping kit (CY8CPROTO-062-4343W)](https://www.infineon.com/cms/en/product/evaluation-boards/cy8cproto-062-4343w/) + +- [PSoC™ 62S2 Wi-Fi BT pioneer kit (CY8CKIT-062S2-43012)](https://www.infineon.com/cms/en/product/evaluation-boards/cy8ckit-062s2-43012/) -* [PSoC™ 6 WiFi-BT Pioneer Kit (CY8CKIT-062-WiFi-BT)](https://www.cypress.com/documentation/development-kitsboards/psoc-6-wifi-bt-pioneer-kit-cy8ckit-062-wifi-bt) +- [PSoC™ 6 WiFi-BT pioneer kit (CY8CKIT-062-WiFi-BT)](https://www.infineon.com/cms/en/product/evaluation-boards/cy8ckit-062-wifi-bt/) -* [PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-LAI-4373M2)](https://www.cypress.com/documentation/development-kitsboards/psoc-62s2-evaluation-kit-cy8ceval-062s2) +- [PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-LAI-4373M2)](https://www.infineon.com/cms/en/product/evaluation-boards/cy8ceval-062s2/) -* [CYW954907AEVAL1F Evaluation Kit(CYW954907AEVAL1F)](https://www.cypress.com/documentation/development-kitsboards/cyw954907aeval1f-evaluation-kit) +- [CYW954907AEVAL1F evaluation kit (CYW954907AEVAL1F)](https://www.infineon.com/cms/en/product/evaluation-boards/cyw954907aeval1f/) -* [CYW943907AEVAL1F Evaluation Kit(CYW943907AEVAL1F)](https://www.cypress.com/documentation/development-kitsboards/cyw943907aeval1f-evaluation-kit) +- [CYW943907AEVAL1F evaluation kit (CYW943907AEVAL1F)](https://www.infineon.com/cms/en/product/evaluation-boards/cyw943907aeval1f/) -* [PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-MUR-43439M2)](https://www.cypress.com/documentation/development-kitsboards/psoc-62s2-evaluation-kit-cy8ceval-062s2) +- [PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-MUR-43439M2)](https://www.infineon.com/cms/en/product/evaluation-boards/cy8ceval-062s2/) + +**Note**: Virtual APIs are supported on all PSoC 62 devices, but they have only been tested on the CY8CEVAL-062S2-MUR-43439M2 kit. + +## Dependent libraries -## Dependent Libraries This library depends on the following: -* [wifi-core-freertos-lwip-mbedtls](https://github.com/Infineon/wifi-core-freertos-lwip-mbedtls) -* [Wi-Fi Host Driver](https://github.com/Infineon/wifi-host-driver) -## Quick Start -* To use wifi-connection-manager library for FreeRTOS, lwIP, and mbed TLS, the application should pull [wifi-core-freertos-lwip-mbedtls](https://github.com/Infineon/wifi-core-freertos-lwip-mbedtls) library which will internally pull wifi-connection-manager, FreeRTOS, lwIP, mbed TLS and other dependent modules. -To pull wifi-core-freertos-lwip-mbedtls create the following *.mtb* file - - *wifi-core-freertos-lwip-mbedtls.mtb:* https://github.com/Infineon/wifi-core-freertos-lwip-mbedtls#latest-v1.X#$$ASSET_REPO$$/wifi-core-freertos-lwip-mbedtls/latest-v1.X +- [wifi-core-freertos-lwip-mbedtls](https://github.com/Infineon/wifi-core-freertos-lwip-mbedtls) + +- [Wi-Fi Host Driver](https://github.com/Infineon/wifi-host-driver) -* For existing Wi-Fi Connection Manager version 2.X users a [porting guide](https://Infineon.github.io/wifi-connection-manager/porting_guide.md) is available to migrate to Wi-Fi Connection Manager version 3.0 +If virtual APIs are to be used, it additionally depends on the [Virtual Connectivity Manager](https://github.com/Infineon/virtual-connectivity-manager). -* A set of pre-defined configuration files have been bundled with the wifi-core-freertos-lwip-mbedtls library for FreeRTOS, lwIP, and mbed TLS. The developer is expected to review the configuration and make adjustments. See the "Quick Start" section in [README.md](https://github.com/Infineon/wifi-core-freertos-lwip-mbedtls/blob/master/README.md). +## Quick start -* A set of COMPONENTS must be defined in the code example project's Makefile for this library. See the "Quick Start" section in [README.md](https://github.com/Infineon/wifi-core-freertos-lwip-mbedtls/blob/master/README.md). +1. To use wifi-connection-manager library for FreeRTOS, lwIP, and mbed TLS, the application should pull the [wifi-core-freertos-lwip-mbedtls](https://github.com/Infineon/wifi-core-freertos-lwip-mbedtls) library which will internally pull wifi-connection-manager, FreeRTOS, lwIP, mbed TLS, and other dependent modules. -* The WCM library disables all the debug log messages by default. To enable log messages, the application must perform the following: +2. To pull [wifi-core-freertos-lwip-mbedtls](https://github.com/Infineon/wifi-core-freertos-lwip-mbedtls#latest-v1.X#$$ASSET_REPO$$/wifi-core-freertos-lwip-mbedtls/latest-v1.X), create the *wifi-core-freertos-lwip-mbedtls.mtb* file. - - Add the `ENABLE_WCM_LOGS` macro to the *DEFINES* in the code example's Makefile. The Makefile entry would look like as follows: +3. For existing Wi-Fi Connection Manager version 2.x users, a [porting guide](https://Infineon.github.io/wifi-connection-manager/porting_guide.md) is available to migrate to Wi-Fi Connection Manager version 3.0. + +4. Review the pre-defined configuration files bundled with the wifi-core-freertos-lwip-mbedtls library for FreeRTOS, lwIP, and mbed TLS and make adjustments. See the "Quick start" section in [README.md](https://github.com/Infineon/wifi-core-freertos-lwip-mbedtls/blob/master/README.md). + +5. Define a set of COMPONENTS in the code example project's Makefile for this library. See the "Quick start" section in [README.md](https://github.com/Infineon/wifi-core-freertos-lwip-mbedtls/blob/master/README.md). + +6. WPS is disabled by default. WPS uses Mbed TLS security stack. Enable the following components for WPS: ``` - DEFINES+=ENABLE_WCM_LOGS + COMPONENTS+=WPS MBEDTLS ``` - - - Call the `cy_log_init()` function provided by the *cy-log* module. cy-log is part of the *connectivity-utilities* library. - - - See [connectivity-utilities library API documentation](https://Infineon.github.io/connectivity-utilities/api_reference_manual/html/group__logging__utils.html). +7. The WCM library disables all the debug log messages by default. To enable log messages, the application must perform the following: + + 1. Add the `ENABLE_WCM_LOGS` macro to the `DEFINES` in the code example's Makefile. The Makefile entry would look like as follows: + ``` + DEFINES+=ENABLE_WCM_LOGS + ``` + 2. Call the `cy_log_init()` function provided by the *cy-log* module. cy-log is part of the *connectivity-utilities* library. + See [connectivity-utilities library API documentation](https://Infineon.github.io/connectivity-utilities/api_reference_manual/html/group__logging__utils.html). + + - To enable logs in a dual core application please refer to [Enable logs in dual core application](https://github.com/Infineon/virtual-connectivity-manager/-/blob/main/README.md#enable-logs-in-dual-core-application) section in Virtual Connectivity Manager. + +### Virtual API usage + +* To use virtual WCM APIs pull [Virtual Connectivity Manager](https://github.com/Infineon/virtual-connectivity-manager) library. + Create the following *.mtb* file to pull the library + - *virtual-connectivity-manager.mtb:* https://github.com/Infineon/virtual-connectivity-manager#latest-v1.X#$$ASSET_REPO$$/virtual-connectivity-manager/latest-v1.X + +**Note:** To use WCM APIs in a multi-core environment, applications on both the cores should include WCM and VCM libraries. + +* Define the following compile-time macro in the primary core application's Makefile: + ``` + DEFINES+=ENABLE_MULTICORE_CONN_MW + ``` +* Define the following compile-time macros in the secondary core application's Makefile: + ``` + DEFINES+=ENABLE_MULTICORE_CONN_MW USE_VIRTUAL_API + ``` +* Call the `cy_vcm_init()` function provided by the VCM library from the application on both cores, before invoking the virtual WCM APIs. + + See [Virtual Connectivity Manager library API documentation](https://Infineon.github.io/virtual-connectivity-manager/api_reference_manual/html/group__logging__utils.html). + +**Notes:** + - To ensure that the VCM initialization is synchronized, the project which boots first(i.e CM0+ project in case of psoc62) must call `cy_vcm_init` before bringing up the second project(i.e CM4 project in case of psoc62). + - The first project must initialize VCM, by passing `config.hal_resource_opt` as `CY_VCM_CREATE_HAL_RESOURCE` in `cy_vcm_init`. The second project must pass `config.hal_resource_opt` as `CY_VCM_USE_HAL_RESOURCE`. -* WPS is disabled by default. WPS uses Mbed TLS security stack. Enable the following components for WPS. - ``` - COMPONENTS+=WPS MBEDTLS - ``` +## Additional information -## Additional Information -* [Wi-Fi Connection Manager RELEASE.md](./RELEASE.md) +- [Wi-Fi Connection Manager RELEASE.md](./RELEASE.md) -* [Wi-Fi Connection Manager API Documentation](https://Infineon.github.io/wifi-connection-manager/api_reference_manual/html/index.html) +- [Wi-Fi Connection Manager API documentation](https://Infineon.github.io/wifi-connection-manager/api_reference_manual/html/index.html) -* [Porting guide for Wi-Fi Connection Manager version 3.0](https://Infineon.github.io/wifi-connection-manager/porting_guide.md) +- [Porting guide for Wi-Fi Connection Manager version 3.0](https://Infineon.github.io/wifi-connection-manager/porting_guide.md) -* [Connectivity Utilities API documentation - for cy-log details](https://Infineon.github.io/connectivity-utilities/api_reference_manual/html/group__logging__utils.html) +- [Connectivity Utilities API documentation - for cy-log details](https://Infineon.github.io/connectivity-utilities/api_reference_manual/html/group__logging__utils.html) -* [ModusToolbox™ Software Environment, Quick Start Guide, Documentation, and Videos](https://www.cypress.com/products/modustoolbox-software-environment) +- [ModusToolbox™ software environment, quick start guide, documentation, and videos](https://www.infineon.com/modustoolbox) -* [Wi-Fi Connection Manager version](./version.xml) +- [Wi-Fi Connection Manager version](./version.xml) -* [ModusToolbox™ AnyCloud code examples](https://github.com/Infineon?q=mtb-example-anycloud%20NOT%20Deprecated) +- [ModusToolbox™ any cloud code examples](https://github.com/Infineon?q=mtb-example-anycloud%20NOT%20Deprecated) diff --git a/RELEASE.md b/RELEASE.md index 5d58bfd..e4ea493 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,86 +1,117 @@ # Wi-Fi Connection Manager (WCM) -## What's Included? +## What's included? + See the [README.md](./README.md) for a complete description of the Wi-Fi Connection Manager. -## Known Issues +## Known issues + | Problem | Workaround | | ------- | ---------- | -| The `cy_wcm_deinit` API does not bring down the network stack as the default underlying lwIP stack does not have an implementation for deinit. Therefore, the expectation is that `cy_wcm_init` and `cy_wcm_deinit` APIs should be invoked only once. | No workaround. Support will be added in a future release. | -| cy_wcm_connect_ap API does not connect to AP, if MAC address is specified as connection parameter.| No workaround. This issue will be fixed in future release. | -| IAR 9.30 toolchain throws build errors on Debug mode, if application explicitly includes iar_dlmalloc.h file | Add '--advance-heap' to LDFLAGS in application Makefile. | +| The `cy_wcm_deinit` API does not bring down the network stack because the default underlying lwIP stack does not have an implementation for deinit. Therefore, the expectation is that `cy_wcm_init` and `cy_wcm_deinit` APIs should be invoked only once. | No workaround. Support will be added in a future release. | +| The `cy_wcm_connect_ap` API does not connect to AP if the MAC address is specified as a connection parameter.| No workaround. This issue will be fixed in future release. | +| IAR 9.30 toolchain throws build errors on Debug mode if the application explicitly includes the *iar_dlmalloc.h* file | Add `'--advance-heap'` to `LDFLAGS` in the application Makefile. | ## Changelog -### v3.0.1 -* General bug fixes. +### v3.1.0 + +- Enabled multi-core, virtual API support for the following WCM APIs: + - `cy_wcm_is_connected_to_ap` + - `cy_wcm_register_event_callback` + - `cy_wcm_deregister_event_callback` +- Enabled low power mode for 4390x devices +- Updated documentation +- Added support for new security type `CY_WCM_SECURITY_WPA2_AES_PSK_SHA256` +- General bug fixes + ### v3.0.0 -* Wifi-connection-manager is updated to be network stack agnostic. -* Added support for CM0P core. -* Updated Documentation. + +- wifi-connection-manager updated to be network stack agnostic + +- Added support for CM0P core +- Updated documentation + ### v2.3.0 -* Added support for WPA3-EXT SAE Supplicant + +- Added support for WPA3-EXT SAE Supplicant + ### v2.2.0 -* Added support for CY8CEVAL-062S2-MUR-43439M2 kit + +- Added support for the CY8CEVAL-062S2-MUR-43439M2 kit + ### v2.1.0 -* Added support for CYW943907AEVAL1F and CYW954907AEVAL1F kits + +- Added support for CYW943907AEVAL1F and CYW954907AEVAL1F kits + ### v2.0.4 -* Documentation updates. -* Minor updates and improvements added in connect to AP and WPS APIs. -* General bug fixes. + +- Documentation updates +- Minor updates and improvements added in connect to AP and WPS APIs +- General bug fixes + ### v2.0.3 -* Added coverity fixes. + +- Added Coverity fixes + ### v2.0.2 -* Fixed passphrase length check for enterprise security auth types. +- Fixed passphrase length check for enterprise security auth types + ### v2.0.1 -* Minor fixes added in ping API, and in re-connection logic for statically assigned IP. -* WEP security support is disabled in connect AP API. -* Documentation updates. + +- Minor fixes added in ping API, and in re-connection logic for statically assigned IP +- WEP security support is disabled in connect AP API +- Documentation updates + ### v2.0.0 -* Added support for Soft-AP and concurrent (simultaneous Soft-AP + STA) modes. -* Documentation updates. + +- Added support for SoftAP and concurrent (simultaneous SoftAP + STA) modes +- Documentation updates + ### v1.1.0 -* Introduced APIs to get the following: + +- Introduced APIs to get the following: - Connected AP information - WLAN interface statistics - IPv6 link-local address - Gateway IP address - Netmask IP address - Gateway MAC address -* Introduced API to ping IPv4 address -* Minor documentation updates +- Introduced API to ping IPv4 address +- Minor documentation updates + ### v1.0.1 -* Code snippets added to the documentation +- Code snippets added to the documentation -### v1.0.0 -* Initial release for Wi-Fi Connection Manager -* Includes support for Wi-Fi Protected Setup (WPS) - Enrollee role +### v1.0.0 +- Initial release for Wi-Fi Connection Manager +- Includes support for Wi-Fi Protected Setup (WPS) - Enrollee role +- Exposes Wi-Fi APIs to scan, join, and leave a Wi-Fi network +- Connection monitoring: Monitor active connections and link events. Provides a mechanism to register for event notification. Re-authenticates the connection with the AP in case of intermittent connection loss. -* Exposes Wi-Fi APIs to scan, join, and leave a Wi-Fi network. -* Connection monitoring: Monitor active connections and link events. Provides a mechanism to register for event notification. Re-authenticates the connection with the AP in case of intermittent connection loss. +### Supported software and tools -### Supported Software and Tools -This version of the library was validated for compatibility with the following Software and Tools: +This version of the library was validated for compatibility with the following software and tools: -| Software and Tools | Version | +| Software and tools | Version | | :--- | :----: | -| ModusToolbox™ Software Environment | 3.0 | -| - ModusToolbox™ Device Configurator | 4.0 | -| - ModusToolbox™ CapSense Configurator / Tuner tools | 5.0 | -| PSoC 6 Peripheral Driver Library (PDL) | 3.0.0 | +| ModusToolbox™ software environment | 3.0 | +| ModusToolbox™ Device Configurator | 4.0 | +| ModusToolbox™ CAPSENSE™ Configurator / Tuner tools | 5.0 | +| PSoC™ 6 Peripheral Driver Library (PDL) | 3.0.0 | | GCC Compiler | 10.3.1 | -| IAR Compiler (only for AnyCloud) | 9.30 | -| Arm Compiler 6 | 6.16 | +| IAR Compiler (only for any cloud) | 9.30 | +| Arm® Compiler 6 | 6.16 | diff --git a/docs/api_reference_manual/html/group__cy__wcm__error.html b/docs/api_reference_manual/html/group__cy__wcm__error.html index 3b47ab0..e86f997 100644 --- a/docs/api_reference_manual/html/group__cy__wcm__error.html +++ b/docs/api_reference_manual/html/group__cy__wcm__error.html @@ -90,16 +90,16 @@
Cypress middleware APIs return results of type cy_rslt_t.
+Infineon middleware APIs return results of type cy_rslt_t.
It consists of three parts:
Module base Type Library specific error code +
Module base Type Library-specific error code +-----------------------------------+------+------------------------------+ - |CY_RSLT_MODULE_WCM_BASE | 0x2 | Error Code | + |CY_RSLT_MODULE_WCM_BASE | 0x2 | Error code | +-----------------------------------+------+------------------------------+ 14-bits 2-bits 16-bits @@ -107,17 +107,17 @@
The data structure cy_rslt_t is part of cy_result.h located in <core_lib/include>.
Module base: This base is derived from CY_RSLT_MODULE_MIDDLEWARE_BASE (defined in cy_result.h) and is an offset of the CY_RSLT_MODULE_MIDDLEWARE_BASE. The details of the offset and the middleware base are defined in cy_result_mw.h, that is part of GitHub connectivity-utilities For example, Wi-Fi Connection Manager (WCM) uses CY_RSLT_MODULE_WCM_BASE as the module base.
Type: This type is defined in cy_result.h and can be one of CY_RSLT_TYPE_FATAL, CY_RSLT_TYPE_ERROR, CY_RSLT_TYPE_WARNING, or CY_RSLT_TYPE_INFO. AWS library error codes are of type CY_RSLT_TYPE_ERROR.
-Library-specific error code: These error codes are library-specific and defined in the macro section.
+Library-specific error codes: These error codes are library-specific and defined in the macro section.
Helper macros used for creating the library-specific result are provided as part of cy_result.h.
Macros | |
#define | CY_RSLT_WCM_ERR_BASE CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_WCM_BASE, 0) |
Generic wcm base error code. | |
Generic WCM base error code. | |
#define | CY_RSLT_WCM_WAIT_TIMEOUT (CY_RSLT_WCM_ERR_BASE + 1) |
WCM Error Codes. More... | |
WCM error codes. More... | |
#define | CY_RSLT_WCM_BAD_NETWORK_PARAM (CY_RSLT_WCM_ERR_BASE + 2) |
Bad network parameters. More... | |
IPv6 global IP not supported. More... | |
#define | CY_RSLT_WCM_IPV6_INTERFACE_NOT_READY (CY_RSLT_WCM_ERR_BASE + 23) |
IPV6 interface not ready. More... | |
IPv6 interface not ready. More... | |
#define | CY_RSLT_WCM_PING_FAILURE (CY_RSLT_WCM_ERR_BASE + 24) |
Failure in executing ping. More... | |
#define | CY_RSLT_WCM_SEMAPHORE_ERROR (CY_RSLT_WCM_ERR_BASE + 37) |
Semaphore error. More... | |
-#define | CY_RSLT_WCM_SECURITY_NOT_FOUND (CY_RSLT_WCM_ERR_BASE + 38) |
Security type could not be determined - | |
#define | CY_RSLT_WCM_SECURITY_NOT_FOUND (CY_RSLT_WCM_ERR_BASE + 38) |
Security type could not be determined. More... | |
-#define | CY_RSLT_WCM_CONNECT_IN_PROGRESS (CY_RSLT_WCM_ERR_BASE + 39) |
Connect to AP is in progress - | |
#define | CY_RSLT_WCM_CONNECT_IN_PROGRESS (CY_RSLT_WCM_ERR_BASE + 39) |
Connect to AP is in progress. More... | |
-#define | CY_RSLT_WCM_GATEWAY_ADDR_ERROR (CY_RSLT_WCM_ERR_BASE + 40) |
Failed to get the Gateway address - | |
#define | CY_RSLT_WCM_GATEWAY_ADDR_ERROR (CY_RSLT_WCM_ERR_BASE + 40) |
Failed to get the Gateway address. More... | |
-#define | CY_RSLT_WCM_NETMASK_ADDR_ERROR (CY_RSLT_WCM_ERR_BASE + 41) |
Failed to get the netmask address - | |
#define | CY_RSLT_WCM_NETMASK_ADDR_ERROR (CY_RSLT_WCM_ERR_BASE + 41) |
Failed to get the netmask address. More... | |
-#define | CY_RSLT_WCM_IP_ADDR_ERROR (CY_RSLT_WCM_ERR_BASE + 42) |
Failed to get the IP address - | |
#define | CY_RSLT_WCM_IP_ADDR_ERROR (CY_RSLT_WCM_ERR_BASE + 42) |
Failed to get the IP address. More... | |
-#define | CY_RSLT_WCM_GATEWAY_MAC_ADDR_ERROR (CY_RSLT_WCM_ERR_BASE + 43) |
Failed to get the Gateway MAC address - | |
#define | CY_RSLT_WCM_GATEWAY_MAC_ADDR_ERROR (CY_RSLT_WCM_ERR_BASE + 43) |
Failed to get the Gateway MAC address. More... | |
-#define | CY_RSLT_WCM_NW_INIT_ERROR (CY_RSLT_WCM_ERR_BASE + 44) |
Failed to initialize the network stack - | |
#define | CY_RSLT_WCM_NW_INIT_ERROR (CY_RSLT_WCM_ERR_BASE + 44) |
Failed to initialize the network stack. More... | |
#define | CY_RSLT_WCM_WPS_PBC_OVERLAP (CY_RSLT_WCM_ERR_BASE + 45) |
WPS Error Codes. More... | |
WPS error codes. More... | |
#define | CY_RSLT_WCM_WPS_ERROR_RECEIVED_WEP_CREDENTIALS (CY_RSLT_WCM_ERR_BASE + 46) |
WPS received incorrect credentials. More... | |
WPS PBC/PIN mode failed. More... | |
#define | CY_RSLT_WCM_DHCP_TIMEOUT (CY_RSLT_WCM_ERR_BASE + 48) |
DHCP Error Code. More... | |
DHCP error code. More... | |
#define | CY_RSLT_WCM_WPA3_SUPPLICANT_ERROR (CY_RSLT_WCM_ERR_BASE + 49) |
WPA3 Supplicant Error Code. More... | |
WPA3 supplicant error code. More... | |
#define | CY_RSLT_WCM_UNSUPPORTED_API (CY_RSLT_WCM_ERR_BASE + 50) |
Unsupported WCM API error code. More... | |
#define | CY_RSLT_WCM_VCM_ERROR (CY_RSLT_WCM_ERR_BASE + 51) |
VCM error code. More... | |
#define | CY_RSLT_WCM_POWERSAVE_MODE_NOT_SUPPORTED (CY_RSLT_WCM_ERR_BASE + 52) |
Powersave Mode error code. More... | |
WPA2 PSK SHA256 Security with AES
+
WPA2 PSK security with TKIP.
Enumeration of 802.11 Radio Bands.
+Enumeration of 802.11 radio bands.
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CY_WCM_WIFI_BAND_ANY | The platform will choose an available band. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CY_WCM_WIFI_BAND_ANY | Platform will choose an available band.
|
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CY_WCM_SCAN_RSSI_FAIR | Wi-Fi RSSI values greater than -90 dBm. |
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CY_WCM_INTERFACE_TYPE_STA | STA or Client interface. + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CY_WCM_INTERFACE_TYPE_STA | STA or client interface. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CY_WCM_INTERFACE_TYPE_AP | SoftAP interface. |
enum cy_wcm_powersave_mode_t | +
Enumeration of Scan Status.
+Enumeration of scan status.
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CY_WCM_SCAN_INCOMPLETE | Scan is in progress; more scan results will be returned. |
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CY_WCM_WPS_PBC_MODE | Push button mode. |
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CY_WCM_WPS_CONFIG_USBA | USB configuration. |
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CY_WCM_WPS_OPEN_AUTHENTICATION | Authentication type OPEN. |
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CY_WCM_WPS_MIXED_ENCRYPTION | MIXED encryption. |
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CY_WCM_WPS_DEVICE_COMPUTER | Computer devices.
- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CY_WCM_EVENT_CONNECTING | STA connecting to an AP.
- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CY_WCM_SCAN_FILTER_TYPE_SSID | SSID-based scan filtering. |
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CY_WCM_BSS_TYPE_INFRASTRUCTURE | Infrastructure network.
- | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Enumerator | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CY_WCM_IE_MASK_BEACON | Denotes mask for beacon packet.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Shuts down the WCM. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cy_rslt_t | cy_wcm_start_scan (cy_wcm_scan_result_callback_t scan_callback, void *user_data, cy_wcm_scan_filter_t *scan_filter) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Performs Wi-Fi network scan. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Performs a Wi-Fi network scan. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cy_rslt_t | cy_wcm_stop_scan (void) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Stops an ongoing Wi-Fi network scan. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Negotiates securely with a Wi-Fi Protected Setup (WPS) Registrar (usually an AP) and obtains the Wi-Fi network credentials. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cy_rslt_t | cy_wcm_wps_generate_pin (char wps_pin_string[CY_WCM_WPS_PIN_LENGTH]) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Generates random WPS PIN for PIN mode connection. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Generates a random WPS PIN for PIN mode connection. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cy_rslt_t | cy_wcm_register_event_callback (cy_wcm_event_callback_t event_callback) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Registers an event callback to monitor the connection and IP address change events. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Checks if the STA interface is connected to an AP. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cy_rslt_t | cy_wcm_get_associated_ap_info (cy_wcm_associated_ap_info_t *ap_info) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function retrieves the information such as SSID, BSSID, and other details of the AP to which the STA interface is connected. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Retrieves the information such as SSID, BSSID, and other details of the AP to which the STA interface is connected. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cy_rslt_t | cy_wcm_get_wlan_statistics (cy_wcm_interface_t interface, cy_wcm_wlan_statistics_t *stat) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function gets the WLAN statistics of the given interface from the time WLAN driver is up and running. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Gets the WLAN statistics of the given interface from the time WLAN driver is up and running. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cy_rslt_t | cy_wcm_get_gateway_mac_address (cy_wcm_mac_t *mac_addr) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Retrieves the MAC address of the gateway for STA interface. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sends a ping request to the given IP address. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cy_rslt_t | cy_wcm_start_ap (const cy_wcm_ap_config_t *ap_config) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Start an infrastructure Wi-Fi network (SoftAP). More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Starts an infrastructure Wi-Fi network (SoftAP). More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cy_rslt_t | cy_wcm_stop_ap (void) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Stops the infrastructure Wi-Fi network (SoftAP), removes the Information Element and stops the internal DHCP server. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Stops the infrastructure Wi-Fi network (SoftAP), removes the information element and stops the internal DHCP server. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cy_rslt_t | cy_wcm_get_associated_client_list (cy_wcm_mac_t *sta_list, uint8_t num_clients) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Gets the MAC address of the clients associated with the SoftAP. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cy_rslt_t | cy_wcm_set_ap_ip_setting (cy_wcm_ip_setting_t *ap_ip, const char *ip_addr, const char *netmask, const char *gateway_addr, cy_wcm_ip_version_t ver) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Stores the AP settings provided by the user. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cy_rslt_t | cy_wcm_allow_low_power_mode (cy_wcm_powersave_mode_t mode) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sets low power mode capability for WLAN CPU. More... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[in] | config | The configuration to be initialized. |
[in] | scan_callback | : Callback function which receives the scan results; callback will be executed in the context of the WCM. Scan results will be individually provided to this callback function. For more details on the scan results refer cy_wcm_scan_result_callback_t. |
[in] | scan_callback | : Callback function which receives the scan results; callback will be executed in the context of the WCM. Scan results will be individually provided to this callback function. For more details on the scan results, see cy_wcm_scan_result_callback_t. |
[in] | user_data | : User data to be returned as an argument in the callback function when the callback function is invoked. |
[in] | scan_filter | : Scan filter parameter passed for scanning (optional). |
Connects the STA interface to a AP using the Wi-Fi credentials and configuration parameters provided.
-On successful connection to the Wi-Fi network, the API returns the IP address. If the user does not know the security type of the AP then, connect_param.ap_credentials.security must be set to CY_WCM_SECURITY_UNKNOWN so that the library will internally find the security type before connecting to AP.
+On a successful connection to the Wi-Fi network, the API returns the IP address. If the user does not know the security type of the AP then, connect_param.ap_credentials.security must be set to CY_WCM_SECURITY_UNKNOWN so that the library will internally find the security type before connecting to AP.
This API is a blocking call; this function additionally performs the following checks: 1) Checks for and ignores duplicate connect requests to an already connected AP. 2) Checks the current connection state; if already connected, disconnects from the current Wi-Fi network and connects to the new Wi-Fi network. 3) If the user does not know the security type of the AP, the library internally finds the security type.
[in] | interface_type | : Type of the WCM interface. |
[out] | ip_addr | : Pointer to an IP address structure (or) an IP address structure array. If the given interface is CY_WCM_INTERFACE_TYPE_STA or CY_WCM_INTERFACE_TYPE_AP upon return, index-0 stores the IPv4 address of the interface. If the given interface type is CY_WCM_INTERFACE_TYPE_AP_STA, index-0 stores the IPv4 address of the STA interface and index-1 stores the IPV4 address of the AP interface. ip_addr should have enough valid memory to hold two IP address structures. |
[out] | ip_addr | : Pointer to an IP address structure (or) an IP address structure array. If the given interface is CY_WCM_INTERFACE_TYPE_STA or CY_WCM_INTERFACE_TYPE_AP upon return, index-0 stores the IPv4 address of the interface. If the given interface type is CY_WCM_INTERFACE_TYPE_AP_STA, index-0 stores the IPv4 address of the STA interface and index-1 stores the IPv4 address of the AP interface. ip_addr should have enough valid memory to hold two IP address structures. |
Retrieves the IPv6 address of the given interface.
-Note: Currently this API supports only CY_WCM_IPV6_LINK_LOCAL type.
+Note: Currently, this API supports only CY_WCM_IPV6_LINK_LOCAL type.
[in] | interface_type | : Type of the WCM interface. |
[out] | wps_pin_string | : Pointer to store the WPS PIN as a null-terminated string. |
[in] | event_callback | : Callback function to de-register from getting notifications. |
[out] | ap_info | : Pointer to store the information of the associated AP cy_wcm_associated_ap_info_t. |
[in] | ap_config | : Configuration parameters for the SoftAP. |
[out] | sta_list | : Pointer to MAC address (or) array of MAC addresses. The client's (STA) MAC address is stored on this array before the function returns. |
[out] | sta_list | : Pointer to the MAC address (or) array of MAC addresses. The client's (STA) MAC address is stored on this array before the function returns. |
[in] | num_clients | : Length of the array passed in sta_list. |
[in] | ip_addr | : Pointer to an array containing IP address of the AP in dotted-decimal format. |
[in] | netmask | : Pointer to an array containing network mask in dotted-decimal format. |
[in] | gateway_addr | : Pointer to an array containing gateway address in dotted-decimal format. |
[in] | ip_addr | : Pointer to an array containing the IP address of the AP in dotted-decimal format. |
[in] | netmask | : Pointer to an array containing the network mask in dotted-decimal format. |
[in] | gateway_addr | : Pointer to an array containing the gateway address in dotted-decimal format. |
[in] | ver | : IP version. Possible values CY_WCM_IP_VER_V6 or CY_WCM_IP_VER_V4. |
[in] | ap_ip | : Pointer to variable which stores AP settings. |
[in] | ap_ip | : Pointer to the variable which stores AP settings. |
cy_rslt_t cy_wcm_allow_low_power_mode | +( | +cy_wcm_powersave_mode_t | +mode | ) | ++ |
Sets low power mode capability for WLAN CPU.
+[in] | mode | - can be one of: CY_WCM_NO_POWERSAVE_MODE WLAN CPU will not go into powersave mode CY_WCM_PM1_POWERSAVE_MODE Powersave mode on specified interface without regard for throughput reduction CY_WCM_PM2_POWERSAVE_MODE Powersave mode on specified interface with High throughput |
@@ -134,6 +134,11 @@
#define | WPA2_SECURITY 0x00400000 | | Flag to enable WPA2 security. More... | | #define | WPA3_SECURITY 0x01000000 | | Flag to enable WPA3 PSK security. More... |
diff --git a/docs/api_reference_manual/html/group__group__wcm__structures.html b/docs/api_reference_manual/html/group__group__wcm__structures.html
index 7c9c889..0164b92 100644
--- a/docs/api_reference_manual/html/group__group__wcm__structures.html
+++ b/docs/api_reference_manual/html/group__group__wcm__structures.html
@@ -129,13 +129,22 @@
| Structure used to receive the information of the associated AP from cy_wcm_get_associated_ap_info(). More... | | | Structure used to receive the WLAN statistics of the given interface from the time the WLAN driver is up. More... | | struct | cy_wcm_custom_ie_info_t | | Structure used to fill the vendor information element (IE) as a part of starting SoftAP. More... | | | Structure which encapsulates the parameters of cy_wcm_event_callback_t function. More... | | |
[in] | result_ptr | : A pointer to the scan result; the scan result will be freed once the callback function returns from the application. There will not be any scan result when the scan status is CY_WCM_SCAN_COMPLETE. For more details on content of result_ptr, refer cy_wcm_scan_result_t. |
[in] | result_ptr | : A pointer to the scan result; the scan result will be freed once the callback function returns from the application. There will not be any scan result when the scan status is CY_WCM_SCAN_COMPLETE. For more details on content of result_ptr, see cy_wcm_scan_result_t. |
[in] | user_data | : User-provided data. |
[in] | status | : Status of the scan process. CY_WCM_SCAN_COMPLETE : Indicates the scan is completed. In this case the result_ptr will not contain any results. CY_WCM_SCAN_INCOMPLETE : Indicates the scan is in progress. In this case result_ptr contains one of the scan result. |
[in] | status | : Status of the scan process. CY_WCM_SCAN_COMPLETE : Indicates the scan is completed. In this case, the result_ptr will not contain any results. CY_WCM_SCAN_INCOMPLETE : Indicates the scan is in progress. In this case, result_ptr contains one of the scan result. |
This library provides a set of APIs that can be used to establish and monitor Wi-Fi connections on Cypress platforms that support Wi-Fi connectivity. WCM library APIs are easy to use; in addition, the library provides additional features such as Wi-Fi Protected Setup (WPS) and connection monitoring.
+This library provides a set of APIs that can be used to establish and monitor Wi-Fi connections on Infineon platforms that support Wi-Fi connectivity. WCM library APIs are easy to use; in addition, the library provides additional features such as Wi-Fi Protected Setup (WPS) and connection monitoring.
+The library supports multi-core architecture by making a subset of APIs available as virtual APIs. The virtualization of the WCM library helps to access the WCM APIs defined in one core from the other core using Inter Process Communication (IPC). WCM can now be run on two cores simultaneously, with one core containing the full connectivity stack (primary core) and the other core containing the subset of virtual-only APIs (secondary core). The virtual APIs pipe the API requests over IPC to the primary core where the API is actually executed and the result is passed back to the secondary core. This virtualization abstracts out the implementation details and complexity of IPC, thus making multi-core connectivity application development simple.
+For more information on virtualization, see the Virtual Connectivity Manager library.
The current implementation has the following features and functionality:
This library and its features are supported on the following Infineon platforms:
This library is bundled in wifi-core-freertos-lwip-mbedtls by default. wifi-core-freertos-lwip-mbedtls library helps code examples to fetch all the components needed to enable Wi-Fi connectivity.
+Dependent libraries +This library is bundled in wifi-core-freertos-lwip-mbedtls by default. The wifi-core-freertos-lwip-mbedtls library helps code examples to fetch all the components needed to enable Wi-Fi connectivity.
+If virtual APIs are to be used, it additionally depends on Virtual Connectivity Manager library.
ENABLE_WCM_LOGS
macro to the DEFINES in the code example's Makefile. The Makefile entry would look like as follows: cy_log_init()
function provided by the cy-log module. cy-log is part of the connectivity-utilities library. See *connectivity-utilities library API documentation. WPS is disabled by default. WPS uses Mbed TLS security stack. Enable the following components for WPS. The following snippet demonstrates how to initialize the Wi-Fi device and network stack, and starts scanning for APs without any filters. The scan_callback receives the scan results and prints them over the serial terminal.
+Snippet 1: Scan for all APs +The following snippet demonstrates how to initialize the Wi-Fi device and network stack, and start scanning for APs without any filters. The scan_callback receives the scan results and prints them over the serial terminal.
The following snippet demonstrates the configuration of a scan filter to filter by the SSID provided and start a scan. The scan_callback receives the scan results and prints them over the serial terminal.
The following snippet demonstrates scanning for WIFI_SSID to get the security type of the AP and then connect to it. After a successful connection, the device registers an event callback through which the middleware notifies the application on disconnection, reconnection, and IP change events. If the connection to AP fails, it is retried up to MAX_WIFI_RETRY_COUNT times before reporting failure.
@@ -323,32 +361,32 @@The following snippet demonstrates joining an AP and obtaining its credentials through WPS using the push button mode. The credentials obtained are printed on the serial terminal.
The following snippet demonstrates joining an AP and obtaining its credentials through WPS using the PIN mode. The credentials obtained are printed on the serial terminal.
@@ -462,10 +500,10 @@The following snippet demonstrates ping to the gateway IP address with a STA mode connection.
The following snippet demonstrates Soft AP start and stop.
+Snippet 7: SoftAP start-stop +The following snippet demonstrates SoftAP start and stop.
The following snippet demonstrates usage of API function cy_wcm_get_associated_client_list to get the list of clients connected to the Soft AP.
+Snippet 8: Clients connected to the SoftAP +The following snippet demonstrates usage of the cy_wcm_get_associated_client_list API function to get the list of clients connected to the SoftAP.
The following snippet demonstrates AP+STA concurrent mode operation.
@@ -1175,8 +1213,447 @@The following snippet demonstrates the usage of virtual WCM API - cy_wcm_is_connected_to_ap()
in a multi-core environment.
The following snippet demonstrates the usage of virtual WCM API - cy_wcm_register_event_callback()
and cy_wcm_deregister_event_callback()
in a multi-core environment.
Message Sequence Charts | |||||||||||
Message sequence charts | |||||||||||
▼Macros | |||||||||||
WCM-specific error codes | Cypress middleware APIs return results of type cy_rslt_t | ||||||||||
Enumerated Types | |||||||||||
WCM-specific error codes | Infineon middleware APIs return results of type cy_rslt_t | ||||||||||
Enumerated types | |||||||||||
Typedefs | |||||||||||
Structures | |||||||||||
Functions |
@@ -108,7 +108,7 @@
| | Optional custom IE information to be added to the SoftAP. | | |
Structure which encapsulates the parameters of cy_wcm_deregister_event_callback API.
++Data Fields | |
+cy_wcm_event_callback_t | event_callback |
WCM event callback function pointer to be de-registered. | |
Structure which encapsulates the parameters of cy_wcm_event_callback_t function.
++Data Fields | |
+cy_wcm_event_t | event |
WCM event type. | |
cy_wcm_event_data_t * | event_data |
A pointer to the event data. More... | |
cy_wcm_event_data_t* cy_wcm_event_callback_params_t::event_data | +
A pointer to the event data.
+The event data will be freed once the callback returns from the application
+ +Structure which encapsulates the parameters of cy_wcm_register_event_callback API.
++Data Fields | |
+cy_wcm_event_callback_t | event_callback |
WCM event callback function pointer type; if registered, callback is invoked when WHD posts events to WCM. | |
Paramter specific to scan filter mode.
+Parameter specific to scan filter mode.
Structure used to receive the WLAN statistics of the given Interface from the time WLAN driver is up.
+Structure used to receive the WLAN statistics of the given interface from the time the WLAN driver is up.
Data Fields |