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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
#include <kapi/devices.hpp>
#include <kstd/memory.hpp>
#include <kstd/result.hpp>
#include <kstd/string.hpp>
#include <catch2/catch_test_macros.hpp>
#include <algorithm>
#include <array>
#include <cstdint>
#include <span>
#include <string_view>
namespace
{
struct controller_identification
{
constexpr auto static id = kapi::capabilities::facet_id{"stacking_test_controller_identification"};
virtual ~controller_identification() = default;
[[nodiscard]] virtual auto controller_name() const -> std::string_view = 0;
};
struct controller_driver_identification
{
constexpr auto static id = kapi::capabilities::facet_id{"stacking_test_controller_driver_identification"};
virtual ~controller_driver_identification() = default;
[[nodiscard]] virtual auto supported_names() const -> std::span<std::string_view const> = 0;
};
struct controller_protocol : kapi::devices::bus_protocol
{
auto enumerate(kapi::devices::bus &) -> void override {}
[[nodiscard]] auto match(kapi::devices::device const & dev, kapi::devices::driver const & drv) const
-> kstd::result<std::uint32_t> override
{
auto const * ident = dev.facet<controller_identification>();
auto const * claims = drv.facet<controller_driver_identification>();
if (!ident || !claims || !std::ranges::contains(claims->supported_names(), ident->controller_name()))
{
return kstd::failure(kapi::devices::driver_match_errc::no_match);
}
return 0u;
}
} constinit controller_protocol_instance{};
struct controller_bus final : kapi::devices::bus
{
using kapi::devices::bus::bus;
[[nodiscard]] auto query_facet(kapi::capabilities::facet_id facet) -> void * override
{
if (facet == kapi::devices::bus_protocol::id)
{
return static_cast<kapi::devices::bus_protocol *>(&controller_protocol_instance);
}
return kapi::devices::bus::query_facet(facet);
}
};
struct controller_device final : kapi::devices::bus, controller_identification
{
controller_device()
: kapi::devices::bus{"stacking_test_controller"}
{}
[[nodiscard]] auto controller_name() const -> std::string_view override
{
return "stacking_test_controller";
}
protected:
auto query_facet(kapi::capabilities::facet_id facet) -> void * override
{
if (facet == controller_identification::id)
{
return static_cast<controller_identification *>(this);
}
return kapi::devices::bus::query_facet(facet);
}
};
struct leaf_identification
{
constexpr auto static id = kapi::capabilities::facet_id{"stacking_test_leaf_identification"};
virtual ~leaf_identification() = default;
[[nodiscard]] virtual auto leaf_name() const -> std::string_view = 0;
};
struct leaf_driver_identification
{
constexpr auto static id = kapi::capabilities::facet_id{"stacking_test_leaf_driver_identification"};
virtual ~leaf_driver_identification() = default;
[[nodiscard]] virtual auto supported_names() const -> std::span<std::string_view const> = 0;
};
struct leaf_device final : kapi::devices::device, leaf_identification
{
leaf_device()
: kapi::devices::device{"stacking_test_leaf"}
{}
[[nodiscard]] auto leaf_name() const -> std::string_view override
{
return "stacking_test_leaf";
}
protected:
auto query_facet(kapi::capabilities::facet_id facet) -> void * override
{
if (facet == leaf_identification::id)
{
return static_cast<leaf_identification *>(this);
}
return kapi::devices::device::query_facet(facet);
}
};
struct leaf_protocol final : kapi::devices::bus_protocol
{
constexpr auto static id = kapi::capabilities::facet_id{"stacking_test_leaf_protocol"};
auto enumerate(kapi::devices::bus & self) -> void override
{
self.add_child(kstd::make_shared<leaf_device>());
}
[[nodiscard]] auto match(kapi::devices::device const & dev, kapi::devices::driver const & drv) const
-> kstd::result<std::uint32_t> override
{
auto const * ident = dev.facet<leaf_identification>();
auto const * claims = drv.facet<leaf_driver_identification>();
if (!ident || !claims || !std::ranges::contains(claims->supported_names(), ident->leaf_name()))
{
return kstd::failure(kapi::devices::driver_match_errc::no_match);
}
return 0u;
}
} constinit leaf_protocol_instance{};
struct leaf_bus final : kapi::devices::bus
{
using kapi::devices::bus::bus;
[[nodiscard]] auto query_facet(kapi::capabilities::facet_id id) -> void * override
{
if (id == kapi::devices::bus_protocol::id)
{
return static_cast<kapi::devices::bus_protocol *>(&leaf_protocol_instance);
}
return kapi::devices::bus::query_facet(id);
}
};
struct controller_driver final : kapi::devices::driver, controller_driver_identification
{
[[nodiscard]] auto probe(kapi::devices::device & dev) -> kstd::result<void> override
{
auto self_as_bus = kstd::static_pointer_cast<kapi::devices::bus>(dev.shared_from_this());
auto leaf = kstd::make_shared<leaf_bus>("stacking_test_leaf_bus");
self_as_bus->add_child(leaf);
leaf->facet<kapi::devices::bus_protocol>()->enumerate(*leaf);
return kstd::success();
}
auto unbind(kapi::devices::device &) -> void override {}
[[nodiscard]] auto supported_names() const -> std::span<std::string_view const> override
{
constexpr auto static names = std::array<std::string_view, 1>{"stacking_test_controller"};
return names;
}
[[nodiscard]] auto name() const noexcept -> std::string_view override
{
return "Generic BHT Test Controller";
}
protected:
auto query_facet(kapi::capabilities::facet_id facet) -> void * override
{
if (facet == controller_driver_identification::id)
{
return static_cast<controller_driver_identification *>(this);
}
return kapi::devices::driver::query_facet(facet);
}
};
struct leaf_driver final : kapi::devices::driver, leaf_driver_identification
{
[[nodiscard]] auto probe(kapi::devices::device &) -> kstd::result<void> override
{
return kstd::success();
}
auto unbind(kapi::devices::device &) -> void override {}
[[nodiscard]] auto supported_names() const -> std::span<std::string_view const> override
{
constexpr auto static names = std::array<std::string_view, 1>{"stacking_test_leaf"};
return names;
}
[[nodiscard]] auto name() const noexcept -> std::string_view override
{
return "Generic BHT Leaf Device";
}
protected:
auto query_facet(kapi::capabilities::facet_id facet) -> void * override
{
if (facet == leaf_driver_identification::id)
{
return static_cast<leaf_driver_identification *>(this);
}
return kapi::devices::driver::query_facet(facet);
}
};
} // namespace
SCENARIO("a bound controller driver can attach a further, independently-typed bus protocol of its own",
"[devices][driver][stacking]")
{
GIVEN("a controller bus, a controller driver, and a leaf driver, none aware of each other's identification scheme")
{
auto outer_bus = kstd::make_shared<controller_bus>("stacking_test_controller_bus");
kapi::devices::driver_registry::get().add(kstd::make_shared<controller_driver>());
kapi::devices::driver_registry::get().add(kstd::make_shared<leaf_driver>());
WHEN("the controller device is attached to the controller bus")
{
outer_bus->add_child(kstd::make_shared<controller_device>());
THEN("the controller device bound the controller driver")
{
auto controller = kapi::devices::device_registry::get().find("stacking_test_controller");
REQUIRE(controller != nullptr);
REQUIRE(controller->state() == kapi::devices::state::bound);
}
THEN("the leaf device the controller driver attached is reachable and bound to the leaf driver")
{
auto leaf = kapi::devices::device_registry::get().find("stacking_test_leaf");
REQUIRE(leaf != nullptr);
REQUIRE(leaf->state() == kapi::devices::state::bound);
REQUIRE(leaf->bound_driver() != nullptr);
}
}
}
}
|
