Add RemoveAllFabrics command to OpCreds cluster (#6513)

* Add RemoveAllFabrics command * modify zap files * RemoveAllFabrics logic + UI support in iOS chiptool * Regen files * Restyled by whitespace * Restyled by clang-format Co-authored-by: Restyled.io <[email protected]>
project-chip · Jul 2, 2021 · 9992017 · 9992017
1 parent af15c53
commit 9992017
Show file tree

Hide file tree

Showing 52 changed files with 483 additions and 23 deletions.
diff --git a/examples/all-clusters-app/all-clusters-common/all-clusters-app.zap b/examples/all-clusters-app/all-clusters-common/all-clusters-app.zap
@@ -1616,7 +1616,7 @@
  "enabled": 0,
  "commands": [
  {
- "name": "GetFabricId",
+ "name": "SetFabric",
  "code": 0,
  "mfgCode": null,
  "source": "client",
@@ -1638,6 +1638,14 @@
  "source": "client",
  "incoming": 1,
  "outgoing": 1
+ },
+ {
+ "name": "RemoveAllFabrics",
+ "code": 11,
+ "mfgCode": null,
+ "source": "client",
+ "incoming": 1,
+ "outgoing": 1
  }
  ],
  "attributes": [
@@ -1667,7 +1675,7 @@
  "enabled": 1,
  "commands": [
  {
- "name": "GetFabricIdResponse",
+ "name": "SetFabricResponse",
  "code": 1,
  "mfgCode": null,
  "source": "server",
@@ -8446,7 +8454,7 @@
  "outgoing": 1
  },
  {
- "name": "TestSpecific",
+ "name": "TestNotHandled",
  "code": 1,
  "mfgCode": null,
  "source": "client",
@@ -11878,4 +11886,4 @@
  }
  ],
  "log": []
-}
+}
diff --git a/examples/all-clusters-app/all-clusters-common/gen/IMClusterCommandHandler.cpp b/examples/all-clusters-app/all-clusters-common/gen/IMClusterCommandHandler.cpp
@@ -7023,6 +7023,12 @@ void DispatchServerCommand(app::Command * apCommandObj, CommandId aCommandId, En
  {
  switch (aCommandId)
  {
+ case ZCL_REMOVE_ALL_FABRICS_COMMAND_ID: {
+
+ // TODO(#5098) We should pass the Command Object and EndpointId to the cluster callbacks.
+ emberAfOperationalCredentialsClusterRemoveAllFabricsCallback(apCommandObj);
+ break;
+ }
  case ZCL_REMOVE_FABRIC_COMMAND_ID: {
  // We are using TLVUnpackError and TLVError here since both of them can be CHIP_END_OF_TLV
  // When TLVError is CHIP_END_OF_TLV, it means we have iterated all of the items, which is not a real error.

diff --git a/examples/all-clusters-app/all-clusters-common/gen/call-command-handler.cpp b/examples/all-clusters-app/all-clusters-common/gen/call-command-handler.cpp
@@ -2310,6 +2310,10 @@ EmberAfStatus emberAfOperationalCredentialsClusterServerCommandParse(EmberAfClus
  {
  switch (cmd->commandId)
  {
+ case ZCL_REMOVE_ALL_FABRICS_COMMAND_ID: {
+ wasHandled = emberAfOperationalCredentialsClusterRemoveAllFabricsCallback(nullptr);
+ break;
+ }
  case ZCL_REMOVE_FABRIC_COMMAND_ID: {
  uint16_t payloadOffset = cmd->payloadStartIndex;
  chip::FabricId FabricId;

diff --git a/examples/all-clusters-app/all-clusters-common/gen/callback.h b/examples/all-clusters-app/all-clusters-common/gen/callback.h
@@ -2723,6 +2723,12 @@ bool emberAfOnOffClusterOnCallback(chip::app::Command * commandObj);
 
 bool emberAfOnOffClusterToggleCallback(chip::app::Command * commandObj);
 
+/**
+ * @brief Operational Credentials Cluster RemoveAllFabrics Command callback
+ */
+
+bool emberAfOperationalCredentialsClusterRemoveAllFabricsCallback(chip::app::Command * commandObj);
+
 /**
  * @brief Operational Credentials Cluster RemoveFabric Command callback
  * @param fabricId

diff --git a/examples/all-clusters-app/all-clusters-common/gen/client-command-macro.h b/examples/all-clusters-app/all-clusters-common/gen/client-command-macro.h
@@ -2240,6 +2240,15 @@
  \
  ZCL_REMOVE_FABRIC_COMMAND_ID, "uuu", FabricId, NodeId, VendorId);
 
+/** @brief Command description for RemoveAllFabrics
+ *
+ * Command: RemoveAllFabrics
+ */
+#define emberAfFillCommandOperational \
+ CredentialsClusterRemoveAllFabrics() emberAfFillExternalBuffer(mask, \
+ \
+ ZCL_REMOVE_ALL_FABRICS_COMMAND_ID, "", );
+
 /** @brief Command description for LockDoor
  *
  * Command: LockDoor

diff --git a/examples/all-clusters-app/all-clusters-common/gen/command-id.h b/examples/all-clusters-app/all-clusters-common/gen/command-id.h
@@ -270,6 +270,7 @@
 #define ZCL_SET_FABRIC_RESPONSE_COMMAND_ID (0x01)
 #define ZCL_UPDATE_FABRIC_LABEL_COMMAND_ID (0x09)
 #define ZCL_REMOVE_FABRIC_COMMAND_ID (0x0A)
+#define ZCL_REMOVE_ALL_FABRICS_COMMAND_ID (0x0B)
 
 // Commands for cluster: Door Lock
 #define ZCL_LOCK_DOOR_COMMAND_ID (0x00)

diff --git a/examples/all-clusters-app/all-clusters-common/gen/endpoint_config.h b/examples/all-clusters-app/all-clusters-common/gen/endpoint_config.h
@@ -1263,7 +1263,7 @@
 
 // Array of EmberAfCommandMetadata structs.
 #define ZAP_COMMAND_MASK(mask) COMMAND_MASK_##mask
-#define EMBER_AF_GENERATED_COMMAND_COUNT (140)
+#define EMBER_AF_GENERATED_COMMAND_COUNT (141)
 #define GENERATED_COMMANDS \
  { \
  \
@@ -1306,6 +1306,7 @@
  { 0x003E, 0x01, ZAP_COMMAND_MASK(INCOMING_CLIENT) }, /* SetFabricResponse */ \
  { 0x003E, 0x09, ZAP_COMMAND_MASK(INCOMING_SERVER) }, /* UpdateFabricLabel */ \
  { 0x003E, 0x0A, ZAP_COMMAND_MASK(INCOMING_SERVER) }, /* RemoveFabric */ \
+ { 0x003E, 0x0B, ZAP_COMMAND_MASK(INCOMING_SERVER) }, /* RemoveAllFabrics */ \
  \
  /* Endpoint: 0, Cluster: Test Cluster (server) */ \
  { 0x050F, 0x00, ZAP_COMMAND_MASK(INCOMING_SERVER) }, /* Test */ \

diff --git a/examples/bridge-app/bridge-common/gen/client-command-macro.h b/examples/bridge-app/bridge-common/gen/client-command-macro.h
@@ -2240,6 +2240,15 @@
  \
  ZCL_REMOVE_FABRIC_COMMAND_ID, "uuu", FabricId, NodeId, VendorId);
 
+/** @brief Command description for RemoveAllFabrics
+ *
+ * Command: RemoveAllFabrics
+ */
+#define emberAfFillCommandOperational \
+ CredentialsClusterRemoveAllFabrics() emberAfFillExternalBuffer(mask, \
+ \
+ ZCL_REMOVE_ALL_FABRICS_COMMAND_ID, "", );
+
 /** @brief Command description for LockDoor
  *
  * Command: LockDoor

diff --git a/examples/bridge-app/bridge-common/gen/command-id.h b/examples/bridge-app/bridge-common/gen/command-id.h
@@ -270,6 +270,7 @@
 #define ZCL_SET_FABRIC_RESPONSE_COMMAND_ID (0x01)
 #define ZCL_UPDATE_FABRIC_LABEL_COMMAND_ID (0x09)
 #define ZCL_REMOVE_FABRIC_COMMAND_ID (0x0A)
+#define ZCL_REMOVE_ALL_FABRICS_COMMAND_ID (0x0B)
 
 // Commands for cluster: Door Lock
 #define ZCL_LOCK_DOOR_COMMAND_ID (0x00)

diff --git a/examples/chip-tool/chip-tool.zap b/examples/chip-tool/chip-tool.zap
@@ -1616,7 +1616,7 @@
  "enabled": 1,
  "commands": [
  {
- "name": "GetFabricId",
+ "name": "SetFabric",
  "code": 0,
  "mfgCode": null,
  "source": "client",
@@ -1638,6 +1638,14 @@
  "source": "client",
  "incoming": 1,
  "outgoing": 1
+ },
+ {
+ "name": "RemoveAllFabrics",
+ "code": 11,
+ "mfgCode": null,
+ "source": "client",
+ "incoming": 1,
+ "outgoing": 1
  }
  ],
  "attributes": [
@@ -1667,7 +1675,7 @@
  "enabled": 0,
  "commands": [
  {
- "name": "GetFabricIdResponse",
+ "name": "SetFabricResponse",
  "code": 1,
  "mfgCode": null,
  "source": "server",
@@ -6033,4 +6041,4 @@
  }
  ],
  "log": []
-}
+}
diff --git a/examples/chip-tool/commands/clusters/Commands.h b/examples/chip-tool/commands/clusters/Commands.h
@@ -10498,6 +10498,7 @@ class ReadOnOffClusterRevision : public ModelCommand
 | Cluster OperationalCredentials | 0x003E |
 |------------------------------------------------------------------------------|
 | Commands: | |
+| * RemoveAllFabrics | 0x0B |
 | * RemoveFabric | 0x0A |
 | * SetFabric | 0x00 |
 | * UpdateFabricLabel | 0x09 |
@@ -10507,6 +10508,35 @@ class ReadOnOffClusterRevision : public ModelCommand
 | * ClusterRevision | 0xFFFD |
 \*----------------------------------------------------------------------------*/
 
+/*
+ * Command RemoveAllFabrics
+ */
+class OperationalCredentialsRemoveAllFabrics : public ModelCommand
+{
+public:
+ OperationalCredentialsRemoveAllFabrics() : ModelCommand("remove-all-fabrics") { ModelCommand::AddArguments(); }
+ ~OperationalCredentialsRemoveAllFabrics()
+ {
+ delete onSuccessCallback;
+ delete onFailureCallback;
+ }
+
+ CHIP_ERROR SendCommand(ChipDevice * device, uint8_t endpointId) override
+ {
+ ChipLogProgress(chipTool, "Sending cluster (0x003E) command (0x0B) on endpoint %" PRIu16, endpointId);
+
+ chip::Controller::OperationalCredentialsCluster cluster;
+ cluster.Associate(device, endpointId);
+ return cluster.RemoveAllFabrics(onSuccessCallback->Cancel(), onFailureCallback->Cancel());
+ }
+
+private:
+ chip::Callback::Callback<DefaultSuccessCallback> * onSuccessCallback =
+ new chip::Callback::Callback<DefaultSuccessCallback>(OnDefaultSuccessResponse, this);
+ chip::Callback::Callback<DefaultFailureCallback> * onFailureCallback =
+ new chip::Callback::Callback<DefaultFailureCallback>(OnDefaultFailureResponse, this);
+};
+
 /*
  * Command RemoveFabric
  */
@@ -14923,9 +14953,10 @@ void registerClusterOperationalCredentials(Commands & commands)
  const char * clusterName = "OperationalCredentials";
 
  commands_list clusterCommands = {
- make_unique<OperationalCredentialsRemoveFabric>(), make_unique<OperationalCredentialsSetFabric>(),
- make_unique<OperationalCredentialsUpdateFabricLabel>(), make_unique<DiscoverOperationalCredentialsAttributes>(),
- make_unique<ReadOperationalCredentialsFabricsList>(), make_unique<ReadOperationalCredentialsClusterRevision>(),
+ make_unique<OperationalCredentialsRemoveAllFabrics>(), make_unique<OperationalCredentialsRemoveFabric>(),
+ make_unique<OperationalCredentialsSetFabric>(), make_unique<OperationalCredentialsUpdateFabricLabel>(),
+ make_unique<DiscoverOperationalCredentialsAttributes>(), make_unique<ReadOperationalCredentialsFabricsList>(),
+ make_unique<ReadOperationalCredentialsClusterRevision>(),
  };
 
  commands.Register(clusterName, clusterCommands);

diff --git a/examples/chip-tool/gen/CHIPClusters.cpp b/examples/chip-tool/gen/CHIPClusters.cpp
@@ -4511,6 +4511,32 @@ CHIP_ERROR OnOffCluster::ReadAttributeClusterRevision(Callback::Cancelable * onS
 }
 
 // OperationalCredentials Cluster Commands
+CHIP_ERROR OperationalCredentialsCluster::RemoveAllFabrics(Callback::Cancelable * onSuccessCallback,
+ Callback::Cancelable * onFailureCallback)
+{
+#if CHIP_ENABLE_INTERACTION_MODEL
+ VerifyOrReturnError(mDevice != nullptr, CHIP_ERROR_INCORRECT_STATE);
+ (void) onSuccessCallback;
+ (void) onFailureCallback;
+
+ app::CommandPathParams cmdParams = { mEndpoint, /* group id */ 0, mClusterId, kRemoveAllFabricsCommandId,
+ (chip::app::CommandPathFlags::kEndpointIdValid) };
+ app::Command * ZCLcommand = mDevice->GetCommandSender();
+
+ ReturnErrorOnFailure(ZCLcommand->PrepareCommand(&cmdParams));
+
+ // Command takes no arguments.
+
+ ReturnErrorOnFailure(ZCLcommand->FinishCommand());
+
+ return mDevice->SendCommands();
+#else
+ uint8_t seqNum = mDevice->GetNextSequenceNumber();
+ System::PacketBufferHandle encodedCommand = encodeOperationalCredentialsClusterRemoveAllFabricsCommand(seqNum, mEndpoint);
+ return SendCommand(seqNum, std::move(encodedCommand), onSuccessCallback, onFailureCallback);
+#endif
+}
+
 CHIP_ERROR OperationalCredentialsCluster::RemoveFabric(Callback::Cancelable * onSuccessCallback,
  Callback::Cancelable * onFailureCallback, chip::FabricId fabricId,
  chip::NodeId nodeId, uint16_t vendorId)

diff --git a/examples/chip-tool/gen/CHIPClusters.h b/examples/chip-tool/gen/CHIPClusters.h
@@ -817,6 +817,7 @@ class DLL_EXPORT OperationalCredentialsCluster : public ClusterBase
  ~OperationalCredentialsCluster() {}
 
  // Cluster Commands
+ CHIP_ERROR RemoveAllFabrics(Callback::Cancelable * onSuccessCallback, Callback::Cancelable * onFailureCallback);
  CHIP_ERROR RemoveFabric(Callback::Cancelable * onSuccessCallback, Callback::Cancelable * onFailureCallback,
  chip::FabricId fabricId, chip::NodeId nodeId, uint16_t vendorId);
  CHIP_ERROR SetFabric(Callback::Cancelable * onSuccessCallback, Callback::Cancelable * onFailureCallback, uint16_t vendorId);
@@ -829,6 +830,7 @@ class DLL_EXPORT OperationalCredentialsCluster : public ClusterBase
  CHIP_ERROR ReadAttributeClusterRevision(Callback::Cancelable * onSuccessCallback, Callback::Cancelable * onFailureCallback);
 
 private:
+ static constexpr CommandId kRemoveAllFabricsCommandId = 0x0B;
  static constexpr CommandId kRemoveFabricCommandId = 0x0A;
  static constexpr CommandId kSetFabricCommandId = 0x00;
  static constexpr CommandId kUpdateFabricLabelCommandId = 0x09;

diff --git a/examples/chip-tool/gen/CHIPClustersObjc.h b/examples/chip-tool/gen/CHIPClustersObjc.h
@@ -686,6 +686,7 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @interface CHIPOperationalCredentials : CHIPCluster
 
+- (void)removeAllFabrics:(ResponseHandler)responseHandler;
 - (void)removeFabric:(uint64_t)fabricId
  nodeId:(uint64_t)nodeId
  vendorId:(uint16_t)vendorId

diff --git a/examples/chip-tool/gen/CHIPClustersObjc.mm b/examples/chip-tool/gen/CHIPClustersObjc.mm
@@ -10180,6 +10180,32 @@ @implementation CHIPOperationalCredentials
  return &_cppCluster;
 }
 
+- (void)removeAllFabrics:(ResponseHandler)responseHandler
+{
+ CHIPDefaultSuccessCallbackBridge * onSuccess = new CHIPDefaultSuccessCallbackBridge(responseHandler, [self callbackQueue]);
+ if (!onSuccess) {
+ responseHandler([CHIPError errorForCHIPErrorCode:CHIP_ERROR_INCORRECT_STATE], nil);
+ return;
+ }
+
+ CHIPDefaultFailureCallbackBridge * onFailure = new CHIPDefaultFailureCallbackBridge(responseHandler, [self callbackQueue]);
+ if (!onFailure) {
+ delete onSuccess;
+ responseHandler([CHIPError errorForCHIPErrorCode:CHIP_ERROR_INCORRECT_STATE], nil);
+ return;
+ }
+
+ __block CHIP_ERROR err;
+ dispatch_sync([self chipWorkQueue], ^{
+ err = self.cppCluster.RemoveAllFabrics(onSuccess->Cancel(), onFailure->Cancel());
+ });
+
+ if (err != CHIP_NO_ERROR) {
+ delete onSuccess;
+ delete onFailure;
+ responseHandler([CHIPError errorForCHIPErrorCode:err], nil);
+ }
+}
 - (void)removeFabric:(uint64_t)fabricId
  nodeId:(uint64_t)nodeId
  vendorId:(uint16_t)vendorId

diff --git a/examples/chip-tool/gen/client-command-macro.h b/examples/chip-tool/gen/client-command-macro.h
@@ -2240,6 +2240,15 @@
  \
  ZCL_REMOVE_FABRIC_COMMAND_ID, "uuu", FabricId, NodeId, VendorId);
 
+/** @brief Command description for RemoveAllFabrics
+ *
+ * Command: RemoveAllFabrics
+ */
+#define emberAfFillCommandOperational \
+ CredentialsClusterRemoveAllFabrics() emberAfFillExternalBuffer(mask, \
+ \
+ ZCL_REMOVE_ALL_FABRICS_COMMAND_ID, "", );
+
 /** @brief Command description for LockDoor
  *
  * Command: LockDoor

diff --git a/examples/chip-tool/gen/command-id.h b/examples/chip-tool/gen/command-id.h
@@ -270,6 +270,7 @@
 #define ZCL_SET_FABRIC_RESPONSE_COMMAND_ID (0x01)
 #define ZCL_UPDATE_FABRIC_LABEL_COMMAND_ID (0x09)
 #define ZCL_REMOVE_FABRIC_COMMAND_ID (0x0A)
+#define ZCL_REMOVE_ALL_FABRICS_COMMAND_ID (0x0B)
 
 // Commands for cluster: Door Lock
 #define ZCL_LOCK_DOOR_COMMAND_ID (0x00)

diff --git a/examples/chip-tool/gen/endpoint_config.h b/examples/chip-tool/gen/endpoint_config.h
@@ -320,7 +320,7 @@
 
 // Array of EmberAfCommandMetadata structs.
 #define ZAP_COMMAND_MASK(mask) COMMAND_MASK_##mask
-#define EMBER_AF_GENERATED_COMMAND_COUNT (191)
+#define EMBER_AF_GENERATED_COMMAND_COUNT (192)
 #define GENERATED_COMMANDS \
  { \
  \
@@ -410,6 +410,7 @@
  { 0x003E, 0x01, ZAP_COMMAND_MASK(INCOMING_CLIENT) }, /* SetFabricResponse */ \
  { 0x003E, 0x09, ZAP_COMMAND_MASK(INCOMING_SERVER) }, /* UpdateFabricLabel */ \
  { 0x003E, 0x0A, ZAP_COMMAND_MASK(INCOMING_SERVER) }, /* RemoveFabric */ \
+ { 0x003E, 0x0B, ZAP_COMMAND_MASK(INCOMING_SERVER) }, /* RemoveAllFabrics */ \
  \
  /* Endpoint: 1, Cluster: Door Lock (client) */ \
  { 0x0101, 0x00, ZAP_COMMAND_MASK(INCOMING_SERVER) }, /* LockDoor */ \

diff --git a/examples/lighting-app/lighting-common/gen/client-command-macro.h b/examples/lighting-app/lighting-common/gen/client-command-macro.h
@@ -2240,6 +2240,15 @@
  \
  ZCL_REMOVE_FABRIC_COMMAND_ID, "uuu", FabricId, NodeId, VendorId);
 
+/** @brief Command description for RemoveAllFabrics
+ *
+ * Command: RemoveAllFabrics
+ */
+#define emberAfFillCommandOperational \
+ CredentialsClusterRemoveAllFabrics() emberAfFillExternalBuffer(mask, \
+ \
+ ZCL_REMOVE_ALL_FABRICS_COMMAND_ID, "", );
+
 /** @brief Command description for LockDoor
  *
  * Command: LockDoor