1d2585f51SVitor Massaru Iha // SPDX-License-Identifier: GPL-2.0+
2d2585f51SVitor Massaru Iha /*
3d2585f51SVitor Massaru Iha * Test cases for bitfield helpers.
4d2585f51SVitor Massaru Iha */
5d2585f51SVitor Massaru Iha
6d2585f51SVitor Massaru Iha #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
7d2585f51SVitor Massaru Iha
8d2585f51SVitor Massaru Iha #include <kunit/test.h>
9d2585f51SVitor Massaru Iha #include <linux/bitfield.h>
10d2585f51SVitor Massaru Iha
11d2585f51SVitor Massaru Iha #define CHECK_ENC_GET_U(tp, v, field, res) do { \
12d2585f51SVitor Massaru Iha { \
13d2585f51SVitor Massaru Iha u##tp _res; \
14d2585f51SVitor Massaru Iha \
15d2585f51SVitor Massaru Iha _res = u##tp##_encode_bits(v, field); \
16d2585f51SVitor Massaru Iha KUNIT_ASSERT_FALSE_MSG(context, _res != res, \
17d2585f51SVitor Massaru Iha "u" #tp "_encode_bits(" #v ", " #field ") is 0x%llx != " #res "\n", \
18d2585f51SVitor Massaru Iha (u64)_res); \
19d2585f51SVitor Massaru Iha KUNIT_ASSERT_FALSE(context, \
20d2585f51SVitor Massaru Iha u##tp##_get_bits(_res, field) != v); \
21d2585f51SVitor Massaru Iha } \
22d2585f51SVitor Massaru Iha } while (0)
23d2585f51SVitor Massaru Iha
24d2585f51SVitor Massaru Iha #define CHECK_ENC_GET_LE(tp, v, field, res) do { \
25d2585f51SVitor Massaru Iha { \
26d2585f51SVitor Massaru Iha __le##tp _res; \
27d2585f51SVitor Massaru Iha \
28d2585f51SVitor Massaru Iha _res = le##tp##_encode_bits(v, field); \
29d2585f51SVitor Massaru Iha KUNIT_ASSERT_FALSE_MSG(context, \
30d2585f51SVitor Massaru Iha _res != cpu_to_le##tp(res), \
31d2585f51SVitor Massaru Iha "le" #tp "_encode_bits(" #v ", " #field ") is 0x%llx != 0x%llx",\
32d2585f51SVitor Massaru Iha (u64)le##tp##_to_cpu(_res), \
33d2585f51SVitor Massaru Iha (u64)(res)); \
34d2585f51SVitor Massaru Iha KUNIT_ASSERT_FALSE(context, \
35d2585f51SVitor Massaru Iha le##tp##_get_bits(_res, field) != v);\
36d2585f51SVitor Massaru Iha } \
37d2585f51SVitor Massaru Iha } while (0)
38d2585f51SVitor Massaru Iha
39d2585f51SVitor Massaru Iha #define CHECK_ENC_GET_BE(tp, v, field, res) do { \
40d2585f51SVitor Massaru Iha { \
41d2585f51SVitor Massaru Iha __be##tp _res; \
42d2585f51SVitor Massaru Iha \
43d2585f51SVitor Massaru Iha _res = be##tp##_encode_bits(v, field); \
44d2585f51SVitor Massaru Iha KUNIT_ASSERT_FALSE_MSG(context, \
45d2585f51SVitor Massaru Iha _res != cpu_to_be##tp(res), \
46d2585f51SVitor Massaru Iha "be" #tp "_encode_bits(" #v ", " #field ") is 0x%llx != 0x%llx", \
47d2585f51SVitor Massaru Iha (u64)be##tp##_to_cpu(_res), \
48d2585f51SVitor Massaru Iha (u64)(res)); \
49d2585f51SVitor Massaru Iha KUNIT_ASSERT_FALSE(context, \
50d2585f51SVitor Massaru Iha be##tp##_get_bits(_res, field) != v);\
51d2585f51SVitor Massaru Iha } \
52d2585f51SVitor Massaru Iha } while (0)
53d2585f51SVitor Massaru Iha
54d2585f51SVitor Massaru Iha #define CHECK_ENC_GET(tp, v, field, res) do { \
55d2585f51SVitor Massaru Iha CHECK_ENC_GET_U(tp, v, field, res); \
56d2585f51SVitor Massaru Iha CHECK_ENC_GET_LE(tp, v, field, res); \
57d2585f51SVitor Massaru Iha CHECK_ENC_GET_BE(tp, v, field, res); \
58d2585f51SVitor Massaru Iha } while (0)
59d2585f51SVitor Massaru Iha
test_bitfields_constants(struct kunit * context)60d2585f51SVitor Massaru Iha static void __init test_bitfields_constants(struct kunit *context)
61d2585f51SVitor Massaru Iha {
62d2585f51SVitor Massaru Iha /*
63d2585f51SVitor Massaru Iha * NOTE
64d2585f51SVitor Massaru Iha * This whole function compiles (or at least should, if everything
65d2585f51SVitor Massaru Iha * is going according to plan) to nothing after optimisation.
66d2585f51SVitor Massaru Iha */
67d2585f51SVitor Massaru Iha
68d2585f51SVitor Massaru Iha CHECK_ENC_GET(16, 1, 0x000f, 0x0001);
69d2585f51SVitor Massaru Iha CHECK_ENC_GET(16, 3, 0x00f0, 0x0030);
70d2585f51SVitor Massaru Iha CHECK_ENC_GET(16, 5, 0x0f00, 0x0500);
71d2585f51SVitor Massaru Iha CHECK_ENC_GET(16, 7, 0xf000, 0x7000);
72d2585f51SVitor Massaru Iha CHECK_ENC_GET(16, 14, 0x000f, 0x000e);
73d2585f51SVitor Massaru Iha CHECK_ENC_GET(16, 15, 0x00f0, 0x00f0);
74d2585f51SVitor Massaru Iha
75d2585f51SVitor Massaru Iha CHECK_ENC_GET_U(8, 1, 0x0f, 0x01);
76d2585f51SVitor Massaru Iha CHECK_ENC_GET_U(8, 3, 0xf0, 0x30);
77d2585f51SVitor Massaru Iha CHECK_ENC_GET_U(8, 14, 0x0f, 0x0e);
78d2585f51SVitor Massaru Iha CHECK_ENC_GET_U(8, 15, 0xf0, 0xf0);
79d2585f51SVitor Massaru Iha
80d2585f51SVitor Massaru Iha CHECK_ENC_GET(32, 1, 0x00000f00, 0x00000100);
81d2585f51SVitor Massaru Iha CHECK_ENC_GET(32, 3, 0x0000f000, 0x00003000);
82d2585f51SVitor Massaru Iha CHECK_ENC_GET(32, 5, 0x000f0000, 0x00050000);
83d2585f51SVitor Massaru Iha CHECK_ENC_GET(32, 7, 0x00f00000, 0x00700000);
84d2585f51SVitor Massaru Iha CHECK_ENC_GET(32, 14, 0x0f000000, 0x0e000000);
85d2585f51SVitor Massaru Iha CHECK_ENC_GET(32, 15, 0xf0000000, 0xf0000000);
86d2585f51SVitor Massaru Iha
87d2585f51SVitor Massaru Iha CHECK_ENC_GET(64, 1, 0x00000f0000000000ull, 0x0000010000000000ull);
88d2585f51SVitor Massaru Iha CHECK_ENC_GET(64, 3, 0x0000f00000000000ull, 0x0000300000000000ull);
89d2585f51SVitor Massaru Iha CHECK_ENC_GET(64, 5, 0x000f000000000000ull, 0x0005000000000000ull);
90d2585f51SVitor Massaru Iha CHECK_ENC_GET(64, 7, 0x00f0000000000000ull, 0x0070000000000000ull);
91d2585f51SVitor Massaru Iha CHECK_ENC_GET(64, 14, 0x0f00000000000000ull, 0x0e00000000000000ull);
92d2585f51SVitor Massaru Iha CHECK_ENC_GET(64, 15, 0xf000000000000000ull, 0xf000000000000000ull);
93d2585f51SVitor Massaru Iha }
94d2585f51SVitor Massaru Iha
95d2585f51SVitor Massaru Iha #define CHECK(tp, mask) do { \
96d2585f51SVitor Massaru Iha u64 v; \
97d2585f51SVitor Massaru Iha \
98d2585f51SVitor Massaru Iha for (v = 0; v < 1 << hweight32(mask); v++) \
99d2585f51SVitor Massaru Iha KUNIT_ASSERT_FALSE(context, \
100d2585f51SVitor Massaru Iha tp##_encode_bits(v, mask) != v << __ffs64(mask));\
101d2585f51SVitor Massaru Iha } while (0)
102d2585f51SVitor Massaru Iha
test_bitfields_variables(struct kunit * context)103d2585f51SVitor Massaru Iha static void __init test_bitfields_variables(struct kunit *context)
104d2585f51SVitor Massaru Iha {
105d2585f51SVitor Massaru Iha CHECK(u8, 0x0f);
106d2585f51SVitor Massaru Iha CHECK(u8, 0xf0);
107d2585f51SVitor Massaru Iha CHECK(u8, 0x38);
108d2585f51SVitor Massaru Iha
109d2585f51SVitor Massaru Iha CHECK(u16, 0x0038);
110d2585f51SVitor Massaru Iha CHECK(u16, 0x0380);
111d2585f51SVitor Massaru Iha CHECK(u16, 0x3800);
112d2585f51SVitor Massaru Iha CHECK(u16, 0x8000);
113d2585f51SVitor Massaru Iha
114d2585f51SVitor Massaru Iha CHECK(u32, 0x80000000);
115d2585f51SVitor Massaru Iha CHECK(u32, 0x7f000000);
116d2585f51SVitor Massaru Iha CHECK(u32, 0x07e00000);
117d2585f51SVitor Massaru Iha CHECK(u32, 0x00018000);
118d2585f51SVitor Massaru Iha
119d2585f51SVitor Massaru Iha CHECK(u64, 0x8000000000000000ull);
120d2585f51SVitor Massaru Iha CHECK(u64, 0x7f00000000000000ull);
121d2585f51SVitor Massaru Iha CHECK(u64, 0x0001800000000000ull);
122d2585f51SVitor Massaru Iha CHECK(u64, 0x0000000080000000ull);
123d2585f51SVitor Massaru Iha CHECK(u64, 0x000000007f000000ull);
124d2585f51SVitor Massaru Iha CHECK(u64, 0x0000000018000000ull);
125d2585f51SVitor Massaru Iha CHECK(u64, 0x0000001f8000000ull);
126d2585f51SVitor Massaru Iha }
127d2585f51SVitor Massaru Iha
128*294a7f16SVitor Massaru Iha #ifdef TEST_BITFIELD_COMPILE
test_bitfields_compile(struct kunit * context)129d2585f51SVitor Massaru Iha static void __init test_bitfields_compile(struct kunit *context)
130d2585f51SVitor Massaru Iha {
131d2585f51SVitor Massaru Iha /* these should fail compilation */
132d2585f51SVitor Massaru Iha CHECK_ENC_GET(16, 16, 0x0f00, 0x1000);
133d2585f51SVitor Massaru Iha u32_encode_bits(7, 0x06000000);
134d2585f51SVitor Massaru Iha
135d2585f51SVitor Massaru Iha /* this should at least give a warning */
136d2585f51SVitor Massaru Iha u16_encode_bits(0, 0x60000);
137d2585f51SVitor Massaru Iha }
138*294a7f16SVitor Massaru Iha #endif
139d2585f51SVitor Massaru Iha
140d2585f51SVitor Massaru Iha static struct kunit_case __refdata bitfields_test_cases[] = {
141d2585f51SVitor Massaru Iha KUNIT_CASE(test_bitfields_constants),
142d2585f51SVitor Massaru Iha KUNIT_CASE(test_bitfields_variables),
143d2585f51SVitor Massaru Iha {}
144d2585f51SVitor Massaru Iha };
145d2585f51SVitor Massaru Iha
146d2585f51SVitor Massaru Iha static struct kunit_suite bitfields_test_suite = {
147d2585f51SVitor Massaru Iha .name = "bitfields",
148d2585f51SVitor Massaru Iha .test_cases = bitfields_test_cases,
149d2585f51SVitor Massaru Iha };
150d2585f51SVitor Massaru Iha
151d2585f51SVitor Massaru Iha kunit_test_suites(&bitfields_test_suite);
152d2585f51SVitor Massaru Iha
153d2585f51SVitor Massaru Iha MODULE_AUTHOR("Johannes Berg <johannes@sipsolutions.net>");
154d2585f51SVitor Massaru Iha MODULE_LICENSE("GPL");
155