blob: dc9be170b9fbecc4382b173120f74194d54a1cf0 [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
manarabdelaty26323152021-09-16 23:11:34 +020018PRECHECK_ROOT?=${HOME}/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
manarabdelaty26323152021-09-16 23:11:34 +020038.PHONY: % : check-caravel
manarabdelatyb41301c2021-04-19 23:30:35 +020039%:
manarabdelaty26323152021-09-16 23:11:34 +020040 export CARAVEL_ROOT=$(CARAVEL_ROOT) && $(MAKE) -f $(CARAVEL_ROOT)/Makefile $@
manarabdelatyb41301c2021-04-19 23:30:35 +020041
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)
manarabdelaty340cc4a2021-04-20 18:28:22 +020057VERIFY_COMMAND="cd ${TARGET_PATH}/verilog/dv/$* && export SIM=${SIM} && make"
manarabdelatyd8dd0102021-04-30 08:40:52 +020058$(DV_PATTERNS): verify-% : ./verilog/dv/%
manarabdelatyb6ce4422021-09-16 22:09:24 +020059 docker run -v ${TARGET_PATH}:${TARGET_PATH} -v ${PDK_ROOT}:${PDK_ROOT} \
manarabdelaty340cc4a2021-04-20 18:28:22 +020060 -v ${CARAVEL_ROOT}:${CARAVEL_ROOT} \
manarabdelatyb6ce4422021-09-16 22:09:24 +020061 -e TARGET_PATH=${TARGET_PATH} -e PDK_ROOT=${PDK_ROOT} \
manarabdelaty340cc4a2021-04-20 18:28:22 +020062 -e CARAVEL_ROOT=${CARAVEL_ROOT} \
63 -u $(id -u $$USER):$(id -g $$USER) efabless/dv_setup:latest \
64 sh -c $(VERIFY_COMMAND)
65
manarabdelatyb41301c2021-04-19 23:30:35 +020066# Openlane Makefile Targets
67BLOCKS = $(shell cd openlane && find * -maxdepth 0 -type d)
68.PHONY: $(BLOCKS)
manarabdelaty5088e752021-04-22 02:18:49 +020069$(BLOCKS): %:
manarabdelatyb41301c2021-04-19 23:30:35 +020070 cd openlane && $(MAKE) $*
71
72# Install caravel
73.PHONY: install
74install:
75ifeq ($(SUBMODULE),1)
76 @echo "Installing $(CARAVEL_NAME) as a submodule.."
manarabdelaty78c1b012021-04-23 17:12:54 +020077# Convert CARAVEL_ROOT to relative path because .gitmodules doesn't accept '/'
78 $(eval CARAVEL_PATH := $(shell realpath --relative-to=$(shell pwd) $(CARAVEL_ROOT)))
79 @if [ ! -d $(CARAVEL_ROOT) ]; then git submodule add --name $(CARAVEL_NAME) $(CARAVEL_REPO) $(CARAVEL_PATH); fi
Jeff DiCorpoa2af4232021-04-20 01:23:54 +000080 @git submodule update --init
Russell L Friesenhahn42af8dc2021-04-27 22:03:21 -050081 @cd $(CARAVEL_ROOT); git checkout $(CARAVEL_BRANCH)
manarabdelatyb41301c2021-04-19 23:30:35 +020082 $(MAKE) simlink
83else
84 @echo "Installing $(CARAVEL_NAME).."
85 @git clone $(CARAVEL_REPO) $(CARAVEL_ROOT)
Russell L Friesenhahn42af8dc2021-04-27 22:03:21 -050086 @cd $(CARAVEL_ROOT); git checkout $(CARAVEL_BRANCH)
manarabdelatyb41301c2021-04-19 23:30:35 +020087endif
88
89# Create symbolic links to caravel's main files
90.PHONY: simlink
91simlink: check-caravel
manarabdelaty78c1b012021-04-23 17:12:54 +020092### Symbolic links relative path to $CARAVEL_ROOT
93 $(eval MAKEFILE_PATH := $(shell realpath --relative-to=openlane $(CARAVEL_ROOT)/openlane/Makefile))
94 $(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 +020095 mkdir -p openlane
96 mkdir -p openlane/user_project_wrapper
97 cd openlane &&\
manarabdelaty78c1b012021-04-23 17:12:54 +020098 ln -sf $(MAKEFILE_PATH) Makefile
manarabdelatye542bdf2021-04-20 11:15:40 +020099 cd openlane/user_project_wrapper &&\
manarabdelaty78c1b012021-04-23 17:12:54 +0200100 ln -sf $(PIN_CFG_PATH) pin_order.cfg
manarabdelatyb41301c2021-04-19 23:30:35 +0200101
102# Update Caravel
103.PHONY: update_caravel
104update_caravel: check-caravel
Jeff DiCorpoa2af4232021-04-20 01:23:54 +0000105ifeq ($(SUBMODULE),1)
manarabdelaty78c1b012021-04-23 17:12:54 +0200106 @git submodule update --init --recursive
107 cd $(CARAVEL_ROOT) && \
108 git checkout $(CARAVEL_BRANCH) && \
109 git pull
manarabdelatyb41301c2021-04-19 23:30:35 +0200110else
111 cd $(CARAVEL_ROOT)/ && \
manarabdelaty78c1b012021-04-23 17:12:54 +0200112 git checkout $(CARAVEL_BRANCH) && \
manarabdelatyb41301c2021-04-19 23:30:35 +0200113 git pull
114endif
115
116# Uninstall Caravel
117.PHONY: uninstall
118uninstall:
119ifeq ($(SUBMODULE),1)
manarabdelaty78c1b012021-04-23 17:12:54 +0200120 git config -f .gitmodules --remove-section "submodule.$(CARAVEL_NAME)"
121 git add .gitmodules
manarabdelatyb41301c2021-04-19 23:30:35 +0200122 git submodule deinit -f $(CARAVEL_ROOT)
manarabdelaty78c1b012021-04-23 17:12:54 +0200123 git rm --cached $(CARAVEL_ROOT)
manarabdelatyb41301c2021-04-19 23:30:35 +0200124 rm -rf .git/modules/$(CARAVEL_NAME)
manarabdelaty78c1b012021-04-23 17:12:54 +0200125 rm -rf $(CARAVEL_ROOT)
manarabdelatyb41301c2021-04-19 23:30:35 +0200126else
127 rm -rf $(CARAVEL_ROOT)
128endif
129
manarabdelaty340cc4a2021-04-20 18:28:22 +0200130# Install Openlane
131.PHONY: openlane
132openlane:
133 cd openlane && $(MAKE) openlane
134
manarabdelaty78c1b012021-04-23 17:12:54 +0200135# Install Pre-check
136# Default installs to the user home directory, override by "export PRECHECK_ROOT=<precheck-installation-path>"
137.PHONY: precheck
138precheck:
manarabdelatyb6ce4422021-09-16 22:09:24 +0200139 @git clone https://github.com/efabless/mpw_precheck.git --depth=1 $(PRECHECK_ROOT)
140 @docker pull efabless/mpw_precheck:latest
manarabdelaty78c1b012021-04-23 17:12:54 +0200141
142.PHONY: run-precheck
143run-precheck: check-precheck check-pdk check-caravel
manarabdelatyb6ce4422021-09-16 22:09:24 +0200144 $(eval INPUT_DIRECTORY := $(shell pwd))
manarabdelaty78c1b012021-04-23 17:12:54 +0200145 cd $(PRECHECK_ROOT) && \
manarabdelatyb6ce4422021-09-16 22:09:24 +0200146 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) \
147 -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)"
manarabdelatyd8dd0102021-04-30 08:40:52 +0200148
149# Install PDK using OL's Docker Image
150.PHONY: pdk-nonnative
151pdk-nonnative: skywater-pdk skywater-library skywater-timing open_pdks
152 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 +0200153
manarabdelatyb41301c2021-04-19 23:30:35 +0200154# Clean
155.PHONY: clean
156clean:
157 cd ./verilog/dv/ && \
158 $(MAKE) -j$(THREADS) clean
159
160check-caravel:
161 @if [ ! -d "$(CARAVEL_ROOT)" ]; then \
162 echo "Caravel Root: "$(CARAVEL_ROOT)" doesn't exists, please export the correct path before running make. "; \
163 exit 1; \
Jeff DiCorpofb944f92021-04-20 00:40:50 +0000164 fi
manarabdelaty78c1b012021-04-23 17:12:54 +0200165
166check-precheck:
167 @if [ ! -d "$(PRECHECK_ROOT)" ]; then \
168 echo "Pre-check Root: "$(PRECHECK_ROOT)" doesn't exists, please export the correct path before running make. "; \
169 exit 1; \
170 fi
171
172check-pdk:
173 @if [ ! -d "$(PDK_ROOT)" ]; then \
174 echo "PDK Root: "$(PDK_ROOT)" doesn't exists, please export the correct path before running make. "; \
175 exit 1; \
manarabdelatyd8dd0102021-04-30 08:40:52 +0200176 fi
177
178.PHONY: help
179help:
180 cd $(CARAVEL_ROOT) && $(MAKE) help
181 @$(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 '^$@$$'