Cellular: Move ready_cb from power to device

Ari Parkkila · Ari Parkkila · commit 7f7ffbe654a3 · 2018-12-10T00:14:29.000-08:00
diff --git a/UNITTESTS/features/cellular/framework/AT/at_cellulardevice/at_cellulardevicetest.cpp b/UNITTESTS/features/cellular/framework/AT/at_cellulardevice/at_cellulardevicetest.cpp
@@ -372,3 +372,17 @@ TEST_F(TestAT_CellularDevice, TestAT_CellularDevice_get_sim_state)
 
     delete dev;
 }
+
+static void device_ready_cb()
+{
+}
+
+TEST_F(TestAT_CellularDevice, test_AT_CellularDevice_set_ready_cb)
+{
+    EventQueue que;
+    FileHandle_stub fh1;
+    AT_CellularDevice *dev = new AT_CellularDevice(&fh1);
+
+    EXPECT_TRUE(NSAPI_ERROR_UNSUPPORTED == dev->set_ready_cb(&device_ready_cb));
+    EXPECT_TRUE(NSAPI_ERROR_UNSUPPORTED == dev->set_ready_cb(0));
+}
diff --git a/UNITTESTS/features/cellular/framework/AT/at_cellularpower/at_cellularpowertest.cpp b/UNITTESTS/features/cellular/framework/AT/at_cellularpower/at_cellularpowertest.cpp
@@ -41,10 +41,6 @@ class TestAT_CellularPower : public testing::Test {
 // *INDENT-ON*
 
 
-static void device_ready_cb()
-{
-}
-
 TEST_F(TestAT_CellularPower, Create)
 {
 
@@ -122,27 +118,3 @@ TEST_F(TestAT_CellularPower, test_AT_CellularPower_reset)
     ATHandler_stub::nsapi_error_value = NSAPI_ERROR_DEVICE_ERROR;
     EXPECT_TRUE(NSAPI_ERROR_DEVICE_ERROR == pow.reset());
 }
-
-TEST_F(TestAT_CellularPower, test_AT_CellularPower_set_device_ready_urc_cb)
-{
-    EventQueue que;
-    FileHandle_stub fh1;
-    ATHandler at(&fh1, que, 0, ",");
-
-    AT_CellularPower pow(at);
-    EXPECT_TRUE(NSAPI_ERROR_UNSUPPORTED == pow.set_device_ready_urc_cb(&device_ready_cb));
-    EXPECT_TRUE(NSAPI_ERROR_UNSUPPORTED == pow.set_device_ready_urc_cb(NULL));
-}
-
-TEST_F(TestAT_CellularPower, test_AT_CellularPower_remove_device_ready_urc_cb)
-{
-    EventQueue que;
-    FileHandle_stub fh1;
-    ATHandler at(&fh1, que, 0, ",");
-
-    AT_CellularPower pow(at);
-    EXPECT_TRUE(NSAPI_ERROR_UNSUPPORTED == pow.set_device_ready_urc_cb(&device_ready_cb));
-
-    pow.remove_device_ready_urc_cb(NULL);
-    pow.remove_device_ready_urc_cb(&device_ready_cb);
-}
diff --git a/UNITTESTS/stubs/AT_CellularDevice_stub.cpp b/UNITTESTS/stubs/AT_CellularDevice_stub.cpp
@@ -149,9 +149,14 @@ nsapi_error_t AT_CellularDevice::is_ready()
     return NSAPI_ERROR_OK;
 }
 
+nsapi_error_t AT_CellularDevice::set_ready_cb(mbed::Callback<void()> callback)
+{
+    return NSAPI_ERROR_UNSUPPORTED;
+}
+
 nsapi_error_t AT_CellularDevice::set_power_save_mode(int periodic_time, int active_time)
 {
-    return NSAPI_ERROR_OK;
+    return NSAPI_ERROR_UNSUPPORTED;
 }
 
 nsapi_error_t AT_CellularDevice::init_module()
diff --git a/UNITTESTS/stubs/AT_CellularPower_stub.cpp b/UNITTESTS/stubs/AT_CellularPower_stub.cpp
@@ -54,13 +54,3 @@ nsapi_error_t AT_CellularPower::reset()
 {
     return NSAPI_ERROR_OK;
 }
-
-nsapi_error_t AT_CellularPower::set_device_ready_urc_cb(mbed::Callback<void()> callback)
-{
-    return NSAPI_ERROR_OK;
-}
-
-void AT_CellularPower::remove_device_ready_urc_cb(mbed::Callback<void()> callback)
-{
-
-}
diff --git a/UNITTESTS/target_h/myCellularDevice.h b/UNITTESTS/target_h/myCellularDevice.h
@@ -114,6 +114,11 @@ class myCellularDevice : public CellularDevice {
         return NSAPI_ERROR_OK;
     }
 
+    virtual nsapi_error_t set_ready_cb(Callback<void()> callback)
+    {
+        return NSAPI_ERROR_UNSUPPORTED;
+    }
+
     nsapi_error_t set_power_save_mode(int periodic_time, int active_time)
     {
         return NSAPI_ERROR_OK;
diff --git a/features/cellular/TESTS/api/cellular_power/main.cpp b/features/cellular/TESTS/api/cellular_power/main.cpp
@@ -52,7 +52,7 @@ static void urc_callback()
 
 static void wait_for_power(CellularPower *pwr)
 {
-    nsapi_error_t err = pwr->set_device_ready_urc_cb(&urc_callback);
+    nsapi_error_t err = cellular_device->set_ready_cb(&urc_callback);
     TEST_ASSERT(err == NSAPI_ERROR_OK || err == NSAPI_ERROR_UNSUPPORTED);
 
     int sanity_count = 0;
@@ -66,7 +66,7 @@ static void wait_for_power(CellularPower *pwr)
 
     TEST_ASSERT(cellular_device->is_ready() == NSAPI_ERROR_OK);
 
-    pwr->remove_device_ready_urc_cb(&urc_callback);
+    TEST_ASSERT(cellular_device->set_ready_cb(0) == NSAPI_ERROR_OK);
 }
 
 static void test_power_interface()
diff --git a/features/cellular/framework/API/CellularDevice.h b/features/cellular/framework/API/CellularDevice.h
@@ -255,6 +255,16 @@ class CellularDevice {
      */
     virtual nsapi_error_t is_ready() = 0;
 
+    /** Set callback function to listen when device is ready.
+     *
+     *  @param callback function to call on device ready, or NULL to remove callback.
+     *
+     *  @return         NSAPI_ERROR_OK on success
+     *                  NSAPI_ERROR_NO_MEMORY on memory failure
+     *                  NSAPI_ERROR_UNSUPPORTED if not overridden by the target modem
+     */
+    virtual nsapi_error_t set_ready_cb(Callback<void()> callback) = 0;
+
     /** Set power save mode
      *
      *  @remark See 3GPP TS 27.007 PSM for details
diff --git a/features/cellular/framework/API/CellularPower.h b/features/cellular/framework/API/CellularPower.h
@@ -92,24 +92,6 @@ class CellularPower {
      *                  NSAPI_ERROR_DEVICE_ERROR on failure
      */
     virtual nsapi_error_t reset() = 0;
-
-    /** Set URC callback function for device specific ready urc. URC is defined in device specific
-     *  power API. Used in startup sequence to listen when device is ready
-     *  for using at commands and possible sim.
-     *
-     *  @param callback Callback function called when urc received
-     *
-     *  @return         NSAPI_ERROR_OK on success
-     *                  NSAPI_ERROR_NO_MEMORY on memory failure
-     *                  NSAPI_ERROR_UNSUPPORTED if not overridden by the target modem
-     */
-    virtual nsapi_error_t set_device_ready_urc_cb(mbed::Callback<void()> callback) = 0;
-
-    /** Removes the device ready urc from the list of urc's.
-     *
-     *  @param callback callback to remove from the list of urc's
-     */
-    virtual void remove_device_ready_urc_cb(mbed::Callback<void()> callback) = 0;
 };
 
 } // namespace mbed
diff --git a/features/cellular/framework/AT/AT_CellularDevice.cpp b/features/cellular/framework/AT/AT_CellularDevice.cpp
@@ -415,6 +415,11 @@ nsapi_error_t AT_CellularDevice::is_ready()
     return _at->unlock_return_error();
 }
 
+nsapi_error_t AT_CellularDevice::set_ready_cb(Callback<void()> callback)
+{
+    return NSAPI_ERROR_UNSUPPORTED;
+}
+
 nsapi_error_t AT_CellularDevice::set_power_save_mode(int periodic_time, int active_time)
 {
     _at->lock();
diff --git a/features/cellular/framework/AT/AT_CellularDevice.h b/features/cellular/framework/AT/AT_CellularDevice.h
@@ -72,6 +72,8 @@ class AT_CellularDevice : public CellularDevice {
 
     virtual nsapi_error_t is_ready();
 
+    virtual nsapi_error_t set_ready_cb(Callback<void()> callback);
+
     virtual nsapi_error_t set_power_save_mode(int periodic_time, int active_time = 0);
 
     virtual nsapi_error_t init_module();
diff --git a/features/cellular/framework/AT/AT_CellularPower.cpp b/features/cellular/framework/AT/AT_CellularPower.cpp
@@ -73,12 +73,3 @@ nsapi_error_t AT_CellularPower::reset()
     _at.cmd_stop_read_resp();
     return _at.unlock_return_error();
 }
-
-nsapi_error_t AT_CellularPower::set_device_ready_urc_cb(mbed::Callback<void()> callback)
-{
-    return NSAPI_ERROR_UNSUPPORTED;
-}
-
-void AT_CellularPower::remove_device_ready_urc_cb(mbed::Callback<void()> callback)
-{
-}
diff --git a/features/cellular/framework/AT/AT_CellularPower.h b/features/cellular/framework/AT/AT_CellularPower.h
@@ -43,10 +43,6 @@ class AT_CellularPower : public CellularPower, public AT_CellularBase {
     virtual nsapi_error_t set_power_level(int func_level, int do_reset = 0);
 
     virtual nsapi_error_t reset();
-
-    virtual nsapi_error_t set_device_ready_urc_cb(mbed::Callback<void()> callback);
-
-    virtual void remove_device_ready_urc_cb(mbed::Callback<void()> callback);
 };
 
 } // namespace mbed
diff --git a/features/cellular/framework/device/CellularStateMachine.cpp b/features/cellular/framework/device/CellularStateMachine.cpp
@@ -385,8 +385,7 @@ bool CellularStateMachine::device_ready()
     if (_event_status_cb) {
         _event_status_cb((nsapi_event_t)CellularDeviceReady, (intptr_t)&_cb_data);
     }
-
-    _power->remove_device_ready_urc_cb(mbed::callback(this, &CellularStateMachine::ready_urc_cb));
+    _cellularDevice.set_ready_cb(0);
     _cellularDevice.close_power();
     _power = NULL;
     return true;
@@ -404,7 +403,7 @@ void CellularStateMachine::state_device_ready()
         }
     } else {
         if (_retry_count == 0) {
-            _power->set_device_ready_urc_cb(mbed::callback(this, &CellularStateMachine::ready_urc_cb));
+            _cellularDevice.set_ready_cb(callback(this, &CellularStateMachine::device_ready_cb));
         }
         retry_state_or_fail();
     }
diff --git a/features/cellular/framework/device/CellularStateMachine.h b/features/cellular/framework/device/CellularStateMachine.h
@@ -154,7 +154,7 @@ class CellularStateMachine {
     bool is_registered_to_plmn();
     void report_failure(const char *msg);
     void event();
-    void ready_urc_cb();
+    void device_ready_cb();
     void pre_event(CellularState state);
     bool check_is_target_reached();
 
diff --git a/features/cellular/framework/targets/QUECTEL/BG96/QUECTEL_BG96.cpp b/features/cellular/framework/targets/QUECTEL/BG96/QUECTEL_BG96.cpp
@@ -32,6 +32,8 @@ using namespace events;
 #define MAX_STARTUP_TRIALS 5
 #define MAX_RESET_TRIALS 5
 
+#define DEVICE_READY_URC "CPIN:"
+
 static const AT_CellularBase::SupportedFeature unsupported_features[] =  {
     AT_CellularBase::AT_CGSN_WITH_TYPE,
     AT_CellularBase::SUPPORTED_FEATURE_END_MARK
@@ -61,7 +63,3 @@ AT_CellularContext *QUECTEL_BG96::create_context_impl(ATHandler &at, const char
     return new QUECTEL_BG96_CellularContext(at, this, apn);
 }
 
-AT_CellularInformation *QUECTEL_BG96::open_information_impl(ATHandler &at)
-{
-    return new QUECTEL_BG96_CellularInformation(at);
-}
diff --git a/features/cellular/framework/targets/QUECTEL/BG96/QUECTEL_BG96.h b/features/cellular/framework/targets/QUECTEL/BG96/QUECTEL_BG96.h
@@ -32,6 +32,8 @@ class QUECTEL_BG96 : public AT_CellularDevice {
     virtual AT_CellularPower *open_power_impl(ATHandler &at);
     virtual AT_CellularContext *create_context_impl(ATHandler &at, const char *apn);
     virtual AT_CellularInformation *open_information_impl(ATHandler &at);
+    virtual nsapi_error_t set_ready_cb(Callback<void()> callback);
+
 public:
     void handle_urc(FileHandle *fh);
 };
diff --git a/features/cellular/framework/targets/QUECTEL/BG96/QUECTEL_BG96_CellularPower.cpp b/features/cellular/framework/targets/QUECTEL/BG96/QUECTEL_BG96_CellularPower.cpp
@@ -24,13 +24,3 @@ using namespace mbed;
 QUECTEL_BG96_CellularPower::QUECTEL_BG96_CellularPower(ATHandler &atHandler) : AT_CellularPower(atHandler)
 {
 }
-
-nsapi_error_t QUECTEL_BG96_CellularPower::set_device_ready_urc_cb(mbed::Callback<void()> callback)
-{
-    return _at.set_urc_handler(DEVICE_READY_URC, callback);
-}
-
-void QUECTEL_BG96_CellularPower::remove_device_ready_urc_cb(mbed::Callback<void()> callback)
-{
-    _at.set_urc_handler(DEVICE_READY_URC, 0);
-}
diff --git a/features/cellular/framework/targets/QUECTEL/BG96/QUECTEL_BG96_CellularPower.h b/features/cellular/framework/targets/QUECTEL/BG96/QUECTEL_BG96_CellularPower.h
@@ -25,10 +25,6 @@ namespace mbed {
 class QUECTEL_BG96_CellularPower : public AT_CellularPower {
 public:
     QUECTEL_BG96_CellularPower(ATHandler &atHandler);
-
-public: //from CellularPower
-    virtual nsapi_error_t set_device_ready_urc_cb(mbed::Callback<void()> callback);
-    virtual void remove_device_ready_urc_cb(mbed::Callback<void()> callback);
 };
 
 } // namespace mbed

Original file line number	Diff line number	Diff line change
`@@ -149,9 +149,14 @@ nsapi_error_t AT_CellularDevice::is_ready()`
`149`	`149`	`return NSAPI_ERROR_OK;`
`150`	`150`	`}`
`151`	`151`
	`152`	`+nsapi_error_t AT_CellularDevice::set_ready_cb(mbed::Callback<void()> callback)`
	`153`	`+{`
	`154`	`+ return NSAPI_ERROR_UNSUPPORTED;`
	`155`	`+}`
	`156`	`+`
`152`	`157`	`nsapi_error_t AT_CellularDevice::set_power_save_mode(int periodic_time, int active_time)`
`153`	`158`	`{`
`154`		`- return NSAPI_ERROR_OK;`
	`159`	`+ return NSAPI_ERROR_UNSUPPORTED;`
`155`	`160`	`}`
`156`	`161`
`157`	`162`	`nsapi_error_t AT_CellularDevice::init_module()`
Original file line number	Diff line number	Diff line change
`@@ -54,13 +54,3 @@ nsapi_error_t AT_CellularPower::reset()`
`54`	`54`	`{`
`55`	`55`	`return NSAPI_ERROR_OK;`
`56`	`56`	`}`
`57`		`-`
`58`		`-nsapi_error_t AT_CellularPower::set_device_ready_urc_cb(mbed::Callback<void()> callback)`
`59`		`-{`
`60`		`- return NSAPI_ERROR_OK;`
`61`		`-}`
`62`		`-`
`63`		`-void AT_CellularPower::remove_device_ready_urc_cb(mbed::Callback<void()> callback)`
`64`		`-{`
`65`		`-`
`66`		`-}`
Original file line number	Diff line number	Diff line change
`@@ -114,6 +114,11 @@ class myCellularDevice : public CellularDevice {`
`114`	`114`	`return NSAPI_ERROR_OK;`
`115`	`115`	`}`
`116`	`116`
	`117`	`+ virtual nsapi_error_t set_ready_cb(Callback<void()> callback)`
	`118`	`+ {`
	`119`	`+ return NSAPI_ERROR_UNSUPPORTED;`
	`120`	`+ }`
	`121`	`+`
`117`	`122`	`nsapi_error_t set_power_save_mode(int periodic_time, int active_time)`
`118`	`123`	`{`
`119`	`124`	`return NSAPI_ERROR_OK;`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ static void urc_callback()`
`52`	`52`
`53`	`53`	`static void wait_for_power(CellularPower *pwr)`
`54`	`54`	`{`
`55`		`- nsapi_error_t err = pwr->set_device_ready_urc_cb(&urc_callback);`
	`55`	`+ nsapi_error_t err = cellular_device->set_ready_cb(&urc_callback);`
`56`	`56`	`TEST_ASSERT(err == NSAPI_ERROR_OK \|\| err == NSAPI_ERROR_UNSUPPORTED);`
`57`	`57`
`58`	`58`	`int sanity_count = 0;`
`@@ -66,7 +66,7 @@ static void wait_for_power(CellularPower *pwr)`
`66`	`66`
`67`	`67`	`TEST_ASSERT(cellular_device->is_ready() == NSAPI_ERROR_OK);`
`68`	`68`
`69`		`- pwr->remove_device_ready_urc_cb(&urc_callback);`
	`69`	`+ TEST_ASSERT(cellular_device->set_ready_cb(0) == NSAPI_ERROR_OK);`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`static void test_power_interface()`
Original file line number	Diff line number	Diff line change
`@@ -415,6 +415,11 @@ nsapi_error_t AT_CellularDevice::is_ready()`
`415`	`415`	`return _at->unlock_return_error();`
`416`	`416`	`}`
`417`	`417`
	`418`	`+nsapi_error_t AT_CellularDevice::set_ready_cb(Callback<void()> callback)`
	`419`	`+{`
	`420`	`+ return NSAPI_ERROR_UNSUPPORTED;`
	`421`	`+}`
	`422`	`+`
`418`	`423`	`nsapi_error_t AT_CellularDevice::set_power_save_mode(int periodic_time, int active_time)`
`419`	`424`	`{`
`420`	`425`	`_at->lock();`
Original file line number	Diff line number	Diff line change
`@@ -385,8 +385,7 @@ bool CellularStateMachine::device_ready()`
`385`	`385`	`if (_event_status_cb) {`
`386`	`386`	`_event_status_cb((nsapi_event_t)CellularDeviceReady, (intptr_t)&_cb_data);`
`387`	`387`	`}`
`388`		`-`
`389`		`- _power->remove_device_ready_urc_cb(mbed::callback(this, &CellularStateMachine::ready_urc_cb));`
	`388`	`+ _cellularDevice.set_ready_cb(0);`
`390`	`389`	`_cellularDevice.close_power();`
`391`	`390`	`_power = NULL;`
`392`	`391`	`return true;`
`@@ -404,7 +403,7 @@ void CellularStateMachine::state_device_ready()`
`404`	`403`	`}`
`405`	`404`	`} else {`
`406`	`405`	`if (_retry_count == 0) {`
`407`		`- _power->set_device_ready_urc_cb(mbed::callback(this, &CellularStateMachine::ready_urc_cb));`
	`406`	`+ _cellularDevice.set_ready_cb(callback(this, &CellularStateMachine::device_ready_cb));`
`408`	`407`	`}`
`409`	`408`	`retry_state_or_fail();`
`410`	`409`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,13 +24,3 @@ using namespace mbed;`
`24`	`24`	`QUECTEL_BG96_CellularPower::QUECTEL_BG96_CellularPower(ATHandler &atHandler) : AT_CellularPower(atHandler)`
`25`	`25`	`{`
`26`	`26`	`}`
`27`		`-`
`28`		`-nsapi_error_t QUECTEL_BG96_CellularPower::set_device_ready_urc_cb(mbed::Callback<void()> callback)`
`29`		`-{`
`30`		`- return _at.set_urc_handler(DEVICE_READY_URC, callback);`
`31`		`-}`
`32`		`-`
`33`		`-void QUECTEL_BG96_CellularPower::remove_device_ready_urc_cb(mbed::Callback<void()> callback)`
`34`		`-{`
`35`		`- _at.set_urc_handler(DEVICE_READY_URC, 0);`
`36`		`-}`