Re: [PATCH v9 2/2] iio: adc: max14001: New driver

[Jonathan Cameron <jic23@kernel.org>]

On Tue, 11 Jul 2023 12:08:04 +0300
Andy Shevchenko <andy.shevchenko@gmail.com> wrote:

> On Tue, Jul 11, 2023 at 9:55 AM Paller, Kim Seer
> <KimSeer.Paller@analog.com> wrote:
> > > From: Andy Shevchenko <andy.shevchenko@gmail.com>
> > > On Mon, Jul 10, 2023 at 11:17 AM Paller, Kim Seer
> > > <KimSeer.Paller@analog.com> wrote:  
> 
> ...
> 
> > > Hence instead of v10, reply with a draft of the comment in the code (I
> > > have asked before) that explains these bit twiddlers.  
> >
> > In patch v9, regarding with my bit arrangement comments, is it somewhat correct
> > or do I need to totally replace it?
> >
> > I am not yet familiar with the terminologies, so I hope you can provide some
> > suggestions and I'll definitely send the draft first.  
> 
> I'm not sure I understand what comments you are referring to.
> The v9 does not explain the algorithm clearly.
> 
> What you need is to cite or retell what the datasheet explains about
> bit ordering along with the proposed algo (in AN as far as I
> understood). Because I haven't got, why do you need to use be16 +
> bitrev if your data is le16 (and that's my understanding of the
> datasheet). Is it because of the answer from the device? I don't
> remember if it keep the bit order the same (i.e. D0...D9) as on the
> wire.
> 
> For the terminology, use what the datasheet and AN provide you. Also
> good to put those URLs to the code and datasheet as Datasheet: tag in
> the commit message.
> 

Absolutely agree.  The data format is weird enough we need the
info to be available for anyone who tries to work out what is going
on in the future.  This is a case where I'd rather see too much detail
in the comments than too little!

Jonathan