Add support of Smart Amplifier IC ALC1319D on Intel platforms

[Chris Chiu]

SRU Justification for firmware-sof

[Impact]
To support Smart Amplifier IC ALC1319D, it requires sof-bin v2.2.6

[Fix]
Pull sof-bin v2.2.6 and for the completeness pull in v2.2.5, too

[Test Case]
Install the fixes on the target platform(RPL Dell SKU 0BDA) and verify the audio function.
1. Install the firmware-sof on platform(RPL) with Audio Smart AMP IC ALC1319D
2. Make sure the audio works
3. Also try above steps on other platforms(ADL/TGL) to make sure the audio keep working.

[Where problems could occur]
New firmware may affect ADL, RPL, and TGL platforms, we need to verify it on not only the target platform, but other existing platforms.

[Misc]
https://github.com/thesofproject/sof-bin/releases/tag/v2.2.5
https://github.com/thesofproject/sof-bin/releases/tag/v2.2.6

================

[Impact]
Speaker is not functional on some Dell machines of Intel RPL platforms

[Fix]
Here's the patch submitted by Intel.
https://patchwork.kernel.org/project<email address hidden>/

[Test Case]
1. Power on the machine and open the audio settings
2. Verify it's not `Dummy Output` shown on the Audio output option

[Where problems could occur]
Only affect specific Intel RPL platforms. The risk of regression is low.

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

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.

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

This bug is awaiting verification that the linux-oem-6.1/6.1.0-1015.15 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-6.1 - 6.1.0-1015.15

---------------
linux-oem-6.1 (6.1.0-1015.15) jammy; urgency=medium

  * jammy/linux-oem-6.1: 6.1.0-1015.15 -proposed tracker (LP: #2024152)

  * Packaging resync (LP: #1786013)
    - [Packaging] resync git-ubuntu-log
    - [Packaging] resync getabis

  * CVE-2023-2430
    - io_uring: get rid of double locking
    - io_uring: extract a io_msg_install_complete helper
    - io_uring/msg_ring: move double lock/unlock helpers higher up
    - io_uring/msg_ring: fix missing lock on overflow for IOPOLL

  * LSM: Configuring Too Many LSMs Causes Kernel Panic on Boot (LP: #1987998)
    - SAUCE: LSM: Change Landlock from LSMBLOB_NEEDED to LSMBLOB_NOT_NEEDED

  * Some INVLPG implementations can leave Global translations unflushed when
    PCIDs are enabled (LP: #2023220)
    - x86/mm: Avoid incomplete Global INVLPG flushes

  * cls_flower: off-by-one in fl_set_geneve_opt (LP: #2023577)
    - net/sched: flower: fix possible OOB write in fl_set_geneve_opt()

  * CVE-2023-2176
    - RDMA/core: Refactor rdma_bind_addr

  * ALSA: hda/realtek: Enable headset onLenovo M70/M90 (LP: #2021449)
    - ALSA: hda/realtek: Enable headset onLenovo M70/M90

  * Add microphone support of the front headphone port on P3 Tower
    (LP: #2023650)
    - ALSA: hda/realtek: Add Lenovo P3 Tower platform

  * Add support of Smart Amplifier IC ALC1319D on Intel platforms
    (LP: #2023201)
    - ASoC: Intel: soc-acpi: add table for RPL Dell SKU 0BDA

  * Fix speaker volume too low on HP G10 laptops (LP: #2023197)
    - ALSA: hda/realtek: Enable 4 amplifiers instead of 2 on a HP platform

  * System hang at reading amdgpu sysfs attribute psp_vbflash (LP: #2023307)
    - SAUCE: drm/amd: Make sure image is written to trigger VBIOS image update
      flow

  * System either hang with black screen or rebooted on entering suspend on AMD
    Ryzen 9 PRO 7940HS w/ Radeon 780M Graphics (LP: #2020685)
    - drm/amdgpu: refine get gpu clock counter method
    - drm/amdgpu/gfx11: update gpu_clock_counter logic

  * Fix Monitor lost after replug WD19TBS to SUT port with VGA/DVI to type-C
    dongle (LP: #2021949)
    - thunderbolt: Increase timeout of DP OUT adapter handshake
    - thunderbolt: Do not touch CL state configuration during discovery
    - thunderbolt: Increase DisplayPort Connection Manager handshake timeout

  * Fix Disable thunderbolt clx make edp-monitor garbage while moving the
    touchpad (LP: #2023004)
    - drm/i915: Explain the magic numbers for AUX SYNC/precharge length
    - drm/i915: Use 18 fast wake AUX sync len

  * Include the MAC address pass through function on RTL8153DD-CG (LP: #2020295)
    - r8152: add USB device driver for config selection

  * FM350(mtk_t7xx) failed to suspend, or early wake while suspending
    (LP: #2020743)
    - net: wwan: t7xx: Ensure init is completed before system sleep

 -- Timo Aaltonen <email address hidden> Fri, 16 Jun 2023 11:51:13 +0300

[AceLan Kao (acelankao)]

https://code.launchpad.net/~acelankao/ubuntu/+source/firmware-sof/+git/firmware-sof/+merge/446354

[Ubuntu Foundations Team Bug Bot (crichton)]

The attachment "firmware-sof_2.0-1ubuntu4.2.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.]

[Andreas Hasenack (ahasenack)]

Before being released into jammy, this will still need a Mantic upload (devel release), and at least a Lunar upload.

I'm not qualified to do firmware package reviews, as I think these packages have something special about their release (like a digital signature), and I don't know how to review the binary blobs that get added to it.

[Steve Langasek (vorlon)]

It doesn't look to me like the bug description matches the contents of the firmware-sof upload in jammy. The bug description implies a targeted fix with possible impact only to a particular affected platform. The debdiff of the upload includes 16 new firmware files, and opaque changes to 16 others.

This needs to be reconciled.

[Anthony Wong (anthonywong)]

@Andreas firmware-sof in Mantic is 2.2.6, which already has everything in Acelan's merge proposal.

@Steve Acelan's merge proposal indeed pulls in 16 new binaries from upstream's firmware-sof 2.2.5 and 2.2.6, more than this bug originally need. It's because when we roll out a new HWE kernel in the future, some users will eventually need the other firmwares. Do you advise us to: 1. update the bug description, or 2. submit a new MR with only the firmwares we need for this bug.

[Steve Langasek (vorlon)]

Anthony, I have no preference about 1 vs 2, I only ask that the bug (and therefore the SRU verification process) be consistent with the upload.

[Steve Langasek (vorlon)]

"@Andreas firmware-sof in Mantic is 2.2.6, which already has everything in Acelan's merge proposal."

[AceLan Kao (acelankao)]

I've updated the bug description for firmware-sof SRU, and provide the link to where the firmare is from.

[Anthony Wong (anthonywong)]

Change status to 'in progress' as the package has been uploaded, and Acelan has updated the bug description.

[Robie Basak (racb)]

Hello Chris, or anyone else affected,

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

[Robie Basak (racb)]

I noted that Lunar wasn't updated when I accepted this, but didn't want to block progress Jammy while I enquired. However, another SRU team member has confirmed that it is a requirement for hardware enablements for the latest stable release of Ubuntu to be enabled as well - otherwise users will be regressed when they upgrade. Please could you also upload a fix for Lunar? This will block the release to Jammy. I'll add a task to track that. Thanks!

[AceLan Kao (acelankao)]

Hi Robie,

Here is the MR for lunar, please review , thanks
https://code.launchpad.net/~acelankao/ubuntu/+source/firmware-sof/+git/firmware-sof/+merge/447491

[Launchpad Janitor (janitor)]

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

[Max Lee (max-lee)]

The speaker works with
linux-oem-6.1-6.1.0-1023
firmware-sof-signed 2.0-1ubuntu4.2
on https://certification.canonical.com/hardware/202309-32142/

[Steve Langasek (vorlon)]

The firmware-sof upload in lunar-proposed contains a sha256sum.txt with the checksums of all the firmware. But every line of this file is different from every line in the previous version, because the version number is encoded. Likewise, the file paths within the package encode the version. This makes it very difficult to review this package using a debdiff. Can you suggest a method of reviewing the package that confirms we have only firmware file additions here, and not changes to existing firmware files that could cause a regression?

[Timo Aaltonen (tjaalton)]

Thanks for the review. According to https://github.com/thesofproject/sof-bin/issues/134#issuecomment-1718183989 adding versioned directories was a mistake by upstream, so I'll mangle the backport to still use v2.2.4 in the files directories and manifest/sha256sum, so the diff will look much better for review.

[Steve Langasek (vorlon)]

Hello Chris, or anyone else affected,

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

[Timo Aaltonen (tjaalton)]

The verification of the Stable Release Update for firmware-sof 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.

[Launchpad Janitor (janitor)]

This bug was fixed in the package firmware-sof - 2.0-1ubuntu4.2

---------------
firmware-sof (2.0-1ubuntu4.2) jammy; urgency=medium

  * Add ADL/RPL topology updates
    - UBUNTU: SAUCE: Add v2.2.5 & v2.2.6 topology updates for Intel ADL and
    RPL. (LP: #2023201)

 -- Chia-Lin Kao (AceLan) <email address hidden> Wed, 12 Jul 2023 16:07:27 +0200

[Launchpad Janitor (janitor)]

This bug was fixed in the package firmware-sof - 2.2.4+2.2.6-0ubuntu0.1

---------------
firmware-sof (2.2.4+2.2.6-0ubuntu0.1) lunar; urgency=medium

  * Backport to lunar. (LP: #2023201)
    - this is actually 2.2.6-1, but with the files directories renamed
      to still use -v2.2.4, and manifest/sha256sum modified to match

 -- Timo Aaltonen <email address hidden> Fri, 06 Oct 2023 12:07:48 +0300