Sample code of Modem Call control

/**
* This module implements the le_mcc's tests.
*
*
* Copyright (C) Sierra Wireless Inc.
*
*/
 
#include "legato.h"
#include "interfaces.h"
 
 
//--------------------------------------------------------------------------------------------------
/**
* Test sequence Structure list
*/
//--------------------------------------------------------------------------------------------------
typedef le_result_t (*TestFunc)(void);
 
typedef struct
{
char * name;
TestFunc ptrfunc;
} myStruct;
 
//--------------------------------------------------------------------------------------------------
/**
* CLIR field valid or not.
*/
//--------------------------------------------------------------------------------------------------
static bool ClirValid = true;
 
//--------------------------------------------------------------------------------------------------
/**
* Calling Line Identification Restriction setting for the destination phone number to used.
*/
//--------------------------------------------------------------------------------------------------
static le_onoff_t ClirStatus = LE_OFF;
 
//--------------------------------------------------------------------------------------------------
/**
* Call Reference.
*/
//--------------------------------------------------------------------------------------------------
static le_mcc_CallRef_t TestCallRef;
 
//--------------------------------------------------------------------------------------------------
/**
* Hang Up Timer Reference.
*/
//--------------------------------------------------------------------------------------------------
static le_timer_Ref_t HangUpTimer;
 
//--------------------------------------------------------------------------------------------------
/**
* Destination Phone number.
*/
//--------------------------------------------------------------------------------------------------
static char DestinationNumber[LE_MDMDEFS_PHONE_NUM_MAX_BYTES];
 
//--------------------------------------------------------------------------------------------------
/**
* HangUp Timer handler.
*
*/
//--------------------------------------------------------------------------------------------------
static void HangUpTimerHandler
(
le_timer_Ref_t timerRef
)
{
LE_INFO("Hanging up all calls!");
LE_ERROR_IF(le_mcc_HangUpAll() != LE_OK, "Could not hangup.");
}
 
//--------------------------------------------------------------------------------------------------
/**
* Handler function for Call Event Notifications.
*
*/
//--------------------------------------------------------------------------------------------------
static void MyCallEventHandler
(
le_mcc_Event_t callEvent,
void* contextPtr
)
{
static bool firstConnectCall = true;
 
LE_INFO("MCC TEST: New Call event: %d for Call %p", callEvent, callRef);
 
if (callEvent == LE_MCC_EVENT_ALERTING)
{
LE_INFO("Check MyCallEventHandler passed, event is LE_MCC_EVENT_ALERTING.");
if (firstConnectCall)
{
LE_INFO("---!!!! PLEASE CHECK ON THE REMOTE SIDE IF THE PHONE NUMBER IS %s !!!!---",
((ClirStatus == LE_ON) ? "HIDED" : "DISPLAYED"));
LE_INFO("---!!!! PLEASE HANG UP ON THE REMOTE SIDE !!!!---");
}
}
else if (callEvent == LE_MCC_EVENT_CONNECTED)
{
LE_INFO("Check MyCallEventHandler passed, event is LE_MCC_EVENT_CONNECTED.");
if (firstConnectCall)
{
LE_INFO("---!!!! PLEASE TERMINATE THE CALL on THE REMOTE SIDE !!!!---");
firstConnectCall = false;
}
}
else if (callEvent == LE_MCC_EVENT_TERMINATED)
{
LE_INFO("Check MyCallEventHandler passed, event is LE_MCC_EVENT_TERMINATED.");
switch(term)
{
LE_ERROR("Termination reason is LE_MCC_TERM_NETWORK_FAIL");
exit(EXIT_FAILURE);
break;
 
LE_ERROR("Termination reason is LE_MCC_TERM_UNASSIGNED_NUMBER");
exit(EXIT_FAILURE);
break;
 
LE_ERROR("Termination reason is LE_MCC_TERM_USER_BUSY");
exit(EXIT_FAILURE);
break;
 
LE_INFO("Termination reason is LE_MCC_TERM_LOCAL_ENDED");
LE_INFO("mccTest Sequence SUCCESS");
LE_INFO("mccTest test exit");
le_mcc_Delete(callRef);
exit(EXIT_SUCCESS);
break;
 
LE_INFO("Termination reason is LE_MCC_TERM_REMOTE_ENDED");
LE_INFO("---!!!! PLEASE CREATE AN INCOMING CALL !!!!---");
break;
 
LE_INFO("Termination reason is LE_MCC_TERM_NO_SERVICE");
exit(EXIT_FAILURE);
break;
 
LE_INFO("Termination reason is LE_MCC_TERM_OPERATOR_DETERMINED_BARRING");
exit(EXIT_FAILURE);
break;
 
LE_ERROR("Termination reason is LE_MCC_TERM_UNDEFINED");
LE_ERROR("---!!!! PLEASE CREATE AN INCOMING CALL !!!!---");
break;
 
default:
LE_ERROR("Termination reason is %d", term);
exit(EXIT_FAILURE);
break;
}
LE_INFO("Termination code is 0x%X", code);
 
if (HangUpTimer)
{
le_timer_Stop(HangUpTimer);
}
}
else if (callEvent == LE_MCC_EVENT_INCOMING)
{
LE_INFO("Check MyCallEventHandler passed, event is LE_MCC_EVENT_INCOMING.");
res = le_mcc_Answer(callRef);
if (res == LE_OK)
{
LE_INFO("Check MyCallEventHandler passed, I answered the call");
LE_INFO("All calls will be hung-up in 10 seconds");
LE_ASSERT(le_timer_Start(HangUpTimer) == LE_OK);
}
else
{
LE_ERROR("Check MyCallEventHandler failed to answer the call.");
}
}
else if (callEvent == LE_MCC_EVENT_ORIGINATING)
{
LE_INFO("Check MyCallEventHandler passed, event is LE_MCC_EVENT_ORIGINATING.");
}
else if (callEvent == LE_MCC_EVENT_SETUP)
{
LE_INFO("Check MyCallEventHandler passed, event is LE_MCC_EVENT_SETUP.");
}
else
{
LE_ERROR("Check MyCallEventHandler failed, unknowm event %d.", callEvent);
}
}
 
 
//--------------------------------------------------------------------------------------------------
/**
* Test: Create and start a call.
*
*/
//--------------------------------------------------------------------------------------------------
static le_result_t Testle_mcc_Call
(
void
)
{
le_onoff_t localClirStatus;
 
TestCallRef = le_mcc_Create(DestinationNumber);
 
if (TestCallRef == NULL)
{
return LE_FAULT;
}
 
le_mcc_AddCallEventHandler(MyCallEventHandler, NULL);
 
if (ClirValid == true)
{
res = le_mcc_SetCallerIdRestrict(TestCallRef, ClirStatus);
if (res != LE_OK)
{
LE_ERROR("Failed to set Caller Id Restriction");
return res;
}
}
 
res = le_mcc_GetCallerIdRestrict(TestCallRef, &localClirStatus);
if (((ClirValid == true) && (res != LE_OK)) ||
((ClirValid == false) && (res != LE_OK) && (res != LE_UNAVAILABLE)))
{
LE_ERROR("Failed to get Caller Id Restriction");
return res;
}
 
if ((res == LE_OK) && (localClirStatus != ClirStatus))
{
LE_ERROR("CLIR status doesn't match with CLIR set");
return LE_FAULT;
}
 
res = le_mcc_Start(TestCallRef);
if (res != LE_OK)
{
 
switch(reason)
{
LE_ERROR("Term reason LE_MCC_TERM_FDN_ACTIVE");
break;
LE_ERROR("Term reason LE_MCC_TERM_NOT_ALLOWED");
break;
LE_ERROR("Term reason LE_MCC_TERM_UNDEFINED");
break;
default:
LE_ERROR("Term reason %d", reason);
}
return LE_FAULT;
}
else
{
res = le_mcc_Start(TestCallRef);
LE_ASSERT(res == LE_BUSY);
LE_INFO("le_mcc_Start() LE_BUSY test OK");
}
 
return LE_OK;
}
 
//--------------------------------------------------------------------------------------------------
/**
* Test: Expect an incoming call and then hang-up.
*
*/
//--------------------------------------------------------------------------------------------------
static le_result_t Testle_mcc_HangUpAll
(
void
)
{
// Set a hang-up timer.
HangUpTimer = le_timer_Create("HangUp");
 
le_clk_Time_t interval = {10, 0};
LE_ASSERT(le_timer_SetInterval(HangUpTimer, interval) == LE_OK);
LE_ASSERT(le_timer_SetHandler(HangUpTimer, HangUpTimerHandler) == LE_OK);
 
return LE_OK;
}
 
 
//--------------------------------------------------------------------------------------------------
/*
* ME must be registered on Network with the SIM in ready state.
* Check "logread -f | grep mcc" log
* Start app : app start mccTest
* Execute app :
* app runProc mccTest --exe=mccTest -- <Destination phone number> <CLIR_ON | CLIR_OFF | NO_CLIR>
* - CLIR_ON to activate the Calling line identification restriction. Phone Number is not
* displayed on the remote side.
* - CLIR_OFF to deactivate the Calling line identification restriction. Phone Number can be
* displayed on the remote side.
* - NO_CLIR to indicate not to set the Calling line identification restriction for this call.
*/
//--------------------------------------------------------------------------------------------------
{
int i, nbArgument = 0;
myStruct mcctest[] =
{
{ "Test le_mcc_Call()", Testle_mcc_Call },
{ "Test le_mcc_HangUpAll()", Testle_mcc_HangUpAll },
{ "", NULL }
};
 
nbArgument = le_arg_NumArgs();
 
if (nbArgument == 2)
{
// This function gets the telephone number from the User (interactive case).
const char* phoneNumber = le_arg_GetArg(0);
if (NULL == phoneNumber)
{
LE_ERROR("phoneNumber is NULL");
exit(EXIT_FAILURE);
}
const char* clirStatusStr = le_arg_GetArg(1);
strncpy(DestinationNumber, phoneNumber, LE_MDMDEFS_PHONE_NUM_MAX_BYTES);
 
if (clirStatusStr)
{
if (0 == strcmp(clirStatusStr, "NO_CLIR"))
{
ClirValid = false;
LE_INFO("Phone number %s, No CLIR", DestinationNumber);
}
else if (0 == strcmp(clirStatusStr, "CLIR_ON"))
{
ClirValid = true;
ClirStatus = LE_ON;
LE_INFO("Phone number %s, CLIR ON", DestinationNumber);
}
else if (0 == strcmp(clirStatusStr, "CLIR_OFF"))
{
ClirValid = true;
ClirStatus = LE_OFF;
LE_INFO("Phone number %s, CLIR OFF", DestinationNumber);
}
else
{
LE_ERROR("Incorrect argument '%s'", clirStatusStr);
exit(EXIT_FAILURE);
}
}
 
for (i=0; mcctest[i].ptrfunc != NULL; i++)
{
LE_INFO("Test %s STARTED\n", mcctest[i].name);
res = mcctest[i].ptrfunc();
if (res != LE_OK)
{
LE_ERROR("Test %s FAILED\n", mcctest[i].name);
LE_INFO("mccTest sequence FAILED");
exit(EXIT_FAILURE);
}
else
{
LE_INFO("Test %s PASSED\n", mcctest[i].name);
}
}
}
else
{
LE_ERROR("PRINT USAGE => app runProc mccTest --exe=mccTest -- <Destination phone number>"
" <CLIR_ON | CLIR_OFF | NO_CLIR>");
exit(EXIT_SUCCESS);
}
}