Bump package version to 0.5.2.

configure.ac: Bump libtool/library version from 5:0:1 to 5:1:1.

The libtool current:revision:age numbers change from 5:0:1 to 5:1:1
since no new APIs were added and no existing ones were changed or
removed. Thus, revision is incremented, current and age stay unchanged.

Details:
http://www.gnu.org/software/libtool/manual/libtool.html#Updating-version-info

This changes the library filename (e.g. on Linux) from
libsigrok.so.4.1.0 to libsigrok.so.4.1.1, the SONAME
(+symlink) remains the same, though (libsigrok.so.4).

Doxyfile: Set version to 0.5.2.

NEWS: Add list of user-visible changes so far.

Backport recent changes from mainline.

This includes all changes from

  4c660b46c11f8a84941194f60e4f48e57b0a86b7
  Makefile.am: Add missing src/serial_hid.h.

up to

  39ea7b7d390c4f1d4a697a40769ce364de9c97d0
  dmm/eev121gw: add missing scale items for sub display in power modes

This is possible since none of the changes above change or
remove public API calls of the library.

configure.ac: Bump package version to 0.5.1.

configure.ac: Bump libtool/library version from 4:0:0 to 5:0:1.

The libtool current:revision:age numbers change from 4:0:0 to 5:0:1
since new APIs were added (but no existing ones were changed or
removed). Thus, revision is set to 0, current and age are bumped.

Details:
http://www.gnu.org/software/libtool/manual/libtool.html#Updating-version-info

This changes the library filename (e.g. on Linux) from
libsigrok.so.4.0.0 to libsigrok.so.4.1.0, the SONAME
(+symlink) remains the same, though (libsigrok.so.4).

Doxygen: Update relevant @since tags to 0.5.1.

Doxyfile: Set version to 0.5.1.

NEWS: Add list of user-visible changes so far.

Revert API/ABI change for Context::create_analog_packet().

This is fine in libsigrokcxx mainline, but for the 0.5.x series we need
to remain API/ABI-compatible.

Backport recent changes from mainline.

This includes all changes from

  59cae77e28538120a472aca1aeee6b2c4465e77a
  serial_stream_detect(): Make a code comment more generic.

up to

  a7600dc5c7712c588f8a940293e50853c88706ca
  Makefile.am: Install MIME info file in $(datadir)/mime/packages.

This is possible since (almost) none of the changes above change or
remove public API calls of the library.

Doxyfile: Set version to 0.5.0.

Bump libtool version (not package version) to 4:0:0.

The last release (0.4.0) had the libtool version (current:revision:age)
set to 3:0:0. Since this release adds, removes, and changes interfaces,
the new version is 4:0:0.

http://www.gnu.org/software/libtool/manual/libtool.html#Updating-version-info

This changes the library filename (e.g. on Linux) from libsigrok.so.3.0.0
to libsigrok.so.4.0.0, the SONAME (+symlink) becomes libsigrok.so.4.

NEWS: Add list of user-visible changes so far.

Various Doxygen fixes.

Add a MIME info file (and icons) for sigrok session files.

File template by Stefan Brüns, thanks!

This fixes bug #857.

(the XML file is moved from PulseView to libsigrok since this is not
PulseView-specific)

Add a 48x48 PNG and a scalable SVG for the MIME type as well.

Install the XML file and in the icons in the respective standard paths.

Rename sigrok-logo-notext.png to libsigrok_112x112.png.

This is more specific and prevents any potential issues e.g. when
multiple distro packages might ship with a generic file like
sigrok-logo-notext.png that's supposed to be installed in the same place.

ruby bindings: Fix a compiler warning.

  bindings/ruby/classes_wrap.cpp:10481:1: warning: control may reach end
  of non-void function [-Wreturn-type]

Fix various -Wundefined-var-template clang warnings.

This fixes bug #915.

C++ binding: Fixup memory leak in input module receive() calls

The Input::send() method allocated glib strings and copied input data,
but only released the glib string container and leaked the actual string
content. This led to leaks in the size of the verbatim input file, which
is especially wasteful for uncompressed textual representations.

This fixes bug #976.

input/csv: Eliminate remaining memory leaks in error paths

When the processing of columns of text lines detected errors, the loop
was aborted and the routine was left, but allocated resources were not
freed. Fix the remaining memory leaks in the error code paths.

input/csv: Fixup datafeed chunk size calculation

The constant at the top of the source file is the number of samples in a
datafeed submission chunk. The previous implementation erroneously made
it the size in bytes. There is no need to round down the buffer size
according to the unit size.

output/csv: Nit, remove an unused loop iteration variable

The i variable is not used in the bottom loop in gen_header(). Remove it
to not obfuscate the purpose of the iteration.

input/csv: Send larger datafeed chunks, to speedup import

The previous implementation sent one sigrok session datafeed packet per
processed CSV line. This is rather inefficient for the CSV input module,
and triggers a dramatic performance loss in the srzip output format.

Communicate up to 128K samples within one datafeed packet. This fixes
bug #695.

Factor out repeated calculation of the unit size which is derived from
the channel count. Fix a minor memory leak in an error path while we are
here. (Other memory leaks in rare error paths remain with this commit.)

Suggested-By: Elias Oenal <redacted>

input/csv: Update developer comment (fix for last EOL marker)

input/csv: Accept absence of last end-of-line termination sequence

On the Windows platform it appears to be popular to _not_ terminate the
very last line in a text file. Which results in an unmet constraint in
the CSV input module and an internal exception in PulseView which aborts
program execution.

Cope with the absence of the text line termination sequence at the very
end of the input stream. Keep all other checks in place, such that only
completely received text lines get processed.

This fixes bug #635.

input/csv: Skip leading UTF-8 BOM in the input stream

This fixes bug #756.

input/csv: Add developer comment with TODO items

"Document" the current state of the implementation in the CSV input
module's source code. Discuss how text handling is non-trivial, which
approaches are available and how they have drawbacks.

Mention the lack of support for the import of analog data as well.

input/csv: Correctly skip over last processed end-of-line sequence

The CSV input module supports variable length end-of-line encodings
(either CRLF, or CR, or LF). When a bunch of accumulated text lines got
processed, do skip the corresponding number of characters after the end
of the last processed line.

This fixes one of the issues discussed in bug #635.

input/csv: Fix a false negative after successful import

The input module runs receive() and end() invocations which end up
calling process_buffer(). It's perfectly legal to call the process
routine with an empty accumulation buffer, especially when the process
routine was called from end().

This fixes a condition where PulseView raised a fatal error at the end
of a completed successful import.

Reported-By: Sergey Alirzaev <redacted>

input/csv: Re-order processing steps (column mode vs text line split)

Move an independent test for single/multi column operation out of a code
path that checked for and then processed text lines. This commit does
not change behaviour, but prepares a subsequent commit.

input/csv: Concentrate text line encoding in a single spot

Factor out a magic string literal which held a delimiter set yet could
be mistaken for an (assumed) fixed termination string. Concentrate the
determination of the end-of-line text encoding as well as the resulting
set of possible deliminters in one nearby location. The symbolic name
for the delimiter set eliminates the doubt on its purpose.

input/csv: Improve readability (bool expr vs assign, nested arrays)

Move variable assignments out of boolean condition checks. Factor out
repeated access to nested arrays. This shall improve readability.

HACKING: Update URL to Linux kernel coding style.

Drop trailing whitespace in various files.

Minor cosmetics.

uninstall: Remove empty libsigrok/libsigrokcxx include directories.

Change uninstall-local to uninstall-hook, since the latter is guaranteed
to run last (order is apparently not guaranteed for uninstall-local).

This fixes bug #861.

Demo: Convert white spaces to dashes for walking one/zero pattern

Bindings: Provide helper method that auto-converts analog

Bindings: Flesh out the analog payload bindings

Demo: Add walking one/walking zero pattern

asix-sigma: Silence a compiler warning (declared but not used)

The call site which referenced the variable was conditional (disabled
trigger support) but the variable declaration was not. Fix that.

asix-sigma: Use monotonic time not wallclock time

Switch from gettimeofday() to g_get_monotonic_time() calls.

This commit is based on work done by jry@ (but with reduced diff size).

asix-sigma: Handle sample memory wrap around (circular buffer)

Handle the case when the sample data memory was filled and has wrapped
around during acquisition. Download the respective part of the data
which is reliably available, only skipping a single 1KB row which might
contain either old or new data while it's not certain which it would be.

This will be essential when triggers later become available. Right now
it copes with user requests for sample counts that exceed the total DRAM
capacity. Instead the maximum available amount of data is provided.

Of course acquisition no longer gets stopped when the end of DRAM is
reached.

asix-sigma: Fixup the download of the last data acquisition chunk

Correctly determine the size of a download chunk for the last DRAM row
that's involved in the recent data acquisition.

This commit is based on work done by jry@.

This addresses bug #838 (trailing garbage).

It's assumed that the previously downloaded excess data was "swallowed"
by the sample count enforcement logic that was applied earlier, so the
(remainder of the) issue could have gone unnoticed, unless some other
termination condition than sample count was used.

asix-sigma: Comment on RLE decompression upon data retrieval

Rephrase and shorten a comment on how RLE decompression works. Drop the
part of the comment which is not related to (de-)compression.

asix-sigma: Remove an unused variable

asix-sigma: Adjust clock configuration upon acquisition start

Configure the samplerate clock and channel count during acquisition
start in identical ways for 50MHz, 100MHz, and 200MHz modes.

This part was inspired by work done by jry@ yet was addressed in
different ways (no exception, do everything in every mode the same way).

Eliminate a portability issue in the previous implementation. Make sure
to send the configuration bytes in the correct order to the hardware.
Don't typecase a struct reference to a bytepointer and hope that the
internal memory representation might fit the external hardware's idea.

asix-sigma: Document the sample memory layout

Add a comment about sample memory organization in a central spot. This
concentrates knowledge which otherwise would be spread across several
locations all over the driver's codebase, yet is essential to have at
hand during maintenance.

All of the information was determined/updated by jry@ with the help of
Ondrej at Asix when he did lots of fixes and improvements to asix-sigma.

asix-sigma: Enforce optionally specified sample count

The Asix Sigma hardware does not support a sample count limit. Instead
this optional input parameter gets mapped to a sample time, and some
slack for hardware pipelines and compression gets added. When data
acquisition completes and sample data gets downloaded, chances are that
there is more data than requested by the user.

Do enforce the optional sample count limit. Stop sending data to the
sigrok session when the configured number of samples was sent.

This commit is based on work done by jry@.

This fixes bug #838.

asix-sigma: Acquisition stop, symbolic identifiers for mode register fields

Enhance how the data acquisition is stopped. Wait for the hardware to
flag the successful completion of data retrieval as well as flushing
through hardware pipelines.

Use symbolic identifiers for the mode register's fields (for read as
well as write access).

This commit uses part of a code update to better match the documentation
done by jry@, but not all of it to reduce the size of the commit.

asix-sigma: Nit, separate declaration from assignment statements

Minor adjustment for improved readability. Don't hide assignments in
variable declarations. Move initialization of some variables closer to
related evaluation or subsequent processing. Break a complicated looking
roundup expression into several short steps.

asix-sigma: Fix a register addressing bug (non-issue)

Fix how the READ_ID register index was passed to the hardware access.
Addresses are sent in nibbles, so shift by eight is wrong here. No harm
was done, as the register's index is zero.

asix-sigma: Only download firmware when necessary

The Asix Sigma driver is aware of three firmware images, which are
required for acquisition with up to 50MHz, 100MHz, and 200MHz. The
previous implementation always downloaded the corresponding firmware
image whenever the sample rate has changed, which was redundant.

Skip the download when the new samplerate uses the same firmware as the
previously selected samplerate did. This results in faster responses in
the GUI when the samplerate selection changes.

Move assignments out of the variable declaration block for improved
readability while we are here.

asix-sigma: Properly decode data gathered at 100 and 200 MHz

The hardware provides captured data at a maximum rate of 16bits per 20ns
(50 MHz). For samplerates of 100 and 200 MHz one individual 16bit entity
contains multiple samples for a reduced number of channels. The bits of
several sample points are interleaved within the 16bit entity.

This commit is based on work done by jry@ who fixed a lot of issues with
the help from Ondrej at Asix.

This fixes bug #840.

asix-sigma: Stabilize channel assignment for different samplerates

Adjust the interpretation of acquired sample data such that regardless
of 50/100/200MHz samplerate the assignment of LA pins to sigrok channels
remains stable.

asix-sigma: Factor out access to sample data and session data

Introduce helper routines to access the sample data that is provided by
the ASIX hardware, as well as the buffer which accumulates logic data
before it gets sent to the session's datafeed.

This hides endianess issues from call sites, and prepares access to
memory layout which varies with sample frequencies.

This commit is based on work done by jry@.

asix-sigma: Disable support for triggers, they don't work right now

This works around bug #359. Triggers currently are not operational for
Asix Sigma. Don't claim support in the driver so that UIs won't use the
feature. Yet allow research in this issue, by concentrating the switch
for the feature's support in a central location.

Add/update a comment and unobfuscate an error code path while we are here.

asix-sigma: Nit, remove redundant USB VID/PID declaration

Both the .c and the .h file declared the same identifiers for USB
properties of ASIX hardware with identical values. Remove the .c
incarnation and keep the .h content, as the names are used in api.c
as well as protocol.c sources.

asix-sigma: Improve sample time estimation, consider hardware pipeline

Introduce a separate routine which maps sample counts and sample period
to an elapsed sample time after which acquisition shall get stopped.
Add some more time to make sure the most recent captured data has passed
the hardware pipeline and is available for download.

This commit is based on work done by jry@.

asix-sigma: Fixed RLE decoder

When "tsdiff < EVENTS_PER_CLUSTER" we don't want "tsdiff - EVENTS_PER_CLUSTER"
(a negative number) to be treated as (int).

Submitted-By: jry <redacted>
[ gsi: massaged for mainline submission ]

Add APIs to query libsigrok build information.

serial-dmm: Use a custom dummy struct for m2110.

This DMM/parser is not related to metex14, don't use that struct.

uni-t-dmm: Fix incorrect Tenma 72-7745 list entry.

This is a regression from f05406117d67de3bd8aa5f904573bdd5d7ba401f.

uni-t-dmm: Add missing special cases for some ES519xx protocols.

fx2lafw: Always enable wide sampling for dslogic firmware

Fixes regression in 8399f68a3.

Ref: https://sourceforge.net/p/sigrok/mailman/message/35780588/

Signed-off-by: Angus Gratton <redacted>

ut71x: Fix incorrect resistance values on some DMMs.

The resistance values of some DMMs were incorrectly reported due to a
missing factor of 10 in the calculations.

Tested on Voltcraft VC-920/VC-940 and Tenma 72-9380A/72-7730/72-7732.

demo: Retain the default of 8 digital channels for now.

demo: support up to 128 logic channels, enable the lower 8 by default

Bump the number of supported logic channels from 8 to 128. This is
mostly motivated to test the 64 channels limit which some of the
components/subprojects of the sigrok project might have (input/output
modules, user interfaces).

Only automatically enable the first 8 of the 128 total logic channels,
i.e. default to the previous behaviour. Prepare to only enable part of
the set of analog channels, but stick with their being active by default
as well.

Factor out the choice for the default logic pattern, too. This allows
for easier adjustment of the default configuration, when settings are
concentrated in a single spot.

demo: add "cable squid" logic waveform (works-with logo, many channels)

Extend the demo driver, add another waveform choice for logic channels.
Create a "cable squid" logo representation which occupies a large number
of channels.

This pattern occupies 128x128 pixels. Unlike the 'sigrok' pattern it
gets repeated when more channels are involved, but is not shifted in the
repetition.

ut71x: Fix float printing issue in a debug message.

Old:
ut71x: Applying exponent -12, new value is 0.000000.
P1: 1.500 nF AUTO
P1: 1.500 nF AUTO

New:
ut71x: Applying exponent -12, new value is 1.5e-09.
P1: 1.500 nF AUTO
P1: 1.500 nF AUTO

This fixes bug #700.

Virtual session: Workaround for SR_CONF_CAPTUREFILE (#944)

This is a (hopefully temporary) workaround for the
SR_CONF_CAPTUREFILE mechanism. The value for
vdev->capturefile is set by this, however only once
via stream_session_data().
During stream processing in stream_session_data(),
capturefile may receive new values - e.g. when there
are multiple logic files or if there is analog data.
With that, the initially set capturefile is overwritten.

When re-loading the file, we are then running into
issues because we don't know what the initial value was.
As all .sr files use "logic-1" by default and, we
simulate the behavior of stream_session_data() and
assign this name to capturefile if there are logic
channels present.

With this change, all three kinds of files reload
as expected: logic only, analog only and mixed signal.
For this reason, it's a short-term fix for #944.

Virtual session: rename num_channels to num_logic_channels

hantek-6xxx: Only list DC coupling once.

Avoid incorrect indexing and the follow-up segfault.

This fixes bug #822.

rigol-ds: Handle digital channels correctly for MSO2000A series.

The handling of the digital channels for this series is somewhere
between that of the DS1000D series (PROTOCOL_V2) and the MSO1000Z
(PROTOCOL_V4).

The :LA command set is similar to that of V4, but the LA data has to be
requested with :WAV:SOUR:LA and arrives in interleaved form like V2.

None of these changes should affect other models. They only affect the
case of PROTOCOL_V3 with digital channels, which occurs only for the
MSO2000A series.

hantek-6xxx: Fix coupling selection.

Due to an uninitialized variable, switching to/from AC/DC coupling
(on models that support this) was not working.

This fixes bug #836.

rigol-ds: Add model entries for MSO2000A series.

This should be sufficient to fully support these models, unless there
are protocol differences for the digital channels.

This fixes bug #778.

output/csv: get proper index for input channels

'j' is the loop variable for channels, not 'ch'.

This fixes parts of bug #844.

Signed-off-by: Wolfram Sang <redacted>

output/csv: fix a minor leak

Signed-off-by: Wolfram Sang <redacted>

output/csv: fix segfault with logic channels

'i' was iterating in steps of unitsize. However, the destination array
was also indexed with it, but it is of u8 type. Let 'i' run bytewise and
only multiply with unitsize when we need it.

This fixes parts of bug #844.

Signed-off-by: Wolfram Sang <redacted>

output/csv: fix segfault when naming logic channels

'j' is the loop variable for channels, not 'i'.

This fixes parts of bug #844.

Reported-by: Maxim Sloyko <redacted>
Signed-off-by: Wolfram Sang <redacted>

output/csv: Fix a compiler warning.

src/output/csv.c: In function 'dump_saved_values':
src/output/csv.c:461:6: warning: format '%lu' expects argument of
type 'long unsigned int', but argument 3 has type 'uint64_t' [-Wformat=]
      ctx->sample_time, ctx->value);
      ^

rigol-ds: Send *OPC? after commands that don't return a value.

Fixes #933.

We'd already had this problem elsewhere and thus have this wrapper function
that does this where necessary. It just wasn't in use on these two call sites,
which was causing timing problems when used over tcp-raw or VXI transports.

hameg-hmo: Add support for Hameg HMO3524

output/vcd: minor nit, remove unused variable

minor nit, fixup whitespace in libsigrok.h

De-init vdev->capturefile when done

Without doing this, re-reading the input file
results in a segfault as the internal state
machine becomes confused.

openbench-logic-sniffer: fix acquisition restart with trigger enabled

With trigger enabled, and with PulseView, a second (or more) acquisition
starts immediately instead of blocking. It's mandatory to try several times
to have a correct behavior.

According to http://mygizmos.org/ols/Logic-Sniffer-FPGA-Spec.pdf section 2.3.1
p.8, the Openbench Logic Sniffer must be reset before each arm command.

This fixes bug #809.

Signed-off-by: Gwenhael Goavec-Merou <redacted>

openbench-logic-sniffer: add a function to handle reset command

Openbench Logic Sniffer reset is a little more complex than a simple send.
To avoid code duplication, this patch adds a new function dedicated to
this task.

Signed-off-by: Gwenhael Goavec-Merou <redacted>

README: Fix incorrect gcc/clang minimum versions.

https://gcc.gnu.org/projects/cxx-status.html#cxx11
https://clang.llvm.org/cxx_status.html

scpi-pps: Add initial support for R&S HMC8043

contrib/z60_libsigrok.rules: Use 660 permissions.

It doesn't really make sense to allow anyone to read (but not write)
USB devices.

This fixes parts of bug #665.

contrib/udev: add note on required name for systemd

Systemd needs the file to be numbered the right way, document this
properly.

See also:
https://lists.debian.org/debian-devel-announce/2016/11/msg00008.html
http://openocd.zylin.com/2804

This fixes parts of bug #665.

Signed-off-by: Karl Palsson <redacted>

contrib/udev: add TAG+="uaccess" for systemd

Instead of replacing the group=plugdev, simply add the TAG as well.
This allows (in most cases) the same file to be used happily on systemd
and older group based systems. Some systems may produce warnings about
non-existant groups, but it remains functional. Approach inspired by
that taken by the OpenOCD project.

This fixes parts of bug #665.

Signed-off-by: Karl Palsson <redacted>

uni-t-ut32x: Accept SR_CONF_CONN, fixing scan.

session_driver.c: Increase chunk size for slightly better performance.

Increasing the chunk size from 512ksamples to 4Msamples leads to
slightly faster session file loading from sigrok session (*.sr) files
in frontends, while not looking too "chunky".

The performance increase is not really massive, but still noticeable.
A further increase to, say, 10 or 100Msamples shows no further
noticeable improvements.

fx2lafw: Only sample/send analog data if analog channels are enabled.

fx2lafw: Drop unused devc->ch_enabled.

fx2lafw: Use wide_sampling only if necessary.

This changes the fx2lafw code to only enable the wide_sampling (16bit)
method, if at least one of the higher eight channels is enabled. This
has the benefit, that we can use higher samplerates on 16bit LA
devices if we use only the first eight channels.

The wide sampling is also enabled if we have one or more analog
channels.

Signed-off-by: Jan Losinski <redacted>