mbed-os/connectivity/drivers/emac/TARGET_RDA_EMAC/RdaWiFiInterface.h

/* LWIP implementation of NetworkInterfaceAPI
 * Copyright (c) 2019 Unisoc Communications Inc.
 * 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.
 */

#ifndef RDA_WIFI_INTERFACE_H
#define RDA_WIFI_INTERFACE_H

#include "nsapi.h"
#include "rtos.h"
#include "EMACInterface.h"
#include "WiFiInterface.h"


/** RDAWiFiInterface class
 *  Implementation of the NetworkStack for an EMAC-based Ethernet driver
 */
class RDAWiFiInterface : public EMACInterface, public WiFiInterface
{
    public:
        /** Create an EMAC-based ethernet interface.
         *
         * The default arguments obtain the default EMAC, which will be target-
         * dependent (and the target may have some JSON option to choose which
         * is the default, if there are multiple). The default stack is configured
         * by JSON option nsapi.default-stack.
         *
         * Due to inability to return errors from the constructor, no real
         * work is done until the first call to connect().
         *
         * @param emac  Reference to EMAC to use
         * @param stack Reference to onboard-network stack to use
         */
        RDAWiFiInterface(
                EMAC &emac = EMAC::get_default_instance(),
                OnboardNetworkStack &stack = OnboardNetworkStack::get_default_instance()) : EMACInterface(emac, stack) {
                _ssid[0] = '\0';
                _pass[0] = '\0';
                _channel = 0;
                _security = NSAPI_SECURITY_NONE;
        }

        //static RDAWiFiInterface *get_target_default_instance();
        
        /** Set the WiFi network credentials
         *
         *  @param ssid      Name of the network to connect to
         *  @param pass      Security passphrase to connect to the network
         *  @param security  Type of encryption for connection
         *                   (defaults to NSAPI_SECURITY_NONE)
         *  @return          0 on success, or error code on failure
         */
        virtual nsapi_error_t set_credentials(const char *ssid, const char *pass,
                nsapi_security_t security = NSAPI_SECURITY_NONE);

        /** Set the WiFi network channel
         *
         *  @param channel   Channel on which the connection is to be made, or 0 for any (Default: 0)
         *  @return          0 on success, or error code on failure
         */
        virtual nsapi_error_t set_channel(uint8_t channel);

        /** Gets the current radio signal strength for active connection
         *
         *  @return         Connection strength in dBm (negative value),
         *                  or 0 if measurement impossible
         */
        virtual int8_t get_rssi();

        /** Start the interface
         *
         *  Attempts to connect to a WiFi network.
         *
         *  @param ssid      Name of the network to connect to
         *  @param pass      Security passphrase to connect to the network
         *  @param security  Type of encryption for connection (Default: NSAPI_SECURITY_NONE)
         *  @param channel   Channel on which the connection is to be made, or 0 for any (Default: 0)
         *  @return          0 on success, or error code on failure
         */
        virtual nsapi_error_t connect(const char *ssid, const char *pass,
                nsapi_security_t security = NSAPI_SECURITY_NONE, uint8_t channel = 0);

        /** Start the interface
         *
         *  Attempts to connect to a WiFi network. Requires ssid and passphrase to be set.
         *  If passphrase is invalid, NSAPI_ERROR_AUTH_ERROR is returned.
         *
         *  @return         0 on success, negative error code on failure
         */
        virtual nsapi_error_t connect();

        /** Stop the interface
         *
         *  @return         0 on success, or error code on failure
         */
        virtual nsapi_error_t disconnect();

        /** Restart the interface
        *
        *  Attempts to reconnect to a WiFi network. Ssid and passphrase has been stored.
        *
        *  @return         0 on success, negative error code on failure
        */
        virtual nsapi_error_t reconnect();

        /** Scan for available networks
         *
         *  This function will block. If the @a count is 0, function will only return count of available networks, so that
         *  user can allocated necessary memory. If the \p count is grater than 0 and the a \p res is not NULL it'll be populated
         *  with discovered networks up to value of \p count.
         *
         *  @param  res      Pointer to allocated array to store discovered AP
         *  @param  count    Size of allocated @a res array, or 0 to only count available AP
         *  @return          Number of entries in \p count, or if \p count was 0 number of available networks,
         *                   negative on error see @a nsapi_error
         */
        virtual nsapi_size_or_error_t scan(WiFiAccessPoint *res, nsapi_size_t count);

        virtual nsapi_size_or_error_t init();

        virtual nsapi_size_or_error_t set_msg_queue(void *queue);

    private:
        char _ssid[33];
        char _pass[65];
		uint8_t _channel;
        nsapi_security_t _security;    
            

};

#endif