byucc.jhdl.platforms.util.hwi
Class HardwareControlInterface

java.lang.Object
  byucc.jhdl.platforms.util.hwi.HardwareControlInterface

Direct Known Subclasses:

DummyPlug, NetworkHardwareControl

public class HardwareControlInterface

extends java.lang.Object

Constructor Summary

HardwareControlInterface()

Method Summary

int	close() Closes the board.
void	finalize()
int	freeRunClock(int clock) Free runs the specified clock.
int	getMemory(int set, int memory, int address, int length, byte[][] data) Gets the contents of the specified memory.
int	getMemoryWidth(int set, int memory) Returns the width of the specified memory element.
int	getRegister(int set, int register, byte[] data) Returns the width of the specified memory element.
int	getRegisterWidth(int set, int register) Returns the width of the specified memory element.
int	open() Opens the board.
int	program(int fpga, byte[] data) Programs the specified FPGA.
int	readback(int fpga, byte[] data) Readbacks the state of the specified FPGA.
int	setClockFrequency(int clock, float freq) Sets the frequency of the specified clock.
int	setMemory(int set, int memory, int address, int length, byte[][] data) Sets the contents of the specified memory.
int	setRegister(int set, int register, byte[] data) Returns the width of the specified memory element.
int	stepClock(int clock, int steps) Steps the specified hardware clock the given number of cycles.
int	stopClock(int clock) Stops the specified free-running clock.
int	writeback(int fpga, byte[] data) Writeback the state of a circuit.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HardwareControlInterface

public HardwareControlInterface()

Method Detail

open

public int open()

Opens the board.

close

public int close()

Closes the board.

stepClock

public int stepClock(int clock,
                     int steps)

Steps the specified hardware clock the given number of cycles.

Parameters:

clock - Clock number.

steps - Number of steps to perform.

setClockFrequency

public int setClockFrequency(int clock,
                             float freq)

Sets the frequency of the specified clock.

Parameters:

clock - Clock number.

freq - Frequency to which the clock will be set.

freeRunClock

public int freeRunClock(int clock)

Free runs the specified clock.

Parameters:

clock - Clock number.

stopClock

public int stopClock(int clock)

Stops the specified free-running clock.

Parameters:

clock - Clock number.

program

public int program(int fpga,
                   byte[] data)

Programs the specified FPGA.

Parameters:

data - Programming data.

readback

public int readback(int fpga,
                    byte[] data)

Readbacks the state of the specified FPGA.

Parameters:

fpga - FPGA to readback.

data - Byte array to fill with the readback data.

writeback

public int writeback(int fpga,
                     byte[] data)

Writeback the state of a circuit.

Parameters:

fpga - FPGA to which data will be written.

data - Data to write back to device.

getMemoryWidth

public int getMemoryWidth(int set,
                          int memory)

Returns the width of the specified memory element.

Parameters:

set - Memory set.

memory - Memory number in the specified memory set.

setMemory

public int setMemory(int set,
                     int memory,
                     int address,
                     int length,
                     byte[][] data)

Sets the contents of the specified memory.

Parameters:

set - Memory set.

memory - Memory number in the specified memory set.

address - Address at which the data will start to be written.

length - Number of addresses to be written.

data - Data to be written to the memory.

getMemory

public int getMemory(int set,
                     int memory,
                     int address,
                     int length,
                     byte[][] data)

Gets the contents of the specified memory.

Parameters:

set - Memory set.

memory - Memory number in the specified memory set.

address - Address at which the data will start to be read.

length - Number of addresses to be read.

data - Byte[] to which data will be written.

getRegisterWidth

public int getRegisterWidth(int set,
                            int register)

Returns the width of the specified memory element.

Parameters:

set - Register set.

setRegister

public int setRegister(int set,
                       int register,
                       byte[] data)

Returns the width of the specified memory element.

Parameters:

set - Register set.

data - Data to be written to the register.

getRegister

public int getRegister(int set,
                       int register,
                       byte[] data)

Returns the width of the specified memory element.

Parameters:

set - Register set.

data - Byte[] to which the register data will be written.

finalize

public void finalize()