pax_global_header 0000666 0000000 0000000 00000000064 13505137667 0014527 g ustar 00root root 0000000 0000000 52 comment=a5459794179fbfdc961d1b965e98e28bbf716e39
wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/ 0000775 0000000 0000000 00000000000 13505137667 0017503 5 ustar 00root root 0000000 0000000 wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/.gitmodules 0000664 0000000 0000000 00000002344 13505137667 0021663 0 ustar 00root root 0000000 0000000 [submodule "dependencies/mock-turtle"]
path = dependencies/mock-turtle
url = https://ohwr.org/project/mock-turtle.git
[submodule "dependencies/fine-delay"]
path = dependencies/fmc-delay-1ns-8cha
url = https://ohwr.org/project/fmc-delay-1ns-8cha.git
[submodule "dependencies/fmc-tdc"]
path = dependencies/fmc-tdc-1ns-5cha-gw
url = https://ohwr.org/project/fmc-tdc-1ns-5cha-gw.git
[submodule "dependencies/vme64x-core"]
path = dependencies/vme64x-core
url = https://ohwr.org/project/vme64x-core.git
[submodule "dependencies/general-cores"]
path = dependencies/general-cores
url = https://ohwr.org/project/general-cores.git
[submodule "dependencies/wr-cores"]
path = dependencies/wr-cores
url = https://ohwr.org/project/wr-cores.git
[submodule "dependencies/urv-core"]
path = dependencies/urv-core
url = https://ohwr.org/project/urv-core.git
[submodule "dependencies/fmc-adc-100m14b4cha-gw"]
path = dependencies/fmc-adc-100m14b4cha-gw
url = https://ohwr.org/project/fmc-adc-100m14b4cha-gw.git
[submodule "dependencies/ddr3-sp6-core"]
path = dependencies/ddr3-sp6-core
url = https://ohwr.org/project/ddr3-sp6-core.git
[submodule "dependencies/gn4124-core"]
path = dependencies/gn4124-core
url = https://ohwr.org/project/gn4124-core.git
wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/.readthedocs.yaml 0000664 0000000 0000000 00000001227 13505137667 0022734 0 ustar 00root root 0000000 0000000 # .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: doc/conf.py
# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml
# Optionally build your docs in additional formats such as PDF and ePub
formats:
- pdf
# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: doc/requirements.txt
# Exclude all submodules, they are not needed for documentation
submodules:
exclude: all
wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/CHANGELOG.md 0000664 0000000 0000000 00000000731 13505137667 0021315 0 ustar 00root root 0000000 0000000 # Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [1.0.0] - 2019-xx-yy
### Added
- First release of WRTD.
[Unreleased]: https://www.ohwr.org/project/wrtd/compare/libwrtd-v1.0.0...master
[1.0.0]: https://www.ohwr.org/project/wrtd/tags/libwrtd-v1.0.0
wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/LICENSE 0000664 0000000 0000000 00000016744 13505137667 0020524 0 ustar 00root root 0000000 0000000 GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/README.md 0000664 0000000 0000000 00000000600 13505137667 0020756 0 ustar 00root root 0000000 0000000 # White Rabbit Trigger Distribution - WRTD
The aim of the project is to provide a system that is able to receive triggers
from some external source and distribute these triggers to remote nodes over
the White Rabbit network.
For more information, check out the project [Wiki](https://ohwr.org/project/wrtd/wikis/Home) and the available [Documentation](https://wrtd.readthedocs.io).
wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/dependencies/ 0000775 0000000 0000000 00000000000 13505137667 0022131 5 ustar 00root root 0000000 0000000 wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/dependencies/ddr3-sp6-core/ 0000775 0000000 0000000 00000000000 13505137667 0024421 5 ustar 00root root 0000000 0000000 wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/dependencies/fmc-adc-100m14b4cha-gw/ 0000775 0000000 0000000 00000000000 13505137667 0025560 5 ustar 00root root 0000000 0000000 wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/dependencies/fmc-delay-1ns-8cha/ 0000775 0000000 0000000 00000000000 13505137667 0025312 5 ustar 00root root 0000000 0000000 wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/dependencies/fmc-tdc-1ns-5cha-gw/ 0000775 0000000 0000000 00000000000 13505137667 0025376 5 ustar 00root root 0000000 0000000 wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/dependencies/general-cores/ 0000775 0000000 0000000 00000000000 13505137667 0024657 5 ustar 00root root 0000000 0000000 wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/dependencies/gn4124-core/ 0000775 0000000 0000000 00000000000 13505137667 0023776 5 ustar 00root root 0000000 0000000 wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/dependencies/mock-turtle/ 0000775 0000000 0000000 00000000000 13505137667 0024377 5 ustar 00root root 0000000 0000000 wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/dependencies/urv-core/ 0000775 0000000 0000000 00000000000 13505137667 0023673 5 ustar 00root root 0000000 0000000 wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/dependencies/vme64x-core/ 0000775 0000000 0000000 00000000000 13505137667 0024210 5 ustar 00root root 0000000 0000000 wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/dependencies/wr-cores/ 0000775 0000000 0000000 00000000000 13505137667 0023672 5 ustar 00root root 0000000 0000000 wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/doc/ 0000775 0000000 0000000 00000000000 13505137667 0020250 5 ustar 00root root 0000000 0000000 wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/doc/.gitignore 0000664 0000000 0000000 00000000067 13505137667 0022243 0 ustar 00root root 0000000 0000000 doxygen-wrtd-output/
*.log
_build
build_env
.doxystamp
wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/doc/Makefile 0000664 0000000 0000000 00000002300 13505137667 0021703 0 ustar 00root root 0000000 0000000 # Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = wrtd
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help doxygen Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
$(MAKE) doxygen TARGET=$@
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
GIT_VERSION = $(shell git describe --always --dirty --long --tags)
doxygen:
ifeq ($(TARGET),clean)
@rm -rf _build doxygen-wrtd-output .doxystamp
else
$(MAKE) .doxystamp
endif
# List of Doxygen folders to consider
DOXINPUT := ../software/lib
DOXINPUT += ../software/include
DOXINPUT += ../software/firmware/common
DOXEXCL := ""
# List of actual Doxygen source files
DOXSRC = $(shell find $(DOXINPUT) -type f -name '*.[chS]')
.doxystamp: $(DOXSRC)
GIT_VERSION=$(GIT_VERSION) DOXINPUT="$(DOXINPUT)" DOXEXCL="$(DOXEXCL)" doxygen ./doxygen-wrtd-config
@touch .doxystamp
wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/doc/conf.py 0000664 0000000 0000000 00000024521 13505137667 0021553 0 ustar 00root root 0000000 0000000 # -*- coding: utf-8 -*-
#
# White Rabbit Trigger Distribution documentation build configuration file, created by
# sphinx-quickstart on Fri Jan 25 09:42:58 2019.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx.ext.graphviz',
'sphinx.ext.coverage',
'breathe',
]
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown',
}
# The encoding of source files.
#
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'White Rabbit Trigger Distribution'
copyright = u'2019, CERN'
author = u'Dimitris Lampridis v documentation" by default.
#
# html_title = u'White Rabbit Trigger Distribution v1.0'
# A shorter title for the navigation bar. Default is the same as html_title.
#
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
#html_logo = 'graphics/CERN-logo_outline-small.jpg'
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#
# html_extra_path = []
# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
# html_last_updated_fmt = None
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#
# html_additional_pages = {}
# If false, no module index is generated.
#
# html_domain_indices = True
# If false, no index is generated.
#
# html_use_index = True
# If true, the index is split into individual pages for each letter.
#
# html_split_index = False
# If true, links to the reST sources are added to the pages.
#
html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#
html_show_sphinx = False
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
#
# html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
#
# html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#
# html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'WhiteRabbitTriggerDistributiondoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
'papersize': 'a4paper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'WhiteRabbitTriggerDistribution.tex', u'White Rabbit Trigger Distribution Documentation',
u'Dimitris Lampridis', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
#latex_logo = 'graphics/CERN-logo_outline-small.jpg'
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#
# latex_use_parts = False
# If true, show page references after internal links.
#
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
#
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
#
# latex_appendices = []
# It false, will not define \strong, \code, itleref, \crossref ... but only
# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
# packages.
#
# latex_keep_old_macro_names = True
# If false, no module index is generated.
#
# latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'whiterabbittriggerdistribution', u'White Rabbit Trigger Distribution Documentation',
[author], 1)
]
# If true, show URL addresses after external links.
#
# man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'WhiteRabbitTriggerDistribution', u'White Rabbit Trigger Distribution Documentation',
author, 'WhiteRabbitTriggerDistribution', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#
# texinfo_appendices = []
# If false, no module index is generated.
#
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#
# texinfo_no_detailmenu = False
breathe_projects = {
"wrtd": "doxygen-wrtd-output/xml/",
}
breathe_default_project = "wrtd"
# This is necessary to run doxygen on ReadTheDocs
import subprocess, os
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
if read_the_docs_build:
subprocess.call('make doxygen', shell=True)
numfig = True
wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/doc/doxygen-wrtd-config 0000664 0000000 0000000 00000001123 13505137667 0024066 0 ustar 00root root 0000000 0000000 PROJECT_NAME = "White Rabbit Trigger Distribution"
PROJECT_NUMBER = $(GIT_VERSION)
PROJECT_BRIEF = "WRTD"
PROJECT_LOGO =
OUTPUT_DIRECTORY = doxygen-wrtd-output
CREATE_SUBDIRS = YES
TAB_SIZE = 8
OPTIMIZE_OUTPUT_FOR_C = YES
EXTRACT_STATIC = YES
CASE_SENSE_NAMES = YES
WARN_NO_PARAMDOC = YES
WARN_IF_UNDOCUMENTED = NO
INPUT = $(DOXINPUT)
RECURSIVE = YES
EXCLUDE = $(DOXEXCL)
GENERATE_HTML = YES
GENERATE_LATEX = NO
GENERATE_XML = YES
wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/doc/graphics/ 0000775 0000000 0000000 00000000000 13505137667 0022050 5 ustar 00root root 0000000 0000000 wrtd-a5459794179fbfdc961d1b965e98e28bbf716e39/doc/graphics/CERN-logo_outline-small.jpg 0000664 0000000 0000000 00000025013 13505137667 0027105 0 ustar 00root root 0000000 0000000 JFIF Ducky <