Initial attempt at porting Arduino's Cinterion TX62 patch

Author: multiplemonomials

connectivity/cellular/include/cellular/framework/API/ATHandler.h

@@ -363,6 +363,12 @@ class ATHandler {
      */
     void write_hex_string(const char *str, size_t size, bool quote_string = true);
 
+    /** Get the error detected during read_int()
+     *
+     *  @return the latest negative integer error got from read_int().
+     */
+    int32_t get_last_read_error() const;
+
     /** Reads as string and converts result to integer. Supports only non-negative integers.
      *
      *  @return the non-negative integer or -1 in case of error.
@@ -599,6 +605,7 @@ class ATHandler {
     nsapi_error_t _last_err;
     int _last_3gpp_error;
     device_err_t  _last_at_err;
+    int32_t _last_read_error{};
     uint16_t _oob_string_max_length;
     char *_output_delimiter;
 

connectivity/cellular/include/cellular/framework/API/CellularContext.h

@@ -41,6 +41,29 @@ namespace mbed {
  * @{
  */
 
+/// Radio Access Technology type
+enum RadioAccessTechnologyType {
+    CATM1 = 7, ///< LTE CAT-M or LTE-M
+    CATNB = 8 ///< NB-IoT (Narrowband IoT)
+};
+
+enum FrequencyBand {
+    BAND_1 = 0x01,
+    BAND_2 = 0x02,
+    BAND_3 = 0x04,
+    BAND_4 = 0x08,
+    BAND_5 = 0x10,
+    BAND_8 = 0x80,
+    BAND_12 = 0x800,
+    BAND_13 = 0x1000,
+    BAND_18 = 0x20000,
+    BAND_19 = 0x40000,
+    BAND_20 = 0x80000,
+    BAND_25 = 0x1000000,
+    BAND_26 = 0x2000000,
+    BAND_28 = 0x8000000
+};
+
 /// CellularContext is CellularInterface/NetworkInterface with extensions for cellular connectivity
 class CellularContext : public CellularInterface {
 
@@ -158,6 +181,8 @@ class CellularContext : public CellularInterface {
     virtual nsapi_error_t connect(const char *sim_pin, const char *apn = 0, const char *uname = 0,
                                   const char *pwd = 0) = 0;
     virtual void set_credentials(const char *apn, const char *uname = 0, const char *pwd = 0) = 0;
+    virtual void set_access_technology(RadioAccessTechnologyType rat = CATM1) = 0;
+    virtual void set_band(FrequencyBand band = BAND_20) = 0;
     virtual bool is_connected() = 0;
 
     /** Same as NetworkInterface::get_default_instance()

connectivity/cellular/include/cellular/framework/AT/AT_CellularContext.h

@@ -22,6 +22,7 @@
 #include "rtos/Semaphore.h"
 #include "AT_CellularDevice.h"
 
+#include <optional>
 
 const int MAX_APN_LENGTH = 63 + 1;
 
@@ -54,6 +55,8 @@ class AT_CellularContext : public CellularContext {
     virtual nsapi_error_t connect(const char *sim_pin, const char *apn = 0, const char *uname = 0,
                                   const char *pwd = 0);
     virtual void set_credentials(const char *apn, const char *uname = 0, const char *pwd = 0);
+    virtual void set_access_technology(RadioAccessTechnologyType rat = CATM1);
+    virtual void set_band(FrequencyBand band = BAND_20);
 
 // from CellularContext
     virtual nsapi_error_t get_pdpcontext_params(pdpContextList_t &params_list);
@@ -115,6 +118,13 @@ class AT_CellularContext : public CellularContext {
      */
     virtual const char *get_nonip_context_type_str();
 
+    /**
+     * @brief Set the cellular technology and band based on the \c _rat and \c _band class variables.
+     *
+     * Modems which support this functionality should override this in their CellularContext implementations.
+     */
+    virtual void enable_access_technology() {}
+
 private:
 #if NSAPI_PPP_AVAILABLE
     nsapi_error_t open_data_channel();
@@ -146,6 +156,8 @@ class AT_CellularContext : public CellularContext {
     bool _cp_req;
     bool _is_connected;
     ATHandler &_at;
+    std::optional<RadioAccessTechnologyType> _rat;
+    std::optional<FrequencyBand> _band;
 };
 
 /**

connectivity/cellular/source/framework/AT/AT_CellularContext.cpp

@@ -109,6 +109,19 @@ nsapi_error_t AT_CellularContext::connect()
     }
     call_network_cb(NSAPI_STATUS_CONNECTING);
 
+    set_device_ready();
+
+    _at.lock();
+    bool valid_context = get_context();
+    _at.unlock();
+    if(!valid_context) {
+        set_new_context(_cid);
+    }
+
+    do_user_authentication();
+
+    enable_access_technology();
+
     nsapi_error_t err = _device->attach_to_network();
     _cb_data.error = check_operation(err, OP_CONNECT);
     _retry_count = 0;
@@ -278,6 +291,16 @@ void AT_CellularContext::set_credentials(const char *apn, const char *uname, con
     _pwd = pwd;
 }
 
+void AT_CellularContext::set_access_technology(RadioAccessTechnologyType rat)
+{
+    _rat = rat;
+}
+
+void AT_CellularContext::set_band(FrequencyBand band)
+{
+    _band = band;
+}
+
 // PDP Context handling
 void AT_CellularContext::delete_current_context()
 {
@@ -352,7 +375,7 @@ bool AT_CellularContext::get_context()
         int pdp_type_len = _at.read_string(pdp_type_from_context, sizeof(pdp_type_from_context));
         if (pdp_type_len > 0) {
             apn_len = _at.read_string(apn, sizeof(apn));
-            if (apn_len >= 0) {
+            if (apn_len > 0) {
                 if (_apn && (strcmp(apn, _apn) != 0)) {
                     tr_debug("CID %d APN \"%s\"", cid, apn);
                     continue;
@@ -370,6 +393,9 @@ bool AT_CellularContext::get_context()
                     set_cid(cid);
                 }
             }
+            else {
+                cid_max = 0;
+            }
         }
     }
 

connectivity/cellular/source/framework/AT/AT_CellularDevice.cpp

@@ -414,7 +414,8 @@ nsapi_error_t AT_CellularDevice::init()
         _at.flush();
         _at.at_cmd_discard("E0", "");
         if (_at.get_last_error() == NSAPI_ERROR_OK) {
-            _at.at_cmd_discard("+CMEE", "=1");
+            // Enable verbose error messages
+            _at.at_cmd_discard("+CMEE", "=2");
             _at.at_cmd_discard("+CFUN", "=1");
             if (_at.get_last_error() == NSAPI_ERROR_OK) {
                 break;

connectivity/cellular/source/framework/AT/AT_CellularNetwork.cpp

@@ -219,6 +219,7 @@ nsapi_error_t AT_CellularNetwork::set_registration(const char *plmn)
             return NSAPI_ERROR_DEVICE_ERROR;
         }
         if (mode != NWModeAutomatic) {
+            // Force operator registration
             return _at.at_cmd_discard("+COPS", "=0");
         }
         return NSAPI_ERROR_OK;

connectivity/cellular/source/framework/device/ATHandler.cpp

@@ -46,7 +46,7 @@ using namespace std::chrono_literals;
 #define PROCESS_URC_TIME 20ms
 
 // Suppress logging of very big packet payloads, maxlen is approximate due to write/read are cached
-#define DEBUG_MAXLEN 60
+#define DEBUG_MAXLEN 120
 #define DEBUG_END_MARK "..\r"
 
 const char *mbed::OK = "OK\r\n";
@@ -697,6 +697,11 @@ ssize_t ATHandler::read_hex_string(char *buf, size_t size)
     return buf_idx;
 }
 
+int32_t ATHandler::get_last_read_error() const
+{
+    return _last_read_error;
+}
+
 int32_t ATHandler::read_int()
 {
     if (!ok_to_proceed() || !_stop_tag ||  _stop_tag->found) {
@@ -711,9 +716,11 @@ int32_t ATHandler::read_int()
     errno = 0;
     long result = std::strtol(buff, NULL, 10);
     if ((result == LONG_MIN || result == LONG_MAX) && errno == ERANGE) {
+        _last_read_error = result;
         return -1; // overflow/underflow
     }
     if (result < 0) {
+        _last_read_error = result;
         return -1; // negative values are unsupported
     }
     if (*buff == '\0') {

connectivity/cellular/source/framework/device/CellularStateMachine.cpp

@@ -28,7 +28,7 @@ using namespace std::chrono_literals;
 
 // timeout to wait for AT responses
 #define TIMEOUT_POWER_ON     1s
-#define TIMEOUT_SIM_PIN      1s
+#define TIMEOUT_SIM_PIN      10s
 #define TIMEOUT_NETWORK      10s
 /** CellularStateMachine does connecting up to packet service attach, and
  *  after that it's up to CellularContext::connect() to connect to PDN.

connectivity/drivers/cellular/GEMALTO/COMPONENT_GEMALTO_CINTERION/GEMALTO_CINTERION.cpp

@@ -70,6 +70,8 @@ nsapi_error_t GEMALTO_CINTERION::init()
         init_module_ems31();
     } else if (memcmp(model, "EHS5-E", sizeof("EHS5-E") - 1) == 0) {
         init_module_ehs5e();
+    } else if (memcmp(model, "TX62", sizeof("TX62") - 1) == 0) {
+        init_module_tx62();
     } else {
         tr_error("Cinterion model unsupported %s", model);
         return NSAPI_ERROR_UNSUPPORTED;
@@ -202,6 +204,35 @@ void GEMALTO_CINTERION::init_module_ehs5e()
     _module = ModuleEHS5E;
 }
 
+void GEMALTO_CINTERION::init_module_tx62()
+{
+    // TX-62
+    static const intptr_t cellular_properties[AT_CellularDevice::PROPERTY_MAX] = {
+        AT_CellularNetwork::RegistrationModeLAC,// C_EREG
+        AT_CellularNetwork::RegistrationModeDisable,    // C_GREG
+        AT_CellularNetwork::RegistrationModeDisable,    // C_REG
+        0,  // AT_CGSN_WITH_TYPE
+        0,  // AT_CGDATA
+        1,  // AT_CGAUTH
+        1,  // AT_CNMI
+        1,  // AT_CSMP
+        1,  // AT_CMGF
+        0,  // AT_CSDH
+        1,  // PROPERTY_IPV4_STACK
+        0,  // PROPERTY_IPV6_STACK
+        0,  // PROPERTY_IPV4V6_STACK
+        0,  // PROPERTY_NON_IP_PDP_TYPE
+        0,  // PROPERTY_AT_CGEREP
+        0,  // PROPERTY_AT_COPS_FALLBACK_AUTO
+        7,  // PROPERTY_SOCKET_COUNT
+        1,  // PROPERTY_IP_TCP
+        1,  // PROPERTY_IP_UDP
+        100,  // PROPERTY_AT_SEND_DELAY
+    };
+    set_cellular_properties(cellular_properties);
+    _module = ModuleTX62;
+}
+
 #if MBED_CONF_GEMALTO_CINTERION_PROVIDE_DEFAULT
 #include "drivers/BufferedSerial.h"
 CellularDevice *CellularDevice::get_default_instance()

connectivity/drivers/cellular/GEMALTO/COMPONENT_GEMALTO_CINTERION/GEMALTO_CINTERION.h

@@ -44,6 +44,7 @@ class GEMALTO_CINTERION : public AT_CellularDevice {
         ModuleBGS2,
         ModuleEMS31,
         ModuleEHS5E,
+        ModuleTX62,
     };
     static Module get_module();
 
@@ -60,6 +61,7 @@ class GEMALTO_CINTERION : public AT_CellularDevice {
     void init_module_els61();
     void init_module_ems31();
     void init_module_ehs5e();
+    void init_module_tx62();
 };
 
 } // namespace mbed