byucc.jhdl.platforms.util.readback
Interface NativeReadBackInterface

All Known Subinterfaces:

NativeReadWriteBackInterface

public interface NativeReadBackInterface

This interface must be implemented to use the readback-related classes in this package. The interface has two methods, one to actually provide the readback bitstream as a Java byte array and another which allows a ReadBackData object to locate arbitrary Cell objects in a design. This interface also defines two constants used for returning the success or failure of the native methods.

Author:

Paul Graham

Field Summary

static int	RB_FAILURE Constant indicating the failure of an operation
static int	RB_SUCCESS Constant indicating the success of an operation

Method Summary

Cell	findJhdlCell(java.lang.String cellName) This method finds a JHDL Cell based on its full name and returns a reference to that Cell, if it is found.
int	nativeReadBackPE(int peNum, byte[] bitstream) This method returns a raw readback bitstream in a byte array format.

Field Detail

RB_FAILURE

public static final int RB_FAILURE

Constant indicating the failure of an operation

See Also:

Constant Field Values

RB_SUCCESS

public static final int RB_SUCCESS

Constant indicating the success of an operation

See Also:

Constant Field Values

Method Detail

nativeReadBackPE

public int nativeReadBackPE(int peNum,
                            byte[] bitstream)

This method returns a raw readback bitstream in a byte array format. The byte array must be allocated before being passed in as a parameter.

Parameters:

peNum - This indicates the number of the PE which is to be sampled. The numbering of PEs used by the ReadBackManager and ReadBackData objects starts with zero.

bitstream - The array of byte which is filled with the bitstream information. The length of the bitstream array is determined by the ReadBackData object via the header of the .rbentry file.

Returns:

The method should return RB_FAILURE if the operation failed, otherwise, RB_SUCCESS should be returned.

findJhdlCell

public Cell findJhdlCell(java.lang.String cellName)

This method finds a JHDL Cell based on its full name and returns a reference to that Cell, if it is found. Otherwise, a null is returned.

Parameters:

cellName - The full, hierarchal name of a JHDL Cell.

Returns:

A reference to the JHDL Cell is returned, if found in the current HWSystem; otherwise, a null is returned.