Overview

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.

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). 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.

Features and functionality

The current implementation has the following features and functionality:

• Supports WPA3 personal network security
• Supports STA, SoftAP, and Concurrent (simultaneous SoftAP + STA) modes
• Support for Wi-Fi Protected Setup (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 the notification registration mechanism.
• Part of the ModusToolbox™ environment that supports connectivity applications based on FreeRTOS, lwIP, and mbed TLS
• The library is built on top of the abstraction-rtos library that provides RTOS abstraction API for FreeRTOS
• Supports multi-core architecture by providing the following APIs as virtual APIs which can be invoked from another core:
  • 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)
• PSoC™ 62S2 Wi-Fi BT pioneer kit (CY8CKIT-062S2-43012)
• PSoC™ 6 WiFi-BT pioneer kit (CY8CKIT-062-WiFi-BT)
• PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-LAI-4373M2)
• CYW954907AEVAL1F Evaluation Kit(CYW954907AEVAL1F)
• CYW943907AEVAL1F Evaluation Kit(CYW943907AEVAL1F)
• PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-MUR-43439M2)
• XMC7200D-E272K8384 kit (KIT_XMC72_EVK_MUR_43439M2)
• PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-CYW43022CUB)

  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

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.

Quick start

• To use wifi-connection-manager library for FreeRTOS, lwIP, and mbed TLS, the application should pull 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 in deps folder.
  • 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
• For existing Wi-Fi Connection Manager version 2.x users, a porting guide is available to migrate to Wi-Fi Connection Manager version 3.0.
• 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.
• Define a set of COMPONENTS in the code example project's Makefile for this library. See the quick start section in README.md.
• WPS is disabled by default. WPS uses Mbed TLS security stack. Enable the following components for WPS:

  COMPONENTS+=WPS MBEDTLS

• 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.
     • To enable logs in a dual core application please refer to Enable logs in dual core application section in Virtual Connectivity Manager.

use virtual APIs

• To use WCM virtual APIs, pull 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 API documentation.

  Note

  - 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.

Code snippets

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.

 
/* Scan callback function */
void scan_callback(cy_wcm_scan_result_t *result_ptr, void *user_data, cy_wcm_scan_status_t status)
{
    /* Print the scan result only when scan is incomplete because on scan completion
     * the contents of result_ptr are empty.
     */
    if (status == CY_WCM_SCAN_INCOMPLETE)
    {
        printf(" %-32s     %4d     %2d\n",
               result_ptr->SSID, result_ptr->signal_strength, result_ptr->channel);
    }
}
 
void snippet_wcm_scan_without_filter()
{
    cy_rslt_t result;
 
    /* Initialize the Wi-Fi device as a STA.*/
    cy_wcm_config_t config = {.interface = CY_WCM_INTERFACE_TYPE_STA};
 
    /* Initialize the Wi-Fi device, Wi-Fi transport, and lwIP network stack.*/
    result = cy_wcm_init(&config);
    if(result != CY_RSLT_SUCCESS)
    {
        printf("\ncy_wcm_init failed....!\n");
    }
    /* Filter is set to NULL.*/
    result = cy_wcm_start_scan(scan_callback, NULL, NULL);
    if(result != CY_RSLT_SUCCESS)
    {
        printf("\ncy_wcm_start_scan failed....!\n");
    }
}

Snippet 2: Scan for a specific AP

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.

 
void snippet_wcm_scan_with_ssid_filter()
{
    cy_rslt_t result;
    cy_wcm_scan_filter_t scan_filter;
 
    /* SSID value which is used to filter the scan results.*/
    static const cy_wcm_ssid_t ssid = "SSID";
 
    /* Configure the scan filter specified by the variable ssid.*/
    scan_filter.mode = CY_WCM_SCAN_FILTER_TYPE_SSID;
    memcpy(scan_filter.param.SSID, ssid, sizeof(cy_wcm_ssid_t));
    printf("\n---------------------------------------------------------------------------------\n"
           "                  SSID                  RSSI   Channel      \n"
           "---------------------------------------------------------------------------------\n");
    result = cy_wcm_start_scan(scan_callback, NULL, &scan_filter);
    if(result != CY_RSLT_SUCCESS)
    {
        printf("\ncy_wcm_start_scan failed....!\n");
    }
}
 

Snippet 3: Connect to an AP

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.

 
/* Wi-Fi Credentials: Modify WIFI_SSID and WIFI_PASSWORD to match your Wi-Fi network
 * credentials.
 */
#define WIFI_SSID                           "SSID"
#define WIFI_PASSWORD                       "PASSWORD"
 
#define MAX_WIFI_RETRY_COUNT                (3u)
#define WIFI_CONN_RETRY_INTERVAL_MSEC       (100u)
 
/* The size of the cy_wcm_ip_address_t array that is passed to
 * cy_wcm_get_ip_addr API. In the case of stand-alone AP or STA mode, the size of
 * the array is 1. In concurrent AP/STA mode, the size of the array is 2 where
 * the first index stores the IP address of the STA and the second index
 * stores the IP address of the AP.
 */
 
/* Scan callback function */
void scan_to_get_security(cy_wcm_scan_result_t *result_ptr, void *user_data, cy_wcm_scan_status_t status)
{
    cy_wcm_security_t* security = (cy_wcm_security_t *)user_data;
    /* Scan for SSID and pass the security type through user_data.*/
    if ((strlen((const char *)result_ptr->SSID) != 0) && (status == CY_WCM_SCAN_INCOMPLETE))
    {
        *security = result_ptr->security;
        cy_wcm_stop_scan();
    }
}
 
void network_event_callback(cy_wcm_event_t event, cy_wcm_event_data_t *event_data)
{
    if (CY_WCM_EVENT_DISCONNECTED == event)
    {
        printf("Disconnected from Wi-Fi\n");
    }
    else if (CY_WCM_EVENT_RECONNECTED == event)
    {
        printf("Reconnected to Wi-Fi.\n");
    }
    /* This event corresponds to the event when the IP address of the device
     * changes.
     */
    else if (CY_WCM_EVENT_IP_CHANGED == event)
    {
        cy_wcm_ip_address_t ip_addr;
        cy_wcm_get_ip_addr(CY_WCM_INTERFACE_TYPE_STA, &ip_addr);
 
        if (event_data->ip_addr.version == CY_WCM_IP_VER_V4)
        {
            printf("IP Address: %d.%d.%d.%d\n", (uint8_t)event_data->ip_addr.ip.v4,
                   (uint8_t)(event_data->ip_addr.ip.v4 >> 8), (uint8_t)(event_data->ip_addr.ip.v4 >> 16),
                   (uint8_t)(event_data->ip_addr.ip.v4 >> 24));
        }
        else if(event_data->ip_addr.version == CY_WCM_IP_VER_V6)
        {
            printf("IP Address: %X:%X:%X:%X\n", (uint8_t)event_data->ip_addr.ip.v6[0],
                   (uint8_t)(event_data->ip_addr.ip.v6[1]), (uint8_t)(event_data->ip_addr.ip.v6[2]),
                   (uint8_t)(event_data->ip_addr.ip.v6[3]));
        }
    }
}
 
void snippet_wcm_connect_ap()
{
    cy_rslt_t result;
    cy_wcm_connect_params_t connect_param;
    cy_wcm_ip_address_t ip_address;
    cy_wcm_security_t security;
    cy_wcm_scan_filter_t scan_filter;
 
    /* Configure the scan filter specified by the macro WIFI_SSID.*/
    scan_filter.mode = CY_WCM_SCAN_FILTER_TYPE_SSID;
    memcpy(scan_filter.param.SSID, WIFI_SSID, sizeof(WIFI_SSID));
 
    /* Scan with the filter to obtain the security type. The function waits
     * until the security type is obtained in scan_to_get_security.
     */
    cy_wcm_start_scan(scan_to_get_security, (void *)(&security), &scan_filter);
    cy_rtos_delay_milliseconds(10000);
 
    memset(&connect_param, 0, sizeof(cy_wcm_connect_params_t));
    memset(&ip_address, 0, sizeof(cy_wcm_ip_address_t));
    memcpy(connect_param.ap_credentials.SSID, WIFI_SSID, sizeof(WIFI_SSID));
    memcpy(connect_param.ap_credentials.password, WIFI_PASSWORD, sizeof(WIFI_PASSWORD));
    connect_param.ap_credentials.security = security;
 
    /* Attempt to connect to Wi-Fi until a connection is made or 
     * MAX_WIFI_RETRY_COUNT attempts have been made.
     */
    for (uint32_t conn_retries = 0; conn_retries < MAX_WIFI_RETRY_COUNT; conn_retries++)
    {
        result = cy_wcm_connect_ap(&connect_param, &ip_address);
 
        if (result == CY_RSLT_SUCCESS)
        {
            printf("Successfully connected to Wi-Fi network '%s'.\n", connect_param.ap_credentials.SSID);
 
            /* Register event callbacks for changes in the Wi-Fi link status. These
             * events could be related to IP address changes, connection, and
             * disconnection events.
             */
            cy_wcm_register_event_callback(network_event_callback);
            break;
        }
 
        printf("Connection to Wi-Fi network failed with error code %d."
                "Retrying in %d ms...\n", (int)result, WIFI_CONN_RETRY_INTERVAL_MSEC);
 
        cy_rtos_delay_milliseconds(WIFI_CONN_RETRY_INTERVAL_MSEC);
    }
 
}

Snippet 4: Connect to an AP using the WPS-Push button

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 value of this macro specifies the maximum number of Wi-Fi networks the
 * device can join through WPS in one call to cy_wcm_wps_enrollee. This value is
 * 2 for dual-band AP. Note that the device can obtain Wi-Fi credentials of only
 * one network and therefore can receive a maximum of 1 for single-band Wi-Fi AP or
 * 2 for dual-band AP.
 */
#define MAX_WIFI_CREDENTIALS_COUNT          (2)
 
/* Device's enrollee details. Details of WPS mode, WPS authentication, and
 * encryption methods supported are provided in this structure.
 */
const cy_wcm_wps_device_detail_t enrollee_details =
{
    .device_name               = "PSoC 6",
    .manufacturer              = "Cypress",
    .model_name                = "PSoC 6",
    .model_number              = "1.0",
    .serial_number             = "1234567",
    .device_category           = CY_WCM_WPS_DEVICE_COMPUTER,
    .sub_category              = 7,
    .config_methods            = CY_WCM_WPS_CONFIG_LABEL | CY_WCM_WPS_CONFIG_VIRTUAL_PUSH_BUTTON | CY_WCM_WPS_CONFIG_VIRTUAL_DISPLAY_PIN,
    .authentication_type_flags = CY_WCM_WPS_OPEN_AUTHENTICATION | CY_WCM_WPS_WPA_PSK_AUTHENTICATION | CY_WCM_WPS_WPA2_PSK_AUTHENTICATION | CY_WCM_WPS_WPA2_WPA_PSK_MIXED_AUTHENTICATION,
    .encryption_type_flags     = CY_WCM_WPS_NO_ENCRYPTION | CY_WCM_WPS_AES_ENCRYPTION | CY_WCM_WPS_TKIP_ENCRYPTION
};
 
void snippet_wcm_wps_pbc()
{
    cy_rslt_t result;
 
    /* Store the credentials obtained through WPS.*/
    cy_wcm_wps_credential_t credentials[MAX_WIFI_CREDENTIALS_COUNT];
    cy_wcm_wps_config_t wps_config;
 
    /* Store the PIN used for WPS. It is unused when PBC mode is employed.*/
    char pin_string[CY_WCM_WPS_PIN_LENGTH];
    uint16_t credential_count = MAX_WIFI_CREDENTIALS_COUNT;
 
    /*Configure the mode of the WPS as CY_WCM_WPS_PBC_MODE.*/
    wps_config.mode = CY_WCM_WPS_PBC_MODE;
    wps_config.password = pin_string;
    memset(credentials, 0, sizeof(credentials));
 
    printf("Press the push button on your WPS AP.\n");
    result = cy_wcm_wps_enrollee(&wps_config, &enrollee_details, credentials, &credential_count);
 
    if (CY_RSLT_SUCCESS == result)
    {
        printf("WPS Success.\n");
 
        /* Print the WPS credentials obtained through WPS.*/
        for (uint32_t loop = 0; loop < credential_count; loop++)
        {
            printf("%d. SSID = %s, Password = %c%c******.\n", (uint8_t)loop + 1, credentials[loop].ssid, credentials[loop].passphrase[0], credentials[loop].passphrase[1]);
        }
    }
}

Snippet 5: Connect to an AP using WPS-PIN

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.

void snippet_wcm_wps_pin()
{
    cy_rslt_t result;
    cy_wcm_wps_credential_t credentials[MAX_WIFI_CREDENTIALS_COUNT];
    cy_wcm_wps_config_t wps_config;
    char pin_string[CY_WCM_WPS_PIN_LENGTH];
    uint16_t credential_count = MAX_WIFI_CREDENTIALS_COUNT;
 
    memset(credentials, 0, sizeof(credentials));
 
    /* Here, the WPS PIN is generated by the device. The user must
     * enter the PIN in the AP to join the network through WPS.
     */
    cy_wcm_wps_generate_pin(pin_string);
 
    /*Configure the mode of WPS as CY_WCM_WPS_PIN_MODE.*/
    wps_config.mode = CY_WCM_WPS_PIN_MODE;
    wps_config.password = pin_string;
    printf("Enter this PIN: \'%s\' in your AP.\n", pin_string);
    result = cy_wcm_wps_enrollee(&wps_config, &enrollee_details, credentials, &credential_count);
 
    if (CY_RSLT_SUCCESS == result)
    {
        printf("WPS Success.\n");
 
        /* Print the WPS credentials obtained through WPS.*/
        for (uint32_t loop = 0; loop < credential_count; loop++)
        {
            printf("%d. SSID = %s, Password = %c%c******.\n", (uint8_t)loop + 1, credentials[loop].ssid, credentials[loop].passphrase[0], credentials[loop].passphrase[1]);
        }
    }
}

Snippet 6: Pinging the gateway IP address

The following snippet demonstrates ping to the gateway IP address with a STA mode connection.

 
#define WIFI_SSID                           "SSID"
#define WIFI_PASSWORD                       "PASSWORD"
 
#define MAX_WIFI_RETRY_COUNT                (3u)
#define WIFI_CONN_RETRY_INTERVAL_MSEC       (100u)
 
void snippet_wcm_sta_ping()
{
    cy_rslt_t result;
    char ip4_str[16];
    cy_nw_ip_address_t nw_ipv4;
 
    /* Initialize the Wi-Fi device as a STA.*/
    cy_wcm_config_t config = {.interface = CY_WCM_INTERFACE_TYPE_STA};
 
    cy_wcm_connect_params_t connect_param;
    cy_wcm_ip_address_t ip_address;
    cy_wcm_ip_address_t ip_addr, gateway_addr;
    uint32_t elapsed_time_ms;
 
    memset(&connect_param, 0, sizeof(cy_wcm_connect_params_t));
    memset(&ip_address, 0, sizeof(cy_wcm_ip_address_t));
    memcpy(connect_param.ap_credentials.SSID, WIFI_SSID, sizeof(WIFI_SSID));
    memcpy(connect_param.ap_credentials.password, WIFI_PASSWORD, sizeof(WIFI_PASSWORD));
    connect_param.ap_credentials.security = CY_WCM_SECURITY_WPA2_AES_PSK;
 
    /* Initialize the Wi-Fi device, Wi-Fi transport, and lwIP network stack.*/
    result = cy_wcm_init(&config);
    if (result != CY_RSLT_SUCCESS)
    {
        printf("\ncy_wcm_init failed...!\n");
        return;
    }
 
    printf("\n*** Starting STA Mode ***\n");
    /* Attempt to connect to Wi-Fi until a connection is made or
     * MAX_WIFI_RETRY_COUNT attempts have been made.
     */
    for (uint32_t conn_retries = 0; conn_retries < MAX_WIFI_RETRY_COUNT; conn_retries++)
    {
        result = cy_wcm_connect_ap(&connect_param, &ip_address);
 
        if (result == CY_RSLT_SUCCESS)
        {
            printf("Successfully connected to Wi-Fi network '%s'.\n", connect_param.ap_credentials.SSID);
            break;
        }
 
        printf("Connection to Wi-Fi network failed with error code %d."
                "Retrying in %d ms...\n", (int)result, WIFI_CONN_RETRY_INTERVAL_MSEC);
 
        cy_rtos_delay_milliseconds(WIFI_CONN_RETRY_INTERVAL_MSEC);
    }
 
    /* Get IPv4 address */
    cy_wcm_get_ip_addr(CY_WCM_INTERFACE_TYPE_STA, &ip_addr);
    nw_ipv4.ip.v4 = ip_addr.ip.v4;
    cy_nw_ntoa(&nw_ipv4, ip4_str);
    printf("IPV4 address: %s\n", ip4_str);
 
    /* Get gateway address */
    cy_wcm_get_gateway_ip_address(CY_WCM_INTERFACE_TYPE_STA, &gateway_addr);
    nw_ipv4.ip.v4 = gateway_addr.ip.v4;
    cy_nw_ntoa(&nw_ipv4, ip4_str);
    printf("IPV4 address: %s\n", ip4_str);
 
    cy_rtos_delay_milliseconds(2000);
 
    printf("Pinging to gateway IP address ... \n");
 
    /* Send PING request with 3000ms ping timeout */
    result = cy_wcm_ping(CY_WCM_INTERFACE_TYPE_STA, &gateway_addr, 3000, &elapsed_time_ms);
    if( result == CY_RSLT_SUCCESS)
    {
        printf("ping was successful time elapsed = %u\n", (uint8_t)elapsed_time_ms);
    }
    else
    {
        printf("Ping failed !!\n");
    }
 
}

Snippet 7: SoftAP start-stop

The following snippet demonstrates SoftAP start and stop.

 
#define WIFI_SSID_AP                      "AnyCloud"
#define WIFI_KEY_AP                       "abcd@9009"
 
static cy_wcm_ip_setting_t ap_mode_ip_settings;
 
static void ap_event_cb(cy_wcm_event_t event, cy_wcm_event_data_t *event_data)
{
    char ip4_str[16];
    cy_nw_ip_address_t nw_ipv4;
    
    printf("######### Received event changed from wcm, event = %d #######\n", event);
    switch(event)
    {
        case CY_WCM_EVENT_DISCONNECTED:
        {
            printf("Network is down! \n");
            break;
        }
        case CY_WCM_EVENT_RECONNECTED:
        {
            printf("Network is up again! \n");
            break;
        }
        case CY_WCM_EVENT_CONNECTING:
        {
            printf("Connecting to AP ... \n");
            break;
        }
        case CY_WCM_EVENT_CONNECTED:
        {
            printf("Connected to AP and network is up !! \n");
            break;
        }
        case CY_WCM_EVENT_CONNECT_FAILED:
        {
            printf("Connection to AP Failed ! \n");
            break;
        }
        case CY_WCM_EVENT_IP_CHANGED:
        {
            cy_wcm_ip_address_t ip_addr;
            cy_wcm_get_ip_addr(CY_WCM_INTERFACE_TYPE_STA, &ip_addr);
 
            if(event_data->ip_addr.version == CY_WCM_IP_VER_V4)
            {
                nw_ipv4.ip.v4 = event_data->ip_addr.ip.v4;
                cy_nw_ntoa(&nw_ipv4, ip4_str);
                printf("IPV4 address: %s\n", ip4_str);
            }
            break;
        }
        case CY_WCM_EVENT_STA_JOINED_SOFTAP:
        {
            printf("mac address of the STA which joined = %02X : %02X : %02X : %02X : %02X : %02X \n",
                    event_data->sta_mac[0], event_data->sta_mac[1], event_data->sta_mac[2],
                    event_data->sta_mac[3], event_data->sta_mac[4], event_data->sta_mac[5]);
            break;
        }
        case CY_WCM_EVENT_STA_LEFT_SOFTAP:
        {
            printf("mac address of the STA which left = %02X : %02X : %02X : %02X : %02X : %02X \n",
                    event_data->sta_mac[0], event_data->sta_mac[1], event_data->sta_mac[2],
                    event_data->sta_mac[3], event_data->sta_mac[4], event_data->sta_mac[5]);
            break;
        }
        default:
        {
            printf("Invalid event \n");
            break;
        }        
    }
}
 
void snippet_wcm_ap_start_stop()
{
    cy_rslt_t result;
    char ip6_str[40];
    char ip4_str[16];
    char *ip = "192.168.0.2";
    char *netmask = "255.255.255.0";
    char *gateway = "192.168.0.2";
    cy_nw_ip_address_t nw_ipv4;
    cy_nw_ip_address_t nw_ipv6;
    
    cy_wcm_config_t config;
    cy_wcm_ap_config_t ap_conf;
    cy_wcm_ip_address_t ipv6_addr;
 
    /* Initialize the Wi-Fi device, Wi-Fi transport, and lwIP network stack.*/
    config.interface = CY_WCM_INTERFACE_TYPE_AP;
    result = cy_wcm_init(&config);
    if(result != CY_RSLT_SUCCESS)
    {
        printf("\ncy_wcm_init failed...!\n");
        return;
    }
 
    /* AP settings */
    cy_wcm_set_ap_ip_setting(&ap_mode_ip_settings, ip, netmask, gateway, CY_WCM_IP_VER_V4);
    
    memset(&ap_conf, 0, sizeof(cy_wcm_ap_config_t));
    ap_conf.channel = 1;
    memcpy(ap_conf.ap_credentials.SSID, WIFI_SSID_AP, strlen(WIFI_SSID_AP) + 1);
    memcpy(ap_conf.ap_credentials.password, WIFI_KEY_AP, strlen(WIFI_KEY_AP) + 1);
    ap_conf.ap_credentials.security = CY_WCM_SECURITY_WPA2_AES_PSK;
 
    ap_conf.ip_settings.ip_address = ap_mode_ip_settings.ip_address;
    ap_conf.ip_settings.netmask = ap_mode_ip_settings.netmask;
    ap_conf.ip_settings.gateway = ap_mode_ip_settings.gateway;
 
    printf("configured ip address of the AP = %u \n", (uint8_t)ap_conf.ip_settings.ip_address.ip.v4);
    nw_ipv4.ip.v4 = ap_conf.ip_settings.ip_address.ip.v4;
    cy_nw_ntoa(&nw_ipv4, ip4_str);
    printf("IPV4 address: %s\n", ip4_str);
 
    /* Start AP */
    result = cy_wcm_start_ap(&ap_conf);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\ncy_wcm_start_ap failed....! \n");
        return;
    }
 
    /* Register AP event callback */
    result = cy_wcm_register_event_callback(&ap_event_cb);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\ncy_wcm_register_event_callback failed....! \n");
        return;
    }
 
    /* Link Local IPV6 AP address for AP */
    result = cy_wcm_get_ipv6_addr(CY_WCM_INTERFACE_TYPE_AP, CY_WCM_IPV6_LINK_LOCAL, &ipv6_addr);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\ncy_wcm_get_ipv6_addr failed....! \n");
        return;
    }
    nw_ipv6.ip.v6[0] = ipv6_addr.ip.v6[0];
    nw_ipv6.ip.v6[1] = ipv6_addr.ip.v6[1];
    nw_ipv6.ip.v6[2] = ipv6_addr.ip.v6[2];
    nw_ipv6.ip.v6[3] = ipv6_addr.ip.v6[3];
    cy_nw_ntoa_ipv6(&nw_ipv6, ip6_str);
    printf("IPV6 address: %s\n", ip6_str);
 
    /* wait for 30 seconds to check whether AP is visible or not */
    cy_rtos_delay_milliseconds(30000);
 
    /* Stop AP */
    result = cy_wcm_stop_ap();
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\ncy_wcm_stop_ap failed....! \n");
    }
    return;
}
 

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.

 
#define WIFI_SSID_AP                      "AnyCloud"
#define WIFI_KEY_AP                       "abcd@9009"
 
static cy_wcm_ip_setting_t ap_ip_settings;
 
static void ap_eve_callback(cy_wcm_event_t event, cy_wcm_event_data_t *event_data)
{
    char ip4_str[16];
    cy_nw_ip_address_t nw_ipv4;
    
    printf("######### Received event changed from wcm, event = %d #######\n", event);
    switch(event)
    {
        case CY_WCM_EVENT_DISCONNECTED:
        {
            printf("Network is down! \n");
            break;
        }
        case CY_WCM_EVENT_RECONNECTED:
        {
            printf("Network is up again! \n");
            break;
        }
        case CY_WCM_EVENT_CONNECTING:
        {
            printf("Connecting to AP ... \n");
            break;
        }
        case CY_WCM_EVENT_CONNECTED:
        {
            printf("Connected to AP and network is up !! \n");
            break;
        }
        case CY_WCM_EVENT_CONNECT_FAILED:
        {
            printf("Connection to AP Failed ! \n");
            break;
        }
        case CY_WCM_EVENT_IP_CHANGED:
        {
            cy_wcm_ip_address_t ip_addr;
            cy_wcm_get_ip_addr(CY_WCM_INTERFACE_TYPE_STA, &ip_addr);
 
            if(event_data->ip_addr.version == CY_WCM_IP_VER_V4)
            {
                nw_ipv4.ip.v4 = event_data->ip_addr.ip.v4;
                cy_nw_ntoa(&nw_ipv4, ip4_str);
                printf("IPV4 address: %s\n", ip4_str);
            }
            break;
        }
        case CY_WCM_EVENT_STA_JOINED_SOFTAP:
        {
            printf("mac address of the STA which joined = %02X : %02X : %02X : %02X : %02X : %02X \n",
                    event_data->sta_mac[0], event_data->sta_mac[1], event_data->sta_mac[2],
                    event_data->sta_mac[3], event_data->sta_mac[4], event_data->sta_mac[5]);
            break;
        }
        case CY_WCM_EVENT_STA_LEFT_SOFTAP:
        {
            printf("mac address of the STA which left = %02X : %02X : %02X : %02X : %02X : %02X \n",
                    event_data->sta_mac[0], event_data->sta_mac[1], event_data->sta_mac[2],
                    event_data->sta_mac[3], event_data->sta_mac[4], event_data->sta_mac[5]);
            break;
        }
        default:
        {
            printf("Invalid event \n");
            break;
        }        
    }
}
 
void snippet_wcm_ap_get_client()
{
    cy_rslt_t result;
    char ip6_str[40];
    char ip4_str[16];
    char *ip = "192.168.0.2";
    char *netmask = "255.255.255.0";
    char *gateway = "192.168.0.2";
    cy_nw_ip_address_t nw_ipv6;
    cy_nw_ip_address_t nw_ipv4;
    
    cy_wcm_config_t config;
    cy_wcm_ap_config_t ap_conf;
    cy_wcm_ip_address_t ipv6_addr;
 
    /* Initialize the Wi-Fi device, Wi-Fi transport, and lwIP network stack.*/
    config.interface = CY_WCM_INTERFACE_TYPE_AP;
    result = cy_wcm_init(&config);
    if(result != CY_RSLT_SUCCESS)
    {
        printf("\ncy_wcm_init failed...!\n");
        return;
    }
 
    /* AP settings */
    cy_wcm_set_ap_ip_setting(&ap_ip_settings, ip, netmask, gateway, CY_WCM_IP_VER_V4);
    
    memset(&ap_conf, 0, sizeof(cy_wcm_ap_config_t));
    ap_conf.channel = 1;
    memcpy(ap_conf.ap_credentials.SSID, WIFI_SSID_AP, strlen(WIFI_SSID_AP) + 1);
    memcpy(ap_conf.ap_credentials.password, WIFI_KEY_AP, strlen(WIFI_KEY_AP) + 1);
    ap_conf.ap_credentials.security = CY_WCM_SECURITY_WPA2_AES_PSK;
 
    ap_conf.ip_settings.ip_address = ap_ip_settings.ip_address;
    ap_conf.ip_settings.netmask = ap_ip_settings.netmask;
    ap_conf.ip_settings.gateway = ap_ip_settings.gateway;
 
    printf("configured ip address of the AP = %u \n", (uint8_t)ap_conf.ip_settings.ip_address.ip.v4);
    nw_ipv4.ip.v4 = ap_conf.ip_settings.ip_address.ip.v4;
    cy_nw_ntoa(&nw_ipv4, ip4_str);
    printf("IPV4 address: %s\n", ip4_str);
 
    /* Start AP */
    result = cy_wcm_start_ap(&ap_conf);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\ncy_wcm_start_ap failed....! \n");
        return;
    }
 
    /* Register AP event callback */
    result = cy_wcm_register_event_callback(&ap_eve_callback);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\ncy_wcm_register_event_callback failed....! \n");
        return;
    }
 
    /* Link Local IPV6 AP address for AP */
    result = cy_wcm_get_ipv6_addr(CY_WCM_INTERFACE_TYPE_AP, CY_WCM_IPV6_LINK_LOCAL, &ipv6_addr);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\ncy_wcm_get_ipv6_addr failed....! \n");
        return;
    }
 
    nw_ipv6.ip.v6[0] = ipv6_addr.ip.v6[0];
    nw_ipv6.ip.v6[1] = ipv6_addr.ip.v6[1];
    nw_ipv6.ip.v6[2] = ipv6_addr.ip.v6[2];
    nw_ipv6.ip.v6[3] = ipv6_addr.ip.v6[3];
    cy_nw_ntoa_ipv6(&nw_ipv6, ip6_str);
    printf("IPV6 address: %s\n", ip6_str);
 
    /* wait for 30 seconds for a client to connect */
    cy_rtos_delay_milliseconds(30000);
 
    /* get connected client */
    cy_wcm_mac_t mac_add;
    result = cy_wcm_get_associated_client_list(&mac_add, 1);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\ncy_wcm_get_associated_client_list failed....! \n");
        return;
    }
    printf("mac address obtained from cy_wcm_get_associated_client_list = %02X : %02X : %02X : %02X : %02X : %02X \n",
            mac_add[0], mac_add[1], mac_add[2],mac_add[3], mac_add[4], mac_add[5]);
 
    return;
 
}
 

Snippet 9: AP+STA concurrent mode

The following snippet demonstrates AP+STA concurrent mode operation.

 
/* Wi-Fi Credentials: Modify WIFI_SSID and WIFI_PASSWORD to match your Wi-Fi network
 * credentials.
 */
#define WIFI_SSID                           "SSID"
#define WIFI_PASSWORD                       "PASSWORD"
#define WIFI_SSID_AP                        "AnyCloud"
#define WIFI_KEY_AP                         "abcd@9009"
 
#define MAX_WIFI_RETRY_COUNT                (3u)
#define WIFI_CONN_RETRY_INTERVAL_MSEC       (100u)
 
/* The size of the cy_wcm_ip_address_t array that is passed to
 * cy_wcm_get_ip_addr API. In the case of stand-alone AP or STA mode, the size of
 * the array is 1. In concurrent AP/STA mode, the size of the array is 2 where
 * the first index stores the IP address of the STA and the second index
 * stores the IP address of the AP.
 */
 
static cy_wcm_ip_setting_t ap_sta_mode_ip_settings;
 
void sta_event_callback(cy_wcm_event_t event, cy_wcm_event_data_t *event_data)
{
    if (CY_WCM_EVENT_DISCONNECTED == event)
    {
        printf("Disconnected from Wi-Fi\n");
    }
    else if (CY_WCM_EVENT_RECONNECTED == event)
    {
        printf("Reconnected to Wi-Fi.\n");
    }
    /* This event corresponds to the event when the IP address of the device
     * changes.
     */
    else if (CY_WCM_EVENT_IP_CHANGED == event)
    {
        cy_wcm_ip_address_t ip_addr;
        cy_wcm_get_ip_addr(CY_WCM_INTERFACE_TYPE_STA, &ip_addr);
 
        if (event_data->ip_addr.version == CY_WCM_IP_VER_V4)
        {
            printf("IP Address: %d.%d.%d.%d\n", (uint8_t)event_data->ip_addr.ip.v4,
                   (uint8_t)(event_data->ip_addr.ip.v4 >> 8), (uint8_t)(event_data->ip_addr.ip.v4 >> 16),
                   (uint8_t)(event_data->ip_addr.ip.v4 >> 24));
        }
        else if(event_data->ip_addr.version == CY_WCM_IP_VER_V6)
        {
            printf("IP Address: %X:%X:%X:%X\n", (uint8_t)event_data->ip_addr.ip.v6[0],
                   (uint8_t)(event_data->ip_addr.ip.v6[1]), (uint8_t)(event_data->ip_addr.ip.v6[2]),
                   (uint8_t)(event_data->ip_addr.ip.v6[3]));
        }
    }
}
 
static void ap_event_callback(cy_wcm_event_t event, cy_wcm_event_data_t *event_data)
{
    char ip4_str[16];
    cy_nw_ip_address_t nw_ipv4;
    
    printf("######### Received event changed from wcm, event = %d #######\n", event);
    switch(event)
    {
        case CY_WCM_EVENT_DISCONNECTED:
        {
            printf("Network is down! \n");
            break;
        }
        case CY_WCM_EVENT_RECONNECTED:
        {
            printf("Network is up again! \n");
            break;
        }
        case CY_WCM_EVENT_CONNECTING:
        {
            printf("Connecting to AP ... \n");
            break;
        }
        case CY_WCM_EVENT_CONNECTED:
        {
            printf("Connected to AP and network is up !! \n");
            break;
        }
        case CY_WCM_EVENT_CONNECT_FAILED:
        {
            printf("Connection to AP Failed ! \n");
            break;
        }
        case CY_WCM_EVENT_IP_CHANGED:
        {
            cy_wcm_ip_address_t ip_addr;
            cy_wcm_get_ip_addr(CY_WCM_INTERFACE_TYPE_STA, &ip_addr);
 
            if(event_data->ip_addr.version == CY_WCM_IP_VER_V4)
            {
                nw_ipv4.ip.v4 = event_data->ip_addr.ip.v4;
                cy_nw_ntoa(&nw_ipv4, ip4_str);
                printf("IPV4 address: %s\n", ip4_str);
            }
            break;
        }
        case CY_WCM_EVENT_STA_JOINED_SOFTAP:
        {
            printf("mac address of the STA which joined = %02X : %02X : %02X : %02X : %02X : %02X \n",
                    event_data->sta_mac[0], event_data->sta_mac[1], event_data->sta_mac[2],
                    event_data->sta_mac[3], event_data->sta_mac[4], event_data->sta_mac[5]);
            break;
        }
        case CY_WCM_EVENT_STA_LEFT_SOFTAP:
        {
            printf("mac address of the STA which left = %02X : %02X : %02X : %02X : %02X : %02X \n",
                    event_data->sta_mac[0], event_data->sta_mac[1], event_data->sta_mac[2],
                    event_data->sta_mac[3], event_data->sta_mac[4], event_data->sta_mac[5]);
            break;
        } 
        default:
        {
            printf("Invalid event \n");
            break;
        }
    }
}
 
void snippet_wcm_concurrent_mode()
{
    cy_rslt_t result;
    char ip6_str[40];
    char ip4_str[16];
    char *ip = "192.168.0.2";
    char *netmask = "255.255.255.0";
    char *gateway = "192.168.0.2";
    cy_nw_ip_address_t nw_ipv4;
    cy_nw_ip_address_t nw_ipv6;
 
    /* Initialize the Wi-Fi device as a STA.*/
    cy_wcm_config_t config = {.interface = CY_WCM_INTERFACE_TYPE_AP_STA};
    cy_wcm_ap_config_t ap_conf;
    cy_wcm_connect_params_t connect_param;
    cy_wcm_ip_address_t ip_address,ipv4_addr,ipv6_addr;
    cy_wcm_security_t security;
 
    memset(&connect_param, 0, sizeof(cy_wcm_connect_params_t));
    memset(&ip_address, 0, sizeof(cy_wcm_ip_address_t));
    memset(&security, 0, sizeof(cy_wcm_security_t));
    memcpy(connect_param.ap_credentials.SSID, WIFI_SSID, sizeof(WIFI_SSID));
    memcpy(connect_param.ap_credentials.password, WIFI_PASSWORD, sizeof(WIFI_PASSWORD));
    connect_param.ap_credentials.security = security;
 
    /* Initialize the Wi-Fi device, Wi-Fi transport, and lwIP network stack.*/
    result = cy_wcm_init(&config);
    if(result != CY_RSLT_SUCCESS)
    {
        printf("\ncy_wcm_init failed...!\n");
        return;
    }
 
    /* AP settings */
    cy_wcm_set_ap_ip_setting(&ap_sta_mode_ip_settings, ip, netmask, gateway, CY_WCM_IP_VER_V4);
    
    printf("\n*** Starting STA Mode ***\n");
    /* Attempt to connect to Wi-Fi until a connection is made or
     * MAX_WIFI_RETRY_COUNT attempts have been made.
     */
    for (uint32_t conn_retries = 0; conn_retries < MAX_WIFI_RETRY_COUNT; conn_retries++)
    {
        result = cy_wcm_connect_ap(&connect_param, &ip_address);
        if (result == CY_RSLT_SUCCESS)
        {
            printf("Successfully connected to Wi-Fi network '%s'.\n", connect_param.ap_credentials.SSID);
 
            /* Register event callbacks for changes in the Wi-Fi link status. These
             * events could be related to IP address changes, connection, and
             * disconnection events.
             */
            cy_wcm_register_event_callback(sta_event_callback);
            break;
        }
 
        printf("Connection to Wi-Fi network failed with error code %d."
                "Retrying in %d ms...\n", (int)result, WIFI_CONN_RETRY_INTERVAL_MSEC);
 
        cy_rtos_delay_milliseconds(WIFI_CONN_RETRY_INTERVAL_MSEC);
    }
 
    printf("\n*** Starting AP Mode ***\n");
    memset(&ap_conf, 0, sizeof(cy_wcm_ap_config_t));
    memset(&ipv4_addr, 0, sizeof(cy_wcm_ip_address_t));
    memset(&ipv6_addr, 0, sizeof(cy_wcm_ip_address_t));
 
    ap_conf.channel = 1;
    memcpy(ap_conf.ap_credentials.SSID, WIFI_SSID_AP, strlen(WIFI_SSID_AP) + 1);
    memcpy(ap_conf.ap_credentials.password, WIFI_KEY_AP, strlen(WIFI_KEY_AP) + 1);
    ap_conf.ap_credentials.security = CY_WCM_SECURITY_WPA2_AES_PSK;
 
    ap_conf.ip_settings.ip_address = ap_sta_mode_ip_settings.ip_address;
    ap_conf.ip_settings.netmask = ap_sta_mode_ip_settings.netmask;
    ap_conf.ip_settings.gateway = ap_sta_mode_ip_settings.gateway;
 
    printf("configured ip address of the AP = %u \n", (uint8_t)ap_conf.ip_settings.ip_address.ip.v4);
    nw_ipv4.ip.v4 = ap_conf.ip_settings.ip_address.ip.v4;
    cy_nw_ntoa(&nw_ipv4, ip4_str);
    printf("IPV4 address: %s\n", ip4_str);
    cy_wcm_register_event_callback(&ap_event_callback);
    result = cy_wcm_start_ap(&ap_conf);
    if (result != CY_RSLT_SUCCESS)
    {
        printf("\ncy_wcm_start_ap failed...! \n");
        return;
    }
    printf("\nAP started successfully... \n");
 
    /* Get IPV4 address for AP */
    result = cy_wcm_get_ip_addr(CY_WCM_INTERFACE_TYPE_AP, &ipv4_addr);
    if (result != CY_RSLT_SUCCESS)
    {
        printf("\ncy_wcm_get_ip_addr failed...! \n");
        return;
    }
    printf("\nIPV4 address of AP : ");
    nw_ipv4.ip.v4 = ipv4_addr.ip.v4;
    cy_nw_ntoa(&nw_ipv4, ip4_str);
    printf("IPV4 address: %s\n", ip4_str);
 
    /* Get IPV6 address for AP */
    printf("Link Local IPV6 AP address \n");
    result = cy_wcm_get_ipv6_addr(CY_WCM_INTERFACE_TYPE_AP, CY_WCM_IPV6_LINK_LOCAL, &ipv6_addr);
    if (result != CY_RSLT_SUCCESS)
    {
        printf("\ncy_wcm_get_ipv6_addr failed...! \n");
        return;
    }
    printf("\nLink Local IPV6 AP address : ");
    nw_ipv6.ip.v6[0] = ipv6_addr.ip.v6[0];
    nw_ipv6.ip.v6[1] = ipv6_addr.ip.v6[1];
    nw_ipv6.ip.v6[2] = ipv6_addr.ip.v6[2];
    nw_ipv6.ip.v6[3] = ipv6_addr.ip.v6[3];
    cy_nw_ntoa_ipv6(&nw_ipv6, ip6_str);
    printf("IPV6 address: %s\n", ip6_str);
 
    /* Get Link Local IPV6 STA address */
    result = cy_wcm_get_ipv6_addr(CY_WCM_INTERFACE_TYPE_STA, CY_WCM_IPV6_LINK_LOCAL, &ipv6_addr);
    if (result != CY_RSLT_SUCCESS)
    {
        printf("\ncy_wcm_get_ipv6_addr failed...! \n");
        return;
    }
    printf("\nLink Local IPV6 STA address : ");
    nw_ipv6.ip.v6[0] = ipv6_addr.ip.v6[0];
    nw_ipv6.ip.v6[1] = ipv6_addr.ip.v6[1];
    nw_ipv6.ip.v6[2] = ipv6_addr.ip.v6[2];
    nw_ipv6.ip.v6[3] = ipv6_addr.ip.v6[3];
    cy_nw_ntoa_ipv6(&nw_ipv6, ip6_str);
    printf("IPV6 address: %s\n", ip6_str);
 
    /* Get MAC address of both STA and AP interface using CY_WCM_INTERFACE_TYPE_AP_STA */
    cy_wcm_mac_t *mac_addr_ptr;
    mac_addr_ptr = (cy_wcm_mac_t*)malloc(sizeof(cy_wcm_mac_t) *2);
    cy_wcm_get_mac_addr(CY_WCM_INTERFACE_TYPE_AP_STA, mac_addr_ptr);
    cy_wcm_mac_t sta_mac, ap_mac;
    memcpy(&sta_mac, mac_addr_ptr, sizeof(sta_mac));
    printf("mac address of STA = %02X : %02X : %02X : %02X : %02X : %02X \n",
            sta_mac[0], sta_mac[1], sta_mac[2],sta_mac[3], sta_mac[4], sta_mac[5]);
    memcpy(&ap_mac, &mac_addr_ptr[1], sizeof(ap_mac));
    printf("mac address AP = %02X : %02X : %02X : %02X : %02X : %02X \n",
            ap_mac[0], ap_mac[1], ap_mac[2],ap_mac[3], ap_mac[4], ap_mac[5]);
    free(mac_addr_ptr);
}
 

Snippet 10: Virtual API usage to check connection status from the secondary core

The following snippet demonstrates the usage of virtual WCM API - cy_wcm_is_connected_to_ap() in a multi-core environment.

 
/***************************** Secondary core ***************************/
 
/* Flag to be set when VCM initialization is completed on the other core */
static bool is_vcm_init_complete = false;
 
/* Callback registered on the secondary core to handle events from VCM. */
void vcm_callback_sec_core(cy_vcm_event_t event)
{
    switch(event)
    {
        case CY_VCM_EVENT_INIT_COMPLETE:
        {
            /* VCM init complete */
            is_vcm_init_complete = 1;
            break;
        }
        default:
            break;
    }
}
 
/* The following snippet demostrates usage of VCM and virtual WCM APIs from the secondary core. 
 * The primary core is where the full WCM implementation is present. The secondary core only
 * has the virtual implementation.
 * In this example, the secondary core application runs first and it enables the primary core.
 * Before enabling the primary core, the secondary core initializes the VCM library.
 */
void snippet_wcm_virtual_api_usage_sec_core()
{
    cy_rslt_t result;
    cy_vcm_config_t vcm_config;
 
    /* Initialize the VCM library */
    vcm_config.hal_resource_opt = CY_VCM_CREATE_HAL_RESOURCE; /* set to CY_VCM_CREATE_HAL_RESOURCE as the secondary core is the first one to initialize VCM. */
    vcm_config.channel_num = CYHAL_IPC_CHAN_0;
    vcm_config.event_cb = vcm_callback_sec_core;
    result = cy_vcm_init(&vcm_config);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_vcm_init failed! \n");
        return;
    }
 
    /* Enable the other core. 
     * For example, for enabling CM4, the following code is applicable. 
     * When this is called, the application on core 2 will begin executing. Ensure cy_vcm_init()
     * is called on the second core when the execution begins.
     */
    Cy_SysEnableCM4(CY_CORTEX_M4_APPL_ADDR);
    
    /* Wait for VCM initialization to complete */
    while ( !is_vcm_init_complete )
    {
        cy_rtos_delay_milliseconds(1000);
    }
 
    /* Initialize the WCM library */
    result = cy_wcm_init(NULL);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_wcm_init failed on secondary core! \n");
        return;
    }
 
    /* Check if the device is connected to an AP using the below virtual API */
    uint8_t is_connected = cy_wcm_is_connected_to_ap();
 
    printf("\n STA connection status: %u\n", is_connected);
 
    /* ... */
 
    /* When WCM virtual APIs are no longer needed on the secondary core, deinit WCM and VCM */
    result = cy_wcm_deinit();
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_wcm_deinit failed on secondary core! \n");
        return;
    }
 
    result = cy_vcm_deinit();
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_vcm_deinit failed on secondary core! \n");
        return;
    }
}
 
/***************************** Primary Core *****************************/
 
/* Wi-Fi Credentials: Modify WIFI_AP_SSID and WIFI_AP_PASSWORD to match your Wi-Fi network
 * credentials.
 */
#define WIFI_AP_SSID                           "SSID"
#define WIFI_AP_PASSWORD                       "PASSWORD"
 
/* Flag that is set when VCM deinit is started by the other core. 
 * When this event is received, call cy_vcm_deinit() to deinitialize VCM
 * on the current core.
 */
static bool is_vcm_deinit_requested = false;
 
/* Callback registered by the application on primary core to handle events from VCM. */
void vcm_callback_prim_core(cy_vcm_event_t event)
{
    switch(event)
    {
        case CY_VCM_EVENT_DEINIT:
        {
            /* The other core has initiated VCM deinit. Deinitialize VCM locally. */
            is_vcm_deinit_requested = true;
            break;
        }
        default:
            break;
    }
}
 
/* The following snippet demostrates usage of VCM on the primary core. 
 * The primary core is where the full WCM implementation is present. The secondary core only
 * has the virtual implementation. The primary core initializes wcm and connects to an AP.
 * Ensure that this snippet is executed when the primary core is enabled.
 */
void snippet_wcm_virtual_api_usage_prim_core()
{
    cy_rslt_t result;
    cy_vcm_config_t vcm_config;
    cy_wcm_config_t wcm_config;
    cy_wcm_connect_params_t connect_params;
    cy_wcm_ip_address_t ip_addr;
 
    /* Initialize the VCM library */
    vcm_config.hal_resource_opt = CY_VCM_USE_HAL_RESOURCE; /* set to CY_VCM_USE_HAL_RESOURCE as primary core initializes VCM after the secondary core. */
    vcm_config.channel_num = CYHAL_IPC_CHAN_0;
    vcm_config.event_cb = vcm_callback_prim_core;
    result = cy_vcm_init(&vcm_config);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_vcm_init failed on primary core! \n");
        return;
    }
 
    /* Initialize the WCM library */
    wcm_config.interface = CY_WCM_INTERFACE_TYPE_STA;
    result = cy_wcm_init(&wcm_config);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_wcm_init failed on primary core! \n");
        return;
    }
 
    /* Connect to Wi-Fi */
    memset(&connect_params, 0, sizeof(cy_wcm_connect_params_t));
    memcpy(connect_params.ap_credentials.SSID, WIFI_AP_SSID, strlen(WIFI_AP_SSID) + 1);
    memcpy(connect_params.ap_credentials.password, WIFI_AP_PASSWORD, strlen(WIFI_AP_PASSWORD) + 1);
    connect_params.ap_credentials.security = CY_WCM_SECURITY_WPA2_AES_PSK;
 
    result = cy_wcm_connect_ap(&connect_params, &ip_addr);
    if(result == CY_RSLT_SUCCESS)
    {
        printf("Connect successful!\n");
    }
 
    /* Wait for VCM deinit on the other core. When deinit event is received,
     * deinitialize the VCM library on this core. */
    while( !is_vcm_deinit_requested )
    {
        cy_rtos_delay_milliseconds(1000);
    }
    
    /* VCM deinit event received. */
    result = cy_vcm_deinit();
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_vcm_deinit failed on primary core! \n");
        return;
    }
 
    /* If WCM is no longer needed, deinitialize WCM. */
    result = cy_wcm_deinit();
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_wcm_deinit failed on primary core! \n");
        return;
    }
}
 

Snippet 11: Virtual API usage to register for WCM events from the secondary core

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.

 
/***************************** Secondary core ***************************/
 
/* Flag to be set when VCM initialization is completed on the other core */
static bool is_vcm_init_complete_2 = false;
 
/* Callback registered on the secondary core to handle events from VCM. */
void vcm_callback_sec_core_2(cy_vcm_event_t event)
{
    switch(event)
    {
        case CY_VCM_EVENT_INIT_COMPLETE:
        {
            /* VCM init complete */
            is_vcm_init_complete_2 = 1;
            break;
        }
        default:
            break;
    }
}
 
void event_callback_sec_core_2(cy_wcm_event_t event, cy_wcm_event_data_t *event_data)
{
    if (CY_WCM_EVENT_DISCONNECTED == event)
    {
        printf("Disconnected from Wi-Fi\n");
    }
    else if (CY_WCM_EVENT_RECONNECTED == event)
    {
        printf("Reconnected to Wi-Fi.\n");
    }
    /* This event corresponds to the event when the IP address of the device
     * changes.
     */
    else if (CY_WCM_EVENT_IP_CHANGED == event)
    {
        cy_wcm_ip_address_t ip_addr;
        cy_wcm_get_ip_addr(CY_WCM_INTERFACE_TYPE_STA, &ip_addr);
 
        if (event_data->ip_addr.version == CY_WCM_IP_VER_V4)
        {
            printf("IP Address: %d.%d.%d.%d\n", (uint8_t)event_data->ip_addr.ip.v4,
                   (uint8_t)(event_data->ip_addr.ip.v4 >> 8), (uint8_t)(event_data->ip_addr.ip.v4 >> 16),
                   (uint8_t)(event_data->ip_addr.ip.v4 >> 24));
        }
        else if(event_data->ip_addr.version == CY_WCM_IP_VER_V6)
        {
            printf("IP Address: %X:%X:%X:%X\n", (uint8_t)event_data->ip_addr.ip.v6[0],
                   (uint8_t)(event_data->ip_addr.ip.v6[1]), (uint8_t)(event_data->ip_addr.ip.v6[2]),
                   (uint8_t)(event_data->ip_addr.ip.v6[3]));
        }
    }
    else if (CY_WCM_EVENT_CONNECTING == event)
    {
        printf("Connecting to Wi-Fi.\n");
    }
    else if (CY_WCM_EVENT_CONNECTED == event)
    {
        printf("Connected to Wi-Fi.\n");
    }
    else if (CY_WCM_EVENT_CONNECT_FAILED == event)
    {
        printf("Failed to connect to Wi-Fi.\n");
    }
}
 
/* The following snippet demostrates usage of VCM and virtual WCM APIs from the secondary core. 
 * The primary core is where the full WCM implementation is present. The secondary core only
 * has the virtual implementation.
 * In this example, the secondary core application runs first and it enables the primary core.
 * Before enabling the primary core, the secondary core initializes VCM library.
 */
void snippet_wcm_virtual_api_usage_sec_core_2()
{
    cy_rslt_t result;
    cy_vcm_config_t vcm_config;
 
    /* Initialize the VCM library */
    vcm_config.hal_resource_opt = CY_VCM_CREATE_HAL_RESOURCE; /* set to CY_VCM_CREATE_HAL_RESOURCE as the secondary core is the first one to initialize VCM. */
    vcm_config.channel_num = CYHAL_IPC_CHAN_0;
    vcm_config.event_cb = vcm_callback_sec_core_2;
    result = cy_vcm_init(&vcm_config);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_vcm_init failed! \n");
        return;
    }
 
    /* Enable the other core. 
     * For example, for enabling CM4, the following code is applicable. 
     * When this is called, the application on core 2 will begin executing. Ensure cy_vcm_init()
     * is called on the second core when the execution begins.
     */
    Cy_SysEnableCM4(CY_CORTEX_M4_APPL_ADDR);
    
    /* Wait for VCM initialization to complete */
    while ( !is_vcm_init_complete )
    {
        cy_rtos_delay_milliseconds(1000);
    }
 
    /* Initialize the WCM library */
    result = cy_wcm_init(NULL);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_wcm_init failed on secondary core! \n");
        return;
    }
 
    /* Listen for changes in the AP connection by registering event callback */
    result = cy_wcm_register_event_callback(event_callback_sec_core_2);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_wcm_register_event_callback failed on secondary core! \n");
        return;
    }
 
    /* ... */
 
    /* When no longer needed, deregister callback for WCM events */
    result = cy_wcm_deregister_event_callback(event_callback_sec_core_2);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_wcm_deregister_event_callback failed on secondary core! \n");
        return;
    }
 
    /* When WCM virtual APIs are no longer needed on the secondary core, deinit WCM and VCM */
    result = cy_wcm_deinit();
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_wcm_deinit failed on secondary core! \n");
        return;
    }
 
    result = cy_vcm_deinit();
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_vcm_deinit failed on secondary core! \n");
        return;
    }
}
 
/***************************** Primary Core *****************************/
 
/* Wi-Fi Credentials: Modify WIFI_AP_SSID and WIFI_AP_PASSWORD to match your Wi-Fi network
 * credentials.
 */
#define WIFI_AP_SSID                           "SSID"
#define WIFI_AP_PASSWORD                       "PASSWORD"
 
/* Flag that is set when VCM deinit is started by the other core. 
 * When this event is received, call cy_vcm_deinit() to deinitialize VCM
 * on the current core.
 */
static bool is_vcm_deinit_requested_2 = false;
 
/* Callback registered by the application on primary core to handle events from VCM. */
void vcm_callback_prim_core_2(cy_vcm_event_t event)
{
    switch(event)
    {
        case CY_VCM_EVENT_DEINIT:
        {
            /* The other core has initiated VCM deinit. Deinitialize VCM locally. */
            is_vcm_deinit_requested_2 = true;
            break;
        }
        default:
            break;
    }
}
 
/* The following snippet demostrates usage of VCM on the primary core. 
 * The primary core is where the full WCM implementation is present. The secondary core only
 * has the virtual implementation. The primary core initializes wcm and connects to an AP.
 * Ensure that this snippet is executed when the primary core is enabled.
 */
void snippet_wcm_virtual_api_usage_prim_core_2()
{
    cy_rslt_t result;
    cy_vcm_config_t vcm_config;
    cy_wcm_config_t wcm_config;
    cy_wcm_connect_params_t connect_params;
    cy_wcm_ip_address_t ip_addr;
 
    /* Initialize the VCM library */
    vcm_config.hal_resource_opt = CY_VCM_USE_HAL_RESOURCE; /* set to CY_VCM_USE_HAL_RESOURCE as primary core initializes VCM after the secondary core. */
    vcm_config.channel_num = CYHAL_IPC_CHAN_0;
    vcm_config.event_cb = vcm_callback_prim_core_2;
    result = cy_vcm_init(&vcm_config);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_vcm_init failed on primary core! \n");
        return;
    }
 
    /* Initialize the WCM library */
    wcm_config.interface = CY_WCM_INTERFACE_TYPE_STA;
    result = cy_wcm_init(&wcm_config);
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_wcm_init failed on primary core! \n");
        return;
    }
 
    /* Connect to Wi-Fi */
    memset(&connect_params, 0, sizeof(cy_wcm_connect_params_t));
    memcpy(connect_params.ap_credentials.SSID, WIFI_AP_SSID, strlen(WIFI_AP_SSID) + 1);
    memcpy(connect_params.ap_credentials.password, WIFI_AP_PASSWORD, strlen(WIFI_AP_PASSWORD) + 1);
    connect_params.ap_credentials.security = CY_WCM_SECURITY_WPA2_AES_PSK;
 
    result = cy_wcm_connect_ap(&connect_params, &ip_addr);
    if(result == CY_RSLT_SUCCESS)
    {
        printf("Connect successful!\n");
    }
 
    /* Wait for VCM deinit on the other core. When deinit event is received,
     * deinitialize the VCM library on this core. */
    while( !is_vcm_deinit_requested_2 )
    {
        cy_rtos_delay_milliseconds(1000);
    }
    
    /* VCM deinit event received. */
    result = cy_vcm_deinit();
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_vcm_deinit failed on primary core! \n");
        return;
    }
 
    /* If WCM is no longer needed, deinitialize WCM. */
    result = cy_wcm_deinit();
    if( result != CY_RSLT_SUCCESS )
    {
        printf("\n cy_wcm_deinit failed on primary core! \n");
        return;
    }
}