diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/pcie_sriov.txt | 8 | ||||
| -rw-r--r-- | docs/system/index.rst | 1 | ||||
| -rw-r--r-- | docs/system/sriov.rst | 36 |
3 files changed, 3 insertions, 42 deletions
diff --git a/docs/pcie_sriov.txt b/docs/pcie_sriov.txt index ab2142807f..a47aad0bfa 100644 --- a/docs/pcie_sriov.txt +++ b/docs/pcie_sriov.txt @@ -52,11 +52,9 @@ setting up a BAR for a VF. ... /* Add and initialize the SR/IOV capability */ - if (!pcie_sriov_pf_init(d, 0x200, "your_virtual_dev", - vf_devid, initial_vfs, total_vfs, - fun_offset, stride, errp)) { - return; - } + pcie_sriov_pf_init(d, 0x200, "your_virtual_dev", + vf_devid, initial_vfs, total_vfs, + fun_offset, stride); /* Set up individual VF BARs (parameters as for normal BARs) */ pcie_sriov_pf_init_vf_bar( ... ) diff --git a/docs/system/index.rst b/docs/system/index.rst index 718e9d3c56..c21065e519 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -39,4 +39,3 @@ or Hypervisor.Framework. multi-process confidential-guest-support vm-templating - sriov diff --git a/docs/system/sriov.rst b/docs/system/sriov.rst deleted file mode 100644 index a851a66a4b..0000000000 --- a/docs/system/sriov.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. SPDX-License-Identifier: GPL-2.0-or-later - -Compsable SR-IOV device -======================= - -SR-IOV (Single Root I/O Virtualization) is an optional extended capability of a -PCI Express device. It allows a single physical function (PF) to appear as -multiple virtual functions (VFs) for the main purpose of eliminating software -overhead in I/O from virtual machines. - -There are devices with predefined SR-IOV configurations, but it is also possible -to compose an SR-IOV device yourself. Composing an SR-IOV device is currently -only supported by virtio-net-pci. - -Users can configure an SR-IOV-capable virtio-net device by adding -virtio-net-pci functions to a bus. Below is a command line example: - -.. code-block:: shell - - -netdev user,id=n -netdev user,id=o - -netdev user,id=p -netdev user,id=q - -device pcie-root-port,id=b - -device virtio-net-pci,bus=b,addr=0x0.0x3,netdev=q,sriov-pf=f - -device virtio-net-pci,bus=b,addr=0x0.0x2,netdev=p,sriov-pf=f - -device virtio-net-pci,bus=b,addr=0x0.0x1,netdev=o,sriov-pf=f - -device virtio-net-pci,bus=b,addr=0x0.0x0,netdev=n,id=f - -The VFs specify the paired PF with ``sriov-pf`` property. The PF must be -added after all VFs. It is the user's responsibility to ensure that VFs have -function numbers larger than one of the PF, and that the function numbers -have a consistent stride. - -You may also need to perform additional steps to activate the SR-IOV feature on -your guest. For Linux, refer to [1]_. - -.. [1] https://docs.kernel.org/PCI/pci-iov-howto.html |