ucm2: soundwire: add rt713 SDCA device

[Artur Pak]

[ Impact ]
Affects devices with SoundWire-Audio Codec-ALC713 and SoundWire-Jack Codec-ALC713.
Without correct configurations in userspace above codecs cannot be used. Thus in Settings > Sound > Output test doesn't produce sounds and Input device is greyed out.

[ Fix ]
Adding rt713 config files in ucm2 will allow to utilize those codecs.
Upstream commit added support: https://github.com/alsa-project/alsa-ucm-conf/pull/363

[ Test Plan ]
Device with the soundwire card

$ cat /proc/asound/cards
 0 [sofsoundwire ]: sof-soundwire - sof-soundwire
                      Intel Soundwire SOF

Before fix:

1. $ alsactl init
alsa-lib utils.c:364:(uc_mgr_config_load_into) could not open configuration file /usr/share/alsa/ucm2/sof-soundwire/rt713.conf
alsa-lib parser.c:77:(uc_mgr_config_load_file) error: failed to open file /usr/share/alsa/ucm2/sof-soundwire/rt713.conf: -2
alsa-lib main.c:1412:(snd_use_case_mgr_open) error: failed to import hw:0 use case configuration -2
Found hardware: "sof-soundwire" "Intel Meteorlake HDMI" "HDA:8086281d,80860101,00100000 cfg-spk:2 cfg-amp:2 hs:rt713-sdca spk:rt1316 mic:rt713-dmic" "" ""
Hardware is initialized using a generic method

2. $ amixer contents
...
numid=24,iface=MIXER,name='Headphone Switch'
  ; type=BOOLEAN,access=rw------,values=1
  : values=off
...
numid=33,iface=MIXER,name='IEC958 Playback Switch'
  ; type=BOOLEAN,access=rw------,values=1
  : values=off

After fix: after adding patch files

1. $ alsactl init
alsa-lib main.c:779:(execute_sequence) exec '/bin/rm -rf /var/lib/alsa/card0.conf.d' failed (exit code 1)

(note: assuming that failed to remove the empty directory is not a critical problem)

2. $ amixer contents
...
numid=24,iface=MIXER,name='Headphone Switch'
  ; type=BOOLEAN,access=rw------,values=1
  : values=on
...
numid=33,iface=MIXER,name='IEC958 Playback Switch'
  ; type=BOOLEAN,access=rw------,values=1
  : values=on

[Where problems could occur]

 * This change adds new hardware support.

 * The change only adds new hardware support,
   it will not affect other codec device.

[Artur Pak (artur-at-work)]

for Jammy

[Artur Pak (artur-at-work)]

For Lunar

[Ubuntu Foundations Team Bug Bot (crichton)]

The attachment "alsa-ucm-conf_1.2.6.3-1ubuntu1.9.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.]

[Paride Legovini (paride)]

Hi, I see debdiffs for the stable releases, but what's the status of the devel release? It is Fix Released already? Can you please adjust the bug tasks accordingly? Thanks!

[Artur Pak (artur-at-work)]

Hi, the devel release (noble) was the same as mantic's changelog and didn't have the fix.
I'm uploading the debdiff for noble also. I hope this answers your question.

Please let me know if I missed something.
Thanks.

[Athos Ribeiro (athos-ribeiro)]

Hi Artur,

is this last patch the one for noble? The changelog entry still says mantic there.

Do note that the mantic version will need to be adjusted as per the SRU policy in item 4.1 in https://wiki.ubuntu.com/StableReleaseUpdates#Procedure.

Finally, once you are done, could you adjust the tasks for each series in this launchpad bug as suggested by Paride? Thanks!

[Julian Andres Klode (juliank)]

Unsubscribing ubuntu-sponsors, please resubscribe when you have new debdiff(s).

[Artur Pak (artur-at-work)]

For Mantic

[Artur Pak (artur-at-work)]

For Noble

[Artur Pak (artur-at-work)]

Thanks for the feedback, Athos.

Yes. I have changed to "noble".

I've adjusted the version in Mantic to avoid the conflict with Noble.

Target series were added by Andy Chi, because I don't have permissions of "UbuntuBugControl".

[Christian Ehrhardt  (paelzer)]

I got a ping on patch pilot duty, sadly on my ping back if they would be
available for questions if I find more that needs to be sorted out was
unanswered. So I need to carry all into this bug.

This is kind of a log of my own understanding process, feel free to ignore it:
Proposed change:
- It adds a few regex expressions to allow matching the new HW
- and then configuration for those new matches
- Accepted upstream
- Other than fixup releases Upstream seems to tag two releases per year, one in Q2 one in Q4
  - Due to that I'd this to be in a new revision v1.2.11 by May 2024
  - that might be worth to mention for packages to know when they will be able to drop it

Paride and Athos guided you to correctly obey the usual "fix -devel first" rule
and due to noble being new that you need to start there.

We are adding one particular device, but I see that due to having added
Ubuntu delta in the past we have not yet picked up 1.2.10 which would have
picked up plenty of other fixes and devices.
=> https://github.com/alsa-project/alsa-ucm-conf/releases/tag/v1.2.10

alsa-ucm-conf | 1.2.10-1 | unstable | source, all
alsa-ucm-conf | 1.2.9-1ubuntu3 | noble | source, all

The SRU fix is fine, those are meant to be surgical based on the need of our
users, but for noble it feels we should aim for 1.2.10 + this.
Checking who usually did that, ah Jürg and Ethan - fine we can ask them
for opinions as they might know the subject matter.

Great, so I'd propose we combine a merge of 1.2.10 with your fix on top.

[Christian Ehrhardt  (paelzer)]

Analyze for merge readiness:

The current delta is:
* d/p/0001-ucm2-Qualcomm-sc8280xp-fix-device-numbers.patch
* d/p/0001-acp63-add-initial-support-for-AMD-Pink-Sardine-ACP63.patch
* d/p/0002-acp63.conf-use-symbolic-link.patch
* d/p/0003-acp62-add-initial-support-for-AMD-ACP-v6.2-RPL.patch
=> Those are in 1.2.10 and can be dropped on a merge

* d/p/0001-Add-initial-support-for-MediaTek-mt8390-evk-and-mt83.patch
=> This is not upstream AFAICS
=> It does not have the dep-3 patch headers for Forwarded or Origin and
   sadly such moments trying to find what happened is just why they should
   always be added.
   This is a sin of the past and not your fault Artur, but your patch also
   misses those, so let me teach you about that ...

Learning links:
 - Standard for patch headers: https://dep-team.pages.debian.net/deps/dep3/
 - If you want it a bit more consumable https://github.com/canonical/ubuntu-maintainers-handbook/blob/a5a386be1be1507fbd1dd8842699b0758042169c/DebianPatch.md#the-patchfile-header

Also your git export is not of the hash that is in the final repository
Instead it is from the PR which might go away and is therefore harder to find.

And finally, no trace back from the patch to the bug that made it being added.

So overall your patch should ideally be like:
- use correct git hash
- add Origin
- add Applied-Upstream
- Add last-update

Which makes it start like:

From b422a8e08cb3845053ece1fc832294adca21a684 Mon Sep 17 00:00:00 2001
From: Shuming Fan <email address hidden>
Date: Thu, 12 Oct 2023 10:07:36 +0800
Subject: [PATCH] ucm2: soundwire: add rt713 SDCA device

Closes: https://github.com/alsa-project/alsa-ucm-conf/pull/363
Signed-off-by: Shuming Fan <email address hidden>
Signed-off-by: Jaroslav Kysela <email address hidden>

Origin: upstream, https://github.com/alsa-project/alsa-ucm-conf/commit/b422a8e08cb3845053ece1fc832294adca21a684
Bug: https://bugs.launchpad.net/ubuntu/+source/alsa-ucm-conf/+bug/2042902
Applied-Upstream: v1.2.11
Last-Update: 2023-11-24
---
...

I'll do that for you here for noble to make some progress, but you can still
fix this up for the SRU uploads.
It really would have helped if you'd have been available after you pinged
me on IRC. At the end of the day we want to teach, not just correct uploads.

[Christian Ehrhardt  (paelzer)]

I contacted Ethan who created the one patch I could not track down.
He had all the information that I needed:
- This is actually from
  - https://github.com/alsa-project/alsa-ucm-conf/pull/321
  - https://github.com/alsa-project/alsa-ucm-conf/pull/322
- related to private LP bug 2037058
- Not yet upstream accepted, but discussed with sil2100 and accepted
  as-is for now
- Ethan plans to file a public LP and update it once upstream accepted
  a final form of it

I'll put all of that into the patch headers to help the next person that
comes by.

[Christian Ehrhardt  (paelzer)]

I've created the merge of 1.2.10 by following [1], then re-added the patch
of Ethan and that of you Artur.

I hope I didn't add too many issues :-)
At least I'm sure I got this whole topic much forward.
The merge including all I mentioned can be seen here (As training material
for how this upload could have been for noble)
=> https://code.launchpad.net/~paelzer/ubuntu/+source/alsa-ucm-conf/+git/alsa-ucm-conf/+merge/456227

I tested the build in a PPA and while I couldn't test on much real HW (just a
super old NUC and I didn't fully know what to check - it had sound at least)
it is early enough in the noble cycle for you to have a look at that.
I hope that also is easier for you as you might be closer to HW to test.

And in general it seems 1.2.10 is the version for noble, as 1.2.11 would be
expected in ~May 2024. So the merge should have been done at some point.

[1]: https://github.com/canonical/ubuntu-maintainers-handbook/blob/main/PackageMerging.md

[Christian Ehrhardt  (paelzer)]

I hope the links and explanations added will help you in future uploads.

Even better, next time be available on IRC after the ping, but I understand
it might be rather late for you - so this isn't a complaint but a
recommendation.

The upload to noble should unblock you there, once you verified all is indeed
fine there you can update the SRU uploads accordingly (patch headers).

If you want to overachieve (=this is optional and depends how sure or not you
are), pre-build in PPAs and demonstrate you have tested it there successfully.

Then you can ping sponsors again to sponsor the uploads to -unapproved
for the SRU team to have a look.

[Christian Ehrhardt  (paelzer)]

For now https://launchpad.net/ubuntu/+source/alsa-ucm-conf/1.2.10-1ubuntu1 looks just as good as in my tests.

[Launchpad Janitor (janitor)]

This bug was fixed in the package alsa-ucm-conf - 1.2.10-1ubuntu1

---------------
alsa-ucm-conf (1.2.10-1ubuntu1) noble; urgency=medium

  * Merge with Debian unstable. Remaining changes:
    - d/p/0001-Add-initial-support-for-MediaTek-mt8390-evk-and-mt83.patch
      - add initial support for MediaTek mt8390-evk and mt8395-evk
        (LP: 2000228)
  * Dropped changes [all in upstream 1.2.10]:
    - d/p/0001-ucm2-Qualcomm-sc8280xp-fix-device-numbers.patch
      - ucm2: Qualcomm: sc8280xp: fix device numbers
        (LP: 2036731)
    - d/p/0001-acp63-add-initial-support-for-AMD-Pink-Sardine-ACP63.patch
      d/p/0002-acp63.conf-use-symbolic-link.patch
      d/p/0003-acp62-add-initial-support-for-AMD-ACP-v6.2-RPL.patch
       - Backport patches to add support AMD ACP RPL and Pink Sardine.
         (LP: 2025353)
  * Added changes
    - added headers and background info to
      d/p/0001-Add-initial-support-for-MediaTek-mt8390-evk-and-mt83.patch

  [Artur Pak]
  * d/p/0001-ucm2-soundwire-add-rt713-SDCA-device.patch:
    - Backport patch to add rt713 SDCA device
      (LP: #2042902)

 -- Christian Ehrhardt <email address hidden> Fri, 24 Nov 2023 09:12:05 +0100

[Artur Pak (artur-at-work)]

Thank you, @Christian. Appreciate you taking time to explain all these.
I will try to be on IRC next time.

I have changed the patch headers.
Then dput to my personal PPA and installed that package on laptop successfully.

https://launchpad.net/~artur-at-work/+archive/ubuntu/verification/+packages

Attaching below the updated files.

[Artur Pak (artur-at-work)]

for Lunar

[Artur Pak (artur-at-work)]

for Jammy

[Artur Pak (artur-at-work)]

for Mantic

[Gianfranco Costamagna (costamagnagianfranco)]

sponsored after removing one newline in jammy debdiff. There was an extra space in the patch, causing a different md5sum, and I prefer them to be bit bit identical across releases when possible.

find . -name 0001-ucm2-soundwire-add-rt713-SDCA-device.patch -exec md5sum {} \;
af9963b8a1d20d1b6c57ffdb690aefc0 ./jammy/debian/patches/0001-ucm2-soundwire-add-rt713-SDCA-device.patch
af9963b8a1d20d1b6c57ffdb690aefc0 ./lunar/debian/patches/0001-ucm2-soundwire-add-rt713-SDCA-device.patch
af9963b8a1d20d1b6c57ffdb690aefc0 ./mantic/debian/patches/0001-ucm2-soundwire-add-rt713-SDCA-device.patch

[Andreas Hasenack (ahasenack)]

@Artur,

a) you had a previous debdiff for mantic which used version 1.2.9-1ubuntu3.1, which is what we expect for an SRU to mantic, but now in the mantic unapproved queue I see that you changed the version to 1.2.9-1ubuntu4 again.

The upgrade path between ubuntu releases still works:
alsa-ucm-conf | 1.2.9-1ubuntu3 | mantic | source
alsa-ucm-conf | 1.2.9-1ubuntu4 | mantic/unapproved/9e381c3 | source
alsa-ucm-conf | 1.2.10-1ubuntu1 | noble | source

But since you were asked to change this once in comment #8, and did so in comment #10, I would ask that we stick to the correct version like you did before already :)

I could fix that for you, but I have other questions:

b) In the test plan:
> 1. $ alsactl init
> alsa-lib main.c:779:(execute_sequence) exec '/bin/rm -rf /var/lib/alsa/card0.conf.d' failed (exit code
> 1)

> (note: assuming that failed to remove the empty directory is not a critical problem)

First of all, thanks a lot for noticing this!

I checked the alsa-lib main.c:779 code in jammy, and it does cause that function to exit with an error. What implications that has to the rest of the initialization I'm not sure:

            if (ignore_error == false && err != 0) {
                uc_error("exec '%s' failed (exit code %d)", s->data.exec, err);
                goto __fail;
            }
...
      __fail:
    free(cdev);
    return err;

Did you get this error in all ubuntu releases with the patched package? What about on systems which do NOT have this particular audio card, but another one? I.e., would we regress those?

Whether it's a big problem or not, depends on who is calling alsactl init, and what they do when this command fails.

I briefly searched in alsa-lib where it would be asking for that rm -rf, but couldn't find it. I also checked git history, and didn't see relevant mentions of that.

Do you have a better idea of what's going on with that rm -rf, why it's being attempted on an empty directory, and if that's the case, why not ignore the error?

[Artur Pak (artur-at-work)]

hi @Andreas,
a) OK, I've changed version the to 1.2.9-1ubuntu3.1 and attaching the debdiff.
(I just thought it had to be changed since Noble's version was bumped, but happy to keep it)

b) The error was resolved by running with the sudo. After the directory was removed, it doesn't cause the error anymore (even if run without sudo).
Installing the package on other systems without this sound card works OK without errors.

[Gianfranco Costamagna (costamagnagianfranco)]

sponsored again.

[Timo Aaltonen (tjaalton)]

Hello Artur, or anyone else affected,

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

Hello Artur, or anyone else affected,

Accepted alsa-ucm-conf into lunar-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/alsa-ucm-conf/1.2.6.3-1ubuntu9.3 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)]

Hello Artur, or anyone else affected,

Accepted alsa-ucm-conf into jammy-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/alsa-ucm-conf/1.2.6.3-1ubuntu1.9 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.

[Artur Pak (artur-at-work)]

Below was performed to verify the -proposed package.

1. Reproduce the problem: used the same environment as in description
- downgrade the package to 1.2.6.3-1ubuntu1.8
- remove file: /var/lib/alsa/asound.state
- power off the machine (not reboot) and power up again
- verify no sound (play youtube)

2. Install jammy-proposed 1.2.6.3-1ubuntu1.9 and verify the same test cases as in description:
- sound can play
- $ sudo alsactl init - does not throw any errors
- $ amixer contents values=on

3. Power cycle and check if any regressions:
- power off and on again
- sound can play
- adjust sound lower/higher works
- $ sudo alsactl init - does not throw any errors

Same steps were performed for mantic-proposed 1.2.9-1ubuntu3.1 and lunar-proposed 1.2.6.3-1ubuntu9.3.

[Launchpad Janitor (janitor)]

This bug was fixed in the package alsa-ucm-conf - 1.2.9-1ubuntu3.1

---------------
alsa-ucm-conf (1.2.9-1ubuntu3.1) mantic; urgency=medium

  * d/p/0001-ucm2-soundwire-add-rt713-SDCA-device.patch:
    - Backport patch to add rt713 SDCA device (LP: #2042902)

 -- Artur Pak <email address hidden> Fri, 10 Nov 2023 13:08:57 +0800

[Brian Murray (brian-murray)]

The verification of the Stable Release Update for alsa-ucm-conf 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 alsa-ucm-conf - 1.2.6.3-1ubuntu1.9

---------------
alsa-ucm-conf (1.2.6.3-1ubuntu1.9) jammy; urgency=medium

  * d/p/0001-ucm2-soundwire-add-rt713-SDCA-device.patch:
    - Backport patch to add rt713 SDCA device (LP: #2042902)

 -- Artur Pak <email address hidden> Thu, 09 Nov 2023 17:48:20 +0800

[Launchpad Janitor (janitor)]

This bug was fixed in the package alsa-ucm-conf - 1.2.6.3-1ubuntu9.3

---------------
alsa-ucm-conf (1.2.6.3-1ubuntu9.3) lunar; urgency=medium

  * d/p/0001-ucm2-soundwire-add-rt713-SDCA-device.patch:
    - Backport patch to add rt713 SDCA device (LP: #2042902)

 -- Artur Pak <email address hidden> Fri, 10 Nov 2023 11:00:55 +0800