From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 8DC05A0560;
	Sun, 13 Nov 2022 10:22:17 +0100 (CET)
Received: from mails.dpdk.org (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id 267C7410E5;
	Sun, 13 Nov 2022 10:22:17 +0100 (CET)
Received: from NAM11-CO1-obe.outbound.protection.outlook.com
 (mail-co1nam11on2063.outbound.protection.outlook.com [40.107.220.63])
 by mails.dpdk.org (Postfix) with ESMTP id DBA6840150
 for <dev@dpdk.org>; Sun, 13 Nov 2022 10:22:15 +0100 (CET)
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none;
 b=je7YrEVth3fc199cwMEs+b40Kuksc+FyoLlHH+sLhFZ+upOZIQT1SPVlcCvNROP6+zoG4PlLFMVCm15mqF0lXDaQSD/gxCZsTVWQNvMP0MZnm7Lfvaj9MVGTmNv7uihtP8JlZEyI+xl5ME65Q2uJU3tTEsADoPZ7K2jxNXrYZopv8qmfFermBchBXm2rYhVsKrU+NfWcLMrPdHMLpk2sjibj/dEk5zR7m6QePDUtf6kmul/cz6dQhgljwcuzHZTlR9tc0ItdOBh28o+iH/zJxlWJbQekCKwjyK7wOgjcqBRihfVm+6Qpa1EXZQmMu1ctuAg0Q8qcMhW5dGFFyvyHWw==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; 
 s=arcselector9901;
 h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1;
 bh=O8L9cVhaFY+pjJbAlaDLQClXlaQZ4LZQ1a9g1uJ1hk8=;
 b=ak8Ak4QrAIFcZObtR4lBFzKVGc8QR9TMkEZwpYrBkui/ECrrUkvf/8y/MQ7v5fWjVoRblco2DAtPQUJ27hT+gqkiPoiNR9RR3n4iX0VNaMbhVzhIb3KOnIfDqr9FRbfxEVY59YrAnXishPyWtQM9SKkJ501Nx4CzaDcc7g2Xx/145TjQoxIf9d8MDK9N2iU0qGgr8EeY0p3GIFK3869pNSSEM+GzxiKUJeTL0Ee4Ru7m47Gx+6dI/1qJNAhceDlYVB50t9mqNxgvWtHUEoEeiuHYpHmB0vernFyy8weF4HmS2J9KtreJ75J0YR+XRF81/cuib/KjO91WIXvdLXxiHQ==
ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is
 216.228.117.161) smtp.rcpttodomain=redhat.com smtp.mailfrom=nvidia.com;
 dmarc=pass (p=reject sp=reject pct=100) action=none header.from=nvidia.com;
 dkim=none (message not signed); arc=none
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com;
 s=selector2;
 h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck;
 bh=O8L9cVhaFY+pjJbAlaDLQClXlaQZ4LZQ1a9g1uJ1hk8=;
 b=XHxqDtjrFP3xJbOLUubhnUVmiO8XUSjJhNh6anFyRrTUtdfRi6aB53b8uXsQ2r6cpcE6yF6adHo4SdbBsYCVEAlsbybmQtOnHQP1Jub34JyQEJimI4FB+RqayDdNcnHyIGMGrHvialunEt6YxQnnaYSsBqvZ+C2rDMO7l52XM9iOCuXnppt6uam6iMO0zoSlb8O8yNAVEPj3iDvxWzPAE3a6gFIIKx4wNj2I2SkOJabQMUXSM8LAU6SWk4AGVESH+EbfKQvCJyjKttTvyRkmKGxasiAWEk6jLyI2DV0yhinCfeoLLJHCf4tXElUJRJ1yqXqq2pY6hDw0zea2aliTYQ==
Received: from BN8PR04CA0025.namprd04.prod.outlook.com (2603:10b6:408:70::38)
 by SJ1PR12MB6051.namprd12.prod.outlook.com (2603:10b6:a03:48a::18)
 with Microsoft SMTP Server (version=TLS1_2,
 cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5813.16; Sun, 13 Nov
 2022 09:22:14 +0000
Received: from BN8NAM11FT058.eop-nam11.prod.protection.outlook.com
 (2603:10b6:408:70:cafe::e) by BN8PR04CA0025.outlook.office365.com
 (2603:10b6:408:70::38) with Microsoft SMTP Server (version=TLS1_2,
 cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5813.17 via Frontend
 Transport; Sun, 13 Nov 2022 09:22:13 +0000
X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.117.161)
 smtp.mailfrom=nvidia.com;
 dkim=none (message not signed)
 header.d=none;dmarc=pass action=none header.from=nvidia.com;
Received-SPF: Pass (protection.outlook.com: domain of nvidia.com designates
 216.228.117.161 as permitted sender) receiver=protection.outlook.com;
 client-ip=216.228.117.161; helo=mail.nvidia.com; pr=C
Received: from mail.nvidia.com (216.228.117.161) by
 BN8NAM11FT058.mail.protection.outlook.com (10.13.177.58) with Microsoft SMTP
 Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id
 15.20.5813.12 via Frontend Transport; Sun, 13 Nov 2022 09:22:13 +0000
Received: from rnnvmail201.nvidia.com (10.129.68.8) by mail.nvidia.com
 (10.129.200.67) with Microsoft SMTP Server (version=TLS1_2,
 cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.26; Sun, 13 Nov
 2022 01:21:54 -0800
Received: from nvidia.com (10.126.230.35) by rnnvmail201.nvidia.com
 (10.129.68.8) with Microsoft SMTP Server (version=TLS1_2,
 cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.36; Sun, 13 Nov
 2022 01:21:52 -0800
From: Matan Azrad <matan@nvidia.com>
To: Maxime Coquelin <maxime.coquelin@redhat.com>
CC: <dev@dpdk.org>
Subject: [PATCH] doc: improve event core description in vDPA mlx5
Date: Sun, 13 Nov 2022 11:21:37 +0200
Message-ID: <20221113092137.1252803-1-matan@nvidia.com>
X-Mailer: git-send-email 2.25.1
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
X-Originating-IP: [10.126.230.35]
X-ClientProxiedBy: rnnvmail201.nvidia.com (10.129.68.8) To
 rnnvmail201.nvidia.com (10.129.68.8)
X-EOPAttributedMessage: 0
X-MS-PublicTrafficType: Email
X-MS-TrafficTypeDiagnostic: BN8NAM11FT058:EE_|SJ1PR12MB6051:EE_
X-MS-Office365-Filtering-Correlation-Id: 028873dd-1456-41f1-98e8-08dac5588cba
X-MS-Exchange-SenderADCheck: 1
X-MS-Exchange-AntiSpam-Relay: 0
X-Microsoft-Antispam: BCL:0;
X-Microsoft-Antispam-Message-Info: ien0ODt/hdfDolgeGtO7EAP3rRJJ5A4fBSsmOBiZnWe8qzWioJUCjsMsBp5CrfslzRaa8dgnwctyAXgdWpn3J3bMHmwruiMsFYBuEuFO433bY/qjoQDRWU2M7zfH8SABUP1Z4PrjwtImsfzhr7crTfBMHKulR2dZJnSrKWVeflcqy+xuSlJH6w3qWefluP5QRnuzJxFEK3SGcgfcDqwf2LzWIiQGhBOOn0/uYuIo7NHsP22jOgV1pLa0bS4JjHGbRLMGrfCF7y25jhIXcvRHCA/p2xojjX5ruRYVx7DRi/cvLl2H3FVBfQbrsEL+g+kl0RLkcmBLCgQL7M4Y6NO/HUTCGd2W50UACzSrWChwrJ+m3CQg2CmMmBXUaMDo1B8By7IN75PKEImv3u1XSfZw8sucuHz/X5jzj3bch75z3p6LVaygHiuJAwcn1DiL61tkzNpUypRl6XVeDg2+8bhPCKWGEgUMrvWu+99NiWSjjihUeSKnPbJDo0lcc8PrBXxsFtIhHycQcmOSUOqpG54luag2rH2P5dxF7Z/jRYAmIebVSOi98X4LugVQIIkRoj6ksJHbbY+930DQmhjxFRaqDmtN1EbvzQa7fagnfJ0lHokKO5PclB2Viuj+/g/euXDCW0OPirE1zDUMEZi3ui7oZIHgUT8NCHfp0gILkf0EMlG3BbjkHpLzByY7cPGE8pjHVNn+amU2TL4vOznU26GyuLsscZnwjEFNdf8I1zb/qBgoGRrXBmjb+p+Mz63OxjTKYMZyrAW3oCoJ6MVSnIT7xw==
X-Forefront-Antispam-Report: CIP:216.228.117.161; CTRY:US; LANG:en; SCL:1; SRV:;
 IPV:NLI; SFV:NSPM; H:mail.nvidia.com; PTR:dc6edge2.nvidia.com; CAT:NONE;
 SFS:(13230022)(4636009)(39860400002)(396003)(376002)(136003)(346002)(451199015)(36840700001)(46966006)(40470700004)(36860700001)(83380400001)(316002)(86362001)(82740400003)(356005)(7636003)(40460700003)(2906002)(41300700001)(82310400005)(4326008)(5660300002)(8936002)(40480700001)(7696005)(6666004)(55016003)(6286002)(26005)(2616005)(186003)(16526019)(47076005)(426003)(336012)(6916009)(70586007)(70206006)(1076003)(8676002)(478600001)(36756003);
 DIR:OUT; SFP:1101; 
X-OriginatorOrg: Nvidia.com
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Nov 2022 09:22:13.3148 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: 028873dd-1456-41f1-98e8-08dac5588cba
X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a
X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a; Ip=[216.228.117.161];
 Helo=[mail.nvidia.com]
X-MS-Exchange-CrossTenant-AuthSource: BN8NAM11FT058.eop-nam11.prod.protection.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Anonymous
X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ1PR12MB6051
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org

The event core is mlx5 vDPA driver devarg that selects the CPU core for
the internal timer thread used to manage data-path events into the
driver.

Emphasize that this CPU should be isolated for vDPA mlx5 devices only in
order to save the performance and latency of the device.

Signed-off-by: Matan Azrad <matan@nvidia.com>
---
 doc/guides/vdpadevs/mlx5.rst | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/doc/guides/vdpadevs/mlx5.rst b/doc/guides/vdpadevs/mlx5.rst
index 9767fbe42d..3b5ce6df38 100644
--- a/doc/guides/vdpadevs/mlx5.rst
+++ b/doc/guides/vdpadevs/mlx5.rst
@@ -86,8 +86,13 @@ for an additional list of options shared with other mlx5 drivers.
 
 - ``event_core`` parameter [int]
 
-  CPU core number to set polling thread affinity to, default to control plane
-  cpu.
+  The CPU core number of the timer thread, default: EAL main lcore.
+
+.. note::
+
+   This core can be shared among different mlx5 vDPA devices as `event_core` but
+   using it also for other tasks may affect the performance and the latency of the
+   mlx5 vDPA devices.
 
 - ``max_conf_threads`` parameter [int]
 
-- 
2.25.1