/*******************************************************************************
*
*  File name:              zl5011xTif.h
*
*  Version:                12
*
*  Author:                 MRC
*
*  Date created:           08/02/2002
*
*  Copyright 2002, 2003, 2004, 2005, Zarlink Semiconductor Limited.
*  All rights reserved.
*
*  Module Description:
*
*  This file contains all the functions that will initialise and control
*  the TIF block.
*
*  Revision History:
*
*  Rev:  Date:       Author:  Comments:
*  1     08/02/2002  MRC      Creation
*  2     15/02/2002  MRC      Update
*  3     19/03/2002  MRC      Update
*  4     16/04/2002  MRC      Changed Authur to Author in the header
*  5     30/04/2002  MRC      Update
*  6     16/05/2002  MRC      Added a channel enable function
*  7     29/05/2002  MRC      Added bit order control
*  8     31/05/2002  MRC      Added function to tri-state all channels
*  9     09/07/2002  MRC      Added BER functions
*  10    14/08/2002  MRC      Added control for sample point - 3/4 and x1 clock
*  11    31/10/2002  MRC      Added variants + minor fixes
*  12    19/08/2004  MRC      Added user defined LIU frequency setting
*
*******************************************************************************/

#ifndef _ZL5011X_TIF_H
#define _ZL5011X_TIF_H

#ifdef __cplusplus
extern "C" {
#endif

zlStatusE zl5011xTifInit(zl5011xParamsS *zl5011xParams);

zlStatusE zl5011xTifControlOutputs(zl5011xParamsS *zl5011xParams,
      zl5011xWanIfOutputEnableE outputState);

zlStatusE zl5011xTifSetFramePulseType(zl5011xParamsS *zl5011xparams,
      zl5011xWanIfFramePulseTypeE pulseType);

zlStatusE zl5011xTifSetFramePolarity(zl5011xParamsS *zl5011xparams,
      zl5011xPolarityE polarity);

zlStatusE zl5011xTifSetDataSampleMode(zl5011xParamsS *zl5011xParams,
      zl5011xWanIfSamplePointE sampleMode);

zlStatusE zl5011xTifSetClockRate(zl5011xParamsS *zl5011xParams,
      zl5011xWanIfClockRateE clockRate);

zlStatusE zl5011xTifSetDataRate(zl5011xParamsS *zl5011xParams,
      zl5011xWanIfDataRateE dataRate);

zlStatusE zl5011xTifSetRefClockPolarity(zl5011xParamsS *zl5011xParams,
      zl5011xPolarityE polarity);

zlStatusE zl5011xTifSetConnectionMode(zl5011xParamsS *zl5011xParams,
      zl5011xWanIfConnectionTypeE mode);

zlStatusE zl5011xTifEnableBitStuffing(zl5011xParamsS *zl5011xParams,
      zl5011xBooleanE enable);

zlStatusE zl5011xTifSetInputClockPolarity(zl5011xParamsS *zl5011xParams,
      Uint8T streamNumber, zl5011xPolarityE polarity);

zlStatusE zl5011xTifSetOutputClockPolarity(zl5011xParamsS *zl5011xParams,
      Uint8T streamNumber, zl5011xPolarityE polarity);

zlStatusE zl5011xTifSetInterfaceType(zl5011xParamsS *zl5011xParams,
      zl5011xWanIfTypeE wanMode, zl5011xWanLiuFreqE wanLiuFreqIn, Uint32T wanLiuFreqHz);

zlStatusE zl5011xTifChannelEnable(zl5011xParamsS *zl5011xParams,
      zl5011xWanChannelS tdm, zl5011xWanIfOutputEnableE enable);

zlStatusE zl5011xTifDisableAllChannels(zl5011xParamsS *zl5011xParams);

zlStatusE zl5011xTifChannelIndexEnable(zl5011xParamsS *zl5011xParams,
      Uint32T chanIndex, zl5011xWanIfOutputEnableE enable);

zlStatusE zl5011xTifReverseBitOrder(zl5011xParamsS *zl5011xParams, zl5011xBooleanE reverse);

zlStatusE zl5011xTifBerConfigure(zl5011xParamsS *zl5011xParams,
   Uint32T regAddress, zl5011xWanBerConfigS *structAddress,
   zl5011xWanIfBerDirectionE berDirection, zl5011xWanIfBerPatternE berPattern,
   Uint8T berStream, Uint8T berStartChannel, Uint8T berEndChannel);
zlStatusE zl5011xTifBerConfigureGenerator(zl5011xParamsS *zl5011xParams,
   zl5011xWanIfBerDirectionE berDirection, zl5011xWanIfBerPatternE berPattern,
   Uint8T berStream, Uint8T berStartChannel, Uint8T berEndChannel);
zlStatusE zl5011xTifBerConfigureReceiver(zl5011xParamsS *zl5011xParams,
   zl5011xWanIfBerDirectionE berDirection, zl5011xWanIfBerPatternE berPattern,
   Uint8T berStream, Uint8T berStartChannel, Uint8T berEndChannel);
zlStatusE zl5011xTifBerDisableGenerator(zl5011xParamsS *zl5011xParams);
zlStatusE zl5011xTifBerDisableReceiver(zl5011xParamsS *zl5011xParams);
zlStatusE zl5011xTifBerResetReceiver(zl5011xParamsS *zl5011xParams);
zlStatusE zl5011xTifBerGetStatsReceiver(zl5011xParamsS *zl5011xParams,
      zl5011xBooleanE *lock, Uint16T *errorCount);

#ifdef __cplusplus
}
#endif

#endif