qaGobiApiQos.h File Reference

Quality of Service API function prototypes. More...

Go to the source code of this file.

Data Structures

struct  dataRate
struct  tokenBucket
struct  pktErrRate
struct  swiQosFlow
struct  IPv4Addr
struct  Tos
struct  IPv6Addr
struct  IPv6TrafCls
struct  Port
struct  swiQosFilter
struct  swiQosReq
struct  swiQosIds
struct  swiQosModifyReq
struct  swiQosGranted
struct  NWProfile
struct  QosFlowStat
struct  QosStat

Functions

ULONG SLQSQosReset (BYTE instance)
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)
ULONG SLQSQosModify (BYTE instance, swiQosModifyReq *pReq)
ULONG SLQSQosGetGranted (BYTE instance, ULONG id, swiQosGranted *pGranted)
ULONG SLQSQosGetFlowStatus (BYTE instance, ULONG id, BYTE *pStatus)
ULONG SLQSQosGetNetworkStatus (BYTE instance, BYTE *pStatus)
ULONG SLQSQosGetNWProf (BYTE instance, BYTE *pSz, NWProfile *pProfile)
ULONG SLQSQosGetStat (ULONG sid, QosStat *pQosStat)
ULONG SLQSQosGetAmbr (ULONG sid, ULONG *pAmbr)

Detailed Description

Quality of Service API function prototypes.

Copyright: © 2013 Sierra Wireless, Inc. all rights reserved

Function Documentation

ULONG SLQSQosGetAmbr ( ULONG  sid,
ULONG *  pAmbr 
)

Queries extra APN parameters that are not reported by existing QCT QMI service

Warning:
NOT IMPLEMENTED
Parameters:
[in] sid 
  • session id
[out] pAmbr 
  • Aggregated Maximum Bit Rate
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
ULONG SLQSQosGetFlowStatus ( BYTE  instance,
ULONG  id,
BYTE *  pStatus 
)

Get the status of a QoS flow.

Parameters:
[in] instance 
  • QMI instance
[in] id Qos identifier Index identifying the QoS flow that has been negotiated
[out] pStatus Qos status Current QoS instance status:

  • 0x01 – QMI_QOS_STATUS_ACTIVATED
  • 0x02 – QMI_QOS_STATUS_SUSPENDED
  • 0x03 – QMI_QOS_STATUS_GONE
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
see qmerrno.h for eQCWWAN_xxx error values
ULONG SLQSQosGetGranted ( BYTE  instance,
ULONG  id,
swiQosGranted *  pGranted 
)

Retrieve the QoS parameters that are in effect for the specified QoS 16 flow as a result of network negotiation

Parameters:
[in] instance 
  • QMI instance
[in] id 
  • Qos identifier
  • Index identifying the QoS flow that has been negotiated
[in] pGranted 
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
see qmerrno.h for eQCWWAN_xxx error values
ULONG SLQSQosGetNetworkStatus ( BYTE  instance,
BYTE *  pStatus 
)

Queries whether the device is currently on a network that supports QoS

Parameters:
instance[IN] 
  • QMI instance
[out] pStatus Network QoS support status

  • 0 – No QoS support in network
  • 1 – Network supports QoS
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
see qmerrno.h for eQCWWAN_xxx error values
Note:
Technology Supported: CDMA
ULONG SLQSQosGetNWProf ( BYTE  instance,
BYTE *  pSz,
NWProfile *  pProfile 
)

Get network supported QoS profile information

Parameters:
[in] instance 
  • QMI instance
in/out] pSz Number of network supported QoS profiles for one technology
[out] pProfile Network supported QoS profiles
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
see qmerrno.h for eQCWWAN_xxx error values
ULONG SLQSQosGetStat ( ULONG  sid,
QosStat *  pQosStat 
)

Get the current number of packets and bytes sent, dropped and received for each UL, DL bearer and a sum of them for UL and DL direction in the modem.

Warning:
NOT IMPLEMENTED
Parameters:
[in] sid -session id
[out] pQosStat See QosFlow for more information
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
ULONG SLQSQosModify ( BYTE  instance,
swiQosModifyReq *  pReq 
)

Resume one or more existing QoS flows

Warning:
NOT IMPLEMENTED
Parameters:
[in] instance 
  • QMI instance
pReq 
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
see qmerrno.h for eQCWWAN_xxx error values
ULONG SLQSQosRel ( BYTE  instance,
swiQosIds *  pQosIds 
)

Release one or more existing QoS flows

Parameters:
[in] instance 
  • QMI instance
pQosIds 
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
see qmerrno.h for eQCWWAN_xxx error values
ULONG SLQSQosReq ( BYTE  instance,
swiQosReq *  pQosReq,
swiQosIds *  pQosResp 
)

Triggers QoS negotiation by providing QoS parameters

Parameters:
instance[IN] 
  • QMI instance
pQoSReq[IN] 
pQosResp[OUT] 
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
see qmerrno.h for eQCWWAN_xxx error values
Note:
Technology Supported: UMTS/CDMA
Device Supported: MC77XX
Timeout: 2 seconds
At least one pair of optional TLVs must be present; Tx QoS Flow Request and Tx QoS Filter Request TLVs must both be present if either one is present; Rx QoS Flow Request and Rx QoS Filter Request TLVs must both be present if either one is present
ULONG SLQSQosReset ( BYTE  instance  ) 

Reset the QoS service state variables of the requesting control point

Parameters:
instance[IN] 
  • QMI instance
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Technology Supported: CDMA, UMTS & LTE
Device Supported: MC7750
Timeout: 2 seconds
ULONG SLQSQosResume ( BYTE  instance,
swiQosIds *  pQosIds 
)

Resume one or more existing QoS flows

Parameters:
[in] instance 
  • QMI instance
pQosIds 
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
see qmerrno.h for eQCWWAN_xxx error values
ULONG SLQSQosSuspend ( BYTE  instance,
swiQosIds *  pQosIds 
)

Suspend one or more existing QoS flows

Parameters:
[in] instance 
  • QMI instance
pQosIds 
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
see qmerrno.h for eQCWWAN_xxx error values
Copyright (c) 2011 Sierra Wireless, Inc. All rights reserved