Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
ALSA: doc: Clarify IEC958 controls iface
The doc currently mentions that the IEC958 Playback Default should be
exposed on the PCM iface, and the Playback Mask on the mixer iface.
It's a bit confusing to advise to have two related controls on two
separate ifaces, and it looks like the drivers that currently expose
those controls use any combination of the mixer and PCM ifaces.
Let's try to clarify the situation a bit, and encourage to at least have
the controls on the same iface.
Signed-off-by: Maxime Ripard <maxime@cerno.tech>
Reviewed-by: Takashi Iwai <tiwai@suse.de>
Link: https://lore.kernel.org/r/20210525132354.297468-2-maxime@cerno.tech
+7
-6
+7
-6
Documentation/sound/kernel-api/writing-an-alsa-driver.rst
+7
-6
Documentation/sound/kernel-api/writing-an-alsa-driver.rst
···
3508
3508
3509
3509
“IEC958 Playback Con Mask” is used to return the bit-mask for the IEC958
3510
3510
status bits of consumer mode. Similarly, “IEC958 Playback Pro Mask”
3511
-
returns the bitmask for professional mode. They are read-only controls,
3512
-
and are defined as MIXER controls (iface =
3513
-
``SNDRV_CTL_ELEM_IFACE_MIXER``).
3511
+
returns the bitmask for professional mode. They are read-only controls.
3514
3512
3515
3513
Meanwhile, “IEC958 Playback Default” control is defined for getting and
3516
-
setting the current default IEC958 bits. Note that this one is usually
3517
-
defined as a PCM control (iface = ``SNDRV_CTL_ELEM_IFACE_PCM``),
3518
-
although in some places it's defined as a MIXER control.
3514
+
setting the current default IEC958 bits.
3515
+
3516
+
Due to historical reasons, both variants of the Playback Mask and the
3517
+
Playback Default controls can be implemented on either a
3518
+
``SNDRV_CTL_ELEM_IFACE_PCM`` or a ``SNDRV_CTL_ELEM_IFACE_MIXER`` iface.
3519
+
Drivers should expose the mask and default on the same iface though.
3519
3520
3520
3521
In addition, you can define the control switches to enable/disable or to
3521
3522
set the raw bit mode. The implementation will depend on the chip, but