doc: move wbgen-generated doc into documentation

352c764f · Dimitris Lampridis · 3eb377d1 · 352c764f · 352c764f · 352c764f
Commit 352c764f authored Jun 01, 2018 by Dimitris Lampridis
8 changed files
--- a/doc/.gitignore
+++ b/doc/.gitignore
 _*
 doxygen-trtl-output/
+registers/wbgen/
 .doxystamp
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -14,6 +14,19 @@ help:

 .PHONY: help doxygen

+# Rebuild documentation from wbgen if necessary
+WBGENDEST    = registers/wbgen
+WBGENLIST    = mt_cpu_csr mt_cpu_lr
+WBGENTARGETS = $(foreach item, $(WBGENLIST), $(WBGENDEST)/$(item).tex $(WBGENDEST)/$(item).html)
+TRTL_HDL     = ../hdl/rtl/
+WBGEN2      ?= wbgen2
+
+$(WBGENDEST)/%.tex: $(TRTL_HDL)/cpu/%.wb
+	@$(WBGEN2) -f latex -D $@ $<
+
+$(WBGENDEST)/%.html: $(TRTL_HDL)/cpu/%.wb
+	@$(WBGEN2) -f html -D $@ $<
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %:
@@ -24,9 +37,10 @@ GIT_VERSION = $(shell git describe --dirty --long --tags)

 doxygen:
 ifeq ($(TARGET),clean)
-	@echo "Remove Doxygen files"
-	@rm -rf doxygen-trtl-output .doxystamp
+	@rm -rf $(WBGENDEST) doxygen-trtl-output .doxystamp
 else
+	@mkdir -p $(WBGENDEST)
+	$(MAKE) $(WBGENTARGETS)
 	$(MAKE) .doxystamp
 endif


--- a/doc/conf.py
+++ b/doc/conf.py
@@ -128,7 +128,7 @@ htmlhelp_basename = 'MockTurtledoc'
 latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
-    # 'papersize': 'letterpaper',
+    'papersize': 'a4paper',

    # The font size ('10pt', '11pt' or '12pt').
    #
@@ -141,6 +141,8 @@ latex_elements = {
    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
+
+    'passoptionstopackages': '\\PassOptionsToPackage{dvipsnames,table}{xcolor}',
 }

 # Grouping the document tree into LaTeX files. List of tuples

--- a/doc/index.rst
+++ b/doc/index.rst
@@ -16,6 +16,7 @@ Welcome to Mock Turtle's documentation!
   software/index
   tools/index
   demos/index
+   registers/index
   glossary

 Indices and tables
@@ -24,3 +25,6 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+* :ref:`wbgen_csr`
+* :ref:`wbgen_lr`
+
--- a/doc/registers/index.rst
+++ b/doc/registers/index.rst
+.. highlight:: none
+
+===============
+Register Tables
+===============
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   wbgen_csr
+   wbgen_lr
--- a/doc/registers/wbgen_csr.rst
+++ b/doc/registers/wbgen_csr.rst
+.. _wbgen_csr:
+
+Control/Status Registers (CSR)
+==============================
+
+This is a list of all the control and status registers, which are accessible from the Host. There is
+one CSR for the whole MT.
+
+.. raw:: html
+  :file: wbgen/mt_cpu_csr.html
+
+.. raw:: latex
+  :file: wbgen/mt_cpu_csr.tex
--- a/doc/registers/wbgen_lr.rst
+++ b/doc/registers/wbgen_lr.rst
+.. _wbgen_lr:
+
+Local Registers (LR)
+====================
+
+This is a list of all the local registers, which are accessible from the soft-CPUs. Each soft CPU
+has its own copy of the LR.
+
+.. raw:: html
+  :file: wbgen/mt_cpu_lr.html
+
+.. raw:: latex
+  :file: wbgen/mt_cpu_lr.tex
--- a/hdl/rtl/cpu/build_wb.sh
+++ b/hdl/rtl/cpu/build_wb.sh
 #!/bin/bash

 mkdir -p doc
-wbgen2 -D ./doc/mt_cpu_csr.html -V mt_cpu_csr_wb.vhd -p mt_cpu_csr_wbgen2_pkg.vhd --hstyle record -Z --lang vhdl -K ../../testbench/include/regs/mt_cpu_csr_regs.vh mt_cpu_csr.wb
-wbgen2 -D ./doc/mt_cpu_lr.html  -V mt_cpu_lr_wb.vhd  -p mt_cpu_lr_wbgen2_pkg.vhd  --hstyle record -Z --lang vhdl -K ../../testbench/include/regs/mt_cpu_lr_regs.vh  mt_cpu_lr.wb
+wbgen2 -V mt_cpu_csr_wb.vhd -p mt_cpu_csr_wbgen2_pkg.vhd --hstyle record -Z --lang vhdl -K ../../testbench/include/regs/mt_cpu_csr_regs.vh mt_cpu_csr.wb
+wbgen2 -V mt_cpu_lr_wb.vhd  -p mt_cpu_lr_wbgen2_pkg.vhd  --hstyle record -Z --lang vhdl -K ../../testbench/include/regs/mt_cpu_lr_regs.vh  mt_cpu_lr.wb