diff options
author | Stephen Finucane <stephen@that.guru> | 2018-04-19 13:57:24 +0100 |
---|---|---|
committer | Ian Stokes <ian.stokes@intel.com> | 2018-04-21 16:59:45 +0100 |
commit | b20eabc3fd5238d98c8e9bf8b60f353a2c820f5d (patch) | |
tree | 0fd54e4094d03016c57148d8b4f70078269b8f4a /Documentation | |
parent | 048c6c97dca091ba228e15fcbd44e70a197413ab (diff) | |
download | openvswitch-b20eabc3fd5238d98c8e9bf8b60f353a2c820f5d.tar.gz |
doc: Add "vdev" topic document
These are separate things from physical, ring and vhost-user interfaces
and deserve their own documents. A couple of small typos are fixed along
the way.
Signed-off-by: Stephen Finucane <stephen@that.guru>
Signed-off-by: Ian Stokes <ian.stokes@intel.com>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/automake.mk | 1 | ||||
-rw-r--r-- | Documentation/howto/dpdk.rst | 29 | ||||
-rw-r--r-- | Documentation/topics/dpdk/index.rst | 1 | ||||
-rw-r--r-- | Documentation/topics/dpdk/vdev.rst | 61 |
4 files changed, 63 insertions, 29 deletions
diff --git a/Documentation/automake.mk b/Documentation/automake.mk index 878de4349..3056e527a 100644 --- a/Documentation/automake.mk +++ b/Documentation/automake.mk @@ -37,6 +37,7 @@ DOC_SOURCE = \ Documentation/topics/dpdk/phy.rst \ Documentation/topics/dpdk/pmd.rst \ Documentation/topics/dpdk/ring.rst \ + Documentation/topics/dpdk/vdev.rst \ Documentation/topics/dpdk/vhost-user.rst \ Documentation/topics/testing.rst \ Documentation/topics/high-availability.rst \ diff --git a/Documentation/howto/dpdk.rst b/Documentation/howto/dpdk.rst index aedef839d..d3425e83b 100644 --- a/Documentation/howto/dpdk.rst +++ b/Documentation/howto/dpdk.rst @@ -244,35 +244,6 @@ Note about "Extended Statistics": vHost ports supports only partial statistics. RX packet size based counter are only supported and doesn't include TX packet size counters. -.. _vdev-support: - -Vdev Support ------------- - -DPDK provides drivers for both physical and virtual devices. Physical DPDK -devices are added to OVS by specifying a valid PCI address in 'dpdk-devargs'. -Virtual DPDK devices which do not have PCI addresses can be added using a -different format for 'dpdk-devargs'. - -Typically, the format expected is 'eth_<driver_name><x>' where 'x' is a -unique identifier of your choice for the given port. - -For example to add a dpdk port that uses the 'null' DPDK PMD driver:: - - $ ovs-vsctl add-port br0 null0 -- set Interface null0 type=dpdk \ - options:dpdk-devargs=eth_null0 - -Similarly, to add a dpdk port that uses the 'af_packet' DPDK PMD driver:: - - $ ovs-vsctl add-port br0 myeth0 -- set Interface myeth0 type=dpdk \ - options:dpdk-devargs=eth_af_packet0,iface=eth0 - -More information on the different types of virtual DPDK PMDs can be found in -the `DPDK documentation -<http://dpdk.org/doc/guides/nics/overview.html>`__. - -Note: Not all DPDK virtual PMD drivers have been tested and verified to work. - EMC Insertion Probability ------------------------- By default 1 in every 100 flows are inserted into the Exact Match Cache (EMC). diff --git a/Documentation/topics/dpdk/index.rst b/Documentation/topics/dpdk/index.rst index 4b4dc119a..c1e6ea78c 100644 --- a/Documentation/topics/dpdk/index.rst +++ b/Documentation/topics/dpdk/index.rst @@ -34,4 +34,5 @@ The DPDK Datapath /topics/dpdk/phy /topics/dpdk/vhost-user /topics/dpdk/ring + /topics/dpdk/vdev /topics/dpdk/pmd diff --git a/Documentation/topics/dpdk/vdev.rst b/Documentation/topics/dpdk/vdev.rst new file mode 100644 index 000000000..31894530b --- /dev/null +++ b/Documentation/topics/dpdk/vdev.rst @@ -0,0 +1,61 @@ +.. + Copyright 2018, Red Hat, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + + Convention for heading levels in Open vSwitch documentation: + + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + + Avoid deeper levels because they do not render well. + +==================== +DPDK Virtual Devices +==================== + +DPDK provides drivers for both physical and virtual devices. Physical DPDK +devices are added to OVS by specifying a valid PCI address in ``dpdk-devargs``. +Virtual DPDK devices which do not have PCI addresses can be added using a +different format for ``dpdk-devargs``. + +.. note:: + + Not all DPDK virtual PMD drivers have been tested and verified to work. + +.. versionadded:: 2.7.0 + +Quick Example +------------- + +To add a virtual ``dpdk`` devices, the ``dpdk-devargs`` argument should be of +the format ``eth_<driver_name><x>``, where ``x``' is a unique identifier of +your choice for the given port. For example to add a ``dpdk`` port that uses +the ``null`` DPDK PMD driver, run:: + + $ ovs-vsctl add-port br0 null0 -- set Interface null0 type=dpdk \ + options:dpdk-devargs=eth_null0 + +Similarly, to add a ``dpdk`` port that uses the ``af_packet`` DPDK PMD driver, +run:: + + $ ovs-vsctl add-port br0 myeth0 -- set Interface myeth0 type=dpdk \ + options:dpdk-devargs=eth_af_packet0,iface=eth0 + +More information on the different types of virtual DPDK PMDs can be found in +the `DPDK documentation`__. + +__ http://dpdk.org/doc/guides/nics/overview.html |