zl5011xtfm.h

Zalink50114----TDMoIP芯片驱动源码

/*******************************************************************************
*
*  File name:              zl5011xTfm.h
*
*  Version:                10
*
*  Author:                 MRC
*
*  Date created:           22/02/2002
*
*  Copyright 2002, 2003, 2004, 2005, Zarlink Semiconductor Limited.
*  All rights reserved.
*
*  Module Description:
*
*  This is the header file for the TFM block. It contains the function prototypes
*  and any definitions.
*
*  Revision History:
*
*  Rev:  Date:       Author:  Comments:
*  1     22/02/2002  MRC      Creation
*  2     28/02/2002  MRC      Update
*  3     19/03/2002  MRC      Update
*  4     16/04/2002  MRC      Changed Authur to Author in the header
*  5     23/04/2002  MRC      Changed the underrun function to take stream
*                             and channel parameter rather than the chanIndex.
*  6     24/04/2002  MRC      Added a cache init function
*  7     07/06/2002  PJE      New Enable & DisableInterrupts. Names Initialised.
*  8     27/06/2002  MRC      Added function to get current context switch bit
*  9     22/07/2002  MRC      Update following review.
*  10    31/10/2002  MRC      Added variants + minor fixes
*
*******************************************************************************/

#ifndef _ZL5011X_TFM_H
#define _ZL5011X_TFM_H

#ifdef __cplusplus
extern "C" {
#endif
/* interrupt mask bits */
#define ZL5011X_TFM_UNDERRUN_INT         24
#define ZL5011X_TFM_FRAME_INT            25
#define ZL5011X_TFM_LUT_INT              26
#define ZL5011X_TFM_UPDATE_INT           27
#define ZL5011X_TFM_TEARDOWN_INT         28

zlStatusE zl5011xTfmInit(zl5011xParamsS *zl5011xParams);

zlStatusE zl5011xTfmAddChan(zl5011xParamsS *zl5011xParams,
      Uint32T context, zl5011xWanChannelS tdm);
zlStatusE zl5011xTfmRemoveChan(zl5011xParamsS *zl5011xParams,
      Uint32T context, zl5011xWanChannelS tdm);
zlStatusE zl5011xTfmAssignChan(zl5011xParamsS *zl5011xParams,
      Uint32T context, Uint32T chanIndex);
zlStatusE zl5011xTfmFreeChan(zl5011xParamsS *zl5011xParams,
      Uint32T context, Uint32T chanIndex);

zlStatusE zl5011xTfmCheckChan(zl5011xParamsS *zl5011xParams,
      Uint32T *context, Uint32T chanIndex);
zlStatusE zl5011xTfmSetChanUnderrun(zl5011xParamsS *zl5011xParams,
      zl5011xWanChannelS tdm, Uint8T underrunByte, zl5011xWanIfUnderrunModeE mode);

zlStatusE zl5011xTfmUpdateFirstChan(zl5011xParamsS *zl5011xParams,
      Uint32T context);
zlStatusE zl5011xTfmClearFirstChan(zl5011xParamsS *zl5011xParams, Uint32T context);
zlStatusE zl5011xTfmSetFirstChan(zl5011xParamsS *zl5011xParams,
      Uint32T context, Uint32T chanIndex);

zlStatusE zl5011xTfmCheckContextUpdate(zl5011xParamsS *zl5011xParams, Uint32T context);
zlStatusE zl5011xTfmCheckContextTeardown(zl5011xParamsS *zl5011xParams, Uint32T context);
zlStatusE zl5011xTfmUpdateActiveContext(zl5011xParamsS *zl5011xParams, Uint32T context);
zlStatusE zl5011xTfmTearoutContext(zl5011xParamsS *zl5011xParams, Uint32T context);

zlStatusE zl5011xTfmTeardownContext(zl5011xParamsS *zl5011xParams, Uint32T context);
zlStatusE zl5011xTfmUpdateContext(zl5011xParamsS *zl5011xParams, Uint32T context);
zlStatusE zl5011xTfmInitContextCache(zl5011xParamsS *zl5011xParams, Uint32T context);

zlStatusE zl5011xTfmGetCurrentHeader(zl5011xParamsS *zl5011xParams,
          Uint32T context, Uint8T *ctxtSw);

zlStatusE zl5011xTfmGetContextValidBit(zl5011xParamsS *zl5011xParams, Uint32T context,
      zl5011xBooleanE *valid);

zlStatusE zl5011xTfmGetPayloadLength(zl5011xParamsS *zl5011xParams, Uint32T context,
      Uint32T *length);

zlStatusE zl5011xTfmDisableInterrupts(zl5011xParamsS *zl5011xParams, Uint32T context,
                                     Uint32T bits);
zlStatusE zl5011xTfmEnableInterrupts(zl5011xParamsS *zl5011xParams, Uint32T context,
                                     Uint32T bits);

zlStatusE zl5011xTfmGetNextInfo(zl5011xParamsS *zl5011xParams,
         Uint32T *context);

zlStatusE zl5011xTfmGetNextError(zl5011xParamsS *zl5011xParams,
         Uint32T *context, Uint32T *error);
zlStatusE zl5011xTfmGetErroredContext(zl5011xParamsS *zl5011xParams,
          Uint32T *context);
zlStatusE zl5011xTfmGetError(zl5011xParamsS *zl5011xParams,
         Uint32T context, Uint32T *error);

zlStatusE zl5011xTfmSetJitterBufferTime(zl5011xParamsS *zl5011xParams, Uint32T context,
      Uint32T timeInUs);
zlStatusE zl5011xTfmSetJitterBuffer(zl5011xParamsS *zl5011xParams, Uint32T context,
      Uint32T depth);

#ifdef __cplusplus
}
#endif

#endif