Skip to content

F
FMC ADC 100M 14b 4cha
Commit 39c6ddbe authored by Federico Vaga's avatar Federico Vaga
Browse files
Options

Merge branch '15-integrare-rest-cheby-file-into-documentation' into 'master' 

Resolve "integrare rest cheby file into documentation"

Closes #15

See merge request be-cem-edl/fec/hardware-modules/fmc-adc-100m14b4cha!4
parents 80df3e5d 86c8bdcc
Hide whitespace changes
Inline Side-by-side
Showing with 36 additions and 42 deletions
.gitignore
View file @ 39c6ddbe
...@@ -76,6 +76,7 @@ hdl/svec/sim/testbench/top/work/ ...@@ -76,6 +76,7 @@ hdl/svec/sim/testbench/top/work/
doc/manual/fmcadc100m14b4cha_gateware_manual.info doc/manual/fmcadc100m14b4cha_gateware_manual.info
doc/manual/fmcadc100m14b4cha_gateware_manual.pdf doc/manual/fmcadc100m14b4cha_gateware_manual.pdf
doc/manual/fmcadc100m14b4cha_gateware_manual.txt doc/manual/fmcadc100m14b4cha_gateware_manual.txt
doc/gateware/regs/*.rst
*.texi *.texi
*.aux *.aux
*.log *.log
......
doc/conf.py
View file @ 39c6ddbe
...@@ -31,8 +31,6 @@ author = 'Matthieu Cattin, Dimitris Lampridis <dimitrios.lampridis@cern.ch>, Fed ...@@ -31,8 +31,6 @@ author = 'Matthieu Cattin, Dimitris Lampridis <dimitrios.lampridis@cern.ch>, Fed
# source_suffix = ['.rst', '.md'] # source_suffix = ['.rst', '.md']
source_suffix = '.rst' source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
...@@ -48,10 +46,13 @@ extensions = ['sphinx.ext.autodoc', ...@@ -48,10 +46,13 @@ extensions = ['sphinx.ext.autodoc',
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
# The root document.
master_doc = 'index'
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path. # This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['build_env', '_build', 'Thumbs.db', '.DS_Store'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
......
doc/gateware/memory-map.rst
View file @ 39c6ddbe
...@@ -9,14 +9,7 @@ The Memory Map ...@@ -9,14 +9,7 @@ The Memory Map
Following the memory map for the part of the ADC design that drives Following the memory map for the part of the ADC design that drives
the FMC ADC 100M modules. the FMC ADC 100M modules.
.. only:: latex .. include:: regs/fmc_adc_mezzanine_mmap.rst
.. warning::
Unfortunatelly we are not able to include the memory map in PDF format.
Please for the memory map refer to the online documentation,
.. raw:: html
:file: regs/fmc_adc_mezzanine_mmap.htm
Supported Designs Supported Designs
================= =================
......
doc/gateware/regs/Makefile
View file @ 39c6ddbe
...@@ -4,32 +4,31 @@ ...@@ -4,32 +4,31 @@
TOP_DIR = ../../.. TOP_DIR = ../../..
HTML := spec_base_regs.htm FILES := spec_base_regs
HTML += svec_base_regs.htm FILES += svec_base_regs
HTML += svec_ref_fmc_adc_100Ms_mmap.htm FILES += svec_ref_fmc_adc_100Ms_mmap
HTML += spec_ref_fmc_adc_100Ms_mmap.htm FILES += spec_ref_fmc_adc_100Ms_mmap
HTML += fmc_adc_mezzanine_mmap.htm FILES += fmc_adc_mezzanine_mmap
all: $(HTML)
.PHONY: clean CHEBY ?= cheby
CHEBY_BUILD=(cd $(dir $<); cheby -i $(notdir $<) --gen-doc --doc html) > $@ all: html rest
fmc_adc_mezzanine_mmap.htm: $(TOP_DIR)/hdl/cheby/fmc_adc_mezzanine_mmap.cheby html : $(addsuffix .htm, $(FILES))
$(CHEBY_BUILD) rest : $(addsuffix .rst, $(FILES))
spec_ref_fmc_adc_100Ms_mmap.htm: $(TOP_DIR)/hdl/cheby/spec_ref_fmc_adc_100Ms_mmap.cheby .PHONY: clean html rest
$(CHEBY_BUILD)
svec_ref_fmc_adc_100Ms_mmap.htm: $(TOP_DIR)/hdl/cheby/svec_ref_fmc_adc_100Ms_mmap.cheby vpath %.cheby $(TOP_DIR)/hdl/cheby/
$(CHEBY_BUILD) vpath %.cheby $(TOP_DIR)/hdl/ip_cores/spec/hdl/rtl/
vpath %.cheby $(TOP_DIR)/hdl/ip_cores/svec/hdl/rtl/
svec_base_regs.htm: $(TOP_DIR)/hdl/ip_cores/svec/hdl/rtl/svec_base_regs.cheby %.htm: %.cheby
$(CHEBY_BUILD) $(CHEBY) -i $< --gen-doc --doc html > $@
spec_base_regs.htm: $(TOP_DIR)/hdl/ip_cores/spec/hdl/rtl/spec_base_regs.cheby %.rst: %.cheby
$(CHEBY_BUILD) $(CHEBY) -i $< --gen-doc --doc rest > $@
clean: clean:
@rm -f *.md *.rst *.htm @rm -f *.md *.rst *.htm
doc/gateware/spec_ref_fmc_adc_100M.rst
View file @ 39c6ddbe
...@@ -12,11 +12,9 @@ designs, and the `FMC-ADC-100M`_ part specific to the FMC-ADC-100M mezzanine. ...@@ -12,11 +12,9 @@ designs, and the `FMC-ADC-100M`_ part specific to the FMC-ADC-100M mezzanine.
Carrier Carrier
======= =======
.. raw:: html .. include:: regs/spec_base_regs.rst
:file: regs/spec_base_regs.htm
FMC-ADC-100M FMC-ADC-100M
============ ============
.. raw:: html .. include:: regs/spec_ref_fmc_adc_100Ms_mmap.rst
:file: regs/spec_ref_fmc_adc_100Ms_mmap.htm
doc/gateware/svec_ref_fmc_adc_100M.rst
View file @ 39c6ddbe
...@@ -12,11 +12,9 @@ designs, and the `FMC-ADC-100M`_ part specific to the FMC-ADC-100M mezzanine. ...@@ -12,11 +12,9 @@ designs, and the `FMC-ADC-100M`_ part specific to the FMC-ADC-100M mezzanine.
Carrier Carrier
======= =======
.. raw:: html .. include:: regs/svec_base_regs.rst
:file: regs/svec_base_regs.htm
FMC-ADC-100M FMC-ADC-100M
============ ============
.. raw:: html .. include:: regs/svec_ref_fmc_adc_100Ms_mmap.rst
:file: regs/svec_ref_fmc_adc_100Ms_mmap.htm
hdl/cheby/Makefile
View file @ 39c6ddbe
...@@ -7,12 +7,14 @@ SIM =../testbench/include ...@@ -7,12 +7,14 @@ SIM =../testbench/include
SOURCES = $(wildcard *.cheby) SOURCES = $(wildcard *.cheby)
TARGETS = $(SOURCES:.cheby=.vhd) TARGETS = $(SOURCES:.cheby=.vhd)
CHEBY ?= cheby
all: $(TARGETS) all: $(TARGETS)
.PHONY: $(TARGETS) .PHONY: $(TARGETS)
$(TARGETS): %.vhd : %.cheby $(TARGETS): %.vhd : %.cheby
@echo -e "\n\033[34m\033[1m-> Processing file $<\033[0m" @echo -e "\n\033[34m\033[1m-> Processing file $<\033[0m"
cheby -i $< --gen-hdl=$@ $(CHEBY) -i $< --gen-hdl=$@
cheby -i $< --gen-consts=$(SIM)/$(@:.vhd=.v) $(CHEBY) -i $< --gen-consts=$(SIM)/$(@:.vhd=.v)
cheby -i $< --gen-c=../../software/include/hw/$(<:.cheby=.h) $(CHEBY) -i $< --gen-c=../../software/include/hw/$(<:.cheby=.h)
hdl/top/svec_ref_design/Makefile
View file @ 39c6ddbe
...@@ -9,14 +9,16 @@ SW =../../../software/include/hw ...@@ -9,14 +9,16 @@ SW =../../../software/include/hw
SOURCES = $(wildcard *.cheby) SOURCES = $(wildcard *.cheby)
TARGETS = $(SOURCES:.cheby=.vhd) TARGETS = $(SOURCES:.cheby=.vhd)
CHEBY ?= cheby
all: $(TARGETS) all: $(TARGETS)
.PHONY: $(TARGETS) .PHONY: $(TARGETS)
$(TARGETS): %.vhd : %.cheby $(TARGETS): %.vhd : %.cheby
@echo "\n\033[34m\033[1m-> Processing file $<\033[0m" @echo "\n\033[34m\033[1m-> Processing file $<\033[0m"
@cheby -i $< --gen-hdl=$@ @$(CHEBY) -i $< --gen-hdl=$@
@cheby -i $< \ @$(CHEBY) -i $< \
--gen-doc=$(DOC)/$(@:.vhd=.html) \ --gen-doc=$(DOC)/$(@:.vhd=.html) \
--gen-consts=$(SIM)/$(@:.vhd=.v) \ --gen-consts=$(SIM)/$(@:.vhd=.v) \
--gen-c=$(SW)/$(@:.vhd=.h) --gen-c=$(SW)/$(@:.vhd=.h)
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