SwiApiCmLbs.h

Go to the documentation of this file.

#ifndef __SWIAPI_CM_LBS
#define __SWIAPI_CM_LBS

#ifdef __cplusplus
extern "C" {
#endif

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


#define MAX_NUM_LBS_SV         12 
#define LENGTH_LbsReqId        33 
#define LENGTH_LbsClientName   33 
#define LENGTH_TimeStamp       16 
enum SWI_TYPE_LbsPdEndStatus
{
    SWI_LBSPDENDSTATUS_Offline,
    SWI_LBSPDENDSTATUS_NoService,
    SWI_LBSPDENDSTATUS_NoConnection,
    SWI_LBSPDENDSTATUS_NoData,
    SWI_LBSPDENDSTATUS_SessionBusy,
    SWI_LBSPDENDSTATUS_CdmaLock,
    SWI_LBSPDENDSTATUS_GpsLock,
    SWI_LBSPDENDSTATUS_ConnectionFailed,
    SWI_LBSPDENDSTATUS_ErrorState,
    SWI_LBSPDENDSTATUS_ClientEnded,
    SWI_LBSPDENDSTATUS_UiEnded,
    SWI_LBSPDENDSTATUS_NetworkEnded,
    SWI_LBSPDENDSTATUS_Timeout,
    SWI_LBSPDENDSTATUS_PrivacyLevel,
    SWI_LBSPDENDSTATUS_NetworkAccessError,
    SWI_LBSPDENDSTATUS_FixError,
    SWI_LBSPDENDSTATUS_PdeRejected,
    SWI_LBSPDENDSTATUS_TrafficChannelExited,
    SWI_LBSPDENDSTATUS_E911,
    SWI_LBSPDENDSTATUS_ServerError,
    SWI_LBSPDENDSTATUS_StaleBsInformation
};

enum SWI_TYPE_LbsPdErr
{
    SWI_LBSPDERR_NoError,
    SWI_LBSPDERR_InternalModemError,
    SWI_LBSPDERR_BadServiceType,
    SWI_LBSPDERR_BadSessionType,
    SWI_LBSPDERR_InvalidPrivacy,
    SWI_LBSPDERR_InvalidDataDownload,
    SWI_LBSPDERR_InvalidNetworkAccess,
    SWI_LBSPDERR_InvalidOperationMode,
    SWI_LBSPDERR_InvalidNumberOfFixes,
    SWI_LBSPDERR_InvalidServerInfo,
    SWI_LBSPDERR_InvalidTimeout,
    SWI_LBSPDERR_InvalidQosParameter,
    SWI_LBSPDERR_NoSessionActive,
    SWI_LBSPDERR_SessionAlreadyActive,
    SWI_LBSPDERR_SessionBusy,
    SWI_LBSPDERR_PhoneIsOffline,
    SWI_LBSPDERR_CDMALockError,
    SWI_LBSPDERR_GPSLockError,
    SWI_LBSPDERR_InvalidState,
    SWI_LBSPDERR_ConnectionFailure,
    SWI_LBSPDERR_NoBuffersAvailable,
    SWI_LBSPDERR_SearcherError,
    SWI_LBSPDERR_CannotReportNow,
    SWI_LBSPDERR_ModeNotSupported,
    SWI_LBSPDERR_OtherError,
    SWI_LBSPDERR_FixRateForTrackingTooLarge
};

enum SWI_MASK_LbsPdService
{
    MASK_LbsPdService_Position  = 0x01,
    MASK_LbsPdService_Velocity  = 0x02,
    MASK_LbsPdService_Height    = 0x04
};

enum SWI_TYPE_LbsPdDloadOption
{
    SWI_LBSPDDLOADOPTION_Periodic = 0x01,
    SWI_LBSPDDLOADOPTION_Single
};

enum SWI_TYPE_LbsSession
{
    SWI_LBSSESSION_LocationFix,
    SWI_LBSSESSION_Download
};

enum SWI_MASK_LbsLocNotifyStatus
{
    MASK_LbsPdLocNotifyStatus_Begin         = 0x0001,
    MASK_LbsPdLocNotifyStatus_Data          = 0x0002,
    MASK_LbsPdLocNotifyStatus_End           = 0x0004,
    MASK_LbsPdLocNotifyStatus_Done          = 0x0008,
    MASK_LbsPdLocNotifyStatus_UpdateFailure = 0x0010
};

enum SWI_MASK_LbsDloadNotifyStatus
{
    MASK_LbsPdDloadNotifyStatus_Begin       = 0x0001,
    MASK_LbsPdDloadNotifyStatus_Data        = 0x0002,
    MASK_LbsPdDloadNotifyStatus_End         = 0x0004,
    MASK_LbsPdDloadNotifyStatus_Done        = 0x0008
};

enum SWI_MASK_LbsParamNotifyStatus
{
    MASK_LbsPaParamNotifyStatus_Address     = 0x0001,
    MASK_LbsPaParamNotifyStatus_GpsLock     = 0x0002,
    MASK_LbsPaParamNotifyStatus_PtlmMode    = 0x0004,
    MASK_LbsPaParamNotifyStatus_PortId      = 0x0008,
    MASK_LbsPaParamNotifyStatus_Privacy     = 0x0010,
    MASK_LbsPaParamNotifyStatus_NetAccess   = 0x0020
};

enum SWI_TYPE_LbsNotifyState
{
    SWI_LBSNOTIFYSTATE_Off,
    SWI_LBSNOTIFYSTATE_On
};

typedef struct SWI_STRUCT_LbsLocNotifyStatus
{
    swi_uint32 sizeStruct;    

    enum SWI_TYPE_LbsNotifyState eNotifyFlag;
}SWI_STRUCT_LbsLocNotifyStatus;

typedef struct SWI_STRUCT_LbsDloadNotifyStatus
{
    swi_uint32 sizeStruct;   
    
    enum SWI_TYPE_LbsNotifyState eNotifyFlag;
}SWI_STRUCT_LbsDloadNotifyStatus;

typedef struct SWI_STRUCT_LbsParamNotifyStatus
{
    swi_uint32 sizeStruct;     
    
    enum SWI_TYPE_LbsNotifyState eNotifyFlag;
}SWI_STRUCT_LbsParamNotifyStatus;

typedef struct SWI_STRUCT_LbsPdDownload
{
    swi_uint32 sizeStruct;    
            
    enum SWI_TYPE_LbsPdDloadOption eOption;
            
    swi_uint16 nDuration;
}SWI_STRUCT_LbsPdDownload;

enum SWI_TYPE_LbsFix
{
    SWI_LBSFIX_Autonomous = 1,
    
    SWI_LBSFIX_MsBased,
    
    SWI_LBSFIX_MsAssisted,
    
    SWI_LBSFIX_OptimizedSpeed,
    
    SWI_LBSFIX_OptimizedAccuracy,
    
    SWI_LBSFIX_OptimizedData
};

typedef struct SWI_STRUCT_LbsPdGetPos
{
    swi_uint32 sizeStruct;
    
    enum SWI_TYPE_LbsFix eFixType; 
    
    swi_uint16 nPerformance;
    
    swi_uint32 nAccuracy;
}SWI_STRUCT_LbsPdGetPos;

enum SWI_TYPE_LbsPdStatus
{
    SWI_LBSPDSTATUS_None    = 0, 
    SWI_LBSPDSTATUS_Active    = 1, 
    SWI_LBSPDSTATUS_Success = 2, 
    SWI_LBSPDSTATUS_Error   = 3
};

typedef struct SWI_STRUCT_LbsPdGetStatus
{
    swi_uint32 sizeStruct;
    
    swi_char szLastFixTimeStamp[LENGTH_TimeStamp];
    
    enum SWI_TYPE_LbsPdStatus eLastFixStatus;  
    
    enum SWI_TYPE_LbsPdErr eLastFixError;
    
    swi_char szLastDownloadTimeStamp[LENGTH_TimeStamp];
    
    enum SWI_TYPE_LbsPdStatus eLastDownloadStatus;
    
    enum SWI_TYPE_LbsPdErr eLastDownloadError;
    
    swi_char szLastFixSessionTimeStamp[LENGTH_TimeStamp];  
    
    enum SWI_TYPE_LbsPdStatus eLastFixSessionStatus; 
    
    enum SWI_TYPE_LbsPdErr eLastFixSessionError;
    
    swi_char szLastDownloadSessionTimeStamp[LENGTH_TimeStamp];
    
    enum SWI_TYPE_LbsPdStatus eLastDownloadSessionStatus;
    
    enum SWI_TYPE_LbsPdErr eLastDownloadSessionError;
}SWI_STRUCT_LbsPdGetStatus;

typedef struct SWI_STRUCT_LbsPdTrack
{
    swi_uint32 sizeStruct;
    
    enum SWI_TYPE_LbsFix eFixType;   
    
    swi_uint16 nPerformance;     
    
    swi_uint32 nAccuracy;    
    
    swi_uint16    nFixCount;        
     
    swi_uint32 nFixRate;
}SWI_STRUCT_LbsPdTrack;

typedef struct SWI_STRUCT_LbsPdEndSession
{
    swi_uint32 sizeStruct;    
    
    enum SWI_TYPE_LbsSession eSessionType;
}SWI_STRUCT_LbsPdEndSession;

enum SWI_TYPE_LbsPaGpsLock
{
    SWI_LBSPAGPSLOCK_NoLockActive,
    SWI_LBSPAGPSLOCK_MiSessionsLocked,
    SWI_LBSPAGPSLOCK_MtSessionsLocked,
    SWI_LBSPAGPSLOCK_AllSessionsLocked
};

enum SWI_TYPE_LbsPaTransMech
{
    SWI_LBSPATRANSMECH_TcpIp,
    SWI_LBSPATRANSMECH_DataBurst
};

enum SWI_TYPE_LbsPaPrivacy
{
    SWI_LBSPAPRIVACY_High,
    SWI_LBSPAPRIVACY_Medium,
    SWI_LBSPAPRIVACY_Low
};

enum SWI_TYPE_LbsPaNetAccess
{
    SWI_LBSPANETACCESS_NetworkOnly,
    SWI_LBSPANETACCESS_NoNetworkAccess,
    SWI_LBSPANETACCESS_NetworkWithDemodulation,
    SWI_LBSPANETACCESS_NetworkWithoutDemodulation
};

typedef struct SWI_STRUCT_LbsPaGetParam
{
    swi_uint32 sizeStruct; 
    
    swi_uint32 nIpAddress;
    
    swi_uint32 nPortId;
    
    enum SWI_TYPE_LbsPaGpsLock eGpsLock;
    
    enum SWI_TYPE_LbsPaTransMech eTransportMech;    
    
    enum SWI_TYPE_LbsPaPrivacy ePrivacy;    
    
    enum SWI_TYPE_LbsPaNetAccess eNetworkAccess;
}SWI_STRUCT_LbsPaGetParam;

enum SWI_TYPE_LbsFixDim
{
    SWI_LBSFIXDIM_2D,
    SWI_LBSFIXDIM_3D
};

enum SWI_TYPE_SDPU
{
    SWI_SDPU_0Dot5,
    SWI_SDPU_0Dot75,
    SWI_SDPU_1,
    SWI_SDPU_1Dot5,
    SWI_SDPU_2,
    SWI_SDPU_3,
    SWI_SDPU_4,
    SWI_SDPU_6,
    SWI_SDPU_8,
    SWI_SDPU_12,
    SWI_SDPU_16,
    SWI_SDPU_24,
    SWI_SDPU_32,
    SWI_SDPU_48,
    SWI_SDPU_64,
    SWI_SDPU_96,
    SWI_SDPU_128,
    SWI_SDPU_192,
    SWI_SDPU_256,
    SWI_SDPU_384,
    SWI_SDPU_512,
    SWI_SDPU_768,
    SWI_SDPU_1024,
    SWI_SDPU_1536,
    SWI_SDPU_2048,
    SWI_SDPU_3072,
    SWI_SDPU_4096,
    SWI_SDPU_6144,
    SWI_SDPU_8192,
    SWI_SDPU_12288,
    SWI_SDPU_GreaterThan12288,
    SWI_SDPU_NotComputable
};

typedef struct SWI_STRUCT_LbsPdData
{
    swi_uint32 sizeStruct;
    
    swi_int32 nLatitude;    
    
    swi_int32 nLongitude;   
    
    swi_uint32 nTimeStamp;   
    
    swi_uint16 nLocUncAngle;
        
    enum SWI_TYPE_SDPU eLocUncA;  
    
    enum SWI_TYPE_SDPU eLocUncP;     
    
    enum SWI_TYPE_LbsFixDim eFix;    
    
    swi_uint16 nHeightIncl;    
    
    swi_int16 nHeight;    
    
    enum SWI_TYPE_SDPU eLocUncVe;        
    
    swi_uint16 nVelocityIncl;
    
    swi_uint16 nHeading;    
    
    swi_uint16 nVelHoriz;    
    
    swi_int16 nVelVert;
    
    swi_uint16 nUncertaintyA;    
    
    swi_uint16 nUncertaintyP;    
    
    swi_uint16 nUncertaintyV;    
    
    swi_uint16 nHEPE;            
    
    swi_uint8 nSatelliteNum;    
}SWI_STRUCT_LbsPdData;

typedef struct SWI_STRUCT_LbsPdDone
{
    swi_uint32 sizeStruct;    
}SWI_STRUCT_LbsPdDone;

typedef struct SWI_STRUCT_LbsPdEnd
{
    swi_uint32 sizeStruct;
    
    enum SWI_TYPE_LbsPdEndStatus eEndStatus;
}SWI_STRUCT_LbsPdEnd;

typedef struct SWI_STRUCT_LbsPdBegin
{
    swi_uint32 sizeStruct; 
}SWI_STRUCT_LbsPdBegin;

typedef struct SWI_STRUCT_LbsPdUpdateFailure
{
    swi_uint32 sizeStruct; 
}SWI_STRUCT_LbsPdUpdateFailure;

typedef struct SWI_STRUCT_LbsPdDloadBegin
{
    swi_uint32 sizeStruct; 
}SWI_STRUCT_LbsPdDloadBegin;

enum SWI_TYPE_LbsDloadData
{
    SWI_LBSDLOADDATA_Location,
    SWI_LBSDLOADDATA_AA,
    SWI_LBSDLOADDATA_SA,
    SWI_LBSDLOADDATA_Epemeris,
    SWI_LBSDLOADDATA_Almanac
};

enum SWI_TYPE_LbsDloadSource
{
    SWI_LBSDLOADSOURCE_Mobile,
    SWI_LBSDLOADSOURCE_Pde
};

typedef struct SWI_STRUCT_LbsPdDloadData
{
    swi_uint32 sizeStruct;         
    swi_uint16 nValidEntryPairNum; 
    enum SWI_TYPE_LbsDloadData eDataType1; 
    enum SWI_TYPE_LbsDloadSource eSource1; 
    enum SWI_TYPE_LbsDloadData eDataType2; 
    enum SWI_TYPE_LbsDloadSource eSource2; 
    enum SWI_TYPE_LbsDloadData eDataType3; 
    enum SWI_TYPE_LbsDloadSource eSource3; 
    enum SWI_TYPE_LbsDloadData eDataType4; 
    enum SWI_TYPE_LbsDloadSource eSource4; 
    enum SWI_TYPE_LbsDloadData eDataType5; 
    enum SWI_TYPE_LbsDloadSource eSource5; 
}SWI_STRUCT_LbsPdDloadData;

typedef struct SWI_STRUCT_LbsPdDloadDone
{
    swi_uint32 sizeStruct; 
}SWI_STRUCT_LbsPdDloadDone;

typedef struct SWI_STRUCT_LbsPdDloadEnd
{
    swi_uint32 sizeStruct;       
    enum SWI_TYPE_LbsPdEndStatus eEndStatus; 
}SWI_STRUCT_LbsPdDloadEnd;

typedef struct SWI_STRUCT_LbsPaIpAddr
{
    swi_uint32 sizeStruct;
    
    swi_uint32 nIpAddress;
}SWI_STRUCT_LbsPaIpAddr;

typedef struct SWI_STRUCT_LbsPaGpsLock
{
    swi_uint32 sizeStruct;
    
    enum SWI_TYPE_LbsPaGpsLock eGpsLock;
}SWI_STRUCT_LbsPaGpsLock;

typedef struct SWI_STRUCT_LbsPaPtlmMode
{
    swi_uint32 sizeStruct;
    
    enum SWI_TYPE_LbsPaTransMech eTransportMech;
}SWI_STRUCT_LbsPaPtlmMode;

typedef struct SWI_STRUCT_LbsPaPortId
{
    swi_uint32 sizeStruct; 
    
    swi_uint32 nPortId;
}SWI_STRUCT_LbsPaPortId;

typedef struct SWI_STRUCT_LbsPaPrivacy
{
    swi_uint32 sizeStruct; 
    
    enum SWI_TYPE_LbsPaPrivacy ePrivacy;
}SWI_STRUCT_LbsPaPrivacy;

typedef struct SWI_STRUCT_LbsPaNetAccess
{
    swi_uint32 sizeStruct; 
    
    enum SWI_TYPE_LbsPaNetAccess eNetAccess;
}SWI_STRUCT_LbsPaNetAccess;

typedef struct SWI_STRUCT_LbsPaBsInfo
{
    swi_uint32 sizeStruct;

    swi_bool bInfoStale;
   
    swi_uint32 nId;

    swi_uint32 nSid;
  
    swi_uint32 nNid;

    swi_uint32 nInfoTimeHigh;

    swi_uint32 nInfoTimeLow;

    swi_int32 nLatitude;

    swi_int32 nLongitude;
}SWI_STRUCT_LbsPaBsInfo;
typedef struct SWI_STRUCT_SatView
{
    swi_uint8 nSvNumber;
    swi_uint8 nSvElevation; 
    swi_uint16 nSvAzimuth;  
    swi_uint8 nSvSnr;       
} SWI_STRUCT_SatView;

typedef struct SWI_STRUCT_LbsSatInfo
{
    swi_uint32 sizeStruct; 
    
    swi_uint8 nSvInView;

    struct SWI_STRUCT_SatView sSatView[MAX_NUM_LBS_SV];
}SWI_STRUCT_LbsSatInfo;

typedef struct SWI_STRUCT_LbsClearAssistance
{
    swi_uint32 sizeStruct; 
    
    swi_bool bClrEphemerisData; 
    
    swi_bool bClrAlmanacData;
    
    swi_bool bClrPosData;
    
    swi_bool bClrSelfLearnDb;
    
    swi_bool bClrServSysDb;    
    
   swi_bool bClrTimeRef;        
    
   swi_bool bResetThrottleParams; 
}SWI_STRUCT_LbsClearAssistance;

/* prototypes */
SWI_API SWI_RCODE SwiSetLbsPdGetPos(
                  const struct SWI_STRUCT_LbsPdGetPos *psLbsPdGetPos, 
                  swi_uint32 timeout);

SWI_API SWI_RCODE SwiGetLbsPdStatus(
                  struct SWI_STRUCT_LbsPdGetStatus *psLbsPdGetStatus, 
                  swi_uint32 timeout);

SWI_API SWI_RCODE SwiSetLbsPdTrack(
                  const struct SWI_STRUCT_LbsPdTrack *psLbsPdTrack, 
                  swi_uint32 timeout);

SWI_API SWI_RCODE SwiSetLbsPdEndSession(
                  const struct SWI_STRUCT_LbsPdEndSession *psLbsPdEndSession, 
                  swi_uint32 timeout);

SWI_API SWI_RCODE SwiGetLbsPaParam(
                  struct SWI_STRUCT_LbsPaGetParam *psLbsPdGetParam, 
                  swi_uint32 timeout);

SWI_API SWI_RCODE SwiGetLbsPdData(
                  struct SWI_STRUCT_LbsPdData *psLbsPdData, 
                  swi_uint32 timeout);

SWI_API SWI_RCODE SwiGetLbsPaIpAddr(
                  struct SWI_STRUCT_LbsPaIpAddr *psPaIpAddr,
                  swi_uint32 timeout);

SWI_API SWI_RCODE SwiSetLbsPaIpAddr(
                  const struct SWI_STRUCT_LbsPaIpAddr *psPaIpAddr, 
                  swi_uint32 timeout);

SWI_API SWI_RCODE SwiGetLbsPaPortId(
                  struct SWI_STRUCT_LbsPaPortId *psPaPortId, 
                  swi_uint32 timeout);

SWI_API SWI_RCODE SwiSetLbsPaPortId(
                  const struct SWI_STRUCT_LbsPaPortId *psPAPortID, 
                  swi_uint32 timeout);

SWI_API SWI_RCODE SwiGetLbsSatInfo(
                  struct SWI_STRUCT_LbsSatInfo *psSatInfo, 
                  swi_uint32 timeout);

SWI_API SWI_RCODE SwiSetLbsClearAssistance(
             const struct SWI_STRUCT_LbsClearAssistance *psLbsClearAssistance, 
             swi_uint32 timeout);

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

#endif /* __SWIAPI_CM_LBS */
/* 
 * $Log: SwiApiCmLbs.h,v $
 */