Takashi Iwai
e8e74453bd
- 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
155 lines
6.3 KiB
Diff
155 lines
6.3 KiB
Diff
From 72aa0f8332fb945c4179450f65402ce1cb389594 Mon Sep 17 00:00:00 2001
|
|
From: Tanu Kaskinen <tanu.kaskinen@linux.intel.com>
|
|
Date: Thu, 5 Mar 2015 14:51:57 +0200
|
|
Subject: [PATCH 04/16] ucm: reformat snd_use_case_get() doc
|
|
|
|
Doxygen doesn't preserve formatting that relies only on indentation.
|
|
This fixes it by using lists more liberally.
|
|
|
|
There are probably more places to fix than just
|
|
snd_use_case_get_list(), but I only have motivation for fixing this
|
|
function's documentation formatting (the next patch will add some more
|
|
content to the function's documentation).
|
|
|
|
Signed-off-by: Tanu Kaskinen <tanu.kaskinen@linux.intel.com>
|
|
Signed-off-by: Takashi Iwai <tiwai@suse.de>
|
|
---
|
|
include/use-case.h | 111 +++++++++++++++++++++++++++++++----------------------
|
|
1 file changed, 65 insertions(+), 46 deletions(-)
|
|
|
|
diff --git a/include/use-case.h b/include/use-case.h
|
|
index 3728906ec83d..d30952245fde 100644
|
|
--- a/include/use-case.h
|
|
+++ b/include/use-case.h
|
|
@@ -229,10 +229,10 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
|
|
* "const", but it's too late to fix it, sorry about that.)
|
|
*
|
|
* Known identifiers:
|
|
- * NULL - return current card
|
|
- * _verb - return current verb
|
|
+ * - NULL - return current card
|
|
+ * - _verb - return current verb
|
|
*
|
|
- * [=]{NAME}[/[{modifier}|{/device}][/{verb}]]
|
|
+ * - [=]{NAME}[/[{modifier}|{/device}][/{verb}]]
|
|
* - value identifier {NAME}
|
|
* - Search starts at given modifier or device if any,
|
|
* else at a verb
|
|
@@ -243,51 +243,70 @@ int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
|
|
* device/modifier/verb specified, and not search
|
|
* through each object in turn.
|
|
* - Examples:
|
|
- * "PlaybackPCM/Play Music"
|
|
- * "CapturePCM/SPDIF"
|
|
- * From ValueDefaults only:
|
|
- * "=Variable"
|
|
- * From current active verb:
|
|
- * "=Variable//"
|
|
- * From verb "Verb":
|
|
- * "=Variable//Verb"
|
|
- * From "Modifier" in current active verb:
|
|
- * "=Variable/Modifier/"
|
|
- * From "Modifier" in "Verb":
|
|
- * "=Variable/Modifier/Verb"
|
|
+ * - "PlaybackPCM/Play Music"
|
|
+ * - "CapturePCM/SPDIF"
|
|
+ * - From ValueDefaults only:
|
|
+ * "=Variable"
|
|
+ * - From current active verb:
|
|
+ * "=Variable//"
|
|
+ * - From verb "Verb":
|
|
+ * "=Variable//Verb"
|
|
+ * - From "Modifier" in current active verb:
|
|
+ * "=Variable/Modifier/"
|
|
+ * - From "Modifier" in "Verb":
|
|
+ * "=Variable/Modifier/Verb"
|
|
*
|
|
* Recommended names for values:
|
|
- * TQ - Tone Quality
|
|
- * PlaybackPCM - full PCM playback device name
|
|
- * PlaybackPCMIsDummy - Valid values: "yes" and "no". If set to "yes", the
|
|
- * PCM named by the PlaybackPCM value is a dummy device,
|
|
- * meaning that opening it enables an audio path in the
|
|
- * hardware, but writing to the PCM device has no
|
|
- * effect.
|
|
- * CapturePCM - full PCM capture device name
|
|
- * CapturePCMIsDummy - Valid values: "yes" and "no". If set to "yes", the
|
|
- * PCM named by the CapturePCM value is a dummy device,
|
|
- * meaning that opening it enables an audio path in the
|
|
- * hardware, but reading from the PCM device has no
|
|
- * effect.
|
|
- * PlaybackRate - playback device sample rate
|
|
- * PlaybackChannels - playback device channel count
|
|
- * PlaybackCTL - playback control device name
|
|
- * PlaybackVolume - playback control volume ID string
|
|
- * PlaybackSwitch - playback control switch ID string
|
|
- * CaptureRate - capture device sample rate
|
|
- * CaptureChannels - capture device channel count
|
|
- * CaptureCTL - capture control device name
|
|
- * CaptureVolume - capture control volume ID string
|
|
- * CaptureSwitch - capture control switch ID string
|
|
- * PlaybackMixer - name of playback mixer
|
|
- * PlaybackMixerID - mixer playback ID
|
|
- * CaptureMixer - 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.
|
|
+ * - TQ
|
|
+ * - Tone Quality
|
|
+ * - PlaybackPCM
|
|
+ * - full PCM playback device name
|
|
+ * - PlaybackPCMIsDummy
|
|
+ * - Valid values: "yes" and "no". If set to "yes", the PCM named by the
|
|
+ * PlaybackPCM value is a dummy device, meaning that opening it enables
|
|
+ * an audio path in the hardware, but writing to the PCM device has no
|
|
+ * effect.
|
|
+ * - CapturePCM
|
|
+ * - full PCM capture device name
|
|
+ * - CapturePCMIsDummy
|
|
+ * - Valid values: "yes" and "no". If set to "yes", the PCM named by the
|
|
+ * CapturePCM value is a dummy device, meaning that opening it enables
|
|
+ * an audio path in the hardware, but reading from the PCM device has no
|
|
+ * effect.
|
|
+ * - PlaybackRate
|
|
+ * - playback device sample rate
|
|
+ * - PlaybackChannels
|
|
+ * - playback device channel count
|
|
+ * - PlaybackCTL
|
|
+ * - playback control device name
|
|
+ * - PlaybackVolume
|
|
+ * - playback control volume ID string
|
|
+ * - PlaybackSwitch
|
|
+ * - playback control switch ID string
|
|
+ * - CaptureRate
|
|
+ * - capture device sample rate
|
|
+ * - CaptureChannels
|
|
+ * - capture device channel count
|
|
+ * - CaptureCTL
|
|
+ * - capture control device name
|
|
+ * - CaptureVolume
|
|
+ * - capture control volume ID string
|
|
+ * - CaptureSwitch
|
|
+ * - capture control switch ID string
|
|
+ * - PlaybackMixer
|
|
+ * - name of playback mixer
|
|
+ * - PlaybackMixerID
|
|
+ * - mixer playback ID
|
|
+ * - CaptureMixer
|
|
+ * - 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.
|
|
*/
|
|
int snd_use_case_get(snd_use_case_mgr_t *uc_mgr,
|
|
const char *identifier,
|
|
--
|
|
2.4.1
|
|
|