SwiApiGsmPhonebook.h

Go to the documentation of this file.

#ifndef __SWIAPI_GSM_PHONEBK
#define __SWIAPI_GSM_PHONEBK

#ifdef __cplusplus
extern "C" {
#endif

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

/* object 0x1045 */
#define OBJ_LENGTH_GSM_ENTRY_NAME       60
#define OBJ_LENGTH_GSM_PHONE_NUM        40
#define OBJ_LENGTH_EmergencyPhoneNumber 6

enum SWI_TYPE_Phonebook
{
    SWI_PHONEBK_Adn,    
    SWI_PHONEBK_Fdn,    
    SWI_PHONEBK_Lnd,    
    SWI_PHONEBK_Msisdn, 
    SWI_PHONEBK_Lnm,    
    SWI_PHONEBK_Lnr,    
    SWI_PHONEBK_Sdn,    
    SWI_PHONEBK_Cphsmn 
};

enum SWI_TYPE_PHONEBOOK_Result
{
    SWI_PHONEBOOKRESULT_Success,
    
    SWI_PHONEBOOKRESULT_Ext1NotAvail,
    
    SWI_PHONEBOOKRESULT_TooManyEntries, 
    
    SWI_PHONEBOOKRESULT_CHV2NotValid,
    
    SWI_PHONEBOOKRESULT_NotExist,
    
    SWI_PHONEBOOKRESULT_Failed          
};

struct SWI_STRUCT_PHONEBK_Size
{
    swi_uint32 sizeStruct;
    
    swi_uint32 nADNFreeEntries;
    
    swi_uint32 nADNTotalEntries;
    
    swi_uint32 nFDNFreeEntries;
    
    swi_uint32 nFDNTotalEntries;
    
    swi_uint32 nLNDFreeEntries;
    
    swi_uint32 nLNDTotalEntries;
    
    swi_uint32 nMSISDNFreeEntries;
    
    swi_uint32 nMSISDNTotalEntries;
    
    swi_uint32 nLNMFreeEntries;
    
    swi_uint32 nLNMTotalEntries;
    
    swi_uint32 nLNRFreeEntries;
    
    swi_uint32 nLNRTotalEntries;
    
    swi_uint32 nSDNFreeEntries;
    
    swi_uint32 nSDNTotalEntries;
    
    swi_uint32 nCPHSMNFreeEntries;
    
    swi_uint32 nCPHSMNTotalEntries;        
};

struct SWI_STRUCT_PHONEBK_Entry
{
    swi_uint32 sizeStruct; 
    
    swi_uint32 nID;
    
    enum SWI_TYPE_Phonebook ePhoneBookType;
    
    swi_char szEntryName[LENGTH_EntryName];
    
    swi_uint32 nPhoneNumberLength;
    
    swi_uint8 byPhoneNumber[LENGTH_GSM_PhoneNumber];
    
    swi_bool bValid;    
    
    swi_bool bInternational;
    
    swi_bool bReadFromStart;
    
    swi_bool bMoreEntries;
    
    enum SWI_TYPE_PHONEBOOK_Result eResultCode;                  
};

struct SWI_STRUCT_PHONEBK_DeleteEntry
{
    swi_uint32 sizeStruct; 
    
    enum SWI_TYPE_Phonebook ePhoneBookType;  
    
    swi_uint32 nID;
    
    enum SWI_TYPE_PHONEBOOK_Result eResultCode;          
};

struct SWI_STRUCT_PhonebookReady
{
    swi_uint32 sizeStruct;
    
    swi_bool bReady;              
};

struct SWI_STRUCT_PHONEBK_Available
{
    swi_uint32 sizeStruct;
    
    swi_bool bADN_Available;
    
    swi_bool bFDN_Available;
    
    swi_bool bLND_Available;
    
    swi_bool bMSISDN_Available;
    
    swi_bool bLNM_Available;
    
    swi_bool bLNR_Available;
    
    swi_bool bSDN_Available;
    
    swi_bool bCPHSMN_Available;
};


struct SWI_STRUCT_Emergency_Number
{
    swi_uint32 sizeStruct;

    swi_uint32 nPhoneNumberLength;

    swi_uint8 byPhoneNumber[LENGTH_EmergencyPhoneNumber];  

    swi_bool bMoreEntries;                                  
};

struct SWI_STRUCT_FdnMode
{
    swi_uint32 sizeStruct;
    
    swi_bool bEnabled;
    
    enum SWI_TYPE_PHONEBOOK_Result eResultCode;      
};

/* Phonebook Maintenance prototypes */
extern SWI_API SWI_RCODE SwiGetPhonebookSize(
    struct SWI_STRUCT_PHONEBK_Size*  pPhonebook, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetPhonebookEntryExp(
    struct SWI_STRUCT_PHONEBK_Entry* pPhonebook,
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiAddPhonebookEntryExp(
    struct SWI_STRUCT_PHONEBK_Entry* pPhonebook,
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiEditPhonebookEntryExp(
    struct SWI_STRUCT_PHONEBK_Entry* pPonebook, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiDeletePhonebookEntry(
    struct SWI_STRUCT_PHONEBK_DeleteEntry* pPhonebook, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiDeletePhonebookLastNum(
    const enum SWI_TYPE_Phonebook ePhoneBookType, 
    swi_uint32 timeout);
                    
extern SWI_API SWI_RCODE SwiGetPhonebookAvailable(
    struct SWI_STRUCT_PHONEBK_Available* pPhonebook, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetFdnMode(
    swi_bool* pFdnEnabled,
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetEmergencyEntry(
    struct SWI_STRUCT_Emergency_Number *pEmergencyNumber, 
    swi_bool bFirst, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiSetFdnMode(
    struct SWI_STRUCT_FdnMode *Fdnp,
    swi_uint32 timeout);

#if 0

SWI_API SWI_RCODE SwiSetFdnMode(SWI_STRUCT_FdnMode* pFdn, swi_uint32 timeout);

SWI_API SWI_RCODE SwiChv2StatusKick(SWI_TYPE_SIM_Chv2KickType eKickType, 
                                    U32 timeout);
#endif

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

#endif /* __SWIAPI_GSM_PHONEBK */
/*
 * $Log: SwiApiGsmPhonebook.h,v $
 */