1 /* SPDX-License-Identifier: GPL-2.0 */ 1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _KUNIT_OF_H 2 #ifndef _KUNIT_OF_H
3 #define _KUNIT_OF_H 3 #define _KUNIT_OF_H
4 4
5 #include <kunit/test.h> 5 #include <kunit/test.h>
6 6
7 struct device_node; 7 struct device_node;
8 8
9 #ifdef CONFIG_OF 9 #ifdef CONFIG_OF
10 10
11 void of_node_put_kunit(struct kunit *test, str 11 void of_node_put_kunit(struct kunit *test, struct device_node *node);
12 12
13 #else 13 #else
14 14
15 static inline 15 static inline
16 void of_node_put_kunit(struct kunit *test, str 16 void of_node_put_kunit(struct kunit *test, struct device_node *node)
17 { 17 {
18 kunit_skip(test, "requires CONFIG_OF") 18 kunit_skip(test, "requires CONFIG_OF");
19 } 19 }
20 20
21 #endif /* !CONFIG_OF */ 21 #endif /* !CONFIG_OF */
22 22
23 #if defined(CONFIG_OF) && defined(CONFIG_OF_OV 23 #if defined(CONFIG_OF) && defined(CONFIG_OF_OVERLAY) && defined(CONFIG_OF_EARLY_FLATTREE)
24 24
25 int of_overlay_fdt_apply_kunit(struct kunit *t 25 int of_overlay_fdt_apply_kunit(struct kunit *test, void *overlay_fdt,
26 u32 overlay_fdt 26 u32 overlay_fdt_size, int *ovcs_id);
27 #else 27 #else
28 28
29 static inline int 29 static inline int
30 of_overlay_fdt_apply_kunit(struct kunit *test, 30 of_overlay_fdt_apply_kunit(struct kunit *test, void *overlay_fdt,
31 u32 overlay_fdt_siz 31 u32 overlay_fdt_size, int *ovcs_id)
32 { 32 {
33 kunit_skip(test, "requires CONFIG_OF a 33 kunit_skip(test, "requires CONFIG_OF and CONFIG_OF_OVERLAY and CONFIG_OF_EARLY_FLATTREE for root node");
34 return -EINVAL; 34 return -EINVAL;
35 } 35 }
36 36
37 #endif 37 #endif
38 38
39 /** 39 /**
40 * __of_overlay_apply_kunit() - Test managed o 40 * __of_overlay_apply_kunit() - Test managed of_overlay_fdt_apply() variant
41 * @test: test context 41 * @test: test context
42 * @overlay_begin: start address of overlay to 42 * @overlay_begin: start address of overlay to apply
43 * @overlay_end: end address of overlay to app 43 * @overlay_end: end address of overlay to apply
44 * 44 *
45 * This is mostly internal API. See of_overlay 45 * This is mostly internal API. See of_overlay_apply_kunit() for the wrapper
46 * that makes this easier to use. 46 * that makes this easier to use.
47 * 47 *
48 * Similar to of_overlay_fdt_apply(), except t 48 * Similar to of_overlay_fdt_apply(), except the overlay is managed by the test
49 * case and is automatically removed with of_o 49 * case and is automatically removed with of_overlay_remove() after the test
50 * case concludes. 50 * case concludes.
51 * 51 *
52 * Return: 0 on success, negative errno on fai 52 * Return: 0 on success, negative errno on failure
53 */ 53 */
54 static inline int __of_overlay_apply_kunit(str 54 static inline int __of_overlay_apply_kunit(struct kunit *test,
55 u8 55 u8 *overlay_begin,
56 con 56 const u8 *overlay_end)
57 { 57 {
58 int unused; 58 int unused;
59 59
60 return of_overlay_fdt_apply_kunit(test 60 return of_overlay_fdt_apply_kunit(test, overlay_begin,
61 over 61 overlay_end - overlay_begin,
62 &unu 62 &unused);
63 } 63 }
64 64
65 /** 65 /**
66 * of_overlay_apply_kunit() - Test managed of_ 66 * of_overlay_apply_kunit() - Test managed of_overlay_fdt_apply() for built-in overlays
67 * @test: test context 67 * @test: test context
68 * @overlay_name: name of overlay to apply 68 * @overlay_name: name of overlay to apply
69 * 69 *
70 * This macro is used to apply a device tree o 70 * This macro is used to apply a device tree overlay built with the
71 * cmd_dt_S_dtbo rule in scripts/Makefile.lib 71 * cmd_dt_S_dtbo rule in scripts/Makefile.lib that has been compiled into the
72 * kernel image or KUnit test module. The over 72 * kernel image or KUnit test module. The overlay is automatically removed when
73 * the test is finished. 73 * the test is finished.
74 * 74 *
75 * Unit tests that need device tree nodes shou 75 * Unit tests that need device tree nodes should compile an overlay file with
76 * @overlay_name\.dtbo.o in their Makefile alo 76 * @overlay_name\.dtbo.o in their Makefile along with their unit test and then
77 * load the overlay during their test. The @ov 77 * load the overlay during their test. The @overlay_name matches the filename
78 * of the overlay without the dtbo filename ex 78 * of the overlay without the dtbo filename extension. If CONFIG_OF_OVERLAY is
79 * not enabled, the @test will be skipped. 79 * not enabled, the @test will be skipped.
80 * 80 *
81 * In the Makefile 81 * In the Makefile
82 * 82 *
83 * .. code-block:: none 83 * .. code-block:: none
84 * 84 *
85 * obj-$(CONFIG_OF_OVERLAY_KUNIT_TEST) += 85 * obj-$(CONFIG_OF_OVERLAY_KUNIT_TEST) += overlay_test.o kunit_overlay_test.dtbo.o
86 * 86 *
87 * In the test 87 * In the test
88 * 88 *
89 * .. code-block:: c 89 * .. code-block:: c
90 * 90 *
91 * static void of_overlay_kunit_of_overla 91 * static void of_overlay_kunit_of_overlay_apply(struct kunit *test)
92 * { 92 * {
93 * struct device_node *np; 93 * struct device_node *np;
94 * 94 *
95 * KUNIT_ASSERT_EQ(test, 0, 95 * KUNIT_ASSERT_EQ(test, 0,
96 * of_overlay_app 96 * of_overlay_apply_kunit(test, kunit_overlay_test));
97 * 97 *
98 * np = of_find_node_by_name(NULL 98 * np = of_find_node_by_name(NULL, "test-kunit");
99 * KUNIT_EXPECT_NOT_ERR_OR_NULL(t 99 * KUNIT_EXPECT_NOT_ERR_OR_NULL(test, np);
100 * of_node_put(np); 100 * of_node_put(np);
101 * } 101 * }
102 * 102 *
103 * Return: 0 on success, negative errno on fai 103 * Return: 0 on success, negative errno on failure.
104 */ 104 */
105 #define of_overlay_apply_kunit(test, overlay_n 105 #define of_overlay_apply_kunit(test, overlay_name) \
106 ({ 106 ({ \
107 extern uint8_t __dtbo_##overlay_name## 107 extern uint8_t __dtbo_##overlay_name##_begin[]; \
108 extern uint8_t __dtbo_##overlay_name## 108 extern uint8_t __dtbo_##overlay_name##_end[]; \
109 109 \
110 __of_overlay_apply_kunit((test), 110 __of_overlay_apply_kunit((test), \
111 __dtbo_##overlay_name# 111 __dtbo_##overlay_name##_begin, \
112 __dtbo_##overlay_name# 112 __dtbo_##overlay_name##_end); \
113 }) 113 })
114 114
115 #endif 115 #endif
116 116
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.