Bitstream

Object
- com.xilinx.rapidwright.bitstream.Bitstream

```
public class Bitstream
extends Object
```
Represents a parsed bitstream into header and packets.

Since:

2020.2.1

Constructor Summary

Constructors
Constructor and Description

Bitstream(String designName, String partName)
Creates an empty bitstream with the design and part name information added to the header.

Constructors
Constructor and Description
`Bitstream(String designName, String partName)` Creates an empty bitstream with the design and part name information added to the header.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`checkIfDeviceSupported(String partName)` Check if RapidWright has bitstream support for this part
`ConfigArray`	`configureArray()` Applies the bitstream packets and data to the configuration array.
`static Packet`	`createPacket1(OpCode opCode, RegisterType regType, int data)` Convenience method to create a new type 1 packet
`static List<Packet>`	`createPacketList(Device device, int configArrayWordSize)` Creates a new (empty) list of configuration packets to fully program a device.
`static Packet`	`createWrCmdPacket1(CMDCode cmdCode)` Convenience method to create a new type 1 packet writing to the command register
`ConfigArray`	`getConfigArray()` Gets the current configuration layout for this bitstream.
`static List<Integer>`	`getDebugBitstreamFARWrites(Bitstream b)` When given a debug bitstream (see UG908 - Table A-1, BITSTREAM.GENERAL.DEBUGBITSTREAM), this method will extract the LOUT writes that provide the consecutive list of FAR addresses of the device.
`String`	`getDesignName()` Gets the design name from the header
`Device`	`getDevice()` Gets the target device using part name information from the header.
`BitstreamHeader`	`getHeader()` Gets the stored header of the bitstream
`List<Packet>`	`getPackets()` Gets the list of packets within this bitstream
`Part`	`getPart()` Gets the target part from header part name information.
`String`	`getPartName()` Gets the target part name from the header.
`static List<Integer>`	`getPerFrameCRCFARWrites(Bitstream b)` When given a per frame CRC bitstream (see UG908 - Table A-1, BITSTREAM.GENERAL.PERFRAMECRC YES), this method will extract the FAR writes that provide the consecutive list of FAR addresses of the device.
`Series`	`getSeries()` Gets the series as derived from the part name stored in the header
`static Bitstream`	`readBitstream(Path fileName)` Reads and parses a bitstream file (*.bit) into packets
`static Bitstream`	`readBitstream(String fileName)` Reads and parses a bitstream file (*.bit) into packets
`void`	`setHeader(BitstreamHeader header)` Updates the bitstream header with a new header
`void`	`setPackets(List<Packet> packets)` Updates the list of packets in this bitstream
`void`	`updateCRCPackets()` Updates the CRC packets in the current packet list to be consistent with any recent changes.
`void`	`updatePacketsFromConfigArray()` Updates the bitstream packets from the current state of the configuration array.
`boolean`	`writeBitstream(Path path)` Writes a bitstream file (*.bit) from the current state of this bitstream.
`boolean`	`writeBitstream(String fileName)` Writes a bitstream file (*.bit) from the current state of this bitstream.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Bitstream
```
public Bitstream(String designName,
                 String partName)
```
    Creates an empty bitstream with the design and part name information added to the header. It also creates a configuration frame set to match the complete configuration memory of the target device.
    
    Parameters:
    
    designName - Name of the design
    
    partName - Name of the target part
    
    Since:
    
    2020.2.1
- Method Detail
  - createPacketList
```
public static List<Packet> createPacketList(Device device,
                                            int configArrayWordSize)
```
    Creates a new (empty) list of configuration packets to fully program a device.
    
    Parameters:
    
    device - The target device.
    
    configArrayWordSize - The number of configuration words in the array (See: ConfigArray.getWordSize()
    
    Returns:
    
    A newly created list of configuration packets
    
    Since:
    
    2020.2.1
  - createWrCmdPacket1
```
public static Packet createWrCmdPacket1(CMDCode cmdCode)
```
    Convenience method to create a new type 1 packet writing to the command register
    
    Parameters:
    
    cmdCode - The command code to write to the command register, see CMDCode
    
    Returns:
    
    Newly created write packet writing the command register with the provided code
    
    Since:
    
    2020.2.1
  - createPacket1
```
public static Packet createPacket1(OpCode opCode,
                                   RegisterType regType,
                                   int data)
```
    Convenience method to create a new type 1 packet
    
    Parameters:
    
    opCode - The op code for the packet, see OpCode
    
    regType - The target register of the packet, see RegisterType
    
    data - The data word to be written (if writing)
    
    Returns:
    
    Newly created type 1 packet
    
    Since:
    
    2020.2.1
  - checkIfDeviceSupported
```
public static void checkIfDeviceSupported(String partName)
```
    Check if RapidWright has bitstream support for this part
    
    Parameters:
    
    partName - The part name to check
    
    Since:
    
    2021.2.2
  - readBitstream
```
public static Bitstream readBitstream(Path fileName)
```
    Reads and parses a bitstream file (*.bit) into packets
    
    Parameters:
    
    fileName - Path of the bitstream file (*.bit)
    
    Returns:
    
    The parsed bitstream
    
    Since:
    
    2023.1.3
  - readBitstream
```
public static Bitstream readBitstream(String fileName)
```
    Reads and parses a bitstream file (*.bit) into packets
    
    Parameters:
    
    fileName - Name of the bitstream file (*.bit)
    
    Returns:
    
    The parsed bitstream
    
    Since:
    
    2020.2.1
  - writeBitstream
```
public boolean writeBitstream(Path path)
```
    Writes a bitstream file (*.bit) from the current state of this bitstream.
    
    Parameters:
    
    path - File path of the bitstream file to write out.
    
    Returns:
    
    True if operation succeeded, false otherwise.
    
    Since:
    
    2023.2.2
  - writeBitstream
```
public boolean writeBitstream(String fileName)
```
    Writes a bitstream file (*.bit) from the current state of this bitstream.
    
    Parameters:
    
    fileName - Name of the bitstream file to write out.
    
    Returns:
    
    True if operation succeeded, false otherwise.
    
    Since:
    
    2020.2.1
  - getHeader
```
public BitstreamHeader getHeader()
```
    Gets the stored header of the bitstream
    
    Returns:
    
    The bitstream header
    
    Since:
    
    2020.2.1
  - setHeader
```
public void setHeader(BitstreamHeader header)
```
    Updates the bitstream header with a new header
    
    Parameters:
    
    header - The new header
    
    Since:
    
    2020.2.1
  - getPackets
```
public List<Packet> getPackets()
```
    Gets the list of packets within this bitstream
    
    Returns:
    
    List of packages within this bitstream
    
    Since:
    
    2020.2.1
  - setPackets
```
public void setPackets(List<Packet> packets)
```
    Updates the list of packets in this bitstream
    
    Parameters:
    
    packets - The desired list of packets to be set for this bitstream
    
    Since:
    
    2020.2.1
  - getDebugBitstreamFARWrites
```
public static List<Integer> getDebugBitstreamFARWrites(Bitstream b)
```
    When given a debug bitstream (see UG908 - Table A-1, BITSTREAM.GENERAL.DEBUGBITSTREAM), this method will extract the LOUT writes that provide the consecutive list of FAR addresses of the device.
    
    Parameters:
    
    b - The bitstream parsed from a debug bitstream
    
    Returns:
    
    The list of FAR addresses that are configured in the device.
    
    Since:
    
    2020.2.1
  - getPerFrameCRCFARWrites
```
public static List<Integer> getPerFrameCRCFARWrites(Bitstream b)
```
    When given a per frame CRC bitstream (see UG908 - Table A-1, BITSTREAM.GENERAL.PERFRAMECRC YES), this method will extract the FAR writes that provide the consecutive list of FAR addresses of the device.
    
    Parameters:
    
    b - The bitstream parsed from a debug bitstream
    
    Returns:
    
    The list of FAR addresses that are configured in the device.
    
    Since:
    
    2020.2.1
  - getDesignName
```
public String getDesignName()
```
    Gets the design name from the header
    
    Returns:
    
    Design name as stored in the header
    
    Since:
    
    2020.2.1
  - getPart
```
public Part getPart()
```
    Gets the target part from header part name information.
    
    Returns:
    
    The part or null if it could not be determined.
    
    Since:
    
    2020.2.1
  - getPartName
```
public String getPartName()
```
    Gets the target part name from the header.
    
    Returns:
    
    The part name this bitstream targets.
    
    Since:
    
    2020.2.1
  - getDevice
```
public Device getDevice()
```
    Gets the target device using part name information from the header.
    
    Returns:
    
    The device or null if it could not be determined.
    
    Since:
    
    2020.2.1
  - getSeries
```
public Series getSeries()
```
    Gets the series as derived from the part name stored in the header
    
    Returns:
    
    The series this bitstream targets
    
    Since:
    
    2020.2.1
  - getConfigArray
```
public ConfigArray getConfigArray()
```
    Gets the current configuration layout for this bitstream. If this is a first time call after loading the bitstream from a file, the configuration array is created from the packets in the bitstream. If this method has been called before, but packets have been modified since, the configuration array will not reflect those changes.
    
    Returns:
    
    The configuration array that corresponds to this bitstream.
    
    Since:
    
    2020.2.1
  - configureArray
```
public ConfigArray configureArray()
```
    Applies the bitstream packets and data to the configuration array. This is the reverse process of Bitstream.updatePacketsFromConfigArray()
    
    Returns:
    
    The freshly configured array.
    
    Since:
    
    2020.2.1
  - updatePacketsFromConfigArray
```
public void updatePacketsFromConfigArray()
```
    Updates the bitstream packets from the current state of the configuration array. This is the reverse process of Bitstream#configArray()
    
    Since:
    
    2020.2.1
  - updateCRCPackets
```
public void updateCRCPackets()
```
    Updates the CRC packets in the current packet list to be consistent with any recent changes.
    
    Since:
    
    2020.2.1

Class Bitstream

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

Bitstream

Method Detail

createPacketList

createWrCmdPacket1

createPacket1

checkIfDeviceSupported

readBitstream

readBitstream

writeBitstream

writeBitstream

getHeader

setHeader

getPackets

setPackets

getDebugBitstreamFARWrites

getPerFrameCRCFARWrites

getDesignName

getPart

getPartName

getDevice

getSeries

getConfigArray

configureArray

updatePacketsFromConfigArray

updateCRCPackets