Skip to content

Commit adf5e8b

Browse files
authored
Document supported transports and features. (#15)
1 parent 95f35b0 commit adf5e8b

File tree

1 file changed

+36
-13
lines changed

1 file changed

+36
-13
lines changed

README.md

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,43 @@
44

55
VirtIO guest drivers in Rust. For **no_std** environment.
66

7-
## Components
8-
9-
| Device | Status |
10-
| -------- | ------------------- |
11-
| Queue ||
12-
| Block ||
13-
| Net ||
14-
| GPU ||
15-
| Input ||
16-
| Console ||
17-
| ... | ❌ Not implemented |
7+
## Support status
8+
9+
### Device types
10+
11+
| Device | Supported |
12+
| ------- | --------- |
13+
| Block ||
14+
| Net ||
15+
| GPU ||
16+
| Input ||
17+
| Console ||
18+
| ... ||
19+
20+
### Transports
21+
22+
| Transport | Supported | |
23+
| ----------- | --------- | --------- |
24+
| Legacy MMIO || version 1 |
25+
| MMIO || version 2 |
26+
| PCI || |
27+
28+
### Device-independent features
29+
30+
| Feature flag | Supported | |
31+
| ---------------------------- | --------- | --------------------------------------- |
32+
| `VIRTIO_F_INDIRECT_DESC` || Indirect descriptors |
33+
| `VIRTIO_F_EVENT_IDX` || `avail_event` and `used_event` fields |
34+
| `VIRTIO_F_VERSION_1` | TODO | VirtIO version 1 compliance |
35+
| `VIRTIO_F_ACCESS_PLATFORM` || Limited device access to memory |
36+
| `VIRTIO_F_RING_PACKED` || Packed virtqueue layout |
37+
| `VIRTIO_F_IN_ORDER` || Optimisations for in-order buffer usage |
38+
| `VIRTIO_F_ORDER_PLATFORM` || Platform ordering for memory access |
39+
| `VIRTIO_F_SR_IOV` || Single root I/O virtualization |
40+
| `VIRTIO_F_NOTIFICATION_DATA` || Extra data in device notifications |
1841

1942
## Examples & Tests
2043

21-
* x86_64 (TODO)
44+
- x86_64 (TODO)
2245

23-
* [RISCV](./examples/riscv)
46+
- [RISCV](./examples/riscv)

0 commit comments

Comments
 (0)