Handle network registration URC in AT command response callback

docs/doxygen/include/size_table.md

@@ -9,8 +9,8 @@
     </tr>
     <tr>
         <td>cellular_3gpp_api.c</td>
-        <td><center>6.3K</center></td>
-        <td><center>5.8K</center></td>
+        <td><center>6.4K</center></td>
+        <td><center>5.9K</center></td>
     </tr>
     <tr>
         <td>cellular_3gpp_urc_handler.c</td>
@@ -44,7 +44,7 @@
     </tr>
     <tr>
         <td><b>Total estimates</b></td>
-        <td><b><center>14.1K</center></b></td>
-        <td><b><center>12.8K</center></b></td>
+        <td><b><center>14.2K</center></b></td>
+        <td><b><center>12.9K</center></b></td>
     </tr>
 </table>

lexicon.txt

@@ -1,6 +1,7 @@
 accessmode
 activatepdn
 activetimevalue
+actstatus
 af
 aka
 api
@@ -142,6 +143,7 @@ checkcrsmmemorystatus
 checkcrsmreadstatus
 checklibrarystatus
 chk
+ci
 ciev
 clearbits
 closedcallback
@@ -283,6 +285,7 @@ eventgrouphandle
 evt
 fasle
 ff
+fffe
 ffffff
 findlineinstream
 firmwareversion
@@ -726,6 +729,7 @@ sendtimeoutms
 sensorhub
 seperator
 serialnumber
+servicestatus
 sessionid
 setbits
 setbitsfromisr
@@ -768,6 +772,7 @@ src
 stacksize
 stanard
 standalone
+stat
 staticqueue
 staticsemaphore
 stm

source/cellular_3gpp_api.c

@@ -150,6 +150,7 @@ static CellularPktStatus_t _Cellular_RecvFuncGetManufactureId( CellularContext_t
                                                                const CellularATCommandResponse_t * pAtResp,
                                                                void * pData,
                                                                uint16_t dataLen );
+static bool regResponseIsUrc( char * pRegLine );
 static CellularPktStatus_t _Cellular_RecvFuncGetNetworkReg( CellularContext_t * pContext,
                                                             const CellularATCommandResponse_t * pAtResp,
                                                             void * pData,
@@ -738,6 +739,50 @@ static CellularPktStatus_t _Cellular_RecvFuncGetManufactureId( CellularContext_t
 
 /*-----------------------------------------------------------*/
 
+
+static bool regResponseIsUrc( char * pRegLine )
+{
+    bool isUrcResponse = false;
+    char * pSeparator = NULL;
+
+    /* CREG, CEREG, CGREG has the same prefix for AT command response and URC.
+     * There will be cases that the URC code is regarded as AT command response.
+     * The response content can be used to distinguish them.
+     *
+     * Take AT+CREG for example, CREG has the following response format.
+     * Read response : +CREG: <n>,<stat>[,<lac>,<ci>[,<AcTStatus>]]
+     * URC : +CREG: <stat>[,[<lac>],[<ci>][,[<AcTStatus>][,<cause_type>, <reject_cause>]]]
+     *
+     * Not registered searching response:
+     * Read response : +CREG: 2,2
+     * URC : +CREG: 2
+     *
+     * Registered, home network response
+     * Read response : +CREG: 2,1,"FFFE","341B50D",8
+     * URC : +CREG: 1,"FFFE","341B50D", 8
+     */
+    pSeparator = strstr( pRegLine, "," );
+
+    if( pSeparator == NULL )
+    {
+        /* Not registered searching response case. */
+        isUrcResponse = true;
+    }
+    else if( pSeparator[ 1 ] == '"' )
+    {
+        /* Registered case, the second token start with '"' */
+        isUrcResponse = true;
+    }
+    else
+    {
+        isUrcResponse = false;
+    }
+
+    return isUrcResponse;
+}
+
+/*-----------------------------------------------------------*/
+
 static CellularPktStatus_t _Cellular_RecvFuncGetNetworkReg( CellularContext_t * pContext,
                                                             const CellularATCommandResponse_t * pAtResp,
                                                             void * pData,
@@ -747,6 +792,7 @@ static CellularPktStatus_t _Cellular_RecvFuncGetNetworkReg( CellularContext_t *
     CellularPktStatus_t pktStatus = CELLULAR_PKT_STATUS_OK;
     CellularATError_t atCoreStatus = CELLULAR_AT_SUCCESS;
     CellularNetworkRegType_t regType = CELLULAR_REG_TYPE_UNKNOWN;
+    CellularATCommandLine_t * pCommandLine = NULL;
 
     if( pContext == NULL )
     {
@@ -764,17 +810,34 @@ static CellularPktStatus_t _Cellular_RecvFuncGetNetworkReg( CellularContext_t *
     }
     else
     {
+        pCommandLine = pAtResp->pItm;
         regType = *( ( CellularNetworkRegType_t * ) pData );
-        pPregLine = pAtResp->pItm->pLine;
-        atCoreStatus = Cellular_ATRemoveLeadingWhiteSpaces( &pPregLine );
-        pktStatus = _Cellular_TranslateAtCoreStatus( atCoreStatus );
 
-        if( pktStatus == CELLULAR_PKT_STATUS_OK )
+        while( ( pCommandLine != NULL ) && ( pktStatus == CELLULAR_PKT_STATUS_OK ) )
         {
+            pPregLine = pCommandLine->pLine;
+
             /* Assumption is that the data is null terminated so we don't need the dataLen. */
             _Cellular_LockAtDataMutex( pContext );
-            pktStatus = _Cellular_ParseRegStatus( pContext, pPregLine, false, regType );
+
+            if( regResponseIsUrc( pPregLine ) == true )
+            {
+                /* Remove the prefix for URC handler. */
+                atCoreStatus = Cellular_ATRemovePrefix( &pPregLine );
+                pktStatus = _Cellular_TranslateAtCoreStatus( atCoreStatus );
+
+                if( pktStatus == CELLULAR_PKT_STATUS_OK )
+                {
+                    pktStatus = _Cellular_ParseRegStatus( pContext, pPregLine, true, regType );
+                }
+            }
+            else
+            {
+                pktStatus = _Cellular_ParseRegStatus( pContext, pPregLine, false, regType );
+            }
+
             _Cellular_UnlockAtDataMutex( pContext );
+            pCommandLine = pCommandLine->pNext;
         }
 
         LogDebug( ( "atcmd network register status %d pktStatus:%d", regType, pktStatus ) );

test/unit-test/cellular_3gpp_api_utest.c

@@ -49,12 +49,27 @@
 /**
  * @brief Cellular sample prefix string input.
  */
-#define CELLULAR_SAMPLE_PREFIX_STRING_INPUT     "+CPIN:READY"
+#define CELLULAR_SAMPLE_PREFIX_STRING_INPUT                        "+CPIN:READY"
+
+/**
+ * @brief Cellular sample network registration URC not registered.
+ */
+#define CELLULAR_SAMPLE_NETWORK_REGISTRATION_RESPONSE              "+CREG: 2,2"
+
+/**
+ * @brief Cellular sample network registration URC not registered.
+ */
+#define CELLULAR_SAMPLE_NETWORK_REGISTRATION_URC_NOT_REGISTERED    "+CREG: 2"
+
+/**
+ * @brief Cellular sample network registration URC registered.
+ */
+#define CELLULAR_SAMPLE_NETWORK_REGISTRATION_URC_REGISTERED        "+CREG: 1,\"FFFE\",\"341B50D\", 8"
 
 /**
  * @brief Cellular sample prefix string output.
  */
-#define CELLULAR_SAMPLE_PREFIX_STRING_OUTPUT    "READY"
+#define CELLULAR_SAMPLE_PREFIX_STRING_OUTPUT                       "READY"
 
 /**
  * @brief operator information.
@@ -586,6 +601,29 @@ CellularPktStatus_t Mock_AtcmdRequestWithCallback__Cellular_RecvFuncGetNetworkRe
             _saveData( pLine, &atResp, strlen( pLine ) + 1 );
             pktStatus = atReq.respCallback( pContext, &atResp, pData, sizeof( pData ) );
         }
+        else if( cbCondition == 4 )
+        {
+            char pLine[] = CELLULAR_SAMPLE_NETWORK_REGISTRATION_URC_NOT_REGISTERED;
+
+            _saveData( pLine, &atResp, strlen( pLine ) + 1 );
+            pktStatus = atReq.respCallback( pContext, &atResp, pData, sizeof( pData ) );
+        }
+        else if( cbCondition == 5 )
+        {
+            char pLine[] = CELLULAR_SAMPLE_NETWORK_REGISTRATION_URC_REGISTERED;
+
+            _saveData( pLine, &atResp, strlen( pLine ) + 1 );
+            pktStatus = atReq.respCallback( pContext, &atResp, pData, sizeof( pData ) );
+        }
+        else if( cbCondition == 6 )
+        {
+            char pLine[] = CELLULAR_SAMPLE_NETWORK_REGISTRATION_RESPONSE;
+            char pLine2[] = CELLULAR_SAMPLE_NETWORK_REGISTRATION_URC_REGISTERED;
+
+            _saveData( pLine, &atResp, strlen( pLine ) + 1 );
+            _saveData( pLine2, &atResp, strlen( pLine2 ) + 1 );
+            pktStatus = atReq.respCallback( pContext, &atResp, pData, sizeof( pData ) );
+        }
     }
 
     return pktStatus;
@@ -3030,7 +3068,7 @@ void test_Cellular_CommonGetServiceStatus_Cb__Cellular_RecvFuncGetNetworkReg_AtC
     _Cellular_AtcmdRequestWithCallback_StubWithCallback( Mock_AtcmdRequestWithCallback__Cellular_RecvFuncGetNetworkReg );
     _Cellular_TranslatePktStatus_ExpectAndReturn( CELLULAR_PKT_STATUS_INVALID_HANDLE, CELLULAR_INTERNAL_FAILURE );
 
-    Cellular_ATRemoveLeadingWhiteSpaces_IgnoreAndReturn( CELLULAR_AT_ERROR );
+    Cellular_ATRemovePrefix_IgnoreAndReturn( CELLULAR_AT_ERROR );
     _Cellular_TranslateAtCoreStatus_IgnoreAndReturn( CELLULAR_PKT_STATUS_FAILURE );
 
     /* called by atcmdUpdateMccMnc. */
@@ -3060,7 +3098,7 @@ void test_Cellular_CommonGetServiceStatus_Cb__Cellular_RecvFuncGetNetworkReg_Hap
     _Cellular_AtcmdRequestWithCallback_StubWithCallback( Mock_AtcmdRequestWithCallback__Cellular_RecvFuncGetNetworkReg );
     _Cellular_TranslatePktStatus_ExpectAndReturn( CELLULAR_PKT_STATUS_INVALID_HANDLE, CELLULAR_INTERNAL_FAILURE );
 
-    Cellular_ATRemoveLeadingWhiteSpaces_IgnoreAndReturn( CELLULAR_AT_SUCCESS );
+    Cellular_ATRemovePrefix_IgnoreAndReturn( CELLULAR_AT_SUCCESS );
     _Cellular_TranslateAtCoreStatus_IgnoreAndReturn( CELLULAR_PKT_STATUS_OK );
     /* _Cellular_ParseRegStatus */
     Cellular_ATRemoveAllDoubleQuote_IgnoreAndReturn( CELLULAR_AT_BAD_PARAMETER );
@@ -3074,6 +3112,111 @@ void test_Cellular_CommonGetServiceStatus_Cb__Cellular_RecvFuncGetNetworkReg_Hap
     TEST_ASSERT_EQUAL( CELLULAR_SUCCESS, cellularStatus );
 }
 
+/**
+ * @brief Test that_Cellular_ParseRegStatus return error in callback function _Cellular_RecvFuncGetNetworkReg
+ * for Cellular_CommonGetServiceStatus to return CELLULAR_SUCCESS.
+ */
+void test_Cellular_CommonGetServiceStatus_Cb__Cellular_RecvFuncGetNetworkReg_Parse_Error( void )
+{
+    CellularError_t cellularStatus = CELLULAR_SUCCESS;
+    CellularContext_t context;
+
+    memset( &context, 0, sizeof( CellularContext_t ) );
+    CellularHandle_t cellularHandle = &context;
+    CellularServiceStatus_t serviceStatus;
+
+    _Cellular_CheckLibraryStatus_IgnoreAndReturn( CELLULAR_SUCCESS );
+
+    /* called by atcmdQueryRegStatus -> queryNetworkStatus for CREG. */
+    cbCondition = 6;
+    _Cellular_AtcmdRequestWithCallback_StubWithCallback( Mock_AtcmdRequestWithCallback__Cellular_RecvFuncGetNetworkReg );
+    _Cellular_TranslatePktStatus_ExpectAndReturn( CELLULAR_PKT_STATUS_INVALID_HANDLE, CELLULAR_INTERNAL_FAILURE );
+
+    /* Return error in _Cellular_ParseRegStatus. */
+    Cellular_ATRemoveAllDoubleQuote_IgnoreAndReturn( CELLULAR_AT_BAD_PARAMETER );
+    _Cellular_TranslateAtCoreStatus_IgnoreAndReturn( CELLULAR_PKT_STATUS_INVALID_HANDLE );
+    _Cellular_NetworkRegistrationCallback_Ignore();
+
+    /* called by atcmdUpdateMccMnc. */
+    _Cellular_TranslatePktStatus_IgnoreAndReturn( CELLULAR_SUCCESS );
+
+    /* The serviceStatus is updated and verified in cellular_3gpp_urc_handler.c test cases. */
+    cellularStatus = Cellular_CommonGetServiceStatus( cellularHandle, &serviceStatus );
+    TEST_ASSERT_EQUAL( CELLULAR_SUCCESS, cellularStatus );
+}
+
+/**
+ * @brief Test that network not registered URC is received in callback function
+ * _Cellular_RecvFuncGetNetworkReg for Cellular_CommonGetServiceStatus to return CELLULAR_SUCCESS.
+ */
+void test_Cellular_CommonGetServiceStatus_Cb__Cellular_RecvFuncGetNetworkReg_URC_not_registered( void )
+{
+    CellularError_t cellularStatus = CELLULAR_SUCCESS;
+    CellularContext_t context;
+
+    memset( &context, 0, sizeof( CellularContext_t ) );
+    CellularHandle_t cellularHandle = &context;
+    CellularServiceStatus_t serviceStatus;
+
+    _Cellular_CheckLibraryStatus_IgnoreAndReturn( CELLULAR_SUCCESS );
+
+    /* called by atcmdQueryRegStatus -> queryNetworkStatus for +CREG:2. */
+    cbCondition = 4;
+    _Cellular_AtcmdRequestWithCallback_StubWithCallback( Mock_AtcmdRequestWithCallback__Cellular_RecvFuncGetNetworkReg );
+    _Cellular_TranslatePktStatus_ExpectAndReturn( CELLULAR_PKT_STATUS_INVALID_HANDLE, CELLULAR_INTERNAL_FAILURE );
+
+    Cellular_ATRemovePrefix_IgnoreAndReturn( CELLULAR_AT_SUCCESS );
+    _Cellular_TranslateAtCoreStatus_IgnoreAndReturn( CELLULAR_PKT_STATUS_INVALID_HANDLE );
+
+    /* _Cellular_ParseRegStatus */
+    Cellular_ATRemoveAllDoubleQuote_IgnoreAndReturn( CELLULAR_AT_BAD_PARAMETER );
+    _Cellular_TranslateAtCoreStatus_IgnoreAndReturn( CELLULAR_PKT_STATUS_INVALID_HANDLE );
+    _Cellular_NetworkRegistrationCallback_Ignore();
+
+    /* called by atcmdUpdateMccMnc. */
+    _Cellular_TranslatePktStatus_IgnoreAndReturn( CELLULAR_SUCCESS );
+
+    /* The serviceStatus is updated and verified in cellular_3gpp_urc_handler.c test cases. */
+    cellularStatus = Cellular_CommonGetServiceStatus( cellularHandle, &serviceStatus );
+    TEST_ASSERT_EQUAL( CELLULAR_SUCCESS, cellularStatus );
+}
+
+/**
+ * @brief Test that network registered URC is received in callback function
+ * _Cellular_RecvFuncGetNetworkReg for Cellular_CommonGetServiceStatus to return CELLULAR_SUCCESS.
+ */
+void test_Cellular_CommonGetServiceStatus_Cb__Cellular_RecvFuncGetNetworkReg_URC_registered( void )
+{
+    CellularError_t cellularStatus = CELLULAR_SUCCESS;
+    CellularContext_t context;
+
+    memset( &context, 0, sizeof( CellularContext_t ) );
+    CellularHandle_t cellularHandle = &context;
+    CellularServiceStatus_t serviceStatus;
+
+    _Cellular_CheckLibraryStatus_IgnoreAndReturn( CELLULAR_SUCCESS );
+
+    /* called by atcmdQueryRegStatus -> queryNetworkStatus for +CREG:2. */
+    cbCondition = 5;
+    _Cellular_AtcmdRequestWithCallback_StubWithCallback( Mock_AtcmdRequestWithCallback__Cellular_RecvFuncGetNetworkReg );
+    _Cellular_TranslatePktStatus_ExpectAndReturn( CELLULAR_PKT_STATUS_INVALID_HANDLE, CELLULAR_INTERNAL_FAILURE );
+
+    Cellular_ATRemovePrefix_IgnoreAndReturn( CELLULAR_AT_SUCCESS );
+    _Cellular_TranslateAtCoreStatus_IgnoreAndReturn( CELLULAR_PKT_STATUS_OK );
+
+    /* _Cellular_ParseRegStatus */
+    Cellular_ATRemoveAllDoubleQuote_IgnoreAndReturn( CELLULAR_AT_BAD_PARAMETER );
+    _Cellular_TranslateAtCoreStatus_IgnoreAndReturn( CELLULAR_PKT_STATUS_OK );
+    _Cellular_NetworkRegistrationCallback_Ignore();
+
+    /* called by atcmdUpdateMccMnc. */
+    _Cellular_TranslatePktStatus_IgnoreAndReturn( CELLULAR_SUCCESS );
+
+    /* The serviceStatus is updated and verified in cellular_3gpp_urc_handler.c test cases. */
+    cellularStatus = Cellular_CommonGetServiceStatus( cellularHandle, &serviceStatus );
+    TEST_ASSERT_EQUAL( CELLULAR_SUCCESS, cellularStatus );
+}
+
 /**
  * @brief Test that wrong psRegStatus case Cellular_CommonGetServiceStatus to return CELLULAR_SUCCESS.
  */