Makefile updates - added target for running help - added target for building the pdk with OL docker to avoid having magic installed
diff --git a/docs/source/index.rst b/docs/source/index.rst index 6a1f564..6e024e7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst
@@ -50,6 +50,11 @@ repo also demonstrates the recommended structure for the open-mpw shuttle projects. +Prerequisites +============= + +- Docker + Install Caravel =============== @@ -147,18 +152,14 @@ </p> -Running Full Chip Simulation -============================ +Building the PDK +================ -First, you will need to install the simulation environment, by +You have two options for building the pdk: -.. code:: bash +- Build the pdk natively. - make simenv - -This will pull a docker image with the needed tools installed. - -Then, you will need to build the pdk to obtain the verilog views. +Make sure you have `Magic VLSI Layout Tool <http://opencircuitdesign.com/magic/index.html>`__ installed on your machine before building the pdk. .. code:: bash @@ -171,6 +172,30 @@ make pdk +- Build the pdk using openlane's docker image which has magic installed. + +.. code:: bash + + # set PDK_ROOT to the path you wish to use for the pdk + export PDK_ROOT=<pdk-installation-path> + + # you can optionally specify skywater-pdk and open-pdks commit used + # by setting and exporting SKYWATER_COMMIT and OPEN_PDKS_COMMIT + # if you do not set them, they default to the last verfied commits tested for this project + + make pdk-nonnative + +Running Full Chip Simulation +============================ + +First, you will need to install the simulation environment, by + +.. code:: bash + + make simenv + +This will pull a docker image with the needed tools installed. + Then, run the RTL and GL simulation by .. code:: bash @@ -190,20 +215,7 @@ Hardening the User Project Macro using Openlane =============================================== -First, you will need to install the pdk by - -.. code:: bash - - # set PDK_ROOT to the path you wish to use for the pdk - export PDK_ROOT=<pdk-installation-path> - - # you can optionally specify skywater-pdk and open-pdks commit used - # by setting and exporting SKYWATER_COMMIT and OPEN_PDKS_COMMIT - # if you do not set them, they default to the last verfied commits tested for this project - - make pdk - -Then, you will need to install openlane by +You will need to install openlane by running the following .. code:: bash @@ -248,7 +260,6 @@ make user_project_wrapper - Running Open-MPW Precheck Locally ================================= @@ -264,9 +275,12 @@ Then, you can run the precheck by running +Specify CARAVEL_ROOT before running any of the following, .. code:: bash + # export CARAVEL_ROOT=$(pwd)/caravel + export CARAVEL_ROOT=<path-to-caravel> make run-precheck This will run all the precheck checks on your project and will produce the logs under the ``checks`` directory. @@ -282,7 +296,8 @@ Specify CARAVEL_ROOT before running any of the following, .. code:: bash - + + # export CARAVEL_ROOT=$(pwd)/caravel export CARAVEL_ROOT=<path-to-caravel> Run lvs on spice,