Skip to content

F
FMC DEL 1ns 4cha - Software
Commit 18f9c3ca authored by Alessandro Rubini's avatar Alessandro Rubini
Browse files
Options

doc and Makefile: support spec-sw submodule, document it 

Signed-off-by: Alessandro Rubini's avatarAlessandro Rubini <rubini@gnudd.com>
parent 87860752
Hide whitespace changes
Inline Side-by-side
Showing with 19 additions and 16 deletions
Makefile
View file @ 18f9c3ca
...@@ -5,8 +5,8 @@ ...@@ -5,8 +5,8 @@
DIRS = kernel tools lib DIRS = kernel tools lib
all clean modules install modules_install: gitmodules all clean modules install modules_install: gitmodules
for d in $(DIRS); do $(MAKE) -C $$d $@ || exit 1; done
@if echo $@ | grep -q install; then $(MAKE) prereq_install_warn; fi @if echo $@ | grep -q install; then $(MAKE) prereq_install_warn; fi
for d in $(DIRS); do $(MAKE) -C $$d $@ || exit 1; done
all modules: prereq all modules: prereq
...@@ -23,7 +23,8 @@ gitmodules: ...@@ -23,7 +23,8 @@ gitmodules:
# The user can override, using environment variables, all these three: # The user can override, using environment variables, all these three:
FMC_BUS ?= fmc-bus FMC_BUS ?= fmc-bus
ZIO ?= zio ZIO ?= zio
SUBMOD = $(FMC_BUS) $(ZIO) SPEC_SW ?= spec-sw
SUBMOD = $(FMC_BUS) $(ZIO) $(SPEC_SW)
prereq: prereq:
for d in $(SUBMOD); do $(MAKE) -C $$d || exit 1; done for d in $(SUBMOD); do $(MAKE) -C $$d || exit 1; done
......
doc/fine-delay.in
View file @ 18f9c3ca
...@@ -375,19 +375,19 @@ module parameters. ...@@ -375,19 +375,19 @@ module parameters.
@section Software Dependencies @section Software Dependencies
The kernel versions I am using during development is 3.4. Everything The kernel versions I am using during development is 3.4. Everything
used here is known to build with all versions since 2.6.32 and up to 3.8. used here is known to build with all versions from 2.6.35 to
A backport to version 2.6.24 is released as a separate @i{git} branch. 3.12. A backport to version 2.6.24 is released as a
separate @i{git} branch, but we won't maintain it any more.
The driver, then, is based on the @sc{zio} framework, available from The driver, then, is based on the @sc{zio} framework, available from
@code{ohwr.org}. I'm developing with the @code{v1.0-fixes} branch of @code{ohwr.org}. This version of @sc{zio} doesn't build with 3.13, for
the framework. Again, this commit of @sc{zio} is known a minor incompatibility, so this version of @i{fine-delay-sw} is
to work in the kernel range 2.6.32..3.8 and a backport to 2.6.24 is limited to Linux 3.12 as well.
available.
The FMC mezzanine is supported by means of the @i{fmc-bus} The FMC mezzanine is supported by means of the @i{fmc-bus}
software project. This @i{fine-delay} software project. This @i{fine-delay}
kernel module registers as a @i{driver} for the FMC bus abstraction, kernel module registers as a @i{driver} for the FMC bus abstraction,
and is verified with version @t{v2013-04} of the FMC package. and is verified with version @t{v2014-02} of the FMC package.
The same kernel range applies. The same kernel range applies.
Both packages (@sc{zio} and @i{fmc-bus}) Both packages (@sc{zio} and @i{fmc-bus})
...@@ -396,14 +396,15 @@ of this package, and each of them is retrieved at the right version ...@@ -396,14 +396,15 @@ of this package, and each of them is retrieved at the right version
to be compatible with this driver. This means you may just to be compatible with this driver. This means you may just
ignore software dependencies and everything should work. ignore software dependencies and everything should work.
The carrier driver is not strictly related to this package, but @sc{fmc} support is a @i{bus} in the Linux way, so you need both
@i{fine-delay} is released against version @t{v2013-04} of a @i{device} and a @i{driver}. This driver is known to work both
@i{spec-sw} and version @t{fixme} of @i{svec-sw}. with the @sc{spec} carrier on @sc{pci} and the @sc{svec} carrier
on @sc{vme}. The software packages that provide the respective @i{device}
are called @i{spec-sw} and @i{svec-sw}; both are hosted on @t{ohwr.org}.
(fixme) Unfortunately, all the packages are moving fast: we are approaching a stable Most of the non-@sc{cern} users are expected to run the @sc{spec}
and long-lasting status but we are not there yet. Please stick carrier, so a compatible version of @i{spec-sw} is downloaded
to the released versions named in this section, unless you are involved as a submodule, too.
in development.
@c ========================================================================== @c ==========================================================================
@node Software Installation @node Software Installation
...@@ -479,6 +480,7 @@ environment variables: ...@@ -479,6 +480,7 @@ environment variables:
@item ZIO @item ZIO
@itemx FMC_BUS @itemx FMC_BUS
@itemx SPEC_SW
The top-level directory of the repository checkout of each The top-level directory of the repository checkout of each
package. Most users won't need to set them, as the Makefiles package. Most users won't need to set them, as the Makefiles
......
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