/*******************************************************************************
*
*  File name:              zl5011xPkq.h
*
*  Version:                8
*
*  Author:                 LCW
*
*  Date created:           16/04/2002
*
*  Copyright 2002, 2003, 2004, 2005, Zarlink Semiconductor Limited.
*  All rights reserved.
*
*  Module Description:
*   This is the header file for the Pkq block.
*   It contains the function prototypes and any definitions.
*
*  Revision History:
*
*  Rev:  Date:       Author:  Comments:
*  1     16/04/2002  LCW      Creation.
*  2     09/05/2002  LCW      Minor mods.
*  3     16/05/2002  LCW      Minor mods.
*  4     16/05/2002  LCW      Minor mods.
*  5     05/06/2002  MRC      Update
*  6     31/10/2002  MRC      Added variants + minor fixes
*  7     27/09/2004  MRC      Added function to return port / queue for an mpid
*  8     14/02/2005  MRC      Updated compiler directive
*
*******************************************************************************/

#ifndef _ZL5011X_PKQ_H_
#define _ZL5011X_PKQ_H_

#ifdef __cplusplus
extern "C" {
#endif

/*****************   DATA TYPES   *********************************************/
/*****************   # DEFINES   **********************************************/
/*****************   INCLUDE FILES   ******************************************/
/*****************   DATA STRUCTURES   ****************************************/
/*****************   EXPORTED GLOBAL VARIABLE DECLARATIONS   ******************/
/*****************   EXTERNAL FUNCTION DECLARATIONS   *************************/

zlStatusE  zl5011xPkqInit(zl5011xParamsS *zl5011xParams);

zlStatusE  zl5011xPkqSetQueuePriority(zl5011xParamsS *zl5011xParams,
                                       Uint8T portNumber,
                                       zl5011xPacketQueuePriorityModeE priorityMode);

zlStatusE  zl5011xPkqSetWeighting(zl5011xParamsS *zl5011xParams,
                              Uint8T portNumber,
                              Uint32T queue0Weighting,
                              Uint32T queue1Weighting,
                              Uint32T queue2Weighting,
                              Uint32T queue3Weighting);


zlStatusE  zl5011xPkqConfigureQueue(zl5011xParamsS *zl5011xParams,
                                   Uint8T portNumber,
                                   Uint8T queueNumber,
                                   zl5011xBooleanE thresholdMode,
                                   Uint32T granuleThreshold);

zlStatusE zl5011xPkqSetGranuleThreshold(zl5011xParamsS *zl5011xParams,
                                       Uint8T portNumber,
                                       Uint8T queueNumber,
                                       Uint32T granuleThreshold);

zlStatusE  zl5011xPkqSetThresholdMode(zl5011xParamsS *zl5011xParams,
                                     Uint8T portNumber,
                                     Uint8T queueNumber,
                                     zl5011xBooleanE thresholdMode);

zlStatusE  zl5011xPkqSetTotalGranuleThreshold(zl5011xParamsS *zl5011xParams,
            Uint32T totalGranuleThreshold);

zlStatusE  zl5011xPkqSetTotalThresholdMode(zl5011xParamsS *zl5011xParams,
            zl5011xBooleanE totalThresholdMode);


zlStatusE  zl5011xPkqSetMpidConnection(zl5011xParamsS *zl5011xParams, Uint32T mpid,
                                       Uint8T portNumber,
                                       Uint8T queueNumber);

zlStatusE  zl5011xPkqGetMpidConnection(zl5011xParamsS *zl5011xParams, Uint32T mpid,
                                       Uint8T *portNumber,
                                       Uint8T *queueNumber);

zlStatusE zl5011xPkqGetDropStatus(zl5011xParamsS *zl5011xParams, Uint32T *pStatus);

#ifdef __cplusplus
}
#endif

#endif /* _ZL5011X_PKQ_H_ */