/* * * Copyright (c) 2021 Project CHIP Authors * * 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. */ #pragma once #include #include using chip::BitFlags; using chip::app::Clusters::NetworkCommissioning::WiFiSecurityBitmap; namespace chip { namespace DeviceLayer { namespace NetworkCommissioning { namespace { inline constexpr uint8_t kMaxWiFiNetworks = 1; inline constexpr uint8_t kWiFiScanNetworksTimeOutSeconds = 10; inline constexpr uint8_t kWiFiConnectNetworkTimeoutSeconds = 30; } // namespace BitFlags ConvertSecurityType(wifi_auth_mode_t authMode); class ESPScanResponseIterator : public Iterator { public: ESPScanResponseIterator(const size_t size, const wifi_ap_record_t * scanResults) : mSize(size), mpScanResults(scanResults) {} size_t Count() override { return mSize; } bool Next(WiFiScanResponse & item) override { if (mIternum >= mSize) { return false; } item.security = ConvertSecurityType(mpScanResults[mIternum].authmode); static_assert(chip::DeviceLayer::Internal::kMaxWiFiSSIDLength <= UINT8_MAX, "SSID length might not fit in item.ssidLen"); item.ssidLen = static_cast( strnlen(reinterpret_cast(mpScanResults[mIternum].ssid), chip::DeviceLayer::Internal::kMaxWiFiSSIDLength)); item.channel = mpScanResults[mIternum].primary; item.wiFiBand = chip::DeviceLayer::NetworkCommissioning::WiFiBand::k2g4; item.rssi = mpScanResults[mIternum].rssi; memcpy(item.ssid, mpScanResults[mIternum].ssid, item.ssidLen); memcpy(item.bssid, mpScanResults[mIternum].bssid, 6); mIternum++; return true; } void Release() override {} private: const size_t mSize; const wifi_ap_record_t * mpScanResults; size_t mIternum = 0; }; class ESPWiFiDriver final : public WiFiDriver { public: class WiFiNetworkIterator final : public NetworkIterator { public: WiFiNetworkIterator(ESPWiFiDriver * aDriver) : mDriver(aDriver) {} size_t Count() override; bool Next(Network & item) override; void Release() override { delete this; } ~WiFiNetworkIterator() = default; private: ESPWiFiDriver * mDriver; bool mExhausted = false; }; struct WiFiNetwork { char ssid[DeviceLayer::Internal::kMaxWiFiSSIDLength]; uint8_t ssidLen = 0; char credentials[DeviceLayer::Internal::kMaxWiFiKeyLength]; uint8_t credentialsLen = 0; }; // BaseDriver NetworkIterator * GetNetworks() override { return new WiFiNetworkIterator(this); } CHIP_ERROR Init(NetworkStatusChangeCallback * networkStatusChangeCallback) override; void Shutdown() override; // WirelessDriver uint8_t GetMaxNetworks() override { return kMaxWiFiNetworks; } uint8_t GetScanNetworkTimeoutSeconds() override { return kWiFiScanNetworksTimeOutSeconds; } uint8_t GetConnectNetworkTimeoutSeconds() override { return kWiFiConnectNetworkTimeoutSeconds; } CHIP_ERROR CommitConfiguration() override; CHIP_ERROR RevertConfiguration() override; Status RemoveNetwork(ByteSpan networkId, MutableCharSpan & outDebugText, uint8_t & outNetworkIndex) override; Status ReorderNetwork(ByteSpan networkId, uint8_t index, MutableCharSpan & outDebugText) override; void ConnectNetwork(ByteSpan networkId, ConnectCallback * callback) override; #if CHIP_DEVICE_CONFIG_SUPPORTS_CONCURRENT_CONNECTION CHIP_ERROR DisconnectFromNetwork() override; #endif // WiFiDriver Status AddOrUpdateNetwork(ByteSpan ssid, ByteSpan credentials, MutableCharSpan & outDebugText, uint8_t & outNetworkIndex) override; void ScanNetworks(ByteSpan ssid, ScanCallback * callback) override; uint32_t GetSupportedWiFiBandsMask() const override; CHIP_ERROR ConnectWiFiNetwork(const char * ssid, uint8_t ssidLen, const char * key, uint8_t keyLen); void OnConnectWiFiNetwork(); void OnConnectWiFiNetworkFailed(); static void OnConnectWiFiNetworkFailed(chip::System::Layer * aLayer, void * aAppState); void OnScanWiFiNetworkDone(); void OnNetworkStatusChange(); CHIP_ERROR SetLastDisconnectReason(const ChipDeviceEvent * event); uint16_t GetLastDisconnectReason(); static ESPWiFiDriver & GetInstance() { static ESPWiFiDriver instance; return instance; } private: bool NetworkMatch(const WiFiNetwork & network, ByteSpan networkId); CHIP_ERROR StartScanWiFiNetworks(ByteSpan ssid); CHIP_ERROR BackupConfiguration(); WiFiNetwork mStagingNetwork; ScanCallback * mpScanCallback; ConnectCallback * mpConnectCallback; NetworkStatusChangeCallback * mpStatusChangeCallback = nullptr; uint16_t mLastDisconnectedReason; }; class ESPEthernetDriver : public EthernetDriver { public: class EthernetNetworkIterator final : public NetworkIterator { public: EthernetNetworkIterator(ESPEthernetDriver * aDriver) : mDriver(aDriver) {} size_t Count() { return 1; } bool Next(Network & item) override { if (exhausted) { return false; } exhausted = true; memcpy(item.networkID, interfaceName, interfaceNameLen); item.networkIDLen = interfaceNameLen; item.connected = true; return true; } void Release() override { delete this; } ~EthernetNetworkIterator() = default; uint8_t interfaceName[kMaxNetworkIDLen]; uint8_t interfaceNameLen = 0; bool exhausted = false; private: ESPEthernetDriver * mDriver; }; // BaseDriver NetworkIterator * GetNetworks() override { return new EthernetNetworkIterator(this); } uint8_t GetMaxNetworks() { return 1; } CHIP_ERROR Init(NetworkStatusChangeCallback * networkStatusChangeCallback) override; void Shutdown() { // TODO: This method can be implemented if Ethernet is used along with Wifi/Thread. } static ESPEthernetDriver & GetInstance() { static ESPEthernetDriver instance; return instance; } }; } // namespace NetworkCommissioning } // namespace DeviceLayer } // namespace chip