Skip to content

Commit

Permalink
Merge pull request #245 from microSharjeel/asic
Browse files Browse the repository at this point in the history 
Added target for openlane flow
  • Loading branch information
@jjts
jjts authored Nov 17, 2021
2 parents 1772de9 + ffd1949 commit 288ea67
Show file tree
Hide file tree
Showing 2 changed files with 118 additions and 93 deletions.
180 changes: 93 additions & 87 deletions hardware/asic/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Clone OpenLane repository with Skywater PDK 130 as follows

```bash
SSH
git clone [email protected]:efabless/OpenLane.git
$ git clone [email protected]:efabless/OpenLane.git
HTTP
https://github.com/efabless/OpenLane.git
$ git clone https://github.com/efabless/OpenLane.git
```
The default Standard Cell Library (SCL) to be installed is sky130_fd_sc_hd.
To change that, you can add this configuration variable:
Expand All @@ -28,47 +28,53 @@ where library name is one of the following:
3. sky130_fd_sc_ms
4. sky130_fd_sc_ls
5. sky130_fd_sc_hdll


In order to run OpenLane from Makefile provided in the hardware/asic/skywater folder, you need to export following environment variable.
```bash
export OPENLANE_HOME=<path to OpenLane root directory>
```
Export the absolute path where the skywater-pdk and open-pdk will reside.
``` bash
export PDK_ROOT=<absolute path to where skywater-pdk and open_pdks will reside>
```
For installation of Skywater PDK and OpenLane type make inside the cloned OpenLane repo:
```bash
cd OpenLane/
make
$ cd OpenLane/
$ make
```
This will clone the specific version of Skywater PDK, pull and build its Docker container. If everything is properly installed by the makefile, it will report success. In order to test the OpenLane flow and PDK installation just run

```bash
make test
$ make test
```
This will run a 5 mins test that will verify the OpenLane and Skywater PDK installation and will report success if everything has been successfully installed.

## OPENLANE FLOW FOR MACRO HARDENING FROM AN HDL DESIGN

1. Go to the OpenLane installation directory (you may set an environment variable called OPENLANE_HOME that points to this directory) and start the OpenLane Docker container by running

```bash
make mount
```
**NOTE**: If mounting of docker require sudo access then follow these steps,
1. First create the docker group, if it is not already there.
```bash
sudo groupadd docker
$ sudo groupadd docker
```
2. Add the user to docker group
```bash
sudo usermod -aG docker $USER
$ sudo usermod -aG docker $USER
```
3. Run following
```bash
newgrp docker
$ newgrp docker
```
Now you should be able to mount docker without sudo access
Now you should be able to mount docker without sudo access.

## OPENLANE FLOW FOR MACRO HARDENING FROM AN HDL DESIGN

This command opens up a bash terminal in which you run the following tcl script to generate a design configuration of your design:
1. Go to the OpenLane installation directory (you may set an environment variable called OPENLANE_HOME that points to this directory) and start the OpenLane Docker container by running

```bash
$ make mount
```
This command will mount the docker container along with bash terminal in which you run the following tcl script to generate a default configuration file for OpenLane flow:
```bash
flow.tcl -design design_name -init_design_config
$ flow.tcl -design design_name -init_design_config
```
4. This tcl script will generate a default tcl configuration file of your design called "config.tcl", which has the following environment variables:
2. The default configuration file "config.tcl" has following environment variables:

* DESIGN_NAME: the name of your design must match the name of your top-level Verilog module. This variable cannot be modified.

Expand All @@ -79,10 +85,20 @@ flow.tcl -design design_name -init_design_config
* CLOCK_PORT: name of the clock signal port. Make sure that this name matches the name of the clock signal in your top level module.

* STD_CELL_LIBRARY: Standard Cell Library.
## Configuration of OpenLane

Configuration parameters of the OpenLane can be changed by adding / changing the environment variables in config.tcl file in the designs/"name of design" folder. Some important parameters that can be used to define the design constraints include the following,

1. Clock definition parameter. Clock Period definition parameter.
2. Synthesis strategy parameter. This parameter can be used to define the synthesis strategy. This defines if the design is optimized for area or for delay.
3. Set input delay as percent of clock period.
4. Parameter to report maximum and minimum delay paths, critical delay path and specific path for delay.
5. Parameter to set different wire load models.

5. After making necessary changes to config.tcl file, run the following tcl command:
**NOTE:** Complete list of configuration parameters that can be used to define the design constraints can be found in OpenLane repository. OpenLane/configuration/Readme.md.
3. After making necessary changes to config.tcl file, run the following command.
```bash
flow.tcl -design design1 -tag first_run
$ flow.tcl -design design1 -tag first_run
```
where the -tag option is the tag for the design run. This command will go through all the following steps to generate GDSII file from Verilog input files.

Expand Down Expand Up @@ -144,88 +160,78 @@ OpenLane can be run in interactive mode. This can be done by following these ste

1. Intialize design configuration. Enter following the command line.
```bash
flow.tcl -design design1 -init_design_config
$ flow.tcl -design design1 -init_design_config
```
2. Start interactive flow of OpenLane. Enter following in command line.
```bash
flow.tcl -interactive
$ flow.tcl -interactive
```
3. Prepare the design. Enter following in command line.
```bash
prep -design design1
$ prep -design design1
```
where the design1 is your design. This command will prepare the design for OpenLane flow by creating one .lef file and one .tech file by merging all the tech and lef files from the library.
4. Run yosys. Enter following in command line.
```bash
run_yosys
$ run_yosys
```
This will create a gate level netlist of the design and will perform technology independent optimizations to the design.

5. Run STA. Enter the following in command line.
```bash
run_sta
$ run_sta
```
This will report the Total Negative Slack and Worst Negative Slack of the design.

6. Run Floorplan. Enter the following in command line.
```bash
run_floorplan
$ run_floorplan
```
7. Run Placement step. Enter the following in command line.
```bash
run_placement_step
$ run_placement_step
```
8. Run CTS step. Enter the following in command line.
```bash
run_cts_step
$ run_cts_step
```
9. Run Routing step. Enter the following in command line.
```bash
run_routing_step
$ run_routing_step
```
10. Run Fake Diode Insertion step. Enter the following in command line.
```bash
run_diode_insertion_2_5_step
$ run_diode_insertion_2_5_step
```
11. Run Power Pin Insertion step. Enter the following in command line.
```bash
run_power_pins_insertion_step
$ run_power_pins_insertion_step
```
12. Run Magic. Enter the following in command line.
```bash
run_magic
$ run_magic
```
13. Run Klayout. Enter the following in command line.
```bash
run_klayout
$ run_klayout
```
14. Run Klayout GDS XOR. Enter the following in command line.
```bash
run_klayout_gds_xor
$ run_klayout_gds_xor
```
15. Run CVC. Enter the following in command line.
```bash
run_lef_cvc
$ run_lef_cvc
```
## Configuration of OpenLane

Configuration parameters of the OpenLane can be changed by adding / changing the environment variables in config.tcl file in the designs/"name of design" folder. Some important parameters that can be used to define the design constraints include the following,

1. Clock definition parameter. Clock Period definition parameter.
2. Synthesis strategy parameter. This parameter can be used to define the synthesis strategy. This defines if the design is optimized for area or for delay.
3. Set input delay as percent of clock period.
4. Parameter to report maximum and minimum delay paths, critical delay path and specific path for delay.
5. parameter to set different wire load models.

Complete list of configuration parameters that can be used to define the design constraints can be found in OpenLane repository. OpenLane/configuration/Readme.md.

-------------------------------
# OpenRAM Instructions

## INSTALLATION OF OPENRAM

Getting Openram: Requirements for Openram are the following,
1. Python 3.8.10
1. Python 3.8.10
2. Python numpy (pip3 install numpy)
3. Python scipy (pip3 install scipy)
4. Python sklearn (pip3 install sklearn)
Expand All @@ -237,7 +243,7 @@ Clone OpenRAM and set environment variables as followa:

1. clone the git repository for openram
```bash
git clone https://github.com/VLSIDA/OpenRAM
$ git clone https://github.com/VLSIDA/OpenRAM
```
2. set following environment variables in bashrc
```bash
Expand All @@ -254,7 +260,7 @@ export PYTHONPATH="$PYTHONPATH:$OPENRAM_HOME"
Getting skywater-pdk:

```bash
git clone https://github.com/google/skywater-pdk
$ git clone https://github.com/google/skywater-pdk
```

## Getting OpenPDK
Expand All @@ -265,9 +271,9 @@ we will need OpenPDK to install & generate the required tech files for magic vls
Get open pdk repository and checkout to new branch as follows:

```bash
git clone git://opencircuitdesign.com/open_pdks
cd open_pdks
git checkout open_pdks-1.0
$ git clone git://opencircuitdesign.com/open_pdks
$ cd open_pdks
$ git checkout open_pdks-1.0
```
## Getting Magic_VLSI

Expand All @@ -281,44 +287,44 @@ Download and installation of Magic_vlsi.

**Download**
```bash
git clone git://opencircuitdesign.com/magic
cd magic
git checkout magic-8.3
$ git clone git://opencircuitdesign.com/magic
$ cd magic
$ git checkout magic-8.3
```
**Compile & Install**
```bash
sudo ./configure
sudo make
sudo make install
$ sudo ./configure
$ sudo make
$ sudo make install
```
and then exit to home directory

## Skywater PDK Installation

```bash
# cd into skywater repo
cd skywater-pdk
$ cd skywater-pdk
```
```bash
# initialise pdk
git submodule init libraries/sky130_fd_pr/latest
git submodule init libraries/sky130_fd_sc_hd/latest
git submodule init libraries/sky130_fd_sc_hdll/latest
git submodule init libraries/sky130_fd_sc_hs/latest
git submodule init libraries/sky130_fd_sc_ms/latest
git submodule init libraries/sky130_fd_sc_ls/latest
git submodule init libraries/sky130_fd_sc_lp/latest
git submodule init libraries/sky130_fd_sc_hvl/latest
git submodule update
sudo make timing
# exit skywater-pdk directory
$ git submodule init libraries/sky130_fd_pr/latest
$ git submodule init libraries/sky130_fd_sc_hd/latest
$ git submodule init libraries/sky130_fd_sc_hdll/latest
$ git submodule init libraries/sky130_fd_sc_hs/latest
$ git submodule init libraries/sky130_fd_sc_ms/latest
$ git submodule init libraries/sky130_fd_sc_ls/latest
$ git submodule init libraries/sky130_fd_sc_lp/latest
$ git submodule init libraries/sky130_fd_sc_hvl/latest
$ git submodule update
$ sudo make timing
# exit skywater-pdk directory
```
## Configuring Open PDK with Google Skywater

cd into open-pdk repository and enter following
```bash
./configure
$ ./configure
--enable-sky130-pdk=<skywater_root_dir>/skywater-pdk/libraries --with-sky130-local-path=<your_target_install_dir>
```

Expand All @@ -327,29 +333,29 @@ cd into open-pdk repository and enter following
## Install Skywater
From open-pdk repository
```bash
cd sky130 # you should be in open_pdks root dir
make
sudo make install
$ cd sky130 # you should be in open_pdks root dir
$ make
$ sudo make install
```
## Integrate Skywater into Magic

As the skywater tech files are not installed in magic’s library, we need to create a symbolic link in order to use the tech files for drawing layout.

So enter following for the symbolic links:
```bash
sudo ln -s <sky130A_install_root_dir>/sky130A/libs.tech/magic/* /usr/local/lib/magic/sys/
$ sudo ln -s <sky130A_install_root_dir>/sky130A/libs.tech/magic/* /usr/local/lib/magic/sys/
```
In my case it was as follows:
```bash
sudo ln -s /home/c/open_pdks/sky130/sky130A/libs.tech/magic/* /usr/local/lib/magic/sys/
$ sudo ln -s /home/c/open_pdks/sky130/sky130A/libs.tech/magic/* /usr/local/lib/magic/sys/
```

## Running Magic with Skywater

Enter following in the terminal to check if the magic runs with skywater
```bash
tcsh
sudo magic -T sky130A
$ tcsh
$ sudo magic -T sky130A
```

## Porting SKY130 to OpenRAM
Expand All @@ -358,7 +364,7 @@ Last step is to port skywater 130 process node technology to Openram. The OpenRA

Getting the Sky130 technology for Openram
```bash
git clone https://github.com/vsdip/vsdsram_sky130
$ git clone https://github.com/vsdip/vsdsram_sky130
```

Copy the folder from (vsdsram_sky130/OpenRAM/sky130A) and paste it in the technology folder of openram repository (openram/technology).
Expand All @@ -367,14 +373,14 @@ Copy the folder from (vsdsram_sky130/OpenRAM/sky130A) and paste it in the techno
Getting the git repo for netgen (tool used for LVS layout vs schemetic comparison)

```bash
git clone git://opencircuitdesign.com/netgen
$ git clone git://opencircuitdesign.com/netgen
```
For installation of this tool
```bash
cd netgen # repo of netgen
./configure
make
make install
$ cd netgen # repo of netgen
$ ./configure
$ make
$ make install
```
Finally, make a configuration python script ("myconfig.py" any name can be used). I used the following one

Expand Down
Loading

0 comments on commit 288ea67

Please sign in to comment.