Merge pull request ARMmbed#1544 from ARMmbed/fhss_headers_refactored

FHSS: refactoring FHSS header files

Author: Jarkko Paso

source/Service_Libs/fhss/channel_functions.h

@@ -14,7 +14,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
+#ifndef CHANNEL_FUNC_H_
+#define CHANNEL_FUNC_H_
 /**
  * @brief Calculate channel table based on TR51 channel function.
  * @param number_of_channels Number of channels in table.
@@ -62,3 +63,5 @@ int32_t dh1cf_get_uc_channel_index(uint16_t slot_number, uint8_t *mac, int16_t n
  * @return Channel index.
  */
 int32_t dh1cf_get_bc_channel_index(uint16_t slot_number, uint16_t bsi, int16_t number_of_channels);
+
+#endif /*CHANNEL_FUNC_H_*/

source/Service_Libs/fhss/fhss.c

@@ -18,8 +18,8 @@
 #include "ns_types.h"
 #include "fhss_api.h"
 #include "fhss_config.h"
-#include "fhss_common.h"
 #include "fhss.h"
+#include "fhss_common.h"
 #include "fhss_channel.h"
 #include "channel_list.h"
 #include "nsdynmemLIB.h"

source/Service_Libs/fhss/fhss.h

@@ -16,16 +16,46 @@
  */
 #ifndef FHSS_H_
 #define FHSS_H_
-
+#include "ns_list.h"
 #define MAX_SCRAMBLE_TABLE_INDEXES  20
 // Lifetime is given as seconds
 #define BEACON_INFO_LIFETIME        600
 // Limits the number of synchronization info messages sent on broadcast channels
 #define MAX_SYNCH_INFOS_PER_CHANNEL_LIST	2
 // FHSS randomly selects the starting superframe for broadcast channel. This defines how many superframes are used for randomization.
 #define NUMBER_OF_BC_START_SUPERFRAMES  3
+#define MAX_FHSS_TIMER_DIVIDER  100
+#define SYNCH_MONITOR_AVG_SAMPLES   5
+
+typedef struct fhss_structure fhss_structure_t;
+typedef struct fhss_beacon_info fhss_beacon_info_t;
+typedef struct fhss_synch_monitor fhss_synch_monitor_s;
+typedef struct fhss_failed_tx fhss_failed_tx_t;
+
+struct fhss_beacon_info
+{
+    uint16_t pan_id;
+    uint8_t source_address[8];
+    uint32_t timestamp;
+    uint8_t synch_info[FHSS_SYNCH_INFO_LENGTH];
+    struct fhss_beacon_info *next;
+};
 
-struct fhss_callback;
+struct fhss_synch_monitor
+{
+    int32_t avg_synch_fix;
+    int avg_synch_fix_counter;
+    int drift_compensation;
+    int channel_counter;
+};
+
+struct fhss_failed_tx
+{
+    uint8_t handle;
+    uint8_t bad_channel;
+    uint8_t retries_done;
+    ns_list_link_t link;
+};
 
 bool fhss_is_synch_root(fhss_structure_t *fhss_structure);
 bool fhss_check_bad_channel(fhss_structure_t *fhss_structure, uint8_t handle);
@@ -43,9 +73,6 @@ void fhss_failed_list_free(fhss_structure_t *fhss_structure);
 int fhss_reset_synch_monitor(fhss_synch_monitor_s *synch_monitor);
 int fhss_set_internal_callbacks(fhss_structure_t *fhss_structure);
 
-#define MAX_FHSS_TIMER_DIVIDER  100
-#define SYNCH_MONITOR_AVG_SAMPLES   5
-
 /**
  * Calculate time in microseconds to start of next superframe.
  *

source/Service_Libs/fhss/fhss_beacon.c

@@ -19,8 +19,8 @@
 #include "nsconfig.h"
 #include "fhss_api.h"
 #include "fhss_config.h"
-#include "fhss_common.h"
 #include "fhss.h"
+#include "fhss_common.h"
 #include "fhss_beacon.h"
 #include "common_functions.h"
 #include <string.h> // memcpy

source/Service_Libs/fhss/fhss_beacon_tasklet.c

@@ -23,8 +23,8 @@
 #include "ns_trace.h"
 #include "fhss_api.h"
 #include "fhss_config.h"
-#include "fhss_common.h"
 #include "fhss.h"
+#include "fhss_common.h"
 #include "fhss_beacon.h"
 #include "fhss_statistics.h"
 #include "fhss_mac_interface.h"

source/Service_Libs/fhss/fhss_channel.c

@@ -18,8 +18,8 @@
 #include "ns_types.h"
 #include "fhss_api.h"
 #include "fhss_config.h"
-#include "fhss_common.h"
 #include "fhss.h"
+#include "fhss_common.h"
 #include "fhss_channel.h"
 #include "fhss_beacon.h"
 #include "channel_list.h"

source/Service_Libs/fhss/fhss_common.c

@@ -19,8 +19,8 @@
 #include "ns_trace.h"
 #include "fhss_api.h"
 #include "fhss_config.h"
-#include "fhss_common.h"
 #include "fhss.h"
+#include "fhss_common.h"
 #include "fhss_ws.h"
 #include "fhss_beacon.h"
 #include "fhss_statistics.h"

source/Service_Libs/fhss/fhss_common.h

@@ -14,43 +14,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-#include "ns_list.h"
+#ifndef FHSS_COMMON_H_
+#define FHSS_COMMON_H_
 #define FHSS_TASKLET_INIT_EVENT             0
 #define FHSS_TIMER_EVENT                    1
 #define FHSS_COMPARE_SYNCH_PARENT           2
 #define FHSS_BROADCAST_CHANNEL              3
 #define FHSS_UPDATE_SYNCH_INFO_STORAGE      4
 
-typedef struct fhss_structure fhss_structure_t;
-struct fhss_ws;
-
-typedef struct fhss_beacon_info
-{
-    uint16_t pan_id;
-    uint8_t source_address[8];
-    uint32_t timestamp;
-    uint8_t synch_info[FHSS_SYNCH_INFO_LENGTH];
-    struct fhss_beacon_info *next;
-}fhss_beacon_info_t;
-
-typedef struct fhss_failed_tx
-{
-    uint8_t handle;
-    uint8_t bad_channel;
-    uint8_t retries_done;
-    ns_list_link_t link;
-}fhss_failed_tx_t;
-
 typedef NS_LIST_HEAD(fhss_failed_tx_t, link) fhss_failed_tx_list_t;
 
-typedef struct
-{
-    int32_t avg_synch_fix;
-    int avg_synch_fix_counter;
-    int drift_compensation;
-    int channel_counter;
-} fhss_synch_monitor_s;
-
 /**
  * @brief Update listening channel.
  * @param fhss_structure FHSS structure.
@@ -120,7 +93,7 @@ struct fhss_structure
     /*Indexes in this table will be used to extend the repeated channel sequence*/
     uint8_t *fhss_scramble_table;
     /** Used to monitor and fix synchronization drift*/
-    fhss_synch_monitor_s synch_monitor;
+    struct fhss_synch_monitor synch_monitor;
     /** Used to drop multiple synch info messages on same broadcast channel*/
     bool beacon_received_on_this_bc_channel;
     /** Timer used for events other than synchronization.*/
@@ -135,7 +108,7 @@ struct fhss_structure
     /* Bit mask for FHSS events pushed to event queue. Prevents pushing same event to queue multiple times*/
     uint8_t active_fhss_events;
     struct fhss_callback callbacks;
-    fhss_beacon_info_t *fhss_beacon_info_store;
+    struct fhss_beacon_info *fhss_beacon_info_store;
     fhss_failed_tx_list_t fhss_failed_tx_list;
     fhss_statistics_t *fhss_stats_ptr;
 
@@ -146,8 +119,7 @@ struct fhss_structure
     fhss_handle_state_set_cb *handle_state_set;    /**< Set FHSS state */
 };
 
-
-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);
+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);
 int fhss_down(fhss_structure_t *fhss_structure);
 int8_t fhss_set_datarate(fhss_structure_t *fhss_structure, uint32_t datarate);
 int8_t fhss_set_synch_configuration(fhss_structure_t *fhss_structure, const fhss_synch_configuration_t *fhss_synch_configuration);
@@ -161,4 +133,6 @@ int fhss_update_synch_parent_address(fhss_structure_t *fhss_structure);
 void fhss_trig_event(fhss_structure_t *fhss_structure, uint8_t event_type);
 int fhss_get_parent_address(fhss_structure_t *fhss_structure, uint8_t *p_addr);
 int fhss_compare_with_synch_parent_address(fhss_structure_t *fhss_structure, const uint8_t *source_addr);
+
 void fhss_superframe_handler(const fhss_api_t *fhss_api, uint16_t delay);
+#endif /*FHSS_COMMON_H_*/

source/Service_Libs/fhss/fhss_configuration_interface.c

@@ -21,8 +21,8 @@
 #include "fhss_config.h"
 #include "net_fhss.h"
 #include "nsdynmemLIB.h"
-#include "Service_Libs/fhss/fhss_common.h"
 #include "Service_Libs/fhss/fhss.h"
+#include "Service_Libs/fhss/fhss_common.h"
 #include "Service_Libs/fhss/fhss_ws.h"
 #include "Service_Libs/fhss/fhss_mac_interface.h"
 #include "ns_trace.h"

source/Service_Libs/fhss/fhss_mac_interface.c

@@ -19,8 +19,8 @@
 #include "ns_types.h"
 #include "fhss_api.h"
 #include "fhss_config.h"
-#include "Service_Libs/fhss/fhss_common.h"
 #include "Service_Libs/fhss/fhss.h"
+#include "Service_Libs/fhss/fhss_common.h"
 #include "Service_Libs/fhss/fhss_ws.h"
 #include "Service_Libs/fhss/fhss_channel.h"
 #include "Service_Libs/fhss/fhss_beacon.h"