tests: tweak a log message

Drop the 'test' prefix from the message displayed when running
a test. We're already stating that in the message header.

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

tests: use the 'malloc' attribute

Use the gcc 'malloc' attribute for all malloc-like routines in the
unit testing framework.

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

tests: rename an argument

Rename the 'color' argument in vmsg()/vmsgn() to 'hdr_clr' to better
reflect its purpose - it affects the color of the message header, not
the message itself.

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

tests: add colors to output

Add terminal colors for improved readability of the test output.

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

tests: rework logging

Major rework of the way logging works: always print to stderr, add
new routines for raw printing, store the message from a failed test
in the test context and print it after the test, general code
reorganization.

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

tests: use function attribute consistently

Move all function attributes to the function definitions and put them
before the return type.

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

core: use the 'malloc' attribute

Use the 'malloc' gcc attribute in the zalloc() definition.

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

tests: drop the external prefix in gu_err()

This function is static so drop the prefix.

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

tests: drop the external prefix in gu_msg()

This function is static so drop the prefix.

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

tests: explain the need for qsort()

Add a comment explaining why we need to sort the mockup gpiochip
structures after detecting them with udev.

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

build: fix a test in configure.ac

We were checking the 'with_tools' variable instead of 'with_tests'.

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

tests: simplify test_load_module()

Add a new function that simplifies the string building when preparing
the module params for gpio-mockup.

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

tests: remove a stray space

Remove a double space in check_chip_index().

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

tests: remove GU_REGISTER_TEST()

This macro is never used directly.

Just make it a part of GU_DEFINE_TEST().

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

tests: make struct gu_chip_descr & gu_test private

Add an underscore to struct gu_chip_descr & struct gu_test. This
indicates that these structures are for internal use only.

Test cases should use provided helper macros when registering tests.

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

tests: document test API

Add some comments to the test header file.

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

tests: make gu_msg() and gu_err() static

Tests should only ever print anything when an assertion fails. Make
gu_msg() and gu_err() static and instead allow passing an error
message to _gu_test_failed().

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

tests: remove unnecessary goto

Check all loop conditions in a single if in test_prepare() and remove
the 'cont' label.

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

tests: test case for gpiod_foreach_chip_noclose()

Add a test for the noclose variants of the chip iterator routines.

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

tests: add new cleanup helper

Add gu_free_chip_iter_noclose() which calls
gpiod_chip_iter_free_noclose() internally to free the chip iterator
without closing the most recent chip handle.

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

tests: add a test for gpiod_chip_open_by_name()

We forgot to test this one before.

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

core: tweak argument names

Rename line_bulk to bulk for brevity.

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

gpiod.h: documentation updates

Clarify that all functions dealing with sets of lines expect at least
a single line in order to work correctly and that the behavior is
undefined for zero lines. This applies both to bulk objects as well
as the high-level API.

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

tests: add test cases for the high-level API

For now we only test the get and set operations. We'll add event tests
once the support for that is merged in the kernel.

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

tests: add new assertion helper

Add GU_ASSERT_NOTEQ() for testing if two numbers are not equal.

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

core: don't use double underscores

Symbols starting with a double underscore are reserved for the
compiler. Private symbols in libgpiod should start with a single
underscore.

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

core: use uint8_t instead of __u8

User space should use types defined in <stdint.h>, not the
linux-specific ones.

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

tests: fix potential memory corruption

Valgrind is complaining about invalid reads and writes from the two
line test cases. The culprit is the order in which the cleanup
functions are called.

Declare the chip pointers above the line handles so that we don't
free the resources associated with the chip before releasing the
lines.

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

tests: move exported functions below main()

Group all functions that are used exclusively by tests together and
below main() for better readability.

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

tests: remove xcasprintf()

There's only one user and we already removed xasprintf() which was no
longer used after introducing udev polling. Remove it for simplicity.

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

tests: wait for gpiochips before running tests

We're currently using an ugly hack to check if gpiochip files are
actually mockup chips. Remove it and use libudev instead to poll for
uevents until all mockup GPIO devices appear in /dev.

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

tests: move the closedir() call

Close the directory immediately after the loop iterating over
its entries ends.

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

tests: fix a potential segfault

We should only sort the mockup chip pointers after determining that
all gpiochip device files have actually been created. Otherwise we
might sort invalid memory since we don't create the mockup_chip
structures for nonexistent devices.

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

tests: implement xcasprintf()

Add another flavor of xasprintf() which can also return the number of
bytes written to the created string.

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

tests: introduce x-funcs

Add a couple helper functions that check for unrecoverable errors
internally and die() if they occur.

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

tests: don't sort entire structures

Instead of moving around whole mockup_chip structures, keep an array
of pointers in the test context structure and pass it to qsort().

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

core: extend gpiod_chip_open_lookup()

Make gpiod_chip_open_lookup() also check the chip label.

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

core: new gpiod_chip_open() flavor

Implement gpiod_chip_open_by_label() which allows to find and open
a GPIO chip by its in-kernel label.

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

tests: add a couple line test cases

Add first test cases for GPIO lines.

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

tests: new cleanup helper

Add a new cleanup helper which releases a previously requested GPIO
line when a gpiod_line pointer used with GU_CLEANUP() goes out of
scope.

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

tests: new assertion helper

Add the GU_ASSERT_RET_OK() macro which checks if an integer (normally
returned from a function call) equals 0 - indicating a correct result.

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

tests: fix a comment

This file contains iterator test cases, not GPIO chip tests.

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

tests: add a chip iterator test case

Add a test case checking the chip iterators and the accompanying
gpiod_foreach_chip() macro.

Since we're adding a new file: make the cleanup helpers reusable from
all test files.

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

tests: add a simple unit testing framework and a couple tests

Implement a simple unit testing framework working together with the
gpio-mockup module present in the mainline linux kernel.

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

core: coding style fixes

Make struct definitions consistent.

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

make: simplify Makefile.am in src/

Drop the redundant variable and use SUBDIRS directly.

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

make: use LDADD instead of AM_LDFLAGS when linking against libgpiod

Libtool tends to have problems (especially with C++) when the
variables are used incorrectly. When building tools, specify the
library we want to link against using LDADD.

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

configure: use quotation marks consistently

Always use quotation marks when testing variables.

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

configure: fix variable assignment

We must not use spaces in assignment.

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

core: code shrink

Use the ternary operator instead of an if-else.

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

core: drop a redundant call to gpiod_line_name()

We're storing the name in line_name, so reuse it.

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

core: really fix event requests

The previous commit addressing the issue when requesting both types
of line events was braindead. Actually fix the bug this time: check
the event_type, not the eventflags.

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

core: close GPIO chip device files on exec

Pass the O_CLOEXEC flag to open() so that we don't leak open GPIO
chip descriptors to any processes spawned by users of the library.

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

gpioset: fix helptext

Add 'signal' to the list of available modes.

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

core: add non-closing gpiochip iterator function and foreach macro

Allows users to iterate over the gpiochips without closing them
automatically. The lines can then be used during the runtime of the
program. The user is responsible for closing the chips after they are
no longer needed.

Signed-off-by: Clemens Gruber <clemens.gruber@pqgruber.com>
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

core: fix requesting events

There was a bitwise OR and assignment operator in an 'if else' instead
of an equality operator when requesting 'both edges' events.

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

libgpiod: relicense under LGPLv2.1

The library is much less useful under GPLv3 - change the license
to the more permissive LGPLv2.1 for the entire project.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
Acked-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>

core: simplify verify_line_bulk()

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

core: rename line_update() to line_maybe_update()

This routine can silently fail, so reflect that in the name.

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

core: simplify gpiod_chip_close()

Use a temporary pointer for GPIO lines and helpers for reading the
line state.

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

gpioinfo: increase the width of the line offset

Increase the width of the line offset to 3 - that way we can display
999 lines before the formatting will be shifted.

This should be generally enough, but we should still implement
a correct, generic solution for gpioinfo display.

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

gpioset: include <poll.h> instead of <sys/poll.h>

Just like we did in core.c: don't include <sys/poll.h> directly.

Follow the manual and include <poll.h>.

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

build: use AC_FUNC_STRERROR_R to check the version of strerror_r()

Define _GNU_SOURCE globally in configure.ac and use the
AC_FUNC_STRERROR_R macro to figure out what version of strerror_r() is
provided. Some libraries (e.g. musl) only provide the POSIX version
even if we explicitly request GNU extensions.

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

doc: documentation updates

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

core: allow to read values of lines configured for events

The kernel allows us to read values of lines on which we're listening
for events, but libgpiod bails out if the user tries to do it.

Modify gpiod_line_get_value_bulk() to select the correct file
descriptor, depending on how the line object is configured and
allow reading values for both normally exported and monitored lines.

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

core: include <poll.h> instead of <sys/poll.h>

<sys/poll.h> is an internal C library header, which shouldn't be
included directly. <poll.h> should be included instead, as advertised
in poll(2).

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
[Bartosz: tweaked the commit message]
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

gpiod.h: include missing <time.h> include

gpiod.h uses "struct timespec", but forgets to include the <time.h>
header which defines "struct timespec". This causes a build error with
the musl C library:

In file included from core.c:11:0:
../../include/gpiod.h:232:49: warning: ‘struct timespec’ declared inside parameter list
 typedef int (*gpiod_event_cb)(int, const struct timespec *, void *);

Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
[Bartosz: tweaked the commit message]
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

configure: add helpers for printing common errors

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

configure: tweak error messages

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

configure: don't check stdint.h

We probably have it if AC_HEADER_STDC succeeded.

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

configure: don't check headers/functions unnecessarily

Only check functions & headers required by tools if we're actually
building them.

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

configure: check sys/poll.h availability

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

configure: check ppoll() availability

We're using ppoll() for events - not poll(). Check the right syscall.

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

README: fix the required version of kernel headers

The project actually needs kernel headers >= v4.8 to compile.

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

gpiomon: fix shortops

The short option for --silent is missing in gpiomon. Add it.

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

build: don't try to process docs if doxygen is not installed

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

libgpiod: start 0.2 development cycle

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

libgpiod v0.1

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

README: add examples

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

README: add the autoconf version needed to compile the project

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

README: add bullet points to the tool list

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

README: the introduction is not a code block

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

README: rename to README.md for nice github cover

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

README: update

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

core: constify function arguments that will not be modified

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

gpiomon: modify the output format

Drop unnecessary strings. Add offset info (if we ever wanted to allow
monitoring multiple lines at once while staying backwards compatible).

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

gpiomon: check if offset is not negative

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

core: name the iterator functions consistently

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

core: skip chips and lines on error in gpiod_line_find_by_name()

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

gpiomon: new options

Add new options to gpiomon:
  - allow to specify the number of events after which the program
    should exit
  - allow to silence the output
  - allow to only monitor certain types of events

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

gpioset: arrange local arguments for better readability

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

configure: check for daemon() and signalfd() functions

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

core: allow to specify the consumer in the simple event loop

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

core: allow to specify the consumer in simple set value routines

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

core: allow to specify the consumer in simple get value routines

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

gpioset: tweak error messages

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

gpioset: fix help text

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

gpioset: new option

Add an option allowing the program to detach from the controlling
terminal after setting values. This is useful for pulled-down/up pins
that we want to keep exported.

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

gpioset: new mode of operation

Add a new mode: 'signal', which makes the program set GPIO values and
then wait until it receives SIGTERM or SIGINT.

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

gpioset: major rework

Allow setting multiple lines at once and add different modes
of operation.

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