# Makefile for RISC-V ISA Manuals
#
# This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
# International License. To view a copy of this license, visit
# http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to
# Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
#
# SPDX-License-Identifier: CC-BY-SA-4.0
#
# Description:
# 
# This Makefile is designed to automate the process of building and packaging 
# the documentation for RISC-V ISA Manuals. It supports multiple build targets 
# for generating documentation in various formats (PDF, HTML).

DOCKER_RUN := docker run --rm -v ${PWD}/..:/build -w /build \
riscvintl/riscv-docs-base-container-image:latest

HEADER_SOURCE := riscv-debug-header.adoc
PDF_RESULT := ./build/riscv-debug-specification.pdf
REGISTERS_ADOC = jtag_registers.adoc
REGISTERS_ADOC += core_registers.adoc
REGISTERS_ADOC += hwbp_registers.adoc
REGISTERS_ADOC += dm_registers.adoc
REGISTERS_ADOC += sample_registers.adoc
REGISTERS_ADOC += abstract_commands.adoc
REGISTERS_ADOC += sw_registers.adoc
REGISTERS_PY = ../registers.py

REGISTERS_CHISEL += dm_registers.scala
REGISTERS_CHISEL += abstract_commands.scala

ASCIIDOCTOR_PDF := asciidoctor-pdf
OPTIONS := --trace \
           -a compress \
           -a mathematical-format=svg \
           -a pdf-fontsdir=docs-resources/fonts \
           -a pdf-theme=docs-resources/themes/riscv-pdf.yml \
           --failure-level=ERROR
REQUIRES := --require=asciidoctor-diagram \
            --require=asciidoctor-mathematical

.PHONY: all build clean build-container build-no-container

all: build

build: 
	@echo "Checking if Docker is available..."
	@if command -v docker >/dev/null 2>&1 ; then \
		echo "Docker is available, building inside Docker container..."; \
		$(MAKE) build-container; \
	else \
		echo "Docker is not available, building without Docker..."; \
		$(MAKE) build-no-container; \
	fi

build-container:	build-registers
	@echo "Starting build inside Docker container..."
	$(DOCKER_RUN) /bin/sh -c "$(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) --out-file=$(PDF_RESULT) $(HEADER_SOURCE)"
	@echo "Build completed successfully inside Docker container."

build-no-container:	build-registers
	@echo "Starting build..."
	$(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) --out-file=$(PDF_RESULT) $(HEADER_SOURCE)
	@echo "Build completed successfully."

build-registers:	$(REGISTERS_ADOC)

%.adoc:	../xml/%.xml $(REGISTERS_PY)
	../registers.py --adoc $@ --adoc-definitions $(patsubst %.adoc,%-def.adoc,$@) $<

debug_defines: debug_defines.h debug_defines.c $(patsubst %,../xml/%,$(REGISTERS_ADOC:.adoc=.xml)) ../registers.py
	../registers.py $@ --cgetters $(filter %.xml, $^)

debug_defines.%:
	echo "/*" > $@
	echo " * This file is auto-generated by running 'make debug_defines' in" >> $@
	echo " * https://github.com/riscv/riscv-debug-spec/ (`git describe --always --dirty --exclude '*'`)" >> $@
	echo " */" >> $@
	echo >> $@

%.scala: ../xml/%.xml ../registers.py
	../registers.py --chisel $(basename $@).scala $< > /dev/null

chisel: $(REGISTERS_CHISEL)

clean:
	@echo "Cleaning up generated files..."
	rm -f $(PDF_RESULT) $(REGISTERS_ADOC)
	@echo "Cleanup completed."
