Possible missing firmware /lib/firmware/rtl_nic/rtl8125a-3.fw for module r8169

[akchhay alok]

[SRU Justification]

[Impact]

Missing firmware for Realtek RTL8153 Based USB Ethernet Adapters, which is supported by linux-generic-hwe-18.04 kernel (currently v5.4).

[Fix]

Two upstream commit necessary:
* commit b27d12383e7a ("rtl_nic: add firmware files for RTL8153")
* commit 6f89735800fe ("rtl_nic: update firmware for RTL8153A")

[Test Case]

Without firmware, drive probe would fail with:

  $ dmesg | grep firmware | grep rtl8153
  r8152 2-4.1:1.0: firmware: failed to load rtl_nic/rtl8153a-2.fw (-2)
  r8152 2-4.1:1.0: Direct firmware load for rtl_nic/rtl8153a-2.fw failed with error -2
  r8152 2-4.1:1.0: unable to load firmware patch rtl_nic/rtl8153a-2.fw (-2)

With firmware, it should succeed:

  $ dmesg | grep rtl8152
  r8152 2-1:1.0: load rtl8153a-3 v2 02/07/20 successfully
  r8152 2-1:1.0 eth0: v1.11.11
  r8152 2-1:1.0 enp0s20f0u1: renamed from eth0

[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]

RTL8153 firmware has been available on Eoan and newer, so only Bionic is
nominated.

========== original bug report ==========

Possible missing firmware /lib/firmware/rtl_nic/rtl8125a-3.fw for module r8169

after running sudo apt upgrade in ubuntu 18.04

ProblemType: Bug
DistroRelease: Ubuntu 18.04
Package: ubuntu-release-upgrader-core 1:18.04.38
ProcVersionSignature: Ubuntu 5.4.0-42.46~18.04.1-generic 5.4.44
Uname: Linux 5.4.0-42-generic x86_64
ApportVersion: 2.20.9-0ubuntu7.16
Architecture: amd64
CrashDB: ubuntu
CurrentDesktop: ubuntu:GNOME
Date: Thu Aug 6 22:38:31 2020
InstallationDate: Installed on 2019-06-16 (417 days ago)
InstallationMedia: Ubuntu 18.04.2 LTS "Bionic Beaver" - Release amd64 (20190210)
PackageArchitecture: all
SourcePackage: ubuntu-release-upgrader
Symptom: release-upgrade
UpgradeStatus: No upgrade log present (probably fresh install)
VarLogDistupgradeAptlog:
 Log time: 2020-03-08 22:54:00.439353
 Starting pkgProblemResolver with broken count: 0
 Starting 2 pkgProblemResolver with broken count: 0
 Done

[Brian Murray (brian-murray)]

The file is available on my 20.04 system.
[ 12:15PM 11013 ] [ bdmurray@impulse:/tmp/bug-1890638 ]
 $ dpkg -L linux-firmware | grep "rtl_nic"
/lib/firmware/rtl_nic
/lib/firmware/rtl_nic/rtl8105e-1.fw
/lib/firmware/rtl_nic/rtl8106e-1.fw
/lib/firmware/rtl_nic/rtl8106e-2.fw
/lib/firmware/rtl_nic/rtl8107e-1.fw
/lib/firmware/rtl_nic/rtl8107e-2.fw
/lib/firmware/rtl_nic/rtl8125a-3.fw
/lib/firmware/rtl_nic/rtl8153a-2.fw
/lib/firmware/rtl_nic/rtl8153a-3.fw
/lib/firmware/rtl_nic/rtl8153a-4.fw
/lib/firmware/rtl_nic/rtl8153b-2.fw
/lib/firmware/rtl_nic/rtl8168d-1.fw
/lib/firmware/rtl_nic/rtl8168d-2.fw
/lib/firmware/rtl_nic/rtl8168e-1.fw
/lib/firmware/rtl_nic/rtl8168e-2.fw
/lib/firmware/rtl_nic/rtl8168e-3.fw
/lib/firmware/rtl_nic/rtl8168f-1.fw
/lib/firmware/rtl_nic/rtl8168f-2.fw
/lib/firmware/rtl_nic/rtl8168fp-3.fw
/lib/firmware/rtl_nic/rtl8168g-1.fw
/lib/firmware/rtl_nic/rtl8168g-2.fw
/lib/firmware/rtl_nic/rtl8168g-3.fw
/lib/firmware/rtl_nic/rtl8168h-1.fw
/lib/firmware/rtl_nic/rtl8168h-2.fw
/lib/firmware/rtl_nic/rtl8402-1.fw
/lib/firmware/rtl_nic/rtl8411-1.fw
/lib/firmware/rtl_nic/rtl8411-2.fw
[ 12:15PM 11014 ] [ bdmurray@impulse:/tmp/bug-1890638 ]
 $ apt-cache policy linux-firmware
linux-firmware:
  Installed: 1.187.2
  Candidate: 1.187.2

[Olaf Zimmermann (faloz2416)]

I had also the Prblem with the missing of /lib/firmware/rtl_nic/rtl8125a-3.fw
Then i have found the rtl8125a-3.fw on git
https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/tree/rtl_nic
then download and copy in the directory /lib/firmware/rtl_nic/
and the command
$ sudo update-initramfs -u
update-initramfs: Generating /boot/initrd.img-5.4.0-42-generic

reboot and all is ok

[Launchpad Janitor (janitor)]

Status changed to 'Confirmed' because the bug affects multiple users.

[Zsolt Farago (azazil)]

Same problem here, first missing rtl8125a-3.fw then missing rtl8168fp-3.fw on ubuntu 18.04 using ubuntu 20 kernel version.

Had to download by hand.

[ken summerville (twpb)]

I am also affected by this bug, but I'm missing at least two firmware files, not just one. I'm missing rtl8168fp-3.fw and rtl8125a-3.fw, I had to download those two files manually

[Maurice Manning (boywiz)]

I too have the same error, I received the following after running an apt upgrade

W: Possible missing firmware /lib/firmware/rtl_nic/rtl8125a-3.fw for module r8169
W: Possible missing firmware /lib/firmware/rtl_nic/rtl8168fp-3.fw for module r8169
W: Possible missing firmware /lib/firmware/amdgpu/renoir_gpu_info.bin for module amdgpu
W: Possible missing firmware /lib/firmware/amdgpu/renoir_asd.bin for module amdgpu
W: Possible missing firmware /lib/firmware/amdgpu/renoir_rlc.bin for module amdgpu
W: Possible missing firmware /lib/firmware/amdgpu/renoir_mec2.bin for module amdgpu
W: Possible missing firmware /lib/firmware/amdgpu/renoir_mec.bin for module amdgpu
W: Possible missing firmware /lib/firmware/amdgpu/renoir_me.bin for module amdgpu
W: Possible missing firmware /lib/firmware/amdgpu/renoir_pfp.bin for module amdgpu
W: Possible missing firmware /lib/firmware/amdgpu/renoir_ce.bin for module amdgpu
W: Possible missing firmware /lib/firmware/amdgpu/renoir_sdma.bin for module amdgpu
W: Possible missing firmware /lib/firmware/amdgpu/renoir_vcn.bin for module amdgpu

in my case downloading from the link above and doing the following fixed the errors for me.
sudo cp -R amdgpu/renoir_* /lib/firmware/amdgpu/
sudo cp -R rtl_nic/rtl8* /lib/firmware/rtl_nic/
sudo update-initramfs -u

Thanks @faloz2416

Mo

[Ruben Garcia (rubengarciahernandez)]

I am also affected.

[You-Sheng Yang (vicamo)]

rtl_nic/rtl8125a-3.fw appears in Ubuntu linux-firmware starting from Eoan. While it's required by linux-generic-hwe-18.04 kernel for driving rtl8125a cards, it deserves a fix.

[You-Sheng Yang (vicamo)]

$ git log korg/master -- rtl_nic/rtl8153a-3.fw
commit 6f89735800fe3af761104defdb81b50b6d6402f0
Author: Hayes Wang <email address hidden>
Date: Fri Feb 7 16:05:49 2020 +0800

    rtl_nic: update firmware for RTL8153A

    - rtl8153a-3 v2 02/07/20:
        1. Disable USB bp 2 and 3.

    - rtl8153a-4 v2 02/07/20:
        1. Fix the wrong bp_num for RTL_FW_USB.

    Signed-off-by: Hayes Wang <email address hidden>
    Signed-off-by: Josh Boyer <email address hidden>

commit b27d12383e7a3049812007cded2f44e7e8769742
Author: Hayes Wang <email address hidden>
Date: Wed Oct 23 11:39:55 2019 +0800

    rtl_nic: add firmware files for RTL8153

    This adds the firmware for Realtek RTL8153 Based USB Ethernet Adapters.

    1. Fix compatible issue for Asmedia hub.
    2. Fix compatible issue for Compal platform.
    3. Fix sometimes the device is lost after rebooting.
    4. Improve the compatibility for EEE.

    Signed-off-by: Hayes Wang <email address hidden>
    Signed-off-by: Josh Boyer <email address hidden>

[You-Sheng Yang (vicamo)]

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

[You-Sheng Yang (vicamo)]

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

[You-Sheng Yang (vicamo)]

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

[Timo Aaltonen (tjaalton)]

Hello akchhay, or anyone else affected,

Accepted linux-firmware into bionic-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/linux-firmware/1.173.20 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-bionic to verification-done-bionic. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-bionic. 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.

[Brian Murray (brian-murray)]

Could you please provide some details regarding the steps you took to verify that this SRU was good?

[You-Sheng Yang (vicamo)]

As indicated from SRU justification section, the solution is to backport a few new fw blobs. So the steps were to verify if the downloaded deb contains exactly the binaries I proposed:

  $ dpkg-deb -R linux-firmware_*.deb .
  $ md5sum lib/firmware/rtl_nic/rtl8153*
  $ md5sum ~/linux-firmware.git/rtl_nic/rtl8153*

and to find a spare platform, install that deb from bionic-proposed, boot with RTL8153 usb-ether attached, and check if network interface is available.

[You-Sheng Yang (vicamo)]

[86441.186983] usb 2-2: new SuperSpeed Gen 1 USB device number 21 using xhci_hcd
[86441.216178] usb 2-2: New USB device found, idVendor=05e3, idProduct=0626, bcdDevice= 6.54
[86441.216193] usb 2-2: New USB device strings: Mfr=1, Product=2, SerialNumber=0
[86441.216199] usb 2-2: Product: USB3.1 Hub
[86441.216203] usb 2-2: Manufacturer: GenesysLogic
[86441.218434] hub 2-2:1.0: USB hub found
[86441.218770] hub 2-2:1.0: 4 ports detected
[86441.342825] usb 1-2: new high-speed USB device number 9 using xhci_hcd
[86441.497697] usb 1-2: New USB device found, idVendor=05e3, idProduct=0610, bcdDevice= 6.54
[86441.497702] usb 1-2: New USB device strings: Mfr=1, Product=2, SerialNumber=0
[86441.497704] usb 1-2: Product: USB2.1 Hub
[86441.497705] usb 1-2: Manufacturer: GenesysLogic
[86441.498581] hub 1-2:1.0: USB hub found
[86441.500068] hub 1-2:1.0: 4 ports detected
[86441.810761] usb 1-2.4: new high-speed USB device number 10 using xhci_hcd
[86441.935709] usb 1-2.4: New USB device found, idVendor=0bda, idProduct=8153, bcdDevice=30.00
[86441.935714] usb 1-2.4: New USB device strings: Mfr=1, Product=2, SerialNumber=6
[86441.935716] usb 1-2.4: Product: USB 10/100/1000 LAN
[86441.935717] usb 1-2.4: Manufacturer: Realtek
[86441.935718] usb 1-2.4: SerialNumber: 000001
[86442.655511] usbcore: registered new interface driver r8152
[86442.661895] usbcore: registered new interface driver cdc_ether
[86442.663764] usbcore: registered new interface driver r8153_ecm
[86442.767922] usb 1-2.4: reset high-speed USB device number 10 using xhci_hcd
[86442.922162] r8152 1-2.4:1.0: load rtl8153a-4 v2 02/07/20 successfully
[86442.951681] r8152 1-2.4:1.0 eth0: v1.11.11
[86443.006134] r8152 1-2.4:1.0 enx00e04c680275: renamed from eth0
^C

$ lsusb
Bus 001 Device 010: ID 0bda:8153 Realtek Semiconductor Corp. RTL8153 Gigabit Ethernet Adapter

[Launchpad Janitor (janitor)]

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

---------------
linux-firmware (1.173.20) bionic; urgency=medium

  * Possible missing firmware /lib/firmware/rtl_nic/rtl8125a-3.fw for module
    r8169 (LP: #1890641)
    - rtl_nic: add firmware files for RTL8153
    - rtl_nic: update firmware for RTL8153A

 -- Seth Forshee <email address hidden> Tue, 02 Mar 2021 14:28:08 -0600

[Brian Murray (brian-murray)]

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.