/*******************************************************************************
*
*  File name:              zl5011xUtilLib.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 common the prototypes for the general utility functions.
*
*  Revision History:
*
*  Rev:  Date:       Author:  Comments:
*  1     08/02/2002  MRC      Creation
*  7     27/09/2002  DJA      SOS version updated
*                             File header updated
*  8     27/09/2002  JFE      Added prototype for zl5011xSenFunctionReport
*  9     30/09/2002  JFE      Removed prototype for zl5011xSenFunctionReport
*  10    31/10/2002  MRC      Added variants + minor fixes
*  11    09/06/2003  DJA      Performed pre-audit actions
*  12    04/07/2005  MRC      Added stream range check for clock only function
*
*******************************************************************************/

#ifndef _ZL5011X_UTIL_LIB_H
#define _ZL5011X_UTIL_LIB_H

#ifdef __cplusplus
extern "C" {
#endif

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

#include "zl5011xRdWr.h"


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

zlStatusE zl5011xUpdateRegisters(zl5011xParamsS *zl5011xParams, AddressT addr,
                                Uint32T *structureRegister, Uint32T data, Uint32T mask);
zlStatusE zl5011xReadModWrite(zl5011xParamsS *zl5011xParams, AddressT addr,
                             Uint32T data,Uint32T mask);

zlStatusE zl5011xCheckClockRange(zl5011xParamsS *zl5011xParams, Uint8T streamNumber);
zlStatusE zl5011xCheckStreamRange(zl5011xParamsS *zl5011xParams, Uint8T streamNumber);
zlStatusE zl5011xCheckChannelRange(zl5011xParamsS *zl5011xParams, Uint8T channelNumber);

zlStatusE zl5011xCheckTdm( zl5011xParamsS *zl5011xParams,
          zl5011xWanChannelS tdm,Uint32T* tdmIndex);

zlStatusE zl5011xCalcChanIndex(zl5011xParamsS *zl5011xParams,
          zl5011xWanChannelS tdm,Uint32T* tdmIndex);

zlStatusE zl5011xHostInterruptDisable(void);
zlStatusE zl5011xHostInterruptEnable(void);




#ifdef __cplusplus
}
#endif

#endif /* _ZL5011X_UTIL_LIB_H */