bitlib.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".
 *
 **********************************************************************/

/*
modification history
--------------------
01a,10oct04,rcd  Created.
*/

/*
This file contains the Built-In Test API for the dy4182 board.
*/

#ifndef	__INCbitLibh
#define	__INCbitLibh

#include "vxWorks.h"
#include "h/drv/dy4/ssError_fwx.h"
#include "h/drv/dy4/fwCard_fwx.h"
#include "h/drv/dy4/fwBit_fwx.h"
#include "h/drv/dy4/ssResults_fwx.h"

/* compiler switches */
#ifdef __cplusplus
extern "C"
{
#endif


/*Function Header*************************************************************
 *
 *  CSU Name     : bitGetPbitDrtHandle
 *
 *  Description  : Get entry point to the PBit results table.
 *
 *  Inputs       : None
 *
 *  Output       : None
 *
 *  Return:      : pDrt - pointer to a PBit results table.
 *
 *  Comments     : None
 *
 *END******************************************************************/
sFW_DRT* bitGetPbitDrtHandle();



/*Function Header*************************************************************
 *
 *  CSU Name     : bitGetBitNumFails
 *
 *  Description  : returns number of IBIT or PBIT failures in a DRT
 *
 *  Inputs       :  pDrt - pointer to a PBit results table.
 *
 *  Return:      : number of failures
 *                 or 0 if none
 *                 or -1 if error
 *
 *  Comments     : None
 *
 *END******************************************************************/
int bitGetBitNumFails(sFW_DRT *pDrt);



/*Function Header*************************************************************
 *
 * bitInvokeIbit
 *
 * Description  :
 *       Execute BITs in passed in Diagnostic Sequence Table (DST).
 *
 * Inputs       :
 *   void         pDst        start address DST
 *   BOOLEAN      contOnFail  Continue tests if failure flag
 *   void         pDrt        Start addr of DRT for test results
 *
 * Return Value : FW_OK, FW_ERROR, or FW_BADINPUT.
 *
 * Comments     :
 *
 *
 *********************************************************************/
eFW_RTCODE bitInvokeIbit
(
 sFW_DST_ENTRY *pDst,
 const BOOLEAN   contOnFail,
 sFW_DRT * pDrt
);



/*Function Header*************************************************************
*  bitDrtInit
*
*  Description     : Initialize header of specified Diagnostic Result Table
*                    (DRT) area for test results storage.
*
*  Input value(s)  :
*       Type             Name       I/O  Description
*   =============== =============== ===  ======================
*   sFW_DRT       pDrt            In   Start address of DRT.
*   UINT32    maxDrtEntries   In   Max. number of entries allowed
*                                        
*  Return Value    : None.
*
*  Comments/Notes  : maxDrtEntries also includes the header entry.
*                  
**End Function Header *******************************************************/

void bitDrtInit
(
const  sFW_DRT       *pDrt,
const UINT32      maxDrtEntries
);



/*Function Header*************************************************************
 *
 *  bitPbitShow
 *
 *  Description  : Displays the BIT Results Table PBIT
 *
 *  Inputs       : True or False
 *
 *  Return:      : None
 *
 *  Comments     : None
 *
 *END******************************************************************/
void bitPbitShow (BOOLEAN showDetails);



/*Function Header*************************************************************
 *
 *  CSU Name     : bitIbitShow
 *
 *  Description  : Displays the IBIT Results Table
 *
 *  Inputs       :
 *       sFW_DRT : Start address of DRT.
 *       Bool    : True or False
 *  Return:      : None
 *
 *  Comments     : None
 *
 *END******************************************************************/
void bitIbitShow ( sFW_DRT *pDrt, BOOLEAN showDetails);

/*Function Header*************************************************************
 *
 *  CSU Name     : bitGetTestName
 *
 *  Description  : looks up the test handle in test name struct
 *                 and returns address of string containing name.
 *
 *  Inputs       : test handle
 *
 *  Return:      : ptr to string containing test name
 *
 *  Comments     : None
 *
 *END******************************************************************/
char *bitGetTestName(eFW_TEST_HANDLE testHandle);

/*Function Header*************************************************************
 *
 *  CSU Name     : bitGetDeviceName
 *
 *  Description  : looks up the device handle in device name struct
 *                 and returns address of string containing name.
 *
 *  Inputs       : device handle
 *
 *  Return:      : ptr to string containing device name
 *
 *  Comments     : None
 *
 *END******************************************************************/
char *bitGetDeviceName(eFW_DEVICE_HANDLE deviceHandle);





#ifdef __cplusplus
}
#endif

#endif  /* _BITLIB_H_ */