FAR

Object
- com.xilinx.rapidwright.bitstream.FAR

```
public class FAR
extends Object
```
Representation for the frame address register functionality.

Since:

2020.2.1

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOT_HALF` The encoding in the FAR for an address to be specified in the bottom half of the device (Series 7 only)
`static int`	`TOP_HALF` The encoding in the FAR for an address to be specified in the top half of the device (Series 7 only)

Constructor Summary

Constructors
Constructor and Description

FAR(ConfigArray configArray)
Creates a new frame address register object

Constructors
Constructor and Description
`FAR(ConfigArray configArray)` Creates a new frame address register object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getBlockAddress()` Gets the current FAR address of the current block.
`static int`	`getBlockAddress(int farAddress, Series series)` Gets the unique block address for the given FAR address.
`int`	`getBlockType()` Gets the current integer block type of the current address the FAR points to
`static int`	`getBlockType(int farAddress, Series s)` Extracts the block type from a 32-bit FAR address.
`int`	`getColumn()` Gets the current column to which the FAR address is currently set
`static int`	`getColumnAddress(int farAddress, Series s)` Extracts the column address from a 32-bit FAR address.
`ConfigArray`	`getConfigArray()` Gets the current config array associated with the FAR
`Block`	`getConfigBlock()` Gets the configuration block from current FAR address, assumes a single SLR or SLR with config order 0.
`Block`	`getConfigBlock(int slrCfgOrder)` Gets the configuration block from current FAR address.
`int`	`getCurrentFAR()` Gets the current address of the FAR object.
`Device`	`getDevice()` Gets the current device associated with this FAR
`static int`	`getFARConfigRowIndex(Tile tile)` Gets the FAR row index based on the the tile's clock region.
`int`	`getMinor()` Gets the minor frame address to which the FAR address is currently set
`static int`	`getMinorAddress(int farAddress, Series s)` Extracts the minor address frame index from a 32-bit FAR address.
`int`	`getRow()` Gets the current row to which the FAR address is currently set
`static int`	`getRowAddress(int farAddress, Series s)` Extracts the row address from a 32-bit FAR address.
`Series`	`getSeries()` Gets the target series of this FAR
`static int`	`getTopBot(Tile tile)` Gets the top/bottom bit for a particular tile by looking at the config row and SLR.
`int`	`getTopBotBit()` Gets the top/bottom bit from the current address set in this FAR (only relevant for Series 7 devices)
`static int`	`getTopBotBit(int farAddress, Series s)` For Series 7 devices, it returns the top or bottom bit.
`boolean`	`hasTopBotBit()` Checks if the FAR has a top/bottom bit field (only relevant for Series 7 devices)
`int`	`incrementFAR()` Gets the next valid FAR address in the device given the current address.
`boolean`	`isFirstFrameInRow()` Checks if the FAR is currently pointing at the first frame in the config row
`boolean`	`isLastFrameInRow()` Checks if the FAR is currently pointing at the last frame in the config row
`void`	`setBlockType(int blockType)` Updates the current address the FAR address to point to the block type provided
`void`	`setColumn(int col)` Updates the current column to which the FAR address is currently set
`void`	`setConfigArray(ConfigArray configArray)` Sets the current config array associated with this FAR
`boolean`	`setFAR(int address)` Sets the FAR object to the specified address.
`void`	`setMinor(int minor)` Updates the minor frame address to which the FAR address is currently set
`void`	`setRow(int row)` Updates the current row to which the FAR address is currently set
`void`	`setTopBotBit(int topBotBit)` Updates the top/bottom bit from the current address set in this FAR (only relevant for Series 7 devices)
`String`	`toString()`

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

- Field Detail
  - TOP_HALF
```
public static final int TOP_HALF
```
    The encoding in the FAR for an address to be specified in the top half of the device (Series 7 only)
    
    Since:
    
    2020.2.1
    
    See Also:
    
    Constant Field Values
  - BOT_HALF
```
public static final int BOT_HALF
```
    The encoding in the FAR for an address to be specified in the bottom half of the device (Series 7 only)
    
    Since:
    
    2020.2.1
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FAR
```
public FAR(ConfigArray configArray)
```
    Creates a new frame address register object
    
    Parameters:
    
    configArray - The corresponding config array for which the FAR can address
    
    Since:
    
    2020.2.1
- Method Detail
  - getBlockType
```
public int getBlockType()
```
    Gets the current integer block type of the current address the FAR points to
    
    Returns:
    
    The current integer block type
    
    Since:
    
    2020.2.1
  - setBlockType
```
public void setBlockType(int blockType)
```
    Updates the current address the FAR address to point to the block type provided
    
    Parameters:
    
    blockType - The desired block type to set within the FAR address
    
    Since:
    
    2020.2.1
  - getRow
```
public int getRow()
```
    Gets the current row to which the FAR address is currently set
    
    Returns:
    
    The current config row
    
    Since:
    
    2020.2.1
  - setRow
```
public void setRow(int row)
```
    Updates the current row to which the FAR address is currently set
    
    Parameters:
    
    row - The desired config row
    
    Since:
    
    2020.2.1
  - getColumn
```
public int getColumn()
```
    Gets the current column to which the FAR address is currently set
    
    Returns:
    
    The current config column
    
    Since:
    
    2020.2.1
  - setColumn
```
public void setColumn(int col)
```
    Updates the current column to which the FAR address is currently set
    
    Parameters:
    
    col - The desired config column
    
    Since:
    
    2020.2.1
  - getMinor
```
public int getMinor()
```
    Gets the minor frame address to which the FAR address is currently set
    
    Returns:
    
    The current minor frame index
    
    Since:
    
    2020.2.1
  - setMinor
```
public void setMinor(int minor)
```
    Updates the minor frame address to which the FAR address is currently set
    
    Parameters:
    
    minor - The desired minor frame index
    
    Since:
    
    2020.2.1
  - getDevice
```
public Device getDevice()
```
    Gets the current device associated with this FAR
    
    Returns:
    
    The current device
    
    Since:
    
    2020.2.1
  - setConfigArray
```
public void setConfigArray(ConfigArray configArray)
```
    Sets the current config array associated with this FAR
    
    Parameters:
    
    configArray - The desired config array for this FAR
    
    Since:
    
    2020.2.1
  - getConfigArray
```
public ConfigArray getConfigArray()
```
    Gets the current config array associated with the FAR
    
    Returns:
    
    This FAR's current config array
    
    Since:
    
    2020.2.1
  - getSeries
```
public Series getSeries()
```
    Gets the target series of this FAR
    
    Returns:
    
    The target series
    
    Since:
    
    2020.2.1
  - setFAR
```
public boolean setFAR(int address)
```
    Sets the FAR object to the specified address.
    
    Parameters:
    
    address - The desired FAR address to set.
    
    Returns:
    
    True if the address was set correctly, false if invalid.
    
    Since:
    
    2020.2.1
  - getCurrentFAR
```
public int getCurrentFAR()
```
    Gets the current address of the FAR object.
    
    Returns:
    
    The current address of the FAR.
    
    Since:
    
    2020.2.1
  - incrementFAR
```
public int incrementFAR()
```
    Gets the next valid FAR address in the device given the current address. If the FAR is at the last valid address, the FAR is not incremented and -1 is returned.
    
    Returns:
    
    The next valid FAR address or -1 if reached the end of the configuration address range.
    
    Since:
    
    2020.2.1
  - getConfigBlock
```
public Block getConfigBlock()
```
    Gets the configuration block from current FAR address, assumes a single SLR or SLR with config order 0.
    
    Returns:
    
    The current configuration block.
    
    Since:
    
    2020.2.1
  - getConfigBlock
```
public Block getConfigBlock(int slrCfgOrder)
```
    Gets the configuration block from current FAR address.
    
    Parameters:
    
    slrCfgOrder - The config order index of the SLR of the block to get
    
    Returns:
    
    The current configuration block.
    
    Since:
    
    2023.1.3
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hasTopBotBit
```
public boolean hasTopBotBit()
```
    Checks if the FAR has a top/bottom bit field (only relevant for Series 7 devices)
    
    Returns:
    
    True if this FAR has a top/bottom bit, false otherwise.
    
    Since:
    
    2020.2.1
  - getTopBotBit
```
public int getTopBotBit()
```
    Gets the top/bottom bit from the current address set in this FAR (only relevant for Series 7 devices)
    
    Returns:
    
    The top/bottom bit in the FAR.
    
    Since:
    
    2020.2.1
  - setTopBotBit
```
public void setTopBotBit(int topBotBit)
```
    Updates the top/bottom bit from the current address set in this FAR (only relevant for Series 7 devices)
    
    Parameters:
    
    topBotBit - The desired top/bottom bit in the FAR.
    
    Since:
    
    2020.2.1
  - getMinorAddress
```
public static int getMinorAddress(int farAddress,
                                  Series s)
```
    Extracts the minor address frame index from a 32-bit FAR address.
    
    Parameters:
    
    farAddress - The full 32-bit FAR address
    
    s - The series of the device being targeted
    
    Returns:
    
    The minor address specified in the FAR address.
    
    Since:
    
    2020.2.1
  - getColumnAddress
```
public static int getColumnAddress(int farAddress,
                                   Series s)
```
    Extracts the column address from a 32-bit FAR address.
    
    Parameters:
    
    farAddress - The full 32-bit FAR address
    
    s - The series of the device being targeted
    
    Returns:
    
    The column address specified in the FAR address.
    
    Since:
    
    2020.2.1
  - getRowAddress
```
public static int getRowAddress(int farAddress,
                                Series s)
```
    Extracts the row address from a 32-bit FAR address.
    
    Parameters:
    
    farAddress - The full 32-bit FAR address
    
    s - The devices series this FAR address targets
    
    Returns:
    
    The row address specified in the FAR address.
    
    Since:
    
    2020.2.1
  - getTopBotBit
```
public static int getTopBotBit(int farAddress,
                               Series s)
```
    For Series 7 devices, it returns the top or bottom bit. For all other devices, it returns 0.
    
    Parameters:
    
    farAddress - The full 32-bit FAR address
    
    s - The devices series this FAR address targets
    
    Returns:
    
    If a Series 7 device, returns the top/bottom bit (bottom=1).
    
    Since:
    
    2020.2.1
  - getBlockType
```
public static int getBlockType(int farAddress,
                               Series s)
```
    Extracts the block type from a 32-bit FAR address.
    
    Parameters:
    
    farAddress - The full 32-bit FAR address
    
    s - The series of the device being targeted
    
    Returns:
    
    The block type specified in the FAR address.
    
    Since:
    
    2020.2.1
  - getBlockAddress
```
public int getBlockAddress()
```
    Gets the current FAR address of the current block. This is all of the fields except the minor address, which is set to zero.
    
    Returns:
    
    The current block address set in this FAR
    
    Since:
    
    2020.2.1
  - getBlockAddress
```
public static int getBlockAddress(int farAddress,
                                  Series series)
```
    Gets the unique block address for the given FAR address. It essentially removes (zeros out) the minor field.
    
    Parameters:
    
    farAddress - The FAR address
    
    series - The series of the target device
    
    Returns:
    
    The block address of the FAR address.
    
    Since:
    
    2020.2.1
  - getTopBot
```
public static int getTopBot(Tile tile)
```
    Gets the top/bottom bit for a particular tile by looking at the config row and SLR.
    
    Parameters:
    
    tile - The tile in the device of interest.
    
    Returns:
    
    0 if it is top (or all UltraScale/UltraScale+ devices) 1 if bottom.
    
    Since:
    
    2020.2.1
  - getFARConfigRowIndex
```
public static int getFARConfigRowIndex(Tile tile)
```
    Gets the FAR row index based on the the tile's clock region.
    
    Parameters:
    
    tile - The tile of interest
    
    Returns:
    
    The row index (accounting for top/bottom in Series 7) corresponding to the tile.
    
    Since:
    
    2020.2.1
  - isLastFrameInRow
```
public boolean isLastFrameInRow()
```
    Checks if the FAR is currently pointing at the last frame in the config row
    
    Returns:
    
    True if the FAR is set to the final frame index of a row, false otherwise
    
    Since:
    
    2020.2.1
  - isFirstFrameInRow
```
public boolean isFirstFrameInRow()
```
    Checks if the FAR is currently pointing at the first frame in the config row
    
    Returns:
    
    True if the FAR is set to the first frame index of a row, false otherwise
    
    Since:
    
    2020.2.1

Class FAR

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

TOP_HALF

BOT_HALF

Constructor Detail

FAR

Method Detail

getBlockType

setBlockType

getRow

setRow

getColumn

setColumn

getMinor

setMinor

getDevice

setConfigArray

getConfigArray

getSeries

setFAR

getCurrentFAR

incrementFAR

getConfigBlock

getConfigBlock

toString

hasTopBotBit

getTopBotBit

setTopBotBit

getMinorAddress

getColumnAddress

getRowAddress

getTopBotBit

getBlockType

getBlockAddress

getBlockAddress

getTopBot

getFARConfigRowIndex

isLastFrameInRow

isFirstFrameInRow