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

Go to the documentation of this file.

#ifndef LEGATO_PASIM_INCLUDE_GUARD
#define LEGATO_PASIM_INCLUDE_GUARD


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

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define PA_SIM_CARDID_MAX_LEN     20

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define PA_SIM_IMSI_MAX_LEN     15

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define PA_SIM_PIN_MAX_LEN     8

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define PA_SIM_PUK_MAX_LEN     8

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    PA_SIM_PIN=0,     
    PA_SIM_PIN2       
}
pa_sim_PinType_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    PA_SIM_PUK=0,    
    PA_SIM_PUK2      
}
pa_sim_PukType_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef char pa_sim_CardId_t[PA_SIM_CARDID_MAX_LEN+1];

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef char pa_sim_Imsi_t[PA_SIM_IMSI_MAX_LEN+1];

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef char pa_sim_Pin_t[PA_SIM_PIN_MAX_LEN+1];

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef char pa_sim_Puk_t[PA_SIM_PUK_MAX_LEN+1];

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct
{
    uint32_t         num;     
    le_sim_States_t  state;   
}
pa_sim_Event_t;

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*pa_sim_NewStateHdlrFunc_t)(pa_sim_Event_t* eventPtr);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint32_t pa_sim_CountSlots
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sim_SelectCard
(
    uint32_t  cardNum     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sim_GetSelectedCard
(
    uint32_t*  cardNumPtr     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sim_GetCardIdentification
(
    pa_sim_CardId_t iccid     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sim_GetIMSI
(
    pa_sim_Imsi_t imsi   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sim_GetState
(
    le_sim_States_t* statePtr    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_event_HandlerRef_t pa_sim_AddNewStateHandler
(
    pa_sim_NewStateHdlrFunc_t handler 
);

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sim_EnterPIN
(
    pa_sim_PinType_t   type,  
    const pa_sim_Pin_t pin    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sim_EnterPUK
(
    pa_sim_PukType_t   type, 
    const pa_sim_Puk_t puk,  
    const pa_sim_Pin_t pin   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sim_GetPINRemainingAttempts
(
    pa_sim_PinType_t type,       
    uint32_t*        attemptsPtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sim_GetPUKRemainingAttempts
(
    pa_sim_PukType_t type,       
    uint32_t*        attemptsPtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sim_ChangePIN
(
    pa_sim_PinType_t   type,    
    const pa_sim_Pin_t oldcode, 
    const pa_sim_Pin_t newcode  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sim_EnablePIN
(
    pa_sim_PinType_t   type,  
    const pa_sim_Pin_t code   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sim_DisablePIN
(
    pa_sim_PinType_t   type,  
    const pa_sim_Pin_t code   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sim_GetSubscriberPhoneNumber
(
    char        *phoneNumberStr,    
    size_t       phoneNumberStrSize 
);

#endif // LEGATO_PASIM_INCLUDE_GUARD