FABulous.FABulous_API

FABulous API module for fabric and geometry generation.

This module provides the main API class for managing FPGA fabric generation, including parsing fabric definitions, generating HDL code, creating geometries, and handling various fabric-related operations.

Classes

class FABulous_API(writer, fabricCSV='')

Class for managing fabric and geometry generation.

This class parses fabric data from ‘fabric.csv’, generates fabric layouts, geometries, models for nextpnr, as well as other fabric-related functions.

If ‘fabricCSV’ is provided, parses fabric data and initialises ‘fabricGenerator’ and ‘geometryGenerator’ with parsed data.

If using VHDL, changes the extension from ‘.v’ to’.vhdl’.

Parameters:

• writer (CodeGenerator) – Object responsible for generating code from code_generator.py

• fabricCSV (str, optional) – Path to the CSV file containing fabric data, by default “”

geometryGenerator

Object responsible for generating geometry-related outputs.

Type:

GeometryGenerator

fabric

Represents the parsed fabric data.

Type:

Fabric

fileExtension

Default file extension for generated output files (‘.v’ or ‘.vhdl’).

Type:

str

Methods:

addList2Matrix(listFile, matrix)

Convert list into CSV matrix and save it.

Using ‘list2CSV’ defined in ‘fabric_gen.py’.

Parameters:

• listFile (Path) – List data to be converted.

• matrix (Path) – File path where the matrix data will be saved.

Return type:

None

bootstrapSwitchMatrix(tileName, outputDir)

Bootstrap the switch matrix for the specified tile.

Using ‘bootstrapSwitchMatrix’ defined in ‘fabric_gen.py’.

Parameters:

• tileName (str) – Name of the tile for which the switch matrix will be bootstrapped.

• outputDir (Path) – Directory path where the switch matrix will be generated.

Raises:

ValueError – If tile is not found in fabric.

Return type:

None

genBitStreamSpec()

Generate the bitstream specification object.

Returns:

Bitstream specification object generated by ‘fabricGenerator’.

Return type:

dict

genConfigMem(tileName, configMem)

Generate configuration memory for specified tile.

Parameters:

• tileName (str) – Name of the tile for which configuration memory will be generated.

• configMem (Path) – File path where the configuration memory will be saved.

Raises:

ValueError – If tile is not found in fabric.

Return type:

None

genFabric()

Generate the entire fabric layout.

Via ‘generatreFabric’ defined in ‘fabric_gen.py’.

Return type:

None

genFabricIOBels()

Generate the IO BELs for the generative IOs of the fabric.

Return type:

None

genGeometry(geomPadding=8)

Generate geometry based on the fabric data and save it to CSV.

Parameters:

geomPadding (int, optional) – Padding value for geometry generation, by default 8.

Return type:

None

genIOBelForTile(tile_name)

Generate the IO BELs for the generative IOs of a tile.

Config Access Generative IOs will be a separate Bel. Updates the tileDic with the generated IO BELs.

Parameters:

tile_name (str) – Name of the tile to generate IO Bels.

Returns:

The bel object representing the generative IOs.

Return type:

list[Bel]

Raises:

ValueError – If tile not found in fabric. In case of an invalid IO type for generative IOs. If the number of config access ports does not match the number of config bits.

genRoutingModel()

Generate model for Nextpnr based on fabric data.

Returns:

Model generated by ‘model_gen_npnr.genNextpnrModel’.

Return type:

tuple[str, str, str, str]

genSuperTile(tileName)

Generate a super tile based on its name.

Using ‘generateSuperTile’ defined in ‘fabric_gen.py’.

Parameters:

tileName (str) – Name of the super tile generated.

Raises:

ValueError – If super tile is not found in fabric.

Return type:

None

genSwitchMatrix(tileName)

Generate switch matrix for specified tile.

Using ‘genTileSwitchMatrix’ defined in ‘fabric_gen.py’.

Parameters:

tileName (str) – Name of the tile for which the switch matrix will be generated.

Raises:

ValueError – If tile is not found in fabric.

Return type:

None

genTile(tileName)

Generate a tile based on its name.

Using ‘generateTile’ defined in ‘fabric_gen.py’.

Parameters:

tileName (str) – Name of the tile generated.

Raises:

ValueError – If tile is not found in fabric.

Return type:

None

genTopWrapper()

Generate the top wrapper for the fabric.

Using ‘generateTopWrapper’ defined in ‘fabric_gen.py’.

Return type:

None

generateUserDesignTopWrapper(userDesign, topWrapper)

Generate the top wrapper for the user design.

Parameters:

• userDesign (Path) – Path to the user design file.

• topWrapper (Path) – Path to the output top wrapper file.

Return type:

None

getBels()

Return all unique Bels within a fabric.

Returns:

List of all unique Bel objects in the fabric.

Return type:

list[Bel]

getSuperTile(tileName, raises_on_miss=False)

Return ‘SuperTile’ object based on ‘tileName’.

Parameters:

• tileName (str) – Name of the SuperTile.

• raises_on_miss (bool, optional) – Whether to raise an error if the supertile is not found, by default ‘False’.

Returns:

SuperTile object based on tile name, or None if not found.

Return type:

SuperTile | None

Raises:

KeyError – If the supertile specified by ‘tileName’ is not found and ‘raises_on_miss’ is ‘True’.

getSuperTiles()

Return all SuperTiles within a fabric.

Returns:

Collection of all SuperTile objects in the fabric.

Return type:

Iterable[SuperTile]

getTile(tileName, raises_on_miss=False)

Return ‘Tile’ or ‘SuperTile’ object based on ‘tileName’.

Parameters:

• tileName (str) – Name of the Tile.

• raises_on_miss (bool, optional) – Whether to raise an error if the tile is not found, by default ‘False’.

Returns:

‘Tile’ or ‘SuperTile’ object based on tile name, or ‘None’ if not found.

Return type:

Tile | SuperTile | None

Raises:

KeyError – If the tile specified by ‘tileName’ is not found and ‘raises_on_miss’ is ‘True’.

getTiles()

Return all Tiles within a fabric.

Returns:

Collection of all Tile objects in the fabric.

Return type:

Iterable[Tile]

loadFabric(fabric_dir)

Load fabric data from ‘fabric.csv’.

Parameters:

fabric_dir (Path) – Path to CSV file containing fabric data.

Raises:

ValueError – If ‘fabric_dir’ does not end with ‘.csv’

Return type:

None

setWriterOutputFile(outputDir)

Set the output file directory for the write object.

Parameters:

outputDir (Path) – Directory path where output files will be saved.

Return type:

None

Functions