Ctrl+K

piel.integration.amaranth_openlane

piel.integration.amaranth_openlane#

This file enhances some functions that easily translates between an amaranth function to implement a openlane flow.

Module Contents#

Functions#

layout_amaranth_truth_table_through_openlane(...[, ...])

This function implements an amaranth truth-table module through the openlane flow. There are several ways to
layout_amaranth_truth_table_through_openlane(amaranth_module: amaranth.Module, inputs_name_list: list[str], outputs_name_list: list[str], parent_directory: piel.types.piel_path_types, target_directory_name: str | None = None, openlane_version: Literal[v1, v2] = 'v2', **kwargs)[source]#

This function implements an amaranth truth-table module through the openlane flow. There are several ways to implement a module. Fundamentally, this requires the verilog files to be generated from the openlane-module in a particular directory. For the particular directory provided, this function will generate the verilog files in the corresponding directory. It can also generate the openlane configuration files for this particular location.

This function does a few things:

  1. Starts off from a amaranth module class.

  2. Determines the output directory in which to generate the files, and creates one accordingly if it does not exist.

  3. Generates the verilog files from the amaranth module class.

  4. Generates the openlane configuration files for this particular location.

  5. Implements the openlane flow for this particular location to generate a chip.

Parameters:

  • amaranth_module (amaranth.Module) – Amaranth module class.

  • inputs_name_list (list[str]) – List of input names.

  • outputs_name_list (list[str]) – List of output names.

  • parent_directory (piel_path_types) – Parent directory PATH.

  • target_directory_name (Optional[str]) – Target directory name. If none is provided, it will default to the name of the amaranth elaboratable class.

  • openlane_version (Literal["v1", "v2"]) – OpenLane version. Defaults to v1.

Returns:

None

Contents