pwm: Rephrase edge and period detection, eliminate internal state

With the simplicity of PWM waveforms and the convenience of the v3 API,
there is no need to maintain internal state. After the start of the
first period was determined based on the input signal's polarity, any
period is defined by just the next two edges, and the next period is
immediately to follow.

Drop support for PD API version 2.

All decoders must be of PD API version 3 now.

Mark all stacked decoders as being PD API version 3.

This is not really relevant for stacked PDs currently (they can be used
unmodified with either PDv2 or PDv3 low-level decoders), but it'll allow
us to drop PDv2 support completely.

ir_rc5: Convert to PD API version 3.

dsi: Convert to PD API version 3.

dsi: Cosmetics, drop obsolete comments.

rgb_led_ws281x: Convert to PD API version 3.

lpc: Convert to PD API version 3.

wiegand: Convert to PD API version 3.

usb_signalling: Convert to PD API version 3.

dali: Change 'self.dali' to 'dali'.

dali: Convert to PD API version 3.

dali: Random cleanups, remove obsolete comments.

instance.c: Drop a few unneeded checks.

spi: Simplify some code chunks.

dmx512: Use a nicer 'dmx' pin name variable.

dmx512: Convert to PD API version 3.

pwm: Reduce indentation level.

pwm: Simplify waiting for initial edge.

session.c: Fix a compiler warning on Mac OS X.

  session.c:203:22: warning: format specifies type 'unsigned long long'
  but the argument has type 'guint64' (aka 'unsigned long') [-Wformat]
                          sess->session_id, g_variant_get_uint64(data));
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~
  libsigrokdecode-internal.h:103:44: note: expanded from macro 'srd_dbg'
  #define srd_dbg(...)    srd_log(SRD_LOG_DBG,  __VA_ARGS__)
                                                ^~~~~~~~~~~

configure.ac: Bump package version to 0.6.0.

0.6.0 will be the next major release. Bump now, so that
there is no confusion of tarball 0.5.0 and 0.6.0-git snapshots.

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 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
libsigrokdecode.so.3.0.0 to libsigrokdecode.so.4.0.0, the SONAME
(+symlink) becomes libsigrokdecode.so.4.

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

Various Doxygen fixes.

spi: Missing samplerate spec is not fatal

Check for the availability of a samplerate specification, but don't
abort in its absence. Lack of the samplerate only prevents the emission
of throughput annotations, but still allows decoding the clocked signal.

spi: Improve use of PD API version 3

Eliminate more instances where Python code tracked signal changes instead
of having common library code do the work. Reduce the number of boundary
crossings between library and decoder code (Python vs C), by inspecting
fewer input edges. Yet cope with the CS signal's being optional. Emit
identical annotations to the previous implementation for CS changes,
including the initial change "from None to 0/1". Sort the checks for
optional input signals at the top of decode() into a more natural order.
Improve and update comments.

This commit results in a more appropriate use of the PD v3 API in the
SPI protocol decoder.

gpib: Convert to PD API version 3

Have edges detected in common library code. Cope with optional initial
low level (without an edge) at the start of sample data. Handle the
optionally enforced processing at a specified sample number.

pwm: Convert to PD API version 3

Have edges detected in common library code.

spi: Convert to PD API version 3

Have edges detected in common library code. Move the test for presence
of optional channels out of the decode loop. Do inspect the very first
sample for pixel compatibility with the previous implementation.

HACKING: Update URL to Linux kernel coding style.

Rename eeprom93cxx decoder to eeprom93xx.

Not all EEPROMs of this series have (just) a 'c' in the name.

eeprom24xx: Don't make lists.py executable.

Drop trailing whitespace in various PDs.

Add srd_inst_initial_pins_set_all() and support code.

This allows frontends to set the assumed initial pins (i.e., the assumed
state of the pins before the first sample of a capture) to user-specified
values.

The assumed initial pins can be either low, or high, or "use same value
as the first sample of the capture".

The special self.initial_pins decoder attribute is now removed.

Rename maxim_ds28ea00 to ds28ea00.

None of the other PDs have a vendorname in the PD name.

struct srd_decoder: Add list of input/output decoder IDs.

Show lib versions in the debug output.

can: Skip stuff bit inspection where not applicable

Bit stuffing does not apply to the last fields of a frame, specifically
the CRC delimiter, the ACK, and the end-of-frame fields. Adjust the
respective bit handling logic.

This fixes bug #656.

can: Convert to PD API version 3

Don't inspect each individual sample in the Python based PD. Instead use
the backend's query API to detect the start of a frame and to advance to
the sample point position.

can: Add warnings for various invalid bits and fields.

sdcard_sd: reference latest command when displaying response

Replace the hardcoded value with the last cmd used. I'd think the whole
ACMD handling could be simplified if we make further use of this new
variable. But for now, let's keep it simple and make it work.

Signed-off-by: Wolfram Sang <redacted>

sdcard_sd: output CMD8 in cmd8-handler

Probably a typo, currently 'cmd0' gets pushed out.

Signed-off-by: Wolfram Sang <redacted>

timing: Drop obsolete self.oldpin variable.

timing: "normalize" negative times too

Use the same scale.

Signed-off-by: Karl Palsson <redacted>

timing: add edge-edge mode and delta calculation

Instead of only measuring the timing from any edge to any edge, provide
a mode to measure the times from falling->falling and rising->rising
edges. This works better to monitor timing of an IRQ pin for instance,
that drives one direction under hardware, and is only cleared by
software reading a value.

Include time delta measurements as an optional annotation to help track
jitter in measurements.

Signed-off-by: Karl Palsson <redacted>

timing: disable averaging if set to zero

The extra row of the average isn't always useful. Allow it to be
disabled by setting the average window to zero.

Signed-off-by: Karl Palsson <redacted>

Rename ade7758 decoder to ade77xx.

There are multiple devices in the ADE77xx series that are similar enough
to be supportable via this decoder in the future.

ade7758: Slightly shorten some code chunks.

Add an ADE7758 protocol decoder.

No value decoding, that can be fairly complicated.

Signed-off-by: Karl Palsson <redacted>

sdcard_sd: remove unused functions

putr2 is unused, so let it go.

Signed-off-by: Wolfram Sang <redacted>

eeprom93cxx: Improve longname.

microwire/eeprom93cxx: Use 'es' instead of 'se' abbrevation.

(for consistency with all other decoders)

eeprom93cxx: Update wrt Python output namedtuple usage.

eeprom93cxx: Shorten put_word() a bit.

Add a 93Cxx Microwire EEPROM protocol decoder.

This fixes parts of bug #931.

microwire: Use namedtuple in some more cases.

microwire: Use namedtuple for the Python output.

This has two advantages:

 - The Python output is always deterministic, which was not the case for
   the dict-based version since dict items have no guaranteed order in
   Python. This caused issues with the sigrok-test use-case.

 - The code is slightly more readable.

microwire: Drop some trailing whitespace.

microwire: Shorten decode() a bit.

microwire: Make Ready/Busy extra annotation classes.

microwire: Make the start bit an extra annotation class.

Add a Microwire protocol decoder.

This fixes parts of bug #931.

sdcard_sd: really show result of SET_BLOCKLEN

Now that self.arg is populated, we can finally use it.

Signed-off-by: Wolfram Sang <redacted>

sdcard_sd: always show CMD argument in hex

This is especially useful with the default handler, so you can better
understand the transfer if you are already familiar with CMD numbers and
their arguments. It makes it also easier to compare with the debug
output of the e.g. Linux Kernel.

Signed-off-by: Wolfram Sang <redacted>

sdcard_sd: don't interate over not implemented command

There is no handler for CMD4 yet.

Signed-off-by: Wolfram Sang <redacted>

onewire_link: (Re-)convert to PD API version 3.

onewire_link: Factor out some helper methods.

This avoids some boilerplate in the decode() method itself.

Implement new 1-Wire link decoder using time ranges

Rewrite of the 1-Wire link decoder.

Existing outputs are kept and new warnings are added.

Instead of sampling at fixed user defined time, time ranges as
specified by the "Book of iButton Standards" are used.

The user does not have to tweak the timing values anymore.

Overdrive speed is detected automatically.

This fixes bugs #666 and #926.

iec: Convert to PD API version 3

Don't show a harmless/confusing warning on stdout.

Some Python versions will lead to the following message on stdout currently:

  srd: Attribute Error: Failed to load decoder common: no 'Decoder' \
  attribute in imported module: 'module' object has no attribute 'Decoder'

This is a harmless (though confusing for users) warning, since "common"
is not an actual PD and it shouldn't be loaded as PD (it just has to
be present).

eeprom24xx: add Xicor X24C02 variant

dali: Use a slightly better variable name.

dsi: Use a slightly better variable name.

dsi: Small fix for the longname.

Add a DALI protocol decoder.

Add a DSI protocol decoder.

uart: Minor cosmetic changes.

uart: Use consistent order of steps when processing samples

Slightly rearrange some of the methods which are involved in UART frame
inspection. Use a consistent sequence of steps: Grab the signal's
current value, accumulate and process the information, emit respective
annotations, and advance to the next stage in the UART frame inspection.

uart: Remove redundant "reached bit" checks

After the decode() method got adjusted to call wait() with custom made
conditions and to check .matched[] before inspecting samples, the check
whether a bit time's sample point was reached has become obsolete.

uart: Improve robustness of query API result processing

Since either of the UART signals (RX, TX) is optional, and in the
absence of Decoder.wait() conditions that "will never match", we cannot
construct a constant layout. Instead we need to explicitly keep track of
which item in the list of wait conditions corresponds to which signal.

Once the index in the list of wait conditions is known, inspection of
samples can depend on the Decoder.matched[] attribute. Before this
change, redundant reached_bit() checks kept us from processing samples
that should not have been inspected. Tests pass before and after this
very commit.

uart: Reduce redundancy in sample inspection (state machine)

Factor out the logic which inspects samples that were provided by the
PD version 3 query API, and dispatches their processing depending on
the progress of UART frame inspection. "Unroll" a loop over the RX and
TX signals.

This commit replaces some complicated variable assignments by easier to
verify invocations.

uart: Convert to PD API version 3

Adjust the UART protocol decoder, to make use of the query based API.
Have edges detected and unrelated samples skipped by common code.

This implementation keeps some redundancy in place (like checking for
having reached specific sample numbers, while the backend managed that
for us). This approach reduces the diff and shall simplify review.

Only some common checks in decode() were moved to the start of the
routine, outside of the sample inspection loop.

uart: Minor readability nit (position of start bit in calculation)

Rephrase the bit slot index calculation for UART frames such that it
becomes more apparent whether a start bit is involved or whether an
array index needs adjustment due to Python range semantics.

This shall improve readability, and reduce the probability of off-by-one
errors during maintenance.

uart: Immediately skip reception of parity bits when not applicable

When the UART frame does not contain a parity bit, then immediately
advance to reception of stop bits after all data bits were received.

This eliminates the necessity to run the parity check routine when
parity does not apply in the first place. Without this change, some
"dummy" sample needs to get inspected for correct operation of the
state machine.

uart: Remove an obsolete unused routine

decoder: terminate .wait() and .decode(), join threads for v3 instances

Add support to terminate blocking .wait() and .decode() method calls of
v3 decoder instances. This terminates the decoder thread's main routine
and allows to release associated resources. Cope with requested as well
as unexpected termination of decode() calls. Add debug messages to
thread related code paths.

Make sure to unblock the main thread which feeds the decoder thread.
This unbreaks situations where decoders e.g. throw "need samplerate to
decode" exceptions.

Drain Python errors which might remain from the most recent .decode()
execution, to not affect other code paths. This avoids an issue where
the creation of a new decoder instance fails in the presence of errors
from a previous run.

This fixes bug #902.

configure summary: Show linker flags.

configure summary: Show whether shared/static build is enabled.

rgb_led_ws281x: Use self.samplenum.

This is currently just a cosmetic change, but will make the conversion
to the PDv3 API slightly easier and more readable.

Drop obsolete workarounds in PDs.

Some PDs were using a temporary workaround for (as it turned out) a
refcounting issue that was fixed in 066fbafdc3ba734a73b5f7fcfa1dbae67ddebf8a.

srd_decoder_load(): Drop dead code.

In 'except_out' the fail_txt variable is always non-NULL.

Fix memory leak in get_current_pinvalues()

The ownership of the tuple reference is transferred to the caller, so
the refcount should not be increased.

More refcounting fixes

PyList_SetItem steals a reference, so code calling that must either
transfer ownership or increase the refcount.

instance.c: Add a debug message for thread creation.

srd_inst_decode(): Slightly more verbose error message.

Fix examples to show abs_end_samplenum as exclusive

Return SRD_ERR_ARG from srd_inst_decode if samplenums are wrong

This validates the requirements that
* abs_start_samplenum continues where the previous decode ended
* abs_end_samplenum is not lower than abs_start_samplenum

Failure to meet these requirements will make v3 decoders crash.

Fix refcounting bug in set_new_condition_list()

py_conditionlist is an owned reference (it gets passed to Py_DecRef()
at the end), so we need to increment the refcount when assigning it
from the borrowed reference py_conds.

instance.c: fix a 'matched' vs 'matches' typo

The Decoder_wait() routine will populate the .matched attribute before
returning to the caller. The srd_inst_start() routine used to setup a
.matches attribute which is unexpected. Make both routines consistently
assign to 'matched' as that is what Python decoder implementations are
referencing.

Add an initial serial GPIB (IEC) decoder.