From f772cc424c455e123c649b130964fffacd6d3a5e Mon Sep 17 00:00:00 2001 From: Thomas Monjalon Date: Tue, 3 Mar 2020 00:08:53 +0100 Subject: [PATCH] doc: add required Linux capabilities in mlx5 guide If running DPDK as non-root, some extra capabilities may be required. The Mellanox devices, using a bifurcated model with Linux drivers, have some specific requirements summarized in mlx5 PMD guide. Signed-off-by: Thomas Monjalon Reviewed-by: Raslan Darawsheh --- doc/guides/nics/mlx5.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index d29ce85ed0..d08d2da14f 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -383,6 +383,32 @@ Run-time configuration - **ethtool** operations on related kernel interfaces also affect the PMD. +Run as non-root +^^^^^^^^^^^^^^^ + +In order to run as a non-root user, +some capabilities must be granted to the application:: + + setcap cap_sys_admin,cap_net_admin,cap_net_raw,cap_ipc_lock+ep + +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. + +``cap_net_raw`` + For raw ethernet queue allocation through kernel driver. + +``cap_ipc_lock`` + For DMA memory pinning. + +Driver options +^^^^^^^^^^^^^^ + - ``rxq_cqe_comp_en`` parameter [int] A nonzero value enables the compression of CQE on RX side. This feature -- 2.20.1