This guide will walk you through the process of preparing your Wokwi design for submission using the Tiny Tapeout GitHub template. We’ll cover the necessary steps to convert your design into the ASIC files required for chip manufacturing and also view your files with the 3d viewer.
GitHub templates are a collection of files with a predefined structure. Ours contains all the files and settings necessary to convert your design to the GDS we need for manufacture.
Go to the Wokwi Template
Click the ‘Use this template’ button to generate your own copy of the repository.
GitHub Actions allow automated tasks to run. They are enabled by default, but we need to enable them to publish the results.
info.yaml
FileThe info.yaml
is used to tell us the important details of your project, which Wokwi project it is, who its by, what it does, how to test.
info.yaml
file of yur repository to match the ID from your Wokwi project.Clicking the commit button will save your changes.
We put all the project information into a datasheet. You can use Markdown to write your documentation, telling everyone what your chip does and how to test it.
info.md
File in the docs directory.Leaving the info.md unmodified will cause the ‘docs’ action to fail.
GitHub actions are a service provided free of charge for open source projects. They usually start a virtual machine, install and then run some software. Each commit will trigger these actions to run. We use a few different actions to do different tasks:
To see the currently running and historical actions, go to the ‘Actions’ tab in your repository.
Red indicates failure and green indicates success. Only the ‘docs’ and ‘gds’ actions need to be green.
This action generates a preview of how your documentation will look. You can download a PDF preview to check it.
If you have a failure, you can check the log to see what the problem is. The most common error is missing fields in info.yaml
or leaving info.md
unchanged.
This action generates the GDS for your project, along with warnings, utilization statistics, and cell usage details.
Take a look at the standard cell usage summary. These cells are part of the PDK from Skywater Technologies. The details for each of the standard cells can be viewed by clicking the links.
The cell usage table includes additional cells such as fill cells and tap cells that are not part of your original design. Certain cells like fill cells and tap cells are automatically inserted during the physical design stage to ensure the integrity of the layout and meet the manufacturing requirements.
The precheck summary shows the results of all the tests we run on the design. All the checks need to be green to submit to the chip.
This section gives you the 3D viewer link and the 2D render of your design. Open the 3D viewer by clicking the link.
Once you have the GDS and Docs jobs completing successfully, you are ready to submit to the Tiny Tapeout shuttle. That’s covered in the next section.
For now, try the following ideas:
On each commit the GitHub actions runs automatically. However if you change your Wokwi design, you might want to force the action to run again without making a commit. To do this you can use the ‘Run workflow’ button.