le_sim_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_SIM_INTERFACE_H_INCLUDE_GUARD
#define LE_SIM_INTERFACE_H_INCLUDE_GUARD


#include "legato.h"

// Interface specific includes
#include "le_mdmDefs_interface.h"


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sim_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sim_DisconnectService
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SIM_PIN_MIN_LEN 4


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SIM_PIN_MAX_LEN 8


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SIM_PIN_MAX_BYTES 9


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SIM_PUK_MAX_LEN 8


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SIM_PUK_MAX_BYTES 9


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SIM_ICCID_LEN 20


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SIM_ICCID_BYTES 21


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SIM_IMSI_LEN 15


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SIM_IMSI_BYTES 16


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_SIM_INSERTED,

    LE_SIM_ABSENT,

    LE_SIM_READY,

    LE_SIM_BLOCKED,

    LE_SIM_BUSY,

    LE_SIM_STATE_UNKNOWN
}
le_sim_States_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_SIM_EMBEDDED,

    LE_SIM_EXTERNAL_SLOT_1,

    LE_SIM_EXTERNAL_SLOT_2,

    LE_SIM_REMOTE,

    LE_SIM_ID_MAX
}
le_sim_Id_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_SIM_OBERTHUR,

    LE_SIM_GEMALTO,

    LE_SIM_G_AND_D,

    LE_SIM_MORPHO,

    LE_SIM_MANUFACTURER_MAX
}
le_sim_Manufacturer_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_SIM_OPEN_CHANNEL,

    LE_SIM_REFRESH,

    LE_SIM_STK_EVENT_MAX
}
le_sim_StkEvent_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_sim_NewStateHandler* le_sim_NewStateHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_sim_SimToolkitEventHandler* le_sim_SimToolkitEventHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_sim_NewStateHandlerFunc_t)
(
    le_sim_Id_t simId,
    le_sim_States_t simState,
    void* contextPtr
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_sim_SimToolkitEventHandlerFunc_t)
(
    le_sim_Id_t simId,
    le_sim_StkEvent_t stkEvent,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sim_NewStateHandlerRef_t le_sim_AddNewStateHandler
(
    le_sim_NewStateHandlerFunc_t handlerPtr,

    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sim_RemoveNewStateHandler
(
    le_sim_NewStateHandlerRef_t addHandlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sim_SimToolkitEventHandlerRef_t le_sim_AddSimToolkitEventHandler
(
    le_sim_SimToolkitEventHandlerFunc_t handlerPtr,

    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sim_RemoveSimToolkitEventHandler
(
    le_sim_SimToolkitEventHandlerRef_t addHandlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sim_Id_t le_sim_GetSelectedCard
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_SelectCard
(
    le_sim_Id_t simId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_GetICCID
(
    le_sim_Id_t simId,

    char* iccid,

    size_t iccidNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_GetIMSI
(
    le_sim_Id_t simId,

    char* imsi,

    size_t imsiNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_sim_IsPresent
(
    le_sim_Id_t simId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_sim_IsReady
(
    le_sim_Id_t simId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_EnterPIN
(
    le_sim_Id_t simId,

    const char* pin
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_ChangePIN
(
    le_sim_Id_t simId,

    const char* oldpin,

    const char* newpin
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int32_t le_sim_GetRemainingPINTries
(
    le_sim_Id_t simId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_Unlock
(
    le_sim_Id_t simId,

    const char* pin
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_Lock
(
    le_sim_Id_t simId,

    const char* pin
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_Unblock
(
    le_sim_Id_t simId,

    const char* puk,

    const char* newpin
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sim_States_t le_sim_GetState
(
    le_sim_Id_t simId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_GetSubscriberPhoneNumber
(
    le_sim_Id_t simId,

    char* phoneNumberStr,

    size_t phoneNumberStrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_GetHomeNetworkOperator
(
    le_sim_Id_t simId,

    char* nameStr,

    size_t nameStrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_GetHomeNetworkMccMnc
(
    le_sim_Id_t simId,

    char* mccPtr,

    size_t mccPtrNumElements,

    char* mncPtr,

    size_t mncPtrNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_LocalSwapToEmergencyCallSubscription
(
    le_sim_Id_t simId,

    le_sim_Manufacturer_t manufacturer
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_LocalSwapToCommercialSubscription
(
    le_sim_Id_t simId,

    le_sim_Manufacturer_t manufacturer
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_IsEmergencyCallSubscriptionSelected
(
    le_sim_Id_t simId,

    bool* isEcsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_AcceptSimToolkitCommand
(
    le_sim_Id_t simId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_RejectSimToolkitCommand
(
    le_sim_Id_t simId
);


#endif // LE_SIM_INTERFACE_H_INCLUDE_GUARD