qaGobiApiWds.h

Go to the documentation of this file.

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

#ifdef __cplusplus
extern "C" {
#endif

#define IPV6_ADDRESS_ARRAY_SIZE 8

ULONG SetMobileIP( ULONG mode );

ULONG GetMobileIP( ULONG *pMode );

ULONG SetMobileIPParameters(
    CHAR  *pSPC,
    ULONG *pMode,
    BYTE  *pRetryLimit,
    BYTE  *pRetryInterval,
    BYTE  *pReRegPeriod,
    BYTE  *pReRegTraffic,
    BYTE  *pHAAuthenticator,
    BYTE  *pHA2002bis );

ULONG SetAutoconnect( ULONG setting );

ULONG GetAutoconnect( ULONG *pSetting );

ULONG  SetDefaultProfile(
    ULONG   profileType,
    ULONG   *pPDPType,
    ULONG   *pIPAddress,
    ULONG   *pPrimaryDNS,
    ULONG   *pSecondaryDNS,
    ULONG   *pAuthentication,
    CHAR    *pName,
    CHAR    *pAPNName,
    CHAR    *pUsername,
    CHAR    *pPassword );
ULONG SetDefaultProfileLTE(
    ULONG   profileType,
    ULONG   *pPDPType,
    ULONG   *pIPAddressv4,
    ULONG   *pPrimaryDNSv4,
    ULONG   *pSecondaryDNSv4,
    USHORT  *pIPAddressv6,
    USHORT  *PrimaryDNSv6,
    USHORT  *pSecondaryDNSv6,
    ULONG   *pAuthentication,
    CHAR    *pName,
    CHAR    *pAPNName,
    CHAR    *pUsername,
    CHAR    *pPassword);

ULONG SetDefaultProfileLTEV2(
    ULONG   profileType,
    ULONG   *pPDPType,
    ULONG   *pIPAddressv4,
    ULONG   *pPrimaryDNSv4,
    ULONG   *pSecondaryDNSv4,
    USHORT  *pIPAddressv6,
    USHORT  *PrimaryDNSv6,
    USHORT  *pSecondaryDNSv6,
    ULONG   *pAuthentication,
    CHAR    *pName,
    CHAR    *pAPNName,
    CHAR    *pUsername,
    CHAR    *pPassword);
ULONG GetDefaultProfile(
    ULONG profileType,
    ULONG *pPDPType,
    ULONG *pIPAddress,
    ULONG *pPrimaryDNS,
    ULONG *pSecondaryDNS,
    ULONG *pAuthentication,
    BYTE  nameSize,
    CHAR  *pName,
    BYTE  apnSize,
    CHAR  *pAPNName,
    BYTE  userSize,
    CHAR  *pUsername );

ULONG GetDefaultProfileLTE(
    ULONG  profileType,
    ULONG  *pPDPType,
    ULONG  *pIPAddressv4,
    ULONG  *pPrimaryDNSv4,
    ULONG  *pSecondaryDNSv4,
    USHORT *pIPAddressv6,
    USHORT *pPrimaryDNSv6,
    USHORT *pSecondaryDNSv6,
    ULONG  *pAuthentication,
    BYTE   nameSize,
    CHAR   *pName,
    BYTE   apnSize,
    CHAR   *pAPNName,
    BYTE   userSize,
    CHAR   *pUsername );

ULONG GetSessionState(
    ULONG    *pState,
    BYTE     instance );

ULONG GetPacketStatus(
    ULONG    *pTXPacketSuccesses,
    ULONG    *pRXPacketSuccesses,
    ULONG    *pTXPacketErrors,
    ULONG    *pRXPacketErrors,
    ULONG    *pTXPacketOverflows,
    ULONG    *pRXPacketOverflows,
    BYTE     instance );

ULONG GetByteTotals(
    ULONGLONG *pTXTotalBytes,
    ULONGLONG *pRXTotalBytes,
    BYTE      instance );

ULONG GetDormancyState(
    ULONG    *pDormancyState,
    BYTE     instance );

ULONG GetDataBearerTechnology(
    ULONG    *pDataBearer,
    BYTE     instance );

typedef struct dataBearerTechnology
{
    BYTE  currentNetwork;
    ULONG ratMask;
    ULONG soMask;
} QmiWDSDataBearerTechnology;

enum qmiDataBearerMasks
{
    QMI_WDS_CURRENT_CALL_DB_MASK = 0x01,
    QMI_WDS_LAST_CALL_DB_MASK    = 0x02
};

typedef struct dataBearers
{
    BYTE dataBearerMask;
    QmiWDSDataBearerTechnology *pCurDataBearerTechnology;
    QmiWDSDataBearerTechnology *pLastCallDataBearerTechnology;
} QmiWDSDataBearers;

ULONG SLQSGetDataBearerTechnology(
    QmiWDSDataBearers *pDataBearers,
    BYTE              instance );

ULONG GetSessionDuration(
    ULONGLONG    *pDuration,
    BYTE         instance );

typedef struct{
    ULONG *pIPAddressV4;
    USHORT *pIPAddressV6;
    BYTE  *pIPv6prefixlen;
}QmiWdsIpAddressInfo;


typedef struct{
    ULONG *pv4sessionId;
    ULONG *pv6sessionId;
    QmiWdsIpAddressInfo ip;
}WdsIpAddressInfoReq;

ULONG GetIPAddressLTE( WdsIpAddressInfoReq *);

ULONG GetConnectionRate(
    ULONG *pCurrentChannelTXRate,
    ULONG *pCurrentChannelRXRate,
    ULONG *pMaxChannelTXRate,
    ULONG *pMaxChannelRXRate,
    BYTE  instance );

ULONG GetMobileIPProfile(
   BYTE  index,
   BYTE  *pEnabled,
   ULONG *pAddress,
   ULONG *pPrimaryHA,
   ULONG *pSecondaryHA,
   BYTE  *pRevTunneling,
   BYTE  naiSize,
   CHAR  *pNAI,
   ULONG *pHASPI,
   ULONG *pAAASPI,
   ULONG *pHAState,
   ULONG *pAAAState );

ULONG GetLastMobileIPError( ULONG *pError );

/*
 *  This API used internally for Setting IP Family Preference
 *
 *  \param  IPFamilyPreference[IN]
 *          - IP Family preference
 *
 *  \param  instance[IN]
 *          - PDP instance
 *
 *  \return eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
 *
 *  \sa     See qmerrno.h for eQCWWAN_xxx error values
 *
 */
ULONG iSLQSMISetIPFamilyPreference(
    BYTE IPFamilyPreference,
    BYTE instance );

/*
 *  This API used internally for checking if a device is a Gobi device
 *
 *  \return eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
 *
 *  \sa     See qmerrno.h for eQCWWAN_xxx error values
 *
 */
BOOL WDS_IsGobiDevice( );

ULONG SetActiveMobileIPProfile(
    CHAR *pSPC,
    BYTE index );

ULONG SetMobileIPProfile(
    CHAR  *pSPC,
    BYTE  index,
    BYTE  *pEnabled,
    ULONG *pAddress,
    ULONG *pPrimaryHA,
    ULONG *pSecondaryHA,
    BYTE  *pRevTunneling,
    CHAR  *pNAI,
    ULONG *pHASPI,
    ULONG *pAAASPI,
    CHAR  *pMNHA,
    CHAR  *pMNAAA );

struct UMTSQoS
{
    BYTE  trafficClass;
    ULONG maxUplinkBitrate;
    ULONG maxDownlinkBitrate;
    ULONG grntUplinkBitrate;
    ULONG grntDownlinkBitrate;
    BYTE  qosDeliveryOrder;
    ULONG maxSDUSize;
    BYTE  sduErrorRatio;
    BYTE  resBerRatio;
    BYTE  deliveryErrSDU;
    ULONG transferDelay;
    ULONG trafficPriority;
};

struct ProfileIdentifier
{
    BYTE profileType;
    BYTE profileIndex;
};

struct GPRSQoS
{
    ULONG precedenceClass;
    ULONG delayClass;
    ULONG reliabilityClass;
    ULONG peakThroughputClass;
    ULONG meanThroughputClass;
};

struct PCSCFIPv4ServerAddressList
{
    BYTE  numInstances;
    ULONG pscsfIPv4Addr[64];
};

struct PCSCFFQDNAddress
{
    WORD fqdnLen;
    CHAR fqdnAddr[256];
};

struct PCSCFFQDNAddressList
{
    BYTE                    numInstances;
    struct PCSCFFQDNAddress pcsfFQDNAddress[10];
};

struct Domain
{
    WORD domainLen;
    CHAR domainName[256];
};

struct DomainNameList
{
    BYTE          numInstances;
    struct Domain domain[10];
};

struct IPV6AddressInfo
{
    BYTE   IPV6PrefixLen;
    USHORT IPAddressV6[IPV6_ADDRESS_ARRAY_SIZE];
};

struct IPV6GWAddressInfo
{
    BYTE   gwV6PrefixLen;
    USHORT gwAddressV6[8];
};

struct qmiWdsRunTimeSettings
{
    CHAR                              *pProfileName;
    ULONG                             *pPDPType;
    CHAR                              *pAPNName;
    ULONG                             *pPrimaryDNSV4;
    ULONG                             *pSecondaryDNSV4;
    struct UMTSQoS                    *pUMTSGrantedQoS;
    struct GPRSQoS                    *pGPRSGrantedQoS;
    CHAR                              *pUsername;
    ULONG                             *pAuthentication;
    ULONG                             *pIPAddressV4;
    struct ProfileIdentifier          *pProfileID;
    ULONG                             *pGWAddressV4;
    ULONG                             *pSubnetMaskV4;
    BYTE                              *pPCSCFAddrPCO;
    struct PCSCFIPv4ServerAddressList *pServerAddrList;
    struct PCSCFFQDNAddressList       *pPCSCFFQDNAddrList;
    USHORT                            *pPrimaryDNSV6;
    USHORT                            *pSecondaryDNSV6;
    ULONG                             *pMtu;
    struct DomainNameList             *pDomainList;
    BYTE                              *pIPFamilyPreference;
    BYTE                              *pIMCNflag;
    WORD                              *pTechnology;
    struct IPV6AddressInfo            *pIPV6AddrInfo;
    struct IPV6GWAddressInfo          *pIPV6GWAddrInfo;
};

struct WdsRunTimeSettings
{
    ULONG  *v4sessionId;
    ULONG  *v6sessionId;
    struct qmiWdsRunTimeSettings rts;
};

ULONG SLQSGetRuntimeSettings (
    struct WdsRunTimeSettings *pRunTimeSettings );

ULONG SLQSSetProfile(
    ULONG   profileType,
    BYTE    profileId,
    ULONG   *pPDPType,
    ULONG   *pIPAddress,
    ULONG   *pPrimaryDNS,
    ULONG   *pSecondaryDNS,
    ULONG   *pAuthentication,
    CHAR    *pName,
    CHAR    *pAPNName,
    CHAR    *pUsername,
    CHAR    *pPassword );

ULONG SLQSGetProfile(
    ULONG profileType,
    BYTE  profileId,
    ULONG *pPDPType,
    ULONG *pIPAddress,
    ULONG *pPrimaryDNS,
    ULONG *pSecondaryDNS,
    ULONG *pAuthentication,
    BYTE  nameSize,
    CHAR  *pName,
    BYTE  apnSize,
    CHAR  *pAPNName,
    BYTE  userSize,
    CHAR  *pUsername,
    WORD  *pExtendedErrorCode );

struct ssdatasession_params{
    BOOL  action;
    BYTE  instanceId;
    ULONG *pTechnology;
    ULONG *pProfileId3GPP;
    ULONG *pProfileId3GPP2;
    ULONG sessionId;
    ULONG failureReason;
    ULONG failureReasonv4;
    ULONG failureReasonv6;
    ULONG rcv4;
    ULONG rcv6;
    ULONG v4sessionId;
    ULONG v6sessionId;
    BYTE  ipfamily;
    ULONG *pAuthentication;
    CHAR  *pUsername;
    CHAR  *pPassword;
    ULONG verbFailReasonType;
    ULONG verbFailReason;
};

ULONG SLQSStartStopDataSession(
    struct ssdatasession_params *pin );

struct SLQSDeleteProfileParams{
    BYTE profileType;
    BYTE profileIndex;
};

ULONG SLQSDeleteProfile(
    struct SLQSDeleteProfileParams *pProfileToDelete,
    WORD                           *pExtendedErrorCode );

struct Profile3GPP
{
    CHAR                    *pProfilename;
    WORD                    *pProfilenameSize;
    BYTE                    *pPDPtype;
    BYTE                    *pPdpHdrCompType;
    BYTE                    *pPdpDataCompType;
    CHAR                    *pAPNName;
    WORD                    *pAPNnameSize;
    ULONG                   *pPriDNSIPv4AddPref;
    ULONG                   *pSecDNSIPv4AddPref;
    struct UMTSQoS          *pUMTSReqQoS;
    struct UMTSQoS          *pUMTSMinQoS;
    struct GPRSRequestedQoS *pGPRSRequestedQos;
    struct GPRSRequestedQoS *pGPRSMinimumQoS;
    CHAR                    *pUsername;
    WORD                    *pUsernameSize;
    CHAR                    *pPassword;
    WORD                    *pPasswordSize;
    BYTE                    *pAuthenticationPref;
    ULONG                   *pIPv4AddrPref;
    BYTE                    *pPcscfAddrUsingPCO;
    BYTE                    *pPdpAccessConFlag;
    BYTE                    *pPcscfAddrUsingDhcp;
    BYTE                    *pImCnFlag;
    struct TFTIDParams      *pTFTID1Params;
    struct TFTIDParams      *pTFTID2Params;
    BYTE                    *pPdpContext;
    BYTE                    *pSecondaryFlag;
    BYTE                    *pPrimaryID;
    USHORT                  *pIPv6AddPref;
    struct UMTSReqQoSSigInd *pUMTSReqQoSSigInd;
    struct UMTSReqQoSSigInd *pUMTSMinQosSigInd;
    USHORT                  *pPriDNSIPv6addpref;
    USHORT                  *pSecDNSIPv6addpref;
    BYTE                    *pAddrAllocPref;
    struct QosClassID       *pQosClassID;
    BYTE                    *pAPNDisabledFlag;
    ULONG                   *pPDNInactivTimeout;
    BYTE                    *pAPNClass;
};
struct Profile3GPP2
{
    BYTE   *pNegoDnsSrvrPref;
    ULONG  *pPppSessCloseTimerDO;
    ULONG  *pPppSessCloseTimer1x;
    BYTE   *pAllowLinger;
    USHORT *pLcpAckTimeout;
    USHORT *pIpcpAckTimeout;
    USHORT *pAuthTimeout;
    BYTE   *pLcpCreqRetryCount;
    BYTE   *pIpcpCreqRetryCount;
    BYTE   *pAuthRetryCount;
    BYTE   *pAuthProtocol;
    CHAR   *pUserId;
    WORD   *pUserIdSize;
    CHAR   *pAuthPassword;
    WORD   *pAuthPasswordSize;
    BYTE   *pDataRate;
    ULONG  *pAppType;
    BYTE   *pDataMode;
    BYTE   *pAppPriority;
    CHAR   *pApnString;
    WORD   *pApnStringSize;
    BYTE   *pPdnType;
    BYTE   *pIsPcscfAddressNedded;
    ULONG  *pPrimaryV4DnsAddress;
    ULONG  *pSecondaryV4DnsAddress;
    USHORT *pPriV6DnsAddress;
    USHORT *pSecV6DnsAddress;
    BYTE   *pRATType;
    BYTE   *pAPNEnabled3GPP2;
    ULONG  *pPDNInactivTimeout3GPP2;
    BYTE   *pAPNClass3GPP2;
};

typedef union WdsProfileParam
{
    struct Profile3GPP  SlqsProfile3GPP;
    struct Profile3GPP2 SlqsProfile3GPP2;
}QmiProfileInfo;

struct CreateProfileIn
{
    BYTE           *pProfileID;
    BYTE           *pProfileType;
    QmiProfileInfo curProfile;
};

struct UMTSMinQoS
{
    BYTE  trafficClass;
    ULONG maxUplinkBitrate;
    ULONG maxDownlinkBitrate;
    ULONG grntUplinkBitrate;
    ULONG grntDownlinkBitrate;
    BYTE  qosDeliveryOrder;
    ULONG maxSDUSize;
    BYTE  sduErrorRatio;
    BYTE  resBerRatio;
    BYTE  deliveryErrSDU;
    ULONG transferDelay;
    ULONG trafficPriority;
};

struct GPRSRequestedQoS
{
    ULONG precedenceClass;
    ULONG delayClass;
    ULONG reliabilityClass;
    ULONG peakThroughputClass;
    ULONG meanThroughputClass;
};

struct TFTIDParams
{
    BYTE  filterId;
    BYTE  eValid;
    BYTE  ipVersion;
    WORD  *pSourceIP;
    BYTE  sourceIPMask;
    BYTE  nextHeader;
    WORD  destPortRangeStart;
    WORD  destPortRangeEnd;
    WORD  srcPortRangeStart;
    WORD  srcPortRangeEnd;
    ULONG IPSECSPI;
    WORD  tosMask;
    ULONG flowLabel;
};

struct  UMTSReqQoSSigInd
{
    struct UMTSQoS UMTSReqQoS;
    BYTE           SigInd;
};

struct QosClassID
{
    BYTE QCI;
    ULONG gDlBitRate;
    ULONG maxDlBitRate;
    ULONG gUlBitRate;
    ULONG maxUlBitRate;
};

struct CreateProfileOut
{
    BYTE   *pProfileType;
    BYTE   *pProfileIndex;
    USHORT *pExtErrorCode;
};

ULONG SLQSCreateProfile(
    struct CreateProfileIn  *pReq,
    struct CreateProfileOut *pResp );

struct slqsautoconnect{
    BOOL action;
    BYTE acsetting;
    BYTE acroamsetting;
};

ULONG SLQSAutoConnect( struct slqsautoconnect *pacreq );

struct ModifyProfileIn
{
    BYTE           *pProfileID;
    BYTE           *pProfileType;
    QmiProfileInfo curProfile;
};

struct ModifyProfileOut
{
    USHORT *pExtErrorCode;
};

ULONG SLQSModifyProfile(
    struct ModifyProfileIn  *pReq,
    struct ModifyProfileOut *pResp );

typedef struct _slqs3GPPConfigItem
{
    WORD *pLTEAttachProfile;
    WORD *pProfileList;
    BYTE *pDefaultPDNEnabled;
    BYTE *p3gppRelease;
    WORD LTEAttachProfileListLen;
    WORD *pLTEAttachProfileList;
} slqs3GPPConfigItem;

ULONG SLQSSet3GPPConfigItem( slqs3GPPConfigItem *pSLQS3GPPConfigItem );

ULONG SLQSGet3GPPConfigItem( slqs3GPPConfigItem *pSLQS3GPPConfigItem );

typedef struct _GetProfileSettingIn
{
    BYTE ProfileType;
    BYTE ProfileID;
}GetProfileSettingIn;

typedef struct _GetProfileSettingOut
{
    QmiProfileInfo curProfile;
    WORD           *pExtErrCode;
}GetProfileSettingOut;

ULONG SLQSGetProfileSettings(
    GetProfileSettingIn  *pReq,
    GetProfileSettingOut *pResp );

typedef struct
{
    BYTE  statsPeriod;
    ULONG statsMask;
} TrStatInd;

typedef struct
{
    BYTE      *pCurrChannelRateInd;
    TrStatInd *pTransferStatInd;
    BYTE      *pDataBearerTechInd;
    BYTE      *pDormancyStatusInd;
    BYTE      *pMIPStatusInd;
    BYTE      *pCurrDataBearerTechInd;
    BYTE      *pDataCallStatusChangeInd;
    BYTE      *pCurrPrefDataSysInd;
    BYTE      *pEVDOPageMonPerChangeInd;
    BYTE      *pDataSystemStatusChangeInd;
} wdsSetEventReportReq;

ULONG SLQSWdsSetEventReport( wdsSetEventReportReq *pSetEventReportReq );

typedef struct
{
    BYTE  contextId;
    BYTE  contextType;
} swiPDPRuntimeSettingsReq;

typedef struct
{
    BYTE                   *pContextId;
    BYTE                   *pBearerId;
    CHAR                   *pAPNName;
    ULONG                  *pIPv4Address;
    ULONG                  *pIPv4GWAddress;
    ULONG                  *pPrDNSIPv4Address;
    ULONG                  *pSeDNSIPv4Address;
    struct IPV6AddressInfo *pIPv6Address;
    struct IPV6AddressInfo *pIPv6GWAddress;
    WORD                   *pPrDNSIPv6Address;
    WORD                   *pSeDNSIPv6Address;
    ULONG                  *pPrPCSCFIPv4Address;
    ULONG                  *pSePCSCFIPv4Address;
    WORD                   *pPrPCSCFIPv6Address;
    WORD                   *pSePCSCFIPv6Address;
} swiPDPRuntimeSettingsResp;

ULONG SLQSWdsSwiPDPRuntimeSettings(
    swiPDPRuntimeSettingsReq  *pPDPRuntimeSettingsReq,
    swiPDPRuntimeSettingsResp *pPDPRuntimeSettingsResp );

struct WdsConnectionRateElmnts
{
    ULONG  *pCurrentChannelTXRate;
    ULONG  *pCurrentChannelRXRate;
    ULONG  *pMaxChannelTXRate;
    ULONG  *pMaxChannelRXRate;
};

struct WdsConnectionRate
{
    ULONG  *pV4sessionId;
    ULONG  *pV6sessionId;
    struct WdsConnectionRateElmnts ConnRateElmntsV4;
    struct WdsConnectionRateElmnts ConnRateElmntsV6;
};

/*
 * This API is an internal Api.Used to switch the call for GetConnectionRate.
 *
 *  \param  pV4sessionId[IN]
 *          - use to store the current IPV4 Session Id. It can be NULL
 *
 *  \param  pV6sessionId[IN]
 *          - use to store the current IPV6 Session Id. It can be NULL
 *
 *  \param  pConnectionRateElmnt[OUT]
 *          - See \ref WdsConnectionRateElmnts for more information
 *
 *  \return eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
 *
 *  \sa     see qmerrno.h for eQCWWAN_xxx error values
 *
 *  \note   Technology Supported: UMTS/CDMA\n
 *          Device Supported: MC77XX\n
 *          Timeout: 2 seconds\n
 *
 */
ULONG iGetConnectionRate (
    ULONG *pv4sessionId,
    ULONG *pv6sessionId,
    struct WdsConnectionRateElmnts *pConnectionRateElmnt );

ULONG SLQSGetConnectionRate (
    struct WdsConnectionRate *pConnectionRate );

struct WdsByteTotalsElmnts
{
    ULONGLONG  *pTXTotalBytes;
    ULONGLONG  *pRXTotalBytes;
};

struct WdsByteTotals
{
    ULONG                      *pV4sessionId;
    ULONG                      *pV6sessionId;
    struct WdsByteTotalsElmnts ByteTotalsElmntsV4;
    struct WdsByteTotalsElmnts ByteTotalsElmntsV6;
};

/*
 * This API is an internal Api.Used to switch the call for GetByteTotals.
 *
 *  \param  pV4sessionId[IN]
 *          - use to store the current IPV4 Session Id. It can be NULL
 *
 *  \param  pV6sessionId[IN]
 *          - use to store the current IPV6 Session Id. It can be NULL
 *
 *  \param  pByteTotalsElmnt[OUT]
 *          - See \ref WdsByteTotalsElmnts for more information
 *
 *  \return eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
 *
 *  \sa     see qmerrno.h for eQCWWAN_xxx error values
 *
 *          Timeout: 2 seconds\n
 *
 */
ULONG iGetByteTotals (
    ULONG                      *pv4sessionId,
    ULONG                      *pv6sessionId,
    struct WdsByteTotalsElmnts *pByteTotalsElmnt );

ULONG SLQSGetByteTotals (
    struct WdsByteTotals *pByteTotals );

ULONG SLQSWdsGoDormant( void );

ULONG SLQSWdsGoActive( void );

ULONG  SLQSGetSessionState(
    ULONG    *pStateV4,
    ULONG    *pStateV6,
    BYTE     instance );

/*
 * This structure contains the response parameters retrieved by the API
 * iSLQSGetInstanceID. This is for SDK internal use only.
 *
 *  \param  pInstanceID
 *          - Instance ID corresponding to the session ID
 *
 *  \param  pIPFamily
 *          - IP Family for the session ID
 *            - 4 - IPv4
 *            - 6 - IPv6
 *
 *  \note  none
 *
 */
typedef struct
{
    BYTE *pInstanceID;
    BYTE *pIPFamily;
} GetInstIDResp;

/*
 * This structure contains the response parameters retrieved by the API
 * iSLQSGetSessionID. This is for SDK internal use only.
 *
 *  \param  pSessionIDv4
 *          - IPv4 session ID
 *
 *  \param  pSessionIDv6
 *          - IPv6 session ID
 *
 *  \note  none
 *
 */
typedef struct
{
    ULONG *pSessionIDv4;
    ULONG *pSessionIDv6;
} GetSessionIDResp;

typedef struct
{
    BYTE  StatsPeriod;
    ULONG StatsMask;
} TransferStatInd;

typedef struct
{
    ULONG           Mask;
    BYTE            *pReportConnStatus;
    TransferStatInd *pTransferStatInd;
    BYTE            *pReportDormStatus;
    BYTE            *pReportDataBearerTech;
    BYTE            *pReportChannelRate;
} getDUNCallInfoReq;

typedef struct
{
    BYTE      MDMConnStatus;
    ULONGLONG MDMCallDuration;
} ConnectionStatus;

typedef struct
{
    ULONG CurrChanTxRate;
    ULONG CurrChanRxRate;
    ULONG MaxChanTxRate;
    ULONG MaxChanRxRate;
} ChannelRate;

typedef struct
{
    ConnectionStatus *pConnectionStatus;
    WORD             *pCallEndReason;
    ULONGLONG        *pTXOKBytesCount;
    ULONGLONG        *pRXOKBytesCount;
    BYTE             *pDormancyStatus;
    BYTE             *pDataBearerTech;
    ChannelRate      *pChannelRate;
    ULONGLONG        *pLastCallTXOKBytesCnt;
    ULONGLONG        *pLastCallRXOKBytesCnt;
    ULONGLONG        *pMdmCallDurationActive;
    BYTE             *pLastCallDataBearerTech;
} getDUNCallInfoResp;

ULONG SLQSGetDUNCallInfo(
    getDUNCallInfoReq  *pGetDUNCallInfoReq,
    getDUNCallInfoResp *pGetDUNCallInfoResp );

struct WdsPktStatisticsElmnts
{
    ULONG        *pTXPacketSuccesses;
    ULONG        *pRXPacketSuccesses;
    ULONG        *pTXPacketErrors;
    ULONG        *pRXPacketErrors;
    ULONG        *pTXPacketOverflows;
    ULONG        *pRXPacketOverflows;
    ULONGLONG    *pTXOkBytesCount;
    ULONGLONG    *pRXOkBytesCount;
    ULONGLONG    *pTXOKBytesLastCall;
    ULONGLONG    *pRXOKBytesLastCall;
    ULONG        *pTXDroppedCount;
    ULONG        *pRXDroppedCount;
};

struct WdsPktStatisticsResp
{
    ULONG                         *pV4sessionId;
    ULONG                         *pV6sessionId;
    struct WdsPktStatisticsElmnts PktStatElmntsV4;
    struct WdsPktStatisticsElmnts PktStatElmntsV6;
};

struct WdsPktStatisticsReq
{
    ULONG *pStatMask;
};

ULONG GetPacketStatistics(
    struct WdsPktStatisticsReq    *pStatMask,
    struct WdsPktStatisticsElmnts *pPktStatisticsElmnt,
    BYTE                          instance );

/*
 * This API is an internal Api.Used to switch the call for GetPacketStatistics.
 *
 *  \param  pV4sessionId[IN]
 *          - use to store the current IPV4 Session Id. It can be NULL
 *
 *  \param  pV6sessionId[IN]
 *          - use to store the current IPV6 Session Id. It can be NULL
 *
 *  \param  pStatMask[IN]
 *          - See \ref WdsPktStatisticsReq for more information
 *
 *  \param  pPktStatisticsElmnt[OUT]
 *          - See \ref WdsPktStatisticsElmnts for more information
 *
 *  \return eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
 *
 *  \sa     see qmerrno.h for eQCWWAN_xxx error values
 *
 */
ULONG iGetPacketStatistics (
    ULONG                         *pV4sessionId,
    ULONG                         *pV6sessionId,
    struct WdsPktStatisticsReq    *pStatMask,
    struct WdsPktStatisticsElmnts *pPktStatisticsElmnt );

ULONG SLQSGetPacketStatistics (
    struct WdsPktStatisticsReq  *pStatMask,
    struct WdsPktStatisticsResp *pPktStatistics );

typedef struct
{
    BYTE  NetworkType;
    ULONG RATMask;
    ULONG SOMask;
}CurrNetworkInfo;

typedef struct
{
    BYTE            *pPrefNetwork;
    BYTE            *pNetworkInfoLen;
    CurrNetworkInfo *pCurrNetworkInfo;
}CurrDataSysStat;

ULONG SLQSGetCurrDataSystemStat ( CurrDataSysStat *pCurrDataSysStat );

typedef struct
{
    BYTE   bResetStatistics;
    ULONG  ulMask;
} swiRMTrasnferStaticsReq;

ULONG RMSetTransferStatistics( swiRMTrasnferStaticsReq *pSwiRMTrasnferStaticsReq );

typedef struct
{
    BYTE    TlvPresent;
    ULONG   ulData;
}DataULongTlv;

typedef struct 
{
    BYTE    TlvPresent;
    ULONGLONG   ullData;
}DataULongLongTlv;

typedef struct {
    DataULongTlv        TxOkConutTlv;
    DataULongTlv        RxOkConutTlv;
    DataULongLongTlv    TxOkByteCountTlv;
    DataULongLongTlv    RxOkByteCountTlv;
    DataULongTlv        TxDropConutTlv;
    DataULongTlv        RxDropConutTlv;
}QmiCbkWdsStatisticsIndState;


ULONG SLQSResetPacketStatics();

typedef struct
{
    ULONG techType;
    ULONG ratValue;
    ULONGLONG soMask;
}DataBearerTech;

typedef struct
{
    DataBearerTech *pBearerTech;
    DataBearerTech *pLastBearerTech;
}DataBearerTechExt;


ULONG  SLQSGetDataBearerTechnologyExt(
    DataBearerTechExt *pDataBearerTech,
    BYTE  instance );

typedef struct
{
    unsigned long current_channel_tx_rate;
    unsigned long current_channel_rx_rate;
    unsigned long max_channel_tx_rate;
    unsigned long max_channel_rx_rate;
}WDSSWICurrentChannelRates;

ULONG SLQSGetCurrentChannelRate(WDSSWICurrentChannelRates *pRates,BYTE instance);

typedef struct
{
    BYTE *pLoopbackMode;
    BYTE *pLoopbackMultiplier;
} WDSSetLoopbackData;

ULONG SLQSSSetLoopback(WDSSetLoopbackData *pReq);

typedef struct
{
    BYTE ByteLoopbackMode;
    BYTE ByteLoopbackMultiplier;
} WDSGetLoopbackData;

ULONG SLQSSGetLoopback(WDSGetLoopbackData *data);

ULONG GetDefaultProfileNum(
        BYTE profile_type,
        BYTE profile_family,
        BYTE *pProfile_no
        );

ULONG SetDefaultProfileNum(
        BYTE profile_type,
        BYTE profile_family,
        BYTE profile_index
        );

typedef struct
{
    BYTE profileType;
    BYTE profileId;
} WdsDHCPv4ProfileId;

typedef struct
{
    BYTE hwType;
    BYTE chaddrLen;
    BYTE chaddr[16];
} WdsDHCPv4HWConfig;

typedef struct
{
    BYTE optCode;
    BYTE optValLen;
    BYTE optVal[255];
} WdsDHCPv4Option;

typedef struct
{
    BYTE numOpt;
    WdsDHCPv4Option *pOptList;
} WdsDHCPv4OptionList;

typedef struct
{
    WdsDHCPv4ProfileId   *pProfileId;
    WdsDHCPv4HWConfig    *pHwConfig;
    WdsDHCPv4OptionList  *pRequestOptionList;
} WdsDHCPv4Config;

typedef struct
{
    BYTE *pEnableNotification;
}WdsClientLeaseChange;

ULONG SLQSSSetDHCPv4ClientConfig(WdsDHCPv4Config *pReq);

ULONG SLQSSGetDHCPv4ClientConfig(WdsDHCPv4Config *pReqResp);

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

#endif /* __GOBI_API_WDS_H__ */