Files
OpenLane/docs/source/reference/interactive_mode.md
Mohamed Gaber 157a650587 Update Documentation (#1917)
+ Added `make docs` target to primary Makefile to generate documentation
~ Update documentation dependencies
~ Updated `tcl.py` to handle JSON lists of elements including whitespace by joining them with a comma (unless one of the elements already contains a comma), resolving odd JSON syntax
~ Re-organized and re-order configuration variables and edited descriptions for general consistency as well as adding anchors
~ Update all documentation dependencies
~ Fixed a number of broken links
- Remove dependency on `docutils` and `sphinx-autobuild` (both unused)
- Remove two of the custom documentation extensions
2023-07-25 13:02:39 +03:00

1.1 KiB

Interactive Mode

You may run the flow interactively by using the -interactive option:

./flow.tcl -interactive

A tcl shell will be opened where the openlane package is automatically sourced:

package require openlane

Then, you should be able to run the following main commands:

  1. Any valid Tcl code.
  2. prep -design <design> [-tag TAG] [-config CONFIG] [-init_design_config] [-overwrite]
  3. run_synthesis
  4. run_floorplan
  5. run_placement
  6. run_cts
  7. run_routing
  8. write_powered_verilog followed by set_netlist $::env(routing_logs)/$::env(DESIGN_NAME).powered.v
  9. run_magic
  10. run_magic_spice_export
  11. run_magic_drc
  12. run_lvs
  13. run_antenna_check
The commands should all be run in this order- skipping any may lead to
unexpected behavior.

You are free however to add any intermediate commands to achieve more complex
functionality.

The above commands can also be written in a file and passed to flow.tcl as shown:

./flow.tcl -interactive -file <file>

A comprehensive list of commands supported by OpenLane can be found here.