Skip to content

Commit

Permalink
staging:iio:ad7887: Use proper kernel doc
Browse files Browse the repository at this point in the history
Use proper kernel doc to document the platform data struct.

Signed-off-by: Lars-Peter Clausen <lars@metafoo.de>
Signed-off-by: Jonathan Cameron <jic23@kernel.org>
  • Loading branch information
Lars-Peter Clausen authored and Jonathan Cameron committed Nov 5, 2012
1 parent 65dd3d3 commit 5daa751
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions drivers/staging/iio/adc/ad7887.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,20 @@
* TODO: struct ad7887_platform_data needs to go into include/linux/iio
*/


/**
* struct ad7887_platform_data - AD7887 ADC driver platform data
* @en_dual: Whether to use dual channel mode. If set to true AIN1 becomes the
* second input channel, and Vref is internally connected to Vdd. If set to
* false the device is used in single channel mode and AIN1/Vref is used as
* VREF input.
* @use_onchip_ref: Whether to use the onchip reference. If set to true the
* internal 2.5V reference is used. If set to false a external reference is
* used.
*/
struct ad7887_platform_data {
/*
* AD7887:
* In single channel mode en_dual = flase, AIN1/Vref pins assumes its
* Vref function. In dual channel mode en_dual = true, AIN1 becomes the
* second input channel, and Vref is internally connected to Vdd.
*/
bool en_dual;
/*
* AD7887:
* use_onchip_ref = true, the Vref is internally connected to the 2.500V
* Voltage reference. If use_onchip_ref = false, the reference voltage
* is supplied by AIN1/Vref
*/
bool use_onchip_ref;
bool en_dual;
bool use_onchip_ref;
};

#endif /* IIO_ADC_AD7887_H_ */

0 comments on commit 5daa751

Please sign in to comment.