Skip to content

Commit 1604f51

Browse files
ivanorlov2206tiwai
authored andcommitted
ALSA: docs: Extend module parameters description
Common ALSA module parameters look a little bit confusing because of the description lacking, and it took me a while to understand the purpose of their existence. To figure it out I asked the question about them to the "alsa-devel" mailing list, and Takashi Iwai answered me with the text I appended to the ALSA documentation in this patch. These common module parameters aren't used a lot nowadays, but as I understand they are important for providing compatibility with some existing user-space apps. So in my opinion it is a good idea to document why we need them. Signed-off-by: Ivan Orlov <ivan.orlov0322@gmail.com> Link: https://lore.kernel.org/r/20230501101634.476297-1-ivan.orlov0322@gmail.com Signed-off-by: Takashi Iwai <tiwai@suse.de>
1 parent 7e2d066 commit 1604f51

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

Documentation/sound/alsa-configuration.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,19 @@ enable
133133
enable card;
134134
Default: enabled, for PCI and ISA PnP cards
135135

136+
These options are used for either specifying the order of instances or
137+
controlling enabling and disabling of each one of the devices if there
138+
are multiple devices bound with the same driver. For example, there are
139+
many machines which have two HD-audio controllers (one for HDMI/DP
140+
audio and another for onboard analog). In most cases, the second one is
141+
in primary usage, and people would like to assign it as the first
142+
appearing card. They can do it by specifying "index=1,0" module
143+
parameter, which will swap the assignment slots.
144+
145+
Today, with the sound backend like PulseAudio and PipeWire which
146+
supports dynamic configuration, it's of little use, but that was a
147+
help for static configuration in the past.
148+
136149
Module snd-adlib
137150
----------------
138151

0 commit comments

Comments
 (0)