| Message ID | 20240603223811.3815762-6-sboyd@kernel.org (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | clk: Add kunit tests for fixed rate and parent data | expand |
On Mon, Jun 03, 2024 at 03:38:02PM -0700, Stephen Boyd wrote: > Test the KUnit test managed overlay APIs. Confirm that platform devices > are created and destroyed properly. This provides us confidence that the > test managed APIs work correctly and can be relied upon to provide tests > with fake platform devices and device nodes via overlays compiled into > the kernel image. > > Cc: Rob Herring <robh@kernel.org> > Cc: Saravana Kannan <saravanak@google.com> > Cc: Daniel Latypov <dlatypov@google.com> > Cc: Brendan Higgins <brendan.higgins@linux.dev> > Cc: David Gow <davidgow@google.com> > Cc: Rae Moar <rmoar@google.com> > Reviewed-by: Rob Herring (Arm) <robh@kernel.org> > Signed-off-by: Stephen Boyd <sboyd@kernel.org> > --- > drivers/of/.kunitconfig | 1 + > drivers/of/Kconfig | 10 +++ > drivers/of/Makefile | 1 + > drivers/of/kunit_overlay_test.dtso | 9 +++ > drivers/of/overlay_test.c | 116 +++++++++++++++++++++++++++++ > 5 files changed, 137 insertions(+) > create mode 100644 drivers/of/kunit_overlay_test.dtso > create mode 100644 drivers/of/overlay_test.c > > diff --git a/drivers/of/.kunitconfig b/drivers/of/.kunitconfig > index 5a8fee11978c..4c53d2c7a275 100644 > --- a/drivers/of/.kunitconfig > +++ b/drivers/of/.kunitconfig > @@ -1,3 +1,4 @@ > CONFIG_KUNIT=y > CONFIG_OF=y > CONFIG_OF_KUNIT_TEST=y > +CONFIG_OF_OVERLAY_KUNIT_TEST=y > diff --git a/drivers/of/Kconfig b/drivers/of/Kconfig > index dd726c7056bf..0e2d608c3e20 100644 > --- a/drivers/of/Kconfig > +++ b/drivers/of/Kconfig > @@ -107,6 +107,16 @@ config OF_OVERLAY > While this option is selected automatically when needed, you can > enable it manually to improve device tree unit test coverage. > > +config OF_OVERLAY_KUNIT_TEST > + tristate "Device Tree overlay KUnit tests" if !KUNIT_ALL_TESTS > + depends on KUNIT > + default KUNIT_ALL_TESTS > + select OF_OVERLAY > + help > + This option builds KUnit unit tests for the device tree overlay code. > + > + If unsure, say N here, but this option is safe to enable. > + > config OF_NUMA > bool > > diff --git a/drivers/of/Makefile b/drivers/of/Makefile > index 2ae909adde49..abd9c578343b 100644 > --- a/drivers/of/Makefile > +++ b/drivers/of/Makefile > @@ -21,5 +21,6 @@ endif > > obj-$(CONFIG_KUNIT) += of_kunit_helpers.o > obj-$(CONFIG_OF_KUNIT_TEST) += of_test.o > +obj-$(CONFIG_OF_OVERLAY_KUNIT_TEST) += overlay_test.o kunit_overlay_test.dtbo.o > > obj-$(CONFIG_OF_UNITTEST) += unittest-data/ > diff --git a/drivers/of/kunit_overlay_test.dtso b/drivers/of/kunit_overlay_test.dtso > new file mode 100644 > index 000000000000..85f20b4b4c16 > --- /dev/null > +++ b/drivers/of/kunit_overlay_test.dtso > @@ -0,0 +1,9 @@ > +// SPDX-License-Identifier: GPL-2.0 > +/dts-v1/; > +/plugin/; > + > +&{/} { > + kunit-test { > + compatible = "test,empty"; > + }; > +}; > diff --git a/drivers/of/overlay_test.c b/drivers/of/overlay_test.c > new file mode 100644 > index 000000000000..9a8083c3a659 > --- /dev/null > +++ b/drivers/of/overlay_test.c > @@ -0,0 +1,116 @@ > +// SPDX-License-Identifier: GPL-2.0 > +/* > + * KUnit tests for device tree overlays > + */ > +#include <linux/device/bus.h> > +#include <linux/kconfig.h> > +#include <linux/of.h> > +#include <linux/of_platform.h> > +#include <linux/platform_device.h> > + > +#include <kunit/of.h> > +#include <kunit/test.h> > + > +static const char * const kunit_node_name = "kunit-test"; > +static const char * const kunit_compatible = "test,empty"; > + > +/* Test that of_overlay_apply_kunit() adds a node to the live tree */ > +static void of_overlay_apply_kunit_apply(struct kunit *test) > +{ > + struct device_node *np; > + > + KUNIT_ASSERT_EQ(test, 0, > + of_overlay_apply_kunit(test, kunit_overlay_test)); > + > + np = of_find_node_by_name(NULL, kunit_node_name); > + KUNIT_EXPECT_NOT_ERR_OR_NULL(test, np); > + of_node_put(np); > +} > + > +/* > + * Test that of_overlay_apply_kunit() creates platform devices with the > + * expected device_node > + */ > +static void of_overlay_apply_kunit_platform_device(struct kunit *test) > +{ > + struct platform_device *pdev; > + struct device_node *np; > + > + KUNIT_ASSERT_EQ(test, 0, > + of_overlay_apply_kunit(test, kunit_overlay_test)); > + > + np = of_find_node_by_name(NULL, kunit_node_name); > + of_node_put_kunit(test, np); Moving target, but we now have of_node_put() cleanups. Would that work here instead? > + KUNIT_ASSERT_NOT_ERR_OR_NULL(test, np); > + > + pdev = of_find_device_by_node(np); > + KUNIT_EXPECT_NOT_ERR_OR_NULL(test, pdev); > + if (pdev) > + put_device(&pdev->dev); > +} > + > +static int of_overlay_bus_match_compatible(struct device *dev, const void *data) > +{ > + return of_device_is_compatible(dev->of_node, data); > +} > + > +/* Test that of_overlay_apply_kunit() cleans up after the test is finished */ > +static void of_overlay_apply_kunit_cleanup(struct kunit *test) > +{ > + struct kunit fake; > + struct platform_device *pdev; > + struct device *dev; > + struct device_node *np; > + > + if (!IS_ENABLED(CONFIG_OF_OVERLAY)) > + kunit_skip(test, "requires CONFIG_OF_OVERLAY"); > + if (!IS_ENABLED(CONFIG_OF_EARLY_FLATTREE)) > + kunit_skip(test, "requires CONFIG_OF_EARLY_FLATTREE for root node"); > + > + kunit_init_test(&fake, "fake test", NULL); > + KUNIT_ASSERT_EQ(test, fake.status, KUNIT_SUCCESS); > + > + KUNIT_ASSERT_EQ(test, 0, > + of_overlay_apply_kunit(&fake, kunit_overlay_test)); > + > + np = of_find_node_by_name(NULL, kunit_node_name); > + of_node_put(np); /* Not derefing 'np' after this */ > + KUNIT_ASSERT_NOT_ERR_OR_NULL(test, np); > + > + pdev = of_find_device_by_node(np); Don't you need to hold a ref on np until here? > + KUNIT_ASSERT_NOT_ERR_OR_NULL(test, pdev); > + put_device(&pdev->dev); /* Not derefing 'pdev' after this */ > + > + /* Remove overlay */ > + kunit_cleanup(&fake); > + > + /* The node and device should be removed */ > + np = of_find_node_by_name(NULL, kunit_node_name); > + KUNIT_EXPECT_PTR_EQ(test, NULL, np); > + of_node_put(np); > + > + dev = bus_find_device(&platform_bus_type, NULL, kunit_compatible, > + of_overlay_bus_match_compatible); > + KUNIT_EXPECT_PTR_EQ(test, NULL, dev); > + put_device(dev); > +} > + > +static struct kunit_case of_overlay_apply_kunit_test_cases[] = { > + KUNIT_CASE(of_overlay_apply_kunit_apply), > + KUNIT_CASE(of_overlay_apply_kunit_platform_device), > + KUNIT_CASE(of_overlay_apply_kunit_cleanup), > + {} > +}; > + > +/* > + * Test suite for test managed device tree overlays. > + */ > +static struct kunit_suite of_overlay_apply_kunit_suite = { > + .name = "of_overlay_apply_kunit", > + .test_cases = of_overlay_apply_kunit_test_cases, > +}; > + > +kunit_test_suites( > + &of_overlay_apply_kunit_suite, > +); > +MODULE_LICENSE("GPL"); > -- > https://git.kernel.org/pub/scm/linux/kernel/git/clk/linux.git/ > https://git.kernel.org/pub/scm/linux/kernel/git/sboyd/spmi.git >
Quoting Rob Herring (2024-06-05 16:47:20) > On Mon, Jun 03, 2024 at 03:38:02PM -0700, Stephen Boyd wrote: > > diff --git a/drivers/of/Makefile b/drivers/of/Makefile > > index 2ae909adde49..abd9c578343b 100644 > > diff --git a/drivers/of/overlay_test.c b/drivers/of/overlay_test.c > > new file mode 100644 > > index 000000000000..9a8083c3a659 > > --- /dev/null > > +++ b/drivers/of/overlay_test.c > > @@ -0,0 +1,116 @@ > > +// SPDX-License-Identifier: GPL-2.0 > > +/* > > + * KUnit tests for device tree overlays > > + */ > > +#include <linux/device/bus.h> > > +#include <linux/kconfig.h> > > +#include <linux/of.h> > > +#include <linux/of_platform.h> > > +#include <linux/platform_device.h> > > + > > +#include <kunit/of.h> > > +#include <kunit/test.h> > > + > > +static const char * const kunit_node_name = "kunit-test"; > > +static const char * const kunit_compatible = "test,empty"; > > + > > +/* Test that of_overlay_apply_kunit() adds a node to the live tree */ > > +static void of_overlay_apply_kunit_apply(struct kunit *test) > > +{ > > + struct device_node *np; > > + > > + KUNIT_ASSERT_EQ(test, 0, > > + of_overlay_apply_kunit(test, kunit_overlay_test)); > > + > > + np = of_find_node_by_name(NULL, kunit_node_name); > > + KUNIT_EXPECT_NOT_ERR_OR_NULL(test, np); > > + of_node_put(np); > > +} > > + > > +/* > > + * Test that of_overlay_apply_kunit() creates platform devices with the > > + * expected device_node > > + */ > > +static void of_overlay_apply_kunit_platform_device(struct kunit *test) > > +{ > > + struct platform_device *pdev; > > + struct device_node *np; > > + > > + KUNIT_ASSERT_EQ(test, 0, > > + of_overlay_apply_kunit(test, kunit_overlay_test)); > > + > > + np = of_find_node_by_name(NULL, kunit_node_name); > > + of_node_put_kunit(test, np); > > Moving target, but we now have of_node_put() cleanups. Would that work > here instead? Do you mean cleanup.h? I don't think it will work. The assert logic is like an exception handler. If the assertion fails we basically jump out of the test and run any test exit code, including kunit resource exits. I could introduce another kunit wrapper for of_find_node_by_name() and use that here so that the reference is dropped when the test exits. > > > + KUNIT_ASSERT_NOT_ERR_OR_NULL(test, np); > > + > > + pdev = of_find_device_by_node(np); > > + KUNIT_EXPECT_NOT_ERR_OR_NULL(test, pdev); > > + if (pdev) > > + put_device(&pdev->dev); > > +} > > + > > +static int of_overlay_bus_match_compatible(struct device *dev, const void *data) > > +{ > > + return of_device_is_compatible(dev->of_node, data); > > +} > > + > > +/* Test that of_overlay_apply_kunit() cleans up after the test is finished */ > > +static void of_overlay_apply_kunit_cleanup(struct kunit *test) > > +{ > > + struct kunit fake; > > + struct platform_device *pdev; > > + struct device *dev; > > + struct device_node *np; > > + > > + if (!IS_ENABLED(CONFIG_OF_OVERLAY)) > > + kunit_skip(test, "requires CONFIG_OF_OVERLAY"); > > + if (!IS_ENABLED(CONFIG_OF_EARLY_FLATTREE)) > > + kunit_skip(test, "requires CONFIG_OF_EARLY_FLATTREE for root node"); > > + > > + kunit_init_test(&fake, "fake test", NULL); > > + KUNIT_ASSERT_EQ(test, fake.status, KUNIT_SUCCESS); > > + > > + KUNIT_ASSERT_EQ(test, 0, > > + of_overlay_apply_kunit(&fake, kunit_overlay_test)); > > + > > + np = of_find_node_by_name(NULL, kunit_node_name); > > + of_node_put(np); /* Not derefing 'np' after this */ > > + KUNIT_ASSERT_NOT_ERR_OR_NULL(test, np); > > + > > + pdev = of_find_device_by_node(np); > > Don't you need to hold a ref on np until here? Oh, good catch. We need an of_find_node_by_name_kunit() wrapper then.
On Tue, 4 Jun 2024 at 06:38, Stephen Boyd <sboyd@kernel.org> wrote: > > Test the KUnit test managed overlay APIs. Confirm that platform devices > are created and destroyed properly. This provides us confidence that the > test managed APIs work correctly and can be relied upon to provide tests > with fake platform devices and device nodes via overlays compiled into > the kernel image. > > Cc: Rob Herring <robh@kernel.org> > Cc: Saravana Kannan <saravanak@google.com> > Cc: Daniel Latypov <dlatypov@google.com> > Cc: Brendan Higgins <brendan.higgins@linux.dev> > Cc: David Gow <davidgow@google.com> > Cc: Rae Moar <rmoar@google.com> > Reviewed-by: Rob Herring (Arm) <robh@kernel.org> > Signed-off-by: Stephen Boyd <sboyd@kernel.org> > --- This is looking good from my point of view, and passes on my test setup. One minor question (do we need both to select OF_OVERLAY and skip if it's not enabled?), but otherwise: Reviewed-by: David Gow <davidgow@google.com> -- David -- David > drivers/of/.kunitconfig | 1 + > drivers/of/Kconfig | 10 +++ > drivers/of/Makefile | 1 + > drivers/of/kunit_overlay_test.dtso | 9 +++ > drivers/of/overlay_test.c | 116 +++++++++++++++++++++++++++++ > 5 files changed, 137 insertions(+) > create mode 100644 drivers/of/kunit_overlay_test.dtso > create mode 100644 drivers/of/overlay_test.c > > diff --git a/drivers/of/.kunitconfig b/drivers/of/.kunitconfig > index 5a8fee11978c..4c53d2c7a275 100644 > --- a/drivers/of/.kunitconfig > +++ b/drivers/of/.kunitconfig > @@ -1,3 +1,4 @@ > CONFIG_KUNIT=y > CONFIG_OF=y > CONFIG_OF_KUNIT_TEST=y > +CONFIG_OF_OVERLAY_KUNIT_TEST=y > diff --git a/drivers/of/Kconfig b/drivers/of/Kconfig > index dd726c7056bf..0e2d608c3e20 100644 > --- a/drivers/of/Kconfig > +++ b/drivers/of/Kconfig > @@ -107,6 +107,16 @@ config OF_OVERLAY > While this option is selected automatically when needed, you can > enable it manually to improve device tree unit test coverage. > > +config OF_OVERLAY_KUNIT_TEST > + tristate "Device Tree overlay KUnit tests" if !KUNIT_ALL_TESTS > + depends on KUNIT > + default KUNIT_ALL_TESTS > + select OF_OVERLAY > + help > + This option builds KUnit unit tests for the device tree overlay code. > + > + If unsure, say N here, but this option is safe to enable. > + > config OF_NUMA > bool > > diff --git a/drivers/of/Makefile b/drivers/of/Makefile > index 2ae909adde49..abd9c578343b 100644 > --- a/drivers/of/Makefile > +++ b/drivers/of/Makefile > @@ -21,5 +21,6 @@ endif > > obj-$(CONFIG_KUNIT) += of_kunit_helpers.o > obj-$(CONFIG_OF_KUNIT_TEST) += of_test.o > +obj-$(CONFIG_OF_OVERLAY_KUNIT_TEST) += overlay_test.o kunit_overlay_test.dtbo.o > > obj-$(CONFIG_OF_UNITTEST) += unittest-data/ > diff --git a/drivers/of/kunit_overlay_test.dtso b/drivers/of/kunit_overlay_test.dtso > new file mode 100644 > index 000000000000..85f20b4b4c16 > --- /dev/null > +++ b/drivers/of/kunit_overlay_test.dtso > @@ -0,0 +1,9 @@ > +// SPDX-License-Identifier: GPL-2.0 > +/dts-v1/; > +/plugin/; > + > +&{/} { > + kunit-test { > + compatible = "test,empty"; > + }; > +}; > diff --git a/drivers/of/overlay_test.c b/drivers/of/overlay_test.c > new file mode 100644 > index 000000000000..9a8083c3a659 > --- /dev/null > +++ b/drivers/of/overlay_test.c > @@ -0,0 +1,116 @@ > +// SPDX-License-Identifier: GPL-2.0 > +/* > + * KUnit tests for device tree overlays > + */ > +#include <linux/device/bus.h> > +#include <linux/kconfig.h> > +#include <linux/of.h> > +#include <linux/of_platform.h> > +#include <linux/platform_device.h> > + > +#include <kunit/of.h> > +#include <kunit/test.h> > + > +static const char * const kunit_node_name = "kunit-test"; > +static const char * const kunit_compatible = "test,empty"; > + > +/* Test that of_overlay_apply_kunit() adds a node to the live tree */ > +static void of_overlay_apply_kunit_apply(struct kunit *test) > +{ > + struct device_node *np; > + > + KUNIT_ASSERT_EQ(test, 0, > + of_overlay_apply_kunit(test, kunit_overlay_test)); > + > + np = of_find_node_by_name(NULL, kunit_node_name); > + KUNIT_EXPECT_NOT_ERR_OR_NULL(test, np); > + of_node_put(np); > +} > + > +/* > + * Test that of_overlay_apply_kunit() creates platform devices with the > + * expected device_node > + */ > +static void of_overlay_apply_kunit_platform_device(struct kunit *test) > +{ > + struct platform_device *pdev; > + struct device_node *np; > + > + KUNIT_ASSERT_EQ(test, 0, > + of_overlay_apply_kunit(test, kunit_overlay_test)); > + > + np = of_find_node_by_name(NULL, kunit_node_name); > + of_node_put_kunit(test, np); > + KUNIT_ASSERT_NOT_ERR_OR_NULL(test, np); > + > + pdev = of_find_device_by_node(np); > + KUNIT_EXPECT_NOT_ERR_OR_NULL(test, pdev); > + if (pdev) > + put_device(&pdev->dev); > +} > + > +static int of_overlay_bus_match_compatible(struct device *dev, const void *data) > +{ > + return of_device_is_compatible(dev->of_node, data); > +} > + > +/* Test that of_overlay_apply_kunit() cleans up after the test is finished */ > +static void of_overlay_apply_kunit_cleanup(struct kunit *test) > +{ > + struct kunit fake; > + struct platform_device *pdev; > + struct device *dev; > + struct device_node *np; > + > + if (!IS_ENABLED(CONFIG_OF_OVERLAY)) > + kunit_skip(test, "requires CONFIG_OF_OVERLAY"); > + if (!IS_ENABLED(CONFIG_OF_EARLY_FLATTREE)) > + kunit_skip(test, "requires CONFIG_OF_EARLY_FLATTREE for root node"); > + > + kunit_init_test(&fake, "fake test", NULL); > + KUNIT_ASSERT_EQ(test, fake.status, KUNIT_SUCCESS); > + > + KUNIT_ASSERT_EQ(test, 0, > + of_overlay_apply_kunit(&fake, kunit_overlay_test)); > + > + np = of_find_node_by_name(NULL, kunit_node_name); > + of_node_put(np); /* Not derefing 'np' after this */ > + KUNIT_ASSERT_NOT_ERR_OR_NULL(test, np); > + > + pdev = of_find_device_by_node(np); > + KUNIT_ASSERT_NOT_ERR_OR_NULL(test, pdev); > + put_device(&pdev->dev); /* Not derefing 'pdev' after this */ > + > + /* Remove overlay */ > + kunit_cleanup(&fake); > + > + /* The node and device should be removed */ > + np = of_find_node_by_name(NULL, kunit_node_name); > + KUNIT_EXPECT_PTR_EQ(test, NULL, np); > + of_node_put(np); > + > + dev = bus_find_device(&platform_bus_type, NULL, kunit_compatible, > + of_overlay_bus_match_compatible); > + KUNIT_EXPECT_PTR_EQ(test, NULL, dev); > + put_device(dev); > +} > + > +static struct kunit_case of_overlay_apply_kunit_test_cases[] = { > + KUNIT_CASE(of_overlay_apply_kunit_apply), > + KUNIT_CASE(of_overlay_apply_kunit_platform_device), > + KUNIT_CASE(of_overlay_apply_kunit_cleanup), > + {} > +}; > + > +/* > + * Test suite for test managed device tree overlays. > + */ > +static struct kunit_suite of_overlay_apply_kunit_suite = { > + .name = "of_overlay_apply_kunit", > + .test_cases = of_overlay_apply_kunit_test_cases, > +}; > + > +kunit_test_suites( > + &of_overlay_apply_kunit_suite, > +); > +MODULE_LICENSE("GPL"); > -- > https://git.kernel.org/pub/scm/linux/kernel/git/clk/linux.git/ > https://git.kernel.org/pub/scm/linux/kernel/git/sboyd/spmi.git > > -- > You received this message because you are subscribed to the Google Groups "KUnit Development" group. > To unsubscribe from this group and stop receiving emails from it, send an email to kunit-dev+unsubscribe@googlegroups.com. > To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20240603223811.3815762-6-sboyd%40kernel.org.
Quoting David Gow (2024-06-13 00:50:10) > On Tue, 4 Jun 2024 at 06:38, Stephen Boyd <sboyd@kernel.org> wrote: > > > > Test the KUnit test managed overlay APIs. Confirm that platform devices > > are created and destroyed properly. This provides us confidence that the > > test managed APIs work correctly and can be relied upon to provide tests > > with fake platform devices and device nodes via overlays compiled into > > the kernel image. > > > > Cc: Rob Herring <robh@kernel.org> > > Cc: Saravana Kannan <saravanak@google.com> > > Cc: Daniel Latypov <dlatypov@google.com> > > Cc: Brendan Higgins <brendan.higgins@linux.dev> > > Cc: David Gow <davidgow@google.com> > > Cc: Rae Moar <rmoar@google.com> > > Reviewed-by: Rob Herring (Arm) <robh@kernel.org> > > Signed-off-by: Stephen Boyd <sboyd@kernel.org> > > --- > > This is looking good from my point of view, and passes on my test > setup. One minor question (do we need both to select OF_OVERLAY and > skip if it's not enabled?), but otherwise: We don't need to skip if OF_OVERLAY isn't set because it's forced on for the test. I'll remove it, thanks.
diff --git a/drivers/of/.kunitconfig b/drivers/of/.kunitconfig index 5a8fee11978c..4c53d2c7a275 100644 --- a/drivers/of/.kunitconfig +++ b/drivers/of/.kunitconfig @@ -1,3 +1,4 @@ CONFIG_KUNIT=y CONFIG_OF=y CONFIG_OF_KUNIT_TEST=y +CONFIG_OF_OVERLAY_KUNIT_TEST=y diff --git a/drivers/of/Kconfig b/drivers/of/Kconfig index dd726c7056bf..0e2d608c3e20 100644 --- a/drivers/of/Kconfig +++ b/drivers/of/Kconfig @@ -107,6 +107,16 @@ config OF_OVERLAY While this option is selected automatically when needed, you can enable it manually to improve device tree unit test coverage. +config OF_OVERLAY_KUNIT_TEST + tristate "Device Tree overlay KUnit tests" if !KUNIT_ALL_TESTS + depends on KUNIT + default KUNIT_ALL_TESTS + select OF_OVERLAY + help + This option builds KUnit unit tests for the device tree overlay code. + + If unsure, say N here, but this option is safe to enable. + config OF_NUMA bool diff --git a/drivers/of/Makefile b/drivers/of/Makefile index 2ae909adde49..abd9c578343b 100644 --- a/drivers/of/Makefile +++ b/drivers/of/Makefile @@ -21,5 +21,6 @@ endif obj-$(CONFIG_KUNIT) += of_kunit_helpers.o obj-$(CONFIG_OF_KUNIT_TEST) += of_test.o +obj-$(CONFIG_OF_OVERLAY_KUNIT_TEST) += overlay_test.o kunit_overlay_test.dtbo.o obj-$(CONFIG_OF_UNITTEST) += unittest-data/ diff --git a/drivers/of/kunit_overlay_test.dtso b/drivers/of/kunit_overlay_test.dtso new file mode 100644 index 000000000000..85f20b4b4c16 --- /dev/null +++ b/drivers/of/kunit_overlay_test.dtso @@ -0,0 +1,9 @@ +// SPDX-License-Identifier: GPL-2.0 +/dts-v1/; +/plugin/; + +&{/} { + kunit-test { + compatible = "test,empty"; + }; +}; diff --git a/drivers/of/overlay_test.c b/drivers/of/overlay_test.c new file mode 100644 index 000000000000..9a8083c3a659 --- /dev/null +++ b/drivers/of/overlay_test.c @@ -0,0 +1,116 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * KUnit tests for device tree overlays + */ +#include <linux/device/bus.h> +#include <linux/kconfig.h> +#include <linux/of.h> +#include <linux/of_platform.h> +#include <linux/platform_device.h> + +#include <kunit/of.h> +#include <kunit/test.h> + +static const char * const kunit_node_name = "kunit-test"; +static const char * const kunit_compatible = "test,empty"; + +/* Test that of_overlay_apply_kunit() adds a node to the live tree */ +static void of_overlay_apply_kunit_apply(struct kunit *test) +{ + struct device_node *np; + + KUNIT_ASSERT_EQ(test, 0, + of_overlay_apply_kunit(test, kunit_overlay_test)); + + np = of_find_node_by_name(NULL, kunit_node_name); + KUNIT_EXPECT_NOT_ERR_OR_NULL(test, np); + of_node_put(np); +} + +/* + * Test that of_overlay_apply_kunit() creates platform devices with the + * expected device_node + */ +static void of_overlay_apply_kunit_platform_device(struct kunit *test) +{ + struct platform_device *pdev; + struct device_node *np; + + KUNIT_ASSERT_EQ(test, 0, + of_overlay_apply_kunit(test, kunit_overlay_test)); + + np = of_find_node_by_name(NULL, kunit_node_name); + of_node_put_kunit(test, np); + KUNIT_ASSERT_NOT_ERR_OR_NULL(test, np); + + pdev = of_find_device_by_node(np); + KUNIT_EXPECT_NOT_ERR_OR_NULL(test, pdev); + if (pdev) + put_device(&pdev->dev); +} + +static int of_overlay_bus_match_compatible(struct device *dev, const void *data) +{ + return of_device_is_compatible(dev->of_node, data); +} + +/* Test that of_overlay_apply_kunit() cleans up after the test is finished */ +static void of_overlay_apply_kunit_cleanup(struct kunit *test) +{ + struct kunit fake; + struct platform_device *pdev; + struct device *dev; + struct device_node *np; + + if (!IS_ENABLED(CONFIG_OF_OVERLAY)) + kunit_skip(test, "requires CONFIG_OF_OVERLAY"); + if (!IS_ENABLED(CONFIG_OF_EARLY_FLATTREE)) + kunit_skip(test, "requires CONFIG_OF_EARLY_FLATTREE for root node"); + + kunit_init_test(&fake, "fake test", NULL); + KUNIT_ASSERT_EQ(test, fake.status, KUNIT_SUCCESS); + + KUNIT_ASSERT_EQ(test, 0, + of_overlay_apply_kunit(&fake, kunit_overlay_test)); + + np = of_find_node_by_name(NULL, kunit_node_name); + of_node_put(np); /* Not derefing 'np' after this */ + KUNIT_ASSERT_NOT_ERR_OR_NULL(test, np); + + pdev = of_find_device_by_node(np); + KUNIT_ASSERT_NOT_ERR_OR_NULL(test, pdev); + put_device(&pdev->dev); /* Not derefing 'pdev' after this */ + + /* Remove overlay */ + kunit_cleanup(&fake); + + /* The node and device should be removed */ + np = of_find_node_by_name(NULL, kunit_node_name); + KUNIT_EXPECT_PTR_EQ(test, NULL, np); + of_node_put(np); + + dev = bus_find_device(&platform_bus_type, NULL, kunit_compatible, + of_overlay_bus_match_compatible); + KUNIT_EXPECT_PTR_EQ(test, NULL, dev); + put_device(dev); +} + +static struct kunit_case of_overlay_apply_kunit_test_cases[] = { + KUNIT_CASE(of_overlay_apply_kunit_apply), + KUNIT_CASE(of_overlay_apply_kunit_platform_device), + KUNIT_CASE(of_overlay_apply_kunit_cleanup), + {} +}; + +/* + * Test suite for test managed device tree overlays. + */ +static struct kunit_suite of_overlay_apply_kunit_suite = { + .name = "of_overlay_apply_kunit", + .test_cases = of_overlay_apply_kunit_test_cases, +}; + +kunit_test_suites( + &of_overlay_apply_kunit_suite, +); +MODULE_LICENSE("GPL");