Forráskód Böngészése

Document supported transports and features. (#15)

Andrew Walbran 2 éve
szülő
commit
adf5e8b650
1 módosított fájl, 36 hozzáadás és 13 törlés
  1. 36 13
      README.md

+ 36 - 13
README.md

@@ -4,20 +4,43 @@
 
 VirtIO guest drivers in Rust. For **no_std** environment.
 
-## Components
-
-| Device   | Status              |
-| -------- | ------------------- |
-| Queue    | ✅                 |
-| Block    | ✅                 |
-| Net      | ✅                 |
-| GPU      | ✅                 |
-| Input    | ✅                 |
-| Console  | ✅                 |
-| ...      | ❌ Not implemented |
+## Support status
+
+### Device types
+
+| Device  | Supported |
+| ------- | --------- |
+| Block   | ✅        |
+| Net     | ✅        |
+| GPU     | ✅        |
+| Input   | ✅        |
+| Console | ✅        |
+| ...     | ❌        |
+
+### Transports
+
+| Transport   | Supported |           |
+| ----------- | --------- | --------- |
+| Legacy MMIO | ✅        | version 1 |
+| MMIO        | ✅        | version 2 |
+| PCI         | ❌        |           |
+
+### Device-independent features
+
+| Feature flag                 | Supported |                                         |
+| ---------------------------- | --------- | --------------------------------------- |
+| `VIRTIO_F_INDIRECT_DESC`     | ❌        | Indirect descriptors                    |
+| `VIRTIO_F_EVENT_IDX`         | ❌        | `avail_event` and `used_event` fields   |
+| `VIRTIO_F_VERSION_1`         | TODO      | VirtIO version 1 compliance             |
+| `VIRTIO_F_ACCESS_PLATFORM`   | ❌        | Limited device access to memory         |
+| `VIRTIO_F_RING_PACKED`       | ❌        | Packed virtqueue layout                 |
+| `VIRTIO_F_IN_ORDER`          | ❌        | Optimisations for in-order buffer usage |
+| `VIRTIO_F_ORDER_PLATFORM`    | ❌        | Platform ordering for memory access     |
+| `VIRTIO_F_SR_IOV`            | ❌        | Single root I/O virtualization          |
+| `VIRTIO_F_NOTIFICATION_DATA` | ❌        | Extra data in device notifications      |
 
 ## Examples & Tests
 
-* x86_64 (TODO)
+- x86_64 (TODO)
 
-* [RISCV](./examples/riscv)
+- [RISCV](./examples/riscv)