1*9e682348SMarco Pagani // SPDX-License-Identifier: GPL-2.0
2*9e682348SMarco Pagani /*
3*9e682348SMarco Pagani * KUnit test for the FPGA Bridge
4*9e682348SMarco Pagani *
5*9e682348SMarco Pagani * Copyright (C) 2023 Red Hat, Inc.
6*9e682348SMarco Pagani *
7*9e682348SMarco Pagani * Author: Marco Pagani <marpagan@redhat.com>
8*9e682348SMarco Pagani */
9*9e682348SMarco Pagani
10*9e682348SMarco Pagani #include <kunit/test.h>
11*9e682348SMarco Pagani #include <linux/device.h>
12*9e682348SMarco Pagani #include <linux/fpga/fpga-bridge.h>
13*9e682348SMarco Pagani #include <linux/module.h>
14*9e682348SMarco Pagani #include <linux/types.h>
15*9e682348SMarco Pagani
16*9e682348SMarco Pagani struct bridge_stats {
17*9e682348SMarco Pagani bool enable;
18*9e682348SMarco Pagani };
19*9e682348SMarco Pagani
20*9e682348SMarco Pagani struct bridge_ctx {
21*9e682348SMarco Pagani struct fpga_bridge *bridge;
22*9e682348SMarco Pagani struct platform_device *pdev;
23*9e682348SMarco Pagani struct bridge_stats stats;
24*9e682348SMarco Pagani };
25*9e682348SMarco Pagani
op_enable_set(struct fpga_bridge * bridge,bool enable)26*9e682348SMarco Pagani static int op_enable_set(struct fpga_bridge *bridge, bool enable)
27*9e682348SMarco Pagani {
28*9e682348SMarco Pagani struct bridge_stats *stats = bridge->priv;
29*9e682348SMarco Pagani
30*9e682348SMarco Pagani stats->enable = enable;
31*9e682348SMarco Pagani
32*9e682348SMarco Pagani return 0;
33*9e682348SMarco Pagani }
34*9e682348SMarco Pagani
35*9e682348SMarco Pagani /*
36*9e682348SMarco Pagani * Fake FPGA bridge that implements only the enable_set op to track
37*9e682348SMarco Pagani * the state.
38*9e682348SMarco Pagani */
39*9e682348SMarco Pagani static const struct fpga_bridge_ops fake_bridge_ops = {
40*9e682348SMarco Pagani .enable_set = op_enable_set,
41*9e682348SMarco Pagani };
42*9e682348SMarco Pagani
43*9e682348SMarco Pagani /**
44*9e682348SMarco Pagani * register_test_bridge() - Register a fake FPGA bridge for testing.
45*9e682348SMarco Pagani * @test: KUnit test context object.
46*9e682348SMarco Pagani *
47*9e682348SMarco Pagani * Return: Context of the newly registered FPGA bridge.
48*9e682348SMarco Pagani */
register_test_bridge(struct kunit * test)49*9e682348SMarco Pagani static struct bridge_ctx *register_test_bridge(struct kunit *test)
50*9e682348SMarco Pagani {
51*9e682348SMarco Pagani struct bridge_ctx *ctx;
52*9e682348SMarco Pagani
53*9e682348SMarco Pagani ctx = kunit_kzalloc(test, sizeof(*ctx), GFP_KERNEL);
54*9e682348SMarco Pagani KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ctx);
55*9e682348SMarco Pagani
56*9e682348SMarco Pagani ctx->pdev = platform_device_register_simple("bridge_pdev", PLATFORM_DEVID_AUTO, NULL, 0);
57*9e682348SMarco Pagani KUNIT_ASSERT_NOT_ERR_OR_NULL(test, ctx->pdev);
58*9e682348SMarco Pagani
59*9e682348SMarco Pagani ctx->bridge = fpga_bridge_register(&ctx->pdev->dev, "Fake FPGA bridge", &fake_bridge_ops,
60*9e682348SMarco Pagani &ctx->stats);
61*9e682348SMarco Pagani KUNIT_ASSERT_FALSE(test, IS_ERR_OR_NULL(ctx->bridge));
62*9e682348SMarco Pagani
63*9e682348SMarco Pagani return ctx;
64*9e682348SMarco Pagani }
65*9e682348SMarco Pagani
unregister_test_bridge(struct bridge_ctx * ctx)66*9e682348SMarco Pagani static void unregister_test_bridge(struct bridge_ctx *ctx)
67*9e682348SMarco Pagani {
68*9e682348SMarco Pagani fpga_bridge_unregister(ctx->bridge);
69*9e682348SMarco Pagani platform_device_unregister(ctx->pdev);
70*9e682348SMarco Pagani }
71*9e682348SMarco Pagani
fpga_bridge_test_get(struct kunit * test)72*9e682348SMarco Pagani static void fpga_bridge_test_get(struct kunit *test)
73*9e682348SMarco Pagani {
74*9e682348SMarco Pagani struct bridge_ctx *ctx = test->priv;
75*9e682348SMarco Pagani struct fpga_bridge *bridge;
76*9e682348SMarco Pagani
77*9e682348SMarco Pagani bridge = fpga_bridge_get(&ctx->pdev->dev, NULL);
78*9e682348SMarco Pagani KUNIT_EXPECT_PTR_EQ(test, bridge, ctx->bridge);
79*9e682348SMarco Pagani
80*9e682348SMarco Pagani bridge = fpga_bridge_get(&ctx->pdev->dev, NULL);
81*9e682348SMarco Pagani KUNIT_EXPECT_EQ(test, PTR_ERR(bridge), -EBUSY);
82*9e682348SMarco Pagani
83*9e682348SMarco Pagani fpga_bridge_put(ctx->bridge);
84*9e682348SMarco Pagani }
85*9e682348SMarco Pagani
fpga_bridge_test_toggle(struct kunit * test)86*9e682348SMarco Pagani static void fpga_bridge_test_toggle(struct kunit *test)
87*9e682348SMarco Pagani {
88*9e682348SMarco Pagani struct bridge_ctx *ctx = test->priv;
89*9e682348SMarco Pagani int ret;
90*9e682348SMarco Pagani
91*9e682348SMarco Pagani ret = fpga_bridge_disable(ctx->bridge);
92*9e682348SMarco Pagani KUNIT_EXPECT_EQ(test, ret, 0);
93*9e682348SMarco Pagani KUNIT_EXPECT_FALSE(test, ctx->stats.enable);
94*9e682348SMarco Pagani
95*9e682348SMarco Pagani ret = fpga_bridge_enable(ctx->bridge);
96*9e682348SMarco Pagani KUNIT_EXPECT_EQ(test, ret, 0);
97*9e682348SMarco Pagani KUNIT_EXPECT_TRUE(test, ctx->stats.enable);
98*9e682348SMarco Pagani }
99*9e682348SMarco Pagani
100*9e682348SMarco Pagani /* Test the functions for getting and controlling a list of bridges */
fpga_bridge_test_get_put_list(struct kunit * test)101*9e682348SMarco Pagani static void fpga_bridge_test_get_put_list(struct kunit *test)
102*9e682348SMarco Pagani {
103*9e682348SMarco Pagani struct list_head bridge_list;
104*9e682348SMarco Pagani struct bridge_ctx *ctx_0, *ctx_1;
105*9e682348SMarco Pagani int ret;
106*9e682348SMarco Pagani
107*9e682348SMarco Pagani ctx_0 = test->priv;
108*9e682348SMarco Pagani ctx_1 = register_test_bridge(test);
109*9e682348SMarco Pagani
110*9e682348SMarco Pagani INIT_LIST_HEAD(&bridge_list);
111*9e682348SMarco Pagani
112*9e682348SMarco Pagani /* Get bridge 0 and add it to the list */
113*9e682348SMarco Pagani ret = fpga_bridge_get_to_list(&ctx_0->pdev->dev, NULL, &bridge_list);
114*9e682348SMarco Pagani KUNIT_EXPECT_EQ(test, ret, 0);
115*9e682348SMarco Pagani
116*9e682348SMarco Pagani KUNIT_EXPECT_PTR_EQ(test, ctx_0->bridge,
117*9e682348SMarco Pagani list_first_entry_or_null(&bridge_list, struct fpga_bridge, node));
118*9e682348SMarco Pagani
119*9e682348SMarco Pagani /* Get bridge 1 and add it to the list */
120*9e682348SMarco Pagani ret = fpga_bridge_get_to_list(&ctx_1->pdev->dev, NULL, &bridge_list);
121*9e682348SMarco Pagani KUNIT_EXPECT_EQ(test, ret, 0);
122*9e682348SMarco Pagani
123*9e682348SMarco Pagani KUNIT_EXPECT_PTR_EQ(test, ctx_1->bridge,
124*9e682348SMarco Pagani list_first_entry_or_null(&bridge_list, struct fpga_bridge, node));
125*9e682348SMarco Pagani
126*9e682348SMarco Pagani /* Disable an then enable both bridges from the list */
127*9e682348SMarco Pagani ret = fpga_bridges_disable(&bridge_list);
128*9e682348SMarco Pagani KUNIT_EXPECT_EQ(test, ret, 0);
129*9e682348SMarco Pagani
130*9e682348SMarco Pagani KUNIT_EXPECT_FALSE(test, ctx_0->stats.enable);
131*9e682348SMarco Pagani KUNIT_EXPECT_FALSE(test, ctx_1->stats.enable);
132*9e682348SMarco Pagani
133*9e682348SMarco Pagani ret = fpga_bridges_enable(&bridge_list);
134*9e682348SMarco Pagani KUNIT_EXPECT_EQ(test, ret, 0);
135*9e682348SMarco Pagani
136*9e682348SMarco Pagani KUNIT_EXPECT_TRUE(test, ctx_0->stats.enable);
137*9e682348SMarco Pagani KUNIT_EXPECT_TRUE(test, ctx_1->stats.enable);
138*9e682348SMarco Pagani
139*9e682348SMarco Pagani /* Put and remove both bridges from the list */
140*9e682348SMarco Pagani fpga_bridges_put(&bridge_list);
141*9e682348SMarco Pagani
142*9e682348SMarco Pagani KUNIT_EXPECT_TRUE(test, list_empty(&bridge_list));
143*9e682348SMarco Pagani
144*9e682348SMarco Pagani unregister_test_bridge(ctx_1);
145*9e682348SMarco Pagani }
146*9e682348SMarco Pagani
fpga_bridge_test_init(struct kunit * test)147*9e682348SMarco Pagani static int fpga_bridge_test_init(struct kunit *test)
148*9e682348SMarco Pagani {
149*9e682348SMarco Pagani test->priv = register_test_bridge(test);
150*9e682348SMarco Pagani
151*9e682348SMarco Pagani return 0;
152*9e682348SMarco Pagani }
153*9e682348SMarco Pagani
fpga_bridge_test_exit(struct kunit * test)154*9e682348SMarco Pagani static void fpga_bridge_test_exit(struct kunit *test)
155*9e682348SMarco Pagani {
156*9e682348SMarco Pagani unregister_test_bridge(test->priv);
157*9e682348SMarco Pagani }
158*9e682348SMarco Pagani
159*9e682348SMarco Pagani static struct kunit_case fpga_bridge_test_cases[] = {
160*9e682348SMarco Pagani KUNIT_CASE(fpga_bridge_test_get),
161*9e682348SMarco Pagani KUNIT_CASE(fpga_bridge_test_toggle),
162*9e682348SMarco Pagani KUNIT_CASE(fpga_bridge_test_get_put_list),
163*9e682348SMarco Pagani {}
164*9e682348SMarco Pagani };
165*9e682348SMarco Pagani
166*9e682348SMarco Pagani static struct kunit_suite fpga_bridge_suite = {
167*9e682348SMarco Pagani .name = "fpga_bridge",
168*9e682348SMarco Pagani .init = fpga_bridge_test_init,
169*9e682348SMarco Pagani .exit = fpga_bridge_test_exit,
170*9e682348SMarco Pagani .test_cases = fpga_bridge_test_cases,
171*9e682348SMarco Pagani };
172*9e682348SMarco Pagani
173*9e682348SMarco Pagani kunit_test_suite(fpga_bridge_suite);
174*9e682348SMarco Pagani
175*9e682348SMarco Pagani MODULE_LICENSE("GPL");
176