Merge pull request ARMmbed#1930 from ARMmbed/IOTTHD-3027

Iotthd 3027

Author: Jarkko Paso

nanostack/mlme.h

@@ -264,6 +264,7 @@ typedef enum {
     macAutoRequestKeyIndex = 0x7b,  /*<The index of the key used for automatic data*/
     macDefaultKeySource = 0x7c,      /*<Default key source*/
     //NON standard extension
+    macRfConfiguration = 0xfb,      /*<RF channel configuration parameters*/
     macAcceptByPassUnknowDevice = 0xfc,  /*< Accept data trough MAC if packet is data can be authenticated by group key nad MIC. Security enforsment point must be handled carefully these packets */
     macLoadBalancingBeaconTx = 0xfd,  /*< Trig Beacon from load balance module periodic */
     macLoadBalancingAcceptAnyBeacon = 0xfe, /*<Beacon accept state control from other network. Value size bool, data true=Enable, false=disable .*/

nanostack/platform/arm_hal_phy.h

@@ -64,6 +64,7 @@ typedef enum {
     PHY_EXTENSION_GET_TIMESTAMP, /**<  Read 32-bit constant monotonic time stamp in us */
     PHY_EXTENSION_SET_CSMA_PARAMETERS, /**< CSMA parameter's are given by phy_csma_params_t structure remember type cast uint8_t pointer to structure type*/
     PHY_EXTENSION_GET_SYMBOLS_PER_SECOND, /**<  Read Symbols per seconds which will help to convert symbol time to real time  */
+    PHY_EXTENSION_SET_RF_CONFIGURATION  /**<  Set RF configuration using phy_rf_channel_parameters_s structure */
 } phy_extension_type_e;
 
 /** Address types */
@@ -130,6 +131,7 @@ typedef enum phy_modulation_e {
     M_OQPSK,    ///< OQPSK
     M_BPSK,     ///< BPSK
     M_GFSK,     ///< GFSK
+    M_2FSK,     ///< 2FSK
     M_UNDEFINED ///< UNDEFINED
 } phy_modulation_e;
 
@@ -146,13 +148,21 @@ typedef enum {
     CHANNEL_PAGE_10 = 10    ///< Page 10
 } channel_page_e;
 
+/** Modulation index */
+typedef enum {
+    MODULATION_INDEX_0_5 = 0,   ///< Modulation index 0.5
+    MODULATION_INDEX_1_0 = 1,   ///< Modulation index 1.0
+    MODULATION_INDEX_UNDEFINED  ///< Modulation index undefined
+} phy_modulation_index_e;
+
 /** Channel configuration */
 typedef struct phy_rf_channel_configuration_s {
-    uint32_t channel_0_center_frequency;    ///< Center frequency
-    uint32_t channel_spacing;               ///< Channel spacing
-    uint32_t datarate;                      ///< Data rate
-    uint16_t number_of_channels;            ///< Number of channels
-    phy_modulation_e modulation;            ///< Modulation scheme
+    uint32_t channel_0_center_frequency;        ///< Center frequency
+    uint32_t channel_spacing;                   ///< Channel spacing
+    uint32_t datarate;                          ///< Data rate
+    uint16_t number_of_channels;                ///< Number of channels
+    phy_modulation_e modulation;                ///< Modulation scheme
+    phy_modulation_index_e modulation_index;    ///< Modulation index
 } phy_rf_channel_configuration_s;
 
 /** Channel page configuration */

source/6LoWPAN/ws/ws_bootstrap.c

@@ -1523,6 +1523,23 @@ int ws_bootstrap_restart(int8_t interface_id)
     return 0;
 }
 
+int ws_bootstrap_set_rf_config(protocol_interface_info_entry_t *cur, phy_rf_channel_configuration_s rf_configs)
+{
+    mlme_set_t set_request;
+    // Set RF configuration
+    set_request.attr = macRfConfiguration;
+    set_request.value_pointer = &rf_configs;
+    set_request.value_size = sizeof(phy_rf_channel_configuration_s);
+    cur->mac_api->mlme_req(cur->mac_api, MLME_SET, &set_request);
+    // Set Ack wait duration
+    uint16_t ack_wait_symbols = WS_ACK_WAIT_SYMBOLS + (WS_TACK_MAX_MS * (rf_configs.datarate / 1000));
+    set_request.attr = macAckWaitDuration;
+    set_request.value_pointer = &ack_wait_symbols;
+    set_request.value_size = sizeof(ack_wait_symbols);
+    cur->mac_api->mlme_req(cur->mac_api, MLME_SET, &set_request);
+    return 0;
+}
+
 int ws_bootstrap_neighbor_remove(protocol_interface_info_entry_t *cur, const uint8_t *ll_address)
 {
     tr_warn("ARO registration Failure %s", trace_ipv6(ll_address));

source/6LoWPAN/ws/ws_bootstrap.h

@@ -37,6 +37,8 @@ void ws_bootstrap_state_machine(protocol_interface_info_entry_t *cur);
 
 int ws_bootstrap_restart(int8_t interface_id);
 
+int ws_bootstrap_set_rf_config(protocol_interface_info_entry_t *cur, phy_rf_channel_configuration_s rf_configs);
+
 int ws_bootstrap_neighbor_remove(protocol_interface_info_entry_t *cur, const uint8_t *ll_address);
 
 /*State machine transactions*/

source/6LoWPAN/ws/ws_common.c

@@ -75,6 +75,60 @@ int8_t ws_generate_channel_list(uint32_t *channel_mask, uint16_t number_of_chann
     return 0;
 }
 
+static uint32_t ws_decode_channel_spacing(uint8_t channel_spacing)
+{
+    if (CHANNEL_SPACING_100 == channel_spacing) {
+        return 100000;
+    } else if (CHANNEL_SPACING_200 == channel_spacing) {
+        return 200000;
+    } else if (CHANNEL_SPACING_250 == channel_spacing) {
+        return 250000;
+    } else if (CHANNEL_SPACING_400 == channel_spacing) {
+        return 400000;
+    } else if (CHANNEL_SPACING_600 == channel_spacing) {
+        return 600000;
+    }
+    return 0;
+}
+
+static uint32_t ws_get_datarate_using_operating_mode(uint8_t operating_mode)
+{
+    if ((OPERATING_MODE_1a == operating_mode) || (OPERATING_MODE_1b == operating_mode)) {
+        return 50000;
+    } else if ((OPERATING_MODE_2a == operating_mode) || (OPERATING_MODE_2b == operating_mode)) {
+        return 100000;
+    } else if (OPERATING_MODE_3 == operating_mode) {
+        return 150000;
+    } else if ((OPERATING_MODE_4a == operating_mode) || (OPERATING_MODE_4b == operating_mode)) {
+        return 200000;
+    } else if (OPERATING_MODE_5 == operating_mode) {
+        return 300000;
+    }
+    return 0;
+}
+
+static phy_modulation_index_e ws_get_modulation_index_using_operating_mode(uint8_t operating_mode)
+{
+    if ((OPERATING_MODE_1b == operating_mode) || (OPERATING_MODE_2b == operating_mode) || (OPERATING_MODE_4b == operating_mode)) {
+        return MODULATION_INDEX_1_0;
+    } else {
+        return MODULATION_INDEX_0_5;
+    }
+}
+
+static int ws_set_domain_rf_config(protocol_interface_info_entry_t *cur)
+{
+    phy_rf_channel_configuration_s rf_configs;
+    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.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);
+    rf_configs.modulation = M_2FSK;
+    rf_configs.number_of_channels = cur->ws_info->hopping_schdule.number_of_channels;
+    ws_bootstrap_set_rf_config(cur, rf_configs);
+    return 0;
+}
+
 int8_t ws_common_regulatory_domain_config(protocol_interface_info_entry_t *cur)
 {
     cur->ws_info->hopping_schdule.channel_plan = 0;
@@ -103,11 +157,11 @@ int8_t ws_common_regulatory_domain_config(protocol_interface_info_entry_t *cur)
         } else if (cur->ws_info->hopping_schdule.operating_class == 3) {
             cur->ws_info->hopping_schdule.ch0_freq = 8701;
             cur->ws_info->hopping_schdule.channel_spacing = CHANNEL_SPACING_100;
-            cur->ws_info->hopping_schdule.number_of_channels = 59;
+            cur->ws_info->hopping_schdule.number_of_channels = 55;
         } else if (cur->ws_info->hopping_schdule.operating_class == 4) {
-            cur->ws_info->hopping_schdule.ch0_freq = 8701;
+            cur->ws_info->hopping_schdule.ch0_freq = 8702;
             cur->ws_info->hopping_schdule.channel_spacing = CHANNEL_SPACING_200;
-            cur->ws_info->hopping_schdule.number_of_channels = 30;
+            cur->ws_info->hopping_schdule.number_of_channels = 27;
         } else {
             return -1;
         }
@@ -160,13 +214,7 @@ int8_t ws_common_regulatory_domain_config(protocol_interface_info_entry_t *cur)
     }
     // Note: doesn't work for Brazil region
     ws_generate_channel_list(cur->ws_info->hopping_schdule.channel_mask, cur->ws_info->hopping_schdule.number_of_channels, cur->ws_info->hopping_schdule.regulatory_domain);
-
-    uint16_t ack_wait_symbols = WS_ACK_WAIT_SYMBOLS;
-    mlme_set_t set_request;
-    set_request.attr = macAckWaitDuration;
-    set_request.value_pointer = &ack_wait_symbols;
-    set_request.value_size = sizeof(ack_wait_symbols);
-    cur->mac_api->mlme_req(cur->mac_api, MLME_SET, &set_request);
+    ws_set_domain_rf_config(cur);
     return 0;
 }
 
@@ -188,9 +236,9 @@ int8_t ws_common_allocate_and_init(protocol_interface_info_entry_t *cur)
     cur->ws_info->pan_information.rpl_routing_method = true;
     cur->ws_info->pan_information.version = WS_FAN_VERSION_1_0;
 
-    cur->ws_info->hopping_schdule.regulatory_domain = REG_DOMAIN_KR;
-    cur->ws_info->hopping_schdule.operating_mode = OPERATING_MODE_1a;
-    cur->ws_info->hopping_schdule.operating_class = 1;
+    cur->ws_info->hopping_schdule.regulatory_domain = REG_DOMAIN_EU;
+    cur->ws_info->hopping_schdule.operating_mode = OPERATING_MODE_3;
+    cur->ws_info->hopping_schdule.operating_class = 2;
     ws_common_regulatory_domain_config(cur);
     ws_common_network_size_configure(cur, 10); // defaults to small network size
 

source/6LoWPAN/ws/ws_common_defines.h

@@ -220,6 +220,11 @@ typedef struct ws_bs_ie {
  */
 #define WS_ACK_WAIT_SYMBOLS    800
 
+/*
+ * Tack max time in milliseconds.
+ */
+#define WS_TACK_MAX_MS 5
+
 /* Default FHSS timing information
  *
  */

source/MAC/IEEE802_15_4/mac_mlme.c

@@ -68,6 +68,7 @@ static int8_t mac_mlme_rf_channel_set(struct protocol_interface_rf_mac_setup *rf
 static void mac_mlme_timer_cb(int8_t timer_id, uint16_t slots);
 static void mac_mlme_start_confirm_handler(protocol_interface_rf_mac_setup_s *rf_ptr, const mlme_start_conf_t *conf);
 static void mac_mlme_scan_confirm_handler(protocol_interface_rf_mac_setup_s *rf_ptr, const mlme_scan_conf_t *conf);
+static int mac_mlme_set_symbol_rate(protocol_interface_rf_mac_setup_s *rf_mac_setup);
 
 static void mac_mlme_energy_scan_start(protocol_interface_rf_mac_setup_s *rf_mac_setup, uint8_t channel)
 {
@@ -748,6 +749,10 @@ int8_t mac_mlme_set_req(protocol_interface_rf_mac_setup_s *rf_mac_setup, const m
                 memcpy(rf_mac_setup->coord_long_address, set_req->value_pointer, 8);
             }
             return 0;
+        case macRfConfiguration:
+            rf_mac_setup->dev_driver->phy_driver->extension(PHY_EXTENSION_SET_RF_CONFIGURATION, (uint8_t *) set_req->value_pointer);
+            mac_mlme_set_symbol_rate(rf_mac_setup);
+            return 0;
         default:
             return mac_mlme_handle_set_values(rf_mac_setup, set_req);
     }
@@ -1034,6 +1039,17 @@ static uint8_t mac_backoff_ticks_calc(phy_device_driver_s *phy_driver)
     return (uint8_t) ticks;
 }
 
+static int mac_mlme_set_symbol_rate(protocol_interface_rf_mac_setup_s *rf_mac_setup)
+{
+    if (rf_mac_setup->rf_csma_extension_supported) {
+        rf_mac_setup->dev_driver->phy_driver->extension(PHY_EXTENSION_GET_SYMBOLS_PER_SECOND, (uint8_t *) &rf_mac_setup->symbol_rate);
+        rf_mac_setup->symbol_time_us = 1000000 / rf_mac_setup->symbol_rate;
+        tr_debug("SW-MAC driver support rf extension %"PRIu32" symbol/seconds  %"PRIu32" us symbol time length", rf_mac_setup->symbol_rate, rf_mac_setup->symbol_time_us);
+        return 0;
+    }
+    return -1;
+}
+
 protocol_interface_rf_mac_setup_s *mac_mlme_data_base_allocate(uint8_t *mac64, arm_device_driver_list_s *dev_driver, mac_description_storage_size_t *storage_sizes)
 {
     uint16_t total_length = 0;
@@ -1124,11 +1140,7 @@ protocol_interface_rf_mac_setup_s *mac_mlme_data_base_allocate(uint8_t *mac64, a
     bool rf_support = false;
     dev_driver->phy_driver->extension(PHY_EXTENSION_DYNAMIC_RF_SUPPORTED, (uint8_t *)&rf_support);
     entry->rf_csma_extension_supported = rf_support;
-    if (entry->rf_csma_extension_supported) {
-        entry->dev_driver->phy_driver->extension(PHY_EXTENSION_GET_SYMBOLS_PER_SECOND, (uint8_t *) &entry->symbol_rate);
-        entry->symbol_time_us = 1000000 / entry->symbol_rate;
-        tr_debug("SW-MAC driver support rf extension %"PRIu32" symbol/seconds  %"PRIu32" us symbol time length", entry->symbol_rate, entry->symbol_time_us);
-    }
+    mac_mlme_set_symbol_rate(entry);
 
     //How many 10us ticks backoff period is for waiting 20symbols which is typically 10 bytes time
     entry->backoff_period_in_10us = mac_backoff_ticks_calc(dev_driver->phy_driver);

source/MAC/virtual_rf/virtual_rf_client.c

@@ -31,7 +31,7 @@
 
 static phy_device_driver_s device_driver;
 static int8_t rf_driver_id = (-1);
-static const phy_rf_channel_configuration_s phy_2_4ghz = {2405000000, 5000000, 250000, 16, M_OQPSK};
+static const phy_rf_channel_configuration_s phy_2_4ghz = {.channel_0_center_frequency = 2405000000, .channel_spacing = 5000000, .datarate = 250000, .number_of_channels = 16, .modulation = M_OQPSK};
 static const phy_device_channel_page_s phy_channel_pages = { CHANNEL_PAGE_0, &phy_2_4ghz};
 
 static int8_t phy_rf_rx(const uint8_t *data_ptr, uint16_t data_len, uint8_t link_quality, int8_t dbm, int8_t driver_id)

source/MAC/virtual_rf/virtual_rf_driver.c

@@ -38,15 +38,15 @@ static int8_t rf_driver_id = (-1);
 static bool data_request_pending_flag = false;
 
 /** XXX: dummy values copied from Atmel RF driver */
-static const phy_rf_channel_configuration_s phy_2_4ghz = {2405000000, 5000000, 250000, 16, M_OQPSK};
-static const phy_rf_channel_configuration_s phy_subghz = {868300000, 2000000, 250000, 11, M_OQPSK};
-
-static const phy_rf_channel_configuration_s phy_subghz_8_ch = {868300000, 2000000, 250000, 8, M_OQPSK};
-static const phy_rf_channel_configuration_s phy_subghz_11_ch = {868300000, 2000000, 250000, 11, M_OQPSK};
-static const phy_rf_channel_configuration_s phy_subghz_16_ch = {868300000, 2000000, 250000, 16, M_OQPSK};
-static const phy_rf_channel_configuration_s phy_2_4ghz_14_ch = {2405000000, 1000000, 250000, 14, M_OQPSK};
-static const phy_rf_channel_configuration_s phy_2_4ghz_5_ch = {2405000000, 1000000, 250000, 5, M_OQPSK}; //For FHSS testing only
-static const phy_rf_channel_configuration_s phy_2_4ghz_256_ch = {2405000000, 1000000, 250000, 256, M_OQPSK}; //For FHSS testing only
+static const phy_rf_channel_configuration_s phy_2_4ghz = {.channel_0_center_frequency = 2405000000, .channel_spacing = 5000000, .datarate = 250000, .number_of_channels = 16, .modulation = M_OQPSK};
+static const phy_rf_channel_configuration_s phy_subghz = {.channel_0_center_frequency = 868300000, .channel_spacing = 2000000, .datarate = 250000, .number_of_channels = 11, .modulation = M_OQPSK};
+
+static const phy_rf_channel_configuration_s phy_subghz_8_ch = {.channel_0_center_frequency = 868300000, .channel_spacing = 2000000, .datarate = 250000, .number_of_channels = 8, .modulation = M_OQPSK};
+static const phy_rf_channel_configuration_s phy_subghz_11_ch = {.channel_0_center_frequency = 868300000, .channel_spacing = 2000000, .datarate = 250000, .number_of_channels = 11, .modulation = M_OQPSK};
+static const phy_rf_channel_configuration_s phy_subghz_16_ch = {.channel_0_center_frequency = 868300000, .channel_spacing = 2000000, .datarate = 250000, .number_of_channels = 16, .modulation = M_OQPSK};
+static const phy_rf_channel_configuration_s phy_2_4ghz_14_ch = {.channel_0_center_frequency = 2405000000, .channel_spacing = 1000000, .datarate = 250000, .number_of_channels = 14, .modulation = M_OQPSK};
+static const phy_rf_channel_configuration_s phy_2_4ghz_5_ch = {.channel_0_center_frequency = 2405000000, .channel_spacing = 1000000, .datarate = 250000, .number_of_channels = 5, .modulation = M_OQPSK}; //For FHSS testing only
+static const phy_rf_channel_configuration_s phy_2_4ghz_256_ch = {.channel_0_center_frequency = 2405000000, .channel_spacing = 1000000, .datarate = 250000, .number_of_channels = 256, .modulation = M_OQPSK}; //For FHSS testing only
 
 static phy_device_channel_page_s phy_channel_pages[] = {
     {CHANNEL_PAGE_0, &phy_2_4ghz}, // this will be modified to contain 11 or 16 channels, depending on radio type

test/nanostack/unittest/mac/mac_mlme/test_mac_mlme.c

@@ -569,7 +569,7 @@ bool test_mac_mlme_set_req()
     uint8_t val[1];
     set.value_pointer = &val;
 
-    set.attr = 0xfb;
+    set.attr = 0xf0;
     set.value_size = 0;
     if (-1 != mac_mlme_set_req(&setup, &set)) {
         return false;