Makefile

#
# TinyTapeout Blackbox Macro Build Harness
# (mostly for art)
#
# Contributors:
#  - watbulb: Dayton Pidhirney
#
TT_PROJECT_NAME ?= tt_um_macro_testing

PDK_ROOT    := ${PDK_ROOT}
PDK_MAGICRC := $(PDK_ROOT)/sky130A/libs.tech/magic/sky130A.magicrc
ifeq ($(PDK_ROOT),)
$(error "PDK_ROOT not in environment")
endif

VSRC_PATH      ?= $(CURDIR)/src
MAG_MACRO_PATH ?= $(CURDIR)/mag
GDS_MACRO_PATH ?= $(CURDIR)/gds
LEF_MACRO_PATH ?= $(CURDIR)/lef

# The target macro 
TARGET_MACRO ?= $(lastword $(MAKECMDGOALS))

# Macro sources
MAG_SOURCES := $(wildcard $(MAG_MACRO_PATH)/*.mag) 
GDS_SOURCES := $(wildcard $(GDS_MACRO_PATH)/*.gds) 
LEF_SOURCES := $(wildcard $(LEF_MACRO_PATH)/*.lef) 

# Find the magic source for the target macro
MAG_MACROS_SRC := $(foreach macro,$(TARGET_MACRO),$(filter %$(macro).mag,$(MAG_SOURCES)))
GDS_MACROS_SRC := $(foreach macro,$(TARGET_MACRO),$(filter %$(macro).gds,$(GDS_SOURCES)))
LEF_MACROS_SRC := $(foreach macro,$(TARGET_MACRO),$(filter %$(macro).lef,$(LEF_SOURCES)))

# Name of top module
TOP_NAME ?= tt_um_macro_test_wrapper
PURE_ART ?= 1

ifeq ($(words $(MAKECMDGOALS)),2)
  # check if we have a mag or GDS for the macro
  ifeq ($(or $(MAG_MACROS_SRC),$(GDS_MACROS_SRC)),)
    $(error "unable to locate a mag for selected macro $(TARGET_MACRO)")
  endif
  # if we are looking at a GDS macro, we need a LEF for it
  ifneq ($(GDS_MACROS_SRC),)
    ifeq ($(LEF_MACROS_SRC),)
	  $(error "unable to locate LEF for GDS specific macro")
	endif
  endif
  # Info
  ifneq ($(DEBUG),)
    $(info [DEBUG] Variables: )
    $(info PDK_ROOT:         $(PDK_ROOT))
    $(info TT_PROJECT_NAME:  $(TT_PROJECT_NAME))
    $(info TARGET_MACRO:     $(TARGET_MACRO))
    $(info MAG_MACROS_SRC:   $(MAG_MACROS_SRC))
    $(info GDS_MACROS_SRC:   $(GDS_MACROS_SRC))
    $(info LEF_MACROS_SRC:   $(LEF_MACROS_SRC))
  endif
endif

# Some helpers we may need
define macro_name
$(firstword $(subst ., ,$(basename $(notdir $(macro)))))
endef

$(TARGET_MACRO):

#
# Conversion targets
#
$(GDS_MACROS_SRC):
	./script/gds_add_pnb.py $@

$(GDS_MACRO_PATH)/%.gds: $(MAG_MACRO_PATH)/%.mag
	$(info MAG -> GDS)
	echo "gds write \"$@\"" | magic -rcfile $(PDK_MAGICRC) -noconsole -dnull $<	
	./script/gds_add_pnb.py $@

$(LEF_MACRO_PATH)/%.lef: $(MAG_MACRO_PATH)/%.mag
	$(info MAG -> LEF)
	echo "lef write \"$@\" -pinonly" | magic -rcfile $(PDK_MAGICRC) -noconsole -dnull $<

preproc: \
	$(GDS_MACROS_SRC) \
	$(patsubst $(MAG_MACRO_PATH)/%.mag,$(GDS_MACRO_PATH)/%.gds,$(MAG_MACROS_SRC)) \
	$(patsubst $(MAG_MACRO_PATH)/%.mag,$(LEF_MACRO_PATH)/%.lef,$(MAG_MACROS_SRC))

#
# Harden targets
#
tt_user_config:
	./tt/tt_tool.py --create-user-config --openlane2

tt_harden_top: preproc
	mkdir -p runs/$(TAGET_MACRO)
	ln -sf $(TARGET_MACRO)_config.json src/config.json
	./tt/tt_tool.py --harden --openlane2
	cp runs/wokwi/final/gds/* gds/final/
	cp runs/wokwi/final/mag/* mag/final/
	cp runs/wokwi/final/lef/* lef/final/
	PURE_ART=$(PURE_ART) TOP_NAME=$(TOP_NAME) MACRO_NAME=$(TARGET_MACRO) magic -noconsole -dnull ./tcl/place_power_pins.tcl

tt_render_final:
	mkdir -p render
	./tt/tt_tool.py --create-png --openlane2
	mv *.png *.svg render/

harden_top: preproc
	mkdir -p runs/$(TARGET_MACRO)
	openlane --run-tag $(TARGET_MACRO) --force-run-dir runs/$(TARGET_MACRO) src/config_marged.json

#
# Viewers targets
#
open_openroad:
	openlane \
		-f OpenInOpenROAD \
		--run-tag $(TARGET_MACRO) \
		--force-run-dir runs/$(TARGET_MACRO) \
		src/config_merged.json

open_klayout:
	openlane \
		-f OpenInKLayout \
		--run-tag $(TARGET_MACRO) \
		--force-run-dir runs/$(TARGET_MACRO) \
		src/config_merged.json

#
# Cleanup targets
#
clean_final:
	@rm -f  gds/*
	@rm -f  lef/*
	@rm -f  png/*

clean_build:
	@rm -rf runs/*
	@rm -f  src/config_merged.json
	@rm -rf slpp_all

dist_clean: clean_final clean_build

#
# META
#
.NOTPARALLEL:
.PHONY: \
	$(TARGET_MACRO)   \
	$(GDS_MACROS_SRC) \
	preproc \
	tt_user_config \
	tt_harden_top harden_top \
	tt_render_final \
	open_openroad open_klayout \
	clean_final clean_build dist_clean