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.

Clarify that {start,end,cur}_samplenum are absolute numbers.

instance.c: Fix a compiler warning.

  ../instance.c: In function ‘srd_inst_find_by_id’:
  ../instance.c:485:3: warning: suggest parentheses around assignment used as truth value [-Wparentheses]
     if (di = srd_inst_find_by_id_stack(inst_id, tmp))
     ^~

Look up instances by ID in the full stack

srd_inst_find_by_id() previously only searched for instance IDs at the
bottom of any stacked decoders. Make it properly search all stacks,
just like srd_inst_find_by_obj() and more usefully when trying to
generate unique instance IDs.

No external API change, only the explicit behaviour of the API.

This fixes parts of bug #868.

Signed-off-by: Karl Palsson <redacted>

Support adding multiple instances of a decoder

srd_inst_new() used the decoder ID as the instance ID, preventing the use
of multiple instances of the same decoder in the same session. Simply
append a numerical suffix to later instances to allow more.

Required changes to cleanup to reliably free all memory. Valgrind checked.

This fixes parts of bug #868.

Based on original work by: Soeren Apel <redacted>
Signed-off-by: Karl Palsson <redacted>

Added intial ADF4350/1 decoder

z80: Convert to PD API version 3 (brute force)

This implementation technically uses v3 API calls, but has yet to come
up with appropriate wait() conditions, to spend less time in the decoder
and have more tedious work done in the backend.

t55xx: Convert to PD API version 3

sdcard_sd: Convert to PD API version 3

qi: Convert to PD API version 3

ps2: Convert to PD API version 3

mdio: Convert to PD API version 3

em4305: Convert to PD API version 3

em4100: Convert to PD API version 3

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.

configure.ac: Also check for Python 3.6.

avr_pdi: Don't pass self.samplenum (use it), simplify code.

avr_pdi: Convert to PD API version 3.

Switch to the v3 decoder API: The decode() methods takes no arguments,
instead it calls wait() and has common code find edges on input signals.

avr_pdi: introduce decoder for Atmel Program and Debug Interface

Introduce a decoder for Atmel's proprietary programming and debugging
interface which got introduced with ATxmega chips. This implementation
supports the UART style physical (two wires PDI_CLK and PDI_DATA).

usb_power_delivery: Convert to PD API version 3.

tlc5620: Convert to PD API version 3.

timing: Convert to PD API version 3.

swd: Convert to PD API version 3.

stepper_motor: Convert to PD API version 3.

spdif: Convert to PD API version 3.

parallel: Convert to PD API version 3.

onewire_link: Convert to PD API version 3.

jtag: Convert to PD API version 3.

jitter: Convert to PD API version 3.

ir_nec: Convert to PD API version 3.

i2s: Convert to PD API version 3.

i2c: Convert to PD API version 3.

guess_bitrate: Convert to PD API version 3.

dcf77: Convert to PD API version 3.

aud: Convert to PD API version 3.

am230x: Convert to PD API version 3.

Add support for the new query-based PD v3 decoder API.

For the time being, both APIs (2 and 3) will remain supported until all
decoders have been converted to API version 3. Then, support for API
version 2 will be dropped.

Decoders using PD v3 API can benefit from both readability improvements
as well as performance improvements. Up to 10x speedup has been measured
in some situations (depends a lot on the decoder, the amount of data,
the amount of edges in the signals, the amount of oversampling etc. etc.).

This is only the first set of (basic) performance improvements for
libsigrokdecode, there are various additional opportunities for further
changes to improve performance.

This changeset has been tested to survive a run of all the test-cases in
the sigrok-test repo without issues (for the converted PDs), however it is
not very well-tested yet, so there might be regressions that need to be
addressed.

repo mgmt: git ignore compiled Python bytecode files

build support: sort list of installed items, factor out pretty printer

Alpha-sort the list of installed items, to support developers which scan
the list for newly added items. Factor out the logic which pretty prints
installed items while maintaining a maximum screen output line length.

valgrind: free channels

Signed-off-by: Karl Palsson <redacted>

valgrind: safely iterate lists

Old versions triggered valgrind errors as the API method to remove an
entry modifies the list that was being iterated.

Signed-off-by: Karl Palsson <redacted>

spiflash: Major refactoring and annotation improvements.

spiflash: Use OrderedDict for cmds, more readable annotation indices.

spiflash: Initial RDSR2 implementation (incomplete).

This is not entirely correct yet, will be fixed later.

spiflash: Implement WRSR command.

spiflash: Add FIDELIX FM25Q32 metadata.

spiflash: Remove hardcoded Macronix references.

spiflash: Implement Release Power-down / Device ID (0xAB) command.

This fixes bug #845.

ps2: Add more detailed per-bit annotations.

ps2: Neither the clock nor the data pin is optional.

Add initial version of PS/2 decoder

Print error messages when decoders fail load time checks

Several checks get applied when loading externally provided protocol
decoders. Print error messages when checks fail, so that developers can
better resolve issues.

The sequence of tests terminates upon the first failed check, while
decoders may suffer from several issues at the same time. This is
considered acceptable, as it reduces the commit's size and the code's
complexity. This commit only adds error messages, and does not change
logic/behaviour.

Failed API version checks result in two messages: One specific message
which reflects the decoder's version and what's supported by the loader,
and a generic message that the API version check has failed. This is
done to simplify the logic of a rarely used error code path.

This commit addresses libsigrokdecode Bug 704, and allows to identify
decoders from parallel installations of differing version.

This fixes bug #704.

Signed-off-by: Gerhard Sittig <redacted>

.gitattributes: introduce git attributes for improved Python diffs

In the absence of respective instructions, git will use a rather generic
approach to generate diffs and patches. Introduce a git attributes file
which results in improved output for Python sources (i.e. all protocol
decoders).

Signed-off-by: Gerhard Sittig <redacted>

spi: Fix binary output for wordsizes > 8.

For wordsizes > 8, multiple bytes are used (big-endian).

This fixes bug #686.

uart: Default to hex format datavalue annotations.

This is in almost all cases what the user will want, only rarely ASCII
(the old default) will be the more natural fit.

uart: Emit 2 bytes for 9-bit UART binary output.

For 5..8 data bits the binary output will be 1 byte, for 9 data bits
it will be 2 bytes (big-endian).

This fixes bug #708.

uart: skip frames with invalid start bits

When the start bit is not low at its sample point, then stop trying
to interpret the remaining frame -- it's already known to be invalid,
anyway.

Wait for the next start bit instead, assuming that either the falling
edge which started the inspection of the UART frame and its start bit
was a spurious glitch or that the captured signal does not communicate
at the decoder's configured bitrate.

Signed-off-by: Gerhard Sittig <redacted>

uart: rework text formatting of communicated data values, plus nits

Factor out the code which generates a textual representation for the
numeric values that were communicated via UART bit patterns. Make the
width of the output text depend on the number of bits in the UART frame
(five to nine) instead of assuming bytes of exactly eight bits.

Fix other minor issues while we are here: Nine bits result in a number
range of 0 to 511 (not 512). ASCII codes 30 and 31 are non-printables.
The previous implementation skipped a significant leading digit in the
octal representation.

Signed-off-by: Gerhard Sittig <redacted>

uart: minor nit, rename the "databyte" variable

Given the generic nature of UART communication and the supported range
for the data width, "byte" may be a misleading name for the numeric
value that gets communicated in five to nine data bits. Rename the
"databyte" variable to "datavalue".

Signed-off-by: Gerhard Sittig <redacted>

Add an initial GPIB decoder.

midi: Add missing copyright lines.

midi: Random cosmetic cleanups.

midi: Simplify some boolean tests.

midi: Use "is" or "is not" with None.

usb_request: Use "is" or "is not" with None.

midi: Add support for complex MIDI message formats (inter-related).

 - Handle "Running Status" where status byte can be omitted
 - SysEx message can be terminated by status byte, not just EOX
 - Handle SysReal messages that interrupt in-progress message transmission
 - Identify and print garbage / truncated data
 - Add 2 new annotations: text-sysreal-verbose and text-error