Wi-SUN node init API change

Added regulatory domain as mandatory parameter.
Support for setting regulatory domain without
changing default mode and class

Author: Mika Tervonen

nanostack/ws_management_api.h

@@ -67,20 +67,27 @@ extern "C" {
 #define CHANNEL_FUNCTION_FIXED            0x00 // Fixed channel
 #define CHANNEL_FUNCTION_TR51CF           0x01 // TR51CF
 #define CHANNEL_FUNCTION_DH1CF            0x02 // Direct Hash
-#define CHANNEL_FUNCTION_VENDOR_DEFINED   0x03 // Direct Hash
+#define CHANNEL_FUNCTION_VENDOR_DEFINED   0x03 // vendor given channel hop schedule
 
 #define CHANNEL_SPACING_200 0x00 // 200 khz
 #define CHANNEL_SPACING_400 0x01 // 400 khz
 #define CHANNEL_SPACING_600 0x02 // 600 khz
 #define CHANNEL_SPACING_100 0x03 // 100 khz
 #define CHANNEL_SPACING_250 0x04 // 250 khz
 
+
+/** Temporary API change flag. this will be removed when new version of API is implemented on applications
+ *
+ */
+#define WS_MANAGEMENT_API_VER_2
+
 /**
  * Initialize Wi-SUN stack.
  *
  * Generates the default configuration for Wi-SUN operation
  *
  * \param interface_id Network interface ID.
+ * \param regulatory_domain Mandatory regulatory domain value of the device.
  * \param network_name_ptr Network name where to join if no configuration found from storage.
  * \param fhss_timer_ptr FHSS functions for timer adaptation to platform.
  *
@@ -89,6 +96,7 @@ extern "C" {
  */
 int ws_management_node_init(
     int8_t interface_id,
+    uint8_t regulatory_domain,
     char *network_name_ptr,
     fhss_timer_t *fhss_timer_ptr);
 
@@ -102,6 +110,8 @@ int ws_management_node_init(
  * Operating class: (1), (2)
  * operation mode: "1b" (symbol rate 50, modulation index 1)
  *
+ * if value of 255 is given then previous value is used.
+ *
  * \param interface_id Network interface ID.
  * \param regulatory_domain FHSS regulatory domain default to "KR" 0x09.
  * \param operating_class FHSS operating class default to 1.

source/6LoWPAN/ws/ws_common.c

@@ -114,7 +114,11 @@ int8_t ws_common_regulatory_domain_config(protocol_interface_info_entry_t *cur)
             return -1;
         }
     } else if(cur->ws_info->hopping_schdule.regulatory_domain == REG_DOMAIN_WW) {
-        if(cur->ws_info->hopping_schdule.operating_class == 2) {
+        if(cur->ws_info->hopping_schdule.operating_class == 1) {
+            cur->ws_info->hopping_schdule.ch0_freq = 24002;
+            cur->ws_info->hopping_schdule.channel_spacing = CHANNEL_SPACING_200;
+            cur->ws_info->hopping_schdule.number_of_channels = (uint8_t)416; // TODO we dont support this yet, but it is used as test value
+        } else if(cur->ws_info->hopping_schdule.operating_class == 2) {
             cur->ws_info->hopping_schdule.ch0_freq = 24004;
             cur->ws_info->hopping_schdule.channel_spacing = CHANNEL_SPACING_400;
             cur->ws_info->hopping_schdule.number_of_channels = 207;

source/6LoWPAN/ws/ws_empty_functions.c

@@ -29,10 +29,12 @@
 #ifndef HAVE_WS
 int ws_management_node_init(
     int8_t interface_id,
+    uint8_t regulatory_domain,
     char *network_name_ptr,
     fhss_timer_t *fhss_timer_ptr)
 {
     (void)interface_id;
+    (void)regulatory_domain;
     (void)network_name_ptr;
     (void)fhss_timer_ptr;
     return -1;

source/6LoWPAN/ws/ws_management_api.c

@@ -33,6 +33,7 @@
 
 int ws_management_node_init(
     int8_t interface_id,
+    uint8_t regulatory_domain,
     char *network_name_ptr,
     fhss_timer_t *fhss_timer_ptr)
 {
@@ -45,6 +46,11 @@ int ws_management_node_init(
     if (!network_name_ptr || !fhss_timer_ptr) {
         return -2;
     }
+    cur->ws_info->hopping_schdule.regulatory_domain = regulatory_domain;
+    if (ws_common_regulatory_domain_config(cur) < 0) {
+        // Invalid regulatory domain set
+        return -3;
+    }
     strncpy(cur->ws_info->network_name,network_name_ptr,32);
     cur->ws_info->fhss_timer_ptr = fhss_timer_ptr;
     return 0;
@@ -68,9 +74,15 @@ int ws_management_regulatory_domain_set(
     regulatory_domain_saved = cur->ws_info->hopping_schdule.regulatory_domain;
     operating_class_saved = cur->ws_info->hopping_schdule.operating_mode;
     operating_mode_saved = cur->ws_info->hopping_schdule.operating_class;
-    cur->ws_info->hopping_schdule.regulatory_domain = regulatory_domain;
-    cur->ws_info->hopping_schdule.operating_mode = operating_mode;
-    cur->ws_info->hopping_schdule.operating_class = operating_class;
+    if (regulatory_domain != 255) {
+        cur->ws_info->hopping_schdule.regulatory_domain = regulatory_domain;
+    }
+    if (operating_mode != 255) {
+        cur->ws_info->hopping_schdule.operating_mode = operating_mode;
+    }
+    if (operating_class != 255) {
+        cur->ws_info->hopping_schdule.operating_class = operating_class;
+    }
     if (ws_common_regulatory_domain_config(cur) != 0) {
         // Restore old config on failure
         //tr_error("unsupported regulatory domain: %d class: %d, mode: %d", regulatory_domain, operating_class, operating_mode);

test/nanostack/unittest/6LoWPAN/ws_management_api/test_ws_management_api.c

@@ -22,6 +22,7 @@
 #include "nsdynmemLIB.h"
 #include "NWK_INTERFACE/Include/protocol.h"
 #include "6LoWPAN/ws/ws_common.h"
+#include "ws_management_api.h"
 
 /* Stubs */
 #include "protocol_core_stub.h"
@@ -37,38 +38,48 @@ bool test_ws_management_node_init()
     memset(&entry, 0, sizeof(protocol_interface_info_entry_t));
     memset(&ws_info_entry, 0, sizeof(ws_info_t));
     memset(&fhss_timer_entry, 0, sizeof(fhss_timer_t));
+    ws_common_stub.int8_value = 0;
+
 
     /* No interface info entry found */
-    if (-1 != ws_management_node_init(1, NULL, NULL)) {
+    if (-1 != ws_management_node_init(1, 3, NULL, NULL)) {
         return false;
     }
 
     protocol_core_stub.entry_ptr = &entry;
 
     /* No ws_info found */
-    if (-1 != ws_management_node_init(1, NULL, NULL)) {
+    if (-1 != ws_management_node_init(1, 3, NULL, NULL)) {
         return false;
     }
 
     entry.ws_info = &ws_info_entry;
 
     /* NULL pointers as a parameters */
-    if (-2 != ws_management_node_init(1, NULL, NULL)) {
+    if (-2 != ws_management_node_init(1, 3, NULL, NULL)) {
         return false;
     }
 
     /* NULL pointers as a FHSS info */
-    if (-2 != ws_management_node_init(1, nw_name, NULL)) {
+    if (-2 != ws_management_node_init(1, 3, nw_name, NULL)) {
         return false;
     }
 
     /* NULL pointers as a network name */
-    if (-2 != ws_management_node_init(1, NULL, fhss_timer_entry)) {
+    if (-2 != ws_management_node_init(1, 3, NULL, &fhss_timer_entry)) {
+        return false;
+    }
+
+    // Invalid regulatory domain
+    ws_common_stub.int8_value = -1;
+    if (-3 != ws_management_node_init(1, 43, nw_name, &fhss_timer_entry)) {
         return false;
     }
 
     /* OK case */
-    if (0 != ws_management_node_init(1, nw_name, fhss_timer_entry)) {
+    ws_common_stub.int8_value = 0;
+
+    if (0 != ws_management_node_init(1, 3, nw_name, &fhss_timer_entry)) {
         return false;
     }
 
@@ -159,21 +170,21 @@ bool test_ws_management_channel_plan_set()
     protocol_core_stub.entry_ptr = NULL;
 
     /* No protocol info entry */
-    if (-1 != ws_management_channel_plan_set(1,0,0,0,0,0)) {
+    if (-1 != ws_management_channel_plan_set(1,0,0,0,0,0,0)) {
         return false;
     }
 
     protocol_core_stub.entry_ptr = &entry;
 
     /* No ws_info found */
-    if (-1 != ws_management_channel_plan_set(1,0,0,0,0,0)) {
+    if (-1 != ws_management_channel_plan_set(1,0,0,0,0,0,0)) {
         return false;
     }
 
     entry.ws_info = &ws_info_entry;
 
     /* OK case */
-    if (0 != ws_management_channel_plan_set(1,0,0,0,0,0)) {
+    if (0 != ws_management_channel_plan_set(1,0,0,0,0,0,0)) {
         return false;
     }
 
@@ -225,29 +236,29 @@ bool test_ws_management_fhss_channel_function_configure()
 
     protocol_core_stub.entry_ptr = NULL;
 
-    if (-1 != ws_management_fhss_unicast_channel_function_configure(1,10))
+    if (-1 != ws_management_fhss_unicast_channel_function_configure(1,10,0,0))
     {
         return false;
     }
     protocol_core_stub.entry_ptr = &entry;
 
-    if (-1 != ws_management_fhss_unicast_channel_function_configure(1,10))
+    if (-1 != ws_management_fhss_unicast_channel_function_configure(1,10,0,0))
     {
         return false;
     }
     entry.ws_info = &ws_info_entry;
-    if (-2 != ws_management_fhss_unicast_channel_function_configure(1,10))
+    if (-2 != ws_management_fhss_unicast_channel_function_configure(1,10,0,0))
     {
         return false;
     }
 
     entry.lowpan_info = 0;
-    if (0 != ws_management_fhss_unicast_channel_function_configure(1,0))
+    if (0 != ws_management_fhss_unicast_channel_function_configure(1,0,0,0))
     {
         return false;
     }
     entry.lowpan_info = INTERFACE_NWK_ACTIVE;
-    if (0 != ws_management_fhss_unicast_channel_function_configure(1,0))
+    if (0 != ws_management_fhss_unicast_channel_function_configure(1,0,0,0))
     {
         return false;
     }