Cellular: Add get_target_default_instance in CellularDevice

Author: Ari Parkkila

UNITTESTS/features/cellular/framework/device/cellulardevice/cellulardevicetest.cpp

@@ -53,7 +53,7 @@ TEST_F(TestCellularDevice, test_create_delete)
     dev = NULL;
 
     CellularDevice *dev1 = CellularDevice::get_default_instance();
-    EXPECT_TRUE(dev1);
+    EXPECT_FALSE(dev1);
 }
 
 TEST_F(TestCellularDevice, test_set_sim_pin)

UNITTESTS/stubs/AT_CellularDevice_stub.cpp

@@ -43,16 +43,6 @@ AT_CellularDevice::~AT_CellularDevice()
     delete _network;
 }
 
-nsapi_error_t AT_CellularDevice::power_on()
-{
-    return NSAPI_ERROR_UNSUPPORTED;
-}
-
-nsapi_error_t AT_CellularDevice::power_off()
-{
-    return NSAPI_ERROR_UNSUPPORTED;
-}
-
 ATHandler *AT_CellularDevice::get_at_handler(FileHandle *fileHandle)
 {
     return ATHandler::get_instance(fileHandle, _queue, _default_timeout, "\r", get_send_delay(), _modem_debug_on);
@@ -232,3 +222,13 @@ nsapi_error_t AT_CellularDevice::get_sim_state(SimState &state)
 
     return AT_CellularDevice_stub::nsapi_error_value;
 }
+
+nsapi_error_t AT_CellularDevice::power_on()
+{
+    return NSAPI_ERROR_UNSUPPORTED;
+}
+
+nsapi_error_t AT_CellularDevice::power_off()
+{
+    return NSAPI_ERROR_UNSUPPORTED;
+}

UNITTESTS/target_h/myCellularDevice.h

@@ -79,16 +79,6 @@ class myCellularDevice : public CellularDevice {
         return _network;
     }
 
-    nsapi_error_t power_on()
-    {
-        return NSAPI_ERROR_UNSUPPORTED;
-    }
-
-    nsapi_error_t power_off()
-    {
-        return NSAPI_ERROR_UNSUPPORTED;
-    }
-
     virtual CellularSMS *open_sms(FileHandle *fh = NULL)
     {
         return NULL;
@@ -137,6 +127,16 @@ class myCellularDevice : public CellularDevice {
         return NSAPI_ERROR_OK;
     }
 
+    virtual nsapi_error_t power_on()
+    {
+        return NSAPI_ERROR_UNSUPPORTED;
+    }
+
+    virtual nsapi_error_t power_off()
+    {
+        return NSAPI_ERROR_UNSUPPORTED;
+    }
+
     virtual void set_ready_cb(Callback<void()> callback)
     {
     }

features/cellular/framework/API/CellularDevice.h

@@ -58,12 +58,22 @@ class CellularDevice {
     };
 
     /** Returns singleton instance of CellularDevice if CELLULAR_DEVICE is defined. If CELLULAR_DEVICE is not
-     *  defined, then it returns NULL. Implementation is marked as weak.
+     *  defined, then it returns NULL. See NetworkInterface::get_default_instance for details.
      *
-     *  @return CellularDevice* instance if any
+     *  @remark Application may override this (non-weak) default implementation.
+     *
+     *  @return default CellularDevice, NULL if not defined
      */
     static CellularDevice *get_default_instance();
 
+    /** Return target onboard instance of CellularDevice
+     *
+     *  @remark Mbed OS target shall override (non-weak) this function for an onboard modem.
+     *
+     *  @return CellularDevice* instance, NULL if not defined
+     */
+    static CellularDevice *get_target_default_instance();
+
     /** Default constructor
      *
      *  @param fh   File handle used in communication with the modem.

features/cellular/framework/device/CellularContext.cpp

@@ -22,10 +22,9 @@ MBED_WEAK CellularBase *CellularBase::get_target_default_instance()
 }
 
 namespace mbed {
-#ifdef CELLULAR_DEVICE
+
 MBED_WEAK CellularContext *CellularContext::get_default_instance()
 {
-    // Uses default APN, uname, password from mbed_app.json
     CellularDevice *dev = CellularDevice::get_default_instance();
     if (!dev) {
         return NULL;
@@ -52,12 +51,6 @@ MBED_WEAK CellularContext *CellularContext::get_default_nonip_instance()
 #endif // #if defined(MDMDCD) && defined(MDM_PIN_POLARITY)
     return context;
 }
-#else
-MBED_WEAK CellularContext *CellularContext::get_default_instance()
-{
-    return NULL;
-}
-#endif // CELLULAR_DEVICE
 
 void CellularContext::cp_data_received()
 {

features/cellular/framework/device/CellularDevice.cpp

@@ -22,31 +22,17 @@
 #include "CellularTargets.h"
 #include "EventQueue.h"
 
-#ifdef CELLULAR_DEVICE
-#include CELLULAR_STRINGIFY(CELLULAR_DEVICE.h)
-#endif // CELLULAR_DEVICE
-
 namespace mbed {
 
-#ifdef CELLULAR_DEVICE
 MBED_WEAK CellularDevice *CellularDevice::get_default_instance()
 {
-    static UARTSerial serial(MDMTXD, MDMRXD, MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
-#if DEVICE_SERIAL_FC
-    if (MDMRTS != NC && MDMCTS != NC) {
-        tr_info("_USING flow control, MDMRTS: %d MDMCTS: %d", MDMRTS, MDMCTS);
-        serial.set_flow_control(SerialBase::RTSCTS, MDMRTS, MDMCTS);
-    }
-#endif
-    static CELLULAR_DEVICE device(&serial);
-    return &device;
+    return get_target_default_instance();
 }
-#else
-MBED_WEAK CellularDevice *CellularDevice::get_default_instance()
+
+MBED_WEAK CellularDevice *CellularDevice::get_target_default_instance()
 {
     return NULL;
 }
-#endif // CELLULAR_DEVICE
 
 CellularDevice::CellularDevice(FileHandle *fh) : _network_ref_count(0), _sms_ref_count(0),
     _info_ref_count(0), _fh(fh), _queue(5 * EVENTS_EVENT_SIZE), _state_machine(0), _nw(0), _status_cb(0)

features/cellular/framework/targets/GEMALTO/CINTERION/GEMALTO_CINTERION.cpp

@@ -32,10 +32,6 @@ GEMALTO_CINTERION::GEMALTO_CINTERION(FileHandle *fh) : AT_CellularDevice(fh)
 {
 }
 
-GEMALTO_CINTERION::~GEMALTO_CINTERION()
-{
-}
-
 AT_CellularContext *GEMALTO_CINTERION::create_context_impl(ATHandler &at, const char *apn, bool cp_req, bool nonip_req)
 {
     return new GEMALTO_CINTERION_CellularContext(at, this, apn, cp_req, nonip_req);
@@ -138,3 +134,17 @@ void GEMALTO_CINTERION::init_module_ems31()
     AT_CellularBase::set_cellular_properties(cellular_properties);
     _module = ModuleEMS31;
 }
+
+#if MBED_CONF_GEMALTO_CINTERION_DEFAULT_CELLULAR_DEVICE
+#include "UARTSerial.h"
+CellularDevice *CellularDevice::get_default_instance()
+{
+    static UARTSerial serial(MBED_CONF_GEMALTO_CINTERION_TX, MBED_CONF_GEMALTO_CINTERION_RX, MBED_CONF_GEMALTO_CINTERION_BAUDRATE);
+#if defined (MBED_CONF_UBLOX_AT_RTS) && defined(MBED_CONF_UBLOX_AT_CTS)
+    tr_info("GEMALTO_CINTERION flow control: RTS %d CTS %d", MBED_CONF_GEMALTO_CINTERION_RTS, MBED_CONF_GEMALTO_CINTERION_CTS);
+    serial.set_flow_control(SerialBase::RTSCTS, MBED_CONF_GEMALTO_CINTERION_RTS, MBED_CONF_GEMALTO_CINTERION_CTS);
+#endif
+    static GEMALTO_CINTERION device(&serial);
+    return &device;
+}
+#endif

features/cellular/framework/targets/GEMALTO/CINTERION/GEMALTO_CINTERION.h

@@ -26,7 +26,6 @@ class GEMALTO_CINTERION : public AT_CellularDevice {
 public:
 
     GEMALTO_CINTERION(FileHandle *fh);
-    virtual ~GEMALTO_CINTERION();
 
     /** Actual model of cellular module is needed to make AT command adaptation at runtime
      *  to support many different models in one cellular driver.

features/cellular/framework/targets/GEMALTO/CINTERION/mbed_lib.json

@@ -0,0 +1,35 @@
+{
+    "name": "GEMALTO_CINTERION",
+    "config": {
+        "tx": {
+            "help": "TX pin for serial connection",
+            "value": null
+        },
+        "rx": {
+            "help": "RX pin for serial connection",
+            "value": null
+        },
+        "rts": {
+            "help": "RTS pin for serial connection",
+            "value": null
+        },
+        "cts": {
+            "help": "CTS pin for serial connection",
+            "value": null
+        },
+        "baudrate" : {
+            "help": "Serial connection baud rate",
+            "value": 115200
+        },
+        "default-cellular-device": {
+            "help": "Provide as default CellularDevice [true/false]",
+            "value": false
+        }
+    },
+    "target_overrides": {
+        "K64F": {
+            "rx": "D0",
+            "tx": "D1"
+        }
+    }
+}

features/cellular/framework/targets/GENERIC/GENERIC_AT3GPP/GENERIC_AT3GPP.h

@@ -28,11 +28,7 @@ namespace mbed {
  *
  * GENERIC_AT3GPP can be used as a shield for example on top K64F.
  * Cellular example can be used for testing: https://github.com/ARMmbed/mbed-os-example-cellular
- * Add line to mbed_app.json where you define this class as CELLULAR_DEVICE and the correct pins. In cellular example
- * line would be for example just above "target_overrides": {...
- * For example:
- * "macros": ["CELLULAR_DEVICE=GENERIC_AT3GPP", "MDMRXD=PTC16", "MDMTXD=PTC17","MDMRTS=NC", "MDMCTS=NC"],
- * You can define CELLULAR_DEVICE and pins also in ../../../common/CellularTargets.h
+ * Define in mbed_app.json "target_overrides" correct pins and other setup for your modem.
  *
  * If new target don't work with GENERIC_AT3GPP then it needs some customizations.
  * First thing to try can be checking/modifying cellular_properties array in GENERIC_AT3GPP.cpp, does the module support

features/cellular/framework/targets/MultiTech/DragonflyNano/PPP/SARA4_PPP.cpp

@@ -15,8 +15,6 @@
  * limitations under the License.
  */
 
-#include "onboard_modem_api.h"
-
 #include "SARA4_PPP.h"
 #include "SARA4_PPP_CellularNetwork.h"
 
@@ -49,19 +47,16 @@ AT_CellularNetwork *SARA4_PPP::open_network_impl(ATHandler &at)
     return new SARA4_PPP_CellularNetwork(at);
 }
 
-nsapi_error_t SARA4_PPP::power_on()
+#if MBED_CONF_SARA4_PPP_DEFAULT_CELLULAR_DEVICE
+#include "UARTSerial.h"
+CellularDevice *CellularDevice::get_default_instance()
 {
-#if MODEM_ON_BOARD
-    ::onboard_modem_init();
-    ::onboard_modem_power_up();
+    static UARTSerial serial(MBED_CONF_SARA4_PPP_TX, MBED_CONF_SARA4_PPP_RX, MBED_CONF_SARA4_PPP_BAUDRATE);
+#if defined (MBED_CONF_SARA4_PPP_RTS) && defined (MBED_CONF_SARA4_PPP_CTS)
+    tr_info("SARA4_PPP flow control: RTS %d CTS %d", MBED_CONF_SARA4_PPP_RTS, MBED_CONF_SARA4_PPP_CTS);
+    serial.set_flow_control(SerialBase::RTSCTS, MBED_CONF_SARA4_PPP_RTS, MBED_CONF_SARA4_PPP_CTS);
 #endif
-    return NSAPI_ERROR_OK;
+    static SARA4_PPP device(&serial);
+    return &device;
 }
-
-nsapi_error_t SARA4_PPP::power_off()
-{
-#if MODEM_ON_BOARD
-    ::onboard_modem_power_down();
 #endif
-    return NSAPI_ERROR_OK;
-}

features/cellular/framework/targets/MultiTech/DragonflyNano/PPP/SARA4_PPP.h

@@ -30,8 +30,6 @@ class SARA4_PPP : public AT_CellularDevice {
 
 public: // CellularDevice
     virtual AT_CellularNetwork *open_network_impl(ATHandler &at);
-    virtual nsapi_error_t power_on();
-    virtual nsapi_error_t power_off();
 };
 
 } // namespace mbed

features/cellular/framework/targets/MultiTech/DragonflyNano/PPP/mbed_lib.json

@@ -0,0 +1,29 @@
+{
+    "name": "SARA4_PPP",
+    "config": {
+        "tx": {
+            "help": "TX pin for serial connection",
+            "value": null
+        },
+        "rx": {
+            "help": "RX pin for serial connection",
+            "value": null
+        },
+        "rts": {
+            "help": "RTS pin for serial connection",
+            "value": null
+        },
+        "cts": {
+            "help": "CTS pin for serial connection",
+            "value": null
+        },
+        "baudrate" : {
+            "help": "Serial connection baud rate",
+            "value": 115200
+        },
+        "default-cellular-device": {
+            "help": "Provide as default CellularDevice [true/false]",
+            "value": false
+        }
+    }
+}

features/cellular/framework/targets/QUECTEL/BC95/QUECTEL_BC95.cpp

@@ -104,3 +104,17 @@ nsapi_error_t QUECTEL_BC95::reset()
     _at->resp_start("REBOOTING", true);
     return _at->unlock_return_error();
 }
+
+#if MBED_CONF_QUECTEL_BC95_DEFAULT_CELLULAR_DEVICE
+#include "UARTSerial.h"
+CellularDevice *CellularDevice::get_default_instance()
+{
+    static UARTSerial serial(MBED_CONF_QUECTEL_BC95_TX, MBED_CONF_QUECTEL_BC95_RX, MBED_CONF_QUECTEL_BC95_BAUDRATE);
+#if defined (MBED_CONF_UBLOX_AT_RTS) && defined(MBED_CONF_UBLOX_AT_CTS)
+    tr_info("QUECTEL_BC95 flow control: RTS %d CTS %d", MBED_CONF_QUECTEL_BC95_RTS, MBED_CONF_QUECTEL_BC95_CTS);
+    serial.set_flow_control(SerialBase::RTSCTS, MBED_CONF_QUECTEL_BC95_RTS, MBED_CONF_QUECTEL_BC95_CTS);
+#endif
+    static QUECTEL_BC95 device(&serial);
+    return &device;
+}
+#endif

features/cellular/framework/targets/QUECTEL/BC95/mbed_lib.json

@@ -0,0 +1,29 @@
+{
+    "name": "QUECTEL_BC95",
+    "config": {
+        "tx": {
+            "help": "TX pin for serial connection",
+            "value": null
+        },
+        "rx": {
+            "help": "RX pin for serial connection",
+            "value": null
+        },
+        "rts": {
+            "help": "RTS pin for serial connection",
+            "value": null
+        },
+        "cts": {
+            "help": "CTS pin for serial connection",
+            "value": null
+        },
+        "baudrate" : {
+            "help": "Serial connection baud rate",
+            "value": 9600
+        },
+        "default-cellular-device": {
+            "help": "Provide as default CellularDevice [true/false]",
+            "value": false
+        }
+    }
+}

features/cellular/framework/targets/QUECTEL/BG96/QUECTEL_BG96.cpp

@@ -71,3 +71,17 @@ void QUECTEL_BG96::set_ready_cb(Callback<void()> callback)
 {
     _at->set_urc_handler(DEVICE_READY_URC, callback);
 }
+
+#if MBED_CONF_QUECTEL_BG96_DEFAULT_CELLULAR_DEVICE
+#include "UARTSerial.h"
+CellularDevice *CellularDevice::get_default_instance()
+{
+    static UARTSerial serial(MBED_CONF_QUECTEL_BG96_TX, MBED_CONF_QUECTEL_BG96_RX, MBED_CONF_QUECTEL_BG96_BAUDRATE);
+#if defined (MBED_CONF_UBLOX_AT_RTS) && defined(MBED_CONF_UBLOX_AT_CTS)
+    tr_info("QUECTEL_BG96 flow control: RTS %d CTS %d", MBED_CONF_QUECTEL_BG96_RTS, MBED_CONF_QUECTEL_BG96_CTS);
+    serial.set_flow_control(SerialBase::RTSCTS, MBED_CONF_QUECTEL_BG96_RTS, MBED_CONF_QUECTEL_BG96_CTS);
+#endif
+    static QUECTEL_BG96 device(&serial);
+    return &device;
+}
+#endif