components/modemServices/platformAdaptor/interfaces/inc/pa_mrc.h

Go to the documentation of this file.

#ifndef LEGATO_PARC_INCLUDE_GUARD
#define LEGATO_PARC_INCLUDE_GUARD

#include "legato.h"
#include "le_mdm_defs.h"

//--------------------------------------------------------------------------------------------------
// Symbol and Enum definitions.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define PA_MRC_METWORK_MASK_GSM       1<<0
#define PA_MRC_METWORK_MASK_UTMS      1<<1
#define PA_MRC_METWORK_MASK_LTE       1<<2
#define PA_MRC_METWORK_MASK_TD_SCDMA  1<<3

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define PA_MRC_METWORK_RATMASK_GSM          1<<0
#define PA_MRC_METWORK_RATMASK_UTMS         1<<1
#define PA_MRC_METWORK_RATMASK_LTE          1<<2
#define PA_MRC_METWORK_RATMASK_GSMCOMPACT   1<<3

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    PA_MRC_DISABLE_REG_NOTIFICATION    = 0, 

    PA_MRC_ENABLE_REG_NOTIFICATION     = 1, 
    PA_MRC_ENABLE_REG_LOC_NOTIFICATION = 2, 


}
pa_mrc_NetworkRegSetting_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    PA_MRC_SCAN_PLMN = 0,       
    PA_MRC_SCAN_CSG,            
}
le_mrc_ScanType_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct
{
    char mcc[LE_MRC_MCC_BYTES];
    char mnc[LE_MRC_MNC_BYTES];
}
pa_mrc_MobileCode_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct
{
    pa_mrc_MobileCode_t mobileCode; 
    uint32_t            ratMask;    
    le_dls_Link_t       link;       
}
pa_mrc_PreferredNetwork_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct
{
    pa_mrc_MobileCode_t mobileCode;     
    uint32_t            rat;            
    uint32_t            networkStatus;  
    le_dls_Link_t       link;           
}
pa_mrc_ScanInformation_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*pa_mrc_NetworkRegHdlrFunc_t)(le_mrc_NetRegState_t* regState);


//--------------------------------------------------------------------------------------------------
// APIs.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_SetRadioPower
(
    le_onoff_t    power   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_GetRadioPower
(
     le_onoff_t*    powerPtr   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_event_HandlerRef_t pa_mrc_AddNetworkRegHandler
(
    pa_mrc_NetworkRegHdlrFunc_t regStateHandler 

);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_RemoveNetworkRegHandler
(
    le_event_HandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_ConfigureNetworkReg
(
    pa_mrc_NetworkRegSetting_t  setting 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_GetNetworkRegConfig
(
    pa_mrc_NetworkRegSetting_t*  settingPtr   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_GetNetworkRegState
(
    le_mrc_NetRegState_t* statePtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_GetSignalQuality
(
    int32_t*          rssiPtr    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_GetHomeNetworkName
(
    char       *nameStr,               
    size_t      nameStrSize            
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void pa_mrc_DeleteScanInformation
(
    le_dls_List_t *scanInformationListPtr 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_PerformNetworkScan
(
    uint32_t            networkMask,           
    le_mrc_ScanType_t   scanType,              
    le_dls_List_t      *scanInformationListPtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_GetScanInformationCode
(
    pa_mrc_ScanInformation_t *scanInformationPtr,   
    pa_mrc_MobileCode_t      *mobileCodePtr         
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_GetScanInformationName
(
    pa_mrc_ScanInformation_t *scanInformationPtr,   
    char *namePtr, 
    size_t nameSize 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_GetScanInformationRat
(
    pa_mrc_ScanInformation_t *scanInformationPtr,   
    le_mrc_Rat_t             *ratPtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_GetScanInformationInUse
(
    pa_mrc_ScanInformation_t *scanInformationPtr,   
    bool *inUsePtr              
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_GetScanInformationAvailable
(
    pa_mrc_ScanInformation_t *scanInformationPtr,   
    bool                     *isAvailablePtr        
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_GetScanInformationHome
(
    pa_mrc_ScanInformation_t *scanInformationPtr,   
    bool *isHomePtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_GetScanInformationForbidden
(
    pa_mrc_ScanInformation_t *scanInformationPtr,   
    bool *isForbiddenPtr 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_AddPreferredNetwork
(
    le_dls_List_t      *PreferredNetworkListPtr,    
    char                mcc[LE_MRC_MCC_BYTES],      
    char                mnc[LE_MRC_MNC_BYTES],      
    uint32_t            ratMask                     
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_ClearPreferedList
(
    le_dls_List_t      *PreferredNetworkListPtr 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_SavePreferredList
(
    le_dls_List_t      *PreferredNetworkListPtr 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_ConnectNetwork
(
    const char *mccPtr,   
    const char *mncPtr    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_mrc_SetAutomaticNetworkRegistration
(
    void
);


#endif // LEGATO_PARC_INCLUDE_GUARD