From: Rodrigo Alencar <[email protected]>
Add a KUnit test suite covering __iio_chan_prefix_emit(), the helper
that builds IIO sysfs attribute name prefixes from an iio_chan_spec.
The suite groups cases by the enum iio_shared_by mode it exercises:
- IIO_SHARED_BY_ALL: produces an empty prefix.
- IIO_SHARED_BY_DIR: emits direction only ("in" / "out").
- IIO_SHARED_BY_TYPE: emits "<dir>_<type>" and the differential
"<dir>_<type>-<type>" variant.
- IIO_SEPARATE: covers the full matrix of indexed, differential,
modified, output and extend_name combinations, plus the two
documented error paths (differential without indexed, differential
with modifier).
A final case exercises the seq_buf overflow path by passing an
undersized buffer and expects -EOVERFLOW.
Also, an entry is created under MAINTAINERS dedicated to tests for IIO
core helpers.
Signed-off-by: Rodrigo Alencar <[email protected]>
---
MAINTAINERS | 7 +
drivers/iio/iio_core.h | 7 +
drivers/iio/industrialio-core.c | 13 +-
drivers/iio/test/Kconfig | 14 ++
drivers/iio/test/Makefile | 1 +
drivers/iio/test/iio-test-channel-prefix.c | 304 +++++++++++++++++++++++++++++
6 files changed, 342 insertions(+), 4 deletions(-)
diff --git a/MAINTAINERS b/MAINTAINERS
index 7077ed7c9efe..d61447c9d197 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -12634,6 +12634,13 @@ F: include/dt-bindings/iio/
F: include/linux/iio/
F: tools/iio/
+IIO CORE KUNIT TESTS
+M: Rodrigo Alencar <[email protected]>
+L: [email protected]
+S: Maintained
+F: drivers/iio/test/iio-test-channel-prefix.c
+F: drivers/iio/test/iio-test-format.c
+
IIO UNIT CONVERTER
M: Peter Rosin <[email protected]>
L: [email protected]
diff --git a/drivers/iio/iio_core.h b/drivers/iio/iio_core.h
index b7d5f4f0fada..59fa1bd9924b 100644
--- a/drivers/iio/iio_core.h
+++ b/drivers/iio/iio_core.h
@@ -109,4 +109,11 @@ void iio_device_wakeup_eventset(struct iio_dev *indio_dev);
struct iio_event_interface;
bool iio_event_enabled(const struct iio_event_interface *ev_int);
+#if IS_ENABLED(CONFIG_KUNIT)
+ssize_t __iio_chan_prefix_emit(struct device *dev,
+ const struct iio_chan_spec *chan,
+ enum iio_shared_by shared_by,
+ char *buf, size_t len);
+#endif
+
#endif
diff --git a/drivers/iio/industrialio-core.c b/drivers/iio/industrialio-core.c
index 23d3801887a9..aa9d6474edd9 100644
--- a/drivers/iio/industrialio-core.c
+++ b/drivers/iio/industrialio-core.c
@@ -9,12 +9,15 @@
#define pr_fmt(fmt) "iio-core: " fmt
+#include <kunit/visibility.h>
+
#include <linux/anon_inodes.h>
#include <linux/cdev.h>
#include <linux/cleanup.h>
#include <linux/debugfs.h>
#include <linux/device.h>
#include <linux/err.h>
+#include <linux/export.h>
#include <linux/fs.h>
#include <linux/idr.h>
#include <linux/kdev_t.h>
@@ -201,10 +204,11 @@ static const char * const iio_chan_info_postfix[] = {
[IIO_CHAN_INFO_POWERFACTOR] = "powerfactor",
};
-static ssize_t __iio_chan_prefix_emit(struct device *dev,
- const struct iio_chan_spec *chan,
- enum iio_shared_by shared_by,
- char *buf, size_t len)
+VISIBLE_IF_KUNIT
+ssize_t __iio_chan_prefix_emit(struct device *dev,
+ const struct iio_chan_spec *chan,
+ enum iio_shared_by shared_by,
+ char *buf, size_t len)
{
const char *type = iio_chan_type_name_spec[chan->type];
const char *dir = iio_direction[chan->output];
@@ -254,6 +258,7 @@ static ssize_t __iio_chan_prefix_emit(struct device *dev,
return seq_buf_has_overflowed(&s) ? -EOVERFLOW : s.len;
}
+EXPORT_SYMBOL_IF_KUNIT(__iio_chan_prefix_emit);
/**
* iio_device_id() - query the unique ID for the device
diff --git a/drivers/iio/test/Kconfig b/drivers/iio/test/Kconfig
index 4fc17dd0dcd7..7d2c29cc583b 100644
--- a/drivers/iio/test/Kconfig
+++ b/drivers/iio/test/Kconfig
@@ -4,6 +4,20 @@
#
# Keep in alphabetical order
+config IIO_CHANNEL_PREFIX_KUNIT_TEST
+ tristate "Test IIO channel prefix" if !KUNIT_ALL_TESTS
+ depends on KUNIT && IIO
+ default KUNIT_ALL_TESTS
+ help
+ Build unit tests for __iio_chan_prefix_emit(), the helper that
+ builds IIO sysfs attribute name prefixes from an iio_chan_spec.
+ The tests are compiled into the IIO core module.
+
+ For more information on KUnit and unit tests in general, please refer
+ to the KUnit documentation in Documentation/dev-tools/kunit/.
+
+ If unsure, say N.
+
config IIO_GTS_KUNIT_TEST
tristate "Test IIO gain-time-scale helpers" if !KUNIT_ALL_TESTS
depends on KUNIT
diff --git a/drivers/iio/test/Makefile b/drivers/iio/test/Makefile
index 0c846bc21acd..ba08afa7f3f2 100644
--- a/drivers/iio/test/Makefile
+++ b/drivers/iio/test/Makefile
@@ -4,6 +4,7 @@
#
# Keep in alphabetical order
+obj-$(CONFIG_IIO_CHANNEL_PREFIX_KUNIT_TEST) += iio-test-channel-prefix.o
obj-$(CONFIG_IIO_RESCALE_KUNIT_TEST) += iio-test-rescale.o
obj-$(CONFIG_IIO_FORMAT_KUNIT_TEST) += iio-test-format.o
obj-$(CONFIG_IIO_GTS_KUNIT_TEST) += iio-test-gts.o
diff --git a/drivers/iio/test/iio-test-channel-prefix.c
b/drivers/iio/test/iio-test-channel-prefix.c
new file mode 100644
index 000000000000..d049e4222c40
--- /dev/null
+++ b/drivers/iio/test/iio-test-channel-prefix.c
@@ -0,0 +1,304 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Unit tests for IIO channel prefix generation.
+ */
+
+#include <kunit/test.h>
+#include <kunit/visibility.h>
+
+#include <linux/iio/iio.h>
+#include <linux/limits.h>
+#include <linux/string.h>
+
+#include "../iio_core.h"
+
+#define PREFIX_BUF_SIZE (NAME_MAX + 1)
+
+#define EXPECT_PREFIX(_test, _buf, _ret, _expected) do {
\
+ struct kunit *__test = (_test);
\
+ const char *__expected = (_expected);
\
+
\
+ KUNIT_EXPECT_EQ(__test, (_ret), (ssize_t)strlen(__expected));
\
+ KUNIT_EXPECT_STREQ(__test, (_buf), __expected);
\
+ } while (0)
+
+static char *iio_test_prefix_alloc(struct kunit *test)
+{
+ char *buf = kunit_kzalloc(test, PREFIX_BUF_SIZE, GFP_KERNEL);
+
+ KUNIT_ASSERT_NOT_ERR_OR_NULL(test, buf);
+ return buf;
+}
+
+static void iio_test_prefix_shared_by_all(struct kunit *test)
+{
+ const struct iio_chan_spec chan = {
+ .type = IIO_VOLTAGE,
+ };
+ const struct iio_chan_spec chan_noisy = {
+ .type = IIO_ACCEL,
+ .output = 1,
+ .indexed = 1,
+ .modified = 1,
+ .channel = 7,
+ .channel2 = IIO_MOD_Z,
+ .extend_name = "supply",
+ };
+ char *buf = iio_test_prefix_alloc(test);
+ ssize_t ret;
+
+ ret = __iio_chan_prefix_emit(NULL, &chan, IIO_SHARED_BY_ALL,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "");
+
+ ret = __iio_chan_prefix_emit(NULL, &chan_noisy, IIO_SHARED_BY_ALL,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "");
+}
+
+static void iio_test_prefix_shared_by_dir(struct kunit *test)
+{
+ const struct iio_chan_spec chan_in = {
+ .type = IIO_VOLTAGE,
+ .output = 0,
+ };
+ const struct iio_chan_spec chan_out = {
+ .type = IIO_VOLTAGE,
+ .output = 1,
+ };
+ const struct iio_chan_spec chan_in_noisy = {
+ .type = IIO_ACCEL,
+ .indexed = 1,
+ .modified = 1,
+ .channel = 5,
+ .channel2 = IIO_MOD_Y,
+ .extend_name = "supply",
+ };
+ char *buf = iio_test_prefix_alloc(test);
+ ssize_t ret;
+
+ ret = __iio_chan_prefix_emit(NULL, &chan_in, IIO_SHARED_BY_DIR,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "in");
+
+ ret = __iio_chan_prefix_emit(NULL, &chan_out, IIO_SHARED_BY_DIR,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "out");
+
+ ret = __iio_chan_prefix_emit(NULL, &chan_in_noisy, IIO_SHARED_BY_DIR,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "in");
+}
+
+static void iio_test_prefix_shared_by_type(struct kunit *test)
+{
+ const struct iio_chan_spec chan = {
+ .type = IIO_VOLTAGE,
+ };
+ const struct iio_chan_spec chan_diff = {
+ .type = IIO_VOLTAGE,
+ .differential = 1,
+ };
+ const struct iio_chan_spec chan_noisy = {
+ .type = IIO_VOLTAGE,
+ .indexed = 1,
+ .modified = 1,
+ .channel = 4,
+ .channel2 = IIO_MOD_X,
+ .extend_name = "supply",
+ };
+ char *buf = iio_test_prefix_alloc(test);
+ ssize_t ret;
+
+ ret = __iio_chan_prefix_emit(NULL, &chan, IIO_SHARED_BY_TYPE,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "in_voltage");
+
+ ret = __iio_chan_prefix_emit(NULL, &chan_diff, IIO_SHARED_BY_TYPE,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "in_voltage-voltage");
+
+ ret = __iio_chan_prefix_emit(NULL, &chan_noisy, IIO_SHARED_BY_TYPE,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "in_voltage");
+}
+
+static void iio_test_prefix_separate_simple(struct kunit *test)
+{
+ const struct iio_chan_spec chan = {
+ .type = IIO_TEMP,
+ };
+ char *buf = iio_test_prefix_alloc(test);
+ ssize_t ret;
+
+ ret = __iio_chan_prefix_emit(NULL, &chan, IIO_SEPARATE,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "in_temp");
+}
+
+static void iio_test_prefix_separate_indexed(struct kunit *test)
+{
+ const struct iio_chan_spec chan = {
+ .type = IIO_VOLTAGE,
+ .indexed = 1,
+ .channel = 3,
+ };
+ char *buf = iio_test_prefix_alloc(test);
+ ssize_t ret;
+
+ ret = __iio_chan_prefix_emit(NULL, &chan, IIO_SEPARATE,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "in_voltage3");
+}
+
+static void iio_test_prefix_separate_indexed_diff(struct kunit *test)
+{
+ const struct iio_chan_spec chan = {
+ .type = IIO_VOLTAGE,
+ .indexed = 1,
+ .differential = 1,
+ .channel = 0,
+ .channel2 = 1,
+ };
+ char *buf = iio_test_prefix_alloc(test);
+ ssize_t ret;
+
+ ret = __iio_chan_prefix_emit(NULL, &chan, IIO_SEPARATE,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "in_voltage0-voltage1");
+}
+
+static void iio_test_prefix_separate_modified(struct kunit *test)
+{
+ const struct iio_chan_spec chan = {
+ .type = IIO_ACCEL,
+ .modified = 1,
+ .channel2 = IIO_MOD_X,
+ };
+ char *buf = iio_test_prefix_alloc(test);
+ ssize_t ret;
+
+ ret = __iio_chan_prefix_emit(NULL, &chan, IIO_SEPARATE,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "in_accel_x");
+}
+
+static void iio_test_prefix_separate_indexed_modified(struct kunit *test)
+{
+ const struct iio_chan_spec chan = {
+ .type = IIO_ACCEL,
+ .indexed = 1,
+ .modified = 1,
+ .channel = 2,
+ .channel2 = IIO_MOD_Y,
+ };
+ char *buf = iio_test_prefix_alloc(test);
+ ssize_t ret;
+
+ ret = __iio_chan_prefix_emit(NULL, &chan, IIO_SEPARATE,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "in_accel2_y");
+}
+
+static void iio_test_prefix_separate_extend_name(struct kunit *test)
+{
+ const struct iio_chan_spec chan = {
+ .type = IIO_VOLTAGE,
+ .indexed = 1,
+ .channel = 2,
+ .extend_name = "supply",
+ };
+ char *buf = iio_test_prefix_alloc(test);
+ ssize_t ret;
+
+ ret = __iio_chan_prefix_emit(NULL, &chan, IIO_SEPARATE,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "in_voltage2_supply");
+}
+
+static void iio_test_prefix_output_separate(struct kunit *test)
+{
+ const struct iio_chan_spec chan = {
+ .type = IIO_VOLTAGE,
+ .output = 1,
+ .indexed = 1,
+ .channel = 0,
+ };
+ char *buf = iio_test_prefix_alloc(test);
+ ssize_t ret;
+
+ ret = __iio_chan_prefix_emit(NULL, &chan, IIO_SEPARATE,
+ buf, PREFIX_BUF_SIZE);
+ EXPECT_PREFIX(test, buf, ret, "out_voltage0");
+}
+
+static void iio_test_prefix_diff_unindexed_fails(struct kunit *test)
+{
+ const struct iio_chan_spec chan = {
+ .type = IIO_VOLTAGE,
+ .differential = 1,
+ };
+ char *buf = iio_test_prefix_alloc(test);
+ ssize_t ret;
+
+ ret = __iio_chan_prefix_emit(NULL, &chan, IIO_SEPARATE,
+ buf, PREFIX_BUF_SIZE);
+ KUNIT_EXPECT_EQ(test, ret, -EINVAL);
+}
+
+static void iio_test_prefix_diff_modified_fails(struct kunit *test)
+{
+ const struct iio_chan_spec chan = {
+ .type = IIO_VOLTAGE,
+ .indexed = 1,
+ .differential = 1,
+ .modified = 1,
+ .channel = 0,
+ .channel2 = 1,
+ };
+ char *buf = iio_test_prefix_alloc(test);
+ ssize_t ret;
+
+ ret = __iio_chan_prefix_emit(NULL, &chan, IIO_SEPARATE,
+ buf, PREFIX_BUF_SIZE);
+ KUNIT_EXPECT_EQ(test, ret, -EINVAL);
+}
+
+static void iio_test_prefix_overflow(struct kunit *test)
+{
+ const struct iio_chan_spec chan = {
+ .type = IIO_VOLTAGE,
+ };
+ char small[4];
+ ssize_t ret;
+
+ ret = __iio_chan_prefix_emit(NULL, &chan, IIO_SHARED_BY_TYPE,
+ small, sizeof(small));
+ KUNIT_EXPECT_EQ(test, ret, -EOVERFLOW);
+}
+
+static struct kunit_case iio_chan_prefix_test_cases[] = {
+ KUNIT_CASE(iio_test_prefix_shared_by_all),
+ KUNIT_CASE(iio_test_prefix_shared_by_dir),
+ KUNIT_CASE(iio_test_prefix_shared_by_type),
+ KUNIT_CASE(iio_test_prefix_separate_simple),
+ KUNIT_CASE(iio_test_prefix_separate_indexed),
+ KUNIT_CASE(iio_test_prefix_separate_indexed_diff),
+ KUNIT_CASE(iio_test_prefix_separate_modified),
+ KUNIT_CASE(iio_test_prefix_separate_indexed_modified),
+ KUNIT_CASE(iio_test_prefix_separate_extend_name),
+ KUNIT_CASE(iio_test_prefix_output_separate),
+ KUNIT_CASE(iio_test_prefix_diff_unindexed_fails),
+ KUNIT_CASE(iio_test_prefix_diff_modified_fails),
+ KUNIT_CASE(iio_test_prefix_overflow),
+ { }
+};
+
+static struct kunit_suite iio_channel_prefix_test_suite = {
+ .name = "iio-channel-prefix",
+ .test_cases = iio_chan_prefix_test_cases,
+};
+
+kunit_test_suite(iio_channel_prefix_test_suite);
+
+MODULE_IMPORT_NS("EXPORTED_FOR_KUNIT_TESTING");
--
2.43.0
