hameg-hmo: Send exactly one sigrok frame per scope frame

The previous implementation used to put FRAME_BEGIN and FRAME_END
markers around each received chunk of samples, while those chunks
correspond to a single channel (analog) or a group of eight channels
(digital) each. In other words, the hameg-hmo driver had provided a
multiple of the requested frames, and those frames were incomplete.

Make sure to only send FRAME_BEGIN before the first channel's data,
and FRAME_END after the last channel's data of a frame. Thus make
sigrok frames exactly match the scope's frames.

Add some comments on the frame marker and the acquisition stop logic
while we are here.

hameg-hmo: Use the host's endianess to read analog channel data via SCPI

Configure the scope to the host's native endianess before downloading
acquisition data from analog channels. This unbreaks operation on those
models which default to a representation which differs from the host.

Revert "hameg-hmo: Support BE format for SCPI sample downloads"

Undo the change which queries the scope's endianess and has the floats
converted after reception. An alternative implementation will perform
better.

Revert "scpi: Don't process received data of zero length"

Undo the change which skips management activities when no data was
received. This change breaks the current implementation, and needs to
get deferred until a delicate interaction between the resize and the
read logic has been eliminated.

license: remove FSF postal address from boiler plate license text

Remove the FSF postal address as it might change (it did in the past).
Reference the gnu.org website instead which is more stable.

asyc-ii: Rephrase "exponent" logic when parsing packets

Replace a C library strcspn(3) call with the more portable glib
g_strstr_len(3) routine. This is possible since a single separator
is searched for, no actual "set of characters" is involved.

As a byproduct, this eliminates a "late" reference to 'cnt' at the
bottom of the routine, after the value was assigned in a rather distant
location at the top of the routine. The cost of strlen() should be
acceptable for a buffer with a single digit total length.

asyc-ii: Prefer more portable and common string routines

Replace C language string operations with their glib incarnations for
improved portability. Prefer a common sigrok float conversion routine
over a DIY implementation.

asyc-ii: Unobfuscate a comment on packet parse constraints

The specific packet layout puts constraints on the parse logic (case
sensitive comparison, order of comparison). Fix a comment that made no
sense before, and better reflect that there are two constraints.

scpi: Rephrase length logic in data block reception, comment/group code

Slightly rephrase the SCPI code which parses the responses that carry
(binary) data blocks. Be explicit about NUL termination when parsing the
leading length spec in the response, obsoleting the array initializer.
Add lots of comments and group source code lines to better reflect
what's happening from the protocol's perspective.

Fix the returned error code in the path which reads responses of
excessive length in chunks. The previous implementation detected errors
but always returned code 0 (success).

scpi: Don't process received data of zero length

When nothing was received in a read attempt, we need not adjust the
buffered data's read position nor the glib string object's size. Skip
any processing for empty input, just keep checking for timeouts.

scpi: Minor style nits

Drop an initial assignment to a variable which never takes effect.
Add braces around the body of a more complex if block. Separate routines
from each other by exactly one empty line.

hameg-hmo: Support BE format for SCPI sample downloads

When the channel state is retrieved, query the pre-set byteorder for
SCPI data blocks as well. When samples get retrieved during capture,
support float representations in either big or little endian format.

This commit unbreaks devices which operate in BE format by default
(tested with HMO2524). It keeps working with LE format as before. For
devices which don't support the byteorder query or return unknown
responses, LE format is assumed for backwards compatibility. The
device's byteorder is only queried and never set. This makes the
commit least intrusive.

hameg-hmo: Declare support for 2 pods / 16 channels on HMO2524 and above

A comment mentioned that the models HMO2524 and above support 16 digital
channels (and thus have two pods for the probes). Move those models to a
section that declares the respective features, including trigger support
on the upper digital channels.

Model detection and reflection of supported channels was tested on HMO2524.

hameg-hmo: Release enabled channels when acquisition start fails

Commit db81fbb58261 made sure to release a potentially previously
allocated list of enabled channels before (re-)building the list in the
current invocation of acquisition start.

This commit frees the memory in the error path near the failed creation
already, which reduces the period of time where unused resources are
held, and eliminates a memory leak when acquisition is not stopped after
failed start.

Both approaches can coexist. Freeing an empty list is perfectly fine.

hameg-hmo: Fix index access for models with 2 pods / 16 digital channels

Fix the code which registers the name of the second pod for digital
probes. The previous implementation registered the first pod twice, and
lost the reference to the second pod. No harm was done, none of the
supported models declared support for two pods so far.

Factor out a channel to group mapping in the registration of digital
channels, while we are here.

serial-lcr: update README.devices (firmware upload, comm port specs)

Catch up with the rename of deree-de5000 to serial-lcr. Put an item in
the "needs a comm port spec" section, too.

deree-de5000: rename to serial-lcr, update configure logic

The former DER EE DE-5000 driver was a very thin wrapper around the
ES51919 LCR meter chipset. None of its source was specific to the
deree-de5000 device. In fact it contained code for all currently
supported LCR meters, and it's expected that all LCR meters which
will get added in the future will fit in as well.

Follow the serial-dmm model. Rename the src/hardware/deree-de5000/
directory to serial-lcr/. Update the configure logic. Although the
source directory and the configure option are named serial-lcr, the
LCR meter still is used by specifying the "deree-de5000" device driver
(which just happens to reside in the serial-lcr driver sources, among
others).

HACKING: Improve description of Doxygen conventions.

serial-dmm: add DMM entry for Metrix MX56C (ASYC-II based)

dmm: introduce support for ASYC-II 16-byte protocol in PRINT mode

Introduce an asycii.c source file (modelled after metex14.c) which
implements support for the 16-byte protocol of the ASYC-II multimeter
chipset (RX only, when the PRINT button was pressed).

Consistently use the "PeakTech" vendor name spelling.

(as per vendor website, and also to be consistent with our wiki)

Bindings: Link C++ code with gnustl_shared if it exists (Android)

Java: Use correct JNI function when calling Vector.add

fx2lafw: fix device product string check

Signed-off-by: Vlad Ivanov <redacted>

fx2lafw: warn on fail to open plausible devices

Instead of silently ignoring all devices that fail to open.

This fixes bug #867.

Signed-off-by: Karl Palsson <redacted>

Makefile: fix for #865.

Buildsystem wants CXX to be defined as $(CXX).
Otherwise it fallbacks to default value, which does not contain
"-std=c++11" statement.

Other changes (like CC=$(CC) and CFLAGS=$(CFLAGS) instead of CXX ones)
is not directly fix the issue, but fix cases, where CFLAGS (and CC)
differs from CXX* ones, so it could lead to similar errors in the future.

Bindings: Make Ruby bindings build with Ruby 2.0

The alias "rb_ary_new_from_args" for "rb_ary_new3" was not introduced
until in Ruby 2.1.

deree-de5000: add driver item for the Peaktech 2170 model

Register another driver for the Peaktech 2170 LCR meter, which is
based on the ES51919/ES51920 chipset, too.

deree-de5000: prepare to add more ES51919 based LCR meters

The "deree-de5000" driver is a very thin wrapper around the ES51919
chipset. We expect more models from other vendors to use that same
support code.

Model the registration of vendor/model combinations after the serial-dmm
approach. Register the DER EE DE-5000 device as the currently only
member in a list of drivers which all use the ES51919 chipset (no model
specific routines are registered in the absence of support for other LCR
meter chips).

This commit does not change the driver's behaviour nor the set of
supported hardware. It prepares the addition of more drivers in the
future.

serial-dmm: Expand a code comment.

serial-dmm: comment nit on the UART bitrate for ES519xx chips

Factor out identical comments on the UART bitrate of ES519xx based
multimeters. These probably got copied from the first item as of 2012
when new items were added in 2014 (the added devices were from the
same vendor and rebadged).

Expand on the fact that the bitrate still is within spec, and does not
harm at all. Strictly speaking the comment could get dropped.

serial-dmm: sort the list of device drivers (part 12, vc870)

This commit puts 'vc870' meters into one group. Which completes the
series of commits which sort the list of supported serial DMMs.

serial-dmm: sort the list of device drivers (part 11, sort ut71x)

This commit sorts items in the 'ut71x' group. This is separated from
collecting the group to reduce the diff size and simplify verification.

serial-dmm: sort the list of device drivers (part 10, group ut71x)

This commit puts 'ut71x' meters into one group. Item order is kept to
reduce the diff size and simplify verification.

serial-dmm: sort the list of device drivers (part 9, rs9lcd)

This commit puts 'rs9lcd' meters into one group.

serial-dmm: sort the list of device drivers (part 8, sort metex14)

This commit sorts items in the 'metex14' group. This is separated from
collecting the group to reduce the diff size and simplify verification.

serial-dmm: sort the list of device drivers (part 7, group metex14)

This commit puts 'metex14' meters into one group. Item order is kept to
reduce the diff size and simplify verification.

serial-dmm: sort the list of device drivers (part 6, fs9922)

This commit puts 'fs9922' meters into one group.

serial-dmm: sort the list of device drivers (part 5, sort fs9721)

This commit sorts items in the 'fs9721' group. This is separated from
collecting the group to reduce the diff size and simplify verification.

serial-dmm: sort the list of device drivers (part 4, group fs9721)

This commit puts 'fs9721' meters into one group. Item order is kept to
reduce the diff size and simplify verification.

serial-dmm: sort the list of device drivers (part 3, es519xx)

This commit puts 'es519xx' meters into one group.

serial-dmm: sort the list of device drivers (part 2, dtm0660)

This commit puts 'dtm0660' meters into one group.

serial-dmm: sort the list of device drivers (part 1, bm25x)

The previous implementation seems to have added drivers in their "order
of appearance". Start sorting the rather long list, to simplify several
tasks: Add new entries as more drivers get written, find existing items
during research, identify and compare similar models during maintenance.
As a byproduct, there will be no doubt about where to put things during
future work :) and duplicates will be spotted immediately.

This commit puts 'bm25x' meters into one group. And comments on the sort
order and motivation for sorting the table.

es51919 lcr: unbreak channel setup after successful detection

Commit 6bcb3ee8763bb introduced initial support for the Cyrustek ES51919
chipset. Its setup_channels() routine used to init a variable to assume
failure, then a loop added channels and changed the value to success.

Commit 5e23fcab889c6 changed channel setup to never fail, but kept the
initialization with an error code. Which prevented the operation of
successfully detected LCR meters.

Remove the no longer needed variable, instead always return success from
an operation which cannot fail.

Fixes: 5e23fcab889c6 "Simplify channel creation."
Signed-off-by: Gerhard Sittig <redacted>

serial-dmm: add support for Peaktech-3330 (based on FS9721)

Add another DMM entry for Peaktech-3330, which is based on the FS9721
chipset. Support was tested with the CP210x based USB cable.

Signed-off-by: Gerhard Sittig <redacted>

output/ascii: add support for user configurable character set

Since tastes and requirements might differ, introduce support for a
user specified character set in the construction of ASCII art graphs
of signal levels. The syntax is "charset=<low><high>[<fall><rise>]",
the default remains backwards compatible with existing consumers.

In comparison to assuming a fixed character set, this change addresses
several distinct aspects:

Users can adjust the output for "higher visual contrast", or "straight
lines" instead of dotted patterns, or "increased difference in height"
for low and high signal levels, or "filled" (block like, "wall of text")
appearance of periods with high levels. User adjustable characters are
needed, as no single fixed set can satisfy the differing expectations.
Perception of the output heavily depends on specific terminals and fonts
in use.

Then there is the issue of levels versus edges, and how their timing
relates. By default edges are drawn at a point in time where the signal
was sampled and was deteremined to already _have_ changed and have
settled to the new level, which means that the position of edges in the
resulting graph might be off by up to one sample period. Strictly
speaking, the available set of samples only contains levels, and does
not hint where exactly an edge might have occured. Though this might be
considered rather nitpicky, representing the graph without edges does
better reflect the input data, and might simplify postprocessing.

Compare the previously only supported format (still the default, -O ascii):

  1:...................................................../""""""""""""""""""""
  1:""""""""""""""""""""""""""""""""\.........................................
  1:..........................................................................

to those example alternatives:

  $ sigrok-cli -i file.sr -O ascii:charset=_\"\\/
  1:_____________________________________________________/""""""""""""""""""""
  1:""""""""""""""""""""""""""""""""\_________________________________________
  1:__________________________________________________________________________

  $ sigrok-cli -i file.sr -O ascii:charset=_\"
  1:_____________________________________________________"""""""""""""""""""""
  1:""""""""""""""""""""""""""""""""__________________________________________
  1:__________________________________________________________________________

  $ sigrok-cli -i file.sr -O ascii:charset=_^
  1:_____________________________________________________^^^^^^^^^^^^^^^^^^^^^
  1:^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^__________________________________________
  1:__________________________________________________________________________

  $ sigrok-cli -i file.sr -O ascii:charset=_M
  1:_____________________________________________________MMMMMMMMMMMMMMMMMMMMM
  1:MMMMMMMMMMMMMMMMMMMMMMMMMMMMMMMM__________________________________________
  1:__________________________________________________________________________

  $ sigrok-cli -i file.sr -O ascii:charset=_X
  1:_____________________________________________________XXXXXXXXXXXXXXXXXXXXX
  1:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX__________________________________________
  1:__________________________________________________________________________

Signed-off-by: Gerhard Sittig <redacted>

udev: Add comment about Rocktech BM102.

udev: Add DreamSourceLab DScope VID/PID.

udev: Update for new post-firmware Hantek 6022BE VID/PID.

hantek-6xxx: Add "fx2lafw-" prefix to the firmware files.

hantek-6xxx: Update driver to use the USB product version field.

We now require the use of the latest fx2lafw firmware which uses the
same USB VID/PID (1D50:608E) for the Hantek 6022BE and the variants
and rebadges of that device (e.g. the SainSmart DDS120).

The variants can be distinguished via the USB product version field.

agilent-dmm: style improvement

agilent-dmm: add support for Log-* data_source for U128x

agilent-dmm: rework job management

This allows much faster and configurable sampling rate, and faster
reaction to function switch.
This also gives a more repeatable job ordering and more reliable
query/reply association.

agilent-dmm: prepare config handling to easily receive more options

analog: use SI prefix only with units that accept SI prefixes

agilent-dmm: fix handling of continuity mode for U128x

agilent-dmm: add support for pulse width and duty cycle on U128x

analog: use correct unit for dBm/dBV

agilent-dmm: add support for dBm/dBV modes

agilent-dmm: add support for reading secondary display and temperature

tests: relax the "version text" length check, accept longer strings

The version text length check fails for git setups that use more digits
in abbreviated hashes, as is recommended by e.g. the Linux kernel project.

Raise the upper limit for acceptable version strings, and add comments
on how the limits were determined. The test still might fail in setups
of slightly different configuration, but now it's easier to see why the
test failed, and how to adjust the test.

Signed-off-by: Gerhard Sittig <redacted>

asix-sigma: fix buffer length check in register write helper

Fix the array size check in the sigma_write_register() routine. The
'len' parameter specifies the number of bytes to write, while the 'buf'
array holds one nibble per array item.

The previous implementation (commit e8686e3ae36c1) switched to a
constant size and made the buffer large enough so that no existing
request would exceed the buffer, fixing an overflow that was present
before that commit. But the most recent size check was incomplete and
might erroneously succeed for larger amounts of write data.

It's assumed that the issue which gets addressed here never occured in
practice. The constant-size buffer could hold up to 39 bytes of input
data in their transport representation, while the largest data that was
passed to the write routine is six bytes (trigger LUT params).

Fixes: e8686e3ae36c1 "asix-sigma: Avoid use of variable length arrays"
Signed-off-by: Gerhard Sittig <redacted>

asix-sigma: store "limit samples" value, re-determine "limit msecs" period

The driver internally implements the "limit samples" feature by means of
the "limit sample period" approach. Determination of the corresponding
period of time for captures depends on the sample rate as well as the
maximum sample count, and thus needs to be re-done when either setting
changes.

Introduce a "limit_samples" variable so that the value is available when
needed later. As a byproduct the parameter can be retrieved now (get).

Add comments to the sigma_set_samplerate() routine's sections, since
quite a bit is happening there, and interacts with other locations.

Signed-off-by: Gerhard Sittig <redacted>

asix-sigma: fix out-of-range access to the samplerates[] array

Commit 2c9c0df86eaf removed the sentinel from the samplerates[] array,
but did not adjust the test which checked whether a rate is listed in
the set of supported rates. This could result in an out-of-range access
beyond the array's last item.

Fix the "listed?" check after iterating the table of supported rates.
Cope with either presence or absence of a sentinel in the array.

Address some more style nits while we are here. Rename an identifier
for a local variable which unintentionally might suggest that it would
be a preprocessor macro (all-caps). Reduce redundancy in data type
references as well as in the determination of the array size.

Signed-off-by: Gerhard Sittig <redacted>

asix-sigma: update comments in firmware download code paths

The current implementation of the ASIX Sigma firmware download contains
comments which express uncertainty. Rephrase them, no magic is involved.

Discuss the polarity of the CCLK hardware signal. Which shall eliminate
potential concerns in future reviews or maintenance.

This commit only updates comments, and does not change behaviour.

Signed-off-by: Gerhard Sittig <redacted>

Doxyfile*: Set GENERATE_TODOLIST to NO.

We don't really need or use this. Bugs/issues should go into Bugzilla.

demo: File naming consistency changes.

hantek-dso: File naming consistency changes.

fluke-dmm: File naming consistency changes.

agilent-dmm: File naming consistency changes.

resource: Improve logging output.

Don't show duplicate lines (per default) such as

  sr: resource: Failed to locate 'saleae-logic16-fx2.fw'.
  sr: resource: Failed to open resource 'saleae-logic16-fx2.fw'.

The first one is now an sr_dbg() instead of sr_err().

Also, mention that a higher loglevel will give more information as to
where the backend is looking for resources / firmware files.

This fixes bug #806.

output/csv: Add an option to output units for column labels.

This change tweaks the CSV output module to change the label
setting from on/off to units/channels/off, where channels is the old
on behavior, and units uses the meaning field to generate the column
label - except for the generated Time column, which uses the label from
the X axis when it's generating gnuplot output.

rigol-ds: Add DS1074Z Plus and DS1104Z Plus.

This was successfully tested on a DS1074Z Plus.

contrib: Drop all example gnuplot scripts.

These files (or at least similar ones) can now be generated by the
CSV output module.

output/gnuplot: Remove, obsoleted by improved CSV module.

We no longer need a gnuplot output module, the CSV module can output
gnuplot-compatible data now (and it can also generate .gpi files).

csv: Fix a segfault due to a g_malloc() allocating too few bytes.

csv: Fix a segfault when using non-hardware input.

New all-singing, almost all dancing, csv output module.

 - It now handles more than one analog value correctly - at least from the
   demo driver.
 - Add column headers from channel names.
 - Add a row dedup capability.
 - Add a sample time column.
 - Add a frame end formatting (for gnuplot).
 - Made almost all formatting controllable or at least optional.
 - Fix it so we can mix analog and digital values.
 - Add outputting a gnuplot script for the data.
 - Count actual channels, not just mine, to find end of sample.
 - Add trigger option (untested).

fluke-dmm: Fix two compiler warnings.

  src/hardware/fluke-dmm/fluke.c:312:24: warning: implicit conversion from \
  enumeration type 'enum sr_unit' to different enumeration type 'enum sr_mq' \
   [-Wenum-conversion]
          devc->mq = devc->unit = devc->mqflags = 0;
                   ~ ~~~~~~~~~~~^~~~~~~~~~~~~~~~~~~

  src/hardware/fluke-dmm/fluke.c:312:40: warning: implicit conversion from \
  enumeration type 'enum sr_mqflag' to different enumeration type 'enum \
  sr_unit' [-Wenum-conversion]
          devc->mq = devc->unit = devc->mqflags = 0;
                                ~ ~~~~~~~~~~~~~~^~~

es51919: Fix a compiler warning.

  src/lcr/es51919.c:538:73: warning: comparison of unsigned enum expression \
< 0 is always false [-Wtautological-compare]
    if ((analog->meaning->mq = parse_mq(pkt, is_secondary, pkt[2] & 0x80)) < 0)

strutil.c: Fix a Doxygen warning.

Fix various sample/time limit regressions.

These were accidentally introduced when the sw_limits helpers were added.

gmc-mh-1x-2x: Shorten some code by using the ternary operator.

Remove some unneeded double-spaces.

(also perform some other minor whitespace fixes while at it)

device.c: Whitespace/cosmetics and typo fixes.

analog.c: Whitespace/cosmetics and typo fixes.

HACKING: Prefer git pull requests over mailing list patches.

Also, drop the reference to gitorious.org (no longer available).

Have remaining drivers default to digits=2 for analog values.

The default so far was 0, which meant there would be no significant
digits at all, yielding results that looked strange/wrong to the user.

Long-term all remaining drivers should be fixed to use the actual,
correct digits and spec_digits values according to the device's
capabilities and/or datasheet/manual. Until that is done, a default
of digits=2 is used as a temporary workaround.

This fixes the remaining parts of bug #815.

Document if or why sometimes digits/spec_digits is 0.

appa-55ii: properly set encoding digits also for log memory reception

analog: improve output readability by using SI prefix

gwinstek-gds-800: properly set encoding digits

hantek-dso: properly set encoding digits

hantek-6xxx: properly set encoding digits

hung-chang-dso-2100: properly set encoding digits

baylibre-acme: properly set encoding digits

tondaj-sl-814: properly set encoding digits

kecheng-kc-330b: properly set encoding digits

colead-slm: properly set encoding digits