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.

Add initial Renesas Advanced User Debugger (AUD) decoder.

em4100/t55xx: Fix accidentally broken wording in license header.

The word "version" was accidentally replaced by "data" (sed).

Fix various incorrect PD license metadata fields.

Have the PD 'license' attribute match what the license header of the
respective pd.py file actually says.

Add an rgb_led_ws281x decoder.

This decoder handles the WS2812B protocol (and possibly WS2811).

Example dump already exists: led/ws281x/ws281x_4ch_5mhz.sr.

Signed-off-by: Vladimir Ermakov <redacted>

Add decoder for the t55xx RFID protocol

configure.ac: Bump package version to 0.5.0.

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

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

The last release (0.3.0) had the libtool version (current:revision:age)
set to 2:0:0. Since this release removes and changes interfaces, the new
version is 3: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.2.0.0 to libsigrokdecode.so.3.0.0, the SONAME
(+symlink) becomes libsigrokdecode.so.3.

NEWS: Update for upcoming 0.4.0 release.

configure.ac: Also check for Python 3.5.

This fixes bug #739.

uart: Optimize handling of samples when tx and rx are both idle

Re-enable the fast path for identical samples but only when both
pins are waiting for the start bit. For sparse data sets (I tested
UT61E capture log) the optimization results in a >4x decode
improvement.

arm_itm: Use objdump instead of addr2line.

This improves speed and fixes bug 564. Code is somewhat
of a copypaste from the arm_etm counterpart, but there
are enough differences that it is easier to keep separate
copy of the objdump parsing in each.

usb_power_delivery: Raise SamplerateError instead of Exception.

(for consistency with the other PDs)

Use self.out_binary naming consistently across all PDs.

Use a Python list (not tuple) for OUT_BINARY.

This is more consistent with annotation syntax and looks slightly
better in most cases.

Drop obsolete support for annotation tuples (only support lists).

None of the PDs use this.

em4100: Simplify the code a bit.

em4100: Use ss/es naming for consistency across PDs.

em4100: Eliminate some unnecessary int()s.

em4100: Change annotation setup a bit, decode more protocol details.

Add RFID EM4100 protocol decoding

usb_power_delivery: Use "if not self.samplerate" form.

Use the "if not self.samplerate" form, which catches both the case
where self.samplerate is None, as well as the case where it is 0.

This is also consistent with all the other PDs.

usb_power_delivery: convert double quotes to single quotes

For consistency with other decoders, convert all the double quotes around
strings to single quotes.

Signed-off-by: Vincent Palatin <redacted>

init: Don't let Python override signal handlers

This fixes bug #461.

usb*: Minor cosmetics.

usb_signalling: detect PREamble PID

PID decoding is normally done in the packet layer, but the signalling
layer has to switch behaviour on detection of an PREamble PID.

usb_signalling: add signaling states needed after LS PREamble PID

usb_{packet,request}: handle PREamble transmissions

usb_signalling: fix SOP detection after an error condition

If the oldsym is not set to 'J' before entering IDLE state, the SOP
detection will never trigger

usb_packet: handle errors from usb_signalling

If a packet had any errors, the usb_signalling PD will not send an EOP
but an ERR message. Wait for the next SOP in both cases.

usb_request: Handle transmission timeouts

If a device or host did not receive a handshake 18 bit times after the
EOP, there was a transmission error and the host may repeat the
transmission

usb_signalling: add option to automatically set signalling speed

In automatic mode, the bus is assumed to be in IDLE state. After a
RESET, the bus state is checked again.

usb_signalling: decode RESET and Keep-Alive signalling conditions

Resets are at least 10ms at the root hub downstream facing port and
2.5us at the device (root hub reset may be shortened by itermediate
hubs).
Keep-alive is a low-speed only signalling condition, as low-speed has no
SOFs to inhibit devices to enter suspend

usb_signalling: use explicit positions for packet start/end

Instead of centering the block around the sampleposition, which shows
some visual glitches due to rounding, use the edge positions already
known. Remove unused halfbit symbol.

usb_signalling: handle symbol errors in EOP state

Only SE0 and J are valid symbols during EOP

usb_signalling: remove unneeded syms array

Do not call get_eop() from get_bit(), but directly issue the symbol. As
get_eop() is only called during the GET EOP state, the SE0 is implicit and
there is no need to save it into the syms array.

usb_signalling: remove unused ss_sop member

usb_signalling: detect bit stuffing errors

More than six consecutive 1's are an error

usb_signalling: consolidate symbol output

No need to replicate the symbol formatting in several places

spi: Add a 'TRANSFER' output type.

Fix documentation comment in SPI decoder

usb_power_delivery: Minor typo and whitespace fixes.

usb_power_delivery: Use the same license header format as other PDs.

USB Power Delivery protocol decoder

Decode and packetize the Biphase Mark Coding (aka differential Manchester)
as used in the Universal Serial Bus Power Delivery Specification Revision 2.0
v1.1, then decode the packet content.

Signed-off-by: Vincent Palatin <redacted>

spiflash: Fix incorrect 'inputs' field.

(this PD is indeed stacked on top of SPI)

Initial attempt at MAX7219/MAX7221 decoder