From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <tdu@semihalf.com>
Received: from mail-lf0-f65.google.com (mail-lf0-f65.google.com
 [209.85.215.65]) by dpdk.org (Postfix) with ESMTP id 6B7D27CBA
 for <dev@dpdk.org>; Thu, 15 Mar 2018 08:52:19 +0100 (CET)
Received: by mail-lf0-f65.google.com with SMTP id m69-v6so8662560lfe.8
 for <dev@dpdk.org>; Thu, 15 Mar 2018 00:52:19 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=semihalf-com.20150623.gappssmtp.com; s=20150623;
 h=from:to:cc:subject:date:message-id:in-reply-to:references;
 bh=+dE+TY8NQQmPf60+SgCe3+hUuC0PrHN8IcMckVdbQYA=;
 b=TWFOYSaHPdTkopEboZkEjCH6lfeF5gMQvJEWPn7a+c6OeNMjagLBfIpjhHBCmQUupY
 MJg8ytUGSgMocMvjlgIGOOyXSEw7i4B2JibIQKk7sqYTQoeGC78y0ui0GjiUyu7COr02
 OMJTCWrOBa74/Vbg6iewfmydIeKtGmLzssVkHFpK1aFRWE2QmgJLmXiwXqYU7OFtImE7
 +6Jvu9t9hwZhOGT5lehSs94U38lOiQM+kXKegnQjg+gyCkPg9aheBOvFWJnVmiiFdTNm
 vSwXnQsgID7dJA1XNUuRldLv5s7S0LR4TzdtWH4/S3x7lCwVUtngtAlwNbGD99BCX0iA
 BUYw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20161025;
 h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to
 :references;
 bh=+dE+TY8NQQmPf60+SgCe3+hUuC0PrHN8IcMckVdbQYA=;
 b=lVr4A2Xybl48nudHvYlNR0x5jW94SkVbLpYgpYxFtJTVFgVJd0N3v7gBIOtm2Bo9gN
 nJcw+J2YYTTnNBED9T/BPSHKDw/0pKC8iKCr7YDPBUAea77l+Im8X1Gx4VEc5AVE4mRS
 XuCcfyTNOupYG/mBgYQSBUlly1AaNTpMeVcmrp/3DQtMqBYVYDD3H1P4oI23OtGv5iSs
 ABvbR5JA+nXfUQfkC08RGj/xf2qvMqSruZvLD/v4ZIrtwWtmWnbzVM6pBJmCuiHFvp1g
 0Mk4XJd7YBFfMar5QPJb2qXE4A7lsrvAA+EkUf6dhovP+gA5Ps6ANUvIK14PMUx/fJ7f
 E5UQ==
X-Gm-Message-State: AElRT7GaUjG4hKAOBwzkc6M152Od3174MAxOPoTR/PKbd/eFM9Hmewvt
 YMzVg6LN32lKIOLl78X3xxeGccmLc4E=
X-Google-Smtp-Source: AG47ELsqLjqc196Ckuj8xMuUir01LHnhALopUbGE+bhHVJyHsLUhmJENjC4iL/JB+zIErxjHHPil1g==
X-Received: by 2002:a19:28d4:: with SMTP id
 o203-v6mr5322320lfo.103.1521100338839; 
 Thu, 15 Mar 2018 00:52:18 -0700 (PDT)
Received: from sh.semihalf.local (31-172-191-173.noc.fibertech.net.pl.
 [31.172.191.173])
 by smtp.gmail.com with ESMTPSA id d14sm972925ljd.31.2018.03.15.00.52.17
 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128);
 Thu, 15 Mar 2018 00:52:17 -0700 (PDT)
From: Tomasz Duszynski <tdu@semihalf.com>
To: dev@dpdk.org
Cc: mw@semihalf.com, dima@marvell.com, nsamsono@marvell.com, jck@semihalf.com,
 jianbo.liu@arm.com, Tomasz Duszynski <tdu@semihalf.com>
Date: Thu, 15 Mar 2018 08:52:00 +0100
Message-Id: <1521100324-26558-5-git-send-email-tdu@semihalf.com>
X-Mailer: git-send-email 2.7.4
In-Reply-To: <1521100324-26558-1-git-send-email-tdu@semihalf.com>
References: <1520844132-29969-1-git-send-email-tdu@semihalf.com>
 <1521100324-26558-1-git-send-email-tdu@semihalf.com>
Subject: [dpdk-dev] [PATCH v3 4/8] net/mrvl: document policer/scheduler/rate
	limiter usage
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Thu, 15 Mar 2018 07:52:19 -0000

Add documentation and example for ingress policer, egress scheduler
and egress rate limiter.

Signed-off-by: Natalie Samsonov <nsamsono@marvell.com>
Signed-off-by: Tomasz Duszynski <tdu@semihalf.com>
---
 doc/guides/nics/mrvl.rst | 86 ++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 80 insertions(+), 6 deletions(-)

diff --git a/doc/guides/nics/mrvl.rst b/doc/guides/nics/mrvl.rst
index b7f3292..6794cbb 100644
--- a/doc/guides/nics/mrvl.rst
+++ b/doc/guides/nics/mrvl.rst
@@ -149,17 +149,36 @@ Configuration syntax
    [port <portnum> default]
    default_tc = <default_tc>
    mapping_priority = <mapping_priority>
+   policer_enable = <policer_enable>
+   token_unit = <token_unit>
+   color = <color_mode>
+   cir = <cir>
+   ebs = <ebs>
+   cbs = <cbs>
+
+   rate_limit_enable = <rate_limit_enable>
+   rate_limit = <rate_limit>
+   burst_size = <burst_size>
 
    [port <portnum> tc <traffic_class>]
    rxq = <rx_queue_list>
    pcp = <pcp_list>
    dscp = <dscp_list>
+   default_color = <default_color>
 
    [port <portnum> tc <traffic_class>]
    rxq = <rx_queue_list>
    pcp = <pcp_list>
    dscp = <dscp_list>
 
+   [port <portnum> txq <txqnum>]
+   sched_mode = <sched_mode>
+   wrr_weight = <wrr_weight>
+
+   rate_limit_enable = <rate_limit_enable>
+   rate_limit = <rate_limit>
+   burst_size = <burst_size>
+
 Where:
 
 - ``<portnum>``: DPDK Port number (0..n).
@@ -176,6 +195,30 @@ Where:
 
 - ``<dscp_list>``: List of DSCP values to handle in particular TC (e.g. 0-12 32-48 63).
 
+- ``<policer_enable>``: Enable ingress policer.
+
+- ``<token_unit>``: Policer token unit (`bytes` or `packets`).
+
+- ``<color_mode>``: Policer color mode (`aware` or `blind`).
+
+- ``<cir>``: Committed information rate in unit of kilo bits per second (data rate) or packets per second.
+
+- ``<cbs>``: Committed burst size in unit of kilo bytes or number of packets.
+
+- ``<ebs>``: Excess burst size in unit of kilo bytes or number of packets.
+
+- ``<default_color>``: Default color for specific tc.
+
+- ``<rate_limit_enable>``: Enables per port or per txq rate limiting.
+
+- ``<rate_limit>``: Committed information rate, in kilo bits per second.
+
+- ``<burst_size>``: Committed burst size, in kilo bytes.
+
+- ``<sched_mode>``: Egress scheduler mode (`wrr` or `sp`).
+
+- ``<wrr_weight>``: Txq weight.
+
 Setting PCP/DSCP values for the default TC is not required. All PCP/DSCP
 values not assigned explicitly to particular TC will be handled by the
 default TC.
@@ -187,11 +230,26 @@ Configuration file example
 
    [port 0 default]
    default_tc = 0
-   qos_mode = ip
+   mapping_priority = ip
+
+   rate_limit_enable = 1
+   rate_limit = 1000
+   burst_size = 2000
 
    [port 0 tc 0]
    rxq = 0 1
 
+   [port 0 txq 0]
+   sched_mode = wrr
+   wrr_weight = 10
+
+   [port 0 txq 1]
+   sched_mode = wrr
+   wrr_weight = 100
+
+   [port 0 txq 2]
+   sched_mode = sp
+
    [port 0 tc 1]
    rxq = 2
    pcp = 5 6 7
@@ -199,15 +257,31 @@ Configuration file example
 
    [port 1 default]
    default_tc = 0
-   qos_mode = vlan/ip
+   mapping_priority = vlan/ip
+
+   policer_enable = 1
+   token_unit = bytes
+   color = blind
+   cir = 100000
+   ebs = 64
+   cbs = 64
 
    [port 1 tc 0]
    rxq = 0
+   dscp = 10
 
    [port 1 tc 1]
-   rxq = 1 2
-   pcp = 5 6 7
-   dscp = 26-38
+   rxq = 1
+   dscp = 11-20
+
+   [port 1 tc 2]
+   rxq = 2
+   dscp = 30
+
+   [port 1 txq 0]
+   rate_limit_enable = 1
+   rate_limit = 10000
+   burst_size = 2000
 
 Usage example
 ^^^^^^^^^^^^^
@@ -215,7 +289,7 @@ Usage example
 .. code-block:: console
 
    ./testpmd --vdev=eth_mrvl,iface=eth0,iface=eth2,cfg=/home/user/mrvl.conf \
-     -c 7 -- -i -a --rxq=2
+     -c 7 -- -i -a --disable-hw-vlan-strip --rxq=3 --txq=3
 
 
 Building DPDK
-- 
2.7.4