blob: 25a5e721a47ab35058122cd58d3af277cd54a393 [file] [log] [blame]
manarabdelatyb41301c2021-04-19 23:30:35 +02001# SPDX-FileCopyrightText: 2020 Efabless Corporation
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14#
15# SPDX-License-Identifier: Apache-2.0
16
manarabdelaty78c1b012021-04-23 17:12:54 +020017CARAVEL_ROOT?=$(PWD)/caravel
manarabdelatyd8dd0102021-04-30 08:40:52 +020018PRECHECK_ROOT?=${HOME}/open_mpw_precheck
manarabdelaty340cc4a2021-04-20 18:28:22 +020019SIM ?= RTL
manarabdelatyb41301c2021-04-19 23:30:35 +020020
21# Install lite version of caravel, (1): caravel-lite, (0): caravel
22CARAVEL_LITE?=1
23
24ifeq ($(CARAVEL_LITE),1)
25 CARAVEL_NAME := caravel-lite
manarabdelaty9619ef12021-04-20 11:34:31 +020026 CARAVEL_REPO := https://github.com/efabless/caravel-lite
Russell L Friesenhahn42af8dc2021-04-27 22:03:21 -050027 CARAVEL_BRANCH := main
manarabdelatyb41301c2021-04-19 23:30:35 +020028else
29 CARAVEL_NAME := caravel
30 CARAVEL_REPO := https://github.com/efabless/caravel
Russell L Friesenhahn42af8dc2021-04-27 22:03:21 -050031 CARAVEL_BRANCH := master
manarabdelatyb41301c2021-04-19 23:30:35 +020032endif
33
34# Install caravel as submodule, (1): submodule, (0): clone
35SUBMODULE?=1
36
37# Include Caravel Makefile Targets
38.PHONY: %
39%:
40 $(MAKE) -f $(CARAVEL_ROOT)/Makefile $@
41
42# Verify Target for running simulations
43.PHONY: verify
44verify:
45 cd ./verilog/dv/ && \
manarabdelaty340cc4a2021-04-20 18:28:22 +020046 export SIM=${SIM} && \
47 $(MAKE) -j$(THREADS)
manarabdelatyb41301c2021-04-19 23:30:35 +020048
manarabdelaty340cc4a2021-04-20 18:28:22 +020049# Install DV setup
50.PHONY: simenv
51simenv:
52 docker pull efabless/dv_setup:latest
53
54PATTERNS=$(shell cd verilog/dv && find * -maxdepth 0 -type d)
55DV_PATTERNS = $(foreach dv, $(PATTERNS), verify-$(dv))
56TARGET_PATH=$(shell pwd)
57PDK_PATH=${PDK_ROOT}/sky130A
58VERIFY_COMMAND="cd ${TARGET_PATH}/verilog/dv/$* && export SIM=${SIM} && make"
manarabdelatyd8dd0102021-04-30 08:40:52 +020059$(DV_PATTERNS): verify-% : ./verilog/dv/%
manarabdelaty340cc4a2021-04-20 18:28:22 +020060 docker run -v ${TARGET_PATH}:${TARGET_PATH} -v ${PDK_PATH}:${PDK_PATH} \
61 -v ${CARAVEL_ROOT}:${CARAVEL_ROOT} \
62 -e TARGET_PATH=${TARGET_PATH} -e PDK_PATH=${PDK_PATH} \
63 -e CARAVEL_ROOT=${CARAVEL_ROOT} \
64 -u $(id -u $$USER):$(id -g $$USER) efabless/dv_setup:latest \
65 sh -c $(VERIFY_COMMAND)
66
manarabdelatyb41301c2021-04-19 23:30:35 +020067# Openlane Makefile Targets
68BLOCKS = $(shell cd openlane && find * -maxdepth 0 -type d)
69.PHONY: $(BLOCKS)
manarabdelaty5088e752021-04-22 02:18:49 +020070$(BLOCKS): %:
manarabdelatyb41301c2021-04-19 23:30:35 +020071 cd openlane && $(MAKE) $*
72
73# Install caravel
74.PHONY: install
75install:
76ifeq ($(SUBMODULE),1)
77 @echo "Installing $(CARAVEL_NAME) as a submodule.."
manarabdelaty78c1b012021-04-23 17:12:54 +020078# Convert CARAVEL_ROOT to relative path because .gitmodules doesn't accept '/'
79 $(eval CARAVEL_PATH := $(shell realpath --relative-to=$(shell pwd) $(CARAVEL_ROOT)))
80 @if [ ! -d $(CARAVEL_ROOT) ]; then git submodule add --name $(CARAVEL_NAME) $(CARAVEL_REPO) $(CARAVEL_PATH); fi
Jeff DiCorpoa2af4232021-04-20 01:23:54 +000081 @git submodule update --init
Russell L Friesenhahn42af8dc2021-04-27 22:03:21 -050082 @cd $(CARAVEL_ROOT); git checkout $(CARAVEL_BRANCH)
manarabdelatyb41301c2021-04-19 23:30:35 +020083 $(MAKE) simlink
84else
85 @echo "Installing $(CARAVEL_NAME).."
86 @git clone $(CARAVEL_REPO) $(CARAVEL_ROOT)
Russell L Friesenhahn42af8dc2021-04-27 22:03:21 -050087 @cd $(CARAVEL_ROOT); git checkout $(CARAVEL_BRANCH)
manarabdelatyb41301c2021-04-19 23:30:35 +020088endif
89
90# Create symbolic links to caravel's main files
91.PHONY: simlink
92simlink: check-caravel
manarabdelaty78c1b012021-04-23 17:12:54 +020093### Symbolic links relative path to $CARAVEL_ROOT
94 $(eval MAKEFILE_PATH := $(shell realpath --relative-to=openlane $(CARAVEL_ROOT)/openlane/Makefile))
95 $(eval PIN_CFG_PATH := $(shell realpath --relative-to=openlane/user_project_wrapper $(CARAVEL_ROOT)/openlane/user_project_wrapper_empty/pin_order.cfg))
manarabdelatye542bdf2021-04-20 11:15:40 +020096 mkdir -p openlane
97 mkdir -p openlane/user_project_wrapper
98 cd openlane &&\
manarabdelaty78c1b012021-04-23 17:12:54 +020099 ln -sf $(MAKEFILE_PATH) Makefile
manarabdelatye542bdf2021-04-20 11:15:40 +0200100 cd openlane/user_project_wrapper &&\
manarabdelaty78c1b012021-04-23 17:12:54 +0200101 ln -sf $(PIN_CFG_PATH) pin_order.cfg
manarabdelatyb41301c2021-04-19 23:30:35 +0200102
103# Update Caravel
104.PHONY: update_caravel
105update_caravel: check-caravel
Jeff DiCorpoa2af4232021-04-20 01:23:54 +0000106ifeq ($(SUBMODULE),1)
manarabdelaty78c1b012021-04-23 17:12:54 +0200107 @git submodule update --init --recursive
108 cd $(CARAVEL_ROOT) && \
109 git checkout $(CARAVEL_BRANCH) && \
110 git pull
manarabdelatyb41301c2021-04-19 23:30:35 +0200111else
112 cd $(CARAVEL_ROOT)/ && \
manarabdelaty78c1b012021-04-23 17:12:54 +0200113 git checkout $(CARAVEL_BRANCH) && \
manarabdelatyb41301c2021-04-19 23:30:35 +0200114 git pull
115endif
116
117# Uninstall Caravel
118.PHONY: uninstall
119uninstall:
120ifeq ($(SUBMODULE),1)
manarabdelaty78c1b012021-04-23 17:12:54 +0200121 git config -f .gitmodules --remove-section "submodule.$(CARAVEL_NAME)"
122 git add .gitmodules
manarabdelatyb41301c2021-04-19 23:30:35 +0200123 git submodule deinit -f $(CARAVEL_ROOT)
manarabdelaty78c1b012021-04-23 17:12:54 +0200124 git rm --cached $(CARAVEL_ROOT)
manarabdelatyb41301c2021-04-19 23:30:35 +0200125 rm -rf .git/modules/$(CARAVEL_NAME)
manarabdelaty78c1b012021-04-23 17:12:54 +0200126 rm -rf $(CARAVEL_ROOT)
manarabdelatyb41301c2021-04-19 23:30:35 +0200127else
128 rm -rf $(CARAVEL_ROOT)
129endif
130
manarabdelaty340cc4a2021-04-20 18:28:22 +0200131# Install Openlane
132.PHONY: openlane
133openlane:
134 cd openlane && $(MAKE) openlane
135
manarabdelaty78c1b012021-04-23 17:12:54 +0200136# Install Pre-check
137# Default installs to the user home directory, override by "export PRECHECK_ROOT=<precheck-installation-path>"
138.PHONY: precheck
139precheck:
140 @git clone https://github.com/efabless/open_mpw_precheck.git --depth=1 $(PRECHECK_ROOT)
141 @docker pull efabless/open_mpw_precheck:latest
142
143.PHONY: run-precheck
144run-precheck: check-precheck check-pdk check-caravel
145 $(eval TARGET_PATH := $(shell pwd))
146 cd $(PRECHECK_ROOT) && \
Jeff DiCorpo99ca0fb2021-06-20 14:31:43 -0700147 docker run -e TARGET_PATH=$(TARGET_PATH) -e PDK_ROOT=$(PDK_ROOT) -e CARAVEL_ROOT=$(CARAVEL_ROOT) -v $(PRECHECK_ROOT):/usr/local/bin -v $(TARGET_PATH):$(TARGET_PATH) -v $(PDK_ROOT):$(PDK_ROOT) -v $(CARAVEL_ROOT):$(CARAVEL_ROOT) \
manarabdelatyd8dd0102021-04-30 08:40:52 +0200148 -u $(shell id -u $(USER)):$(shell id -g $(USER)) efabless/open_mpw_precheck:latest bash -c "python3 open_mpw_prechecker.py --pdk_root $(PDK_ROOT) --target_path $(TARGET_PATH) -rfc -c $(CARAVEL_ROOT) "
149
150# Install PDK using OL's Docker Image
151.PHONY: pdk-nonnative
152pdk-nonnative: skywater-pdk skywater-library skywater-timing open_pdks
153 docker run --rm -v $(PDK_ROOT):$(PDK_ROOT) -v $(pwd):/user_project -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"
manarabdelaty78c1b012021-04-23 17:12:54 +0200154
manarabdelatyb41301c2021-04-19 23:30:35 +0200155# Clean
156.PHONY: clean
157clean:
158 cd ./verilog/dv/ && \
159 $(MAKE) -j$(THREADS) clean
160
161check-caravel:
162 @if [ ! -d "$(CARAVEL_ROOT)" ]; then \
163 echo "Caravel Root: "$(CARAVEL_ROOT)" doesn't exists, please export the correct path before running make. "; \
164 exit 1; \
Jeff DiCorpofb944f92021-04-20 00:40:50 +0000165 fi
manarabdelaty78c1b012021-04-23 17:12:54 +0200166
167check-precheck:
168 @if [ ! -d "$(PRECHECK_ROOT)" ]; then \
169 echo "Pre-check Root: "$(PRECHECK_ROOT)" doesn't exists, please export the correct path before running make. "; \
170 exit 1; \
171 fi
172
173check-pdk:
174 @if [ ! -d "$(PDK_ROOT)" ]; then \
175 echo "PDK Root: "$(PDK_ROOT)" doesn't exists, please export the correct path before running make. "; \
176 exit 1; \
manarabdelatyd8dd0102021-04-30 08:40:52 +0200177 fi
178
179.PHONY: help
180help:
181 cd $(CARAVEL_ROOT) && $(MAKE) help
182 @$(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 '^$@$$'