bkcompat.h

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

/******************************************************************
* Function : Ixf6048GetOhBytes
*-----------------------------------------------------------------
* Description  : Gets Overhead Bytes: Rx MST, Rx HPM
*-----------------------------------------------------------------
* Inputs  : pChipData : Initialized Chip Data
*			section : Determines the section(block) to get the bytes
*			SelOhBytes : Selects the Overhead Bytes 
* Outputs : pOhBytes : place to put Overhead Bytes, of type:
bb_RxMstBytes_t, or ixf6048_RxHpmBytes_t
*-----------------------------------------------------------------
* Returns : 
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : 
******************************************************************/
extern bb_Error_e
Ixf6048GetOhBytes(bb_ChipData_t* pChipData, bb_ChipSegment_t *section,
				 bb_SelOhBytes_e SelOhBytes, void* pOhBytes);

/******************************************************************
* Function : Ixf6048Reset
*-----------------------------------------------------------------
* Description  : Reset (chip or a section of the chip) and then 
*				 reconfigure 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 : 
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : 
******************************************************************/
extern bb_Error_e 
Ixf6048Reset(bb_ChipData_t* pChipData, bb_ChipSegment_t *section,
			 bb_SelResetType_e resetType);

#if 0
/******************************************************************
* Function : Ixf6048CfgTest
*-----------------------------------------------------------------
* Description  : Run Tests
*-----------------------------------------------------------------
* Inputs  : pChipData : Validated Chip Data
*				testType : The type of test to run.
* Outputs : None.
*-----------------------------------------------------------------
* Returns : 
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : 
******************************************************************/
extern bb_Error_e
Ixf6048CfgTest(bb_ChipData_t* pChipData, bb_ChipSegment_t *section, 
               bb_TestType_e testType, void *ptTestCfg);

/******************************************************************
* Function : Ixf6048SetAlarmCfg
*-----------------------------------------------------------------
* 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 : 
*-----------------------------------------------------------------
* Returns : 
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : 
******************************************************************/
extern bb_Error_e 
Ixf6048SetAlarmCfg(bb_ChipData_t* pChipData, bb_ChipSegment_t *section,
				  bb_AlarmType_e AlarmType, void* pAlarmCfg);
#endif

/******************************************************************
* Function : Ixf6048Read
*-----------------------------------------------------------------
* 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 : 
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : 
******************************************************************/
extern bb_Error_e 
Ixf6048Read(bb_ChipData_t* pChipData, bb_Word_Size_t wordSize,
				  ulong address, ushort length, void *buffer);

/******************************************************************
* Function : Ixf6048Write
*-----------------------------------------------------------------
* 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 : 
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : 
******************************************************************/
extern bb_Error_e 
Ixf6048Write(bb_ChipData_t* pChipData, bb_Word_Size_t wordSize,
				   ulong address, ushort length, void *buffer);

#if 0
/******************************************************************
* Function : Ixf6048GetBuildVersion
*-----------------------------------------------------------------
* Description  : This routine returns the firmware build version of 
*                the ixf6192 driver.
*-----------------------------------------------------------------
* Inputs  : pChipData : Validated Chip Data
* Outputs : drvName : Null terminated string describing the driver
*           date : The build date of the driver.
*           buildVer : The version number of the driver.
*           buildRev : The revision number of the driver.
*-----------------------------------------------------------------
* Returns : bb_Error_e  Returns Error Condition if Not successful
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : None.
******************************************************************/
extern bb_Error_e 
Ixf6048GetBuildVersion(bb_ChipData_t* pChipData, char* drvName,
                       char *date, ushort *buildVer, ushort *buildRev);
#endif

/******************************************************************
* Function : Ixf6048GetLCDFilter
*-----------------------------------------------------------------
* Description  : This routine will retrieve the LCD Filter value.
*-----------------------------------------------------------------
* Inputs  : pChipData : Validated Chip Data
*			section : Determines the section(channel) to get the value.
* Outputs : value : The LCD value.
*-----------------------------------------------------------------
* Returns : Status;
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : 
******************************************************************/
extern bb_Error_e 
Ixf6048GetLCDFilter(bb_ChipData_t* pChipData, bb_ChipSegment_t *section,
                    void *value);

/******************************************************************
* Function : Ixf6048SetLCDFilter
*-----------------------------------------------------------------
* Description  : This routine will retrieve the LCD Filter value.
*-----------------------------------------------------------------
* Inputs  : pChipData : Validated Chip Data
*			section : Determines the section(channel) to get the value.
*           value : The LCD value.
* Outputs : None.
*-----------------------------------------------------------------
* Returns : Status;
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : 
******************************************************************/
extern bb_Error_e 
Ixf6048SetLCDFilter(bb_ChipData_t* pChipData, bb_ChipSegment_t *section,
                    void *value);

#if 0
/******************************************************************
* Function : Ixf6048InitAllocMemory
*-----------------------------------------------------------------
* Description  : This routine dynamically allocates memory within
*				 the "pChipData" parameter for those members that 
*				 need dynamic allocation.
*-----------------------------------------------------------------
* Inputs  : pChipData : A pointer to the chip data structure without 
*						pointers memory allocation.
* Outputs : pChipData : A pointer to the chip data structure with 
*						pointer memory allocation.
*-----------------------------------------------------------------
* Returns : 
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : See IxfApiInit for the completion of the initialization
******************************************************************/
extern bb_Error_e 
Ixf6048InitAllocMemory(bb_ChipData_t *pChipData);

/******************************************************************
* Function : Ixf6048DeAllocMemory
*-----------------------------------------------------------------
* Description  : This routine frees the dynamically allocated memory
*				 within the "pChipData" structure
*-----------------------------------------------------------------
* Inputs  : pChipData : A pointer to the chip data structure.
* Outputs : None.
*-----------------------------------------------------------------
* Returns : Status
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : None.
******************************************************************/
extern bb_Error_e 
Ixf6048DeAllocMemory(bb_ChipData_t *pChipData);
#endif

/******************************************************************
* Function : Ixf6048InitChip
*-----------------------------------------------------------------
* Description  : This routine commits the internal register table
*                down to the chip and initializes the bb_ChipData_t
*                structure.
*-----------------------------------------------------------------
* Inputs  : pChipData	: A pointer to an allocated structure.
*           pTable : Table to be committed to the device.
* Outputs : None.
*-----------------------------------------------------------------
* Returns : bb_Error_e  Returns Error Condition if Not successful
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
******************************************************************/
extern bb_Error_e 
Ixf6048InitChip(bb_ChipData_t* pChipData, InitRegTable_t *pTable);

/******************************************************************
* Function : Ixf6048GetWindowSize
*-----------------------------------------------------------------
* Description  : Gets the window size for clear and setting 
*                Degraded B2 error.
*-----------------------------------------------------------------
* Inputs  : pChipData : Initialized Chip Data
*           section   : Determines the section(block) to get the
*  						window size from.
*           mode      : The clearing/setting mode.
* Outputs : value  : Window size value.
*-----------------------------------------------------------------
* Returns : Status
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : None.
******************************************************************/
extern bb_Error_e 
Ixf6048GetWindowSize(bb_ChipData_t* pChipData, bb_ChipSegment_t *section,
                     bb_WindowSizeMode_e mode, ulong* value);

/******************************************************************
* Function : Ixf6048SetWindowSize
*-----------------------------------------------------------------
* Description  : Sets the window size for clear and setting 
*                Degraded B2 error.
*-----------------------------------------------------------------
* Inputs  : pChipData : Initialized Chip Data
*           section   : Determines the section(block) to set the
*  						window size.
*           mode      : The clearing/setting mode.
*           value     : Window size value.
* Outputs : None.
*-----------------------------------------------------------------
* Returns : Status
*-----------------------------------------------------------------
* Access Globals : None.
*-----------------------------------------------------------------
* Comments : None.
******************************************************************/
extern bb_Error_e 
Ixf6048SetWindowSize(bb_ChipData_t* pChipData, bb_ChipSegment_t *section,
                     bb_WindowSizeMode_e mode, ulong value);

/******************************************************************
* Function : Ixf6048SetOpMode
*-----------------------------------------------------------------
* 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 
Ixf6048SetOpMode(bb_ChipData_t *pChipData, bb_ChipSegment_t *section,
                bb_OperMode_e opMode, void *pModeCfg);

#endif   /* _BKCOMPAT_H_ */