Convert to PCI "--allow" devarg format. The documentation
was previously using the "--vdev" form, which cannot be used with the
DLB2 PF PMD.
Fixes: 166378a79412 ("event/dlb2: add documentation and build infrastructure")
Cc: sta...@dpdk.org
Signed-off-by: Timothy McDaniel <timothy.mcdan...@intel.com>
---
Cc: timothy.mcdan...@intel.com
---
doc/guides/eventdevs/dlb2.rst | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/doc/guides/eventdevs/dlb2.rst b/doc/guides/eventdevs/dlb2.rst
index 3f4bab97a..bce984ca0 100644
--- a/doc/guides/eventdevs/dlb2.rst
+++ b/doc/guides/eventdevs/dlb2.rst
@@ -152,19 +152,19 @@ These pools' sizes are controlled by the nb_events_limit
field in struct
rte_event_dev_config. The load-balanced pool is sized to contain
nb_events_limit credits, and the directed pool is sized to contain
nb_events_limit/4 credits. The directed pool size can be overridden with the
-num_dir_credits vdev argument, like so:
+num_dir_credits devargs argument, like so:
.. code-block:: console
- --vdev=dlb2_event,num_dir_credits=<value>
+ --allow ea:00.0,num_dir_credits=<value>
This can be used if the default allocation is too low or too high for the
-specific application needs. The PMD also supports a vdev arg that limits the
+specific application needs. The PMD also supports a devarg that limits the
max_num_events reported by rte_event_dev_info_get():
.. code-block:: console
- --vdev=dlb2_event,max_num_events=<value>
+ --allow ea:00.0,max_num_events=<value>
By default, max_num_events is reported as the total available load-balanced
credits. If multiple DLB-based applications are being used, it may be desirable
@@ -315,11 +315,11 @@ buffer space (e.g. if not all queues are used, or aren't
used for atomic
scheduling).
The PMD provides a dev arg to override the default per-queue allocation. To
-increase a vdev's per-queue atomic-inflight allocation to (for example) 64:
+increase per-queue atomic-inflight allocation to (for example) 64:
.. code-block:: console
- --vdev=dlb2_event,atm_inflights=64
+ --allow ea:00.0,atm_inflights=64
QID Depth Threshold
~~~~~~~~~~~~~~~~~~~
@@ -342,9 +342,9 @@ shown below.
.. code-block:: console
- --vdev=dlb2_event,qid_depth_thresh=all:<threshold_value>
- --vdev=dlb2_event,qid_depth_thresh=qidA-qidB:<threshold_value>
- --vdev=dlb2_event,qid_depth_thresh=qid:<threshold_value>
+ --allow ea:00.0,qid_depth_thresh=all:<threshold_value>
+ --allow ea:00.0,qid_depth_thresh=qidA-qidB:<threshold_value>
+ --allow ea:00.0,qid_depth_thresh=qid:<threshold_value>
Class of service
~~~~~~~~~~~~~~~~
@@ -366,10 +366,10 @@ Class of service can be specified in the devargs, as
follows
.. code-block:: console
- --vdev=dlb2_event,cos=<0..4>
+ --allow ea:00.0,cos=<0..4>
Use X86 Vector Instructions
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
DLB supports using x86 vector instructions to optimize the data path.
@@ -379,4 +379,4 @@ follows
.. code-block:: console
- --allow ea:00.0,vector_opts_enabled=<y/Y>
+ --allow ea:00.0,vector_opts_enabled=<y/Y>
--
2.23.0
