diff mbox series

[4/4] ethtool: add PHY Fast Link Down tunable to man page

Message ID 2ca651c7-89b3-65fd-0941-b732692c8d41@gmail.com
State Superseded
Delegated to: John Linville
Headers show
Series ethtool: add support for new PHY tunable Fast Link Down | expand

Commit Message

Heiner Kallweit March 28, 2019, 7:28 p.m. UTC
Add description of new PHY tunable Fast Link Down to ethtool man page.

Signed-off-by: Heiner Kallweit <hkallweit1@gmail.com>
---
 ethtool.8.in | 28 ++++++++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

Comments

Andrew Lunn March 28, 2019, 8:01 p.m. UTC | #1
> +	Sets the period after which the link is reported as down. Note that the PHY may choose
> +	the closest supported value. Only on reading back you get the actual value.

Hi Heiner

'Only on reading back the tunable do you get the actual value.'

would be better.

>  .TE
>  .PD
>  .RE
> @@ -1090,6 +1106,14 @@ Link speed downshift after N failed 1000BASE-T auto-negotiation attempts.
>  Downshift is useful where cable does not have the 4 pairs instance.
>  
>  Gets the PHY downshift count/status.
> +.TP
> +.B fast\-link\-down
> +Depending on the mode it may take 0.5s - 1s until a broken link is reported as down.
> +In certain use cases a link-down event needs to be reported as soon as possible.
> +Some PHYs support a Fast Link Down feature, and partially even allow to configure
> +the period until until a broken link is reported as being down.

Some PHYs support a Fast Link Down Feature and may allow configuration
of the delay before a broken link is reported as being down.

   Andrew
Heiner Kallweit March 28, 2019, 8:12 p.m. UTC | #2
On 28.03.2019 21:01, Andrew Lunn wrote:
>> +	Sets the period after which the link is reported as down. Note that the PHY may choose
>> +	the closest supported value. Only on reading back you get the actual value.
> 
> Hi Heiner
> 
> 'Only on reading back the tunable do you get the actual value.'
> 
> would be better.
> 
OK. I'll wait for more review feedback and will consider this in a v2.
Currently all mails to John are bounced due to some spam filter rejecting mails from
Google servers, so let's see when he reads this.

>>  .TE
>>  .PD
>>  .RE
>> @@ -1090,6 +1106,14 @@ Link speed downshift after N failed 1000BASE-T auto-negotiation attempts.
>>  Downshift is useful where cable does not have the 4 pairs instance.
>>  
>>  Gets the PHY downshift count/status.
>> +.TP
>> +.B fast\-link\-down
>> +Depending on the mode it may take 0.5s - 1s until a broken link is reported as down.
>> +In certain use cases a link-down event needs to be reported as soon as possible.
>> +Some PHYs support a Fast Link Down feature, and partially even allow to configure
>> +the period until until a broken link is reported as being down.
> 
> Some PHYs support a Fast Link Down Feature and may allow configuration
> of the delay before a broken link is reported as being down.
> 
OK

>    Andrew
> 
Heiner
John W. Linville March 29, 2019, 2:19 p.m. UTC | #3
On Thu, Mar 28, 2019 at 09:12:45PM +0100, Heiner Kallweit wrote:
> On 28.03.2019 21:01, Andrew Lunn wrote:
> >> +	Sets the period after which the link is reported as down. Note that the PHY may choose
> >> +	the closest supported value. Only on reading back you get the actual value.
> > 
> > Hi Heiner
> > 
> > 'Only on reading back the tunable do you get the actual value.'
> > 
> > would be better.
> > 
> OK. I'll wait for more review feedback and will consider this in a v2.
> Currently all mails to John are bounced due to some spam filter rejecting mails from
> Google servers, so let's see when he reads this.

I'm having some mail server problems right now, but I got this message... ;-)

I like Andrew's wording suggestions, FWIW. Should I expect a repost?

John
 
> >>  .TE
> >>  .PD
> >>  .RE
> >> @@ -1090,6 +1106,14 @@ Link speed downshift after N failed 1000BASE-T auto-negotiation attempts.
> >>  Downshift is useful where cable does not have the 4 pairs instance.
> >>  
> >>  Gets the PHY downshift count/status.
> >> +.TP
> >> +.B fast\-link\-down
> >> +Depending on the mode it may take 0.5s - 1s until a broken link is reported as down.
> >> +In certain use cases a link-down event needs to be reported as soon as possible.
> >> +Some PHYs support a Fast Link Down feature, and partially even allow to configure
> >> +the period until until a broken link is reported as being down.
> > 
> > Some PHYs support a Fast Link Down Feature and may allow configuration
> > of the delay before a broken link is reported as being down.
> > 
> OK
> 
> >    Andrew
> > 
> Heiner
> 
>
Heiner Kallweit March 29, 2019, 6:54 p.m. UTC | #4
On 29.03.2019 15:19, John W. Linville wrote:
> On Thu, Mar 28, 2019 at 09:12:45PM +0100, Heiner Kallweit wrote:
>> On 28.03.2019 21:01, Andrew Lunn wrote:
>>>> +	Sets the period after which the link is reported as down. Note that the PHY may choose
>>>> +	the closest supported value. Only on reading back you get the actual value.
>>>
>>> Hi Heiner
>>>
>>> 'Only on reading back the tunable do you get the actual value.'
>>>
>>> would be better.
>>>
>> OK. I'll wait for more review feedback and will consider this in a v2.
>> Currently all mails to John are bounced due to some spam filter rejecting mails from
>> Google servers, so let's see when he reads this.
> 
> I'm having some mail server problems right now, but I got this message... ;-)
> 
> I like Andrew's wording suggestions, FWIW. Should I expect a repost?
> 
You're alive, great ;) Yes, I'll send a v2.

> John
>  
>>>>  .TE
>>>>  .PD
>>>>  .RE
>>>> @@ -1090,6 +1106,14 @@ Link speed downshift after N failed 1000BASE-T auto-negotiation attempts.
>>>>  Downshift is useful where cable does not have the 4 pairs instance.
>>>>  
>>>>  Gets the PHY downshift count/status.
>>>> +.TP
>>>> +.B fast\-link\-down
>>>> +Depending on the mode it may take 0.5s - 1s until a broken link is reported as down.
>>>> +In certain use cases a link-down event needs to be reported as soon as possible.
>>>> +Some PHYs support a Fast Link Down feature, and partially even allow to configure
>>>> +the period until until a broken link is reported as being down.
>>>
>>> Some PHYs support a Fast Link Down Feature and may allow configuration
>>> of the delay before a broken link is reported as being down.
>>>
>> OK
>>
>>>    Andrew
>>>
>> Heiner
>>
>>
>
diff mbox series

Patch

diff --git a/ethtool.8.in b/ethtool.8.in
index b878521..c2a97f2 100644
--- a/ethtool.8.in
+++ b/ethtool.8.in
@@ -355,10 +355,16 @@  ethtool \- query or control network driver and hardware settings
 .A1 on off
 .BN count
 .RB ]
+.RB [
+.B fast\-link\-down
+.A1 on off
+.BN msecs
+.RB ]
 .HP
 .B ethtool \-\-get\-phy\-tunable
 .I devname
 .RB [ downshift ]
+.RB [ fast-link-down ]
 .HP
 .B ethtool \-\-reset
 .I devname
@@ -1069,12 +1075,22 @@  Sets the PHY tunable parameters.
 .RS 4
 .TP
 .A2 downshift on off
-Specifies whether downshift should be enabled
+Specifies whether downshift should be enabled.
 .TS
 nokeep;
 lB	l.
 .BI count \ N
-Sets the PHY downshift re-tries count.
+	Sets the PHY downshift re-tries count.
+.TE
+.TP
+.A2 fast-link-down on off
+Specifies whether Fast Link Down should be enabled and time until link down (if supported).
+.TS
+nokeep;
+lB	l.
+.BI msecs \ N
+	Sets the period after which the link is reported as down. Note that the PHY may choose
+	the closest supported value. Only on reading back you get the actual value.
 .TE
 .PD
 .RE
@@ -1090,6 +1106,14 @@  Link speed downshift after N failed 1000BASE-T auto-negotiation attempts.
 Downshift is useful where cable does not have the 4 pairs instance.
 
 Gets the PHY downshift count/status.
+.TP
+.B fast\-link\-down
+Depending on the mode it may take 0.5s - 1s until a broken link is reported as down.
+In certain use cases a link-down event needs to be reported as soon as possible.
+Some PHYs support a Fast Link Down feature, and partially even allow to configure
+the period until until a broken link is reported as being down.
+
+Gets the PHY Fast Link Down status / period.
 .RE
 .TP
 .B \-\-reset