diff mbox

ALSA: Update control names documentation

Message ID 1413808689-4175-1-git-send-email-david.henningsson@canonical.com (mailing list archive)
State Accepted
Delegated to: Takashi Iwai
Headers show

Commit Message

David Henningsson Oct. 20, 2014, 12:38 p.m. UTC
This document was not really up-to-date. Add recent additions to this
standard - based on what the HDA driver currently does, which is some
kind of a de facto standard.

Signed-off-by: David Henningsson <david.henningsson@canonical.com>
---
 Documentation/sound/alsa/ControlNames.txt | 32 ++++++++++++++++++++++++++-----
 1 file changed, 27 insertions(+), 5 deletions(-)

Comments

Takashi Iwai Oct. 20, 2014, 1:38 p.m. UTC | #1
At Mon, 20 Oct 2014 14:38:09 +0200,
David Henningsson wrote:
> 
> This document was not really up-to-date. Add recent additions to this
> standard - based on what the HDA driver currently does, which is some
> kind of a de facto standard.
> 
> Signed-off-by: David Henningsson <david.henningsson@canonical.com>

Looks god to me as a start.  Applied to for-next branch now.


thanks,

Takashi


> ---
>  Documentation/sound/alsa/ControlNames.txt | 32 ++++++++++++++++++++++++++-----
>  1 file changed, 27 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/sound/alsa/ControlNames.txt b/Documentation/sound/alsa/ControlNames.txt
> index fea65bb..79a6127 100644
> --- a/Documentation/sound/alsa/ControlNames.txt
> +++ b/Documentation/sound/alsa/ControlNames.txt
> @@ -1,6 +1,6 @@
>  This document describes standard names of mixer controls.
>  
> -Syntax: SOURCE [DIRECTION] FUNCTION
> +Syntax: [LOCATION] SOURCE [CHANNEL] [DIRECTION] FUNCTION
>  
>  DIRECTION:
>    <nothing>	(both directions)
> @@ -14,12 +14,29 @@ FUNCTION:
>    Volume
>    Route		(route control, hardware specific)
>  
> +CHANNEL:
> +  <nothing>     (channel independent, or applies to all channels)
> +  Front
> +  Surround      (rear left/right in 4.0/5.1 surround)
> +  CLFE
> +  Center
> +  LFE
> +  Side          (side left/right for 7.1 surround)
> +
> +LOCATION:       (physical location of source)
> +  Front
> +  Rear
> +  Dock          (docking station)
> +  Internal
> +
>  SOURCE:
>    Master
>    Master Mono
>    Hardware Master
>    Speaker	(internal speaker)
> +  Bass Speaker	(internal LFE speaker)
>    Headphone
> +  Line Out
>    Beep		(beep generator)
>    Phone
>    Phone Input
> @@ -27,14 +44,14 @@ SOURCE:
>    Synth
>    FM
>    Mic
> -  Line
> +  Headset Mic	(mic part of combined headset jack - 4-pin headphone + mic)
> +  Headphone Mic	(mic part of either/or - 3-pin headphone or mic)
> +  Line		(input only, use "Line Out" for output)
>    CD
>    Video
>    Zoom Video
>    Aux
>    PCM
> -  PCM Front
> -  PCM Rear
>    PCM Pan
>    Loopback
>    Analog Loopback	(D/A -> A/D loopback)
> @@ -47,8 +64,13 @@ SOURCE:
>    Music
>    I2S
>    IEC958
> +  HDMI
> +  SPDIF		(output only)
> +  SPDIF In
> +  Digital In
> +  HDMI/DP	(either HDMI or DisplayPort)
>  
> -Exceptions:
> +Exceptions (deprecated):
>    [Digital] Capture Source
>    [Digital] Capture Switch	(aka input gain switch)
>    [Digital] Capture Volume	(aka input gain volume)
> -- 
> 1.9.1
>
Raymond Yau Oct. 20, 2014, 11:46 p.m. UTC | #2
>
> This document was not really up-to-date. Add recent additions to this
> standard - based on what the HDA driver currently does, which is some
> kind of a de facto standard.
>

Is it feasible to remove "Hardware Master" if no alsa driver use this name ?

>
>
> diff --git a/Documentation/sound/alsa/ControlNames.txt
b/Documentation/sound/alsa/ControlNames.txt
> index fea65bb..79a6127 100644
> --- a/Documentation/sound/alsa/ControlNames.txt
> +++ b/Documentation/sound/alsa/ControlNames.txt
> @@ -1,6 +1,6 @@
>  This document describes standard names of mixer controls.
>
> -Syntax: SOURCE [DIRECTION] FUNCTION
> +Syntax: [LOCATION] SOURCE [CHANNEL] [DIRECTION] FUNCTION
>

>    Hardware Master
David Henningsson Oct. 21, 2014, 3:38 a.m. UTC | #3
On 2014-10-21 01:46, Raymond Yau wrote:
>
>  >
>  > This document was not really up-to-date. Add recent additions to this
>  > standard - based on what the HDA driver currently does, which is some
>  > kind of a de facto standard.
>  >
>
> Is it feasible to remove "Hardware Master" if no alsa driver use this name ?

I believe so, it's kind of a bad name anyway. Feel free to send a patch.
diff mbox

Patch

diff --git a/Documentation/sound/alsa/ControlNames.txt b/Documentation/sound/alsa/ControlNames.txt
index fea65bb..79a6127 100644
--- a/Documentation/sound/alsa/ControlNames.txt
+++ b/Documentation/sound/alsa/ControlNames.txt
@@ -1,6 +1,6 @@ 
 This document describes standard names of mixer controls.
 
-Syntax: SOURCE [DIRECTION] FUNCTION
+Syntax: [LOCATION] SOURCE [CHANNEL] [DIRECTION] FUNCTION
 
 DIRECTION:
   <nothing>	(both directions)
@@ -14,12 +14,29 @@  FUNCTION:
   Volume
   Route		(route control, hardware specific)
 
+CHANNEL:
+  <nothing>     (channel independent, or applies to all channels)
+  Front
+  Surround      (rear left/right in 4.0/5.1 surround)
+  CLFE
+  Center
+  LFE
+  Side          (side left/right for 7.1 surround)
+
+LOCATION:       (physical location of source)
+  Front
+  Rear
+  Dock          (docking station)
+  Internal
+
 SOURCE:
   Master
   Master Mono
   Hardware Master
   Speaker	(internal speaker)
+  Bass Speaker	(internal LFE speaker)
   Headphone
+  Line Out
   Beep		(beep generator)
   Phone
   Phone Input
@@ -27,14 +44,14 @@  SOURCE:
   Synth
   FM
   Mic
-  Line
+  Headset Mic	(mic part of combined headset jack - 4-pin headphone + mic)
+  Headphone Mic	(mic part of either/or - 3-pin headphone or mic)
+  Line		(input only, use "Line Out" for output)
   CD
   Video
   Zoom Video
   Aux
   PCM
-  PCM Front
-  PCM Rear
   PCM Pan
   Loopback
   Analog Loopback	(D/A -> A/D loopback)
@@ -47,8 +64,13 @@  SOURCE:
   Music
   I2S
   IEC958
+  HDMI
+  SPDIF		(output only)
+  SPDIF In
+  Digital In
+  HDMI/DP	(either HDMI or DisplayPort)
 
-Exceptions:
+Exceptions (deprecated):
   [Digital] Capture Source
   [Digital] Capture Switch	(aka input gain switch)
   [Digital] Capture Volume	(aka input gain volume)