Possible missing firmware /lib/firmware/rtl_nic/rtl8125b-2.fw for module r8169

[You-Sheng Yang]

[SRU Justification]

[Impact]

Missing firmware for Realtek RTL8125B 2.5Gb Ethernet-NIC, which
is supported by linux-oem-5.10 kernel.

[Fix]

Two upstream commit necessary:
* commit 3890db36665d ("rtl_nic: add firmware for RTL8125B")
* commit 69c7f0bdc76e ("rtl_nic: update firmware for RTL8125B")

[Test Case]

Without firmware, drive probe would fail with:

  $ dmesg | grep -i r8169
  r8169 0000:06:00.0: unknown chip XID 641

With firmware, it should then succeed:

  $ dmesg | grep -i r8169
  r8169 0000:07:00.0 eth0: RTL8125B, b4:2e:99:ef:c6:82, XID 641, IRQ 66
  r8169 0000:07:00.0 eth0: jumbo features [frames: 9194 bytes, tx checksumming: ko]
  r8169 0000:07:00.0 eno1: renamed from eth0
  RTL8125B 2.5Gbps internal r8169-700:00: attached PHY driver [RTL8125B 2.5Gbps internal] (mii_bus:phy_addr=r8169-700:00, irq=IGNORE)

[Where problems could occur]

While this introduces new firmware blobs and enabled devices supported
by new kernels, it should have little effect on existing systems, but
with new devices up and running, it may still affect power consumptions,
ability to enter deep suspend, etc.

[Other Info]

RTL8125B is supported by Linux kernel since v5.9 and on, so only Focal
is nominated specifically for linux-oem-5.10 kernel.

========== original bug description ==========

https://askubuntu.com/questions/1259947/cant-get-rtl8125b-working-on-20-04

$ lspci -knn | grep Eth -A3
06:00.0 Ethernet controller [0200]: Realtek Semiconductor Co., Ltd. RTL8125 2.5GbE Controller [10ec:8125] (rev 04)
Subsystem: ASUSTeK Computer Inc. RTL8125 2.5GbE Controller [1043:87d7]
Kernel modules: r8169
07:00.0 VGA compatible controller [0300]: Advanced Micro Devices, Inc. [AMD/ATI] Ellesmere [Radeon RX 470/480/570/570X/580/580X/590] [1002:67df] (rev e7)

$ dmesg | grep -i r8169
[ 0.911236] r8169 0000:06:00.0: unknown chip XID 64

[You-Sheng Yang (vicamo)]

RTL8125B support was first introduced by https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=0439297be95111cf9ef5ece2091af16d140ce2ef ("r8169: add support for RTL8125B") available since v5.9 and on. While Focal has oem-5.10 kernel now, RTL8125B will fail to drive without the firmware.

[You-Sheng Yang (vicamo)]

$ git log korg/master -- rtl_nic/rtl8125b-2.fw
commit 69c7f0bdc76eaad92e543d07cd53e7a3947f037d
Author: Heiner Kallweit <email address hidden>
Date: Tue Jul 14 17:25:49 2020 +0200

    rtl_nic: update firmware for RTL8125B

    Realtek provided updated versions of RTL8125B rev.a and rev.b firmware.

    Signed-off-by: Heiner Kallweit <email address hidden>
    Signed-off-by: Chunhao Lin <email address hidden>
    Signed-off-by: Josh Boyer <email address hidden>

commit 3890db36665dbff4c415b0b0dc5c8d53b2850870
Author: Heiner Kallweit <email address hidden>
Date: Mon Jun 15 20:57:52 2020 +0200

    rtl_nic: add firmware for RTL8125B

    This adds firmware for RTL8125B rev.a and RTL8125B rev.b.

    Signed-off-by: Heiner Kallweit <email address hidden>
    Signed-off-by: Chunhao Lin <email address hidden>
    Signed-off-by: Josh Boyer <email address hidden>

[You-Sheng Yang (vicamo)]

PPA: https://launchpad.net/~vicamo/+archive/ubuntu/ppa-1916558

[You-Sheng Yang (vicamo)]

SRU: https://lists.ubuntu.com/archives/kernel-team/2021-February/117452.html

[You-Sheng Yang (vicamo)]

SRU v2: https://lists.ubuntu.com/archives/kernel-team/2021-February/117460.html update BugLink

[Łukasz Zemczak (sil2100)]

Hello You-Sheng, or anyone else affected,

Accepted linux-firmware into focal-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/linux-firmware/1.187.10 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-focal to verification-done-focal. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-focal. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

[You-Sheng Yang (vicamo)]

verified linux-firmware/focal-proposed version 1.187.10.

[Launchpad Janitor (janitor)]

This bug was fixed in the package linux-firmware - 1.187.10

---------------
linux-firmware (1.187.10) focal; urgency=medium

  * Possible missing firmware /lib/firmware/rtl_nic/rtl8125b-2.fw for module
    r8169 (LP: #1916558)
    - rtl_nic: add firmware for RTL8125B
    - rtl_nic: update firmware for RTL8125B
  * Add AMD GPU green sardine firmware (LP: #1916731)
    - amdgpu: add initial firmware for green sardine

 -- Seth Forshee <email address hidden> Tue, 02 Mar 2021 13:55:42 -0600

[Łukasz Zemczak (sil2100)]

The verification of the Stable Release Update for linux-firmware has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.