diff mbox series

[v3,3/3] doc: document --iova-mode EAL option

Message ID 1538599994-23331-4-git-send-email-eric.zhang@windriver.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series force IOVA to a particular mode |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

eric zhang Oct. 3, 2018, 8:53 p.m. UTC 
  This patch updates Programmer's Guide and EAL parameter guides
to show EAL option "--iova-mode" support.

Signed-off-by: eric zhang <eric.zhang@windriver.com>
---
 doc/guides/prog_guide/env_abstraction_layer.rst | 8 ++++++++
 doc/guides/testpmd_app_ug/run_app.rst           | 4 ++++
 2 files changed, 12 insertions(+)

Comments

Kovacevic, Marko Oct. 18, 2018, 1:18 p.m. UTC | #1 
Only one thing I noticed:

Running git log check: 45999
Wrong headline lowercase:
        doc: document --iova-mode EAL option

All else seem ok.

Reviewed-by: Marko Kovacevic <marko.kovacevic@intel.com>
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst
index 34d871c..208c454 100644
--- a/doc/guides/prog_guide/env_abstraction_layer.rst
+++ b/doc/guides/prog_guide/env_abstraction_layer.rst
@@ -225,6 +225,14 @@  Misc Functions
 
 Locks and atomic operations are per-architecture (i686 and x86_64).
 
+IOVA Mode Configuration
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Auto detection of the IOVA mode, based on probing the bus and IOMMU configuration, may not report
+the desired addressing mode when virtual devices that are not directly attached to the bus are present.
+To facilitate forcing the IOVA mode to a specific value the EAL command line option ``--iova-mode`` can
+be used to select either physical addressing('pa') or virtual addressing('va').
+
 Memory Segments and Memory Zones (memzone)
 ------------------------------------------
 
diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
index 4c0d2ce..94fd0cc 100644
--- a/doc/guides/testpmd_app_ug/run_app.rst
+++ b/doc/guides/testpmd_app_ug/run_app.rst
@@ -156,6 +156,10 @@  See the DPDK Getting Started Guides for more information on these options.
 
     Use malloc instead of hugetlbfs.
 
+*   ``--iova-mode <pa|va>``
+
+    Force IOVA mode to a specific value.
+
 
 Testpmd Command-line Options
 ----------------------------