Handle undefined message when sending AT command (#110)

* Update pktio to handle undefined message when sending AT command
* Undefined message handler is moved to pkthandler
* Use PktRespMutex in pktio thread to keep data consistency
* Add test cases to cover the undefined message handle flow
* Update ATE0 handling in SARA R4 and HL7802. ATE0 may still echo back ATE0. Change the AT command type to CELLULAR_AT_WO_PREFIX

Author: chinglee-iot

docs/doxygen/include/size_table.md

@@ -24,27 +24,27 @@
     </tr>
     <tr>
         <td>cellular_common_api.c</td>
+        <td><center>0.7K</center></td>
         <td><center>0.6K</center></td>
-        <td><center>0.5K</center></td>
     </tr>
     <tr>
         <td>cellular_common.c</td>
-        <td><center>1.6K</center></td>
+        <td><center>1.7K</center></td>
         <td><center>1.5K</center></td>
     </tr>
     <tr>
         <td>cellular_pkthandler.c</td>
-        <td><center>1.5K</center></td>
-        <td><center>1.4K</center></td>
+        <td><center>1.7K</center></td>
+        <td><center>1.6K</center></td>
     </tr>
     <tr>
         <td>cellular_pktio.c</td>
+        <td><center>2.0K</center></td>
         <td><center>1.8K</center></td>
-        <td><center>1.6K</center></td>
     </tr>
     <tr>
         <td><b>Total estimates</b></td>
-        <td><b><center>14.2K</center></b></td>
-        <td><b><center>12.9K</center></b></td>
+        <td><b><center>14.8K</center></b></td>
+        <td><b><center>13.4K</center></b></td>
     </tr>
 </table>

lexicon.txt

@@ -547,6 +547,8 @@ pktioreadthread
 pktiosendatcmd
 pktiosenddata
 pktioshutdown
+pktrequestmutex
+pktrespmutex
 pktrespqueue
 pktrxcallback
 pktstatus
@@ -799,6 +801,7 @@ technoloyg
 tempvalue
 testindex
 testresultnumber
+threadreturn
 threadroutine
 ticktype
 timeoutatcmddatarecvrequestwithcallback

modules/hl7802/cellular_hl7802.c

@@ -335,6 +335,15 @@ CellularError_t Cellular_ModuleEnableUE( CellularContext_t * pContext )
 {
     CellularError_t cellularStatus = CELLULAR_SUCCESS;
     CellularPktStatus_t pktStatus = CELLULAR_PKT_STATUS_OK;
+    CellularAtReq_t atReqGetWoPrefix =
+    {
+        NULL,
+        CELLULAR_AT_WO_PREFIX,
+        NULL,
+        NULL,
+        NULL,
+        0
+    };
     CellularAtReq_t atReqGetNoResult =
     {
         NULL,
@@ -351,8 +360,8 @@ CellularError_t Cellular_ModuleEnableUE( CellularContext_t * pContext )
     if( pContext != NULL )
     {
         /* Disable echo. */
-        atReqGetNoResult.pAtCmd = "ATE0";
-        cellularStatus = sendAtCommandWithRetryTimeout( pContext, &atReqGetNoResult,
+        atReqGetWoPrefix.pAtCmd = "ATE0";
+        cellularStatus = sendAtCommandWithRetryTimeout( pContext, &atReqGetWoPrefix,
                                                         CELLULAR_HL7802_AT_TIMEOUT_2_SECONDS_MS );
 
         if( cellularStatus == CELLULAR_SUCCESS )
@@ -464,8 +473,8 @@ CellularError_t Cellular_ModuleEnableUE( CellularContext_t * pContext )
         if( cellularStatus == CELLULAR_SUCCESS )
         {
             Platform_Delay( CELLULAR_HL7802_RESET_DELAY_MS );
-            atReqGetNoResult.pAtCmd = "ATE0";
-            cellularStatus = sendAtCommandWithRetryTimeout( pContext, &atReqGetNoResult,
+            atReqGetWoPrefix.pAtCmd = "ATE0";
+            cellularStatus = sendAtCommandWithRetryTimeout( pContext, &atReqGetWoPrefix,
                                                             CELLULAR_HL7802_AT_TIMEOUT_2_SECONDS_MS );
         }
     }

modules/sara_r4/cellular_r4.c

@@ -262,7 +262,15 @@ CellularError_t rebootCellularModem( CellularContext_t * pContext,
     CellularError_t cellularStatus = CELLULAR_SUCCESS;
     CellularPktStatus_t pktStatus = CELLULAR_PKT_STATUS_OK;
     uint32_t count = 0;
-
+    CellularAtReq_t atReqGetWoPrefix =
+    {
+        NULL,
+        CELLULAR_AT_WO_PREFIX,
+        NULL,
+        NULL,
+        NULL,
+        0
+    };
     CellularAtReq_t atReqGetNoResult =
     {
         "AT+CFUN=15",
@@ -283,9 +291,9 @@ CellularError_t rebootCellularModem( CellularContext_t * pContext,
     {
         LogInfo( ( "rebootCellularModem: Use ATE0 command to test modem status." ) );
 
-        atReqGetNoResult.pAtCmd = "ATE0";
+        atReqGetWoPrefix.pAtCmd = "ATE0";
 
-        pktStatus = _Cellular_TimeoutAtcmdRequestWithCallback( pContext, atReqGetNoResult, ENBABLE_MODULE_UE_REBOOT_POLL_TIME );
+        pktStatus = _Cellular_TimeoutAtcmdRequestWithCallback( pContext, atReqGetWoPrefix, ENBABLE_MODULE_UE_REBOOT_POLL_TIME );
         cellularStatus = _Cellular_TranslatePktStatus( pktStatus );
 
         if( cellularStatus == CELLULAR_SUCCESS )

source/cellular_common.c

@@ -1115,6 +1115,7 @@ CellularError_t _Cellular_RegisterUndefinedRespCallback( CellularContext_t * pCo
     else
     {
         /* undefinedRespCallback can be set to NULL to unregister the callback. */
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->undefinedRespCallback = undefinedRespCallback;
 
         if( pContext->undefinedRespCallback != NULL )
@@ -1125,6 +1126,8 @@ CellularError_t _Cellular_RegisterUndefinedRespCallback( CellularContext_t * pCo
         {
             pContext->pUndefinedRespCBContext = NULL;
         }
+
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
     }
 
     return cellularStatus;

source/cellular_common_api.c

@@ -206,8 +206,10 @@ CellularError_t Cellular_CommonRegisterUrcNetworkRegistrationEventCallback( Cell
     }
     else
     {
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->cbEvents.networkRegistrationCallback = networkRegistrationCallback;
         pContext->cbEvents.pNetworkRegistrationCallbackContext = pCallbackContext;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
     }
 
     return cellularStatus;
@@ -231,8 +233,10 @@ CellularError_t Cellular_CommonRegisterUrcPdnEventCallback( CellularHandle_t cel
     }
     else
     {
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->cbEvents.pdnEventCallback = pdnEventCallback;
         pContext->cbEvents.pPdnEventCallbackContext = pCallbackContext;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
     }
 
     return cellularStatus;
@@ -256,8 +260,10 @@ CellularError_t Cellular_CommonRegisterUrcSignalStrengthChangedCallback( Cellula
     }
     else
     {
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->cbEvents.signalStrengthChangedCallback = signalStrengthChangedCallback;
         pContext->cbEvents.pSignalStrengthChangedCallbackContext = pCallbackContext;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
     }
 
     return cellularStatus;
@@ -281,8 +287,10 @@ CellularError_t Cellular_CommonRegisterUrcGenericCallback( CellularHandle_t cell
     }
     else
     {
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->cbEvents.genericCallback = genericCallback;
         pContext->cbEvents.pGenericCallbackContext = pCallbackContext;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
     }
 
     return cellularStatus;
@@ -306,8 +314,10 @@ CellularError_t Cellular_CommonRegisterModemEventCallback( CellularHandle_t cell
     }
     else
     {
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->cbEvents.modemEventCallback = modemEventCallback;
         pContext->cbEvents.pModemEventCallbackContext = pCallbackContext;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
     }
 
     return cellularStatus;