txc_envoy_drv_mgmt_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_drv_mgmt_api.h                                       
                                                                          
  Description:  This header file contains typedefs, structure definitions 
  and prototypes for the layer management apis.                                 
                                                                           
 --------------------------------------------------------------------------
                              Revision History                             
 --------------------------------------------------------------------------
    Rev       Date          Author               Description
   -----    -------      ------------         -----------------
   0.5.0    6/03/04      F. Giannella         Initial release (beta)
 *--------------------------------------------------------------------------*/



#ifndef TXC_ENVOY_LMGMT_API_H
#define TXC_ENVOY_LMGMT_API_H


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

/* none */


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

/* this structure is used by TXC_ENVOY_StartDriver */
typedef struct
{
    TXC_VOID_PTR reserved;      /* future use. */

} ENVOY_START_DRIVER_STRUCT;

/* this structure is used by TXC_ENVOY_RegisterDevice */
typedef struct
{
    TXC_VOID_PTR baseAddr;      /* User supplied device base address. */
    TXC_U16BIT   handle;        /* Handle returned by device driver,from 0 to ENVOY_MAX_DEVICES-1 */

} ENVOY_REGISTER_DEVICE_STRUCT;



/* these enumerated data type & structure is used by TXC_ENVOY_DeviceReset */
typedef enum {

    ENVOY_DEV_RESET_WITHOUT_INIT = 0,
    ENVOY_DEV_RESET_WITH_INIT,
    ENVOY_END_OF_DEV_RESET_ENUM,
    ENVOY_DEV_RESET_ENUM_ERR= 0xFFFE

} ENVOY_DEV_RESET_ENUM;


typedef struct
{
    ENVOY_DEV_RESET_ENUM resetType; /* This parameter selects the type of device reset */

} ENVOY_DEV_RESET_STRUCT;


/* this structure is used by TXC_ENVOY_DriverVersion */
typedef struct
{
    TXC_U16BIT  majorVersion;       /* Driver Major Version Number. */
    TXC_U16BIT  minorVersion;       /* Driver Minor Version Number. */
    TXC_U16BIT  patchVersion;       /* Driver Patch Version Number. */

} ENVOY_DRIVER_VERSION_STRUCT;


/* this structure is used by TXC_ENVOY_DeviceVersion */
typedef struct
{
    TXC_U16BIT  partNumber;     /* Envoy JTAG # 06840      */
    TXC_U16BIT  manufId;        /* TXC Manufacturer ID 107 */
    TXC_U16BIT  version;        /* Device specific version number. */

} ENVOY_DEVICE_VERSION_STRUCT;

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

TXC_U16BIT TXC_ENVOY_StartDriver
    (ENVOY_START_DRIVER_STRUCT *startdriverDataPtr);

TXC_U16BIT TXC_ENVOY_TerminateDriver(void);

TXC_U16BIT TXC_ENVOY_RegisterDevice
    (ENVOY_REGISTER_DEVICE_STRUCT *registerDeviceDataPtr);

TXC_U16BIT TXC_ENVOY_UnregisterDevice(TXC_U16BIT handle);

TXC_U16BIT TXC_ENVOY_DeviceReset
    (TXC_U16BIT handle, 
    ENVOY_DEV_RESET_STRUCT *deviceResetType);

TXC_U16BIT TXC_ENVOY_DriverVersion
    (ENVOY_DRIVER_VERSION_STRUCT *driverVersionDataPtr);

TXC_U16BIT TXC_ENVOY_DeviceVersion
    (TXC_U16BIT handle,
    ENVOY_DEVICE_VERSION_STRUCT *deviceVersionDataPtr);



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

#endif /* TXC_ENVOY_LMGMT_API_H */