| # 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 |
| |
| # cannot commit files larger than 100 MB to GitHub |
| FILE_SIZE_LIMIT_MB = 100 |
| LARGE_FILES := $(shell find ./gds -type f -name "*.gds") |
| LARGE_FILES += $(shell find . -type f -size +$(FILE_SIZE_LIMIT_MB)M -not -path "./.git/*" -not -path "./gds/*" -not -path "./openlane/*") |
| |
| LARGE_FILES_GZ := $(addsuffix .gz, $(LARGE_FILES)) |
| |
| ARCHIVES := $(shell find . -type f -name "*.gz") |
| ARCHIVE_SOURCES := $(basename $(ARCHIVES)) |
| |
| # PDK setup configs |
| THREADS ?= $(shell nproc) |
| STD_CELL_LIBRARY ?= sky130_fd_sc_hd |
| SPECIAL_VOLTAGE_LIBRARY ?= sky130_fd_sc_hvl |
| IO_LIBRARY ?= sky130_fd_io |
| SKYWATER_COMMIT ?= 3d7617a1acb92ea883539bcf22a632d6361a5de4 |
| OPEN_PDKS_COMMIT ?= 32cdb2097fd9a629c91e8ea33e1f6de08ab25946 |
| |
| .DEFAULT_GOAL := ship |
| # We need portable GDS_FILE pointers... |
| .PHONY: ship |
| ship: check-env uncompress |
| @echo "###############################################" |
| @echo "Generating Caravel GDS (sources are in the 'gds' directory)" |
| @sleep 1 |
| @cp gds/caravel.gds gds/caravel.old.gds && echo "Copying old Caravel to gds/caravel.old.gds" || true |
| @cd gds && MAGTYPE=mag magic -rcfile ${PDK_ROOT}/sky130A/libs.tech/magic/current/sky130A.magicrc -noc -dnull gen_caravel.tcl < /dev/null |
| |
| |
| |
| .PHONY: clean |
| clean: |
| echo "clean" |
| |
| |
| |
| .PHONY: verify |
| verify: |
| echo "verify" |
| |
| |
| |
| $(LARGE_FILES_GZ): %.gz: % |
| @if ! [ $(suffix $<) == ".gz" ]; then\ |
| gzip -n --best $< > /dev/null &&\ |
| echo "$< -> $@";\ |
| fi |
| |
| # This target compresses all files larger than $(FILE_SIZE_LIMIT_MB) MB |
| .PHONY: compress |
| compress: $(LARGE_FILES_GZ) |
| @echo "Files larger than $(FILE_SIZE_LIMIT_MB) MBytes are compressed!" |
| |
| |
| |
| $(ARCHIVE_SOURCES): %: %.gz |
| @gzip -d $< &&\ |
| echo "$< -> $@";\ |
| |
| .PHONY: uncompress |
| uncompress: $(ARCHIVE_SOURCES) |
| @echo "All files are uncompressed!" |
| |
| |
| # LVS |
| BLOCKS = $(shell cd openlane && find * -maxdepth 0 -type d) |
| LVS_BLOCKS = $(foreach block, $(BLOCKS), lvs-$(block)) |
| $(LVS_BLOCKS): lvs-% : ./mag/%.mag ./verilog/gl/%.v |
| echo "Extracting $*" |
| mkdir -p ./mag/tmp |
| echo "load $* -dereference;\ |
| select top cell;\ |
| foreach cell [cellname list children] {\ |
| load \$$cell -dereference;\ |
| property LEFview TRUE;\ |
| };\ |
| load $* -dereference;\ |
| select top cell;\ |
| extract no all;\ |
| extract do local;\ |
| extract unique;\ |
| extract;\ |
| ext2spice lvs;\ |
| ext2spice $*.ext;\ |
| feedback save extract_$*.log;\ |
| exit;" > ./mag/extract_$*.tcl |
| cd mag && export MAGTYPE=maglef; magic -rcfile ${PDK_ROOT}/sky130A/libs.tech/magic/current/sky130A.magicrc -noc -dnull extract_$*.tcl < /dev/null |
| mv ./mag/$*.spice ./spi/lvs |
| rm ./mag/*.ext |
| mv -f ./mag/extract_$*.{tcl,log} ./mag/tmp |
| #### |
| mkdir -p ./spi/lvs/tmp |
| sh ./spi/lvs/run_lvs.sh ./spi/lvs/$*.spice ./verilog/gl/$*.v $* |
| @echo "" |
| python3 ./scripts/count_lvs.py -f ./verilog/gl/$*.v_comp.json |
| mv -f ./verilog/gl/*{.out,.json,.log} ./spi/lvs/tmp 2> /dev/null || true |
| @echo "" |
| @echo "LVS: ./spi/lvs/$*.spice vs. ./verilog/gl/$*.v" |
| @echo "Comparison result: ./spi/lvs/tmp/$*.v_comp.out" |
| |
| # connect-by-label is enabled here! |
| LVS_MAGLEF_BLOCKS = $(foreach block, $(BLOCKS), lvs-maglef-$(block)) |
| $(LVS_MAGLEF_BLOCKS): lvs-maglef-% : ./mag/%.mag ./verilog/gl/%.v |
| echo "Extracting $*" |
| mkdir -p ./maglef/tmp |
| echo "load $* -dereference;\ |
| select top cell;\ |
| foreach cell [cellname list children] {\ |
| load \$$cell -dereference;\ |
| property LEFview TRUE;\ |
| };\ |
| load $* -dereference;\ |
| select top cell;\ |
| extract no all;\ |
| extract do local;\ |
| extract;\ |
| ext2spice lvs;\ |
| ext2spice $*.ext;\ |
| feedback save extract_$*.log;\ |
| exit;" > ./mag/extract_$*.tcl |
| cd mag && export MAGTYPE=maglef; magic -noc -dnull extract_$*.tcl < /dev/null |
| mv ./mag/$*.spice ./spi/lvs |
| rm ./maglef/*.ext |
| mv -f ./mag/extract_$*.{tcl,log} ./maglef/tmp |
| #### |
| mkdir -p ./spi/lvs/tmp |
| sh ./spi/lvs/run_lvs.sh ./spi/lvs/$*.spice ./verilog/gl/$*.v $* |
| @echo "" |
| python3 ./scripts/count_lvs.py -f ./verilog/gl/$*.v_comp.json |
| mv -f ./verilog/gl/*{.out,.json,.log} ./spi/lvs/tmp 2> /dev/null || true |
| @echo "" |
| @echo "LVS: ./spi/lvs/$*.spice vs. ./verilog/gl/$*.v" |
| @echo "Comparison result: ./spi/lvs/tmp/$*.v_comp.out" |
| |
| # DRC |
| BLOCKS = $(shell cd openlane && find * -maxdepth 0 -type d) |
| DRC_BLOCKS = $(foreach block, $(BLOCKS), drc-$(block)) |
| $(DRC_BLOCKS): drc-% : ./gds/%.gds |
| echo "Running DRC on $*" |
| mkdir -p ./gds/tmp |
| cd gds && export DESIGN_IN_DRC=$* && export MAGTYPE=mag; magic -rcfile ${PDK_ROOT}/sky130A/libs.tech/magic/current/sky130A.magicrc -noc -dnull drc_on_gds.tcl < /dev/null |
| @echo "DRC result: ./gds/tmp/$*.drc" |
| |
| # Antenna |
| BLOCKS = $(shell cd openlane && find * -maxdepth 0 -type d) |
| ANTENNA_BLOCKS = $(foreach block, $(BLOCKS), antenna-$(block)) |
| $(ANTENNA_BLOCKS): antenna-% : ./gds/%.gds |
| echo "Running Antenna Checks on $*" |
| mkdir -p ./gds/tmp |
| cd gds && export DESIGN_IN_ANTENNA=$* && export MAGTYPE=mag; magic -rcfile ${PDK_ROOT}/sky130A/libs.tech/magic/current/sky130A.magicrc -noc -dnull antenna_on_gds.tcl < /dev/null 2>&1 | tee ./tmp/$*.antenna |
| mv -f ./gds/*.ext ./gds/tmp/ |
| @echo "Antenna result: ./gds/tmp/$*.antenna" |
| |
| mag2gds: check-env |
| echo "\ |
| gds readonly true; \ |
| gds rescale false; \ |
| load caravel -dereference;\ |
| select top cell;\ |
| gds write caravel.gds; \ |
| exit;" > ./mag/mag2gds_caravel.tcl |
| @cd mag && PDKPATH=${PDK_ROOT}/sky130A magic -noc -dnull mag2gds_caravel.tcl < /dev/null |
| @rm ./mag/mag2gds_caravel.tcl |
| mv -f ./gds/caravel.gds ./gds/caravel.old.gds |
| mv ./mag/caravel.gds ./gds |
| |
| .PHONY: help |
| 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 '^$@$$' |
| |
| |
| ########################################################################### |
| .PHONY: pdk |
| pdk: skywater-pdk skywater-library open_pdks build-pdk |
| |
| $(PDK_ROOT)/skywater-pdk: |
| git clone https://github.com/google/skywater-pdk.git $(PDK_ROOT)/skywater-pdk |
| |
| .PHONY: skywater-pdk |
| skywater-pdk: check-env $(PDK_ROOT)/skywater-pdk |
| cd $(PDK_ROOT)/skywater-pdk && \ |
| git checkout master && git pull && \ |
| git checkout -qf $(SKYWATER_COMMIT) |
| |
| .PHONY: skywater-library |
| skywater-library: check-env $(PDK_ROOT)/skywater-pdk |
| cd $(PDK_ROOT)/skywater-pdk && \ |
| git submodule update --init libraries/$(STD_CELL_LIBRARY)/latest && \ |
| git submodule update --init libraries/$(IO_LIBRARY)/latest && \ |
| git submodule update --init libraries/$(SPECIAL_VOLTAGE_LIBRARY)/latest && \ |
| $(MAKE) -j$(THREADS) timing |
| |
| ### OPEN_PDKS |
| $(PDK_ROOT)/open_pdks: |
| git clone https://github.com/RTimothyEdwards/open_pdks.git $(PDK_ROOT)/open_pdks |
| |
| .PHONY: open_pdks |
| open_pdks: check-env $(PDK_ROOT)/open_pdks |
| cd $(PDK_ROOT)/open_pdks && \ |
| git checkout master && git pull && \ |
| git checkout -qf $(OPEN_PDKS_COMMIT) |
| |
| .PHONY: build-pdk |
| build-pdk: check-env $(PDK_ROOT)/open_pdks $(PDK_ROOT)/skywater-pdk |
| [ -d $(PDK_ROOT)/sky130A ] && \ |
| (echo "Warning: A sky130A build already exists under $(PDK_ROOT). It will be deleted first!" && \ |
| sleep 5 && \ |
| rm -rf $(PDK_ROOT)/sky130A) || \ |
| true |
| cd $(PDK_ROOT)/open_pdks && \ |
| ./configure --with-sky130-source=$(PDK_ROOT)/skywater-pdk/libraries --with-sky130-local-path=$(PDK_ROOT) && \ |
| cd sky130 && \ |
| $(MAKE) veryclean && \ |
| $(MAKE) && \ |
| $(MAKE) install-local |
| |
| .RECIPE: manifest |
| manifest: |
| cd verilog/rtl/ && \ |
| find * -type f ! -name "user_*.v" ! -name "manifest" ! -name "README" ! -name "defines.v" -exec shasum {} \; > manifest && \ |
| cd ../../maglef/ && \ |
| shasum *.mag > manifest && \ |
| cd ../mag/ && \ |
| shasum caravel.mag .magicrc > manifest |
| |
| |
| check-env: |
| ifndef PDK_ROOT |
| $(error PDK_ROOT is undefined, please export it before running make) |
| endif |
| |
| # Make README.rst |
| README.rst: README.src.rst docs/source/getting-started.rst docs/source/tool-versioning.rst openlane/README.src.rst docs/source/caravel-with-openlane.rst Makefile |
| pip -q install rst_include && \ |
| rm -f README.rst && \ |
| rst_include include README.src.rst - | \ |
| sed \ |
| -e's@\.\/\_static@\/docs\/source\/\_static@g' \ |
| -e's@:ref:`tool-versioning`@`tool-versioning`_@g' \ |
| -e's@.. note::@**NOTE:**@g' \ |
| -e's@.. warning::@**WARNING:**@g' \ |
| > README.rst && \ |
| rst_include include openlane/README.src.rst - | \ |
| sed \ |
| -e's@https://github.com/efabless/caravel/blob/master/verilog@../verilog@g' \ |
| -e's@:ref:`getting-started`@`README.rst <../README.rst>`__@g' \ |
| -e's@https://github.com/efabless/caravel/blob/master/openlane/@./@g' \ |
| -e's@.. note::@**NOTE:**@g' \ |
| -e's@.. warning::@**WARNING:**@g' \ |
| > openlane/README.rst |