Cellular: CellularDevice:get_default_instance() implemented

Removed copy-paste code from targets by creating implementation methods to override.

Author: Teppo Järvelin

features/cellular/easy_cellular/CellularConnectionFSM.cpp

@@ -24,6 +24,8 @@
 #endif
 #include "CellularLog.h"
 #include "CellularCommon.h"
+#include "CellularDevice.h"
+#include "CellularUtil.h"
 
 // timeout to wait for AT responses
 #define TIMEOUT_POWER_ON     (1*1000)
@@ -42,7 +44,7 @@ namespace mbed {
 CellularConnectionFSM::CellularConnectionFSM() :
     _serial(0), _state(STATE_INIT), _next_state(_state), _status_callback(0), _event_status_cb(0), _network(0), _power(0), _sim(0),
     _queue(8 * EVENTS_EVENT_SIZE), _queue_thread(0), _cellularDevice(0), _retry_count(0), _event_timeout(-1),
-    _at_queue(8 * EVENTS_EVENT_SIZE), _event_id(0), _plmn(0), _command_success(false), _plmn_network_found(false)
+    _at_queue(0), _event_id(0), _plmn(0), _command_success(false), _plmn_network_found(false)
 {
     memset(_sim_pin, 0, sizeof(_sim_pin));
 #if MBED_CONF_CELLULAR_RANDOM_MAX_START_DELAY == 0
@@ -82,12 +84,20 @@ void CellularConnectionFSM::stop()
         _queue_thread = NULL;
     }
 
-    delete _cellularDevice;
-    _cellularDevice = NULL;
-    // _cellularDevice closes all interfaces in destructor
-    _power = NULL;
-    _network = NULL;
-    _sim = NULL;
+    if (_power) {
+        _cellularDevice->close_power();
+        _power = NULL;
+    }
+
+    if (_network) {
+        _cellularDevice->close_network();
+        _network = NULL;
+    }
+
+    if (_sim) {
+        _cellularDevice->close_sim();
+        _sim = NULL;
+    }
 
     _state = STATE_INIT;
     _next_state = _state;
@@ -96,7 +106,7 @@ void CellularConnectionFSM::stop()
 nsapi_error_t CellularConnectionFSM::init()
 {
     tr_info("CELLULAR_DEVICE: %s", CELLULAR_STRINGIFY(CELLULAR_DEVICE));
-    _cellularDevice = new CELLULAR_DEVICE(_at_queue);
+    _cellularDevice = CellularDevice::get_default_instance();
     if (!_cellularDevice) {
         stop();
         return NSAPI_ERROR_NO_MEMORY;
@@ -120,7 +130,8 @@ nsapi_error_t CellularConnectionFSM::init()
         return NSAPI_ERROR_NO_MEMORY;
     }
 
-    _at_queue.chain(&_queue);
+    _at_queue = _cellularDevice->get_queue();
+    _at_queue->chain(&_queue);
 
     _retry_count = 0;
     _state = STATE_INIT;

features/cellular/easy_cellular/CellularConnectionFSM.h

@@ -15,8 +15,8 @@
  * limitations under the License.
  */
 
-#ifndef _CELLULAR_CONNECTION_UTIL_H
-#define _CELLULAR_CONNECTION_UTIL_H
+#ifndef _CELLULAR_CONNECTION_FSM_H
+#define _CELLULAR_CONNECTION_FSM_H
 
 #include "CellularTargets.h"
 #if defined(CELLULAR_DEVICE) || defined(DOXYGEN_ONLY)
@@ -29,13 +29,11 @@
 #include "CellularNetwork.h"
 #include "CellularPower.h"
 #include "CellularSIM.h"
-#include "CellularUtil.h"
-
-// modem type is defined as CELLULAR_DEVICE macro
-#include CELLULAR_STRINGIFY(CELLULAR_DEVICE.h)
 
 namespace mbed {
 
+class CellularDevice;
+
 const int PIN_SIZE = 8;
 const int MAX_RETRY_ARRAY_SIZE = 10;
 
@@ -209,7 +207,7 @@ class CellularConnectionFSM {
 
     uint16_t _retry_timeout_array[MAX_RETRY_ARRAY_SIZE];
     int _retry_array_length;
-    events::EventQueue _at_queue;
+    events::EventQueue *_at_queue;
     char _st_string[20];
     int _event_id;
     const char *_plmn;
@@ -221,4 +219,4 @@ class CellularConnectionFSM {
 
 #endif // CELLULAR_DEVICE || DOXYGEN
 
-#endif /* _CELLULAR_CONNECTION_UTIL_H */
+#endif // _CELLULAR_CONNECTION_FSM_H

features/cellular/easy_cellular/EasyCellularConnection.cpp

@@ -23,7 +23,7 @@
 #endif
 
 #include "CellularConnectionFSM.h"
-#include "CellularUtil.h"
+#include "CellularDevice.h"
 
 #include "EasyCellularConnection.h"
 #include "CellularLog.h"

features/cellular/framework/API/CellularDevice.h

@@ -18,17 +18,22 @@
 #ifndef CELLULAR_DEVICE_H_
 #define CELLULAR_DEVICE_H_
 
-#include "FileHandle.h"
+#include "CellularTargets.h"
+#include "EventQueue.h"
+#include "nsapi_types.h"
+#include "PlatformMutex.h"
 
-#include "CellularSIM.h"
-#include "CellularNetwork.h"
-#include "CellularSMS.h"
-#include "CellularPower.h"
-#include "CellularInformation.h"
-#include "NetworkStack.h"
+class NetworkStack;
 
 namespace mbed {
 
+class CellularPower;
+class CellularSMS;
+class CellularSIM;
+class CellularInformation;
+class CellularNetwork;
+class FileHandle;
+
 /**
  *  Class CellularDevice
  *
@@ -37,6 +42,24 @@ namespace mbed {
  */
 class CellularDevice {
 public:
+
+    /** Return singleton instance of CellularDevice if CELLULAR_DEVICE is defined. If CELLULAR_DEVICE is not
+     *  defined then returns NULL. Implementation is marked as weak.
+     *
+     *  @return CellularDevice* instance if any
+     */
+    static CellularDevice *get_default_instance();
+
+    /** Get event queue that can be chained to main event queue. EventQueue is created in get_default_instance() or
+     *  given to CELLULAR_DEVICE (for example TELIT_HE910 class).
+     *  @return event queue
+     */
+    virtual events::EventQueue *get_queue() const;
+
+    /** Default constructor
+     */
+    CellularDevice();
+
     /** virtual Destructor
      */
     virtual ~CellularDevice() {}
@@ -124,6 +147,13 @@ class CellularDevice {
      *  @return 0 on success
      */
     virtual nsapi_error_t init_module(FileHandle *fh) = 0;
+
+protected:
+    int _network_ref_count;
+    int _sms_ref_count;
+    int _power_ref_count;
+    int _sim_ref_count;
+    int _info_ref_count;
 };
 
 } // namespace mbed