[controller] allows polymorphism of the controller

src/agent/CMakeLists.txt

@@ -33,6 +33,10 @@ add_executable(otbr-agent
     vendor.hpp
 )
 
+target_link_libraries(openthread-radio-spinel INTERFACE
+    openthread-spinel-rcp
+)
+
 target_link_libraries(otbr-agent PRIVATE
     $<$<BOOL:${OTBR_BORDER_AGENT}>:otbr-border-agent>
     $<$<BOOL:${OTBR_BACKBONE_ROUTER}>:otbr-backbone-router>

src/agent/application.cpp

@@ -60,98 +60,40 @@ Application::Application(const std::string               &aInterfaceName,
 #else
     , mBackboneInterfaceName(aBackboneInterfaceNames.empty() ? "" : aBackboneInterfaceNames.front())
 #endif
+    , mHost(Ncp::ThreadController::Create(mInterfaceName.c_str(),
+                                          aRadioUrls,
+                                          mBackboneInterfaceName,
+                                          /* aDryRun */ false,
+                                          aEnableAutoAttach))
 #if OTBR_ENABLE_MDNS
     , mPublisher(Mdns::Publisher::Create([this](Mdns::Publisher::State aState) { this->HandleMdnsState(aState); }))
 #endif
 #if OTBR_ENABLE_VENDOR_SERVER
     , mVendorServer(vendor::VendorServer::newInstance(*this))
 #endif
 {
-    mHost = MakeUnique<Ncp::RcpHost>(mInterfaceName.c_str(), aRadioUrls, mBackboneInterfaceName,
-                                     /* aDryRun */ false, aEnableAutoAttach);
-
-#if OTBR_ENABLE_BORDER_AGENT
-    mBorderAgent = MakeUnique<BorderAgent>(*mHost, *mPublisher);
-#endif
-#if OTBR_ENABLE_BACKBONE_ROUTER
-    mBackboneAgent = MakeUnique<BackboneRouter::BackboneAgent>(*mHost, aInterfaceName, mBackboneInterfaceName);
-#endif
-#if OTBR_ENABLE_SRP_ADVERTISING_PROXY
-    mAdvertisingProxy = MakeUnique<AdvertisingProxy>(*mHost, *mPublisher);
-#endif
-#if OTBR_ENABLE_DNSSD_DISCOVERY_PROXY
-    mDiscoveryProxy = MakeUnique<Dnssd::DiscoveryProxy>(*mHost, *mPublisher);
-#endif
-#if OTBR_ENABLE_TREL
-    mTrelDnssd = MakeUnique<TrelDnssd::TrelDnssd>(*mHost, *mPublisher);
-#endif
-#if OTBR_ENABLE_OPENWRT
-    mUbusAgent = MakeUnique<ubus::UBusAgent>(*mHost);
-#endif
-#if OTBR_ENABLE_REST_SERVER
-    mRestWebServer = MakeUnique<rest::RestWebServer>(*mHost, aRestListenAddress, aRestListenPort);
-#endif
-#if OTBR_ENABLE_DBUS_SERVER && OTBR_ENABLE_BORDER_AGENT
-    mDBusAgent = MakeUnique<DBus::DBusAgent>(*mHost, *mPublisher);
-#endif
-
-    OT_UNUSED_VARIABLE(aRestListenAddress);
-    OT_UNUSED_VARIABLE(aRestListenPort);
+    if (mHost->GetCoprocessorType() == OT_COPROCESSOR_RCP)
+    {
+        CreateRcpMode(aRestListenAddress, aRestListenPort);
+    }
 }
 
 void Application::Init(void)
 {
     mHost->Init();
 
-#if OTBR_ENABLE_MDNS
-    mPublisher->Start();
-#endif
-#if OTBR_ENABLE_BORDER_AGENT
-// This is for delaying publishing the MeshCoP service until the correct
-// vendor name and OUI etc. are correctly set by BorderAgent::SetMeshCopServiceValues()
-#if OTBR_STOP_BORDER_AGENT_ON_INIT
-    mBorderAgent->SetEnabled(false);
-#else
-    mBorderAgent->SetEnabled(true);
-#endif
-#endif
-#if OTBR_ENABLE_BACKBONE_ROUTER
-    mBackboneAgent->Init();
-#endif
-#if OTBR_ENABLE_SRP_ADVERTISING_PROXY
-    mAdvertisingProxy->SetEnabled(true);
-#endif
-#if OTBR_ENABLE_DNSSD_DISCOVERY_PROXY
-    mDiscoveryProxy->SetEnabled(true);
-#endif
-#if OTBR_ENABLE_OPENWRT
-    mUbusAgent->Init();
-#endif
-#if OTBR_ENABLE_REST_SERVER
-    mRestWebServer->Init();
-#endif
-#if OTBR_ENABLE_DBUS_SERVER
-    mDBusAgent->Init();
-#endif
-#if OTBR_ENABLE_VENDOR_SERVER
-    mVendorServer->Init();
-#endif
+    if (mHost->GetCoprocessorType() == OT_COPROCESSOR_RCP)
+    {
+        InitRcpMode();
+    }
 }
 
 void Application::Deinit(void)
 {
-#if OTBR_ENABLE_SRP_ADVERTISING_PROXY
-    mAdvertisingProxy->SetEnabled(false);
-#endif
-#if OTBR_ENABLE_DNSSD_DISCOVERY_PROXY
-    mDiscoveryProxy->SetEnabled(false);
-#endif
-#if OTBR_ENABLE_BORDER_AGENT
-    mBorderAgent->SetEnabled(false);
-#endif
-#if OTBR_ENABLE_MDNS
-    mPublisher->Stop();
-#endif
+    if (mHost->GetCoprocessorType() == OT_COPROCESSOR_RCP)
+    {
+        DeinitRcpMode();
+    }
 
     mHost->Deinit();
 }
@@ -255,4 +197,89 @@ void Application::HandleSignal(int aSignal)
     signal(aSignal, SIG_DFL);
 }
 
+void Application::CreateRcpMode(const std::string &aRestListenAddress, int aRestListenPort)
+{
+    otbr::Ncp::RcpHost &rcpHost = static_cast<otbr::Ncp::RcpHost &>(*mHost);
+#if OTBR_ENABLE_BORDER_AGENT
+    mBorderAgent = MakeUnique<BorderAgent>(rcpHost, *mPublisher);
+#endif
+#if OTBR_ENABLE_BACKBONE_ROUTER
+    mBackboneAgent = MakeUnique<BackboneRouter::BackboneAgent>(rcpHost, mInterfaceName, mBackboneInterfaceName);
+#endif
+#if OTBR_ENABLE_SRP_ADVERTISING_PROXY
+    mAdvertisingProxy = MakeUnique<AdvertisingProxy>(rcpHost, *mPublisher);
+#endif
+#if OTBR_ENABLE_DNSSD_DISCOVERY_PROXY
+    mDiscoveryProxy = MakeUnique<Dnssd::DiscoveryProxy>(rcpHost, *mPublisher);
+#endif
+#if OTBR_ENABLE_TREL
+    mTrelDnssd = MakeUnique<TrelDnssd::TrelDnssd>(rcpHost, *mPublisher);
+#endif
+#if OTBR_ENABLE_OPENWRT
+    mUbusAgent = MakeUnique<ubus::UBusAgent>(rcpHost);
+#endif
+#if OTBR_ENABLE_REST_SERVER
+    mRestWebServer = MakeUnique<rest::RestWebServer>(rcpHost, aRestListenAddress, aRestListenPort);
+#endif
+#if OTBR_ENABLE_DBUS_SERVER && OTBR_ENABLE_BORDER_AGENT
+    mDBusAgent = MakeUnique<DBus::DBusAgent>(rcpHost, *mPublisher);
+#endif
+
+    OT_UNUSED_VARIABLE(aRestListenAddress);
+    OT_UNUSED_VARIABLE(aRestListenPort);
+}
+
+void Application::InitRcpMode(void)
+{
+#if OTBR_ENABLE_MDNS
+    mPublisher->Start();
+#endif
+#if OTBR_ENABLE_BORDER_AGENT
+// This is for delaying publishing the MeshCoP service until the correct
+// vendor name and OUI etc. are correctly set by BorderAgent::SetMeshCopServiceValues()
+#if OTBR_STOP_BORDER_AGENT_ON_INIT
+    mBorderAgent->SetEnabled(false);
+#else
+    mBorderAgent->SetEnabled(true);
+#endif
+#endif
+#if OTBR_ENABLE_BACKBONE_ROUTER
+    mBackboneAgent->Init();
+#endif
+#if OTBR_ENABLE_SRP_ADVERTISING_PROXY
+    mAdvertisingProxy->SetEnabled(true);
+#endif
+#if OTBR_ENABLE_DNSSD_DISCOVERY_PROXY
+    mDiscoveryProxy->SetEnabled(true);
+#endif
+#if OTBR_ENABLE_OPENWRT
+    mUbusAgent->Init();
+#endif
+#if OTBR_ENABLE_REST_SERVER
+    mRestWebServer->Init();
+#endif
+#if OTBR_ENABLE_DBUS_SERVER
+    mDBusAgent->Init();
+#endif
+#if OTBR_ENABLE_VENDOR_SERVER
+    mVendorServer->Init();
+#endif
+}
+
+void Application::DeinitRcpMode(void)
+{
+#if OTBR_ENABLE_SRP_ADVERTISING_PROXY
+    mAdvertisingProxy->SetEnabled(false);
+#endif
+#if OTBR_ENABLE_DNSSD_DISCOVERY_PROXY
+    mDiscoveryProxy->SetEnabled(false);
+#endif
+#if OTBR_ENABLE_BORDER_AGENT
+    mBorderAgent->SetEnabled(false);
+#endif
+#if OTBR_ENABLE_MDNS
+    mPublisher->Stop();
+#endif
+}
+
 } // namespace otbr

src/agent/application.hpp

@@ -132,7 +132,7 @@ class Application : private NonCopyable
      *
      * @returns The OpenThread controller object.
      */
-    Ncp::RcpHost &GetNcp(void) { return *mHost; }
+    Ncp::ThreadController &GetHost(void) { return *mHost; }
 
 #if OTBR_ENABLE_MDNS
     /**
@@ -256,12 +256,16 @@ class Application : private NonCopyable
 
     static void HandleSignal(int aSignal);
 
+    void CreateRcpMode(const std::string &aRestListenAddress, int aRestListenPort);
+    void InitRcpMode(void);
+    void DeinitRcpMode(void);
+
     std::string mInterfaceName;
 #if __linux__
     otbr::Utils::InfraLinkSelector mInfraLinkSelector;
 #endif
-    const char                   *mBackboneInterfaceName;
-    std::unique_ptr<Ncp::RcpHost> mHost;
+    const char                            *mBackboneInterfaceName;
+    std::unique_ptr<Ncp::ThreadController> mHost;
 #if OTBR_ENABLE_MDNS
     std::unique_ptr<Mdns::Publisher> mPublisher;
 #endif

src/agent/main.cpp

@@ -56,7 +56,7 @@
 #include "common/logging.hpp"
 #include "common/mainloop.hpp"
 #include "common/types.hpp"
-#include "ncp/rcp_host.hpp"
+#include "ncp/thread_controller.hpp"
 
 static const char kDefaultInterfaceName[] = "wpan0";
 
@@ -176,18 +176,19 @@ static otbrLogLevel GetDefaultLogLevel(void)
 
 static void PrintRadioVersionAndExit(const std::vector<const char *> &aRadioUrls)
 {
-    otbr::Ncp::RcpHost rcpHost{/* aInterfaceName */ "", aRadioUrls,
-                               /* aBackboneInterfaceName */ "",
-                               /* aDryRun */ true, /* aEnableAutoAttach */ false};
-    const char        *radioVersion;
+    auto host = std::unique_ptr<otbr::Ncp::ThreadController>(
+        otbr::Ncp::ThreadController::Create(/* aInterfaceName */ "", aRadioUrls,
+                                            /* aBackboneInterfaceName */ "",
+                                            /* aDryRun */ true, /* aEnableAutoAttach */ false));
+    const char *coprocessorVersion;
 
-    rcpHost.Init();
+    host->Init();
 
-    radioVersion = otPlatRadioGetVersionString(rcpHost.GetInstance());
-    otbrLogNotice("Radio version: %s", radioVersion);
-    printf("%s\n", radioVersion);
+    coprocessorVersion = host->GetCoprocessorVersion();
+    otbrLogNotice("Co-processor version: %s", coprocessorVersion);
+    printf("%s\n", coprocessorVersion);
 
-    rcpHost.Deinit();
+    host->Deinit();
 
     exit(EXIT_SUCCESS);
 }

src/common/code_utils.hpp

@@ -142,6 +142,19 @@
         }                                                                    \
     } while (false)
 
+/**
+ * This macro prints the message and terminates the program.
+ *
+ * @param[in] aMessage    A message (text string) to print.
+ *
+ */
+#define DieNow(aMessage)                                                 \
+    do                                                                   \
+    {                                                                    \
+        otbrLogEmerg("FAILED %s:%d - %s", __FILE__, __LINE__, aMessage); \
+        exit(-1);                                                        \
+    } while (false)
+
 /**
  *  This unconditionally executes @a ... and branches to the local
  *  label 'exit'.

src/ncp/CMakeLists.txt

@@ -29,6 +29,8 @@
 add_library(otbr-ncp
     rcp_host.cpp
     rcp_host.hpp
+    thread_controller.cpp
+    thread_controller.hpp
 )
 
 target_link_libraries(otbr-ncp PRIVATE

src/ncp/rcp_host.cpp

@@ -164,36 +164,6 @@ otbrLogLevel ConvertProtoToOtbrLogLevel(ProtoLogLevel aProtoLogLevel)
 }
 #endif
 
-otLogLevel RcpHost::ConvertToOtLogLevel(otbrLogLevel aLevel)
-{
-    otLogLevel level;
-
-    switch (aLevel)
-    {
-    case OTBR_LOG_EMERG:
-    case OTBR_LOG_ALERT:
-    case OTBR_LOG_CRIT:
-        level = OT_LOG_LEVEL_CRIT;
-        break;
-    case OTBR_LOG_ERR:
-    case OTBR_LOG_WARNING:
-        level = OT_LOG_LEVEL_WARN;
-        break;
-    case OTBR_LOG_NOTICE:
-        level = OT_LOG_LEVEL_NOTE;
-        break;
-    case OTBR_LOG_INFO:
-        level = OT_LOG_LEVEL_INFO;
-        break;
-    case OTBR_LOG_DEBUG:
-    default:
-        level = OT_LOG_LEVEL_DEBG;
-        break;
-    }
-
-    return level;
-}
-
 otError RcpHost::SetOtbrAndOtLogLevel(otbrLogLevel aLevel)
 {
     otError error = OT_ERROR_NONE;

src/ncp/rcp_host.hpp

@@ -86,16 +86,16 @@ class RcpHost : public MainloopProcessor, public ThreadController
             bool                             aEnableAutoAttach);
 
     /**
-     * This method initialize the NCP controller.
+     * This method initialize the Thread controller.
      *
      */
-    void Init(void);
+    void Init(void) override;
 
     /**
-     * This method deinitialize the NCP controller.
+     * This method deinitialize the Thread controller.
      *
      */
-    void Deinit(void);
+    void Deinit(void) override;
 
     /**
      * Returns an OpenThread instance.
@@ -194,9 +194,19 @@ class RcpHost : public MainloopProcessor, public ThreadController
 
     ~RcpHost(void) override;
 
-    // Thread Control APIs
+    // Thread Control virtual methods
     void GetDeviceRole(const DeviceRoleHandler aHandler) override;
 
+    CoprocessorType GetCoprocessorType(void) override
+    {
+        return OT_COPROCESSOR_RCP;
+    }
+
+    const char *GetCoprocessorVersion(void) override
+    {
+        return otPlatRadioGetVersionString(mInstance);
+    }
+
 private:
     static void HandleStateChanged(otChangedFlags aFlags, void *aContext)
     {
@@ -220,8 +230,6 @@ class RcpHost : public MainloopProcessor, public ThreadController
     bool IsAutoAttachEnabled(void);
     void DisableAutoAttach(void);
 
-    static otLogLevel ConvertToOtLogLevel(otbrLogLevel aLevel);
-
     otError SetOtbrAndOtLogLevel(otbrLogLevel aLevel);
 
     otInstance *mInstance;