blob: c7e95e587a9f4ee1c8ae65a02727c3ffbf2c361f [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
kareem76e8a0f2022-02-25 10:13:53 -080016MAKEFLAGS+=--warn-undefined-variables
manarabdelatyb41301c2021-04-19 23:30:35 +020017
manarabdelaty78c1b012021-04-23 17:12:54 +020018CARAVEL_ROOT?=$(PWD)/caravel
manarabdelaty26323152021-09-16 23:11:34 +020019PRECHECK_ROOT?=${HOME}/mpw_precheck
Marwan Abbas51a10962022-02-11 16:35:19 +020020MCW_ROOT?=$(PWD)/mgmt_core_wrapper
kareem76e8a0f2022-02-25 10:13:53 -080021SIM?=RTL
22
23export SKYWATER_COMMIT=c094b6e83a4f9298e47f696ec5a7fd53535ec5eb
24export OPEN_PDKS_COMMIT=7519dfb04400f224f140749cda44ee7de6f5e095
25export PDK_MAGIC_COMMIT=7d601628e4e05fd17fcb80c3552dacb64e9f6e7b
26export OPENLANE_TAG=2022.02.23_02.50.41
manarabdelatyb41301c2021-04-19 23:30:35 +020027
28# Install lite version of caravel, (1): caravel-lite, (0): caravel
29CARAVEL_LITE?=1
30
Jeff DiCorpo5c041f12022-02-25 17:56:06 -080031MPW_TAG ?= mpw-5c
32
kareem76e8a0f2022-02-25 10:13:53 -080033ifeq ($(CARAVEL_LITE),1)
manarabdelatyb41301c2021-04-19 23:30:35 +020034 CARAVEL_NAME := caravel-lite
kareem76e8a0f2022-02-25 10:13:53 -080035 CARAVEL_REPO := https://github.com/efabless/caravel-lite
Jeff DiCorpo5c041f12022-02-25 17:56:06 -080036 CARAVEL_TAG := $(MPW_TAG)
manarabdelatyb41301c2021-04-19 23:30:35 +020037else
38 CARAVEL_NAME := caravel
kareem76e8a0f2022-02-25 10:13:53 -080039 CARAVEL_REPO := https://github.com/efabless/caravel
Jeff DiCorpo5c041f12022-02-25 17:56:06 -080040 CARAVEL_TAG := $(MPW_TAG)
manarabdelatyb41301c2021-04-19 23:30:35 +020041endif
42
manarabdelatyb41301c2021-04-19 23:30:35 +020043# Include Caravel Makefile Targets
manarabdelaty26323152021-09-16 23:11:34 +020044.PHONY: % : check-caravel
kareem76e8a0f2022-02-25 10:13:53 -080045%:
manarabdelaty26323152021-09-16 23:11:34 +020046 export CARAVEL_ROOT=$(CARAVEL_ROOT) && $(MAKE) -f $(CARAVEL_ROOT)/Makefile $@
manarabdelatyb41301c2021-04-19 23:30:35 +020047
kareem76e8a0f2022-02-25 10:13:53 -080048.PHONY: install
49install:
50 if [ -d "$(CARAVEL_ROOT)" ]; then\
51 echo "Deleting exisiting $(CARAVEL_ROOT)" && \
52 rm -rf $(CARAVEL_ROOT) && sleep 2;\
53 fi
54 echo "Installing $(CARAVEL_NAME).."
55 git clone -b $(CARAVEL_TAG) $(CARAVEL_REPO) $(CARAVEL_ROOT) --depth=1
manarabdelatyb41301c2021-04-19 23:30:35 +020056
manarabdelaty340cc4a2021-04-20 18:28:22 +020057# Install DV setup
58.PHONY: simenv
59simenv:
60 docker pull efabless/dv_setup:latest
61
kareem76e8a0f2022-02-25 10:13:53 -080062.PHONY: setup
63setup: install check-env install_mcw pdk openlane
64
65# Openlane
66blocks=$(shell cd openlane && find * -maxdepth 0 -type d)
67.PHONY: $(blocks)
Kareem Farid0eb93ef2022-03-02 13:25:37 +020068$(blocks): % :
kareem76e8a0f2022-02-25 10:13:53 -080069 export CARAVEL_ROOT=$(CARAVEL_ROOT) && cd openlane && $(MAKE) $*
70
71dv_patterns=$(shell cd verilog/dv && find * -maxdepth 0 -type d)
72dv-targets-rtl=$(dv_patterns:%=verify-%-rtl)
73dv-targets-gl=$(dv_patterns:%=verify-%-gl)
74dv-targets-gl-sdf=$(dv_patterns:%=verify-%-gl-sdf)
75
manarabdelaty340cc4a2021-04-20 18:28:22 +020076TARGET_PATH=$(shell pwd)
kareem76e8a0f2022-02-25 10:13:53 -080077verify_command="cd ${TARGET_PATH}/verilog/dv/$* && export SIM=${SIM} && make"
78dv_base_dependencies=simenv
79docker_run_verify=\
manarabdelatyb6ce4422021-09-16 22:09:24 +020080 docker run -v ${TARGET_PATH}:${TARGET_PATH} -v ${PDK_ROOT}:${PDK_ROOT} \
kareemab6cfe12022-02-15 05:36:48 -080081 -v ${CARAVEL_ROOT}:${CARAVEL_ROOT} \
82 -e TARGET_PATH=${TARGET_PATH} -e PDK_ROOT=${PDK_ROOT} \
83 -e CARAVEL_ROOT=${CARAVEL_ROOT} \
84 -e TOOLS=/opt/riscv32i \
85 -e DESIGNS=$(TARGET_PATH) \
Marwan Abbas68788702022-02-15 16:49:02 +020086 -e CORE_VERILOG_PATH=$(TARGET_PATH)/mgmt_core_wrapper/verilog \
87 -e GCC_PREFIX=riscv32-unknown-elf \
kareemab6cfe12022-02-15 05:36:48 -080088 -e MCW_ROOT=$(MCW_ROOT) \
89 -u $$(id -u $$USER):$$(id -g $$USER) efabless/dv_setup:latest \
kareem76e8a0f2022-02-25 10:13:53 -080090 sh -c $(verify_command)
manarabdelatyb41301c2021-04-19 23:30:35 +020091
kareem76e8a0f2022-02-25 10:13:53 -080092.PHONY: harden
93harden: $(blocks)
94
Marwan Abbaseda60992022-03-03 19:53:27 +020095.PHONY: verify-all-rtl
96verify-all-rtl: $(dv-targets-rtl)
97
98.PHONY: verify-all-gl
99verify-all-gl: $(dv-targets-gl)
100
101.PHONY: verify-all-gl-sdf
Marwan Abbas17c43a62022-03-03 21:11:51 +0200102verify-all-gl-sdf: $(dv-targets-gl-sdf)
kareem76e8a0f2022-02-25 10:13:53 -0800103
104$(dv-targets-rtl): SIM=RTL
105$(dv-targets-rtl): verify-%-rtl: $(dv_base_dependencies)
106 $(docker_run_verify)
107
108$(dv-targets-gl): SIM=GL
109$(dv-targets-gl): verify-%-gl: $(dv_base_dependencies)
110 $(docker_run_verify)
111
112$(dv-targets-gl-sdf): SIM=GL_SDF
113$(dv-targets-gl-sdf): verify-%-gl-sdf: $(dv_base_dependencies)
114 $(docker_run_verify)
115
116clean-targets=$(blocks:%=clean-%)
117.PHONY: $(clean-targets)
118$(clean-targets): clean-% :
119 rm -f ./verilog/gl/$*.v
120 rm -f ./spef/$*.spef
121 rm -f ./sdc/$*.sdc
122 rm -f ./sdf/$*.sdf
123 rm -f ./gds/$*.gds
124 rm -f ./mag/$*.mag
125 rm -f ./lef/$*.lef
126 rm -f ./maglef/*.maglef
127
128make_what=setup $(blocks) $(dv-targets-rtl) $(dv-targets-gl) $(dv-targets-gl-sdf) $(clean-targets)
129.PHONY: what
130what:
131 # $(make_what)
132
133# Install Openlane
134.PHONY: openlane
135openlane:
136 cd openlane && $(MAKE) openlane
137
138#### Not sure if the targets following are of any use
manarabdelatyb41301c2021-04-19 23:30:35 +0200139
140# Create symbolic links to caravel's main files
141.PHONY: simlink
142simlink: check-caravel
kareem76e8a0f2022-02-25 10:13:53 -0800143### Symbolic links relative path to $CARAVEL_ROOT
manarabdelaty78c1b012021-04-23 17:12:54 +0200144 $(eval MAKEFILE_PATH := $(shell realpath --relative-to=openlane $(CARAVEL_ROOT)/openlane/Makefile))
145 $(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 +0200146 mkdir -p openlane
147 mkdir -p openlane/user_project_wrapper
148 cd openlane &&\
manarabdelaty78c1b012021-04-23 17:12:54 +0200149 ln -sf $(MAKEFILE_PATH) Makefile
manarabdelatye542bdf2021-04-20 11:15:40 +0200150 cd openlane/user_project_wrapper &&\
manarabdelaty78c1b012021-04-23 17:12:54 +0200151 ln -sf $(PIN_CFG_PATH) pin_order.cfg
manarabdelatyb41301c2021-04-19 23:30:35 +0200152
153# Update Caravel
154.PHONY: update_caravel
155update_caravel: check-caravel
jeffdi298918f2021-12-16 11:15:44 -0800156 cd $(CARAVEL_ROOT)/ && git checkout $(CARAVEL_TAG) && git pull
manarabdelatyb41301c2021-04-19 23:30:35 +0200157
158# Uninstall Caravel
159.PHONY: uninstall
kareem76e8a0f2022-02-25 10:13:53 -0800160uninstall:
manarabdelaty78c1b012021-04-23 17:12:54 +0200161 rm -rf $(CARAVEL_ROOT)
manarabdelatyb41301c2021-04-19 23:30:35 +0200162
manarabdelaty340cc4a2021-04-20 18:28:22 +0200163
manarabdelaty78c1b012021-04-23 17:12:54 +0200164# Install Pre-check
165# Default installs to the user home directory, override by "export PRECHECK_ROOT=<precheck-installation-path>"
166.PHONY: precheck
167precheck:
Ahmed El Omla0abd1612022-02-08 19:12:27 +0200168 @git clone --depth=1 --branch mpw-5a https://github.com/efabless/mpw_precheck.git $(PRECHECK_ROOT)
manarabdelatyb6ce4422021-09-16 22:09:24 +0200169 @docker pull efabless/mpw_precheck:latest
manarabdelaty78c1b012021-04-23 17:12:54 +0200170
171.PHONY: run-precheck
Ahmed El Omla0abd1612022-02-08 19:12:27 +0200172run-precheck: check-pdk check-precheck
manarabdelatyb6ce4422021-09-16 22:09:24 +0200173 $(eval INPUT_DIRECTORY := $(shell pwd))
manarabdelaty78c1b012021-04-23 17:12:54 +0200174 cd $(PRECHECK_ROOT) && \
Ahmed El Omla0abd1612022-02-08 19:12:27 +0200175 docker run -v $(PRECHECK_ROOT):$(PRECHECK_ROOT) -v $(INPUT_DIRECTORY):$(INPUT_DIRECTORY) -v $(PDK_ROOT):$(PDK_ROOT) -e INPUT_DIRECTORY=$(INPUT_DIRECTORY) -e PDK_ROOT=$(PDK_ROOT) \
176 -u $(shell id -u $(USER)):$(shell id -g $(USER)) efabless/mpw_precheck:latest bash -c "cd $(PRECHECK_ROOT) ; python3 mpw_precheck.py --input_directory $(INPUT_DIRECTORY) --pdk_root $(PDK_ROOT)"
manarabdelatyd8dd0102021-04-30 08:40:52 +0200177
manarabdelatyb41301c2021-04-19 23:30:35 +0200178
kareem76e8a0f2022-02-25 10:13:53 -0800179
kareem035ac3d2022-02-25 10:34:26 -0800180.PHONY: clean
181clean:
182 cd ./verilog/dv/ && \
183 $(MAKE) -j$(THREADS) clean
184
manarabdelatyb41301c2021-04-19 23:30:35 +0200185check-caravel:
186 @if [ ! -d "$(CARAVEL_ROOT)" ]; then \
187 echo "Caravel Root: "$(CARAVEL_ROOT)" doesn't exists, please export the correct path before running make. "; \
188 exit 1; \
Jeff DiCorpofb944f92021-04-20 00:40:50 +0000189 fi
manarabdelaty78c1b012021-04-23 17:12:54 +0200190
191check-precheck:
192 @if [ ! -d "$(PRECHECK_ROOT)" ]; then \
193 echo "Pre-check Root: "$(PRECHECK_ROOT)" doesn't exists, please export the correct path before running make. "; \
194 exit 1; \
195 fi
196
197check-pdk:
198 @if [ ! -d "$(PDK_ROOT)" ]; then \
199 echo "PDK Root: "$(PDK_ROOT)" doesn't exists, please export the correct path before running make. "; \
200 exit 1; \
manarabdelatyd8dd0102021-04-30 08:40:52 +0200201 fi
202
203.PHONY: help
204help:
kareem76e8a0f2022-02-25 10:13:53 -0800205 cd $(CARAVEL_ROOT) && $(MAKE) help
manarabdelatyd8dd0102021-04-30 08:40:52 +0200206 @$(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 '^$@$$'
kareem76e8a0f2022-02-25 10:13:53 -0800207
208
209