Fhss ut improvements (ARMmbed#1622)

* FHSS unit tests: Removed unnecessary TODO comment

* FHSS unit tests: Test written ufsi field in synch info

Author: Jarkko Paso

test/nanostack/unittest/service_libs/fhss_common/test_fhss_common.c

@@ -266,7 +266,7 @@ bool test_fhss_use_broadcast_queue_cb()
 
 bool test_fhss_read_timestamp_cb()
 {
-    fhss_platform_stub.uint32_value = 100000;
+    fhss_platform_stub.timestamp_value = 100000;
     nsdynmemlib_stub.returnCounter = 1;
     test_set_platform_api(&fhss_timer);
     // Allocate instance
@@ -276,7 +276,7 @@ bool test_fhss_read_timestamp_cb()
         return false;
     }
     // Test success
-    if (fhss_platform_stub.uint32_value != fhss_read_timestamp_cb(&fhss_api)) {
+    if (fhss_platform_stub.timestamp_value != fhss_read_timestamp_cb(&fhss_api)) {
         return false;
     }
     // Free allocated instance

test/nanostack/unittest/service_libs/fhss_ws/Makefile

@@ -13,7 +13,6 @@ TEST_SRC_FILES = \
         test_fhss_ws.c \
         ../../stub/mbed_trace_stub.c \
         ../../stub/nsdynmemLIB_stub.c \
-        ../../stub/common_functions_stub.c \
         ../../stub/channel_list_stub.c \
         ../../stub/channel_functions_stub.c \
         ../../stub/fhss_stub.c \

test/nanostack/unittest/service_libs/fhss_ws/test_fhss_ws.c

@@ -28,7 +28,6 @@
 #include "fhss_callbacks_stub.h"
 #include "fhss_platform_stub.h"
 #include "channel_functions_stub.h"
-#include "common_functions_stub.h"
 
 #define VENDOR_CHANNEL          89
 #define DEFAULT_CHANNEL         99
@@ -50,6 +49,22 @@ static fhss_api_t fhss_api;
 static fhss_ws_t ws;
 static fhss_ws_neighbor_timing_info_t neighbor_info;
 
+uint16_t common_read_16_bit_inverse(const uint8_t data_buf[__static 2])
+{
+    uint16_t temp_16;
+    temp_16 = *data_buf++;
+    temp_16 += (uint16_t)(*data_buf++) << 8;
+    return temp_16;
+}
+
+uint8_t *common_write_24_bit_inverse(uint_fast24_t value, uint8_t ptr[__static 3])
+{
+    *ptr++ = value;
+    *ptr++ = value >> 8;
+    *ptr++ = value >> 16;
+    return ptr;
+}
+
 static int32_t app_channel_function(const fhss_api_t *api, uint16_t slot, uint8_t eui64[8], uint16_t bsi, uint16_t number_of_channels)
 {
     return VENDOR_CHANNEL;
@@ -77,6 +92,17 @@ static void enable_fhss_struct(void)
     fhss_common_stub.bool_value = true;
 }
 
+static bool test_ufsi(uint8_t *ufsi_ptr, uint_fast24_t test_value)
+{
+    uint_fast24_t ufsi =  *ufsi_ptr++;
+    ufsi += (uint_fast24_t)(*ufsi_ptr++) << 8;
+    ufsi += (uint_fast24_t)(*ufsi_ptr++) << 16;
+    if (test_value != ufsi) {
+        return false;
+    }
+    return true;
+}
+
 static void test_set_platform_api(fhss_timer_t *fhss_timer)
 {
     fhss_timer->fhss_resolution_divider = 1;
@@ -97,6 +123,7 @@ static fhss_api_t *test_generate_fhss_api(void)
     neighbor_info.uc_timing_info.utt_rx_timestamp = 100000;
     fhss_common_stub.fhss_struct.fhss_api = &fhss_api;
     fhss_common_stub.fhss_struct.ws = &ws;
+    fhss_common_stub.fhss_struct.ws->uc_slot = 3;
     fhss_common_stub.fhss_struct.ws->fhss_configuration.fhss_uc_dwell_interval = 200;
     fhss_common_stub.fhss_struct.ws->fhss_configuration.fhss_bc_dwell_interval = 250;
     fhss_common_stub.fhss_struct.ws->fhss_configuration.fhss_broadcast_interval = 1000;
@@ -195,7 +222,7 @@ bool test_fhss_ws_tx_handle_callback()
     /* Test TR51 channel function
      * Dest. slot:     | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 |
      *                 |dest. ufsi|     900ms        |
-     * timestamps:    100000us|             1000000us|
+     * timestamps:        100000us|         1000000us|
      */
     fhss_common_stub.fhss_struct.ws->fhss_configuration.ws_channel_function = WS_TR51CF;
     if ((fhss_common_stub.fhss_struct.fhss_api->tx_handle(api, DEFAULT_IS_BC_DEST, dest_address, DEFAULT_FRAME_TYPE, DEFAULT_FRAME_LENGTH, DEFAULT_PHY_HEAD_LENGTH, DEFAULT_PHY_TAIL_LENGTH, DEFAULT_TX_TIME) != 0)
@@ -243,8 +270,6 @@ bool test_fhss_ws_tx_handle_callback()
         return false;
     }
 
-    // TODO: Test own_ceil with decimal number
-
     return true;
 }
 
@@ -340,13 +365,31 @@ bool test_fhss_ws_write_synch_info_callback()
     if (fhss_common_stub.fhss_struct.fhss_api->write_synch_info(api, synch_info, sizeof(synch_info), FHSS_SYNCH_FRAME, DEFAULT_TX_TIME) != -1) {
         return false;
     }
-    // Test when IE element not found
-    common_functions_stub.uint16_value = 0;
-    if (fhss_common_stub.fhss_struct.fhss_api->write_synch_info(api, synch_info, sizeof(synch_info), DEFAULT_FRAME_TYPE, DEFAULT_TX_TIME) != 0) {
+    fhss_platform_stub.remaining_slots_value = 100000;
+    fhss_common_stub.uint32_value = 1000000;
+    /* Test the UFSI field in synch info
+     * slot:           |               0(200ms)        |               1(200ms)        |               2(200ms)        |               3(200ms)        |
+     *                 |                      ufsi(597ms) -> 1001599                                                  |
+     * timestamps:                                                                written at 1000000us|TX at 1097000us|
+     */
+    if ((fhss_common_stub.fhss_struct.fhss_api->write_synch_info(api, synch_info, sizeof(synch_info), DEFAULT_FRAME_TYPE, fhss_common_stub.uint32_value + 97000) != 0)
+            || (test_ufsi(&synch_info[11], 1001599) != true)) {
         return false;
     }
-    // Test when IE element found
-    common_functions_stub.uint16_value = 0x1505;
+    // Test when timestamp overflows
+    fhss_common_stub.uint32_value = 4294960000;
+    /* Test the UFSI field in synch info
+     * slot:           |               0(200ms)        |               1(200ms)        |               2(200ms)        |               3(200ms)        |
+     *                 |                      ufsi(597ms) -> 1001599                                                  |
+     * timestamps:                                                             written at 4294960000us|  TX at 89704us|
+     */
+    if ((fhss_common_stub.fhss_struct.fhss_api->write_synch_info(api, synch_info, sizeof(synch_info), DEFAULT_FRAME_TYPE, fhss_common_stub.uint32_value + 97000) != 0)
+            || (test_ufsi(&synch_info[11], 1001599) != true)) {
+        return false;
+    }
+
+    // Test when IE element not found
+    memset(synch_info, 0, sizeof(synch_info));
     if (fhss_common_stub.fhss_struct.fhss_api->write_synch_info(api, synch_info, sizeof(synch_info), DEFAULT_FRAME_TYPE, DEFAULT_TX_TIME) != 0) {
         return false;
     }

test/nanostack/unittest/stub/fhss_platform_stub.c

@@ -25,12 +25,12 @@ fhss_platform_stub_def fhss_platform_stub;
 
 uint32_t fhss_get_remaining_slots_stub(struct fhss_api *fhss_api)
 {
-    return fhss_platform_stub.uint32_value;
+    return fhss_platform_stub.remaining_slots_value;
 }
 
 uint32_t fhss_get_timestamp_stub(struct fhss_api *fhss_api)
 {
-    return fhss_platform_stub.uint32_value;
+    return fhss_platform_stub.timestamp_value;
 }
 
 int fhss_timer_stop_stub(struct fhss_api *fhss_api)

test/nanostack/unittest/stub/fhss_platform_stub.h

@@ -23,7 +23,8 @@ extern "C" {
 
 typedef struct {
     bool channel_bool_value;
-    uint32_t uint32_value;
+    uint32_t timestamp_value;
+    uint32_t remaining_slots_value;
     uint8_t address[8];
     int int_value;
 } fhss_platform_stub_def;