summaryrefslogtreecommitdiff
path: root/lib/util_macros_kunit.c
blob: 94cc9f0de50ab143910d2717402cde9acaba2000 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
// SPDX-License-Identifier: GPL-2.0+
/*
 * Test cases for bitfield helpers.
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <kunit/test.h>
#include <linux/util_macros.h>

#define FIND_CLOSEST_RANGE_CHECK(from, to, array, exp_idx)		\
{									\
	int i;								\
	for (i = from; i <= to; i++) {					\
		int found = find_closest(i, array, ARRAY_SIZE(array));	\
		KUNIT_ASSERT_EQ(ctx, exp_idx, found);			\
	}								\
}

static void test_find_closest(struct kunit *ctx)
{
	/* This will test a few arrays that are found in drivers */
	static const int ina226_avg_tab[] = { 1, 4, 16, 64, 128, 256, 512, 1024 };
	static const unsigned int ad7616_oversampling_avail[] = {
		1, 2, 4, 8, 16, 32, 64, 128,
	};
	static u32 wd_timeout_table[] = { 2, 4, 6, 8, 16, 32, 48, 64 };
	static int array_prog1a[] = { 1, 2, 3, 4, 5 };
	static u32 array_prog1b[] = { 2, 3, 4, 5, 6 };
	static int array_prog1mix[] = { -2, -1, 0, 1, 2 };
	static int array_prog2a[] = { 1, 3, 5, 7 };
	static u32 array_prog2b[] = { 2, 4, 6, 8 };
	static int array_prog3a[] = { 1, 4, 7, 10 };
	static u32 array_prog3b[] = { 2, 5, 8, 11 };
	static int array_prog4a[] = { 1, 5, 9, 13 };
	static u32 array_prog4b[] = { 2, 6, 10, 14 };

	FIND_CLOSEST_RANGE_CHECK(-3, 2, ina226_avg_tab, 0);
	FIND_CLOSEST_RANGE_CHECK(3, 10, ina226_avg_tab, 1);
	FIND_CLOSEST_RANGE_CHECK(11, 40, ina226_avg_tab, 2);
	FIND_CLOSEST_RANGE_CHECK(41, 96, ina226_avg_tab, 3);
	FIND_CLOSEST_RANGE_CHECK(97, 192, ina226_avg_tab, 4);
	FIND_CLOSEST_RANGE_CHECK(193, 384, ina226_avg_tab, 5);
	FIND_CLOSEST_RANGE_CHECK(385, 768, ina226_avg_tab, 6);
	FIND_CLOSEST_RANGE_CHECK(769, 2048, ina226_avg_tab, 7);

	/* The array that found the bug that caused this kunit to exist */
	FIND_CLOSEST_RANGE_CHECK(-3, 1, ad7616_oversampling_avail, 0);
	FIND_CLOSEST_RANGE_CHECK(2, 3, ad7616_oversampling_avail, 1);
	FIND_CLOSEST_RANGE_CHECK(4, 6, ad7616_oversampling_avail, 2);
	FIND_CLOSEST_RANGE_CHECK(7, 12, ad7616_oversampling_avail, 3);
	FIND_CLOSEST_RANGE_CHECK(13, 24, ad7616_oversampling_avail, 4);
	FIND_CLOSEST_RANGE_CHECK(25, 48, ad7616_oversampling_avail, 5);
	FIND_CLOSEST_RANGE_CHECK(49, 96, ad7616_oversampling_avail, 6);
	FIND_CLOSEST_RANGE_CHECK(97, 256, ad7616_oversampling_avail, 7);

	FIND_CLOSEST_RANGE_CHECK(-3, 3, wd_timeout_table, 0);
	FIND_CLOSEST_RANGE_CHECK(4, 5, wd_timeout_table, 1);
	FIND_CLOSEST_RANGE_CHECK(6, 7, wd_timeout_table, 2);
	FIND_CLOSEST_RANGE_CHECK(8, 12, wd_timeout_table, 3);
	FIND_CLOSEST_RANGE_CHECK(13, 24, wd_timeout_table, 4);
	FIND_CLOSEST_RANGE_CHECK(25, 40, wd_timeout_table, 5);
	FIND_CLOSEST_RANGE_CHECK(41, 56, wd_timeout_table, 6);
	FIND_CLOSEST_RANGE_CHECK(57, 128, wd_timeout_table, 7);

	/* One could argue that find_closest() should not be used for monotonic
	 * arrays (like 1,2,3,4,5), but even so, it should work as long as the
	 * array is sorted ascending. */
	FIND_CLOSEST_RANGE_CHECK(-3, 1, array_prog1a, 0);
	FIND_CLOSEST_RANGE_CHECK(2, 2, array_prog1a, 1);
	FIND_CLOSEST_RANGE_CHECK(3, 3, array_prog1a, 2);
	FIND_CLOSEST_RANGE_CHECK(4, 4, array_prog1a, 3);
	FIND_CLOSEST_RANGE_CHECK(5, 8, array_prog1a, 4);

	FIND_CLOSEST_RANGE_CHECK(-3, 2, array_prog1b, 0);
	FIND_CLOSEST_RANGE_CHECK(3, 3, array_prog1b, 1);
	FIND_CLOSEST_RANGE_CHECK(4, 4, array_prog1b, 2);
	FIND_CLOSEST_RANGE_CHECK(5, 5, array_prog1b, 3);
	FIND_CLOSEST_RANGE_CHECK(6, 8, array_prog1b, 4);

	FIND_CLOSEST_RANGE_CHECK(-4, -2, array_prog1mix, 0);
	FIND_CLOSEST_RANGE_CHECK(-1, -1, array_prog1mix, 1);
	FIND_CLOSEST_RANGE_CHECK(0, 0, array_prog1mix, 2);
	FIND_CLOSEST_RANGE_CHECK(1, 1, array_prog1mix, 3);
	FIND_CLOSEST_RANGE_CHECK(2, 5, array_prog1mix, 4);

	FIND_CLOSEST_RANGE_CHECK(-3, 2, array_prog2a, 0);
	FIND_CLOSEST_RANGE_CHECK(3, 4, array_prog2a, 1);
	FIND_CLOSEST_RANGE_CHECK(5, 6, array_prog2a, 2);
	FIND_CLOSEST_RANGE_CHECK(7, 10, array_prog2a, 3);

	FIND_CLOSEST_RANGE_CHECK(-3, 3, array_prog2b, 0);
	FIND_CLOSEST_RANGE_CHECK(4, 5, array_prog2b, 1);
	FIND_CLOSEST_RANGE_CHECK(6, 7, array_prog2b, 2);
	FIND_CLOSEST_RANGE_CHECK(8, 10, array_prog2b, 3);

	FIND_CLOSEST_RANGE_CHECK(-3, 2, array_prog3a, 0);
	FIND_CLOSEST_RANGE_CHECK(3, 5, array_prog3a, 1);
	FIND_CLOSEST_RANGE_CHECK(6, 8, array_prog3a, 2);
	FIND_CLOSEST_RANGE_CHECK(9, 20, array_prog3a, 3);

	FIND_CLOSEST_RANGE_CHECK(-3, 3, array_prog3b, 0);
	FIND_CLOSEST_RANGE_CHECK(4, 6, array_prog3b, 1);
	FIND_CLOSEST_RANGE_CHECK(7, 9, array_prog3b, 2);
	FIND_CLOSEST_RANGE_CHECK(10, 20, array_prog3b, 3);

	FIND_CLOSEST_RANGE_CHECK(-3, 3, array_prog4a, 0);
	FIND_CLOSEST_RANGE_CHECK(4, 7, array_prog4a, 1);
	FIND_CLOSEST_RANGE_CHECK(8, 11, array_prog4a, 2);
	FIND_CLOSEST_RANGE_CHECK(12, 20, array_prog4a, 3);

	FIND_CLOSEST_RANGE_CHECK(-3, 4, array_prog4b, 0);
	FIND_CLOSEST_RANGE_CHECK(5, 8, array_prog4b, 1);
	FIND_CLOSEST_RANGE_CHECK(9, 12, array_prog4b, 2);
	FIND_CLOSEST_RANGE_CHECK(13, 20, array_prog4b, 3);
}

#define FIND_CLOSEST_DESC_RANGE_CHECK(from, to, array, exp_idx)	\
{									\
	int i;								\
	for (i = from; i <= to; i++) {					\
		int found = find_closest_descending(i, array,		\
						ARRAY_SIZE(array));	\
		KUNIT_ASSERT_EQ(ctx, exp_idx, found);			\
	}								\
}

static void test_find_closest_descending(struct kunit *ctx)
{
	/* Same arrays as 'test_find_closest' but reversed */
	static const int ina226_avg_tab[] = { 1024, 512, 256, 128, 64, 16, 4, 1 };
	static const unsigned int ad7616_oversampling_avail[] = {
		128, 64, 32, 16, 8, 4, 2, 1
	};
	static u32 wd_timeout_table[] = { 64, 48, 32, 16, 8, 6, 4, 2 };
	static int array_prog1a[] = { 5, 4, 3, 2, 1 };
	static u32 array_prog1b[] = { 6, 5, 4, 3, 2 };
	static int array_prog1mix[] = { 2, 1, 0, -1, -2 };
	static int array_prog2a[] = { 7, 5, 3, 1 };
	static u32 array_prog2b[] = { 8, 6, 4, 2 };
	static int array_prog3a[] = { 10, 7, 4, 1 };
	static u32 array_prog3b[] = { 11, 8, 5, 2 };
	static int array_prog4a[] = { 13, 9, 5, 1 };
	static u32 array_prog4b[] = { 14, 10, 6, 2 };

	FIND_CLOSEST_DESC_RANGE_CHECK(-3, 2, ina226_avg_tab, 7);
	FIND_CLOSEST_DESC_RANGE_CHECK(3, 10, ina226_avg_tab, 6);
	FIND_CLOSEST_DESC_RANGE_CHECK(11, 40, ina226_avg_tab, 5);
	FIND_CLOSEST_DESC_RANGE_CHECK(41, 96, ina226_avg_tab, 4);
	FIND_CLOSEST_DESC_RANGE_CHECK(97, 192, ina226_avg_tab, 3);
	FIND_CLOSEST_DESC_RANGE_CHECK(193, 384, ina226_avg_tab, 2);
	FIND_CLOSEST_DESC_RANGE_CHECK(385, 768, ina226_avg_tab, 1);
	FIND_CLOSEST_DESC_RANGE_CHECK(769, 2048, ina226_avg_tab, 0);

	FIND_CLOSEST_DESC_RANGE_CHECK(-3, 1, ad7616_oversampling_avail, 7);
	FIND_CLOSEST_DESC_RANGE_CHECK(2, 3, ad7616_oversampling_avail, 6);
	FIND_CLOSEST_DESC_RANGE_CHECK(4, 6, ad7616_oversampling_avail, 5);
	FIND_CLOSEST_DESC_RANGE_CHECK(7, 12, ad7616_oversampling_avail, 4);
	FIND_CLOSEST_DESC_RANGE_CHECK(13, 24, ad7616_oversampling_avail, 3);
	FIND_CLOSEST_DESC_RANGE_CHECK(25, 48, ad7616_oversampling_avail, 2);
	FIND_CLOSEST_DESC_RANGE_CHECK(49, 96, ad7616_oversampling_avail, 1);
	FIND_CLOSEST_DESC_RANGE_CHECK(97, 256, ad7616_oversampling_avail, 0);

	FIND_CLOSEST_DESC_RANGE_CHECK(-3, 3, wd_timeout_table, 7);
	FIND_CLOSEST_DESC_RANGE_CHECK(4, 5, wd_timeout_table, 6);
	FIND_CLOSEST_DESC_RANGE_CHECK(6, 7, wd_timeout_table, 5);
	FIND_CLOSEST_DESC_RANGE_CHECK(8, 12, wd_timeout_table, 4);
	FIND_CLOSEST_DESC_RANGE_CHECK(13, 24, wd_timeout_table, 3);
	FIND_CLOSEST_DESC_RANGE_CHECK(25, 40, wd_timeout_table, 2);
	FIND_CLOSEST_DESC_RANGE_CHECK(41, 56, wd_timeout_table, 1);
	FIND_CLOSEST_DESC_RANGE_CHECK(57, 128, wd_timeout_table, 0);

	/* One could argue that find_closest_descending() should not be used
	 * for monotonic arrays (like 5,4,3,2,1), but even so, it should still
	 * it should work as long as the array is sorted descending. */
	FIND_CLOSEST_DESC_RANGE_CHECK(-3, 1, array_prog1a, 4);
	FIND_CLOSEST_DESC_RANGE_CHECK(2, 2, array_prog1a, 3);
	FIND_CLOSEST_DESC_RANGE_CHECK(3, 3, array_prog1a, 2);
	FIND_CLOSEST_DESC_RANGE_CHECK(4, 4, array_prog1a, 1);
	FIND_CLOSEST_DESC_RANGE_CHECK(5, 8, array_prog1a, 0);

	FIND_CLOSEST_DESC_RANGE_CHECK(-3, 2, array_prog1b, 4);
	FIND_CLOSEST_DESC_RANGE_CHECK(3, 3, array_prog1b, 3);
	FIND_CLOSEST_DESC_RANGE_CHECK(4, 4, array_prog1b, 2);
	FIND_CLOSEST_DESC_RANGE_CHECK(5, 5, array_prog1b, 1);
	FIND_CLOSEST_DESC_RANGE_CHECK(6, 8, array_prog1b, 0);

	FIND_CLOSEST_DESC_RANGE_CHECK(-4, -2, array_prog1mix, 4);
	FIND_CLOSEST_DESC_RANGE_CHECK(-1, -1, array_prog1mix, 3);
	FIND_CLOSEST_DESC_RANGE_CHECK(0, 0, array_prog1mix, 2);
	FIND_CLOSEST_DESC_RANGE_CHECK(1, 1, array_prog1mix, 1);
	FIND_CLOSEST_DESC_RANGE_CHECK(2, 5, array_prog1mix, 0);

	FIND_CLOSEST_DESC_RANGE_CHECK(-3, 2, array_prog2a, 3);
	FIND_CLOSEST_DESC_RANGE_CHECK(3, 4, array_prog2a, 2);
	FIND_CLOSEST_DESC_RANGE_CHECK(5, 6, array_prog2a, 1);
	FIND_CLOSEST_DESC_RANGE_CHECK(7, 10, array_prog2a, 0);

	FIND_CLOSEST_DESC_RANGE_CHECK(-3, 3, array_prog2b, 3);
	FIND_CLOSEST_DESC_RANGE_CHECK(4, 5, array_prog2b, 2);
	FIND_CLOSEST_DESC_RANGE_CHECK(6, 7, array_prog2b, 1);
	FIND_CLOSEST_DESC_RANGE_CHECK(8, 10, array_prog2b, 0);

	FIND_CLOSEST_DESC_RANGE_CHECK(-3, 2, array_prog3a, 3);
	FIND_CLOSEST_DESC_RANGE_CHECK(3, 5, array_prog3a, 2);
	FIND_CLOSEST_DESC_RANGE_CHECK(6, 8, array_prog3a, 1);
	FIND_CLOSEST_DESC_RANGE_CHECK(9, 20, array_prog3a, 0);

	FIND_CLOSEST_DESC_RANGE_CHECK(-3, 3, array_prog3b, 3);
	FIND_CLOSEST_DESC_RANGE_CHECK(4, 6, array_prog3b, 2);
	FIND_CLOSEST_DESC_RANGE_CHECK(7, 9, array_prog3b, 1);
	FIND_CLOSEST_DESC_RANGE_CHECK(10, 20, array_prog3b, 0);

	FIND_CLOSEST_DESC_RANGE_CHECK(-3, 3, array_prog4a, 3);
	FIND_CLOSEST_DESC_RANGE_CHECK(4, 7, array_prog4a, 2);
	FIND_CLOSEST_DESC_RANGE_CHECK(8, 11, array_prog4a, 1);
	FIND_CLOSEST_DESC_RANGE_CHECK(12, 20, array_prog4a, 0);

	FIND_CLOSEST_DESC_RANGE_CHECK(-3, 4, array_prog4b, 3);
	FIND_CLOSEST_DESC_RANGE_CHECK(5, 8, array_prog4b, 2);
	FIND_CLOSEST_DESC_RANGE_CHECK(9, 12, array_prog4b, 1);
	FIND_CLOSEST_DESC_RANGE_CHECK(13, 20, array_prog4b, 0);
}

static struct kunit_case __refdata util_macros_test_cases[] = {
	KUNIT_CASE(test_find_closest),
	KUNIT_CASE(test_find_closest_descending),
	{}
};

static struct kunit_suite util_macros_test_suite = {
	.name = "util_macros.h",
	.test_cases = util_macros_test_cases,
};

kunit_test_suites(&util_macros_test_suite);

MODULE_AUTHOR("Alexandru Ardelean <aardelean@baylibre.com>");
MODULE_DESCRIPTION("Test cases for util_macros.h helpers");
MODULE_LICENSE("GPL");