Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parsing CREG/CGREG/CEREG separately. #182

Merged
merged 7 commits into from
Nov 20, 2024
Merged

Parsing CREG/CGREG/CEREG separately. #182

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0c8aa38
Parsing CREG/CGREG/CEREG separately.
ActoryOu Nov 19, 2024
109aa39
Fix complexity
ActoryOu Nov 19, 2024
5516349
Add UT test cases for CREG/CGREG/CEREG
ActoryOu Nov 19, 2024
693b195
Fix comments
ActoryOu Nov 19, 2024
613ce99
Fix Spelling and Complexity.
ActoryOu Nov 19, 2024
70f1d11
Update size_table
ActoryOu Nov 19, 2024
3297062
Add const to patsing table.
ActoryOu Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
output
output
build
236 changes: 212 additions & 24 deletions source/cellular_3gpp_urc_handler.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,23 @@

/*-----------------------------------------------------------*/

#define CELLULAR_REG_POS_NONE ( 0U )
#define CELLULAR_REG_POS_NET_REG ( 1U )
#define CELLULAR_REG_POS_STAT ( 2U )
#define CELLULAR_REG_POS_LAC_TAC ( 3U )
#define CELLULAR_REG_POS_CELL_ID ( 4U )
#define CELLULAR_REG_POS_RAT ( 5U )
#define CELLULAR_REG_POS_REJ_TYPE ( 6U )
#define CELLULAR_REG_POS_REJ_CAUSE ( 7U )
#define CELLULAR_REG_POS_RAC ( 8U )

/*-----------------------------------------------------------*/

/* Function pointer prototype to point to corresponding function for CREG/CEREG/CGREG. */
typedef CellularPktStatus_t ( * RegStatusSwitchParsingFunc_t )( CellularContext_t * pContext,
uint8_t i,
const char * pToken,
cellularAtData_t * pLibAtData );

/*-----------------------------------------------------------*/
static CellularPktStatus_t _parseRegStatusInRegStatusParsing( CellularContext_t * pContext,
Expand All @@ -74,11 +85,25 @@ static CellularPktStatus_t _parseRejectTypeInRegStatus( CellularNetworkRegType_t
static CellularPktStatus_t _parseRejectCauseInRegStatus( CellularNetworkRegType_t regType,
const char * pToken,
cellularAtData_t * pLibAtData );
static CellularPktStatus_t _parseRoutingAreaCodeInRegStatus( const char * pToken,
cellularAtData_t * pLibAtData );
static CellularPktStatus_t _regStatusSwitchParsingFunc( CellularContext_t * pContext,
uint8_t i,
CellularNetworkRegType_t regType,
const char * pToken,
cellularAtData_t * pLibAtData );
static CellularPktStatus_t _regStatusSwitchParsingFuncCreg( CellularContext_t * pContext,
uint8_t i,
const char * pToken,
cellularAtData_t * pLibAtData );
static CellularPktStatus_t _regStatusSwitchParsingFuncCereg( CellularContext_t * pContext,
uint8_t i,
const char * pToken,
cellularAtData_t * pLibAtData );
static CellularPktStatus_t _regStatusSwitchParsingFuncCgreg( CellularContext_t * pContext,
uint8_t i,
const char * pToken,
cellularAtData_t * pLibAtData );
static void _regStatusGenerateLog( char * pRegPayload,
CellularNetworkRegType_t regType );
static void _regStatusGenerateEvent( const CellularContext_t * pContext,
Expand All @@ -101,33 +126,25 @@ static CellularPktStatus_t _parseRegStatusInRegStatusParsing( CellularContext_t
CellularPktStatus_t packetStatus = CELLULAR_PKT_STATUS_OK;
CellularNetworkRegistrationStatus_t regStatus = REGISTRATION_STATUS_UNKNOWN;

if( ( regType != CELLULAR_REG_TYPE_CREG ) && ( regType != CELLULAR_REG_TYPE_CEREG ) &&
( regType != CELLULAR_REG_TYPE_CGREG ) )
{
packetStatus = CELLULAR_PKT_STATUS_BAD_PARAM;
}
else
{
atCoreStatus = Cellular_ATStrtoi( pToken, 10, &tempValue );
atCoreStatus = Cellular_ATStrtoi( pToken, 10, &tempValue );

if( atCoreStatus == CELLULAR_AT_SUCCESS )
if( atCoreStatus == CELLULAR_AT_SUCCESS )
{
if( ( tempValue >= 0 ) && ( tempValue < ( int32_t ) REGISTRATION_STATUS_MAX ) )
{
if( ( tempValue >= 0 ) && ( tempValue < ( int32_t ) REGISTRATION_STATUS_MAX ) )
{
/* MISRA Ref 10.5.1 [Essential type casting] */
/* More details at: https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/blob/main/MISRA.md#rule-105 */
/* coverity[misra_c_2012_rule_10_5_violation] */
regStatus = ( CellularNetworkRegistrationStatus_t ) tempValue;
}
else
{
atCoreStatus = CELLULAR_AT_ERROR;
}
/* MISRA Ref 10.5.1 [Essential type casting] */
/* More details at: https://github.com/FreeRTOS/FreeRTOS-Cellular-Interface/blob/main/MISRA.md#rule-105 */
/* coverity[misra_c_2012_rule_10_5_violation] */
regStatus = ( CellularNetworkRegistrationStatus_t ) tempValue;
}
else
{
atCoreStatus = CELLULAR_AT_ERROR;
}

packetStatus = _Cellular_TranslateAtCoreStatus( atCoreStatus );
}

packetStatus = _Cellular_TranslateAtCoreStatus( atCoreStatus );

if( packetStatus == CELLULAR_PKT_STATUS_OK )
{
if( regType == CELLULAR_REG_TYPE_CREG )
Expand Down Expand Up @@ -386,6 +403,39 @@ static CellularPktStatus_t _parseRejectCauseInRegStatus( CellularNetworkRegType_

/*-----------------------------------------------------------*/

static CellularPktStatus_t _parseRoutingAreaCodeInRegStatus( const char * pToken,
cellularAtData_t * pLibAtData )
{
int32_t tempValue = 0;
uint8_t rac = 0;
CellularATError_t atCoreStatus = CELLULAR_AT_SUCCESS;
CellularPktStatus_t packetStatus = CELLULAR_PKT_STATUS_OK;

atCoreStatus = Cellular_ATStrtoi( pToken, 16, &tempValue );

if( atCoreStatus == CELLULAR_AT_SUCCESS )
{
if( ( tempValue >= 0 ) && ( tempValue <= ( int32_t ) UINT8_MAX ) )
{
rac = ( uint8_t ) tempValue;
}
else
{
atCoreStatus = CELLULAR_AT_ERROR;
}
}

if( atCoreStatus == CELLULAR_AT_SUCCESS )
{
pLibAtData->rac = rac;
}

packetStatus = _Cellular_TranslateAtCoreStatus( atCoreStatus );
return packetStatus;
}

/*-----------------------------------------------------------*/

static CellularPktStatus_t _regStatusSwitchParsingFunc( CellularContext_t * pContext,
uint8_t i,
CellularNetworkRegType_t regType,
Expand All @@ -397,6 +447,10 @@ static CellularPktStatus_t _regStatusSwitchParsingFunc( CellularContext_t * pCon
switch( i )
{
/* Parsing network Registration status in CREG or CGREG or CEREG response. */
case CELLULAR_REG_POS_NET_REG:
LogDebug( ( "Do nothing for network registration unsolicited result code" ) );
ActoryOu marked this conversation as resolved.
Show resolved Hide resolved
break;

case CELLULAR_REG_POS_STAT:
packetStatus = _parseRegStatusInRegStatusParsing( pContext, regType, pToken, pLibAtData );
break;
Expand Down Expand Up @@ -425,6 +479,11 @@ static CellularPktStatus_t _regStatusSwitchParsingFunc( CellularContext_t * pCon
packetStatus = _parseRejectCauseInRegStatus( regType, pToken, pLibAtData );
break;

/* Parsing the routing area code */
case CELLULAR_REG_POS_RAC:
packetStatus = _parseRoutingAreaCodeInRegStatus( pToken, pLibAtData );
break;

default:
LogDebug( ( "Unknown Parameter Position in Registration URC" ) );
break;
Expand All @@ -435,6 +494,106 @@ static CellularPktStatus_t _regStatusSwitchParsingFunc( CellularContext_t * pCon

/*-----------------------------------------------------------*/

static CellularPktStatus_t _regStatusSwitchParsingFuncCreg( CellularContext_t * pContext,
uint8_t i,
const char * pToken,
cellularAtData_t * pLibAtData )
{
CellularPktStatus_t packetStatus = CELLULAR_PKT_STATUS_OK;
uint8_t parsingTable[] =
ActoryOu marked this conversation as resolved.
Show resolved Hide resolved
{
CELLULAR_REG_POS_NONE,
CELLULAR_REG_POS_NET_REG,
CELLULAR_REG_POS_STAT,
CELLULAR_REG_POS_LAC_TAC,
CELLULAR_REG_POS_CELL_ID,
CELLULAR_REG_POS_RAT,
CELLULAR_REG_POS_REJ_TYPE,
CELLULAR_REG_POS_REJ_CAUSE
};

if( i >= ( sizeof( parsingTable ) / sizeof( parsingTable[ 0 ] ) ) )
{
LogDebug( ( "Unknown Parameter Position(%u) in Registration URC", i ) );
}
else
{
packetStatus = _regStatusSwitchParsingFunc( pContext, parsingTable[ i ], CELLULAR_REG_TYPE_CREG,
pToken, pLibAtData );
}

return packetStatus;
}

/*-----------------------------------------------------------*/

static CellularPktStatus_t _regStatusSwitchParsingFuncCgreg( CellularContext_t * pContext,
uint8_t i,
const char * pToken,
cellularAtData_t * pLibAtData )
{
CellularPktStatus_t packetStatus = CELLULAR_PKT_STATUS_OK;
uint8_t parsingTable[] =
ActoryOu marked this conversation as resolved.
Show resolved Hide resolved
{
CELLULAR_REG_POS_NONE,
CELLULAR_REG_POS_NET_REG,
CELLULAR_REG_POS_STAT,
CELLULAR_REG_POS_LAC_TAC,
CELLULAR_REG_POS_CELL_ID,
CELLULAR_REG_POS_RAT,
CELLULAR_REG_POS_RAC,
CELLULAR_REG_POS_REJ_TYPE,
CELLULAR_REG_POS_REJ_CAUSE
};

if( i >= ( sizeof( parsingTable ) / sizeof( parsingTable[ 0 ] ) ) )
{
LogDebug( ( "Unknown Parameter Position(%u) in Registration URC", i ) );
}
else
{
packetStatus = _regStatusSwitchParsingFunc( pContext, parsingTable[ i ], CELLULAR_REG_TYPE_CGREG,
pToken, pLibAtData );
}

return packetStatus;
}

/*-----------------------------------------------------------*/

static CellularPktStatus_t _regStatusSwitchParsingFuncCereg( CellularContext_t * pContext,
uint8_t i,
const char * pToken,
cellularAtData_t * pLibAtData )
{
CellularPktStatus_t packetStatus = CELLULAR_PKT_STATUS_OK;
uint8_t parsingTable[] =
ActoryOu marked this conversation as resolved.
Show resolved Hide resolved
{
CELLULAR_REG_POS_NONE,
CELLULAR_REG_POS_NET_REG,
CELLULAR_REG_POS_STAT,
CELLULAR_REG_POS_LAC_TAC,
CELLULAR_REG_POS_CELL_ID,
CELLULAR_REG_POS_RAT,
CELLULAR_REG_POS_REJ_TYPE,
CELLULAR_REG_POS_REJ_CAUSE
};

if( i >= ( sizeof( parsingTable ) / sizeof( parsingTable[ 0 ] ) ) )
{
LogDebug( ( "Unknown Parameter Position(%u) in Registration URC", i ) );
}
else
{
packetStatus = _regStatusSwitchParsingFunc( pContext, parsingTable[ i ], CELLULAR_REG_TYPE_CEREG,
pToken, pLibAtData );
}

return packetStatus;
}

/*-----------------------------------------------------------*/

static void _regStatusGenerateLog( char * pRegPayload,
CellularNetworkRegType_t regType )
{
Expand Down Expand Up @@ -548,6 +707,7 @@ CellularPktStatus_t _Cellular_ParseRegStatus( CellularContext_t * pContext,
CellularATError_t atCoreStatus = CELLULAR_AT_SUCCESS;
CellularNetworkRegistrationStatus_t prevCsRegStatus = REGISTRATION_STATUS_UNKNOWN;
CellularNetworkRegistrationStatus_t prevPsRegStatus = REGISTRATION_STATUS_UNKNOWN;
RegStatusSwitchParsingFunc_t pRegStatusParsingFunc = NULL;

if( pContext == NULL )
{
Expand Down Expand Up @@ -580,6 +740,29 @@ CellularPktStatus_t _Cellular_ParseRegStatus( CellularContext_t * pContext,
atCoreStatus = Cellular_ATGetNextTok( &pRegStr, &pToken );
}

if( atCoreStatus == CELLULAR_AT_SUCCESS )
ActoryOu marked this conversation as resolved.
Show resolved Hide resolved
{
switch( regType )
{
case CELLULAR_REG_TYPE_CREG:
pRegStatusParsingFunc = _regStatusSwitchParsingFuncCreg;
break;

case CELLULAR_REG_TYPE_CGREG:
pRegStatusParsingFunc = _regStatusSwitchParsingFuncCgreg;
break;

case CELLULAR_REG_TYPE_CEREG:
pRegStatusParsingFunc = _regStatusSwitchParsingFuncCereg;
break;

default:
LogDebug( ( "Unknown Registration Type %d", regType ) );
atCoreStatus = CELLULAR_AT_BAD_PARAMETER;
break;
}
}

if( atCoreStatus == CELLULAR_AT_SUCCESS )
{
/* Backup the previous regStatus. */
Expand All @@ -589,8 +772,13 @@ CellularPktStatus_t _Cellular_ParseRegStatus( CellularContext_t * pContext,
while( pToken != NULL )
{
i++;
packetStatus = _regStatusSwitchParsingFunc( pContext, i, regType,
pToken, pLibAtData );

packetStatus = pRegStatusParsingFunc( pContext, i, pToken, pLibAtData );

if( packetStatus != CELLULAR_PKT_STATUS_OK )
{
break;
}

/* Getting next token to parse. */
if( Cellular_ATGetNextTok( &pRegStr, &pToken ) != CELLULAR_AT_SUCCESS )
Expand Down
Loading