Re: [PATCH] staging:iio:ad7606: update structs with doc annotations

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sun, 2018-09-16 at 12:24 +0100, Jonathan Cameron wrote:
> On Thu, 13 Sep 2018 14:07:36 +0300
> Alexandru Ardelean <alexandru.ardelean@xxxxxxxxxx> wrote:
> 
> > The current structs are only partially documented via annotations. This
> > change updates annotations for all structs in the ad7606.h file.
> > 
> > Signed-off-by: Alexandru Ardelean <alexandru.ardelean@xxxxxxxxxx>
> 
> Good stuff, though a few questions inline.
> 
> I'm hoping this means you are planning to finish tidying this driver
> up and move it out of staging? 

Replies inline.


So, I don't have a good track-record of saying yes to this question and
sticking to it, because I also have the AD7192 [in my pipeline] to move out
of staging [and it's only partially done].

But, specifically for this driver, we want to add a new chip to this [after
the AD7605-4], so there is an interest from our side to actually see this
through.

And also, we did manage to rebase quite a lot of our patches on top of a
4.14 base [ which should hopefully make things more easier to track
internally vs upstream ].
I do hope to send-out a bigger set of these patches upstream.
And I'll try to separate patches as much as possible, because it's simpler
to resend V2,V3,...,VN for smaller sets of patches.

So, this is not a definite-yes to your question; it's more of an indicative
of what we're trying to do.

Thanks
Alex

> 
> Thanks,
> 
> Jonathan
> 
> > ---
> >  drivers/staging/iio/adc/ad7606.h | 23 +++++++++++++++++++++++
> >  1 file changed, 23 insertions(+)
> > 
> > diff --git a/drivers/staging/iio/adc/ad7606.h
> > b/drivers/staging/iio/adc/ad7606.h
> > index 4983e3aa6b0e..f422296354c9 100644
> > --- a/drivers/staging/iio/adc/ad7606.h
> > +++ b/drivers/staging/iio/adc/ad7606.h
> > @@ -24,7 +24,26 @@ struct ad7606_chip_info {
> >  
> >  /**
> >   * struct ad7606_state - driver instance specific data
> > + * @dev		pointer to kernel device
> > + * @chip_info		entry in the table of chips that
> > describes this device
> > + * @reg		regulator info for the the power supply of the
> > device
> > + * @poll_work		struct info for reading data in buffer
> > mode
> 
> I'm not quite sure on the intended meaning of this one above...
Ack.
Will try to make it clearer.

> 
> > + * @wq_data_avail	wait queue struct for buffer mode
> > + * @bops		bus operations (SPI or parallel)
> > + * @range		voltage range selection, selects which scale
> > to apply
> > + * @oversampling	oversampling selection
> > + * @done		marks whether reading data is done
> > + * @base_address	address from where to read data in parallel
> > operation
> >   * @lock		protect sensor state
> 
> From what? Concurrent changes I guess, but would be good to be clear.

Ack.
Will update.

> 
> > + * @gpio_convst	GPIO descriptor for conversion start signal
> > (CONVST)
> > + * @gpio_reset		GPIO descriptor for device hard-reset
> > + * @gpio_range		GPIO descriptor for range selection
> > + * @gpio_standby	GPIO descriptor for stand-by signal (STBY),
> > + *			controls power-down mode of device
> > + * @gpio_frstdata	GPIO descriptor for reading from device when
> > data
> > + *			is being read on the first channel
> > + * @gpio_os		GPIO descriptors to control oversampling on
> > the device
> > + * @data		buffer for reading data from the device
> >   */
> >  
> >  struct ad7606_state {
> > @@ -55,6 +74,10 @@ struct ad7606_state {
> >  	unsigned short			data[12]
> > ____cacheline_aligned;
> >  };
> >  
> > +/**
> > + * struct ad7606_bus_ops - driver bus operations
> > + * @read_block		function pointer for reading blocks of
> > data
> > + */
> >  struct ad7606_bus_ops {
> >  	/* more methods added in future? */
> >  	int (*read_block)(struct device *dev, int num, void *data);
> 
> 




[Index of Archives]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Input]     [Linux Kernel]     [Linux SCSI]     [X.org]

  Powered by Linux