From patchwork Tue Mar 12 04:22:01 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Vipin Varghese X-Patchwork-Id: 138177 X-Patchwork-Delegate: thomas@monjalon.net 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 C208443C8A; Tue, 12 Mar 2024 05:22:25 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 688ED402DC; Tue, 12 Mar 2024 05:22:25 +0100 (CET) Received: from NAM10-DM6-obe.outbound.protection.outlook.com (mail-dm6nam10on2084.outbound.protection.outlook.com [40.107.93.84]) by mails.dpdk.org (Postfix) with ESMTP id CF6FC40282 for ; Tue, 12 Mar 2024 05:22:22 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=j2JrG1tijEVuFQ83vinfctF3rOjAlGwNHKfGEcO9yRbJMQajmbSAhomOttaa0QRzCllKNOG+HNLdHtfiE89THltvNG4N67QYmD+0VH5ReWl3TRrXt/3TIOMbNoRvyPkQxcchE8G2jFmSeyEEsH3HDKs9wJ9cFhy36ViBQB9EYVvbWorvz4yuAtUJ7ogGlooEzuZw6GXB/jHH3ag2nlWPLZRFEpsehx2pa51iilyeWjfo76RYz7ocPagbDA9pR/J2aIVLZdaYIcF2pG37ZBWhqArB+0n4CRKn2xX6k+fjBS4JJ6cubS1DeqfUDXuNtie2GIe4DViiEWlAyhnfwECMcw== 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=EFW3nrvjKjEsng4J9JalSr3tHfZcJk7MULQj6M1JiF0=; b=h2tSQSMpLMLzXrYJB+ZeqtZRTstUSx44iO1xcfEfSgCj/9bnaYBOpusatpebQQIv0b60YEARtjvAFIesVMkb+BCjIy0rYrdMvSe+Hi5gB2qV9REsPmP+MwXWO80hkHXFPeCrY0gxlyKhcVs6tIbNYrtSY5zeZ66EuZACYztLMpwFM4rqvw6fxAl6MuvplfB6tkF4ZjaLVObetanPJxi5qo58sLVzeEHhgmFUXFsSAFJcZQ1d4G7f4IA5yWmbkO6iYAukD+/3La6VcyXX+TlY5bEhiGZy/waqr54xiy7UIxBsrPmKijol77Ik5PF16QQZhv6Yno7RZmmharIXtF20tw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 165.204.84.17) smtp.rcpttodomain=dpdk.org smtp.mailfrom=amd.com; dmarc=pass (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com; dkim=none (message not signed); arc=none (0) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=EFW3nrvjKjEsng4J9JalSr3tHfZcJk7MULQj6M1JiF0=; b=CGNCXZRdgd3GEtQbnaqUwjD3SJdWpQdmrOU64zW2d6SDHPEVp1cijyc99rGjwaHw0r+7snlKtcP5+7JDku8owL6JZ8L1YOkO8OJdbcO9/2A0w9dmetpQ4Zhcn+X/nUMBWi2Hp3ogoB3TAvrwNVL6BLFmw/sh9tgnLVZB1EGZGIw= Received: from SJ0PR05CA0070.namprd05.prod.outlook.com (2603:10b6:a03:332::15) by SA3PR12MB9132.namprd12.prod.outlook.com (2603:10b6:806:394::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7362.35; Tue, 12 Mar 2024 04:22:21 +0000 Received: from SJ1PEPF00001CE0.namprd05.prod.outlook.com (2603:10b6:a03:332:cafe::e9) by SJ0PR05CA0070.outlook.office365.com (2603:10b6:a03:332::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7386.16 via Frontend Transport; Tue, 12 Mar 2024 04:22:21 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 165.204.84.17) smtp.mailfrom=amd.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=amd.com; Received-SPF: Pass (protection.outlook.com: domain of amd.com designates 165.204.84.17 as permitted sender) receiver=protection.outlook.com; client-ip=165.204.84.17; helo=SATLEXMB04.amd.com; pr=C Received: from SATLEXMB04.amd.com (165.204.84.17) by SJ1PEPF00001CE0.mail.protection.outlook.com (10.167.242.8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.20.7386.12 via Frontend Transport; Tue, 12 Mar 2024 04:22:20 +0000 Received: from BLR-5CG134626B.amd.com (10.180.168.240) by SATLEXMB04.amd.com (10.181.40.145) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.35; Mon, 11 Mar 2024 23:22:18 -0500 From: Vipin Varghese To: , CC: , Subject: [PATCH v2] doc: update size parameter details Date: Tue, 12 Mar 2024 09:52:01 +0530 Message-ID: <20240312042201.157-1-vipin.varghese@amd.com> X-Mailer: git-send-email 2.41.0.windows.3 In-Reply-To: <20231212104508.1941-1-vipin.varghese@amd.com> References: <20231212104508.1941-1-vipin.varghese@amd.com> MIME-Version: 1.0 X-Originating-IP: [10.180.168.240] X-ClientProxiedBy: SATLEXMB04.amd.com (10.181.40.145) To SATLEXMB04.amd.com (10.181.40.145) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: SJ1PEPF00001CE0:EE_|SA3PR12MB9132:EE_ X-MS-Office365-Filtering-Correlation-Id: cbd5de2f-92ff-43bc-cca0-08dc424c0284 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: 3fAq7oSTPHR/wEmonpNN2PmRpboJ8riT+QkSGtlwqkD4PBGQ73XKLRUWSiPwyQFq2aQMrP+Tw5SdUeTGMZyagk0N5AnItpAyiU13FfH/VU9UMoVrhLBegC1dS1yTBu05YA0NEuHmzD2T2N/wSBVxUxpTClhz6AP6OSaeOgJd/k1+ekaXj1h5w8ioXBwQVtNWSKRx1OYAz7OKYd7vRU+T9qE6IGrV9pVNPFvyaGLOKcU4S71psoLjbDdgE3u2ha5Ymy8OgWIgcHxpkNawJ11V2d/VHuHGWWGAFWhv6YKsngYCyyC5HFkDNVlPSbCRaT3VzRGgohQ1oVc0x3BOIqMAjWZx9R8nskRKtG5UDStST3v2wKCZ7VrABbh40ELYSJiAA/E3Fmst6L2UJWax0a7aIt+NO5jH/HASSGoDdTIzUt0AIliYJjbBjl5C72qRj437umBAsV47W37kGJXQJdSSLTgGJTpvPAk5y7b82l9yE2Y2uDu0kk/jDVJouBAI35Z2SOqEK9DqgC+4GsnEH34V3o6ZkeYdAPn3osTH1mY/cfajjL4nz4TH/i+W5dW0ymouz4SdGEm/lVqtHN2kJ6WZV8hu5SVTsZdMbstXJSyBplze3IAmDDEreaV1Gg2ssTpwgV4s8N/QQJXMcGaBN/+PB/G+TVXe9TZphWmxVkPZ65E2avveZBVYHgBPgr9oRK+Db8zrODpsfMN1SNcSAK1rXJ8hmKOyRVin5DiitxtkYXzj70uZn0S4NnbbvDu1R4MM X-Forefront-Antispam-Report: CIP:165.204.84.17; CTRY:US; LANG:en; SCL:1; SRV:; IPV:CAL; SFV:NSPM; H:SATLEXMB04.amd.com; PTR:InfoDomainNonexistent; CAT:NONE; SFS:(13230031)(82310400014)(1800799015)(36860700004)(376005); DIR:OUT; SFP:1101; X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Mar 2024 04:22:20.5723 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: cbd5de2f-92ff-43bc-cca0-08dc424c0284 X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=3dd8961f-e488-4e60-8e11-a82d994e183d; Ip=[165.204.84.17]; Helo=[SATLEXMB04.amd.com] X-MS-Exchange-CrossTenant-AuthSource: SJ1PEPF00001CE0.namprd05.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA3PR12MB9132 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 For configuration parameters `mem_size` and `buf_size` are represented as megabytes and bytes respectively in application. Update the documentation and to represent the same. V2 Changes: - add mem_size and buf_size in config.ini, suggested by Chengwen. Signed-off-by: Vipin Varghese Acked-by: Chengwen Feng --- --- app/test-dma-perf/config.ini | 4 ++-- doc/guides/tools/dmaperf.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/app/test-dma-perf/config.ini b/app/test-dma-perf/config.ini index b550f4b23f..17aa91c22d 100644 --- a/app/test-dma-perf/config.ini +++ b/app/test-dma-perf/config.ini @@ -5,8 +5,8 @@ ; Supported test types are DMA_MEM_COPY and CPU_MEM_COPY. ; Parameters: -; "mem_size" denotes the size of the memory footprint. -; "buf_size" denotes the memory size of a single operation. +; "mem_size" denotes the size of the memory footprint in megabytes (MB) for source and destination. +; "buf_size" denotes the memory size of a single operation in bytes (B). ; "dma_ring_size" denotes the dma ring buffer size. It should be must be a power of two, and between ; 64 and 4096. ; "kick_batch" denotes the dma operation batch size, and should be greater than 1 normally. diff --git a/doc/guides/tools/dmaperf.rst b/doc/guides/tools/dmaperf.rst index 9e3e78a6b7..6f85fceb8a 100644 --- a/doc/guides/tools/dmaperf.rst +++ b/doc/guides/tools/dmaperf.rst @@ -74,10 +74,10 @@ Configuration Parameters Currently supported types are ``DMA_MEM_COPY`` and ``CPU_MEM_COPY``. ``mem_size`` - The size of the memory footprint. + The size of the memory footprint in megabytes (MB) for source and destination. ``buf_size`` - The memory size of a single operation. + The memory size of a single operation in bytes (B). ``dma_ring_size`` The DMA ring buffer size. Must be a power of two, and between ``64`` and ``4096``.