/*******************************************************************************
*
*  File name:              zl5011xFlow.h
*
*  Version:                22
*
*  Author:                 MRC
*
*  Date created:           28/02/2002
*
*  Copyright 2002, 2003, 2004, 2005, Zarlink Semiconductor Limited.
*  All rights reserved.
*
*  Module Description:
*
*     Contains the block ID's and flow type definitions.
*
*  Revision History:
*
*  Rev:  Date:       Author:  Comments:
*  1     28/02/2002  MRC      Creation
*  2     08/03/2002  MRC      Update
*  3     19/03/2002  MRC      Update
*  4     28/03/2002  MRC      Trailing , caused warning in pedantic mode
*  5     16/04/2002  MRC      Authur changed to Author in title block
*  6     17/04/2002  MRC      Changed the CHECK_.. macros to ZL5011X_CHECK_..
*  7     18/04/2002  MRC      Added WAN loopback flow for test ONLY
*  8     07/05/2002  MRC      Added block ID for the PKC
*  9     03/07/2002  MRC      Added flow for PKT to PKT for test ONLY
*  10    10/07/2002  MRC      Added flow WAN_RTP_CPU
*  11    23/07/2002  MRC      Added block ID for the RTP
*  12    17/09/2002  ARW      Added a new block ID number for CPU transfers
*  13    23/09/2002  MRC      Modified the CHECK FLOW macro to allow new value
*  14    31/10/2002  MRC      Added variants + minor fixes
*  15    19/05/2003  APL      Added ZL5011X_FLOW_PKT_PE_PKT for test
*  16    17/07/2003  APL      Added support for device variants with no TDM
*  17    16/06/2004  MRC      Added flow PKT_PE_CPU
*  18    12/07/2004  MRC      Added flow ZL5011X_FLOW_WAN_PE_WAN
*  19    14/07/2004  MRC      Added flow WAN_PE_WAN
*  20    27/09/2004  APL      Clarified comment in flow type enumerator
*  21    19/10/2004  APL      Added flow CPU_CPU
*  22    21/01/2005  MRC      Added extra test flow
*
*******************************************************************************/

#ifndef _ZL5011X_FLOW_H
#define _ZL5011X_FLOW_H

#ifdef __cplusplus
extern "C" {
#endif

/* block ID's - used for TM interface */
#define ZL5011X_PLA_SOURCE_BLOCK_ID   1
#define ZL5011X_PKC_SOURCE_BLOCK_ID   2
#define ZL5011X_RTP_SOURCE_BLOCK_ID   3
#define ZL5011X_CPU_SOURCE_BLOCK_ID   4

/* flow type definitions */
   #define ZL5011X_CHECK_FLOW_TYPE(X) \
            ((X < ZL5011X_FLOW_WAN_PE_PKT) || (X >= ZL5011X_FLOW_END_MARKER)) ? \
               ZL5011X_PARAMETER_INVALID : ZL5011X_OK

typedef enum
{
   ZL5011X_FLOW_WAN_PE_PKT = 1,
   ZL5011X_FLOW_PKT_PE_WAN = 2,
   ZL5011X_FLOW_WAN_PKT = 3,
   ZL5011X_FLOW_PKT_WAN = 4,
   ZL5011X_FLOW_WAN_CPU = 5,
   ZL5011X_FLOW_WAN_PE_CPU = 6,
   ZL5011X_FLOW_CPU_WAN = 7,
   ZL5011X_FLOW_PKT_CPU = 8,
   ZL5011X_FLOW_CPU_PKT = 9,
   ZL5011X_FLOW_WAN_WAN = 10,   /* Wan to Wan loopback, for test mode only */
   ZL5011X_FLOW_PKT_PKT = 11,
   ZL5011X_FLOW_CPU_PE_PKT = 12,
   ZL5011X_FLOW_PKT_PE_PKT = 13,
   ZL5011X_FLOW_PKT_PE_CPU = 14,
   ZL5011X_FLOW_WAN_PE_WAN = 15,  /* Wan to Wan loopback with PE statistics, for test mode only */
   ZL5011X_FLOW_CPU_CPU = 16,     /* Cpu to Cpu loopback, for testing only */
   ZL5011X_FLOW_PKT_TS_WAN = 17,

   /* the following enumeration must stay at the end */
   ZL5011X_FLOW_END_MARKER
} zl5011xFlowTypeE;


#ifdef __cplusplus
}
#endif

#endif