le_mrc_interface.h

Go to the documentation of this file.

/*
 * ====================== WARNING ======================
 *
 * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
 * DO NOT MODIFY IN ANY WAY.
 *
 * ====================== WARNING ======================
 */

#ifndef LE_MRC_H_INCLUDE_GUARD
#define LE_MRC_H_INCLUDE_GUARD


#include "legato.h"

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mrc_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mrc_DisconnectService
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MRC_MCC_LEN 3


//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
#define LE_MRC_MCC_BYTES 4


//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
#define LE_MRC_MNC_LEN 3


//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
#define LE_MRC_MNC_BYTES 4


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MRC_BITMASK_BAND_CLASS_0_A_SYSTEM = 0x1,
    LE_MRC_BITMASK_BAND_CLASS_0_B_SYSTEM = 0x2,
    LE_MRC_BITMASK_BAND_CLASS_1_ALL_BLOCKS = 0x4,
    LE_MRC_BITMASK_BAND_CLASS_2_PLACEHOLDER = 0x8,
    LE_MRC_BITMASK_BAND_CLASS_3_A_SYSTEM = 0x10,
    LE_MRC_BITMASK_BAND_CLASS_4_ALL_BLOCKS = 0x20,
    LE_MRC_BITMASK_BAND_CLASS_5_ALL_BLOCKS = 0x40,
    LE_MRC_BITMASK_BAND_CLASS_6 = 0x80,
    LE_MRC_BITMASK_BAND_CLASS_7 = 0x100,
    LE_MRC_BITMASK_BAND_CLASS_8 = 0x200,
    LE_MRC_BITMASK_BAND_CLASS_9 = 0x400,
    LE_MRC_BITMASK_BAND_CLASS_10 = 0x800,
    LE_MRC_BITMASK_BAND_CLASS_11 = 0x1000,
    LE_MRC_BITMASK_BAND_CLASS_12 = 0x2000,
    LE_MRC_BITMASK_BAND_CLASS_14 = 0x4000,
    LE_MRC_BITMASK_BAND_CLASS_15 = 0x8000,
    LE_MRC_BITMASK_BAND_CLASS_16 = 0x10000,
    LE_MRC_BITMASK_BAND_CLASS_17 = 0x20000,
    LE_MRC_BITMASK_BAND_CLASS_18 = 0x40000,
    LE_MRC_BITMASK_BAND_CLASS_19 = 0x80000,
    LE_MRC_BITMASK_BAND_GSM_DCS_1800 = 0x100000,
    LE_MRC_BITMASK_BAND_EGSM_900 = 0x200000,
    LE_MRC_BITMASK_BAND_PRI_GSM_900 = 0x400000,
    LE_MRC_BITMASK_BAND_GSM_450 = 0x800000,
    LE_MRC_BITMASK_BAND_GSM_480 = 0x1000000,
    LE_MRC_BITMASK_BAND_GSM_750 = 0x2000000,
    LE_MRC_BITMASK_BAND_GSM_850 = 0x4000000,
    LE_MRC_BITMASK_BAND_GSMR_900 = 0x8000000,
    LE_MRC_BITMASK_BAND_GSM_PCS_1900 = 0x10000000,
    LE_MRC_BITMASK_BAND_WCDMA_EU_J_CH_IMT_2100 = 0x20000000,
    LE_MRC_BITMASK_BAND_WCDMA_US_PCS_1900 = 0x40000000,
    LE_MRC_BITMASK_BAND_WCDMA_EU_CH_DCS_1800 = 0x80000000,
    LE_MRC_BITMASK_BAND_WCDMA_US_1700 = 0x100000000,
    LE_MRC_BITMASK_BAND_WCDMA_US_850 = 0x200000000,
    LE_MRC_BITMASK_BAND_WCDMA_J_800 = 0x400000000,
    LE_MRC_BITMASK_BAND_WCDMA_EU_2600 = 0x800000000,
    LE_MRC_BITMASK_BAND_WCDMA_EU_J_900 = 0x1000000000,
    LE_MRC_BITMASK_BAND_WCDMA_J_1700 = 0x2000000000
}
le_mrc_BandBitMask_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_1 = 0x1,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_2 = 0x2,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_3 = 0x4,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_4 = 0x8,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_5 = 0x10,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_6 = 0x20,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_7 = 0x40,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_8 = 0x80,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_9 = 0x100,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_10 = 0x200,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_11 = 0x400,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_12 = 0x800,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_13 = 0x1000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_14 = 0x2000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_17 = 0x4000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_18 = 0x8000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_19 = 0x10000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_20 = 0x20000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_21 = 0x40000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_24 = 0x80000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_25 = 0x100000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_33 = 0x200000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_34 = 0x400000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_35 = 0x800000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_36 = 0x1000000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_37 = 0x2000000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_38 = 0x4000000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_39 = 0x8000000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_40 = 0x10000000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_41 = 0x20000000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_42 = 0x40000000,
    LE_MRC_BITMASK_LTE_BAND_E_UTRA_OP_BAND_43 = 0x80000000
}
le_mrc_LteBandBitMask_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MRC_BITMASK_TDSCDMA_BAND_A = 0x1,
    LE_MRC_BITMASK_TDSCDMA_BAND_B = 0x2,
    LE_MRC_BITMASK_TDSCDMA_BAND_C = 0x4,
    LE_MRC_BITMASK_TDSCDMA_BAND_D = 0x8,
    LE_MRC_BITMASK_TDSCDMA_BAND_E = 0x10,
    LE_MRC_BITMASK_TDSCDMA_BAND_F = 0x20
}
le_mrc_TdScdmaBandBitMask_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_MRC_NETWORK_NAME_MAX_LEN 100


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


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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mrc_PreferredOperator* le_mrc_PreferredOperatorRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mrc_PreferredOperatorList* le_mrc_PreferredOperatorListRef_t;


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


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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MRC_REG_NONE,

    LE_MRC_REG_HOME,

    LE_MRC_REG_SEARCHING,

    LE_MRC_REG_DENIED,

    LE_MRC_REG_ROAMING,

    LE_MRC_REG_UNKNOWN
}
le_mrc_NetRegState_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MRC_RAT_UNKNOWN,

    LE_MRC_RAT_GSM,

    LE_MRC_RAT_UMTS,

    LE_MRC_RAT_LTE,

    LE_MRC_RAT_CDMA
}
le_mrc_Rat_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_MRC_BITMASK_RAT_GSM = 0x1,

    LE_MRC_BITMASK_RAT_UMTS = 0x2,

    LE_MRC_BITMASK_RAT_LTE = 0x4,

    LE_MRC_BITMASK_RAT_CDMA = 0x8,

    LE_MRC_BITMASK_RAT_ALL = 0x10
}
le_mrc_RatBitMask_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mrc_NetRegStateEventHandler* le_mrc_NetRegStateEventHandlerRef_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_NetRegStateEventHandlerRef_t le_mrc_AddNetRegStateEventHandler
(
    le_mrc_NetRegStateHandlerFunc_t handlerPtr,

    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mrc_RemoveNetRegStateEventHandler
(
    le_mrc_NetRegStateEventHandlerRef_t addHandlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mrc_RatChangeHandlerRef_t le_mrc_AddRatChangeHandler
(
    le_mrc_RatChangeHandlerFunc_t handlerPtr,

    void* contextPtr
);

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_SetAutomaticRegisterMode
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_SetManualRegisterMode
(
    const char* mcc,

    const char* mnc
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_GetRegisterMode
(
    bool* isManualPtrPtr,

    char* mccPtr,

    size_t mccPtrNumElements,

    char* mncPtr,

    size_t mncPtrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_SetRatPreferences
(
    le_mrc_RatBitMask_t ratMask
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_GetRatPreferences
(
    le_mrc_RatBitMask_t* ratMaskPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_SetBandPreferences
(
    le_mrc_BandBitMask_t bandMask
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_GetBandPreferences
(
    le_mrc_BandBitMask_t* bandMaskPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_SetLteBandPreferences
(
    le_mrc_LteBandBitMask_t bandMask
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_GetLteBandPreferences
(
    le_mrc_LteBandBitMask_t* bandMaskPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_SetTdScdmaBandPreferences
(
    le_mrc_TdScdmaBandBitMask_t bandMask
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_GetTdScdmaBandPreferences
(
    le_mrc_TdScdmaBandBitMask_t* bandMaskPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_AddPreferredOperator
(
    const char* mcc,

    const char* mnc,

    le_mrc_RatBitMask_t ratMask
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_RemovePreferredOperator
(
    const char* mcc,

    const char* mnc
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mrc_PreferredOperatorListRef_t le_mrc_GetPreferredOperatorsList
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mrc_PreferredOperatorRef_t le_mrc_GetFirstPreferredOperator
(
    le_mrc_PreferredOperatorListRef_t preferredOperatorListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mrc_PreferredOperatorRef_t le_mrc_GetNextPreferredOperator
(
    le_mrc_PreferredOperatorListRef_t preferredOperatorListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mrc_DeletePreferredOperatorsList
(
    le_mrc_PreferredOperatorListRef_t preferredOperatorListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_GetPreferredOperatorDetails
(
    le_mrc_PreferredOperatorRef_t preferredOperatorRef,

    char* mccPtr,

    size_t mccPtrNumElements,

    char* mncPtr,

    size_t mncPtrNumElements,

    le_mrc_RatBitMask_t* ratMaskPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
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_SetRadioPower
(
    le_onoff_t power
);

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_RegisterCellularNetwork
(
    const char* mcc,

    const char* mnc
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mrc_ScanInformationListRef_t le_mrc_PerformCellularNetworkScan
(
    le_mrc_RatBitMask_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 mccPtrNumElements,

    char* mncPtr,

    size_t mncPtrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_GetCellularNetworkName
(
    le_mrc_ScanInformationRef_t scanInformationRef,

    char* namePtr,

    size_t namePtrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mrc_Rat_t le_mrc_GetCellularNetworkRat
(
    le_mrc_ScanInformationRef_t scanInformationRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
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_GetCurrentNetworkName
(
    char* nameStr,

    size_t nameStrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_mrc_GetCurrentNetworkMccMnc
(
    char* mccStr,

    size_t mccStrNumElements,

    char* mncStr,

    size_t mncStrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
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 // LE_MRC_H_INCLUDE_GUARD