quick start guide

This section describes how to simulate and .gds generarion with the Riscduino repository

Prerequisites

Docker

If you have followed the Getting Started Guide you should have all of these installed. To proceed make sure, that your environment variables are set correctly:

git clone https://github.com/efabless/caravel-lite.git
cd caravel-lite
make install_mcw

export OPENLANE_IMAGE_NAME=riscduino/openlane:<Check the mpw version on project mpw4/mpw5/latest>
export OPENLANE_TAG=<Check the mpw version on project mpw4/mpw5/latest>
export CARAVEL_ROOT=<Set the caravel lite root>
export MCW_ROOT=$CARAVEL_ROOT/mgmt_core_wrapper

Building individual design

To build your design go into openlane and run make with your design name as a target:

cd openlane
make <design>

This will run your design throught the OpenLANE workflow and if successfull produce a .gds file of your project. The subdirectory runs/<design> will be created in your designs folder, which contains the results of the run. The following result files in runs/<design>/ are important:

<design>/runs/<design>/reports/final_summary_report.csv: Contains the results of the run including violations
<design>/runs/<design>/results/magic/<design>.lef
<design>/runs/<design>/results/magic/<design>.gds

The .gds and .lef files can also be found in the gds and lef directories on the top level of the repository.