com.xilinx.rapidwright.bitstream

Class BitstreamHeader

Object

com.xilinx.rapidwright.bitstream.BitstreamHeader

public class BitstreamHeader
extends Object

Represents the header of a bitstream file (.bit). This includes everything up to and including the sync word.

Since:

2020.2.1

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	BUS_WIDTH_AUTO_DETECT1
static byte[]	BUS_WIDTH_AUTO_DETECT2
static byte[]	DUMMY_WORD
static byte[]	INIT_HEADER
static byte[]	SYNC_WORD Common SYNC word, terminates a header

Method Summary

Modifier and Type	Method and Description
String	getDate() Gets the recorded 'date created' from the bitstream header
String	getDesignName() Gets the design name as stored in the bitstream header
String	getOptions() Gets the options used as stored in the bitstream header
String	getPartName() Gets the part name as stored in the bitstream header
String	getTime() Gets the recorded 'time created' time stamp as stored in the bitstream header
boolean	isSeries7() Convenience method to check if this bitstream targets a Series 7 device
void	setDate(String date) Sets the recorded 'date created' in the bitstream header
void	setDesignName(String designName) Gets the design name as stored in the bitstream header
void	setOptions(String options) Sets the options used as stored in the bitstream header
void	setPartName(String partName) Sets the part name as stored in the bitstream header
void	setTime(String time) Sets the recorded 'time created' time stamp as stored in the bitstream header

Methods inherited from class Object

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

Field Detail

SYNC_WORD

public static final byte[] SYNC_WORD

Common SYNC word, terminates a header

INIT_HEADER

public static final byte[] INIT_HEADER

DUMMY_WORD

public static final byte[] DUMMY_WORD

BUS_WIDTH_AUTO_DETECT1

public static final byte[] BUS_WIDTH_AUTO_DETECT1

BUS_WIDTH_AUTO_DETECT2

public static final byte[] BUS_WIDTH_AUTO_DETECT2

Method Detail

isSeries7

public boolean isSeries7()

Convenience method to check if this bitstream targets a Series 7 device

Returns:

True if the device is from the series 7 set of devices, false otherwise

Since:

2020.2.1

getDesignName

public String getDesignName()

Gets the design name as stored in the bitstream header

Returns:

The design name

Since:

2020.2.1

getOptions

public String getOptions()

Gets the options used as stored in the bitstream header

Returns:

The options used

Since:

2020.2.1

setDesignName

public void setDesignName(String designName)

Gets the design name as stored in the bitstream header

Parameters:

designName - The new design name

Since:

2020.2.1

setOptions

public void setOptions(String options)

Sets the options used as stored in the bitstream header

Parameters:

options - The desired option string to set

Since:

2020.2.1

getPartName

public String getPartName()

Gets the part name as stored in the bitstream header

Returns:

The part name

Since:

2020.2.1

setPartName

public void setPartName(String partName)

Sets the part name as stored in the bitstream header

Parameters:

partName - The desired part name

Since:

2020.2.1

getDate

public String getDate()

Gets the recorded 'date created' from the bitstream header

Returns:

The date

Since:

2020.2.1

setDate

public void setDate(String date)

Sets the recorded 'date created' in the bitstream header

Parameters:

date - The new date to set

Since:

2020.2.1

getTime

public String getTime()

Gets the recorded 'time created' time stamp as stored in the bitstream header

Returns:

The time

Since:

2020.2.1

setTime

public void setTime(String time)

Sets the recorded 'time created' time stamp as stored in the bitstream header

Parameters:

time - the desired 'time created' time stamp to set

Since:

2020.2.1