virtfw-libhw 0.5.0

library for direct hardware access
Documentation
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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
//! pci config space data structures and access functions
pub mod ecam;
pub mod x86;

#[cfg(feature = "alloc")]
pub mod setup;

use bitfield_struct::bitfield;
use core::fmt;
use core::ops::Deref;

use crate::size::*;

pub const PCI_CFG_VENDOR: u8 = 0x00;
pub const PCI_CFG_DEVICE: u8 = 0x02;
pub const PCI_CFG_COMMAND: u8 = 0x04;
pub const PCI_CFG_STATUS: u8 = 0x06;
pub const PCI_CFG_REVISION: u8 = 0x08;
pub const PCI_CFG_CLASS_PROG: u8 = 0x09;
pub const PCI_CFG_CLASS_DEVICE: u8 = 0x0a;
pub const PCI_CFG_CACHE_LINE_SIZE: u8 = 0x0c;
pub const PCI_CFG_LATENCY_TIMER: u8 = 0x0d;
pub const PCI_CFG_HEADER_TYPE: u8 = 0x0e;
pub const PCI_CFG_BIST: u8 = 0x0f;

// pci bridge
pub const PCI_CFG_PRIMARY_BUS: u8 = 0x18;
pub const PCI_CFG_SECONDARY_BUS: u8 = 0x19;
pub const PCI_CFG_SUBORDINATE_BUS: u8 = 0x1a;
pub const PCI_CFG_IO_BASE: u8 = 0x1c;
pub const PCI_CFG_IO_LIMIT: u8 = 0x1d;
pub const PCI_CFG_MEM_BASE: u8 = 0x20;
pub const PCI_CFG_MEM_LIMIT: u8 = 0x22;
pub const PCI_CFG_PREFMEM_BASE: u8 = 0x24;
pub const PCI_CFG_PREFMEM_LIMIT: u8 = 0x26;
pub const PCI_CFG_PREFMEM_BASE_U32: u8 = 0x28;
pub const PCI_CFG_PREFMEM_LIMIT_U32: u8 = 0x2c;
pub const PCI_CFG_BRIDGE_CTRL: u8 = 0x3e;

pub const PCI_CFG_SUB_VENDOR: u8 = 0x2c;
pub const PCI_CFG_SUB_DEVICE: u8 = 0x2e;

#[bitfield(u16)]
pub struct PciCommand {
    pub io: bool,
    pub memory: bool,
    pub master: bool,
    pub special: bool,
    pub invalidate: bool,
    pub vga_palette: bool,
    pub parity: bool,
    pub wait: bool,
    pub serr: bool,
    pub fast_back: bool,
    pub intx_disable: bool,
    #[bits(5)]
    _pad: u8,
}

impl fmt::Display for PciCommand {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "io{} memory{} master{} special{} inval{} vga-snoop{} parity{} wait{} serr{} fast-back{} no-intx{}",
            if self.io() { "+" } else { "-" },
            if self.memory() { "+" } else { "-" },
            if self.master() { "+" } else { "-" },
            if self.special() { "+" } else { "-" },
            if self.invalidate() { "+" } else { "-" },
            if self.vga_palette() { "+" } else { "-" },
            if self.parity() { "+" } else { "-" },
            if self.wait() { "+" } else { "-" },
            if self.serr() { "+" } else { "-" },
            if self.fast_back() { "+" } else { "-" },
            if self.intx_disable() { "+" } else { "-" },
        )
    }
}

#[bitfield(u8)]
pub struct PciHeaderType {
    #[bits(7)]
    pub value: u8,
    pub mfd: bool,
}

#[bitfield(u8)]
pub struct PciBridgeCtrl {
    pub parity: bool,
    pub serr: bool,
    pub isa: bool,
    pub vga: bool,
    _pad: bool,
    pub master_abort: bool,
    pub bus_reset: bool,
    pub fast_back: bool,
}

impl fmt::Display for PciBridgeCtrl {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "parity{} serr{} isa{} vga{} abort{} bus-reset{} fast-back{}",
            if self.parity() { "+" } else { "-" },
            if self.serr() { "+" } else { "-" },
            if self.isa() { "+" } else { "-" },
            if self.vga() { "+" } else { "-" },
            if self.master_abort() { "+" } else { "-" },
            if self.bus_reset() { "+" } else { "-" },
            if self.fast_back() { "+" } else { "-" },
        )
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PciAddrKind {
    Io,
    Mem32,
    Mem64,
}

#[derive(Debug, Clone)]
pub struct PciAddrRange {
    pub kind: PciAddrKind,
    pub prefetchable: bool,
    pub base: u64,
    pub size: u64,
}

impl PciAddrRange {
    pub fn new_sized(kind: PciAddrKind, size: u64) -> Self {
        Self {
            kind,
            prefetchable: (kind == PciAddrKind::Mem64),
            base: 0,
            size,
        }
    }

    pub fn new_empty(kind: PciAddrKind) -> Self {
        Self::new_sized(kind, 0)
    }

    pub fn name(&self) -> &'static str {
        match (&self.kind, &self.prefetchable) {
            (PciAddrKind::Io, _) => "io",
            (PciAddrKind::Mem32, false) => "mem32",
            (PciAddrKind::Mem32, true) => "prefmem32",
            (PciAddrKind::Mem64, false) => "mem64",
            (PciAddrKind::Mem64, true) => "prefmem64",
        }
    }

    pub fn limit(&self) -> u64 {
        self.base + self.size - 1
    }
}

impl fmt::Display for PciAddrRange {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let (v, u) = pretty_usize(self.size as usize);
        if self.base > 0 {
            write!(
                f,
                "{}: {:x}-{:x} [size {v}{u}]",
                self.name(),
                self.base,
                self.limit()
            )
        } else {
            write!(f, "{}: <unmapped> [size {v}{u}]", self.name())
        }
    }
}

#[derive(Debug, Clone)]
pub struct PciDevAddr {
    pub bus: u8,
    pub slot: u8,
    pub func: u8,
}

impl fmt::Display for PciDevAddr {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{:02x}:{:02x}.{:x}", self.bus, self.slot, self.func)
    }
}

pub struct PciDevice {
    pub addr: PciDevAddr,
    pub vendor: u16,
    pub device: u16,
    pub class: u16,
}

impl Deref for PciDevice {
    type Target = PciDevAddr;

    fn deref(&self) -> &Self::Target {
        &self.addr
    }
}

impl fmt::Display for PciDevice {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "{}  {:04x}:{:04x}  [{:04x} {}]  {}",
            self.addr,
            self.vendor,
            self.device,
            self.class,
            self.class_name(),
            self.device_name(),
        )
    }
}

impl PciDevice {
    pub fn device_name(&self) -> &str {
        match (self.vendor, self.device) {
            // 'pc' machine type
            (0x8086, 0x1237) => "intel i440fx",
            (0x8086, 0x7000) => "intel piix4 lpc",
            (0x8086, 0x7010) => "intel piix4 ide",
            (0x8086, 0x7020) => "intel piix4 uhci",
            (0x8086, 0x7113) => "intel piix4 acpi",

            // 'q35' machine type
            (0x8086, 0x29c0) => "intel q35",
            (0x8086, 0x2918) => "intel ich9 lpc",
            (0x8086, 0x2922) => "intel ich9 ahci",
            (0x8086, 0x2930) => "intel ich9 smbus",

            (0x8086, 0x2934) => "intel ich9 uhci1",
            (0x8086, 0x2935) => "intel ich9 uhci2",
            (0x8086, 0x2936) => "intel ich9 uhci3",
            (0x8086, 0x293a) => "intel ich9 ehci",

            // intel device
            (0x8086, 0x100e) => "intel e1000",
            (0x8086, 0x10d3) => "intel e1000e",
            (0x8086, _) => "intel unknown",

            // virtio devices (vendor 0x1af4)
            (0x1af4, 0x1000) => "virtio net",
            (0x1af4, 0x1001) => "virtio blk",
            (0x1af4, 0x1003) => "virtio console",
            (0x1af4, 0x1004) => "virtio scsi",
            (0x1af4, 0x1005) => "virtio rng",
            (0x1af4, 0x1012) => "virtio vsock",

            (0x1af4, 0x1041) => "virtio net 1.0",
            (0x1af4, 0x1042) => "virtio blk 1.0",
            (0x1af4, 0x1043) => "virtio console 1.0",
            (0x1af4, 0x1044) => "virtio rng 1.0",
            (0x1af4, 0x1048) => "virtio scsi 1.0",
            (0x1af4, 0x1050) => "virtio gpu",
            (0x1af4, 0x1052) => "virtio input",
            (0x1af4, 0x1053) => "virtio vsock 1.0",

            (0x1af4, _) => "virtio unknown",

            // qemu devices (vendor 0x1b36)
            (0x1b36, 0x0001) => "qemu pci-pci bridge",
            (0x1b36, 0x0007) => "qemu sdhci",
            (0x1b36, 0x0008) => "qemu pcie host bridge",
            (0x1b36, 0x000c) => "qemu pcie root port",
            (0x1b36, 0x000d) => "qemu xhci",
            (0x1b36, 0x000e) => "qemu pcie-pci bridge",
            (0x1b36, 0x0010) => "qemu nvme",
            (0x1b36, _) => "qemu unknown",

            // qemu devices (other)
            (0x1234, 0x1111) => "qemu stdvga",

            // catch all
            (_, _) => "unknown",
        }
    }

    pub fn class_name(&self) -> &str {
        match self.class {
            0x0100 => "scsi",
            0x0101 => "ide",
            0x0105 => "ata",
            0x0106 => "sata",
            0x0180 => "storage",

            0x0200 => "ethernet",
            0x0280 => "network",

            0x0300 => "vga",
            0x0380 => "display",

            0x0600 => "host bridge",
            0x0601 => "isa bridge",
            0x0604 => "pci bridge",

            0x0c03 => "usb",
            0x0c05 => "smbus",

            _ => "unknown",
        }
    }
}

pub trait PciHost {
    fn readl(&self, dev: &PciDevAddr, addr: u8) -> u32;
    fn readw(&self, dev: &PciDevAddr, addr: u8) -> u16;
    fn readb(&self, dev: &PciDevAddr, addr: u8) -> u8;

    fn writel(&self, dev: &PciDevAddr, addr: u8, value: u32);
    fn writew(&self, dev: &PciDevAddr, addr: u8, value: u16);
    fn writeb(&self, dev: &PciDevAddr, addr: u8, value: u8);

    fn try_device(&self, bus: u8, slot: u8, func: u8) -> Option<PciDevice> {
        let addr = PciDevAddr { bus, slot, func };
        let vendor = self.readw(&addr, PCI_CFG_VENDOR);
        if (vendor == 0x0000) || (vendor == 0xffff) {
            return None;
        }
        let device = self.readw(&addr, PCI_CFG_DEVICE);
        let class = self.readw(&addr, PCI_CFG_CLASS_DEVICE);
        let pcidev = PciDevice {
            addr,
            vendor,
            device,
            class,
        };
        Some(pcidev)
    }

    fn command(&self, addr: &PciDevAddr) -> PciCommand {
        PciCommand::from(self.readw(addr, PCI_CFG_COMMAND))
    }

    fn revision(&self, addr: &PciDevAddr) -> u8 {
        self.readb(addr, PCI_CFG_DEVICE)
    }

    fn header_type(&self, addr: &PciDevAddr) -> PciHeaderType {
        PciHeaderType::from(self.readb(addr, PCI_CFG_HEADER_TYPE))
    }

    fn is_vga(&self, dev: &PciDevice) -> bool {
        dev.class == 0x0300
    }

    fn is_mfd(&self, dev: &PciDevice) -> bool {
        let h = self.header_type(dev);
        h.mfd()
    }

    fn is_device(&self, dev: &PciDevice) -> bool {
        if self.header_type(dev).value() != 0 {
            return false;
        }
        true
    }

    fn read_bar(&self, addr: &PciDevAddr, nr: u8) -> u32 {
        let offset = 0x10 + nr * 4;
        self.readl(addr, offset)
    }

    fn write_bar(&self, addr: &PciDevAddr, nr: u8, value: u32) {
        let offset = 0x10 + nr * 4;
        self.writel(addr, offset, value);
    }

    fn bar(&self, addr: &PciDevAddr, nr: u8) -> Option<PciAddrRange> {
        if nr > 5 {
            return None;
        }
        let mut base = self.read_bar(addr, nr) as u64;
        if nr > 0 {
            let prevbase = self.read_bar(addr, nr - 1);
            if (prevbase & 6) == 4 {
                // previous bar is 64-bit
                return None;
            }
        }

        self.write_bar(addr, nr, !0);
        let mut size = self.read_bar(addr, nr) as u64;
        self.write_bar(addr, nr, base as u32);

        if base == 0 && size == 0 {
            None
        } else if (base & 1) == 1 {
            // io
            base &= !0x03;
            size &= !0x03;
            size = !size & 0xffffffff;
            Some(PciAddrRange {
                kind: PciAddrKind::Io,
                prefetchable: false,
                base,
                size: size + 1,
            })
        } else if (base & 6) == 0 {
            // 32 bit mem
            let prefetchable = (base & 0x08) != 0;
            base &= !0x0f;
            size &= !0x0f;
            size = !size & 0xffffffff;
            Some(PciAddrRange {
                kind: PciAddrKind::Mem32,
                prefetchable,
                base,
                size: size + 1,
            })
        } else if (base & 6) == 4 {
            // 64 bit mem
            let prefetchable = (base & 0x08) != 0;
            base &= !0x0f;
            size &= !0x0f;

            let nextbase = self.read_bar(addr, nr + 1) as u64;
            self.write_bar(addr, nr + 1, !0);
            let nextsize = self.read_bar(addr, nr + 1) as u64;
            self.write_bar(addr, nr + 1, nextbase as u32);

            base += nextbase << 32;
            size += nextsize << 32;
            size = !size;

            Some(PciAddrRange {
                kind: PciAddrKind::Mem64,
                prefetchable,
                base,
                size: size + 1,
            })
        } else {
            None
        }
    }

    fn is_pci_bridge(&self, dev: &PciDevice) -> bool {
        if dev.class != 0x0604 {
            return false;
        }
        if self.header_type(dev).value() != 1 {
            return false;
        }
        true
    }

    fn bridge_ctl(&self, addr: &PciDevAddr) -> PciBridgeCtrl {
        PciBridgeCtrl::from(self.readb(addr, PCI_CFG_BRIDGE_CTRL))
    }

    fn bridge_primary(&self, addr: &PciDevAddr) -> u8 {
        self.readb(addr, PCI_CFG_PRIMARY_BUS)
    }

    fn bridge_secondary(&self, addr: &PciDevAddr) -> u8 {
        self.readb(addr, PCI_CFG_SECONDARY_BUS)
    }

    fn bridge_subordinate(&self, addr: &PciDevAddr) -> u8 {
        self.readb(addr, PCI_CFG_SUBORDINATE_BUS)
    }

    fn bridge_io(&self, addr: &PciDevAddr) -> Option<PciAddrRange> {
        let basereg = self.readb(addr, PCI_CFG_IO_BASE) as u64;
        let limitreg = self.readb(addr, PCI_CFG_IO_LIMIT) as u64;
        if limitreg != 0 {
            let base = (basereg & 0xf0) << 8;
            let limit = ((limitreg & 0xf0) << 8) + 0xfff;
            Some(PciAddrRange {
                kind: PciAddrKind::Io,
                prefetchable: false,
                base,
                size: limit - base + 1,
            })
        } else {
            None
        }
    }

    fn bridge_mem(&self, addr: &PciDevAddr) -> Option<PciAddrRange> {
        let basereg = self.readw(addr, PCI_CFG_MEM_BASE) as u64;
        let limitreg = self.readw(addr, PCI_CFG_MEM_LIMIT) as u64;
        if limitreg != 0 {
            let base = (basereg & 0xfff0) << 16;
            let limit = ((limitreg & 0xfff0) << 16) + 0xfffff;
            Some(PciAddrRange {
                kind: PciAddrKind::Mem32,
                prefetchable: false,
                base,
                size: limit - base + 1,
            })
        } else {
            None
        }
    }

    fn bridge_prefmem(&self, addr: &PciDevAddr) -> Option<PciAddrRange> {
        let basereg = self.readw(addr, PCI_CFG_PREFMEM_BASE) as u64;
        let limitreg = self.readw(addr, PCI_CFG_PREFMEM_LIMIT) as u64;
        let basereg_u32 = self.readl(addr, PCI_CFG_PREFMEM_BASE_U32) as u64;
        let limitreg_u32 = self.readl(addr, PCI_CFG_PREFMEM_LIMIT_U32) as u64;

        let mut base = (basereg & 0xfff0) << 16;
        let mut limit = (limitreg & 0xfff0) << 16;
        base |= basereg_u32 << 32;
        limit |= limitreg_u32 << 32;

        if limit != 0 {
            limit += 0xfffff;
            Some(PciAddrRange {
                kind: PciAddrKind::Mem64,
                prefetchable: true,
                base,
                size: limit - base + 1,
            })
        } else {
            None
        }
    }

    fn set_bridge_primary(&self, addr: &PciDevAddr, nr: u8) {
        self.writeb(addr, PCI_CFG_PRIMARY_BUS, nr)
    }

    fn set_bridge_secondary(&self, addr: &PciDevAddr, nr: u8) {
        self.writeb(addr, PCI_CFG_SECONDARY_BUS, nr)
    }

    fn set_bridge_subordinate(&self, addr: &PciDevAddr, nr: u8) {
        self.writeb(addr, PCI_CFG_SUBORDINATE_BUS, nr)
    }

    fn set_bridge_io(&self, addr: &PciDevAddr, range: &PciAddrRange) {
        let basereg = (range.base >> 8) & 0xf0;
        let limitreg = (range.limit() >> 8) & 0xf0;
        self.writeb(addr, PCI_CFG_IO_BASE, basereg as u8);
        self.writeb(addr, PCI_CFG_IO_LIMIT, limitreg as u8);
    }

    fn set_bridge_mem(&self, addr: &PciDevAddr, range: &PciAddrRange) {
        let basereg = (range.base >> 16) & 0xfff0;
        let limitreg = (range.limit() >> 16) & 0xfff0;
        self.writew(addr, PCI_CFG_MEM_BASE, basereg as u16);
        self.writew(addr, PCI_CFG_MEM_LIMIT, limitreg as u16);
    }

    fn set_bridge_prefmem(&self, addr: &PciDevAddr, range: &PciAddrRange) {
        let base = range.base >> 16;
        let limit = range.limit() >> 16;
        self.writew(addr, PCI_CFG_PREFMEM_BASE, (base & 0xffff) as u16);
        self.writew(addr, PCI_CFG_PREFMEM_LIMIT, (limit & 0xffff) as u16);
        self.writel(addr, PCI_CFG_PREFMEM_BASE_U32, (base >> 16) as u32);
        self.writel(addr, PCI_CFG_PREFMEM_LIMIT_U32, (limit >> 16) as u32);
    }

    fn set_bar(&self, addr: &PciDevAddr, nr: u8, range: &PciAddrRange) {
        match range.kind {
            PciAddrKind::Io => {
                let value = (range.base & 0xfffc) | 1;
                self.write_bar(addr, nr, value as u32);
            }
            PciAddrKind::Mem32 => {
                let value = range.base & 0xffff_fff0;
                self.write_bar(addr, nr, value as u32);
            }
            PciAddrKind::Mem64 => {
                let value_lo = (range.base & 0xffff_fff0) | 4;
                let value_hi = range.base >> 32;
                self.write_bar(addr, nr, value_lo as u32);
                self.write_bar(addr, nr + 1, value_hi as u32);
            }
        }
    }
}

pub fn pci_foreach_device<F>(pcihost: &dyn PciHost, bus: u8, mut function: F)
where
    F: FnMut(&PciDevice),
{
    for slot in 0..32 {
        for func in 0..8 {
            if let Some(dev) = pcihost.try_device(bus, slot, func) {
                function(&dev);
                if func == 0 && !pcihost.is_mfd(&dev) {
                    break;
                }
            }
        }
    }
}