Skip to content

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

Merge branch 'release/v5.0.0.rc9' into master

parents bdfff5dd 86613661
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 29232 additions and 50252 deletions
.gitignore
View file @ 7cc993f1
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# SPDX-License-Identifier: CC0-1.0
hdl/ip_cores/.lso
hdl/ip_cores/_xmsgs
hdl/*/sim/*/transcript
......@@ -106,3 +110,5 @@ TAGS*
GTAGS
GPATH
GRTAGS
.clangd
compile_commands.json
\ No newline at end of file
.gitlab-ci.yml 0 → 100644
View file @ 7cc993f1
# SPDX-FileCopyrightText: 2019 CERN
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# SPDX-License-Identifier: CC0-1.0
---
variables:
KOJI_TARGET: 'ohwr7'
KOJI_DISTTAG: '.el7.cern'
DIST_PATH: distribution
BUILD_PATH: distribution/build
stages:
- static-analysis
- build
- dkms
- srpm
- kscratch
- kbuild
reuse:
stage: static-analysis
image:
name: fsfe/reuse:latest
entrypoint: [""]
script:
- reuse lint
cppcheck:
stage: static-analysis
script:
- yum install -y cppcheck
- make -C software cppcheck
build:
stage: build
script:
- yum install -y kernel-devel
- LINUX=/usr/src/kernels/*/ make -C software
build_dkms_rpm:
stage: dkms
script:
- yum install -y dkms
- make -C distribution dkms-rpm
build_srpm:
stage: srpm
script:
- yum-builddep -y ${DIST_PATH}/*.spec
- LINUX=/usr/src/kernels/*/ make -C distribution srpm
artifacts:
paths:
- distribution/build/SRPMS/${CI_PROJECT_NAME}*src.rpm
expire_in: 1 day
.koji_deps_template: &koji_deps
before_script:
- yum install -y koji krb5-workstation rpm-build
- echo ${OHWR_PASSWORD} | kinit ${OHWR_USER}
kscratch:
<<: *koji_deps
stage: kscratch
script:
- koji --config=.koji build --wait --scratch ${KOJI_TARGET} distribution/build/SRPMS/${CI_PROJECT_NAME}*src.rpm
kbuild-ohwr:
<<: *koji_deps
stage: kbuild
only:
- tags
script:
- koji --config=.koji build --wait ${KOJI_TARGET} distribution/build/SRPMS/${CI_PROJECT_NAME}*src.rpm
.gitmodules
View file @ 7cc993f1
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# SPDX-License-Identifier: CC0-1.0
[submodule "hdl/ip_cores/general-cores"]
path = hdl/ip_cores/general-cores
url = https://ohwr.org/project/general-cores.git
......
.reuse/dep5 0 → 100644
View file @ 7cc993f1
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: fmc-adc-100m14b4ch
Upstream-Contact: Federico Vaga <federico.vaga@cern.ch>
Source: https://ohwr.org/project/fmc-adc-100m14b4cha
Files: doc/img/* doc/fig/*
Copyright: 2020 CERN (home.cern)
License: CC-BY-SA-4.0
Files: doc/requirements.txt
Copyright: 2020 CERN (home.cern)
License: CC0-1.0
CHANGELOG.rst 0 → 100644
View file @ 7cc993f1
..
SPDX-FileCopyrightText: 2020 CERN (home.cern)
SPDX-License-Identifier: CC0-1.0
=========
Changelog
=========
5.0.0 - 2020-01-01
==================
Changes
-------
- channel sysfs attribute 'chx-offset' does not accept mV (milli-volts) values
anymore. Now the unit is uV (micro-Volts)
- acquisition sysfs attribute 'decimation' is now named 'undersample'
- software trigger is enable by default
- on DAC offset saturation set the maximum/minimum value instead of error
- the software trigger is not anymore a ZIO attribute. It is now in debugfs
Added
-----
- multiple trigger sources at the same time
- trigger threshold per-channel
- channel sysfs attributes to set trigger threshold
- sysfs binary attribute to overwrite run-time calibration data
- add tool to get/set run-time calibration data
- periodically update gain calibration for DAC and ADC
- trigger time
Removed
-------
- library is not supported anymore, use adc-lib (https://www.ohwr.org/projects/adc-lib)
- fald-acq tool is not supported anymore, use adc-acq from adc-lib (https://www.ohwr.org/projects/adc-lib)
LICENSES/CC-BY-SA-4.0.txt 0 → 100644
View file @ 7cc993f1
This diff is collapsed.
LICENSES/CC0-1.0.txt 0 → 100644
View file @ 7cc993f1
Creative Commons Legal Code
CC0 1.0 Universal
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.
Statement of Purpose
The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").
Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.
For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.
1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:
i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.
2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.
3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.
4. Limitations and Disclaimers.
a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.
LICENSES/CERN-OHL-W-2.0+.txt 0 → 120000
View file @ 7cc993f1
CERN-OHL-W-2.0.txt
\ No newline at end of file
LICENSES/CERN-OHL-W-2.0.txt 0 → 100644
View file @ 7cc993f1
This diff is collapsed.
Manifest.py
View file @ 7cc993f1
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# SPDX-License-Identifier: CC0-1.0
modules = {
"local" : [
"hdl/rtl",
......
distribution/.gitignore
View file @ 7cc993f1
build/
\ No newline at end of file
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# SPDX-License-Identifier: CC0-1.0
build/
sources/
\ No newline at end of file
distribution/Makefile
View file @ 7cc993f1
TOP_DIR ?= ..
DRIVER_NAME := fmc-adc-100m14b4ch
VERSION := $(shell git describe --abbrev=0)
DIR_NAME := $(DRIVER_NAME)-$(VERSION)
# Copyright (C) 2020 CERN
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# SPDX-License-Identifier: CC0-1.0
TOP_DIR ?= $(shell pwd)/../
NAME := fmc-adc-100m14b4ch
VERSION := $(shell git describe --abbrev=0 | tr -d 'v')
DIR_NAME := $(NAME)-$(VERSION)
KEEP_TEMP ?= n
BUILD ?= $(abspath build)
SOURCES ?= $(abspath sources)
PKG_SOURCES := $(SOURCES)/$(DIR_NAME)
BUILD_DKMS := $(BUILD)/dkms
BUILD_DKMSSOURCE := $(BUILD_DKMS)/source
BUILD_DKMSTREE := $(BUILD_DKMS)/tree
RPM_SPEC := $(shell mktemp /tmp/$(NAME)-$(VERSION)-XXXXXX.spec)
DKMS_OPT := --dkmstree $(BUILD_DKMSTREE) -m $(DRIVER_NAME)/$(VERSION)
DKMS_OPT := --dkmstree $(BUILD_DKMSTREE) -m $(NAME)/$(VERSION)
FIND_OPT := -type f -regextype posix-extended
all: kernel
......@@ -19,16 +29,8 @@ dkms-tree:
@mkdir -p $(BUILD_DKMSSOURCE)
@mkdir -p $(BUILD_DKMSTREE)
dkms-src: dkms-tree
$(eval $@_dir := $(BUILD_DKMSSOURCE)/$(DRIVER_NAME)-$(VERSION))
$(eval $@_src := $(shell git ls-tree -r --name-only HEAD $(TOP_DIR)/software/kernel/))
@mkdir -p $($@_dir)
@cp $(TOP_DIR)/distribution/dkms.conf $($@_dir)
@cp $(TOP_DIR)/distribution/fmc-adc-100m14b4ch-dkms-mkrpm.spec $($@_dir)
@cp $($@_src) $($@_dir)
@cp $(TOP_DIR)/LICENSES/GPL-2.0-or-later.txt $($@_dir)/LICENSE
@sed -r -i -e "s/^GIT_VERSION\s=\s.*/GIT_VERSION = $(VERSION)/" $($@_dir)/Makefile
@sed -r -i -e "s/@PKGVER@/$(VERSION)/g" -e "s/@PKGNAME@/$(DRIVER_NAME)/g" $($@_dir)/dkms.conf
dkms-src: dkms-tree sources-build
@cp -a $(PKG_SOURCES) $(BUILD_DKMSSOURCE)
dkms-add: dkms-src
@dkms add $(DKMS_OPT) --sourcetree $(BUILD_DKMSSOURCE)
......@@ -39,7 +41,53 @@ dkms-tar: dkms-add
dkms-rpm: dkms-add
@dkms mkrpm $(DKMS_OPT) --source-only
dkms-build: dkms-add
@dkms build $(DKMS_OPT)
sources-build:
@mkdir -p $(PKG_SOURCES)
@find $(TOP_DIR)/software/kernel $(FIND_OPT) -regex '.+/([^.]+[.](c|h)|Makefile|Kbuild)' -exec cp \{} $(PKG_SOURCES) \;
@mkdir -p $(PKG_SOURCES)/platform_data
@cp $(TOP_DIR)/software/kernel/platform_data/* $(PKG_SOURCES)/platform_data/
@cp $(TOP_DIR)/software/kernel/fmc-adc-100m14b4cha.h $(PKG_SOURCES)/
@cp $(TOP_DIR)/LICENSES/GPL-2.0-or-later.txt $(PKG_SOURCES)/LICENSE
@cp -a $(TOP_DIR)/CHANGELOG.rst $(PKG_SOURCES)/CHANGELOG.rst
@cp -a $(TOP_DIR)/distribution/dkms.conf $(PKG_SOURCES)/
@sed -r -i -e "s/^GIT_VERSION\s=\s.*/GIT_VERSION = $(VERSION)/" $(PKG_SOURCES)/Makefile
@sed -r -i -e "s/@PKGVER@/$(VERSION)/g" -e "s/@PKGNAME@/$(NAME)/g" $(PKG_SOURCES)/dkms.conf
sources-tar: sources-build
cd $(SOURCES); tar czf $(DIR_NAME).tar.gz --exclude-vcs $(DIR_NAME)
sources: sources-tar
srpm-changelog: sources
$(eval $@_pattern := ^([0-9]+\.[0-9]+\.[0-9]+)\s-\s([0-9]{4}-[0-9]{2}-[0-9]{2})$)
$(eval $@_replace := echo -e "\n"\\* `date --date="\2" "+%a %b %d %Y"` "\1")
@cp -a $(PKG_SOURCES)/CHANGELOG.rst $(SOURCES)/CHANGELOG
@sed -r -i -e "/^[.]{2}/d" -e "/^\s{2}.*$$/d" $(SOURCES)/CHANGELOG
@sed -r -i -e "/Changelog/d" -e "/^(=|-|\s)*$$/d" $(SOURCES)/CHANGELOG
@sed -r -i -e 's,$($@_pattern),$($@_replace),e' $(SOURCES)/CHANGELOG
rpm-spec: fmc-adc-100m14b4ch.spec
# The fmc-adc-100m14b4ch.spec file is good when we can define
# variables. With tools like koji it is not possible, so we need to
# create a .spec file without using package-specific variables.
@cp $< $(RPM_SPEC)
@sed -i -e "s/%{?_build_version}/$(VERSION)/" $(RPM_SPEC)
srpm: sources rpm-spec srpm-changelog
@rpmbuild -bs --define "_topdir $(BUILD)" \
--define '_sourcedir $(SOURCES)' \
--define "_build_version $(VERSION)" \
$(RPM_SPEC)
ifeq ($(KEEP_TEMP), n)
@rm -f $(RPM_SPEC)
endif
clean:
@rm -rf $(BUILD)
@rm -rf $(BUILD) $(SOURCES) *.tar.gz $(RPM_SPEC)
.PHONY: sources sources-tar sources-build
.PHONY: dkmstree dkms-add kernel-dkms-tar
distribution/dkms.conf
View file @ 7cc993f1
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# SPDX-License-Identifier: CC0-1.0
PACKAGE_NAME="@PKGNAME@"
PACKAGE_VERSION="@PKGVER@"
CLEAN="make KVERSION=$kernelver DKMSTREE=$dkms_tree DKMS=1 clean"
......
distribution/fmc-adc-100m14b4ch-dkms-mkrpm.spec deleted 100644 → 0
View file @ bdfff5dd
# Mainline copied from the template, added requirements
%{?!module_name: %{error: You did not specify a module name (%%module_name)}}
%{?!version: %{error: You did not specify a module version (%%version)}}
%{?!kernel_versions: %{error: You did not specify kernel versions (%%kernel_version)}}
%{?!packager: %define packager DKMS <dkms-devel@lists.us.dell.com>}
%{?!license: %define license Unknown}
%{?!_dkmsdir: %define _dkmsdir /var/lib/dkms}
%{?!_srcdir: %define _srcdir %_prefix/src}
%{?!_datarootdir: %define _datarootdir %{_datadir}}
Summary: %{module_name} %{version} dkms package
Name: %{module_name}
Version: %{version}
License: %license
Release: 1dkms
BuildArch: noarch
Group: System/Kernel
Requires: dkms >= 1.95, zio >= 1.4
BuildRequires: dkms
BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root/
%description
Kernel modules for %{module_name} %{version} in a DKMS wrapper.
%prep
if [ "%mktarball_line" != "none" ]; then
/usr/sbin/dkms mktarball -m %module_name -v %version %mktarball_line --archive `basename %{module_name}-%{version}.dkms.tar.gz`
cp -af %{_dkmsdir}/%{module_name}/%{version}/tarball/`basename %{module_name}-%{version}.dkms.tar.gz` %{module_name}-%{version}.dkms.tar.gz
fi
%install
if [ "$RPM_BUILD_ROOT" != "/" ]; then
rm -rf $RPM_BUILD_ROOT
fi
mkdir -p $RPM_BUILD_ROOT/%{_srcdir}
mkdir -p $RPM_BUILD_ROOT/%{_datarootdir}/%{module_name}
if [ -d %{_sourcedir}/%{module_name}-%{version} ]; then
cp -Lpr %{_sourcedir}/%{module_name}-%{version} $RPM_BUILD_ROOT/%{_srcdir}
fi
if [ -f %{module_name}-%{version}.dkms.tar.gz ]; then
install -m 644 %{module_name}-%{version}.dkms.tar.gz $RPM_BUILD_ROOT/%{_datarootdir}/%{module_name}
fi
if [ -f %{_sourcedir}/common.postinst ]; then
install -m 755 %{_sourcedir}/common.postinst $RPM_BUILD_ROOT/%{_datarootdir}/%{module_name}/postinst
fi
%clean
if [ "$RPM_BUILD_ROOT" != "/" ]; then
rm -rf $RPM_BUILD_ROOT
fi
%post
for POSTINST in %{_prefix}/lib/dkms/common.postinst %{_datarootdir}/%{module_name}/postinst; do
if [ -f $POSTINST ]; then
$POSTINST %{module_name} %{version} %{_datarootdir}/%{module_name}
exit $?
fi
echo "WARNING: $POSTINST does not exist."
done
echo -e "ERROR: DKMS version is too old and %{module_name} was not"
echo -e "built with legacy DKMS support."
echo -e "You must either rebuild %{module_name} with legacy postinst"
echo -e "support or upgrade DKMS to a more current version."
exit 1
%preun
echo -e
echo -e "Uninstall of %{module_name} module (version %{version}) beginning:"
dkms remove -m %{module_name} -v %{version} --all --rpm_safe_upgrade
exit 0
%files
%defattr(-,root,root)
%{_srcdir}
%{_datarootdir}/%{module_name}/
%changelog
* %(date "+%a %b %d %Y") %packager %{version}-%{release}
- Automatic build by DKMS
distribution/fmc-adc-100m14b4ch.spec 0 → 100644
View file @ 7cc993f1
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# SPDX-License-Identifier: CC0-1.0
# Mainline copied from the template, added requirements
name: fmc-adc-100m14b4ch
version: %{?_build_version}
Release: 1%{?dist}
Summary: Linux kernel FMC-ADC-10M support
BuildArch: noarch
Group: System/Kernel
License: GPL-2.0-or-later
URL: https://ohwr.org/project/fmc-adc-100m14b4cha
Source0: %{name}-%{version}.tar.gz
Source1: CHANGELOG
BuildRequires: dkms
Requires: dkms >= 1.95, zio >= 1.4, fmc >= 1.1
%description
Kernel modules for FMC-ADC-100M in a DKMS wrapper.
%prep
%setup -q
%install
mkdir -p %{buildroot}/usr/src/%{name}-%{version}
cp -ra * %{buildroot}/usr/src/%{name}-%{version}/
%post
dkms add -m %{name} -v %{version} --rpm_safe_upgrade
dkms build -m %{name} -v %{version} --rpm_safe_upgrade
dkms install -m %{name} -v %{version} --rpm_safe_upgrade
%preun
dkms remove -m %{name} -v %{version} --rpm_safe_upgrade --all ||:
%files
/usr/src/%{name}-%{version}/
%changelog
%include %{SOURCE1}
doc/.gitignore
View file @ 7cc993f1
*~
*.aux
*.cp
*.cps
*.fn
*.fns
*.html
*.info
*.ky
*.log
/*.pdf
*.pg
*.texi
*.toc
*.tp
/*.txt
*.vr
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# SPDX-License-Identifier: CC0-1.0
build_env
_build
*.htm
*.pdf
\ No newline at end of file
doc/Makefile
View file @ 7cc993f1
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# SPDX-License-Identifier: CC0-1.0
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = FMCADC100M14bit4Channel
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS = -Drelease=$(shell git describe) -Dversion=$(shell git describe | cut -d "-" -f 1 | tr -d "v")
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
......@@ -17,4 +21,10 @@ help:
# 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
$(MAKE) -C fig all
$(MAKE) -C gateware/regs all
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
clean:
$(MAKE) -C fig clean
$(MAKE) -C gateware/regs clean
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
doc/conf.py
View file @ 7cc993f1
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# FMC ADC 100M 14 bit 4 Channel documentation build configuration file, created by
# sphinx-quickstart on Thu Jan 25 09:54:50 2018.
#
# 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.
# SPDX-License-Identifier: CC0-1.0
# Configuration file for the Sphinx documentation builder.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# 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
......@@ -22,22 +19,11 @@
# 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.coverage',
'sphinx.ext.graphviz',]
# -- Project information -----------------------------------------------------
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
project = 'FMC-ADC-100M-14B-4CHA'
copyright = u'2013-2020, CERN, documentation released under CC-BY-SA-4.0'
author = 'Matthieu Cattin, Dimitris Lampridis <dimitrios.lampridis@cern.ch>, Federico Vaga <federico.vaga@cern.ch>'
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
......@@ -48,148 +34,59 @@ source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'FMC ADC 100M 14 bit 4 Channel'
copyright = '2018, Federico Vaga <federico.vaga@cern.ch>'
author = 'Federico Vaga <federico.vaga@cern.ch>'
# -- General configuration ---------------------------------------------------
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '5.0'
# The full version, including alpha/beta/rc tags.
release = '5.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.coverage',
'sphinx.ext.graphviz',
]
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['build_env', '_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output ----------------------------------------------
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
#html_theme = 'alabaster'
html_theme = "sphinx_rtd_theme"
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# If true, links to the reST sources are added to the pages.
#
# html_theme_options = {}
html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#
html_show_sphinx = False
# 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']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
'**': [
'relations.html', # needs 'show_related': True theme option to display
'searchbox.html',
]
}
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'FMCADC100M14bit4Channeldoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# 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, 'FMCADC100M14bit4Channel.tex', 'FMC ADC 100M 14 bit 4 Channel Documentation',
'Federico Vaga \\textless{}federico.vaga@cern.ch\\textgreater{}', 'manual'),
(master_doc,
'FMCADC100M14bit4Channel.tex',
'FMC ADC 100M 14 bit 4 Channel Documentation',
'Matthieu Cattin,\\\Dimitris Lampridis \\textless{}dimitrios.lampridis@cern.ch\\textgreater{},\\\ Federico Vaga \\textless{}federico.vaga@cern.ch\\textgreater{}',
'manual'),
]
# -- 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, 'fmcadc100m14bit4channel', 'FMC ADC 100M 14 bit 4 Channel Documentation',
[author], 1)
]
# -- 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, 'FMCADC100M14bit4Channel', 'FMC ADC 100M 14 bit 4 Channel Documentation',
author, 'FMCADC100M14bit4Channel', 'One line description of project.',
'Miscellaneous'),
]
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''
# A unique identification for the text.
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
# epub_uid = ''
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
smart_quotes = False
latex_logo = 'fig/ohr_logo_lowres.png'
doc/fig/Makefile
View file @ 7cc993f1
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# SPDX-License-Identifier: CC0-1.0
SVG=$(wildcard *.svg)
PDF=$(SVG:.svg=.pdf)
......
doc/fig/analogue_input.svg 0 → 100644
View file @ 7cc993f1
This diff is collapsed.
doc/fig/config-if.svg 0 → 100644
View file @ 7cc993f1
This diff is collapsed.
doc/fig/memory_multi-shot.svg
View file @ 7cc993f1
This diff is collapsed.
doc/fig/memory_samples.svg
View file @ 7cc993f1
This diff is collapsed.
doc/fig/memory_single-shot.svg
View file @ 7cc993f1
This diff is collapsed.
doc/fig/memory_single-shot_overlap.svg
View file @ 7cc993f1
This diff is collapsed.
doc/fig/spec_fw_arch.svg
View file @ 7cc993f1
This diff is collapsed.
doc/fig/spec_fw_arch.svg.2020_11_23_14_48_11.0.svg 0 → 100644
View file @ 7cc993f1
This diff is collapsed.
doc/fig/spec_fw_arch.svg.2020_11_23_15_11_39.0.svg 0 → 100644
View file @ 7cc993f1
This diff is collapsed.
doc/fig/svec_fw_arch.svg
View file @ 7cc993f1
This diff is collapsed.
doc/fig/svec_fw_arch.svg.2020_11_23_16_22_06.0.svg 0 → 100644
View file @ 7cc993f1
This diff is collapsed.
doc/fig/trig_hw_int.svg
View file @ 7cc993f1
This diff is collapsed.
doc/fig/trigger_unit.svg
View file @ 7cc993f1
This diff is collapsed.
doc/gateware/index.rst 0 → 100644
View file @ 7cc993f1
This diff is collapsed.
doc/gateware/memory-map.rst 0 → 100644
View file @ 7cc993f1
..
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2020 CERN
==============
The Memory Map
==============
Following the memory map for the part of the ADC design that drives
the FMC ADC 100M modules.
.. only:: latex
.. 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
=================
Here you can find the complete memory MAP for the supported
designs. This will include the ADC register as well as the carrier
registers and any other component used in an FMC ADC 100M design.
.. toctree::
:maxdepth: 1
:caption: Table of Contents
spec_ref_fmc_adc_100M
svec_ref_fmc_adc_100M
doc/gateware/regs/Makefile 0 → 100644
View file @ 7cc993f1
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# SPDX-License-Identifier: CC0-1.0
SOURCES = $(wildcard *.cheby) ../../../hdl/cheby/fmc_adc_mezzanine_mmap.cheby
TARGETS = $(SOURCES:.cheby=.htm)
all: $(TARGETS)
.PHONY: $(TARGETS) clean
$(TARGETS): %.htm : %.cheby
@echo -e "\n\033[34m\033[1m-> Processing file $<\033[0m"
@cheby -i $< --gen-doc=$(shell basename $@) --doc html
clean:
@rm -f *.md *.rst *.htm
doc/gateware/regs/spec_ref_fmc_adc_100Ms_doc.cheby 0 → 100644
View file @ 7cc993f1
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# SPDX-License-Identifier: CC-BY-SA-4.0
memory-map:
name: spec_ref_fmc_adc_100m_doc
bus: wb-32-be
description: SPEC FMC-ADC-100M full memory map
children:
- submap:
name: spec_base_mmap
address: 0x0000
description: SPEC base memory map
filename: ../../../hdl/ip_cores/spec/hdl/rtl/spec_base_regs.cheby
- submap:
name: metadata
address: 0x2000
size: 0x40
interface: wb-32-be
x-hdl:
busgroup: True
description: a ROM containing the application metadata
- submap:
name: fmc_adc_mezzanine
address: 0x4000
description: FMC ADC Mezzanine
filename: ../../../hdl/cheby/fmc_adc_mezzanine_mmap.cheby
doc/gateware/regs/svec_ref_fmc_adc_100Ms_doc.cheby 0 → 100644
View file @ 7cc993f1
# SPDX-FileCopyrightText: 2020 CERN (home.cern)
#
# SPDX-License-Identifier: CC-BY-SA-4.0
memory-map:
name: svec_ref_fmc_adc_100m_doc
bus: wb-32-be
description: SVEC FMC-ADC-100M full memory map
children:
- submap:
name: svec_base_mmap
address: 0x0000
description: SVEC base memory map
filename: ../../../hdl/ip_cores/svec/hdl/rtl/svec_base_regs.cheby
- submap:
name: metadata
address: 0x2000
size: 0x40
interface: wb-32-be
x-hdl:
busgroup: True
description: a ROM containing the application metadata
- submap:
name: fmc1_adc_mezzanine
address: 0x4000
description: FMC ADC Mezzanine slot 1
filename: ../../../hdl/cheby/fmc_adc_mezzanine_mmap.cheby
- submap:
name: fmc2_adc_mezzanine
address: 0x6000
description: FMC ADC Mezzanine slot 2
filename: ../../../hdl/cheby/fmc_adc_mezzanine_mmap.cheby
doc/gateware/spec_ref_fmc_adc_100M.rst 0 → 100644
View file @ 7cc993f1
..
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2020 CERN
=================
SPEC FMC ADC 100M
=================
.. raw:: html
:file: regs/spec_ref_fmc_adc_100Ms_doc.htm
doc/gateware/svec_ref_fmc_adc_100M.rst 0 → 100644
View file @ 7cc993f1
..
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2020 CERN
=================
SVEC FMC ADC 100M
=================
.. raw:: html
:file: regs/svec_ref_fmc_adc_100Ms_doc.htm
doc/index.rst
View file @ 7cc993f1
..
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2020 CERN
.. Copyright (c) 2013-2020 CERN (home.cern)
SPDX-License-Identifier: CC-BY-SA-4.0
Welcome to FMC ADC 100M 14 bit 4 Channel's documentation!
=========================================================
This is the user manual of the driver for the `FMC ADC 100M 14b 4cha`_
board developed on the `Open Hardware Repository`_. FMC is the form
factor of the card, ADC is its role, 100M means it can acquire
100Msample per second, 14b is the numbers of meaningful bits and 4cha
states it has 4 input channels (plus a trigger input).
.. FMC-ADC-100M-14B-4CHA documentation master file, created by
sphinx-quickstart on Thu Aug 6 14:57:13 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. _`Open Hardware Repository`: http://www.ohwr.org/
.. _`FMC ADC 100M 14b 4cha`: http://www.ohwr.org/projects/fmc-adc-100m14b4cha
FMC-ADC-100M-14B-4CHA documentation
===================================
.. toctree::
:maxdepth: 2
:caption: Contents:
:caption: Table of Contents
introduction
software/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
gateware/index
gateware/memory-map
doc/introduction.rst 0 → 100644
View file @ 7cc993f1
.. Copyright (c) 2013-2020 CERN (home.cern)
SPDX-License-Identifier: CC-BY-SA-4.0
.. _introduction:
------------
Introduction
------------
This document describes the gateware developed to support the
FmcAdc100m14b4cha (later refered to as fmc-adc) mezzanine card on the
`SPEC`_ and `SVEC`_ carrier cards. The gateware is the HDL code used
to generate the bitstream that configures the FPGA on the carrier
(sometimes also called firmware). The gateware architecture is
described in detail. The configuration and operation of the fmc-adc
is also explained. The Linux driver and basic tools are explained as
well. On the other hand, this manual is not intended to provide
information about the hardware design.
Repositories and Releases
=========================
The `FMC ADC 100M 14 bits 4 Channels`_ is hosted on
the `Open HardWare Repository`_. The main development happens
here. You can clone the GIT project with the following command::
git clone https://ohwr.org/project/fmc-adc-100m14b4cha.git
Within the GIT respository, releases are marked with a TAG named
using the `Semantic Versioning`_. For example the latest release is
``v5.0.0``. You can also find older releases with a different versioning
mechanism.
For each release we will publish the FPGA bitstream for all supported
carrier cards (`FPGA Bitstream Page
<https://ohwr.org/project/fmc-adc-100m14b4cha/wikis/Documents/Bitstreams>`_).
For the Linux driver we can't release the binary because it depends on
the Linux version on which it will run. For details about how to build
the Linux driver for your kernel please have a look at :ref:`Compile And Install <drv_build_install>`
section in :doc:`Driver's Documentation <software/driver>`.
Documentation License
=====================
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/.
.. _SPEC: http://www.ohwr.org/projects/spec
.. _SVEC: http://www.ohwr.org/projects/svec
.. _`FMC ADC 100M 14 bits 4 Channels`: https://ohwr.org/project/fmc-adc-100m14b4cha
.. _`Open HardWare Repository`: https://ohwr.org/
.. _`Semantic Versioning`: https://semver.org/
doc/manual/Makefile deleted 100644 → 0
View file @ bdfff5dd
#
# Makefile for the documentation directory
#
# Copyright 1994,2000,2010,2011 Alessandro Rubini <rubini@linux.it>
#
#################
# There is not basenames here, all *.in are considered input
INPUT = $(wildcard *.in)
TEXI = $(INPUT:.in=.texi)
INFO = $(INPUT:.in=.info)
HTML = $(INPUT:.in=.html)
TXT = $(INPUT:.in=.txt)
PDF = $(INPUT:.in=.pdf)
ALL = $(INFO) $(HTML) $(TXT) $(PDF)
MAKEINFO ?= makeinfo
%.texi: %.in
@rm -f $@
sed -f ./infofilter $< > $@
emacs -batch --no-site-file -l fixinfo $@
chmod -w $@
%.pdf: %.texi
texi2pdf --batch $<
%.info: %.texi
$(MAKEINFO) $< -o $@
%.html: %.texi
$(MAKEINFO) --html --no-split -o $@ $<
%.txt: %.texi
$(MAKEINFO) --no-headers $< > $@
##############################################
.PHONY: all images check terse clean install
.INTERMEDIATE: $(TEXI)
all: images $(ALL)
$(MAKE) terse
images::
if [ -d images ]; then $(MAKE) -C images || exit 1; fi
check: _err.ps
gs -sDEVICE=linux -r320x200x16 $<
terse:
for n in cp fn ky pg toc tp vr aux log; do rm -f *.$$n; done
rm -f *~
clean: terse
rm -f $(ALL) $(TEXI)
# add the other unused targets, so the rule in ../Makefile works
modules install modules_install:
doc/manual/fixinfo deleted 100644 → 0
View file @ bdfff5dd
;; use:
;; emacs -batch -l ./fixinfo.el <file>
;; or, better:
;; emacs -batch --no-site-file -l ./fixinfo.el <file>
(defun fixinfo (file)
(find-file-other-window file)
(message (concat "Maxing texinfo tree in " file))
(texinfo-all-menus-update)
(texinfo-every-node-update)
(save-buffer)
(kill-buffer (current-buffer))
)
;; loop over command line arguments
(mapcar 'fixinfo command-line-args-left)
(kill-emacs)
doc/manual/fmc_adc_100Ms_csr.tex deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
doc/manual/fmc_adc_eic.tex deleted 100644 → 0
View file @ bdfff5dd
@regsection Memory map summary
@multitable @columnfractions .10 .15 .15 .55
@headitem Address @tab Type @tab Prefix @tab Name
@item @code{0x0} @tab
REG @tab
@code{EIC_IDR} @tab
Interrupt disable register
@item @code{0x4} @tab
REG @tab
@code{EIC_IER} @tab
Interrupt enable register
@item @code{0x8} @tab
REG @tab
@code{EIC_IMR} @tab
Interrupt mask register
@item @code{0xc} @tab
REG @tab
@code{EIC_ISR} @tab
Interrupt status register
@end multitable
@regsection @code{EIC_IDR} - Interrupt disable register
Writing 1 disables handling of the interrupt associated with corresponding bit. Writin 0 has no effect.
@multitable @columnfractions .10 .10 .15 .10 .55
@headitem Bits @tab Access @tab Prefix @tab Default @tab Name
@item @code{0}
@tab W/O @tab
@code{TRIG}
@tab @code{0} @tab
Trigger interrupt
@item @code{1}
@tab W/O @tab
@code{ACQ_END}
@tab @code{0} @tab
End of acquisition interrupt
@end multitable
@multitable @columnfractions 0.15 0.85
@headitem Field @tab Description
@item @code{trig} @tab write 1: disable interrupt 'Trigger interrupt'@*write 0: no effect
@item @code{acq_end} @tab write 1: disable interrupt 'End of acquisition interrupt'@*write 0: no effect
@end multitable
@regsection @code{EIC_IER} - Interrupt enable register
Writing 1 enables handling of the interrupt associated with corresponding bit. Writin 0 has no effect.
@multitable @columnfractions .10 .10 .15 .10 .55
@headitem Bits @tab Access @tab Prefix @tab Default @tab Name
@item @code{0}
@tab W/O @tab
@code{TRIG}
@tab @code{0} @tab
Trigger interrupt
@item @code{1}
@tab W/O @tab
@code{ACQ_END}
@tab @code{0} @tab
End of acquisition interrupt
@end multitable
@multitable @columnfractions 0.15 0.85
@headitem Field @tab Description
@item @code{trig} @tab write 1: enable interrupt 'Trigger interrupt'@*write 0: no effect
@item @code{acq_end} @tab write 1: enable interrupt 'End of acquisition interrupt'@*write 0: no effect
@end multitable
@regsection @code{EIC_IMR} - Interrupt mask register
Shows which interrupts are enabled. 1 means that the interrupt associated with the bitfield is enabled
@multitable @columnfractions .10 .10 .15 .10 .55
@headitem Bits @tab Access @tab Prefix @tab Default @tab Name
@item @code{0}
@tab R/O @tab
@code{TRIG}
@tab @code{X} @tab
Trigger interrupt
@item @code{1}
@tab R/O @tab
@code{ACQ_END}
@tab @code{X} @tab
End of acquisition interrupt
@end multitable
@multitable @columnfractions 0.15 0.85
@headitem Field @tab Description
@item @code{trig} @tab read 1: interrupt 'Trigger interrupt' is enabled@*read 0: interrupt 'Trigger interrupt' is disabled
@item @code{acq_end} @tab read 1: interrupt 'End of acquisition interrupt' is enabled@*read 0: interrupt 'End of acquisition interrupt' is disabled
@end multitable
@regsection @code{EIC_ISR} - Interrupt status register
Each bit represents the state of corresponding interrupt. 1 means the interrupt is pending. Writing 1 to a bit clears the corresponding interrupt. Writing 0 has no effect.
@multitable @columnfractions .10 .10 .15 .10 .55
@headitem Bits @tab Access @tab Prefix @tab Default @tab Name
@item @code{0}
@tab R/W @tab
@code{TRIG}
@tab @code{X} @tab
Trigger interrupt
@item @code{1}
@tab R/W @tab
@code{ACQ_END}
@tab @code{X} @tab
End of acquisition interrupt
@end multitable
@multitable @columnfractions 0.15 0.85
@headitem Field @tab Description
@item @code{trig} @tab read 1: interrupt 'Trigger interrupt' is pending@*read 0: interrupt not pending@*write 1: clear interrupt 'Trigger interrupt'@*write 0: no effect
@item @code{acq_end} @tab read 1: interrupt 'End of acquisition interrupt' is pending@*read 0: interrupt not pending@*write 1: clear interrupt 'End of acquisition interrupt'@*write 0: no effect
@end multitable
doc/manual/fmcadc100m14b4cha_gateware_manual.in deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
doc/manual/infofilter deleted 100644 → 0
View file @ bdfff5dd
#! /usr/bin/sed -f
# allow "%" as a comment char, but only at the beginning of the line
s/^%/@c /
#s/[^\\]%.*$//
s/^\\%/%/
#preserve blanks and braces in @example blocks
/^@example/,/^@end example/ s/{/@{/g
/^@example/,/^@end example/ s/}/@}/g
/^@example/,/^@end example/ p
/^@example/,/^@end example/ d
/^@smallexample/,/^@end smallexample/ s/{/@{/g
/^@smallexample/,/^@end smallexample/ s/}/@}/g
/^@smallexample/,/^@end smallexample/ p
/^@smallexample/,/^@end smallexample/ d
# remove leading blanks
s/^[ ]*//
doc/manual/sdb_ids.txt deleted 100644 → 0
View file @ bdfff5dd
@verbatim
integration: vid=0xCE42, did=0x47c786a2
wb crossbar: vid=0x0651, did=0xe6a542c9
wb bridge : vid=0x0651, did=0xeef0b198
vic : vid=0xCE42, did=0x00000013
onewire : vid=0xCE42, did=0x779c5443
spec_csr : vid=0xCE42, did=0x00000603
svec_csr : vid=0xCE42, did=0x00006603
timetag : vid=0xCE42, did=0x00000604
fmc_eic : vid=0xCE42, did=0x26ec6086
i2c : vid=0xCE42, did=0x123c5443
spi : vid=0xCE42, did=0xe503947e
adc_csr : vid=0xCE42, did=0x00000608
dma_eic : vid=0xCE42, did=0xd5735ab4
dma_ctrl : vid=0xCE42, did=0x00000601
ddr_addr : vid=0xCE42, did=0x10006611
ddr_data : vid=0xCE42, did=0x10006610
@end verbatim
doc/manual/spec/carrier_csr.tex deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
doc/manual/spec/dma_eic.tex deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
doc/manual/spec_wb_tree.txt deleted 100644 → 0
View file @ bdfff5dd
@verbatim
0x0000 crossbar (sdb records)
0x1000 |-- dma controller
0x1100 |-- onewire master
0x1200 |-- spec csr
0x1300 |-- vic
0x1400 |-- dma eic
0x2000 |-- bridge (fmc slot 1) -> crossbar (sdb records)
0x3000 | |-- i2c master
0x3100 | |-- spi master
0x3200 | |-- i2c master
0x3300 | |-- adc csr
0x3400 | |-- onewire
0x3500 | |-- fmc-adc eic
0x3600 | |-- timetag core
@end verbatim
doc/manual/svec/carrier_csr.tex deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
doc/manual/svec_wb_tree.txt deleted 100644 → 0
View file @ bdfff5dd
@verbatim
0x0000 crossbar (sdb records)
0x1000 |-- i2c
0x1100 |-- onewire
0x1200 |-- svec csr
0x1300 |-- vic
0x2000 |-- bridge (fmc slot 1) -> crossbar (sdb records)
0x3000 | |-- i2c
0x3100 | |-- spi
0x3200 | |-- i2c
0x3300 | |-- adc csr
0x3400 | |-- onewire
0x3500 | |-- fmc_eic
0x3600 | |-- timetag
0x4000 |-- ddr_addr (fmc slot 1)
0x5000 |-- ddr_data (fmc slot 1)
0x6000 |-- bridge (fmc slot 2) -> crossbar (sdb records)
0x7000 | |-- i2c
0x7100 | |-- spi
0x7200 | |-- i2c
0x7300 | |-- adc csr
0x7400 | |-- onewire
0x7500 | |-- fmc_eic
0x7600 | |-- timetag
0x8000 |-- ddr_addr (fmc slot 2)
0x9000 |-- ddr_data (fmc slot 2)
@end verbatim
doc/manual/timetag_core_regs.tex deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
doc/manual/wb_vic.htm deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
doc/manual/wb_vic.tex deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
doc/requirements.txt 0 → 100644
View file @ 7cc993f1
alabaster==0.7.12
appdirs==1.4.3
Babel==2.8.0
CacheControl==0.12.6
certifi==2019.11.28
chardet==3.0.4
colorama==0.4.3
contextlib2==0.6.0
distlib==0.3.0
distro==1.4.0
docutils==0.16
html5lib==1.0.1
idna==2.8
imagesize==1.2.0
Jinja2==2.11.2
lockfile==0.12.2
MarkupSafe==1.1.1
msgpack==0.6.2
packaging==20.3
pep517==0.8.2
progress==1.5
Pygments==2.6.1
pyparsing==2.4.6
pytoml==0.1.21
pytz==2020.1
requests==2.23.0
retrying==1.3.3
six==1.14.0
snowballstemmer==2.0.0
Sphinx==3.1.2
sphinx-rtd-theme==0.5.0
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==1.0.3
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.4
urllib3==1.25.8
webencodings==0.5.1
doc/software/driver.rst
View file @ 7cc993f1
This diff is collapsed.
doc/software/tools.rst
View file @ 7cc993f1
......@@ -102,7 +102,7 @@ the graphic appearance of Tk-8.4 (and earlier versions). If you prefer the
older one, run *wish8.4 tools/fau-config-if* instead of
``tools/fau-config-if`` (or set the previous version as default Tk interpreter).
.. figure:: ../img/config-if.gif
.. figure:: ../fig/config-if.*
:alt: Two snapshots of fa-config-if
:align: center
......
doc/specs/Makefile deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
doc/specs/adc100m14b4cha.tex deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
doc/specs/fmcadc_fw_testing.txt deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
doc/specs/state_machine.dia deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/cheby/Makefile
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/fmc_adc_100Ms_channel_regs.cheby
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/fmc_adc_100Ms_channel_regs.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/fmc_adc_100Ms_csr.cheby
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/fmc_adc_100Ms_csr.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/fmc_adc_aux_trigin.cheby
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/fmc_adc_aux_trigin.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/fmc_adc_aux_trigout.cheby
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/fmc_adc_aux_trigout.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/fmc_adc_eic_regs.cheby
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/fmc_adc_eic_regs.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/fmc_adc_mezzanine_mmap.cheby
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/fmc_adc_mezzanine_mmap.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/spec_ref_fmc_adc_100Ms_mmap.cheby
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/spec_ref_fmc_adc_100Ms_mmap.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/svec_ref_fmc_adc_100Ms_mmap.cheby
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/svec_ref_fmc_adc_100Ms_mmap.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/timetag_core_regs.cheby
View file @ 7cc993f1
This diff is collapsed.
hdl/cheby/timetag_core_regs.vhd
View file @ 7cc993f1
This diff is collapsed.
gn4124-core @ 06414d93
This diff is collapsed.
spec @ 26b16bd3
This diff is collapsed.
hdl/platform/Manifest.py
View file @ 7cc993f1
This diff is collapsed.
hdl/platform/xilinx/Manifest.py
View file @ 7cc993f1
This diff is collapsed.
hdl/platform/xilinx/spartan6/Manifest.py
View file @ 7cc993f1
This diff is collapsed.
hdl/rtl/Manifest.py
View file @ 7cc993f1
This diff is collapsed.
hdl/rtl/fmc_adc_100Ms_core.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/rtl/fmc_adc_100Ms_core_pkg.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/rtl/fmc_adc_eic.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/rtl/fmc_adc_mezzanine.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/rtl/fmc_adc_mezzanine_pkg.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/rtl/offset_gain_s.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/rtl/timetag_core.vhd
View file @ 7cc993f1
This diff is collapsed.
hdl/syn/spec150_ref_design_wr/.gitignore
View file @ 7cc993f1
This diff is collapsed.
hdl/syn/spec150_ref_design_wr/Manifest.py
View file @ 7cc993f1
This diff is collapsed.
hdl/syn/spec_ref_design_wr/.gitignore
View file @ 7cc993f1
This diff is collapsed.
hdl/syn/spec_ref_design_wr/Manifest.py
View file @ 7cc993f1
This diff is collapsed.
hdl/syn/svec_ref_design_wr/.gitignore
View file @ 7cc993f1
This diff is collapsed.
hdl/syn/svec_ref_design_wr/Manifest.py
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/__deprecated/other/Manifest.py deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/Test_Builder/a.out deleted 100755 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/Test_Builder/lambo.h deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/Test_Builder/sg_dma.c deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/Test_Builder/simple.c deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/cmd0.vec deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/cmd0.vec.dma deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/spec.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/testbench/Manifest.py deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/testbench/tb_spec.vhd deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/testbench/util.vhd deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/tests/simple(old).vec deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/tests/simple.vec deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/tests/simple_dma-.vec deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/tests/simple_dma.vec deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/util/make.exe deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/util/rm.exe deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/wave.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/wave_adc_core.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/wave_datapath.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/wave_ddr_wb.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/wave_end_acq_irq.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/wave_gnum.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/wave_multishot.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/wave_onewire.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/wave_reset.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/wave_serdes.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/other/wave_wb_buses.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/spec/Manifest.py deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/spec/ddr3/ddr3.v deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/spec/ddr3/ddr3_mcp.v deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/spec/ddr3/ddr3_module.v deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/spec/gn4124_bfm/Manifest.py deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/spec/gn4124_bfm/util.vhd deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/spec/main.sv deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/spec/run.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/spec/sfp_i2c_adapter.vhd deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/spec/wave.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/svec/2048Mb_ddr3/ddr3.svh deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/svec/2048Mb_ddr3/ddr3.v deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/svec/2048Mb_ddr3/ddr3_mcp.v deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/svec/2048Mb_ddr3/readme.txt deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/svec/2048Mb_ddr3/subtest.vh deleted 100755 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/svec/2048Mb_ddr3/tb.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/svec/2048Mb_ddr3/tb.v deleted 100755 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/svec/testbench/Manifest.py deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/svec/testbench/fmc.svh deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/svec/testbench/main.sv deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/svec/testbench/svec.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/__deprecated/svec/testbench/wave.do deleted 100644 → 0
View file @ bdfff5dd
This diff is collapsed.
hdl/testbench/fmc_adc_mezzanine/.gitignore
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/fmc_adc_mezzanine/Manifest.py
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/fmc_adc_mezzanine/main.sv
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/fmc_adc_mezzanine/run.do
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/fmc_adc_mezzanine/run_ci.do
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/include/fmc_adc_100Ms_csr.v
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/include/fmc_adc_aux_trigin.v
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/include/fmc_adc_aux_trigout.v
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/include/fmc_adc_eic_regs.v
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/include/spec_carrier_csr.v
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/include/svec_carrier_csr.v
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/include/timetag_core_regs.v
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/spec_ref_design/.gitignore
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/spec_ref_design/Manifest.py
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/spec_ref_design/main.sv
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/spec_ref_design/run.do
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/spec_ref_design/run_ci.do
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/spec_ref_design/wave.do
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/svec_ref_design/.gitignore
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/svec_ref_design/Manifest.py
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/svec_ref_design/main.sv
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/svec_ref_design/run.do
View file @ 7cc993f1
This diff is collapsed.
hdl/testbench/svec_ref_design/run_ci.do
View file @ 7cc993f1
This diff is collapsed.
hdl/top/spec_ref_design/Manifest.py
View file @ 7cc993f1
This diff is collapsed.
hdl/top/svec_ref_design/Makefile
View file @ 7cc993f1
This diff is collapsed.
hdl/top/svec_ref_design/Manifest.py
View file @ 7cc993f1
This diff is collapsed.
software/.gitignore 0 → 100644
View file @ 7cc993f1
This diff is collapsed.
software/Makefile
View file @ 7cc993f1
This diff is collapsed.
software/kernel/.gitignore
View file @ 7cc993f1
This diff is collapsed.
software/kernel/Kbuild
View file @ 7cc993f1
This diff is collapsed.
software/kernel/Makefile
View file @ 7cc993f1
This diff is collapsed.
software/kernel/fa-calibration.c
View file @ 7cc993f1
This diff is collapsed.
software/kernel/fa-core.c
View file @ 7cc993f1
This diff is collapsed.
software/kernel/fa-debug.c
View file @ 7cc993f1
This diff is collapsed.
software/kernel/fa-dma.c
View file @ 7cc993f1
This diff is collapsed.
software/kernel/fa-irq.c
View file @ 7cc993f1
This diff is collapsed.
software/kernel/fa-regtable.c
View file @ 7cc993f1
This diff is collapsed.
software/kernel/fa-zio-drv.c
View file @ 7cc993f1
This diff is collapsed.
software/kernel/fa-zio-trg.c
View file @ 7cc993f1
This diff is collapsed.
software/kernel/fmc-adc-100m14b4cha-private.h 0 → 100644
View file @ 7cc993f1
This diff is collapsed.
software/kernel/fmc-adc-100m14b4cha.h
View file @ 7cc993f1
This diff is collapsed.
software/kernel/spi.c
View file @ 7cc993f1
This diff is collapsed.
software/tools/.gitignore
View file @ 7cc993f1
This diff is collapsed.
software/tools/Makefile
View file @ 7cc993f1
This diff is collapsed.
software/tools/fau-acq-time.c
View file @ 7cc993f1
This diff is collapsed.
software/tools/fau-config-if
View file @ 7cc993f1
This diff is collapsed.
software/tools/fau-trg-config.c
View file @ 7cc993f1
This diff is collapsed.
software/tools/parport-burst.c
View file @ 7cc993f1
This diff is collapsed.
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