RegisterType

Object
- Enum<RegisterType>
- - com.xilinx.rapidwright.bitstream.RegisterType

All Implemented Interfaces:

Serializable, Comparable<RegisterType>
```
public enum RegisterType
extends Enum<RegisterType>
```
Enumeration of all configuration registers

Since:

2020.2.1

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AXSS`
`BOOTSTS`
`BSPI`
`CBC`
`CMD`
`COR0`
`COR1`
`CRC`
`CTL0`
`CTL1`
`FAR`
`FDRI`
`FDRO`
`IDCODE`
`LOUT`
`MASK`
`MFWR`
`RSVD15`
`RSVD18`
`RSVD19`
`RSVD20`
`RSVD21`
`RSVD23`
`RSVD25`
`RSVD26`
`RSVD27`
`RSVD28`
`RSVD29`
`RSVD30`
`STAT`
`TIMER`
`WBSTAR`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`REG_ADDR_WIDTH` The number of bits in the packet header for register type
`static RegisterType[]`	`values` A static final (cached) copy of values()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canRead()` Checks if this configuration address can be read.
`boolean`	`canWrite()` Checks if this configuration address can be written to.
`int`	`getAddress()` Gets the configuration address (see register address field in packet header).
`String`	`getDescription()` A short description of the purpose of this register.
`int`	`getHeaderValue()` Gets the Register address field for a type 1 packet for this register
`static RegisterType`	`getRegisterType(int address)` Takes a register address and returns the register type.
`static RegisterType`	`getRegisterTypeFromHeader(int header)` Takes a packet type 1 header and returns the register type.
`static RegisterType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static RegisterType[]`	`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
  - CRC
```
public static final RegisterType CRC
```
  - FAR
```
public static final RegisterType FAR
```
  - FDRI
```
public static final RegisterType FDRI
```
  - FDRO
```
public static final RegisterType FDRO
```
  - CMD
```
public static final RegisterType CMD
```
  - CTL0
```
public static final RegisterType CTL0
```
  - MASK
```
public static final RegisterType MASK
```
  - STAT
```
public static final RegisterType STAT
```
  - LOUT
```
public static final RegisterType LOUT
```
  - COR0
```
public static final RegisterType COR0
```
  - MFWR
```
public static final RegisterType MFWR
```
  - CBC
```
public static final RegisterType CBC
```
  - IDCODE
```
public static final RegisterType IDCODE
```
  - AXSS
```
public static final RegisterType AXSS
```
  - COR1
```
public static final RegisterType COR1
```
  - RSVD15
```
public static final RegisterType RSVD15
```
  - WBSTAR
```
public static final RegisterType WBSTAR
```
  - TIMER
```
public static final RegisterType TIMER
```
  - RSVD18
```
public static final RegisterType RSVD18
```
  - RSVD19
```
public static final RegisterType RSVD19
```
  - RSVD20
```
public static final RegisterType RSVD20
```
  - RSVD21
```
public static final RegisterType RSVD21
```
  - BOOTSTS
```
public static final RegisterType BOOTSTS
```
  - RSVD23
```
public static final RegisterType RSVD23
```
  - CTL1
```
public static final RegisterType CTL1
```
  - RSVD25
```
public static final RegisterType RSVD25
```
  - RSVD26
```
public static final RegisterType RSVD26
```
  - RSVD27
```
public static final RegisterType RSVD27
```
  - RSVD28
```
public static final RegisterType RSVD28
```
  - RSVD29
```
public static final RegisterType RSVD29
```
  - RSVD30
```
public static final RegisterType RSVD30
```
  - BSPI
```
public static final RegisterType BSPI
```
- Field Detail
  - REG_ADDR_WIDTH
```
public static int REG_ADDR_WIDTH
```
    The number of bits in the packet header for register type
    
    Since:
    
    2020.2.1
  - values
```
public static final RegisterType[] values
```
    A static final (cached) copy of values()
    
    Since:
    
    2021.2.2
- Method Detail
  - values
```
public static RegisterType[] 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 (RegisterType c : RegisterType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static RegisterType 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
  - canRead
```
public boolean canRead()
```
    Checks if this configuration address can be read.
    
    Returns:
    
    True if it can be read, false otherwise.
    
    Since:
    
    2020.2.1
  - canWrite
```
public boolean canWrite()
```
    Checks if this configuration address can be written to.
    
    Returns:
    
    True if it can be written to, false otherwise.
    
    Since:
    
    2020.2.1
  - getAddress
```
public int getAddress()
```
    Gets the configuration address (see register address field in packet header).
    
    Returns:
    
    The 5-bit register address.
    
    Since:
    
    2020.2.1
  - getDescription
```
public String getDescription()
```
    A short description of the purpose of this register.
    
    Returns:
    
    A short description of the purpose of this register.
    
    Since:
    
    2020.2.1
  - getRegisterTypeFromHeader
```
public static RegisterType getRegisterTypeFromHeader(int header)
```
    Takes a packet type 1 header and returns the register type.
    
    Parameters:
    
    header - A type 1 packet header to query
    
    Returns:
    
    The register type designated in the provided packet header.
    
    Since:
    
    2020.2.1
  - getRegisterType
```
public static RegisterType getRegisterType(int address)
```
    Takes a register address and returns the register type.
    
    Parameters:
    
    address - The register address
    
    Returns:
    
    The corresponding register type for the address specified.
    
    Since:
    
    2020.2.1
  - getHeaderValue
```
public int getHeaderValue()
```
    Gets the Register address field for a type 1 packet for this register
    
    Returns:
    
    The integer value of a packet 1 header for this register address value.
    
    Since:
    
    2020.2.1

Enum RegisterType

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class Enum

Methods inherited from class Object

Enum Constant Detail

CRC

FAR

FDRI

FDRO

CMD

CTL0

MASK

STAT

LOUT

COR0

MFWR

CBC

IDCODE

AXSS

COR1

RSVD15

WBSTAR

TIMER

RSVD18

RSVD19

RSVD20

RSVD21

BOOTSTS

RSVD23

CTL1

RSVD25

RSVD26

RSVD27

RSVD28

RSVD29

RSVD30

BSPI

Field Detail

REG_ADDR_WIDTH

values

Method Detail

values

valueOf

canRead

canWrite

getAddress

getDescription

getRegisterTypeFromHeader

getRegisterType

getHeaderValue