RF config resolver and some refactoring (ARMmbed#2683)

Author: Jarkko Paso

source/6LoWPAN/ws/ws_bootstrap.c

@@ -1869,6 +1869,44 @@ int ws_bootstrap_restart_delayed(int8_t interface_id)
     return 0;
 }
 
+static int8_t ws_bootstrap_phy_mode_resolver(const mac_api_t *api, uint8_t phy_mode_id, phy_rf_channel_configuration_s *rf_config)
+{
+    rf_config->modulation = ws_get_modulation_using_phy_mode_id(phy_mode_id);
+    if (rf_config->modulation == M_UNDEFINED) {
+        return -1;
+    }
+    protocol_interface_info_entry_t *interface = protocol_stack_interface_info_get_by_id(api->parent_id);
+    if (!interface) {
+        return -1;
+    }
+    uint8_t regulatory_domain = interface->ws_info->hopping_schdule.regulatory_domain;
+    uint8_t base_channel_plan_id = interface->ws_info->hopping_schdule.channel_plan_id;
+    if (base_channel_plan_id == 255) {
+        base_channel_plan_id = ws_convert_operating_class_to_channel_plan_id(interface->ws_info->hopping_schdule.operating_class, regulatory_domain);
+    }
+    if (!base_channel_plan_id) {
+        return -1;
+    }
+    // Function returns base channel plan ID, if it matches the PHY mode ID. Otherwise, nearest matching channel plan ID where PHY mode ID is allowed will be returned.
+    uint8_t channel_plan_id = ws_get_channel_plan_id_using_phy_mode_id(phy_mode_id, regulatory_domain, base_channel_plan_id);
+    if (!channel_plan_id) {
+        return -1;
+    }
+
+    rf_config->channel_0_center_frequency = ws_get_channel_0_frequency_using_channel_plan_id(channel_plan_id);
+    rf_config->channel_spacing = ws_get_channel_spacing_using_channel_plan_id(channel_plan_id);
+    rf_config->number_of_channels = ws_get_number_of_channels_using_channel_plan_id(channel_plan_id);
+    rf_config->datarate = ws_get_datarate_using_phy_mode_id(phy_mode_id);
+    if (!rf_config->channel_0_center_frequency || !rf_config->channel_spacing || !rf_config->number_of_channels || !rf_config->datarate) {
+        return -1;
+    }
+    rf_config->ofdm_option = ws_get_ofdm_option_using_phy_mode_id(phy_mode_id);
+    rf_config->ofdm_mcs = ws_get_ofdm_mcs_using_phy_mode_id(phy_mode_id);
+    rf_config->fec = ws_get_fsk_fec_enabled_using_phy_mode_id(phy_mode_id);
+    rf_config->modulation_index = ws_get_modulation_index_using_phy_mode_id(phy_mode_id);
+    return 0;
+}
+
 static int ws_bootstrap_set_rf_config(protocol_interface_info_entry_t *cur, phy_rf_channel_configuration_s rf_configs)
 {
     mlme_set_t set_request;
@@ -1901,6 +1939,16 @@ static int ws_bootstrap_set_rf_config(protocol_interface_info_entry_t *cur, phy_
     cur->mac_api->mlme_req(cur->mac_api, MLME_SET, &set_request);
     // Start automatic CCA threshold
     mac_helper_start_auto_cca_threshold(cur->id, cur->ws_info->hopping_schdule.number_of_channels, CCA_DEFAULT_DBM, CCA_HIGH_LIMIT, CCA_LOW_LIMIT);
+    // Enable MAC mode switch when base PHY mode ID could be found, otherwise disable the feature
+    uint8_t phy_mode_id = cur->ws_info->hopping_schdule.phy_mode_id;
+    if (phy_mode_id == 255) {
+        phy_mode_id = ws_convert_operating_mode_to_phy_mode_id(cur->ws_info->hopping_schdule.operating_mode);
+    }
+    if (!phy_mode_id) {
+        cur->mac_api->mac_mode_switch_resolver_set(cur->mac_api, NULL, phy_mode_id);
+    } else {
+        cur->mac_api->mac_mode_switch_resolver_set(cur->mac_api, &ws_bootstrap_phy_mode_resolver, phy_mode_id);
+    }
     return 0;
 }
 
@@ -1921,35 +1969,35 @@ int ws_bootstrap_aro_failure(protocol_interface_info_entry_t *cur, const uint8_t
     return 0;
 }
 
+static int ws_bootstrap_operating_mode_resolver(protocol_interface_info_entry_t *cur, phy_rf_channel_configuration_s *rf_config)
+{
+    memset(rf_config, 0, sizeof(phy_rf_channel_configuration_s));
+    rf_config->fec = false;
+    rf_config->modulation = M_2FSK;
+    rf_config->datarate = ws_get_datarate_using_operating_mode(cur->ws_info->hopping_schdule.operating_mode);
+    rf_config->modulation_index = ws_get_modulation_index_using_operating_mode(cur->ws_info->hopping_schdule.operating_mode);
+    rf_config->channel_0_center_frequency = (uint32_t)cur->ws_info->hopping_schdule.ch0_freq * 100000;
+    rf_config->channel_spacing = ws_decode_channel_spacing(cur->ws_info->hopping_schdule.channel_spacing);
+    rf_config->number_of_channels = cur->ws_info->hopping_schdule.number_of_channels;
+    return 0;
+}
+
 int ws_bootstrap_set_domain_rf_config(protocol_interface_info_entry_t *cur)
 {
-    phy_rf_channel_configuration_s rf_configs;
-    memset(&rf_configs, 0, sizeof(phy_rf_channel_configuration_s));
+    phy_rf_channel_configuration_s rf_config;
+    memset(&rf_config, 0, sizeof(phy_rf_channel_configuration_s));
 
     uint8_t phy_mode_id = cur->ws_info->hopping_schdule.phy_mode_id;
-    if (((phy_mode_id >= 34) && (phy_mode_id <= 38)) ||
-            ((phy_mode_id >= 51) && (phy_mode_id <= 54)) ||
-            ((phy_mode_id >= 68) && (phy_mode_id <= 70)) ||
-            ((phy_mode_id >= 84) && (phy_mode_id <= 86))) {
-        rf_configs.modulation = M_OFDM;
-        rf_configs.datarate = ws_get_datarate_using_phy_mode_id(cur->ws_info->hopping_schdule.phy_mode_id);
-        rf_configs.ofdm_option = ws_get_ofdm_option_using_phy_mode_id(cur->ws_info->hopping_schdule.phy_mode_id);
-        rf_configs.ofdm_mcs = ws_get_ofdm_mcs_using_phy_mode_id(cur->ws_info->hopping_schdule.phy_mode_id);
-    } else {
-        if ((phy_mode_id >= 17) && (phy_mode_id <= 24)) {
-            rf_configs.fec = true;
-        } else {
-            rf_configs.fec = false;
-        }
-        rf_configs.modulation = M_2FSK;
-        rf_configs.datarate = ws_get_datarate_using_operating_mode(cur->ws_info->hopping_schdule.operating_mode);
-        rf_configs.modulation_index = ws_get_modulation_index_using_operating_mode(cur->ws_info->hopping_schdule.operating_mode);
+    if (phy_mode_id == 255) {
+        phy_mode_id = ws_convert_operating_mode_to_phy_mode_id(cur->ws_info->hopping_schdule.operating_mode);
+    }
+
+    if (!phy_mode_id || ws_bootstrap_phy_mode_resolver(cur->mac_api, phy_mode_id, &rf_config)) {
+        // Cannot resolve RF configuration using PHY mode ID, try with operating mode
+        ws_bootstrap_operating_mode_resolver(cur, &rf_config);
     }
 
-    rf_configs.channel_0_center_frequency = (uint32_t)cur->ws_info->hopping_schdule.ch0_freq * 100000;
-    rf_configs.channel_spacing = ws_decode_channel_spacing(cur->ws_info->hopping_schdule.channel_spacing);
-    rf_configs.number_of_channels = cur->ws_info->hopping_schdule.number_of_channels;
-    ws_bootstrap_set_rf_config(cur, rf_configs);
+    ws_bootstrap_set_rf_config(cur, rf_config);
     return 0;
 }