NCP Soft-Reset Status Notification from Z/IP GW to Z/IP Clients

Motivation: In some cases, the application layer (like z-ware) really care about the NCP controller's soft reset status report. Especially, the "failed soft-reset status" MUST be sent back to zware, so the user can press the hard reset button the whole system.
- We send the 'soft-reset status report' to the unsolicited destinations (remote IPs + Ports), z-ware must always listen on the unsolicited destination.
- Since there are no specific comamnd in the Z/IP Packet Command class to notify the health check status of the NCP Controller, we implemented a custom COMMAND_ZIP_CONTROLLER_STATUS_REPORT (0x04) with the payload is status bytes (RESET_OK: 0x00; RESET_FAIL: 0xFF)
- So, this new command also requires z-ware (zip clients) must understand and support our custom frame

Fixes: #<ZGW-3450>
Signed-off-by: silabs-tuD <[email protected]>

Author: silabs-tuD

src/CC_NetworkManagement.c

@@ -375,6 +375,20 @@ static int set_conn_to_unsol2(zwave_connection_t*  c)
  }
 }
 
+/**
+ * Set up the connection to be the unsolicited destinations (#1 or #2)
+ */
+bool setup_unsolicited_connection(zwave_connection_t *conn, uint8_t dest_id)
+{
+  bool ret = false;
+  if(dest_id == 1) {
+    ret = set_conn_to_unsol1(conn);
+  } else if(dest_id == 2) {
+    ret = set_conn_to_unsol2(conn);
+  }
+  return ret;
+}
+
 static uint8_t set_unsolicited_as_nm_dest()
 {
   nms.seq = random_rand() & 0xFF;

src/CC_NetworkManagement.h

@@ -674,6 +674,11 @@ void extend_middleware_probe_timeout(void);
  */
 void send_to_both_unsoc_dest(const uint8_t * frame, uint16_t len, ZW_SendDataAppl_Callback_t cbFunc);
 
+/**
+ * Set up the connection to be the unsolicited destinations (#1 or #2)
+ */
+bool setup_unsolicited_connection(zwave_connection_t *conn, uint8_t dest_id);
+
 /* Internal entry function used by the CC_NetworkManagement_queue, this function
  * the same as NetworkManagementCommandHandler but it will not put the command
  * back in the queue.

src/ZW_classcmd_ex.h

@@ -1215,8 +1215,11 @@ typedef struct _ZW_EXTENDED_NODE_ADD_STATUS_1BYTE_FRAME_
 #define COMMAND_CLASS_NO_OPERATION_LR   0x04
 
 
-// Soft Reset Status
-#define COMMAND_ZIP_SOFT_RESET_REPORT   0x04
+// NCP Controller Status
+// We defined a new command (COMMAND_ZIP_CONTROLLER_STATUS_REPORT-0x04) in the COMMAND_CLASS_ZIP (0x23)
+#define COMMAND_ZIP_CONTROLLER_STATUS_REPORT   0x04   
+// Currently, we define for the NCP controller's Soft Reset Status only.
+// Later, we can extend it for other controller status reports like NCP Controller Health Check.
 #define STATUS_SOFT_RESET_OK            0x0
 #define STATUS_SOFT_RESET_FAIL          0xFF
 

src/ZW_udp_server.c

@@ -508,7 +508,7 @@ void ZW_BackupRxConnection(struct uip_udp_conn* new_conn)
 
 void ZW_SendResetReportZIP(uint8_t status)
 {
-  const u8_t reset_rpt_frm[] = {COMMAND_CLASS_ZIP, COMMAND_ZIP_SOFT_RESET_REPORT, status};          
+  const u8_t reset_rpt_frm[] = {COMMAND_CLASS_ZIP, COMMAND_ZIP_CONTROLLER_STATUS_REPORT, status};          
   struct udp_rx_bk_t *cbk;
 
   LOG_PRINTF("ZW_SendResetReportZIP! items: %u\n", list_length(udp_rx_conn_list));
@@ -522,6 +522,37 @@ void ZW_SendResetReportZIP(uint8_t status)
   }
 }
 
+/**
+ * Send NCP Controller Status Report to the given connection.
+ * We've used the form of Z/IP Command Class (0x23), with a new custom COMMAND_ZIP_CONTROLLER_STATUS_REPORT (0x04).
+ * And the payload is the status bytes:
+ * #define STATUS_SOFT_RESET_OK            0x0
+ * #define STATUS_SOFT_RESET_FAIL          0xFF
+ * Note: Currently, this function is only used to send "NCP Controller's Soft Reset Status" via unsolicited destinations.
+ * The frame format is of our custom Z/IP command as below:
+ * +---+---+---+---+---+---+---+---+
+ * | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | Bit
+ * +---+---+---+---+---+---+---+---+
+ * | 0 | 0 | 1 | 0 | 0 | 0 | 1 | 1 | COMMAND_CLASS_ZIP (0x23)
+ * +---+---+---+---+---+---+---+---+
+ * | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | COMMAND_ZIP_CONTROLLER_STATUS_REPORT (0x04)
+ * +---+---+---+---+---+---+---+---+
+ * | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | STATUS_SOFT_RESET_OK (0x00) or STATUS_SOFT_RESET_FAIL (0xFF)
+ * +---+---+---+---+---+---+---+---+
+ */
+void ZW_SendNCPControllerStatusZIP(zwave_connection_t *c, uint8_t status)
+{
+  const u8_t controller_status_frame[] = {COMMAND_CLASS_ZIP, COMMAND_ZIP_CONTROLLER_STATUS_REPORT, status};
+
+  if (c) {
+    struct uip_udp_conn conn = c->conn;
+    DBG_PRINTF("ZW_SendNCPControllerStatusZIP => sending ncp cotroller status from local to remote address\n");
+    uip_udp_print_conn(&conn);
+    LOG_PRINTF("Sending Command_Class_ZIP (0x%2.2x), COMMAND_ZIP_CONTROLLER_STATUS_REPORT (0x%2.2x), status (0x%2.2x) to Unsolicited Destinations\n", controller_status_frame[0], controller_status_frame[1], controller_status_frame[2]);
+    udp_send_wrap(&conn, &controller_status_frame, sizeof(controller_status_frame), NULL, NULL);
+  }
+}
+
 
 void
 ZW_SendDataZIP(zwave_connection_t *c,  const  void *dataptr, u16_t datalen, void

src/ZW_udp_server.h

@@ -234,6 +234,27 @@ void ZW_SendResetReportZIP(uint8_t status);
  */
 void ZW_BackupRxConnInit(void);
 
+
+/**
+ * Send NCP Controller Status Report to the given connection.
+ * We've used the form of Z/IP Command Class (0x23), with a new custom COMMAND_ZIP_CONTROLLER_STATUS_REPORT (0x04).
+ * And the payload is the status bytes:
+ * #define STATUS_SOFT_RESET_OK            0x0
+ * #define STATUS_SOFT_RESET_FAIL          0xFF
+ * Note: Currently, this function is only used to send "NCP Controller's Soft Reset Status" via unsolicited destinations.
+ * The frame format is of our custom Z/IP command as below:
+ * +---+---+---+---+---+---+---+---+
+ * | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | Bit
+ * +---+---+---+---+---+---+---+---+
+ * | 0 | 0 | 1 | 0 | 0 | 0 | 1 | 1 | COMMAND_CLASS_ZIP (0x23)
+ * +---+---+---+---+---+---+---+---+
+ * | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | COMMAND_ZIP_CONTROLLER_STATUS_REPORT (0x04)
+ * +---+---+---+---+---+---+---+---+
+ * | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | STATUS_SOFT_RESET_OK (0x00) or STATUS_SOFT_RESET_FAIL (0xFF)
+ * +---+---+---+---+---+---+---+---+
+ */
+void ZW_SendNCPControllerStatusZIP(zwave_connection_t *c, uint8_t status);
+
 /**
  * This process handles all Z/ZIP UDP communication.
  */

src/transport/ZW_SendDataAppl.c

@@ -16,7 +16,7 @@
 #include "node_queue.h"
 #include "S2_wrap.h"
 #include "S2_multicast_auto.h"
-#include<stdlib.h>
+#include <stdlib.h>
 #include "ZW_transport_api.h"
 #include "ZIP_Router_logging.h"
 #include "zgw_crc.h"
@@ -25,6 +25,8 @@
 #include "ZW_classcmd_ex.h"
 #include "ZW_ZIPApplication.h"
 #include "zip_router_config.h"
+#include "ZW_classcmd.h"
+#include "CC_NetworkManagement.h"
 /*
  * SendData Hierarchy, each, level wraps the previous. A higher level call MUST only call lower level calls.
  *
@@ -701,7 +703,30 @@ void ZW_SendDataAppl_FrameRX_Notify(const ts_param_t *c, const uint8_t* frame, u
   }
 }
 
+/**
+ * Notify the NCP controller status via unsolicited destination(s) (#1 and #2).
+ * @param status  Status code defined in ZW_classcmd_ex.h
+ */
+void notify_ncp_controller_status_via_unsolicited_dest(uint8_t status)
+{
+  // unsolicited connections
+  zwave_connection_t uconn;
+  memset(&uconn, 0, sizeof(zwave_connection_t));
+
+  DBG_PRINTF("Notify NCP soft reset status(%d) via unsolicited dest\n", status);
+  if (uip_is_addr_unspecified(&cfg.unsolicited_dest)
+      && uip_is_addr_unspecified(&cfg.unsolicited_dest2)) {
+     ERR_PRINTF("No Unsolicited Destinations configured\n");
+      return;
+  }
 
+  // Send the report to both unsolicited destinations (#1 and #2)
+  for (int i = 0; i < 2; i++) {
+    if(setup_unsolicited_connection(&uconn, i+1)) {
+      ZW_SendNCPControllerStatusZIP(&uconn, status);
+    }
+  }
+}
 
 PROCESS_THREAD(ZW_SendDataAppl_process, ev, data)
 {
@@ -740,10 +765,12 @@ PROCESS_THREAD(ZW_SendDataAppl_process, ev, data)
             if (ZW_SoftResetWithCheck()) {
               DBG_PRINTF("Soft reset successful!\n");
               process_post(&ZW_SendDataAppl_process, SEND_EVENT_SEND_NEXT_LL, NULL);
-              ZW_SendResetReportZIP(STATUS_SOFT_RESET_OK);
+              //ZW_SendResetReportZIP(STATUS_SOFT_RESET_OK);
+              notify_ncp_controller_status_via_unsolicited_dest(STATUS_SOFT_RESET_OK);
             } else {
               ERR_PRINTF("Soft reset failed\n");
-              ZW_SendResetReportZIP(STATUS_SOFT_RESET_FAIL);
+              //ZW_SendResetReportZIP(STATUS_SOFT_RESET_FAIL);
+              notify_ncp_controller_status_via_unsolicited_dest(STATUS_SOFT_RESET_FAIL);
             }
           }
         }

src/transport/ZW_SendDataAppl.h

@@ -224,6 +224,12 @@ security_scheme_t highest_scheme(uint8_t scheme_mask);
 void ZW_SendDataAppl_FrameRX_Notify(const ts_param_t *p, const uint8_t* frame, uint16_t length);
 
 
+/**
+ * Notify the NCP controller status via unsolicited destination(s) (#1 and #2)
+ * @param status  Status code defined in ZW_classcmd_ex.h
+ */
+void notify_ncp_controller_status_via_unsolicited_dest(uint8_t status);
+
 /** @} */
 
 #endif /* ZW_SENDDATAAPPL_H_ */