Update Makefile
diff --git a/Makefile b/Makefile index fc74db5..1b5f960 100644 --- a/Makefile +++ b/Makefile
@@ -16,13 +16,31 @@ # cannot commit files larger than 100 MB to GitHub FILE_SIZE_LIMIT_MB = 100 + +# Commands to be used to compress/uncompress files +# they must operate **in place** (otherwise, modify the target to delete the +# intermediate file/archive) +COMPRESS ?= gzip -n --best +UNCOMPRESS ?= gzip -d +ARCHIVE_EXT ?= gz + +# The following variables are to build static pattern rules + +# Needed to rebuild archives that were previously split +SPLIT_FILES := $(shell find . -type f -name "*.$(ARCHIVE_EXT).00.split") +SPLIT_FILES_SOURCES := $(basename $(basename $(basename $(SPLIT_FILES)))) + +# Needed to uncompress the existing archives +ARCHIVES := $(shell find . -type f -name "*.$(ARCHIVE_EXT)") +ARCHIVE_SOURCES := $(basename $(ARCHIVES)) + +# Needed to compress and split files/archives that are too large 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)) +LARGE_FILES_GZ := $(addsuffix .$(ARCHIVE_EXT), $(LARGE_FILES)) +LARGE_FILES_GZ_SPLIT := $(addsuffix .$(ARCHIVE_EXT).00.split, $(LARGE_FILES)) +# consider splitting existing archives +LARGE_FILES_GZ_SPLIT += $(addsuffix .00.split, $(ARCHIVES)) # PDK setup configs THREADS ?= $(shell nproc) @@ -30,7 +48,7 @@ SPECIAL_VOLTAGE_LIBRARY ?= sky130_fd_sc_hvl IO_LIBRARY ?= sky130_fd_io SKYWATER_COMMIT ?= 3d7617a1acb92ea883539bcf22a632d6361a5de4 -OPEN_PDKS_COMMIT ?= 32cdb2097fd9a629c91e8ea33e1f6de08ab25946 +OPEN_PDKS_COMMIT ?= debc0a49b00d93416e0efd82f26f7604ae1e7a3a .DEFAULT_GOAL := ship # We need portable GDS_FILE pointers... @@ -46,35 +64,58 @@ .PHONY: clean clean: - echo "clean" - + cd ./verilog/dv/caravel/mgmt_soc/ && \ + $(MAKE) -j$(THREADS) clean + cd ./verilog/dv/caravel/user_proj_example/ && \ + $(MAKE) -j$(THREADS) clean .PHONY: verify verify: - echo "verify" + cd ./verilog/dv/caravel/mgmt_soc/ && \ + $(MAKE) -j$(THREADS) all + cd ./verilog/dv/caravel/user_proj_example/ && \ + $(MAKE) -j$(THREADS) all -$(LARGE_FILES_GZ): %.gz: % - @if ! [ $(suffix $<) == ".gz" ]; then\ - gzip -n --best $< > /dev/null &&\ +##### +$(LARGE_FILES_GZ): %.$(ARCHIVE_EXT): % + @if ! [ $(suffix $<) == ".$(ARCHIVE_EXT)" ]; then\ + $(COMPRESS) $< > /dev/null &&\ echo "$< -> $@";\ fi +$(LARGE_FILES_GZ_SPLIT): %.$(ARCHIVE_EXT).00.split: %.$(ARCHIVE_EXT) + @if [ -n "$$(find "$<" -prune -size +$(FILE_SIZE_LIMIT_MB)M)" ]; then\ + split $< -b $(FILE_SIZE_LIMIT_MB)M $<. -d --additional-suffix=.split &&\ + rm $< &&\ + echo -n "$< -> $$(ls $<.*.split)" | tr '\n' ' ' && echo "";\ + fi + # This target compresses all files larger than $(FILE_SIZE_LIMIT_MB) MB .PHONY: compress -compress: $(LARGE_FILES_GZ) +compress: $(LARGE_FILES_GZ) $(LARGE_FILES_GZ_SPLIT) @echo "Files larger than $(FILE_SIZE_LIMIT_MB) MBytes are compressed!" -$(ARCHIVE_SOURCES): %: %.gz - @gzip -d $< &&\ - echo "$< -> $@";\ +##### +$(ARCHIVE_SOURCES): %: %.$(ARCHIVE_EXT) + @$(UNCOMPRESS) $< + @echo "$< -> $@" + +.SECONDEXPANSION: +$(SPLIT_FILES_SOURCES): %: $$(sort $$(wildcard %.$(ARCHIVE_EXT).*.split)) + @cat $? > $@.$(ARCHIVE_EXT) + @rm $? + @echo "$? -> $@.$(ARCHIVE_EXT)" + @$(UNCOMPRESS) $@.$(ARCHIVE_EXT) + @echo "$@.$(ARCHIVE_EXT) -> $@" + .PHONY: uncompress -uncompress: $(ARCHIVE_SOURCES) +uncompress: $(SPLIT_FILES_SOURCES) $(ARCHIVE_SOURCES) @echo "All files are uncompressed!" @@ -85,30 +126,109 @@ 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 | tee ./spi/lvs/tmp/$*.lvs.summary.log + 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;\ + ext2spice $*.ext;\ feedback save extract_$*.log;\ exit;" > ./mag/extract_$*.tcl - cd mag && MAGTYPE=maglef magic -rcfile ${PDK_ROOT}/sky130A/libs.tech/magic/current/sky130A.magicrc -noc -dnull extract_$*.tcl + cd mag && export MAGTYPE=maglef; magic -noc -dnull extract_$*.tcl < /dev/null mv ./mag/$*.spice ./spi/lvs - mv -f ./mag/extract_$*.{tcl,log} ./mag/*.ext ./mag/tmp + rm ./maglef/*.ext + mv -f ./mag/extract_$*.{tcl,log} ./maglef/tmp #### mkdir -p ./spi/lvs/tmp - sh ./spi/lvs/run_lvs.sh ./verilog/gl/$*.v ./spi/lvs/$*.spice $* - mv -f ./spi/lvs/*{.out,.json,.log} ./spi/lvs/tmp 2> /dev/null || true - + sh ./spi/lvs/run_lvs.sh ./spi/lvs/$*.spice ./verilog/gl/$*.v $* + @echo "" + python3 ./scripts/count_lvs.py -f ./verilog/gl/$*.v_comp.json | tee ./spi/lvs/tmp/$*.maglef.lvs.summary.log + 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: skywater-pdk skywater-library skywater-timing open_pdks build-pdk $(PDK_ROOT)/skywater-pdk: git clone https://github.com/google/skywater-pdk.git $(PDK_ROOT)/skywater-pdk @@ -124,9 +244,11 @@ 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 + git submodule update --init libraries/$(SPECIAL_VOLTAGE_LIBRARY)/latest +skywater-timing: check-env $(PDK_ROOT)/skywater-pdk + cd $(PDK_ROOT)/skywater-pdk && \ + $(MAKE) -j$(THREADS) timing ### OPEN_PDKS $(PDK_ROOT)/open_pdks: git clone https://github.com/RTimothyEdwards/open_pdks.git $(PDK_ROOT)/open_pdks @@ -145,7 +267,7 @@ 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) && \ + ./configure --enable-sky130-pdk=$(PDK_ROOT)/skywater-pdk/libraries --with-sky130-local-path=$(PDK_ROOT) && \ cd sky130 && \ $(MAKE) veryclean && \ $(MAKE) && \ @@ -165,3 +287,24 @@ 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@:doc:`tool-versioning`@`tool-versioning.rst <./docs/source/tool-versioning.rst>`__@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 +