diff options
author | Mark Brown <broonie@opensource.wolfsonmicro.com> | 2012-05-07 12:10:21 -0400 |
---|---|---|
committer | Takashi Iwai <tiwai@suse.de> | 2012-05-07 12:11:37 -0400 |
commit | a2e888f0d7cf6f2011740acb1f310bcc959c2842 (patch) | |
tree | f24bbd033bbe832bfa2a050703e389fb0a34dd11 /sound/core | |
parent | 76bc7a0d0a2a833d09fbf9d4e19a7985ef6e276b (diff) |
ALSA: jack: Update documention to reflect other userspace interfaces
Since this is a generic API which should support any userspace interface
for reporting jacks update the documentation a little to make that a bit
clearer.
Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'sound/core')
-rw-r--r-- | sound/core/jack.c | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/sound/core/jack.c b/sound/core/jack.c index 471e1e3b0a99..a06b1651fcba 100644 --- a/sound/core/jack.c +++ b/sound/core/jack.c | |||
@@ -155,7 +155,7 @@ EXPORT_SYMBOL(snd_jack_new); | |||
155 | * @jack: The jack to configure | 155 | * @jack: The jack to configure |
156 | * @parent: The device to set as parent for the jack. | 156 | * @parent: The device to set as parent for the jack. |
157 | * | 157 | * |
158 | * Set the parent for the jack input device in the device tree. This | 158 | * Set the parent for the jack devices in the device tree. This |
159 | * function is only valid prior to registration of the jack. If no | 159 | * function is only valid prior to registration of the jack. If no |
160 | * parent is configured then the parent device will be the sound card. | 160 | * parent is configured then the parent device will be the sound card. |
161 | */ | 161 | */ |
@@ -179,6 +179,9 @@ EXPORT_SYMBOL(snd_jack_set_parent); | |||
179 | * mapping is provided but keys are enabled in the jack type then | 179 | * mapping is provided but keys are enabled in the jack type then |
180 | * BTN_n numeric buttons will be reported. | 180 | * BTN_n numeric buttons will be reported. |
181 | * | 181 | * |
182 | * If jacks are not reporting via the input API this call will have no | ||
183 | * effect. | ||
184 | * | ||
182 | * Note that this is intended to be use by simple devices with small | 185 | * Note that this is intended to be use by simple devices with small |
183 | * numbers of keys that can be reported. It is also possible to | 186 | * numbers of keys that can be reported. It is also possible to |
184 | * access the input device directly - devices with complex input | 187 | * access the input device directly - devices with complex input |