Time configuration distribution using DHCPv6 vendor data

Border router can distribute timezone and day light saving time
configuration to devices joining Wi-SUN network.

New ARM defined vendor extension added to DHCP server

New Time API extension added to all devices to learn new configuration
from network

Author: Mika Tervonen

CHANGELOG.md

@@ -6,6 +6,7 @@
 * Added support for triggering test procedures (e.g. for manually sending DIS, DIO, DAO, PAS, PS, PCS and PC).
 * Added automatic test procedure triggering during bootstrap (PAS, EAPOL target selection, PCS, DIS, RPL parent selection).
 * Added checks for Border Router frame counter space exhaustion.
+* Added Daylight saving time and time zone configuration distribution using DHCPv6 vendor data during address renewal.
 
 ### Changes
 * PAN_TIMEOUT for medium sized network changed to 30 minutes.

nanostack/ns_time_api.h

@@ -28,6 +28,24 @@
 
 #include "ns_types.h"
 
+/**
+ * Time zone information structure.
+ *
+ * Daylight saving time and time zone information learned by network stack
+ *
+ */
+typedef struct timezone_info {
+    /** Timestamp of the Daylight saving time change*/
+    uint64_t timestamp;
+    /** Time zone information in minutes*/
+    int16_t timezone;
+    /** Change that is applied when timestamp is reached*/
+    int16_t deviation;
+    /** Time configuration status bit field
+     * "bit xxxxxxxxxxxxxxxS"       0 = false 1 = true Daylight saving time status*/
+    uint16_t status;
+} timezone_info_t;
+
 /**
  * System time read callback.
  *
@@ -48,6 +66,22 @@ typedef uint64_t ns_time_api_system_time_callback(void);
  */
 typedef void ns_time_api_system_time_write_callback(uint64_t write_time);
 
+/**
+ * New time zone and daylight saving time information learned from stack.
+ *
+ * Called when network stack learns the time zone and daylights saving time information.
+ *
+ * In Wi-SUN Border router can distribute this information to synchronize all nodes in network.
+ *      This information is updated roughly once a day using DHCPv6 protocol
+ *
+ * If network stack does not have the information this is not called and can be called when information becomes available.
+ * This can be called multiple times with same information.
+ *
+ * \param info_ptr time zone and daylight saving time configuration.
+ *
+ */
+typedef void ns_time_api_time_configuration_notify_callback(timezone_info_t *info_ptr);
+
 /**
  * System time read callback set.
  *
@@ -68,4 +102,15 @@ void ns_time_api_system_time_callback_set(ns_time_api_system_time_callback callb
  */
 void ns_time_api_system_time_write_callback_set(ns_time_api_system_time_write_callback callback_wr);
 
+/**
+ * Set system time configuration notify callback.
+ *
+ * Sets system time configuration notify callback that is called if network stack
+ * learns time information from other devices in the network.
+ *
+ * \param callback_wr system time write callback.
+ *
+ */
+void ns_time_api_time_configuration_notify_callback_set(ns_time_api_time_configuration_notify_callback callback_wr);
+
 #endif /* NS_TIME_API_H_ */

nanostack/ws_bbr_api.h

@@ -74,6 +74,20 @@ typedef struct bbr_radius_timing {
     uint8_t radius_retry_count;
 } bbr_radius_timing_t;
 
+/**
+ * \brief Daylights saving time parameters.
+ */
+typedef struct bbr_timezone_configuration {
+    /** Timestamp of the Daylight saving time change*/
+    uint64_t timestamp;
+    /** Time zone information in minutes*/
+    int16_t timezone;
+    /** Change that is applied when timestamp is reached*/
+    int16_t deviation;
+    /** Time configuration status bit field
+     * "bit xxxxxxxxxxxxxxxS"       0 = false 1 = true Daylight saving time status*/
+    uint16_t status;
+} bbr_timezone_configuration_t;
 /**
  * Start backbone border router service.
  *
@@ -521,4 +535,22 @@ int ws_bbr_radius_timing_validate(int8_t interface_id, bbr_radius_timing_t *timi
  */
 int ws_bbr_dns_query_result_set(int8_t interface_id, const uint8_t address[16], char *domain_name_ptr);
 
+/**
+ * \brief A function to set time zone and daylights saving time configuration
+ *
+ * Border router distributes this information in DHCP Reply messages to
+ * all the devices joining to the Wi-SUN mesh network.
+ *
+ * Border router keeps this information until reboot and continues to distribute the information.
+ * If the information is changed the updates are sent to devices in network when they
+ * renew their address. This can take time from 1 to 24 hours
+ *
+ * \param interface_id Network interface ID.
+ * \param daylight_saving_time_ptr daylights saving time configuration. NULL if you want to remove the configuration.
+ *
+ * \return < 0 failure
+ * \return >= 0 success
+ */
+int ws_bbr_timezone_configuration_set(int8_t interface_id, bbr_timezone_configuration_t *daylight_saving_time_ptr);
+
 #endif /* WS_BBR_API_H_ */

source/6LoWPAN/ws/ws_bbr_api.c

@@ -97,6 +97,9 @@ static uint8_t current_global_prefix[16] = {0}; // DHCP requires 16 bytes prefix
 static uint32_t bbr_delay_timer = BBR_CHECK_INTERVAL; // initial delay.
 static uint32_t global_prefix_unavailable_timer = 0; // initial delay.
 
+static bbr_timezone_configuration_t *bbr_time_config = NULL;
+
+
 static rpl_dodag_conf_t rpl_conf = {
     // Lifetime values
     .default_lifetime = 120,
@@ -488,24 +491,32 @@ static uint8_t *ws_bbr_dhcp_server_dynamic_vendor_data_write(int8_t interfaceId,
     // If local time is not available vendor data is not written and data_len is not modified
     (void)interfaceId;
 
-    uint64_t time_read;
+    uint64_t time_read = 0;
 
-    if (0 != ns_time_system_time_read(&time_read)) {
-        return ptr;
-    }
+    ns_time_system_time_read(&time_read);
 
     if (data_len) {
-        *data_len += net_vendor_option_current_time_length();
+        if (time_read) {
+            *data_len += net_vendor_option_current_time_length();
+        }
+        if (bbr_time_config) {
+            *data_len += net_vendor_option_time_configuration_length();
+        }
     }
     if (!ptr) {
         return ptr;
     }
-    time_read += 2208988800; // Time starts now from the 0 era instead of First day of Unix (1 Jan 1970)
+    if (time_read) {
+        time_read += 2208988800; // Time starts now from the 0 era instead of First day of Unix (1 Jan 1970)
 
-    uint32_t era = time_read / (uint64_t)(4294967296);
-    uint32_t timestamp = time_read - (era * (uint64_t)(4294967296));
-    ptr = net_vendor_option_current_time_write(ptr, era, timestamp, 0);
+        uint32_t era = time_read / (uint64_t)(4294967296);
+        uint32_t timestamp = time_read - (era * (uint64_t)(4294967296));
+        ptr = net_vendor_option_current_time_write(ptr, era, timestamp, 0);
+    }
+    if (bbr_time_config) {
+        ptr = net_vendor_option_time_configuration_write(ptr, bbr_time_config->timestamp, bbr_time_config->timezone, bbr_time_config->deviation, bbr_time_config->status);
 
+    }
     return ptr;
 }
 
@@ -1553,3 +1564,32 @@ int ws_bbr_dns_query_result_set(int8_t interface_id, const uint8_t address[16],
     return -1;
 #endif
 }
+
+int ws_bbr_timezone_configuration_set(int8_t interface_id, bbr_timezone_configuration_t *daylight_saving_time_ptr)
+{
+#ifdef HAVE_WS_BORDER_ROUTER
+    (void) interface_id;
+
+    if (!daylight_saving_time_ptr) {
+        // Delete configuration
+        ns_dyn_mem_free(bbr_time_config);
+        bbr_time_config = NULL;
+        return 0;
+    }
+
+    if (!bbr_time_config) {
+        bbr_time_config = ns_dyn_mem_alloc(sizeof(bbr_timezone_configuration_t));
+    }
+
+    if (!bbr_time_config) {
+        return -2;
+    }
+    *bbr_time_config = *daylight_saving_time_ptr;
+
+    return 0;
+#else
+    (void) interface_id;
+    (void) daylight_saving_time_ptr;
+    return -1;
+#endif
+}

source/6LoWPAN/ws/ws_bootstrap.c

@@ -1003,6 +1003,13 @@ static void ws_bootstrap_dhcp_info_notify_cb(int8_t interface, dhcp_option_notif
                         net_dns_query_result_set(interface, address, domain, server_info->life_time);
                     }
                 }
+                if (option_type == ARM_DHCP_VENDOR_DATA_TIME_CONFIGURATION) {
+                    timezone_info_t time_configuration;
+                    if (net_vendor_option_time_configuration_read(options->option.vendor_spesific.data, options->option.vendor_spesific.data_length, &time_configuration.timestamp, &time_configuration.timezone, &time_configuration.deviation, &time_configuration.status)) {
+                        int ret = ns_time_system_timezone_info_notify(&time_configuration);
+                        tr_info("Network Time configuration %s status:%"PRIu16" time stamp: %"PRIu64" deviation: %"PRId16" Time Zone: %"PRId16, ret == 0 ? "notified" : "notify FAILED", time_configuration.status, time_configuration.timestamp, time_configuration.deviation, time_configuration.timezone);
+                    }
+                }
                 if (option_type == ARM_DHCP_VENDOR_DATA_NETWORK_TIME) {
                     // Process ARM Network Time
                     // Get Current time

source/Service_Libs/utils/ns_time.c

@@ -22,6 +22,7 @@
 
 static ns_time_api_system_time_callback *system_time_read_callback = NULL;
 static ns_time_api_system_time_write_callback *system_time_write_callback = NULL;
+static ns_time_api_time_configuration_notify_callback *system_time_configuration_notify_callback = NULL;
 
 void ns_time_api_system_time_callback_set(ns_time_api_system_time_callback callback_rd)
 {
@@ -33,6 +34,11 @@ void ns_time_api_system_time_write_callback_set(ns_time_api_system_time_write_ca
     system_time_write_callback = callback_wr;
 }
 
+void ns_time_api_time_configuration_notify_callback_set(ns_time_api_time_configuration_notify_callback callback_wr)
+{
+    system_time_configuration_notify_callback = callback_wr;
+}
+
 int ns_time_system_time_write(uint64_t time_write)
 {
     if (system_time_write_callback) {
@@ -53,3 +59,13 @@ int ns_time_system_time_read(uint64_t *time_read)
 
     return -1;
 }
+
+int ns_time_system_timezone_info_notify(timezone_info_t *info_ptr)
+{
+    if (system_time_configuration_notify_callback && info_ptr) {
+        system_time_configuration_notify_callback(info_ptr);
+        return 0;
+    }
+
+    return -1;
+}

source/Service_Libs/utils/ns_time.h

@@ -22,6 +22,7 @@
  * \file ns_time.h
  * \brief Nanostack internal time handling API.
  */
+#include "ns_time_api.h"
 
 /**
  * Write new time as a platform time
@@ -51,6 +52,15 @@ int ns_time_system_time_write(uint64_t time_write);
  */
 int ns_time_system_time_read(uint64_t *time_read);
 
-
+/**
+ * Notify Time zone and daylight saving time information
+ *
+ * \param info_ptr time zone information pointer.
+ *
+ * \return 0 in success.
+ * \return <0 in case of errors.
+ *
+ */
+int ns_time_system_timezone_info_notify(timezone_info_t *info_ptr);
 
 #endif /* _NS_TIME_H_ */

source/libDHCPv6/libDHCPv6_vendordata.c

@@ -137,7 +137,7 @@ uint8_t *net_vendor_option_current_time_read(uint8_t *ptr, uint16_t length, int3
     }
 
     option_len = common_read_16_bit(ptr + 2);
-    ptr += 4;
+    ptr += 2 * sizeof(uint16_t);
 
     if (option_len < 3 * sizeof(uint32_t)) {
         // Corrupted as not enough room for fields
@@ -147,11 +147,70 @@ uint8_t *net_vendor_option_current_time_read(uint8_t *ptr, uint16_t length, int3
     if (era) {
         *era = (int32_t)common_read_32_bit(ptr);
     }
+
     if (offset) {
         *offset = common_read_32_bit(ptr + sizeof(uint32_t));
     }
+
     if (fraction) {
-        *fraction = common_read_32_bit(ptr + 2 * sizeof(uint32_t));
+        *fraction = common_read_32_bit(ptr + sizeof(uint32_t) + sizeof(uint32_t));
+    }
+
+    return ptr;
+}
+
+uint16_t net_vendor_option_time_configuration_length(void)
+{
+    return 4 + 1 * sizeof(uint64_t) + 2 * sizeof(int16_t) + 1 * sizeof(uint16_t);
+}
+
+uint8_t *net_vendor_option_time_configuration_write(uint8_t *ptr, uint64_t timestamp, int16_t timezone, int16_t deviation, uint16_t status)
+{
+
+    ptr = common_write_16_bit(ARM_DHCP_VENDOR_DATA_TIME_CONFIGURATION, ptr);
+    ptr = common_write_16_bit(1 * sizeof(uint64_t) + 2 * sizeof(int16_t) + 1 * sizeof(uint16_t), ptr);
+    ptr = common_write_16_bit(status, ptr);
+    ptr = common_write_64_bit(timestamp, ptr);
+    ptr = common_write_16_bit((uint16_t)deviation, ptr);
+    ptr = common_write_16_bit((uint16_t)timezone, ptr);
+    return ptr;
+}
+
+uint8_t *net_vendor_option_time_configuration_read(uint8_t *ptr, uint16_t length, uint64_t *timestamp, int16_t *timezone, int16_t *deviation, uint16_t *status)
+{
+    uint16_t option_len;
+
+    if (length < net_vendor_option_time_configuration_length()) {
+        // Corrupted as there is no room for all fields
+        return 0;
+    }
+
+    if (common_read_16_bit(ptr) != ARM_DHCP_VENDOR_DATA_TIME_CONFIGURATION) {
+        return 0;
+    }
+
+    option_len = common_read_16_bit(ptr + sizeof(uint16_t));
+    ptr += 2 * sizeof(uint16_t);
+
+    if (option_len < 1 * sizeof(uint64_t) + 2 * sizeof(int16_t) + 1 * sizeof(uint16_t)) {
+        // Corrupted as not enough room for fields
+        return 0;
+    }
+
+    if (status) {
+        *status = (uint16_t)common_read_16_bit(ptr);
+    }
+
+    if (timestamp) {
+        *timestamp = common_read_64_bit(ptr + sizeof(uint16_t));
+    }
+
+    if (deviation) {
+        *deviation = (int16_t)common_read_16_bit(ptr + sizeof(uint16_t) + sizeof(uint64_t));
+    }
+
+    if (timezone) {
+        *timezone = (int16_t)common_read_16_bit(ptr + sizeof(uint16_t) + sizeof(uint64_t) + sizeof(uint16_t));
     }
 
     return ptr;

source/libDHCPv6/libDHCPv6_vendordata.h

@@ -66,6 +66,17 @@
  * */
 #define ARM_DHCP_VENDOR_DATA_NETWORK_TIME 298
 
+/* ARM Defined vendor data option to distribute Time configuration
+ *
+ *   uint16_t status        Bit field for status
+ *                              bit 1 Daylight saving time status 0 = false 1 = true
+ *                              Additional bits reserved for future and are ignored on receive
+ *   uint64_t timestamp     Time stamp of the Daylight saving time change
+ *   int16_t deviation      Change that is applied when time stamp is reached
+ *   int16_t timezone       Time zone information in minutes compared to UTC time
+ */
+#define ARM_DHCP_VENDOR_DATA_TIME_CONFIGURATION 299
+
 /* DHCPv6 vendor options to distribute ARM vendor data*/
 
 uint16_t net_dns_option_vendor_option_data_dns_query_length(char *domain);
@@ -78,5 +89,8 @@ uint16_t net_vendor_option_current_time_length(void);
 uint8_t *net_vendor_option_current_time_write(uint8_t *ptr, int32_t era, uint32_t offset, uint32_t fraction);
 uint8_t *net_vendor_option_current_time_read(uint8_t *ptr, uint16_t length, int32_t *era, uint32_t *offset, uint32_t *fraction);
 
+uint16_t net_vendor_option_time_configuration_length(void);
+uint8_t *net_vendor_option_time_configuration_write(uint8_t *ptr, uint64_t timestamp, int16_t timezone, int16_t deviation, uint16_t status);
+uint8_t *net_vendor_option_time_configuration_read(uint8_t *ptr, uint16_t length, uint64_t *timestamp, int16_t *timezone, int16_t *deviation, uint16_t *status);
 
 #endif /* LIBDHCPV6_VENDOR_DATA_H_ */