SwiApiGsmBasic.h

Go to the documentation of this file.

#ifndef __SWIAPI_GSM_BASIC
#define __SWIAPI_GSM_BASIC

#ifdef __cplusplus
extern "C" {
#endif

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

/* defines */

#define MAX_NO_CONTEXT              3
#define MAX_3G_GSM_PROFILES         16
#define NUMBER_PLMN                 14
#define NUMBER_Band                 5
#define LENGTH_IPAddress            16
#define LENGTH_AccessPointName      101
#define LENGTH_UserName             128
#define LENGTH_Label                31
#define LENGTH_Password             128
#define LENGTH_AddressNumber        20
#define LENGTH_SME                  20
#define LENGTH_SMSTimestamp         14
#define LENGTH_SMSValidityPeriod    16
#define LENGTH_MaxCHV               9
#define LENGTH_MaxPhone             20
#define LENGTH_CallerName           82
#define MAX_CALLS                   7
#define LENGTH_MaxDebugString       201
#define LENGTH_DcsMsgInd            3
#define LENGTH_Timestamp            14
#define LENGTH_Validity             16
#define LENGTH_MAX_Sms              1024
#define LENGTH_MAX_SmsMsgData       161
#define LENGTH_MsgWaiting           3
#define LENGTH_EntryName            (31 * UTF8_MAX_CHAR_SIZE) + 1
#define LENGTH_GSM_PhoneNumber      40
#define LENGTH_EmergencyPhoneNumber 6
#define LENGTH_ForwardNumber        38
#define LENGTH_ForwardInfo          18
#define LENGTH_SSPassword           4
#define VERSION_SuppService         0x0001
#define MAX_FWD_INFO_ENTRIES        8
#define MAX_CALL_BARR_ENTRIES       8
#define MAX_INFO_DATA               70
#define MAX_BS_LIST                 70
#define LENGTH_RawData              229
#define LENGTH_SSString             40
#define LENGTH_STKCommand           119
#define LENGTH_STKCommand_utf8      (119 * UTF8_MAX_CHAR_SIZE) + 1
#define LENGTH_STKRespInput         120
#define LENGTH_STKRespInput_utf8    (120 * UTF8_MAX_CHAR_SIZE) + 1
#define LENGTH_SSString             40
#define LENGTH_SetFeaturesKey       21
#define LENGTH_RandNum              16
#define LENGTH_Kc                   8
#define LENGTH_USSDInput            100
#define LENGTH_CommandData          157

#define LENGTH_ErrorString          33
#define LENGTH_IccId                10
#define LENGTH_Imei                 16 
#define LENGTH_Tac                  7
#define LENGTH_Fac                  3
#define LENGTH_Snr                  7
#define LENGTH_ChkByte              2
#define LENGTH_Fsn                  16
#define LENGTH_Signature            9


/* enum declarations */
enum SWI_TYPE_Band
{
    SWI_BAND_None,                  
    SWI_BAND_PGSM,                  
    SWI_BAND_EGSM,                  
    SWI_BAND_DCS,                   
    SWI_BAND_PGSM_DCS,              
    SWI_BAND_EGSM_DCS,              
    SWI_BAND_PCS,                   
    SWI_BAND_PGSM_PCS,              
    SWI_BAND_EGSM_PCS,              
    SWI_BAND_GSM850,                
    SWI_BAND_GSM850_PCS,            
    SWI_BAND_GSM_ALL,               
    SWI_BAND_WCDMA_EU,              
    SWI_BAND_WCDMA_NA,              
    SWI_BAND_WCDMA_GSM_NA,          
    SWI_BAND_WCDMA_GSM_EU,          
    SWI_BAND_WCDMA_ALL = 0x0010,    
    SWI_BAND_WCDMA_AU,              
    SWI_BAND_WCDMA_JAP,             
    SWI_BAND_WCDMA_GSM_AU,          
    SWI_BAND_WCDMA_GSM_AU_2,        
    SWI_BAND_WCDMA_GSM_AU_3,        
    SWI_BAND_AUTO = 0xffff         
};


enum SWI_TYPE_PDP
{
    SWI_PDP_IP,               
    SWI_PDP_PPP,              
    SWI_PDP_IPV6              
};


/* structure declarations */
struct SWI_STRUCT_AvailFeatures
{
    swi_uint32           sizeStruct;
    swi_bool             bVoice;
    swi_bool             bTriBand;
    enum SWI_TYPE_PDP    pdpType;
};

struct SWI_STRUCT_Band 
{
    swi_uint32              sizeStruct;             
    swi_uint32              cntValidBands;          
    enum SWI_TYPE_Band      eBandType;              
    enum SWI_TYPE_Band      arrBand[NUMBER_Band];   
    swi_bool                bChangeSuccess;         
};



struct CNS_BAND_PAYLOAD {
    swi_uint16 CurBand;        
    swi_uint16 cntValidBands;  
    swi_uint16 Band[5];        

};

struct SWI_STRUCT_Fsn
{
    swi_uint32     sizeStruct;
    swi_char  szFsn[LENGTH_Fsn];
};

struct SWI_STRUCT_Thb
{
    swi_uint32  sizeStruct;           
    swi_bool    bInitialTest;   
    swi_bool    bRFScreen;     
    swi_bool    bCalibration;   
    swi_bool    bSystem;        
};

struct SWI_STRUCT_ModemDisabled
{
    swi_uint32  sizeStruct;        
    swi_bool    bModemDisabled;    
};

struct SWI_STRUCT_Imei
{
    swi_uint32 sizeStruct;     
    
    swi_char szImei[LENGTH_Imei]; 
    
    swi_char szTac[LENGTH_Tac];
    
    swi_char szFac[LENGTH_Fac];
    
    swi_char szSnr[LENGTH_Snr];
    
    swi_char szCheckByte[LENGTH_ChkByte];
};

struct SWI_STRUCT_FeatureCustomizations
{
    swi_uint32    sizeStruct;
    swi_uint32    nVersion;
    swi_bool      bAutoConnect;
    swi_bool      bAdvanceProfile;
    swi_bool      bDisplayDun;
    swi_bool      bHideByteCounters;
    swi_bool      bAllowCsd;
    swi_bool      bHSDPASupport;
    swi_bool      bScanProfile;
    swi_bool      bBluetooth;
    swi_bool      bGps;
};

/* function prototypes */
extern SWI_API SWI_RCODE SwiGetImei(struct SWI_STRUCT_Imei *pImei, 
                                    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetBandInfo(struct SWI_STRUCT_Band *sBandInfo, 
                                        swi_uint32 sizeBuffer, 
                                        swi_uint32 timeout);
                                        
extern SWI_API SWI_RCODE SwiGetAvailableFeatures(struct SWI_STRUCT_AvailFeatures * sFeatures,
                                                swi_uint32 sizeBuffer, 
                                                swi_uint32 timeout);
                                         
extern SWI_API SWI_RCODE SwiGetSerialNumber(struct SWI_STRUCT_Fsn *sFsnp, 
                                            swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetTestHistoryByte (struct SWI_STRUCT_Thb *Thbp, swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetModemDisable(swi_bool* pModemDisable, 
                                            swi_uint32 timeout);
                                            
extern SWI_API SWI_RCODE SwiSetModemDisable(const swi_bool bModemDisable, 
                                            swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiGetFeatureCustomizations(struct SWI_STRUCT_FeatureCustomizations* sCustomizationsp, 
                                                     swi_uint32 timeout);
                                                     
extern SWI_API SWI_RCODE SwiStopAllNotif(swi_uint32 timeout);

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

#endif /* __SWIAPI_GSM_BASIC */

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