From patchwork Tue Jul 24 15:50:25 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jasvinder Singh X-Patchwork-Id: 43319 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 6FAD2324B; Tue, 24 Jul 2018 17:50:37 +0200 (CEST) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id 42BB098 for ; Tue, 24 Jul 2018 17:50:33 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga004.jf.intel.com ([10.7.209.38]) by fmsmga103.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 24 Jul 2018 08:50:29 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.51,398,1526367600"; d="scan'208";a="218690646" Received: from silpixa00381635.ir.intel.com (HELO silpixa00381635.ger.corp.intel.com) ([10.237.222.149]) by orsmga004.jf.intel.com with ESMTP; 24 Jul 2018 08:50:28 -0700 From: Jasvinder Singh To: dev@dpdk.org Cc: john.mcnamara@intel.com, marko.kovacevic@intel.com, Reshma Pattan Date: Tue, 24 Jul 2018 16:50:25 +0100 Message-Id: <20180724155026.90724-2-jasvinder.singh@intel.com> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20180724155026.90724-1-jasvinder.singh@intel.com> References: <20180724155026.90724-1-jasvinder.singh@intel.com> Subject: [dpdk-dev] [PATCH 2/3] app/testpmd: update softnic mode documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Update tespmd documentation with softnic forwarding mode description. Signed-off-by: Jasvinder Singh Signed-off-by: Reshma Pattan Acked-by: Bernard Iremonger --- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst index 1d6bdf9..4271dda 100644 --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst @@ -320,12 +320,8 @@ The available information categories are: * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``. -* ``tm``: Traffic Management forwarding mode - Demonstrates the use of ethdev traffic management APIs and softnic PMD for - QoS traffic management. In this mode, 5-level hierarchical QoS scheduler is - available as an default option that can be enabled through CLI. The user can - also modify the default hierarchy or specify the new hierarchy through CLI for - implementing QoS scheduler. Requires ``CONFIG_RTE_LIBRTE_PMD_SOFTNIC=y`` ``CONFIG_RTE_LIBRTE_SCHED=y``. +* ``softnic``: Demonstrates the softnic forwarding operation. In this mode, packet forwarding is + similar to I/O mode except for the fact that packets are loopback to the softnic ports only. Therefore, portmask parameter should be set to softnic port only. The various software based custom NIC pipelines specified through the softnic firmware (DPDK packet framework script) can be tested in this mode. Furthermore, it allows to build 5-level hierarchical QoS scheduler as a default option that can be enabled through CLI once testpmd application is initialised. The user can modify the default scheduler hierarchy or can specify the new QoS Scheduler hierarchy through CLI. Requires ``CONFIG_RTE_LIBRTE_PMD_SOFTNIC=y``. Example:: @@ -2628,8 +2624,8 @@ where: call failure. On the other hand, hierarchy is preserved when this parameter is equal to zero. -Set port traffic management default hierarchy (tm forwarding mode) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Set port traffic management default hierarchy (softnic forwarding mode) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ set the traffic management default hierarchy on the port::