FABulous.fabric_definition.Fabric

FPGA fabric definition module.

This module contains the Fabric class which represents the complete FPGA fabric including tile layout, configuration parameters, and connectivity information. The fabric is the top-level container for all tiles, BELs, and routing resources.

Classes

class Fabric

Store the configuration of a fabric.

All the information is parsed from the CSV file.

tile

The tile map of the fabric

Type:

list[list[Tile]]

name

The name of the fabric

Type:

str

numberOfRows

The number of rows of the fabric

Type:

int

numberOfColumns

The number of columns of the fabric

Type:

int

configBitMode

The configuration bit mode of the fabric. Currently supports frame based or ff chain

Type:

ConfigBitMode

frameBitsPerRow

The number of frame bits per row of the fabric

Type:

int

maxFramesPerCol

The maximum number of frames per column of the fabric

Type:

int

package

The extra package used by the fabric. Only useful for VHDL output.

Type:

str

generateDelayInSwitchMatrix

The amount of delay in a switch matrix.

Type:

int

multiplexerStyle

The style of the multiplexer used in the fabric. Currently supports custom or generic

Type:

MultiplexerStyle

frameSelectWidth

The width of the frame select signal.

Type:

int

rowSelectWidth

The width of the row select signal.

Type:

int

desync_flag

The flag indicating desynchronization status, used to manage timing issues within the fabric.

Type:

int

numberOfBRAMs

The number of BRAMs in the fabric.

Type:

int

superTileEnable

Whether the fabric has super tile.

Type:

bool

tileDic

A dictionary of tiles used in the fabric. The key is the name of the tile and the value is the tile.

Type:

dict[str, Tile]

superTileDic

A dictionary of super tiles used in the fabric. The key is the name of the supertile and the value is the supertile.

Type:

dict[str, SuperTile]

unusedTileDic

A dictionary of tiles that are not used in the fabric, but defined in the fabric.csv. The key is the name of the tile and the value is the tile.

Type:

dict[str, Tile]

unusedSuperTileDic

A dictionary of super tiles that are not used in the fabric, but defined in the fabric.csv. The key is the name of the tile and the value is the tile.

Type:

dict[str, SuperTile]

commonWirePair

A list of common wire pairs in the fabric.

Type:

list[tuple[str, str]]

Methods:

determine_border_side(x, y)

Determine which border side a tile position is on, if any.

Parameters:

• x (int) – X coordinate in the fabric grid

• y (int) – Y coordinate in the fabric grid

Returns:

The border side (NORTH, SOUTH, EAST, or WEST) if the position is on a border, None otherwise. If on a corner, returns the vertical side (NORTH or SOUTH) as priority.

Return type:

Side | None

find_tile_positions(tile)

Find all positions where a tile or supertile appears in the fabric grid.

Parameters:

tile (Tile | SuperTile) – The tile or supertile to search for

Returns:

List of (x, y) positions where the tile/supertile appears, or None if not found

Return type:

list[tuple[int, int]] | None

getAllUniqueBels()

Get all unique BELs from all tiles in the fabric.

Returns:

A list of all unique BELs across all tiles.

Return type:

list[Bel]

getBelsByTileXY(x, y)

Get all the Bels of a tile.

Parameters:

• x (int) – The x coordinate of / column the tile.

• y (int) – The y coordinate / row of the tile.

Returns:

A list of Bels in the tile.

Return type:

list[Bel]

Raises:

ValueError – Tile coordinates are out of range.

getSuperTileByName(name)

Get a supertile by its name from the fabric.

Searches for the supertile first in the used supertiles dictionary, then in the unused supertiles dictionary if not found.

Parameters:

name (str) – The name of the supertile to retrieve.

Returns:

The super tile object if found.

Return type:

SuperTile

Raises:

KeyError – If the super tile name is not found in either used or unused super tiles.

getTileByName(name)

Get a tile by its name from the fabric.

Search for the tile first in the used tiles dictionary, then in the unused tiles dictionary then in the supertiles if not found.

Parameters:

name (str) – The name of the tile to retrieve.

Returns:

The tile or supertile object if found.

Return type:

Tile | SuperTile

Raises:

KeyError – If the tile name is not found in either used or unused tiles.

get_tile_row_column_indices(tile_name)

Get all row and column indices where a tile type appears.

Parameters:

tile_name (str) – Name of the tile type to search for

Returns:

(row_indices, column_indices) where the tile type appears

Return type:

tuple[set[int], set[int]]

get_unique_tile_types()

Get list of unique tile types used in the fabric.

Returns:

List of unique tile types (one instance per type name)

Return type:

list[Tile]