Changes to make "make distcheck" pass

There were two errors:

1) Changelog wasn't deleted by "make distclean"

2) libsigrok.h wasn't treated as a distributable file and hence couldn't be found. This is a result of two commits:

https://sigrok.org/gitweb/?p=libserialport.git;a=commit;h=f1c916ede191ec398cbe53d7f978078311c25785 marking libsigrok.h as non-distributable since it was build from libsigrok.h.in at the time and

https://sigrok.org/gitweb/?p=libserialport.git;a=commit;h=f6e32b2dfa322aa4bd4a279a46d588e0e73ea238 which removed libsigrok.h.in in favor of a static libsigrok.h

The second commit didn't revert the Makefile.am change that marked libsigrok.h as non-distributable, which this commit takes care of.

Windows: don't fail if WaitCommEvent was aborted due to thread exit

This is a partial fix for #1603.

sp_close(): disable exclusive mode to allow re-opening the port later

Increase max class string length to 64

Fix xon_xoff not initialized

Add handling of ERROR_OPERATION_ABORTED in restart_wait for WIN32

It appears that the standard Win11 CDC driver does produce this case on occasion when the last byte of the IO has been transferred.

change type of result variables to ssize_t

These variables are being used to store the result of read/write calls,
which return a ssize_t value, which depending on platform can be bigger
than an int.

rename deprecated constant kIOMasterPortDefault

This constant is now deprecated since macOS 12.0 and a new constant
named kIOMainPortDefault is provided. There is a fallback in place
that retains compatibility for older macOS versions.

https://developer.apple.com/documentation/iokit/kiomasterportdefault

[ gsi: tweak style to match existing code base ]

HACK: don't even check for termiox

termiox was removed from linux in e0efb3168d34
Some more information available in https://www.spinics.net/lists/linux-serial/msg41926.html

Attempting to use the termiox ioctls on more modern kernels results in
"Inappropriate IOCTL" errors.

While the "right" solution might be to remove the termiox code from the
linux path, simply not checking for termiox builds a libserialport that
functions on modern linux kernels.

Signed-off-by: Karl Palsson <redacted>

Apply a default baudrate when the OS does not provide one.

Handle the situation when the OS does not provide a baudrate in the code
path which opens the serial port. See bug #1632 and PR #6 for details.

  https://sigrok.org/bugzilla/show_bug.cgi?id=1632
  https://github.com/sigrokproject/libserialport/pull/6

This resolves bug #1632.

[ gsi: adjust comment style, rephrase comment and commit message ]

doc: update IRC reference to Libera.Chat

sp: clear HUPCL to preserve control lines on close

The comment and code are out of sync. The comments say "leave control
lines alone on close." The HUPCL bit, when set, will "Lower modem control
lines after last process closes the device (hang up)."

To match the intent captured in the comment, the HUPCL bit should be
cleared.

Signed-off-by: Ben Gardiner <redacted>

Return proper type when sp_get_port_transport() fails

The above function must always return an 'enum sp_transport'. So, return
NATIVE if no port is present because its effective meaning within the
API is "you shouldn't call any transport-specific functions for this
port handle".

Fixes bug #1531.

Signed-off-by: Wolfram Sang <redacted>

Open the file descriptor of a serial port on POSIX systems exclusively

This fixes bug #1510.

examples/send_receive: Fix receive check.

Fix use of variable length array in send_receive example, for MSVC.

Add send/receive example to VS2019 examples solution.

windows: Ignore fParity flag which is always 0 after GetCommState().

This is a known bug in Windows: https://stackoverflow.com/a/36650872

Reported here: https://github.com/martinling/libserialport/issues/36

README: Remove note about old MinGW, it actually works fine.

configure.ac: remove broken handling for cygwin as $host_os.

I don't think these two mentions of cygwin ever did anything useful.
In fact they stop libserialport being buildable under cygwin.

The first one caused builds on cygwin to try to build windows.c,
which uses the Win32 API, not the POSIX layer provided by cygwin.

The second asserts that enumeration and port metadata are supported
on cygwin, but that isn't the case.

Without these matches for cygwin as $host_os, libserialport builds
and works just fine on old-school cygwin with the original mingw32.

The only reason that MSYS2 worked better is that it uses "msys" as
the $host_os identifier, not cygwin.

Add remaining examples to examples/README.

Formatting fix for example descriptions.

Add example of sending and receiving data.

unix: Fix calculation of poll() timeout in sp_wait().

Minor whitespace- and consistency fixes.

README: Add note on building for MSYS2/Cygwin.

Relax timing test in the other direction.

On my test system under MSYS (Cygwin64), a period of 991ms was
measured after a sleep of 1s.

Fix building on Cygwin.

There were two issues: first, feature test macros were only defined
for __linux__, so defintions we needed were not included. Enable the
same feature test macros for __CYGWIN__.

Second, the Cygwin headers do not define TIOCOUTQ, needed to use
ioctl() to get the number of bytes in the output queue. Return
SP_ERR_SUPP on Cygwin for this operation.

This fixes bug #963.

Relax timing test because it's too tight for Windows.

On my test system, a delay of 1016ms was measured after a
sleep of 1000ms.

README: update instructions for building with MSYS2.

README: update build instructions with VS2019/MSBuild options.

Add Visual Studio projects and solution to build example programs.

Fix use of variable length local array in await_events example.

This prevented building with MSVC.

windows: Fix another CreateFile usage.

When built with MSVC with unicode enabled, this gave:

warning C4133: 'function': incompatible types - from 'char *' to 'LPCWSTR'

due to CreateFile expanding to CreateFileW which accepts UTF-16 filenames.

The device name used here is in 8-bit format, having come from a call to
wc_to_utf8() in either get_root_hub_name() or get_external_hub_name(). So
we need to use CreateFileA.

windows: Fix a warning on size_t to USHORT conversion.

Building with MSVC gave:
warning C4267: '=': conversion from 'size_t' to 'USHORT', possible loss of data

The value here is known to be safe for the sizes involved. Add an
explicit cast to suppress the warning.

windows: Fix a warning on conversion to unsigned int.

The result should be safe because we only use this function on time
differences as part of timeout calculations, not on absolute times.

Add an explicit cast to suppress the warning.

windows: Fix warnings for conversions in time_as_timeval().

Building with MSVC gave:

warning C4244: '=': conversion from 'LONGLONG' to 'long', possible loss of data

when assigning the results of these calculation to the long fields
of struct timeval. The result should be OK, but put an explicit
cast in to make the change clear and suppress the warning.

windows: Avoid leak of write buffer on realloc failure.

VS2019 IntelliSense reported:

Warning C6308: 'realloc' might return null pointer: assigning null
               pointer to 'port->write_buf', which is passed as an
       argument to 'realloc', will cause the original memory
       block to be leaked.

This is correct, we would leak the buffer on a realloc failure.

Put the realloc result in a separate variable and handle the error
path before assigning the result to port->write_buf.

windows: Use correct variant of FormatMessage.

When built with MSVC and unicode enabled, using 'message' gave:

warning C4133: 'initializing': incompatible types - from 'TCHAR *' to 'char *'

FormatMessage expands to either FormatMessageA or FormatMessageW
depending if unicode is enabled, and generates either a char (8-bit)
or WCHAR (UTF-16) string accordingly.

Since sp_last_error_message() returns char *, we must use the 8-bit
variant. The message will be encoded in the current code page.

windows: Use correct variant of CreateFile.

When built with MSVC and unicode enabled, using CreateFile gave:

warning C4133: 'function': incompatible types - from 'char *' to 'LPCWSTR'

CreateFile is a macro expanding to either CreateFileW if unicode
mode is enabled, or CreateFileA if not.

For CreateFileW, the filename is a UTF-16 string. For CreateFileA
it is an 'ANSI' string, meaning 8-bit chars in the current Windows
code page.

We do need to stick to 8-bit strings for port names, since
sp_get_port_by_name() and sp_get_port_name() are defined with
char * types, and that is what we store in struct sp_port. So
CreateFileA is the correct version to use.

Since Windows serial port names are always just 'COM' and a digit,
with a '\\.\' prefix for higher numbers, encoding is fortunately
not an issue - ASCII, UTF-8 and all the Windows code pages seem to
be equivalent for these characters.

We should however explicitly document what the encoding of strings
accepted and returned by libserialport is.

Fix some warnings for size_t, DWORD and int conversions.

These cases are all in the sp_[non]blocking_{read,write} functions.

On MSVC, these conversions would generate warnings such as:
warning C4267: '=': conversion from 'size_t' to 'DWORD', possible loss of data

The warnings are genuine. There are some places where overflow is technically
possible, due to our use of size_t for sizes in function parameters (unsigned
64-bit on Windows x64), but an enum for return values (typically signed int
and 32-bit, but not guaranteed to be so by the standards), plus the Win32 API
usage of DWORD (unsigned 32-bit) for sizes in ReadFile/WriteFile.

However, overflow in practice would require reading/writing more than 2GB
over a serial port in a single call and is therefore unlikely to be a
real-world concern. I have therefore not tried to catch those cases - but the
places it is possible do now have explicit casts to the smaller types so that
they are more obvious.

We could document and test for a maximum read/write size of INT_MAX, but that
would still depend on the storage of 'enum sp_return' being at least a signed
int, which as I understand it the C standard does not require.

To be absolutely correct we would need a different API where sp_return
was only used for result codes, and the read/write functions took a
pointer to size_t for result sizes.

Replace some usages of int with size_t to fix overflow warnings.

On MSVC, these gave the following warning:

warning C4267: '=': conversion from 'size_t' to 'int', possible loss of data

Add project files for Visual Studio 2019.

Adjust headers and include ordering for MSVC support.

Add example of waiting for events.

Add an example of proper error handling.

Add some more narrative docs on the configuration API.

Add example of how to configure a port.

Use SP_API prefix for functions in libserialport.h.

For MSVC, we need to set the __declspec() for public symbols to
dllexport or dllimport, depending if we are building or using the
library. So, detect MSVC and define SP_API appropriately if found.
We use the LIBSERIALPORT_MSBUILD define to distinguish between
building and using the library, which will need to be set in the
project configuration when building the library using MS tools.

For normal client use of the header on other systems, we need to
define SP_API to nothing to avoid it being undefined, but we need
to avoid doing this in the case where we are including the header
whilst building the library with autotools and SP_API is already
set by autoconf. So define LIBSERIALPORT_ATBUILD in AM_CFLAGS,
and don't touch SP_API in the header if that's set.

Use a static header file, not dependent on autoconf.

windows: wc_to_utf8: use some clearer variable names.

windows: Don't try to include <unistd.h>.

This should enable compatibility with MSVC.

windows: wc_to_utf8: Eliminate variable-length array.

This should enable compatibility with MSVC.

windows: Use a fixed worst-case WRITEFILE_MAX_SIZE.

This saves needing to include and isolate the DDK headers.

windows: Handle the case where there are no serial ports at all.

It's possible for the HARDWARE\DEVICEMAP\SERIALCOMM key to not exist in
the registry if there are no serial ports at all and never have been, as
discovered on my rather minimalist gaming machine.

Handle that case gracefully and return an empty list.

windows: Handle registry lookup failures correctly.

RegOpenKeyEx() and RegQueryInfoKey() return system error codes directly,
not by setting the thread-local errno equivalent that is returned by
GetLastError().

When returning SP_ERR_FAIL, our API specifies that sp_last_error_code()
may be called immediately afterwards to get the system error code. In
this case that would not work, as it would call GetLastError() and miss
the directly-returned result.

We therefore need to call SetLastError() with the error code before
returning with SP_ERR_FAIL.

windows: Loop over WriteFile() if write size exceeds limit.

Fixes #1469.

Add test program for timing functions.

Move timing routines to separate file.

Move commonly used start flag into timeout helpers.

Move special case for poll() timeout to call site.

Support timing helpers on Windows.

More generic solution for limiting per-call timeout.

Move repetitive timeout code into helper functions.

Abstract all time handling operations.

Makefile.am: Add example files to the tarball.

Doxygen: Fix an issue causing missing #define documentation output.

  Searching for documented defines...
  [...]libserialport.h:1624: warning: documentation for unknown define SP_PACKAGE_VERSION_MAJOR found.
  [...]libserialport.h:1627: warning: documentation for unknown define SP_PACKAGE_VERSION_MINOR found.
  [...]libserialport.h:1630: warning: documentation for unknown define SP_PACKAGE_VERSION_MICRO found.
  [...]libserialport.h:1633: warning: documentation for unknown define SP_PACKAGE_VERSION_STRING found.
  [...]libserialport.h:1640: warning: documentation for unknown define SP_LIB_VERSION_CURRENT found.
  [...]libserialport.h:1643: warning: documentation for unknown define SP_LIB_VERSION_REVISION found.
  [...]libserialport.h:1646: warning: documentation for unknown define SP_LIB_VERSION_AGE found.
  [...]libserialport.h:1649: warning: documentation for unknown define SP_LIB_VERSION_STRING found.

Update Doxyfile for doxygen 1.8.16.

Release examples as public domain.

Add some additional formatting hints to Doxygen comments.

Integrate examples into Doxygen.

Add examples directory with two example programs.

android: Fix build compatibility with NDK platform 21 and up.

In platforms 21 and higher of the NDK, linux/serial.h is available,
which it was not before. This broke the build, because the configure
script would detect the availability of 'struct serial_struct' in that
header and set HAVE_STRUCT_SERIAL_STRUCT, but the #ifndef __ANDROID__
in libserialport_internal.h stopped us actually including the header.

This change fixes things to build with all versions of the NDK, and is
tested with builds for arm from versions 9 to 24.

Version 21 also added availability of tcdrain(), so we also use that
where available, and only use the direct ioctl() method on NDK < 21.

Fixes #1078.

Define _POSIX_C_SOURCE to 199309L to get clock_gettime().

linux: Fix compile warning on gcc 6+ for readlink() call.

Fixes #1268.

Use O_CLOEXEC where available

Ensures that the file descriptor is (by default) not passed to
subprocesses spawned by applications using libserialport.

This fixes bug #1051.

windows: Fix a build error.

  serialport.c: In function 'get_time':
  serialport.c:64:6: warning: implicit declaration of function 'clock_gettime' [-Wimplicit-function-declaration]
    if (clock_gettime(CLOCK_MONOTONIC, &ts) == -1)
        ^
  serialport.c:64:20: error: 'CLOCK_MONOTONIC' undeclared (first use in this function)
    if (clock_gettime(CLOCK_MONOTONIC, &ts) == -1)
                      ^
  serialport.c:64:20: note: each undeclared identifier is reported only once for each function it appears in
  serialport.c:65:17: error: 'CLOCK_REALTIME' undeclared (first use in this function)
     clock_gettime(CLOCK_REALTIME, &ts);
                   ^
  serialport.c: At top level:
  serialport.c:60:13: warning: 'get_time' defined but not used [-Wunused-function]
   static void get_time(struct timeval *time)
               ^

Fall back to CLOCK_REALTIME if CLOCK_MONOTONIC not usable.

Sounds like this may be necessary on some older systems.

Use mach_absolute_time() on OSX without clock_gettime().

This should fix #759 for OSX versions below 10.12.

Use clock_gettime(CLOCK_MONOTONIC) if available.

Should fix #759 except on OSX versions below 10.12, which don't
have clock_gettime.

configure: Check whether clock_gettime is available.

Move all gettimeofday() calls into a wrapper function.

windows: Use architecture-specific size limit for WriteFile calls.

windows: Use an adaptively sized buffer for nonblocking writes.

windows: Await completion of previous write before changing config.

unix: Fix handling of EAGAIN in sp_nonblocking_write().

Random minor whitespace fixes.

windows: Fix incorrect wc_to_utf8() calls.

This fixes bug #1079.

windows: wc_to_utf8(): Fix a WCHAR related issue causing crashes.

In wc_to_utf8() in windows.c, the zero terminator is written to an invalid
array index, which results in 2 bytes being zeroed in a random place in the
stack. This sometimes causes a crash when running sp_list_ports() (depending
on string length and compiler optimisation settings).

sizeof(wc_str) returns the size in bytes, so cannot be used directly as an
index into that array, it should be divided by sizeof(WCHAR). Otherwise the
zero terminator index is approximately twice what it should be.

This fixes bug #1031.

README: Add link to bug tracker.

README: Add missing contact info.

windows: Break out helper function for awaiting previous write completion.

Remove redundant inclusions of limits.h

The first one would be included for Windows too which seems to be
an error. The second one is obviously redundant.

Canonicalize symlinks in portnames

This allows users to supply symlinks created e.g. by udev rules instead
of the actual device names.

FreeBSD: Add missing libusb-2.0 to pkg-config file.

This fixes bug #1033.

Linux: fix for alpha where BOTHER is not defined.

Fixes bug #363.

configure summary: Show compiler version and flags.

configure summary: Show whether shared/static build is enabled.

configure summary: Slightly change formatting.

use readdir() instead of the deprecated readir_r()

readir() is threadsafe on both linux and freebsd anyway.
The rationale behind the readdir_r() deprecation is in the glibc manual:
https://www.gnu.org/software/libc/manual/html_node/Reading_002fClosing-Directory.html

This fixes the following warning with recent glibc:

linux.c: In function ‘list_ports’:
linux.c:197:2: warning: ‘readdir_r’ is deprecated [-Wdeprecated-declarations]
  while (!readdir_r(dir, &entry, &result) && result) {
  ^~~~~