qaGobiApiQos.h

Go to the documentation of this file.

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

#ifdef __cplusplus
extern "C" {
#endif

#define MAX_QOS_SPEC_PER_APN (10)

#define MAX_QOS_FILTER_TLV 25

ULONG SLQSQosReset(
        BYTE instance
        );

typedef struct
{
    ULONG   dataRateMax;
    ULONG   guaranteedRate;
} dataRate;

typedef struct
{
    ULONG   peakRate;
    ULONG   tokenRate;
    ULONG   bucketSz;
} tokenBucket;

typedef struct
{
    WORD    multiplier;
    WORD    exponent;
} pktErrRate;

typedef struct
{
    BYTE        index;
    WORD        *pProfileId3GPP2;
    BYTE        *p3GPP2Pri;
    BYTE        *pTrafficClass;
    dataRate    *pDataRate;
    tokenBucket *pTokenBucket;
    ULONG       *pLatency;
    ULONG       *pJitter;
    pktErrRate  *pPktErrRate;
    ULONG       *pMinPolicedPktSz;
    ULONG       *pMaxAllowedPktSz;
    WORD        *p3GPPResResidualBER;
    BYTE        *p3GPPTraHdlPri;
    BYTE        *p3GPPImCn;
    BYTE        *p3GPPSigInd;
    BYTE        *pLteQci;
} swiQosFlow;

typedef struct
{
    ULONG   addr;
    ULONG   subnetMask;
} IPv4Addr;

typedef struct
{
    BYTE   val;
    BYTE   mask;
} Tos;

typedef struct
{
    BYTE    addr[16];
    BYTE    prefixLen;
} IPv6Addr;

typedef struct
{
    BYTE   val;
    BYTE   mask;
} IPv6TrafCls;

typedef struct
{
    WORD   port;
    WORD   range;
} Port;

typedef struct
{
    BYTE        index;
    BYTE        version;
    IPv4Addr    *pIPv4SrcAddr;
    IPv4Addr    *pIPv4DstAddr;
    BYTE        *pNxtHdrProto;
    Tos         *pTos;
    IPv6Addr    *pIPv6SrcAddr;
    IPv6Addr    *pIPv6DstAddr;
    IPv6TrafCls *pIPv6TrafCls;
    ULONG       *pIPv6Label;
    Port        *pTCPSrcPort;
    Port        *pTCPDstPort;
    Port        *pUDPSrcPort;
    Port        *pUDPDstPort;
    ULONG       *pEspSpi;
    WORD        *pPrecedence;
    WORD        *pId;
    Port        *pTranSrcPort;
    Port        *pTranDstPort;
} swiQosFilter;

typedef struct
{
    BYTE            index;
    swiQosFlow      *pTxFlow;
    swiQosFlow      *pRxFlow;
    swiQosFilter    *pTxFilter;
    swiQosFilter    *pRxFilter;
} swiQosReq;

typedef struct
{
    BYTE    sz;
    ULONG   *pIds;
} swiQosIds;

ULONG SLQSQosReq(
    BYTE        instance,
    swiQosReq   *pQosReq,
    swiQosIds   *pQosResp );

ULONG SLQSQosRel(
    BYTE        instance,
    swiQosIds   *pQosIds );

ULONG SLQSQosSuspend(
    BYTE        instance,
    swiQosIds   *pQosIds );

ULONG SLQSQosResume(
    BYTE        instance,
    swiQosIds   *pQosIds );

typedef struct
{
    ULONG           id;
    swiQosFlow      *pTxFlow;
    swiQosFlow      *pRxFlow;
    swiQosFilter    *pTxFilter;
    swiQosFilter    *pRxFilter;
} swiQosModifyReq;

ULONG SLQSQosModify(
    BYTE            instance,
    swiQosModifyReq *pReq );

typedef struct
{
    swiQosFlow      *pTxFlow;
    swiQosFlow      *pRxFlow;
} swiQosGranted;

ULONG SLQSQosGetGranted(
    BYTE            instance,
    ULONG           id,
    swiQosGranted   *pGranted );

ULONG SLQSQosGetFlowStatus(
    BYTE    instance,
    ULONG   id,
    BYTE    *pStatus);

ULONG SLQSQosGetNetworkStatus(
    BYTE    instance,
    BYTE    *pStatus);

typedef struct
{
    WORD    tech;
    BYTE    *pProfSz;
    WORD    *pProfValues;
} NWProfile;

ULONG SLQSQosGetNWProf(
    BYTE        instance,
    BYTE        *pSz,
    NWProfile   *pProfile);

typedef struct
{
    ULONG   bearerId;
    ULONG   tx_pkt;
    ULONG   tx_pkt_drp;
    ULONGLONG   tx_bytes;
    ULONGLONG   tx_bytes_drp;
} sQosFlowStat;

typedef struct
{
    ULONG    apnId;
    ULONG    total_tx_pkt;
    ULONG    total_tx_pkt_drp;
    ULONG    total_rx_pkt;
    ULONGLONG    total_tx_bytes;
    ULONGLONG    total_tx_bytes_drp;
    ULONGLONG    total_rx_bytes;

    ULONG        numQosFlow;
    sQosFlowStat qosFlow[MAX_QOS_SPEC_PER_APN];
} sQosStat;

typedef struct
{
    ULONG    apnId;
    BYTE     ambr_ul;
    BYTE     ambr_dl;
    BYTE     ambr_ul_ext;
    BYTE     ambr_dl_ext;
    BYTE     ambr_ul_ext2;
    BYTE     ambr_dl_ext2;
} sApnExtraParams;

ULONG SLQSQosSwiReadDataStats(
        BYTE        instance,
        ULONG       apnId,
        sQosStat    *pQosStat
        );

ULONG SLQSQosSwiReadApnExtraParams (
        BYTE        instance,
        ULONG       apnId,
        sApnExtraParams    *pApnExtraParams
        );

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

#endif /* __GOBI_API_QOS_H__ */