From patchwork Tue Dec 26 18:54:28 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Qi Zhang X-Patchwork-Id: 135586 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 163DA43797; Tue, 26 Dec 2023 11:33:38 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2D9A7402E5; Tue, 26 Dec 2023 11:33:34 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.11]) by mails.dpdk.org (Postfix) with ESMTP id EBDCC402D0 for ; Tue, 26 Dec 2023 11:33:31 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1703586812; x=1735122812; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=EQwVtuagQMVm1qnFNnWEgKGxQSgzAZ7eDJxPY6tplVQ=; b=f5r9iuvxgkDcTNWsCVWnmvg81SpQF1P0gcgfPUtb39QISRzOFaiiW/Yj SHclaeWvZfJGTu7+AgjXpNBpWANkl/DKOA+6lglXBhxE0HXLf0HhoD54W 2lO37hHGefyEUCkEHOAVrC/WWx3APf5w0Diugzj+kHt+uO4tT3YwHWLKb X3Z8/721hVtuXKf+/A5eptTFTbDWgd6Mk6FLuvCO0C5Qnrijt/ZevGI62 35twhnNV0e61Ccr/pQ5nCQh4YzQUEzUR8nxLXHl0t1clVoMXkNZEjh1Z4 QxR/tkRR/ZId/nQ0Hf5rPHW2/m3LDRBifGV1QeG9uffT2KEeXfPhhjDFp w==; X-IronPort-AV: E=McAfee;i="6600,9927,10934"; a="3170299" X-IronPort-AV: E=Sophos;i="6.04,306,1695711600"; d="scan'208";a="3170299" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmvoesa105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 26 Dec 2023 02:33:31 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10934"; a="896541694" X-IronPort-AV: E=Sophos;i="6.04,306,1695711600"; d="scan'208";a="896541694" Received: from dpdk-qzhan15-test02.sh.intel.com ([10.67.115.37]) by fmsmga002.fm.intel.com with ESMTP; 26 Dec 2023 02:33:30 -0800 From: Qi Zhang To: qiming.yang@intel.com, wenjun1.wu@intel.com Cc: dev@dpdk.org, Qi Zhang Subject: [PATCH 2/2] doc: add document for diagnostic utilities Date: Tue, 26 Dec 2023 13:54:28 -0500 Message-Id: <20231226185428.3158880-2-qi.z.zhang@intel.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20231226185428.3158880-1-qi.z.zhang@intel.com> References: <20231226185428.3158880-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 ---------------------------