[SRU] the input volume of external mic for sof driver is 0 by default

[Hui Wang]

The change of this SRU has been squashed to https://bugs.launchpad.net/ubuntu/+source/alsa-ucm-conf/+bug/1937980.

[Impact]
For the machines with sof audio driver, after we freshly install the ubuntu linux and plug a microphone or headset-mic to the audio jack, we can't record sound through them since the default input volume is 0, users need to adjust the input volume to non-zero manually, then could record sound successfully.

[Fix]
Backport 1 patch (https://github.com/alsa-project/alsa-ucm-conf/pull/107), after applying the patch, the ucm will set the 'Capture Switch' to on in the bootsequence, and set the Capture volume to 60%, then users could record sound without manually adjust the input volume.

[Test]
sudo rm /var/lib/alsa/*; rm ~/.config/pulse/*; alsactl init; reboot, plug a headset to the audio jack, use the headset-mic to record the sound, it could record successfully.

[Where problems will occur]
This SRU changes the Capture Switch and Capture Volume in the ucm, this could make the whole ucm can't be parsed if the syntax is not correct, then the whole audio will fail to work like audio jack can't detect plugin/plugout and the internal mic can't be found. But this regression possibility is very low since we already tested the change on lenovo and Dell machines, all worked well.

[Hui Wang (hui.wang)]

the debdiff of this SRU has been squashed to https://bugs.launchpad.net/ubuntu/+source/alsa-ucm-conf/+bug/1937980.

[Hui Wang (hui.wang)]

The https://github.com/alsa-project/alsa-ucm-conf/pull/107 was merged to upstream last night.

[Launchpad Janitor (janitor)]

This bug was fixed in the package alsa-ucm-conf - 1.2.4-2ubuntu4

---------------
alsa-ucm-conf (1.2.4-2ubuntu4) impish; urgency=medium

  * d/p/0006-sof-soundwire-rt1316-DAC-L-and-R-is-replaced-by-DAC.patch
    The mixer name is changed in the codec driver rt1316-sdw.c, so need
    to handle the new mixer name.
    https://github.com/alsa-project/alsa-ucm-conf/pull/109
    (LP: #1937980)
  * d/p/0007-sof-hda-dsp-Set-Capture-Switch-on-in-the-BootSequenc.patch
    The input volume of the external microphone is 0 by default for all
    machines with sof audio driver, that is because the capture switch
    is set to off by default, need to set it to on in the ucm.
    https://github.com/alsa-project/alsa-ucm-conf/pull/107
    (LP: #1940788)

 -- Hui Wang <email address hidden> Mon, 23 Aug 2021 10:36:38 +0800

[Łukasz Zemczak (sil2100)]

Hello Hui, or anyone else affected,

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

[Łukasz Zemczak (sil2100)]

Hello Hui, or anyone else affected,

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

[Hui Wang (hui.wang)]

For hirsute:

On a Dell and a Lenovo machine which run the sof audio driver,
enable hirsute-proposed in the /etc/apt/sources.list
apt-get update
apt install alsa-ucm-conf, now the alsa-ucm-conf all 1.2.4-2ubuntu1.3 is installed.
sudo rm /var/lib/alsa/*; rm ~/.config/pulse/*;alsactl init; reboot machine
After the system boots up, check the internal dmic status from gnome-sound-setting, it is not muted, and run arecord test.wav, could record the sound via internal dmic successfully.

Verification done for hirsute.

[Hui Wang (hui.wang)]

For focal:

On a Dell and a Lenovo machine which run the sof audio driver,
enable focal-proposed in the /etc/apt/sources.list
apt-get update
apt install alsa-ucm-conf, now the alsa-ucm-conf 1.2.2-1ubuntu0.10 is installed.
sudo rm /var/lib/alsa/*; rm ~/.config/pulse/*;alsactl init; reboot machine
After the system boots up, check the internal dmic status from gnome-sound-setting, it is not muted, and run arecord test.wav, could record the sound via internal dmic successfully.

Verification done for focal.

[Launchpad Janitor (janitor)]

This bug was fixed in the package alsa-ucm-conf - 1.2.4-2ubuntu1.3

---------------
alsa-ucm-conf (1.2.4-2ubuntu1.3) hirsute; urgency=medium

  * d/p/0005-sof-soundwire-rt1316-DAC-L-and-R-is-replaced-by-DAC.patch
    The mixer name is changed in the codec driver rt1316-sdw.c, so need
    to handle the new mixer name.
    https://github.com/alsa-project/alsa-ucm-conf/pull/109
    (LP: #1937980)
  * d/p/0006-sof-hda-dsp-Set-Capture-Switch-on-in-the-BootSequenc.patch
    The input volume of the external microphone is 0 by default for all
    machines with sof audio driver, that is because the capture switch
    is set to off by default, need to set it to on in the ucm.
    https://github.com/alsa-project/alsa-ucm-conf/pull/107
    (LP: #1940788)

 -- Hui Wang <email address hidden> Mon, 23 Aug 2021 10:05:50 +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.2-1ubuntu0.10

---------------
alsa-ucm-conf (1.2.2-1ubuntu0.10) focal; urgency=medium

  * d/p/0031-sof-soundwire-rt1316-DAC-L-and-R-is-replaced-by-DAC.patch
    The mixer name is changed in the codec driver rt1316-sdw.c, so need
    to handle the new mixer name.
    https://github.com/alsa-project/alsa-ucm-conf/pull/109
    (LP: #1937980)
  * d/p/0032-sof-hda-dsp-Set-Capture-Switch-on-in-the-BootSequenc.patch
    The input volume of the external microphone is 0 by default for all
    machines with sof audio driver, that is because the capture switch
    is set to off by default, need to set it to on in the ucm.
    https://github.com/alsa-project/alsa-ucm-conf/pull/107
    (LP: #1940788)

 -- Hui Wang <email address hidden> Mon, 23 Aug 2021 11:00:48 +0800