byucc.jhdl.platforms.util.hwi
Interface HardwareControlInterfaceStub

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

RemoteHardwareControl

public interface HardwareControlInterfaceStub

extends java.rmi.Remote

Method Summary

int	close() Closes the board.
void	finalize()
int	freeRunClock(int clock) Free runs the specified clock.
RemoteDataReturn	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.
RemoteDataReturn	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.
RemoteDataReturn	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.

Method Detail

open

public int open()
         throws java.rmi.RemoteException

Opens the board.

Throws:

java.rmi.RemoteException

close

public int close()
          throws java.rmi.RemoteException

Closes the board.

Throws:

java.rmi.RemoteException

stepClock

public int stepClock(int clock,
                     int steps)
              throws java.rmi.RemoteException

Steps the specified hardware clock the given number of cycles.

Parameters:

clock - Clock number.

steps - Number of steps to perform.

Throws:

java.rmi.RemoteException

setClockFrequency

public int setClockFrequency(int clock,
                             float freq)
                      throws java.rmi.RemoteException

Sets the frequency of the specified clock.

Parameters:

clock - Clock number.

freq - Frequency to which the clock will be set.

Throws:

java.rmi.RemoteException

freeRunClock

public int freeRunClock(int clock)
                 throws java.rmi.RemoteException

Free runs the specified clock.

Parameters:

clock - Clock number.

Throws:

java.rmi.RemoteException

stopClock

public int stopClock(int clock)
              throws java.rmi.RemoteException

Stops the specified free-running clock.

Parameters:

clock - Clock number.

Throws:

java.rmi.RemoteException

program

public int program(int fpga,
                   byte[] data)
            throws java.rmi.RemoteException

Programs the specified FPGA.

Parameters:

data - Programming data.

Throws:

java.rmi.RemoteException

readback

public RemoteDataReturn readback(int fpga,
                                 byte[] data)
                          throws java.rmi.RemoteException

Readbacks the state of the specified FPGA.

Parameters:

fpga - FPGA to readback.

data - Byte array to fill with the readback data.

Throws:

java.rmi.RemoteException

writeback

public int writeback(int fpga,
                     byte[] data)
              throws java.rmi.RemoteException

Writeback the state of a circuit.

Parameters:

fpga - FPGA to which data will be written.

data - Data to write back to device.

Throws:

java.rmi.RemoteException

getMemoryWidth

public int getMemoryWidth(int set,
                          int memory)
                   throws java.rmi.RemoteException

Returns the width of the specified memory element.

Parameters:

set - Memory set.

memory - Memory number in the specified memory set.

Throws:

java.rmi.RemoteException

setMemory

public int setMemory(int set,
                     int memory,
                     int address,
                     int length,
                     byte[][] data)
              throws java.rmi.RemoteException

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.

Throws:

java.rmi.RemoteException

getMemory

public RemoteDataReturn getMemory(int set,
                                  int memory,
                                  int address,
                                  int length,
                                  byte[][] data)
                           throws java.rmi.RemoteException

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.

Throws:

java.rmi.RemoteException

getRegisterWidth

public int getRegisterWidth(int set,
                            int register)
                     throws java.rmi.RemoteException

Returns the width of the specified memory element.

Parameters:

set - Register set.

Throws:

java.rmi.RemoteException

setRegister

public int setRegister(int set,
                       int register,
                       byte[] data)
                throws java.rmi.RemoteException

Returns the width of the specified memory element.

Parameters:

set - Register set.

data - Data to be written to the register.

Throws:

java.rmi.RemoteException

getRegister

public RemoteDataReturn getRegister(int set,
                                    int register,
                                    byte[] data)
                             throws java.rmi.RemoteException

Returns the width of the specified memory element.

Parameters:

set - Register set.

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

Throws:

java.rmi.RemoteException

finalize

public void finalize()
              throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException