Commit a2e888f0 authored by Mark Brown's avatar Mark Brown Committed by Takashi Iwai

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: default avatarMark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 76bc7a0d
...@@ -155,7 +155,7 @@ EXPORT_SYMBOL(snd_jack_new); ...@@ -155,7 +155,7 @@ EXPORT_SYMBOL(snd_jack_new);
* @jack: The jack to configure * @jack: The jack to configure
* @parent: The device to set as parent for the jack. * @parent: The device to set as parent for the jack.
* *
* Set the parent for the jack input device in the device tree. This * Set the parent for the jack devices in the device tree. This
* function is only valid prior to registration of the jack. If no * function is only valid prior to registration of the jack. If no
* parent is configured then the parent device will be the sound card. * parent is configured then the parent device will be the sound card.
*/ */
...@@ -179,6 +179,9 @@ EXPORT_SYMBOL(snd_jack_set_parent); ...@@ -179,6 +179,9 @@ EXPORT_SYMBOL(snd_jack_set_parent);
* mapping is provided but keys are enabled in the jack type then * mapping is provided but keys are enabled in the jack type then
* BTN_n numeric buttons will be reported. * BTN_n numeric buttons will be reported.
* *
* If jacks are not reporting via the input API this call will have no
* effect.
*
* Note that this is intended to be use by simple devices with small * Note that this is intended to be use by simple devices with small
* numbers of keys that can be reported. It is also possible to * numbers of keys that can be reported. It is also possible to
* access the input device directly - devices with complex input * access the input device directly - devices with complex input
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment