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)

enc28j60: Shorten various self.put*() calls.

enc28j60: Factor out self.putr().

enc28j60: Factor out self.putc().

enc28j60: Use the common ss/es abbreviations.

This makes it more consistent with the rest of the decoders.

enc28j60: Clear 'outputs' (no OUTPUT_PYTHON support).

enc28j60: Factor out command list to lists.py.

enc28j60: Shorten ANN_* list a bit.

enc28j60: Add 'tags' field.

enc28j60: Implements decoder for ENC28J60 SPI Ethernet chip

atsha204a: Mention other potentially supported devices.

atsha204a: Mention ATECC508A support in docs.

atsha204a: Minor indentation fixes.

atsha204a: Only call output_tx_bytes() when the bytes buffer is not empty

atsha204a: Display OtherData parameter correctly when Verify command is executed in Validate mode.

atsha204a: Add support for ATECC508A

NEWS: Fix two typos.

spi: Fix annotation row ordering.

Use the same (more logical) order of having the "bits" annotation row
being the first one, which is also what pretty much all other PDs do.

spi: Don't emit bogus "transfer" items.

spi: Add support for "transfer" annotations.

There is already an OUTPUT_PYTHON type named 'TRANSFER' that is being
transmitted to stacked decoders. Make the same information available
as annotations (additionally), which can be helpful in some situations.

cc1101: Use namedtuple to increase readability a bit.

cc1101: Remove 0x prefixes and unneeded quotation marks.

The format "0xAA BB CC ..." looks a bit strange, use "AA BB CC" instead,
it's relatively obvious that the data is hex-encoded.

The quotation marks around some names/values are unneeded and reduce
readability a bit, so drop them.

cc1101: Shorten decode_register() to decode_reg().

cc1101: Simplify decode_command().

By using the annotation strings as command names directly, some parts
of decode_command() can be simplified a bit.

cc1101: Simplify format_command().

cc1101: Factor out and simplify ANN_* names.

Add a TI CC1101 decoder.

sdcard_spi: Fix duplicated 'End bit' annotation emission.

sdcard_spi: Fix incorrect annotation row indices.

This fixes the remaining parts of bug #1365.

sdcard_spi: handle_data_response(): Shorten a few lines.

sdcard_spi: handle_data_response(): Add comment, cosmetics.

sdcard_spi: Fix some abbreviations and names to match the spec.

The official abbreviation for CMD24 in the spec is "WRITE_BLOCK", as
opposed to "WRITE_MULTIPLE_BLOCK" for CMD25 (chapter 4.7.4,
"Detailed Command Description", table 4-24).

The byte preceeding e.g. the CMD24 block data is called "Start Block" token
(chapter 7.3.3.2, "Start Block Tokens and Stop Tran Token"). We don't
include the "token" itself for consistency, since the decoder doesn't do
that for any other tokens either.

sdcard_spi: touch up CMD24 handling

Address some nits in the SDCard (SPI mode) protocol decoder. Rename
identifiers to eliminate comments. Determine the default block size at
the start of the write command instead of the iteration over payload
data bytes. Remove a print() statement which would break regression
tests. Allow re-use of the data handler for other commands, too. Use
lower case hex digits for consistency across the source file, and
slightly unobfuscate a bit pattern check while we are here. Improve
robustness of response handlers and how internal state gets advanced.
Replace constant lookups by direct method calls.

sdcard_spi: add support for CMD24 including payload data

The previous implementation advanced from the start of CMD24 to IDLE.
This commit introduces support for the data phase and data response of
CMD24. Which results in improved usability of the decoder output, and
reduced probability of false positives (don't detect "commands" in the
payload data).

This commit addresses the missing CMD24 handling part of bug #1365.

srd_inst_stack(): Warn upon potentially incorrect stacking.

Currently there must be at least one match of inputs/outputs for
decoders that are stacked. If not, we emit an informational warning
(but this is not a hard error for the time being).

decoders: Fix incorrect 'outputs' fields.

Only add items to 'outputs' if the respective PD actually has
OUTPUT_PYTHON support implemented as of right now.

Various decoders might get OUTPUT_PYTHON support later, but the
'outputs' field should reflect the current status.

ds2408: Add missing tags.

add a Maxim DS2408 decoder

This is a 1-Wire 8-channel addressable switch.

onewire_network: add a 'Disable Test Mode' command for DS2408

For details see the DS2408 datasheet, section "Power-up timing".

This commit is adding this missing command so now a full decoding
is possible:
Annotations from 1-Wire network layer:
8990980-8991220 1-Wire network layer: : Reset/presence: true
8994163-8994437 1-Wire network layer: : ROM command: 0x96 'DS2408: Disable Test Mode'
8995026-9008178 1-Wire network layer: : ROM: 0xa30000001246a929
9008785-9009060 1-Wire network layer: : Data: 0x3c
9012290-9012530 1-Wire network layer: : Reset/presence: true

And from the specific stacked DS2408 slave:
8990980-8991220 DS2408: : Reset/presence: true
8995026-9008178 DS2408: : ROM: 0xa30000001246a929 (family code 0x29)
9008785-9009060 DS2408: : Disable Test Mode (0x3c)
9012290-9012530 DS2408: : Reset/presence: true

onewire_network: add a missing 'Resume ROM' command

For details see the DS2408 datasheet, section "Resume Command [A5h]".

decoders: Various cosmetic/consistency/typo fixes.

HACKING: Document current tags and their intention/usage.

decoders: Add/update tags for each PD.

Add PD tags handling and some tags