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) {
  ^~~~~

libserialport: Fix Linux files not compiled in with a toolchain for ucLinux

Buildroot can create toolchains for the no-MMU flavour of Linux, with a triple
containing 'uclinux' instead of just 'linux'.

Signed-off-by: Paul Cercueil <redacted>

linux: freebsd: do check on proper pointer

We want to check here if we added something to the list, not if the
function argument was valid. Problem spotted by Coverity, CID 50754.

Signed-off-by: Wolfram Sang <redacted>

Bump libtool version (not package version) to 1:0:1.

The last release (0.1.0) had the libtool version (current:revision:age)
set to 0:0:0. Since this release doesn't change/remove any
interfaces (it does *add* new interfaces, though), 'current' and 'age'
are increased and 'revision' is set to 0, resulting in 1:0:1.

http://www.gnu.org/software/libtool/manual/libtool.html#Updating-version-info

Programs using libserialport don't need to be recompiled or relinked.

NEWS: Last updates for the upcoming 0.1.1 release.

Fix ERROR_SEM_TIMEOUT issue on Windows.

The sp_blocking_write() call was incorrectly returning an error upon
ERROR_SEM_TIMEOUT. It now returns 0 instead.

Fix sp_blocking_read_next() implementation on Windows.

A ReadFile() call needed to check the actual number of bytes read,
instead of assuming all requested bytes were read.

windows: Fix iSerial for composite devices.

USB composite devices can contain an ACM serial interface.
On Windows, the correct iSerial descriptor field is assigned to the parent
(composite) device instead of to the actual serial interface. A bogus
value is returned if the serial interface is asked to provide the S/N.
This patch provides a fallback for this kind of device (tested on Android
with adb + cdc gadgets and on Arduino Zero Programming Port)

macosx: Fix port listing on ElCapitan.

On OSX 10.11 (ElCapitan) the query for IOProviderClass fails to list ACM
devices as USB.
Add a fallback query using IOClass to correctly recognize these devices.
The fix has no effect on previous OSX versions (tested on Mavericks)

Change debug message to "Port not open" when a closed port is used.

Fixes bug #710.

libserialport_internal: use new macro to enable timeradd, etc.

Since glibc 2.20, the usage of _BSD_SOURCE is deprecated. Fix it like
described here:

https://sourceware.org/glibc/wiki/Release/2.20#Deprecation_of__BSD_SOURCE_and__SVID_SOURCE_feature_macros

This fixes bug #716.

Signed-off-by: Wolfram Sang <redacted>

windows: Handle ERROR_IO_PENDING from ReadFile in sp_nonblocking_read().

This fixes bug #707.

sp_wait: Avoid overflow of timeout parameter to poll().

Build: Include config.h first in all source files

Build: Use GNUMAKEFLAGS and $@

autogen.sh: Create autostuff/ dir if it does not exist

configure: Enable largefile support on 32-bit systems

Clean up .gitignore

Build: Clean up configure.ac and Makefile.am

Among other things, rename some config defines so we can take
advantage of standard Autoconf macros.

Build: Reduce autogen.sh to trivial stub

Use autoreconf instead of invoking the various Auto tools
separately. Get rid of the Darwin-specific guesswork -- it does
not make sense to handle this at the level of libserialport.

People should set up their ACLOCAL_PATH themselves as appropriate
for their own system; just as they already need to set up various
other paths.

Update copyright notices.

Update AUTHORS file.

NEWS: Update for the upcoming 0.1.1 release.

doc: Provided channel is binary, not necessarily 8-bit.

Fix possible use of uninitialised variable in poll() setup.

doc: Additional introductory text.

doc: Expanded introductory text.

doc: Additional notes on sp_last_error_{code,message}.

Handle the case when /sys/class/tty/ entries are not symlinks.

For example:

$ uname -a
Linux RT-N66U 2.6.22.19 #1 Thu Feb 12 20:33:36 CST 2015 mips GNU/Linux

$ ls -lF /sys/class/tty/
drwxr-xr-x    2 foo  root             0 May 18 18:12 ttyACM0/

$ ls -lF /sys/class/tty/ttyACM0/
-r--r--r--    1 foo  root          4096 May 18 18:12 dev
lrwxrwxrwx    1 foo  root             0 May 18 18:12 device -> ../../../devices/pci0000:00/0000:00:04.1/usb1/1-1/1-1.1/1-1.1:1.0/
lrwxrwxrwx    1 foo  root             0 May 18 18:12 subsystem -> ../../../class/tty/
-rw-r--r--    1 foo  root          4096 May 18 18:12 uevent

Add new sp_blocking_read_next() function.

windows: Always check and set ReadTotalTimeoutMultiplier.

This is not currently touched, but will be by the upcoming
sp_blocking_read_next() function.

posix: Make sure blocking operations can't time out without trying.

posix: Consistent debug output when blocking operations time out.

posix: Move FD_ZERO() and FD_SET() calls outside loops.

windows: Always check return value of GetOverlappedResult().

windows: Restructure if/else blocks with unnecessary indentation.

windows: restart_wait_if_needed(): Inline receive buffer check.

This removes all the debug spam arising from calling sp_input_waiting().

windows: restart_wait_if_needed(): Skip buffer check if no bytes read.

windows: Refactor duplicated code into a static function.

windows: Avoid unnecessary calls to SetCommTimeouts().

This fixes bug #586.

windows: Strip CR/LF from end of system error messages.

This fixes bug #585.

doc: correct structure name in sp_get_port_handle() documentation.

libserialport.h.in: Fix/update some API docs.

sp_list_ports(): Actually set list_ptr NULL as documented.

Fix a potential segfault in sp_get_config_*().

Fix a potential segfault in sp_get_port_handle().

windows.c: Constify a few function parameters.

sp_get_port_usb_vid_pid(): Document that usb_vid/usb_pid can be NULL.

Rename timeout to timeout_ms for clarity in a few places.

autotools: Don't set/override "user variables".

This fixes bug #577.

Makefile.am: Simplify LDFLAGS handling a bit.

Constify the sp_get_port_description() parameter.

Constify the sp_get_port_transport() parameter.

configure.ac: Drop no longer needed SP_PKGLIBS.

Various Doxygen comment updates and fixes.

 - Add some missing @param lines.

 - Add [in], [out], or [in,out] markers for @param tags.

 - Add explicit "Must not be NULL" comments for parameters where
   the caller should not pass in a NULL.

libserialport.h.in: Drop unneeded <windows.h> #include.

This is not needed and would pollute the namespace of every
libserialport user on Windows.

libserialport.h.in: Add @since tags for new enums.

Set package version to 0.1.1, use "@since 0.1.1" Doxygen tags.

The next release will not contain any backwards-incompatible
API or ABI changes, thus changing the package version to 0.1.1.

windows: Drop no longer needed -luuid.

Also, use SP_LIBS in Makefile.am.

This is build-tested using a native MinGW-w64 based toolchain
as well as a MinGW-w64 based cross-compile setup.

configure.ac: Minor whitespace cosmetics.

Doxyfile: Update to Doxygen 1.8.8 template.

(by running 'doxygen -u')

configure.ac: Add #include guard to config.h.

Fix a compiler warning when -Wshadow is used.

    CC       serialport.lo
  In file included from ../serialport.c:25:0:
  ../serialport.c: In function 'get_config':
  ../libserialport_internal.h:227:25: warning: declaration of 'ret' shadows a previous local [-Wshadow]
   #define TRY(x) do { int ret = x; if (ret != SP_OK) RETURN_CODEVAL(ret); } while (0)
                           ^
  ../serialport.c:1566:3: note: in expansion of macro 'TRY'
     TRY(get_baudrate(port->fd, &config->baudrate));
     ^
  ../serialport.c:1543:6: warning: shadowed declaration is here [-Wshadow]
    int ret = get_flow(port->fd, data);
        ^

Also, add -Wshadow to the list of default compiler options.

autogen.sh: Drop obsolete MinGW/MSYS items.

For Windows builds (which require MinGW-w64) we currently support:

 - cross-builds using MXE (mxe.cc) and possibly other cross-compile setups

 - native builds using MSYS2 (sf.net/projects/msys2/)

Neither of those require explicitly specifying ACLOCAL_DIR.

README: Refer to MSYS2 only.

The "old" MSYS related to the "old" and unsupported MinGW (from
mingw.org) may or may not work properly, so only refer to MSYS2 which
we currently recommend and which has been tested.

Minor Doxygen improvements and fixes.

configure.ac: Use $host_os instead of $target_os.

$build and $build_os refer to the machine on which the software is
built, $host and $host_os refer to the machine for which the software
is (cross-)built.

The variables $target and $target_os (despite the confusing names)
are only relevant in the context of building cross-compilers.