/*******************************************************************************
*
*  File name:              zl5011xCpq.h
*
*  Version:                11
*
*  Author:                 LCW
*
*  Date created:           15/04/2002
*
*  Copyright 2002, 2003, 2004, 2005, Zarlink Semiconductor Limited.
*  All rights reserved.
*
*  Module Description:
*   This is the header file for the CPQ block.
*   It contains the function prototypes and any definitions.
*
*  Revision History:
*
*  Rev:  Date:       Author:  Comments:
*  1     15/04/2002  LCW      Created
*  2     16/04/2002  MRC      Changed Authur to Author
*  3     19/04/2002  LCW      Prepared for code review
*  4     30/04/2002  LCW      Prepared for code review
*  5     08/05/2002  LCW      Code review actions
*  6     12/06/2002  MRC      Update.
*  7     12/07/2002  MRC      Rationalised the 2 enums for CPU queues
*  8     18/10/2002  PJE      interruptEnable/Disable updated
*  9     31/10/2002  MRC      Added variants + minor fixes
*  10    07/04/2003  ARW      Added function zl5011xCpqReceiveQueueStatus
*  11    14/02/2005  MRC      Updated compiler directive
*
*******************************************************************************/

#ifndef _ZL5011X_CPQ_H
#define _ZL5011X_CPQ_H

#ifdef __cplusplus
extern "C" {
#endif

/*****************   #DEFINES    **********************************************/

/*****************   DATA TYPES   *********************************************/

/*****************   INCLUDE FILES   ******************************************/

/*****************   DATA STRUCTURES   ****************************************/

/*****************   EXPORTED GLOBAL VARIABLE DECLARATIONS   ******************/

/*****************   FUNCTION DECLARATIONS   **********************************/

  /* Function prototypes */
zlStatusE zl5011xCpqInit(zl5011xParamsS *zl5011xParams);

zlStatusE zl5011xCpqConfigureQueue(zl5011xParamsS *zl5011xParams,
      zl5011xQueueE queue, Uint32T overrunThld,
      zl5011xBooleanE enablePacketDrop);

zlStatusE zl5011xCpqSetOverrunThreshold(zl5011xParamsS *zl5011xParams,
      zl5011xQueueE queue, Uint32T overrunThld);

zlStatusE zl5011xCpqSetOverrunMode(zl5011xParamsS *zl5011xParams,
      zl5011xQueueE queue, zl5011xBooleanE enablePacketDrop);

zlStatusE zl5011xCpqSetGranuleUsage(zl5011xParamsS *zl5011xParams,
      Uint32T maxNumberOfGranules);

zlStatusE zl5011xCpqGetStatus(zl5011xParamsS *zl5011xParams,
      Uint32T *queueStatus);

zlStatusE zl5011xCpqGetQueueDepth(zl5011xParamsS *zl5011xParams,
      zl5011xQueueE queue, Uint32T *packetCount);
zlStatusE zl5011xCpqEnableInterrupts(zl5011xParamsS *zl5011xParams,
                                       Uint32T interruptBits);
zlStatusE zl5011xCpqDisableInterrupts(zl5011xParamsS *zl5011xParams,
                                       Uint32T interruptBits);

zlStatusE zl5011xCpqReceiveQueueStatus(zl5011xParamsS *zl5011xParams,
      zl5011xQueueE queue,zl5011xBooleanE *packetsWaiting);

#ifdef __cplusplus
}
#endif

#endif /* _ZL5011X_CPQ_H_ */