SAIFIINDUSTRIES's picture
Add batch 5 (Luthiraa_TALOS-V2, dawsonjon_fpu, The-OpenROAD-Project_OpenROAD-flow-scripts, antonblanchard_microwatt, alexforencich_verilog-i2c)
784ee2c verified
Raw History Blame Contribute Delete
34.9 kB
# Put variables into this file to avoid having to adding
# the to the make command line.
#
# Out of ORFS trees can have their own settings.mk.
-include settings.mk
# ==============================================================================
# Uncomment or add the design to run
# ==============================================================================
# DESIGN_CONFIG=./designs/nangate45/aes/config.mk
# DESIGN_CONFIG=./designs/nangate45/ariane133/config.mk
# DESIGN_CONFIG=./designs/nangate45/ariane136/config.mk
# DESIGN_CONFIG=./designs/nangate45/black_parrot/config.mk
# DESIGN_CONFIG=./designs/nangate45/bp_be_top/config.mk
# DESIGN_CONFIG=./designs/nangate45/bp_fe_top/config.mk
# DESIGN_CONFIG=./designs/nangate45/bp_multi_top/config.mk
# DESIGN_CONFIG=./designs/nangate45/bp_quad/config.mk
# DESIGN_CONFIG=./designs/nangate45/dynamic_node/config.mk
# DESIGN_CONFIG=./designs/nangate45/gcd/config.mk
# DESIGN_CONFIG=./designs/nangate45/ibex/config.mk
# DESIGN_CONFIG=./designs/nangate45/jpeg/config.mk
# DESIGN_CONFIG=./designs/nangate45/mempool_group/config.mk
# DESIGN_CONFIG=./designs/nangate45/swerv/config.mk
# DESIGN_CONFIG=./designs/nangate45/swerv_wrapper/config.mk
# DESIGN_CONFIG=./designs/nangate45/tinyRocket/config.mk
# DESIGN_CONFIG=./designs/gf12/aes/config.mk
# DESIGN_CONFIG=./designs/gf12/ariane/config.mk
# DESIGN_CONFIG=./designs/gf12/ca53/config.mk
# DESIGN_CONFIG=./designs/gf12/coyote/config.mk
# DESIGN_CONFIG=./designs/gf12/gcd/config.mk
# DESIGN_CONFIG=./designs/gf12/ibex/config.mk
# DESIGN_CONFIG=./designs/gf12/jpeg/config.mk
# DESIGN_CONFIG=./designs/gf12/swerv_wrapper/config.mk
# DESIGN_CONFIG=./designs/gf12/tinyRocket/config.mk
# DESIGN_CONFIG=./designs/gf12/ariane133/config.mk
# DESIGN_CONFIG=./designs/gf12/bp_dual/config.mk
# DESIGN_CONFIG=./designs/gf12/bp_quad/config.mk
# DESIGN_CONFIG=./designs/gf12/bp_single/config.mk
# DESIGN_CONFIG=./designs/sky130hd/aes/config.mk
# DESIGN_CONFIG=./designs/sky130hd/chameleon/config.mk
# DESIGN_CONFIG=./designs/sky130hd/gcd/config.mk
# DESIGN_CONFIG=./designs/sky130hd/ibex/config.mk
# DESIGN_CONFIG=./designs/sky130hd/jpeg/config.mk
# DESIGN_CONFIG=./designs/sky130hd/microwatt/config.mk
# DESIGN_CONFIG=./designs/sky130hd/riscv32i/config.mk
# DESIGN_CONFIG=./designs/sky130hs/aes/config.mk
# DESIGN_CONFIG=./designs/sky130hs/gcd/config.mk
# DESIGN_CONFIG=./designs/sky130hs/ibex/config.mk
# DESIGN_CONFIG=./designs/sky130hs/jpeg/config.mk
# DESIGN_CONFIG=./designs/sky130hs/riscv32i/config.mk
# DESIGN_CONFIG=./designs/asap7/aes/config.mk
# DESIGN_CONFIG=./designs/asap7/ethmac/config.mk
# DESIGN_CONFIG=./designs/asap7/gcd/config.mk
# DESIGN_CONFIG=./designs/asap7/ibex/config.mk
# DESIGN_CONFIG=./designs/asap7/jpeg/config.mk
# DESIGN_CONFIG=./designs/asap7/megaboom/config.mk
# DESIGN_CONFIG=./designs/asap7/riscv32i/config.mk
# DESIGN_CONFIG=./designs/asap7/swerv_wrapper/config.mk
# DESIGN_CONFIG=./designs/asap7/uart/config.mk
# DESIGN_CONFIG=./designs/intel16/aes/config.mk
# DESIGN_CONFIG=./designs/intel16/gcd/config.mk
# DESIGN_CONFIG=./designs/intel22/ibex/config.mk
# DESIGN_CONFIG=./designs/intel22/jpeg/config.mk
# DESIGN_CONFIG=./designs/gf180/aes/config.mk
# DESIGN_CONFIG=./designs/gf180/ibex/config.mk
# DESIGN_CONFIG=./designs/gf180/jpeg/config.mk
# DESIGN_CONFIG=./designs/gf180/riscv32i/config.mk
# DESIGN_CONFIG=./designs/gf180/uart-blocks/config.mk
#DESIGN_CONFIG=./designs/ihp-sg13g2/aes/config.mk
#DESIGN_CONFIG=./designs/ihp-sg13g2/ibex/config.mk
#DESIGN_CONFIG=./designs/ihp-sg13g2/gcd/config.mk
#DESIGN_CONFIG=./designs/ihp-sg13g2/spi/config.mk
#DESIGN_CONFIG=./designs/ihp-sg13g2/riscv32i/config.mk
#DESIGN_CONFIG=./designs/ihp-sg13g2/i2c-gpio-expander/config.mk
# Default design
DESIGN_CONFIG ?= ./designs/nangate45/gcd/config.mk
export DESIGN_CONFIG
include $(DESIGN_CONFIG)
export DESIGN_DIR ?= $(patsubst %/,%,$(dir $(DESIGN_CONFIG)))
# default value "base" for FLOW_VARIANT and "." for WORK_HOME are duplicated
# from variables.yaml and variables.mk because we need it
# earlier in the flow for BLOCKS. BLOCKS is a feature specific to the
# ORFS Makefile.
export FLOW_VARIANT?=base
export WORK_HOME?=.
# BLOCKS is a ORFS make flow specific feature.
ifneq ($(BLOCKS),)
# Normally this comes from variables.yaml, but we need it here to set up these variables
# which are part of the DESIGN_CONFIG. BLOCKS is a Makefile specific concept.
$(foreach block,$(BLOCKS),$(eval BLOCK_LEFS += $(WORK_HOME)/results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/${block}.lef))
$(foreach block,$(BLOCKS),$(eval BLOCK_TYP_LIBS += $(WORK_HOME)/results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/${block}_typ.lib))
$(foreach block,$(BLOCKS),$(eval BLOCK_FAST_LIBS += $(WORK_HOME)/results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/${block}_fast.lib))
$(foreach block,$(BLOCKS),$(eval BLOCK_SLOW_LIBS += $(WORK_HOME)/results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/${block}_slow.lib))
$(foreach block,$(BLOCKS),$(eval BLOCK_GDS += $(WORK_HOME)/results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/6_final.gds))
$(foreach block,$(BLOCKS),$(eval BLOCK_CDL += $(WORK_HOME)/results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/6_final.cdl))
$(foreach block,$(BLOCKS),$(eval BLOCK_LOG_FOLDERS += $(WORK_HOME)/logs/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/))
export ADDITIONAL_LEFS += $(BLOCK_LEFS)
export ADDITIONAL_LIBS += $(BLOCK_TYP_LIBS)
export ADDITIONAL_TYP_LIBS += $(BLOCK_TYP_LIBS)
export ADDITIONAL_FAST_LIBS += $(BLOCK_FAST_LIBS)
export ADDITIONAL_SLOW_LIBS += $(BLOCK_SLOW_LIBS)
export ADDITIONAL_GDS += $(BLOCK_GDS)
ifneq ($(CDL_FILES),)
export CDL_FILES += $(BLOCK_CDL)
endif
endif
# ==============================================================================
# ____ _____ _____ _ _ ____
# / ___|| ____|_ _| | | | _ \
# \___ \| _| | | | | | | |_) |
# ___) | |___ | | | |_| | __/
# |____/|_____| |_| \___/|_|
#
# ==============================================================================
# Disable make's implicit rules
MAKEFLAGS += --no-builtin-rules
.SUFFIXES:
#-------------------------------------------------------------------------------
# Default target when invoking without specific target.
.DEFAULT_GOAL := all
#-------------------------------------------------------------------------------
# Proper way to initiate SHELL for make
SHELL := /usr/bin/env bash
.SHELLFLAGS := -o pipefail -c
#-------------------------------------------------------------------------------
# Setup variables to point to root / head of the OpenROAD directory
# - the following settings allowed user to point OpenROAD binaries to different
# location
# - default is current install / clone directory
ifeq ($(origin FLOW_HOME), undefined)
FLOW_HOME := $(abspath $(dir $(firstword $(MAKEFILE_LIST))))
endif
export FLOW_HOME
include $(FLOW_HOME)/scripts/variables.mk
define GENERATE_ABSTRACT_RULE
ifeq ($(wildcard $(3)),)
# There is no unique config.mk for this module, use the shared
# block.mk that, by convention, is in the same folder as config.mk
# of the parent macro.
#
# At an early stage, before refining each of the macros, a shared
# block.mk file can be useful to run through the flow to explore
# more global concerns instead of getting mired in the details of
# each macro.
block := $(patsubst ./designs/$(PLATFORM)/$(DESIGN_NICKNAME)/%,%,$(dir $(3)))
$(1) $(2) &:
$$(UNSET_AND_MAKE) DESIGN_NAME=${block} DESIGN_NICKNAME=$$(DESIGN_NICKNAME)_${block} DESIGN_CONFIG=$$(shell dirname $$(DESIGN_CONFIG))/block.mk generate_abstract
else
# There is a unique config.mk for this Verilog module
$(1) $(2) &:
$$(UNSET_AND_MAKE) DESIGN_CONFIG=$(3) generate_abstract
endif
endef
# Targets to harden Blocks in case of hierarchical flow is triggered
.PHONY: build_macros
build_macros: $(BLOCK_LEFS) $(BLOCK_TYP_LIBS)
$(foreach block,$(BLOCKS),$(eval $(call GENERATE_ABSTRACT_RULE,$(WORK_HOME)/results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/${block}.lef,$(WORK_HOME)/results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/${block}_typ.lib,$(shell dirname $(DESIGN_CONFIG))/${block}/config.mk)))
$(foreach block,$(BLOCKS),$(eval $(WORK_HOME)/results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/6_final.gds: $(WORK_HOME)/results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/${block}.lef))
# Pre-process KLayout tech
# ==============================================================================
$(OBJECTS_DIR)/klayout_tech.lef: $(TECH_LEF)
$(UNSET_AND_MAKE) do-klayout_tech
.PHONY: do-klayout_tech
do-klayout_tech:
@mkdir -p $(OBJECTS_DIR)
cp $(TECH_LEF) $(OBJECTS_DIR)/klayout_tech.lef
$(OBJECTS_DIR)/klayout.lyt: $(KLAYOUT_TECH_FILE) $(OBJECTS_DIR)/klayout_tech.lef
$(UNSET_AND_MAKE) do-klayout
.PHONY: do-klayout
do-klayout:
@mkdir -p $(dir $(OBJECTS_DIR)/klayout.lyt)
$(PYTHON_EXE) $(UTILS_DIR)/generate_klayout_tech.py \
--template $(KLAYOUT_TECH_FILE) \
--output $(OBJECTS_DIR)/klayout.lyt \
--lef-files $(OBJECTS_DIR)/klayout_tech.lef $(SC_LEF) $(ADDITIONAL_LEFS) \
--map-files $(wildcard $(FLOW_HOME)/platforms/$(PLATFORM)/*map)
$(OBJECTS_DIR)/klayout_wrap.lyt: $(KLAYOUT_TECH_FILE) $(OBJECTS_DIR)/klayout_tech.lef
$(UNSET_AND_MAKE) do-klayout_wrap
.PHONY: do-klayout_wrap
do-klayout_wrap:
@mkdir -p $(dir $(OBJECTS_DIR)/klayout_wrap.lyt)
$(PYTHON_EXE) $(UTILS_DIR)/generate_klayout_tech.py \
--template $(KLAYOUT_TECH_FILE) \
--output $(OBJECTS_DIR)/klayout_wrap.lyt \
--lef-files $(OBJECTS_DIR)/klayout_tech.lef $(WRAP_LEFS)
$(WRAPPED_LEFS):
mkdir -p $(OBJECTS_DIR)/lef $(OBJECTS_DIR)/def
util/cell-veneer/wrap.tcl -cfg $(WRAP_CFG) -macro $(filter %$(notdir $(@:_mod.lef=.lef)),$(WRAP_LEFS))
mv $(notdir $@) $@
mv $(notdir $(@:lef=def)) $(dir $@)../def/$(notdir $(@:lef=def))
$(WRAPPED_LIBS):
mkdir -p $(OBJECTS_DIR)/lib
sed 's/library(\(.*\))/library(\1_mod)/g' $(filter %$(notdir $(@:_mod.lib=.lib)),$(WRAP_LIBS)) | sed 's/cell(\(.*\))/cell(\1_mod)/g' > $@
# ==============================================================================
# ______ ___ _ _____ _ _ _____ ____ ___ ____
# / ___\ \ / / \ | |_ _| | | | ____/ ___|_ _/ ___|
# \___ \\ V /| \| | | | | |_| | _| \___ \| |\___ \
# ___) || | | |\ | | | | _ | |___ ___) | | ___) |
# |____/ |_| |_| \_| |_| |_| |_|_____|____/___|____/
#
.PHONY: synth
synth: $(RESULTS_DIR)/1_synth.odb
.PHONY: synth-report
synth-report: synth
$(UNSET_AND_MAKE) do-synth-report
.PHONY: do-synth-report
do-synth-report:
$(RUN_CMD) --log $(abspath $(LOG_DIR)/1_2_yosys_metrics.log) --tee -- $(OPENROAD_CMD) $(SCRIPTS_DIR)/synth_metrics.tcl
.PHONY: memory
memory:
if [ -f $(RESULTS_DIR)/mem_hierarchical.json ]; then \
$(PYTHON_EXE) $(SCRIPTS_DIR)/mem_dump.py $(RESULTS_DIR)/mem_hierarchical.json; \
fi
$(PYTHON_EXE) $(SCRIPTS_DIR)/mem_dump.py $(RESULTS_DIR)/mem.json
# ==============================================================================
# Run Synthesis using yosys
#-------------------------------------------------------------------------------
$(SDC_FILE_CLOCK_PERIOD): $(SDC_FILE)
$(UNSET_AND_MAKE) do-sdc-clock-period
.PHONY: do-sdc-clock-period
do-sdc-clock-period:
mkdir -p $(dir $(SDC_FILE_CLOCK_PERIOD))
echo $(ABC_CLOCK_PERIOD_IN_PS) > $(SDC_FILE_CLOCK_PERIOD)
.PHONY: yosys-dependencies
yosys-dependencies: $(YOSYS_DEPENDENCIES)
# AUTO_MEMORIES: detect memories in the RTL pre-synthesis and generate
# .lib/.lef macro views for them. Experimental; see
# docs/user/AutoMemories.md.
ifeq ($(AUTO_MEMORIES),1)
$(RESULTS_DIR)/memories_inferred.json: $(VERILOG_FILES) $(SCRIPTS_DIR)/memories/extract_memories.tcl
mkdir -p $(RESULTS_DIR) $(LOG_DIR)
$(SCRIPTS_DIR)/synth.sh $(SCRIPTS_DIR)/memories/extract_memories.tcl $(LOG_DIR)/memories_extract.log
.PHONY: do-auto-memories
do-auto-memories: $(RESULTS_DIR)/memories_inferred.json
mkdir -p $(RESULTS_DIR)
$(PYTHON_EXE) $(SCRIPTS_DIR)/memories/gen_memories.py \
--platform $(PLATFORM) \
--yosys-json $(RESULTS_DIR)/memories_inferred.json \
--out-dir $(RESULTS_DIR)/memories \
--json $(RESULTS_DIR)/memories.json \
$(foreach file,$(VERILOG_FILES),--verilog $(file)) \
$(foreach file,$(ADDITIONAL_MEMORIES),--memories $(file))
$(RESULTS_DIR)/memories.json: $(RESULTS_DIR)/memories_inferred.json $(ADDITIONAL_MEMORIES) \
$(wildcard $(SCRIPTS_DIR)/memories/*.py)
$(UNSET_AND_MAKE) do-auto-memories
yosys-dependencies: $(RESULTS_DIR)/memories.json
$(RESULTS_DIR)/1_1_yosys_canonicalize.rtlil: $(RESULTS_DIR)/memories.json
endif
.PHONY: do-yosys
do-yosys: yosys-dependencies
$(SCRIPTS_DIR)/synth.sh $(SYNTH_SCRIPT) $(LOG_DIR)/1_2_yosys.log
$(RESULTS_DIR)/1_2_yosys.sdc: $(SDC_FILE)
cp $(SDC_FILE) $@
touch -r $(SDC_FILE) $@
.PHONY: do-yosys-canonicalize
do-yosys-canonicalize: yosys-dependencies
$(SCRIPTS_DIR)/synth.sh $(SCRIPTS_DIR)/synth_canonicalize.tcl $(LOG_DIR)/1_1_yosys_canonicalize.log
$(RESULTS_DIR)/1_1_yosys_canonicalize.rtlil: $(YOSYS_DEPENDENCIES)
$(UNSET_AND_MAKE) do-yosys-canonicalize
$(RESULTS_DIR)/1_2_yosys.v: $(RESULTS_DIR)/1_1_yosys_canonicalize.rtlil
$(UNSET_AND_MAKE) do-yosys
.PHONY: clean_synth
clean_synth:
rm -f $(RESULTS_DIR)/1_* $(RESULTS_DIR)/mem*.json
rm -rf $(RESULTS_DIR)/memories
rm -f $(REPORTS_DIR)/synth_*
rm -f $(LOG_DIR)/1_*
rm -f $(SYNTH_STATS)
rm -f $(SDC_FILE_CLOCK_PERIOD)
# ==============================================================================
# _____ _ ___ ___ ____ ____ _ _ _ _
# | ___| | / _ \ / _ \| _ \| _ \| | / \ | \ | |
# | |_ | | | | | | | | | |_) | |_) | | / _ \ | \| |
# | _| | |__| |_| | |_| | _ <| __/| |___ / ___ \| |\ |
# |_| |_____\___/ \___/|_| \_\_| |_____/_/ \_\_| \_|
#
.PHONY: floorplan
floorplan: $(RESULTS_DIR)/2_floorplan.odb \
$(RESULTS_DIR)/2_floorplan.sdc
# ==============================================================================
UNSET_VARS = for var in $(UNSET_VARIABLES_NAMES); do unset $$var; done
# FILE_MAKEFILE is needed when ORFS is invoked with
# `make --file=$FLOW_DIR/Makefile` or `make --directory $FLOW_DIR`.
#
# However, on some versions of make, MAKEFILE_LIST can be empty, so
# don't expand it in that case.
FILE_MAKEFILE ?= $(if $(firstword $(MAKEFILE_LIST)),--file=$(firstword $(MAKEFILE_LIST)),)
SUB_MAKE = $(MAKE) $(foreach V,$(COMMAND_LINE_ARGS), $(if $($V),$V=$(shell echo "$($V)" | $(FLOW_HOME)/scripts/escape.sh),$V='')) --no-print-directory $(FILE_MAKEFILE) DESIGN_CONFIG=$(DESIGN_CONFIG)
UNSET_AND_MAKE = @bash -c '$(UNSET_VARS); $(SUB_MAKE) $$@' --
$(OBJECTS_DIR)/copyright.txt:
@$(OPENROAD_CMD) $(SCRIPTS_DIR)/noop.tcl
mkdir -p $(OBJECTS_DIR)
@touch $(OBJECTS_DIR)/copyright.txt
define OPEN_GUI_SHORTCUT
.PHONY: gui_$(1) open_$(1) web_$(1)
gui_$(1): gui_$(2)
open_$(1): open_$(2)
web_$(1): web_$(2)
endef
define OPEN_GUI
.PHONY: open_$(1) gui_$(1) web_$(1)
open_$(1):
$(2)=$(RESULTS_DIR)/$(1) $(OPENROAD_NO_EXIT_CMD) $(SCRIPTS_DIR)/open.tcl
gui_$(1):
$(2)=$(RESULTS_DIR)/$(1) $(OPENROAD_GUI_CMD) $(SCRIPTS_DIR)/open.tcl
web_$(1):
$(2)=$(RESULTS_DIR)/$(1) $(OPENROAD_WEB_CMD) $(SCRIPTS_DIR)/open.tcl
endef
# Enables "make gui_5_1_grt-failed"
$(eval $(call OPEN_GUI_SHORTCUT,5_1_grt-failed,5_1_grt-failed.odb))
# Separate dependency checking and doing a step. This can
# be useful to retest a stage without having to delete the
# target, or when building a wafer thin layer on top of
# ORFS using CMake, Ninja, Bazel, etc. where makefile
# dependency checking only gets in the way.
#
# Note that there is no "do-synth" step as it is a special
# first step that for usecases such as Bazel where it should
# always be built when invoked. Latter stages in the build process
# are conditionally built by the Bazel implementation.
#
# A "do-synth" step would be welcomed, but it isn't strictly necessary
# for the Bazel use-case.
#
# do-floorplan, do-place, do-cts, do-route, do-finish are the
# supported interface to execute those stages without checking
# for dependencies.
#
# The do- substeps of each of these stages are subject to change.
#
# $(1) stem, e.g. 2_1_floorplan
# $(2) dependencies
# $(3) tcl script step
# $(4) extension of result, default .odb
# $(5) folder of target, default $(RESULTS_DIR)
define do-step
$(if $(5),$(5),$(RESULTS_DIR))/$(1)$(if $(4),$(4),.odb): $(2)
$$(UNSET_AND_MAKE) do-$(1)
ifeq ($(if $(4),$(4),.odb),.odb)
.PHONY: $(1)
$(1): $(RESULTS_DIR)/$(1).odb
$(eval $(call OPEN_GUI_SHORTCUT,$(1),$(1).odb))
endif
.PHONY: do-$(1)
do-$(1): $(OBJECTS_DIR)/copyright.txt
$(SCRIPTS_DIR)/flow.sh $(1) $(3)
endef
# generate make rules to copy a file, if a dependency change and
# a do- sibling rule that copies the file unconditionally.
#
# The file is copied within the $(RESULTS_DIR)
#
# $(1) stem of target, e.g. 2_1_floorplan
# $(2) basename of file to be copied
# $(3) further dependencies
# $(4) target extension, default .odb
define do-copy
$(RESULTS_DIR)/$(1)$(if $(4),$(4),.odb): $(RESULTS_DIR)/$(2) $(3)
$$(UNSET_AND_MAKE) do-$(1)$(if $(4),$(4),)
.PHONY: do-$(1)$(if $(4),$(4),)
do-$(1)$(if $(4),$(4),):
cp $(RESULTS_DIR)/$(2) $(RESULTS_DIR)/$(1)$(if $(4),$(4),.odb)
endef
# ==============================================================================
# Custom target to go from synthesis to placement in a single OpenROAD run
$(eval $(call do-step,1_3_floorplan_to_place, $(RESULTS_DIR)/1_synth.odb $(RESULTS_DIR)/1_synth.sdc,floorplan_to_place))
$(eval $(call OPEN_GUI_SHORTCUT,yosys,1_2_yosys.v))
.PHONY: floorplan_to_place
floorplan_to_place: $(RESULTS_DIR)/1_synth.odb $(RESULTS_DIR)/1_synth.sdc
$(UNSET_AND_MAKE) do-1_3_floorplan_to_place
# ==============================================================================
ifeq ($(SYNTH_USE_SYN),1)
$(eval $(call do-step,1_synth,$(VERILOG_FILES) $(SDC_FILE) $(TECH_LEF) $(SC_LEF) $(ADDITIONAL_LEFS) $(LIB_FILES),synth_syn))
else
$(eval $(call do-step,1_synth,$(RESULTS_DIR)/1_2_yosys.v $(RESULTS_DIR)/1_2_yosys.sdc $(TECH_LEF) $(SC_LEF) $(ADDITIONAL_LEFS) $(LIB_FILES),synth_odb))
endif
$(RESULTS_DIR)/1_synth.sdc: $(RESULTS_DIR)/1_synth.odb
$(eval $(call do-step,2_1_floorplan,$(RESULTS_DIR)/1_synth.odb $(RESULTS_DIR)/1_synth.sdc $(TECH_LEF) $(SC_LEF) $(ADDITIONAL_LEFS) $(FOOTPRINT) $(SIG_MAP_FILE) $(FOOTPRINT_TCL) $(LIB_FILES) $(IO_CONSTRAINTS),floorplan))
$(eval $(call do-copy,2_floorplan,2_1_floorplan.sdc,,.sdc))
# STEP 2: Macro Placement
#-------------------------------------------------------------------------------
$(eval $(call do-step,2_2_floorplan_macro,$(RESULTS_DIR)/2_1_floorplan.odb $(RESULTS_DIR)/1_synth.sdc $(MACRO_PLACEMENT) $(MACRO_PLACEMENT_TCL),macro_place))
# STEP 3: Tapcell and Welltie insertion
#-------------------------------------------------------------------------------
$(eval $(call do-step,2_3_floorplan_tapcell,$(RESULTS_DIR)/2_2_floorplan_macro.odb $(TAPCELL_TCL),tapcell))
# STEP 4: PDN generation
#-------------------------------------------------------------------------------
$(eval $(call do-step,2_4_floorplan_pdn,$(RESULTS_DIR)/2_3_floorplan_tapcell.odb $(PDN_TCL),pdn))
$(eval $(call do-copy,2_floorplan,2_4_floorplan_pdn.odb,))
$(RESULTS_DIR)/2_floorplan.sdc: $(RESULTS_DIR)/2_1_floorplan.odb
.PHONY: do-floorplan
do-floorplan:
$(UNSET_AND_MAKE) do-2_1_floorplan do-2_2_floorplan_macro do-2_3_floorplan_tapcell do-2_4_floorplan_pdn do-2_floorplan do-2_floorplan.sdc
.PHONY: clean_floorplan
clean_floorplan:
rm -f $(RESULTS_DIR)/2_*floorplan*.odb $(RESULTS_DIR)/2_floorplan.sdc $(RESULTS_DIR)/2_*.v $(RESULTS_DIR)/2_*.def
rm -f $(REPORTS_DIR)/2_*
rm -f $(LOG_DIR)/2_*
# ==============================================================================
# ____ _ _ ____ _____
# | _ \| | / \ / ___| ____|
# | |_) | | / _ \| | | _|
# | __/| |___ / ___ \ |___| |___
# |_| |_____/_/ \_\____|_____|
#
.PHONY: place
place: $(RESULTS_DIR)/3_place.odb \
$(RESULTS_DIR)/3_place.sdc
# ==============================================================================
# STEP 1: Global placement without placed IOs, timing-driven, and routability-driven.
#-------------------------------------------------------------------------------
$(eval $(call do-step,3_1_place_gp_skip_io,$(RESULTS_DIR)/2_floorplan.odb $(RESULTS_DIR)/2_floorplan.sdc $(LIB_FILES),global_place_skip_io))
$(eval $(call do-step,3_2_place_iop,$(RESULTS_DIR)/3_1_place_gp_skip_io.odb,io_placement))
# STEP 3: Global placement with placed IOs, timing-driven, and routability-driven.
#-------------------------------------------------------------------------------
$(eval $(call do-step,3_3_place_gp,$(RESULTS_DIR)/3_2_place_iop.odb $(RESULTS_DIR)/2_floorplan.sdc $(LIB_FILES),global_place))
# STEP 4: Resizing & Buffering
#-------------------------------------------------------------------------------
$(eval $(call do-step,3_4_place_resized,$(RESULTS_DIR)/3_3_place_gp.odb $(RESULTS_DIR)/2_floorplan.sdc,resize))
.PHONY: clean_resize
clean_resize:
rm -f $(RESULTS_DIR)/3_4_place_resized.odb
# STEP 5: Detail placement
#-------------------------------------------------------------------------------
$(eval $(call do-step,3_5_place_dp,$(RESULTS_DIR)/3_4_place_resized.odb,detail_place))
$(eval $(call do-copy,3_place,3_5_place_dp.odb,))
# detail_place writes 3_place.sdc alongside 3_5_place_dp.odb (constraints
# are unchanged during placement), mirroring how synth writes 1_synth.sdc.
$(RESULTS_DIR)/3_place.sdc: $(RESULTS_DIR)/3_5_place_dp.odb
.PHONY: do-place
do-place:
$(UNSET_AND_MAKE) do-3_1_place_gp_skip_io do-3_2_place_iop do-3_3_place_gp do-3_4_place_resized do-3_5_place_dp do-3_place
# Clean Targets
#-------------------------------------------------------------------------------
.PHONY: clean_place
clean_place:
rm -f $(RESULTS_DIR)/3_*place*.odb
rm -f $(RESULTS_DIR)/3_place.sdc
rm -f $(RESULTS_DIR)/3_*.def $(RESULTS_DIR)/3_*.v
rm -f $(REPORTS_DIR)/3_*
rm -f $(LOG_DIR)/3_*
# ==============================================================================
# ____ _____ ____
# / ___|_ _/ ___|
# | | | | \___ \
# | |___ | | ___) |
# \____| |_| |____/
#
.PHONY: cts
cts: $(RESULTS_DIR)/4_cts.odb \
$(RESULTS_DIR)/4_cts.sdc
# ==============================================================================
# Run TritonCTS
# ------------------------------------------------------------------------------
$(eval $(call do-step,4_1_cts,$(RESULTS_DIR)/3_place.odb $(RESULTS_DIR)/3_place.sdc,cts))
$(RESULTS_DIR)/4_cts.sdc: $(RESULTS_DIR)/4_cts.odb
$(eval $(call do-copy,4_cts,4_1_cts.odb))
.PHONY: do-cts
do-cts:
$(UNSET_AND_MAKE) do-4_1_cts do-4_cts
.PHONY: clean_cts
clean_cts:
rm -rf $(RESULTS_DIR)/4_*cts*.odb $(RESULTS_DIR)/4_cts.sdc $(RESULTS_DIR)/4_*.v $(RESULTS_DIR)/4_*.def
rm -f $(REPORTS_DIR)/4_*
rm -rf $(LOG_DIR)/4_*
# ==============================================================================
# ____ ___ _ _ _____ ___ _ _ ____
# | _ \ / _ \| | | |_ _|_ _| \ | |/ ___|
# | |_) | | | | | | | | | | || \| | | _
# | _ <| |_| | |_| | | | | || |\ | |_| |
# |_| \_\\___/ \___/ |_| |___|_| \_|\____|
#
.PHONY: route
route: $(RESULTS_DIR)/5_route.odb \
$(RESULTS_DIR)/5_route.sdc
.PHONY: grt globalroute
globalroute: grt
grt: $(RESULTS_DIR)/5_1_grt.odb
# ==============================================================================
# STEP 1: Run global route
#-------------------------------------------------------------------------------
$(eval $(call do-step,5_1_grt,$(RESULTS_DIR)/4_cts.odb $(FASTROUTE_TCL) $(PRE_GLOBAL_ROUTE_TCL),global_route))
# STEP 2: Run detailed route
#-------------------------------------------------------------------------------
$(eval $(call do-step,5_2_route,$(RESULTS_DIR)/5_1_grt.odb,detail_route))
$(eval $(call do-step,5_3_fillcell,$(RESULTS_DIR)/5_2_route.odb,fillcell))
$(eval $(call do-copy,5_route,5_3_fillcell.odb))
$(eval $(call do-copy,5_route,5_1_grt.sdc,,.sdc))
.PHONY: do-route
do-route:
$(UNSET_AND_MAKE) do-5_1_grt do-5_2_route do-5_3_fillcell do-5_route do-5_route.sdc
.PHONY: do-grt
do-grt:
$(UNSET_AND_MAKE) do-5_1_grt
.PHONY: clean_route
clean_route:
rm -rf $(RESULTS_DIR)/route.guide $(RESULTS_DIR)/output_guide.mod $(RESULTS_DIR)/updated_clks.sdc
rm -rf $(RESULTS_DIR)/5_*.odb $(RESULTS_DIR)/5_route.sdc $(RESULTS_DIR)/5_*.def $(RESULTS_DIR)/5_*.v
rm -f $(REPORTS_DIR)/5_*
rm -f $(LOG_DIR)/5_*
.PHONY: klayout_tr_rpt
klayout_tr_rpt: $(RESULTS_DIR)/5_route.def $(OBJECTS_DIR)/klayout.lyt
$(SCRIPTS_DIR)/klayout.sh -rd in_drc="$(REPORTS_DIR)/5_route_drc.rpt" \
-rd in_def="$<" \
-rd tech_file=$(OBJECTS_DIR)/klayout.lyt \
-rm $(UTILS_DIR)/viewDrc.py
.PHONY: klayout_guides
klayout_guides: $(RESULTS_DIR)/5_route.def $(OBJECTS_DIR)/klayout.lyt
$(SCRIPTS_DIR)/klayout.sh -rd in_guide="$(RESULTS_DIR)/route.guide" \
-rd in_def="$<" \
-rd net_name=$(GUIDE_NET) \
-rd tech_file=$(OBJECTS_DIR)/klayout.lyt \
-rm $(UTILS_DIR)/viewGuide.py
# ==============================================================================
# _____ ___ _ _ ___ ____ _ _ ___ _ _ ____
# | ___|_ _| \ | |_ _/ ___|| | | |_ _| \ | |/ ___|
# | |_ | || \| || |\___ \| |_| || || \| | | _
# | _| | || |\ || | ___) | _ || || |\ | |_| |
# |_| |___|_| \_|___|____/|_| |_|___|_| \_|\____|
#
.PHONY: finish
finish: $(LOG_DIR)/6_report.log \
$(RESULTS_DIR)/6_final.v \
$(RESULTS_DIR)/6_final.sdc \
$(GDS_FINAL_FILE)
$(UNSET_AND_MAKE) elapsed
.PHONY: elapsed
elapsed:
-@$(PYTHON_EXE) $(UTILS_DIR)/genElapsedTime.py -d $(BLOCK_LOG_FOLDERS) $(LOG_DIR)
# Useful when working with macros, see elapsed time for all macros in platform
.PHONY: elapsed-all
elapsed-all:
@$(PYTHON_EXE) $(UTILS_DIR)/genElapsedTime.py -d $(shell find $(WORK_HOME)/logs/$(PLATFORM)/*/*/ -type d)
$(eval $(call do-step,6_1_fill,$(RESULTS_DIR)/5_route.odb $(RESULTS_DIR)/5_route.sdc $(FILL_CONFIG),density_fill))
$(eval $(call do-copy,6_1_fill,5_route.sdc,,.sdc))
$(eval $(call do-step,6_report,$(RESULTS_DIR)/6_1_fill.odb $(RESULTS_DIR)/6_1_fill.sdc,final_report,.log,$(LOG_DIR)))
# final_report writes 6_final.sdc alongside 6_final.odb (constraints are
# unchanged during finishing), mirroring how synth writes 1_synth.sdc.
$(RESULTS_DIR)/6_final.sdc: $(LOG_DIR)/6_report.log
$(RESULTS_DIR)/6_final.def: $(LOG_DIR)/6_report.log
# The final results are called 6_final.*, so it is convenient when scripting
# to have the names of the artifacts match the name of the target
.PHONY: do-final
do-final: do-finish
.PHONY: final
final: finish
.PHONY: do-finish
do-finish:
$(UNSET_AND_MAKE) do-6_1_fill do-6_1_fill.sdc do-6_report elapsed
.PHONY: generate_abstract
generate_abstract: $(RESULTS_DIR)/6_final.gds $(RESULTS_DIR)/6_final.def $(RESULTS_DIR)/6_final.v $(RESULTS_DIR)/6_final.sdc
$(UNSET_AND_MAKE) do-generate_abstract
# Set ABSTRACT_SOURCE if you want to create an abstract from another stage than 6_final.
.PHONY: do-generate_abstract
do-generate_abstract:
mkdir -p $(LOG_DIR) $(REPORTS_DIR)
$(RUN_CMD) --log $(abspath $(LOG_DIR)/generate_abstract.log) --tee -- $(OPENROAD_CMD) $(SCRIPTS_DIR)/generate_abstract.tcl -metrics $(LOG_DIR)/generate_abstract.json
.PHONY: clean_abstract
clean_abstract:
rm -f $(RESULTS_DIR)/$(DESIGN_NAME).lib $(RESULTS_DIR)/$(DESIGN_NAME).lef
.PHONY: check-klayout
check-klayout:
@if [ -z "$(KLAYOUT_CMD)" ]; then \
echo "Error: KLayout not found. Install KLayout or set KLAYOUT_CMD."; \
echo "Hint: KLayout is needed for GDS/DRC/LVS targets."; \
exit 1; \
fi
.PHONY: gds
gds: $(GDS_FINAL_FILE)
# Merge wrapped macros using Klayout
#-------------------------------------------------------------------------------
$(WRAPPED_GDSOAS): $(OBJECTS_DIR)/klayout_wrap.lyt $(WRAPPED_LEFS)
$(RUN_CMD) --log $(abspath $(LOG_DIR)/6_merge_$(basename $(notdir $@)).log) --tee -- \
$(SCRIPTS_DIR)/klayout.sh -zz -rd design_name=$(basename $(notdir $@)) \
-rd in_def=$(OBJECTS_DIR)/def/$(notdir $(@:$(STREAM_SYSTEM_EXT)=def)) \
-rd in_files="$(ADDITIONAL_GDSOAS)" \
-rd config_file=$(FILL_CONFIG) \
-rd seal_file="" \
-rd out_file=$@ \
-rd tech_file=$(OBJECTS_DIR)/klayout_wrap.lyt \
-rd layer_map=$(GDS_LAYER_MAP) \
-r $(UTILS_DIR)/def2stream.py
# Merge GDS using Klayout
#-------------------------------------------------------------------------------
$(GDS_MERGED_FILE): $(RESULTS_DIR)/6_final.def $(OBJECTS_DIR)/klayout.lyt $(GDSOAS_FILES) $(WRAPPED_GDSOAS) $(SEAL_GDSOAS) | check-klayout
$(UNSET_AND_MAKE) do-gds-merged
.PHONY: do-gds-merged
do-gds-merged:
$(RUN_CMD) --log $(abspath $(LOG_DIR)/6_1_merge.log) --tee -- \
$(SCRIPTS_DIR)/klayout.sh -zz -rd design_name=$(DESIGN_NAME) \
-rd in_def=$(RESULTS_DIR)/6_final.def \
-rd in_files="$(GDSOAS_FILES) $(WRAPPED_GDSOAS)" \
-rd seal_file="$(SEAL_GDSOAS)" \
-rd out_file=$(GDS_MERGED_FILE) \
-rd tech_file=$(OBJECTS_DIR)/klayout.lyt \
-rd layer_map=$(GDS_LAYER_MAP) \
-r $(UTILS_DIR)/def2stream.py
$(RESULTS_DIR)/6_final.v: $(LOG_DIR)/6_report.log
.PHONY: do-gds
do-gds:
$(UNSET_AND_MAKE) do-klayout_tech do-klayout do-klayout_wrap do-gds-merged
cp $(GDS_MERGED_FILE) $(GDS_FINAL_FILE)
$(GDS_FINAL_FILE): $(GDS_MERGED_FILE)
cp $< $@
.PHONY: drc
drc: $(REPORTS_DIR)/6_drc.lyrdb
$(REPORTS_DIR)/6_drc.lyrdb: $(GDS_FINAL_FILE) $(KLAYOUT_DRC_FILE)
ifneq ($(KLAYOUT_DRC_FILE),)
$(RUN_CMD) --log $(abspath $(LOG_DIR)/6_drc.log) --tee -- \
$(SCRIPTS_DIR)/klayout.sh -zz -rd in_gds="$<" \
-rd report_file=$(abspath $@) \
-r $(KLAYOUT_DRC_FILE)
# Hacky way of getting DRV count (don't error on no matches)
grep -c "<value>" $@ > $(REPORTS_DIR)/6_drc_count.rpt || [[ $$? == 1 ]]
else
echo "DRC not supported on this platform" > $@
endif
$(RESULTS_DIR)/6_final.cdl: $(RESULTS_DIR)/6_final.v
$(RUN_CMD) --log $(abspath $(LOG_DIR)/6_cdl.log) --tee -- $(OPENROAD_CMD) $(SCRIPTS_DIR)/cdl.tcl
$(OBJECTS_DIR)/6_final_concat.cdl: $(RESULTS_DIR)/6_final.cdl $(CDL_FILE)
cat $^ > $@
.PHONY: lvs
lvs: $(RESULTS_DIR)/6_lvs.lvsdb
$(RESULTS_DIR)/6_lvs.lvsdb: $(GDS_FINAL_FILE) $(KLAYOUT_LVS_FILE) $(OBJECTS_DIR)/6_final_concat.cdl
ifneq ($(KLAYOUT_LVS_FILE),)
$(RUN_CMD) --log $(abspath $(LOG_DIR)/6_lvs.log) --tee -- \
$(SCRIPTS_DIR)/klayout.sh -b -rd in_gds="$<" \
-rd cdl_file=$(abspath $(OBJECTS_DIR)/6_final_concat.cdl) \
-rd report_file=$(abspath $@) \
-r $(KLAYOUT_LVS_FILE)
else
echo "LVS not supported on this platform" > $@
endif
.PHONY: clean_finish
clean_finish:
rm -rf $(RESULTS_DIR)/6_*.gds $(RESULTS_DIR)/6_*.oas $(RESULTS_DIR)/6_*.odb $(RESULTS_DIR)/6_*.v $(RESULTS_DIR)/6_*.def $(RESULTS_DIR)/6_*.sdc $(RESULTS_DIR)/6_*.spef
rm -rf $(REPORTS_DIR)/6_*.rpt
rm -f $(LOG_DIR)/6_*
# ==============================================================================
# __ __ ___ ____ ____
# | \/ |_ _/ ___| / ___|
# | |\/| || |\___ \| |
# | | | || | ___) | |___
# |_| |_|___|____/ \____|
#
# ==============================================================================
.PHONY: check-openroad
check-openroad:
@if [ "$(strip $(OPENROAD_IS_VALID))" != "true" ]; then \
echo "OPENROAD_EXE is set to '$(OPENROAD_EXE)', but it is either not found or not executable."; \
exit 1; \
fi
.PHONY: check-yosys
check-yosys:
@if [ "$(strip $(YOSYS_IS_VALID))" != "true" ]; then \
echo "YOSYS_EXE is set to '$(YOSYS_EXE)', but it is either not found or not executable."; \
exit 1; \
fi
.PHONY: all
all: check-yosys check-openroad synth floorplan place cts route finish
.PHONY: clean
clean:
@echo
@echo "Make clean disabled."
@echo "Use make clean_all or clean individual steps:"
@echo " clean_synth clean_floorplan clean_place clean_cts clean_route clean_finish"
@echo
.PHONY: clean_all
clean_all: clean_synth clean_floorplan clean_place clean_cts clean_route clean_finish clean_metadata clean_abstract
rm -rf $(OBJECTS_DIR)
.PHONY: nuke
nuke: clean_test clean_issues
rm -rf $(WORK_HOME)/results $(WORK_HOME)/logs $(WORK_HOME)/reports $(WORK_HOME)/objects
rm -f $(OBJECTS_DIR)/copyright.txt
# DEF/GDS/OAS viewer shortcuts
#-------------------------------------------------------------------------------
.PHONY: $(foreach file,$(RESULTS_DEF) $(RESULTS_GDS) $(RESULTS_OAS),klayout_$(file))
$(foreach file,$(RESULTS_DEF) $(RESULTS_GDS) $(RESULTS_OAS),klayout_$(file)): klayout_%: check-klayout $(OBJECTS_DIR)/klayout.lyt
$(SCRIPTS_DIR)/klayout.sh -nn $(OBJECTS_DIR)/klayout.lyt $(RESULTS_DIR)/$*
$(eval $(call OPEN_GUI_SHORTCUT,synth,1_synth.odb))
$(eval $(call OPEN_GUI_SHORTCUT,floorplan,2_floorplan.odb))
$(eval $(call OPEN_GUI_SHORTCUT,place,3_place.odb))
$(eval $(call OPEN_GUI_SHORTCUT,cts,4_cts.odb))
$(eval $(call OPEN_GUI_SHORTCUT,route,5_route.odb))
$(eval $(call OPEN_GUI_SHORTCUT,grt,5_1_grt.odb))
$(eval $(call OPEN_GUI_SHORTCUT,final,6_final.odb))
$(foreach file,$(RESULTS_DEF),$(eval $(call OPEN_GUI,$(file),DEF_FILE)))
$(foreach file,$(RESULTS_ODB),$(eval $(call OPEN_GUI,$(file),ODB_FILE)))
$(foreach file,$(RESULTS_V),$(eval $(call OPEN_GUI,$(file),V_FILE)))
# Write a def for the corresponding odb
$(foreach file,$(RESULTS_ODB),$(file).def): %.def:
ODB_FILE=$(RESULTS_DIR)/$* DEF_FILE=$(RESULTS_DIR)/$@ $(OPENROAD_CMD) $(SCRIPTS_DIR)/write_def.tcl
#
# Write a verilog for the corresponding odb
$(foreach file,$(RESULTS_ODB),$(file).v): %.v:
ODB_FILE=$(RESULTS_DIR)/$* VERILOG_FILE=$(RESULTS_DIR)/$@ $(OPENROAD_CMD) $(SCRIPTS_DIR)/write_verilog.tcl
# Drop into yosys with all environment variables, useful to for instance
# debug synthesis, or run other commands aftewards, such as "show" to
# generate a .dot file of the design to visualize designs.
.PHONY: yosys
yosys:
$(YOSYS_EXE)
# Drop into a bash shell with all environment variables, useful for debugging
.PHONY: bash
bash:
bash --init-file <(echo "PS1='\[\e[32m\]Makefile Environment \[\e[0m\] \w $ '")
.PHONY: all_defs
all_defs : $(foreach file,$(RESULTS_ODB),$(file).def)
.PHONY: all_verilog
all_verilog : $(foreach file,$(RESULTS_ODB),$(file).v)
.PHONY: handoff
handoff : all_defs all_verilog
.PHONY: test-unset-and-make-%
test-unset-and-make-%: ; $(UNSET_AND_MAKE) $*
.phony: klayout
klayout:
$(SCRIPTS_DIR)/klayout.sh
.phony: run
run:
@mkdir -p $(RESULTS_DIR) $(LOG_DIR) $(REPORTS_DIR) $(OBJECTS_DIR)
$(RUN_CMD) --log $(abspath $(LOG_DIR)/$(RUN_LOG_NAME_STEM).log) --tee -- $(OPENROAD_CMD) -no_splash $(if $(filter %.py,$(RUN_SCRIPT)),-python) $(RUN_SCRIPT)
export RUN_YOSYS_ARGS ?= -c $(SCRIPTS_DIR)/yosys_keep.tcl
.phony: run-yosys
run-yosys:
$(YOSYS_EXE) $(RUN_YOSYS_ARGS)
# Utilities
#-------------------------------------------------------------------------------
include $(UTILS_DIR)/utils.mk
export PRIVATE_DIR ?= ../../private_tool_scripts
-include $(PRIVATE_DIR)/private.mk