uni-t-ut32x: rephrase the receive buffer and packets relation

The previous implementation assumed that a receive data chunk ends
exactly with a sensor packet's end. Yet the buffer had 32 bytes while
the packets have 19 bytes.

Separate the data reception from the packet processing. Collect whatever
chunks the USB connection provides, and scan the resulting buffer for
packets. Cope with either incomplete or corrupt or misaligned packets as
well as with multiple packets in receive chunks. The latter might happen
upon initial synchronization, when a device already sends data or the
serial port buffered previously communicated data.

In the regular case, the computer will process so fast that each single
character will be handled individually. We don't mind. The frequency is
some 60 times per second, and the data volume is 19 bytes. The software
works for the regular case, and synchronizes fast at startup or after
comm errors.

uni-t-ut32x: improve robustness of packet parser, more diagnostics

Always print the data bytes of received buffers in the packet parser,
then check some more fixed fields to not process invalid packets, then
process the packet content as the previous implementation did.

Call the packet parser for incomplete packets and discarded input
buffers as well (initial synchronization, re-sync after comm errors).
This results in the availability of more diagnostics during development.

Pass the packet's location and size from outside. This prepares the
logic to cope with situations where the receive buffer contains multiple
(potentially incomplete) packets.

uni-t-ut32x: use ASCII literals in packet parser, symbols for magic numbers

Slightly unobfuscate the UT32x packet parser. The protocol is mostly
ASCII based, checks for hex numbers may be unexpected. Use symbolic
identifiers for the packet length and some special characters.

uni-t-ut32x: comment on the "T1-T2" channel name (looks like a range)

uni-t-ut32x: use common code for sw limits, minor data type fixup (data source)

uni-t-ut32x: pre-set to default conn= spec

The previous implementation of the UT32x driver expected to see a conn=
spec, without it no device is found. Default to the USB identification
of the CH9325 chip, to make the driver work out of the box. Users still
can provide conn= specs and override the default for other cables.

doc: update README.devices (USB detection, enable serial comm)

Slightly rephrase README.devices since there is no strict distinction
into "fully automatic" and "always manual". Some drivers _accept_ conn=
specs when provided, _and_ support automatic detection of enumerable
devices, _and_ might implement defaults but also support overrides.

Nit, numerically sort the list of Uni-T cables (which is about to grow
in the future) for improved readability.

Add two more devices which require users to manually enable the serial
communication (Brymen BM257s, EEVBlog 121GW).

bindings: Add Output::format()

rigol-ds: Fix memory buffer readout on DS4000 series.

Add support for YiXingDianZi MDSO in hantek-6xxx driver.

scpi-pps: add support for BK Precision 9130

scpi-dmm: add experimental Keysight 34465A support

Tested DC current, DC voltage, and resistance. Instrument gives an error
only on first measurement but the output of the measurements is correct.

contrib/60-libsigrok.rules: Mention FT232H/ftdi-la item.

ftdi-la: added FT232H device ID

bindings: Add new Context::create_end_packet() method.

python: Add override for Context.create_logic_packet()

dmm/eev121gw: fix a typo in a comment

pickit2: avoid NULL dereference in close code path

ipdbg-la: Check if limit samples is valid (leq size of ringuffer)

Don't reference SR_PACKAGE_VERSION_STRING directly in backend.c.

Reporting build versus runtime versions makes sense for a client,
but not inside the library itself.

Don't reference SR_PACKAGE_VERSION_STRING directly in output modules.

drivers: Make per-driver sr_dev_driver structs static.

microchip-pickit2: Drop unneeded prefix.

microchip-pickit2: Minor cosmetics.

microchip-pickit2: first driver implementation (acquisition works, triggers don't)

Fill in the scan, open/close, get/set/list, acquisition start/stop logic
such that data acquisition with a PICkit2 works.

Trigger support needs more attention. User specified triggers either
seem to not take effect, or the trigger position is not in the expected
location. It's yet to get determined what's the issue.

This implementation is based on protocol information gathered from the
pk2-la project.

microchip-pickit2: Initial driver skeleton.

brymen-bm86x: drop redundant free call, fixup channel index

Remove a free() call in an error path for a list which immediately
before the call was determined to be NULL. Use index 0 and 1 for
channels P1 and P2 respectively (the previous implementation used 0
for both channels).

scpi-dmm: run OPC queries immediately before essential commands

The current implementation of the SCPI DMM driver is conservative about
checking the device's being operational, but the *OPC? queries are found
in unfortunate locations. Run the OPC query right before running the
next "actual" command, not afterwards. And certainly not between sending
requests and potentially gathering responses in subsequent calls.

This commit does not change current behaviour, but improves maintenance
before pending commits.

scpi-dmm: return MQ table entry to "get MQ" routine callers

The "get MQ" helper routine communicates SCPI responses and translates
them to internal "MQ and flag" values. Optionally return the MQ table
entry reference to callers, so they don't have to repeat the table
lookup when the function's default precision is required, or should
future "start acquisition" requests need to refer to the meter's current
function.

scpi-dmm: adjust MQ table for Agilent 34405A

Rename the table to reflect that it's model specific. Remove the 4-wire
resistance function which this device does not support.

scpi-dmm: add support for model specific device options

Supported SCPI DMM devices will differ in the set of options and whether
parameters can get queried or configured. Use a "generic" set of devopts
during scan and for simpler models, prepare support for other sets of
devopts for more complex models.

scpi-dmm: accept serialcomm= scan options

scpi: alpha-sort the vendor alias list

scpi: add Keysight vendor alias

scpi-dmm: move declaration of local variable out of header file

Remove always-false condition

Python-Binding: Added data array for logic packet payload

scpi-dmm: Implement support for Agilent 34405A, prepare others

Implement the scpi-dmm driver in such a generic way that it could work
with several protocol variants and with differing models which happen to
use any of these protocol variants. Prepare a list of supported models
with their respective SCPI command set, set of DMM functions and their
precision.

Add support for Agilent 34405A. The ten functions of this device got
tested and are operational, in continuous mode as well as with sample
count or capture time limits. The driver can query the current meter's
function, can change the function, and can run acquisitions in either
the current mode or with a user specified function selection. There is
some potential for improvement: AUTO/MIN/MAX/HOLD indicators are not
supported by this implementation.

scpi-dmm: Initial driver skeleton.

scpi: nit, use glib to determine string vector length

Replace a DIY length calculation with a glib call.

scpi: introduce string un-quote helper routine

The SCPI protocol may communicate strings in quoted form, enclosed by a
matching pair of single or double quote characters, and occurances of
this very quote character within the string get doubled (escaped). Add a
common routine to undo the quotes.

fluke-45: fix minor memory leaks in the probe routine

Free the SCPI hardware info after successful model detection, too. Only
allocate the device instance when a supported model was found. Link the
device context earlier right after allocation, for easier verification.

fluke-45: disable ECHO test, it confuses other SCPI devices

Disable the ECHO test in the Fluke 45 probe routine which violates the
SCPI protocol and makes other devices unavailable. This fixes bug #1272.

fluke-45: avoid NULL dereference in the probe routine

The Fluke 45 probe routine tries to detect whether the serial port is
"in echo mode" (which already is questionable before the IDN query).
In the absence of a response, the library segfaults. Fix it.

README.devices: add example for -d driver:conn=usbtmc/bus.addr

Free list returned by sr_session_dev_list()

==214948== 16 bytes in 1 blocks are definitely lost in loss record 161 of 6,440
==214948==    at 0x4C2EE0B: malloc (vg_replace_malloc.c:299)
==214948==    by 0x650F435: g_malloc (in /usr/lib64/libglib-2.0.so.0.5600.3)
==214948==    by 0x6527056: g_slice_alloc (in /usr/lib64/libglib-2.0.so.0.5600.3)
==214948==    by 0x65284B0: g_slist_copy_deep (in /usr/lib64/libglib-2.0.so.0.5600.3)
==214948==    by 0x592BBA6: sr_session_dev_list (session.c:402)
==214948==    by 0x56EF7B5: sigrok::Session::Session(std::shared_ptr<sigrok::Context>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >) (classes.cpp:932)

==214948== 16 bytes in 1 blocks are definitely lost in loss record 162 of 6,440
==214948==    at 0x4C2EE0B: malloc (vg_replace_malloc.c:299)
==214948==    by 0x650F435: g_malloc (in /usr/lib64/libglib-2.0.so.0.5600.3)
==214948==    by 0x6527056: g_slice_alloc (in /usr/lib64/libglib-2.0.so.0.5600.3)
==214948==    by 0x65284B0: g_slist_copy_deep (in /usr/lib64/libglib-2.0.so.0.5600.3)
==214948==    by 0x592BBA6: sr_session_dev_list (session.c:402)
==214948==    by 0x56F1EB1: sigrok::Session::devices() (classes.cpp:967)

siglent-sds: Consistently use gboolean/TRUE/FALSE.

Additional USB PID for Rohde&Schwarz HMO series mixed-signal oscilloscopes

Add another possible USB PID for Rohde&Schwarz HMO series mixed-signal
oscilloscopes (previously branded Hameg).

dmm/eev121gw: drop an obsolete TODO comment (power measurement)

dmm/eev121gw: cosmetics, align ranges' scaling table entries

Align the scaling items such that all numbers are aligned. Drop unneeded
"prefixes" for the 2nd display's tables, the main and sub displays already
have their individual tables which reside in their respective groups.

dmm/eev121gw: add missing scale items for sub display in power modes

Complete the voltage and current scale items for the sub display which
were incomplete for VA, mVA, and uVA power measurement modes before.

serial_stream_detect(): Make a code comment more generic.

demo: Fixup soft-trigger

demo: Implement logic triggering.

Analog triggers and other items still need more work.

demo: Port trigger configuration from fx2lafw.

Random whitespace/cosmetic/typo fixes.

serial-dmm: add EEVblog 121GW device entry (-d eevblog-121gw:conn=<uart>)

Add an "eevblog-121gw" subdriver entry for the EEVblog 121GW multimeter.
Use device dependent channel names instead of the default "P1" etc names.

It's assumed that the device's binary packet data is available at a COM
port. This means that an external BT to UART gateway is required until
BLE communication will be one of libsigrok's native connection types.

dmm/eev121gw: introduce parser for EEVblog 121GW 19-byte binary packets

Introduce the dmm/eev121gw.c source file with parse routines for the
EEVblog 121GW meter's 19-bytes binary packets. Get the values and MQ
properties of the device's several displays (main, sub, bar) in several
individual parse calls.

This commit introduces initial support for the device. Some of the modes
and features are untested, as are some of the device's ranges.

Newer versions of Victor DMMs (at least for 86) contain a direct
Mini-USB port. This port speaks the FS9922 protocol.

Picture of Mini-USB version:
http://roastlogger.co.uk/coffee/roastlogger/victor86.html

Signed-off-by: Thomas Weißschuh <redacted>

siglent-sds: Fix SR_CONF_AVERAGING/SR_CONF_AVG_SAMPLES handling.

siglent-sds: Add ESERIES device support.

Due to some SCPI command changes that Siglent made, the connection
failed due to the wrong commands being send to the device.

This might fix parts of bug #1242, though initial tests show that
further changes might be needed.

[Note: This commit consists of multiple squashed commits from
marchelh <redacted> and various fixups and rebasing
operations by Uwe Hermann <redacted>]

korad-kaxxxxp: Add Tenma 72-2540 V2.0/V2.1 support (untested).

The IDN strings were mentioned here:
https://github.com/kxtells/tenma-serial/issues/2

serial: dump DMM packets during stream detection

Regular operation of serial DMM drivers optionally can dump packet bytes
after the intialization phase has synchronized to the stream. Failure to
synchronize to the stream left developers without a dump, which complicates
research what went wrong.

Do dump packet content while the serial_stream_detect() routine tries to
synchronize to the stream. Use the spew level since the dump occurs upon
every attempt, which translates to: every received byte until a valid
packet was seen (or the synchronization phase expired).

serial-dmm: print data bytes according to specific meter's packet length

The previous implementation always dumped 23 data bytes for received
packets. This could result in truncated diagnostics information, and/or
access to invalid buffer content.

Rephrase the packet dump routine such that the specific meter's exact
packet length gets dumped, and use the common hex dump support code.

uni-t-dmm: use common hex dump helper routine

strutil: introduce hex dump routines (allocate a text buffer)

Introduce common support for hex dumps in the string util collection.
There are explicit allocation and release routines for the textual
representation of the data bytes, so that callers are free to chose
whether and how to decorate the dump and where to send the message.

input/vcd: add channel list checks for file re-read

Keep (part of) previous results around when the VCD input module gets
reset, and check the header of the next import against previous runs to
avoid issues in applications. This addresses the VCD specific part of
bug #1241, and resolves the remaining part of bug #1306.

device: introduce routines to compare channels and channel lists

Applications are not prepared to handle changes in the channel list
between multiple acquisitions from the same source (device drivers
or input modules). Introduce common helpers to compare channels and
channel lists.

device: introduce common sr_channel_free() support code

There was the sr_channel_new() allocation routine, but releasing that
allocation was open-coded in call sites. Add the sr_channel_free()
routine for code re-use and consistency.

input/vcd: Expand the reset() logic

This addresses part of bug #1306. The reset() method of the VCD input
module was incomplete, and did not process new data upon second read.
Improve robustness and add missing reset instructions. Void invalid
pointers and avoid NULL dereferences in cleanup paths.

korad-kaxxxxp: add yet another KD3005P identification string

Apparently there are devices which identify as "KORADKD3005PV2.0" (no
whitespace, no trailing 0x01). Add another model entry.

Reported-By: Lars Pötter

zeroplus-logic-cube: Only emit log message upon unexpected number of bytes.

Fix various gcc 8 compiler warnings related to ARRAY_SIZE.

Example:

  In file included from src/hardware/kecheng-kc-330b/protocol.h:26,
                   from src/hardware/kecheng-kc-330b/api.c:22:
  src/hardware/kecheng-kc-330b/api.c: In function ‘config_list’:
  src/libsigrok-internal.h:51:34: warning: division ‘sizeof (void *) / sizeof (void)’ does not compute the number of array elements [-Wsizeof-pointer-div]
   #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
                                    ^
  src/libsigrok-internal.h:55:32: note: in expansion of macro ‘ARRAY_SIZE’
   #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
                                  ^~~~~~~~~~
  src/libsigrok-internal.h:964:43: note: in expansion of macro ‘ARRAY_AND_SIZE’
    std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \
                                             ^~~~~~~~~~~~~~
  src/hardware/kecheng-kc-330b/api.c:296:10: note: in expansion of macro ‘STD_CONFIG_LIST’
     return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
            ^~~~~~~~~~~~~~~

fx2lafw: Add new VID:PID for usb-c-grok

serial-dmm: introduce support for subdriver specific channel names

Default to the existing "P1" etc naming scheme for analog channels of
serial-dmm subdrivers. Add support for subdriver specific channel names
(which can reference the channel number if they desire). This is useful
for devices with multiple displays, or special purpose devices where
other names than P1 can better reflect the channel's nature.

serial-dmm: only send acquisition data for enabled channels

Respect the user's "channel enabled" status. Do not feed the session bus
when data for disabled channels was received.

serial-dmm: count analog DMM channels starting at 1

Commit 556a926d432dd introduced support for multiple displays in
subdrivers of serial-dmm, but also changed user visible channel numbers
to start from 0. Restore the previous behaviour, start counting from 1
which users may perceive as more natural (serial-dmm used to start at P1
in the past, scopes start with CH1 as well).

brymen-bm86x: avoid NULL deref when usb->devhdl does not exist

There are code paths where dev_close() tries to access a USB handle
which does not exist. This was observed with this command:

  $ sigrok-cli -d brymen-bm86x --scan

Makefile: cosmetics, alpha-sort src/dmm/ entries

hantek-6xxx: Hantek 6022BL: Add VID/PID 04b5:602a support.

On Windows, this device can either enumerate as 04b4:602a or 04b5:602a,
depending on which vendor driver is currently being used, so we have to
support both in the hantek-6xxx driver as well.

This fixes bug #1295.

raw_analog: Set appropriate precision digits for sample format.

This fixes parts of bug #950.

analog output: convert binary to digital digits of precision.

This fixes parts of bug #950.

Fix read past end of array in sr_analog_si_prefix_friendly.

In the case where the input unit was not in the array, the for loop would
complete, but the following test would then read past the end of the array
since 'i' would already have been incremented to the array size.

Spotted because unitless data was getting SI prefixes with no unit, though
this would not have been deterministically reproducible.

This fixes parts of bug #950.

scpi-pps: Add a missing "break" in config_get().

Make sr_packet_{copy,free} API calls public.

This fixes bug #1277.

scpi-pps: Fix broken channel selection code.

Fixes bug #1279.

scpi-pps: Use software sample and time limits.

scpi-pps: Don't block waiting for a value on capture stop.

The comment says "A requested value is certainly on the way", but the code no
longer works this way. The receive handler requests a value and blocks until
it is received. There is no value pending between receive handler calls, so
this code now only leads to a timeout.

Add udev rules for Rigol DP800 series.

output/csv: Disable the dedup option by default.

Having this on by default is surprising to most users, since csv is
not usually associated with having a VCD-like dedup property/feature.

std: Drop unneeded/duplicate log messages.

The sr_session_send() function will already log all of those anyway.

hantek-4032l: Fix default threshold value selection (FP workaround).

Take value from generated array of range instead of using a hard-coded value.

Signed-off-by: Andrej Valek <redacted>

std: Fix up non-zero FP value generation

input: improve robustness, avoid NULL dereference in sr_input_send()

Applications might pass NULL for the buffer, and input modules might
accept it (or just cope). Eliminate a potential NULL dereference in
the emission of diagnostics messages.

proto.h: move routine declaration to its respective group

sr_resourcepaths_get(): Drop confusing log message.

This is not really needed and can sometimes confuse users.

hantek-6xxx: Hantek 6022BE: Add VID/PID 04b5:6022 support.

On Windows, this device can either enumerate as 04b4:6022 or 04b5:6022,
depending on which vendor driver is currently being used, so we have to
support both in the hantek-6xxx driver as well.

This fixes bug #918.

Consistently use the _WIN32 #define.

The _WIN32 variant is available pretty much on all compilers, others
might not be. G_OS_WIN32 would probably be an equally well-suited
alternative, but for now we standardize on _WIN32.

  http://nadeausoftware.com/articles/2012/01/c_c_tip_how_use_compiler_predefined_macros_detect_operating_system#WindowswithCygwinPOSIX

ipdbg-la: Fix two compiler warnings on Windows.

This is happening because the send() and recv() functions
have different prototypes on POSIX and Windows. Using the casts
is required on Windows and doesn't hurt on POSIX systems.

  [...]/protocol.c: In function 'tcp_send':
  [...]/protocol.c:161:26: warning: pointer targets in passing argument 2 of 'send' differ in signedness [-Wpointer-sign]
    out = send(tcp->socket, buf, len, 0);
                            ^
  In file included from [...]/protocol.c:24:0:
  [...]/include/winsock2.h:997:34: note: expected 'const char *' but argument is of type 'const uint8_t * {aka const unsigned char *}'
     WINSOCK_API_LINKAGE int WSAAPI send(SOCKET s,const char *buf,int len,int flags);
                                    ^
  [...]/protocol.c: In function 'ipdbg_la_tcp_receive':
  [...]/protocol.c:201:32: warning: pointer targets in passing argument 2 of 'recv' differ in signedness [-Wpointer-sign]
      int len = recv(tcp->socket, buf, 1, 0);
                                  ^
  In file included from [...]/protocol.c:24:0:
  [...]/include/winsock2.h:992:34: note: expected 'char *' but argument is of type 'uint8_t * {aka unsigned char *}'
     WINSOCK_API_LINKAGE int WSAAPI recv(SOCKET s,char *buf,int len,int flags);
                                    ^

ipdbg-la: Fix data_available() implementation on Windows.

  [...]/protocol.c: In function 'data_available':
  [...]/protocol.c:73:38: error: 'bytes_available' undeclared (first use in this function)
    ioctlsocket(tcp->socket, FIONREAD, &bytes_available);
                                        ^
  [...]/protocol.c:73:38: note: each undeclared identifier is reported only once for each function it appears in
  [...]/protocol.c:84:1: warning: no return statement in function returning non-void [-Wreturn-type]
   }
   ^