treewide: remove more cruft and add some improvements
Subsystems (2)
v2 cover treewide: remove more cruft and add some improvements
From: Bartosz Golaszewski <[email protected]>
This is another batch of improvements to libgpiod before we overhaul the data structure model.
The last patch adds the kernel uapi header to the repository so that we no longer depend on its presence on the host system.
v1 -> v2:
- rename BIAS_NONE to BIAS_UNKNOWN
- rename DRIVE_NONE to DRIVE_PUSH_PULL
- rename BIAS_DISABLE to BIAS_DISABLED
Bartosz Golaszewski (7):
treewide: remove helpers for opening chips by name & number
treewide: simplify the active-low line property
treewide: rename BIAS_AS_IS to BIAS_UNKNOWN
treewide: rename BIAS_DISABLE to BIAS_DISABLED
treewide: make drive settings an enum
bindings: cxx: line: reorder bias mapping entries
core: add the kernel uapi header to the repository
bindings/cxx/chip.cpp | 41 +- bindings/cxx/examples/gpioinfocxx.cpp | 3 +- bindings/cxx/gpiod.hpp | 61 +-- bindings/cxx/line.cpp | 28 +- bindings/cxx/line_bulk.cpp | 4 +- bindings/cxx/tests/tests-chip.cpp | 97 +---- bindings/cxx/tests/tests-event.cpp | 14 +- bindings/cxx/tests/tests-iter.cpp | 2 +- bindings/cxx/tests/tests-line.cpp | 97 ++--- bindings/python/examples/gpioinfo.py | 4 +- bindings/python/gpiodmodule.c | 187 +++------ bindings/python/tests/gpiod_py_test.py | 177 ++++----- configure.ac | 12 +- include/gpiod.h | 69 +--- lib/Makefile.am | 2 +- lib/core.c | 35 +- lib/helpers.c | 57 --- lib/uapi/gpio.h | 522 +++++++++++++++++++++++++ tests/tests-chip.c | 41 -- tests/tests-event.c | 2 +- tests/tests-line.c | 110 +++--- tools/gpiodetect.c | 2 +- tools/gpiofind.c | 2 +- tools/gpioget.c | 2 +- tools/gpioinfo.c | 30 +- tools/gpiomon.c | 2 +- tools/gpioset.c | 2 +- tools/tools-common.c | 59 ++- tools/tools-common.h | 3 + 29 files changed, 934 insertions(+), 733 deletions(-) create mode 100644 lib/uapi/gpio.h
Signature · 1 line
2.29.1
PATCH v2 1/7 treewide: remove helpers for opening chips by name & number
From: Bartosz Golaszewski <[email protected]>
Helper wrappers around gpiod_chip_open() shouldn't really be part of the core, low-level library. They assume that devtmpfs is mounted at /dev and that GPIO chips follow the gpiochipX naming convention.
This changeset removes all variants of gpiod_chip_open() other than the one taking the path as argument. We're doing this treewide so C++ and Python bindings lose the 'how' argument that currently allows to change the way the chips are opened by the chip's constructors or the open() method in C++.
The gpio-tools programs still support opening chips by number, name and path but they implement this functionality locally rather than using the library code.
--- bindings/cxx/chip.cpp | 41 +------- bindings/cxx/gpiod.hpp | 25 +---- bindings/cxx/tests/tests-chip.cpp | 97 +++--------------- bindings/cxx/tests/tests-event.cpp | 14 +-- bindings/cxx/tests/tests-iter.cpp | 2 +- bindings/cxx/tests/tests-line.cpp | 16 +-- bindings/python/gpiodmodule.c | 57 ++--------- bindings/python/tests/gpiod_py_test.py | 133 +++++++++++-------------- include/gpiod.h | 29 ------ lib/helpers.c | 57 ----------- tests/tests-chip.c | 41 -------- tools/gpiodetect.c | 2 +- tools/gpiofind.c | 2 +- tools/gpioget.c | 2 +- tools/gpioinfo.c | 4 +- tools/gpiomon.c | 2 +- tools/gpioset.c | 2 +- tools/tools-common.c | 57 +++++++++++ tools/tools-common.h | 3 + 19 files changed, 167 insertions(+), 419 deletions(-)
bindings/cxx/chip.cpp +5 -36
@@ -15,35 +15,6 @@ namespace gpiod { namespace { -::gpiod_chip* open_lookup(const ::std::string& device) -{ - return ::gpiod_chip_open_lookup(device.c_str()); -} - -::gpiod_chip* open_by_path(const ::std::string& device) -{ - return ::gpiod_chip_open(device.c_str()); -} - -::gpiod_chip* open_by_name(const ::std::string& device) -{ - return ::gpiod_chip_open_by_name(device.c_str()); -} - -::gpiod_chip* open_by_number(const ::std::string& device) -{ - return ::gpiod_chip_open_by_number(::std::stoul(device)); -} - -using open_func = ::std::function<::gpiod_chip* (const ::std::string&)>; - -const ::std::map<int, open_func> open_funcs = { - { chip::OPEN_LOOKUP, open_lookup, }, - { chip::OPEN_BY_PATH, open_by_path, }, - { chip::OPEN_BY_NAME, open_by_name, }, - { chip::OPEN_BY_NUMBER, open_by_number, }, -}; - void chip_deleter(::gpiod_chip* chip) { ::gpiod_chip_close(chip);
@@ -56,10 +27,10 @@ bool is_gpiochip_device(const ::std::string& path) return ::gpiod_is_gpiochip_device(path.c_str()); } -chip::chip(const ::std::string& device, int how) +chip::chip(const ::std::string& path) : _m_chip() { - this->open(device, how); + this->open(path); } chip::chip(::gpiod_chip* chip)
@@ -74,14 +45,12 @@ chip::chip(const ::std::weak_ptr<::gpiod_chip>& chip_ptr) } -void chip::open(const ::std::string& device, int how) +void chip::open(const ::std::string& path) { - auto func = open_funcs.at(how); - - ::gpiod_chip *chip = func(device); + ::gpiod_chip *chip = ::gpiod_chip_open(path.c_str()); if (!chip) throw ::std::system_error(errno, ::std::system_category(), - "cannot open GPIO device " + device); + "cannot open GPIO device " + path); this->_m_chip.reset(chip, chip_deleter); }
bindings/cxx/gpiod.hpp +4 -21
@@ -58,10 +58,9 @@ public: /** * @brief Constructor. Opens the chip using chip::open. - * @param device String describing the GPIO chip. - * @param how Indicates how the chip should be opened. + * @param path Path to the GPIO chip device. */ - GPIOD_API chip(const ::std::string& device, int how = OPEN_LOOKUP); + GPIOD_API chip(const ::std::string& path); /** * @brief Copy constructor. References the object held by other.
@@ -96,13 +95,12 @@ public: /** * @brief Open a GPIO chip. - * @param device String describing the GPIO chip. - * @param how Indicates how the chip should be opened. + * @param path Path to the GPIO chip device. * * If the object already holds a reference to an open chip, it will be * closed and the reference reset. */ - GPIOD_API void open(const ::std::string &device, int how = OPEN_LOOKUP); + GPIOD_API void open(const ::std::string &path); /** * @brief Reset the internal smart pointer owned by this object.
@@ -184,21 +182,6 @@ public: */ GPIOD_API bool operator!(void) const noexcept; - /** - * @brief Affect the way in which chip::chip and chip::open will try - * to open a GPIO chip character device. - */ - enum : int { - OPEN_LOOKUP = 1, - /**< Open based on the best guess what the supplied string is. */ - OPEN_BY_PATH, - /**< Assume the string is a path to the GPIO chardev. */ - OPEN_BY_NAME, - /**< Assume the string is the name of the chip */ - OPEN_BY_NUMBER, - /**< Assume the string is the number of the GPIO chip. */ - }; - private: chip(::gpiod_chip* chip);
bindings/cxx/tests/tests-chip.cpp +13 -84
158 lines not on this page · raw message
bindings/cxx/tests/tests-event.cpp +7 -7
@@ -24,7 +24,7 @@ TEST_CASE("Line events can be detected", "[event][line]") { mockup::probe_guard mockup_chips({ 8 }); mockup::event_thread events(0, 4, 200); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); auto line = chip.get_line(4); ::gpiod::line_request config;
@@ -105,7 +105,7 @@ TEST_CASE("Watching line_bulk objects for events works", "[event][bulk]") { mockup::probe_guard mockup_chips({ 8 }); mockup::event_thread events(0, 2, 200); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); auto lines = chip.get_lines({ 0, 1, 2, 3 }); ::gpiod::line_request config;
@@ -133,7 +133,7 @@ TEST_CASE("Watching line_bulk objects for events works", "[event][bulk]") TEST_CASE("It's possible to retrieve the event file descriptor", "[event][line]") { mockup::probe_guard mockup_chips({ 8 }); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); auto line = chip.get_line(4); ::gpiod::line_request config;
@@ -165,7 +165,7 @@ TEST_CASE("Event file descriptors can be used for polling", "[event]") { mockup::probe_guard mockup_chips({ 8 }); mockup::event_thread events(0, 3, 200); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); auto lines = chip.get_lines({ 0, 1, 2, 3, 4, 5 }); ::gpiod::line_request config;
@@ -196,7 +196,7 @@ TEST_CASE("Event file descriptors can be used for polling", "[event]") TEST_CASE("It's possible to read a value from a line requested for events", "[event][line]") { mockup::probe_guard mockup_chips({ 8 }); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); auto line = chip.get_line(4); ::gpiod::line_request config;
@@ -222,7 +222,7 @@ TEST_CASE("It's possible to read a value from a line requested for events", "[ev TEST_CASE("It's possible to read values from lines requested for events", "[event][bulk]") { mockup::probe_guard mockup_chips({ 8 }); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); auto lines = chip.get_lines({ 0, 1, 2, 3, 4 }); ::gpiod::line_request config;
@@ -256,7 +256,7 @@ TEST_CASE("It's possible to read values from lines requested for events", "[even TEST_CASE("It's possible to read more than one line event", "[event][line]") { mockup::probe_guard mockup_chips({ 8 }); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); auto line = chip.get_line(4); ::gpiod::line_request config;
bindings/cxx/tests/tests-iter.cpp +1 -1
@@ -15,7 +15,7 @@ using ::gpiod::test::mockup; TEST_CASE("Line iterator works", "[iter][line]") { mockup::probe_guard mockup_chips({ 4 }); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); unsigned int count = 0; for (auto& it: ::gpiod::line_iter(chip))
bindings/cxx/tests/tests-line.cpp +8 -8
@@ -21,7 +21,7 @@ const ::std::string consumer = "line-test"; TEST_CASE("Line information can be correctly retrieved", "[line]") { mockup::probe_guard mockup_chips({ 8 }, mockup::FLAG_NAMED_LINES); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); auto line = chip.get_line(4); SECTION("unexported line")
@@ -167,7 +167,7 @@ TEST_CASE("Line information can be correctly retrieved", "[line]") TEST_CASE("Line bulk object works correctly", "[line][bulk]") { mockup::probe_guard mockup_chips({ 8 }, mockup::FLAG_NAMED_LINES); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); SECTION("lines can be added, accessed and cleared") {
@@ -210,7 +210,7 @@ TEST_CASE("Line bulk object works correctly", "[line][bulk]") TEST_CASE("Line values can be set and read", "[line]") { mockup::probe_guard mockup_chips({ 8 }); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); ::gpiod::line_request config; config.consumer = consumer.c_str();
@@ -308,7 +308,7 @@ TEST_CASE("Line values can be set and read", "[line]") TEST_CASE("Line can be reconfigured", "[line]") { mockup::probe_guard mockup_chips({ 8 }); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); ::gpiod::line_request config; config.consumer = consumer.c_str();
@@ -436,7 +436,7 @@ TEST_CASE("Line can be reconfigured", "[line]") TEST_CASE("Exported line can be released", "[line]") { mockup::probe_guard mockup_chips({ 8 }); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); auto line = chip.get_line(4); ::gpiod::line_request config;
@@ -487,7 +487,7 @@ TEST_CASE("Uninitialized GPIO line_bulk behaves correctly", "[line][bulk]") TEST_CASE("Cannot request the same line twice", "[line]") { mockup::probe_guard mockup_chips({ 8 }); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); ::gpiod::line_request config; config.consumer = consumer.c_str();
@@ -516,7 +516,7 @@ TEST_CASE("Cannot request the same line twice", "[line]") TEST_CASE("Cannot get/set values of unrequested lines", "[line]") { mockup::probe_guard mockup_chips({ 8 }); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); auto line = chip.get_line(3); SECTION("get value")
@@ -533,7 +533,7 @@ TEST_CASE("Cannot get/set values of unrequested lines", "[line]") TEST_CASE("Line objects can be compared") { mockup::probe_guard mockup_chips({ 8 }); - ::gpiod::chip chip(mockup::instance().chip_name(0)); + ::gpiod::chip chip(mockup::instance().chip_path(0)); auto line1 = chip.get_line(3); auto line2 = chip.get_line(3); auto line3 = chip.get_line(4);
bindings/python/gpiodmodule.c +6 -51
76 lines not on this page · raw message
bindings/python/tests/gpiod_py_test.py +56 -77
466 lines not on this page · raw message
include/gpiod.h +0 -29
@@ -84,35 +84,6 @@ bool gpiod_is_gpiochip_device(const char *path) GPIOD_API;*/ struct gpiod_chip *gpiod_chip_open (const char *path)GPIOD_API ; -/** -* @brief Open a gpiochip by name. -* @param name Name of the gpiochip to open. -* @return GPIO chip handle or NULL if an error occurred. -* -* This routine appends name to '/dev/' to create the path. -*/ -struct gpiod_chip *gpiod_chip_open_by_name (const char *name)GPIOD_API ; - -/** -* @brief Open a gpiochip by number. -* @param num Number of the gpiochip. -* @return GPIO chip handle or NULL if an error occurred. -* -* This routine appends num to '/dev/gpiochip' to create the path. -*/ -struct gpiod_chip *gpiod_chip_open_by_number (unsigned int num)GPIOD_API ; - -/** -* @brief Open a gpiochip based on the best guess what the path is. -* @param descr String describing the gpiochip. -* @return GPIO chip handle or NULL if an error occurred. -* -* This routine tries to figure out whether the user passed it the path to the -* GPIO chip, its name or number as a string. Then it tries to open it using -* one of the gpiod_chip_open** variants. -*/ -struct gpiod_chip *gpiod_chip_open_lookup (const char *descr)GPIOD_API ; -/** * @brief Close a GPIO chip handle and release all allocated resources. * @param chip The GPIO chip object.
lib/helpers.c +0 -57
68 lines not on this page · raw message
tests/tests-chip.c +0 -41
47 lines not on this page · raw message
tools/gpiodetect.c +1 -1
@@ -69,7 +69,7 @@ int main(int argc, char **argv)die_perror ("unable to scan /dev" );for (i =0 ; i < num_chips; i++) { - chip =gpiod_chip_open_by_name (entries[i]->d_name); + chip =chip_open_by_name (entries[i]->d_name);if (!chip) {if (errno ==EACCES ) printf("%s Permission denied\n",
tools/gpiofind.c +1 -1
@@ -70,7 +70,7 @@ int main(int argc, char **argv)die_perror ("unable to scan /dev" );for (i =0 ; i < num_chips; i++) { - chip =gpiod_chip_open_by_name (entries[i]->d_name); + chip =chip_open_by_name (entries[i]->d_name);if (!chip) {if (errno ==EACCES )continue ;
tools/gpioget.c +1 -1
@@ -97,7 +97,7 @@ int main(int argc, char **argv)die ("invalid GPIO offset: %s" , argv[i +1 ]); } - chip =gpiod_chip_open_lookup (device); + chip =chip_open_lookup (device);if (!chip)die_perror ("unable to open %s" , device);
tools/gpioinfo.c +2 -2
@@ -214,7 +214,7 @@ int main(int argc, char **argv)die_perror ("unable to scan /dev" );for (i =0 ; i < num_chips; i++) { - chip =gpiod_chip_open_by_name (entries[i]->d_name); + chip =chip_open_by_name (entries[i]->d_name);if (!chip) {if (errno ==EACCES ) printf("%s Permission denied\n",
@@ -230,7 +230,7 @@ int main(int argc, char **argv) } }else {for (i =0 ; i < argc; i++) { - chip =gpiod_chip_open_lookup (argv[i]); + chip =chip_open_lookup (argv[i]);if (!chip)die_perror ("looking up chip %s" , argv[i]);
tools/gpiomon.c +1 -1
@@ -253,7 +253,7 @@ int main(int argc, char **argv) num_lines++; } - chip =gpiod_chip_open_lookup (argv[0 ]); + chip =chip_open_lookup (argv[0 ]);if (!chip)die_perror ("unable to open %s" , argv[0 ]);
tools/gpioset.c +1 -1
@@ -288,7 +288,7 @@ int main(int argc, char **argv)die ("invalid offset: %s" , argv[i +1 ]); } - chip =gpiod_chip_open_lookup (device); + chip =chip_open_lookup (device);if (!chip)die_perror ("unable to open %s" , device);
tools/tools-common.c +57 -0
66 lines not on this page · raw message
tools/tools-common.h +3 -0
@@ -9,6 +9,7 @@#define __GPIOD_TOOLS_COMMON_H__#include <dirent.h> +#include <gpiod.h> /* * Various helpers for the GPIO tools.
@@ -32,5 +33,7 @@ int bias_flags(const char *option);void print_bias_help (void );int make_signalfd (void );int chip_dir_filter (const struct dirent *entry); +struct gpiod_chip *chip_open_by_name (const char *name); +struct gpiod_chip *chip_open_lookup (const char *device);#endif /* __GPIOD_TOOLS_COMMON_H__ */
Signature · 1 line
2.29.1
PATCH v2 2/7 treewide: simplify the active-low line property
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
Unlike line direction - where input and output modes are equal, no signal inversion (active-high) is the natural state of the line while active-low is less likely. Let's drop the ACTIVE_STATE enum treewide and provide a boolean property for lines - is_active_low() - to reflect that fact. This function returning false means the line is "active-high".
--- bindings/cxx/examples/gpioinfocxx.cpp | 3 +- bindings/cxx/gpiod.hpp | 16 ++------ bindings/cxx/line.cpp | 6 +-- bindings/cxx/tests/tests-line.cpp | 24 ++++++------ bindings/python/examples/gpioinfo.py | 4 +- bindings/python/gpiodmodule.c | 45 ++++++---------------- bindings/python/tests/gpiod_py_test.py | 16 ++++---- include/gpiod.h | 16 ++------ lib/core.c | 12 +++--- tests/tests-line.c | 52 +++++++++----------------- tools/gpioinfo.c | 10 ++--- 11 files changed, 69 insertions(+), 135 deletions(-)
bindings/cxx/examples/gpioinfocxx.cpp +1 -2
@@ -44,8 +44,7 @@ int main(int argc, char **argv) ::std::cout << " "; ::std::cout.width(10); - ::std::cout << (lit.active_state() == ::gpiod::line::ACTIVE_LOW - ? "active-low" : "active-high"); + ::std::cout << (lit.is_active_low() ? "active-low" : "active-high"); ::std::cout << ::std::endl; }
bindings/cxx/gpiod.hpp +3 -13
@@ -313,10 +313,10 @@ public: GPIOD_API int direction(void) const; /** - * @brief Get current active state of this line. - * @return Current active state setting. + * @brief Check if this line's signal is inverted. + * @return True if this line is "active-low", false otherwise. */ - GPIOD_API int active_state(void) const; + GPIOD_API bool is_active_low(void) const; /** * @brief Get current bias of this line.
@@ -482,16 +482,6 @@ public: /**< Line's direction setting is output. */ }; - /** - * @brief Possible active state settings. - */ - enum : int { - ACTIVE_LOW = 1, - /**< Line's active state is low. */ - ACTIVE_HIGH, - /**< Line's active state is high. */ - }; - /** * @brief Possible bias settings. */
bindings/cxx/line.cpp +2 -4
@@ -74,14 +74,12 @@ int line::direction(void) const return dir == GPIOD_LINE_DIRECTION_INPUT ? DIRECTION_INPUT : DIRECTION_OUTPUT; } -int line::active_state(void) const +bool line::is_active_low(void) const { this->throw_if_null(); line::chip_guard lock_chip(*this); - int active = ::gpiod_line_active_state(this->_m_line); - - return active == GPIOD_LINE_ACTIVE_STATE_HIGH ? ACTIVE_HIGH : ACTIVE_LOW; + return ::gpiod_line_is_active_low(this->_m_line); } int line::bias(void) const
bindings/cxx/tests/tests-line.cpp +12 -12
@@ -29,7 +29,7 @@ TEST_CASE("Line information can be correctly retrieved", "[line]") REQUIRE(line.offset() == 4); REQUIRE(line.name() == "gpio-mockup-A-4"); REQUIRE(line.direction() == ::gpiod::line::DIRECTION_INPUT); - REQUIRE(line.active_state() == ::gpiod::line::ACTIVE_HIGH); + REQUIRE_FALSE(line.is_active_low()); REQUIRE(line.consumer().empty()); REQUIRE_FALSE(line.is_requested()); REQUIRE_FALSE(line.is_used());
@@ -49,7 +49,7 @@ TEST_CASE("Line information can be correctly retrieved", "[line]") REQUIRE(line.offset() == 4); REQUIRE(line.name() == "gpio-mockup-A-4"); REQUIRE(line.direction() == ::gpiod::line::DIRECTION_OUTPUT); - REQUIRE(line.active_state() == ::gpiod::line::ACTIVE_HIGH); + REQUIRE_FALSE(line.is_active_low()); REQUIRE(line.is_requested()); REQUIRE(line.is_used()); REQUIRE_FALSE(line.is_open_drain());
@@ -70,7 +70,7 @@ TEST_CASE("Line information can be correctly retrieved", "[line]") REQUIRE(line.offset() == 4); REQUIRE(line.name() == "gpio-mockup-A-4"); REQUIRE(line.direction() == ::gpiod::line::DIRECTION_OUTPUT); - REQUIRE(line.active_state() == ::gpiod::line::ACTIVE_LOW); + REQUIRE(line.is_active_low()); REQUIRE(line.is_requested()); REQUIRE(line.is_used()); REQUIRE(line.is_open_drain());
@@ -90,7 +90,7 @@ TEST_CASE("Line information can be correctly retrieved", "[line]") REQUIRE(line.offset() == 4); REQUIRE(line.name() == "gpio-mockup-A-4"); REQUIRE(line.direction() == ::gpiod::line::DIRECTION_OUTPUT); - REQUIRE(line.active_state() == ::gpiod::line::ACTIVE_HIGH); + REQUIRE_FALSE(line.is_active_low()); REQUIRE(line.is_requested()); REQUIRE(line.is_used()); REQUIRE_FALSE(line.is_open_drain());
@@ -110,7 +110,7 @@ TEST_CASE("Line information can be correctly retrieved", "[line]") REQUIRE(line.offset() == 4); REQUIRE(line.name() == "gpio-mockup-A-4"); REQUIRE(line.direction() == ::gpiod::line::DIRECTION_OUTPUT); - REQUIRE(line.active_state() == ::gpiod::line::ACTIVE_HIGH); + REQUIRE_FALSE(line.is_active_low()); REQUIRE(line.is_requested()); REQUIRE(line.is_used()); REQUIRE_FALSE(line.is_open_drain());
@@ -130,7 +130,7 @@ TEST_CASE("Line information can be correctly retrieved", "[line]") REQUIRE(line.offset() == 4); REQUIRE(line.name() == "gpio-mockup-A-4"); REQUIRE(line.direction() == ::gpiod::line::DIRECTION_OUTPUT); - REQUIRE(line.active_state() == ::gpiod::line::ACTIVE_HIGH); + REQUIRE_FALSE(line.is_active_low());; REQUIRE(line.is_requested()); REQUIRE(line.is_used()); REQUIRE_FALSE(line.is_open_drain());
@@ -150,7 +150,7 @@ TEST_CASE("Line information can be correctly retrieved", "[line]") REQUIRE(line.offset() == 4); REQUIRE(line.name() == "gpio-mockup-A-4"); REQUIRE(line.direction() == ::gpiod::line::DIRECTION_OUTPUT); - REQUIRE(line.active_state() == ::gpiod::line::ACTIVE_HIGH); + REQUIRE_FALSE(line.is_active_low()); REQUIRE(line.is_requested()); REQUIRE(line.is_used()); REQUIRE_FALSE(line.is_open_drain());
@@ -320,19 +320,19 @@ TEST_CASE("Line can be reconfigured", "[line]") config.flags = 0; line.request(config); REQUIRE(line.direction() == ::gpiod::line::DIRECTION_INPUT); - REQUIRE(line.active_state() == ::gpiod::line::ACTIVE_HIGH); + REQUIRE_FALSE(line.is_active_low()); line.set_config(::gpiod::line_request::DIRECTION_OUTPUT, ::gpiod::line_request::FLAG_ACTIVE_LOW,1); REQUIRE(line.direction() == ::gpiod::line::DIRECTION_OUTPUT); - REQUIRE(line.active_state() == ::gpiod::line::ACTIVE_LOW); + REQUIRE(line.is_active_low()); REQUIRE(mockup::instance().chip_get_value(0, 3) == 0); line.set_value(0); REQUIRE(mockup::instance().chip_get_value(0, 3) == 1); line.set_config(::gpiod::line_request::DIRECTION_OUTPUT, 0); REQUIRE(line.direction() == ::gpiod::line::DIRECTION_OUTPUT); - REQUIRE(line.active_state() == ::gpiod::line::ACTIVE_HIGH); + REQUIRE_FALSE(line.is_active_low()); REQUIRE(mockup::instance().chip_get_value(0, 3) == 0); line.set_value(1); REQUIRE(mockup::instance().chip_get_value(0, 3) == 1);
@@ -348,12 +348,12 @@ TEST_CASE("Line can be reconfigured", "[line]") line.set_flags(::gpiod::line_request::FLAG_ACTIVE_LOW); REQUIRE(line.direction() == ::gpiod::line::DIRECTION_OUTPUT); - REQUIRE(line.active_state() == ::gpiod::line::ACTIVE_LOW); + REQUIRE(line.is_active_low()); REQUIRE(mockup::instance().chip_get_value(0, 3) == 0); line.set_flags(0); REQUIRE(line.direction() == ::gpiod::line::DIRECTION_OUTPUT); - REQUIRE(line.active_state() == ::gpiod::line::ACTIVE_HIGH); + REQUIRE_FALSE(line.is_active_low()); REQUIRE(mockup::instance().chip_get_value(0, 3) == 1); }
bindings/python/examples/gpioinfo.py +2 -2
@@ -23,11 +23,11 @@ if __name__ == '__main__': name = line.name() consumer = line.consumer() direction = line.direction() - active_state = line.active_state() + active_low = line.is_active_low() print('\tline {:>3}: {:>18} {:>12} {:>8} {:>10}'.format( offset, 'unnamed' if name is None else name, 'unused' if consumer is None else consumer, 'input' if direction == gpiod.Line.DIRECTION_INPUT else 'output', - 'active-low' if active_state == gpiod.Line.ACTIVE_LOW else 'active-high')) + 'active-low' if active_low else 'active-high'))
bindings/python/gpiodmodule.c +11 -34
76 lines not on this page · raw message
bindings/python/tests/gpiod_py_test.py +8 -8
@@ -205,7 +205,7 @@ class LineInfo(MockupTestCase): self.assertEqual(line.offset(), 4) self.assertEqual(line.name(), 'gpio-mockup-A-4') self.assertEqual(line.direction(), gpiod.Line.DIRECTION_INPUT) - self.assertEqual(line.active_state(), gpiod.Line.ACTIVE_HIGH) + self.assertFalse(line.is_active_low()) self.assertEqual(line.consumer(), None) self.assertFalse(line.is_used()) self.assertFalse(line.is_requested())
@@ -219,7 +219,7 @@ class LineInfo(MockupTestCase): self.assertEqual(line.offset(), 4) self.assertEqual(line.name(), 'gpio-mockup-A-4') self.assertEqual(line.direction(), gpiod.Line.DIRECTION_OUTPUT) - self.assertEqual(line.active_state(), gpiod.Line.ACTIVE_LOW) + self.assertTrue(line.is_active_low()) self.assertEqual(line.consumer(), default_consumer) self.assertTrue(line.is_used()) self.assertTrue(line.is_requested())
@@ -235,7 +235,7 @@ class LineInfo(MockupTestCase): self.assertEqual(line.offset(), 4) self.assertEqual(line.name(), 'gpio-mockup-A-4') self.assertEqual(line.direction(), gpiod.Line.DIRECTION_OUTPUT) - self.assertEqual(line.active_state(), gpiod.Line.ACTIVE_LOW) + self.assertTrue(line.is_active_low()) self.assertEqual(line.consumer(), default_consumer) self.assertTrue(line.is_used()) self.assertTrue(line.is_requested())
@@ -253,7 +253,7 @@ class LineInfo(MockupTestCase): self.assertEqual(line.offset(), 4) self.assertEqual(line.name(), 'gpio-mockup-A-4') self.assertEqual(line.direction(), gpiod.Line.DIRECTION_OUTPUT) - self.assertEqual(line.active_state(), gpiod.Line.ACTIVE_HIGH) + self.assertFalse(line.is_active_low()) self.assertEqual(line.consumer(), default_consumer) self.assertTrue(line.is_used()) self.assertTrue(line.is_requested())
@@ -271,7 +271,7 @@ class LineInfo(MockupTestCase): self.assertEqual(line.offset(), 4) self.assertEqual(line.name(), 'gpio-mockup-A-4') self.assertEqual(line.direction(), gpiod.Line.DIRECTION_OUTPUT) - self.assertEqual(line.active_state(), gpiod.Line.ACTIVE_HIGH) + self.assertFalse(line.is_active_low()) self.assertEqual(line.consumer(), default_consumer) self.assertTrue(line.is_used()) self.assertTrue(line.is_requested())
@@ -289,7 +289,7 @@ class LineInfo(MockupTestCase): self.assertEqual(line.offset(), 4) self.assertEqual(line.name(), 'gpio-mockup-A-4') self.assertEqual(line.direction(), gpiod.Line.DIRECTION_OUTPUT) - self.assertEqual(line.active_state(), gpiod.Line.ACTIVE_HIGH) + self.assertFalse(line.is_active_low()) self.assertEqual(line.consumer(), default_consumer) self.assertTrue(line.is_used()) self.assertTrue(line.is_requested())
@@ -307,7 +307,7 @@ class LineInfo(MockupTestCase): self.assertEqual(line.offset(), 4) self.assertEqual(line.name(), 'gpio-mockup-A-4') self.assertEqual(line.direction(), gpiod.Line.DIRECTION_OUTPUT) - self.assertEqual(line.active_state(), gpiod.Line.ACTIVE_HIGH) + self.assertFalse(line.is_active_low()) self.assertEqual(line.consumer(), default_consumer) self.assertTrue(line.is_used()) self.assertTrue(line.is_requested())
@@ -325,7 +325,7 @@ class LineInfo(MockupTestCase): self.assertEqual(line.offset(), 4) self.assertEqual(line.name(), 'gpio-mockup-A-4') self.assertEqual(line.direction(), gpiod.Line.DIRECTION_OUTPUT) - self.assertEqual(line.active_state(), gpiod.Line.ACTIVE_HIGH) + self.assertFalse(line.is_active_low()) self.assertEqual(line.consumer(), default_consumer) self.assertTrue(line.is_used()) self.assertTrue(line.is_requested())
include/gpiod.h +3 -13
@@ -280,16 +280,6 @@ enum {/**< Direction is output - we're driving the GPIO line. */ }; -/** -* @brief Possible active state settings. -*/ -enum { -GPIOD_LINE_ACTIVE_STATE_HIGH =1 , -/**< The active state of a GPIO is active-high. */ -GPIOD_LINE_ACTIVE_STATE_LOW , -/**< The active state of a GPIO is active-low. */ -}; -/** * @brief Possible internal bias settings. */
@@ -337,11 +327,11 @@ const char *gpiod_line_consumer(struct gpiod_line *line) GPIOD_API; int gpiod_line_direction(struct gpiod_line *line) GPIOD_API;/** -* @brief Read the GPIO line active state setting. +* @brief Check if the signal of this line is inverted. * @param line GPIO line object. -* @return Returns GPIOD_LINE_ACTIVE_STATE_HIGH or GPIOD_LINE_ACTIVE_STATE_LOW. +* @return True if this line is "active-low", false otherwise. */ -int gpiod_line_active_state(struct gpiod_line *line) GPIOD_API; +bool gpiod_line_is_active_low(struct gpiod_line *line) GPIOD_API;/** * @brief Read the GPIO line bias setting.
lib/core.c +5 -7
@@ -41,8 +41,8 @@ struct gpiod_line {/* The direction of the GPIO line. */ int direction; -/* The active-state configuration. */ -int active_state; +/* Is this line active-low?. */ +bool active_low;/* The logical value last written to the line. */ int output_value;
@@ -471,9 +471,9 @@ int gpiod_line_direction(struct gpiod_line *line)return line->direction; } -int gpiod_line_active_state (struct gpiod_line *line) +bool gpiod_line_is_active_low (struct gpiod_line *line) { -return line->active_state; +return line->active_low; }int gpiod_line_bias (struct gpiod_line *line)
@@ -541,9 +541,7 @@ int gpiod_line_update(struct gpiod_line *line) ? GPIOD_LINE_DIRECTION_OUTPUT :GPIOD_LINE_DIRECTION_INPUT ; - line->active_state = info.flags &GPIO_V2_LINE_FLAG_ACTIVE_LOW - ?GPIOD_LINE_ACTIVE_STATE_LOW - :GPIOD_LINE_ACTIVE_STATE_HIGH ; + line->active_low = !!(info.flags &GPIO_V2_LINE_FLAG_ACTIVE_LOW ); line->info_flags =line_info_v2_to_info_flags (&info);
tests/tests-line.c +18 -34
114 lines not on this page · raw message
tools/gpioinfo.c +4 -6
@@ -117,11 +117,11 @@ static PRINTF(3, 4) void prinfo(bool *of,static void list_lines (struct gpiod_chip *chip) { -int direction, active_state; +bool flag_printed, of, active_low;const char *name, *consumer;struct gpiod_line *line;unsigned int i, offset; -bool flag_printed, of; +int direction;printf ("%s - %u lines:\n" ,gpiod_chip_name (chip),gpiod_chip_num_lines (chip));
@@ -134,7 +134,7 @@ static void list_lines(struct gpiod_chip *chip) name =gpiod_line_name (line); consumer =gpiod_line_consumer (line); direction =gpiod_line_direction (line); - active_state =gpiod_line_active_state (line); + active_low =gpiod_line_is_active_low (line); of = false;
@@ -157,9 +157,7 @@ static void list_lines(struct gpiod_chip *chip)prinfo (&of,8 ,"%s " , direction ==GPIOD_LINE_DIRECTION_INPUT ?"input" :"output" );prinfo (&of,13 ,"%s " , - active_state ==GPIOD_LINE_ACTIVE_STATE_LOW - ?"active-low" - :"active-high" ); + active_low ?"active-low" :"active-high" ); flag_printed = false;for (i =0 ; i <ARRAY_SIZE (flags); i++) {
Signature · 1 line
2.29.1
PATCH v2 3/7 treewide: rename BIAS_AS_IS to BIAS_UNKNOWN
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
When inspecting the current bias setting of a GPIO line, the AS_IS name of one of the possible values really means that the kernel uAPI can't determine the bias setting because it didn't set it itself. In this case it's better to change the name to BIAS_UNKNOWN to reflect that.
--- bindings/cxx/gpiod.hpp | 2 +- bindings/cxx/line.cpp | 2 +- bindings/cxx/tests/tests-line.cpp | 8 ++++---- bindings/python/gpiodmodule.c | 10 +++++----- bindings/python/tests/gpiod_py_test.py | 6 +++--- include/gpiod.h | 4 ++-- lib/core.c | 2 +- tests/tests-line.c | 12 ++++++------ 8 files changed, 23 insertions(+), 23 deletions(-)
bindings/cxx/gpiod.hpp +1 -1
@@ -486,7 +486,7 @@ public: * @brief Possible bias settings. */ enum : int { - BIAS_AS_IS = 1, + BIAS_UNKNOWN = 1, /**< Line's bias state is unknown. */ BIAS_DISABLE, /**< Line's internal bias is disabled. */
bindings/cxx/line.cpp +1 -1
@@ -17,7 +17,7 @@ const ::std::map<int, int> bias_mapping = { { GPIOD_LINE_BIAS_PULL_UP, line::BIAS_PULL_UP, }, { GPIOD_LINE_BIAS_PULL_DOWN, line::BIAS_PULL_DOWN, }, { GPIOD_LINE_BIAS_DISABLE, line::BIAS_DISABLE, }, - { GPIOD_LINE_BIAS_AS_IS, line::BIAS_AS_IS, }, + { GPIOD_LINE_BIAS_UNKNOWN, line::BIAS_UNKNOWN, }, }; } /* namespace */
bindings/cxx/tests/tests-line.cpp +4 -4
@@ -35,7 +35,7 @@ TEST_CASE("Line information can be correctly retrieved", "[line]") REQUIRE_FALSE(line.is_used()); REQUIRE_FALSE(line.is_open_drain()); REQUIRE_FALSE(line.is_open_source()); - REQUIRE(line.bias() == ::gpiod::line::BIAS_AS_IS); + REQUIRE(line.bias() == ::gpiod::line::BIAS_UNKNOWN); } SECTION("exported line")
@@ -54,7 +54,7 @@ TEST_CASE("Line information can be correctly retrieved", "[line]") REQUIRE(line.is_used()); REQUIRE_FALSE(line.is_open_drain()); REQUIRE_FALSE(line.is_open_source()); - REQUIRE(line.bias() == ::gpiod::line::BIAS_AS_IS); + REQUIRE(line.bias() == ::gpiod::line::BIAS_UNKNOWN); } SECTION("exported line with flags")
@@ -75,7 +75,7 @@ TEST_CASE("Line information can be correctly retrieved", "[line]") REQUIRE(line.is_used()); REQUIRE(line.is_open_drain()); REQUIRE_FALSE(line.is_open_source()); - REQUIRE(line.bias() == ::gpiod::line::BIAS_AS_IS); + REQUIRE(line.bias() == ::gpiod::line::BIAS_UNKNOWN); } SECTION("exported open source line")
@@ -95,7 +95,7 @@ TEST_CASE("Line information can be correctly retrieved", "[line]") REQUIRE(line.is_used()); REQUIRE_FALSE(line.is_open_drain()); REQUIRE(line.is_open_source()); - REQUIRE(line.bias() == ::gpiod::line::BIAS_AS_IS); + REQUIRE(line.bias() == ::gpiod::line::BIAS_UNKNOWN); } SECTION("exported bias disable line")
bindings/python/gpiodmodule.c +5 -5
@@ -68,7 +68,7 @@ enum { };enum { - gpiod_BIAS_AS_IS =1 , + gpiod_BIAS_UNKNOWN =1 , gpiod_BIAS_DISABLE, gpiod_BIAS_PULL_UP, gpiod_BIAS_PULL_DOWN,
@@ -374,9 +374,9 @@ static PyObject *gpiod_Line_bias(gpiod_LineObject *self,return Py_BuildValue ("I" , gpiod_BIAS_PULL_DOWN);case GPIOD_LINE_BIAS_DISABLE :return Py_BuildValue ("I" , gpiod_BIAS_DISABLE); -case GPIOD_LINE_BIAS_AS_IS : +case GPIOD_LINE_BIAS_UNKNOWN :default : -return Py_BuildValue ("I" , gpiod_BIAS_AS_IS); +return Py_BuildValue ("I" , gpiod_BIAS_UNKNOWN); } }
@@ -2527,8 +2527,8 @@ static gpiod_ConstDescr gpiod_ConstList[] = { }, { .typeobj = &gpiod_LineType, - .name = "BIAS_AS_IS", - .val = gpiod_BIAS_AS_IS, + .name = "BIAS_UNKNOWN", + .val = gpiod_BIAS_UNKNOWN, }, { .typeobj = &gpiod_LineType,
bindings/python/tests/gpiod_py_test.py +3 -3
@@ -241,7 +241,7 @@ class LineInfo(MockupTestCase): self.assertTrue(line.is_requested()) self.assertTrue(line.is_open_drain()) self.assertFalse(line.is_open_source()) - self.assertEqual(line.bias(), gpiod.Line.BIAS_AS_IS) + self.assertEqual(line.bias(), gpiod.Line.BIAS_UNKNOWN) def test_exported_open_drain_line(self): with gpiod.Chip(mockup.chip_path(0)) as chip:
@@ -259,7 +259,7 @@ class LineInfo(MockupTestCase): self.assertTrue(line.is_requested()) self.assertTrue(line.is_open_drain()) self.assertFalse(line.is_open_source()) - self.assertEqual(line.bias(), gpiod.Line.BIAS_AS_IS) + self.assertEqual(line.bias(), gpiod.Line.BIAS_UNKNOWN) def test_exported_open_source_line(self): with gpiod.Chip(mockup.chip_path(0)) as chip:
@@ -277,7 +277,7 @@ class LineInfo(MockupTestCase): self.assertTrue(line.is_requested()) self.assertFalse(line.is_open_drain()) self.assertTrue(line.is_open_source()) - self.assertEqual(line.bias(), gpiod.Line.BIAS_AS_IS) + self.assertEqual(line.bias(), gpiod.Line.BIAS_UNKNOWN) def test_exported_bias_disable_line(self): with gpiod.Chip(mockup.chip_path(0)) as chip:
include/gpiod.h +2 -2
@@ -284,7 +284,7 @@ enum {* @brief Possible internal bias settings. */ enum { -GPIOD_LINE_BIAS_AS_IS =1 , +GPIOD_LINE_BIAS_UNKNOWN =1 ,/**< The internal bias state is unknown. */ GPIOD_LINE_BIAS_DISABLE ,/**< The internal bias is disabled. */
@@ -337,7 +337,7 @@ bool gpiod_line_is_active_low(struct gpiod_line *line) GPIOD_API;* @brief Read the GPIO line bias setting. * @param line GPIO line object. * @return Returns GPIOD_LINE_BIAS_PULL_UP, GPIOD_LINE_BIAS_PULL_DOWN, -* GPIOD_LINE_BIAS_DISABLE or GPIOD_LINE_BIAS_AS_IS. +* GPIOD_LINE_BIAS_DISABLE or GPIOD_LINE_BIAS_UNKNOWN. */ int gpiod_line_bias(struct gpiod_line *line) GPIOD_API;
lib/core.c +1 -1
@@ -485,7 +485,7 @@ int gpiod_line_bias(struct gpiod_line *line)if (line->info_flags &GPIOLINE_FLAG_BIAS_PULL_DOWN )return GPIOD_LINE_BIAS_PULL_DOWN ; -return GPIOD_LINE_BIAS_AS_IS ; +return GPIOD_LINE_BIAS_UNKNOWN ; }bool gpiod_line_is_used (struct gpiod_line *line)
tests/tests-line.c +6 -6
@@ -418,7 +418,7 @@ GPIOD_TEST_CASE(set_flags_bias, 0, { 8 }) ret =gpiod_line_request_input (line,GPIOD_TEST_CONSUMER ); g_assert_cmpint(ret, ==, 0);gpiod_test_return_if_failed (); - g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_AS_IS); + g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_UNKNOWN); ret =gpiod_line_set_flags (line,GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLE );
@@ -762,7 +762,7 @@ GPIOD_TEST_CASE(misc_flags, 0, { 8 })g_assert_false (gpiod_line_is_used (line));g_assert_false (gpiod_line_is_open_drain (line));g_assert_false (gpiod_line_is_open_source (line)); - g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_AS_IS); + g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_UNKNOWN); config.request_type =GPIOD_LINE_REQUEST_DIRECTION_OUTPUT ; config.consumer =GPIOD_TEST_CONSUMER ;
@@ -775,7 +775,7 @@ GPIOD_TEST_CASE(misc_flags, 0, { 8 })g_assert_true (gpiod_line_is_used (line));g_assert_true (gpiod_line_is_open_drain (line));g_assert_false (gpiod_line_is_open_source (line)); - g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_AS_IS); + g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_UNKNOWN); g_assert_cmpint(gpiod_line_direction(line), ==,GPIOD_LINE_DIRECTION_OUTPUT );
@@ -790,7 +790,7 @@ GPIOD_TEST_CASE(misc_flags, 0, { 8 })g_assert_true (gpiod_line_is_used (line));g_assert_false (gpiod_line_is_open_drain (line));g_assert_true (gpiod_line_is_open_source (line)); - g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_AS_IS); + g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_UNKNOWN); g_assert_cmpint(gpiod_line_direction(line), ==,GPIOD_LINE_DIRECTION_OUTPUT );
@@ -829,7 +829,7 @@ GPIOD_TEST_CASE(misc_flags_work_together, 0, { 8 })g_assert_true (gpiod_line_is_used (line));g_assert_true (gpiod_line_is_open_drain (line));g_assert_false (gpiod_line_is_open_source (line)); - g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_AS_IS); + g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_UNKNOWN);g_assert_true (gpiod_line_is_active_low (line)); g_assert_cmpint(gpiod_line_direction(line), ==,GPIOD_LINE_DIRECTION_OUTPUT );
@@ -846,7 +846,7 @@ GPIOD_TEST_CASE(misc_flags_work_together, 0, { 8 })g_assert_true (gpiod_line_is_used (line));g_assert_false (gpiod_line_is_open_drain (line));g_assert_true (gpiod_line_is_open_source (line)); - g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_AS_IS); + g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_UNKNOWN);g_assert_true (gpiod_line_is_active_low (line));gpiod_line_release (line);
Signature · 1 line
2.29.1
Re: [libgpiod][PATCH v2 3/7] treewide: rename BIAS_AS_IS to BIAS_UNKNOWN
Quoted 7 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
When inspecting the current bias setting of a GPIO line, the
AS_ISname of one of the possible values really means that the kernel uAPI can't determine the bias setting because it didn't set it itself. In this case it's better to change the name toBIAS_UNKNOWNto reflect that.
Your checkin comment incorporates some of my review comments, which were actually a bit sloppy. While I didn't bother to correct myself for that email, I'd rather the checkin comment be more precise.
Specifically, I was conflating gpiolib and the cdev uAPI. If the bias is set via gpiolib then the uAPI will report it correctly. If it is set otherwise then the setting is unknown to gpiolib and therefore the uAPI.
And I'm not sure if the DT example that I used in that email was a good one. But say the hardware initialises with pull-up enabled. If it hasn't also been set via gpiolib then it will be reported as unknown.
Cheers,
Kent.
Re: [libgpiod][PATCH v2 3/7] treewide: rename BIAS_AS_IS to BIAS_UNKNOWN
Quoted 14 lines · Kent Gibson
Quoted 7 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
When inspecting the current bias setting of a GPIO line, the
AS_ISname of one of the possible values really means that the kernel uAPI can't determine the bias setting because it didn't set it itself. In this case it's better to change the name toBIAS_UNKNOWNto reflect that.Your checkin comment incorporates some of my review comments, which were actually a bit sloppy. While I didn't bother to correct myself for that email, I'd rather the checkin comment be more precise.
Quoted 8 lines
Specifically, I was conflating gpiolib and the cdev uAPI. If the bias is set via gpiolib then the uAPI will report it correctly. If it is set otherwise then the setting is unknown to gpiolib and therefore the uAPI.
And I'm not sure if the DT example that I used in that email was a good one. But say the hardware initialises with pull-up enabled. If it hasn't also been set via gpiolib then it will be reported as unknown.
Which makes me wonder whether we shouldn't add a get_config() callback to drivers in gpiolib for that because some controllers allow you to query their current settings.
---
When inspecting the current bias setting of a GPIO line, the AS_IS name of one of the possible values really means that the kernel GPIO subsystem can't determine the bias setting because it didn't set it itself (e.g. the hardware may have internally initialized pull-up or pull-down resistors). In this case it's better to change the name to BIAS_UNKNOWN to reflect that.
---
Does this sound good?
Bartosz
Re: [libgpiod][PATCH v2 3/7] treewide: rename BIAS_AS_IS to BIAS_UNKNOWN
Quoted 19 lines · Bartosz Golaszewski
Quoted 18 lines · Kent Gibson
Quoted 7 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
When inspecting the current bias setting of a GPIO line, the
AS_ISname of one of the possible values really means that the kernel uAPI can't determine the bias setting because it didn't set it itself. In this case it's better to change the name toBIAS_UNKNOWNto reflect that.Your checkin comment incorporates some of my review comments, which were actually a bit sloppy. While I didn't bother to correct myself for that email, I'd rather the checkin comment be more precise.
Specifically, I was conflating gpiolib and the cdev uAPI. If the bias is set via gpiolib then the uAPI will report it correctly. If it is set otherwise then the setting is unknown to gpiolib and therefore the uAPI.
Quoted 9 lines
Quoted 4 lines
And I'm not sure if the DT example that I used in that email was a good one. But say the hardware initialises with pull-up enabled. If it hasn't also been set via gpiolib then it will be reported as unknown.
Which makes me wonder whether we shouldn't add a
get_config()callback to drivers in gpiolib for that because some controllers allow you to query their current settings.
I've thought the same, but until all the pinctrl drivers support it you are still going to be returning unknown. So you still can't provide any guarantee that the information is available. And as such is it any more use than just requiring the user set it explicitly? And if they really care about the bias they will probably set it anyway.
Quoted 10 lines
---
When inspecting the current bias setting of a GPIO line, theAS_ISname of one of the possible values really means that the kernel GPIO subsystem can't determine the bias setting because it didn't set it itself (e.g. the hardware may have internally initialized pull-up or pull-down resistors). In this case it's better to change the name toBIAS_UNKNOWNto reflect that.
---Does this sound good?
That works for me.
Cheers,
Kent.
PATCH v2 4/7 treewide: rename BIAS_DISABLE to BIAS_DISABLED
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
When we're reading the current bias setting of a line, it is already disabled so the flag should be named as such. While BIAS_DISABLE would technically be fine when modifying the setting, let's rename it to BIAS_DISABLED too for consistency.
--- bindings/cxx/gpiod.hpp | 4 ++-- bindings/cxx/line.cpp | 2 +- bindings/cxx/line_bulk.cpp | 4 ++-- bindings/cxx/tests/tests-line.cpp | 4 ++-- bindings/python/gpiodmodule.c | 20 ++++++++++---------- bindings/python/tests/gpiod_py_test.py | 4 ++-- include/gpiod.h | 4 ++-- lib/core.c | 6 +++--- tests/tests-event.c | 2 +- tests/tests-line.c | 10 +++++----- tools/gpioinfo.c | 2 +- tools/tools-common.c | 2 +- 12 files changed, 32 insertions(+), 32 deletions(-)
bindings/cxx/gpiod.hpp +2 -2
@@ -225,7 +225,7 @@ struct line_request /**< The line is an open-source port. */ GPIOD_API static const ::std::bitset<32> FLAG_OPEN_DRAIN; /**< The line is an open-drain port. */ - GPIOD_API static const ::std::bitset<32> FLAG_BIAS_DISABLE; + GPIOD_API static const ::std::bitset<32> FLAG_BIAS_DISABLED; /**< The line has neither pull-up nor pull-down resistor enabled. */ GPIOD_API static const ::std::bitset<32> FLAG_BIAS_PULL_DOWN; /**< The line has a configurable pull-down resistor enabled. */
@@ -488,7 +488,7 @@ public: enum : int { BIAS_UNKNOWN = 1, /**< Line's bias state is unknown. */ - BIAS_DISABLE, + BIAS_DISABLED, /**< Line's internal bias is disabled. */ BIAS_PULL_UP, /**< Line's internal pull-up bias is enabled. */
bindings/cxx/line.cpp +1 -1
@@ -16,7 +16,7 @@ namespace { const ::std::map<int, int> bias_mapping = { { GPIOD_LINE_BIAS_PULL_UP, line::BIAS_PULL_UP, }, { GPIOD_LINE_BIAS_PULL_DOWN, line::BIAS_PULL_DOWN, }, - { GPIOD_LINE_BIAS_DISABLE, line::BIAS_DISABLE, }, + { GPIOD_LINE_BIAS_DISABLED, line::BIAS_DISABLED, }, { GPIOD_LINE_BIAS_UNKNOWN, line::BIAS_UNKNOWN, }, };
bindings/cxx/line_bulk.cpp +2 -2
@@ -14,7 +14,7 @@ namespace gpiod { const ::std::bitset<32> line_request::FLAG_ACTIVE_LOW(GPIOD_BIT(0)); const ::std::bitset<32> line_request::FLAG_OPEN_SOURCE(GPIOD_BIT(1)); const ::std::bitset<32> line_request::FLAG_OPEN_DRAIN(GPIOD_BIT(2)); -const ::std::bitset<32> line_request::FLAG_BIAS_DISABLE(GPIOD_BIT(3)); +const ::std::bitset<32> line_request::FLAG_BIAS_DISABLED(GPIOD_BIT(3)); const ::std::bitset<32> line_request::FLAG_BIAS_PULL_DOWN(GPIOD_BIT(4)); const ::std::bitset<32> line_request::FLAG_BIAS_PULL_UP(GPIOD_BIT(5));
@@ -41,7 +41,7 @@ const ::std::map<::std::bitset<32>, int, bitset_cmp> reqflag_mapping = { { line_request::FLAG_ACTIVE_LOW, GPIOD_LINE_REQUEST_FLAG_ACTIVE_LOW, }, { line_request::FLAG_OPEN_DRAIN, GPIOD_LINE_REQUEST_FLAG_OPEN_DRAIN, }, { line_request::FLAG_OPEN_SOURCE, GPIOD_LINE_REQUEST_FLAG_OPEN_SOURCE, }, - { line_request::FLAG_BIAS_DISABLE, GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLE, }, + { line_request::FLAG_BIAS_DISABLED, GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLED, }, { line_request::FLAG_BIAS_PULL_DOWN, GPIOD_LINE_REQUEST_FLAG_BIAS_PULL_DOWN, }, { line_request::FLAG_BIAS_PULL_UP, GPIOD_LINE_REQUEST_FLAG_BIAS_PULL_UP, }, };
bindings/cxx/tests/tests-line.cpp +2 -2
@@ -104,7 +104,7 @@ TEST_CASE("Line information can be correctly retrieved", "[line]") config.consumer = consumer.c_str(); config.request_type = ::gpiod::line_request::DIRECTION_OUTPUT; - config.flags = ::gpiod::line_request::FLAG_BIAS_DISABLE; + config.flags = ::gpiod::line_request::FLAG_BIAS_DISABLED; line.request(config); REQUIRE(line.offset() == 4);
@@ -115,7 +115,7 @@ TEST_CASE("Line information can be correctly retrieved", "[line]") REQUIRE(line.is_used()); REQUIRE_FALSE(line.is_open_drain()); REQUIRE_FALSE(line.is_open_source()); - REQUIRE(line.bias() == ::gpiod::line::BIAS_DISABLE); + REQUIRE(line.bias() == ::gpiod::line::BIAS_DISABLED); } SECTION("exported pull-down line")
bindings/python/gpiodmodule.c +10 -10
@@ -57,7 +57,7 @@ enum { gpiod_LINE_REQ_FLAG_OPEN_DRAIN =GPIOD_BIT (0 ), gpiod_LINE_REQ_FLAG_OPEN_SOURCE =GPIOD_BIT (1 ), gpiod_LINE_REQ_FLAG_ACTIVE_LOW =GPIOD_BIT (2 ), - gpiod_LINE_REQ_FLAG_BIAS_DISABLE =GPIOD_BIT (3 ), + gpiod_LINE_REQ_FLAG_BIAS_DISABLED =GPIOD_BIT (3 ), gpiod_LINE_REQ_FLAG_BIAS_PULL_DOWN =GPIOD_BIT (4 ), gpiod_LINE_REQ_FLAG_BIAS_PULL_UP = GPIOD_BIT(5), };
@@ -69,7 +69,7 @@ enum {enum { gpiod_BIAS_UNKNOWN =1 , - gpiod_BIAS_DISABLE, + gpiod_BIAS_DISABLED, gpiod_BIAS_PULL_UP, gpiod_BIAS_PULL_DOWN, };
@@ -372,8 +372,8 @@ static PyObject *gpiod_Line_bias(gpiod_LineObject *self,return Py_BuildValue ("I" , gpiod_BIAS_PULL_UP);case GPIOD_LINE_BIAS_PULL_DOWN :return Py_BuildValue ("I" , gpiod_BIAS_PULL_DOWN); -case GPIOD_LINE_BIAS_DISABLE : -return Py_BuildValue ("I" , gpiod_BIAS_DISABLE); +case GPIOD_LINE_BIAS_DISABLED : +return Py_BuildValue ("I" , gpiod_BIAS_DISABLED);case GPIOD_LINE_BIAS_UNKNOWN :default :return Py_BuildValue ("I" , gpiod_BIAS_UNKNOWN);
@@ -1286,8 +1286,8 @@ static void gpiod_MakeRequestConfig(struct gpiod_line_request_config *conf, conf->flags |=GPIOD_LINE_REQUEST_FLAG_OPEN_SOURCE ;if (flags & gpiod_LINE_REQ_FLAG_ACTIVE_LOW) conf->flags |=GPIOD_LINE_REQUEST_FLAG_ACTIVE_LOW ; -if (flags & gpiod_LINE_REQ_FLAG_BIAS_DISABLE) - conf->flags |=GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLE ; +if (flags & gpiod_LINE_REQ_FLAG_BIAS_DISABLED) + conf->flags |=GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLED ;if (flags & gpiod_LINE_REQ_FLAG_BIAS_PULL_DOWN) conf->flags |=GPIOD_LINE_REQUEST_FLAG_BIAS_PULL_DOWN ;if (flags & gpiod_LINE_REQ_FLAG_BIAS_PULL_UP)
@@ -2532,8 +2532,8 @@ static gpiod_ConstDescr gpiod_ConstList[] = { }, { .typeobj = &gpiod_LineType, - .name = "BIAS_DISABLE", - .val = gpiod_BIAS_DISABLE, + .name = "BIAS_DISABLED", + .val = gpiod_BIAS_DISABLED, }, { .typeobj = &gpiod_LineType,
@@ -2649,8 +2649,8 @@ static gpiod_ModuleConst gpiod_ModuleConsts[] = { .value = gpiod_LINE_REQ_FLAG_ACTIVE_LOW, }, { - .name = "LINE_REQ_FLAG_BIAS_DISABLE", - .value = gpiod_LINE_REQ_FLAG_BIAS_DISABLE, + .name = "LINE_REQ_FLAG_BIAS_DISABLED", + .value = gpiod_LINE_REQ_FLAG_BIAS_DISABLED, }, { .name = "LINE_REQ_FLAG_BIAS_PULL_DOWN",
bindings/python/tests/gpiod_py_test.py +2 -2
@@ -282,7 +282,7 @@ class LineInfo(MockupTestCase): def test_exported_bias_disable_line(self): with gpiod.Chip(mockup.chip_path(0)) as chip: line = chip.get_line(4) - flags = gpiod.LINE_REQ_FLAG_BIAS_DISABLE + flags = gpiod.LINE_REQ_FLAG_BIAS_DISABLED line.request(consumer=default_consumer, type=gpiod.LINE_REQ_DIR_OUT, flags=flags)
@@ -295,7 +295,7 @@ class LineInfo(MockupTestCase): self.assertTrue(line.is_requested()) self.assertFalse(line.is_open_drain()) self.assertFalse(line.is_open_source()) - self.assertEqual(line.bias(), gpiod.Line.BIAS_DISABLE) + self.assertEqual(line.bias(), gpiod.Line.BIAS_DISABLED) def test_exported_bias_pull_down_line(self): with gpiod.Chip(mockup.chip_path(0)) as chip:
include/gpiod.h +2 -2
@@ -286,7 +286,7 @@ enum {enum {GPIOD_LINE_BIAS_UNKNOWN =1 ,/**< The internal bias state is unknown. */ -GPIOD_LINE_BIAS_DISABLE , +GPIOD_LINE_BIAS_DISABLED ,/**< The internal bias is disabled. */ GPIOD_LINE_BIAS_PULL_UP ,/**< The internal pull-up bias is enabled. */
@@ -433,7 +433,7 @@ enum {/**< The line is an open-source port. */ GPIOD_LINE_REQUEST_FLAG_ACTIVE_LOW =GPIOD_BIT (2 ),/**< The active state of the line is low (high is the default). */ -GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLE =GPIOD_BIT (3 ), +GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLED =GPIOD_BIT (3 ),/**< The line has neither either pull-up nor pull-down resistor. */ GPIOD_LINE_REQUEST_FLAG_BIAS_PULL_DOWN = GPIOD_BIT(4),/**< The line has pull-down resistor enabled. */
lib/core.c +3 -3
@@ -479,7 +479,7 @@ bool gpiod_line_is_active_low(struct gpiod_line *line)int gpiod_line_bias (struct gpiod_line *line) {if (line->info_flags &GPIOLINE_FLAG_BIAS_DISABLE ) -return GPIOD_LINE_BIAS_DISABLE ; +return GPIOD_LINE_BIAS_DISABLED ;if (line->info_flags &GPIOLINE_FLAG_BIAS_PULL_UP )return GPIOD_LINE_BIAS_PULL_UP ;if (line->info_flags &GPIOLINE_FLAG_BIAS_PULL_DOWN )
@@ -639,7 +639,7 @@ static void line_request_flag_to_gpio_v2_line_config(int flags,else if (flags &GPIOD_LINE_REQUEST_FLAG_OPEN_SOURCE ) config->flags |=GPIO_V2_LINE_FLAG_OPEN_SOURCE ; -if (flags &GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLE ) +if (flags &GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLED ) config->flags |=GPIO_V2_LINE_FLAG_BIAS_DISABLED ;else if (flags &GPIOD_LINE_REQUEST_FLAG_BIAS_PULL_DOWN ) config->flags |=GPIO_V2_LINE_FLAG_BIAS_PULL_DOWN ;
@@ -671,7 +671,7 @@ static bool line_request_config_validate(return false; } -if (config->flags &GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLE ) +if (config->flags &GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLED ) bias_flags++;if (config->flags &GPIOD_LINE_REQUEST_FLAG_BIAS_PULL_UP ) bias_flags++;
tests/tests-event.c +1 -1
@@ -219,7 +219,7 @@ GPIOD_TEST_CASE(both_edges_bias_disable, 0, { 8 })gpiod_test_return_if_failed (); ret =gpiod_line_request_both_edges_events_flags (line, -GPIOD_TEST_CONSUMER ,GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLE ); +GPIOD_TEST_CONSUMER ,GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLED ); g_assert_cmpint(ret, ==, 0);gpiod_test_return_if_failed ();
tests/tests-line.c +5 -5
@@ -421,9 +421,9 @@ GPIOD_TEST_CASE(set_flags_bias, 0, { 8 }) g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_UNKNOWN); ret =gpiod_line_set_flags (line, -GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLE ); +GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLED ); g_assert_cmpint(ret, ==, 0); - g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_DISABLE); + g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_DISABLED); ret =gpiod_line_set_flags (line,GPIOD_LINE_REQUEST_FLAG_BIAS_PULL_UP );
@@ -959,13 +959,13 @@ GPIOD_TEST_CASE(multiple_bias_flags, 0, { 8 })gpiod_test_return_if_failed (); ret =gpiod_line_request_input_flags (line,GPIOD_TEST_CONSUMER , -GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLE | +GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLED |GPIOD_LINE_REQUEST_FLAG_BIAS_PULL_DOWN ); g_assert_cmpint(ret, ==, -1); g_assert_cmpint(errno, ==, EINVAL); ret =gpiod_line_request_input_flags (line,GPIOD_TEST_CONSUMER , -GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLE | +GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLED |GPIOD_LINE_REQUEST_FLAG_BIAS_PULL_UP ); g_assert_cmpint(ret, ==, -1); g_assert_cmpint(errno, ==, EINVAL);
@@ -977,7 +977,7 @@ GPIOD_TEST_CASE(multiple_bias_flags, 0, { 8 }) g_assert_cmpint(errno, ==, EINVAL); ret =gpiod_line_request_input_flags (line,GPIOD_TEST_CONSUMER , -GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLE | +GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLED |GPIOD_LINE_REQUEST_FLAG_BIAS_PULL_DOWN |GPIOD_LINE_REQUEST_FLAG_BIAS_PULL_UP ); g_assert_cmpint(ret, ==, -1);
tools/gpioinfo.c +1 -1
@@ -34,7 +34,7 @@ static bool line_bias_is_pulldown(struct gpiod_line *line)static bool line_bias_is_disabled (struct gpiod_line *line) { -return gpiod_line_bias (line) ==GPIOD_LINE_BIAS_DISABLE ; +return gpiod_line_bias (line) ==GPIOD_LINE_BIAS_DISABLED ; }static const struct flag flags[] = {
tools/tools-common.c +1 -1
@@ -68,7 +68,7 @@ int bias_flags(const char *option)if (strcmp (option,"pull-up" ) ==0 )return GPIOD_LINE_REQUEST_FLAG_BIAS_PULL_UP ;if (strcmp (option,"disable" ) ==0 ) -return GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLE ; +return GPIOD_LINE_REQUEST_FLAG_BIAS_DISABLED ;if (strcmp (option,"as-is" ) !=0 )die ("invalid bias: %s" , option);return 0 ;
Signature · 1 line
2.29.1
PATCH v2 5/7 treewide: make drive settings an enum
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
Open-source and open-drain drive settings are mutually exclusive just like the bias settings. Make them into an enum so that becomes clear.
--- bindings/cxx/gpiod.hpp | 24 +++++---- bindings/cxx/line.cpp | 18 +++---- bindings/cxx/tests/tests-line.cpp | 45 ++++++---------- bindings/python/gpiodmodule.c | 73 ++++++++++++++------------ bindings/python/tests/gpiod_py_test.py | 18 +++---- include/gpiod.h | 26 +++++---- lib/core.c | 12 ++--- tests/tests-line.c | 36 ++++++------- tools/gpioinfo.c | 14 ++++- 9 files changed, 134 insertions(+), 132 deletions(-)
bindings/cxx/gpiod.hpp +15 -9
@@ -332,16 +332,10 @@ public: GPIOD_API bool is_used(void) const; /** - * @brief Check if this line represents an open-drain GPIO. - * @return True if the line is an open-drain GPIO, false otherwise. + * @brief Get current drive setting of this line. + * @return Current drive setting. */ - GPIOD_API bool is_open_drain(void) const; - - /** - * @brief Check if this line represents an open-source GPIO. - * @return True if the line is an open-source GPIO, false otherwise. - */ - GPIOD_API bool is_open_source(void) const; + GPIOD_API int drive(void) const; /** * @brief Request this line.
@@ -482,6 +476,18 @@ public: /**< Line's direction setting is output. */ }; + /** + * @brief Possible drive settings. + */ + enum : int { + DRIVE_PUSH_PULL = 1, + /**< Drive setting is unknown. */ + DRIVE_OPEN_DRAIN, + /**< Line output is open-drain. */ + DRIVE_OPEN_SOURCE, + /**< Line output is open-source. */ + }; + /** * @brief Possible bias settings. */
bindings/cxx/line.cpp +8 -10
@@ -13,6 +13,12 @@ namespace gpiod { namespace { +const ::std::map<int, int> drive_mapping = { + { GPIOD_LINE_DRIVE_PUSH_PULL, line::DRIVE_PUSH_PULL, }, + { GPIOD_LINE_DRIVE_OPEN_DRAIN, line::DRIVE_OPEN_DRAIN, }, + { GPIOD_LINE_DRIVE_OPEN_SOURCE, line::DRIVE_OPEN_SOURCE, }, +}; + const ::std::map<int, int> bias_mapping = { { GPIOD_LINE_BIAS_PULL_UP, line::BIAS_PULL_UP, }, { GPIOD_LINE_BIAS_PULL_DOWN, line::BIAS_PULL_DOWN, },
@@ -98,20 +104,12 @@ bool line::is_used(void) const return ::gpiod_line_is_used(this->_m_line); } -bool line::is_open_drain(void) const -{ - this->throw_if_null(); - line::chip_guard lock_chip(*this); - - return ::gpiod_line_is_open_drain(this->_m_line); -} - -bool line::is_open_source(void) const +int line::drive(void) const { this->throw_if_null(); line::chip_guard lock_chip(*this); - return ::gpiod_line_is_open_source(this->_m_line); + return drive_mapping.at(::gpiod_line_drive(this->_m_line)); } void line::request(const line_request& config, int default_val) const
bindings/cxx/tests/tests-line.cpp +15 -30
117 lines not on this page · raw message
bindings/python/gpiodmodule.c +40 -33
106 lines not on this page · raw message
bindings/python/tests/gpiod_py_test.py +6 -12
@@ -239,8 +239,7 @@ class LineInfo(MockupTestCase): self.assertEqual(line.consumer(), default_consumer) self.assertTrue(line.is_used()) self.assertTrue(line.is_requested()) - self.assertTrue(line.is_open_drain()) - self.assertFalse(line.is_open_source()) + self.assertEqual(line.drive(), gpiod.Line.DRIVE_OPEN_DRAIN) self.assertEqual(line.bias(), gpiod.Line.BIAS_UNKNOWN) def test_exported_open_drain_line(self):
@@ -257,8 +256,7 @@ class LineInfo(MockupTestCase): self.assertEqual(line.consumer(), default_consumer) self.assertTrue(line.is_used()) self.assertTrue(line.is_requested()) - self.assertTrue(line.is_open_drain()) - self.assertFalse(line.is_open_source()) + self.assertEqual(line.drive(), gpiod.Line.DRIVE_OPEN_DRAIN) self.assertEqual(line.bias(), gpiod.Line.BIAS_UNKNOWN) def test_exported_open_source_line(self):
@@ -275,8 +273,7 @@ class LineInfo(MockupTestCase): self.assertEqual(line.consumer(), default_consumer) self.assertTrue(line.is_used()) self.assertTrue(line.is_requested()) - self.assertFalse(line.is_open_drain()) - self.assertTrue(line.is_open_source()) + self.assertEqual(line.drive(), gpiod.Line.DRIVE_OPEN_SOURCE) self.assertEqual(line.bias(), gpiod.Line.BIAS_UNKNOWN) def test_exported_bias_disable_line(self):
@@ -293,8 +290,7 @@ class LineInfo(MockupTestCase): self.assertEqual(line.consumer(), default_consumer) self.assertTrue(line.is_used()) self.assertTrue(line.is_requested()) - self.assertFalse(line.is_open_drain()) - self.assertFalse(line.is_open_source()) + self.assertEqual(line.drive(), gpiod.Line.DRIVE_PUSH_PULL) self.assertEqual(line.bias(), gpiod.Line.BIAS_DISABLED) def test_exported_bias_pull_down_line(self):
@@ -311,8 +307,7 @@ class LineInfo(MockupTestCase): self.assertEqual(line.consumer(), default_consumer) self.assertTrue(line.is_used()) self.assertTrue(line.is_requested()) - self.assertFalse(line.is_open_drain()) - self.assertFalse(line.is_open_source()) + self.assertEqual(line.drive(), gpiod.Line.DRIVE_PUSH_PULL) self.assertEqual(line.bias(), gpiod.Line.BIAS_PULL_DOWN) def test_exported_bias_pull_up_line(self):
@@ -329,8 +324,7 @@ class LineInfo(MockupTestCase): self.assertEqual(line.consumer(), default_consumer) self.assertTrue(line.is_used()) self.assertTrue(line.is_requested()) - self.assertFalse(line.is_open_drain()) - self.assertFalse(line.is_open_source()) + self.assertEqual(line.drive(), gpiod.Line.DRIVE_PUSH_PULL) self.assertEqual(line.bias(), gpiod.Line.BIAS_PULL_UP) def test_update_line_info(self):
include/gpiod.h +16 -10
@@ -280,6 +280,18 @@ enum {/**< Direction is output - we're driving the GPIO line. */ }; +/** +* @brief Possible drive settings. +*/ +enum { +GPIOD_LINE_DRIVE_PUSH_PULL =1 , +/**< Drive setting is push-pull. */ +GPIOD_LINE_DRIVE_OPEN_DRAIN , +/**< Line output is open-drain. */ +GPIOD_LINE_DRIVE_OPEN_SOURCE , +/**< Line output is open-source. */ +}; +/** * @brief Possible internal bias settings. */
@@ -353,18 +365,12 @@ int gpiod_line_bias(struct gpiod_line *line) GPIOD_API; bool gpiod_line_is_used(struct gpiod_line *line) GPIOD_API;/** -* @brief Check if the line is an open-drain GPIO. -* @param line GPIO line object. -* @return True if the line is an open-drain GPIO, false otherwise. -*/ -bool gpiod_line_is_open_drain(struct gpiod_line *line) GPIOD_API; - -/** -* @brief Check if the line is an open-source GPIO. +* @brief Read the GPIO line drive setting. * @param line GPIO line object. -* @return True if the line is an open-source GPIO, false otherwise. +* @return Returns GPIOD_LINE_DRIVE_PUSH_PULL, GPIOD_LINE_DRIVE_OPEN_DRAIN or +* GPIOD_LINE_DRIVE_OPEN_SOURCE. */ -bool gpiod_line_is_open_source(struct gpiod_line *line) GPIOD_API; +int gpiod_line_drive(struct gpiod_line *line) GPIOD_API;/** * @brief Re-read the line info.
lib/core.c +6 -6
@@ -493,14 +493,14 @@ bool gpiod_line_is_used(struct gpiod_line *line)return line->info_flags &GPIOLINE_FLAG_KERNEL ; } -bool gpiod_line_is_open_drain (struct gpiod_line *line) +int gpiod_line_drive (struct gpiod_line *line) { -return line->info_flags &GPIOLINE_FLAG_OPEN_DRAIN ; -} +if (line->info_flags &GPIOLINE_FLAG_OPEN_DRAIN ) +return GPIOD_LINE_DRIVE_OPEN_DRAIN ; +if (line->info_flags &GPIOLINE_FLAG_OPEN_SOURCE ) +return GPIOD_LINE_DRIVE_OPEN_SOURCE ; -bool gpiod_line_is_open_source (struct gpiod_line *line) -{ -return line->info_flags &GPIOLINE_FLAG_OPEN_SOURCE ; +return GPIOD_LINE_DRIVE_PUSH_PULL ; }static int line_info_v2_to_info_flags (struct gpio_v2_line_info *info)
tests/tests-line.c +16 -20
@@ -455,20 +455,19 @@ GPIOD_TEST_CASE(set_flags_drive, 0, { 8 }) ret =gpiod_line_request_output (line,GPIOD_TEST_CONSUMER ,0 ); g_assert_cmpint(ret, ==, 0);gpiod_test_return_if_failed (); - g_assert_cmpint(gpiod_line_is_open_drain(line), ==, false); - g_assert_cmpint(gpiod_line_is_open_source(line), ==, false); + g_assert_cmpint(gpiod_line_drive(line), ==, GPIOD_LINE_DRIVE_PUSH_PULL); ret =gpiod_line_set_flags (line,GPIOD_LINE_REQUEST_FLAG_OPEN_DRAIN ); g_assert_cmpint(ret, ==, 0); - g_assert_cmpint(gpiod_line_is_open_drain(line), ==, true); - g_assert_cmpint(gpiod_line_is_open_source(line), ==, false); + g_assert_cmpint(gpiod_line_drive(line), ==, +GPIOD_LINE_DRIVE_OPEN_DRAIN ); ret =gpiod_line_set_flags (line,GPIOD_LINE_REQUEST_FLAG_OPEN_SOURCE ); g_assert_cmpint(ret, ==, 0); - g_assert_cmpint(gpiod_line_is_open_drain(line), ==, false); - g_assert_cmpint(gpiod_line_is_open_source(line), ==, true); + g_assert_cmpint(gpiod_line_drive(line), ==, +GPIOD_LINE_DRIVE_OPEN_SOURCE ); } GPIOD_TEST_CASE(set_direction, 0, { 8 })
@@ -760,8 +759,7 @@ GPIOD_TEST_CASE(misc_flags, 0, { 8 })gpiod_test_return_if_failed ();g_assert_false (gpiod_line_is_used (line)); -g_assert_false (gpiod_line_is_open_drain (line)); -g_assert_false (gpiod_line_is_open_source (line)); + g_assert_cmpint(gpiod_line_drive(line), ==, GPIOD_LINE_DRIVE_PUSH_PULL); g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_UNKNOWN); config.request_type =GPIOD_LINE_REQUEST_DIRECTION_OUTPUT ;
@@ -773,8 +771,8 @@ GPIOD_TEST_CASE(misc_flags, 0, { 8 })gpiod_test_return_if_failed ();g_assert_true (gpiod_line_is_used (line)); -g_assert_true (gpiod_line_is_open_drain (line)); -g_assert_false (gpiod_line_is_open_source (line)); + g_assert_cmpint(gpiod_line_drive(line), ==, +GPIOD_LINE_DRIVE_OPEN_DRAIN ); g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_UNKNOWN); g_assert_cmpint(gpiod_line_direction(line), ==,GPIOD_LINE_DIRECTION_OUTPUT );
@@ -788,8 +786,8 @@ GPIOD_TEST_CASE(misc_flags, 0, { 8 })gpiod_test_return_if_failed ();g_assert_true (gpiod_line_is_used (line)); -g_assert_false (gpiod_line_is_open_drain (line)); -g_assert_true (gpiod_line_is_open_source (line)); + g_assert_cmpint(gpiod_line_drive(line), ==, +GPIOD_LINE_DRIVE_OPEN_SOURCE ); g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_UNKNOWN); g_assert_cmpint(gpiod_line_direction(line), ==,GPIOD_LINE_DIRECTION_OUTPUT );
@@ -827,8 +825,8 @@ GPIOD_TEST_CASE(misc_flags_work_together, 0, { 8 })gpiod_test_return_if_failed ();g_assert_true (gpiod_line_is_used (line)); -g_assert_true (gpiod_line_is_open_drain (line)); -g_assert_false (gpiod_line_is_open_source (line)); + g_assert_cmpint(gpiod_line_drive(line), ==, +GPIOD_LINE_DRIVE_OPEN_DRAIN ); g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_UNKNOWN);g_assert_true (gpiod_line_is_active_low (line)); g_assert_cmpint(gpiod_line_direction(line), ==,
@@ -844,8 +842,8 @@ GPIOD_TEST_CASE(misc_flags_work_together, 0, { 8 })gpiod_test_return_if_failed ();g_assert_true (gpiod_line_is_used (line)); -g_assert_false (gpiod_line_is_open_drain (line)); -g_assert_true (gpiod_line_is_open_source (line)); + g_assert_cmpint(gpiod_line_drive(line), ==, +GPIOD_LINE_DRIVE_OPEN_SOURCE ); g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_UNKNOWN);g_assert_true (gpiod_line_is_active_low (line));
@@ -865,8 +863,7 @@ GPIOD_TEST_CASE(misc_flags_work_together, 0, { 8 })gpiod_test_return_if_failed ();g_assert_true (gpiod_line_is_used (line)); -g_assert_false (gpiod_line_is_open_drain (line)); -g_assert_false (gpiod_line_is_open_source (line)); + g_assert_cmpint(gpiod_line_drive(line), ==, GPIOD_LINE_DRIVE_PUSH_PULL); g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_PULL_DOWN);g_assert_true (gpiod_line_is_active_low (line)); g_assert_cmpint(gpiod_line_direction(line), ==,
@@ -885,8 +882,7 @@ GPIOD_TEST_CASE(misc_flags_work_together, 0, { 8 })gpiod_test_return_if_failed ();g_assert_true (gpiod_line_is_used (line)); -g_assert_false (gpiod_line_is_open_drain (line)); -g_assert_false (gpiod_line_is_open_source (line)); + g_assert_cmpint(gpiod_line_drive(line), ==, GPIOD_LINE_DRIVE_PUSH_PULL); g_assert_cmpint(gpiod_line_bias(line), ==, GPIOD_LINE_BIAS_PULL_UP);g_assert_true (gpiod_line_is_active_low (line)); g_assert_cmpint(gpiod_line_direction(line), ==,
tools/gpioinfo.c +12 -2
@@ -37,6 +37,16 @@ static bool line_bias_is_disabled(struct gpiod_line *line)return gpiod_line_bias (line) ==GPIOD_LINE_BIAS_DISABLED ; } +static bool line_drive_is_open_drain (struct gpiod_line *line) +{ +return gpiod_line_drive (line) ==GPIOD_LINE_DRIVE_OPEN_DRAIN ; +} + +static bool line_drive_is_open_source (struct gpiod_line *line) +{ +return gpiod_line_drive (line) ==GPIOD_LINE_DRIVE_OPEN_SOURCE ; +} +static const struct flag flags[] = { { .name ="used" ,
@@ -44,11 +54,11 @@ static const struct flag flags[] = { }, { .name = "open-drain", - .is_set = gpiod_line_is_open_drain, + .is_set = line_drive_is_open_drain, }, { .name = "open-source", - .is_set = gpiod_line_is_open_source, + .is_set = line_drive_is_open_source, }, { .name = "pull-up",
Signature · 1 line
2.29.1
PATCH v2 6/7 bindings: cxx: line: reorder bias mapping entries
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
Reorder the definitions so that they match the order in which they're declared in the class. This is cosmetic only.
--- bindings/cxx/line.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
bindings/cxx/line.cpp +2 -2
@@ -20,10 +20,10 @@ const ::std::map<int, int> drive_mapping = { }; const ::std::map<int, int> bias_mapping = { + { GPIOD_LINE_BIAS_UNKNOWN, line::BIAS_UNKNOWN, }, + { GPIOD_LINE_BIAS_DISABLED, line::BIAS_DISABLED, }, { GPIOD_LINE_BIAS_PULL_UP, line::BIAS_PULL_UP, }, { GPIOD_LINE_BIAS_PULL_DOWN, line::BIAS_PULL_DOWN, }, - { GPIOD_LINE_BIAS_DISABLED, line::BIAS_DISABLED, }, - { GPIOD_LINE_BIAS_UNKNOWN, line::BIAS_UNKNOWN, }, }; } /* namespace */
Signature · 1 line
2.29.1
PATCH v2 7/7 core: add the kernel uapi header to the repository
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
In order to avoid any problems with symbols missing from the host linux kernel headers (for example: if current version of libgpiod supports features that were added recently to the kernel but the host headers are outdated and don't export required symbols) let's add the uapi header to the repository and include it instead of the one in /usr/include/linux.
--- configure.ac | 12 +- lib/Makefile.am | 2 +- lib/core.c | 3 +- lib/uapi/gpio.h | 522 ++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 528 insertions(+), 11 deletions(-) create mode 100644 lib/uapi/gpio.h
configure.ac +3 -9
@@ -93,16 +93,10 @@ AC_CHECK_HEADERS([getopt.h], [], [HEADER_NOT_FOUND_LIB([getopt.h])]) AC_CHECK_HEADERS([dirent.h], [], [HEADER_NOT_FOUND_LIB([dirent.h])]) AC_CHECK_HEADERS([sys/poll.h], [], [HEADER_NOT_FOUND_LIB([sys/poll.h])]) AC_CHECK_HEADERS([sys/sysmacros.h], [], [HEADER_NOT_FOUND_LIB([sys/sysmacros.h])]) -AC_CHECK_HEADERS([linux/gpio.h], [], [HEADER_NOT_FOUND_LIB([linux/gpio.h])]) AC_CHECK_HEADERS([linux/version.h], [], [HEADER_NOT_FOUND_LIB([linux/version.h])]) - -AC_COMPILE_IFELSE([AC_LANG_SOURCE( -#include <linux/version.h> -#if LINUX_VERSION_CODE < KERNEL_VERSION(5, 10, 0) -#error -#endif -)], -[], [AC_MSG_ERROR(["libgpiod needs linux headers version >= v5.10.0"])]) +AC_CHECK_HEADERS([linux/const.h], [], [HEADER_NOT_FOUND_LIB([linux/const.h])]) +AC_CHECK_HEADERS([linux/ioctl.h], [], [HEADER_NOT_FOUND_LIB([linux/ioctl.h])]) +AC_CHECK_HEADERS([linux/types.h], [], [HEADER_NOT_FOUND_LIB([linux/types.h])]) AC_ARG_ENABLE([tools], [AS_HELP_STRING([--enable-tools],[enable libgpiod command-line tools [default=no]])],
lib/Makefile.am +1 -1
@@ -7,7 +7,7 @@ # lib_LTLIBRARIES = libgpiod.la -libgpiod_la_SOURCES = core.c helpers.c misc.c +libgpiod_la_SOURCES = core.c helpers.c misc.c uapi/gpio.h libgpiod_la_CFLAGS = -Wall -Wextra -g -std=gnu89 libgpiod_la_CFLAGS += -fvisibility=hidden -I$(top_srcdir)/include/ libgpiod_la_CFLAGS += -include $(top_builddir)/config.h
lib/core.c +2 -1
@@ -11,7 +11,6 @@#include <fcntl.h> #include <gpiod.h> #include <limits.h> -#include <linux/gpio.h> #include <poll.h> #include <stdint.h> #include <stdio.h>
@@ -22,6 +21,8 @@#include <sys/types.h> #include <unistd.h> +#include "uapi/gpio.h" +#define LINE_REQUEST_MAX_LINES 64enum {
lib/uapi/gpio.h new file +522 -0
522 lines not on this page · raw message
Signature · 1 line
2.29.1
Re: [libgpiod][PATCH v2 7/7] core: add the kernel uapi header to the repository
Quoted 17 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
In order to avoid any problems with symbols missing from the host linux kernel headers (for example: if current version of libgpiod supports features that were added recently to the kernel but the host headers are outdated and don't export required symbols) let's add the uapi header to the repository and include it instead of the one in
/usr/include/linux.Signed-off-by Bartosz Golaszewski <[email protected]>--- configure.ac | 12 +- lib/Makefile.am | 2 +- lib/core.c | 3 +- lib/uapi/gpio.h | 522 ++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 528 insertions(+), 11 deletions(-) create mode 100644 lib/uapi/gpio.h
[snip]
lib/uapi/gpio.h line 81
Quoted 13 lines
lib/uapi/gpio.h new file +13
-0+enum gpio_v2_line_flag { +GPIO_V2_LINE_FLAG_USED =_BITULL (0 ), +GPIO_V2_LINE_FLAG_ACTIVE_LOW =_BITULL (1 ), +GPIO_V2_LINE_FLAG_INPUT =_BITULL (2 ), +GPIO_V2_LINE_FLAG_OUTPUT =_BITULL (3 ), +GPIO_V2_LINE_FLAG_EDGE_RISING =_BITULL (4 ), +GPIO_V2_LINE_FLAG_EDGE_FALLING =_BITULL (5 ), +GPIO_V2_LINE_FLAG_OPEN_DRAIN =_BITULL (6 ), +GPIO_V2_LINE_FLAG_OPEN_SOURCE =_BITULL (7 ), +GPIO_V2_LINE_FLAG_BIAS_PULL_UP =_BITULL (8 ), +GPIO_V2_LINE_FLAG_BIAS_PULL_DOWN =_BITULL (9 ), +GPIO_V2_LINE_FLAG_BIAS_DISABLED =_BITULL (10 ), +};
Perhaps include the header from v5.11-rc3 that includes the GPIO_V2_LINE_FLAG_EVENT_CLOCK_REALTIME flag?
Unless your intent is for the next libgpiod release to explicitly target v5.10?
+1 for including the header, btw. Targetting a specific kernel header simplifies the build. We are always going to have to deal with current apps being run on old kernels, either way, and anyone that cares to use current features has to ensure they have a current kernel, either way.
Cheers,
Kent.
Re: [libgpiod][PATCH v2 7/7] core: add the kernel uapi header to the repository
Quoted 38 lines · Kent Gibson
Quoted 17 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
In order to avoid any problems with symbols missing from the host linux kernel headers (for example: if current version of libgpiod supports features that were added recently to the kernel but the host headers are outdated and don't export required symbols) let's add the uapi header to the repository and include it instead of the one in
/usr/include/linux.Signed-off-by Bartosz Golaszewski <[email protected]>--- configure.ac | 12 +- lib/Makefile.am | 2 +- lib/core.c | 3 +- lib/uapi/gpio.h | 522 ++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 528 insertions(+), 11 deletions(-) create mode 100644 lib/uapi/gpio.h[snip]
lib/uapi/gpio.h line 81
Quoted 13 lines
lib/uapi/gpio.h new file +13
-0+enum gpio_v2_line_flag { +GPIO_V2_LINE_FLAG_USED =_BITULL (0 ), +GPIO_V2_LINE_FLAG_ACTIVE_LOW =_BITULL (1 ), +GPIO_V2_LINE_FLAG_INPUT =_BITULL (2 ), +GPIO_V2_LINE_FLAG_OUTPUT =_BITULL (3 ), +GPIO_V2_LINE_FLAG_EDGE_RISING =_BITULL (4 ), +GPIO_V2_LINE_FLAG_EDGE_FALLING =_BITULL (5 ), +GPIO_V2_LINE_FLAG_OPEN_DRAIN =_BITULL (6 ), +GPIO_V2_LINE_FLAG_OPEN_SOURCE =_BITULL (7 ), +GPIO_V2_LINE_FLAG_BIAS_PULL_UP =_BITULL (8 ), +GPIO_V2_LINE_FLAG_BIAS_PULL_DOWN =_BITULL (9 ), +GPIO_V2_LINE_FLAG_BIAS_DISABLED =_BITULL (10 ), +};Perhaps include the header from v5.11-rc3 that includes the
GPIO_V2_LINE_FLAG_EVENT_CLOCK_REALTIMEflag?
Quoted 3 lines
Unless your intent is for the next libgpiod release to explicitly target v5.10?
Not at all! I'll just update the header once a new linux version is out. I doubt v2.0 will be done anytime soon and I don't want to rush it.
Bart
Quoted 7 lines
+1 for including the header, btw. Targetting a specific kernel header simplifies the build. We are always going to have to deal with current apps being run on old kernels, either way, and anyone that cares to use current features has to ensure they have a current kernel, either way.
Cheers,
Kent.
Quoted 8 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
This is another batch of improvements to libgpiod before we overhaul the data structure model.
The last patch adds the kernel uapi header to the repository so that we no longer depend on its presence on the host system.
+1 for this set, other than my specific comments.
I'm all for a small core C library.
And there are more drastic changes to come, so any problems missed here can be picked up there.
Cheers,
Kent.