Skip to content

Commit bf6e80a

Browse files
committed
Update variables.yaml to match FlowVariables.md changes
- Add FOOTPRINT variable for ICeWall-based floorplan initialization - Add FOOTPRINT_TCL variable for custom footprint commands - Update FLOORPLAN_DEF description to note mutual exclusivity Signed-off-by: kcaisley <[email protected]>
1 parent 4e92f80 commit bf6e80a

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed

docs/user/FlowVariables.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,6 @@ configuration file.
138138
| <a name="FLOW_VARIANT"></a>FLOW_VARIANT| Flow variant to use, used in the flow variant directory name.| base|
139139
| <a name="FOOTPRINT"></a>FOOTPRINT| Custom footprint definition file for ICeWall-based floorplan initialization. Mutually exclusive with FLOORPLAN_DEF or DIE_AREA/CORE_AREA or CORE_UTILIZATION.| |
140140
| <a name="FOOTPRINT_TCL"></a>FOOTPRINT_TCL| Specifies a Tcl script with custom footprint-related commands for floorplan setup.| |
141-
| <a name="FLOW_VARIANT"></a>FLOW_VARIANT| Flow variant to use, used in the flow variant directory name.| base|
142141
| <a name="GDS_ALLOW_EMPTY"></a>GDS_ALLOW_EMPTY| Regular expression of module names of macros that have no .gds file| |
143142
| <a name="GDS_FILES"></a>GDS_FILES| Path to platform GDS files.| |
144143
| <a name="GENERATE_ARTIFACTS_ON_FAILURE"></a>GENERATE_ARTIFACTS_ON_FAILURE| For instance Bazel needs artifacts (.odb and .rpt files) on a failure to allow the user to save hours on re-running the failed step locally, but when working with a Makefile flow, it is more natural to fail the step and leave the user to manually inspect the logs and artifacts directly via the file system. Set to 1 to change the behavior to generate artifacts upon failure to e.g. do a global route. The exit code will still be non-zero on all other failures that aren't covered by the "useful to inspect the artifacts on failure" use-case. Example: just like detailed routing, a global route that fails with congestion, is not a build failure(as in exit code non-zero), it is a successful(as in zero exit code) global route that produce reports detailing the problem. Detailed route will not proceed, if there is global routing congestion This allows build systems, such as bazel, to create artifacts for global and detailed route, even if the operation had problems, without having know about the semantics between global and detailed route. Considering that global and detailed route can run for a long time and use a lot of memory, this allows inspecting results on a laptop for a build that ran on a server.| 0|

flow/scripts/floorplan.tcl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ if { $methods_defined > 1 } {
6161
# Method 1: Use existing DEF file with floorplan data
6262
if { $use_floorplan_def } {
6363
log_cmd read_def -floorplan_initialize $env(FLOORPLAN_DEF)
64-
# Method 2: Use ICeWall footprint file (platform-specific extension)
64+
# Method 2: Use ICeWall footprint file (platform-specific extension)
6565
} elseif { $use_footprint } {
6666
ICeWall load_footprint $env(FOOTPRINT)
6767

@@ -71,13 +71,13 @@ if { $use_floorplan_def } {
7171
-site $::env(PLACE_SITE)
7272

7373
ICeWall init_footprint $env(SIG_MAP_FILE)
74-
# Method 3: Use explicit die and core area coordinates
74+
# Method 3: Use explicit die and core area coordinates
7575
} elseif { $use_die_and_core_area } {
7676
initialize_floorplan -die_area $::env(DIE_AREA) \
7777
-core_area $::env(CORE_AREA) \
7878
-site $::env(PLACE_SITE) \
7979
{*}$additional_args
80-
# Method 4: Calculate core area from utilization, aspect ratio, and margins
80+
# Method 4: Calculate core area from utilization, aspect ratio, and margins
8181
} elseif { $use_core_utilization } {
8282
initialize_floorplan -utilization $::env(CORE_UTILIZATION) \
8383
-aspect_ratio $::env(CORE_ASPECT_RATIO) \

flow/scripts/variables.yaml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ SWAP_ARITH_OPERATORS:
305305
- All stages
306306
FLOORPLAN_DEF:
307307
description: |
308-
Use the DEF file to initialize floorplan.
308+
Use the DEF file to initialize floorplan. Mutually exclusive with FOOTPRINT or DIE_AREA/CORE_AREA or CORE_UTILIZATION.
309309
stages:
310310
- floorplan
311311
- place
@@ -1019,6 +1019,16 @@ YOSYS_FLAGS:
10191019
stages:
10201020
- synth
10211021
default: -v 3
1022+
FOOTPRINT:
1023+
description: |
1024+
Custom footprint definition file for ICeWall-based floorplan initialization. Mutually exclusive with FLOORPLAN_DEF or DIE_AREA/CORE_AREA or CORE_UTILIZATION.
1025+
stages:
1026+
- floorplan
1027+
FOOTPRINT_TCL:
1028+
description: |
1029+
Specifies a Tcl script with custom footprint-related commands for floorplan setup.
1030+
stages:
1031+
- floorplan
10221032
FLOW_VARIANT:
10231033
description: >
10241034
Flow variant to use, used in the flow variant directory name.

0 commit comments

Comments
 (0)