bindings: cxx: try using pkg-config to detect catch2

If there is no system wide package, try using a regular header as before.

Signed-off-by: Alexander Stein <alexander.stein@mailbox.org>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: use 'upstream' include path

According to https://github.com/catchorg/Catch2/issues/1202 the
regular include is 'catch2/catch.hpp'. Also CMake and pkg-config
provide include paths for this include name.

Signed-off-by: Alexander Stein <alexander.stein@mailbox.org>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: tests: extend the test case for global find_line()

Split the test into sections and also test the case where the line
is not found.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: don't use 'index' as a name for variables

The standard library provides index() as a function. Don't use it as
a name for variables, arguments, etc.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tools: tests: restore the bats shebang in the bats source file

In commit f52e12eafd17 ("tools: tests: run the bats script indirectly
from a shell script") we removed the bats shebang and dropped the
execute permission from the .bats test-suite file.

While the preferred method of running the gpio-tools tests is using
the helper bash script, the .bats file should still be executable on
its own. Restore the execute permissions and the shebang.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: event: add two additional test cases for both edge events

Add two test cases explicitly verifying that watching events of both
types works correctly (in active-high and active-low modes).

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: use catch2 to implement a proper test-suite

Currently the only tests we have for C++ bindings are in a simple
program that makes a lot of assumptions about the environment and
doesn't even work anymore with recent kernels.

Remove it and replace it with a proper test-suite implemented using
libgpiomockup and Catch2.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: add a missing throw to line::event_get_fd()

If the call to gpiod_line_event_get_fd() fails, we're not actually
throwing the exception - we're only creating it on stack. Add the
missing throw keyword.

Fixes: 8078a4a2ad90 ("bindings: implement C++ bindings")
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: event: fix the active-low switch test case

Kernel commit 223ecaf140b1 ("gpiolib: fix incorrect IRQ requesting of
an active-low lineevent") fixed an issue with line events not being
inverted with the GPIOHANDLE_REQUEST_ACTIVE_LOW flag. This change has
now been released in linux v5.2.7 and the relevant test case must be
adjusted.

Convert the test case to expect a falling edge event. Since the first
pull change will be 0->1, it will be interpreted as such when the
active-low flag is used.

The minimum kernel version to run the core test-suite is now set to
v5.2.7.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: mockup: don't fail at init-time if gpio-mockup is already loaded

The comment in gpio_mockup_new() says we can deal with gpio-mockup
already being loaded, but it's wrong - we'd actually fail in the call
to kmod_module_probe_insert_module().

Pass the KMOD_PROBE_IGNORE_LOADED flag to the insert function to fix
that.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tools: tests: fix the gpiomon test case with --active-low switch

Kernel commit 223ecaf140b1 ("gpiolib: fix incorrect IRQ requesting of
an active-low lineevent") fixed an issue with line events not being
inverted with the GPIOHANDLE_REQUEST_ACTIVE_LOW flag. This change has
now been released in linux v5.2.7 and the relevant test case for
gpiomon needs to be adjusted.

Since the line going down will now be interpreted as a rising edge
event, set the pull to 1 before running gpiomon and then set it to 0
after starting it to trigger a rising edge event.

The minimum kernel version to run tests must be set to v5.2.7.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tools: tests: drop the .sh extension from the testing script's name

This script requires bash, so .sh extension is not accurate. Also: it's
executable, so there's no need to indicate the interpreter in the
extension.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tools: tests: pass command-line arguments to the underlying bats script

Command-line arguments need to be forwarded to the bats test-suite if
we want to control bats' execution.

Fixes: f52e12eafd17 ("tools: tests: run the bats script indirectly from a shell script")
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tools: tests: run the bats script indirectly from a shell script

Bats makes it very difficult to run some initial code once, perform
checks for requirements and optionally exit if they are not satisfied.

Instead of working around it in the .bats script, just create
a separate shell script that does all the initial checks and then
execs the actual bats test-suite.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: add a test case for using misc line flags together

This adds a test case that verifies that the ACTIVE_LOW flag works
correctly when used together with OPEN_SOURCE and OPEN_DRAIN flags.

Note: a bug has been discovered in the kernel that makes the LINEINFO
ioctl() incorrectly report the direction of lines requested with
open-drain or open-source flags as 'input' if the underlying hardware
doesn't support these config options. A patch fixing it has been sent
and once it's released, the FIXME's added by this patch will be
removed.

While at it: extend the previous misc flags test with additional checks
of the reported direction, but disable the one that fails due to the
bug mentioned above.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tools: tests: remove some development leftovers

Remove a leftover debugging command from the testing script that got
accidentally commited.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: examples: use seconds for timeout in line.event_wait()

While the event_wait() method takes ::std::chrono::nanoseconds as the
timeout argument, we don't actually need to use the same type - we can
use less fine-grained duration types. Switch to using seconds in the
gpiomoncxx example to showcase this implicit conversion.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: mockup: make sure the gpio-mockup debugfs directory is writable

The gpio-mockup library needs write permissions to make full use of
the debugfs interface. Add the W_OK flag to the call to access() when
preparing the context structure.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: mockup: add a comment explaining the kernel version definition

The library only works on newer kernels. The specific features we're
using have only available since linux v5.1.0. Add a comment explaining
this limitation to the library code.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: free the GList linking test cases once it's no longer needed

Once we registered all the test cases, the GList linking them is no
longer used. We can free it before running the test suite.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: mockup: fix a typo in comment

It should have been 'check' not 'chech'.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

README: update the tests section

The tests underwent significant changes recently. Reflect those in the
README file.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: mockup: validate the chip index where applicable

In functions that take the chip index as argument: let's verify that
its value is valid i.e. it refers to an existing chip to avoid potential
segfaults.

While we're at it: delegate the validation of arguments in mockup getter
helpers to a separate routine.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: drop manual test case links and use GList

Let's not handcode a linked list if GLib already provides us with
a robust implementation. Use GList to link the tests at registration.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: mockup: add extern "C" to the header

The gpio-mockup support library should be usable from C++ code too.
Add extern "C" to the header.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: use GLib for library test cases and bats for gpio-tools

This replaces the custom hand-crafted testing suite with well-known
open-source tools while keeping the same coverage. The core library
is now tested using the GLib unit testing framework. The gpio-tools
are now tested in bash using the bats testing system instead of being
invoked from a C program.

This simplifies and shrinks the testing code and makes it less prone
to bugs.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

gpioinfo: mark kernel claimed lines as used

In case where the GPIOLINE_FLAG_KERNEL flag was set and no consumer
string is provided by the kernel, the used column was still showing
the pin as "unused" Fix that by writing "kernel".

Signed-off-by: Ramon Fried <rfried.dev@gmail.com>
[Bartosz:
  - fixed indentation and alignment
  - tweaked the commit message formatting]
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: setup libgpiomockup before checking the kernel version

The gpio-mockup helper library checks the kernel version itself when
creating the context object. We then check the version again (as the
minimum versions for libgpiomockup and the test-suite may differ) in
the test-suite's main function. Make sure the library runs the check
first as we don't want to tell the user the version is OK and then
fail because it isn't...

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: fix a segfault in error path

We may all the atexit() cleanup func before the gpio_mockup context
is setup. This will result in a segfault so add an appropriate check.

Fixes: b8659e044d50 ("tests: use libgpiomockup")
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

TODO: new task for gpiomon

Making gpiomon be able to run external processes is a common request
from users. Add it to the TODO list.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: mockup: use KERNEL_VERSION()

There's no need to reimplement checking the kernel version. An
appropriate macro - KERNEL_VERSION() - is already provided in
linux/version.h. Use it in libgpiomockup.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: iter: free non-mockup GPIO chips

When using gpiod_foreach_chip_noclose() we need to close any non-mockup
GPIO chip that may be present in the system. Otherwise we'll be leaking
memory.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: python: fix GCC8 warnings due to function pointer casting

GCC8 has added a new warning heuristic to detect invalid function
casts. This causes a lot of warnings when building libgpiod python
bindings.

Let's use Py_UNUSED where applicable to make function prototypes match
that of PyCFunction. For keyword functions, let's cast them to a
function pointer taking no arguments before casting them again to
PyCFunction. This may not be the best solution but it has to do for
the moment.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: build: fix the name of the test executable displayed by Makefile

The test suite Makefile prints a help message after building the test
executable but the name of the program is wrong. Fix it.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: gpio-mockup: constify num_lines

The array pointed to by num_lines is never modified so make it really
constant.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: fix a memory leak in exit path

When exiting normally we free all allocated resources (mostly to keep
valgrind quiet). The toolpath string is not being freed and pops up in
valgrind's "still reachable" category of leaks. Free this memory too
in the atexit() cleanup callback.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: gpio-mockup: store the number of chips in gpio_mockup_probe()

We're currently not storing the number of chips in the gpio-mockup
context structure after probing the module. The value is left
initialized to 0. This leads to both a memory leak and to chip ordering
errors when running the tests at high CPU loads. This patch fixes both
issues.

Fixes: e43e46d4f79c ("tests: mockup: add a library for controlling the gpio-mockup module")
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: gpio-mockup: don't allocate the chip structure twice

We incorrectly allocate the chip structure twice: once in
gpio_mockup_probe() and then again in make_chip() which leads to a
memory leak. Remove the first instance as it's the one that's
unnecessary.

Fixes: e43e46d4f79c ("tests: mockup: add a library for controlling the gpio-mockup module")
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

TODO: remove the task for factoring out of common testing code

We now have libgpiomockup and it's used by the core library testing
executable. Remove the task from TODO.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

libgpiod: start v1.5 development cycle

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

libgpiod v1.4

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

NEWS: updates for v1.4

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: gpiomon: use test_trigger_event() to fix timing errors

Since we don't need to trigger events from a separate thread when
testing tools and we've experienced timing issues with these two
test cases, let's use the new helper for triggering of single events.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: provide test_trigger_event()

We use a separate thread to trigger line events for library test cases
but if we're testing tools which are separate processes, we can generate
the events from the main thread. Add a simple helper for that.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: gpiomon: tweak the timing for single event type tests

Since switching to using libgpiomockup there are some timing problems
with two gpiomon test cases. I'm not sure what the reason is and we'll
be switching to glib unit tests soon, so let's not waste time on that
and just increase the sleep time.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: use libgpiomockup

Now that all the gpio-mockup support lives in a separate library we
can drop a lot of code from the testing framework.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: mockup: add a library for controlling the gpio-mockup module

In order to both switch to glib unit testing framework for core
libgpiod tests as well as to cover the bindings in other languages
with proper testing while avoiding unnecessary code duplication, let's
factor out the code responsible for interaction with the gpio-mockup
module into a separate shared library.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: remove make check target

Having both --enable-tests configure option and the check make target
seems redundant and confusing. Especially since the tests won't even
run without appropriate permissions for /dev/gpiochipX anyway.

Remove the check target and the --enable-install-tests option. From now
on the tests - if enabled - are built as a regular program installed to
${prefix}/bin.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: fix mapping of chip numbers

After recent changes the tests stopped working when other (non mockup)
GPIO chips are present in the system. The reason for that is broken
mapping of chip numbers to chip indexes. This patch fixes it.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

TODO: remove the task for converting the tests for linux v5.1

The conversion of the testing framework for linux v5.1 is now done.
Remove the task from the list.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: make linux v5.1 the minimum version to run tests

The testing framework has been adjusted for linux v5.1. It will no
longer work with older versions.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: line: use debugfs to verify set values

Use new debugfs helpers when verifying if line values were correctly
set.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: gpioset: make test cases work with linux v5.1

Make all gpioset test cases work with the recent changes to gpio-mockup
introduced in linux v5.1.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: gpiomon: increase the time waiting for events

We no longer have influence over the type of generated events. We
always start with a rising edge-event and then get alternating edges.
We need to wait slightly longer to collect the events we're expecting
in one of the test cases.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: gpioget: make test cases work with linux v5.1

Make all gpioget test cases work with the recent changes to gpio-mockup
introduced in linux v5.1.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: event: make test cases work with linux v5.1

Make all event test cases work with the recent changes to gpio-mockup
introduced in linux v5.1.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: ctxless: make test cases work with linux v5.1

Make all ctxless test cases work with the recent changes to gpio-mockup
introduced in linux v5.1.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: provide test_debugfs_get/set_value() helpers

Since linux v5.1 gpio-mockup simulates pull-up/down resistors for dummy
lines. The current pull can be set using debugfs. Since we can no longer
verify if the character device interface properly sets line values, the
debugfs interface now also allows to read line values. This way we can
verify if the ABI works correctly using different code paths.

Provide functions for reading and setting values of mockup GPIO lines.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: document the freq argument in test_set_event()

The freq argument is not documented and it's not clear what it means.
Add a brief comment.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: fix debugfs path

Since linux v5.1 the debugfs path for gpio-mockup changed. Use the new
path both for the main directory as well as for the chip subdirectories
which no longer use the chip's label.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: don't allow to generate events of the same type subsequently

Since linux v5.1 the state of simulated lines is tracked by the kernel
and it's no longer possible to generate two subsequent events of the
same type (e.g. two rising edge events one after another). Drop the
event_type parameter from test_set_event() and adjust all users.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

man: fix out of source build

Use build and source directory variables for correct paths. This
distinction is important for out of source builds.

Signed-off-by: Alexander Stein <alexander.stein@mailbox.org>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

TODO: add a list of things to implement for feature-complete

Add a document listing major features I'd like to see in libgpiod to
make it more or less complete (not including of course the support for
any potential new features that the kernel may expose in the future).

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

gitignore: add .swp to the list of ignored extensions

We want to ignore vim swap files. Add .swp to .gitignore.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: make operator bool() explicit

A non-explicit operator bool() is dangerous: It allows unwanted
conversion to integral types:

gpiod::chip c;
int i = c;

This is a trivial example, but more insidious effects are possible,
e.g. with std::set<gpiod::chip>, which would use the operator bool()
to implement element comparison, thus turning such set into a set that
has at most 2 elements: An invalid (false) element and just 1 valid
element:

std::set<gpiod::chip> s;
s.emplace();
s.emplace("/dev/gpiochip0");
s.emplace("/dev/gpiochip1");
// s.size() is still 2 even if both chips were opened!

Making the operator explicit disables this.

See e.g.
https://en.cppreference.com/w/cpp/language/implicit_conversion#The_safe_bool_problem
for more info on this.

Signed-off-by: David Kozub <zub@linux.fjfi.cvut.cz>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: remove superfluous std::move

There is no need to use std::move on an r-value (e.g.
std::move(gpiod::chip())). Similarly, there is no need to use std::move
for returning a local variable as in:

T foo()
{
    U local;
    return std::move(local);
}

Not only it doesn't help, it actually inhibits named return value
optimization.

See e.g. https://isocpp.org/blog/2013/02/no-really-moving-a-return-value-is-easy-stackoverflow

Signed-off-by: David Kozub <zub@linux.fjfi.cvut.cz>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

libgpiod: start v1.4 development cycle

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

libgpiod v1.3

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

NEWS: updates for v1.3

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

build: fix cross-compilation after adding manpages

Cross-compilation is currently broken because WITH_MANPAGES is defined
conditionally. Move it out of the if/then.

Fixes: 6cbc2e57555a ("doc: add automatically generated man pages for gpio-tools")
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: look for gpio-tools in more places

Currently we only support running the test cases for gpio-tools from
the top-level source directory. Some users want to install the test
executable and run the tests from other locations (/bin, /usr/bin or
custom path).

This patch makes the test suite look in the source tree path first,
then check the directory in which the program resides and last iterate
over all directories in $PATH.

We only do that once at the beginning and then reuse the path later.

Cc: Anders Roxell <anders.roxell@linaro.org>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>
Reviewed-by: Anders Roxell <anders.roxell@linaro.org>
Tested-by: Anders Roxell <anders.roxell@linaro.org>

tests: enable installing tests to bindir

Add an enable option to configure that allows to install the testing
binary to <prefix>/bindir.

Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
[Bartosz: trimmed the patch to fit the new approach]
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

gitignore: ignore patches

Add all files with the .patch extension to the list of ignored files.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

treewide: rearrange source directories

The src directory containing lib and tools is not necessary and will
actually cause problems if we tried to add a new component to src/
which would depend on libraries from the bindings directory because it
(bindings) already depends on src/lib.

Simplify the directory structure. Move lib and tools to the root source
directory and update all relevant files. That way we can specify the
exact build order of components from the top source Makefile.am.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tools: coding style fix

Drop a stray space between '*' and get_progname().

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

man: add template to EXTRA_DIST

Currently the man page template used by help2man is not included in the
distribution tarball. This causes build failures on systems that
actually do have help2man in which case we rebuild the man pages
locally. Add template to EXTRA_DIST.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

core: ctxless: arrange local variables in reverse christmas tree order

This is a cosmetic change: let's be consistent treewide and have all
local variables arranged in reverse christmas tree order.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

core: ctxless: bail-out if num_lines == 0

Return -1 and set errno to EINVAL if the number of lines specified in
any context-less helper is 0. This is done in addition to bailing out
when the number is higher than the maximum supported number of GPIO
lines. This fixes the segfaults that currently ocurr for num_lines == 0.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

README: fix the kernel version required to run tests

The kernel version required to run tests is v4.16 while README says
it's v4.11. Fix it.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

build: use top_builddir instead of relative paths

The only instance of using a relative path for an internal library is
in tests/Makefile.am. Use top_builddir instead.

Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

core: drop an unnecessary pointer assignment

The whole line structure is zeroed in the line above, so there's no
need to set the fd_handle pointer to NULL.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

configure: check for setlinebuf() when building tools

Add setlinebuf() to the list of functions checked for when building
gpio-tools. This is now required to build gpiomon.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

gpiomon: add option to set line buffered output

Some applications call gpiomon in a sub process, in which case glibc
defaults to block buffered output on stdout. This makes the output
arrive to the calling process only when the (4kB) buffer is filled (or
when gpiomon exists), making the information obsolete and pretty much
useless.

Support such scenarios by adding a switch to configure line buffered
output on stdout. Similar switches are available in other applications
(e.g. `rsync`s --output argument).

Signed-off-by: Martin Hundebøll <martin@geanix.com>
[Bartosz:
  - use setlinebuf() instead of setvbuf(),
  - tweak the help string,
  - move the setlinebuf() call directly into the optarg switch statement]
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

configure: code shrink

When defining enable arguments, we don't need a full if-else spanning
multiple lines. We only care about the 'true' value, so pull the
relevant code into a single line.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

treewide: order includes alphabetically

Unify the header includes by ordering them alphabetically and always
having local headers in a second group below the global ones (separated
by a newline).

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

README: add a section about API documentation

Doxygen and python documentation are briefly mentioned in the BINDINGS
section but there's no word about the core C API and automatically
generated man pages.

Add a separate section to the README file describing the process of
generating html doxygen output, python help strings and man pages for
gpio-tools.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

doc: add automatically generated man pages for gpio-tools

Extend the build files to automatically generate man pages for
gpio-tools using help2man if it's present in the system and we're not
cross-compiling (as the built programs must be executable for help2man
to work).

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

doc: delete generated files on make clean

Delete the entire doc directory when running make clean.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

gitignore: add distribution tarballs to ignored files

Add .tar.gz files to .gitignore.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: python: add support for 'default_val' in Line.request()

Until now Line.request() only took 'default_vals' argument which was
passed down directly to LineBulk.request() internally. This meant that
even when requesting a single line in output mode, the default value
had to be passed in a sequence.

Add support for the 'default_val' argument which makes it possible to
specify the default value as an integer. The previous 'default_vals'
argument is still supported, but the two cannot be passed at the same
time.

Documentation for default_vals is removed, as it's now deprecated for
Line.request().

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: python: fix argument alignment in a function call

When breaking a line, the arguments should be aligned with the opening
bracket of the function call.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: gpiomon: remove failing test case

Since commit fa38869b0161 ("gpiolib: Don't support irq sharing for
userspace") in the kernel, the test case veryfing correct ignoring
of edge events is failing. It will take a while until it will be
fixed upstream so remove this test for now.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: make bitset_cmp::operator() const

This fixes build problems with clang and libc++ and such constness is
now required by C++17 (see https://cplusplus.github.io/LWG/issue2542).

Signed-off-by: Michael Beach <michaelb@ieee.org>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: do not initialize a chip's shared_ptr with nullptr

A shared_ptr initialized with nullptr will still call the deleter which
causes a NULL-pointer dereference if we create a chip_iter when there
are no GPIO chips in the system.

Only initialize the current chip object in chip_iter if
gpiod_chip_iter_next_noclose() returned a valid pointer.

Signed-off-by: Patrick Boettcher <p@yai.se>
[Bartosz:
  - tweaked the commit message
  - use std::move when assigning the chip object]
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

gpioset: extend help text

There's a common misconception about the way the character device
works. Some users expect line states to be driven as desired even
after gpioset exits. Add a note about that to the help text to avoid
further confusion.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

treewide: unify naming of local variables representing return values

For integers representing simple return values of various functions
use the name 'rv' everywhere.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

doc: C API documentation fixes

Fix a couple problems in doxygen documentation of the C API.

(Unfortunately no Signed-off-by tag from the submitter...)
[Bartosz: added a proper commit message]
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: ignore 'remove' events from udev

So far the tests have been executed on a Debian 9 machine with libudev
provided by systemd 232 - everything always worked fine. However
running them on a system with systemd 237 uncovered a bug in the
testing framework.

It turned out that on newer versions the ignored 'remove' events linger
somewhere in the pipeline and get read by subsequent test cases causing
erroneous chip naming and breaking tests.

Check the action string for udev device objects and only care about
those being added.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

libgpiod: start v1.3 development cycle

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

libgpiod v1.2

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>