From patchwork Tue Jan 2 12:24:25 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Qi Zhang X-Patchwork-Id: 135643 X-Patchwork-Delegate: qi.z.zhang@intel.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 BBE76437F8; Tue, 2 Jan 2024 05:03:36 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 36A9C40A6F; Tue, 2 Jan 2024 05:03:29 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.11]) by mails.dpdk.org (Postfix) with ESMTP id 38162402BE for ; Tue, 2 Jan 2024 05:03:26 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1704168207; x=1735704207; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=EQwVtuagQMVm1qnFNnWEgKGxQSgzAZ7eDJxPY6tplVQ=; b=bjllHhDMzfm+QP74rdqbtoD7ELPL12KYY8FoBD/CmRB13KXgDYREMqlh IsGC+GQsYdFacS4GJ0pMKYCUYMvNqRzjBv7s8FzBQ2MMGlTZjZIPmFlZl kOeE1COl3d6sjEoNNxWl0xooLLLUUYg8Dv8Y4cyUKNpdyMf42QSsQdlrA ro5715mxJAGyVCcHjxLMFUNrB10NkuaB0/miq4wBB0aQHcz+yc7FCaQ6v 7ppDMGAYxVA/BSzM7UzT0EzaIYK9QihySaHr7lasG10FfrKnBspI8+2+X 3HSAF83f7QVMeLQ6k/FhsCqyD75xXorsPSVt03NsRR28/mu6PV5cXSRuZ w==; X-IronPort-AV: E=McAfee;i="6600,9927,10940"; a="3647045" X-IronPort-AV: E=Sophos;i="6.04,324,1695711600"; d="scan'208";a="3647045" Received: from orsmga007.jf.intel.com ([10.7.209.58]) by fmvoesa105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 01 Jan 2024 20:03:26 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10940"; a="772725895" X-IronPort-AV: E=Sophos;i="6.04,324,1695711600"; d="scan'208";a="772725895" Received: from dpdk-qzhan15-test02.sh.intel.com ([10.67.115.37]) by orsmga007.jf.intel.com with ESMTP; 01 Jan 2024 20:03:23 -0800 From: Qi Zhang To: qiming.yang@intel.com, wenjun1.wu@intel.com Cc: dev@dpdk.org, Qi Zhang Subject: [PATCH v5 2/2] doc: add document for diagnostic utilities Date: Tue, 2 Jan 2024 07:24:25 -0500 Message-Id: <20240102122425.3480836-2-qi.z.zhang@intel.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20240102122425.3480836-1-qi.z.zhang@intel.com> References: <20231226185428.3158880-1-qi.z.zhang@intel.com> <20240102122425.3480836-1-qi.z.zhang@intel.com> MIME-Version: 1.0 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 Document CLI for diagnose purpose. Signed-off-by: Qi Zhang --- doc/guides/nics/ice.rst | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst index 820a385b06..29309abe4d 100644 --- a/doc/guides/nics/ice.rst +++ b/doc/guides/nics/ice.rst @@ -411,6 +411,42 @@ To start ``testpmd``, and add vlan 10 to port 0: testpmd> rx_vlan add 10 0 +Diagnostic Utilities +-------------------- + +Dump DDP Package +~~~~~~~~~~~~~~~~ + +Dump the runtime packet processing pipeline configuration into a +binary file. This helps the support team diagnose hardware +configuration issues. + +Usage:: + + testpmd>ddp dump + +Dump Switch Configurations +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Dump detail hardware configurations related to the switch pipeline +stage into a binary file. + +Usage:: + + testpmd>ddp dump switch + +Dump Tx Scheduling Tree +~~~~~~~~~~~~~~~~~~~~~~~ + +Dump the runtime Tx scheduling tree into a DOT file. + +Usage:: + + testpmd>txsched dump + +In "brief" mode, all scheduling nodes in the tree are displayed. +In "detail" mode, each node's configuration parameters are also displayed. + Limitations or Known issues ---------------------------