From: Vedang Patel <vedang.patel@intel.com>
To: netdev@vger.kernel.org
Cc: jhs@mojatatu.com, xiyou.wangcong@gmail.com, jiri@resnulli.us,
stephen@networkplumber.org, vinicius.gomes@intel.com,
leandro.maciel.dorileo@intel.com, jakub.kicinski@netronome.com,
m-karicheri2@ti.com, dsahern@gmail.com,
Vedang Patel <vedang.patel@intel.com>
Subject: [PATCH iproute2 net-next v5 5/5] tc: taprio: Update documentation
Date: Thu, 18 Jul 2019 12:55:43 -0700 [thread overview]
Message-ID: <1563479743-8371-5-git-send-email-vedang.patel@intel.com> (raw)
In-Reply-To: <1563479743-8371-1-git-send-email-vedang.patel@intel.com>
Add documentation for the latest options, flags and txtime-delay, to the
taprio manpage.
This also adds an example to run tc in txtime offload mode.
Signed-off-by: Vedang Patel <vedang.patel@intel.com>
---
man/man8/tc-taprio.8 | 40 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 40 insertions(+)
diff --git a/man/man8/tc-taprio.8 b/man/man8/tc-taprio.8
index 850be9b03649..e1d19ba19089 100644
--- a/man/man8/tc-taprio.8
+++ b/man/man8/tc-taprio.8
@@ -112,6 +112,26 @@ means that traffic class 0 is "active" for that schedule entry.
long that state defined by <command> and <gate mask> should be held
before moving to the next entry.
+.TP
+flags
+.br
+Specifies different modes for taprio. Currently, only txtime-assist is
+supported which can be enabled by setting it to 0x1. In this mode, taprio will
+set the transmit timestamp depending on the interval in which the packet needs
+to be transmitted. It will then utililize the
+.BR etf(8)
+qdisc to sort and transmit the packets at the right time. The second example
+can be used as a reference to configure this mode.
+
+.TP
+txtime-delay
+.br
+This parameter is specific to the txtime offload mode. It specifies the maximum
+time a packet might take to reach the network card from the taprio qdisc. The
+value should always be greater than the delta specified in the
+.BR etf(8)
+qdisc.
+
.SH EXAMPLES
The following example shows how an traffic schedule with three traffic
@@ -137,6 +157,26 @@ reference CLOCK_TAI. The schedule is composed of three entries each of
clockid CLOCK_TAI
.EE
+Following is an example to enable the txtime offload mode in taprio. See
+.BR etf(8)
+for more information about configuring the ETF qdisc.
+
+.EX
+# tc qdisc replace dev eth0 parent root handle 100 taprio \\
+ num_tc 3 \\
+ map 2 2 1 0 2 2 2 2 2 2 2 2 2 2 2 2 \\
+ queues 1@0 1@0 1@0 \\
+ base-time 1528743495910289987 \\
+ sched-entry S 01 300000 \\
+ sched-entry S 02 300000 \\
+ sched-entry S 04 400000 \\
+ flags 0x1 \\
+ txtime-delay 200000 \\
+ clockid CLOCK_TAI
+
+# tc qdisc replace dev $IFACE parent 100:1 etf skip_skb_check \\
+ offload delta 200000 clockid CLOCK_TAI
+.EE
.SH AUTHORS
Vinicius Costa Gomes <vinicius.gomes@intel.com>
--
2.7.3
next prev parent reply other threads:[~2019-07-18 19:55 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-07-18 19:55 [PATCH iproute2 net-next v5 1/5] etf: Add skip_sock_check Vedang Patel
2019-07-18 19:55 ` [PATCH iproute2 net-next v5 2/5] taprio: Add support for setting flags Vedang Patel
2019-07-18 19:55 ` [PATCH iproute2 net-next v5 3/5] taprio: add support for setting txtime_delay Vedang Patel
2019-07-18 19:55 ` [PATCH iproute2 net-next v5 4/5] tc: etf: Add documentation for skip_sock_check Vedang Patel
2019-07-18 19:55 ` Vedang Patel [this message]
2019-07-18 22:48 ` [PATCH iproute2 net-next v5 1/5] etf: Add skip_sock_check David Ahern
2019-07-19 5:12 ` Stephen Hemminger
2019-07-19 21:39 ` Patel, Vedang
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1563479743-8371-5-git-send-email-vedang.patel@intel.com \
--to=vedang.patel@intel.com \
--cc=dsahern@gmail.com \
--cc=jakub.kicinski@netronome.com \
--cc=jhs@mojatatu.com \
--cc=jiri@resnulli.us \
--cc=leandro.maciel.dorileo@intel.com \
--cc=m-karicheri2@ti.com \
--cc=netdev@vger.kernel.org \
--cc=stephen@networkplumber.org \
--cc=vinicius.gomes@intel.com \
--cc=xiyou.wangcong@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).