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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
use accessor::Mapper;
use bit_field::BitField;
use core::convert::TryInto;
#[derive(Debug)]
pub struct Capability<M>
where
M: Mapper + Clone,
{
pub caplength: accessor::Single<CapabilityRegistersLength, M>,
pub hciversion: accessor::Single<InterfaceVersionNumber, M>,
pub hcsparams1: accessor::Single<StructuralParameters1, M>,
pub hcsparams2: accessor::Single<StructuralParameters2, M>,
pub hcsparams3: accessor::Single<StructuralParameters3, M>,
pub hccparams1: accessor::Single<CapabilityParameters1, M>,
pub dboff: accessor::Single<DoorbellOffset, M>,
pub rtsoff: accessor::Single<RuntimeRegisterSpaceOffset, M>,
pub hccparams2: accessor::Single<CapabilityParameters2, M>,
pub vtiosoff: accessor::Single<VirtualizationBasedTrustedIoRegisterSpaceOffset, M>,
}
impl<M> Capability<M>
where
M: Mapper + Clone,
{
pub unsafe fn new(mmio_base: usize, mapper: &M) -> Self
where
M: Mapper,
{
macro_rules! m {
($offset:expr) => {
accessor::Single::new(mmio_base + $offset, mapper.clone())
};
}
Self {
caplength: m!(0x00),
hciversion: m!(0x02),
hcsparams1: m!(0x04),
hcsparams2: m!(0x08),
hcsparams3: m!(0x0c),
hccparams1: m!(0x10),
dboff: m!(0x14),
rtsoff: m!(0x18),
hccparams2: m!(0x1c),
vtiosoff: m!(0x20),
}
}
}
#[repr(transparent)]
#[allow(clippy::module_name_repetitions)]
#[derive(Copy, Clone, Debug)]
pub struct CapabilityRegistersLength(u8);
impl CapabilityRegistersLength {
#[must_use]
pub fn get(self) -> u8 {
self.0
}
}
#[repr(transparent)]
#[derive(Copy, Clone, Debug)]
pub struct InterfaceVersionNumber(u16);
impl InterfaceVersionNumber {
#[must_use]
pub fn get(self) -> u16 {
self.0
}
}
#[repr(transparent)]
#[derive(Copy, Clone)]
pub struct StructuralParameters1(u32);
impl StructuralParameters1 {
#[must_use]
pub fn number_of_device_slots(self) -> u8 {
self.0.get_bits(0..=7).try_into().unwrap()
}
#[must_use]
pub fn number_of_interrupts(self) -> u16 {
self.0.get_bits(8..=18).try_into().unwrap()
}
#[must_use]
pub fn number_of_ports(self) -> u8 {
self.0.get_bits(24..=31).try_into().unwrap()
}
}
impl_debug_from_methods! {
StructuralParameters1{
number_of_device_slots,
number_of_interrupts,
number_of_ports
}
}
#[repr(transparent)]
#[derive(Copy, Clone)]
pub struct StructuralParameters2(u32);
impl StructuralParameters2 {
#[must_use]
pub fn isochronous_scheduling_threshold(self) -> u8 {
self.0.get_bits(0..=3).try_into().unwrap()
}
#[must_use]
pub fn event_ring_segment_table_max(self) -> u16 {
2_u16.pow(self.erst_max())
}
#[must_use]
pub fn max_scratchpad_buffers(self) -> u32 {
let h = self.max_scratchpad_buffers_hi();
let l = self.max_scratchpad_buffers_lo();
h << 5 | l
}
#[must_use]
pub fn scratchpad_restore(self) -> bool {
self.0.get_bit(26)
}
fn erst_max(self) -> u32 {
self.0.get_bits(4..=7)
}
fn max_scratchpad_buffers_hi(self) -> u32 {
self.0.get_bits(20..=25)
}
fn max_scratchpad_buffers_lo(self) -> u32 {
self.0.get_bits(27..=31)
}
}
impl_debug_from_methods! {
StructuralParameters2{
isochronous_scheduling_threshold,
event_ring_segment_table_max,
max_scratchpad_buffers,
scratchpad_restore
}
}
#[repr(transparent)]
#[derive(Copy, Clone)]
pub struct StructuralParameters3(u32);
impl StructuralParameters3 {
#[must_use]
pub fn u1_device_exit_latency(self) -> u8 {
self.0.get_bits(0..=7).try_into().unwrap()
}
#[must_use]
pub fn u2_device_exit_latency(self) -> u16 {
self.0.get_bits(16..=31).try_into().unwrap()
}
}
impl_debug_from_methods! {
StructuralParameters3{
u1_device_exit_latency,
u2_device_exit_latency
}
}
#[repr(transparent)]
#[derive(Copy, Clone)]
#[allow(clippy::module_name_repetitions)]
pub struct CapabilityParameters1(u32);
impl CapabilityParameters1 {
#[must_use]
pub fn addressing_capability(self) -> bool {
self.0.get_bit(0)
}
#[must_use]
pub fn bw_negotiation_capability(self) -> bool {
self.0.get_bit(1)
}
#[must_use]
pub fn context_size(self) -> bool {
self.0.get_bit(2)
}
#[must_use]
pub fn port_power_control(self) -> bool {
self.0.get_bit(3)
}
#[must_use]
pub fn port_indicators(self) -> bool {
self.0.get_bit(4)
}
#[must_use]
pub fn light_hc_reset_capability(self) -> bool {
self.0.get_bit(5)
}
#[must_use]
pub fn latency_tolerance_messaging_capability(self) -> bool {
self.0.get_bit(6)
}
#[must_use]
pub fn no_secondary_sid_support(self) -> bool {
self.0.get_bit(7)
}
#[must_use]
pub fn parse_all_event_data(self) -> bool {
self.0.get_bit(8)
}
#[must_use]
pub fn stopped_short_packet_capability(self) -> bool {
self.0.get_bit(9)
}
#[must_use]
pub fn stopped_edtla_capability(self) -> bool {
self.0.get_bit(10)
}
#[must_use]
pub fn contiguous_frame_id_capability(self) -> bool {
self.0.get_bit(11)
}
#[must_use]
pub fn max_primary_stream_array_size(self) -> u8 {
self.0.get_bits(12..=15).try_into().unwrap()
}
#[must_use]
pub fn xhci_extended_capabilities_pointer(self) -> u16 {
self.0.get_bits(16..=31).try_into().unwrap()
}
}
impl_debug_from_methods! {
CapabilityParameters1 {
addressing_capability,
bw_negotiation_capability,
context_size,
port_power_control,
port_indicators,
light_hc_reset_capability,
latency_tolerance_messaging_capability,
no_secondary_sid_support,
parse_all_event_data,
stopped_short_packet_capability,
stopped_edtla_capability,
contiguous_frame_id_capability,
max_primary_stream_array_size,
xhci_extended_capabilities_pointer
}
}
#[repr(transparent)]
#[derive(Copy, Clone, Debug)]
pub struct DoorbellOffset(u32);
impl DoorbellOffset {
#[must_use]
pub fn get(self) -> u32 {
self.0
}
}
#[repr(transparent)]
#[derive(Copy, Clone, Debug)]
pub struct RuntimeRegisterSpaceOffset(u32);
impl RuntimeRegisterSpaceOffset {
#[must_use]
pub fn get(self) -> u32 {
self.0
}
}
#[repr(transparent)]
#[allow(clippy::module_name_repetitions)]
#[derive(Copy, Clone)]
pub struct CapabilityParameters2(u32);
impl CapabilityParameters2 {
#[must_use]
pub fn u3_entry_capability(self) -> bool {
self.0.get_bit(0)
}
#[must_use]
pub fn configure_endpoint_command_max_exit_latency_too_large_capability(self) -> bool {
self.0.get_bit(1)
}
#[must_use]
pub fn force_save_context_capability(self) -> bool {
self.0.get_bit(2)
}
#[must_use]
pub fn compliance_transition_capability(self) -> bool {
self.0.get_bit(3)
}
#[must_use]
pub fn large_esit_payload_capability(self) -> bool {
self.0.get_bit(4)
}
#[must_use]
pub fn configuration_information_capability(self) -> bool {
self.0.get_bit(5)
}
#[must_use]
pub fn extended_tbc_capability(self) -> bool {
self.0.get_bit(6)
}
#[must_use]
pub fn extended_tbc_trb_status_capability(self) -> bool {
self.0.get_bit(7)
}
#[must_use]
pub fn get_set_extended_property_capability(self) -> bool {
self.0.get_bit(8)
}
#[must_use]
pub fn virtualization_based_trusted_io_capability(self) -> bool {
self.0.get_bit(9)
}
}
impl_debug_from_methods! {
CapabilityParameters2 {
u3_entry_capability,
configure_endpoint_command_max_exit_latency_too_large_capability,
force_save_context_capability,
compliance_transition_capability,
large_esit_payload_capability,
configuration_information_capability,
extended_tbc_capability,
extended_tbc_trb_status_capability,
get_set_extended_property_capability,
virtualization_based_trusted_io_capability
}
}
#[repr(transparent)]
#[derive(Copy, Clone, Debug)]
pub struct VirtualizationBasedTrustedIoRegisterSpaceOffset(u32);
impl VirtualizationBasedTrustedIoRegisterSpaceOffset {
#[must_use]
pub fn get(self) -> u32 {
self.0
}
}