txc_envoy_fifo_support.h

TranSwitch Envoy CE2 & Envoy CE4 设备驱动及编程指南

/*--------------------------------------------------------------------------

  *******                           ****
     *     *****     **    *    *  *       *    *   *  *****   ****   *    *
     *     *    *   *  *   **   *  *       *    *   *    *    *    *  *    *
     *     *    *  *    *  * *  *   ****   *    *   *    *    *       ******
     *     *****   ******  *  * *       *  * ** *   *    *    *       *    *
     *     *   *   *    *  *   **  *    *  **  **   *    *    *    *  *    *
     *     *    *  *    *  *    *   ****   *    *   *    *     ****   *    *

                        Proprietary and Confidential 

    This program is made available only to customers and prospective customers 
of TranSwitch Corporation under license and may be used only with TranSwitch 
semi-conductor products.

                      Copyright(c) 2004 TranSwitch Inc.

 --------------------------------------------------------------------------

             *******  **      **  **        **   ********   **      **
             *******  ***     **  **        **  **********  **      **
             **       ** *    **  **        **  **      **   **    **
             *****    **  *   **   **      **   **      **     *  *
             *****    **   *  **    **    **    **      **      **
             **       **    * **     **  **     **      **      **
             *******  **     ***      ****      **********      **
             *******  **      **       **        ********       **

 --------------------------------------------------------------------------
                           TranSwitch Envoy-CE2/CE4
                                Device Driver
 --------------------------------------------------------------------------
                                                                           
  Workfile:     txc_envoy_mac_support.h                                        
                                                                           
  Description:  This header file contains support function for the FIFO I/F                                
                                                                           
 --------------------------------------------------------------------------
                              Revision History                             
 --------------------------------------------------------------------------
   Rev #     Date           Author                Description               
   -----    -------      -----------              -----------               
   0.5.0    6/03/04      F. Giannella         Initial release (beta)

 *--------------------------------------------------------------------------*/


#ifndef TXC_ENVOY_FIFO_SUPPORT_H
#define TXC_ENVOY_FIFO_SUPPORT_H


/****************************************************************************
 **                                Defines                                 **
 ****************************************************************************/

#define MAX_INGRESS_FLOW_CTRL_HI_WMARK   0x1FFF
#define MAX_INGRESS_FLOW_CTRL_LO_WMARK   0x1FFF
#define MAX_INGRESS_PAUSE_FRM_REG_TIME   0xFFFF


/****************************************************************************
 **                            Data Structures                             **
 ****************************************************************************/



/****************************************************************************
 **                          Function Prototypes                           **
 ****************************************************************************/

/* prototypes for VALIDATION functions */

TXC_U16BIT ENVOY_SetIngressFlowCtrlWmarkValid (TXC_U16BIT handle,
           TXC_U16BIT portBlockID,
           ENVOY_IFIFO_FLOW_CTRL_WMARK_STRUCT *ingressFlowCtrlWmarkDataPtr);

TXC_U16BIT ENVOY_GetIngressFlowCtrlWmarkValid (TXC_U16BIT handle,
                                               TXC_U16BIT portBlockID);

TXC_U16BIT ENVOY_SetIngressFifoTransferModeValid (TXC_U16BIT handle,
           ENVOY_IFIFO_TRANSFER_MODE_STRUCT *ingressFifoTransferModeDataPtr);

TXC_U16BIT ENVOY_GetIngressFifoTransferModeValid (TXC_U16BIT handle);

TXC_U16BIT ENVOY_SetEgressFifoTransferModeValid (TXC_U16BIT handle,
           ENVOY_EFIFO_TRANSFER_MODE_STRUCT *eFifoTransferModeDataPtr);

TXC_U16BIT ENVOY_GetEgressFifoTransferModeValid (TXC_U16BIT handle);

TXC_U16BIT ENVOY_SetEfifoStreamingCfgValid (TXC_U16BIT handle, TXC_U16BIT port,
           ENVOY_EFIFO_STREAMING_CFG_STRUCT  *eFifoStreamDataPtr);

TXC_U16BIT ENVOY_GetEfifoStreamingCfgValid (TXC_U16BIT handle, TXC_U16BIT port);

TXC_U16BIT ENVOY_SetFifoPortCtrlValid (TXC_U16BIT handle, TXC_U16BIT port,
           ENVOY_FIFO_PORT_CTRL_STRUCT  *fifoPortCtrlPtr);

TXC_U16BIT ENVOY_GetFifoPortCtrlValid (TXC_U16BIT handle, TXC_U16BIT port);

TXC_U16BIT ENVOY_RtrvFifoPortStatisticsValid (TXC_U16BIT handle, TXC_U16BIT port);

TXC_U16BIT ENVOY_RtrvFifoStatusValid (TXC_U16BIT handle, TXC_U16BIT port);

/* virtual functions */
#ifdef TXC_ENVOY_VIRTUAL_DEVICE_MODE

/* placeholder for virtual function prototypes */

#endif /* NOT TXC_ENVOY_VIRTUAL_DEVICE_MODE */


/* Live (REAL) functions */
#ifndef TXC_ENVOY_VIRTUAL_DEVICE_MODE

TXC_U16BIT ENVOY_SetIngressFlowCtrlWmarkReal (TXC_U16BIT handle,
                                               TXC_U16BIT portBlockID,
            ENVOY_IFIFO_FLOW_CTRL_WMARK_STRUCT *ingressFlowCtrlWmarkDataPtr);


TXC_U16BIT ENVOY_GetIngressFlowCtrlWmarkReal (TXC_U16BIT handle,
                                               TXC_U16BIT portBlockID,
            ENVOY_IFIFO_FLOW_CTRL_WMARK_STRUCT *ingressFlowCtrlWmarkDataPtr);

TXC_U16BIT ENVOY_SetIngressFifoTransferModeReal (TXC_U16BIT handle, 
           ENVOY_IFIFO_TRANSFER_MODE_STRUCT *ingressFifoTransferModeDataPtr);

TXC_U16BIT ENVOY_GetIngressFifoTransferModeReal (TXC_U16BIT handle, 
           ENVOY_IFIFO_TRANSFER_MODE_STRUCT *iFifoTransferModeDataPtr);

TXC_U16BIT ENVOY_SetEgressFifoTransferModeReal (TXC_U16BIT handle,
           ENVOY_EFIFO_TRANSFER_MODE_STRUCT *eFifoTransferModeDataPtr);

TXC_U16BIT ENVOY_GetEgressFifoTransferModeReal (TXC_U16BIT handle,
           ENVOY_EFIFO_TRANSFER_MODE_STRUCT *eFifoTransferModeDataPtr);

TXC_U16BIT ENVOY_SetEfifoStreamingCfgReal (TXC_U16BIT handle, TXC_U16BIT port,
           ENVOY_EFIFO_STREAMING_CFG_STRUCT  *eFifoStreamDataPtr);

TXC_U16BIT ENVOY_GetEfifoStreamingCfgReal (TXC_U16BIT handle, TXC_U16BIT port,
           ENVOY_EFIFO_STREAMING_CFG_STRUCT  *eFifoStreamDataPtr);

TXC_U16BIT ENVOY_SetFifoPortCtrlReal (TXC_U16BIT handle, TXC_U16BIT port,
           ENVOY_FIFO_PORT_CTRL_STRUCT  *fifoPortCtrlPtr);

TXC_U16BIT ENVOY_GetFifoPortCtrlReal (TXC_U16BIT handle, TXC_U16BIT port,
           ENVOY_FIFO_PORT_CTRL_STRUCT  *fifoPortCtrlPtr);

TXC_U16BIT ENVOY_RtrvFifoPortStatisticsReal (TXC_U16BIT handle, TXC_U16BIT port,
           ENVOY_FIFO_PORT_STATISTICS_STRUCT *fifoPortStatisticsDataPtr);

TXC_U16BIT ENVOY_RtrvFifoStatusReal (TXC_U16BIT handle, TXC_U16BIT port,
           ENVOY_FIFO_STATUS_STRUCT *fifoStatusDataPtr);


#endif /* NOT TXC_ENVOY_VIRTUAL_DEVICE_MODE */

 /****************************************************************************
 **                              End of Module                             **
 ****************************************************************************/

#endif /* TXC_ENVOY_FIFO_SUPPORT_H */