mbed-os/connectivity/drivers/emac/COMPONENT_WHD/interface/whd_emac.cpp

/*
 * Copyright (c) 2018-2019 ARM Limited
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <ctype.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>

#include "cmsis_os.h"
#include "whd_emac.h"
#include "lwip/etharp.h"
#include "lwip/ethip6.h"
#include "events/mbed_shared_queues.h"
#include "whd_wlioctl.h"
#include "whd_buffer_api.h"
#include "wiced_resource.h"
#include "cybsp_wifi.h"
#include "emac_eapol.h"
#include "cy_result.h"

#if defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE
#include "cy_ext_wifi_fw_reserved_region_bd.h"
#endif /* defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE */

#define NULL_MAC(a)  ( ( ( ( (unsigned char *)a )[0] ) == 0 ) && \
                       ( ( ( (unsigned char *)a )[1] ) == 0 ) && \
                       ( ( ( (unsigned char *)a )[2] ) == 0 ) && \
                       ( ( ( (unsigned char *)a )[3] ) == 0 ) && \
                       ( ( ( (unsigned char *)a )[4] ) == 0 ) && \
                       ( ( ( (unsigned char *)a )[5] ) == 0 ) )

extern "C"
{
    eapol_packet_handler_t emac_eapol_packet_handler = NULL;
    void whd_emac_wifi_link_state_changed(whd_interface_t ifp, whd_bool_t state_up);
} // extern "C"

WHD_EMAC::WHD_EMAC(whd_interface_role_t role, const uint8_t *mac_addr)
    : interface_type(role)
{
    if (mac_addr) {
        set_hwaddr(mac_addr);
    }
}

WHD_EMAC &WHD_EMAC::get_instance(whd_interface_role_t role, const uint8_t *mac_addr)
{
    static WHD_EMAC emac_sta(WHD_STA_ROLE, mac_addr);
    static WHD_EMAC emac_ap(WHD_AP_ROLE, mac_addr);
    return role == WHD_AP_ROLE ? emac_ap : emac_sta;
}

uint32_t WHD_EMAC::get_mtu_size() const
{
    return WHD_PAYLOAD_MTU;
}

uint32_t WHD_EMAC::get_align_preference() const
{
    return 0;
}

void WHD_EMAC::add_multicast_group(const uint8_t *addr)
{
    memcpy(multicast_addr.octet, addr, sizeof(multicast_addr.octet));
    whd_wifi_register_multicast_address(ifp, &multicast_addr);
}

void WHD_EMAC::remove_multicast_group(const uint8_t *addr)
{
    whd_wifi_unregister_multicast_address(ifp, &multicast_addr);
}

void WHD_EMAC::set_all_multicast(bool all)
{
    /* No-op at this stage */
}

void WHD_EMAC::power_down()
{
    if (powered_up) {
        powered_up = false;
        whd_wifi_off(ifp);
        whd_deinit(ifp);
    }
}

bool WHD_EMAC::power_up()
{
    if (!powered_up) {
        cy_rslt_t res = CY_RSLT_SUCCESS;
        if (ap_sta_concur && interface_type == WHD_AP_ROLE) {
            WHD_EMAC &emac_prime = WHD_EMAC::get_instance(WHD_STA_ROLE);
            if (NULL_MAC(unicast_addr.octet)) {
                emac_prime.get_hwaddr(unicast_addr.octet);
                // Generated mac will set locally administered bit 1 of first byte
                unicast_addr.octet[0] |= (1 << 1);
            }
            // Note: This assumes that the primary interface initializes the
            // wifi driver and turns on the wifi chip.
            res = cybsp_wifi_init_secondary(&ifp /* Out */, &unicast_addr);
        } else {
            WHD_EMAC &emac_other = WHD_EMAC::get_instance(interface_type == WHD_STA_ROLE ? WHD_AP_ROLE :
                                                          WHD_STA_ROLE);
            if (!emac_other.powered_up) {
#if defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE
                CyReservedRegionBlockDevice *reserved_region_bd = cy_get_ext_wifi_fw_reserved_region_bd();
                reserved_region_bd->init();

                extern whd_resource_source_t cy_ext_wifi_fw_resource_ops;
                res = cybsp_wifi_init_primary_extended(&ifp /* OUT */, &cy_ext_wifi_fw_resource_ops, NULL, NULL);

                reserved_region_bd->deinit();
#else
                res = cybsp_wifi_init_primary(&ifp /* OUT */);
#endif /* defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE */
            } else {
                ifp = emac_other.ifp;
            }
        }

        if (CY_RSLT_SUCCESS == res) {
            drvp = cybsp_get_wifi_driver();
            powered_up = true;
            if (link_state && emac_link_state_cb) {
                emac_link_state_cb(link_state);
            }
        } else {
            return false;
        }
    }
    return true;
}

bool WHD_EMAC::get_hwaddr(uint8_t *addr) const
{
    if (!NULL_MAC(unicast_addr.octet)) {
        memcpy(addr, unicast_addr.octet, sizeof(unicast_addr.octet));
    } else {
        whd_mac_t mac;
        whd_result_t res = whd_wifi_get_mac_address(ifp, &mac);
        MBED_ASSERT(res == WHD_SUCCESS);
        memcpy(addr, mac.octet, sizeof(mac.octet));
    }
    return true;
}

void WHD_EMAC::set_hwaddr(const uint8_t *addr)
{
    memcpy(unicast_addr.octet, addr, sizeof(unicast_addr.octet));
}

uint8_t WHD_EMAC::get_hwaddr_size() const
{
    whd_mac_t mac;
    return sizeof(mac.octet);
}

void WHD_EMAC::set_link_input_cb(emac_link_input_cb_t input_cb)
{
    emac_link_input_cb = input_cb;
}

void WHD_EMAC::set_link_state_cb(emac_link_state_change_cb_t state_cb)
{
    emac_link_state_cb = state_cb;
}

void WHD_EMAC::set_memory_manager(EMACMemoryManager &mem_mngr)
{
    memory_manager = &mem_mngr;
}

bool WHD_EMAC::link_out(emac_mem_buf_t *buf)
{
    uint16_t offset = 64;
    whd_buffer_t buffer;

    uint16_t size = memory_manager->get_total_len(buf);

    whd_result_t res = whd_host_buffer_get(drvp, &buffer, WHD_NETWORK_TX, size + offset, WHD_TRUE);
    if (res != WHD_SUCCESS) {
        memory_manager->free(buf);
        return true;
    }
    MBED_ASSERT(res == WHD_SUCCESS);

    whd_buffer_add_remove_at_front(drvp, &buffer, offset);

    void *dest = whd_buffer_get_current_piece_data_pointer(drvp, buffer);
    memory_manager->copy_from_buf(dest, size, buf);

    if (activity_cb) {
        activity_cb(true);
    }
    whd_network_send_ethernet_data(ifp, buffer);
    memory_manager->free(buf);
    return true;
}

void WHD_EMAC::get_ifname(char *name, uint8_t size) const
{
    switch (interface_type) {
        case WHD_STA_ROLE:
            memcpy(name, "st", size);
            break;
        case WHD_AP_ROLE:
            memcpy(name, "ap", size);
            break;
        default:
            memcpy(name, "wh", size);
    }
}

void WHD_EMAC::set_activity_cb(mbed::Callback<void(bool)> cb)
{
    activity_cb = cb;
}

extern "C"
{

    static void emac_receive_eapol_packet(whd_interface_t interface, whd_buffer_t buffer)
    {
        if (buffer != NULL) {
            if (emac_eapol_packet_handler != NULL) {

                emac_eapol_packet_handler(interface, buffer);
            } else {
                whd_buffer_release(interface->whd_driver, buffer, WHD_NETWORK_RX);
            }
        }
    }

    whd_result_t emac_register_eapol_packet_handler(eapol_packet_handler_t eapol_packet_handler)
    {

        if (emac_eapol_packet_handler == NULL) {
            emac_eapol_packet_handler = eapol_packet_handler;
            return WHD_SUCCESS;
        }

        return WHD_HANDLER_ALREADY_REGISTERED;
    }

    void emac_unregister_eapol_packet_handler(void)
    {
        emac_eapol_packet_handler = NULL;
    }

    void cy_network_process_ethernet_data(whd_interface_t ifp, whd_buffer_t buffer)
    {
        emac_mem_buf_t *mem_buf = NULL;

        WHD_EMAC &emac = WHD_EMAC::get_instance(ifp->role);

        if (!emac.powered_up || !emac.emac_link_input_cb) {
            // ignore any trailing packets
            whd_buffer_release(emac.drvp, buffer, WHD_NETWORK_RX);
            return;
        }

        uint8_t *data = whd_buffer_get_current_piece_data_pointer(emac.drvp, buffer);

        uint16_t size = whd_buffer_get_current_piece_size(emac.drvp, buffer);


        if (size > WHD_ETHERNET_SIZE) {

            uint16_t ethertype;

            ethertype = (uint16_t)(data[12] << 8 | data[13]);

            if (ethertype == EAPOL_PACKET_TYPE) {

                /* pass it to the EAP layer, but do not release the packet */
                emac_receive_eapol_packet(ifp, buffer);

            } else {
                mem_buf = buffer;
                if (emac.activity_cb) {
                    emac.activity_cb(false);
                }
                emac.emac_link_input_cb(mem_buf);
            }
        }
    }

    void whd_emac_wifi_link_state_changed(whd_interface_t ifp, whd_bool_t state_up)
    {
        WHD_EMAC &emac = WHD_EMAC::get_instance(ifp->role);

        emac.link_state = state_up;
        if (emac.emac_link_state_cb) {
            emac.emac_link_state_cb(state_up);
        }
    }

#if defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE
    resource_result_t platform_read_external_resource(const resource_hnd_t *resource, uint32_t offset, uint32_t maxsize, uint32_t *size, void *buffer)
    {
        CyReservedRegionBlockDevice *bd = cy_get_ext_wifi_fw_reserved_region_bd();
        int status = bd->reserved_read(buffer, (mbed::bd_addr_t) resource->val.external_storage_context + offset, *size);
        return (status == 0) ? RESOURCE_SUCCESS : RESOURCE_FILE_READ_FAIL;
    }
#endif /* defined(CY_EXT_WIFI_FW_STORAGE) && !MBED_CONF_TARGET_XIP_ENABLE */

} // extern "C"