Skip to content

Commit 9b18ef2

Browse files
committed
[DOCS] Include new features.
1 parent b7c5556 commit 9b18ef2

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ If instead of QEMU, you'd like to import the setup into Virt-Manager for further
4040

4141
You're done!
4242

43-
Look in the `docs` folder for more information on adding passthrough hardware (for GPU graphics), set up bridged networking, and enabling sound features.
43+
To fine-tune the system and improve performance, look in the `docs` folder for more information on [adding memory](docs/guide-performance.md), seting up [bridged networking](docs/guide-networking.md), adding [passthrough hardware (for GPUs)](docs/guide-passthrough.md), and enabling sound features.

docs/guide-networking.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,7 @@ Once you have set up the bridge and tun/tap on the host, you'll have to add the
5151
```
5252
-netdev tap,id=net0,ifname=tap0,script=no,downscript=no \
5353
```
54+
You can optionally use the `vmxnet3` driver for higher performance compared to the default e1000. Note that replacing it requires macOS El Capitan or higher.
55+
```
56+
-device vmxnet3,netdev=net0,id=net0,mac=52:54:00:c9:18:27 \
57+
```

docs/guide-passthrough.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
Guide to PCIe Passthrough
22
=========================
3-
This is a draft.
43

54
## Enable BIOS features
65
To use PCIe Passthrough, you will need a compatible motherboard and CPU with support for iommu. Look up your motherboard manual on how to enable these features, but they are commonly named `VT-d` or `AMD Vi`.
@@ -22,6 +21,9 @@ An example output might look like this:
2221

2322
The first value (`26:00.0`) is the BDF ID, and the last (`1002:6810`) is the Device ID. Cards with a built-in audio controller have to be passed together, so note the IDs for both subdevices.
2423

24+
## Load the vfio-pci module
25+
The `vfio-pci` module is not included in the kernel on all systems, you may need for load it as part of initramfs. Look up your distro's documentation on how to do this.
26+
2527
## Add Kernel Flags
2628
The `iommu` kernel module is not enabled by default, but you can enable it on boot by passing the following flags to the kernel. Replace the Device IDs with your corresponding card.
2729

@@ -35,7 +37,7 @@ iommu=pt amd_iommu=on vfio-pci.ids=1002:66af,1002:ab20
3537
iommu=pt intel_iommu=on vfio-pci.ids=1002:66af,1002:ab20
3638
```
3739

38-
To do this permanently, you can add it to your bootloader. If you're using GRUB, for example, edit `/etc/default/grub` and add the previous lines to the `GRUB_CMDLINE_LINUX_DEFAULT` section, then run `sudo update-grub` and reboot.
40+
To do this permanently, you can add it to your bootloader. If you're using GRUB, for example, edit `/etc/default/grub` and add the previous lines to the `GRUB_CMDLINE_LINUX_DEFAULT` section, then run `sudo update-grub` (or `sudo grub-mkconfig` on some systems) and reboot.
3941

4042
## Attach card to QEMU
4143
You will need to attach the cards using the BDF IDs for the audio and video controller. The following example shows the config for a card with two devices. The romfile parameter is optional.
@@ -44,7 +46,7 @@ You will need to attach the cards using the BDF IDs for the audio and video cont
4446

4547
```
4648
-vga none \
47-
-device ioh3420,bus=pcie.0,multifunction=on,port=1,chassis=1,id=port.1 \
49+
-device pcie-root-port,bus=pcie.0,multifunction=on,port=1,chassis=1,id=port.1 \
4850
-device vfio-pci,host=26:00.0,bus=port.1,multifunction=on,romfile=/path/to/card.rom \
4951
-device vfio-pci,host=26:00.1,bus=port.1 \
5052
```

0 commit comments

Comments
 (0)