Handle undefined message when sending AT command

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>1.8K</center></td>
-        <td><center>1.6K</center></td>
+        <td><center>2.0K</center></td>
+        <td><center>1.9K</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.5K</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

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;

source/cellular_pkthandler.c

@@ -81,6 +81,8 @@ static void _Cellular_ProcessGenericUrc( const CellularContext_t * pContext,
 static CellularPktStatus_t _atParseGetHandler( CellularContext_t * pContext,
                                                const char * pTokenPtr,
                                                char * pSavePtr );
+static CellularPktStatus_t _handleUndefinedMessage( CellularContext_t * pContext,
+                                                    const char * pLine );
 
 /*-----------------------------------------------------------*/
 
@@ -93,7 +95,6 @@ static CellularPktStatus_t _convertAndQueueRespPacket( CellularContext_t * pCont
     if( ( pBuf != NULL ) )
     {
         pAtResp = ( const CellularATCommandResponse_t * ) pBuf;
-        PlatformMutex_Lock( &pContext->PktRespMutex );
 
         if( pAtResp->status == false )
         {
@@ -115,8 +116,6 @@ static CellularPktStatus_t _convertAndQueueRespPacket( CellularContext_t * pCont
             pktStatus = CELLULAR_PKT_STATUS_FAILURE;
             LogError( ( "_convertAndQueueRespPacket: Got a response when the Resp Q is full!!" ) );
         }
-
-        PlatformMutex_Unlock( &pContext->PktRespMutex );
     }
     else
     {
@@ -217,12 +216,16 @@ static CellularPktStatus_t _Cellular_AtcmdRequestTimeoutWithCallbackRaw( Cellula
     }
     else
     {
+        LogDebug( ( ">>>>>Start sending [%s]<<<<<", atReq.pAtCmd ) );
+
         /* Fill in request info structure. */
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->pktRespCB = atReq.respCallback;
-        LogDebug( ( ">>>>>Start sending [%s]<<<<<", atReq.pAtCmd ) );
         pContext->pPktUsrData = atReq.pData;
         pContext->PktUsrDataLen = ( uint16_t ) atReq.dataLen;
         pContext->pCurrentCmd = atReq.pAtCmd;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
+
         pktStatus = _Cellular_PktioSendAtCmd( pContext, atReq.pAtCmd, atReq.atCmdType, atReq.pAtRspPrefix );
 
         if( pktStatus != CELLULAR_PKT_STATUS_OK )
@@ -252,9 +255,11 @@ static CellularPktStatus_t _Cellular_AtcmdRequestTimeoutWithCallbackRaw( Cellula
         }
 
         /* No command is waiting response. */
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->PktioAtCmdType = CELLULAR_AT_NO_COMMAND;
         pContext->pktRespCB = NULL;
         pContext->pCurrentCmd = NULL;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
         LogDebug( ( "<<<<<Exit sending [%s] status[%d]<<<<<", atReq.pAtCmd, pktStatus ) );
     }
 
@@ -281,8 +286,13 @@ static CellularPktStatus_t _Cellular_DataSendWithTimeoutDelayRaw( CellularContex
     else
     {
         LogDebug( ( ">>>>>Start sending Data <<<<<" ) );
+
+        /* Send the packet. Data send is regarded as CELLULAR_AT_NO_RESULT. Only
+         * success or error token is expected in the result. */
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->PktioAtCmdType = CELLULAR_AT_NO_RESULT;
-        /* Send the packet. */
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
+
         *dataReq.pSentDataLength = _Cellular_PktioSendData( pContext, dataReq.pData, dataReq.dataLen );
 
         if( *dataReq.pSentDataLength != dataReq.dataLen )
@@ -331,7 +341,11 @@ static CellularPktStatus_t _Cellular_DataSendWithTimeoutDelayRaw( CellularContex
             LogError( ( "pkt_recv status=%d, data sending timed out", pktStatus ) );
         }
 
+        /* Set AT command type to CELLULAR_AT_NO_COMMAND for timeout case here. */
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->PktioAtCmdType = CELLULAR_AT_NO_COMMAND;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
+
         LogDebug( ( "<<<<<Exit sending data ret[%d]>>>>>", pktStatus ) );
     }
 
@@ -479,6 +493,41 @@ static CellularPktStatus_t _atParseGetHandler( CellularContext_t * pContext,
 
 /*-----------------------------------------------------------*/
 
+/*
+ * @brief Handle AT_UNDEFINED message type.
+ */
+static CellularPktStatus_t _handleUndefinedMessage( CellularContext_t * pContext,
+                                                    const char * pLine )
+{
+    CellularPktStatus_t pktStatus = CELLULAR_PKT_STATUS_OK;
+
+    LogInfo( ( "AT_UNDEFINED message received %s\r\n", pLine ) );
+
+    /* undefined message received. Try to handle it with cellular module
+     * specific handler. */
+    if( pContext->undefinedRespCallback == NULL )
+    {
+        LogError( ( "No undefined callback for AT_UNDEFINED type message %s received.",
+                    pLine ) );
+        pktStatus = CELLULAR_PKT_STATUS_INVALID_DATA;
+    }
+    else
+    {
+        pktStatus = pContext->undefinedRespCallback( pContext->pUndefinedRespCBContext, pLine );
+
+        if( pktStatus != CELLULAR_PKT_STATUS_OK )
+        {
+            LogError( ( "undefinedRespCallback returns error %d for AT_UNDEFINED type message %s received.",
+                        pktStatus, pLine ) );
+            pktStatus = CELLULAR_PKT_STATUS_INVALID_DATA;
+        }
+    }
+
+    return pktStatus;
+}
+
+/*-----------------------------------------------------------*/
+
 void _Cellular_PktHandlerCleanup( CellularContext_t * pContext )
 {
     if( ( pContext != NULL ) && ( pContext->pktRespQueue != NULL ) )
@@ -513,6 +562,11 @@ CellularPktStatus_t _Cellular_HandlePacket( CellularContext_t * pContext,
                 pktStatus = _processUrcPacket( pContext, pBuf );
                 break;
 
+            case AT_UNDEFINED:
+                pktStatus = _handleUndefinedMessage( pContext, pBuf );
+
+                break;
+
             default:
                 pktStatus = CELLULAR_PKT_STATUS_BAD_PARAM;
                 LogError( ( "_Cellular_HandlePacket Callback type (%d) error", atRespType ) );
@@ -573,11 +627,21 @@ CellularPktStatus_t _Cellular_AtcmdRequestSuccessToken( CellularContext_t * pCon
     else
     {
         _Cellular_PktHandlerAcquirePktRequestMutex( pContext );
+
+        /* Set the extra Token table for this AT command. */
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->tokenTable.pCellularSrcExtraTokenSuccessTable = pCellularSrcTokenSuccessTable;
         pContext->tokenTable.cellularSrcExtraTokenSuccessTableSize = cellularSrcTokenSuccessTableSize;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
+
         pktStatus = _Cellular_AtcmdRequestTimeoutWithCallbackRaw( pContext, atReq, atTimeoutMS );
+
+        /* Clear the extra Token table for this AT command. */
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->tokenTable.cellularSrcExtraTokenSuccessTableSize = 0;
         pContext->tokenTable.pCellularSrcExtraTokenSuccessTable = NULL;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
+
         _Cellular_PktHandlerReleasePktRequestMutex( pContext );
     }
 
@@ -602,11 +666,21 @@ CellularPktStatus_t _Cellular_TimeoutAtcmdDataRecvRequestWithCallback( CellularC
     else
     {
         _Cellular_PktHandlerAcquirePktRequestMutex( pContext );
+
+        /* Set the data receive prefix. */
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->pktDataPrefixCB = pktDataPrefixCallback;
         pContext->pDataPrefixCBContext = pCallbackContext;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
+
         pktStatus = _Cellular_AtcmdRequestTimeoutWithCallbackRaw( pContext, atReq, timeoutMS );
+
+        /* Clear the data receive prefix. */
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->pktDataPrefixCB = NULL;
         pContext->pDataPrefixCBContext = NULL;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
+
         _Cellular_PktHandlerReleasePktRequestMutex( pContext );
     }
 
@@ -634,11 +708,20 @@ CellularPktStatus_t _Cellular_AtcmdDataSend( CellularContext_t * pContext,
     else
     {
         _Cellular_PktHandlerAcquirePktRequestMutex( pContext );
+
+        /* Set the data send prefix callback. */
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->pktDataSendPrefixCB = pktDataSendPrefixCallback;
         pContext->pDataSendPrefixCBContext = pCallbackContext;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
+
         pktStatus = _Cellular_AtcmdRequestTimeoutWithCallbackRaw( pContext, atReq, atTimeoutMS );
+
+        /* Clear the data send prefix callback. */
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->pDataSendPrefixCBContext = NULL;
         pContext->pktDataSendPrefixCB = NULL;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
 
         if( pktStatus == CELLULAR_PKT_STATUS_OK )
         {
@@ -682,11 +765,20 @@ CellularPktStatus_t _Cellular_TimeoutAtcmdDataSendSuccessToken( CellularContext_
     else
     {
         _Cellular_PktHandlerAcquirePktRequestMutex( pContext );
+
+        /* Set the extra token table. */
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->tokenTable.pCellularSrcExtraTokenSuccessTable = pCellularSrcTokenSuccessTable;
         pContext->tokenTable.cellularSrcExtraTokenSuccessTableSize = cellularSrcTokenSuccessTableSize;
+        PlatformMutex_Lock( &pContext->PktRespMutex );
+
         pktStatus = _Cellular_AtcmdRequestTimeoutWithCallbackRaw( pContext, atReq, atTimeoutMS );
+
+        /* Clear the extra token table. */
+        PlatformMutex_Lock( &pContext->PktRespMutex );
         pContext->tokenTable.cellularSrcExtraTokenSuccessTableSize = 0;
         pContext->tokenTable.pCellularSrcExtraTokenSuccessTable = NULL;
+        PlatformMutex_Unlock( &pContext->PktRespMutex );
 
         if( pktStatus == CELLULAR_PKT_STATUS_OK )
         {