qaGobiApiPds.h

Go to the documentation of this file.

/*
 * Copyright: © 2011-2015 Sierra Wireless, Inc. all rights reserved
 */
#ifndef __GOBI_API_PDS_H__
#define __GOBI_API_PDS_H__

#define DEFAULTBYTEVALUE 0xFF
#define DEFAULTWORDVALUE 0xFFFF
#define DEFAULTLONGVALUE 0xFFFFFFFF

#ifdef __cplusplus
extern "C" {
#endif

ULONG GetPDSState(
    ULONG *pEnabledStatus,
    ULONG *pTrackingStatus );

ULONG SetPDSState(
    ULONG enable );

ULONG StartPDSTrackingSessionExt(
    BYTE  sessionControl,
    BYTE  sessionType,
    BYTE  sessionOperation,
    BYTE  sessionServerOption,
    BYTE  fixTimeout,
    ULONG fixInterval,
    ULONG fixCount,
    ULONG fixAccuracy );

ULONG StopPDSTrackingSession();

ULONG PDSInjectTimeReference(
    ULONGLONG systemTime,
    USHORT    systemDiscontinuities );

ULONG GetPDSDefaults(
    ULONG *pOperation,
    BYTE  *pTimeout,
    ULONG *pInterval,
    ULONG *pAccuracy );

ULONG SetPDSDefaults(
    ULONG operation,
    BYTE  timeout,
    ULONG interval,
    ULONG accuracy );

ULONG GetXTRAAutomaticDownload(
    ULONG  *pbEnabled,
    USHORT *pInterval );

ULONG SetXTRAAutomaticDownload(
    ULONG  bEnabled,
    USHORT interval );

ULONG GetXTRANetwork(
    ULONG *pPreference );

ULONG SetXTRANetwork(
    ULONG preference );

ULONG GetXTRAValidity(
    USHORT *pGPSWeek,
    USHORT *pGPSWeekOffset,
    USHORT *pDuration );

ULONG ForceXTRADownload();

ULONG GetServiceAutomaticTracking(
    ULONG *pbAuto );

enum {
   eSetServiceAutomaticTrackingDisable=0,
   eSetServiceAutomaticTrackingEnable=1
};
ULONG SetServiceAutomaticTracking(
    ULONG bAuto );

ULONG GetPortAutomaticTracking(
    ULONG *pbAuto );

ULONG SetPortAutomaticTracking(
    ULONG bAuto );

ULONG ResetPDSData(
    ULONG *pGPSDataMask,
    ULONG *pCellDataMask );

ULONG SLQSSetAGPSConfig(
    ULONG *pServerAddress,
    ULONG *pServerPort,
    BYTE  *pServerURL,
    BYTE  *pServerURLLength,
    BYTE  *pNetworkMode );

ULONG SLQSPDSInjectAbsoluteTimeReference(
    ULONGLONG timeMsec,
    ULONG     timeUncMsec,
    BYTE      timeBase,
    BYTE      forceFlag );

ULONG SLQSGetAGPSConfig(
    ULONG *pServerAddress,
    ULONG *pServerPort,
    BYTE  *pServerURL,
    BYTE  *pServerURLLength,
    BYTE  *pNetworkMode);

struct PDSPositionData
{
    ULONGLONG *pTimeStamp;
    ULONGLONG *pLatitude;
    ULONGLONG *pLongitude;
    ULONG     *pAltitudeWrtEllipsoid;
    ULONG     *pAltitudeWrtSealevel;
    ULONG     *pHorizontalUncCircular;
    ULONG     *pVerticalUnc;
    BYTE      *pHorizontalConfidence;
    BYTE      *pVerticalConfidence;
    BYTE      *pPositionSource;
    BYTE      *pTimeType;
};

ULONG SLQSPDSInjectPositionData( struct PDSPositionData *pPositionData );

ULONG SLQSPDSDeterminePosition( );

typedef struct
{
    BYTE      EngineState;
    ULONG ValidMask;
    ULONGLONG Latitude;
    ULONGLONG Longitude;
    ULONG HorizontalUncertainty;
    ULONG Altitude;
    ULONG VerticalUncertainty;
    ULONG TimeStmp_tow_ms;
    WORD TimeStmp_gps_week;
    ULONG Time_uncert_ms;
    BYTE Iono_valid;
    ULONG gps_ephemeris_sv_msk;
    ULONG gps_almanac_sv_msk;
    ULONG gps_health_sv_msk;
    ULONG gps_visible_sv_msk;
    ULONG glo_ephemeris_sv_msk;
    ULONG glo_almanac_sv_msk;
    ULONG glo_health_sv_msk;
    ULONG glo_visible_sv_msk;
    ULONG sbas_ephemeris_sv_msk;
    ULONG sbas_almanac_sv_msk;
    ULONG sbas_health_sv_msk;
    ULONG sbas_visible_sv_msk;
    WORD xtra_start_gps_week;
    WORD xtra_start_gps_minutes;
    WORD xtra_valid_duration_hours;
}GPSStateInfo;

ULONG SLQSGetGPSStateInfo( GPSStateInfo *pGPSStateInfo );

typedef struct
{
    BYTE      *pXtraTimeState;
    BYTE      *pXtraDataState ;
    BYTE      *pWifiState;
}PDSPosMethodStateReq;

ULONG SLQSSetPositionMethodState( PDSPosMethodStateReq *pPDSPosMethodStateReq );

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

#endif /* __GOBI_API_PDS_H__ */