From 3ef70a0835ebeb213d1dd07d9afa5d0740abb07d Mon Sep 17 00:00:00 2001 From: Vivien Nicolas Date: Fri, 28 Jan 2022 14:17:12 +0100 Subject: [PATCH] Convert mSuccess and mFailure --- src/controller/CHIPDeviceController.cpp | 119 ++++++++++++++++-------- src/controller/CHIPDeviceController.h | 42 +++++++-- 2 files changed, 114 insertions(+), 47 deletions(-) diff --git a/src/controller/CHIPDeviceController.cpp b/src/controller/CHIPDeviceController.cpp index 0c9cafc772ffde..4cec03ce11cc8b 100644 --- a/src/controller/CHIPDeviceController.cpp +++ b/src/controller/CHIPDeviceController.cpp @@ -644,8 +644,7 @@ ControllerDeviceInitParams DeviceController::GetControllerDeviceInitParams() } DeviceCommissioner::DeviceCommissioner() : - mSuccess(BasicSuccess, this), mFailure(BasicFailure, this), mOnDeviceConnectedCallback(OnDeviceConnectedFn, this), - mOnDeviceConnectionFailureCallback(OnDeviceConnectionFailureFn, this), + mOnDeviceConnectedCallback(OnDeviceConnectedFn, this), mOnDeviceConnectionFailureCallback(OnDeviceConnectionFailureFn, this), mDeviceAttestationInformationVerificationCallback(OnDeviceAttestationInformationVerification, this), mDeviceNOCChainCallback(OnDeviceNOCChainGeneration, this), mSetUpCodePairer(this), mAutoCommissioner(this) { @@ -1457,18 +1456,11 @@ void DeviceCommissioner::OnNodeDiscoveryComplete(const chip::Dnssd::DiscoveredNo } #endif // CHIP_DEVICE_CONFIG_ENABLE_DNSSD -void BasicSuccess(void * context, uint16_t val) +void OnBasicFailure(void * context, CHIP_ERROR error) { - ChipLogProgress(Controller, "Received success response 0x%x\n", val); + ChipLogProgress(Controller, "Received failure response %s\n", chip::ErrorStr(error)); DeviceCommissioner * commissioner = static_cast(context); - commissioner->CommissioningStageComplete(CHIP_NO_ERROR); -} - -void BasicFailure(void * context, uint8_t status) -{ - ChipLogProgress(Controller, "Received failure response %d\n", (int) status); - DeviceCommissioner * commissioner = static_cast(context); - commissioner->CommissioningStageComplete(static_cast(status)); + commissioner->CommissioningStageComplete(error); } void DeviceCommissioner::CommissioningStageComplete(CHIP_ERROR err, CommissioningDelegate::CommissioningReport report) @@ -1578,6 +1570,51 @@ void DeviceCommissioner::SetupCluster(ClusterBase & base, DeviceProxy * proxy, E base.SetCommandTimeout(timeout); } +void DeviceCommissioner::OnArmFailSafe(void * context, + const GeneralCommissioning::Commands::ArmFailSafeResponse::DecodableType & data) +{ + // TODO: Use errorCode + ChipLogProgress(Controller, "Received ArmFailSafe response"); + DeviceCommissioner * commissioner = static_cast(context); + commissioner->CommissioningStageComplete(CHIP_NO_ERROR); +} + +void DeviceCommissioner::OnSetRegulatoryConfigResponse( + void * context, const GeneralCommissioning::Commands::SetRegulatoryConfigResponse::DecodableType & data) +{ + // TODO: Use errorCode + ChipLogProgress(Controller, "Received SetRegulatoryConfig response"); + DeviceCommissioner * commissioner = static_cast(context); + commissioner->CommissioningStageComplete(CHIP_NO_ERROR); +} + +void DeviceCommissioner::OnNetworkConfigResponse(void * context, + const NetworkCommissioning::Commands::NetworkConfigResponse::DecodableType & data) +{ + // TODO: Use networkingStatus + ChipLogProgress(Controller, "Received NetworkConfig response"); + DeviceCommissioner * commissioner = static_cast(context); + commissioner->CommissioningStageComplete(CHIP_NO_ERROR); +} + +void DeviceCommissioner::OnConnectNetworkResponse( + void * context, const NetworkCommissioning::Commands::ConnectNetworkResponse::DecodableType & data) +{ + // TODO: Use networkingStatus + ChipLogProgress(Controller, "Received ConnectNetwork response"); + DeviceCommissioner * commissioner = static_cast(context); + commissioner->CommissioningStageComplete(CHIP_NO_ERROR); +} + +void DeviceCommissioner::OnCommissioningCompleteResponse( + void * context, const GeneralCommissioning::Commands::CommissioningCompleteResponse::DecodableType & data) +{ + // TODO: Use errorCode + ChipLogProgress(Controller, "Received CommissioningComplete response"); + DeviceCommissioner * commissioner = static_cast(context); + commissioner->CommissioningStageComplete(CHIP_NO_ERROR); +} + void DeviceCommissioner::PerformCommissioningStep(DeviceProxy * proxy, CommissioningStage step, CommissioningParameters & params, CommissioningDelegate * delegate, EndpointId endpoint, Optional timeout) @@ -1598,11 +1635,12 @@ void DeviceCommissioner::PerformCommissioningStep(DeviceProxy * proxy, Commissio { case CommissioningStage::kArmFailsafe: { ChipLogProgress(Controller, "Arming failsafe"); - // TODO(cecille): Find a way to enumerate the clusters here. - GeneralCommissioningCluster genCom; // TODO: should get the endpoint information from the descriptor cluster. - SetupCluster(genCom, proxy, endpoint, timeout); - genCom.ArmFailSafe(mSuccess.Cancel(), mFailure.Cancel(), params.GetFailsafeTimerSeconds(), breadcrumb, kCommandTimeoutMs); + GeneralCommissioning::Commands::ArmFailSafe::Type request; + request.expiryLengthSeconds = params.GetFailsafeTimerSeconds(); + request.breadcrumb = breadcrumb; + request.timeoutMs = kCommandTimeoutMs; + SendCommand(proxy, request, OnArmFailSafe, OnBasicFailure, timeout); } break; case CommissioningStage::kConfigRegulatory: { @@ -1641,10 +1679,12 @@ void DeviceCommissioner::PerformCommissioningStep(DeviceProxy * proxy, Commissio } chip::CharSpan countryCode(countryCodeStr, actualCountryCodeSize); - GeneralCommissioningCluster genCom; - SetupCluster(genCom, proxy, endpoint, timeout); - genCom.SetRegulatoryConfig(mSuccess.Cancel(), mFailure.Cancel(), regulatoryLocation, countryCode, breadcrumb, - kCommandTimeoutMs); + GeneralCommissioning::Commands::SetRegulatoryConfig::Type request; + request.location = static_cast(regulatoryLocation); + request.countryCode = countryCode; + request.breadcrumb = breadcrumb; + request.timeoutMs = kCommandTimeoutMs; + SendCommand(proxy, request, OnSetRegulatoryConfigResponse, OnBasicFailure, timeout); } break; case CommissioningStage::kSendPAICertificateRequest: @@ -1763,11 +1803,13 @@ void DeviceCommissioner::PerformCommissioningStep(DeviceProxy * proxy, Commissio CommissioningStageComplete(CHIP_ERROR_INVALID_ARGUMENT); return; } + ChipLogProgress(Controller, "Adding wifi network"); - NetworkCommissioningCluster netCom; - SetupCluster(netCom, proxy, endpoint, timeout); - netCom.AddOrUpdateWiFiNetwork(mSuccess.Cancel(), mFailure.Cancel(), params.GetWiFiCredentials().Value().ssid, - params.GetWiFiCredentials().Value().credentials, breadcrumb); + NetworkCommissioning::Commands::AddOrUpdateWiFiNetwork::Type request; + request.ssid = params.GetWiFiCredentials().Value().ssid; + request.credentials = params.GetWiFiCredentials().Value().credentials; + request.breadcrumb = breadcrumb; + SendCommand(proxy, request, OnNetworkConfigResponse, OnBasicFailure); } break; case CommissioningStage::kThreadNetworkSetup: { @@ -1778,10 +1820,10 @@ void DeviceCommissioner::PerformCommissioningStep(DeviceProxy * proxy, Commissio return; } ChipLogProgress(Controller, "Adding thread network"); - NetworkCommissioningCluster netCom; - SetupCluster(netCom, proxy, endpoint, timeout); - netCom.AddOrUpdateThreadNetwork(mSuccess.Cancel(), mFailure.Cancel(), params.GetThreadOperationalDataset().Value(), - breadcrumb); + NetworkCommissioning::Commands::AddOrUpdateThreadNetwork::Type request; + request.operationalDataset = params.GetThreadOperationalDataset().Value(); + request.breadcrumb = breadcrumb; + SendCommand(proxy, request, OnNetworkConfigResponse, OnBasicFailure); } break; case CommissioningStage::kWiFiNetworkEnable: { @@ -1792,9 +1834,10 @@ void DeviceCommissioner::PerformCommissioningStep(DeviceProxy * proxy, Commissio return; } ChipLogProgress(Controller, "Enabling wifi network"); - NetworkCommissioningCluster netCom; - SetupCluster(netCom, proxy, endpoint, timeout); - netCom.ConnectNetwork(mSuccess.Cancel(), mFailure.Cancel(), params.GetWiFiCredentials().Value().ssid, breadcrumb); + NetworkCommissioning::Commands::ConnectNetwork::Type request; + request.networkID = params.GetWiFiCredentials().Value().ssid; + request.breadcrumb = breadcrumb; + SendCommand(proxy, request, OnConnectNetworkResponse, OnBasicFailure); } break; case CommissioningStage::kThreadNetworkEnable: { @@ -1809,9 +1852,10 @@ void DeviceCommissioner::PerformCommissioningStep(DeviceProxy * proxy, Commissio return; } ChipLogProgress(Controller, "Enabling thread network"); - NetworkCommissioningCluster netCom; - SetupCluster(netCom, proxy, endpoint, timeout); - netCom.ConnectNetwork(mSuccess.Cancel(), mFailure.Cancel(), extendedPanId, breadcrumb); + NetworkCommissioning::Commands::ConnectNetwork::Type request; + request.networkID = extendedPanId; + request.breadcrumb = breadcrumb; + SendCommand(proxy, request, OnConnectNetworkResponse, OnBasicFailure); } break; case CommissioningStage::kFindOperational: { @@ -1826,9 +1870,8 @@ void DeviceCommissioner::PerformCommissioningStep(DeviceProxy * proxy, Commissio break; case CommissioningStage::kSendComplete: { ChipLogProgress(Controller, "Calling commissioning complete"); - GeneralCommissioningCluster genCom; - SetupCluster(genCom, proxy, endpoint, timeout); - genCom.CommissioningComplete(mSuccess.Cancel(), mFailure.Cancel()); + GeneralCommissioning::Commands::CommissioningComplete::Type request; + SendCommand(proxy, request, OnCommissioningCompleteResponse, OnBasicFailure, timeout); } break; case CommissioningStage::kCleanup: @@ -1846,7 +1889,7 @@ void DeviceCommissioner::PerformCommissioningStep(DeviceProxy * proxy, Commissio case CommissioningStage::kSecurePairing: break; } -} +} // namespace Controller } // namespace Controller } // namespace chip diff --git a/src/controller/CHIPDeviceController.h b/src/controller/CHIPDeviceController.h index 149251e6aedb71..74c8a36130c1d1 100644 --- a/src/controller/CHIPDeviceController.h +++ b/src/controller/CHIPDeviceController.h @@ -51,6 +51,7 @@ #include #include #include +#include #include #include #include @@ -88,10 +89,7 @@ constexpr uint16_t kNumMaxActiveDevices = CHIP_CONFIG_CONTROLLER_MAX_ACTIVE_DEVI constexpr uint16_t kNumMaxPairedDevices = 128; // Raw functions for cluster callbacks -typedef void (*BasicSuccessCallback)(void * context, uint16_t val); -typedef void (*BasicFailureCallback)(void * context, uint8_t status); -void BasicSuccess(void * context, uint16_t val); -void BasicFailure(void * context, uint8_t status); +void OnBasicFailure(void * context, CHIP_ERROR err); struct ControllerInitParams { @@ -784,6 +782,19 @@ class DLL_EXPORT DeviceCommissioner : public DeviceController, static void OnDeviceNOCChainGeneration(void * context, CHIP_ERROR status, const ByteSpan & noc, const ByteSpan & icac, const ByteSpan & rcac, Optional ipk, Optional adminSubject); + static void OnArmFailSafe(void * context, + const chip::app::Clusters::GeneralCommissioning::Commands::ArmFailSafeResponse::DecodableType & data); + static void OnSetRegulatoryConfigResponse( + void * context, + const chip::app::Clusters::GeneralCommissioning::Commands::SetRegulatoryConfigResponse::DecodableType & data); + static void + OnNetworkConfigResponse(void * context, + const chip::app::Clusters::NetworkCommissioning::Commands::NetworkConfigResponse::DecodableType & data); + static void OnConnectNetworkResponse( + void * context, const chip::app::Clusters::NetworkCommissioning::Commands::ConnectNetworkResponse::DecodableType & data); + static void OnCommissioningCompleteResponse( + void * context, + const chip::app::Clusters::GeneralCommissioning::Commands::CommissioningCompleteResponse::DecodableType & data); /** * @brief @@ -819,13 +830,26 @@ class DLL_EXPORT DeviceCommissioner : public DeviceController, ClusterObjectT cluster; cluster.Associate(device, 0); - ReturnErrorOnFailure(cluster.InvokeCommand(request, this, successCb, failureCb)); - return CHIP_NO_ERROR; + return cluster.InvokeCommand(request, this, successCb, failureCb); } - // Cluster callbacks for advancing commissioning flows - Callback::Callback mSuccess; - Callback::Callback mFailure; + template + CHIP_ERROR SendCommand(DeviceProxy * device, RequestObjectT request, + CommandResponseSuccessCallback successCb, + CommandResponseFailureCallback failureCb, chip::Optional timeout) + { + ClusterObjectT cluster; + cluster.Associate(device, 0); + + if (timeout.HasValue()) + { + VerifyOrReturnError(chip::CanCastTo(timeout.Value().count()), CHIP_ERROR_INVALID_ARGUMENT); + chip::Optional timedInvokeRequestTimeoutInMs(static_cast(timeout.Value().count())); + return cluster.InvokeCommand(request, this, successCb, failureCb, timedInvokeRequestTimeoutInMs); + } + + return cluster.InvokeCommand(request, this, successCb, failureCb); + } static CHIP_ERROR ConvertFromNodeOperationalCertStatus(uint8_t err);