txc_error.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 Header File                       |
|--------------------------------------------------------------------|
|                                                                    |
|  Workfile:  txc_error.h                                            |
|                                                                    |
|  Description: This file contains TranSwitch error code definitions.|
|                                                                    |
|             DO NOT EDIT THIS FILE                                  |
|                                                                    |
----------------------------------------------------------------------

                           Revision History
----------------------------------------------------------------------
Rev #   Date        Author          Description
-----   ------      -------         -----------
1.0     06-Feb-01   R.Ruchandani    Initial Revision.
2.0     10-Aug-01   Preeti Singh    Modified the error code values to 
                                    align them with PHAST3. And added 
                                    point 8 in the NOTES to explain the
                                    changes
3.0     24-Aug-01   Preeti Singh    1. Added error code TXC_DEVICE_RESET_ERR
                                    2. Corrected the values of 
                                        TXC_DEVICE_WRITE_ERR, TXC_GEN_ERR &
                                        TXC_BPOOL_ERR
                                    3. Changed the file organisation such 
                                       that the error code are in sequence
3.1     18-Oct-02   Roger Kuhnen    Added following defines:
                                    TXC_NO_EXTRACT_CELL_AVAIL, TXC_FIRMWARE_CHKSUM_ERR,
                                    TXC_FIRMWARE_IRAM_TEST_FAIL_ERR
3.2     18-Noc-02   Roger Kuhnen    Removed following defines:
                                    TXC_NO_EXTRACT_CELL_AVAIL, TXC_FIRMWARE_CHKSUM_ERR,
                                    TXC_FIRMWARE_IRAM_TEST_FAIL_ERR
---------------------------------------------------------------------*/

/* NOTES
    1 - All error codes are unsigned 16 bits.
    
    2 - If the function preformed with out any error an TXC_NO_ERR code (value = 0)
        is returned.
    
    3 - The scheme here is 0x0000 to 0x00BF are general error. Error starting from 0x0000 
        to 0x00BF and incrementing are the most general error and are used by all drivers. 
        Not all error codes are used by all drivers. 
    
    4 - The error codes from 0x00C0 and incrementing are error codes for drivers whose device have an embedded 
        risc processor.
    
    5 - The error codes from 0x00FF and decrementing are error codes relative to message 
        based devices.
    
    6 - Any technology specific error code will start at 0x0100 and increment, except for 
        internal status.
    
    7 - Internal Status start at 0xFFFF and decrement. These are never returned via API.

    8 - Exception to the above scheme are TXC_FIRMWARE_DOWNLOAD_ERR, TXC_PROCESSOR_BUSY_ERR &
        TXC_FIRMWARE_FAILURE_ERR. These error codes apply on the devices with embedded processors, 
        but their values lies in the range of general errors. This has been done for backward 
        compatibility with existing error codes.
    
*********************************************************************************************/
        

    
#ifndef TXC_ERROR_H
#define TXC_ERROR_H

/* The function worked as described  */
#define TXC_NO_ERR                          0x0000

/* The function worked as planned, but a warning occurred.  A good example is detaching a 
    detached device.  The end results is the device is attached, but no code was 
    executed expect for a database check */
#define TXC_WARNING                         0x0001

/* The user passed in an unknown handle */
#define TXC_INVALID_HANDLE_ERR              0x0002

/* The user passed in an unknown parameter in the argument list */
#define TXC_INVALID_PARM_ERR                0x0003

/* The is a configuration error */
#define TXC_INVALID_CFG_ERR                 0x0004

/* The supplied base address has been already allociated */
#define TXC_DEVICE_INIT_ERR                 0x0005

/* the total number of devices the driver supports has been reached */
#define TXC_EXCEED_MAX_DEVICE_ERR           0x0006

/* a call to the user supplied OS failed */
#define TXC_OS_RESOURCE_ERR                 0x0007

/* there was not a device at the base address supplied */
#define TXC_DEVICE_NOT_FOUND_ERR            0x0008

/* deleting a driver with devices still created.  Also, in the case of the
    messaged-based drivers, deleting the base driver with device driver 
    still active */
#define TXC_DRIVER_BUSY_ERR                 0x0009

/* the specific device driver was not created */
#define TXC_DRIVER_NOT_CREATED_ERR          0x000A

/* THIS ERROR CODE APPLY ONLY TO DEVICE WITH EMBEDDED RISC PROCESSORS */
/* the down load process failed */
#define TXC_FIRMWARE_DOWNLOAD_ERR           0x000B

/* a device feature in a multi-device driver in not supported in that specific device */
#define TXC_INVALID_FEATURE_ERR             0x000C

/* NEXT TWO ERROR CODES APPLY ONLY TO DEVICE WITH EMBEDDED RISC PROCESSORS */
/* the processor did not reply (handshake) in proper time or sequence */
#define TXC_PROCESSOR_BUSY_ERR              0x000D

/* something failed in the firmware */
#define TXC_FIRMWARE_FAILURE_ERR            0x000E

/* an invalid channel was received. Channel could be DS1, E1, or instance of 
    multi-device module (ie. single L3M in a TL3M) */
#define TXC_INVALID_CHANNEL_ERR             0x000F

/* an invalid DS0 or E1-Time slot was received. Applies only to DS0 granularity devices */ 
#define TXC_INVALID_TSLOT_ERR               0x0010

/* the write to a register did not readback correctly applies only to direct-register
    based devices */    
#define TXC_DEVICE_WRITE_ERR                0x0011

/* a general error */
#define TXC_GEN_ERR                         0x0012

/* an memory allocation issue with the internal buffer pools */
#define TXC_BPOOL_ERR                       0x0013

/* a reset to the device failed */
#define TXC_DEVICE_RESET_ERR                0x0014

/* new error codes (F. Giannella) */

#define TXC_INCOMPATIBLE_FULL_DPLX_ERR      0x001F

#define TXC_INCOMPATIBLE_HALF_DPLX_ERR      0x0020

#define TXC_INVALID_FLOW_CTRL_MODE          0x0021



/* THESE ERROR CODES APPLY ONLY TO DEVICE WITH EMBEDDED RISC PROCESSORS */




/* THESE ERROR CODES APPLY ONLY TO DRIVERS THAT EMPLOY MESSAGING-BASED INTERFACES,
    AND NOT DIRECT REGISTER ACCESS */
    
/* attempting to delete a message-based while attached */
#define TXC_DEVICE_BUSY_ERR                 0x00FA

/* message-based devices must be attached to establish communication */
#define TXC_DEVICE_NOT_ATTACHED_ERR         0x00FB
    
/* message base device support more than 1 device driver */
#define TXC_EXCEED_MAX_DRIVER_ERR           0x00FC

/* A non-timeout transportation error (i.e CRC error) */
#define TXC_MSG_FAIL_ERR                    0x00FD

/* reply did not come back in time */
#define TXC_MSG_TIMEOUT_ERR                 0x00FE

/* the base driver, which creates the message-based software, was not created */
#define TXC_BASE_DRIVER_NOT_CREATED_ERR     0x00FF



/* Envoy-CE2/CE4 device specific error codes */

#define TXC_INVALID_IFACE_ID_ERR            0x0100
#define TXC_AGGR_DISABLED_WARNING           0x0101
#define TXC_MII_MGMT_BUSY_ERR               0x0102


/* Envoy-CE2/CE4 device specific warnings */
#define TXC_PHY_LAYER_WARNING               0x0200
#define TXC_LINK_LAYER_WARNING              0x0201
#define TXC_OSPI_PACKET_MODE_WARNING        0x0202


/* INTERNAL STATUS, NEVER RETURNED TO THE USER */

#define TXC_OS_RESOURCE_EMPTY_STAT          0xFFFD
#define TXC_OS_TIMEOUT_STAT                 0xFFFE
#define TXC_FATAL_STAT                      0xFFFF

#endif /* TXC_ERROR_H */