iio: clarify channel and indexed in struct iio_chan_spec
authorPeter Meerwald <p.meerwald@bct-electronic.com>
Tue, 12 Jun 2012 13:38:46 +0000 (15:38 +0200)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Tue, 12 Jun 2012 21:53:31 +0000 (14:53 -0700)
Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
Acked-by: Jonathan Cameron <jic23@kernel.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
include/linux/iio/iio.h

index 01afaa0..9a9e6d5 100644 (file)
@@ -196,7 +196,7 @@ ssize_t iio_enum_write(struct iio_dev *indio_dev,
 /**
  * struct iio_chan_spec - specification of a single channel
  * @type:              What type of measurement is the channel making.
- * @channel:           What number or name do we wish to assign the channel.
+ * @channel:           What number do we wish to assign the channel.
  * @channel2:          If there is a second number for a differential
  *                     channel then this is it. If modified is set then the
  *                     value here specifies the modifier.
@@ -227,9 +227,8 @@ ssize_t iio_enum_write(struct iio_dev *indio_dev,
  *                     channel2. Examples are IIO_MOD_X for axial sensors about
  *                     the 'x' axis.
  * @indexed:           Specify the channel has a numerical index. If not,
- *                     the value in channel will be suppressed for attribute
- *                     but not for event codes. Typically set it to 0 when
- *                     the index is false.
+ *                     the channel index number will be suppressed for sysfs
+ *                     attributes but not for event codes.
  * @differential:      Channel is differential.
  */
 struct iio_chan_spec {