librelane 2.4.3__tar.gz → 2.4.4__tar.gz

{librelane-2.4.3 → librelane-2.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: librelane
-Version: 2.4.3
+Version: 2.4.4
 Summary: An infrastructure for implementing chip design flows
 Home-page: https://github.com/librelane/librelane
 License: Apache-2.0

{librelane-2.4.3 → librelane-2.4.4}/librelane/__init__.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 """
 The LibreLane API
-----------------
+-----------------
 
 Documented elements of this API represent the primary programming interface for
 the LibreLane infrastructure.

{librelane-2.4.3 → librelane-2.4.4}/librelane/__main__.py

@@ -220,7 +220,10 @@ def print_version(ctx: click.Context, param: click.Parameter, value: bool):
     if len(discovered_plugins) > 0:
         print("Discovered plugins:")
         for name, module in discovered_plugins.items():
-            print(f"{name} -> {module.__version__}")
+            if hasattr(module, "__version__"):
+                print(f"{name} -> {module.__version__}")
+            else:
+                print(f"{name}")
 
     ctx.exit(0)
 

{librelane-2.4.3 → librelane-2.4.4}/librelane/common/tcl.py

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import re
-import tkinter
 from typing import Dict, Mapping, Any, Iterable
 
 _env_rx = re.compile(r"(?:\:\:)?env\((\w+)\)")
@@ -55,6 +54,8 @@ class TclUtils(object):
 
     @staticmethod
     def _eval_env(env_in: Mapping[str, Any], tcl_in: str) -> Dict[str, Any]:
+        import tkinter
+
         interpreter = tkinter.Tcl()
 
         interpreter.eval("array unset ::env")

{librelane-2.4.3 → librelane-2.4.4}/librelane/container.py

@@ -57,10 +57,13 @@ def gui_args(osinfo: OSInfo) -> List[str]:
             args += [
                 "-e",
                 f"DISPLAY={os.environ.get('DISPLAY')}",
-                "-v",
-                "/tmp/.X11-unix:/tmp/.X11-unix",
-                "-v",
-                f"{os.path.expanduser('~')}/.Xauthority:/.Xauthority",
+            ]
+            if os.path.isdir("/tmp/.X11-unix"):
+                args += ["-v", "/tmp/.X11-unix:/tmp/.X11-unix"]
+            homedir = os.path.expanduser("~")
+            if os.path.isfile(f"{homedir}/.Xauthority"):
+                args += ["-v", f"{homedir}/.Xauthority:/.Xauthority"]
+            args += [
                 "--network",
                 "host",
                 "--security-opt",

librelane-2.4.4/librelane/examples/hold_eco_demo/config.yaml

@@ -0,0 +1,18 @@
+DESIGN_NAME: hold_violation
+CLOCK_PORT: clk
+CLOCK_PERIOD: 5
+VERILOG_FILES: dir::demo.v
+RUN_POST_CTS_RESIZER_TIMING: false
+RUN_POST_GRT_RESIZER_TIMING: false
+FP_SIZING: absolute
+DIE_AREA: [0, 0, 100, 100]
+INSERT_ECO_BUFFERS:
+  - target: u_ff1/Q
+    buffer: sky130_fd_sc_hd__buf_1
+  - target: u_ff1/Q
+    buffer: sky130_fd_sc_hd__buf_1
+meta:
+  flow: Classic
+  substituting_steps:
+    "+OpenROAD.DetailedRouting": "Odb.InsertECOBuffers"
+    "+Odb.InsertECOBuffers": "OpenROAD.DetailedRouting"

librelane-2.4.4/librelane/examples/hold_eco_demo/demo.v

@@ -0,0 +1,27 @@
+module hold_violation(
+    input clk,
+    input d,
+    output q
+);
+    wire intermediate;
+    wire clk_delayed;
+
+    sky130_fd_sc_hd__clkbuf_4 dly (
+        .A(clk),
+        .X(clk_delayed)
+    );
+
+    sky130_fd_sc_hd__dfrtp_4 u_ff1 (
+        .CLK(clk),
+        .D(d),
+        .RESET_B(1'b1),
+        .Q(intermediate)
+    );
+
+    sky130_fd_sc_hd__dfrtp_1 u_ff2 (
+        .CLK(clk_delayed),
+        .D(intermediate),
+        .RESET_B(1'b1),
+        .Q(q)
+    );
+endmodule

{librelane-2.4.3 → librelane-2.4.4}/librelane/scripts/odbpy/eco_buffer.py

@@ -43,7 +43,8 @@ def cli(reader):
     grt_inc = GRT.IncrementalGRoute(grt, reader.block)
     i = 0
 
-    for target_info in reader.config["INSERT_ECO_BUFFERS"]:
+    eco_buffers = reader.config["INSERT_ECO_BUFFERS"] or []
+    for target_info in eco_buffers:
         target_name, target_pin = target_info["target"].split("/")
         name_escaped = reader.escape_verilog_name(target_name)
         buffer_master = target_info["buffer"]

{librelane-2.4.3 → librelane-2.4.4}/librelane/scripts/odbpy/eco_diode.py

@@ -38,7 +38,8 @@ def cli(reader):
     # print(grt)
     grt_inc = GRT.IncrementalGRoute(grt, reader.block)
     i = 0
-    for target_info in reader.config["INSERT_ECO_DIODES"]:
+    diodes = reader.config["INSERT_ECO_DIODES"] or []
+    for target_info in diodes:
         target_name, target_pin = target_info["target"].split("/")
         name_escaped = reader.escape_verilog_name(target_name)
 

{librelane-2.4.3 → librelane-2.4.4}/librelane/steps/__main__.py

@@ -47,8 +47,9 @@ def load_step_from_inputs(
         if Found := Step.factory.get(id):
             Target = Found
         else:
-            err(
-                f"No step registered with id '{id}'. Ensure all relevant plugins are installed."
+            err(f"No step registered with id '{id}'.")
+            info(
+                f"If the step '{id}' is part of a plugin, make sure the plugin's parent directory is in the PYTHONPATH environment variable."
             )
             ctx.exit(-1)
 

{librelane-2.4.3 → librelane-2.4.4}/librelane/steps/checker.py

@@ -79,22 +79,21 @@ class MetricChecker(Step):
     deferred: ClassVar[bool] = True
     error_on_var: Optional[Variable] = None
 
-    @classmethod
-    def get_help_md(Self, **kwargs):  # pragma: no cover
-        threshold_string = Self.get_threshold_description(None)
+    def __init_subclass__(cls):
+        threshold_string = cls.get_threshold_description(None)
         if threshold_string is None:
-            threshold_string = str(Self.get_threshold(None))
+            threshold_string = str(cls.get_threshold(None))
         dynamic_docstring = "Raises"
-        if Self.deferred:
+        if cls.deferred:
             dynamic_docstring += " a deferred error"
         else:
             dynamic_docstring += " an immediate error"
-        dynamic_docstring += f" if {Self.metric_description} (metric: ``{Self.metric_name}``) are >= {threshold_string}."
+        dynamic_docstring += f" if {cls.metric_description} (metric: ``{cls.metric_name}``) are >= {threshold_string}."
         dynamic_docstring += (
             " Doesn't raise an error depending on error_on_var if defined."
         )
-
-        return super().get_help_md(docstring_override=dynamic_docstring, **kwargs)
+        cls.__doc__ = dynamic_docstring
+        return super().__init_subclass__()
 
     def get_threshold(self: Optional["MetricChecker"]) -> Optional[Decimal]:
         return Decimal(0)

{librelane-2.4.3 → librelane-2.4.4}/librelane/steps/klayout.py

@@ -327,6 +327,15 @@ class XOR(KLayoutStep):
 
 @Step.factory.register()
 class DRC(KLayoutStep):
+    """
+    Runs DRC using KLayout.
+
+    Unlike most steps, the KLayout scripts vary quite wildly by PDK. If a PDK
+    is not supported by this step, it will simply be skipped.
+
+    Currently, only sky130A and sky130B are supported.
+    """
+
     id = "KLayout.DRC"
     name = "Design Rule Check (KLayout)"
 

{librelane-2.4.3 → librelane-2.4.4}/librelane/steps/misc.py

@@ -53,6 +53,11 @@ class LoadBaseSDC(Step):
 
 @Step.factory.register()
 class ReportManufacturability(Step):
+    """
+    Logs a simple "manufacturability report", i.e., the status of DRC, LVS, and
+    antenna violations.
+    """
+
     id = "Misc.ReportManufacturability"
     name = "Report Manufacturability"
     long_name = "Report Manufacturability (DRC, LVS, Antenna)"

{librelane-2.4.3 → librelane-2.4.4}/librelane/steps/odb.py

@@ -176,6 +176,10 @@ class OdbpyStep(Step):
 
 @Step.factory.register()
 class CheckMacroAntennaProperties(OdbpyStep):
+    """
+    Prints warnings if the LEF views of macros are missing antenna information.
+    """
+
     id = "Odb.CheckMacroAntennaProperties"
     name = "Check Antenna Properties of Macros Pins in Their LEF Views"
     inputs = OdbpyStep.inputs
@@ -213,6 +217,10 @@ class CheckMacroAntennaProperties(OdbpyStep):
 
 @Step.factory.register()
 class CheckDesignAntennaProperties(CheckMacroAntennaProperties):
+    """
+    Prints warnings if the LEF view of the design is missing antenna information.
+    """
+
     id = "Odb.CheckDesignAntennaProperties"
     name = "Check Antenna Properties of Pins in The Generated Design LEF view"
     inputs = CheckMacroAntennaProperties.inputs + [DesignFormat.LEF]
@@ -519,6 +527,11 @@ class ReportDisconnectedPins(OdbpyStep):
 
 @Step.factory.register()
 class AddRoutingObstructions(OdbpyStep):
+    """
+    Adds obstructions on metal layers which prevent shapes from being created in
+    the designated areas.
+    """
+
     id = "Odb.AddRoutingObstructions"
     name = "Add Obstructions"
     config_vars = [
@@ -561,6 +574,11 @@ class AddRoutingObstructions(OdbpyStep):
 
 @Step.factory.register()
 class RemoveRoutingObstructions(AddRoutingObstructions):
+    """
+    Removes any routing obstructions previously placed by
+    <#Odb.AddRoutingObstructions>`_.
+    """
+
     id = "Odb.RemoveRoutingObstructions"
     name = "Remove Obstructions"
 
@@ -570,6 +588,15 @@ class RemoveRoutingObstructions(AddRoutingObstructions):
 
 @Step.factory.register()
 class AddPDNObstructions(AddRoutingObstructions):
+    """
+    Adds obstructions on metal layers which prevent shapes from being created in
+    the designated areas.
+
+    A soft-duplicate of <#Odb.AddRoutingObstructions>`_ , though this one uses
+    a different variable name so the obstructions can be restricted for PDN
+    steps only.
+    """
+
     id = "Odb.AddPDNObstructions"
     name = "Add PDN obstructions"
 
@@ -587,6 +614,11 @@ class AddPDNObstructions(AddRoutingObstructions):
 
 @Step.factory.register()
 class RemovePDNObstructions(RemoveRoutingObstructions):
+    """
+    Removes any PDN obstructions previously placed by
+    <#Odb.RemovePDNObstructions>`_.
+    """
+
     id = "Odb.RemovePDNObstructions"
     name = "Remove PDN obstructions"
 

{librelane-2.4.3 → librelane-2.4.4}/librelane/steps/openroad.py

@@ -1051,11 +1051,6 @@ class IOPlacement(OpenROADStep):
                 Optional[Path],
                 "Path to a custom pin configuration file.",
             ),
-            Variable(
-                "FP_DEF_TEMPLATE",
-                Optional[Path],
-                "Points to the DEF file to be used as a template.",
-            ),
             Variable(
                 "FP_IO_VLENGTH",
                 Optional[Decimal],
@@ -1327,11 +1322,6 @@ class GlobalPlacementSkipIO(_GlobalPlacement):
             default="matching",
             deprecated_names=[("FP_IO_MODE", _migrate_ppl_mode)],
         ),
-        Variable(
-            "FP_DEF_TEMPLATE",
-            Optional[Path],
-            "Points to the DEF file to be used as a template.",
-        ),
     ]
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:

{librelane-2.4.3 → librelane-2.4.4}/librelane/steps/pyosys.py

@@ -302,6 +302,12 @@ class VerilogStep(PyosysStep):
 
 @Step.factory.register()
 class JsonHeader(VerilogStep):
+    """
+    Extracts a high-level hierarchical view of the circuit in JSON format,
+    including power connections. The power connections are used in later steps
+    to ensure macros and cells are connected as desired.
+    """
+
     id = "Yosys.JsonHeader"
     name = "Generate JSON Header"
     long_name = "Generate JSON Header"

{librelane-2.4.3 → librelane-2.4.4}/librelane/steps/yosys.py

@@ -248,6 +248,14 @@ class YosysStep(TclStep):
 
 @Step.factory.register()
 class EQY(Step):
+    """
+    Experimental: Uses the `EQY <https://github.com/yosyshq/eqy>`_ utility to
+    perform an RTL vs. Netlist equivalence check.
+
+    Currently, you are expected to provide your own EQY script if you want this
+    to work properly.
+    """
+
     id = "Yosys.EQY"
     name = "Equivalence Check"
     long_name = "RTL/Netlist Equivalence Check"
@@ -262,7 +270,7 @@ class EQY(Step):
             Variable(
                 "EQY_SCRIPT",
                 Optional[Path],
-                "An optional override for the automatically generated EQY script for more complex designs.",
+                "The EQY script to use. If unset, a generic EQY script will be generated, but this fails in a number of scenarios.",
             ),
             Variable(
                 "MACRO_PLACEMENT_CFG",

{librelane-2.4.3 → librelane-2.4.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "librelane"
-version = "2.4.3"
+version = "2.4.4"
 description = "An infrastructure for implementing chip design flows"
 # Technically, maintainer. We cannot use the maintainers field until
 # poetry-core>=2.0.0 which requires Python version 3.9+. This field does
@@ -68,6 +68,12 @@ librelane = "librelane.__main__:cli"
 "librelane.help" = "librelane.help.__main__:cli"
 "librelane.env_info" = "librelane:env_info_cli"
 
+[tool.ruff]
+# syntax-only check, make sure files are parseable under py38
+# $ ruff check .
+target-version = "py38"
+lint.ignore = ["E", "F"] 
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"