add --dont-scan (-D) command line option

Introduce the -D or --dont-scan command line option. This avoids
automatic driver scans, and exclusively uses what -d specifies.

Some device drivers use non-standard protocol features since their
supported devices don't support the corresponding standard mechanisms.
Which can confuse conforming devices. In these situations it can be
desirable to not scan automatically for available devices, instead do
nothing until callers will specify the -d option.

This change is motivated by but does not resolve bugs #1155 and #1373.

doc: update manpage, mention -A and annotation rows

Extend the manpage section which documents the -A option to select
annotation output. Mention that rows are supported in addition to
classes.

Rephrase the paragraph about multiple decoder specs in a single -A
option. Each of them can select multiple annotation classes, while the
previous documentation strongly suggested that only one class would be
available. [ best viewed with 'git diff -U10' ]

decode: accept annotation rows for -A specs

Extend the logic which parses -A annotation selection specs. Lookup
annotation classes first for backwards compatibility. Then lookup rows
when classes don't match.

Users can mix classes and rows in -A specs as they like. This is a
convenience feature, to eliminate the tedium of spelling out many
classes when a row is to be shown. Which is useful to only see the
"summary", the uppermost protocol layer within a protocol decoder, while
the individual bits on lower layers of that same protocol decoder are
not of interest. It's more accessible to specify

  -A ir_rc5=fields
  -A ac97=slots-out
  -A i2c=addr-data

instead of

  -A ir_rc5=startbit1:startbit2:togglebit-0:togglebit-1:address:command
  -A ac97=slot-out-tag:slot-out-cmd-addr:slot-out-cmd-data:slot-out-03:slot-out-04:slot-out-05:slot-out-06:slot-out-07:slot-out-08:slot-out-09:slot-out-10:slot-out-11:slot-out-io-ctrl
  -A i2c=start:repeat-start:stop:ack:nack:address-read:address-write:data-read:data-write

As an additional benefit row specs remain stable across decoder updates
which introduce new annotation classes on existing rows.

decode: rephrase logic which looks up -A specs

The previous logic scanned for specific annotation classes listed in -A,
broke the loop when nothing was found, otherwise registered the matching
annotation for display later on.

Rephrase the logic such that classes get registered when found, and then
advance to the next spec. Only mismatch will "fall through" to the error
path and terminate the setup routine with a fatal error.

This prepares for an optional lookup of annotation rows when class
lookup fails, before a fatal error is returned.

decode: nits, whitespace and line length fix

Address nits in the setup_pd_annotations() routine. Fixup an occurance
of too deep an indentation level (introduced in 790b026162332). Rephrase
a long line while we are here, to cut its length and for consistency
with other "visible annotations" manipulations in other locations.

decode: improve readability, use intermediate variables

Replace repeated complex keyval[] references with open coded indices by
respectively named variables. Also use 'ann_id' for an often referenced
annotation ID text string, for consistency with decoder ID.

decode: fix memory leaks in annotation setup error paths

Add --list-supported-wiki option.

This is meant for developers only, to easily update the list of
supported protocol decoders in the sigrok wiki.

README: Bump libsigrokdecode requirement to >= 0.6.0.

We now depend on the decoder tags feature introduced in the
libsigrokdecode 0.6.x series.

Decoder --show output: List decoder tags.

Fix listing of some configuration options.

The listing of the following configuration options is currently
broken in sigrok-cli (invalid values are displayed):

 - "timebase" in yokogawa-dlm, rohde-schwarz-hameg, hantek-dso,
   lecroy-xstream, siglent-sds and rigol-ds drivers;
 - "vdiv" in hantek-6xxx, yokogawa-dlm, rohde-schwarz-hameg, hantek-dso,
   lecroy-xstream, hung-chang-dso-2100, siglent-sds and rigol-ds drivers;
 - "spl_meas_range" in pce-322a and cem-dt-885x drivers.

Fixes bug #1331.

Signed-off-by: Guido Trentalancia <redacted>

decode: stricter check for integer decoder options

Tighten the check for integer type decoder options. Insist that the
conversion must have consumed all of the input text. Early reject specs
like "1m" or "8.0", but also unusual specs like "1 ". This shall avoid
later confusion when "seemingly accepted" specs won't take effect during
operation.

decode: add support for float option data type

Accept decoder options where the value is a floating point number. This
fixes bug #1247 (the "unsupported type" issue reported for sigrok-cli).

manpage: Clarify annotation classes in -A description.

manpage: Fix -A description wrt default annotations shown.

main: synchronize --get output for MQ with --show output

The --show output used to print human readable text for measured
quantities, --get printed raw numbers for quantity and flags. Adjust
main.c:get_option() to follow the show.c:show_dev_detail() model for
consistency and usability.

doc: minor update to -O and -g options in the manpage

Demonstrate output format options by means of "-O csv:..." which as a
byproduct also demonstrates booleans. Add an example how to combine -g
and -c, configuring an option of a channel group.

manpage: Various updates and improvements.

doc: mention lack of decoder signal name matching in manpage

Users may assume that sigrok-cli automatically matches input trace names
to decoder signals like pulseview does, and not be able to learn that
this is not the case. Explicitly state that limitation in the manpage.

doc: discuss protocol decoder stacks in the manpage

The previous version mentioned comma-separated lists of decoders, which
is correct but also was easy to miss. Add a discussion and examples on
stacking decoders as well as creating multiple decoder stacks.

Fix invalid frame limit error reporting

This patch fixes a bug in the sigrok command-line interface error reporting
when an invalid frame limit is selected for the Hameg/Rohde&Schwarz HMO
mixed-signal oscilloscope driver (hameg-hmo).

Signed-off-by: Guido Trentalancia <redacted>

input: make read from stdin work with the presence of -I specs

The previous implementation supported reading from stdin, but only when
-I was not specified (i.e. with auto detectable input formats). Accept
stdin also when -I was specified, i.e. with the full set of supported
input formats (given they can get streamed).

main.c: Minor cosmetic fix.

Minor fix that makes Clang Static Analyzer stop complaining

Bugfix in order to make sr_session_stop() actually work.

The sr_session_stop() calls were previously invoked with the session
pointer being NULL, which didn't actually stop the session. This could
lead to samples still being processed and (e.g.) passed to libsigrokdecode
for decoding, even though the session should have been stopped.

Fix this by passing the session pointer along in the
sr_session_datafeed_callback_add() function, so that the callbacks
can make use of it.

session: Don't run nop transform unless explicitly requested.

options: --help output cosmetics.

input.c: Rename BUFSIZE to CHUNK_SIZE.

input: Increase chunk size from 16KB to 4MB.

This not only slightly speeds up loading files, but more importantly leads
to larger chunks being passed to input modules (and later potentially output
modules), some of which can have a large performance penalty for small chunks.

In the specific case of e.g. binary input and an .sr output file this change
can lead to a speedup of 220x or more (due to larger chunks for srzip).

sigrok-cli.h: Drop unused functions and #defines.

Add a .desktop file and an icon.

manpage: Don't list specific output formats, mention -L.

The list is going to be outdated eventually (e.g. "gnuplot" no longer
exists), it's better to just mention that -L can be used to get a list.

Force backup analog traces only if needed

With the current conditions, when using the 'srzip' output module with
device generating SR_DF_ANALOG packets, they are processed both by
'srzip' and the backup 'analog' module (as 'out' is always null for
srzip which does its own file operation).
For a moderately fast continuous analog capture (e.g. 2.4MSamples/s),
the overhead of the 'analog' module is important (e.g. 80% of the whole
processing of my workstation) while we are not using its output,
so disable it when the user actually selected an output format/file
but the module doesn't generate text output.

Also remove the second part of the condition as 'opt_output_format'
never seems to be null or at least not in the case where the user has
omitted output parameters.

Tested with a device generating analog packets both with '-o test.sr'
and no output option.

Update manpage references from -V to -L

Since bug #604, the supported drivers, decoders and input/output formats
are listed by -L|--list-supported.

Update the references in the manpage to -L, accordingly.

decode: Always print colon after protocol decoder ID

Remove the "bug compatibility" support. It's assumed that the omission
of the colon after the protocol decoder ID in log level 3 was less of a
design choice, but instead a byproduct of the redundancy in a previous
implementation (multiple code paths that got out of sync).

doc: add --protocol-decoder-samplenum option to the manpage

decode: Optionally print sample numbers with protocol decoder annotations

Introduce the "--protocol-decoder-samplenum" command line option (no
short form available), which emits sample numbers with textual output
from protocol decoder annotations, regardless of a log level value.

This shall increase usability of sigrok-cli output with external
postprocessors, as the option exclusively adds sample numbers to the
output but does not affect the presence or layout of any other line.

This commit prepends "text" and "meta" annotations with sample number
information. It does not change "binary" output.

decode: Rework logic for text output of protocol decoder annotations

Fold the previous three code paths which formatted text output for
annotations into one code path, which inspects the flags that were
determined before the actual output, and then always formats the fields
in identical ways regardless of why a field is shown.

Remove the assert checks that were introduced in a previous commit. The
logic for the field selection was proven to be identical to the previous
behaviour.

decode: Prepare to rework text output for protocol decoder annotations

When the current implementation receives a protocol decoder annotation,
one out of several code paths prints one of several different variations
of text layout. The current implementation exclusively checks the active
log level to determine the layout variant.

Prepare to rework that text layout logic. Separate the determination of
which fields to display from the logic which does emit those fields in a
specific format.

This commit does not yet adjust the print statements. It is supposed to
verify that the "which fields to display?" logic results in identical
behaviour to the previous implementation.

decode: Nit, avoid 'class' identifier for local variable

session: Adjust scan for non-demo device

The "demo?" condition is a property of the driver not a device instance.
Adjust the check accordingly, by not passing the 'sdi' when retrieving
the list of options. Rename the involved variable to reflect its purpose.
Adjust an error message text.

This fixes bug #848.

HACKING: Prefer git pull requests over mailing list patches.

Also, drop the reference to gitorious.org (no longer available).

configure.ac: Bump package version to 0.8.0.

0.8.0 will be the next major release. Bump now, so that
there is no confusion of tarball 0.7.0 and 0.8.0-git snapshots.

NEWS: Update for upcoming 0.7.0 release.

Fix various clang warnings.

../show.c:668:30: warning: variable 'q' is uninitialized when used here [-Wuninitialized]
                                        s = sr_period_string(p, q);
                                                                ^
../show.c:324:30: note: initialize the variable 'q' to silence this warning
        const uint64_t *uint64, p, q, low, high;
                                    ^
                                     = 0
../show.c:668:27: warning: variable 'p' is uninitialized when used here [-Wuninitialized]
                                        s = sr_period_string(p, q);
                                                             ^
../show.c:324:27: note: initialize the variable 'p' to silence this warning
        const uint64_t *uint64, p, q, low, high;
                                 ^
                                  = 0
../show.c:458:58: warning: variable 'high' is uninitialized when used here [-Wuninitialized]
                                printf("    Maximum number of samples: %"PRIu64"\n", high);
                                                                                     ^~~~
../show.c:324:41:   CC       input.o
note: initialize the variable 'high' to silence this warning
        const uint64_t *uint64, p, q, low, high;
                                               ^
                                                = 0
../show.c:589:33: warning: variable 'low' is uninitialized when used here [-Wuninitialized]
                                printf("%"PRIu64"-%"PRIu64, low, high);
                                                            ^~~
../show.c:324:35: note: initialize the variable 'low' to silence this warning
        const uint64_t *uint64, p, q, low, high;
                                         ^
                                          = 0

HACKING: Update URL to Linux kernel coding style.

README: Drop trailing whitespace.

Fix build when using --without-libsigrokdecode.

Installer: Whitespace consistency fixes.

Installer: Add "sigrok-cli" to uninstaller/Zadig links.

Windows 10 merges all links of the same vendor ("sigrok" here) into one
section in the Start menu. If PulseView and sigrok-cli are installed,
there will be two "Uninstall" links and the user will not know which one
uninstalls which program.

Installer: Place set of example .sr files in separate section

--list-supported: Show detailed library/feature info.

List supported devices, modules, decoders via --list-supported.

Move this data from -V to -L|--list-supported for usability reasons.

This fixes bug #604.

Bump requirements to libsigrok/libsigrokdecode 0.5.0.

We use various new API calls from the upcoming 0.5.0 releases and are
not compatible with the respective 0.4.x anymore.

show: Also print the possible decoder input/output IDs.

options: expand builtin help, discuss samples/time/continuous constraint

It might be surprising when the sigrok-cli(1) program does nothing (yet
spends user noticable time) before quitting while it spews the --help
text to the screen. Expand the builtin help text, explicitly mention
that either of --samples or --frames or --time or --continuous are
essentially required for data acquisition.

Update sr_period_string usage

configure summary: Show linker flags.

Show annotations based on decoder ID

Originally, decoder ID was equal to decoder instance ID, so it didn't
matter what you were comparing with. However, with distinct decoder
instances, this assumption fails. Because instance IDs can't be known
in advance, and because it would make the CLI arguments even more
complex, we simply let the -A option continue to be per decoder, not per
instance. This maintains compatibility with prior behaviour, but
doesn't allow the full flexibility possible with the library.

Behaviour preserved:
Single PD, no -A flag => all annotations from PD
Single PD, -A pdid => all annotations from PD
Single PD, -A pdid=annX => annX from PD

Behaviour now added:
Duplicate PDs, no -A flag => all annotations from all PDs
Duplicate PDs, -A pdid => all annotations from all PDs of type pdid
Duplicate PDs, -A pdid=annX => all annX from all PDs of type pdid

This fixes parts of bug #868.

Signed-off-by: Karl Palsson <redacted>

valgrind: Clear more unfreed memory issues

Command line used for checking:

  $ valgrind -v --leak-check=full ./sigrok-cli \
    -i rockband_wireless_keyboard_wii/midi_key4.sr \
    -P uart:baudrate=31250,midi -P uart:baudrate=31250,midi

Signed-off-by: Karl Palsson <redacted>

Include decoder instance ID in normal outputs

Without this, it's nigh impossible to determine what lines of output are
from what decoder. While -l 4 and above will include this information,
this feels like something that is essential even at the basic level.

Old:
System Realtime: active sensing
System Realtime: active sensing
System Realtime: active sensing
UNHANDLED DATA: 0x00
Channel 1: note on (note = 51 'D#3', velocity = 70)
System Realtime: active sensing
System Realtime: active sensing
System Realtime: active sensing
System Realtime: active sensing
UNHANDLED DATA: 0x00
Channel 1: note on (note = 51 'D#3', velocity = 70)
System Realtime: active sensing

New:

midi1: System Realtime: active sensing
midi1: System Realtime: active sensing
midi1: System Realtime: active sensing
midi1: UNHANDLED DATA: 0x00
midi1: Channel 1: note on (note = 51 'D#3', velocity = 70)
midi1: System Realtime: active sensing
midi2: System Realtime: active sensing
midi2: System Realtime: active sensing
midi2: System Realtime: active sensing
midi2: UNHANDLED DATA: 0x00
midi2: Channel 1: note on (note = 51 'D#3', velocity = 70)
midi2: System Realtime: active sensing

This fixes parts of bug #868.

Signed-off-by: Karl Palsson <redacted>

Support multiple protocol decoder stacks

Requires libsigrokdecode changes to actually work.
This allows multiple -P options to be specified, each of which is
registered as a full stack with libsigrokdecode.

At this point, there's no way to specify annotations per instance, the
annotations are simply global per decoder (as before) rather than per
instance.

This fixes parts of bug #868.

Signed-off-by: Karl Palsson <redacted>

Drop -S stack option

The -P option already stacks. The -S option was only used for changing the
stacking order. Simply require the correct order with -P. This reduces
the confusion in stacking.

Signed-off-by: Karl Palsson <redacted>

sigrok-cli_cross.nsi.in: Use Python 3.4 (Windows XP support).

The last Python version to officially support Windows XP was 3.4.x.

We'll keep the Windows installers at that version for the time being,
until Windows XP support is no longer feasible (e.g. because important
sigrok requirements such as Qt, glib, or libusb drop XP suppport).

sigrok-cli_cross.nsi.in: Bump Python version to 3.6.

license: remove FSF postal address from boiler plate license text

Remove the FSF postal address as it might change (it did in the past).
Reference the gnu.org website instead which is more stable.

--help output: More specific --show help text.

Mention that --show also works for showing input/output format options,
as well as protocol decoder options.

This fixes bug #851.

show: print binary classes as well in protocol decoder details

The output of `sigrok -P <decoder> --show` omitted the binary classes,
users could not learn which specs are available for the -B option.  Add
a "Binary classes:" section after the list of annotations.

Signed-off-by: Gerhard Sittig <redacted>

configure.ac: Bump package version to 0.7.0.

0.7.0 will be the next major release. Bump now, so that
there is no confusion of tarball 0.6.0 and 0.7.0-git snapshots.

NEWS: Update for upcoming 0.6.0 release.

Update API calls due to recent libsigrok renames.

 - sr_driver_scan_options() -> sr_driver_scan_options_list()

 - sr_dev_config_capabilities() -> sr_dev_config_capabilities_list()

Update for configuration API changes.

input: Use own main loop instead of sr_session_run()

Again, this is mainly for demonstration purposes, and to make
sigrok-cli consistently use the same "modern" API everywhere.

build: Require GLib 2.32.0

This is needed for the G_SOURCE_REMOVE symbolic constant. Although
it would be trivial to make do without it, there is no reason not to
bump the requirement since libsigrok depends on GLib 2.32.0 anyway.

anykey: Use GLib I/O channel watch

Watch for input on a GLib I/O channel using the standard GLib main
loop API instead of injecting an FD event source into the sigrok
session loop.

Also run the session in a main loop created by sigrok-cli instead
of using sr_session_run(). This is mainly for demonstration; the
GLib I/O watch change would work even with sr_session_run() since
it is using the same main context in this case.

options: Type of G_OPTION_ARG_NONE is gboolean

Change mistaken gchar * variables to gboolean type.

Use g_strerror() in favor of strerror().

windows: Install data files into share subdirectory

This allows these files to be found on standard paths relative
to the executable location.

Makefile.am: Shorten ChangeLog target a bit.

Build: Move _POSIX_C_SOURCE definition to config.h

Do not redefine it though when already set, so that it can be
overridden by the user, or indirectly by the compiler settings.

Build: Include <config.h> first in all source files

Since Autoconf places some important feature flags only into the
configuration header, it is necessary to include it globally to
guarantee a consistent build.

Use PRIu64 instead of %ld for uint64_t printing.

Clean up .gitignore

Build: Adopt modernized Autotools build system

Build: Add copy of sigrok.m4 from libsigrok

device: Use g_ascii_strcasecmp() for portability

Free trigger after acquisition session.

NSIS installer fix for Windows

Support SR_T_MQ.

Support SR_T_MQLIST.

Use new sr_key_info instead of sr_config_info.

session: Use INTERNAL_IO_HANDLING output module flag

Also, fix the segfault occuring due to an invalid outfile
handle when using srzip.

Pass unitsize to srd_session_send() directly.

Follow an API change in libsigrokdecode where srd_inst_channel_set_all()
no longer gets passed a unitsize, but rather srd_session_send() gets it.

This allows us to avoid having to guess a unitsize based on the number
of channels (which guesses incorrectly in some cases).

This fixes (parts of) bug #352.

nsis: Add start menu entries for Zadig.

This fixes bug #543.

Don't open an output file in the case of srzip.

This fixes parts of bug #570.

session: Supply filename to the output module directly

This fixes parts of bug #570.

Build-depend on the upcoming libsigrok + libsigrokdecode 0.4.0.

Bump version to 0.6.0 (the upcoming next major release).

Append "-git" to the version string.

This avoids confusion with the released tarballs.

Check if hash table is NULL before accessing it.

This fixes bug 520.