d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: fix runtime options in DLB2 guide

Browse Source 
Convert to PCI "--allow" devarg format.
The documentation was previously using the "--vdev" form, which cannot
be used with the DLB2 PF PMD.

Fixes: f3cad285bb ("event/dlb2: add infos get and configure")
Fixes: f7cc194b0f ("event/dlb2: add enqueue and its burst variants")
Fixes: a2e4f1f5e7 ("event/dlb2: add dequeue and its burst variants")
Fixes: 95aa7101cd ("doc: add some features to DLB2 guide")
Cc: stable@dpdk.org

Signed-off-by: Timothy McDaniel <timothy.mcdaniel@intel.com>
Signed-off-by: David Marchand <david.marchand@redhat.com>
This commit is contained in:
Timothy McDaniel 2021-05-21 11:11:35 +02:00 committed by Thomas Monjalon
parent 0e94408f00
commit 9e35ae0700
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/guides/eventdevs/dlb2.rst
View File

@ -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 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 credits, and the directed pool is sized to contain
nb_events_limit/4 credits. The directed pool size can be overridden with the 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 .. 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 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(): max_num_events reported by rte_event_dev_info_get():
.. code-block:: console .. 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 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 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). scheduling).
The PMD provides a dev arg to override the default per-queue allocation. To 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 .. code-block:: console
--vdev=dlb2_event,atm_inflights=64 --allow ea:00.0,atm_inflights=64
QID Depth Threshold QID Depth Threshold
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
@ -342,9 +342,9 @@ shown below.
.. code-block:: console .. code-block:: console
--vdev=dlb2_event,qid_depth_thresh=all:<threshold_value> --allow ea:00.0,qid_depth_thresh=all:<threshold_value>
--vdev=dlb2_event,qid_depth_thresh=qidA-qidB:<threshold_value> --allow ea:00.0,qid_depth_thresh=qidA-qidB:<threshold_value>
--vdev=dlb2_event,qid_depth_thresh=qid:<threshold_value> --allow ea:00.0,qid_depth_thresh=qid:<threshold_value>
Class of service Class of service
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
@ -366,4 +366,4 @@ Class of service can be specified in the devargs, as follows
.. code-block:: console .. code-block:: console
--vdev=dlb2_event,cos=<0..4> --allow ea:00.0,cos=<0..4>