Skip to content

S
Simple PCIe FMC carrier SPEC
Commit db407941 authored by Federico Vaga's avatar Federico Vaga
Browse files
Options

doc: add spec-base memory map to documentation 

Signed-off-by: Federico Vaga's avatarFederico Vaga <federico.vaga@cern.ch>
parent 0b3d30e6
Hide whitespace changes
Inline Side-by-side
Showing with 22 additions and 3 deletions
doc/.gitignore
View file @ db407941
......@@ -3,3 +3,4 @@
# SPDX-License-Identifier: CC0-1.0
_build/
spec_base_regs.rst
doc/Makefile
View file @ db407941
......@@ -11,13 +11,26 @@ SPHINXBUILD = sphinx-build
SOURCEDIR = .
BUILDDIR = _build
CHEBY ?= cheby
CHEBY_FILES := spec_base_regs.cheby
CHEBY_DOC_FILES := $(CHEBY_FILES:.cheby=.rst)
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
.PHONY: clean help cheby_doc
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
%: cheby_doc
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
vpath %.cheby ../hdl/rtl
cheby_doc: $(CHEBY_DOC_FILES)
$(CHEBY_DOC_FILES): %.rst: %.cheby
$(CHEBY) -i $< --gen-doc --doc rest > $@
clean:
@rm -f $(CHEBY_DOC_FILES)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
doc/hdl-spec-base.rst
View file @ db407941
......@@ -112,6 +112,11 @@ These are the fixed fields in the current (|version|) release.
0x00000030 128 Vendor UUID 0x00000000
========== ========== ================== ============
Memory Map
----------
.. include:: spec_base_regs.rst
.. _`SPEC project`: https://ohwr.org/project/spec
.. _`FPGA device identification`: https://www.ohwr.org/project/fpga-dev-id/
.. _`general cores`: https://www.ohwr.org/projects/general-cores
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment