le_mrc.h

Go to the documentation of this file.

#ifndef LEGATO_MRC_INCLUDE_GUARD
#define LEGATO_MRC_INCLUDE_GUARD

#include "legato.h"

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

// Mobile Country Code length
#define LE_MRC_MCC_LEN      3
#define LE_MRC_MCC_BYTES    (LE_MRC_MCC_LEN+1)

// Mobile network Code length
#define LE_MRC_MNC_LEN      3
#define LE_MRC_MNC_BYTES    (LE_MRC_MNC_LEN+1)

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MRC_BITMASK_RAT_CDMA         0x01
#define LE_MRC_BITMASK_RAT_GSM          0x02
#define LE_MRC_BITMASK_RAT_UMTS         0x04
#define LE_MRC_BITMASK_RAT_LTE          0x08


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MRC_BITMASK_BAND_CLASS_0_A_SYSTEM        0x0000000000000001
#define LE_MRC_BITMASK_BAND_CLASS_0_B_SYSTEM        0x0000000000000002
#define LE_MRC_BITMASK_BAND_CLASS_1_ALL_BLOCKS      0x0000000000000004
#define LE_MRC_BITMASK_BAND_CLASS_2_PLACEHOLDER     0x0000000000000008
#define LE_MRC_BITMASK_BAND_CLASS_3_A_SYSTEM        0x0000000000000010
#define LE_MRC_BITMASK_BAND_CLASS_4_ALL_BLOCKS      0x0000000000000020
#define LE_MRC_BITMASK_BAND_CLASS_5_ALL_BLOCKS      0x0000000000000040
#define LE_MRC_BITMASK_BAND_CLASS_6                 0x0000000000000080
#define LE_MRC_BITMASK_BAND_CLASS_7                 0x0000000000000100
#define LE_MRC_BITMASK_BAND_CLASS_8                 0x0000000000000200
#define LE_MRC_BITMASK_BAND_CLASS_9                 0x0000000000000400
#define LE_MRC_BITMASK_BAND_CLASS_10                0x0000000000000800
#define LE_MRC_BITMASK_BAND_CLASS_11                0x0000000000001000
#define LE_MRC_BITMASK_BAND_CLASS_12                0x0000000000002000
#define LE_MRC_BITMASK_BAND_CLASS_14                0x0000000000004000
#define LE_MRC_BITMASK_BAND_CLASS_15                0x0000000000008000
#define LE_MRC_BITMASK_BAND_CLASS_16                0x0000000000010000
#define LE_MRC_BITMASK_BAND_CLASS_17                0x0000000000020000
#define LE_MRC_BITMASK_BAND_CLASS_18                0x0000000000040000
#define LE_MRC_BITMASK_BAND_CLASS_19                0x0000000000080000
#define LE_MRC_BITMASK_BAND_GSM_DCS_1800            0x0000000000100000
#define LE_MRC_BITMASK_BAND_EGSM_900                0x0000000000200000
#define LE_MRC_BITMASK_BAND_PRI_GSM_900             0x0000000000400000
#define LE_MRC_BITMASK_BAND_GSM_450                 0x0000000000800000
#define LE_MRC_BITMASK_BAND_GSM_480                 0x0000000001000000
#define LE_MRC_BITMASK_BAND_GSM_750                 0x0000000002000000
#define LE_MRC_BITMASK_BAND_GSM_850                 0x0000000004000000
#define LE_MRC_BITMASK_BAND_GSMR_900                0x0000000008000000
#define LE_MRC_BITMASK_BAND_GSM_PCS_1900            0x0000000010000000
#define LE_MRC_BITMASK_BAND_WCDMA_EU_J_CH_IMT_2100  0x0000000020000000
#define LE_MRC_BITMASK_BAND_WCDMA_US_PCS_1900       0x0000000040000000
#define LE_MRC_BITMASK_BAND_WCDMA_EU_CH_DCS_1800    0x0000000080000000
#define LE_MRC_BITMASK_BAND_WCDMA_US_1700           0x0000000100000000
#define LE_MRC_BITMASK_BAND_WCDMA_US_850            0x0000000200000000
#define LE_MRC_BITMASK_BAND_WCDMA_J_800             0x0000000400000000
#define LE_MRC_BITMASK_BAND_WCDMA_EU_2600           0x0000000800000000
#define LE_MRC_BITMASK_BAND_WCDMA_EU_J_900          0x0000001000000000
#define LE_MRC_BITMASK_BAND_WCDMA_J_1700            0x0000002000000000

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_1    0x0000000000000001
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_2    0x0000000000000002
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_3    0x0000000000000004
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_4    0x0000000000000008
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_5    0x0000000000000010
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_6    0x0000000000000020
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_7    0x0000000000000040
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_8    0x0000000000000080
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_9    0x0000000000000100
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_10   0x0000000000000200
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_11   0x0000000000000400
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_12   0x0000000000000800
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_13   0x0000000000001000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_14   0x0000000000002000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_17   0x0000000000004000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_18   0x0000000000008000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_19   0x0000000000010000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_20   0x0000000000020000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_21   0x0000000000040000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_24   0x0000000000080000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_25   0x0000000000100000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_33   0x0000000000200000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_34   0x0000000000400000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_35   0x0000000000800000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_36   0x0000000001000000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_37   0x0000000002000000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_38   0x0000000004000000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_39   0x0000000008000000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_40   0x0000000010000000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_41   0x0000000020000000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_42   0x0000000040000000
#define LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_43   0x0000000080000000

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MRC_BITMASK_TDSCDMA_BAND_A  0x01
#define LE_MRC_BITMASK_TDSCDMA_BAND_B  0x02
#define LE_MRC_BITMASK_TDSCDMA_BAND_C  0x04
#define LE_MRC_BITMASK_TDSCDMA_BAND_D  0x08
#define LE_MRC_BITMASK_TDSCDMA_BAND_E  0x10
#define LE_MRC_BITMASK_TDSCDMA_BAND_F  0x20


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MRC_REG_NONE      = 0, 
    LE_MRC_REG_HOME      = 1, 
    LE_MRC_REG_SEARCHING = 2, 
    LE_MRC_REG_DENIED    = 3, 
    LE_MRC_REG_ROAMING   = 5, 
    LE_MRC_REG_UNKNOWN   = 4, 
}
le_mrc_NetRegState_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MRC_RAT_UNKNOWN  = 0,     
    LE_MRC_RAT_GSM      = 1<<0,  
    LE_MRC_RAT_UMTS     = 1<<1,  
    LE_MRC_RAT_LTE      = 1<<2,  
    LE_MRC_RAT_CDMA     = 1<<3,  
    LE_MRC_RAT_ALL      = LE_MRC_RAT_GSM  |
                          LE_MRC_RAT_UMTS |
                          LE_MRC_RAT_LTE  |
                          LE_MRC_RAT_CDMA   
}
le_mrc_Rat_t;

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mrc_ScanInformation* le_mrc_ScanInformationRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mrc_ScanInformationList* le_mrc_ScanInformationListRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mrc_CellInfo* le_mrc_CellInfoRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mrc_NeighborCells* le_mrc_NeighborCellsRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mrc_NetRegStateHandler* le_mrc_NetRegStateHandlerRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mrc_RatChangeHandler* le_mrc_RatChangeHandlerRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void(*le_mrc_NetRegStateHandlerFunc_t)
(
    le_mrc_NetRegState_t  state,
    void*                 contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void(*le_mrc_RatChangeHandlerFunc_t)
(
    le_mrc_Rat_t  rat,
    void*         contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mrc_NetRegStateHandlerRef_t le_mrc_AddNetRegStateHandler
(
    le_mrc_NetRegStateHandlerFunc_t handlerFuncPtr, 
    void*                           contextPtr      
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mrc_RemoveNetRegStateHandler
(
    le_mrc_NetRegStateHandlerRef_t    handlerRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mrc_RatChangeHandlerRef_t le_mrc_AddRatChangeHandler
(
    le_mrc_RatChangeHandlerFunc_t handlerFuncPtr, 
    void*                         contextPtr      
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mrc_RemoveRatChangeHandler
(
    le_mrc_RatChangeHandlerRef_t    handlerRef 
);

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

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

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_GetSignalQual
(
    uint32_t*   qualityPtr  
);

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

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mrc_ScanInformationListRef_t le_mrc_PerformCellularNetworkScan
(
    le_mrc_Rat_t ratMask 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mrc_ScanInformationRef_t le_mrc_GetFirstCellularNetworkScan
(
    le_mrc_ScanInformationListRef_t  scanInformationListRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mrc_ScanInformationRef_t le_mrc_GetNextCellularNetworkScan
(
    le_mrc_ScanInformationListRef_t  scanInformationListRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mrc_DeleteCellularNetworkScan
(
    le_mrc_ScanInformationListRef_t  scanInformationListRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_GetCellularNetworkMccMnc
(
    le_mrc_ScanInformationRef_t scanInformationRef,    
    char                        *mccPtr,                
    size_t                       mccPtrSize,            
    char                        *mncPtr,                
    size_t                       mncPtrSize             
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_GetCellularNetworkName
(
    le_mrc_ScanInformationRef_t scanInformationRef,    
    char *namePtr, 
    size_t nameSize 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_mrc_IsCellularNetworkRatAvailable
(
    le_mrc_ScanInformationRef_t scanInformationRef,    
    le_mrc_Rat_t                 rat                    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_mrc_IsCellularNetworkInUse
(
    le_mrc_ScanInformationRef_t scanInformationRef    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_mrc_IsCellularNetworkAvailable
(
    le_mrc_ScanInformationRef_t scanInformationRef    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_mrc_IsCellularNetworkHome
(
    le_mrc_ScanInformationRef_t scanInformationRef    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_mrc_IsCellularNetworkForbidden
(
    le_mrc_ScanInformationRef_t scanInformationRef    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_GetRadioAccessTechInUse
(
    le_mrc_Rat_t*   ratPtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mrc_NeighborCellsRef_t le_mrc_GetNeighborCellsInfo
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mrc_DeleteNeighborCellsInfo
(
    le_mrc_NeighborCellsRef_t ngbrCellsRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mrc_CellInfoRef_t le_mrc_GetFirstNeighborCellInfo
(
    le_mrc_NeighborCellsRef_t     ngbrCellsRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mrc_CellInfoRef_t le_mrc_GetNextNeighborCellInfo
(
    le_mrc_NeighborCellsRef_t     ngbrCellsRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint32_t le_mrc_GetNeighborCellId
(
    le_mrc_CellInfoRef_t     ngbrCellInfoRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint32_t le_mrc_GetNeighborCellLocAreaCode
(
    le_mrc_CellInfoRef_t     ngbrCellInfoRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int32_t le_mrc_GetNeighborCellRxLevel
(
    le_mrc_CellInfoRef_t     ngbrCellInfoRef 
);


#endif // LEGATO_MRC_INCLUDE_GUARD