le_sim.h

Go to the documentation of this file.

#ifndef LEGATO_SIM_INCLUDE_GUARD
#define LEGATO_SIM_INCLUDE_GUARD

#include "legato.h"

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

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


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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SIM_PUK_LEN     8

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SIM_ICCID_LEN     (20+1)

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SIM_IMSI_LEN     (15+1)


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_SIM_INSERTED      = 0, 
    LE_SIM_ABSENT        = 1, 
    LE_SIM_READY         = 2, 
    LE_SIM_BLOCKED       = 3, 
    LE_SIM_BUSY          = 4, 
    LE_SIM_STATE_UNKNOWN = 5, 
}
le_sim_States_t;

//--------------------------------------------------------------------------------------------------
// Other new type definitions.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_sim_Obj* le_sim_ObjRef_t;


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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_sim_NewStateHandlerFunc_t)
(
    le_sim_ObjRef_t  simRef,
    void*         contextPtr
);


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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint32_t le_sim_CountSlots
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint32_t le_sim_GetSelectedCard
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sim_ObjRef_t le_sim_Create
(
    uint32_t cardNum  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sim_Delete
(
    le_sim_ObjRef_t  simRef    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint32_t le_sim_GetSlotNumber
(
    le_sim_ObjRef_t simRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_GetICCID
(
    le_sim_ObjRef_t simRef,   
    char * iccidPtr,       
    size_t iccidLen        
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_GetIMSI
(
    le_sim_ObjRef_t simRef,  
    char * imsiPtr,       
    size_t imsiLen        
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_sim_IsPresent
(
    le_sim_ObjRef_t simRef    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_sim_IsReady
(
    le_sim_ObjRef_t simRef    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_EnterPIN
(
    le_sim_ObjRef_t simRef,    
    const char*  pinPtr     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_ChangePIN
(
    le_sim_ObjRef_t simRef,    
    const char*  oldpinPtr, 
    const char*  newpinPtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int32_t le_sim_GetRemainingPINTries
(
    le_sim_ObjRef_t simRef    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_Unlock
(
    le_sim_ObjRef_t simRef, 
    const char*  pinPtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_Lock
(
    le_sim_ObjRef_t simRef, 
    const char*  pinPtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_Unblock
(
    le_sim_ObjRef_t simRef,    
    const char*  pukPtr,    
    const char*  newpinPtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sim_States_t le_sim_GetState
(
    le_sim_ObjRef_t simRef    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sim_NewStateHandlerRef_t le_sim_AddNewStateHandler
(
    le_sim_NewStateHandlerFunc_t handlerFuncPtr, 
    void*                        contextPtr      
);

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sim_GetSubscriberPhoneNumber
(
    le_sim_ObjRef_t simRef,            
    char        *phoneNumberStr,    
    size_t       phoneNumberStrSize 
);

#endif // LEGATO_SIM_INCLUDE_GUARD