mirror of
https://github.com/The-OpenROAD-Project/OpenLane.git
synced 2026-05-29 00:23:55 +08:00
~ Documentation all moved under `docs/source`, arranged hierarchically according to the table of contents ~ `Klayout` changed to `KLayout` in all logging messages ~ Readme rewritten to just be concise, parts of it isolated into standalone documentation ~ RTD builds no longer use conda (saves some time) ~ Fixed all broken links
3.9 KiB
3.9 KiB
Command-Line Arguments
The following are the command-line arguments that can be passed to flow.tcl:
| Argument | Description |
|---|---|
-design <folder path> (Optional) |
Specifies the design folder. A design folder should contain a config.json or config.tcl file defining the design parameters. If the folder is not found, ./designs directory is searched, and if this parameter is omitted, the current working directory is treated as the design. |
-from <stage> (Optional) |
Specifies stage to start flow execution from |
-to <stage> (Optional) |
Specifies stage to stop flow execution at (included) |
-config_file <file> (Optional) |
Specifies the design's configuration file for running the flow. For example, to run the flow using ./designs/spm/config2.tcl Use run ./flow.tcl -design ./designs/spm -config_file ./designs/spm/config2.tcl By default config.tcl is used, and if not found, config.json is used instead. |
-override_env Optional |
Allows you to override certain configuration environment variables for this run. Format: KEY1=VALUE1,KEY2=VALUE2 |
-tag <name> (Optional) |
Specifies a "name" for a specific run. If the tag is not specified, a timestamp is generated for identification of that run. |
-run_path <path> (Optional) |
Specifies a path to save the run in. By default the run is in design_path/, where the design path is the one passed to -design |
-src <verilog_source_file> (Optional) |
Sets the verilog source code file(s) in case of using -init\_design\_config. The default is that the source code files are under design_path/src/, where the design path is the one passed to -design |
-init_design_config (Optional) |
Creates a configuration file for a design. The config file is by default openlane/config.json, but can be overriden using the value from -config_file. |
-add_to_designs (Optional) |
Adds the design to the OpenLane folder instead of creating an openlane folder. This is the default behavior on earlier versions of OpenLane. |
-overwrite (Optional) |
Flag to overwrite an existing run with the same tag |
-interactive (Optional) |
Flag to run openlane flow in interactive mode |
-file <file_path> (Optional) |
Passes a script of interactive commands in interactive mode |
-synth_explore (Boolean) |
If enabled, synthesis exploration will be run (only synthesis exploration), which will try out the available synthesis strategies against the input design. The output will be the four possible gate level netlists under <run_path/results/synthesis> and a summary report under reports that compares the 4 outputs. |
-lvs (Boolean) |
If enabled, only LVS will be run on the design. in which case the user must also pass: -design DESIGN_DIR -gds DESIGN_GDS -net DESIGN_NETLIST. |
-drc (Boolean) |
If enabled, only DRC will be run on the design. in which case the user must also pass: -design DESIGN_DIR -gds DESIGN_GDS -report OUTPUT_REPORT_PATH -magicrc MAGICRC. |
-save (Optional) |
A flag to save a runs results like .mag and .lef in the design's folder. |
-save_path <path> (Optional) |
Specifies a different path to save the design's result. This option is to be used with the -save flag. |
-verbose <level> (Optional) |
Specifies a level of verbosity. 0, the default, only outputs high-level messages. 1 also outputs some of the inner workings of the flow scripts. 2 or higher forwards outputs from all tools to your terminal. |
-test_mismatches <class> (Optional) |
Test for mismatches between the OpenLane tool versions and the current environment. all, the default, tests all mismatches. tools tests all except the PDK. pdk only tests the PDK. none disables the check.(Default: all) |
-ignore_mismatches |
If specified, halts the flow on detected environment mismatches. |