com.xilinx.rapidwright.bitstream

Class Frame

Object

com.xilinx.rapidwright.bitstream.Frame

public class Frame
extends Object

Represents a configuration frame (part of a configuration block)

Since:

2020.2.1

See Also:

Block

Constructor Summary

Constructors

Constructor and Description
Frame(Series series, int address) Creates a new configuration frame based on the provides series and address

Method Summary

Modifier and Type	Method and Description
boolean	copyWords(Frame frame) Copies all frame data into this frame.
int	getAddress() Gets the frame address within the configuration.
int	getBit(int index) Gets the bit value at the specified index within the frame.
List<BitLocation>	getDiff(Frame otherFrame) Examines another frame for differences and reports them as a list of BitLocation objects.
Series	getSeries() Gets the series based on the number of word allocated in the frame.
int[]	getWords() Gets the linear array of integer words where the bits of the frame data are stored.
static int	getWordsPerFrame(Series series) Gets the number of words in a frame of the provided Series
boolean	isBitIndexECC(int bitIdx) Checks if the current bit index corresponds to an ECC bit
void	setAddress(int address) Sets the frame address for this frame.
boolean	setBit(int index, int value) Sets the bit at the provided index to the specified value.
void	setWords(int[] words) Updates the linear array of integer words in the frame.
void	toggleBit(int index) Toggles or flips the bit stored at the location index within the frame.
String	toString()
String	toString(boolean printData) Creates a formatted string of the frame and optionally data in the frame (hex words)
void	updateECCBits() Updates the ECC bits based on the current frame contents

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Frame

public Frame(Series series,
             int address)

Creates a new configuration frame based on the provides series and address

Parameters:

series - The series to use to template the frame (appropriate size, etc)

address - The address to which this frame corresponds

Since:

2020.2.1

Method Detail

getWordsPerFrame

public static int getWordsPerFrame(Series series)

Gets the number of words in a frame of the provided Series

Parameters:

series - The Series of interest

Returns:

The number of words (32-bit integers) in a frame of the specified Series.

Since:

2020.2.1

getWords

public int[] getWords()

Gets the linear array of integer words where the bits of the frame data are stored.

Returns:

Words of the frame

Since:

2020.2.1

setWords

public void setWords(int[] words)

Updates the linear array of integer words in the frame.

Parameters:

words - The desired words to be stored in the frame

Since:

2020.2.1

copyWords

public boolean copyWords(Frame frame)

Copies all frame data into this frame.

Parameters:

frame - The source frame from which to copy the data.

Returns:

True if the operation was successful, false otherwise.

Since:

2021.1.1

getAddress

public int getAddress()

Gets the frame address within the configuration.

Returns:

The frame address of this frame.

Since:

2020.2.1

setAddress

public void setAddress(int address)

Sets the frame address for this frame.

Parameters:

address - The address to set for this frame

Since:

2020.2.1

setBit

public boolean setBit(int index,
                      int value)

Sets the bit at the provided index to the specified value.

Parameters:

index - Index of the desired bit to set.

value - The desired value (0 or 1) to set.

Returns:

True if the bit value changed, false otherwise

Since:

2020.2.1

toggleBit

public void toggleBit(int index)

Toggles or flips the bit stored at the location index within the frame.

Parameters:

index - Index of the bit to flip.

Since:

2020.2.1

getBit

public int getBit(int index)

Gets the bit value at the specified index within the frame.

Parameters:

index - Index of the desired bit

Returns:

The bit value (0 or 1).

Since:

2020.2.1

getSeries

public Series getSeries()

Gets the series based on the number of word allocated in the frame.

Returns:

The targeted series of the frame.

Since:

2020.2.1

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean printData)

Creates a formatted string of the frame and optionally data in the frame (hex words)

Parameters:

printData - flag indicating if the frame data should be added to the String

Returns:

The formatted string representation of the frame

Since:

2020.2.1

updateECCBits

public void updateECCBits()

Updates the ECC bits based on the current frame contents

Since:

2020.2.1

isBitIndexECC

public boolean isBitIndexECC(int bitIdx)

Checks if the current bit index corresponds to an ECC bit

Parameters:

bitIdx - The desired bit index to query

Returns:

True if the bit index is an ECC bit, false otherwise

Since:

2020.2.1

getDiff

public List<BitLocation> getDiff(Frame otherFrame)

Examines another frame for differences and reports them as a list of BitLocation objects.

Parameters:

otherFrame - The other frame to check against

Returns:

A list of bits that differ between this frame and otherFrame

Since:

2023.2.2