uic: zpc: Pull request #2913: SWPROT-8900 zpc bulk changes for s2v2

Merge in UIC/uic from feature/UIC-3590-zpc-bulk-changes-for-s2v2 to develop

(cherry picked from commit 7cbdd551af3ab85e87662a67b3864c464532b961)
Last-Update: 2025-01-31
Forwarded: #11
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>

Author: silabs-aydogane

applications/zpc/components/ucl_mqtt/src/zpc_node_state.cpp

@@ -49,7 +49,7 @@ static sl_status_t ucl_node_state_discover_neighbors_command(
   dotdot_endpoint_id_t endpoint,
   uic_mqtt_dotdot_callback_call_type_t callback_type)
 {
-  if (true == is_zpc_unid(unid)) {
+  if (is_zpc_unid(unid)) {
     return SL_STATUS_NOT_SUPPORTED;
   }
 
@@ -90,7 +90,7 @@ static sl_status_t ucl_node_state_remove_offline_command(
   dotdot_endpoint_id_t endpoint,
   uic_mqtt_dotdot_callback_call_type_t callback_type)
 {
-  if (true == is_zpc_unid(unid)) {
+  if (is_zpc_unid(unid)) {
     return SL_STATUS_NOT_SUPPORTED;
   }
 
@@ -132,7 +132,7 @@ static sl_status_t ucl_node_state_interview_command(
   dotdot_endpoint_id_t endpoint,
   uic_mqtt_dotdot_callback_call_type_t callback_type)
 {
-  if (true == is_zpc_unid(unid)) {
+  if (is_zpc_unid(unid)) {
     return SL_STATUS_NOT_SUPPORTED;
   }
 
@@ -170,7 +170,7 @@ static sl_status_t ucl_node_state_discover_security_command(
   dotdot_endpoint_id_t endpoint,
   uic_mqtt_dotdot_callback_call_type_t callback_type)
 {
-  if (true == is_zpc_unid(unid)) {
+  if (is_zpc_unid(unid)) {
     return SL_STATUS_NOT_SUPPORTED;
   }
 
@@ -199,6 +199,48 @@ static sl_status_t ucl_node_state_discover_security_command(
                                                    : SL_STATUS_NOT_SUPPORTED;
 }
 
+/**
+ * @brief Performs an enable NLS operation for a Unid/Endpoint
+ *
+ * @param unid          UNID of the node to attempt to enable NLS
+ * @param endpoint      Endpoint of the node. The State topic does not support
+ *                      endpoints so this variable will be ignored.
+ *                      is performed on a NodeID level, as all endpoints share the same radio.
+ * @param callback_type  Dotdot MQTT Callback type
+ *
+ * @returns SL_STATUS_OK/SL_STATUS_FAIL to indicate support if callback_type is set to UIC_MQTT_DOTDOT_CALLBACK_TYPE_SUPPORT_CHECK
+ * sl_status_t code indicating the outcome of applying the command if callback_type is set to UIC_MQTT_DOTDOT_CALLBACK_TYPE_NORMAL
+*/
+static sl_status_t ucl_node_state_enable_nls_command(
+  const dotdot_unid_t unid,
+  dotdot_endpoint_id_t endpoint,
+  uic_mqtt_dotdot_callback_call_type_t callback_type)
+{
+  if (is_zpc_unid(unid)) {
+    return SL_STATUS_NOT_SUPPORTED;
+  }
+
+  if (UIC_MQTT_DOTDOT_CALLBACK_TYPE_SUPPORT_CHECK == callback_type) {
+    // Enable NLS always supported unless the node is offline/unavailable
+    NodeStateNetworkStatus network_status = unify_attribute_store_node_state_get_status(
+      attribute_store_network_helper_get_node_id_node(unid)
+    );
+
+    sl_status_t support = SL_STATUS_OK;
+    if ((network_status == ZCL_NODE_STATE_NETWORK_STATUS_OFFLINE)
+        || (network_status == ZCL_NODE_STATE_NETWORK_STATUS_UNAVAILABLE)) {
+      support = SL_STATUS_FAIL;
+    }
+    return support;
+  }
+
+  zwave_node_id_t node_id = 0x00;
+  if (SL_STATUS_OK == zwave_unid_to_node_id(unid, &node_id)) {
+    return zwave_store_nls_state(node_id, true, DESIRED_ATTRIBUTE);
+  }
+  return SL_STATUS_OK;
+}
+
 ///////////////////////////////////////////////////////////////////////////////
 // Init function shared with the component.
 //////////////////////////////////////////////////////////////////////////////
@@ -216,5 +258,8 @@ sl_status_t zpc_node_state_init()
   uic_mqtt_dotdot_state_discover_security_callback_set(
     &ucl_node_state_discover_security_command);
 
+  uic_mqtt_dotdot_state_enable_nls_callback_set(
+    &ucl_node_state_enable_nls_command);
+
   return SL_STATUS_OK;
 }

applications/zpc/components/ucl_mqtt/test/zpc_node_state_test.c

@@ -48,6 +48,9 @@ static uic_mqtt_dotdot_state_interview_callback_t interview_command = NULL;
 static uic_mqtt_dotdot_state_discover_security_callback_t
   discover_security_command
   = NULL;
+static uic_mqtt_dotdot_state_enable_nls_callback_t
+  enable_nls_command
+  = NULL;
 
 // Stub functions
 static void uic_mqtt_dotdot_state_remove_offline_callback_set_stub(
@@ -78,6 +81,13 @@ static void uic_mqtt_dotdot_state_discover_security_callback_set_stub(
   discover_security_command = callback;
 }
 
+static void uic_mqtt_dotdot_state_enable_nls_callback_set_stub(
+  const uic_mqtt_dotdot_state_enable_nls_callback_t callback,
+  int cmock_num_calls)
+{
+  enable_nls_command = callback;
+}
+
 /// Setup the test suite (called once before all test_xxx functions are called)
 void suiteSetUp()
 {
@@ -102,6 +112,7 @@ void setUp()
   discover_neighbors_command = NULL;
   interview_command          = NULL;
   discover_security_command  = NULL;
+  enable_nls_command         = NULL;
 
   // Always respond with HomeID / NodeID from the simulated network
   zwave_network_management_get_node_id_IgnoreAndReturn(zpc_node_id);
@@ -123,6 +134,9 @@ void setUp()
   uic_mqtt_dotdot_state_discover_security_callback_set_Stub(
     uic_mqtt_dotdot_state_discover_security_callback_set_stub);
 
+  uic_mqtt_dotdot_state_enable_nls_callback_set_Stub(
+    uic_mqtt_dotdot_state_enable_nls_callback_set_stub);
+
   // Call init
   TEST_ASSERT_EQUAL(SL_STATUS_OK, zpc_node_state_init());
 
@@ -131,6 +145,7 @@ void setUp()
   TEST_ASSERT_NOT_NULL(discover_neighbors_command);
   TEST_ASSERT_NOT_NULL(interview_command);
   TEST_ASSERT_NOT_NULL(discover_security_command);
+  TEST_ASSERT_NOT_NULL(enable_nls_command);
 }
 
 /// Called after each and every test

applications/zpc/components/zpc_attribute_store/include/attribute_store_defined_attribute_types.h

@@ -107,6 +107,10 @@ DEFINE_ATTRIBUTE(ATTRIBUTE_ZWAVE_GENERIC_DEVICE_CLASS, 0x0104)
 DEFINE_ATTRIBUTE(ATTRIBUTE_ZWAVE_SPECIFIC_DEVICE_CLASS, 0x0105)
 ///< This represent a zwave_key_protocol_combination_t
 DEFINE_ATTRIBUTE(ATTRIBUTE_ZWAVE_KEY_AND_PROTOCOL_TO_DISCOVER, 0x0106)
+/** This represents whether a Z-Wave node/endpoint supports NLS. */
+DEFINE_ATTRIBUTE(ATTRIBUTE_ZWAVE_NLS_SUPPORT, 0x0107)
+/** This represents whether a Z-Wave node/endpoint has NLS enabled. */
+DEFINE_ATTRIBUTE(ATTRIBUTE_ZWAVE_NLS_STATE, 0x0108)
 
 // Generic attributes that can be placed anywhere under an endpoint.
 /** This indicates if more reports are expected to "complete" the value of an attribute */

applications/zpc/components/zpc_attribute_store/include/zwave_utils.h

@@ -30,6 +30,7 @@
 #include "zwave_keyset_definitions.h"
 #include "zwave_command_class_version_types.h"
 #include "zwave_command_class_wake_up_types.h"
+#include "attribute_store_defined_attribute_types.h"
 
 /**
  * @ingroup zpc_utils
@@ -45,6 +46,66 @@
 extern "C" {
 #endif
 
+/**
+ * @brief Returns whether a node supports Network Layer Security (NLS)
+ *
+ * It will search for the node in the Attribute store and deduct its NLS support
+ * from the ATTRIBUTE_ZWAVE_NLS_SUPPORT
+ * attribute stored under the NodeID.
+ *
+ * @param node_id The NodeID for which the NLS support is requested
+ * @param value_state The value state to look for
+ * 
+ * @returns
+ * - true if the node/endpoint supports NLS
+ * - false if the node/endpoint does not support NLS
+ */
+bool zwave_get_nls_support(zwave_node_id_t node_id, attribute_store_node_value_state_t value_state);
+
+/**
+ * @brief Returns whether a node has Network Layer Security (NLS) enabled
+ *
+ * It will search for the node in the Attribute store and deduct its NLS state
+ * from the ATTRIBUTE_ZWAVE_NLS_STATE
+ * attribute stored under the NodeID.
+ *
+ * @param node_id The NodeID for which the NLS state is requested
+ * @param value_state The value state to look for
+ * 
+ * @returns
+ * - true if the node/endpoint has NLS enabled
+ * - false if the node/endpoint has NLS disabled
+ */
+bool zwave_get_nls_state(zwave_node_id_t node_id, attribute_store_node_value_state_t value_state);
+
+/**
+ * @brief Stores Network Layer Security (NLS) support for a NodeID in the attribute store.
+ *
+ * @param node_id                 The NodeID for which the NLS support
+ *                                must be saved in the attribute store
+ * @param is_nls_supported        NLS support
+ * @param value_state             The value state to store
+ * 
+ * @returns SL_STATUS_OK on success, any other code if not successful.
+ */
+sl_status_t zwave_store_nls_support(zwave_node_id_t node_id,
+                                    bool is_nls_supported,
+                                    attribute_store_node_value_state_t value_state);
+
+/**
+ * @brief Stores Network Layer Security (NLS) state for a NodeID in the attribute store.
+ *
+ * @param node_id                 The NodeID for which the NLS state
+ *                                must be saved in the attribute store
+ * @param is_nls_enabled          NLS state
+ * @param value_state             The value state to store
+ * 
+ * @returns SL_STATUS_OK on success, any other code if not successful.
+ */
+sl_status_t zwave_store_nls_state(zwave_node_id_t node_id,
+                                  bool is_nls_enabled,
+                                  attribute_store_node_value_state_t value_state);
+
 /**
  * @brief Returns the operating mode of a node
  *

applications/zpc/components/zpc_attribute_store/src/zpc_attribute_store_type_registration.cpp

@@ -61,6 +61,8 @@ static const std::vector<attribute_schema_t> attribute_schema = {
   {ATTRIBUTE_ZWAVE_GENERIC_DEVICE_CLASS,   "Generic Device Class",   ATTRIBUTE_ENDPOINT_ID,   U8_STORAGE_TYPE},
   {ATTRIBUTE_ZWAVE_SPECIFIC_DEVICE_CLASS,   "Specific Device Class",   ATTRIBUTE_ENDPOINT_ID,   U8_STORAGE_TYPE},
   {ATTRIBUTE_ZWAVE_KEY_AND_PROTOCOL_TO_DISCOVER,   "Network Key / Protocol to probe",   ATTRIBUTE_ENDPOINT_ID,   BYTE_ARRAY_STORAGE_TYPE},
+  {ATTRIBUTE_ZWAVE_NLS_SUPPORT,   "NLS support",   ATTRIBUTE_NODE_ID,   U8_STORAGE_TYPE},
+  {ATTRIBUTE_ZWAVE_NLS_STATE,   "NLS state",   ATTRIBUTE_NODE_ID,   U8_STORAGE_TYPE},
   /////////////////////////////////////////////////////////////////////
   //         Generic Z-Wave attributes
   /////////////////////////////////////////////////////////////////////

applications/zpc/components/zpc_attribute_store/src/zwave_utils.c

@@ -27,6 +27,109 @@
 #include "sl_log.h"
 #define LOG_TAG "zwave_utils"
 
+bool zwave_get_nls_support(zwave_node_id_t node_id, attribute_store_node_value_state_t value_state)
+{
+  attribute_store_node_t node_id_node
+    = attribute_store_network_helper_get_zwave_node_id_node(node_id);
+
+  attribute_store_node_t node
+    = attribute_store_get_first_child_by_type(node_id_node,
+                                              ATTRIBUTE_ZWAVE_NLS_SUPPORT);
+
+  if (node == ATTRIBUTE_STORE_INVALID_NODE) {
+    return false;
+  }
+
+  uint8_t nls_supported = 0;
+  if (SL_STATUS_OK
+      != attribute_store_read_value(node,
+                                    value_state,
+                                    &nls_supported,
+                                    sizeof(nls_supported))) {
+    return false;
+  }
+
+  return (bool)nls_supported;
+}
+
+bool zwave_get_nls_state(zwave_node_id_t node_id,
+                         attribute_store_node_value_state_t value_state)
+{
+  attribute_store_node_t node_id_node
+    = attribute_store_network_helper_get_zwave_node_id_node(node_id);
+
+  attribute_store_node_t node
+    = attribute_store_get_first_child_by_type(node_id_node,
+                                              ATTRIBUTE_ZWAVE_NLS_STATE);
+
+  if (node == ATTRIBUTE_STORE_INVALID_NODE) {
+    return false;
+  }
+
+  uint8_t nls_enabled = 0;
+  if (SL_STATUS_OK
+      != attribute_store_read_value(node,
+                                    value_state,
+                                    &nls_enabled,
+                                    sizeof(nls_enabled))) {
+    return false;
+  }
+
+  return (bool)nls_enabled;
+}
+
+sl_status_t zwave_store_nls_support(zwave_node_id_t node_id,
+                                    bool is_nls_supported,
+                                    attribute_store_node_value_state_t value_state)
+{
+  uint8_t value = (uint8_t)is_nls_supported;
+
+  attribute_store_node_t node_id_node
+    = attribute_store_network_helper_get_zwave_node_id_node(node_id);
+
+  attribute_store_node_t node
+    = attribute_store_get_first_child_by_type(node_id_node,
+                                              ATTRIBUTE_ZWAVE_NLS_SUPPORT);
+
+  if (node == ATTRIBUTE_STORE_INVALID_NODE) {
+    node = attribute_store_add_node(ATTRIBUTE_ZWAVE_NLS_SUPPORT, node_id_node);
+  }
+
+  if (value_state == DESIRED_ATTRIBUTE) {
+    return attribute_store_set_desired(node, &value, sizeof(value));
+  } else if (value_state == REPORTED_ATTRIBUTE) {
+    return attribute_store_set_reported(node, &value, sizeof(value));
+  } else {
+    return SL_STATUS_NOT_SUPPORTED;
+  }
+}
+
+sl_status_t zwave_store_nls_state(zwave_node_id_t node_id,
+                                  bool is_nls_enabled,
+                                  attribute_store_node_value_state_t value_state)
+{
+  uint8_t value = (uint8_t)is_nls_enabled;
+
+  attribute_store_node_t node_id_node
+    = attribute_store_network_helper_get_zwave_node_id_node(node_id);
+
+  attribute_store_node_t node
+    = attribute_store_get_first_child_by_type(node_id_node,
+                                              ATTRIBUTE_ZWAVE_NLS_STATE);
+
+  if (node == ATTRIBUTE_STORE_INVALID_NODE) {
+    node = attribute_store_add_node(ATTRIBUTE_ZWAVE_NLS_STATE, node_id_node);
+  }
+
+  if (value_state == DESIRED_ATTRIBUTE) {
+    return attribute_store_set_desired(node, &value, sizeof(value));
+  } else if (value_state == REPORTED_ATTRIBUTE) {
+    return attribute_store_set_reported(node, &value, sizeof(value));
+  } else {
+    return SL_STATUS_NOT_SUPPORTED;
+  }
+}
+
 zwave_operating_mode_t zwave_get_operating_mode(zwave_node_id_t node_id)
 {
   attribute_store_node_t node_id_node

applications/zpc/components/zpc_rust/src/rust_command_handlers/zwave_command_classes/zwave_command_class_firmware_update/mod.rs

@@ -78,6 +78,7 @@ where
             is_first_follow_up: false,
             group_id: 0,
             is_test_frame: false,
+            is_protocol_frame: false,
             ignore_incoming_frames_back_off: false,
             rf_power: zwave_tx_sys::rf_power_level_t::NORMAL_POWER,
         },
@@ -971,6 +972,7 @@ fn handle_fwu_md_get(
                 is_first_follow_up: false,
                 group_id: 0,
                 is_test_frame: false,
+                is_protocol_frame: false,
                 ignore_incoming_frames_back_off: false,
                 rf_power: zwave_tx_sys::rf_power_level_t::NORMAL_POWER,
             },