From patchwork Thu Apr 1 07:49:13 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eli Britstein X-Patchwork-Id: 90274 X-Patchwork-Delegate: rasland@nvidia.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id F2616A034F; Thu, 1 Apr 2021 09:49:52 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id DA77240142; Thu, 1 Apr 2021 09:49:52 +0200 (CEST) Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by mails.dpdk.org (Postfix) with ESMTP id 9B57740141 for ; Thu, 1 Apr 2021 09:49:51 +0200 (CEST) Received: from Internal Mail-Server by MTLPINE1 (envelope-from elibr@nvidia.com) with SMTP; 1 Apr 2021 10:49:48 +0300 Received: from nvidia.com (dev-r-vrt-214.mtr.labs.mlnx [10.212.214.1]) by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id 1317nmBp026584; Thu, 1 Apr 2021 10:49:48 +0300 From: Eli Britstein To: dev@dpdk.org Cc: Gaetan Rivet , Asaf Penso , Ori Kam , Thomas Monjalon , Eli Britstein , stable@dpdk.org Date: Thu, 1 Apr 2021 07:49:13 +0000 Message-Id: <20210401074913.16563-1-elibr@nvidia.com> X-Mailer: git-send-email 2.28.0.2311.g225365fb51 MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH] doc: add Linux rawio capability requirement in mlx5 guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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: stable@dpdk.org Signed-off-by: Eli Britstein Reviewed-by: Gaetan Rivet --- 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 + setcap cap_net_admin,cap_net_raw,cap_ipc_lock,cap_sys_admin,cap_sys_rawio+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. @@ -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 ^^^^^^^^^^^^^^