zl5011xerror.h

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

/*******************************************************************************
*
*  File name:              zl5011xError.h
*
*  Version:                39
*
*  Author:                 MRC
*
*  Date created:           22/02/2002
*
*  Copyright 2002, 2003, 2004, 2005, Zarlink Semiconductor Limited.
*  All rights reserved.
*
*  Module Description:
*
*  Header file contains the error codes for function calls.
*
*  Revision History:
*
*  Rev:  Date:       Author:  Comments:
*  1     22/02/2002  MRC      Creation
*  2     28/02/2002  MRC      Update
*  3     04/04/2002  MRC      Added GM error code
*  4     04/04/2002  MRC      Fixed compile error
*  5     16/04/2002  MRC      Changed Authur to Author in the header
*  6     19/04/2002  MRC      Added error codes for use in TFQ
*  7     30/04/2002  MRC      Added some initialisation error codes
*  8     07/05/2002  MRC      Update
*  9     09/05/2002  MRC      Added BIST error code - for MM
*  10    13/05/2002  MRC      Added error codes for PKC
*  11    14/05/2002  MRC      Added error codes for WAN queue initialisation
*  12    07/06/2002  MRC      Added error codes for granule chain checks
*  13    13/06/2002  MRC      Added error codes for PKC
*  14    27/06/2002  MRC      Added error codes for packet routines
*  15    12/07/2002  MRC      Added RTP interrupt error code
*  16    31/07/2002  MRC      Added packet size error code
*  17    06/08/2002  MRC      Added packet Rx filtering error codes and removed
*                             some duplicate codes
*  18    02/09/2002  MRC      Tidied up error codes
*  19    12/09/2002  MRC      Added extra mutex codes
*  20    19/09/2002  ARW      Added extra code for DMA failure
*  21    19/09/2002  ARW      Added extra codes for NULL pointer & invalid
*                             Booleans
*  22    04/10/2002  ARW      Removed DMA error codes no longer used
*  23    22/10/2002  MRC      Added Lan port error code
*  24    23/10/2002  MRC      Added parameter check error codes
*  25    30/10/2002  MRC      Added unknown device code
*  26    31/10/2002  MRC      Added variants + minor fixes
*  27    12/11/2002  MRC      Added task error codes
*  28    13/11/2002  MRC      Added codes for DMA and interrupt status
*  29    18/12/2002  PJE      Added eval code
*  30    29/01/2003  MRC      Added interrupt not running error code
*  31    14/02/2003  MRC      Added socket error code
*  32    05/03/2003  MRC      Added error code for packet fns
*  33    05/03/2003  MRC      Added generic RTOS error code
*  34    04/08/2003  APL      Added error if API and device type mismatch
*  35    11/08/2003  MRC      Added ZL5011X_CHANNEL_INVALID
*  36    06/09/2004  APL      Renamed _INVALID_MAC_TYPE to _INVALID_PORT_CONFIG
*  37    21/01/2005  MRC      Added error code ZL5011X_CHANNEL_CAPACITY
*  38    07/02/2005  APL      Added timing API error codes
*  39    24/02/2005  MRC      Added error code and tidied up
*
*******************************************************************************/

#ifndef _ZL5011X_ERROR_H
#define _ZL5011X_ERROR_H

#ifdef __cplusplus
extern "C" {
#endif

/* zl Error Codes */
typedef enum
{
   /* Successful completion */
   ZL5011X_OK,

   /* Generic error */
   ZL5011X_ERROR,

   /* general return value for enum out of range  */
   ZL5011X_PARAMETER_INVALID,

   /* generic errors */
   ZL5011X_INVALID_MODE,
   ZL5011X_INVALID_POINTER,
   ZL5011X_MULTIPLE_INIT_ATTEMPT,
   ZL5011X_NOT_RUNNING,
   ZL5011X_STATISTICS_NOT_ENABLED,
   ZL5011X_TIMEOUT,
   ZL5011X_UNKNOWN_DEVICE_ID,

   /* initialisation failures */
   ZL5011X_LAN_NOT_INIT,
   ZL5011X_MEMORY_NOT_INIT,
   ZL5011X_NOT_INIT,
   ZL5011X_PACKET_MEMORY_FAIL,
   ZL5011X_WAN_NOT_INIT,
   ZL5011X_WAN_QUEUE_NOT_INIT,

   /* Wan configuration errors */
   ZL5011X_CHANNEL_CAPACITY,
   ZL5011X_CHANNEL_IN_USE,
   ZL5011X_CHANNEL_INVALID,
   ZL5011X_CHANNEL_NOT_IN_CTXT,
   ZL5011X_CHANNEL_RANGE,
   ZL5011X_CONTEXT_IN_TEARDOWN,
   ZL5011X_CONTEXT_IN_UPDATE,
   ZL5011X_CONTEXT_IN_USE,
   ZL5011X_CONTEXT_NOT_ACTIVE,
   ZL5011X_CONTEXT_NOT_IN_INIT,
   ZL5011X_CONTEXT_NOT_IN_TEARDOWN,
   ZL5011X_CONTEXT_NOT_IN_UPDATE,
   ZL5011X_CONTEXT_NOT_IN_USE,
   ZL5011X_CONTEXT_NOT_TAKEN,
   ZL5011X_CONTEXT_TAKEN,
   ZL5011X_CONTEXT_TEARDOWN_COMPLETE,
   ZL5011X_CONTEXT_UNUSED,
   ZL5011X_CONTEXT_UPDATE_COMPLETE,
   ZL5011X_CONTEXTID_RANGE,
   ZL5011X_CTXT_NO_CHANNELS,
   ZL5011X_LAST_CHANNEL_IN_CONTEXT,
   ZL5011X_STREAM_IN_USE,
   ZL5011X_STREAM_RANGE,
   ZL5011X_WAN_INVALID_FIRST_CHANNEL,
   ZL5011X_WAN_QUEUE_IN_FLUSH,
   ZL5011X_WAN_QUEUE_IN_RESUME,
   ZL5011X_WAN_QUEUE_LENGTH_BUSY,

   /* lan errors */
   ZL5011X_INVALID_PORT,
   ZL5011X_INVALID_PORT_CONFIG,
   ZL5011X_PHY_READ_FAIL,
   ZL5011X_PHY_WRITE_FAIL,

   /* error codes associated with Rx packet matching */
   ZL5011X_CLASSIFY_MATCH_IN_USE,
   ZL5011X_FILTER_MATCH_IN_USE,
   ZL5011X_PROTOCOL_MATCH_IN_USE,
   ZL5011X_NO_AVAIL_CLASSIFY_MATCH,
   ZL5011X_NO_AVAIL_FILTER_MATCH,
   ZL5011X_NO_AVAIL_PROTOCOL_MATCH,

   /* error codes for the packet construction functions */
   ZL5011X_PAYLOAD_SIZE_ERROR,
   ZL5011X_PKT_HEADER_IN_CONTEXT_USE,
   ZL5011X_PKT_HEADER_IN_USE,
   ZL5011X_PKT_HEADER_SIZE_ERROR,
   ZL5011X_PKT_INCOMPATIBLE_HEADER_ERROR,
   ZL5011X_PKT_INVALID_MATCH_NUM,
   ZL5011X_PKT_RX_CTXT_ERROR,

   /* error codes associated with the granule manager */
   ZL5011X_DESCRIPTOR_ADDRESS,
   ZL5011X_DESCRIPTOR_AVAIL_MEMORY,
   ZL5011X_GRANULE_ADDRESS,
   ZL5011X_GRANULE_CHAIN_ERROR,
   ZL5011X_NUM_FREE_GRANULES_ERROR,

   /* DMA errors */
   ZL5011X_DMA_INIT_FAIL,
   ZL5011X_DMA_QUEUE_NOT_INIT,
   ZL5011X_DMA_QUEUE_ALREADY_INIT,
   ZL5011X_DMA_QUEUE_FAIL,
   ZL5011X_DMA_BUFFERS_FULL,
   ZL5011X_DMA_NO_PACKET,
   ZL5011X_DMA_INVALID_POINTER,
   ZL5011X_DMA_RUNNING,

   /* interrupt errors */
   ZL5011X_INTERRUPTS_RUNNING,
   ZL5011X_INTERRUPT_NOT_RUNNING,
   ZL5011X_RTP_INTERRUPT_ERROR,

   /* packet routing errors */
   ZL5011X_INVALID_FLOW_TYPE,

   /* RTOS semaphore errors */
   ZL5011X_RTOS_SEMA4_CREATE_FAIL,
   ZL5011X_RTOS_SEMA4_DELETE_FAIL,
   ZL5011X_RTOS_SEMA4_TAKE_FAIL,
   ZL5011X_RTOS_SEMA4_NOT_CREATED,
   ZL5011X_RTOS_SEMA4_GIVE_FAIL,

    /* RTOS message queue errors */
   ZL5011X_RTOS_MSGQ_CREATE_FAIL,
   ZL5011X_RTOS_MSGQ_DELETE_FAIL,

  /* RTOS task errors */
   ZL5011X_RTOS_TASK_CREATE_FAIL,
   ZL5011X_RTOS_TASK_DELETE_FAIL,

   /* RTOS failed to alllocate memory */
   ZL5011X_RTOS_MEMORY_FAIL,

   /* RTOS error code for failed socket operations */
   ZL5011X_RTOS_SOCKET_FAIL,

   /* RTOS general purpose failure code*/
   ZL5011X_RTOS_FAIL,

   /* evaluation board error code */
   ZL5011X_E_BOARD_ERROR,

   /* A mismatch detected between this API version and the device in used */
   ZL5011X_API_AND_DEVICE_MISMATCH,

   /* timing API errors */
   ZL5011X_SLAVE_TIMING_STREAM_PARAMS_INVALID,
   /*2004/2/26  added by Zhengqis*/
   ZL5011X_DEVICE_HAVE_BEEN_INIT,
   ZL5011X_ERROR_SLOT_NUM

} zlStatusE;


#ifdef __cplusplus
}
#endif

#endif