sserror_fwx.h

Curtiss-Wright Controls Embedded Computing公司的cw183板bsp源代码

/**********************************************************************
 *
 *   Copyright (c) 2004, Dy 4 Systems All rights reserved.
 *   This Source Code is the Property of Dy 4 Systems Inc. and
 *   can only be used in accordance with Source Code License
 *   Agreement of Dy 4 Systems Inc. dba (doing business as) 
 *   CURTISS-WRIGHT CONTROLS EMBEDDED COMPUTING, "CWCEC". 
 *
 **********************************************************************/

/*FILE HEADER*****************************************************************
 *  Product Name:   BSP demo code
 *
 *  %name:          ssError_fwx.h %
 *
 *  Description:    Contains prototypes for error related functions.
 *
 *  %created_by:     tissa %
 *  %date_created:   Tue Sep 30 2004 %
 * 
 *  Notes:
 *          
 *  History:
 *     01c, 18jul05, tis updated based on the fwx file ssError.h version fwx145_2 
 *     01b, 18jan05, tis updated based on the fwx file ssError.h version fwx145.1
 *     01a, 30sep04, tis created based on the fwx file ssError.h version 9
 *
 *END FILE HEADER*************************************************************/

#ifndef _FW_ERROR_H_
#define _FW_ERROR_H_

#ifdef __cplusplus
extern "C"
{
#endif

/*---------------------------------------------------------------------------*/
/* constant definition */


/* FW error types */
typedef enum 
{

    FW_PASS = 0,
    FW_FAIL,                  /* 1- general failure */
    FW_BIT_NOT_SUPPORTED,     /* 2- test not supported */
    FW_BIT_NOTRUN,            /* 3- test code did not get run */
    FW_CBOOT_FAIL,            /* 4- CBOOT check failed */ 
    FW_TOGGLE_FAIL,           /* 5- register bit failed change:1=reg addr,2=bit mask,3=read value */
    FW_TOGGLE_RESTORE_FAIL,   /* 6- register bit not restored:1=reg addr,2=bit mask,3=read value */
    FW_RESET_VALUE_FAIL,      /* 7- register bit not value at reset:1=reg addr,2=exp. */
                              /*    mask,3=act.mask,4=reg size */
    FW_BAD_INPUT,             /* 8- Bad input parameter received, 1,2,3,4=bad parameter(s) */
    FW_SIGNATURE_FAIL,        /* 9- Signature in data/code mismatch,1=exp. sig.,2=actual sig.*/
    FW_VERSION_FAIL,          /* 10- Version in data/code mismatch,1=exp. version,2=actual version*/
    FW_CSUM_CHECK_FAIL,       /* 11- Incorrect checksum found,1=exp. CS,2=actual CS */
    FW_DEVICE_ID_FAIL,        /* 12- Device/Vendor ID mismatch, 1=expected D/V ID,2=actual D/V ID */
    FW_DATA_CONVERG_FAIL,     /* 13- data convergence test failed */
    FW_INTERRUPT_NOT_RECEIVED, /* 14- expected interrupt did not occur, 1=vector */
    FW_INTERRUPT_UNEXPECTED,  /* 15- unexp. interrupt, 1=expected vector,2=actual vector/status */
    FW_ILLEGAL_INT_VECTOR,    /* 16- Illegal interrupt vector specified, 1=vector number */
    FW_TOO_MANY_INTERRUPTS,   /* 17- More interrupts than expected,1=vector,2=int count,3=address(opt) */
    FW_MEMORY_SIZE_UNEXPECTED,/* 18- Required memory size error,1=required size,2=actual size */
    FW_ILLEGAL_DEVICE_CONFIG, /* 19- Illegal device coonfiguration */
    FW_DATA_COMPARE_FAIL,     /* 20- 1=address, 2=read value, 3 = expected value, 4=size */
    FW_CONVERGENCE_FAIL,      /* 21- 1= stuck at bit errors, 2 = short/open bit errors, 
                                     3= suspect bit errors (if short/open bit error was short),
                                     4=N/A */
    FW_DEVICE_UNAVAIL,        /* 22- Requested device has bad device status, 1=device status */
    FW_DEVICE_HANDLE_NOT_FOUND, /* 23- Requested device handle illegal, 1=max. device handle ID */
    FW_DEVICE_NOT_IN_PCI_TREE, /* 24- Device not found in PCI tree database, 1=last tree index */
    FW_DEVICE_TABLE_OVERFLOW, /* 25- Device Table too small to add entry, 1 = required # entries */
    FW_DEVICE_BAD_PARITY,     /* 26- Bad parity found for device, 1=value read for parity check */
    FW_NOT_IN_DEVICE_SPACE,   /* 27- Requested operation not inside device memory,
                                     1=value read for parity check */
    FW_DEVICE_TIME_OUT,       /* 28- Timed-out waiting for device,1=port address,2=device data/vector,
                                     3=channel(opt) */
    FW_DEVICE_IO_ERROR,       /* 29- I/O error occurred,1=port address,2=device status/vector,3=channel(opt) */
    FW_DEVICE_RECEIVE_ERROR,  /* 30- Wrong number bytes received,1=channel/addr,2=exp.count,3=actual count */
    FW_DEVICE_TRANSMIT_ERROR, /* 31- Wrong number bytes transmitted,1=channel/addr,2=exp.count,3=actual count */

    FW_TIMER_UNAVAIL,         /* 32- timer not available, 1=timer number,2=timer status */
    FW_TIMER_UNEXPECTED_VALUE,/* 33- timer has unexp. value,1=timer number,2=exp.value,3=actual value */
    FW_TIMER_STOPPED_EARLY,   /* 34- timer timed-out too early,1=timer number,2=timer status */
    FW_TIMER_NO_STOP,         /* 35- timer did not time-out,1=timer number,2=timer status */
    FW_DEVICE_PROTECTED,      /* 36- Device is write-protected, no extra info */
    FW_ECC_ERROR_NOT_CORRECTED,/* 37- Correctable error not corrected,1=address,2=exp.value,3=actual value,*/
                              /*      4=value stored */
    FW_ECC_WRONG_ERROR,       /* 38- ECC wrong type of error logged,1=test address,2=exp.error,3=act.error,*/
                              /*     4=corr/uncorr error flag (1=correctable,0=uncorrectable) */
    FW_ECC_WRONG_CORRUPT,     /* 39- ECC wrong corrupted value in high/low error data,1=test address, */
                              /*     2=exp.corrupted value,3=act.corrupted value,*/
                              /*     4=corr/uncorr error flag (1=correctable,0=uncorrectable) */
    FW_ECC_WRONG_ADDRESS,     /* 40- ECC wrong address logged for error,1=exp.address,2=act.address, */
                              /*     4=corr/uncorr error flag (1=correctable,0=uncorrectable) */

    /* add more FW_ERROR above this line */
    eFW_ERROR_END

} eFW_ERROR;


/* FW routine call return values. */
typedef enum 
{
    FW_OK,                                /* function completed normally    */
    FW_UNIMPLEMENTED,                     /* service not supported          */
    FW_ERROR,                             /* error while attempting to
                                               execute service                */
    FW_BADINPUT,                          /* input parameters out of range  */
    /* add more eFW_RTCODE above this line */
    eFW_RTCODE_END

} eFW_RTCODE;

/*---------------------------------------------------------------------------*/
/* data structure */

typedef struct
{
    eFW_ERROR     errorCode;      /* failure identifier code */
    UINT32    uResultData1;   /* supplemental failure data */
    UINT32    uResultData2;   /* supplemental failure data */
    UINT32    uResultData3;   /* supplemental failure data */
    UINT32    uResultData4;   /* supplemental failure data */
} sFW_ERROR;      


#ifdef _cplusplus
}
#endif

#endif  /* _FW_ERROR_H_ */