build backport-iwlwifi-dkms as linux-modules-iwlwifi-ABI

[You-Sheng Yang]

[SRU Justfication]

[Impact]

Intel AX211 iwlwifi -64 firmware may fail to init under reboot stress,
and -67 is immune. FW API -64 supported by oem-5.14, and -67 in v5.16.
Not reproducible on every platform with AX211 installed, and the chances
of such failures vary from one to another.

[Fix]

A few solutions were considered. The very first one is to ask Intel to
fix -64 firmware directly, and the answer is a solid no claimed -64 is
not the planned production version of AX211.

It's also possible to backport FW API from v5.16, but while iwlwifi FW
API is more or less a black box to us and the new FW APIs also depends
on updates on the wireless stack, this is going to be very risky and
actually we had regressions before after such backports.

The last viable solution is to run backport-iwlwifi-dkms >= rev 8580 on
the effected platforms. This means oem-5.14 and its migration target,
hwe-5.15 will not be able to drive this piece of hw flawlessly without
backport-iwlwifi-dkms installed.

However, while we need secureboot to be enabled on these platforms,
backport-iwlwifi-dkms must also be signed somehow. There are two
possible method to achieve this, too. One, to prebuild this dkms as zfs
and v4l2loopback does. However, while backport-iwlwifi-dkms generates
kernel modules with exactly the same name as the in-tree ones, when
prebuilt, they'll be available directly from the linux-modules package
and therefore overrides the in-tree ones always, turning the in-tree
driver completely useless and risk the stability of all other generic
installations.

The second one is to build backport-iwlwifi-dkms as nvidia graphic
drivers in the linux-restricted-modules source package. In this way,
affected platforms may install the corresponding packages when needed
without interfering others. However, l-r-m is for restricted modules
that needs special care of redistribution of its binaries, and
backport-iwlwifi-dkms is GPL licensed.

Here a similar but simpler process in the main kernel tree is
re-implemented. Two additional packages,
linux-modules-MODULE-PKGVER-ABINUM-FLAVOUR and its meta package
linux-modules-MODULE-FLAVOUR will be created.

[Test Case]

Test builds:
./jammy/amd64/linux-modules-iwlwifi-5.15.0-27-generic_5.15.0-27.28_amd64.deb
./jammy/amd64/linux-modules-iwlwifi-generic_5.15.0-27.28_amd64.deb
./unstable/amd64/linux-modules-iwlwifi-5.17.0-8-generic_5.17.0-8.8_amd64.deb
./unstable/amd64/linux-modules-iwlwifi-generic_5.17.0-8.8_amd64.deb
./oem-5.17/amd64/linux-modules-iwlwifi-5.17.0-1003-oem_5.17.0-1003.3_amd64.deb
./oem-5.17/amd64/linux-modules-iwlwifi-oem_5.17.0-1003.3_amd64.deb
./oem-5.14/amd64/linux-modules-iwlwifi-5.14.0-1033-oem_5.14.0-1033.36_amd64.deb
./oem-5.14/amd64/linux-modules-iwlwifi-oem_5.14.0-1033.36_amd64.deb

[Where problems could occur]

The latest (9858-0ubuntu2) backport-iwlwifi-dkms/jammy actually fails
to build under this proposed process. Debdiff attached to the same
bug.

Different from nvidia packages built from l-r-m, the generated package
names do not carry an additional short version string, e.g. nvidia-410,
as there is no such necessity to build multiple versions of iwlwifi.
The modules are installed to /lib/modules/<kver>/kernel/iwlwifi, not
iwlwifi-9858/.

========== linux-meta-hwe-5.15 SRU ==========

[Impact]

To bring standalone dkms module builds to hwe-5.15 as well.

[Fix]

Same fix that has been applied to
Unstable/Kinetic/Jammy/OEM-6.0/OEM-5.14/HWE-5.19.

[Test Case]

This should generate meta packages:
* linux-modules-iwlwifi-generic-hwe-20.04
* linux-modules-iwlwifi-generic-hwe-20.04-edge
* linux-modules-iwlwifi-oem-20.04
* linux-modules-iwlwifi-oem-20.04d

[Where problems could occur]

This creates only the meta packages that are currently missing. No
function changes.

[Other Info]

While this has been ported to all other series in concern, only hwe-5.15
is nominated for fix here.

The patch titled "UBUNTU: [Packaging] skip standalone dkms modules for
virtual flavour" was not tagged with a BugLink line, but we'd need that
to skip generating linux-modules-foo meta packages for virtual flavour.

========== backport-iwlwifi-dkms SRU ==========

In order to be compiled with dkms-build in kernel source package, the kernel header dir will not be /lib/modules/<version>/build but a temporary directory. This change specifies KLIB_BUILD from dkms variable ${kernel_source_dir}.

[backport-iwlwifi-dkms]

Under some circumstances, dkms is invoked as: `/usr/sbin/dkms build --kernelsourcedir ...` and yet the dkms make command in this package has:

  MAKE="'make' -j$(num_cpu_cores) KLIB=/lib/modules/$kernelver"

[You-Sheng Yang (vicamo)]

Turns out is is an issue originated from linux-backports: https://git.kernel.org/pub/scm/linux/kernel/git/backports/backports.git/tree/backport/Makefile

[Ubuntu Kernel Bot (ubuntu-kernel-bot)]

This bug is missing log files that will aid in diagnosing the problem. While running an Ubuntu kernel (not a mainline or third-party kernel) please enter the following command in a terminal window:

apport-collect 1969434

and then change the status of the bug to 'Confirmed'.

If, due to the nature of the issue you have encountered, you are unable to run this command, please add a comment stating that fact and change the bug status to 'Confirmed'.

This change has been made by an automated script, maintained by the Ubuntu Kernel Team.

[You-Sheng Yang (vicamo)]

Prebuilt PPA in https://launchpad.net/~vicamo/+archive/ubuntu/ppa-1969434

[Ubuntu Foundations Team Bug Bot (crichton)]

The attachment "backport-iwlwifi-dkms_9858-0ubuntu3.debdiff" seems to be a debdiff. The ubuntu-sponsors team has been subscribed to the bug report so that they can review and hopefully sponsor the debdiff. If the attachment isn't a patch, please remove the "patch" flag from the attachment, remove the "patch" tag, and if you are member of the ~ubuntu-sponsors, unsubscribe the team.

[This is an automated message performed by a Launchpad user owned by ~brian-murray, for any issue please contact him.]

[You-Sheng Yang (vicamo)]

Tested:
./jammy/amd64/linux-modules-iwlwifi-5.15.0-27-generic_5.15.0-27.28_amd64.deb
./jammy/amd64/linux-modules-iwlwifi-generic_5.15.0-27.28_amd64.deb
./unstable/amd64/linux-modules-iwlwifi-5.17.0-8-generic_5.17.0-8.8_amd64.deb
./unstable/amd64/linux-modules-iwlwifi-generic_5.17.0-8.8_amd64.deb
./oem-5.17/amd64/linux-modules-iwlwifi-5.17.0-1003-oem_5.17.0-1003.3_amd64.deb
./oem-5.17/amd64/linux-modules-iwlwifi-oem_5.17.0-1003.3_amd64.deb
./oem-5.14/amd64/linux-modules-iwlwifi-5.14.0-1033-oem_5.14.0-1033.36_amd64.deb
./oem-5.14/amd64/linux-modules-iwlwifi-oem_5.14.0-1033.36_amd64.deb

[You-Sheng Yang (vicamo)]

SRU: https://lists.ubuntu.com/archives/kernel-team/2022-April/129581.html (oem-5.15, jammy, oem-5.17, unstable)

[Launchpad Janitor (janitor)]

This bug was fixed in the package backport-iwlwifi-dkms - 9858-0ubuntu3

---------------
backport-iwlwifi-dkms (9858-0ubuntu3) jammy; urgency=medium

  * Fix FTBFS dkms module during kernel builds with a non-default
    kernelsourcedir location by respecting kernelsourcedir in dkms.conf
    (LP: #1969434)

 -- You-Sheng Yang <email address hidden> Tue, 19 Apr 2022 17:20:09 +0800

[You-Sheng Yang (vicamo)]

SRU: https://lists.ubuntu.com/archives/kernel-team/2022-April/129683.html (V2: oem-5.14, jammy, unstable, oem-5.17)

[You-Sheng Yang (vicamo)]

Blocked by https://bugs.launchpad.net/ubuntu/+source/backport-iwlwifi-dkms/+bug/1970777, backport-iwlwifi-dkms 9858-0ubuntu3 fails to build against latest linux-unstable=5.18.0-1-generic.

[You-Sheng Yang (vicamo)]

And by https://bugs.launchpad.net/ubuntu/+source/v4l2loopback/+bug/1970983, also FTBFS due to linux-unstable=5.18.0-1-generic.

[You-Sheng Yang (vicamo)]

SRU V3:
* https://lists.ubuntu.com/archives/kernel-team/2022-May/129985.html (kernel-versions)
* https://lists.ubuntu.com/archives/kernel-team/2022-May/129989.html (linux-meta, oem-5.14/jammy/oem-5.17/unstable)
* https://lists.ubuntu.com/archives/kernel-team/2022-May/129996.html (linux, oem-5.14/jammy/oem-5.17/unstable)

[You-Sheng Yang (vicamo)]

SRU V4:
* linux: https://lists.ubuntu.com/archives/kernel-team/2022-May/130284.html (oem-5.14, jammy, oem-5.17, unstable)
* linux-meta: https://lists.ubuntu.com/archives/kernel-team/2022-May/130294.html (oem-5.14, jammy, oem-5.17, unstable)

[Ubuntu Kernel Bot (ubuntu-kernel-bot)]

This bug is awaiting verification that the linux-oem-5.14/5.14.0-1037.41 kernel in -proposed solves the problem. Please test the kernel and update this bug with the results. If the problem is solved, change the tag 'verification-needed-focal' to 'verification-done-focal'. If the problem still exists, change the tag 'verification-needed-focal' to 'verification-failed-focal'.

If verification is not done by 5 working days from today, this fix will be dropped from the source code, and this bug will be closed.

See https://wiki.ubuntu.com/Testing/EnableProposed for documentation how to enable and use -proposed. Thank you!

[Ubuntu SRU Bot (ubuntu-sru-bot)]

All autopkgtests for the newly accepted linux-meta-oem-5.17 (5.17.0.1005.5) for jammy have finished running.
The following regressions have been reported in tests triggered by the package:

dahdi-linux/1:2.11.1~dfsg-1ubuntu11 (amd64)
r8168/8.049.02-1ubuntu1 (amd64)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/jammy/update_excuses.html#linux-meta-oem-5.17

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

[Kai-Chuan Hsieh (kchsieh)]

On the system PORT-DVT2-D1, BIOS 0.2.31 with proposed kernel 5.14.0-1037-oem and linux-modules-iwlwifi-oem-20.04d.

I can still reproduce the RT ucode start timeout log, but it will be loaded after retry.
May 18 13:37:48 PORT-DVT2-D1 kernel: iwlwifi 0000:00:14.3: Failed to start RT ucode: -110
May 18 13:37:48 PORT-DVT2-D1 kernel: iwlwifi 0000:00:14.3: WRT: Collecting data: ini trigger 13 fired (delay=0ms).
...
May 18 13:37:49 PORT-DVT2-D1 kernel: iwlwifi 0000:00:14.3: Failed to run INIT ucode: -110
May 18 13:37:49 PORT-DVT2-D1 kernel: iwlwifi 0000:00:14.3: retry init count 0
May 18 13:37:49 PORT-DVT2-D1 kernel: iwlwifi 0000:00:14.3: Detected Intel(R) Wi-Fi 6E AX211 160MHz, REV=0x370

Therefore, the Wi-Fi still can be used when the issue happened.

[Kai-Chuan Hsieh (kchsieh)]

Run 200 times reboot stress on POMP-DGPU-DVT-C2-R_202107-29336, BIOS 1.0.6. It didn't encounter "RT ucode init timeout error". The kernel log is attached.

[Ubuntu SRU Bot (ubuntu-sru-bot)]

All autopkgtests for the newly accepted linux-meta-oem-5.17 (5.17.0.1005.5) for jammy have finished running.
The following regressions have been reported in tests triggered by the package:

dahdi-linux/1:2.11.1~dfsg-1ubuntu11 (amd64)
r8168/8.049.02-1ubuntu1 (amd64)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/jammy/update_excuses.html#linux-meta-oem-5.17

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

[Ubuntu Kernel Bot (ubuntu-kernel-bot)]

This bug is awaiting verification that the linux-oem-5.17/5.17.0-1006.6 kernel in -proposed solves the problem. Please test the kernel and update this bug with the results. If the problem is solved, change the tag 'verification-needed-jammy' to 'verification-done-jammy'. If the problem still exists, change the tag 'verification-needed-jammy' to 'verification-failed-jammy'.

If verification is not done by 5 working days from today, this fix will be dropped from the source code, and this bug will be closed.

See https://wiki.ubuntu.com/Testing/EnableProposed for documentation how to enable and use -proposed. Thank you!

[Launchpad Janitor (janitor)]

This bug was fixed in the package linux-oem-5.14 - 5.14.0-1038.42

---------------
linux-oem-5.14 (5.14.0-1038.42) focal; urgency=medium

  * focal/linux-oem-5.14: 5.14.0-1038.42 -proposed tracker (LP: #1973981)

  * CVE-2022-29581
    - net/sched: cls_u32: fix netns refcount changes in u32_change()

 -- Timo Aaltonen <email address hidden> Thu, 19 May 2022 07:57:30 +0300

[Timo Aaltonen (tjaalton)]

oem-5.17 verification missing

[You-Sheng Yang (vicamo)]

correctly generated:
* https://launchpad.net/ubuntu/+archive/primary/+files/linux-modules-iwlwifi-5.15.0-36-generic_5.15.0-36.37_amd64.deb
* https://launchpad.net/ubuntu/+archive/primary/+files/linux-modules-iwlwifi-5.17.0-1009-oem_5.17.0-1009.9_amd64.deb

[Launchpad Janitor (janitor)]

This bug was fixed in the package linux-oem-5.17 - 5.17.0-1011.12

---------------
linux-oem-5.17 (5.17.0-1011.12) jammy; urgency=medium

  * CVE-2022-1972
    - netfilter: nf_tables: sanitize nft_set_desc_concat_parse()

  * CVE-2022-1966
    - netfilter: nf_tables: disallow non-stateful expression in sets earlier

 -- Thadeu Lima de Souza Cascardo <email address hidden> Fri, 03 Jun 2022 14:17:23 -0300

[Ubuntu SRU Bot (ubuntu-sru-bot)]

All autopkgtests for the newly accepted linux-meta (5.15.0.40.41) for jammy have finished running.
The following regressions have been reported in tests triggered by the package:

systemd/249.11-0ubuntu3.1 (arm64, armhf)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/jammy/update_excuses.html#linux-meta

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

[Ubuntu SRU Bot (ubuntu-sru-bot)]

All autopkgtests for the newly accepted linux-meta (5.15.0.40.42) for jammy have finished running.
The following regressions have been reported in tests triggered by the package:

casper/1.470 (amd64)
network-manager/1.36.6-0ubuntu1 (arm64)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/jammy/update_excuses.html#linux-meta

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

[Launchpad Janitor (janitor)]

This bug was fixed in the package linux - 5.15.0-40.43

---------------
linux (5.15.0-40.43) jammy; urgency=medium

  * jammy/linux: 5.15.0-40.43 -proposed tracker (LP: #1978610)

  * Packaging resync (LP: #1786013)
    - debian/dkms-versions -- update from kernel-versions (main/2022.05.30)

  * [SRU][OEM-5.14/OEM-5.17/J][PATCH 0/2] Fix system hangs after s2idle on AMD
    A+A GPU (LP: #1975804)
    - Revert "drm/amd/pm: keep the BACO feature enabled for suspend"
    - drm/amd: Don't reset dGPUs if the system is going to s2idle

  * [SRU][OEM-5.14/OEM-5.17/J][PATCH 0/1] Read the discovery registers for
    AMD_SFH (LP: #1975798)
    - HID: amd_sfh: Add support for sensor discovery

  * [UBUNTU 20.04] CPU-MF: add extended counter set definitions for new IBM z16
    (LP: #1974433)
    - s390/cpumf: add new extended counter set for IBM z16

  * [UBUNTU 20.04] KVM nesting support leaks too much memory, might result in
    stalls during cleanup (LP: #1974017)
    - KVM: s390: vsie/gmap: reduce gmap_rmap overhead

  * [UBUNTU 20.04] Null Pointer issue in nfs code running Ubuntu on IBM Z
    (LP: #1968096)
    - NFS: Fix up nfs_ctx_key_to_expire()

  * Fix REG_WAIT timeout for Yellow Carp (LP: #1971417)
    - drm/amd/display: Clear encoder assignments when state cleared.
    - drm/amd/display: fix stale info in link encoder assignment
    - drm/amd/display: Query all entries in assignment table during updates.
    - drm/amd/display: Initialise encoder assignment when initialising dc_state

  * Enable hotspot feature for Realtek 8821CE (LP: #1969326)
    - rtw88: Add update beacon flow for AP mode
    - rtw88: 8821c: Enable TX report for management frames
    - rtw88: do PHY calibration while starting AP
    - rtw88: 8821c: fix debugfs rssi value
    - rtw88: add ieee80211:sta_rc_update ops

  * prevent kernel panic with overlayfs + shiftfs (LP: #1973620)
    - SAUCE: overlayfs: prevent dereferencing struct file in ovl_vm_prfile_set()

  * disable Intel DMA remapping by default (LP: #1971699)
    - Revert "UBUNTU: [Config] enable Intel DMA remapping options by default"

  * Mute/mic LEDs no function on Elitebook 630 (LP: #1974111)
    - ALSA: hda/realtek: fix right sounds and mute/micmute LEDs for HP machine

  * [Regression] Real-time Kernel Build Failure (LP: #1972899)
    - x86/mm: Include spinlock_t definition in pgtable.

  * build backport-iwlwifi-dkms as linux-modules-iwlwifi-ABI (LP: #1969434)
    - [Packaging] support standalone dkms module builds
    - [Packaging] drop do_<mod> arch specific configs

  * IPU6 camera has no function on Andrews MLK (LP: #1964983)
    - SAUCE: IPU6: 2022-03-11 alpha release for Andrews MLK
    - [Config] IPU6: enable OV02C10 sensor
    - SAUCE: IPU6: 2022-04-01 Andrews MLK PV release
    - SAUCE: spi: ljca: return when a sub-transaction first failed
    - SACUE: ljca: disable parallelly stub write
    - SAUCE: ljca: fix race condition issue in runtime PM
    - SAUCE: i2c-ljca: fix a null pointer access issue on tgl
    - SAUCE: ljca: fix a typo issue
    - SAUCE: ljca: assume stub enum failed as a warning
    - SAUCE: mei: cleanup header file including
    - SAUCE: intel_ulpss: Replaced by LJCA and remove
    ...

[Launchpad Janitor (janitor)]

This bug was fixed in the package linux-meta - 5.15.0.40.42

---------------
linux-meta (5.15.0.40.42) jammy; urgency=medium

  * Miscellaneous Ubuntu changes
    - [Packaging] skip standalone dkms modules for virtual flavour

linux-meta (5.15.0.40.41) jammy; urgency=medium

  * Bump ABI 5.15.0-40

  * Packaging resync (LP: #1786013)
    - [Packaging] resync debian/dkms-versions from main package

  * build backport-iwlwifi-dkms as linux-modules-iwlwifi-ABI (LP: #1969434)
    - [Packaging] support standalone dkms module builds

 -- Dimitri John Ledkov <email address hidden> Fri, 17 Jun 2022 23:27:35 +0100

[Marcos Alano (mhalano)]

Any plans to extend this change to Kinetic?

[Launchpad Janitor (janitor)]

This bug was fixed in the package linux - 5.19.0-15.15

---------------
linux (5.19.0-15.15) kinetic; urgency=medium

  * kinetic/linux: 5.19.0-15.15 -proposed tracker (LP: #1983335)

  * Miscellaneous Ubuntu changes
    - [Config] update annotations to support both gcc-11 and gcc-12

 -- Andrea Righi <email address hidden> Tue, 02 Aug 2022 09:23:01 +0200

[Launchpad Janitor (janitor)]

This bug was fixed in the package linux-meta - 5.19.0.15.15

---------------
linux-meta (5.19.0.15.15) kinetic; urgency=medium

  * Bump ABI 5.19.0-15

 -- Andrea Righi <email address hidden> Tue, 02 Aug 2022 09:23:48 +0200

[Kleber Sacilotto de Souza (kleber-souza)]

The meta package change also needs to be done to linux-meta-hwe-5.15 in Focal. The linux-hwe-5.15 package produces 'linux-modules-iwlwifi-<ABI>-generic' but currently there are no meta package produced pointing at it.

[You-Sheng Yang (vicamo)]

SRU: https://lists.ubuntu.com/archives/kernel-team/2022-October/133872.html (linux-meta-hwe-5.15)

[Ubuntu SRU Bot (ubuntu-sru-bot)]

All autopkgtests for the newly accepted linux-meta-hwe-5.15 (5.15.0.53.59~20.04.21) for focal have finished running.
The following regressions have been reported in tests triggered by the package:

linux-hwe-5.15/5.15.0-53.59~20.04.1 (armhf)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/focal/update_excuses.html#linux-meta-hwe-5.15

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

[Launchpad Janitor (janitor)]

This bug was fixed in the package linux-meta-hwe-5.15 - 5.15.0.53.59~20.04.21

---------------
linux-meta-hwe-5.15 (5.15.0.53.59~20.04.21) focal; urgency=medium

  * Bump ABI 5.15.0-53.59~20.04

  * build backport-iwlwifi-dkms as linux-modules-iwlwifi-ABI (LP: #1969434)
    - [Packaging] hwe-5.15: support standalone dkms module builds
    - [Packaging] hwe-5.15: skip standalone dkms modules for virtual flavour

 -- Kleber Sacilotto de Souza <email address hidden> Thu, 20 Oct 2022 15:42:13 +0200

[Julian Andres Klode (juliank)]

I don't see anything sponsorable for backport-iwlwifi-dkms/focal and the other tasks are in various done states, so I am going to mark this task Incomplete and unsubscribe ubuntu sponsors.