File size: 1,646 Bytes
d59bb1b |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
# User Guide
The OpenROAD Project uses three tools to perform automated RTL-to-GDS layout generation:
1. [yosys](https://github.com/The-OpenROAD-Project/yosys): Logic
Synthesis
2. [OpenROAD](https://github.com/The-OpenROAD-Project/OpenROAD):
Floorplanning through Detailed Routing
3. [KLayout](https://www.klayout.de/): GDS merge, DRC and LVS (public
PDKs)
To automate RTL-to-GDS we provide
[OpenROAD Flow](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts),
which contains scripts that integrate the three tools.
## Code Organization
The [OpenROAD Flow](https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts)
repository serves as an example RTL-to-GDS flow using the OpenROAD
tools. The script `build_openroad.sh` in the repository will
automatically build the OpenROAD toolchain.
The two main directories are:
1. `tools/`: contains the source code for the entire yosys and
[OpenROAD App](https://github.com/The-OpenROAD-Project/OpenROAD)
(both via submodules) as well as other tools required for the flow.
3. `flow/`: contains reference recipes and scripts to run designs
through the flow. It also contains public platforms and test
designs.
## Setup
See [Getting Started](../index.md#getting-started-with-openroad-flow-scripts) guide.
## Using the OpenROAD Flow
See the documentation [here](../tutorials/FlowTutorial.md) for details about the
flow and how to run designs through the flow.
## Using the OpenROAD App
See the documentation [here](https://github.com/The-OpenROAD-Project/OpenROAD/blob/master/README.md) for details about the app and
the available features and commands.
|