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

midi: chromatic_notes in list.py was off by 1 octave

(ex: note 60 is middle C which is C4, not C3)

uart: Fix a bug in the output for stacked PDs.

The UART bit information was not transmitted correctly to stacked PDs
if there was an overlap between RX and TX bytes in the data.

midi: Some annotation consistency changes.

Updates each annotation with multiple strings ranging from long, medium, and short lengths

usb_power_delivery: Drop problematic exception in us2samples().

This causes an issue when running the sigrok-test test-cases, so drop
it for now (the same check already exists in decode()).

This fixes bug #758.

srd_inst_decode(): Return SRD_ERR_ARG if unitsize is 0.

srd_inst_decode(): Make the code API version dependent.

Factor out srd_decoder_apiver().

srd_inst_decode(): Improve comments and log messages.

Also, drop @since tag (as the function is not public).

srd_session_send(): Improve Doxygen comments.

ssi32: Slightly more descriptive naming.

midi: Substantially improve decoding of MIDI messages.

 * Decode note names and percussion names (ex: 'G2', 'Tambourine').
 * Decode instrument names and drum_kit names (ex: 'Flute', 'GS Orchestra Kit').
 * Handle Polyphonic Pressure / Aftertouch (message 0xAn).
 * Handle Program Change (message 0xCn).
 * Handle Channel Pressure / Aftertouch (message 0xDn).
 * Handle Channel Mode (message 0xBn mm where mm is 120 through 127).
 * Handle System Common messages (message 0xF1 through 0xF6), including
   full time code decoding.
 * SysEx decoding now decodes the 1-3 byte manufacturer field, payload
   is now displayed as hex.
 * 'undefined' fields now display the value (ex: 'undefined 0xf4').
 * Add 'MSB' and 'LSB' to many control_functions entries.
 * Fix "trapped in state X" bug with handle_channel_msg_generic(),
   though this might be dead code.
 * Fix bug in sysex_manufacturer_ids; 1-byte manufacturers were not
   tuples due to missing comma.
 * Fix bug in SysEx decoding state machine; 0xF7 now sent to handle_sysex_msg().

ssi32: Minor cosmetics, add full license header (for consistency).

Add Bosch SSI32 protocol decoder.

Signed-off-by: Oleksij Rempel <redacted>
Signed-off-by: Oleksij Rempel <redacted>

Add a DMX512 protocol decoder

timing: Add frequency and averaging support.

This patch was contributed by James Sleeman <redacted>, thanks!

spiflash: Add a 'format' option.

spiflash: Perf tweak: Build handler lookup table once per decoder

spiflash: Handle "Fast Read Dual I/O"

spiflash: Handle CS# transitions, allow variable-length transfers

Consistency renames of {ss,es}_ variables.

Move common/ directory into decoders/.

This simplifies cross-platform handling of the Python/decoder paths
and module installation/dist a bit and also fixes bug #804.

Add decoder for em4305 RFID protocol

Use consistent __init__() format across all PDs.

The previous **kwargs some PDs had is not actually ever used, so drop it.

usb_request: Drop hardcoded samplerate.

The libsigrokdecode backend now passes metadata (e.g. samplerate) to all
PDs, stacked and non-stacked (see bug #664), so this interim solution is no
longer needed.

Supply metadata to stacked decoders

Currently only toplevel decoders receive the samplerate, thus stacked
decoders are not able to derive e.g. timestamps from the sample number.

This fixes bug #664.

wiegand: Make bitwidth_ms option values integer (not string).

Add wiegand decoder.

Consistently use ' instead of " for strings in all PDs.

Factor out SD card lists into common/sdcard.

These are used by the sdcard_spi and sdcard_sd decoders.

Factor out bcd2int() into common/srdhelper.

Have one subdirectory per module in common/ as well.

This is consistent with decoders/, conveniently allows for more than one
file per module, and also happens to avoid some import warnings.

Move constants out of xfp to common/plugtrx.

Add common directory for shared modules.

mdio: Add 'TURNAROUND' long/full annotation.

(useful in GUIs for displaying more useful annotations at certain
zoom levels)

mdio: Factor out self.putff().

Add an MDIO protocol decoder.

This new implementation supports all the features of the old decoder,
and additionally supports Clause 22 and 45.

Drop mdio decoder (to be replaced with another implementation).

pwm: Use self.{ss,es}_block for consistency across PDs.

timing: Use self.samplenum for consistency across PDs.