Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
add vfio-e1000 compilation notice
  • Loading branch information
FlorianFreudiger authored Oct 20, 2023
1 parent 36f97b7 commit cae125d
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ by including the generate-bindings feature.
#### Dependencies
To build the binary you will need
- All the dependencies of [libvfio-user](https://github.com/nutanix/libvfio-user),
namely the libraries of `json-c` and `cmocka`.
namely the libraries of `json-c` and `cmocka`.
- `libclang` for [libvfio-user-rs](https://github.com/vmuxIO/libvfio-user-rs).

### Release build
Expand Down Expand Up @@ -67,6 +67,11 @@ If you use the intel-iommu device in QEMU make sure to add `caching-mode=on` for
Newer libvfio-user and QEMU versions may change the mechanism of the underlying communication
and thus may require updates to [libvfio-user-rs](https://github.com/vmuxIO/libvfio-user-rs) and nic-emu.

### vfio-e1000
[vfio-e1000](https://github.com/mmisono/vfio-e1000)
must be compiled with MSI interrupt support (`-DMSI`),
unless polling mode (`-DPOLL`) is used.

## References
- https://www.intel.com/content/dam/doc/manual/pci-pci-x-family-gbe-controllers-software-dev-manual.pdf
- https://github.com/qemu/qemu/blob/master/hw/net/e1000.c - reference implementation
Expand Down

0 comments on commit cae125d

Please sign in to comment.