For an application to be able to create "transfer" rte_flows for mlx5
devices, it should have cap_sys_rawio capability.
Document it.
Fixes: f772cc424c45 ("doc: add required Linux capabilities in mlx5 guide")
Cc: [email protected]
Signed-off-by: Eli Britstein <[email protected]>
Reviewed-by: Gaetan Rivet <[email protected]>
---
doc/guides/nics/mlx5.rst | 18 ++++++++++++------
1 file changed, 12 insertions(+), 6 deletions(-)
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 7c50497fbc..7ef682a8fb 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -458,16 +458,14 @@ Run as non-root
^^^^^^^^^^^^^^^
In order to run as a non-root user,
-some capabilities must be granted to the application::
+some capabilities must be granted to the application, while others are
+optional for some use cases. Capabilities can be set for example using
+the setcap utilitiy::
- setcap cap_sys_admin,cap_net_admin,cap_net_raw,cap_ipc_lock+ep <dpdk-app>
+ setcap
cap_net_admin,cap_net_raw,cap_ipc_lock,cap_sys_admin,cap_sys_rawio+ep <dpdk-app>
Below are the reasons of the need for each capability:
-``cap_sys_admin``
- When using physical addresses (PA mode), with Linux >= 4.0,
- for access to ``/proc/self/pagemap``.
-
``cap_net_admin``
For device configuration.
@@ -477,6 +475,14 @@ Below are the reasons of the need for each capability:
``cap_ipc_lock``
For DMA memory pinning.
+``cap_sys_admin`` optional
+ When using physical addresses (PA mode), with Linux >= 4.0,
+ for access to ``/proc/self/pagemap``.
+
+``cap_sys_rawio`` optional
+ For the application to be able to apply rte_flow flows in transfer
+ mode.
+
Driver options
^^^^^^^^^^^^^^
--
2.28.0.2311.g225365fb51
