diff mbox series

ASoC: core: Change device numbering

Message ID 20250127144445.2739017-1-amadeuszx.slawinski@linux.intel.com (mailing list archive)
State New
Headers show
Series ASoC: core: Change device numbering | expand

Commit Message

Amadeusz Sławiński Jan. 27, 2025, 2:44 p.m. UTC
Currently ASoC cards when enumerating create CPUs rtds first and CODECs
rtds second. This causes device number on cards to not start from 0, but
from number of present CPUs. During that it does count number of rtds
and uses it as device number visible in userspace.

This patch changes device visible to userspace, when listing cards:

Before:
card 0: hdaudioB0D0 [hdaudioB0D0], device 1: HDAudio Analog (*) []
card 1: hdaudioB0D2 [hdaudioB0D2], device 1: HDMI1 (*) []
card 1: hdaudioB0D2 [hdaudioB0D2], device 2: HDMI2 (*) []
card 1: hdaudioB0D2 [hdaudioB0D2], device 3: HDMI3 (*) []

After:
card 0: hdaudioB0D0 [hdaudioB0D0], device 0: HDAudio Analog (*) []
card 1: hdaudioB0D2 [hdaudioB0D2], device 0: HDMI1 (*) []
card 1: hdaudioB0D2 [hdaudioB0D2], device 1: HDMI2 (*) []
card 1: hdaudioB0D2 [hdaudioB0D2], device 2: HDMI3 (*) []

It is done by skipping back end devices and only counting front end
ones.

Now there are few concerns I have:
- while rtd->id is not used much, few drivers seem to be using it as
  index into a table, above may break this use (although
  "include/sound/simple_card_utils.h: * the ID stored in rtd->id may not be a valid array index."
  suggests that maybe it is a bad idea anyway, but I'm not sure how
  generic that comment is)
- this will break user scripts, with hardcoded device IDs
- this will also break some UCMs with hardcoded IDs

Now my main question is, if such patch would even be considered?
Perhaps device IDs are not considered as "stable" interface and can be
changed and my above worries are unnecessary.

Patch is a result of discussion from:
https://github.com/alsa-project/alsa-ucm-conf/pull/499
and as such I may consider others ways of fixing the problem.
---
 sound/soc/soc-core.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Amadeusz Sławiński Jan. 27, 2025, 2:45 p.m. UTC | #1
On 1/27/2025 3:44 PM, Amadeusz Sławiński wrote:
> Currently ASoC cards when enumerating create CPUs rtds first and CODECs
> rtds second. This causes device number on cards to not start from 0, but
> from number of present CPUs. During that it does count number of rtds
> and uses it as device number visible in userspace.
> 
> This patch changes device visible to userspace, when listing cards:
> 
> Before:
> card 0: hdaudioB0D0 [hdaudioB0D0], device 1: HDAudio Analog (*) []
> card 1: hdaudioB0D2 [hdaudioB0D2], device 1: HDMI1 (*) []
> card 1: hdaudioB0D2 [hdaudioB0D2], device 2: HDMI2 (*) []
> card 1: hdaudioB0D2 [hdaudioB0D2], device 3: HDMI3 (*) []
> 
> After:
> card 0: hdaudioB0D0 [hdaudioB0D0], device 0: HDAudio Analog (*) []
> card 1: hdaudioB0D2 [hdaudioB0D2], device 0: HDMI1 (*) []
> card 1: hdaudioB0D2 [hdaudioB0D2], device 1: HDMI2 (*) []
> card 1: hdaudioB0D2 [hdaudioB0D2], device 2: HDMI3 (*) []
> 
> It is done by skipping back end devices and only counting front end
> ones.
> 
> Now there are few concerns I have:
> - while rtd->id is not used much, few drivers seem to be using it as
>    index into a table, above may break this use (although
>    "include/sound/simple_card_utils.h: * the ID stored in rtd->id may not be a valid array index."
>    suggests that maybe it is a bad idea anyway, but I'm not sure how
>    generic that comment is)
> - this will break user scripts, with hardcoded device IDs
> - this will also break some UCMs with hardcoded IDs
> 
> Now my main question is, if such patch would even be considered?
> Perhaps device IDs are not considered as "stable" interface and can be
> changed and my above worries are unnecessary.
> 
> Patch is a result of discussion from:
> https://github.com/alsa-project/alsa-ucm-conf/pull/499
> and as such I may consider others ways of fixing the problem.

And it should've been RFC in topic... :( Sorry about that.
Jaroslav Kysela Jan. 27, 2025, 2:54 p.m. UTC | #2
On 27. 01. 25 15:45, Amadeusz Sławiński wrote:
> On 1/27/2025 3:44 PM, Amadeusz Sławiński wrote:
>> Currently ASoC cards when enumerating create CPUs rtds first and CODECs
>> rtds second. This causes device number on cards to not start from 0, but
>> from number of present CPUs. During that it does count number of rtds
>> and uses it as device number visible in userspace.
>>
>> This patch changes device visible to userspace, when listing cards:
>>
>> Before:
>> card 0: hdaudioB0D0 [hdaudioB0D0], device 1: HDAudio Analog (*) []
>> card 1: hdaudioB0D2 [hdaudioB0D2], device 1: HDMI1 (*) []
>> card 1: hdaudioB0D2 [hdaudioB0D2], device 2: HDMI2 (*) []
>> card 1: hdaudioB0D2 [hdaudioB0D2], device 3: HDMI3 (*) []
>>
>> After:
>> card 0: hdaudioB0D0 [hdaudioB0D0], device 0: HDAudio Analog (*) []
>> card 1: hdaudioB0D2 [hdaudioB0D2], device 0: HDMI1 (*) []
>> card 1: hdaudioB0D2 [hdaudioB0D2], device 1: HDMI2 (*) []
>> card 1: hdaudioB0D2 [hdaudioB0D2], device 2: HDMI3 (*) []
>>
>> It is done by skipping back end devices and only counting front end
>> ones.
>>
>> Now there are few concerns I have:
>> - while rtd->id is not used much, few drivers seem to be using it as
>>     index into a table, above may break this use (although
>>     "include/sound/simple_card_utils.h: * the ID stored in rtd->id may not be a valid array index."
>>     suggests that maybe it is a bad idea anyway, but I'm not sure how
>>     generic that comment is)
>> - this will break user scripts, with hardcoded device IDs
>> - this will also break some UCMs with hardcoded IDs
>>
>> Now my main question is, if such patch would even be considered?
>> Perhaps device IDs are not considered as "stable" interface and can be
>> changed and my above worries are unnecessary.
>>
>> Patch is a result of discussion from:
>> https://github.com/alsa-project/alsa-ucm-conf/pull/499
>> and as such I may consider others ways of fixing the problem.
> 
> And it should've been RFC in topic... :( Sorry about that.

Looking to UCM configs, most of ASoC cards have PCM devices starting from 
zero. So this id is not used for all ASoC cards.

Also, a bit off-topic, but the driver name (hdaudioB?D?) for this particular 
driver should be corrected, too. It should be like 'hda-avs-dsp' or so. If I 
am not wrong, the SST driver name was 'hda-dsp'.

					Jaroslav
Cezary Rojewski Jan. 29, 2025, 9:25 a.m. UTC | #3
On 2025-01-27 3:54 PM, Jaroslav Kysela wrote:
> On 27. 01. 25 15:45, Amadeusz Sławiński wrote:
>> On 1/27/2025 3:44 PM, Amadeusz Sławiński wrote:
>>> Currently ASoC cards when enumerating create CPUs rtds first and CODECs
>>> rtds second. This causes device number on cards to not start from 0, but
>>> from number of present CPUs. During that it does count number of rtds
>>> and uses it as device number visible in userspace.
>>>
>>> This patch changes device visible to userspace, when listing cards:
>>>
>>> Before:
>>> card 0: hdaudioB0D0 [hdaudioB0D0], device 1: HDAudio Analog (*) []
>>> card 1: hdaudioB0D2 [hdaudioB0D2], device 1: HDMI1 (*) []
>>> card 1: hdaudioB0D2 [hdaudioB0D2], device 2: HDMI2 (*) []
>>> card 1: hdaudioB0D2 [hdaudioB0D2], device 3: HDMI3 (*) []
>>>
>>> After:
>>> card 0: hdaudioB0D0 [hdaudioB0D0], device 0: HDAudio Analog (*) []
>>> card 1: hdaudioB0D2 [hdaudioB0D2], device 0: HDMI1 (*) []
>>> card 1: hdaudioB0D2 [hdaudioB0D2], device 1: HDMI2 (*) []
>>> card 1: hdaudioB0D2 [hdaudioB0D2], device 2: HDMI3 (*) []
>>>
>>> It is done by skipping back end devices and only counting front end
>>> ones.
>>>
>>> Now there are few concerns I have:
>>> - while rtd->id is not used much, few drivers seem to be using it as
>>>     index into a table, above may break this use (although
>>>     "include/sound/simple_card_utils.h: * the ID stored in rtd->id 
>>> may not be a valid array index."
>>>     suggests that maybe it is a bad idea anyway, but I'm not sure how
>>>     generic that comment is)
>>> - this will break user scripts, with hardcoded device IDs
>>> - this will also break some UCMs with hardcoded IDs
>>>
>>> Now my main question is, if such patch would even be considered?
>>> Perhaps device IDs are not considered as "stable" interface and can be
>>> changed and my above worries are unnecessary.
>>>
>>> Patch is a result of discussion from:
>>> https://github.com/alsa-project/alsa-ucm-conf/pull/499
>>> and as such I may consider others ways of fixing the problem.
>>
>> And it should've been RFC in topic... :( Sorry about that.
> 
> Looking to UCM configs, most of ASoC cards have PCM devices starting 
> from zero. So this id is not used for all ASoC cards.

Most of the ASoC does not utilize topology and there is no strict 
guideline: initialize FE first, BE last. What Amadeusz proposes is to 
skip BEs when counting the 'devices' for the userspace as these are not 
touchable by them anyway. I believe this is a good direction and does 
not limit one's action when playing with the ASoC-topology feature.

> Also, a bit off-topic, but the driver name (hdaudioB?D?) for this 
> particular driver should be corrected, too. It should be like 'hda-avs- 
> dsp' or so. If I am not wrong, the SST driver name was 'hda-dsp'.

We had a discussion or two within the team and yes, we do agree that a 
more user-friendly pattern should be provided. Currently card names are 
mostly based on machine board device (platform_device) name. There is no 
strong technical argument for that - the development was/is simply 
focused on bringing new functionality and we did not prioritize the card 
naming.

The task touches all interfaces though, not just HDA. We would like to 
streamline or fix the naming for all the interfaces. This time we will 
specifically request a review for that : )


Kind regards,
Czarek
Amadeusz Sławiński Jan. 29, 2025, 2:51 p.m. UTC | #4
On 1/29/2025 10:25 AM, Cezary Rojewski wrote:
> On 2025-01-27 3:54 PM, Jaroslav Kysela wrote:
>> On 27. 01. 25 15:45, Amadeusz Sławiński wrote:
>>> On 1/27/2025 3:44 PM, Amadeusz Sławiński wrote:
>>>> Currently ASoC cards when enumerating create CPUs rtds first and CODECs
>>>> rtds second. This causes device number on cards to not start from 0, 
>>>> but
>>>> from number of present CPUs. During that it does count number of rtds
>>>> and uses it as device number visible in userspace.
>>>>
>>>> This patch changes device visible to userspace, when listing cards:
>>>>
>>>> Before:
>>>> card 0: hdaudioB0D0 [hdaudioB0D0], device 1: HDAudio Analog (*) []
>>>> card 1: hdaudioB0D2 [hdaudioB0D2], device 1: HDMI1 (*) []
>>>> card 1: hdaudioB0D2 [hdaudioB0D2], device 2: HDMI2 (*) []
>>>> card 1: hdaudioB0D2 [hdaudioB0D2], device 3: HDMI3 (*) []
>>>>
>>>> After:
>>>> card 0: hdaudioB0D0 [hdaudioB0D0], device 0: HDAudio Analog (*) []
>>>> card 1: hdaudioB0D2 [hdaudioB0D2], device 0: HDMI1 (*) []
>>>> card 1: hdaudioB0D2 [hdaudioB0D2], device 1: HDMI2 (*) []
>>>> card 1: hdaudioB0D2 [hdaudioB0D2], device 2: HDMI3 (*) []
>>>>
>>>> It is done by skipping back end devices and only counting front end
>>>> ones.
>>>>
>>>> Now there are few concerns I have:
>>>> - while rtd->id is not used much, few drivers seem to be using it as
>>>>     index into a table, above may break this use (although
>>>>     "include/sound/simple_card_utils.h: * the ID stored in rtd->id 
>>>> may not be a valid array index."
>>>>     suggests that maybe it is a bad idea anyway, but I'm not sure how
>>>>     generic that comment is)
>>>> - this will break user scripts, with hardcoded device IDs
>>>> - this will also break some UCMs with hardcoded IDs
>>>>
>>>> Now my main question is, if such patch would even be considered?
>>>> Perhaps device IDs are not considered as "stable" interface and can be
>>>> changed and my above worries are unnecessary.
>>>>
>>>> Patch is a result of discussion from:
>>>> https://github.com/alsa-project/alsa-ucm-conf/pull/499
>>>> and as such I may consider others ways of fixing the problem.
>>>
>>> And it should've been RFC in topic... :( Sorry about that.
>>
>> Looking to UCM configs, most of ASoC cards have PCM devices starting 
>> from zero. So this id is not used for all ASoC cards.
> 
> Most of the ASoC does not utilize topology and there is no strict 
> guideline: initialize FE first, BE last. What Amadeusz proposes is to 
> skip BEs when counting the 'devices' for the userspace as these are not 
> touchable by them anyway. I believe this is a good direction and does 
> not limit one's action when playing with the ASoC-topology feature.
> 

And it seems that apparently other topology users set .use_dai_pcm_id in 
struct snd_soc_component_driver. Which tells the code to use PCM ID 
values from topology as device IDs. Although the more I look at this the 
more this looks to be a workaround due to how ASoC counts devices, which 
this RFC fixes. But at least for now we are also looking to set this 
flag, as to avoid potentially impacting ASoC core.

>> Also, a bit off-topic, but the driver name (hdaudioB?D?) for this 
>> particular driver should be corrected, too. It should be like 'hda- 
>> avs- dsp' or so. If I am not wrong, the SST driver name was 'hda-dsp'.
> 
> We had a discussion or two within the team and yes, we do agree that a 
> more user-friendly pattern should be provided. Currently card names are 
> mostly based on machine board device (platform_device) name. There is no 
> strong technical argument for that - the development was/is simply 
> focused on bringing new functionality and we did not prioritize the card 
> naming.
> 
> The task touches all interfaces though, not just HDA. We would like to 
> streamline or fix the naming for all the interfaces. This time we will 
> specifically request a review for that : )

And we had yet another discussion today ;) Are there some guidelines 
upstream, about how cards should be named? Currently we need names for: 
HDA, HDMI, DMIC & I2S cards. Here are examples from running systems:
HDA:
card 0: hdaudioB0D0 [hdaudioB0D0], device 1: HDAudio Analog (*) []
HDMI:
card 1: hdaudioB0D2 [hdaudioB0D2], device 1: HDMI 0 (*) []
DMIC:
card 2: avsdmic [avs_dmic], device 2: Digital Microphone (*) []
I2S:
card 3: avsrt274 [avs_rt274], device 1: Audio (*) []

Additionally is there a way to alias card name? We would like to still 
allow users to use current names, to keep backward compatibility at 
least for some time.
diff mbox series

Patch

diff --git a/sound/soc/soc-core.c b/sound/soc/soc-core.c
index 3c6d8aef41309..ba257396b2063 100644
--- a/sound/soc/soc-core.c
+++ b/sound/soc/soc-core.c
@@ -558,7 +558,8 @@  static struct snd_soc_pcm_runtime *soc_new_pcm_runtime(
 	 */
 	rtd->card	= card;
 	rtd->dai_link	= dai_link;
-	rtd->id		= card->num_rtd++;
+	if (!rtd->dai_link->no_pcm)
+		rtd->id		= card->num_rtd++;
 	rtd->pmdown_time = pmdown_time;			/* default power off timeout */
 
 	/* see for_each_card_rtds */