summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorTanu Kaskinen <tanu.kaskinen@linux.intel.com>2015-03-05 14:51:58 +0200
committerTakashi Iwai <tiwai@suse.de>2015-03-05 14:24:10 +0100
commitecb38d2bec72a9fbb171e2e89816301d3451c8d3 (patch)
tree1d662727eb8171d5b777c1e382c973d3288fa36a /include
parent72aa0f8332fb945c4179450f65402ce1cb389594 (diff)
ucm: improve jack configuration documentationHEADmaster
Signed-off-by: Tanu Kaskinen <tanu.kaskinen@linux.intel.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'include')
-rw-r--r--include/use-case.h24
1 files changed, 18 insertions, 6 deletions
diff --git a/include/use-case.h b/include/use-case.h
index d3095224..e3308b17 100644
--- a/include/use-case.h
+++ b/include/use-case.h
@@ -301,12 +301,24 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
* - name of capture mixer
* - CaptureMixerID
* - mixer capture ID
- * - JackDev
- * - jack device name
- * - JackControl
- * - jack control name
- * - JackHWMute
- * - indicate if the HW mutes a device on jack insertion or not.
+ * - JackControl, JackDev, JackHWMute
+ * - Jack information for a device. The jack status can be reported via
+ * a kcontrol and/or via an input device. **JackControl** is the
+ * kcontrol name of the jack, and **JackDev** is the input device id of
+ * the jack (if the full input device path is /dev/input/by-id/foo, the
+ * JackDev value should be "foo"). UCM configuration files should
+ * contain both JackControl and JackDev when possible, because
+ * applications are likely to support only one or the other.
+ *
+ * If **JackHWMute** is set, it indicates that when the jack is plugged
+ * in, the hardware automatically mutes some other device. The
+ * JackHWMute value is the name of the muted device. Note that
+ * JackHWMute should be used only when the hardware enforces the
+ * automatic muting. If the hardware doesn't enforce any muting, it may
+ * still be tempting to set JackHWMute to trick upper software layers to
+ * e.g. automatically mute speakers when headphones are plugged in, but
+ * that's application policy configuration that doesn't belong to UCM
+ * configuration files.
*/
int snd_use_case_get(snd_use_case_mgr_t *uc_mgr,
const char *identifier,