Move session-specific functionality into session.c

Minor cleanup

Move versioning info out to separate header

Use OUTPUT_BINARY with four classes.

Implement OUTPUT_BINARY

This requires the PD to have a tuple in its class called 'binary',
which contains a list of strings describing the different binary
classes it can output. For the SPI decoder this might be 'MOSI' and
'MISO', for example.

The data is submitted to the frontend as struct srd_proto_data_binary,
which contains the class that data belongs to.

Drop obsolete report() method.

Drop outdated report: this should be handled by a frontend.

Use the new Decoder.register() API

Emit meta bitrate

Emit meta bitrate

Prune dead code

Implement OUTPUT_META

This replaces the Decoder.add() method with Decoder.register().
The first argument is still output type, but all arguments are now
optional:

  Decoder.register(output_type,
        id='someid',
        meta=(object-type, 'Name', 'Description'))

'id' defaults to the protocol decoder instance id, and only needs changing
if a decoder chain needs to fork.
'object-type' refers to a Python object, such as int or str.

After registering, the PD submits data as usual with Decoder.put(), with
the only argument a value of the registered object-type.

Split annotation-specific output to another struct

struct srd_proto_data was supposed to be independent of the output
type, but a field specific to annotations snuck in there.

Minor code cleanup

Rename inter-PD output type to SRD_OUTPUT_PYTHON

This better reflects what it is: a python object generated and
processed by python code.

unittests: Update to recent API changes.

srd_session_config_set() is now called srd_session_metadata_set(), and
SRD_CONF_NUM_PROBES and SRD_CONF_UNITSIZE are dropped.

The start() method no longer takes a metadata parameter

Receive samplerate via metadata(), not start()

Pass metadata to PDs only at runtime, not at decoder start

The SRD_CONF_NUM_PROBES metadata key was removed. It wasn't actually
used for anything, since this is trivially available via the configured
(or default) probe list.

The SRD_CONF_UNITSIZE key was removed. The unit size is instead derived
from the probe list: the number of probes packed into the least amount
of space possible defines the unit size.

PD changes:
* The start() method no longer takes a 'metadata' parameter.
* Metadata now comes in only via the metadata() method, which takes
  a key and value. The only key defined so far is SRD_CONF_SAMPLERATE,
  which is exported into the module namespace.

API changes:
* srd_session_send() now takes an end_samplenum parameter, and had its
  options rearranged.
* srd_session_config_set() is now srd_session_metadata_set(). This keeps
  "config" options for a future feature to allow PDs or frontends to
  configure each other's options on the fly, up and down the stack.

Documentation and coding style fixes

Add a 'guess_bitrate' protocol decoder.

This PD tries to guess / detect / estimate a bitrate of e.g. some
UART communication snippet or other protocols.

controller.c: Add checks for srd_inst_option_set().

This also fixes some unit tests that were previously failing.

testsuite: Add some decoder instance related tests.

parallel: Limit number of probes to 8 for now.

This will be increased again at some later point.

session: Add some more parameter checks, minor other fixes.

Some of these also fix unit tests that were previously failing.

testsuite: Add a few session related unit tests.

Add initial sync parallel bus decoder.

Report invalid module name on decoder load

testsuite: Add a few more unit tests.

Minor cosmetics, typos, Doxygen updates/fixes.

Avoid clobbering class variables when setting instance options

Don't release borrowed reference

.gitignore: Add some missing entries.

testsuite: Add some basic tests for loading PDs.

Add a testsuite for libsigrokdecode.

This uses the Check unit testing framework, just like libsigrok.
For now, only a few very basic unit tests are included.

Invocation:

  make check

Properly return error on exception in srd_inst_option_set()

Move all decoder instances and callbacks into a session struct

The struct srd_session also holds configuration parameters formerly
passed to srd_session_start().

The new call srd_session_new() takes a pointer where a newly allocated
pointer to struct srd_session will be stored. This pointer must be
passed as the first argument to all functions that require it.

The SRD_CONF_NUM_PROBES, SRD_CONF_UNITSIZE and SRD_CONF_SAMPLERATE
keys must be configured with srd_config_set() before srd_session_start()
is called.

A new call srd_session_destroy() is also available. This cleans up all
resources the session holds. This is also called from srd_exit() for
all sessions.

Code cleanup

i2s_dump: Fix bug in the WAV output format generation.

Add new i2s_dump protocol decoder.

This stacks of top of the 'i2s' decoder and outputs the audio data to
file (or stdout) in various formats. Currently only WAV is supported.

This is work in progress, it has various hard-coded assumptions.

tlc5620: Output short/long annotations.

This fixes (the remaining parts of) bug #168.

tlc5620: Use annotation types.

This fixes parts of bug #168.

lpc: Initial start-/end-sample support.

This fixes (parts of) bug #163.

lpc: Use annotation types.

This fixes (parts of) bug #163.

lpc: Make the RESET# pin optional.

lpc: Fix handling of optional probes.

lpc: Add annotation helper method.

This fixes (parts of) bug #163.

usb_signalling: Drop packet handling.

The usb_signalling PD should not care about packets, only symbols and bits.
The new (fixed) usb_packet PD constructs packets out of individual bits now.

usb_packet: Major rewrite, e.g. to prepare for GUI usage.

Restructure the PD into a state machine, output individual packet
components as separate annotations, define a protocol output format and
implement it (so that other PDs can stack on top of this one), and fix
various other isses in the PD.

Rename usb_protocol to usb_packet.

There will be further PDs that are stacked on top of usb_packet.

usb_signalling: Document protocol output format.

Also, add missing output for some packet types.

onewire_link: Provide short/long annotations.

onewire_link: Fix typos.

onewire_link: Split "reset" and "presence" annotations.

This needs a few more fixes later, but it's a start.

onewire_link: Default the 'overdrive' option to 'no'.

onewire_link: Use defaults for the PD options.

This also simplifies the PD code a bit.

onewire_link: Drop PD info not useful for the user.

onewire_link: Use annotation types.

This fixes bug #147.

onewire_link: Add/use annotation helpers.

i2s: Add shorter and longer annotations for GUI use.

This fixes (the remaining parts of) bug #162.

i2s: Define/use common proto out format.

i2s: Add helper methods for annotation/proto output.

i2s: Use annotation types.

This fixes parts of bug #162.

Add initial MIDI protocol decoder.

This supports a certain number of MIDI messages already, but not yet all
of them. More will be added later.

usb_signalling: Fix packet annotation.

usb_signalling: Fix EOP handling and annotation.

usb_signalling: Properly use different annotation types.

usb_signalling: Fix decode of individual bits.

After a Start of Packet (SOP) has been detected, "sample" the individual
USB symbolѕ/bits in the middle of the respective bittime (depending on
whether full-speed or low-speed signalling is used).

This fixes various incorrectly decoded cases (bug #158).

usb_signalling: Simplify symbols handling a bit.

usb_signalling: Refactor/simplify bitrate/bitwidth handling.

usb_signalling: Fix start/end sample numbers.

This makes the decoder suitable for GUI usage.

This fixes bug #155.

dcf77: Fix date parity check.

The parity check for certain DCF77 fields/bits was incorrect. It has to be
an even parity over bits 36-58. This is fixed now.

This fixes bug #157.

dcf77: Provide short and long annotations.

dcf77: Fix multi-bit DCF77 field annotations.

dcf77: Consistency renames.

dcf77: Drop PON pin handling.

The PON pin is specific to the Pollin "DCF1 module", but has nothing to
do with DCF77 itself. Thus, drop it from this PD. It can be part of
another stacked PD if needed.

This fixes bug #153.

dcf77: Use proper annotations for DCF77 components.

dcf77: Fix bug in handling of DCF77 bit 0.

dcf77: Fix start-/end-sample numbers.

This fixes bug #154.

i2c: Drop unneeded 'addressing' option.

This (unimplemented so far) option is not needed at all, since the
decoder will be able to detect 7/10 bit slave addresses automatically,
the user doesn't have to specify slave address sizes.

i2c: Drop obsolete TODOs.

i2c: Move OUTPUT_PROTO docs to pd.py.

i2c: Moved extensive protocol docs to the wiki.

i2c: Various fixes to make the PD suitable for GUIs.

The output format of the slave address is now a PD option. It can be
"shifted" or "unshifted", i.e. bit 0 (which contains a read/write
marker) is either shifted out or not, i.e., the slave address is
displayed as 8bit or 7bit number (or 11bit/10bit number for 10bit slave
addresses).

Data bytes (not address bytes) are always shown as 8bit values, of course.

Add annotation types for the individual I2C components such as
start conditions, stop conditions, ACK/NACK, address read/writes,
data read/writes and so on.

This fixes bug #151.

spi: Add some documentation, move OUTPUT_PROTO docs.

Add a short help text for the PD and move the OUTPUT_PROTO docs to pd.py
since they're not meant for the user too see.

spi: Make CS# optional and use it if supplied.

The CS# pin is now optional, it can either be supplied to the PD or not.

If it _is_ supplied, reset the PD state every time it changes. This has
the effect that "incomplete" SPI frames and those where CS# is not
asserted are ignored and not decoded.

This fixes bug #152.

spi: Refactor code, use a state machine.

spi: Provide multiple annotation types.

For now SPI gets the following annotation types:

 - MISO/MOSI SPI data
 - MISO SPI data
 - MOSI SPI data

(i.e. you can see either MISO, or MOSI, or both; the latter is most
useful for CLI usage)

Also, show the hex values as e.g. F5 (upper-case letters, no "0x" prefix).

spi: Fix start-/end-sample numbers.

This now makes the SPI decoder suitable for use in GUIs.

This fixes bug #150.

spi: Make data format a PD option, add annotation types.

The data format can be specified via the PD's "format" option now, it is
no longer an annotation type.

Also, add and use two annotation types: "Data" and "Warnings".

can: Use proper annotation types for the CAN fields.

This allows GUIs to show different fields in different colors.

uart: Output data in separate RX and TX annotation types.

There is one annotation type for the RX side of the communication/data
output now, and another one for the TX side.

This allows GUIs to show them in two different traces, and/or show them in
the same trace but with different colors.

This also has the additional benefit that it is clear which databyte
belongs to which direction. Previously the annotations had to look like
"RX: 5F" or "TX: 11001011", but the "RX: " and "TX: " prefixes are now
no longer required, making the GUI traces (and CLI output too) much more
readable.

uart: Use same length for data output in all cases.

Until now you could get e.g. "d" or "df" as hex output from the UART PD.

This will now be a common-length "0D" and "DF". When all data byte
annotations are of the same lengths the readability in GUI traces is a lot
better. Also, hardcode hex characters to be upper-case (for now).

The same applies to oct ("021" instead of "21") and bin output
("00001001" instead of "1001").

uart: Put annotations into proper annotation types.

There are now extra annotation types for data, start/stop/parity bits and
for warnings (e.g. "invalid parity" or "frame error" or such).

This allows users to select which of the annotation types they want to
see (they can select one/multiple/all annotations as needed), and also
allows them to use different visual representation for the different
annotation types in GUIs (e.g. different colors for the blobs, different
fonts, rectangle/round/elliptic blobs, and so on; how the annotation
blobs are displayed is entirely up to the GUI and its configuration by
the user).

uart: Move OUTPUT_PROTO format description to pd.py.

This is information that a user (when viewing PD info in a GUI/CLI)
should not see (and doesn't care to see), it is meant for developers only.

Thus, make it a comment in pd.py instead.

uart: Drop extensive protocol info (moved to wiki).

Move the full details of the protocol to the wiki, the docs in the PD
itself should only be a short description and/or a collection of notes
that could be useful for a user in a GUI (or CLI) to decide which
PD to select, which options to set how, what PDs to stack where, and so on.

The full protocol description (including photos, examples, ...) is here:

  http://sigrok.org/wiki/Protocol_decoder:Uart

uart: Make data format selection a PD option.

Until now we (ab)used annotation types for outputting the same data
(numbers) in different formats (hex, ascii, binary, and so on).

Turn this into a proper PD option, since annotation types should rather be
used for different _types_ of annotations (e.g. "CRC", "Stop bit",
"Preamble", "Sequence counter", "Warnings", and similar things), not
different _formats_ for the same annotation type.

Old sigrok-cli invocation for hex output:

  sigrok-cli ... -P uart:rx=0:tx=1 -A uart=hex

New:

  sigrok-cli ... -P uart:rx=0:tx=1:format=hex

In GUIs there is now a new "Data format" option where the user can
select the output format for UART data (default is 'ascii').

uart: Use T for stop bit, P for parity bit.

The short(est) annotations for "Stop bit" and "Parity bit" have both
been "P" until now, which is confusing for users (on certain zoom levels
in GUIs). Use "T" for stop bits now instead.

uart: Don't prefix databyte output numbers.

Previously the output was 0x41 or 0o101 or 0b1000001, now it is 41 or
101 or 1000001. We drop these prefixes, since they decrease the readability
of the PD output (especially when displayed in GUIs) and are not needed
anyway since the user knowingly selected the number format before running
the respective PD.

uart: Fix corner-case that can occur with LA triggers.

Assume that the initial pin state is 1/high for the RX and TX lines.

This fixes the decode when an LA triggers on e.g. TX=low (the first
sample would be low in that case, so the falling edge for the start bit
would be missed by the decoder).