LoRA: Code cleanup + doxygen updates

- Internal changes only
- reset function is created to LoRaPHY to reset LoRaMAC parameters with default values
- Doxygen updates for newly created functions

Author: Antti Kauppila

features/lorawan/LoRaWANStack.cpp

@@ -87,21 +87,15 @@ lorawan_status_t LoRaWANStack::set_application_port(uint8_t port)
 LoRaWANStack::LoRaWANStack()
 : _loramac(_lora_time), _lora_phy(_lora_time),
   _device_current_state(DEVICE_STATE_NOT_INITIALIZED), _mac_handlers(NULL),
-  _num_retry(1), _queue(NULL), _duty_cycle_on(MBED_CONF_LORA_DUTY_CYCLE_ON)
+  _num_retry(1), _queue(NULL), _duty_cycle_on(MBED_CONF_LORA_DUTY_CYCLE_ON),
+  _app_port(INVALID_PORT)
 {
 #ifdef MBED_CONF_LORA_APP_PORT
-    // is_port_valid() is not virtual, so we can call it in constructor
     if (is_port_valid(MBED_CONF_LORA_APP_PORT)) {
         _app_port = MBED_CONF_LORA_APP_PORT;
     } else {
         tr_error("User defined port in .json is illegal.");
-        _app_port = INVALID_PORT;
     }
-
-#else
-    // initialize it to INVALID_PORT (255) an illegal port number.
-    // user should set the port
-     _app_port = INVALID_PORT;
 #endif
 
      memset(&_lw_session, 0, sizeof(_lw_session));

features/lorawan/LoRaWANStack.h

@@ -455,10 +455,10 @@ class LoRaWANStack: private mbed::NonCopyable<LoRaWANStack> {
     lorawan_session_t _lw_session;
     loramac_tx_message_t _tx_msg;
     loramac_rx_message_t _rx_msg;
-    uint8_t _app_port;
     uint8_t _num_retry;
     events::EventQueue *_queue;
     bool _duty_cycle_on;
+    uint8_t _app_port;
 
 
 #if defined(LORAWAN_COMPLIANCE_TEST)

features/lorawan/lorastack/mac/LoRaMac.cpp

@@ -1274,21 +1274,7 @@ void LoRaMac::reset_mac_parameters(void)
 
     _params.is_rx_window_enabled = true;
 
-    _params.sys_params.channel_tx_power = lora_phy->get_default_tx_power();
-
-    _params.sys_params.channel_data_rate = lora_phy->get_default_tx_datarate();
-
-    _params.sys_params.rx1_dr_offset = lora_phy->get_default_datarate1_offset();
-
-    _params.sys_params.rx2_channel.frequency = lora_phy->get_default_rx2_frequency();
-
-    _params.sys_params.rx2_channel.datarate = lora_phy->get_default_rx2_datarate();
-
-    _params.sys_params.uplink_dwell_time = lora_phy->get_default_uplink_dwell_time();
-
-    _params.sys_params.max_eirp = lora_phy->get_default_max_eirp();
-
-    _params.sys_params.antenna_gain = lora_phy->get_default_antenna_gain();
+    lora_phy->reset_to_default_values(&_params, false);
 
     _params.is_node_ack_requested = false;
     _params.is_srv_ack_requested = false;
@@ -1632,35 +1618,7 @@ lorawan_status_t LoRaMac::initialize(loramac_primitives_t *primitives,
     _params.timers.aggregated_last_tx_time = 0;
     _params.timers.aggregated_timeoff = 0;
 
-    _params.is_dutycycle_on = lora_phy->duty_cycle_enabled();
-
-    _params.sys_params.channel_tx_power = lora_phy->get_default_tx_power();
-
-    _params.sys_params.channel_data_rate = lora_phy->get_default_tx_datarate();
-
-    _params.sys_params.max_rx_win_time = lora_phy->get_maximum_receive_window_duration();
-
-    _params.sys_params.recv_delay1 = lora_phy->get_window1_receive_delay();
-
-    _params.sys_params.recv_delay2 = lora_phy->get_window2_receive_delay();
-
-    _params.sys_params.join_accept_delay1 = lora_phy->get_window1_join_accept_delay();
-
-    _params.sys_params.join_accept_delay2 = lora_phy->get_window2_join_accept_delay();
-
-    _params.sys_params.rx1_dr_offset = lora_phy->get_default_datarate1_offset();
-
-    _params.sys_params.rx2_channel.frequency = lora_phy->get_default_rx2_frequency();
-
-    _params.sys_params.rx2_channel.datarate = lora_phy->get_default_rx2_datarate();
-
-    _params.sys_params.uplink_dwell_time = lora_phy->get_default_uplink_dwell_time();
-
-    _params.sys_params.downlink_dwell_time = lora_phy->get_default_downlink_dwell_time();
-
-    _params.sys_params.max_eirp = lora_phy->get_default_max_eirp();
-
-    _params.sys_params.antenna_gain = lora_phy->get_default_antenna_gain();
+    lora_phy->reset_to_default_values(&_params, true);
 
     // Init parameters which are not set in function ResetMacParameters
     _params.sys_params.max_sys_rx_error = 10;
@@ -1909,7 +1867,7 @@ lorawan_status_t LoRaMac::mlme_request( loramac_mlme_req_t *mlmeRequest )
 
         if (!lora_phy->verify_nb_join_trials(mlmeRequest->req.join.nb_trials)) {
             // Value not supported, get default
-            _params.max_join_request_trials = lora_phy->get_nb_join_trials(true);
+            _params.max_join_request_trials = MBED_CONF_LORA_NB_TRIALS;
         }
         // Reset variable JoinRequestTrials
         _params.join_request_trial_counter = 0;

features/lorawan/lorastack/mac/LoRaMacChannelPlan.h

@@ -54,7 +54,6 @@ class LoRaMacChannelPlan {
      * Stores pointers to PHY layer MIB subsystem
      *
      * @param phy    pointer to PHY layer
-     * @param mib    pointer to MIB subsystem
      */
     void activate_channelplan_subsystem(LoRaPHY *phy);
 
@@ -75,13 +74,13 @@ class LoRaMacChannelPlan {
      *
      * Used to get active channel plan.
      *
-     * @param plan      a reference to application provided channel plan structure
-     *                  which gets filled in with active channel plan data.
+     * @param plan          a reference to application provided channel plan structure
+     *                      which gets filled in with active channel plan data.
      *
-     * @param params    pointer to active MAC layer parameters.
+     * @param mib_confirm   pointer to MIB request structure containing channel information
      *
-     * @return          LORAWAN_STATUS_OK if everything goes well otherwise
-     *                  a negative error code is returned.
+     * @return              LORAWAN_STATUS_OK if everything goes well otherwise
+     *                      a negative error code is returned.
      */
     lorawan_status_t get_plan(lorawan_channelplan_t& plan, const loramac_mib_req_confirm_t *mib_confirm);
 

features/lorawan/lorastack/mac/LoRaMacCommand.h

@@ -125,7 +125,7 @@ class LoRaMacCommand {
     /**
      * @brief Check if MAC command buffer has commands to be sent in next TX
      *
-     * @return status  True: buffer has MAC commands to be sent, false: no commands in buffer]
+     * @return status  True: buffer has MAC commands to be sent, false: no commands in buffer
      */
     bool is_mac_command_in_next_tx() const;
 
@@ -137,7 +137,7 @@ class LoRaMacCommand {
     /**
      * @brief Check if MAC command buffer contains sticky commands
      *
-     * @return status  True: buffer has sticky MAC commands in it, false: no sticky commands in buffer]
+     * @return status  True: buffer has sticky MAC commands in it, false: no sticky commands in buffer
      */
     bool has_sticky_mac_cmd() const;
 

features/lorawan/lorastack/mac/LoRaMacMcps.h

@@ -57,9 +57,6 @@ class LoRaMacMcps {
     /** Activating MCPS subsystem
      *
      * Stores pointers to MAC and PHY layer handles
-     *
-     * @param mac    pointer to MAC layer
-     * @param phy    pointer to PHY layer
      */
     void activate_mcps_subsystem();
 

features/lorawan/lorastack/mac/LoRaMacMib.h

@@ -53,7 +53,6 @@ class LoRaMacMib {
      *
      * Stores pointers to MAC and PHY layer handles
      *
-     * @param mac    pointer to MAC layer
      * @param phy    pointer to PHY layer
      */
     void activate_mib_subsystem(LoRaPHY *phy);

features/lorawan/lorastack/mac/LoRaMacMlme.h

@@ -58,7 +58,6 @@ class LoRaMacMlme {
      *
      * Stores pointers to MAC and PHY layer handles
      *
-     * @param mac    pointer to MAC layer
      * @param phy    pointer to PHY layer
      */
     void activate_mlme_subsystem(LoRaPHY *phy);
@@ -75,6 +74,15 @@ class LoRaMacMlme {
      */
     loramac_mlme_indication_t& get_indication();
 
+    /**
+     * @brief set_tx_continuous_wave Puts the system in continuous transmission mode
+     * @param [in] channel A Channel to use
+     * @param [in] datarate A datarate to use
+     * @param [in] tx_power A RF output power to use
+     * @param [in] max_eirp A maximum possible EIRP to use
+     * @param [in] antenna_gain Antenna gain to use
+     * @param [in] timeout Time in seconds while the radio is kept in continuous wave mode
+     */
     void set_tx_continuous_wave(uint8_t channel, int8_t datarate, int8_t tx_power,
                                 float max_eirp, float antenna_gain, uint16_t timeout);
 

features/lorawan/lorastack/phy/LoRaPHY.cpp

@@ -487,14 +487,48 @@ uint8_t LoRaPHY::enabled_channel_count(bool joined, uint8_t datarate,
     return count;
 }
 
-uint32_t LoRaPHY::get_next_lower_tx_datarate(int8_t datarate)
+void LoRaPHY::reset_to_default_values(loramac_protocol_params *params, bool init)
+{
+    if (init) {
+        params->is_dutycycle_on = phy_params.duty_cycle_enabled;
+
+        params->sys_params.max_rx_win_time = phy_params.max_rx_window;
+
+        params->sys_params.recv_delay1 = phy_params.recv_delay1;
+
+        params->sys_params.recv_delay2 = phy_params.recv_delay2;
+
+        params->sys_params.join_accept_delay1 = phy_params.join_accept_delay1;
+
+        params->sys_params.join_accept_delay2 = phy_params.join_accept_delay2;
+
+        params->sys_params.downlink_dwell_time = phy_params.dl_dwell_time_setting;
+    }
+
+    params->sys_params.channel_tx_power = get_default_tx_power();
+
+    params->sys_params.channel_data_rate = get_default_tx_datarate();
+
+    params->sys_params.rx1_dr_offset = phy_params.default_rx1_dr_offset;
+
+    params->sys_params.rx2_channel.frequency = get_default_rx2_frequency();
+
+    params->sys_params.rx2_channel.datarate = get_default_rx2_datarate();
+
+    params->sys_params.uplink_dwell_time = phy_params.ul_dwell_time_setting;
+
+    params->sys_params.max_eirp = phy_params.default_max_eirp;
+
+    params->sys_params.antenna_gain = phy_params.default_antenna_gain;
+}
+
+int8_t LoRaPHY::get_next_lower_tx_datarate(int8_t datarate)
 {
     if (phy_params.ul_dwell_time_setting == 0) {
         return get_next_lower_dr(datarate, phy_params.min_tx_datarate);
     }
 
-    return get_next_lower_dr(
-                datarate, phy_params.dwell_limit_datarate);
+    return get_next_lower_dr(datarate, phy_params.dwell_limit_datarate);
 
 }
 
@@ -540,36 +574,6 @@ uint8_t LoRaPHY::get_max_payload(uint8_t datarate, bool use_repeater)
     return payload_table[datarate];
 }
 
-bool LoRaPHY::duty_cycle_enabled()
-{
-    return phy_params.duty_cycle_enabled;
-}
-
-uint16_t LoRaPHY::get_maximum_receive_window_duration()
-{
-    return phy_params.max_rx_window;
-}
-
-uint16_t LoRaPHY::get_window1_receive_delay()
-{
-    return phy_params.recv_delay1;
-}
-
-uint16_t LoRaPHY::get_window2_receive_delay()
-{
-    return phy_params.recv_delay2;
-}
-
-uint16_t LoRaPHY::get_window1_join_accept_delay()
-{
-    return phy_params.join_accept_delay1;
-}
-
-uint16_t LoRaPHY::get_window2_join_accept_delay()
-{
-    return phy_params.join_accept_delay2;
-}
-
 uint16_t LoRaPHY::get_maximum_frame_counter_gap()
 {
     return phy_params.max_fcnt_gap;
@@ -582,11 +586,6 @@ uint32_t LoRaPHY::get_ack_timeout()
             + get_random(-ack_timeout_rnd, ack_timeout_rnd));
 }
 
-uint8_t LoRaPHY::get_default_datarate1_offset()
-{
-    return phy_params.default_rx1_dr_offset;
-}
-
 uint32_t LoRaPHY::get_default_rx2_frequency()
 {
     return phy_params.rx_window2_frequency;
@@ -620,32 +619,6 @@ bool LoRaPHY::is_custom_channel_plan_supported()
     return phy_params.custom_channelplans_supported;
 }
 
-uint8_t LoRaPHY::get_default_uplink_dwell_time()
-{
-    return phy_params.ul_dwell_time_setting;
-}
-
-uint8_t LoRaPHY::get_default_downlink_dwell_time()
-{
-    return phy_params.dl_dwell_time_setting;
-}
-
-float LoRaPHY::get_default_max_eirp()
-{
-    return phy_params.default_max_eirp;
-}
-
-float LoRaPHY::get_default_antenna_gain()
-{
-    return phy_params.default_antenna_gain;
-}
-
-uint8_t LoRaPHY::get_nb_join_trials(bool get_default)
-{
-    (void)get_default;
-    return MBED_CONF_LORA_NB_TRIALS;
-}
-
 void LoRaPHY::restore_default_channels()
 {
     // Restore channels default mask