From patchwork Mon Mar 27 22:21:53 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Boyd X-Patchwork-Id: 75716 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp1827669vqo; Mon, 27 Mar 2023 15:31:25 -0700 (PDT) X-Google-Smtp-Source: AKy350a9TCJcynEOK65kTvLUH5nWkEvgaw/dUXS7rOUVRxkybChWQ6YrRH5/Hl1OWBIQ1wzkpMuS X-Received: by 2002:a17:906:c0cc:b0:93a:353d:e38b with SMTP id bn12-20020a170906c0cc00b0093a353de38bmr14346456ejb.37.1679956285088; Mon, 27 Mar 2023 15:31:25 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1679956285; cv=none; d=google.com; s=arc-20160816; b=D3meBkD+NK279Cr0a/2GfHg8yCfjTPuVJNFRwiV6U0h90436QcaUt5HLXIW8UoUOyN w8bAjDQazJiKgAJc5hHlJAyr369sKmwz6t1n6hcdpQzzJq1wFBOOY/H1rvv7ucz6PUaq PLd2XkJP7rp4DCSbyuYL+HgPPzVP7ykzQtsPEihew7KYLsL0Qg+deNDO6iNnpIZFYaY9 EEVtsK/r7f0zHWrItG4tE/CgES1taaypIVv0o5Y/ebB3BrugB5Jggbp/hy++pudpivR5 N4DQ7SmabNdVZ+FCRUELlQ/EnoWgh0rY/q+EKfClCJwpBQ/1tB+MVwg2cbnofxhpSC6Z Iojw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=6JsbMFJhFi3i05PKn1W+kjT6FXyas0i3g4wvbjWKT38=; b=Ubu82mQegOrIPtCKzGeP8qReIbhOcxvbOs0q+WJp8YjGkQpmbPT3sNkEKAvNfneS9b FjiDjh+jlibJDhZCJerTsFsJmZAOTKTAcmu+WmJuxNPWaxEVVYtAVIL7pTyrFOMh591+ tbVML8bB9nfqYkS7YMeUq/7b9sVB97JYE2ftIfW4VxGdmesn7PpZCOSQTgNYwH/1HiuD CBaNKeZ3lP+hTXqZ3sLLBfym305Xj3qfTV1GYdnE8DAaR1jwr82/irEFnBV52HaC6HLU 4V4OrcVwtKA22YHHEPWwnqylWwc4XPjlpKpT65FAYdJIZhsHaYb+9NKXNzeaamIQo7qK j6jg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=GNvncrQL; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id hs40-20020a1709073ea800b008b3b05ca5ebsi35123847ejc.40.2023.03.27.15.30.59; Mon, 27 Mar 2023 15:31:25 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=GNvncrQL; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232341AbjC0WWZ (ORCPT + 99 others); Mon, 27 Mar 2023 18:22:25 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53770 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231873AbjC0WWH (ORCPT ); Mon, 27 Mar 2023 18:22:07 -0400 Received: from ams.source.kernel.org (ams.source.kernel.org [IPv6:2604:1380:4601:e00::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2BC6D3592; Mon, 27 Mar 2023 15:22:06 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ams.source.kernel.org (Postfix) with ESMTPS id CF1B6B819A8; Mon, 27 Mar 2023 22:22:04 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 0886AC433A0; Mon, 27 Mar 2023 22:22:04 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1679955724; bh=MjA1FsmqJ2V7HV543zNN1KKNIL0mEuDUBkfHr047Y8g=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=GNvncrQLX2RhgBggXKCW1d2W0HHNHDHlYzODMXgsmZgBSpwuIv8otCUMqNoGE+vof 3T7rGuPAg+8xYqIcEN0KEdsbwVGNbp9EZjnvfl/N33JnM5/DTeW6ftkaqHlXzEklaR +KaxLhet4tUp8WnE8+gCvdDq//ndXztpanQHWz8U/Ge18tGC1Qd8blv5AyeeqQVnV7 8XdiyzOnumJl1YHoAwKjyrCeUwim6Cqb7DbSlJ2mPC41CZfQWyjCvJVSEpolBtPL9p 13Pv+x6pBJt53C3k/QhAtDCjgVrVSzBjjSfXYKLjp+jpZ+PuH+cpTxCOLOuj5XMlmc Hyzz3VtdZ/y6Q== From: Stephen Boyd To: Michael Turquette , Stephen Boyd Cc: linux-kernel@vger.kernel.org, linux-clk@vger.kernel.org, patches@lists.linux.dev, Brendan Higgins , David Gow , Greg Kroah-Hartman , "Rafael J . Wysocki" , Rob Herring , Frank Rowand , Christian Marangi , Krzysztof Kozlowski , devicetree@vger.kernel.org, linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com, Maxime Ripard Subject: [PATCH v3 05/11] of: Add a KUnit test for overlays and test managed APIs Date: Mon, 27 Mar 2023 15:21:53 -0700 Message-Id: <20230327222159.3509818-6-sboyd@kernel.org> X-Mailer: git-send-email 2.40.0.348.gf938b09366-goog In-Reply-To: <20230327222159.3509818-1-sboyd@kernel.org> References: <20230327222159.3509818-1-sboyd@kernel.org> MIME-Version: 1.0 X-Spam-Status: No, score=-2.5 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1761561841735441676?= X-GMAIL-MSGID: =?utf-8?q?1761561841735441676?= Test the KUnit test managed overlay APIs. Confirm that platform devices are created and destroyed properly. This provides us confidence that the test managed 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 Cc: Frank Rowand Signed-off-by: Stephen Boyd --- drivers/of/.kunitconfig | 2 + drivers/of/Kconfig | 10 +++ drivers/of/Makefile | 1 + drivers/of/kunit_overlay_test.dtso | 9 +++ drivers/of/overlay_test.c | 110 +++++++++++++++++++++++++++++ 5 files changed, 132 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..7d570cb922a1 100644 --- a/drivers/of/.kunitconfig +++ b/drivers/of/.kunitconfig @@ -1,3 +1,5 @@ CONFIG_KUNIT=y CONFIG_OF=y CONFIG_OF_KUNIT_TEST=y +CONFIG_OF_OVERLAY=y +CONFIG_OF_OVERLAY_KUNIT_TEST=y diff --git a/drivers/of/Kconfig b/drivers/of/Kconfig index 1b995cecf5be..5bdeba11268d 100644 --- a/drivers/of/Kconfig +++ b/drivers/of/Kconfig @@ -113,6 +113,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 OF_OVERLAY + depends on KUNIT + default KUNIT_ALL_TESTS + 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 c694f998b9f5..2ad60d5b87ac 100644 --- a/drivers/of/Makefile +++ b/drivers/of/Makefile @@ -21,5 +21,6 @@ endif obj-$(CONFIG_KUNIT) += of_kunit.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..66b1dceea568 --- /dev/null +++ b/drivers/of/overlay_test.c @@ -0,0 +1,110 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * KUnit tests for device tree overlays + */ +#include +#include +#include +#include + +#include +#include + +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); +} + +static int bus_match_np(struct device *dev, const void *data) +{ + const struct device_node *np = data; + + return np == dev->of_node; +} + +/* + * 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 device *dev; + 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); + + dev = bus_find_device(&platform_bus_type, NULL, np, bus_match_np); + KUNIT_EXPECT_NOT_ERR_OR_NULL(test, dev); + put_device(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 device *dev; + 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(np); /* Not derefing 'np' after this */ + KUNIT_ASSERT_NOT_ERR_OR_NULL(test, np); + + dev = bus_find_device(&platform_bus_type, NULL, np, bus_match_np); + put_device(dev); /* Not derefing 'device' after this */ + KUNIT_ASSERT_NOT_ERR_OR_NULL(test, dev); + + /* Remove overlay */ + kunit_cleanup(test); + + 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");