txc_envoy_mgmt_port_api.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_mgmt_port_api.h                                             
                                                                           
  Description:  This header file contains the defines and prototypes      
                for the management MII port.         
                                                                           
 --------------------------------------------------------------------------
                              Revision History                            
 --------------------------------------------------------------------------
  Rev #       Date            Author             Description               
  -----       ------          -------            -----------               
   0.5.0    6/03/04      F. Giannella         Initial release (beta)
 *--------------------------------------------------------------------------*/




#ifndef TXC_ENVOY_MGMT_PORT_API_H
#define TXC_ENVOY_MGMT_PORT_API_H


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

/* these defines are used by all MAC functions */

/* these defines are used by TXC_ENVOY_SetMacPhyMgmt & TXC_ENVOY_GetMacPhyMgmt */
#define ENVOY_MAC_MAX_PHY_ADDR     31
#define ENVOY_MAC_MAX_PHY_REG      31


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

/* enumerated data types & structures */

typedef enum
{  
    ENVOY_MGMT_PORT_CLK_DIV4 = 0,
    ENVOY_MGMT_PORT_CLK_DIV6,
    ENVOY_MGMT_PORT_CLK_DIV8,
    ENVOY_MGMT_PORT_CLK_DIV10,
    ENVOY_MGMT_PORT_CLK_DIV14,
    ENVOY_MGMT_PORT_CLK_DIV20,
    ENVOY_MGMT_PORT_CLK_DIV28,
    ENVOY_MGMT_PORT_END_OF_CLK_DIV_ENUM,
    ENVOY_MGMT_PORT_CLK_DIV_ENUM_ERR = 0xFFFE

} ENVOY_MGMT_PORT_CLK_DIV_ENUM;


typedef struct
{  
    ENVOY_MGMT_PORT_CLK_DIV_ENUM    mgmtClockDivideMode;

} ENVOY_MGMT_PORT_CFG_STRUCT;


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

TXC_U16BIT TXC_ENVOY_MgmtPortReset (TXC_U16BIT handle);


TXC_U16BIT TXC_ENVOY_MgmtPortConfigSet(TXC_U16BIT handle, 
                                       ENVOY_MGMT_PORT_CFG_STRUCT  *mgmtPortDataPtr);


TXC_U16BIT TXC_ENVOY_MgmtPortConfigGet(TXC_U16BIT handle, 
                                       ENVOY_MGMT_PORT_CFG_STRUCT  *mgmtPortDataPtr);


TXC_U16BIT TXC_ENVOY_MgmtPortPhyRegPoke (TXC_U16BIT handle, TXC_U16BIT phyAddr,
                                         TXC_U16BIT phyReg, TXC_U16BIT phyData);


TXC_U16BIT TXC_ENVOY_MgmtPortPhyRegPeek (TXC_U16BIT handle, TXC_U16BIT phyAddr,
                                         TXC_U16BIT phyReg, TXC_U16BIT *phyDataPtr);


/****************************************************************************
 **                       Callback Function Typedef                        **
 ****************************************************************************/

/* none */


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

#endif /* TXC_ENVOY_MGMT_PORT_API_H */