librelane 3.0.0.dev24__py3-none-any.whl → 3.0.0.dev25__py3-none-any.whl

librelane/examples/spm/config.yaml

@@ -7,16 +7,16 @@ PNR_SDC_FILE: dir::src/impl.sdc
 SIGNOFF_SDC_FILE: dir::src/signoff.sdc
 
 # PDN
-FP_PDN_VOFFSET: 5
-FP_PDN_HOFFSET: 5
-FP_PDN_VWIDTH: 2
-FP_PDN_HWIDTH: 2
-FP_PDN_VPITCH: 30
-FP_PDN_HPITCH: 30
-FP_PDN_SKIPTRIM: true
+PDN_VOFFSET: 5
+PDN_HOFFSET: 5
+PDN_VWIDTH: 2
+PDN_HWIDTH: 2
+PDN_VPITCH: 30
+PDN_HPITCH: 30
+PDN_SKIPTRIM: true
 
 # Pin Order
-FP_PIN_ORDER_CFG: dir::pin_order.cfg
+IO_PIN_ORDER_CFG: dir::pin_order.cfg
 
 # Technology-Specific Configs
 pdk::sky130*:

librelane/examples/spm-user_project_wrapper/config.json

@@ -1,13 +1,25 @@
 {
     "DESIGN_NAME": "SPM_example",
-    "VERILOG_FILES": ["dir::./defines.v", "dir::./SPM_example.v"],
+    "VERILOG_FILES": [
+        "dir::./defines.v",
+        "dir::./SPM_example.v"
+    ],
     "CLOCK_PERIOD": 25,
     "CLOCK_PORT": "wb_clk_i",
     "CLOCK_NET": "SPM.clk",
     "RT_MAX_LAYER": "met4",
     "FP_SIZING": "absolute",
-    "VDD_NETS": ["vccd1"],
-    "GND_NETS": ["vssd1"],
-    "FP_PDN_MULTILAYER": false,
-    "DIE_AREA": [0, 0, 600, 600]
+    "VDD_NETS": [
+        "vccd1"
+    ],
+    "GND_NETS": [
+        "vssd1"
+    ],
+    "PDN_MULTILAYER": false,
+    "DIE_AREA": [
+        0,
+        0,
+        600,
+        600
+    ]
 }

librelane/scripts/openroad/common/io.tcl

@@ -99,23 +99,35 @@ proc read_pdn_cfg {} {
 
     # Compatibility Layer for Deprecated Variables That May Still Be Used By
     # User Files
-    set ::env(DESIGN_IS_CORE) $::env(FP_PDN_MULTILAYER)
-    set ::env(FP_PDN_ENABLE_MACROS_GRID) $::env(PDN_CONNECT_MACROS_TO_GRID)
-    set ::env(FP_PDN_RAILS_LAYER) $::env(FP_PDN_RAIL_LAYER)
-    set ::env(FP_PDN_UPPER_LAYER) $::env(FP_PDN_HORIZONTAL_LAYER)
-    set ::env(FP_PDN_LOWER_LAYER) $::env(FP_PDN_VERTICAL_LAYER)
+    set unset_list {
+        DESIGN_IS_CORE
+        PDN_ENABLE_MACROS_GRID
+        PDN_RAILS_LAYER
+        PDN_UPPER_LAYER
+        PDN_LOWER_LAYER
+    }
+    set ::env(DESIGN_IS_CORE) $::env(PDN_MULTILAYER)
+    set ::env(PDN_ENABLE_MACROS_GRID) $::env(PDN_CONNECT_MACROS_TO_GRID)
+    set ::env(PDN_RAILS_LAYER) $::env(PDN_RAIL_LAYER)
+    set ::env(PDN_UPPER_LAYER) $::env(PDN_HORIZONTAL_LAYER)
+    set ::env(PDN_LOWER_LAYER) $::env(PDN_VERTICAL_LAYER)
+    foreach key [array names ::env] {
+        if { [string match PDN_* $key] } {
+            set fp_name FP_$key
+            lappend unset_list $fp_name
+            set ::env($fp_name) $::env($key)
+        }
+    }
 
-    if {[catch {source $::env(FP_PDN_CFG)} errmsg]} {
+    if {[catch {source $::env(PDN_CFG)} errmsg]} {
         puts stderr $errmsg
         exit 1
     }
 
     # Restore Environment
-    unset ::env(DESIGN_IS_CORE)
-    unset ::env(FP_PDN_ENABLE_MACROS_GRID)
-    unset ::env(FP_PDN_RAILS_LAYER)
-    unset ::env(FP_PDN_UPPER_LAYER)
-    unset ::env(FP_PDN_LOWER_LAYER)
+    foreach unsettable $unset_list {
+        unset ::env($unsettable)
+    }
 }
 
 

librelane/scripts/openroad/common/pdn_cfg.tcl

@@ -43,83 +43,83 @@ foreach vdd $::env(VDD_NETS) gnd $::env(GND_NETS) {
 set_voltage_domain -name CORE -power $::env(VDD_NET) -ground $::env(GND_NET) \
     -secondary_power $secondary
 
-if { $::env(FP_PDN_MULTILAYER) == 1 } {
+if { $::env(PDN_MULTILAYER) == 1 } {
     define_pdn_grid \
         -name stdcell_grid \
         -starts_with POWER \
         -voltage_domain CORE \
-        -pins "$::env(FP_PDN_VERTICAL_LAYER) $::env(FP_PDN_HORIZONTAL_LAYER)"
+        -pins "$::env(PDN_VERTICAL_LAYER) $::env(PDN_HORIZONTAL_LAYER)"
 
     add_pdn_stripe \
         -grid stdcell_grid \
-        -layer $::env(FP_PDN_VERTICAL_LAYER) \
-        -width $::env(FP_PDN_VWIDTH) \
-        -pitch $::env(FP_PDN_VPITCH) \
-        -offset $::env(FP_PDN_VOFFSET) \
-        -spacing $::env(FP_PDN_VSPACING) \
+        -layer $::env(PDN_VERTICAL_LAYER) \
+        -width $::env(PDN_VWIDTH) \
+        -pitch $::env(PDN_VPITCH) \
+        -offset $::env(PDN_VOFFSET) \
+        -spacing $::env(PDN_VSPACING) \
         -starts_with POWER -extend_to_core_ring
 
     add_pdn_stripe \
         -grid stdcell_grid \
-        -layer $::env(FP_PDN_HORIZONTAL_LAYER) \
-        -width $::env(FP_PDN_HWIDTH) \
-        -pitch $::env(FP_PDN_HPITCH) \
-        -offset $::env(FP_PDN_HOFFSET) \
-        -spacing $::env(FP_PDN_HSPACING) \
+        -layer $::env(PDN_HORIZONTAL_LAYER) \
+        -width $::env(PDN_HWIDTH) \
+        -pitch $::env(PDN_HPITCH) \
+        -offset $::env(PDN_HOFFSET) \
+        -spacing $::env(PDN_HSPACING) \
         -starts_with POWER -extend_to_core_ring
 
     add_pdn_connect \
         -grid stdcell_grid \
-        -layers "$::env(FP_PDN_VERTICAL_LAYER) $::env(FP_PDN_HORIZONTAL_LAYER)"
+        -layers "$::env(PDN_VERTICAL_LAYER) $::env(PDN_HORIZONTAL_LAYER)"
 } else {
     define_pdn_grid \
         -name stdcell_grid \
         -starts_with POWER \
         -voltage_domain CORE \
-        -pins $::env(FP_PDN_VERTICAL_LAYER)
+        -pins $::env(PDN_VERTICAL_LAYER)
 
     add_pdn_stripe \
         -grid stdcell_grid \
-        -layer $::env(FP_PDN_VERTICAL_LAYER) \
-        -width $::env(FP_PDN_VWIDTH) \
-        -pitch $::env(FP_PDN_VPITCH) \
-        -offset $::env(FP_PDN_VOFFSET) \
-        -spacing $::env(FP_PDN_VSPACING) \
+        -layer $::env(PDN_VERTICAL_LAYER) \
+        -width $::env(PDN_VWIDTH) \
+        -pitch $::env(PDN_VPITCH) \
+        -offset $::env(PDN_VOFFSET) \
+        -spacing $::env(PDN_VSPACING) \
         -starts_with POWER -extend_to_core_ring
 }
 
 # Adds the standard cell rails if enabled.
-if { $::env(FP_PDN_ENABLE_RAILS) == 1 } {
+if { $::env(PDN_ENABLE_RAILS) == 1 } {
     add_pdn_stripe \
         -grid stdcell_grid \
-        -layer $::env(FP_PDN_RAIL_LAYER) \
-        -width $::env(FP_PDN_RAIL_WIDTH) \
+        -layer $::env(PDN_RAIL_LAYER) \
+        -width $::env(PDN_RAIL_WIDTH) \
         -followpins
 
     add_pdn_connect \
         -grid stdcell_grid \
-        -layers "$::env(FP_PDN_RAIL_LAYER) $::env(FP_PDN_VERTICAL_LAYER)"
+        -layers "$::env(PDN_RAIL_LAYER) $::env(PDN_VERTICAL_LAYER)"
 }
 
 
 # Adds the core ring if enabled.
-if { $::env(FP_PDN_CORE_RING) == 1 } {
-    if { $::env(FP_PDN_MULTILAYER) == 1 } {
+if { $::env(PDN_CORE_RING) == 1 } {
+    if { $::env(PDN_MULTILAYER) == 1 } {
         add_pdn_ring \
             -allow_out_of_die \
             -grid stdcell_grid \
-            -layers "$::env(FP_PDN_VERTICAL_LAYER) $::env(FP_PDN_HORIZONTAL_LAYER)" \
-            -widths "$::env(FP_PDN_CORE_RING_VWIDTH) $::env(FP_PDN_CORE_RING_HWIDTH)" \
-            -spacings "$::env(FP_PDN_CORE_RING_VSPACING) $::env(FP_PDN_CORE_RING_HSPACING)" \
-            -core_offset "$::env(FP_PDN_CORE_RING_VOFFSET) $::env(FP_PDN_CORE_RING_HOFFSET)"
+            -layers "$::env(PDN_VERTICAL_LAYER) $::env(PDN_HORIZONTAL_LAYER)" \
+            -widths "$::env(PDN_CORE_RING_VWIDTH) $::env(PDN_CORE_RING_HWIDTH)" \
+            -spacings "$::env(PDN_CORE_RING_VSPACING) $::env(PDN_CORE_RING_HSPACING)" \
+            -core_offset "$::env(PDN_CORE_RING_VOFFSET) $::env(PDN_CORE_RING_HOFFSET)"
     } else {
-        throw APPLICATION "FP_PDN_CORE_RING cannot be used when FP_PDN_MULTILAYER is set to false."
+        throw APPLICATION "PDN_CORE_RING cannot be used when PDN_MULTILAYER is set to false."
         # add_pdn_ring \
         #     -grid stdcell_grid \
-        #     -layers "$::env(FP_PDN_VERTICAL_LAYER)" \
-        #     -widths "$::env(FP_PDN_CORE_RING_VWIDTH)" \
-        #     -spacings "$::env(FP_PDN_CORE_RING_VSPACING)" \
-        #     -core_offset "$::env(FP_PDN_CORE_RING_VOFFSET)"
+        #     -layers "$::env(PDN_VERTICAL_LAYER)" \
+        #     -widths "$::env(PDN_CORE_RING_VWIDTH)" \
+        #     -spacings "$::env(PDN_CORE_RING_VSPACING)" \
+        #     -core_offset "$::env(PDN_CORE_RING_VOFFSET)"
     }
 }
 
@@ -128,8 +128,8 @@ define_pdn_grid \
     -default \
     -name macro \
     -starts_with POWER \
-    -halo "$::env(FP_PDN_HORIZONTAL_HALO) $::env(FP_PDN_VERTICAL_HALO)"
+    -halo "$::env(PDN_HORIZONTAL_HALO) $::env(PDN_VERTICAL_HALO)"
 
 add_pdn_connect \
     -grid macro \
-    -layers "$::env(FP_PDN_VERTICAL_LAYER) $::env(FP_PDN_HORIZONTAL_LAYER)"
+    -layers "$::env(PDN_VERTICAL_LAYER) $::env(PDN_HORIZONTAL_LAYER)"

librelane/scripts/openroad/ioplacer.tcl

@@ -15,50 +15,51 @@ source $::env(SCRIPTS_DIR)/openroad/common/io.tcl
 read_current_odb
 
 if { [info exists ::env(CONTEXTUAL_IO_FLAG)] } {
-	read_lef $::env(placement_tmpfiles)/top_level.lef
+    read_lef $::env(placement_tmpfiles)/top_level.lef
 }
 
-if { [info exists ::env(FP_IO_HLENGTH)] } {
-	set_pin_length -hor_length $::env(FP_IO_HLENGTH)
+if { [info exists ::env(IO_PIN_H_LENGTH)] } {
+    set_pin_length -hor_length $::env(IO_PIN_H_LENGTH)
 }
 
-if { [info exists ::env(FP_IO_VLENGTH)] } {
-	set_pin_length -ver_length $::env(FP_IO_VLENGTH)
+if { [info exists ::env(IO_PIN_V_LENGTH)] } {
+    set_pin_length -ver_length $::env(IO_PIN_V_LENGTH)
 }
 
-if { $::env(FP_IO_HEXTEND) != "0"} {
-	set_pin_length_extension -hor_extension $::env(FP_IO_HEXTEND)
+if { $::env(IO_PIN_H_EXTENSION) != "0"} {
+    set_pin_length_extension -hor_extension $::env(IO_PIN_H_EXTENSION)
 }
 
-if { $::env(FP_IO_VEXTEND) != "0"} {
-	set_pin_length_extension -ver_extension $::env(FP_IO_VEXTEND)
+if { $::env(IO_PIN_V_EXTENSION) != "0"} {
+    set_pin_length_extension -ver_extension $::env(IO_PIN_V_EXTENSION)
 }
 
-if {$::env(FP_IO_VTHICKNESS_MULT) != "" && $::env(FP_IO_HTHICKNESS_MULT) != ""} {
-	set_pin_thick_multiplier -hor_multiplier $::env(FP_IO_HTHICKNESS_MULT) \
-		-ver_multiplier $::env(FP_IO_VTHICKNESS_MULT)
+if {$::env(IO_PIN_V_THICKNESS_MULT) != "" && $::env(IO_PIN_H_THICKNESS_MULT) != ""} {
+    set_pin_thick_multiplier\
+        -hor_multiplier $::env(IO_PIN_H_THICKNESS_MULT) \
+        -ver_multiplier $::env(IO_PIN_V_THICKNESS_MULT)
 }
 
 set arg_list [list]
-if { $::env(FP_PPL_MODE) == "random_equidistant" } {
-	lappend arg_list -random
+if { $::env(IO_PIN_PLACEMENT_MODE) == "random_equidistant" } {
+    lappend arg_list -random
 }
 
-if { [info exists ::env(FP_IO_MIN_DISTANCE)] } {
-	lappend arg_list -min_distance $::env(FP_IO_MIN_DISTANCE)
+if { [info exists ::env(IO_PIN_MIN_DISTANCE)] } {
+    lappend arg_list -min_distance $::env(IO_PIN_MIN_DISTANCE)
 }
 
-if { $::env(FP_PPL_MODE) == "annealing" } {
-	lappend arg_list -annealing
+if { $::env(IO_PIN_PLACEMENT_MODE) == "annealing" } {
+    lappend arg_list -annealing
 }
 
 set HMETAL $::env(FP_IO_HLAYER)
 set VMETAL $::env(FP_IO_VLAYER)
 
 log_cmd place_pins {*}$arg_list \
-	-random_seed 42 \
-	-hor_layers $HMETAL \
-	-ver_layers $VMETAL
+    -random_seed 42 \
+    -hor_layers $HMETAL \
+    -ver_layers $VMETAL
 
 write_views
 

librelane/scripts/openroad/pdn.tcl

@@ -21,7 +21,7 @@ source $::env(SCRIPTS_DIR)/openroad/common/set_power_nets.tcl
 read_pdn_cfg
 
 set arg_list [list]
-if { $::env(FP_PDN_SKIPTRIM) } {
+if { $::env(PDN_SKIPTRIM) } {
     lappend arg_list -skip_trim
 }
 # run PDNGEN

librelane/steps/common_variables.py

@@ -18,204 +18,253 @@ from ..config import Variable
 
 io_layer_variables = [
     Variable(
-        "FP_IO_VEXTEND",
+        "IO_PIN_V_EXTENSION",
         Decimal,
         "Extends the vertical io pins outside of the die by the specified units.",
         default=0,
         units="µm",
+        deprecated_names=["FP_IO_VEXTEND"],
     ),
     Variable(
-        "FP_IO_HEXTEND",
+        "IO_PIN_H_EXTENSION",
         Decimal,
         "Extends the horizontal io pins outside of the die by the specified units.",
         default=0,
         units="µm",
+        deprecated_names=["FP_IO_HEXTEND"],
     ),
     Variable(
-        "FP_IO_VTHICKNESS_MULT",
+        "IO_PIN_V_THICKNESS_MULT",
         Decimal,
         "A multiplier for vertical pin thickness. Base thickness is the pins layer min width.",
         default=2,
+        deprecated_names=["FP_IO_VTHICKNESS_MULT"],
     ),
     Variable(
-        "FP_IO_HTHICKNESS_MULT",
+        "IO_PIN_H_THICKNESS_MULT",
         Decimal,
         "A multiplier for horizontal pin thickness. Base thickness is the pins layer min width.",
         default=2,
+        deprecated_names=["FP_IO_HTHICKNESS_MULT"],
+    ),
+    Variable(
+        "IO_PIN_V_LENGTH",
+        Optional[Decimal],
+        """
+        The length of the pins with a north or south orientation. If unspecified by a PDK, OpenROAD will use whichever is higher of the following two values:
+            * The pin width
+            * The minimum value satisfying the minimum area constraint given the pin width
+        """,
+        units="µm",
+        pdk=True,
+        deprecated_names=["FP_IO_VLENGTH"],
+    ),
+    Variable(
+        "IO_PIN_H_LENGTH",
+        Optional[Decimal],
+        """
+        The length of the pins with an east or west orientation. If unspecified by a PDK, OpenROAD will use whichever is higher of the following two values:
+            * The pin width
+            * The minimum value satisfying the minimum area constraint given the pin width
+        """,
+        units="µm",
+        pdk=True,
+        deprecated_names=["FP_IO_HLENGTH"],
     ),
 ]
 
 pdn_variables = [
     Variable(
-        "FP_PDN_SKIPTRIM",
+        "PDN_SKIPTRIM",
         bool,
         "Enables `-skip_trim` option during pdngen which skips the metal trim step, which attempts to remove metal stubs.",
         default=False,
+        deprecated_names=["FP_PDN_SKIPTRIM"],
     ),
     Variable(
-        "FP_PDN_CORE_RING",
+        "PDN_CORE_RING",
         bool,
         "Enables adding a core ring around the design. More details on the control variables in the PDK config documentation.",
         default=False,
+        deprecated_names=["FP_PDN_CORE_RING"],
     ),
     Variable(
-        "FP_PDN_ENABLE_RAILS",
+        "PDN_ENABLE_RAILS",
         bool,
         "Enables the creation of rails in the power grid.",
         default=True,
+        deprecated_names=["FP_PDN_ENABLE_RAILS"],
     ),
     Variable(
-        "FP_PDN_HORIZONTAL_HALO",
+        "PDN_HORIZONTAL_HALO",
         Decimal,
         "Sets the horizontal halo around the macros during power grid insertion.",
         default=10,
         units="µm",
+        deprecated_names=["FP_PDN_HORIZONTAL_HALO"],
     ),
     Variable(
-        "FP_PDN_VERTICAL_HALO",
+        "PDN_VERTICAL_HALO",
         Decimal,
         "Sets the vertical halo around the macros during power grid insertion.",
         default=10,
         units="µm",
+        deprecated_names=["FP_PDN_VERTICAL_HALO"],
     ),
     Variable(
-        "FP_PDN_MULTILAYER",
+        "PDN_MULTILAYER",
         bool,
         "Controls the layers used in the power grid. If set to false, only the lower layer will be used, which is useful when hardening a macro for integrating into a larger top-level design.",
         default=True,
-        deprecated_names=["DESIGN_IS_CORE"],
+        deprecated_names=["FP_PDN_MULTILAYER", "DESIGN_IS_CORE"],
     ),
     Variable(
-        "FP_PDN_RAIL_OFFSET",
+        "PDN_RAIL_OFFSET",
         Decimal,
         "The offset for the power distribution network rails for first metal layer.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_RAIL_OFFSET"],
     ),
     Variable(
-        "FP_PDN_VWIDTH",
+        "PDN_VWIDTH",
         Decimal,
         "The strap width for the vertical layer in generated power distribution networks.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_VWIDTH"],
     ),
     Variable(
-        "FP_PDN_HWIDTH",
+        "PDN_HWIDTH",
         Decimal,
         "The strap width for the horizontal layer in generated power distribution networks.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_HWIDTH"],
     ),
     Variable(
-        "FP_PDN_VSPACING",
+        "PDN_VSPACING",
         Decimal,
         "Intra-spacing (within a set) of vertical straps in generated power distribution networks.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_VSPACING"],
     ),
     Variable(
-        "FP_PDN_HSPACING",
+        "PDN_HSPACING",
         Decimal,
         "Intra-spacing (within a set) of horizontal straps in generated power distribution networks.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_HSPACING"],
     ),
     Variable(
-        "FP_PDN_VPITCH",
+        "PDN_VPITCH",
         Decimal,
         "Inter-distance (between sets) of vertical power straps in generated power distribution networks.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_VPITCH"],
     ),
     Variable(
-        "FP_PDN_HPITCH",
+        "PDN_HPITCH",
         Decimal,
         "Inter-distance (between sets) of horizontal power straps in generated power distribution networks.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_HPITCH"],
     ),
     Variable(
-        "FP_PDN_VOFFSET",
+        "PDN_VOFFSET",
         Decimal,
         "Initial offset for sets of vertical power straps.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_VOFFSET"],
     ),
     Variable(
-        "FP_PDN_HOFFSET",
+        "PDN_HOFFSET",
         Decimal,
         "Initial offset for sets of horizontal power straps.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_HOFFSET"],
     ),
     Variable(
-        "FP_PDN_CORE_RING_VWIDTH",
+        "PDN_CORE_RING_VWIDTH",
         Decimal,
         "The width for the vertical layer in the core ring of generated power distribution networks.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_CORE_RING_VWIDTH"],
     ),
     Variable(
-        "FP_PDN_CORE_RING_HWIDTH",
+        "PDN_CORE_RING_HWIDTH",
         Decimal,
         "The width for the horizontal layer in the core ring of generated power distribution networks.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_CORE_RING_HWIDTH"],
     ),
     Variable(
-        "FP_PDN_CORE_RING_VSPACING",
+        "PDN_CORE_RING_VSPACING",
         Decimal,
         "The spacing for the vertical layer in the core ring of generated power distribution networks.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_CORE_RING_VSPACING"],
     ),
     Variable(
-        "FP_PDN_CORE_RING_HSPACING",
+        "PDN_CORE_RING_HSPACING",
         Decimal,
         "The spacing for the horizontal layer in the core ring of generated power distribution networks.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_CORE_RING_HSPACING"],
     ),
     Variable(
-        "FP_PDN_CORE_RING_VOFFSET",
+        "PDN_CORE_RING_VOFFSET",
         Decimal,
         "The offset for the vertical layer in the core ring of generated power distribution networks.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_CORE_RING_VOFFSET"],
     ),
     Variable(
-        "FP_PDN_CORE_RING_HOFFSET",
+        "PDN_CORE_RING_HOFFSET",
         Decimal,
         "The offset for the horizontal layer in the core ring of generated power distribution networks.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_CORE_RING_HOFFSET"],
     ),
     Variable(
-        "FP_PDN_RAIL_LAYER",
+        "PDN_RAIL_LAYER",
         str,
         "Defines the metal layer used for PDN rails.",
-        deprecated_names=["FP_PDN_RAILS_LAYER"],
+        deprecated_names=["FP_PDN_RAIL_LAYER", "FP_PDN_RAILS_LAYER"],
         pdk=True,
     ),
     Variable(
-        "FP_PDN_RAIL_WIDTH",
+        "PDN_RAIL_WIDTH",
         Decimal,
         "Defines the width of PDN rails on the `FP_PDN_RAILS_LAYER` layer.",
         units="µm",
         pdk=True,
+        deprecated_names=["FP_PDN_RAIL_WIDTH"],
     ),
     Variable(
-        "FP_PDN_HORIZONTAL_LAYER",
+        "PDN_HORIZONTAL_LAYER",
         str,
         "Defines the horizontal PDN layer.",
-        deprecated_names=["FP_PDN_UPPER_LAYER"],
+        deprecated_names=["FP_PDN_HORIZONTAL_LAYER", "FP_PDN_UPPER_LAYER"],
         pdk=True,
     ),
     Variable(
-        "FP_PDN_VERTICAL_LAYER",
+        "PDN_VERTICAL_LAYER",
         str,
         "Defines the vertical PDN layer.",
-        deprecated_names=["FP_PDN_LOWER_LAYER"],
+        deprecated_names=["FP_PDN_VERTICAL_LAYER", "FP_PDN_LOWER_LAYER"],
         pdk=True,
     ),
 ]

librelane/steps/odb.py

@@ -618,31 +618,10 @@ class CustomIOPlacement(OdbpyStep):
 
     config_vars = io_layer_variables + [
         Variable(
-            "FP_IO_VLENGTH",
-            Optional[Decimal],
-            """
-            The length of the pins with a north or south orientation. If unspecified by a PDK, the script will use whichever is higher of the following two values:
-                * The pin width
-                * The minimum value satisfying the minimum area constraint given the pin width
-            """,
-            units="µm",
-            pdk=True,
-        ),
-        Variable(
-            "FP_IO_HLENGTH",
-            Optional[Decimal],
-            """
-            The length of the pins with an east or west orientation. If unspecified by a PDK, the script will use whichever is higher of the following two values:
-                * The pin width
-                * The minimum value satisfying the minimum area constraint given the pin width
-            """,
-            units="µm",
-            pdk=True,
-        ),
-        Variable(
-            "FP_PIN_ORDER_CFG",
+            "IO_PIN_ORDER_CFG",
             Optional[Path],
-            "Path to the configuration file. If set to `None`, this step is skipped.",
+            "Path to a custom pin configuration file.",
+            deprecated_names=["FP_PIN_ORDER_CFG"],
         ),
         Variable(
             "ERRORS_ON_UNMATCHED_IO",
@@ -660,28 +639,28 @@ class CustomIOPlacement(OdbpyStep):
 
     def get_command(self) -> List[str]:
         length_args = []
-        if self.config["FP_IO_VLENGTH"] is not None:
-            length_args += ["--ver-length", self.config["FP_IO_VLENGTH"]]
-        if self.config["FP_IO_HLENGTH"] is not None:
-            length_args += ["--hor-length", self.config["FP_IO_HLENGTH"]]
+        if self.config["IO_PIN_V_LENGTH"] is not None:
+            length_args += ["--ver-length", self.config["IO_PIN_V_LENGTH"]]
+        if self.config["IO_PIN_H_LENGTH"] is not None:
+            length_args += ["--hor-length", self.config["IO_PIN_H_LENGTH"]]
 
         return (
             super().get_command()
             + [
                 "--config",
-                self.config["FP_PIN_ORDER_CFG"],
+                self.config["IO_PIN_ORDER_CFG"],
                 "--hor-layer",
                 self.config["FP_IO_HLAYER"],
                 "--ver-layer",
                 self.config["FP_IO_VLAYER"],
                 "--hor-width-mult",
-                str(self.config["FP_IO_VTHICKNESS_MULT"]),
+                str(self.config["IO_PIN_V_THICKNESS_MULT"]),
                 "--ver-width-mult",
-                str(self.config["FP_IO_HTHICKNESS_MULT"]),
+                str(self.config["IO_PIN_H_THICKNESS_MULT"]),
                 "--hor-extension",
-                str(self.config["FP_IO_HEXTEND"]),
+                str(self.config["IO_PIN_H_EXTENSION"]),
                 "--ver-extension",
-                str(self.config["FP_IO_VEXTEND"]),
+                str(self.config["IO_PIN_V_EXTENSION"]),
                 "--unmatched-error",
                 self.config["ERRORS_ON_UNMATCHED_IO"],
             ]
@@ -689,8 +668,8 @@ class CustomIOPlacement(OdbpyStep):
         )
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:
-        if self.config["FP_PIN_ORDER_CFG"] is None:
-            info(f"No custom floorplan file configured, skipping '{self.id}'…")
+        if self.config["IO_PIN_ORDER_CFG"] is None:
+            info(f"No custom I/O placement file configured, skipping '{self.id}'…")
             return {}, {}
         return super().run(state_in, **kwargs)
 

librelane/steps/openroad.py

@@ -1177,8 +1177,8 @@ class IOPlacement(OpenROADStep):
     """
     Places I/O pins on a floor-planned ODB file using OpenROAD's built-in placer.
 
-    If ``FP_PIN_ORDER_CFG`` is not ``None``, this step is skipped (for
-    compatibility with LibreLane 1.)
+    If ``IO_PIN_ORDER_CFG`` is not ``None``, this step is skipped (for
+    compatibility with OpenLane.)
     """
 
     id = "OpenROAD.IOPlacement"
@@ -1189,51 +1189,31 @@ class IOPlacement(OpenROADStep):
         + io_layer_variables
         + [
             Variable(
-                "FP_PPL_MODE",
+                "IO_PIN_PLACEMENT_MODE",
                 Literal["matching", "random_equidistant", "annealing"],
                 "Decides the mode of the random IO placement option.",
                 default="matching",
-                deprecated_names=[("FP_IO_MODE", _migrate_ppl_mode)],
+                deprecated_names=[("FP_IO_MODE", _migrate_ppl_mode), "FP_PPL_MODE"],
             ),
             Variable(
-                "FP_IO_MIN_DISTANCE",
+                "IO_PIN_MIN_DISTANCE",
                 Optional[Decimal],
                 "The minimum distance between two pins. If unspecified by a PDK, OpenROAD will use the length of two routing tracks.",
                 units="µm",
                 pdk=True,
+                deprecated_names=["FP_IO_MIN_DISTANCE"],
             ),
             Variable(
-                "FP_PIN_ORDER_CFG",
+                "IO_PIN_ORDER_CFG",
                 Optional[Path],
                 "Path to a custom pin configuration file.",
+                deprecated_names=["FP_PIN_ORDER_CFG"],
             ),
             Variable(
                 "FP_DEF_TEMPLATE",
                 Optional[Path],
                 "Points to the DEF file to be used as a template.",
             ),
-            Variable(
-                "FP_IO_VLENGTH",
-                Optional[Decimal],
-                """
-                The length of the pins with a north or south orientation. If unspecified by a PDK, OpenROAD will use whichever is higher of the following two values:
-                    * The pin width
-                    * The minimum value satisfying the minimum area constraint given the pin width
-                """,
-                units="µm",
-                pdk=True,
-            ),
-            Variable(
-                "FP_IO_HLENGTH",
-                Optional[Decimal],
-                """
-                The length of the pins with an east or west orientation. If unspecified by a PDK, OpenROAD will use whichever is higher of the following two values:
-                    * The pin width
-                    * The minimum value satisfying the minimum area constraint given the pin width
-                """,
-                units="µm",
-                pdk=True,
-            ),
         ]
     )
 
@@ -1241,8 +1221,8 @@ class IOPlacement(OpenROADStep):
         return os.path.join(get_script_dir(), "openroad", "ioplacer.tcl")
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:
-        if self.config["FP_PIN_ORDER_CFG"] is not None:
-            info(f"FP_PIN_ORDER_CFG is set. Skipping '{self.id}'…")
+        if self.config["IO_PIN_ORDER_CFG"] is not None:
+            info(f"IO_PIN_ORDER_CFG is set. Skipping '{self.id}'…")
             return {}, {}
         if self.config["FP_DEF_TEMPLATE"] is not None:
             info(
@@ -1353,10 +1333,10 @@ class GeneratePDN(OpenROADStep):
         + pdn_variables
         + [
             Variable(
-                "FP_PDN_CFG",
+                "PDN_CFG",
                 Optional[Path],
                 "A custom PDN configuration file. If not provided, the default PDN config will be used.",
-                deprecated_names=["PDN_CFG"],
+                deprecated_names=["FP_PDN_CFG"],
             )
         ]
     )
@@ -1366,11 +1346,11 @@ class GeneratePDN(OpenROADStep):
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:
         kwargs, env = self.extract_env(kwargs)
-        if self.config["FP_PDN_CFG"] is None:
-            env["FP_PDN_CFG"] = os.path.join(
+        if self.config["PDN_CFG"] is None:
+            env["PDN_CFG"] = os.path.join(
                 get_script_dir(), "openroad", "common", "pdn_cfg.tcl"
             )
-            info(f"'FP_PDN_CFG' not explicitly set, setting it to {env['FP_PDN_CFG']}…")
+            info(f"'PDN_CFG' not explicitly set, setting it to {env['PDN_CFG']}…")
         views_updates, metrics_updates = super().run(state_in, env=env, **kwargs)
 
         alerts = self.alerts or []
@@ -1523,16 +1503,17 @@ class GlobalPlacementSkipIO(_GlobalPlacement):
 
     config_vars = _GlobalPlacement.config_vars + [
         Variable(
-            "FP_PPL_MODE",
+            "IO_PIN_PLACEMENT_MODE",
             Literal["matching", "random_equidistant", "annealing"],
             "Decides the mode of the random IO placement option.",
             default="matching",
-            deprecated_names=[("FP_IO_MODE", _migrate_ppl_mode)],
+            deprecated_names=[("FP_IO_MODE", _migrate_ppl_mode), "FP_PPL_MODE"],
         ),
         Variable(
-            "FP_PIN_ORDER_CFG",
+            "IO_PIN_ORDER_CFG",
             Optional[Path],
             "Path to a custom pin configuration file.",
+            deprecated_names=["FP_PIN_ORDER_CFG"],
         ),
         Variable(
             "FP_DEF_TEMPLATE",
@@ -1548,9 +1529,9 @@ class GlobalPlacementSkipIO(_GlobalPlacement):
                 f"I/O pins were loaded from {self.config['FP_DEF_TEMPLATE']}. Returning state unaltered…"
             )
             return {}, {}
-        if self.config["FP_PIN_ORDER_CFG"] is not None:
+        if self.config["IO_PIN_ORDER_CFG"] is not None:
             info(
-                f"I/O pins to be placed from {self.config['FP_PIN_ORDER_CFG']}. Returning state unaltered…"
+                f"I/O pins to be placed from {self.config['IO_PIN_ORDER_CFG']}. Returning state unaltered…"
             )
             return {}, {}
         env["__PL_SKIP_IO"] = "1"

{librelane-3.0.0.dev24.dist-info → librelane-3.0.0.dev25.dist-info}/METADATA

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

{librelane-3.0.0.dev24.dist-info → librelane-3.0.0.dev25.dist-info}/RECORD

@@ -26,7 +26,7 @@ librelane/config/removals.py,sha256=vxqTuRTJ0jt2TX4KmFZCZPTwghDFkCVjIhF2iReHwJA,
 librelane/config/variable.py,sha256=v92bVwy11LgS53gYhU9DBwOUABc2XMGqEglqTORpPfc,26269
 librelane/container.py,sha256=3KHxs3dUSVUZVYsS6fsA7dD3Q4QEQEzRxgXZZh9dzi0,7554
 librelane/env_info.py,sha256=vAE9AZ_vDFLt7Srtg4ZywPzE6vgVhCrIvg8PP25-BJ8,10460
-librelane/examples/spm/config.yaml,sha256=YKBm0lsY3AJZNcxAh1sQ1QMmJeVCpOpil6dw_RgQh4c,633
+librelane/examples/spm/config.yaml,sha256=H2ERY4xoIeXN7kM3N9yGWiFBbtByyaN2Ni1kFqYPtO4,612
 librelane/examples/spm/pin_order.cfg,sha256=-8mTGFKnES0vhQATfaE2TXN_mdCZ3SZIN90Src1l6fY,52
 librelane/examples/spm/src/impl.sdc,sha256=wP18UoVlOJ9q4lmUoa3XpgcpPdyzEqHBNxCgOOU7QH0,2961
 librelane/examples/spm/src/signoff.sdc,sha256=uiW143QNFig2vw3tXdC0LEtd59_pzsuaBDdgtMGB48Q,2694
@@ -35,7 +35,7 @@ librelane/examples/spm/verify/spm_tb.v,sha256=FJfUnnI7u4SDcrnKXK0QWd9KSpM-fjH2ni
 librelane/examples/spm-user_project_wrapper/SPM_example.v,sha256=pSpVqH0LSzWHDcNCqehPik1GRQbw57fXqWZctITnWmY,8430
 librelane/examples/spm-user_project_wrapper/base_sdc_file.sdc,sha256=O6dbdMWNR1AKi3bdHcYRqMs89angq2eWSBxzSR3R_Pg,7247
 librelane/examples/spm-user_project_wrapper/config-tut.json,sha256=g6NBPVNZifToYeT5yU9Em8yv6TsUUD8JMsIvsGGN0bI,254
-librelane/examples/spm-user_project_wrapper/config.json,sha256=Whifv8K2ydE6UGbVfaHyZXbMtfuGX88mhGhsTheXMVU,363
+librelane/examples/spm-user_project_wrapper/config.json,sha256=BBfnaAQ1VFabzurQDGcHGTgLkFudKL2-RdB3pIZrZ5Q,448
 librelane/examples/spm-user_project_wrapper/defines.v,sha256=TUfuwmRFiUCjY6MdWJLGr0LWiuyoPpH1UeBbacDqFDI,2236
 librelane/examples/spm-user_project_wrapper/template.def,sha256=7kl9l-oh4BDKuFHhp2yzk-ObUcrvvUVwPkqsMG0ZTds,438993
 librelane/examples/spm-user_project_wrapper/user_project_wrapper.v,sha256=zc6GC583muuWtzw3p6v_B1k8j-Oo9WypuQf_8doA4uo,3364
@@ -107,8 +107,8 @@ librelane/scripts/openroad/buffer_list.tcl,sha256=sXygy1KRSUS4dZi1UOpBkGGOuXRVLM
 librelane/scripts/openroad/common/dpl.tcl,sha256=T_rzoZy8i7S9C92TOmiN79w0MCfudafEhkXcHmB1BAM,920
 librelane/scripts/openroad/common/dpl_cell_pad.tcl,sha256=KWVuj8u1-y3ZUiQr48TAsFv1GSzOCVnAjdqfBjtoQxQ,1066
 librelane/scripts/openroad/common/grt.tcl,sha256=2qDLSj8lKKEJHH9V9npiSMXQdsIsIHE0DVmbVRStbk4,1132
-librelane/scripts/openroad/common/io.tcl,sha256=1DHtdskRn1yc-jywvUFClHbrPFypKUXdZqOXXJsfouQ,22523
-librelane/scripts/openroad/common/pdn_cfg.tcl,sha256=6Uodl1pO6fckiQnMFbTo3fghrflqXp-MQnQ9ZT5gR64,4555
+librelane/scripts/openroad/common/io.tcl,sha256=fAoRoz6E9iwanFsWvaO50T1xGF6CSuxw38O6MtgrZ1w,22756
+librelane/scripts/openroad/common/pdn_cfg.tcl,sha256=8xTK4_her0hcaxySKpXKlQIIe0goetTcJlSEBl88qL0,4417
 librelane/scripts/openroad/common/resizer.tcl,sha256=OhjpVxw_8IOx5Bmh2_gh_EIHxKaX84NS37Of9Rlchpw,2255
 librelane/scripts/openroad/common/set_global_connections.tcl,sha256=jxafLD-2SLciJYeueobrlJYetnfAfK0P5uMLwhaTQco,2927
 librelane/scripts/openroad/common/set_layer_adjustments.tcl,sha256=xqAIDXsTa1_JsGmKXf6eG2Rni2EZSilSsHfJAhCl1xY,1037
@@ -126,9 +126,9 @@ librelane/scripts/openroad/gpl.tcl,sha256=WzxlyikUf70Q1FgaE6sIVvquYPZ8RU02_te1VB
 librelane/scripts/openroad/grt.tcl,sha256=r_73hbvc4wMi2EFoPbGTh29Lh5ATT4vVwKjxyPIOFcM,1022
 librelane/scripts/openroad/gui.tcl,sha256=BhKTcYEo-SajnYtdzXqpzjYbczy0qZ-OvEFlHMjPtlU,1255
 librelane/scripts/openroad/insert_buffer.tcl,sha256=ST0tbr1LoutjjaouqgngiQZudlzzHMd5APB6DTE2TGw,4412
-librelane/scripts/openroad/ioplacer.tcl,sha256=u7PQ8vaPKHAXeb2HNc5RZmOMc52j2LrccO0irnxDNLM,1861
+librelane/scripts/openroad/ioplacer.tcl,sha256=tV-GF4ExJAKXqw-PQTf1Xlcc87xDJDLi1jksmnS1Smk,1970
 librelane/scripts/openroad/irdrop.tcl,sha256=bXhNY_87xPV-ocF9v8wOWqjlnFPaVO_6K_DWbBHAAPs,1974
-librelane/scripts/openroad/pdn.tcl,sha256=YlZp5T9A4ZEC5_05QXMyQuOfYtJhQ3uR2Gu3-xud9vM,1569
+librelane/scripts/openroad/pdn.tcl,sha256=WiKVmLw3g_ZN1Hs4iiAzc6Qah7ZwCn6o-OA5iNmlTtY,1566
 librelane/scripts/openroad/rcx.tcl,sha256=kyEhli4sGFMEj-He9UXZDGb0Tmxlw7d6iZD7t6adUx8,1057
 librelane/scripts/openroad/repair_design.tcl,sha256=mSQKIT-uac2gJFia_xMNQtHJKD--aTI2T0gmM5mrWZA,2314
 librelane/scripts/openroad/repair_design_postgrt.tcl,sha256=sEXdFfH2le-q0ggcsWGgCR-GCFyzPdxk4P3RZyWCnpI,1902
@@ -151,21 +151,21 @@ librelane/state/state.py,sha256=3CdihPR6lryQMt8ihSef0O2F8-qaqy1w7V0wiwie3nk,1171
 librelane/steps/__init__.py,sha256=j3JYrdnWM74dYuEvE931oSrQI7FUz-hKWr8Mts8C0wg,1668
 librelane/steps/__main__.py,sha256=GviXtDLISKJCufKxK3oFPOSMF1GyShZbG5RXpVCYFkk,13376
 librelane/steps/checker.py,sha256=HD5YFPAbHQKsFmBDrIAbo_0clZcCszNhIXb4lHaNIeQ,21629
-librelane/steps/common_variables.py,sha256=XPNEvrojD-6oIvxgo55mi2lKmARWyYq-PtY1_c_0ZUs,10318
+librelane/steps/common_variables.py,sha256=eih2eA1m0FpL8ydF5WWattwh_SxtzI55eb8gggJtBuY,12494
 librelane/steps/cvc_rv.py,sha256=TNnEQDJI5tEUq8OQelVmBWmNbLzygrvKsZ36utKDvp4,5543
 librelane/steps/klayout.py,sha256=EFtzu53bWm-Bg_xEovdR7fc1GbWTwqkcivtr1rivHWU,16615
 librelane/steps/magic.py,sha256=Xtsy1KWu8dcNq3pRlqM9WRRxtwbCQJq24IyxC0W8D2o,20254
 librelane/steps/misc.py,sha256=8ubCvFeFEspXrgnzNWINY5-TXTyalNtlvcX8TSw0qdg,5685
 librelane/steps/netgen.py,sha256=R9sDWv-9wKMdi2rkuLQdOc4uLlbYhXcKKd6WsZsnLt0,8953
-librelane/steps/odb.py,sha256=9ilEnb8w--T84Eh51cB_sz5fwa-UWa7d7p0Di5rv3BA,39371
-librelane/steps/openroad.py,sha256=YQ_vMfPrTgz843Rhq9MR38sZ5C_-YuFO4Z73QOkTAfA,100144
+librelane/steps/odb.py,sha256=SD5m1ulI2f1LB0_0oKanY9Yql9YpKGolMqtfXun2xTY,38498
+librelane/steps/openroad.py,sha256=quPV082y__la4YgRKfB4wFslcn9E9nEDUSgSIlE3yRo,99340
 librelane/steps/openroad_alerts.py,sha256=IJyB4piBDCKXhkJswHGMYCRDwbdQsR0GZlrGGDhmW6Q,3364
 librelane/steps/pyosys.py,sha256=LY7qqxkhjfoyBBR7vdkm7ylabbxMJDwIoYm7mAUbLVY,23348
 librelane/steps/step.py,sha256=T5z0Nm5z-fq_qj3BIwchnfUobmxX67cEmZ-5dUYT76s,55163
 librelane/steps/tclstep.py,sha256=YwyiSXAjRIflH2vzYvTzYfN4FyAI8Td9B_CKLkBj08o,10084
 librelane/steps/verilator.py,sha256=MWx2TpLqYyea9_jSeLG9c2S5ujvYERQZRFNaMhfHxZE,7916
 librelane/steps/yosys.py,sha256=uC72fb1yFXyIxrtcRu5DxxR3hadG19SlGh668yjhWHc,12694
-librelane-3.0.0.dev24.dist-info/METADATA,sha256=maVhK_OcJ7zHWMQsUUmlwqT4bID895Jv6Sx3FpZnzm8,6561
-librelane-3.0.0.dev24.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-librelane-3.0.0.dev24.dist-info/entry_points.txt,sha256=GTBvXykNMMFsNKiJFgtEw7P1wb_VZIqVM35EFSpyZQE,263
-librelane-3.0.0.dev24.dist-info/RECORD,,
+librelane-3.0.0.dev25.dist-info/METADATA,sha256=jBuGDi3vE2DO6eXdV0UE5_PDXxN5SErWVZePiZEfmmA,6561
+librelane-3.0.0.dev25.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+librelane-3.0.0.dev25.dist-info/entry_points.txt,sha256=GTBvXykNMMFsNKiJFgtEw7P1wb_VZIqVM35EFSpyZQE,263
+librelane-3.0.0.dev25.dist-info/RECORD,,