Cleanup & Documentation

efabless · Sep 29, 2024 · fd5df84 · fd5df84
1 parent 4fa5151
commit fd5df84
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 23 deletions.
diff --git a/openlane/scripts/odbpy/cell_frequency.py b/openlane/scripts/odbpy/cell_frequency.py
@@ -1,13 +1,10 @@
-# Copyright 2022 Efabless Corporation
-#
-# This file is part of the DFFRAM Memory Compiler.
-# See https://github.com/Cloud-V/DFFRAM for further info.
+# Copyright 2024 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#      http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/openlane/scripts/odbpy/disconnected_pins.py b/openlane/scripts/odbpy/disconnected_pins.py
@@ -1,13 +1,10 @@
 # Copyright 2022 Efabless Corporation
 #
-# This file is part of the DFFRAM Memory Compiler.
-# See https://github.com/Cloud-V/DFFRAM for further info.
-#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#      http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/openlane/scripts/odbpy/wire_lengths.py b/openlane/scripts/odbpy/wire_lengths.py
@@ -1,13 +1,10 @@
 # Copyright 2022 Efabless Corporation
 #
-# This file is part of the DFFRAM Memory Compiler.
-# See https://github.com/Cloud-V/DFFRAM for further info.
-#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#      http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,

diff --git a/openlane/scripts/openroad/antenna_repair.tcl b/openlane/scripts/openroad/antenna_repair.tcl
@@ -28,7 +28,4 @@ source $::env(SCRIPTS_DIR)/openroad/common/grt.tcl
 source $::env(SCRIPTS_DIR)/openroad/common/set_rc.tcl
 estimate_parasitics -global_routing
 
-report_cell_count
-report_design_area_metrics
-
 write_views
diff --git a/openlane/scripts/openroad/fill.tcl b/openlane/scripts/openroad/fill.tcl
@@ -26,8 +26,5 @@ foreach {pattern} $::env(FILL_CELL) {
 puts $fill_list
 filler_placement $fill_list
 
-report_cell_count
-report_design_area_metrics
-
 write_views
 
diff --git a/openlane/scripts/openroad/floorplan.tcl b/openlane/scripts/openroad/floorplan.tcl
@@ -139,7 +139,4 @@ source $::env(TRACKS_INFO_FILE_PROCESSED)
 write_metric_str "design__die__bbox"  $::env(DIE_AREA)
 write_metric_str "design__core__bbox" $::env(CORE_AREA)
 
-report_cell_count
-report_design_area_metrics
-
 write_views
diff --git a/openlane/scripts/openroad/tapcell.tcl b/openlane/scripts/openroad/tapcell.tcl
@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 source $::env(SCRIPTS_DIR)/openroad/common/io.tcl
-source $::env(SCRIPTS_DIR)/openroad/common/report_cell_count.tcl
 read_current_odb
 
 tapcell\

diff --git a/openlane/steps/odb.py b/openlane/steps/odb.py
@@ -859,6 +859,18 @@ class HeuristicDiodeInsertion(CompositeStep):
 
 @Step.factory.register()
 class CellFrequencyTables(OdbpyStep):
+    """
+    Creates a number of tables to show the cell frequencies by:
+
+    - Cells
+    - Buffer cells only
+    - Cell Function*
+    - Standard Cell Library*
+
+    * These tables only return meaningful info with PDKs distributed in the
+      Open_PDKs format, i.e., all cells are named ``{scl}__{cell_fn}_{size}``.
+    """
+
     id = "Odb.CellFrequencyTables"
     name = "Generate Cell Frequency Tables"