/*******************************************************************************
*
*  File name:              zl5011xPktPassthru.h
*
*  Version:                1
*
*  Author:                 APL
*
*  Date created:           18/02/2005
*
*  Copyright 2002, 2003, 2004, 2005, Zarlink Semiconductor Limited.
*  All rights reserved.
*
*  Module Description:
*
*  This file is the interface definition file for the data pass through functions
*
*  Revision History:
*
*  Rev:  Date:       Author:  Comments:
*  1     18/02/2005  APL      First version
*
*******************************************************************************/

#ifndef _ZL5011X_PKT_PASSTHRU_H
#define _ZL5011X_PKT_PASSTHRU_H

/*****************   COMPILE CONTROLS *****************************************/

/*****************   INCLUDE FILES                *****************************/
#include "zl5011x.h"

#ifdef __cplusplus
extern "C" {
#endif

/*****************   # DEFINES   **********************************************/
#define ZL5011X_NUM_PKT_PKT_FLOWS  2

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

/*****************   DATA STRUCTURES and FUNCTION DECLARATIONS   **************/

/* Packet to packet flow creation */
/* Main structure containing parameters for creating bidirectional packet-to-packet flows */
typedef struct
{
   Uint32T  upLinkPort;       /* Port number for uplink port */
   Uint32T  upLinkQueueNum;   /* Ouput queue to use on uplink port */

   Uint32T  downLinkPort;       /* Port number for downlink port */
   Uint32T  downLinkQueueNum;   /* Ouput queue to use on downlink port */

   Uint32T  protocolMatchNum;                            /* The protocol match number to use */
   Uint32T  context[ZL5011X_NUM_PKT_PKT_FLOWS];            /* Context number to use */
   Uint32T  classifyMatchNum[ZL5011X_NUM_PKT_PKT_FLOWS];   /* The classify match number to use */

   zl5011xBooleanE osExclusionEnable;   /* ZL5011X_TRUE to use OS exclusion in this function */
} zl5011xPktToPktPassthruS;

/* Function definitons */
zlStatusE zl5011xCreatePktToPktPassthruStructInit(zl5011xParamsS *zl5011xParams,
      zl5011xPktToPktPassthruS * par);
zlStatusE zl5011xCreatePktToPktPassthru(zl5011xParamsS *zl5011xParams, zl5011xPktToPktPassthruS *par);


/* Packet to Packet flow deletion */
/* Main structure containing parameters for deleting pkt-to-pkt flow  */
typedef struct
{
   Uint32T context[ZL5011X_NUM_PKT_PKT_FLOWS];     /* The packet to packet context numbers */
   zl5011xBooleanE osExclusionEnable;
} zl5011xDeletePktToPktPassthruS;

zlStatusE zl5011xDeletePktToPktPassthruStructInit(zl5011xParamsS *zl5011xParams,
            zl5011xDeletePktToPktPassthruS *par);
zlStatusE zl5011xDeletePktToPktPassthru(zl5011xParamsS *zl5011xParams,
            zl5011xDeletePktToPktPassthruS *par);

/* Helper function to convert a classifier priority number into an absolute classifier number */
Uint32T zl5011xGetClassifierNumFromPriorityOrder(Uint32T matchPriority);

#ifdef __cplusplus
}
#endif

#endif   /* _ZL5011X_PKT_PASSTHRU_H */