tests: event: extend testing to cover reading a subset of available events

Add tests for gpiod_line_event_read(), including reading multiple
entries from the kernel event kfifo, and extend the existing
read_multiple_event tests to read a subset of the available events as
well as all the available events.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: fix event timestamp calculation for 32bit

Use appropriate C++ chrono library functions to convert the event
timestamp from a struct timespec to ::std::chrono::nanoseconds to
ensure correct conversion independent of platform.

Fixes: 8078a4a2ad90 ("bindings: implement C++ bindings")
Reported-by: Florian Evers <florian-evers@gmx.de>
Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

doc: add @file to headers

It's necessary to have a file reference linked in the file list.
Also: strip the top_srcdir from paths

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

doc: remove obsolete PERL_PATH

This fixes the following warning:

warning: Tag 'PERL_PATH' at line 110 of file 'Doxyfile' has become obsolete.

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

doc: fix doxygen warning

This fixes the following warning:

warning: argument 'a4wide' for option PAPER_TYPE is not a valid enum value
Using the default: a4!

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

doc: use autotoolized Doxyfile

This has several advantages:
* More simplified Makefile.am
* Actually used doxygen config is available as a file
* Building doc out-of-tree is possible

Signed-off-by: Alexander Stein <alexander.stein@mailbox.org>
[Bartosz: add a dependency on Doxygen to the doc target in Makefile]
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

doc: fix doxygen warnings

Apparently __<name>__ is not supported for @defgroup commands anymore in
doxygen v1.8.19 (and possibly earlier versions). This results in the
following warning (printed multiple times):

gpiod.h:79: warning: group strong: ignoring title ">high_level</strong> High-level
API" that does not match old title ">common</strong> Common helper macros"

Also the module list is broken.

Fix this my removing the underscores.

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

doc: document the reasons for deprecating interfaces

Use the @deprecated doxygen tag to mark deprecated functions and explain
why their usage is discouraged.

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

doc: document the caveat concerning line lookups

GPIO line names in the kernel aren't unique - neither globally nor
within a single chip. The current API doesn't take this into
consideration and simply returns the first matching line in
gpiod_line_find() and co.

This will be addressed in v2.0 but we can't fix it in v1.x without
introducing new interfaces and deprecating the ones that already exist.

Let's document this behavior in doxygen comments for all affected
routines.

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

TODO: add a task for improving the interface for line lookups

The functions allowing to find GPIO lines by name don't take into
account the fact that line names are not unique in the linux kernel
(neither globally nor per chip). Add a task to address that in v2.0.

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

TODO: clarify the release plan for libgpiod v2.0

Bumping the major version number is now planned to coincide with the
release of the v2 kernel uAPI for the GPIO character device. Update
the appropriate paragraph in the TODO file.

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

TODO: add a task for Rust bindings

I'd like to include Rust bindings in libgpiod at some point. This
is a low-priority task though.

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

bindings: cxx: fix sign-compare compile warnings in tests

Fix sign-compare compile warnings in cxx tests.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

core: fix gpiod_line_get_value_bulk for events

Extend gpiod_line_get_value_bulk so that it works for bulks of
lineevents, not only linehandles.

Reported-by: Gerrit Wyen <ml@ionscale.com>
Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: event: add tests for gpiod_line_get_value_bulk events

Add tests to verify the behaviour of gpiod_line_get_value_bulk when
applied to a bulk of event lines.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: tests: add tests for bulk events get_values

Add tests to verify the behaviour of get_values when applied to a bulk
of event lines.

Reported-by: Gerrit Wyen <ml@ionscale.com>
Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

doc: fix comment mix up in gpiod.h

A couple of the doc comments for GPIOD_LINE_REQUEST_XX values document
the wrong value. Switch them so that they document the appropriate value.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: remove debug asserts

Remove asserts that are a hangover from debugging test cases.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: fix the forward declaration for line_event

line_event is defined as a struct, not a class. Fix the forward
declaration for consistency.

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

gpioinfo: print bias flags if set

When printing line information: check the bias configuration and include
the current value in the 'flags' column of output.

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

tools: unduplicate signalfd() code

The code creating the signal file descriptor in gpiomon and gpioset is
pretty much the same. Move it into tools-common.

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

bindings: cxx: drop a stray newline

Drop an unnecessary newline from struct line_event.

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

doc: improve the description of gpiod_line_event_read()

The description of gpiod_line_event_read() states that it reads the last
event that occurred for this line. This is not true: the kernel stores
the events in a FIFO and this function reads the next event from it.

Fix the confusing statement.

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

TODO: add a list of planned API changes for v2.0

At some point in the future we'll make non-compatible changes to the
API and increase the major version number. Add a list of changes planned
for v2.0 to the TODO file.

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

tools: tests: fix regex patterns for timestamps in gpiomon test cases

Commit f8850206e160 ("gpio: Switch timestamps to ktime_get_ns()") in the
linux kernel (released in v5.7-rc1) changed the clock used to generate
line events from real-time to monotonic. This has the effect of making
the timestamp values much smaller and it uncovered a bug in regex
patterns used to verify gpiomon output: they don't expect there to be
any whitespace characters in the timestamp part of the line.

Fix it by accepting any number of whitespace chars between the opening
'[' and the first digit of the timestamp.

Fixes: 9c5a6f31ebff ("tests: use GLib for library test cases and bats for gpio-tools")
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

doc: add descriptions for doxygen sub-sections

Add additional descriptions fox doxygen sub-sections under the line
section.

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

bindings: python: add the __version__ module attribute

The python module provides the version_string() function that returns
the API version but the standard way to do this according to PEP 396
is by providing the __version__ attribute at the module level.

Add __version__ constant to gpiod module and mark version_string() as
deprecated in the doc.

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

build: use the gnu89 C standard explicitly

We're already using it implicitly but GCC may change the default
standard to gnu99 at some point, so use gnu89 explicitly whenever
building C files.

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

core: reuse the err_close_fd label in gpiod_chip_open()

Remove redundant resource cleanup in error path after is_gpiochip_cdev()
and reuse the already existing label.

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

build: check for realpath() in configure.ac

Core library is now using realpath(). Check its availability in
configure.ac.

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

core: relax gpiod_chip_open() for symbolic links

User may ask device helper tool, for example, udev, to create a specific
symbolic link to a device node. GPIO chip character device node is not
exceptional. However, libgpiod in the commit d9b1c1f14c6b
("core: harden gpiod_chip_open()") went way too far in the hardening device
node check.

Relax that hardening for symbolic link to fix the regression.

Reproducer:

  % gpioinfo /dev/gpiochip5
  gpiochip5 - 16 lines:
      line   0:  "MUX33_DIR" "uart1-rx-oe" output active-high [used]
      ...

  % ln -sf /dev/gpiochip5 /dev/MyGPIO_5

  % gpioinfo /dev/MyGPIO_5
  gpioinfo: looking up chip /dev/MyGPIO_5: Inappropriate ioctl for device

Link: https://stackoverflow.com/questions/60057494/gpio-issue-with-sym-link
Fixes: d9b1c1f14c6b ("core: harden gpiod_chip_open()")
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: fix std namespace resolution

We try to always resolve symbols from std starting from the global
namespace by using the '::' prefix but there are a couple places where
this was missed. This patch makes the resolution consistent treewide.

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

tests: misc: fix the version string test case

The current development version is v1.6-devel. The '-' character is
there to differentiate between the "main" version part and the extra
suffix.

The existing test case for the version string is now failing because
we used '.' previously for the extra version suffix. Fix it by extending
the regex pattern.

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

Merge branch 'next'

libgpiod: start v1.6 development cycle

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

libgpiod v1.5

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

README: remove the reference to v4.8 kernel headers

The project now depends on v5.5 kernel headers to build. Drop the
reference to v4.8 headers and instead refer readers to the contents
of configure.ac for the exact required version.

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

iter: remove unnecessary indirection in free_dirs

It is not necessary to pass the address of the 'dirs' variable to
dirs_free(), so this commit removes the unecessary indirection.

Signed-off-by: Chris Nisbet <chris@nisbet.kiwi.nz>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

configure: move the ABI version definition for libgpiomockup

Having it separated from the other ABI versions already led to it almost
being forgotten when incrementing versions before release. Group all
versions together.

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

build: increment the revision in libgpiomockup's ABI version

This helper library too has a separate ABI version, but we missed it
when incrementing other ABI numbers for v1.5-rc1. Increment the revision
only as no new interfaces were added or old ones removed.

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

libgpiod v1.5-rc2

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

bindings: python: tests: package the python test-suite in the dist tarball

The test-suite python scripts is added to bin_SCRIPTS in Makefile.am.
This means it's not distributed by default. Add it to dist_bin_SCRIPTS
and make it part of the distribution tarball.

Fixes: 452696601ae5 ("bindings: python: use unittest to implement a proper test-suite")
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

libgpiod v1.5-rc1

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

NEWS: updates for v1.5

Add release notes for libgpiod v1.5.

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

tools: add a newline between the usage and summary sections of help text

Improve the readability of help messages in all tools by adding
a newline between the usage and summary sections.

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

treewide: split .gitignore into separate files

Cleanup the main .gitignore: remove explicit filenames which are already
implicitly ignored with pattern entries and move all the specific
entries into appropriate sub-directories.

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

bindings: python: tests: add a test-case for reading multiple line events

Extend the test coverage of Python bindings with tests of reading of
multiple line events at once.

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

bindings: python: add a method for reading multiple line events

Add a new method to the Line class allowing to read up to 16 line
events at once.

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

bindings: cxx: tests: add a test-case for reading multiple line events

Extend the test coverage of C++ bindings with tests of reading of
multiple line events at once.

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

bindings: cxx: provide a method for reading multiple line events

Add a new method to gpiod::line class allowing to read up to 16 line
events at once.

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

tests: event: extend test coverage for reading multiple line events at once

Add test cases for new helpers allowing users to read multiple events
at once.

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

core: provide functions for reading multiple line events at once

The kernel allows us to read multiple (up to 16) line events with
a single read() call, but up to this point libgpiod only supported
reading one event at a time. Add two new functions that allow users
to read more events at the same time.

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

core: use gpiod_line_event_get_fd() in gpiod_line_event_read()

We can drop the redundant line state check if we directly call
gpiod_line_event_get_fd() from gpiod_line_event_read(). As opposed
to line_get_fd() it checks if the line was requested for events.

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

gitignore: ignore libtool scripts created when cross-compiling

When '--host' option is passed to configure, the name of the generated
libtool script will be prefixed with the value used as argument for
'--host'. Add a pattern for prefixed 'libtool' scripts to .gitignore.

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

build: drop a redundant check for linux/version.h header

We're now checking for linux/version.h on every build - not only when
building tests. Drop the redundant check.

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

build: check linux headers version at build-time

Original libgpiod relied on linux headers v4.8 to build but it was only
documented in README and not enforced at build-time. We now support
features first available in linux v5.5. Add a check to configure.ac that
verifies if recent enough kernel headers are available - otherwise we'd
fail only when trying to build the library.

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

bindings: python: fix segfault when calling Line.request()

When Line.request() is called without the required 'consumer=value'
argument, the module attempts access an empty dictionary object
resulting in a segfault. This patch avoids such access when the
dictionary is empty and maintains the current design where the
LineBulk object is responsible for validation of arguments.

Signed-off-by: Joel Savitz <jsavitz@redhat.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: python: make vals in gpiod_Line_set_value consistent with other functions

Change the vals in gpiod_Line_set_value from a tuple of tuples to just a
tuple. This brings it into line with other vals in the module such as
gpiod_Line_set_config and gpiod_Line_set_direction_output.

The previous usage made the vals equivalent to an args (a tuple of
arguments equivalent to argc,argv in C), as per gpiod_Line_set_flags.

Renaming vals to args in gpiod_Line_set_value was not an option as there
is already an args parameter.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: fix indentation of wrapped field descriptions

Minor formatting fix to make long text descriptions of params wrap under
the text, not under the param name.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

doc: document gpiod_line_set_value_bulk NULL values behaviour

The handling of NULL values by gpiod_line_set_value_bulk has been changed
to interpret NULL as low values for all lines. This patch updates the
documentation of the function to describe that.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tools: add tests for drive flags

Add tests for drive flags in gpioset.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tools: gpioset: add support for drive flags

Add support for drive flags to gpioset so that line drive flags
(open-drain,open-source) can be set from the command line.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tools: add tests for bias flags

Add tests for bias flags to applicable tools - gpioget, gpioset, and
gpiomon.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tools: add support for bias flags

Add support for bias flags to applicable tools - gpioget, gpioset, and
gpiomon.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: python: tests: add tests for SET_CONFIG methods

Extend test coverage over set_config, set_flags, set_direction_input, and
set_direction_output methods.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: python: add support for SET_CONFIG

Add methods to support setting line configuration.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: python: move tuple to int array conversion into helper function

Restructured gpiod_LineBulk_set_values to move the conversion of values
from Python tuple to int array into a helper function as it is useful for
similar functions.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: tests: add tests for SET_CONFIG methods

Extend test coverage over set_config, set_flags, set_direction_input, and
set_direction_output methods.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: add support for SET_CONFIG

Add methods to support setting line configuration.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: add tests for SET_CONFIG

Extend test coverage over the SET_CONFIG functions.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

core: add support for SET_CONFIG

Extend the libgpiod API to support the setting line configuration using the
GPIO GPIOHANDLE_SET_CONFIG_IOCTL uAPI ioctl.

The core change is the addition of gpiod_line_set_config, which provides a
low level wrapper around the ioctl.

Additionally, higher level helper functions, gpiod_line_set_flags,
gpiod_line_set_direction_input, and gpiod_line_set_direction_output provide
slightly simplified APIs for common use cases.

Bulk forms of all functions are also provided.

Documented the fields of gpiod_line to better identify the purpose of
each where the field name alone is not sufficiently clear, and to
indicate which flags are applicable to each field.

Implementation includes a few helper functions that serve to keep the
code tidier and are consistent with similar helper functions already
present.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: python: tests: add tests for bias flags

Extend test coverage to cover the bias flags in requests and the bias
setting returned by line.bias().

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: python: add support for bias flags

Add support for bias flags in line requests and returning the line bias
setting via a bias accessor.

Based on initial work by Drew Fustini <drew@pdp7.com>.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: tests: add tests for bias flags

Extend test coverage over the bias flags in requests and the bias setting
returned by line.bias().

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: add support for bias flags

Add support for bias flags in line requests and returning the line bias
setting via a bias accessor.

Based on initial work by Drew Fustini <drew@pdp7.com>.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: add tests for bias flags

Extend test coverage over the bias flags, gpiod_line_bias and the extended
ctxless functions.

Also update existing tests to check bias flags where line state is checked.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

core: add support for bias flags

Extend the libgpiod API to support the bias flags recently added to the
kernel GPIO uAPI.  The core change is the addition of
GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLE, GPIOD_LINE_REQUEST_FLAG_BIAS_PULL_UP
and GPIOD_LINE_REQUEST_FLAG_BIAS_PULL_DOWN flags to be passed into
line_request functions, and the addition of gpiod_line_bias to return the
bias state of lines.

Variants of the ctxless functions that accept an active_low flag
are added to also accept other flags. The variant names add a "_ext"
suffix to the name of the original function.

Based on initial work by Drew Fustini <drew@pdp7.com>.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

tests: fix a typo in comment

s/There/These.

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

build: use AC_CHECK_PROG() instead of AC_CHECK_FILE() for python3-config

Commit 9ed02fc793b3 ("build: check for python-config in configure")
breaks cross-compilation because AC_CHECK_FILE() only checks the host
machine. Use AC_CHECK_PROG() instead.

Cc: Joel Savitz <joelsavitz@gmail.com>
Fixes: 9ed02fc793b3 ("build: check for python-config in configure")
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

core: deprecate gpiod_needs_update()

This function and the logic behind have been introduced in an early
version of libgpiod for reasons that have been long forgotten.

When updating the line info after a line request fails, just propagate
the error out of the request function instead of setting the internal
needs_update variable. Drop the entire logic behind gpiod_needs_update(),
make this routine always return false and mark it as deprecated in the
header.

Suggested-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

treewide: change "correspond with" to "correspond to"

Trivial grammar fix. "correspond with" can mean either being in agreement
with, happening at the same time, or communication between parties.
"correspond to" is used to mean equivalance, which is the intended use
throughout the documentation.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

core: allow gpiod_line_set_value_bulk() to accept null values

Change gpiod_line_set_value_bulk to interpret a NULL values pointer as an
array of zero, as per gpiod_line_request_bulk, gpiod_line_set_config_bulk,
and gpiod_line_set_direction_bulk_output.

The old behaviour was to segfault.

Add a corresponding test case for gpiod_line_set_value_bulk().

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: initialize bitset with integer instead of string

Initializing bitsets with string is inefficient and confusing.
Initialize them with the corresponding int instead.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: drop noexcept from direction() and active_state()

Both line::direction() and line::active_state() methods can throw and
so should not be declared as noexcept.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: cxx: tests: fix misspelling of parameter

Trivial misspelling fix: s/paramter/parameter.

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

core: fix misspelling of parameter

Trivial fix to bring gpiod_ctxless_event_monitor_multiple() documentation
into line with gpiod_ctxless_event_monitor_multiple_ext().

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

core: move request flag to handle flag conversion into a separate function

Move common conversion code from line_request_values and
line_request_event_single() into a separate function to simplify adding
additional flags.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

build: check for python-config in configure

Currently, configure succeeds when python is installed without its
development components, i.e. python-config and headers. The subsequent
make will fail when gcc cannot locate Python.h.

This patch fixes that behavior by throwing an error at configure-time if
python-config cannot be found.

Signed-off-by: Joel Savitz <joelsavitz@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

bindings: python: directly return the value from PyErr_SetFromErrno()

PyErr_SetFromErrno() always returns NULL. We can return from functions
on failure directly instead of calling it and then returning NULL in
the next line.

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

README: update the testing section

Add information about the tests included in Python and C++ bindings.
Move the BINDINGS section above TESTING so that the user first knows
that bindings exist before learning they also provide their own
test-suites.

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

TODO: add a task for a re-write of python bindings

The python bindings should be improved but without breaking the existing
programs. Add an appropriate task to the TODO list.

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

bindings: python: provide Line.update()

Python bindings are missing the functionality provided by the core C
library's gpiod_line_update(). Extend the Line class with the update()
method that allows to re-read the line information from the kernel.

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

bindings: cxx: provide line::update()

The C++ bindings are missing the functionality provided by the core C
library's gpiod_line_update(). Extend the line class with the update()
method that allows to re-read the line information from the kernel.

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

build: tweak formatting of multi-line variables in Makefiles

Don't put a tab between the asignment and the first string - just move
the whole list one line below.

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

bindings: python: examples: check if '__main__' is set

The examples are programs meant to be executed directly and not
imported. Use the standard "if __name__ == '__main__':" before
any code.

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

TODO: remove the task for running external processes in gpiomon

This functionality can be achieved with a shell oneliner, for example:

  gpiomon --line-buffered --format="%o %e" 0 0 | while read line; \
do cut -d" " -f2; done

There's no need to add this to the program. It would make the code
much more complicated without any real benefit.

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

core: rename up_to_date to needs_update in struct gpiod_line

This variable is called up_to_date which can lead readers to the wrong
conclusion that libgpiod can somehow know when external actors (such as
a different process or a kernel driver) change the state of a GPIO line.

This is not the case and libgpiod only ever knows if a line needs info
update when a previous internal call to gpiod_line_update() fails.

The kernel does not provide any notification mechanism currently.

For that reason: rename the variable to needs_update.

While at it: clarify the documentation for gpiod_line_needs_update().

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

bindings: python: tests: fix checking the kernel version

Kernel release candidate version strings seem to not be working
correctly with python's version.parse() function. Split the string
retrieved with os.uname().release using '-' as delimiter and pass
only the first part - 'major.minor.release' - to version.parse().

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

core: fix the major:minor number comparison between the device and sysfs

Current code will incorrectly conclude that a device "1:1" matches
a sysfs device "1:10" as the length it reads from sysfsp is based on
the devstr length, which in this example is 3.

Always read the whole sysfs attribute and compare the string generated
from actual major:minor numbers against it (minus the trailing newline).

Fixes: d9b1c1f14c6b ("core: harden gpiod_chip_open()")
Reported-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>

treewide: tests: uncomment previously failing test assertions

Mainline commit 2c60e6b5c924 ("gpiolib: never report open-drain/source
lines as 'input' to user-space") in the linux kernel has now been
backported to v5.2 stable branch and released in linux v5.2.11. We can
now enable back the assertions that were previously failed in test
suites (core, C++ and python). The required kernel versions must be
updated as well.

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