src/include/platform/internal/GenericConnectivityManagerImpl_WiFi.h

   1 /*
   2  *
   3  *    Copyright (c) 2020-2021 Project CHIP Authors
   4  *
   5  *    Licensed under the Apache License, Version 2.0 (the "License");
   6  *    you may not use this file except in compliance with the License.
   7  *    You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *    Unless required by applicable law or agreed to in writing, software
  12  *    distributed under the License is distributed on an "AS IS" BASIS,
  13  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *    See the License for the specific language governing permissions and
  15  *    limitations under the License.
  16  */
  17
  18 /**
  19  *    @file
  20  *          Provides an generic implementation of ConnectivityManager features
  21  *          for use on platforms that support WiFi.
  22  */
  23
  24 #pragma once
  25
  26 #include <platform/ConnectivityManager.h>
  27 #include <platform/internal/DeviceNetworkInfo.h>
  28 #include <support/logging/CHIPLogging.h>
  29
  30 namespace chip {
  31 namespace DeviceLayer {
  32 namespace Internal {
  33
  34 /**
  35  * Provides a generic implementation of WiFi-specific ConnectivityManager features for
  36  * platforms that don't support WiFi.
  37  *
  38  * This class is intended to be inherited (directly or indirectly) by the ConnectivityManagerImpl
  39  * class, which also appears as the template's ImplClass parameter.
  40  *
  41  * The members of this class are all inlined methods that do nothing, and return static return
  42  * values.  This allows the compiler to optimize away dead code without the use of \#ifdef's.
  43  * For example:
  44  *
  45  * ```
  46  * if (ConnectivityMgr().GetWiFiStationMode() != ConnectivityManager::kWiFiStationMode_NotSupported)
  47  * {
  48  *     // ... do something on devices that support WiFi ...
  49  * }
  50  * ```
  51  */
  52 template <class ImplClass>
  53 class GenericConnectivityManagerImpl_WiFi
  54 {
  55 public:
  56     // ===== Methods that implement the ConnectivityManager abstract interface.
  57
  58     ConnectivityManager::WiFiStationMode _GetWiFiStationMode();
  59     CHIP_ERROR _SetWiFiStationMode(ConnectivityManager::WiFiStationMode val);
  60     bool _IsWiFiStationEnabled();
  61     bool _IsWiFiStationApplicationControlled();
  62     uint32_t _GetWiFiStationReconnectIntervalMS();
  63     CHIP_ERROR _SetWiFiStationReconnectIntervalMS(uint32_t val);
  64     bool _IsWiFiStationProvisioned();
  65     void _ClearWiFiStationProvision();
  66     ConnectivityManager::WiFiAPMode _GetWiFiAPMode();
  67     CHIP_ERROR _SetWiFiAPMode(ConnectivityManager::WiFiAPMode val);
  68     bool _IsWiFiAPActive();
  69     bool _IsWiFiAPApplicationControlled();
  70     void _DemandStartWiFiAP();
  71     void _StopOnDemandWiFiAP();
  72     void _MaintainOnDemandWiFiAP();
  73     uint32_t _GetWiFiAPIdleTimeoutMS();
  74     void _SetWiFiAPIdleTimeoutMS(uint32_t val);
  75     CHIP_ERROR _GetAndLogWifiStatsCounters();
  76     bool _CanStartWiFiScan();
  77     void _OnWiFiScanDone();
  78     void _OnWiFiStationProvisionChange();
  79     static const char * _WiFiStationModeToStr(ConnectivityManager::WiFiStationMode mode);
  80     static const char * _WiFiAPModeToStr(ConnectivityManager::WiFiAPMode mode);
  81     static const char * _WiFiStationStateToStr(ConnectivityManager::WiFiStationState state);
  82     static const char * _WiFiAPStateToStr(ConnectivityManager::WiFiAPState state);
  83
  84 protected:
  85     enum class ConnectivityFlags : uint16_t
  86     {
  87         kHaveIPv4InternetConnectivity = 0x0001,
  88         kHaveIPv6InternetConnectivity = 0x0002,
  89         kAwaitingConnectivity         = 0x0010,
  90     };
  91
  92 private:
  93     ImplClass * Impl() { return static_cast<ImplClass *>(this); }
  94 };
  95
  96 template <class ImplClass>
  97 inline uint32_t GenericConnectivityManagerImpl_WiFi<ImplClass>::_GetWiFiStationReconnectIntervalMS()
  98 {
  99     return 0;
 100 }
 101
 102 template <class ImplClass>
 103 inline CHIP_ERROR GenericConnectivityManagerImpl_WiFi<ImplClass>::_SetWiFiStationReconnectIntervalMS(uint32_t val)
 104 {
 105     return CHIP_ERROR_UNSUPPORTED_CHIP_FEATURE;
 106 }
 107
 108 template <class ImplClass>
 109 inline bool GenericConnectivityManagerImpl_WiFi<ImplClass>::_IsWiFiStationProvisioned()
 110 {
 111     return false;
 112 }
 113
 114 template <class ImplClass>
 115 inline void GenericConnectivityManagerImpl_WiFi<ImplClass>::_ClearWiFiStationProvision()
 116 {}
 117
 118 template <class ImplClass>
 119 inline ConnectivityManager::WiFiAPMode GenericConnectivityManagerImpl_WiFi<ImplClass>::_GetWiFiAPMode()
 120 {
 121     return ConnectivityManager::kWiFiAPMode_NotSupported;
 122 }
 123
 124 template <class ImplClass>
 125 inline CHIP_ERROR GenericConnectivityManagerImpl_WiFi<ImplClass>::_SetWiFiAPMode(ConnectivityManager::WiFiAPMode val)
 126 {
 127     return CHIP_ERROR_UNSUPPORTED_CHIP_FEATURE;
 128 }
 129
 130 template <class ImplClass>
 131 inline bool GenericConnectivityManagerImpl_WiFi<ImplClass>::_IsWiFiAPActive()
 132 {
 133     return false;
 134 }
 135
 136 template <class ImplClass>
 137 inline bool GenericConnectivityManagerImpl_WiFi<ImplClass>::_IsWiFiAPApplicationControlled()
 138 {
 139     return false;
 140 }
 141
 142 template <class ImplClass>
 143 inline void GenericConnectivityManagerImpl_WiFi<ImplClass>::_DemandStartWiFiAP()
 144 {}
 145
 146 template <class ImplClass>
 147 inline void GenericConnectivityManagerImpl_WiFi<ImplClass>::_StopOnDemandWiFiAP()
 148 {}
 149
 150 template <class ImplClass>
 151 inline void GenericConnectivityManagerImpl_WiFi<ImplClass>::_MaintainOnDemandWiFiAP()
 152 {}
 153
 154 template <class ImplClass>
 155 inline uint32_t GenericConnectivityManagerImpl_WiFi<ImplClass>::_GetWiFiAPIdleTimeoutMS()
 156 {
 157     return 0;
 158 }
 159
 160 template <class ImplClass>
 161 inline void GenericConnectivityManagerImpl_WiFi<ImplClass>::_SetWiFiAPIdleTimeoutMS(uint32_t val)
 162 {}
 163
 164 template <class ImplClass>
 165 inline CHIP_ERROR GenericConnectivityManagerImpl_WiFi<ImplClass>::_GetAndLogWifiStatsCounters()
 166 {
 167     return CHIP_ERROR_UNSUPPORTED_CHIP_FEATURE;
 168 }
 169
 170 template <class ImplClass>
 171 inline bool GenericConnectivityManagerImpl_WiFi<ImplClass>::_CanStartWiFiScan()
 172 {
 173     return false;
 174 }
 175
 176 template <class ImplClass>
 177 inline void GenericConnectivityManagerImpl_WiFi<ImplClass>::_OnWiFiScanDone()
 178 {}
 179
 180 template <class ImplClass>
 181 inline void GenericConnectivityManagerImpl_WiFi<ImplClass>::_OnWiFiStationProvisionChange()
 182 {}
 183
 184 } // namespace Internal
 185 } // namespace DeviceLayer
 186 } // namespace chip