Commit 'r8152: fix a WOL issue' makes Ethernet port on Lenovo Thunderbolt 3 dock go crazy

Commit 'r8152: fix a WOL issue' makes Ethernet port on Lenovo Thunderbolt 3 dock go crazy

[Maxim Levitsky]

I recently bisected an issue on my Lenovo P1 gen3, which is connected to the Lenovo Thunderbolt 3 dock.

After I suspend the laptop to ram, the ethernet port led on the dock starts to blink like crazy,
its peer port on my ethernet switch blinks as well, and eventually the switch stops forwarding packets,
bringing all my network down.

Likely the ethernet card in the dock sends some kind of a garbage over the wire.

Resuming the laptop, "fixes" the issue (leds stops blinking, and the network starts working again
after a minute or so).

I also tried to connect the dock directly to my main desktop over a dedicated usb network card
and try to capture the packets that are sent, but no packets were captured. I will soon retry
this test with another network card. I did use promicious mode.


This is the offending commit, and reverting it helps:

commit cdf0b86b250fd3c1c3e120c86583ea510c52e4ce
Author: Hayes Wang <hayeswang@realtek.com>
Date:   Mon Jul 18 16:21:20 2022 +0800

    r8152: fix a WOL issue
    
    This fixes that the platform is waked by an unexpected packet. The
    size and range of FIFO is different when the device enters S3 state,
    so it is necessary to correct some settings when suspending.
    
    Regardless of jumbo frame, set RMS to 1522 and MTPS to MTPS_DEFAULT.
    Besides, enable MCU_BORW_EN to update the method of calculating the
    pointer of data. Then, the hardware could get the correct data.
    
    Fixes: 195aae321c82 ("r8152: support new chips")
    Signed-off-by: Hayes Wang <hayeswang@realtek.com>
    Link: https://lore.kernel.org/r/20220718082120.10957-391-nic_swsd@realtek.com
    Signed-off-by: Jakub Kicinski <kuba@kernel.org>


WOL from dock was enabled in BIOS, but I tested with it disabled as well, and
no change in behavier.

Any help is welcome. I can test patches if needed, the laptop currently runs 6.0-rc2
with this commit reverted.

When I find some time I can also narrow the change down by reverting only parts
of the patch.

Best regards,
	Maxim Levitsky

Re: Commit 'r8152: fix a WOL issue' makes Ethernet port on Lenovo Thunderbolt 3 dock go crazy

[Thorsten Leemhuis]

Hi, this is your Linux kernel regression tracker.

Quick note before the boilerplate: there is another report about issues
caused by cdf0b86b250fd3 also involving a dock, but apparently it's
ignored so far:
https://bugzilla.kernel.org/show_bug.cgi?id=216333

Anyway, moving on:

[TLDR: I'm adding this regression report to the list of tracked
regressions; all text from me you find below is based on a few templates
paragraphs you might have encountered already already in similar form.]

CCing the regression mailing list, as it should be in the loop for all
regressions, as explained here:
https://www.kernel.org/doc/html/latest/admin-guide/reporting-issues.html

On 23.08.22 11:20, Maxim Levitsky wrote:
> 
> I recently bisected an issue on my Lenovo P1 gen3, which is connected to the Lenovo Thunderbolt 3 dock.
> 
> After I suspend the laptop to ram, the ethernet port led on the dock starts to blink like crazy,
> its peer port on my ethernet switch blinks as well, and eventually the switch stops forwarding packets,
> bringing all my network down.
> 
> Likely the ethernet card in the dock sends some kind of a garbage over the wire.
> 
> Resuming the laptop, "fixes" the issue (leds stops blinking, and the network starts working again
> after a minute or so).
> 
> I also tried to connect the dock directly to my main desktop over a dedicated usb network card
> and try to capture the packets that are sent, but no packets were captured. I will soon retry
> this test with another network card. I did use promicious mode.
> 
> 
> This is the offending commit, and reverting it helps:
> 
> commit cdf0b86b250fd3c1c3e120c86583ea510c52e4ce
> Author: Hayes Wang <hayeswang@realtek.com>
> Date:   Mon Jul 18 16:21:20 2022 +0800
> 
>     r8152: fix a WOL issue
>     
>     This fixes that the platform is waked by an unexpected packet. The
>     size and range of FIFO is different when the device enters S3 state,
>     so it is necessary to correct some settings when suspending.
>     
>     Regardless of jumbo frame, set RMS to 1522 and MTPS to MTPS_DEFAULT.
>     Besides, enable MCU_BORW_EN to update the method of calculating the
>     pointer of data. Then, the hardware could get the correct data.
>     
>     Fixes: 195aae321c82 ("r8152: support new chips")
>     Signed-off-by: Hayes Wang <hayeswang@realtek.com>
>     Link: https://lore.kernel.org/r/20220718082120.10957-391-nic_swsd@realtek.com
>     Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> 
> 
> WOL from dock was enabled in BIOS, but I tested with it disabled as well, and
> no change in behavier.
> 
> Any help is welcome. I can test patches if needed, the laptop currently runs 6.0-rc2
> with this commit reverted.
> 
> When I find some time I can also narrow the change down by reverting only parts
> of the patch.
> 
> Best regards,
> 	Maxim Levitsky
> 


Thanks for the report. To be sure below issue doesn't fall through the
cracks unnoticed, I'm adding it to regzbot, my Linux kernel regression
tracking bot:

#regzbot ^introduced cdf0b86b250fd3c1c3e120c86583ea510c52e4ce
#regzbot title net: r8152: ehernet port on Lenovo Thunderbolt 3 dock
goes crazy
#regzbot ignore-activity

This isn't a regression? This issue or a fix for it are already
discussed somewhere else? It was fixed already? You want to clarify when
the regression started to happen? Or point out I got the title or
something else totally wrong? Then just reply -- ideally with also
telling regzbot about it, as explained here:
https://linux-regtracking.leemhuis.info/tracked-regression/

Reminder for developers: When fixing the issue, add 'Link:' tags
pointing to the report (the mail this one replies to), as explained for
in the Linux kernel's documentation; above webpage explains why this is
important for tracked regressions.

Ciao, Thorsten (wearing his 'the Linux kernel's regression tracker' hat)

P.S.: As the Linux kernel's regression tracker I deal with a lot of
reports and sometimes miss something important when writing mails like
this. If that's the case here, don't hesitate to tell me in a public
reply, it's in everyone's interest to set the public record straight.

Re: Commit 'r8152: fix a WOL issue' makes Ethernet port on Lenovo Thunderbolt 3 dock go crazy

[Thorsten Leemhuis]

On 24.08.22 13:16, Thorsten Leemhuis wrote:
> Hi, this is your Linux kernel regression tracker.
> 
> Quick note before the boilerplate: there is another report about issues
> caused by cdf0b86b250fd3 also involving a dock, but apparently it's
> ignored so far:
> https://bugzilla.kernel.org/show_bug.cgi?id=216333

TWIMC, apparently it's the same problem.

Fun fact: Hayes discussed this in privately with the bug reporter
according to this comment:
https://bugzilla.kernel.org/show_bug.cgi?id=216333#c3

Well, that's not how things normally should be handled, but whatever, he
in the end recently submitted a patch to fix it that is already merged
to net.git:

https://lore.kernel.org/lkml/20220818080620.14538-394-nic_swsd@realtek.com/

Ciao, Thorsten

P.S.:

#regzbot link: https://bugzilla.kernel.org/show_bug.cgi?id=216333	
#regzbot fixed-by: b75d612014447


> Anyway, moving on:
> 
> [TLDR: I'm adding this regression report to the list of tracked
> regressions; all text from me you find below is based on a few templates
> paragraphs you might have encountered already already in similar form.]
> 
> CCing the regression mailing list, as it should be in the loop for all
> regressions, as explained here:
> https://www.kernel.org/doc/html/latest/admin-guide/reporting-issues.html
> 
> On 23.08.22 11:20, Maxim Levitsky wrote:
>>
>> I recently bisected an issue on my Lenovo P1 gen3, which is connected to the Lenovo Thunderbolt 3 dock.
>>
>> After I suspend the laptop to ram, the ethernet port led on the dock starts to blink like crazy,
>> its peer port on my ethernet switch blinks as well, and eventually the switch stops forwarding packets,
>> bringing all my network down.
>>
>> Likely the ethernet card in the dock sends some kind of a garbage over the wire.
>>
>> Resuming the laptop, "fixes" the issue (leds stops blinking, and the network starts working again
>> after a minute or so).
>>
>> I also tried to connect the dock directly to my main desktop over a dedicated usb network card
>> and try to capture the packets that are sent, but no packets were captured. I will soon retry
>> this test with another network card. I did use promicious mode.
>>
>>
>> This is the offending commit, and reverting it helps:
>>
>> commit cdf0b86b250fd3c1c3e120c86583ea510c52e4ce
>> Author: Hayes Wang <hayeswang@realtek.com>
>> Date:   Mon Jul 18 16:21:20 2022 +0800
>>
>>     r8152: fix a WOL issue
>>     
>>     This fixes that the platform is waked by an unexpected packet. The
>>     size and range of FIFO is different when the device enters S3 state,
>>     so it is necessary to correct some settings when suspending.
>>     
>>     Regardless of jumbo frame, set RMS to 1522 and MTPS to MTPS_DEFAULT.
>>     Besides, enable MCU_BORW_EN to update the method of calculating the
>>     pointer of data. Then, the hardware could get the correct data.
>>     
>>     Fixes: 195aae321c82 ("r8152: support new chips")
>>     Signed-off-by: Hayes Wang <hayeswang@realtek.com>
>>     Link: https://lore.kernel.org/r/20220718082120.10957-391-nic_swsd@realtek.com
>>     Signed-off-by: Jakub Kicinski <kuba@kernel.org>
>>
>>
>> WOL from dock was enabled in BIOS, but I tested with it disabled as well, and
>> no change in behavier.
>>
>> Any help is welcome. I can test patches if needed, the laptop currently runs 6.0-rc2
>> with this commit reverted.
>>
>> When I find some time I can also narrow the change down by reverting only parts
>> of the patch.
>>
>> Best regards,
>> 	Maxim Levitsky
>>
> 
> 
> Thanks for the report. To be sure below issue doesn't fall through the
> cracks unnoticed, I'm adding it to regzbot, my Linux kernel regression
> tracking bot:
> 
> #regzbot ^introduced cdf0b86b250fd3c1c3e120c86583ea510c52e4ce
> #regzbot title net: r8152: ehernet port on Lenovo Thunderbolt 3 dock
> goes crazy
> #regzbot ignore-activity
> 
> This isn't a regression? This issue or a fix for it are already
> discussed somewhere else? It was fixed already? You want to clarify when
> the regression started to happen? Or point out I got the title or
> something else totally wrong? Then just reply -- ideally with also
> telling regzbot about it, as explained here:
> https://linux-regtracking.leemhuis.info/tracked-regression/
> 
> Reminder for developers: When fixing the issue, add 'Link:' tags
> pointing to the report (the mail this one replies to), as explained for
> in the Linux kernel's documentation; above webpage explains why this is
> important for tracked regressions.
> 
> Ciao, Thorsten (wearing his 'the Linux kernel's regression tracker' hat)
> 
> P.S.: As the Linux kernel's regression tracker I deal with a lot of
> reports and sometimes miss something important when writing mails like
> this. If that's the case here, don't hesitate to tell me in a public
> reply, it's in everyone's interest to set the public record straight.

Re: Commit 'r8152: fix a WOL issue' makes Ethernet port on Lenovo Thunderbolt 3 dock go crazy

[Jakub Kicinski]

On Thu, 25 Aug 2022 09:26:21 +0200 Thorsten Leemhuis wrote:
> On 24.08.22 13:16, Thorsten Leemhuis wrote:
> > Hi, this is your Linux kernel regression tracker.
> > 
> > Quick note before the boilerplate: there is another report about issues
> > caused by cdf0b86b250fd3 also involving a dock, but apparently it's
> > ignored so far:
> > https://bugzilla.kernel.org/show_bug.cgi?id=216333  
> 
> TWIMC, apparently it's the same problem.
> 
> Fun fact: Hayes discussed this in privately with the bug reporter
> according to this comment:
> https://bugzilla.kernel.org/show_bug.cgi?id=216333#c3
> 
> Well, that's not how things normally should be handled, but whatever, he
> in the end recently submitted a patch to fix it that is already merged
> to net.git:
> 
> https://lore.kernel.org/lkml/20220818080620.14538-394-nic_swsd@realtek.com/

Yup, it will be part of 6.0-rc3. 

Thanks!

Re: Commit 'r8152: fix a WOL issue' makes Ethernet port on Lenovo Thunderbolt 3 dock go crazy

[Thorsten Leemhuis]

On 25.08.22 18:13, Jakub Kicinski wrote:
> On Thu, 25 Aug 2022 09:26:21 +0200 Thorsten Leemhuis wrote:
>> On 24.08.22 13:16, Thorsten Leemhuis wrote:
>>> Hi, this is your Linux kernel regression tracker.
>>>
>>> Quick note before the boilerplate: there is another report about issues
>>> caused by cdf0b86b250fd3 also involving a dock, but apparently it's
>>> ignored so far:
>>> https://bugzilla.kernel.org/show_bug.cgi?id=216333  
>>
>> TWIMC, apparently it's the same problem.
>>
>> Fun fact: Hayes discussed this in privately with the bug reporter
>> according to this comment:
>> https://bugzilla.kernel.org/show_bug.cgi?id=216333#c3
>>
>> Well, that's not how things normally should be handled, but whatever, he
>> in the end recently submitted a patch to fix it that is already merged
>> to net.git:
>>
>> https://lore.kernel.org/lkml/20220818080620.14538-394-nic_swsd@realtek.com/
> 
> Yup, it will be part of 6.0-rc3. 

Great. BTW, a small note for Hayes and reviewers: The commit
b75d61201444 ("r8152: fix the RX FIFO settings when suspending") links
to the report with a "BugLink" tag. You want to use plain "Link:" tags
instead, as explained in the documentation. Also: a "BugLink" tag not
that long ago made Linus write:

```
please stop making up random tags that make no sense.

Just use "Link:"
```

Quote from:
https://lore.kernel.org/all/CAHk-=wgs38ZrfPvy=nOwVkVzjpM3VFU1zobP37Fwd_h9iAD5JQ@mail.gmail.com/

Ciao, Thorsten

Re: Commit 'r8152: fix a WOL issue' makes Ethernet port on Lenovo Thunderbolt 3 dock go crazy

[Maxim Levitsky]

On Fri, 2022-08-26 at 09:49 +0200, Thorsten Leemhuis wrote:
> On 25.08.22 18:13, Jakub Kicinski wrote:
> > On Thu, 25 Aug 2022 09:26:21 +0200 Thorsten Leemhuis wrote:
> > > On 24.08.22 13:16, Thorsten Leemhuis wrote:
> > > > Hi, this is your Linux kernel regression tracker.
> > > > 
> > > > Quick note before the boilerplate: there is another report about issues
> > > > caused by cdf0b86b250fd3 also involving a dock, but apparently it's
> > > > ignored so far:
> > > > https://bugzilla.kernel.org/show_bug.cgi?id=216333  
> > > 
> > > TWIMC, apparently it's the same problem.
> > > 
> > > Fun fact: Hayes discussed this in privately with the bug reporter
> > > according to this comment:
> > > https://bugzilla.kernel.org/show_bug.cgi?id=216333#c3
> > > 
> > > Well, that's not how things normally should be handled, but whatever, he
> > > in the end recently submitted a patch to fix it that is already merged
> > > to net.git:
> > > 
> > > https://lore.kernel.org/lkml/20220818080620.14538-394-nic_swsd@realtek.com/
> > 
> > Yup, it will be part of 6.0-rc3. 

Thank you all very much! -rc3 indeed works for me!

Best regards,
	Maxim Levitsky

> 
> Great. BTW, a small note for Hayes and reviewers: The commit
> b75d61201444 ("r8152: fix the RX FIFO settings when suspending") links
> to the report with a "BugLink" tag. You want to use plain "Link:" tags
> instead, as explained in the documentation. Also: a "BugLink" tag not
> that long ago made Linus write:
> 
> ```
> please stop making up random tags that make no sense.
> 
> Just use "Link:"
> ```
> 
> Quote from:
> https://lore.kernel.org/all/CAHk-=wgs38ZrfPvy=nOwVkVzjpM3VFU1zobP37Fwd_h9iAD5JQ@mail.gmail.com/
> 
> Ciao, Thorsten
>