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

Add ON Semi CAT24C256, CAT24M01.

Decoder_put(): Avoid a g_malloc()/g_free() pair per binary out.

Decoder_put(): Avoid a g_malloc()/g_free() pair per annotation.

srd_inst_find_by_obj(): Minor performance improvement.

Handle the most common case of one session and one decoder first so
we can exit early. This has a small, but measurable performance benefit.

srd_*inst_find_by_obj(): Suggest inlining for performance reasons.

This has a small, but measurable performance benefit.

srd_*inst_find_by_obj(): Move functions, make them static.

These functions are only used in type_decoder.c. Move them there and
make them static.

sample_matches(): Force inlining for performance reasons.

Simplify code by dropping session_is_valid().

A simple NULL check is sufficient here, max_session_id is being
properly handled by srd_init(), srd_exit(), srd_session_new().

This might also have a small performance benefit.

convert_meta(): Use g_variant_type_equal().

Doxyfile: Exclude the build/ directory.

Add srd_searchpaths_get() API docs.

Doxyfile: Update to a more recent Doxygen version.

Random whitespace/cosmetic/consistency fixes.

type_decoder.c: Fix a compiler warning (-Wswitch-default).

  type_decoder.c: In function ‘get_term_type’:
  type_decoder.c:486:2: warning: switch missing default case [-Wswitch-default]
    switch (v[0]) {
    ^~~~~~

configure.ac: Add some more compiler warning options.

Add the -Wshadow -Wformat=2 -Wno-format-nonliteral -Wfloat-equal
compiler options (supported by both gcc and clang) to get notified
of more potential issues in the code.

srd_decoder_load_all_zip_path(): Fix a compiler warning (-Wshadow).

srd_inst_channel_set_all(): Fix a compiler warning (-Wshadow).

  instance.c:266:11: warning: declaration of ‘l’ shadows a previous local [-Wshadow]
     GSList *l = g_slist_nth(di->decoder->channels, i);
             ^
  instance.c:206:9: note: shadowed declaration is here
    GList *l;
           ^

type_decoder.c: Drop unneeded g_free() NULL check.

instance.c: Fix a scan-build warning.

  instance.c:278:25: warning: The left operand of '!=' is a garbage value
                  if (new_channelmap[i] != -1)
                      ~~~~~~~~~~~~~~~~~ ^

decoder.c: Fix a scan-build warning.

  decoder.c:343:9: warning: Access to field 'ob_type' results in a dereference of a null pointer (loaded from variable 'py_default')
                                  if (Py_TYPE(py_default) != Py_TYPE(py_item)) {
                                      ^~~~~~~~~~~~~~~~~~~
  /usr/include/python3.6m/object.h:118:33: note: expanded from macro 'Py_TYPE'
  #define Py_TYPE(ob)             (((PyObject*)(ob))->ob_type)
                                  ^~~~~~~~~~~~~~~~~~~~~~~~~~~~

type_decoder.c: Fix a scan-build warning.

  type_decoder.c:836:3: warning: Value stored to 'ret' is never read
                ret = process_samples_until_condition_match(di, &found_match);
                ^     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

instance.c: Fix a memory leak reported by scan-build.

  instance.c:280:10: warning: Potential leak of memory pointed to by 'new_channelmap'
                  pdch = g_slist_nth(di->decoder->channels, i)->data;
                         ^~~~~~~~~~~

type_decoder.c: Fix a memory leak reported by scan-build.

  type_decoder.c:206:2: warning: Potential leak of memory pointed to by 'pdb'
          PyGILState_Release(gstate);
          ^~~~~~~~~~~~~~~~~~

type_decoder.c: Fix a memory leak reported by scan-build.

  type_decoder.c:197:10: warning: Potential leak of memory pointed to by 'pdb'
                 return SRD_ERR_MALLOC;
                        ^~~~~~~~~~~~~~

Convert some g_malloc0() to g_malloc().

For the converted calls there's no requirement for all struct fields
being memset()'d to zero, or all struct fields are explicitly set
later anyway.

get_current_pinvalues(): Slightly simplify a code chunk.

util.c: Add two missing PyGILState_Release() calls.

st7735: Merge reset_state() into reset().

Simple decoder for ST7735 TFT controller

mcs48: add reset method, make A12 optional, unassorted adjustment

Add the reset() method which recently has become essential. Make the A12
"memory bank" address line optional. Use more Python idioms. Update
comments.

The control signals had to move, to avoid gaps between D7 and A8 as well
as between A11 and A12 in the GUI decoder properties dialog. With
dynamic assignment in the UI and with named references in the CLI this
shall not harm. Unmodified automated tests still pass.

The logic is prepared to handle data, address, and "bank" pin groups at
arbitrary locations, A[11:8] and D[7:0] need not be adjacent any longer.
Support for more than one memory bank pin is prepared, but the number of
bank pins needs to get determined at the start of decode(), when this
feature is to get added in the future.

Add new decoder: Intel MCS-48

Decodes addresses and data read from an external ROM. The MCS-48
processors (8048, 8049, 8039, etc.) have an 8-bit data bus that latches
first the address then the data.

type_decoder.c: Drop incorrect Py_DECREF() calls.

type_decoder: Fixup memory leak in Decoder.put() (meta, python)

This fixes parts of bug #329.

type_decoder: fixup memory leak in Decoder.put() (annotation, binary)

The text presentation of decoder annotations' payload data was allocated
but not freed. As were the byte strings of binary output. Fix it.

This fixes parts of bug #329.

Doxyfile: Set CREATE_SUBDIRS to NO.

The API docs for libsigrokdecode are relatively small, no need for
the many, many subdirectories this would otherwise create.

jtag_stm32: Always switch state on new instruction

jtag_stm32: Fix handling of boundary scan TAP

jtag: Fix shifting of registers

This fixes bug #1066.

spiflash: Add Adesto AT45DB161E metadata.

spiflash: Add basic Adesto AT45DBxx support (WRITE1/2, STATUS).

dcf77: annotate unexpected bit numbers and values, do not abort execution

Improve robustness of the DCF77 decoder. Cope with "neiter 0 nor 1" bit
values (glitches can break the detection of pulse widths), as well as
unexpected bit numbers (more than 59 pulses per minute, can be a
follow-up error after e.g. glitches break one long pulse into two short
pulses). Do not process this invalid data, do emit error annotations.

dcf77: annotate invalid dow and month fields, do not abort execution

Emit error annotations for invalid day of the week or month numbers,
instead of aborting decoder execution with an exception.

Implementation detail: Neither the Python 'in' keyword nor a .get()
method are available. That's why we have to catch the IndexError
exception.

This fixes bug #1173.

dcf77, lpc: rephrase bit string formatting

Create the text representation of a bit string by means of the builtin
.format() method and an appropriate specifier. Drop the non-obvious
sequence of bin() and slice and zfill() calls.

instance: return SRD_ERR_TERM_REQ when execution shall terminate

The previous implementation internally noticed the "want terminate"
request, and skipped decoder execution to faster get to the end of the
input stream. But an OK return code was provided in that code path, and
more input data was sent by applications (sometimes for many seconds or
few minutes).

Do return a new SRD_ERR_TERM_REQ error code, such that applications can
tell failed execution from requested termination.

instance: drop an unneeded "want wait() to terminate" reset assignment

It's uncertain why srd_inst_decode() which internally gets called by the
public srd_session_send() routine used to clear the want_wait_terminate
flag. This should be cleared upon decoder instance creation and state
reset, gets raised upon termination request, but shall not get cleared
in other spots, especially not upon the availability of new input data
while the stream shall be considered in the "about to terminate, skip
all subsequent execution" state.

log: Move log level check so that it affects all handlers.

Before this change, the loglevel check would only be performed for the
default log handler in libsigrokdecode, but not for other handlers set
via srd_log_callback_set().

This fixes bug #698.

srd_exception_catch(): Beautify traceback logging output.

Decoder_register(): Drop an overly verbose log message.

srd_logv(): Add an explicit fflush().