ASoC: jack: Clarify GPIO descriptor lookup in struct snd_soc_jack_gpio doc
authorJarkko Nikula <jarkko.nikula@linux.intel.com>
Tue, 27 May 2014 10:54:18 +0000 (13:54 +0300)
committerMark Brown <broonie@linaro.org>
Tue, 27 May 2014 11:03:44 +0000 (12:03 +0100)
commit83ad152d03b594b6a3fb9f3d313622b491cd6168
tree9568ec68b09ba1e750a31a87fa3ef88fdd9161e3
parentf025d3b9c64e1f7feb75a559d4a12f5f8c6a4a25
ASoC: jack: Clarify GPIO descriptor lookup in struct snd_soc_jack_gpio doc

Clarify struct snd_soc_jack_gpio documentation for the idx and name fields.
Because name is passed as connection ID to gpiod_get_index() when using GPIO
descriptor defined jack pins it is not only used as a label in debugfs but
also as function name lookup in systems that support functions names for
GPIOs.

Clarify also idx since the index is within the function of the GPIO consumer
device and not within the device itself only.

Signed-off-by: Jarkko Nikula <jarkko.nikula@linux.intel.com>
Signed-off-by: Mark Brown <broonie@linaro.org>
include/sound/soc.h