netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Yuval Mintz" <yuvalmin@broadcom.com>
To: bhutchings@solarflare.com, netdev@vger.kernel.org
Cc: eilong@broadcom.com, peppe.cavallaro@st.com,
	"Yuval Mintz" <yuvalmin@broadcom.com>
Subject: [PATCH 2/2] Ethtool: add EEE to ethtool's documentation
Date: Tue, 5 Jun 2012 09:41:10 +0300	[thread overview]
Message-ID: <1338878470-24784-3-git-send-email-yuvalmin@broadcom.com> (raw)
In-Reply-To: <1338878470-24784-1-git-send-email-yuvalmin@broadcom.com>

under Synopsis:
	ethtool --get-eee devname
	ethtool --set-eee devname [eee on|off] [tx-lpi on|off] [tx-timer N] [advertise N]

under Options:
       --get-eee
              Queries  the  specified network device for its support in Efficient Energy Ethernet (ac-
	      cording to the IEEE 802.3az specifications)
       --set-eee
	      Sets the device EEE behaviour.
       eee on|off
	      Enables/Disables the device support in EEE.
       tx-lpi on|off
	      Determines whether the device should assert its tx lpi.
       advertise N
              Sets the speeds for which the device would advertise EEE capabliities.   Values  are  as
	      for --change advertise
       tx-timer N
              Sets  the  amount  of time the device should stay in idle mode prior to asserting its tx
              lpi (in microseconds). This has meaning only when tx lpi is on.

Signed-off-by: Yuval Mintz <yuvalmin@broadcom.com>
Signed-off-by: Eilon Greenstein <eilong@broadcom.com>
---
 ethtool.8.in |   32 ++++++++++++++++++++++++++++++++
 1 files changed, 32 insertions(+), 0 deletions(-)

diff --git a/ethtool.8.in b/ethtool.8.in
index 523b737..b906d8e 100644
--- a/ethtool.8.in
+++ b/ethtool.8.in
@@ -335,6 +335,16 @@ ethtool \- query or control network driver and hardware settings
 .I devname flag
 .A1 on off
 .RB ...
+.HP
+.B ethtool \-\-get\-eee
+.I devname
+.HP
+.B ethtool \-\-set\-eee
+.I devname
+.B2 eee on off
+.B2 tx-lpi on off
+.BN tx-timer
+.BN advertise
 .
 .\" Adjust lines (i.e. full justification) and hyphenate.
 .ad
@@ -817,6 +827,28 @@ Sets the device's private flags as specified.
 .I flag
 .A1 on off
 Sets the state of the named private flag.
+.TP
+.B \-\-get\-eee
+Queries the specified network device for its support in Efficient Energy
+Ethernet (according to the IEEE 802.3az specifications)
+.TP
+.B \-\-set\-eee
+Sets the device EEE behaviour.
+.TP
+.A2 eee on off
+Enables/Disables the device support in EEE.
+.TP
+.A2 tx-lpi on off
+Determines whether the device should assert its tx lpi.
+.TP
+.BI advertise \ N
+Sets the speeds for which the device would advertise EEE capabliities.
+Values are as for
+.B \-\-change advertise
+.TP
+.BI tx-timer \ N
+Sets the amount of time the device should stay in idle mode prior to asserting
+its tx lpi (in microseconds). This has meaning only when tx lpi is on.
 .SH BUGS
 Not supported (in part or whole) on all network drivers.
 .SH AUTHOR
-- 
1.7.9.rc2

  parent reply	other threads:[~2012-06-05  6:42 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-06-05  6:41 [PATCH 0/2] Ethtool: EEE support Yuval Mintz
2012-06-05  6:41 ` [PATCH 1/2] Ethtool: Add " Yuval Mintz
2012-06-06 15:48   ` Ben Hutchings
2012-06-06 16:27     ` Yuval Mintz
2012-06-06 17:21       ` Ben Hutchings
2012-06-05  6:41 ` Yuval Mintz [this message]
2012-06-06 15:56   ` [PATCH 2/2] Ethtool: add EEE to ethtool's documentation Ben Hutchings

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=1338878470-24784-3-git-send-email-yuvalmin@broadcom.com \
    --to=yuvalmin@broadcom.com \
    --cc=bhutchings@solarflare.com \
    --cc=eilong@broadcom.com \
    --cc=netdev@vger.kernel.org \
    --cc=peppe.cavallaro@st.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).