com.xilinx.rapidwright.bitstream

Class Packet

Object

com.xilinx.rapidwright.bitstream.Packet

public class Packet
extends Object

Represents Type I and Type II packets for at least Series 7, UltraScale and UltraScale+ devices.

Since:

2020.2.1

Field Summary

Fields

Modifier and Type	Field and Description
static Packet	BUS_WIDTH_AUTO_DETECT1 The first bus width auto detect packet
static Packet	BUS_WIDTH_AUTO_DETECT2 The second bus width auto detect packet
static Packet	DUMMY A 'Dummy' packet
static Packet	NOOP A 'No Op' packet
static Packet	SYNC A 'Sync Word' packet

Constructor Summary

Constructors

Constructor and Description
Packet(CMDCode code) Creates a new packet targeting the command register with the provided command code
Packet(int header) Creates a new packet with the provided header word
Packet(int header, int data) Creates a new packet that has a single word of data
Packet(int header, int[] data) Creates a new packet with the provided header and set of data

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Checks if this packet is equal (header and data match) with the provided packet.
int[]	getData() Gets the data (payload) of this packet
int	getHeader() Gets the header word (first word) in the packet
OpCode	getOpCode() Gets the specified opcode from the header of the packet
PacketType	getPacketType() Gets the packet type of the packet based on the header information.
RegisterType	getRegister() Gets the configuration register specified in the header of the packet.
int	getWordCount() Gets the number of words in the data/payload portion of the packet as indicated in the header.
int	hashCode() Creates a hash from the packets header and data.
boolean	isTypeOnePacket() Checks if it is a Type 1 packet
boolean	isTypeTwoPacket() Checks if it is a Type 2 packet
static Packet	newType1(OpCode opCode, RegisterType regType, int wordCount) Creates a new type 1 packet and allocates any applicable data words.
static Packet	newType1(OpCode opCode, RegisterType regType, int[] data) Creates a new type 1 packet and allocates any applicable data words.
static Packet	newType2(OpCode opCode, int wordCount) Creates a new type 2 packet and allocates any applicable data words.
static Packet	newType2(OpCode opCode, int[] data) Creates a new type 2 packet and allocates any applicable data words.
void	setData(int[] data) Updates the data/payload of this packet with the provided array
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

NOOP

public static Packet NOOP

A 'No Op' packet

Since:

2020.2.1

DUMMY

public static Packet DUMMY

A 'Dummy' packet

Since:

2020.2.1

SYNC

public static Packet SYNC

A 'Sync Word' packet

Since:

2020.2.1

BUS_WIDTH_AUTO_DETECT1

public static Packet BUS_WIDTH_AUTO_DETECT1

The first bus width auto detect packet

Since:

2020.2.1

BUS_WIDTH_AUTO_DETECT2

public static Packet BUS_WIDTH_AUTO_DETECT2

The second bus width auto detect packet

Since:

2020.2.1

Constructor Detail

Packet

public Packet(int header)

Creates a new packet with the provided header word

Parameters:

header - The 32-bit header word

Since:

2020.2.1

Packet

public Packet(int header,
              int data)

Creates a new packet that has a single word of data

Parameters:

header - The 32-bit header word

data - The 32-bit data word

Since:

2020.2.1

Packet

public Packet(CMDCode code)

Creates a new packet targeting the command register with the provided command code

Parameters:

code - The command code to use in the packet

Since:

2020.2.1

Packet

public Packet(int header,
              int[] data)

Creates a new packet with the provided header and set of data

Parameters:

header - The 32-bit header word

data - An array of data words to attach to the packet

Since:

2020.2.1

Method Detail

getData

public int[] getData()

Gets the data (payload) of this packet

Returns:

The data (payload) of the packet

Since:

2020.2.1

setData

public void setData(int[] data)

Updates the data/payload of this packet with the provided array

Parameters:

data - The desired set of integer words to be carried as payload of the packet

Since:

2020.2.1

getHeader

public int getHeader()

Gets the header word (first word) in the packet

Returns:

Header word of the packet

Since:

2020.2.1

getWordCount

public int getWordCount()

Gets the number of words in the data/payload portion of the packet as indicated in the header.

Returns:

Number of words in the packet data/payload portion.

Since:

2020.2.1

getRegister

public RegisterType getRegister()

Gets the configuration register specified in the header of the packet.

Returns:

The target configuration register, or null if invalid or is a type II packet.

Since:

2020.2.1

getOpCode

public OpCode getOpCode()

Gets the specified opcode from the header of the packet

Returns:

The designated opcode for the packet.

Since:

2020.2.1

isTypeOnePacket

public boolean isTypeOnePacket()

Checks if it is a Type 1 packet

Returns:

True if it is a type 1 packet, false otherwise

Since:

2020.2.1

isTypeTwoPacket

public boolean isTypeTwoPacket()

Checks if it is a Type 2 packet

Returns:

True if it is a type 2 packet, false otherwise

Since:

2020.2.1

getPacketType

public PacketType getPacketType()

Gets the packet type of the packet based on the header information.

Returns:

The packet type, see PacketType

Since:

2020.2.1

toString

public String toString()

Overrides:

toString in class Object

newType1

public static Packet newType1(OpCode opCode,
                              RegisterType regType,
                              int wordCount)

Creates a new type 1 packet and allocates any applicable data words.

Parameters:

opCode - The opcode for the packet

regType - The intended register for the packet

wordCount - The number of 32-bit words that are payload in the packet.

Returns:

The newly created type 1 packet.

Since:

2020.2.1

newType1

public static Packet newType1(OpCode opCode,
                              RegisterType regType,
                              int[] data)

Creates a new type 1 packet and allocates any applicable data words.

Parameters:

opCode - The opcode for the packet

regType - The intended register for the packet

data - The data to be carried as payload for the packet

Returns:

The newly created type 1 packet

Since:

2020.2.1

newType2

public static Packet newType2(OpCode opCode,
                              int wordCount)

Creates a new type 2 packet and allocates any applicable data words.

Parameters:

opCode - The op code to use in packet creation

wordCount - The number of 32-bit payload words to add to the packet

Returns:

The newly created type 2 packet.

Since:

2020.2.1

newType2

public static Packet newType2(OpCode opCode,
                              int[] data)

Creates a new type 2 packet and allocates any applicable data words.

Parameters:

opCode - The op code to use in packet creation

data - The data to be carried as payload

Returns:

The newly created type 2 packet.

Since:

2020.2.1

hashCode

public int hashCode()

Creates a hash from the packets header and data.

Overrides:

hashCode in class Object

Since:

2023.1.3

equals

public boolean equals(Object obj)

Checks if this packet is equal (header and data match) with the provided packet.

Overrides:

equals in class Object

Since:

2023.1.3