From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id CA777437AB; Thu, 28 Dec 2023 02:49:44 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 1C081402DF; Thu, 28 Dec 2023 02:49:39 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.55.52.43]) by mails.dpdk.org (Postfix) with ESMTP id B44A640144 for ; Thu, 28 Dec 2023 02:49:36 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1703728176; x=1735264176; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=EQwVtuagQMVm1qnFNnWEgKGxQSgzAZ7eDJxPY6tplVQ=; b=Uiy9DHL8WnW5Cshp9FlgSnsSqCxuFCCM4cMqpy2KVA6SHuCsQW/ZUIoS xvasahqJ2TpFqOu5njyRh4zrhlqAsf1u3uvm2JeagLco6AzrrZA9GyK5t rDdgo0HD5A33Nx+2IR8WdBIaGPVmV/R/ziThKemoiNnE6NQ3fE8nAu12O +VMWws/zmbUF9n1YYp8Hc4jwtcCCTlbD0QtkcJQO3ArjnJXRIKXGNGX0c I3tZlaTzzKEiqwWe3WyvpwuDOWwnzZF6VZkkgaSTYyONH8VoVS4EwNILl 5Ug8PCv1WZ98cUwL45cIy67JVFlN/HWkktbRiQxISBFxC3PrX3PRFjr+d A==; X-IronPort-AV: E=McAfee;i="6600,9927,10936"; a="482682918" X-IronPort-AV: E=Sophos;i="6.04,310,1695711600"; d="scan'208";a="482682918" Received: from orsmga004.jf.intel.com ([10.7.209.38]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 Dec 2023 17:49:35 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10936"; a="901838344" X-IronPort-AV: E=Sophos;i="6.04,310,1695711600"; d="scan'208";a="901838344" Received: from dpdk-qzhan15-test02.sh.intel.com ([10.67.115.37]) by orsmga004.jf.intel.com with ESMTP; 27 Dec 2023 17:49:34 -0800 From: Qi Zhang To: qiming.yang@intel.com, wenjun1.wu@intel.com Cc: dev@dpdk.org, Qi Zhang Subject: [PATCH v3 2/2] doc: add document for diagnostic utilities Date: Thu, 28 Dec 2023 05:10:32 -0500 Message-Id: <20231228101032.3278127-2-qi.z.zhang@intel.com> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20231228101032.3278127-1-qi.z.zhang@intel.com> References: <20231226185428.3158880-1-qi.z.zhang@intel.com> <20231228101032.3278127-1-qi.z.zhang@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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 --------------------------- -- 2.31.1