# qmss_qos.h File Reference

This is the QMSS QOS header file. More...

`#include <ti/drv/qmss/qmss_drv.h>`

## Data Structures

struct | Qmss_QosQueueCfg
| QoS queue configuration structure. More...
struct | Qmss_QosClusterCfgTB
| QoS cluster configuration structure for Modified Token Bucket. More...
struct | Qmss_QosClusterCfgRR
| QoS cluster configuration structure for Round Robin. More...
struct | Qmss_QosClusterCfg
| QoS cluster configuration structure. More...
struct | Qmss_QosSrioTXQCfg
| QoS SRIO Tracking configuration structure. More...
struct | Qmss_QosSrioCfg
| QoS SRIO Tracking configuration structure. More...

## Defines

#define | QMSS_QOS_PDSP_NUM 1
#define | QMSS_QOS_MAX_QUE_RR_HIGH_PRI 4
#define | QMSS_QOS_SRIO_MIN_TX_Q 2
#define | QMSS_QOS_SRIO_SHADOW_GARBAGE_Q_OFFSET 0
#define | QMSS_QOS_SRIO_SHADOW_TX_Q_OFFSET 6
#define | QMSS_QOS_SRIO_SHADOW_TX_COMPLETION_Q_OFFSET 11
#define | QMSS_QOS_SRIO_GARBAGE_Q_OFFSET 16
#define | QMSS_QOS_SRIO_TX_COMPLETION_Q_OFFSET 21
#define | QMSS_QCMD_GET_QUEUE_BASE 0x80
#define | QCMD_RETCODE_SUCCESS 1
#define | QMSS_QCMD_INVALID_COMMAND 2
#define | QMSS_QCMD_INVALID_INDEX 3
#define | QMSS_QCMD_INVALID_OPTION 4
#define | QMSS_QCMD_INVALID_MODE 100
#define | QMSS_QCMD_INVALID_RR_HIGH_Q 101
#define | QMSS_QCMD_INVALID_RR_LOW_Q 102
#define | QMSS_QCMD_INVALID_RR_EGRESS_Q 103
#define | QMSS_QCMD_INVALID_SRIO_NUM_Q 104

## Enumerations

enum | Qmss_QosMode { Qmss_QosMode_TokenBucket, Qmss_QosMode_RoundRobin }
| QoS cluster mode. More...

## Functions

Qmss_Result | Qmss_setQosQueueBase (uint32_t queueNum)
Qmss_Result | Qmss_getQosQueueBase (uint32_t *queueNum)
Qmss_Result | Qmss_configureQosTimer (uint32_t timerConstant)
Qmss_Result | Qmss_enableQosCluster (uint32_t clusterIndex)
Qmss_Result | Qmss_disableQosCluster (uint32_t clusterIndex)
Qmss_Result | Qmss_configureQosQueue (uint32_t queIndex, Qmss_QosQueueCfg *cfg)
Qmss_Result | Qmss_configureQosCluster (uint32_t clusterIndex, Qmss_QosClusterCfg *cfg)
Qmss_Result | Qmss_getQosQueueForwardPktStats (uint32_t queueIndex)
Qmss_Result | Qmss_getQosQueueDroppedPktStats (uint32_t queueIndex)
Qmss_Result | Qmss_resetQosQueueStats (uint32_t queueIndex)
Qmss_Result | Qmss_configureQosSrioCluster (uint32_t clusterIndex, Qmss_QosSrioCfg *cfg)
Qmss_Result | Qmss_enableQosSrioCluster (uint32_t clusterIndex)
Qmss_Result | Qmss_disableQosSrioCluster (uint32_t clusterIndex)

## Detailed Description

This is the QMSS QOS header file.

  ============================================================================
  (C) Copyright 2009-2011, Texas Instruments, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Copyright 2012, Texas Instruments Incorporated