ixf_api.h

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

******************************************************************/
extern bb_Error_e 
IxfApiGetOpMode(bb_ChipData_t *pChipData, bb_ChipSegment_t *section,
                bb_OperMode_e *opMode, void *pModeCfg); 
#endif

/******************************************************************
* Function : IxfApiSetOpMode
*-----------------------------------------------------------------
* Description  : Sets the operation mode of the chip.
*-----------------------------------------------------------------
* Inputs  : pChipData : Initialized Chip Data
*           section   : Determines the section(block) to get the
*                       status from.
*           opMode    : The mode of operation.
*           pModeCfg  : place to put mode.
* Outputs : None.
*-----------------------------------------------------------------
* Returns : bb_Error_e  Returns Error Condition if Not successful
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : None.
******************************************************************/
extern bb_Error_e 
IxfApiSetOpMode(bb_ChipData_t *pChipData, bb_ChipSegment_t *section,
                bb_OperMode_e opMode, void *pModeCfg);

/******************************************************************
* Function : IxfApiReset
*-----------------------------------------------------------------
* Description  : Reset (chip or a section of the chip) and then 
*                reconfigures it. To restart traffic, the chip or 
*                section of chip must be set back online
*-----------------------------------------------------------------
* Inputs  : pChipData  : Initialized Chip Data
*           section    : Determines the section(block) to reset
*           resetType  : Specifies type of Reset
* Outputs : None.
*-----------------------------------------------------------------
* Returns : bb_Error_e : Returns Error Condition if Not successful
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : None.
******************************************************************/
extern bb_Error_e 
IxfApiReset(bb_ChipData_t *pChipData, bb_ChipSegment_t *section,
            bb_SelResetType_e resetType);

#if 0
/******************************************************************
* Function : IxfApiInitAlarmCallback
*-----------------------------------------------------------------
* Description : Initialize the Driver
*-----------------------------------------------------------------
* Inputs  : pChipData      : Validated Chip Data
*           pAlarmCallback : Alarm Callback
* Outputs : None.
*-----------------------------------------------------------------
* Returns : bb_Error_e  Returns Error Condition if Not successful
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : None.
******************************************************************/
extern bb_Error_e 
IxfApiInitAlarmCallback(bb_ChipData_t *pChipData, AlarmCallBack pAlarmCallbackArg);

/******************************************************************
* Function : IxfApiChipIsr
*-----------------------------------------------------------------
* Description  : Handle Interupts for Chip
*-----------------------------------------------------------------
* Inputs  : pChipData : Validated Chip Data
* Outputs : None.
*-----------------------------------------------------------------
* Returns : None.
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : None.
******************************************************************/
extern void
IxfApiChipIsr(bb_ChipData_t *pChipData);

/******************************************************************
* Function : IxfApiGetChipInfo
*-----------------------------------------------------------------
* Description  : Get the chip information.
*-----------------------------------------------------------------
* Inputs  : pChipData : Validated Chip Data
* Outputs : pChipInfo : Place to return chip info
*-----------------------------------------------------------------
* Returns : 
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : 
******************************************************************/
extern bb_Error_e 
IxfApiGetChipInfo(bb_ChipData_t *pChipData, bb_ChipInfo_t *pChipInfo);

/******************************************************************
* Function : IxfApiCfgTest
*-----------------------------------------------------------------
* Description  : Run Tests
*-----------------------------------------------------------------
* Inputs  : pChipData : Validated Chip Data
*           section : Determines the section(block) to run the
*                     test for.
*           testType : The type of test to run.
*           pTestCfg : Contains the test configuration data.
* Outputs : None.
*-----------------------------------------------------------------
* Returns : 
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : 
******************************************************************/
extern bb_Error_e
IxfApiCfgTest(bb_ChipData_t *pChipData, bb_ChipSegment_t *section,
              bb_TestType_e testType, void *pTestCfg);

/******************************************************************
* Function : IxfApiGetCounters
*-----------------------------------------------------------------
* Description  : Retrieve a set of Counters
*-----------------------------------------------------------------
* Inputs  : pChipData   : Validated Chip Data
*           section     : Determines the section(block) to get the
*                         counters from.
*           SelCounters : Selects the set of counters
* Outputs : pCounters   : Place to put Counters
*-----------------------------------------------------------------
* Returns : bb_Error_e  : Returns Error Condition if Not successful
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : 
******************************************************************/
extern bb_Error_e 
IxfApiGetCounters(bb_ChipData_t *pChipData, bb_ChipSegment_t *section, 
                  bb_SelCounters_e SelCounters, void *pCounters);

/******************************************************************
* Function : IxfApiSetChipOnline
*-----------------------------------------------------------------
* Description  : Puts some or all of the chip online.
*-----------------------------------------------------------------
* Inputs  : pChipData : Validated Chip Data
*          section    : Specifies which portion of the chip to 
*                       put online.
* Outputs : None.
*-----------------------------------------------------------------
* Returns : bb_Error_e:  Returns Error Condition if Not successful
*-----------------------------------------------------------------
* Access Globals : None. 
*-----------------------------------------------------------------
* Comments : None.
******************************************************************/
extern bb_Error_e 
IxfApiSetChipOnline(bb_ChipData_t *pChipData, bb_ChipSegment_t *section);

/******************************************************************
* Function : IxfApiSetChipOffline
*-----------------------------------------------------------------
* Description  : Takes some or all of the chip offline.
*-----------------------------------------------------------------
* Inputs  : pChipData  : Validated Chip Data
*          section     : Specifies which portion of the chip to 
*                        take offline.
* Outputs : None.
*-----------------------------------------------------------------
* Returns : bb_Error_e  Returns Error Condition if Not successful
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : None.
******************************************************************/
extern bb_Error_e 
IxfApiSetChipOffline(bb_ChipData_t *pChipData, bb_ChipSegment_t *section);

/******************************************************************
* Function : IxfApiSetAlarmCfg
*-----------------------------------------------------------------
* Description  : Edits Interrupt Enabled Masks for a Specific Set
*                of Interrupts.
*-----------------------------------------------------------------
* Inputs  : pChipData : Validated Chip Data
*          section    : Determines the section(block) of the alarm(s)
*                       to edit.
*          AlarmType  : Specifies the type of Alarm
*          pAlarmCfg  : A pointer to the alarm structure.
* Outputs : None.
*-----------------------------------------------------------------
* Returns : bb_Error_e  Returns Error Condition if Not successful
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : None.
******************************************************************/
extern bb_Error_e 
IxfApiSetAlarmCfg(bb_ChipData_t *pChipData, bb_ChipSegment_t *section,
                  bb_AlarmType_e AlarmType, void *pAlarmCfg);
#endif

/******************************************************************
* Function : IxfApiGenericRead
*-----------------------------------------------------------------
* Description  : This routine will read starting at a particular 
*                location and read for N number of words.
*-----------------------------------------------------------------
* Inputs  : pChipData  : Validated Chip Data
*          wordSize    : Identifies the size of a word.
*          address     : Location where to start reading from.
*          length      : Number of words to read.
* Outputs : buffer     : The buffer to contain the read data.
*-----------------------------------------------------------------
* Returns : bb_Error_e  Returns Error Condition if Not successful
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : None.
******************************************************************/
extern bb_Error_e 
IxfApiGenericRead(bb_ChipData_t *pChipData, bb_Word_Size_t wordSize,
                  ulong address, ushort length, void *buffer);                        

/******************************************************************
* Function : IxfApiGenericWrite
*-----------------------------------------------------------------
* Description  : This routine will write starting at a particular 
*                      location and write for N number of words.
*-----------------------------------------------------------------
* Inputs  : pChipData  : Validated Chip Data
*          wordSize    : Identifies the size of a word.
*          address     : Location where to start writing to.
*          length      : Number of words to write.
*          buffer      : The buffer to contain the read data.
* Outputs : None.
*-----------------------------------------------------------------
* Returns : bb_Error_e  Returns Error Condition if Not successful
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : None.
******************************************************************/
extern bb_Error_e 
IxfApiGenericWrite(bb_ChipData_t *pChipData, bb_Word_Size_t wordSize,
                   ulong address, ushort length, void *buffer);                        

#endif   /* _IXF_FUNC_H_ */