Makefile

#
# Copyright 2020 The Project Oak Authors
#
# 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.
#

# This Makefile by default builds all targets that are part of the
# Silver Oak system except documentation and those targets that require the
# invocation of the Xilinx tools for simulation or FPGA implementation.

# Build everything (except Xilinx-specific targets):
# make

# Clean everything:
# make clean

SUBDIRS = third_party cava tests examples silveroak-opentitan \
	  examples/xilinx tests/xilinx demos firmware cava2

.PHONY: all coq minimize-requires clean update-third_party subdirs $(SUBDIRS)

all: subdirs

subdirs: $(SUBDIRS)

$(SUBDIRS):
	$(MAKE) -C $@ $(SUBDIRTARGET)

coq: $(SUBDIRS)

# Call cleanall after updating as the sub modules may not currently exist
update-third_party:
	$(MAKE) -C third_party update
	$(MAKE) cleanall

# special target to make only the core Coq library (old version)
cava-coq : third_party
	$(MAKE) -C cava coq

# special target to make only the core Coq library (new version)
cava2-coq : third_party
	$(MAKE) -C cava2 coq

minimize-requires: $(SUBDIRS)

# clean everything *except for* third_party
clean:
	for dir in $(filter-out third_party,$(SUBDIRS)); do \
		$(MAKE) -C $$dir clean; \
	done
	echo "Note: to clean all dependencies (e.g. after a Coq upgrade) do 'make cleanall'"

# clean everything *including* third_party
cleanall:
	for dir in $(SUBDIRS); do \
		$(MAKE) -C $$dir clean; \
	done

# pass the 'coq' target down to subdirs
coq: SUBDIRTARGET=coq

# pass the 'minimize-requires' target down to subdirs
minimize-requires: SUBDIRTARGET=minimize-requires

# strip off the first subdir name, then call make on that subdir with the specified .vo target
# for example, "make cava/X/Y/Foo.vo" will call "make -C cava X/Y/Foo.vo"
%.vo:
	$(MAKE) -C $(DIR) $(TARGET)

%.vo: DIR=$(firstword $(subst /, , $@))

%.vo: TARGET=$(subst $(DIR)/,,$@)

# cava depends on third_party
cava : third_party

# cava2 depends on cava (for Util)
cava2 : cava

# tests depends on cava
tests: cava

# tests/xilinx depends on tests
tests/xilinx : cava tests

# examples depends on cava
examples : cava

# demos depends on cava
demos : cava

# examples/xilinx depends on examples
examples/xilinx : examples

# silveroak-opentitan depends on:
# cava (for AES and pinmux circuits, only Util for HMAC)
# cava2 (for HMAC circuits)
# firmware (for HMAC software)
silveroak-opentitan : cava cava2 firmware

# firmware depends on cava and cava2
firmware : cava cava2