Hi Martin,
The Linux kernel GPIO api operates with chips, lines, handles, and
events.
The chip and line structures represent info about gpio chips, and
gpio lines, respectively. They are used to e.g. lookup a line with a
certain name, and/or line flags.
The handle structure is used to "obtain" a handle to one or more gpio
lines on a chip. Until the file descriptor in this handle is closed, the
gpio lines cannot be used by others. The same file descriptor is used
when setting or getting the line values (one can also set the initial
value when obtaining handles for output lines).
The event structure is used to get a file descriptor that can be used
with select/poll to wait for changes in line levels.
This commit add simple support for setting and getting the value for a
single gpio line. It does so by obtaining a line handle to get/set the
value, and then release the handle immediately again.
Functionality that could be implemented, but is postponed until the need
arises includes:
* looking up a gpio line by its name
* setting/getting multiple gpio lines with a single function
* waiting for events
* holding on to handles
Some of the above probably require adding structures to represent gpio
lines and events, while handles should be private to the class.
---
Makefile.am | 6 ++-
ell/ell.sym | 7 +++
ell/gpio.c | 151 ++++++++++++++++++++++++++++++++++++++++++++++++++++
ell/gpio.h | 50 +++++++++++++++++
4 files changed, 212 insertions(+), 2 deletions(-)
create mode 100644 ell/gpio.c
create mode 100644 ell/gpio.h
diff --git a/Makefile.am b/Makefile.am
index 8401972..0ecb9a1 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -51,7 +51,8 @@ pkginclude_HEADERS = ell/ell.h \
ell/dhcp.h \
ell/cert.h \
ell/ecc.h \
- ell/ecdh.h
+ ell/ecdh.h \
+ ell/gpio.h
lib_LTLIBRARIES = ell/libell.la
@@ -119,7 +120,8 @@ ell_libell_la_SOURCES = $(linux_headers) \
ell/ecc.h \
ell/ecc-external.c \
ell/ecc.c \
- ell/ecdh.c
+ ell/ecdh.c \
+ ell/gpio.c
ell_libell_la_LDFLAGS = -no-undefined \
-Wl,--version-script=$(top_srcdir)/ell/ell.sym \
diff --git a/ell/ell.sym b/ell/ell.sym
index 841bc49..d6b12f1 100644
--- a/ell/ell.sym
+++ b/ell/ell.sym
@@ -463,6 +463,13 @@ global:
/* ecdh */
l_ecdh_generate_key_pair;
l_ecdh_generate_shared_secret;
+ /* gpio */
+ l_gpio_chip_new;
+ l_gpio_chip_free;
+ l_gpio_chip_open;
+ l_gpio_chip_open_name;
+ l_gpio_chip_get_line_value;
+ l_gpio_chip_set_line_value;
local:
*;
};
diff --git a/ell/gpio.c b/ell/gpio.c
new file mode 100644
index 0000000..1398594
--- /dev/null
+++ b/ell/gpio.c
@@ -0,0 +1,151 @@
+/*
+ *
+ * Embedded Linux library
+ *
+ * Copyright (C) 2011-2018 Intel Corporation. All rights reserved.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ */
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#include <sys/ioctl.h>
+#include <fcntl.h>
+#include <unistd.h>
+#include <linux/gpio.h>
+
+#include "util.h"
+#include "gpio.h"
+#include "private.h"
+
+struct l_gpio_chip {
+ int fd;
+};
+
+LIB_EXPORT struct l_gpio_chip *l_gpio_chip_new(void)
+{
+ struct l_gpio_chip *chip = l_new(struct l_gpio_chip, 1);
I am not a big fan of these kind of allocation during the variable declaration. So lets
have these like this:
struct l_gpio_chip *chip;
chip = l_new(struct l_gpio_chip, 1);
+
+ chip->fd = -1;
+
+ return chip;
+}
+
+LIB_EXPORT void l_gpio_chip_free(struct l_gpio_chip *chip)
+{
+ if (chip && chip->fd >= 0)
+ close(chip->fd);
I prefer doing this nicely in sequence to reduce the brain power to follow it:
if (!chip)
return;
if (chip->fd >= 0)
close(chip->fd);
+
+ l_free(chip);
+}
+
+static bool gpio_chip_open(struct l_gpio_chip *chip, const char *path)
+{
+ if (chip->fd >= 0)
+ close(chip->fd);
This is missing the NULL check:
if (!chip)
return false;
+
+ chip->fd = open(path, O_RDWR | O_CLOEXEC);
+ if (chip->fd < 0)
+ return false;
+
+ return true;
+}
+
+LIB_EXPORT bool l_gpio_chip_open(struct l_gpio_chip *chip, uint32_t num)
+{
+ char *path = l_strdup_printf("/dev/gpiochip%u", num);
+ bool ret = gpio_chip_open(chip, path);
+
+ l_free(path);
+
+ return ret;
+}
+
+LIB_EXPORT bool l_gpio_chip_open_name(struct l_gpio_chip *chip,
+ const char *name)
+{
+ char *path;
+ bool ret;
+
+ if (!name)
+ return false;
+
+ if (l_str_has_prefix(name, "/dev/"))
+ path = l_strdup(name);
+ else
+ path = l_strdup_printf("/dev/%s", name);
+
+ ret = gpio_chip_open(chip, path);
+
+ l_free(path);
+
+ return ret;
+}
Now the more important question, why do we have so many options here for opening the file
descriptor and also why do we have an empty struct l_gpio_chip.
LIB_EXPORT struct l_gpio_chip *l_gpio_chip_new(const char *name)
{
struct l_gpio_chip *chip;
char *path;
if (!name)
return NULL;
chip = l_new(struct l_gpio_chip, 1);
path = l_strdup_printf("/dev/%s", name);
chip->fd = open(path, O_RDWR | O_CLOEXEC);
l_free(path);
if (chip->fd < 0) {
l_free(chip);
return NULL;
}
return chip;
}
+
+LIB_EXPORT bool l_gpio_chip_get_line_value(struct l_gpio_chip *chip,
+ uint32_t line, bool *value)
+{
+ struct gpiohandle_request req = {0};
+ struct gpiohandle_data data = {0};
+ int ret;
+
+ if (chip->fd < 0)
+ return false;
It is missing input validation.
if (!chip)
return false;
+
+ req.lineoffsets[0] = line;
+ req.lines = 1;
+ req.flags = GPIOHANDLE_REQUEST_INPUT;
I think we better do the init via memset().
+
+ ret = ioctl(chip->fd, GPIO_GET_LINEHANDLE_IOCTL, &req);
+ if (ret < 0 || req.fd <= 0)
+ return false;
+
+ ret = ioctl(req.fd, GPIOHANDLE_GET_LINE_VALUES_IOCTL, &data);
close(req.fd);
if (ret < 0)
return false;
+ if (ret < 0)
+ goto error;
+
+ *value = data.values[0];
if (value)
*value = !!data.values[0];
+
+error:
+ close(req.fd);
+
+ return ret == 0;
return true;
+}
+
+LIB_EXPORT bool l_gpio_chip_set_line_value(struct l_gpio_chip *chip,
+ uint32_t line, bool value)
+{
+ struct gpiohandle_request req = {0};
+ int ret;
+
+ if (chip->fd < 0)
+ return false;
+
+ req.lineoffsets[0] = line;
+ req.lines = 1;
+ req.flags = GPIOHANDLE_REQUEST_OUTPUT;
+ req.default_values[0] = value;
See my comments above.
+
+ ret = ioctl(chip->fd, GPIO_GET_LINEHANDLE_IOCTL, &req);
+ if (ret < 0 || req.fd <= 0)
+ return false;
+
+ close(req.fd);
+
+ return true;
+}
Regards
Marcel