LUTTools

Object
- com.xilinx.rapidwright.design.tools.LUTTools

```
public class LUTTools
extends Object
```
A collection of tools to help modify LUTs.

Field Summary

Fields
Modifier and Type Field and Description

static String[] empty

static String LUT_INIT

static char[] lutLetters

static String[][] lutMap

static int MAX_LUT_SIZE

Fields
Modifier and Type	Field and Description
`static String[]`	`empty`
`static String`	`LUT_INIT`
`static char[]`	`lutLetters`
`static String[][]`	`lutMap`
`static int`	`MAX_LUT_SIZE`

Constructor Summary

Constructors
Constructor and Description

LUTTools()

Constructors
Constructor and Description
`LUTTools()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static EDIFPropertyValue`	`configureLUT(Cell c, String equation)` Programs a LUT cell's init string from the provided equation.
`static EDIFPropertyValue`	`configureLUT(EDIFCellInst c, String equation)` Programs a LUT cell's init string from the provided equation.
`static int`	`getBit(int value, int bitIndex)`
`static int`	`getBit(long value, int bitIndex)`
`static BEL`	`getCompanionLUT(Cell cell)` From a placed LUT cell, get the companion LUT BEL location.
`static Cell`	`getCompanionLUTCell(Cell cell)` From a placed LUT cell, get the cell in the companion LUT BEL location.
`static String`	`getCompanionLUTName(BEL lut)` Gets the BEL's companion LUT.
`static String`	`getCompanionLUTName(String lutName)` Get the companion LUT name of the provided LUT name.
`static long`	`getInitValue(String init)` Converts the Verilog-syntax number literal for the LUT initialization to a primitive long integer.
`static String[]`	`getLUTBELNames(char lutLetter)` Gets the corresponding BEL site names for a given LUT letter.
`static String`	`getLUTEquation(Cell c)` Reads the init string in this LUT and creates an equivalent (non-optimal) equation.
`static String`	`getLUTEquation(EDIFCellInst i)` Reads the init string in this LUT and creates an equivalent (non-optimal) equation.
`static String`	`getLUTEquation(String init)` Creates a (dumb, non-reduced) boolean logic equation compatible with Vivado's LUT Equation Editor from an INIT string.
`static String`	`getLUTInitFromEquation(String equation, int lutSize)` Evaluates the provided equation in order to create the INIT string of a LUT of the given size.
`static BELPin`	`getLUTOutputPin(BEL bel)` Gets the output pin from the BEL of a LUT
`static int`	`getLUTSize(Cell c)` If the provided cell is a LUT, it will return the LUT input count.
`static int`	`getLUTSize(EDIFCellInst c)` If the provided cell instance is a LUT, it will return the LUT input count.
`static int`	`getLUTSize(String init)` Performs essentially a log_2 operation on the init string length to get the LUT size.
`static int`	`initLength(String init)` Extracts the length value from the INIT String (16, in 16'hA8A2)
`static boolean`	`isCellALUT(Cell c)` Checks if this cell is a LUT (LUT1, LUT2, LUT3,...).
`static boolean`	`isCellALUT(EDIFCellInst i)` Checks if this cell is a LUT (LUT1, LUT2, LUT3,...).
`static void`	`main(String[] args)`
`static void`	`printTruthTable(Cell c)` Prints out the truth table for the given INIT string on the cell.
`static void`	`printTruthTable(EDIFCellInst c)` Prints out the truth table for the given INIT string on the cell.
`static long`	`setBit(long value, int bitIndex)`
`static int`	`swapLutPinsFromPIPs(Design design)` Analyze the routing PIPs of a design to identify (based on whether a PIP existing on a Net drives the expected SitePin based on Net.getPins()) and perform any necessary LUT pin swapping.
`static int`	`swapMultipleLutPins(Map<SitePinInst,String> oldPinToNewPins)` Given a mapping from old SitePinInsts to new site pin name, update all state necessary to reflect these LUT pin swaps.
`static void`	`swapSingleLutPins(String key, Collection<PinSwap> pinSwaps)` For each pair of LUT sites (5LUT/6LUT), perform pin swapping.

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

- Field Detail
  - LUT_INIT
```
public static final String LUT_INIT
```
    See Also:
    
    Constant Field Values
  - MAX_LUT_SIZE
```
public static final int MAX_LUT_SIZE
```
    See Also:
    
    Constant Field Values
  - lutMap
```
public static final String[][] lutMap
```
  - lutLetters
```
public static final char[] lutLetters
```
  - empty
```
public static final String[] empty
```
- Constructor Detail
  - LUTTools
```
public LUTTools()
```
- Method Detail
  - getLUTBELNames
```
public static String[] getLUTBELNames(char lutLetter)
```
    Gets the corresponding BEL site names for a given LUT letter. For example, 'A' will return ["A6LUT", "A5LUT"]
    
    Parameters:
    
    lutLetter - The letter of the LUT of interest. Valid values are 'A'..'H', case insensitive.
    
    Returns:
    
    The list of corresponding BEL site names or an empty list if none were found.
  - getCompanionLUTName
```
public static String getCompanionLUTName(BEL lut)
```
    Gets the BEL's companion LUT. For example the A5LUT bel's companion would be A6LUT and vice versa.
    
    Parameters:
    
    lut - The LUT bel in question.
    
    Returns:
    
    The name of the companion LUT or null if undetermined.
  - getCompanionLUTName
```
public static String getCompanionLUTName(String lutName)
```
    Get the companion LUT name of the provided LUT name. For example the A5LUT bel's companion would be A6LUT and vice versa.
    
    Parameters:
    
    lutName - Name of the LUT in question.
    
    Returns:
    
    The companion LUT name or null if undetermined.
  - getCompanionLUT
```
public static BEL getCompanionLUT(Cell cell)
```
    From a placed LUT cell, get the companion LUT BEL location. For example, a cell placed on A5LUT would return the A6LUT and vice versa.
    
    Parameters:
    
    cell - A placed cell on a LUT BEL.
    
    Returns:
    
    The companion LUT BEL or null if the cell is not placed on a LUT BEL location.
  - getCompanionLUTCell
```
public static Cell getCompanionLUTCell(Cell cell)
```
    From a placed LUT cell, get the cell in the companion LUT BEL location. For example, a cell placed on A5LUT would return the cell in the A6LUT and vice versa.
    
    Parameters:
    
    cell - A placed cell on a LUT BEL.
    
    Returns:
    
    The companion cell placed in the LUT BEL location or null if the cell is not placed on a LUT BEL location or there is no cell in the companion LUT BEL.
  - getLUTOutputPin
```
public static BELPin getLUTOutputPin(BEL bel)
```
    Gets the output pin from the BEL of a LUT
    
    Parameters:
    
    bel - The physical bel site of the LUT
    
    Returns:
    
    O5 or O6 based on the BEL
  - isCellALUT
```
public static boolean isCellALUT(Cell c)
```
    Checks if this cell is a LUT (LUT1, LUT2, LUT3,...). A CFGLUT5 will return false.
    
    Parameters:
    
    c - The cell in question
    
    Returns:
    
    True if this is a LUT[1-6], false otherwise.
  - isCellALUT
```
public static boolean isCellALUT(EDIFCellInst i)
```
    Checks if this cell is a LUT (LUT1, LUT2, LUT3,...). A CFGLUT5 will return false.
    
    Parameters:
    
    i - The cell in question
    
    Returns:
    
    True if this is a LUT[1-6], false otherwise.
  - getLUTSize
```
public static int getLUTSize(Cell c)
```
    If the provided cell is a LUT, it will return the LUT input count. If it is not a LUT, it will return 0.
    
    Parameters:
    
    c - The LUT cell
    
    Returns:
    
    The number of LUT inputs or 0 if cell is not a LUT.
  - getLUTSize
```
public static int getLUTSize(EDIFCellInst c)
```
    If the provided cell instance is a LUT, it will return the LUT input count. If it is not a LUT, it will return 0.
    
    Parameters:
    
    c - The LUT cell
    
    Returns:
    
    The number of LUT inputs or 0 if cell is not a LUT.
  - initLength
```
public static int initLength(String init)
```
    Extracts the length value from the INIT String (16, in 16'hA8A2)
    
    Parameters:
    
    init - The init string.
    
    Returns:
    
    The init length.
  - getLUTSize
```
public static int getLUTSize(String init)
```
    Performs essentially a log_2 operation on the init string length to get the LUT size.
    
    Parameters:
    
    init - The LUT's init string.
    
    Returns:
    
    Size of the LUT by number of inputs (1-6).
  - printTruthTable
```
public static void printTruthTable(Cell c)
```
    Prints out the truth table for the given INIT string on the cell. If the cell is not a LUT, it prints nothing.
    
    Parameters:
    
    c - The Cell in question.
  - printTruthTable
```
public static void printTruthTable(EDIFCellInst c)
```
    Prints out the truth table for the given INIT string on the cell. If the cell is not a LUT, it prints nothing.
    
    Parameters:
    
    c - The cell instance in question.
  - getInitValue
```
public static long getInitValue(String init)
```
    Converts the Verilog-syntax number literal for the LUT initialization to a primitive long integer.
    
    Parameters:
    
    init - The LUT INIT string.
    
    Returns:
  - setBit
```
public static long setBit(long value,
                          int bitIndex)
```
  - getBit
```
public static int getBit(int value,
                         int bitIndex)
```
  - getBit
```
public static int getBit(long value,
                         int bitIndex)
```
  - getLUTInitFromEquation
```
public static String getLUTInitFromEquation(String equation,
                                            int lutSize)
```
    Evaluates the provided equation in order to create the INIT string of a LUT of the given size. Equation syntax: Operators: XOR: @, ^ AND: &, *, . OR: |, + NOT: ~, ! A Few Examples: O = 0 O = 1 O = (I0 & I1) + (I2 & I3) O = I0 & !I1 & !I3 NOTE: XOR and AND have the same precedence and are evaluated from left to right. Vivado uses different rules for handling operators of the same precedence, so be sure to use parentheses to avoid any ambiguity!
    
    Parameters:
    
    equation - A Vivado LUT Equation String. This follows the same conventions as the Vivado LUT equation string editor.
    
    lutSize - LUT size (input count), supported sizes are: 1,2,3,4,5,6
    
    Returns:
    
    The INIT string to program the LUT of the provided size
  - configureLUT
```
public static EDIFPropertyValue configureLUT(Cell c,
                                             String equation)
```
    Programs a LUT cell's init string from the provided equation.
    
    Parameters:
    
    c - The LUT cell to program.
    
    equation - The desired programming of the LUT using Vivado LUT equation syntax.
    
    Returns:
    
    The previous LUT init string or null if none.
  - configureLUT
```
public static EDIFPropertyValue configureLUT(EDIFCellInst c,
                                             String equation)
```
    Programs a LUT cell's init string from the provided equation.
    
    Parameters:
    
    c - The LUT cell instance to program.
    
    equation - The desired programming of the LUT using Vivado LUT equation syntax.
    
    Returns:
    
    The previous LUT init string or null if none.
  - getLUTEquation
```
public static String getLUTEquation(Cell c)
```
    Reads the init string in this LUT and creates an equivalent (non-optimal) equation.
    
    Parameters:
    
    c - The LUT instance
    
    Returns:
    
    The equation following LUT equation syntax or null if cell is not configured.
  - getLUTEquation
```
public static String getLUTEquation(EDIFCellInst i)
```
    Reads the init string in this LUT and creates an equivalent (non-optimal) equation.
    
    Parameters:
    
    i - The LUT instance
    
    Returns:
    
    The equation following LUT equation syntax or null if cell is not configured.
  - getLUTEquation
```
public static String getLUTEquation(String init)
```
    Creates a (dumb, non-reduced) boolean logic equation compatible with Vivado's LUT Equation Editor from an INIT string. TODO - Enhance with a logic minimization method such as Quine-McCluskey method.
    
    Parameters:
    
    init - The existing INIT string configuring a LUT.
    
    Returns:
    
    A Vivado LUT Equation Editor compatible equation.
  - swapMultipleLutPins
```
public static int swapMultipleLutPins(Map<SitePinInst,String> oldPinToNewPins)
```
    Given a mapping from old SitePinInsts to new site pin name, update all state necessary to reflect these LUT pin swaps. This includes updating cells' logical-to-physical pin mappings, updating intra-site routing, moving the SitePinInst objects, etc.
    
    Parameters:
    
    oldPinToNewPins - Mapping from old pins to new pins.
  - swapSingleLutPins
```
public static void swapSingleLutPins(String key,
                                     Collection<PinSwap> pinSwaps)
```
    For each pair of LUT sites (5LUT/6LUT), perform pin swapping.
    
    Parameters:
    
    key - The name of the site and letter of LUT pair (ex: SLICE_X54Y44/D)
    
    pinSwaps - The list of pin swaps to be performed on the pair of LUT sites
  - swapLutPinsFromPIPs
```
public static int swapLutPinsFromPIPs(Design design)
```
    Analyze the routing PIPs of a design to identify (based on whether a PIP existing on a Net drives the expected SitePin based on Net.getPins()) and perform any necessary LUT pin swapping.
    
    Parameters:
    
    design - Design object to analyze and fix.
    
    Returns:
    
    Number of pin swaps processed.
  - main
```
public static void main(String[] args)
```

Class LUTTools

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

LUT_INIT

MAX_LUT_SIZE

lutMap

lutLetters

empty

Constructor Detail

LUTTools

Method Detail

getLUTBELNames

getCompanionLUTName

getCompanionLUTName

getCompanionLUT

getCompanionLUTCell

getLUTOutputPin

isCellALUT

isCellALUT

getLUTSize

getLUTSize

initLength

getLUTSize

printTruthTable

printTruthTable

getInitValue

setBit

getBit

getBit

getLUTInitFromEquation

configureLUT

configureLUT

getLUTEquation

getLUTEquation

getLUTEquation

swapMultipleLutPins

swapSingleLutPins

swapLutPinsFromPIPs

main