OpenROAD¶
OpenROAD is run using Tcl scripts. The following commands are used to read and write design data.
read_lef [-tech] [-library] filename
read_def filename
write_def [-version 5.8|5.6|5.5|5.4|5.3] filename
read_verilog filename
write_verilog filename
read_db filename
write_db filename
write_abstract_lef filename
Use the Tcl source command to read commands from a file.
source [-echo] file
If an error is encountered in a command while reading the command file,
then the error is printed and no more commands are read from the file. If
file_continue_on_error is 1 then OpenROAD will continue reading commands
after the error.
If exit_on_error is 1 then OpenROAD will exit when it encounters an error.
OpenROAD can be used to make a OpenDB database from LEF/DEF, or Verilog
(flat or hierarchical). Once the database is made it can be saved as a file
with the write_db command. OpenROAD can then read the database with the
read_db command without reading LEF/DEF or Verilog.
The read_lef and read_def commands can be used to build an OpenDB database
as shown below. The read_lef -tech flag reads the technology portion of a
LEF file. The read_lef -library flag reads the MACROs in the LEF file.
If neither of the -tech and -library flags are specified they default
to -tech -library if no technology has been read and -library if a
technology exists in the database.
read_lef liberty1.lef
read_def reg1.def
# Write the db for future runs.
write_db reg1.db
The read_verilog command is used to build an OpenDB database as shown
below. Multiple Verilog files for a hierarchical design can be read.
The link_design command is used to flatten the design and make a database.
read_lef liberty1.lef
read_verilog reg1.v
link_design top
# Write the db for future runs.
write_db reg1.db
Example scripts¶
Example scripts demonstrating how to run OpenROAD on sample designs can be found in /test. Flow tests taking sample designs from synthesizable RTL Verilog to detail-routed final layout in the open-source technologies Nangate45 and Sky130HD are shown below.
gcd_nangate45.tcl
aes_nangate45.tcl
tinyRocket_nangate45.tcl
gcd_sky130hd.tcl
aes_sky130hd.tcl
ibex_sky130hd.tcl
Each of these designs use the common script flow.tcl.
Abstract LEF Support¶
OpenROAD contains an abstract LEF writer that can take your current design and emit an abstract LEF representing the external pins of your design and metal obstructions.
read reg1.db
write_abstract_lef reg1_abstract.lef
Limitations of the Abstract LEF Writer¶
Currently the writer will place an obstruction over the entire block area on any metal layer if there is any object on that metal layer.
TCL functions¶
Get the die and core areas as a list in microns: llx lly urx ury
ord::get_die_area
ord::get_core_area
FAQs¶
Check out GitHub discussion about this tool.
License¶
BSD 3-Clause License.