Add files via upload
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/Makefile b/Makefile new file mode 100644 index 0000000..188e997 --- /dev/null +++ b/Makefile
@@ -0,0 +1,181 @@ +# SPDX-FileCopyrightText: 2020 Efabless Corporation +# +# 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. +# +# SPDX-License-Identifier: Apache-2.0 + +CARAVEL_ROOT?=$(PWD)/caravel +PRECHECK_ROOT?=${HOME}/mpw_precheck +SIM ?= RTL + +# Install lite version of caravel, (1): caravel-lite, (0): caravel +CARAVEL_LITE?=1 + +ifeq ($(CARAVEL_LITE),1) + CARAVEL_NAME := caravel-lite + CARAVEL_REPO := https://github.com/efabless/caravel-lite + CARAVEL_BRANCH := main +else + CARAVEL_NAME := caravel + CARAVEL_REPO := https://github.com/efabless/caravel + CARAVEL_BRANCH := master +endif + +# Install caravel as submodule, (1): submodule, (0): clone +SUBMODULE?=1 + +# Include Caravel Makefile Targets +.PHONY: % : check-caravel +%: + export CARAVEL_ROOT=$(CARAVEL_ROOT) && $(MAKE) -f $(CARAVEL_ROOT)/Makefile $@ + +# Verify Target for running simulations +.PHONY: verify +verify: + cd ./verilog/dv/ && \ + export SIM=${SIM} && \ + $(MAKE) -j$(THREADS) + +# Install DV setup +.PHONY: simenv +simenv: + docker pull efabless/dv_setup:latest + +PATTERNS=$(shell cd verilog/dv && find * -maxdepth 0 -type d) +DV_PATTERNS = $(foreach dv, $(PATTERNS), verify-$(dv)) +TARGET_PATH=$(shell pwd) +VERIFY_COMMAND="cd ${TARGET_PATH}/verilog/dv/$* && export SIM=${SIM} && make" +$(DV_PATTERNS): verify-% : ./verilog/dv/% + docker run -v ${TARGET_PATH}:${TARGET_PATH} -v ${PDK_ROOT}:${PDK_ROOT} \ + -v ${CARAVEL_ROOT}:${CARAVEL_ROOT} \ + -e TARGET_PATH=${TARGET_PATH} -e PDK_ROOT=${PDK_ROOT} \ + -e CARAVEL_ROOT=${CARAVEL_ROOT} \ + -u $(id -u $$USER):$(id -g $$USER) efabless/dv_setup:latest \ + sh -c $(VERIFY_COMMAND) + +# Openlane Makefile Targets +BLOCKS = $(shell cd openlane && find * -maxdepth 0 -type d) +.PHONY: $(BLOCKS) +$(BLOCKS): %: + export CARAVEL_ROOT=$(CARAVEL_ROOT) && cd openlane && $(MAKE) $* + +# Install caravel +.PHONY: install +install: +ifeq ($(SUBMODULE),1) + @echo "Installing $(CARAVEL_NAME) as a submodule.." +# Convert CARAVEL_ROOT to relative path because .gitmodules doesn't accept '/' + $(eval CARAVEL_PATH := $(shell realpath --relative-to=$(shell pwd) $(CARAVEL_ROOT))) + @if [ ! -d $(CARAVEL_ROOT) ]; then git submodule add --name $(CARAVEL_NAME) $(CARAVEL_REPO) $(CARAVEL_PATH); fi + @git submodule update --init + @cd $(CARAVEL_ROOT); git checkout $(CARAVEL_BRANCH) + $(MAKE) simlink +else + @echo "Installing $(CARAVEL_NAME).." + @git clone $(CARAVEL_REPO) $(CARAVEL_ROOT) + @cd $(CARAVEL_ROOT); git checkout $(CARAVEL_BRANCH) +endif + +# Create symbolic links to caravel's main files +.PHONY: simlink +simlink: check-caravel +### Symbolic links relative path to $CARAVEL_ROOT + $(eval MAKEFILE_PATH := $(shell realpath --relative-to=openlane $(CARAVEL_ROOT)/openlane/Makefile)) + $(eval PIN_CFG_PATH := $(shell realpath --relative-to=openlane/user_project_wrapper $(CARAVEL_ROOT)/openlane/user_project_wrapper_empty/pin_order.cfg)) + mkdir -p openlane + mkdir -p openlane/user_project_wrapper + cd openlane &&\ + ln -sf $(MAKEFILE_PATH) Makefile + cd openlane/user_project_wrapper &&\ + ln -sf $(PIN_CFG_PATH) pin_order.cfg + +# Update Caravel +.PHONY: update_caravel +update_caravel: check-caravel +ifeq ($(SUBMODULE),1) + @git submodule update --init --recursive + cd $(CARAVEL_ROOT) && \ + git checkout $(CARAVEL_BRANCH) && \ + git pull +else + cd $(CARAVEL_ROOT)/ && \ + git checkout $(CARAVEL_BRANCH) && \ + git pull +endif + +# Uninstall Caravel +.PHONY: uninstall +uninstall: +ifeq ($(SUBMODULE),1) + git config -f .gitmodules --remove-section "submodule.$(CARAVEL_NAME)" + git add .gitmodules + git submodule deinit -f $(CARAVEL_ROOT) + git rm --cached $(CARAVEL_ROOT) + rm -rf .git/modules/$(CARAVEL_NAME) + rm -rf $(CARAVEL_ROOT) +else + rm -rf $(CARAVEL_ROOT) +endif + +# Install Openlane +.PHONY: openlane +openlane: + cd openlane && $(MAKE) openlane + +# Install Pre-check +# Default installs to the user home directory, override by "export PRECHECK_ROOT=<precheck-installation-path>" +.PHONY: precheck +precheck: + @git clone https://github.com/efabless/mpw_precheck.git --depth=1 $(PRECHECK_ROOT) + @docker pull efabless/mpw_precheck:latest + +.PHONY: run-precheck +run-precheck: check-precheck check-pdk check-caravel + $(eval INPUT_DIRECTORY := $(shell pwd)) + cd $(PRECHECK_ROOT) && \ + docker run -e INPUT_DIRECTORY=$(INPUT_DIRECTORY) -e PDK_ROOT=$(PDK_ROOT) -e CARAVEL_ROOT=$(CARAVEL_ROOT) -v $(PRECHECK_ROOT):$(PRECHECK_ROOT) -v $(INPUT_DIRECTORY):$(INPUT_DIRECTORY) -v $(PDK_ROOT):$(PDK_ROOT) -v $(CARAVEL_ROOT):$(CARAVEL_ROOT) \ + -u $(shell id -u $(USER)):$(shell id -g $(USER)) efabless/mpw_precheck:latest bash -c "cd $(PRECHECK_ROOT) ; python3 mpw_precheck.py --pdk_root $(PDK_ROOT) --input_directory $(INPUT_DIRECTORY) --caravel_root $(CARAVEL_ROOT)" + +# Install PDK using OL's Docker Image +.PHONY: pdk-nonnative +pdk-nonnative: skywater-pdk skywater-library skywater-timing open_pdks + docker run --rm -v $(PDK_ROOT):$(PDK_ROOT) -v $(CARAVEL_ROOT):$(CARAVEL_ROOT) -e CARAVEL_ROOT=$(CARAVEL_ROOT) -e PDK_ROOT=$(PDK_ROOT) -u $(shell id -u $(USER)):$(shell id -g $(USER)) efabless/openlane:current sh -c "cd $(CARAVEL_ROOT); make build-pdk; make gen-sources" + +# Clean +.PHONY: clean +clean: + cd ./verilog/dv/ && \ + $(MAKE) -j$(THREADS) clean + +check-caravel: + @if [ ! -d "$(CARAVEL_ROOT)" ]; then \ + echo "Caravel Root: "$(CARAVEL_ROOT)" doesn't exists, please export the correct path before running make. "; \ + exit 1; \ + fi + +check-precheck: + @if [ ! -d "$(PRECHECK_ROOT)" ]; then \ + echo "Pre-check Root: "$(PRECHECK_ROOT)" doesn't exists, please export the correct path before running make. "; \ + exit 1; \ + fi + +check-pdk: + @if [ ! -d "$(PDK_ROOT)" ]; then \ + echo "PDK Root: "$(PDK_ROOT)" doesn't exists, please export the correct path before running make. "; \ + exit 1; \ + fi + +.PHONY: help +help: + cd $(CARAVEL_ROOT) && $(MAKE) help + @$(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' | sort | egrep -v -e '^[^[:alnum:]]' -e '^$@$$'
diff --git a/README.md b/README.md new file mode 100644 index 0000000..8af762d --- /dev/null +++ b/README.md
@@ -0,0 +1,3 @@ +# Caravel User Project + +18 bit Adder \ No newline at end of file
diff --git a/README.md.bak b/README.md.bak new file mode 100644 index 0000000..3706438 --- /dev/null +++ b/README.md.bak
@@ -0,0 +1,11 @@ +# Caravel User Project + +[](https://opensource.org/licenses/Apache-2.0) [](https://github.com/efabless/caravel_project_example/actions/workflows/user_project_ci.yml) [](https://github.com/efabless/caravel_project_example/actions/workflows/caravel_build.yml) + +| :exclamation: Important Note | +|-----------------------------------------| + +## Please fill in your project documentation in this README.md file + + +Refer to [README](docs/source/index.rst) for this sample project documentation.
diff --git a/info.yaml b/info.yaml new file mode 100644 index 0000000..bdd53ba --- /dev/null +++ b/info.yaml
@@ -0,0 +1,19 @@ +--- +project: + description: "A template SoC for Google sponsored Open MPW shuttles for SKY130." + foundry: "SkyWater" + git_url: "https://github.com/efabless/caravel_project_example.git" + organization: "Efabless" + organization_url: "http://efabless.com" + owner: "Tim Edwards" + process: "SKY130" + project_name: "Caravel" + project_id: "00000000" + tags: + - "Open MPW" + - "Test Harness" + category: "Test Harness" + top_level_netlist: "caravel/verilog/gl/caravel.v" + user_level_netlist: "verilog/gl/user_project_wrapper.v" + version: "1.00" + cover_image: "docs/source/_static/caravel_harness.png"