zl5011xgm.h

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

/*******************************************************************************
*
*  File name:              zl5011xGm.h
*
*  Version:                8
*
*  Author:                 MRC
*
*  Date created:           04/04/2002
*
*  Copyright 2002, 2003, 2004, 2005, Zarlink Semiconductor Limited.
*  All rights reserved.
*
*  Module Description:
*
*  This is the header file for the GM block. It contains the function prototypes
*  and any definitions.
*
*  Revision History:
*
*  Rev:  Date:       Author:  Comments:
*  1     04/04/2002  MRC      Creation
*  2     04/04/2002  MRC      Added prototypes
*  3     16/04/2002  MRC      Changed Authur to Author in the header
*  4     07/06/2002  MRC      Added granule check functions
*  5     10/06/2002  LCW      Added extra functions
*  6     18/07/2002  MRC      Added number of granules as parameter to configure
*                             function
*  7     17/10/2002  PJE      missing prototype zl5011xGmGetStatus
*  8     31/10/2002  MRC      Added variants + minor fixes
*
*******************************************************************************/

#ifndef _ZL5011X_GM_H
#define _ZL5011X_GM_H

#ifdef __cplusplus
extern "C" {
#endif

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

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

/* interrupt mask bits */
#define ZL5011X_GM_GRANULE_ERROR_INT        2
#define ZL5011X_GM_GRANULE_OVERRUN_INT      1
#define ZL5011X_GM_GRANULE_THRESHOLD_INT    0

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

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

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

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

zlStatusE zl5011xGmInit(zl5011xParamsS *zl5011xParams);
zlStatusE zl5011xGmConfigure(zl5011xParamsS *zl5011xParams, Uint32T numGranules);
zlStatusE zl5011xGmSetHeadGranule(zl5011xParamsS *zl5011xParams, Uint32T index);
zlStatusE zl5011xGmSetTailGranule(zl5011xParamsS *zl5011xParams, Uint32T index);
zlStatusE zl5011xGmSetNumFreeGranules(zl5011xParamsS *zl5011xParams, Uint32T count);
zlStatusE zl5011xGmSetGranuleThreshold(zl5011xParamsS *zl5011xParams, Uint32T count);
zlStatusE zl5011xGmGetTailGranule(zl5011xParamsS *zl5011xParams, Uint32T *index);
zlStatusE zl5011xGmGetHeadGranule(zl5011xParamsS *zl5011xParams, Uint32T *index);
zlStatusE zl5011xGmGetNumFreeGranules(zl5011xParamsS *zl5011xParams, Uint32T *count);
zlStatusE zl5011xGmCheckGranules(zl5011xParamsS *zl5011xParams);
zlStatusE zl5011xGmEnableInterrupts(zl5011xParamsS *zl5011xParams,
            Uint32T interruptMask);
zlStatusE zl5011xGmDisableInterrupts(zl5011xParamsS *zl5011xParams,
                                    Uint32T interruptMask);
zlStatusE zl5011xGmGetStatus(zl5011xParamsS *zl5011xParams, Uint32T *gmStatus);

#ifdef __cplusplus
}
#endif

#endif