HACKING: Add some Python coding style hints, fix incorrect docs.

uart: Use human-readable names for binary classes.

uart: Fix incorrect stop bit annotation class.

This fixes bug #1474.

uart: Use human-readable names for annotation classes.

Using human-readable names for annotation classes (instead of numeric
indices) improves readability and maintainability of the decoder, and can
also prevent bugs due to incorrect indices.

uart: sample position nits, fix typo, float calculation awareness

This commit amends bd50ceb314e4. Fix a typo in a comment. Rephrase the
bit width percentage calculation such that readers remain aware of the
necessity for floating point math in sample position calculations. This
commit does not change behaviour, Python 3 always yields float results
for divisions. It's about raising awareness.

uart: allow arbitrary sample positions for UART bit values (1-99%)

The previous implementation of the UART decoder used to sample bit values
strictly at the center position within a bit time. This commit introduces
support to sample bit values at arbitrary positions in the range of 1-99%
of the bit time. This allows to work around glitches in existing captures
as well as using the decoder for UART like protocols which don't sample
bit values at the center position (like EIB aka KNX).

This implementation is incomplete (on purpose). Although this version
improves the ability to extract data from captures, it also introduces
inaccuracies in the annotation positions for non-default values of the
sample point position. Addressing this issue is left for later, assuming
that it'll be a byproduct of another commit series that is being worked
on (general annotation position adjustment and stop bits support).

can: Drop an unused method.

signature: increase compatibility across Python versions

Underscores in number literals are a recent Python feature which only
was introduced in version 3.6. The sigrok project claims compatibility
with previous Python versions, but the signature decoder fails to load
with this error:

  $ pulseview
  srd: SyntaxError: Failed to load decoder signature: import by name failed: invalid syntax (pd.py, line 138)
  srd: Traceback (most recent call last):
    File "/home/user/share/libsigrokdecode/decoders/signature/__init__.py", line 25, in <module>
      from .pd import Decoder
    File "/home/user/share/libsigrokdecode/decoders/signature/pd.py", line 138
      incoming = (bin(shiftreg & 0b0000_0010_1001_0001).count('1') + data) & 1
                                                     ^
  SyntaxError: invalid syntax

Use the more compact hex presentation for a magic binary pattern. This
obsoletes the necessity to separate groups of bits for readability.

ac97/lin: Remove some unneeded code snippets.

struct srd_decoder: Fix/improve some documentation comments.

i2cfilter: Improve description of the "address" option.

dsi: Add a TODO comment for proper self.wait() usage.

All PDs where "trivial" self.wait() conversion was used now have this
specific comment, so it's easy to grep for.

srd_decoder_doc_get(): Add an additional sanity check.

decoders: Don't set self.samplenum.

This is managed by the backend and should be read-only for PDs.

hdcp: Add missing spaces.

hdcp: Reduce nesting level.

hdcp: Simplify some code snippets.

hdcp: Add tags.

Add HDCP traffic decoder to stack on i2c

This decoder annotates i2c traffic to indicate the type of HDCP
message contained. It includes HDCP2.2 and HDCP1.4. Useful for
analysing HDCP negotiation failures.

ieee488: flush upper layer payload data when IFC asserts

Also flush previously accumulated payload data when the IFC signal
asserts (interface clear, a controller requests ownership of the bus).
This is in line with EOI (end of message) and ATN (start of a command,
including change of "connected" peers or direction of communication).

ieee488: introduce 'delim' option for improved text output

When a capture contains output from a talking device, but neither
contains EOI (end of transmission) nor ATN (new commands, including
changes in the set of communicating peers or communication direction),
then lower layer data bytes would be shown but accumulated runs of upper
layer payload data would not. The hp53131a-ton.sr capture demonstrates
this behaviour.

Add transparent support for the typical case of communicating SCPI over
GPIB. Do emit upper layer payload data annotations when termination
sequences for text lines were seen. Allow users to disable this feature
when it's not appropriate for binary content.

It's an internal implementation detail that accumulated data gets flushed.
Communicate the user visible option as "payload data separation", which
should most appropriately reflect the resulting behaviour. The specific
implementation of this feature can also support different kinds of payload
chunk separation.

Obsolete gpib and iec PDs in favor of ieee488.

ieee488: Mention more relevant keywords in longname.

This can be used by frontends for decoder search features.

ieee488: Simplify _get_raw_byte() a bit.

ieee488: introduce unified IEEE-488 decoder (supports GPIB and IEC)

Introduce an 'ieee488' protocol decoder which handles both the 16 lines
parallel GPIB variant as well as the serial IEC bus variant. Which kind
of supersedes the 'gpib' and 'iec' decoders.

This implementation increases maintainability because only the extraction
of raw bytes from the parallel or serial bus is separate, and all GPIB
related command/address/data interpretation is shared. This decoder extends
the feature set of the previous versions: Visual annotations are more fine
grained (more classes, additional rows, various text lengths to maintain
usability during zoom). There is binary output for communicated data,
as well as Python output for stacked decoders. Consecutive runs of
talker data gets accumulated, and is made available in binary form as well
as text (with escapes for non-printables). The terse single-letter format
(character codes '0' to 'O' for addresses) is kept for compatibility for
those users who are accustomed to it. The implemented logic also copes
with captures of low samplerate, where edges happen to fall onto the same
sample number which at higher samplerates shall be perceived as distant
and should get processed in their respective order of appearance.

This implementation tracks the most recent configuration of "peers" (the
set of talkers and listeners). A future implementation might support the
isolation of a single conversation out of a busy chat on the bus.

Some optional support for Commodore peripherals is included (currently
limited to disk channels), while it's recommended to move this logic to
a stacked decoder if it grows more complex.

ir_rc6: Reduce nesting level.

ir_rc6: Initial commit

ir_rc5: improved performance

flexray: Use bit/s instead of Mbit/s for bitrate.

This avoids floating point number option values, which makes things
a bit easier/clearer on the command-line and also matches what other
decoders do.

Also, use numbers instead of strings for the option values.

flexray: add basic decoder

nes_gamepad: implement and add decoder

uart: Drop question mark from two option names.

uart: Shorten various decoder option names.

This makes the decoder a lot nicer to use from the command-line.

 * num_data_bits -> data_bits
 * parity_type -> parity
 * num_stop_bits -> stop_bits
 * rx_packet_delimiter -> rx_packet_delim
 * tx_packet_delimiter -> tx_packet_delim

uart: rephrase check for required input signals, reword error message

Rephrase the test for the availability of at least one of several
optional input signals, and reword the corresponding error message.

uart: support 'ignore' parity type, remove unsupported 'check_parity' option

The previous UART decoder implementation announced a 'check_parity'
option which took no effect (support code was missing). Remove it. Add
another 'ignore' parity choice instead, which consumes the parity bit's
position yet always passes the check.

Remove left-over FSF postal address from boiler plate license text.

decoders: Use a slightly more consistent/logical annotation row setup.

Generally show "bits" and other smaller annotations in rows that come
before "larger" annotations (in later rows).

ir_nec: fix #1243, multiple capture frames.

ws281x: Check for "None" before subtracting.

can: more robust sample point position for low sample rates

Do more of the calculation with floating point, only trim precision and
enforce integers at the end of the determination of the next sample
point. This shall increase robustness at low capture sample rates.

can: implement bit rate switch support for CAN-FD frames

can: annotate classic CAN CRC as CRC-15

lin: calculate checksum on two consecutive UART idle frames

modbus: Ignore unknown/unsupported types.

Without this, e.g. the recently added 'IDLE' ptype of the UART decoder
would cause issues.

uart: Document the new 'IDLE' ptype for OUTPUT_PYTHON output.

uart: communicate periods of idle frames to stacked decoders

Detect periods of a frame's length with idle level, and communicate
these time spans to stacked decoders by means of PYTHON output. Do *not*
display these idle frames in regular annotations, for backwards compat.

signature: Fix license metadata field to match pd.py license header.

signature: Use more human-readable option values.

signature: Minor consistency fixes.

signature: Add self.reset().

Add decoder: signature analysis

gpib: drop obscure "total number of samples" option

The gpib decoder tried to "flush" input data at a user specified sample
number when the input data lacked the respective edge which triggers the
processing during regular operation.

This is rather obscure a feature, not seen in any other decoder, perhaps
a workaround for bug #292, rather unaccessible to users (units of sample
numbers not times nor automatic detection of the EOF condition), highly
confusing according to user reports, and not covered by existing tests.

The mere presence of this option caused severe issues in application
code (see bug #1444). While there is no apparent fix that won't affect
other decoders. So let's drop this questionable feature. Valid and
complete captures should contain all relevent edges and thus decode
properly.

decoder: accept skip count 0 (onewire_link, usb_signalling)

A recent commit tightened the check for acceptable 'skip' sample counts.
This broke the onewire_link and usb_signalling decoders' test sequences,
which no longer pass with a minimum count of one. Relax the condition
and accept a count of zero. This breaks gpib again for low total sample
count option values, but this needs to get addressed differently.

decoder: internal 'always false' term, handle invalid skip and channel

Introduce an "always false" type for .wait() terms. Map invalid counts
of skip conditions (zero or negative numbers) as well as invalid channel
references for level/edge conditions to this type which never matches.
Keep this "always false" term type an internal detail of the common
support code.

This is most robust and least intrusive at the same time, it keeps the
existing API, and simplifies the implementation of Python decoders for
rare edge cases (optional input signals or optional features, handling
of initial samples at the very start of a capture).

This commit passes sample counts internally in a signed data type. This
is essential for proper operation, and the loss of one bit out of 64
shall not be considered a severe limitation.

This fixes bug #1444.

tdm_audio: Place each channel on its own annotation row.

tdm_audio: Add initial decoder

amulet_ascii: Drop unneeded rxtx_channels.

amulet_ascii: Drop a few unneeded parenthesis.

Initial Amulet LCD ASCII PD

This is a protocol decoder for the 'ASCII' protocol used by
Amulet Technologies LCDs.

Currently some commands are not implemented yet. I also lack capture data
from a display that will use replies other than ACK and NACK.

Reads are untested as I have no suitable captures.

The PD copes with bus errors (there is an actual bug in the device I'm
reverse engineering) and most of the commands are implemented.

The unimplemented commands should generally consume the correct
number of bytes from the bus, the exception to this are the drawing
commands, because there are actually at least two revisions of them
with different payloads, that are really hard to detect in greedy
algorithm.

Fix three -fsanitize=undefined issues.

  instance.c:62:2: runtime error: null pointer passed as argument 1, which is declared to never be null
  instance.c:858:45: runtime error: shift exponent -1 is negative
  instance.c:836:45: runtime error: shift exponent -1 is negative

Avoid using Py_IncRef/Py_DecRef for consistency.

We currently use a mix of Py_IncRef/Py_DecRef and Py_XINCREF/Py_XDECREF
or Py_INCREF/Py_DECREF in the code-base. Only use the latter variants
for the time being (for consistency).

srd_inst_option_set(): Fix multiple memory leaks.

These were reported when compiling with "-fsanitize=address" and running
"PYTHONMALLOC=malloc make check":

  =================================================================
  ==42879==ERROR: LeakSanitizer: detected memory leaks

  Direct leak of 317 byte(s) in 6 object(s) allocated from:
      #0 0x7f08e4809538 in __interceptor_malloc ../../../../src/libsanitizer/asan/asan_malloc_linux.cc:144
      #1 0x7f08e3f37622 in PyUnicode_New ../Objects/unicodeobject.c:1365

  Direct leak of 28 byte(s) in 1 object(s) allocated from:
      #0 0x7f08e4809538 in __interceptor_malloc ../../../../src/libsanitizer/asan/asan_malloc_linux.cc:144
      #1 0x7f08e3f7e1a5 in _PyLong_New ../Objects/longobject.c:275

  Direct leak of 24 byte(s) in 1 object(s) allocated from:
      #0 0x7f08e4809538 in __interceptor_malloc ../../../../src/libsanitizer/asan/asan_malloc_linux.cc:144
      #1 0x7f08e3f91521 in PyFloat_FromDouble ../Objects/floatobject.c:122

  SUMMARY: AddressSanitizer: 369 byte(s) leaked in 8 allocation(s).
   session

spiflash: lists.py: Use None for unsupported features.

spiflash: Minor fixes for Atmel AT25 chips.

spiflash: Add support for Atmel AT25xxx

Fix multiple PyObject_SetAttrString() related leaks.

This fixes bug #1374.

condition_list_free(): Fix a memory leak.

uart: Add [rx|tx]_packet_len options.

Similar to the recently added [rx|tx]_packet_delimiter options, these
emit summary annotations ("packets") when a certain number of data values
have been decoded.

This is a convenience feature which can be useful when a user wants to
view data which doesn't have a specified delimiter value (as last data
value in the "packet"), but rather fixed-length "packets".

This is just an (intentionally very simple) helper/convenience improvement
and is NOT meant to replace "proper" stacked decoders for UART-based protocols.

uart: Add [rx|tx]_packet_delimiter options.

This is a convenience feature that emits summary annotations ("packets")
that comprise all data values that were decoded until a specified delimiter
value is seen (as last data value of the "packet").

Example use-cases include ASCII data where it can be convenient to
"packetize" whenever a 10/0x0A value (newline) is seen, or some
protocols which have a fixed "marker" value (e.g. 0x55) as last
value in the "packet".

The annotations are affected by the selected 'format' option, i.e. the
user can get summaries in ASCII or hex or other formats.

This is just an (intentionally very simple) helper/convenience improvement
and is NOT meant to replace "proper" stacked decoders for UART-based protocols.

configure.ac: Add support for Python 3.8.

This fixes bug #1438.

eeprom93xx: Use fixed-width hex output.

This improves readability a bit in most cases.

eeprom93xx: Add OUTPUT_BINARY support.

seven_segment: Simplify two code snippets.

seven_segment: Initial commit.

spiflash: Add "EEPROM" to descriptions.

There are various different names that these types of memories are being
referred to in the wild: SPI flash, flash chip, flash, flash EEPROM,
SPI EEPROM, serial flash, serial memory, flash memory, and various others.

In order to make UI decoder selection more useful to the user, we add
the "EEPROM" string to some of the decoder metadata fields, so the
decoder will (for example) show up in PulseView's list of decoders when
the user types "eeprom" to narrow down the listed decoders.

can: Mention CAN-FD support in the description.

can: Factor out dlc2len().

can: Random whitespace and cosmetic fixes.

can: introduce fast bitrate

can: proper annotation on CAN-FD extended frames

can: add basic CAN-FD handling of non BRS extended frames

can: make PD temporary compatible to existing tests

can: correct decoding of CRC-21

can: decode CAN-FD DLC

can: display CRC type + correct decoding of CRC-17

can: implement decoding of CAN-FD header when FDF bit is set

can: implement basic CAN-FD decoding (SRR and FDF bits)

eeprom93xx: Add ascii format support

mrf24j40: Add TX retries/fails and CCAFAIL support.

mrf24j40: Add RX/TX frame annotations.

pca9571: Shorten names a bit.

Add an NXP PCA9571 decoder.

modbus: Make the 'framegap' option an integer.

modbus: Make C->S and S->C configurable, add framegap option.

Change client->server and server->client to be separately configurable,
allowing decoding at both the server (where client->server is RX and
server->client is TX) and client (where client->server is TX and
server->client is RX) ends of the link. It also allows monitoring of the
bus on a single channel (where client->server and server->client are both
RX (or TX)).

When I tried to decode a bus capture, I found that when the transmitter was
turned off it generated a false start bit, which in turn resulted in a false
trailing byte from the UART decoder. This narrowed the inter-frame gap to
the point where the Modbus decoder failed to recognise a new frame. The
result was only the first frame of the capture decoded - all the rest of the
frames failed to decode. I had to reduce the frame gap to allow subsequent
frames to decode, and so made it a configurable option that defaults to the
existing gap.

Lastly, I fixed a call to puti() that incorrectly included the annotation
prefix.

sdcard_spi: Add "Card is busy" annotations for CMD24.

This fixes bug #1376.

sdcard_spi: Fix incorrect handling of CMD17.

This fixes bug #1377.

usb_request: Allow configuration of BULK IN transfer display

From a protocol level, a BULK IN transfer starts when the host starts
polling the respective endpoint. For analysis, it is sometimes useful
to show when the devices starts to answer the requests.

As both are useful for different use cases (the old, default one emphasizes
the host behavior, the new one shows the endpoint/device behavior), make
the display configurable.

usb_request: Use separate annotation rows for IN, OUT and CONTROL

E.g. CONTROL and BULK IN transfers may overlap each other, and as a result
only one of the two can be seen in pulseview.

Partly solves bug #1046. In case a device has multiple IN/OUT endpoints,
transfers would still overlap, but many simple devices have just one each.

usb_request: Fix some decoding errors

Append OUT data only if it has been ACKed. OUT transfers (BULK OUT or
CONTROL transfer DATA stage) are typically NACKed to create backpressure.

Always keep IN and OUT transfers separate. On the physical layer, the
endpoint number only uses 4 bits, and IN and OUT use separate tokens.
In case the transfer is an IN transfer, set the high bit as used in the
endpoint descriptors (i.e. 0x81 is IN enpoint 1, 0x01 is OUT endpoint 1).

enc28j60: Rename self.ann to self.out_ann.

(for consistency with all other decoders)