Cellular: Make CellularStateMachine timeouts configurable

Author: Ari Parkkila

features/cellular/framework/API/CellularDevice.h

@@ -131,6 +131,7 @@ class CellularDevice {
      *  The driver may repeat this if the modem is not responsive to AT commands.
      *
      *  @remark CellularStateMachine calls this when requested to connect.
+     *  Configure response timeout with `cellular.timeout-power-on` in mbed_lib.json.
      *  If you are not using CellularStateMachine then you need to call this function yourself.
      *
      *  @post You must call init to setup the modem.
@@ -162,6 +163,9 @@ class CellularDevice {
     virtual nsapi_error_t set_pin(const char *sim_pin) = 0;
 
     /** Get SIM card's state
+     *
+     *  @remark CellularStateMachine calls this when requested to connect and SIM pin is set.
+     *  Configure response timeout with `cellular.timeout-sim-pin` in mbed_lib.json.
      *
      *  @param state    current state of SIM
      *  @return         NSAPI_ERROR_OK on success
@@ -330,7 +334,9 @@ class CellularDevice {
      */
     virtual void close_information() = 0;
 
-    /** Set the default response timeout.
+    /** Set the default response timeout from the modem.
+     *
+     *  @remark Timeout is overwritten by CellularStateMachine if defaults are defined, see cellular `mbed_lib.json`.
      *
      *  @param timeout    milliseconds to wait response from modem
      */

features/cellular/framework/device/CellularStateMachine.cpp

@@ -24,13 +24,6 @@
 #define MBED_TRACE_MAX_LEVEL TRACE_LEVEL_INFO
 #endif
 
-// timeout to wait for AT responses
-#define TIMEOUT_POWER_ON     (1*1000)
-#define TIMEOUT_SIM_PIN      (1*1000)
-#define TIMEOUT_NETWORK      (10*1000)
-#define TIMEOUT_CONNECT      (60*1000)
-#define TIMEOUT_REGISTRATION (180*1000)
-
 // maximum time when retrying network register, attach and connect in seconds ( 20minutes )
 #define TIMEOUT_NETWORK_MAX (20*60)
 
@@ -298,8 +291,10 @@ void CellularStateMachine::retry_state_or_fail()
 
 void CellularStateMachine::state_init()
 {
-    _cellularDevice.set_timeout(TIMEOUT_POWER_ON);
-    tr_info("Start connecting (timeout %d s)", TIMEOUT_POWER_ON / 1000);
+#ifdef MBED_CONF_CELLULAR_TIMEOUT_POWER_ON
+    _cellularDevice.set_timeout(MBED_CONF_CELLULAR_TIMEOUT_POWER_ON);
+    tr_debug("Wait for modem response (timeout %d s)", MBED_CONF_CELLULAR_TIMEOUT_POWER_ON / 1000);
+#endif
     _cb_data.error = _cellularDevice.is_ready();
     _status = _cb_data.error ? 0 : DEVICE_READY;
     if (_cb_data.error != NSAPI_ERROR_OK) {
@@ -315,8 +310,10 @@ void CellularStateMachine::state_init()
 
 void CellularStateMachine::state_power_on()
 {
-    _cellularDevice.set_timeout(TIMEOUT_POWER_ON);
-    tr_info("Modem power ON (timeout %d s)", TIMEOUT_POWER_ON / 1000);
+#ifdef MBED_CONF_CELLULAR_TIMEOUT_POWER_ON
+    _cellularDevice.set_timeout(MBED_CONF_CELLULAR_TIMEOUT_POWER_ON);
+    tr_debug("Modem power ON (timeout %d s)", MBED_CONF_CELLULAR_TIMEOUT_POWER_ON / 1000);
+#endif
     if (power_on()) {
         enter_to_state(STATE_DEVICE_READY);
     } else {
@@ -353,7 +350,9 @@ bool CellularStateMachine::device_ready()
 
 void CellularStateMachine::state_device_ready()
 {
-    _cellularDevice.set_timeout(TIMEOUT_POWER_ON);
+#ifdef MBED_CONF_CELLULAR_TIMEOUT_POWER_ON
+    _cellularDevice.set_timeout(MBED_CONF_CELLULAR_TIMEOUT_POWER_ON);
+#endif
     if (!(_status & DEVICE_READY)) {
         tr_debug("Device was not ready, calling soft_power_on()");
         _cb_data.error = _cellularDevice.soft_power_on();
@@ -377,8 +376,10 @@ void CellularStateMachine::state_device_ready()
 
 void CellularStateMachine::state_sim_pin()
 {
-    _cellularDevice.set_timeout(TIMEOUT_SIM_PIN);
-    tr_info("Setup SIM (timeout %d s)", TIMEOUT_SIM_PIN / 1000);
+#ifdef MBED_CONF_CELLULAR_TIMEOUT_SIM_PIN
+    _cellularDevice.set_timeout(MBED_CONF_CELLULAR_TIMEOUT_SIM_PIN);
+    tr_debug("Setup SIM (timeout %d s)", MBED_CONF_CELLULAR_TIMEOUT_SIM_PIN / 1000);
+#endif
     if (open_sim()) {
         bool success = false;
         for (int type = 0; type < CellularNetwork::C_MAX; type++) {
@@ -419,8 +420,9 @@ void CellularStateMachine::state_sim_pin()
 
 void CellularStateMachine::state_registering()
 {
-    _cellularDevice.set_timeout(TIMEOUT_NETWORK);
-    tr_info("Network registration (timeout %d s)", TIMEOUT_REGISTRATION / 1000);
+#ifdef MBED_CONF_CELLULAR_TIMEOUT_NETWORK_ATTACH
+    _cellularDevice.set_timeout(MBED_CONF_CELLULAR_TIMEOUT_NETWORK_ATTACH);
+#endif
     if (is_registered()) {
         if (_cb_data.status_data != CellularNetwork::RegisteredHomeNetwork &&
                 _cb_data.status_data != CellularNetwork::RegisteredRoaming && _status) {
@@ -432,7 +434,10 @@ void CellularStateMachine::state_registering()
         // we are already registered, go to attach
         enter_to_state(STATE_ATTACHING_NETWORK);
     } else {
-        _cellularDevice.set_timeout(TIMEOUT_REGISTRATION);
+#ifdef MBED_CONF_CELLULAR_TIMEOUT_NETWORK_SELECTION
+        _cellularDevice.set_timeout(MBED_CONF_CELLULAR_TIMEOUT_NETWORK_SELECTION);
+        tr_debug("Network selection (timeout %d s)", MBED_CONF_CELLULAR_TIMEOUT_NETWORK_SELECTION / 1000);
+#endif
         if (!_command_success && !_plmn) { // don't call set_registration twice for manual registration
             _cb_data.error = _network->set_registration(_plmn);
             _command_success = (_cb_data.error == NSAPI_ERROR_OK);
@@ -443,8 +448,10 @@ void CellularStateMachine::state_registering()
 
 void CellularStateMachine::state_attaching()
 {
-    _cellularDevice.set_timeout(TIMEOUT_CONNECT);
-    tr_info("Attaching network (timeout %d s)", TIMEOUT_CONNECT / 1000);
+#ifdef MBED_CONF_CELLULAR_TIMEOUT_NETWORK_CONNECT
+    _cellularDevice.set_timeout(MBED_CONF_CELLULAR_TIMEOUT_NETWORK_CONNECT);
+    tr_debug("Attaching network (timeout %d s)", MBED_CONF_CELLULAR_TIMEOUT_NETWORK_CONNECT / 1000);
+#endif
     if (_status != ATTACHED_TO_NETWORK) {
         _cb_data.error = _network->set_attach();
     }

features/cellular/mbed_lib.json

@@ -20,6 +20,26 @@
         "control-plane-opt": {
             "help": "Enables control plane CIoT EPS optimization",
             "value": false
+        },
+        "timeout-power-on": {
+            "help": "Timeout for device power on, null to ignore",
+            "value": 1000
+        },
+        "timeout-sim-pin": {
+            "help": "Timeout for SIM pin query response from the modem, null to ignore",
+            "value": 1000
+        },
+        "timeout-network-selection": {
+            "help": "Timeout for cellular selection response from the modem, null to ignore",
+            "value": 180000
+        },
+        "timeout-network-attach": {
+            "help": "Timeout for packet network attach response from the modem, null to ignore",
+            "value": 10000
+        },
+        "timeout-network-connect": {
+            "help": "Timeout for network connect and PDP context activation response from the modem, null to ignore",
+            "value": 60000
         }
     }
 }