SwiApiGsmSim.h

Go to the documentation of this file.

#ifndef __SWIAPI_GSM_SIM
#define __SWIAPI_GSM_SIM

#ifdef __cplusplus
extern "C" {
#endif

/* include files */
#include "SwiDataTypes.h"
#include "SwiRcodes.h"

/* constants */
#define LENGTH_MaxCHV               9
#define LENGTH_MEPCode              13
#define LENGTH_IccId                10
#define LENGTH_RandNum              16
#define LENGTH_Kc                   8

/* enum declarations */
enum SWI_TYPE_SIM_Password
{
    SWI_SIMPASSWORD_Reserved,
    
    SWI_SIMPASSWORD_CHV1,

    SWI_SIMPASSWORD_CHV2,
    
    SWI_SIMPASSWORD_UnblockingCHV1, 
    
    SWI_SIMPASSWORD_UnblockingCHV2          
};
enum SWI_TYPE_SIM_StatusExp
{
    SWI_SIMSTATUSEXP_OK,                
    SWI_SIMSTATUSEXP_NotInserted,       
    SWI_SIMSTATUSEXP_Removed,           
    SWI_SIMSTATUSEXP_InitializeFailure, 
    SWI_SIMSTATUSEXP_GeneralFailure,    
    SWI_SIMSTATUSEXP_Locked,            
    SWI_SIMSTATUSEXP_PIN1Blocked,       
    SWI_SIMSTATUSEXP_PIN2Blocked,       
    SWI_SIMSTATUSEXP_PIN1Rejected,      
    SWI_SIMSTATUSEXP_PIN2Rejected,      
    SWI_SIMSTATUSEXP_MEPLocked,         
    SWI_SIMSTATUSEXP_NetworkReject      
};
enum SWI_TYPE_SIM_RequiredOperation
{
    SWI_REQUIREDOPERATON_NoOperation, 
    SWI_REQUIREDOPERATON_EnterPIN,    
    SWI_REQUIREDOPERATON_EnterPIN2,   
    SWI_REQUIREDOPERATON_EnterPUK,    
    SWI_REQUIREDOPERATON_EnterPUK2,   
    SWI_REQUIREDOPERATON_EnterMEP     
};
enum SWI_TYPE_SIM_PreviousOperation
{
    SWI_PREVIOUSOPERATION_None,       
    SWI_PREVIOUSOPERATION_ChangePIN,  
    SWI_PREVIOUSOPERATION_ChangePIN2, 
    SWI_PREVIOUSOPERATION_EnableDisablePINVerification, 
    SWI_PREVIOUSOPERATION_VerifyPIN,  
    SWI_PREVIOUSOPERATION_VerifyPIN2, 
    SWI_PREVIOUSOPERATION_VerifyPUK,  
    SWI_PREVIOUSOPERATION_VerifyPUK2, 
    SWI_PREVIOUSOPERATION_MEPUnlock,  
    SWI_PREVIOUSOPERATION_EnablePIN,  
    SWI_PREVIOUSOPERATION_DisablePIN  
};

enum SWI_TYPE_SIM_PreviousActionResult
{
    SWI_PREVIOUSACTIONRESULT_Succeeded,

    SWI_PREVIOUSACTIONRESULT_Failed,

    SWI_PREVIOUSACTIONRESULT_PINVerifyDisabled,

    SWI_PREVIOUSACTIONRESULT_PINStartsEmergency
};

enum SWI_TYPE_SIM_RetryInformation
{
    SWI_TYPE_RETRYINFORMATION_Pin,  
    SWI_TYPE_RETRYINFORMATION_Pin2, 
    SWI_TYPE_RETRYINFORMATION_Puk,  
    SWI_TYPE_RETRYINFORMATION_Puk2  
};

enum SWI_TYPE_SIM_Chv2KickType
{
    SWI_TYPE_CHV2KICKTYPE_Verify,  
    SWI_TYPE_CHV2KICKTYPE_Change   
};

struct SWI_STRUCT_SIM_Verify
{
    swi_uint32 sizeStruct;
    
    enum SWI_TYPE_SIM_Password eType;

    swi_char szPassword[LENGTH_MaxCHV];

    swi_char szUnblockPassword[LENGTH_MaxCHV]; 
};

struct SWI_STRUCT_SIM_Password
{
    swi_uint32 sizeStruct;
    
    enum SWI_TYPE_SIM_Password eType;

    swi_char szOldPassword[LENGTH_MaxCHV]; 

    swi_char szNewPassword[LENGTH_MaxCHV];     
};  

struct SWI_STRUCT_SIM_EnableLock
{
    swi_uint32 sizeStruct;
    
    swi_bool bEnable;                           

    swi_char szPassword[LENGTH_MaxCHV];            
};

struct SWI_STRUCT_SIM_LockStatus
{
    swi_uint32 sizeStruct;  
    
    swi_bool bEnabled;                          
};

struct SWI_STRUCT_SIM_StatusExp
{
    swi_uint32 sizeStruct;  

    enum SWI_TYPE_SIM_StatusExp eStatus;

    enum SWI_TYPE_SIM_RequiredOperation eRequiredOperation;

    enum SWI_TYPE_SIM_PreviousOperation ePreviousOperation;

    enum SWI_TYPE_SIM_PreviousActionResult ePreviousActionResult;

    swi_bool bRetryInformationPresent;

    enum SWI_TYPE_SIM_RetryInformation eRetryInformation;

    swi_uint32 nNumberRetries;          
};

struct SWI_STRUCT_MEP_Unlock
{
    swi_uint32 sizeStruct;  

    swi_char szUnLockCode[LENGTH_MEPCode];     
};
struct SWI_STRUCT_IccId
{
    swi_uint32 sizeStruct;
    
    swi_uint8 nIccId[LENGTH_IccId]; 
};

struct SWI_STRUCT_SimAuth 
{
    swi_uint32 sizeStruct;
    
    swi_uint8 RandNum[LENGTH_RandNum];
    
    swi_uint32 SimResponse;
    
    swi_uint8 Kc[LENGTH_Kc];
};

/* function prototypes */
SWI_API SWI_RCODE SwiSetSimVerify (
    const struct SWI_STRUCT_SIM_Verify* pSim, 
    swi_uint32 timeout);
SWI_API SWI_RCODE SwiSetSimLock (
    const struct SWI_STRUCT_SIM_EnableLock*  pSim, 
    swi_uint32 timeout);
SWI_API SWI_RCODE SwiGetSimLock (
    struct SWI_STRUCT_SIM_LockStatus* pSim, 
    swi_uint32 timeout);
SWI_API SWI_RCODE SwiSetSimPassword (
    const struct SWI_STRUCT_SIM_Password* pSim, 
    swi_uint32 timeout);
SWI_API SWI_RCODE SwiChv2StatusKick(
    enum SWI_TYPE_SIM_Chv2KickType eKickType, 
    swi_uint32 timeout);
extern SWI_API SWI_RCODE SwiSetMEPUnlock (
    const struct SWI_STRUCT_MEP_Unlock* 
    pMEP, swi_uint32 timeout);
extern SWI_API SWI_RCODE SwiGetGsmIMSI(
    swi_charp szMSIN, 
    swi_uint32 sizeBuffer, 
    swi_uint32 *pMCC, 
    swi_uint32 *pMNC, 
    swi_uint32 timeout);
extern SWI_API SWI_RCODE SwiGetIccId(
    struct SWI_STRUCT_IccId *sIccId, 
    swi_uint32 timeout);
extern SWI_API SWI_RCODE SwiGetNetworkProviderID(
    swi_charp szName, 
    swi_uint32 sizeBuffer, 
    swi_uint32 timeout);
extern SWI_API SWI_RCODE SwiSetSimAuthentication(
    struct SWI_STRUCT_SimAuth  *pSimAuth, 
    swi_uint32 timeout);

#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif /* __SWIAPI_GSM_SIM */

/* 
 * $Log: SwiApiGsmSim.h,v $
 */