Address review comments

Author: yufengwangca

src/app/zap-templates/zcl/data-model/chip/commissioner-control-cluster.xml

@@ -16,13 +16,12 @@ limitations under the License.
 -->
 <configurator>
   <domain name="CHIP"/>
-
   <bitmap name="SupportedDeviceCategoryBitmap" type="bitmap32">
-      <cluster code="0x0751"/>
-      <field name="FabricSynchronization" mask="0x1"/>
+    <cluster code="0x0751"/>
+    <field name="FabricSynchronization" mask="0x1"/>
   </bitmap>
 
-  <cluster>
+  <cluster apiMaturity="provisional">
     <domain>General</domain>
     <name>Commissioner Control</name>
     <code>0x0751</code>
@@ -31,41 +30,47 @@ limitations under the License.
     <server init="false" tick="false">true</server>
     <description>Supports the ability for clients to request the commissioning of themselves or other nodes onto a fabric which the cluster server can commission onto.</description>
 
-    <attribute side="server" code="0x0000" define="SUPPORTED_DEVICE_CATEGORIES" type="SupportedDeviceCategoryBitmap" default="0" writable="false" optional="false">SupportedDeviceCategories</attribute>
+    <!-- cluster revision -->
+    <globalAttribute side="either" code="0xFFFD" value="1"/>
+    <attribute side="server" code="0x0000" define="SUPPORTED_DEVICE_CATEGORIES" type="SupportedDeviceCategoryBitmap" default="0" min="0x00000000" max="0x00000001">
+      <description>SupportedDeviceCategories</description>
+      <access op="read" privilege="manage"/>
+    </attribute>
 
     <command source="client" code="0x00" name="RequestCommissioningApproval" optional="false">
       <description>This command is sent by a client to request approval for a future CommissionNode call.</description>
-      <arg name="RequestId" type="int64u" optional="false"/>
-      <arg name="VendorId" type="vendor_id" optional="false"/>
-      <arg name="ProductId" type="int16u" optional="false"/>
-      <arg name="Label" type="char_string"  lenght="64" optional="true"/>     
+      <arg id="0" name="RequestId" type="int64u"/>
+      <arg id="1" name="VendorId" type="vendor_id"/>
+      <arg id="2" name="ProductId" type="int16u"/>
+      <arg id="3" name="Label" type="char_string" optional="true" length="64"/>
       <access op="invoke" privilege="manage"/>
     </command>
 
     <command source="client" code="0x01" name="CommissionNode" response="ReverseOpenCommissioningWindow" optional="false">
       <description>This command is sent by a client to request that the server begins commissioning a previously approved request.</description>
-      <arg name="RequestId" type="int64u" optional="false"/>
-      <arg name="ResponseTimeoutSeconds" type="int16u" min="30" max="120" default="30" optional="false"/>
-      <arg name="IpAddress" type="octet_string" optional="true"/> <!-- Note: ipadr is not supported yet, use its base type (octet_string) here -->
-      <arg name="Port" type="int16u" optional="true"/>         
+      <arg id="0" name="RequestId" type="int64u"/>
+      <arg id="2" name="ResponseTimeoutSeconds" type="int16u" min="30" max="120" default="30"/>
+      <arg id="3" name="IpAddress" type="octet_string" optional="true" min="4" max="16"/>
+      <!-- Note: ipadr is not supported yet, use its base type (octet_string) here -->
+      <arg id="4" name="Port" type="int16u" optional="true"/>
       <access op="invoke" privilege="manage"/>
     </command>
 
     <command source="server" code="0x02" name="ReverseOpenCommissioningWindow" optional="false">
       <description>When received within the timeout specified by CommissionNode, the client SHALL open a commissioning window on to the node which the client called RequestCommissioningApproval to have commissioned.</description>
-      <arg name="CommissioningTimeout" type="int16u" optional="false"/>
-      <arg name="PAKEPasscodeVerifier" type="octet_string" optional="false"/>
-      <arg name="Discriminator" type="int16u" min="0" max="4095" optional="false"/>
-      <arg name="Iterations" type="int32u" min="1000" max="100000" optional="false"/>
-      <arg name="Salt" type="octet_string" length="32" optional="false"/>
-      <access op="invoke" privilege="manage"/>
-    </command>    
+      <arg id="0" name="CommissioningTimeout" type="int16u"/>
+      <arg id="1" name="PAKEPasscodeVerifier" type="octet_string"/>
+      <arg id="2" name="Discriminator" type="int16u" min="0" max="4095"/>
+      <arg id="3" name="Iterations" type="int32u" min="1000" max="100000"/>
+      <arg id="4" name="Salt" type="octet_string" length="32" minLength="16"/>
+    </command>
 
-    <event code="0x00" name="CommissioningRequestResult" priority="info" side="server" optional="false">
+    <event code="0x00" name="CommissioningRequestResult" priority="info" side="server" isFabricSensitive="true">
       <description>This event SHALL be sent by the server following a RequestCommissioningApproval command which the server responded to with SUCCESS.</description>
-      <field id="0" name="RequestId" type="int64u" optional="false"/>
-      <field id="1" name="ClientNodeId" type="node_id" optional="false"/>
-      <field id="2" name="StatusCode" type="enum8" optional="false"/>       
+      <field id="0" name="RequestId" type="int64u"/>
+      <field id="1" name="ClientNodeId" type="node_id"/>
+      <field id="2" name="StatusCode" type="enum8"/>
+      <access op="read" privilege="manage"/>
     </event>
 
   </cluster>

src/app/zap_cluster_list.json

@@ -23,6 +23,7 @@
         "CHANNEL_CLUSTER": [],
         "CLIENT_MONITORING_CLUSTER": [],
         "COLOR_CONTROL_CLUSTER": [],
+        "COMMISSIONER_CONTROL_CLUSTER_CLUSTER": [],
         "COMMISSIONING_CLUSTER": [],
         "CONTENT_LAUNCHER_CLUSTER": [],
         "CONTENT_CONTROL_CLUSTER": [],
@@ -168,6 +169,7 @@
         ],
         "CHANNEL_CLUSTER": ["channel-server"],
         "COLOR_CONTROL_CLUSTER": ["color-control-server"],
+        "COMMISSIONER_CONTROL_CLUSTER_CLUSTER": [],
         "COMMISSIONING_CLUSTER": [],
         "CONTENT_LAUNCHER_CLUSTER": ["content-launch-server"],
         "CONTENT_CONTROL_CLUSTER": ["content-control-server"],

src/controller/data_model/controller-clusters.matter

@@ -9135,20 +9135,21 @@ provisional cluster ContentAppObserver = 1296 {
 }
 
 /** Supports the ability for clients to request the commissioning of themselves or other nodes onto a fabric which the cluster server can commission onto. */
-cluster CommissionerControl = 1873 {
-  revision 1; // NOTE: Default/not specifically set
+provisional cluster CommissionerControl = 1873 {
+  revision 1;
 
   bitmap SupportedDeviceCategoryBitmap : bitmap32 {
     kFabricSynchronization = 0x1;
   }
 
-  info event CommissioningRequestResult = 0 {
+  fabric_sensitive info event access(read: manage) CommissioningRequestResult = 0 {
     int64u requestId = 0;
     node_id clientNodeId = 1;
     enum8 statusCode = 2;
+    fabric_idx fabricIndex = 254;
   }
 
-  readonly attribute SupportedDeviceCategoryBitmap supportedDeviceCategories = 0;
+  readonly attribute access(read: manage) SupportedDeviceCategoryBitmap supportedDeviceCategories = 0;
   readonly attribute command_id generatedCommandList[] = 65528;
   readonly attribute command_id acceptedCommandList[] = 65529;
   readonly attribute event_id eventList[] = 65530;
@@ -9160,7 +9161,7 @@ cluster CommissionerControl = 1873 {
     int64u requestId = 0;
     vendor_id vendorId = 1;
     int16u productId = 2;
-    optional char_string label = 3;
+    optional char_string<64> label = 3;
   }
 
   request struct CommissionNodeRequest {

src/controller/java/generated/java/chip/devicecontroller/ChipEventStructs.java

@@ -5950,25 +5950,30 @@ public static class CommissionerControlClusterCommissioningRequestResultEvent {
   public Long requestId;
   public Long clientNodeId;
   public Integer statusCode;
+  public Integer fabricIndex;
   private static final long REQUEST_ID_ID = 0L;
   private static final long CLIENT_NODE_ID_ID = 1L;
   private static final long STATUS_CODE_ID = 2L;
+  private static final long FABRIC_INDEX_ID = 254L;
 
   public CommissionerControlClusterCommissioningRequestResultEvent(
     Long requestId,
     Long clientNodeId,
-    Integer statusCode
+    Integer statusCode,
+    Integer fabricIndex
   ) {
     this.requestId = requestId;
     this.clientNodeId = clientNodeId;
     this.statusCode = statusCode;
+    this.fabricIndex = fabricIndex;
   }
 
   public StructType encodeTlv() {
     ArrayList<StructElement> values = new ArrayList<>();
     values.add(new StructElement(REQUEST_ID_ID, new UIntType(requestId)));
     values.add(new StructElement(CLIENT_NODE_ID_ID, new UIntType(clientNodeId)));
     values.add(new StructElement(STATUS_CODE_ID, new UIntType(statusCode)));
+    values.add(new StructElement(FABRIC_INDEX_ID, new UIntType(fabricIndex)));
 
     return new StructType(values);
   }
@@ -5980,6 +5985,7 @@ public static CommissionerControlClusterCommissioningRequestResultEvent decodeTl
     Long requestId = null;
     Long clientNodeId = null;
     Integer statusCode = null;
+    Integer fabricIndex = null;
     for (StructElement element: ((StructType)tlvValue).value()) {
       if (element.contextTagNum() == REQUEST_ID_ID) {
         if (element.value(BaseTLVType.class).type() == TLVType.UInt) {
@@ -5996,12 +6002,18 @@ public static CommissionerControlClusterCommissioningRequestResultEvent decodeTl
           UIntType castingValue = element.value(UIntType.class);
           statusCode = castingValue.value(Integer.class);
         }
+      } else if (element.contextTagNum() == FABRIC_INDEX_ID) {
+        if (element.value(BaseTLVType.class).type() == TLVType.UInt) {
+          UIntType castingValue = element.value(UIntType.class);
+          fabricIndex = castingValue.value(Integer.class);
+        }
       }
     }
     return new CommissionerControlClusterCommissioningRequestResultEvent(
       requestId,
       clientNodeId,
-      statusCode
+      statusCode,
+      fabricIndex
     );
   }
 
@@ -6018,6 +6030,9 @@ public String toString() {
     output.append("\tstatusCode: ");
     output.append(statusCode);
     output.append("\n");
+    output.append("\tfabricIndex: ");
+    output.append(fabricIndex);
+    output.append("\n");
     output.append("}\n");
     return output.toString();
   }

src/controller/java/generated/java/chip/devicecontroller/cluster/eventstructs/CommissionerControlClusterCommissioningRequestResultEvent.kt

@@ -26,12 +26,14 @@ class CommissionerControlClusterCommissioningRequestResultEvent(
   val requestId: ULong,
   val clientNodeId: ULong,
   val statusCode: UInt,
+  val fabricIndex: UInt,
 ) {
   override fun toString(): String = buildString {
     append("CommissionerControlClusterCommissioningRequestResultEvent {\n")
     append("\trequestId : $requestId\n")
     append("\tclientNodeId : $clientNodeId\n")
     append("\tstatusCode : $statusCode\n")
+    append("\tfabricIndex : $fabricIndex\n")
     append("}\n")
   }
 
@@ -41,6 +43,7 @@ class CommissionerControlClusterCommissioningRequestResultEvent(
       put(ContextSpecificTag(TAG_REQUEST_ID), requestId)
       put(ContextSpecificTag(TAG_CLIENT_NODE_ID), clientNodeId)
       put(ContextSpecificTag(TAG_STATUS_CODE), statusCode)
+      put(ContextSpecificTag(TAG_FABRIC_INDEX), fabricIndex)
       endStructure()
     }
   }
@@ -49,6 +52,7 @@ class CommissionerControlClusterCommissioningRequestResultEvent(
     private const val TAG_REQUEST_ID = 0
     private const val TAG_CLIENT_NODE_ID = 1
     private const val TAG_STATUS_CODE = 2
+    private const val TAG_FABRIC_INDEX = 254
 
     fun fromTlv(
       tlvTag: Tag,
@@ -58,13 +62,15 @@ class CommissionerControlClusterCommissioningRequestResultEvent(
       val requestId = tlvReader.getULong(ContextSpecificTag(TAG_REQUEST_ID))
       val clientNodeId = tlvReader.getULong(ContextSpecificTag(TAG_CLIENT_NODE_ID))
       val statusCode = tlvReader.getUInt(ContextSpecificTag(TAG_STATUS_CODE))
+      val fabricIndex = tlvReader.getUInt(ContextSpecificTag(TAG_FABRIC_INDEX))
 
       tlvReader.exitContainer()
 
       return CommissionerControlClusterCommissioningRequestResultEvent(
         requestId,
         clientNodeId,
         statusCode,
+        fabricIndex,
       )
     }
   }

src/controller/java/generated/java/matter/controller/cluster/eventstructs/CommissionerControlClusterCommissioningRequestResultEvent.kt

@@ -26,12 +26,14 @@ class CommissionerControlClusterCommissioningRequestResultEvent(
   val requestId: ULong,
   val clientNodeId: ULong,
   val statusCode: UByte,
+  val fabricIndex: UByte,
 ) {
   override fun toString(): String = buildString {
     append("CommissionerControlClusterCommissioningRequestResultEvent {\n")
     append("\trequestId : $requestId\n")
     append("\tclientNodeId : $clientNodeId\n")
     append("\tstatusCode : $statusCode\n")
+    append("\tfabricIndex : $fabricIndex\n")
     append("}\n")
   }
 
@@ -41,6 +43,7 @@ class CommissionerControlClusterCommissioningRequestResultEvent(
       put(ContextSpecificTag(TAG_REQUEST_ID), requestId)
       put(ContextSpecificTag(TAG_CLIENT_NODE_ID), clientNodeId)
       put(ContextSpecificTag(TAG_STATUS_CODE), statusCode)
+      put(ContextSpecificTag(TAG_FABRIC_INDEX), fabricIndex)
       endStructure()
     }
   }
@@ -49,6 +52,7 @@ class CommissionerControlClusterCommissioningRequestResultEvent(
     private const val TAG_REQUEST_ID = 0
     private const val TAG_CLIENT_NODE_ID = 1
     private const val TAG_STATUS_CODE = 2
+    private const val TAG_FABRIC_INDEX = 254
 
     fun fromTlv(
       tlvTag: Tag,
@@ -58,13 +62,15 @@ class CommissionerControlClusterCommissioningRequestResultEvent(
       val requestId = tlvReader.getULong(ContextSpecificTag(TAG_REQUEST_ID))
       val clientNodeId = tlvReader.getULong(ContextSpecificTag(TAG_CLIENT_NODE_ID))
       val statusCode = tlvReader.getUByte(ContextSpecificTag(TAG_STATUS_CODE))
+      val fabricIndex = tlvReader.getUByte(ContextSpecificTag(TAG_FABRIC_INDEX))
 
       tlvReader.exitContainer()
 
       return CommissionerControlClusterCommissioningRequestResultEvent(
         requestId,
         clientNodeId,
         statusCode,
+        fabricIndex,
       )
     }
   }