FHSS unit tests: Removed FHSS common functions from FHSS

Author: Jarkko Paso

source/Service_Libs/fhss/fhss.c

@@ -86,7 +86,7 @@ fhss_structure_t *fhss_enable(fhss_api_t *fhss_api, const fhss_configuration_t *
 
     if (fhss_beacon_create_tasklet(fhss_struct) < 0) {
         ns_dyn_mem_free(fhss_struct->bs);
-        ns_dyn_mem_free(fhss_struct);
+        fhss_free_instance(fhss_api);
         return NULL;
     }
 
@@ -680,7 +680,7 @@ static int fhss_add_beacon_info(fhss_structure_t *fhss_structure, uint16_t pan_i
     return 0;
 }
 
-void fhss_update_beacon_info_lifetimes(fhss_structure_t *fhss_structure, uint32_t timestamp)
+static void fhss_update_beacon_info_lifetimes(fhss_structure_t *fhss_structure, uint32_t timestamp)
 {
     fhss_beacon_info_t *beacon_info;
     beacon_info = fhss_structure->bs->fhss_beacon_info_store;
@@ -737,7 +737,7 @@ static void fhss_failed_list_free(fhss_structure_t *fhss_structure)
     }
 }
 
-static void fhss_handle_state_set(const fhss_api_t *api, fhss_states fhss_state, uint16_t pan_id)
+static void fhss_synch_state_set_callback(const fhss_api_t *api, fhss_states fhss_state, uint16_t pan_id)
 {
     fhss_structure_t *fhss_structure = fhss_get_object_with_api(api);
     if (!fhss_structure) {
@@ -1008,7 +1008,7 @@ static bool fhss_check_tx_conditions_callback(const fhss_api_t *api, bool is_bro
 {
     fhss_structure_t *fhss_structure = fhss_get_object_with_api(api);
     if (!fhss_structure) {
-        return false;
+        return true;
     }
     // This condition will check that message is not sent on bad channel
     if (fhss_check_bad_channel(fhss_structure, handle) == false) {
@@ -1095,8 +1095,8 @@ static void fhss_beacon_build(fhss_structure_t *fhss_structure, uint8_t* dest)
 static int16_t fhss_write_synch_info_callback(const fhss_api_t *api, uint8_t *ptr, uint8_t length, int frame_type, uint32_t tx_time)
 {
     (void) length;
-    fhss_structure_t *fhss_structure = fhss_get_object_with_api(api);
     (void) tx_time;
+    fhss_structure_t *fhss_structure = fhss_get_object_with_api(api);
     if (!fhss_structure || !ptr || (frame_type != FHSS_SYNCH_FRAME)) {
         return -1;
     }
@@ -1234,7 +1234,7 @@ static bool fhss_is_broadcast_channel_callback(const fhss_api_t *api)
 {
     fhss_structure_t *fhss_structure = fhss_get_object_with_api(api);
     if (!fhss_structure) {
-        return false;
+        return true;
     }
     // FHSS is unsynchronized, broadcasts allowed
     if (fhss_structure->fhss_state == FHSS_UNSYNCHRONIZED) {
@@ -1325,7 +1325,7 @@ int fhss_set_callbacks(fhss_structure_t *fhss_structure)
     fhss_structure->fhss_api->receive_frame = &fhss_receive_frame_callback;
     fhss_structure->fhss_api->data_tx_done = &fhss_data_tx_done_callback;
     fhss_structure->fhss_api->data_tx_fail = &fhss_data_tx_fail_callback;
-    fhss_structure->fhss_api->synch_state_set = &fhss_handle_state_set;
+    fhss_structure->fhss_api->synch_state_set = &fhss_synch_state_set_callback;
     fhss_structure->fhss_api->read_timestamp = &fhss_read_timestamp_cb;
     fhss_structure->fhss_api->get_retry_period = &fhss_get_retry_period_callback;
     fhss_structure->fhss_api->write_synch_info = &fhss_write_synch_info_callback;

source/Service_Libs/fhss/fhss.h

@@ -123,7 +123,6 @@ struct fhss_bs
 
 fhss_structure_t *fhss_enable(fhss_api_t *fhss_api, const fhss_configuration_t *fhss_configuration, const fhss_timer_t *fhss_timer, fhss_statistics_t *fhss_statistics);
 bool fhss_is_synch_root(fhss_structure_t *fhss_structure);
-void fhss_update_beacon_info_lifetimes(fhss_structure_t *fhss_structure, uint32_t timestamp);
 uint32_t fhss_get_tx_time(fhss_structure_t *fhss_structure, uint16_t bytes_to_send, uint8_t phy_header_length, uint8_t phy_tail_length);
 /**
  * Calculate time in microseconds to start of next superframe.

test/nanostack/unittest/mac/mac_mcps_sap/test_mac_mcps_sap.c

@@ -458,6 +458,7 @@ bool test_mcps_sap_trig_tx()
     rf_mac_setup->active_mac_events &= ~(1 << MAC_SAP_TRIG_TX);
 
     // FHSS is on broadcast channel and tx conditions are fine
+    fhss_config_stub.bool_value = true;
     fhss_tx_condition = true;
 
     mcps_sap_trig_tx(rf_mac_setup);
@@ -1901,6 +1902,7 @@ bool test_mac_mcps_data_indication()
 
      // Test calling FHSS receive synch request
      rf_mac_setup->fhss_api = ns_fhss_create(0, 0);
+     int start_value = fhss_config_stub.int8_value;
      mac_header_helper_functions_stub.uint8_value = MAC_BEACON_REQ;
      nsdynmemlib_stub.returnCounter = 2;
      buffer =  mcps_sap_pre_parsed_frame_buffer_get(tx_buf, 18);
@@ -1914,6 +1916,9 @@ bool test_mac_mcps_data_indication()
      test_mac_buffer_init(buffer, 7, 1, 6);
      buffer->mac_class_ptr = rf_mac_setup;
      mcps_sap_pd_ind(buffer);
+     if (start_value != (fhss_config_stub.int8_value - 1)) {
+         return false;
+     }
 
      test_mac_rf_mac_class_free(rf_mac_setup);
      return true;
@@ -2070,6 +2075,7 @@ bool test_mcps_sap_pd_req_queue_write()
     // Buffer has broadcast destination and TX conditions are bad
     buffer->fcf_dsn.ackRequested = false;
     fhss_tx_condition = false;
+    fhss_config_stub.bool_value_2 = true;
     mcps_sap_pd_req_queue_write(rf_mac_setup, buffer);
     // Should be first in BC queue, one buffer in a bc queue
     if ((rf_mac_setup->pd_data_request_bc_queue_to_go != buffer) || (rf_mac_setup->broadcast_queue_size != 1)) {
@@ -2111,6 +2117,7 @@ bool test_mcps_sap_pd_req_queue_write()
     // Buffer has unicast destination and TX conditions are bad
     buffer->fcf_dsn.ackRequested = true;
     fhss_tx_condition = false;
+    fhss_config_stub.bool_value_2 = false;
     mcps_sap_pd_req_queue_write(rf_mac_setup, buffer);
     // Should be first in a UC queue, 1 buffer in a uc queue
     if ((rf_mac_setup->pd_data_request_queue_to_go != buffer) || (rf_mac_setup->unicast_queue_size != 1)) {
@@ -2143,6 +2150,7 @@ bool test_mcps_sap_pd_req_queue_write()
     // Test queueing when broadcast disable
     buffer->fcf_dsn.ackRequested = false;
     rf_mac_setup->macBroadcastDisabled = true;
+    fhss_config_stub.bool_value_2 = true;
     mcps_sap_pd_req_queue_write(rf_mac_setup, buffer);
     // Should be first in a BC queue, 1 buffer in a BC queue
     if ((rf_mac_setup->pd_data_request_bc_queue_to_go != buffer) || (rf_mac_setup->broadcast_queue_size != 1)) {
@@ -2750,6 +2758,7 @@ bool test_mac_mcps_trig_buffer_from_queue()
     rf_mac_setup->broadcast_queue_size = 1;
 
     // FHSS is not on broadcast channel and tx conditions are fine
+    fhss_config_stub.bool_value = false;
     fhss_tx_condition = true;
     mac_mcps_trig_buffer_from_queue(rf_mac_setup);
     if (!rf_mac_setup->pd_data_request_bc_queue_to_go) {
@@ -2758,6 +2767,7 @@ bool test_mac_mcps_trig_buffer_from_queue()
     }
 
     // FHSS is on broadcast channel and tx conditions are bad
+    fhss_config_stub.bool_value = true;
     fhss_tx_condition = false;
     mac_mcps_trig_buffer_from_queue(rf_mac_setup);
     if (!rf_mac_setup->pd_data_request_bc_queue_to_go) {
@@ -2766,6 +2776,7 @@ bool test_mac_mcps_trig_buffer_from_queue()
     }
 
     // FHSS is on broadcast channel and tx conditions are fine
+    fhss_config_stub.bool_value = true;
     fhss_tx_condition = true;
     mac_mcps_trig_buffer_from_queue(rf_mac_setup);
     if (!rf_mac_setup->active_pd_data_request || rf_mac_setup->pd_data_request_bc_queue_to_go || rf_mac_setup->broadcast_queue_size) {
@@ -2783,6 +2794,7 @@ bool test_mac_mcps_trig_buffer_from_queue()
     rf_mac_setup->pd_data_request_queue_to_go = buf;
     rf_mac_setup->pd_data_request_queue_to_go->next = buf2;
     rf_mac_setup->unicast_queue_size = 2;
+    fhss_config_stub.bool_value = false;
     fhss_tx_condition = true;
     // Should trig second packet from queue
     mac_mcps_trig_buffer_from_queue(rf_mac_setup);

test/nanostack/unittest/mac/mac_pd_sap/test_mac_pd_sap.c

@@ -551,6 +551,7 @@ bool test_mac_pd_sap_data_cb()
     phy_message.id = MAC15_4_PD_SAP_DATA_IND;
     phy_message.message.generic_data_ind.data_ptr = buffer;
     // Test returning timestamp
+    fhss_config_stub.uint32_value = 1234567890;
     ret = mac_pd_sap_data_cb(&rf_ptr, &phy_message);
     if (ret != 0) {
         return false;

test/nanostack/unittest/mac/sw_mac/Makefile

@@ -17,6 +17,7 @@ TEST_SRC_FILES = \
         ../../stub/mac_pd_sap_stub.c \
         ../../stub/mac_mcps_sap_stub.c \
         ../../stub/fhss_callbacks_stub.c \
+        ../../stub/fhss_config_stub.c \
         ../../stub/ns_timer_stub.c \
         ../../stub/common_functions_stub.c \
 

test/nanostack/unittest/mac/sw_mac/test_sw_mac.c

@@ -32,6 +32,7 @@
 #include "mac_mlme_stub.h"
 #include "mac_security_mib_stub.h"
 #include "mac_mcps_sap_stub.h"
+#include "fhss_config_stub.h"
 
 #define C_CHECK(condition) \
   do { if (!(condition)) { printf("ERROR: %s at file %s on line %d\n", #condition, __FILE__, __LINE__); return false; } } while(0)
@@ -802,7 +803,7 @@ bool test_ns_sw_mac_fhss_register()
     mac_description_storage_size_t storage_sizes;
     protocol_interface_rf_mac_setup_s setup;
     memset(&setup, 0, sizeof(protocol_interface_rf_mac_setup_s));
-//    fhss_api.init_callbacks = &fhss_init_callbacks_cb;
+    fhss_api.init_callbacks = &fhss_init_callbacks_cb_stub;
 
     phy_device_driver_s drv;
     memset(&drv, 0, sizeof(phy_device_driver_s));

test/nanostack/unittest/service_libs/fhss/Makefile

@@ -5,16 +5,13 @@ COMPONENT_NAME = fhss_unit
 #This must be changed manually
 SRC_FILES = \
         ../../../../../source/Service_Libs/fhss/fhss.c \
-        ../../../../../source/Service_Libs/fhss/fhss_common.c \
-
 
 TEST_SRC_FILES = \
 	main.cpp \
         fhsstest.cpp \
         test_fhss.c \
         ../../stub/mbed_trace_stub.c \
         ../../stub/nsdynmemLIB_stub.c \
-        ../../stub/common_functions_stub.c \
         ../../stub/channel_list_stub.c \
         ../../stub/fhss_config_stub.c \
         ../../stub/fhss_channel_stub.c \
@@ -25,6 +22,7 @@ TEST_SRC_FILES = \
         ../../stub/randLIB_stub.c \
         ../../stub/event_stub.c \
         ../../stub/fhss_callbacks_stub.c \
+        ../../stub/fhss_common_stub.c \
         ../../stub/ns_list_stub.c \
         ../../stub/platform_stub.c \
 

test/nanostack/unittest/service_libs/fhss/fhsstest.cpp

@@ -29,73 +29,67 @@ TEST_GROUP(fhss)
     }
 };
 
-TEST(fhss, test_fhss_timeout_stop)
-{
-    CHECK(test_fhss_timeout_stop());
-}
-
-TEST(fhss, test_fhss_timeout_start)
+TEST(fhss, test_fhss_enable)
 {
-    CHECK(test_fhss_timeout_start());
+    CHECK(test_fhss_enable());
 }
 
-
-TEST(fhss, test_fhss_update_synch_parent_address)
+TEST(fhss, test_fhss_is_broadcast_channel_callback)
 {
-    CHECK(test_fhss_update_synch_parent_address());
+    CHECK(test_fhss_is_broadcast_channel_callback());
 }
 
-TEST(fhss, test_fhss_compare_with_synch_parent_address)
+TEST(fhss, test_fhss_tx_handle_callback)
 {
-    CHECK(test_fhss_compare_with_synch_parent_address());
+    CHECK(test_fhss_tx_handle_callback());
 }
 
-TEST(fhss, test_fhss_get_parent_address)
+TEST(fhss, test_fhss_check_tx_conditions_callback)
 {
-    CHECK(test_fhss_get_parent_address());
+    CHECK(test_fhss_check_tx_conditions_callback());
 }
 
-TEST(fhss, test_fhss_set_datarate)
+TEST(fhss, test_fhss_receive_frame_callback)
 {
-    CHECK(test_fhss_set_datarate());
+    CHECK(test_fhss_receive_frame_callback());
 }
 
-TEST(fhss, test_fhss_set_synch_configuration)
+TEST(fhss, test_fhss_data_tx_done_callback)
 {
-    CHECK(test_fhss_set_synch_configuration());
+    CHECK(test_fhss_data_tx_done_callback());
 }
 
-TEST(fhss, test_fhss_disable)
+TEST(fhss, test_fhss_data_tx_fail_callback)
 {
-    CHECK(test_fhss_disable());
+    CHECK(test_fhss_data_tx_fail_callback());
 }
 
-TEST(fhss, test_fhss_enable)
+TEST(fhss, test_fhss_synch_state_set_callback)
 {
-    CHECK(test_fhss_enable());
+    CHECK(test_fhss_synch_state_set_callback());
 }
 
-TEST(fhss, test_fhss_clear_active_event)
+TEST(fhss, test_fhss_write_synch_info_callback)
 {
-    CHECK(test_fhss_clear_active_event());
+    CHECK(test_fhss_write_synch_info_callback());
 }
 
-TEST(fhss, test_fhss_update_beacon_info_lifetimes)
+TEST(fhss, test_fhss_superframe_handler)
 {
-    CHECK(test_fhss_update_beacon_info_lifetimes());
+    CHECK(test_fhss_superframe_handler());
 }
 
-TEST(fhss, test_fhss_is_synch_root)
+TEST(fhss, test_fhss_get_retry_period_callback)
 {
-    CHECK(test_fhss_is_synch_root());
+    CHECK(test_fhss_get_retry_period_callback());
 }
 
-TEST(fhss, test_fhss_tx_handle_callback)
+TEST(fhss, test_fhss_beacon_tasklet_func)
 {
-    CHECK(test_fhss_tx_handle_callback());
+    CHECK(test_fhss_beacon_tasklet_func());
 }
 
-TEST(fhss, test_fhss_check_tx_conditions_callback)
+TEST(fhss, test_fhss_set_synch_configuration)
 {
-    CHECK(test_fhss_check_tx_conditions_callback());
+    CHECK(test_fhss_set_synch_configuration());
 }