devlib.h

开发Inetl IXP2400平台所必须的硬件诊断和测试程序。该软件包支持的功能包括CPU基本功能检测

/* 
 *---------------------------------------------------------------------------
 *                                                                      
 *                  I N T E L   P R O P R I E T A R Y                   
 *                                                                      
 *     COPYRIGHT (c)  2001 BY  INTEL  CORPORATION.  ALL RIGHTS          
 *     RESERVED.   NO  PART  OF THIS PROGRAM  OR  PUBLICATION  MAY      
 *     BE  REPRODUCED,   TRANSMITTED,   TRANSCRIBED,   STORED  IN  A    
 *     RETRIEVAL SYSTEM, OR TRANSLATED INTO ANY LANGUAGE OR COMPUTER    
 *     LANGUAGE IN ANY FORM OR BY ANY MEANS, ELECTRONIC, MECHANICAL,    
 *     MAGNETIC,  OPTICAL,  CHEMICAL, MANUAL, OR OTHERWISE,  WITHOUT    
 *     THE PRIOR WRITTEN PERMISSION OF :                                
 *                                                                      
 *                        INTEL  CORPORATION                            
 *                                                                     
 *                     2200 MISSION COLLEGE BLVD                        
 *                                                                      
 *               SANTA  CLARA,  CALIFORNIA  95052-8119                  
 *                                                                      
 *---------------------------------------------------------------------------
 *
 *
 *   AUTHOR:         $Author: lagarwal $
 *   DATE:           $Date: 2003/08/06 20:58:19 $
 *   LAST MODIFIED:  $Modtime: 5/14/02 4:12p $
 *   REV#:           $Revision: 1.3 $
 *   LOGFILE:        $Logfile: /Embedded/source/drivers/ixf/devlib.h $
 *   WORKFILE:       $Workfile: devlib.h $
 *
 * --------------------------------------------------------------------------
 * Project: ALL
 *
 * Purpose: Defines the function pointers for the device libraries.
 *          The function pointers depeneds on the bb_ChipType_e type
 *          numbering.
 *          
 * Notes:
 *          
 * --------------------------------------------------------------------------
 * CompilerFlags: 
 * --------------------------------------------------------------------------
 * --------------------------------------------------------------------------
 *   $Log: devlib.h,v $
 *   Revision 1.3  2003/08/06 20:58:19  lagarwal
 *   no message
 *
 *   Revision 1.2  2003/01/29 00:04:33  lagarwal
 *   no message
 *
 *   Revision 1.1.1.1  2002/11/15 17:51:11  lagarwal
 *   rename dir
 *
 *   Revision 1.4  2002/09/09 21:49:20  cmah1
 *   no message
 *
 *   Revision 1.2  2002/08/07 17:30:50  machambe
 *   no message
 *
 *   Revision 1.1  2002/05/22 00:05:41  machambe
 *   Initial update
 *
 * 
 * 48    5/14/02 4:14p Machambe
 * Added InitChip 2nd Param.
 * 
 * 47    5/03/02 1:34p Srodrig1
 * 
 * 46    4/24/02 2:03p Rcordova
 * Code changes for debugging  generic driver code
 * 
 * 45    4/24/02 10:39a Srodrig1
 * 
 * 44    4/18/02 11:31a Jaalliso
 * Fixing parameter type for GetOpMode
 * 
 * 43    4/17/02 2:07p Srodrig1
 * 
 * 42    4/16/02 2:43p Jaalliso
 * Renaming ixf_api_xgmac include files
 * 
 * 41    4/15/02 4:53p Jaalliso
 * Removing #if 0 code
 * 
 * 40    4/03/02 9:49a Machambe
 * Taking out unnecessary include header files for IXF6192
 * 
 * 39    2/14/02 4:04p Rcordova
 * Added Ixf16121 pointers and adding 2 new functions to the ixf6192.
 * 
 * 38    2/13/02 2:00p Rcordova
 * 
 * 37    2/07/02 5:04p Skadrix
 * Added a section (ChipSegment) parameter to the TestCfg API function.
 * Added a new API function  - IxfApiSetBERThreshold
 * 
 * 36    1/19/02 2:41p Machambe
 * 
 * 35    1/15/02 2:23p Rsood
 * 
 * 34    1/02/02 5:44p Machambe
 * Taking XgmacFunctionPointers_t out of #if 0
 * 
 * 33    12/12/01 4:04p Machambe
 * Added IxfApiMapframe related functions.
 * 
 * 32    12/05/01 3:26p Pkjain2
 * 
 * 31    12/05/01 2:36p Srodrig1
 * 
 * 30    12/04/01 4:22p Pkjain2
 * 
 * 29    11/29/01 4:46p Srodrig1
 * 
 * 28    11/28/01 12:03p Machambe
 * 
 * 27    11/18/01 10:48p Machambe
 * 
 * 26    11/16/01 8:44p Pkjain2
 * moved data structures to devlib.c
 * 
 * 25    11/15/01 6:40p Machambe
 * 
 * 24    11/14/01 3:08p Rsood
 * 
 * 23    11/14/01 2:06p Machambe
 * Changing the chip to device relationship
 * 
 * 22    11/09/01 4:29p Jaalliso
 * Debugging shadow directory stuff.  Added blank space to line 1
 * 
 * 21    11/09/01 2:07p Pkjain2
 * 
 * 20    11/06/01 2:01p Pkjain2
 * 
 * 19    8/02/01 9:38a Rfranz
 * adding support for Calypso
 * All changes made withing 'INCLUDE_18100_LIB' blocks, so this doesn't 
 * affect other devices.
 * 
 * 18    7/20/01 9:11a Machambe
 * Adding IxfApiGetBuildVersion
 * 
 * 17    7/03/01 4:09p Machambe
 * 
 * 16    6/25/01 10:54a Machambe
 * 
 * 15    6/18/01 4:10p Machambe
 * 
 * 14    6/11/01 4:11p Machambe
 * 
 * 13    5/18/01 5:03p Machambe
 * Uncommenting ixf6048 pointers
 * 
 * 12    5/03/01 3:54p Machambe
 * 
 * --------------------------------------------------------------------------
 */ 

#ifndef __DEVLIB_H_ /* Include file contents only once per compilation */
#define __DEVLIB_H_



/* Common API related include's */
#include "common_types.h"
#include "common_def.h"
#include "ixf_api_d.h" /* General data structures for entire API */
#include "ixf_api_sonet_d.h" /* Sonet related data structures */
#include "ixf_api_ether_d.h"

#ifdef INCLUDE_6192_LIB
/* IXF6192 related include's */
#include "ixf6192f.h" /* Prototypes for the IXF6192 */
#endif

#ifdef INCLUDE_18100_LIB
#include "ixf18100.h"
#include "ixf18100_sonet_d.h"
#include "ixf18100_sonet.h"
#include "ixf18100_xgmac.h"
#endif

#ifdef INCLUDE_6048_LIB
/* IXF6048 related include's */
#include "bkcompat.h"
#endif

#ifdef INCLUDE_16121_LIB
/* IXF16121 related include's */
#include "ixf16121_global_b.h" /* Bit definitions for IXF16121 */
#include "ixf16121_global_interrupts_b.h" /* Bit definitions for IXF16121 */
#include "ixf16121_hpt_b.h" /* Bit definitions for IXF16121 */
#include "ixf16121_msa_b.h" /* Bit definitions for IXF16121 */
#include "ixf16121_rmst_b.h" /* Bit definitions for IXF16121 */

#include "ixf16121.h" /* Prototypes for the IXF16121 */
#include "ixf16121_d.h" /* Data definitions for IXF16121 */
#include "ixf16121_cnfg_d.h"
#include "ixf16121_counters_d.h"
#include "ixf16121_jn_trace_d.h"
#include "ixf16121_oht_d.h"
#include "ixf16121_tests_d.h"
#include "ixf16121_ber_d.h"
#include "ixf16121_cnfg.h"
#include "ixf16121_counters.h"
#include "ixf16121_jn_trace.h"
#include "ixf16121_oht.h"
#include "ixf16121_tests.h"
#include "ixf16121_ber.h"
#endif

#ifdef INCLUDE_GENERIC_LIB
#include "genericdriver.h"  /*Prototypes for the Generic */
#endif

/* The types below define the common api prototypes */
typedef bb_Error_e (*IxfInitChip_t)(bb_ChipData_t *pChipData,
                                    InitRegTable_t *pTable);

typedef bb_Error_e (*IxfAllocMem_t)(bb_ChipData_t *pChipData);

typedef bb_Error_e (*IxfDeAllocMem_t)(bb_ChipData_t *pChipData);

typedef bb_Error_e (*IxfGetStatus_t)(bb_ChipData_t *pChipData,
                                     bb_ChipSegment_t *section,
                                     bb_SelStatus_e selStatus,
                                     void *pStatus);