Skip to content

Commit 883a752

Browse files
rodrigo455jic23
authored andcommitted
iio: dac: ad5686: cleanup doc header of local structs
Review documentation comment header for ad5686_chip_info and ad5686_state. Update variable names and description and remove unnecessary blank line between comment and struct declaration. Reviewed-by: Andy Shevchenko <andriy.shevchenko@intel.com> Signed-off-by: Rodrigo Alencar <rodrigo.alencar@analog.com> Signed-off-by: Jonathan Cameron <jic23@kernel.org>
1 parent 592b378 commit 883a752

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

drivers/iio/dac/ad5686.h

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,11 @@ typedef int (*ad5686_read_func)(struct ad5686_state *st, u8 addr);
6969

7070
/**
7171
* struct ad5686_chip_info - chip specific information
72-
* @int_vref_mv: AD5620/40/60: the internal reference voltage
72+
* @int_vref_mv: the internal reference voltage
7373
* @num_channels: number of channels
7474
* @channel: channel specification
7575
* @regmap_type: register map layout variant
7676
*/
77-
7877
struct ad5686_chip_info {
7978
u16 int_vref_mv;
8079
unsigned int num_channels;
@@ -112,16 +111,16 @@ extern const struct ad5686_chip_info ad5679r_chip_info;
112111

113112
/**
114113
* struct ad5686_state - driver instance specific data
115-
* @spi: spi_device
114+
* @dev: device instance
116115
* @chip_info: chip model specific constants, available modes etc
117116
* @vref_mv: actual reference voltage used
118117
* @pwr_down_mask: power down mask
119118
* @pwr_down_mode: current power down mode
120119
* @use_internal_vref: set to true if the internal reference voltage is used
121-
* @lock lock to protect the data buffer during regmap ops
122-
* @data: spi transfer buffers
120+
* @lock: lock to protect access to state fields, which includes
121+
* the data buffer during regmap ops
122+
* @data: transfer buffers
123123
*/
124-
125124
struct ad5686_state {
126125
struct device *dev;
127126
const struct ad5686_chip_info *chip_info;

0 commit comments

Comments
 (0)