alsa/0005-ucm-improve-jack-configuration-documentation.patch
Takashi Iwai e8e74453bd Accepting request 308371 from home:tiwai:branches:multimedia:libs
- Backport upstream fixes: UCM updates, Broadwell UCM support,
  namehint fixes, fix faulty assert in PCM plugins, etc:
  0001-ucm-document-some-standard-values.patch
  0002-conf-ucm-broadwell-rt286-add-ucm-config.patch
  0003-conf-ucm-Add-Makefile.am-for-broadwell-rt286-ucm-con.patch
  0004-ucm-reformat-snd_use_case_get-doc.patch
  0005-ucm-improve-jack-configuration-documentation.patch
  0006-USB-audio-Sound-Blaster-HD-iec958-is-on-device-1.patch
  0007-Sync-include-sound-asound.h-with-4.1-kernel.patch
  0008-conf-ucm-broadwell-rt286-change-to-use-the-correct-j.patch
  0009-namehint-Fix-invalid-list-access-in-snd_device_name_.patch
  0010-namehint-Fix-the-listing-without-device-number.patch
  0011-namehint-Fix-bad-free-with-invalid-iface-name.patch
  0012-Allow-hint-for-ctl-hwdep-timer-and-seq.patch
  0013-conf-Add-hint-descriptions-to-ctl-hwdep-seq-and-time.patch
  0014-conf-ucm-broadwell-rt286-change-to-set-capture-volum.patch
  0015-ucm-allow-multiple-devices-in-JackHWMute.patch
  0016-pcm-Remove-assert-from-snd_pcm_hw_params_slave.patch

OBS-URL: https://build.opensuse.org/request/show/308371
OBS-URL: https://build.opensuse.org/package/show/multimedia:libs/alsa?expand=0&rev=181
2015-05-22 12:33:18 +00:00

50 lines
2.2 KiB
Diff

From ecb38d2bec72a9fbb171e2e89816301d3451c8d3 Mon Sep 17 00:00:00 2001
From: Tanu Kaskinen <tanu.kaskinen@linux.intel.com>
Date: Thu, 5 Mar 2015 14:51:58 +0200
Subject: [PATCH 05/16] ucm: improve jack configuration documentation
Signed-off-by: Tanu Kaskinen <tanu.kaskinen@linux.intel.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
---
include/use-case.h | 24 ++++++++++++++++++------
1 file changed, 18 insertions(+), 6 deletions(-)
diff --git a/include/use-case.h b/include/use-case.h
index d30952245fde..e3308b17b105 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,
--
2.4.1