Re: [v2 03/10] iio: document euler angles modifiers

[Jonathan Cameron <Jonathan.Cameron@Huawei.com>]

On Tue, 9 Nov 2021 09:15:09 +0100
Andrea Merello <andrea.merello@gmail.com> wrote:

> Il giorno gio 28 ott 2021 alle ore 12:37 Jonathan Cameron
> <jic23@kernel.org> ha scritto:
> >
> > On Thu, 28 Oct 2021 12:18:33 +0200
> > Andrea Merello <andrea.merello@gmail.com> wrote:
> >  
> > > This patch introduces ABI documentation for new modifiers used for
> > > reporting rotations expressed as euler angles (i.e. yaw, pitch, roll).
> > >
> > > Signed-off-by: Andrea Merello <andrea.merello@iit.it>
> > > ---
> > >  Documentation/ABI/testing/sysfs-bus-iio | 8 ++++++++
> > >  1 file changed, 8 insertions(+)
> > >
> > > diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
> > > index 5147a00bf24a..f0adc2c817bd 100644
> > > --- a/Documentation/ABI/testing/sysfs-bus-iio
> > > +++ b/Documentation/ABI/testing/sysfs-bus-iio
> > > @@ -1965,3 +1965,11 @@ KernelVersion: 5.15
> > >  Contact:     linux-iio@vger.kernel.org
> > >  Description:
> > >               Raw (unscaled) linear acceleration readings.
> > > +
> > > +What:                /sys/bus/iio/devices/iio:deviceX/in_rot_yaw_raw
> > > +What:                /sys/bus/iio/devices/iio:deviceX/in_rot_pitch_raw
> > > +What:                /sys/bus/iio/devices/iio:deviceX/in_rot_roll_raw
> > > +KernelVersion:       5.15
> > > +Contact:     linux-iio@vger.kernel.org
> > > +Description:
> > > +             Raw (unscaled) euler angles readings.  
> > Any _raw entry should also include what the units are after application of
> > offset and scale.   Or you could just add this as more info to the in_rot_raw
> > block as an extra sentence explaining that they are euler angles.
> > That will lose the 'KernelVersion' information but honestly I'm not sure we
> > care that much about that.  
> 
> I'm unsure which block you are talking about: I see there are two
> blocks that refer to rot things: in_rot_quaternion_raw and
> in_rot_from_north_xxx_raw.
> 
> Looking at the 1st one description, it looks very specific to
> quaternions to me; the 2nd seems very specific to its own thing,
> whatever it is.. So I would just add the missing information (unit) in
> the new block just being introduced, if this is ok for you. Or am I
> missing some other block in which I could  coalesce this new euler
> thing?

Good point, not sure what I was thinking.  There isn't a sensible block
to add this to.  So just add the info about units.

Jonathan

> 
> 
> > Jonathan
> >
> >