Skip to content

F
FMC ADC 100M 14b 4cha - Software
Commit 8eeab0c7 authored by Alessandro Rubini's avatar Alessandro Rubini
Browse files
Options

doc: documented bugs and missing features 

Signed-off-by: Alessandro Rubini's avatarAlessandro Rubini <rubini@gnudd.com>
parent 5cd4ff91
Hide whitespace changes
Inline Side-by-side
Showing with 86 additions and 4 deletions
doc/fmc-adc-api.in
View file @ 8eeab0c7
......@@ -65,6 +65,49 @@ David Cobas, Federico Vaga and Alessandro Rubini in March 2013. Ideas
have later been refined during real use. Alessandro wrote this
document.
@c ##########################################################################
@node Bugs and Missing Features
@chapter Bugs and Missing Features
To set the record straight, we'd better list the known issues right
off at the start. A new release will follow shortly (summer 2013),
dealing with most of these details.
@itemize @bullet
@item The ``parameters'' functions are not documented, although they
are here to stay.
@item The library should automatically choose the buffering options:
for zio, buffer type and size adjustment. This is not implemented
and users must do that by themselves (see the driver manual about how
to do it).
@item Internals are not documented, while we think some guidance in
understanding the code is useful, in case users need to trace unexpected
behaviours that may be library bugs or application bugs. Also,
verbose mode exists but it not documented.
@item Verbose mode is not verbose enough: @i{sysfs} accesses are only
reported in case of error, while a complete trace of them is often
useful to understand what is going on. Similarly, ``log to file''
instead of ``verbose to stderr'' should be added as an option.
@item Internally, a number of functions must be renamed, and a better
split between api-generic, zio-generic and driver-specific code must
be put in place.
@item Some code parts, especially configuration, should be
restructured to use data tables instead of open-coded conditionals.
This is important for maintainance and easy addition of new boards.
@item We need to add @i{reset_conf} and related functions, that
are currently missing. Also, direct access to configuration structures
inside the device structure should be provided. The curent API will
remain, though, we plan to just add easier use cases.
@end itemize
@c ##########################################################################
@node General Ideas and Rationale
@chapter General Ideas and Rationale
......
doc/fmc-adc-driver.in
View file @ 8eeab0c7
......@@ -35,9 +35,9 @@
@setchapternewpage off
@set update-month June 2013
@c @set release 1.0
@c @set tagname fmc-adc-sw1.0
@set update-month July 2013
@set release 1.0 (almost...)
@c @set tagname fmc-adc-sw-v1.0
@finalout
......@@ -45,7 +45,7 @@
@title FMC ADC User's Manual
@subtitle @value{update-month}
@c -- Release @value{release}
@subtitle FMC ADC 100M 14 b 4ch software manual
@subtitle FMC ADC 100M 14b 4ch -- software manual
@author CERN BE-CO-HT / Federico Vaga / Alessandro Rubini
@end titlepage
@headings single
......@@ -71,6 +71,45 @@ numbers of meaningful bits and @i{4cha} states it has 4 input channels
If you want to start acquiring straight off, we suggest running @i{fald-simple-ack}, described in @ref{Simple Acquisition}.
@c ##########################################################################
@node Bugs and Missing Features
@chapter Bugs and Missing Features
To set the record straight, we'd better list the known issues right
off at the start. Release 1.1 will follow shortly (summer 2013),
dealing with most of these details. Meanwhile, the package (hardware,
gateware, software) is rock solid, so we release it despite this
list of known deficiencies:
@itemize @bullet
@item The driver doesn't check acquisition size overflows (the code is
almost there but it is not triggering). Each shot in multi-shot is
limited to 2048 samples, and a single-show acquisition is limited to
32M samples.
@item Some attributes should probably be renamed, to use human-readable
names and numbers, instead of exposing hardware-internal values.
This applies to @i{vref/range} mainly.
@item Software trigger (e.g. ZIO @i{timer} trigger) works properly,
but the sequence number of blocks is incrementing by 2 at each
block. This must be fixed in this driver, that increments the sequence
number at the wrong place.
@item Timestamps generated by the hardware are not configured nor
properly used.
@item Some error messages in the tools are puzzling and should be fixed.
@item The library has a number of issues too, but the fix won't
have user-visible effect (i.e. no incompatibilities in the API).
@item API documentation is incomplete, especially about ``parameters'',
internals and portability issues.
@end itemize
@c ##########################################################################
@node Repositories and Releases
@chapter Repositories and Releases
......
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