com.xilinx.rapidwright.bitstream

Enum OpCode

Object

Enum<OpCode>

com.xilinx.rapidwright.bitstream.OpCode

All Implemented Interfaces:

Serializable, Comparable<OpCode>

public enum OpCode
extends Enum<OpCode>

Enumeration of the opcode field in both type 1 and type 2 packets.

Since:

2020.2.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
NOP
READ
RESERVED
WRITE

Field Summary

Fields

Modifier and Type	Field and Description
static OpCode[]	values A static final (cached) copy of values()

Method Summary

Modifier and Type	Method and Description
int	getCode() Gets the 2-bit code for the opcode.
int	getHeaderValue() Gets the header int representation for this opcode.
static OpCode	getOpCode(int code) For a given 2-bit code, get the corresponding opcode.
static OpCode	getOpCodeFromHeader(int header) Takes a type 1 or type 2 header packet word and returns the corresponding opcode.
static OpCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static OpCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOP

public static final OpCode NOP

READ

public static final OpCode READ

WRITE

public static final OpCode WRITE

RESERVED

public static final OpCode RESERVED

Field Detail

values

public static final OpCode[] values

A static final (cached) copy of values()

Since:

2021.2.2

Method Detail

values

public static OpCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OpCode c : OpCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OpCode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getOpCodeFromHeader

public static OpCode getOpCodeFromHeader(int header)

Takes a type 1 or type 2 header packet word and returns the corresponding opcode.

Parameters:

header - The packet header word (first word in a packet) of interest.

Returns:

The opcode corresponding to the packet header provided.

Since:

2020.2.1

getOpCode

public static OpCode getOpCode(int code)

For a given 2-bit code, get the corresponding opcode.

Parameters:

code - The 2-bit code of the opcode.

Returns:

The OpCode for the provided code.

Since:

2020.2.1

getCode

public int getCode()

Gets the 2-bit code for the opcode.

Returns:

The 2-bit code for the opcode.

Since:

2020.2.1

getHeaderValue

public int getHeaderValue()

Gets the header int representation for this opcode.

Returns:

First word header representation of this opcode

Since:

2020.2.1