EE431 Tool Chain

This is a containerized environment for VLSI development in Cal Poly EE431 to install and run the Magic VLSI suite along with the necessary dependencies.

Prepare for Installation

Windows

To start, install Docker Desktop. Once set up, enable WSL integration so that your WSL instances can access docker.

Mac

Step 1: Install Docker

Install Docker.

After installation open Docker from your mac, make an account and ensure the software is running.

Step 2: Install and Setup XQuartz

Ensure XQuartz is Installed and Running:

1. Install XQuartz from https://www.xquartz.org/. Launch XQuartz after installation. Configure XQuartz to Allow Network Connections:
2. Go to XQuartz > Preferences > Security. Uncheck the option Authenticate connections. Check the option Allow connections from network clients.
3. Restart XQuartz for the changes to take effect.

Linux

Install Docker.

Installation

Step 1: Test Docker

Test that docker works by typing docker, making sure it does not warn you that you cannot access docker.

Step 2: Installation

Once you have tested your Docker installation run the following command in your terminal in the location where you want the installation to take place.

git clone https://github.com/HenryAEvans/EE431_Toolchain.git
cd EE431_Toolchain
./install.sh
su $USER -c ./install.sh
logout

Step 3: Log In

You might be logged out after the installation takes place. Simply log back in your computer and the installation will be complete.

Running Tools (Magic, XSchem, Etc.)

Step 1: Enter the Container

To run magic, navigate to the directory where it is installed eg. cd ~/EE431_Toolchain then run the following command to enter the container

./run.sh

Step 2: Create a Project

A project template has been created for you and resides in the home directory, you can make a copy of this and place it in the workspace/ directory with the following command:

cp -R magic_template_project workspace/<project_name>

Caution

Anything you don't place in the workspace/ directory will be deleted when you restart the container

Step 3: Start Magic

Then you can cd into the new project and start magic with:

magic -rcfile sky130A.magicrc

Container Development

Do not worry about this if you are just using the tools, this section is for updating the tools!

• Use ./build.sh to locally build the docker container rather than pulling it from Dockerhub. This takes ~45 minutes.
• Use ./run.sh -l or ./run.sh --local to run your locally built version, rather than the most recent published version.
• Use ./publish.sh to push that most recent build to dockerhub. Requires your docker account have access to EE431 Dockerhub.