[SRU] Migrate Pi users to KMS

[Dave Jones]

[ Impact ]

In switching Pi Server users over to the KMS overlay (as resolution to LP: #2038924) we need an additional quirk for upgraders to migrate config.txt (this will be similar, but not identical, to the one for LP: #1923673).

If we do not migrate such users, the immediate impact is that Pi 5 users will have no sound output on server images (the Pi 5 only has HDMI audio output, no auxiliary jack). Potentially more problematic in the long-run, though, is that we will wind up with users on different graphical stacks (the KMS stack, which is the only upstream supported stack going forward, and the legacy framebuffer method).

[ Test Case ]

* Flash Ubuntu jammy to SD card and boot on Pi 4
* Check /boot/firmware/config.txt does not contain dtoverlay=vc4-kms-v3d (it should not on Pi server images)
* sudo do-release-upgrade
* Proceed through upgrade and reboot
* Ensure system reboots successfully
* After reboot, check /boot/firmware/config.txt contains dtoverlay=vc4-kms-v3d
* Shutdown, move SD card to Pi 5 and boot it
* Check /proc/asound/cards contains entries for vc4hdmi

[ Regression Potential ]

The use of the KMS overlay itself is not concerning; we already use it on the Pi desktop images, and have for several cycles now with no serious issues, so the regression potential there is minimal.

However, the quirk does manipulate the bootloader's config.txt on the boot partition, which always carries the potential of leaving a system unbootable. To guard against this, tests are included with the quirk which check for several scenarios including a config.txt which has already been migrated to the KMS overlay manually by the user (there are various reasons to do this, including running kmscon), as well as the typical expected case.

[Timo Aaltonen (tjaalton)]

Hello Dave, or anyone else affected,

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

[Dave Jones (waveform)]

Verified with upgrade of a Pi 4 on an SD card as described in the test plan, only variant being to grab the noble tar-ball manually (as do-release-upgrade won't allow --proposed with --devel). Worked happily, KMS was present in the config.txt after the upgrade, and the HDMI audio outputs appeared correctly when the card was subsequently booted on a Pi 5.

[Launchpad Janitor (janitor)]

This bug was fixed in the package ubuntu-release-upgrader - 1:24.10.3

---------------
ubuntu-release-upgrader (1:24.10.3) oracular; urgency=medium

  [ Nick Rosbrook ]
  * tests: fix un-templated expected ubuntu.sources
  * DistUpgradeQuirks: prevent upgrades of TPM FDE desktops (LP: #2065229)
  * Run pre-build.sh: updating mirrors, demotions, and translations.

  [ Dave Jones ]
  * New quirk to add KMS overlay on Pi Server images (LP: #2065051)

 -- Nick Rosbrook <email address hidden> Thu, 09 May 2024 15:29:17 -0400

[Launchpad Janitor (janitor)]

This bug was fixed in the package ubuntu-release-upgrader - 1:24.04.18

---------------
ubuntu-release-upgrader (1:24.04.18) noble; urgency=medium

  [ Nick Rosbrook ]
  * tests: fix un-templated expected ubuntu.sources
  * DistUpgradeQuirks: prevent upgrades of TPM FDE desktops (LP: #2065229)
  * Run pre-build.sh: updating mirrors, demotions, and translations.

  [ Dave Jones ]
  * New quirk to add KMS overlay on Pi Server images (LP: #2065051)

ubuntu-release-upgrader (1:24.04.17) noble; urgency=medium

  [ Nick Rosbrook ]
  * Revert "DistUpgrade.cfg.jammy: keep {netfilter,iptables}-persistent installed"
  * DistUpgradeQuirks: keep {netfilter,iptables}-persistent instead of ufw
    (LP: #2061891)

  [ Julian Andres Klode ]
  * DistUpgrade.cfg.jammy: Add systemd-resolved to PostUpgradeInstall
    (LP: #2063464)
  * Transition the automatically installed bit to t64 libraries, and
    do not write automatically installed bit in simulation (LP: #2064090)
  * Run pre-build.sh: updating mirrors, demotions, and translations.

 -- Nick Rosbrook <email address hidden> Thu, 09 May 2024 15:39:56 -0400

[Brian Murray (brian-murray)]

The verification of the Stable Release Update for ubuntu-release-upgrader 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.