/*******************************************************************************
*
*  File name:              zl5011xTm.h
*
*  Version:                10
*
*  Author:                 MRC
*
*  Date created:           09/04/2002
*
*  Copyright 2002, 2003, 2004, 2005, Zarlink Semiconductor Limited.
*  All rights reserved.
*
*  Module Description:
*
*  This is the header file for the TM block. It contains the function prototypes
*  and any definitions.
*
*  Revision History:
*
*  Rev:  Date:       Author:  Comments:
*  1     09/04/2002  MRC      Creation
*  2     12/04/2002  MRC      Minor mods
*  3     16/04/2002  MRC      Minor mods
*  4     16/04/2002  MRC      Minor mods
*  5     16/04/2002  MRC      Minor mods
*  6     10/06/2002  LCW      Minor mods
*  7     24/07/2002  MRC      Added TM trace buffer functions
*  8     08/10/2002  PJE      Added three intr functions
*  9     31/10/2002  MRC      Added variants + minor fixes
*  10    22/05/2003  MRC      Tidied up interrupt fns
*
*******************************************************************************/

#ifndef _ZL5011X_TM_H
#define _ZL5011X_TM_H

#ifdef __cplusplus
extern "C" {
#endif

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

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

/* defines for the TM interrupt bit positions */
#define ZL5011X_TM_LOOKUP_RAM_INT       31
#define ZL5011X_TM_INPUT_PORT3_INT      11
#define ZL5011X_TM_INPUT_PORT2_INT      10
#define ZL5011X_TM_INPUT_PORT1_INT      9
#define ZL5011X_TM_INPUT_PORT0_INT      8
#define ZL5011X_TM_OUTPUT_PORT4_INT     4
#define ZL5011X_TM_OUTPUT_PORT3_INT     3
#define ZL5011X_TM_OUTPUT_PORT2_INT     2
#define ZL5011X_TM_OUTPUT_PORT1_INT     1
#define ZL5011X_TM_OUTPUT_PORT0_INT     0

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

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

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

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

zlStatusE zl5011xTmInit(zl5011xParamsS *zl5011xParams);
zlStatusE zl5011xTmEnableLookUpRam(zl5011xParamsS *zl5011xParams,
      zl5011xTmSrcPortE port, zl5011xBooleanE enable);
zlStatusE zl5011xTmWriteLookUpRam(zl5011xParamsS *zl5011xParams,
      zl5011xFlowTypeE flow, zl5011xTmSrcPortE srcPort, zl5011xTmDestPortE destPort);

zlStatusE zl5011xTmConfigureInputBuffer(zl5011xParamsS *zl5011xParams,
      zl5011xTmSrcPortE srcPort, Uint32T cpuSize, Uint32T tfqSize,
      Uint32T rtpSize, Uint32T pkqSize);
zlStatusE zl5011xTmSetInputBufferAddress(zl5011xParamsS *zl5011xParams,
      zl5011xTmSrcPortE srcPort, zl5011xTmDestPortE destPort,
      AddressT startAddress, AddressT endAddress);
zlStatusE zl5011xTmSetInputBufferSize(zl5011xParamsS *zl5011xParams,
      zl5011xTmSrcPortE srcPort, zl5011xTmDestPortE destPort, Uint32T size);

zlStatusE zl5011xTmConfigureTrace(zl5011xParamsS *zl5011xParams,
      zl5011xTmTraceModeE mode, zl5011xBooleanE defaultTimer);
zlStatusE zl5011xTmDisableTrace(zl5011xParamsS *zl5011xParams);
zlStatusE zl5011xTmDecodeTraceFull(zl5011xParamsS *zl5011xParams,
      Uint32T *buffer, zl5011xTmTraceMessageS *msg);
zlStatusE zl5011xTmDecodeTracePartial(zl5011xParamsS *zl5011xParams,
      Uint32T *buffer, zl5011xTmTraceMessageS *msg);
zlStatusE zl5011xTmDecodeTraceTime(zl5011xParamsS *zl5011xParams,
      Uint32T *buffer, zl5011xTmTraceMessageS *msg);
zlStatusE zl5011xTmDecodeTraceSource(zl5011xParamsS *zl5011xParams,
      Uint32T *buffer, zl5011xTmTraceMessageS *msg);
zlStatusE zl5011xTmGetTracePointer(zl5011xParamsS *zl5011xParams,
         Uint32T *tracePointer);
zlStatusE zl5011xTmGetTraceMessage(zl5011xParamsS *zl5011xParams,
      Uint32T index, zl5011xTmTraceMessageS *msg);
zlStatusE zl5011xTmDumpTraceMessage(zl5011xParamsS *zl5011xParams,
      Uint32T index);

zlStatusE zl5011xTmGetInterruptStatus(zl5011xParamsS *zl5011xParams, Uint32T *pIntrStatus);
zlStatusE zl5011xTmEnableInterrupts(zl5011xParamsS *zl5011xParams, Uint32T interruptBits);
zlStatusE zl5011xTmDisableInterrupts(zl5011xParamsS *zl5011xParams, Uint32T interruptBits);
zlStatusE zl5011xTmClearInterrupts(zl5011xParamsS *zl5011xParams, Uint32T interruptBits);

#ifdef __cplusplus
}
#endif

#endif