decoder: consider reset() a mandatory decoder method

In theory support for PD reset is optional, applications are not
required to make use of it. But it's essential to receive correct
decoding results when used with the popular Pulseview mainline
application.

So let's consider the absence of the reset() method fatal. All mainline
decoders have it. Out-of-tree decoders are easy to adjust, and very
probably should support reset() as well. Thus this change is considered
beneficial, and not harmful.

miller: add reset() method

lin: Simplify state handling a bit.

lin: handle_break(): Use self.putx().

lin: Simplify LinFsm._transition_allowed().

add LIN protocol decoder

spiflash: Remember write protection latch from status registers

spiflash: Bugfix: WRSR was using miso for register decode

spiflash: Initial support for write enable state tracking

spiflash: Handle chip erase

Minimal implementation of chip erase 0x60 and 0xc7 command handling

spiflash: Add Winbond W25Q80DV metadata.

Fix GVariant memory leaks in session test code

==187759== 88 (40 direct, 48 indirect) bytes in 1 blocks are definitely lost in loss record 2,262 of 3,218
==187759==    at 0x4C2EBAB: malloc (vg_replace_malloc.c:299)
==187759==    by 0x563C435: g_malloc (in /usr/lib64/libglib-2.0.so.0.5600.3)
==187759==    by 0x5654056: g_slice_alloc (in /usr/lib64/libglib-2.0.so.0.5600.3)
==187759==    by 0x5673630: g_variant_new_from_bytes (in /usr/lib64/libglib-2.0.so.0.5600.3)
==187759==    by 0x566C5E6: ??? (in /usr/lib64/libglib-2.0.so.0.5600.3)
==187759==    by 0x566C7D2: g_variant_new_uint64 (in /usr/lib64/libglib-2.0.so.0.5600.3)
==187759==    by 0x403D41: conf_check_fail.constprop.6 (session.c:152)
==187759==    by 0x403E06: test_session_metadata_set_bogus (session.c:215)
==187759==    by 0x53E51D5: srunner_run_tagged (in /usr/lib64/libcheck.so.0.0.0)
==187759==    by 0x401237: main (main.c:51)

Fix memory leak in decoder test code

==187724== 917 bytes in 1 blocks are definitely lost in loss record 3,046 of 3,207
==187724==    at 0x4C2EBAB: malloc (vg_replace_malloc.c:299)
==187724==    by 0x563C435: g_malloc (in /usr/lib64/libglib-2.0.so.0.5600.3)
==187724==    by 0x5655D82: g_strdup (in /usr/lib64/libglib-2.0.so.0.5600.3)
==187724==    by 0x4E43937: py_str_as_str (util.c:371)
==187724==    by 0x4E415E1: srd_decoder_doc_get (decoder.c:892)
==187724==    by 0x40281D: test_doc_get (decoder.c:395)
==187724==    by 0x53E51D5: srunner_run_tagged (in /usr/lib64/libcheck.so.0.0.0)
==187724==    by 0x401237: main (main.c:51)

Fix memory leak in print_searchpaths()

==175453== 522 bytes in 8 blocks are definitely lost in loss record 2,923 of 3,201
==175453==    at 0x4C2EBAB: malloc (vg_replace_malloc.c:299)
==175453==    by 0x59E9BB5: PyObject_Malloc (in /usr/lib64/libpython3.6m.so.1.0)
==175453==    by 0x5A35A76: PyBytes_FromStringAndSize (in /usr/lib64/libpython3.6m.so.1.0)
==175453==    by 0x4E3FA6E: print_searchpaths (srd.c:173)
==175453==    by 0x4E3FA6E: srd_init (srd.c:287)
==175453==    by 0x4034BE: test_session_reset_nodata (session.c:238)
==175453==    by 0x53E51D5: srunner_run_tagged (in /usr/lib64/libcheck.so.0.0.0)
==175453==    by 0x401237: main (main.c:51)

Fix bad memory accesses during srd_exit()

When the decoder and session unload functions are called they
remove themselves from the list. The code walking the list
must be careful to avoid accessing the next pointer which
might now be invalid. The g_slist_foreach() takes care of
this.

Reports from Valgrind before fix:

==175436== Invalid read of size 8
--
==175436==  Address 0xe3f2598 is 8 bytes inside a block of size 16 free'd
==175436==    at 0x4C2FDAC: free (vg_replace_malloc.c:530)
==175436==    by 0x563C541: g_free (in /usr/lib64/libglib-2.0.so.0.5600.3)
==175436==    by 0x5654783: g_slice_free1 (in /usr/lib64/libglib-2.0.so.0.5600.3)
==175436==    by 0x56552A2: g_slist_remove (in /usr/lib64/libglib-2.0.so.0.5600.3)
==175436==    by 0x4E3FEFF: srd_session_destroy (session.c:343)
==175436==    by 0x4E3F5C7: srd_exit (srd.c:311)
==175436==    by 0x40336F: test_inst_new (inst.c:40)
==175436==    by 0x53E51D5: srunner_run_tagged (in /usr/lib64/libcheck.so.0.0.0)
==175436==    by 0x401237: main (main.c:51)
==175436==  Block was alloc'd at
==175436==    at 0x4C2EBAB: malloc (vg_replace_malloc.c:299)
==175436==    by 0x563C435: g_malloc (in /usr/lib64/libglib-2.0.so.0.5600.3)
==175436==    by 0x5654056: g_slice_alloc (in /usr/lib64/libglib-2.0.so.0.5600.3)
==175436==    by 0x5655797: g_slist_append (in /usr/lib64/libglib-2.0.so.0.5600.3)
==175436==    by 0x4E3FC75: srd_session_new (session.c:71)
==175436==    by 0x403345: test_inst_new (inst.c:37)
==175436==    by 0x53E51D5: srunner_run_tagged (in /usr/lib64/libcheck.so.0.0.0)
==175436==    by 0x401237: main (main.c:51)

Update a few Doxygen @since tags.

Drop @since tags for non-public functions.

instance.c: Avoid 4 unneeded forward declarations.

uart: add support for break condition detection

There are the "traffic inspecting" wait() conditions, which check an
edge to find the start of START, then wait for sample points to grab the
bit values. Bit times are sampled in their respective center, potential
glitches around sample points get ignored.

Add another independent set of wait() conditions which check _all_ edges
regardless of any data communication. This results in the most reliable
and maintainable detection of break conditions, regardless of how they
align to data frames. Break is defined as a period of low input signal
which spans at least one frame's length. Run the edge inspection after
data inspection, which results in the most appropriate annotation output
like leading data bits (of incomplete frames), frame errors (violated
STOP bit expectations), then break conditions. This approach is most
robust in the presence of incomplete input streams.

ook: Fix two typos which affect the decoding results.

Various log message improvements.

log: Use human-readable output type name everywhere.

instance.c: Make oldpins_array_*() static.

Decoder_put(): Add more info to OTUPUT_PYTHON log messages.

srd.c: Fix a compiler warning with gcc 8.

  srd.c: In function ‘srd_searchpaths_get’:
  srd.c:399:40: warning: cast between incompatible function types from ‘gchar * (*)(const gchar *)’ {aka ‘char * (*)(const char *)’} to ‘void * (*)(const void *, void *)’ [-Wcast-function-type]
    return g_slist_copy_deep(searchpaths, (GCopyFunc)g_strdup, NULL);
                                          ^

Upstream glib issue / documentation change:
https://gitlab.gnome.org/GNOME/glib/issues/1492
https://gitlab.gnome.org/pwithnall/glib/commit/e81f4c2acea5ada6ae989426e462613f7c612cac

type_decoder.c: Fix trailing whitespace.

morse: fix for #1278

ook_vis: Minor code simplifications.

ook_oregon: Minor code simplifications.

ook: Minor code simplifications.

added ook_vis

added ook_oregon

added ook

miller: Minor description/whitespace fixes.

atsha204a: Add missing full stop in description.

miller: Add missing 'binary' meta-data.

Miller encoding PD

cec: Drop uneeded self.set_stat().

cec: Replace unneeded decode_opcode().

cec: Simplify a few code snippets.

Add HDMI CEC protocol decoder.

usb_power_delivery: Whitespace/consistency cosmetics.

All annotation classes/rows have all-lowercase IDs.

Also fix a few minor whitespace/consistency issues.

usb_power_delivery: Drop currently unused self.out_python.

usb_power_delivery: Drop non-existing max_w for now.

usb_power_delivery: better PD 3.0 support and other changes

 - better PD 3.0 support
 - display PD revision in output
 - different flags for source and sink PDO's and RDO's

[Note: This commit is the remaining set of manually merged changes of the
 recent commits from Peetz0r <redacted> and the
 improvements from davidanger <redacted> over at
 https://github.com/davidanger/libsigrokdecode]

usb_power_delivery: wait 1ms instead of 100k samples

usb_power_delivery: improve wording

Control channel => Configuration Channel

usb_power_delivery: PPS support

usb_power_delivery: Move stored PDO's inside Decoder class

Also add timeout functionality to properly decode the last packet in a capture.

usb_power_delivery: print more useful stuff

including:
 - power in watts
 - type of PDO (fixed, pps, etc)
 - which PDO belongs to an RDO

also deduplicated get_source_cap() and get_sink_cap()

swim: Simplify a code snippet.

Decoder for STM8 series MCUs SWIM protocol.

Signed-off-by: Mike Jagdis <redacted> (github: mjagdis)

srd_exit(): Fix a -Wcast-function-type compiler warning.

  srd.c: In function ‘srd_exit’:
  srd.c:310:28: warning: cast between incompatible function types from ‘int (*)(struct srd_session *)’ to ‘void (*)(void *, void *)’ [-Wcast-function-type]
    g_slist_foreach(sessions, (GFunc)srd_session_destroy, NULL);
                              ^

srd_decoder_unload_all(): Fix a -Wcast-function-type compiler warning.

  decoder.c: In function ‘srd_decoder_unload_all’:
  decoder.c:1080:27: warning: cast between incompatible function types from ‘int (*)(struct srd_decoder *)’ to ‘void (*)(void *, void *)’ [-Wcast-function-type]
    g_slist_foreach(pd_list, (GFunc)srd_decoder_unload, NULL);
                           ^

log: add a public srd_log_callback_get() API routine

Allow applications to query the currently registered log callback. So
they can either restore the previously registered routine, or register
another routine _and_ log to the previously registered routine as well.

Make srd_inst_decode() return the actual decoder state, not SRD_OK

counter: Consider edge counter offset also in word processing

counter: Let user decide how to handle the initial dead_cycles state

edge_off and word_off are not included in the if block because a user may
want to use edge_off to dismiss unwanted clocks instead of dead_cycles.

counter: Introduce option to ignore edges

counter: Use initial counter values also after a reset

spi: Create the out_bitrate annotation unconditionally

The start() method is called before the metadata() method, which results in the
the out_bitrate instance variable never getting created and ending up as an
AttributeError when decoding.

(observed with sigrok-cli and VCD file as the input)

edid: Shorten two code snippets.

edid: Add support for extension blocks, cleanups

Extension blocks are widely used by e.g. HDMI to signal support for
audio, colorspaces and much more.

Cleanups:
- support short forms for annotations
- join overlapping annotations, these were unreadable in PV, and the
  positions were inaccurate (aligned to bytes instead of bits, no
  notion of used bits in split fields).

install: unbreak installation with Python 3.7 (os.errno)

The os.errno module has not been an official feature. Python 3.7
removed the corresponding import. This broke the installation of
decoders. Prefer 'errno' over 'os.errno'.

configure.ac: Also check for Python 3.7.

counter: add support for user specified initial counter values

Introduce options for the initial edge and word counter values. Default
to 0 for compatibility with the previous implementation. This fixes
bug #1229.

mdio: accept MDIO READ without previous ADDRESS command

Fix a Python string formatting issue, where the format string disagreed
with the argument list. A READ command could unexpectedly terminate the
decoder instance when there was no previous ADDRESS command.

This fixes bug #1258.

uart: rephrase data bits to data value conversion

Use the already available .databits[] information which holds sample data
and bit time edge positions, and the common bitpack() routine. This shall
increase readability of the bits to value conversion.

[ best viewed with more context, like 'git diff -U5' ]

common: rephrase bitpack(), use list comprehension Python idiom

jtag_ejtag: Simplify some code snippets.

jtag_ejtag: Fix short/long annotation order.

The list of annotation strings is sorted from longest to shortest.

jtag_ejtag: Add short description in __init__.py.

jtag_ejtag: Move bin2int() to common/srdhelper.

Also, rename from bin_to_int to bin2int() for consistency.

jtag_ejtag: Simplify two code snippets.

jtag_ejtag: Shorten variable names to ss/es.

These abbreviations are commonly-used in all other PDs.

Add MIPS EJTAG decoder

Signed-off-by: Vlad Ivanov <redacted>

cfp: Add reset() method.

cfp: Use the Python in/range keywords.

cfp: Shorten two variable names.

cfp: Factor out self.putx().

This improves readability and avoids some duplication.

cfp: Reduce indentation level.

cfp: Drop unneeded annotation prefix; plural fixes.

cfp: Drop unused self.out_python.

cfp: Fix incorrect copy-paste description.

Revert "mdio: Add 'TURNAROUND' long/full annotation." in order to comply with the naming used in the Ethernet standard.

This reverts commit 30d775b095a4b76e5fa755b19d5521affa3c053c.

Add a CFP decoder.

counter: Drop unneeded tuple braces.

(minor readability / consistency improvement)

counter: emit wider annotations for data and word counts

Track the start of a data or word cycle. Avoid narrow ss=es annotations
which may be tedious to inspect by users in GUI applications. This
resolves the issue initially reported in bug #1210.

counter: prepare for variable width annotations

Explicitly pass a start sample number to the .putc() method, to prepare
annotations where ss differs from es. This is motivated by bug #1210.
Stick with the narrow ss=es annotations for backwards compatibility.

counter: explicit string formatting for annotation text

Replace str() conversion with explicit number text formatting, for
improved awareness and easier future adjustment during maintenance.

counter: use local variables instead of instance variables

Since values get accessed within the .decode() method exclusively, we need
not store data in instance variables of the decoder object. Use another
variable for the "reset edge" option as well for consistency.

counter: move some init code to the start of decode()

Since PD API v3 the .decode() method is called exactly once, and
contains a main loop itself. Move initialization code that sets up
.decode() related logic to the start of the .decode() routine.

counter: use symbolic names for input pins, wait conditions, annotation rows

Replace magic numbers by symbolic references to (fixed and optional)
decoder input signals, .wait() conditions, as well as annotation rows.

Move some empty lines, to better reflect which code lines form groups of
similar activity ("blocks" that logically belong together).

counter: explicit option text to .wait() edge mapping

The previous implementation used the fact that libsigrok's internal API
happens to use the first letter of the user visible English option text.
Two locations mapped edge choices to API literals in different ways.
Unify them, introduce an explicit option text to literal value mapping.

(Many if not all decoder implementations do that. More adjustment to use
common code could be beneficial.)

atsha204a: Add the reset() method.

atsha204a: Rename a few methods for consistency.

atsha204a: Shorten a few more code chunks, add helpers.

atsha204a: Shorten self.opcode to op in a few places.

atsha204a: Use the Python 'in' keyword to improve readability.

atsha204a: Shorten output_tx_bytes()/output_rx_bytes() a bit.

Add decoder for Microchip ATSHA204A crypto module