116 lines · c
1/* SPDX-License-Identifier: GPL-2.0 */2#ifndef _KUNIT_OF_H3#define _KUNIT_OF_H4 5#include <kunit/test.h>6 7struct device_node;8 9#ifdef CONFIG_OF10 11void of_node_put_kunit(struct kunit *test, struct device_node *node);12 13#else14 15static inline16void of_node_put_kunit(struct kunit *test, struct device_node *node)17{18 kunit_skip(test, "requires CONFIG_OF");19}20 21#endif /* !CONFIG_OF */22 23#if defined(CONFIG_OF) && defined(CONFIG_OF_OVERLAY) && defined(CONFIG_OF_EARLY_FLATTREE)24 25int of_overlay_fdt_apply_kunit(struct kunit *test, void *overlay_fdt,26 u32 overlay_fdt_size, int *ovcs_id);27#else28 29static inline int30of_overlay_fdt_apply_kunit(struct kunit *test, void *overlay_fdt,31 u32 overlay_fdt_size, int *ovcs_id)32{33 kunit_skip(test, "requires CONFIG_OF and CONFIG_OF_OVERLAY and CONFIG_OF_EARLY_FLATTREE for root node");34 return -EINVAL;35}36 37#endif38 39/**40 * __of_overlay_apply_kunit() - Test managed of_overlay_fdt_apply() variant41 * @test: test context42 * @overlay_begin: start address of overlay to apply43 * @overlay_end: end address of overlay to apply44 *45 * This is mostly internal API. See of_overlay_apply_kunit() for the wrapper46 * that makes this easier to use.47 *48 * Similar to of_overlay_fdt_apply(), except the overlay is managed by the test49 * case and is automatically removed with of_overlay_remove() after the test50 * case concludes.51 *52 * Return: 0 on success, negative errno on failure53 */54static inline int __of_overlay_apply_kunit(struct kunit *test,55 u8 *overlay_begin,56 const u8 *overlay_end)57{58 int unused;59 60 return of_overlay_fdt_apply_kunit(test, overlay_begin,61 overlay_end - overlay_begin,62 &unused);63}64 65/**66 * of_overlay_apply_kunit() - Test managed of_overlay_fdt_apply() for built-in overlays67 * @test: test context68 * @overlay_name: name of overlay to apply69 *70 * This macro is used to apply a device tree overlay built with the71 * cmd_dt_S_dtbo rule in scripts/Makefile.lib that has been compiled into the72 * kernel image or KUnit test module. The overlay is automatically removed when73 * the test is finished.74 *75 * Unit tests that need device tree nodes should compile an overlay file with76 * @overlay_name\.dtbo.o in their Makefile along with their unit test and then77 * load the overlay during their test. The @overlay_name matches the filename78 * of the overlay without the dtbo filename extension. If CONFIG_OF_OVERLAY is79 * not enabled, the @test will be skipped.80 *81 * In the Makefile82 *83 * .. code-block:: none84 *85 * obj-$(CONFIG_OF_OVERLAY_KUNIT_TEST) += overlay_test.o kunit_overlay_test.dtbo.o86 *87 * In the test88 *89 * .. code-block:: c90 *91 * static void of_overlay_kunit_of_overlay_apply(struct kunit *test)92 * {93 * struct device_node *np;94 *95 * KUNIT_ASSERT_EQ(test, 0,96 * of_overlay_apply_kunit(test, kunit_overlay_test));97 *98 * np = of_find_node_by_name(NULL, "test-kunit");99 * KUNIT_EXPECT_NOT_ERR_OR_NULL(test, np);100 * of_node_put(np);101 * }102 *103 * Return: 0 on success, negative errno on failure.104 */105#define of_overlay_apply_kunit(test, overlay_name) \106({ \107 extern uint8_t __dtbo_##overlay_name##_begin[]; \108 extern uint8_t __dtbo_##overlay_name##_end[]; \109 \110 __of_overlay_apply_kunit((test), \111 __dtbo_##overlay_name##_begin, \112 __dtbo_##overlay_name##_end); \113})114 115#endif116