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 ECBD1460EE;
	Tue, 28 Jan 2025 09:15:58 +0100 (CET)
Received: from mails.dpdk.org (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id BA12A40150;
	Tue, 28 Jan 2025 09:15:58 +0100 (CET)
Received: from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com
 [67.231.156.173])
 by mails.dpdk.org (Postfix) with ESMTP id 39A1A40144
 for <dev@dpdk.org>; Tue, 28 Jan 2025 09:15:56 +0100 (CET)
Received: from pps.filterd (m0431383.ppops.net [127.0.0.1])
 by mx0b-0016f401.pphosted.com (8.18.1.2/8.18.1.2) with ESMTP id 50S6oWQd009921;
 Tue, 28 Jan 2025 00:15:55 -0800
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=
 cc:content-transfer-encoding:content-type:date:from:message-id
 :mime-version:subject:to; s=pfpt0220; bh=4Q9gVZ1+f8nLDClsVYHs14U
 vjngA5QlGcfeHPD00MR4=; b=iFcF7h6NlNiKO5GJAuFgnFiiYoa9peYW5qD72m4
 7ArdbLJHpyLcXUrzAaufqrhcUOCvqCpOQuDekHa9bc3T7GPriLyMe3wM0/8E9llz
 d4S+il8e4+pkESWmAJTCQbGZADt3tFXiRLdZ3T9iYz8I81GzTD40yjbUsVCFKW3z
 EsjiVnykJ87P3J/n2hjIbgpth1yEUPiLoLdQWKTcuVw5MdxgXSdypNTI/mlFfzsV
 K5XAzyrSefBZjlggqQSndkqEbYLmmDlEBaZV+PjyFk2FNtaMpIpCCz0vZvwEnPv/
 xMIqSCD2FeHyzHteHi7nFp7ctNfnUKhOWhWZIJfo+5FT3+g==
Received: from dc5-exch05.marvell.com ([199.233.59.128])
 by mx0b-0016f401.pphosted.com (PPS) with ESMTPS id 44etaw833a-1
 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT);
 Tue, 28 Jan 2025 00:15:55 -0800 (PST)
Received: from DC5-EXCH05.marvell.com (10.69.176.209) by
 DC5-EXCH05.marvell.com (10.69.176.209) with Microsoft SMTP Server
 (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id
 15.2.1544.4; Tue, 28 Jan 2025 00:15:53 -0800
Received: from maili.marvell.com (10.69.176.80) by DC5-EXCH05.marvell.com
 (10.69.176.209) with Microsoft SMTP Server id 15.2.1544.4 via Frontend
 Transport; Tue, 28 Jan 2025 00:15:53 -0800
Received: from anoobj2204.marvell.com (unknown [10.28.34.118])
 by maili.marvell.com (Postfix) with ESMTP id 70FD83F7076;
 Tue, 28 Jan 2025 00:15:51 -0800 (PST)
From: Anoob Joseph <anoobj@marvell.com>
To: Chengwen Feng <fengchengwen@huawei.com>, Kevin Laatz
 <kevin.laatz@intel.com>, Bruce Richardson <bruce.richardson@intel.com>,
 Thomas Monjalon <thomas@monjalon.net>, David Marchand
 <david.marchand@redhat.com>
CC: Jerin Jacob <jerinj@marvell.com>, Vidya Sagar Velumuri
 <vvelumuri@marvell.com>, <dev@dpdk.org>
Subject: [PATCH] doc: update ODM dmadev guide
Date: Tue, 28 Jan 2025 08:15:40 +0000
Message-ID: <20250128081550.1005874-1-anoobj@marvell.com>
X-Mailer: git-send-email 2.45.2
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
X-Proofpoint-GUID: gzEKZnMLg7GlPy6ou7XfbjQSVhJKzOPw
X-Proofpoint-ORIG-GUID: gzEKZnMLg7GlPy6ou7XfbjQSVhJKzOPw
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.293,Aquarius:18.0.1057,Hydra:6.0.680,FMLib:17.12.68.34
 definitions=2025-01-28_02,2025-01-27_01,2024-11-22_01
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

Update ODM dmadev guide with details on ODM PF driver application. The
kernel PF driver module is being removed and so the steps specific to
that is also removed.

Signed-off-by: Anoob Joseph <anoobj@marvell.com>
---
 doc/guides/dmadevs/odm.rst | 39 ++++++++++++++------------------------
 1 file changed, 14 insertions(+), 25 deletions(-)

diff --git a/doc/guides/dmadevs/odm.rst b/doc/guides/dmadevs/odm.rst
index cc2ae95275..f4be87a966 100644
--- a/doc/guides/dmadevs/odm.rst
+++ b/doc/guides/dmadevs/odm.rst
@@ -13,18 +13,14 @@ ODM DMA device can support up to 32 queues and 16 VFs.
 Device Setup
 ------------
 
-ODM DMA device is initialized by kernel PF driver.
-The PF kernel driver is part of Marvell software packages for Odyssey.
+The ODM DMA device is initialized by the ODM PF driver application, which is
+responsible for configuring the device and creating VFs.
 
-Kernel module can be inserted as in below example::
+The driver can be downloaded from GitHub using the following link
+`<https://github.com/MarvellEmbeddedProcessors/odm_pf_driver>`_
 
-   sudo insmod odyssey_odm.ko
-
-ODM DMA device can support up to 16 VFs::
-
-   sudo echo 16 > /sys/bus/pci/devices/0000\:08\:00.0/sriov_numvfs
-
-Above command creates 16 VFs with 2 queues each.
+Instructions for enabling the ODM PF driver are provided in the repository's
+README file.
 
 The ``dpdk-devbind.py`` script, included with DPDK,
 can be used to show the presence of supported hardware.
@@ -59,18 +55,19 @@ for details on operation enqueue and submission API usage.
 Performance Tuning Parameters
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To achieve higher performance, DMA device needs to be tuned
-using PF kernel driver module parameters.
+To achieve higher performance, the DMA device needs to be tuned using the
+parameters provided by the PF driver application.
 
-Following options are exposed by kernel PF driver via devlink interface
-for tuning performance.
+The following configuration parameters are exposed by the ODM PF driver
+application
 
-``eng_sel``
+``ENG_SEL``
 
   ODM DMA device has 2 engines internally. Engine to queue mapping is decided
-  by a hardware register which can be configured as below::
+  by a hardware register which can be configured by updating the configuration
+  file::
 
-     /sbin/devlink dev param set pci/0000:08:00.0 name eng_sel value 3435973836 cmode runtime
+     ENG_SEL="0xCCCCCCCC"
 
   Each bit in the register corresponds to one queue.
   Each queue would be associated with one engine.
@@ -81,11 +78,3 @@ for tuning performance.
   ``1100 1100 1100 1100 1100 1100 1100 1100``
   which allows for alternate engines to be used with alternate VFs
   (assuming the system has 16 VFs with 2 queues each).
-
-``max_load_request``
-
-  Specifies maximum outstanding load requests on internal bus.
-  Values can range from 1 to 512.
-  Set to 512 for maximum requests in flight.::
-
-     /sbin/devlink dev param set pci/0000:08:00.0 name max_load_request value 512 cmode runtime
-- 
2.45.2