MLE parent request timeout fixes (#1676)

- More exact timeout values for parent request timeouts
- Added delay for parent request send

Author: Tero Heinonen

source/6LoWPAN/Thread/thread_config.h

@@ -307,6 +307,15 @@
  */
 #define THREAD_PROACTIVE_AN_SEND_DELAY 2
 
+/*
+ * Parent response wait time (in 100ms) when "R" bit is set in scan mask TLV (rounded up from  0.75 seconds)
+ */
+#define THREAD_PARENT_REQ_SCANMASK_R_TIMEOUT 9
+
+/*
+ * Parent response wait time (in 100ms) when both "R" and "E" bit is set in scan mask TLV (rounded up from 1.25 seconds)
+ */
+#define THREAD_PARENT_REQ_SCANMASK_RE_TIMEOUT 15
 /**
  * Build time flag to enable THCI special traces for test harness purposes
  */

source/6LoWPAN/Thread/thread_host_bootstrap.c

@@ -227,13 +227,20 @@ static int thread_parent_request_build(protocol_interface_info_entry_t *cur)
         return -1;
     }
 
+    timeout.retrans_max = THREAD_PARENT_REQUEST_MAX_RETRY_CNT;
+    timeout.timeout_init = THREAD_PARENT_REQ_SCANMASK_R_TIMEOUT;
+    timeout.timeout_max = THREAD_PARENT_REQ_SCANMASK_RE_TIMEOUT;
+    timeout.delay = MLE_STANDARD_RESPONSE_DELAY;
+
     if (cur->thread_info->thread_attached_state == THREAD_STATE_REATTACH ||
         cur->thread_info->thread_attached_state == THREAD_STATE_REATTACH_RETRY ||
         cur->thread_info->thread_attached_state == THREAD_STATE_CONNECTED ||
         cur->thread_info->thread_attached_state == THREAD_STATE_CONNECTED_ROUTER) {
         // When doing re-attach End devices are immediately accepted as parents
         scanMask |= 0x40;
+        timeout.timeout_init = THREAD_PARENT_REQ_SCANMASK_RE_TIMEOUT;
     }
+
     thread_management_get_current_keysequence(cur->id, &keySequence);
     mle_service_msg_update_security_params(buf_id, 5, 2, keySequence);
 
@@ -256,19 +263,17 @@ static int thread_parent_request_build(protocol_interface_info_entry_t *cur)
     if (mle_service_update_length_by_ptr(buf_id,ptr)!= 0) {
         tr_debug("Buffer overflow at message write");
     }
-    timeout.retrans_max = THREAD_PARENT_REQUEST_MAX_RETRY_CNT;
-    timeout.timeout_init = 1;
-    timeout.timeout_max = 2;
-    timeout.delay = MLE_NO_DELAY;
+
     cur->nwk_nd_re_scan_count = 1;
+
     mle_service_set_packet_callback(buf_id, thread_parent_discover_timeout_cb);
     if (cur->thread_info->thread_attached_state == THREAD_STATE_NETWORK_DISCOVER) {
         mle_service_interface_receiver_handler_update(cur->id, thread_mle_parent_discover_receive_cb);
     } else {
         mle_service_interface_receiver_handler_update(cur->id, thread_general_mle_receive_cb);
     }
 
-    mle_service_set_msg_timeout_parameters(buf_id, &timeout);
+    mle_service_set_msg_timeout_parameters_fast(buf_id, &timeout);
     mle_service_send_message(buf_id);
     return 0;
 }

source/Service_Libs/mle_service/mle_service.c

@@ -1210,22 +1210,41 @@ int mle_service_message_tail_get(uint16_t msgId, uint16_t tail_length)
     return mle_service_buffer_tail_get(msgId,tail_length);
 }
 
-int mle_service_set_msg_timeout_parameters(uint16_t msgId, mle_message_timeout_params_t *timeout_params)
+static int mle_service_timeout_fill(uint16_t msgId, mle_message_timeout_params_t *timeout_params, bool timeout_in_seconds)
 {
     mle_service_msg_buf_t *buffer = mle_service_buffer_find(msgId);
 
     if (!buffer) {
         return -1;
     }
 
-    buffer->timeout_init = randLIB_randomise_base(timeout_params->timeout_init * 10, MLE_RAND_LOW, MLE_RAND_HIGH);
-    buffer->timeout = buffer->timeout_init;
-    buffer->timeout_max = timeout_params->timeout_max * 10;
+    buffer->timeout_max = timeout_params->timeout_max;
     buffer->retrans_max = timeout_params->retrans_max;
     buffer->delayed_response = timeout_params->delay;
+    buffer->timeout_init = timeout_params->timeout_init;
+
+    if (timeout_in_seconds) {
+        buffer->timeout_max = buffer->timeout_max * 10;
+        buffer->timeout_init = buffer->timeout_init * 10;
+    }
+
+    buffer->timeout_init = randLIB_randomise_base(buffer->timeout_init, MLE_RAND_LOW, MLE_RAND_HIGH);
+
+    buffer->timeout = buffer->timeout_init;
+
     return 0;
 }
 
+int mle_service_set_msg_timeout_parameters(uint16_t msgId, mle_message_timeout_params_t *timeout_params)
+{
+    return mle_service_timeout_fill(msgId, timeout_params, true);
+}
+
+int mle_service_set_msg_timeout_parameters_fast(uint16_t msgId, mle_message_timeout_params_t *timeout_params)
+{
+    return mle_service_timeout_fill(msgId, timeout_params, false);
+}
+
 int mle_service_set_msg_token_bucket_priority(uint16_t msgId)
 {
     mle_service_msg_buf_t *buffer = mle_service_buffer_find(msgId);

source/Service_Libs/mle_service/mle_service_api.h

@@ -126,8 +126,8 @@ typedef struct {
  *
  */
 typedef struct {
-uint16_t timeout_init; /*!< Define start timeout in seconds */
-uint16_t timeout_max; /*!< Define max timeout time in seconds */
+uint16_t timeout_init; /*!< Define start timeout */
+uint16_t timeout_max; /*!< Define max timeout time */
 uint8_t retrans_max; /*!< Define max packet TX count */
 uint8_t delay; /*!< 100ms Ticks for random delay */
 } mle_message_timeout_params_t;
@@ -583,14 +583,25 @@ int mle_service_set_msg_panid(uint16_t msgId, uint16_t panid);
 /**
 * Set messages timeout parameters.
 *
-* Messages timeout parameters define messages TX count and init timeout and max timeout values is messages delayed.
+* Struct timeout_params defines messages retransmission times in seconds, retransmission count and sending delay.
 * Delayed message will affect random time between 100-900ms
 *
 * \param msgId Message Id.
 * \param timeout_params messages transmission parameters
 */
 int mle_service_set_msg_timeout_parameters(uint16_t msgId, mle_message_timeout_params_t *timeout_params);
 
+/**
+* Set messages timeout parameters.
+*
+* Struct timeout_params defines messages retransmission times in 100ms, retransmission count and sending delay.
+* Delayed message will affect random time between 100-900ms
+*
+* \param msgId Message Id.
+* \param timeout_params messages transmission parameters
+*/
+int mle_service_set_msg_timeout_parameters_fast(uint16_t msgId, mle_message_timeout_params_t *timeout_params);
+
 int mle_service_set_msg_rf_channel(uint16_t msgId, uint8_t channel);
 
 int mle_service_set_msg_link_layer_security_mode(uint16_t msgId, bool use_key_id_mode_2);