diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 0000000..64cb271 --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,17 @@ +name: docs + +on: + push: + workflow_dispatch: + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v3 + with: + submodules: recursive + + - name: Build docs + uses: TinyTapeout/tt-gds-action/docs@tt05 diff --git a/.github/workflows/gds.yaml b/.github/workflows/gds.yaml new file mode 100644 index 0000000..28335c2 --- /dev/null +++ b/.github/workflows/gds.yaml @@ -0,0 +1,26 @@ +name: gds + +on: + push: + workflow_dispatch: + +jobs: + gds: + runs-on: ubuntu-latest + steps: + - name: checkout repo + uses: actions/checkout@v3 + with: + submodules: recursive + + - name: Build GDS + uses: TinyTapeout/tt-gds-action@tt05 + + viewer: + needs: gds + runs-on: ubuntu-latest + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + steps: + - uses: TinyTapeout/tt-gds-action/viewer@tt05 diff --git a/.github/workflows/wokwi_test.yaml b/.github/workflows/wokwi_test.yaml new file mode 100644 index 0000000..2c8683e --- /dev/null +++ b/.github/workflows/wokwi_test.yaml @@ -0,0 +1,67 @@ +name: wokwi_test +# either manually started, or on a schedule +on: [ push, workflow_dispatch ] +jobs: + wokwi_test: + # ubuntu + runs-on: ubuntu-latest + steps: + # need the repo checked out + - name: checkout repo + uses: actions/checkout@v3 + with: + submodules: recursive + + # install oss fpga tools + - name: install oss-cad-suite + uses: YosysHQ/setup-oss-cad-suite@v2 + with: + python-override: true + github-token: ${{ secrets.GITHUB_TOKEN }} + - run: | + yosys --version + iverilog -V + cocotb-config --libpython + cocotb-config --python-bin + + - name: checkout tt tools repo + uses: actions/checkout@v3 + with: + repository: tinytapeout/tt-support-tools + path: tt + ref: tt03p5 + + # need python and requirements + - name: setup python + uses: actions/setup-python@v4 + with: + python-version: '3.10' + - run: pip install -r tt/requirements.txt + + # fetch the truth table + - name: fetch Verilog and build config + run: ./tt/tt_tool.py --create-user-config + + # does the wokwi project have a truthtable? + - name: Check the truthtable exists + id: check_files + uses: andstor/file-existence-action@v2 + with: + files: "src/truthtable.md" + + - name: test + if: steps.check_files.outputs.files_exists == 'true' + run: | + cd src + make clean + make + # make will return success even if the test fails, so check for failure in the results.xml + ! grep failure results.xml + + - name: upload vcd + if: success() || failure() + uses: actions/upload-artifact@v3 + with: + name: test-vcd + path: src/*.vcd + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7ef7f87 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +.DS_Store +.idea +.vscode +*.vcd +runs +src/sim_build +src/__pycache__/ +src/__tinytapeout +src/results.xml +src/user_config.tcl diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..0ce84d8 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +![](../../workflows/gds/badge.svg) ![](../../workflows/docs/badge.svg) ![](../../workflows/wokwi_test/badge.svg) + +# What is Tiny Tapeout? + +TinyTapeout is an educational project that aims to make it easier and cheaper than ever to get your digital designs manufactured on a real chip! + +Go to https://tinytapeout.com for instructions! + +## How to change the Wokwi project + +Edit the [info.yaml](info.yaml) and change the wokwi_id to match your project. + +## How to enable the GitHub actions to build the ASIC files + +Please see the instructions for: + +- [Enabling GitHub Actions](https://tinytapeout.com/faq/#when-i-commit-my-change-the-gds-action-isnt-running) +- [Enabling GitHub Pages](https://tinytapeout.com/faq/#my-github-action-is-failing-on-the-pages-part) + +## How does it work? + +When you edit the info.yaml to choose a different ID, the [GitHub Action](.github/workflows/gds.yaml) will fetch the digital netlist of your design from Wokwi. + +After that, the action uses the open source ASIC tool called [OpenLane](https://www.zerotoasiccourse.com/terminology/openlane/) to build the files needed to fabricate an ASIC. + +## Resources + +- [FAQ](https://tinytapeout.com/faq/) +- [Digital design lessons](https://tinytapeout.com/digital_design/) +- [Learn how semiconductors work](https://tinytapeout.com/siliwiz/) +- [Join the community](https://discord.gg/rPK2nSjxy8) + +## What next? + +- Submit your design to the next shuttle [on the website](https://tinytapeout.com/#submit-your-design), the closing date is 8th September. +- Share your GDS on Twitter, tag it [#tinytapeout](https://twitter.com/hashtag/tinytapeout?src=hashtag_click) and [link me](https://twitter.com/matthewvenn)! diff --git a/info.yaml b/info.yaml new file mode 100644 index 0000000..6508906 --- /dev/null +++ b/info.yaml @@ -0,0 +1,74 @@ +--- +# Tiny Tapeout project information +project: + wokwi_id: 0 # If using wokwi, set this to your project's ID + +# If using an HDL, set wokwi_id as 0 and uncomment and list your source files here. +# Source files must be in ./src and you must list each source file separately +# source_files: +# - counter.v +# - decoder.v +# top_module: "tt_um_example" # Put the name of your top module here, must start with "tt_um_". Make it unique by including your github username + +# How many tiles your design occupies? A single tile is about 167x108 uM. + tiles: "1x1" # Valid values: 1x1, 1x2, 2x2, 4x2 or 8x2 + +# Keep a track of the submission yaml +yaml_version: 4 + +# As everyone will have access to all designs, try to make it easy for someone new to your design to know what +# it does and how to operate it. This info will be automatically collected and used to make a datasheet for the chip. +# +# Here is a great example: https://github.com/davidsiaw/tt02-davidsiaw-stackcalc/blob/38c5647f83aad2aec675d566aa3d67b98f0aac81/info.yaml +documentation: + author: "" # Your name + title: "" # Project title + language: "Wokwi" # other examples include Verilog, Amaranth, VHDL, etc + description: "" # Short description of what your project does + +# Longer description of how the project works. You can use standard markdown format. + how_it_works: | + Explain how your project works + +# Instructions on how someone could test your project, include things like what buttons do what and how to set the clock if needed + how_to_test: | + Explain how to test your project + +# A description of what the inputs do (e.g. red button, SPI CLK, SPI MOSI, etc). + inputs: + - none + - none + - none + - none + - none + - none + - none + - none +# A description of what the outputs do (e.g. status LED, SPI MISO, etc) + outputs: + - segment a + - segment b + - segment c + - segment d + - segment e + - segment f + - segment g + - dot +# A description of what the bidirectional I/O pins do (e.g. I2C SDA, I2C SCL, etc) + bidirectional: + - none + - none + - none + - none + - none + - none + - none + - none + +# The following fields are optional + tag: "" # comma separated list of tags: test, encryption, experiment, clock, animation, utility, industrial, pwm, fpga, alu, microprocessor, risc, riscv, sensor, signal generator, fft, filter, music, bcd, sound, serial, timer, random number generator, calculator, decoder, counter, puzzle, multiplier, game, oscillator, + external_hw: "" # Describe any external hardware needed + discord: "" # Your discord handle, used for communication and automatically assigning tapeout role after a submission + doc_link: "" # URL to longer form documentation, eg the README.md in your repository + clock_hz: 0 # Clock frequency in Hz (if required) + picture: "" # relative path to a picture in your repository (must be 512kb or less) diff --git a/src/cells.v b/src/cells.v new file mode 100644 index 0000000..772fb21 --- /dev/null +++ b/src/cells.v @@ -0,0 +1,102 @@ +/* +This file provides the mapping from the Wokwi modules to Verilog HDL + +It's only needed for Wokwi designs + +*/ +`define default_netname none + +module buffer_cell ( + input wire in, + output wire out + ); + assign out = in; +endmodule + +module and_cell ( + input wire a, + input wire b, + output wire out + ); + + assign out = a & b; +endmodule + +module or_cell ( + input wire a, + input wire b, + output wire out + ); + + assign out = a | b; +endmodule + +module xor_cell ( + input wire a, + input wire b, + output wire out + ); + + assign out = a ^ b; +endmodule + +module nand_cell ( + input wire a, + input wire b, + output wire out + ); + + assign out = !(a&b); +endmodule + +module not_cell ( + input wire in, + output wire out + ); + + assign out = !in; +endmodule + +module mux_cell ( + input wire a, + input wire b, + input wire sel, + output wire out + ); + + assign out = sel ? b : a; +endmodule + +module dff_cell ( + input wire clk, + input wire d, + output reg q, + output wire notq + ); + + assign notq = !q; + always @(posedge clk) + q <= d; + +endmodule + +module dffsr_cell ( + input wire clk, + input wire d, + input wire s, + input wire r, + output reg q, + output wire notq + ); + + assign notq = !q; + + always @(posedge clk or posedge s or posedge r) begin + if (r) + q <= 0; + else if (s) + q <= 1; + else + q <= d; + end +endmodule diff --git a/src/config.tcl b/src/config.tcl new file mode 100644 index 0000000..4a525a1 --- /dev/null +++ b/src/config.tcl @@ -0,0 +1,78 @@ +# DO NOT EDIT THIS FILE before reading the comments below: + +# This is the default configuration for Tiny Tapeout projects. It should fit most designs. +# If you change it, please make sure you understand what you are doing. We are not responsible +# if your project fails because of a bad configuration. + +# !!! DO NOT EDIT THIS FILE unless you know what you are doing !!! + +# If you get stuck with this config, please open an issue or get in touch via the discord. + +# Here are some of the variables you may want to change: + +# PL_TARGET_DENSITY - You can increase this if Global Placement fails with error GPL-0302. +# Users have reported that values up to 0.8 worked well for them. +set ::env(PL_TARGET_DENSITY) 0.6 + +# CLOCK_PERIOD - Increase this in case you are getting setup time violations. +# The value is in nanoseconds, so 20ns == 50MHz. +set ::env(CLOCK_PERIOD) "20" + +# Hold slack margin - Increase them in case you are getting hold violations. +set ::env(PL_RESIZER_HOLD_SLACK_MARGIN) 0.1 +set ::env(GLB_RESIZER_HOLD_SLACK_MARGIN) 0.05 + +# RUN_LINTER, LINTER_INCLUDE_PDK_MODELS - Disabling the linter is not recommended! +set ::env(RUN_LINTER) 1 +set ::env(LINTER_INCLUDE_PDK_MODELS) 1 + +# Configuration docs: https://openlane.readthedocs.io/en/latest/reference/configuration.html + +# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +# !!! DO NOT CHANGE ANYTHING BELOW THIS POINT !!! +# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +# Load configuration auto-generated by tt-support-tools +set script_dir [file dirname [file normalize [info script]]] +source $::env(DESIGN_DIR)/user_config.tcl + +# Save some time +set ::env(RUN_KLAYOUT_XOR) 0 +set ::env(RUN_KLAYOUT_DRC) 0 + +# Don't put clock buffers on the outputs +set ::env(PL_RESIZER_BUFFER_OUTPUT_PORTS) 0 + +# Allow use of specific sky130 cells +set ::env(SYNTH_READ_BLACKBOX_LIB) 1 + +# Reduce wasted space +set ::env(TOP_MARGIN_MULT) 1 +set ::env(BOTTOM_MARGIN_MULT) 1 +set ::env(LEFT_MARGIN_MULT) 6 +set ::env(RIGHT_MARGIN_MULT) 6 + +# Absolute die size +set ::env(FP_SIZING) absolute + +set ::env(PL_BASIC_PLACEMENT) {0} +set ::env(GRT_ALLOW_CONGESTION) "1" + +set ::env(FP_IO_HLENGTH) 2 +set ::env(FP_IO_VLENGTH) 2 + +# Use alternative efabless decap cells to solve LI density issue +set ::env(DECAP_CELL) "\ + sky130_fd_sc_hd__decap_3 \ + sky130_fd_sc_hd__decap_4 \ + sky130_fd_sc_hd__decap_6 \ + sky130_fd_sc_hd__decap_8 \ + sky130_ef_sc_hd__decap_12" + +# Clock +set ::env(RUN_CTS) 1 +set ::env(CLOCK_PORT) {clk} + +# Don't use power rings or met5 layer +set ::env(DESIGN_IS_CORE) 0 +set ::env(RT_MAX_LAYER) {met4}