CMDCode

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

All Implemented Interfaces:

Serializable, Comparable<CMDCode>
```
public enum CMDCode
extends Enum<CMDCode>
```
Command Register Codes (see UG570)

Since:

2020.2.1

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AGHIGH` Asserts the GHIGH_B signal: places all interconnect in a High-Z state to prevent contention when writing new configuration data.
`BSPI_READ` BPI/SPI re-initiate bitstream read.
`CRCC` When readback CRC is selected, the configuration logic recalculates the first readback CRC value after reconfiguration.
`DESYNC` Resets the DALIGN signal: Used at the end of configuration to desynchronize the device.
`DGHIGH` Last frame: Deasserts the GHIGH_B signal, activating all interconnects.
`FALL_EDGE` Switch to negative edge clocking (configuration data capture on falling edge).
`GRESTORE` Pulses the GRESTORE signal: sets/resets (depending on user configuration) CLB flip-flops.
`IPROG` Internal PROG for triggering a warm boot.
`LFRM` Last frame: Deasserts the GHIGH_B signal, activating all interconnects.
`LTIMER` Reload watchdog timer.
`MFW` Multiple frame write: used to perform a write of a single frame data to multiple frame addresses.
`NULL` Null command, no action.
`RCFG` Reads configuration data: used prior to reading configuration data from the FDRO.
`RCRC` Resets CRC: Resets the CRC register.
`SHUTDOWN` Begin shutdown sequence: Initiates the shutdown sequence, disabling the device when finished.
`START` Begins the start-up sequence: start-up sequence begins after a successful CRC check and a DESYNC command are performed.
`SWITCH` Switches the CCLK frequency: updates the frequency of the master CCLK based on the ECLK_EN and OSCFSEL bits in the COR0 register.
`ULTRASCALE_RSVD`
`WCFG` Writes configuration data: used prior to writing configuration data to the FDRI.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCode()` Gets the integer representation of the command code.
`static CMDCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CMDCode[]`	`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
  - NULL
```
public static final CMDCode NULL
```
    Null command, no action.
  - WCFG
```
public static final CMDCode WCFG
```
    Writes configuration data: used prior to writing configuration data to the FDRI.
  - MFW
```
public static final CMDCode MFW
```
    Multiple frame write: used to perform a write of a single frame data to multiple frame addresses.
  - DGHIGH
```
public static final CMDCode DGHIGH
```
    Last frame: Deasserts the GHIGH_B signal, activating all interconnects. The GHIGH_B signal is asserted with the AGHIGH command.
  - LFRM
```
public static final CMDCode LFRM
```
    Last frame: Deasserts the GHIGH_B signal, activating all interconnects. The GHIGH_B signal is asserted with the AGHIGH command.
  - RCFG
```
public static final CMDCode RCFG
```
    Reads configuration data: used prior to reading configuration data from the FDRO.
  - START
```
public static final CMDCode START
```
    Begins the start-up sequence: start-up sequence begins after a successful CRC check and a DESYNC command are performed.
  - RCRC
```
public static final CMDCode RCRC
```
    Resets CRC: Resets the CRC register.
  - AGHIGH
```
public static final CMDCode AGHIGH
```
    Asserts the GHIGH_B signal: places all interconnect in a High-Z state to prevent contention when writing new configuration data. This command is only used in shutdown reconfiguration. Interconnect is reactivated with the LFRM command.
  - SWITCH
```
public static final CMDCode SWITCH
```
    Switches the CCLK frequency: updates the frequency of the master CCLK based on the ECLK_EN and OSCFSEL bits in the COR0 register.
  - GRESTORE
```
public static final CMDCode GRESTORE
```
    Pulses the GRESTORE signal: sets/resets (depending on user configuration) CLB flip-flops.
  - SHUTDOWN
```
public static final CMDCode SHUTDOWN
```
    Begin shutdown sequence: Initiates the shutdown sequence, disabling the device when finished. Shutdown activates on the next successful CRC check or RCRC instruction (typically an RCRC instruction).
  - DESYNC
```
public static final CMDCode DESYNC
```
    Resets the DALIGN signal: Used at the end of configuration to desynchronize the device. After desynchronization, all values on the configuration data pins are ignored.
  - IPROG
```
public static final CMDCode IPROG
```
    Internal PROG for triggering a warm boot.
  - CRCC
```
public static final CMDCode CRCC
```
    When readback CRC is selected, the configuration logic recalculates the first readback CRC value after reconfiguration. Toggling GHIGH has the same effect. This command can be used when GHIGH is not toggled during the reconfiguration case.
  - LTIMER
```
public static final CMDCode LTIMER
```
    Reload watchdog timer.
  - BSPI_READ
```
public static final CMDCode BSPI_READ
```
    BPI/SPI re-initiate bitstream read.
  - FALL_EDGE
```
public static final CMDCode FALL_EDGE
```
    Switch to negative edge clocking (configuration data capture on falling edge).
  - ULTRASCALE_RSVD
```
public static final CMDCode ULTRASCALE_RSVD
```
- Method Detail
  - values
```
public static CMDCode[] 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 (CMDCode c : CMDCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CMDCode 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
  - getCode
```
public int getCode()
```
    Gets the integer representation of the command code.
    
    Returns:
    
    Integer representation of the command code
    
    Since:
    
    2020.2.1

Enum CMDCode

Enum Constant Summary

Method Summary

Methods inherited from class Enum

Methods inherited from class Object

Enum Constant Detail

NULL

WCFG

MFW

DGHIGH

LFRM

RCFG

START

RCRC

AGHIGH

SWITCH

GRESTORE

SHUTDOWN

DESYNC

IPROG

CRCC

LTIMER

BSPI_READ

FALL_EDGE

ULTRASCALE_RSVD

Method Detail

values

valueOf

getCode