uic: zpc: UIC-3274: CRC16 Encapsulation

[Philippe Coval]

Took over change and fixed typos

Origin: projects/UIC/repos/uic/pull-requests/2851/overview
Thanks-to: Aydogan Ersoz <Aydogan.Ersoz@silabs.com>
cherry picked from commit 86dd2bba208fc85f256b451a8b7cb9d9b4acea98)
Last-update: 2025-01-10
Forwarded: #11
Signed-off-by: Philippe Coval <philippe.coval@silabs.com>

Author: silabs-borisl

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

@@ -561,6 +561,10 @@ DEFINE_ATTRIBUTE(ATTRIBUTE_COMMAND_CLASS_CONFIGURATION_PARAMETERS_TO_DISCOVER,
 /// zwave_cc_version_t
 DEFINE_ATTRIBUTE(ATTRIBUTE_COMMAND_CLASS_CRC16_VERSION,
                  ((COMMAND_CLASS_CRC_16_ENCAP << 8) | 0x01))
+// Flag to disable CRC16 response if necessary (default is enabled)
+// Should not be used (unless with some faulty devices)
+DEFINE_ATTRIBUTE(ATTRIBUTE_COMMAND_CLASS_CRC16_DISABLE_CRC16,
+                 ((COMMAND_CLASS_CRC_16_ENCAP << 8) | 0x02))
 
 /////////////////////////////////////////////////
 // Device Reset Locally Command Class

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

@@ -32,6 +32,8 @@
 #include "zwave_command_class_wake_up_types.h"
 #include "attribute_store_defined_attribute_types.h"
 
+#include "attribute_store.h"
+
 /**
  * @ingroup zpc_utils
  * @{
@@ -214,12 +216,22 @@ zwave_cc_version_t
                                        zwave_endpoint_id_t endpoint_id);
 
 /**
+ * @brief Get endpoint node associated with the ZWave NodeID and Endpoint ID
+ * 
+ * @param node_id       The Z-Wave NodeID for which we want to find the endpoint
+ * @param endpoint_id   The Z-Wave Endpoint ID for which we want to find the endpoint
+ * 
+ * @returns The attribute store node associated with the endpoint.
+ */
+attribute_store_node_t zwave_get_endpoint_node(zwave_node_id_t node_id,
+                                               zwave_endpoint_id_t endpoint_id);
+  /**
  * @brief Verify if we registered a node as supporting S2.
  *
  * @param node_id             The NodeID that supports S2.
  * @returns True if the node has been registered to support S2, false otherwise
  */
-bool zwave_security_validation_is_node_s2_capable(zwave_node_id_t node_id);
+  bool zwave_security_validation_is_node_s2_capable(zwave_node_id_t node_id);
 
 /**
  * @brief Sets a node as S2 capable, meaning that we know it supports S2,

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

@@ -192,6 +192,7 @@ static const std::vector<attribute_schema_t> attribute_schema = {
   // Device Reset Locally Command Class attributes
   /////////////////////////////////////////////////////////////////////
   {ATTRIBUTE_COMMAND_CLASS_CRC16_VERSION,   "CRC16 Version",   ATTRIBUTE_ENDPOINT_ID,   U8_STORAGE_TYPE},
+  {ATTRIBUTE_COMMAND_CLASS_CRC16_DISABLE_CRC16, "Disable CRC16 frames", ATTRIBUTE_ENDPOINT_ID, U8_STORAGE_TYPE},
   /////////////////////////////////////////////////////////////////////
   // Inclusion Controller Command Class attributes
   /////////////////////////////////////////////////////////////////////

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

@@ -359,10 +359,8 @@ zwave_cc_version_t
                                        zwave_node_id_t node_id,
                                        zwave_endpoint_id_t endpoint_id)
 {
-  unid_t node_unid;
-  zwave_unid_from_node_id(node_id, node_unid);
   attribute_store_node_t endpoint_node
-    = attribute_store_network_helper_get_endpoint_node(node_unid, endpoint_id);
+    = zwave_get_endpoint_node(node_id, endpoint_id);
 
   if (endpoint_node == ATTRIBUTE_STORE_INVALID_NODE) {
     return 0;
@@ -378,6 +376,16 @@ zwave_cc_version_t
   return version;
 }
 
+attribute_store_node_t zwave_get_endpoint_node(zwave_node_id_t node_id,
+                                               zwave_endpoint_id_t endpoint_id)
+{
+  unid_t node_unid;
+  zwave_unid_from_node_id(node_id, node_unid);
+  return attribute_store_network_helper_get_endpoint_node(node_unid,
+                                                          endpoint_id);
+
+}
+
 bool zwave_security_validation_is_node_s2_capable(zwave_node_id_t node_id)
 {
   attribute_store_node_t node_id_node

applications/zpc/components/zwave/zwave_transports/CMakeLists.txt

@@ -11,6 +11,7 @@ target_link_libraries(
   PUBLIC zwave_controller
          zwave_tx
          zwave_rx
+         zwave_crc16
          zwave_s0
          zwave_s2
          zwave_api_transport
@@ -21,6 +22,7 @@ target_link_libraries(
          zwave_tx_scheme_selector)
 install(TARGETS zwave_transports LIBRARY DESTINATION lib)
 
+add_subdirectory(crc16)
 add_subdirectory(s0)
 add_subdirectory(s2)
 add_subdirectory(multi_channel)

applications/zpc/components/zwave/zwave_transports/crc16/CMakeLists.txt

@@ -0,0 +1,18 @@
+# Library
+add_library(zwave_crc16
+  src/zwave_crc16_transport.c
+)
+
+target_include_directories(zwave_crc16
+  PUBLIC include
+)
+
+target_link_libraries(zwave_crc16
+  PUBLIC zwave_controller unify
+  PRIVATE zpc_attribute_store zwave_command_classes
+)
+
+if(BUILD_TESTING)
+  #target_add_mock(zwave_crc16)
+  add_subdirectory(test)
+endif()

applications/zpc/components/zwave/zwave_transports/crc16/include/zwave_crc16_transport.h

@@ -0,0 +1,61 @@
+/******************************************************************************
+ * # License
+ * <b>Copyright 2024 Silicon Laboratories Inc. www.silabs.com</b>
+ ******************************************************************************
+ * The licensor of this software is Silicon Laboratories Inc. Your use of this
+ * software is governed by the terms of Silicon Labs Master Software License
+ * Agreement (MSLA) available at
+ * www.silabs.com/about-us/legal/master-software-license-agreement. This
+ * software is distributed to you in Source Code format and is governed by the
+ * sections of the MSLA applicable to Source Code.
+ *
+ *****************************************************************************/
+
+/**
+ * @defgroup zwave_crc16_transport CRC16 Transport
+ * @ingroup zwave_transports
+ * @brief Transport for CRC16
+ *
+ * @{
+ */
+
+#ifndef ZWAVE_CRC_16_TRANSPORT_H
+#define ZWAVE_CRC_16_TRANSPORT_H
+
+#include "sl_status.h"
+#include "zwave_node_id_definitions.h"
+
+// We allow to encapsulate the maximum minus our encapsulation command overhead
+#define CRC_16_ENCAPSULATION_HEADER 2
+#define CRC_16_ENCAPSULATION_FOOTER 2
+#define CRC_16_ENCAPSULATION_OVERHEAD (CRC_16_ENCAPSULATION_HEADER + CRC_16_ENCAPSULATION_FOOTER)
+
+#define CRC_16_ENCAPSULATED_COMMAND_MAXIMUM_SIZE \
+  (ZWAVE_MAX_FRAME_SIZE - CRC_16_ENCAPSULATION_OVERHEAD)
+
+typedef struct zwave_crc16_encapsulation_frame {
+  uint8_t command_class; /* The command class */
+  uint8_t command;       /* The command */
+  uint8_t encapsulated_command
+    [CRC_16_ENCAPSULATED_COMMAND_MAXIMUM_SIZE]; /* The checksum will be appended to the command*/
+/* Encapsulated command */
+} zwave_crc16_encapsulation_frame_t;
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Initialize the CRC16 Transport
+ * *
+ * @returns SL_STATUS_OK if successful
+ * @returns SL_STATUS_FAIL if an error occurred
+ */
+sl_status_t zwave_crc16_transport_init(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif  //ZWAVE_CRC_16_TRANSPORT_H
+/** @} end zwave_crc16_transport */